From 397a503da3553ead59664891377958788bc527f5 Mon Sep 17 00:00:00 2001 From: Charlie Hess Date: Fri, 17 Apr 2015 14:26:29 -0700 Subject: [PATCH 0001/1293] Update submodules --- vendor/breakpad | 2 +- vendor/brightray | 2 +- vendor/native_mate | 2 +- vendor/node | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/vendor/breakpad b/vendor/breakpad index 4427c1170387..1e937567e92d 160000 --- a/vendor/breakpad +++ b/vendor/breakpad @@ -1 +1 @@ -Subproject commit 4427c1170387afe46eb3fad259436f1f9f5efa86 +Subproject commit 1e937567e92d2c3beed4556f3c68a4b0362b1e6d diff --git a/vendor/brightray b/vendor/brightray index ec0a660b0b70..d3500e5d9451 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit ec0a660b0b70e6ea5a4ee760a753b8fac31a5de2 +Subproject commit d3500e5d9451e248dd8f4ae805f19b371e795cc3 diff --git a/vendor/native_mate b/vendor/native_mate index 40da835cbb7a..d0db7bfb586a 160000 --- a/vendor/native_mate +++ b/vendor/native_mate @@ -1 +1 @@ -Subproject commit 40da835cbb7a5f76aacebf9d3ee4b66a62cece71 +Subproject commit d0db7bfb586afe9f491bd4cb368353d2660ecfe1 diff --git a/vendor/node b/vendor/node index 9f7ab575d78f..9cd0fad904c3 160000 --- a/vendor/node +++ b/vendor/node @@ -1 +1 @@ -Subproject commit 9f7ab575d78fa4c50cc5529f15646c8a37eb3258 +Subproject commit 9cd0fad904c3ebf0af0aeec2097cad3e039a7c6d From 5b69421625525faf3cc61a22a48fae1c7e907c3d Mon Sep 17 00:00:00 2001 From: Charlie Hess Date: Fri, 17 Apr 2015 14:29:50 -0700 Subject: [PATCH 0002/1293] Revert "Update submodules" This reverts commit 397a503da3553ead59664891377958788bc527f5. --- vendor/breakpad | 2 +- vendor/brightray | 2 +- vendor/native_mate | 2 +- vendor/node | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/vendor/breakpad b/vendor/breakpad index 1e937567e92d..4427c1170387 160000 --- a/vendor/breakpad +++ b/vendor/breakpad @@ -1 +1 @@ -Subproject commit 1e937567e92d2c3beed4556f3c68a4b0362b1e6d +Subproject commit 4427c1170387afe46eb3fad259436f1f9f5efa86 diff --git a/vendor/brightray b/vendor/brightray index d3500e5d9451..ec0a660b0b70 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit d3500e5d9451e248dd8f4ae805f19b371e795cc3 +Subproject commit ec0a660b0b70e6ea5a4ee760a753b8fac31a5de2 diff --git a/vendor/native_mate b/vendor/native_mate index d0db7bfb586a..40da835cbb7a 160000 --- a/vendor/native_mate +++ b/vendor/native_mate @@ -1 +1 @@ -Subproject commit d0db7bfb586afe9f491bd4cb368353d2660ecfe1 +Subproject commit 40da835cbb7a5f76aacebf9d3ee4b66a62cece71 diff --git a/vendor/node b/vendor/node index 9cd0fad904c3..9f7ab575d78f 160000 --- a/vendor/node +++ b/vendor/node @@ -1 +1 @@ -Subproject commit 9cd0fad904c3ebf0af0aeec2097cad3e039a7c6d +Subproject commit 9f7ab575d78fa4c50cc5529f15646c8a37eb3258 From 7fee639edf975e254ab543dd8d6540c5d466ab33 Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Thu, 7 May 2015 01:45:56 +0530 Subject: [PATCH 0003/1293] protocol: wrapping httpjobfactory with a default protocol handler to intercept --- atom/browser/atom_browser_context.cc | 3 +++ atom/browser/net/http_protocol_handler.cc | 25 +++++++++++++++++++++++ atom/browser/net/http_protocol_handler.h | 25 +++++++++++++++++++++++ filenames.gypi | 2 ++ spec/api-protocol-spec.coffee | 7 +++++++ 5 files changed, 62 insertions(+) create mode 100644 atom/browser/net/http_protocol_handler.cc create mode 100644 atom/browser/net/http_protocol_handler.h diff --git a/atom/browser/atom_browser_context.cc b/atom/browser/atom_browser_context.cc index f0a92af9a3f0..835a5c50ae0a 100644 --- a/atom/browser/atom_browser_context.cc +++ b/atom/browser/atom_browser_context.cc @@ -7,6 +7,7 @@ #include "atom/browser/atom_browser_main_parts.h" #include "atom/browser/net/atom_url_request_job_factory.h" #include "atom/browser/net/asar/asar_protocol_handler.h" +#include "atom/browser/net/http_protocol_handler.h" #include "atom/browser/web_view_manager.h" #include "atom/common/options_switches.h" #include "base/command_line.h" @@ -59,6 +60,8 @@ net::URLRequestJobFactory* AtomBrowserContext::CreateURLRequestJobFactory( url::kFileScheme, new asar::AsarProtocolHandler( BrowserThread::GetBlockingPool()->GetTaskRunnerWithShutdownBehavior( base::SequencedWorkerPool::SKIP_ON_SHUTDOWN))); + job_factory->SetProtocolHandler( + url::kHttpScheme, new HttpProtocolHandler()); // Set up interceptors in the reverse order. scoped_ptr top_job_factory = job_factory.Pass(); diff --git a/atom/browser/net/http_protocol_handler.cc b/atom/browser/net/http_protocol_handler.cc new file mode 100644 index 000000000000..9cc3d2d2675e --- /dev/null +++ b/atom/browser/net/http_protocol_handler.cc @@ -0,0 +1,25 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#include "atom/browser/net/http_protocol_handler.h" + +#include "net/url_request/url_request_http_job.h" + +namespace atom { + +HttpProtocolHandler::HttpProtocolHandler() { +} + +HttpProtocolHandler::~HttpProtocolHandler() { +} + +net::URLRequestJob* HttpProtocolHandler::MaybeCreateJob( + net::URLRequest* request, + net::NetworkDelegate* network_delegate) const { + return net::URLRequestHttpJob::Factory(request, + network_delegate, + "http"); +} + +} // namespace atom diff --git a/atom/browser/net/http_protocol_handler.h b/atom/browser/net/http_protocol_handler.h new file mode 100644 index 000000000000..ad66fa75e054 --- /dev/null +++ b/atom/browser/net/http_protocol_handler.h @@ -0,0 +1,25 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#ifndef ATOM_BROWSER_NET_HTTP_PROTOCOL_HANDLER_H_ +#define ATOM_BROWSER_NET_HTTP_PROTOCOL_HANDLER_H_ + +#include "net/url_request/url_request_job_factory.h" + +namespace atom { + +class HttpProtocolHandler : public net::URLRequestJobFactory::ProtocolHandler { + public: + HttpProtocolHandler(); + virtual ~HttpProtocolHandler(); + + // net::URLRequestJobFactory::ProtocolHandler: + net::URLRequestJob* MaybeCreateJob( + net::URLRequest* request, + net::NetworkDelegate* network_delegate) const override; +}; + +} // namespace atom + +#endif // ATOM_BROWSER_NET_HTTP_PROTOCOL_HANDLER_H_ diff --git a/filenames.gypi b/filenames.gypi index ebd1fb41aaf2..1aa038c0c339 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -145,6 +145,8 @@ 'atom/browser/net/asar/url_request_asar_job.h', 'atom/browser/net/atom_url_request_job_factory.cc', 'atom/browser/net/atom_url_request_job_factory.h', + 'atom/browser/net/http_protocol_handler.cc', + 'atom/browser/net/http_protocol_handler.h', 'atom/browser/net/url_request_string_job.cc', 'atom/browser/net/url_request_string_job.h', 'atom/browser/net/url_request_buffer_job.cc', diff --git a/spec/api-protocol-spec.coffee b/spec/api-protocol-spec.coffee index 0b6c62c02754..060f035037d1 100644 --- a/spec/api-protocol-spec.coffee +++ b/spec/api-protocol-spec.coffee @@ -190,3 +190,10 @@ describe 'protocol module', -> assert false, 'Got error: ' + errorType + ' ' + error free() protocol.interceptProtocol 'file', handler + + it 'can override http protocol handler', (done) -> + handler = remote.createFunctionWithReturnValue 'valar morghulis' + protocol.once 'intercepted', -> + protocol.uninterceptProtocol 'http' + done() + protocol.interceptProtocol 'http', handler From 707503ac40e5fda17b504ee746203bb86a179c6a Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Mon, 11 May 2015 12:56:36 +0530 Subject: [PATCH 0004/1293] support https, ws, wss builtin schemes to be intercepted --- atom/browser/atom_browser_context.cc | 8 +++++++- atom/browser/net/http_protocol_handler.cc | 5 +++-- atom/browser/net/http_protocol_handler.h | 7 ++++++- spec/api-protocol-spec.coffee | 21 +++++++++++++++++++++ 4 files changed, 37 insertions(+), 4 deletions(-) diff --git a/atom/browser/atom_browser_context.cc b/atom/browser/atom_browser_context.cc index 835a5c50ae0a..d69aab22fa8a 100644 --- a/atom/browser/atom_browser_context.cc +++ b/atom/browser/atom_browser_context.cc @@ -61,7 +61,13 @@ net::URLRequestJobFactory* AtomBrowserContext::CreateURLRequestJobFactory( BrowserThread::GetBlockingPool()->GetTaskRunnerWithShutdownBehavior( base::SequencedWorkerPool::SKIP_ON_SHUTDOWN))); job_factory->SetProtocolHandler( - url::kHttpScheme, new HttpProtocolHandler()); + url::kHttpScheme, new HttpProtocolHandler(url::kHttpScheme)); + job_factory->SetProtocolHandler( + url::kHttpsScheme, new HttpProtocolHandler(url::kHttpsScheme)); + job_factory->SetProtocolHandler( + url::kWsScheme, new HttpProtocolHandler(url::kWsScheme)); + job_factory->SetProtocolHandler( + url::kWssScheme, new HttpProtocolHandler(url::kWssScheme)); // Set up interceptors in the reverse order. scoped_ptr top_job_factory = job_factory.Pass(); diff --git a/atom/browser/net/http_protocol_handler.cc b/atom/browser/net/http_protocol_handler.cc index 9cc3d2d2675e..cf5fc01c0884 100644 --- a/atom/browser/net/http_protocol_handler.cc +++ b/atom/browser/net/http_protocol_handler.cc @@ -8,7 +8,8 @@ namespace atom { -HttpProtocolHandler::HttpProtocolHandler() { +HttpProtocolHandler::HttpProtocolHandler(const std::string& scheme) + : scheme_(scheme) { } HttpProtocolHandler::~HttpProtocolHandler() { @@ -19,7 +20,7 @@ net::URLRequestJob* HttpProtocolHandler::MaybeCreateJob( net::NetworkDelegate* network_delegate) const { return net::URLRequestHttpJob::Factory(request, network_delegate, - "http"); + scheme_); } } // namespace atom diff --git a/atom/browser/net/http_protocol_handler.h b/atom/browser/net/http_protocol_handler.h index ad66fa75e054..98085374175b 100644 --- a/atom/browser/net/http_protocol_handler.h +++ b/atom/browser/net/http_protocol_handler.h @@ -5,19 +5,24 @@ #ifndef ATOM_BROWSER_NET_HTTP_PROTOCOL_HANDLER_H_ #define ATOM_BROWSER_NET_HTTP_PROTOCOL_HANDLER_H_ +#include + #include "net/url_request/url_request_job_factory.h" namespace atom { class HttpProtocolHandler : public net::URLRequestJobFactory::ProtocolHandler { public: - HttpProtocolHandler(); + explicit HttpProtocolHandler(const std::string&); virtual ~HttpProtocolHandler(); // net::URLRequestJobFactory::ProtocolHandler: net::URLRequestJob* MaybeCreateJob( net::URLRequest* request, net::NetworkDelegate* network_delegate) const override; + + private: + std::string scheme_; }; } // namespace atom diff --git a/spec/api-protocol-spec.coffee b/spec/api-protocol-spec.coffee index 060f035037d1..5b72140344b7 100644 --- a/spec/api-protocol-spec.coffee +++ b/spec/api-protocol-spec.coffee @@ -197,3 +197,24 @@ describe 'protocol module', -> protocol.uninterceptProtocol 'http' done() protocol.interceptProtocol 'http', handler + + it 'can override https protocol handler', (done) -> + handler = remote.createFunctionWithReturnValue 'valar morghulis' + protocol.once 'intercepted', -> + protocol.uninterceptProtocol 'https' + done() + protocol.interceptProtocol 'https', handler + + it 'can override ws protocol handler', (done) -> + handler = remote.createFunctionWithReturnValue 'valar morghulis' + protocol.once 'intercepted', -> + protocol.uninterceptProtocol 'ws' + done() + protocol.interceptProtocol 'ws', handler + + it 'can override wss protocol handler', (done) -> + handler = remote.createFunctionWithReturnValue 'valar morghulis' + protocol.once 'intercepted', -> + protocol.uninterceptProtocol 'wss' + done() + protocol.interceptProtocol 'wss', handler From e1beeb95e3f7fbb9441a9c3dbb3195143ec304bc Mon Sep 17 00:00:00 2001 From: Magica Date: Tue, 12 May 2015 06:02:42 +0800 Subject: [PATCH 0005/1293] Fix PPAPI flash plugin description Fix https://github.com/atom/electron/issues/1637 --- atom/app/atom_content_client.cc | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/atom/app/atom_content_client.cc b/atom/app/atom_content_client.cc index c8a591a59cc4..74f88db0b9b2 100644 --- a/atom/app/atom_content_client.cc +++ b/atom/app/atom_content_client.cc @@ -10,6 +10,8 @@ #include "atom/common/chrome_version.h" #include "atom/common/options_switches.h" #include "base/command_line.h" +#include "base/strings/string_split.h" +#include "base/strings/string_util.h" #include "content/public/common/content_constants.h" #include "content/public/common/pepper_plugin_info.h" #include "ppapi/shared_impl/ppapi_permissions.h" @@ -26,8 +28,24 @@ content::PepperPluginInfo CreatePepperFlashInfo(const base::FilePath& path, plugin.name = content::kFlashPluginName; plugin.path = path; plugin.permissions = ppapi::PERMISSION_ALL_BITS; - plugin.version = version; + std::vector flash_version_numbers; + base::SplitString(version, '.', &flash_version_numbers); + if (flash_version_numbers.size() < 1) + flash_version_numbers.push_back("11"); + // |SplitString()| puts in an empty string given an empty string. :( + else if (flash_version_numbers[0].empty()) + flash_version_numbers[0] = "11"; + if (flash_version_numbers.size() < 2) + flash_version_numbers.push_back("2"); + if (flash_version_numbers.size() < 3) + flash_version_numbers.push_back("999"); + if (flash_version_numbers.size() < 4) + flash_version_numbers.push_back("999"); + // E.g., "Shockwave Flash 10.2 r154": + plugin.description = plugin.name + " " + flash_version_numbers[0] + "." + + flash_version_numbers[1] + " r" + flash_version_numbers[2]; + plugin.version = JoinString(flash_version_numbers, '.'); content::WebPluginMimeType swf_mime_type( content::kFlashPluginSwfMimeType, content::kFlashPluginSwfExtension, From 2785a4cc480fc9cde00fae46bc7d5772f0631d61 Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Tue, 12 May 2015 17:52:30 +0530 Subject: [PATCH 0006/1293] browser: create quota permission context to allow quota request --- atom/browser/atom_browser_client.cc | 7 +++++ atom/browser/atom_browser_client.h | 5 +++ atom/browser/atom_quota_permission_context.cc | 24 ++++++++++++++ atom/browser/atom_quota_permission_context.h | 31 +++++++++++++++++++ filenames.gypi | 2 ++ 5 files changed, 69 insertions(+) create mode 100644 atom/browser/atom_quota_permission_context.cc create mode 100644 atom/browser/atom_quota_permission_context.h diff --git a/atom/browser/atom_browser_client.cc b/atom/browser/atom_browser_client.cc index fbc09d9fe15f..633cc6accd06 100644 --- a/atom/browser/atom_browser_client.cc +++ b/atom/browser/atom_browser_client.cc @@ -7,6 +7,7 @@ #include "atom/browser/atom_access_token_store.h" #include "atom/browser/atom_browser_context.h" #include "atom/browser/atom_browser_main_parts.h" +#include "atom/browser/atom_quota_permission_context.h" #include "atom/browser/atom_resource_dispatcher_host_delegate.h" #include "atom/browser/atom_speech_recognition_manager_delegate.h" #include "atom/browser/native_window.h" @@ -19,6 +20,7 @@ #include "chrome/browser/renderer_host/pepper/chrome_browser_pepper_host_factory.h" #include "chrome/browser/speech/tts_message_filter.h" #include "content/public/browser/browser_ppapi_host.h" +#include "content/public/browser/quota_permission_context.h" #include "content/public/browser/render_process_host.h" #include "content/public/browser/render_view_host.h" #include "content/public/browser/resource_dispatcher_host.h" @@ -222,6 +224,11 @@ void AtomBrowserClient::DidCreatePpapiPlugin( new chrome::ChromeBrowserPepperHostFactory(browser_host))); } +content::QuotaPermissionContext* + AtomBrowserClient::CreateQuotaPermissionContext() { + return new AtomQuotaPermissionContext; +} + brightray::BrowserMainParts* AtomBrowserClient::OverrideCreateBrowserMainParts( const content::MainFunctionParams&) { v8::V8::Initialize(); // Init V8 before creating main parts. diff --git a/atom/browser/atom_browser_client.h b/atom/browser/atom_browser_client.h index cc69a1e12de8..6d77eabc5a99 100644 --- a/atom/browser/atom_browser_client.h +++ b/atom/browser/atom_browser_client.h @@ -9,6 +9,10 @@ #include "brightray/browser/browser_client.h" +namespace content { +class QuotaPermissionContext; +} + namespace atom { class AtomResourceDispatcherHostDelegate; @@ -39,6 +43,7 @@ class AtomBrowserClient : public brightray::BrowserClient { void AppendExtraCommandLineSwitches(base::CommandLine* command_line, int child_process_id) override; void DidCreatePpapiPlugin(content::BrowserPpapiHost* browser_host) override; + content::QuotaPermissionContext* CreateQuotaPermissionContext() override; private: brightray::BrowserMainParts* OverrideCreateBrowserMainParts( diff --git a/atom/browser/atom_quota_permission_context.cc b/atom/browser/atom_quota_permission_context.cc new file mode 100644 index 000000000000..8775f950ca9a --- /dev/null +++ b/atom/browser/atom_quota_permission_context.cc @@ -0,0 +1,24 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#include "atom/browser/atom_quota_permission_context.h" + +#include "storage/common/quota/quota_types.h" + +namespace atom { + +AtomQuotaPermissionContext::AtomQuotaPermissionContext() { +} + +AtomQuotaPermissionContext::~AtomQuotaPermissionContext() { +} + +void AtomQuotaPermissionContext::RequestQuotaPermission( + const content::StorageQuotaParams& params, + int render_process_id, + const PermissionCallback& callback) { + callback.Run(response::QUOTA_PERMISSION_RESPONSE_ALLOW); +} + +} // namespace atom diff --git a/atom/browser/atom_quota_permission_context.h b/atom/browser/atom_quota_permission_context.h new file mode 100644 index 000000000000..1246ea7bad58 --- /dev/null +++ b/atom/browser/atom_quota_permission_context.h @@ -0,0 +1,31 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#ifndef ATOM_BROWSER_ATOM_QUOTA_PERMISSION_CONTEXT_H_ +#define ATOM_BROWSER_ATOM_QUOTA_PERMISSION_CONTEXT_H_ + +#include "content/public/browser/quota_permission_context.h" + +namespace atom { + +class AtomQuotaPermissionContext : public content::QuotaPermissionContext { + public: + typedef content::QuotaPermissionContext::QuotaPermissionResponse response; + + AtomQuotaPermissionContext(); + virtual ~AtomQuotaPermissionContext(); + + // content::QuotaPermissionContext: + void RequestQuotaPermission( + const content::StorageQuotaParams& params, + int render_process_id, + const PermissionCallback& callback) override; + + private: + DISALLOW_COPY_AND_ASSIGN(AtomQuotaPermissionContext); +}; + +} // namespace atom + +#endif // ATOM_BROWSER_ATOM_QUOTA_PERMISSION_CONTEXT_H_ diff --git a/filenames.gypi b/filenames.gypi index ebd1fb41aaf2..c97e39f80ccc 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -114,6 +114,8 @@ 'atom/browser/atom_browser_main_parts_mac.mm', 'atom/browser/atom_javascript_dialog_manager.cc', 'atom/browser/atom_javascript_dialog_manager.h', + 'atom/browser/atom_quota_permission_context.cc', + 'atom/browser/atom_quota_permission_context.h', 'atom/browser/atom_resource_dispatcher_host_delegate.cc', 'atom/browser/atom_resource_dispatcher_host_delegate.h', 'atom/browser/atom_speech_recognition_manager_delegate.cc', From add7f8a4aae7199d942b1f85a4f9a3b2465ef035 Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Tue, 12 May 2015 18:03:00 +0530 Subject: [PATCH 0007/1293] add test --- atom/browser/atom_browser_client.cc | 1 - spec/chromium-spec.coffee | 6 ++++++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/atom/browser/atom_browser_client.cc b/atom/browser/atom_browser_client.cc index 633cc6accd06..cf656d4a7cd8 100644 --- a/atom/browser/atom_browser_client.cc +++ b/atom/browser/atom_browser_client.cc @@ -20,7 +20,6 @@ #include "chrome/browser/renderer_host/pepper/chrome_browser_pepper_host_factory.h" #include "chrome/browser/speech/tts_message_filter.h" #include "content/public/browser/browser_ppapi_host.h" -#include "content/public/browser/quota_permission_context.h" #include "content/public/browser/render_process_host.h" #include "content/public/browser/render_view_host.h" #include "content/public/browser/resource_dispatcher_host.h" diff --git a/spec/chromium-spec.coffee b/spec/chromium-spec.coffee index d39183576b40..88a3487cc9d2 100644 --- a/spec/chromium-spec.coffee +++ b/spec/chromium-spec.coffee @@ -82,3 +82,9 @@ describe 'chromium feature', -> iframe.onload = -> assert.equal iframe.contentWindow.test, 'undefined undefined undefined' done() + + describe 'storage', -> + it 'requesting persitent quota works', (done) -> + navigator.webkitPersistentStorage.requestQuota 1024 * 1024, (grantedBytes) -> + assert.equal grantedBytes, 1048576 + done() From 32ba219146c06aac844732aaccef064744a397cf Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Tue, 12 May 2015 18:21:48 +0530 Subject: [PATCH 0008/1293] allowing file:// URI to access other file:// URIs for filesytem api use --- atom/app/atom_main_delegate.cc | 3 +++ 1 file changed, 3 insertions(+) diff --git a/atom/app/atom_main_delegate.cc b/atom/app/atom_main_delegate.cc index c9cdc77e1173..e73cc06bc464 100644 --- a/atom/app/atom_main_delegate.cc +++ b/atom/app/atom_main_delegate.cc @@ -78,6 +78,9 @@ void AtomMainDelegate::PreSandboxStartup() { // Disable renderer sandbox for most of node's functions. command_line->AppendSwitch(switches::kNoSandbox); + // Allow file:// URIs to read other file:// URIs by default. + command_line->AppendSwitch(switches::kAllowFileAccessFromFiles); + #if defined(OS_MACOSX) // Enable AVFoundation. command_line->AppendSwitch("enable-avfoundation"); From 0097f89adbc8b1461a487e1a87a52ad17b827ada Mon Sep 17 00:00:00 2001 From: Kyle Hornberg Date: Tue, 12 May 2015 10:29:00 -0500 Subject: [PATCH 0009/1293] Correct link of debugging UI Using the link provided one receives a response of `Cannot GET /[object%20Object]`. I've tested this on electron 0.25.3 using the example application and node-inspector version 0.10.0. The url change is the url provided by node-inspector in the terminal window. --- docs/tutorial/debugging-main-process.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorial/debugging-main-process.md b/docs/tutorial/debugging-main-process.md index 857f26faa4d7..5874dc5e779e 100644 --- a/docs/tutorial/debugging-main-process.md +++ b/docs/tutorial/debugging-main-process.md @@ -44,6 +44,6 @@ $ electron --debug-brk=5858 your/app ### 3. Load the debugger UI -Open http://127.0.0.1:8080/debug?port=5858 in the Chrome browser. +Open http://127.0.0.1:8080/debug?ws=127.0.0.1:8080&port=5858 in the Chrome browser. [node-inspector]: https://github.com/node-inspector/node-inspector From 033f9bcceddfc21c0d82e8759d5d948860c908c9 Mon Sep 17 00:00:00 2001 From: joshaber Date: Tue, 12 May 2015 21:05:48 -0400 Subject: [PATCH 0010/1293] If the window's transparent it also needs to be textured. --- atom/browser/native_window_mac.mm | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/atom/browser/native_window_mac.mm b/atom/browser/native_window_mac.mm index 8dd6bcbacbe1..2a5813c1072e 100644 --- a/atom/browser/native_window_mac.mm +++ b/atom/browser/native_window_mac.mm @@ -315,7 +315,7 @@ NativeWindowMac::NativeWindowMac(content::WebContents* web_contents, NSUInteger styleMask = NSTitledWindowMask | NSClosableWindowMask | NSMiniaturizableWindowMask | NSResizableWindowMask; - if (!useStandardWindow) { + if (!useStandardWindow || transparent_) { styleMask |= NSTexturedBackgroundWindowMask; } From 76d33c37d7fb74e898d56b5a28fd2669e4f9d362 Mon Sep 17 00:00:00 2001 From: joshaber Date: Tue, 12 May 2015 21:11:43 -0400 Subject: [PATCH 0011/1293] Use the textured window for the frameless case too. --- atom/browser/native_window_mac.mm | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/atom/browser/native_window_mac.mm b/atom/browser/native_window_mac.mm index 2a5813c1072e..a9ff57d8d279 100644 --- a/atom/browser/native_window_mac.mm +++ b/atom/browser/native_window_mac.mm @@ -315,7 +315,7 @@ NativeWindowMac::NativeWindowMac(content::WebContents* web_contents, NSUInteger styleMask = NSTitledWindowMask | NSClosableWindowMask | NSMiniaturizableWindowMask | NSResizableWindowMask; - if (!useStandardWindow || transparent_) { + if (!useStandardWindow || transparent_ || !has_frame_) { styleMask |= NSTexturedBackgroundWindowMask; } From 3913e18447cce589725336799860843ce8e54474 Mon Sep 17 00:00:00 2001 From: Charlie Hess Date: Fri, 15 May 2015 00:15:19 -0700 Subject: [PATCH 0012/1293] Add WebContents API for PasteAndMatchStyle. --- atom/browser/api/atom_api_web_contents.cc | 5 +++++ atom/browser/api/atom_api_web_contents.h | 1 + atom/renderer/lib/web-view/web-view.coffee | 1 + 3 files changed, 7 insertions(+) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index e228a064f413..99d6fd7cfede 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -523,6 +523,10 @@ void WebContents::Paste() { web_contents()->Paste(); } +void WebContents::PasteAndMatchStyle() { + web_contents()->PasteAndMatchStyle(); +} + void WebContents::Delete() { web_contents()->Delete(); } @@ -645,6 +649,7 @@ mate::ObjectTemplateBuilder WebContents::GetObjectTemplateBuilder( .SetMethod("cut", &WebContents::Cut) .SetMethod("copy", &WebContents::Copy) .SetMethod("paste", &WebContents::Paste) + .SetMethod("pasteAndMatchStyle", &WebContents::PasteAndMatchStyle) .SetMethod("delete", &WebContents::Delete) .SetMethod("selectAll", &WebContents::SelectAll) .SetMethod("unselect", &WebContents::Unselect) diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index e75cfb0267f0..4661a570f5af 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -75,6 +75,7 @@ class WebContents : public mate::EventEmitter, void Cut(); void Copy(); void Paste(); + void PasteAndMatchStyle(); void Delete(); void SelectAll(); void Unselect(); diff --git a/atom/renderer/lib/web-view/web-view.coffee b/atom/renderer/lib/web-view/web-view.coffee index bf163c0cfb5c..881300c4dd0a 100644 --- a/atom/renderer/lib/web-view/web-view.coffee +++ b/atom/renderer/lib/web-view/web-view.coffee @@ -261,6 +261,7 @@ registerWebViewElement = -> "cut" "copy" "paste" + "pasteAndMatchStyle" "delete" "selectAll" "unselect" From 9f461aed68b2871b85918c462f18903ae08c39d8 Mon Sep 17 00:00:00 2001 From: Charlie Hess Date: Fri, 15 May 2015 00:15:33 -0700 Subject: [PATCH 0013/1293] Update docs. --- docs/api/browser-window.md | 4 ++++ docs/api/web-view-tag.md | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index f8ff8e7b9e0c..3b80dd823d0d 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -840,6 +840,10 @@ Executes editing command `copy` in page. Executes editing command `paste` in page. +### WebContents.pasteAndMatchStyle() + +Executes editing command `pasteAndMatchStyle` in page. + ### WebContents.delete() Executes editing command `delete` in page. diff --git a/docs/api/web-view-tag.md b/docs/api/web-view-tag.md index 89ae678b3c46..cc1a49463eaa 100644 --- a/docs/api/web-view-tag.md +++ b/docs/api/web-view-tag.md @@ -246,6 +246,10 @@ Executes editing command `copy` in page. Executes editing command `paste` in page. +### ``.pasteAndMatchStyle() + +Executes editing command `pasteAndMatchStyle` in page. + ### ``.delete() Executes editing command `delete` in page. From d19ae50cad4271fc666246de38db9810a8dfe84f Mon Sep 17 00:00:00 2001 From: campersau Date: Fri, 15 May 2015 17:46:25 +0200 Subject: [PATCH 0014/1293] docs: fixed casing of "Note" --- docs/api/tray.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/tray.md b/docs/api/tray.md index 0562a6180e46..ae2a471856e9 100644 --- a/docs/api/tray.md +++ b/docs/api/tray.md @@ -55,7 +55,7 @@ Creates a new tray icon associated with the `image`. Emitted when the tray icon is clicked. -__NOte:__ The `bounds` payload is only implemented on OS X. +__Note:__ The `bounds` payload is only implemented on OS X. ### Event: 'double-clicked' From a725a497598ec2f4ef7b155171604b15044ff5c3 Mon Sep 17 00:00:00 2001 From: Tom Moor Date: Fri, 15 May 2015 13:09:59 -0700 Subject: [PATCH 0015/1293] Small spelling mistake --- docs/api/screen.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/screen.md b/docs/api/screen.md index 8b3de4abfb46..bc93ec5f892b 100644 --- a/docs/api/screen.md +++ b/docs/api/screen.md @@ -68,9 +68,9 @@ Emitted when `oldDisplay` has been removed. * `event` Event * `display` Object -* `changedMetricts` Array +* `changedMetrics` Array -Emitted when a `display` has one or more metrics changed, `changedMetricts` is +Emitted when a `display` has one or more metrics changed, `changedMetrics` is an array of strings that describe the changes. Possible changes are `bounds`, `workArea`, `scaleFactor` and `rotation`. From e4415f00212de791b669595368f4b7814acee3be Mon Sep 17 00:00:00 2001 From: Andy Dill Date: Fri, 17 Apr 2015 09:33:00 -0700 Subject: [PATCH 0016/1293] compile-coffee.py searches for node even on non-windows systems --- tools/compile-coffee.py | 29 +++++++++++++++++++---------- 1 file changed, 19 insertions(+), 10 deletions(-) diff --git a/tools/compile-coffee.py b/tools/compile-coffee.py index c7eb3fccba66..5b7a17c87716 100755 --- a/tools/compile-coffee.py +++ b/tools/compile-coffee.py @@ -10,6 +10,11 @@ WINDOWS_NODE_PATHs = [ 'C:/Program Files (x86)/nodejs', 'C:/Program Files/nodejs', ] + os.environ['PATH'].split(os.pathsep) +NIX_NODE_PATHs = [ + '/usr/local/bin', + '/usr/bin', + '/bin', +] + os.environ['PATH'].split(os.pathsep) def main(): @@ -18,20 +23,24 @@ def main(): coffee = os.path.join(SOURCE_ROOT, 'node_modules', 'coffee-script', 'bin', 'coffee') + + node = 'node' if sys.platform in ['win32', 'cygwin']: - node = find_node() - if not node: - print 'Node.js not found in PATH for building atom-shell' - return 1 - subprocess.check_call(['node', coffee, '-c', '-o', output_dir, input_file], - executable=node) + node = find_node(WINDOWS_NODE_PATHs, 'node.exe') else: - subprocess.check_call(['node', coffee, '-c', '-o', output_dir, input_file]) + node = find_node(NIX_NODE_PATHs, 'node') + + if not node: + print 'Node.js not found in PATH for building electron' + return 1 + + subprocess.check_call(['node', coffee, '-c', '-o', output_dir, input_file], + executable=node) -def find_node(): - for path in WINDOWS_NODE_PATHs: - full_path = os.path.join(path, 'node.exe') +def find_node(paths, target): + for path in paths: + full_path = os.path.join(path, target) if os.path.exists(full_path): return full_path return None From dcbc6a127bb97e97a0cc63e16d4f6de01f558230 Mon Sep 17 00:00:00 2001 From: Andy Dill Date: Thu, 30 Apr 2015 16:46:33 -0700 Subject: [PATCH 0017/1293] Explicitly null the crash reporter before assigning it to allow the EH to unregister. --- atom/common/crash_reporter/crash_reporter_win.cc | 1 + 1 file changed, 1 insertion(+) diff --git a/atom/common/crash_reporter/crash_reporter_win.cc b/atom/common/crash_reporter/crash_reporter_win.cc index e5c5edc582ae..ebb9a784da54 100644 --- a/atom/common/crash_reporter/crash_reporter_win.cc +++ b/atom/common/crash_reporter/crash_reporter_win.cc @@ -54,6 +54,7 @@ void CrashReporterWin::InitBreakpad(const std::string& product_name, if (waiting_event != INVALID_HANDLE_VALUE) WaitForSingleObject(waiting_event, 1000); + breakpad_.reset(nullptr); int handler_types = google_breakpad::ExceptionHandler::HANDLER_EXCEPTION | google_breakpad::ExceptionHandler::HANDLER_PURECALL; breakpad_.reset(new google_breakpad::ExceptionHandler( From 36c376b1ecb1888f6f90f44840917185b9d10697 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Kevin=20M=C3=A5rtensson?= Date: Sat, 16 May 2015 17:03:19 +0200 Subject: [PATCH 0018/1293] Add link to `awesome-electron` --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index c3f7461c5e7e..ee00b098b96c 100644 --- a/README.md +++ b/README.md @@ -43,3 +43,5 @@ contains documents describing how to build and contribute to Electron. There is an [`electron` category on the Atom forums](http://discuss.atom.io/category/electron) as well as an `#atom-shell` channel on Freenode. + +Check out [awesome-electron](https://github.com/sindresorhus/awesome-electron) for a community maintained list of useful example apps, tools and resources. From ef30adcaefe21fce6a658237c7446cea88fc89b2 Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Sun, 17 May 2015 03:31:24 +0530 Subject: [PATCH 0019/1293] navigation: fix accessing url from history array for goToIndex --- atom/browser/api/lib/navigation-controller.coffee | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/atom/browser/api/lib/navigation-controller.coffee b/atom/browser/api/lib/navigation-controller.coffee index f7945e07bf40..c9635a6ca1d0 100644 --- a/atom/browser/api/lib/navigation-controller.coffee +++ b/atom/browser/api/lib/navigation-controller.coffee @@ -90,7 +90,7 @@ class NavigationController goToIndex: (index) -> return unless @canGoToIndex index @pendingIndex = index - @webContents._loadUrl @history[@pendingIndex].url, {} + @webContents._loadUrl @history[@pendingIndex], {} goToOffset: (offset) -> return unless @canGoToOffset offset From 46d80e8f05391f24fbe9d48d0f5b69728131f400 Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Mon, 18 May 2015 19:19:33 +0530 Subject: [PATCH 0020/1293] devtools: api to inspect service worker for current webcontents --- atom/browser/api/atom_api_web_contents.cc | 12 ++++++++++++ atom/browser/api/atom_api_web_contents.h | 1 + atom/renderer/lib/web-view/web-view.coffee | 1 + docs/api/web-view-tag.md | 4 ++++ 4 files changed, 18 insertions(+) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index e228a064f413..c61a124e4810 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -615,6 +615,17 @@ void WebContents::UnregisterServiceWorker( callback); } +void WebContents::InspectServiceWorker() { + for (const auto& agent_host : content::DevToolsAgentHost::GetOrCreateAll()) { + if (agent_host->GetType() == + content::DevToolsAgentHost::TYPE_SERVICE_WORKER) { + OpenDevTools(); + storage_->AttachTo(agent_host); + break; + } + } +} + mate::ObjectTemplateBuilder WebContents::GetObjectTemplateBuilder( v8::Isolate* isolate) { if (template_.IsEmpty()) @@ -657,6 +668,7 @@ mate::ObjectTemplateBuilder WebContents::GetObjectTemplateBuilder( .SetMethod("hasServiceWorker", &WebContents::HasServiceWorker) .SetMethod("unregisterServiceWorker", &WebContents::UnregisterServiceWorker) + .SetMethod("inspectServiceWorker", &WebContents::InspectServiceWorker) .Build()); return mate::ObjectTemplateBuilder( diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index e75cfb0267f0..1b22a2cbc61d 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -68,6 +68,7 @@ class WebContents : public mate::EventEmitter, void InspectElement(int x, int y); void HasServiceWorker(const base::Callback&); void UnregisterServiceWorker(const base::Callback&); + void InspectServiceWorker(); // Editing commands. void Undo(); diff --git a/atom/renderer/lib/web-view/web-view.coffee b/atom/renderer/lib/web-view/web-view.coffee index bf163c0cfb5c..c450f753060c 100644 --- a/atom/renderer/lib/web-view/web-view.coffee +++ b/atom/renderer/lib/web-view/web-view.coffee @@ -268,6 +268,7 @@ registerWebViewElement = -> "replaceMisspelling" "send" "getId" + "inspectServiceWorker" ] # Forward proto.foo* method calls to WebViewImpl.foo*. diff --git a/docs/api/web-view-tag.md b/docs/api/web-view-tag.md index 89ae678b3c46..13bd32d41d79 100644 --- a/docs/api/web-view-tag.md +++ b/docs/api/web-view-tag.md @@ -226,6 +226,10 @@ Returns whether guest page has a devtools window attached. Starts inspecting element at position (`x`, `y`) of guest page. +### ``.inspectServiceWorker() + +Opens the devtools for the service worker context present in the guest page. + ### ``.undo() Executes editing command `undo` in page. From 9963ddc4856e3712adb004e03568b6506bdf9583 Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Mon, 18 May 2015 20:08:08 +0530 Subject: [PATCH 0021/1293] implement method on browser window --- atom/browser/api/atom_api_window.cc | 7 ++++++- atom/browser/api/atom_api_window.h | 1 + atom/browser/native_window.cc | 11 +++++++++++ atom/browser/native_window.h | 1 + docs/api/browser-window.md | 4 ++++ 5 files changed, 23 insertions(+), 1 deletion(-) diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index b71499d3699c..74f0ba69ca45 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -351,6 +351,10 @@ void Window::InspectElement(int x, int y) { window_->InspectElement(x, y); } +void Window::InspectServiceWorker() { + window_->InspectServiceWorker(); +} + void Window::FocusOnWebView() { window_->FocusOnWebView(); } @@ -524,7 +528,8 @@ void Window::BuildPrototype(v8::Isolate* isolate, &Window::ShowDefinitionForSelection) #endif .SetMethod("_getWebContents", &Window::GetWebContents) - .SetMethod("_getDevToolsWebContents", &Window::GetDevToolsWebContents); + .SetMethod("_getDevToolsWebContents", &Window::GetDevToolsWebContents) + .SetMethod("inspectServiceWorker", &Window::InspectServiceWorker); } } // namespace api diff --git a/atom/browser/api/atom_api_window.h b/atom/browser/api/atom_api_window.h index d5c3ceedd2eb..d0d7b2621c56 100644 --- a/atom/browser/api/atom_api_window.h +++ b/atom/browser/api/atom_api_window.h @@ -116,6 +116,7 @@ class Window : public mate::EventEmitter, void CloseDevTools(); bool IsDevToolsOpened(); void InspectElement(int x, int y); + void InspectServiceWorker(); void FocusOnWebView(); void BlurWebView(); bool IsWebViewFocused(); diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 5bef1acfb872..9d24e68c8f42 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -317,6 +317,17 @@ void NativeWindow::InspectElement(int x, int y) { agent->InspectElement(x, y); } +void NativeWindow::InspectServiceWorker() { + for (const auto& agent_host : content::DevToolsAgentHost::GetOrCreateAll()) { + if (agent_host->GetType() == + content::DevToolsAgentHost::TYPE_SERVICE_WORKER) { + OpenDevTools(true); + inspectable_web_contents()->AttachTo(agent_host); + break; + } + } +} + void NativeWindow::FocusOnWebView() { GetWebContents()->GetRenderViewHost()->Focus(); } diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index 32c3493cdbf8..05742a3880da 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -153,6 +153,7 @@ class NativeWindow : public brightray::DefaultWebContentsDelegate, virtual void CloseDevTools(); virtual bool IsDevToolsOpened(); virtual void InspectElement(int x, int y); + virtual void InspectServiceWorker(); virtual void FocusOnWebView(); virtual void BlurWebView(); diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index f8ff8e7b9e0c..e20d809a5e7b 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -500,6 +500,10 @@ Toggle the developer tools. Starts inspecting element at position (`x`, `y`). +### BrowserWindow.inspectServiceWorker() + +Opens the developer tools for the service worker context present in the web contents. + ### BrowserWindow.focusOnWebView() ### BrowserWindow.blurWebView() From 3387459be25cb0ac784c3b864caf55a8e9498d31 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Mon, 18 May 2015 18:29:13 -0700 Subject: [PATCH 0022/1293] Start a contributing doc --- CONTRIBUTING.md | 72 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 72 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000000..727a09c4cd54 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,72 @@ +# Contributing to Electron + +:+1::tada: First off, thanks for taking the time to contribute! :tada::+1: + +The following is a set of guidelines for contributing to Electron. +These are just guidelines, not rules, use your best judgment and feel free to +propose changes to this document in a pull request. + +## Submitting Issues + +* You can create an issue [here](https://github.com/atom/electron/issues/new), +but before doing that please read the notes below and include as many details as +possible with your report. If you can, please include: + * The version of Electron you are using + * The operating system you are using + * If applicable, what you were doing when the issue arose and what you + expected to happen +* Other things that will help resolve your issue: + * Screenshots and animated GIFs + * Error output that appears in your terminal, dev tools or as an alert + * Perform a [cursory search](https://github.com/issues?q=+is%3Aissue+user%3Aatom) + to see if a similar issue has already been submitted + +## Submitting Pull Requests + +* Include screenshots and animated GIFs in your pull request whenever possible. +* Follow the CoffeeScript, JavaScript, C++ and Python [coding style defined in docs](/docs/development/coding-style.md). +* Write documentation in [Markdown](https://daringfireball.net/projects/markdown). +* Use short, present tense commit messages. See [Commit Message Styleguide](#git-commit-messages-styleguide). + +## Styleguides + +### General Code + +* End files with a newline. +* Place requires in the following order: + * Built in Node Modules (such as `path`) + * Built in Electron Modules (such as `ipc`, `app`) + * Local Modules (using relative paths) +* Place class properties in the following order: + * Class methods and properties (methods starting with a `@`) + * Instance methods and properties +* Avoid platform-dependent code: + * Use `require('fs-plus').getHomeDirectory()` to get the home directory. + * Use `path.join()` to concatenate filenames. + * Use `os.tmpdir()` rather than `/tmp` when you need to reference the + temporary directory. +* Using a plain `return` when returning explicitly at the end of a function. + * Not `return null`, `return undefined`, `null`, or `undefined` + +### Git Commit Messages + +* Use the present tense ("Add feature" not "Added feature") +* Use the imperative mood ("Move cursor to..." not "Moves cursor to...") +* Limit the first line to 72 characters or less +* Reference issues and pull requests liberally +* Consider starting the commit message with an applicable emoji: + * :art: `:art:` when improving the format/structure of the code + * :racehorse: `:racehorse:` when improving performance + * :non-potable_water: `:non-potable_water:` when plugging memory leaks + * :memo: `:memo:` when writing docs + * :penguin: `:penguin:` when fixing something on Linux + * :apple: `:apple:` when fixing something on Mac OS + * :checkered_flag: `:checkered_flag:` when fixing something on Windows + * :bug: `:bug:` when fixing a bug + * :fire: `:fire:` when removing code or files + * :green_heart: `:green_heart:` when fixing the CI build + * :white_check_mark: `:white_check_mark:` when adding tests + * :lock: `:lock:` when dealing with security + * :arrow_up: `:arrow_up:` when upgrading dependencies + * :arrow_down: `:arrow_down:` when downgrading dependencies + * :shirt: `:shirt:` when removing linter warnings From 6980982e32017f28e38fd80e970f0edfa2fe6946 Mon Sep 17 00:00:00 2001 From: Magica Date: Tue, 19 May 2015 20:27:12 +0800 Subject: [PATCH 0023/1293] ppapi: Add pepper flash tutorial Fix https://github.com/atom/electron/issues/1674 --- docs/tutorial/using-pepper-flash-plugin.md | 55 ++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 docs/tutorial/using-pepper-flash-plugin.md diff --git a/docs/tutorial/using-pepper-flash-plugin.md b/docs/tutorial/using-pepper-flash-plugin.md new file mode 100644 index 000000000000..7a542e0003fb --- /dev/null +++ b/docs/tutorial/using-pepper-flash-plugin.md @@ -0,0 +1,55 @@ +# Using Pepper Flash Plugin + +Pepper flash plugin is now supported. To use pepper flash plugin in Electron, you should manually specify the location of pepper flash plugin and then enable it in your application. + +## Prepare a copy of flash plugin + +On OS X and Linux, the detail of pepper flash plugin can be found by navigating `chrome://plugins` in Chrome browser. Its location and version are useful for electron's pepper flash support. You can also copy it to anywhere else. + +## Add Electron switch + +You can directly add `--ppapi-flash-path` and `ppapi-flash-version` to electron commandline or by `app.commandLine.appendSwitch` method before app ready event. Also, add the `plugins` switch of `browser-window`. For example, + +```javascript +var app = require('app'); +var BrowserWindow = require('browser-window'); + +// Report crashes to our server. +require('crash-reporter').start(); + +// Keep a global reference of the window object, if you don't, the window will +// be closed automatically when the javascript object is GCed. +var mainWindow = null; + +// Quit when all windows are closed. +app.on('window-all-closed', function() { + if (process.platform != 'darwin') + app.quit(); +}); + +// Specify flash path. +// On Windows, it might be /path/to/pepflashplayer.dll +// On Mac, /path/to/PepperFlashPlayer.plugin +// On Linux, /path/to/libpepflashplayer.so +app.commandLine.appendSwitch('ppapi-flash-path', '/path/to/libpepflashplayer.so'); + +// Specify flash version, for example, v17.0.0.169 +app.commandLine.appendSwitch('ppapi-flash-version', '17.0.0.169'); + +app.on('ready', function() { + mainWindow = new BrowserWindow({ + 'width': 800, + 'height': 600, + 'web-preferences': + 'plugins': true + }); + mainWindow.loadUrl('file://' + __dirname + '/index.html'); + // Something else +}); +``` + +## Enable flash plugin in a `` tag +Add `plugins` attribute to `` tag. +```html + +``` From 1a8c0230a713a10d3f07d6109bf7b925927a57a9 Mon Sep 17 00:00:00 2001 From: Magica Date: Tue, 19 May 2015 20:29:04 +0800 Subject: [PATCH 0024/1293] doc: Add pepper flash tutorial link in README. --- docs/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/README.md b/docs/README.md index 34688848b354..98b4219d3432 100644 --- a/docs/README.md +++ b/docs/README.md @@ -6,6 +6,7 @@ * [Debugging main process](tutorial/debugging-main-process.md) * [Using Selenium and WebDriver](tutorial/using-selenium-and-webdriver.md) * [DevTools extension](tutorial/devtools-extension.md) +* [Using pepper flash plugin](tutorial/using-pepper-flash-plugin.md) ## Tutorials From b0e8cafa0043d392a1cf189b5d254718e38bbcd9 Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Tue, 19 May 2015 22:41:03 +0530 Subject: [PATCH 0025/1293] navigation: adding clearHistory method --- .../api/lib/navigation-controller.coffee | 17 +++++++++++++---- atom/renderer/lib/override.coffee | 7 +++++++ atom/renderer/lib/web-view/web-view.coffee | 1 + docs/api/browser-window.md | 4 ++++ docs/api/web-view-tag.md | 4 ++++ 5 files changed, 29 insertions(+), 4 deletions(-) diff --git a/atom/browser/api/lib/navigation-controller.coffee b/atom/browser/api/lib/navigation-controller.coffee index f7945e07bf40..75e3affbabd5 100644 --- a/atom/browser/api/lib/navigation-controller.coffee +++ b/atom/browser/api/lib/navigation-controller.coffee @@ -4,6 +4,9 @@ ipc = require 'ipc' ipc.on 'ATOM_SHELL_NAVIGATION_CONTROLLER', (event, method, args...) -> event.sender[method] args... +ipc.on 'ATOM_SHELL_SYNC_NAVIGATION_CONTROLLER', (event, method, args...) -> + event.returnValue = event.sender[method] args... + # JavaScript implementation of Chromium's NavigationController. # Instead of relying on Chromium for history control, we compeletely do history # control on user land, and only rely on WebContents.loadUrl for navigation. @@ -11,10 +14,7 @@ ipc.on 'ATOM_SHELL_NAVIGATION_CONTROLLER', (event, method, args...) -> # process is restarted everytime. class NavigationController constructor: (@webContents) -> - @history = [] - @currentIndex = -1 - @pendingIndex = -1 - @inPageIndex = -1 + @clearHistory() @webContents.on 'navigation-entry-commited', (event, url, inPage, replaceEntry) => if @inPageIndex > -1 and not inPage @@ -71,6 +71,12 @@ class NavigationController canGoToOffset: (offset) -> @canGoToIndex @currentIndex + offset + clearHistory: -> + @history = [] + @currentIndex = -1 + @pendingIndex = -1 + @inPageIndex = -1 + goBack: -> return unless @canGoBack() @pendingIndex = @getActiveIndex() - 1 @@ -104,4 +110,7 @@ class NavigationController getActiveIndex: -> if @pendingIndex is -1 then @currentIndex else @pendingIndex + length: -> + @history.length + module.exports = NavigationController diff --git a/atom/renderer/lib/override.coffee b/atom/renderer/lib/override.coffee index 1ca6e692ba21..ccc7882a37e8 100644 --- a/atom/renderer/lib/override.coffee +++ b/atom/renderer/lib/override.coffee @@ -85,6 +85,13 @@ ipc.on 'ATOM_SHELL_GUEST_WINDOW_POSTMESSAGE', (message, targetOrigin) -> # Forward history operations to browser. sendHistoryOperation = (args...) -> ipc.send 'ATOM_SHELL_NAVIGATION_CONTROLLER', args... + +getHistoryOperation = (args...) -> + ipc.sendSync 'ATOM_SHELL_SYNC_NAVIGATION_CONTROLLER', args... + window.history.back = -> sendHistoryOperation 'goBack' window.history.forward = -> sendHistoryOperation 'goForward' window.history.go = (offset) -> sendHistoryOperation 'goToOffset', offset +Object.defineProperty window.history, 'length', + get: -> + getHistoryOperation 'length' diff --git a/atom/renderer/lib/web-view/web-view.coffee b/atom/renderer/lib/web-view/web-view.coffee index bf163c0cfb5c..b87131b9141c 100644 --- a/atom/renderer/lib/web-view/web-view.coffee +++ b/atom/renderer/lib/web-view/web-view.coffee @@ -244,6 +244,7 @@ registerWebViewElement = -> "canGoBack" "canGoForward" "canGoToOffset" + "clearHistory" "goBack" "goForward" "goToIndex" diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index f8ff8e7b9e0c..748f5b3e4c99 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -778,6 +778,10 @@ Returns whether the web page can go forward. Returns whether the web page can go to `offset`. +### WebContents.clearHistory() + +Clears the navigation history. + ### WebContents.goBack() Makes the web page go back. diff --git a/docs/api/web-view-tag.md b/docs/api/web-view-tag.md index 89ae678b3c46..6cb9718a8d8a 100644 --- a/docs/api/web-view-tag.md +++ b/docs/api/web-view-tag.md @@ -165,6 +165,10 @@ Returns whether guest page can go forward. Returns whether guest page can go to `offset`. +### ``.clearHistory() + +Clears the navigation history. + ### ``.goBack() Makes guest page go back. From 8fea373758ffd27dff30a823f18eab9b4f0e8cd0 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Tue, 19 May 2015 11:08:43 -0700 Subject: [PATCH 0026/1293] Use Electron repo search url --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 727a09c4cd54..cbebe6f418cd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,7 +18,7 @@ possible with your report. If you can, please include: * Other things that will help resolve your issue: * Screenshots and animated GIFs * Error output that appears in your terminal, dev tools or as an alert - * Perform a [cursory search](https://github.com/issues?q=+is%3Aissue+user%3Aatom) + * Perform a [cursory search](https://github.com/atom/electron/issues?utf8=✓&q=is%3Aissue+) to see if a similar issue has already been submitted ## Submitting Pull Requests From 25019de69035c4b627836ddbda4969e340544be6 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Tue, 19 May 2015 11:18:22 -0700 Subject: [PATCH 0027/1293] Remove example --- CONTRIBUTING.md | 1 - 1 file changed, 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cbebe6f418cd..6569918ef5aa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -41,7 +41,6 @@ possible with your report. If you can, please include: * Class methods and properties (methods starting with a `@`) * Instance methods and properties * Avoid platform-dependent code: - * Use `require('fs-plus').getHomeDirectory()` to get the home directory. * Use `path.join()` to concatenate filenames. * Use `os.tmpdir()` rather than `/tmp` when you need to reference the temporary directory. From 3993161a635a59517741da6f219f404088673ad3 Mon Sep 17 00:00:00 2001 From: Paul Betts Date: Tue, 5 May 2015 16:24:20 -0700 Subject: [PATCH 0028/1293] Define a new useragent attribute on WebView tag --- atom/renderer/lib/web-view/web-view-attributes.coffee | 1 + atom/renderer/lib/web-view/web-view-constants.coffee | 1 + 2 files changed, 2 insertions(+) diff --git a/atom/renderer/lib/web-view/web-view-attributes.coffee b/atom/renderer/lib/web-view/web-view-attributes.coffee index 05bd6141203f..de370e124952 100644 --- a/atom/renderer/lib/web-view/web-view-attributes.coffee +++ b/atom/renderer/lib/web-view/web-view-attributes.coffee @@ -190,6 +190,7 @@ WebViewImpl::setupWebViewAttributes = -> @attributes[webViewConstants.ATTRIBUTE_PARTITION] = new PartitionAttribute(this) @attributes[webViewConstants.ATTRIBUTE_SRC] = new SrcAttribute(this) @attributes[webViewConstants.ATTRIBUTE_HTTPREFERRER] = new HttpReferrerAttribute(this) + @attributes[webViewConstants.ATTRIBUTE_USERAGENT] = new UserAgentAttribute(this) @attributes[webViewConstants.ATTRIBUTE_NODEINTEGRATION] = new BooleanAttribute(webViewConstants.ATTRIBUTE_NODEINTEGRATION, this) @attributes[webViewConstants.ATTRIBUTE_PLUGINS] = new BooleanAttribute(webViewConstants.ATTRIBUTE_PLUGINS, this) @attributes[webViewConstants.ATTRIBUTE_DISABLEWEBSECURITY] = new BooleanAttribute(webViewConstants.ATTRIBUTE_DISABLEWEBSECURITY, this) diff --git a/atom/renderer/lib/web-view/web-view-constants.coffee b/atom/renderer/lib/web-view/web-view-constants.coffee index cda715423dd4..deb678e6a1e8 100644 --- a/atom/renderer/lib/web-view/web-view-constants.coffee +++ b/atom/renderer/lib/web-view/web-view-constants.coffee @@ -14,6 +14,7 @@ module.exports = ATTRIBUTE_PLUGINS: 'plugins' ATTRIBUTE_DISABLEWEBSECURITY: 'disablewebsecurity' ATTRIBUTE_PRELOAD: 'preload' + ATTRIBUTE_USERAGENT: 'useragent' # Internal attribute. ATTRIBUTE_INTERNALINSTANCEID: 'internalinstanceid' From 3a81a5224d74c2fbd7715ddde2ec81fab105910e Mon Sep 17 00:00:00 2001 From: Paul Betts Date: Tue, 5 May 2015 16:25:05 -0700 Subject: [PATCH 0029/1293] Set up a class for it in web-view-attributes --- atom/renderer/lib/web-view/web-view-attributes.coffee | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/atom/renderer/lib/web-view/web-view-attributes.coffee b/atom/renderer/lib/web-view/web-view-attributes.coffee index de370e124952..34304103ebbb 100644 --- a/atom/renderer/lib/web-view/web-view-attributes.coffee +++ b/atom/renderer/lib/web-view/web-view-attributes.coffee @@ -167,6 +167,11 @@ class HttpReferrerAttribute extends WebViewAttribute constructor: (webViewImpl) -> super webViewConstants.ATTRIBUTE_HTTPREFERRER, webViewImpl +# Attribute specifies HTTP referrer. +class UserAgentAttribute extends WebViewAttribute + constructor: (webViewImpl) -> + super webViewConstants.ATTRIBUTE_HTTPREFERRER, webViewImpl + # Attribute that set preload script. class PreloadAttribute extends WebViewAttribute constructor: (webViewImpl) -> From 4a8d7c18194570d29d0bcece3f9cdf0269986a7d Mon Sep 17 00:00:00 2001 From: Paul Betts Date: Tue, 5 May 2015 16:25:16 -0700 Subject: [PATCH 0030/1293] Right before navigate, set the user agent --- atom/renderer/lib/web-view/web-view-attributes.coffee | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/atom/renderer/lib/web-view/web-view-attributes.coffee b/atom/renderer/lib/web-view/web-view-attributes.coffee index 34304103ebbb..080300d02bf8 100644 --- a/atom/renderer/lib/web-view/web-view-attributes.coffee +++ b/atom/renderer/lib/web-view/web-view-attributes.coffee @@ -160,7 +160,12 @@ class SrcAttribute extends WebViewAttribute # Navigate to |this.src|. httpreferrer = @webViewImpl.attributes[webViewConstants.ATTRIBUTE_HTTPREFERRER].getValue() urlOptions = if httpreferrer then {httpreferrer} else {} - remote.getGuestWebContents(@webViewImpl.guestInstanceId).loadUrl @getValue(), urlOptions + + useragent = @webViewImpl.attributes[webViewConstants.ATTRIBUTE_HTTPREFERRER].getValue() + + guestContents = remote.getGuestWebContents(@webViewImpl.guestInstanceId) + guestContents.setUserAgent(guestContents) if guestContents + guestContents.loadUrl @getValue(), urlOptions # Attribute specifies HTTP referrer. class HttpReferrerAttribute extends WebViewAttribute From e4d90f747f83c69d3c31608eab9c5e4054ebdfd7 Mon Sep 17 00:00:00 2001 From: Paul Betts Date: Tue, 5 May 2015 21:01:41 -0700 Subject: [PATCH 0031/1293] Pass user agent along like http referrer and set user agent in C++ --- atom/browser/api/atom_api_web_contents.cc | 4 ++++ atom/browser/lib/guest-view-manager.coffee | 7 +++++-- atom/renderer/lib/web-view/web-view-attributes.coffee | 9 +++++---- 3 files changed, 14 insertions(+), 6 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index e228a064f413..8814057b9b99 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -418,6 +418,10 @@ void WebContents::LoadURL(const GURL& url, const mate::Dictionary& options) { params.referrer = content::Referrer(http_referrer.GetAsReferrer(), blink::WebReferrerPolicyDefault); + std::string user_agent; + if (options.Get("useragent", &user_agent)) + this->SetUserAgent(user_agent); + params.transition_type = ui::PAGE_TRANSITION_TYPED; params.should_clear_history_list = true; params.override_user_agent = content::NavigationController::UA_OVERRIDE_TRUE; diff --git a/atom/browser/lib/guest-view-manager.coffee b/atom/browser/lib/guest-view-manager.coffee index 43f4d7c98c5f..a8c930278db6 100644 --- a/atom/browser/lib/guest-view-manager.coffee +++ b/atom/browser/lib/guest-view-manager.coffee @@ -58,8 +58,11 @@ createGuest = (embedder, params) -> max = width: params.maxwidth, height: params.maxheight @setAutoSize params.autosize, min, max if params.src - if params.httpreferrer - @loadUrl params.src, {httpreferrer: params.httpreferrer} + opts = {} + opts.httpreferrer = params.httpreferrer if params.httpreferrer + opts.useragent = params.useragent if params.useragent + if params.httpreferrer or params.useragent + @loadUrl params.src, opts else @loadUrl params.src if params.allowtransparency? diff --git a/atom/renderer/lib/web-view/web-view-attributes.coffee b/atom/renderer/lib/web-view/web-view-attributes.coffee index 080300d02bf8..bd00dc5322e9 100644 --- a/atom/renderer/lib/web-view/web-view-attributes.coffee +++ b/atom/renderer/lib/web-view/web-view-attributes.coffee @@ -158,13 +158,14 @@ class SrcAttribute extends WebViewAttribute return # Navigate to |this.src|. + opts = {} httpreferrer = @webViewImpl.attributes[webViewConstants.ATTRIBUTE_HTTPREFERRER].getValue() - urlOptions = if httpreferrer then {httpreferrer} else {} + if httpreferrer then opts.httpreferrer = httpreferrer - useragent = @webViewImpl.attributes[webViewConstants.ATTRIBUTE_HTTPREFERRER].getValue() + useragent = @webViewImpl.attributes[webViewConstants.ATTRIBUTE_USERAGENT].getValue() + if useragent then opts.useragent = useragent guestContents = remote.getGuestWebContents(@webViewImpl.guestInstanceId) - guestContents.setUserAgent(guestContents) if guestContents guestContents.loadUrl @getValue(), urlOptions # Attribute specifies HTTP referrer. @@ -175,7 +176,7 @@ class HttpReferrerAttribute extends WebViewAttribute # Attribute specifies HTTP referrer. class UserAgentAttribute extends WebViewAttribute constructor: (webViewImpl) -> - super webViewConstants.ATTRIBUTE_HTTPREFERRER, webViewImpl + super webViewConstants.ATTRIBUTE_USERAGENT, webViewImpl # Attribute that set preload script. class PreloadAttribute extends WebViewAttribute From 22f51372f58b1796266fd038f6e7ee22239a7412 Mon Sep 17 00:00:00 2001 From: Paul Betts Date: Tue, 5 May 2015 21:18:08 -0700 Subject: [PATCH 0032/1293] Fix typo --- atom/renderer/lib/web-view/web-view-attributes.coffee | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/atom/renderer/lib/web-view/web-view-attributes.coffee b/atom/renderer/lib/web-view/web-view-attributes.coffee index bd00dc5322e9..9fd8e5151a78 100644 --- a/atom/renderer/lib/web-view/web-view-attributes.coffee +++ b/atom/renderer/lib/web-view/web-view-attributes.coffee @@ -166,7 +166,7 @@ class SrcAttribute extends WebViewAttribute if useragent then opts.useragent = useragent guestContents = remote.getGuestWebContents(@webViewImpl.guestInstanceId) - guestContents.loadUrl @getValue(), urlOptions + guestContents.loadUrl @getValue(), opts # Attribute specifies HTTP referrer. class HttpReferrerAttribute extends WebViewAttribute From 50c913fe92a703027ff2829026d19b4432804cc3 Mon Sep 17 00:00:00 2001 From: Paul Betts Date: Tue, 5 May 2015 22:06:15 -0700 Subject: [PATCH 0033/1293] Add a test for the user agent --- spec/fixtures/pages/useragent.html | 7 +++++++ spec/webview-spec.coffee | 12 ++++++++++++ 2 files changed, 19 insertions(+) create mode 100644 spec/fixtures/pages/useragent.html diff --git a/spec/fixtures/pages/useragent.html b/spec/fixtures/pages/useragent.html new file mode 100644 index 000000000000..4e19f5b8276a --- /dev/null +++ b/spec/fixtures/pages/useragent.html @@ -0,0 +1,7 @@ + + + + + diff --git a/spec/webview-spec.coffee b/spec/webview-spec.coffee index 54bc2e78817f..6d624eb9d81b 100644 --- a/spec/webview-spec.coffee +++ b/spec/webview-spec.coffee @@ -99,6 +99,18 @@ describe ' tag', -> webview.src = "file://#{fixtures}/pages/referrer.html" document.body.appendChild webview + describe 'useragent attribute', -> + it 'sets the user agent', (done) -> + referrer = 'Mozilla/5.0 (Windows NT 6.1; WOW64; Trident/7.0; AS; rv:11.0) like Gecko' + listener = (e) -> + assert.equal e.message, referrer + webview.removeEventListener 'console-message', listener + done() + webview.addEventListener 'console-message', listener + webview.setAttribute 'useragent', referrer + webview.src = "file://#{fixtures}/pages/useragent.html" + document.body.appendChild webview + describe 'disablewebsecurity attribute', -> it 'does not disable web security when not set', (done) -> src = " From ca63ea0882c00d3482750a57db15cbac088c728e Mon Sep 17 00:00:00 2001 From: Paul Betts Date: Tue, 5 May 2015 22:08:39 -0700 Subject: [PATCH 0034/1293] Add documentation --- docs/api/web-view-tag.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/api/web-view-tag.md b/docs/api/web-view-tag.md index 89ae678b3c46..3e008a5db258 100644 --- a/docs/api/web-view-tag.md +++ b/docs/api/web-view-tag.md @@ -112,6 +112,14 @@ after this script has done execution. Sets the referrer URL for the guest page. +### useragent + +```html + +``` + +Sets the user agent for the guest page before the page is navigated to. Once the page is loaded, use the `setUserAgent` method to change the user agent. + ### disablewebsecurity ```html From 5ee0ff9ee909943213c8fcc49d965fa81c31ab55 Mon Sep 17 00:00:00 2001 From: Paul Betts Date: Wed, 6 May 2015 14:21:43 -0700 Subject: [PATCH 0035/1293] Fixup code review items --- atom/browser/api/atom_api_web_contents.cc | 2 +- atom/renderer/lib/web-view/web-view-attributes.coffee | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 8814057b9b99..9894241f74ee 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -420,7 +420,7 @@ void WebContents::LoadURL(const GURL& url, const mate::Dictionary& options) { std::string user_agent; if (options.Get("useragent", &user_agent)) - this->SetUserAgent(user_agent); + SetUserAgent(user_agent); params.transition_type = ui::PAGE_TRANSITION_TYPED; params.should_clear_history_list = true; diff --git a/atom/renderer/lib/web-view/web-view-attributes.coffee b/atom/renderer/lib/web-view/web-view-attributes.coffee index 9fd8e5151a78..51dd2475a4e0 100644 --- a/atom/renderer/lib/web-view/web-view-attributes.coffee +++ b/atom/renderer/lib/web-view/web-view-attributes.coffee @@ -173,7 +173,7 @@ class HttpReferrerAttribute extends WebViewAttribute constructor: (webViewImpl) -> super webViewConstants.ATTRIBUTE_HTTPREFERRER, webViewImpl -# Attribute specifies HTTP referrer. +# Attribute specifies user agent class UserAgentAttribute extends WebViewAttribute constructor: (webViewImpl) -> super webViewConstants.ATTRIBUTE_USERAGENT, webViewImpl From 975978b414f473fadc49fa2f7ad7b150965b6a72 Mon Sep 17 00:00:00 2001 From: Paul Betts Date: Mon, 11 May 2015 10:00:41 -0700 Subject: [PATCH 0036/1293] Don't be so paranoid about empty opts --- atom/browser/lib/guest-view-manager.coffee | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/atom/browser/lib/guest-view-manager.coffee b/atom/browser/lib/guest-view-manager.coffee index a8c930278db6..a02a1676e8e6 100644 --- a/atom/browser/lib/guest-view-manager.coffee +++ b/atom/browser/lib/guest-view-manager.coffee @@ -57,14 +57,13 @@ createGuest = (embedder, params) -> min = width: params.minwidth, height: params.minheight max = width: params.maxwidth, height: params.maxheight @setAutoSize params.autosize, min, max + if params.src opts = {} opts.httpreferrer = params.httpreferrer if params.httpreferrer opts.useragent = params.useragent if params.useragent - if params.httpreferrer or params.useragent - @loadUrl params.src, opts - else - @loadUrl params.src + @loadUrl params.src, opts + if params.allowtransparency? @setAllowTransparency params.allowtransparency From cda8b119e22929225d2f3f513f0669c0804ee6c8 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 20 May 2015 09:18:11 +0800 Subject: [PATCH 0037/1293] Upgrade brightray --- vendor/brightray | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/brightray b/vendor/brightray index a929d7582927..442d46faa757 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit a929d75829270def615e342c79ea17634e8c5989 +Subproject commit 442d46faa7579156da7501c7256ce232b87aa329 From 7c69c2846b4e5ce2e0e7d533069b82dd4c49dd66 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 20 May 2015 10:27:16 +0800 Subject: [PATCH 0038/1293] Simplify how we find NativeWindow from WebContents --- atom/browser/api/atom_api_web_contents.cc | 4 +--- atom/browser/atom_browser_client.cc | 3 +-- atom/browser/native_window.cc | 13 ++++--------- atom/browser/native_window.h | 4 ++-- 4 files changed, 8 insertions(+), 16 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index e228a064f413..6da2fbf86f46 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -51,9 +51,7 @@ v8::Persistent template_; NativeWindow* GetWindowFromGuest(const content::WebContents* guest) { WebViewManager::WebViewInfo info; if (WebViewManager::GetInfoForProcess(guest->GetRenderProcessHost(), &info)) - return NativeWindow::FromRenderView( - info.embedder->GetRenderProcessHost()->GetID(), - info.embedder->GetRoutingID()); + return NativeWindow::FromWebContents(info.embedder); else return nullptr; } diff --git a/atom/browser/atom_browser_client.cc b/atom/browser/atom_browser_client.cc index fbc09d9fe15f..23674035e1d3 100644 --- a/atom/browser/atom_browser_client.cc +++ b/atom/browser/atom_browser_client.cc @@ -124,8 +124,7 @@ void AtomBrowserClient::OverrideWebkitPrefs( return; } - NativeWindow* window = NativeWindow::FromRenderView( - process->GetID(), render_view_host->GetRoutingID()); + NativeWindow* window = NativeWindow::FromWebContents(web_contents); if (window) window->OverrideWebkitPrefs(prefs); } diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 5bef1acfb872..8bc2c4616fe8 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -169,18 +169,13 @@ NativeWindow* NativeWindow::Create(const mate::Dictionary& options) { } // static -NativeWindow* NativeWindow::FromRenderView(int process_id, int routing_id) { - // Stupid iterating. +NativeWindow* NativeWindow::FromWebContents( + content::WebContents* web_contents) { WindowList& window_list = *WindowList::GetInstance(); - for (auto w = window_list.begin(); w != window_list.end(); ++w) { - auto& window = *w; - content::WebContents* web_contents = window->GetWebContents(); - int window_process_id = web_contents->GetRenderProcessHost()->GetID(); - int window_routing_id = web_contents->GetRoutingID(); - if (window_routing_id == routing_id && window_process_id == process_id) + for (NativeWindow* window : window_list) { + if (window->GetWebContents() == web_contents) return window; } - return nullptr; } diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index 32c3493cdbf8..39c58625ad2d 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -91,8 +91,8 @@ class NativeWindow : public brightray::DefaultWebContentsDelegate, // managing the window's live. static NativeWindow* Create(const mate::Dictionary& options); - // Find a window from its process id and routing id. - static NativeWindow* FromRenderView(int process_id, int routing_id); + // Find a window from its WebContents + static NativeWindow* FromWebContents(content::WebContents* web_contents); void InitFromOptions(const mate::Dictionary& options); From f8185296f471c2da7642c34dffbfe67d783635be Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Wed, 20 May 2015 09:23:08 +0530 Subject: [PATCH 0039/1293] add test --- spec/fixtures/pages/history.html | 8 ++++++++ spec/webview-spec.coffee | 15 +++++++++++++++ 2 files changed, 23 insertions(+) create mode 100644 spec/fixtures/pages/history.html diff --git a/spec/fixtures/pages/history.html b/spec/fixtures/pages/history.html new file mode 100644 index 000000000000..b5029d638926 --- /dev/null +++ b/spec/fixtures/pages/history.html @@ -0,0 +1,8 @@ + + + + + diff --git a/spec/webview-spec.coffee b/spec/webview-spec.coffee index 54bc2e78817f..3606c363c63a 100644 --- a/spec/webview-spec.coffee +++ b/spec/webview-spec.coffee @@ -193,3 +193,18 @@ describe ' tag', -> webview.setAttribute 'nodeintegration', 'on' webview.src = "file://#{fixtures}/pages/beforeunload-false.html" document.body.appendChild webview + + describe '.clearHistory()', -> + it 'should clear the navigation history', (done) -> + listener = (e) -> + assert.equal e.channel, 'history' + assert.equal e.args[0], 2 + assert webview.canGoBack() + webview.clearHistory() + assert not webview.canGoBack() + webview.removeEventListener 'ipc-message', listener + done() + webview.addEventListener 'ipc-message', listener + webview.setAttribute 'nodeintegration', 'on' + webview.src = "file://#{fixtures}/pages/history.html" + document.body.appendChild webview From 0e7bc6b8ec81984a92af708f15d935e084a04aad Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 20 May 2015 13:29:05 +0800 Subject: [PATCH 0040/1293] Make "original-fs" available as built-in module --- atom/common/lib/asar_init.coffee | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/atom/common/lib/asar_init.coffee b/atom/common/lib/asar_init.coffee index 49efc902d9af..211c79ee9099 100644 --- a/atom/common/lib/asar_init.coffee +++ b/atom/common/lib/asar_init.coffee @@ -9,10 +9,10 @@ return (process, require, asarSource) -> # Make graceful-fs work with asar. source = process.binding 'natives' - source.originalFs = source.fs - source.fs = """ + source['original-fs'] = source.fs + source['fs'] = """ var src = '(function (exports, require, module, __filename, __dirname) { ' + - process.binding('natives').originalFs + + process.binding('natives')['original-fs'] + ' });'; var vm = require('vm'); var fn = vm.runInThisContext(src, { filename: 'fs.js' }); From fa169ee7ff5f59fb57fcb7c75cf9b157a6a8e67c Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 20 May 2015 13:31:28 +0800 Subject: [PATCH 0041/1293] Remove the original-fs.js It is acutally not needed. --- atom/common/api/lib/original-fs.coffee | 8 -------- filenames.gypi | 1 - 2 files changed, 9 deletions(-) delete mode 100644 atom/common/api/lib/original-fs.coffee diff --git a/atom/common/api/lib/original-fs.coffee b/atom/common/api/lib/original-fs.coffee deleted file mode 100644 index e4e47f33120b..000000000000 --- a/atom/common/api/lib/original-fs.coffee +++ /dev/null @@ -1,8 +0,0 @@ -vm = require 'vm' - -# Execute the 'fs.js' and pass the 'exports' to it. -source = '(function (exports, require, module, __filename, __dirname) { ' + - process.binding('natives').originalFs + - '\n});' -fn = vm.runInThisContext source, { filename: 'fs.js' } -fn exports, require, module diff --git a/filenames.gypi b/filenames.gypi index 1aa038c0c339..2a94b44d1cbc 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -35,7 +35,6 @@ 'atom/common/api/lib/crash-reporter.coffee', 'atom/common/api/lib/id-weak-map.coffee', 'atom/common/api/lib/native-image.coffee', - 'atom/common/api/lib/original-fs.coffee', 'atom/common/api/lib/shell.coffee', 'atom/common/lib/init.coffee', 'atom/renderer/lib/chrome-api.coffee', From efd8a8a62477398b1e99f5a104dc2303895124f9 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 20 May 2015 13:37:46 +0800 Subject: [PATCH 0042/1293] spec: original-fs is available in forked scripts --- spec/asar-spec.coffee | 14 +++++++++++--- spec/fixtures/module/original-fs.js | 3 +++ 2 files changed, 14 insertions(+), 3 deletions(-) create mode 100644 spec/fixtures/module/original-fs.js diff --git a/spec/asar-spec.coffee b/spec/asar-spec.coffee index d78ab4360618..3ad706b69e5a 100644 --- a/spec/asar-spec.coffee +++ b/spec/asar-spec.coffee @@ -1,6 +1,7 @@ -assert = require 'assert' -fs = require 'fs' -path = require 'path' +assert = require 'assert' +child_process = require 'child_process' +fs = require 'fs' +path = require 'path' describe 'asar package', -> fixtures = path.join __dirname, 'fixtures' @@ -443,6 +444,13 @@ describe 'asar package', -> stats = originalFs.statSync file assert stats.isFile() + it 'is available in forked scripts', (done) -> + child = child_process.fork path.join(fixtures, 'module', 'original-fs.js') + child.on 'message', (msg) -> + assert.equal msg, 'object' + done() + child.send 'message' + describe 'graceful-fs module', -> gfs = require 'graceful-fs' diff --git a/spec/fixtures/module/original-fs.js b/spec/fixtures/module/original-fs.js new file mode 100644 index 000000000000..90b6abcf9b78 --- /dev/null +++ b/spec/fixtures/module/original-fs.js @@ -0,0 +1,3 @@ +process.on('message', function (msg) { + process.send(typeof require('original-fs')); +}); From fe19e63fbc1ccf768fca89590abb9c13d4fe85a2 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 20 May 2015 13:54:15 +0800 Subject: [PATCH 0043/1293] Update brightray for #1653 --- vendor/brightray | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/brightray b/vendor/brightray index 442d46faa757..2cd0e42cb837 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit 442d46faa7579156da7501c7256ce232b87aa329 +Subproject commit 2cd0e42cb8375f2793df531f5668d4414fe38698 From c548b9c87e3004ffe9bb85ac358f63f8473d6308 Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Wed, 13 May 2015 01:05:56 +0530 Subject: [PATCH 0044/1293] webContents: adding events to detect gpu and plugin process crashes --- atom/browser/api/atom_api_web_contents.cc | 14 ++++++++++++++ atom/browser/api/atom_api_web_contents.h | 9 ++++++++- atom/browser/lib/guest-view-manager.coffee | 2 ++ .../lib/web-view/guest-view-internal.coffee | 2 ++ docs/api/browser-window.md | 12 ++++++++++++ docs/api/web-view-tag.md | 11 +++++++++++ 6 files changed, 49 insertions(+), 1 deletion(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 2866871a004b..5a91062340d6 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -24,6 +24,7 @@ #include "content/public/browser/favicon_status.h" #include "content/public/browser/navigation_details.h" #include "content/public/browser/navigation_entry.h" +#include "content/public/browser/plugin_service.h" #include "content/public/browser/render_frame_host.h" #include "content/public/browser/render_process_host.h" #include "content/public/browser/render_view_host.h" @@ -223,6 +224,19 @@ void WebContents::RenderProcessGone(base::TerminationStatus status) { Emit("crashed"); } +void WebContents::PluginCrashed(const base::FilePath& plugin_path, + base::ProcessId plugin_pid) { + content::WebPluginInfo info; + auto plugin_service = content::PluginService::GetInstance(); + plugin_service->GetPluginInfoByPath(plugin_path, &info); + Emit("plugin-crashed", info.name, info.version); +} + +void WebContents::OnGpuProcessCrashed(base::TerminationStatus exit_code) { + if (exit_code == base::TERMINATION_STATUS_PROCESS_CRASHED) + Emit("gpu-crashed"); +} + void WebContents::DocumentLoadedInFrame( content::RenderFrameHost* render_frame_host) { if (!render_frame_host->GetParent()) diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index e75cfb0267f0..4d0937436f36 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -14,6 +14,7 @@ #include "content/public/common/favicon_url.h" #include "content/public/browser/web_contents_delegate.h" #include "content/public/browser/web_contents_observer.h" +#include "content/public/browser/gpu_data_manager_observer.h" #include "native_mate/handle.h" #include "ui/gfx/image/image.h" @@ -35,7 +36,8 @@ namespace api { class WebContents : public mate::EventEmitter, public content::BrowserPluginGuestDelegate, public content::WebContentsDelegate, - public content::WebContentsObserver { + public content::WebContentsObserver, + public content::GpuDataManagerObserver { public: // Create from an existing WebContents. static mate::Handle CreateFrom( @@ -182,6 +184,8 @@ class WebContents : public mate::EventEmitter, void TitleWasSet(content::NavigationEntry* entry, bool explicit_set) override; void DidUpdateFaviconURL( const std::vector& urls) override; + void PluginCrashed(const base::FilePath& plugin_path, + base::ProcessId plugin_pid) override; // content::BrowserPluginGuestDelegate: void DidAttach(int guest_proxy_routing_id) final; @@ -194,6 +198,9 @@ class WebContents : public mate::EventEmitter, int element_instance_id, bool is_full_page_plugin) final; + // content::GpuDataManagerObserver: + void OnGpuProcessCrashed(base::TerminationStatus exit_code) override; + private: // Called when received a message from renderer. void OnRendererMessage(const base::string16& channel, diff --git a/atom/browser/lib/guest-view-manager.coffee b/atom/browser/lib/guest-view-manager.coffee index a02a1676e8e6..9403466f27a7 100644 --- a/atom/browser/lib/guest-view-manager.coffee +++ b/atom/browser/lib/guest-view-manager.coffee @@ -15,6 +15,8 @@ supportedWebViewEvents = [ 'new-window' 'close' 'crashed' + 'gpu-crashed' + 'plugin-crashed' 'destroyed' 'page-title-set' 'page-favicon-updated' diff --git a/atom/renderer/lib/web-view/guest-view-internal.coffee b/atom/renderer/lib/web-view/guest-view-internal.coffee index 04aa5c5494f0..fb1b40d27e1f 100644 --- a/atom/renderer/lib/web-view/guest-view-internal.coffee +++ b/atom/renderer/lib/web-view/guest-view-internal.coffee @@ -17,6 +17,8 @@ WEB_VIEW_EVENTS = 'new-window': ['url', 'frameName', 'disposition'] 'close': [] 'crashed': [] + 'gpu-crashed': [] + 'plugin-crashed': ['name', 'version'] 'destroyed': [] 'page-title-set': ['title', 'explicitSet'] 'page-favicon-updated': ['favicons'] diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index f8ff8e7b9e0c..9808e3abfd15 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -724,6 +724,18 @@ Calling `event.preventDefault()` can prevent the navigation. Emitted when the renderer process is crashed. +### Event: 'gpu-crashed' + +Emitted when the gpu process is crashed. + +### Event: 'plugin-crashed' + +* `event` Event +* `name` String +* `version` String + +Emitted when a plugin process is crashed. + ### Event: 'destroyed' Emitted when the WebContents is destroyed. diff --git a/docs/api/web-view-tag.md b/docs/api/web-view-tag.md index 3e008a5db258..49c16fabae93 100644 --- a/docs/api/web-view-tag.md +++ b/docs/api/web-view-tag.md @@ -434,6 +434,17 @@ ipc.on('ping', function() { Fired when the renderer process is crashed. +### gpu-crashed + +Fired when the gpu process is crashed. + +### plugin-crashed + +* `name` String +* `version` String + +Fired when a plugin process is crashed. + ### destroyed Fired when the WebContents is destroyed. From f960c2dc6364eb584e423ed1f4d73a58f7926a84 Mon Sep 17 00:00:00 2001 From: Magica Date: Wed, 20 May 2015 18:04:51 +0800 Subject: [PATCH 0045/1293] doc: fix typo in pepper flash document Add brackets around `plugins: true` --- docs/tutorial/using-pepper-flash-plugin.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/tutorial/using-pepper-flash-plugin.md b/docs/tutorial/using-pepper-flash-plugin.md index 7a542e0003fb..bbb37862da44 100644 --- a/docs/tutorial/using-pepper-flash-plugin.md +++ b/docs/tutorial/using-pepper-flash-plugin.md @@ -40,8 +40,9 @@ app.on('ready', function() { mainWindow = new BrowserWindow({ 'width': 800, 'height': 600, - 'web-preferences': + 'web-preferences': { 'plugins': true + } }); mainWindow.loadUrl('file://' + __dirname + '/index.html'); // Something else From 04b797ff0ceb410255e363295cf284a765acf69e Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Thu, 7 May 2015 17:12:40 +0530 Subject: [PATCH 0046/1293] webContents: providing response headers in did-get-response-details event --- atom/browser/api/atom_api_web_contents.cc | 8 +++++++- atom/renderer/lib/web-view/guest-view-internal.coffee | 3 ++- docs/api/browser-window.md | 2 ++ docs/api/web-view-tag.md | 2 ++ 4 files changed, 13 insertions(+), 2 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 5a91062340d6..3ccb297514ba 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -278,13 +278,19 @@ void WebContents::DidStopLoading(content::RenderViewHost* render_view_host) { void WebContents::DidGetResourceResponseStart( const content::ResourceRequestDetails& details) { + auto context = AtomBrowserContext::Get(); + std::string headers; + if (context) + headers = context->GetNetworkDelegate()->GetResponseHeaders(details.url); + Emit("did-get-response-details", details.socket_address.IsEmpty(), details.url, details.original_url, details.http_response_code, details.method, - details.referrer); + details.referrer, + headers); } void WebContents::DidGetRedirectForResourceRequest( diff --git a/atom/renderer/lib/web-view/guest-view-internal.coffee b/atom/renderer/lib/web-view/guest-view-internal.coffee index fb1b40d27e1f..218108ce3773 100644 --- a/atom/renderer/lib/web-view/guest-view-internal.coffee +++ b/atom/renderer/lib/web-view/guest-view-internal.coffee @@ -10,7 +10,8 @@ WEB_VIEW_EVENTS = 'did-start-loading': [] 'did-stop-loading': [] 'did-get-response-details': ['status', 'newUrl', 'originalUrl', - 'httpResponseCode', 'requestMethod', 'referrer'] + 'httpResponseCode', 'requestMethod', 'referrer', + 'headers'] 'did-get-redirect-request': ['oldUrl', 'newUrl', 'isMainFrame'] 'dom-ready': [] 'console-message': ['level', 'message', 'line', 'sourceId'] diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 9808e3abfd15..14740e929c4e 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -666,9 +666,11 @@ Corresponds to the points in time when the spinner of the tab stops spinning. * `httpResponseCode` Integer * `requestMethod` String * `referrer` String +* `headers` String Emitted when details regarding a requested resource is available. `status` indicates the socket connection to download the resource. +`headers` is key-value string separated by new-line character. ### Event: 'did-get-redirect-request' diff --git a/docs/api/web-view-tag.md b/docs/api/web-view-tag.md index 49c16fabae93..55f4ad77bfac 100644 --- a/docs/api/web-view-tag.md +++ b/docs/api/web-view-tag.md @@ -325,9 +325,11 @@ Corresponds to the points in time when the spinner of the tab stops spinning. * `httpResponseCode` Integer * `requestMethod` String * `referrer` String +* `headers` String Fired when details regarding a requested resource is available. `status` indicates socket connection to download the resource. +`headers` is key-value string separated by new-line character. ### did-get-redirect-request From e80e4ae02c2cda76cb2e8cdec44687df19c16608 Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Wed, 20 May 2015 16:14:57 +0530 Subject: [PATCH 0047/1293] remove usage global browser context --- atom/browser/api/atom_api_web_contents.cc | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 3ccb297514ba..002739424f07 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -37,6 +37,7 @@ #include "native_mate/callback.h" #include "native_mate/dictionary.h" #include "native_mate/object_template_builder.h" +#include "net/url_request/url_request_context.h" #include "atom/common/node_includes.h" @@ -278,7 +279,8 @@ void WebContents::DidStopLoading(content::RenderViewHost* render_view_host) { void WebContents::DidGetResourceResponseStart( const content::ResourceRequestDetails& details) { - auto context = AtomBrowserContext::Get(); + auto context = static_cast( + web_contents()->GetBrowserContext()); std::string headers; if (context) headers = context->GetNetworkDelegate()->GetResponseHeaders(details.url); From 4ae1998d09563dae4861e1df533c600852e3c304 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 20 May 2015 20:35:54 +0800 Subject: [PATCH 0048/1293] Revert #1604 --- atom/browser/api/atom_api_web_contents.cc | 9 +-------- atom/renderer/lib/web-view/guest-view-internal.coffee | 3 +-- 2 files changed, 2 insertions(+), 10 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 002739424f07..0d9730d7afc5 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -279,20 +279,13 @@ void WebContents::DidStopLoading(content::RenderViewHost* render_view_host) { void WebContents::DidGetResourceResponseStart( const content::ResourceRequestDetails& details) { - auto context = static_cast( - web_contents()->GetBrowserContext()); - std::string headers; - if (context) - headers = context->GetNetworkDelegate()->GetResponseHeaders(details.url); - Emit("did-get-response-details", details.socket_address.IsEmpty(), details.url, details.original_url, details.http_response_code, details.method, - details.referrer, - headers); + details.referrer); } void WebContents::DidGetRedirectForResourceRequest( diff --git a/atom/renderer/lib/web-view/guest-view-internal.coffee b/atom/renderer/lib/web-view/guest-view-internal.coffee index 218108ce3773..fb1b40d27e1f 100644 --- a/atom/renderer/lib/web-view/guest-view-internal.coffee +++ b/atom/renderer/lib/web-view/guest-view-internal.coffee @@ -10,8 +10,7 @@ WEB_VIEW_EVENTS = 'did-start-loading': [] 'did-stop-loading': [] 'did-get-response-details': ['status', 'newUrl', 'originalUrl', - 'httpResponseCode', 'requestMethod', 'referrer', - 'headers'] + 'httpResponseCode', 'requestMethod', 'referrer'] 'did-get-redirect-request': ['oldUrl', 'newUrl', 'isMainFrame'] 'dom-ready': [] 'console-message': ['level', 'message', 'line', 'sourceId'] From 76447997902c04b8920fa1c683aa3626553e6774 Mon Sep 17 00:00:00 2001 From: Andy Dill Date: Wed, 20 May 2015 14:37:26 -0700 Subject: [PATCH 0049/1293] Check PATH first --- tools/compile-coffee.py | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/tools/compile-coffee.py b/tools/compile-coffee.py index 5b7a17c87716..d7423428f489 100755 --- a/tools/compile-coffee.py +++ b/tools/compile-coffee.py @@ -6,16 +6,15 @@ import sys SOURCE_ROOT = os.path.dirname(os.path.dirname(__file__)) -WINDOWS_NODE_PATHs = [ +WINDOWS_NODE_PATHs = os.environ['PATH'].split(os.pathsep) + [ 'C:/Program Files (x86)/nodejs', 'C:/Program Files/nodejs', -] + os.environ['PATH'].split(os.pathsep) -NIX_NODE_PATHs = [ +] +NIX_NODE_PATHs = os.environ['PATH'].split(os.pathsep) + [ '/usr/local/bin', '/usr/bin', '/bin', -] + os.environ['PATH'].split(os.pathsep) - +] def main(): input_file = sys.argv[1] From 71ee864d1d184f10aa03dbc70d51dadf46e92a09 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 21 May 2015 11:16:39 +0800 Subject: [PATCH 0050/1293] docs: Open devtools in the quick start example --- docs/tutorial/quick-start.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/tutorial/quick-start.md b/docs/tutorial/quick-start.md index d9f6504eb1fa..fbdad5b4ec4c 100644 --- a/docs/tutorial/quick-start.md +++ b/docs/tutorial/quick-start.md @@ -95,6 +95,9 @@ app.on('ready', function() { // and load the index.html of the app. mainWindow.loadUrl('file://' + __dirname + '/index.html'); + // Open the devtools. + mainWindow.openDevTools(); + // Emitted when the window is closed. mainWindow.on('closed', function() { // Dereference the window object, usually you would store windows From be5715103773e945f492ae905cc8f2be31376e02 Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Fri, 8 May 2015 11:48:15 +0530 Subject: [PATCH 0051/1293] webContents: override fullscreen notification apis for webview --- atom/browser/api/atom_api_web_contents.cc | 20 ++++++++++++++++++++ atom/browser/api/atom_api_web_contents.h | 5 +++++ 2 files changed, 25 insertions(+) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index b0f0a95ed2fd..2bd496ffce74 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -215,6 +215,26 @@ void WebContents::HandleKeyboardEvent( web_contents(), event); } +void WebContents::EnterFullscreenModeForTab(content::WebContents* web_contents, + const GURL& origin) { + GetWindowFromGuest(web_contents)->SetFullScreen(true); + web_contents->GetRenderViewHost()->WasResized(); +} + +void WebContents::ExitFullscreenModeForTab(content::WebContents* web_contents) { + GetWindowFromGuest(web_contents)->SetFullScreen(false); + web_contents->GetRenderViewHost()->WasResized(); +} + +bool WebContents::IsFullscreenForTabOrPending( + const content::WebContents* web_contents) const { + auto window = GetWindowFromGuest(web_contents); + if (window) + return window->IsFullscreen(); + else + return false; +} + void WebContents::RenderViewDeleted(content::RenderViewHost* render_view_host) { Emit("render-view-deleted", render_view_host->GetProcess()->GetID(), diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index eb69d65bf9aa..5e9a93e3b5c2 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -151,6 +151,11 @@ class WebContents : public mate::EventEmitter, void HandleKeyboardEvent( content::WebContents* source, const content::NativeWebKeyboardEvent& event) override; + void EnterFullscreenModeForTab(content::WebContents* web_contents, + const GURL& origin) override; + void ExitFullscreenModeForTab(content::WebContents* web_contents) override; + bool IsFullscreenForTabOrPending( + const content::WebContents* web_contents) const override; // content::WebContentsObserver: void RenderViewDeleted(content::RenderViewHost*) override; From 4fe294ed047c47d2c83942662c03b0e877dd774e Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Sat, 9 May 2015 17:47:40 +0530 Subject: [PATCH 0052/1293] check for renderviewhost availability before using --- atom/browser/api/atom_api_web_contents.cc | 22 ++++++++++++++-------- atom/browser/api/atom_api_web_contents.h | 6 +++--- 2 files changed, 17 insertions(+), 11 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 2bd496ffce74..02aa76fe6a04 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -215,20 +215,26 @@ void WebContents::HandleKeyboardEvent( web_contents(), event); } -void WebContents::EnterFullscreenModeForTab(content::WebContents* web_contents, +void WebContents::EnterFullscreenModeForTab(content::WebContents* source, const GURL& origin) { - GetWindowFromGuest(web_contents)->SetFullScreen(true); - web_contents->GetRenderViewHost()->WasResized(); + auto window = GetWindowFromGuest(source); + if (window) { + window->SetFullScreen(true); + source->GetRenderViewHost()->WasResized(); + } } -void WebContents::ExitFullscreenModeForTab(content::WebContents* web_contents) { - GetWindowFromGuest(web_contents)->SetFullScreen(false); - web_contents->GetRenderViewHost()->WasResized(); +void WebContents::ExitFullscreenModeForTab(content::WebContents* source) { + auto window = GetWindowFromGuest(source); + if (window) { + window->SetFullScreen(false); + source->GetRenderViewHost()->WasResized(); + } } bool WebContents::IsFullscreenForTabOrPending( - const content::WebContents* web_contents) const { - auto window = GetWindowFromGuest(web_contents); + const content::WebContents* source) const { + auto window = GetWindowFromGuest(source); if (window) return window->IsFullscreen(); else diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index 5e9a93e3b5c2..e1979a6dc5f2 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -151,11 +151,11 @@ class WebContents : public mate::EventEmitter, void HandleKeyboardEvent( content::WebContents* source, const content::NativeWebKeyboardEvent& event) override; - void EnterFullscreenModeForTab(content::WebContents* web_contents, + void EnterFullscreenModeForTab(content::WebContents* source, const GURL& origin) override; - void ExitFullscreenModeForTab(content::WebContents* web_contents) override; + void ExitFullscreenModeForTab(content::WebContents* source) override; bool IsFullscreenForTabOrPending( - const content::WebContents* web_contents) const override; + const content::WebContents* source) const override; // content::WebContentsObserver: void RenderViewDeleted(content::RenderViewHost*) override; From ddda8e4197588d0c3f4d791c1f7d6263d61957db Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Sun, 17 May 2015 01:37:46 +0530 Subject: [PATCH 0053/1293] track html api triggered fullscreen separaely --- atom/browser/api/atom_api_web_contents.cc | 6 +++--- atom/browser/native_window.cc | 12 +++++++++--- atom/browser/native_window.h | 8 ++++++++ 3 files changed, 20 insertions(+), 6 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 02aa76fe6a04..b0a6217988bc 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -219,7 +219,7 @@ void WebContents::EnterFullscreenModeForTab(content::WebContents* source, const GURL& origin) { auto window = GetWindowFromGuest(source); if (window) { - window->SetFullScreen(true); + window->SetHtmlApiFullscreen(true); source->GetRenderViewHost()->WasResized(); } } @@ -227,7 +227,7 @@ void WebContents::EnterFullscreenModeForTab(content::WebContents* source, void WebContents::ExitFullscreenModeForTab(content::WebContents* source) { auto window = GetWindowFromGuest(source); if (window) { - window->SetFullScreen(false); + window->SetHtmlApiFullscreen(false); source->GetRenderViewHost()->WasResized(); } } @@ -236,7 +236,7 @@ bool WebContents::IsFullscreenForTabOrPending( const content::WebContents* source) const { auto window = GetWindowFromGuest(source); if (window) - return window->IsFullscreen(); + return window->IsHtmlApiFullscreen(); else return false; } diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 8bc2c4616fe8..6ba941ff7dde 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -99,6 +99,7 @@ NativeWindow::NativeWindow(content::WebContents* web_contents, is_closed_(false), node_integration_(true), has_dialog_attached_(false), + fullscreen_(false), zoom_factor_(1.0), weak_factory_(this), inspectable_web_contents_( @@ -698,16 +699,16 @@ void NativeWindow::RendererResponsive(content::WebContents* source) { void NativeWindow::EnterFullscreenModeForTab(content::WebContents* source, const GURL& origin) { - SetFullScreen(true); + SetHtmlApiFullscreen(true); } void NativeWindow::ExitFullscreenModeForTab(content::WebContents* source) { - SetFullScreen(false); + SetHtmlApiFullscreen(false); } bool NativeWindow::IsFullscreenForTabOrPending( const content::WebContents* source) const { - return IsFullscreen(); + return IsHtmlApiFullscreen(); } void NativeWindow::BeforeUnloadFired(const base::TimeTicks& proceed_time) { @@ -800,6 +801,11 @@ void NativeWindow::ScheduleUnresponsiveEvent(int ms) { base::TimeDelta::FromMilliseconds(ms)); } +void NativeWindow::SetHtmlApiFullscreen(bool enter_fullscreen) { + SetFullScreen(enter_fullscreen); + fullscreen_ = enter_fullscreen; +} + void NativeWindow::NotifyWindowUnresponsive() { window_unresposive_closure_.Cancel(); diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index 39c58625ad2d..ae53fba76f1e 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -195,6 +195,9 @@ class NativeWindow : public brightray::DefaultWebContentsDelegate, int child_process_id); void OverrideWebkitPrefs(content::WebPreferences* prefs); + // Set fullscreen mode triggered by html api. + void SetHtmlApiFullscreen(bool enter_fullscreen); + // Public API used by platform-dependent delegates and observers to send UI // related notifications. void NotifyWindowClosed(); @@ -217,6 +220,8 @@ class NativeWindow : public brightray::DefaultWebContentsDelegate, bool has_frame() const { return has_frame_; } + bool IsHtmlApiFullscreen() const { return fullscreen_; } + void set_has_dialog_attached(bool has_dialog_attached) { has_dialog_attached_ = has_dialog_attached; } @@ -343,6 +348,9 @@ class NativeWindow : public brightray::DefaultWebContentsDelegate, // There is a dialog that has been attached to window. bool has_dialog_attached_; + // Whether window is fullscreened by HTML5 api. + bool fullscreen_; + // Closure that would be called when window is unresponsive when closing, // it should be cancelled when we can prove that the window is responsive. base::CancelableClosure window_unresposive_closure_; From f2d91bc53c4e7445f4a331d5c36f16390826a4f0 Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Sun, 17 May 2015 02:31:30 +0530 Subject: [PATCH 0054/1293] adding events to notify fullscreen state --- atom/browser/api/atom_api_window.cc | 8 ++++++++ atom/browser/api/atom_api_window.h | 2 ++ atom/browser/native_window.cc | 4 ++++ atom/browser/native_window_observer.h | 2 ++ docs/api/browser-window.md | 8 ++++++++ 5 files changed, 24 insertions(+) diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index b71499d3699c..252c8f920354 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -132,6 +132,14 @@ void Window::OnWindowLeaveFullScreen() { Emit("leave-full-screen"); } +void Window::OnWindowEnterHtmlFullScreen() { + Emit("enter-html-full-screen"); +} + +void Window::OnWindowLeaveHtmlFullScreen() { + Emit("leave-html-full-screen"); +} + void Window::OnRendererUnresponsive() { Emit("unresponsive"); } diff --git a/atom/browser/api/atom_api_window.h b/atom/browser/api/atom_api_window.h index d5c3ceedd2eb..8aa1ed0988dc 100644 --- a/atom/browser/api/atom_api_window.h +++ b/atom/browser/api/atom_api_window.h @@ -66,6 +66,8 @@ class Window : public mate::EventEmitter, void OnWindowRestore() override; void OnWindowEnterFullScreen() override; void OnWindowLeaveFullScreen() override; + void OnWindowEnterHtmlFullScreen() override; + void OnWindowLeaveHtmlFullScreen() override; void OnRendererUnresponsive() override; void OnRendererResponsive() override; void OnDevToolsFocus() override; diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 6ba941ff7dde..7d00483b20cc 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -700,10 +700,14 @@ void NativeWindow::RendererResponsive(content::WebContents* source) { void NativeWindow::EnterFullscreenModeForTab(content::WebContents* source, const GURL& origin) { SetHtmlApiFullscreen(true); + FOR_EACH_OBSERVER(NativeWindowObserver, observers_, + OnWindowEnterHtmlFullScreen()); } void NativeWindow::ExitFullscreenModeForTab(content::WebContents* source) { SetHtmlApiFullscreen(false); + FOR_EACH_OBSERVER(NativeWindowObserver, observers_, + OnWindowLeaveHtmlFullScreen()); } bool NativeWindow::IsFullscreenForTabOrPending( diff --git a/atom/browser/native_window_observer.h b/atom/browser/native_window_observer.h index aa5824946731..8c09e832a829 100644 --- a/atom/browser/native_window_observer.h +++ b/atom/browser/native_window_observer.h @@ -49,6 +49,8 @@ class NativeWindowObserver { virtual void OnWindowRestore() {} virtual void OnWindowEnterFullScreen() {} virtual void OnWindowLeaveFullScreen() {} + virtual void OnWindowEnterHtmlFullScreen() {} + virtual void OnWindowLeaveHtmlFullScreen() {} // Called when devtools window gets focused. virtual void OnDevToolsFocus() {} diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 4eb3eb332737..97844a8690e0 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -179,6 +179,14 @@ Emitted when window enters full screen state. Emitted when window leaves full screen state. +### Event: 'enter-html-full-screen' + +Emitted when window enters full screen state triggered by html api. + +### Event: 'leave-html-full-screen' + +Emitted when window leaves full screen state triggered by html api. + ### Event: 'devtools-opened' Emitted when devtools is opened. From 0dcf061dc1c4bfc4e02489f9659c45bbde244eb4 Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Tue, 19 May 2015 14:06:19 +0530 Subject: [PATCH 0055/1293] check if window is html or forced fullscreen --- atom/browser/api/atom_api_web_contents.cc | 2 ++ atom/browser/lib/guest-view-manager.coffee | 2 ++ atom/browser/native_window.cc | 18 ++++++++++++++++-- atom/browser/native_window.h | 7 +++++-- .../lib/web-view/guest-view-internal.coffee | 2 ++ docs/api/web-view-tag.md | 8 ++++++++ 6 files changed, 35 insertions(+), 4 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index b0a6217988bc..f72a4c4d1683 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -221,6 +221,7 @@ void WebContents::EnterFullscreenModeForTab(content::WebContents* source, if (window) { window->SetHtmlApiFullscreen(true); source->GetRenderViewHost()->WasResized(); + Emit("enter-html-full-screen"); } } @@ -229,6 +230,7 @@ void WebContents::ExitFullscreenModeForTab(content::WebContents* source) { if (window) { window->SetHtmlApiFullscreen(false); source->GetRenderViewHost()->WasResized(); + Emit("leave-html-full-screen"); } } diff --git a/atom/browser/lib/guest-view-manager.coffee b/atom/browser/lib/guest-view-manager.coffee index 9403466f27a7..f0d2a89318d6 100644 --- a/atom/browser/lib/guest-view-manager.coffee +++ b/atom/browser/lib/guest-view-manager.coffee @@ -20,6 +20,8 @@ supportedWebViewEvents = [ 'destroyed' 'page-title-set' 'page-favicon-updated' + 'enter-html-full-screen' + 'leave-html-full-screen' ] nextInstanceId = 0 diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 7d00483b20cc..79ea407f3da4 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -99,7 +99,7 @@ NativeWindow::NativeWindow(content::WebContents* web_contents, is_closed_(false), node_integration_(true), has_dialog_attached_(false), - fullscreen_(false), + html_fullscreen_(false), zoom_factor_(1.0), weak_factory_(this), inspectable_web_contents_( @@ -806,8 +806,22 @@ void NativeWindow::ScheduleUnresponsiveEvent(int ms) { } void NativeWindow::SetHtmlApiFullscreen(bool enter_fullscreen) { + // Window is already in fullscreen mode, save the state. + if (enter_fullscreen && IsFullscreen()) { + forced_fullscreen_ = true; + html_fullscreen_ = true; + return; + } + + // Exit html fullscreen state but not window's fullscreen mode. + if (!enter_fullscreen && forced_fullscreen_) { + html_fullscreen_ = false; + return; + } + SetFullScreen(enter_fullscreen); - fullscreen_ = enter_fullscreen; + html_fullscreen_ = enter_fullscreen; + forced_fullscreen_ = false; } void NativeWindow::NotifyWindowUnresponsive() { diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index ae53fba76f1e..f23c27ebf770 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -220,7 +220,7 @@ class NativeWindow : public brightray::DefaultWebContentsDelegate, bool has_frame() const { return has_frame_; } - bool IsHtmlApiFullscreen() const { return fullscreen_; } + bool IsHtmlApiFullscreen() const { return html_fullscreen_; } void set_has_dialog_attached(bool has_dialog_attached) { has_dialog_attached_ = has_dialog_attached; @@ -349,7 +349,10 @@ class NativeWindow : public brightray::DefaultWebContentsDelegate, bool has_dialog_attached_; // Whether window is fullscreened by HTML5 api. - bool fullscreen_; + bool html_fullscreen_; + + // Whether window is fullscreened by window api. + bool forced_fullscreen_; // Closure that would be called when window is unresponsive when closing, // it should be cancelled when we can prove that the window is responsive. diff --git a/atom/renderer/lib/web-view/guest-view-internal.coffee b/atom/renderer/lib/web-view/guest-view-internal.coffee index fb1b40d27e1f..e856896ae61d 100644 --- a/atom/renderer/lib/web-view/guest-view-internal.coffee +++ b/atom/renderer/lib/web-view/guest-view-internal.coffee @@ -22,6 +22,8 @@ WEB_VIEW_EVENTS = 'destroyed': [] 'page-title-set': ['title', 'explicitSet'] 'page-favicon-updated': ['favicons'] + 'enter-html-full-screen': [] + 'leave-html-full-screen': [] dispatchEvent = (webView, event, args...) -> throw new Error("Unkown event #{event}") unless WEB_VIEW_EVENTS[event]? diff --git a/docs/api/web-view-tag.md b/docs/api/web-view-tag.md index 5536920c5b7b..f607f0d225ba 100644 --- a/docs/api/web-view-tag.md +++ b/docs/api/web-view-tag.md @@ -361,6 +361,14 @@ url. Fired when page receives favicon urls. +### enter-html-full-screen + +Fired when page enters fullscreen triggered by html api. + +### leave-html-full-screen + +Fired when page leaves fullscreen triggered by html api. + ### console-message * `level` Integer From e8a02316ce78b684b03f3363daf4c1f9ddd891fe Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Thu, 21 May 2015 10:39:31 +0530 Subject: [PATCH 0056/1293] also emit html fullscreen notification on windows when its webview contents trigger it --- atom/browser/api/atom_api_web_contents.cc | 4 +- atom/browser/native_window.cc | 55 +++++++++++++---------- atom/browser/native_window.h | 6 ++- 3 files changed, 38 insertions(+), 27 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index f72a4c4d1683..734434aff1ae 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -220,6 +220,7 @@ void WebContents::EnterFullscreenModeForTab(content::WebContents* source, auto window = GetWindowFromGuest(source); if (window) { window->SetHtmlApiFullscreen(true); + window->NotifyWindowEnterHtmlFullScreen(); source->GetRenderViewHost()->WasResized(); Emit("enter-html-full-screen"); } @@ -229,6 +230,7 @@ void WebContents::ExitFullscreenModeForTab(content::WebContents* source) { auto window = GetWindowFromGuest(source); if (window) { window->SetHtmlApiFullscreen(false); + window->NotifyWindowLeaveHtmlFullScreen(); source->GetRenderViewHost()->WasResized(); Emit("leave-html-full-screen"); } @@ -238,7 +240,7 @@ bool WebContents::IsFullscreenForTabOrPending( const content::WebContents* source) const { auto window = GetWindowFromGuest(source); if (window) - return window->IsHtmlApiFullscreen(); + return window->is_html_api_fullscreen(); else return false; } diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 79ea407f3da4..e937bbdfccf1 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -100,6 +100,7 @@ NativeWindow::NativeWindow(content::WebContents* web_contents, node_integration_(true), has_dialog_attached_(false), html_fullscreen_(false), + native_fullscreen_(false), zoom_factor_(1.0), weak_factory_(this), inspectable_web_contents_( @@ -477,6 +478,25 @@ void NativeWindow::OverrideWebkitPrefs(content::WebPreferences* prefs) { } } +void NativeWindow::SetHtmlApiFullscreen(bool enter_fullscreen) { + // Window is already in fullscreen mode, save the state. + if (enter_fullscreen && IsFullscreen()) { + native_fullscreen_ = true; + html_fullscreen_ = true; + return; + } + + // Exit html fullscreen state but not window's fullscreen mode. + if (!enter_fullscreen && native_fullscreen_) { + html_fullscreen_ = false; + return; + } + + SetFullScreen(enter_fullscreen); + html_fullscreen_ = enter_fullscreen; + native_fullscreen_ = false; +} + void NativeWindow::NotifyWindowClosed() { if (is_closed_) return; @@ -525,6 +545,16 @@ void NativeWindow::NotifyWindowLeaveFullScreen() { OnWindowLeaveFullScreen()); } +void NativeWindow::NotifyWindowEnterHtmlFullScreen() { + FOR_EACH_OBSERVER(NativeWindowObserver, observers_, + OnWindowEnterHtmlFullScreen()); +} + +void NativeWindow::NotifyWindowLeaveHtmlFullScreen() { + FOR_EACH_OBSERVER(NativeWindowObserver, observers_, + OnWindowLeaveHtmlFullScreen()); +} + bool NativeWindow::ShouldCreateWebContents( content::WebContents* web_contents, int route_id, @@ -700,19 +730,15 @@ void NativeWindow::RendererResponsive(content::WebContents* source) { void NativeWindow::EnterFullscreenModeForTab(content::WebContents* source, const GURL& origin) { SetHtmlApiFullscreen(true); - FOR_EACH_OBSERVER(NativeWindowObserver, observers_, - OnWindowEnterHtmlFullScreen()); } void NativeWindow::ExitFullscreenModeForTab(content::WebContents* source) { SetHtmlApiFullscreen(false); - FOR_EACH_OBSERVER(NativeWindowObserver, observers_, - OnWindowLeaveHtmlFullScreen()); } bool NativeWindow::IsFullscreenForTabOrPending( const content::WebContents* source) const { - return IsHtmlApiFullscreen(); + return is_html_api_fullscreen(); } void NativeWindow::BeforeUnloadFired(const base::TimeTicks& proceed_time) { @@ -805,25 +831,6 @@ void NativeWindow::ScheduleUnresponsiveEvent(int ms) { base::TimeDelta::FromMilliseconds(ms)); } -void NativeWindow::SetHtmlApiFullscreen(bool enter_fullscreen) { - // Window is already in fullscreen mode, save the state. - if (enter_fullscreen && IsFullscreen()) { - forced_fullscreen_ = true; - html_fullscreen_ = true; - return; - } - - // Exit html fullscreen state but not window's fullscreen mode. - if (!enter_fullscreen && forced_fullscreen_) { - html_fullscreen_ = false; - return; - } - - SetFullScreen(enter_fullscreen); - html_fullscreen_ = enter_fullscreen; - forced_fullscreen_ = false; -} - void NativeWindow::NotifyWindowUnresponsive() { window_unresposive_closure_.Cancel(); diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index f23c27ebf770..b114ecf510b4 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -209,6 +209,8 @@ class NativeWindow : public brightray::DefaultWebContentsDelegate, void NotifyWindowRestore(); void NotifyWindowEnterFullScreen(); void NotifyWindowLeaveFullScreen(); + void NotifyWindowEnterHtmlFullScreen(); + void NotifyWindowLeaveHtmlFullScreen(); void AddObserver(NativeWindowObserver* obs) { observers_.AddObserver(obs); @@ -220,7 +222,7 @@ class NativeWindow : public brightray::DefaultWebContentsDelegate, bool has_frame() const { return has_frame_; } - bool IsHtmlApiFullscreen() const { return html_fullscreen_; } + bool is_html_api_fullscreen() const { return html_fullscreen_; } void set_has_dialog_attached(bool has_dialog_attached) { has_dialog_attached_ = has_dialog_attached; @@ -352,7 +354,7 @@ class NativeWindow : public brightray::DefaultWebContentsDelegate, bool html_fullscreen_; // Whether window is fullscreened by window api. - bool forced_fullscreen_; + bool native_fullscreen_; // Closure that would be called when window is unresponsive when closing, // it should be cancelled when we can prove that the window is responsive. From ea147c588ff62c1f0975015591ab913a821d3607 Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Thu, 14 May 2015 20:32:40 +0530 Subject: [PATCH 0057/1293] protocol: adding ftp scheme support --- atom/browser/atom_browser_context.cc | 3 +++ atom/renderer/atom_render_view_observer.cc | 19 +++++++++++++++++++ 2 files changed, 22 insertions(+) diff --git a/atom/browser/atom_browser_context.cc b/atom/browser/atom_browser_context.cc index d69aab22fa8a..d34001368eaf 100644 --- a/atom/browser/atom_browser_context.cc +++ b/atom/browser/atom_browser_context.cc @@ -16,8 +16,11 @@ #include "chrome/browser/browser_process.h" #include "content/public/browser/browser_thread.h" #include "content/public/common/url_constants.h" +#include "net/ftp/ftp_network_layer.h" #include "net/url_request/data_protocol_handler.h" +#include "net/url_request/ftp_protocol_handler.h" #include "net/url_request/url_request_intercepting_job_factory.h" +#include "net/url_request/url_request_context.h" #include "url/url_constants.h" using content::BrowserThread; diff --git a/atom/renderer/atom_render_view_observer.cc b/atom/renderer/atom_render_view_observer.cc index 2c1166b7e24f..095a4fd94922 100644 --- a/atom/renderer/atom_render_view_observer.cc +++ b/atom/renderer/atom_render_view_observer.cc @@ -16,12 +16,14 @@ #include "base/strings/string_number_conversions.h" #include "content/public/renderer/render_view.h" #include "ipc/ipc_message_macros.h" +#include "net/base/net_module.h" #include "third_party/WebKit/public/web/WebDraggableRegion.h" #include "third_party/WebKit/public/web/WebDocument.h" #include "third_party/WebKit/public/web/WebFrame.h" #include "third_party/WebKit/public/web/WebLocalFrame.h" #include "third_party/WebKit/public/web/WebKit.h" #include "third_party/WebKit/public/web/WebView.h" +#include "ui/base/resource/resource_bundle.h" #include "atom/common/node_includes.h" @@ -29,6 +31,11 @@ namespace atom { namespace { +// A hack here: +// Copy from net/grit/net_resources.h of chromium repository +// since libchromiumcontent doesn't expose it. +const int kIDR_DIR_HEADER_HTML = 4000; + bool GetIPCObject(v8::Isolate* isolate, v8::Handle context, v8::Handle* ipc) { @@ -49,6 +56,16 @@ std::vector> ListValueToVector( return result; } +base::StringPiece NetResourceProvider(int key) { + if (key == kIDR_DIR_HEADER_HTML) { + base::StringPiece html_data = + ui::ResourceBundle::GetSharedInstance().GetRawDataResource( + kIDR_DIR_HEADER_HTML); + return html_data; + } + return base::StringPiece(); +} + } // namespace AtomRenderViewObserver::AtomRenderViewObserver( @@ -57,6 +74,8 @@ AtomRenderViewObserver::AtomRenderViewObserver( : content::RenderViewObserver(render_view), renderer_client_(renderer_client), document_created_(false) { + // Initialise resource for directory listing. + net::NetModule::SetResourceProvider(NetResourceProvider); } AtomRenderViewObserver::~AtomRenderViewObserver() { From 27c3727ddb51a5ac8ab3116c614bac460e3e3ec4 Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Thu, 21 May 2015 11:07:25 +0530 Subject: [PATCH 0058/1293] use generated constants --- atom/browser/atom_browser_context.cc | 7 +++++++ atom/renderer/atom_render_view_observer.cc | 10 +++------- 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/atom/browser/atom_browser_context.cc b/atom/browser/atom_browser_context.cc index d34001368eaf..e31ebc4147e4 100644 --- a/atom/browser/atom_browser_context.cc +++ b/atom/browser/atom_browser_context.cc @@ -72,6 +72,13 @@ net::URLRequestJobFactory* AtomBrowserContext::CreateURLRequestJobFactory( job_factory->SetProtocolHandler( url::kWssScheme, new HttpProtocolHandler(url::kWssScheme)); + auto host_resolver = url_request_context_getter() + ->GetURLRequestContext() + ->host_resolver(); + job_factory->SetProtocolHandler( + url::kFtpScheme, new net::FtpProtocolHandler( + new net::FtpNetworkLayer(host_resolver))); + // Set up interceptors in the reverse order. scoped_ptr top_job_factory = job_factory.Pass(); content::URLRequestInterceptorScopedVector::reverse_iterator it; diff --git a/atom/renderer/atom_render_view_observer.cc b/atom/renderer/atom_render_view_observer.cc index 095a4fd94922..598af535ada6 100644 --- a/atom/renderer/atom_render_view_observer.cc +++ b/atom/renderer/atom_render_view_observer.cc @@ -17,6 +17,7 @@ #include "content/public/renderer/render_view.h" #include "ipc/ipc_message_macros.h" #include "net/base/net_module.h" +#include "net/grit/net_resources.h" #include "third_party/WebKit/public/web/WebDraggableRegion.h" #include "third_party/WebKit/public/web/WebDocument.h" #include "third_party/WebKit/public/web/WebFrame.h" @@ -31,11 +32,6 @@ namespace atom { namespace { -// A hack here: -// Copy from net/grit/net_resources.h of chromium repository -// since libchromiumcontent doesn't expose it. -const int kIDR_DIR_HEADER_HTML = 4000; - bool GetIPCObject(v8::Isolate* isolate, v8::Handle context, v8::Handle* ipc) { @@ -57,10 +53,10 @@ std::vector> ListValueToVector( } base::StringPiece NetResourceProvider(int key) { - if (key == kIDR_DIR_HEADER_HTML) { + if (key == IDR_DIR_HEADER_HTML) { base::StringPiece html_data = ui::ResourceBundle::GetSharedInstance().GetRawDataResource( - kIDR_DIR_HEADER_HTML); + IDR_DIR_HEADER_HTML); return html_data; } return base::StringPiece(); From 3ecfadf3675b18b7362d8636b8362f3589079f68 Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Sat, 16 May 2015 22:05:56 +0530 Subject: [PATCH 0059/1293] screen: initialise displays_ vector with available displays --- atom/browser/api/atom_api_screen.cc | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/atom/browser/api/atom_api_screen.cc b/atom/browser/api/atom_api_screen.cc index c595f350d920..3d2e46472472 100644 --- a/atom/browser/api/atom_api_screen.cc +++ b/atom/browser/api/atom_api_screen.cc @@ -48,6 +48,7 @@ std::vector MetricsToArray(uint32_t metrics) { } // namespace Screen::Screen(gfx::Screen* screen) : screen_(screen) { + displays_ = screen_->GetAllDisplays(); screen_->AddObserver(this); } @@ -64,11 +65,6 @@ gfx::Display Screen::GetPrimaryDisplay() { } std::vector Screen::GetAllDisplays() { - // The Screen::GetAllDisplays doesn't update when there is display added or - // removed, so we have to manually maintain the displays_ to make it up to - // date. - if (displays_.size() == 0) - displays_ = screen_->GetAllDisplays(); return displays_; } From 466fc9a2fa4d6b1d48710f4d102f6944596b33ec Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 21 May 2015 15:15:53 +0800 Subject: [PATCH 0060/1293] Remove trailing white space --- filenames.gypi | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/filenames.gypi b/filenames.gypi index adeb36466db5..5ba27229e321 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -114,7 +114,7 @@ 'atom/browser/atom_javascript_dialog_manager.cc', 'atom/browser/atom_javascript_dialog_manager.h', 'atom/browser/atom_quota_permission_context.cc', - 'atom/browser/atom_quota_permission_context.h', + 'atom/browser/atom_quota_permission_context.h', 'atom/browser/atom_resource_dispatcher_host_delegate.cc', 'atom/browser/atom_resource_dispatcher_host_delegate.h', 'atom/browser/atom_speech_recognition_manager_delegate.cc', From f31bfab127c47b3419b6ea787658e819d1e8be93 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 21 May 2015 15:22:52 +0800 Subject: [PATCH 0061/1293] gtk: Notify the click event --- atom/browser/ui/tray_icon_gtk.cc | 1 + 1 file changed, 1 insertion(+) diff --git a/atom/browser/ui/tray_icon_gtk.cc b/atom/browser/ui/tray_icon_gtk.cc index d95109c26e66..666e64101e88 100644 --- a/atom/browser/ui/tray_icon_gtk.cc +++ b/atom/browser/ui/tray_icon_gtk.cc @@ -42,6 +42,7 @@ void TrayIconGtk::SetContextMenu(ui::SimpleMenuModel* menu_model) { } void TrayIconGtk::OnClick() { + NotifyClicked(); } bool TrayIconGtk::HasClickAction() { From 82377cbfd5412a6ab60df2a84b7e46ae8ff14d02 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 21 May 2015 15:52:42 +0800 Subject: [PATCH 0062/1293] Bump v0.26.1 --- atom.gyp | 2 +- atom/browser/resources/mac/Info.plist | 2 +- atom/browser/resources/win/atom.rc | 8 ++++---- atom/common/atom_version.h | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/atom.gyp b/atom.gyp index 9ae9a90a122b..557d53028931 100644 --- a/atom.gyp +++ b/atom.gyp @@ -4,7 +4,7 @@ 'product_name%': 'Electron', 'company_name%': 'GitHub, Inc', 'company_abbr%': 'github', - 'version%': '0.26.0', + 'version%': '0.26.1', 'atom_source_root': 'CFBundleIconFile atom.icns CFBundleVersion - 0.26.0 + 0.26.1 LSMinimumSystemVersion 10.8.0 NSMainNibFile diff --git a/atom/browser/resources/win/atom.rc b/atom/browser/resources/win/atom.rc index 2de44863443c..5bc9521a3da1 100644 --- a/atom/browser/resources/win/atom.rc +++ b/atom/browser/resources/win/atom.rc @@ -50,8 +50,8 @@ END // VS_VERSION_INFO VERSIONINFO - FILEVERSION 0,26,0,0 - PRODUCTVERSION 0,26,0,0 + FILEVERSION 0,26,1,0 + PRODUCTVERSION 0,26,1,0 FILEFLAGSMASK 0x3fL #ifdef _DEBUG FILEFLAGS 0x1L @@ -68,12 +68,12 @@ BEGIN BEGIN VALUE "CompanyName", "GitHub, Inc." VALUE "FileDescription", "Electron" - VALUE "FileVersion", "0.26.0" + VALUE "FileVersion", "0.26.1" VALUE "InternalName", "electron.exe" VALUE "LegalCopyright", "Copyright (C) 2015 GitHub, Inc. All rights reserved." VALUE "OriginalFilename", "electron.exe" VALUE "ProductName", "Electron" - VALUE "ProductVersion", "0.26.0" + VALUE "ProductVersion", "0.26.1" VALUE "SquirrelAwareVersion", "1" END END diff --git a/atom/common/atom_version.h b/atom/common/atom_version.h index b14baf7ad702..b9c3d4a3bec8 100644 --- a/atom/common/atom_version.h +++ b/atom/common/atom_version.h @@ -7,7 +7,7 @@ #define ATOM_MAJOR_VERSION 0 #define ATOM_MINOR_VERSION 26 -#define ATOM_PATCH_VERSION 0 +#define ATOM_PATCH_VERSION 1 #define ATOM_VERSION_IS_RELEASE 1 From 9a768dd4f0f55149d8dbcbb191d559c42dfbc646 Mon Sep 17 00:00:00 2001 From: Andy Dill Date: Thu, 21 May 2015 08:54:27 -0700 Subject: [PATCH 0063/1293] Remove explicit nullptr and add clarifying comment. --- atom/common/crash_reporter/crash_reporter_win.cc | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/atom/common/crash_reporter/crash_reporter_win.cc b/atom/common/crash_reporter/crash_reporter_win.cc index ebb9a784da54..a348cf012612 100644 --- a/atom/common/crash_reporter/crash_reporter_win.cc +++ b/atom/common/crash_reporter/crash_reporter_win.cc @@ -54,7 +54,11 @@ void CrashReporterWin::InitBreakpad(const std::string& product_name, if (waiting_event != INVALID_HANDLE_VALUE) WaitForSingleObject(waiting_event, 1000); - breakpad_.reset(nullptr); + // ExceptionHandler() attaches our handler and ~ExceptionHandler() detaches + // it, so we must explicitly reset *before* we instantiate our new handler + // to allow any previous handler to detach in the correct order. + breakpad_.reset(); + int handler_types = google_breakpad::ExceptionHandler::HANDLER_EXCEPTION | google_breakpad::ExceptionHandler::HANDLER_PURECALL; breakpad_.reset(new google_breakpad::ExceptionHandler( From 33a926c5d30810b0494f1f88b00368b27d3ff4b0 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 22 May 2015 10:32:59 +0800 Subject: [PATCH 0064/1293] Fix typo --- docs/api/remote.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/remote.md b/docs/api/remote.md index 89bbc1f0606f..345b0d5b132d 100644 --- a/docs/api/remote.md +++ b/docs/api/remote.md @@ -3,7 +3,7 @@ The `remote` module provides a simple way to do inter-process communication between the renderer process and the main process. -In Electron, only GUI-related modules are available in the renderer process. +In Electron, only GUI-unrelated modules are available in the renderer process. Without the `remote` module, users who wanted to call a main process API in the renderer process would have to explicitly send inter-process messages to the main process. With the `remote` module, users can invoke methods of From 3a5977e09fac2ea045258ba2d592e5049b174472 Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Sat, 9 May 2015 21:25:10 +0530 Subject: [PATCH 0065/1293] window: adding resize and move events --- atom/browser/api/atom_api_window.cc | 8 ++++++++ atom/browser/api/atom_api_window.h | 2 ++ atom/browser/native_window.cc | 8 ++++++++ atom/browser/native_window.h | 2 ++ atom/browser/native_window_mac.mm | 6 ++++++ atom/browser/native_window_observer.h | 2 ++ atom/browser/native_window_views.cc | 16 ++++++++++++++++ atom/browser/native_window_views.h | 4 ++++ docs/api/browser-window.md | 18 ++++++++++++++++++ spec/api-browser-window-spec.coffee | 20 +++++++++++++++----- 10 files changed, 81 insertions(+), 5 deletions(-) diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index 252c8f920354..dcdc10dc36a8 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -124,6 +124,14 @@ void Window::OnWindowRestore() { Emit("restore"); } +void Window::OnWindowResize() { + Emit("resize", GetBounds().size()); +} + +void Window::OnWindowMove() { + Emit("move", window_->GetPosition()); +} + void Window::OnWindowEnterFullScreen() { Emit("enter-full-screen"); } diff --git a/atom/browser/api/atom_api_window.h b/atom/browser/api/atom_api_window.h index 8aa1ed0988dc..efe196bd55fc 100644 --- a/atom/browser/api/atom_api_window.h +++ b/atom/browser/api/atom_api_window.h @@ -64,6 +64,8 @@ class Window : public mate::EventEmitter, void OnWindowUnmaximize() override; void OnWindowMinimize() override; void OnWindowRestore() override; + void OnWindowResize() override; + void OnWindowMove() override; void OnWindowEnterFullScreen() override; void OnWindowLeaveFullScreen() override; void OnWindowEnterHtmlFullScreen() override; diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index e937bbdfccf1..9bc97d5d192e 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -535,6 +535,14 @@ void NativeWindow::NotifyWindowRestore() { FOR_EACH_OBSERVER(NativeWindowObserver, observers_, OnWindowRestore()); } +void NativeWindow::NotifyWindowResize() { + FOR_EACH_OBSERVER(NativeWindowObserver, observers_, OnWindowResize()); +} + +void NativeWindow::NotifyWindowMove() { + FOR_EACH_OBSERVER(NativeWindowObserver, observers_, OnWindowMove()); +} + void NativeWindow::NotifyWindowEnterFullScreen() { FOR_EACH_OBSERVER(NativeWindowObserver, observers_, OnWindowEnterFullScreen()); diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index b114ecf510b4..7f72ebdf5e02 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -207,6 +207,8 @@ class NativeWindow : public brightray::DefaultWebContentsDelegate, void NotifyWindowUnmaximize(); void NotifyWindowMinimize(); void NotifyWindowRestore(); + void NotifyWindowMove(); + void NotifyWindowResize(); void NotifyWindowEnterFullScreen(); void NotifyWindowLeaveFullScreen(); void NotifyWindowEnterHtmlFullScreen(); diff --git a/atom/browser/native_window_mac.mm b/atom/browser/native_window_mac.mm index a9ff57d8d279..6a21f33b2ffc 100644 --- a/atom/browser/native_window_mac.mm +++ b/atom/browser/native_window_mac.mm @@ -98,6 +98,12 @@ static const CGFloat kAtomWindowCornerRadius = 4.0; - (void)windowDidResize:(NSNotification*)notification { if (!shell_->has_frame()) shell_->ClipWebView(); + + shell_->NotifyWindowResize(); +} + +- (void)windowDidMove:(NSNotification*)notification { + shell_->NotifyWindowMove(); } - (void)windowDidMiniaturize:(NSNotification*)notification { diff --git a/atom/browser/native_window_observer.h b/atom/browser/native_window_observer.h index 8c09e832a829..1db1fed7cbfa 100644 --- a/atom/browser/native_window_observer.h +++ b/atom/browser/native_window_observer.h @@ -47,6 +47,8 @@ class NativeWindowObserver { virtual void OnWindowUnmaximize() {} virtual void OnWindowMinimize() {} virtual void OnWindowRestore() {} + virtual void OnWindowResize() {} + virtual void OnWindowMove() {} virtual void OnWindowEnterFullScreen() {} virtual void OnWindowLeaveFullScreen() {} virtual void OnWindowEnterHtmlFullScreen() {} diff --git a/atom/browser/native_window_views.cc b/atom/browser/native_window_views.cc index 4c99f88969ba..29e480ce7382 100644 --- a/atom/browser/native_window_views.cc +++ b/atom/browser/native_window_views.cc @@ -720,6 +720,22 @@ void NativeWindowViews::OnWidgetActivationChanged( SetMenuBarVisibility(false); } +void NativeWindowViews::OnWidgetBoundsChanged( + views::Widget* widget, const gfx::Rect& bounds) { + if (widget != window_.get()) + return; + + if (widget_size_ != bounds.size()) { + NotifyWindowResize(); + widget_size_ = bounds.size(); + } + + if (widget_pos_ != bounds.origin()) { + NotifyWindowMove(); + widget_pos_ = bounds.origin(); + } +} + void NativeWindowViews::DeleteDelegate() { NotifyWindowClosed(); } diff --git a/atom/browser/native_window_views.h b/atom/browser/native_window_views.h index 15f073d8d8c1..88d2c78eee2d 100644 --- a/atom/browser/native_window_views.h +++ b/atom/browser/native_window_views.h @@ -93,6 +93,8 @@ class NativeWindowViews : public NativeWindow, // views::WidgetObserver: void OnWidgetActivationChanged( views::Widget* widget, bool active) override; + void OnWidgetBoundsChanged( + views::Widget* widget, const gfx::Rect& bounds) override; // views::WidgetDelegate: void DeleteDelegate() override; @@ -173,6 +175,8 @@ class NativeWindowViews : public NativeWindow, std::string title_; gfx::Size minimum_size_; gfx::Size maximum_size_; + gfx::Size widget_size_; + gfx::Point widget_pos_; scoped_ptr draggable_region_; diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index cc68f2008b9e..056148b398d8 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -171,6 +171,24 @@ Emitted when window is minimized. Emitted when window is restored from minimized state. +### Event: 'resize' + +* `event` Event +* `value` Object + * `width` Integer + * `height` Integer + +Emitted when window is resized. + +### Event: 'move' + +* `event` Event +* `value` Object + * `x` Integer + * `y` Integer + +Emitted when window is moved. + ### Event: 'enter-full-screen' Emitted when window enters full screen state. diff --git a/spec/api-browser-window-spec.coffee b/spec/api-browser-window-spec.coffee index 958bd7295803..12f790d3b29b 100644 --- a/spec/api-browser-window-spec.coffee +++ b/spec/api-browser-window-spec.coffee @@ -90,12 +90,22 @@ describe 'browser-window module', -> done() describe 'BrowserWindow.setSize(width, height)', -> - it 'sets the window size', -> - size = [400, 400] + it 'sets the window size', (done) -> + size = [20, 400] + w.on 'resize', (e, value) -> + assert.equal value.width, size[0] + assert.equal value.height, size[1] + done() w.setSize size[0], size[1] - after = w.getSize() - assert.equal after[0], size[0] - assert.equal after[1], size[1] + + describe 'BrowserWindow.setPosition(x, y)', -> + it 'sets the window position', (done) -> + pos = [10, 10] + w.on 'move', (e, value) -> + assert.equal value.x, pos[0] + assert.equal value.y, pos[1] + done() + w.setPosition pos[0], pos[1] describe 'BrowserWindow.setContentSize(width, height)', -> it 'sets the content size', -> From 1b1735bca932fa6b6cc86cccccbb68cb72c60d61 Mon Sep 17 00:00:00 2001 From: Robo Date: Sat, 9 May 2015 23:33:16 +0530 Subject: [PATCH 0066/1293] avoid unnecessary api calls --- atom/browser/api/atom_api_window.cc | 4 ++-- docs/api/browser-window.md | 10 ---------- spec/api-browser-window-spec.coffee | 14 ++++++++------ 3 files changed, 10 insertions(+), 18 deletions(-) diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index dcdc10dc36a8..f7f6c7239fef 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -125,11 +125,11 @@ void Window::OnWindowRestore() { } void Window::OnWindowResize() { - Emit("resize", GetBounds().size()); + Emit("resize"); } void Window::OnWindowMove() { - Emit("move", window_->GetPosition()); + Emit("move"); } void Window::OnWindowEnterFullScreen() { diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 056148b398d8..d95baa5deb90 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -173,20 +173,10 @@ Emitted when window is restored from minimized state. ### Event: 'resize' -* `event` Event -* `value` Object - * `width` Integer - * `height` Integer - Emitted when window is resized. ### Event: 'move' -* `event` Event -* `value` Object - * `x` Integer - * `y` Integer - Emitted when window is moved. ### Event: 'enter-full-screen' diff --git a/spec/api-browser-window-spec.coffee b/spec/api-browser-window-spec.coffee index 12f790d3b29b..fb5c26abc457 100644 --- a/spec/api-browser-window-spec.coffee +++ b/spec/api-browser-window-spec.coffee @@ -92,18 +92,20 @@ describe 'browser-window module', -> describe 'BrowserWindow.setSize(width, height)', -> it 'sets the window size', (done) -> size = [20, 400] - w.on 'resize', (e, value) -> - assert.equal value.width, size[0] - assert.equal value.height, size[1] + w.on 'resize', -> + newSize = w.getSize() + assert.equal newSize[0], size[0] + assert.equal newSize[1], size[1] done() w.setSize size[0], size[1] describe 'BrowserWindow.setPosition(x, y)', -> it 'sets the window position', (done) -> pos = [10, 10] - w.on 'move', (e, value) -> - assert.equal value.x, pos[0] - assert.equal value.y, pos[1] + w.on 'move', -> + newPos = w.getPosition() + assert.equal newPos[0], pos[0] + assert.equal newPos[1], pos[1] done() w.setPosition pos[0], pos[1] From f46fcd158af4f6505df9f71d0b35290886c79b51 Mon Sep 17 00:00:00 2001 From: Robo Date: Sun, 10 May 2015 09:14:18 +0530 Subject: [PATCH 0067/1293] chnage move hook and add details to doc --- atom/browser/native_window_views.cc | 9 ++++----- atom/browser/native_window_views.h | 2 +- docs/api/browser-window.md | 5 +++-- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/atom/browser/native_window_views.cc b/atom/browser/native_window_views.cc index 29e480ce7382..630c7e086f60 100644 --- a/atom/browser/native_window_views.cc +++ b/atom/browser/native_window_views.cc @@ -729,11 +729,6 @@ void NativeWindowViews::OnWidgetBoundsChanged( NotifyWindowResize(); widget_size_ = bounds.size(); } - - if (widget_pos_ != bounds.origin()) { - NotifyWindowMove(); - widget_pos_ = bounds.origin(); - } } void NativeWindowViews::DeleteDelegate() { @@ -823,6 +818,10 @@ views::NonClientFrameView* NativeWindowViews::CreateNonClientFrameView( #endif } +void NativeWindowViews::OnWidgetMove() { + NotifyWindowMove(); +} + #if defined(OS_WIN) bool NativeWindowViews::ExecuteWindowsCommand(int command_id) { // Windows uses the 4 lower order bits of |command_id| for type-specific diff --git a/atom/browser/native_window_views.h b/atom/browser/native_window_views.h index 88d2c78eee2d..aa694f053734 100644 --- a/atom/browser/native_window_views.h +++ b/atom/browser/native_window_views.h @@ -115,6 +115,7 @@ class NativeWindowViews : public NativeWindow, views::ClientView* CreateClientView(views::Widget* widget) override; views::NonClientFrameView* CreateNonClientFrameView( views::Widget* widget) override; + void OnWidgetMove() override; #if defined(OS_WIN) bool ExecuteWindowsCommand(int command_id) override; #endif @@ -176,7 +177,6 @@ class NativeWindowViews : public NativeWindow, gfx::Size minimum_size_; gfx::Size maximum_size_; gfx::Size widget_size_; - gfx::Point widget_pos_; scoped_ptr draggable_region_; diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index d95baa5deb90..00e2ceb46945 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -173,11 +173,12 @@ Emitted when window is restored from minimized state. ### Event: 'resize' -Emitted when window is resized. +Emitted when window is getting resized on all platforms. ### Event: 'move' -Emitted when window is moved. +Emitted once when the window is moved to a new position on `OSX` and emitted during the process +of moving on `Linux` and `Windows`. ### Event: 'enter-full-screen' From 9a60fde59b2dc789c59e71d72c4aa4525f01041c Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Wed, 20 May 2015 14:07:13 +0530 Subject: [PATCH 0068/1293] alias move and moved event on OS X --- atom/browser/api/atom_api_window.cc | 4 ++++ atom/browser/api/atom_api_window.h | 1 + atom/browser/native_window.cc | 4 ++++ atom/browser/native_window.h | 1 + atom/browser/native_window_mac.mm | 3 +++ atom/browser/native_window_observer.h | 1 + atom/browser/native_window_views.cc | 1 + docs/api/browser-window.md | 9 ++++++--- 8 files changed, 21 insertions(+), 3 deletions(-) diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index f7f6c7239fef..4e3aadd47ba5 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -132,6 +132,10 @@ void Window::OnWindowMove() { Emit("move"); } +void Window::OnWindowMoved() { + Emit("moved"); +} + void Window::OnWindowEnterFullScreen() { Emit("enter-full-screen"); } diff --git a/atom/browser/api/atom_api_window.h b/atom/browser/api/atom_api_window.h index efe196bd55fc..f9c85e75fef9 100644 --- a/atom/browser/api/atom_api_window.h +++ b/atom/browser/api/atom_api_window.h @@ -66,6 +66,7 @@ class Window : public mate::EventEmitter, void OnWindowRestore() override; void OnWindowResize() override; void OnWindowMove() override; + void OnWindowMoved() override; void OnWindowEnterFullScreen() override; void OnWindowLeaveFullScreen() override; void OnWindowEnterHtmlFullScreen() override; diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 9bc97d5d192e..dd1a389228c6 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -543,6 +543,10 @@ void NativeWindow::NotifyWindowMove() { FOR_EACH_OBSERVER(NativeWindowObserver, observers_, OnWindowMove()); } +void NativeWindow::NotifyWindowMoved() { + FOR_EACH_OBSERVER(NativeWindowObserver, observers_, OnWindowMoved()); +} + void NativeWindow::NotifyWindowEnterFullScreen() { FOR_EACH_OBSERVER(NativeWindowObserver, observers_, OnWindowEnterFullScreen()); diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index 7f72ebdf5e02..d95f7faf9178 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -209,6 +209,7 @@ class NativeWindow : public brightray::DefaultWebContentsDelegate, void NotifyWindowRestore(); void NotifyWindowMove(); void NotifyWindowResize(); + void NotifyWindowMoved(); void NotifyWindowEnterFullScreen(); void NotifyWindowLeaveFullScreen(); void NotifyWindowEnterHtmlFullScreen(); diff --git a/atom/browser/native_window_mac.mm b/atom/browser/native_window_mac.mm index 6a21f33b2ffc..8130d2c0fedd 100644 --- a/atom/browser/native_window_mac.mm +++ b/atom/browser/native_window_mac.mm @@ -103,7 +103,10 @@ static const CGFloat kAtomWindowCornerRadius = 4.0; } - (void)windowDidMove:(NSNotification*)notification { + // TODO(zcbenz): Remove the alias after figuring out a proper + // way to disptach move. shell_->NotifyWindowMove(); + shell_->NotifyWindowMoved(); } - (void)windowDidMiniaturize:(NSNotification*)notification { diff --git a/atom/browser/native_window_observer.h b/atom/browser/native_window_observer.h index 1db1fed7cbfa..417731fb3474 100644 --- a/atom/browser/native_window_observer.h +++ b/atom/browser/native_window_observer.h @@ -49,6 +49,7 @@ class NativeWindowObserver { virtual void OnWindowRestore() {} virtual void OnWindowResize() {} virtual void OnWindowMove() {} + virtual void OnWindowMoved() {} virtual void OnWindowEnterFullScreen() {} virtual void OnWindowLeaveFullScreen() {} virtual void OnWindowEnterHtmlFullScreen() {} diff --git a/atom/browser/native_window_views.cc b/atom/browser/native_window_views.cc index 630c7e086f60..69c595f1df46 100644 --- a/atom/browser/native_window_views.cc +++ b/atom/browser/native_window_views.cc @@ -176,6 +176,7 @@ NativeWindowViews::NativeWindowViews(content::WebContents* web_contents, options.Get(switches::kWidth, &width); options.Get(switches::kHeight, &height); gfx::Rect bounds(0, 0, width, height); + widget_size_ = bounds.size(); window_->AddObserver(this); diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 00e2ceb46945..5476275bd502 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -173,12 +173,15 @@ Emitted when window is restored from minimized state. ### Event: 'resize' -Emitted when window is getting resized on all platforms. +Emitted when window is getting resized. ### Event: 'move' -Emitted once when the window is moved to a new position on `OSX` and emitted during the process -of moving on `Linux` and `Windows`. +Emitted when the window is getting moved to a new position. + +### Event: 'moved' + +Emitted once when the window is moved to a new position. ### Event: 'enter-full-screen' From 63c2a7f1a92a05568f116552f720a7daf3b33cd5 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 22 May 2015 14:57:00 +0800 Subject: [PATCH 0069/1293] Upgrade to Chrome 43 --- script/lib/config.py | 2 +- vendor/brightray | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/script/lib/config.py b/script/lib/config.py index eb17cc92c4fd..02b99458e46c 100644 --- a/script/lib/config.py +++ b/script/lib/config.py @@ -7,7 +7,7 @@ import sys BASE_URL = 'http://gh-contractor-zcbenz.s3.amazonaws.com/libchromiumcontent' -LIBCHROMIUMCONTENT_COMMIT = '90a5b9c3792645067ad9517e60cf5eb99730e0f9' +LIBCHROMIUMCONTENT_COMMIT = '1a1ecefebd8aef44cf0dafe6f4315ecdd367e54c' PLATFORM = { 'cygwin': 'win32', diff --git a/vendor/brightray b/vendor/brightray index 2cd0e42cb837..7addcd81c6af 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit 2cd0e42cb8375f2793df531f5668d4414fe38698 +Subproject commit 7addcd81c6af25691b09c27bd461d63176eb6b87 From c82d21b39f416ffa5153f77ecfc8b124d6099a07 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 22 May 2015 15:01:13 +0800 Subject: [PATCH 0070/1293] Add AtomRenderFrameObserver --- atom/renderer/atom_renderer_client.cc | 24 +++++++++++++++++++++++- atom/renderer/atom_renderer_client.h | 8 ++++---- 2 files changed, 27 insertions(+), 5 deletions(-) diff --git a/atom/renderer/atom_renderer_client.cc b/atom/renderer/atom_renderer_client.cc index d90a90b9415f..5b8193a4915e 100644 --- a/atom/renderer/atom_renderer_client.cc +++ b/atom/renderer/atom_renderer_client.cc @@ -11,12 +11,13 @@ #include "atom/common/options_switches.h" #include "atom/renderer/atom_render_view_observer.h" #include "atom/renderer/guest_view_container.h" +#include "base/command_line.h" #include "chrome/renderer/pepper/pepper_helper.h" #include "chrome/renderer/printing/print_web_view_helper.h" #include "chrome/renderer/tts_dispatcher.h" #include "content/public/common/content_constants.h" +#include "content/public/renderer/render_frame_observer.h" #include "content/public/renderer/render_thread.h" -#include "base/command_line.h" #include "third_party/WebKit/public/web/WebCustomElement.h" #include "third_party/WebKit/public/web/WebFrame.h" #include "third_party/WebKit/public/web/WebPluginParams.h" @@ -46,6 +47,27 @@ bool IsGuestFrame(blink::WebFrame* frame) { return frame->uniqueName().utf8() == "ATOM_SHELL_GUEST_WEB_VIEW"; } +// Helper class to forward the messages to the client. +class AtomRenderFrameObserver : public content::RenderFrameObserver { + public: + AtomRenderFrameObserver(content::RenderFrame* frame, + AtomRendererClient* renderer_client) + : content::RenderFrameObserver(frame), + renderer_client_(renderer_client) {} + + // content::RenderFrameObserver: + void DidCreateScriptContext(blink::WebFrame* frame, + v8::Handle context, + int world_id) { + renderer_client_->DidCreateScriptContext(frame, context, world_id); + } + + private: + AtomRendererClient* renderer_client_; + + DISALLOW_COPY_AND_ASSIGN(AtomRenderFrameObserver); +}; + } // namespace AtomRendererClient::AtomRendererClient() diff --git a/atom/renderer/atom_renderer_client.h b/atom/renderer/atom_renderer_client.h index a7096125580c..2bbbc3c1d9b3 100644 --- a/atom/renderer/atom_renderer_client.h +++ b/atom/renderer/atom_renderer_client.h @@ -21,6 +21,10 @@ class AtomRendererClient : public content::ContentRendererClient, AtomRendererClient(); virtual ~AtomRendererClient(); + void DidCreateScriptContext(blink::WebFrame* frame, + v8::Handle context, + int world_id); + private: enum NodeIntegration { ALL, @@ -42,10 +46,6 @@ class AtomRendererClient : public content::ContentRendererClient, blink::WebLocalFrame* frame, const blink::WebPluginParams& params, blink::WebPlugin** plugin) override; - void DidCreateScriptContext(blink::WebFrame* frame, - v8::Handle context, - int extension_group, - int world_id) override; bool ShouldFork(blink::WebFrame* frame, const GURL& url, const std::string& http_method, From 01e891652f1a34d505d67906f2740c92afa904b8 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 22 May 2015 15:24:34 +0800 Subject: [PATCH 0071/1293] Fix compilation errors --- atom/browser/api/atom_api_web_contents.cc | 27 +++++++++---------- atom/browser/api/atom_api_web_contents.h | 13 ++++----- atom/browser/atom_javascript_dialog_manager.h | 2 +- atom/common/api/atom_api_v8_util.cc | 3 +-- atom/common/asar/archive.cc | 9 ++++--- atom/renderer/atom_renderer_client.cc | 17 ++++++------ atom/renderer/atom_renderer_client.h | 3 +-- 7 files changed, 34 insertions(+), 40 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 734434aff1ae..1f3afb582710 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -22,6 +22,7 @@ #include "brightray/browser/inspectable_web_contents.h" #include "brightray/browser/media/media_stream_devices_controller.h" #include "content/public/browser/favicon_status.h" +#include "content/public/browser/guest_host.h" #include "content/public/browser/navigation_details.h" #include "content/public/browser/navigation_entry.h" #include "content/public/browser/plugin_service.h" @@ -81,7 +82,7 @@ WebContents::WebContents(content::WebContents* web_contents) guest_instance_id_(-1), element_instance_id_(-1), guest_opaque_(true), - guest_sizer_(nullptr), + guest_host_(nullptr), auto_size_enabled_(false) { } @@ -89,7 +90,7 @@ WebContents::WebContents(const mate::Dictionary& options) : guest_instance_id_(-1), element_instance_id_(-1), guest_opaque_(true), - guest_sizer_(nullptr), + guest_host_(nullptr), auto_size_enabled_(false) { options.Get("guestInstanceId", &guest_instance_id_); @@ -299,11 +300,11 @@ void WebContents::DidFailLoad(content::RenderFrameHost* render_frame_host, Emit("did-fail-load", error_code, error_description); } -void WebContents::DidStartLoading(content::RenderViewHost* render_view_host) { +void WebContents::DidStartLoading() { Emit("did-start-loading"); } -void WebContents::DidStopLoading(content::RenderViewHost* render_view_host) { +void WebContents::DidStopLoading() { Emit("did-stop-loading"); } @@ -406,7 +407,7 @@ void WebContents::ElementSizeChanged(const gfx::Size& size) { // Only resize if needed. if (!size.IsEmpty()) - guest_sizer_->SizeContents(size); + guest_host_->SizeContents(size); } content::WebContents* WebContents::GetOwnerWebContents() const { @@ -420,13 +421,8 @@ void WebContents::GuestSizeChanged(const gfx::Size& new_size) { guest_size_ = new_size; } -void WebContents::RegisterDestructionCallback( - const DestructionCallback& callback) { - destruction_callback_ = callback; -} - -void WebContents::SetGuestSizer(content::GuestSizer* guest_sizer) { - guest_sizer_ = guest_sizer; +void WebContents::SetGuestHost(content::GuestHost* guest_host) { + guest_host_ = guest_host; } void WebContents::WillAttach(content::WebContents* embedder_web_contents, @@ -438,12 +434,13 @@ void WebContents::WillAttach(content::WebContents* embedder_web_contents, void WebContents::Destroy() { if (storage_) { - if (!destruction_callback_.is_null()) - destruction_callback_.Run(); - // When force destroying the "destroyed" event is not emitted. WebContentsDestroyed(); + // Give the content module an opportunity to perform some cleanup. + guest_host_->WillDestroy(); + guest_host_ = nullptr; + Observe(nullptr); storage_.reset(); } diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index e1979a6dc5f2..204f7d2b6a6f 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -172,8 +172,8 @@ class WebContents : public mate::EventEmitter, const GURL& validated_url, int error_code, const base::string16& error_description) override; - void DidStartLoading(content::RenderViewHost* render_view_host) override; - void DidStopLoading(content::RenderViewHost* render_view_host) override; + void DidStartLoading() override; + void DidStopLoading() override; void DidGetResourceResponseStart( const content::ResourceRequestDetails& details) override; void DidGetRedirectForResourceRequest( @@ -198,8 +198,7 @@ class WebContents : public mate::EventEmitter, void ElementSizeChanged(const gfx::Size& size) final; content::WebContents* GetOwnerWebContents() const final; void GuestSizeChanged(const gfx::Size& new_size) final; - void RegisterDestructionCallback(const DestructionCallback& callback) final; - void SetGuestSizer(content::GuestSizer* guest_sizer) final; + void SetGuestHost(content::GuestHost* guest_host) final; void WillAttach(content::WebContents* embedder_web_contents, int element_instance_id, bool is_full_page_plugin) final; @@ -230,8 +229,6 @@ class WebContents : public mate::EventEmitter, // element. int element_instance_id_; - DestructionCallback destruction_callback_; - // Stores whether the contents of the guest can be transparent. bool guest_opaque_; @@ -248,8 +245,8 @@ class WebContents : public mate::EventEmitter, // element may not match the size of the guest. gfx::Size guest_size_; - // A pointer to the guest_sizer. - content::GuestSizer* guest_sizer_; + // A pointer to the guest_host. + content::GuestHost* guest_host_; // Indicates whether autosize mode is enabled or not. bool auto_size_enabled_; diff --git a/atom/browser/atom_javascript_dialog_manager.h b/atom/browser/atom_javascript_dialog_manager.h index 3712b81a49fc..c0a0dccf0fa9 100644 --- a/atom/browser/atom_javascript_dialog_manager.h +++ b/atom/browser/atom_javascript_dialog_manager.h @@ -30,7 +30,7 @@ class AtomJavaScriptDialogManager : public content::JavaScriptDialogManager { const DialogClosedCallback& callback) override; void CancelActiveAndPendingDialogs( content::WebContents* web_contents) override {} - void WebContentsDestroyed(content::WebContents* web_contents) override {} + void ResetDialogState(content::WebContents* web_contents) override {}; }; } // namespace atom diff --git a/atom/common/api/atom_api_v8_util.cc b/atom/common/api/atom_api_v8_util.cc index 9412f406777a..b0c79afb0ef1 100644 --- a/atom/common/api/atom_api_v8_util.cc +++ b/atom/common/api/atom_api_v8_util.cc @@ -39,8 +39,7 @@ void SetDestructor(v8::Isolate* isolate, } void TakeHeapSnapshot(v8::Isolate* isolate) { - isolate->GetHeapProfiler()->TakeHeapSnapshot( - mate::StringToV8(isolate, "test")); + isolate->GetHeapProfiler()->TakeHeapSnapshot(); } void Initialize(v8::Handle exports, v8::Handle unused, diff --git a/atom/common/asar/archive.cc b/atom/common/asar/archive.cc index 98e464650bac..79b82416cd0a 100644 --- a/atom/common/asar/archive.cc +++ b/atom/common/asar/archive.cc @@ -15,8 +15,9 @@ #include "base/files/file.h" #include "base/logging.h" #include "base/pickle.h" -#include "base/json/json_string_value_serializer.h" +#include "base/json/json_reader.h" #include "base/strings/string_number_conversions.h" +#include "base/values.h" namespace asar { @@ -149,15 +150,15 @@ bool Archive::Init() { } std::string error; - JSONStringValueSerializer serializer(&header); - base::Value* value = serializer.Deserialize(NULL, &error); + base::JSONReader reader; + scoped_ptr value(reader.ReadToValue(header)); if (!value || !value->IsType(base::Value::TYPE_DICTIONARY)) { LOG(ERROR) << "Failed to parse header: " << error; return false; } header_size_ = 8 + size; - header_.reset(static_cast(value)); + header_.reset(static_cast(value.release())); return true; } diff --git a/atom/renderer/atom_renderer_client.cc b/atom/renderer/atom_renderer_client.cc index 5b8193a4915e..05008fc0ba4c 100644 --- a/atom/renderer/atom_renderer_client.cc +++ b/atom/renderer/atom_renderer_client.cc @@ -16,10 +16,11 @@ #include "chrome/renderer/printing/print_web_view_helper.h" #include "chrome/renderer/tts_dispatcher.h" #include "content/public/common/content_constants.h" +#include "content/public/renderer/render_frame.h" #include "content/public/renderer/render_frame_observer.h" #include "content/public/renderer/render_thread.h" #include "third_party/WebKit/public/web/WebCustomElement.h" -#include "third_party/WebKit/public/web/WebFrame.h" +#include "third_party/WebKit/public/web/WebLocalFrame.h" #include "third_party/WebKit/public/web/WebPluginParams.h" #include "third_party/WebKit/public/web/WebKit.h" #include "third_party/WebKit/public/web/WebRuntimeFeatures.h" @@ -56,10 +57,11 @@ class AtomRenderFrameObserver : public content::RenderFrameObserver { renderer_client_(renderer_client) {} // content::RenderFrameObserver: - void DidCreateScriptContext(blink::WebFrame* frame, - v8::Handle context, + void DidCreateScriptContext(v8::Handle context, + int extension_group, int world_id) { - renderer_client_->DidCreateScriptContext(frame, context, world_id); + renderer_client_->DidCreateScriptContext( + render_frame()->GetWebFrame(), context); } private: @@ -131,10 +133,9 @@ bool AtomRendererClient::OverrideCreatePlugin( return true; } -void AtomRendererClient::DidCreateScriptContext(blink::WebFrame* frame, - v8::Handle context, - int extension_group, - int world_id) { +void AtomRendererClient::DidCreateScriptContext( + blink::WebFrame* frame, + v8::Handle context) { // Only attach node bindings in main frame or guest frame. if (!IsGuestFrame(frame)) { if (main_frame_) diff --git a/atom/renderer/atom_renderer_client.h b/atom/renderer/atom_renderer_client.h index 2bbbc3c1d9b3..af264d59792d 100644 --- a/atom/renderer/atom_renderer_client.h +++ b/atom/renderer/atom_renderer_client.h @@ -22,8 +22,7 @@ class AtomRendererClient : public content::ContentRendererClient, virtual ~AtomRendererClient(); void DidCreateScriptContext(blink::WebFrame* frame, - v8::Handle context, - int world_id); + v8::Handle context); private: enum NodeIntegration { From d1685f79a2660648431bdf0272c9d9567be64dd6 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 22 May 2015 15:30:02 +0800 Subject: [PATCH 0072/1293] Initialize V8 in browser process Previously it was initialized by ProxyResolverV8, but after Chrome 43 V8 started to initialize V8 lazily. --- atom/browser/javascript_environment.cc | 12 +++++++++++- atom/browser/javascript_environment.h | 3 +++ 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/atom/browser/javascript_environment.cc b/atom/browser/javascript_environment.cc index f8dd71f471eb..887c59353ae4 100644 --- a/atom/browser/javascript_environment.cc +++ b/atom/browser/javascript_environment.cc @@ -4,10 +4,13 @@ #include "atom/browser/javascript_environment.h" +#include "gin/array_buffer.h" + namespace atom { JavascriptEnvironment::JavascriptEnvironment() - : isolate_(isolate_holder_.isolate()), + : initialized_(Initialize()), + isolate_(isolate_holder_.isolate()), isolate_scope_(isolate_), locker_(isolate_), handle_scope_(isolate_), @@ -15,4 +18,11 @@ JavascriptEnvironment::JavascriptEnvironment() context_scope_(v8::Local::New(isolate_, context_)) { } +bool JavascriptEnvironment::Initialize() { + gin::IsolateHolder::LoadV8Snapshot(); + gin::IsolateHolder::Initialize(gin::IsolateHolder::kNonStrictMode, + gin::ArrayBufferAllocator::SharedInstance()); + return true; +} + } // namespace atom diff --git a/atom/browser/javascript_environment.h b/atom/browser/javascript_environment.h index 8baec7e36815..20f1667c3b8e 100644 --- a/atom/browser/javascript_environment.h +++ b/atom/browser/javascript_environment.h @@ -20,6 +20,9 @@ class JavascriptEnvironment { } private: + bool Initialize(); + + bool initialized_; gin::IsolateHolder isolate_holder_; v8::Isolate* isolate_; v8::Isolate::Scope isolate_scope_; From b169ac016eb949a482890c8953b56cf4c2d9052d Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 22 May 2015 15:59:06 +0800 Subject: [PATCH 0073/1293] Start AtomRenderFrameObserver --- atom/renderer/atom_renderer_client.cc | 1 + 1 file changed, 1 insertion(+) diff --git a/atom/renderer/atom_renderer_client.cc b/atom/renderer/atom_renderer_client.cc index 05008fc0ba4c..1dc4e45b03d7 100644 --- a/atom/renderer/atom_renderer_client.cc +++ b/atom/renderer/atom_renderer_client.cc @@ -107,6 +107,7 @@ void AtomRendererClient::RenderThreadStarted() { void AtomRendererClient::RenderFrameCreated( content::RenderFrame* render_frame) { new PepperHelper(render_frame); + new AtomRenderFrameObserver(render_frame, this); } void AtomRendererClient::RenderViewCreated(content::RenderView* render_view) { From d78efe7c224624d1071fcedc081b55e9904b3767 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 22 May 2015 19:11:22 +0800 Subject: [PATCH 0074/1293] Use Local instead of Handle --- atom/browser/api/atom_api_app.cc | 6 ++--- atom/browser/api/atom_api_auto_updater.cc | 4 ++-- atom/browser/api/atom_api_content_tracing.cc | 8 +++---- atom/browser/api/atom_api_dialog.cc | 12 +++++----- atom/browser/api/atom_api_global_shortcut.cc | 4 ++-- atom/browser/api/atom_api_menu.cc | 10 ++++---- atom/browser/api/atom_api_menu.h | 4 ++-- atom/browser/api/atom_api_power_monitor.cc | 6 ++--- atom/browser/api/atom_api_power_monitor.h | 2 +- atom/browser/api/atom_api_protocol.cc | 12 +++++----- atom/browser/api/atom_api_protocol.h | 2 +- atom/browser/api/atom_api_screen.cc | 6 ++--- atom/browser/api/atom_api_screen.h | 2 +- atom/browser/api/atom_api_tray.cc | 10 ++++---- atom/browser/api/atom_api_tray.h | 2 +- atom/browser/api/atom_api_web_contents.cc | 4 ++-- atom/browser/api/atom_api_web_view_manager.cc | 8 +++---- atom/browser/api/atom_api_window.cc | 10 ++++---- atom/browser/api/atom_api_window.h | 4 ++-- atom/browser/api/event_emitter.cc | 4 ++-- atom/browser/api/event_emitter.h | 2 +- atom/common/api/atom_api_asar.cc | 24 +++++++++---------- atom/common/api/atom_api_clipboard.cc | 6 ++--- atom/common/api/atom_api_crash_reporter.cc | 12 +++++----- atom/common/api/atom_api_id_weak_map.cc | 10 ++++---- atom/common/api/atom_api_id_weak_map.h | 6 ++--- atom/common/api/atom_api_native_image.cc | 10 ++++---- atom/common/api/atom_api_native_image.h | 6 ++--- atom/common/api/atom_api_shell.cc | 4 ++-- atom/common/api/atom_api_v8_util.cc | 24 +++++++++---------- atom/common/api/atom_bindings.cc | 2 +- atom/common/api/atom_bindings.h | 2 +- atom/common/api/object_life_monitor.cc | 4 ++-- atom/common/api/object_life_monitor.h | 4 ++-- .../accelerator_converter.cc | 2 +- .../accelerator_converter.h | 2 +- .../file_path_converter.h | 4 ++-- .../native_mate_converters/gfx_converter.cc | 16 ++++++------- .../native_mate_converters/gfx_converter.h | 16 ++++++------- .../native_mate_converters/gurl_converter.h | 4 ++-- .../native_mate_converters/image_converter.cc | 6 ++--- .../native_mate_converters/image_converter.h | 6 ++--- .../string16_converter.h | 4 ++-- .../v8_value_converter.cc | 8 +++---- .../v8_value_converter.h | 4 ++-- .../native_mate_converters/value_converter.cc | 6 ++--- .../native_mate_converters/value_converter.h | 6 ++--- atom/renderer/api/atom_api_renderer_ipc.cc | 4 ++-- .../api/atom_api_spell_check_client.cc | 6 ++--- .../api/atom_api_spell_check_client.h | 2 +- atom/renderer/api/atom_api_web_frame.cc | 12 +++++----- atom/renderer/api/atom_api_web_frame.h | 6 ++--- atom/renderer/atom_render_view_observer.cc | 18 +++++++------- vendor/native_mate | 2 +- 54 files changed, 185 insertions(+), 185 deletions(-) diff --git a/atom/browser/api/atom_api_app.cc b/atom/browser/api/atom_api_app.cc index d3b04f043622..27178b389409 100644 --- a/atom/browser/api/atom_api_app.cc +++ b/atom/browser/api/atom_api_app.cc @@ -42,7 +42,7 @@ namespace mate { #if defined(OS_WIN) template<> struct Converter { - static bool FromV8(v8::Isolate* isolate, v8::Handle val, + static bool FromV8(v8::Isolate* isolate, v8::Local val, Browser::UserTask* out) { mate::Dictionary dict; if (!ConvertFromV8(isolate, val, &dict)) @@ -277,8 +277,8 @@ void DockSetMenu(atom::api::Menu* menu) { } #endif -void Initialize(v8::Handle exports, v8::Handle unused, - v8::Handle context, void* priv) { +void Initialize(v8::Local exports, v8::Local unused, + v8::Local context, void* priv) { v8::Isolate* isolate = context->GetIsolate(); auto command_line = base::CommandLine::ForCurrentProcess(); diff --git a/atom/browser/api/atom_api_auto_updater.cc b/atom/browser/api/atom_api_auto_updater.cc index bf52c310b72a..1691ac103e96 100644 --- a/atom/browser/api/atom_api_auto_updater.cc +++ b/atom/browser/api/atom_api_auto_updater.cc @@ -77,8 +77,8 @@ mate::Handle AutoUpdater::Create(v8::Isolate* isolate) { namespace { -void Initialize(v8::Handle exports, v8::Handle unused, - v8::Handle context, void* priv) { +void Initialize(v8::Local exports, v8::Local unused, + v8::Local context, void* priv) { v8::Isolate* isolate = context->GetIsolate(); mate::Dictionary dict(isolate, exports); dict.Set("autoUpdater", atom::api::AutoUpdater::Create(isolate)); diff --git a/atom/browser/api/atom_api_content_tracing.cc b/atom/browser/api/atom_api_content_tracing.cc index a3299e447a8f..6da450185cd7 100644 --- a/atom/browser/api/atom_api_content_tracing.cc +++ b/atom/browser/api/atom_api_content_tracing.cc @@ -20,7 +20,7 @@ namespace mate { template<> struct Converter { static bool FromV8(v8::Isolate* isolate, - v8::Handle val, + v8::Local val, base::trace_event::CategoryFilter* out) { std::string filter; if (!ConvertFromV8(isolate, val, &filter)) @@ -33,7 +33,7 @@ struct Converter { template<> struct Converter { static bool FromV8(v8::Isolate* isolate, - v8::Handle val, + v8::Local val, base::trace_event::TraceOptions* out) { std::string options; if (!ConvertFromV8(isolate, val, &options)) @@ -46,8 +46,8 @@ struct Converter { namespace { -void Initialize(v8::Handle exports, v8::Handle unused, - v8::Handle context, void* priv) { +void Initialize(v8::Local exports, v8::Local unused, + v8::Local context, void* priv) { auto controller = base::Unretained(TracingController::GetInstance()); mate::Dictionary dict(context->GetIsolate(), exports); dict.SetMethod("getCategories", base::Bind( diff --git a/atom/browser/api/atom_api_dialog.cc b/atom/browser/api/atom_api_dialog.cc index 5834b73e6b6d..02d820bdeb5f 100644 --- a/atom/browser/api/atom_api_dialog.cc +++ b/atom/browser/api/atom_api_dialog.cc @@ -22,7 +22,7 @@ namespace mate { template<> struct Converter { static bool FromV8(v8::Isolate* isolate, - v8::Handle val, + v8::Local val, file_dialog::Filter* out) { mate::Dictionary dict; if (!ConvertFromV8(isolate, val, &dict)) @@ -52,7 +52,7 @@ void ShowMessageBox(int type, const std::string& message = texts[1]; const std::string& detail = texts[2]; - v8::Handle peek = args->PeekNext(); + v8::Local peek = args->PeekNext(); atom::MessageBoxCallback callback; if (mate::Converter::FromV8(args->isolate(), peek, @@ -72,7 +72,7 @@ void ShowOpenDialog(const std::string& title, int properties, atom::NativeWindow* window, mate::Arguments* args) { - v8::Handle peek = args->PeekNext(); + v8::Local peek = args->PeekNext(); file_dialog::OpenDialogCallback callback; if (mate::Converter::FromV8(args->isolate(), peek, @@ -92,7 +92,7 @@ void ShowSaveDialog(const std::string& title, const file_dialog::Filters& filters, atom::NativeWindow* window, mate::Arguments* args) { - v8::Handle peek = args->PeekNext(); + v8::Local peek = args->PeekNext(); file_dialog::SaveDialogCallback callback; if (mate::Converter::FromV8(args->isolate(), peek, @@ -106,8 +106,8 @@ void ShowSaveDialog(const std::string& title, } } -void Initialize(v8::Handle exports, v8::Handle unused, - v8::Handle context, void* priv) { +void Initialize(v8::Local exports, v8::Local unused, + v8::Local context, void* priv) { mate::Dictionary dict(context->GetIsolate(), exports); dict.SetMethod("showMessageBox", &ShowMessageBox); dict.SetMethod("showErrorBox", &atom::ShowErrorBox); diff --git a/atom/browser/api/atom_api_global_shortcut.cc b/atom/browser/api/atom_api_global_shortcut.cc index c30873379746..47bebe9d12bd 100644 --- a/atom/browser/api/atom_api_global_shortcut.cc +++ b/atom/browser/api/atom_api_global_shortcut.cc @@ -86,8 +86,8 @@ mate::Handle GlobalShortcut::Create(v8::Isolate* isolate) { namespace { -void Initialize(v8::Handle exports, v8::Handle unused, - v8::Handle context, void* priv) { +void Initialize(v8::Local exports, v8::Local unused, + v8::Local context, void* priv) { v8::Isolate* isolate = context->GetIsolate(); mate::Dictionary dict(isolate, exports); dict.Set("globalShortcut", atom::api::GlobalShortcut::Create(isolate)); diff --git a/atom/browser/api/atom_api_menu.cc b/atom/browser/api/atom_api_menu.cc index 010d0414d9a9..c0bfff3f050c 100644 --- a/atom/browser/api/atom_api_menu.cc +++ b/atom/browser/api/atom_api_menu.cc @@ -58,7 +58,7 @@ bool Menu::GetAcceleratorForCommandId(int command_id, v8::Isolate* isolate = v8::Isolate::GetCurrent(); v8::Locker locker(isolate); v8::HandleScope handle_scope(isolate); - v8::Handle val = get_accelerator_.Run(command_id); + v8::Local val = get_accelerator_.Run(command_id); return mate::ConvertFromV8(isolate, val, accelerator); } @@ -150,7 +150,7 @@ bool Menu::IsVisibleAt(int index) const { // static void Menu::BuildPrototype(v8::Isolate* isolate, - v8::Handle prototype) { + v8::Local prototype) { mate::ObjectTemplateBuilder(isolate, prototype) .SetMethod("insertItem", &Menu::InsertItemAt) .SetMethod("insertCheckItem", &Menu::InsertCheckItemAt) @@ -180,14 +180,14 @@ void Menu::BuildPrototype(v8::Isolate* isolate, namespace { -void Initialize(v8::Handle exports, v8::Handle unused, - v8::Handle context, void* priv) { +void Initialize(v8::Local exports, v8::Local unused, + v8::Local context, void* priv) { using atom::api::Menu; v8::Isolate* isolate = context->GetIsolate(); v8::Local constructor = mate::CreateConstructor( isolate, "Menu", base::Bind(&Menu::Create)); mate::Dictionary dict(isolate, exports); - dict.Set("Menu", static_cast>(constructor)); + dict.Set("Menu", static_cast>(constructor)); #if defined(OS_MACOSX) dict.SetMethod("setApplicationMenu", &Menu::SetApplicationMenu); dict.SetMethod("sendActionToFirstResponder", diff --git a/atom/browser/api/atom_api_menu.h b/atom/browser/api/atom_api_menu.h index 830c5d0c6465..37e544a82e09 100644 --- a/atom/browser/api/atom_api_menu.h +++ b/atom/browser/api/atom_api_menu.h @@ -23,7 +23,7 @@ class Menu : public mate::Wrappable, static mate::Wrappable* Create(); static void BuildPrototype(v8::Isolate* isolate, - v8::Handle prototype); + v8::Local prototype); #if defined(OS_MACOSX) // Set the global menubar. @@ -88,7 +88,7 @@ class Menu : public mate::Wrappable, base::Callback is_checked_; base::Callback is_enabled_; base::Callback is_visible_; - base::Callback(int)> get_accelerator_; + base::Callback(int)> get_accelerator_; base::Callback execute_command_; base::Callback menu_will_show_; diff --git a/atom/browser/api/atom_api_power_monitor.cc b/atom/browser/api/atom_api_power_monitor.cc index 8f87eec07280..afdebfcf7f2f 100644 --- a/atom/browser/api/atom_api_power_monitor.cc +++ b/atom/browser/api/atom_api_power_monitor.cc @@ -39,7 +39,7 @@ void PowerMonitor::OnResume() { } // static -v8::Handle PowerMonitor::Create(v8::Isolate* isolate) { +v8::Local PowerMonitor::Create(v8::Isolate* isolate) { if (!Browser::Get()->is_ready()) { node::ThrowError("Cannot initialize \"power-monitor\" module" "before app is ready"); @@ -56,8 +56,8 @@ v8::Handle PowerMonitor::Create(v8::Isolate* isolate) { namespace { -void Initialize(v8::Handle exports, v8::Handle unused, - v8::Handle context, void* priv) { +void Initialize(v8::Local exports, v8::Local unused, + v8::Local context, void* priv) { #if defined(OS_MACOSX) base::PowerMonitorDeviceSource::AllocateSystemIOPorts(); #endif diff --git a/atom/browser/api/atom_api_power_monitor.h b/atom/browser/api/atom_api_power_monitor.h index cdd14ff6e859..dcf0906b437f 100644 --- a/atom/browser/api/atom_api_power_monitor.h +++ b/atom/browser/api/atom_api_power_monitor.h @@ -17,7 +17,7 @@ namespace api { class PowerMonitor : public mate::EventEmitter, public base::PowerObserver { public: - static v8::Handle Create(v8::Isolate* isolate); + static v8::Local Create(v8::Isolate* isolate); protected: PowerMonitor(); diff --git a/atom/browser/api/atom_api_protocol.cc b/atom/browser/api/atom_api_protocol.cc index 8a7e0ae6840a..0d56a6fb1c49 100644 --- a/atom/browser/api/atom_api_protocol.cc +++ b/atom/browser/api/atom_api_protocol.cc @@ -21,7 +21,7 @@ namespace mate { template<> struct Converter { - static v8::Handle ToV8(v8::Isolate* isolate, + static v8::Local ToV8(v8::Isolate* isolate, const net::URLRequest* val) { return mate::ObjectTemplateBuilder(isolate) .SetValue("method", val->method()) @@ -63,7 +63,7 @@ class CustomProtocolRequestJob : public AdapterRequestJob { // Call the JS handler. Protocol::JsProtocolHandler callback = registry_->GetProtocolHandler(request()->url().scheme()); - v8::Handle result = callback.Run(request()); + v8::Local result = callback.Run(request()); // Determine the type of the job we are going to create. if (result->IsString()) { @@ -73,7 +73,7 @@ class CustomProtocolRequestJob : public AdapterRequestJob { GetWeakPtr(), "text/plain", "UTF-8", data)); return; } else if (result->IsObject()) { - v8::Handle obj = result->ToObject(); + v8::Local obj = result->ToObject(); mate::Dictionary dict(isolate, obj); std::string name = mate::V8ToString(obj->GetConstructorName()); if (name == "RequestStringJob") { @@ -88,7 +88,7 @@ class CustomProtocolRequestJob : public AdapterRequestJob { return; } else if (name == "RequestBufferJob") { std::string mime_type, encoding; - v8::Handle buffer; + v8::Local buffer; dict.Get("mimeType", &mime_type); dict.Get("encoding", &encoding); dict.Get("data", &buffer); @@ -339,8 +339,8 @@ mate::Handle Protocol::Create(v8::Isolate* isolate) { namespace { -void Initialize(v8::Handle exports, v8::Handle unused, - v8::Handle context, void* priv) { +void Initialize(v8::Local exports, v8::Local unused, + v8::Local context, void* priv) { v8::Isolate* isolate = context->GetIsolate(); mate::Dictionary dict(isolate, exports); dict.Set("protocol", atom::api::Protocol::Create(isolate)); diff --git a/atom/browser/api/atom_api_protocol.h b/atom/browser/api/atom_api_protocol.h index 03a6deb847a1..deef277333b5 100644 --- a/atom/browser/api/atom_api_protocol.h +++ b/atom/browser/api/atom_api_protocol.h @@ -24,7 +24,7 @@ namespace api { class Protocol : public mate::EventEmitter { public: - typedef base::Callback(const net::URLRequest*)> + typedef base::Callback(const net::URLRequest*)> JsProtocolHandler; static mate::Handle Create(v8::Isolate* isolate); diff --git a/atom/browser/api/atom_api_screen.cc b/atom/browser/api/atom_api_screen.cc index 3d2e46472472..c042cc3f1f08 100644 --- a/atom/browser/api/atom_api_screen.cc +++ b/atom/browser/api/atom_api_screen.cc @@ -111,7 +111,7 @@ mate::ObjectTemplateBuilder Screen::GetObjectTemplateBuilder( } // static -v8::Handle Screen::Create(v8::Isolate* isolate) { +v8::Local Screen::Create(v8::Isolate* isolate) { if (!Browser::Get()->is_ready()) { node::ThrowError("Cannot initialize \"screen\" module before app is ready"); return v8::Null(isolate); @@ -132,8 +132,8 @@ v8::Handle Screen::Create(v8::Isolate* isolate) { namespace { -void Initialize(v8::Handle exports, v8::Handle unused, - v8::Handle context, void* priv) { +void Initialize(v8::Local exports, v8::Local unused, + v8::Local context, void* priv) { mate::Dictionary dict(context->GetIsolate(), exports); dict.Set("screen", atom::api::Screen::Create(context->GetIsolate())); } diff --git a/atom/browser/api/atom_api_screen.h b/atom/browser/api/atom_api_screen.h index 5a81f3d67057..f724130fa7fc 100644 --- a/atom/browser/api/atom_api_screen.h +++ b/atom/browser/api/atom_api_screen.h @@ -24,7 +24,7 @@ namespace api { class Screen : public mate::EventEmitter, public gfx::DisplayObserver { public: - static v8::Handle Create(v8::Isolate* isolate); + static v8::Local Create(v8::Isolate* isolate); protected: explicit Screen(gfx::Screen* screen); diff --git a/atom/browser/api/atom_api_tray.cc b/atom/browser/api/atom_api_tray.cc index b66d95cb0732..6d7a9e5dedbd 100644 --- a/atom/browser/api/atom_api_tray.cc +++ b/atom/browser/api/atom_api_tray.cc @@ -128,7 +128,7 @@ bool Tray::CheckTrayLife(mate::Arguments* args) { // static void Tray::BuildPrototype(v8::Isolate* isolate, - v8::Handle prototype) { + v8::Local prototype) { mate::ObjectTemplateBuilder(isolate, prototype) .SetMethod("destroy", &Tray::Destroy) .SetMethod("setImage", &Tray::SetImage) @@ -147,14 +147,14 @@ void Tray::BuildPrototype(v8::Isolate* isolate, namespace { -void Initialize(v8::Handle exports, v8::Handle unused, - v8::Handle context, void* priv) { +void Initialize(v8::Local exports, v8::Local unused, + v8::Local context, void* priv) { using atom::api::Tray; v8::Isolate* isolate = context->GetIsolate(); - v8::Handle constructor = mate::CreateConstructor( + v8::Local constructor = mate::CreateConstructor( isolate, "Tray", base::Bind(&Tray::New)); mate::Dictionary dict(isolate, exports); - dict.Set("Tray", static_cast>(constructor)); + dict.Set("Tray", static_cast>(constructor)); } } // namespace diff --git a/atom/browser/api/atom_api_tray.h b/atom/browser/api/atom_api_tray.h index 5ed29ecd74f1..9fe3513094d8 100644 --- a/atom/browser/api/atom_api_tray.h +++ b/atom/browser/api/atom_api_tray.h @@ -34,7 +34,7 @@ class Tray : public mate::EventEmitter, static mate::Wrappable* New(const gfx::Image& image); static void BuildPrototype(v8::Isolate* isolate, - v8::Handle prototype); + v8::Local prototype); protected: explicit Tray(const gfx::Image& image); diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 1f3afb582710..441bb2408eb4 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -751,8 +751,8 @@ mate::Handle WebContents::Create( namespace { -void Initialize(v8::Handle exports, v8::Handle unused, - v8::Handle context, void* priv) { +void Initialize(v8::Local exports, v8::Local unused, + v8::Local context, void* priv) { v8::Isolate* isolate = context->GetIsolate(); mate::Dictionary dict(isolate, exports); dict.SetMethod("create", &atom::api::WebContents::Create); diff --git a/atom/browser/api/atom_api_web_view_manager.cc b/atom/browser/api/atom_api_web_view_manager.cc index ed796be8e83f..d77ea18d6d0c 100644 --- a/atom/browser/api/atom_api_web_view_manager.cc +++ b/atom/browser/api/atom_api_web_view_manager.cc @@ -15,7 +15,7 @@ namespace mate { template<> struct Converter { - static bool FromV8(v8::Isolate* isolate, v8::Handle val, + static bool FromV8(v8::Isolate* isolate, v8::Local val, content::WebContents** out) { atom::api::WebContents* contents; if (!Converter::FromV8(isolate, val, &contents)) @@ -27,7 +27,7 @@ struct Converter { template<> struct Converter { - static bool FromV8(v8::Isolate* isolate, v8::Handle val, + static bool FromV8(v8::Isolate* isolate, v8::Local val, atom::WebViewManager::WebViewInfo* out) { Dictionary options; if (!ConvertFromV8(isolate, val, &options)) @@ -81,8 +81,8 @@ void RemoveGuest(content::WebContents* embedder, int guest_instance_id) { manager->RemoveGuest(guest_instance_id); } -void Initialize(v8::Handle exports, v8::Handle unused, - v8::Handle context, void* priv) { +void Initialize(v8::Local exports, v8::Local unused, + v8::Local context, void* priv) { mate::Dictionary dict(context->GetIsolate(), exports); dict.SetMethod("addGuest", &AddGuest); dict.SetMethod("removeGuest", &RemoveGuest); diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index 252c8f920354..99df40845e7c 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -32,7 +32,7 @@ namespace mate { template<> struct Converter { - static bool FromV8(v8::Isolate* isolate, v8::Handle val, + static bool FromV8(v8::Isolate* isolate, v8::Local val, PrintSettings* out) { mate::Dictionary dict; if (!ConvertFromV8(isolate, val, &dict)) @@ -462,7 +462,7 @@ mate::Handle Window::GetDevToolsWebContents( // static void Window::BuildPrototype(v8::Isolate* isolate, - v8::Handle prototype) { + v8::Local prototype) { mate::ObjectTemplateBuilder(isolate, prototype) .SetMethod("destroy", &Window::Destroy) .SetMethod("close", &Window::Close) @@ -542,14 +542,14 @@ void Window::BuildPrototype(v8::Isolate* isolate, namespace { -void Initialize(v8::Handle exports, v8::Handle unused, - v8::Handle context, void* priv) { +void Initialize(v8::Local exports, v8::Local unused, + v8::Local context, void* priv) { using atom::api::Window; v8::Isolate* isolate = context->GetIsolate(); v8::Local constructor = mate::CreateConstructor( isolate, "BrowserWindow", base::Bind(&Window::New)); mate::Dictionary dict(isolate, exports); - dict.Set("BrowserWindow", static_cast>(constructor)); + dict.Set("BrowserWindow", static_cast>(constructor)); } } // namespace diff --git a/atom/browser/api/atom_api_window.h b/atom/browser/api/atom_api_window.h index 8aa1ed0988dc..e3b48cf9651f 100644 --- a/atom/browser/api/atom_api_window.h +++ b/atom/browser/api/atom_api_window.h @@ -40,7 +40,7 @@ class Window : public mate::EventEmitter, const mate::Dictionary& options); static void BuildPrototype(v8::Isolate* isolate, - v8::Handle prototype); + v8::Local prototype); NativeWindow* window() const { return window_.get(); } @@ -160,7 +160,7 @@ namespace mate { template<> struct Converter { - static bool FromV8(v8::Isolate* isolate, v8::Handle val, + static bool FromV8(v8::Isolate* isolate, v8::Local val, atom::NativeWindow** out) { // null would be tranfered to NULL. if (val->IsNull()) { diff --git a/atom/browser/api/event_emitter.cc b/atom/browser/api/event_emitter.cc index 87ab69a16f83..7fdcfa138c74 100644 --- a/atom/browser/api/event_emitter.cc +++ b/atom/browser/api/event_emitter.cc @@ -43,13 +43,13 @@ bool EventEmitter::CallEmit(v8::Isolate* isolate, content::WebContents* sender, IPC::Message* message, ValueArray args) { - v8::Handle event; + v8::Local event; bool use_native_event = sender && message; if (use_native_event) { mate::Handle native_event = mate::Event::Create(isolate); native_event->SetSenderAndMessage(sender, message); - event = v8::Handle::Cast(native_event.ToV8()); + event = v8::Local::Cast(native_event.ToV8()); } else { event = CreateEventObject(isolate); } diff --git a/atom/browser/api/event_emitter.h b/atom/browser/api/event_emitter.h index 854076044bde..3809407138a1 100644 --- a/atom/browser/api/event_emitter.h +++ b/atom/browser/api/event_emitter.h @@ -22,7 +22,7 @@ namespace mate { // Provide helperers to emit event in JavaScript. class EventEmitter : public Wrappable { public: - typedef std::vector> ValueArray; + typedef std::vector> ValueArray; protected: EventEmitter(); diff --git a/atom/common/api/atom_api_asar.cc b/atom/common/api/atom_api_asar.cc index 3fd2ca6f86f7..07d7c608d16d 100644 --- a/atom/common/api/atom_api_asar.cc +++ b/atom/common/api/atom_api_asar.cc @@ -21,7 +21,7 @@ namespace { class Archive : public mate::Wrappable { public: - static v8::Handle Create(v8::Isolate* isolate, + static v8::Local Create(v8::Isolate* isolate, const base::FilePath& path) { scoped_ptr archive(new asar::Archive(path)); if (!archive->Init()) @@ -34,7 +34,7 @@ class Archive : public mate::Wrappable { : archive_(archive.Pass()) {} // Reads the offset and size of file. - v8::Handle GetFileInfo(v8::Isolate* isolate, + v8::Local GetFileInfo(v8::Isolate* isolate, const base::FilePath& path) { asar::Archive::FileInfo info; if (!archive_ || !archive_->GetFileInfo(path, &info)) @@ -47,7 +47,7 @@ class Archive : public mate::Wrappable { } // Returns a fake result of fs.stat(path). - v8::Handle Stat(v8::Isolate* isolate, + v8::Local Stat(v8::Isolate* isolate, const base::FilePath& path) { asar::Archive::Stats stats; if (!archive_ || !archive_->Stat(path, &stats)) @@ -62,7 +62,7 @@ class Archive : public mate::Wrappable { } // Returns all files under a directory. - v8::Handle Readdir(v8::Isolate* isolate, + v8::Local Readdir(v8::Isolate* isolate, const base::FilePath& path) { std::vector files; if (!archive_ || !archive_->Readdir(path, &files)) @@ -71,7 +71,7 @@ class Archive : public mate::Wrappable { } // Returns the path of file with symbol link resolved. - v8::Handle Realpath(v8::Isolate* isolate, + v8::Local Realpath(v8::Isolate* isolate, const base::FilePath& path) { base::FilePath realpath; if (!archive_ || !archive_->Realpath(path, &realpath)) @@ -80,7 +80,7 @@ class Archive : public mate::Wrappable { } // Copy the file out into a temporary file and returns the new path. - v8::Handle CopyFileOut(v8::Isolate* isolate, + v8::Local CopyFileOut(v8::Isolate* isolate, const base::FilePath& path) { base::FilePath new_path; if (!archive_ || !archive_->CopyFileOut(path, &new_path)) @@ -120,8 +120,8 @@ class Archive : public mate::Wrappable { }; void InitAsarSupport(v8::Isolate* isolate, - v8::Handle process, - v8::Handle require) { + v8::Local process, + v8::Local require) { // Evaluate asar_init.coffee. v8::Local asar_init = v8::Script::Compile(v8::String::NewFromUtf8( isolate, @@ -131,8 +131,8 @@ void InitAsarSupport(v8::Isolate* isolate, v8::Local result = asar_init->Run(); // Initialize asar support. - base::Callback, - v8::Handle, + base::Callback, + v8::Local, std::string)> init; if (mate::ConvertFromV8(isolate, result, &init)) { init.Run(process, @@ -141,8 +141,8 @@ void InitAsarSupport(v8::Isolate* isolate, } } -void Initialize(v8::Handle exports, v8::Handle unused, - v8::Handle context, void* priv) { +void Initialize(v8::Local exports, v8::Local unused, + v8::Local context, void* priv) { mate::Dictionary dict(context->GetIsolate(), exports); dict.SetMethod("createArchive", &Archive::Create); dict.SetMethod("initAsarSupport", &InitAsarSupport); diff --git a/atom/common/api/atom_api_clipboard.cc b/atom/common/api/atom_api_clipboard.cc index 349b35ce5853..e6119864cb61 100644 --- a/atom/common/api/atom_api_clipboard.cc +++ b/atom/common/api/atom_api_clipboard.cc @@ -19,7 +19,7 @@ namespace mate { template<> struct Converter { - static bool FromV8(v8::Isolate* isolate, v8::Handle val, + static bool FromV8(v8::Isolate* isolate, v8::Local val, ui::ClipboardType* out) { std::string type; if (!Converter::FromV8(isolate, val, &type)) @@ -78,8 +78,8 @@ void Clear(ui::ClipboardType type) { ui::Clipboard::GetForCurrentThread()->Clear(type); } -void Initialize(v8::Handle exports, v8::Handle unused, - v8::Handle context, void* priv) { +void Initialize(v8::Local exports, v8::Local unused, + v8::Local context, void* priv) { mate::Dictionary dict(context->GetIsolate(), exports); dict.SetMethod("_has", &Has); dict.SetMethod("_read", &Read); diff --git a/atom/common/api/atom_api_crash_reporter.cc b/atom/common/api/atom_api_crash_reporter.cc index ba44be90b17e..9386dda8637e 100644 --- a/atom/common/api/atom_api_crash_reporter.cc +++ b/atom/common/api/atom_api_crash_reporter.cc @@ -16,15 +16,15 @@ namespace mate { template<> struct Converter > { static bool FromV8(v8::Isolate* isolate, - v8::Handle val, + v8::Local val, std::map* out) { if (!val->IsObject()) return false; - v8::Handle dict = val->ToObject(); - v8::Handle keys = dict->GetOwnPropertyNames(); + v8::Local dict = val->ToObject(); + v8::Local keys = dict->GetOwnPropertyNames(); for (uint32_t i = 0; i < keys->Length(); ++i) { - v8::Handle key = keys->Get(i); + v8::Local key = keys->Get(i); (*out)[V8ToString(key)] = V8ToString(dict->Get(key)); } return true; @@ -35,8 +35,8 @@ struct Converter > { namespace { -void Initialize(v8::Handle exports, v8::Handle unused, - v8::Handle context, void* priv) { +void Initialize(v8::Local exports, v8::Local unused, + v8::Local context, void* priv) { using crash_reporter::CrashReporter; mate::Dictionary dict(context->GetIsolate(), exports); dict.SetMethod("start", diff --git a/atom/common/api/atom_api_id_weak_map.cc b/atom/common/api/atom_api_id_weak_map.cc index cddf2d2dd4db..cc2af821de18 100644 --- a/atom/common/api/atom_api_id_weak_map.cc +++ b/atom/common/api/atom_api_id_weak_map.cc @@ -23,7 +23,7 @@ IDWeakMap::IDWeakMap() IDWeakMap::~IDWeakMap() { } -int32_t IDWeakMap::Add(v8::Isolate* isolate, v8::Handle object) { +int32_t IDWeakMap::Add(v8::Isolate* isolate, v8::Local object) { int32_t key = GetNextID(); object->SetHiddenValue(mate::StringToV8(isolate, "IDWeakMapKey"), mate::Converter::ToV8(isolate, key)); @@ -33,7 +33,7 @@ int32_t IDWeakMap::Add(v8::Isolate* isolate, v8::Handle object) { return key; } -v8::Handle IDWeakMap::Get(v8::Isolate* isolate, int32_t key) { +v8::Local IDWeakMap::Get(v8::Isolate* isolate, int32_t key) { if (!Has(key)) { node::ThrowError("Invalid key"); return v8::Undefined(isolate); @@ -67,7 +67,7 @@ int IDWeakMap::GetNextID() { // static void IDWeakMap::BuildPrototype(v8::Isolate* isolate, - v8::Handle prototype) { + v8::Local prototype) { mate::ObjectTemplateBuilder(isolate, prototype) .SetMethod("add", &IDWeakMap::Add) .SetMethod("get", &IDWeakMap::Get) @@ -91,8 +91,8 @@ void IDWeakMap::WeakCallback( namespace { -void Initialize(v8::Handle exports, v8::Handle unused, - v8::Handle context, void* priv) { +void Initialize(v8::Local exports, v8::Local unused, + v8::Local context, void* priv) { using atom::api::IDWeakMap; v8::Isolate* isolate = context->GetIsolate(); v8::Local constructor = mate::CreateConstructor( diff --git a/atom/common/api/atom_api_id_weak_map.h b/atom/common/api/atom_api_id_weak_map.h index e435da189f01..0648ce925202 100644 --- a/atom/common/api/atom_api_id_weak_map.h +++ b/atom/common/api/atom_api_id_weak_map.h @@ -23,13 +23,13 @@ class IDWeakMap : public mate::Wrappable { IDWeakMap(); static void BuildPrototype(v8::Isolate* isolate, - v8::Handle prototype); + v8::Local prototype); private: virtual ~IDWeakMap(); - int32_t Add(v8::Isolate* isolate, v8::Handle object); - v8::Handle Get(v8::Isolate* isolate, int32_t key); + int32_t Add(v8::Isolate* isolate, v8::Local object); + v8::Local Get(v8::Isolate* isolate, int32_t key); bool Has(int32_t key) const; std::vector Keys() const; void Remove(int32_t key); diff --git a/atom/common/api/atom_api_native_image.cc b/atom/common/api/atom_api_native_image.cc index 23da1b9f1761..bd66ad511f75 100644 --- a/atom/common/api/atom_api_native_image.cc +++ b/atom/common/api/atom_api_native_image.cc @@ -145,14 +145,14 @@ mate::ObjectTemplateBuilder NativeImage::GetObjectTemplateBuilder( isolate, v8::Local::New(isolate, template_)); } -v8::Handle NativeImage::ToPNG(v8::Isolate* isolate) { +v8::Local NativeImage::ToPNG(v8::Isolate* isolate) { scoped_refptr png = image_.As1xPNGBytes(); return node::Buffer::New(isolate, reinterpret_cast(png->front()), png->size()); } -v8::Handle NativeImage::ToJPEG(v8::Isolate* isolate, int quality) { +v8::Local NativeImage::ToJPEG(v8::Isolate* isolate, int quality) { std::vector output; gfx::JPEG1xEncodedDataFromImage(image_, quality, &output); return node::Buffer::New(isolate, @@ -225,7 +225,7 @@ mate::Handle NativeImage::CreateFromPath( // static mate::Handle NativeImage::CreateFromBuffer( - mate::Arguments* args, v8::Handle buffer) { + mate::Arguments* args, v8::Local buffer) { double scale_factor = 1.; args->GetNext(&scale_factor); @@ -258,8 +258,8 @@ mate::Handle NativeImage::CreateFromDataURL( namespace { -void Initialize(v8::Handle exports, v8::Handle unused, - v8::Handle context, void* priv) { +void Initialize(v8::Local exports, v8::Local unused, + v8::Local context, void* priv) { mate::Dictionary dict(context->GetIsolate(), exports); dict.SetMethod("createEmpty", &atom::api::NativeImage::CreateEmpty); dict.SetMethod("createFromPath", &atom::api::NativeImage::CreateFromPath); diff --git a/atom/common/api/atom_api_native_image.h b/atom/common/api/atom_api_native_image.h index 081501348868..8cb43d06e152 100644 --- a/atom/common/api/atom_api_native_image.h +++ b/atom/common/api/atom_api_native_image.h @@ -41,7 +41,7 @@ class NativeImage : public mate::Wrappable { static mate::Handle CreateFromPath( v8::Isolate* isolate, const base::FilePath& path); static mate::Handle CreateFromBuffer( - mate::Arguments* args, v8::Handle buffer); + mate::Arguments* args, v8::Local buffer); static mate::Handle CreateFromDataURL( v8::Isolate* isolate, const GURL& url); @@ -59,8 +59,8 @@ class NativeImage : public mate::Wrappable { v8::Isolate* isolate) override; private: - v8::Handle ToPNG(v8::Isolate* isolate); - v8::Handle ToJPEG(v8::Isolate* isolate, int quality); + v8::Local ToPNG(v8::Isolate* isolate); + v8::Local ToJPEG(v8::Isolate* isolate, int quality); std::string ToDataURL(); bool IsEmpty(); gfx::Size GetSize(); diff --git a/atom/common/api/atom_api_shell.cc b/atom/common/api/atom_api_shell.cc index ecbb99f71aac..013c5f5c6c84 100644 --- a/atom/common/api/atom_api_shell.cc +++ b/atom/common/api/atom_api_shell.cc @@ -13,8 +13,8 @@ namespace { -void Initialize(v8::Handle exports, v8::Handle unused, - v8::Handle context, void* priv) { +void Initialize(v8::Local exports, v8::Local unused, + v8::Local context, void* priv) { mate::Dictionary dict(context->GetIsolate(), exports); dict.SetMethod("showItemInFolder", &platform_util::ShowItemInFolder); dict.SetMethod("openItem", &platform_util::OpenItem); diff --git a/atom/common/api/atom_api_v8_util.cc b/atom/common/api/atom_api_v8_util.cc index b0c79afb0ef1..ae90fe1f37fc 100644 --- a/atom/common/api/atom_api_v8_util.cc +++ b/atom/common/api/atom_api_v8_util.cc @@ -10,31 +10,31 @@ namespace { -v8::Handle CreateObjectWithName(v8::Isolate* isolate, - v8::Handle name) { +v8::Local CreateObjectWithName(v8::Isolate* isolate, + v8::Local name) { v8::Local t = v8::FunctionTemplate::New(isolate); t->SetClassName(name); return t->GetFunction()->NewInstance(); } -v8::Handle GetHiddenValue(v8::Handle object, - v8::Handle key) { +v8::Local GetHiddenValue(v8::Local object, + v8::Local key) { return object->GetHiddenValue(key); } -void SetHiddenValue(v8::Handle object, - v8::Handle key, - v8::Handle value) { +void SetHiddenValue(v8::Local object, + v8::Local key, + v8::Local value) { object->SetHiddenValue(key, value); } -int32_t GetObjectHash(v8::Handle object) { +int32_t GetObjectHash(v8::Local object) { return object->GetIdentityHash(); } void SetDestructor(v8::Isolate* isolate, - v8::Handle object, - v8::Handle callback) { + v8::Local object, + v8::Local callback) { atom::ObjectLifeMonitor::BindTo(isolate, object, callback); } @@ -42,8 +42,8 @@ void TakeHeapSnapshot(v8::Isolate* isolate) { isolate->GetHeapProfiler()->TakeHeapSnapshot(); } -void Initialize(v8::Handle exports, v8::Handle unused, - v8::Handle context, void* priv) { +void Initialize(v8::Local exports, v8::Local unused, + v8::Local context, void* priv) { mate::Dictionary dict(context->GetIsolate(), exports); dict.SetMethod("createObjectWithName", &CreateObjectWithName); dict.SetMethod("getHiddenValue", &GetHiddenValue); diff --git a/atom/common/api/atom_bindings.cc b/atom/common/api/atom_bindings.cc index 202819eb539e..a210cc6931d2 100644 --- a/atom/common/api/atom_bindings.cc +++ b/atom/common/api/atom_bindings.cc @@ -49,7 +49,7 @@ AtomBindings::~AtomBindings() { } void AtomBindings::BindTo(v8::Isolate* isolate, - v8::Handle process) { + v8::Local process) { v8::V8::SetFatalErrorHandler(FatalErrorCallback); mate::Dictionary dict(isolate, process); diff --git a/atom/common/api/atom_bindings.h b/atom/common/api/atom_bindings.h index 1d92f174d5eb..b3536c234030 100644 --- a/atom/common/api/atom_bindings.h +++ b/atom/common/api/atom_bindings.h @@ -24,7 +24,7 @@ class AtomBindings { // Add process.atomBinding function, which behaves like process.binding but // load native code from atom-shell instead. - void BindTo(v8::Isolate* isolate, v8::Handle process); + void BindTo(v8::Isolate* isolate, v8::Local process); private: void ActivateUVLoop(v8::Isolate* isolate); diff --git a/atom/common/api/object_life_monitor.cc b/atom/common/api/object_life_monitor.cc index ac954d8d54f7..18d2a3a4d53f 100644 --- a/atom/common/api/object_life_monitor.cc +++ b/atom/common/api/object_life_monitor.cc @@ -11,8 +11,8 @@ namespace atom { // static void ObjectLifeMonitor::BindTo(v8::Isolate* isolate, - v8::Handle target, - v8::Handle destructor) { + v8::Local target, + v8::Local destructor) { target->SetHiddenValue(MATE_STRING_NEW(isolate, "destructor"), destructor); ObjectLifeMonitor* olm = new ObjectLifeMonitor(); diff --git a/atom/common/api/object_life_monitor.h b/atom/common/api/object_life_monitor.h index 6717c68db52d..e8dbbcf65f15 100644 --- a/atom/common/api/object_life_monitor.h +++ b/atom/common/api/object_life_monitor.h @@ -13,8 +13,8 @@ namespace atom { class ObjectLifeMonitor { public: static void BindTo(v8::Isolate* isolate, - v8::Handle target, - v8::Handle destructor); + v8::Local target, + v8::Local destructor); private: ObjectLifeMonitor(); diff --git a/atom/common/native_mate_converters/accelerator_converter.cc b/atom/common/native_mate_converters/accelerator_converter.cc index 74d65161585e..15eaafda2e3d 100644 --- a/atom/common/native_mate_converters/accelerator_converter.cc +++ b/atom/common/native_mate_converters/accelerator_converter.cc @@ -12,7 +12,7 @@ namespace mate { // static bool Converter::FromV8( - v8::Isolate* isolate, v8::Handle val, ui::Accelerator* out) { + v8::Isolate* isolate, v8::Local val, ui::Accelerator* out) { std::string keycode; if (!ConvertFromV8(isolate, val, &keycode)) return false; diff --git a/atom/common/native_mate_converters/accelerator_converter.h b/atom/common/native_mate_converters/accelerator_converter.h index 0a08f059253a..499077c08e28 100644 --- a/atom/common/native_mate_converters/accelerator_converter.h +++ b/atom/common/native_mate_converters/accelerator_converter.h @@ -15,7 +15,7 @@ namespace mate { template<> struct Converter { - static bool FromV8(v8::Isolate* isolate, v8::Handle val, + static bool FromV8(v8::Isolate* isolate, v8::Local val, ui::Accelerator* out); }; diff --git a/atom/common/native_mate_converters/file_path_converter.h b/atom/common/native_mate_converters/file_path_converter.h index f41449d5f85a..468f506de8a3 100644 --- a/atom/common/native_mate_converters/file_path_converter.h +++ b/atom/common/native_mate_converters/file_path_converter.h @@ -14,12 +14,12 @@ namespace mate { template<> struct Converter { - static v8::Handle ToV8(v8::Isolate* isolate, + static v8::Local ToV8(v8::Isolate* isolate, const base::FilePath& val) { return Converter::ToV8(isolate, val.value()); } static bool FromV8(v8::Isolate* isolate, - v8::Handle val, + v8::Local val, base::FilePath* out) { base::FilePath::StringType path; if (Converter::FromV8(isolate, val, &path)) { diff --git a/atom/common/native_mate_converters/gfx_converter.cc b/atom/common/native_mate_converters/gfx_converter.cc index 7f18debb96e1..6620276b584e 100644 --- a/atom/common/native_mate_converters/gfx_converter.cc +++ b/atom/common/native_mate_converters/gfx_converter.cc @@ -12,7 +12,7 @@ namespace mate { -v8::Handle Converter::ToV8(v8::Isolate* isolate, +v8::Local Converter::ToV8(v8::Isolate* isolate, const gfx::Point& val) { mate::Dictionary dict(isolate, v8::Object::New(isolate)); dict.Set("x", val.x()); @@ -21,7 +21,7 @@ v8::Handle Converter::ToV8(v8::Isolate* isolate, } bool Converter::FromV8(v8::Isolate* isolate, - v8::Handle val, + v8::Local val, gfx::Point* out) { mate::Dictionary dict; if (!ConvertFromV8(isolate, val, &dict)) @@ -33,7 +33,7 @@ bool Converter::FromV8(v8::Isolate* isolate, return true; } -v8::Handle Converter::ToV8(v8::Isolate* isolate, +v8::Local Converter::ToV8(v8::Isolate* isolate, const gfx::Size& val) { mate::Dictionary dict(isolate, v8::Object::New(isolate)); dict.Set("width", val.width()); @@ -42,7 +42,7 @@ v8::Handle Converter::ToV8(v8::Isolate* isolate, } bool Converter::FromV8(v8::Isolate* isolate, - v8::Handle val, + v8::Local val, gfx::Size* out) { mate::Dictionary dict; if (!ConvertFromV8(isolate, val, &dict)) @@ -54,7 +54,7 @@ bool Converter::FromV8(v8::Isolate* isolate, return true; } -v8::Handle Converter::ToV8(v8::Isolate* isolate, +v8::Local Converter::ToV8(v8::Isolate* isolate, const gfx::Rect& val) { mate::Dictionary dict(isolate, v8::Object::New(isolate)); dict.Set("x", val.x()); @@ -65,7 +65,7 @@ v8::Handle Converter::ToV8(v8::Isolate* isolate, } bool Converter::FromV8(v8::Isolate* isolate, - v8::Handle val, + v8::Local val, gfx::Rect* out) { mate::Dictionary dict; if (!ConvertFromV8(isolate, val, &dict)) @@ -80,7 +80,7 @@ bool Converter::FromV8(v8::Isolate* isolate, template<> struct Converter { - static v8::Handle ToV8(v8::Isolate* isolate, + static v8::Local ToV8(v8::Isolate* isolate, const gfx::Display::TouchSupport& val) { switch (val) { case gfx::Display::TOUCH_SUPPORT_AVAILABLE: @@ -93,7 +93,7 @@ struct Converter { } }; -v8::Handle Converter::ToV8(v8::Isolate* isolate, +v8::Local Converter::ToV8(v8::Isolate* isolate, const gfx::Display& val) { mate::Dictionary dict(isolate, v8::Object::New(isolate)); dict.Set("id", val.id()); diff --git a/atom/common/native_mate_converters/gfx_converter.h b/atom/common/native_mate_converters/gfx_converter.h index 35fd5039a72f..c6da76a2d0e7 100644 --- a/atom/common/native_mate_converters/gfx_converter.h +++ b/atom/common/native_mate_converters/gfx_converter.h @@ -18,37 +18,37 @@ namespace mate { template<> struct Converter { - static v8::Handle ToV8(v8::Isolate* isolate, + static v8::Local ToV8(v8::Isolate* isolate, const gfx::Point& val); static bool FromV8(v8::Isolate* isolate, - v8::Handle val, + v8::Local val, gfx::Point* out); }; template<> struct Converter { - static v8::Handle ToV8(v8::Isolate* isolate, + static v8::Local ToV8(v8::Isolate* isolate, const gfx::Size& val); static bool FromV8(v8::Isolate* isolate, - v8::Handle val, + v8::Local val, gfx::Size* out); }; template<> struct Converter { - static v8::Handle ToV8(v8::Isolate* isolate, + static v8::Local ToV8(v8::Isolate* isolate, const gfx::Rect& val); static bool FromV8(v8::Isolate* isolate, - v8::Handle val, + v8::Local val, gfx::Rect* out); }; template<> struct Converter { - static v8::Handle ToV8(v8::Isolate* isolate, + static v8::Local ToV8(v8::Isolate* isolate, const gfx::Display& val); static bool FromV8(v8::Isolate* isolate, - v8::Handle val, + v8::Local val, gfx::Display* out); }; diff --git a/atom/common/native_mate_converters/gurl_converter.h b/atom/common/native_mate_converters/gurl_converter.h index f578ad4cffcd..34408913b789 100644 --- a/atom/common/native_mate_converters/gurl_converter.h +++ b/atom/common/native_mate_converters/gurl_converter.h @@ -14,12 +14,12 @@ namespace mate { template<> struct Converter { - static v8::Handle ToV8(v8::Isolate* isolate, + static v8::Local ToV8(v8::Isolate* isolate, const GURL& val) { return ConvertToV8(isolate, val.spec()); } static bool FromV8(v8::Isolate* isolate, - v8::Handle val, + v8::Local val, GURL* out) { std::string url; if (Converter::FromV8(isolate, val, &url)) { diff --git a/atom/common/native_mate_converters/image_converter.cc b/atom/common/native_mate_converters/image_converter.cc index ec5c50f31564..550bb7b904a7 100644 --- a/atom/common/native_mate_converters/image_converter.cc +++ b/atom/common/native_mate_converters/image_converter.cc @@ -11,7 +11,7 @@ namespace mate { bool Converter::FromV8(v8::Isolate* isolate, - v8::Handle val, + v8::Local val, gfx::ImageSkia* out) { gfx::Image image; if (!ConvertFromV8(isolate, val, &image)) @@ -22,7 +22,7 @@ bool Converter::FromV8(v8::Isolate* isolate, } bool Converter::FromV8(v8::Isolate* isolate, - v8::Handle val, + v8::Local val, gfx::Image* out) { if (val->IsNull()) return true; @@ -43,7 +43,7 @@ bool Converter::FromV8(v8::Isolate* isolate, return true; } -v8::Handle Converter::ToV8(v8::Isolate* isolate, +v8::Local Converter::ToV8(v8::Isolate* isolate, const gfx::Image& val) { return ConvertToV8(isolate, atom::api::NativeImage::Create(isolate, val)); } diff --git a/atom/common/native_mate_converters/image_converter.h b/atom/common/native_mate_converters/image_converter.h index 1b1a12c3ae02..be52288eb049 100644 --- a/atom/common/native_mate_converters/image_converter.h +++ b/atom/common/native_mate_converters/image_converter.h @@ -17,16 +17,16 @@ namespace mate { template<> struct Converter { static bool FromV8(v8::Isolate* isolate, - v8::Handle val, + v8::Local val, gfx::ImageSkia* out); }; template<> struct Converter { static bool FromV8(v8::Isolate* isolate, - v8::Handle val, + v8::Local val, gfx::Image* out); - static v8::Handle ToV8(v8::Isolate* isolate, + static v8::Local ToV8(v8::Isolate* isolate, const gfx::Image& val); }; diff --git a/atom/common/native_mate_converters/string16_converter.h b/atom/common/native_mate_converters/string16_converter.h index 4eb7d7698870..9fff5be45f7a 100644 --- a/atom/common/native_mate_converters/string16_converter.h +++ b/atom/common/native_mate_converters/string16_converter.h @@ -12,13 +12,13 @@ namespace mate { template<> struct Converter { - static v8::Handle ToV8(v8::Isolate* isolate, + static v8::Local ToV8(v8::Isolate* isolate, const base::string16& val) { return MATE_STRING_NEW_FROM_UTF16( isolate, reinterpret_cast(val.data()), val.size()); } static bool FromV8(v8::Isolate* isolate, - v8::Handle val, + v8::Local val, base::string16* out) { if (!val->IsString()) return false; diff --git a/atom/common/native_mate_converters/v8_value_converter.cc b/atom/common/native_mate_converters/v8_value_converter.cc index 7c34b222ff01..87bc2e7c030f 100644 --- a/atom/common/native_mate_converters/v8_value_converter.cc +++ b/atom/common/native_mate_converters/v8_value_converter.cc @@ -46,7 +46,7 @@ class V8ValueConverter::FromV8ValueState { // other handle B in the map points to the same object as A. Note that A can // be unique even if there already is another handle with the same identity // hash (key) in the map, because two objects can have the same hash. - bool UpdateAndCheckUniqueness(v8::Handle handle) { + bool UpdateAndCheckUniqueness(v8::Local handle) { typedef HashToHandleMap::const_iterator Iterator; int hash = handle->GetIdentityHash(); // We only compare using == with handles to objects with the same identity @@ -67,7 +67,7 @@ class V8ValueConverter::FromV8ValueState { } private: - typedef std::multimap > HashToHandleMap; + typedef std::multimap > HashToHandleMap; HashToHandleMap unique_map_; int max_recursion_depth_; @@ -202,7 +202,7 @@ v8::Local V8ValueConverter::ToV8Object( base::Value* V8ValueConverter::FromV8ValueImpl( FromV8ValueState* state, - v8::Handle val, + v8::Local val, v8::Isolate* isolate) const { CHECK(!val.IsEmpty()); @@ -267,7 +267,7 @@ base::Value* V8ValueConverter::FromV8ValueImpl( } base::Value* V8ValueConverter::FromV8Array( - v8::Handle val, + v8::Local val, FromV8ValueState* state, v8::Isolate* isolate) const { if (!state->UpdateAndCheckUniqueness(val)) diff --git a/atom/common/native_mate_converters/v8_value_converter.h b/atom/common/native_mate_converters/v8_value_converter.h index 94250a335f2a..3a0f6374ccb4 100644 --- a/atom/common/native_mate_converters/v8_value_converter.h +++ b/atom/common/native_mate_converters/v8_value_converter.h @@ -43,9 +43,9 @@ class V8ValueConverter { const base::DictionaryValue* dictionary) const; base::Value* FromV8ValueImpl(FromV8ValueState* state, - v8::Handle value, + v8::Local value, v8::Isolate* isolate) const; - base::Value* FromV8Array(v8::Handle array, + base::Value* FromV8Array(v8::Local array, FromV8ValueState* state, v8::Isolate* isolate) const; diff --git a/atom/common/native_mate_converters/value_converter.cc b/atom/common/native_mate_converters/value_converter.cc index 65d47b2af8c4..815ba0ebb211 100644 --- a/atom/common/native_mate_converters/value_converter.cc +++ b/atom/common/native_mate_converters/value_converter.cc @@ -10,7 +10,7 @@ namespace mate { bool Converter::FromV8(v8::Isolate* isolate, - v8::Handle val, + v8::Local val, base::DictionaryValue* out) { scoped_ptr converter(new atom::V8ValueConverter); scoped_ptr value(converter->FromV8Value( @@ -24,7 +24,7 @@ bool Converter::FromV8(v8::Isolate* isolate, } bool Converter::FromV8(v8::Isolate* isolate, - v8::Handle val, + v8::Local val, base::ListValue* out) { scoped_ptr converter(new atom::V8ValueConverter); scoped_ptr value(converter->FromV8Value( @@ -37,7 +37,7 @@ bool Converter::FromV8(v8::Isolate* isolate, } } -v8::Handle Converter::ToV8( +v8::Local Converter::ToV8( v8::Isolate* isolate, const base::ListValue& val) { scoped_ptr converter(new atom::V8ValueConverter); diff --git a/atom/common/native_mate_converters/value_converter.h b/atom/common/native_mate_converters/value_converter.h index 4810e6aa26f0..bb0ef66e719b 100644 --- a/atom/common/native_mate_converters/value_converter.h +++ b/atom/common/native_mate_converters/value_converter.h @@ -17,16 +17,16 @@ namespace mate { template<> struct Converter { static bool FromV8(v8::Isolate* isolate, - v8::Handle val, + v8::Local val, base::DictionaryValue* out); }; template<> struct Converter { static bool FromV8(v8::Isolate* isolate, - v8::Handle val, + v8::Local val, base::ListValue* out); - static v8::Handle ToV8(v8::Isolate* isolate, + static v8::Local ToV8(v8::Isolate* isolate, const base::ListValue& val); }; diff --git a/atom/renderer/api/atom_api_renderer_ipc.cc b/atom/renderer/api/atom_api_renderer_ipc.cc index 81209d9cffae..00a5ba861650 100644 --- a/atom/renderer/api/atom_api_renderer_ipc.cc +++ b/atom/renderer/api/atom_api_renderer_ipc.cc @@ -62,8 +62,8 @@ base::string16 SendSync(const base::string16& channel, return json; } -void Initialize(v8::Handle exports, v8::Handle unused, - v8::Handle context, void* priv) { +void Initialize(v8::Local exports, v8::Local unused, + v8::Local context, void* priv) { mate::Dictionary dict(context->GetIsolate(), exports); dict.SetMethod("send", &Send); dict.SetMethod("sendSync", &SendSync); diff --git a/atom/renderer/api/atom_api_spell_check_client.cc b/atom/renderer/api/atom_api_spell_check_client.cc index e4ee25ea5eff..25d1e30b0aac 100644 --- a/atom/renderer/api/atom_api_spell_check_client.cc +++ b/atom/renderer/api/atom_api_spell_check_client.cc @@ -41,7 +41,7 @@ bool HasWordCharacters(const base::string16& text, int index) { SpellCheckClient::SpellCheckClient(const std::string& language, bool auto_spell_correct_turned_on, v8::Isolate* isolate, - v8::Handle provider) + v8::Local provider) : auto_spell_correct_turned_on_(auto_spell_correct_turned_on), isolate_(isolate), provider_(isolate, provider) { @@ -160,8 +160,8 @@ bool SpellCheckClient::SpellCheckWord(const base::string16& word_to_check) { return true; v8::HandleScope handle_scope(isolate_); - v8::Handle word = mate::ConvertToV8(isolate_, word_to_check); - v8::Handle result = spell_check_.NewHandle()->Call( + v8::Local word = mate::ConvertToV8(isolate_, word_to_check); + v8::Local result = spell_check_.NewHandle()->Call( provider_.NewHandle(), 1, &word); if (result->IsBoolean()) diff --git a/atom/renderer/api/atom_api_spell_check_client.h b/atom/renderer/api/atom_api_spell_check_client.h index fa616528d482..345cad186ace 100644 --- a/atom/renderer/api/atom_api_spell_check_client.h +++ b/atom/renderer/api/atom_api_spell_check_client.h @@ -22,7 +22,7 @@ class SpellCheckClient : public blink::WebSpellCheckClient { SpellCheckClient(const std::string& language, bool auto_spell_correct_turned_on, v8::Isolate* isolate, - v8::Handle provider); + v8::Local provider); virtual ~SpellCheckClient(); private: diff --git a/atom/renderer/api/atom_api_web_frame.cc b/atom/renderer/api/atom_api_web_frame.cc index ee0d11a0200b..21c0592a7c43 100644 --- a/atom/renderer/api/atom_api_web_frame.cc +++ b/atom/renderer/api/atom_api_web_frame.cc @@ -27,7 +27,7 @@ namespace mate { template<> struct Converter { static bool FromV8(v8::Isolate* isolate, - v8::Handle val, + v8::Local val, WTF::String* out) { if (!val->IsString()) return false; @@ -72,8 +72,8 @@ double WebFrame::GetZoomFactor() const { return blink::WebView::zoomLevelToZoomFactor(GetZoomLevel()); } -v8::Handle WebFrame::RegisterEmbedderCustomElement( - const base::string16& name, v8::Handle options) { +v8::Local WebFrame::RegisterEmbedderCustomElement( + const base::string16& name, v8::Local options) { blink::WebExceptionCode c = 0; return web_frame_->document().registerEmbedderCustomElement(name, options, c); } @@ -85,7 +85,7 @@ void WebFrame::AttachGuest(int id) { void WebFrame::SetSpellCheckProvider(mate::Arguments* args, const std::string& language, bool auto_spell_correct_turned_on, - v8::Handle provider) { + v8::Local provider) { if (!provider->Has(mate::StringToV8(args->isolate(), "spellCheck"))) { args->ThrowError("\"spellCheck\" has to be defined"); return; @@ -123,8 +123,8 @@ mate::Handle WebFrame::Create(v8::Isolate* isolate) { namespace { -void Initialize(v8::Handle exports, v8::Handle unused, - v8::Handle context, void* priv) { +void Initialize(v8::Local exports, v8::Local unused, + v8::Local context, void* priv) { v8::Isolate* isolate = context->GetIsolate(); mate::Dictionary dict(isolate, exports); dict.Set("webFrame", atom::api::WebFrame::Create(isolate)); diff --git a/atom/renderer/api/atom_api_web_frame.h b/atom/renderer/api/atom_api_web_frame.h index aca4d0f0b52b..f9afa1d1d616 100644 --- a/atom/renderer/api/atom_api_web_frame.h +++ b/atom/renderer/api/atom_api_web_frame.h @@ -40,15 +40,15 @@ class WebFrame : public mate::Wrappable { double SetZoomFactor(double factor); double GetZoomFactor() const; - v8::Handle RegisterEmbedderCustomElement( - const base::string16& name, v8::Handle options); + v8::Local RegisterEmbedderCustomElement( + const base::string16& name, v8::Local options); void AttachGuest(int element_instance_id); // Set the provider that will be used by SpellCheckClient for spell check. void SetSpellCheckProvider(mate::Arguments* args, const std::string& language, bool auto_spell_correct_turned_on, - v8::Handle provider); + v8::Local provider); // mate::Wrappable: virtual mate::ObjectTemplateBuilder GetObjectTemplateBuilder( diff --git a/atom/renderer/atom_render_view_observer.cc b/atom/renderer/atom_render_view_observer.cc index 2c1166b7e24f..10ac9bbd6b7c 100644 --- a/atom/renderer/atom_render_view_observer.cc +++ b/atom/renderer/atom_render_view_observer.cc @@ -30,21 +30,21 @@ namespace atom { namespace { bool GetIPCObject(v8::Isolate* isolate, - v8::Handle context, - v8::Handle* ipc) { - v8::Handle key = mate::StringToV8(isolate, "ipc"); - v8::Handle value = context->Global()->GetHiddenValue(key); + v8::Local context, + v8::Local* ipc) { + v8::Local key = mate::StringToV8(isolate, "ipc"); + v8::Local value = context->Global()->GetHiddenValue(key); if (value.IsEmpty() || !value->IsObject()) return false; *ipc = value->ToObject(); return true; } -std::vector> ListValueToVector( +std::vector> ListValueToVector( v8::Isolate* isolate, const base::ListValue& list) { - v8::Handle array = mate::ConvertToV8(isolate, list); - std::vector> result; + v8::Local array = mate::ConvertToV8(isolate, list); + std::vector> result; mate::ConvertFromV8(isolate, array, &result); return result; } @@ -119,11 +119,11 @@ void AtomRenderViewObserver::OnBrowserMessage(const base::string16& channel, v8::Local context = frame->mainWorldScriptContext(); v8::Context::Scope context_scope(context); - std::vector> arguments = ListValueToVector( + std::vector> arguments = ListValueToVector( isolate, args); arguments.insert(arguments.begin(), mate::ConvertToV8(isolate, channel)); - v8::Handle ipc; + v8::Local ipc; if (GetIPCObject(isolate, context, &ipc)) node::MakeCallback(isolate, ipc, "emit", arguments.size(), &arguments[0]); } diff --git a/vendor/native_mate b/vendor/native_mate index 047a8de9342a..269be869988b 160000 --- a/vendor/native_mate +++ b/vendor/native_mate @@ -1 +1 @@ -Subproject commit 047a8de9342a3217a8d8316f77b9276e8eb7a649 +Subproject commit 269be869988bda9a7e8ad0ef56af178a741af09c From b202bba2e6ef31b70476385fc0baa009b2a8b58e Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 22 May 2015 22:15:13 +0800 Subject: [PATCH 0075/1293] Don't read Buffer in IO thread --- atom/browser/api/atom_api_protocol.cc | 11 ++++++++++- atom/browser/net/adapter_request_job.cc | 18 +++++------------- atom/browser/net/adapter_request_job.h | 3 ++- atom/browser/net/url_request_buffer_job.cc | 16 +++++++--------- atom/browser/net/url_request_buffer_job.h | 2 +- vendor/native_mate | 2 +- 6 files changed, 26 insertions(+), 26 deletions(-) diff --git a/atom/browser/api/atom_api_protocol.cc b/atom/browser/api/atom_api_protocol.cc index 0d56a6fb1c49..323d282b19a9 100644 --- a/atom/browser/api/atom_api_protocol.cc +++ b/atom/browser/api/atom_api_protocol.cc @@ -42,6 +42,14 @@ namespace { typedef net::URLRequestJobFactory::ProtocolHandler ProtocolHandler; +scoped_refptr BufferToRefCountedBytes( + v8::Local buf) { + scoped_refptr data(new base::RefCountedBytes); + auto start = reinterpret_cast(node::Buffer::Data(buf)); + data->data().assign(start, start + node::Buffer::Length(buf)); + return data; +} + class CustomProtocolRequestJob : public AdapterRequestJob { public: CustomProtocolRequestJob(Protocol* registry, @@ -95,7 +103,8 @@ class CustomProtocolRequestJob : public AdapterRequestJob { BrowserThread::PostTask(BrowserThread::IO, FROM_HERE, base::Bind(&AdapterRequestJob::CreateBufferJobAndStart, - GetWeakPtr(), mime_type, encoding, buffer->ToObject())); + GetWeakPtr(), mime_type, encoding, + BufferToRefCountedBytes(buffer))); return; } else if (name == "RequestFileJob") { base::FilePath path; diff --git a/atom/browser/net/adapter_request_job.cc b/atom/browser/net/adapter_request_job.cc index 8b562bcbf248..af3b02f150f4 100644 --- a/atom/browser/net/adapter_request_job.cc +++ b/atom/browser/net/adapter_request_job.cc @@ -71,8 +71,6 @@ base::WeakPtr AdapterRequestJob::GetWeakPtr() { } void AdapterRequestJob::CreateErrorJobAndStart(int error_code) { - DCHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::IO)); - real_job_ = new net::URLRequestErrorJob( request(), network_delegate(), error_code); real_job_->Start(); @@ -81,25 +79,21 @@ void AdapterRequestJob::CreateErrorJobAndStart(int error_code) { void AdapterRequestJob::CreateStringJobAndStart(const std::string& mime_type, const std::string& charset, const std::string& data) { - DCHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::IO)); - real_job_ = new URLRequestStringJob( request(), network_delegate(), mime_type, charset, data); real_job_->Start(); } -void AdapterRequestJob::CreateBufferJobAndStart(const std::string& mime_type, - const std::string& charset, - v8::Local buffer) { - DCHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::IO)); - +void AdapterRequestJob::CreateBufferJobAndStart( + const std::string& mime_type, + const std::string& charset, + scoped_refptr data) { real_job_ = new URLRequestBufferJob( - request(), network_delegate(), mime_type, charset, buffer); + request(), network_delegate(), mime_type, charset, data); real_job_->Start(); } void AdapterRequestJob::CreateFileJobAndStart(const base::FilePath& path) { - DCHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::IO)); real_job_ = asar::CreateJobFromPath( path, request(), @@ -111,8 +105,6 @@ void AdapterRequestJob::CreateFileJobAndStart(const base::FilePath& path) { } void AdapterRequestJob::CreateJobFromProtocolHandlerAndStart() { - DCHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::IO)); - DCHECK(protocol_handler_); real_job_ = protocol_handler_->MaybeCreateJob(request(), network_delegate()); if (!real_job_.get()) diff --git a/atom/browser/net/adapter_request_job.h b/atom/browser/net/adapter_request_job.h index 406214e3c162..d87207464c08 100644 --- a/atom/browser/net/adapter_request_job.h +++ b/atom/browser/net/adapter_request_job.h @@ -7,6 +7,7 @@ #include +#include "base/memory/ref_counted_memory.h" #include "base/memory/weak_ptr.h" #include "net/url_request/url_request_job.h" #include "net/url_request/url_request_job_factory.h" @@ -53,7 +54,7 @@ class AdapterRequestJob : public net::URLRequestJob { const std::string& data); void CreateBufferJobAndStart(const std::string& mime_type, const std::string& charset, - v8::Local buffer); + scoped_refptr data); void CreateFileJobAndStart(const base::FilePath& path); void CreateJobFromProtocolHandlerAndStart(); diff --git a/atom/browser/net/url_request_buffer_job.cc b/atom/browser/net/url_request_buffer_job.cc index 4aeb3284a4e9..a8233b88da46 100644 --- a/atom/browser/net/url_request_buffer_job.cc +++ b/atom/browser/net/url_request_buffer_job.cc @@ -10,18 +10,16 @@ namespace atom { -URLRequestBufferJob::URLRequestBufferJob(net::URLRequest* request, - net::NetworkDelegate* network_delegate, - const std::string& mime_type, - const std::string& charset, - v8::Local data) +URLRequestBufferJob::URLRequestBufferJob( + net::URLRequest* request, + net::NetworkDelegate* network_delegate, + const std::string& mime_type, + const std::string& charset, + scoped_refptr data) : net::URLRequestSimpleJob(request, network_delegate), mime_type_(mime_type), charset_(charset), - buffer_data_(new base::RefCountedBytes()) { - auto input = reinterpret_cast(node::Buffer::Data(data)); - size_t length = node::Buffer::Length(data); - buffer_data_->data().assign(input, input + length); + buffer_data_(data) { } int URLRequestBufferJob::GetRefCountedData( diff --git a/atom/browser/net/url_request_buffer_job.h b/atom/browser/net/url_request_buffer_job.h index 936d96409428..cbdfbfa10d0b 100644 --- a/atom/browser/net/url_request_buffer_job.h +++ b/atom/browser/net/url_request_buffer_job.h @@ -19,7 +19,7 @@ class URLRequestBufferJob : public net::URLRequestSimpleJob { net::NetworkDelegate* network_delegate, const std::string& mime_type, const std::string& charset, - v8::Local buffer); + scoped_refptr data); // URLRequestSimpleJob: int GetRefCountedData(std::string* mime_type, diff --git a/vendor/native_mate b/vendor/native_mate index 269be869988b..1696237a3f44 160000 --- a/vendor/native_mate +++ b/vendor/native_mate @@ -1 +1 @@ -Subproject commit 269be869988bda9a7e8ad0ef56af178a741af09c +Subproject commit 1696237a3f444f0e33a8947749b4d70f6feb511b From e233eab4f2ae48b40c9ca42933c1bd54ebddec17 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Sat, 23 May 2015 11:58:20 +0800 Subject: [PATCH 0076/1293] HandleMouseDown is deprecated --- atom/browser/native_window_views.cc | 3 ++- atom/browser/native_window_views.h | 2 +- vendor/brightray | 2 +- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/atom/browser/native_window_views.cc b/atom/browser/native_window_views.cc index 4c99f88969ba..bd1bd76478eb 100644 --- a/atom/browser/native_window_views.cc +++ b/atom/browser/native_window_views.cc @@ -840,7 +840,8 @@ void NativeWindowViews::GetDevToolsWindowWMClass( } #endif -void NativeWindowViews::HandleMouseDown() { +void NativeWindowViews::ActivateContents(content::WebContents* contents) { + NativeWindow::ActivateContents(contents); // Hide menu bar when web view is clicked. if (menu_bar_autohide_ && menu_bar_visible_) SetMenuBarVisibility(false); diff --git a/atom/browser/native_window_views.h b/atom/browser/native_window_views.h index 15f073d8d8c1..ae8b6205321a 100644 --- a/atom/browser/native_window_views.h +++ b/atom/browser/native_window_views.h @@ -125,7 +125,7 @@ class NativeWindowViews : public NativeWindow, #endif // content::WebContentsDelegate: - void HandleMouseDown() override; + void ActivateContents(content::WebContents* contents) override; void HandleKeyboardEvent( content::WebContents*, const content::NativeWebKeyboardEvent& event) override; diff --git a/vendor/brightray b/vendor/brightray index 7addcd81c6af..748e5b922456 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit 7addcd81c6af25691b09c27bd461d63176eb6b87 +Subproject commit 748e5b922456f352a7cc54c0705d0a997f926a18 From abd97a7513ffd54a682cdded87351914d409eb70 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Mon, 11 May 2015 20:14:07 +0800 Subject: [PATCH 0077/1293] Load pdf component dynamically. Ship pdf as dll library, electron only loads pdf.dll when calling print API. In this way, the developer who don't need print feature can safe remove the pdf.dll in saving their binary size. --- atom/app/atom_main_delegate.cc | 6 + atom/utility/atom_content_utility_client.cc | 5 + atom/utility/atom_content_utility_client.h | 1 + .../chrome/utility/printing_handler.cc | 107 +++++++++++++++++- .../chrome/utility/printing_handler.h | 2 + 5 files changed, 118 insertions(+), 3 deletions(-) diff --git a/atom/app/atom_main_delegate.cc b/atom/app/atom_main_delegate.cc index e73cc06bc464..ff9d14cf593a 100644 --- a/atom/app/atom_main_delegate.cc +++ b/atom/app/atom_main_delegate.cc @@ -64,6 +64,12 @@ void AtomMainDelegate::PreSandboxStartup() { std::string process_type = command_line->GetSwitchValueASCII( switches::kProcessType); +#if defined(OS_WIN) + if (process_type == switches::kUtilityProcess) { + AtomContentUtilityClient::PreSandboxStartup(); + } +#endif + // Only append arguments for browser process. if (!process_type.empty()) return; diff --git a/atom/utility/atom_content_utility_client.cc b/atom/utility/atom_content_utility_client.cc index cc739227aad8..06d0c3b82cfd 100644 --- a/atom/utility/atom_content_utility_client.cc +++ b/atom/utility/atom_content_utility_client.cc @@ -71,4 +71,9 @@ void AtomContentUtilityClient::OnStartupPing() { // Don't release the process, we assume further messages are on the way. } +// static +void AtomContentUtilityClient::PreSandboxStartup() { + PrintingHandler::PreSandboxStartup(); +} + } // namespace atom diff --git a/atom/utility/atom_content_utility_client.h b/atom/utility/atom_content_utility_client.h index 2c245b62f61e..756193d6d44c 100644 --- a/atom/utility/atom_content_utility_client.h +++ b/atom/utility/atom_content_utility_client.h @@ -31,6 +31,7 @@ class AtomContentUtilityClient : public content::ContentUtilityClient { void UtilityThreadStarted() override; bool OnMessageReceived(const IPC::Message& message) override; + static void PreSandboxStartup(); static void set_max_ipc_message_size_for_test(int64_t max_message_size) { max_ipc_message_size_ = max_message_size; diff --git a/chromium_src/chrome/utility/printing_handler.cc b/chromium_src/chrome/utility/printing_handler.cc index db6d9533cf51..7821c174c950 100644 --- a/chromium_src/chrome/utility/printing_handler.cc +++ b/chromium_src/chrome/utility/printing_handler.cc @@ -10,7 +10,6 @@ #include "base/scoped_native_library.h" #include "chrome/common/print_messages.h" #include "content/public/utility/utility_thread.h" -#include "pdf/pdf.h" #include "printing/page_range.h" #include "printing/pdf_render_settings.h" @@ -30,12 +29,111 @@ void ReleaseProcessIfNeeded() { content::UtilityThread::Get()->ReleaseProcessIfNeeded(); } +class PdfFunctions { + public: + PdfFunctions() : get_pdf_doc_info_func_(NULL), + render_pdf_to_dc_func_(NULL) {} + + bool Init() { + base::FilePath pdf_module_path(FILE_PATH_LITERAL("pdf.dll")); + pdf_lib_.Reset(base::LoadNativeLibrary(pdf_module_path, NULL)); + if (!pdf_lib_.is_valid()) { + LOG(WARNING) << "Couldn't load PDF plugin"; + return false; + } + + get_pdf_doc_info_func_ = + reinterpret_cast( + pdf_lib_.GetFunctionPointer("GetPDFDocInfo")); + LOG_IF(WARNING, !get_pdf_doc_info_func_) << "Missing GetPDFDocInfo"; + + render_pdf_to_dc_func_ = + reinterpret_cast( + pdf_lib_.GetFunctionPointer("RenderPDFPageToDC")); + LOG_IF(WARNING, !render_pdf_to_dc_func_) << "Missing RenderPDFPageToDC"; + + if (!get_pdf_doc_info_func_ || !render_pdf_to_dc_func_) { + Reset(); + } + + return IsValid(); + } + + bool IsValid() const { + return pdf_lib_.is_valid(); + } + + void Reset() { + pdf_lib_.Reset(NULL); + } + + bool GetPDFDocInfo(const void* pdf_buffer, + int buffer_size, + int* page_count, + double* max_page_width) { + if (!get_pdf_doc_info_func_) + return false; + return get_pdf_doc_info_func_(pdf_buffer, buffer_size, page_count, + max_page_width); + } + + bool RenderPDFPageToDC(const void* pdf_buffer, + int buffer_size, + int page_number, + HDC dc, + int dpi, + int bounds_origin_x, + int bounds_origin_y, + int bounds_width, + int bounds_height, + bool fit_to_bounds, + bool stretch_to_bounds, + bool keep_aspect_ratio, + bool center_in_bounds, + bool autorotate) { + if (!render_pdf_to_dc_func_) + return false; + return render_pdf_to_dc_func_(pdf_buffer, buffer_size, page_number, + dc, dpi, bounds_origin_x, + bounds_origin_y, bounds_width, bounds_height, + fit_to_bounds, stretch_to_bounds, + keep_aspect_ratio, center_in_bounds, + autorotate); + } + + private: + // Exported by PDF plugin. + typedef bool (*GetPDFDocInfoProc)(const void* pdf_buffer, + int buffer_size, int* page_count, + double* max_page_width); + typedef bool (*RenderPDFPageToDCProc)( + const void* pdf_buffer, int buffer_size, int page_number, HDC dc, + int dpi, int bounds_origin_x, int bounds_origin_y, + int bounds_width, int bounds_height, bool fit_to_bounds, + bool stretch_to_bounds, bool keep_aspect_ratio, bool center_in_bounds, + bool autorotate); + + RenderPDFPageToDCProc render_pdf_to_dc_func_; + GetPDFDocInfoProc get_pdf_doc_info_func_; + + base::ScopedNativeLibrary pdf_lib_; + + DISALLOW_COPY_AND_ASSIGN(PdfFunctions); +}; + +base::LazyInstance g_pdf_lib = LAZY_INSTANCE_INITIALIZER; + } // namespace PrintingHandler::PrintingHandler() {} PrintingHandler::~PrintingHandler() {} +// static +void PrintingHandler::PreSandboxStartup() { + g_pdf_lib.Get().Init(); +} + bool PrintingHandler::OnMessageReceived(const IPC::Message& message) { bool handled = true; IPC_BEGIN_MESSAGE_MAP(PrintingHandler, message) @@ -80,6 +178,9 @@ void PrintingHandler::OnRenderPDFPagesToMetafileStop() { } int PrintingHandler::LoadPDF(base::File pdf_file) { + if (!g_pdf_lib.Get().IsValid()) + return 0; + int64 length64 = pdf_file.GetLength(); if (length64 <= 0 || length64 > std::numeric_limits::max()) return 0; @@ -90,7 +191,7 @@ int PrintingHandler::LoadPDF(base::File pdf_file) { return 0; int total_page_count = 0; - if (!chrome_pdf::GetPDFDocInfo( + if (!g_pdf_lib.Get().GetPDFDocInfo( &pdf_data_.front(), pdf_data_.size(), &total_page_count, NULL)) { return 0; } @@ -119,7 +220,7 @@ bool PrintingHandler::RenderPdfPageToMetafile(int page_number, // The underlying metafile is of type Emf and ignores the arguments passed // to StartPage. metafile.StartPage(gfx::Size(), gfx::Rect(), 1); - if (!chrome_pdf::RenderPDFPageToDC( + if (!g_pdf_lib.Get().RenderPDFPageToDC( &pdf_data_.front(), pdf_data_.size(), page_number, diff --git a/chromium_src/chrome/utility/printing_handler.h b/chromium_src/chrome/utility/printing_handler.h index b1f09acb9cc9..ad96dd704ffe 100644 --- a/chromium_src/chrome/utility/printing_handler.h +++ b/chromium_src/chrome/utility/printing_handler.h @@ -30,6 +30,8 @@ class PrintingHandler : public UtilityMessageHandler { // IPC::Listener: bool OnMessageReceived(const IPC::Message& message) override; + static void PrintingHandler::PreSandboxStartup(); + private: // IPC message handlers. #if defined(OS_WIN) From 5ede62459cb76dd74c782661ceac4763c0ceac9d Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Mon, 11 May 2015 20:57:07 +0800 Subject: [PATCH 0078/1293] Rename PrintHandler to PrintHandlerWin since only used on Windows. --- atom/utility/atom_content_utility_client.cc | 8 ++-- ...ing_handler.cc => printing_handler_win.cc} | 37 +++++++------------ ...nting_handler.h => printing_handler_win.h} | 26 ++++--------- filenames.gypi | 4 +- 4 files changed, 29 insertions(+), 46 deletions(-) rename chromium_src/chrome/utility/{printing_handler.cc => printing_handler_win.cc} (90%) rename chromium_src/chrome/utility/{printing_handler.h => printing_handler_win.h} (68%) diff --git a/atom/utility/atom_content_utility_client.cc b/atom/utility/atom_content_utility_client.cc index 06d0c3b82cfd..2e591f2c6a8d 100644 --- a/atom/utility/atom_content_utility_client.cc +++ b/atom/utility/atom_content_utility_client.cc @@ -17,7 +17,7 @@ #if defined(OS_WIN) -#include "chrome/utility/printing_handler.h" +#include "chrome/utility/printing_handler_win.h" #endif @@ -37,7 +37,7 @@ int64_t AtomContentUtilityClient::max_ipc_message_size_ = AtomContentUtilityClient::AtomContentUtilityClient() : filter_messages_(false) { #if defined(OS_WIN) - handlers_.push_back(new PrintingHandler()); + handlers_.push_back(new PrintingHandlerWin()); #endif } @@ -73,7 +73,9 @@ void AtomContentUtilityClient::OnStartupPing() { // static void AtomContentUtilityClient::PreSandboxStartup() { - PrintingHandler::PreSandboxStartup(); +#if defined(OS_WIN) + PrintingHandlerWin::PreSandboxStartup(); +#endif } } // namespace atom diff --git a/chromium_src/chrome/utility/printing_handler.cc b/chromium_src/chrome/utility/printing_handler_win.cc similarity index 90% rename from chromium_src/chrome/utility/printing_handler.cc rename to chromium_src/chrome/utility/printing_handler_win.cc index 7821c174c950..705131f348cd 100644 --- a/chromium_src/chrome/utility/printing_handler.cc +++ b/chromium_src/chrome/utility/printing_handler_win.cc @@ -2,7 +2,7 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. -#include "chrome/utility/printing_handler.h" +#include "chrome/utility/printing_handler_win.h" #include "base/files/file_util.h" #include "base/lazy_instance.h" @@ -10,14 +10,10 @@ #include "base/scoped_native_library.h" #include "chrome/common/print_messages.h" #include "content/public/utility/utility_thread.h" +#include "printing/emf_win.h" #include "printing/page_range.h" #include "printing/pdf_render_settings.h" - -#if defined(OS_WIN) -#include "printing/emf_win.h" #include "ui/gfx/gdi_util.h" -#endif - namespace { @@ -125,33 +121,30 @@ base::LazyInstance g_pdf_lib = LAZY_INSTANCE_INITIALIZER; } // namespace -PrintingHandler::PrintingHandler() {} +PrintingHandlerWin::PrintingHandlerWin() {} -PrintingHandler::~PrintingHandler() {} +PrintingHandlerWin::~PrintingHandlerWin() {} // static -void PrintingHandler::PreSandboxStartup() { +void PrintingHandlerWin::PreSandboxStartup() { g_pdf_lib.Get().Init(); } -bool PrintingHandler::OnMessageReceived(const IPC::Message& message) { +bool PrintingHandlerWin::OnMessageReceived(const IPC::Message& message) { bool handled = true; - IPC_BEGIN_MESSAGE_MAP(PrintingHandler, message) -#if defined(OS_WIN) + IPC_BEGIN_MESSAGE_MAP(PrintingHandlerWin, message) IPC_MESSAGE_HANDLER(ChromeUtilityMsg_RenderPDFPagesToMetafiles, OnRenderPDFPagesToMetafile) IPC_MESSAGE_HANDLER(ChromeUtilityMsg_RenderPDFPagesToMetafiles_GetPage, OnRenderPDFPagesToMetafileGetPage) IPC_MESSAGE_HANDLER(ChromeUtilityMsg_RenderPDFPagesToMetafiles_Stop, OnRenderPDFPagesToMetafileStop) -#endif // OS_WIN IPC_MESSAGE_UNHANDLED(handled = false) IPC_END_MESSAGE_MAP() return handled; } -#if defined(OS_WIN) -void PrintingHandler::OnRenderPDFPagesToMetafile( +void PrintingHandlerWin::OnRenderPDFPagesToMetafile( IPC::PlatformFileForTransit pdf_transit, const printing::PdfRenderSettings& settings) { pdf_rendering_settings_ = settings; @@ -162,7 +155,7 @@ void PrintingHandler::OnRenderPDFPagesToMetafile( new ChromeUtilityHostMsg_RenderPDFPagesToMetafiles_PageCount(page_count)); } -void PrintingHandler::OnRenderPDFPagesToMetafileGetPage( +void PrintingHandlerWin::OnRenderPDFPagesToMetafileGetPage( int page_number, IPC::PlatformFileForTransit output_file) { base::File emf_file = IPC::PlatformFileForTransitToFile(output_file); @@ -173,11 +166,11 @@ void PrintingHandler::OnRenderPDFPagesToMetafileGetPage( success, scale_factor)); } -void PrintingHandler::OnRenderPDFPagesToMetafileStop() { +void PrintingHandlerWin::OnRenderPDFPagesToMetafileStop() { ReleaseProcessIfNeeded(); } -int PrintingHandler::LoadPDF(base::File pdf_file) { +int PrintingHandlerWin::LoadPDF(base::File pdf_file) { if (!g_pdf_lib.Get().IsValid()) return 0; @@ -198,9 +191,9 @@ int PrintingHandler::LoadPDF(base::File pdf_file) { return total_page_count; } -bool PrintingHandler::RenderPdfPageToMetafile(int page_number, - base::File output_file, - float* scale_factor) { +bool PrintingHandlerWin::RenderPdfPageToMetafile(int page_number, + base::File output_file, + float* scale_factor) { printing::Emf metafile; metafile.Init(); @@ -241,5 +234,3 @@ bool PrintingHandler::RenderPdfPageToMetafile(int page_number, metafile.FinishDocument(); return metafile.SaveTo(&output_file); } - -#endif // OS_WIN diff --git a/chromium_src/chrome/utility/printing_handler.h b/chromium_src/chrome/utility/printing_handler_win.h similarity index 68% rename from chromium_src/chrome/utility/printing_handler.h rename to chromium_src/chrome/utility/printing_handler_win.h index ad96dd704ffe..5b8c5e970f15 100644 --- a/chromium_src/chrome/utility/printing_handler.h +++ b/chromium_src/chrome/utility/printing_handler_win.h @@ -2,8 +2,8 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. -#ifndef CHROME_UTILITY_PRINTING_HANDLER_H_ -#define CHROME_UTILITY_PRINTING_HANDLER_H_ +#ifndef CHROME_UTILITY_PRINTING_HANDLER_WIN_H_ +#define CHROME_UTILITY_PRINTING_HANDLER_WIN_H_ #include "base/compiler_specific.h" #include "base/macros.h" @@ -11,10 +11,6 @@ #include "ipc/ipc_platform_file.h" #include "printing/pdf_render_settings.h" -#if !defined(ENABLE_PRINT_PREVIEW) && !defined(OS_WIN) -#error "Windows or full printing must be enabled" -#endif - namespace printing { class PdfRenderSettings; struct PwgRasterSettings; @@ -22,40 +18,34 @@ struct PageRange; } // Dispatches IPCs for printing. -class PrintingHandler : public UtilityMessageHandler { +class PrintingHandlerWin : public UtilityMessageHandler { public: - PrintingHandler(); - ~PrintingHandler() override; + PrintingHandlerWin(); + ~PrintingHandlerWin() override; // IPC::Listener: bool OnMessageReceived(const IPC::Message& message) override; - static void PrintingHandler::PreSandboxStartup(); + static void PrintingHandlerWin::PreSandboxStartup(); private: // IPC message handlers. -#if defined(OS_WIN) void OnRenderPDFPagesToMetafile(IPC::PlatformFileForTransit pdf_transit, const printing::PdfRenderSettings& settings); void OnRenderPDFPagesToMetafileGetPage( int page_number, IPC::PlatformFileForTransit output_file); void OnRenderPDFPagesToMetafileStop(); -#endif // OS_WIN -#if defined(OS_WIN) int LoadPDF(base::File pdf_file); bool RenderPdfPageToMetafile(int page_number, base::File output_file, float* scale_factor); -#endif // OS_WIN -#if defined(OS_WIN) std::vector pdf_data_; printing::PdfRenderSettings pdf_rendering_settings_; -#endif - DISALLOW_COPY_AND_ASSIGN(PrintingHandler); + DISALLOW_COPY_AND_ASSIGN(PrintingHandlerWin); }; -#endif // CHROME_UTILITY_PRINTING_HANDLER_H_ +#endif // CHROME_UTILITY_PRINTING_HANDLER_WIN_H_ diff --git a/filenames.gypi b/filenames.gypi index 5ba27229e321..13b75d79fa61 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -381,8 +381,8 @@ 'chromium_src/chrome/browser/ui/views/color_chooser_win.cc', 'chromium_src/chrome/browser/printing/pdf_to_emf_converter.cc', 'chromium_src/chrome/browser/printing/pdf_to_emf_converter.h', - 'chromium_src/chrome/utility/printing_handler.cc', - 'chromium_src/chrome/utility/printing_handler.h', + 'chromium_src/chrome/utility/printing_handler_win.cc', + 'chromium_src/chrome/utility/printing_handler_win.h', ], 'framework_sources': [ 'atom/app/atom_library_main.h', From f1f801b7a260559427dddffb7a7fbd8ba6499564 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Wed, 13 May 2015 08:04:27 +0800 Subject: [PATCH 0079/1293] Copy pdf.dll to build directory. --- atom.gyp | 1 + 1 file changed, 1 insertion(+) diff --git a/atom.gyp b/atom.gyp index 557d53028931..69d4b2f46f5d 100644 --- a/atom.gyp +++ b/atom.gyp @@ -134,6 +134,7 @@ '<(libchromiumcontent_dir)/ffmpegsumo.dll', '<(libchromiumcontent_dir)/libEGL.dll', '<(libchromiumcontent_dir)/libGLESv2.dll', + '<(libchromiumcontent_dir)/pdf.dll', '<(libchromiumcontent_dir)/icudtl.dat', '<(libchromiumcontent_dir)/content_resources_200_percent.pak', '<(libchromiumcontent_dir)/content_shell.pak', From bf5f85645ec3d019b4cf3bb1a6c7e92957658a76 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Wed, 13 May 2015 09:50:56 +0800 Subject: [PATCH 0080/1293] Remove the multiple rules generate pdf.dll warning in GYP during debug build. --- atom.gyp | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/atom.gyp b/atom.gyp index 69d4b2f46f5d..b514e8d9d247 100644 --- a/atom.gyp +++ b/atom.gyp @@ -124,7 +124,9 @@ '<@(libchromiumcontent_shared_v8_libraries)', ], }, { - 'copied_libraries': [], + 'copied_libraries': [ + '<(libchromiumcontent_dir)/pdf.dll', + ], }], ], }, @@ -134,7 +136,6 @@ '<(libchromiumcontent_dir)/ffmpegsumo.dll', '<(libchromiumcontent_dir)/libEGL.dll', '<(libchromiumcontent_dir)/libGLESv2.dll', - '<(libchromiumcontent_dir)/pdf.dll', '<(libchromiumcontent_dir)/icudtl.dat', '<(libchromiumcontent_dir)/content_resources_200_percent.pak', '<(libchromiumcontent_dir)/content_shell.pak', From c3791bba78aa5fb7563b25843712148bc61d803c Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Thu, 21 May 2015 15:01:36 +0800 Subject: [PATCH 0081/1293] Remove duplicated macro. --- atom/app/atom_main_delegate.cc | 2 -- 1 file changed, 2 deletions(-) diff --git a/atom/app/atom_main_delegate.cc b/atom/app/atom_main_delegate.cc index ff9d14cf593a..02dd11c81ba0 100644 --- a/atom/app/atom_main_delegate.cc +++ b/atom/app/atom_main_delegate.cc @@ -64,11 +64,9 @@ void AtomMainDelegate::PreSandboxStartup() { std::string process_type = command_line->GetSwitchValueASCII( switches::kProcessType); -#if defined(OS_WIN) if (process_type == switches::kUtilityProcess) { AtomContentUtilityClient::PreSandboxStartup(); } -#endif // Only append arguments for browser process. if (!process_type.empty()) From fdad5892d9f5b41657298982a09b5b245ba86103 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Sat, 23 May 2015 21:39:59 +0800 Subject: [PATCH 0082/1293] :memo: Add `pdf.dll` note doc. --- docs/api/browser-window.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index cc68f2008b9e..ef92d5b37afd 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -543,6 +543,10 @@ up system's default printer and default settings for printing. Calling `window.print()` in web page is equivalent to call `BrowserWindow.print({silent: false, printBackground: false})`. +**Note:** On Windows, the print API relies on `pdf.dll`. If your application +doesn't need print feature, you can safely remove `pdf.dll` in saving binary +size. + ### BrowserWindow.loadUrl(url) Same with `webContents.loadUrl(url)`. From c22b138b67b7e56554a780406292a8a3cffb8b12 Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Wed, 20 May 2015 21:24:59 +0530 Subject: [PATCH 0083/1293] webContents: providing header details with response event --- atom/browser/api/atom_api_web_contents.cc | 3 ++- atom/renderer/lib/web-view/guest-view-internal.coffee | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 441bb2408eb4..a361d747e6af 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -316,7 +316,8 @@ void WebContents::DidGetResourceResponseStart( details.original_url, details.http_response_code, details.method, - details.referrer); + details.referrer, + details.header); } void WebContents::DidGetRedirectForResourceRequest( diff --git a/atom/renderer/lib/web-view/guest-view-internal.coffee b/atom/renderer/lib/web-view/guest-view-internal.coffee index e856896ae61d..4d5f599b3527 100644 --- a/atom/renderer/lib/web-view/guest-view-internal.coffee +++ b/atom/renderer/lib/web-view/guest-view-internal.coffee @@ -10,7 +10,8 @@ WEB_VIEW_EVENTS = 'did-start-loading': [] 'did-stop-loading': [] 'did-get-response-details': ['status', 'newUrl', 'originalUrl', - 'httpResponseCode', 'requestMethod', 'referrer'] + 'httpResponseCode', 'requestMethod', 'referrer', + 'headers'] 'did-get-redirect-request': ['oldUrl', 'newUrl', 'isMainFrame'] 'dom-ready': [] 'console-message': ['level', 'message', 'line', 'sourceId'] From 4d5790dc09dcad616d34aa476b1551e978e72939 Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Fri, 22 May 2015 02:52:52 +0530 Subject: [PATCH 0084/1293] return headers as object --- atom/browser/api/atom_api_web_contents.cc | 13 ++++++++++++- .../native_mate_converters/value_converter.cc | 7 +++++++ .../common/native_mate_converters/value_converter.h | 2 ++ docs/api/browser-window.md | 3 +-- docs/api/web-view-tag.md | 3 +-- 5 files changed, 23 insertions(+), 5 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index a361d747e6af..23bdc24cf761 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -18,6 +18,7 @@ #include "atom/common/native_mate_converters/image_converter.h" #include "atom/common/native_mate_converters/string16_converter.h" #include "atom/common/native_mate_converters/value_converter.h" +#include "base/strings/string_util.h" #include "base/strings/utf_string_conversions.h" #include "brightray/browser/inspectable_web_contents.h" #include "brightray/browser/media/media_stream_devices_controller.h" @@ -38,6 +39,7 @@ #include "native_mate/callback.h" #include "native_mate/dictionary.h" #include "native_mate/object_template_builder.h" +#include "net/http/http_response_headers.h" #include "net/url_request/url_request_context.h" #include "atom/common/node_includes.h" @@ -310,6 +312,15 @@ void WebContents::DidStopLoading() { void WebContents::DidGetResourceResponseStart( const content::ResourceRequestDetails& details) { + net::HttpResponseHeaders* headers = details.headers.get(); + base::DictionaryValue response_headers; + void* iter = nullptr; + std::string key; + std::string value; + while (headers && headers->EnumerateHeaderLines(&iter, &key, &value)) { + response_headers.SetString(base::StringToLowerASCII(key), + base::StringToLowerASCII(value)); + } Emit("did-get-response-details", details.socket_address.IsEmpty(), details.url, @@ -317,7 +328,7 @@ void WebContents::DidGetResourceResponseStart( details.http_response_code, details.method, details.referrer, - details.header); + response_headers); } void WebContents::DidGetRedirectForResourceRequest( diff --git a/atom/common/native_mate_converters/value_converter.cc b/atom/common/native_mate_converters/value_converter.cc index 815ba0ebb211..7971623021a3 100644 --- a/atom/common/native_mate_converters/value_converter.cc +++ b/atom/common/native_mate_converters/value_converter.cc @@ -23,6 +23,13 @@ bool Converter::FromV8(v8::Isolate* isolate, } } +v8::Handle Converter::ToV8( + v8::Isolate* isolate, + const base::DictionaryValue& val) { + scoped_ptr converter(new atom::V8ValueConverter); + return converter->ToV8Value(&val, isolate->GetCurrentContext()); +} + bool Converter::FromV8(v8::Isolate* isolate, v8::Local val, base::ListValue* out) { diff --git a/atom/common/native_mate_converters/value_converter.h b/atom/common/native_mate_converters/value_converter.h index bb0ef66e719b..27e00f4521df 100644 --- a/atom/common/native_mate_converters/value_converter.h +++ b/atom/common/native_mate_converters/value_converter.h @@ -19,6 +19,8 @@ struct Converter { static bool FromV8(v8::Isolate* isolate, v8::Local val, base::DictionaryValue* out); + static v8::Handle ToV8(v8::Isolate* isolate, + const base::DictionaryValue& val); }; template<> diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index cc68f2008b9e..f7bc6396ecc7 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -674,11 +674,10 @@ Corresponds to the points in time when the spinner of the tab stops spinning. * `httpResponseCode` Integer * `requestMethod` String * `referrer` String -* `headers` String +* `headers` Object Emitted when details regarding a requested resource is available. `status` indicates the socket connection to download the resource. -`headers` is key-value string separated by new-line character. ### Event: 'did-get-redirect-request' diff --git a/docs/api/web-view-tag.md b/docs/api/web-view-tag.md index a1a472a5f154..96484649ceb8 100644 --- a/docs/api/web-view-tag.md +++ b/docs/api/web-view-tag.md @@ -333,11 +333,10 @@ Corresponds to the points in time when the spinner of the tab stops spinning. * `httpResponseCode` Integer * `requestMethod` String * `referrer` String -* `headers` String +* `headers` Object Fired when details regarding a requested resource is available. `status` indicates socket connection to download the resource. -`headers` is key-value string separated by new-line character. ### did-get-redirect-request From 2b9826404af7fa4c090a880628fe6db4593fa278 Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Fri, 22 May 2015 09:12:03 +0530 Subject: [PATCH 0085/1293] using mate::Dictionary instead of base::DictionaryValue --- atom/browser/api/atom_api_web_contents.cc | 14 +++++++++----- .../native_mate_converters/value_converter.cc | 7 ------- .../native_mate_converters/value_converter.h | 2 -- 3 files changed, 9 insertions(+), 14 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 23bdc24cf761..ab58ca0d8cc4 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -312,15 +312,19 @@ void WebContents::DidStopLoading() { void WebContents::DidGetResourceResponseStart( const content::ResourceRequestDetails& details) { + v8::Isolate* isolate = v8::Isolate::GetCurrent(); + v8::Locker locker(isolate); + v8::HandleScope handle_scope(isolate); + mate::Dictionary response_headers(isolate, v8::Object::New(isolate)); + net::HttpResponseHeaders* headers = details.headers.get(); - base::DictionaryValue response_headers; void* iter = nullptr; std::string key; std::string value; - while (headers && headers->EnumerateHeaderLines(&iter, &key, &value)) { - response_headers.SetString(base::StringToLowerASCII(key), - base::StringToLowerASCII(value)); - } + while (headers && headers->EnumerateHeaderLines(&iter, &key, &value)) + response_headers.Set(base::StringToLowerASCII(key), + base::StringToLowerASCII(value)); + Emit("did-get-response-details", details.socket_address.IsEmpty(), details.url, diff --git a/atom/common/native_mate_converters/value_converter.cc b/atom/common/native_mate_converters/value_converter.cc index 7971623021a3..815ba0ebb211 100644 --- a/atom/common/native_mate_converters/value_converter.cc +++ b/atom/common/native_mate_converters/value_converter.cc @@ -23,13 +23,6 @@ bool Converter::FromV8(v8::Isolate* isolate, } } -v8::Handle Converter::ToV8( - v8::Isolate* isolate, - const base::DictionaryValue& val) { - scoped_ptr converter(new atom::V8ValueConverter); - return converter->ToV8Value(&val, isolate->GetCurrentContext()); -} - bool Converter::FromV8(v8::Isolate* isolate, v8::Local val, base::ListValue* out) { diff --git a/atom/common/native_mate_converters/value_converter.h b/atom/common/native_mate_converters/value_converter.h index 27e00f4521df..bb0ef66e719b 100644 --- a/atom/common/native_mate_converters/value_converter.h +++ b/atom/common/native_mate_converters/value_converter.h @@ -19,8 +19,6 @@ struct Converter { static bool FromV8(v8::Isolate* isolate, v8::Local val, base::DictionaryValue* out); - static v8::Handle ToV8(v8::Isolate* isolate, - const base::DictionaryValue& val); }; template<> From d91ddc6177f80576c9317ed949acd4c258e7d656 Mon Sep 17 00:00:00 2001 From: Sam Saccone Date: Sat, 23 May 2015 15:41:36 -0400 Subject: [PATCH 0086/1293] :lipstick: Fix grammatical issue --- docs/api/synopsis.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/synopsis.md b/docs/api/synopsis.md index 7dcd53363a29..10daf2b68e78 100644 --- a/docs/api/synopsis.md +++ b/docs/api/synopsis.md @@ -1,6 +1,6 @@ # Synopsis -All [node.js's built-in modules](http://nodejs.org/api/) are available in +All of [node.js's built-in modules](http://nodejs.org/api/) are available in Electron, and third-party node modules are fully supported too (including the [native modules](../tutorial/using-native-node-modules.md)). From 0bb4e0e44a9aa64226526637cb770c1446192350 Mon Sep 17 00:00:00 2001 From: Sam Saccone Date: Sat, 23 May 2015 16:00:09 -0400 Subject: [PATCH 0087/1293] :lipstick: Fix grammatical issues --- docs/api/native-image.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/api/native-image.md b/docs/api/native-image.md index 61298cae7e52..13477133f344 100644 --- a/docs/api/native-image.md +++ b/docs/api/native-image.md @@ -3,15 +3,15 @@ In Electron for the APIs that take images, you can pass either file paths or `NativeImage` instances. When passing `null`, an empty image will be used. -For example when creating tray or setting window's icon, you can pass image's -file path as `String` to represent an image: +For example, when creating a tray or setting a window's icon, you can pass an image +file path as a `String`: ```javascript var appIcon = new Tray('/Users/somebody/images/icon.png'); var window = new BrowserWindow({icon: '/Users/somebody/images/window.png'}); ``` -Or read the image from clipboard: +Or read the image from the clipboard: ```javascript var clipboard = require('clipboard'); @@ -21,8 +21,8 @@ var appIcon = new Tray(image); ## Supported formats -Currently `PNG` and `JPEG` are supported, and it is recommended to use `PNG` -because it supports alpha channel and image is usually not compressed. +Currently `PNG` and `JPEG` are supported. It is recommended to use `PNG` +because of its support for transparency and lossless compression. ## High resolution image @@ -31,9 +31,9 @@ file name's base name to mark it as a high resolution image. For example if `icon.png` is a normal image that has standard resolution, the `icon@2x.png` would be treated as a high resolution image that has double DPI -dense. +density. -If you want to support displays with different DPI denses at the same time, you +If you want to support displays with different DPI density at the same time, you can put images with different sizes in the same folder, and use the filename without DPI suffixes, like this: @@ -88,7 +88,7 @@ Creates an empty `NativeImage` instance. * `path` String -Creates a new `NativeImage` instance from file located at `path`. +Creates a new `NativeImage` instance from a file located at `path`. ## nativeImage.createFromBuffer(buffer[, scaleFactor]) From a642782a00ca6bc38fc6db82a1ce17edfa059c25 Mon Sep 17 00:00:00 2001 From: Sam Saccone Date: Sat, 23 May 2015 18:44:58 -0400 Subject: [PATCH 0088/1293] :lipstick: Fix grammatical issues --- docs/api/content-tracing.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/api/content-tracing.md b/docs/api/content-tracing.md index ce66e3ff4ab8..c7575ba8a23f 100644 --- a/docs/api/content-tracing.md +++ b/docs/api/content-tracing.md @@ -2,7 +2,7 @@ The `content-trace` module is used to collect tracing data generated by the underlying Chromium content module. This module does not include a web interface -so you need to open `chrome://tracing/` in Chrome browser and load the generated +so you need to open `chrome://tracing/` in a Chrome browser and load the generated file to view the result. ```javascript @@ -26,7 +26,7 @@ Get a set of category groups. The category groups can change as new code paths are reached. Once all child processes have acked to the `getCategories` request, `callback` -is called back with an array of category groups. +is invoked with an array of category groups. ## tracing.startRecording(categoryFilter, options, callback) @@ -43,7 +43,7 @@ have acked to the `startRecording` request, `callback` will be called back. `categoryFilter` is a filter to control what category groups should be traced. A filter can have an optional `-` prefix to exclude category groups that contain a matching category. Having both included and excluded -category patterns in the same list would not be supported. +category patterns in the same list is not supported. Examples: @@ -107,12 +107,12 @@ Get the current monitoring traced data. Child processes typically are caching trace data and only rarely flush and send trace data back to the main process. That is because it may be an expensive -operation to send the trace data over IPC, and we would like to avoid much +operation to send the trace data over IPC, and we would like to avoid unneeded runtime overhead of tracing. So, to end tracing, we must asynchronously ask all child processes to flush any pending trace data. Once all child processes have acked to the `captureMonitoringSnapshot` request, -`callback` will be called back with a file that contains the traced data. +the `callback` will be invoked with a file that contains the traced data. ## tracing.getTraceBufferUsage(callback) From 2de0b025f1df9ddc541632c75d61e7b7ecbfc5ee Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Sun, 24 May 2015 10:56:25 +0530 Subject: [PATCH 0089/1293] retrieve headers from response info --- atom/browser/api/atom_api_web_contents.cc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index ab58ca0d8cc4..96b767a98817 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -317,7 +317,7 @@ void WebContents::DidGetResourceResponseStart( v8::HandleScope handle_scope(isolate); mate::Dictionary response_headers(isolate, v8::Object::New(isolate)); - net::HttpResponseHeaders* headers = details.headers.get(); + net::HttpResponseHeaders* headers = details.response_info.headers.get(); void* iter = nullptr; std::string key; std::string value; From 291604515f267707016c8cba0f47ab042580322d Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 26 May 2015 12:44:24 +0800 Subject: [PATCH 0090/1293] Update libchromiumcontent for optional pdf.dll --- script/lib/config.py | 2 +- vendor/brightray | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/script/lib/config.py b/script/lib/config.py index 02b99458e46c..7bbce1183e60 100644 --- a/script/lib/config.py +++ b/script/lib/config.py @@ -7,7 +7,7 @@ import sys BASE_URL = 'http://gh-contractor-zcbenz.s3.amazonaws.com/libchromiumcontent' -LIBCHROMIUMCONTENT_COMMIT = '1a1ecefebd8aef44cf0dafe6f4315ecdd367e54c' +LIBCHROMIUMCONTENT_COMMIT = 'fa886209473d40eafda4e8263a79b5cf83eef95e' PLATFORM = { 'cygwin': 'win32', diff --git a/vendor/brightray b/vendor/brightray index 748e5b922456..cd03cb447545 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit 748e5b922456f352a7cc54c0705d0a997f926a18 +Subproject commit cd03cb447545bba0f820a148a3c838c97bb1a375 From 172a5a71fc049f729f1eb37829e856c935665240 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 27 May 2015 14:57:14 +0800 Subject: [PATCH 0091/1293] docs: "move" and "moved" are platform-dependent --- docs/api/browser-window.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 86330bf0f934..5f96beca830c 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -179,10 +179,14 @@ Emitted when window is getting resized. Emitted when the window is getting moved to a new position. +__Note__: On OS X this event is just an alias of `moved`. + ### Event: 'moved' Emitted once when the window is moved to a new position. +__Note__: This event is available only on OS X. + ### Event: 'enter-full-screen' Emitted when window enters full screen state. From 935cd92ef31ffc6fa496ea71b259bf7c796acf26 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 27 May 2015 15:03:12 +0800 Subject: [PATCH 0092/1293] Update brightray --- vendor/brightray | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/brightray b/vendor/brightray index cd03cb447545..8fba2a883552 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit cd03cb447545bba0f820a148a3c838c97bb1a375 +Subproject commit 8fba2a883552ad939a63250b552f467fa4f9bedb From f961f0617fd7719ec2d51794a4e76fc6f3637b1c Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 27 May 2015 15:26:32 +0800 Subject: [PATCH 0093/1293] test: Add case for #634 --- spec/node-spec.coffee | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/spec/node-spec.coffee b/spec/node-spec.coffee index 006565407915..5ec2bb05e906 100644 --- a/spec/node-spec.coffee +++ b/spec/node-spec.coffee @@ -126,3 +126,10 @@ describe 'node feature', -> b = new Buffer(p.innerText) assert.equal b.toString(), '闲云潭影日悠悠，物换星移几度秋' assert.equal Buffer.byteLength(p.innerText), 45 + + it 'correctly parses external one-byte UTF8 string', -> + p = document.createElement 'p' + p.innerText = 'Jøhänñéß' + b = new Buffer(p.innerText) + assert.equal b.toString(), 'Jøhänñéß' + assert.equal Buffer.byteLength(p.innerText), 13 From fbdea15649cd132088e9ff3692109d49f43c9f4b Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 27 May 2015 15:26:48 +0800 Subject: [PATCH 0094/1293] Update node, fix #634 --- vendor/node | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/node b/vendor/node index e5aaa1ad33b3..b772c19a8f9d 160000 --- a/vendor/node +++ b/vendor/node @@ -1 +1 @@ -Subproject commit e5aaa1ad33b3479dbb29df797beca5873e7490dc +Subproject commit b772c19a8f9db65673184822fb294235eff9c364 From 5584e3fd498874d0cb4262832f3f990974a4c00b Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Fri, 22 May 2015 14:59:11 +0530 Subject: [PATCH 0095/1293] clipboard: api to list supported types, reading and writing markup --- atom/common/api/atom_api_clipboard.cc | 30 +++++++++++++++++++++++---- atom/common/api/lib/clipboard.coffee | 4 +++- docs/api/clipboard.md | 22 +++++++++++++------- spec/api-clipboard-spec.coffee | 12 +++++++++++ 4 files changed, 56 insertions(+), 12 deletions(-) diff --git a/atom/common/api/atom_api_clipboard.cc b/atom/common/api/atom_api_clipboard.cc index e6119864cb61..0b804eb8a404 100644 --- a/atom/common/api/atom_api_clipboard.cc +++ b/atom/common/api/atom_api_clipboard.cc @@ -37,10 +37,12 @@ struct Converter { namespace { -bool Has(const std::string& format_string, ui::ClipboardType type) { +std::vector AvailableFormats(ui::ClipboardType type) { + std::vector format_types; + bool ignore; ui::Clipboard* clipboard = ui::Clipboard::GetForCurrentThread(); - ui::Clipboard::FormatType format(ui::Clipboard::GetFormatType(format_string)); - return clipboard->IsFormatAvailable(format, type); + clipboard->ReadAvailableTypes(type, &format_types, &ignore); + return format_types; } std::string Read(const std::string& format_string, @@ -64,6 +66,24 @@ void WriteText(const base::string16& text, ui::ClipboardType type) { writer.WriteText(text); } +base::string16 ReadHtml(ui::ClipboardType type) { + base::string16 data; + base::string16 html; + std::string url; + uint32 start; + uint32 end; + ui::Clipboard::GetForCurrentThread()->ReadHTML(type, &html, &url, + &start, &end); + data = html.substr(start, end - start); + return data; +} + +void WriteHtml(const base::string16& html, + ui::ClipboardType type) { + ui::ScopedClipboardWriter writer(type); + writer.WriteHTML(html, std::string()); +} + gfx::Image ReadImage(ui::ClipboardType type) { SkBitmap bitmap = ui::Clipboard::GetForCurrentThread()->ReadImage(type); return gfx::Image::CreateFrom1xBitmap(bitmap); @@ -81,10 +101,12 @@ void Clear(ui::ClipboardType type) { void Initialize(v8::Local exports, v8::Local unused, v8::Local context, void* priv) { mate::Dictionary dict(context->GetIsolate(), exports); - dict.SetMethod("_has", &Has); + dict.SetMethod("_availableFormats", &AvailableFormats); dict.SetMethod("_read", &Read); dict.SetMethod("_readText", &ReadText); dict.SetMethod("_writeText", &WriteText); + dict.SetMethod("_readHtml", &ReadHtml); + dict.SetMethod("_writeHtml", &WriteHtml); dict.SetMethod("_readImage", &ReadImage); dict.SetMethod("_writeImage", &WriteImage); dict.SetMethod("_clear", &Clear); diff --git a/atom/common/api/lib/clipboard.coffee b/atom/common/api/lib/clipboard.coffee index 582feba4b1ef..70e2e86fc982 100644 --- a/atom/common/api/lib/clipboard.coffee +++ b/atom/common/api/lib/clipboard.coffee @@ -1,9 +1,11 @@ binding = process.atomBinding 'clipboard' module.exports = - has: (format, type='standard') -> binding._has format, type + availableFormats: (type='standard') -> binding._availableFormats type read: (format, type='standard') -> binding._read format, type readText: (type='standard') -> binding._readText type writeText: (text, type='standard') -> binding._writeText text, type + readHtml: (type='standard') -> binding._readHtml type + writeHtml: (markup, type='standard') -> binding._writeHtml markup, type readImage: (type='standard') -> binding._readImage type writeImage: (image, type='standard') -> binding._writeImage image, type clear: (type='standard') -> binding._clear type diff --git a/docs/api/clipboard.md b/docs/api/clipboard.md index c0f830491c1b..92264075a706 100644 --- a/docs/api/clipboard.md +++ b/docs/api/clipboard.md @@ -30,6 +30,19 @@ Returns the content in clipboard as plain text. Writes the `text` into clipboard as plain text. +## clipboard.readHtml([type]) + +* `type` String + +Returns the content in clipboard as markup. + +## clipboard.writeHtml(markup[, type]) + +* `markup` String +* `type` String + +Writes the `markup` into clipboard. + ## clipboard.readImage([type]) * `type` String @@ -49,14 +62,9 @@ Writes the `image` into clipboard. Clears everything in clipboard. -## clipboard.has(format[, type]) +## clipboard.availableFormats([type]) -* `format` String -* `type` String - -Returns whether clipboard has data in specified `format`. - -**Note:** This API is experimental and could be removed in future. +Returns an array of supported `format` for the clipboard `type`. ## clipboard.read(format[, type]) diff --git a/spec/api-clipboard-spec.coffee b/spec/api-clipboard-spec.coffee index feadd15b0a6f..429fcbc2d0ad 100644 --- a/spec/api-clipboard-spec.coffee +++ b/spec/api-clipboard-spec.coffee @@ -18,3 +18,15 @@ describe 'clipboard module', -> text = '千江有水千江月，万里无云万里天' clipboard.writeText text assert.equal clipboard.readText(), text + + describe 'clipboard.readHtml()', -> + it 'returns markup correctly', -> + text = 'Hi' + markup = + if process.platform is 'darwin' + 'Hi' + else + 'Hi' + clipboard.writeHtml text + assert.equal clipboard.readHtml(), markup From 4d56281972797964f74cf75fb42cbcd04ba449c0 Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Wed, 27 May 2015 13:35:51 +0530 Subject: [PATCH 0096/1293] restore clipboard.has api and fix docs --- atom/common/api/atom_api_clipboard.cc | 7 +++++++ atom/common/api/lib/clipboard.coffee | 1 + docs/api/clipboard.md | 20 +++++++++++++++++--- 3 files changed, 25 insertions(+), 3 deletions(-) diff --git a/atom/common/api/atom_api_clipboard.cc b/atom/common/api/atom_api_clipboard.cc index 0b804eb8a404..da624a0a1ad3 100644 --- a/atom/common/api/atom_api_clipboard.cc +++ b/atom/common/api/atom_api_clipboard.cc @@ -45,6 +45,12 @@ std::vector AvailableFormats(ui::ClipboardType type) { return format_types; } +bool Has(const std::string& format_string, ui::ClipboardType type) { + ui::Clipboard* clipboard = ui::Clipboard::GetForCurrentThread(); + ui::Clipboard::FormatType format(ui::Clipboard::GetFormatType(format_string)); + return clipboard->IsFormatAvailable(format, type); +} + std::string Read(const std::string& format_string, ui::ClipboardType type) { ui::Clipboard* clipboard = ui::Clipboard::GetForCurrentThread(); @@ -102,6 +108,7 @@ void Initialize(v8::Local exports, v8::Local unused, v8::Local context, void* priv) { mate::Dictionary dict(context->GetIsolate(), exports); dict.SetMethod("_availableFormats", &AvailableFormats); + dict.SetMethod("_has", &Has); dict.SetMethod("_read", &Read); dict.SetMethod("_readText", &ReadText); dict.SetMethod("_writeText", &WriteText); diff --git a/atom/common/api/lib/clipboard.coffee b/atom/common/api/lib/clipboard.coffee index 70e2e86fc982..44dadb8cd9ee 100644 --- a/atom/common/api/lib/clipboard.coffee +++ b/atom/common/api/lib/clipboard.coffee @@ -1,6 +1,7 @@ binding = process.atomBinding 'clipboard' module.exports = availableFormats: (type='standard') -> binding._availableFormats type + has: (format, type='standard') -> binding._has format, type read: (format, type='standard') -> binding._read format, type readText: (type='standard') -> binding._readText type writeText: (text, type='standard') -> binding._writeText text, type diff --git a/docs/api/clipboard.md b/docs/api/clipboard.md index 92264075a706..b9ca8b3a9b90 100644 --- a/docs/api/clipboard.md +++ b/docs/api/clipboard.md @@ -66,11 +66,25 @@ Clears everything in clipboard. Returns an array of supported `format` for the clipboard `type`. -## clipboard.read(format[, type]) +## clipboard.has(data[, type]) -* `format` String +* `data` String * `type` String -Reads the data in clipboard of the `format`. +Returns whether clipboard supports the format of specified `data`. + +```javascript +var clipboard = require('clipboard'); +console.log(clipboard.has('

selection

')); +``` + +**Note:** This API is experimental and could be removed in future. + +## clipboard.read(data[, type]) + +* `data` String +* `type` String + +Reads the `data` in clipboard. **Note:** This API is experimental and could be removed in future. From 6ee8f6e4f2b66e3ded52390538cb8ef039359c4b Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 27 May 2015 16:57:41 +0800 Subject: [PATCH 0097/1293] Bump v0.27.0 --- atom.gyp | 2 +- atom/browser/resources/mac/Info.plist | 2 +- atom/browser/resources/win/atom.rc | 8 ++++---- atom/common/atom_version.h | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/atom.gyp b/atom.gyp index b514e8d9d247..51b5de01e59b 100644 --- a/atom.gyp +++ b/atom.gyp @@ -4,7 +4,7 @@ 'product_name%': 'Electron', 'company_name%': 'GitHub, Inc', 'company_abbr%': 'github', - 'version%': '0.26.1', + 'version%': '0.27.0', 'atom_source_root': 'CFBundleIconFile atom.icns CFBundleVersion - 0.26.1 + 0.27.0 LSMinimumSystemVersion 10.8.0 NSMainNibFile diff --git a/atom/browser/resources/win/atom.rc b/atom/browser/resources/win/atom.rc index 5bc9521a3da1..d81ccccda74c 100644 --- a/atom/browser/resources/win/atom.rc +++ b/atom/browser/resources/win/atom.rc @@ -50,8 +50,8 @@ END // VS_VERSION_INFO VERSIONINFO - FILEVERSION 0,26,1,0 - PRODUCTVERSION 0,26,1,0 + FILEVERSION 0,27,0,0 + PRODUCTVERSION 0,27,0,0 FILEFLAGSMASK 0x3fL #ifdef _DEBUG FILEFLAGS 0x1L @@ -68,12 +68,12 @@ BEGIN BEGIN VALUE "CompanyName", "GitHub, Inc." VALUE "FileDescription", "Electron" - VALUE "FileVersion", "0.26.1" + VALUE "FileVersion", "0.27.0" VALUE "InternalName", "electron.exe" VALUE "LegalCopyright", "Copyright (C) 2015 GitHub, Inc. All rights reserved." VALUE "OriginalFilename", "electron.exe" VALUE "ProductName", "Electron" - VALUE "ProductVersion", "0.26.1" + VALUE "ProductVersion", "0.27.0" VALUE "SquirrelAwareVersion", "1" END END diff --git a/atom/common/atom_version.h b/atom/common/atom_version.h index b9c3d4a3bec8..ec08ccfa3290 100644 --- a/atom/common/atom_version.h +++ b/atom/common/atom_version.h @@ -6,8 +6,8 @@ #define ATOM_VERSION_H #define ATOM_MAJOR_VERSION 0 -#define ATOM_MINOR_VERSION 26 -#define ATOM_PATCH_VERSION 1 +#define ATOM_MINOR_VERSION 27 +#define ATOM_PATCH_VERSION 0 #define ATOM_VERSION_IS_RELEASE 1 From 9b7ad675c6d0cc70b38004822c1b0d8e3c956d9e Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Wed, 27 May 2015 16:39:02 +0530 Subject: [PATCH 0098/1293] browserClient: dont restart render process for javascript: scheme --- atom/browser/atom_browser_client.cc | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/atom/browser/atom_browser_client.cc b/atom/browser/atom_browser_client.cc index 733ec2bbb962..763a2b4b0952 100644 --- a/atom/browser/atom_browser_client.cc +++ b/atom/browser/atom_browser_client.cc @@ -147,8 +147,11 @@ void AtomBrowserClient::OverrideSiteInstanceForNavigation( if (current_instance->HasProcess()) dying_render_process_ = current_instance->GetProcess(); - // Restart renderer process for all navigations. - *new_instance = content::SiteInstance::CreateForURL(browser_context, url); + + if (!url.SchemeIs(url::kJavaScriptScheme)) { + // Restart renderer process for all navigations except javacript: scheme. + *new_instance = content::SiteInstance::CreateForURL(browser_context, url); + } } void AtomBrowserClient::AppendExtraCommandLineSwitches( From 014d80c359beabeb4bdd25479e9ab9bd453a3cc3 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Wed, 27 May 2015 12:51:19 -0700 Subject: [PATCH 0099/1293] Replace cmd with bash MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Markdown parser doesn’t recognize cmd. --- docs/tutorial/application-distribution.md | 2 +- docs/tutorial/quick-start.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/tutorial/application-distribution.md b/docs/tutorial/application-distribution.md index bb969ef3f85b..5c76f14d504a 100644 --- a/docs/tutorial/application-distribution.md +++ b/docs/tutorial/application-distribution.md @@ -111,7 +111,7 @@ environment variable and have a clean rebuild: __Windows__ -```cmd +```bash > set "GYP_DEFINES=project_name=myapp product_name=MyApp" > python script\clean.py > python script\bootstrap.py diff --git a/docs/tutorial/quick-start.md b/docs/tutorial/quick-start.md index fbdad5b4ec4c..073d2ee40c95 100644 --- a/docs/tutorial/quick-start.md +++ b/docs/tutorial/quick-start.md @@ -133,7 +133,7 @@ Electron binary to execute your app directly. On Windows: -```cmd +```bash $ .\electron\electron.exe your-app\ ``` From f98da217e130cce7e1de8caa1f8dc4f2125aaae5 Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Thu, 28 May 2015 11:10:25 +0530 Subject: [PATCH 0100/1293] fix accessing headers from resourcerequestdetails --- atom/browser/api/atom_api_web_contents.cc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 3a0dfbb5552c..1358d41822db 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -317,7 +317,7 @@ void WebContents::DidGetResourceResponseStart( v8::HandleScope handle_scope(isolate); mate::Dictionary response_headers(isolate, v8::Object::New(isolate)); - net::HttpResponseHeaders* headers = details.response_info.headers.get(); + net::HttpResponseHeaders* headers = details.headers.get(); void* iter = nullptr; std::string key; std::string value; From 8a6ba7c49ff5a897d736dd20923d12d7ac327973 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 28 May 2015 10:52:51 +0800 Subject: [PATCH 0101/1293] Update libchromiumcontent for race condition fix --- script/lib/config.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/script/lib/config.py b/script/lib/config.py index 7bbce1183e60..fd9773b5a31c 100644 --- a/script/lib/config.py +++ b/script/lib/config.py @@ -7,7 +7,7 @@ import sys BASE_URL = 'http://gh-contractor-zcbenz.s3.amazonaws.com/libchromiumcontent' -LIBCHROMIUMCONTENT_COMMIT = 'fa886209473d40eafda4e8263a79b5cf83eef95e' +LIBCHROMIUMCONTENT_COMMIT = '5ccddd5f3968a7f63eaa888e6a8ba319ea8cd3b7' PLATFORM = { 'cygwin': 'win32', From ebbb974aca1771d4b519bba354239c2005683e03 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 28 May 2015 13:45:16 +0800 Subject: [PATCH 0102/1293] Fix running spec on Windows --- spec/api-browser-window-spec.coffee | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/spec/api-browser-window-spec.coffee b/spec/api-browser-window-spec.coffee index fb5c26abc457..ea3e06c9d406 100644 --- a/spec/api-browser-window-spec.coffee +++ b/spec/api-browser-window-spec.coffee @@ -91,8 +91,8 @@ describe 'browser-window module', -> describe 'BrowserWindow.setSize(width, height)', -> it 'sets the window size', (done) -> - size = [20, 400] - w.on 'resize', -> + size = [300, 400] + w.once 'resize', -> newSize = w.getSize() assert.equal newSize[0], size[0] assert.equal newSize[1], size[1] @@ -102,7 +102,7 @@ describe 'browser-window module', -> describe 'BrowserWindow.setPosition(x, y)', -> it 'sets the window position', (done) -> pos = [10, 10] - w.on 'move', -> + w.once 'move', -> newPos = w.getPosition() assert.equal newPos[0], pos[0] assert.equal newPos[1], pos[1] From 419a14a63f6fa1d466e98a8f0b2886c3512631da Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 28 May 2015 15:19:44 +0800 Subject: [PATCH 0103/1293] Use gcc-4.8 on CI machine --- script/cibuild | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/script/cibuild b/script/cibuild index 707735814874..b5798a94df58 100755 --- a/script/cibuild +++ b/script/cibuild @@ -15,6 +15,8 @@ LINUX_DEPS = [ 'libgnome-keyring-dev', 'libgtk2.0-dev', 'libnotify-dev', + 'gcc-4.8', + 'g++-4.8', 'gcc-multilib', 'g++-multilib', ] @@ -26,6 +28,7 @@ def main(): is_travis = (os.getenv('TRAVIS') == 'true') if is_travis and sys.platform == 'linux2': print 'Setup travis CI' + execute(['sudo', 'add-apt-repository', '-y', 'ppa:ubuntu-toolchain-r/test']) execute(['sudo', 'apt-get', 'update']) execute(['sudo', 'apt-get', 'install'] + LINUX_DEPS) @@ -41,8 +44,8 @@ def main(): 'libchromiumcontent')) if is_travis and sys.platform == 'linux2': - with scoped_env('CXX', 'g++'): - with scoped_env('CC', 'gcc'): + with scoped_env('CXX', 'g++-4.8'): + with scoped_env('CC', 'gcc-4.8'): run_script('bootstrap.py', ['--dev']) run_script('update.py') else: From 3e720bd611507cf44a72ba319deb7ca468e8122d Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 28 May 2015 16:23:29 +0800 Subject: [PATCH 0104/1293] Bump v0.27.1 --- atom.gyp | 2 +- atom/browser/resources/mac/Info.plist | 2 +- atom/browser/resources/win/atom.rc | 8 ++++---- atom/common/atom_version.h | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/atom.gyp b/atom.gyp index 51b5de01e59b..efc51f209679 100644 --- a/atom.gyp +++ b/atom.gyp @@ -4,7 +4,7 @@ 'product_name%': 'Electron', 'company_name%': 'GitHub, Inc', 'company_abbr%': 'github', - 'version%': '0.27.0', + 'version%': '0.27.1', 'atom_source_root': 'CFBundleIconFile atom.icns CFBundleVersion - 0.27.0 + 0.27.1 LSMinimumSystemVersion 10.8.0 NSMainNibFile diff --git a/atom/browser/resources/win/atom.rc b/atom/browser/resources/win/atom.rc index d81ccccda74c..7960f463aa8f 100644 --- a/atom/browser/resources/win/atom.rc +++ b/atom/browser/resources/win/atom.rc @@ -50,8 +50,8 @@ END // VS_VERSION_INFO VERSIONINFO - FILEVERSION 0,27,0,0 - PRODUCTVERSION 0,27,0,0 + FILEVERSION 0,27,1,0 + PRODUCTVERSION 0,27,1,0 FILEFLAGSMASK 0x3fL #ifdef _DEBUG FILEFLAGS 0x1L @@ -68,12 +68,12 @@ BEGIN BEGIN VALUE "CompanyName", "GitHub, Inc." VALUE "FileDescription", "Electron" - VALUE "FileVersion", "0.27.0" + VALUE "FileVersion", "0.27.1" VALUE "InternalName", "electron.exe" VALUE "LegalCopyright", "Copyright (C) 2015 GitHub, Inc. All rights reserved." VALUE "OriginalFilename", "electron.exe" VALUE "ProductName", "Electron" - VALUE "ProductVersion", "0.27.0" + VALUE "ProductVersion", "0.27.1" VALUE "SquirrelAwareVersion", "1" END END diff --git a/atom/common/atom_version.h b/atom/common/atom_version.h index ec08ccfa3290..e5ebb55616cd 100644 --- a/atom/common/atom_version.h +++ b/atom/common/atom_version.h @@ -7,7 +7,7 @@ #define ATOM_MAJOR_VERSION 0 #define ATOM_MINOR_VERSION 27 -#define ATOM_PATCH_VERSION 0 +#define ATOM_PATCH_VERSION 1 #define ATOM_VERSION_IS_RELEASE 1 From bdf73fcd4c6f60e347fe475cc9354629b8b3f21d Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 29 May 2015 11:12:55 +0800 Subject: [PATCH 0105/1293] Update to the new algorithm of setting webview size --- atom/browser/api/atom_api_web_contents.cc | 102 ++++++++++++++---- atom/browser/api/atom_api_web_contents.h | 37 ++++++- atom/browser/lib/guest-view-manager.coffee | 6 +- .../lib/web-view/guest-view-internal.coffee | 4 +- .../lib/web-view/web-view-attributes.coffee | 2 +- atom/renderer/lib/web-view/web-view.coffee | 3 + 6 files changed, 126 insertions(+), 28 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 1358d41822db..f82a65818a6a 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -44,12 +44,40 @@ #include "atom/common/node_includes.h" +namespace mate { + +template<> +struct Converter { + static bool FromV8(v8::Isolate* isolate, + v8::Local val, + atom::api::SetSizeParams* out) { + mate::Dictionary params; + if (!ConvertFromV8(isolate, val, ¶ms)) + return false; + bool autosize; + if (params.Get("enableAutoSize", &autosize)) + out->enable_auto_size.reset(new bool(true)); + gfx::Size size; + if (params.Get("min", &size)) + out->min_size.reset(new gfx::Size(size)); + if (params.Get("max", &size)) + out->max_size.reset(new gfx::Size(size)); + return true; + } +}; + +} // namespace mate + + namespace atom { namespace api { namespace { +const int kDefaultWidth = 300; +const int kDefaultHeight = 300; + v8::Persistent template_; // Get the window that has the |guest| embedded. @@ -85,7 +113,8 @@ WebContents::WebContents(content::WebContents* web_contents) element_instance_id_(-1), guest_opaque_(true), guest_host_(nullptr), - auto_size_enabled_(false) { + auto_size_enabled_(false), + is_full_page_plugin_(false) { } WebContents::WebContents(const mate::Dictionary& options) @@ -93,7 +122,8 @@ WebContents::WebContents(const mate::Dictionary& options) element_instance_id_(-1), guest_opaque_(true), guest_host_(nullptr), - auto_size_enabled_(false) { + auto_size_enabled_(false), + is_full_page_plugin_(false) { options.Get("guestInstanceId", &guest_instance_id_); auto browser_context = AtomBrowserContext::Get(); @@ -612,31 +642,57 @@ bool WebContents::SendIPCMessage(const base::string16& channel, return Send(new AtomViewMsg_Message(routing_id(), channel, args)); } -void WebContents::SetAutoSize(bool enabled, - const gfx::Size& min_size, - const gfx::Size& max_size) { +void WebContents::SetSize(const SetSizeParams& params) { + bool enable_auto_size = + params.enable_auto_size ? *params.enable_auto_size : auto_size_enabled_; + gfx::Size min_size = params.min_size ? *params.min_size : min_auto_size_; + gfx::Size max_size = params.max_size ? *params.max_size : max_auto_size_; + + if (params.normal_size) + normal_size_ = *params.normal_size; + min_auto_size_ = min_size; min_auto_size_.SetToMin(max_size); max_auto_size_ = max_size; max_auto_size_.SetToMax(min_size); - enabled &= !min_auto_size_.IsEmpty() && !max_auto_size_.IsEmpty(); - if (!enabled && !auto_size_enabled_) - return; - - auto_size_enabled_ = enabled; - - if (!attached()) - return; + enable_auto_size &= !min_auto_size_.IsEmpty() && !max_auto_size_.IsEmpty(); content::RenderViewHost* rvh = web_contents()->GetRenderViewHost(); - if (auto_size_enabled_) { + if (enable_auto_size) { + // Autosize is being enabled. rvh->EnableAutoResize(min_auto_size_, max_auto_size_); + normal_size_.SetSize(0, 0); } else { - rvh->DisableAutoResize(element_size_); - guest_size_ = element_size_; - GuestSizeChangedDueToAutoSize(guest_size_, element_size_); + // Autosize is being disabled. + // Use default width/height if missing from partially defined normal size. + if (normal_size_.width() && !normal_size_.height()) + normal_size_.set_height(GetDefaultSize().height()); + if (!normal_size_.width() && normal_size_.height()) + normal_size_.set_width(GetDefaultSize().width()); + + gfx::Size new_size; + if (!normal_size_.IsEmpty()) { + new_size = normal_size_; + } else if (!guest_size_.IsEmpty()) { + new_size = guest_size_; + } else { + new_size = GetDefaultSize(); + } + + if (auto_size_enabled_) { + // Autosize was previously enabled. + rvh->DisableAutoResize(new_size); + GuestSizeChangedDueToAutoSize(guest_size_, new_size); + } else { + // Autosize was already disabled. + guest_host_->SizeContents(new_size); + } + + guest_size_ = new_size; } + + auto_size_enabled_ = enable_auto_size; } void WebContents::SetAllowTransparency(bool allow) { @@ -727,7 +783,7 @@ mate::ObjectTemplateBuilder WebContents::GetObjectTemplateBuilder( .SetMethod("replace", &WebContents::Replace) .SetMethod("replaceMisspelling", &WebContents::ReplaceMisspelling) .SetMethod("_send", &WebContents::SendIPCMessage) - .SetMethod("setAutoSize", &WebContents::SetAutoSize) + .SetMethod("setSize", &WebContents::SetSize) .SetMethod("setAllowTransparency", &WebContents::SetAllowTransparency) .SetMethod("isGuest", &WebContents::is_guest) .SetMethod("hasServiceWorker", &WebContents::HasServiceWorker) @@ -760,6 +816,16 @@ void WebContents::GuestSizeChangedDueToAutoSize(const gfx::Size& old_size, new_size.width(), new_size.height()); } +gfx::Size WebContents::GetDefaultSize() const { + if (is_full_page_plugin_) { + // Full page plugins default to the size of the owner's viewport. + return embedder_web_contents_->GetRenderWidgetHostView() + ->GetVisibleViewportSize(); + } else { + return gfx::Size(kDefaultWidth, kDefaultHeight); + } +} + // static mate::Handle WebContents::CreateFrom( v8::Isolate* isolate, content::WebContents* web_contents) { diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index c7a8bbbfc04f..63248fd02a21 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -33,6 +33,22 @@ class WebDialogHelper; namespace api { +// A struct of parameters for SetSize(). The parameters are all declared as +// scoped pointers since they are all optional. Null pointers indicate that the +// parameter has not been provided, and the last used value should be used. Note +// that when |enable_auto_size| is true, providing |normal_size| is not +// meaningful. This is because the normal size of the guestview is overridden +// whenever autosizing occurs. +struct SetSizeParams { + SetSizeParams() {} + ~SetSizeParams() {} + + scoped_ptr enable_auto_size; + scoped_ptr min_size; + scoped_ptr max_size; + scoped_ptr normal_size; +}; + class WebContents : public mate::EventEmitter, public content::BrowserPluginGuestDelegate, public content::WebContentsDelegate, @@ -89,10 +105,9 @@ class WebContents : public mate::EventEmitter, bool SendIPCMessage(const base::string16& channel, const base::ListValue& args); - // Toggles autosize mode for corresponding . - void SetAutoSize(bool enabled, - const gfx::Size& min_size, - const gfx::Size& max_size); + // Used to toggle autosize mode for this GuestView, and set both the automatic + // and normal sizes. + void SetSize(const SetSizeParams& params); // Sets the transparency of the guest. void SetAllowTransparency(bool allow); @@ -217,9 +232,17 @@ class WebContents : public mate::EventEmitter, const base::ListValue& args, IPC::Message* message); + // This method is invoked when the contents auto-resized to give the container + // an opportunity to match it if it wishes. + // + // This gives the derived class an opportunity to inform its container element + // or perform other actions. void GuestSizeChangedDueToAutoSize(const gfx::Size& old_size, const gfx::Size& new_size); + // Returns the default size of the guestview. + gfx::Size GetDefaultSize() const; + scoped_ptr web_dialog_helper_; scoped_ptr dialog_manager_; @@ -258,6 +281,12 @@ class WebContents : public mate::EventEmitter, // The minimum size constraints of the container element in autosize mode. gfx::Size min_auto_size_; + // The size that will be used when autosize mode is disabled. + gfx::Size normal_size_; + + // Whether the guest view is inside a plugin document. + bool is_full_page_plugin_; + DISALLOW_COPY_AND_ASSIGN(WebContents); }; diff --git a/atom/browser/lib/guest-view-manager.coffee b/atom/browser/lib/guest-view-manager.coffee index f0d2a89318d6..e59bdb42c009 100644 --- a/atom/browser/lib/guest-view-manager.coffee +++ b/atom/browser/lib/guest-view-manager.coffee @@ -60,7 +60,7 @@ createGuest = (embedder, params) -> @viewInstanceId = params.instanceId min = width: params.minwidth, height: params.minheight max = width: params.maxwidth, height: params.maxheight - @setAutoSize params.autosize, min, max + @setSize params.autosize, min, max if params.src opts = {} @@ -132,8 +132,8 @@ ipc.on 'ATOM_SHELL_GUEST_VIEW_MANAGER_ATTACH_GUEST', (event, elementInstanceId, ipc.on 'ATOM_SHELL_GUEST_VIEW_MANAGER_DESTROY_GUEST', (event, id) -> destroyGuest event.sender, id -ipc.on 'ATOM_SHELL_GUEST_VIEW_MANAGER_SET_AUTO_SIZE', (event, id, params) -> - guestInstances[id]?.guest.setAutoSize params.enableAutoSize, params.min, params.max +ipc.on 'ATOM_SHELL_GUEST_VIEW_MANAGER_SET_SIZE', (event, id, params) -> + guestInstances[id]?.guest.setSize params ipc.on 'ATOM_SHELL_GUEST_VIEW_MANAGER_SET_ALLOW_TRANSPARENCY', (event, id, allowtransparency) -> guestInstances[id]?.guest.setAllowTransparency allowtransparency diff --git a/atom/renderer/lib/web-view/guest-view-internal.coffee b/atom/renderer/lib/web-view/guest-view-internal.coffee index 4d5f599b3527..2abc47edffe6 100644 --- a/atom/renderer/lib/web-view/guest-view-internal.coffee +++ b/atom/renderer/lib/web-view/guest-view-internal.coffee @@ -67,8 +67,8 @@ module.exports = destroyGuest: (guestInstanceId) -> ipc.send 'ATOM_SHELL_GUEST_VIEW_MANAGER_DESTROY_GUEST', guestInstanceId - setAutoSize: (guestInstanceId, params) -> - ipc.send 'ATOM_SHELL_GUEST_VIEW_MANAGER_SET_AUTO_SIZE', guestInstanceId, params + setSize: (guestInstanceId, params) -> + ipc.send 'ATOM_SHELL_GUEST_VIEW_MANAGER_SET_SIZE', guestInstanceId, params setAllowTransparency: (guestInstanceId, allowtransparency) -> ipc.send 'ATOM_SHELL_GUEST_VIEW_MANAGER_SET_ALLOW_TRANSPARENCY', guestInstanceId, allowtransparency diff --git a/atom/renderer/lib/web-view/web-view-attributes.coffee b/atom/renderer/lib/web-view/web-view-attributes.coffee index 51dd2475a4e0..d2ea629f50d7 100644 --- a/atom/renderer/lib/web-view/web-view-attributes.coffee +++ b/atom/renderer/lib/web-view/web-view-attributes.coffee @@ -72,7 +72,7 @@ class AutosizeDimensionAttribute extends WebViewAttribute handleMutation: (oldValue, newValue) -> return unless @webViewImpl.guestInstanceId - guestViewInternal.setAutoSize @webViewImpl.guestInstanceId, + guestViewInternal.setSize @webViewImpl.guestInstanceId, enableAutoSize: @webViewImpl.attributes[webViewConstants.ATTRIBUTE_AUTOSIZE].getValue() min: width: parseInt @webViewImpl.attributes[webViewConstants.ATTRIBUTE_MINWIDTH].getValue() || 0 diff --git a/atom/renderer/lib/web-view/web-view.coffee b/atom/renderer/lib/web-view/web-view.coffee index a4edc58a10f2..94cd897d6a34 100644 --- a/atom/renderer/lib/web-view/web-view.coffee +++ b/atom/renderer/lib/web-view/web-view.coffee @@ -107,6 +107,9 @@ class WebViewImpl minWidth = @attributes[webViewConstants.ATTRIBUTE_MINWIDTH].getValue() | width minHeight = @attributes[webViewConstants.ATTRIBUTE_MINHEIGHT].getValue() | width + minWidth = Math.min minWidth, maxWidth + minHeight = Math.min minHeight, maxHeight + if not @attributes[webViewConstants.ATTRIBUTE_AUTOSIZE].getValue() or (newWidth >= minWidth and newWidth <= maxWidth and From b45ed8d9a202f007474da7e205920a3e76e9986d Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 29 May 2015 11:20:28 +0800 Subject: [PATCH 0106/1293] pendingGuestCreation is removed --- atom/renderer/lib/web-view/web-view.coffee | 7 ------- 1 file changed, 7 deletions(-) diff --git a/atom/renderer/lib/web-view/web-view.coffee b/atom/renderer/lib/web-view/web-view.coffee index 94cd897d6a34..6a8e3cf05e58 100644 --- a/atom/renderer/lib/web-view/web-view.coffee +++ b/atom/renderer/lib/web-view/web-view.coffee @@ -13,7 +13,6 @@ class WebViewImpl constructor: (@webviewNode) -> v8Util.setHiddenValue @webviewNode, 'internal', this @attached = false - @pendingGuestCreation = false @elementAttached = false @beforeFirstNavigation = true @@ -122,16 +121,10 @@ class WebViewImpl @dispatchEvent webViewEvent createGuest: -> - return if @pendingGuestCreation params = storagePartitionId: @attributes[webViewConstants.ATTRIBUTE_PARTITION].getValue() guestViewInternal.createGuest 'webview', params, (guestInstanceId) => - @pendingGuestCreation = false - unless @elementAttached - guestViewInternal.destroyGuest guestInstanceId - return @attachWindow guestInstanceId - @pendingGuestCreation = true dispatchEvent: (webViewEvent) -> @webviewNode.dispatchEvent webViewEvent From e4bb456964ce5c622cd539fb3824dccdea4af329 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 29 May 2015 11:44:49 +0800 Subject: [PATCH 0107/1293] Pass element size when attaching --- atom/browser/api/atom_api_web_contents.cc | 3 +++ atom/browser/lib/guest-view-manager.coffee | 12 +++++----- .../lib/web-view/guest-view-internal.coffee | 4 ++-- atom/renderer/lib/web-view/web-view.coffee | 22 ++++++++++++------- 4 files changed, 26 insertions(+), 15 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index f82a65818a6a..639b875fa975 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -62,6 +62,8 @@ struct Converter { out->min_size.reset(new gfx::Size(size)); if (params.Get("max", &size)) out->max_size.reset(new gfx::Size(size)); + if (params.Get("elementSize", &size)) + out->normal_size.reset(new gfx::Size(size)); return true; } }; @@ -476,6 +478,7 @@ void WebContents::WillAttach(content::WebContents* embedder_web_contents, bool is_full_page_plugin) { embedder_web_contents_ = embedder_web_contents; element_instance_id_ = element_instance_id; + is_full_page_plugin_ = is_full_page_plugin; } void WebContents::Destroy() { diff --git a/atom/browser/lib/guest-view-manager.coffee b/atom/browser/lib/guest-view-manager.coffee index e59bdb42c009..ab8aa8a4ad98 100644 --- a/atom/browser/lib/guest-view-manager.coffee +++ b/atom/browser/lib/guest-view-manager.coffee @@ -41,7 +41,6 @@ createGuest = (embedder, params) -> guest = webContents.create isGuest: true guestInstanceId: id - storagePartitionId: params.storagePartitionId guestInstances[id] = {guest, embedder} # Destroy guest when the embedder is gone or navigated. @@ -58,9 +57,12 @@ createGuest = (embedder, params) -> delete @attachParams @viewInstanceId = params.instanceId - min = width: params.minwidth, height: params.minheight - max = width: params.maxwidth, height: params.maxheight - @setSize params.autosize, min, max + @setSize + enableAutoSize: params.autosize + min: + width: params.minwidth, height: params.minheight + max: + width: params.maxwidth, height: params.maxheight if params.src opts = {} @@ -123,7 +125,7 @@ destroyGuest = (embedder, id) -> delete reverseEmbedderElementsMap[id] delete embedderElementsMap[key] -ipc.on 'ATOM_SHELL_GUEST_VIEW_MANAGER_CREATE_GUEST', (event, type, params, requestId) -> +ipc.on 'ATOM_SHELL_GUEST_VIEW_MANAGER_CREATE_GUEST', (event, params, requestId) -> event.sender.send "ATOM_SHELL_RESPONSE_#{requestId}", createGuest(event.sender, params) ipc.on 'ATOM_SHELL_GUEST_VIEW_MANAGER_ATTACH_GUEST', (event, elementInstanceId, guestInstanceId, params) -> diff --git a/atom/renderer/lib/web-view/guest-view-internal.coffee b/atom/renderer/lib/web-view/guest-view-internal.coffee index 2abc47edffe6..cc0a7c928e38 100644 --- a/atom/renderer/lib/web-view/guest-view-internal.coffee +++ b/atom/renderer/lib/web-view/guest-view-internal.coffee @@ -55,9 +55,9 @@ module.exports = ipc.removeAllListeners "ATOM_SHELL_GUEST_VIEW_INTERNAL_IPC_MESSAGE-#{viewInstanceId}" ipc.removeAllListeners "ATOM_SHELL_GUEST_VIEW_INTERNAL_SIZE_CHANGED-#{viewInstanceId}" - createGuest: (type, params, callback) -> + createGuest: (params, callback) -> requestId++ - ipc.send 'ATOM_SHELL_GUEST_VIEW_MANAGER_CREATE_GUEST', type, params, requestId + ipc.send 'ATOM_SHELL_GUEST_VIEW_MANAGER_CREATE_GUEST', params, requestId ipc.once "ATOM_SHELL_RESPONSE_#{requestId}", callback attachGuest: (elementInstanceId, guestInstanceId, params) -> diff --git a/atom/renderer/lib/web-view/web-view.coffee b/atom/renderer/lib/web-view/web-view.coffee index 6a8e3cf05e58..72961052a055 100644 --- a/atom/renderer/lib/web-view/web-view.coffee +++ b/atom/renderer/lib/web-view/web-view.coffee @@ -88,7 +88,7 @@ class WebViewImpl return unless @guestInstanceId - guestViewInternal.attachGuest @internalInstanceId, @guestInstanceId, @buildAttachParams() + guestViewInternal.attachGuest @internalInstanceId, @guestInstanceId, @buildParams() onSizeChanged: (webViewEvent) -> newWidth = webViewEvent.newWidth @@ -121,9 +121,7 @@ class WebViewImpl @dispatchEvent webViewEvent createGuest: -> - params = - storagePartitionId: @attributes[webViewConstants.ATTRIBUTE_PARTITION].getValue() - guestViewInternal.createGuest 'webview', params, (guestInstanceId) => + guestViewInternal.createGuest @buildParams(), (guestInstanceId) => @attachWindow guestInstanceId dispatchEvent: (webViewEvent) -> @@ -156,21 +154,29 @@ class WebViewImpl onAttach: (storagePartitionId) -> @attributes[webViewConstants.ATTRIBUTE_PARTITION].setValue storagePartitionId - buildAttachParams: -> + buildParams: -> params = instanceId: @viewInstanceId userAgentOverride: @userAgentOverride for attributeName, attribute of @attributes params[attributeName] = attribute.getValue() + # When the WebView is not participating in layout (display:none) + # then getBoundingClientRect() would report a width and height of 0. + # However, in the case where the WebView has a fixed size we can + # use that value to initially size the guest so as to avoid a relayout of + # the on display:block. + css = window.getComputedStyle @webviewNode, null + elementRect = @webviewNode.getBoundingClientRect() + params.elementSize = + width: parseInt(elementRect.width) || parseInt(css.getPropertyValue('width')) + height: parseInt(elementRect.height) || parseInt(css.getPropertyValue('height')) params attachWindow: (guestInstanceId) -> @guestInstanceId = guestInstanceId - params = @buildAttachParams() - return true unless @internalInstanceId - guestViewInternal.attachGuest @internalInstanceId, @guestInstanceId, params + guestViewInternal.attachGuest @internalInstanceId, @guestInstanceId, @buildParams() # Registers browser plugin custom element. registerBrowserPluginElement = -> From b5c9fe78f17ed0a676c4849f130ee909a30a83ca Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 29 May 2015 13:47:09 +0800 Subject: [PATCH 0108/1293] Listen to ElementSizeChanged event --- atom/browser/api/atom_api_web_contents.cc | 2 +- atom/browser/default_app/default_app.js | 1 - atom/browser/lib/guest-view-manager.coffee | 2 + atom/renderer/api/atom_api_web_frame.cc | 12 ++++++ atom/renderer/api/atom_api_web_frame.h | 4 ++ atom/renderer/guest_view_container.cc | 44 +++++++++++++++++++++- atom/renderer/guest_view_container.h | 23 ++++++++++- atom/renderer/lib/web-view/web-view.coffee | 22 +++++++++-- vendor/native_mate | 2 +- 9 files changed, 104 insertions(+), 8 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 639b875fa975..d6f934525eb1 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -62,7 +62,7 @@ struct Converter { out->min_size.reset(new gfx::Size(size)); if (params.Get("max", &size)) out->max_size.reset(new gfx::Size(size)); - if (params.Get("elementSize", &size)) + if (params.Get("normal", &size)) out->normal_size.reset(new gfx::Size(size)); return true; } diff --git a/atom/browser/default_app/default_app.js b/atom/browser/default_app/default_app.js index e471b23ae621..6b52d3f280f9 100644 --- a/atom/browser/default_app/default_app.js +++ b/atom/browser/default_app/default_app.js @@ -15,7 +15,6 @@ app.on('ready', function() { mainWindow = new BrowserWindow({ width: 800, height: 600, - resizable: false, 'auto-hide-menu-bar': true, 'use-content-size': true, }); diff --git a/atom/browser/lib/guest-view-manager.coffee b/atom/browser/lib/guest-view-manager.coffee index ab8aa8a4ad98..6e3447eece3e 100644 --- a/atom/browser/lib/guest-view-manager.coffee +++ b/atom/browser/lib/guest-view-manager.coffee @@ -58,6 +58,8 @@ createGuest = (embedder, params) -> @viewInstanceId = params.instanceId @setSize + normal: + width: params.elementWidth, height: params.elementHeight enableAutoSize: params.autosize min: width: params.minwidth, height: params.minheight diff --git a/atom/renderer/api/atom_api_web_frame.cc b/atom/renderer/api/atom_api_web_frame.cc index 21c0592a7c43..7b1666e680c3 100644 --- a/atom/renderer/api/atom_api_web_frame.cc +++ b/atom/renderer/api/atom_api_web_frame.cc @@ -10,9 +10,11 @@ #define USE(WTF_FEATURE) (defined WTF_USE_##WTF_FEATURE && WTF_USE_##WTF_FEATURE) // NOLINT #define ENABLE(WTF_FEATURE) (defined ENABLE_##WTF_FEATURE && ENABLE_##WTF_FEATURE) // NOLINT +#include "atom/common/native_mate_converters/gfx_converter.h" #include "atom/common/native_mate_converters/string16_converter.h" #include "atom/renderer/api/atom_api_spell_check_client.h" #include "content/public/renderer/render_frame.h" +#include "native_mate/callback.h" #include "native_mate/dictionary.h" #include "native_mate/object_template_builder.h" #include "third_party/WebKit/public/web/WebDocument.h" @@ -78,6 +80,14 @@ v8::Local WebFrame::RegisterEmbedderCustomElement( return web_frame_->document().registerEmbedderCustomElement(name, options, c); } +void WebFrame::RegisterElementResizeCallback( + int element_instance_id, + const GuestViewContainer::ResizeCallback& callback) { + auto guest_view_container = GuestViewContainer::FromID(element_instance_id); + if (guest_view_container) + guest_view_container->RegisterElementResizeCallback(callback); +} + void WebFrame::AttachGuest(int id) { content::RenderFrame::FromWebFrame(web_frame_)->AttachGuest(id); } @@ -106,6 +116,8 @@ mate::ObjectTemplateBuilder WebFrame::GetObjectTemplateBuilder( .SetMethod("getZoomFactor", &WebFrame::GetZoomFactor) .SetMethod("registerEmbedderCustomElement", &WebFrame::RegisterEmbedderCustomElement) + .SetMethod("registerElementResizeCallback", + &WebFrame::RegisterElementResizeCallback) .SetMethod("attachGuest", &WebFrame::AttachGuest) .SetMethod("setSpellCheckProvider", &WebFrame::SetSpellCheckProvider) .SetMethod("registerUrlSchemeAsSecure", diff --git a/atom/renderer/api/atom_api_web_frame.h b/atom/renderer/api/atom_api_web_frame.h index f9afa1d1d616..e57efd45cfb8 100644 --- a/atom/renderer/api/atom_api_web_frame.h +++ b/atom/renderer/api/atom_api_web_frame.h @@ -7,6 +7,7 @@ #include +#include "atom/renderer/guest_view_container.h" #include "base/memory/scoped_ptr.h" #include "native_mate/handle.h" #include "native_mate/wrappable.h" @@ -42,6 +43,9 @@ class WebFrame : public mate::Wrappable { v8::Local RegisterEmbedderCustomElement( const base::string16& name, v8::Local options); + void RegisterElementResizeCallback( + int element_instance_id, + const GuestViewContainer::ResizeCallback& callback); void AttachGuest(int element_instance_id); // Set the provider that will be used by SpellCheckClient for spell check. diff --git a/atom/renderer/guest_view_container.cc b/atom/renderer/guest_view_container.cc index f23c36dfd356..638df2177e48 100644 --- a/atom/renderer/guest_view_container.cc +++ b/atom/renderer/guest_view_container.cc @@ -4,12 +4,54 @@ #include "atom/renderer/guest_view_container.h" +#include + +#include "base/lazy_instance.h" + namespace atom { -GuestViewContainer::GuestViewContainer(content::RenderFrame* render_frame) { +namespace { + +using GuestViewContainerMap = std::map; +static base::LazyInstance g_guest_view_container_map = + LAZY_INSTANCE_INITIALIZER; + +} // namespace + +GuestViewContainer::GuestViewContainer(content::RenderFrame* render_frame) + : render_frame_(render_frame) { } GuestViewContainer::~GuestViewContainer() { + if (element_instance_id_ > 0) + g_guest_view_container_map.Get().erase(element_instance_id_); +} + +// static +GuestViewContainer* GuestViewContainer::FromID(int element_instance_id) { + GuestViewContainerMap* guest_view_containers = + g_guest_view_container_map.Pointer(); + auto it = guest_view_containers->find(element_instance_id); + return it == guest_view_containers->end() ? nullptr : it->second; +} + +void GuestViewContainer::RegisterElementResizeCallback( + const ResizeCallback& callback) { + element_resize_callback_ = callback; +} + +void GuestViewContainer::SetElementInstanceID(int element_instance_id) { + element_instance_id_ = element_instance_id; + g_guest_view_container_map.Get().insert( + std::make_pair(element_instance_id, this)); +} + +void GuestViewContainer::DidResizeElement(const gfx::Size& old_size, + const gfx::Size& new_size) { + if (element_resize_callback_.is_null()) + return; + + element_resize_callback_.Run(old_size, new_size); } } // namespace atom diff --git a/atom/renderer/guest_view_container.h b/atom/renderer/guest_view_container.h index 5a21dad028ff..b81f84cbd050 100644 --- a/atom/renderer/guest_view_container.h +++ b/atom/renderer/guest_view_container.h @@ -5,17 +5,38 @@ #ifndef ATOM_RENDERER_GUEST_VIEW_CONTAINER_H_ #define ATOM_RENDERER_GUEST_VIEW_CONTAINER_H_ +#include "base/callback.h" #include "content/public/renderer/browser_plugin_delegate.h" -#include "v8/include/v8.h" + +namespace gfx { +class Size; +} namespace atom { class GuestViewContainer : public content::BrowserPluginDelegate { public: + typedef base::Callback + ResizeCallback; + explicit GuestViewContainer(content::RenderFrame* render_frame); ~GuestViewContainer() override; + static GuestViewContainer* FromID(int element_instance_id); + + void RegisterElementResizeCallback(const ResizeCallback& callback); + + // content::BrowserPluginDelegate: + void SetElementInstanceID(int element_instance_id) final; + void DidResizeElement(const gfx::Size& old_size, + const gfx::Size& new_size) final; + private: + int element_instance_id_; + content::RenderFrame* render_frame_; + + ResizeCallback element_resize_callback_; + DISALLOW_COPY_AND_ASSIGN(GuestViewContainer); }; diff --git a/atom/renderer/lib/web-view/web-view.coffee b/atom/renderer/lib/web-view/web-view.coffee index 72961052a055..da6f55c8fe35 100644 --- a/atom/renderer/lib/web-view/web-view.coffee +++ b/atom/renderer/lib/web-view/web-view.coffee @@ -86,6 +86,9 @@ class WebViewImpl @browserPluginNode.removeAttribute webViewConstants.ATTRIBUTE_INTERNALINSTANCEID @internalInstanceId = parseInt newValue + # Track when the element resizes using the element resize callback. + webFrame.registerElementResizeCallback @internalInstanceId, @onElementResize.bind(this) + return unless @guestInstanceId guestViewInternal.attachGuest @internalInstanceId, @guestInstanceId, @buildParams() @@ -120,6 +123,18 @@ class WebViewImpl # changed. @dispatchEvent webViewEvent + onElementResize: (oldSize, newSize) -> + # Dispatch the 'resize' event. + resizeEvent = new Event('resize', bubbles: true) + resizeEvent.oldWidth = oldSize.width + resizeEvent.oldHeight = oldSize.height + resizeEvent.newWidth = newSize.width + resizeEvent.newHeight = newSize.height + @dispatchEvent resizeEvent + + if @guestInstanceId + guestViewInternal.setSize @guestInstanceId, normal: newSize + createGuest: -> guestViewInternal.createGuest @buildParams(), (guestInstanceId) => @attachWindow guestInstanceId @@ -167,9 +182,10 @@ class WebViewImpl # the on display:block. css = window.getComputedStyle @webviewNode, null elementRect = @webviewNode.getBoundingClientRect() - params.elementSize = - width: parseInt(elementRect.width) || parseInt(css.getPropertyValue('width')) - height: parseInt(elementRect.height) || parseInt(css.getPropertyValue('height')) + params.elementWidth = parseInt(elementRect.width) || + parseInt(css.getPropertyValue('width')) + params.elementHeight = parseInt(elementRect.height) || + parseInt(css.getPropertyValue('height')) params attachWindow: (guestInstanceId) -> diff --git a/vendor/native_mate b/vendor/native_mate index 1696237a3f44..ad207eeabb01 160000 --- a/vendor/native_mate +++ b/vendor/native_mate @@ -1 +1 @@ -Subproject commit 1696237a3f444f0e33a8947749b4d70f6feb511b +Subproject commit ad207eeabb0185f74c017e70ca3411d522627ff0 From a9ad783bcaf81b371643dce9b145eb1f3df9c439 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 29 May 2015 13:52:14 +0800 Subject: [PATCH 0109/1293] The ElementSizeChanged has been removed --- atom/browser/api/atom_api_web_contents.cc | 11 ----------- atom/browser/api/atom_api_web_contents.h | 5 ----- 2 files changed, 16 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index d6f934525eb1..cfc8304d0611 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -112,7 +112,6 @@ content::ServiceWorkerContext* GetServiceWorkerContext( WebContents::WebContents(content::WebContents* web_contents) : content::WebContentsObserver(web_contents), guest_instance_id_(-1), - element_instance_id_(-1), guest_opaque_(true), guest_host_(nullptr), auto_size_enabled_(false), @@ -121,7 +120,6 @@ WebContents::WebContents(content::WebContents* web_contents) WebContents::WebContents(const mate::Dictionary& options) : guest_instance_id_(-1), - element_instance_id_(-1), guest_opaque_(true), guest_host_(nullptr), auto_size_enabled_(false), @@ -450,14 +448,6 @@ void WebContents::DidAttach(int guest_proxy_routing_id) { Emit("did-attach"); } -void WebContents::ElementSizeChanged(const gfx::Size& size) { - element_size_ = size; - - // Only resize if needed. - if (!size.IsEmpty()) - guest_host_->SizeContents(size); -} - content::WebContents* WebContents::GetOwnerWebContents() const { return embedder_web_contents_; } @@ -477,7 +467,6 @@ void WebContents::WillAttach(content::WebContents* embedder_web_contents, int element_instance_id, bool is_full_page_plugin) { embedder_web_contents_ = embedder_web_contents; - element_instance_id_ = element_instance_id; is_full_page_plugin_ = is_full_page_plugin; } diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index 63248fd02a21..062831577aad 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -211,7 +211,6 @@ class WebContents : public mate::EventEmitter, // content::BrowserPluginGuestDelegate: void DidAttach(int guest_proxy_routing_id) final; - void ElementSizeChanged(const gfx::Size& size) final; content::WebContents* GetOwnerWebContents() const final; void GuestSizeChanged(const gfx::Size& new_size) final; void SetGuestHost(content::GuestHost* guest_host) final; @@ -249,10 +248,6 @@ class WebContents : public mate::EventEmitter, // Unique ID for a guest WebContents. int guest_instance_id_; - // |element_instance_id_| is an identifer that's unique to a particular - // element. - int element_instance_id_; - // Stores whether the contents of the guest can be transparent. bool guest_opaque_; From 57ab704300329695387ec7917f317046478ecbdf Mon Sep 17 00:00:00 2001 From: fraserxu Date: Fri, 29 May 2015 15:55:11 +0800 Subject: [PATCH 0110/1293] convert message to string for window.alert method --- atom/renderer/lib/override.coffee | 1 + 1 file changed, 1 insertion(+) diff --git a/atom/renderer/lib/override.coffee b/atom/renderer/lib/override.coffee index ccc7882a37e8..2e25ffbd6b43 100644 --- a/atom/renderer/lib/override.coffee +++ b/atom/renderer/lib/override.coffee @@ -62,6 +62,7 @@ window.open = (url, frameName='', features='') -> window.alert = (message, title='') -> dialog = remote.require 'dialog' buttons = ['OK'] + message = message.toString() dialog.showMessageBox remote.getCurrentWindow(), {message, title, buttons} # And the confirm(). From fb37b5720d4822f99359f97ae1ea207ee04b4b26 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 29 May 2015 17:52:19 +0800 Subject: [PATCH 0111/1293] Update brightray to use correct Chrome version string Close #1808 --- atom/common/chrome_version.h | 2 +- vendor/brightray | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/atom/common/chrome_version.h b/atom/common/chrome_version.h index 6b2ea8d91a45..093ed4e98b05 100644 --- a/atom/common/chrome_version.h +++ b/atom/common/chrome_version.h @@ -8,7 +8,7 @@ #ifndef ATOM_COMMON_CHROME_VERSION_H_ #define ATOM_COMMON_CHROME_VERSION_H_ -#define CHROME_VERSION_STRING "42.0.2311.107" +#define CHROME_VERSION_STRING "43.0.2357.65" #define CHROME_VERSION "v" CHROME_VERSION_STRING #endif // ATOM_COMMON_CHROME_VERSION_H_ diff --git a/vendor/brightray b/vendor/brightray index 8fba2a883552..7391c76630ad 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit 8fba2a883552ad939a63250b552f467fa4f9bedb +Subproject commit 7391c76630ad514ee8c9a7e0d5e7932b60f38ab1 From dfbe158ca9741f51df607ed8524acde27509ade8 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 29 May 2015 18:14:59 +0800 Subject: [PATCH 0112/1293] mac: Remove dead "Frameworks" link, close #1801 --- atom.gyp | 1 - 1 file changed, 1 deletion(-) diff --git a/atom.gyp b/atom.gyp index efc51f209679..8cfdf6d1897f 100644 --- a/atom.gyp +++ b/atom.gyp @@ -452,7 +452,6 @@ 'tools/mac/create-framework-subdir-symlinks.sh', '<(product_name) Framework', 'Libraries', - 'Frameworks', ], }, ], From 6ed538b952c6746c98bcbb2678b866b7a6bff8f5 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 29 May 2015 18:21:25 +0800 Subject: [PATCH 0113/1293] docs: Remove obsolete build instructions, close #1809 --- docs/development/build-instructions-linux.md | 24 -------------------- 1 file changed, 24 deletions(-) diff --git a/docs/development/build-instructions-linux.md b/docs/development/build-instructions-linux.md index edaf2f79d2e2..e98cf3007c49 100644 --- a/docs/development/build-instructions-linux.md +++ b/docs/development/build-instructions-linux.md @@ -15,18 +15,6 @@ $ sudo apt-get install build-essential clang libdbus-1-dev libgtk2.0-dev \ gcc-multilib g++-multilib ``` -Latest Node.js could be installed via ppa: - -```bash -$ sudo apt-get install python-software-properties software-properties-common -$ sudo add-apt-repository ppa:chris-lea/node.js -$ sudo apt-get update -$ sudo apt-get install nodejs - -# Update to latest npm -$ sudo npm install npm -g -``` - ## Getting the code ```bash @@ -81,18 +69,6 @@ this: $ sudo apt-get install gcc-multilib g++-multilib ``` -### error adding symbols: DSO missing from command line - -If you got an error like this: - -```` -/usr/bin/ld: vendor/download/libchromiumcontent/Release/libchromiumcontent.so: undefined reference to symbol 'gconf_client_get' -//usr/lib/x86_64-linux-gnu/libgconf-2.so.4: error adding symbols: DSO missing from command line -```` - -libchromiumcontent.so is build with clang 3.0 which is incompatible with newer -versions of clang. Try using clang 3.0, default version in Ubuntu 12.04. - ### libudev.so.0 missing If you get an error like: From 02bdace366f38271b5c186412f42810ecb06e99e Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 29 May 2015 22:20:20 +0800 Subject: [PATCH 0114/1293] Delete Node's symbols after Environment has been loaded Fix #1803. --- atom/common/node_bindings.cc | 3 +++ atom/renderer/lib/init.coffee | 8 ++------ 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/atom/common/node_bindings.cc b/atom/common/node_bindings.cc index 10ab8f4929a4..eb627d06b757 100644 --- a/atom/common/node_bindings.cc +++ b/atom/common/node_bindings.cc @@ -178,6 +178,9 @@ void NodeBindings::LoadEnvironment(node::Environment* env) { if (node::use_debug_agent) node::EnableDebug(env); + + v8::Local msg = mate::StringToV8(env->isolate(), "loaded"); + node::MakeCallback(env->isolate(), env->process_object(), "emit", 1, &msg); } void NodeBindings::PrepareMessageLoop() { diff --git a/atom/renderer/lib/init.coffee b/atom/renderer/lib/init.coffee index 1e0167d6e154..470715626b13 100644 --- a/atom/renderer/lib/init.coffee +++ b/atom/renderer/lib/init.coffee @@ -88,12 +88,8 @@ if nodeIntegration in ['true', 'all', 'except-iframe', 'manual-enable-iframe'] window.addEventListener 'unload', -> process.emit 'exit' else - # The Module.runMain will run process._tickCallck() immediately, so we are - # able to delete the symbols in this tick even though we used process.nextTick - # to schedule it. - # It is important that we put this in process.nextTick, if we delete them now - # some code in node.js will complain about "process not defined". - process.nextTick -> + # Delete Node's symbols after the Environment has been loaded. + process.once 'loaded', -> delete global.process delete global.setImmediate delete global.clearImmediate From 4e2f242ad0209515639c406542eaabfc2f5d556f Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Fri, 29 May 2015 23:25:11 +0800 Subject: [PATCH 0115/1293] Use Crashpad instead of Breakpad on OS X. --- .gitmodules | 3 + atom.gyp | 6 +- .../crash_reporter/crash_reporter_mac.h | 3 - .../crash_reporter/crash_reporter_mac.mm | 120 +++++++++++------- common.gypi | 1 + 5 files changed, 78 insertions(+), 55 deletions(-) diff --git a/.gitmodules b/.gitmodules index 2a1f087e7446..1af8329b5f01 100644 --- a/.gitmodules +++ b/.gitmodules @@ -13,3 +13,6 @@ [submodule "vendor/native_mate"] path = vendor/native_mate url = https://github.com/zcbenz/native-mate.git +[submodule "vendor/crashpad"] + path = vendor/crashpad + url = https://github.com/hokein/crashpad.git diff --git a/atom.gyp b/atom.gyp index 557d53028931..ee0589d17e63 100644 --- a/atom.gyp +++ b/atom.gyp @@ -273,7 +273,8 @@ }], # OS=="win" ['OS=="mac"', { 'dependencies': [ - 'vendor/breakpad/breakpad.gyp:breakpad', + 'vendor/crashpad/client/client.gyp:crashpad_client', + 'vendor/crashpad/handler/handler.gyp:crashpad_handler', ], }], # OS=="mac" ['OS=="linux"', { @@ -428,8 +429,7 @@ { 'destination': '<(PRODUCT_DIR)/<(product_name) Framework.framework/Versions/A/Resources', 'files': [ - '<(PRODUCT_DIR)/Inspector', - '<(PRODUCT_DIR)/crash_report_sender.app', + '<(PRODUCT_DIR)/crashpad_handler', ], }, ], diff --git a/atom/common/crash_reporter/crash_reporter_mac.h b/atom/common/crash_reporter/crash_reporter_mac.h index 882744db3c7e..53202c0f174f 100644 --- a/atom/common/crash_reporter/crash_reporter_mac.h +++ b/atom/common/crash_reporter/crash_reporter_mac.h @@ -9,7 +9,6 @@ #include "atom/common/crash_reporter/crash_reporter.h" #include "base/compiler_specific.h" -#import "vendor/breakpad/src/client/mac/Framework/Breakpad.h" template struct DefaultSingletonTraits; @@ -33,8 +32,6 @@ class CrashReporterMac : public CrashReporter { CrashReporterMac(); virtual ~CrashReporterMac(); - BreakpadRef breakpad_; - DISALLOW_COPY_AND_ASSIGN(CrashReporterMac); }; diff --git a/atom/common/crash_reporter/crash_reporter_mac.mm b/atom/common/crash_reporter/crash_reporter_mac.mm index c251e0e0d100..0790d45d411a 100644 --- a/atom/common/crash_reporter/crash_reporter_mac.mm +++ b/atom/common/crash_reporter/crash_reporter_mac.mm @@ -4,20 +4,44 @@ #include "atom/common/crash_reporter/crash_reporter_mac.h" +#include "base/files/file_path.h" +#include "base/mac/bundle_locations.h" #include "base/mac/mac_util.h" #include "base/memory/singleton.h" +#include "base/strings/string_piece.h" +#include "base/strings/stringprintf.h" #include "base/strings/sys_string_conversions.h" -#import "vendor/breakpad/src/client/apple/Framework/BreakpadDefines.h" +#include "vendor/crashpad/client/crash_report_database.h" +#include "vendor/crashpad/client/crashpad_client.h" +#include "vendor/crashpad/client/crashpad_info.h" +#include "vendor/crashpad/client/settings.h" +#include "vendor/crashpad/client/simple_string_dictionary.h" namespace crash_reporter { -CrashReporterMac::CrashReporterMac() - : breakpad_(NULL) { +namespace { + +crashpad::SimpleStringDictionary* g_simple_string_dictionary; +crashpad::CrashReportDatabase* g_database; + +void SetUploadsEnabled(bool enable_uploads) { + if (g_database) { + crashpad::Settings* settings = g_database->GetSettings(); + settings->SetUploadsEnabled(enable_uploads); + } +} + +void SetCrashKeyValue(const base::StringPiece& key, + const base::StringPiece& value) { + g_simple_string_dictionary->SetKeyValue(key.data(), value.data()); +} + +} // namespace + +CrashReporterMac::CrashReporterMac() { } CrashReporterMac::~CrashReporterMac() { - if (breakpad_ != NULL) - BreakpadRelease(breakpad_); } void CrashReporterMac::InitBreakpad(const std::string& product_name, @@ -26,54 +50,52 @@ void CrashReporterMac::InitBreakpad(const std::string& product_name, const std::string& submit_url, bool auto_submit, bool skip_system_crash_handler) { - if (breakpad_ != NULL) - BreakpadRelease(breakpad_); - - NSMutableDictionary* parameters = - [NSMutableDictionary dictionaryWithCapacity:4]; - - [parameters setValue:@ATOM_PRODUCT_NAME - forKey:@BREAKPAD_PRODUCT]; - [parameters setValue:base::SysUTF8ToNSString(product_name) - forKey:@BREAKPAD_PRODUCT_DISPLAY]; - [parameters setValue:base::SysUTF8ToNSString(version) - forKey:@BREAKPAD_VERSION]; - [parameters setValue:base::SysUTF8ToNSString(company_name) - forKey:@BREAKPAD_VENDOR]; - [parameters setValue:base::SysUTF8ToNSString(submit_url) - forKey:@BREAKPAD_URL]; - [parameters setValue:(auto_submit ? @"YES" : @"NO") - forKey:@BREAKPAD_SKIP_CONFIRM]; - [parameters setValue:(skip_system_crash_handler ? @"YES" : @"NO") - forKey:@BREAKPAD_SEND_AND_EXIT]; - - // Report all crashes (important for testing the crash reporter). - [parameters setValue:@"0" forKey:@BREAKPAD_REPORT_INTERVAL]; - - // Put dump files under "/tmp/ProductName Crashes". - std::string dump_dir = "/tmp/" + product_name + " Crashes"; - [parameters setValue:base::SysUTF8ToNSString(dump_dir) - forKey:@BREAKPAD_DUMP_DIRECTORY]; - - // Temporarily run Breakpad in-process on 10.10 and later because APIs that - // it depends on got broken (http://crbug.com/386208). - // This can catch crashes in the browser process only. - if (base::mac::IsOSYosemiteOrLater()) { - [parameters setObject:[NSNumber numberWithBool:YES] - forKey:@BREAKPAD_IN_PROCESS]; - } - - breakpad_ = BreakpadCreate(parameters); - if (!breakpad_) { - LOG(ERROR) << "Failed to initialize breakpad"; + static bool initialized = false; + if (initialized) return; + initialized = true; + + std::string dump_dir = "/tmp/" + product_name + " Crashes"; + base::FilePath database_path(dump_dir); + if (is_browser_) { + @autoreleasepool { + base::FilePath framework_bundle_path = base::mac::FrameworkBundlePath(); + base::FilePath handler_path = + framework_bundle_path.Append("Resources").Append("crashpad_handler"); + + crashpad::CrashpadClient crashpad_client; + if (crashpad_client.StartHandler(handler_path, database_path, + submit_url, + StringMap(), + std::vector())) { + crashpad_client.UseHandler(); + } + } // @autoreleasepool } - for (StringMap::const_iterator iter = upload_parameters_.begin(); + crashpad::CrashpadInfo* crashpad_info = + crashpad::CrashpadInfo::GetCrashpadInfo(); + if (skip_system_crash_handler) { + crashpad_info->set_system_crash_reporter_forwarding( + crashpad::TriState::kDisabled); + } + + g_simple_string_dictionary = new crashpad::SimpleStringDictionary(); + crashpad_info->set_simple_annotations(g_simple_string_dictionary); + + SetCrashKeyValue("prod", ATOM_PRODUCT_NAME); + SetCrashKeyValue("process_type", is_browser_ ? base::StringPiece("browser") + : base::StringPiece("renderer")); + SetCrashKeyValue("ver", version); + + for (auto iter = upload_parameters_.begin(); iter != upload_parameters_.end(); ++iter) { - BreakpadAddUploadParameter(breakpad_, - base::SysUTF8ToNSString(iter->first), - base::SysUTF8ToNSString(iter->second)); + SetCrashKeyValue(iter->first, iter->second); + } + if (is_browser_) { + g_database = + crashpad::CrashReportDatabase::Initialize(database_path).release(); + SetUploadsEnabled(auto_submit); } } diff --git a/common.gypi b/common.gypi index c6f3320c0a5b..1bd88828ea77 100644 --- a/common.gypi +++ b/common.gypi @@ -30,6 +30,7 @@ 'v8_enable_i18n_support': 'false', # Required by Linux (empty for now, should support it in future). 'sysroot': '', + 'crashpad_standalone': 1, }, # Settings to compile node under Windows. 'target_defaults': { From 98a9d8a9e327195857cf9030b7ff5b017f7d6371 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Sat, 30 May 2015 07:34:56 +0800 Subject: [PATCH 0116/1293] Enable crashpad test on OS X. --- spec/api-crash-reporter-spec.coffee | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/spec/api-crash-reporter-spec.coffee b/spec/api-crash-reporter-spec.coffee index d6a619c905c3..60144bc63087 100644 --- a/spec/api-crash-reporter-spec.coffee +++ b/spec/api-crash-reporter-spec.coffee @@ -5,12 +5,10 @@ url = require 'url' remote = require 'remote' formidable = require 'formidable' +crashReporter = remote.require 'crash-reporter' BrowserWindow = remote.require 'browser-window' describe 'crash-reporter module', -> - # We have trouble makeing crash reporter work on Yosemite. - return if process.platform is 'darwin' - fixtures = path.resolve __dirname, 'fixtures' w = null @@ -47,4 +45,5 @@ describe 'crash-reporter module', -> protocol: 'file' pathname: path.join fixtures, 'api', 'crash.html' search: "?port=#{port}" + crashReporter.start {'submitUrl': 'http://127.0.0.1:' + port} w.loadUrl url From cd8ceec62e5c127fd378ba97da2d41031923b18d Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Sat, 30 May 2015 08:47:52 +0800 Subject: [PATCH 0117/1293] Send all crash reports to collection server. Crashpad client only send reports once per hour. It's different with breakpad. With this behavior, the other reports generated within an hour will be totally skipped, which causes the crash api test only run once with an hour. This patch unrestricts this time limit. --- atom/common/crash_reporter/crash_reporter_mac.mm | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/atom/common/crash_reporter/crash_reporter_mac.mm b/atom/common/crash_reporter/crash_reporter_mac.mm index 0790d45d411a..0e6635cafbbc 100644 --- a/atom/common/crash_reporter/crash_reporter_mac.mm +++ b/atom/common/crash_reporter/crash_reporter_mac.mm @@ -64,10 +64,12 @@ void CrashReporterMac::InitBreakpad(const std::string& product_name, framework_bundle_path.Append("Resources").Append("crashpad_handler"); crashpad::CrashpadClient crashpad_client; + // Send all crash reports. + std::vector arguments = { "--upload-internal=0" }; if (crashpad_client.StartHandler(handler_path, database_path, submit_url, StringMap(), - std::vector())) { + arguments)) { crashpad_client.UseHandler(); } } // @autoreleasepool From 16fb8470096222ceee7ebd9aaf09536ca0c6a15b Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Sat, 30 May 2015 09:40:07 +0800 Subject: [PATCH 0118/1293] Add script to setup crashpad repository. Crashpad use `gclient` to maintain its third_party libraries. This patch switches `gclient` instead of `git submodule` to align crashpad way. --- .gitignore | 1 + .gitmodules | 3 --- script/bootstrap.py | 15 +++++++++++++++ 3 files changed, 16 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index b18292e6ab0f..701451fd0d93 100644 --- a/.gitignore +++ b/.gitignore @@ -6,6 +6,7 @@ /vendor/brightray/vendor/download/ /vendor/python_26/ /vendor/npm/ +/vendor/.gclient node_modules/ *.xcodeproj *.swp diff --git a/.gitmodules b/.gitmodules index 1af8329b5f01..2a1f087e7446 100644 --- a/.gitmodules +++ b/.gitmodules @@ -13,6 +13,3 @@ [submodule "vendor/native_mate"] path = vendor/native_mate url = https://github.com/zcbenz/native-mate.git -[submodule "vendor/crashpad"] - path = vendor/crashpad - url = https://github.com/hokein/crashpad.git diff --git a/script/bootstrap.py b/script/bootstrap.py index f67a790a04ce..88dfaad53d7f 100755 --- a/script/bootstrap.py +++ b/script/bootstrap.py @@ -12,6 +12,7 @@ from lib.util import execute_stdout, get_atom_shell_version, scoped_cwd SOURCE_ROOT = os.path.abspath(os.path.dirname(os.path.dirname(__file__))) VENDOR_DIR = os.path.join(SOURCE_ROOT, 'vendor') PYTHON_26_URL = 'https://chromium.googlesource.com/chromium/deps/python_26' +CRACKPAD_URL = 'https://github.com/hokein/crashpad.git' NPM = 'npm.cmd' if sys.platform in ['win32', 'cygwin'] else 'npm' @@ -27,6 +28,8 @@ def main(): update_win32_python() update_submodules() update_node_modules('.') + if sys.platform == 'darwin': + update_crashpad() bootstrap_brightray(args.dev, args.url, args.target_arch) create_chrome_version_h() @@ -92,6 +95,18 @@ def update_node_modules(dirname, env=None): execute_stdout([NPM, 'install'], env) +def update_crashpad(): + gclient = os.path.join(VENDOR_DIR, 'depot_tools', 'gclient.py') + args = [ + 'config', + '--unmanaged', + CRACKPAD_URL, + ] + with scoped_cwd(VENDOR_DIR): + execute_stdout([sys.executable, gclient] + args) + execute_stdout([sys.executable, gclient] + ['sync']) + + def update_electron_modules(dirname, target_arch): env = os.environ.copy() env['npm_config_arch'] = target_arch From 51d5ef9d862390607b6376e2abc7f78f1b000873 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Sat, 30 May 2015 10:03:59 +0800 Subject: [PATCH 0119/1293] :memo: crash-reporter note on OS X. --- docs/api/crash-reporter.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/api/crash-reporter.md b/docs/api/crash-reporter.md index 47e3666fa440..8e4540567908 100644 --- a/docs/api/crash-reporter.md +++ b/docs/api/crash-reporter.md @@ -27,6 +27,10 @@ crashReporter.start({ * Only string properties are send correctly. * Nested objects are not supported. +**Note:** On OS X, electron uses a new `crashpad` client, which is different +with the `breakpad` on Windows and Linux. To enable crash collection feature, +you are required to call `crashReporter.start` API to initiliaze `crashpad` in Browser Process, even you only collect crash report in Renderer Process. + ## crashReporter.getLastCrashReport() Returns the date and ID of last crash report, when there was no crash report From c026863d4894d86918ee73029d6c9cff296c3e28 Mon Sep 17 00:00:00 2001 From: Yeechan Lu Date: Fri, 29 May 2015 14:53:32 +0800 Subject: [PATCH 0120/1293] Print real error messages even if it looks like an invalid app --- atom/browser/default_app/main.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/atom/browser/default_app/main.js b/atom/browser/default_app/main.js index 5664fac4cd21..1726ffba8ea1 100644 --- a/atom/browser/default_app/main.js +++ b/atom/browser/default_app/main.js @@ -53,7 +53,7 @@ if (option.file && !option.webdriver) { } catch(e) { if (e.code == 'MODULE_NOT_FOUND') { app.focus(); - dialog.showErrorBox('Error opening app', 'The app provided is not a valid electron app, please read the docs on how to write one:\nhttps://github.com/atom/electron/tree/master/docs'); + dialog.showErrorBox('Error opening app', 'The app provided is not a valid electron app, please read the docs on how to write one:\nhttps://github.com/atom/electron/tree/master/docs\n\n' + e.toString()); process.exit(1); } else { console.error('App threw an error when running', e); From 1314b7c7e56ebf69182b6df6f82534b2a45c3000 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 1 Jun 2015 12:19:56 +0800 Subject: [PATCH 0121/1293] Update libchromiumcontent, fix #1786 --- script/lib/config.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/script/lib/config.py b/script/lib/config.py index fd9773b5a31c..c8ee28cb0c4d 100644 --- a/script/lib/config.py +++ b/script/lib/config.py @@ -7,7 +7,7 @@ import sys BASE_URL = 'http://gh-contractor-zcbenz.s3.amazonaws.com/libchromiumcontent' -LIBCHROMIUMCONTENT_COMMIT = '5ccddd5f3968a7f63eaa888e6a8ba319ea8cd3b7' +LIBCHROMIUMCONTENT_COMMIT = '893b48a10ef1813abdaf8de3540e2e7203475105' PLATFORM = { 'cygwin': 'win32', From fe631e6eeb61437523b631063249c4b1c8da9744 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 1 Jun 2015 12:22:36 +0800 Subject: [PATCH 0122/1293] Bump v0.27.2 --- atom.gyp | 2 +- atom/browser/resources/mac/Info.plist | 2 +- atom/browser/resources/win/atom.rc | 8 ++++---- atom/common/atom_version.h | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/atom.gyp b/atom.gyp index 8cfdf6d1897f..8455274f2904 100644 --- a/atom.gyp +++ b/atom.gyp @@ -4,7 +4,7 @@ 'product_name%': 'Electron', 'company_name%': 'GitHub, Inc', 'company_abbr%': 'github', - 'version%': '0.27.1', + 'version%': '0.27.2', 'atom_source_root': 'CFBundleIconFile atom.icns CFBundleVersion - 0.27.1 + 0.27.2 LSMinimumSystemVersion 10.8.0 NSMainNibFile diff --git a/atom/browser/resources/win/atom.rc b/atom/browser/resources/win/atom.rc index 7960f463aa8f..c559363f41a4 100644 --- a/atom/browser/resources/win/atom.rc +++ b/atom/browser/resources/win/atom.rc @@ -50,8 +50,8 @@ END // VS_VERSION_INFO VERSIONINFO - FILEVERSION 0,27,1,0 - PRODUCTVERSION 0,27,1,0 + FILEVERSION 0,27,2,0 + PRODUCTVERSION 0,27,2,0 FILEFLAGSMASK 0x3fL #ifdef _DEBUG FILEFLAGS 0x1L @@ -68,12 +68,12 @@ BEGIN BEGIN VALUE "CompanyName", "GitHub, Inc." VALUE "FileDescription", "Electron" - VALUE "FileVersion", "0.27.1" + VALUE "FileVersion", "0.27.2" VALUE "InternalName", "electron.exe" VALUE "LegalCopyright", "Copyright (C) 2015 GitHub, Inc. All rights reserved." VALUE "OriginalFilename", "electron.exe" VALUE "ProductName", "Electron" - VALUE "ProductVersion", "0.27.1" + VALUE "ProductVersion", "0.27.2" VALUE "SquirrelAwareVersion", "1" END END diff --git a/atom/common/atom_version.h b/atom/common/atom_version.h index e5ebb55616cd..dd316cdd0220 100644 --- a/atom/common/atom_version.h +++ b/atom/common/atom_version.h @@ -7,7 +7,7 @@ #define ATOM_MAJOR_VERSION 0 #define ATOM_MINOR_VERSION 27 -#define ATOM_PATCH_VERSION 1 +#define ATOM_PATCH_VERSION 2 #define ATOM_VERSION_IS_RELEASE 1 From b97c22d4d768b557f6c601e7ef89b4bb9ab6a41a Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 1 Jun 2015 12:53:43 +0800 Subject: [PATCH 0123/1293] win: Load pdf.dll with abosolute path, fix #1826 --- chromium_src/chrome/utility/printing_handler_win.cc | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/chromium_src/chrome/utility/printing_handler_win.cc b/chromium_src/chrome/utility/printing_handler_win.cc index 705131f348cd..ec908d19fc51 100644 --- a/chromium_src/chrome/utility/printing_handler_win.cc +++ b/chromium_src/chrome/utility/printing_handler_win.cc @@ -31,8 +31,11 @@ class PdfFunctions { render_pdf_to_dc_func_(NULL) {} bool Init() { - base::FilePath pdf_module_path(FILE_PATH_LITERAL("pdf.dll")); - pdf_lib_.Reset(base::LoadNativeLibrary(pdf_module_path, NULL)); + base::FilePath module_path; + if (!PathService::Get(base::DIR_MODULE, &module_path)) + return false; + base::FilePath::StringType name(FILE_PATH_LITERAL("pdf.dll")); + pdf_lib_.Reset(base::LoadNativeLibrary(module_path.Append(name), NULL)); if (!pdf_lib_.is_valid()) { LOG(WARNING) << "Couldn't load PDF plugin"; return false; From c4cbb5ecdbe22e7e9b9b30b558389a445806e941 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Mon, 1 Jun 2015 13:03:56 +0800 Subject: [PATCH 0124/1293] Ship pdf.dll in release. --- script/create-dist.py | 1 + 1 file changed, 1 insertion(+) diff --git a/script/create-dist.py b/script/create-dist.py index 6a6fa0d1a34b..da2efb3ef1cf 100755 --- a/script/create-dist.py +++ b/script/create-dist.py @@ -38,6 +38,7 @@ TARGET_BINARIES = { 'msvcp120.dll', 'msvcr120.dll', 'node.dll', + 'pdf.dll', 'content_resources_200_percent.pak', 'ui_resources_200_percent.pak', 'xinput1_3.dll', From 67a9931b5554501bf5d1021eba7dd7c6e1089cc4 Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Mon, 1 Jun 2015 17:23:44 +0530 Subject: [PATCH 0125/1293] devtools: initialise devtoolsWebContents when opened with inspect* apis --- atom/browser/api/atom_api_window.cc | 4 ++-- atom/browser/api/lib/browser-window.coffee | 8 ++++++++ atom/browser/native_window.cc | 2 -- 3 files changed, 10 insertions(+), 4 deletions(-) diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index fb2562e0e078..a016c16da012 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -527,7 +527,7 @@ void Window::BuildPrototype(v8::Isolate* isolate, .SetMethod("_openDevTools", &Window::OpenDevTools) .SetMethod("closeDevTools", &Window::CloseDevTools) .SetMethod("isDevToolsOpened", &Window::IsDevToolsOpened) - .SetMethod("inspectElement", &Window::InspectElement) + .SetMethod("_inspectElement", &Window::InspectElement) .SetMethod("focusOnWebView", &Window::FocusOnWebView) .SetMethod("blurWebView", &Window::BlurWebView) .SetMethod("isWebViewFocused", &Window::IsWebViewFocused) @@ -549,7 +549,7 @@ void Window::BuildPrototype(v8::Isolate* isolate, #endif .SetMethod("_getWebContents", &Window::GetWebContents) .SetMethod("_getDevToolsWebContents", &Window::GetDevToolsWebContents) - .SetMethod("inspectServiceWorker", &Window::InspectServiceWorker); + .SetMethod("_inspectServiceWorker", &Window::InspectServiceWorker); } } // namespace api diff --git a/atom/browser/api/lib/browser-window.coffee b/atom/browser/api/lib/browser-window.coffee index 93e744233885..803fb9207c42 100644 --- a/atom/browser/api/lib/browser-window.coffee +++ b/atom/browser/api/lib/browser-window.coffee @@ -55,6 +55,14 @@ BrowserWindow::openDevTools = (options={}) -> BrowserWindow::toggleDevTools = -> if @isDevToolsOpened() then @closeDevTools() else @openDevTools() +BrowserWindow::inspectElement = (x, y) -> + @openDevTools true + @_inspectElement x, y + +BrowserWindow::inspectServiceWorker = -> + @openDevTools true + @_inspectServiceWorker() + BrowserWindow::getWebContents = -> wrapWebContents @_getWebContents() diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 7fb0de344472..ab6b08e8d4a9 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -308,7 +308,6 @@ bool NativeWindow::IsDevToolsOpened() { } void NativeWindow::InspectElement(int x, int y) { - OpenDevTools(true); scoped_refptr agent( content::DevToolsAgentHost::GetOrCreateFor(GetWebContents())); agent->InspectElement(x, y); @@ -318,7 +317,6 @@ void NativeWindow::InspectServiceWorker() { for (const auto& agent_host : content::DevToolsAgentHost::GetOrCreateAll()) { if (agent_host->GetType() == content::DevToolsAgentHost::TYPE_SERVICE_WORKER) { - OpenDevTools(true); inspectable_web_contents()->AttachTo(agent_host); break; } From 317406f26d9e079e3ca02846816a13d3ca4fba10 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Tue, 2 Jun 2015 11:41:47 +0800 Subject: [PATCH 0126/1293] Update crashpad implementation after code review. --- .../crash_reporter/crash_reporter_mac.h | 14 ++++++ .../crash_reporter/crash_reporter_mac.mm | 43 ++++++++----------- common.gypi | 1 - 3 files changed, 31 insertions(+), 27 deletions(-) diff --git a/atom/common/crash_reporter/crash_reporter_mac.h b/atom/common/crash_reporter/crash_reporter_mac.h index 53202c0f174f..86f216bf5575 100644 --- a/atom/common/crash_reporter/crash_reporter_mac.h +++ b/atom/common/crash_reporter/crash_reporter_mac.h @@ -9,9 +9,16 @@ #include "atom/common/crash_reporter/crash_reporter.h" #include "base/compiler_specific.h" +#include "base/memory/scoped_ptr.h" +#include "base/strings/string_piece.h" +#include "vendor/crashpad/client/simple_string_dictionary.h" template struct DefaultSingletonTraits; +namespace crashpad { +class CrashReportDatabase; +} + namespace crash_reporter { class CrashReporterMac : public CrashReporter { @@ -32,6 +39,13 @@ class CrashReporterMac : public CrashReporter { CrashReporterMac(); virtual ~CrashReporterMac(); + void SetUploadsEnabled(bool enable_uploads); + void SetCrashKeyValue(const base::StringPiece& key, + const base::StringPiece& value); + + scoped_ptr simple_string_dictionary_; + scoped_ptr crash_report_database_; + DISALLOW_COPY_AND_ASSIGN(CrashReporterMac); }; diff --git a/atom/common/crash_reporter/crash_reporter_mac.mm b/atom/common/crash_reporter/crash_reporter_mac.mm index 0e6635cafbbc..fe55475c051e 100644 --- a/atom/common/crash_reporter/crash_reporter_mac.mm +++ b/atom/common/crash_reporter/crash_reporter_mac.mm @@ -19,25 +19,6 @@ namespace crash_reporter { -namespace { - -crashpad::SimpleStringDictionary* g_simple_string_dictionary; -crashpad::CrashReportDatabase* g_database; - -void SetUploadsEnabled(bool enable_uploads) { - if (g_database) { - crashpad::Settings* settings = g_database->GetSettings(); - settings->SetUploadsEnabled(enable_uploads); - } -} - -void SetCrashKeyValue(const base::StringPiece& key, - const base::StringPiece& value) { - g_simple_string_dictionary->SetKeyValue(key.data(), value.data()); -} - -} // namespace - CrashReporterMac::CrashReporterMac() { } @@ -64,12 +45,10 @@ void CrashReporterMac::InitBreakpad(const std::string& product_name, framework_bundle_path.Append("Resources").Append("crashpad_handler"); crashpad::CrashpadClient crashpad_client; - // Send all crash reports. - std::vector arguments = { "--upload-internal=0" }; if (crashpad_client.StartHandler(handler_path, database_path, submit_url, StringMap(), - arguments)) { + std::vector())) { crashpad_client.UseHandler(); } } // @autoreleasepool @@ -82,8 +61,8 @@ void CrashReporterMac::InitBreakpad(const std::string& product_name, crashpad::TriState::kDisabled); } - g_simple_string_dictionary = new crashpad::SimpleStringDictionary(); - crashpad_info->set_simple_annotations(g_simple_string_dictionary); + simple_string_dictionary_.reset(new crashpad::SimpleStringDictionary()); + crashpad_info->set_simple_annotations(simple_string_dictionary_.get()); SetCrashKeyValue("prod", ATOM_PRODUCT_NAME); SetCrashKeyValue("process_type", is_browser_ ? base::StringPiece("browser") @@ -95,8 +74,8 @@ void CrashReporterMac::InitBreakpad(const std::string& product_name, SetCrashKeyValue(iter->first, iter->second); } if (is_browser_) { - g_database = - crashpad::CrashReportDatabase::Initialize(database_path).release(); + crash_report_database_ = crashpad::CrashReportDatabase::Initialize( + database_path); SetUploadsEnabled(auto_submit); } } @@ -105,6 +84,18 @@ void CrashReporterMac::SetUploadParameters() { upload_parameters_["platform"] = "darwin"; } +void CrashReporterMac::SetUploadsEnabled(bool enable_uploads) { + if (crash_report_database_) { + crashpad::Settings* settings = crash_report_database_->GetSettings(); + settings->SetUploadsEnabled(enable_uploads); + } +} + +void CrashReporterMac::SetCrashKeyValue(const base::StringPiece& key, + const base::StringPiece& value) { + simple_string_dictionary_->SetKeyValue(key.data(), value.data()); +} + // static CrashReporterMac* CrashReporterMac::GetInstance() { return Singleton::get(); diff --git a/common.gypi b/common.gypi index 1bd88828ea77..c6f3320c0a5b 100644 --- a/common.gypi +++ b/common.gypi @@ -30,7 +30,6 @@ 'v8_enable_i18n_support': 'false', # Required by Linux (empty for now, should support it in future). 'sysroot': '', - 'crashpad_standalone': 1, }, # Settings to compile node under Windows. 'target_defaults': { From 2396b51cb6e21d2e5fcb41cb05b425e1adf35402 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Tue, 2 Jun 2015 11:46:20 +0800 Subject: [PATCH 0127/1293] Switch to use crashpad repo under atom org. --- .gitmodules | 3 +++ script/bootstrap.py | 15 --------------- 2 files changed, 3 insertions(+), 15 deletions(-) diff --git a/.gitmodules b/.gitmodules index 2a1f087e7446..7c26c6c2c12d 100644 --- a/.gitmodules +++ b/.gitmodules @@ -13,3 +13,6 @@ [submodule "vendor/native_mate"] path = vendor/native_mate url = https://github.com/zcbenz/native-mate.git +[submodule "vendor/crashpad"] + path = vendor/crashpad + url = https://github.com/atom/crashpad.git diff --git a/script/bootstrap.py b/script/bootstrap.py index 88dfaad53d7f..f67a790a04ce 100755 --- a/script/bootstrap.py +++ b/script/bootstrap.py @@ -12,7 +12,6 @@ from lib.util import execute_stdout, get_atom_shell_version, scoped_cwd SOURCE_ROOT = os.path.abspath(os.path.dirname(os.path.dirname(__file__))) VENDOR_DIR = os.path.join(SOURCE_ROOT, 'vendor') PYTHON_26_URL = 'https://chromium.googlesource.com/chromium/deps/python_26' -CRACKPAD_URL = 'https://github.com/hokein/crashpad.git' NPM = 'npm.cmd' if sys.platform in ['win32', 'cygwin'] else 'npm' @@ -28,8 +27,6 @@ def main(): update_win32_python() update_submodules() update_node_modules('.') - if sys.platform == 'darwin': - update_crashpad() bootstrap_brightray(args.dev, args.url, args.target_arch) create_chrome_version_h() @@ -95,18 +92,6 @@ def update_node_modules(dirname, env=None): execute_stdout([NPM, 'install'], env) -def update_crashpad(): - gclient = os.path.join(VENDOR_DIR, 'depot_tools', 'gclient.py') - args = [ - 'config', - '--unmanaged', - CRACKPAD_URL, - ] - with scoped_cwd(VENDOR_DIR): - execute_stdout([sys.executable, gclient] + args) - execute_stdout([sys.executable, gclient] + ['sync']) - - def update_electron_modules(dirname, target_arch): env = os.environ.copy() env['npm_config_arch'] = target_arch From ce8aa073eedc61b14bc10222ba3942f505379c61 Mon Sep 17 00:00:00 2001 From: Seppe Stas Date: Tue, 2 Jun 2015 21:43:37 +0200 Subject: [PATCH 0128/1293] Added `bounds` payload to tray `clicked` event Used [Shell_NotifyIconGetRect function](https://msdn.microsoft.com/en-us/library/windows/desktop/dd378426) to get the bounds of the application's tray icon. Note: only works with Windows 7 and later. Related to #1159, #1500. --- atom/browser/ui/win/notify_icon.cc | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/atom/browser/ui/win/notify_icon.cc b/atom/browser/ui/win/notify_icon.cc index 99b7153631af..bce258901861 100644 --- a/atom/browser/ui/win/notify_icon.cc +++ b/atom/browser/ui/win/notify_icon.cc @@ -49,7 +49,18 @@ void NotifyIcon::HandleClickEvent(const gfx::Point& cursor_pos, bool left_mouse_click) { // Pass to the observer if appropriate. if (left_mouse_click) { - NotifyClicked(); + NOTIFYICONIDENTIFIER icon_id; + memset(&icon_id, 0, sizeof(NOTIFYICONIDENTIFIER)); + icon_id.uID = icon_id_; + icon_id.hWnd = window_; + icon_id.cbSize = sizeof(NOTIFYICONIDENTIFIER); + + RECT rect; + Shell_NotifyIconGetRect(&icon_id, &rect); + + int width = rect.right - rect.left; + int height = rect.bottom - rect.top; + NotifyClicked(gfx::Rect(rect.left, rect.top, width, height)); return; } From e920ce3e243790c0548f0602098872734e17ae66 Mon Sep 17 00:00:00 2001 From: Seppe Stas Date: Tue, 2 Jun 2015 23:19:49 +0200 Subject: [PATCH 0129/1293] Updated tray api docs to reflect changes in ce8aa07 --- docs/api/tray.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/tray.md b/docs/api/tray.md index ae2a471856e9..d85ac1a1dac8 100644 --- a/docs/api/tray.md +++ b/docs/api/tray.md @@ -55,7 +55,7 @@ Creates a new tray icon associated with the `image`. Emitted when the tray icon is clicked. -__Note:__ The `bounds` payload is only implemented on OS X. +__Note:__ The `bounds` payload is only implemented on OS X and Windows 7 or newer. ### Event: 'double-clicked' From 4457edb1d31e7e211778b28a8167f01accd7e0fd Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Wed, 3 Jun 2015 09:47:42 +0800 Subject: [PATCH 0130/1293] Implement crash-reporter.getLastLastCrashReport API on OS X. --- atom/common/api/atom_api_crash_reporter.cc | 25 ++++++++++++++ atom/common/api/lib/crash-reporter.coffee | 4 +++ atom/common/crash_reporter/crash_reporter.cc | 4 +++ atom/common/crash_reporter/crash_reporter.h | 4 +++ .../crash_reporter/crash_reporter_mac.h | 2 ++ .../crash_reporter/crash_reporter_mac.mm | 33 +++++++++++++++++++ 6 files changed, 72 insertions(+) diff --git a/atom/common/api/atom_api_crash_reporter.cc b/atom/common/api/atom_api_crash_reporter.cc index 9386dda8637e..e396356cdbb8 100644 --- a/atom/common/api/atom_api_crash_reporter.cc +++ b/atom/common/api/atom_api_crash_reporter.cc @@ -31,10 +31,34 @@ struct Converter > { } }; +template<> +struct Converter > { + static v8::Local ToV8(v8::Isolate* isolate, + const std::vector< + crash_reporter::CrashReporter::UploadReportResult>& reports) { + v8::Local result(v8::Array::New(isolate, reports.size())); + for (size_t i = 0; i < reports.size(); ++i) { + mate::Dictionary dict(isolate, v8::Object::New(isolate)); + dict.Set("date", reports[i].first); + dict.Set("id", reports[i].second); + v8::TryCatch try_catch; + result->Set(static_cast(i), dict.GetHandle()); + if (try_catch.HasCaught()) + LOG(ERROR) << "Setter for index " << i << " threw an exception."; + } + return result; + } +}; + } // namespace mate namespace { +std::vector +GetUploadedReports() { + return (crash_reporter::CrashReporter::GetInstance())->GetUploadedReports(); +} + void Initialize(v8::Local exports, v8::Local unused, v8::Local context, void* priv) { using crash_reporter::CrashReporter; @@ -42,6 +66,7 @@ void Initialize(v8::Local exports, v8::Local unused, dict.SetMethod("start", base::Bind(&CrashReporter::Start, base::Unretained(CrashReporter::GetInstance()))); + dict.SetMethod("_getUploadedReports", &GetUploadedReports); } } // namespace diff --git a/atom/common/api/lib/crash-reporter.coffee b/atom/common/api/lib/crash-reporter.coffee index d87ff9ea772f..c151ff7f71c8 100644 --- a/atom/common/api/lib/crash-reporter.coffee +++ b/atom/common/api/lib/crash-reporter.coffee @@ -41,6 +41,10 @@ class CrashReporter start() getLastCrashReport: -> + if process.platform is 'darwin' + reports = binding._getUploadedReports() + return if reports.length > 0 then reports[0] else null + tmpdir = if process.platform is 'win32' os.tmpdir() diff --git a/atom/common/crash_reporter/crash_reporter.cc b/atom/common/crash_reporter/crash_reporter.cc index 0a02086056b8..5d1e2146cc86 100644 --- a/atom/common/crash_reporter/crash_reporter.cc +++ b/atom/common/crash_reporter/crash_reporter.cc @@ -39,4 +39,8 @@ void CrashReporter::SetUploadParameters(const StringMap& parameters) { SetUploadParameters(); } +std::vector CrashReporter::GetUploadedReports() { + return std::vector(); +} + } // namespace crash_reporter diff --git a/atom/common/crash_reporter/crash_reporter.h b/atom/common/crash_reporter/crash_reporter.h index 43548a105b6c..c81111b596bd 100644 --- a/atom/common/crash_reporter/crash_reporter.h +++ b/atom/common/crash_reporter/crash_reporter.h @@ -7,6 +7,7 @@ #include #include +#include #include "base/basictypes.h" @@ -15,6 +16,7 @@ namespace crash_reporter { class CrashReporter { public: typedef std::map StringMap; + typedef std::pair UploadReportResult; // upload-date, id static CrashReporter* GetInstance(); @@ -25,6 +27,8 @@ class CrashReporter { bool skip_system_crash_handler, const StringMap& extra_parameters); + virtual std::vector GetUploadedReports(); + protected: CrashReporter(); virtual ~CrashReporter(); diff --git a/atom/common/crash_reporter/crash_reporter_mac.h b/atom/common/crash_reporter/crash_reporter_mac.h index 86f216bf5575..25eb0e28ba95 100644 --- a/atom/common/crash_reporter/crash_reporter_mac.h +++ b/atom/common/crash_reporter/crash_reporter_mac.h @@ -43,6 +43,8 @@ class CrashReporterMac : public CrashReporter { void SetCrashKeyValue(const base::StringPiece& key, const base::StringPiece& value); + std::vector GetUploadedReports() override; + scoped_ptr simple_string_dictionary_; scoped_ptr crash_report_database_; diff --git a/atom/common/crash_reporter/crash_reporter_mac.mm b/atom/common/crash_reporter/crash_reporter_mac.mm index fe55475c051e..3cb3063d079b 100644 --- a/atom/common/crash_reporter/crash_reporter_mac.mm +++ b/atom/common/crash_reporter/crash_reporter_mac.mm @@ -96,6 +96,39 @@ void CrashReporterMac::SetCrashKeyValue(const base::StringPiece& key, simple_string_dictionary_->SetKeyValue(key.data(), value.data()); } +std::vector +CrashReporterMac::GetUploadedReports() { + std::vector uploaded_reports; + + if (!crash_report_database_) { + return uploaded_reports; + } + + std::vector completed_reports; + crashpad::CrashReportDatabase::OperationStatus status = + crash_report_database_->GetCompletedReports(&completed_reports); + if (status != crashpad::CrashReportDatabase::kNoError) { + return uploaded_reports; + } + + for (const crashpad::CrashReportDatabase::Report& completed_report : + completed_reports) { + if (completed_report.uploaded) { + uploaded_reports.push_back( + UploadReportResult(static_cast(completed_report.creation_time), + completed_report.id)); + } + } + + struct { + bool operator()(const UploadReportResult& a, const UploadReportResult& b) { + return a.first >= b.first; + } + } sort_by_time; + std::sort(uploaded_reports.begin(), uploaded_reports.end(), sort_by_time); + return uploaded_reports; +} + // static CrashReporterMac* CrashReporterMac::GetInstance() { return Singleton::get(); From bd6d41bd87fdf9d0c433075fdf2edb5ec3e810d5 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 3 Jun 2015 10:00:29 +0800 Subject: [PATCH 0131/1293] Update brightray for updates on devtools_ui --- vendor/brightray | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/brightray b/vendor/brightray index 7391c76630ad..88f063c1b432 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit 7391c76630ad514ee8c9a7e0d5e7932b60f38ab1 +Subproject commit 88f063c1b432f124ffe4eb9ca68ee4b76a5fdf02 From d46e986e80e1ff8de783eebb1519c1930d906df8 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 3 Jun 2015 10:08:05 +0800 Subject: [PATCH 0132/1293] Remove AtomResourceDispatcherHostDelegate --- atom/browser/atom_browser_client.cc | 8 ----- atom/browser/atom_browser_client.h | 5 --- .../atom_resource_dispatcher_host_delegate.cc | 33 ------------------- .../atom_resource_dispatcher_host_delegate.h | 30 ----------------- filenames.gypi | 2 -- 5 files changed, 78 deletions(-) delete mode 100644 atom/browser/atom_resource_dispatcher_host_delegate.cc delete mode 100644 atom/browser/atom_resource_dispatcher_host_delegate.h diff --git a/atom/browser/atom_browser_client.cc b/atom/browser/atom_browser_client.cc index 763a2b4b0952..69f745ac7a72 100644 --- a/atom/browser/atom_browser_client.cc +++ b/atom/browser/atom_browser_client.cc @@ -8,7 +8,6 @@ #include "atom/browser/atom_browser_context.h" #include "atom/browser/atom_browser_main_parts.h" #include "atom/browser/atom_quota_permission_context.h" -#include "atom/browser/atom_resource_dispatcher_host_delegate.h" #include "atom/browser/atom_speech_recognition_manager_delegate.h" #include "atom/browser/native_window.h" #include "atom/browser/web_view_manager.h" @@ -22,7 +21,6 @@ #include "content/public/browser/browser_ppapi_host.h" #include "content/public/browser/render_process_host.h" #include "content/public/browser/render_view_host.h" -#include "content/public/browser/resource_dispatcher_host.h" #include "content/public/browser/site_instance.h" #include "content/public/browser/web_contents.h" #include "content/public/common/web_preferences.h" @@ -83,12 +81,6 @@ content::AccessTokenStore* AtomBrowserClient::CreateAccessTokenStore() { return new AtomAccessTokenStore; } -void AtomBrowserClient::ResourceDispatcherHostCreated() { - resource_dispatcher_delegate_.reset(new AtomResourceDispatcherHostDelegate); - content::ResourceDispatcherHost::Get()->SetDelegate( - resource_dispatcher_delegate_.get()); -} - void AtomBrowserClient::OverrideWebkitPrefs( content::RenderViewHost* render_view_host, content::WebPreferences* prefs) { diff --git a/atom/browser/atom_browser_client.h b/atom/browser/atom_browser_client.h index 6d77eabc5a99..a505daaea5cc 100644 --- a/atom/browser/atom_browser_client.h +++ b/atom/browser/atom_browser_client.h @@ -15,8 +15,6 @@ class QuotaPermissionContext; namespace atom { -class AtomResourceDispatcherHostDelegate; - class AtomBrowserClient : public brightray::BrowserClient { public: AtomBrowserClient(); @@ -31,7 +29,6 @@ class AtomBrowserClient : public brightray::BrowserClient { content::SpeechRecognitionManagerDelegate* CreateSpeechRecognitionManagerDelegate() override; content::AccessTokenStore* CreateAccessTokenStore() override; - void ResourceDispatcherHostCreated() override; void OverrideWebkitPrefs(content::RenderViewHost* render_view_host, content::WebPreferences* prefs) override; std::string GetApplicationLocale() override; @@ -49,8 +46,6 @@ class AtomBrowserClient : public brightray::BrowserClient { brightray::BrowserMainParts* OverrideCreateBrowserMainParts( const content::MainFunctionParams&) override; - scoped_ptr resource_dispatcher_delegate_; - // The render process which would be swapped out soon. content::RenderProcessHost* dying_render_process_; diff --git a/atom/browser/atom_resource_dispatcher_host_delegate.cc b/atom/browser/atom_resource_dispatcher_host_delegate.cc deleted file mode 100644 index 95335abcc576..000000000000 --- a/atom/browser/atom_resource_dispatcher_host_delegate.cc +++ /dev/null @@ -1,33 +0,0 @@ -// Copyright (c) 2014 GitHub, Inc. All rights reserved. -// Use of this source code is governed by the MIT license that can be -// found in the LICENSE file. - -#include "atom/browser/atom_resource_dispatcher_host_delegate.h" - -#include - -#include "base/logging.h" -#include "content/public/browser/render_frame_host.h" -#include "content/public/browser/resource_request_info.h" -#include "net/http/http_response_headers.h" -#include "net/url_request/url_request.h" - -namespace atom { - -AtomResourceDispatcherHostDelegate::AtomResourceDispatcherHostDelegate() { -} - -void AtomResourceDispatcherHostDelegate::OnResponseStarted( - net::URLRequest* request, - content::ResourceContext* resource_context, - content::ResourceResponse* response, - IPC::Sender* sender) { - // Remove the "X-Frame-Options" from response headers for devtools. - if (request->url().SchemeIs("chrome-devtools")) { - net::HttpResponseHeaders* response_headers = request->response_headers(); - if (response_headers && response_headers->HasHeader("x-frame-options")) - response_headers->RemoveHeader("x-frame-options"); - } -} - -} // namespace atom diff --git a/atom/browser/atom_resource_dispatcher_host_delegate.h b/atom/browser/atom_resource_dispatcher_host_delegate.h deleted file mode 100644 index 12032444bce1..000000000000 --- a/atom/browser/atom_resource_dispatcher_host_delegate.h +++ /dev/null @@ -1,30 +0,0 @@ -// Copyright (c) 2014 GitHub, Inc. All rights reserved. -// Use of this source code is governed by the MIT license that can be -// found in the LICENSE file. - -#ifndef ATOM_BROWSER_ATOM_RESOURCE_DISPATCHER_HOST_DELEGATE_H_ -#define ATOM_BROWSER_ATOM_RESOURCE_DISPATCHER_HOST_DELEGATE_H_ - -#include "base/compiler_specific.h" -#include "content/public/browser/resource_dispatcher_host_delegate.h" - -namespace atom { - -class AtomResourceDispatcherHostDelegate - : public content::ResourceDispatcherHostDelegate { - public: - AtomResourceDispatcherHostDelegate(); - - // content::ResourceDispatcherHostDelegate: - void OnResponseStarted(net::URLRequest* request, - content::ResourceContext* resource_context, - content::ResourceResponse* response, - IPC::Sender* sender) override; - - private: - DISALLOW_COPY_AND_ASSIGN(AtomResourceDispatcherHostDelegate); -}; - -} // namespace atom - -#endif // ATOM_BROWSER_ATOM_RESOURCE_DISPATCHER_HOST_DELEGATE_H_ diff --git a/filenames.gypi b/filenames.gypi index 13b75d79fa61..2bef38832548 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -115,8 +115,6 @@ 'atom/browser/atom_javascript_dialog_manager.h', 'atom/browser/atom_quota_permission_context.cc', 'atom/browser/atom_quota_permission_context.h', - 'atom/browser/atom_resource_dispatcher_host_delegate.cc', - 'atom/browser/atom_resource_dispatcher_host_delegate.h', 'atom/browser/atom_speech_recognition_manager_delegate.cc', 'atom/browser/atom_speech_recognition_manager_delegate.h', 'atom/browser/browser.cc', From 981908c33629b2224fb432be0a83e3fb3ee3f0ae Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Wed, 3 Jun 2015 11:13:20 +0800 Subject: [PATCH 0133/1293] Add missing crashpad submodule. --- vendor/crashpad | 1 + 1 file changed, 1 insertion(+) create mode 160000 vendor/crashpad diff --git a/vendor/crashpad b/vendor/crashpad new file mode 160000 index 000000000000..e6a0d433b0ee --- /dev/null +++ b/vendor/crashpad @@ -0,0 +1 @@ +Subproject commit e6a0d433b0ee399eecce2bef671794771052ffdb From 94382cbaa27c7130a832989ac19dd60c0a143697 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Wed, 3 Jun 2015 11:31:34 +0800 Subject: [PATCH 0134/1293] Fix cpplint error. --- atom/common/api/atom_api_crash_reporter.cc | 13 ++++++------- atom/common/crash_reporter/crash_reporter.cc | 3 ++- atom/common/crash_reporter/crash_reporter.h | 3 ++- atom/common/crash_reporter/crash_reporter_mac.h | 1 + 4 files changed, 11 insertions(+), 9 deletions(-) diff --git a/atom/common/api/atom_api_crash_reporter.cc b/atom/common/api/atom_api_crash_reporter.cc index e396356cdbb8..4b51a88b9f3d 100644 --- a/atom/common/api/atom_api_crash_reporter.cc +++ b/atom/common/api/atom_api_crash_reporter.cc @@ -11,6 +11,8 @@ #include "atom/common/node_includes.h" +using crash_reporter::CrashReporter; + namespace mate { template<> @@ -32,10 +34,9 @@ struct Converter > { }; template<> -struct Converter > { +struct Converter > { static v8::Local ToV8(v8::Isolate* isolate, - const std::vector< - crash_reporter::CrashReporter::UploadReportResult>& reports) { + const std::vector& reports) { v8::Local result(v8::Array::New(isolate, reports.size())); for (size_t i = 0; i < reports.size(); ++i) { mate::Dictionary dict(isolate, v8::Object::New(isolate)); @@ -54,14 +55,12 @@ struct Converter namespace { -std::vector -GetUploadedReports() { - return (crash_reporter::CrashReporter::GetInstance())->GetUploadedReports(); +std::vector GetUploadedReports() { + return (CrashReporter::GetInstance())->GetUploadedReports(); } void Initialize(v8::Local exports, v8::Local unused, v8::Local context, void* priv) { - using crash_reporter::CrashReporter; mate::Dictionary dict(context->GetIsolate(), exports); dict.SetMethod("start", base::Bind(&CrashReporter::Start, diff --git a/atom/common/crash_reporter/crash_reporter.cc b/atom/common/crash_reporter/crash_reporter.cc index 5d1e2146cc86..25dbf6065d96 100644 --- a/atom/common/crash_reporter/crash_reporter.cc +++ b/atom/common/crash_reporter/crash_reporter.cc @@ -39,7 +39,8 @@ void CrashReporter::SetUploadParameters(const StringMap& parameters) { SetUploadParameters(); } -std::vector CrashReporter::GetUploadedReports() { +std::vector +CrashReporter::GetUploadedReports() { return std::vector(); } diff --git a/atom/common/crash_reporter/crash_reporter.h b/atom/common/crash_reporter/crash_reporter.h index c81111b596bd..6cfa5b3f3a59 100644 --- a/atom/common/crash_reporter/crash_reporter.h +++ b/atom/common/crash_reporter/crash_reporter.h @@ -7,6 +7,7 @@ #include #include +#include #include #include "base/basictypes.h" @@ -16,7 +17,7 @@ namespace crash_reporter { class CrashReporter { public: typedef std::map StringMap; - typedef std::pair UploadReportResult; // upload-date, id + typedef std::pair UploadReportResult; // upload-date, id static CrashReporter* GetInstance(); diff --git a/atom/common/crash_reporter/crash_reporter_mac.h b/atom/common/crash_reporter/crash_reporter_mac.h index 25eb0e28ba95..ca31237cc154 100644 --- a/atom/common/crash_reporter/crash_reporter_mac.h +++ b/atom/common/crash_reporter/crash_reporter_mac.h @@ -6,6 +6,7 @@ #define ATOM_COMMON_CRASH_REPORTER_CRASH_REPORTER_MAC_H_ #include +#include #include "atom/common/crash_reporter/crash_reporter.h" #include "base/compiler_specific.h" From 6dfa7b5383248ab9444aa3b803360c7a9e384773 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 3 Jun 2015 13:45:06 +0800 Subject: [PATCH 0135/1293] Don't rely on guest_process_id for searching guest --- atom/browser/atom_browser_client.cc | 128 ++++++++++++---------------- atom/browser/web_view_manager.cc | 50 +++++------ atom/browser/web_view_manager.h | 14 ++- 3 files changed, 80 insertions(+), 112 deletions(-) diff --git a/atom/browser/atom_browser_client.cc b/atom/browser/atom_browser_client.cc index 69f745ac7a72..f987cec5ac5e 100644 --- a/atom/browser/atom_browser_client.cc +++ b/atom/browser/atom_browser_client.cc @@ -34,22 +34,33 @@ namespace { // Next navigation should not restart renderer process. bool g_suppress_renderer_process_restart = false; -struct FindByProcessId { - explicit FindByProcessId(int child_process_id) - : child_process_id_(child_process_id) { - } - - bool operator() (NativeWindow* const window) { - content::WebContents* web_contents = window->GetWebContents(); - if (!web_contents) - return false; - - int id = window->GetWebContents()->GetRenderProcessHost()->GetID(); - return id == child_process_id_; - } - - int child_process_id_; +// Find out the owner of the child process according to child_process_id. +enum ChildProcessOwner { + OWNER_NATIVE_WINDOW, + OWNER_GUEST_WEB_CONTENTS, + OWNER_NONE, // it might be devtools though. }; +ChildProcessOwner GetChildProcessOwner(int process_id, + NativeWindow** window, + WebViewManager::WebViewInfo* info) { + // First search for NativeWindow. + for (auto native_window : *WindowList::GetInstance()) { + content::WebContents* web_contents = native_window->GetWebContents(); + if (web_contents && + process_id == web_contents->GetRenderProcessHost()->GetID()) { + *window = native_window; + return OWNER_NATIVE_WINDOW; + } + } + + // Then search for guest WebContents. + auto process = content::RenderProcessHost::FromID(process_id); + if (WebViewManager::GetInfoForProcess(process, info)) { + return OWNER_GUEST_WEB_CONTENTS; + } + + return OWNER_NONE; +} } // namespace @@ -82,8 +93,7 @@ content::AccessTokenStore* AtomBrowserClient::CreateAccessTokenStore() { } void AtomBrowserClient::OverrideWebkitPrefs( - content::RenderViewHost* render_view_host, - content::WebPreferences* prefs) { + content::RenderViewHost* host, content::WebPreferences* prefs) { prefs->javascript_enabled = true; prefs->web_security_enabled = true; prefs->javascript_can_open_windows_automatically = true; @@ -102,17 +112,15 @@ void AtomBrowserClient::OverrideWebkitPrefs( prefs->allow_running_insecure_content = false; // Turn off web security for devtools. - auto web_contents = content::WebContents::FromRenderViewHost( - render_view_host); + auto web_contents = content::WebContents::FromRenderViewHost(host); if (web_contents && web_contents->GetURL().SchemeIs("chrome-devtools")) { prefs->web_security_enabled = false; return; } // Custom preferences of guest page. - auto process = render_view_host->GetProcess(); WebViewManager::WebViewInfo info; - if (WebViewManager::GetInfoForProcess(process, &info)) { + if (WebViewManager::GetInfoForWebContents(web_contents, &info)) { prefs->web_security_enabled = !info.disable_web_security; return; } @@ -136,73 +144,47 @@ void AtomBrowserClient::OverrideSiteInstanceForNavigation( return; } + // Restart renderer process for all navigations except "javacript:" scheme. + if (url.SchemeIs(url::kJavaScriptScheme)) + return; + if (current_instance->HasProcess()) dying_render_process_ = current_instance->GetProcess(); - - if (!url.SchemeIs(url::kJavaScriptScheme)) { - // Restart renderer process for all navigations except javacript: scheme. - *new_instance = content::SiteInstance::CreateForURL(browser_context, url); - } + *new_instance = content::SiteInstance::CreateForURL(browser_context, url); } void AtomBrowserClient::AppendExtraCommandLineSwitches( base::CommandLine* command_line, - int child_process_id) { + int process_id) { std::string process_type = command_line->GetSwitchValueASCII("type"); if (process_type != "renderer") return; - WindowList* list = WindowList::GetInstance(); - NativeWindow* window = nullptr; + NativeWindow* window; + WebViewManager::WebViewInfo info; + ChildProcessOwner owner = GetChildProcessOwner(process_id, &window, &info); - // Find the owner of this child process. - WindowList::const_iterator iter = std::find_if( - list->begin(), list->end(), FindByProcessId(child_process_id)); - if (iter != list->end()) - window = *iter; - - // If the render process is a newly started one, which means the window still + // If the render process is a newly started one, which means the owner still // uses the old going-to-be-swapped render process, then we try to find the - // window from the swapped render process. - if (!window && dying_render_process_) { - int dying_process_id = dying_render_process_->GetID(); - WindowList::const_iterator iter = std::find_if( - list->begin(), list->end(), FindByProcessId(dying_process_id)); - if (iter != list->end()) { - window = *iter; - child_process_id = dying_process_id; - } else { - // It appears that the dying process doesn't belong to a BrowserWindow, - // then it might be a guest process, if it is we should update its - // process ID in the WebViewManager. - auto child_process = content::RenderProcessHost::FromID(child_process_id); - // Update the process ID in webview guests. - WebViewManager::UpdateGuestProcessID(dying_render_process_, - child_process); - } + // owner from the swapped render process. + if (owner == OWNER_NONE) { + process_id = dying_render_process_->GetID(); + owner = GetChildProcessOwner(process_id, &window, &info); } - if (window) { - window->AppendExtraCommandLineSwitches(command_line, child_process_id); - } else { - // Append commnad line arguments for guest web view. - auto child_process = content::RenderProcessHost::FromID(child_process_id); - WebViewManager::WebViewInfo info; - if (WebViewManager::GetInfoForProcess(child_process, &info)) { - command_line->AppendSwitchASCII( - switches::kGuestInstanceID, - base::IntToString(info.guest_instance_id)); - command_line->AppendSwitchASCII( - switches::kNodeIntegration, - info.node_integration ? "true" : "false"); - if (info.plugins) - command_line->AppendSwitch(switches::kEnablePlugins); - if (!info.preload_script.empty()) - command_line->AppendSwitchPath( - switches::kPreloadScript, - info.preload_script); - } + if (owner == OWNER_NATIVE_WINDOW) { + window->AppendExtraCommandLineSwitches(command_line, process_id); + } else if (owner == OWNER_GUEST_WEB_CONTENTS) { + command_line->AppendSwitchASCII( + switches::kGuestInstanceID, base::IntToString(info.guest_instance_id)); + command_line->AppendSwitchASCII( + switches::kNodeIntegration, info.node_integration ? "true" : "false"); + if (info.plugins) + command_line->AppendSwitch(switches::kEnablePlugins); + if (!info.preload_script.empty()) + command_line->AppendSwitchPath( + switches::kPreloadScript, info.preload_script); } dying_render_process_ = nullptr; diff --git a/atom/browser/web_view_manager.cc b/atom/browser/web_view_manager.cc index 77a772da9adf..0ce31ffe0c8c 100644 --- a/atom/browser/web_view_manager.cc +++ b/atom/browser/web_view_manager.cc @@ -29,23 +29,27 @@ bool WebViewManager::GetInfoForProcess(content::RenderProcessHost* process, auto manager = GetManagerFromProcess(process); if (!manager) return false; - return manager->GetInfo(process->GetID(), info); + base::AutoLock auto_lock(manager->lock_); + for (auto iter : manager->webview_info_map_) + if (iter.first->GetRenderProcessHost() == process) { + *info = iter.second; + return true; + } + return false; } // static -void WebViewManager::UpdateGuestProcessID( - content::RenderProcessHost* old_process, - content::RenderProcessHost* new_process) { - auto manager = GetManagerFromProcess(old_process); - if (manager) { - base::AutoLock auto_lock(manager->lock_); - int old_id = old_process->GetID(); - int new_id = new_process->GetID(); - if (!ContainsKey(manager->webview_info_map_, old_id)) - return; - manager->webview_info_map_[new_id] = manager->webview_info_map_[old_id]; - manager->webview_info_map_.erase(old_id); - } +bool WebViewManager::GetInfoForWebContents(content::WebContents* web_contents, + WebViewInfo* info) { + auto manager = GetManagerFromProcess(web_contents->GetRenderProcessHost()); + if (!manager) + return false; + base::AutoLock auto_lock(manager->lock_); + auto iter = manager->webview_info_map_.find(web_contents); + if (iter == manager->webview_info_map_.end()) + return false; + *info = iter->second; + return true; } WebViewManager::WebViewManager(content::BrowserContext* context) { @@ -61,9 +65,7 @@ void WebViewManager::AddGuest(int guest_instance_id, const WebViewInfo& info) { base::AutoLock auto_lock(lock_); web_contents_embdder_map_[guest_instance_id] = { web_contents, embedder }; - - int guest_process_id = web_contents->GetRenderProcessHost()->GetID(); - webview_info_map_[guest_process_id] = info; + webview_info_map_[web_contents] = info; // Map the element in embedder to guest. int owner_process_id = embedder->GetRenderProcessHost()->GetID(); @@ -78,9 +80,7 @@ void WebViewManager::RemoveGuest(int guest_instance_id) { auto web_contents = web_contents_embdder_map_[guest_instance_id].web_contents; web_contents_embdder_map_.erase(guest_instance_id); - - int guest_process_id = web_contents->GetRenderProcessHost()->GetID(); - webview_info_map_.erase(guest_process_id); + webview_info_map_.erase(web_contents); // Remove the record of element in embedder too. for (const auto& element : element_instance_id_to_guest_map_) @@ -90,16 +90,6 @@ void WebViewManager::RemoveGuest(int guest_instance_id) { } } -bool WebViewManager::GetInfo(int guest_process_id, WebViewInfo* webview_info) { - base::AutoLock auto_lock(lock_); - WebViewInfoMap::iterator iter = webview_info_map_.find(guest_process_id); - if (iter != webview_info_map_.end()) { - *webview_info = iter->second; - return true; - } - return false; -} - content::WebContents* WebViewManager::GetGuestByInstanceID( int owner_process_id, int element_instance_id) { diff --git a/atom/browser/web_view_manager.h b/atom/browser/web_view_manager.h index 2327b2e02b4c..24a33fb6221d 100644 --- a/atom/browser/web_view_manager.h +++ b/atom/browser/web_view_manager.h @@ -34,9 +34,9 @@ class WebViewManager : public content::BrowserPluginGuestManager { static bool GetInfoForProcess(content::RenderProcessHost* process, WebViewInfo* info); - // Updates the guest process ID. - static void UpdateGuestProcessID(content::RenderProcessHost* old_process, - content::RenderProcessHost* new_process); + // Same with GetInfoForProcess but search for |web_contents| instead. + static bool GetInfoForWebContents(content::WebContents* web_contents, + WebViewInfo* info); explicit WebViewManager(content::BrowserContext* context); virtual ~WebViewManager(); @@ -48,10 +48,6 @@ class WebViewManager : public content::BrowserPluginGuestManager { const WebViewInfo& info); void RemoveGuest(int guest_instance_id); - // Looks up the information for the embedder for a given render - // view, if one exists. Called on the IO thread. - bool GetInfo(int guest_process_id, WebViewInfo* webview_info); - protected: // content::BrowserPluginGuestManager: content::WebContents* GetGuestByInstanceID(int owner_process_id, @@ -89,8 +85,8 @@ class WebViewManager : public content::BrowserPluginGuestManager { // (embedder_process_id, element_instance_id) => guest_instance_id std::map element_instance_id_to_guest_map_; - typedef std::map WebViewInfoMap; - // guest_process_id => (guest_instance_id, embedder, ...) + typedef std::map WebViewInfoMap; + // web_contents => (guest_instance_id, embedder, ...) WebViewInfoMap webview_info_map_; base::Lock lock_; From e5c4e34ac4c6527c5f3a85283d564837dc4542f5 Mon Sep 17 00:00:00 2001 From: Seppe Stas Date: Wed, 3 Jun 2015 07:54:38 +0200 Subject: [PATCH 0136/1293] Ow :poop:, where did that extra space come from? --- atom/browser/ui/win/notify_icon.cc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/atom/browser/ui/win/notify_icon.cc b/atom/browser/ui/win/notify_icon.cc index bce258901861..d319539823cc 100644 --- a/atom/browser/ui/win/notify_icon.cc +++ b/atom/browser/ui/win/notify_icon.cc @@ -59,7 +59,7 @@ void NotifyIcon::HandleClickEvent(const gfx::Point& cursor_pos, Shell_NotifyIconGetRect(&icon_id, &rect); int width = rect.right - rect.left; - int height = rect.bottom - rect.top; + int height = rect.bottom - rect.top; NotifyClicked(gfx::Rect(rect.left, rect.top, width, height)); return; } From d4be2da70ee330f64d5236d151d5f5bb531d07ef Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 3 Jun 2015 14:08:56 +0800 Subject: [PATCH 0137/1293] Don't rely on process_id to search for NativeWindow --- atom/browser/api/atom_api_web_contents.cc | 2 +- atom/browser/atom_browser_client.cc | 53 ++++++++++------------- atom/browser/atom_browser_client.h | 3 -- atom/browser/native_window.cc | 2 +- atom/browser/native_window.h | 3 +- atom/browser/web_view_manager.cc | 28 +++--------- atom/browser/web_view_manager.h | 10 ++--- 7 files changed, 36 insertions(+), 65 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index cfc8304d0611..e06d2b2419b3 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -85,7 +85,7 @@ v8::Persistent template_; // Get the window that has the |guest| embedded. NativeWindow* GetWindowFromGuest(const content::WebContents* guest) { WebViewManager::WebViewInfo info; - if (WebViewManager::GetInfoForProcess(guest->GetRenderProcessHost(), &info)) + if (WebViewManager::GetInfoForWebContents(guest, &info)) return NativeWindow::FromWebContents(info.embedder); else return nullptr; diff --git a/atom/browser/atom_browser_client.cc b/atom/browser/atom_browser_client.cc index f987cec5ac5e..50a851bb5248 100644 --- a/atom/browser/atom_browser_client.cc +++ b/atom/browser/atom_browser_client.cc @@ -31,33 +31,38 @@ namespace atom { namespace { +// The default routing id of WebContents, since in Electron a WebContents +// always owns its own RenderProcessHost, this ID is same for every WebContents. +int kDefaultRoutingID = 2; + // Next navigation should not restart renderer process. bool g_suppress_renderer_process_restart = false; +// Returns the WebContents from process. +inline content::WebContents* GetWebContentsFromProcess(int process_id) { + return content::WebContents::FromRenderViewHost( + content::RenderViewHost::FromID(process_id, kDefaultRoutingID)); +} + // Find out the owner of the child process according to child_process_id. -enum ChildProcessOwner { +enum WebContentsOwner { OWNER_NATIVE_WINDOW, OWNER_GUEST_WEB_CONTENTS, OWNER_NONE, // it might be devtools though. }; -ChildProcessOwner GetChildProcessOwner(int process_id, - NativeWindow** window, - WebViewManager::WebViewInfo* info) { +WebContentsOwner GetWebContentsOwner(content::WebContents* web_contents, + NativeWindow** window, + WebViewManager::WebViewInfo* info) { // First search for NativeWindow. - for (auto native_window : *WindowList::GetInstance()) { - content::WebContents* web_contents = native_window->GetWebContents(); - if (web_contents && - process_id == web_contents->GetRenderProcessHost()->GetID()) { + for (auto native_window : *WindowList::GetInstance()) + if (web_contents == native_window->GetWebContents()) { *window = native_window; return OWNER_NATIVE_WINDOW; } - } // Then search for guest WebContents. - auto process = content::RenderProcessHost::FromID(process_id); - if (WebViewManager::GetInfoForProcess(process, info)) { + if (WebViewManager::GetInfoForWebContents(web_contents, info)) return OWNER_GUEST_WEB_CONTENTS; - } return OWNER_NONE; } @@ -69,8 +74,7 @@ void AtomBrowserClient::SuppressRendererProcessRestartForOnce() { g_suppress_renderer_process_restart = true; } -AtomBrowserClient::AtomBrowserClient() - : dying_render_process_(nullptr) { +AtomBrowserClient::AtomBrowserClient() { } AtomBrowserClient::~AtomBrowserClient() { @@ -148,9 +152,6 @@ void AtomBrowserClient::OverrideSiteInstanceForNavigation( if (url.SchemeIs(url::kJavaScriptScheme)) return; - if (current_instance->HasProcess()) - dying_render_process_ = current_instance->GetProcess(); - *new_instance = content::SiteInstance::CreateForURL(browser_context, url); } @@ -161,20 +162,16 @@ void AtomBrowserClient::AppendExtraCommandLineSwitches( if (process_type != "renderer") return; + auto web_contents = GetWebContentsFromProcess(process_id); + if (!web_contents) + return; + NativeWindow* window; WebViewManager::WebViewInfo info; - ChildProcessOwner owner = GetChildProcessOwner(process_id, &window, &info); - - // If the render process is a newly started one, which means the owner still - // uses the old going-to-be-swapped render process, then we try to find the - // owner from the swapped render process. - if (owner == OWNER_NONE) { - process_id = dying_render_process_->GetID(); - owner = GetChildProcessOwner(process_id, &window, &info); - } + WebContentsOwner owner = GetWebContentsOwner(web_contents, &window, &info); if (owner == OWNER_NATIVE_WINDOW) { - window->AppendExtraCommandLineSwitches(command_line, process_id); + window->AppendExtraCommandLineSwitches(command_line); } else if (owner == OWNER_GUEST_WEB_CONTENTS) { command_line->AppendSwitchASCII( switches::kGuestInstanceID, base::IntToString(info.guest_instance_id)); @@ -186,8 +183,6 @@ void AtomBrowserClient::AppendExtraCommandLineSwitches( command_line->AppendSwitchPath( switches::kPreloadScript, info.preload_script); } - - dying_render_process_ = nullptr; } void AtomBrowserClient::DidCreatePpapiPlugin( diff --git a/atom/browser/atom_browser_client.h b/atom/browser/atom_browser_client.h index a505daaea5cc..6aebc3128a48 100644 --- a/atom/browser/atom_browser_client.h +++ b/atom/browser/atom_browser_client.h @@ -46,9 +46,6 @@ class AtomBrowserClient : public brightray::BrowserClient { brightray::BrowserMainParts* OverrideCreateBrowserMainParts( const content::MainFunctionParams&) override; - // The render process which would be swapped out soon. - content::RenderProcessHost* dying_render_process_; - DISALLOW_COPY_AND_ASSIGN(AtomBrowserClient); }; diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 7fb0de344472..01916781ee6d 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -422,7 +422,7 @@ content::WebContents* NativeWindow::GetDevToolsWebContents() const { } void NativeWindow::AppendExtraCommandLineSwitches( - base::CommandLine* command_line, int child_process_id) { + base::CommandLine* command_line) { // Append --node-integration to renderer process. command_line->AppendSwitchASCII(switches::kNodeIntegration, node_integration_ ? "true" : "false"); diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index ce829c71b533..8f9d8e95a34e 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -192,8 +192,7 @@ class NativeWindow : public brightray::DefaultWebContentsDelegate, content::WebContents* GetDevToolsWebContents() const; // Called when renderer process is going to be started. - void AppendExtraCommandLineSwitches(base::CommandLine* command_line, - int child_process_id); + void AppendExtraCommandLineSwitches(base::CommandLine* command_line); void OverrideWebkitPrefs(content::WebPreferences* prefs); // Set fullscreen mode triggered by html api. diff --git a/atom/browser/web_view_manager.cc b/atom/browser/web_view_manager.cc index 0ce31ffe0c8c..7dba6c06dd38 100644 --- a/atom/browser/web_view_manager.cc +++ b/atom/browser/web_view_manager.cc @@ -12,10 +12,9 @@ namespace atom { namespace { -WebViewManager* GetManagerFromProcess(content::RenderProcessHost* process) { - if (!process) - return nullptr; - auto context = process->GetBrowserContext(); +WebViewManager* GetManagerFromWebContents( + const content::WebContents* web_contents) { + auto context = web_contents->GetBrowserContext(); if (!context) return nullptr; return static_cast(context->GetGuestManager()); @@ -24,24 +23,9 @@ WebViewManager* GetManagerFromProcess(content::RenderProcessHost* process) { } // namespace // static -bool WebViewManager::GetInfoForProcess(content::RenderProcessHost* process, - WebViewInfo* info) { - auto manager = GetManagerFromProcess(process); - if (!manager) - return false; - base::AutoLock auto_lock(manager->lock_); - for (auto iter : manager->webview_info_map_) - if (iter.first->GetRenderProcessHost() == process) { - *info = iter.second; - return true; - } - return false; -} - -// static -bool WebViewManager::GetInfoForWebContents(content::WebContents* web_contents, - WebViewInfo* info) { - auto manager = GetManagerFromProcess(web_contents->GetRenderProcessHost()); +bool WebViewManager::GetInfoForWebContents( + const content::WebContents* web_contents, WebViewInfo* info) { + auto manager = GetManagerFromWebContents(web_contents); if (!manager) return false; base::AutoLock auto_lock(manager->lock_); diff --git a/atom/browser/web_view_manager.h b/atom/browser/web_view_manager.h index 24a33fb6221d..b1bea92702cc 100644 --- a/atom/browser/web_view_manager.h +++ b/atom/browser/web_view_manager.h @@ -29,13 +29,9 @@ class WebViewManager : public content::BrowserPluginGuestManager { base::FilePath preload_script; }; - // Finds the WebViewManager attached with |process| and returns the + // Finds the WebViewManager attached with |web_contents| and returns the // WebViewInfo of it. - static bool GetInfoForProcess(content::RenderProcessHost* process, - WebViewInfo* info); - - // Same with GetInfoForProcess but search for |web_contents| instead. - static bool GetInfoForWebContents(content::WebContents* web_contents, + static bool GetInfoForWebContents(const content::WebContents* web_contents, WebViewInfo* info); explicit WebViewManager(content::BrowserContext* context); @@ -85,7 +81,7 @@ class WebViewManager : public content::BrowserPluginGuestManager { // (embedder_process_id, element_instance_id) => guest_instance_id std::map element_instance_id_to_guest_map_; - typedef std::map WebViewInfoMap; + typedef std::map WebViewInfoMap; // web_contents => (guest_instance_id, embedder, ...) WebViewInfoMap webview_info_map_; From 34cd1435b47877686398b9acf52cbcabfcc439f2 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 3 Jun 2015 14:17:11 +0800 Subject: [PATCH 0138/1293] Clean up code --- atom/browser/atom_browser_client.cc | 33 ++++++++++------------------- 1 file changed, 11 insertions(+), 22 deletions(-) diff --git a/atom/browser/atom_browser_client.cc b/atom/browser/atom_browser_client.cc index 50a851bb5248..b8f63bc604a3 100644 --- a/atom/browser/atom_browser_client.cc +++ b/atom/browser/atom_browser_client.cc @@ -38,21 +38,20 @@ int kDefaultRoutingID = 2; // Next navigation should not restart renderer process. bool g_suppress_renderer_process_restart = false; -// Returns the WebContents from process. -inline content::WebContents* GetWebContentsFromProcess(int process_id) { - return content::WebContents::FromRenderViewHost( - content::RenderViewHost::FromID(process_id, kDefaultRoutingID)); -} - // Find out the owner of the child process according to child_process_id. -enum WebContentsOwner { +enum ProcessOwner { OWNER_NATIVE_WINDOW, OWNER_GUEST_WEB_CONTENTS, OWNER_NONE, // it might be devtools though. }; -WebContentsOwner GetWebContentsOwner(content::WebContents* web_contents, - NativeWindow** window, - WebViewManager::WebViewInfo* info) { +ProcessOwner GetProcessOwner(int process_id, + NativeWindow** window, + WebViewManager::WebViewInfo* info) { + auto web_contents = content::WebContents::FromRenderViewHost( + content::RenderViewHost::FromID(process_id, kDefaultRoutingID)); + if (!web_contents) + return OWNER_NONE; + // First search for NativeWindow. for (auto native_window : *WindowList::GetInstance()) if (web_contents == native_window->GetWebContents()) { @@ -115,14 +114,8 @@ void AtomBrowserClient::OverrideWebkitPrefs( prefs->allow_displaying_insecure_content = false; prefs->allow_running_insecure_content = false; - // Turn off web security for devtools. - auto web_contents = content::WebContents::FromRenderViewHost(host); - if (web_contents && web_contents->GetURL().SchemeIs("chrome-devtools")) { - prefs->web_security_enabled = false; - return; - } - // Custom preferences of guest page. + auto web_contents = content::WebContents::FromRenderViewHost(host); WebViewManager::WebViewInfo info; if (WebViewManager::GetInfoForWebContents(web_contents, &info)) { prefs->web_security_enabled = !info.disable_web_security; @@ -162,13 +155,9 @@ void AtomBrowserClient::AppendExtraCommandLineSwitches( if (process_type != "renderer") return; - auto web_contents = GetWebContentsFromProcess(process_id); - if (!web_contents) - return; - NativeWindow* window; WebViewManager::WebViewInfo info; - WebContentsOwner owner = GetWebContentsOwner(web_contents, &window, &info); + ProcessOwner owner = GetProcessOwner(process_id, &window, &info); if (owner == OWNER_NATIVE_WINDOW) { window->AppendExtraCommandLineSwitches(command_line); From 95a8f3fc7063c3221dbd2430330cbfea5ae076d4 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 3 Jun 2015 14:33:22 +0800 Subject: [PATCH 0139/1293] Fix changing src would calling loadUrl for twice --- .../lib/web-view/web-view-attributes.coffee | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/atom/renderer/lib/web-view/web-view-attributes.coffee b/atom/renderer/lib/web-view/web-view-attributes.coffee index d2ea629f50d7..37002aefc4b7 100644 --- a/atom/renderer/lib/web-view/web-view-attributes.coffee +++ b/atom/renderer/lib/web-view/web-view-attributes.coffee @@ -28,7 +28,7 @@ class WebViewAttribute # Changes the attribute's value without triggering its mutation handler. setValueIgnoreMutation: (value) -> @ignoreMutation = true - @webViewImpl.webviewNode.setAttribute(@name, value || '') + @setValue value @ignoreMutation = false # Defines this attribute as a property on the webview node. @@ -119,6 +119,14 @@ class SrcAttribute extends WebViewAttribute else '' + setValueIgnoreMutation: (value) -> + WebViewAttribute::setValueIgnoreMutation value + # takeRecords() is needed to clear queued up src mutations. Without it, it + # is possible for this change to get picked up asyncronously by src's + # mutation observer |observer|, and then get handled even though we do not + # want to handle this mutation. + @observer.takeRecords() + handleMutation: (oldValue, newValue) -> # Once we have navigated, we don't allow clearing the src attribute. # Once enters a navigated state, it cannot return to a @@ -138,7 +146,10 @@ class SrcAttribute extends WebViewAttribute setupMutationObserver: -> @observer = new MutationObserver (mutations) => for mutation in mutations - @handleMutation mutation.oldValue, @getValue() + oldValue = mutation.oldValue + newValue = @getValue() + return if oldValue isnt newValue + @handleMutation oldValue, newValue params = attributes: true, attributeOldValue: true, From 3a3b05b2f06f108885f11a6c21015117371dd25b Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 3 Jun 2015 14:53:19 +0800 Subject: [PATCH 0140/1293] Clean up code --- atom/browser/atom_browser_client.cc | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/atom/browser/atom_browser_client.cc b/atom/browser/atom_browser_client.cc index b8f63bc604a3..88aa5b77755c 100644 --- a/atom/browser/atom_browser_client.cc +++ b/atom/browser/atom_browser_client.cc @@ -31,22 +31,23 @@ namespace atom { namespace { -// The default routing id of WebContents, since in Electron a WebContents -// always owns its own RenderProcessHost, this ID is same for every WebContents. +// The default routing id of WebContents. +// In Electron each RenderProcessHost only has one WebContents, so this ID is +// same for every WebContents. int kDefaultRoutingID = 2; // Next navigation should not restart renderer process. bool g_suppress_renderer_process_restart = false; -// Find out the owner of the child process according to child_process_id. +// Find out the owner of the child process according to |process_id|. enum ProcessOwner { OWNER_NATIVE_WINDOW, OWNER_GUEST_WEB_CONTENTS, OWNER_NONE, // it might be devtools though. }; ProcessOwner GetProcessOwner(int process_id, - NativeWindow** window, - WebViewManager::WebViewInfo* info) { + NativeWindow** window, + WebViewManager::WebViewInfo* info) { auto web_contents = content::WebContents::FromRenderViewHost( content::RenderViewHost::FromID(process_id, kDefaultRoutingID)); if (!web_contents) From 31beee9599784ad5427dc8c035501688ea38d905 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 3 Jun 2015 18:48:10 +0800 Subject: [PATCH 0141/1293] Check for nullness when comparing webContents, close #1838 --- atom/browser/api/lib/browser-window.coffee | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/atom/browser/api/lib/browser-window.coffee b/atom/browser/api/lib/browser-window.coffee index 803fb9207c42..a0c1576ad533 100644 --- a/atom/browser/api/lib/browser-window.coffee +++ b/atom/browser/api/lib/browser-window.coffee @@ -88,11 +88,11 @@ BrowserWindow.getFocusedWindow = -> BrowserWindow.fromWebContents = (webContents) -> windows = BrowserWindow.getAllWindows() - return window for window in windows when webContents.equal window.webContents + return window for window in windows when window.webContents?.equal webContents BrowserWindow.fromDevToolsWebContents = (webContents) -> windows = BrowserWindow.getAllWindows() - return window for window in windows when webContents.equal window.devToolsWebContents + return window for window in windows when window.devToolsWebContents?.equal webContents BrowserWindow.fromId = (id) -> BrowserWindow.windows.get id From 3c186946eb6d32faf21de513b0b95e224c055e36 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 3 Jun 2015 19:27:04 +0800 Subject: [PATCH 0142/1293] docs: python 2.7 is required, close #1830 --- docs/development/build-instructions-linux.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/development/build-instructions-linux.md b/docs/development/build-instructions-linux.md index e98cf3007c49..38918f19ad98 100644 --- a/docs/development/build-instructions-linux.md +++ b/docs/development/build-instructions-linux.md @@ -2,6 +2,7 @@ ## Prerequisites +* Python 2.7 * [Node.js](http://nodejs.org) * Clang 3.4 or later * Development headers of GTK+ and libnotify From da83ba6c06153827a3e1f7849db3a00d2a168ea6 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Thu, 4 Jun 2015 10:08:16 +0800 Subject: [PATCH 0143/1293] Fix dialog.showSaveDialog doesn't show the non-exist file name on Linux. --- atom/browser/ui/file_dialog_gtk.cc | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/atom/browser/ui/file_dialog_gtk.cc b/atom/browser/ui/file_dialog_gtk.cc index 0a74cf7551d7..40c14028d4fa 100644 --- a/atom/browser/ui/file_dialog_gtk.cc +++ b/atom/browser/ui/file_dialog_gtk.cc @@ -93,12 +93,15 @@ class FileChooserDialog { gtk_window_set_modal(GTK_WINDOW(dialog_), TRUE); if (!default_path.empty()) { - if (base::DirectoryExists(default_path)) + if (base::DirectoryExists(default_path)) { gtk_file_chooser_set_current_folder(GTK_FILE_CHOOSER(dialog_), default_path.value().c_str()); - else - gtk_file_chooser_set_filename(GTK_FILE_CHOOSER(dialog_), - default_path.value().c_str()); + } else { + gtk_file_chooser_set_current_folder(GTK_FILE_CHOOSER(dialog_), + default_path.DirName().value().c_str()); + gtk_file_chooser_set_current_name(GTK_FILE_CHOOSER(dialog_), + default_path.BaseName().value().c_str()); + } } if (!filters.empty()) From 0fcc0f3e0ad50d0133c39c33626ce8f3d4435256 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 4 Jun 2015 14:41:44 +0800 Subject: [PATCH 0144/1293] Update brightray for #1809 --- vendor/brightray | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/brightray b/vendor/brightray index 88f063c1b432..e9f49690e3f2 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit 88f063c1b432f124ffe4eb9ca68ee4b76a5fdf02 +Subproject commit e9f49690e3f2d16c6bc4f70fca6b11987745ceac From cc3066e7466402e14c04c4f58d96552fd4651fae Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 4 Jun 2015 14:54:53 +0800 Subject: [PATCH 0145/1293] Create a default menu for apps ran by default_app --- atom/browser/default_app/default_app.js | 214 --------------------- atom/browser/default_app/main.js | 242 ++++++++++++++++++++++++ 2 files changed, 242 insertions(+), 214 deletions(-) diff --git a/atom/browser/default_app/default_app.js b/atom/browser/default_app/default_app.js index 6b52d3f280f9..2378902b44ec 100644 --- a/atom/browser/default_app/default_app.js +++ b/atom/browser/default_app/default_app.js @@ -1,10 +1,7 @@ var app = require('app'); -var Menu = require('menu'); -var MenuItem = require('menu-item'); var BrowserWindow = require('browser-window'); var mainWindow = null; -var menu = null; // Quit when all windows are closed. app.on('window-all-closed', function() { @@ -20,215 +17,4 @@ app.on('ready', function() { }); mainWindow.loadUrl('file://' + __dirname + '/index.html'); mainWindow.focus(); - - if (process.platform == 'darwin') { - var template = [ - { - label: 'Electron', - submenu: [ - { - label: 'About Electron', - selector: 'orderFrontStandardAboutPanel:' - }, - { - type: 'separator' - }, - { - label: 'Services', - submenu: [] - }, - { - type: 'separator' - }, - { - label: 'Hide Electron', - accelerator: 'Command+H', - selector: 'hide:' - }, - { - label: 'Hide Others', - accelerator: 'Command+Shift+H', - selector: 'hideOtherApplications:' - }, - { - label: 'Show All', - selector: 'unhideAllApplications:' - }, - { - type: 'separator' - }, - { - label: 'Quit', - accelerator: 'Command+Q', - click: function() { app.quit(); } - }, - ] - }, - { - label: 'Edit', - submenu: [ - { - label: 'Undo', - accelerator: 'Command+Z', - selector: 'undo:' - }, - { - label: 'Redo', - accelerator: 'Shift+Command+Z', - selector: 'redo:' - }, - { - type: 'separator' - }, - { - label: 'Cut', - accelerator: 'Command+X', - selector: 'cut:' - }, - { - label: 'Copy', - accelerator: 'Command+C', - selector: 'copy:' - }, - { - label: 'Paste', - accelerator: 'Command+V', - selector: 'paste:' - }, - { - label: 'Select All', - accelerator: 'Command+A', - selector: 'selectAll:' - }, - ] - }, - { - label: 'View', - submenu: [ - { - label: 'Reload', - accelerator: 'Command+R', - click: function() { mainWindow.restart(); } - }, - { - label: 'Toggle Full Screen', - accelerator: 'Ctrl+Command+F', - click: function() { mainWindow.setFullScreen(!mainWindow.isFullScreen()); } - }, - { - label: 'Toggle Developer Tools', - accelerator: 'Alt+Command+I', - click: function() { mainWindow.toggleDevTools(); } - }, - ] - }, - { - label: 'Window', - submenu: [ - { - label: 'Minimize', - accelerator: 'Command+M', - selector: 'performMiniaturize:' - }, - { - label: 'Close', - accelerator: 'Command+W', - selector: 'performClose:' - }, - { - type: 'separator' - }, - { - label: 'Bring All to Front', - selector: 'arrangeInFront:' - }, - ] - }, - { - label: 'Help', - submenu: [ - { - label: 'Learn More', - click: function() { require('shell').openExternal('http://electron.atom.io') } - }, - { - label: 'Documentation', - click: function() { require('shell').openExternal('https://github.com/atom/electron/tree/master/docs#readme') } - }, - { - label: 'Community Discussions', - click: function() { require('shell').openExternal('https://discuss.atom.io/c/electron') } - }, - { - label: 'Search Issues', - click: function() { require('shell').openExternal('https://github.com/atom/electron/issues') } - } - ] - } - ]; - - menu = Menu.buildFromTemplate(template); - Menu.setApplicationMenu(menu); - } else { - var template = [ - { - label: '&File', - submenu: [ - { - label: '&Open', - accelerator: 'Ctrl+O', - }, - { - label: '&Close', - accelerator: 'Ctrl+W', - click: function() { mainWindow.close(); } - }, - ] - }, - { - label: '&View', - submenu: [ - { - label: '&Reload', - accelerator: 'Ctrl+R', - click: function() { mainWindow.restart(); } - }, - { - label: 'Toggle &Full Screen', - accelerator: 'F11', - click: function() { mainWindow.setFullScreen(!mainWindow.isFullScreen()); } - }, - { - label: 'Toggle &Developer Tools', - accelerator: 'Alt+Ctrl+I', - click: function() { mainWindow.toggleDevTools(); } - }, - ] - }, - { - label: 'Help', - submenu: [ - { - label: 'Learn More', - click: function() { require('shell').openExternal('http://electron.atom.io') } - }, - { - label: 'Documentation', - click: function() { require('shell').openExternal('https://github.com/atom/electron/tree/master/docs#readme') } - }, - { - label: 'Community Discussions', - click: function() { require('shell').openExternal('https://discuss.atom.io/c/electron') } - }, - { - label: 'Search Issues', - click: function() { require('shell').openExternal('https://github.com/atom/electron/issues') } - } - ] - } - ]; - - menu = Menu.buildFromTemplate(template); - mainWindow.setMenu(menu); - } }); diff --git a/atom/browser/default_app/main.js b/atom/browser/default_app/main.js index 1726ffba8ea1..3ca8081e23c0 100644 --- a/atom/browser/default_app/main.js +++ b/atom/browser/default_app/main.js @@ -2,6 +2,8 @@ var app = require('app'); var dialog = require('dialog'); var fs = require('fs'); var path = require('path'); +var Menu = require('menu'); +var BrowserWindow = require('browser-window'); // Quit when all windows are closed and no other one is listening to this. app.on('window-all-closed', function() { @@ -29,6 +31,246 @@ for (var i in argv) { } } +// Create default menu. +app.once('ready', function() { + var template; + if (process.platform == 'darwin') { + template = [ + { + label: 'Electron', + submenu: [ + { + label: 'About Electron', + selector: 'orderFrontStandardAboutPanel:' + }, + { + type: 'separator' + }, + { + label: 'Services', + submenu: [] + }, + { + type: 'separator' + }, + { + label: 'Hide Electron', + accelerator: 'Command+H', + selector: 'hide:' + }, + { + label: 'Hide Others', + accelerator: 'Command+Shift+H', + selector: 'hideOtherApplications:' + }, + { + label: 'Show All', + selector: 'unhideAllApplications:' + }, + { + type: 'separator' + }, + { + label: 'Quit', + accelerator: 'Command+Q', + click: function() { app.quit(); } + }, + ] + }, + { + label: 'Edit', + submenu: [ + { + label: 'Undo', + accelerator: 'Command+Z', + selector: 'undo:' + }, + { + label: 'Redo', + accelerator: 'Shift+Command+Z', + selector: 'redo:' + }, + { + type: 'separator' + }, + { + label: 'Cut', + accelerator: 'Command+X', + selector: 'cut:' + }, + { + label: 'Copy', + accelerator: 'Command+C', + selector: 'copy:' + }, + { + label: 'Paste', + accelerator: 'Command+V', + selector: 'paste:' + }, + { + label: 'Select All', + accelerator: 'Command+A', + selector: 'selectAll:' + }, + ] + }, + { + label: 'View', + submenu: [ + { + label: 'Reload', + accelerator: 'Command+R', + click: function() { + var focusedWindow = BrowserWindow.getFocusedWindow(); + if (focusedWindow) + mainWindow.restart(); + } + }, + { + label: 'Toggle Full Screen', + accelerator: 'Ctrl+Command+F', + click: function() { + var focusedWindow = BrowserWindow.getFocusedWindow(); + if (focusedWindow) + focusedWindow.setFullScreen(!focusedWindow.isFullScreen()); + } + }, + { + label: 'Toggle Developer Tools', + accelerator: 'Alt+Command+I', + click: function() { + var focusedWindow = BrowserWindow.getFocusedWindow(); + if (focusedWindow) + focusedWindow.toggleDevTools(); + } + }, + ] + }, + { + label: 'Window', + submenu: [ + { + label: 'Minimize', + accelerator: 'Command+M', + selector: 'performMiniaturize:' + }, + { + label: 'Close', + accelerator: 'Command+W', + selector: 'performClose:' + }, + { + type: 'separator' + }, + { + label: 'Bring All to Front', + selector: 'arrangeInFront:' + }, + ] + }, + { + label: 'Help', + submenu: [ + { + label: 'Learn More', + click: function() { require('shell').openExternal('http://electron.atom.io') } + }, + { + label: 'Documentation', + click: function() { require('shell').openExternal('https://github.com/atom/electron/tree/master/docs#readme') } + }, + { + label: 'Community Discussions', + click: function() { require('shell').openExternal('https://discuss.atom.io/c/electron') } + }, + { + label: 'Search Issues', + click: function() { require('shell').openExternal('https://github.com/atom/electron/issues') } + } + ] + } + ]; + } else { + template = [ + { + label: '&File', + submenu: [ + { + label: '&Open', + accelerator: 'Ctrl+O', + }, + { + label: '&Close', + accelerator: 'Ctrl+W', + click: function() { + var focusedWindow = BrowserWindow.getFocusedWindow(); + if (focusedWindow) + focusedWindow.close(); + } + }, + ] + }, + { + label: '&View', + submenu: [ + { + label: '&Reload', + accelerator: 'Ctrl+R', + click: function() { + var focusedWindow = BrowserWindow.getFocusedWindow(); + if (focusedWindow) + focusedWindow.reload(); + } + }, + { + label: 'Toggle &Full Screen', + accelerator: 'F11', + click: function() { + var focusedWindow = BrowserWindow.getFocusedWindow(); + if (focusedWindow) + focusedWindow.setFullScreen(!focusedWindow.isFullScreen()); + } + }, + { + label: 'Toggle &Developer Tools', + accelerator: 'Alt+Ctrl+I', + click: function() { + var focusedWindow = BrowserWindow.getFocusedWindow(); + if (focusedWindow) + focusedWindow.toggleDevTools(); + } + }, + ] + }, + { + label: 'Help', + submenu: [ + { + label: 'Learn More', + click: function() { require('shell').openExternal('http://electron.atom.io') } + }, + { + label: 'Documentation', + click: function() { require('shell').openExternal('https://github.com/atom/electron/tree/master/docs#readme') } + }, + { + label: 'Community Discussions', + click: function() { require('shell').openExternal('https://discuss.atom.io/c/electron') } + }, + { + label: 'Search Issues', + click: function() { require('shell').openExternal('https://github.com/atom/electron/issues') } + } + ] + } + ]; + } + + var menu = Menu.buildFromTemplate(template); + Menu.setApplicationMenu(menu); +}); + // Start the specified app if there is one specified in command line, otherwise // start the default app. if (option.file && !option.webdriver) { From 6d6e75795f140565bc6b8f9952c551f667bf4e74 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 4 Jun 2015 15:14:43 +0800 Subject: [PATCH 0146/1293] Allow settting menu to null --- atom/browser/api/lib/browser-window.coffee | 2 +- atom/browser/api/lib/menu.coffee | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/atom/browser/api/lib/browser-window.coffee b/atom/browser/api/lib/browser-window.coffee index a0c1576ad533..5042b78a3adc 100644 --- a/atom/browser/api/lib/browser-window.coffee +++ b/atom/browser/api/lib/browser-window.coffee @@ -73,7 +73,7 @@ BrowserWindow::setMenu = (menu) -> if process.platform is 'darwin' throw new Error('BrowserWindow.setMenu is not available on OS X') - throw new TypeError('Invalid menu') unless menu?.constructor?.name is 'Menu' + throw new TypeError('Invalid menu') unless menu is null or menu?.constructor?.name is 'Menu' @menu = menu # Keep a reference of menu in case of GC. @menu.attachToWindow this diff --git a/atom/browser/api/lib/menu.coffee b/atom/browser/api/lib/menu.coffee index b4b0dec23e20..80e0330943e7 100644 --- a/atom/browser/api/lib/menu.coffee +++ b/atom/browser/api/lib/menu.coffee @@ -130,11 +130,12 @@ Menu::_callMenuWillShow = -> applicationMenu = null Menu.setApplicationMenu = (menu) -> - throw new TypeError('Invalid menu') unless menu?.constructor is Menu + throw new TypeError('Invalid menu') unless menu is null or menu.constructor is Menu applicationMenu = menu # Keep a reference. if process.platform is 'darwin' menu._callMenuWillShow() + throw new Error('You can not remove application menu') if menu is null bindings.setApplicationMenu menu else windows = BrowserWindow.getAllWindows() From 47e9deeb9ab13f0e6b13f6210df1caf11f33adf3 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 4 Jun 2015 15:32:33 +0800 Subject: [PATCH 0147/1293] Remove Menu::AttachToWindow It makes the logic more complex without any benefit --- atom/browser/api/atom_api_menu.cc | 5 ----- atom/browser/api/atom_api_menu.h | 24 +++++++++++++++++++++- atom/browser/api/atom_api_window.cc | 6 ++++++ atom/browser/api/atom_api_window.h | 5 +++++ atom/browser/api/lib/browser-window.coffee | 5 +---- 5 files changed, 35 insertions(+), 10 deletions(-) diff --git a/atom/browser/api/atom_api_menu.cc b/atom/browser/api/atom_api_menu.cc index c0bfff3f050c..c0704a22d052 100644 --- a/atom/browser/api/atom_api_menu.cc +++ b/atom/browser/api/atom_api_menu.cc @@ -70,10 +70,6 @@ void Menu::MenuWillShow(ui::SimpleMenuModel* source) { menu_will_show_.Run(); } -void Menu::AttachToWindow(Window* window) { - window->window()->SetMenu(model_.get()); -} - void Menu::InsertItemAt( int index, int command_id, const base::string16& label) { model_->InsertItemAt(index, command_id, label); @@ -168,7 +164,6 @@ void Menu::BuildPrototype(v8::Isolate* isolate, .SetMethod("isItemCheckedAt", &Menu::IsItemCheckedAt) .SetMethod("isEnabledAt", &Menu::IsEnabledAt) .SetMethod("isVisibleAt", &Menu::IsVisibleAt) - .SetMethod("attachToWindow", &Menu::AttachToWindow) .SetMethod("_popup", &Menu::Popup) .SetMethod("_popupAt", &Menu::PopupAt); } diff --git a/atom/browser/api/atom_api_menu.h b/atom/browser/api/atom_api_menu.h index 37e544a82e09..0c2743878f78 100644 --- a/atom/browser/api/atom_api_menu.h +++ b/atom/browser/api/atom_api_menu.h @@ -51,7 +51,6 @@ class Menu : public mate::Wrappable, void ExecuteCommand(int command_id, int event_flags) override; void MenuWillShow(ui::SimpleMenuModel* source) override; - virtual void AttachToWindow(Window* window); virtual void Popup(Window* window) = 0; virtual void PopupAt(Window* window, int x, int y) = 0; @@ -99,4 +98,27 @@ class Menu : public mate::Wrappable, } // namespace atom + +namespace mate { + +template<> +struct Converter { + static bool FromV8(v8::Isolate* isolate, v8::Local val, + ui::SimpleMenuModel** out) { + // null would be tranfered to NULL. + if (val->IsNull()) { + *out = nullptr; + return true; + } + + atom::api::Menu* menu; + if (!Converter::FromV8(isolate, val, &menu)) + return false; + *out = menu->model(); + return true; + } +}; + +} // namespace mate + #endif // ATOM_BROWSER_API_ATOM_API_MENU_H_ diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index a016c16da012..f689af1288b7 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -4,6 +4,7 @@ #include "atom/browser/api/atom_api_window.h" +#include "atom/browser/api/atom_api_menu.h" #include "atom/browser/api/atom_api_web_contents.h" #include "atom/browser/browser.h" #include "atom/browser/native_window.h" @@ -437,6 +438,10 @@ void Window::SetOverlayIcon(const gfx::Image& overlay, window_->SetOverlayIcon(overlay, description); } +void Window::SetMenu(ui::SimpleMenuModel* menu) { + window_->SetMenu(menu); +} + void Window::SetAutoHideMenuBar(bool auto_hide) { window_->SetAutoHideMenuBar(auto_hide); } @@ -535,6 +540,7 @@ void Window::BuildPrototype(v8::Isolate* isolate, .SetMethod("print", &Window::Print) .SetMethod("setProgressBar", &Window::SetProgressBar) .SetMethod("setOverlayIcon", &Window::SetOverlayIcon) + .SetMethod("_setMenu", &Window::SetMenu) .SetMethod("setAutoHideMenuBar", &Window::SetAutoHideMenuBar) .SetMethod("isMenuBarAutoHide", &Window::IsMenuBarAutoHide) .SetMethod("setMenuBarVisibility", &Window::SetMenuBarVisibility) diff --git a/atom/browser/api/atom_api_window.h b/atom/browser/api/atom_api_window.h index 71de91df6913..72d2c842d8e8 100644 --- a/atom/browser/api/atom_api_window.h +++ b/atom/browser/api/atom_api_window.h @@ -25,6 +25,10 @@ class Arguments; class Dictionary; } +namespace ui { +class SimpleMenuModel; +} + namespace atom { class NativeWindow; @@ -134,6 +138,7 @@ class Window : public mate::EventEmitter, void SetProgressBar(double progress); void SetOverlayIcon(const gfx::Image& overlay, const std::string& description); + void SetMenu(ui::SimpleMenuModel* menu); void SetAutoHideMenuBar(bool auto_hide); bool IsMenuBarAutoHide(); void SetMenuBarVisibility(bool visible); diff --git a/atom/browser/api/lib/browser-window.coffee b/atom/browser/api/lib/browser-window.coffee index 5042b78a3adc..7e4711e817c4 100644 --- a/atom/browser/api/lib/browser-window.coffee +++ b/atom/browser/api/lib/browser-window.coffee @@ -70,13 +70,10 @@ BrowserWindow::getDevToolsWebContents = -> wrapWebContents @_getDevToolsWebContents() BrowserWindow::setMenu = (menu) -> - if process.platform is 'darwin' - throw new Error('BrowserWindow.setMenu is not available on OS X') - throw new TypeError('Invalid menu') unless menu is null or menu?.constructor?.name is 'Menu' @menu = menu # Keep a reference of menu in case of GC. - @menu.attachToWindow this + @_setMenu menu BrowserWindow.getAllWindows = -> windows = BrowserWindow.windows From d5b47d1059bfee5f53790740fd56524093253fdc Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Thu, 4 Jun 2015 15:52:16 +0800 Subject: [PATCH 0148/1293] Simplify and polish the code. --- atom/common/api/atom_api_crash_reporter.cc | 29 +++++++------------ .../crash_reporter/crash_reporter_mac.mm | 22 +++++--------- docs/api/crash-reporter.md | 3 +- spec/api-crash-reporter-spec.coffee | 2 +- 4 files changed, 21 insertions(+), 35 deletions(-) diff --git a/atom/common/api/atom_api_crash_reporter.cc b/atom/common/api/atom_api_crash_reporter.cc index 4b51a88b9f3d..e1932ad7f5f0 100644 --- a/atom/common/api/atom_api_crash_reporter.cc +++ b/atom/common/api/atom_api_crash_reporter.cc @@ -34,20 +34,13 @@ struct Converter > { }; template<> -struct Converter > { +struct Converter { static v8::Local ToV8(v8::Isolate* isolate, - const std::vector& reports) { - v8::Local result(v8::Array::New(isolate, reports.size())); - for (size_t i = 0; i < reports.size(); ++i) { - mate::Dictionary dict(isolate, v8::Object::New(isolate)); - dict.Set("date", reports[i].first); - dict.Set("id", reports[i].second); - v8::TryCatch try_catch; - result->Set(static_cast(i), dict.GetHandle()); - if (try_catch.HasCaught()) - LOG(ERROR) << "Setter for index " << i << " threw an exception."; - } - return result; + const CrashReporter::UploadReportResult& reports) { + mate::Dictionary dict(isolate, v8::Object::New(isolate)); + dict.Set("date", v8::Date::New(isolate, reports.first*1000.0)); + dict.Set("id", reports.second); + return dict.GetHandle(); } }; @@ -55,17 +48,15 @@ struct Converter > { namespace { -std::vector GetUploadedReports() { - return (CrashReporter::GetInstance())->GetUploadedReports(); -} void Initialize(v8::Local exports, v8::Local unused, v8::Local context, void* priv) { mate::Dictionary dict(context->GetIsolate(), exports); + auto report = base::Unretained(CrashReporter::GetInstance()); dict.SetMethod("start", - base::Bind(&CrashReporter::Start, - base::Unretained(CrashReporter::GetInstance()))); - dict.SetMethod("_getUploadedReports", &GetUploadedReports); + base::Bind(&CrashReporter::Start, report)); + dict.SetMethod("_getUploadedReports", + base::Bind(&CrashReporter::GetUploadedReports, report)); } } // namespace diff --git a/atom/common/crash_reporter/crash_reporter_mac.mm b/atom/common/crash_reporter/crash_reporter_mac.mm index 3cb3063d079b..4edd35a43138 100644 --- a/atom/common/crash_reporter/crash_reporter_mac.mm +++ b/atom/common/crash_reporter/crash_reporter_mac.mm @@ -15,7 +15,6 @@ #include "vendor/crashpad/client/crashpad_client.h" #include "vendor/crashpad/client/crashpad_info.h" #include "vendor/crashpad/client/settings.h" -#include "vendor/crashpad/client/simple_string_dictionary.h" namespace crash_reporter { @@ -31,10 +30,10 @@ void CrashReporterMac::InitBreakpad(const std::string& product_name, const std::string& submit_url, bool auto_submit, bool skip_system_crash_handler) { - static bool initialized = false; - if (initialized) + // check whether crashpad has been initilized. + // Only need to initilize once. + if (simple_string_dictionary_) return; - initialized = true; std::string dump_dir = "/tmp/" + product_name + " Crashes"; base::FilePath database_path(dump_dir); @@ -65,13 +64,11 @@ void CrashReporterMac::InitBreakpad(const std::string& product_name, crashpad_info->set_simple_annotations(simple_string_dictionary_.get()); SetCrashKeyValue("prod", ATOM_PRODUCT_NAME); - SetCrashKeyValue("process_type", is_browser_ ? base::StringPiece("browser") - : base::StringPiece("renderer")); + SetCrashKeyValue("process_type", is_browser_ ? "browser" : "renderer"); SetCrashKeyValue("ver", version); - for (auto iter = upload_parameters_.begin(); - iter != upload_parameters_.end(); ++iter) { - SetCrashKeyValue(iter->first, iter->second); + for (const auto& upload_parameter: upload_parameters_) { + SetCrashKeyValue(upload_parameter.first, upload_parameter.second); } if (is_browser_) { crash_report_database_ = crashpad::CrashReportDatabase::Initialize( @@ -120,11 +117,8 @@ CrashReporterMac::GetUploadedReports() { } } - struct { - bool operator()(const UploadReportResult& a, const UploadReportResult& b) { - return a.first >= b.first; - } - } sort_by_time; + auto sort_by_time = [](const UploadReportResult& a, + const UploadReportResult& b) {return a.first >= b.first;}; std::sort(uploaded_reports.begin(), uploaded_reports.end(), sort_by_time); return uploaded_reports; } diff --git a/docs/api/crash-reporter.md b/docs/api/crash-reporter.md index 8e4540567908..d867f77ce398 100644 --- a/docs/api/crash-reporter.md +++ b/docs/api/crash-reporter.md @@ -29,7 +29,8 @@ crashReporter.start({ **Note:** On OS X, electron uses a new `crashpad` client, which is different with the `breakpad` on Windows and Linux. To enable crash collection feature, -you are required to call `crashReporter.start` API to initiliaze `crashpad` in Browser Process, even you only collect crash report in Renderer Process. +you are required to call `crashReporter.start` API to initiliaze `crashpad` in +main process, even you only collect crash report in renderer process. ## crashReporter.getLastCrashReport() diff --git a/spec/api-crash-reporter-spec.coffee b/spec/api-crash-reporter-spec.coffee index 60144bc63087..fc93eb304b65 100644 --- a/spec/api-crash-reporter-spec.coffee +++ b/spec/api-crash-reporter-spec.coffee @@ -45,5 +45,5 @@ describe 'crash-reporter module', -> protocol: 'file' pathname: path.join fixtures, 'api', 'crash.html' search: "?port=#{port}" - crashReporter.start {'submitUrl': 'http://127.0.0.1:' + port} + crashReporter.start {'submitUrl': 'http://127.0.0.1:' + port} w.loadUrl url From 5d23b7468eab6f1cb7856585149807f5d91dc764 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 4 Jun 2015 16:10:19 +0800 Subject: [PATCH 0149/1293] Allow removing menu bar --- atom/browser/native_window_views.cc | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/atom/browser/native_window_views.cc b/atom/browser/native_window_views.cc index 8f5e51edafdc..710788ddbd11 100644 --- a/atom/browser/native_window_views.cc +++ b/atom/browser/native_window_views.cc @@ -541,6 +541,19 @@ bool NativeWindowViews::IsKiosk() { } void NativeWindowViews::SetMenu(ui::MenuModel* menu_model) { + if (menu_model == nullptr) { + // Remove accelerators + accelerator_table_.clear(); + GetFocusManager()->UnregisterAccelerators(this); + // and menu bar. +#if defined(USE_X11) + global_menu_bar_.reset(); +#endif + SetMenuBarVisibility(false); + menu_bar_.reset(); + return; + } + RegisterAccelerators(menu_model); #if defined(USE_X11) From 3b20f2aced587c8e1f9829f74454ac694f217800 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 4 Jun 2015 16:12:29 +0800 Subject: [PATCH 0150/1293] docs: Mention how to remove menu bar --- docs/api/browser-window.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 30055dccb0af..35a439a53620 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -579,7 +579,8 @@ Same with `webContents.reload`. * `menu` Menu -Sets the `menu` as the window top menu. +Sets the `menu` as the window's menu bar, setting it to `null` will remove the +menu bar. __Note:__ This API is not available on OS X. From a22b9be681be43891ee468ee45eea79f56d13b5e Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 4 Jun 2015 16:14:19 +0800 Subject: [PATCH 0151/1293] mac: Do nothing if calling Menu.setApplicationMenu(null) --- atom/browser/api/lib/menu.coffee | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/atom/browser/api/lib/menu.coffee b/atom/browser/api/lib/menu.coffee index 80e0330943e7..af70af740aaf 100644 --- a/atom/browser/api/lib/menu.coffee +++ b/atom/browser/api/lib/menu.coffee @@ -134,8 +134,8 @@ Menu.setApplicationMenu = (menu) -> applicationMenu = menu # Keep a reference. if process.platform is 'darwin' + return if menu is null menu._callMenuWillShow() - throw new Error('You can not remove application menu') if menu is null bindings.setApplicationMenu menu else windows = BrowserWindow.getAllWindows() From 683917ae67109a855c4e7fae4dbd418c4415ea91 Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Mon, 1 Jun 2015 12:58:20 +0530 Subject: [PATCH 0152/1293] renderer: option to override page visiblity state --- atom/browser/native_window.cc | 1 + atom/common/options_switches.cc | 3 +++ atom/common/options_switches.h | 1 + atom/renderer/atom_renderer_client.cc | 15 +++++++++++++++ atom/renderer/atom_renderer_client.h | 3 +++ docs/api/browser-window.md | 2 ++ 6 files changed, 25 insertions(+) diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 3698d8b94594..c2326debc99b 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -78,6 +78,7 @@ const char* kWebRuntimeFeatures[] = { switches::kOverlayScrollbars, switches::kOverlayFullscreenVideo, switches::kSharedWorker, + switches::kPageVisibility, }; std::string RemoveWhitespace(const std::string& str) { diff --git a/atom/common/options_switches.cc b/atom/common/options_switches.cc index 7f642ecbbabd..c9997996fed8 100644 --- a/atom/common/options_switches.cc +++ b/atom/common/options_switches.cc @@ -95,6 +95,9 @@ const char kOverlayScrollbars[] = "overlay-scrollbars"; const char kOverlayFullscreenVideo[] = "overlay-fullscreen-video"; const char kSharedWorker[] = "shared-worker"; +// Set page visiblity to always visible. +const char kPageVisibility[] = "page-visibility"; + // Disable HTTP cache. const char kDisableHttpCache[] = "disable-http-cache"; diff --git a/atom/common/options_switches.h b/atom/common/options_switches.h index aaaa86addb15..071459afac73 100644 --- a/atom/common/options_switches.h +++ b/atom/common/options_switches.h @@ -52,6 +52,7 @@ extern const char kSubpixelFontScaling[]; extern const char kOverlayScrollbars[]; extern const char kOverlayFullscreenVideo[]; extern const char kSharedWorker[]; +extern const char kPageVisibility[]; extern const char kDisableHttpCache[]; diff --git a/atom/renderer/atom_renderer_client.cc b/atom/renderer/atom_renderer_client.cc index 1dc4e45b03d7..e2a114af0141 100644 --- a/atom/renderer/atom_renderer_client.cc +++ b/atom/renderer/atom_renderer_client.cc @@ -191,6 +191,21 @@ content::BrowserPluginDelegate* AtomRendererClient::CreateBrowserPluginDelegate( } } +bool AtomRendererClient::ShouldOverridePageVisibilityState( + const content::RenderFrame* render_frame, + blink::WebPageVisibilityState* override_state) { + base::CommandLine* command_line = base::CommandLine::ForCurrentProcess(); + bool b; + + if (IsSwitchEnabled(command_line, switches::kPageVisibility, &b) + && b) { + *override_state = blink::WebPageVisibilityStateVisible; + return true; + } + + return false; +} + void AtomRendererClient::EnableWebRuntimeFeatures() { base::CommandLine* command_line = base::CommandLine::ForCurrentProcess(); bool b; diff --git a/atom/renderer/atom_renderer_client.h b/atom/renderer/atom_renderer_client.h index af264d59792d..68201f3cd435 100644 --- a/atom/renderer/atom_renderer_client.h +++ b/atom/renderer/atom_renderer_client.h @@ -55,6 +55,9 @@ class AtomRendererClient : public content::ContentRendererClient, content::RenderFrame* render_frame, const std::string& mime_type, const GURL& original_url) override; + bool ShouldOverridePageVisibilityState( + const content::RenderFrame* render_frame, + blink::WebPageVisibilityState* override_state) override; void EnableWebRuntimeFeatures(); diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 30055dccb0af..c97bec0ebbb1 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -97,6 +97,8 @@ You can also create a window without chrome by using * `shared-worker` Boolean * `direct-write` Boolean - Whether the DirectWrite font rendering system on Windows is enabled + * `page-visibility` Boolean - Sets the page visibility state + to visible, prevents throttling of DOM timers. Creates a new `BrowserWindow` with native properties set by the `options`. Usually you only need to set the `width` and `height`, other properties will From 44660825920ac38994ed4be438acc22f02b17f2b Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 4 Jun 2015 21:15:29 +0800 Subject: [PATCH 0153/1293] Revert "Update libchromiumcontent, fix #1786" This reverts commit 1314b7c7e56ebf69182b6df6f82534b2a45c3000. --- script/lib/config.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/script/lib/config.py b/script/lib/config.py index c8ee28cb0c4d..fd9773b5a31c 100644 --- a/script/lib/config.py +++ b/script/lib/config.py @@ -7,7 +7,7 @@ import sys BASE_URL = 'http://gh-contractor-zcbenz.s3.amazonaws.com/libchromiumcontent' -LIBCHROMIUMCONTENT_COMMIT = '893b48a10ef1813abdaf8de3540e2e7203475105' +LIBCHROMIUMCONTENT_COMMIT = '5ccddd5f3968a7f63eaa888e6a8ba319ea8cd3b7' PLATFORM = { 'cygwin': 'win32', From 129159c895bac9b35f1524d7f21b16dce57a7d26 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 4 Jun 2015 22:42:36 +0800 Subject: [PATCH 0154/1293] docs: Say more about page-visibility option --- docs/api/browser-window.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index a829e390ae97..ab7766981dc9 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -97,8 +97,10 @@ You can also create a window without chrome by using * `shared-worker` Boolean * `direct-write` Boolean - Whether the DirectWrite font rendering system on Windows is enabled - * `page-visibility` Boolean - Sets the page visibility state - to visible, prevents throttling of DOM timers. + * `page-visibility` Boolean - Page would be forced to be always in visible + or hidden state once set, instead of reflecting current window's + visibility. Users can set it to `true` to prevent throttling of DOM + timers. Creates a new `BrowserWindow` with native properties set by the `options`. Usually you only need to set the `width` and `height`, other properties will From 790fba598e9e0739bfda1877f1d517a6cf185615 Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Thu, 4 Jun 2015 22:19:31 +0530 Subject: [PATCH 0155/1293] devtools: supporting workspace usage --- atom/browser/native_window.cc | 109 ++++++++++++++++++++++++++++++++++ atom/browser/native_window.h | 23 +++++++ 2 files changed, 132 insertions(+) diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 3698d8b94594..0f522e4bb692 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -33,6 +33,7 @@ #include "chrome/browser/printing/print_view_manager_basic.h" #include "chrome/browser/ui/browser_dialogs.h" #include "content/browser/renderer_host/render_widget_host_impl.h" +#include "content/public/browser/child_process_security_policy.h" #include "content/public/browser/devtools_agent_host.h" #include "content/public/browser/invalidate_type.h" #include "content/public/browser/navigation_entry.h" @@ -50,6 +51,7 @@ #include "content/public/common/web_preferences.h" #include "ipc/ipc_message_macros.h" #include "native_mate/dictionary.h" +#include "storage/browser/fileapi/isolated_context.h" #include "ui/gfx/codec/png_codec.h" #include "ui/gfx/geometry/size_conversions.h" #include "ui/gfx/geometry/point.h" @@ -88,6 +90,62 @@ std::string RemoveWhitespace(const std::string& str) { return str; } +storage::IsolatedContext* isolated_context() { + storage::IsolatedContext* context = + storage::IsolatedContext::GetInstance(); + DCHECK(context); + return context; +} + +std::string RegisterFileSystem(content::WebContents* web_contents, + const base::FilePath& path, + std::string* registered_name) { + std::string file_system_id = isolated_context()->RegisterFileSystemForPath( + storage::kFileSystemTypeNativeLocal, + std::string(), + path, + registered_name); + + content::ChildProcessSecurityPolicy* policy = + content::ChildProcessSecurityPolicy::GetInstance(); + content::RenderViewHost* render_view_host = web_contents->GetRenderViewHost(); + int renderer_id = render_view_host->GetProcess()->GetID(); + policy->GrantReadFileSystem(renderer_id, file_system_id); + policy->GrantWriteFileSystem(renderer_id, file_system_id); + policy->GrantCreateFileForFileSystem(renderer_id, file_system_id); + policy->GrantDeleteFromFileSystem(renderer_id, file_system_id); + + if (!policy->CanReadFile(renderer_id, path)) + policy->GrantReadFile(renderer_id, path); + + return file_system_id; +} + +NativeWindow::FileSystem CreateFileSystemStruct( + content::WebContents* web_contents, + const std::string& file_system_id, + const std::string& registered_name, + const std::string& file_system_path) { + const GURL origin = web_contents->GetURL().GetOrigin(); + std::string file_system_name = + storage::GetIsolatedFileSystemName(origin, file_system_id); + std::string root_url = storage::GetIsolatedFileSystemRootURIString( + origin, file_system_id, registered_name); + + return NativeWindow::FileSystem(file_system_name, + root_url, + file_system_path); +} + +base::DictionaryValue* CreateFileSystemValue( + NativeWindow::FileSystem file_system) { + base::DictionaryValue* file_system_value = new base::DictionaryValue(); + file_system_value->SetString("fileSystemName", file_system.file_system_name); + file_system_value->SetString("rootURL", file_system.root_url); + file_system_value->SetString("fileSystemPath", file_system.file_system_path); + return file_system_value; +} + } // namespace NativeWindow::NativeWindow(content::WebContents* web_contents, @@ -839,6 +897,57 @@ void NativeWindow::DevToolsFocused() { FOR_EACH_OBSERVER(NativeWindowObserver, observers_, OnDevToolsFocus()); } +void NativeWindow::DevToolsAddFileSystem() { + file_dialog::Filters filters; + base::FilePath default_path; + std::vector paths; + int flag = file_dialog::FILE_DIALOG_OPEN_DIRECTORY; + if (!file_dialog::ShowOpenDialog(this, "", default_path, + filters, flag, &paths)) + return; + + base::FilePath path = paths[0]; + std::string registered_name; + std::string file_system_id = RegisterFileSystem(GetDevToolsWebContents(), + path, + ®istered_name); + + WorkspaceMap::iterator it = saved_paths_.find(file_system_id); + if (it != saved_paths_.end()) + return; + + saved_paths_[file_system_id] = path; + + FileSystem file_system = CreateFileSystemStruct(GetDevToolsWebContents(), + file_system_id, + registered_name, + path.AsUTF8Unsafe()); + + scoped_ptr error_string_value( + new base::StringValue(std::string())); + scoped_ptr file_system_value; + if (!file_system.file_system_path.empty()) + file_system_value.reset(CreateFileSystemValue(file_system)); + CallDevToolsFunction("DevToolsAPI.fileSystemAdded", error_string_value.get(), + file_system_value.get(), nullptr); +} + +void NativeWindow::DevToolsRemoveFileSystem( + const std::string& file_system_path) { + base::FilePath path = base::FilePath::FromUTF8Unsafe(file_system_path); + isolated_context()->RevokeFileSystemByPath(path); + + for (auto it = saved_paths_.begin(); it != saved_paths_.end(); ++it) + if (it->second == path) { + saved_paths_.erase(it); + break; + } + + base::StringValue file_system_path_value(file_system_path); + CallDevToolsFunction("DevToolsAPI.fileSystemRemoved", + &file_system_path_value, nullptr, nullptr); +} + void NativeWindow::ScheduleUnresponsiveEvent(int ms) { if (!window_unresposive_closure_.IsCancelled()) return; diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index 8f9d8e95a34e..eb3aad65986a 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -61,6 +61,22 @@ class NativeWindow : public brightray::DefaultWebContentsDelegate, public: typedef base::Callback CapturePageCallback; + struct FileSystem { + FileSystem() { + } + FileSystem(const std::string& file_system_name, + const std::string& root_url, + const std::string& file_system_path) + : file_system_name(file_system_name), + root_url(root_url), + file_system_path(file_system_path) { + } + + std::string file_system_name; + std::string root_url; + std::string file_system_path; + }; + class DialogScope { public: explicit DialogScope(NativeWindow* window) @@ -307,6 +323,8 @@ class NativeWindow : public brightray::DefaultWebContentsDelegate, void DevToolsAppendToFile(const std::string& url, const std::string& content) override; void DevToolsFocused() override; + void DevToolsAddFileSystem() override; + void DevToolsRemoveFileSystem(const std::string& file_system_path) override; // Whether window has standard frame. bool has_frame_; @@ -386,6 +404,11 @@ class NativeWindow : public brightray::DefaultWebContentsDelegate, typedef std::map PathsMap; PathsMap saved_files_; + // Maps file system id to file path, used by the file system requests + // sent from devtools. + typedef std::map WorkspaceMap; + WorkspaceMap saved_paths_; + DISALLOW_COPY_AND_ASSIGN(NativeWindow); }; From ed244648d07fe0a97a5d75da903ed7aea0b3fd78 Mon Sep 17 00:00:00 2001 From: BobCochran Date: Thu, 4 Jun 2015 21:03:45 -0400 Subject: [PATCH 0156/1293] Update build instructions for Linux --- docs/development/build-instructions-linux.md | 45 ++++++++++++++++---- 1 file changed, 37 insertions(+), 8 deletions(-) diff --git a/docs/development/build-instructions-linux.md b/docs/development/build-instructions-linux.md index 38918f19ad98..06b1561743ef 100644 --- a/docs/development/build-instructions-linux.md +++ b/docs/development/build-instructions-linux.md @@ -2,8 +2,8 @@ ## Prerequisites -* Python 2.7 -* [Node.js](http://nodejs.org) +* Python 2.7.x +* [Node.js] (http://nodejs.org) * Clang 3.4 or later * Development headers of GTK+ and libnotify @@ -13,9 +13,23 @@ On Ubuntu you could install the libraries via: $ sudo apt-get install build-essential clang libdbus-1-dev libgtk2.0-dev \ libnotify-dev libgnome-keyring-dev libgconf2-dev \ libasound2-dev libcap-dev libcups2-dev libxtst-dev \ - gcc-multilib g++-multilib + libxss1 gcc-multilib g++-multilib ``` +## If You Use Virtual Machines For Building + +If you plan to build electron on a virtual machine, you will need a fixed-size +device container of at least 25 gigabytes in size. The default disk sizes +suggested by VirtualBox are much too small. You will risk running out of space. +If creating a Ubuntu virtual machine under VirtualBox, do not partition the +disk using LVM, which is the Ubuntu installer default. Instead do all +partitioning with ext4 which is offered as an alternative to LVM. This way +if your vdi container does run out of space, you can use VirtualBox and gparted +utilities to increase the container size without needing to resize +LVM Volume Groups as an additional task. You may never have a need for LVM +in a virtual machine. + + ## Getting the code ```bash @@ -25,8 +39,9 @@ $ git clone https://github.com/atom/electron.git ## Bootstrapping The bootstrap script will download all necessary build dependencies and create -build project files. Notice that we're using `ninja` to build Electron so -there is no `Makefile` generated. +build project files. You must have Python 2.7.x for the script to succeed. +Downloading certain files could take a long time. Notice that we are using +`ninja` to build Electron so there is no `Makefile` generated. ```bash $ cd electron @@ -35,19 +50,33 @@ $ ./script/bootstrap.py -v ## Building -Build both `Release` and `Debug` targets: +If you would like to build both `Release` and `Debug` targets: ```bash $ ./script/build.py ``` -You can also only build the `Debug` target: +This script will cause a very large Electron executable to be placed in +the directory `out/R`. The file size is in excess of 1.3 gigabytes. This +happens because the Release target binary contains debugging symbols. +To reduce the file size, run the `create-dist.py` script: + +```bash +$ ./script/create-dist.py +``` + +This will put a working distribution with much smaller file sizes in +the `dist` directory. After running the create-dist.py script, you +may want to remove the 1.3+ gigabyte binary which is still in out/R. + +You can also build the `Debug` target only: ```bash $ ./script/build.py -c D ``` -After building is done, you can find `atom` under `out/D`. +After building is done, you can find the `electron` debug binary +under `out/D`. ## Troubleshooting From 66b3972fbce15747c4b4a455b21b1f9f29c486d1 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 5 Jun 2015 10:02:42 +0800 Subject: [PATCH 0157/1293] Fix typo --- atom/browser/default_app/main.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/atom/browser/default_app/main.js b/atom/browser/default_app/main.js index 3ca8081e23c0..f59b6e0efe7a 100644 --- a/atom/browser/default_app/main.js +++ b/atom/browser/default_app/main.js @@ -124,7 +124,7 @@ app.once('ready', function() { click: function() { var focusedWindow = BrowserWindow.getFocusedWindow(); if (focusedWindow) - mainWindow.restart(); + focusedWindow.reload(); } }, { From 7f42c0fa2116313de0d9ac5e7513dc5bd1388fed Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 5 Jun 2015 13:27:13 +0800 Subject: [PATCH 0158/1293] Update brightray --- vendor/brightray | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/brightray b/vendor/brightray index e9f49690e3f2..d888f67b75a3 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit e9f49690e3f2d16c6bc4f70fca6b11987745ceac +Subproject commit d888f67b75a387181475df4eef062fab1bffee72 From 7f7cdbf775625a034d2adf1da1cb77aaf7b24c43 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 5 Jun 2015 13:32:01 +0800 Subject: [PATCH 0159/1293] Remove NativeWindow::CallDevToolsFunction --- atom/browser/native_window.cc | 46 ++++++++++++----------------------- atom/browser/native_window.h | 6 ----- 2 files changed, 16 insertions(+), 36 deletions(-) diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index d63c7a14f7c7..c254ed96042f 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -869,7 +869,8 @@ void NativeWindow::DevToolsSaveToFile(const std::string& url, base::FilePath default_path(base::FilePath::FromUTF8Unsafe(url)); if (!file_dialog::ShowSaveDialog(this, url, default_path, filters, &path)) { base::StringValue url_value(url); - CallDevToolsFunction("DevToolsAPI.canceledSaveURL", &url_value); + inspectable_web_contents()->CallClientFunction( + "DevToolsAPI.canceledSaveURL", &url_value, nullptr, nullptr); return; } } @@ -879,7 +880,8 @@ void NativeWindow::DevToolsSaveToFile(const std::string& url, // Notify devtools. base::StringValue url_value(url); - CallDevToolsFunction("DevToolsAPI.savedURL", &url_value); + inspectable_web_contents()->CallClientFunction( + "DevToolsAPI.savedURL", &url_value, nullptr, nullptr); } void NativeWindow::DevToolsAppendToFile(const std::string& url, @@ -891,7 +893,8 @@ void NativeWindow::DevToolsAppendToFile(const std::string& url, // Notify devtools. base::StringValue url_value(url); - CallDevToolsFunction("DevToolsAPI.appendedToURL", &url_value); + inspectable_web_contents()->CallClientFunction( + "DevToolsAPI.appendedToURL", &url_value, nullptr, nullptr); } void NativeWindow::DevToolsFocused() { @@ -929,8 +932,11 @@ void NativeWindow::DevToolsAddFileSystem() { scoped_ptr file_system_value; if (!file_system.file_system_path.empty()) file_system_value.reset(CreateFileSystemValue(file_system)); - CallDevToolsFunction("DevToolsAPI.fileSystemAdded", error_string_value.get(), - file_system_value.get(), nullptr); + inspectable_web_contents()->CallClientFunction( + "DevToolsAPI.fileSystemAdded", + error_string_value.get(), + file_system_value.get(), + nullptr); } void NativeWindow::DevToolsRemoveFileSystem( @@ -945,8 +951,11 @@ void NativeWindow::DevToolsRemoveFileSystem( } base::StringValue file_system_path_value(file_system_path); - CallDevToolsFunction("DevToolsAPI.fileSystemRemoved", - &file_system_path_value, nullptr, nullptr); + inspectable_web_contents()->CallClientFunction( + "DevToolsAPI.fileSystemRemoved", + &file_system_path_value, + nullptr, + nullptr); } void NativeWindow::ScheduleUnresponsiveEvent(int ms) { @@ -977,27 +986,4 @@ void NativeWindow::OnCapturePageDone(const CapturePageCallback& callback, callback.Run(bitmap); } -void NativeWindow::CallDevToolsFunction(const std::string& function_name, - const base::Value* arg1, - const base::Value* arg2, - const base::Value* arg3) { - std::string params; - if (arg1) { - std::string json; - base::JSONWriter::Write(arg1, &json); - params.append(json); - if (arg2) { - base::JSONWriter::Write(arg2, &json); - params.append(", " + json); - if (arg3) { - base::JSONWriter::Write(arg3, &json); - params.append(", " + json); - } - } - } - base::string16 javascript = - base::UTF8ToUTF16(function_name + "(" + params + ");"); - GetDevToolsWebContents()->GetMainFrame()->ExecuteJavaScript(javascript); -} - } // namespace atom diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index eb3aad65986a..fb614bad2bde 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -345,12 +345,6 @@ class NativeWindow : public brightray::DefaultWebContentsDelegate, // Dispatch unresponsive event to observers. void NotifyWindowUnresponsive(); - // Call a function in devtools. - void CallDevToolsFunction(const std::string& function_name, - const base::Value* arg1 = NULL, - const base::Value* arg2 = NULL, - const base::Value* arg3 = NULL); - // Called when CapturePage has done. void OnCapturePageDone(const CapturePageCallback& callback, const SkBitmap& bitmap, From e8f33f51fbed6a4e803b9dbba0513c7cca1252c5 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 5 Jun 2015 13:41:45 +0800 Subject: [PATCH 0160/1293] Use DefaultWebContentsDelegate in api::WebContents --- atom/browser/api/atom_api_web_contents.cc | 15 --------------- atom/browser/api/atom_api_web_contents.h | 9 +-------- 2 files changed, 1 insertion(+), 23 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index e06d2b2419b3..ac96a64d4948 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -21,7 +21,6 @@ #include "base/strings/string_util.h" #include "base/strings/utf_string_conversions.h" #include "brightray/browser/inspectable_web_contents.h" -#include "brightray/browser/media/media_stream_devices_controller.h" #include "content/public/browser/favicon_status.h" #include "content/public/browser/guest_host.h" #include "content/public/browser/navigation_details.h" @@ -223,20 +222,6 @@ void WebContents::EnumerateDirectory(content::WebContents* guest, web_dialog_helper_->EnumerateDirectory(guest, request_id, path); } -bool WebContents::CheckMediaAccessPermission(content::WebContents* web_contents, - const GURL& security_origin, - content::MediaStreamType type) { - return true; -} - -void WebContents::RequestMediaAccessPermission( - content::WebContents*, - const content::MediaStreamRequest& request, - const content::MediaResponseCallback& callback) { - brightray::MediaStreamDevicesController controller(request, callback); - controller.TakeAction(); -} - void WebContents::HandleKeyboardEvent( content::WebContents* source, const content::NativeWebKeyboardEvent& event) { diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index 062831577aad..14de69fc9031 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -51,7 +51,7 @@ struct SetSizeParams { class WebContents : public mate::EventEmitter, public content::BrowserPluginGuestDelegate, - public content::WebContentsDelegate, + public brightray::DefaultWebContentsDelegate, public content::WebContentsObserver, public content::GpuDataManagerObserver { public: @@ -157,13 +157,6 @@ class WebContents : public mate::EventEmitter, void EnumerateDirectory(content::WebContents* web_contents, int request_id, const base::FilePath& path) override; - bool CheckMediaAccessPermission(content::WebContents* web_contents, - const GURL& security_origin, - content::MediaStreamType type) override; - void RequestMediaAccessPermission( - content::WebContents*, - const content::MediaStreamRequest&, - const content::MediaResponseCallback&) override; void HandleKeyboardEvent( content::WebContents* source, const content::NativeWebKeyboardEvent& event) override; From 19d742de37cbb60561370181b4448da479fd32ed Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 5 Jun 2015 13:49:12 +0800 Subject: [PATCH 0161/1293] Add CommonWebContentsDelegate --- atom/browser/api/atom_api_web_contents.cc | 6 +++-- atom/browser/api/atom_api_web_contents.h | 4 +-- atom/browser/common_web_contents_delegate.cc | 16 ++++++++++++ atom/browser/common_web_contents_delegate.h | 27 ++++++++++++++++++++ atom/browser/native_window.cc | 3 ++- atom/browser/native_window.h | 4 +-- filenames.gypi | 2 ++ 7 files changed, 55 insertions(+), 7 deletions(-) create mode 100644 atom/browser/common_web_contents_delegate.cc create mode 100644 atom/browser/common_web_contents_delegate.h diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index ac96a64d4948..02ac372f876a 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -109,7 +109,8 @@ content::ServiceWorkerContext* GetServiceWorkerContext( } // namespace WebContents::WebContents(content::WebContents* web_contents) - : content::WebContentsObserver(web_contents), + : CommonWebContentsDelegate(false), + content::WebContentsObserver(web_contents), guest_instance_id_(-1), guest_opaque_(true), guest_host_(nullptr), @@ -118,7 +119,8 @@ WebContents::WebContents(content::WebContents* web_contents) } WebContents::WebContents(const mate::Dictionary& options) - : guest_instance_id_(-1), + : CommonWebContentsDelegate(true), + guest_instance_id_(-1), guest_opaque_(true), guest_host_(nullptr), auto_size_enabled_(false), diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index 14de69fc9031..97a433ed36ce 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -9,7 +9,7 @@ #include #include "atom/browser/api/event_emitter.h" -#include "brightray/browser/default_web_contents_delegate.h" +#include "atom/browser/common_web_contents_delegate.h" #include "content/public/browser/browser_plugin_guest_delegate.h" #include "content/public/common/favicon_url.h" #include "content/public/browser/web_contents_delegate.h" @@ -51,7 +51,7 @@ struct SetSizeParams { class WebContents : public mate::EventEmitter, public content::BrowserPluginGuestDelegate, - public brightray::DefaultWebContentsDelegate, + public CommonWebContentsDelegate, public content::WebContentsObserver, public content::GpuDataManagerObserver { public: diff --git a/atom/browser/common_web_contents_delegate.cc b/atom/browser/common_web_contents_delegate.cc new file mode 100644 index 000000000000..46e872384f02 --- /dev/null +++ b/atom/browser/common_web_contents_delegate.cc @@ -0,0 +1,16 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#include "atom/browser/common_web_contents_delegate.h" + +namespace atom { + +CommonWebContentsDelegate::CommonWebContentsDelegate(bool is_guest) + : is_guest_(is_guest) { +} + +CommonWebContentsDelegate::~CommonWebContentsDelegate() { +} + +} // namespace atom diff --git a/atom/browser/common_web_contents_delegate.h b/atom/browser/common_web_contents_delegate.h new file mode 100644 index 000000000000..f449bf23b9b3 --- /dev/null +++ b/atom/browser/common_web_contents_delegate.h @@ -0,0 +1,27 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#ifndef ATOM_BROWSER_COMMON_WEB_CONTENTS_DELEGATE_H_ +#define ATOM_BROWSER_COMMON_WEB_CONTENTS_DELEGATE_H_ + +#include "brightray/browser/default_web_contents_delegate.h" + +namespace atom { + +class CommonWebContentsDelegate : public brightray::DefaultWebContentsDelegate { + public: + explicit CommonWebContentsDelegate(bool is_guest); + virtual ~CommonWebContentsDelegate(); + + bool is_guest() const { return is_guest_; }; + + private: + const bool is_guest_; + + DISALLOW_COPY_AND_ASSIGN(CommonWebContentsDelegate); +}; + +} // namespace atom + +#endif // ATOM_BROWSER_COMMON_WEB_CONTENTS_DELEGATE_H_ diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index c254ed96042f..6c11e97e96a6 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -151,7 +151,8 @@ base::DictionaryValue* CreateFileSystemValue( NativeWindow::NativeWindow(content::WebContents* web_contents, const mate::Dictionary& options) - : content::WebContentsObserver(web_contents), + : CommonWebContentsDelegate(false), + content::WebContentsObserver(web_contents), has_frame_(true), transparent_(false), enable_larger_than_screen_(false), diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index fb614bad2bde..2cfbe135ef67 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -9,13 +9,13 @@ #include #include +#include "atom/browser/common_web_contents_delegate.h" #include "atom/browser/native_window_observer.h" #include "atom/browser/ui/accelerator_util.h" #include "base/cancelable_callback.h" #include "base/memory/scoped_ptr.h" #include "base/memory/weak_ptr.h" #include "base/observer_list.h" -#include "brightray/browser/default_web_contents_delegate.h" #include "brightray/browser/inspectable_web_contents_delegate.h" #include "brightray/browser/inspectable_web_contents_impl.h" #include "content/public/browser/notification_registrar.h" @@ -54,7 +54,7 @@ class AtomJavaScriptDialogManager; struct DraggableRegion; class WebDialogHelper; -class NativeWindow : public brightray::DefaultWebContentsDelegate, +class NativeWindow : public CommonWebContentsDelegate, public brightray::InspectableWebContentsDelegate, public content::WebContentsObserver, public content::NotificationObserver { diff --git a/filenames.gypi b/filenames.gypi index 2bef38832548..6ece2ba634c7 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -123,6 +123,8 @@ 'atom/browser/browser_mac.mm', 'atom/browser/browser_win.cc', 'atom/browser/browser_observer.h', + 'atom/browser/common_web_contents_delegate.cc', + 'atom/browser/common_web_contents_delegate.h', 'atom/browser/javascript_environment.cc', 'atom/browser/javascript_environment.h', 'atom/browser/mac/atom_application.h', From 92b15c81e9473c385bf42d1ea07dfebccfba8120 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 5 Jun 2015 14:55:07 +0800 Subject: [PATCH 0162/1293] Manage InspectableWebContents in CommonWebContentsDelegate --- atom/browser/api/atom_api_web_contents.cc | 9 - atom/browser/api/atom_api_web_contents.h | 5 - atom/browser/common_web_contents_delegate.cc | 214 ++++++++++++++++++- atom/browser/common_web_contents_delegate.h | 64 +++++- atom/browser/native_window.cc | 193 +---------------- atom/browser/native_window.h | 55 ----- vendor/brightray | 2 +- 7 files changed, 280 insertions(+), 262 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 02ac372f876a..6ec4ea0b679d 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -8,7 +8,6 @@ #include "atom/browser/atom_browser_client.h" #include "atom/browser/atom_browser_context.h" -#include "atom/browser/atom_javascript_dialog_manager.h" #include "atom/browser/native_window.h" #include "atom/browser/web_dialog_helper.h" #include "atom/browser/web_view_manager.h" @@ -201,14 +200,6 @@ content::WebContents* WebContents::OpenURLFromTab( return web_contents(); } -content::JavaScriptDialogManager* WebContents::GetJavaScriptDialogManager( - content::WebContents* source) { - if (!dialog_manager_) - dialog_manager_.reset(new AtomJavaScriptDialogManager); - - return dialog_manager_.get(); -} - void WebContents::RunFileChooser(content::WebContents* guest, const content::FileChooserParams& params) { if (!web_dialog_helper_) diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index 97a433ed36ce..e70b25d72353 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -12,7 +12,6 @@ #include "atom/browser/common_web_contents_delegate.h" #include "content/public/browser/browser_plugin_guest_delegate.h" #include "content/public/common/favicon_url.h" -#include "content/public/browser/web_contents_delegate.h" #include "content/public/browser/web_contents_observer.h" #include "content/public/browser/gpu_data_manager_observer.h" #include "native_mate/handle.h" @@ -28,7 +27,6 @@ class Dictionary; namespace atom { -class AtomJavaScriptDialogManager; class WebDialogHelper; namespace api { @@ -150,8 +148,6 @@ class WebContents : public mate::EventEmitter, content::WebContents* OpenURLFromTab( content::WebContents* source, const content::OpenURLParams& params) override; - content::JavaScriptDialogManager* GetJavaScriptDialogManager( - content::WebContents* source) override; void RunFileChooser(content::WebContents* web_contents, const content::FileChooserParams& params) override; void EnumerateDirectory(content::WebContents* web_contents, @@ -236,7 +232,6 @@ class WebContents : public mate::EventEmitter, gfx::Size GetDefaultSize() const; scoped_ptr web_dialog_helper_; - scoped_ptr dialog_manager_; // Unique ID for a guest WebContents. int guest_instance_id_; diff --git a/atom/browser/common_web_contents_delegate.cc b/atom/browser/common_web_contents_delegate.cc index 46e872384f02..2360a9748c64 100644 --- a/atom/browser/common_web_contents_delegate.cc +++ b/atom/browser/common_web_contents_delegate.cc @@ -4,13 +4,225 @@ #include "atom/browser/common_web_contents_delegate.h" +#include "atom/browser/atom_javascript_dialog_manager.h" +#include "atom/browser/native_window.h" +#include "atom/browser/ui/file_dialog.h" +#include "content/public/browser/child_process_security_policy.h" +#include "content/public/browser/render_process_host.h" +#include "content/public/browser/render_view_host.h" +#include "storage/browser/fileapi/isolated_context.h" + namespace atom { +namespace { + +struct FileSystem { + FileSystem() { + } + FileSystem(const std::string& file_system_name, + const std::string& root_url, + const std::string& file_system_path) + : file_system_name(file_system_name), + root_url(root_url), + file_system_path(file_system_path) { + } + + std::string file_system_name; + std::string root_url; + std::string file_system_path; +}; + +std::string RegisterFileSystem(content::WebContents* web_contents, + const base::FilePath& path, + std::string* registered_name) { + auto isolated_context = storage::IsolatedContext::GetInstance(); + std::string file_system_id = isolated_context->RegisterFileSystemForPath( + storage::kFileSystemTypeNativeLocal, + std::string(), + path, + registered_name); + + content::ChildProcessSecurityPolicy* policy = + content::ChildProcessSecurityPolicy::GetInstance(); + content::RenderViewHost* render_view_host = web_contents->GetRenderViewHost(); + int renderer_id = render_view_host->GetProcess()->GetID(); + policy->GrantReadFileSystem(renderer_id, file_system_id); + policy->GrantWriteFileSystem(renderer_id, file_system_id); + policy->GrantCreateFileForFileSystem(renderer_id, file_system_id); + policy->GrantDeleteFromFileSystem(renderer_id, file_system_id); + + if (!policy->CanReadFile(renderer_id, path)) + policy->GrantReadFile(renderer_id, path); + + return file_system_id; +} + +FileSystem CreateFileSystemStruct( + content::WebContents* web_contents, + const std::string& file_system_id, + const std::string& registered_name, + const std::string& file_system_path) { + const GURL origin = web_contents->GetURL().GetOrigin(); + std::string file_system_name = + storage::GetIsolatedFileSystemName(origin, file_system_id); + std::string root_url = storage::GetIsolatedFileSystemRootURIString( + origin, file_system_id, registered_name); + return FileSystem(file_system_name, root_url, file_system_path); +} + +base::DictionaryValue* CreateFileSystemValue(const FileSystem& file_system) { + base::DictionaryValue* file_system_value = new base::DictionaryValue(); + file_system_value->SetString("fileSystemName", file_system.file_system_name); + file_system_value->SetString("rootURL", file_system.root_url); + file_system_value->SetString("fileSystemPath", file_system.file_system_path); + return file_system_value; +} + +} // namespace + CommonWebContentsDelegate::CommonWebContentsDelegate(bool is_guest) - : is_guest_(is_guest) { + : is_guest_(is_guest), + owner_window_(nullptr) { } CommonWebContentsDelegate::~CommonWebContentsDelegate() { } +void CommonWebContentsDelegate::InitWithWebContents( + content::WebContents* web_contents, + NativeWindow* owner_window) { + owner_window_ = owner_window; + web_contents->SetDelegate(this); + + // Create InspectableWebContents. + web_contents_.reset(brightray::InspectableWebContents::Create(web_contents)); + web_contents_->SetDelegate(this); +} + +void CommonWebContentsDelegate::DestroyWebContents() { + web_contents_.reset(); +} + +content::JavaScriptDialogManager* +CommonWebContentsDelegate::GetJavaScriptDialogManager( + content::WebContents* source) { + if (!dialog_manager_) + dialog_manager_.reset(new AtomJavaScriptDialogManager); + + return dialog_manager_.get(); +} + +content::WebContents* CommonWebContentsDelegate::GetWebContents() const { + if (!web_contents_) + return nullptr; + return web_contents_->GetWebContents(); +} + +content::WebContents* +CommonWebContentsDelegate::GetDevToolsWebContents() const { + if (!web_contents_) + return nullptr; + return web_contents_->GetDevToolsWebContents(); +} + +void CommonWebContentsDelegate::DevToolsSaveToFile( + const std::string& url, const std::string& content, bool save_as) { + base::FilePath path; + PathsMap::iterator it = saved_files_.find(url); + if (it != saved_files_.end() && !save_as) { + path = it->second; + } else { + file_dialog::Filters filters; + base::FilePath default_path(base::FilePath::FromUTF8Unsafe(url)); + if (!file_dialog::ShowSaveDialog(owner_window_, url, default_path, + filters, &path)) { + base::StringValue url_value(url); + web_contents_->CallClientFunction( + "DevToolsAPI.canceledSaveURL", &url_value, nullptr, nullptr); + return; + } + } + + saved_files_[url] = path; + base::WriteFile(path, content.data(), content.size()); + + // Notify devtools. + base::StringValue url_value(url); + web_contents_->CallClientFunction( + "DevToolsAPI.savedURL", &url_value, nullptr, nullptr); +} + +void CommonWebContentsDelegate::DevToolsAppendToFile( + const std::string& url, const std::string& content) { + PathsMap::iterator it = saved_files_.find(url); + if (it == saved_files_.end()) + return; + base::AppendToFile(it->second, content.data(), content.size()); + + // Notify devtools. + base::StringValue url_value(url); + web_contents_->CallClientFunction( + "DevToolsAPI.appendedToURL", &url_value, nullptr, nullptr); +} + +void CommonWebContentsDelegate::DevToolsAddFileSystem() { + file_dialog::Filters filters; + base::FilePath default_path; + std::vector paths; + int flag = file_dialog::FILE_DIALOG_OPEN_DIRECTORY; + if (!file_dialog::ShowOpenDialog(owner_window_, "", default_path, + filters, flag, &paths)) + return; + + base::FilePath path = paths[0]; + std::string registered_name; + std::string file_system_id = RegisterFileSystem(GetDevToolsWebContents(), + path, + ®istered_name); + + WorkspaceMap::iterator it = saved_paths_.find(file_system_id); + if (it != saved_paths_.end()) + return; + + saved_paths_[file_system_id] = path; + + FileSystem file_system = CreateFileSystemStruct(GetDevToolsWebContents(), + file_system_id, + registered_name, + path.AsUTF8Unsafe()); + + scoped_ptr error_string_value( + new base::StringValue(std::string())); + scoped_ptr file_system_value; + if (!file_system.file_system_path.empty()) + file_system_value.reset(CreateFileSystemValue(file_system)); + web_contents_->CallClientFunction( + "DevToolsAPI.fileSystemAdded", + error_string_value.get(), + file_system_value.get(), + nullptr); +} + +void CommonWebContentsDelegate::DevToolsRemoveFileSystem( + const std::string& file_system_path) { + if (!web_contents_) + return; + + base::FilePath path = base::FilePath::FromUTF8Unsafe(file_system_path); + storage::IsolatedContext::GetInstance()->RevokeFileSystemByPath(path); + + for (auto it = saved_paths_.begin(); it != saved_paths_.end(); ++it) + if (it->second == path) { + saved_paths_.erase(it); + break; + } + + base::StringValue file_system_path_value(file_system_path); + web_contents_->CallClientFunction( + "DevToolsAPI.fileSystemRemoved", + &file_system_path_value, + nullptr, + nullptr); +} + } // namespace atom diff --git a/atom/browser/common_web_contents_delegate.h b/atom/browser/common_web_contents_delegate.h index f449bf23b9b3..d383aac1ad00 100644 --- a/atom/browser/common_web_contents_delegate.h +++ b/atom/browser/common_web_contents_delegate.h @@ -5,20 +5,82 @@ #ifndef ATOM_BROWSER_COMMON_WEB_CONTENTS_DELEGATE_H_ #define ATOM_BROWSER_COMMON_WEB_CONTENTS_DELEGATE_H_ +#include + #include "brightray/browser/default_web_contents_delegate.h" +#include "brightray/browser/inspectable_web_contents_impl.h" +#include "brightray/browser/inspectable_web_contents_delegate.h" namespace atom { -class CommonWebContentsDelegate : public brightray::DefaultWebContentsDelegate { +class AtomJavaScriptDialogManager; +class NativeWindow; + +class CommonWebContentsDelegate + : public brightray::DefaultWebContentsDelegate, + public brightray::InspectableWebContentsDelegate { public: explicit CommonWebContentsDelegate(bool is_guest); virtual ~CommonWebContentsDelegate(); + // Create a InspectableWebContents object and takes onwership of + // |web_contents|. + void InitWithWebContents(content::WebContents* web_contents, + NativeWindow* owner_window); + + // Destroy the managed InspectableWebContents object. + void DestroyWebContents(); + + // Returns the WebContents managed by this delegate. + content::WebContents* GetWebContents() const; + + // Returns the WebContents of devtools. + content::WebContents* GetDevToolsWebContents() const; + + brightray::InspectableWebContents* inspectable_web_contents() const { + return web_contents_.get(); + } + bool is_guest() const { return is_guest_; }; + protected: + // content::WebContentsDelegate: + content::JavaScriptDialogManager* GetJavaScriptDialogManager( + content::WebContents* source) override; + + // brightray::InspectableWebContentsDelegate: + void DevToolsSaveToFile(const std::string& url, + const std::string& content, + bool save_as) override; + void DevToolsAppendToFile(const std::string& url, + const std::string& content) override; + void DevToolsAddFileSystem() override; + void DevToolsRemoveFileSystem(const std::string& file_system_path) override; + private: + // Whether this is guest WebContents or NativeWindow. const bool is_guest_; + // The window that this WebContents belongs to. + NativeWindow* owner_window_; + + scoped_ptr dialog_manager_; + + // The stored InspectableWebContents object. + // Notice that web_contents_ must be placed after dialog_manager_, so we can + // make sure web_contents_ is destroyed before dialog_manager_, otherwise a + // crash would happen. + scoped_ptr web_contents_; + + // Maps url to file path, used by the file requests sent from devtools. + typedef std::map PathsMap; + PathsMap saved_files_; + + // Maps file system id to file path, used by the file system requests + // sent from devtools. + typedef std::map WorkspaceMap; + WorkspaceMap saved_paths_; + DISALLOW_COPY_AND_ASSIGN(CommonWebContentsDelegate); }; diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 6c11e97e96a6..b286caf6c480 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -9,9 +9,7 @@ #include #include "atom/browser/atom_browser_context.h" -#include "atom/browser/atom_javascript_dialog_manager.h" #include "atom/browser/browser.h" -#include "atom/browser/ui/file_dialog.h" #include "atom/browser/web_dialog_helper.h" #include "atom/browser/window_list.h" #include "atom/common/api/api_messages.h" @@ -33,7 +31,6 @@ #include "chrome/browser/printing/print_view_manager_basic.h" #include "chrome/browser/ui/browser_dialogs.h" #include "content/browser/renderer_host/render_widget_host_impl.h" -#include "content/public/browser/child_process_security_policy.h" #include "content/public/browser/devtools_agent_host.h" #include "content/public/browser/invalidate_type.h" #include "content/public/browser/navigation_entry.h" @@ -51,7 +48,6 @@ #include "content/public/common/web_preferences.h" #include "ipc/ipc_message_macros.h" #include "native_mate/dictionary.h" -#include "storage/browser/fileapi/isolated_context.h" #include "ui/gfx/codec/png_codec.h" #include "ui/gfx/geometry/size_conversions.h" #include "ui/gfx/geometry/point.h" @@ -91,62 +87,6 @@ std::string RemoveWhitespace(const std::string& str) { return str; } -storage::IsolatedContext* isolated_context() { - storage::IsolatedContext* context = - storage::IsolatedContext::GetInstance(); - DCHECK(context); - return context; -} - -std::string RegisterFileSystem(content::WebContents* web_contents, - const base::FilePath& path, - std::string* registered_name) { - std::string file_system_id = isolated_context()->RegisterFileSystemForPath( - storage::kFileSystemTypeNativeLocal, - std::string(), - path, - registered_name); - - content::ChildProcessSecurityPolicy* policy = - content::ChildProcessSecurityPolicy::GetInstance(); - content::RenderViewHost* render_view_host = web_contents->GetRenderViewHost(); - int renderer_id = render_view_host->GetProcess()->GetID(); - policy->GrantReadFileSystem(renderer_id, file_system_id); - policy->GrantWriteFileSystem(renderer_id, file_system_id); - policy->GrantCreateFileForFileSystem(renderer_id, file_system_id); - policy->GrantDeleteFromFileSystem(renderer_id, file_system_id); - - if (!policy->CanReadFile(renderer_id, path)) - policy->GrantReadFile(renderer_id, path); - - return file_system_id; -} - -NativeWindow::FileSystem CreateFileSystemStruct( - content::WebContents* web_contents, - const std::string& file_system_id, - const std::string& registered_name, - const std::string& file_system_path) { - const GURL origin = web_contents->GetURL().GetOrigin(); - std::string file_system_name = - storage::GetIsolatedFileSystemName(origin, file_system_id); - std::string root_url = storage::GetIsolatedFileSystemRootURIString( - origin, file_system_id, registered_name); - - return NativeWindow::FileSystem(file_system_name, - root_url, - file_system_path); -} - -base::DictionaryValue* CreateFileSystemValue( - NativeWindow::FileSystem file_system) { - base::DictionaryValue* file_system_value = new base::DictionaryValue(); - file_system_value->SetString("fileSystemName", file_system.file_system_name); - file_system_value->SetString("rootURL", file_system.root_url); - file_system_value->SetString("fileSystemPath", file_system.file_system_path); - return file_system_value; -} - } // namespace NativeWindow::NativeWindow(content::WebContents* web_contents, @@ -162,11 +102,11 @@ NativeWindow::NativeWindow(content::WebContents* web_contents, html_fullscreen_(false), native_fullscreen_(false), zoom_factor_(1.0), - weak_factory_(this), - inspectable_web_contents_( - brightray::InspectableWebContents::Create(web_contents)) { + weak_factory_(this) { printing::PrintViewManagerBasic::CreateForWebContents(web_contents); + InitWithWebContents(web_contents, this); + options.Get(switches::kFrame, &has_frame_); options.Get(switches::kTransparent, &transparent_); options.Get(switches::kEnableLargerThanScreen, &enable_larger_than_screen_); @@ -198,9 +138,6 @@ NativeWindow::NativeWindow(content::WebContents* web_contents, // Read the zoom factor before any navigation. options.Get(switches::kZoomFactor, &zoom_factor_); - web_contents->SetDelegate(this); - inspectable_web_contents()->SetDelegate(this); - WindowList::AddWindow(this); // Override the user agent to contain application and atom-shell's version. @@ -431,13 +368,6 @@ void NativeWindow::CapturePage(const gfx::Rect& rect, kBGRA_8888_SkColorType); } -void NativeWindow::DestroyWebContents() { - if (!inspectable_web_contents_) - return; - - inspectable_web_contents_.reset(); -} - void NativeWindow::CloseWebContents() { bool prevent_default = false; FOR_EACH_OBSERVER(NativeWindowObserver, @@ -467,18 +397,6 @@ void NativeWindow::CloseWebContents() { web_contents->Close(); } -content::WebContents* NativeWindow::GetWebContents() const { - if (!inspectable_web_contents_) - return nullptr; - return inspectable_web_contents()->GetWebContents(); -} - -content::WebContents* NativeWindow::GetDevToolsWebContents() const { - if (!inspectable_web_contents_) - return nullptr; - return inspectable_web_contents()->devtools_web_contents(); -} - void NativeWindow::AppendExtraCommandLineSwitches( base::CommandLine* command_line) { // Append --node-integration to renderer process. @@ -694,14 +612,6 @@ content::WebContents* NativeWindow::OpenURLFromTab( return source; } -content::JavaScriptDialogManager* NativeWindow::GetJavaScriptDialogManager( - content::WebContents* source) { - if (!dialog_manager_) - dialog_manager_.reset(new AtomJavaScriptDialogManager); - - return dialog_manager_.get(); -} - void NativeWindow::RenderViewCreated( content::RenderViewHost* render_view_host) { if (!transparent_) @@ -858,107 +768,10 @@ void NativeWindow::Observe(int type, } } -void NativeWindow::DevToolsSaveToFile(const std::string& url, - const std::string& content, - bool save_as) { - base::FilePath path; - PathsMap::iterator it = saved_files_.find(url); - if (it != saved_files_.end() && !save_as) { - path = it->second; - } else { - file_dialog::Filters filters; - base::FilePath default_path(base::FilePath::FromUTF8Unsafe(url)); - if (!file_dialog::ShowSaveDialog(this, url, default_path, filters, &path)) { - base::StringValue url_value(url); - inspectable_web_contents()->CallClientFunction( - "DevToolsAPI.canceledSaveURL", &url_value, nullptr, nullptr); - return; - } - } - - saved_files_[url] = path; - base::WriteFile(path, content.data(), content.size()); - - // Notify devtools. - base::StringValue url_value(url); - inspectable_web_contents()->CallClientFunction( - "DevToolsAPI.savedURL", &url_value, nullptr, nullptr); -} - -void NativeWindow::DevToolsAppendToFile(const std::string& url, - const std::string& content) { - PathsMap::iterator it = saved_files_.find(url); - if (it == saved_files_.end()) - return; - base::AppendToFile(it->second, content.data(), content.size()); - - // Notify devtools. - base::StringValue url_value(url); - inspectable_web_contents()->CallClientFunction( - "DevToolsAPI.appendedToURL", &url_value, nullptr, nullptr); -} - void NativeWindow::DevToolsFocused() { FOR_EACH_OBSERVER(NativeWindowObserver, observers_, OnDevToolsFocus()); } -void NativeWindow::DevToolsAddFileSystem() { - file_dialog::Filters filters; - base::FilePath default_path; - std::vector paths; - int flag = file_dialog::FILE_DIALOG_OPEN_DIRECTORY; - if (!file_dialog::ShowOpenDialog(this, "", default_path, - filters, flag, &paths)) - return; - - base::FilePath path = paths[0]; - std::string registered_name; - std::string file_system_id = RegisterFileSystem(GetDevToolsWebContents(), - path, - ®istered_name); - - WorkspaceMap::iterator it = saved_paths_.find(file_system_id); - if (it != saved_paths_.end()) - return; - - saved_paths_[file_system_id] = path; - - FileSystem file_system = CreateFileSystemStruct(GetDevToolsWebContents(), - file_system_id, - registered_name, - path.AsUTF8Unsafe()); - - scoped_ptr error_string_value( - new base::StringValue(std::string())); - scoped_ptr file_system_value; - if (!file_system.file_system_path.empty()) - file_system_value.reset(CreateFileSystemValue(file_system)); - inspectable_web_contents()->CallClientFunction( - "DevToolsAPI.fileSystemAdded", - error_string_value.get(), - file_system_value.get(), - nullptr); -} - -void NativeWindow::DevToolsRemoveFileSystem( - const std::string& file_system_path) { - base::FilePath path = base::FilePath::FromUTF8Unsafe(file_system_path); - isolated_context()->RevokeFileSystemByPath(path); - - for (auto it = saved_paths_.begin(); it != saved_paths_.end(); ++it) - if (it->second == path) { - saved_paths_.erase(it); - break; - } - - base::StringValue file_system_path_value(file_system_path); - inspectable_web_contents()->CallClientFunction( - "DevToolsAPI.fileSystemRemoved", - &file_system_path_value, - nullptr, - nullptr); -} - void NativeWindow::ScheduleUnresponsiveEvent(int ms) { if (!window_unresposive_closure_.IsCancelled()) return; diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index 2cfbe135ef67..841bfe56b52b 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -16,8 +16,6 @@ #include "base/memory/scoped_ptr.h" #include "base/memory/weak_ptr.h" #include "base/observer_list.h" -#include "brightray/browser/inspectable_web_contents_delegate.h" -#include "brightray/browser/inspectable_web_contents_impl.h" #include "content/public/browser/notification_registrar.h" #include "content/public/browser/notification_observer.h" #include "content/public/browser/readback_types.h" @@ -50,33 +48,15 @@ class MenuModel; namespace atom { -class AtomJavaScriptDialogManager; struct DraggableRegion; class WebDialogHelper; class NativeWindow : public CommonWebContentsDelegate, - public brightray::InspectableWebContentsDelegate, public content::WebContentsObserver, public content::NotificationObserver { public: typedef base::Callback CapturePageCallback; - struct FileSystem { - FileSystem() { - } - FileSystem(const std::string& file_system_name, - const std::string& root_url, - const std::string& file_system_path) - : file_system_name(file_system_name), - root_url(root_url), - file_system_path(file_system_path) { - } - - std::string file_system_name; - std::string root_url; - std::string file_system_path; - }; - class DialogScope { public: explicit DialogScope(NativeWindow* window) @@ -197,16 +177,10 @@ class NativeWindow : public CommonWebContentsDelegate, // Should be called by platform code when user want to close the window. virtual void CloseWebContents(); - // Destroy the WebContents immediately. - virtual void DestroyWebContents(); - base::WeakPtr GetWeakPtr() { return weak_factory_.GetWeakPtr(); } - content::WebContents* GetWebContents() const; - content::WebContents* GetDevToolsWebContents() const; - // Called when renderer process is going to be started. void AppendExtraCommandLineSwitches(base::CommandLine* command_line); void OverrideWebkitPrefs(content::WebPreferences* prefs); @@ -251,11 +225,6 @@ class NativeWindow : public CommonWebContentsDelegate, explicit NativeWindow(content::WebContents* web_contents, const mate::Dictionary& options); - brightray::InspectableWebContentsImpl* inspectable_web_contents() const { - return static_cast( - inspectable_web_contents_.get()); - } - // Called when the window needs to update its draggable region. virtual void UpdateDraggableRegions( const std::vector& regions) = 0; @@ -273,8 +242,6 @@ class NativeWindow : public CommonWebContentsDelegate, content::WebContents* OpenURLFromTab( content::WebContents* source, const content::OpenURLParams& params) override; - content::JavaScriptDialogManager* GetJavaScriptDialogManager( - content::WebContents* source) override; void BeforeUnloadFired(content::WebContents* tab, bool proceed, bool* proceed_to_fire_unload) override; @@ -317,14 +284,7 @@ class NativeWindow : public CommonWebContentsDelegate, const content::NotificationDetails& details) override; // Implementations of brightray::InspectableWebContentsDelegate. - void DevToolsSaveToFile(const std::string& url, - const std::string& content, - bool save_as) override; - void DevToolsAppendToFile(const std::string& url, - const std::string& content) override; void DevToolsFocused() override; - void DevToolsAddFileSystem() override; - void DevToolsRemoveFileSystem(const std::string& file_system_path) override; // Whether window has standard frame. bool has_frame_; @@ -387,21 +347,6 @@ class NativeWindow : public CommonWebContentsDelegate, base::WeakPtrFactory weak_factory_; scoped_ptr web_dialog_helper_; - scoped_ptr dialog_manager_; - - // Notice that inspectable_web_contents_ must be placed after dialog_manager_, - // so we can make sure inspectable_web_contents_ is destroyed before - // dialog_manager_, otherwise a crash would happen. - scoped_ptr inspectable_web_contents_; - - // Maps url to file path, used by the file requests sent from devtools. - typedef std::map PathsMap; - PathsMap saved_files_; - - // Maps file system id to file path, used by the file system requests - // sent from devtools. - typedef std::map WorkspaceMap; - WorkspaceMap saved_paths_; DISALLOW_COPY_AND_ASSIGN(NativeWindow); }; diff --git a/vendor/brightray b/vendor/brightray index d888f67b75a3..190c3dd16291 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit d888f67b75a387181475df4eef062fab1bffee72 +Subproject commit 190c3dd1629141027f0962d0fab82c58853e7c85 From c32aac0a56a5869677534995987bba34513c4b67 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 5 Jun 2015 15:01:51 +0800 Subject: [PATCH 0163/1293] Manage webview with CommonWebContentsDelegate --- atom/browser/api/atom_api_web_contents.cc | 23 ++++++++++++----------- atom/browser/api/atom_api_web_contents.h | 3 --- 2 files changed, 12 insertions(+), 14 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 6ec4ea0b679d..01d96921e063 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -135,9 +135,10 @@ WebContents::WebContents(const mate::Dictionary& options) if (options.Get("isGuest", &is_guest) && is_guest) params.guest_delegate = this; - storage_.reset(brightray::InspectableWebContents::Create(params)); - Observe(storage_->GetWebContents()); - web_contents()->SetDelegate(this); + auto web_contents = content::WebContents::Create(params); + InitWithWebContents(web_contents, GetWindowFromGuest(web_contents)); + + Observe(GetWebContents()); } WebContents::~WebContents() { @@ -449,7 +450,7 @@ void WebContents::WillAttach(content::WebContents* embedder_web_contents, } void WebContents::Destroy() { - if (storage_) { + if (is_guest()) { // When force destroying the "destroyed" event is not emitted. WebContentsDestroyed(); @@ -458,7 +459,7 @@ void WebContents::Destroy() { guest_host_ = nullptr; Observe(nullptr); - storage_.reset(); + DestroyWebContents(); } } @@ -544,22 +545,22 @@ void WebContents::ExecuteJavaScript(const base::string16& code) { } void WebContents::OpenDevTools() { - storage_->SetCanDock(false); - storage_->ShowDevTools(); + inspectable_web_contents()->SetCanDock(false); + inspectable_web_contents()->ShowDevTools(); } void WebContents::CloseDevTools() { - storage_->CloseDevTools(); + inspectable_web_contents()->CloseDevTools(); } bool WebContents::IsDevToolsOpened() { - return storage_->IsDevToolsViewShowing(); + return inspectable_web_contents()->IsDevToolsViewShowing(); } void WebContents::InspectElement(int x, int y) { OpenDevTools(); scoped_refptr agent( - content::DevToolsAgentHost::GetOrCreateFor(storage_->GetWebContents())); + content::DevToolsAgentHost::GetOrCreateFor(web_contents())); agent->InspectElement(x, y); } @@ -710,7 +711,7 @@ void WebContents::InspectServiceWorker() { if (agent_host->GetType() == content::DevToolsAgentHost::TYPE_SERVICE_WORKER) { OpenDevTools(); - storage_->AttachTo(agent_host); + inspectable_web_contents()->AttachTo(agent_host); break; } } diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index e70b25d72353..056e7f3f699c 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -239,9 +239,6 @@ class WebContents : public mate::EventEmitter, // Stores whether the contents of the guest can be transparent. bool guest_opaque_; - // Stores the WebContents that managed by this class. - scoped_ptr storage_; - // The WebContents that attaches this guest view. content::WebContents* embedder_web_contents_; From d9efc3b4bfdb8000ee917b6eaed261d929c0ad48 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 5 Jun 2015 15:12:38 +0800 Subject: [PATCH 0164/1293] Move more methods to CommonWebContentsDelegate --- atom/browser/api/atom_api_web_contents.cc | 16 -------- atom/browser/api/atom_api_web_contents.h | 9 ----- atom/browser/common_web_contents_delegate.cc | 41 ++++++++++++++++++++ atom/browser/common_web_contents_delegate.h | 16 ++++++++ atom/browser/native_window.cc | 39 ------------------- atom/browser/native_window.h | 18 --------- 6 files changed, 57 insertions(+), 82 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 01d96921e063..bc5aba2f36b6 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -9,7 +9,6 @@ #include "atom/browser/atom_browser_client.h" #include "atom/browser/atom_browser_context.h" #include "atom/browser/native_window.h" -#include "atom/browser/web_dialog_helper.h" #include "atom/browser/web_view_manager.h" #include "atom/common/api/api_messages.h" #include "atom/common/native_mate_converters/gfx_converter.h" @@ -201,21 +200,6 @@ content::WebContents* WebContents::OpenURLFromTab( return web_contents(); } -void WebContents::RunFileChooser(content::WebContents* guest, - const content::FileChooserParams& params) { - if (!web_dialog_helper_) - web_dialog_helper_.reset(new WebDialogHelper(GetWindowFromGuest(guest))); - web_dialog_helper_->RunFileChooser(guest, params); -} - -void WebContents::EnumerateDirectory(content::WebContents* guest, - int request_id, - const base::FilePath& path) { - if (!web_dialog_helper_) - web_dialog_helper_.reset(new WebDialogHelper(GetWindowFromGuest(guest))); - web_dialog_helper_->EnumerateDirectory(guest, request_id, path); -} - void WebContents::HandleKeyboardEvent( content::WebContents* source, const content::NativeWebKeyboardEvent& event) { diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index 056e7f3f699c..42ce299a4621 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -27,8 +27,6 @@ class Dictionary; namespace atom { -class WebDialogHelper; - namespace api { // A struct of parameters for SetSize(). The parameters are all declared as @@ -148,11 +146,6 @@ class WebContents : public mate::EventEmitter, content::WebContents* OpenURLFromTab( content::WebContents* source, const content::OpenURLParams& params) override; - void RunFileChooser(content::WebContents* web_contents, - const content::FileChooserParams& params) override; - void EnumerateDirectory(content::WebContents* web_contents, - int request_id, - const base::FilePath& path) override; void HandleKeyboardEvent( content::WebContents* source, const content::NativeWebKeyboardEvent& event) override; @@ -231,8 +224,6 @@ class WebContents : public mate::EventEmitter, // Returns the default size of the guestview. gfx::Size GetDefaultSize() const; - scoped_ptr web_dialog_helper_; - // Unique ID for a guest WebContents. int guest_instance_id_; diff --git a/atom/browser/common_web_contents_delegate.cc b/atom/browser/common_web_contents_delegate.cc index 2360a9748c64..b1a660444e02 100644 --- a/atom/browser/common_web_contents_delegate.cc +++ b/atom/browser/common_web_contents_delegate.cc @@ -7,6 +7,8 @@ #include "atom/browser/atom_javascript_dialog_manager.h" #include "atom/browser/native_window.h" #include "atom/browser/ui/file_dialog.h" +#include "atom/browser/web_dialog_helper.h" +#include "chrome/browser/ui/browser_dialogs.h" #include "content/public/browser/child_process_security_policy.h" #include "content/public/browser/render_process_host.h" #include "content/public/browser/render_view_host.h" @@ -103,6 +105,22 @@ void CommonWebContentsDelegate::DestroyWebContents() { web_contents_.reset(); } +void CommonWebContentsDelegate::RequestToLockMouse( + content::WebContents* web_contents, + bool user_gesture, + bool last_unlocked_by_target) { + GetWebContents()->GotResponseToLockMouseRequest(true); +} + +bool CommonWebContentsDelegate::CanOverscrollContent() const { + return false; +} + +bool CommonWebContentsDelegate::IsPopupOrPanel( + const content::WebContents* source) const { + return !is_guest_; +} + content::JavaScriptDialogManager* CommonWebContentsDelegate::GetJavaScriptDialogManager( content::WebContents* source) { @@ -112,6 +130,29 @@ CommonWebContentsDelegate::GetJavaScriptDialogManager( return dialog_manager_.get(); } +content::ColorChooser* CommonWebContentsDelegate::OpenColorChooser( + content::WebContents* web_contents, + SkColor color, + const std::vector& suggestions) { + return chrome::ShowColorChooser(web_contents, color); +} + +void CommonWebContentsDelegate::RunFileChooser( + content::WebContents* guest, + const content::FileChooserParams& params) { + if (!web_dialog_helper_) + web_dialog_helper_.reset(new WebDialogHelper(owner_window_)); + web_dialog_helper_->RunFileChooser(guest, params); +} + +void CommonWebContentsDelegate::EnumerateDirectory(content::WebContents* guest, + int request_id, + const base::FilePath& path) { + if (!web_dialog_helper_) + web_dialog_helper_.reset(new WebDialogHelper(owner_window_)); + web_dialog_helper_->EnumerateDirectory(guest, request_id, path); +} + content::WebContents* CommonWebContentsDelegate::GetWebContents() const { if (!web_contents_) return nullptr; diff --git a/atom/browser/common_web_contents_delegate.h b/atom/browser/common_web_contents_delegate.h index d383aac1ad00..6366e7410ccd 100644 --- a/atom/browser/common_web_contents_delegate.h +++ b/atom/browser/common_web_contents_delegate.h @@ -15,6 +15,7 @@ namespace atom { class AtomJavaScriptDialogManager; class NativeWindow; +class WebDialogHelper; class CommonWebContentsDelegate : public brightray::DefaultWebContentsDelegate, @@ -45,8 +46,22 @@ class CommonWebContentsDelegate protected: // content::WebContentsDelegate: + void RequestToLockMouse(content::WebContents* web_contents, + bool user_gesture, + bool last_unlocked_by_target) override; + bool CanOverscrollContent() const override; + bool IsPopupOrPanel(const content::WebContents* source) const override; content::JavaScriptDialogManager* GetJavaScriptDialogManager( content::WebContents* source) override; + content::ColorChooser* OpenColorChooser( + content::WebContents* web_contents, + SkColor color, + const std::vector& suggestions) override; + void RunFileChooser(content::WebContents* web_contents, + const content::FileChooserParams& params) override; + void EnumerateDirectory(content::WebContents* web_contents, + int request_id, + const base::FilePath& path) override; // brightray::InspectableWebContentsDelegate: void DevToolsSaveToFile(const std::string& url, @@ -64,6 +79,7 @@ class CommonWebContentsDelegate // The window that this WebContents belongs to. NativeWindow* owner_window_; + scoped_ptr web_dialog_helper_; scoped_ptr dialog_manager_; // The stored InspectableWebContents object. diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index b286caf6c480..4f3fab7fcf10 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -10,7 +10,6 @@ #include "atom/browser/atom_browser_context.h" #include "atom/browser/browser.h" -#include "atom/browser/web_dialog_helper.h" #include "atom/browser/window_list.h" #include "atom/common/api/api_messages.h" #include "atom/common/atom_version.h" @@ -29,7 +28,6 @@ #include "brightray/browser/inspectable_web_contents.h" #include "brightray/browser/inspectable_web_contents_view.h" #include "chrome/browser/printing/print_view_manager_basic.h" -#include "chrome/browser/ui/browser_dialogs.h" #include "content/browser/renderer_host/render_widget_host_impl.h" #include "content/public/browser/devtools_agent_host.h" #include "content/public/browser/invalidate_type.h" @@ -637,38 +635,6 @@ void NativeWindow::BeforeUnloadFired(content::WebContents* tab, } } -content::ColorChooser* NativeWindow::OpenColorChooser( - content::WebContents* web_contents, - SkColor color, - const std::vector& suggestions) { - return chrome::ShowColorChooser(web_contents, color); -} - -void NativeWindow::RunFileChooser(content::WebContents* web_contents, - const content::FileChooserParams& params) { - if (!web_dialog_helper_) - web_dialog_helper_.reset(new WebDialogHelper(this)); - web_dialog_helper_->RunFileChooser(web_contents, params); -} - -void NativeWindow::EnumerateDirectory(content::WebContents* web_contents, - int request_id, - const base::FilePath& path) { - if (!web_dialog_helper_) - web_dialog_helper_.reset(new WebDialogHelper(this)); - web_dialog_helper_->EnumerateDirectory(web_contents, request_id, path); -} - -void NativeWindow::RequestToLockMouse(content::WebContents* web_contents, - bool user_gesture, - bool last_unlocked_by_target) { - GetWebContents()->GotResponseToLockMouseRequest(true); -} - -bool NativeWindow::CanOverscrollContent() const { - return false; -} - void NativeWindow::ActivateContents(content::WebContents* contents) { FocusOnWebView(); } @@ -697,11 +663,6 @@ void NativeWindow::CloseContents(content::WebContents* source) { window_unresposive_closure_.Cancel(); } -bool NativeWindow::IsPopupOrPanel(const content::WebContents* source) const { - // Only popup window can use things like window.moveTo. - return true; -} - void NativeWindow::RendererUnresponsive(content::WebContents* source) { // Schedule the unresponsive shortly later, since we may receive the // responsive event soon. This could happen after the whole application had diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index 841bfe56b52b..1726d9d372d9 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -49,7 +49,6 @@ class MenuModel; namespace atom { struct DraggableRegion; -class WebDialogHelper; class NativeWindow : public CommonWebContentsDelegate, public content::WebContentsObserver, @@ -245,26 +244,11 @@ class NativeWindow : public CommonWebContentsDelegate, void BeforeUnloadFired(content::WebContents* tab, bool proceed, bool* proceed_to_fire_unload) override; - content::ColorChooser* OpenColorChooser( - content::WebContents* web_contents, - SkColor color, - const std::vector& suggestions) override; - void RunFileChooser(content::WebContents* web_contents, - const content::FileChooserParams& params) override; - void EnumerateDirectory(content::WebContents* web_contents, - int request_id, - const base::FilePath& path) override; - void RequestToLockMouse(content::WebContents* web_contents, - bool user_gesture, - bool last_unlocked_by_target) override; - bool CanOverscrollContent() const override; void ActivateContents(content::WebContents* contents) override; void DeactivateContents(content::WebContents* contents) override; void MoveContents(content::WebContents* source, const gfx::Rect& pos) override; void CloseContents(content::WebContents* source) override; - bool IsPopupOrPanel( - const content::WebContents* source) const override; void RendererUnresponsive(content::WebContents* source) override; void RendererResponsive(content::WebContents* source) override; void EnterFullscreenModeForTab(content::WebContents* source, @@ -346,8 +330,6 @@ class NativeWindow : public CommonWebContentsDelegate, base::WeakPtrFactory weak_factory_; - scoped_ptr web_dialog_helper_; - DISALLOW_COPY_AND_ASSIGN(NativeWindow); }; From 67144aaf2add05fc1947fee355867c99dd60c8ad Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 5 Jun 2015 15:18:15 +0800 Subject: [PATCH 0165/1293] Remove duplicate def of is_guest --- atom/browser/api/atom_api_web_contents.cc | 20 ++++++++++---------- atom/browser/api/atom_api_web_contents.h | 3 +-- 2 files changed, 11 insertions(+), 12 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index bc5aba2f36b6..e3b86572d9f4 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -384,15 +384,11 @@ void WebContents::RenderViewReady() { // WebContents::GetRenderWidgetHostView will return the RWHV of an // interstitial page if one is showing at this time. We only want opacity // to apply to web pages. - if (guest_opaque_) { - web_contents() - ->GetRenderViewHost() - ->GetView() - ->SetBackgroundColorToDefault(); - } else { - web_contents()->GetRenderViewHost()->GetView()->SetBackgroundColor( - SK_ColorTRANSPARENT); - } + auto render_view_host_view = web_contents()->GetRenderViewHost()->GetView(); + if (guest_opaque_) + render_view_host_view->SetBackgroundColorToDefault(); + else + render_view_host_view->SetBackgroundColor(SK_ColorTRANSPARENT); } void WebContents::WebContentsDestroyed() { @@ -669,6 +665,10 @@ void WebContents::SetAllowTransparency(bool allow) { } } +bool WebContents::IsGuest() const { + return is_guest(); +} + void WebContents::HasServiceWorker( const base::Callback& callback) { auto context = GetServiceWorkerContext(web_contents()); @@ -740,7 +740,7 @@ mate::ObjectTemplateBuilder WebContents::GetObjectTemplateBuilder( .SetMethod("_send", &WebContents::SendIPCMessage) .SetMethod("setSize", &WebContents::SetSize) .SetMethod("setAllowTransparency", &WebContents::SetAllowTransparency) - .SetMethod("isGuest", &WebContents::is_guest) + .SetMethod("isGuest", &WebContents::IsGuest) .SetMethod("hasServiceWorker", &WebContents::HasServiceWorker) .SetMethod("unregisterServiceWorker", &WebContents::UnregisterServiceWorker) diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index 42ce299a4621..278426e73599 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -108,8 +108,7 @@ class WebContents : public mate::EventEmitter, // Sets the transparency of the guest. void SetAllowTransparency(bool allow); - // Returns whether this is a guest view. - bool is_guest() const { return guest_instance_id_ != -1; } + bool IsGuest() const; // Returns whether this guest has an associated embedder. bool attached() const { return !!embedder_web_contents_; } From 94d69777fa3678c4ac9c35fea5f56d9028636628 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 5 Jun 2015 15:41:03 +0800 Subject: [PATCH 0166/1293] Enable calling WebContents::openDevTools for BrowserWindow's WebContents --- atom/browser/api/atom_api_web_contents.cc | 98 +++++++++++++-------- atom/browser/api/atom_api_web_contents.h | 15 +++- atom/browser/api/atom_api_window.cc | 2 +- atom/browser/common_web_contents_delegate.h | 2 +- atom/browser/native_window.h | 4 + 5 files changed, 78 insertions(+), 43 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index e3b86572d9f4..e9dfd9f47f4b 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -95,17 +95,21 @@ content::ServiceWorkerContext* GetServiceWorkerContext( if (!context || !site_instance) return nullptr; - content::StoragePartition* storage_partition = - content::BrowserContext::GetStoragePartition( - context, site_instance); - - DCHECK(storage_partition); + auto storage_partition = + content::BrowserContext::GetStoragePartition(context, site_instance); + if (!storage_partition) + return nullptr; return storage_partition->GetServiceWorkerContext(); } } // namespace +WebContents::WebContents(brightray::InspectableWebContents* web_contents) + : WebContents(web_contents->GetWebContents()) { + inspectable_web_contents_ = web_contents; +} + WebContents::WebContents(content::WebContents* web_contents) : CommonWebContentsDelegate(false), content::WebContentsObserver(web_contents), @@ -113,7 +117,8 @@ WebContents::WebContents(content::WebContents* web_contents) guest_opaque_(true), guest_host_(nullptr), auto_size_enabled_(false), - is_full_page_plugin_(false) { + is_full_page_plugin_(false), + inspectable_web_contents_(nullptr) { } WebContents::WebContents(const mate::Dictionary& options) @@ -136,6 +141,7 @@ WebContents::WebContents(const mate::Dictionary& options) auto web_contents = content::WebContents::Create(params); InitWithWebContents(web_contents, GetWindowFromGuest(web_contents)); + inspectable_web_contents_ = managed_web_contents(); Observe(GetWebContents()); } @@ -525,25 +531,67 @@ void WebContents::ExecuteJavaScript(const base::string16& code) { } void WebContents::OpenDevTools() { + if (!inspectable_web_contents()) + return; inspectable_web_contents()->SetCanDock(false); inspectable_web_contents()->ShowDevTools(); } void WebContents::CloseDevTools() { + if (!inspectable_web_contents()) + return; inspectable_web_contents()->CloseDevTools(); } bool WebContents::IsDevToolsOpened() { + if (!inspectable_web_contents()) + return false; return inspectable_web_contents()->IsDevToolsViewShowing(); } void WebContents::InspectElement(int x, int y) { + if (!inspectable_web_contents()) + return; OpenDevTools(); scoped_refptr agent( content::DevToolsAgentHost::GetOrCreateFor(web_contents())); agent->InspectElement(x, y); } +void WebContents::InspectServiceWorker() { + if (!inspectable_web_contents()) + return; + for (const auto& agent_host : content::DevToolsAgentHost::GetOrCreateAll()) { + if (agent_host->GetType() == + content::DevToolsAgentHost::TYPE_SERVICE_WORKER) { + OpenDevTools(); + inspectable_web_contents()->AttachTo(agent_host); + break; + } + } +} + +void WebContents::HasServiceWorker( + const base::Callback& callback) { + auto context = GetServiceWorkerContext(web_contents()); + if (!context) + return; + + context->CheckHasServiceWorker(web_contents()->GetLastCommittedURL(), + GURL::EmptyGURL(), + callback); +} + +void WebContents::UnregisterServiceWorker( + const base::Callback& callback) { + auto context = GetServiceWorkerContext(web_contents()); + if (!context) + return; + + context->UnregisterServiceWorker(web_contents()->GetLastCommittedURL(), + callback); +} + void WebContents::Undo() { web_contents()->Undo(); } @@ -669,38 +717,6 @@ bool WebContents::IsGuest() const { return is_guest(); } -void WebContents::HasServiceWorker( - const base::Callback& callback) { - auto context = GetServiceWorkerContext(web_contents()); - if (!context) - return; - - context->CheckHasServiceWorker(web_contents()->GetLastCommittedURL(), - GURL::EmptyGURL(), - callback); -} - -void WebContents::UnregisterServiceWorker( - const base::Callback& callback) { - auto context = GetServiceWorkerContext(web_contents()); - if (!context) - return; - - context->UnregisterServiceWorker(web_contents()->GetLastCommittedURL(), - callback); -} - -void WebContents::InspectServiceWorker() { - for (const auto& agent_host : content::DevToolsAgentHost::GetOrCreateAll()) { - if (agent_host->GetType() == - content::DevToolsAgentHost::TYPE_SERVICE_WORKER) { - OpenDevTools(); - inspectable_web_contents()->AttachTo(agent_host); - break; - } - } -} - mate::ObjectTemplateBuilder WebContents::GetObjectTemplateBuilder( v8::Isolate* isolate) { if (template_.IsEmpty()) @@ -781,6 +797,12 @@ gfx::Size WebContents::GetDefaultSize() const { } } +// static +mate::Handle WebContents::CreateFrom( + v8::Isolate* isolate, brightray::InspectableWebContents* web_contents) { + return mate::CreateHandle(isolate, new WebContents(web_contents)); +} + // static mate::Handle WebContents::CreateFrom( v8::Isolate* isolate, content::WebContents* web_contents) { diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index 278426e73599..486c61c5dda8 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -52,6 +52,8 @@ class WebContents : public mate::EventEmitter, public content::GpuDataManagerObserver { public: // Create from an existing WebContents. + static mate::Handle CreateFrom( + v8::Isolate* isolate, brightray::InspectableWebContents* web_contents); static mate::Handle CreateFrom( v8::Isolate* isolate, content::WebContents* web_contents); @@ -80,9 +82,9 @@ class WebContents : public mate::EventEmitter, void CloseDevTools(); bool IsDevToolsOpened(); void InspectElement(int x, int y); + void InspectServiceWorker(); void HasServiceWorker(const base::Callback&); void UnregisterServiceWorker(const base::Callback&); - void InspectServiceWorker(); // Editing commands. void Undo(); @@ -113,11 +115,14 @@ class WebContents : public mate::EventEmitter, // Returns whether this guest has an associated embedder. bool attached() const { return !!embedder_web_contents_; } - content::WebContents* web_contents() const { - return content::WebContentsObserver::web_contents(); + // Returns the current InspectableWebContents object, nullptr will be returned + // if current WebContents can not beinspected, e.g. it is the devtools. + brightray::InspectableWebContents* inspectable_web_contents() const { + return inspectable_web_contents_; } protected: + explicit WebContents(brightray::InspectableWebContents* web_contents); explicit WebContents(content::WebContents* web_contents); explicit WebContents(const mate::Dictionary& options); ~WebContents(); @@ -257,6 +262,10 @@ class WebContents : public mate::EventEmitter, // Whether the guest view is inside a plugin document. bool is_full_page_plugin_; + // Current InspectableWebContents object, can be nullptr for WebContents of + // devtools. It is a weak reference. + brightray::InspectableWebContents* inspectable_web_contents_; + DISALLOW_COPY_AND_ASSIGN(WebContents); }; diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index f689af1288b7..fec072e27f9e 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -473,7 +473,7 @@ bool Window::IsVisibleOnAllWorkspaces() { } mate::Handle Window::GetWebContents(v8::Isolate* isolate) const { - return WebContents::CreateFrom(isolate, window_->GetWebContents()); + return WebContents::CreateFrom(isolate, window_->managed_web_contents()); } mate::Handle Window::GetDevToolsWebContents( diff --git a/atom/browser/common_web_contents_delegate.h b/atom/browser/common_web_contents_delegate.h index 6366e7410ccd..5d80ac42c36f 100644 --- a/atom/browser/common_web_contents_delegate.h +++ b/atom/browser/common_web_contents_delegate.h @@ -38,7 +38,7 @@ class CommonWebContentsDelegate // Returns the WebContents of devtools. content::WebContents* GetDevToolsWebContents() const; - brightray::InspectableWebContents* inspectable_web_contents() const { + brightray::InspectableWebContents* managed_web_contents() const { return web_contents_.get(); } diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index 1726d9d372d9..f6b88e4e401a 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -212,6 +212,10 @@ class NativeWindow : public CommonWebContentsDelegate, observers_.RemoveObserver(obs); } + brightray::InspectableWebContents* inspectable_web_contents() const { + return managed_web_contents(); + } + bool has_frame() const { return has_frame_; } bool is_html_api_fullscreen() const { return html_fullscreen_; } From 05468cc3fa31a13a27d0302f8bb34395e1f17ec6 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 5 Jun 2015 17:01:17 +0800 Subject: [PATCH 0167/1293] Remove devtools APIs from NativeWindow --- atom/browser/api/atom_api_web_contents.cc | 49 ++++++++++++--- atom/browser/api/atom_api_web_contents.h | 4 +- atom/browser/api/atom_api_window.cc | 66 ++++++++++---------- atom/browser/api/atom_api_window.h | 15 +++-- atom/browser/api/lib/browser-window.coffee | 43 +++---------- atom/browser/api/lib/web-contents.coffee | 9 +-- atom/browser/common_web_contents_delegate.cc | 3 + atom/browser/common_web_contents_delegate.h | 4 +- atom/browser/native_window.cc | 40 +++--------- atom/browser/native_window.h | 7 +-- atom/browser/native_window_observer.h | 4 +- vendor/brightray | 2 +- 12 files changed, 118 insertions(+), 128 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index e9dfd9f47f4b..49b0a89d8362 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -79,6 +79,10 @@ const int kDefaultHeight = 300; v8::Persistent template_; +// The wrapWebContents funtion which is implemented in JavaScript +using WrapWebContentsCallback = base::Callback)>; +WrapWebContentsCallback g_wrap_web_contents; + // Get the window that has the |guest| embedded. NativeWindow* GetWindowFromGuest(const content::WebContents* guest) { WebViewManager::WebViewInfo info; @@ -530,10 +534,17 @@ void WebContents::ExecuteJavaScript(const base::string16& code) { web_contents()->GetMainFrame()->ExecuteJavaScript(code); } -void WebContents::OpenDevTools() { +void WebContents::OpenDevTools(mate::Arguments* args) { if (!inspectable_web_contents()) return; - inspectable_web_contents()->SetCanDock(false); + bool detach = false; + if (is_guest()) { + detach = true; + } else if (args && args->Length() == 1) { + mate::Dictionary options; + args->GetNext(&options) && options.Get("detach", &detach); + } + inspectable_web_contents()->SetCanDock(!detach); inspectable_web_contents()->ShowDevTools(); } @@ -549,10 +560,17 @@ bool WebContents::IsDevToolsOpened() { return inspectable_web_contents()->IsDevToolsViewShowing(); } +void WebContents::ToggleDevTools() { + if (IsDevToolsOpened()) + CloseDevTools(); + else + OpenDevTools(nullptr); +} + void WebContents::InspectElement(int x, int y) { if (!inspectable_web_contents()) return; - OpenDevTools(); + OpenDevTools(nullptr); scoped_refptr agent( content::DevToolsAgentHost::GetOrCreateFor(web_contents())); agent->InspectElement(x, y); @@ -564,7 +582,7 @@ void WebContents::InspectServiceWorker() { for (const auto& agent_host : content::DevToolsAgentHost::GetOrCreateAll()) { if (agent_host->GetType() == content::DevToolsAgentHost::TYPE_SERVICE_WORKER) { - OpenDevTools(); + OpenDevTools(nullptr); inspectable_web_contents()->AttachTo(agent_host); break; } @@ -741,6 +759,7 @@ mate::ObjectTemplateBuilder WebContents::GetObjectTemplateBuilder( .SetMethod("openDevTools", &WebContents::OpenDevTools) .SetMethod("closeDevTools", &WebContents::CloseDevTools) .SetMethod("isDevToolsOpened", &WebContents::IsDevToolsOpened) + .SetMethod("toggleDevTools", &WebContents::ToggleDevTools) .SetMethod("inspectElement", &WebContents::InspectElement) .SetMethod("undo", &WebContents::Undo) .SetMethod("redo", &WebContents::Redo) @@ -800,19 +819,33 @@ gfx::Size WebContents::GetDefaultSize() const { // static mate::Handle WebContents::CreateFrom( v8::Isolate* isolate, brightray::InspectableWebContents* web_contents) { - return mate::CreateHandle(isolate, new WebContents(web_contents)); + auto handle = mate::CreateHandle(isolate, new WebContents(web_contents)); + g_wrap_web_contents.Run(handle.ToV8()); + return handle; } // static mate::Handle WebContents::CreateFrom( v8::Isolate* isolate, content::WebContents* web_contents) { - return mate::CreateHandle(isolate, new WebContents(web_contents)); + auto handle = mate::CreateHandle(isolate, new WebContents(web_contents)); + g_wrap_web_contents.Run(handle.ToV8()); + return handle; } // static mate::Handle WebContents::Create( v8::Isolate* isolate, const mate::Dictionary& options) { - return mate::CreateHandle(isolate, new WebContents(options)); + auto handle = mate::CreateHandle(isolate, new WebContents(options)); + g_wrap_web_contents.Run(handle.ToV8()); + return handle; +} + +void SetWrapWebContents(const WrapWebContentsCallback& callback) { + g_wrap_web_contents = callback; +} + +void ClearWrapWebContents() { + g_wrap_web_contents.Reset(); } } // namespace api @@ -827,6 +860,8 @@ void Initialize(v8::Local exports, v8::Local unused, v8::Isolate* isolate = context->GetIsolate(); mate::Dictionary dict(isolate, exports); dict.SetMethod("create", &atom::api::WebContents::Create); + dict.SetMethod("_setWrapWebContents", &atom::api::SetWrapWebContents); + dict.SetMethod("_clearWrapWebContents", &atom::api::ClearWrapWebContents); } } // namespace diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index 486c61c5dda8..f16680b53d00 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -22,6 +22,7 @@ class InspectableWebContents; } namespace mate { +class Arguments; class Dictionary; } @@ -78,9 +79,10 @@ class WebContents : public mate::EventEmitter, void SetUserAgent(const std::string& user_agent); void InsertCSS(const std::string& css); void ExecuteJavaScript(const base::string16& code); - void OpenDevTools(); + void OpenDevTools(mate::Arguments* args); void CloseDevTools(); bool IsDevToolsOpened(); + void ToggleDevTools(); void InspectElement(int x, int y); void InspectServiceWorker(); void HasServiceWorker(const base::Callback&); diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index fec072e27f9e..76aaa3baaff5 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -165,6 +165,26 @@ void Window::OnDevToolsFocus() { Emit("devtools-focused"); } +void Window::OnDevToolsOpened() { + Emit("devtools-opened"); + + v8::Isolate* isolate = v8::Isolate::GetCurrent(); + v8::Locker locker(isolate); + v8::HandleScope handle_scope(isolate); + auto handle = + WebContents::CreateFrom(isolate, window_->GetDevToolsWebContents()); + devtools_web_contents_.Reset(isolate, handle.ToV8()); +} + +void Window::OnDevToolsClosed() { + Emit("devtools-closed"); + + v8::Isolate* isolate = v8::Isolate::GetCurrent(); + v8::Locker locker(isolate); + v8::HandleScope handle_scope(isolate); + devtools_web_contents_.Reset(); +} + // static mate::Wrappable* Window::New(v8::Isolate* isolate, const mate::Dictionary& options) { @@ -356,26 +376,6 @@ bool Window::IsKiosk() { return window_->IsKiosk(); } -void Window::OpenDevTools(bool can_dock) { - window_->OpenDevTools(can_dock); -} - -void Window::CloseDevTools() { - window_->CloseDevTools(); -} - -bool Window::IsDevToolsOpened() { - return window_->IsDevToolsOpened(); -} - -void Window::InspectElement(int x, int y) { - window_->InspectElement(x, y); -} - -void Window::InspectServiceWorker() { - window_->InspectServiceWorker(); -} - void Window::FocusOnWebView() { window_->FocusOnWebView(); } @@ -472,13 +472,20 @@ bool Window::IsVisibleOnAllWorkspaces() { return window_->IsVisibleOnAllWorkspaces(); } -mate::Handle Window::GetWebContents(v8::Isolate* isolate) const { - return WebContents::CreateFrom(isolate, window_->managed_web_contents()); +v8::Local Window::WebContents(v8::Isolate* isolate) { + if (web_contents_.IsEmpty()) { + auto handle = + WebContents::CreateFrom(isolate, window_->managed_web_contents()); + web_contents_.Reset(isolate, handle.ToV8()); + } + return v8::Local::New(isolate, web_contents_); } -mate::Handle Window::GetDevToolsWebContents( - v8::Isolate* isolate) const { - return WebContents::CreateFrom(isolate, window_->GetDevToolsWebContents()); +v8::Local Window::DevToolsWebContents(v8::Isolate* isolate) { + if (devtools_web_contents_.IsEmpty()) + return v8::Null(isolate); + else + return v8::Local::New(isolate, devtools_web_contents_); } // static @@ -529,10 +536,6 @@ void Window::BuildPrototype(v8::Isolate* isolate, .SetMethod("getRepresentedFilename", &Window::GetRepresentedFilename) .SetMethod("setDocumentEdited", &Window::SetDocumentEdited) .SetMethod("isDocumentEdited", &Window::IsDocumentEdited) - .SetMethod("_openDevTools", &Window::OpenDevTools) - .SetMethod("closeDevTools", &Window::CloseDevTools) - .SetMethod("isDevToolsOpened", &Window::IsDevToolsOpened) - .SetMethod("_inspectElement", &Window::InspectElement) .SetMethod("focusOnWebView", &Window::FocusOnWebView) .SetMethod("blurWebView", &Window::BlurWebView) .SetMethod("isWebViewFocused", &Window::IsWebViewFocused) @@ -553,9 +556,8 @@ void Window::BuildPrototype(v8::Isolate* isolate, .SetMethod("showDefinitionForSelection", &Window::ShowDefinitionForSelection) #endif - .SetMethod("_getWebContents", &Window::GetWebContents) - .SetMethod("_getDevToolsWebContents", &Window::GetDevToolsWebContents) - .SetMethod("_inspectServiceWorker", &Window::InspectServiceWorker); + .SetProperty("webContents", &Window::WebContents) + .SetProperty("devToolsWebContents", &Window::DevToolsWebContents); } } // namespace api diff --git a/atom/browser/api/atom_api_window.h b/atom/browser/api/atom_api_window.h index 72d2c842d8e8..43a32e86f45a 100644 --- a/atom/browser/api/atom_api_window.h +++ b/atom/browser/api/atom_api_window.h @@ -78,6 +78,8 @@ class Window : public mate::EventEmitter, void OnRendererUnresponsive() override; void OnRendererResponsive() override; void OnDevToolsFocus() override; + void OnDevToolsOpened() override; + void OnDevToolsClosed() override; private: // APIs for NativeWindow. @@ -121,11 +123,6 @@ class Window : public mate::EventEmitter, void SetSkipTaskbar(bool skip); void SetKiosk(bool kiosk); bool IsKiosk(); - void OpenDevTools(bool can_dock); - void CloseDevTools(); - bool IsDevToolsOpened(); - void InspectElement(int x, int y); - void InspectServiceWorker(); void FocusOnWebView(); void BlurWebView(); bool IsWebViewFocused(); @@ -151,9 +148,11 @@ class Window : public mate::EventEmitter, void SetVisibleOnAllWorkspaces(bool visible); bool IsVisibleOnAllWorkspaces(); - // APIs for WebContents. - mate::Handle GetWebContents(v8::Isolate* isolate) const; - mate::Handle GetDevToolsWebContents(v8::Isolate* isolate) const; + v8::Local WebContents(v8::Isolate* isolate); + v8::Local DevToolsWebContents(v8::Isolate* isolate); + + v8::Global web_contents_; + v8::Global devtools_web_contents_; scoped_ptr window_; diff --git a/atom/browser/api/lib/browser-window.coffee b/atom/browser/api/lib/browser-window.coffee index 7e4711e817c4..f0691b19b8fa 100644 --- a/atom/browser/api/lib/browser-window.coffee +++ b/atom/browser/api/lib/browser-window.coffee @@ -2,7 +2,6 @@ EventEmitter = require('events').EventEmitter IDWeakMap = require 'id-weak-map' app = require 'app' ipc = require 'ipc' -wrapWebContents = require('web-contents').wrap BrowserWindow = process.atomBinding('window').BrowserWindow BrowserWindow::__proto__ = EventEmitter.prototype @@ -16,10 +15,6 @@ BrowserWindow::_init = -> menu = app.getApplicationMenu() @setMenu menu if menu? - @webContents = @getWebContents() - @devToolsWebContents = null - @webContents.once 'destroyed', => @webContents = null - # Remember the window ID. Object.defineProperty this, 'id', value: BrowserWindow.windows.add(this) @@ -40,35 +35,6 @@ BrowserWindow::_init = -> @once 'closed', => BrowserWindow.windows.remove @id if BrowserWindow.windows.has @id -BrowserWindow::openDevTools = (options={}) -> - options.detach ?= false - @_openDevTools !options.detach - - # Force devToolsWebContents to be created. - @devToolsWebContents = @getDevToolsWebContents() - @devToolsWebContents.once 'destroyed', => @devToolsWebContents = null - - # Emit devtools events. - @devToolsWebContents.once 'did-finish-load', => @emit 'devtools-opened' - @devToolsWebContents.once 'destroyed', => @emit 'devtools-closed' - -BrowserWindow::toggleDevTools = -> - if @isDevToolsOpened() then @closeDevTools() else @openDevTools() - -BrowserWindow::inspectElement = (x, y) -> - @openDevTools true - @_inspectElement x, y - -BrowserWindow::inspectServiceWorker = -> - @openDevTools true - @_inspectServiceWorker() - -BrowserWindow::getWebContents = -> - wrapWebContents @_getWebContents() - -BrowserWindow::getDevToolsWebContents = -> - wrapWebContents @_getDevToolsWebContents() - BrowserWindow::setMenu = (menu) -> throw new TypeError('Invalid menu') unless menu is null or menu?.constructor?.name is 'Menu' @@ -110,7 +76,12 @@ BrowserWindow::stop = -> @webContents.stop() BrowserWindow::getRoutingId = -> @webContents.getRoutingId() BrowserWindow::getProcessId = -> @webContents.getProcessId() BrowserWindow::isCrashed = -> @webContents.isCrashed() -BrowserWindow::executeJavaScriptInDevTools = (code) -> - @devToolsWebContents.executeJavaScript code +BrowserWindow::executeJavaScriptInDevTools = (code) -> @devToolsWebContents?.executeJavaScript code +BrowserWindow::openDevTools = -> @webContents.openDevTools.apply @webContents, arguments +BrowserWindow::closeDevTools = -> @webContents.closeDevTools() +BrowserWindow::isDevToolsOpened = -> @webContents.isDevToolsOpened() +BrowserWindow::toggleDevTools = -> @webContents.toggleDevTools() +BrowserWindow::inspectElement = -> @webContents.inspectElement.apply @webContents, arguments +BrowserWindow::inspectServiceWorker = -> @webContents.inspectServiceWorker() module.exports = BrowserWindow diff --git a/atom/browser/api/lib/web-contents.coffee b/atom/browser/api/lib/web-contents.coffee index eb86c94500ce..b8c101423d04 100644 --- a/atom/browser/api/lib/web-contents.coffee +++ b/atom/browser/api/lib/web-contents.coffee @@ -3,9 +3,7 @@ NavigationController = require './navigation-controller' binding = process.atomBinding 'web_contents' ipc = require 'ipc' -module.exports.wrap = (webContents) -> - return null unless webContents.isAlive() - +wrapWebContents = (webContents) -> # webContents is an EventEmitter. webContents.__proto__ = EventEmitter.prototype @@ -62,5 +60,8 @@ module.exports.wrap = (webContents) -> webContents +binding._setWrapWebContents wrapWebContents +process.once 'exit', binding._clearWrapWebContents + module.exports.create = (options={}) -> - @wrap binding.create(options) + binding.create(options) diff --git a/atom/browser/common_web_contents_delegate.cc b/atom/browser/common_web_contents_delegate.cc index b1a660444e02..1a64f2498582 100644 --- a/atom/browser/common_web_contents_delegate.cc +++ b/atom/browser/common_web_contents_delegate.cc @@ -4,6 +4,9 @@ #include "atom/browser/common_web_contents_delegate.h" +#include +#include + #include "atom/browser/atom_javascript_dialog_manager.h" #include "atom/browser/native_window.h" #include "atom/browser/ui/file_dialog.h" diff --git a/atom/browser/common_web_contents_delegate.h b/atom/browser/common_web_contents_delegate.h index 5d80ac42c36f..8909d1931457 100644 --- a/atom/browser/common_web_contents_delegate.h +++ b/atom/browser/common_web_contents_delegate.h @@ -6,6 +6,8 @@ #define ATOM_BROWSER_COMMON_WEB_CONTENTS_DELEGATE_H_ #include +#include +#include #include "brightray/browser/default_web_contents_delegate.h" #include "brightray/browser/inspectable_web_contents_impl.h" @@ -42,7 +44,7 @@ class CommonWebContentsDelegate return web_contents_.get(); } - bool is_guest() const { return is_guest_; }; + bool is_guest() const { return is_guest_; } protected: // content::WebContentsDelegate: diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 4f3fab7fcf10..07ad83f1acee 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -29,14 +29,11 @@ #include "brightray/browser/inspectable_web_contents_view.h" #include "chrome/browser/printing/print_view_manager_basic.h" #include "content/browser/renderer_host/render_widget_host_impl.h" -#include "content/public/browser/devtools_agent_host.h" -#include "content/public/browser/invalidate_type.h" #include "content/public/browser/navigation_entry.h" #include "content/public/browser/notification_details.h" #include "content/public/browser/notification_source.h" #include "content/public/browser/notification_types.h" #include "content/public/browser/plugin_service.h" -#include "content/public/browser/render_frame_host.h" #include "content/public/browser/render_process_host.h" #include "content/public/browser/render_view_host.h" #include "content/public/browser/render_widget_host_view.h" @@ -289,35 +286,6 @@ bool NativeWindow::HasModalDialog() { return has_dialog_attached_; } -void NativeWindow::OpenDevTools(bool can_dock) { - inspectable_web_contents()->SetCanDock(can_dock); - inspectable_web_contents()->ShowDevTools(); -} - -void NativeWindow::CloseDevTools() { - inspectable_web_contents()->CloseDevTools(); -} - -bool NativeWindow::IsDevToolsOpened() { - return inspectable_web_contents()->IsDevToolsViewShowing(); -} - -void NativeWindow::InspectElement(int x, int y) { - scoped_refptr agent( - content::DevToolsAgentHost::GetOrCreateFor(GetWebContents())); - agent->InspectElement(x, y); -} - -void NativeWindow::InspectServiceWorker() { - for (const auto& agent_host : content::DevToolsAgentHost::GetOrCreateAll()) { - if (agent_host->GetType() == - content::DevToolsAgentHost::TYPE_SERVICE_WORKER) { - inspectable_web_contents()->AttachTo(agent_host); - break; - } - } -} - void NativeWindow::FocusOnWebView() { GetWebContents()->GetRenderViewHost()->Focus(); } @@ -733,6 +701,14 @@ void NativeWindow::DevToolsFocused() { FOR_EACH_OBSERVER(NativeWindowObserver, observers_, OnDevToolsFocus()); } +void NativeWindow::DevToolsOpened() { + FOR_EACH_OBSERVER(NativeWindowObserver, observers_, OnDevToolsOpened()); +} + +void NativeWindow::DevToolsClosed() { + FOR_EACH_OBSERVER(NativeWindowObserver, observers_, OnDevToolsClosed()); +} + void NativeWindow::ScheduleUnresponsiveEvent(int ms) { if (!window_unresposive_closure_.IsCancelled()) return; diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index f6b88e4e401a..191e326df06d 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -144,11 +144,6 @@ class NativeWindow : public CommonWebContentsDelegate, virtual bool IsVisibleOnAllWorkspaces() = 0; virtual bool IsClosed() const { return is_closed_; } - virtual void OpenDevTools(bool can_dock); - virtual void CloseDevTools(); - virtual bool IsDevToolsOpened(); - virtual void InspectElement(int x, int y); - virtual void InspectServiceWorker(); virtual void FocusOnWebView(); virtual void BlurWebView(); @@ -273,6 +268,8 @@ class NativeWindow : public CommonWebContentsDelegate, // Implementations of brightray::InspectableWebContentsDelegate. void DevToolsFocused() override; + void DevToolsOpened() override; + void DevToolsClosed() override; // Whether window has standard frame. bool has_frame_; diff --git a/atom/browser/native_window_observer.h b/atom/browser/native_window_observer.h index 417731fb3474..335a63149953 100644 --- a/atom/browser/native_window_observer.h +++ b/atom/browser/native_window_observer.h @@ -55,8 +55,10 @@ class NativeWindowObserver { virtual void OnWindowEnterHtmlFullScreen() {} virtual void OnWindowLeaveHtmlFullScreen() {} - // Called when devtools window gets focused. + // Redirect devtools events. virtual void OnDevToolsFocus() {} + virtual void OnDevToolsOpened() {} + virtual void OnDevToolsClosed() {} // Called when renderer is hung. virtual void OnRendererUnresponsive() {} diff --git a/vendor/brightray b/vendor/brightray index 190c3dd16291..20af087dd3ba 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit 190c3dd1629141027f0962d0fab82c58853e7c85 +Subproject commit 20af087dd3ba01b601f8ad176899610c9479b382 From 8f9a109fa67356e6d1e9329ab573b6c6d3a5b052 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 5 Jun 2015 17:27:24 +0800 Subject: [PATCH 0168/1293] Implement HTML5 fullscreen in CommonWebContentsDelegate --- atom/browser/api/atom_api_web_contents.cc | 27 ++------- atom/browser/api/atom_api_web_contents.h | 2 - atom/browser/common_web_contents_delegate.cc | 64 +++++++++++++++++--- atom/browser/common_web_contents_delegate.h | 14 +++++ atom/browser/native_window.cc | 35 ----------- atom/browser/native_window.h | 16 ----- 6 files changed, 72 insertions(+), 86 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 49b0a89d8362..18bfc7a53f5f 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -223,32 +223,13 @@ void WebContents::HandleKeyboardEvent( void WebContents::EnterFullscreenModeForTab(content::WebContents* source, const GURL& origin) { - auto window = GetWindowFromGuest(source); - if (window) { - window->SetHtmlApiFullscreen(true); - window->NotifyWindowEnterHtmlFullScreen(); - source->GetRenderViewHost()->WasResized(); - Emit("enter-html-full-screen"); - } + CommonWebContentsDelegate::EnterFullscreenModeForTab(source, origin); + Emit("enter-html-full-screen"); } void WebContents::ExitFullscreenModeForTab(content::WebContents* source) { - auto window = GetWindowFromGuest(source); - if (window) { - window->SetHtmlApiFullscreen(false); - window->NotifyWindowLeaveHtmlFullScreen(); - source->GetRenderViewHost()->WasResized(); - Emit("leave-html-full-screen"); - } -} - -bool WebContents::IsFullscreenForTabOrPending( - const content::WebContents* source) const { - auto window = GetWindowFromGuest(source); - if (window) - return window->is_html_api_fullscreen(); - else - return false; + CommonWebContentsDelegate::ExitFullscreenModeForTab(source); + Emit("leave-html-full-screen"); } void WebContents::RenderViewDeleted(content::RenderViewHost* render_view_host) { diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index f16680b53d00..58059d9e9262 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -158,8 +158,6 @@ class WebContents : public mate::EventEmitter, void EnterFullscreenModeForTab(content::WebContents* source, const GURL& origin) override; void ExitFullscreenModeForTab(content::WebContents* source) override; - bool IsFullscreenForTabOrPending( - const content::WebContents* source) const override; // content::WebContentsObserver: void RenderViewDeleted(content::RenderViewHost*) override; diff --git a/atom/browser/common_web_contents_delegate.cc b/atom/browser/common_web_contents_delegate.cc index 1a64f2498582..564efe7edd15 100644 --- a/atom/browser/common_web_contents_delegate.cc +++ b/atom/browser/common_web_contents_delegate.cc @@ -87,7 +87,9 @@ base::DictionaryValue* CreateFileSystemValue(const FileSystem& file_system) { CommonWebContentsDelegate::CommonWebContentsDelegate(bool is_guest) : is_guest_(is_guest), - owner_window_(nullptr) { + owner_window_(nullptr), + html_fullscreen_(false), + native_fullscreen_(false) { } CommonWebContentsDelegate::~CommonWebContentsDelegate() { @@ -108,6 +110,19 @@ void CommonWebContentsDelegate::DestroyWebContents() { web_contents_.reset(); } +content::WebContents* CommonWebContentsDelegate::GetWebContents() const { + if (!web_contents_) + return nullptr; + return web_contents_->GetWebContents(); +} + +content::WebContents* +CommonWebContentsDelegate::GetDevToolsWebContents() const { + if (!web_contents_) + return nullptr; + return web_contents_->GetDevToolsWebContents(); +} + void CommonWebContentsDelegate::RequestToLockMouse( content::WebContents* web_contents, bool user_gesture, @@ -156,17 +171,27 @@ void CommonWebContentsDelegate::EnumerateDirectory(content::WebContents* guest, web_dialog_helper_->EnumerateDirectory(guest, request_id, path); } -content::WebContents* CommonWebContentsDelegate::GetWebContents() const { - if (!web_contents_) - return nullptr; - return web_contents_->GetWebContents(); +void CommonWebContentsDelegate::EnterFullscreenModeForTab( + content::WebContents* source, const GURL& origin) { + if (!owner_window_) + return; + SetHtmlApiFullscreen(true); + owner_window_->NotifyWindowEnterHtmlFullScreen(); + source->GetRenderViewHost()->WasResized(); } -content::WebContents* -CommonWebContentsDelegate::GetDevToolsWebContents() const { - if (!web_contents_) - return nullptr; - return web_contents_->GetDevToolsWebContents(); +void CommonWebContentsDelegate::ExitFullscreenModeForTab( + content::WebContents* source) { + if (!owner_window_) + return; + SetHtmlApiFullscreen(false); + owner_window_->NotifyWindowLeaveHtmlFullScreen(); + source->GetRenderViewHost()->WasResized(); +} + +bool CommonWebContentsDelegate::IsFullscreenForTabOrPending( + const content::WebContents* source) const { + return html_fullscreen_; } void CommonWebContentsDelegate::DevToolsSaveToFile( @@ -269,4 +294,23 @@ void CommonWebContentsDelegate::DevToolsRemoveFileSystem( nullptr); } +void CommonWebContentsDelegate::SetHtmlApiFullscreen(bool enter_fullscreen) { + // Window is already in fullscreen mode, save the state. + if (enter_fullscreen && owner_window_->IsFullscreen()) { + native_fullscreen_ = true; + html_fullscreen_ = true; + return; + } + + // Exit html fullscreen state but not window's fullscreen mode. + if (!enter_fullscreen && native_fullscreen_) { + html_fullscreen_ = false; + return; + } + + owner_window_->SetFullScreen(enter_fullscreen); + html_fullscreen_ = enter_fullscreen; + native_fullscreen_ = false; +} + } // namespace atom diff --git a/atom/browser/common_web_contents_delegate.h b/atom/browser/common_web_contents_delegate.h index 8909d1931457..30545e2e4043 100644 --- a/atom/browser/common_web_contents_delegate.h +++ b/atom/browser/common_web_contents_delegate.h @@ -64,6 +64,11 @@ class CommonWebContentsDelegate void EnumerateDirectory(content::WebContents* web_contents, int request_id, const base::FilePath& path) override; + void EnterFullscreenModeForTab(content::WebContents* source, + const GURL& origin) override; + void ExitFullscreenModeForTab(content::WebContents* source) override; + bool IsFullscreenForTabOrPending( + const content::WebContents* source) const override; // brightray::InspectableWebContentsDelegate: void DevToolsSaveToFile(const std::string& url, @@ -75,12 +80,21 @@ class CommonWebContentsDelegate void DevToolsRemoveFileSystem(const std::string& file_system_path) override; private: + // Set fullscreen mode triggered by html api. + void SetHtmlApiFullscreen(bool enter_fullscreen); + // Whether this is guest WebContents or NativeWindow. const bool is_guest_; // The window that this WebContents belongs to. NativeWindow* owner_window_; + // Whether window is fullscreened by HTML5 api. + bool html_fullscreen_; + + // Whether window is fullscreened by window api. + bool native_fullscreen_; + scoped_ptr web_dialog_helper_; scoped_ptr dialog_manager_; diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 07ad83f1acee..60a9eb27f2d2 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -94,8 +94,6 @@ NativeWindow::NativeWindow(content::WebContents* web_contents, is_closed_(false), node_integration_(true), has_dialog_attached_(false), - html_fullscreen_(false), - native_fullscreen_(false), zoom_factor_(1.0), weak_factory_(this) { printing::PrintViewManagerBasic::CreateForWebContents(web_contents); @@ -431,25 +429,6 @@ void NativeWindow::OverrideWebkitPrefs(content::WebPreferences* prefs) { } } -void NativeWindow::SetHtmlApiFullscreen(bool enter_fullscreen) { - // Window is already in fullscreen mode, save the state. - if (enter_fullscreen && IsFullscreen()) { - native_fullscreen_ = true; - html_fullscreen_ = true; - return; - } - - // Exit html fullscreen state but not window's fullscreen mode. - if (!enter_fullscreen && native_fullscreen_) { - html_fullscreen_ = false; - return; - } - - SetFullScreen(enter_fullscreen); - html_fullscreen_ = enter_fullscreen; - native_fullscreen_ = false; -} - void NativeWindow::NotifyWindowClosed() { if (is_closed_) return; @@ -647,20 +626,6 @@ void NativeWindow::RendererResponsive(content::WebContents* source) { FOR_EACH_OBSERVER(NativeWindowObserver, observers_, OnRendererResponsive()); } -void NativeWindow::EnterFullscreenModeForTab(content::WebContents* source, - const GURL& origin) { - SetHtmlApiFullscreen(true); -} - -void NativeWindow::ExitFullscreenModeForTab(content::WebContents* source) { - SetHtmlApiFullscreen(false); -} - -bool NativeWindow::IsFullscreenForTabOrPending( - const content::WebContents* source) const { - return is_html_api_fullscreen(); -} - void NativeWindow::BeforeUnloadFired(const base::TimeTicks& proceed_time) { // Do nothing, we override this method just to avoid compilation error since // there are two virtual functions named BeforeUnloadFired. diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index 191e326df06d..2038775f8d9a 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -179,9 +179,6 @@ class NativeWindow : public CommonWebContentsDelegate, void AppendExtraCommandLineSwitches(base::CommandLine* command_line); void OverrideWebkitPrefs(content::WebPreferences* prefs); - // Set fullscreen mode triggered by html api. - void SetHtmlApiFullscreen(bool enter_fullscreen); - // Public API used by platform-dependent delegates and observers to send UI // related notifications. void NotifyWindowClosed(); @@ -213,8 +210,6 @@ class NativeWindow : public CommonWebContentsDelegate, bool has_frame() const { return has_frame_; } - bool is_html_api_fullscreen() const { return html_fullscreen_; } - void set_has_dialog_attached(bool has_dialog_attached) { has_dialog_attached_ = has_dialog_attached; } @@ -250,11 +245,6 @@ class NativeWindow : public CommonWebContentsDelegate, void CloseContents(content::WebContents* source) override; void RendererUnresponsive(content::WebContents* source) override; void RendererResponsive(content::WebContents* source) override; - void EnterFullscreenModeForTab(content::WebContents* source, - const GURL& origin) override; - void ExitFullscreenModeForTab(content::WebContents* source) override; - bool IsFullscreenForTabOrPending( - const content::WebContents* source) const override; // Implementations of content::WebContentsObserver. void RenderViewCreated(content::RenderViewHost* render_view_host) override; @@ -310,12 +300,6 @@ class NativeWindow : public CommonWebContentsDelegate, // There is a dialog that has been attached to window. bool has_dialog_attached_; - // Whether window is fullscreened by HTML5 api. - bool html_fullscreen_; - - // Whether window is fullscreened by window api. - bool native_fullscreen_; - // Closure that would be called when window is unresponsive when closing, // it should be cancelled when we can prove that the window is responsive. base::CancelableClosure window_unresposive_closure_; From af62b7b5c9518fdc89e10dda8e07da01c8a3c5e1 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 5 Jun 2015 17:45:17 +0800 Subject: [PATCH 0169/1293] Put common code of OpenURLFromTab to CommonWebContentsDelegate --- atom/browser/api/atom_api_web_contents.cc | 14 +---------- atom/browser/common_web_contents_delegate.cc | 25 ++++++++++++++++++++ atom/browser/common_web_contents_delegate.h | 3 +++ atom/browser/native_window.cc | 14 +---------- 4 files changed, 30 insertions(+), 26 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 18bfc7a53f5f..3678be78529b 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -195,19 +195,7 @@ content::WebContents* WebContents::OpenURLFromTab( if (Emit("will-navigate", params.url)) return nullptr; - content::NavigationController::LoadURLParams load_url_params(params.url); - load_url_params.referrer = params.referrer; - load_url_params.transition_type = params.transition; - load_url_params.extra_headers = params.extra_headers; - load_url_params.should_replace_current_entry = - params.should_replace_current_entry; - load_url_params.is_renderer_initiated = params.is_renderer_initiated; - load_url_params.transferred_global_request_id = - params.transferred_global_request_id; - load_url_params.should_clear_history_list = true; - - web_contents()->GetController().LoadURLWithParams(load_url_params); - return web_contents(); + return CommonWebContentsDelegate::OpenURLFromTab(source, params); } void WebContents::HandleKeyboardEvent( diff --git a/atom/browser/common_web_contents_delegate.cc b/atom/browser/common_web_contents_delegate.cc index 564efe7edd15..1cf75cf021ef 100644 --- a/atom/browser/common_web_contents_delegate.cc +++ b/atom/browser/common_web_contents_delegate.cc @@ -15,6 +15,7 @@ #include "content/public/browser/child_process_security_policy.h" #include "content/public/browser/render_process_host.h" #include "content/public/browser/render_view_host.h" +#include "content/public/common/renderer_preferences.h" #include "storage/browser/fileapi/isolated_context.h" namespace atom { @@ -101,6 +102,12 @@ void CommonWebContentsDelegate::InitWithWebContents( owner_window_ = owner_window; web_contents->SetDelegate(this); + // Tell renderer to handle all navigations in browser. + auto preferences = web_contents->GetMutableRendererPrefs(); + preferences->browser_handles_non_local_top_level_requests = true; + preferences->browser_handles_all_top_level_requests = true; + web_contents->GetRenderViewHost()->SyncRendererPrefs(); + // Create InspectableWebContents. web_contents_.reset(brightray::InspectableWebContents::Create(web_contents)); web_contents_->SetDelegate(this); @@ -123,6 +130,24 @@ CommonWebContentsDelegate::GetDevToolsWebContents() const { return web_contents_->GetDevToolsWebContents(); } +content::WebContents* CommonWebContentsDelegate::OpenURLFromTab( + content::WebContents* source, + const content::OpenURLParams& params) { + content::NavigationController::LoadURLParams load_url_params(params.url); + load_url_params.referrer = params.referrer; + load_url_params.transition_type = params.transition; + load_url_params.extra_headers = params.extra_headers; + load_url_params.should_replace_current_entry = + params.should_replace_current_entry; + load_url_params.is_renderer_initiated = params.is_renderer_initiated; + load_url_params.transferred_global_request_id = + params.transferred_global_request_id; + load_url_params.should_clear_history_list = true; + + source->GetController().LoadURLWithParams(load_url_params); + return source; +} + void CommonWebContentsDelegate::RequestToLockMouse( content::WebContents* web_contents, bool user_gesture, diff --git a/atom/browser/common_web_contents_delegate.h b/atom/browser/common_web_contents_delegate.h index 30545e2e4043..84564e0ce743 100644 --- a/atom/browser/common_web_contents_delegate.h +++ b/atom/browser/common_web_contents_delegate.h @@ -48,6 +48,9 @@ class CommonWebContentsDelegate protected: // content::WebContentsDelegate: + content::WebContents* OpenURLFromTab( + content::WebContents* source, + const content::OpenURLParams& params) override; void RequestToLockMouse(content::WebContents* web_contents, bool user_gesture, bool last_unlocked_by_target) override; diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 60a9eb27f2d2..8eb05cb9b0f2 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -542,19 +542,7 @@ content::WebContents* NativeWindow::OpenURLFromTab( if (prevent_default) return nullptr; - content::NavigationController::LoadURLParams load_url_params(params.url); - load_url_params.referrer = params.referrer; - load_url_params.transition_type = params.transition; - load_url_params.extra_headers = params.extra_headers; - load_url_params.should_replace_current_entry = - params.should_replace_current_entry; - load_url_params.is_renderer_initiated = params.is_renderer_initiated; - load_url_params.transferred_global_request_id = - params.transferred_global_request_id; - load_url_params.should_clear_history_list = true; - - source->GetController().LoadURLWithParams(load_url_params); - return source; + return CommonWebContentsDelegate::OpenURLFromTab(source, params); } void NativeWindow::RenderViewCreated( From bb42c2c7b65b3f4fd5b0e796e48fde2a96eb6638 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 5 Jun 2015 18:13:30 +0800 Subject: [PATCH 0170/1293] Avoid destorying api::WebContents for twice --- atom/browser/api/atom_api_web_contents.cc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 3678be78529b..3d925b839918 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -409,7 +409,7 @@ void WebContents::WillAttach(content::WebContents* embedder_web_contents, } void WebContents::Destroy() { - if (is_guest()) { + if (is_guest() && managed_web_contents()) { // When force destroying the "destroyed" event is not emitted. WebContentsDestroyed(); From c821a06e2f001db8726777b01a8ee5656d7067e9 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Fri, 5 Jun 2015 18:50:52 +0800 Subject: [PATCH 0171/1293] Implement crash-reporter.getUploadedReports API. Also redefine the getLastCrashReport API implementation using getUploadedReports API. --- atom/common/api/lib/crash-reporter.coffee | 22 +++++++-------- atom/common/crash_reporter/crash_reporter.cc | 23 ++++++++++++++-- atom/common/crash_reporter/crash_reporter.h | 3 ++- .../crash_reporter/crash_reporter_mac.h | 8 ++---- .../crash_reporter/crash_reporter_mac.mm | 27 ++++++++++--------- 5 files changed, 50 insertions(+), 33 deletions(-) diff --git a/atom/common/api/lib/crash-reporter.coffee b/atom/common/api/lib/crash-reporter.coffee index c151ff7f71c8..868cda28fcf6 100644 --- a/atom/common/api/lib/crash-reporter.coffee +++ b/atom/common/api/lib/crash-reporter.coffee @@ -41,23 +41,23 @@ class CrashReporter start() getLastCrashReport: -> - if process.platform is 'darwin' - reports = binding._getUploadedReports() - return if reports.length > 0 then reports[0] else null + reports = this.getUploadedReports() + if reports.length > 0 then reports[0] else null + getUploadedReports: -> tmpdir = if process.platform is 'win32' os.tmpdir() else '/tmp' - log = path.join tmpdir, "#{@productName} Crashes", 'uploads.log' - try - reports = String(fs.readFileSync(log)).split('\n') - return null unless reports.length > 1 - [time, id] = reports[reports.length - 2].split ',' - return {date: new Date(parseInt(time) * 1000), id} - catch e - return null + log = + if process.platform is 'darwin' + path.join tmpdir, "#{@productName} Crashes" + else + path.join tmpdir, "#{@productName} Crashes", 'uploads.log' + console.log log; + binding._getUploadedReports(log) + crashRepoter = new CrashReporter module.exports = crashRepoter diff --git a/atom/common/crash_reporter/crash_reporter.cc b/atom/common/crash_reporter/crash_reporter.cc index 25dbf6065d96..365860b256c7 100644 --- a/atom/common/crash_reporter/crash_reporter.cc +++ b/atom/common/crash_reporter/crash_reporter.cc @@ -7,6 +7,9 @@ #include "atom/browser/browser.h" #include "atom/common/atom_version.h" #include "base/command_line.h" +#include "base/files/file_util.h" +#include "base/strings/string_split.h" +#include "base/strings/string_number_conversions.h" #include "content/public/common/content_switches.h" namespace crash_reporter { @@ -40,8 +43,24 @@ void CrashReporter::SetUploadParameters(const StringMap& parameters) { } std::vector -CrashReporter::GetUploadedReports() { - return std::vector(); +CrashReporter::GetUploadedReports(const std::string& path) { + std::string file_content; + std::vector result; + if (base::ReadFileToString(base::FilePath(path), &file_content)) { + std::vector reports; + base::SplitString(file_content, '\n', &reports); + for (const std::string& report : reports) { + std::vector report_item; + base::SplitString(report, ',', &report_item); + int report_time = 0; + if (report_item.size() >= 2 && base::StringToInt(report_item[0], + &report_time)) { + result.push_back(CrashReporter::UploadReportResult(report_time, + report_item[1])); + } + } + } + return result; } } // namespace crash_reporter diff --git a/atom/common/crash_reporter/crash_reporter.h b/atom/common/crash_reporter/crash_reporter.h index 6cfa5b3f3a59..c7d58ca3aa76 100644 --- a/atom/common/crash_reporter/crash_reporter.h +++ b/atom/common/crash_reporter/crash_reporter.h @@ -28,7 +28,8 @@ class CrashReporter { bool skip_system_crash_handler, const StringMap& extra_parameters); - virtual std::vector GetUploadedReports(); + virtual std::vector GetUploadedReports( + const std::string& path); protected: CrashReporter(); diff --git a/atom/common/crash_reporter/crash_reporter_mac.h b/atom/common/crash_reporter/crash_reporter_mac.h index ca31237cc154..cbdb3c65feb1 100644 --- a/atom/common/crash_reporter/crash_reporter_mac.h +++ b/atom/common/crash_reporter/crash_reporter_mac.h @@ -16,10 +16,6 @@ template struct DefaultSingletonTraits; -namespace crashpad { -class CrashReportDatabase; -} - namespace crash_reporter { class CrashReporterMac : public CrashReporter { @@ -44,10 +40,10 @@ class CrashReporterMac : public CrashReporter { void SetCrashKeyValue(const base::StringPiece& key, const base::StringPiece& value); - std::vector GetUploadedReports() override; + std::vector GetUploadedReports( + const std::string& path) override; scoped_ptr simple_string_dictionary_; - scoped_ptr crash_report_database_; DISALLOW_COPY_AND_ASSIGN(CrashReporterMac); }; diff --git a/atom/common/crash_reporter/crash_reporter_mac.mm b/atom/common/crash_reporter/crash_reporter_mac.mm index 4edd35a43138..00f37cc3febb 100644 --- a/atom/common/crash_reporter/crash_reporter_mac.mm +++ b/atom/common/crash_reporter/crash_reporter_mac.mm @@ -5,6 +5,7 @@ #include "atom/common/crash_reporter/crash_reporter_mac.h" #include "base/files/file_path.h" +#include "base/files/file_util.h" #include "base/mac/bundle_locations.h" #include "base/mac/mac_util.h" #include "base/memory/singleton.h" @@ -71,9 +72,11 @@ void CrashReporterMac::InitBreakpad(const std::string& product_name, SetCrashKeyValue(upload_parameter.first, upload_parameter.second); } if (is_browser_) { - crash_report_database_ = crashpad::CrashReportDatabase::Initialize( - database_path); - SetUploadsEnabled(auto_submit); + scoped_ptr database = + crashpad::CrashReportDatabase::Initialize(database_path); + if (database) { + database->GetSettings()->SetUploadsEnabled(auto_submit); + } } } @@ -81,29 +84,27 @@ void CrashReporterMac::SetUploadParameters() { upload_parameters_["platform"] = "darwin"; } -void CrashReporterMac::SetUploadsEnabled(bool enable_uploads) { - if (crash_report_database_) { - crashpad::Settings* settings = crash_report_database_->GetSettings(); - settings->SetUploadsEnabled(enable_uploads); - } -} - void CrashReporterMac::SetCrashKeyValue(const base::StringPiece& key, const base::StringPiece& value) { simple_string_dictionary_->SetKeyValue(key.data(), value.data()); } std::vector -CrashReporterMac::GetUploadedReports() { +CrashReporterMac::GetUploadedReports(const std::string& path) { std::vector uploaded_reports; - if (!crash_report_database_) { + base::FilePath file_path(path); + if (!base::PathExists(file_path)) { return uploaded_reports; } + // Load crashpad database. + scoped_ptr database = + crashpad::CrashReportDatabase::Initialize(file_path); + DCHECK(database); std::vector completed_reports; crashpad::CrashReportDatabase::OperationStatus status = - crash_report_database_->GetCompletedReports(&completed_reports); + database->GetCompletedReports(&completed_reports); if (status != crashpad::CrashReportDatabase::kNoError) { return uploaded_reports; } From 4da7578daba66c82c945ecaeb5f485d6fe8fd156 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Fri, 5 Jun 2015 19:05:55 +0800 Subject: [PATCH 0172/1293] :memo: Add getUploadedReports API doc. --- docs/api/crash-reporter.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/api/crash-reporter.md b/docs/api/crash-reporter.md index d867f77ce398..2064f20f3951 100644 --- a/docs/api/crash-reporter.md +++ b/docs/api/crash-reporter.md @@ -27,6 +27,9 @@ crashReporter.start({ * Only string properties are send correctly. * Nested objects are not supported. +Developers are required to call the API before using other crashReporter APIs. + + **Note:** On OS X, electron uses a new `crashpad` client, which is different with the `breakpad` on Windows and Linux. To enable crash collection feature, you are required to call `crashReporter.start` API to initiliaze `crashpad` in @@ -37,6 +40,10 @@ main process, even you only collect crash report in renderer process. Returns the date and ID of last crash report, when there was no crash report sent or the crash reporter is not started, `null` will be returned. +## crashReporter.getUploadedReports() + +Returns all uploaded crash reports, each report contains date and uploaded ID. + # crash-reporter payload The crash reporter will send the following data to the `submitUrl` as `POST`: From 13c1b078f98ba79164540b33e6a7407298b15fa7 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 5 Jun 2015 19:48:58 +0800 Subject: [PATCH 0173/1293] Fix refreshing test window --- spec/api-crash-reporter-spec.coffee | 6 +++++- spec/static/main.js | 1 + 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/spec/api-crash-reporter-spec.coffee b/spec/api-crash-reporter-spec.coffee index fc93eb304b65..6cd714215354 100644 --- a/spec/api-crash-reporter-spec.coffee +++ b/spec/api-crash-reporter-spec.coffee @@ -39,8 +39,12 @@ describe 'crash-reporter module', -> res.end('abc-123-def') server.close() done() - server.listen 0, '127.0.0.1', -> + # Server port is generated randomly for the first run, it will be reused + # when page is refreshed. + port = remote.process.port + server.listen port, '127.0.0.1', -> {port} = server.address() + remote.process.port = port url = url.format protocol: 'file' pathname: path.join fixtures, 'api', 'crash.html' diff --git a/spec/static/main.js b/spec/static/main.js index df9f19a630e2..601926716e96 100644 --- a/spec/static/main.js +++ b/spec/static/main.js @@ -5,6 +5,7 @@ var BrowserWindow = require('browser-window'); var Menu = require('menu'); var window = null; +process.port = 0; // will be used by crash-reporter spec. app.commandLine.appendSwitch('js-flags', '--expose_gc'); app.commandLine.appendSwitch('ignore-certificate-errors'); From 690513db7fc17d60bfdc3fecfdd680d5c4783e11 Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Sat, 6 Jun 2015 00:59:28 +0530 Subject: [PATCH 0174/1293] doc: adding info about log-net-log flag --- docs/api/chrome-command-line-switches.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/api/chrome-command-line-switches.md b/docs/api/chrome-command-line-switches.md index fe22bd2c08ab..316211e4db0c 100644 --- a/docs/api/chrome-command-line-switches.md +++ b/docs/api/chrome-command-line-switches.md @@ -70,6 +70,10 @@ Set path to pepper flash plugin for use. Set the pepper flash version. +## --log-net-log + +Set the path to net log file. + ## --v=`log_level` Gives the default maximal active V-logging level; 0 is the default. Normally From 8a2b66509775151253eb95c91be9fcb1be93fcef Mon Sep 17 00:00:00 2001 From: BobCochran Date: Fri, 5 Jun 2015 19:38:30 -0400 Subject: [PATCH 0175/1293] Edit linux build instructions based on feedback --- docs/development/build-instructions-linux.md | 57 +++++--------------- 1 file changed, 12 insertions(+), 45 deletions(-) diff --git a/docs/development/build-instructions-linux.md b/docs/development/build-instructions-linux.md index 06b1561743ef..638ceb35ef30 100644 --- a/docs/development/build-instructions-linux.md +++ b/docs/development/build-instructions-linux.md @@ -2,12 +2,16 @@ ## Prerequisites -* Python 2.7.x -* [Node.js] (http://nodejs.org) +* Python 2.7.x. Some distributions like CentOS still use Python 2.6.x +so you may need to check your Python version with `python -V`. +* Node.js v0.12.x. There are various ways to install Node. One can download +source code from [Node.js] (http://nodejs.org) and compile from source. +Doing so permits installing Node to your own home directory as a standard user. +Or try repositories such as [NodeSource] (https://nodesource.com/blog/nodejs-v012-iojs-and-the-nodesource-linux-repositories) * Clang 3.4 or later * Development headers of GTK+ and libnotify -On Ubuntu you could install the libraries via: +On Ubuntu, install the following libraries: ```bash $ sudo apt-get install build-essential clang libdbus-1-dev libgtk2.0-dev \ @@ -16,6 +20,10 @@ $ sudo apt-get install build-essential clang libdbus-1-dev libgtk2.0-dev \ libxss1 gcc-multilib g++-multilib ``` +Other distributions may offer similar packages for installation via package +managers such as yum. Or one can compile from source code. + + ## If You Use Virtual Machines For Building If you plan to build electron on a virtual machine, you will need a fixed-size @@ -80,48 +88,7 @@ under `out/D`. ## Troubleshooting -### fatal error: bits/predefs.h: No such file or directory - -If you got an error like this: - -```` -In file included from /usr/include/stdio.h:28:0, - from ../../../svnsrc/libgcc/../gcc/tsystem.h:88, - from ../../../svnsrc/libgcc/libgcc2.c:29: -/usr/include/features.h:324:26: fatal error: bits/predefs.h: No such file or directory - #include -```` - -Then you need to install `gcc-multilib` and `g++-multilib`, on Ubuntu you can do -this: - -```bash -$ sudo apt-get install gcc-multilib g++-multilib -``` - -### libudev.so.0 missing - -If you get an error like: - -```` -/usr/bin/ld: warning: libudev.so.0, needed by .../vendor/brightray/vendor/download/libchromiumcontent/Release/libchromiumcontent.so, not found (try using -rpath or -rpath-link) -```` - -and you are on Ubuntu 13.04+, 64 bit system, try doing - -```bash -sudo ln -s /lib/x86_64-linux-gnu/libudev.so.1.3.5 /usr/lib/libudev.so.0 -``` - -for ubuntu 13.04+ 32 bit systems, try doing - -```bash -sudo ln -s /lib/i386-linux-gnu/libudev.so.1.3.5 /usr/lib/libudev.so.0 -``` - -also see - -https://github.com/nwjs/nw.js/wiki/The-solution-of-lacking-libudev.so.0 +Make sure you have installed all the build dependencies. ## Tests From cd1c331112360ded924830bcc07ab54ccaff9207 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Sat, 6 Jun 2015 17:59:20 +0800 Subject: [PATCH 0176/1293] Fix coffeelint error. --- atom/common/api/lib/crash-reporter.coffee | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/atom/common/api/lib/crash-reporter.coffee b/atom/common/api/lib/crash-reporter.coffee index 868cda28fcf6..451fa1729428 100644 --- a/atom/common/api/lib/crash-reporter.coffee +++ b/atom/common/api/lib/crash-reporter.coffee @@ -55,8 +55,7 @@ class CrashReporter path.join tmpdir, "#{@productName} Crashes" else path.join tmpdir, "#{@productName} Crashes", 'uploads.log' - console.log log; - binding._getUploadedReports(log) + binding._getUploadedReports log crashRepoter = new CrashReporter From 9a0a10e76679f55e5197a41c15ecce665bc3a865 Mon Sep 17 00:00:00 2001 From: Lucidogen Media Date: Sat, 6 Jun 2015 13:20:47 +0200 Subject: [PATCH 0177/1293] Fixed example with correct capturePage api. --- docs/api/remote.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/api/remote.md b/docs/api/remote.md index 345b0d5b132d..70703743b5f7 100644 --- a/docs/api/remote.md +++ b/docs/api/remote.md @@ -97,7 +97,8 @@ returns a `Buffer` by calling the passed callback: ```javascript var remote = require('remote'); var fs = require('fs'); -remote.getCurrentWindow().capturePage(function(buf) { +remote.getCurrentWindow().capturePage(function(image) { + var buf = image.toPng() fs.writeFile('/tmp/screenshot.png', buf, function(err) { console.log(err); }); @@ -115,7 +116,8 @@ The work-around is to write the `buf` in the main process, where it is a real ```javascript var remote = require('remote'); -remote.getCurrentWindow().capturePage(function(buf) { +remote.getCurrentWindow().capturePage(function(image) { + var buf = image.toPng() remote.require('fs').writeFile('/tmp/screenshot.png', buf, function(err) { console.log(err); }); From 582a42f97c05acef6c3da9c2ec8ea980233f3bfa Mon Sep 17 00:00:00 2001 From: Lucidogen Media Date: Sat, 6 Jun 2015 13:31:22 +0200 Subject: [PATCH 0178/1293] Added ending semicolon for consistency. --- docs/api/remote.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/remote.md b/docs/api/remote.md index 70703743b5f7..fa0cd387ff37 100644 --- a/docs/api/remote.md +++ b/docs/api/remote.md @@ -98,7 +98,7 @@ returns a `Buffer` by calling the passed callback: var remote = require('remote'); var fs = require('fs'); remote.getCurrentWindow().capturePage(function(image) { - var buf = image.toPng() + var buf = image.toPng(); fs.writeFile('/tmp/screenshot.png', buf, function(err) { console.log(err); }); @@ -117,7 +117,7 @@ The work-around is to write the `buf` in the main process, where it is a real ```javascript var remote = require('remote'); remote.getCurrentWindow().capturePage(function(image) { - var buf = image.toPng() + var buf = image.toPng(); remote.require('fs').writeFile('/tmp/screenshot.png', buf, function(err) { console.log(err); }); From e4ae579b1643721afdaaf4f9e1123f7aa7d722c1 Mon Sep 17 00:00:00 2001 From: Lucidogen Media Date: Sat, 6 Jun 2015 13:38:00 +0200 Subject: [PATCH 0179/1293] Added note and link for poorly documented operation. Accessing renderer process from main process is not documented and as "remote" does the opposite, it seems fair to add a pointer here. --- docs/api/remote.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/api/remote.md b/docs/api/remote.md index 345b0d5b132d..4abe774b6a70 100644 --- a/docs/api/remote.md +++ b/docs/api/remote.md @@ -20,6 +20,8 @@ var win = new BrowserWindow({ width: 800, height: 600 }); win.loadUrl('https://github.com'); ``` +Note: for the reverse (access renderer process from main process), you can use [webContents.executeJavascript](https://github.com/atom/electron/blob/master/docs/api/browser-window.md#browserwindowwebcontents). + ## Remote objects Each object (including functions) returned by the `remote` module represents an From 40b6a1a37c2fde83625de2879c77ef0629745dcc Mon Sep 17 00:00:00 2001 From: BobCochran Date: Sat, 6 Jun 2015 18:04:11 -0400 Subject: [PATCH 0180/1293] Add instructions to clean build products --- docs/development/build-instructions-linux.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/development/build-instructions-linux.md b/docs/development/build-instructions-linux.md index 638ceb35ef30..5b9e0408e827 100644 --- a/docs/development/build-instructions-linux.md +++ b/docs/development/build-instructions-linux.md @@ -86,6 +86,17 @@ $ ./script/build.py -c D After building is done, you can find the `electron` debug binary under `out/D`. + +## Cleaning + + +To clean the build files: + +```bash +$ ./script/clean.py +``` + + ## Troubleshooting Make sure you have installed all the build dependencies. From 29827fa66bf6d611b1a95f4e97e45b655e13c230 Mon Sep 17 00:00:00 2001 From: Sam Saccone Date: Sat, 6 Jun 2015 21:42:21 -0400 Subject: [PATCH 0181/1293] :memo: Fix english errors --- docs/api/process.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/process.md b/docs/api/process.md index 160ffc78bc8a..4afa6677b8aa 100644 --- a/docs/api/process.md +++ b/docs/api/process.md @@ -1,6 +1,6 @@ # Process object -The `process` object in Electron has following differences between the one in +The `process` object in Electron has the following differences from the one in upstream node: * `process.type` String - Process's type, can be `browser` (i.e. main process) or `renderer`. From 161dc45ec8f4316e2d13b9d8b38ee06ea94c6f49 Mon Sep 17 00:00:00 2001 From: Sam Saccone Date: Sat, 6 Jun 2015 21:46:51 -0400 Subject: [PATCH 0182/1293] :memo: Fix english errors and clarify docs --- docs/api/global-shortcut.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/api/global-shortcut.md b/docs/api/global-shortcut.md index 285c26995afb..2d27398aae4b 100644 --- a/docs/api/global-shortcut.md +++ b/docs/api/global-shortcut.md @@ -1,8 +1,8 @@ # global-shortcut The `global-shortcut` module can register/unregister a global keyboard shortcut -in operating system, so that you can custom the operations for various shortcuts. -Note that it is global, even the app does not get focused, it still works. +in operating system, so that you can customize the operations for various shortcuts. +Note that the shortcut is global, even if the app does not get focused, it will still work. ```javascript var globalShortcut = require('global-shortcut'); @@ -34,7 +34,7 @@ the registered shortcut is pressed by user. * `accelerator` [Accelerator](accelerator.md) -Returns whether shortcut of `accelerator` is registered. +Returns `true` or `false` depending on if the shortcut `accelerator` is registered. ## globalShortcut.unregister(accelerator) From 55c07cec68bce21567a217db609670cf97fcac3a Mon Sep 17 00:00:00 2001 From: Sam Saccone Date: Sat, 6 Jun 2015 21:56:13 -0400 Subject: [PATCH 0183/1293] :memo: Improve devtools documentation --- docs/tutorial/devtools-extension.md | 28 ++++++++++++---------------- 1 file changed, 12 insertions(+), 16 deletions(-) diff --git a/docs/tutorial/devtools-extension.md b/docs/tutorial/devtools-extension.md index 1e0a64ac3901..e93013d6ed19 100644 --- a/docs/tutorial/devtools-extension.md +++ b/docs/tutorial/devtools-extension.md @@ -1,14 +1,14 @@ # DevTools extension -To make debugging more easy, Electron has added basic support for +To make debugging easier, Electron has basic support for [Chrome DevTools Extension][devtools-extension]. -For most devtools extensions, you can simply download their source codes and use +For most devtools extensions, you can simply download the source code and use the `BrowserWindow.addDevToolsExtension` API to load them, the loaded extensions will be remembered so you don't need to call the API every time when creating a window. -For example to use the React DevTools Extension, first you need to download its +For example to use the [React DevTools Extension](https://github.com/facebook/react-devtools), first you need to download its source code: ```bash @@ -16,15 +16,15 @@ $ cd /some-directory $ git clone --recursive https://github.com/facebook/react-devtools.git ``` -Then you can load it in Electron by opening the devtools in arbitray window, -and run this code in the console of devtools: +Then you can load the extension in Electron by opening devtools in any window, +and then running the following code in the devtools console: ```javascript require('remote').require('browser-window').addDevToolsExtension('/some-directory/react-devtools') ``` To unload the extension, you can call `BrowserWindow.removeDevToolsExtension` -API with its name and it will disappear the next time you open the devtools: +API with its name and it will not load the next time you open the devtools: ```javascript require('remote').require('browser-window').removeDevToolsExtension('React Developer Tools') @@ -34,23 +34,19 @@ require('remote').require('browser-window').removeDevToolsExtension('React Devel Ideally all devtools extension written for Chrome browser can be loaded by Electron, but they have to be in a plain directory, for those packaged `crx` -extensions, there is no way in Electron to load them unless you find a way to +extensions, there is no way for Electron to load them unless you find a way to extract them into a directory. ## Background pages -Currently Electron doesn't support the background pages of chrome extensions, -so for some devtools extensions that rely on this feature, they may not work -well in Electron +Currently Electron doesn't support the background pages feature in chrome extensions, +so for some devtools extensions that rely on this feature, they may not work in Electron. ## `chrome.*` APIs -Some chrome extensions use `chrome.*` APIs for some features, there is some -effort to implement those APIs in Electron to make them work, but we have -only implemented few for now. +Some chrome extensions use `chrome.*` APIs for some features, there has been some +effort to implement those APIs in Electron, however not all are implemented. -So if the devtools extension is using APIs other than `chrome.devtools.*`, it is -very likely to fail, but you can report those extensions in the issues tracker -so we can add support for those APIs. +Given that not all `chrome.*` APIs are implemented if the devtools extension is using APIs other than `chrome.devtools.*`, the extension is very likely not to work. You can report failing extensions in the issue tracker so that we can add support for those APIs. [devtools-extension]: https://developer.chrome.com/extensions/devtools From f776932718d6ce573af5a2b74b24288bc9aa9142 Mon Sep 17 00:00:00 2001 From: BobCochran Date: Sun, 7 Jun 2015 08:11:44 -0400 Subject: [PATCH 0184/1293] Edited virtual machines sections. --- docs/development/build-instructions-linux.md | 10 +--------- 1 file changed, 1 insertion(+), 9 deletions(-) diff --git a/docs/development/build-instructions-linux.md b/docs/development/build-instructions-linux.md index 5b9e0408e827..505cb4d5f046 100644 --- a/docs/development/build-instructions-linux.md +++ b/docs/development/build-instructions-linux.md @@ -27,15 +27,7 @@ managers such as yum. Or one can compile from source code. ## If You Use Virtual Machines For Building If you plan to build electron on a virtual machine, you will need a fixed-size -device container of at least 25 gigabytes in size. The default disk sizes -suggested by VirtualBox are much too small. You will risk running out of space. -If creating a Ubuntu virtual machine under VirtualBox, do not partition the -disk using LVM, which is the Ubuntu installer default. Instead do all -partitioning with ext4 which is offered as an alternative to LVM. This way -if your vdi container does run out of space, you can use VirtualBox and gparted -utilities to increase the container size without needing to resize -LVM Volume Groups as an additional task. You may never have a need for LVM -in a virtual machine. +device container of at least 25 gigabytes in size. ## Getting the code From b6a5e927e0b23bc5538af503d1cfa49a8d2f84ee Mon Sep 17 00:00:00 2001 From: Sam Saccone Date: Sun, 7 Jun 2015 15:32:54 -0400 Subject: [PATCH 0185/1293] :memo: Fix english errors and language --- docs/api/dialog.md | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/docs/api/dialog.md b/docs/api/dialog.md index 4f4403db6d8e..05b8650a0198 100644 --- a/docs/api/dialog.md +++ b/docs/api/dialog.md @@ -1,7 +1,7 @@ # dialog The `dialog` module provides APIs to show native system dialogs, so web -applications can get the same user experience with native applications. +applications can deliver the same user experience as native applications. An example of showing a dialog to select multiple files and directories: @@ -11,7 +11,7 @@ var dialog = require('dialog'); console.log(dialog.showOpenDialog({ properties: [ 'openFile', 'openDirectory', 'multiSelections' ]})); ``` -**Note for OS X**: If you want to present dialogs as sheets, the only thing you have to do is to provide a `BrowserWindow` reference in the `browserWindow` parameter. +**Note for OS X**: If you want to present dialogs as sheets, the only thing you have to do is provide a `BrowserWindow` reference in the `browserWindow` parameter. ## dialog.showOpenDialog([browserWindow], [options], [callback]) @@ -44,10 +44,9 @@ selected, an example is: If a `callback` is passed, the API call would be asynchronous and the result would be passed via `callback(filenames)` -**Note:** On Windows and Linux, an open dialog could not be both file selector -and directory selector at the same time, so if you set `properties` to -`['openFile', 'openDirectory']` on these platforms, a directory selector would -be showed. +**Note:** On Windows and Linux, an open dialog can not be both a file selector +and a directory selector, so if you set `properties` to +`['openFile', 'openDirectory']` on these platforms, a directory selector will be shown. ## dialog.showSaveDialog([browserWindow], [options], [callback]) @@ -58,14 +57,14 @@ be showed. * `filters` Array * `callback` Function -On success, returns the path of file chosen by the user, otherwise returns +On success, returns the path of the file chosen by the user, otherwise returns `undefined`. The `filters` specifies an array of file types that can be displayed, see `dialog.showOpenDialog` for an example. -If a `callback` is passed, the API call would be asynchronous and the result -would be passed via `callback(filename)` +If a `callback` is passed, the API call will be asynchronous and the result +will be passed via `callback(filename)` ## dialog.showMessageBox([browserWindow], options, [callback]) @@ -82,8 +81,8 @@ would be passed via `callback(filename)` Shows a message box, it will block until the message box is closed. It returns the index of the clicked button. -If a `callback` is passed, the API call would be asynchronous and the result -would be passed via `callback(response)` +If a `callback` is passed, the API call will be asynchronous and the result +will be passed via `callback(response)` ## dialog.showErrorBox(title, content) From 5ae9c633ca7317c419ac0f7ba4990d0d6d386ffa Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 8 Jun 2015 13:19:56 +0800 Subject: [PATCH 0186/1293] Fix building on Windows, close #1896 --- atom/browser/common_web_contents_delegate.cc | 1 + atom/browser/native_window_views.cc | 3 ++- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/atom/browser/common_web_contents_delegate.cc b/atom/browser/common_web_contents_delegate.cc index 1cf75cf021ef..eeb8d5748edc 100644 --- a/atom/browser/common_web_contents_delegate.cc +++ b/atom/browser/common_web_contents_delegate.cc @@ -11,6 +11,7 @@ #include "atom/browser/native_window.h" #include "atom/browser/ui/file_dialog.h" #include "atom/browser/web_dialog_helper.h" +#include "base/files/file_util.h" #include "chrome/browser/ui/browser_dialogs.h" #include "content/public/browser/child_process_security_policy.h" #include "content/public/browser/render_process_host.h" diff --git a/atom/browser/native_window_views.cc b/atom/browser/native_window_views.cc index 710788ddbd11..697d0779f3f9 100644 --- a/atom/browser/native_window_views.cc +++ b/atom/browser/native_window_views.cc @@ -726,7 +726,8 @@ void NativeWindowViews::OnWidgetActivationChanged( else NotifyWindowBlur(); - if (active && GetWebContents() && !IsDevToolsOpened()) + if (active && GetWebContents() && + !inspectable_web_contents()->IsDevToolsViewShowing()) GetWebContents()->Focus(); // Hide menu bar when window is blured. From 57ef6adbbdb2806ca31525231639124796099aba Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 8 Jun 2015 13:22:53 +0800 Subject: [PATCH 0187/1293] win: Fix runing clipboard spec --- spec/api-clipboard-spec.coffee | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/spec/api-clipboard-spec.coffee b/spec/api-clipboard-spec.coffee index 429fcbc2d0ad..135ed6cf1570 100644 --- a/spec/api-clipboard-spec.coffee +++ b/spec/api-clipboard-spec.coffee @@ -25,8 +25,10 @@ describe 'clipboard module', -> markup = if process.platform is 'darwin' 'Hi' - else + else if process.platform is 'linux' 'Hi' + else + 'Hi' clipboard.writeHtml text assert.equal clipboard.readHtml(), markup From 8363a39a568b66b5c91657a84fad1a3ed40b44ba Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 8 Jun 2015 13:24:47 +0800 Subject: [PATCH 0188/1293] Bump v0.27.3 --- atom.gyp | 2 +- atom/browser/resources/mac/Info.plist | 2 +- atom/browser/resources/win/atom.rc | 8 ++++---- atom/common/atom_version.h | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/atom.gyp b/atom.gyp index 0e904a66940f..82b741b41584 100644 --- a/atom.gyp +++ b/atom.gyp @@ -4,7 +4,7 @@ 'product_name%': 'Electron', 'company_name%': 'GitHub, Inc', 'company_abbr%': 'github', - 'version%': '0.27.2', + 'version%': '0.27.3', 'atom_source_root': 'CFBundleIconFile atom.icns CFBundleVersion - 0.27.2 + 0.27.3 LSMinimumSystemVersion 10.8.0 NSMainNibFile diff --git a/atom/browser/resources/win/atom.rc b/atom/browser/resources/win/atom.rc index c559363f41a4..13c6eca6b97c 100644 --- a/atom/browser/resources/win/atom.rc +++ b/atom/browser/resources/win/atom.rc @@ -50,8 +50,8 @@ END // VS_VERSION_INFO VERSIONINFO - FILEVERSION 0,27,2,0 - PRODUCTVERSION 0,27,2,0 + FILEVERSION 0,27,3,0 + PRODUCTVERSION 0,27,3,0 FILEFLAGSMASK 0x3fL #ifdef _DEBUG FILEFLAGS 0x1L @@ -68,12 +68,12 @@ BEGIN BEGIN VALUE "CompanyName", "GitHub, Inc." VALUE "FileDescription", "Electron" - VALUE "FileVersion", "0.27.2" + VALUE "FileVersion", "0.27.3" VALUE "InternalName", "electron.exe" VALUE "LegalCopyright", "Copyright (C) 2015 GitHub, Inc. All rights reserved." VALUE "OriginalFilename", "electron.exe" VALUE "ProductName", "Electron" - VALUE "ProductVersion", "0.27.2" + VALUE "ProductVersion", "0.27.3" VALUE "SquirrelAwareVersion", "1" END END diff --git a/atom/common/atom_version.h b/atom/common/atom_version.h index dd316cdd0220..a108d84985d8 100644 --- a/atom/common/atom_version.h +++ b/atom/common/atom_version.h @@ -7,7 +7,7 @@ #define ATOM_MAJOR_VERSION 0 #define ATOM_MINOR_VERSION 27 -#define ATOM_PATCH_VERSION 2 +#define ATOM_PATCH_VERSION 3 #define ATOM_VERSION_IS_RELEASE 1 From cefe540ec04c8608e8c9a7d75fe2b237569264e8 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 8 Jun 2015 13:47:08 +0800 Subject: [PATCH 0189/1293] mac: Build dump_syms Crashpad doesn't ship dump_syms, we have to build to from breakpad. Related: #1822 --- atom.gyp | 1 + 1 file changed, 1 insertion(+) diff --git a/atom.gyp b/atom.gyp index 82b741b41584..795ae97e9f0c 100644 --- a/atom.gyp +++ b/atom.gyp @@ -45,6 +45,7 @@ 'dependencies': [ '<(project_name)_framework', '<(project_name)_helper', + 'vendor/breakpad/breakpad.gyp:dump_syms', ], 'xcode_settings': { 'ATOM_BUNDLE_ID': 'com.<(company_abbr).<(project_name)', From 75448ad7ed989a28bdd0ad87a90a25f6b92ce83c Mon Sep 17 00:00:00 2001 From: Kirk Ouimet Date: Sun, 7 Jun 2015 23:59:49 -0700 Subject: [PATCH 0190/1293] Guarding against polluted Object.prototypes --- atom/common/lib/asar.coffee | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/atom/common/lib/asar.coffee b/atom/common/lib/asar.coffee index f70d2c456d78..a17ac729253d 100644 --- a/atom/common/lib/asar.coffee +++ b/atom/common/lib/asar.coffee @@ -14,7 +14,7 @@ getOrCreateArchive = (p) -> # Clean cache on quit. process.on 'exit', -> - archive.destroy() for p, archive of cachedArchives + archive.destroy() for own p, archive of cachedArchives # Separate asar package's path from full path. splitPath = (p) -> From 2de5f9de6c47e866da692655222692900212a617 Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Thu, 4 Jun 2015 02:27:06 +0530 Subject: [PATCH 0191/1293] browser: support client certificate --- atom/browser/atom_browser_client.cc | 36 ++++++++++++++++++++++++ atom/browser/atom_browser_client.h | 9 ++++++ atom/common/options_switches.cc | 3 ++ atom/common/options_switches.h | 1 + docs/api/chrome-command-line-switches.md | 4 +++ 5 files changed, 53 insertions(+) diff --git a/atom/browser/atom_browser_client.cc b/atom/browser/atom_browser_client.cc index 88aa5b77755c..2d5db4d17d13 100644 --- a/atom/browser/atom_browser_client.cc +++ b/atom/browser/atom_browser_client.cc @@ -19,11 +19,14 @@ #include "chrome/browser/renderer_host/pepper/chrome_browser_pepper_host_factory.h" #include "chrome/browser/speech/tts_message_filter.h" #include "content/public/browser/browser_ppapi_host.h" +#include "content/public/browser/client_certificate_delegate.h" #include "content/public/browser/render_process_host.h" #include "content/public/browser/render_view_host.h" #include "content/public/browser/site_instance.h" #include "content/public/browser/web_contents.h" #include "content/public/common/web_preferences.h" +#include "net/cert/x509_certificate.h" +#include "net/ssl/ssl_cert_request_info.h" #include "ppapi/host/ppapi_host.h" #include "ui/base/l10n/l10n_util.h" @@ -67,6 +70,23 @@ ProcessOwner GetProcessOwner(int process_id, return OWNER_NONE; } +scoped_refptr ImportCertFromFile( + const base::FilePath& path) { + std::string cert_data; + if (!base::ReadFileToString(path, &cert_data)) + return nullptr; + + net::CertificateList certs = + net::X509Certificate::CreateCertificateListFromBytes( + cert_data.data(), cert_data.size(), + net::X509Certificate::FORMAT_AUTO); + + if (certs.empty()) + return nullptr; + + return certs[0]; +} + } // namespace // static @@ -189,6 +209,22 @@ content::QuotaPermissionContext* return new AtomQuotaPermissionContext; } +void AtomBrowserClient::SelectClientCertificate( + content::WebContents* web_contents, + net::SSLCertRequestInfo* cert_request_info, + scoped_ptr delegate) { + auto command_line = base::CommandLine::ForCurrentProcess(); + auto cert_path = command_line->GetSwitchValueNative( + switches::kClientCertificate); + + if (cert_path.empty()) + return; + + scoped_refptr certificate = + ImportCertFromFile(base::FilePath(cert_path)); + delegate->ContinueWithCertificate(certificate.get()); +} + brightray::BrowserMainParts* AtomBrowserClient::OverrideCreateBrowserMainParts( const content::MainFunctionParams&) { v8::V8::Initialize(); // Init V8 before creating main parts. diff --git a/atom/browser/atom_browser_client.h b/atom/browser/atom_browser_client.h index 6aebc3128a48..c8a26da7099f 100644 --- a/atom/browser/atom_browser_client.h +++ b/atom/browser/atom_browser_client.h @@ -11,6 +11,11 @@ namespace content { class QuotaPermissionContext; +class ClientCertificateDelegate; +} + +namespace net { +class SSLCertRequestInfo; } namespace atom { @@ -41,6 +46,10 @@ class AtomBrowserClient : public brightray::BrowserClient { int child_process_id) override; void DidCreatePpapiPlugin(content::BrowserPpapiHost* browser_host) override; content::QuotaPermissionContext* CreateQuotaPermissionContext() override; + void SelectClientCertificate( + content::WebContents* web_contents, + net::SSLCertRequestInfo* cert_request_info, + scoped_ptr delegate) override; private: brightray::BrowserMainParts* OverrideCreateBrowserMainParts( diff --git a/atom/common/options_switches.cc b/atom/common/options_switches.cc index c9997996fed8..2764f86a5fcf 100644 --- a/atom/common/options_switches.cc +++ b/atom/common/options_switches.cc @@ -87,6 +87,9 @@ const char kDisableAutoHideCursor[] = "disable-auto-hide-cursor"; // Use the OS X's standard window instead of the textured window. const char kStandardWindow[] = "standard-window"; +// Path to client certificate. +const char kClientCertificate[] = "client-certificate"; + // Web runtime features. const char kExperimentalFeatures[] = "experimental-features"; const char kExperimentalCanvasFeatures[] = "experimental-canvas-features"; diff --git a/atom/common/options_switches.h b/atom/common/options_switches.h index 071459afac73..e6d85063341a 100644 --- a/atom/common/options_switches.h +++ b/atom/common/options_switches.h @@ -45,6 +45,7 @@ extern const char kTransparent[]; extern const char kType[]; extern const char kDisableAutoHideCursor[]; extern const char kStandardWindow[]; +extern const char kClientCertificate[]; extern const char kExperimentalFeatures[]; extern const char kExperimentalCanvasFeatures[]; diff --git a/docs/api/chrome-command-line-switches.md b/docs/api/chrome-command-line-switches.md index 316211e4db0c..37b0e6fbca54 100644 --- a/docs/api/chrome-command-line-switches.md +++ b/docs/api/chrome-command-line-switches.md @@ -14,6 +14,10 @@ app.on('ready', function() { }); ``` +## --client-certificate + +Path to client certificate file. + ## --disable-http-cache Disables the disk cache for HTTP requests. From 16c08e7e374718be487f566d557c2bdb1ba356ea Mon Sep 17 00:00:00 2001 From: Seppe Stas Date: Mon, 8 Jun 2015 19:04:56 +0200 Subject: [PATCH 0192/1293] Switched to `gfx::Rect` constructor that takes a RECT As per @zcbenz's suggestion the rect passed to the click event handler now passes a rect constructed using `gfx::Rect(const RECT& r)`. --- atom/browser/ui/win/notify_icon.cc | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/atom/browser/ui/win/notify_icon.cc b/atom/browser/ui/win/notify_icon.cc index d319539823cc..473a2bcac8d4 100644 --- a/atom/browser/ui/win/notify_icon.cc +++ b/atom/browser/ui/win/notify_icon.cc @@ -58,9 +58,7 @@ void NotifyIcon::HandleClickEvent(const gfx::Point& cursor_pos, RECT rect; Shell_NotifyIconGetRect(&icon_id, &rect); - int width = rect.right - rect.left; - int height = rect.bottom - rect.top; - NotifyClicked(gfx::Rect(rect.left, rect.top, width, height)); + NotifyClicked(gfx::Rect(rect)); return; } From cac97cca0da04513edd33614af910b803b1a39cb Mon Sep 17 00:00:00 2001 From: Seppe Stas Date: Mon, 8 Jun 2015 19:07:46 +0200 Subject: [PATCH 0193/1293] Initialized rect with zeros As per @zcbenz 's remark: The rect should be initialized with zeros to prevent random values being passed to the click event handler when `Shell_NotifyIconGetRect` fails. --- atom/browser/ui/win/notify_icon.cc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/atom/browser/ui/win/notify_icon.cc b/atom/browser/ui/win/notify_icon.cc index 473a2bcac8d4..955a047fe1f5 100644 --- a/atom/browser/ui/win/notify_icon.cc +++ b/atom/browser/ui/win/notify_icon.cc @@ -55,7 +55,7 @@ void NotifyIcon::HandleClickEvent(const gfx::Point& cursor_pos, icon_id.hWnd = window_; icon_id.cbSize = sizeof(NOTIFYICONIDENTIFIER); - RECT rect; + RECT rect = { 0 }; Shell_NotifyIconGetRect(&icon_id, &rect); NotifyClicked(gfx::Rect(rect)); From 47cb06e20169fdbb7f4c3b0578235f3e813b047b Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 9 Jun 2015 09:52:11 +0800 Subject: [PATCH 0194/1293] Update brightray for --log-net-log --- vendor/brightray | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/brightray b/vendor/brightray index 20af087dd3ba..ae06dded48b7 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit 20af087dd3ba01b601f8ad176899610c9479b382 +Subproject commit ae06dded48b7f08d47bb29c798d3cdfd64aa6a81 From d4e4c6ca15fddca0cc75ef1065845bc5ff5190b0 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 9 Jun 2015 09:56:19 +0800 Subject: [PATCH 0195/1293] docs: Update formats of command line switches --- docs/api/chrome-command-line-switches.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/api/chrome-command-line-switches.md b/docs/api/chrome-command-line-switches.md index 316211e4db0c..2ea1a29fb86f 100644 --- a/docs/api/chrome-command-line-switches.md +++ b/docs/api/chrome-command-line-switches.md @@ -60,19 +60,19 @@ Like `--host-rules` but these `rules` only apply to the host resolver. ## --ignore-certificate-errors -Ignore certificate related errors. +Ignores certificate related errors. -## --ppapi-flash-path +## --ppapi-flash-path=`path` -Set path to pepper flash plugin for use. +Sets `path` of pepper flash plugin. -## --ppapi-flash-version +## --ppapi-flash-version=`version` -Set the pepper flash version. +Sets `version` of pepper flash plugin. -## --log-net-log +## --log-net-log=`path` -Set the path to net log file. +Enables saving net log events and writes them to `path`. ## --v=`log_level` From 994be9cdabbfa1fdea148643dfa0d6e16ed2c531 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Sat, 6 Jun 2015 17:51:27 +0800 Subject: [PATCH 0196/1293] :memo: Add missing `httpreferer` option doc. --- docs/api/browser-window.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index ab7766981dc9..67d31f27bd99 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -571,9 +571,9 @@ Calling `window.print()` in web page is equivalent to call doesn't need print feature, you can safely remove `pdf.dll` in saving binary size. -### BrowserWindow.loadUrl(url) +### BrowserWindow.loadUrl(url, [options]) -Same with `webContents.loadUrl(url)`. +Same with `webContents.loadUrl(url, [options])`. ### BrowserWindow.reload() @@ -778,9 +778,11 @@ Emitted when a plugin process is crashed. Emitted when the WebContents is destroyed. -### WebContents.loadUrl(url) +### WebContents.loadUrl(url, [options]) * `url` URL +* `options` URL + * `httpreferrer` String - A HTTP Referer url Loads the `url` in the window, the `url` must contains the protocol prefix, e.g. the `http://` or `file://`. From bf1765f941f60eeae4f14bd4c344e063176516d0 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Mon, 8 Jun 2015 14:29:30 +0800 Subject: [PATCH 0197/1293] :memo: Add missing `useragent` doc. --- docs/api/browser-window.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 67d31f27bd99..768200dc5e40 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -783,6 +783,7 @@ Emitted when the WebContents is destroyed. * `url` URL * `options` URL * `httpreferrer` String - A HTTP Referer url + * `useragent` String - A user agent originating the request Loads the `url` in the window, the `url` must contains the protocol prefix, e.g. the `http://` or `file://`. From 488801e2447481aea9affda152a5965244bf1aca Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Tue, 9 Jun 2015 09:27:57 +0800 Subject: [PATCH 0198/1293] Rename httpreferrer to httpReferrer, useragent to userAgent. --- atom/browser/api/atom_api_web_contents.cc | 4 ++-- docs/api/browser-window.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 3d925b839918..848b243f317e 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -430,12 +430,12 @@ void WebContents::LoadURL(const GURL& url, const mate::Dictionary& options) { content::NavigationController::LoadURLParams params(url); GURL http_referrer; - if (options.Get("httpreferrer", &http_referrer)) + if (options.Get("httpReferrer", &http_referrer)) params.referrer = content::Referrer(http_referrer.GetAsReferrer(), blink::WebReferrerPolicyDefault); std::string user_agent; - if (options.Get("useragent", &user_agent)) + if (options.Get("userAgent", &user_agent)) SetUserAgent(user_agent); params.transition_type = ui::PAGE_TRANSITION_TYPED; diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 768200dc5e40..e60a7d227995 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -782,8 +782,8 @@ Emitted when the WebContents is destroyed. * `url` URL * `options` URL - * `httpreferrer` String - A HTTP Referer url - * `useragent` String - A user agent originating the request + * `httpReferrer` String - A HTTP Referer url + * `userAgent` String - A user agent originating the request Loads the `url` in the window, the `url` must contains the protocol prefix, e.g. the `http://` or `file://`. From f1a8c5a1ca63a64803e16be07e99ade68982cf7e Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Tue, 9 Jun 2015 10:44:06 +0800 Subject: [PATCH 0199/1293] Use httpReferrer and userAgent new names in webview. --- atom/browser/lib/guest-view-manager.coffee | 4 ++-- atom/renderer/lib/web-view/web-view-attributes.coffee | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/atom/browser/lib/guest-view-manager.coffee b/atom/browser/lib/guest-view-manager.coffee index 6e3447eece3e..43624b891c88 100644 --- a/atom/browser/lib/guest-view-manager.coffee +++ b/atom/browser/lib/guest-view-manager.coffee @@ -68,8 +68,8 @@ createGuest = (embedder, params) -> if params.src opts = {} - opts.httpreferrer = params.httpreferrer if params.httpreferrer - opts.useragent = params.useragent if params.useragent + opts.httpReferrer = params.httpreferrer if params.httpreferrer + opts.userAgent = params.useragent if params.useragent @loadUrl params.src, opts if params.allowtransparency? diff --git a/atom/renderer/lib/web-view/web-view-attributes.coffee b/atom/renderer/lib/web-view/web-view-attributes.coffee index 37002aefc4b7..82229aae57b1 100644 --- a/atom/renderer/lib/web-view/web-view-attributes.coffee +++ b/atom/renderer/lib/web-view/web-view-attributes.coffee @@ -171,10 +171,10 @@ class SrcAttribute extends WebViewAttribute # Navigate to |this.src|. opts = {} httpreferrer = @webViewImpl.attributes[webViewConstants.ATTRIBUTE_HTTPREFERRER].getValue() - if httpreferrer then opts.httpreferrer = httpreferrer + if httpreferrer then opts.httpReferrer = httpreferrer useragent = @webViewImpl.attributes[webViewConstants.ATTRIBUTE_USERAGENT].getValue() - if useragent then opts.useragent = useragent + if useragent then opts.userAgent = useragent guestContents = remote.getGuestWebContents(@webViewImpl.guestInstanceId) guestContents.loadUrl @getValue(), opts From f8c6056eecf3c343ebdb5a9cb86499db1d1087bf Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 9 Jun 2015 11:09:41 +0800 Subject: [PATCH 0200/1293] Upgrade brightray, fix #1901 --- vendor/brightray | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/brightray b/vendor/brightray index ae06dded48b7..1cba3a459e96 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit ae06dded48b7f08d47bb29c798d3cdfd64aa6a81 +Subproject commit 1cba3a459e9629916655c98716b32ccd1869ef56 From 64e84b8f6ab125549fd00f5d015233da1e9493b9 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Fri, 5 Jun 2015 13:24:47 +0800 Subject: [PATCH 0201/1293] Support multiple-line headers in web-contents `did-get-response-details' event. --- atom/browser/api/atom_api_web_contents.cc | 20 +++++++++++++++---- .../native_mate_converters/value_converter.cc | 7 +++++++ .../native_mate_converters/value_converter.h | 4 +++- 3 files changed, 26 insertions(+), 5 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index e06d2b2419b3..86648220ab9d 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -345,15 +345,27 @@ void WebContents::DidGetResourceResponseStart( v8::Isolate* isolate = v8::Isolate::GetCurrent(); v8::Locker locker(isolate); v8::HandleScope handle_scope(isolate); - mate::Dictionary response_headers(isolate, v8::Object::New(isolate)); + base::DictionaryValue response_headers; net::HttpResponseHeaders* headers = details.headers.get(); + if (!headers) + return; void* iter = nullptr; std::string key; std::string value; - while (headers && headers->EnumerateHeaderLines(&iter, &key, &value)) - response_headers.Set(base::StringToLowerASCII(key), - base::StringToLowerASCII(value)); + while (headers->EnumerateHeaderLines(&iter, &key, &value)) { + key = base::StringToLowerASCII(key); + value = base::StringToLowerASCII(value); + if (response_headers.HasKey(key)) { + base::ListValue* values = nullptr; + if (response_headers.GetList(key, &values)) + values->AppendString(value); + } else { + scoped_ptr values(new base::ListValue()); + values->AppendString(value); + response_headers.Set(key, values.Pass()); + } + } Emit("did-get-response-details", details.socket_address.IsEmpty(), diff --git a/atom/common/native_mate_converters/value_converter.cc b/atom/common/native_mate_converters/value_converter.cc index 815ba0ebb211..c9c1a861ba26 100644 --- a/atom/common/native_mate_converters/value_converter.cc +++ b/atom/common/native_mate_converters/value_converter.cc @@ -23,6 +23,13 @@ bool Converter::FromV8(v8::Isolate* isolate, } } +v8::Local Converter::ToV8( + v8::Isolate* isolate, + const base::DictionaryValue& val) { + scoped_ptr converter(new atom::V8ValueConverter); + return converter->ToV8Value(&val, isolate->GetCurrentContext()); +} + bool Converter::FromV8(v8::Isolate* isolate, v8::Local val, base::ListValue* out) { diff --git a/atom/common/native_mate_converters/value_converter.h b/atom/common/native_mate_converters/value_converter.h index bb0ef66e719b..013dd99cc798 100644 --- a/atom/common/native_mate_converters/value_converter.h +++ b/atom/common/native_mate_converters/value_converter.h @@ -19,6 +19,8 @@ struct Converter { static bool FromV8(v8::Isolate* isolate, v8::Local val, base::DictionaryValue* out); + static v8::Local ToV8(v8::Isolate* isolate, + const base::DictionaryValue& val); }; template<> @@ -27,7 +29,7 @@ struct Converter { v8::Local val, base::ListValue* out); static v8::Local ToV8(v8::Isolate* isolate, - const base::ListValue& val); + const base::ListValue& val); }; } // namespace mate From 52b2c0d27f7c050f8b032e5173c167d617cf393f Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Mon, 8 Jun 2015 21:35:32 +0530 Subject: [PATCH 0202/1293] default to first certificate from cert store --- atom/browser/atom_browser_client.cc | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/atom/browser/atom_browser_client.cc b/atom/browser/atom_browser_client.cc index 2d5db4d17d13..d0f2df2122cd 100644 --- a/atom/browser/atom_browser_client.cc +++ b/atom/browser/atom_browser_client.cc @@ -217,12 +217,19 @@ void AtomBrowserClient::SelectClientCertificate( auto cert_path = command_line->GetSwitchValueNative( switches::kClientCertificate); - if (cert_path.empty()) - return; + // TODO(zcbenz): allow users to select certificate from + // client_cert list. Right now defaults to first certificate + // in the list. + scoped_refptr certificate; + if (cert_path.empty()) { + if (!cert_request_info->client_certs.empty()) + certificate = cert_request_info->client_certs[0]; + } else { + certificate = ImportCertFromFile(base::FilePath(cert_path)); + } - scoped_refptr certificate = - ImportCertFromFile(base::FilePath(cert_path)); - delegate->ContinueWithCertificate(certificate.get()); + if (certificate.get()) + delegate->ContinueWithCertificate(certificate.get()); } brightray::BrowserMainParts* AtomBrowserClient::OverrideCreateBrowserMainParts( From 5459137d3d41e73935ff0ac617e8c09adb94d1d7 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 9 Jun 2015 15:40:04 +0800 Subject: [PATCH 0203/1293] Remove unused options for WebContents.create --- atom/browser/api/atom_api_web_contents.cc | 8 +------- atom/browser/api/atom_api_web_contents.h | 3 --- atom/browser/lib/guest-view-manager.coffee | 4 +--- 3 files changed, 2 insertions(+), 13 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 3d3cc78510a6..9e1747b29e24 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -117,7 +117,6 @@ WebContents::WebContents(brightray::InspectableWebContents* web_contents) WebContents::WebContents(content::WebContents* web_contents) : CommonWebContentsDelegate(false), content::WebContentsObserver(web_contents), - guest_instance_id_(-1), guest_opaque_(true), guest_host_(nullptr), auto_size_enabled_(false), @@ -127,21 +126,16 @@ WebContents::WebContents(content::WebContents* web_contents) WebContents::WebContents(const mate::Dictionary& options) : CommonWebContentsDelegate(true), - guest_instance_id_(-1), guest_opaque_(true), guest_host_(nullptr), auto_size_enabled_(false), is_full_page_plugin_(false) { - options.Get("guestInstanceId", &guest_instance_id_); - auto browser_context = AtomBrowserContext::Get(); content::SiteInstance* site_instance = content::SiteInstance::CreateForURL( browser_context, GURL("chrome-guest://fake-host")); content::WebContents::CreateParams params(browser_context, site_instance); - bool is_guest; - if (options.Get("isGuest", &is_guest) && is_guest) - params.guest_delegate = this; + params.guest_delegate = this; auto web_contents = content::WebContents::Create(params); InitWithWebContents(web_contents, GetWindowFromGuest(web_contents)); diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index 58059d9e9262..9e3016f5da8e 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -228,9 +228,6 @@ class WebContents : public mate::EventEmitter, // Returns the default size of the guestview. gfx::Size GetDefaultSize() const; - // Unique ID for a guest WebContents. - int guest_instance_id_; - // Stores whether the contents of the guest can be transparent. bool guest_opaque_; diff --git a/atom/browser/lib/guest-view-manager.coffee b/atom/browser/lib/guest-view-manager.coffee index 43624b891c88..ec1352304649 100644 --- a/atom/browser/lib/guest-view-manager.coffee +++ b/atom/browser/lib/guest-view-manager.coffee @@ -38,9 +38,7 @@ createGuest = (embedder, params) -> webViewManager ?= process.atomBinding 'web_view_manager' id = getNextInstanceId embedder - guest = webContents.create - isGuest: true - guestInstanceId: id + guest = webContents.create() guestInstances[id] = {guest, embedder} # Destroy guest when the embedder is gone or navigated. From 9f0ac13edc4e4b020dd3f2c8b03c73075ad0ac95 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 9 Jun 2015 15:50:20 +0800 Subject: [PATCH 0204/1293] Pass embedder when creating WebContents --- atom/browser/api/atom_api_web_contents.cc | 19 +++++++------------ atom/browser/lib/guest-view-manager.coffee | 2 +- 2 files changed, 8 insertions(+), 13 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 9e1747b29e24..029c098a8daa 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -9,7 +9,6 @@ #include "atom/browser/atom_browser_client.h" #include "atom/browser/atom_browser_context.h" #include "atom/browser/native_window.h" -#include "atom/browser/web_view_manager.h" #include "atom/common/api/api_messages.h" #include "atom/common/native_mate_converters/gfx_converter.h" #include "atom/common/native_mate_converters/gurl_converter.h" @@ -83,15 +82,6 @@ v8::Persistent template_; using WrapWebContentsCallback = base::Callback)>; WrapWebContentsCallback g_wrap_web_contents; -// Get the window that has the |guest| embedded. -NativeWindow* GetWindowFromGuest(const content::WebContents* guest) { - WebViewManager::WebViewInfo info; - if (WebViewManager::GetInfoForWebContents(guest, &info)) - return NativeWindow::FromWebContents(info.embedder); - else - return nullptr; -} - content::ServiceWorkerContext* GetServiceWorkerContext( const content::WebContents* web_contents) { auto context = web_contents->GetBrowserContext(); @@ -136,9 +126,14 @@ WebContents::WebContents(const mate::Dictionary& options) content::WebContents::CreateParams params(browser_context, site_instance); params.guest_delegate = this; - auto web_contents = content::WebContents::Create(params); - InitWithWebContents(web_contents, GetWindowFromGuest(web_contents)); + + NativeWindow* owner_window = nullptr; + WebContents* embedder = nullptr; + if (options.Get("embedder", &embedder) && embedder) + owner_window = NativeWindow::FromWebContents(embedder->web_contents()); + + InitWithWebContents(web_contents, owner_window); inspectable_web_contents_ = managed_web_contents(); Observe(GetWebContents()); diff --git a/atom/browser/lib/guest-view-manager.coffee b/atom/browser/lib/guest-view-manager.coffee index ec1352304649..ea6be5547dde 100644 --- a/atom/browser/lib/guest-view-manager.coffee +++ b/atom/browser/lib/guest-view-manager.coffee @@ -38,7 +38,7 @@ createGuest = (embedder, params) -> webViewManager ?= process.atomBinding 'web_view_manager' id = getNextInstanceId embedder - guest = webContents.create() + guest = webContents.create {embedder} guestInstances[id] = {guest, embedder} # Destroy guest when the embedder is gone or navigated. From 719f68a44b0b97ab7370c96cf034a0e8b84d1a1f Mon Sep 17 00:00:00 2001 From: Tim Ruffles Date: Tue, 9 Jun 2015 10:29:47 +0100 Subject: [PATCH 0205/1293] doc on how to test with your application --- docs/tutorial/using-selenium-and-webdriver.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/tutorial/using-selenium-and-webdriver.md b/docs/tutorial/using-selenium-and-webdriver.md index 9a0f6b8116a9..cda69c0d6184 100644 --- a/docs/tutorial/using-selenium-and-webdriver.md +++ b/docs/tutorial/using-selenium-and-webdriver.md @@ -70,4 +70,10 @@ driver.wait(function() { driver.quit(); ``` +## Workflow + +To test your application without rebuilding Electron, simply [place](https://github.com/atom/electron/blob/master/docs/tutorial/application-distribution.md) your app source into Electron's resource directory. + [chrome-driver]: https://sites.google.com/a/chromium.org/chromedriver/ + + From 13b6ed6dc527e765267adf9b9477df728c0a650e Mon Sep 17 00:00:00 2001 From: Thomas Tuts Date: Tue, 9 Jun 2015 16:49:21 +0200 Subject: [PATCH 0206/1293] Fix several typos and grammar errors --- docs/api/browser-window.md | 2 +- docs/api/frameless-window.md | 2 +- docs/api/global-shortcut.md | 2 +- docs/tutorial/application-distribution.md | 2 +- docs/tutorial/desktop-environment-integration.md | 4 ++-- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index e60a7d227995..858877ebc8a8 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -753,7 +753,7 @@ Calling `event.preventDefault()` can prevent creating new windows. Emitted when user or the page wants to start an navigation, it can happen when `window.location` object is changed or user clicks a link in the page. -This event will not emit when the navigation is started programmely with APIs +This event will not emit when the navigation is started programmatically with APIs like `WebContents.loadUrl` and `WebContents.back`. Calling `event.preventDefault()` can prevent the navigation. diff --git a/docs/api/frameless-window.md b/docs/api/frameless-window.md index fe3b33388d9b..498a65b225db 100644 --- a/docs/api/frameless-window.md +++ b/docs/api/frameless-window.md @@ -28,7 +28,7 @@ var win = new BrowserWindow({ transparent: true, frame: false }); API to set window shape to solve this, but currently blocked at an [upstream bug](https://code.google.com/p/chromium/issues/detail?id=387234). * Transparent window is not resizable, setting `resizable` to `true` may make - transprent window stop working on some platforms. + transparent window stop working on some platforms. * The `blur` filter only applies to the web page, so there is no way to apply blur effect to the content below the window. * On Windows transparent window will not work when DWM is disabled. diff --git a/docs/api/global-shortcut.md b/docs/api/global-shortcut.md index 2d27398aae4b..e48519b96e72 100644 --- a/docs/api/global-shortcut.md +++ b/docs/api/global-shortcut.md @@ -10,7 +10,7 @@ var globalShortcut = require('global-shortcut'); // Register a 'ctrl+x' shortcut listener. var ret = globalShortcut.register('ctrl+x', function() { console.log('ctrl+x is pressed'); }) if (!ret) - console.log('registerion fails'); + console.log('registration failed'); // Check whether a shortcut is registered. console.log(globalShortcut.isRegistered('ctrl+x')); diff --git a/docs/tutorial/application-distribution.md b/docs/tutorial/application-distribution.md index 5c76f14d504a..c96a53bcbeee 100644 --- a/docs/tutorial/application-distribution.md +++ b/docs/tutorial/application-distribution.md @@ -35,7 +35,7 @@ exposing your app's source code to users. To use an `asar` archive to replace the `app` folder, you need to rename the archive to `app.asar`, and put it under Electron's resources directory like -bellow, and Electron will then try read the archive and start from it. +below, and Electron will then try read the archive and start from it. On OS X: diff --git a/docs/tutorial/desktop-environment-integration.md b/docs/tutorial/desktop-environment-integration.md index 3f65df234dfe..b67b252f4d5b 100644 --- a/docs/tutorial/desktop-environment-integration.md +++ b/docs/tutorial/desktop-environment-integration.md @@ -149,8 +149,8 @@ On Windows, a taskbar button can be used to display a progress bar. This enables a window to provide progress information to the user without that user having to switch to the window itself. -The Unity DE also has a simililar feature that allows you to specify progress -bar in the lancher. +The Unity DE also has a similar feature that allows you to specify the progress +bar in the launcher. __Progress bar in taskbar button:__ From 8893c9502aaedd08e80f488cd73d467e62768864 Mon Sep 17 00:00:00 2001 From: Thomas Tuts Date: Tue, 9 Jun 2015 16:49:44 +0200 Subject: [PATCH 0207/1293] Use consistent naming convention for 'task bar' concept --- docs/api/browser-window.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 858877ebc8a8..ca2638b6bb80 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -43,7 +43,7 @@ You can also create a window without chrome by using other windows * `fullscreen` Boolean - Whether the window should show in fullscreen, when set to `false` the fullscreen button would also be hidden on OS X - * `skip-taskbar` Boolean - Do not show window in Taskbar + * `skip-taskbar` Boolean - Do not show window in taskbar * `zoom-factor` Number - The default zoom factor of the page, zoom factor is zoom percent / 100, so `3.0` represents `300%` * `kiosk` Boolean - The kiosk mode @@ -464,7 +464,7 @@ Starts or stops flashing the window to attract user's attention. * `skip` Boolean -Makes the window do not show in Taskbar. +Makes the window not show in the taskbar. ### BrowserWindow.setKiosk(flag) @@ -604,12 +604,12 @@ it will assume `app.getName().desktop`. ### BrowserWindow.setOverlayIcon(overlay, description) * `overlay` [NativeImage](native-image.md) - the icon to display on the bottom -right corner of the Taskbar icon. If this parameter is `null`, the overlay is +right corner of the taskbar icon. If this parameter is `null`, the overlay is cleared * `description` String - a description that will be provided to Accessibility screen readers -Sets a 16px overlay onto the current Taskbar icon, usually used to convey some sort of application status or to passively notify the user. +Sets a 16px overlay onto the current taskbar icon, usually used to convey some sort of application status or to passively notify the user. __Note:__ This API is only available on Windows, Win7 or above From 6494ed6b13d96c4417d48e1afa08bed332c80be0 Mon Sep 17 00:00:00 2001 From: Thomas Tuts Date: Tue, 9 Jun 2015 16:51:54 +0200 Subject: [PATCH 0208/1293] Make platform compatibility notes consistent --- docs/api/browser-window.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index ca2638b6bb80..6358e15e1c18 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -483,13 +483,13 @@ Returns whether the window is in kiosk mode. Sets the pathname of the file the window represents, and the icon of the file will show in window's title bar. -__Note__: This API is available only on OS X. +__Note__: This API is only available on OS X. ### BrowserWindow.getRepresentedFilename() Returns the pathname of the file the window represents. -__Note__: This API is available only on OS X. +__Note__: This API is only available on OS X. ### BrowserWindow.setDocumentEdited(edited) @@ -498,13 +498,13 @@ __Note__: This API is available only on OS X. Specifies whether the window’s document has been edited, and the icon in title bar will become grey when set to `true`. -__Note__: This API is available only on OS X. +__Note__: This API is only available on OS X. ### BrowserWindow.IsDocumentEdited() Whether the window's document has been edited. -__Note__: This API is available only on OS X. +__Note__: This API is only available on OS X. ### BrowserWindow.openDevTools([options]) @@ -611,13 +611,13 @@ screen readers Sets a 16px overlay onto the current taskbar icon, usually used to convey some sort of application status or to passively notify the user. -__Note:__ This API is only available on Windows, Win7 or above +__Note:__ This API is only available on Windows (Windows 7 and above) ### BrowserWindow.showDefinitionForSelection() Shows pop-up dictionary that searches the selected word on the page. -__Note__: This API is available only on OS X. +__Note__: This API is only available on OS X. ### BrowserWindow.setAutoHideMenuBar(hide) From ab98dcd7cf30f80135f997a131c0562dbb656f08 Mon Sep 17 00:00:00 2001 From: Thomas Tuts Date: Tue, 9 Jun 2015 16:56:45 +0200 Subject: [PATCH 0209/1293] Try to clarify docs for window.onbeforeunload() --- docs/api/browser-window.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 6358e15e1c18..4211ac8020fd 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -131,9 +131,9 @@ window.onbeforeunload = function(e) { console.log('I do not want to be closed'); // Unlike usual browsers, in which a string should be returned and the user is - // prompted to confirm the page unload. Electron gives the power completely - // to the developers, return empty string or false would prevent the unloading - // now. You can also use the dialog API to let user confirm it. + // prompted to confirm the page unload, Electron gives developers more options. + // Returning empty string or false would prevent the unloading now. + // You can also use the dialog API to let the user confirm closing the application. return false; }; ``` From 29abfa68e91c36465441cff0a5d0b08e5ed2376e Mon Sep 17 00:00:00 2001 From: Thomas Tuts Date: Tue, 9 Jun 2015 16:59:14 +0200 Subject: [PATCH 0210/1293] Fix grammar and JS example for Chrome command line switches docs --- docs/api/chrome-command-line-switches.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/api/chrome-command-line-switches.md b/docs/api/chrome-command-line-switches.md index 2ea1a29fb86f..84057129bc5c 100644 --- a/docs/api/chrome-command-line-switches.md +++ b/docs/api/chrome-command-line-switches.md @@ -1,6 +1,6 @@ # Supported Chrome command line switches -Following command lines switches in Chrome browser are also Supported in +The following command lines switches in Chrome browser are also supported in Electron, you can use [app.commandLine.appendSwitch][append-switch] to append them in your app's main script before the [ready][ready] event of [app][app] module is emitted: @@ -11,6 +11,7 @@ app.commandLine.appendSwitch('remote-debugging-port', '8315'); app.commandLine.appendSwitch('host-rules', 'MAP * 127.0.0.1'); app.on('ready', function() { + // Your code here }); ``` From 6d756d9d13c66426562ea1f5c93c9e8c711ff864 Mon Sep 17 00:00:00 2001 From: Thomas Tuts Date: Tue, 9 Jun 2015 17:59:53 +0200 Subject: [PATCH 0211/1293] Remove trailing commas from dialog filters code example --- docs/api/dialog.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/dialog.md b/docs/api/dialog.md index 05b8650a0198..f8058649ae57 100644 --- a/docs/api/dialog.md +++ b/docs/api/dialog.md @@ -36,8 +36,8 @@ selected, an example is: filters: [ { name: 'Images', extensions: ['jpg', 'png', 'gif'] }, { name: 'Movies', extensions: ['mkv', 'avi', 'mp4'] }, - { name: 'Custom File Type', extensions: ['as'] }, - ], + { name: 'Custom File Type', extensions: ['as'] } + ] } ``` From e829a289475366e1a5b9c87e1281333c73837d92 Mon Sep 17 00:00:00 2001 From: Thomas Tuts Date: Tue, 9 Jun 2015 18:01:09 +0200 Subject: [PATCH 0212/1293] Clean up code in global shortcut code example --- docs/api/global-shortcut.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/api/global-shortcut.md b/docs/api/global-shortcut.md index e48519b96e72..871357f89f9f 100644 --- a/docs/api/global-shortcut.md +++ b/docs/api/global-shortcut.md @@ -9,8 +9,10 @@ var globalShortcut = require('global-shortcut'); // Register a 'ctrl+x' shortcut listener. var ret = globalShortcut.register('ctrl+x', function() { console.log('ctrl+x is pressed'); }) -if (!ret) + +if (!ret) { console.log('registration failed'); +} // Check whether a shortcut is registered. console.log(globalShortcut.isRegistered('ctrl+x')); From cf79f439ce625144ede7e422b4b047b1266528e4 Mon Sep 17 00:00:00 2001 From: Thomas Tuts Date: Tue, 9 Jun 2015 18:08:02 +0200 Subject: [PATCH 0213/1293] Remove trailing commas in menu docs --- docs/api/menu.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/api/menu.md b/docs/api/menu.md index 60e37884e352..8da093901d48 100644 --- a/docs/api/menu.md +++ b/docs/api/menu.md @@ -70,7 +70,7 @@ var template = [ label: 'Quit', accelerator: 'Command+Q', click: function() { app.quit(); } - }, + } ] }, { @@ -108,7 +108,7 @@ var template = [ label: 'Select All', accelerator: 'Command+A', selector: 'selectAll:' - }, + } ] }, { @@ -123,7 +123,7 @@ var template = [ label: 'Toggle DevTools', accelerator: 'Alt+Command+I', click: function() { BrowserWindow.getFocusedWindow().toggleDevTools(); } - }, + } ] }, { @@ -145,13 +145,13 @@ var template = [ { label: 'Bring All to Front', selector: 'arrangeInFront:' - }, + } ] }, { label: 'Help', submenu: [] - }, + } ]; menu = Menu.buildFromTemplate(template); From bd1fd9680f43493d564913006d330e89a1404ab5 Mon Sep 17 00:00:00 2001 From: Thomas Tuts Date: Tue, 9 Jun 2015 18:08:27 +0200 Subject: [PATCH 0214/1293] Add missing commas in menu docs --- docs/api/menu.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/api/menu.md b/docs/api/menu.md index 8da093901d48..461bfbb43de4 100644 --- a/docs/api/menu.md +++ b/docs/api/menu.md @@ -281,10 +281,10 @@ Template: ```javascript [ - {label: '4', id: '4'} - {label: '5', id: '5'} - {label: '1', id: '1', position: 'before=4'} - {label: '2', id: '2'} + {label: '4', id: '4'}, + {label: '5', id: '5'}, + {label: '1', id: '1', position: 'before=4'}, + {label: '2', id: '2'}, {label: '3', id: '3'} ] ``` @@ -303,11 +303,11 @@ Template: ```javascript [ - {label: 'a', position: 'endof=letters'} - {label: '1', position: 'endof=numbers'} - {label: 'b', position: 'endof=letters'} - {label: '2', position: 'endof=numbers'} - {label: 'c', position: 'endof=letters'} + {label: 'a', position: 'endof=letters'}, + {label: '1', position: 'endof=numbers'}, + {label: 'b', position: 'endof=letters'}, + {label: '2', position: 'endof=numbers'}, + {label: 'c', position: 'endof=letters'}, {label: '3', position: 'endof=numbers'} ] ``` From 2f4333b852a72558f2401f3a2272a2fd46353481 Mon Sep 17 00:00:00 2001 From: Thomas Tuts Date: Tue, 9 Jun 2015 18:10:02 +0200 Subject: [PATCH 0215/1293] Declare one variable per statement in protocol code example --- docs/api/protocol.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/protocol.md b/docs/api/protocol.md index 65554e052105..181a2e57f733 100644 --- a/docs/api/protocol.md +++ b/docs/api/protocol.md @@ -7,8 +7,8 @@ An example of implementing a protocol that has the same effect with the `file://` protocol: ```javascript -var app = require('app'), - path = require('path'); +var app = require('app'); +var path = require('path'); app.on('ready', function() { var protocol = require('protocol'); From 35dcdfc49239fcd954141b88f8eb3173b545b367 Mon Sep 17 00:00:00 2001 From: Thomas Tuts Date: Tue, 9 Jun 2015 18:11:40 +0200 Subject: [PATCH 0216/1293] Remove trailing comma in tray code example --- docs/api/tray.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/tray.md b/docs/api/tray.md index d85ac1a1dac8..3be241dde9a2 100644 --- a/docs/api/tray.md +++ b/docs/api/tray.md @@ -15,7 +15,7 @@ app.on('ready', function(){ { label: 'Item1', type: 'radio' }, { label: 'Item2', type: 'radio' }, { label: 'Item3', type: 'radio', checked: true }, - { label: 'Item4', type: 'radio' }, + { label: 'Item4', type: 'radio' } ]); appIcon.setToolTip('This is my application.'); appIcon.setContextMenu(contextMenu); From a84e6227efd0beb3b5d9de0c287cace0839ddec0 Mon Sep 17 00:00:00 2001 From: Thomas Tuts Date: Tue, 9 Jun 2015 18:12:34 +0200 Subject: [PATCH 0217/1293] Remove obsolete space in console log when using multiple arguments --- docs/api/web-view-tag.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/web-view-tag.md b/docs/api/web-view-tag.md index 705014cf6a18..1198f212e25f 100644 --- a/docs/api/web-view-tag.md +++ b/docs/api/web-view-tag.md @@ -390,7 +390,7 @@ without regard for log level or other properties. ```javascript webview.addEventListener('console-message', function(e) { - console.log('Guest page logged a message: ', e.message); + console.log('Guest page logged a message:', e.message); }); ``` From 9199d0df0af8078dda7ff929860f7580565a8752 Mon Sep 17 00:00:00 2001 From: Thomas Tuts Date: Tue, 9 Jun 2015 18:14:06 +0200 Subject: [PATCH 0218/1293] Add missing semicolon in webview tag documentation --- docs/api/web-view-tag.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/web-view-tag.md b/docs/api/web-view-tag.md index 1198f212e25f..cbbd6205c391 100644 --- a/docs/api/web-view-tag.md +++ b/docs/api/web-view-tag.md @@ -448,7 +448,7 @@ webview.send('ping'); var ipc = require('ipc'); ipc.on('ping', function() { ipc.sendToHost('pong'); -}) +}); ``` ### crashed From b4790a753133fce66a430f4d1613d4ca05674988 Mon Sep 17 00:00:00 2001 From: Thomas Tuts Date: Tue, 9 Jun 2015 18:15:30 +0200 Subject: [PATCH 0219/1293] Remove trailing commas in desktop environment docs --- docs/tutorial/desktop-environment-integration.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/tutorial/desktop-environment-integration.md b/docs/tutorial/desktop-environment-integration.md index b67b252f4d5b..5dee6fdf4ec3 100644 --- a/docs/tutorial/desktop-environment-integration.md +++ b/docs/tutorial/desktop-environment-integration.md @@ -70,9 +70,9 @@ var dockMenu = Menu.buildFromTemplate([ { label: 'New Window', click: function() { console.log('New Window'); } }, { label: 'New Window with Settings', submenu: [ { label: 'Basic' }, - { label: 'Pro'}, + { label: 'Pro'} ]}, - { label: 'New Command...'}, + { label: 'New Command...'} ]); app.dock.setMenu(dockMenu); ``` @@ -119,7 +119,7 @@ app.setUserTasks([ iconPath: process.execPath, iconIndex: 0, title: 'New Window', - description: 'Create a new window', + description: 'Create a new window' } ]); ``` From a6a5d50c3fd3a686b9b385b826547f4d8542be3e Mon Sep 17 00:00:00 2001 From: Thomas Tuts Date: Tue, 9 Jun 2015 18:15:54 +0200 Subject: [PATCH 0220/1293] Add missing semicolons in devtools extension docs --- docs/tutorial/devtools-extension.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/tutorial/devtools-extension.md b/docs/tutorial/devtools-extension.md index e93013d6ed19..731de4e13f8b 100644 --- a/docs/tutorial/devtools-extension.md +++ b/docs/tutorial/devtools-extension.md @@ -20,14 +20,14 @@ Then you can load the extension in Electron by opening devtools in any window, and then running the following code in the devtools console: ```javascript -require('remote').require('browser-window').addDevToolsExtension('/some-directory/react-devtools') +require('remote').require('browser-window').addDevToolsExtension('/some-directory/react-devtools'); ``` To unload the extension, you can call `BrowserWindow.removeDevToolsExtension` API with its name and it will not load the next time you open the devtools: ```javascript -require('remote').require('browser-window').removeDevToolsExtension('React Developer Tools') +require('remote').require('browser-window').removeDevToolsExtension('React Developer Tools'); ``` ## Format of devtools extension From 464263067403f9607f2f1218a5bf5ad6d0a272ae Mon Sep 17 00:00:00 2001 From: Thomas Tuts Date: Tue, 9 Jun 2015 18:17:12 +0200 Subject: [PATCH 0221/1293] Replace shorthand if-statement notation in quick start docs --- docs/tutorial/quick-start.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/tutorial/quick-start.md b/docs/tutorial/quick-start.md index 073d2ee40c95..644793f62378 100644 --- a/docs/tutorial/quick-start.md +++ b/docs/tutorial/quick-start.md @@ -82,8 +82,9 @@ var mainWindow = null; // Quit when all windows are closed. app.on('window-all-closed', function() { - if (process.platform != 'darwin') + if (process.platform != 'darwin') { app.quit(); + } }); // This method will be called when Electron has done everything From c78a3ff7149e48f3506a4b4f316fbaabbca1960d Mon Sep 17 00:00:00 2001 From: Thomas Tuts Date: Tue, 9 Jun 2015 18:17:38 +0200 Subject: [PATCH 0222/1293] Replace shorthand if-statement notation in Pepper Flash docs --- docs/tutorial/using-pepper-flash-plugin.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/tutorial/using-pepper-flash-plugin.md b/docs/tutorial/using-pepper-flash-plugin.md index bbb37862da44..20b29c4114a9 100644 --- a/docs/tutorial/using-pepper-flash-plugin.md +++ b/docs/tutorial/using-pepper-flash-plugin.md @@ -23,8 +23,9 @@ var mainWindow = null; // Quit when all windows are closed. app.on('window-all-closed', function() { - if (process.platform != 'darwin') + if (process.platform != 'darwin') { app.quit(); + } }); // Specify flash path. From d8cd9b71b06eb9690de79cb75bfb1fed758568b9 Mon Sep 17 00:00:00 2001 From: Thomas Tuts Date: Tue, 9 Jun 2015 18:18:47 +0200 Subject: [PATCH 0223/1293] Clean up Selenium webdriver code example --- docs/tutorial/using-selenium-and-webdriver.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/tutorial/using-selenium-and-webdriver.md b/docs/tutorial/using-selenium-and-webdriver.md index cda69c0d6184..13934c01b086 100644 --- a/docs/tutorial/using-selenium-and-webdriver.md +++ b/docs/tutorial/using-selenium-and-webdriver.md @@ -49,14 +49,14 @@ and where to find Electron's binary: ```javascript var webdriver = require('selenium-webdriver'); -var driver = new webdriver.Builder(). - // The "9515" is the port opened by chrome driver. - usingServer('http://localhost:9515'). - withCapabilities({chromeOptions: { - // Here is the path to your Electron binary. - binary: '/Path-to-Your-App.app/Contents/MacOS/Atom'}}). - forBrowser('electron'). - build(); +var driver = new webdriver.Builder() + // The "9515" is the port opened by chrome driver. + .usingServer('http://localhost:9515') + .withCapabilities({chromeOptions: { + // Here is the path to your Electron binary. + binary: '/Path-to-Your-App.app/Contents/MacOS/Atom'}}) + .forBrowser('electron') + .build(); driver.get('http://www.google.com'); driver.findElement(webdriver.By.name('q')).sendKeys('webdriver'); From 51dc8ad70a2228aa2a0137e8f98477fd9ff8fc99 Mon Sep 17 00:00:00 2001 From: Alex Warren Date: Tue, 9 Jun 2015 22:08:34 +0100 Subject: [PATCH 0224/1293] Corrections to menu.md --- docs/api/menu.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/api/menu.md b/docs/api/menu.md index 60e37884e352..3623adce86b3 100644 --- a/docs/api/menu.md +++ b/docs/api/menu.md @@ -30,7 +30,9 @@ window.addEventListener('contextmenu', function (e) { Another example of creating the application menu with the simple template API: ```javascript -// main.js + +var remote = require('remote'); +var Menu = remote.require('menu'); var template = [ { label: 'Electron', @@ -69,7 +71,7 @@ var template = [ { label: 'Quit', accelerator: 'Command+Q', - click: function() { app.quit(); } + selector: 'terminate:' }, ] }, @@ -117,12 +119,12 @@ var template = [ { label: 'Reload', accelerator: 'Command+R', - click: function() { BrowserWindow.getFocusedWindow().reloadIgnoringCache(); } + click: function() { remote.getCurrentWindow().reloadIgnoringCache(); } }, { label: 'Toggle DevTools', accelerator: 'Alt+Command+I', - click: function() { BrowserWindow.getFocusedWindow().toggleDevTools(); } + click: function() { remote.getCurrentWindow().toggleDevTools(); } }, ] }, @@ -156,7 +158,7 @@ var template = [ menu = Menu.buildFromTemplate(template); -Menu.setApplicationMenu(menu); // Must be called within app.on('ready', function(){ ... }); +Menu.setApplicationMenu(menu); ``` ## Class: Menu From 78eff673ec4268d9a3802c24d3da2288bc3eaeaf Mon Sep 17 00:00:00 2001 From: Alex Warren Date: Tue, 9 Jun 2015 22:09:23 +0100 Subject: [PATCH 0225/1293] Make consistent with other example --- docs/api/menu.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/api/menu.md b/docs/api/menu.md index 3623adce86b3..351edfc0ebff 100644 --- a/docs/api/menu.md +++ b/docs/api/menu.md @@ -29,8 +29,9 @@ window.addEventListener('contextmenu', function (e) { Another example of creating the application menu with the simple template API: -```javascript +```html + ``` ## Class: Menu From f91a81fe77aa59a75792c8f7bd3b7510acfcd017 Mon Sep 17 00:00:00 2001 From: kirkouimet Date: Tue, 9 Jun 2015 15:56:54 -0700 Subject: [PATCH 0226/1293] Convert std::string path to a FilePath to get compiling working on Windows --- atom/common/crash_reporter/crash_reporter.cc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/atom/common/crash_reporter/crash_reporter.cc b/atom/common/crash_reporter/crash_reporter.cc index 365860b256c7..144542086a1f 100644 --- a/atom/common/crash_reporter/crash_reporter.cc +++ b/atom/common/crash_reporter/crash_reporter.cc @@ -46,7 +46,7 @@ std::vector CrashReporter::GetUploadedReports(const std::string& path) { std::string file_content; std::vector result; - if (base::ReadFileToString(base::FilePath(path), &file_content)) { + if (base::ReadFileToString(base::FilePath::FromUTF8Unsafe(path), &file_content)) { std::vector reports; base::SplitString(file_content, '\n', &reports); for (const std::string& report : reports) { From 0fef09281b27fcb6de9f90d521e549026e79b4c5 Mon Sep 17 00:00:00 2001 From: Kirk Ouimet Date: Tue, 9 Jun 2015 16:17:00 -0700 Subject: [PATCH 0227/1293] Guarding webview attributes against polluted Object.prototypes Ran into an error with the buildParams function breaking when using a JavaScript library that modified the Object.prototype, this small fix resolves the issue. --- atom/renderer/lib/web-view/web-view.coffee | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/atom/renderer/lib/web-view/web-view.coffee b/atom/renderer/lib/web-view/web-view.coffee index da6f55c8fe35..a815dc6499dc 100644 --- a/atom/renderer/lib/web-view/web-view.coffee +++ b/atom/renderer/lib/web-view/web-view.coffee @@ -173,7 +173,7 @@ class WebViewImpl params = instanceId: @viewInstanceId userAgentOverride: @userAgentOverride - for attributeName, attribute of @attributes + for own attributeName, attribute of @attributes params[attributeName] = attribute.getValue() # When the WebView is not participating in layout (display:none) # then getBoundingClientRect() would report a width and height of 0. From 2ee6e43fb3ab861c9db36bf574c8ebec67cd8c6e Mon Sep 17 00:00:00 2001 From: Sam Eaton Date: Tue, 9 Jun 2015 21:51:10 -0600 Subject: [PATCH 0228/1293] adds display:inline-block to style tag The example attempts to change the height of an inline element (webview), which has no effect. The height will now take effect. --- docs/api/web-view-tag.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/web-view-tag.md b/docs/api/web-view-tag.md index 705014cf6a18..842e3428e0a4 100644 --- a/docs/api/web-view-tag.md +++ b/docs/api/web-view-tag.md @@ -18,7 +18,7 @@ form, the `webview` tag includes the `src` of the web page and css styles that control the appearance of the `webview` container: ```html - + ``` If you want to control the guest content in any way, you can write JavaScript From 200a19dad9de3131fd3054b43fd2d94754947c3a Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 9 Jun 2015 18:25:24 +0800 Subject: [PATCH 0229/1293] linux: Don't use clipboard module in renderer process --- atom/common/api/lib/clipboard.coffee | 29 ++++++++++++++++------------ 1 file changed, 17 insertions(+), 12 deletions(-) diff --git a/atom/common/api/lib/clipboard.coffee b/atom/common/api/lib/clipboard.coffee index 44dadb8cd9ee..9a7a6abfa47f 100644 --- a/atom/common/api/lib/clipboard.coffee +++ b/atom/common/api/lib/clipboard.coffee @@ -1,12 +1,17 @@ -binding = process.atomBinding 'clipboard' -module.exports = - availableFormats: (type='standard') -> binding._availableFormats type - has: (format, type='standard') -> binding._has format, type - read: (format, type='standard') -> binding._read format, type - readText: (type='standard') -> binding._readText type - writeText: (text, type='standard') -> binding._writeText text, type - readHtml: (type='standard') -> binding._readHtml type - writeHtml: (markup, type='standard') -> binding._writeHtml markup, type - readImage: (type='standard') -> binding._readImage type - writeImage: (image, type='standard') -> binding._writeImage image, type - clear: (type='standard') -> binding._clear type +if process.platform is 'linux' and process.type is 'renderer' + # On Linux we could not access clipboard in renderer process. + module.exports = require('remote').require 'clipboard' +else + binding = process.atomBinding 'clipboard' + + module.exports = + availableFormats: (type='standard') -> binding._availableFormats type + has: (format, type='standard') -> binding._has format, type + read: (format, type='standard') -> binding._read format, type + readText: (type='standard') -> binding._readText type + writeText: (text, type='standard') -> binding._writeText text, type + readHtml: (type='standard') -> binding._readHtml type + writeHtml: (markup, type='standard') -> binding._writeHtml markup, type + readImage: (type='standard') -> binding._readImage type + writeImage: (image, type='standard') -> binding._writeImage image, type + clear: (type='standard') -> binding._clear type From 4b12a95d370c023e8fbb54b9144b45744ccafdfe Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 9 Jun 2015 17:46:33 +0800 Subject: [PATCH 0230/1293] Transfer Buffer through "remote" --- atom/browser/lib/rpc-server.coffee | 4 ++++ atom/renderer/api/lib/remote.coffee | 3 +++ 2 files changed, 7 insertions(+) diff --git a/atom/browser/lib/rpc-server.coffee b/atom/browser/lib/rpc-server.coffee index 48d00e9bd23b..ab86a0c45518 100644 --- a/atom/browser/lib/rpc-server.coffee +++ b/atom/browser/lib/rpc-server.coffee @@ -7,6 +7,7 @@ v8Util = process.atomBinding 'v8_util' valueToMeta = (sender, value) -> meta = type: typeof value + meta.type = 'buffer' if Buffer.isBuffer value meta.type = 'value' if value is null meta.type = 'array' if Array.isArray value @@ -26,6 +27,8 @@ valueToMeta = (sender, value) -> meta.members = [] meta.members.push {name: prop, type: typeof field} for prop, field of value + else if meta.type is 'buffer' + meta.value = Array::slice.call value, 0 else meta.type = 'value' meta.value = value @@ -43,6 +46,7 @@ unwrapArgs = (sender, args) -> when 'value' then meta.value when 'remote-object' then objectsRegistry.get meta.id when 'array' then unwrapArgs sender, meta.value + when 'buffer' then new Buffer(meta.value) when 'object' ret = v8Util.createObjectWithName meta.name for member in meta.members diff --git a/atom/renderer/api/lib/remote.coffee b/atom/renderer/api/lib/remote.coffee index 569678476587..4c4970f0932f 100644 --- a/atom/renderer/api/lib/remote.coffee +++ b/atom/renderer/api/lib/remote.coffee @@ -10,6 +10,8 @@ wrapArgs = (args) -> valueToMeta = (value) -> if Array.isArray value type: 'array', value: wrapArgs(value) + else if Buffer.isBuffer value + type: 'buffer', value: Array::slice.call(value, 0) else if value? and typeof value is 'object' and v8Util.getHiddenValue value, 'atomId' type: 'remote-object', id: v8Util.getHiddenValue value, 'atomId' else if value? and typeof value is 'object' @@ -30,6 +32,7 @@ metaToValue = (meta) -> switch meta.type when 'value' then meta.value when 'array' then (metaToValue(el) for el in meta.members) + when 'buffer' then new Buffer(meta.value) when 'error' throw new Error("#{meta.message}\n#{meta.stack}") else From 09c5da7147d3934efee209a7cfeedd6651b2c7c1 Mon Sep 17 00:00:00 2001 From: Kirk Ouimet Date: Tue, 9 Jun 2015 21:06:40 -0700 Subject: [PATCH 0231/1293] Fixing cpplint line width --- atom/common/crash_reporter/crash_reporter.cc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/atom/common/crash_reporter/crash_reporter.cc b/atom/common/crash_reporter/crash_reporter.cc index 144542086a1f..59b7fd51e45e 100644 --- a/atom/common/crash_reporter/crash_reporter.cc +++ b/atom/common/crash_reporter/crash_reporter.cc @@ -46,7 +46,8 @@ std::vector CrashReporter::GetUploadedReports(const std::string& path) { std::string file_content; std::vector result; - if (base::ReadFileToString(base::FilePath::FromUTF8Unsafe(path), &file_content)) { + if (base::ReadFileToString(base::FilePath::FromUTF8Unsafe(path), + &file_content)) { std::vector reports; base::SplitString(file_content, '\n', &reports); for (const std::string& report : reports) { From db9615f5cda2d5163aaef420aa47b472004b53ed Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 10 Jun 2015 12:12:37 +0800 Subject: [PATCH 0232/1293] Don't rely on JS for setting optional argument It makes the code much shorter and cleaner. --- atom/common/api/atom_api_clipboard.cc | 91 ++++++++++++--------------- atom/common/api/lib/clipboard.coffee | 14 +---- 2 files changed, 41 insertions(+), 64 deletions(-) diff --git a/atom/common/api/atom_api_clipboard.cc b/atom/common/api/atom_api_clipboard.cc index da624a0a1ad3..273d30d96770 100644 --- a/atom/common/api/atom_api_clipboard.cc +++ b/atom/common/api/atom_api_clipboard.cc @@ -7,6 +7,7 @@ #include "atom/common/native_mate_converters/image_converter.h" #include "atom/common/native_mate_converters/string16_converter.h" +#include "native_mate/arguments.h" #include "native_mate/dictionary.h" #include "third_party/skia/include/core/SkBitmap.h" #include "ui/base/clipboard/clipboard.h" @@ -15,44 +16,32 @@ #include "atom/common/node_includes.h" -namespace mate { - -template<> -struct Converter { - static bool FromV8(v8::Isolate* isolate, v8::Local val, - ui::ClipboardType* out) { - std::string type; - if (!Converter::FromV8(isolate, val, &type)) - return false; - - if (type == "selection") - *out = ui::CLIPBOARD_TYPE_SELECTION; - else - *out = ui::CLIPBOARD_TYPE_COPY_PASTE; - return true; - } -}; - -} // namespace mate - namespace { -std::vector AvailableFormats(ui::ClipboardType type) { +ui::ClipboardType GetClipboardType(mate::Arguments* args) { + std::string type; + if (args->GetNext(&type) && type == "selection") + return ui::CLIPBOARD_TYPE_SELECTION; + else + return ui::CLIPBOARD_TYPE_COPY_PASTE; +} + +std::vector AvailableFormats(mate::Arguments* args) { std::vector format_types; bool ignore; ui::Clipboard* clipboard = ui::Clipboard::GetForCurrentThread(); - clipboard->ReadAvailableTypes(type, &format_types, &ignore); + clipboard->ReadAvailableTypes(GetClipboardType(args), &format_types, &ignore); return format_types; } -bool Has(const std::string& format_string, ui::ClipboardType type) { +bool Has(const std::string& format_string, mate::Arguments* args) { ui::Clipboard* clipboard = ui::Clipboard::GetForCurrentThread(); ui::Clipboard::FormatType format(ui::Clipboard::GetFormatType(format_string)); - return clipboard->IsFormatAvailable(format, type); + return clipboard->IsFormatAvailable(format, GetClipboardType(args)); } std::string Read(const std::string& format_string, - ui::ClipboardType type) { + mate::Arguments* args) { ui::Clipboard* clipboard = ui::Clipboard::GetForCurrentThread(); ui::Clipboard::FormatType format(ui::Clipboard::GetFormatType(format_string)); @@ -61,62 +50,62 @@ std::string Read(const std::string& format_string, return data; } -base::string16 ReadText(ui::ClipboardType type) { +base::string16 ReadText(mate::Arguments* args) { base::string16 data; - ui::Clipboard::GetForCurrentThread()->ReadText(type, &data); + ui::Clipboard::GetForCurrentThread()->ReadText(GetClipboardType(args), &data); return data; } -void WriteText(const base::string16& text, ui::ClipboardType type) { - ui::ScopedClipboardWriter writer(type); +void WriteText(const base::string16& text, mate::Arguments* args) { + ui::ScopedClipboardWriter writer(GetClipboardType(args)); writer.WriteText(text); } -base::string16 ReadHtml(ui::ClipboardType type) { +base::string16 ReadHtml(mate::Arguments* args) { base::string16 data; base::string16 html; std::string url; uint32 start; uint32 end; - ui::Clipboard::GetForCurrentThread()->ReadHTML(type, &html, &url, - &start, &end); + ui::Clipboard* clipboard = ui::Clipboard::GetForCurrentThread(); + clipboard->ReadHTML(GetClipboardType(args), &html, &url, &start, &end); data = html.substr(start, end - start); return data; } -void WriteHtml(const base::string16& html, - ui::ClipboardType type) { - ui::ScopedClipboardWriter writer(type); +void WriteHtml(const base::string16& html, mate::Arguments* args) { + ui::ScopedClipboardWriter writer(GetClipboardType(args)); writer.WriteHTML(html, std::string()); } -gfx::Image ReadImage(ui::ClipboardType type) { - SkBitmap bitmap = ui::Clipboard::GetForCurrentThread()->ReadImage(type); +gfx::Image ReadImage(mate::Arguments* args) { + ui::Clipboard* clipboard = ui::Clipboard::GetForCurrentThread(); + SkBitmap bitmap = clipboard->ReadImage(GetClipboardType(args)); return gfx::Image::CreateFrom1xBitmap(bitmap); } -void WriteImage(const gfx::Image& image, ui::ClipboardType type) { - ui::ScopedClipboardWriter writer(type); +void WriteImage(const gfx::Image& image, mate::Arguments* args) { + ui::ScopedClipboardWriter writer(GetClipboardType(args)); writer.WriteImage(image.AsBitmap()); } -void Clear(ui::ClipboardType type) { - ui::Clipboard::GetForCurrentThread()->Clear(type); +void Clear(mate::Arguments* args) { + ui::Clipboard::GetForCurrentThread()->Clear(GetClipboardType(args)); } void Initialize(v8::Local exports, v8::Local unused, v8::Local context, void* priv) { mate::Dictionary dict(context->GetIsolate(), exports); - dict.SetMethod("_availableFormats", &AvailableFormats); - dict.SetMethod("_has", &Has); - dict.SetMethod("_read", &Read); - dict.SetMethod("_readText", &ReadText); - dict.SetMethod("_writeText", &WriteText); - dict.SetMethod("_readHtml", &ReadHtml); - dict.SetMethod("_writeHtml", &WriteHtml); - dict.SetMethod("_readImage", &ReadImage); - dict.SetMethod("_writeImage", &WriteImage); - dict.SetMethod("_clear", &Clear); + dict.SetMethod("availableFormats", &AvailableFormats); + dict.SetMethod("has", &Has); + dict.SetMethod("read", &Read); + dict.SetMethod("readText", &ReadText); + dict.SetMethod("writeText", &WriteText); + dict.SetMethod("readHtml", &ReadHtml); + dict.SetMethod("writeHtml", &WriteHtml); + dict.SetMethod("readImage", &ReadImage); + dict.SetMethod("writeImage", &WriteImage); + dict.SetMethod("clear", &Clear); } } // namespace diff --git a/atom/common/api/lib/clipboard.coffee b/atom/common/api/lib/clipboard.coffee index 9a7a6abfa47f..5c4bb10d4ae5 100644 --- a/atom/common/api/lib/clipboard.coffee +++ b/atom/common/api/lib/clipboard.coffee @@ -2,16 +2,4 @@ if process.platform is 'linux' and process.type is 'renderer' # On Linux we could not access clipboard in renderer process. module.exports = require('remote').require 'clipboard' else - binding = process.atomBinding 'clipboard' - - module.exports = - availableFormats: (type='standard') -> binding._availableFormats type - has: (format, type='standard') -> binding._has format, type - read: (format, type='standard') -> binding._read format, type - readText: (type='standard') -> binding._readText type - writeText: (text, type='standard') -> binding._writeText text, type - readHtml: (type='standard') -> binding._readHtml type - writeHtml: (markup, type='standard') -> binding._writeHtml markup, type - readImage: (type='standard') -> binding._readImage type - writeImage: (image, type='standard') -> binding._writeImage image, type - clear: (type='standard') -> binding._clear type + module.exports = process.atomBinding 'clipboard' From 8eb5e651a2b6ab5c9400d9c367f78644c192b7f5 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 10 Jun 2015 12:52:04 +0800 Subject: [PATCH 0233/1293] Suppress some tests on CI The Mac runner of Travis CI is too flacky. --- spec/api-browser-window-spec.coffee | 3 +++ 1 file changed, 3 insertions(+) diff --git a/spec/api-browser-window-spec.coffee b/spec/api-browser-window-spec.coffee index ea3e06c9d406..390f29bf2f0c 100644 --- a/spec/api-browser-window-spec.coffee +++ b/spec/api-browser-window-spec.coffee @@ -188,6 +188,7 @@ describe 'browser-window module', -> w.loadUrl 'file://' + path.join(fixtures, 'api', 'close-beforeunload-empty-string.html') describe 'new-window event', -> + return if isCI and process.platform is 'darwin' it 'emits when window.open is called', (done) -> w.webContents.once 'new-window', (e, url, frameName) -> e.preventDefault() @@ -230,6 +231,7 @@ describe 'browser-window module', -> w.minimize() describe 'will-navigate event', -> + return if isCI and process.platform is 'darwin' it 'emits when user starts a navigation', (done) -> @timeout 10000 w.webContents.on 'will-navigate', (event, url) -> @@ -239,6 +241,7 @@ describe 'browser-window module', -> w.loadUrl "file://#{fixtures}/pages/will-navigate.html" describe 'dom-ready event', -> + return if isCI and process.platform is 'darwin' it 'emits when document is loaded', (done) -> ipc = remote.require 'ipc' server = http.createServer (req, res) -> From 04d24f61fee0c7eb2a778ef77002aac27a7019ec Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 10 Jun 2015 14:11:34 +0800 Subject: [PATCH 0234/1293] Update to node.gyp's changes --- common.gypi | 6 +++++- script/update.py | 10 ++++++++++ 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/common.gypi b/common.gypi index c6f3320c0a5b..7c6e45d045b8 100644 --- a/common.gypi +++ b/common.gypi @@ -9,6 +9,7 @@ 'component%': 'static_library', 'python': 'python', 'openssl_no_asm': 1, + 'node_target_type': 'shared_library', 'node_install_npm': 'false', 'node_prefix': '', 'node_shared_cares': 'false', @@ -99,7 +100,10 @@ ], }], ['_target_name=="node"', { - 'include_dirs': [ '<(libchromiumcontent_src_dir)/v8/include' ], + 'include_dirs': [ + '<(libchromiumcontent_src_dir)/v8', + '<(libchromiumcontent_src_dir)/v8/include', + ], 'conditions': [ ['OS=="mac" and libchromiumcontent_component==0', { # -all_load is the "whole-archive" on OS X. diff --git a/script/update.py b/script/update.py index aaa07526c05f..23497ff9e5ac 100755 --- a/script/update.py +++ b/script/update.py @@ -1,6 +1,7 @@ #!/usr/bin/env python import os +import platform import subprocess import sys @@ -43,10 +44,19 @@ def run_gyp(target_arch, component): defines = [ '-Dlibchromiumcontent_component={0}'.format(component), '-Dtarget_arch={0}'.format(target_arch), + '-Dhost_arch={0}'.format(target_arch), '-Dlibrary=static_library', ] return subprocess.call([python, gyp, '-f', 'ninja', '--depth', '.', 'atom.gyp', '-Icommon.gypi'] + defines) + +def get_host_arch(): + if platform.architecture()[0] == '32bit': + return 'ia32' + else: + return 'x64' + + if __name__ == '__main__': sys.exit(main()) From 132c13a11bdab8b147606866770d01bd307f60cf Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 10 Jun 2015 14:21:09 +0800 Subject: [PATCH 0235/1293] Fix calls to deprecated node::ThrowError API --- atom/browser/api/atom_api_power_monitor.cc | 5 +-- atom/browser/api/atom_api_protocol.cc | 42 ++++++++++------------ atom/browser/api/atom_api_protocol.h | 10 +++--- atom/browser/api/atom_api_screen.cc | 5 +-- atom/browser/api/atom_api_tray.cc | 4 +-- atom/browser/api/atom_api_tray.h | 2 +- atom/browser/api/atom_api_window.cc | 3 +- atom/common/api/atom_api_id_weak_map.cc | 2 +- atom/renderer/api/atom_api_renderer_ipc.cc | 11 +++--- 9 files changed, 43 insertions(+), 41 deletions(-) diff --git a/atom/browser/api/atom_api_power_monitor.cc b/atom/browser/api/atom_api_power_monitor.cc index afdebfcf7f2f..093df2a1d4ef 100644 --- a/atom/browser/api/atom_api_power_monitor.cc +++ b/atom/browser/api/atom_api_power_monitor.cc @@ -41,8 +41,9 @@ void PowerMonitor::OnResume() { // static v8::Local PowerMonitor::Create(v8::Isolate* isolate) { if (!Browser::Get()->is_ready()) { - node::ThrowError("Cannot initialize \"power-monitor\" module" - "before app is ready"); + node::ThrowError( + isolate, + "Cannot initialize \"power-monitor\" module before app is ready"); return v8::Null(isolate); } diff --git a/atom/browser/api/atom_api_protocol.cc b/atom/browser/api/atom_api_protocol.cc index 323d282b19a9..083ea32b2010 100644 --- a/atom/browser/api/atom_api_protocol.cc +++ b/atom/browser/api/atom_api_protocol.cc @@ -192,28 +192,19 @@ Protocol::JsProtocolHandler Protocol::GetProtocolHandler( mate::ObjectTemplateBuilder Protocol::GetObjectTemplateBuilder( v8::Isolate* isolate) { return mate::ObjectTemplateBuilder(isolate) - .SetMethod("registerProtocol", - base::Bind(&Protocol::RegisterProtocol, - base::Unretained(this))) - .SetMethod("unregisterProtocol", - base::Bind(&Protocol::UnregisterProtocol, - base::Unretained(this))) - .SetMethod("isHandledProtocol", - base::Bind(&Protocol::IsHandledProtocol, - base::Unretained(this))) - .SetMethod("interceptProtocol", - base::Bind(&Protocol::InterceptProtocol, - base::Unretained(this))) - .SetMethod("uninterceptProtocol", - base::Bind(&Protocol::UninterceptProtocol, - base::Unretained(this))); + .SetMethod("registerProtocol", &Protocol::RegisterProtocol) + .SetMethod("unregisterProtocol", &Protocol::UnregisterProtocol) + .SetMethod("isHandledProtocol", &Protocol::IsHandledProtocol) + .SetMethod("interceptProtocol", &Protocol::InterceptProtocol) + .SetMethod("uninterceptProtocol", &Protocol::UninterceptProtocol); } -void Protocol::RegisterProtocol(const std::string& scheme, +void Protocol::RegisterProtocol(v8::Isolate* isolate, + const std::string& scheme, const JsProtocolHandler& callback) { if (ContainsKey(protocol_handlers_, scheme) || job_factory_->IsHandledProtocol(scheme)) - return node::ThrowError("The scheme is already registered"); + return node::ThrowError(isolate, "The scheme is already registered"); protocol_handlers_[scheme] = callback; BrowserThread::PostTask(BrowserThread::IO, @@ -222,10 +213,11 @@ void Protocol::RegisterProtocol(const std::string& scheme, base::Unretained(this), scheme)); } -void Protocol::UnregisterProtocol(const std::string& scheme) { +void Protocol::UnregisterProtocol(v8::Isolate* isolate, + const std::string& scheme) { ProtocolHandlersMap::iterator it(protocol_handlers_.find(scheme)); if (it == protocol_handlers_.end()) - return node::ThrowError("The scheme has not been registered"); + return node::ThrowError(isolate, "The scheme has not been registered"); protocol_handlers_.erase(it); BrowserThread::PostTask(BrowserThread::IO, @@ -238,13 +230,14 @@ bool Protocol::IsHandledProtocol(const std::string& scheme) { return job_factory_->IsHandledProtocol(scheme); } -void Protocol::InterceptProtocol(const std::string& scheme, +void Protocol::InterceptProtocol(v8::Isolate* isolate, + const std::string& scheme, const JsProtocolHandler& callback) { if (!job_factory_->HasProtocolHandler(scheme)) - return node::ThrowError("Scheme does not exist."); + return node::ThrowError(isolate, "Scheme does not exist."); if (ContainsKey(protocol_handlers_, scheme)) - return node::ThrowError("Cannot intercept custom procotols"); + return node::ThrowError(isolate, "Cannot intercept custom procotols"); protocol_handlers_[scheme] = callback; BrowserThread::PostTask(BrowserThread::IO, @@ -253,10 +246,11 @@ void Protocol::InterceptProtocol(const std::string& scheme, base::Unretained(this), scheme)); } -void Protocol::UninterceptProtocol(const std::string& scheme) { +void Protocol::UninterceptProtocol(v8::Isolate* isolate, + const std::string& scheme) { ProtocolHandlersMap::iterator it(protocol_handlers_.find(scheme)); if (it == protocol_handlers_.end()) - return node::ThrowError("The scheme has not been registered"); + return node::ThrowError(isolate, "The scheme has not been registered"); protocol_handlers_.erase(it); BrowserThread::PostTask(BrowserThread::IO, diff --git a/atom/browser/api/atom_api_protocol.h b/atom/browser/api/atom_api_protocol.h index deef277333b5..34725cecc925 100644 --- a/atom/browser/api/atom_api_protocol.h +++ b/atom/browser/api/atom_api_protocol.h @@ -43,9 +43,10 @@ class Protocol : public mate::EventEmitter { // Register/unregister an networking |scheme| which would be handled by // |callback|. - void RegisterProtocol(const std::string& scheme, + void RegisterProtocol(v8::Isolate* isolate, + const std::string& scheme, const JsProtocolHandler& callback); - void UnregisterProtocol(const std::string& scheme); + void UnregisterProtocol(v8::Isolate* isolate, const std::string& scheme); // Returns whether a scheme has been registered. // FIXME Should accept a callback and be asynchronous so we do not have to use @@ -53,9 +54,10 @@ class Protocol : public mate::EventEmitter { bool IsHandledProtocol(const std::string& scheme); // Intercept/unintercept an existing protocol handler. - void InterceptProtocol(const std::string& scheme, + void InterceptProtocol(v8::Isolate* isolate, + const std::string& scheme, const JsProtocolHandler& callback); - void UninterceptProtocol(const std::string& scheme); + void UninterceptProtocol(v8::Isolate* isolate, const std::string& scheme); // The networking related operations have to be done in IO thread. void RegisterProtocolInIO(const std::string& scheme); diff --git a/atom/browser/api/atom_api_screen.cc b/atom/browser/api/atom_api_screen.cc index c042cc3f1f08..9f81cf6eeff7 100644 --- a/atom/browser/api/atom_api_screen.cc +++ b/atom/browser/api/atom_api_screen.cc @@ -113,13 +113,14 @@ mate::ObjectTemplateBuilder Screen::GetObjectTemplateBuilder( // static v8::Local Screen::Create(v8::Isolate* isolate) { if (!Browser::Get()->is_ready()) { - node::ThrowError("Cannot initialize \"screen\" module before app is ready"); + node::ThrowError(isolate, + "Cannot initialize \"screen\" module before app is ready"); return v8::Null(isolate); } gfx::Screen* screen = gfx::Screen::GetNativeScreen(); if (!screen) { - node::ThrowError("Failed to get screen information"); + node::ThrowError(isolate, "Failed to get screen information"); return v8::Null(isolate); } diff --git a/atom/browser/api/atom_api_tray.cc b/atom/browser/api/atom_api_tray.cc index 6d7a9e5dedbd..2672f6f67ae5 100644 --- a/atom/browser/api/atom_api_tray.cc +++ b/atom/browser/api/atom_api_tray.cc @@ -32,9 +32,9 @@ Tray::~Tray() { } // static -mate::Wrappable* Tray::New(const gfx::Image& image) { +mate::Wrappable* Tray::New(v8::Isolate* isolate, const gfx::Image& image) { if (!Browser::Get()->is_ready()) { - node::ThrowError("Cannot create Tray before app is ready"); + node::ThrowError(isolate, "Cannot create Tray before app is ready"); return nullptr; } return new Tray(image); diff --git a/atom/browser/api/atom_api_tray.h b/atom/browser/api/atom_api_tray.h index 9fe3513094d8..6bbbe6d2d90c 100644 --- a/atom/browser/api/atom_api_tray.h +++ b/atom/browser/api/atom_api_tray.h @@ -31,7 +31,7 @@ class Menu; class Tray : public mate::EventEmitter, public TrayIconObserver { public: - static mate::Wrappable* New(const gfx::Image& image); + static mate::Wrappable* New(v8::Isolate* isolate, const gfx::Image& image); static void BuildPrototype(v8::Isolate* isolate, v8::Local prototype); diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index 76aaa3baaff5..7461bc736855 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -189,7 +189,8 @@ void Window::OnDevToolsClosed() { mate::Wrappable* Window::New(v8::Isolate* isolate, const mate::Dictionary& options) { if (!Browser::Get()->is_ready()) { - node::ThrowError("Cannot create BrowserWindow before app is ready"); + node::ThrowError(isolate, + "Cannot create BrowserWindow before app is ready"); return nullptr; } return new Window(options); diff --git a/atom/common/api/atom_api_id_weak_map.cc b/atom/common/api/atom_api_id_weak_map.cc index cc2af821de18..614683c473a5 100644 --- a/atom/common/api/atom_api_id_weak_map.cc +++ b/atom/common/api/atom_api_id_weak_map.cc @@ -35,7 +35,7 @@ int32_t IDWeakMap::Add(v8::Isolate* isolate, v8::Local object) { v8::Local IDWeakMap::Get(v8::Isolate* isolate, int32_t key) { if (!Has(key)) { - node::ThrowError("Invalid key"); + node::ThrowError(isolate, "Invalid key"); return v8::Undefined(isolate); } diff --git a/atom/renderer/api/atom_api_renderer_ipc.cc b/atom/renderer/api/atom_api_renderer_ipc.cc index 00a5ba861650..d222f8f73b85 100644 --- a/atom/renderer/api/atom_api_renderer_ipc.cc +++ b/atom/renderer/api/atom_api_renderer_ipc.cc @@ -30,7 +30,9 @@ RenderView* GetCurrentRenderView() { return RenderView::FromWebView(view); } -void Send(const base::string16& channel, const base::ListValue& arguments) { +void Send(v8::Isolate* isolate, + const base::string16& channel, + const base::ListValue& arguments) { RenderView* render_view = GetCurrentRenderView(); if (render_view == NULL) return; @@ -39,10 +41,11 @@ void Send(const base::string16& channel, const base::ListValue& arguments) { render_view->GetRoutingID(), channel, arguments)); if (!success) - node::ThrowError("Unable to send AtomViewHostMsg_Message"); + node::ThrowError(isolate, "Unable to send AtomViewHostMsg_Message"); } -base::string16 SendSync(const base::string16& channel, +base::string16 SendSync(v8::Isolate* isolate, + const base::string16& channel, const base::ListValue& arguments) { base::string16 json; @@ -57,7 +60,7 @@ base::string16 SendSync(const base::string16& channel, bool success = render_view->Send(message); if (!success) - node::ThrowError("Unable to send AtomViewHostMsg_Message_Sync"); + node::ThrowError(isolate, "Unable to send AtomViewHostMsg_Message_Sync"); return json; } From 605722c397c1b3799c749d79047e43d1b8b92f42 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 10 Jun 2015 16:18:55 +0800 Subject: [PATCH 0236/1293] Make asar work with internalModuleReadFile and internalModuleStat --- atom/common/lib/asar.coffee | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/atom/common/lib/asar.coffee b/atom/common/lib/asar.coffee index a17ac729253d..7ce89156285d 100644 --- a/atom/common/lib/asar.coffee +++ b/atom/common/lib/asar.coffee @@ -310,6 +310,38 @@ exports.wrapFsWithAsar = (fs) -> files + internalModuleReadFile = process.binding('fs').internalModuleReadFile + process.binding('fs').internalModuleReadFile = (p) -> + [isAsar, asarPath, filePath] = splitPath p + return internalModuleReadFile p unless isAsar + + archive = getOrCreateArchive asarPath + return undefined unless archive + + info = archive.getFileInfo filePath + return undefined unless info + return '' if info.size is 0 + + buffer = new Buffer(info.size) + fd = archive.getFd() + retrun undefined unless fd >= 0 + + fs.readSync fd, buffer, 0, info.size, info.offset + buffer.toString 'utf8' + + internalModuleStat = process.binding('fs').internalModuleStat + process.binding('fs').internalModuleStat = (p) -> + [isAsar, asarPath, filePath] = splitPath p + return internalModuleStat p unless isAsar + + archive = getOrCreateArchive asarPath + return -34 unless archive # -ENOENT + + stats = archive.stat filePath + return -34 unless stats # -ENOENT + + if stats.isDirectory then return 1 else return 0 + overrideAPI fs, 'open' overrideAPI child_process, 'execFile' overrideAPISync process, 'dlopen', 1 From 36f0ef703a88edef9b2d9a868e9251997aecddc7 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 10 Jun 2015 16:19:19 +0800 Subject: [PATCH 0237/1293] Update io.js to v2.2.1 --- vendor/node | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/node b/vendor/node index b772c19a8f9d..f642ab6e5326 160000 --- a/vendor/node +++ b/vendor/node @@ -1 +1 @@ -Subproject commit b772c19a8f9db65673184822fb294235eff9c364 +Subproject commit f642ab6e532647b5ee8828e79054990439e2b34b From 333fe874904b447bb55bef79cc49ef6c729bd7ed Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 10 Jun 2015 16:30:47 +0800 Subject: [PATCH 0238/1293] Define V8_BASE --- common.gypi | 1 + 1 file changed, 1 insertion(+) diff --git a/common.gypi b/common.gypi index 7c6e45d045b8..14b89393a534 100644 --- a/common.gypi +++ b/common.gypi @@ -27,6 +27,7 @@ 'uv_library': 'static_library', 'uv_parent_path': 'vendor/node/deps/uv', 'uv_use_dtrace': 'false', + 'V8_BASE': '', 'v8_postmortem_support': 'false', 'v8_enable_i18n_support': 'false', # Required by Linux (empty for now, should support it in future). From 731773765e1844fe859524c31bdc8f77e9e2aa60 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 10 Jun 2015 16:40:35 +0800 Subject: [PATCH 0239/1293] Update iojs to fix linking on Linux --- vendor/node | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/node b/vendor/node index f642ab6e5326..0a8c4d2a8c01 160000 --- a/vendor/node +++ b/vendor/node @@ -1 +1 @@ -Subproject commit f642ab6e532647b5ee8828e79054990439e2b34b +Subproject commit 0a8c4d2a8c0118348b5072b1e21bc4bd148b238b From b76642bd10d20dcb0dc51a0227ac03bf3cf08f76 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 10 Jun 2015 19:16:23 +0800 Subject: [PATCH 0240/1293] Update brightray --- vendor/brightray | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/brightray b/vendor/brightray index 1cba3a459e96..d6f97206b3fe 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit 1cba3a459e9629916655c98716b32ccd1869ef56 +Subproject commit d6f97206b3fea5d8b9e5941d500a4be7bbf34a3d From 163790d1075dc07c81dbe1c8c8499a35829d3d13 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 10 Jun 2015 19:18:33 +0800 Subject: [PATCH 0241/1293] docs: Update formats --- docs/api/chrome-command-line-switches.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/chrome-command-line-switches.md b/docs/api/chrome-command-line-switches.md index 0469f47ef91e..0eaefbe1551c 100644 --- a/docs/api/chrome-command-line-switches.md +++ b/docs/api/chrome-command-line-switches.md @@ -15,9 +15,9 @@ app.on('ready', function() { }); ``` -## --client-certificate +## --client-certificate=`path` -Path to client certificate file. +Sets `path` of client certificate file. ## --disable-http-cache From cd3c06144896e071034f86e2b65b845ce73ab71b Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 10 Jun 2015 19:34:30 +0800 Subject: [PATCH 0242/1293] win: Fix compilation error --- atom/browser/atom_browser_client.cc | 1 + vendor/brightray | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/atom/browser/atom_browser_client.cc b/atom/browser/atom_browser_client.cc index d0f2df2122cd..ec519fa4f822 100644 --- a/atom/browser/atom_browser_client.cc +++ b/atom/browser/atom_browser_client.cc @@ -14,6 +14,7 @@ #include "atom/browser/window_list.h" #include "atom/common/options_switches.h" #include "base/command_line.h" +#include "base/files/file_util.h" #include "base/strings/string_number_conversions.h" #include "chrome/browser/printing/printing_message_filter.h" #include "chrome/browser/renderer_host/pepper/chrome_browser_pepper_host_factory.h" diff --git a/vendor/brightray b/vendor/brightray index d6f97206b3fe..7c6c530608e1 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit d6f97206b3fea5d8b9e5941d500a4be7bbf34a3d +Subproject commit 7c6c530608e17ee569edea3dc2607736f3cdb376 From 71598e15bf0ca2fd8de338d864cc37776608c6c2 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 10 Jun 2015 21:08:54 +0800 Subject: [PATCH 0243/1293] Update node to fix crash caused by malloc --- vendor/node | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/node b/vendor/node index 0a8c4d2a8c01..ab1b3ba0b007 160000 --- a/vendor/node +++ b/vendor/node @@ -1 +1 @@ -Subproject commit 0a8c4d2a8c0118348b5072b1e21bc4bd148b238b +Subproject commit ab1b3ba0b0076d7aa72e80caf8045fb6f7a68be0 From b4674923c9ece958a4694c4e1e33d50da81eb3c6 Mon Sep 17 00:00:00 2001 From: msullivan Date: Wed, 10 Jun 2015 11:06:22 -0400 Subject: [PATCH 0244/1293] return bool on shell.openExternal --- atom/common/platform_util.h | 2 +- atom/common/platform_util_linux.cc | 14 +++++++------- atom/common/platform_util_mac.mm | 13 ++++++++++--- atom/common/platform_util_win.cc | 9 +++++---- 4 files changed, 23 insertions(+), 15 deletions(-) diff --git a/atom/common/platform_util.h b/atom/common/platform_util.h index 7ac150b79211..312942c4f5dc 100644 --- a/atom/common/platform_util.h +++ b/atom/common/platform_util.h @@ -23,7 +23,7 @@ void OpenItem(const base::FilePath& full_path); // Open the given external protocol URL in the desktop's default manner. // (For example, mailto: URLs in the default mail user agent.) -void OpenExternal(const GURL& url); +bool OpenExternal(const GURL& url); // Move a file to trash. bool MoveItemToTrash(const base::FilePath& full_path); diff --git a/atom/common/platform_util_linux.cc b/atom/common/platform_util_linux.cc index f70d16a559a7..aa7439968daa 100644 --- a/atom/common/platform_util_linux.cc +++ b/atom/common/platform_util_linux.cc @@ -37,12 +37,12 @@ bool XDGUtil(const std::string& util, const std::string& arg) { return (exit_code == 0); } -void XDGOpen(const std::string& path) { - XDGUtil("xdg-open", path); +bool XDGOpen(const std::string& path) { + return XDGUtil("xdg-open", path); } -void XDGEmail(const std::string& email) { - XDGUtil("xdg-email", email); +bool XDGEmail(const std::string& email) { + return XDGUtil("xdg-email", email); } } // namespace @@ -64,11 +64,11 @@ void OpenItem(const base::FilePath& full_path) { XDGOpen(full_path.value()); } -void OpenExternal(const GURL& url) { +bool OpenExternal(const GURL& url) { if (url.SchemeIs("mailto")) - XDGEmail(url.spec()); + return XDGEmail(url.spec()); else - XDGOpen(url.spec()); + return XDGOpen(url.spec()); } bool MoveItemToTrash(const base::FilePath& full_path) { diff --git a/atom/common/platform_util_mac.mm b/atom/common/platform_util_mac.mm index 41f3c59916aa..4637bc330e31 100644 --- a/atom/common/platform_util_mac.mm +++ b/atom/common/platform_util_mac.mm @@ -118,12 +118,19 @@ void OpenItem(const base::FilePath& full_path) { } } -void OpenExternal(const GURL& url) { +bool OpenExternal(const GURL& url) { DCHECK([NSThread isMainThread]); NSString* url_string = base::SysUTF8ToNSString(url.spec()); NSURL* ns_url = [NSURL URLWithString:url_string]; - if (!ns_url || ![[NSWorkspace sharedWorkspace] openURL:ns_url]) - LOG(WARNING) << "NSWorkspace failed to open URL " << url; + if (!ns_url){ + return false; + } + NSArray *appUrls = (NSArray*)LSCopyApplicationURLsForURL((CFURLRef)ns_url, kLSRolesAll); + if([appUrls count] > 0){ + if([[NSWorkspace sharedWorkspace] openURL:ns_url]) + return true; + } + return false; } bool MoveItemToTrash(const base::FilePath& full_path) { diff --git a/atom/common/platform_util_win.cc b/atom/common/platform_util_win.cc index 1998b8873189..09ac5aca48f2 100644 --- a/atom/common/platform_util_win.cc +++ b/atom/common/platform_util_win.cc @@ -135,7 +135,7 @@ void OpenItem(const base::FilePath& full_path) { ui::win::OpenFileViaShell(full_path); } -void OpenExternal(const GURL& url) { +bool OpenExternal(const GURL& url) { // Quote the input scheme to be sure that the command does not have // parameters unexpected by the external program. This url should already // have been escaped. @@ -150,12 +150,12 @@ void OpenExternal(const GURL& url) { const size_t kMaxUrlLength = 2048; if (escaped_url.length() > kMaxUrlLength) { NOTREACHED(); - return; + return false; } if (base::win::GetVersion() < base::win::VERSION_WIN7) { if (!ValidateShellCommandForScheme(url.scheme())) - return; + return false; } if (reinterpret_cast(ShellExecuteA(NULL, "open", @@ -164,8 +164,9 @@ void OpenExternal(const GURL& url) { // We fail to execute the call. We could display a message to the user. // TODO(nsylvain): we should also add a dialog to warn on errors. See // bug 1136923. - return; + return false; } + return true; } bool MoveItemToTrash(const base::FilePath& path) { From 549ec51bce2b493d73e23bdb4dda9d16ac3301f3 Mon Sep 17 00:00:00 2001 From: Sam Eaton Date: Wed, 10 Jun 2015 19:24:36 -0600 Subject: [PATCH 0245/1293] adds 'before using methods' example The document does not inform that the webview element has to be loaded before using the element's methods. It is not clear. --- docs/api/web-view-tag.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/api/web-view-tag.md b/docs/api/web-view-tag.md index 705014cf6a18..210b15f9e8b4 100644 --- a/docs/api/web-view-tag.md +++ b/docs/api/web-view-tag.md @@ -130,6 +130,14 @@ If "on", the guest page will have web security disabled. ## Methods +The webview element must be loaded before using the methods. +**Example** +```javascript +webview.addEventListener("dom-ready", function(){ + webview.openDevTools(); +}); +``` + ### ``.getUrl() Returns URL of guest page. From 5fe130a684fadc650c02d91038c9642a5ab4e60b Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 11 Jun 2015 12:13:18 +0800 Subject: [PATCH 0246/1293] Bump v0.28.0 --- atom.gyp | 2 +- atom/browser/resources/mac/Info.plist | 2 +- atom/browser/resources/win/atom.rc | 8 ++++---- atom/common/atom_version.h | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/atom.gyp b/atom.gyp index 795ae97e9f0c..3af90f0337ce 100644 --- a/atom.gyp +++ b/atom.gyp @@ -4,7 +4,7 @@ 'product_name%': 'Electron', 'company_name%': 'GitHub, Inc', 'company_abbr%': 'github', - 'version%': '0.27.3', + 'version%': '0.28.0', 'atom_source_root': 'CFBundleIconFile atom.icns CFBundleVersion - 0.27.3 + 0.28.0 LSMinimumSystemVersion 10.8.0 NSMainNibFile diff --git a/atom/browser/resources/win/atom.rc b/atom/browser/resources/win/atom.rc index 13c6eca6b97c..9a01132b82dd 100644 --- a/atom/browser/resources/win/atom.rc +++ b/atom/browser/resources/win/atom.rc @@ -50,8 +50,8 @@ END // VS_VERSION_INFO VERSIONINFO - FILEVERSION 0,27,3,0 - PRODUCTVERSION 0,27,3,0 + FILEVERSION 0,28,0,0 + PRODUCTVERSION 0,28,0,0 FILEFLAGSMASK 0x3fL #ifdef _DEBUG FILEFLAGS 0x1L @@ -68,12 +68,12 @@ BEGIN BEGIN VALUE "CompanyName", "GitHub, Inc." VALUE "FileDescription", "Electron" - VALUE "FileVersion", "0.27.3" + VALUE "FileVersion", "0.28.0" VALUE "InternalName", "electron.exe" VALUE "LegalCopyright", "Copyright (C) 2015 GitHub, Inc. All rights reserved." VALUE "OriginalFilename", "electron.exe" VALUE "ProductName", "Electron" - VALUE "ProductVersion", "0.27.3" + VALUE "ProductVersion", "0.28.0" VALUE "SquirrelAwareVersion", "1" END END diff --git a/atom/common/atom_version.h b/atom/common/atom_version.h index a108d84985d8..3377653c3b7b 100644 --- a/atom/common/atom_version.h +++ b/atom/common/atom_version.h @@ -6,8 +6,8 @@ #define ATOM_VERSION_H #define ATOM_MAJOR_VERSION 0 -#define ATOM_MINOR_VERSION 27 -#define ATOM_PATCH_VERSION 3 +#define ATOM_MINOR_VERSION 28 +#define ATOM_PATCH_VERSION 0 #define ATOM_VERSION_IS_RELEASE 1 From 18fcd6990b204dca7b43b54c2fbb9556a7132954 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 11 Jun 2015 14:14:22 +0800 Subject: [PATCH 0247/1293] win: Fix running spec --- spec/webview-spec.coffee | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/webview-spec.coffee b/spec/webview-spec.coffee index 2b67fb5b0de3..a1a1724380cc 100644 --- a/spec/webview-spec.coffee +++ b/spec/webview-spec.coffee @@ -54,7 +54,7 @@ describe ' tag', -> assert.equal e.message, 'function' done() webview.addEventListener 'console-message', listener2 - webview.src = "file://#{fixtures}/pages/native-module.html" + webview.reload() webview.addEventListener 'did-finish-load', listener webview.setAttribute 'nodeintegration', 'on' webview.src = "file://#{fixtures}/pages/native-module.html" From 0e6a70c556363befe1e9f8be2d168fc030e7aa49 Mon Sep 17 00:00:00 2001 From: Sota Yamashita Date: Sun, 7 Jun 2015 15:52:19 +0900 Subject: [PATCH 0248/1293] Tranlsate quick-start-jp.md: status first Translate: quick-start-jp.md Fix bug Tranlsate the world web Change the method Translate tutorial/quick-start-jp.md Translate docs Translate Translate quick-start --- docs/tutorial/quick-start-jp.md | 131 ++++++++++++++++++++++++++++++++ 1 file changed, 131 insertions(+) create mode 100644 docs/tutorial/quick-start-jp.md diff --git a/docs/tutorial/quick-start-jp.md b/docs/tutorial/quick-start-jp.md new file mode 100644 index 000000000000..d64c5ae9a38f --- /dev/null +++ b/docs/tutorial/quick-start-jp.md @@ -0,0 +1,131 @@ +# クイックスタート + +## 導入 + +ElectronではリッチなネイティブAPIを持ったランタイムを提供することによってピュアなJavaScriptでデスクトップアプリケーションをつくることができます。ウェブサーバーの代わりにデスクトップアプリケーションに焦点をあてたio.jsランタイムであるといえばわかりやすいかもしれません。 + +ElectronはJavaScriptをGUIライブラリにバインディングしません。その代わりに、ElectronはウェブページをGUIとして使用します。なのでElectronはJavaScriptによってコントロールされる最小のChromiumブラウザでもあるともいえます。 + +### メインプロセス + +Electronでは、`package.json` の `main`で実行されるプロセスを __メインプロセス__ と呼びます。メインスクリプトではGUIにウェブページを表示することができるプロセスを実行します。 + +### レンダラープロセス + +Electronはウェブページを表示させるためにChromiumを使用しているので、Chromiumのマルチプロセスアーキテクチャが使用されることになります。Electronで実行されるウェブページはそれぞれ自身のプロセスで実行されます。それを __レンダラープロセス__ と呼びます。 + +通常、ブラウザのウェブページはサウンドボックス環境で実行されネイティブなリソースへのアクセスができません。Electronではウェブページからio.jsのAPIを使って、ネイティブリソースへの権限が与えられます。そのおかげでウェブページの中からJavaScriptを使って低レベルなオペレーティングシステムとのインタラクションが可能になります。 + +### メインプロセスとリレンダラープロセスの違い + +メインプロセスは `BrowserWindow` インスタンスを作ることによってウェブページをつくります。それぞれの `BrowserWindow` インスタンスはそれ自身の リレンダラープロセス上でウェブページを実行します。`BrowserWindow` インスタンスが破棄されると、対応するリレンダラープロセスも終了されます。 + +メインプロセスはすべてのウェブページとそれに対応するリレンダラープロセスを管理しています。それぞれのリレンダラープロセスは分離しているのでウェブページで実行されていることだけを気に留めておいてください。 + +ウェブページでは、GUI関連のAPIを呼ぶことはできません。なぜならば、ウェブページで管理しているネイティブのGUIリソースは非常に危険で簡単にリークしてしまうからです。もしウェブページ内でGUIを操作したい場合には、メインプロセスと通信をする必要があります。 + +Electronでは、メインプロセスとリレンダラープロセスとのコミュニケーションをするために[ipc](../api/ipc-renderer.md)モジュールを提供しています。またそれと、RPC形式の通信を行う[remote](../api/remote.md)モジュールもあります。 + +## Electronアプリを作成する + +一般的に Electronアプリの構成は次のようになります： + +```text +your-app/ +├── package.json +├── main.js +└── index.html +``` + +`package.json`の形式はNodeモジュールとまったく同じです。 `main`　フィールドでアプリを起動するためのスクリプトを特定し、メインプロセスで実行します。 `package.json`の例は次のようになります： + +```json +{ + "name" : "your-app", + "version" : "0.1.0", + "main" : "main.js" +} +``` + +`main.js` ではウィンドウを作成してシステムイベントを管理します。典型的な例は次のようになります： + +```javascript +var app = require('app'); // Module to control application life. +var BrowserWindow = require('browser-window'); // Module to create native browser window. + +// Report crashes to our server. +require('crash-reporter').start(); + +// Keep a global reference of the window object, if you don't, the window will +// be closed automatically when the javascript object is GCed. +var mainWindow = null; + +// Quit when all windows are closed. +app.on('window-all-closed', function() { + if (process.platform != 'darwin') { + app.quit(); + } +}); + +// This method will be called when Electron has done everything +// initialization and ready for creating browser windows. +app.on('ready', function() { + // Create the browser window. + mainWindow = new BrowserWindow({width: 800, height: 600}); + + // and load the index.html of the app. + mainWindow.loadUrl('file://' + __dirname + '/index.html'); + + // Open the devtools. + mainWindow.openDevTools(); + + // Emitted when the window is closed. + mainWindow.on('closed', function() { + // Dereference the window object, usually you would store windows + // in an array if your app supports multi windows, this is the time + // when you should delete the corresponding element. + mainWindow = null; + }); +}); +``` + +最後に表示するウェブページ`index.html`は次のようになります： + + +```html + + + + Hello World! + + +

Hello World!

+ We are using io.js + and Electron . + + +``` + +## アプリを実行する + +アプリケーションを作り終えたら、[Application distribution](./application-distribution.md)ガイドにしたがってディストリビューションを作成します、そしてパッケージされたアプリケーションとして配布することが可能です。またダウンロードしたElectronのバイナリをアプリケーション・ディレクトリを実行するために利用することもできます。 + +Windowsの場合： + +```bash +$ .\electron\electron.exe your-app\ +``` + +Linuxの場合： + +```bash +$ ./electron/electron your-app/ +``` + +OS Xの場合： + +```bash +$ ./Electron.app/Contents/MacOS/Electron your-app/ +``` + +`Electron.app` はElectronのリリースパッケージに含まれており、[ここ](https://github.com/atom/electron/releases) からダウンロードできます。 From c97c3fb9a1f28d56ba2b6cc7090ab438204ec78e Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 12 Jun 2015 13:54:42 +0800 Subject: [PATCH 0249/1293] Use LSGetApplicationForURL to search for app It costs less. --- atom/common/platform_util_mac.mm | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/atom/common/platform_util_mac.mm b/atom/common/platform_util_mac.mm index 4637bc330e31..a1f17d7c9d5c 100644 --- a/atom/common/platform_util_mac.mm +++ b/atom/common/platform_util_mac.mm @@ -122,15 +122,21 @@ bool OpenExternal(const GURL& url) { DCHECK([NSThread isMainThread]); NSString* url_string = base::SysUTF8ToNSString(url.spec()); NSURL* ns_url = [NSURL URLWithString:url_string]; - if (!ns_url){ + if (!ns_url) { return false; } - NSArray *appUrls = (NSArray*)LSCopyApplicationURLsForURL((CFURLRef)ns_url, kLSRolesAll); - if([appUrls count] > 0){ - if([[NSWorkspace sharedWorkspace] openURL:ns_url]) - return true; + + CFURLRef openingApp = NULL; + OSStatus status = LSGetApplicationForURL((CFURLRef)ns_url, + kLSRolesAll, + NULL, + &openingApp); + if (status != noErr) { + return false; } - return false; + CFRelease(openingApp); // NOT A BUG; LSGetApplicationForURL retains for us + + return [[NSWorkspace sharedWorkspace] openURL:ns_url]; } bool MoveItemToTrash(const base::FilePath& full_path) { From 16e224bb86318c6a9b96f2f0d5157898daa49a35 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 12 Jun 2015 16:23:26 +0800 Subject: [PATCH 0250/1293] Don't set browser_handles_all_top_level_requests POST requests currently can not be handled on browser side. Fix #1945. --- atom/browser/common_web_contents_delegate.cc | 7 ------- 1 file changed, 7 deletions(-) diff --git a/atom/browser/common_web_contents_delegate.cc b/atom/browser/common_web_contents_delegate.cc index eeb8d5748edc..087205d37d5b 100644 --- a/atom/browser/common_web_contents_delegate.cc +++ b/atom/browser/common_web_contents_delegate.cc @@ -16,7 +16,6 @@ #include "content/public/browser/child_process_security_policy.h" #include "content/public/browser/render_process_host.h" #include "content/public/browser/render_view_host.h" -#include "content/public/common/renderer_preferences.h" #include "storage/browser/fileapi/isolated_context.h" namespace atom { @@ -103,12 +102,6 @@ void CommonWebContentsDelegate::InitWithWebContents( owner_window_ = owner_window; web_contents->SetDelegate(this); - // Tell renderer to handle all navigations in browser. - auto preferences = web_contents->GetMutableRendererPrefs(); - preferences->browser_handles_non_local_top_level_requests = true; - preferences->browser_handles_all_top_level_requests = true; - web_contents->GetRenderViewHost()->SyncRendererPrefs(); - // Create InspectableWebContents. web_contents_.reset(brightray::InspectableWebContents::Create(web_contents)); web_contents_->SetDelegate(this); From 8b8a6aea748ebe4882e18d3c050975130ff6cb23 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 12 Jun 2015 16:26:51 +0800 Subject: [PATCH 0251/1293] Bump v0.28.1 --- atom.gyp | 2 +- atom/browser/resources/mac/Info.plist | 2 +- atom/browser/resources/win/atom.rc | 8 ++++---- atom/common/atom_version.h | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/atom.gyp b/atom.gyp index 3af90f0337ce..bb64d1d7aa74 100644 --- a/atom.gyp +++ b/atom.gyp @@ -4,7 +4,7 @@ 'product_name%': 'Electron', 'company_name%': 'GitHub, Inc', 'company_abbr%': 'github', - 'version%': '0.28.0', + 'version%': '0.28.1', 'atom_source_root': 'CFBundleIconFile atom.icns CFBundleVersion - 0.28.0 + 0.28.1 LSMinimumSystemVersion 10.8.0 NSMainNibFile diff --git a/atom/browser/resources/win/atom.rc b/atom/browser/resources/win/atom.rc index 9a01132b82dd..95c7fd25370b 100644 --- a/atom/browser/resources/win/atom.rc +++ b/atom/browser/resources/win/atom.rc @@ -50,8 +50,8 @@ END // VS_VERSION_INFO VERSIONINFO - FILEVERSION 0,28,0,0 - PRODUCTVERSION 0,28,0,0 + FILEVERSION 0,28,1,0 + PRODUCTVERSION 0,28,1,0 FILEFLAGSMASK 0x3fL #ifdef _DEBUG FILEFLAGS 0x1L @@ -68,12 +68,12 @@ BEGIN BEGIN VALUE "CompanyName", "GitHub, Inc." VALUE "FileDescription", "Electron" - VALUE "FileVersion", "0.28.0" + VALUE "FileVersion", "0.28.1" VALUE "InternalName", "electron.exe" VALUE "LegalCopyright", "Copyright (C) 2015 GitHub, Inc. All rights reserved." VALUE "OriginalFilename", "electron.exe" VALUE "ProductName", "Electron" - VALUE "ProductVersion", "0.28.0" + VALUE "ProductVersion", "0.28.1" VALUE "SquirrelAwareVersion", "1" END END diff --git a/atom/common/atom_version.h b/atom/common/atom_version.h index 3377653c3b7b..3d500e741038 100644 --- a/atom/common/atom_version.h +++ b/atom/common/atom_version.h @@ -7,7 +7,7 @@ #define ATOM_MAJOR_VERSION 0 #define ATOM_MINOR_VERSION 28 -#define ATOM_PATCH_VERSION 0 +#define ATOM_PATCH_VERSION 1 #define ATOM_VERSION_IS_RELEASE 1 From 7da3e843695b1222fe2b3dc942493270d4b2cd3e Mon Sep 17 00:00:00 2001 From: Benjamin Pasero Date: Fri, 12 Jun 2015 12:37:53 +0200 Subject: [PATCH 0252/1293] Update app.md to document how open-file is emitted On Mac, open-file is also emitted when the application is not yet running. --- docs/api/app.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/api/app.md b/docs/api/app.md index 31fa1c616101..2d0e82195484 100644 --- a/docs/api/app.md +++ b/docs/api/app.md @@ -62,9 +62,7 @@ Emitted when application is quitting. * `event` Event * `path` String -Emitted when user wants to open a file with the application, it usually -happens when the application is already opened and then OS wants to reuse the -application to open file. +Emitted when user wants to open a file with the application, it usually happens when the application is already opened and then OS wants to reuse the application to open file. But it is also emitted when a file is dropped onto the dock and the application is not yet running. Make sure to liste to open-file very early in your application startup to handle this case (even before the ready event is emitted). You should call `event.preventDefault()` if you want to handle this event. From 2b3a80ecda8d55b23f94250c12f0bfbe41ee0cd8 Mon Sep 17 00:00:00 2001 From: Johannes Schmitz Date: Sat, 13 Jun 2015 16:58:18 +0200 Subject: [PATCH 0253/1293] Add minor grammar fixes --- .../desktop-environment-integration.md | 28 +++++++++---------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/tutorial/desktop-environment-integration.md b/docs/tutorial/desktop-environment-integration.md index 5dee6fdf4ec3..0691b15f4091 100644 --- a/docs/tutorial/desktop-environment-integration.md +++ b/docs/tutorial/desktop-environment-integration.md @@ -1,17 +1,17 @@ # Desktop environment integration Different operating systems provide different features on integrating desktop -applications into their desktop environments, for example, on Windows +applications into their desktop environments. For example, on Windows applications can put shortcuts in the JumpList of task bar, and on Mac applications can put a custom menu in the dock menu. -This guide introduces how to integrate your application into those desktop +This guide explains how to integrate your application into those desktop environments with Electron APIs. ## Recent documents (Windows & OS X) -Windows and OS X have provided easy access to recent documents opened by the -application via JumpList and dock menu. +Windows and OS X provide easy access to a list of recent documents opened by +the application via JumpList and dock menu. __JumpList:__ @@ -39,12 +39,12 @@ app.clearRecentDocuments(); ### Windows notes In order to be able to use this feature on Windows, your application has to be -registered as handler of the file type of the document, otherwise the file won't -appear in JumpList even after you have added it. You can find everything on -registering your application in [Application Registration][app-registration]. +registered as a handler of the file type of the document, otherwise the file +won't appear in JumpList even after you have added it. You can find everything +on registering your application in [Application Registration][app-registration]. When a user clicks a file from JumpList, a new instance of your application will -be started with the path of file appended in command line. +be started with the path of the file added as a command line argument. ### OS X notes @@ -53,7 +53,7 @@ of `app` module would be emitted for it. ## Custom dock menu (OS X) -OS X enables developers to specify a custom menu for dock, which usually +OS X enables developers to specify a custom menu for the dock, which usually contains some shortcuts for commonly used features of your application: __Dock menu of Terminal.app:__ @@ -104,7 +104,7 @@ __Tasks of Internet Explorer:__ ![IE](http://i.msdn.microsoft.com/dynimg/IC420539.png) Unlike the dock menu in OS X which is a real menu, user tasks in Windows work -like application shortcuts that when user clicks a task a program would be +like application shortcuts that when user clicks a task, a program would be executed with specified arguments. To set user tasks for your application, you can use @@ -146,7 +146,7 @@ __Launcher shortcuts of Audacious:__ ## Progress bar in taskbar (Windows & Unity) On Windows, a taskbar button can be used to display a progress bar. This enables -a window to provide progress information to the user without that user having to +a window to provide progress information to the user without the user having to switch to the window itself. The Unity DE also has a similar feature that allows you to specify the progress @@ -171,11 +171,11 @@ window.setProgressBar(0.5); ## Represented file of window (OS X) On OS X a window can set its represented file, so the file's icon can show in -title bar, and when users Command-Click or Control-Click on the tile a path +the title bar, and when users Command-Click or Control-Click on the tile a path popup will show. -You can also set edited state of a window so the file icon can indicate whether -the document in this window has been modified. +You can also set the edited state of a window so that the file icon can indicate +whether the document in this window has been modified. __Represented file popup menu:__ From a5e2f8e79e5144e1a54353afdd1ea57c13abca00 Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Fri, 29 May 2015 21:24:00 +0530 Subject: [PATCH 0254/1293] protocol: adding requestHttpJob method --- atom/browser/api/atom_api_protocol.cc | 9 +++ atom/browser/api/lib/protocol.coffee | 4 + atom/browser/net/adapter_request_job.cc | 7 ++ atom/browser/net/adapter_request_job.h | 2 + atom/browser/net/url_request_fetch_job.cc | 90 +++++++++++++++++++++++ atom/browser/net/url_request_fetch_job.h | 57 ++++++++++++++ filenames.gypi | 4 +- spec/api-protocol-spec.coffee | 23 ++++++ 8 files changed, 195 insertions(+), 1 deletion(-) create mode 100644 atom/browser/net/url_request_fetch_job.cc create mode 100644 atom/browser/net/url_request_fetch_job.h diff --git a/atom/browser/api/atom_api_protocol.cc b/atom/browser/api/atom_api_protocol.cc index 083ea32b2010..eede89233201 100644 --- a/atom/browser/api/atom_api_protocol.cc +++ b/atom/browser/api/atom_api_protocol.cc @@ -8,6 +8,7 @@ #include "atom/browser/net/adapter_request_job.h" #include "atom/browser/net/atom_url_request_job_factory.h" #include "atom/common/native_mate_converters/file_path_converter.h" +#include "atom/common/native_mate_converters/gurl_converter.h" #include "content/public/browser/browser_thread.h" #include "native_mate/callback.h" #include "native_mate/dictionary.h" @@ -123,6 +124,14 @@ class CustomProtocolRequestJob : public AdapterRequestJob { base::Bind(&AdapterRequestJob::CreateErrorJobAndStart, GetWeakPtr(), error)); return; + } else if (name == "RequestHttpJob") { + GURL url; + dict.Get("url", &url); + + BrowserThread::PostTask(BrowserThread::IO, FROM_HERE, + base::Bind(&AdapterRequestJob::CreateHttpJobAndStart, + GetWeakPtr(), url)); + return; } } diff --git a/atom/browser/api/lib/protocol.coffee b/atom/browser/api/lib/protocol.coffee index c2db7800c08d..bbd2499a8371 100644 --- a/atom/browser/api/lib/protocol.coffee +++ b/atom/browser/api/lib/protocol.coffee @@ -34,4 +34,8 @@ protocol.RequestErrorJob = class RequestErrorJob constructor: (@error) -> +protocol.RequestHttpJob = +class RequestHttpJob + constructor: (@url) -> + module.exports = protocol diff --git a/atom/browser/net/adapter_request_job.cc b/atom/browser/net/adapter_request_job.cc index af3b02f150f4..258416e2f42a 100644 --- a/atom/browser/net/adapter_request_job.cc +++ b/atom/browser/net/adapter_request_job.cc @@ -4,8 +4,10 @@ #include "atom/browser/net/adapter_request_job.h" +#include "atom/browser/atom_browser_context.h" #include "base/threading/sequenced_worker_pool.h" #include "atom/browser/net/url_request_buffer_job.h" +#include "atom/browser/net/url_request_fetch_job.h" #include "atom/browser/net/url_request_string_job.h" #include "atom/browser/net/asar/url_request_asar_job.h" #include "atom/common/asar/asar_util.h" @@ -104,6 +106,11 @@ void AdapterRequestJob::CreateFileJobAndStart(const base::FilePath& path) { real_job_->Start(); } +void AdapterRequestJob::CreateHttpJobAndStart(const GURL& url) { + real_job_ = new URLRequestFetchJob(request(), network_delegate(), url); + real_job_->Start(); +} + void AdapterRequestJob::CreateJobFromProtocolHandlerAndStart() { real_job_ = protocol_handler_->MaybeCreateJob(request(), network_delegate()); diff --git a/atom/browser/net/adapter_request_job.h b/atom/browser/net/adapter_request_job.h index d87207464c08..1ecc82230b76 100644 --- a/atom/browser/net/adapter_request_job.h +++ b/atom/browser/net/adapter_request_job.h @@ -9,6 +9,7 @@ #include "base/memory/ref_counted_memory.h" #include "base/memory/weak_ptr.h" +#include "net/url_request/url_request_context.h" #include "net/url_request/url_request_job.h" #include "net/url_request/url_request_job_factory.h" #include "v8/include/v8.h" @@ -56,6 +57,7 @@ class AdapterRequestJob : public net::URLRequestJob { const std::string& charset, scoped_refptr data); void CreateFileJobAndStart(const base::FilePath& path); + void CreateHttpJobAndStart(const GURL& url); void CreateJobFromProtocolHandlerAndStart(); private: diff --git a/atom/browser/net/url_request_fetch_job.cc b/atom/browser/net/url_request_fetch_job.cc new file mode 100644 index 000000000000..081e85f28f32 --- /dev/null +++ b/atom/browser/net/url_request_fetch_job.cc @@ -0,0 +1,90 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#include "atom/browser/net/url_request_fetch_job.h" + +#include + +#include "atom/browser/atom_browser_context.h" +#include "net/base/io_buffer.h" +#include "net/base/net_errors.h" +#include "net/url_request/url_request_status.h" + +namespace atom { + +URLRequestFetchJob::URLRequestFetchJob( + net::URLRequest* request, + net::NetworkDelegate* network_delegate, + const GURL& url) + : net::URLRequestJob(request, network_delegate), + url_(url), + weak_ptr_factory_(this) {} + +URLRequestFetchJob::~URLRequestFetchJob() {} + +void URLRequestFetchJob::Start() { + net::URLFetcher* fetcher = net::URLFetcher::Create(url_, + net::URLFetcher::GET, + this); + auto context = AtomBrowserContext::Get()->url_request_context_getter(); + fetcher->SetRequestContext(context); + fetcher->SaveResponseWithWriter(scoped_ptr( + this)); + fetcher->Start(); +} + +void URLRequestFetchJob::Kill() { + weak_ptr_factory_.InvalidateWeakPtrs(); + URLRequestJob::Kill(); +} + +bool URLRequestFetchJob::ReadRawData(net::IOBuffer* dest, + int dest_size, + int* bytes_read) { + if (!dest_size) { + *bytes_read = 0; + return true; + } + + int to_read = dest_size < buffer_->BytesRemaining() ? + dest_size : buffer_->BytesRemaining(); + memcpy(dest->data(), buffer_->data(), to_read); + buffer_->DidConsume(to_read); + if (!buffer_->BytesRemaining()) { + NotifyReadComplete(buffer_->size()); + return true; + } + + *bytes_read = to_read; + return false; +} + +void URLRequestFetchJob::OnURLFetchComplete(const net::URLFetcher* source) { + if (!source->GetStatus().is_success()) + NotifyDone(net::URLRequestStatus(net::URLRequestStatus::FAILED, + source->GetResponseCode())); + + NotifyHeadersComplete(); +} + + +int URLRequestFetchJob::Initialize(const net::CompletionCallback& callback) { + if (buffer_) + buffer_->Release(); + return net::OK; +} + +int URLRequestFetchJob::Write(net::IOBuffer* buffer, + int num_bytes, + const net::CompletionCallback& calback) { + buffer_ = new net::DrainableIOBuffer(buffer, num_bytes); + set_expected_content_size(num_bytes); + return num_bytes; +} + +int URLRequestFetchJob::Finish(const net::CompletionCallback& callback) { + return net::OK; +} + +} // namespace atom diff --git a/atom/browser/net/url_request_fetch_job.h b/atom/browser/net/url_request_fetch_job.h new file mode 100644 index 000000000000..e955341c7d50 --- /dev/null +++ b/atom/browser/net/url_request_fetch_job.h @@ -0,0 +1,57 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#ifndef ATOM_BROWSER_NET_URL_REQUEST_FETCH_JOB_H_ +#define ATOM_BROWSER_NET_URL_REQUEST_FETCH_JOB_H_ + +#include "base/memory/ref_counted.h" +#include "base/memory/weak_ptr.h" +#include "net/base/io_buffer.h" +#include "net/url_request/url_fetcher.h" +#include "net/url_request/url_fetcher_delegate.h" +#include "net/url_request/url_fetcher_response_writer.h" +#include "net/url_request/url_request_job.h" + +namespace atom { + +class URLRequestFetchJob : public net::URLRequestJob, + public net::URLFetcherDelegate, + public net::URLFetcherResponseWriter { + public: + URLRequestFetchJob(net::URLRequest* request, + net::NetworkDelegate* network_delegate, + const GURL& url); + + // net::URLRequestJob: + void Start() override; + void Kill() override; + bool ReadRawData(net::IOBuffer* buf, + int buf_size, + int* bytes_read) override; + + // net::URLFetcherDelegate: + void OnURLFetchComplete(const net::URLFetcher* source) override; + + // net::URLFetchResponseWriter: + int Initialize(const net::CompletionCallback& callback) override; + int Write(net::IOBuffer* buffer, + int num_bytes, + const net::CompletionCallback& callback) override; + int Finish(const net::CompletionCallback& callback) override; + + protected: + virtual ~URLRequestFetchJob(); + + private: + GURL url_; + scoped_refptr buffer_; + + base::WeakPtrFactory weak_ptr_factory_; + + DISALLOW_COPY_AND_ASSIGN(URLRequestFetchJob); +}; + +} // namespace atom + +#endif // ATOM_BROWSER_NET_URL_REQUEST_FETCH_JOB_H_ diff --git a/filenames.gypi b/filenames.gypi index 6ece2ba634c7..ab523c188beb 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -147,11 +147,13 @@ 'atom/browser/net/atom_url_request_job_factory.cc', 'atom/browser/net/atom_url_request_job_factory.h', 'atom/browser/net/http_protocol_handler.cc', - 'atom/browser/net/http_protocol_handler.h', + 'atom/browser/net/http_protocol_handler.h', 'atom/browser/net/url_request_string_job.cc', 'atom/browser/net/url_request_string_job.h', 'atom/browser/net/url_request_buffer_job.cc', 'atom/browser/net/url_request_buffer_job.h', + 'atom/browser/net/url_request_fetch_job.cc', + 'atom/browser/net/url_request_fetch_job.h', 'atom/browser/ui/accelerator_util.cc', 'atom/browser/ui/accelerator_util.h', 'atom/browser/ui/accelerator_util_mac.mm', diff --git a/spec/api-protocol-spec.coffee b/spec/api-protocol-spec.coffee index 5a7bda16555d..e3cc98cd7c4e 100644 --- a/spec/api-protocol-spec.coffee +++ b/spec/api-protocol-spec.coffee @@ -1,5 +1,6 @@ assert = require 'assert' ipc = require 'ipc' +http = require 'http' path = require 'path' remote = require 'remote' protocol = remote.require 'protocol' @@ -73,6 +74,28 @@ describe 'protocol module', -> protocol.unregisterProtocol 'atom-error-job' done() + it 'returns RequestHttpJob should send respone', (done) -> + server = http.createServer (req, res) -> + res.writeHead(200, {'Content-Type': 'text/plain'}) + res.end('hello') + server.close() + server.listen 0, '127.0.0.1', -> + {port} = server.address() + url = "http://127.0.0.1:#{port}" + job = new protocol.RequestHttpJob(url) + handler = remote.createFunctionWithReturnValue job + protocol.registerProtocol 'atom-http-job', handler + + $.ajax + url: 'atom-http-job://fake-host' + success: (data) -> + assert.equal data, 'hello' + protocol.unregisterProtocol 'atom-http-job' + done() + error: (xhr, errorType, error) -> + assert false, 'Got error: ' + errorType + ' ' + error + protocol.unregisterProtocol 'atom-http-job' + it 'returns RequestBufferJob should send buffer', (done) -> data = new Buffer("hello") job = new protocol.RequestBufferJob(data: data) From 8aa559fe51beff28bc47be9138b461bed2a06779 Mon Sep 17 00:00:00 2001 From: Magica Date: Mon, 15 Jun 2015 21:40:49 +0800 Subject: [PATCH 0255/1293] Add setAudioMuted to webContents --- atom/browser/api/atom_api_web_contents.cc | 10 ++++++++++ atom/browser/api/atom_api_web_contents.h | 2 ++ atom/renderer/lib/web-view/web-view.coffee | 2 ++ docs/api/browser-window.md | 10 ++++++++++ docs/api/web-view-tag.md | 10 ++++++++++ 5 files changed, 34 insertions(+) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 029c098a8daa..ec24ab45fa24 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -580,6 +580,14 @@ void WebContents::UnregisterServiceWorker( callback); } +void WebContents::SetAudioMuted(bool muted) { + web_contents()->SetAudioMuted(muted); +} + +bool WebContents::IsAudioMuted() { + return web_contents()->IsAudioMuted(); +} + void WebContents::Undo() { web_contents()->Undo(); } @@ -731,6 +739,8 @@ mate::ObjectTemplateBuilder WebContents::GetObjectTemplateBuilder( .SetMethod("isDevToolsOpened", &WebContents::IsDevToolsOpened) .SetMethod("toggleDevTools", &WebContents::ToggleDevTools) .SetMethod("inspectElement", &WebContents::InspectElement) + .SetMethod("setAudioMuted", &WebContents::SetAudioMuted) + .SetMethod("isAudioMuted", &WebContents::IsAudioMuted) .SetMethod("undo", &WebContents::Undo) .SetMethod("redo", &WebContents::Redo) .SetMethod("cut", &WebContents::Cut) diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index 9e3016f5da8e..7c20144517f3 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -87,6 +87,8 @@ class WebContents : public mate::EventEmitter, void InspectServiceWorker(); void HasServiceWorker(const base::Callback&); void UnregisterServiceWorker(const base::Callback&); + void SetAudioMuted(bool muted); + bool IsAudioMuted(); // Editing commands. void Undo(); diff --git a/atom/renderer/lib/web-view/web-view.coffee b/atom/renderer/lib/web-view/web-view.coffee index a815dc6499dc..443b2bca1f2d 100644 --- a/atom/renderer/lib/web-view/web-view.coffee +++ b/atom/renderer/lib/web-view/web-view.coffee @@ -275,6 +275,8 @@ registerWebViewElement = -> "closeDevTools" "isDevToolsOpened" "inspectElement" + "setAudioMuted" + "isAudioMuted" "undo" "redo" "cut" diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 4211ac8020fd..11ac53096038 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -877,6 +877,16 @@ Injects CSS into this page. Evaluates `code` in page. +### WebContents.setAudioMuted(muted) + ++ `muted` Boolean + +Set the page muted. + +### WebContents.isAudioMuted() + +Returns whether this page has been muted. + ### WebContents.undo() Executes editing command `undo` in page. diff --git a/docs/api/web-view-tag.md b/docs/api/web-view-tag.md index c83994768478..4a227d769cb7 100644 --- a/docs/api/web-view-tag.md +++ b/docs/api/web-view-tag.md @@ -250,6 +250,16 @@ Starts inspecting element at position (`x`, `y`) of guest page. Opens the devtools for the service worker context present in the guest page. +### ``.setAudioMuted(muted) + ++ `muted` Boolean + +Set guest page muted. + +### ``.isAudioMuted() + +Returns whether guest page has been muted. + ### ``.undo() Executes editing command `undo` in page. From e96119fc3228e95d76020e6bc0e44d2c5faf50ef Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 16 Jun 2015 10:08:32 +0800 Subject: [PATCH 0256/1293] s/liste/listen --- docs/api/app.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/api/app.md b/docs/api/app.md index 2d0e82195484..d30c8c39c8a8 100644 --- a/docs/api/app.md +++ b/docs/api/app.md @@ -62,7 +62,12 @@ Emitted when application is quitting. * `event` Event * `path` String -Emitted when user wants to open a file with the application, it usually happens when the application is already opened and then OS wants to reuse the application to open file. But it is also emitted when a file is dropped onto the dock and the application is not yet running. Make sure to liste to open-file very early in your application startup to handle this case (even before the ready event is emitted). +Emitted when user wants to open a file with the application, it usually happens +when the application is already opened and then OS wants to reuse the +application to open file. But it is also emitted when a file is dropped onto the +dock and the application is not yet running. Make sure to listen to open-file +very early in your application startup to handle this case (even before the +`ready` event is emitted). You should call `event.preventDefault()` if you want to handle this event. From 8181e9a0ef2aad0551c5ce46ce63d77f27216be3 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 16 Jun 2015 13:38:21 +0800 Subject: [PATCH 0257/1293] Update brightray for #1941 --- vendor/brightray | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/brightray b/vendor/brightray index 7c6c530608e1..c5f37af149c2 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit 7c6c530608e17ee569edea3dc2607736f3cdb376 +Subproject commit c5f37af149c292cb1ab3f2f23771c0d1aa8ed253 From b03f44df10264c16f214ee4a42915788a73e6c31 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 16 Jun 2015 16:04:03 +0800 Subject: [PATCH 0258/1293] Update brightray for #1960 --- vendor/brightray | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/brightray b/vendor/brightray index c5f37af149c2..9541f111e9b0 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit c5f37af149c292cb1ab3f2f23771c0d1aa8ed253 +Subproject commit 9541f111e9b0cb8b157b717d2d053da4d2a4f050 From 193f95a888b644fd8e624e5bd8c4f7cde0e28b37 Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Mon, 15 Jun 2015 19:11:14 +0530 Subject: [PATCH 0259/1293] remote: handle circular reference in wrapArgs --- atom/renderer/api/lib/remote.coffee | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/atom/renderer/api/lib/remote.coffee b/atom/renderer/api/lib/remote.coffee index 4c4970f0932f..b159125b7949 100644 --- a/atom/renderer/api/lib/remote.coffee +++ b/atom/renderer/api/lib/remote.coffee @@ -5,18 +5,29 @@ CallbacksRegistry = require 'callbacks-registry' callbacksRegistry = new CallbacksRegistry +# Check for circular reference. +isCircular = (field, visited) -> + if typeof field is 'object' + if field in visited + return true + visited.push field + return false + # Convert the arguments object into an array of meta data. -wrapArgs = (args) -> +wrapArgs = (args, visited=[]) -> valueToMeta = (value) -> if Array.isArray value - type: 'array', value: wrapArgs(value) + type: 'array', value: wrapArgs(value, visited) else if Buffer.isBuffer value type: 'buffer', value: Array::slice.call(value, 0) else if value? and typeof value is 'object' and v8Util.getHiddenValue value, 'atomId' type: 'remote-object', id: v8Util.getHiddenValue value, 'atomId' else if value? and typeof value is 'object' ret = type: 'object', name: value.constructor.name, members: [] - ret.members.push(name: prop, value: valueToMeta(field)) for prop, field of value + for prop, field of value + ret.members.push + name: prop + value: valueToMeta(if isCircular(field, visited) then null else field) ret else if typeof value is 'function' and v8Util.getHiddenValue value, 'returnValue' type: 'function-with-return-value', value: valueToMeta(value()) From 7b3fc1402337ad142f3aed758a73d9ffad98857d Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 16 Jun 2015 16:13:46 +0800 Subject: [PATCH 0260/1293] docs: --ignore-connections-limit --- docs/api/chrome-command-line-switches.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/api/chrome-command-line-switches.md b/docs/api/chrome-command-line-switches.md index 0eaefbe1551c..62bfa2450ca0 100644 --- a/docs/api/chrome-command-line-switches.md +++ b/docs/api/chrome-command-line-switches.md @@ -19,6 +19,10 @@ app.on('ready', function() { Sets `path` of client certificate file. +## --ignore-connections-limit=`domains` + +Ignore the connections limit for `domains` list seperated by `,`. + ## --disable-http-cache Disables the disk cache for HTTP requests. From 44f8bfc550cb3fe0a103c2cdd3209a2741ebb2de Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 16 Jun 2015 17:08:53 +0800 Subject: [PATCH 0261/1293] Don't leak URLFetcher --- atom/browser/net/url_request_fetch_job.cc | 10 ++++------ atom/browser/net/url_request_fetch_job.h | 1 + 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/atom/browser/net/url_request_fetch_job.cc b/atom/browser/net/url_request_fetch_job.cc index 081e85f28f32..3f4ef0694e70 100644 --- a/atom/browser/net/url_request_fetch_job.cc +++ b/atom/browser/net/url_request_fetch_job.cc @@ -24,14 +24,12 @@ URLRequestFetchJob::URLRequestFetchJob( URLRequestFetchJob::~URLRequestFetchJob() {} void URLRequestFetchJob::Start() { - net::URLFetcher* fetcher = net::URLFetcher::Create(url_, - net::URLFetcher::GET, - this); + fetcher_.reset(net::URLFetcher::Create(url_, net::URLFetcher::GET, this)); auto context = AtomBrowserContext::Get()->url_request_context_getter(); - fetcher->SetRequestContext(context); - fetcher->SaveResponseWithWriter(scoped_ptr( + fetcher_->SetRequestContext(context); + fetcher_->SaveResponseWithWriter(scoped_ptr( this)); - fetcher->Start(); + fetcher_->Start(); } void URLRequestFetchJob::Kill() { diff --git a/atom/browser/net/url_request_fetch_job.h b/atom/browser/net/url_request_fetch_job.h index e955341c7d50..69726f9db45b 100644 --- a/atom/browser/net/url_request_fetch_job.h +++ b/atom/browser/net/url_request_fetch_job.h @@ -45,6 +45,7 @@ class URLRequestFetchJob : public net::URLRequestJob, private: GURL url_; + scoped_ptr fetcher_; scoped_refptr buffer_; base::WeakPtrFactory weak_ptr_factory_; From b360f7d86a3b00be4235057e971c25d9948edaf7 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Sun, 31 May 2015 10:24:45 +0800 Subject: [PATCH 0262/1293] Add printToPDF API skeleton. --- atom/browser/api/atom_api_window.cc | 5 +++++ atom/browser/api/atom_api_window.h | 1 + atom/browser/native_window.cc | 3 +++ atom/browser/native_window.h | 3 +++ 4 files changed, 12 insertions(+) diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index 7461bc736855..00a0bb464089 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -430,6 +430,10 @@ void Window::Print(mate::Arguments* args) { window_->Print(settings.silent, settings.print_background); } +void Window::PrintToPDF() { + window_->PrintToPDF(); +} + void Window::SetProgressBar(double progress) { window_->SetProgressBar(progress); } @@ -542,6 +546,7 @@ void Window::BuildPrototype(v8::Isolate* isolate, .SetMethod("isWebViewFocused", &Window::IsWebViewFocused) .SetMethod("capturePage", &Window::CapturePage) .SetMethod("print", &Window::Print) + .SetMethod("printToPDF", &Window::PrintToPDF) .SetMethod("setProgressBar", &Window::SetProgressBar) .SetMethod("setOverlayIcon", &Window::SetOverlayIcon) .SetMethod("_setMenu", &Window::SetMenu) diff --git a/atom/browser/api/atom_api_window.h b/atom/browser/api/atom_api_window.h index 43a32e86f45a..606fda9f7dc3 100644 --- a/atom/browser/api/atom_api_window.h +++ b/atom/browser/api/atom_api_window.h @@ -132,6 +132,7 @@ class Window : public mate::EventEmitter, bool IsDocumentEdited(); void CapturePage(mate::Arguments* args); void Print(mate::Arguments* args); + void PrintToPDF(); void SetProgressBar(double progress); void SetOverlayIcon(const gfx::Image& overlay, const std::string& description); diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 8eb05cb9b0f2..f0198996668d 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -262,6 +262,9 @@ void NativeWindow::Print(bool silent, bool print_background) { PrintNow(silent, print_background); } +void NativeWindow::PrintToPDF() { +} + void NativeWindow::ShowDefinitionForSelection() { NOTIMPLEMENTED(); } diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index 2038775f8d9a..5c99a2c117b5 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -157,6 +157,9 @@ class NativeWindow : public CommonWebContentsDelegate, // Print current page. virtual void Print(bool silent, bool print_background); + // Print current page as PDF. + virtual void PrintToPDF(); + // Show popup dictionary. virtual void ShowDefinitionForSelection(); From 7ffa7042b1c6becad7e20e8fb8f9d182b575475c Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Sun, 31 May 2015 11:01:35 +0800 Subject: [PATCH 0263/1293] Add printToPDF Implementation. --- atom/browser/native_window.cc | 5 + .../printing/print_preview_message_handler.cc | 237 +++++++++ .../printing/print_preview_message_handler.h | 70 +++ .../printing/printing_message_filter.cc | 55 ++ .../printing/printing_message_filter.h | 9 + chromium_src/chrome/common/print_messages.h | 85 +++ .../printing/print_web_view_helper.cc | 490 ++++++++++++++++++ .../renderer/printing/print_web_view_helper.h | 159 ++++++ .../printing/print_web_view_helper_pdf_win.cc | 2 - filenames.gypi | 2 + 10 files changed, 1112 insertions(+), 2 deletions(-) create mode 100644 chromium_src/chrome/browser/printing/print_preview_message_handler.cc create mode 100644 chromium_src/chrome/browser/printing/print_preview_message_handler.h diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index f0198996668d..9b922dc9b5b0 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -28,6 +28,8 @@ #include "brightray/browser/inspectable_web_contents.h" #include "brightray/browser/inspectable_web_contents_view.h" #include "chrome/browser/printing/print_view_manager_basic.h" +#include "chrome/browser/printing/print_preview_message_handler.h" +#include "chrome/browser/ui/browser_dialogs.h" #include "content/browser/renderer_host/render_widget_host_impl.h" #include "content/public/browser/navigation_entry.h" #include "content/public/browser/notification_details.h" @@ -97,6 +99,7 @@ NativeWindow::NativeWindow(content::WebContents* web_contents, zoom_factor_(1.0), weak_factory_(this) { printing::PrintViewManagerBasic::CreateForWebContents(web_contents); + printing::PrintPreviewMessageHandler::CreateForWebContents(web_contents); InitWithWebContents(web_contents, this); @@ -263,6 +266,8 @@ void NativeWindow::Print(bool silent, bool print_background) { } void NativeWindow::PrintToPDF() { + printing::PrintPreviewMessageHandler::FromWebContents(GetWebContents())-> + HandleGetPreview(NULL); } void NativeWindow::ShowDefinitionForSelection() { diff --git a/chromium_src/chrome/browser/printing/print_preview_message_handler.cc b/chromium_src/chrome/browser/printing/print_preview_message_handler.cc new file mode 100644 index 000000000000..6cc47e90876f --- /dev/null +++ b/chromium_src/chrome/browser/printing/print_preview_message_handler.cc @@ -0,0 +1,237 @@ +// Copyright (c) 2012 The Chromium Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. + +#include "chrome/browser/printing/print_preview_message_handler.h" + +#include + +#include "atom/browser/ui/file_dialog.h" +#include "atom/browser/native_window.h" +#include "base/bind.h" +#include "base/json/json_reader.h" +#include "base/memory/ref_counted.h" +#include "base/memory/ref_counted_memory.h" +#include "base/memory/shared_memory.h" +#include "chrome/browser/browser_process.h" +#include "chrome/browser/printing/print_job_manager.h" +#include "chrome/browser/printing/printer_query.h" +#include "chrome/common/print_messages.h" +#include "content/public/browser/browser_thread.h" +#include "content/public/browser/render_view_host.h" +#include "content/public/browser/web_contents.h" +#include "content/public/browser/web_ui.h" +#include "printing/page_size_margins.h" +#include "printing/print_job_constants.h" +#include "printing/pdf_metafile_skia.h" + +using content::BrowserThread; +using content::WebContents; + +DEFINE_WEB_CONTENTS_USER_DATA_KEY(printing::PrintPreviewMessageHandler); + +namespace { + +void StopWorker(int document_cookie) { + if (document_cookie <= 0) + return; + scoped_refptr queue = + g_browser_process->print_job_manager()->queue(); + scoped_refptr printer_query = + queue->PopPrinterQuery(document_cookie); + if (printer_query.get()) { + BrowserThread::PostTask(BrowserThread::IO, FROM_HERE, + base::Bind(&printing::PrinterQuery::StopWorker, + printer_query)); + } +} + +base::RefCountedBytes* GetDataFromHandle(base::SharedMemoryHandle handle, + uint32 data_size) { + scoped_ptr shared_buf( + new base::SharedMemory(handle, true)); + if (!shared_buf->Map(data_size)) { + NOTREACHED(); + return NULL; + } + + unsigned char* data_begin = static_cast(shared_buf->memory()); + std::vector data(data_begin, data_begin + data_size); + return base::RefCountedBytes::TakeVector(&data); +} + +} // namespace + +namespace printing { + +PrintPreviewMessageHandler::PrintPreviewMessageHandler( + WebContents* web_contents) + : content::WebContentsObserver(web_contents) { + DCHECK(web_contents); +} + +PrintPreviewMessageHandler::~PrintPreviewMessageHandler() { +} + +void PrintPreviewMessageHandler::OnDidGetPreviewPageCount( + const PrintHostMsg_DidGetPreviewPageCount_Params& params) { + if (params.page_count <= 0) { + NOTREACHED(); + return; + } + + LOG(ERROR) << "OnDidGetPreviewPageCount: " << params.page_count; +} + +void PrintPreviewMessageHandler::OnDidPreviewPage( + const PrintHostMsg_DidPreviewPage_Params& params) { + int page_number = params.page_number; + if (page_number < FIRST_PAGE_INDEX || !params.data_size) + return; + LOG(ERROR) << "OnDidPreviewPage: " << params.data_size; +} + +void PrintPreviewMessageHandler::OnMetafileReadyForPrinting( + const PrintHostMsg_DidPreviewDocument_Params& params) { + // Always try to stop the worker. + StopWorker(params.document_cookie); + + if (params.expected_pages_count <= 0) { + NOTREACHED(); + return; + } + + // TODO(joth): This seems like a good match for using RefCountedStaticMemory + // to avoid the memory copy, but the SetPrintPreviewData call chain below + // needs updating to accept the RefCountedMemory* base class. + scoped_refptr data( + GetDataFromHandle(params.metafile_data_handle, params.data_size)); + if (!data || !data->size()) + return; + + LOG(ERROR) << params.preview_request_id; + atom::NativeWindow* window = atom::NativeWindow::FromWebContents( + web_contents()); + base::FilePath save_path; + file_dialog::ShowSaveDialog(window, "Save As", + base::FilePath(FILE_PATH_LITERAL("print.pdf")), + file_dialog::Filters(), &save_path); + printing::PdfMetafileSkia metafile; + metafile.InitFromData(static_cast(data->front()), data->size()); + base::File file(save_path, + base::File::FLAG_CREATE_ALWAYS | base::File::FLAG_WRITE); + metafile.SaveTo(&file); +} + +//void PrintPreviewMessageHandler::OnPrintPreviewFailed(int document_cookie) { + //StopWorker(document_cookie); + + ////PrintPreviewUI* print_preview_ui = GetPrintPreviewUI(); + ////if (!print_preview_ui) + ////return; + ////print_preview_ui->OnPrintPreviewFailed(); +//} + +//void PrintPreviewMessageHandler::OnDidGetDefaultPageLayout( + //const PageSizeMargins& page_layout_in_points, + //const gfx::Rect& printable_area_in_points, + //bool has_custom_page_size_style) { + ////PrintPreviewUI* print_preview_ui = GetPrintPreviewUI(); + ////if (!print_preview_ui) + ////return; + ////print_preview_ui->OnDidGetDefaultPageLayout(page_layout_in_points, + ////printable_area_in_points, + ////has_custom_page_size_style); +//} + +//void PrintPreviewMessageHandler::OnPrintPreviewCancelled(int document_cookie) { + //// Always need to stop the worker. + //StopWorker(document_cookie); +//} + +//void PrintPreviewMessageHandler::OnInvalidPrinterSettings(int document_cookie) { + //StopWorker(document_cookie); + ////PrintPreviewUI* print_preview_ui = GetPrintPreviewUI(); + ////if (!print_preview_ui) + ////return; + ////print_preview_ui->OnInvalidPrinterSettings(); +//} + +//void PrintPreviewMessageHandler::OnSetOptionsFromDocument( + //const PrintHostMsg_SetOptionsFromDocument_Params& params) { + ////PrintPreviewUI* print_preview_ui = GetPrintPreviewUI(); + ////if (!print_preview_ui) + ////return; + ////print_preview_ui->OnSetOptionsFromDocument(params); +//} + +bool PrintPreviewMessageHandler::OnMessageReceived( + const IPC::Message& message) { + bool handled = true; + IPC_BEGIN_MESSAGE_MAP(PrintPreviewMessageHandler, message) + IPC_MESSAGE_HANDLER(PrintHostMsg_DidGetPreviewPageCount, + OnDidGetPreviewPageCount) + IPC_MESSAGE_HANDLER(PrintHostMsg_DidPreviewPage, + OnDidPreviewPage) + IPC_MESSAGE_HANDLER(PrintHostMsg_MetafileReadyForPrinting, + OnMetafileReadyForPrinting) + //IPC_MESSAGE_HANDLER(PrintHostMsg_PrintPreviewFailed, + //OnPrintPreviewFailed) + //IPC_MESSAGE_HANDLER(PrintHostMsg_DidGetDefaultPageLayout, + //OnDidGetDefaultPageLayout) + //IPC_MESSAGE_HANDLER(PrintHostMsg_PrintPreviewCancelled, + //OnPrintPreviewCancelled) + //IPC_MESSAGE_HANDLER(PrintHostMsg_PrintPreviewInvalidPrinterSettings, + //OnInvalidPrinterSettings) + //IPC_MESSAGE_HANDLER(PrintHostMsg_SetOptionsFromDocument, + //OnSetOptionsFromDocument) + IPC_MESSAGE_UNHANDLED(handled = false) + IPC_END_MESSAGE_MAP() + return handled; +} + +void PrintPreviewMessageHandler::HandleGetPreview(const base::ListValue* args) { + static int request_id = 0; + request_id++; + // A simulated Chromium print preivew setting. + const std::string setting_json_str = "{ \ + \"pageRage\":[], \ + \"mediaSize\":{ \ + \"height_microns\":297000, \ + \"is_default\":true, \ + \"name\":\"ISO_A4\", \ + \"width_microns\":210000, \ + \"custom_display_name\":\"A4\" \ + }, \ + \"landscape\":true, \ + \"color\":2, \ + \"headerFooterEnabled\":false, \ + \"marginsType\":0, \ + \"isFirstRequest\":false, \ + \"requestID\":1, \ + \"previewModifiable\":true, \ + \"printToPDF\":true, \ + \"printWithCloudPrint\":false, \ + \"printWithPrivet\":false, \ + \"printWithExtension\":false, \ + \"deviceName\":\"Save as PDF\", \ + \"generateDraftData\":true, \ + \"fitToPageEnabled\":false, \ + \"duplex\":0, \ + \"copies\":1, \ + \"collate\":true, \ + \"shouldPrintBackgrounds\":true, \ + \"shouldPrintSelectionOnly\":false \ + }"; + + scoped_ptr settings( + static_cast( + base::JSONReader::Read(setting_json_str))); + settings->SetInteger(printing::kPreviewRequestID, request_id); + + LOG(ERROR) << "Print preview request start"; + content::RenderViewHost* rvh = web_contents()->GetRenderViewHost(); + rvh->Send(new PrintMsg_PrintPreview(rvh->GetRoutingID(), *settings)); +} + +} // namespace printing diff --git a/chromium_src/chrome/browser/printing/print_preview_message_handler.h b/chromium_src/chrome/browser/printing/print_preview_message_handler.h new file mode 100644 index 000000000000..8f9f1b4ed230 --- /dev/null +++ b/chromium_src/chrome/browser/printing/print_preview_message_handler.h @@ -0,0 +1,70 @@ +// Copyright (c) 2012 The Chromium Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. + +#ifndef CHROME_BROWSER_PRINTING_PRINT_PREVIEW_MESSAGE_HANDLER_H_ +#define CHROME_BROWSER_PRINTING_PRINT_PREVIEW_MESSAGE_HANDLER_H_ + +#include "base/compiler_specific.h" +#include "content/public/browser/web_contents_observer.h" +#include "content/public/browser/web_contents_user_data.h" + +struct PrintHostMsg_DidGetPreviewPageCount_Params; +struct PrintHostMsg_DidPreviewDocument_Params; +struct PrintHostMsg_DidPreviewPage_Params; + +namespace content { +class WebContents; +} + +namespace gfx { +class Rect; +} + +namespace printing { + +struct PageSizeMargins; + +// Manages the print preview handling for a WebContents. +class PrintPreviewMessageHandler + : public content::WebContentsObserver, + public content::WebContentsUserData { + public: + ~PrintPreviewMessageHandler() override; + + // content::WebContentsObserver implementation. + bool OnMessageReceived(const IPC::Message& message) override; + + // Asks the initiator renderer to generate a preview. First element of |args| + // is a job settings JSON string. + void HandleGetPreview(const base::ListValue* args); + + private: + explicit PrintPreviewMessageHandler(content::WebContents* web_contents); + friend class content::WebContentsUserData; + + + // Message handlers. + //void OnRequestPrintPreview( + //const PrintHostMsg_RequestPrintPreview_Params& params); + //void OnDidGetDefaultPageLayout( + //const printing::PageSizeMargins& page_layout_in_points, + //const gfx::Rect& printable_area_in_points, + //bool has_custom_page_size_style); + void OnDidGetPreviewPageCount( + const PrintHostMsg_DidGetPreviewPageCount_Params& params); + void OnDidPreviewPage(const PrintHostMsg_DidPreviewPage_Params& params); + void OnMetafileReadyForPrinting( + const PrintHostMsg_DidPreviewDocument_Params& params); + //void OnPrintPreviewFailed(int document_cookie); + //void OnPrintPreviewCancelled(int document_cookie); + //void OnInvalidPrinterSettings(int document_cookie); + //void OnSetOptionsFromDocument( + //const PrintHostMsg_SetOptionsFromDocument_Params& params); + + DISALLOW_COPY_AND_ASSIGN(PrintPreviewMessageHandler); +}; + +} // namespace printing + +#endif // CHROME_BROWSER_PRINTING_PRINT_PREVIEW_MESSAGE_HANDLER_H_ diff --git a/chromium_src/chrome/browser/printing/printing_message_filter.cc b/chromium_src/chrome/browser/printing/printing_message_filter.cc index 15ca50fba53f..6fd536ef68c3 100644 --- a/chromium_src/chrome/browser/printing/printing_message_filter.cc +++ b/chromium_src/chrome/browser/printing/printing_message_filter.cc @@ -128,6 +128,8 @@ bool PrintingMessageFilter::OnMessageReceived(const IPC::Message& message) { IPC_MESSAGE_HANDLER_DELAY_REPLY(PrintHostMsg_GetDefaultPrintSettings, OnGetDefaultPrintSettings) IPC_MESSAGE_HANDLER_DELAY_REPLY(PrintHostMsg_ScriptedPrint, OnScriptedPrint) + IPC_MESSAGE_HANDLER_DELAY_REPLY(PrintHostMsg_UpdatePrintSettings, + OnUpdatePrintSettings) #if defined(ENABLE_FULL_PRINTING) IPC_MESSAGE_HANDLER(PrintHostMsg_CheckForCancel, OnCheckForCancel) #endif @@ -372,4 +374,57 @@ void PrintingMessageFilter::UpdateFileDescriptor(int render_view_id, int fd) { } #endif +void PrintingMessageFilter::OnUpdatePrintSettings( + int document_cookie, const base::DictionaryValue& job_settings, + IPC::Message* reply_msg) { + scoped_ptr new_settings(job_settings.DeepCopy()); + + scoped_refptr printer_query; + printer_query = queue_->PopPrinterQuery(document_cookie); + if (!printer_query.get()) { + int host_id = render_process_id_; + int routing_id = reply_msg->routing_id(); + if (!new_settings->GetInteger(printing::kPreviewInitiatorHostId, + &host_id) || + !new_settings->GetInteger(printing::kPreviewInitiatorRoutingId, + &routing_id)) { + host_id = content::ChildProcessHost::kInvalidUniqueID; + routing_id = content::ChildProcessHost::kInvalidUniqueID; + } + printer_query = queue_->CreatePrinterQuery(host_id, routing_id); + } + printer_query->SetSettings( + new_settings.Pass(), + base::Bind(&PrintingMessageFilter::OnUpdatePrintSettingsReply, this, + printer_query, reply_msg)); +} + +void PrintingMessageFilter::OnUpdatePrintSettingsReply( + scoped_refptr printer_query, + IPC::Message* reply_msg) { + PrintMsg_PrintPages_Params params; + if (!printer_query.get() || + printer_query->last_status() != PrintingContext::OK) { + params.Reset(); + } else { + RenderParamsFromPrintSettings(printer_query->settings(), ¶ms.params); + params.params.document_cookie = printer_query->cookie(); + params.pages = PageRange::GetPages(printer_query->settings().ranges()); + } + PrintHostMsg_UpdatePrintSettings::WriteReplyParams( + reply_msg, + params, + printer_query.get() && + (printer_query->last_status() == printing::PrintingContext::CANCEL)); + Send(reply_msg); + // If user hasn't cancelled. + if (printer_query.get()) { + if (printer_query->cookie() && printer_query->settings().dpi()) { + queue_->QueuePrinterQuery(printer_query.get()); + } else { + printer_query->StopWorker(); + } + } +} + } // namespace printing diff --git a/chromium_src/chrome/browser/printing/printing_message_filter.h b/chromium_src/chrome/browser/printing/printing_message_filter.h index 410b6245786d..624b28fd35dd 100644 --- a/chromium_src/chrome/browser/printing/printing_message_filter.h +++ b/chromium_src/chrome/browser/printing/printing_message_filter.h @@ -96,6 +96,15 @@ class PrintingMessageFilter : public content::BrowserMessageFilter { void OnScriptedPrintReply(scoped_refptr printer_query, IPC::Message* reply_msg); + // Modify the current print settings based on |job_settings|. The task is + // handled by the print worker thread and the UI thread. The reply occurs on + // the IO thread. + void OnUpdatePrintSettings(int document_cookie, + const base::DictionaryValue& job_settings, + IPC::Message* reply_msg); + void OnUpdatePrintSettingsReply(scoped_refptr printer_query, + IPC::Message* reply_msg); + #if defined(ENABLE_FULL_PRINTING) // Check to see if print preview has been cancelled. void OnCheckForCancel(int32 preview_ui_id, diff --git a/chromium_src/chrome/common/print_messages.h b/chromium_src/chrome/common/print_messages.h index 4a54546b69d7..2e6d23771676 100644 --- a/chromium_src/chrome/common/print_messages.h +++ b/chromium_src/chrome/common/print_messages.h @@ -46,7 +46,9 @@ struct PrintMsg_Print_Params { int document_cookie; bool selection_only; bool supports_alpha_blend; + int preview_request_id; blink::WebPrintScalingOption print_scaling_option; + bool print_to_pdf; base::string16 title; base::string16 url; bool should_print_backgrounds; @@ -185,6 +187,61 @@ IPC_STRUCT_BEGIN(PrintHostMsg_ScriptedPrint_Params) IPC_STRUCT_MEMBER(printing::MarginType, margin_type) IPC_STRUCT_END() +// Parameters to describe a rendered preview page. +IPC_STRUCT_BEGIN(PrintHostMsg_DidPreviewPage_Params) + // A shared memory handle to metafile data for a draft document of the page. + IPC_STRUCT_MEMBER(base::SharedMemoryHandle, metafile_data_handle) + + // Size of metafile data. + IPC_STRUCT_MEMBER(uint32, data_size) + + // |page_number| is zero-based and can be |printing::INVALID_PAGE_INDEX| if it + // is just a check. + IPC_STRUCT_MEMBER(int, page_number) + + // The id of the preview request. + IPC_STRUCT_MEMBER(int, preview_request_id) +IPC_STRUCT_END() + +// Parameters sent along with the page count. +IPC_STRUCT_BEGIN(PrintHostMsg_DidGetPreviewPageCount_Params) + // Cookie for the document to ensure correctness. + IPC_STRUCT_MEMBER(int, document_cookie) + + // Total page count. + IPC_STRUCT_MEMBER(int, page_count) + + // Indicates whether the previewed document is modifiable. + IPC_STRUCT_MEMBER(bool, is_modifiable) + + // The id of the preview request. + IPC_STRUCT_MEMBER(int, preview_request_id) + + // Indicates whether the existing preview data needs to be cleared or not. + IPC_STRUCT_MEMBER(bool, clear_preview_data) +IPC_STRUCT_END() + +// Parameters to describe a rendered document. +IPC_STRUCT_BEGIN(PrintHostMsg_DidPreviewDocument_Params) + // A shared memory handle to metafile data. + IPC_STRUCT_MEMBER(base::SharedMemoryHandle, metafile_data_handle) + + // Size of metafile data. + IPC_STRUCT_MEMBER(uint32, data_size) + + // Cookie for the document to ensure correctness. + IPC_STRUCT_MEMBER(int, document_cookie) + + // Store the expected pages count. + IPC_STRUCT_MEMBER(int, expected_pages_count) + + // Whether the preview can be modified. + IPC_STRUCT_MEMBER(bool, modifiable) + + // The id of the preview request. + IPC_STRUCT_MEMBER(int, preview_request_id) +IPC_STRUCT_END() + // Messages sent from the browser to the renderer. @@ -198,6 +255,12 @@ IPC_MESSAGE_ROUTED2(PrintMsg_PrintPages, IPC_MESSAGE_ROUTED1(PrintMsg_PrintingDone, bool /* success */) +// Tells the render view to switch the CSS to print media type, renders every +// requested pages for print preview using the given |settings|. This gets +// called multiple times as the user updates settings. +IPC_MESSAGE_ROUTED1(PrintMsg_PrintPreview, + base::DictionaryValue /* settings */) + // Messages sent from the renderer to the browser. #if defined(OS_WIN) @@ -231,6 +294,14 @@ IPC_MESSAGE_ROUTED1(PrintHostMsg_DidPrintPage, IPC_SYNC_MESSAGE_ROUTED0_1(PrintHostMsg_GetDefaultPrintSettings, PrintMsg_Print_Params /* default_settings */) +// The renderer wants to update the current print settings with new +// |job_settings|. +IPC_SYNC_MESSAGE_ROUTED2_2(PrintHostMsg_UpdatePrintSettings, + int /* document_cookie */, + base::DictionaryValue /* job_settings */, + PrintMsg_PrintPages_Params /* current_settings */, + bool /* canceled */) + // It's the renderer that controls the printing process when it is generated // by javascript. This step is about showing UI to the user to select the // final print settings. The output parameter is the same as @@ -247,6 +318,20 @@ IPC_MESSAGE_ROUTED0(PrintHostMsg_ShowInvalidPrinterSettingsError) IPC_MESSAGE_ROUTED1(PrintHostMsg_PrintingFailed, int /* document cookie */) +// Notify the browser a print preview page has been rendered. +IPC_MESSAGE_ROUTED1(PrintHostMsg_DidPreviewPage, + PrintHostMsg_DidPreviewPage_Params /* params */) + +// Sends back to the browser the complete rendered document (non-draft mode, +// used for printing) that was requested by a PrintMsg_PrintPreview message. +// The memory handle in this message is already valid in the browser process. +IPC_MESSAGE_ROUTED1(PrintHostMsg_MetafileReadyForPrinting, + PrintHostMsg_DidPreviewDocument_Params /* params */) + +// Notify the browser the number of pages in the print preview document. +IPC_MESSAGE_ROUTED1(PrintHostMsg_DidGetPreviewPageCount, + PrintHostMsg_DidGetPreviewPageCount_Params /* params */) + #if defined(OS_WIN) // Tell the utility process to start rendering the given PDF into a metafile. diff --git a/chromium_src/chrome/renderer/printing/print_web_view_helper.cc b/chromium_src/chrome/renderer/printing/print_web_view_helper.cc index 60158f6c1d4c..82a7b54fc2c5 100644 --- a/chromium_src/chrome/renderer/printing/print_web_view_helper.cc +++ b/chromium_src/chrome/renderer/printing/print_web_view_helper.cc @@ -650,6 +650,7 @@ bool PrintWebViewHelper::OnMessageReceived(const IPC::Message& message) { IPC_BEGIN_MESSAGE_MAP(PrintWebViewHelper, message) IPC_MESSAGE_HANDLER(PrintMsg_PrintPages, OnPrintPages) IPC_MESSAGE_HANDLER(PrintMsg_PrintingDone, OnPrintingDone) + IPC_MESSAGE_HANDLER(PrintMsg_PrintPreview, OnPrintPreview) IPC_MESSAGE_UNHANDLED(handled = false) IPC_END_MESSAGE_MAP() return handled; @@ -712,6 +713,157 @@ void PrintWebViewHelper::OnPrintingDone(bool success) { DidFinishPrinting(success ? OK : FAIL_PRINT); } +void PrintWebViewHelper::OnPrintPreview(const base::DictionaryValue& settings) { + blink::WebLocalFrame* frame; + if (GetPrintFrame(&frame)) { + print_preview_context_.InitWithFrame(frame); + LOG(ERROR) << "OnPrintPreview1"; + if (!print_preview_context_.source_frame()) { + DidFinishPrinting(FAIL_PREVIEW); + return; + } + + LOG(ERROR) << "OnPrintPreview2"; + //SetPrintPagesParams(settings) + if (!UpdatePrintSettings(print_preview_context_.source_frame(), + print_preview_context_.source_node(), settings)) { + DidFinishPrinting(FAIL_PREVIEW); + return; + } + LOG(ERROR) << "OnPrintPreview3"; + is_print_ready_metafile_sent_ = false; + PrepareFrameForPreviewDocument(); + } +} + +void PrintWebViewHelper::PrepareFrameForPreviewDocument() { + reset_prep_frame_view_ = false; + + if (!print_pages_params_) { + DidFinishPrinting(FAIL_PREVIEW); + return; + } + + // Don't reset loading frame or WebKit will fail assert. Just retry when + // current selection is loaded. + if (prep_frame_view_ && prep_frame_view_->IsLoadingSelection()) { + reset_prep_frame_view_ = true; + return; + } + + const PrintMsg_Print_Params& print_params = print_pages_params_->params; + prep_frame_view_.reset(new PrepareFrameAndViewForPrint( + print_params, print_preview_context_.source_frame(), + print_preview_context_.source_node(), ignore_css_margins_)); + prep_frame_view_->CopySelectionIfNeeded( + render_view()->GetWebkitPreferences(), + base::Bind(&PrintWebViewHelper::OnFramePreparedForPreviewDocument, + base::Unretained(this))); +} + +void PrintWebViewHelper::OnFramePreparedForPreviewDocument() { + if (reset_prep_frame_view_) { + PrepareFrameForPreviewDocument(); + return; + } + DidFinishPrinting(CreatePreviewDocument() ? OK : FAIL_PREVIEW); +} + +bool PrintWebViewHelper::CreatePreviewDocument() { + if (!print_pages_params_) + return false; + + const PrintMsg_Print_Params& print_params = print_pages_params_->params; + const std::vector& pages = print_pages_params_->pages; + + if (!print_preview_context_.CreatePreviewDocument(prep_frame_view_.release(), + pages)) { + return false; + } + + PageSizeMargins default_page_layout; + ComputePageLayoutInPointsForCss(print_preview_context_.prepared_frame(), 0, + print_params, ignore_css_margins_, NULL, + &default_page_layout); + + //bool has_page_size_style = + //PrintingFrameHasPageSizeStyle(print_preview_context_.prepared_frame(), + //print_preview_context_.total_page_count()); + int dpi = GetDPI(&print_params); + + gfx::Rect printable_area_in_points( + ConvertUnit(print_params.printable_area.x(), dpi, kPointsPerInch), + ConvertUnit(print_params.printable_area.y(), dpi, kPointsPerInch), + ConvertUnit(print_params.printable_area.width(), dpi, kPointsPerInch), + ConvertUnit(print_params.printable_area.height(), dpi, kPointsPerInch)); + + + PrintHostMsg_DidGetPreviewPageCount_Params params; + params.page_count = print_preview_context_.total_page_count(); + params.is_modifiable = print_preview_context_.IsModifiable(); + params.document_cookie = print_params.document_cookie; + params.preview_request_id = print_params.preview_request_id; + params.clear_preview_data = print_preview_context_.generate_draft_pages(); + Send(new PrintHostMsg_DidGetPreviewPageCount(routing_id(), params)); + + while (!print_preview_context_.IsFinalPageRendered()) { + int page_number = print_preview_context_.GetNextPageNumber(); + DCHECK_GE(page_number, 0); + if (!RenderPreviewPage(page_number, print_params)) + return false; + + // We must call PrepareFrameAndViewForPrint::FinishPrinting() (by way of + // print_preview_context_.AllPagesRendered()) before calling + // FinalizePrintReadyDocument() when printing a PDF because the plugin + // code does not generate output until we call FinishPrinting(). We do not + // generate draft pages for PDFs, so IsFinalPageRendered() and + // IsLastPageOfPrintReadyMetafile() will be true in the same iteration of + // the loop. + if (print_preview_context_.IsFinalPageRendered()) + print_preview_context_.AllPagesRendered(); + + if (print_preview_context_.IsLastPageOfPrintReadyMetafile()) { + DCHECK(print_preview_context_.IsModifiable() || + print_preview_context_.IsFinalPageRendered()); + if (!FinalizePrintReadyDocument()) + return false; + } + } + print_preview_context_.Finished(); + return true; +} + +bool PrintWebViewHelper::FinalizePrintReadyDocument() { + DCHECK(!is_print_ready_metafile_sent_); + print_preview_context_.FinalizePrintReadyDocument(); + + // Get the size of the resulting metafile. + PdfMetafileSkia* metafile = print_preview_context_.metafile(); + uint32 buf_size = metafile->GetDataSize(); + DCHECK_GT(buf_size, 0u); + + PrintHostMsg_DidPreviewDocument_Params preview_params; + preview_params.data_size = buf_size; + preview_params.document_cookie = print_pages_params_->params.document_cookie; + preview_params.expected_pages_count = + print_preview_context_.total_page_count(); + preview_params.modifiable = print_preview_context_.IsModifiable(); + preview_params.preview_request_id = + print_pages_params_->params.preview_request_id; + + // Ask the browser to create the shared memory for us. + if (!CopyMetafileDataToSharedMem(metafile, + &(preview_params.metafile_data_handle))) { + LOG(ERROR) << "CopyMetafileDataToSharedMem failed"; + print_preview_context_.set_error(PREVIEW_ERROR_METAFILE_COPY_FAILED); + return false; + } + is_print_ready_metafile_sent_ = true; + + Send(new PrintHostMsg_MetafileReadyForPrinting(routing_id(), preview_params)); + return true; +} + void PrintWebViewHelper::PrintNode(const blink::WebNode& node) { if (node.isNull() || !node.document().frame()) { // This can occur when the context menu refers to an invalid WebNode. @@ -916,6 +1068,68 @@ bool PrintWebViewHelper::CalculateNumberOfPages(blink::WebLocalFrame* frame, return true; } +bool PrintWebViewHelper::UpdatePrintSettings( + blink::WebLocalFrame* frame, + const blink::WebNode& node, + const base::DictionaryValue& passed_job_settings) { + const base::DictionaryValue* job_settings = &passed_job_settings; + base::DictionaryValue modified_job_settings; + if (job_settings->empty()) { + if (!print_for_preview_) + print_preview_context_.set_error(PREVIEW_ERROR_BAD_SETTING); + return false; + } + + bool source_is_html = true; + if (print_for_preview_) { + if (!job_settings->GetBoolean(kSettingPreviewModifiable, &source_is_html)) { + NOTREACHED(); + } + } else { + source_is_html = !PrintingNodeOrPdfFrame(frame, node); + } + + if (print_for_preview_ || !source_is_html) { + modified_job_settings.MergeDictionary(job_settings); + modified_job_settings.SetBoolean(kSettingHeaderFooterEnabled, false); + modified_job_settings.SetInteger(kSettingMarginsType, NO_MARGINS); + job_settings = &modified_job_settings; + } + + // Send the cookie so that UpdatePrintSettings can reuse PrinterQuery when + // possible. + int cookie = + print_pages_params_ ? print_pages_params_->params.document_cookie : 0; + PrintMsg_PrintPages_Params settings; + bool canceled = false; + Send(new PrintHostMsg_UpdatePrintSettings(routing_id(), cookie, *job_settings, + &settings, &canceled)); + if (canceled) { + notify_browser_of_print_failure_ = false; + return false; + } + + if (!print_for_preview_) { + job_settings->GetInteger(kPreviewRequestID, + &settings.params.preview_request_id); + settings.params.print_to_pdf = true; + UpdateFrameMarginsCssInfo(*job_settings); + settings.params.print_scaling_option = + blink::WebPrintScalingOptionSourceSize; + } + + SetPrintPagesParams(settings); + + if (!PrintMsg_Print_Params_IsValid(settings.params)) { + if (!print_for_preview_) + print_preview_context_.set_error(PREVIEW_ERROR_INVALID_PRINTER_SETTINGS); + return false; + } + + return true; +} + + bool PrintWebViewHelper::GetPrintSettingsFromUser(blink::WebFrame* frame, const blink::WebNode& node, int expected_pages_count) { @@ -987,4 +1201,280 @@ void PrintWebViewHelper::SetPrintPagesParams( print_pages_params_.reset(new PrintMsg_PrintPages_Params(settings)); } +bool PrintWebViewHelper::PreviewPageRendered(int page_number, + PdfMetafileSkia* metafile) { + DCHECK_GE(page_number, FIRST_PAGE_INDEX); + + // For non-modifiable files, |metafile| should be NULL, so do not bother + // sending a message. If we don't generate draft metafiles, |metafile| is + // NULL. + if (!print_preview_context_.IsModifiable() || + !print_preview_context_.generate_draft_pages()) { + DCHECK(!metafile); + return true; + } + + if (!metafile) { + NOTREACHED(); + print_preview_context_.set_error( + PREVIEW_ERROR_PAGE_RENDERED_WITHOUT_METAFILE); + return false; + } + + PrintHostMsg_DidPreviewPage_Params preview_page_params; + // Get the size of the resulting metafile. + uint32 buf_size = metafile->GetDataSize(); + DCHECK_GT(buf_size, 0u); + if (!CopyMetafileDataToSharedMem( + metafile, &(preview_page_params.metafile_data_handle))) { + LOG(ERROR) << "CopyMetafileDataToSharedMem failed"; + print_preview_context_.set_error(PREVIEW_ERROR_METAFILE_COPY_FAILED); + return false; + } + preview_page_params.data_size = buf_size; + preview_page_params.page_number = page_number; + preview_page_params.preview_request_id = + print_pages_params_->params.preview_request_id; + + Send(new PrintHostMsg_DidPreviewPage(routing_id(), preview_page_params)); + return true; +} + +PrintWebViewHelper::PrintPreviewContext::PrintPreviewContext() + : total_page_count_(0), + current_page_index_(0), + generate_draft_pages_(true), + print_ready_metafile_page_count_(0), + error_(PREVIEW_ERROR_NONE), + state_(UNINITIALIZED) { +} + +PrintWebViewHelper::PrintPreviewContext::~PrintPreviewContext() { +} + +void PrintWebViewHelper::PrintPreviewContext::InitWithFrame( + blink::WebLocalFrame* web_frame) { + DCHECK(web_frame); + DCHECK(!IsRendering()); + state_ = INITIALIZED; + source_frame_.Reset(web_frame); + source_node_.reset(); +} + +void PrintWebViewHelper::PrintPreviewContext::InitWithNode( + const blink::WebNode& web_node) { + DCHECK(!web_node.isNull()); + DCHECK(web_node.document().frame()); + DCHECK(!IsRendering()); + state_ = INITIALIZED; + source_frame_.Reset(web_node.document().frame()); + source_node_ = web_node; +} + +void PrintWebViewHelper::PrintPreviewContext::OnPrintPreview() { + DCHECK_EQ(INITIALIZED, state_); + ClearContext(); +} + +bool PrintWebViewHelper::PrintPreviewContext::CreatePreviewDocument( + PrepareFrameAndViewForPrint* prepared_frame, + const std::vector& pages) { + DCHECK_EQ(INITIALIZED, state_); + state_ = RENDERING; + + // Need to make sure old object gets destroyed first. + prep_frame_view_.reset(prepared_frame); + prep_frame_view_->StartPrinting(); + + total_page_count_ = prep_frame_view_->GetExpectedPageCount(); + if (total_page_count_ == 0) { + LOG(ERROR) << "CreatePreviewDocument got 0 page count"; + set_error(PREVIEW_ERROR_ZERO_PAGES); + return false; + } + + metafile_.reset(new PdfMetafileSkia); + if (!metafile_->Init()) { + set_error(PREVIEW_ERROR_METAFILE_INIT_FAILED); + LOG(ERROR) << "PdfMetafileSkia Init failed"; + return false; + } + + current_page_index_ = 0; + pages_to_render_ = pages; + // Sort and make unique. + std::sort(pages_to_render_.begin(), pages_to_render_.end()); + pages_to_render_.resize( + std::unique(pages_to_render_.begin(), pages_to_render_.end()) - + pages_to_render_.begin()); + // Remove invalid pages. + pages_to_render_.resize(std::lower_bound(pages_to_render_.begin(), + pages_to_render_.end(), + total_page_count_) - + pages_to_render_.begin()); + print_ready_metafile_page_count_ = pages_to_render_.size(); + if (pages_to_render_.empty()) { + print_ready_metafile_page_count_ = total_page_count_; + // Render all pages. + for (int i = 0; i < total_page_count_; ++i) + pages_to_render_.push_back(i); + } else if (generate_draft_pages_) { + int pages_index = 0; + for (int i = 0; i < total_page_count_; ++i) { + if (pages_index < print_ready_metafile_page_count_ && + i == pages_to_render_[pages_index]) { + pages_index++; + continue; + } + pages_to_render_.push_back(i); + } + } + + document_render_time_ = base::TimeDelta(); + begin_time_ = base::TimeTicks::Now(); + + return true; +} + +void PrintWebViewHelper::PrintPreviewContext::RenderedPreviewPage( + const base::TimeDelta& page_time) { + DCHECK_EQ(RENDERING, state_); + document_render_time_ += page_time; + UMA_HISTOGRAM_TIMES("PrintPreview.RenderPDFPageTime", page_time); +} + +void PrintWebViewHelper::PrintPreviewContext::AllPagesRendered() { + DCHECK_EQ(RENDERING, state_); + state_ = DONE; + prep_frame_view_->FinishPrinting(); +} + +void PrintWebViewHelper::PrintPreviewContext::FinalizePrintReadyDocument() { + DCHECK(IsRendering()); + + base::TimeTicks begin_time = base::TimeTicks::Now(); + metafile_->FinishDocument(); + + if (print_ready_metafile_page_count_ <= 0) { + NOTREACHED(); + return; + } + + UMA_HISTOGRAM_MEDIUM_TIMES("PrintPreview.RenderToPDFTime", + document_render_time_); + base::TimeDelta total_time = + (base::TimeTicks::Now() - begin_time) + document_render_time_; + UMA_HISTOGRAM_MEDIUM_TIMES("PrintPreview.RenderAndGeneratePDFTime", + total_time); + UMA_HISTOGRAM_MEDIUM_TIMES("PrintPreview.RenderAndGeneratePDFTimeAvgPerPage", + total_time / pages_to_render_.size()); +} + +void PrintWebViewHelper::PrintPreviewContext::Finished() { + DCHECK_EQ(DONE, state_); + state_ = INITIALIZED; + ClearContext(); +} + +void PrintWebViewHelper::PrintPreviewContext::Failed(bool report_error) { + DCHECK(state_ == INITIALIZED || state_ == RENDERING); + state_ = INITIALIZED; + if (report_error) { + DCHECK_NE(PREVIEW_ERROR_NONE, error_); + UMA_HISTOGRAM_ENUMERATION("PrintPreview.RendererError", error_, + PREVIEW_ERROR_LAST_ENUM); + } + ClearContext(); +} + +int PrintWebViewHelper::PrintPreviewContext::GetNextPageNumber() { + DCHECK_EQ(RENDERING, state_); + if (IsFinalPageRendered()) + return -1; + return pages_to_render_[current_page_index_++]; +} + +bool PrintWebViewHelper::PrintPreviewContext::IsRendering() const { + return state_ == RENDERING || state_ == DONE; +} + +bool PrintWebViewHelper::PrintPreviewContext::IsModifiable() { + // The only kind of node we can print right now is a PDF node. + return !PrintingNodeOrPdfFrame(source_frame(), source_node_); +} + +bool PrintWebViewHelper::PrintPreviewContext::HasSelection() { + return IsModifiable() && source_frame()->hasSelection(); +} + +bool PrintWebViewHelper::PrintPreviewContext::IsLastPageOfPrintReadyMetafile() + const { + DCHECK(IsRendering()); + return current_page_index_ == print_ready_metafile_page_count_; +} + +bool PrintWebViewHelper::PrintPreviewContext::IsFinalPageRendered() const { + DCHECK(IsRendering()); + return static_cast(current_page_index_) == pages_to_render_.size(); +} + +void PrintWebViewHelper::PrintPreviewContext::set_generate_draft_pages( + bool generate_draft_pages) { + DCHECK_EQ(INITIALIZED, state_); + generate_draft_pages_ = generate_draft_pages; +} + +void PrintWebViewHelper::PrintPreviewContext::set_error( + enum PrintPreviewErrorBuckets error) { + error_ = error; +} + +blink::WebLocalFrame* PrintWebViewHelper::PrintPreviewContext::source_frame() { + DCHECK(state_ != UNINITIALIZED); + return source_frame_.GetFrame(); +} + +const blink::WebNode& + PrintWebViewHelper::PrintPreviewContext::source_node() const { + DCHECK(state_ != UNINITIALIZED); + return source_node_; +} + +blink::WebLocalFrame* +PrintWebViewHelper::PrintPreviewContext::prepared_frame() { + DCHECK(state_ != UNINITIALIZED); + return prep_frame_view_->frame(); +} + +const blink::WebNode& + PrintWebViewHelper::PrintPreviewContext::prepared_node() const { + DCHECK(state_ != UNINITIALIZED); + return prep_frame_view_->node(); +} + +int PrintWebViewHelper::PrintPreviewContext::total_page_count() const { + DCHECK(state_ != UNINITIALIZED); + return total_page_count_; +} + +bool PrintWebViewHelper::PrintPreviewContext::generate_draft_pages() const { + return generate_draft_pages_; +} + +PdfMetafileSkia* PrintWebViewHelper::PrintPreviewContext::metafile() { + DCHECK(IsRendering()); + return metafile_.get(); +} + +int PrintWebViewHelper::PrintPreviewContext::last_error() const { + return error_; +} + +void PrintWebViewHelper::PrintPreviewContext::ClearContext() { + prep_frame_view_.reset(); + metafile_.reset(); + pages_to_render_.clear(); + error_ = PREVIEW_ERROR_NONE; +} + } // namespace printing diff --git a/chromium_src/chrome/renderer/printing/print_web_view_helper.h b/chromium_src/chrome/renderer/printing/print_web_view_helper.h index 498a01b53da4..bfe9cb612d16 100644 --- a/chromium_src/chrome/renderer/printing/print_web_view_helper.h +++ b/chromium_src/chrome/renderer/printing/print_web_view_helper.h @@ -76,6 +76,19 @@ class PrintWebViewHelper OK, FAIL_PRINT_INIT, FAIL_PRINT, + FAIL_PREVIEW, + }; + + enum PrintPreviewErrorBuckets { + PREVIEW_ERROR_NONE, // Always first. + PREVIEW_ERROR_BAD_SETTING, + PREVIEW_ERROR_METAFILE_COPY_FAILED, + PREVIEW_ERROR_METAFILE_INIT_FAILED, + PREVIEW_ERROR_ZERO_PAGES, + PREVIEW_ERROR_MAC_DRAFT_METAFILE_INIT_FAILED, + PREVIEW_ERROR_PAGE_RENDERED_WITHOUT_METAFILE, + PREVIEW_ERROR_INVALID_PRINTER_SETTINGS, + PREVIEW_ERROR_LAST_ENUM // Always last. }; // RenderViewObserver implementation. @@ -88,6 +101,8 @@ class PrintWebViewHelper void OnPrintPages(bool silent, bool print_background); void OnPrintingDone(bool success); #endif // !DISABLE_BASIC_PRINTING + void OnPrintPreview(const base::DictionaryValue& settings); + // Get |page_size| and |content_area| information from // |page_layout_in_points|. @@ -99,6 +114,24 @@ class PrintWebViewHelper // Update |ignore_css_margins_| based on settings. void UpdateFrameMarginsCssInfo(const base::DictionaryValue& settings); + // Prepare frame for creating preview document. + void PrepareFrameForPreviewDocument(); + + // Continue creating preview document. + void OnFramePreparedForPreviewDocument(); + + // Finalize the print ready preview document. + bool FinalizePrintReadyDocument(); + + // Renders a print preview page. |page_number| is 0-based. + // Returns true if print preview should continue, false on failure. + bool RenderPreviewPage(int page_number, + const PrintMsg_Print_Params& print_params); + + + // Initialize the print preview document. + bool CreatePreviewDocument(); + // Main printing code ------------------------------------------------------- void Print(blink::WebLocalFrame* frame, @@ -120,6 +153,14 @@ class PrintWebViewHelper const blink::WebNode& node, int* number_of_pages); + // Update the current print settings with new |passed_job_settings|. + // |passed_job_settings| dictionary contains print job details such as printer + // name, number of copies, page range, etc. + bool UpdatePrintSettings(blink::WebLocalFrame* frame, + const blink::WebNode& node, + const base::DictionaryValue& passed_job_settings); + + // Get final print settings from the user. // Return false if the user cancels or on error. bool GetPrintSettingsFromUser(blink::WebFrame* frame, @@ -193,6 +234,13 @@ class PrintWebViewHelper // Script Initiated Printing ------------------------------------------------ + // Notifies the browser a print preview page has been rendered. + // |page_number| is 0-based. + // For a valid |page_number| with modifiable content, + // |metafile| is the rendered page. Otherwise |metafile| is NULL. + // Returns true if print preview should continue, false on failure. + bool PreviewPageRendered(int page_number, PdfMetafileSkia* metafile); + void SetPrintPagesParams(const PrintMsg_PrintPages_Params& settings); // WebView used only to print the selection. @@ -213,10 +261,121 @@ class PrintWebViewHelper // True, when printing from print preview. bool print_for_preview_; + // Keeps track of the state of print preview between messages. + // TODO(vitalybuka): Create PrintPreviewContext when needed and delete after + // use. Now it's interaction with various messages is confusing. + class PrintPreviewContext { + public: + PrintPreviewContext(); + ~PrintPreviewContext(); + + // Initializes the print preview context. Need to be called to set + // the |web_frame| / |web_node| to generate the print preview for. + void InitWithFrame(blink::WebLocalFrame* web_frame); + void InitWithNode(const blink::WebNode& web_node); + + // Does bookkeeping at the beginning of print preview. + void OnPrintPreview(); + + // Create the print preview document. |pages| is empty to print all pages. + // Takes ownership of |prepared_frame|. + bool CreatePreviewDocument(PrepareFrameAndViewForPrint* prepared_frame, + const std::vector& pages); + + // Called after a page gets rendered. |page_time| is how long the + // rendering took. + void RenderedPreviewPage(const base::TimeDelta& page_time); + + // Updates the print preview context when the required pages are rendered. + void AllPagesRendered(); + + // Finalizes the print ready preview document. + void FinalizePrintReadyDocument(); + + // Cleanup after print preview finishes. + void Finished(); + + // Cleanup after print preview fails. + void Failed(bool report_error); + + // Helper functions + int GetNextPageNumber(); + bool IsRendering() const; + bool IsModifiable(); + bool HasSelection(); + bool IsLastPageOfPrintReadyMetafile() const; + bool IsFinalPageRendered() const; + + // Setters + void set_generate_draft_pages(bool generate_draft_pages); + void set_error(enum PrintPreviewErrorBuckets error); + + // Getters + // Original frame for which preview was requested. + blink::WebLocalFrame* source_frame(); + // Original node for which preview was requested. + const blink::WebNode& source_node() const; + + // Frame to be use to render preview. May be the same as source_frame(), or + // generated from it, e.g. copy of selected block. + blink::WebLocalFrame* prepared_frame(); + // Node to be use to render preview. May be the same as source_node(), or + // generated from it, e.g. copy of selected block. + const blink::WebNode& prepared_node() const; + + int total_page_count() const; + bool generate_draft_pages() const; + PdfMetafileSkia* metafile(); + int last_error() const; + + private: + enum State { + UNINITIALIZED, // Not ready to render. + INITIALIZED, // Ready to render. + RENDERING, // Rendering. + DONE // Finished rendering. + }; + + // Reset some of the internal rendering context. + void ClearContext(); + + // Specifies what to render for print preview. + FrameReference source_frame_; + blink::WebNode source_node_; + + scoped_ptr prep_frame_view_; + scoped_ptr metafile_; + + // Total page count in the renderer. + int total_page_count_; + + // The current page to render. + int current_page_index_; + + // List of page indices that need to be rendered. + std::vector pages_to_render_; + + // True, when draft pages needs to be generated. + bool generate_draft_pages_; + + // Specifies the total number of pages in the print ready metafile. + int print_ready_metafile_page_count_; + + base::TimeDelta document_render_time_; + base::TimeTicks begin_time_; + + enum PrintPreviewErrorBuckets error_; + + State state_; + }; + + bool print_node_in_progress_; bool is_loading_; bool is_scripted_preview_delayed_; + PrintPreviewContext print_preview_context_; + // Used to fix a race condition where the source is a PDF and print preview // hangs because RequestPrintPreview is called before DidStopLoading() is // called. This is a store for the RequestPrintPreview() call and its diff --git a/chromium_src/chrome/renderer/printing/print_web_view_helper_pdf_win.cc b/chromium_src/chrome/renderer/printing/print_web_view_helper_pdf_win.cc index f98ee5097cca..dcd388fd1111 100644 --- a/chromium_src/chrome/renderer/printing/print_web_view_helper_pdf_win.cc +++ b/chromium_src/chrome/renderer/printing/print_web_view_helper_pdf_win.cc @@ -21,7 +21,6 @@ namespace printing { using blink::WebFrame; -#if 0 bool PrintWebViewHelper::RenderPreviewPage( int page_number, const PrintMsg_Print_Params& print_params) { @@ -53,7 +52,6 @@ bool PrintWebViewHelper::RenderPreviewPage( } return PreviewPageRendered(page_number, draft_metafile.get()); } -#endif bool PrintWebViewHelper::PrintPagesNative(blink::WebFrame* frame, int page_count) { diff --git a/filenames.gypi b/filenames.gypi index 6ece2ba634c7..de1d04174648 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -314,6 +314,8 @@ 'chromium_src/chrome/browser/printing/printer_query.h', 'chromium_src/chrome/browser/printing/printing_message_filter.cc', 'chromium_src/chrome/browser/printing/printing_message_filter.h', + 'chromium_src/chrome/browser/printing/print_preview_message_handler.cc', + 'chromium_src/chrome/browser/printing/print_preview_message_handler.h', 'chromium_src/chrome/browser/renderer_host/pepper/chrome_browser_pepper_host_factory.cc', 'chromium_src/chrome/browser/renderer_host/pepper/chrome_browser_pepper_host_factory.h', 'chromium_src/chrome/browser/renderer_host/pepper/pepper_broker_message_filter.cc', From 9cf9229308bc69e15d3b75e1d71a10b9e6627a93 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Sun, 31 May 2015 11:07:26 +0800 Subject: [PATCH 0264/1293] Write PDF file in FILE thread. --- .../printing/print_preview_message_handler.cc | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/chromium_src/chrome/browser/printing/print_preview_message_handler.cc b/chromium_src/chrome/browser/printing/print_preview_message_handler.cc index 6cc47e90876f..c5b59547599b 100644 --- a/chromium_src/chrome/browser/printing/print_preview_message_handler.cc +++ b/chromium_src/chrome/browser/printing/print_preview_message_handler.cc @@ -60,6 +60,15 @@ base::RefCountedBytes* GetDataFromHandle(base::SharedMemoryHandle handle, return base::RefCountedBytes::TakeVector(&data); } +void PrintToPdfCallback(const scoped_refptr& data, + const base::FilePath& save_path) { + printing::PdfMetafileSkia metafile; + metafile.InitFromData(static_cast(data->front()), data->size()); + base::File file(save_path, + base::File::FLAG_CREATE_ALWAYS | base::File::FLAG_WRITE); + metafile.SaveTo(&file); +} + } // namespace namespace printing { @@ -116,11 +125,11 @@ void PrintPreviewMessageHandler::OnMetafileReadyForPrinting( file_dialog::ShowSaveDialog(window, "Save As", base::FilePath(FILE_PATH_LITERAL("print.pdf")), file_dialog::Filters(), &save_path); - printing::PdfMetafileSkia metafile; - metafile.InitFromData(static_cast(data->front()), data->size()); - base::File file(save_path, - base::File::FLAG_CREATE_ALWAYS | base::File::FLAG_WRITE); - metafile.SaveTo(&file); + BrowserThread::PostTask(BrowserThread::FILE, + FROM_HERE, + base::Bind(&PrintToPdfCallback, + data, + save_path)); } //void PrintPreviewMessageHandler::OnPrintPreviewFailed(int document_cookie) { From ce8bbb689c142d145763c31f9e6915385bcb3263 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Sun, 31 May 2015 14:52:41 +0800 Subject: [PATCH 0265/1293] Add options to custom print settings in printToPDF API. --- atom/browser/api/atom_api_window.cc | 10 +++++-- atom/browser/api/atom_api_window.h | 2 +- atom/browser/native_window.cc | 4 +-- atom/browser/native_window.h | 2 +- .../printing/print_preview_message_handler.cc | 26 ++++++++++++++++--- .../printing/print_preview_message_handler.h | 7 +++-- 6 files changed, 40 insertions(+), 11 deletions(-) diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index 00a0bb464089..66f17029bd54 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -16,6 +16,7 @@ #include "native_mate/callback.h" #include "native_mate/constructor.h" #include "native_mate/dictionary.h" +#include "printing/print_job_constants.h" #include "ui/gfx/geometry/rect.h" #include "atom/common/node_includes.h" @@ -430,8 +431,13 @@ void Window::Print(mate::Arguments* args) { window_->Print(settings.silent, settings.print_background); } -void Window::PrintToPDF() { - window_->PrintToPDF(); +void Window::PrintToPDF(mate::Arguments* args) { + mate::Dictionary options; + if (args->Length() == 1 && !args->GetNext(&options)) { + args->ThrowError(); + return; + } + window_->PrintToPDF(options); } void Window::SetProgressBar(double progress) { diff --git a/atom/browser/api/atom_api_window.h b/atom/browser/api/atom_api_window.h index 606fda9f7dc3..828ab2ab9014 100644 --- a/atom/browser/api/atom_api_window.h +++ b/atom/browser/api/atom_api_window.h @@ -132,7 +132,7 @@ class Window : public mate::EventEmitter, bool IsDocumentEdited(); void CapturePage(mate::Arguments* args); void Print(mate::Arguments* args); - void PrintToPDF(); + void PrintToPDF(mate::Arguments* args); void SetProgressBar(double progress); void SetOverlayIcon(const gfx::Image& overlay, const std::string& description); diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 9b922dc9b5b0..f7616f423666 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -265,9 +265,9 @@ void NativeWindow::Print(bool silent, bool print_background) { PrintNow(silent, print_background); } -void NativeWindow::PrintToPDF() { +void NativeWindow::PrintToPDF(const mate::Dictionary& options) { printing::PrintPreviewMessageHandler::FromWebContents(GetWebContents())-> - HandleGetPreview(NULL); + HandleGetPreview(options); } void NativeWindow::ShowDefinitionForSelection() { diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index 5c99a2c117b5..dd10dd1229f2 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -158,7 +158,7 @@ class NativeWindow : public CommonWebContentsDelegate, virtual void Print(bool silent, bool print_background); // Print current page as PDF. - virtual void PrintToPDF(); + virtual void PrintToPDF(const mate::Dictionary& options); // Show popup dictionary. virtual void ShowDefinitionForSelection(); diff --git a/chromium_src/chrome/browser/printing/print_preview_message_handler.cc b/chromium_src/chrome/browser/printing/print_preview_message_handler.cc index c5b59547599b..bb960b2ef75e 100644 --- a/chromium_src/chrome/browser/printing/print_preview_message_handler.cc +++ b/chromium_src/chrome/browser/printing/print_preview_message_handler.cc @@ -199,7 +199,8 @@ bool PrintPreviewMessageHandler::OnMessageReceived( return handled; } -void PrintPreviewMessageHandler::HandleGetPreview(const base::ListValue* args) { +void PrintPreviewMessageHandler::HandleGetPreview( + const mate::Dictionary& options) { static int request_id = 0; request_id++; // A simulated Chromium print preivew setting. @@ -212,7 +213,7 @@ void PrintPreviewMessageHandler::HandleGetPreview(const base::ListValue* args) { \"width_microns\":210000, \ \"custom_display_name\":\"A4\" \ }, \ - \"landscape\":true, \ + \"landscape\":false, \ \"color\":2, \ \"headerFooterEnabled\":false, \ \"marginsType\":0, \ @@ -229,7 +230,7 @@ void PrintPreviewMessageHandler::HandleGetPreview(const base::ListValue* args) { \"duplex\":0, \ \"copies\":1, \ \"collate\":true, \ - \"shouldPrintBackgrounds\":true, \ + \"shouldPrintBackgrounds\":false, \ \"shouldPrintSelectionOnly\":false \ }"; @@ -237,7 +238,26 @@ void PrintPreviewMessageHandler::HandleGetPreview(const base::ListValue* args) { static_cast( base::JSONReader::Read(setting_json_str))); settings->SetInteger(printing::kPreviewRequestID, request_id); + // Default Print PDF settings: + int margins_type = 0; // DEFAULT_MARGINS + bool print_background = false; + bool print_selection_only = false; + bool is_landscape = false; // layout: true for portrait, false for landscape + if (!options.IsEmpty()) { + options.Get(printing::kSettingMarginsType, &margins_type); + options.Get(printing::kSettingShouldPrintBackgrounds, &print_background); + options.Get(printing::kSettingShouldPrintSelectionOnly, + &print_selection_only); + std::string layout; + options.Get("layout", &is_landscape); + } + settings->SetInteger(printing::kSettingMarginsType, margins_type); + settings->SetBoolean(printing::kSettingShouldPrintBackgrounds, + print_background); + settings->SetBoolean(printing::kSettingShouldPrintSelectionOnly, + print_selection_only); + settings->SetBoolean(printing::kSettingLandscape, is_landscape); LOG(ERROR) << "Print preview request start"; content::RenderViewHost* rvh = web_contents()->GetRenderViewHost(); rvh->Send(new PrintMsg_PrintPreview(rvh->GetRoutingID(), *settings)); diff --git a/chromium_src/chrome/browser/printing/print_preview_message_handler.h b/chromium_src/chrome/browser/printing/print_preview_message_handler.h index 8f9f1b4ed230..38943b01b80a 100644 --- a/chromium_src/chrome/browser/printing/print_preview_message_handler.h +++ b/chromium_src/chrome/browser/printing/print_preview_message_handler.h @@ -17,6 +17,10 @@ namespace content { class WebContents; } +namespace mate { +class Dictionary; +} + namespace gfx { class Rect; } @@ -37,8 +41,7 @@ class PrintPreviewMessageHandler // Asks the initiator renderer to generate a preview. First element of |args| // is a job settings JSON string. - void HandleGetPreview(const base::ListValue* args); - + void HandleGetPreview(const mate::Dictionary& options); private: explicit PrintPreviewMessageHandler(content::WebContents* web_contents); friend class content::WebContentsUserData; From 8572ccb80733bab172e64d5c06814acc7d1b27ea Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Mon, 1 Jun 2015 10:37:27 +0800 Subject: [PATCH 0266/1293] Add callback function in printToPDF API. --- atom/browser/api/atom_api_window.cc | 8 ++-- atom/browser/native_window.cc | 5 ++- atom/browser/native_window.h | 4 +- .../printing/print_preview_message_handler.cc | 43 +++++++++++++------ .../printing/print_preview_message_handler.h | 20 ++++++++- 5 files changed, 61 insertions(+), 19 deletions(-) diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index 66f17029bd54..8872a0e7f6ca 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -16,7 +16,6 @@ #include "native_mate/callback.h" #include "native_mate/constructor.h" #include "native_mate/dictionary.h" -#include "printing/print_job_constants.h" #include "ui/gfx/geometry/rect.h" #include "atom/common/node_includes.h" @@ -433,11 +432,14 @@ void Window::Print(mate::Arguments* args) { void Window::PrintToPDF(mate::Arguments* args) { mate::Dictionary options; - if (args->Length() == 1 && !args->GetNext(&options)) { + base::Callback callback; + if (!(args->Length() == 1 && !args->GetNext(&callback)) && + !(args->Length() == 2 && args->GetNext(&options) + && args->GetNext(&callback))) { args->ThrowError(); return; } - window_->PrintToPDF(options); + window_->PrintToPDF(options, callback); } void Window::SetProgressBar(double progress) { diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index f7616f423666..2edf8906d6c2 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -265,9 +265,10 @@ void NativeWindow::Print(bool silent, bool print_background) { PrintNow(silent, print_background); } -void NativeWindow::PrintToPDF(const mate::Dictionary& options) { +void NativeWindow::PrintToPDF(const mate::Dictionary& options, + const PrintToPDFCallback& callback) { printing::PrintPreviewMessageHandler::FromWebContents(GetWebContents())-> - HandleGetPreview(options); + HandleGetPreview(options, callback); } void NativeWindow::ShowDefinitionForSelection() { diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index dd10dd1229f2..78187bc8d458 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -55,6 +55,7 @@ class NativeWindow : public CommonWebContentsDelegate, public content::NotificationObserver { public: typedef base::Callback CapturePageCallback; + typedef base::Callback PrintToPDFCallback; class DialogScope { public: @@ -158,7 +159,8 @@ class NativeWindow : public CommonWebContentsDelegate, virtual void Print(bool silent, bool print_background); // Print current page as PDF. - virtual void PrintToPDF(const mate::Dictionary& options); + virtual void PrintToPDF(const mate::Dictionary& options, + const PrintToPDFCallback& callback); // Show popup dictionary. virtual void ShowDefinitionForSelection(); diff --git a/chromium_src/chrome/browser/printing/print_preview_message_handler.cc b/chromium_src/chrome/browser/printing/print_preview_message_handler.cc index bb960b2ef75e..36befec47915 100644 --- a/chromium_src/chrome/browser/printing/print_preview_message_handler.cc +++ b/chromium_src/chrome/browser/printing/print_preview_message_handler.cc @@ -60,19 +60,23 @@ base::RefCountedBytes* GetDataFromHandle(base::SharedMemoryHandle handle, return base::RefCountedBytes::TakeVector(&data); } -void PrintToPdfCallback(const scoped_refptr& data, - const base::FilePath& save_path) { +printing::PrintPreviewMessageHandler::PrintPDFResult +SavePDF(const scoped_refptr& data, + const base::FilePath& save_path) { printing::PdfMetafileSkia metafile; metafile.InitFromData(static_cast(data->front()), data->size()); base::File file(save_path, base::File::FLAG_CREATE_ALWAYS | base::File::FLAG_WRITE); - metafile.SaveTo(&file); + return metafile.SaveTo(&file)? + printing::PrintPreviewMessageHandler::SUCCESS : + printing::PrintPreviewMessageHandler::FAIL_SAVEFILE; } } // namespace namespace printing { + PrintPreviewMessageHandler::PrintPreviewMessageHandler( WebContents* web_contents) : content::WebContentsObserver(web_contents) { @@ -122,14 +126,19 @@ void PrintPreviewMessageHandler::OnMetafileReadyForPrinting( atom::NativeWindow* window = atom::NativeWindow::FromWebContents( web_contents()); base::FilePath save_path; - file_dialog::ShowSaveDialog(window, "Save As", - base::FilePath(FILE_PATH_LITERAL("print.pdf")), - file_dialog::Filters(), &save_path); - BrowserThread::PostTask(BrowserThread::FILE, - FROM_HERE, - base::Bind(&PrintToPdfCallback, - data, - save_path)); + if (!file_dialog::ShowSaveDialog(window, "Save As", + base::FilePath(FILE_PATH_LITERAL("print.pdf")), + file_dialog::Filters(), &save_path)) { // Users cancel dialog. + RunPrintToPDFCallback(params.preview_request_id, FAIL_CANCEL); + return; + } + BrowserThread::PostTaskAndReplyWithResult( + BrowserThread::FILE, + FROM_HERE, + base::Bind(&SavePDF, data, save_path), + base::Bind(&PrintPreviewMessageHandler::RunPrintToPDFCallback, + base::Unretained(this), + params.preview_request_id)); } //void PrintPreviewMessageHandler::OnPrintPreviewFailed(int document_cookie) { @@ -200,7 +209,8 @@ bool PrintPreviewMessageHandler::OnMessageReceived( } void PrintPreviewMessageHandler::HandleGetPreview( - const mate::Dictionary& options) { + const mate::Dictionary& options, + const atom::NativeWindow::PrintToPDFCallback& callback) { static int request_id = 0; request_id++; // A simulated Chromium print preivew setting. @@ -238,6 +248,9 @@ void PrintPreviewMessageHandler::HandleGetPreview( static_cast( base::JSONReader::Read(setting_json_str))); settings->SetInteger(printing::kPreviewRequestID, request_id); + print_to_pdf_callback_map_[request_id] = callback; + + // Default Print PDF settings: int margins_type = 0; // DEFAULT_MARGINS bool print_background = false; @@ -263,4 +276,10 @@ void PrintPreviewMessageHandler::HandleGetPreview( rvh->Send(new PrintMsg_PrintPreview(rvh->GetRoutingID(), *settings)); } +void PrintPreviewMessageHandler::RunPrintToPDFCallback( + int request_id, PrintPDFResult result) { + print_to_pdf_callback_map_[request_id].Run(static_cast(result)); + print_to_pdf_callback_map_.erase(request_id); +} + } // namespace printing diff --git a/chromium_src/chrome/browser/printing/print_preview_message_handler.h b/chromium_src/chrome/browser/printing/print_preview_message_handler.h index 38943b01b80a..5594a41f2db1 100644 --- a/chromium_src/chrome/browser/printing/print_preview_message_handler.h +++ b/chromium_src/chrome/browser/printing/print_preview_message_handler.h @@ -5,6 +5,9 @@ #ifndef CHROME_BROWSER_PRINTING_PRINT_PREVIEW_MESSAGE_HANDLER_H_ #define CHROME_BROWSER_PRINTING_PRINT_PREVIEW_MESSAGE_HANDLER_H_ +#include + +#include "atom/browser/native_window.h" #include "base/compiler_specific.h" #include "content/public/browser/web_contents_observer.h" #include "content/public/browser/web_contents_user_data.h" @@ -34,6 +37,13 @@ class PrintPreviewMessageHandler : public content::WebContentsObserver, public content::WebContentsUserData { public: + enum PrintPDFResult { + SUCCESS, + FAIL_PREVIEW, + FAIL_SAVEFILE, + FAIL_CANCEL, + }; + ~PrintPreviewMessageHandler() override; // content::WebContentsObserver implementation. @@ -41,8 +51,12 @@ class PrintPreviewMessageHandler // Asks the initiator renderer to generate a preview. First element of |args| // is a job settings JSON string. - void HandleGetPreview(const mate::Dictionary& options); + void HandleGetPreview(const mate::Dictionary& options, + const atom::NativeWindow::PrintToPDFCallback& callback); + private: + typedef std::map PrintToPDFCallbackMap; + explicit PrintPreviewMessageHandler(content::WebContents* web_contents); friend class content::WebContentsUserData; @@ -65,6 +79,10 @@ class PrintPreviewMessageHandler //void OnSetOptionsFromDocument( //const PrintHostMsg_SetOptionsFromDocument_Params& params); + void RunPrintToPDFCallback(int request_id, PrintPDFResult result); + + PrintToPDFCallbackMap print_to_pdf_callback_map_; + DISALLOW_COPY_AND_ASSIGN(PrintPreviewMessageHandler); }; From cef177abc460cecd4fc9004f7f9497a222c1e13d Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Mon, 1 Jun 2015 11:08:40 +0800 Subject: [PATCH 0267/1293] Add preview failed error. --- .../printing/print_preview_message_handler.cc | 17 +++++++---------- .../printing/print_preview_message_handler.h | 2 +- chromium_src/chrome/common/print_messages.h | 3 +++ .../renderer/printing/print_web_view_helper.cc | 10 +++++++++- 4 files changed, 20 insertions(+), 12 deletions(-) diff --git a/chromium_src/chrome/browser/printing/print_preview_message_handler.cc b/chromium_src/chrome/browser/printing/print_preview_message_handler.cc index 36befec47915..0a3ae97afd60 100644 --- a/chromium_src/chrome/browser/printing/print_preview_message_handler.cc +++ b/chromium_src/chrome/browser/printing/print_preview_message_handler.cc @@ -141,14 +141,11 @@ void PrintPreviewMessageHandler::OnMetafileReadyForPrinting( params.preview_request_id)); } -//void PrintPreviewMessageHandler::OnPrintPreviewFailed(int document_cookie) { - //StopWorker(document_cookie); - - ////PrintPreviewUI* print_preview_ui = GetPrintPreviewUI(); - ////if (!print_preview_ui) - ////return; - ////print_preview_ui->OnPrintPreviewFailed(); -//} +void PrintPreviewMessageHandler::OnPrintPreviewFailed(int document_cookie, + int request_id) { + StopWorker(document_cookie); + RunPrintToPDFCallback(request_id, FAIL_PREVIEW); +} //void PrintPreviewMessageHandler::OnDidGetDefaultPageLayout( //const PageSizeMargins& page_layout_in_points, @@ -193,8 +190,8 @@ bool PrintPreviewMessageHandler::OnMessageReceived( OnDidPreviewPage) IPC_MESSAGE_HANDLER(PrintHostMsg_MetafileReadyForPrinting, OnMetafileReadyForPrinting) - //IPC_MESSAGE_HANDLER(PrintHostMsg_PrintPreviewFailed, - //OnPrintPreviewFailed) + IPC_MESSAGE_HANDLER(PrintHostMsg_PrintPreviewFailed, + OnPrintPreviewFailed) //IPC_MESSAGE_HANDLER(PrintHostMsg_DidGetDefaultPageLayout, //OnDidGetDefaultPageLayout) //IPC_MESSAGE_HANDLER(PrintHostMsg_PrintPreviewCancelled, diff --git a/chromium_src/chrome/browser/printing/print_preview_message_handler.h b/chromium_src/chrome/browser/printing/print_preview_message_handler.h index 5594a41f2db1..f4298fb6b2fc 100644 --- a/chromium_src/chrome/browser/printing/print_preview_message_handler.h +++ b/chromium_src/chrome/browser/printing/print_preview_message_handler.h @@ -73,7 +73,7 @@ class PrintPreviewMessageHandler void OnDidPreviewPage(const PrintHostMsg_DidPreviewPage_Params& params); void OnMetafileReadyForPrinting( const PrintHostMsg_DidPreviewDocument_Params& params); - //void OnPrintPreviewFailed(int document_cookie); + void OnPrintPreviewFailed(int document_cookie, int request_id); //void OnPrintPreviewCancelled(int document_cookie); //void OnInvalidPrinterSettings(int document_cookie); //void OnSetOptionsFromDocument( diff --git a/chromium_src/chrome/common/print_messages.h b/chromium_src/chrome/common/print_messages.h index 2e6d23771676..fc9c1d493509 100644 --- a/chromium_src/chrome/common/print_messages.h +++ b/chromium_src/chrome/common/print_messages.h @@ -332,6 +332,9 @@ IPC_MESSAGE_ROUTED1(PrintHostMsg_MetafileReadyForPrinting, IPC_MESSAGE_ROUTED1(PrintHostMsg_DidGetPreviewPageCount, PrintHostMsg_DidGetPreviewPageCount_Params /* params */) +IPC_MESSAGE_ROUTED2(PrintHostMsg_PrintPreviewFailed, + int /* document cookie */, + int /* request_id */); #if defined(OS_WIN) // Tell the utility process to start rendering the given PDF into a metafile. diff --git a/chromium_src/chrome/renderer/printing/print_web_view_helper.cc b/chromium_src/chrome/renderer/printing/print_web_view_helper.cc index 82a7b54fc2c5..550735f709b5 100644 --- a/chromium_src/chrome/renderer/printing/print_web_view_helper.cc +++ b/chromium_src/chrome/renderer/printing/print_web_view_helper.cc @@ -724,7 +724,6 @@ void PrintWebViewHelper::OnPrintPreview(const base::DictionaryValue& settings) { } LOG(ERROR) << "OnPrintPreview2"; - //SetPrintPagesParams(settings) if (!UpdatePrintSettings(print_preview_context_.source_frame(), print_preview_context_.source_node(), settings)) { DidFinishPrinting(FAIL_PREVIEW); @@ -938,6 +937,15 @@ void PrintWebViewHelper::DidFinishPrinting(PrintingResult result) { Send(new PrintHostMsg_PrintingFailed(routing_id(), cookie)); } break; + + case FAIL_PREVIEW: + LOG(ERROR) << "PREVIEW FAILED."; + if (print_pages_params_) { + Send(new PrintHostMsg_PrintPreviewFailed(routing_id(), + print_pages_params_->params.document_cookie, + print_pages_params_->params.preview_request_id)); + } + break; } prep_frame_view_.reset(); print_pages_params_.reset(); From 600077996c2607dd6b416f0e488c3876fa9d270e Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Mon, 1 Jun 2015 11:45:03 +0800 Subject: [PATCH 0268/1293] Fix a `landscape` option error. --- .../chrome/browser/printing/print_preview_message_handler.cc | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/chromium_src/chrome/browser/printing/print_preview_message_handler.cc b/chromium_src/chrome/browser/printing/print_preview_message_handler.cc index 0a3ae97afd60..ee47742c687a 100644 --- a/chromium_src/chrome/browser/printing/print_preview_message_handler.cc +++ b/chromium_src/chrome/browser/printing/print_preview_message_handler.cc @@ -252,15 +252,14 @@ void PrintPreviewMessageHandler::HandleGetPreview( int margins_type = 0; // DEFAULT_MARGINS bool print_background = false; bool print_selection_only = false; - bool is_landscape = false; // layout: true for portrait, false for landscape + bool is_landscape = false; if (!options.IsEmpty()) { options.Get(printing::kSettingMarginsType, &margins_type); options.Get(printing::kSettingShouldPrintBackgrounds, &print_background); options.Get(printing::kSettingShouldPrintSelectionOnly, &print_selection_only); - std::string layout; - options.Get("layout", &is_landscape); + options.Get(printing::kSettingLandscape, &is_landscape); } settings->SetInteger(printing::kSettingMarginsType, margins_type); settings->SetBoolean(printing::kSettingShouldPrintBackgrounds, From bf5d448e37086aba4e410a579cfc415636a59af5 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Mon, 1 Jun 2015 11:45:43 +0800 Subject: [PATCH 0269/1293] :memo: Add BrowserWindow.printToPDF API docs. --- docs/api/browser-window.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 11ac53096038..58e6fa73e35c 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -571,6 +571,32 @@ Calling `window.print()` in web page is equivalent to call doesn't need print feature, you can safely remove `pdf.dll` in saving binary size. +### BrowserWindow.printToPDF([options], callback) + +* `options` Object + * `marginsType` Integer - Specify the type of margins to use + * 0 - default + * 1 - none + * 2 - minimum + * `shouldPrintBackgrounds` Boolean - Whether to print CSS backgrounds. + * `shouldPrintSelectionOnly` Boolean - Whether to print selection only. + * `landscape` Boolean - `true` for landscape, `false` for portrait. + +* `callback` Function - `function(statusCode) {}` + * `statusCode` Integer + * 0 - Success. + * 1 - Fail to generate PDF file on renderer part. + * 2 - Fail to save PDF file on local disk. + * 3 - Users cancel the prompted save file dialog. + +Prints windows' web page as PDF with Chromium's preview printing custom +settings. The API will prompt a SaveDialog to allow user custom the file path +for saving the generated PDF file on disk. + +By default, the options will be +`{marginsType:0, shouldPrintBackgrounds:false, shouldPrintSelectionOnly:false, + landscape:false}`. + ### BrowserWindow.loadUrl(url, [options]) Same with `webContents.loadUrl(url, [options])`. From 68005f9ad4693bf761f2a983014ff71390107ee3 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Mon, 1 Jun 2015 14:14:33 +0800 Subject: [PATCH 0270/1293] Fix OS X compilation error. --- .../printing/print_web_view_helper_mac.mm | 41 +++++++++++++++++++ 1 file changed, 41 insertions(+) diff --git a/chromium_src/chrome/renderer/printing/print_web_view_helper_mac.mm b/chromium_src/chrome/renderer/printing/print_web_view_helper_mac.mm index 93fd06464b37..0785e30a9cfb 100644 --- a/chromium_src/chrome/renderer/printing/print_web_view_helper_mac.mm +++ b/chromium_src/chrome/renderer/printing/print_web_view_helper_mac.mm @@ -50,6 +50,47 @@ void PrintWebViewHelper::PrintPageInternal( Send(new PrintHostMsg_DidPrintPage(routing_id(), page_params)); } +bool PrintWebViewHelper::RenderPreviewPage( + int page_number, + const PrintMsg_Print_Params& print_params) { + PrintMsg_Print_Params printParams = print_params; + scoped_ptr draft_metafile; + PdfMetafileSkia* initial_render_metafile = print_preview_context_.metafile(); + + bool render_to_draft = print_preview_context_.IsModifiable() && + is_print_ready_metafile_sent_; + + if (render_to_draft) { + draft_metafile.reset(new PdfMetafileSkia()); + if (!draft_metafile->Init()) { + print_preview_context_.set_error( + PREVIEW_ERROR_MAC_DRAFT_METAFILE_INIT_FAILED); + LOG(ERROR) << "Draft PdfMetafileSkia Init failed"; + return false; + } + initial_render_metafile = draft_metafile.get(); + } + + base::TimeTicks begin_time = base::TimeTicks::Now(); + gfx::Size page_size; + RenderPage(printParams, page_number, print_preview_context_.prepared_frame(), + true, initial_render_metafile, &page_size, NULL); + print_preview_context_.RenderedPreviewPage( + base::TimeTicks::Now() - begin_time); + + if (draft_metafile.get()) { + draft_metafile->FinishDocument(); + } else { + if (print_preview_context_.IsModifiable() && + print_preview_context_.generate_draft_pages()) { + DCHECK(!draft_metafile.get()); + draft_metafile = + print_preview_context_.metafile()->GetMetafileForCurrentPage(); + } + } + return PreviewPageRendered(page_number, draft_metafile.get()); +} + void PrintWebViewHelper::RenderPage(const PrintMsg_Print_Params& params, int page_number, WebFrame* frame, From 36fa4da25217b6248ffe87e4b1fc0f84e231482f Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Mon, 1 Jun 2015 14:58:15 +0800 Subject: [PATCH 0271/1293] Fix Linux compilation error. --- .../printing/print_web_view_helper_linux.cc | 30 +++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/chromium_src/chrome/renderer/printing/print_web_view_helper_linux.cc b/chromium_src/chrome/renderer/printing/print_web_view_helper_linux.cc index 38bd9114d244..82d7779d0266 100644 --- a/chromium_src/chrome/renderer/printing/print_web_view_helper_linux.cc +++ b/chromium_src/chrome/renderer/printing/print_web_view_helper_linux.cc @@ -24,6 +24,36 @@ namespace printing { using blink::WebFrame; +bool PrintWebViewHelper::RenderPreviewPage( + int page_number, + const PrintMsg_Print_Params& print_params) { + PrintMsg_PrintPage_Params page_params; + page_params.params = print_params; + page_params.page_number = page_number; + scoped_ptr draft_metafile; + PdfMetafileSkia* initial_render_metafile = print_preview_context_.metafile(); + if (print_preview_context_.IsModifiable() && is_print_ready_metafile_sent_) { + draft_metafile.reset(new PdfMetafileSkia); + initial_render_metafile = draft_metafile.get(); + } + + base::TimeTicks begin_time = base::TimeTicks::Now(); + PrintPageInternal(page_params, + print_preview_context_.prepared_frame(), + initial_render_metafile); + print_preview_context_.RenderedPreviewPage( + base::TimeTicks::Now() - begin_time); + if (draft_metafile.get()) { + draft_metafile->FinishDocument(); + } else if (print_preview_context_.IsModifiable() && + print_preview_context_.generate_draft_pages()) { + DCHECK(!draft_metafile.get()); + draft_metafile = + print_preview_context_.metafile()->GetMetafileForCurrentPage(); + } + return PreviewPageRendered(page_number, draft_metafile.get()); +} + bool PrintWebViewHelper::PrintPagesNative(blink::WebFrame* frame, int page_count) { PdfMetafileSkia metafile; From 10da361db12a5898e9f233536544f0d6770ef5f8 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Mon, 1 Jun 2015 17:08:15 +0800 Subject: [PATCH 0272/1293] Fix a type error in checking function options. --- atom/browser/api/atom_api_window.cc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index 8872a0e7f6ca..7ab03181993c 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -433,7 +433,7 @@ void Window::Print(mate::Arguments* args) { void Window::PrintToPDF(mate::Arguments* args) { mate::Dictionary options; base::Callback callback; - if (!(args->Length() == 1 && !args->GetNext(&callback)) && + if (!(args->Length() == 1 && args->GetNext(&callback)) && !(args->Length() == 2 && args->GetNext(&options) && args->GetNext(&callback))) { args->ThrowError(); From 2597ded985b2427956496c6b034819e1f33665fe Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Mon, 1 Jun 2015 18:00:00 +0800 Subject: [PATCH 0273/1293] Cleanup. --- atom/browser/api/atom_api_window.cc | 2 +- atom/browser/native_window.cc | 2 +- .../printing/print_preview_message_handler.cc | 58 ++----------------- .../printing/print_preview_message_handler.h | 20 ++----- .../printing/print_web_view_helper.cc | 3 - 5 files changed, 13 insertions(+), 72 deletions(-) diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index 7ab03181993c..4b6ab9c95422 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -421,7 +421,7 @@ void Window::CapturePage(mate::Arguments* args) { } void Window::Print(mate::Arguments* args) { - PrintSettings settings = { false, false };; + PrintSettings settings = { false, false }; if (args->Length() == 1 && !args->GetNext(&settings)) { args->ThrowError(); return; diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 2edf8906d6c2..e1cdab59471b 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -268,7 +268,7 @@ void NativeWindow::Print(bool silent, bool print_background) { void NativeWindow::PrintToPDF(const mate::Dictionary& options, const PrintToPDFCallback& callback) { printing::PrintPreviewMessageHandler::FromWebContents(GetWebContents())-> - HandleGetPreview(options, callback); + PrintToPDF(options, callback); } void NativeWindow::ShowDefinitionForSelection() { diff --git a/chromium_src/chrome/browser/printing/print_preview_message_handler.cc b/chromium_src/chrome/browser/printing/print_preview_message_handler.cc index ee47742c687a..0ba9ea662e45 100644 --- a/chromium_src/chrome/browser/printing/print_preview_message_handler.cc +++ b/chromium_src/chrome/browser/printing/print_preview_message_handler.cc @@ -79,7 +79,8 @@ namespace printing { PrintPreviewMessageHandler::PrintPreviewMessageHandler( WebContents* web_contents) - : content::WebContentsObserver(web_contents) { + : request_id_(0), + content::WebContentsObserver(web_contents) { DCHECK(web_contents); } @@ -92,8 +93,6 @@ void PrintPreviewMessageHandler::OnDidGetPreviewPageCount( NOTREACHED(); return; } - - LOG(ERROR) << "OnDidGetPreviewPageCount: " << params.page_count; } void PrintPreviewMessageHandler::OnDidPreviewPage( @@ -101,7 +100,6 @@ void PrintPreviewMessageHandler::OnDidPreviewPage( int page_number = params.page_number; if (page_number < FIRST_PAGE_INDEX || !params.data_size) return; - LOG(ERROR) << "OnDidPreviewPage: " << params.data_size; } void PrintPreviewMessageHandler::OnMetafileReadyForPrinting( @@ -122,7 +120,6 @@ void PrintPreviewMessageHandler::OnMetafileReadyForPrinting( if (!data || !data->size()) return; - LOG(ERROR) << params.preview_request_id; atom::NativeWindow* window = atom::NativeWindow::FromWebContents( web_contents()); base::FilePath save_path; @@ -147,39 +144,6 @@ void PrintPreviewMessageHandler::OnPrintPreviewFailed(int document_cookie, RunPrintToPDFCallback(request_id, FAIL_PREVIEW); } -//void PrintPreviewMessageHandler::OnDidGetDefaultPageLayout( - //const PageSizeMargins& page_layout_in_points, - //const gfx::Rect& printable_area_in_points, - //bool has_custom_page_size_style) { - ////PrintPreviewUI* print_preview_ui = GetPrintPreviewUI(); - ////if (!print_preview_ui) - ////return; - ////print_preview_ui->OnDidGetDefaultPageLayout(page_layout_in_points, - ////printable_area_in_points, - ////has_custom_page_size_style); -//} - -//void PrintPreviewMessageHandler::OnPrintPreviewCancelled(int document_cookie) { - //// Always need to stop the worker. - //StopWorker(document_cookie); -//} - -//void PrintPreviewMessageHandler::OnInvalidPrinterSettings(int document_cookie) { - //StopWorker(document_cookie); - ////PrintPreviewUI* print_preview_ui = GetPrintPreviewUI(); - ////if (!print_preview_ui) - ////return; - ////print_preview_ui->OnInvalidPrinterSettings(); -//} - -//void PrintPreviewMessageHandler::OnSetOptionsFromDocument( - //const PrintHostMsg_SetOptionsFromDocument_Params& params) { - ////PrintPreviewUI* print_preview_ui = GetPrintPreviewUI(); - ////if (!print_preview_ui) - ////return; - ////print_preview_ui->OnSetOptionsFromDocument(params); -//} - bool PrintPreviewMessageHandler::OnMessageReceived( const IPC::Message& message) { bool handled = true; @@ -192,24 +156,14 @@ bool PrintPreviewMessageHandler::OnMessageReceived( OnMetafileReadyForPrinting) IPC_MESSAGE_HANDLER(PrintHostMsg_PrintPreviewFailed, OnPrintPreviewFailed) - //IPC_MESSAGE_HANDLER(PrintHostMsg_DidGetDefaultPageLayout, - //OnDidGetDefaultPageLayout) - //IPC_MESSAGE_HANDLER(PrintHostMsg_PrintPreviewCancelled, - //OnPrintPreviewCancelled) - //IPC_MESSAGE_HANDLER(PrintHostMsg_PrintPreviewInvalidPrinterSettings, - //OnInvalidPrinterSettings) - //IPC_MESSAGE_HANDLER(PrintHostMsg_SetOptionsFromDocument, - //OnSetOptionsFromDocument) IPC_MESSAGE_UNHANDLED(handled = false) IPC_END_MESSAGE_MAP() return handled; } -void PrintPreviewMessageHandler::HandleGetPreview( +void PrintPreviewMessageHandler::PrintToPDF( const mate::Dictionary& options, const atom::NativeWindow::PrintToPDFCallback& callback) { - static int request_id = 0; - request_id++; // A simulated Chromium print preivew setting. const std::string setting_json_str = "{ \ \"pageRage\":[], \ @@ -244,8 +198,9 @@ void PrintPreviewMessageHandler::HandleGetPreview( scoped_ptr settings( static_cast( base::JSONReader::Read(setting_json_str))); - settings->SetInteger(printing::kPreviewRequestID, request_id); - print_to_pdf_callback_map_[request_id] = callback; + settings->SetInteger(printing::kPreviewRequestID, request_id_); + print_to_pdf_callback_map_[request_id_] = callback; + ++request_id_; // Default Print PDF settings: @@ -267,7 +222,6 @@ void PrintPreviewMessageHandler::HandleGetPreview( settings->SetBoolean(printing::kSettingShouldPrintSelectionOnly, print_selection_only); settings->SetBoolean(printing::kSettingLandscape, is_landscape); - LOG(ERROR) << "Print preview request start"; content::RenderViewHost* rvh = web_contents()->GetRenderViewHost(); rvh->Send(new PrintMsg_PrintPreview(rvh->GetRoutingID(), *settings)); } diff --git a/chromium_src/chrome/browser/printing/print_preview_message_handler.h b/chromium_src/chrome/browser/printing/print_preview_message_handler.h index f4298fb6b2fc..585eca7e0546 100644 --- a/chromium_src/chrome/browser/printing/print_preview_message_handler.h +++ b/chromium_src/chrome/browser/printing/print_preview_message_handler.h @@ -49,10 +49,8 @@ class PrintPreviewMessageHandler // content::WebContentsObserver implementation. bool OnMessageReceived(const IPC::Message& message) override; - // Asks the initiator renderer to generate a preview. First element of |args| - // is a job settings JSON string. - void HandleGetPreview(const mate::Dictionary& options, - const atom::NativeWindow::PrintToPDFCallback& callback); + void PrintToPDF(const mate::Dictionary& options, + const atom::NativeWindow::PrintToPDFCallback& callback); private: typedef std::map PrintToPDFCallbackMap; @@ -60,27 +58,19 @@ class PrintPreviewMessageHandler explicit PrintPreviewMessageHandler(content::WebContents* web_contents); friend class content::WebContentsUserData; - // Message handlers. - //void OnRequestPrintPreview( - //const PrintHostMsg_RequestPrintPreview_Params& params); - //void OnDidGetDefaultPageLayout( - //const printing::PageSizeMargins& page_layout_in_points, - //const gfx::Rect& printable_area_in_points, - //bool has_custom_page_size_style); void OnDidGetPreviewPageCount( const PrintHostMsg_DidGetPreviewPageCount_Params& params); void OnDidPreviewPage(const PrintHostMsg_DidPreviewPage_Params& params); void OnMetafileReadyForPrinting( const PrintHostMsg_DidPreviewDocument_Params& params); void OnPrintPreviewFailed(int document_cookie, int request_id); - //void OnPrintPreviewCancelled(int document_cookie); - //void OnInvalidPrinterSettings(int document_cookie); - //void OnSetOptionsFromDocument( - //const PrintHostMsg_SetOptionsFromDocument_Params& params); void RunPrintToPDFCallback(int request_id, PrintPDFResult result); + // PrintToPDF request id counter. + int request_id_; + PrintToPDFCallbackMap print_to_pdf_callback_map_; DISALLOW_COPY_AND_ASSIGN(PrintPreviewMessageHandler); diff --git a/chromium_src/chrome/renderer/printing/print_web_view_helper.cc b/chromium_src/chrome/renderer/printing/print_web_view_helper.cc index 550735f709b5..643340deac3b 100644 --- a/chromium_src/chrome/renderer/printing/print_web_view_helper.cc +++ b/chromium_src/chrome/renderer/printing/print_web_view_helper.cc @@ -717,19 +717,16 @@ void PrintWebViewHelper::OnPrintPreview(const base::DictionaryValue& settings) { blink::WebLocalFrame* frame; if (GetPrintFrame(&frame)) { print_preview_context_.InitWithFrame(frame); - LOG(ERROR) << "OnPrintPreview1"; if (!print_preview_context_.source_frame()) { DidFinishPrinting(FAIL_PREVIEW); return; } - LOG(ERROR) << "OnPrintPreview2"; if (!UpdatePrintSettings(print_preview_context_.source_frame(), print_preview_context_.source_node(), settings)) { DidFinishPrinting(FAIL_PREVIEW); return; } - LOG(ERROR) << "OnPrintPreview3"; is_print_ready_metafile_sent_ = false; PrepareFrameForPreviewDocument(); } From c0a6cb69bf21847c84b850fc8a537d0d878bfb65 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Tue, 9 Jun 2015 13:07:40 +0800 Subject: [PATCH 0274/1293] Move printToPDF API to WebContents. Also expose in webview. --- atom/browser/api/atom_api_web_contents.cc | 18 ++++++++++++++++++ atom/browser/api/atom_api_web_contents.h | 3 +++ atom/browser/api/atom_api_window.cc | 13 ------------- atom/browser/native_window.cc | 6 ------ atom/browser/native_window.h | 4 ---- atom/renderer/lib/web-view/web-view.coffee | 1 + 6 files changed, 22 insertions(+), 23 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index ec24ab45fa24..e325ed902aed 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -18,6 +18,7 @@ #include "base/strings/string_util.h" #include "base/strings/utf_string_conversions.h" #include "brightray/browser/inspectable_web_contents.h" +#include "chrome/browser/printing/print_preview_message_handler.h" #include "content/public/browser/favicon_status.h" #include "content/public/browser/guest_host.h" #include "content/public/browser/navigation_details.h" @@ -137,6 +138,7 @@ WebContents::WebContents(const mate::Dictionary& options) inspectable_web_contents_ = managed_web_contents(); Observe(GetWebContents()); + printing::PrintPreviewMessageHandler::CreateForWebContents(web_contents); } WebContents::~WebContents() { @@ -580,6 +582,7 @@ void WebContents::UnregisterServiceWorker( callback); } +<<<<<<< HEAD void WebContents::SetAudioMuted(bool muted) { web_contents()->SetAudioMuted(muted); } @@ -588,6 +591,20 @@ bool WebContents::IsAudioMuted() { return web_contents()->IsAudioMuted(); } +void WebContents::PrintToPDF(mate::Arguments* args) { + mate::Dictionary options; + base::Callback callback; + if (!(args->Length() == 1 && args->GetNext(&callback)) && + !(args->Length() == 2 && args->GetNext(&options) + && args->GetNext(&callback))) { + args->ThrowError(); + return; + } + + printing::PrintPreviewMessageHandler::FromWebContents(web_contents())-> + PrintToPDF(options, callback); +} + void WebContents::Undo() { web_contents()->Undo(); } @@ -760,6 +777,7 @@ mate::ObjectTemplateBuilder WebContents::GetObjectTemplateBuilder( .SetMethod("unregisterServiceWorker", &WebContents::UnregisterServiceWorker) .SetMethod("inspectServiceWorker", &WebContents::InspectServiceWorker) + .SetMethod("printToPDF", &WebContents::PrintToPDF) .Build()); return mate::ObjectTemplateBuilder( diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index 7c20144517f3..0f8f08889fef 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -90,6 +90,9 @@ class WebContents : public mate::EventEmitter, void SetAudioMuted(bool muted); bool IsAudioMuted(); + // Print current page as PDF. + void PrintToPDF(mate::Arguments* args); + // Editing commands. void Undo(); void Redo(); diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index 4b6ab9c95422..69271c0db328 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -430,18 +430,6 @@ void Window::Print(mate::Arguments* args) { window_->Print(settings.silent, settings.print_background); } -void Window::PrintToPDF(mate::Arguments* args) { - mate::Dictionary options; - base::Callback callback; - if (!(args->Length() == 1 && args->GetNext(&callback)) && - !(args->Length() == 2 && args->GetNext(&options) - && args->GetNext(&callback))) { - args->ThrowError(); - return; - } - window_->PrintToPDF(options, callback); -} - void Window::SetProgressBar(double progress) { window_->SetProgressBar(progress); } @@ -554,7 +542,6 @@ void Window::BuildPrototype(v8::Isolate* isolate, .SetMethod("isWebViewFocused", &Window::IsWebViewFocused) .SetMethod("capturePage", &Window::CapturePage) .SetMethod("print", &Window::Print) - .SetMethod("printToPDF", &Window::PrintToPDF) .SetMethod("setProgressBar", &Window::SetProgressBar) .SetMethod("setOverlayIcon", &Window::SetOverlayIcon) .SetMethod("_setMenu", &Window::SetMenu) diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index e1cdab59471b..581565ad188c 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -265,12 +265,6 @@ void NativeWindow::Print(bool silent, bool print_background) { PrintNow(silent, print_background); } -void NativeWindow::PrintToPDF(const mate::Dictionary& options, - const PrintToPDFCallback& callback) { - printing::PrintPreviewMessageHandler::FromWebContents(GetWebContents())-> - PrintToPDF(options, callback); -} - void NativeWindow::ShowDefinitionForSelection() { NOTIMPLEMENTED(); } diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index 78187bc8d458..a5b8b677b2d5 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -158,10 +158,6 @@ class NativeWindow : public CommonWebContentsDelegate, // Print current page. virtual void Print(bool silent, bool print_background); - // Print current page as PDF. - virtual void PrintToPDF(const mate::Dictionary& options, - const PrintToPDFCallback& callback); - // Show popup dictionary. virtual void ShowDefinitionForSelection(); diff --git a/atom/renderer/lib/web-view/web-view.coffee b/atom/renderer/lib/web-view/web-view.coffee index 443b2bca1f2d..3778d7f48d3f 100644 --- a/atom/renderer/lib/web-view/web-view.coffee +++ b/atom/renderer/lib/web-view/web-view.coffee @@ -291,6 +291,7 @@ registerWebViewElement = -> "send" "getId" "inspectServiceWorker" + "printToPDF" ] # Forward proto.foo* method calls to WebViewImpl.foo*. From 6e099af5fee8da4bcfed982f35688191ec975e14 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Wed, 10 Jun 2015 11:34:16 +0800 Subject: [PATCH 0275/1293] Move PDF printing setting in JS part. --- atom/browser/api/atom_api_web_contents.cc | 17 ++--- atom/browser/api/atom_api_web_contents.h | 5 +- atom/browser/api/lib/web-contents.coffee | 43 ++++++++++++ atom/browser/native_window.h | 1 - .../printing/print_preview_message_handler.cc | 69 ++----------------- .../printing/print_preview_message_handler.h | 12 ++-- 6 files changed, 64 insertions(+), 83 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index e325ed902aed..d72e5539a6de 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -582,6 +582,7 @@ void WebContents::UnregisterServiceWorker( callback); } +<<<<<<< HEAD <<<<<<< HEAD void WebContents::SetAudioMuted(bool muted) { web_contents()->SetAudioMuted(muted); @@ -591,18 +592,10 @@ bool WebContents::IsAudioMuted() { return web_contents()->IsAudioMuted(); } -void WebContents::PrintToPDF(mate::Arguments* args) { - mate::Dictionary options; - base::Callback callback; - if (!(args->Length() == 1 && args->GetNext(&callback)) && - !(args->Length() == 2 && args->GetNext(&options) - && args->GetNext(&callback))) { - args->ThrowError(); - return; - } - +void WebContents::PrintToPDF(const base::DictionaryValue& setting, + const PrintToPDFCallback& callback) { printing::PrintPreviewMessageHandler::FromWebContents(web_contents())-> - PrintToPDF(options, callback); + PrintToPDF(setting, callback); } void WebContents::Undo() { @@ -777,7 +770,7 @@ mate::ObjectTemplateBuilder WebContents::GetObjectTemplateBuilder( .SetMethod("unregisterServiceWorker", &WebContents::UnregisterServiceWorker) .SetMethod("inspectServiceWorker", &WebContents::InspectServiceWorker) - .SetMethod("printToPDF", &WebContents::PrintToPDF) + .SetMethod("_printToPDF", &WebContents::PrintToPDF) .Build()); return mate::ObjectTemplateBuilder( diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index 0f8f08889fef..13abf5184d15 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -52,6 +52,8 @@ class WebContents : public mate::EventEmitter, public content::WebContentsObserver, public content::GpuDataManagerObserver { public: + typedef base::Callback PrintToPDFCallback; + // Create from an existing WebContents. static mate::Handle CreateFrom( v8::Isolate* isolate, brightray::InspectableWebContents* web_contents); @@ -91,7 +93,8 @@ class WebContents : public mate::EventEmitter, bool IsAudioMuted(); // Print current page as PDF. - void PrintToPDF(mate::Arguments* args); + void PrintToPDF(const base::DictionaryValue& setting, + const PrintToPDFCallback& callback); // Editing commands. void Undo(); diff --git a/atom/browser/api/lib/web-contents.coffee b/atom/browser/api/lib/web-contents.coffee index b8c101423d04..5725f0011908 100644 --- a/atom/browser/api/lib/web-contents.coffee +++ b/atom/browser/api/lib/web-contents.coffee @@ -3,6 +3,9 @@ NavigationController = require './navigation-controller' binding = process.atomBinding 'web_contents' ipc = require 'ipc' +nextId = 0 +getNextId = -> ++nextId + wrapWebContents = (webContents) -> # webContents is an EventEmitter. webContents.__proto__ = EventEmitter.prototype @@ -58,6 +61,46 @@ wrapWebContents = (webContents) -> Object.defineProperty event, 'sender', value: webContents ipc.emit channel, event, args... + webContents.printToPDF = (options, callback) -> + printingSetting = + pageRage:[], + mediaSize: + height_microns:297000, + is_default:true, + name:"ISO_A4", + width_microns:210000, + custom_display_name:"A4", + landscape:false, + color:2, + headerFooterEnabled:false, + marginsType:0, + isFirstRequest:false, + requestID: getNextId(), + previewModifiable:true, + printToPDF:true, + printWithCloudPrint:false, + printWithPrivet:false, + printWithExtension:false, + deviceName:"Save as PDF", + generateDraftData:true, + fitToPageEnabled:false, + duplex:0, + copies:1, + collate:true, + shouldPrintBackgrounds:false, + shouldPrintSelectionOnly:false + + if options.landscape + printingSetting.landscape = options.landscape + if options.marginsType + printingSetting.marginsType = options.marginsType + if options.printSelectionOnly + printingSetting.shouldPrintSelectionOnly = options.printSelectionOnly + if options.printCSSBackgrounds + printingSetting.shouldPrintBackgrounds = options.printBackgrounds + + webContents._printToPDF printingSetting, callback + webContents binding._setWrapWebContents wrapWebContents diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index a5b8b677b2d5..2038775f8d9a 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -55,7 +55,6 @@ class NativeWindow : public CommonWebContentsDelegate, public content::NotificationObserver { public: typedef base::Callback CapturePageCallback; - typedef base::Callback PrintToPDFCallback; class DialogScope { public: diff --git a/chromium_src/chrome/browser/printing/print_preview_message_handler.cc b/chromium_src/chrome/browser/printing/print_preview_message_handler.cc index 0ba9ea662e45..dc7052cab1a1 100644 --- a/chromium_src/chrome/browser/printing/print_preview_message_handler.cc +++ b/chromium_src/chrome/browser/printing/print_preview_message_handler.cc @@ -79,8 +79,7 @@ namespace printing { PrintPreviewMessageHandler::PrintPreviewMessageHandler( WebContents* web_contents) - : request_id_(0), - content::WebContentsObserver(web_contents) { + : content::WebContentsObserver(web_contents) { DCHECK(web_contents); } @@ -162,68 +161,14 @@ bool PrintPreviewMessageHandler::OnMessageReceived( } void PrintPreviewMessageHandler::PrintToPDF( - const mate::Dictionary& options, - const atom::NativeWindow::PrintToPDFCallback& callback) { - // A simulated Chromium print preivew setting. - const std::string setting_json_str = "{ \ - \"pageRage\":[], \ - \"mediaSize\":{ \ - \"height_microns\":297000, \ - \"is_default\":true, \ - \"name\":\"ISO_A4\", \ - \"width_microns\":210000, \ - \"custom_display_name\":\"A4\" \ - }, \ - \"landscape\":false, \ - \"color\":2, \ - \"headerFooterEnabled\":false, \ - \"marginsType\":0, \ - \"isFirstRequest\":false, \ - \"requestID\":1, \ - \"previewModifiable\":true, \ - \"printToPDF\":true, \ - \"printWithCloudPrint\":false, \ - \"printWithPrivet\":false, \ - \"printWithExtension\":false, \ - \"deviceName\":\"Save as PDF\", \ - \"generateDraftData\":true, \ - \"fitToPageEnabled\":false, \ - \"duplex\":0, \ - \"copies\":1, \ - \"collate\":true, \ - \"shouldPrintBackgrounds\":false, \ - \"shouldPrintSelectionOnly\":false \ - }"; + const base::DictionaryValue& options, + const atom::api::WebContents::PrintToPDFCallback& callback) { + int request_id; + options.GetInteger(printing::kPreviewRequestID, &request_id); + print_to_pdf_callback_map_[request_id] = callback; - scoped_ptr settings( - static_cast( - base::JSONReader::Read(setting_json_str))); - settings->SetInteger(printing::kPreviewRequestID, request_id_); - print_to_pdf_callback_map_[request_id_] = callback; - ++request_id_; - - - // Default Print PDF settings: - int margins_type = 0; // DEFAULT_MARGINS - bool print_background = false; - bool print_selection_only = false; - bool is_landscape = false; - - if (!options.IsEmpty()) { - options.Get(printing::kSettingMarginsType, &margins_type); - options.Get(printing::kSettingShouldPrintBackgrounds, &print_background); - options.Get(printing::kSettingShouldPrintSelectionOnly, - &print_selection_only); - options.Get(printing::kSettingLandscape, &is_landscape); - } - settings->SetInteger(printing::kSettingMarginsType, margins_type); - settings->SetBoolean(printing::kSettingShouldPrintBackgrounds, - print_background); - settings->SetBoolean(printing::kSettingShouldPrintSelectionOnly, - print_selection_only); - settings->SetBoolean(printing::kSettingLandscape, is_landscape); content::RenderViewHost* rvh = web_contents()->GetRenderViewHost(); - rvh->Send(new PrintMsg_PrintPreview(rvh->GetRoutingID(), *settings)); + rvh->Send(new PrintMsg_PrintPreview(rvh->GetRoutingID(), options)); } void PrintPreviewMessageHandler::RunPrintToPDFCallback( diff --git a/chromium_src/chrome/browser/printing/print_preview_message_handler.h b/chromium_src/chrome/browser/printing/print_preview_message_handler.h index 585eca7e0546..692baba36ee7 100644 --- a/chromium_src/chrome/browser/printing/print_preview_message_handler.h +++ b/chromium_src/chrome/browser/printing/print_preview_message_handler.h @@ -7,7 +7,7 @@ #include -#include "atom/browser/native_window.h" +#include "atom/browser/api/atom_api_web_contents.h" #include "base/compiler_specific.h" #include "content/public/browser/web_contents_observer.h" #include "content/public/browser/web_contents_user_data.h" @@ -49,11 +49,12 @@ class PrintPreviewMessageHandler // content::WebContentsObserver implementation. bool OnMessageReceived(const IPC::Message& message) override; - void PrintToPDF(const mate::Dictionary& options, - const atom::NativeWindow::PrintToPDFCallback& callback); + void PrintToPDF(const base::DictionaryValue& options, + const atom::api::WebContents::PrintToPDFCallback& callback); private: - typedef std::map PrintToPDFCallbackMap; + typedef std::map + PrintToPDFCallbackMap; explicit PrintPreviewMessageHandler(content::WebContents* web_contents); friend class content::WebContentsUserData; @@ -68,9 +69,6 @@ class PrintPreviewMessageHandler void RunPrintToPDFCallback(int request_id, PrintPDFResult result); - // PrintToPDF request id counter. - int request_id_; - PrintToPDFCallbackMap print_to_pdf_callback_map_; DISALLOW_COPY_AND_ASSIGN(PrintPreviewMessageHandler); From ab40da3f31b9cbc8baa173c701b6ce61fc5ffe02 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Wed, 10 Jun 2015 13:18:41 +0800 Subject: [PATCH 0276/1293] Add silent and savePath options. --- atom/browser/api/lib/web-contents.coffee | 1 + .../printing/print_preview_message_handler.cc | 36 ++++++++++++------- .../printing/print_preview_message_handler.h | 12 +++++-- 3 files changed, 34 insertions(+), 15 deletions(-) diff --git a/atom/browser/api/lib/web-contents.coffee b/atom/browser/api/lib/web-contents.coffee index 5725f0011908..865154f0cdc4 100644 --- a/atom/browser/api/lib/web-contents.coffee +++ b/atom/browser/api/lib/web-contents.coffee @@ -89,6 +89,7 @@ wrapWebContents = (webContents) -> collate:true, shouldPrintBackgrounds:false, shouldPrintSelectionOnly:false + silent:false if options.landscape printingSetting.landscape = options.landscape diff --git a/chromium_src/chrome/browser/printing/print_preview_message_handler.cc b/chromium_src/chrome/browser/printing/print_preview_message_handler.cc index dc7052cab1a1..9b72a9a10445 100644 --- a/chromium_src/chrome/browser/printing/print_preview_message_handler.cc +++ b/chromium_src/chrome/browser/printing/print_preview_message_handler.cc @@ -119,14 +119,21 @@ void PrintPreviewMessageHandler::OnMetafileReadyForPrinting( if (!data || !data->size()) return; - atom::NativeWindow* window = atom::NativeWindow::FromWebContents( - web_contents()); - base::FilePath save_path; - if (!file_dialog::ShowSaveDialog(window, "Save As", - base::FilePath(FILE_PATH_LITERAL("print.pdf")), - file_dialog::Filters(), &save_path)) { // Users cancel dialog. - RunPrintToPDFCallback(params.preview_request_id, FAIL_CANCEL); - return; + int request_id = params.preview_request_id; + std::string file_path = + print_to_pdf_request_details_map_[request_id].save_path; + base::FilePath save_path = + file_path.empty() ? base::FilePath(FILE_PATH_LITERAL("print.pdf")): + base::FilePath::FromUTF8Unsafe(file_path); + if (!print_to_pdf_request_details_map_[request_id].silent) { + atom::NativeWindow* window = atom::NativeWindow::FromWebContents( + web_contents()); + if (!file_dialog::ShowSaveDialog(window, "Save As", + base::FilePath(FILE_PATH_LITERAL("print.pdf")), + file_dialog::Filters(), &save_path)) { // Users cancel dialog. + RunPrintToPDFCallback(request_id, FAIL_CANCEL); + return; + } } BrowserThread::PostTaskAndReplyWithResult( BrowserThread::FILE, @@ -134,7 +141,7 @@ void PrintPreviewMessageHandler::OnMetafileReadyForPrinting( base::Bind(&SavePDF, data, save_path), base::Bind(&PrintPreviewMessageHandler::RunPrintToPDFCallback, base::Unretained(this), - params.preview_request_id)); + request_id)); } void PrintPreviewMessageHandler::OnPrintPreviewFailed(int document_cookie, @@ -165,7 +172,11 @@ void PrintPreviewMessageHandler::PrintToPDF( const atom::api::WebContents::PrintToPDFCallback& callback) { int request_id; options.GetInteger(printing::kPreviewRequestID, &request_id); - print_to_pdf_callback_map_[request_id] = callback; + PrintToPDFRequestDetails details; + options.GetBoolean("silent", &details.silent); + options.GetString("savePath", &details.save_path); + details.callback = callback; + print_to_pdf_request_details_map_[request_id] = details; content::RenderViewHost* rvh = web_contents()->GetRenderViewHost(); rvh->Send(new PrintMsg_PrintPreview(rvh->GetRoutingID(), options)); @@ -173,8 +184,9 @@ void PrintPreviewMessageHandler::PrintToPDF( void PrintPreviewMessageHandler::RunPrintToPDFCallback( int request_id, PrintPDFResult result) { - print_to_pdf_callback_map_[request_id].Run(static_cast(result)); - print_to_pdf_callback_map_.erase(request_id); + print_to_pdf_request_details_map_[request_id].callback.Run( + static_cast(result)); + print_to_pdf_request_details_map_.erase(request_id); } } // namespace printing diff --git a/chromium_src/chrome/browser/printing/print_preview_message_handler.h b/chromium_src/chrome/browser/printing/print_preview_message_handler.h index 692baba36ee7..656fde4a6083 100644 --- a/chromium_src/chrome/browser/printing/print_preview_message_handler.h +++ b/chromium_src/chrome/browser/printing/print_preview_message_handler.h @@ -53,8 +53,14 @@ class PrintPreviewMessageHandler const atom::api::WebContents::PrintToPDFCallback& callback); private: - typedef std::map - PrintToPDFCallbackMap; + struct PrintToPDFRequestDetails { + std::string save_path; + bool silent; + atom::api::WebContents::PrintToPDFCallback callback; + }; + + typedef std::map + PrintToPDFRequestDetailsMap; explicit PrintPreviewMessageHandler(content::WebContents* web_contents); friend class content::WebContentsUserData; @@ -69,7 +75,7 @@ class PrintPreviewMessageHandler void RunPrintToPDFCallback(int request_id, PrintPDFResult result); - PrintToPDFCallbackMap print_to_pdf_callback_map_; + PrintToPDFRequestDetailsMap print_to_pdf_request_details_map_; DISALLOW_COPY_AND_ASSIGN(PrintPreviewMessageHandler); }; From ac62871645df7bec445312a5a290fbbc4b390a77 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Wed, 10 Jun 2015 15:16:00 +0800 Subject: [PATCH 0277/1293] Return node::Buffer as a printToPDF callback result. --- atom/browser/api/atom_api_web_contents.h | 2 +- atom/browser/api/lib/web-contents.coffee | 1 - .../printing/print_preview_message_handler.cc | 71 +++++-------------- .../printing/print_preview_message_handler.h | 22 ++---- 4 files changed, 25 insertions(+), 71 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index 13abf5184d15..dbd75db286fd 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -52,7 +52,7 @@ class WebContents : public mate::EventEmitter, public content::WebContentsObserver, public content::GpuDataManagerObserver { public: - typedef base::Callback PrintToPDFCallback; + typedef base::Callback)> PrintToPDFCallback; // Create from an existing WebContents. static mate::Handle CreateFrom( diff --git a/atom/browser/api/lib/web-contents.coffee b/atom/browser/api/lib/web-contents.coffee index 865154f0cdc4..5725f0011908 100644 --- a/atom/browser/api/lib/web-contents.coffee +++ b/atom/browser/api/lib/web-contents.coffee @@ -89,7 +89,6 @@ wrapWebContents = (webContents) -> collate:true, shouldPrintBackgrounds:false, shouldPrintSelectionOnly:false - silent:false if options.landscape printingSetting.landscape = options.landscape diff --git a/chromium_src/chrome/browser/printing/print_preview_message_handler.cc b/chromium_src/chrome/browser/printing/print_preview_message_handler.cc index 9b72a9a10445..50739ed57323 100644 --- a/chromium_src/chrome/browser/printing/print_preview_message_handler.cc +++ b/chromium_src/chrome/browser/printing/print_preview_message_handler.cc @@ -25,6 +25,8 @@ #include "printing/print_job_constants.h" #include "printing/pdf_metafile_skia.h" +#include "atom/common/node_includes.h" + using content::BrowserThread; using content::WebContents; @@ -60,18 +62,6 @@ base::RefCountedBytes* GetDataFromHandle(base::SharedMemoryHandle handle, return base::RefCountedBytes::TakeVector(&data); } -printing::PrintPreviewMessageHandler::PrintPDFResult -SavePDF(const scoped_refptr& data, - const base::FilePath& save_path) { - printing::PdfMetafileSkia metafile; - metafile.InitFromData(static_cast(data->front()), data->size()); - base::File file(save_path, - base::File::FLAG_CREATE_ALWAYS | base::File::FLAG_WRITE); - return metafile.SaveTo(&file)? - printing::PrintPreviewMessageHandler::SUCCESS : - printing::PrintPreviewMessageHandler::FAIL_SAVEFILE; -} - } // namespace namespace printing { @@ -111,43 +101,15 @@ void PrintPreviewMessageHandler::OnMetafileReadyForPrinting( return; } - // TODO(joth): This seems like a good match for using RefCountedStaticMemory - // to avoid the memory copy, but the SetPrintPreviewData call chain below - // needs updating to accept the RefCountedMemory* base class. - scoped_refptr data( + base::RefCountedBytes *data = ( GetDataFromHandle(params.metafile_data_handle, params.data_size)); - if (!data || !data->size()) - return; - - int request_id = params.preview_request_id; - std::string file_path = - print_to_pdf_request_details_map_[request_id].save_path; - base::FilePath save_path = - file_path.empty() ? base::FilePath(FILE_PATH_LITERAL("print.pdf")): - base::FilePath::FromUTF8Unsafe(file_path); - if (!print_to_pdf_request_details_map_[request_id].silent) { - atom::NativeWindow* window = atom::NativeWindow::FromWebContents( - web_contents()); - if (!file_dialog::ShowSaveDialog(window, "Save As", - base::FilePath(FILE_PATH_LITERAL("print.pdf")), - file_dialog::Filters(), &save_path)) { // Users cancel dialog. - RunPrintToPDFCallback(request_id, FAIL_CANCEL); - return; - } - } - BrowserThread::PostTaskAndReplyWithResult( - BrowserThread::FILE, - FROM_HERE, - base::Bind(&SavePDF, data, save_path), - base::Bind(&PrintPreviewMessageHandler::RunPrintToPDFCallback, - base::Unretained(this), - request_id)); + RunPrintToPDFCallback(params.preview_request_id, data); } void PrintPreviewMessageHandler::OnPrintPreviewFailed(int document_cookie, int request_id) { StopWorker(document_cookie); - RunPrintToPDFCallback(request_id, FAIL_PREVIEW); + RunPrintToPDFCallback(request_id, nullptr); } bool PrintPreviewMessageHandler::OnMessageReceived( @@ -172,21 +134,26 @@ void PrintPreviewMessageHandler::PrintToPDF( const atom::api::WebContents::PrintToPDFCallback& callback) { int request_id; options.GetInteger(printing::kPreviewRequestID, &request_id); - PrintToPDFRequestDetails details; - options.GetBoolean("silent", &details.silent); - options.GetString("savePath", &details.save_path); - details.callback = callback; - print_to_pdf_request_details_map_[request_id] = details; + print_to_pdf_callback_map_[request_id] = callback; content::RenderViewHost* rvh = web_contents()->GetRenderViewHost(); rvh->Send(new PrintMsg_PrintPreview(rvh->GetRoutingID(), options)); } void PrintPreviewMessageHandler::RunPrintToPDFCallback( - int request_id, PrintPDFResult result) { - print_to_pdf_request_details_map_[request_id].callback.Run( - static_cast(result)); - print_to_pdf_request_details_map_.erase(request_id); + int request_id, base::RefCountedBytes* data) { + v8::Isolate* isolate = v8::Isolate::GetCurrent(); + v8::Locker locker(isolate); + v8::HandleScope handle_scope(isolate); + if (data) { + v8::Local buffer = node::Buffer::Use( + const_cast(reinterpret_cast(data->front())), + data->size()); + print_to_pdf_callback_map_[request_id].Run(buffer); + } else { + print_to_pdf_callback_map_[request_id].Run(v8::Null(isolate)); + } + print_to_pdf_callback_map_.erase(request_id); } } // namespace printing diff --git a/chromium_src/chrome/browser/printing/print_preview_message_handler.h b/chromium_src/chrome/browser/printing/print_preview_message_handler.h index 656fde4a6083..bfdd436b196c 100644 --- a/chromium_src/chrome/browser/printing/print_preview_message_handler.h +++ b/chromium_src/chrome/browser/printing/print_preview_message_handler.h @@ -37,13 +37,6 @@ class PrintPreviewMessageHandler : public content::WebContentsObserver, public content::WebContentsUserData { public: - enum PrintPDFResult { - SUCCESS, - FAIL_PREVIEW, - FAIL_SAVEFILE, - FAIL_CANCEL, - }; - ~PrintPreviewMessageHandler() override; // content::WebContentsObserver implementation. @@ -53,14 +46,8 @@ class PrintPreviewMessageHandler const atom::api::WebContents::PrintToPDFCallback& callback); private: - struct PrintToPDFRequestDetails { - std::string save_path; - bool silent; - atom::api::WebContents::PrintToPDFCallback callback; - }; - - typedef std::map - PrintToPDFRequestDetailsMap; + typedef std::map + PrintToPDFCallbackMap; explicit PrintPreviewMessageHandler(content::WebContents* web_contents); friend class content::WebContentsUserData; @@ -73,9 +60,10 @@ class PrintPreviewMessageHandler const PrintHostMsg_DidPreviewDocument_Params& params); void OnPrintPreviewFailed(int document_cookie, int request_id); - void RunPrintToPDFCallback(int request_id, PrintPDFResult result); + void RunPrintToPDFCallback( + int request_id, base::RefCountedBytes* data); - PrintToPDFRequestDetailsMap print_to_pdf_request_details_map_; + PrintToPDFCallbackMap print_to_pdf_callback_map_; DISALLOW_COPY_AND_ASSIGN(PrintPreviewMessageHandler); }; From 47439cd77c95a535bdd52f7d602b412f387dff7b Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Wed, 10 Jun 2015 15:43:33 +0800 Subject: [PATCH 0278/1293] Fix a type error. --- atom/browser/api/lib/web-contents.coffee | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/atom/browser/api/lib/web-contents.coffee b/atom/browser/api/lib/web-contents.coffee index 5725f0011908..95b651e13d3d 100644 --- a/atom/browser/api/lib/web-contents.coffee +++ b/atom/browser/api/lib/web-contents.coffee @@ -96,7 +96,7 @@ wrapWebContents = (webContents) -> printingSetting.marginsType = options.marginsType if options.printSelectionOnly printingSetting.shouldPrintSelectionOnly = options.printSelectionOnly - if options.printCSSBackgrounds + if options.printBackgrounds printingSetting.shouldPrintBackgrounds = options.printBackgrounds webContents._printToPDF printingSetting, callback From 93243ef223b0c47422c878772d55196ee97a0229 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Wed, 10 Jun 2015 18:29:07 +0800 Subject: [PATCH 0279/1293] Remove some unused IPC messages. --- atom/browser/api/atom_api_window.h | 1 - .../printing/print_preview_message_handler.cc | 19 --------- .../printing/print_preview_message_handler.h | 13 ------ chromium_src/chrome/common/print_messages.h | 42 ------------------- .../printing/print_web_view_helper.cc | 41 ------------------ 5 files changed, 116 deletions(-) diff --git a/atom/browser/api/atom_api_window.h b/atom/browser/api/atom_api_window.h index 828ab2ab9014..43a32e86f45a 100644 --- a/atom/browser/api/atom_api_window.h +++ b/atom/browser/api/atom_api_window.h @@ -132,7 +132,6 @@ class Window : public mate::EventEmitter, bool IsDocumentEdited(); void CapturePage(mate::Arguments* args); void Print(mate::Arguments* args); - void PrintToPDF(mate::Arguments* args); void SetProgressBar(double progress); void SetOverlayIcon(const gfx::Image& overlay, const std::string& description); diff --git a/chromium_src/chrome/browser/printing/print_preview_message_handler.cc b/chromium_src/chrome/browser/printing/print_preview_message_handler.cc index 50739ed57323..5a6a17034a63 100644 --- a/chromium_src/chrome/browser/printing/print_preview_message_handler.cc +++ b/chromium_src/chrome/browser/printing/print_preview_message_handler.cc @@ -76,21 +76,6 @@ PrintPreviewMessageHandler::PrintPreviewMessageHandler( PrintPreviewMessageHandler::~PrintPreviewMessageHandler() { } -void PrintPreviewMessageHandler::OnDidGetPreviewPageCount( - const PrintHostMsg_DidGetPreviewPageCount_Params& params) { - if (params.page_count <= 0) { - NOTREACHED(); - return; - } -} - -void PrintPreviewMessageHandler::OnDidPreviewPage( - const PrintHostMsg_DidPreviewPage_Params& params) { - int page_number = params.page_number; - if (page_number < FIRST_PAGE_INDEX || !params.data_size) - return; -} - void PrintPreviewMessageHandler::OnMetafileReadyForPrinting( const PrintHostMsg_DidPreviewDocument_Params& params) { // Always try to stop the worker. @@ -116,10 +101,6 @@ bool PrintPreviewMessageHandler::OnMessageReceived( const IPC::Message& message) { bool handled = true; IPC_BEGIN_MESSAGE_MAP(PrintPreviewMessageHandler, message) - IPC_MESSAGE_HANDLER(PrintHostMsg_DidGetPreviewPageCount, - OnDidGetPreviewPageCount) - IPC_MESSAGE_HANDLER(PrintHostMsg_DidPreviewPage, - OnDidPreviewPage) IPC_MESSAGE_HANDLER(PrintHostMsg_MetafileReadyForPrinting, OnMetafileReadyForPrinting) IPC_MESSAGE_HANDLER(PrintHostMsg_PrintPreviewFailed, diff --git a/chromium_src/chrome/browser/printing/print_preview_message_handler.h b/chromium_src/chrome/browser/printing/print_preview_message_handler.h index bfdd436b196c..391261d08e0f 100644 --- a/chromium_src/chrome/browser/printing/print_preview_message_handler.h +++ b/chromium_src/chrome/browser/printing/print_preview_message_handler.h @@ -12,22 +12,12 @@ #include "content/public/browser/web_contents_observer.h" #include "content/public/browser/web_contents_user_data.h" -struct PrintHostMsg_DidGetPreviewPageCount_Params; struct PrintHostMsg_DidPreviewDocument_Params; -struct PrintHostMsg_DidPreviewPage_Params; namespace content { class WebContents; } -namespace mate { -class Dictionary; -} - -namespace gfx { -class Rect; -} - namespace printing { struct PageSizeMargins; @@ -53,9 +43,6 @@ class PrintPreviewMessageHandler friend class content::WebContentsUserData; // Message handlers. - void OnDidGetPreviewPageCount( - const PrintHostMsg_DidGetPreviewPageCount_Params& params); - void OnDidPreviewPage(const PrintHostMsg_DidPreviewPage_Params& params); void OnMetafileReadyForPrinting( const PrintHostMsg_DidPreviewDocument_Params& params); void OnPrintPreviewFailed(int document_cookie, int request_id); diff --git a/chromium_src/chrome/common/print_messages.h b/chromium_src/chrome/common/print_messages.h index fc9c1d493509..cd775d0478b7 100644 --- a/chromium_src/chrome/common/print_messages.h +++ b/chromium_src/chrome/common/print_messages.h @@ -187,40 +187,6 @@ IPC_STRUCT_BEGIN(PrintHostMsg_ScriptedPrint_Params) IPC_STRUCT_MEMBER(printing::MarginType, margin_type) IPC_STRUCT_END() -// Parameters to describe a rendered preview page. -IPC_STRUCT_BEGIN(PrintHostMsg_DidPreviewPage_Params) - // A shared memory handle to metafile data for a draft document of the page. - IPC_STRUCT_MEMBER(base::SharedMemoryHandle, metafile_data_handle) - - // Size of metafile data. - IPC_STRUCT_MEMBER(uint32, data_size) - - // |page_number| is zero-based and can be |printing::INVALID_PAGE_INDEX| if it - // is just a check. - IPC_STRUCT_MEMBER(int, page_number) - - // The id of the preview request. - IPC_STRUCT_MEMBER(int, preview_request_id) -IPC_STRUCT_END() - -// Parameters sent along with the page count. -IPC_STRUCT_BEGIN(PrintHostMsg_DidGetPreviewPageCount_Params) - // Cookie for the document to ensure correctness. - IPC_STRUCT_MEMBER(int, document_cookie) - - // Total page count. - IPC_STRUCT_MEMBER(int, page_count) - - // Indicates whether the previewed document is modifiable. - IPC_STRUCT_MEMBER(bool, is_modifiable) - - // The id of the preview request. - IPC_STRUCT_MEMBER(int, preview_request_id) - - // Indicates whether the existing preview data needs to be cleared or not. - IPC_STRUCT_MEMBER(bool, clear_preview_data) -IPC_STRUCT_END() - // Parameters to describe a rendered document. IPC_STRUCT_BEGIN(PrintHostMsg_DidPreviewDocument_Params) // A shared memory handle to metafile data. @@ -318,20 +284,12 @@ IPC_MESSAGE_ROUTED0(PrintHostMsg_ShowInvalidPrinterSettingsError) IPC_MESSAGE_ROUTED1(PrintHostMsg_PrintingFailed, int /* document cookie */) -// Notify the browser a print preview page has been rendered. -IPC_MESSAGE_ROUTED1(PrintHostMsg_DidPreviewPage, - PrintHostMsg_DidPreviewPage_Params /* params */) - // Sends back to the browser the complete rendered document (non-draft mode, // used for printing) that was requested by a PrintMsg_PrintPreview message. // The memory handle in this message is already valid in the browser process. IPC_MESSAGE_ROUTED1(PrintHostMsg_MetafileReadyForPrinting, PrintHostMsg_DidPreviewDocument_Params /* params */) -// Notify the browser the number of pages in the print preview document. -IPC_MESSAGE_ROUTED1(PrintHostMsg_DidGetPreviewPageCount, - PrintHostMsg_DidGetPreviewPageCount_Params /* params */) - IPC_MESSAGE_ROUTED2(PrintHostMsg_PrintPreviewFailed, int /* document cookie */, int /* request_id */); diff --git a/chromium_src/chrome/renderer/printing/print_web_view_helper.cc b/chromium_src/chrome/renderer/printing/print_web_view_helper.cc index 643340deac3b..cba75b651b6b 100644 --- a/chromium_src/chrome/renderer/printing/print_web_view_helper.cc +++ b/chromium_src/chrome/renderer/printing/print_web_view_helper.cc @@ -777,31 +777,6 @@ bool PrintWebViewHelper::CreatePreviewDocument() { return false; } - PageSizeMargins default_page_layout; - ComputePageLayoutInPointsForCss(print_preview_context_.prepared_frame(), 0, - print_params, ignore_css_margins_, NULL, - &default_page_layout); - - //bool has_page_size_style = - //PrintingFrameHasPageSizeStyle(print_preview_context_.prepared_frame(), - //print_preview_context_.total_page_count()); - int dpi = GetDPI(&print_params); - - gfx::Rect printable_area_in_points( - ConvertUnit(print_params.printable_area.x(), dpi, kPointsPerInch), - ConvertUnit(print_params.printable_area.y(), dpi, kPointsPerInch), - ConvertUnit(print_params.printable_area.width(), dpi, kPointsPerInch), - ConvertUnit(print_params.printable_area.height(), dpi, kPointsPerInch)); - - - PrintHostMsg_DidGetPreviewPageCount_Params params; - params.page_count = print_preview_context_.total_page_count(); - params.is_modifiable = print_preview_context_.IsModifiable(); - params.document_cookie = print_params.document_cookie; - params.preview_request_id = print_params.preview_request_id; - params.clear_preview_data = print_preview_context_.generate_draft_pages(); - Send(new PrintHostMsg_DidGetPreviewPageCount(routing_id(), params)); - while (!print_preview_context_.IsFinalPageRendered()) { int page_number = print_preview_context_.GetNextPageNumber(); DCHECK_GE(page_number, 0); @@ -1226,22 +1201,6 @@ bool PrintWebViewHelper::PreviewPageRendered(int page_number, return false; } - PrintHostMsg_DidPreviewPage_Params preview_page_params; - // Get the size of the resulting metafile. - uint32 buf_size = metafile->GetDataSize(); - DCHECK_GT(buf_size, 0u); - if (!CopyMetafileDataToSharedMem( - metafile, &(preview_page_params.metafile_data_handle))) { - LOG(ERROR) << "CopyMetafileDataToSharedMem failed"; - print_preview_context_.set_error(PREVIEW_ERROR_METAFILE_COPY_FAILED); - return false; - } - preview_page_params.data_size = buf_size; - preview_page_params.page_number = page_number; - preview_page_params.preview_request_id = - print_pages_params_->params.preview_request_id; - - Send(new PrintHostMsg_DidPreviewPage(routing_id(), preview_page_params)); return true; } From ccbe554ec004587b1036025139a8780dbc8ae840 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Wed, 10 Jun 2015 20:07:14 +0800 Subject: [PATCH 0280/1293] Make callback aligns node.js style. --- atom/browser/api/atom_api_web_contents.h | 4 +++- .../browser/printing/print_preview_message_handler.cc | 7 +++++-- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index dbd75db286fd..891fd0bcb436 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -52,7 +52,9 @@ class WebContents : public mate::EventEmitter, public content::WebContentsObserver, public content::GpuDataManagerObserver { public: - typedef base::Callback)> PrintToPDFCallback; + // For node.js callback function type: function(error, buffer) + typedef base::Callback, v8::Local)> + PrintToPDFCallback; // Create from an existing WebContents. static mate::Handle CreateFrom( diff --git a/chromium_src/chrome/browser/printing/print_preview_message_handler.cc b/chromium_src/chrome/browser/printing/print_preview_message_handler.cc index 5a6a17034a63..7005b1c24e9d 100644 --- a/chromium_src/chrome/browser/printing/print_preview_message_handler.cc +++ b/chromium_src/chrome/browser/printing/print_preview_message_handler.cc @@ -130,9 +130,12 @@ void PrintPreviewMessageHandler::RunPrintToPDFCallback( v8::Local buffer = node::Buffer::Use( const_cast(reinterpret_cast(data->front())), data->size()); - print_to_pdf_callback_map_[request_id].Run(buffer); + print_to_pdf_callback_map_[request_id].Run(v8::Null(isolate), buffer); } else { - print_to_pdf_callback_map_[request_id].Run(v8::Null(isolate)); + v8::Local error_message = v8::String::NewFromUtf8(isolate, + "Fail to generate PDF"); + print_to_pdf_callback_map_[request_id].Run( + v8::Exception::Error(error_message), v8::Null(isolate)); } print_to_pdf_callback_map_.erase(request_id); } From 559eb20e7fcad0e0c449179edd23ed54fd04936c Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Thu, 11 Jun 2015 14:43:45 +0800 Subject: [PATCH 0281/1293] Fixing type: printBackgrounds => printBackground --- atom/browser/api/lib/web-contents.coffee | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/atom/browser/api/lib/web-contents.coffee b/atom/browser/api/lib/web-contents.coffee index 95b651e13d3d..8855b6d35f5f 100644 --- a/atom/browser/api/lib/web-contents.coffee +++ b/atom/browser/api/lib/web-contents.coffee @@ -97,7 +97,7 @@ wrapWebContents = (webContents) -> if options.printSelectionOnly printingSetting.shouldPrintSelectionOnly = options.printSelectionOnly if options.printBackgrounds - printingSetting.shouldPrintBackgrounds = options.printBackgrounds + printingSetting.shouldPrintBackgrounds = options.printBackground webContents._printToPDF printingSetting, callback From f22662ffb20c1bed88fc4b0d18f9dcd47e15d200 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Thu, 11 Jun 2015 15:04:58 +0800 Subject: [PATCH 0282/1293] :memo: Update docs. --- docs/api/browser-window.md | 48 +++++++++++++++++--------------------- 1 file changed, 22 insertions(+), 26 deletions(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 58e6fa73e35c..fb45ce110371 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -571,32 +571,6 @@ Calling `window.print()` in web page is equivalent to call doesn't need print feature, you can safely remove `pdf.dll` in saving binary size. -### BrowserWindow.printToPDF([options], callback) - -* `options` Object - * `marginsType` Integer - Specify the type of margins to use - * 0 - default - * 1 - none - * 2 - minimum - * `shouldPrintBackgrounds` Boolean - Whether to print CSS backgrounds. - * `shouldPrintSelectionOnly` Boolean - Whether to print selection only. - * `landscape` Boolean - `true` for landscape, `false` for portrait. - -* `callback` Function - `function(statusCode) {}` - * `statusCode` Integer - * 0 - Success. - * 1 - Fail to generate PDF file on renderer part. - * 2 - Fail to save PDF file on local disk. - * 3 - Users cancel the prompted save file dialog. - -Prints windows' web page as PDF with Chromium's preview printing custom -settings. The API will prompt a SaveDialog to allow user custom the file path -for saving the generated PDF file on disk. - -By default, the options will be -`{marginsType:0, shouldPrintBackgrounds:false, shouldPrintSelectionOnly:false, - landscape:false}`. - ### BrowserWindow.loadUrl(url, [options]) Same with `webContents.loadUrl(url, [options])`. @@ -976,6 +950,28 @@ Unregisters any serviceworker if present and returns boolean as response to `callback` when the JS promise is fullfilled or false when the JS promise is rejected. +### WebContents.printToPDF(options, callback) + +* `options` Object + * `marginsType` Integer - Specify the type of margins to use + * 0 - default + * 1 - none + * 2 - minimum + * `printBackground` Boolean - Whether to print CSS backgrounds. + * `printSelectionOnly` Boolean - Whether to print selection only. + * `landscape` Boolean - `true` for landscape, `false` for portrait. + +* `callback` Function - `function(error, data) {}` + * `error` Error + * `data` Buffer - PDF file content + +Prints windows' web page as PDF with Chromium's preview printing custom +settings. + +By default, the options will be +`{marginsType:0, printBackgrounds:false, printSelectionOnly:false, + landscape:false}`. + ### WebContents.send(channel[, args...]) * `channel` String From 894f9c0cb0b62244745707cc9775babb5f2593e8 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Thu, 11 Jun 2015 15:52:48 +0800 Subject: [PATCH 0283/1293] Don't use duprecated node buffer api, fix build error on OS X. --- .../chrome/browser/printing/print_preview_message_handler.cc | 1 + 1 file changed, 1 insertion(+) diff --git a/chromium_src/chrome/browser/printing/print_preview_message_handler.cc b/chromium_src/chrome/browser/printing/print_preview_message_handler.cc index 7005b1c24e9d..78f01c5de016 100644 --- a/chromium_src/chrome/browser/printing/print_preview_message_handler.cc +++ b/chromium_src/chrome/browser/printing/print_preview_message_handler.cc @@ -128,6 +128,7 @@ void PrintPreviewMessageHandler::RunPrintToPDFCallback( v8::HandleScope handle_scope(isolate); if (data) { v8::Local buffer = node::Buffer::Use( + isolate, const_cast(reinterpret_cast(data->front())), data->size()); print_to_pdf_callback_map_[request_id].Run(v8::Null(isolate), buffer); From 93bbc6c8109ce95990fcdfe5a5c73070507b96a0 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Sat, 13 Jun 2015 15:47:32 +0800 Subject: [PATCH 0284/1293] Simplify the pdf-data handled code. --- .../printing/print_preview_message_handler.cc | 37 +++++++------------ .../printing/print_preview_message_handler.h | 2 +- 2 files changed, 15 insertions(+), 24 deletions(-) diff --git a/chromium_src/chrome/browser/printing/print_preview_message_handler.cc b/chromium_src/chrome/browser/printing/print_preview_message_handler.cc index 78f01c5de016..3971b9552504 100644 --- a/chromium_src/chrome/browser/printing/print_preview_message_handler.cc +++ b/chromium_src/chrome/browser/printing/print_preview_message_handler.cc @@ -48,20 +48,6 @@ void StopWorker(int document_cookie) { } } -base::RefCountedBytes* GetDataFromHandle(base::SharedMemoryHandle handle, - uint32 data_size) { - scoped_ptr shared_buf( - new base::SharedMemory(handle, true)); - if (!shared_buf->Map(data_size)) { - NOTREACHED(); - return NULL; - } - - unsigned char* data_begin = static_cast(shared_buf->memory()); - std::vector data(data_begin, data_begin + data_size); - return base::RefCountedBytes::TakeVector(&data); -} - } // namespace namespace printing { @@ -86,15 +72,22 @@ void PrintPreviewMessageHandler::OnMetafileReadyForPrinting( return; } - base::RefCountedBytes *data = ( - GetDataFromHandle(params.metafile_data_handle, params.data_size)); - RunPrintToPDFCallback(params.preview_request_id, data); + scoped_ptr shared_buf( + new base::SharedMemory(params.metafile_data_handle, true)); + if (!shared_buf->Map(params.data_size)) { + RunPrintToPDFCallback(params.preview_request_id, nullptr, 0); + return; + } + + RunPrintToPDFCallback(params.preview_request_id, + static_cast(shared_buf->memory()), + params.data_size); } void PrintPreviewMessageHandler::OnPrintPreviewFailed(int document_cookie, int request_id) { StopWorker(document_cookie); - RunPrintToPDFCallback(request_id, nullptr); + RunPrintToPDFCallback(request_id, nullptr, 0); } bool PrintPreviewMessageHandler::OnMessageReceived( @@ -122,15 +115,13 @@ void PrintPreviewMessageHandler::PrintToPDF( } void PrintPreviewMessageHandler::RunPrintToPDFCallback( - int request_id, base::RefCountedBytes* data) { + int request_id, char* data, uint32 data_size) { v8::Isolate* isolate = v8::Isolate::GetCurrent(); v8::Locker locker(isolate); v8::HandleScope handle_scope(isolate); if (data) { - v8::Local buffer = node::Buffer::Use( - isolate, - const_cast(reinterpret_cast(data->front())), - data->size()); + v8::Local buffer = node::Buffer::New(isolate, + data, static_cast(data_size)); print_to_pdf_callback_map_[request_id].Run(v8::Null(isolate), buffer); } else { v8::Local error_message = v8::String::NewFromUtf8(isolate, diff --git a/chromium_src/chrome/browser/printing/print_preview_message_handler.h b/chromium_src/chrome/browser/printing/print_preview_message_handler.h index 391261d08e0f..a16591dd9f66 100644 --- a/chromium_src/chrome/browser/printing/print_preview_message_handler.h +++ b/chromium_src/chrome/browser/printing/print_preview_message_handler.h @@ -48,7 +48,7 @@ class PrintPreviewMessageHandler void OnPrintPreviewFailed(int document_cookie, int request_id); void RunPrintToPDFCallback( - int request_id, base::RefCountedBytes* data); + int request_id, char* data, uint32 data_size); PrintToPDFCallbackMap print_to_pdf_callback_map_; From 57580e00f9d05e94889b2a64bcf06b133bfb7656 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Sat, 13 Jun 2015 16:02:16 +0800 Subject: [PATCH 0285/1293] Fix code style. --- atom/browser/api/atom_api_web_contents.cc | 3 +-- atom/browser/api/atom_api_web_contents.h | 2 +- atom/browser/common_web_contents_delegate.cc | 3 +++ atom/browser/native_window.cc | 3 --- .../browser/printing/print_preview_message_handler.cc | 8 -------- 5 files changed, 5 insertions(+), 14 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index d72e5539a6de..959b0e344dbf 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -138,7 +138,6 @@ WebContents::WebContents(const mate::Dictionary& options) inspectable_web_contents_ = managed_web_contents(); Observe(GetWebContents()); - printing::PrintPreviewMessageHandler::CreateForWebContents(web_contents); } WebContents::~WebContents() { @@ -593,7 +592,7 @@ bool WebContents::IsAudioMuted() { } void WebContents::PrintToPDF(const base::DictionaryValue& setting, - const PrintToPDFCallback& callback) { + const PrintToPDFCallback& callback) { printing::PrintPreviewMessageHandler::FromWebContents(web_contents())-> PrintToPDF(setting, callback); } diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index 891fd0bcb436..bab7c9e40643 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -96,7 +96,7 @@ class WebContents : public mate::EventEmitter, // Print current page as PDF. void PrintToPDF(const base::DictionaryValue& setting, - const PrintToPDFCallback& callback); + const PrintToPDFCallback& callback); // Editing commands. void Undo(); diff --git a/atom/browser/common_web_contents_delegate.cc b/atom/browser/common_web_contents_delegate.cc index 087205d37d5b..437d4d725f73 100644 --- a/atom/browser/common_web_contents_delegate.cc +++ b/atom/browser/common_web_contents_delegate.cc @@ -12,6 +12,7 @@ #include "atom/browser/ui/file_dialog.h" #include "atom/browser/web_dialog_helper.h" #include "base/files/file_util.h" +#include "chrome/browser/printing/print_preview_message_handler.h" #include "chrome/browser/ui/browser_dialogs.h" #include "content/public/browser/child_process_security_policy.h" #include "content/public/browser/render_process_host.h" @@ -102,6 +103,8 @@ void CommonWebContentsDelegate::InitWithWebContents( owner_window_ = owner_window; web_contents->SetDelegate(this); + printing::PrintPreviewMessageHandler::CreateForWebContents(web_contents); + // Create InspectableWebContents. web_contents_.reset(brightray::InspectableWebContents::Create(web_contents)); web_contents_->SetDelegate(this); diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 581565ad188c..8eb05cb9b0f2 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -28,8 +28,6 @@ #include "brightray/browser/inspectable_web_contents.h" #include "brightray/browser/inspectable_web_contents_view.h" #include "chrome/browser/printing/print_view_manager_basic.h" -#include "chrome/browser/printing/print_preview_message_handler.h" -#include "chrome/browser/ui/browser_dialogs.h" #include "content/browser/renderer_host/render_widget_host_impl.h" #include "content/public/browser/navigation_entry.h" #include "content/public/browser/notification_details.h" @@ -99,7 +97,6 @@ NativeWindow::NativeWindow(content::WebContents* web_contents, zoom_factor_(1.0), weak_factory_(this) { printing::PrintViewManagerBasic::CreateForWebContents(web_contents); - printing::PrintPreviewMessageHandler::CreateForWebContents(web_contents); InitWithWebContents(web_contents, this); diff --git a/chromium_src/chrome/browser/printing/print_preview_message_handler.cc b/chromium_src/chrome/browser/printing/print_preview_message_handler.cc index 3971b9552504..51bfffce9cb1 100644 --- a/chromium_src/chrome/browser/printing/print_preview_message_handler.cc +++ b/chromium_src/chrome/browser/printing/print_preview_message_handler.cc @@ -4,14 +4,7 @@ #include "chrome/browser/printing/print_preview_message_handler.h" -#include - -#include "atom/browser/ui/file_dialog.h" -#include "atom/browser/native_window.h" #include "base/bind.h" -#include "base/json/json_reader.h" -#include "base/memory/ref_counted.h" -#include "base/memory/ref_counted_memory.h" #include "base/memory/shared_memory.h" #include "chrome/browser/browser_process.h" #include "chrome/browser/printing/print_job_manager.h" @@ -20,7 +13,6 @@ #include "content/public/browser/browser_thread.h" #include "content/public/browser/render_view_host.h" #include "content/public/browser/web_contents.h" -#include "content/public/browser/web_ui.h" #include "printing/page_size_margins.h" #include "printing/print_job_constants.h" #include "printing/pdf_metafile_skia.h" From 47eac062f63a65ddc1c8e46602895d001985711d Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Sat, 13 Jun 2015 21:23:45 +0800 Subject: [PATCH 0286/1293] Expose Print API to webContents and webView. Also move the print implementation from window to webContents. --- atom/browser/api/atom_api_web_contents.cc | 37 ++++++++++++++++++-- atom/browser/api/atom_api_web_contents.h | 1 + atom/browser/api/atom_api_window.cc | 37 -------------------- atom/browser/api/atom_api_window.h | 1 - atom/browser/api/lib/browser-window.coffee | 1 + atom/browser/common_web_contents_delegate.cc | 2 ++ atom/browser/native_window.cc | 8 ----- atom/browser/native_window.h | 3 -- atom/renderer/lib/web-view/web-view.coffee | 1 + docs/api/browser-window.md | 32 +++++++++-------- docs/api/web-view-tag.md | 4 +++ 11 files changed, 62 insertions(+), 65 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 959b0e344dbf..192955e6acbb 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -18,6 +18,7 @@ #include "base/strings/string_util.h" #include "base/strings/utf_string_conversions.h" #include "brightray/browser/inspectable_web_contents.h" +#include "chrome/browser/printing/print_view_manager_basic.h" #include "chrome/browser/printing/print_preview_message_handler.h" #include "content/public/browser/favicon_status.h" #include "content/public/browser/guest_host.h" @@ -41,6 +42,15 @@ #include "atom/common/node_includes.h" +namespace { + +struct PrintSettings { + bool silent; + bool print_background; +}; + +} // namespace + namespace mate { template<> @@ -65,6 +75,19 @@ struct Converter { } }; +template<> +struct Converter { + static bool FromV8(v8::Isolate* isolate, v8::Local val, + PrintSettings* out) { + mate::Dictionary dict; + if (!ConvertFromV8(isolate, val, &dict)) + return false; + dict.Get("silent", &(out->silent)); + dict.Get("printBackground", &(out->print_background)); + return true; + } +}; + } // namespace mate @@ -581,8 +604,6 @@ void WebContents::UnregisterServiceWorker( callback); } -<<<<<<< HEAD -<<<<<<< HEAD void WebContents::SetAudioMuted(bool muted) { web_contents()->SetAudioMuted(muted); } @@ -591,6 +612,17 @@ bool WebContents::IsAudioMuted() { return web_contents()->IsAudioMuted(); } +void WebContents::Print(mate::Arguments* args) { + PrintSettings settings = { false, false }; + if (args->Length() == 1 && !args->GetNext(&settings)) { + args->ThrowError(); + return; + } + + printing::PrintViewManagerBasic::FromWebContents(web_contents())-> + PrintNow(settings.silent, settings.print_background); +} + void WebContents::PrintToPDF(const base::DictionaryValue& setting, const PrintToPDFCallback& callback) { printing::PrintPreviewMessageHandler::FromWebContents(web_contents())-> @@ -769,6 +801,7 @@ mate::ObjectTemplateBuilder WebContents::GetObjectTemplateBuilder( .SetMethod("unregisterServiceWorker", &WebContents::UnregisterServiceWorker) .SetMethod("inspectServiceWorker", &WebContents::InspectServiceWorker) + .SetMethod("print", &WebContents::Print) .SetMethod("_printToPDF", &WebContents::PrintToPDF) .Build()); diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index bab7c9e40643..655087f9b0f5 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -93,6 +93,7 @@ class WebContents : public mate::EventEmitter, void UnregisterServiceWorker(const base::Callback&); void SetAudioMuted(bool muted); bool IsAudioMuted(); + void Print(mate::Arguments* args); // Print current page as PDF. void PrintToPDF(const base::DictionaryValue& setting, diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index 69271c0db328..0ad9a329e6cc 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -20,32 +20,6 @@ #include "atom/common/node_includes.h" -namespace { - -struct PrintSettings { - bool silent; - bool print_background; -}; - -} // namespace - -namespace mate { - -template<> -struct Converter { - static bool FromV8(v8::Isolate* isolate, v8::Local val, - PrintSettings* out) { - mate::Dictionary dict; - if (!ConvertFromV8(isolate, val, &dict)) - return false; - dict.Get("silent", &(out->silent)); - dict.Get("printBackground", &(out->print_background)); - return true; - } -}; - -} // namespace mate - namespace atom { namespace api { @@ -420,16 +394,6 @@ void Window::CapturePage(mate::Arguments* args) { rect, base::Bind(&OnCapturePageDone, args->isolate(), callback)); } -void Window::Print(mate::Arguments* args) { - PrintSettings settings = { false, false }; - if (args->Length() == 1 && !args->GetNext(&settings)) { - args->ThrowError(); - return; - } - - window_->Print(settings.silent, settings.print_background); -} - void Window::SetProgressBar(double progress) { window_->SetProgressBar(progress); } @@ -541,7 +505,6 @@ void Window::BuildPrototype(v8::Isolate* isolate, .SetMethod("blurWebView", &Window::BlurWebView) .SetMethod("isWebViewFocused", &Window::IsWebViewFocused) .SetMethod("capturePage", &Window::CapturePage) - .SetMethod("print", &Window::Print) .SetMethod("setProgressBar", &Window::SetProgressBar) .SetMethod("setOverlayIcon", &Window::SetOverlayIcon) .SetMethod("_setMenu", &Window::SetMenu) diff --git a/atom/browser/api/atom_api_window.h b/atom/browser/api/atom_api_window.h index 43a32e86f45a..d2b9d28034df 100644 --- a/atom/browser/api/atom_api_window.h +++ b/atom/browser/api/atom_api_window.h @@ -131,7 +131,6 @@ class Window : public mate::EventEmitter, void SetDocumentEdited(bool edited); bool IsDocumentEdited(); void CapturePage(mate::Arguments* args); - void Print(mate::Arguments* args); void SetProgressBar(double progress); void SetOverlayIcon(const gfx::Image& overlay, const std::string& description); diff --git a/atom/browser/api/lib/browser-window.coffee b/atom/browser/api/lib/browser-window.coffee index f0691b19b8fa..b0ffe6b37ef9 100644 --- a/atom/browser/api/lib/browser-window.coffee +++ b/atom/browser/api/lib/browser-window.coffee @@ -83,5 +83,6 @@ BrowserWindow::isDevToolsOpened = -> @webContents.isDevToolsOpened() BrowserWindow::toggleDevTools = -> @webContents.toggleDevTools() BrowserWindow::inspectElement = -> @webContents.inspectElement.apply @webContents, arguments BrowserWindow::inspectServiceWorker = -> @webContents.inspectServiceWorker() +BrowserWindow::print = -> @webContents.print.apply @webContents, arguments module.exports = BrowserWindow diff --git a/atom/browser/common_web_contents_delegate.cc b/atom/browser/common_web_contents_delegate.cc index 437d4d725f73..285b93014e44 100644 --- a/atom/browser/common_web_contents_delegate.cc +++ b/atom/browser/common_web_contents_delegate.cc @@ -13,6 +13,7 @@ #include "atom/browser/web_dialog_helper.h" #include "base/files/file_util.h" #include "chrome/browser/printing/print_preview_message_handler.h" +#include "chrome/browser/printing/print_view_manager_basic.h" #include "chrome/browser/ui/browser_dialogs.h" #include "content/public/browser/child_process_security_policy.h" #include "content/public/browser/render_process_host.h" @@ -103,6 +104,7 @@ void CommonWebContentsDelegate::InitWithWebContents( owner_window_ = owner_window; web_contents->SetDelegate(this); + printing::PrintViewManagerBasic::CreateForWebContents(web_contents); printing::PrintPreviewMessageHandler::CreateForWebContents(web_contents); // Create InspectableWebContents. diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 8eb05cb9b0f2..48ea9e76c32c 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -27,7 +27,6 @@ #include "base/strings/utf_string_conversions.h" #include "brightray/browser/inspectable_web_contents.h" #include "brightray/browser/inspectable_web_contents_view.h" -#include "chrome/browser/printing/print_view_manager_basic.h" #include "content/browser/renderer_host/render_widget_host_impl.h" #include "content/public/browser/navigation_entry.h" #include "content/public/browser/notification_details.h" @@ -96,8 +95,6 @@ NativeWindow::NativeWindow(content::WebContents* web_contents, has_dialog_attached_(false), zoom_factor_(1.0), weak_factory_(this) { - printing::PrintViewManagerBasic::CreateForWebContents(web_contents); - InitWithWebContents(web_contents, this); options.Get(switches::kFrame, &has_frame_); @@ -257,11 +254,6 @@ bool NativeWindow::IsDocumentEdited() { void NativeWindow::SetMenu(ui::MenuModel* menu) { } -void NativeWindow::Print(bool silent, bool print_background) { - printing::PrintViewManagerBasic::FromWebContents(GetWebContents())-> - PrintNow(silent, print_background); -} - void NativeWindow::ShowDefinitionForSelection() { NOTIMPLEMENTED(); } diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index 2038775f8d9a..0298101ce043 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -154,9 +154,6 @@ class NativeWindow : public CommonWebContentsDelegate, virtual void CapturePage(const gfx::Rect& rect, const CapturePageCallback& callback); - // Print current page. - virtual void Print(bool silent, bool print_background); - // Show popup dictionary. virtual void ShowDefinitionForSelection(); diff --git a/atom/renderer/lib/web-view/web-view.coffee b/atom/renderer/lib/web-view/web-view.coffee index 3778d7f48d3f..72fee948d137 100644 --- a/atom/renderer/lib/web-view/web-view.coffee +++ b/atom/renderer/lib/web-view/web-view.coffee @@ -291,6 +291,7 @@ registerWebViewElement = -> "send" "getId" "inspectServiceWorker" + "print" "printToPDF" ] diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index fb45ce110371..a25c4d88527d 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -556,20 +556,7 @@ process. ### BrowserWindow.print([options]) -* `options` Object - * `silent` Boolean - Don't ask user for print settings, defaults to `false` - * `printBackground` Boolean - Also prints the background color and image of - the web page, defaults to `false`. - -Prints window's web page. When `silent` is set to `false`, Electron will pick -up system's default printer and default settings for printing. - -Calling `window.print()` in web page is equivalent to call -`BrowserWindow.print({silent: false, printBackground: false})`. - -**Note:** On Windows, the print API relies on `pdf.dll`. If your application -doesn't need print feature, you can safely remove `pdf.dll` in saving binary -size. +Same with `webContents.print([options])` ### BrowserWindow.loadUrl(url, [options]) @@ -950,6 +937,23 @@ Unregisters any serviceworker if present and returns boolean as response to `callback` when the JS promise is fullfilled or false when the JS promise is rejected. +### WebContents.print([options]) + +* `options` Object + * `silent` Boolean - Don't ask user for print settings, defaults to `false` + * `printBackground` Boolean - Also prints the background color and image of + the web page, defaults to `false`. + +Prints window's web page. When `silent` is set to `false`, Electron will pick +up system's default printer and default settings for printing. + +Calling `window.print()` in web page is equivalent to call +`WebContents.print({silent: false, printBackground: false})`. + +**Note:** On Windows, the print API relies on `pdf.dll`. If your application +doesn't need print feature, you can safely remove `pdf.dll` in saving binary +size. + ### WebContents.printToPDF(options, callback) * `options` Object diff --git a/docs/api/web-view-tag.md b/docs/api/web-view-tag.md index 4a227d769cb7..2a9344048253 100644 --- a/docs/api/web-view-tag.md +++ b/docs/api/web-view-tag.md @@ -308,6 +308,10 @@ Executes editing command `replace` in page. Executes editing command `replaceMisspelling` in page. +### `.print([options])` + +Prints webview's web page. Same with `webContents.print([options])`. + ### ``.send(channel[, args...]) * `channel` String From 1eba552a8d1ab4479824275f0e0a2cea9337bd8c Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Sat, 13 Jun 2015 21:39:06 +0800 Subject: [PATCH 0287/1293] Also Expose printToPDF to BrowserWindow. --- atom/browser/api/lib/browser-window.coffee | 1 + docs/api/browser-window.md | 4 ++++ 2 files changed, 5 insertions(+) diff --git a/atom/browser/api/lib/browser-window.coffee b/atom/browser/api/lib/browser-window.coffee index b0ffe6b37ef9..818d737a894f 100644 --- a/atom/browser/api/lib/browser-window.coffee +++ b/atom/browser/api/lib/browser-window.coffee @@ -84,5 +84,6 @@ BrowserWindow::toggleDevTools = -> @webContents.toggleDevTools() BrowserWindow::inspectElement = -> @webContents.inspectElement.apply @webContents, arguments BrowserWindow::inspectServiceWorker = -> @webContents.inspectServiceWorker() BrowserWindow::print = -> @webContents.print.apply @webContents, arguments +BrowserWindow::printToPDF = -> @webContents.printToPDF.apply @webContents, arguments module.exports = BrowserWindow diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index a25c4d88527d..05cddc7978a7 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -558,6 +558,10 @@ process. Same with `webContents.print([options])` +### BrowserWindow.printToPDF(options, callback) + +Same with `webContents.printToPDF(options, callback)` + ### BrowserWindow.loadUrl(url, [options]) Same with `webContents.loadUrl(url, [options])`. From 16348fc8956dcee0712863bc9bb2b866532740ea Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Tue, 16 Jun 2015 19:42:17 +0800 Subject: [PATCH 0288/1293] Copy pdf data on IO thread to avoid causing main process hangs. --- .../printing/print_preview_message_handler.cc | 39 ++++++++++++------- .../printing/print_preview_message_handler.h | 3 +- 2 files changed, 27 insertions(+), 15 deletions(-) diff --git a/chromium_src/chrome/browser/printing/print_preview_message_handler.cc b/chromium_src/chrome/browser/printing/print_preview_message_handler.cc index 51bfffce9cb1..ca70ac2c58ef 100644 --- a/chromium_src/chrome/browser/printing/print_preview_message_handler.cc +++ b/chromium_src/chrome/browser/printing/print_preview_message_handler.cc @@ -40,6 +40,19 @@ void StopWorker(int document_cookie) { } } +char* CopyPDFDataOnIOThread( + const PrintHostMsg_DidPreviewDocument_Params& params) { + DCHECK_CURRENTLY_ON(BrowserThread::IO); + scoped_ptr shared_buf( + new base::SharedMemory(params.metafile_data_handle, true)); + if (!shared_buf->Map(params.data_size)) + return nullptr; + char* memory_pdf_data = static_cast(shared_buf->memory()); + char* pdf_data = new char[params.data_size]; + memcpy(pdf_data, memory_pdf_data, params.data_size); + return pdf_data; +} + } // namespace namespace printing { @@ -64,22 +77,20 @@ void PrintPreviewMessageHandler::OnMetafileReadyForPrinting( return; } - scoped_ptr shared_buf( - new base::SharedMemory(params.metafile_data_handle, true)); - if (!shared_buf->Map(params.data_size)) { - RunPrintToPDFCallback(params.preview_request_id, nullptr, 0); - return; - } - - RunPrintToPDFCallback(params.preview_request_id, - static_cast(shared_buf->memory()), - params.data_size); + BrowserThread::PostTaskAndReplyWithResult( + BrowserThread::IO, + FROM_HERE, + base::Bind(&CopyPDFDataOnIOThread, params), + base::Bind(&PrintPreviewMessageHandler::RunPrintToPDFCallback, + base::Unretained(this), + params.preview_request_id, + params.data_size)); } void PrintPreviewMessageHandler::OnPrintPreviewFailed(int document_cookie, int request_id) { StopWorker(document_cookie); - RunPrintToPDFCallback(request_id, nullptr, 0); + RunPrintToPDFCallback(request_id, 0, nullptr); } bool PrintPreviewMessageHandler::OnMessageReceived( @@ -107,12 +118,14 @@ void PrintPreviewMessageHandler::PrintToPDF( } void PrintPreviewMessageHandler::RunPrintToPDFCallback( - int request_id, char* data, uint32 data_size) { + int request_id, uint32 data_size, char* data) { + DCHECK_CURRENTLY_ON(BrowserThread::UI); + v8::Isolate* isolate = v8::Isolate::GetCurrent(); v8::Locker locker(isolate); v8::HandleScope handle_scope(isolate); if (data) { - v8::Local buffer = node::Buffer::New(isolate, + v8::Local buffer = node::Buffer::Use(isolate, data, static_cast(data_size)); print_to_pdf_callback_map_[request_id].Run(v8::Null(isolate), buffer); } else { diff --git a/chromium_src/chrome/browser/printing/print_preview_message_handler.h b/chromium_src/chrome/browser/printing/print_preview_message_handler.h index a16591dd9f66..453d78761bbe 100644 --- a/chromium_src/chrome/browser/printing/print_preview_message_handler.h +++ b/chromium_src/chrome/browser/printing/print_preview_message_handler.h @@ -47,8 +47,7 @@ class PrintPreviewMessageHandler const PrintHostMsg_DidPreviewDocument_Params& params); void OnPrintPreviewFailed(int document_cookie, int request_id); - void RunPrintToPDFCallback( - int request_id, char* data, uint32 data_size); + void RunPrintToPDFCallback(int request_id, uint32 data_size, char* data); PrintToPDFCallbackMap print_to_pdf_callback_map_; From 82b1607c1e8400913b0342f8a32669e94bdab295 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Tue, 16 Jun 2015 20:17:58 +0800 Subject: [PATCH 0289/1293] :memo: Add missing printToPDF API in webview. --- docs/api/web-view-tag.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/api/web-view-tag.md b/docs/api/web-view-tag.md index 2a9344048253..54e82ef3a7bc 100644 --- a/docs/api/web-view-tag.md +++ b/docs/api/web-view-tag.md @@ -312,6 +312,10 @@ Executes editing command `replaceMisspelling` in page. Prints webview's web page. Same with `webContents.print([options])`. +### `.printToPDF(options, callback)` + +Prints webview's web page as PDF, Same with `webContents.printToPDF(options, callback)` + ### ``.send(channel[, args...]) * `channel` String From 8a56ab3947b5655c2d8435191c1a87cea12c5d21 Mon Sep 17 00:00:00 2001 From: Paul Betts Date: Tue, 16 Jun 2015 18:17:51 -0700 Subject: [PATCH 0290/1293] Note that setPressedImage only has an effect on OS X --- docs/api/tray.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/tray.md b/docs/api/tray.md index 3be241dde9a2..25c9cb451b1d 100644 --- a/docs/api/tray.md +++ b/docs/api/tray.md @@ -96,7 +96,7 @@ Sets the `image` associated with this tray icon. * `image` [NativeImage](native-image.md) -Sets the `image` associated with this tray icon when pressed. +Sets the `image` associated with this tray icon when pressed on OS X. ### Tray.setToolTip(toolTip) From af05f26a5f9b124cdf894483a1f35f4592b454be Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 17 Jun 2015 09:31:33 +0800 Subject: [PATCH 0291/1293] Make URLRequestFetchJob actually work --- atom/browser/api/atom_api_protocol.cc | 3 +- atom/browser/api/lib/protocol.coffee | 2 +- atom/browser/net/adapter_request_job.cc | 13 +++ atom/browser/net/adapter_request_job.h | 2 + atom/browser/net/url_request_fetch_job.cc | 136 +++++++++++++++------- atom/browser/net/url_request_fetch_job.h | 35 +++--- 6 files changed, 130 insertions(+), 61 deletions(-) diff --git a/atom/browser/api/atom_api_protocol.cc b/atom/browser/api/atom_api_protocol.cc index eede89233201..48c4f483c593 100644 --- a/atom/browser/api/atom_api_protocol.cc +++ b/atom/browser/api/atom_api_protocol.cc @@ -116,8 +116,7 @@ class CustomProtocolRequestJob : public AdapterRequestJob { GetWeakPtr(), path)); return; } else if (name == "RequestErrorJob") { - // Default value net::ERR_NOT_IMPLEMENTED - int error = -11; + int error = net::ERR_NOT_IMPLEMENTED; dict.Get("error", &error); BrowserThread::PostTask(BrowserThread::IO, FROM_HERE, diff --git a/atom/browser/api/lib/protocol.coffee b/atom/browser/api/lib/protocol.coffee index bbd2499a8371..b1084cf86bd7 100644 --- a/atom/browser/api/lib/protocol.coffee +++ b/atom/browser/api/lib/protocol.coffee @@ -36,6 +36,6 @@ class RequestErrorJob protocol.RequestHttpJob = class RequestHttpJob - constructor: (@url) -> + constructor: ({@url}) -> module.exports = protocol diff --git a/atom/browser/net/adapter_request_job.cc b/atom/browser/net/adapter_request_job.cc index 258416e2f42a..6b493bbc496e 100644 --- a/atom/browser/net/adapter_request_job.cc +++ b/atom/browser/net/adapter_request_job.cc @@ -68,6 +68,14 @@ bool AdapterRequestJob::GetCharset(std::string* charset) { return real_job_->GetCharset(charset); } +void AdapterRequestJob::GetResponseInfo(net::HttpResponseInfo* info) { + real_job_->GetResponseInfo(info); +} + +int AdapterRequestJob::GetResponseCode() const { + return real_job_->GetResponseCode(); +} + base::WeakPtr AdapterRequestJob::GetWeakPtr() { return weak_factory_.GetWeakPtr(); } @@ -107,6 +115,11 @@ void AdapterRequestJob::CreateFileJobAndStart(const base::FilePath& path) { } void AdapterRequestJob::CreateHttpJobAndStart(const GURL& url) { + if (!url.is_valid()) { + CreateErrorJobAndStart(net::ERR_INVALID_URL); + return; + } + real_job_ = new URLRequestFetchJob(request(), network_delegate(), url); real_job_->Start(); } diff --git a/atom/browser/net/adapter_request_job.h b/atom/browser/net/adapter_request_job.h index 1ecc82230b76..a5d591cd3ce9 100644 --- a/atom/browser/net/adapter_request_job.h +++ b/atom/browser/net/adapter_request_job.h @@ -41,6 +41,8 @@ class AdapterRequestJob : public net::URLRequestJob { net::Filter* SetupFilter() const override; bool GetMimeType(std::string* mime_type) const override; bool GetCharset(std::string* charset) override; + void GetResponseInfo(net::HttpResponseInfo* info) override; + int GetResponseCode() const override; base::WeakPtr GetWeakPtr(); diff --git a/atom/browser/net/url_request_fetch_job.cc b/atom/browser/net/url_request_fetch_job.cc index 3f4ef0694e70..3754a1538d49 100644 --- a/atom/browser/net/url_request_fetch_job.cc +++ b/atom/browser/net/url_request_fetch_job.cc @@ -4,85 +4,141 @@ #include "atom/browser/net/url_request_fetch_job.h" -#include +#include +#include #include "atom/browser/atom_browser_context.h" #include "net/base/io_buffer.h" #include "net/base/net_errors.h" +#include "net/http/http_response_headers.h" +#include "net/url_request/url_fetcher.h" +#include "net/url_request/url_fetcher_response_writer.h" #include "net/url_request/url_request_status.h" namespace atom { +namespace { + +// Pipe the response writer back to URLRequestFetchJob. +class ResponsePiper : public net::URLFetcherResponseWriter { + public: + explicit ResponsePiper(URLRequestFetchJob* job) + : first_write_(true), job_(job) {} + + // net::URLFetcherResponseWriter: + int Initialize(const net::CompletionCallback& callback) override { + return net::OK; + } + int Write(net::IOBuffer* buffer, + int num_bytes, + const net::CompletionCallback& callback) override { + job_->DataAvailable(buffer, num_bytes); + if (first_write_) { + // The URLFetcherResponseWriter doesn't have an event when headers have + // been read, so we have to emulate by hooking to first write event. + job_->HeadersCompleted(); + first_write_ = false; + } + return num_bytes; + } + int Finish(const net::CompletionCallback& callback) override { + return net::OK; + } + + private: + bool first_write_; + URLRequestFetchJob* job_; + + DISALLOW_COPY_AND_ASSIGN(ResponsePiper); +}; + +} // namespace + URLRequestFetchJob::URLRequestFetchJob( net::URLRequest* request, net::NetworkDelegate* network_delegate, const GURL& url) : net::URLRequestJob(request, network_delegate), url_(url), - weak_ptr_factory_(this) {} + finished_(false), + weak_factory_(this) {} -URLRequestFetchJob::~URLRequestFetchJob() {} +void URLRequestFetchJob::HeadersCompleted() { + response_info_.reset(new net::HttpResponseInfo); + response_info_->headers = fetcher_->GetResponseHeaders(); + NotifyHeadersComplete(); +} + +void URLRequestFetchJob::DataAvailable(net::IOBuffer* buffer, int num_bytes) { + buffer_.resize(buffer_.size() + num_bytes); + memcpy(buffer_.data() + buffer_.size() - num_bytes, + buffer->data(), + num_bytes); + SetStatus(net::URLRequestStatus()); +} void URLRequestFetchJob::Start() { fetcher_.reset(net::URLFetcher::Create(url_, net::URLFetcher::GET, this)); auto context = AtomBrowserContext::Get()->url_request_context_getter(); fetcher_->SetRequestContext(context); - fetcher_->SaveResponseWithWriter(scoped_ptr( - this)); + fetcher_->SaveResponseWithWriter(make_scoped_ptr(new ResponsePiper(this))); fetcher_->Start(); } void URLRequestFetchJob::Kill() { - weak_ptr_factory_.InvalidateWeakPtrs(); URLRequestJob::Kill(); + fetcher_.reset(); } bool URLRequestFetchJob::ReadRawData(net::IOBuffer* dest, int dest_size, int* bytes_read) { - if (!dest_size) { + if (finished_) { *bytes_read = 0; return true; } - int to_read = dest_size < buffer_->BytesRemaining() ? - dest_size : buffer_->BytesRemaining(); - memcpy(dest->data(), buffer_->data(), to_read); - buffer_->DidConsume(to_read); - if (!buffer_->BytesRemaining()) { - NotifyReadComplete(buffer_->size()); - return true; + if (buffer_.size() == 0) { + SetStatus(net::URLRequestStatus(net::URLRequestStatus::IO_PENDING, 0)); + return false; } - *bytes_read = to_read; - return false; + if (static_cast(dest_size) >= buffer_.size()) { + // Copy all data at once (quick). + memcpy(dest->data(), buffer_.data(), buffer_.size()); + *bytes_read = buffer_.size(); + buffer_.clear(); + } else { + // Can not fit all data, strip them (slow). + memcpy(dest->data(), buffer_.data(), dest_size); + *bytes_read = dest_size; + std::rotate(buffer_.begin(), buffer_.begin() + dest_size, buffer_.end()); + buffer_.resize(buffer_.size() - dest_size); + } + return true; +} + +bool URLRequestFetchJob::GetMimeType(std::string* mime_type) const { + if (!response_info_) + return false; + + return response_info_->headers->GetMimeType(mime_type); +} + +void URLRequestFetchJob::GetResponseInfo(net::HttpResponseInfo* info) { + if (response_info_) + *info = *response_info_; +} + +int URLRequestFetchJob::GetResponseCode() const { + if (!response_info_) + return -1; + + return response_info_->headers->response_code(); } void URLRequestFetchJob::OnURLFetchComplete(const net::URLFetcher* source) { - if (!source->GetStatus().is_success()) - NotifyDone(net::URLRequestStatus(net::URLRequestStatus::FAILED, - source->GetResponseCode())); - - NotifyHeadersComplete(); -} - - -int URLRequestFetchJob::Initialize(const net::CompletionCallback& callback) { - if (buffer_) - buffer_->Release(); - return net::OK; -} - -int URLRequestFetchJob::Write(net::IOBuffer* buffer, - int num_bytes, - const net::CompletionCallback& calback) { - buffer_ = new net::DrainableIOBuffer(buffer, num_bytes); - set_expected_content_size(num_bytes); - return num_bytes; -} - -int URLRequestFetchJob::Finish(const net::CompletionCallback& callback) { - return net::OK; + finished_ = true; } } // namespace atom diff --git a/atom/browser/net/url_request_fetch_job.h b/atom/browser/net/url_request_fetch_job.h index 69726f9db45b..df7ad54d5937 100644 --- a/atom/browser/net/url_request_fetch_job.h +++ b/atom/browser/net/url_request_fetch_job.h @@ -5,50 +5,49 @@ #ifndef ATOM_BROWSER_NET_URL_REQUEST_FETCH_JOB_H_ #define ATOM_BROWSER_NET_URL_REQUEST_FETCH_JOB_H_ -#include "base/memory/ref_counted.h" +#include + #include "base/memory/weak_ptr.h" -#include "net/base/io_buffer.h" -#include "net/url_request/url_fetcher.h" #include "net/url_request/url_fetcher_delegate.h" -#include "net/url_request/url_fetcher_response_writer.h" #include "net/url_request/url_request_job.h" namespace atom { class URLRequestFetchJob : public net::URLRequestJob, - public net::URLFetcherDelegate, - public net::URLFetcherResponseWriter { + public net::URLFetcherDelegate { public: URLRequestFetchJob(net::URLRequest* request, net::NetworkDelegate* network_delegate, const GURL& url); + base::WeakPtr GetWeakPtr() { + return weak_factory_.GetWeakPtr(); + }; + + void HeadersCompleted(); + void DataAvailable(net::IOBuffer* buffer, int num_bytes); + // net::URLRequestJob: void Start() override; void Kill() override; bool ReadRawData(net::IOBuffer* buf, int buf_size, int* bytes_read) override; + bool GetMimeType(std::string* mime_type) const override; + void GetResponseInfo(net::HttpResponseInfo* info) override; + int GetResponseCode() const override; // net::URLFetcherDelegate: void OnURLFetchComplete(const net::URLFetcher* source) override; - // net::URLFetchResponseWriter: - int Initialize(const net::CompletionCallback& callback) override; - int Write(net::IOBuffer* buffer, - int num_bytes, - const net::CompletionCallback& callback) override; - int Finish(const net::CompletionCallback& callback) override; - - protected: - virtual ~URLRequestFetchJob(); - private: GURL url_; scoped_ptr fetcher_; - scoped_refptr buffer_; + std::vector buffer_; + scoped_ptr response_info_; + bool finished_; - base::WeakPtrFactory weak_ptr_factory_; + base::WeakPtrFactory weak_factory_; DISALLOW_COPY_AND_ASSIGN(URLRequestFetchJob); }; From 81db8e098ed4bbd28afc407fc6a9f1fea025bff9 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 17 Jun 2015 10:19:58 +0800 Subject: [PATCH 0292/1293] Don't need buffer for piping data --- atom/browser/net/url_request_fetch_job.cc | 56 +++++++++-------------- atom/browser/net/url_request_fetch_job.h | 15 ++---- spec/api-protocol-spec.coffee | 2 +- 3 files changed, 26 insertions(+), 47 deletions(-) diff --git a/atom/browser/net/url_request_fetch_job.cc b/atom/browser/net/url_request_fetch_job.cc index 3754a1538d49..4dc0b5a7c9c5 100644 --- a/atom/browser/net/url_request_fetch_job.cc +++ b/atom/browser/net/url_request_fetch_job.cc @@ -5,7 +5,6 @@ #include "atom/browser/net/url_request_fetch_job.h" #include -#include #include "atom/browser/atom_browser_context.h" #include "net/base/io_buffer.h" @@ -32,14 +31,13 @@ class ResponsePiper : public net::URLFetcherResponseWriter { int Write(net::IOBuffer* buffer, int num_bytes, const net::CompletionCallback& callback) override { - job_->DataAvailable(buffer, num_bytes); if (first_write_) { // The URLFetcherResponseWriter doesn't have an event when headers have // been read, so we have to emulate by hooking to first write event. job_->HeadersCompleted(); first_write_ = false; } - return num_bytes; + return job_->DataAvailable(buffer, num_bytes); } int Finish(const net::CompletionCallback& callback) override { return net::OK; @@ -60,8 +58,7 @@ URLRequestFetchJob::URLRequestFetchJob( const GURL& url) : net::URLRequestJob(request, network_delegate), url_(url), - finished_(false), - weak_factory_(this) {} + pending_buffer_size_(0) {} void URLRequestFetchJob::HeadersCompleted() { response_info_.reset(new net::HttpResponseInfo); @@ -69,12 +66,21 @@ void URLRequestFetchJob::HeadersCompleted() { NotifyHeadersComplete(); } -void URLRequestFetchJob::DataAvailable(net::IOBuffer* buffer, int num_bytes) { - buffer_.resize(buffer_.size() + num_bytes); - memcpy(buffer_.data() + buffer_.size() - num_bytes, - buffer->data(), - num_bytes); +int URLRequestFetchJob::DataAvailable(net::IOBuffer* buffer, int num_bytes) { + // Clear the IO_PENDING status. SetStatus(net::URLRequestStatus()); + // Do nothing if pending_buffer_ is empty, i.e. there's no ReadRawData() + // operation waiting for IO completion. + if (!pending_buffer_.get()) + return net::ERR_IO_PENDING;; + + // pending_buffer_ is set to the IOBuffer instance provided to ReadRawData() + // by URLRequestJob. + + int bytes_read = std::min(num_bytes, pending_buffer_size_); + memcpy(pending_buffer_->data(), buffer->data(), bytes_read); + NotifyReadComplete(bytes_read); + return bytes_read; } void URLRequestFetchJob::Start() { @@ -93,29 +99,10 @@ void URLRequestFetchJob::Kill() { bool URLRequestFetchJob::ReadRawData(net::IOBuffer* dest, int dest_size, int* bytes_read) { - if (finished_) { - *bytes_read = 0; - return true; - } - - if (buffer_.size() == 0) { - SetStatus(net::URLRequestStatus(net::URLRequestStatus::IO_PENDING, 0)); - return false; - } - - if (static_cast(dest_size) >= buffer_.size()) { - // Copy all data at once (quick). - memcpy(dest->data(), buffer_.data(), buffer_.size()); - *bytes_read = buffer_.size(); - buffer_.clear(); - } else { - // Can not fit all data, strip them (slow). - memcpy(dest->data(), buffer_.data(), dest_size); - *bytes_read = dest_size; - std::rotate(buffer_.begin(), buffer_.begin() + dest_size, buffer_.end()); - buffer_.resize(buffer_.size() - dest_size); - } - return true; + pending_buffer_ = dest; + pending_buffer_size_ = dest_size; + SetStatus(net::URLRequestStatus(net::URLRequestStatus::IO_PENDING, 0)); + return false; } bool URLRequestFetchJob::GetMimeType(std::string* mime_type) const { @@ -138,7 +125,8 @@ int URLRequestFetchJob::GetResponseCode() const { } void URLRequestFetchJob::OnURLFetchComplete(const net::URLFetcher* source) { - finished_ = true; + NotifyDone(fetcher_->GetStatus()); + NotifyReadComplete(0); } } // namespace atom diff --git a/atom/browser/net/url_request_fetch_job.h b/atom/browser/net/url_request_fetch_job.h index df7ad54d5937..b608b980bc52 100644 --- a/atom/browser/net/url_request_fetch_job.h +++ b/atom/browser/net/url_request_fetch_job.h @@ -5,9 +5,6 @@ #ifndef ATOM_BROWSER_NET_URL_REQUEST_FETCH_JOB_H_ #define ATOM_BROWSER_NET_URL_REQUEST_FETCH_JOB_H_ -#include - -#include "base/memory/weak_ptr.h" #include "net/url_request/url_fetcher_delegate.h" #include "net/url_request/url_request_job.h" @@ -20,12 +17,8 @@ class URLRequestFetchJob : public net::URLRequestJob, net::NetworkDelegate* network_delegate, const GURL& url); - base::WeakPtr GetWeakPtr() { - return weak_factory_.GetWeakPtr(); - }; - void HeadersCompleted(); - void DataAvailable(net::IOBuffer* buffer, int num_bytes); + int DataAvailable(net::IOBuffer* buffer, int num_bytes); // net::URLRequestJob: void Start() override; @@ -43,11 +36,9 @@ class URLRequestFetchJob : public net::URLRequestJob, private: GURL url_; scoped_ptr fetcher_; - std::vector buffer_; + scoped_refptr pending_buffer_; + int pending_buffer_size_; scoped_ptr response_info_; - bool finished_; - - base::WeakPtrFactory weak_factory_; DISALLOW_COPY_AND_ASSIGN(URLRequestFetchJob); }; diff --git a/spec/api-protocol-spec.coffee b/spec/api-protocol-spec.coffee index e3cc98cd7c4e..3ad1cbd91fad 100644 --- a/spec/api-protocol-spec.coffee +++ b/spec/api-protocol-spec.coffee @@ -82,7 +82,7 @@ describe 'protocol module', -> server.listen 0, '127.0.0.1', -> {port} = server.address() url = "http://127.0.0.1:#{port}" - job = new protocol.RequestHttpJob(url) + job = new protocol.RequestHttpJob({url}) handler = remote.createFunctionWithReturnValue job protocol.registerProtocol 'atom-http-job', handler From 274854876c54d21806cf0324486350544da489cb Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 17 Jun 2015 10:57:26 +0800 Subject: [PATCH 0293/1293] Allow setting method for RequestHttpJob --- atom/browser/api/atom_api_protocol.cc | 4 ++- atom/browser/api/lib/protocol.coffee | 2 +- atom/browser/net/adapter_request_job.cc | 6 ++-- atom/browser/net/adapter_request_job.h | 2 +- atom/browser/net/url_request_fetch_job.cc | 38 ++++++++++++++++++----- atom/browser/net/url_request_fetch_job.h | 4 +-- 6 files changed, 41 insertions(+), 15 deletions(-) diff --git a/atom/browser/api/atom_api_protocol.cc b/atom/browser/api/atom_api_protocol.cc index 48c4f483c593..186e36a52210 100644 --- a/atom/browser/api/atom_api_protocol.cc +++ b/atom/browser/api/atom_api_protocol.cc @@ -125,11 +125,13 @@ class CustomProtocolRequestJob : public AdapterRequestJob { return; } else if (name == "RequestHttpJob") { GURL url; + std::string method; dict.Get("url", &url); + dict.Get("method", &method); BrowserThread::PostTask(BrowserThread::IO, FROM_HERE, base::Bind(&AdapterRequestJob::CreateHttpJobAndStart, - GetWeakPtr(), url)); + GetWeakPtr(), url, method)); return; } } diff --git a/atom/browser/api/lib/protocol.coffee b/atom/browser/api/lib/protocol.coffee index b1084cf86bd7..2f6617a173c7 100644 --- a/atom/browser/api/lib/protocol.coffee +++ b/atom/browser/api/lib/protocol.coffee @@ -36,6 +36,6 @@ class RequestErrorJob protocol.RequestHttpJob = class RequestHttpJob - constructor: ({@url}) -> + constructor: ({@url, @method}) -> module.exports = protocol diff --git a/atom/browser/net/adapter_request_job.cc b/atom/browser/net/adapter_request_job.cc index 6b493bbc496e..ff5d4deaa595 100644 --- a/atom/browser/net/adapter_request_job.cc +++ b/atom/browser/net/adapter_request_job.cc @@ -114,13 +114,15 @@ void AdapterRequestJob::CreateFileJobAndStart(const base::FilePath& path) { real_job_->Start(); } -void AdapterRequestJob::CreateHttpJobAndStart(const GURL& url) { +void AdapterRequestJob::CreateHttpJobAndStart(const GURL& url, + const std::string& method) { if (!url.is_valid()) { CreateErrorJobAndStart(net::ERR_INVALID_URL); return; } - real_job_ = new URLRequestFetchJob(request(), network_delegate(), url); + real_job_ = new URLRequestFetchJob(request(), network_delegate(), url, + method); real_job_->Start(); } diff --git a/atom/browser/net/adapter_request_job.h b/atom/browser/net/adapter_request_job.h index a5d591cd3ce9..4c173f0de825 100644 --- a/atom/browser/net/adapter_request_job.h +++ b/atom/browser/net/adapter_request_job.h @@ -59,7 +59,7 @@ class AdapterRequestJob : public net::URLRequestJob { const std::string& charset, scoped_refptr data); void CreateFileJobAndStart(const base::FilePath& path); - void CreateHttpJobAndStart(const GURL& url); + void CreateHttpJobAndStart(const GURL& url, const std::string& method); void CreateJobFromProtocolHandlerAndStart(); private: diff --git a/atom/browser/net/url_request_fetch_job.cc b/atom/browser/net/url_request_fetch_job.cc index 4dc0b5a7c9c5..ad5f2aed62b7 100644 --- a/atom/browser/net/url_request_fetch_job.cc +++ b/atom/browser/net/url_request_fetch_job.cc @@ -7,6 +7,7 @@ #include #include "atom/browser/atom_browser_context.h" +#include "base/strings/string_util.h" #include "net/base/io_buffer.h" #include "net/base/net_errors.h" #include "net/http/http_response_headers.h" @@ -18,6 +19,25 @@ namespace atom { namespace { +// Convert string to RequestType. +net::URLFetcher::RequestType GetRequestType(const std::string& raw) { + std::string method = StringToUpperASCII(raw); + if (method.empty() || method == "GET") + return net::URLFetcher::GET; + else if (method == "POST") + return net::URLFetcher::POST; + else if (method == "HEAD") + return net::URLFetcher::HEAD; + else if (method == "DELETE") + return net::URLFetcher::DELETE_REQUEST; + else if (method == "PUT") + return net::URLFetcher::PUT; + else if (method == "PATCH") + return net::URLFetcher::PATCH; + else // Use "GET" as fallback. + return net::URLFetcher::GET; +} + // Pipe the response writer back to URLRequestFetchJob. class ResponsePiper : public net::URLFetcherResponseWriter { public: @@ -55,10 +75,15 @@ class ResponsePiper : public net::URLFetcherResponseWriter { URLRequestFetchJob::URLRequestFetchJob( net::URLRequest* request, net::NetworkDelegate* network_delegate, - const GURL& url) + const GURL& url, + const std::string& method) : net::URLRequestJob(request, network_delegate), - url_(url), - pending_buffer_size_(0) {} + fetcher_(net::URLFetcher::Create(url, GetRequestType(method), this)), + pending_buffer_size_(0) { + auto context = AtomBrowserContext::Get()->url_request_context_getter(); + fetcher_->SetRequestContext(context); + fetcher_->SaveResponseWithWriter(make_scoped_ptr(new ResponsePiper(this))); +} void URLRequestFetchJob::HeadersCompleted() { response_info_.reset(new net::HttpResponseInfo); @@ -84,10 +109,6 @@ int URLRequestFetchJob::DataAvailable(net::IOBuffer* buffer, int num_bytes) { } void URLRequestFetchJob::Start() { - fetcher_.reset(net::URLFetcher::Create(url_, net::URLFetcher::GET, this)); - auto context = AtomBrowserContext::Get()->url_request_context_getter(); - fetcher_->SetRequestContext(context); - fetcher_->SaveResponseWithWriter(make_scoped_ptr(new ResponsePiper(this))); fetcher_->Start(); } @@ -126,7 +147,8 @@ int URLRequestFetchJob::GetResponseCode() const { void URLRequestFetchJob::OnURLFetchComplete(const net::URLFetcher* source) { NotifyDone(fetcher_->GetStatus()); - NotifyReadComplete(0); + if (fetcher_->GetStatus().is_success()) + NotifyReadComplete(0); } } // namespace atom diff --git a/atom/browser/net/url_request_fetch_job.h b/atom/browser/net/url_request_fetch_job.h index b608b980bc52..23a4a9f8dd72 100644 --- a/atom/browser/net/url_request_fetch_job.h +++ b/atom/browser/net/url_request_fetch_job.h @@ -15,7 +15,8 @@ class URLRequestFetchJob : public net::URLRequestJob, public: URLRequestFetchJob(net::URLRequest* request, net::NetworkDelegate* network_delegate, - const GURL& url); + const GURL& url, + const std::string& method); void HeadersCompleted(); int DataAvailable(net::IOBuffer* buffer, int num_bytes); @@ -34,7 +35,6 @@ class URLRequestFetchJob : public net::URLRequestJob, void OnURLFetchComplete(const net::URLFetcher* source) override; private: - GURL url_; scoped_ptr fetcher_; scoped_refptr pending_buffer_; int pending_buffer_size_; From 66c4c7e77b39b45538c943b3f35449a810d2a117 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 17 Jun 2015 11:04:15 +0800 Subject: [PATCH 0294/1293] Clear pending_buffer_ at correct time --- atom/browser/net/url_request_fetch_job.cc | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/atom/browser/net/url_request_fetch_job.cc b/atom/browser/net/url_request_fetch_job.cc index ad5f2aed62b7..7781f957cc1a 100644 --- a/atom/browser/net/url_request_fetch_job.cc +++ b/atom/browser/net/url_request_fetch_job.cc @@ -104,6 +104,12 @@ int URLRequestFetchJob::DataAvailable(net::IOBuffer* buffer, int num_bytes) { int bytes_read = std::min(num_bytes, pending_buffer_size_); memcpy(pending_buffer_->data(), buffer->data(), bytes_read); + + // Clear the buffers before notifying the read is complete, so that it is + // safe for the observer to read. + pending_buffer_ = nullptr; + pending_buffer_size_ = 0; + NotifyReadComplete(bytes_read); return bytes_read; } @@ -146,6 +152,8 @@ int URLRequestFetchJob::GetResponseCode() const { } void URLRequestFetchJob::OnURLFetchComplete(const net::URLFetcher* source) { + pending_buffer_ = nullptr; + pending_buffer_size_ = 0; NotifyDone(fetcher_->GetStatus()); if (fetcher_->GetStatus().is_success()) NotifyReadComplete(0); From e07f5cd53f0efb8997d2b0f983f3607ddb0c8312 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 17 Jun 2015 11:11:13 +0800 Subject: [PATCH 0295/1293] Use |request|'s method if |method| is not specified --- atom/browser/net/url_request_fetch_job.cc | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/atom/browser/net/url_request_fetch_job.cc b/atom/browser/net/url_request_fetch_job.cc index 7781f957cc1a..c064ee6d913a 100644 --- a/atom/browser/net/url_request_fetch_job.cc +++ b/atom/browser/net/url_request_fetch_job.cc @@ -78,8 +78,15 @@ URLRequestFetchJob::URLRequestFetchJob( const GURL& url, const std::string& method) : net::URLRequestJob(request, network_delegate), - fetcher_(net::URLFetcher::Create(url, GetRequestType(method), this)), pending_buffer_size_(0) { + // Use |request|'s method if |method| is not specified. + net::URLFetcher::RequestType request_type; + if (method.empty()) + request_type = GetRequestType(request->method()); + else + request_type = GetRequestType(method); + + fetcher_.reset(net::URLFetcher::Create(url, request_type, this)); auto context = AtomBrowserContext::Get()->url_request_context_getter(); fetcher_->SetRequestContext(context); fetcher_->SaveResponseWithWriter(make_scoped_ptr(new ResponsePiper(this))); From 543c4d55972b7958807e20fa1b1d7f13b8ba168d Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 17 Jun 2015 11:20:09 +0800 Subject: [PATCH 0296/1293] Allow setting referrer --- atom/browser/api/atom_api_protocol.cc | 5 +++-- atom/browser/api/lib/protocol.coffee | 2 +- atom/browser/net/adapter_request_job.cc | 5 +++-- atom/browser/net/adapter_request_job.h | 4 +++- atom/browser/net/url_request_fetch_job.cc | 9 ++++++++- atom/browser/net/url_request_fetch_job.h | 3 ++- 6 files changed, 20 insertions(+), 8 deletions(-) diff --git a/atom/browser/api/atom_api_protocol.cc b/atom/browser/api/atom_api_protocol.cc index 186e36a52210..9bc2de4b42a9 100644 --- a/atom/browser/api/atom_api_protocol.cc +++ b/atom/browser/api/atom_api_protocol.cc @@ -125,13 +125,14 @@ class CustomProtocolRequestJob : public AdapterRequestJob { return; } else if (name == "RequestHttpJob") { GURL url; - std::string method; + std::string method, referrer; dict.Get("url", &url); dict.Get("method", &method); + dict.Get("referrer", &referrer); BrowserThread::PostTask(BrowserThread::IO, FROM_HERE, base::Bind(&AdapterRequestJob::CreateHttpJobAndStart, - GetWeakPtr(), url, method)); + GetWeakPtr(), url, method, referrer)); return; } } diff --git a/atom/browser/api/lib/protocol.coffee b/atom/browser/api/lib/protocol.coffee index 2f6617a173c7..ff4bc5ba9a66 100644 --- a/atom/browser/api/lib/protocol.coffee +++ b/atom/browser/api/lib/protocol.coffee @@ -36,6 +36,6 @@ class RequestErrorJob protocol.RequestHttpJob = class RequestHttpJob - constructor: ({@url, @method}) -> + constructor: ({@url, @method, @referrer}) -> module.exports = protocol diff --git a/atom/browser/net/adapter_request_job.cc b/atom/browser/net/adapter_request_job.cc index ff5d4deaa595..08331829b550 100644 --- a/atom/browser/net/adapter_request_job.cc +++ b/atom/browser/net/adapter_request_job.cc @@ -115,14 +115,15 @@ void AdapterRequestJob::CreateFileJobAndStart(const base::FilePath& path) { } void AdapterRequestJob::CreateHttpJobAndStart(const GURL& url, - const std::string& method) { + const std::string& method, + const std::string& referrer) { if (!url.is_valid()) { CreateErrorJobAndStart(net::ERR_INVALID_URL); return; } real_job_ = new URLRequestFetchJob(request(), network_delegate(), url, - method); + method, referrer); real_job_->Start(); } diff --git a/atom/browser/net/adapter_request_job.h b/atom/browser/net/adapter_request_job.h index 4c173f0de825..d5e814d214d4 100644 --- a/atom/browser/net/adapter_request_job.h +++ b/atom/browser/net/adapter_request_job.h @@ -59,7 +59,9 @@ class AdapterRequestJob : public net::URLRequestJob { const std::string& charset, scoped_refptr data); void CreateFileJobAndStart(const base::FilePath& path); - void CreateHttpJobAndStart(const GURL& url, const std::string& method); + void CreateHttpJobAndStart(const GURL& url, + const std::string& method, + const std::string& referrer); void CreateJobFromProtocolHandlerAndStart(); private: diff --git a/atom/browser/net/url_request_fetch_job.cc b/atom/browser/net/url_request_fetch_job.cc index c064ee6d913a..35e46a8f4f8d 100644 --- a/atom/browser/net/url_request_fetch_job.cc +++ b/atom/browser/net/url_request_fetch_job.cc @@ -76,7 +76,8 @@ URLRequestFetchJob::URLRequestFetchJob( net::URLRequest* request, net::NetworkDelegate* network_delegate, const GURL& url, - const std::string& method) + const std::string& method, + const std::string& referrer) : net::URLRequestJob(request, network_delegate), pending_buffer_size_(0) { // Use |request|'s method if |method| is not specified. @@ -90,6 +91,12 @@ URLRequestFetchJob::URLRequestFetchJob( auto context = AtomBrowserContext::Get()->url_request_context_getter(); fetcher_->SetRequestContext(context); fetcher_->SaveResponseWithWriter(make_scoped_ptr(new ResponsePiper(this))); + + // Use |request|'s referrer if |referrer| is not specified. + if (referrer.empty()) + fetcher_->SetReferrer(request->referrer()); + else + fetcher_->SetReferrer(referrer); } void URLRequestFetchJob::HeadersCompleted() { diff --git a/atom/browser/net/url_request_fetch_job.h b/atom/browser/net/url_request_fetch_job.h index 23a4a9f8dd72..affa7b331f3e 100644 --- a/atom/browser/net/url_request_fetch_job.h +++ b/atom/browser/net/url_request_fetch_job.h @@ -16,7 +16,8 @@ class URLRequestFetchJob : public net::URLRequestJob, URLRequestFetchJob(net::URLRequest* request, net::NetworkDelegate* network_delegate, const GURL& url, - const std::string& method); + const std::string& method, + const std::string& referrer); void HeadersCompleted(); int DataAvailable(net::IOBuffer* buffer, int num_bytes); From 92f3371118c39c1a22a1c72b734a50410c947ff7 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 17 Jun 2015 11:30:31 +0800 Subject: [PATCH 0297/1293] Use |request|'s headers if possible --- atom/browser/net/url_request_fetch_job.cc | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/atom/browser/net/url_request_fetch_job.cc b/atom/browser/net/url_request_fetch_job.cc index 35e46a8f4f8d..bff3332a3f54 100644 --- a/atom/browser/net/url_request_fetch_job.cc +++ b/atom/browser/net/url_request_fetch_job.cc @@ -97,6 +97,12 @@ URLRequestFetchJob::URLRequestFetchJob( fetcher_->SetReferrer(request->referrer()); else fetcher_->SetReferrer(referrer); + + // Use |request|'s headers. + net::HttpRequestHeaders headers; + if (request->GetFullRequestHeaders(&headers)) { + fetcher_->SetExtraRequestHeaders(headers.ToString()); + } } void URLRequestFetchJob::HeadersCompleted() { From 1d4190377901ff5d6b462498de884374f1e4e339 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 17 Jun 2015 11:32:39 +0800 Subject: [PATCH 0298/1293] docs: protocol.RequestHttpJob --- docs/api/protocol.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/api/protocol.md b/docs/api/protocol.md index 181a2e57f733..ba62bf301f41 100644 --- a/docs/api/protocol.md +++ b/docs/api/protocol.md @@ -84,12 +84,21 @@ Create a request job which sends a string as response. Create a request job which sends a buffer as response. +## Class: protocol.RequestHttpJob(options) + +* `options` Object + * `url` String + * `method` String - Default is `GET` + * `referrer` String + +Send a request to `url` and pipe the response back. + ## Class: protocol.RequestErrorJob(code) * `code` Integer Create a request job which sets appropriate network error message to console. -Default message is `net::ERR_NOT_IMPLEMENTED`. Code should be in the following +Default message is `net::ERR_NOT_IMPLEMENTED`. Code should be in the following range. * Ranges: From c2aa7d538fc56774164887da32041b08aa2d0cdf Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 17 Jun 2015 11:34:47 +0800 Subject: [PATCH 0299/1293] Fix cpplint warnings --- atom/browser/net/url_request_fetch_job.cc | 8 +++++--- atom/browser/net/url_request_fetch_job.h | 2 ++ 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/atom/browser/net/url_request_fetch_job.cc b/atom/browser/net/url_request_fetch_job.cc index bff3332a3f54..f77379aed6c2 100644 --- a/atom/browser/net/url_request_fetch_job.cc +++ b/atom/browser/net/url_request_fetch_job.cc @@ -5,6 +5,7 @@ #include "atom/browser/net/url_request_fetch_job.h" #include +#include #include "atom/browser/atom_browser_context.h" #include "base/strings/string_util.h" @@ -93,10 +94,11 @@ URLRequestFetchJob::URLRequestFetchJob( fetcher_->SaveResponseWithWriter(make_scoped_ptr(new ResponsePiper(this))); // Use |request|'s referrer if |referrer| is not specified. - if (referrer.empty()) + if (referrer.empty()) { fetcher_->SetReferrer(request->referrer()); - else + } else { fetcher_->SetReferrer(referrer); + } // Use |request|'s headers. net::HttpRequestHeaders headers; @@ -117,7 +119,7 @@ int URLRequestFetchJob::DataAvailable(net::IOBuffer* buffer, int num_bytes) { // Do nothing if pending_buffer_ is empty, i.e. there's no ReadRawData() // operation waiting for IO completion. if (!pending_buffer_.get()) - return net::ERR_IO_PENDING;; + return net::ERR_IO_PENDING; // pending_buffer_ is set to the IOBuffer instance provided to ReadRawData() // by URLRequestJob. diff --git a/atom/browser/net/url_request_fetch_job.h b/atom/browser/net/url_request_fetch_job.h index affa7b331f3e..7975aa715eec 100644 --- a/atom/browser/net/url_request_fetch_job.h +++ b/atom/browser/net/url_request_fetch_job.h @@ -5,6 +5,8 @@ #ifndef ATOM_BROWSER_NET_URL_REQUEST_FETCH_JOB_H_ #define ATOM_BROWSER_NET_URL_REQUEST_FETCH_JOB_H_ +#include + #include "net/url_request/url_fetcher_delegate.h" #include "net/url_request/url_request_job.h" From ad593936419721a9faa4bcaa78a719b8dcbfc742 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 17 Jun 2015 12:38:36 +0800 Subject: [PATCH 0300/1293] Update brightray, close #1025 --- vendor/brightray | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/brightray b/vendor/brightray index 9541f111e9b0..2dc473cada4f 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit 9541f111e9b0cb8b157b717d2d053da4d2a4f050 +Subproject commit 2dc473cada4f118880241c6cd62ffb59dc58ef50 From db8ffe1dc71024c4096251007c118cb0261bed58 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 17 Jun 2015 15:52:29 +0800 Subject: [PATCH 0301/1293] Handle ".." in asar path, fix #1982 --- atom/common/lib/asar.coffee | 1 + 1 file changed, 1 insertion(+) diff --git a/atom/common/lib/asar.coffee b/atom/common/lib/asar.coffee index 7ce89156285d..ee6d18e4358f 100644 --- a/atom/common/lib/asar.coffee +++ b/atom/common/lib/asar.coffee @@ -20,6 +20,7 @@ process.on 'exit', -> splitPath = (p) -> return [false] if typeof p isnt 'string' return [true, p, ''] if p.substr(-5) is '.asar' + p = path.normalize p index = p.lastIndexOf ".asar#{path.sep}" return [false] if index is -1 [true, p.substr(0, index + 5), p.substr(index + 6)] From 663a48ee3823443852956c110903ed73f8be49db Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Fri, 12 Jun 2015 13:28:23 +0530 Subject: [PATCH 0302/1293] protocol: api to register custom schemes to standard schemes --- atom/app/atom_content_client.cc | 10 ++++++++++ atom/browser/api/atom_api_protocol.cc | 7 +++++++ atom/browser/api/atom_api_protocol.h | 4 ++++ atom/browser/atom_browser_client.cc | 13 +++++++++++++ atom/browser/atom_browser_client.h | 3 +++ atom/common/options_switches.cc | 3 +++ atom/common/options_switches.h | 1 + docs/api/protocol.md | 6 ++++++ 8 files changed, 47 insertions(+) diff --git a/atom/app/atom_content_client.cc b/atom/app/atom_content_client.cc index 74f88db0b9b2..1ba1f2031564 100644 --- a/atom/app/atom_content_client.cc +++ b/atom/app/atom_content_client.cc @@ -75,6 +75,16 @@ std::string AtomContentClient::GetProduct() const { void AtomContentClient::AddAdditionalSchemes( std::vector* standard_schemes, std::vector* savable_schemes) { + auto command_line = base::CommandLine::ForCurrentProcess(); + auto custom_schemes = command_line->GetSwitchValueASCII( + switches::kRegisterStandardSchemes); + if (!custom_schemes.empty()) { + std::vector schemes; + base::SplitString(custom_schemes, ',', &schemes); + standard_schemes->insert(standard_schemes->end(), + schemes.begin(), + schemes.end()); + } standard_schemes->push_back("chrome-extension"); } diff --git a/atom/browser/api/atom_api_protocol.cc b/atom/browser/api/atom_api_protocol.cc index 9bc2de4b42a9..db7252ec95b9 100644 --- a/atom/browser/api/atom_api_protocol.cc +++ b/atom/browser/api/atom_api_protocol.cc @@ -4,6 +4,7 @@ #include "atom/browser/api/atom_api_protocol.h" +#include "atom/browser/atom_browser_client.h" #include "atom/browser/atom_browser_context.h" #include "atom/browser/net/adapter_request_job.h" #include "atom/browser/net/atom_url_request_job_factory.h" @@ -205,6 +206,7 @@ mate::ObjectTemplateBuilder Protocol::GetObjectTemplateBuilder( return mate::ObjectTemplateBuilder(isolate) .SetMethod("registerProtocol", &Protocol::RegisterProtocol) .SetMethod("unregisterProtocol", &Protocol::UnregisterProtocol) + .SetMethod("registerStandardSchemes", &Protocol::RegisterStandardSchemes) .SetMethod("isHandledProtocol", &Protocol::IsHandledProtocol) .SetMethod("interceptProtocol", &Protocol::InterceptProtocol) .SetMethod("uninterceptProtocol", &Protocol::UninterceptProtocol); @@ -237,6 +239,11 @@ void Protocol::UnregisterProtocol(v8::Isolate* isolate, base::Unretained(this), scheme)); } +void Protocol::RegisterStandardSchemes( + const std::vector& schemes) { + atom::AtomBrowserClient::SetCustomSchemes(schemes); +} + bool Protocol::IsHandledProtocol(const std::string& scheme) { return job_factory_->IsHandledProtocol(scheme); } diff --git a/atom/browser/api/atom_api_protocol.h b/atom/browser/api/atom_api_protocol.h index 34725cecc925..b059440f2927 100644 --- a/atom/browser/api/atom_api_protocol.h +++ b/atom/browser/api/atom_api_protocol.h @@ -7,6 +7,7 @@ #include #include +#include #include "atom/browser/api/event_emitter.h" #include "base/callback.h" @@ -41,6 +42,9 @@ class Protocol : public mate::EventEmitter { private: typedef std::map ProtocolHandlersMap; + // Register schemes to standard scheme list. + void RegisterStandardSchemes(const std::vector& schemes); + // Register/unregister an networking |scheme| which would be handled by // |callback|. void RegisterProtocol(v8::Isolate* isolate, diff --git a/atom/browser/atom_browser_client.cc b/atom/browser/atom_browser_client.cc index ec519fa4f822..c62bc6436ddd 100644 --- a/atom/browser/atom_browser_client.cc +++ b/atom/browser/atom_browser_client.cc @@ -16,6 +16,7 @@ #include "base/command_line.h" #include "base/files/file_util.h" #include "base/strings/string_number_conversions.h" +#include "base/strings/string_util.h" #include "chrome/browser/printing/printing_message_filter.h" #include "chrome/browser/renderer_host/pepper/chrome_browser_pepper_host_factory.h" #include "chrome/browser/speech/tts_message_filter.h" @@ -43,6 +44,9 @@ int kDefaultRoutingID = 2; // Next navigation should not restart renderer process. bool g_suppress_renderer_process_restart = false; +// Custom schemes to be registered to standard. +std::string g_custom_schemes = ""; + // Find out the owner of the child process according to |process_id|. enum ProcessOwner { OWNER_NATIVE_WINDOW, @@ -95,6 +99,11 @@ void AtomBrowserClient::SuppressRendererProcessRestartForOnce() { g_suppress_renderer_process_restart = true; } +void AtomBrowserClient::SetCustomSchemes( + const std::vector& schemes) { + g_custom_schemes = JoinString(schemes, ','); +} + AtomBrowserClient::AtomBrowserClient() { } @@ -174,9 +183,13 @@ void AtomBrowserClient::AppendExtraCommandLineSwitches( base::CommandLine* command_line, int process_id) { std::string process_type = command_line->GetSwitchValueASCII("type"); + if (process_type != "renderer") return; + command_line->AppendSwitchASCII(switches::kRegisterStandardSchemes, + g_custom_schemes); + NativeWindow* window; WebViewManager::WebViewInfo info; ProcessOwner owner = GetProcessOwner(process_id, &window, &info); diff --git a/atom/browser/atom_browser_client.h b/atom/browser/atom_browser_client.h index c8a26da7099f..8cbdb3f2e199 100644 --- a/atom/browser/atom_browser_client.h +++ b/atom/browser/atom_browser_client.h @@ -6,6 +6,7 @@ #define ATOM_BROWSER_ATOM_BROWSER_CLIENT_H_ #include +#include #include "brightray/browser/browser_client.h" @@ -27,6 +28,8 @@ class AtomBrowserClient : public brightray::BrowserClient { // Don't force renderer process to restart for once. static void SuppressRendererProcessRestartForOnce(); + // Custom schemes to be registered to standard. + static void SetCustomSchemes(const std::vector& schemes); protected: // content::ContentBrowserClient: diff --git a/atom/common/options_switches.cc b/atom/common/options_switches.cc index 2764f86a5fcf..71469b9601b6 100644 --- a/atom/common/options_switches.cc +++ b/atom/common/options_switches.cc @@ -104,6 +104,9 @@ const char kPageVisibility[] = "page-visibility"; // Disable HTTP cache. const char kDisableHttpCache[] = "disable-http-cache"; +// Register schemes to standard. +const char kRegisterStandardSchemes[] = "register-standard-schemes"; + } // namespace switches } // namespace atom diff --git a/atom/common/options_switches.h b/atom/common/options_switches.h index e6d85063341a..fc25208a60ac 100644 --- a/atom/common/options_switches.h +++ b/atom/common/options_switches.h @@ -56,6 +56,7 @@ extern const char kSharedWorker[]; extern const char kPageVisibility[]; extern const char kDisableHttpCache[]; +extern const char kRegisterStandardSchemes[]; } // namespace switches diff --git a/docs/api/protocol.md b/docs/api/protocol.md index ba62bf301f41..c6dd373b586c 100644 --- a/docs/api/protocol.md +++ b/docs/api/protocol.md @@ -39,6 +39,12 @@ response you would like to send. Unregisters the custom protocol of `scheme`. +## protocol.registerStandardSchemes(value) + +* `value` Array + +`value` is an array of custom schemes to be registered to the standard. + ## protocol.isHandledProtocol(scheme) * `scheme` String From f76b60f29505c330cea2bdc03ebd9f0c671d5392 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 18 Jun 2015 12:42:02 +0800 Subject: [PATCH 0303/1293] Update brightray --- vendor/brightray | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/brightray b/vendor/brightray index 2dc473cada4f..20871355cb59 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit 2dc473cada4f118880241c6cd62ffb59dc58ef50 +Subproject commit 20871355cb590e009d7ee394a7d9da0e4666ea0b From beb2853bbff52b385a46afa58d7cdbf04660277f Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 18 Jun 2015 12:59:13 +0800 Subject: [PATCH 0304/1293] Update how to rebrand from source, close #1999 --- docs/tutorial/application-distribution.md | 22 ++-------------------- 1 file changed, 2 insertions(+), 20 deletions(-) diff --git a/docs/tutorial/application-distribution.md b/docs/tutorial/application-distribution.md index c96a53bcbeee..c0e8bebc4041 100644 --- a/docs/tutorial/application-distribution.md +++ b/docs/tutorial/application-distribution.md @@ -106,26 +106,8 @@ You can rename the `electron` executable to any name you like. ## Rebranding by rebuilding Electron from source It is also possible to rebrand Electron by changing the product name and -building it from source. To do this you need to override the `GYP_DEFINES` -environment variable and have a clean rebuild: - -__Windows__ - -```bash -> set "GYP_DEFINES=project_name=myapp product_name=MyApp" -> python script\clean.py -> python script\bootstrap.py -> python script\build.py -c R -t myapp -``` - -__Bash__ - -```bash -$ export GYP_DEFINES="project_name=myapp product_name=MyApp" -$ script/clean.py -$ script/bootstrap.py -$ script/build.py -c Release -t myapp -``` +building it from source. To do this you need to modify the `atom.gyp` file and +have a clean rebuild. ### grunt-build-atom-shell From c8eaaaea83bec692060c131c997e1480856981fd Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 18 Jun 2015 13:09:02 +0800 Subject: [PATCH 0305/1293] mac: Use NSFileManager::resultingItemURL for moving file to trash This allows the deleted file to be restored, fixes #2001. --- atom/common/platform_util_mac.mm | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/atom/common/platform_util_mac.mm b/atom/common/platform_util_mac.mm index a1f17d7c9d5c..1aa75effd35b 100644 --- a/atom/common/platform_util_mac.mm +++ b/atom/common/platform_util_mac.mm @@ -140,17 +140,12 @@ bool OpenExternal(const GURL& url) { } bool MoveItemToTrash(const base::FilePath& full_path) { - DCHECK([NSThread isMainThread]); NSString* path_string = base::SysUTF8ToNSString(full_path.value()); - NSArray* file_array = - [NSArray arrayWithObject:[path_string lastPathComponent]]; - BOOL status = [[NSWorkspace sharedWorkspace] - performFileOperation:NSWorkspaceRecycleOperation - source:[path_string stringByDeletingLastPathComponent] - destination:@"" - files:file_array - tag:nil]; - if (!path_string || !file_array || !status) + BOOL status = [[NSFileManager defaultManager] + trashItemAtURL:[NSURL fileURLWithPath:path_string] + resultingItemURL:nil + error:nil]; + if (!path_string || !status) LOG(WARNING) << "NSWorkspace failed to move file " << full_path.value() << " to trash"; return status; From 25a7bcef82675a58162f1ca8d59f819f1a55c339 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 18 Jun 2015 13:15:13 +0800 Subject: [PATCH 0306/1293] Bump v0.28.2 --- atom.gyp | 2 +- atom/browser/resources/mac/Info.plist | 2 +- atom/browser/resources/win/atom.rc | 8 ++++---- atom/common/atom_version.h | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/atom.gyp b/atom.gyp index bb64d1d7aa74..14e96d90b37a 100644 --- a/atom.gyp +++ b/atom.gyp @@ -4,7 +4,7 @@ 'product_name%': 'Electron', 'company_name%': 'GitHub, Inc', 'company_abbr%': 'github', - 'version%': '0.28.1', + 'version%': '0.28.2', 'atom_source_root': 'CFBundleIconFile atom.icns CFBundleVersion - 0.28.1 + 0.28.2 LSMinimumSystemVersion 10.8.0 NSMainNibFile diff --git a/atom/browser/resources/win/atom.rc b/atom/browser/resources/win/atom.rc index 95c7fd25370b..ab4a871b959f 100644 --- a/atom/browser/resources/win/atom.rc +++ b/atom/browser/resources/win/atom.rc @@ -50,8 +50,8 @@ END // VS_VERSION_INFO VERSIONINFO - FILEVERSION 0,28,1,0 - PRODUCTVERSION 0,28,1,0 + FILEVERSION 0,28,2,0 + PRODUCTVERSION 0,28,2,0 FILEFLAGSMASK 0x3fL #ifdef _DEBUG FILEFLAGS 0x1L @@ -68,12 +68,12 @@ BEGIN BEGIN VALUE "CompanyName", "GitHub, Inc." VALUE "FileDescription", "Electron" - VALUE "FileVersion", "0.28.1" + VALUE "FileVersion", "0.28.2" VALUE "InternalName", "electron.exe" VALUE "LegalCopyright", "Copyright (C) 2015 GitHub, Inc. All rights reserved." VALUE "OriginalFilename", "electron.exe" VALUE "ProductName", "Electron" - VALUE "ProductVersion", "0.28.1" + VALUE "ProductVersion", "0.28.2" VALUE "SquirrelAwareVersion", "1" END END diff --git a/atom/common/atom_version.h b/atom/common/atom_version.h index 3d500e741038..809d02cb2285 100644 --- a/atom/common/atom_version.h +++ b/atom/common/atom_version.h @@ -7,7 +7,7 @@ #define ATOM_MAJOR_VERSION 0 #define ATOM_MINOR_VERSION 28 -#define ATOM_PATCH_VERSION 1 +#define ATOM_PATCH_VERSION 2 #define ATOM_VERSION_IS_RELEASE 1 From 2f36f5ca78a505d59c62f1ce6b73c3c64688450c Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Thu, 18 Jun 2015 11:29:08 +0530 Subject: [PATCH 0307/1293] app: adding browser-window-focus/blur events --- atom/browser/api/lib/browser-window.coffee | 8 +++++++- docs/api/app.md | 14 ++++++++++++++ spec/api-app-spec.coffee | 19 +++++++++++++++++++ 3 files changed, 40 insertions(+), 1 deletion(-) diff --git a/atom/browser/api/lib/browser-window.coffee b/atom/browser/api/lib/browser-window.coffee index 818d737a894f..fc4667aa2c89 100644 --- a/atom/browser/api/lib/browser-window.coffee +++ b/atom/browser/api/lib/browser-window.coffee @@ -30,6 +30,12 @@ BrowserWindow::_init = -> @on '-will-navigate', (event, url) => @webContents.emit 'will-navigate', event, url + # Redirect focus/blur event to app instance too. + @on 'blur', (event) => + app.emit 'browser-window-blur', event, this + @on 'focus', (event) => + app.emit 'browser-window-focus', event, this + # Remove the window from weak map immediately when it's destroyed, since we # could be iterating windows before GC happened. @once 'closed', => @@ -58,7 +64,7 @@ BrowserWindow.fromDevToolsWebContents = (webContents) -> return window for window in windows when window.devToolsWebContents?.equal webContents BrowserWindow.fromId = (id) -> - BrowserWindow.windows.get id + BrowserWindow.windows.get id if BrowserWindow.windows.has id # Helpers. BrowserWindow::loadUrl = -> @webContents.loadUrl.apply @webContents, arguments diff --git a/docs/api/app.md b/docs/api/app.md index d30c8c39c8a8..1564196ce810 100644 --- a/docs/api/app.md +++ b/docs/api/app.md @@ -87,6 +87,20 @@ Emitted when the application is activated while there is no opened windows. It usually happens when user has closed all of application's windows and then click on the application's dock icon. +## Event: browser-window-blur + +* `event` Event +* `window` BrowserWindow + +Emitted when a [browserWindow](browser-window.md) gets blurred. + +## Event: browser-window-focus + +* `event` Event +* `window` BrowserWindow + +Emitted when a [browserWindow](browser-window.md) gets focused. + ## app.quit() Try to close all windows. The `before-quit` event will first be emitted. If all diff --git a/spec/api-app-spec.coffee b/spec/api-app-spec.coffee index 4e6bda2ac1fe..44de38927454 100644 --- a/spec/api-app-spec.coffee +++ b/spec/api-app-spec.coffee @@ -1,5 +1,7 @@ assert = require 'assert' app = require('remote').require 'app' +remote = require 'remote' +BrowserWindow = remote.require 'browser-window' describe 'app module', -> describe 'app.getVersion()', -> @@ -23,3 +25,20 @@ describe 'app module', -> app.setName 'test-name' assert.equal app.getName(), 'test-name' app.setName 'Electron Test' + + describe 'focus/blur event', -> + w = null + beforeEach -> + w.destroy() if w? + w = new BrowserWindow(show: false, width: 400, height: 400) + afterEach -> + w.destroy() if w? + w = null + it 'should emit focus event', (done) -> + app.once 'browser-window-blur', (e, window) -> + assert.equal w.id, window.id + done() + app.once 'browser-window-focus', (e, window) -> + assert.equal w.id, window.id + w.hide() + w.show() From 19436358fb91638bedacd5309ed537d7c8b017e9 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 18 Jun 2015 16:17:13 +0800 Subject: [PATCH 0308/1293] win: Fix setContentSize changing window position Close #1934. --- atom/browser/native_window_views.cc | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/atom/browser/native_window_views.cc b/atom/browser/native_window_views.cc index 697d0779f3f9..52309ba29774 100644 --- a/atom/browser/native_window_views.cc +++ b/atom/browser/native_window_views.cc @@ -945,6 +945,7 @@ void NativeWindowViews::RegisterAccelerators(ui::MenuModel* menu_model) { gfx::Rect NativeWindowViews::ContentBoundsToWindowBounds( const gfx::Rect& bounds) { + gfx::Point origin = bounds.origin(); #if defined(OS_WIN) gfx::Rect dpi_bounds = gfx::win::DIPToScreenRect(bounds); gfx::Rect window_bounds = gfx::win::ScreenToDIPRect( @@ -953,6 +954,9 @@ gfx::Rect NativeWindowViews::ContentBoundsToWindowBounds( gfx::Rect window_bounds = window_->non_client_view()->GetWindowBoundsForClientBounds(bounds); #endif + // The window's position would also be changed, but we only want to change + // the size. + window_bounds.set_origin(origin); if (menu_bar_ && menu_bar_visible_) window_bounds.set_height(window_bounds.height() + kMenuBarHeight); From 0120be5b8c3d3a9cbe2ae0a06c8f318c35a32c2b Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 18 Jun 2015 16:31:55 +0800 Subject: [PATCH 0309/1293] Don't rely on real focus/blur events in tests It is super unreliable. --- spec/api-app-spec.coffee | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/spec/api-app-spec.coffee b/spec/api-app-spec.coffee index 44de38927454..5c6591cadf50 100644 --- a/spec/api-app-spec.coffee +++ b/spec/api-app-spec.coffee @@ -1,6 +1,6 @@ assert = require 'assert' -app = require('remote').require 'app' remote = require 'remote' +app = remote.require 'app' BrowserWindow = remote.require 'browser-window' describe 'app module', -> @@ -40,5 +40,5 @@ describe 'app module', -> done() app.once 'browser-window-focus', (e, window) -> assert.equal w.id, window.id - w.hide() - w.show() + w.emit 'blur' + w.emit 'focus' From e6341ceaaa3b69f21ead550a273be0f25c3d7407 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 18 Jun 2015 16:33:12 +0800 Subject: [PATCH 0310/1293] Move BrowserProcess to BrowserMainParts --- atom/browser/atom_browser_context.cc | 4 +--- atom/browser/atom_browser_context.h | 4 ---- atom/browser/atom_browser_main_parts.cc | 4 +++- atom/browser/atom_browser_main_parts.h | 5 +++++ 4 files changed, 9 insertions(+), 8 deletions(-) diff --git a/atom/browser/atom_browser_context.cc b/atom/browser/atom_browser_context.cc index e31ebc4147e4..f09f094bf428 100644 --- a/atom/browser/atom_browser_context.cc +++ b/atom/browser/atom_browser_context.cc @@ -13,7 +13,6 @@ #include "base/command_line.h" #include "base/threading/sequenced_worker_pool.h" #include "base/threading/worker_pool.h" -#include "chrome/browser/browser_process.h" #include "content/public/browser/browser_thread.h" #include "content/public/common/url_constants.h" #include "net/ftp/ftp_network_layer.h" @@ -40,8 +39,7 @@ class NoCacheBackend : public net::HttpCache::BackendFactory { } // namespace AtomBrowserContext::AtomBrowserContext() - : fake_browser_process_(new BrowserProcess), - job_factory_(new AtomURLRequestJobFactory) { + : job_factory_(new AtomURLRequestJobFactory) { } AtomBrowserContext::~AtomBrowserContext() { diff --git a/atom/browser/atom_browser_context.h b/atom/browser/atom_browser_context.h index ab28c3e81a0c..2f2efc944330 100644 --- a/atom/browser/atom_browser_context.h +++ b/atom/browser/atom_browser_context.h @@ -7,8 +7,6 @@ #include "brightray/browser/browser_context.h" -class BrowserProcess; - namespace atom { class AtomURLRequestJobFactory; @@ -35,8 +33,6 @@ class AtomBrowserContext : public brightray::BrowserContext { AtomURLRequestJobFactory* job_factory() const { return job_factory_; } private: - // A fake BrowserProcess object that used to feed the source code from chrome. - scoped_ptr fake_browser_process_; scoped_ptr guest_manager_; AtomURLRequestJobFactory* job_factory_; // Weak reference. diff --git a/atom/browser/atom_browser_main_parts.cc b/atom/browser/atom_browser_main_parts.cc index aaf68836d0c3..a63ec9a703b2 100644 --- a/atom/browser/atom_browser_main_parts.cc +++ b/atom/browser/atom_browser_main_parts.cc @@ -11,6 +11,7 @@ #include "atom/common/api/atom_bindings.h" #include "atom/common/node_bindings.h" #include "base/command_line.h" +#include "chrome/browser/browser_process.h" #include "v8/include/v8-debug.h" #if defined(USE_X11) @@ -25,7 +26,8 @@ namespace atom { AtomBrowserMainParts* AtomBrowserMainParts::self_ = NULL; AtomBrowserMainParts::AtomBrowserMainParts() - : browser_(new Browser), + : fake_browser_process_(new BrowserProcess), + browser_(new Browser), node_bindings_(NodeBindings::Create(true)), atom_bindings_(new AtomBindings), gc_timer_(true, true) { diff --git a/atom/browser/atom_browser_main_parts.h b/atom/browser/atom_browser_main_parts.h index 6ca0686655ba..c7d688f7c323 100644 --- a/atom/browser/atom_browser_main_parts.h +++ b/atom/browser/atom_browser_main_parts.h @@ -8,6 +8,8 @@ #include "base/timer/timer.h" #include "brightray/browser/browser_main_parts.h" +class BrowserProcess; + namespace atom { class AtomBindings; @@ -41,6 +43,9 @@ class AtomBrowserMainParts : public brightray::BrowserMainParts { void SetDPIFromGSettings(); #endif + // A fake BrowserProcess object that used to feed the source code from chrome. + scoped_ptr fake_browser_process_; + scoped_ptr browser_; scoped_ptr js_env_; scoped_ptr node_bindings_; From 8e05fe33503f4e334a3a057790c94e098158bc9b Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Wed, 17 Jun 2015 20:13:43 +0530 Subject: [PATCH 0311/1293] process: add hang method --- atom/common/api/atom_bindings.cc | 6 ++++++ docs/api/process.md | 4 ++++ 2 files changed, 10 insertions(+) diff --git a/atom/common/api/atom_bindings.cc b/atom/common/api/atom_bindings.cc index a210cc6931d2..fa4a88d58437 100644 --- a/atom/common/api/atom_bindings.cc +++ b/atom/common/api/atom_bindings.cc @@ -26,6 +26,11 @@ void Crash() { static_cast(NULL)->crash = true; } +void Hang() { + for (;;) + base::PlatformThread::Sleep(base::TimeDelta::FromSeconds(1)); +} + // Called when there is a fatal error in V8, we just crash the process here so // we can get the stack trace. void FatalErrorCallback(const char* location, const char* message) { @@ -54,6 +59,7 @@ void AtomBindings::BindTo(v8::Isolate* isolate, mate::Dictionary dict(isolate, process); dict.SetMethod("crash", &Crash); + dict.SetMethod("hang", &Hang); dict.SetMethod("log", &Log); dict.SetMethod("activateUvLoop", base::Bind(&AtomBindings::ActivateUVLoop, base::Unretained(this))); diff --git a/docs/api/process.md b/docs/api/process.md index 4afa6677b8aa..c9efa22fe0f9 100644 --- a/docs/api/process.md +++ b/docs/api/process.md @@ -7,3 +7,7 @@ upstream node: * `process.versions['electron']` String - Version of Electron. * `process.versions['chrome']` String - Version of Chromium. * `process.resourcesPath` String - Path to JavaScript source code. + +## process.hang + +Causes the main thread of the current process hang. From b47fae7393a8867bd543e76fde80bfff8682a6ec Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 18 Jun 2015 16:59:03 +0800 Subject: [PATCH 0312/1293] Make api::Protocol per-context --- atom/browser/api/atom_api_protocol.cc | 15 ++++++++++----- atom/browser/api/atom_api_protocol.h | 7 +++++-- 2 files changed, 15 insertions(+), 7 deletions(-) diff --git a/atom/browser/api/atom_api_protocol.cc b/atom/browser/api/atom_api_protocol.cc index 9bc2de4b42a9..b4ce2e327ba8 100644 --- a/atom/browser/api/atom_api_protocol.cc +++ b/atom/browser/api/atom_api_protocol.cc @@ -5,6 +5,7 @@ #include "atom/browser/api/atom_api_protocol.h" #include "atom/browser/atom_browser_context.h" +#include "atom/browser/atom_browser_main_parts.h" #include "atom/browser/net/adapter_request_job.h" #include "atom/browser/net/atom_url_request_job_factory.h" #include "atom/common/native_mate_converters/file_path_converter.h" @@ -190,8 +191,9 @@ class CustomProtocolHandler : public ProtocolHandler { } // namespace -Protocol::Protocol() - : job_factory_(AtomBrowserContext::Get()->job_factory()) { +Protocol::Protocol(AtomBrowserContext* browser_context) + : browser_context_(browser_context), + job_factory_(browser_context->job_factory()) { CHECK(job_factory_); } @@ -343,8 +345,9 @@ void Protocol::EmitEventInUI(const std::string& event, } // static -mate::Handle Protocol::Create(v8::Isolate* isolate) { - return CreateHandle(isolate, new Protocol); +mate::Handle Protocol::Create( + v8::Isolate* isolate, AtomBrowserContext* browser_context) { + return CreateHandle(isolate, new Protocol(browser_context)); } } // namespace api @@ -357,7 +360,9 @@ void Initialize(v8::Local exports, v8::Local unused, v8::Local context, void* priv) { v8::Isolate* isolate = context->GetIsolate(); mate::Dictionary dict(isolate, exports); - dict.Set("protocol", atom::api::Protocol::Create(isolate)); + auto browser_context = static_cast( + atom::AtomBrowserMainParts::Get()->browser_context()); + dict.Set("protocol", atom::api::Protocol::Create(isolate, browser_context)); } } // namespace diff --git a/atom/browser/api/atom_api_protocol.h b/atom/browser/api/atom_api_protocol.h index 34725cecc925..8d76008eb52c 100644 --- a/atom/browser/api/atom_api_protocol.h +++ b/atom/browser/api/atom_api_protocol.h @@ -18,6 +18,7 @@ class URLRequest; namespace atom { +class AtomBrowserContext; class AtomURLRequestJobFactory; namespace api { @@ -27,12 +28,13 @@ class Protocol : public mate::EventEmitter { typedef base::Callback(const net::URLRequest*)> JsProtocolHandler; - static mate::Handle Create(v8::Isolate* isolate); + static mate::Handle Create( + v8::Isolate* isolate, AtomBrowserContext* browser_context); JsProtocolHandler GetProtocolHandler(const std::string& scheme); protected: - Protocol(); + explicit Protocol(AtomBrowserContext* browser_context); // mate::Wrappable implementations: virtual mate::ObjectTemplateBuilder GetObjectTemplateBuilder( @@ -68,6 +70,7 @@ class Protocol : public mate::EventEmitter { // Do protocol.emit(event, parameter) under UI thread. void EmitEventInUI(const std::string& event, const std::string& parameter); + AtomBrowserContext* browser_context_; AtomURLRequestJobFactory* job_factory_; ProtocolHandlersMap protocol_handlers_; From e209312459a880b519efba5f85a6a11e78b666c9 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 18 Jun 2015 17:01:23 +0800 Subject: [PATCH 0313/1293] Replace a few calls to AtomBrowserMainParts::Get. These calls replies on global BrowserContext, we can just make them use the future default BrowserContext. --- atom/browser/api/atom_api_app.cc | 4 +++- atom/browser/api/atom_api_web_contents.cc | 3 ++- atom/browser/atom_access_token_store.cc | 5 +++-- atom/browser/native_window.cc | 4 +++- 4 files changed, 11 insertions(+), 5 deletions(-) diff --git a/atom/browser/api/atom_api_app.cc b/atom/browser/api/atom_api_app.cc index 27178b389409..7468a4b8b837 100644 --- a/atom/browser/api/atom_api_app.cc +++ b/atom/browser/api/atom_api_app.cc @@ -13,6 +13,7 @@ #include "atom/browser/api/atom_api_menu.h" #include "atom/browser/atom_browser_context.h" +#include "atom/browser/atom_browser_main_parts.h" #include "atom/browser/browser.h" #include "atom/common/native_mate_converters/file_path_converter.h" #include "atom/common/native_mate_converters/gurl_converter.h" @@ -97,7 +98,8 @@ class ResolveProxyHelper { public: ResolveProxyHelper(const GURL& url, App::ResolveProxyCallback callback) : callback_(callback) { - net::ProxyService* proxy_service = AtomBrowserContext::Get()-> + auto browser_context = AtomBrowserMainParts::Get()->browser_context(); + net::ProxyService* proxy_service = browser_context-> url_request_context_getter()->GetURLRequestContext()->proxy_service(); // Start the request. diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 192955e6acbb..af00112d09a6 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -8,6 +8,7 @@ #include "atom/browser/atom_browser_client.h" #include "atom/browser/atom_browser_context.h" +#include "atom/browser/atom_browser_main_parts.h" #include "atom/browser/native_window.h" #include "atom/common/api/api_messages.h" #include "atom/common/native_mate_converters/gfx_converter.h" @@ -144,7 +145,7 @@ WebContents::WebContents(const mate::Dictionary& options) guest_host_(nullptr), auto_size_enabled_(false), is_full_page_plugin_(false) { - auto browser_context = AtomBrowserContext::Get(); + auto browser_context = AtomBrowserMainParts::Get()->browser_context(); content::SiteInstance* site_instance = content::SiteInstance::CreateForURL( browser_context, GURL("chrome-guest://fake-host")); diff --git a/atom/browser/atom_access_token_store.cc b/atom/browser/atom_access_token_store.cc index 5e117869a4ee..86ce1c215936 100644 --- a/atom/browser/atom_access_token_store.cc +++ b/atom/browser/atom_access_token_store.cc @@ -7,6 +7,7 @@ #include #include "atom/browser/atom_browser_context.h" +#include "atom/browser/atom_browser_main_parts.h" #include "atom/common/google_api_key.h" namespace atom { @@ -39,8 +40,8 @@ void AtomAccessTokenStore::LoadAccessTokens( token_pair.first = GURL(kGeolocationProviderUrl); access_token_set.insert(token_pair); - callback.Run(access_token_set, - AtomBrowserContext::Get()->url_request_context_getter()); + auto browser_context = AtomBrowserMainParts::Get()->browser_context(); + callback.Run(access_token_set, browser_context->url_request_context_getter()); } void AtomAccessTokenStore::SaveAccessToken(const GURL& server_url, diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 48ea9e76c32c..5404eba59791 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -9,6 +9,7 @@ #include #include "atom/browser/atom_browser_context.h" +#include "atom/browser/atom_browser_main_parts.h" #include "atom/browser/browser.h" #include "atom/browser/window_list.h" #include "atom/common/api/api_messages.h" @@ -153,7 +154,8 @@ NativeWindow::~NativeWindow() { // static NativeWindow* NativeWindow::Create(const mate::Dictionary& options) { - content::WebContents::CreateParams create_params(AtomBrowserContext::Get()); + auto browser_context = AtomBrowserMainParts::Get()->browser_context(); + content::WebContents::CreateParams create_params(browser_context); return Create(content::WebContents::Create(create_params), options); } From 923296b4ee3d978f5058a571eb126882960f8a41 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 18 Jun 2015 17:18:11 +0800 Subject: [PATCH 0314/1293] Use the BrowserContext from protocol --- atom/browser/api/atom_api_protocol.cc | 4 ++-- atom/browser/api/atom_api_protocol.h | 2 ++ atom/browser/net/adapter_request_job.cc | 12 +++++++----- atom/browser/net/adapter_request_job.h | 5 ++++- atom/browser/net/url_request_fetch_job.cc | 4 ++-- atom/browser/net/url_request_fetch_job.h | 5 ++++- 6 files changed, 21 insertions(+), 11 deletions(-) diff --git a/atom/browser/api/atom_api_protocol.cc b/atom/browser/api/atom_api_protocol.cc index b4ce2e327ba8..75dd70d2a460 100644 --- a/atom/browser/api/atom_api_protocol.cc +++ b/atom/browser/api/atom_api_protocol.cc @@ -132,8 +132,8 @@ class CustomProtocolRequestJob : public AdapterRequestJob { dict.Get("referrer", &referrer); BrowserThread::PostTask(BrowserThread::IO, FROM_HERE, - base::Bind(&AdapterRequestJob::CreateHttpJobAndStart, - GetWeakPtr(), url, method, referrer)); + base::Bind(&AdapterRequestJob::CreateHttpJobAndStart, GetWeakPtr(), + registry_->browser_context(), url, method, referrer)); return; } } diff --git a/atom/browser/api/atom_api_protocol.h b/atom/browser/api/atom_api_protocol.h index 8d76008eb52c..3e2e18d33f51 100644 --- a/atom/browser/api/atom_api_protocol.h +++ b/atom/browser/api/atom_api_protocol.h @@ -33,6 +33,8 @@ class Protocol : public mate::EventEmitter { JsProtocolHandler GetProtocolHandler(const std::string& scheme); + AtomBrowserContext* browser_context() const { return browser_context_; } + protected: explicit Protocol(AtomBrowserContext* browser_context); diff --git a/atom/browser/net/adapter_request_job.cc b/atom/browser/net/adapter_request_job.cc index 08331829b550..20be9a708945 100644 --- a/atom/browser/net/adapter_request_job.cc +++ b/atom/browser/net/adapter_request_job.cc @@ -114,16 +114,18 @@ void AdapterRequestJob::CreateFileJobAndStart(const base::FilePath& path) { real_job_->Start(); } -void AdapterRequestJob::CreateHttpJobAndStart(const GURL& url, - const std::string& method, - const std::string& referrer) { +void AdapterRequestJob::CreateHttpJobAndStart( + AtomBrowserContext* browser_context, + const GURL& url, + const std::string& method, + const std::string& referrer) { if (!url.is_valid()) { CreateErrorJobAndStart(net::ERR_INVALID_URL); return; } - real_job_ = new URLRequestFetchJob(request(), network_delegate(), url, - method, referrer); + real_job_ = new URLRequestFetchJob(browser_context, request(), + network_delegate(), url, method, referrer); real_job_->Start(); } diff --git a/atom/browser/net/adapter_request_job.h b/atom/browser/net/adapter_request_job.h index d5e814d214d4..6aff376f3021 100644 --- a/atom/browser/net/adapter_request_job.h +++ b/atom/browser/net/adapter_request_job.h @@ -20,6 +20,8 @@ class FilePath; namespace atom { +class AtomBrowserContext; + // Ask JS which type of job it wants, and then delegate corresponding methods. class AdapterRequestJob : public net::URLRequestJob { public: @@ -59,7 +61,8 @@ class AdapterRequestJob : public net::URLRequestJob { const std::string& charset, scoped_refptr data); void CreateFileJobAndStart(const base::FilePath& path); - void CreateHttpJobAndStart(const GURL& url, + void CreateHttpJobAndStart(AtomBrowserContext* browser_context, + const GURL& url, const std::string& method, const std::string& referrer); void CreateJobFromProtocolHandlerAndStart(); diff --git a/atom/browser/net/url_request_fetch_job.cc b/atom/browser/net/url_request_fetch_job.cc index f77379aed6c2..e353ff170879 100644 --- a/atom/browser/net/url_request_fetch_job.cc +++ b/atom/browser/net/url_request_fetch_job.cc @@ -74,6 +74,7 @@ class ResponsePiper : public net::URLFetcherResponseWriter { } // namespace URLRequestFetchJob::URLRequestFetchJob( + AtomBrowserContext* browser_context, net::URLRequest* request, net::NetworkDelegate* network_delegate, const GURL& url, @@ -89,8 +90,7 @@ URLRequestFetchJob::URLRequestFetchJob( request_type = GetRequestType(method); fetcher_.reset(net::URLFetcher::Create(url, request_type, this)); - auto context = AtomBrowserContext::Get()->url_request_context_getter(); - fetcher_->SetRequestContext(context); + fetcher_->SetRequestContext(browser_context->url_request_context_getter()); fetcher_->SaveResponseWithWriter(make_scoped_ptr(new ResponsePiper(this))); // Use |request|'s referrer if |referrer| is not specified. diff --git a/atom/browser/net/url_request_fetch_job.h b/atom/browser/net/url_request_fetch_job.h index 7975aa715eec..d598e3223618 100644 --- a/atom/browser/net/url_request_fetch_job.h +++ b/atom/browser/net/url_request_fetch_job.h @@ -12,10 +12,13 @@ namespace atom { +class AtomBrowserContext; + class URLRequestFetchJob : public net::URLRequestJob, public net::URLFetcherDelegate { public: - URLRequestFetchJob(net::URLRequest* request, + URLRequestFetchJob(AtomBrowserContext* browser_context, + net::URLRequest* request, net::NetworkDelegate* network_delegate, const GURL& url, const std::string& method, From 91f3b3955ab71bbe13b0e641bfe6f94131151e08 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 18 Jun 2015 17:19:29 +0800 Subject: [PATCH 0315/1293] Remove AtomBrowserContext::Get --- atom/browser/atom_browser_context.cc | 6 ------ atom/browser/atom_browser_context.h | 3 --- 2 files changed, 9 deletions(-) diff --git a/atom/browser/atom_browser_context.cc b/atom/browser/atom_browser_context.cc index f09f094bf428..64b80fb61453 100644 --- a/atom/browser/atom_browser_context.cc +++ b/atom/browser/atom_browser_context.cc @@ -104,10 +104,4 @@ content::BrowserPluginGuestManager* AtomBrowserContext::GetGuestManager() { return guest_manager_.get(); } -// static -AtomBrowserContext* AtomBrowserContext::Get() { - return static_cast( - AtomBrowserMainParts::Get()->browser_context()); -} - } // namespace atom diff --git a/atom/browser/atom_browser_context.h b/atom/browser/atom_browser_context.h index 2f2efc944330..688a4977fa2d 100644 --- a/atom/browser/atom_browser_context.h +++ b/atom/browser/atom_browser_context.h @@ -17,9 +17,6 @@ class AtomBrowserContext : public brightray::BrowserContext { AtomBrowserContext(); virtual ~AtomBrowserContext(); - // Returns the browser context singleton. - static AtomBrowserContext* Get(); - // brightray::URLRequestContextGetter::Delegate: net::URLRequestJobFactory* CreateURLRequestJobFactory( content::ProtocolHandlerMap* handlers, From cb1d9f60ecfb3454a875fb7074623303f5f5f6c2 Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Thu, 18 Jun 2015 21:14:45 +0530 Subject: [PATCH 0316/1293] override: set window.opener to null for webview --- atom/renderer/lib/override.coffee | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/atom/renderer/lib/override.coffee b/atom/renderer/lib/override.coffee index 2e25ffbd6b43..4c2b64a816e0 100644 --- a/atom/renderer/lib/override.coffee +++ b/atom/renderer/lib/override.coffee @@ -76,9 +76,10 @@ window.prompt = -> throw new Error('prompt() is and will not be supported.') # Simple implementation of postMessage. -window.opener = - postMessage: (message, targetOrigin='*') -> - ipc.send 'ATOM_SHELL_GUEST_WINDOW_MANAGER_WINDOW_OPENER_POSTMESSAGE', message, targetOrigin +unless process.guestInstanceId? + window.opener = + postMessage: (message, targetOrigin='*') -> + ipc.send 'ATOM_SHELL_GUEST_WINDOW_MANAGER_WINDOW_OPENER_POSTMESSAGE', message, targetOrigin ipc.on 'ATOM_SHELL_GUEST_WINDOW_POSTMESSAGE', (message, targetOrigin) -> window.postMessage message, targetOrigin From dbbc2f19f4c0bd71d2c1c81754a6fe449c770604 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Sun, 14 Jun 2015 16:19:53 +0800 Subject: [PATCH 0317/1293] Implement cookies.get API. --- atom/browser/api/atom_api_cookies.cc | 209 +++++++++++++++++++++++++++ atom/browser/api/atom_api_cookies.h | 56 +++++++ atom/browser/api/lib/cookies.coffee | 3 + atom/common/node_bindings.cc | 1 + filenames.gypi | 3 + 5 files changed, 272 insertions(+) create mode 100644 atom/browser/api/atom_api_cookies.cc create mode 100644 atom/browser/api/atom_api_cookies.h create mode 100644 atom/browser/api/lib/cookies.coffee diff --git a/atom/browser/api/atom_api_cookies.cc b/atom/browser/api/atom_api_cookies.cc new file mode 100644 index 000000000000..bc784321da81 --- /dev/null +++ b/atom/browser/api/atom_api_cookies.cc @@ -0,0 +1,209 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#include "atom/browser/api/atom_api_cookies.h" + +#include "atom/browser/atom_browser_context.h" +#include "atom/common/native_mate_converters/value_converter.h" +#include "base/bind.h" +#include "content/public/browser/browser_thread.h" +#include "native_mate/callback.h" +#include "native_mate/dictionary.h" +#include "native_mate/object_template_builder.h" +#include "net/cookies/cookie_monster.h" +#include "net/cookies/cookie_store.h" +#include "net/cookies/cookie_util.h" +#include "net/url_request/url_request_context.h" + +#include "atom/common/node_includes.h" + +using content::BrowserThread; + +namespace { + +bool GetCookieListFromStore(net::CookieStore* cookie_store, + const std::string& url, + const net::CookieMonster::GetCookieListCallback& callback) { + DCHECK(cookie_store); + GURL gurl(url); + net::CookieMonster* monster = cookie_store->GetCookieMonster(); + // Empty url will match all url cookies. + if (url.empty()) { + monster->GetAllCookiesAsync(callback); + return true; + } + + if (!gurl.is_valid()) + return false; + + monster->GetAllCookiesForURLAsync(gurl, callback); + return true; +} + +void RunGetCookiesCallbackOnUIThread(const base::DictionaryValue* filter, + const std::string& error_message, const net::CookieList& cookie_list, + const atom::api::Cookies::GetCookiesCallback& callback) { + // Should release filter here. + delete filter; + + v8::Isolate* isolate = v8::Isolate::GetCurrent(); + v8::Locker locker(isolate); + v8::HandleScope handle_scope(isolate); + + if (!error_message.empty()) { + v8::Local error = v8::String::NewFromUtf8(isolate, + error_message.c_str()); + callback.Run(error, v8::Null(isolate)); + return; + } + callback.Run(v8::Null(isolate), + mate::Converter::ToV8(isolate, cookie_list)); +} + +bool MatchesDomain(const base::DictionaryValue* filter, + const std::string& cookie_domain) { + std::string filter_domain; + if (!filter->GetString("domain", &filter_domain)) + return true; + + // Add a leading '.' character to the filter domain if it doesn't exist. + if (net::cookie_util::DomainIsHostOnly(filter_domain)) + filter_domain.insert(0, "."); + + std::string sub_domain(cookie_domain); + // Strip any leading '.' character from the input cookie domain. + if (!net::cookie_util::DomainIsHostOnly(sub_domain)) + sub_domain = sub_domain.substr(1); + + // Now check whether the domain argument is a subdomain of the filter domain. + for (sub_domain.insert(0, "."); + sub_domain.length() >= filter_domain.length();) { + if (sub_domain == filter_domain) { + return true; + } + const size_t next_dot = sub_domain.find('.', 1); // Skip over leading dot. + sub_domain.erase(0, next_dot); + } + return false; +} + +bool MatchesCookie(const base::DictionaryValue* filter, + const net::CanonicalCookie& cookie) { + std::string name, domain, path; + bool is_secure, session; + if (filter->GetString("name", &name) && name != cookie.Name()) + return false; + if (filter->GetString("path", &path) && path != cookie.Path()) + return false; + if (!MatchesDomain(filter, cookie.Domain())) + return false; + if (filter->GetBoolean("secure", &is_secure) && + is_secure != cookie.IsSecure()) + return false; + if (filter->GetBoolean("session", &session) && + session != cookie.IsPersistent()) + return false; + return true; +} + +} // namespace + +namespace mate { + +template<> +struct Converter { + static v8::Local ToV8(v8::Isolate* isolate, + const net::CanonicalCookie& val) { + mate::Dictionary dict(isolate, v8::Object::New(isolate)); + dict.Set("name", val.Name()); + dict.Set("value", val.Value()); + dict.Set("source", val.Source()); + dict.Set("domain", val.Domain()); + dict.Set("path", val.Path()); + dict.Set("secure", val.IsSecure()); + dict.Set("http_only", val.IsHttpOnly()); + dict.Set("session", val.IsPersistent()); + if (!val.IsPersistent()) + dict.Set("expirationDate", val.ExpiryDate().ToDoubleT()); + return dict.GetHandle(); + } +}; + +} + +namespace atom { + +namespace api { + +Cookies::Cookies() { +} + +Cookies::~Cookies() { +} + +void Cookies::Get(const base::DictionaryValue& options, + const GetCookiesCallback& callback) { + // The filter will be deleted manually after callback function finishes. + base::DictionaryValue* filter = options.DeepCopyWithoutEmptyChildren(); + + content::BrowserThread::PostTask(BrowserThread::IO, FROM_HERE, + base::Bind(&Cookies::GetCookiesOnIOThread, base::Unretained(this), + filter, callback)); +} + +void Cookies::GetCookiesOnIOThread(const base::DictionaryValue* filter, + const GetCookiesCallback& callback) { + net::CookieStore* cookie_store = + AtomBrowserContext::Get()->url_request_context_getter() + ->GetURLRequestContext()->cookie_store(); + std::string url; + filter->GetString("url", &url); + if (!GetCookieListFromStore(cookie_store, url, + base::Bind(&Cookies::OnGetCookies, base::Unretained(this), filter, + callback))) { + BrowserThread::PostTask(BrowserThread::UI, FROM_HERE, + base::Bind(&RunGetCookiesCallbackOnUIThread, filter, "url is not valid", + net::CookieList(), callback)); + } +} + +void Cookies::OnGetCookies(const base::DictionaryValue* filter, + const GetCookiesCallback& callback, + const net::CookieList& cookie_list) { + net::CookieList result; + for (const auto& cookie : cookie_list) { + if (MatchesCookie(filter, cookie)) + result.push_back(cookie); + } + BrowserThread::PostTask(BrowserThread::UI, FROM_HERE, base::Bind( + &RunGetCookiesCallbackOnUIThread, filter, "", result, callback)); +} + +mate::ObjectTemplateBuilder Cookies::GetObjectTemplateBuilder( + v8::Isolate* isolate) { + return mate::ObjectTemplateBuilder(isolate) + .SetMethod("get", &Cookies::Get); +} + +// static +mate::Handle Cookies::Create(v8::Isolate* isolate) { + return CreateHandle(isolate, new Cookies); +} + +} // namespace api + +} // namespace atom + +namespace { + +void Initialize(v8::Local exports, v8::Local unused, + v8::Local context, void* priv) { + v8::Isolate* isolate = context->GetIsolate(); + mate::Dictionary dict(isolate, exports); + dict.Set("cookies", atom::api::Cookies::Create(isolate)); +} + +} // namespace + +NODE_MODULE_CONTEXT_AWARE_BUILTIN(atom_browser_cookies, Initialize); diff --git a/atom/browser/api/atom_api_cookies.h b/atom/browser/api/atom_api_cookies.h new file mode 100644 index 000000000000..ad0988106df1 --- /dev/null +++ b/atom/browser/api/atom_api_cookies.h @@ -0,0 +1,56 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#ifndef ATOM_BROWSER_API_ATOM_API_COOKIES_H_ +#define ATOM_BROWSER_API_ATOM_API_COOKIES_H_ + +#include + +#include "base/callback.h" +#include "base/values.h" +#include "native_mate/wrappable.h" +#include "native_mate/handle.h" +#include "native_mate/dictionary.h" + +#include "net/cookies/canonical_cookie.h" + +namespace atom { + +namespace api { + +class Cookies : public mate::Wrappable { + public: + // node.js style callback function(error, result) + typedef base::Callback, v8::Local)> + GetCookiesCallback; + + static mate::Handle Create(v8::Isolate* isolate); + + protected: + Cookies(); + ~Cookies(); + + void Get(const base::DictionaryValue& options, + const GetCookiesCallback& callback); + + void GetCookiesOnIOThread(const base::DictionaryValue* filter, + const GetCookiesCallback& callback); + + void OnGetCookies(const base::DictionaryValue* filter, + const GetCookiesCallback& callback, + const net::CookieList& cookie_list); + + // mate::Wrappable implementations: + mate::ObjectTemplateBuilder GetObjectTemplateBuilder( + v8::Isolate* isolate) override; + + private: + DISALLOW_COPY_AND_ASSIGN(Cookies); +}; + +} // namespace api + +} // namespace atom + +#endif // ATOM_BROWSER_API_ATOM_API_COOKIES_H_ diff --git a/atom/browser/api/lib/cookies.coffee b/atom/browser/api/lib/cookies.coffee new file mode 100644 index 000000000000..1d9114fd2c19 --- /dev/null +++ b/atom/browser/api/lib/cookies.coffee @@ -0,0 +1,3 @@ +bindings = process.atomBinding 'cookies' + +module.exports = bindings.cookies diff --git a/atom/common/node_bindings.cc b/atom/common/node_bindings.cc index eb627d06b757..329683c60602 100644 --- a/atom/common/node_bindings.cc +++ b/atom/common/node_bindings.cc @@ -32,6 +32,7 @@ using content::BrowserThread; REFERENCE_MODULE(atom_browser_app); REFERENCE_MODULE(atom_browser_auto_updater); REFERENCE_MODULE(atom_browser_content_tracing); +REFERENCE_MODULE(atom_browser_cookies); REFERENCE_MODULE(atom_browser_dialog); REFERENCE_MODULE(atom_browser_menu); REFERENCE_MODULE(atom_browser_power_monitor); diff --git a/filenames.gypi b/filenames.gypi index 99d37b5d3093..e4da4c89398d 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -13,6 +13,7 @@ 'atom/browser/api/lib/auto-updater.coffee', 'atom/browser/api/lib/browser-window.coffee', 'atom/browser/api/lib/content-tracing.coffee', + 'atom/browser/api/lib/cookies.coffee', 'atom/browser/api/lib/dialog.coffee', 'atom/browser/api/lib/global-shortcut.coffee', 'atom/browser/api/lib/ipc.coffee', @@ -69,6 +70,8 @@ 'atom/browser/api/atom_api_auto_updater.cc', 'atom/browser/api/atom_api_auto_updater.h', 'atom/browser/api/atom_api_content_tracing.cc', + 'atom/browser/api/atom_api_cookies.cc', + 'atom/browser/api/atom_api_cookies.h', 'atom/browser/api/atom_api_dialog.cc', 'atom/browser/api/atom_api_global_shortcut.cc', 'atom/browser/api/atom_api_global_shortcut.h', From 0dfd00f6644c1dcd98c31a69d78401eb2a7e78d4 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Mon, 15 Jun 2015 15:33:09 +0800 Subject: [PATCH 0318/1293] Add cookies.remove API. --- atom/browser/api/atom_api_cookies.cc | 63 +++++++++++++++++++++++++--- atom/browser/api/atom_api_cookies.h | 17 +++++--- 2 files changed, 69 insertions(+), 11 deletions(-) diff --git a/atom/browser/api/atom_api_cookies.cc b/atom/browser/api/atom_api_cookies.cc index bc784321da81..c87b4fca62da 100644 --- a/atom/browser/api/atom_api_cookies.cc +++ b/atom/browser/api/atom_api_cookies.cc @@ -43,7 +43,7 @@ bool GetCookieListFromStore(net::CookieStore* cookie_store, void RunGetCookiesCallbackOnUIThread(const base::DictionaryValue* filter, const std::string& error_message, const net::CookieList& cookie_list, - const atom::api::Cookies::GetCookiesCallback& callback) { + const atom::api::Cookies::CookiesCallback& callback) { // Should release filter here. delete filter; @@ -61,6 +61,22 @@ void RunGetCookiesCallbackOnUIThread(const base::DictionaryValue* filter, mate::Converter::ToV8(isolate, cookie_list)); } +void RunRemoveCookiesCallbackOnUIThread(const std::string& error_message, + const atom::api::Cookies::CookiesCallback& callback) { + v8::Isolate* isolate = v8::Isolate::GetCurrent(); + v8::Locker locker(isolate); + v8::HandleScope handle_scope(isolate); + + if (!error_message.empty()) { + v8::Local error = v8::String::NewFromUtf8(isolate, + error_message.c_str()); + callback.Run(error, v8::Null(isolate)); + return; + } + + callback.Run(v8::Null(isolate), v8::Null(isolate)); +} + bool MatchesDomain(const base::DictionaryValue* filter, const std::string& cookie_domain) { std::string filter_domain; @@ -143,7 +159,7 @@ Cookies::~Cookies() { } void Cookies::Get(const base::DictionaryValue& options, - const GetCookiesCallback& callback) { + const CookiesCallback& callback) { // The filter will be deleted manually after callback function finishes. base::DictionaryValue* filter = options.DeepCopyWithoutEmptyChildren(); @@ -153,7 +169,7 @@ void Cookies::Get(const base::DictionaryValue& options, } void Cookies::GetCookiesOnIOThread(const base::DictionaryValue* filter, - const GetCookiesCallback& callback) { + const CookiesCallback& callback) { net::CookieStore* cookie_store = AtomBrowserContext::Get()->url_request_context_getter() ->GetURLRequestContext()->cookie_store(); @@ -163,13 +179,13 @@ void Cookies::GetCookiesOnIOThread(const base::DictionaryValue* filter, base::Bind(&Cookies::OnGetCookies, base::Unretained(this), filter, callback))) { BrowserThread::PostTask(BrowserThread::UI, FROM_HERE, - base::Bind(&RunGetCookiesCallbackOnUIThread, filter, "url is not valid", + base::Bind(&RunGetCookiesCallbackOnUIThread, filter, "Url is not valid", net::CookieList(), callback)); } } void Cookies::OnGetCookies(const base::DictionaryValue* filter, - const GetCookiesCallback& callback, + const CookiesCallback& callback, const net::CookieList& cookie_list) { net::CookieList result; for (const auto& cookie : cookie_list) { @@ -180,10 +196,45 @@ void Cookies::OnGetCookies(const base::DictionaryValue* filter, &RunGetCookiesCallbackOnUIThread, filter, "", result, callback)); } +void Cookies::Remove(const base::DictionaryValue& details, + const CookiesCallback& callback) { + std::string url, name; + std::string error_message; + if (!details.GetString("url", &url) || !details.GetString("name", &name)) { + error_message = "Details(url, name) of removing cookie are required."; + } + GURL gurl(url); + if (error_message.empty() && !gurl.is_valid()) { + error_message = "Url is not valid."; + } + if (!error_message.empty()) { + RunRemoveCookiesCallbackOnUIThread(error_message, callback); + return; + } + content::BrowserThread::PostTask(BrowserThread::IO, FROM_HERE, + base::Bind(&Cookies::RemoveCookiesOnIOThread, base::Unretained(this), + gurl, name, callback)); +} + +void Cookies::RemoveCookiesOnIOThread(const GURL& url, const std::string& name, + const CookiesCallback& callback) { + net::CookieStore* cookie_store = + AtomBrowserContext::Get()->url_request_context_getter() + ->GetURLRequestContext()->cookie_store(); + cookie_store->DeleteCookieAsync(url, name, + base::Bind(&Cookies::OnRemoveCookies, base::Unretained(this), callback)); +} + +void Cookies::OnRemoveCookies(const CookiesCallback& callback) { + BrowserThread::PostTask(BrowserThread::UI, FROM_HERE, + base::Bind(&RunRemoveCookiesCallbackOnUIThread, "", callback)); +} + mate::ObjectTemplateBuilder Cookies::GetObjectTemplateBuilder( v8::Isolate* isolate) { return mate::ObjectTemplateBuilder(isolate) - .SetMethod("get", &Cookies::Get); + .SetMethod("get", &Cookies::Get) + .SetMethod("remove", &Cookies::Remove); } // static diff --git a/atom/browser/api/atom_api_cookies.h b/atom/browser/api/atom_api_cookies.h index ad0988106df1..1ea4886b26c8 100644 --- a/atom/browser/api/atom_api_cookies.h +++ b/atom/browser/api/atom_api_cookies.h @@ -23,7 +23,7 @@ class Cookies : public mate::Wrappable { public: // node.js style callback function(error, result) typedef base::Callback, v8::Local)> - GetCookiesCallback; + CookiesCallback; static mate::Handle Create(v8::Isolate* isolate); @@ -32,15 +32,22 @@ class Cookies : public mate::Wrappable { ~Cookies(); void Get(const base::DictionaryValue& options, - const GetCookiesCallback& callback); + const CookiesCallback& callback); + void Remove(const base::DictionaryValue& details, + const CookiesCallback& callback); void GetCookiesOnIOThread(const base::DictionaryValue* filter, - const GetCookiesCallback& callback); - + const CookiesCallback& callback); void OnGetCookies(const base::DictionaryValue* filter, - const GetCookiesCallback& callback, + const CookiesCallback& callback, const net::CookieList& cookie_list); + void RemoveCookiesOnIOThread(const GURL& url, + const std::string& name, + const CookiesCallback& callback); + void OnRemoveCookies(const CookiesCallback& callback); + + // mate::Wrappable implementations: mate::ObjectTemplateBuilder GetObjectTemplateBuilder( v8::Isolate* isolate) override; From cfffe39151ba40a5f2fcc1d7e33d928522cbc4cc Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Mon, 15 Jun 2015 21:18:40 +0800 Subject: [PATCH 0319/1293] Add cookies.set API. --- atom/browser/api/atom_api_cookies.cc | 105 ++++++++++++++++++++++++++- atom/browser/api/atom_api_cookies.h | 9 +++ 2 files changed, 113 insertions(+), 1 deletion(-) diff --git a/atom/browser/api/atom_api_cookies.cc b/atom/browser/api/atom_api_cookies.cc index c87b4fca62da..17418bcf9d17 100644 --- a/atom/browser/api/atom_api_cookies.cc +++ b/atom/browser/api/atom_api_cookies.cc @@ -7,6 +7,7 @@ #include "atom/browser/atom_browser_context.h" #include "atom/common/native_mate_converters/value_converter.h" #include "base/bind.h" +#include "base/time/time.h" #include "content/public/browser/browser_thread.h" #include "native_mate/callback.h" #include "native_mate/dictionary.h" @@ -44,6 +45,8 @@ bool GetCookieListFromStore(net::CookieStore* cookie_store, void RunGetCookiesCallbackOnUIThread(const base::DictionaryValue* filter, const std::string& error_message, const net::CookieList& cookie_list, const atom::api::Cookies::CookiesCallback& callback) { + DCHECK_CURRENTLY_ON(BrowserThread::UI); + // Should release filter here. delete filter; @@ -63,6 +66,8 @@ void RunGetCookiesCallbackOnUIThread(const base::DictionaryValue* filter, void RunRemoveCookiesCallbackOnUIThread(const std::string& error_message, const atom::api::Cookies::CookiesCallback& callback) { + DCHECK_CURRENTLY_ON(BrowserThread::UI); + v8::Isolate* isolate = v8::Isolate::GetCurrent(); v8::Locker locker(isolate); v8::HandleScope handle_scope(isolate); @@ -77,6 +82,27 @@ void RunRemoveCookiesCallbackOnUIThread(const std::string& error_message, callback.Run(v8::Null(isolate), v8::Null(isolate)); } +void RunSetCookiesCallbackOnUIThread(const base::DictionaryValue* details, + const std::string& error_message, bool set_success, + const atom::api::Cookies::CookiesCallback& callback) { + DCHECK_CURRENTLY_ON(BrowserThread::UI); + + delete details; + + v8::Isolate* isolate = v8::Isolate::GetCurrent(); + v8::Locker locker(isolate); + v8::HandleScope handle_scope(isolate); + + if (!error_message.empty()) { + v8::Local error = v8::String::NewFromUtf8(isolate, + error_message.c_str()); + callback.Run(error, v8::Null(isolate)); + return; + } + + callback.Run(v8::Null(isolate), v8::Boolean::New(isolate, set_success)); +} + bool MatchesDomain(const base::DictionaryValue* filter, const std::string& cookie_domain) { std::string filter_domain; @@ -230,11 +256,88 @@ void Cookies::OnRemoveCookies(const CookiesCallback& callback) { base::Bind(&RunRemoveCookiesCallbackOnUIThread, "", callback)); } +void Cookies::Set(const base::DictionaryValue& options, + const CookiesCallback& callback) { + std::string url; + std::string error_message; + if (!options.GetString("url", &url)) { + error_message = "The url field is required."; + } + + GURL gurl(url); + if (error_message.empty() && !gurl.is_valid()) { + error_message = "Url is not valid."; + } + + if (!error_message.empty()) { + RunSetCookiesCallbackOnUIThread(nullptr, error_message, false, callback); + return; + } + + // The filter will be deleted manually after callback function finishes. + base::DictionaryValue* details = options.DeepCopyWithoutEmptyChildren(); + + content::BrowserThread::PostTask(BrowserThread::IO, FROM_HERE, + base::Bind(&Cookies::SetCookiesOnIOThread, base::Unretained(this), + details, gurl, callback)); +} + +void Cookies::SetCookiesOnIOThread(const base::DictionaryValue* details, + const GURL& url, + const CookiesCallback& callback) { + DCHECK_CURRENTLY_ON(BrowserThread::IO); + net::CookieStore* cookie_store = + AtomBrowserContext::Get()->url_request_context_getter() + ->GetURLRequestContext()->cookie_store(); + + std::string name, value, domain, path; + bool secure = false; + bool http_only = false; + double expiration_date; + + details->GetString("name", &name); + details->GetString("value", &value); + details->GetString("domain", &domain); + details->GetString("path", &path); + details->GetBoolean("secure", &secure); + details->GetBoolean("http_only", &http_only); + + base::Time expiration_time; + if (details->GetDouble("expirationDate", &expiration_date)) { + expiration_time = (expiration_date == 0) ? + base::Time::UnixEpoch() : + base::Time::FromDoubleT(expiration_date); + } + + cookie_store->GetCookieMonster()->SetCookieWithDetailsAsync( + url, + name, + value, + domain, + path, + expiration_time, + secure, + http_only, + false, + net::COOKIE_PRIORITY_DEFAULT, + base::Bind(&Cookies::OnSetCookies, base::Unretained(this), details, + callback)); +} + +void Cookies::OnSetCookies(const base::DictionaryValue* details, + const CookiesCallback& callback, + bool set_success) { + BrowserThread::PostTask(BrowserThread::UI, FROM_HERE, + base::Bind(&RunSetCookiesCallbackOnUIThread, details, "", set_success, + callback)); +} + mate::ObjectTemplateBuilder Cookies::GetObjectTemplateBuilder( v8::Isolate* isolate) { return mate::ObjectTemplateBuilder(isolate) .SetMethod("get", &Cookies::Get) - .SetMethod("remove", &Cookies::Remove); + .SetMethod("remove", &Cookies::Remove) + .SetMethod("set", &Cookies::Set); } // static diff --git a/atom/browser/api/atom_api_cookies.h b/atom/browser/api/atom_api_cookies.h index 1ea4886b26c8..c53e39bb3d80 100644 --- a/atom/browser/api/atom_api_cookies.h +++ b/atom/browser/api/atom_api_cookies.h @@ -35,6 +35,8 @@ class Cookies : public mate::Wrappable { const CookiesCallback& callback); void Remove(const base::DictionaryValue& details, const CookiesCallback& callback); + void Set(const base::DictionaryValue& details, + const CookiesCallback& callback); void GetCookiesOnIOThread(const base::DictionaryValue* filter, const CookiesCallback& callback); @@ -47,6 +49,13 @@ class Cookies : public mate::Wrappable { const CookiesCallback& callback); void OnRemoveCookies(const CookiesCallback& callback); + void SetCookiesOnIOThread(const base::DictionaryValue* details, + const GURL& url, + const CookiesCallback& callback); + void OnSetCookies(const base::DictionaryValue* details, + const CookiesCallback& callback, + bool set_success); + // mate::Wrappable implementations: mate::ObjectTemplateBuilder GetObjectTemplateBuilder( From 19e96cc212053a8041e965dde70ad9d9637b2105 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Mon, 15 Jun 2015 21:21:53 +0800 Subject: [PATCH 0320/1293] Fix cpplint. --- atom/browser/api/atom_api_cookies.cc | 2 +- atom/browser/api/atom_api_cookies.h | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/atom/browser/api/atom_api_cookies.cc b/atom/browser/api/atom_api_cookies.cc index 17418bcf9d17..a55c0c70d987 100644 --- a/atom/browser/api/atom_api_cookies.cc +++ b/atom/browser/api/atom_api_cookies.cc @@ -172,7 +172,7 @@ struct Converter { } }; -} +} // namespace mate namespace atom { diff --git a/atom/browser/api/atom_api_cookies.h b/atom/browser/api/atom_api_cookies.h index c53e39bb3d80..f4166a723981 100644 --- a/atom/browser/api/atom_api_cookies.h +++ b/atom/browser/api/atom_api_cookies.h @@ -69,4 +69,4 @@ class Cookies : public mate::Wrappable { } // namespace atom -#endif // ATOM_BROWSER_API_ATOM_API_COOKIES_H_ +#endif // ATOM_BROWSER_API_ATOM_API_COOKIES_H_ From 98adcac5df7e8c7106f70b53d9100da8942ccca2 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Mon, 15 Jun 2015 21:51:08 +0800 Subject: [PATCH 0321/1293] Move set status code into error. --- atom/browser/api/atom_api_cookies.cc | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/atom/browser/api/atom_api_cookies.cc b/atom/browser/api/atom_api_cookies.cc index a55c0c70d987..a52841b5fe3f 100644 --- a/atom/browser/api/atom_api_cookies.cc +++ b/atom/browser/api/atom_api_cookies.cc @@ -99,8 +99,13 @@ void RunSetCookiesCallbackOnUIThread(const base::DictionaryValue* details, callback.Run(error, v8::Null(isolate)); return; } + if (!set_success) { + v8::Local error = v8::String::NewFromUtf8(isolate, + "Failed to set cookies"); + callback.Run(error, v8::Null(isolate)); + } - callback.Run(v8::Null(isolate), v8::Boolean::New(isolate, set_success)); + callback.Run(v8::Null(isolate), v8::Null(isolate)); } bool MatchesDomain(const base::DictionaryValue* filter, From 4818e76ad9f53537abcda1b7c3f8676969457868 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Mon, 15 Jun 2015 21:52:15 +0800 Subject: [PATCH 0322/1293] :memo: add cookies doc. --- docs/README.md | 1 + docs/api/cookies.md | 63 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 64 insertions(+) create mode 100644 docs/api/cookies.md diff --git a/docs/README.md b/docs/README.md index 98b4219d3432..c01a748d05ee 100644 --- a/docs/README.md +++ b/docs/README.md @@ -32,6 +32,7 @@ Modules for the main process: * [auto-updater](api/auto-updater.md) * [browser-window](api/browser-window.md) * [content-tracing](api/content-tracing.md) +* [cookies](api/cookies.md) * [dialog](api/dialog.md) * [global-shortcut](api/global-shortcut.md) * [ipc (main process)](api/ipc-main-process.md) diff --git a/docs/api/cookies.md b/docs/api/cookies.md new file mode 100644 index 000000000000..d84e871be8d9 --- /dev/null +++ b/docs/api/cookies.md @@ -0,0 +1,63 @@ +# cookies + +The `cookies` module gives you ability to query and modify cookies, an example +is: + +```javascipt +var cookies = require('cookies'); + +// Query all cookies. +cookies.get({}, function(error, cookies) { + if (error) throw error; + console.log(cookies); +}); + +// Query all cookies that are associated with a specific url. +cookies.get({ url : "http://www.github.com" }, function(error, cookies) { + if (error) throw error; + console.log(cookies); +}); + +// Set a cookie with the given cookie data; may overwrite equivalent cookies if they exist. +cookies.set({ url : "http://www.github.com", name : "dummy_name", value : "dummy"}, + function(error, cookies) { + if (error) throw error; + console.log(cookies); +}); +``` + +## cookies.get(details, callback) + +* `details` Object + * `url` String - Retrieves cookies which are associated with `url`. Empty imples retrieving cookies of all urls. + * `name` String - Filters cookies by name + * `domain` String - Retrieves cookies whose domains match or are subdomains of `domains` + * `path` String - Retrieves cookies whose path matches `path` + * `secure` Boolean - Filters cookies by their Secure property + * `session` Boolean - Filters out session or persistent cookies. +* `callback` Function - function(error, cookies) + * `error` Error + * `cookies` Array - array of cookie objects. + +## cookies.set(details, callback) + +* `details` Object + * `url` String - Retrieves cookies which are associated with `url` + * `name` String - The name of the cookie. Empty by default if omitted. + * `value` String - The value of the cookie. Empty by default if omitted. + * `domain` String - The domain of the cookie. Empty by default if omitted. + * `path` String - The path of the cookie. Empty by default if omitted. + * `secure` Boolean - Whether the cookie should be marked as Secure. Defaults to false. + * `session` Boolean - Whether the cookie should be marked as HttpOnly. Defaults to false. + * `expirationDate` Double - The expiration date of the cookie as the number of seconds since the UNIX epoch. If omitted, the cookie becomes a session cookie. + +* `callback` Function - function(error) + * `error` Error + +## cookies.remove(details, callback) + +* `details` Object + * `url` String - The URL associated with the cookie + * `name` String - The name of cookie to remove +* `callback` Function - function(error) + * `error` Error From 245dc01e33760772ff758ce5effbbd0557be21c4 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Tue, 16 Jun 2015 10:37:39 +0800 Subject: [PATCH 0323/1293] Add cookies spec. --- spec/api-cookies-spec.coffee | 63 ++++++++++++++++++++++++++++++++++++ 1 file changed, 63 insertions(+) create mode 100644 spec/api-cookies-spec.coffee diff --git a/spec/api-cookies-spec.coffee b/spec/api-cookies-spec.coffee new file mode 100644 index 000000000000..b15be889f52b --- /dev/null +++ b/spec/api-cookies-spec.coffee @@ -0,0 +1,63 @@ +assert = require 'assert' +remote = require 'remote' +http = require 'http' +cookies = remote.require 'cookies' +BrowserWindow = remote.require 'browser-window' + +describe 'cookies module', -> + w = null + url = "http://127.0.0.1:9999" + beforeEach -> w = new BrowserWindow(show: true) + afterEach -> w.destroy() + + it 'should get cookies', (done) -> + server = http.createServer (req, res) -> + console.log req + res.setHeader('Set-Cookie', ['type=dummy']) + res.end('finished') + + server.listen 9999, '127.0.0.1', -> + {port} = server.address() + w.loadUrl url + w.webContents.on 'did-finish-load', ()-> + cookies.get {url:url}, (error, cookies) -> + throw error if error + assert.equal 1, cookies.length + assert.equal 'type', cookies[0].name + assert.equal 'dummy', cookies[0].value + done() + + it 'should overwrite the existent cookie', (done) -> + cookies.set {url:url, name:'type', value:'dummy2'}, (error) -> + throw error if error + cookies.get {url:url}, (error, cookies_list) -> + throw error if error + assert.equal 1, cookies_list.length + assert.equal 'type', cookies_list[0].name + assert.equal 'dummy2', cookies_list[0].value + done() + + it 'should set new cookie', (done) -> + cookies.set {url:url, name:'key', value:'dummy2'}, (error) -> + throw error if error + cookies.get {url:url}, (error, cookies_list) -> + throw error if error + assert.equal 2, cookies_list.length + for cookie in cookies_list + if cookie.name is 'key' + assert.equal 'dummy2', cookie.value + done(); + + it 'should remove cookies', (done) -> + cookies.get {url:url}, (error, cookies_list) -> + count = 0 + console.log cookies_list + for cookie in cookies_list + cookies.remove {url:url, name:cookie.name}, (error) -> + throw error if error + ++count + if count == cookies_list.length + cookies.get {url:url}, (error, cookies_list) -> + throw error if error + assert.equal 0, cookies_list.length + done() From 99bfc9b7f5333e76afabdb10573c8339b34afcd7 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Tue, 16 Jun 2015 17:23:29 +0800 Subject: [PATCH 0324/1293] Move cookies APIs to webContents.session.cookies namespace. --- atom/browser/api/atom_api_cookies.cc | 13 ---- atom/browser/api/atom_api_session.cc | 45 ++++++++++++++ atom/browser/api/atom_api_session.h | 39 ++++++++++++ atom/browser/api/atom_api_web_contents.cc | 10 +++ atom/browser/api/atom_api_web_contents.h | 4 ++ atom/browser/api/lib/cookies.coffee | 3 - atom/common/node_bindings.cc | 1 - docs/README.md | 1 - docs/api/browser-window.md | 74 +++++++++++++++++++++++ docs/api/cookies.md | 63 ------------------- filenames.gypi | 3 +- spec/api-cookies-spec.coffee | 67 +++++++++++--------- 12 files changed, 211 insertions(+), 112 deletions(-) create mode 100644 atom/browser/api/atom_api_session.cc create mode 100644 atom/browser/api/atom_api_session.h delete mode 100644 atom/browser/api/lib/cookies.coffee delete mode 100644 docs/api/cookies.md diff --git a/atom/browser/api/atom_api_cookies.cc b/atom/browser/api/atom_api_cookies.cc index a52841b5fe3f..eb31dcc3728b 100644 --- a/atom/browser/api/atom_api_cookies.cc +++ b/atom/browser/api/atom_api_cookies.cc @@ -353,16 +353,3 @@ mate::Handle Cookies::Create(v8::Isolate* isolate) { } // namespace api } // namespace atom - -namespace { - -void Initialize(v8::Local exports, v8::Local unused, - v8::Local context, void* priv) { - v8::Isolate* isolate = context->GetIsolate(); - mate::Dictionary dict(isolate, exports); - dict.Set("cookies", atom::api::Cookies::Create(isolate)); -} - -} // namespace - -NODE_MODULE_CONTEXT_AWARE_BUILTIN(atom_browser_cookies, Initialize); diff --git a/atom/browser/api/atom_api_session.cc b/atom/browser/api/atom_api_session.cc new file mode 100644 index 000000000000..316d4b8ff70a --- /dev/null +++ b/atom/browser/api/atom_api_session.cc @@ -0,0 +1,45 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#include "atom/browser/api/atom_api_session.h" + +#include "atom/browser/api/atom_api_cookies.h" +#include "native_mate/callback.h" +#include "native_mate/dictionary.h" +#include "native_mate/object_template_builder.h" + +#include "atom/common/node_includes.h" + +namespace atom { + +namespace api { + +Session::Session() { +} + +Session::~Session() { +} + +v8::Local Session::Cookies(v8::Isolate* isolate) { + if (cookies_.IsEmpty()) { + auto handle = atom::api::Cookies::Create(isolate); + cookies_.Reset(isolate, handle.ToV8()); + } + return v8::Local::New(isolate, cookies_); +} + +mate::ObjectTemplateBuilder Session::GetObjectTemplateBuilder( + v8::Isolate* isolate) { + return mate::ObjectTemplateBuilder(isolate) + .SetProperty("cookies", &Session::Cookies); +} + +// static +mate::Handle Session::Create(v8::Isolate* isolate) { + return CreateHandle(isolate, new Session); +} + +} // namespace api + +} // namespace atom diff --git a/atom/browser/api/atom_api_session.h b/atom/browser/api/atom_api_session.h new file mode 100644 index 000000000000..459d541b9510 --- /dev/null +++ b/atom/browser/api/atom_api_session.h @@ -0,0 +1,39 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#ifndef ATOM_BROWSER_API_ATOM_API_SESSION_H_ +#define ATOM_BROWSER_API_ATOM_API_SESSION_H_ + +#include "native_mate/handle.h" +#include "native_mate/wrappable.h" + +namespace atom { + +namespace api { + +class Session: public mate::Wrappable { + public: + static mate::Handle Create(v8::Isolate* isolate); + + protected: + Session(); + ~Session(); + + // mate::Wrappable implementations: + mate::ObjectTemplateBuilder GetObjectTemplateBuilder( + v8::Isolate* isolate) override; + + private: + v8::Local Cookies(v8::Isolate* isolate); + + v8::Global cookies_; + + DISALLOW_COPY_AND_ASSIGN(Session); +}; + +} // namespace api + +} // namespace atom + +#endif // ATOM_BROWSER_API_ATOM_API_SESSION_H_ diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index af00112d09a6..658387447941 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -6,6 +6,7 @@ #include +#include "atom/browser/api/atom_api_session.h" #include "atom/browser/atom_browser_client.h" #include "atom/browser/atom_browser_context.h" #include "atom/browser/atom_browser_main_parts.h" @@ -584,6 +585,14 @@ void WebContents::InspectServiceWorker() { } } +v8::Local WebContents::Session(v8::Isolate* isolate) { + if (session_.IsEmpty()) { + auto handle = Session::Create(isolate); + session_.Reset(isolate, handle.ToV8()); + } + return v8::Local::New(isolate, session_); +} + void WebContents::HasServiceWorker( const base::Callback& callback) { auto context = GetServiceWorkerContext(web_contents()); @@ -804,6 +813,7 @@ mate::ObjectTemplateBuilder WebContents::GetObjectTemplateBuilder( .SetMethod("inspectServiceWorker", &WebContents::InspectServiceWorker) .SetMethod("print", &WebContents::Print) .SetMethod("_printToPDF", &WebContents::PrintToPDF) + .SetProperty("session", &WebContents::Session) .Build()); return mate::ObjectTemplateBuilder( diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index 655087f9b0f5..c83e029c7767 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -239,6 +239,10 @@ class WebContents : public mate::EventEmitter, // Returns the default size of the guestview. gfx::Size GetDefaultSize() const; + v8::Local Session(v8::Isolate* isolate); + + v8::Global session_; + // Stores whether the contents of the guest can be transparent. bool guest_opaque_; diff --git a/atom/browser/api/lib/cookies.coffee b/atom/browser/api/lib/cookies.coffee deleted file mode 100644 index 1d9114fd2c19..000000000000 --- a/atom/browser/api/lib/cookies.coffee +++ /dev/null @@ -1,3 +0,0 @@ -bindings = process.atomBinding 'cookies' - -module.exports = bindings.cookies diff --git a/atom/common/node_bindings.cc b/atom/common/node_bindings.cc index 329683c60602..eb627d06b757 100644 --- a/atom/common/node_bindings.cc +++ b/atom/common/node_bindings.cc @@ -32,7 +32,6 @@ using content::BrowserThread; REFERENCE_MODULE(atom_browser_app); REFERENCE_MODULE(atom_browser_auto_updater); REFERENCE_MODULE(atom_browser_content_tracing); -REFERENCE_MODULE(atom_browser_cookies); REFERENCE_MODULE(atom_browser_dialog); REFERENCE_MODULE(atom_browser_menu); REFERENCE_MODULE(atom_browser_power_monitor); diff --git a/docs/README.md b/docs/README.md index c01a748d05ee..98b4219d3432 100644 --- a/docs/README.md +++ b/docs/README.md @@ -32,7 +32,6 @@ Modules for the main process: * [auto-updater](api/auto-updater.md) * [browser-window](api/browser-window.md) * [content-tracing](api/content-tracing.md) -* [cookies](api/cookies.md) * [dialog](api/dialog.md) * [global-shortcut](api/global-shortcut.md) * [ipc (main process)](api/ipc-main-process.md) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 05cddc7978a7..01298ce4dea4 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -1020,3 +1020,77 @@ app.on('ready', function() { is different from the handlers on the main process. 2. There is no way to send synchronous messages from the main process to a renderer process, because it would be very easy to cause dead locks. + +## Class: WebContents.session.cookies + +The `cookies` gives you ability to query and modify cookies, an example is: + +```javascipt +var BrowserWindow = require('browser-window'); + +var win = new BrowserWindow({ width: 800, height: 600 }); + +win.loadUrl('https://github.com'); + +win.webContents.on('did-finish-load', function() { + // Query all cookies. + win.webContents.session.cookies.get({}, function(error, cookies) { + if (error) throw error; + console.log(cookies); + }); + + // Query all cookies that are associated with a specific url. + win.webContents.session.cookies.get({ url : "http://www.github.com" }, + function(error, cookies) { + if (error) throw error; + console.log(cookies); + }); + + // Set a cookie with the given cookie data; + // may overwrite equivalent cookies if they exist. + win.webContents.session.cookies.set( + { url : "http://www.github.com", name : "dummy_name", value : "dummy"}, + function(error, cookies) { + if (error) throw error; + console.log(cookies); + }); +}); +``` + +### WebContents.session.cookies.get(details, callback) + +* `details` Object + * `url` String - Retrieves cookies which are associated with `url`. + Empty imples retrieving cookies of all urls. + * `name` String - Filters cookies by name + * `domain` String - Retrieves cookies whose domains match or are subdomains of `domains` + * `path` String - Retrieves cookies whose path matches `path` + * `secure` Boolean - Filters cookies by their Secure property + * `session` Boolean - Filters out session or persistent cookies. +* `callback` Function - function(error, cookies) + * `error` Error + * `cookies` Array - array of cookie objects. + +### WebContents.session.cookies.set(details, callback) + +* `details` Object + * `url` String - Retrieves cookies which are associated with `url` + * `name` String - The name of the cookie. Empty by default if omitted. + * `value` String - The value of the cookie. Empty by default if omitted. + * `domain` String - The domain of the cookie. Empty by default if omitted. + * `path` String - The path of the cookie. Empty by default if omitted. + * `secure` Boolean - Whether the cookie should be marked as Secure. Defaults to false. + * `session` Boolean - Whether the cookie should be marked as HttpOnly. Defaults to false. + * `expirationDate` Double - The expiration date of the cookie as the number of + seconds since the UNIX epoch. If omitted, the cookie becomes a session cookie. + +* `callback` Function - function(error) + * `error` Error + +### WebContents.session.cookies.remove(details, callback) + +* `details` Object + * `url` String - The URL associated with the cookie + * `name` String - The name of cookie to remove +* `callback` Function - function(error) + * `error` Error diff --git a/docs/api/cookies.md b/docs/api/cookies.md deleted file mode 100644 index d84e871be8d9..000000000000 --- a/docs/api/cookies.md +++ /dev/null @@ -1,63 +0,0 @@ -# cookies - -The `cookies` module gives you ability to query and modify cookies, an example -is: - -```javascipt -var cookies = require('cookies'); - -// Query all cookies. -cookies.get({}, function(error, cookies) { - if (error) throw error; - console.log(cookies); -}); - -// Query all cookies that are associated with a specific url. -cookies.get({ url : "http://www.github.com" }, function(error, cookies) { - if (error) throw error; - console.log(cookies); -}); - -// Set a cookie with the given cookie data; may overwrite equivalent cookies if they exist. -cookies.set({ url : "http://www.github.com", name : "dummy_name", value : "dummy"}, - function(error, cookies) { - if (error) throw error; - console.log(cookies); -}); -``` - -## cookies.get(details, callback) - -* `details` Object - * `url` String - Retrieves cookies which are associated with `url`. Empty imples retrieving cookies of all urls. - * `name` String - Filters cookies by name - * `domain` String - Retrieves cookies whose domains match or are subdomains of `domains` - * `path` String - Retrieves cookies whose path matches `path` - * `secure` Boolean - Filters cookies by their Secure property - * `session` Boolean - Filters out session or persistent cookies. -* `callback` Function - function(error, cookies) - * `error` Error - * `cookies` Array - array of cookie objects. - -## cookies.set(details, callback) - -* `details` Object - * `url` String - Retrieves cookies which are associated with `url` - * `name` String - The name of the cookie. Empty by default if omitted. - * `value` String - The value of the cookie. Empty by default if omitted. - * `domain` String - The domain of the cookie. Empty by default if omitted. - * `path` String - The path of the cookie. Empty by default if omitted. - * `secure` Boolean - Whether the cookie should be marked as Secure. Defaults to false. - * `session` Boolean - Whether the cookie should be marked as HttpOnly. Defaults to false. - * `expirationDate` Double - The expiration date of the cookie as the number of seconds since the UNIX epoch. If omitted, the cookie becomes a session cookie. - -* `callback` Function - function(error) - * `error` Error - -## cookies.remove(details, callback) - -* `details` Object - * `url` String - The URL associated with the cookie - * `name` String - The name of cookie to remove -* `callback` Function - function(error) - * `error` Error diff --git a/filenames.gypi b/filenames.gypi index e4da4c89398d..992b16636f77 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -13,7 +13,6 @@ 'atom/browser/api/lib/auto-updater.coffee', 'atom/browser/api/lib/browser-window.coffee', 'atom/browser/api/lib/content-tracing.coffee', - 'atom/browser/api/lib/cookies.coffee', 'atom/browser/api/lib/dialog.coffee', 'atom/browser/api/lib/global-shortcut.coffee', 'atom/browser/api/lib/ipc.coffee', @@ -87,6 +86,8 @@ 'atom/browser/api/atom_api_protocol.h', 'atom/browser/api/atom_api_screen.cc', 'atom/browser/api/atom_api_screen.h', + 'atom/browser/api/atom_api_session.cc', + 'atom/browser/api/atom_api_session.h', 'atom/browser/api/atom_api_tray.cc', 'atom/browser/api/atom_api_tray.h', 'atom/browser/api/atom_api_web_contents.cc', diff --git a/spec/api-cookies-spec.coffee b/spec/api-cookies-spec.coffee index b15be889f52b..55d10de152dd 100644 --- a/spec/api-cookies-spec.coffee +++ b/spec/api-cookies-spec.coffee @@ -1,12 +1,14 @@ assert = require 'assert' remote = require 'remote' -http = require 'http' -cookies = remote.require 'cookies' +http = require 'http' +path = require 'path' BrowserWindow = remote.require 'browser-window' describe 'cookies module', -> + fixtures = path.resolve __dirname, 'fixtures' w = null url = "http://127.0.0.1:9999" + beforeEach -> w = new BrowserWindow(show: true) afterEach -> w.destroy() @@ -20,7 +22,7 @@ describe 'cookies module', -> {port} = server.address() w.loadUrl url w.webContents.on 'did-finish-load', ()-> - cookies.get {url:url}, (error, cookies) -> + w.webContents.session.cookies.get {url:url}, (error, cookies) -> throw error if error assert.equal 1, cookies.length assert.equal 'type', cookies[0].name @@ -28,36 +30,41 @@ describe 'cookies module', -> done() it 'should overwrite the existent cookie', (done) -> - cookies.set {url:url, name:'type', value:'dummy2'}, (error) -> - throw error if error - cookies.get {url:url}, (error, cookies_list) -> + w.loadUrl 'file://' + path.join(fixtures, 'page', 'a.html') + w.webContents.on 'did-finish-load', ()-> + w.webContents.session.cookies.set {url:url, name:'type', value:'dummy2'}, (error) -> throw error if error - assert.equal 1, cookies_list.length - assert.equal 'type', cookies_list[0].name - assert.equal 'dummy2', cookies_list[0].value - done() + w.webContents.session.cookies.get {url:url}, (error, cookies_list) -> + throw error if error + assert.equal 1, cookies_list.length + assert.equal 'type', cookies_list[0].name + assert.equal 'dummy2', cookies_list[0].value + done() it 'should set new cookie', (done) -> - cookies.set {url:url, name:'key', value:'dummy2'}, (error) -> - throw error if error - cookies.get {url:url}, (error, cookies_list) -> + w.loadUrl 'file://' + path.join(fixtures, 'page', 'a.html') + w.webContents.on 'did-finish-load', ()-> + w.webContents.session.cookies.set {url:url, name:'key', value:'dummy2'}, (error) -> throw error if error - assert.equal 2, cookies_list.length - for cookie in cookies_list - if cookie.name is 'key' - assert.equal 'dummy2', cookie.value - done(); + w.webContents.session.cookies.get {url:url}, (error, cookies_list) -> + throw error if error + assert.equal 2, cookies_list.length + for cookie in cookies_list + if cookie.name is 'key' + assert.equal 'dummy2', cookie.value + done(); it 'should remove cookies', (done) -> - cookies.get {url:url}, (error, cookies_list) -> - count = 0 - console.log cookies_list - for cookie in cookies_list - cookies.remove {url:url, name:cookie.name}, (error) -> - throw error if error - ++count - if count == cookies_list.length - cookies.get {url:url}, (error, cookies_list) -> - throw error if error - assert.equal 0, cookies_list.length - done() + w.loadUrl 'file://' + path.join(fixtures, 'page', 'a.html') + w.webContents.on 'did-finish-load', ()-> + w.webContents.session.cookies.get {url:url}, (error, cookies_list) -> + count = 0 + for cookie in cookies_list + w.webContents.session.cookies.remove {url:url, name:cookie.name}, (error) -> + throw error if error + ++count + if count == cookies_list.length + w.webContents.session.cookies.get {url:url}, (error, cookies_list) -> + throw error if error + assert.equal 0, cookies_list.length + done() From 969916442f3bcaef2fec1319d21202709f42ffa8 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Thu, 18 Jun 2015 18:38:32 +0800 Subject: [PATCH 0325/1293] Use webContents BrowserContext. Also fix some code styles. --- atom/browser/api/atom_api_cookies.cc | 95 +++++++++++------------ atom/browser/api/atom_api_cookies.h | 22 ++++-- atom/browser/api/atom_api_session.cc | 11 ++- atom/browser/api/atom_api_session.h | 12 ++- atom/browser/api/atom_api_web_contents.cc | 2 +- atom/browser/api/atom_api_web_contents.h | 2 +- 6 files changed, 78 insertions(+), 66 deletions(-) diff --git a/atom/browser/api/atom_api_cookies.cc b/atom/browser/api/atom_api_cookies.cc index eb31dcc3728b..6f59cd25bbe1 100644 --- a/atom/browser/api/atom_api_cookies.cc +++ b/atom/browser/api/atom_api_cookies.cc @@ -4,11 +4,13 @@ #include "atom/browser/api/atom_api_cookies.h" -#include "atom/browser/atom_browser_context.h" +#include "atom/common/native_mate_converters/gurl_converter.h" #include "atom/common/native_mate_converters/value_converter.h" #include "base/bind.h" #include "base/time/time.h" +#include "content/public/browser/browser_context.h" #include "content/public/browser/browser_thread.h" +#include "content/public/browser/web_contents.h" #include "native_mate/callback.h" #include "native_mate/dictionary.h" #include "native_mate/object_template_builder.h" @@ -16,6 +18,7 @@ #include "net/cookies/cookie_store.h" #include "net/cookies/cookie_util.h" #include "net/url_request/url_request_context.h" +#include "net/url_request/url_request_context_getter.h" #include "atom/common/node_includes.h" @@ -42,14 +45,11 @@ bool GetCookieListFromStore(net::CookieStore* cookie_store, return true; } -void RunGetCookiesCallbackOnUIThread(const base::DictionaryValue* filter, - const std::string& error_message, const net::CookieList& cookie_list, +void RunGetCookiesCallbackOnUIThread(const std::string& error_message, + const net::CookieList& cookie_list, const atom::api::Cookies::CookiesCallback& callback) { DCHECK_CURRENTLY_ON(BrowserThread::UI); - // Should release filter here. - delete filter; - v8::Isolate* isolate = v8::Isolate::GetCurrent(); v8::Locker locker(isolate); v8::HandleScope handle_scope(isolate); @@ -60,8 +60,7 @@ void RunGetCookiesCallbackOnUIThread(const base::DictionaryValue* filter, callback.Run(error, v8::Null(isolate)); return; } - callback.Run(v8::Null(isolate), - mate::Converter::ToV8(isolate, cookie_list)); + callback.Run(v8::Null(isolate), mate::ConvertToV8(isolate, cookie_list)); } void RunRemoveCookiesCallbackOnUIThread(const std::string& error_message, @@ -82,13 +81,10 @@ void RunRemoveCookiesCallbackOnUIThread(const std::string& error_message, callback.Run(v8::Null(isolate), v8::Null(isolate)); } -void RunSetCookiesCallbackOnUIThread(const base::DictionaryValue* details, - const std::string& error_message, bool set_success, - const atom::api::Cookies::CookiesCallback& callback) { +void RunSetCookiesCallbackOnUIThread(const std::string& error_message, + bool set_success, const atom::api::Cookies::CookiesCallback& callback) { DCHECK_CURRENTLY_ON(BrowserThread::UI); - delete details; - v8::Isolate* isolate = v8::Isolate::GetCurrent(); v8::Locker locker(isolate); v8::HandleScope handle_scope(isolate); @@ -101,7 +97,7 @@ void RunSetCookiesCallbackOnUIThread(const base::DictionaryValue* details, } if (!set_success) { v8::Local error = v8::String::NewFromUtf8(isolate, - "Failed to set cookies"); + "Failed to set cookies"); callback.Run(error, v8::Null(isolate)); } @@ -109,7 +105,7 @@ void RunSetCookiesCallbackOnUIThread(const base::DictionaryValue* details, } bool MatchesDomain(const base::DictionaryValue* filter, - const std::string& cookie_domain) { + const std::string& cookie_domain) { std::string filter_domain; if (!filter->GetString("domain", &filter_domain)) return true; @@ -183,7 +179,8 @@ namespace atom { namespace api { -Cookies::Cookies() { +Cookies::Cookies(content::WebContents* web_contents): + web_contents_(web_contents) { } Cookies::~Cookies() { @@ -191,51 +188,51 @@ Cookies::~Cookies() { void Cookies::Get(const base::DictionaryValue& options, const CookiesCallback& callback) { - // The filter will be deleted manually after callback function finishes. - base::DictionaryValue* filter = options.DeepCopyWithoutEmptyChildren(); + scoped_ptr filter( + options.DeepCopyWithoutEmptyChildren()); content::BrowserThread::PostTask(BrowserThread::IO, FROM_HERE, base::Bind(&Cookies::GetCookiesOnIOThread, base::Unretained(this), - filter, callback)); + Passed(&filter), callback)); } -void Cookies::GetCookiesOnIOThread(const base::DictionaryValue* filter, +void Cookies::GetCookiesOnIOThread(scoped_ptr filter, const CookiesCallback& callback) { net::CookieStore* cookie_store = - AtomBrowserContext::Get()->url_request_context_getter() + web_contents_->GetBrowserContext()->GetRequestContext() ->GetURLRequestContext()->cookie_store(); std::string url; filter->GetString("url", &url); if (!GetCookieListFromStore(cookie_store, url, - base::Bind(&Cookies::OnGetCookies, base::Unretained(this), filter, - callback))) { + base::Bind(&Cookies::OnGetCookies, base::Unretained(this), + Passed(&filter), callback))) { BrowserThread::PostTask(BrowserThread::UI, FROM_HERE, - base::Bind(&RunGetCookiesCallbackOnUIThread, filter, "Url is not valid", - net::CookieList(), callback)); + base::Bind(&RunGetCookiesCallbackOnUIThread, "Url is not valid", + net::CookieList(), callback)); } } -void Cookies::OnGetCookies(const base::DictionaryValue* filter, +void Cookies::OnGetCookies(scoped_ptr filter, const CookiesCallback& callback, const net::CookieList& cookie_list) { net::CookieList result; for (const auto& cookie : cookie_list) { - if (MatchesCookie(filter, cookie)) + if (MatchesCookie(filter.get(), cookie)) result.push_back(cookie); } BrowserThread::PostTask(BrowserThread::UI, FROM_HERE, base::Bind( - &RunGetCookiesCallbackOnUIThread, filter, "", result, callback)); + &RunGetCookiesCallbackOnUIThread, "", result, callback)); } -void Cookies::Remove(const base::DictionaryValue& details, +void Cookies::Remove(const mate::Dictionary& details, const CookiesCallback& callback) { - std::string url, name; + GURL url; + std::string name; std::string error_message; - if (!details.GetString("url", &url) || !details.GetString("name", &name)) { + if (!details.Get("url", &url) || !details.Get("name", &name)) { error_message = "Details(url, name) of removing cookie are required."; } - GURL gurl(url); - if (error_message.empty() && !gurl.is_valid()) { + if (error_message.empty() && !url.is_valid()) { error_message = "Url is not valid."; } if (!error_message.empty()) { @@ -244,13 +241,13 @@ void Cookies::Remove(const base::DictionaryValue& details, } content::BrowserThread::PostTask(BrowserThread::IO, FROM_HERE, base::Bind(&Cookies::RemoveCookiesOnIOThread, base::Unretained(this), - gurl, name, callback)); + url, name, callback)); } void Cookies::RemoveCookiesOnIOThread(const GURL& url, const std::string& name, const CookiesCallback& callback) { net::CookieStore* cookie_store = - AtomBrowserContext::Get()->url_request_context_getter() + web_contents_->GetBrowserContext()->GetRequestContext() ->GetURLRequestContext()->cookie_store(); cookie_store->DeleteCookieAsync(url, name, base::Bind(&Cookies::OnRemoveCookies, base::Unretained(this), callback)); @@ -275,24 +272,24 @@ void Cookies::Set(const base::DictionaryValue& options, } if (!error_message.empty()) { - RunSetCookiesCallbackOnUIThread(nullptr, error_message, false, callback); - return; + RunSetCookiesCallbackOnUIThread(error_message, false, callback); + return; } - // The filter will be deleted manually after callback function finishes. - base::DictionaryValue* details = options.DeepCopyWithoutEmptyChildren(); + scoped_ptr details( + options.DeepCopyWithoutEmptyChildren()); content::BrowserThread::PostTask(BrowserThread::IO, FROM_HERE, base::Bind(&Cookies::SetCookiesOnIOThread, base::Unretained(this), - details, gurl, callback)); + Passed(&details), gurl, callback)); } -void Cookies::SetCookiesOnIOThread(const base::DictionaryValue* details, +void Cookies::SetCookiesOnIOThread(scoped_ptr details, const GURL& url, const CookiesCallback& callback) { DCHECK_CURRENTLY_ON(BrowserThread::IO); net::CookieStore* cookie_store = - AtomBrowserContext::Get()->url_request_context_getter() + web_contents_->GetBrowserContext()->GetRequestContext() ->GetURLRequestContext()->cookie_store(); std::string name, value, domain, path; @@ -325,16 +322,13 @@ void Cookies::SetCookiesOnIOThread(const base::DictionaryValue* details, http_only, false, net::COOKIE_PRIORITY_DEFAULT, - base::Bind(&Cookies::OnSetCookies, base::Unretained(this), details, - callback)); + base::Bind(&Cookies::OnSetCookies, base::Unretained(this), callback)); } -void Cookies::OnSetCookies(const base::DictionaryValue* details, - const CookiesCallback& callback, +void Cookies::OnSetCookies(const CookiesCallback& callback, bool set_success) { BrowserThread::PostTask(BrowserThread::UI, FROM_HERE, - base::Bind(&RunSetCookiesCallbackOnUIThread, details, "", set_success, - callback)); + base::Bind(&RunSetCookiesCallbackOnUIThread, "", set_success, callback)); } mate::ObjectTemplateBuilder Cookies::GetObjectTemplateBuilder( @@ -346,8 +340,9 @@ mate::ObjectTemplateBuilder Cookies::GetObjectTemplateBuilder( } // static -mate::Handle Cookies::Create(v8::Isolate* isolate) { - return CreateHandle(isolate, new Cookies); +mate::Handle Cookies::Create(v8::Isolate* isolate, + content::WebContents* web_contents) { + return CreateHandle(isolate, new Cookies(web_contents)); } } // namespace api diff --git a/atom/browser/api/atom_api_cookies.h b/atom/browser/api/atom_api_cookies.h index f4166a723981..4ed1dc8cb325 100644 --- a/atom/browser/api/atom_api_cookies.h +++ b/atom/browser/api/atom_api_cookies.h @@ -15,6 +15,10 @@ #include "net/cookies/canonical_cookie.h" +namespace content { +class WebContents; +} + namespace atom { namespace api { @@ -25,22 +29,23 @@ class Cookies : public mate::Wrappable { typedef base::Callback, v8::Local)> CookiesCallback; - static mate::Handle Create(v8::Isolate* isolate); + static mate::Handle Create(v8::Isolate* isolate, + content::WebContents* web_contents); protected: - Cookies(); + explicit Cookies(content::WebContents* web_contents); ~Cookies(); void Get(const base::DictionaryValue& options, const CookiesCallback& callback); - void Remove(const base::DictionaryValue& details, + void Remove(const mate::Dictionary& details, const CookiesCallback& callback); void Set(const base::DictionaryValue& details, const CookiesCallback& callback); - void GetCookiesOnIOThread(const base::DictionaryValue* filter, + void GetCookiesOnIOThread(scoped_ptr filter, const CookiesCallback& callback); - void OnGetCookies(const base::DictionaryValue* filter, + void OnGetCookies(scoped_ptr filter, const CookiesCallback& callback, const net::CookieList& cookie_list); @@ -49,11 +54,10 @@ class Cookies : public mate::Wrappable { const CookiesCallback& callback); void OnRemoveCookies(const CookiesCallback& callback); - void SetCookiesOnIOThread(const base::DictionaryValue* details, + void SetCookiesOnIOThread(scoped_ptr details, const GURL& url, const CookiesCallback& callback); - void OnSetCookies(const base::DictionaryValue* details, - const CookiesCallback& callback, + void OnSetCookies(const CookiesCallback& callback, bool set_success); @@ -62,6 +66,8 @@ class Cookies : public mate::Wrappable { v8::Isolate* isolate) override; private: + content::WebContents* web_contents_; + DISALLOW_COPY_AND_ASSIGN(Cookies); }; diff --git a/atom/browser/api/atom_api_session.cc b/atom/browser/api/atom_api_session.cc index 316d4b8ff70a..6fa2c28f84c6 100644 --- a/atom/browser/api/atom_api_session.cc +++ b/atom/browser/api/atom_api_session.cc @@ -5,6 +5,7 @@ #include "atom/browser/api/atom_api_session.h" #include "atom/browser/api/atom_api_cookies.h" +#include "content/public/browser/web_contents.h" #include "native_mate/callback.h" #include "native_mate/dictionary.h" #include "native_mate/object_template_builder.h" @@ -15,7 +16,8 @@ namespace atom { namespace api { -Session::Session() { +Session::Session(content::WebContents* web_contents): + web_contents_(web_contents) { } Session::~Session() { @@ -23,7 +25,7 @@ Session::~Session() { v8::Local Session::Cookies(v8::Isolate* isolate) { if (cookies_.IsEmpty()) { - auto handle = atom::api::Cookies::Create(isolate); + auto handle = atom::api::Cookies::Create(isolate, web_contents_); cookies_.Reset(isolate, handle.ToV8()); } return v8::Local::New(isolate, cookies_); @@ -36,8 +38,9 @@ mate::ObjectTemplateBuilder Session::GetObjectTemplateBuilder( } // static -mate::Handle Session::Create(v8::Isolate* isolate) { - return CreateHandle(isolate, new Session); +mate::Handle Session::Create(v8::Isolate* isolate, + content::WebContents* web_contents) { + return CreateHandle(isolate, new Session(web_contents)); } } // namespace api diff --git a/atom/browser/api/atom_api_session.h b/atom/browser/api/atom_api_session.h index 459d541b9510..35b3329ffe30 100644 --- a/atom/browser/api/atom_api_session.h +++ b/atom/browser/api/atom_api_session.h @@ -8,16 +8,21 @@ #include "native_mate/handle.h" #include "native_mate/wrappable.h" +namespace content { +class WebContents; +} + namespace atom { namespace api { class Session: public mate::Wrappable { public: - static mate::Handle Create(v8::Isolate* isolate); + static mate::Handle Create(v8::Isolate* isolate, + content::WebContents* web_contents); protected: - Session(); + explicit Session(content::WebContents* web_contents); ~Session(); // mate::Wrappable implementations: @@ -29,6 +34,9 @@ class Session: public mate::Wrappable { v8::Global cookies_; + // The webContents which owns the Sesssion. + content::WebContents* web_contents_; + DISALLOW_COPY_AND_ASSIGN(Session); }; diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 658387447941..16988d46c45b 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -587,7 +587,7 @@ void WebContents::InspectServiceWorker() { v8::Local WebContents::Session(v8::Isolate* isolate) { if (session_.IsEmpty()) { - auto handle = Session::Create(isolate); + auto handle = Session::Create(isolate, web_contents()); session_.Reset(isolate, handle.ToV8()); } return v8::Local::New(isolate, session_); diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index c83e029c7767..31f54134afac 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -89,6 +89,7 @@ class WebContents : public mate::EventEmitter, void ToggleDevTools(); void InspectElement(int x, int y); void InspectServiceWorker(); + v8::Local Session(v8::Isolate* isolate); void HasServiceWorker(const base::Callback&); void UnregisterServiceWorker(const base::Callback&); void SetAudioMuted(bool muted); @@ -239,7 +240,6 @@ class WebContents : public mate::EventEmitter, // Returns the default size of the guestview. gfx::Size GetDefaultSize() const; - v8::Local Session(v8::Isolate* isolate); v8::Global session_; From c164da5a388b54c61e221b707ca3b7186b883259 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Fri, 19 Jun 2015 14:18:22 +0800 Subject: [PATCH 0326/1293] Make cookie aligns to Chrome's. --- atom/browser/api/atom_api_cookies.cc | 2 +- docs/api/browser-window.md | 15 ++++++++++++++- 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/atom/browser/api/atom_api_cookies.cc b/atom/browser/api/atom_api_cookies.cc index 6f59cd25bbe1..4a0060efa537 100644 --- a/atom/browser/api/atom_api_cookies.cc +++ b/atom/browser/api/atom_api_cookies.cc @@ -161,8 +161,8 @@ struct Converter { mate::Dictionary dict(isolate, v8::Object::New(isolate)); dict.Set("name", val.Name()); dict.Set("value", val.Value()); - dict.Set("source", val.Source()); dict.Set("domain", val.Domain()); + dict.Set("host_only", net::cookie_util::DomainIsHostOnly(val.Domain())); dict.Set("path", val.Path()); dict.Set("secure", val.IsSecure()); dict.Set("http_only", val.IsHttpOnly()); diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 01298ce4dea4..2c41200da2bd 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -1069,7 +1069,20 @@ win.webContents.on('did-finish-load', function() { * `session` Boolean - Filters out session or persistent cookies. * `callback` Function - function(error, cookies) * `error` Error - * `cookies` Array - array of cookie objects. + * `cookies` Array - array of `cookie` objects. + * `cookie` - Object + * `name` String - The name of the cookie + * `value` String - The value of the cookie + * `domain` String - The domain of the cookie + * `host_only` String - Whether the cookie is a host-only cookie + * `path` String - The path of the cookie + * `secure` Boolean - Whether the cookie is marked as Secure (typically HTTPS) + * `http_only` Boolean - Whether the cookie is marked as HttpOnly + * `session` Boolean - Whether the cookie is a session cookie or a persistent + * cookie with an expiration date. + * `expirationDate` Double - (Option) The expiration date of the cookie as + the number of seconds since the UNIX epoch. Not provided for session cookies. + ### WebContents.session.cookies.set(details, callback) From a1cbd11b5b60eddfbab2709c21fa95daaefb675f Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 19 Jun 2015 21:53:29 +0800 Subject: [PATCH 0327/1293] Only append --register-standard-schemes when needed --- atom/browser/atom_browser_client.cc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/atom/browser/atom_browser_client.cc b/atom/browser/atom_browser_client.cc index c62bc6436ddd..a4e2734a6886 100644 --- a/atom/browser/atom_browser_client.cc +++ b/atom/browser/atom_browser_client.cc @@ -183,12 +183,12 @@ void AtomBrowserClient::AppendExtraCommandLineSwitches( base::CommandLine* command_line, int process_id) { std::string process_type = command_line->GetSwitchValueASCII("type"); - if (process_type != "renderer") return; - command_line->AppendSwitchASCII(switches::kRegisterStandardSchemes, - g_custom_schemes); + if (!g_custom_schemes.empty()) + command_line->AppendSwitchASCII(switches::kRegisterStandardSchemes, + g_custom_schemes); NativeWindow* window; WebViewManager::WebViewInfo info; From b4f90c8c81f30e4b970cb3ef6e066edef73b53f9 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 19 Jun 2015 22:01:32 +0800 Subject: [PATCH 0328/1293] Update libchromiumcontent to enable zygote process --- script/lib/config.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/script/lib/config.py b/script/lib/config.py index fd9773b5a31c..274779d44a67 100644 --- a/script/lib/config.py +++ b/script/lib/config.py @@ -7,7 +7,7 @@ import sys BASE_URL = 'http://gh-contractor-zcbenz.s3.amazonaws.com/libchromiumcontent' -LIBCHROMIUMCONTENT_COMMIT = '5ccddd5f3968a7f63eaa888e6a8ba319ea8cd3b7' +LIBCHROMIUMCONTENT_COMMIT = '3bfdfa28d2361c2242b89603b98f2509d3ebb859' PLATFORM = { 'cygwin': 'win32', From 83fe340b98cefdc441c213d8704575a29db05285 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 19 Jun 2015 22:56:10 +0800 Subject: [PATCH 0329/1293] Make process.argv work with zygote --- atom/app/atom_main_args.cc | 11 ++++++++++- atom/app/atom_main_args.h | 8 +++++++- atom/common/node_bindings.cc | 6 ++++++ 3 files changed, 23 insertions(+), 2 deletions(-) diff --git a/atom/app/atom_main_args.cc b/atom/app/atom_main_args.cc index b9ef7c43a34b..ac1c96c1bcaf 100644 --- a/atom/app/atom_main_args.cc +++ b/atom/app/atom_main_args.cc @@ -3,7 +3,9 @@ // found in the LICENSE file. #include "atom/app/atom_main_args.h" -#include "vendor/node/deps/uv/include/uv.h" + +#include "base/command_line.h" +#include "node/deps/uv/include/uv.h" namespace atom { @@ -19,4 +21,11 @@ void AtomCommandLine::Init(int argc, const char* const* argv) { } } +#if defined(OS_LINUX) +// static +void AtomCommandLine::InitializeFromCommandLine() { + argv_ = base::CommandLine::ForCurrentProcess()->argv(); +} +#endif + } // namespace atom diff --git a/atom/app/atom_main_args.h b/atom/app/atom_main_args.h index c3bc0a9823dc..5dd42713c65a 100644 --- a/atom/app/atom_main_args.h +++ b/atom/app/atom_main_args.h @@ -8,7 +8,7 @@ #include #include -#include "base/macros.h" +#include "base/basictypes.h" namespace atom { @@ -18,6 +18,12 @@ class AtomCommandLine { static void Init(int argc, const char* const* argv); static std::vector argv() { return argv_; } +#if defined(OS_LINUX) + // On Linux the command line has to be read from base::CommandLine since + // it is using zygote. + static void InitializeFromCommandLine(); +#endif + private: static std::vector argv_; diff --git a/atom/common/node_bindings.cc b/atom/common/node_bindings.cc index eb627d06b757..ff1d646c4d34 100644 --- a/atom/common/node_bindings.cc +++ b/atom/common/node_bindings.cc @@ -128,6 +128,12 @@ void NodeBindings::Initialize() { node::g_standalone_mode = is_browser_; node::g_upstream_node_mode = false; +#if defined(OS_LINUX) + // Get real command line in renderer process forked by zygote. + if (!is_browser_) + AtomCommandLine::InitializeFromCommandLine(); +#endif + // Parse the debug args. auto args = AtomCommandLine::argv(); for (const std::string& arg : args) From ef59f4f2431d9eeeed9d29c0634bcf76d3184824 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 19 Jun 2015 23:11:53 +0800 Subject: [PATCH 0330/1293] Move headers to atom/common --- atom/app/atom_library_main.mm | 2 +- atom/app/atom_main.cc | 2 +- atom/{app/atom_main_args.cc => common/atom_command_line.cc} | 2 +- atom/{app/atom_main_args.h => common/atom_command_line.h} | 6 +++--- atom/common/node_bindings.cc | 2 +- filenames.gypi | 4 ++-- 6 files changed, 9 insertions(+), 9 deletions(-) rename atom/{app/atom_main_args.cc => common/atom_command_line.cc} (94%) rename atom/{app/atom_main_args.h => common/atom_command_line.h} (85%) diff --git a/atom/app/atom_library_main.mm b/atom/app/atom_library_main.mm index 5cf910b2369a..885500beb5d3 100644 --- a/atom/app/atom_library_main.mm +++ b/atom/app/atom_library_main.mm @@ -4,9 +4,9 @@ #include "atom/app/atom_library_main.h" -#include "atom/app/atom_main_args.h" #include "atom/app/atom_main_delegate.h" #include "atom/app/node_main.h" +#include "atom/common/atom_command_line.h" #include "base/at_exit.h" #include "base/i18n/icu_util.h" #include "base/mac/bundle_locations.h" diff --git a/atom/app/atom_main.cc b/atom/app/atom_main.cc index 02dc985e30c4..47be348522f1 100644 --- a/atom/app/atom_main.cc +++ b/atom/app/atom_main.cc @@ -3,7 +3,6 @@ // found in the LICENSE file. #include "atom/app/atom_main.h" -#include "atom/app/atom_main_args.h" #include #include @@ -33,6 +32,7 @@ #endif // defined(OS_MACOSX) #include "atom/app/node_main.h" +#include "atom/common/atom_command_line.h" #include "base/i18n/icu_util.h" #if defined(OS_WIN) diff --git a/atom/app/atom_main_args.cc b/atom/common/atom_command_line.cc similarity index 94% rename from atom/app/atom_main_args.cc rename to atom/common/atom_command_line.cc index ac1c96c1bcaf..2ac62385aeac 100644 --- a/atom/app/atom_main_args.cc +++ b/atom/common/atom_command_line.cc @@ -2,7 +2,7 @@ // Use of this source code is governed by the MIT license that can be // found in the LICENSE file. -#include "atom/app/atom_main_args.h" +#include "atom/common/atom_command_line.h" #include "base/command_line.h" #include "node/deps/uv/include/uv.h" diff --git a/atom/app/atom_main_args.h b/atom/common/atom_command_line.h similarity index 85% rename from atom/app/atom_main_args.h rename to atom/common/atom_command_line.h index 5dd42713c65a..7c8840f70751 100644 --- a/atom/app/atom_main_args.h +++ b/atom/common/atom_command_line.h @@ -2,8 +2,8 @@ // Use of this source code is governed by the MIT license that can be // found in the LICENSE file. -#ifndef ATOM_APP_ATOM_MAIN_ARGS_H_ -#define ATOM_APP_ATOM_MAIN_ARGS_H_ +#ifndef ATOM_COMMON_ATOM_COMMAND_LINE_H_ +#define ATOM_COMMON_ATOM_COMMAND_LINE_H_ #include #include @@ -32,4 +32,4 @@ class AtomCommandLine { } // namespace atom -#endif // ATOM_APP_ATOM_MAIN_ARGS_H_ +#endif // ATOM_COMMON_ATOM_COMMAND_LINE_H_ diff --git a/atom/common/node_bindings.cc b/atom/common/node_bindings.cc index ff1d646c4d34..2d96d346d6f6 100644 --- a/atom/common/node_bindings.cc +++ b/atom/common/node_bindings.cc @@ -7,7 +7,7 @@ #include #include -#include "atom/app/atom_main_args.h" +#include "atom/common/atom_command_line.h" #include "atom/common/native_mate_converters/file_path_converter.h" #include "base/command_line.h" #include "base/base_paths.h" diff --git a/filenames.gypi b/filenames.gypi index 99d37b5d3093..579386a5fa2b 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -57,8 +57,6 @@ 'lib_sources': [ 'atom/app/atom_content_client.cc', 'atom/app/atom_content_client.h', - 'atom/app/atom_main_args.cc', - 'atom/app/atom_main_args.h', 'atom/app/atom_main_delegate.cc', 'atom/app/atom_main_delegate.h', 'atom/app/atom_main_delegate_mac.mm', @@ -227,6 +225,8 @@ 'atom/common/asar/asar_util.h', 'atom/common/asar/scoped_temporary_file.cc', 'atom/common/asar/scoped_temporary_file.h', + 'atom/common/atom_command_line.cc', + 'atom/common/atom_command_line.h', 'atom/common/common_message_generator.cc', 'atom/common/common_message_generator.h', 'atom/common/crash_reporter/crash_reporter.cc', From bafbee805cf49eecf87dc33070ca467cf2ec7fc0 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Sat, 20 Jun 2015 10:41:40 +0800 Subject: [PATCH 0331/1293] Fix more code styles. --- atom/browser/api/atom_api_cookies.cc | 43 ++++++++++++----------- atom/browser/api/atom_api_cookies.h | 8 ++--- atom/browser/api/atom_api_session.cc | 15 ++++---- atom/browser/api/atom_api_session.h | 8 ++--- atom/browser/api/atom_api_web_contents.cc | 2 +- 5 files changed, 39 insertions(+), 37 deletions(-) diff --git a/atom/browser/api/atom_api_cookies.cc b/atom/browser/api/atom_api_cookies.cc index 4a0060efa537..be11df8888c5 100644 --- a/atom/browser/api/atom_api_cookies.cc +++ b/atom/browser/api/atom_api_cookies.cc @@ -10,7 +10,6 @@ #include "base/time/time.h" #include "content/public/browser/browser_context.h" #include "content/public/browser/browser_thread.h" -#include "content/public/browser/web_contents.h" #include "native_mate/callback.h" #include "native_mate/dictionary.h" #include "native_mate/object_template_builder.h" @@ -22,11 +21,13 @@ #include "atom/common/node_includes.h" +using atom::api::Cookies; using content::BrowserThread; namespace { -bool GetCookieListFromStore(net::CookieStore* cookie_store, +bool GetCookieListFromStore( + net::CookieStore* cookie_store, const std::string& url, const net::CookieMonster::GetCookieListCallback& callback) { DCHECK(cookie_store); @@ -46,8 +47,8 @@ bool GetCookieListFromStore(net::CookieStore* cookie_store, } void RunGetCookiesCallbackOnUIThread(const std::string& error_message, - const net::CookieList& cookie_list, - const atom::api::Cookies::CookiesCallback& callback) { + const net::CookieList& cookie_list, + const Cookies::CookiesCallback& callback) { DCHECK_CURRENTLY_ON(BrowserThread::UI); v8::Isolate* isolate = v8::Isolate::GetCurrent(); @@ -63,8 +64,9 @@ void RunGetCookiesCallbackOnUIThread(const std::string& error_message, callback.Run(v8::Null(isolate), mate::ConvertToV8(isolate, cookie_list)); } -void RunRemoveCookiesCallbackOnUIThread(const std::string& error_message, - const atom::api::Cookies::CookiesCallback& callback) { +void RunRemoveCookiesCallbackOnUIThread( + const std::string& error_message, + const Cookies::CookiesCallback& callback) { DCHECK_CURRENTLY_ON(BrowserThread::UI); v8::Isolate* isolate = v8::Isolate::GetCurrent(); @@ -82,7 +84,8 @@ void RunRemoveCookiesCallbackOnUIThread(const std::string& error_message, } void RunSetCookiesCallbackOnUIThread(const std::string& error_message, - bool set_success, const atom::api::Cookies::CookiesCallback& callback) { + bool set_success, + const Cookies::CookiesCallback& callback) { DCHECK_CURRENTLY_ON(BrowserThread::UI); v8::Isolate* isolate = v8::Isolate::GetCurrent(); @@ -132,7 +135,7 @@ bool MatchesDomain(const base::DictionaryValue* filter, } bool MatchesCookie(const base::DictionaryValue* filter, - const net::CanonicalCookie& cookie) { + const net::CanonicalCookie& cookie) { std::string name, domain, path; bool is_secure, session; if (filter->GetString("name", &name) && name != cookie.Name()) @@ -157,7 +160,7 @@ namespace mate { template<> struct Converter { static v8::Local ToV8(v8::Isolate* isolate, - const net::CanonicalCookie& val) { + const net::CanonicalCookie& val) { mate::Dictionary dict(isolate, v8::Object::New(isolate)); dict.Set("name", val.Name()); dict.Set("value", val.Value()); @@ -179,8 +182,8 @@ namespace atom { namespace api { -Cookies::Cookies(content::WebContents* web_contents): - web_contents_(web_contents) { +Cookies::Cookies(content::BrowserContext* browser_context) : + browser_context_(browser_context) { } Cookies::~Cookies() { @@ -198,8 +201,7 @@ void Cookies::Get(const base::DictionaryValue& options, void Cookies::GetCookiesOnIOThread(scoped_ptr filter, const CookiesCallback& callback) { - net::CookieStore* cookie_store = - web_contents_->GetBrowserContext()->GetRequestContext() + net::CookieStore* cookie_store = browser_context_->GetRequestContext() ->GetURLRequestContext()->cookie_store(); std::string url; filter->GetString("url", &url); @@ -245,9 +247,8 @@ void Cookies::Remove(const mate::Dictionary& details, } void Cookies::RemoveCookiesOnIOThread(const GURL& url, const std::string& name, - const CookiesCallback& callback) { - net::CookieStore* cookie_store = - web_contents_->GetBrowserContext()->GetRequestContext() + const CookiesCallback& callback) { + net::CookieStore* cookie_store = browser_context_->GetRequestContext() ->GetURLRequestContext()->cookie_store(); cookie_store->DeleteCookieAsync(url, name, base::Bind(&Cookies::OnRemoveCookies, base::Unretained(this), callback)); @@ -288,8 +289,7 @@ void Cookies::SetCookiesOnIOThread(scoped_ptr details, const GURL& url, const CookiesCallback& callback) { DCHECK_CURRENTLY_ON(BrowserThread::IO); - net::CookieStore* cookie_store = - web_contents_->GetBrowserContext()->GetRequestContext() + net::CookieStore* cookie_store = browser_context_->GetRequestContext() ->GetURLRequestContext()->cookie_store(); std::string name, value, domain, path; @@ -340,9 +340,10 @@ mate::ObjectTemplateBuilder Cookies::GetObjectTemplateBuilder( } // static -mate::Handle Cookies::Create(v8::Isolate* isolate, - content::WebContents* web_contents) { - return CreateHandle(isolate, new Cookies(web_contents)); +mate::Handle Cookies::Create( + v8::Isolate* isolate, + content::BrowserContext* browser_context) { + return CreateHandle(isolate, new Cookies(browser_context)); } } // namespace api diff --git a/atom/browser/api/atom_api_cookies.h b/atom/browser/api/atom_api_cookies.h index 4ed1dc8cb325..61357f05d75d 100644 --- a/atom/browser/api/atom_api_cookies.h +++ b/atom/browser/api/atom_api_cookies.h @@ -16,7 +16,7 @@ #include "net/cookies/canonical_cookie.h" namespace content { -class WebContents; +class BrowserContext; } namespace atom { @@ -30,10 +30,10 @@ class Cookies : public mate::Wrappable { CookiesCallback; static mate::Handle Create(v8::Isolate* isolate, - content::WebContents* web_contents); + content::BrowserContext* browser_context); protected: - explicit Cookies(content::WebContents* web_contents); + explicit Cookies(content::BrowserContext* browser_context); ~Cookies(); void Get(const base::DictionaryValue& options, @@ -66,7 +66,7 @@ class Cookies : public mate::Wrappable { v8::Isolate* isolate) override; private: - content::WebContents* web_contents_; + content::BrowserContext* browser_context_; DISALLOW_COPY_AND_ASSIGN(Cookies); }; diff --git a/atom/browser/api/atom_api_session.cc b/atom/browser/api/atom_api_session.cc index 6fa2c28f84c6..744accd7d1cd 100644 --- a/atom/browser/api/atom_api_session.cc +++ b/atom/browser/api/atom_api_session.cc @@ -5,7 +5,7 @@ #include "atom/browser/api/atom_api_session.h" #include "atom/browser/api/atom_api_cookies.h" -#include "content/public/browser/web_contents.h" +#include "content/public/browser/browser_context.h" #include "native_mate/callback.h" #include "native_mate/dictionary.h" #include "native_mate/object_template_builder.h" @@ -16,8 +16,8 @@ namespace atom { namespace api { -Session::Session(content::WebContents* web_contents): - web_contents_(web_contents) { +Session::Session(content::BrowserContext* browser_context): + browser_context_(browser_context) { } Session::~Session() { @@ -25,7 +25,7 @@ Session::~Session() { v8::Local Session::Cookies(v8::Isolate* isolate) { if (cookies_.IsEmpty()) { - auto handle = atom::api::Cookies::Create(isolate, web_contents_); + auto handle = atom::api::Cookies::Create(isolate, browser_context_); cookies_.Reset(isolate, handle.ToV8()); } return v8::Local::New(isolate, cookies_); @@ -38,9 +38,10 @@ mate::ObjectTemplateBuilder Session::GetObjectTemplateBuilder( } // static -mate::Handle Session::Create(v8::Isolate* isolate, - content::WebContents* web_contents) { - return CreateHandle(isolate, new Session(web_contents)); +mate::Handle Session::Create( + v8::Isolate* isolate, + content::BrowserContext* browser_context) { + return CreateHandle(isolate, new Session(browser_context)); } } // namespace api diff --git a/atom/browser/api/atom_api_session.h b/atom/browser/api/atom_api_session.h index 35b3329ffe30..4bdab0757709 100644 --- a/atom/browser/api/atom_api_session.h +++ b/atom/browser/api/atom_api_session.h @@ -9,7 +9,7 @@ #include "native_mate/wrappable.h" namespace content { -class WebContents; +class BrowserContext; } namespace atom { @@ -19,10 +19,10 @@ namespace api { class Session: public mate::Wrappable { public: static mate::Handle Create(v8::Isolate* isolate, - content::WebContents* web_contents); + content::BrowserContext* browser_context); protected: - explicit Session(content::WebContents* web_contents); + explicit Session(content::BrowserContext* browser_context); ~Session(); // mate::Wrappable implementations: @@ -35,7 +35,7 @@ class Session: public mate::Wrappable { v8::Global cookies_; // The webContents which owns the Sesssion. - content::WebContents* web_contents_; + content::BrowserContext* browser_context_; DISALLOW_COPY_AND_ASSIGN(Session); }; diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 16988d46c45b..8b26b724fa06 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -587,7 +587,7 @@ void WebContents::InspectServiceWorker() { v8::Local WebContents::Session(v8::Isolate* isolate) { if (session_.IsEmpty()) { - auto handle = Session::Create(isolate, web_contents()); + auto handle = Session::Create(isolate, web_contents()->GetBrowserContext()); session_.Reset(isolate, handle.ToV8()); } return v8::Local::New(isolate, session_); From db23d1165cfc14f29f0b7866fe9dfbe3c1fd6335 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Sat, 20 Jun 2015 10:42:18 +0800 Subject: [PATCH 0332/1293] Update cookies spec. --- spec/api-cookies-spec.coffee | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/spec/api-cookies-spec.coffee b/spec/api-cookies-spec.coffee index 55d10de152dd..c526a1cc7489 100644 --- a/spec/api-cookies-spec.coffee +++ b/spec/api-cookies-spec.coffee @@ -7,7 +7,7 @@ BrowserWindow = remote.require 'browser-window' describe 'cookies module', -> fixtures = path.resolve __dirname, 'fixtures' w = null - url = "http://127.0.0.1:9999" + url = "http://127.0.0.1" beforeEach -> w = new BrowserWindow(show: true) afterEach -> w.destroy() @@ -17,12 +17,14 @@ describe 'cookies module', -> console.log req res.setHeader('Set-Cookie', ['type=dummy']) res.end('finished') + server.close() - server.listen 9999, '127.0.0.1', -> + port = remote.process.port + server.listen port, '127.0.0.1', -> {port} = server.address() - w.loadUrl url + w.loadUrl "#{url}:#{port}" w.webContents.on 'did-finish-load', ()-> - w.webContents.session.cookies.get {url:url}, (error, cookies) -> + w.webContents.session.cookies.get {url: url}, (error, cookies) -> throw error if error assert.equal 1, cookies.length assert.equal 'type', cookies[0].name @@ -32,9 +34,9 @@ describe 'cookies module', -> it 'should overwrite the existent cookie', (done) -> w.loadUrl 'file://' + path.join(fixtures, 'page', 'a.html') w.webContents.on 'did-finish-load', ()-> - w.webContents.session.cookies.set {url:url, name:'type', value:'dummy2'}, (error) -> + w.webContents.session.cookies.set {url: url, name: 'type', value: 'dummy2'}, (error) -> throw error if error - w.webContents.session.cookies.get {url:url}, (error, cookies_list) -> + w.webContents.session.cookies.get {url: url}, (error, cookies_list) -> throw error if error assert.equal 1, cookies_list.length assert.equal 'type', cookies_list[0].name @@ -44,9 +46,9 @@ describe 'cookies module', -> it 'should set new cookie', (done) -> w.loadUrl 'file://' + path.join(fixtures, 'page', 'a.html') w.webContents.on 'did-finish-load', ()-> - w.webContents.session.cookies.set {url:url, name:'key', value:'dummy2'}, (error) -> + w.webContents.session.cookies.set {url: url, name: 'key', value: 'dummy2'}, (error) -> throw error if error - w.webContents.session.cookies.get {url:url}, (error, cookies_list) -> + w.webContents.session.cookies.get {url: url}, (error, cookies_list) -> throw error if error assert.equal 2, cookies_list.length for cookie in cookies_list @@ -57,14 +59,14 @@ describe 'cookies module', -> it 'should remove cookies', (done) -> w.loadUrl 'file://' + path.join(fixtures, 'page', 'a.html') w.webContents.on 'did-finish-load', ()-> - w.webContents.session.cookies.get {url:url}, (error, cookies_list) -> + w.webContents.session.cookies.get {url: url}, (error, cookies_list) -> count = 0 for cookie in cookies_list - w.webContents.session.cookies.remove {url:url, name:cookie.name}, (error) -> + w.webContents.session.cookies.remove {url: url, name: cookie.name}, (error) -> throw error if error ++count if count == cookies_list.length - w.webContents.session.cookies.get {url:url}, (error, cookies_list) -> + w.webContents.session.cookies.get {url: url}, (error, cookies_list) -> throw error if error assert.equal 0, cookies_list.length done() From d50db378d7069231902421b13266d2fdc575c859 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Sat, 20 Jun 2015 15:18:21 +0800 Subject: [PATCH 0333/1293] Add usage sample code of printToPDF API. --- docs/api/browser-window.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 05cddc7978a7..903abce4062b 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -976,10 +976,29 @@ size. Prints windows' web page as PDF with Chromium's preview printing custom settings. -By default, the options will be +By default, an empty `options` will be regarded as `{marginsType:0, printBackgrounds:false, printSelectionOnly:false, landscape:false}`. +```javascript +var BrowserWindow = require('browser-window'); +var fs = require('fs'); + +var win = new BrowserWindow({width: 800, height: 600}); +win.loadUrl("http://github.com"); + +win.webContents.on("did-finish-load", function() { + // Use default printing options + win.webContents.printToPDF({}, function(error, data) { + if (error) throw error; + fs.writeFile(dist, data, function(error) { + if (err) + alert('write pdf file error', error); + }) + }) +}); +``` + ### WebContents.send(channel[, args...]) * `channel` String From f73e1f91880b959281b49e1bbd228522aa03df41 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Sun, 21 Jun 2015 10:56:40 +0800 Subject: [PATCH 0334/1293] :memo: Add missing BrowserWindow.isDevToolsOpened method. --- docs/api/browser-window.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 05cddc7978a7..de37f8f01b2b 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -517,6 +517,10 @@ Opens the developer tools. Closes the developer tools. +### BrowserWindow.isDevToolsOpened() + +Returns whether the developer tools are opened. + ### BrowserWindow.toggleDevTools() Toggle the developer tools. From 7c5afdd3881130a68f4f0e33156d007a1e38bffb Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Sun, 21 Jun 2015 20:57:42 +0800 Subject: [PATCH 0335/1293] Add PowerSaveBlocker APIs. --- .../api/atom_api_power_save_blocker.cc | 94 +++++++++++++++++++ .../browser/api/atom_api_power_save_blocker.h | 46 +++++++++ .../browser/api/lib/power-save-blocker.coffee | 8 ++ atom/common/node_bindings.cc | 1 + filenames.gypi | 3 + 5 files changed, 152 insertions(+) create mode 100644 atom/browser/api/atom_api_power_save_blocker.cc create mode 100644 atom/browser/api/atom_api_power_save_blocker.h create mode 100644 atom/browser/api/lib/power-save-blocker.coffee diff --git a/atom/browser/api/atom_api_power_save_blocker.cc b/atom/browser/api/atom_api_power_save_blocker.cc new file mode 100644 index 000000000000..98a84d0001a5 --- /dev/null +++ b/atom/browser/api/atom_api_power_save_blocker.cc @@ -0,0 +1,94 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#include "atom/browser/api/atom_api_power_save_blocker.h" + +#include "content/public/browser/power_save_blocker.h" +#include "native_mate/constructor.h" +#include "native_mate/dictionary.h" + +#include "atom/common/node_includes.h" + +namespace mate { + +template<> +struct Converter { + static bool FromV8(v8::Isolate* isolate, + v8::Local val, + content::PowerSaveBlocker::PowerSaveBlockerType* out) { + using content::PowerSaveBlocker; + int type; + if (!ConvertFromV8(isolate, val, &type)) + return false; + switch (static_cast(type)) { + case PowerSaveBlocker::kPowerSaveBlockPreventAppSuspension: + *out = PowerSaveBlocker::kPowerSaveBlockPreventAppSuspension; + break; + case PowerSaveBlocker::kPowerSaveBlockPreventDisplaySleep: + *out = PowerSaveBlocker::kPowerSaveBlockPreventDisplaySleep; + break; + default: + return false; + } + return true; + } +}; + +} // namespace mate + +namespace atom { + +namespace api { + +PowerSaveBlocker::PowerSaveBlocker() { +} + +PowerSaveBlocker::~PowerSaveBlocker() { +} + +void PowerSaveBlocker::Start( + content::PowerSaveBlocker::PowerSaveBlockerType type) { + power_save_blocker_ = content::PowerSaveBlocker::Create( + type, + content::PowerSaveBlocker::kReasonOther, + "Users required"); +} + +void PowerSaveBlocker::Stop() { + power_save_blocker_.reset(); +} + +bool PowerSaveBlocker::IsStarted() { + return power_save_blocker_.get() != NULL; +} + +mate::ObjectTemplateBuilder PowerSaveBlocker::GetObjectTemplateBuilder( + v8::Isolate* isolate) { + return mate::ObjectTemplateBuilder(isolate) + .SetMethod("start", &PowerSaveBlocker::Start) + .SetMethod("stop", &PowerSaveBlocker::Stop); + .SetMethod("isStarted", &PowerSaveBlocker::IsStarted) +} + +// static +mate::Handle PowerSaveBlocker::Create(v8::Isolate* isolate) { + return CreateHandle(isolate, new PowerSaveBlocker); +} + +} // namespace api + +} // namespace atom + +namespace { + +void Initialize(v8::Local exports, v8::Local unused, + v8::Local context, void* priv) { + v8::Isolate* isolate = context->GetIsolate(); + mate::Dictionary dict(isolate, exports); + dict.Set("powerSaveBlocker", atom::api::PowerSaveBlocker::Create(isolate)); +} + +} // namespace + +NODE_MODULE_CONTEXT_AWARE_BUILTIN(atom_browser_power_save_blocker, Initialize); diff --git a/atom/browser/api/atom_api_power_save_blocker.h b/atom/browser/api/atom_api_power_save_blocker.h new file mode 100644 index 000000000000..03338422de1e --- /dev/null +++ b/atom/browser/api/atom_api_power_save_blocker.h @@ -0,0 +1,46 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#ifndef ATOM_BROWSER_API_ATOM_API_POWER_SAVE_BLOCKER_H_ +#define ATOM_BROWSER_API_ATOM_API_POWER_SAVE_BLOCKER_H_ + +#include "base/memory/scoped_ptr.h" +#include "content/public/browser/power_save_blocker.h" +#include "native_mate/handle.h" +#include "native_mate/wrappable.h" + +namespace mate { +class Dictionary; +} + +namespace atom { + +namespace api { + +class PowerSaveBlocker : public mate::Wrappable { + public: + static mate::Handle Create(v8::Isolate* isolate); + + protected: + PowerSaveBlocker(); + virtual ~PowerSaveBlocker(); + + // mate::Wrappable implementations: + mate::ObjectTemplateBuilder GetObjectTemplateBuilder( + v8::Isolate* isolate) override; + + private: + void Start(content::PowerSaveBlocker::PowerSaveBlockerType type); + void Stop(); + bool IsStarted(); + + scoped_ptr power_save_blocker_; + DISALLOW_COPY_AND_ASSIGN(PowerSaveBlocker); +}; + +} // namespace api + +} // namespace atom + +#endif // ATOM_BROWSER_API_ATOM_API_POWER_SAVE_BLOCKER_H_ diff --git a/atom/browser/api/lib/power-save-blocker.coffee b/atom/browser/api/lib/power-save-blocker.coffee new file mode 100644 index 000000000000..6ac8b9b01905 --- /dev/null +++ b/atom/browser/api/lib/power-save-blocker.coffee @@ -0,0 +1,8 @@ +bindings = process.atomBinding 'power_save_blocker' + +powerSaveBlocker = bindings.powerSaveBlocker + +powerSaveBlocker.PREVENT_APP_SUSPENSION = 0 +powerSaveBlocker.PREVENT_DISPLAY_SLEEP = 1 + +module.exports = powerSaveBlocker diff --git a/atom/common/node_bindings.cc b/atom/common/node_bindings.cc index eb627d06b757..8e3db80125d6 100644 --- a/atom/common/node_bindings.cc +++ b/atom/common/node_bindings.cc @@ -35,6 +35,7 @@ REFERENCE_MODULE(atom_browser_content_tracing); REFERENCE_MODULE(atom_browser_dialog); REFERENCE_MODULE(atom_browser_menu); REFERENCE_MODULE(atom_browser_power_monitor); +REFERENCE_MODULE(atom_browser_power_save_blocker); REFERENCE_MODULE(atom_browser_protocol); REFERENCE_MODULE(atom_browser_global_shortcut); REFERENCE_MODULE(atom_browser_tray); diff --git a/filenames.gypi b/filenames.gypi index 99d37b5d3093..0c16a62ce107 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -20,6 +20,7 @@ 'atom/browser/api/lib/menu-item.coffee', 'atom/browser/api/lib/navigation-controller.coffee', 'atom/browser/api/lib/power-monitor.coffee', + 'atom/browser/api/lib/power-save-blocker.coffee', 'atom/browser/api/lib/protocol.coffee', 'atom/browser/api/lib/screen.coffee', 'atom/browser/api/lib/tray.coffee', @@ -80,6 +81,8 @@ 'atom/browser/api/atom_api_menu_mac.mm', 'atom/browser/api/atom_api_power_monitor.cc', 'atom/browser/api/atom_api_power_monitor.h', + 'atom/browser/api/atom_api_power_save_blocker.cc', + 'atom/browser/api/atom_api_power_save_blocker.h', 'atom/browser/api/atom_api_protocol.cc', 'atom/browser/api/atom_api_protocol.h', 'atom/browser/api/atom_api_screen.cc', From 7ee2a703d98ed1a38d3f4f3f1928968c8be1bfd8 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Sun, 21 Jun 2015 21:14:49 +0800 Subject: [PATCH 0336/1293] :memo: Add powerSaveBlocker APIs doc. --- docs/api/power-save-blocker.md | 37 ++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 docs/api/power-save-blocker.md diff --git a/docs/api/power-save-blocker.md b/docs/api/power-save-blocker.md new file mode 100644 index 000000000000..3dfb024aa23c --- /dev/null +++ b/docs/api/power-save-blocker.md @@ -0,0 +1,37 @@ +# power-save-blocker + +The `power-save-blocker` module is used to block the system from entering +low-power(sleep) mode. + +An example is: + +```javascript +var powerSaveBlocker = require('power-save-blocker'); + +powerSaveBlocker.start(powerSaveBlocker.PREVENT_DISPLAY_SLEEP); +console.log(powerSaveBlocker.IsStarted()); +``` + +## powerSaveBlocker.start(type) + +* type - Power save blocker type + * powerSaveBlocker.PREVENT_APP_SUSPENSION - Prevent the application from being + suspended. On some platforms, apps may be suspended when they are not visible + to the user. This type of block requests that the app continue to run in that + case,and on all platforms prevents the system from sleeping. + Example use cases: downloading a file, playing audio. + * powerSaveBlocker.PREVENT_DISPLAY_SLEEP - Prevent the display from going to sleep. + This also has the side effect of preventing the system from sleeping, but + does not necessarily prevent the app from being suspended on some platforms + if the user hides it. + Example use case: playing video. + +Starts the power save blocker preventing the system entering lower-power mode. + +## powerSaveBlocker.isStarted() + +Returns whether the `powerSaveBlocker` starts. + +## powerSaveBlocker.stop() + +Stops blocking the system from entering low-power mode. From 532f75fcab841de6f2fbaddd3491fcffdf5fd204 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Mon, 22 Jun 2015 10:23:58 +0800 Subject: [PATCH 0337/1293] Update PowerSaveBlocker APIs design. --- .../api/atom_api_power_save_blocker.cc | 64 +++++++++++++++---- .../browser/api/atom_api_power_save_blocker.h | 19 +++++- docs/api/power-save-blocker.md | 40 ++++++++---- 3 files changed, 95 insertions(+), 28 deletions(-) diff --git a/atom/browser/api/atom_api_power_save_blocker.cc b/atom/browser/api/atom_api_power_save_blocker.cc index 98a84d0001a5..0e09d9b8c2bd 100644 --- a/atom/browser/api/atom_api_power_save_blocker.cc +++ b/atom/browser/api/atom_api_power_save_blocker.cc @@ -10,6 +10,12 @@ #include "atom/common/node_includes.h" +namespace { + +const char kPowerSaveBlockerDescription[] = "Electron"; + +} // namespace + namespace mate { template<> @@ -47,28 +53,64 @@ PowerSaveBlocker::PowerSaveBlocker() { PowerSaveBlocker::~PowerSaveBlocker() { } -void PowerSaveBlocker::Start( +void PowerSaveBlocker::UpdatePowerSaveBlocker() { + if (power_save_blocker_types_.empty()) { + power_save_blocker_.reset(); + return; + } + + // |kPowerSaveBlockPreventAppSuspension| keeps system active, but allows + // screen to be turned off. + // |kPowerSaveBlockPreventDisplaySleep| keeps system and screen active, has a + // higher precedence level than |kPowerSaveBlockPreventAppSuspension|. + // + // Only the highest-precedence blocker type takes effect. + content::PowerSaveBlocker::PowerSaveBlockerType new_blocker_type = + content::PowerSaveBlocker::kPowerSaveBlockPreventAppSuspension; + for (const auto& element : power_save_blocker_types_) { + if (element.second == + content::PowerSaveBlocker::kPowerSaveBlockPreventDisplaySleep) { + new_blocker_type = + content::PowerSaveBlocker::kPowerSaveBlockPreventDisplaySleep; + break; + } + } + + if (!power_save_blocker_ || new_blocker_type != current_blocker_type_) { + scoped_ptr new_blocker = + content::PowerSaveBlocker::Create( + new_blocker_type, + content::PowerSaveBlocker::kReasonOther, + kPowerSaveBlockerDescription); + power_save_blocker_.swap(new_blocker); + current_blocker_type_ = new_blocker_type; + } +} + +int PowerSaveBlocker::Start( content::PowerSaveBlocker::PowerSaveBlockerType type) { - power_save_blocker_ = content::PowerSaveBlocker::Create( - type, - content::PowerSaveBlocker::kReasonOther, - "Users required"); + static int count = 0; + power_save_blocker_types_[count] = type; + UpdatePowerSaveBlocker(); + return count++; } -void PowerSaveBlocker::Stop() { - power_save_blocker_.reset(); +bool PowerSaveBlocker::Stop(int id) { + bool success = power_save_blocker_types_.erase(id) > 0; + UpdatePowerSaveBlocker(); + return success; } -bool PowerSaveBlocker::IsStarted() { - return power_save_blocker_.get() != NULL; +bool PowerSaveBlocker::IsStarted(int id) { + return power_save_blocker_types_.find(id) != power_save_blocker_types_.end(); } mate::ObjectTemplateBuilder PowerSaveBlocker::GetObjectTemplateBuilder( v8::Isolate* isolate) { return mate::ObjectTemplateBuilder(isolate) .SetMethod("start", &PowerSaveBlocker::Start) - .SetMethod("stop", &PowerSaveBlocker::Stop); - .SetMethod("isStarted", &PowerSaveBlocker::IsStarted) + .SetMethod("stop", &PowerSaveBlocker::Stop) + .SetMethod("isStarted", &PowerSaveBlocker::IsStarted); } // static diff --git a/atom/browser/api/atom_api_power_save_blocker.h b/atom/browser/api/atom_api_power_save_blocker.h index 03338422de1e..fdfb2d9cdec8 100644 --- a/atom/browser/api/atom_api_power_save_blocker.h +++ b/atom/browser/api/atom_api_power_save_blocker.h @@ -5,6 +5,8 @@ #ifndef ATOM_BROWSER_API_ATOM_API_POWER_SAVE_BLOCKER_H_ #define ATOM_BROWSER_API_ATOM_API_POWER_SAVE_BLOCKER_H_ +#include + #include "base/memory/scoped_ptr.h" #include "content/public/browser/power_save_blocker.h" #include "native_mate/handle.h" @@ -31,11 +33,22 @@ class PowerSaveBlocker : public mate::Wrappable { v8::Isolate* isolate) override; private: - void Start(content::PowerSaveBlocker::PowerSaveBlockerType type); - void Stop(); - bool IsStarted(); + void UpdatePowerSaveBlocker(); + int Start(content::PowerSaveBlocker::PowerSaveBlockerType type); + bool Stop(int id); + bool IsStarted(int id); scoped_ptr power_save_blocker_; + + // Currnet blocker type used by |power_save_blocker_| + content::PowerSaveBlocker::PowerSaveBlockerType current_blocker_type_; + + // Map from id to the corresponding blocker type for each request. + typedef std::map + PowerSaveBlockerTypeMap; + PowerSaveBlockerTypeMap power_save_blocker_types_; + + DISALLOW_COPY_AND_ASSIGN(PowerSaveBlocker); }; diff --git a/docs/api/power-save-blocker.md b/docs/api/power-save-blocker.md index 3dfb024aa23c..e4de5a17d310 100644 --- a/docs/api/power-save-blocker.md +++ b/docs/api/power-save-blocker.md @@ -1,37 +1,49 @@ # power-save-blocker The `power-save-blocker` module is used to block the system from entering -low-power(sleep) mode. +low-power(sleep) mode, allowing app to keep system and screen active. An example is: ```javascript var powerSaveBlocker = require('power-save-blocker'); -powerSaveBlocker.start(powerSaveBlocker.PREVENT_DISPLAY_SLEEP); -console.log(powerSaveBlocker.IsStarted()); +var id = powerSaveBlocker.start(powerSaveBlocker.PREVENT_DISPLAY_SLEEP); +console.log(powerSaveBlocker.isStarted(id)); + +powerSaveBlocker.stop(id); ``` ## powerSaveBlocker.start(type) -* type - Power save blocker type +* `type` - Power save blocker type * powerSaveBlocker.PREVENT_APP_SUSPENSION - Prevent the application from being - suspended. On some platforms, apps may be suspended when they are not visible - to the user. This type of block requests that the app continue to run in that - case,and on all platforms prevents the system from sleeping. + suspended. Keeps system active, but allows screen to be turned off. Example use cases: downloading a file, playing audio. * powerSaveBlocker.PREVENT_DISPLAY_SLEEP - Prevent the display from going to sleep. - This also has the side effect of preventing the system from sleeping, but - does not necessarily prevent the app from being suspended on some platforms - if the user hides it. + Keeps system and screen active. Example use case: playing video. Starts the power save blocker preventing the system entering lower-power mode. +Returns an integer identified the power save blocker. -## powerSaveBlocker.isStarted() +**Note:** +`PREVENT_DISPLAY_SLEEP` has higher precedence level than `PREVENT_APP_SUSPENSION`. +Only the highest precedence type takes effect. In other words, `PREVENT_DISPLAY_SLEEP` +always take precedence over `PREVENT_APP_SUSPENSION`. -Returns whether the `powerSaveBlocker` starts. +For example, an API calling A requests for `PREVENT_APP_SUSPENSION`, and +another calling B requests for `PREVENT_DISPLAY_SLEEP`. `PREVENT_DISPLAY_SLEEP` +will be used until B stops its request. After that, `PREVENT_APP_SUSPENSION` is used. -## powerSaveBlocker.stop() +## powerSaveBlocker.stop(id) -Stops blocking the system from entering low-power mode. +* `id` Integer - The power save blocker id returned by `powerSaveBlocker.start`. + +Stops the specified power save blocker. + +## powerSaveBlocker.isStarted(id) + +* `id` Integer - The power save blocker id returned by `powerSaveBlocker.start`. + +Returns whether the corresponding `powerSaveBlocker` starts. From 30dfd54575adb2ba3ae9b5dae12220b0fec0914f Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Mon, 22 Jun 2015 14:06:06 +0900 Subject: [PATCH 0338/1293] First translation Translate docs to korean --- README-ko.md | 43 ++ docs/README-ko.md | 69 +++ docs/api/accelerator-ko.md | 46 ++ docs/api/menu-item-ko.md | 20 + docs/api/power-monitor-ko.md | 33 ++ docs/api/tray-ko.md | 139 +++++ docs/api/web-view-tag-ko.md | 479 ++++++++++++++++++ docs/development/coding-style-ko.md | 23 + docs/tutorial/application-distribution-ko.md | 138 +++++ docs/tutorial/application-packaging-ko.md | 153 ++++++ docs/tutorial/debugging-main-process-ko.md | 45 ++ .../desktop-environment-integration-ko.md | 201 ++++++++ docs/tutorial/devtools-extension-ko.md | 46 ++ docs/tutorial/online-offline-events-ko.md | 80 +++ docs/tutorial/quick-start-ko.md | 145 ++++++ docs/tutorial/using-native-node-modules-ko.md | 56 ++ docs/tutorial/using-pepper-flash-plugin-ko.md | 59 +++ .../using-selenium-and-webdriver-ko.md | 74 +++ 18 files changed, 1849 insertions(+) create mode 100644 README-ko.md create mode 100644 docs/README-ko.md create mode 100644 docs/api/accelerator-ko.md create mode 100644 docs/api/menu-item-ko.md create mode 100644 docs/api/power-monitor-ko.md create mode 100644 docs/api/tray-ko.md create mode 100644 docs/api/web-view-tag-ko.md create mode 100644 docs/development/coding-style-ko.md create mode 100644 docs/tutorial/application-distribution-ko.md create mode 100644 docs/tutorial/application-packaging-ko.md create mode 100644 docs/tutorial/debugging-main-process-ko.md create mode 100644 docs/tutorial/desktop-environment-integration-ko.md create mode 100644 docs/tutorial/devtools-extension-ko.md create mode 100644 docs/tutorial/online-offline-events-ko.md create mode 100644 docs/tutorial/quick-start-ko.md create mode 100644 docs/tutorial/using-native-node-modules-ko.md create mode 100644 docs/tutorial/using-pepper-flash-plugin-ko.md create mode 100644 docs/tutorial/using-selenium-and-webdriver-ko.md diff --git a/README-ko.md b/README-ko.md new file mode 100644 index 000000000000..cc862a3e89e7 --- /dev/null +++ b/README-ko.md @@ -0,0 +1,43 @@ +[![Electron Logo](http://electron.atom.io/images/electron-logo.svg)](http://electron.atom.io/) + +[![Build Status](https://travis-ci.org/atom/electron.svg?branch=master)](https://travis-ci.org/atom/electron) +[![devDependency Status](https://david-dm.org/atom/electron/dev-status.svg)](https://david-dm.org/atom/electron#info=devDependencies) + +### [Electron](https://github.com/atom/electron/) 한국어 참조문서 + +:zap: *이전까지 Atom Shell로 알려져 있었습니다* :zap: + + +Electron은 JavaScript, HTML 그리고 CSS를 이용하여 Cross-Platform 데스크톱 어플리케이션을 개발할 수 있도록 해주는 프레임워크입니다. 이 프레임워크는 [io.js](http://iojs.org) 와 +[Chromium](http://www.chromium.org) 을 기반으로 만들어 졌으며 [Atom Editor](https://github.com/atom/atom) 에 사용되고 있습니다. + +Electron에 대한 중요한 알림을 받으려면 Twitter에서 [@ElectronJS](https://twitter.com/electronjs)를 Follow하세요. + +## 다운로드 + +Linux, Windows, Mac용으로 미리 빌드된 Electron 바이너리와 디버그 심볼이 준비되어 있습니다. [releases](https://github.com/atom/electron/releases) 페이지에서 받아 볼 수 있습니다. + +또한 [`npm`](https://docs.npmjs.com/)을 이용하여 미리 빌드된 Electron 바이너리를 받을 수 있습니다: + +```sh +# $PATH에 `electron`을 등록하고 전역에 설치합니다. +npm install electron-prebuilt -g + +# 개발용 dependency로 설치합니다. +npm install electron-prebuilt --save-dev +``` + +### 미러 + +- [China](https://npm.taobao.org/mirrors/electron) + +## 참조문서 + +[docs](https://github.com/preco21/electron/tree/master/docs) 에 프레임워크 사용 가이드와 API 레퍼런스가 있습니다. +또한, Electron을 빌드 하는 방법과 프로젝트에 기여하는 방법 문서에 포함되어 있으니 참고바랍니다. + +## 커뮤니티 + +[Atom 포럼내의 `electron` 카테고리](http://discuss.atom.io/category/electron) 와 Freenode `#atom-shell` 채팅채널이 있습니다. + +[awesome-electron](https://github.com/sindresorhus/awesome-electron) 에 커뮤니티가 운영중인 유용한 예제 앱과 툴, 리소스가 있으니 한번 탐색해 보시기 바랍니다. diff --git a/docs/README-ko.md b/docs/README-ko.md new file mode 100644 index 000000000000..0a00d7a479df --- /dev/null +++ b/docs/README-ko.md @@ -0,0 +1,69 @@ +## 개발 가이드 + +* [어플리케이션 배포](tutorial/application-distribution-ko.md) +* [어플리케이션 패키징](tutorial/application-packaging-ko.md) +* [네이티브 node 모듈 사용하기](tutorial/using-native-node-modules-ko.md) +* [메인 프로세스 디버깅하기](tutorial/debugging-main-process-ko.md) +* [Selenium 과 WebDriver 사용하기](tutorial/using-selenium-and-webdriver-ko.md) +* [개발자 콘솔 확장기능](tutorial/devtools-extension-ko.md) +* [Pepper 플래시 플러그인 사용하기](tutorial/using-pepper-flash-plugin-ko.md) + +## 튜토리얼 + +* [시작하기](tutorial/quick-start-ko.md) +* [데스크톱 환경 통합](tutorial/desktop-environment-integration-ko.md) +* [온라인/오프라인 이벤트](tutorial/online-offline-events-ko.md) + +## API 레퍼런스 + +* [개요](api/synopsis-ko.md) +* [프로세스 객체](api/process-ko.md) +* [크롬 Command-Line 스위치에 대한 지원](api/chrome-command-line-switches-ko.md) + +커스텀 DOM Element: + +* [`File` 객체](api/file-object-ko.md) +* [`` 태그](api/web-view-tag-ko.md) +* [`window.open` 함수](api/window-open-ko.md) + +메인 프로세스를 위한 모듈들: + +* [app](api/app-ko.md) +* [auto-updater](api/auto-updater-ko.md) +* [browser-window](api/browser-window-ko.md) +* [content-tracing](api/content-tracing-ko.md) +* [dialog](api/dialog-ko.md) +* [global-shortcut](api/global-shortcut-ko.md) +* [ipc (main process)](api/ipc-main-process-ko.md) +* [menu](api/menu-ko.md) +* [menu-item](api/menu-item-ko.md) +* [power-monitor](api/power-monitor-ko.md) +* [protocol](api/protocol-ko.md) +* [tray](api/tray-ko.md) + +랜더러 프로세스를 위한 모듈들 (웹 페이지): + +* [ipc (renderer)](api/ipc-renderer-ko.md) +* [remote](api/remote-ko.md) +* [web-frame](api/web-frame-ko.md) + +두 프로세스에서 모두 사용 가능한 모듈들: + +* [clipboard](api/clipboard-ko.md) +* [crash-reporter](api/crash-reporter-ko.md) +* [native-image](api/native-image-ko.md) +* [screen](api/screen-ko.md) +* [shell](api/shell-ko.md) + +## 개발자용 + +* [코딩 스타일](development/coding-style-ko.md) +* [소스코드 구조](development/source-code-directory-structure-ko.md) +* [NW.js와 기술적으로 다른점 (이전 node-webkit)](development/atom-shell-vs-node-webkit-ko.md) +* [빌드 시스템 개요](development/build-system-overview-ko.md) +* [빌드 설명서 (Mac)](development/build-instructions-mac-ko.md) +* [빌드 설명서 (Windows)](development/build-instructions-windows-ko.md) +* [빌드 설명서 (Linux)](development/build-instructions-linux-ko.md) +* [디버거에서 디버그 심볼 서버 설정](development/setting-up-symbol-server-ko.md) + +이 문서는 (@preco21)[https://github.com/preco21]이 번역하였습니다. diff --git a/docs/api/accelerator-ko.md b/docs/api/accelerator-ko.md new file mode 100644 index 000000000000..67f94b60a6cb --- /dev/null +++ b/docs/api/accelerator-ko.md @@ -0,0 +1,46 @@ +# Accelerator + +Accelerator는 키보드 단축키를 표현하는 문자열입니다, 여러 혼합키와 키코드를 `+` 문자를 +이용하여 결합할 수 있습니다. + +예제: + +* `Command+A` +* `Ctrl+Shift+Z` + +## 플랫폼에 관련하여 주의할 점 + +Linux와 Windows에서는 `Command`키가 없으므로 작동하지 않습니다. 대신에 `CommandOrControl`을 +사용하면 OS X의 `Command`와 Linux, Windows의 `Control` 모두 지원할 수 있습니다. + +`Super`키는 Windows와 Linux 에서는 `윈도우`키를, OS X에서는 `Cmd`키로 맵핑됩니다. + +## 사용 가능한 혼합키 + +* `Command` (단축어 `Cmd`) +* `Control` (단축어 `Ctrl`) +* `CommandOrControl` (단축어 `CmdOrCtrl`) +* `Alt` +* `Shift` +* `Super` + +## 사용 가능한 전체 키코드 + +* `0` 부터 `9` 까지 +* `A` 부터 `Z` 까지 +* `F1` 부터 `F24` 까지 +* `~`, `!`, `@`, `#`, `$`, etc 와 같은 구두점 기호들 +* `Plus` +* `Space` +* `Backspace` +* `Delete` +* `Insert` +* `Return` (또는 `Enter`) +* `Up`, `Down`, `Left` 와 `Right` +* `Home` 그리고 `End` +* `PageUp` 그리고 `PageDown` +* `Escape` (단축어 `Esc`) +* `VolumeUp`, `VolumeDown` 그리고 `VolumeMute` +* `MediaNextTrack`, `MediaPreviousTrack`, `MediaStop` 그리고 `MediaPlayPause` + +__키코드는 `단축어`로도 사용할 수 있습니다__ diff --git a/docs/api/menu-item-ko.md b/docs/api/menu-item-ko.md new file mode 100644 index 000000000000..09c2b782a228 --- /dev/null +++ b/docs/api/menu-item-ko.md @@ -0,0 +1,20 @@ +# menu-item + +## Class: MenuItem + +### new MenuItem(options) + +* `options` Object + * `click` Function - ޴ Ŭ ȣǴ ݹԼ + * `selector` String - First Responder Ŭ ȣ Ǵ (OS X ) + * `type` String - `MenuItem` Ÿ `normal`, `separator`, `submenu`, `checkbox` Ǵ `radio` 밡 + * `label` String + * `sublabel` String + * `accelerator` [Accelerator](accelerator.md) + * `icon` [NativeImage](native-image.md) + * `enabled` Boolean + * `visible` Boolean + * `checked` Boolean + * `submenu` Menu - ޴ մϴ. `type` `submenu` ݵ ؾմϴ. Ϲ ޴ ֽϴ. + * `id` String - ޴ ۿ Ű մϴ. Ű `position` ɼǿ ֽϴ. + * `position` String - ̸ `id` ̿Ͽ ޴ ġ ϰ մϴ. diff --git a/docs/api/power-monitor-ko.md b/docs/api/power-monitor-ko.md new file mode 100644 index 000000000000..e21c70a77fea --- /dev/null +++ b/docs/api/power-monitor-ko.md @@ -0,0 +1,33 @@ +# power-monitor + +`power-monitor` 모듈은 PC의 파워 상태를 나타냅니다. (주로 노트북 등에서 사용됩니다) +이 모듈은 메인 프로세스에서만 사용할 수 있으며, (remote 모듈(RPC)을 사용해도 작동이 됩니다) +메인 프로세스의 `app` 모듈에서 `ready` 이벤트를 호출하기 전까지 사용할 수 없습니다. + +예제: + +```javascript +var app = require('app'); + +app.on('ready', function() { + require('power-monitor').on('suspend', function() { + console.log('절전모드로 진입합니다!'); + }); +}); +``` + +## Event: suspend + +시스템이 절전모드로 진입할 때 호출됩니다. + +## Event: resume + +시스템의 절전모드가 해제될 때 호출됩니다. + +## Event: on-ac + +시스템이 AC 어뎁터 충전기를 사용하기 시작할 때 호출됩니다. + +## Event: on-battery + +시스템이 배터리를 사용하기 시작할 때 호출됩니다. diff --git a/docs/api/tray-ko.md b/docs/api/tray-ko.md new file mode 100644 index 000000000000..2678b6812dc8 --- /dev/null +++ b/docs/api/tray-ko.md @@ -0,0 +1,139 @@ +# Tray + +`Tray`는 OS의 알림영역에 아이콘을 표시합니다. 보통 컨텍스트 메뉴(context menu)를 같이 사용합니다. + +```javascript +var app = require('app'); +var Menu = require('menu'); +var Tray = require('tray'); + +var appIcon = null; +app.on('ready', function(){ + appIcon = new Tray('/path/to/my/icon'); // 현재 어플리케이션 디렉터리를 기준으로 하려면 `__dirname + '/images/tray.png'` 형식으로 입력해야합니다. + var contextMenu = Menu.buildFromTemplate([ + { label: 'Item1', type: 'radio' }, + { label: 'Item2', type: 'radio' }, + { label: 'Item3', type: 'radio', checked: true }, + { label: 'Item4', type: 'radio' } + ]); + appIcon.setToolTip('이것은 나의 어플리케이션 입니다!'); + appIcon.setContextMenu(contextMenu); +}); + +``` + +__플랫폼별 한계:__ + +* OS X에서는 트레이 아이콘이 컨텍스트 메뉴를 가지고 있을 경우 `clicked` 이벤트는 무시됩니다. +* Linux에서는 앱 알림 표시기(app indicator)가 지원되면 해당 기능을 사용합니다. 만약 지원하지 않으면 `GtkStatusIcon`을 대신 사용합니다. +* 앱 알림 표시기는 컨텍스트 메뉴를 가지고 있을 때만 보입니다. +* Linux에서 앱 알림 표시기가 사용될 경우, `clicked` 이벤트는 무시됩니다. + +이러한 이유로 만약 Tray API가 모든 플랫폼에서 똑같이 작동하게 하고 싶다면, 설계시 `clicked` 이벤트에 의존하지 말아야합니다. +그리고 언제나 컨텍스트 메뉴를 포함해서 사용해야 합니다. + +## Class: Tray + +`Tray`는 [EventEmitter][event-emitter]를 상속 받았습니다. + +### new Tray(image) + +* `image` [NativeImage](native-image-ko.md) + +전달된 `image`를 이용하여 트레이 아이콘을 만듭니다. + +### Event: 'clicked' + +* `event` +* `bounds` Object - 트레이 아이콘의 범위 + * `x` Integer + * `y` Integer + * `width` Integer + * `height` Integer + +트레이 아이콘이 클릭될 때 호출됩니다. + +__주의:__ `bounds`는 OS X와 Window 7 이후 버전에서만 작동합니다. + +### Event: 'double-clicked' + +트레이 아이콘이 더블 클릭될 때 호출됩니다. + +__주의:__ 이 기능은 OS X에서만 작동합니다. + +### Event: 'balloon-show' + +알림풍선이 보여질 때 호출됩니다. + +__주의:__ 이 기능은 Windows에서만 작동합니다. + +### Event: 'balloon-clicked' + +알림풍선이 클릭될 때 호출됩니다. + +__주의:__ 이 기능은 Windows에서만 작동합니다. + +### Event: 'balloon-closed' + +알림풍선이 시간이 지나 사라지거나 유저가 클릭하여 닫을 때 호출됩니다. + +__주의:__ 이 기능은 Windows에서만 작동합니다. + +### Tray.destroy() + +트레이 아이콘을 즉시 삭제시킵니다. + +### Tray.setImage(image) + +* `image` [NativeImage](native-image-ko.md) + +`image`를 사용하여 트레이 아이콘의 이미지를 설정합니다. + +### Tray.setPressedImage(image) + +* `image` [NativeImage](native-image-ko.md) + +`image`를 사용하여 트레이 아이콘이 눌렸을 때의 이미지를 설정합니다. + +__주의:__ 이 기능은 OS X에서만 작동합니다. + +### Tray.setToolTip(toolTip) + +* `toolTip` String + +트레이 아이콘의 툴팁 텍스트를 설정합니다. + +### Tray.setTitle(title) + +* `title` String + +상태바에서 트레이 아이콘 옆에 표시되는 제목 텍스트를 설정합니다. + +__주의:__ 이 기능은 OS X에서만 작동합니다. + +### Tray.setHighlightMode(highlight) + +* `highlight` Boolean + +트레이 아이콘을 클릭했을 때 하이라이트 될지 설정합니다. + +__주의:__ 이 기능은 OS X에서만 작동합니다. + +### Tray.displayBalloon(options) + +* `options` Object + * `icon` [NativeImage](native-image-ko.md) + * `title` String + * `content` String + +트레이에 알림풍선을 생성합니다. + +__알림:__ 이 기능은 Windows에서만 작동합니다. + +### Tray.setContextMenu(menu) + +* `menu` Menu + +트레이에 컨텍스트 메뉴를 설정합니다. + +[event-emitter]: http://nodejs.org/api/events.html#events_class_events_eventemitter diff --git a/docs/api/web-view-tag-ko.md b/docs/api/web-view-tag-ko.md new file mode 100644 index 000000000000..198deec8dd6c --- /dev/null +++ b/docs/api/web-view-tag-ko.md @@ -0,0 +1,479 @@ +# `` ± + +Use the `webview` tag to embed 'guest' content (such as web pages) in your +Electron app. The guest content is contained within the `webview` container; +an embedder page within your app controls how the guest content is laid out and +rendered. + +Different from the `iframe`, the `webview` runs in a separate process than your +app; it doesn't have the same permissions as your web page and all interactions +between your app and embedded content will be asynchronous. This keeps your app +safe from the embedded content. + +## + +To embed a web page in your app, add the `webview` tag to your app's embedder +page (this is the app page that will display the guest content). In its simplest +form, the `webview` tag includes the `src` of the web page and css styles that +control the appearance of the `webview` container: + +```html + +``` + +If you want to control the guest content in any way, you can write JavaScript +that listens for `webview` events and responds to those events using the +`webview` methods. Here's sample code with two event listeners: one that listens +for the web page to start loading, the other for the web page to stop loading, +and displays a "loading..." message during the load time: + +```html + +``` + +## ± Ӽ + +### src + +```html + +``` + +Returns the visible URL. Writing to this attribute initiates top-level +navigation. + +Assigning `src` its own value will reload the current page. + +The `src` attribute can also accept data URLs, such as +`data:text/plain,Hello, world!`. + +### autosize + +```html + +``` + +If "on", the `webview` container will automatically resize within the +bounds specified by the attributes `minwidth`, `minheight`, `maxwidth`, and +`maxheight`. These contraints do not impact the `webview` UNLESS `autosize` is +enabled. When `autosize` is enabled, the `webview` container size cannot be less +than the minimum values or greater than the maximum. + +### nodeintegration + +```html + +``` + +If "on", the guest page in `webview` will have node integration and can use node +APIs like `require` and `process` to access low level system resources. + +### plugins + +```html + +``` + +If "on", the guest page in `webview` will be able to use browser plugins. + +### preload + +```html + +``` + +Specifies a script that will be loaded before other scripts run in the guest +page. The protocol of script's URL must be either `file:` or `asar:`, because it +will be loaded by `require` in guest page under the hood. + +When the guest page doesn't have node integration this script will still have +access to all Node APIs, but global objects injected by Node will be deleted +after this script has done execution. + +### httpreferrer + +```html + +``` + +Sets the referrer URL for the guest page. + +### useragent + +```html + +``` + +Sets the user agent for the guest page before the page is navigated to. Once the page is loaded, use the `setUserAgent` method to change the user agent. + +### disablewebsecurity + +```html + +``` + +If "on", the guest page will have web security disabled. + +## API + +The webview element must be loaded before using the methods. +**Example** +```javascript +webview.addEventListener("dom-ready", function(){ + webview.openDevTools(); +}); +``` + +### ``.getUrl() + +Returns URL of guest page. + +### ``.getTitle() + +Returns the title of guest page. + +### ``.isLoading() + +Returns whether guest page is still loading resources. + +### ``.isWaitingForResponse() + +Returns whether guest page is waiting for a first-response for the main resource +of the page. + +### ``.stop() + +Stops any pending navigation. + +### ``.reload() + +Reloads guest page. + +### ``.reloadIgnoringCache() + +Reloads guest page and ignores cache. + +### ``.canGoBack() + +Returns whether guest page can go back. + +### ``.canGoForward() + +Returns whether guest page can go forward. + +### ``.canGoToOffset(offset) + +* `offset` Integer + +Returns whether guest page can go to `offset`. + +### ``.clearHistory() + +Clears the navigation history. + +### ``.goBack() + +Makes guest page go back. + +### ``.goForward() + +Makes guest page go forward. + +### ``.goToIndex(index) + +* `index` Integer + +Navigates to the specified absolute index. + +### ``.goToOffset(offset) + +* `offset` Integer + +Navigates to the specified offset from the "current entry". + +### ``.isCrashed() + +Whether the renderer process has crashed. + +### ``.setUserAgent(userAgent) + +* `userAgent` String + +Overrides the user agent for guest page. + +### ``.insertCSS(css) + +* `css` String + +Injects CSS into guest page. + +### ``.executeJavaScript(code) + +* `code` String + +Evaluates `code` in guest page. + +### ``.openDevTools() + +Opens a devtools window for guest page. + +### ``.closeDevTools() + +Closes the devtools window of guest page. + +### ``.isDevToolsOpened() + +Returns whether guest page has a devtools window attached. + +### ``.inspectElement(x, y) + +* `x` Integer +* `y` Integer + +Starts inspecting element at position (`x`, `y`) of guest page. + +### ``.inspectServiceWorker() + +Opens the devtools for the service worker context present in the guest page. + +### ``.undo() + +Executes editing command `undo` in page. + +### ``.redo() + +Executes editing command `redo` in page. + +### ``.cut() + +Executes editing command `cut` in page. + +### ``.copy() + +Executes editing command `copy` in page. + +### ``.paste() + +Executes editing command `paste` in page. + +### ``.pasteAndMatchStyle() + +Executes editing command `pasteAndMatchStyle` in page. + +### ``.delete() + +Executes editing command `delete` in page. + +### ``.selectAll() + +Executes editing command `selectAll` in page. + +### ``.unselect() + +Executes editing command `unselect` in page. + +### ``.replace(text) + +* `text` String + +Executes editing command `replace` in page. + +### ``.replaceMisspelling(text) + +* `text` String + +Executes editing command `replaceMisspelling` in page. + +### ``.send(channel[, args...]) + +* `channel` String + +Send `args..` to guest page via `channel` in asynchronous message, the guest +page can handle it by listening to the `channel` event of `ipc` module. + +See [WebContents.send](browser-window-ko.md#webcontentssendchannel-args) for +examples. + +## DOM ̺Ʈ + +### did-finish-load + +Fired when the navigation is done, i.e. the spinner of the tab will stop +spinning, and the `onload` event was dispatched. + +### did-fail-load + +* `errorCode` Integer +* `errorDescription` String + +This event is like `did-finish-load`, but fired when the load failed or was +cancelled, e.g. `window.stop()` is invoked. + +### did-frame-finish-load + +* `isMainFrame` Boolean + +Fired when a frame has done navigation. + +### did-start-loading + +Corresponds to the points in time when the spinner of the tab starts spinning. + +### did-stop-loading + +Corresponds to the points in time when the spinner of the tab stops spinning. + +### did-get-response-details + +* `status` Boolean +* `newUrl` String +* `originalUrl` String +* `httpResponseCode` Integer +* `requestMethod` String +* `referrer` String +* `headers` Object + +Fired when details regarding a requested resource is available. +`status` indicates socket connection to download the resource. + +### did-get-redirect-request + +* `oldUrl` String +* `newUrl` String +* `isMainFrame` Boolean + +Fired when a redirect was received while requesting a resource. + +### dom-ready + +Fired when document in the given frame is loaded. + +### page-title-set + +* `title` String +* `explicitSet` Boolean + +Fired when page title is set during navigation. `explicitSet` is false when title is synthesised from file +url. + +### page-favicon-updated + +* `favicons` Array - Array of Urls + +Fired when page receives favicon urls. + +### enter-html-full-screen + +Fired when page enters fullscreen triggered by html api. + +### leave-html-full-screen + +Fired when page leaves fullscreen triggered by html api. + +### console-message + +* `level` Integer +* `message` String +* `line` Integer +* `sourceId` String + +Fired when the guest window logs a console message. + +The following example code forwards all log messages to the embedder's console +without regard for log level or other properties. + +```javascript +webview.addEventListener('console-message', function(e) { + console.log('Guest page logged a message:', e.message); +}); +``` + +### new-window + +* `url` String +* `frameName` String +* `disposition` String - Can be `default`, `foreground-tab`, `background-tab`, + `new-window` and `other` + +Fired when the guest page attempts to open a new browser window. + +The following example code opens the new url in system's default browser. + +```javascript +webview.addEventListener('new-window', function(e) { + require('shell').openExternal(e.url); +}); +``` + +### close + +Fired when the guest page attempts to close itself. + +The following example code navigates the `webview` to `about:blank` when the +guest attempts to close itself. + +```javascript +webview.addEventListener('close', function() { + webview.src = 'about:blank'; +}); +``` + +### ipc-message + +* `channel` String +* `args` Array + +Fired when the guest page has sent an asynchronous message to embedder page. + +With `sendToHost` method and `ipc-message` event you can easily communicate +between guest page and embedder page: + +```javascript +// In embedder page. +webview.addEventListener('ipc-message', function(event) { + console.log(event.channel); + // Prints "pong" +}); +webview.send('ping'); +``` + +```javascript +// In guest page. +var ipc = require('ipc'); +ipc.on('ping', function() { + ipc.sendToHost('pong'); +}); +``` + +### crashed + +Fired when the renderer process is crashed. + +### gpu-crashed + +Fired when the gpu process is crashed. + +### plugin-crashed + +* `name` String +* `version` String + +Fired when a plugin process is crashed. + +### destroyed + +Fired when the WebContents is destroyed. diff --git a/docs/development/coding-style-ko.md b/docs/development/coding-style-ko.md new file mode 100644 index 000000000000..40328cd6c5e3 --- /dev/null +++ b/docs/development/coding-style-ko.md @@ -0,0 +1,23 @@ +# 코딩 스타일 + +## C++과 Python + +C++과 Python스크립트는 Chromium의 [코딩 스타일](http://www.chromium.org/developers/coding-style)을 따릅니다. +파이선 스크립트 `script/cpplint.py`를 사용하여 모든 파일이 해당 코딩스타일에 맞게 코딩 되었는지 확인할 수 있습니다. + +파이선의 버전은 2.7을 사용합니다. + +## CoffeeScript + +CoffeeScript의 경우 GitHub의 [스타일 가이드](https://github.com/styleguide/javascript)를 따릅니다, 동시에 다음 규칙도 따릅니다: + +* Google의 코딩 스타일에도 맞추기 위해, 파일의 끝에는 **절대** 개행을 삽입해선 안됩니다. +* 파일 이름의 공백은 `_`대신에 `-`을 사용하여야 합니다. 예를 들어 `file_name.coffee`를 +`file-name.coffee`로 고쳐야합니다, 왜냐하면 [github/atom](https://github.com/github/atom) 에서 사용되는 모듈의 이름은 +보통 `module-name`형식이기 때문입니다, 이 규칙은 '.coffee' 파일에만 적용됩니다. + +## API 이름 + +새로운 API를 만들 땐, getter, setter스타일 대신 jQuery의 one-function스타일을 사용해야 합니다. 예를 들어, +`.getText()`와 `.setText(text)`대신에 `.text([text])`형식으로 설계하면 됩니다. +포럼에 이 문제에 대한 [논의](https://github.com/atom/electron/issues/46)가 있습니다. diff --git a/docs/tutorial/application-distribution-ko.md b/docs/tutorial/application-distribution-ko.md new file mode 100644 index 000000000000..fff2453fc0a5 --- /dev/null +++ b/docs/tutorial/application-distribution-ko.md @@ -0,0 +1,138 @@ +# 어플리케이션 배포 + +Electron 어플리케이션을 배포할 때는 어플리케이션 폴더의 이름을 `app`으로 지정한 후 Electron 실행파일의 리소스 디렉터리에 집어넣어야합니다. +리소스 디렉터리는 OS X에선 `Electron.app/Contents/Resources/` Windows와 Linux에선 `resources/` 입니다. + +예제: + +OS X의 경우: + +```text +electron/Electron.app/Contents/Resources/app/ +├── package.json +├── main.js +└── index.html +``` + +Windows 와 Linux의 경우: + +```text +electron/resources/app +├── package.json +├── main.js +└── index.html +``` + +그리고 `Electron.app`을 실행하면 (Linux에선 `electron` Windows에선 `electron.exe`입니다), Electron은 해당 앱을 실행시킵니다. +최종 사용자에게는 이 `electron` 폴더(Electron.app)를 배포하면 됩니다. + +## asar로 앱 패키징 하기 + +소스파일 전체를 복사해서 배포하는 것과는 별개로, [asar](https://github.com/atom/asar) 아카이브를 통해 +어플리케이션의 소스코드가 사용자에게 노출되는 것을 방지할 수 있습니다. + +`asar` 아카이브를 사용할 땐 단순히 `app` 폴더 대신에 어플리케이션을 패키징한 `app.asar` 파일로 대체하면됩니다. +이렇게 하면 Electron은 아카이브를 `app`폴더 대신 asar 아카이브를 기반으로 어플리케이션을 실행합니다. + +OS X의 경우: + +```text +electron/Electron.app/Contents/Resources/ +└── app.asar +``` + +Windows 와 Linux의 경우: + +```text +electron/resources/ +└── app.asar +``` + +자세한 내용은 [어플리케이션 패키징](application-packaging.md)에서 찾아볼 수 있습니다. + +## 다운로드한 바이너리의 리소스를 앱에 맞게 수정하기 + +어플리케이션을 Electron에 번들링한 후, 해당 어플리케이션에 맞게 리브랜딩 할 수 있습니다. + +### Windows + +`electron.exe`을 원하는 이름으로 변경할 수 있습니다. +그리고 [rcedit](https://github.com/atom/rcedit) 또는 [ResEdit](http://www.resedit.net)를 사용하여 아이콘을 변경할 수 있습니다. + +### OS X + +`Electron.app`을 원하는 이름으로 변경할 수 있습니다. 그리고 다음 표시된 어플리케이션 내부 파일에서 +`CFBundleDisplayName`, `CFBundleIdentifier` and `CFBundleName` 필드를 원하는 이름으로 변경해야합니다: + +* `Electron.app/Contents/Info.plist` +* `Electron.app/Contents/Frameworks/Electron Helper.app/Contents/Info.plist` + +또한 helper 앱이 프로세스 모니터에 `Electron Helper`로 나오지 않도록 이름을 변경할 수 있습니다. +하지만 반드시 내부 및 모든 helper 앱의 이름을 변경해야 합니다. + +어플리케이션 아이콘은 `Electron.app/Contents/Resources/atom.icns`을 원하는 아이콘으로 변경하면 됩니다. + +원하는 이름으로 바꾼 어플리케이션 예제: + +``` +MyApp.app/Contents +├── Info.plist +├── MacOS/ +│   └── MyApp +└── Frameworks/ + ├── MyApp Helper EH.app + | ├── Info.plist + | └── MacOS/ + |    └── MyApp Helper EH + ├── MyApp Helper NP.app + | ├── Info.plist + | └── MacOS/ + |    └── MyApp Helper NP + └── MyApp Helper.app + ├── Info.plist + └── MacOS/ +    └── MyApp Helper +``` + +### Linux + +실행파일 `electron`의 이름을 원하는 대로 바꿀 수 있습니다. +리눅스 어플리케이션의 아이콘은 [.desktop file](https://developer.gnome.org/integration-guide/stable/desktop-files.html.en)을 사용하여 지정할 수 있습니다. + +### 역자주-자동화 + +일일이 Electron의 리소스를 수정하는 것은 상당히 귀찮고 복잡합니다. +하지만 이 작업을 자동화 시킬 수 있는 몇가지 방법이 있습니다: + +* [electron-builder](https://github.com/loopline-systems/electron-builder) +* [electron-packager](https://github.com/maxogden/electron-packager) + +## Electron 소스코드를 다시 빌드하여 리소스 수정하기 + +또한 Electron 소스코드를 다시 빌드할 때 어플리케이션 이름을 변경할 수 있습니다. +`GYP_DEFINES` 환경변수를 사용하여 다음과 같이 다시 빌드할 수 있습니다: + +__Windows__ + +```bash +> set "GYP_DEFINES=project_name=myapp product_name=MyApp" +> python script\clean.py +> python script\bootstrap.py +> python script\build.py -c R -t myapp +``` + +__Bash__ + +```bash +$ export GYP_DEFINES="project_name=myapp product_name=MyApp" +$ script/clean.py +$ script/bootstrap.py +$ script/build.py -c Release -t myapp +``` + +### grunt-build-atom-shell + +Electron의 소스코드를 수정하고 다시 빌드하는 작업은 상당히 복잡합니다. +이를 해결하기 위해 [grunt-build-atom-shell](https://github.com/paulcbetts/grunt-build-atom-shell)를 사용하여 빌드를 자동화 시킬 수 있습니다. + +이 툴을 사용하면 자동적으로 `.gyp`파일을 수정하고 다시 빌드합니다. 그리고 어플리케이션의 네이티브 Node 모듈 또한 새로운 실행파일 이름으로 매치 시킵니다. diff --git a/docs/tutorial/application-packaging-ko.md b/docs/tutorial/application-packaging-ko.md new file mode 100644 index 000000000000..3e4798f1f523 --- /dev/null +++ b/docs/tutorial/application-packaging-ko.md @@ -0,0 +1,153 @@ +# ø̼ Ű¡ + +ø̼ ҽ ҽڵ带 κ ȣϱ , ణ ø̼ [asar][asar] ī̺ Ű¡ ֽϴ. + +## `asar` ī̺ + +[asar][asar]ī̺ tar ҽ ϳ Ϸ ϴ. +׸ Electron Ƿ о ֽϴ. + +  ܰ踦 ø̼ `asar` ī̺ ֽϴ: + +### 1. asar ƿƼ ġ + +```bash +$ npm install -g asar +``` + +### 2. `asar pack` Ŀǵ Ű¡ + +```bash +$ asar pack your-app app.asar +``` + +## `asar` ī̺ ϱ + +Electron ΰ API ֽϴ: Node.js Node API, Chromiumκ Web API. + API `asar` о ֵ մϴ. + +### Node API + +`fs.readFile` `require` Node API ϱ Electron `asar` ī̺갡 ͸ +ġ߽ϴ. ׷ ī̺ ο ҽ ýó ֽϴ. + +, `/path/to` ο `example.asar` ī̺갡 ִٰ ϸ: + +```bash +$ asar list /path/to/example.asar +/app.js +/file.txt +/dir/module.js +/static/index.html +/static/main.css +/static/jquery.min.js +``` + +`asar` ī̺꿡 ֽϴ: + +```javascript +var fs = require('fs'); +fs.readFileSync('/path/to/example.asar/file.txt'); +``` + +ī̺ Ʈ ͸ մϴ: + +```javascript +var fs = require('fs'); +fs.readdirSync('/path/to/example.asar'); +``` + +ī̺ ϱ: + +```javascript +require('/path/to/example.asar/dir/module.js'); +``` + +`BrowserWindow` Ŭ ̿ ϴ ǥ ֽϴ: + +```javascript +var BrowserWindow = require('browser-window'); +var win = new BrowserWindow({width: 800, height: 600}); +win.loadUrl('file:///path/to/example.asar/static/index.html'); +``` + +### Web API + + , ī̺ `file:` Ͽ û ֽϴ. + Node API ͸ ϴ. + +, jQuery `$.get` Ͽ ֽϴ: + +```html + +``` + +### `asar` ī̺긦 Ϲ Ϸ ϱ + +`asar` ī̺ üũ(checksum) ˻ϱ ؼ, `asar` ī̺긦 ״ о鿩 ʿ䰡 ֽϴ. + ۾ ϱ `original-fs` ϴ Ʈ `fs` ſ ֽϴ. + `asar` ֽϴ. ״θ оԴϴ: + +```javascript +var originalFs = require('original-fs'); +originalFs.readFileSync('/path/to/example.asar'); +``` + +## Node API Ѱ + +`asar` ī̺긦 Node API ִ ͸ ۵ϵ ؿ, (low-level) Node API Ѱ谡 ֽϴ. + +Even though we tried hard to make `asar` archives in the Node API work like +directories as much as possible, there are still limitations due to the +low-level nature of the Node API. + +### ī̺ б Դϴ + +ī̺ ⺻δ Node API , `asar` ī̺꿡 ۵ ʽϴ. + +### ī̺ ͸ ۾ η ϸ ȵ˴ϴ + +`asar` ī̺ ͸ó ֵ Ǿ, װ Ͻý ͸ ƴ ͸Դϴ. +׷ API ϴ `cwd` ɼ `asar` ī̺ ͸ η ϸ ߿ ߻ ֽϴ. + +### Ư API + + `fs` API `asar` ī̺ ʰ ٷ ī̺긦 аų , + API ý θ ۵ϹǷ API Electron + API ϰ ۵ ֵ ϱ ӽðο ش ϵ մϴ. ۾ ణ 带 ҷ ų ֽϴ. + +شϴ API Լ ϴ: + +* `child_process.execFile` +* `fs.open` +* `fs.openSync` +* `process.dlopen` - Used by `require` on native modules + +### `fs.stat` ߸ ͽ + +`fs.stat` ȯǴ `Stats` ü API `asar` ī̺긦 Ÿ ϴ. +ֳϸ ī̺ ͸ δ Ͻýۿ ʱ Դϴ. +׷ ũ Ÿ Ȯ `Stats` ü ŷؼ ȵ˴ϴ. + +## Adding unpacked files in `asar` archive + + ٿ , Node API ȣ ش ӽ մϴ. + ɹ ߻ ֽϴ. ׸ Ʈ ߸ ų ֽϴ. + + ذϷ, `--unpack` ɼ ȰϿ Ǯ · ؾ մϴ. + node Ƽ ̺귯 unpack · մϴ: + +```bash +$ asar pack app app.asar --unpack *.node +``` + +Ŀǵ带 , ͸ `app.asar` ܿ `app.asar.unpacked` ˴ϴ. + ȿ unpack ɼǿ ϵ Ǯ · ԵǾ ֽϴ. + ø̼ ݵ ش Ͽմϴ. + +[asar]: https://github.com/atom/asar diff --git a/docs/tutorial/debugging-main-process-ko.md b/docs/tutorial/debugging-main-process-ko.md new file mode 100644 index 000000000000..ae8d6c897acd --- /dev/null +++ b/docs/tutorial/debugging-main-process-ko.md @@ -0,0 +1,45 @@ +# 메인 프로세스 디버깅하기 + +브라우저 창의 개발자 콘솔은 랜더러 프로세스의 스크립트만 디버깅이 가능합니다. (다시말해 웹 페이지) +메인 프로세스의 디버깅 방법을 제공하기 위해, Electron은 `--debug` 과 `--debug-brk` 스위치들을 제공합니다. + +## 커맨드 라인 스위치(command line switches) + +### `--debug=[port]` + +이 스위치를 사용하면 Electron은 지정한 `port`에 V8 디버거 프로토콜을 리스닝합니다. `port`는 `5858`이 기본적으로 사용됩니다. + +### `--debug-brk=[port]` + +`--debug`와 비슷하지만 스크립트의 첫번째 라인에서 일시정지합니다. + +## node-inspector로 디버깅 하기 + +__주의:__ Electron은 node v0.11.13 버전을 사용합니다, node-inspector는 현재 아주 잘 작동하지 않습니다. +그리고 메인 프로세스의 `process`를 node-inspector 콘솔 내에서 검사할 경우 크래시가 발생할 수 있습니다. + +### 1. [node-inspector][node-inspector] 서버 시작 + +```bash +$ node-inspector +``` + +### 2. Electron용 디버그 모드 활성화 + +다음과 같이 debung 플래그로 Electron을 실행할 수도 있습니다: + +```bash +$ electron --debug=5858 your/app +``` + +또는 스크립트 첫번째 라인에서 일시정지: + +```bash +$ electron --debug-brk=5858 your/app +``` + +### 3. 디버그 UI 로드 + +Chrome 브라우저에서 http://127.0.0.1:8080/debug?ws=127.0.0.1:8080&port=5858 주소에 접속합니다. (기본포트 또는 지정한 포트로 접속) + +[node-inspector]: https://github.com/node-inspector/node-inspector diff --git a/docs/tutorial/desktop-environment-integration-ko.md b/docs/tutorial/desktop-environment-integration-ko.md new file mode 100644 index 000000000000..fbf002154434 --- /dev/null +++ b/docs/tutorial/desktop-environment-integration-ko.md @@ -0,0 +1,201 @@ +# 데스크톱 환경 통합 + +Different operating systems provide different features on integrating desktop +applications into their desktop environments. For example, on Windows +applications can put shortcuts in the JumpList of task bar, and on Mac +applications can put a custom menu in the dock menu. + +This guide explains how to integrate your application into those desktop +environments with Electron APIs. + +## 최근 사용한 문서 (Windows & OS X) + +Windows and OS X provide easy access to a list of recent documents opened by +the application via JumpList and dock menu. + +__JumpList:__ + +![JumpList Recent Files](http://i.msdn.microsoft.com/dynimg/IC420538.png) + +__Application dock menu:__ + + + +To add a file to recent documents, you can use +[app.addRecentDocument][addrecentdocument] API: + +```javascript +var app = require('app'); +app.addRecentDocument('/Users/USERNAME/Desktop/work.type'); +``` + +And you can use [app.clearRecentDocuments](clearrecentdocuments) API to empty +the recent documents list: + +```javascript +app.clearRecentDocuments(); +``` + +### Windows에서 주의할 점 + +In order to be able to use this feature on Windows, your application has to be +registered as a handler of the file type of the document, otherwise the file +won't appear in JumpList even after you have added it. You can find everything +on registering your application in [Application Registration][app-registration]. + +When a user clicks a file from JumpList, a new instance of your application will +be started with the path of the file added as a command line argument. + +### OS X에서 주의할 점 + +When a file is requested from the recent documents menu, the `open-file` event +of `app` module would be emitted for it. + +## 커스텀 독 메뉴 (OS X) + +OS X enables developers to specify a custom menu for the dock, which usually +contains some shortcuts for commonly used features of your application: + +__Dock menu of Terminal.app:__ + + + +To set your custom dock menu, you can use the `app.dock.setMenu` API, which is +only available on OS X: + +```javascript +var app = require('app'); +var Menu = require('menu'); +var dockMenu = Menu.buildFromTemplate([ + { label: 'New Window', click: function() { console.log('New Window'); } }, + { label: 'New Window with Settings', submenu: [ + { label: 'Basic' }, + { label: 'Pro'} + ]}, + { label: 'New Command...'} +]); +app.dock.setMenu(dockMenu); +``` + +## 사용자 작업 (Windows) + +On Windows you can specify custom actions in the `Tasks` category of JumpList, +as quoted from MSDN: + +> Applications define tasks based on both the program's features and the key +> things a user is expected to do with them. Tasks should be context-free, in +> that the application does not need to be running for them to work. They +> should also be the statistically most common actions that a normal user would +> perform in an application, such as compose an email message or open the +> calendar in a mail program, create a new document in a word processor, launch +> an application in a certain mode, or launch one of its subcommands. An +> application should not clutter the menu with advanced features that standard +> users won't need or one-time actions such as registration. Do not use tasks +> for promotional items such as upgrades or special offers. +> +> It is strongly recommended that the task list be static. It should remain the +> same regardless of the state or status of the application. While it is +> possible to vary the list dynamically, you should consider that this could +> confuse the user who does not expect that portion of the destination list to +> change. + +__Tasks of Internet Explorer:__ + +![IE](http://i.msdn.microsoft.com/dynimg/IC420539.png) + +Unlike the dock menu in OS X which is a real menu, user tasks in Windows work +like application shortcuts that when user clicks a task, a program would be +executed with specified arguments. + +To set user tasks for your application, you can use +[app.setUserTasks][setusertaskstasks] API: + +```javascript +var app = require('app'); +app.setUserTasks([ + { + program: process.execPath, + arguments: '--new-window', + iconPath: process.execPath, + iconIndex: 0, + title: 'New Window', + description: 'Create a new window' + } +]); +``` + +To clean your tasks list, just call `app.setUserTasks` with empty array: + +```javascript +app.setUserTasks([]); +``` + +The user tasks will still show even after your application closes, so the icon +and program path specified for a task should exist until your application is +uninstalled. + +## Unity 런처 숏컷 기능 (Linux) + +In Unity, you can add custom entries to its launcher via modifying `.desktop` +file, see [Adding shortcuts to a launcher][unity-launcher]. + +__Launcher shortcuts of Audacious:__ + +![audacious](https://help.ubuntu.com/community/UnityLaunchersAndDesktopFiles?action=AttachFile&do=get&target=shortcuts.png) + +## Taskbar progress 기능 (Windows & Unity) + +On Windows, a taskbar button can be used to display a progress bar. This enables +a window to provide progress information to the user without the user having to +switch to the window itself. + +The Unity DE also has a similar feature that allows you to specify the progress +bar in the launcher. + +__Progress bar in taskbar button:__ + +![Taskbar Progress Bar](https://cloud.githubusercontent.com/assets/639601/5081682/16691fda-6f0e-11e4-9676-49b6418f1264.png) + +__Progress bar in Unity launcher:__ + +![Unity Launcher](https://cloud.githubusercontent.com/assets/639601/5081747/4a0a589e-6f0f-11e4-803f-91594716a546.png) + +To set the progress bar for a Window, you can use the +[BrowserWindow.setProgressBar][setprogressbar] API: + +```javascript +var window = new BrowserWindow({...}); +window.setProgressBar(0.5); +``` + +## 윈도우 파일 제시 (OS X) + +On OS X a window can set its represented file, so the file's icon can show in +the title bar, and when users Command-Click or Control-Click on the tile a path +popup will show. + +You can also set the edited state of a window so that the file icon can indicate +whether the document in this window has been modified. + +__Represented file popup menu:__ + + + +To set the represented file of window, you can use the +[BrowserWindow.setRepresentedFilename][setrepresentedfilename] and +[BrowserWindow.setDocumentEdited][setdocumentedited] APIs: + +```javascript +var window = new BrowserWindow({...}); +window.setRepresentedFilename('/etc/passwd'); +window.setDocumentEdited(true); +``` + +[addrecentdocument]: ../api/app-ko.md#appaddrecentdocumentpath +[clearrecentdocuments]: ../api/app-ko.md#appclearrecentdocuments +[setusertaskstasks]: ../api/app-ko.md#appsetusertaskstasks +[setprogressbar]: ../api/browser-window-ko.md#browserwindowsetprogressbarprogress +[setrepresentedfilename]: ../api/browser-window-ko.md#browserwindowsetrepresentedfilenamefilename +[setdocumentedited]: ../api/browser-window-ko.md#browserwindowsetdocumenteditededited +[app-registration]: http://msdn.microsoft.com/en-us/library/windows/desktop/ee872121(v=vs.85).aspx +[unity-launcher]: https://help.ubuntu.com/community/UnityLaunchersAndDesktopFiles#Adding_shortcuts_to_a_launcher diff --git a/docs/tutorial/devtools-extension-ko.md b/docs/tutorial/devtools-extension-ko.md new file mode 100644 index 000000000000..8642e30441ce --- /dev/null +++ b/docs/tutorial/devtools-extension-ko.md @@ -0,0 +1,46 @@ +# 개발자 콘솔 확장 + +어플리케이션의 디버깅을 쉽게 하기 위해, Electron은 기본적으로 [Chrome DevTools Extension][devtools-extension]을 지원합니다. + +개발자 콘솔 확장기능은 간단하게 사용할 확장기능 플러그인의 소스코드를 다운로드한 후 `BrowserWindow.addDevToolsExtension` API를 이용하여 +어플리케이션 내에 로드할 수 있습니다. 한가지 주의할 점은 확장기능 사용시 창이 생성될 때 마다 일일이 해당 API를 호출할 필요는 없습니다. + +예시로 [React DevTools Extension](https://github.com/facebook/react-devtools)을 사용하자면, 먼저 소스코드를 다운로드 받아야합니다: + +```bash +$ cd /some-directory +$ git clone --recursive https://github.com/facebook/react-devtools.git +``` + +그리고 개발자 콘솔이 열린 창에서 다음의 코드를 콘솔에 입력하면 확장기능을 로드할 수 있습니다: + +```javascript +require('remote').require('browser-window').addDevToolsExtension('/some-directory/react-devtools'); +``` + +확장기능을 unload 하려면, `BrowserWindow.removeDevToolsExtension` API를 사용하여 다음에 콘솔을 다시 열 때 해당 확장기능이 로드되지 않도록 할 수 있습니다: + +```javascript +require('remote').require('browser-window').removeDevToolsExtension('React Developer Tools'); +``` + +## 개발자 콘솔 확장기능의 구성 형식 + +완벽하게 모든 개발자 콘솔 확장은 Chrome 브라우저를 위해 작성되었기 때문에 Electron에서도 로드할 수 있습니다. +하지만 반드시 확장기능은 소스코드 그대로의 디렉터리(폴더) 형태여야 합니다. 그래서 `crx` 등의 포맷으로 패키징된 확장기능의 경우 +사용자가 직접 해당 패키지의 압축을 풀어서 로드하지 않는 이상은 Electron에서 해당 확장기능의 압축을 풀 방법이 없습니다. + +## 백그라운드 페이지 + +현재 Electron은 Chrome에서 지원하는 백그라운드 페이지(background pages)를 지원하지 않습니다. +몇몇 확장기능은 이 기능에 의존하는 경우가 있는데, 이 경우 해당 확장기능은 Electron에서 작동하지 않을 수 있습니다. + +## `chrome.*` API + +몇몇 Chrome 확장기능은 특정 기능을 사용하기 위해 `chrome.*` API를 사용하는데, Electron에선 이 API들을 구현하기 위해 노력했지만, +안타깝게도 아직 모든 API가 구현되지는 않았습니다. + +아직 모든 API가 구현되지 않았기 때문에 확장기능에서 `chrome.devtools.*` 대신 `chrome.*` API를 사용할 경우 확장기능이 제대로 작동하지 않을 수 있음을 감안해야 합니다. +만약 문제가 발생할 경우 Electron의 GitHub repo에 이슈를 올리면 해당 API를 추가하는데 많은 도움이 됩니다. + +[devtools-extension]: https://developer.chrome.com/extensions/devtools diff --git a/docs/tutorial/online-offline-events-ko.md b/docs/tutorial/online-offline-events-ko.md new file mode 100644 index 000000000000..bf4a4124c396 --- /dev/null +++ b/docs/tutorial/online-offline-events-ko.md @@ -0,0 +1,80 @@ +# 온라인/오프라인 이벤트 + +온라인/오프라인 이벤트는 다음 예제와 같이 랜더러 프로세스에서 표준 HTML5 API를 이용하여 구현할 수 있습니다. + +_main.js_ + +```javascript +var app = require('app'); +var BrowserWindow = require('browser-window'); +var onlineStatusWindow; + +app.on('ready', function() { + onlineStatusWindow = new BrowserWindow({ width: 0, height: 0, show: false }); + onlineStatusWindow.loadUrl('file://' + __dirname + '/online-status.html'); +}); +``` + +_online-status.html_ + +```html + + + + + + +``` + +필요하다면, 이러한 이벤트를 메인 프로세스로 보낼 수도 있습니다. +메인 프로세스는 `navigator` 오브젝트를 가지고 있지 않기 때문에 이 이벤트를 직접 사용할 수 없습니다. +이는 다음 예제와 같이 electron의 inter-process communication(ipc)유틸리티를 사용하여 +이벤트를 메인 프로세스로 전달하는 것으로 해결할 수 있습니다. + +_main.js_ + +```javascript +var app = require('app'); +var ipc = require('ipc'); +var BrowserWindow = require('browser-window'); +var onlineStatusWindow; + +app.on('ready', function() { + onlineStatusWindow = new BrowserWindow({ width: 0, height: 0, show: false }); + onlineStatusWindow.loadUrl('file://' + __dirname + '/online-status.html'); +}); + +ipc.on('online-status-changed', function(event, status) { + console.log(status); +}); +``` + +_online-status.html_ + +```html + + + + + + +``` diff --git a/docs/tutorial/quick-start-ko.md b/docs/tutorial/quick-start-ko.md new file mode 100644 index 000000000000..9cd5f51230f2 --- /dev/null +++ b/docs/tutorial/quick-start-ko.md @@ -0,0 +1,145 @@ +# 시작하기 + +## 소개 + +Electron은 자바스크립트와 함께 제공되는 풍부한 네이티브 API를 이용하여 데스크톱 어플리케이션을 만들 수 있도록 해주는 프레임워크입니다. +이 프레임워크의 io.js(node.js)는 웹 서버 개발이 아닌 데스크톱 어플리케이션 개발에 초점을 맞췄습니다. + +이것은 Electron이 GUI 라이브러리의 자바스크립트 바인딩이라는 뜻이 아닙니다. +대신에, Electron은 웹 페이지의 GUI를 사용합니다. 쉽게 말해 Electron은 자바스크립트를 사용하여 조작하는 작은 Chromium + 브라우저로 볼 수 있습니다. + +### 메인 프로세스 + +Electron은 실행될 때 __메인 프로세스__ 로 불리는 `package.json`의 `main` 스크립트를 호출합니다. +이 스크립트는 메인 프로세스에서 작동합니다, GUI 컴포넌트를 컨트롤하거나 웹 페이지 창을 생성할 수 있습니다. + +### 랜더러 프로세스 + +Electron이 웹페이지를 보여줄 때, Chromium의 multi-processes 구조도 같이 사용됩니다. +Electron 프로세스 내에서 작동하는 웹 페이지는 __랜더러 프로세스__ 라고 불립니다. + +보통, 일반 브라우저의 웹 페이지들은 샌드박스가 적용된 환경에서 작동하며 네이티브 리소스에는 접근할 수 없도록 되어 있습니다. +하지만 Electron은 웹 페이지 내에서 io.js(node.js) API를 사용하여 low-level 수준으로 운영체제와 상호작용할 수 있습니다. + +### 메인 프로세스와 랜더러 프로세스의 차이점 + +메인 프로세스는 `BrowserWindow` Class를 이용하여 창을 만들 수 있습니다. `BrowserWindow` 인스턴스는 +따로 분리된 프로세스에서 랜더링 되며, `BrowserWindow` 인스턴스가 소멸할 때, 해당하는 랜더러 프로세스도 같이 소멸합니다. + +메인 프로세스는 모든 웹 페이지와 그에 해당하는 랜더러 프로세스를 관리하며, +랜더러 프로세스는 각각의 프로세스에 고립되며 웹 페이지의 작동에만 영향을 끼칩니다. + +웹 페이지 내에서 네이티브 GUI 리소스를 관리하는 것은 매우 위험하고, +리소스를 누수시킬 수 있기 때문에 웹 페이지 내에서는 네이티브 GUI와 관련된 API를 호출할 수 없도록 되어 있습니다. +만약 웹 페이지 내에서 GUI작업이 필요하다면, 메인 프로세스에서 그 작업을 할 수 있도록 통신을 해야합니다. + +Electron에는 메인 프로세스와 랜더러 프로세스간에 통신을 할 수 있도록 [ipc](../api/ipc-renderer-ko.md) 모듈을 제공하고 있습니다. +또한 [remote](../api/remote-ko.md) 모듈을 사용하여 RPC 스타일로 통신할 수도 있습니다. + +## 나의 첫번째 Electron 앱 만들기 + +보통, Electron 앱은 다음과 같은 폴더 구조를 가집니다: + +```text +your-app/ +├── package.json +├── main.js +└── index.html +``` + +`package.json`은 node 모듈의 package.json과 같습니다, 그리고 `main` 필드를 지정하여 +메인 프로세스로 사용할 어플리케이션 시작점을 정의할 수 있습니다. +예를 들어 사용할 수 있는 `package.json`은 다음과 같습니다: + +```json +{ + "name" : "your-app", + "version" : "0.1.0", + "main" : "main.js" +} +``` + +`main.js`에서 창을 만들거나 시스템 이벤트를 처리할 수 있습니다, 대표적인 예제로 다음과 같이 작성할 수 있습니다: + +```javascript +var app = require('app'); // 어플리케이션 기반을 조작 하는 모듈. +var BrowserWindow = require('browser-window'); // 네이티브 브라우저 창을 만드는 모듈. + +// Electron 개발자에게 crash-report를 보냄. +require('crash-reporter').start(); + +// 윈도우 객체를 전역에 유지합니다, 만약 이렇게 하지 않으면, +// 자바스크립트 GC가 일어날 때 창이 자동으로 닫혀버립니다. +var mainWindow = null; + +// 모든 창이 닫히면 어플리케이션 종료. +app.on('window-all-closed', function() { + if (process.platform != 'darwin') { + app.quit(); + } +}); + +// 이 메서드는 Electron의 초기화가 모두 끝나고 +// 브라우저 창을 열 준비가 되었을 때 호출됩니다. +app.on('ready', function() { + // 새로운 브라우저 창을 생성합니다. + mainWindow = new BrowserWindow({width: 800, height: 600}); + + // 그리고 현재 디렉터리의 index.html을 로드합니다. + mainWindow.loadUrl('file://' + __dirname + '/index.html'); + + // 개발자 콘솔을 엽니다. + mainWindow.openDevTools(); + + // 창이 닫히면 호출됩니다. + mainWindow.on('closed', function() { + // 윈도우 객체의 참조를 삭제합니다, 보통 멀티 윈도우 지원을 위해 + // 윈도우 객체를 배열에 저장하는 경우가 있는데, 이 경우 + // 해당하는 모든 윈도우 객체의 참조를 삭제해 주어야 합니다. + mainWindow = null; + }); +}); +``` + +마지막으로, 사용자에게 보여줄 `index.html` 웹 페이지의 예제입니다: + +```html + + + + 헬로 월드! + + +

헬로 월드!

+ 우리는 io.js 버전과 + Electron 버전을 사용합니다. + + +``` + +## 앱 실행하기 + +앱을 작성한 후, [어플리케이션 배포](./application-distribution-ko.md) 가이드를 따라 앱을 패키징 하고 +패키징한 앱을 실행해 볼 수 있습니다. 또한 Electron 실행파일을 다운로드 받아 바로 실행해 볼 수도 있습니다. + +Windows의 경우: + +```bash +$ .\electron\electron.exe your-app\ +``` + +Linux의 경우: + +```bash +$ ./electron/electron your-app/ +``` + +OS X의 경우: + +```bash +$ ./Electron.app/Contents/MacOS/Electron your-app/ +``` + +앱 실행파일은 `Electron`의 release 패키지에 포함되어 있습니다. +[여기](https://github.com/atom/electron/releases)에서 다운로드 받을 수 있습니다. diff --git a/docs/tutorial/using-native-node-modules-ko.md b/docs/tutorial/using-native-node-modules-ko.md new file mode 100644 index 000000000000..c36346b6536f --- /dev/null +++ b/docs/tutorial/using-native-node-modules-ko.md @@ -0,0 +1,56 @@ +# 네이티브 node 모듈 사용하기 + +__역자주: 현재 Electron은 node.js대신 io.js를 사용합니다. 문서에 기재된 버전과 다를 수 있습니다__ + +Electron에선 node.js 네이티브 모듈이 지원됩니다. 하지만 Electron은 공식 node.js의 V8 엔진과는 달리 다른 V8 버전을 사용합니다. +그런 이유로 네이티브 모듈을 사용하기 위해선 Electron의 V8 버전에 맞춰 네이티브 모듈을 다시 빌드하고 헤더를 변경해야 합니다. + +## 네이티브 node 모듈 호환성 + +Node v0.11.x 버전부터는 V8 API의 중대한 변경이 있었습니다. 하지만 일반적으로 모든 네이티브 모듈은 Node v0.10.x 버전을 타겟으로 작성 되었기 때문에 +Node v0.11.x 버전에선 작동하지 않습니다. Electron은 내부적으로 Node v0.11.13 버전을 사용합니다. 그래서 위에서 설명한 문제가 발생합니다. + +이 문제를 해결하기 위해, 모듈이 Node v0.11.x 버전을 지원할 수 있도록 해야합니다. +현재 [많은 모듈들](https://www.npmjs.org/browse/depended/nan)이 안정적으로 두 버전 모두 지원하고 있지만, +오래된 모듈의 경우 Node v0.10.x 버전만을 지원하고 있습니다. +예를들어 [nan](https://github.com/rvagg/nan) 모듈을 사용해야 하는 경우, Node v0.11.x 버전으로 포팅 할 필요가 있습니다. + +## 네이티브 모듈 설치하는 방법 + +### 쉬운 방법 - 권장 + +[`electron-rebuild`](https://github.com/paulcbetts/electron-rebuild) 패키지를 사용하면 아주 빠르고 정확하게 네이티브 모듈을 다시 빌드할 수 있습니다. +다음의 간단한 절차를 통해 자동으로 헤더를 다운로드하고 네이티브 모듈을 빌드할 수 있습니다: + +```sh +npm install --save-dev electron-rebuild + +# 필요한 네이티브 모듈을 `npm install`로 설치한 후 다음 작업을 실행하세요: +./node_modules/.bin/electron-rebuild +``` + +### node-gyp을 이용한 방법 + +Node 모듈을 `node-gyp`를 사용하여 Electron을 타겟으로 빌드할 땐, `node-gyp`에 헤더 다운로드 주소와 버전을 알려주어야합니다: + +```bash +$ cd /path-to-module/ +$ HOME=~/.electron-gyp node-gyp rebuild --target=0.25.0 --arch=ia64 --dist-url=https://atom.io/download/atom-shell +``` + + + +`HOME=~/.electron-gyp`은 변경할 헤더의 위치를 찾습니다. `--target=0.25.0`은 Electron의 버전입니다. +`--dist-url=...`은 헤더를 다운로드 하는 주소입니다. `--arch=ia64`는 64비트 시스템을 타겟으로 빌드 한다는 것을 `node-gyp`에게 알려줍니다. + +### npm을 이용한 방법 + +또한 `npm`을 사용하여 모듈을 설치할 수도 있습니다. +환경변수가 필요한 것을 제외하고는 일반 Node 모듈을 설치하는 방법과 완전히 똑같습니다: + +```bash +export npm_config_disturl=https://atom.io/download/atom-shell +export npm_config_target=0.25.0 +export npm_config_arch=x64 +HOME=~/.electron-gyp npm install module-name +``` diff --git a/docs/tutorial/using-pepper-flash-plugin-ko.md b/docs/tutorial/using-pepper-flash-plugin-ko.md new file mode 100644 index 000000000000..92dce61716ef --- /dev/null +++ b/docs/tutorial/using-pepper-flash-plugin-ko.md @@ -0,0 +1,59 @@ +# Pepper ÷ ÷ ϱ + +ʿϴٸ Pepper ÷ ÷ ֽϴ. Electron pepper ÷ ÷ ϱ ؼ, pepper ÷ ÷ ġ ־մϴ. + +## ÷ ÷ غϱ + +ũ `chrome://plugins` `` ÷ ÷ ġ ã ֽϴ. +Electron ÷ ÷ ϱ ؼ ; մϴ. + +## Electron ġ ߰ + +÷ ϱ `--ppapi-flash-path` `ppapi-flash-version` ÷׸ ready ̺Ʈ ȣDZ ߰ؾմϴ. +׸ `browser-window` `plugins` ġ ߰ؾմϴ. + +```javascript +var app = require('app'); +var BrowserWindow = require('browser-window'); + +// Report crashes to our server. +require('crash-reporter').start(); + +// Keep a global reference of the window object, if you don't, the window will +// be closed automatically when the javascript object is GCed. +var mainWindow = null; + +// Quit when all windows are closed. +app.on('window-all-closed', function() { + if (process.platform != 'darwin') { + app.quit(); + } +}); + +// ÷ ÷ ġ մϴ. +// Windows , /path/to/pepflashplayer.dll +// Mac , /path/to/PepperFlashPlayer.plugin +// Linux , /path/to/libpepflashplayer.so +app.commandLine.appendSwitch('ppapi-flash-path', '/path/to/libpepflashplayer.so'); + +// Specify flash version, for example, v17.0.0.169 +app.commandLine.appendSwitch('ppapi-flash-version', '17.0.0.169'); + +app.on('ready', function() { + mainWindow = new BrowserWindow({ + 'width': 800, + 'height': 600, + 'web-preferences': { + 'plugins': true + } + }); + mainWindow.loadUrl('file://' + __dirname + '/index.html'); + // Something else +}); +``` + +## `` ±׸ ̿Ͽ ÷ Ȱȭ +`plugins` Ӽ `` ±׿ ߰մϴ. +```html + +``` diff --git a/docs/tutorial/using-selenium-and-webdriver-ko.md b/docs/tutorial/using-selenium-and-webdriver-ko.md new file mode 100644 index 000000000000..ddd391653879 --- /dev/null +++ b/docs/tutorial/using-selenium-and-webdriver-ko.md @@ -0,0 +1,74 @@ +# Selenium 과 WebDriver 사용하기 + +[ChromeDriver - WebDriver for Chrome][chrome-driver]로 부터 인용: + +> WebDriver는 많은 브라우저에서 웹 앱을 자동적으로 테스트하는 툴입니다. +> 이 툴은 웹 페이지를 자동으로 탐색하고, 유저 폼을 사용하거나, 자바스크립트를 실행하는 등의 작업을 수행할 수 있습니다. +> ChromeDriver는 Chromium의 WebDriver wire 프로토콜 스텐드얼론 서버 구현입니다. +> Chromium 과 WebDriver 팀 멤버에 의해 개발되었습니다. + +Electron의 [releases](https://github.com/atom/electron/releases) 페이지에서 `chromedriver` 릴리즈 압축파일을 찾을 수 있습니다. +`chromedriver`의 Electron 배포판과 upstream과의 차이는 없습니다. +`chromedriver`와 Electron을 함께 사용하려면, 몇가지 설정이 필요합니다. + +또한 releases에는 `chromedriver`를 포함하여 주 버전만 업데이트 됩니다. (예시: `vX.X.0` releases) +왜냐하면 `chromedriver`는 Electron 자체에서 자주 업데이트하지 않기 때문입니다. + +## WebDriverJs 설정하기 + +[WebDriverJs](https://code.google.com/p/selenium/wiki/WebDriverJs)는 WebDriver를 사용하여 테스팅 할 수 있도록 도와주는 node 패키지입니다. +다음 예제를 참고하세요: + +### 1. 크롬 드라이버 시작 + +먼저, `chromedriver` 바이너리를 다운로드 받고 실행합니다: + +```bash +$ ./chromedriver +Starting ChromeDriver (v2.10.291558) on port 9515 +Only local connections are allowed. +``` + +포트 `9515`를 기억하세요, 나중에 사용합니다 + +### 2. WebDriverJS 설치 + +```bash +$ npm install selenium-webdriver +``` + +### 3. 크롬 드라이버에 연결 + +`selenium-webdriver`를 Electron과 같이 사용할 땐 기본적으로 upstream과 같습니다. +한가지 다른점이 있다면 수동으로 크롬 드라이버 연결에 대해 설정하고 , Electron 실행파일의 위치를 전달합니다: + +```javascript +var webdriver = require('selenium-webdriver'); + +var driver = new webdriver.Builder() + // 작동하고 있는 크롬 드라이버의 포트 "9515"를 사용합니다. + .usingServer('http://localhost:9515') + .withCapabilities({chromeOptions: { + // 여기에 사용중인 Electron 바이너리의 경로를 기재하세요. + binary: '/Path-to-Your-App.app/Contents/MacOS/Atom'}}) + .forBrowser('electron') + .build(); + +driver.get('http://www.google.com'); +driver.findElement(webdriver.By.name('q')).sendKeys('webdriver'); +driver.findElement(webdriver.By.name('btnG')).click(); +driver.wait(function() { + return driver.getTitle().then(function(title) { + return title === 'webdriver - Google Search'; + }); +}, 1000); + +driver.quit(); +``` + +## 작업환경 + +따로 Electron을 다시 빌드하지 않는다면, 간단히 어플리케이션을 Electron의 리소스 디렉터리에 +[배치](https://github.com/atom/electron/blob/master/docs/tutorial/application-distribution-ko.md)하여 바로 테스트 할 수 있습니다. + +[chrome-driver]: https://sites.google.com/a/chromium.org/chromedriver/ From f51103f44a539d519f308c9d281d56ecc9b6dfe8 Mon Sep 17 00:00:00 2001 From: Rich Hong Date: Mon, 22 Jun 2015 19:38:47 -0400 Subject: [PATCH 0339/1293] Update internalModuleReadFile to support unpacked asar files Add tests for reading unpacked files using both fs.readFileSync and internalModuleReadFile --- atom/common/lib/asar.coffee | 4 ++++ spec/asar-spec.coffee | 19 +++++++++++++++++++ 2 files changed, 23 insertions(+) diff --git a/atom/common/lib/asar.coffee b/atom/common/lib/asar.coffee index ee6d18e4358f..900a686d44a2 100644 --- a/atom/common/lib/asar.coffee +++ b/atom/common/lib/asar.coffee @@ -323,6 +323,10 @@ exports.wrapFsWithAsar = (fs) -> return undefined unless info return '' if info.size is 0 + if info.unpacked + realPath = archive.copyFileOut filePath + return fs.readFileSync realPath, encoding: 'utf8' + buffer = new Buffer(info.size) fd = archive.getFd() retrun undefined unless fd >= 0 diff --git a/spec/asar-spec.coffee b/spec/asar-spec.coffee index 3ad706b69e5a..977676a1936a 100644 --- a/spec/asar-spec.coffee +++ b/spec/asar-spec.coffee @@ -45,6 +45,10 @@ describe 'asar package', -> assert /ENOENT/.test e async = true + it 'reads a normal file with unpacked files', -> + p = path.join fixtures, 'asar', 'unpack.asar', 'a.txt' + assert.equal fs.readFileSync(p).toString(), 'a\n' + describe 'fs.readFile', -> it 'reads a normal file', (done) -> p = path.join fixtures, 'asar', 'a.asar', 'file1' @@ -372,6 +376,21 @@ describe 'asar package', -> done() child.send file + describe 'internalModuleReadFile', -> + internalModuleReadFile = process.binding('fs').internalModuleReadFile + + it 'read a normal file', -> + file1 = path.join fixtures, 'asar', 'a.asar', 'file1' + assert.equal internalModuleReadFile(file1).toString(), 'file1\n' + file2 = path.join fixtures, 'asar', 'a.asar', 'file2' + assert.equal internalModuleReadFile(file2).toString(), 'file2\n' + file3 = path.join fixtures, 'asar', 'a.asar', 'file3' + assert.equal internalModuleReadFile(file3).toString(), 'file3\n' + + it 'reads a normal file with unpacked files', -> + p = path.join fixtures, 'asar', 'unpack.asar', 'a.txt' + assert.equal internalModuleReadFile(p).toString(), 'a\n' + describe 'asar protocol', -> url = require 'url' remote = require 'remote' From 1ce86b6dfc677d9d3348b5fc9ab20ccd199d62eb Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 23 Jun 2015 10:18:43 +0800 Subject: [PATCH 0340/1293] win: Fix building, close #2018 --- atom/browser/api/atom_api_cookies.cc | 2 +- atom/browser/api/atom_api_protocol.cc | 2 +- atom/browser/api/atom_api_session.cc | 2 +- common.gypi | 4 +++- script/upload.py | 4 ---- 5 files changed, 6 insertions(+), 8 deletions(-) diff --git a/atom/browser/api/atom_api_cookies.cc b/atom/browser/api/atom_api_cookies.cc index be11df8888c5..27abfcc65f58 100644 --- a/atom/browser/api/atom_api_cookies.cc +++ b/atom/browser/api/atom_api_cookies.cc @@ -343,7 +343,7 @@ mate::ObjectTemplateBuilder Cookies::GetObjectTemplateBuilder( mate::Handle Cookies::Create( v8::Isolate* isolate, content::BrowserContext* browser_context) { - return CreateHandle(isolate, new Cookies(browser_context)); + return mate::CreateHandle(isolate, new Cookies(browser_context)); } } // namespace api diff --git a/atom/browser/api/atom_api_protocol.cc b/atom/browser/api/atom_api_protocol.cc index bb937905004c..0b7a5cfa7c34 100644 --- a/atom/browser/api/atom_api_protocol.cc +++ b/atom/browser/api/atom_api_protocol.cc @@ -354,7 +354,7 @@ void Protocol::EmitEventInUI(const std::string& event, // static mate::Handle Protocol::Create( v8::Isolate* isolate, AtomBrowserContext* browser_context) { - return CreateHandle(isolate, new Protocol(browser_context)); + return mate::CreateHandle(isolate, new Protocol(browser_context)); } } // namespace api diff --git a/atom/browser/api/atom_api_session.cc b/atom/browser/api/atom_api_session.cc index 744accd7d1cd..18806ebf41f3 100644 --- a/atom/browser/api/atom_api_session.cc +++ b/atom/browser/api/atom_api_session.cc @@ -41,7 +41,7 @@ mate::ObjectTemplateBuilder Session::GetObjectTemplateBuilder( mate::Handle Session::Create( v8::Isolate* isolate, content::BrowserContext* browser_context) { - return CreateHandle(isolate, new Session(browser_context)); + return mate::CreateHandle(isolate, new Session(browser_context)); } } // namespace api diff --git a/common.gypi b/common.gypi index 14b89393a534..8ecf77e58bf9 100644 --- a/common.gypi +++ b/common.gypi @@ -38,15 +38,16 @@ 'target_conditions': [ ['_target_name in ["libuv", "http_parser", "openssl", "cares", "node", "zlib"]', { 'msvs_disabled_warnings': [ - 4703, # potentially uninitialized local pointer variable 'req' used 4013, # 'free' undefined; assuming extern returning int 4018, # signed/unsigned mismatch 4054, # + 4055, # 'type cast' : from data pointer 'void *' to function pointer 4057, # 'function' : 'volatile LONG *' differs in indirection to slightly different base types from 'unsigned long *' 4189, # 4131, # uses old-style declarator 4133, # incompatible types 4146, # unary minus operator applied to unsigned type, result still unsigned + 4164, # intrinsic function not declared 4152, # function/data pointer conversion in expression 4206, # translation unit is empty 4204, # non-constant aggregate initializer @@ -58,6 +59,7 @@ 4389, # '==' : signed/unsigned mismatch 4505, # unreferenced local function has been removed 4701, # potentially uninitialized local variable 'sizew' used + 4703, # potentially uninitialized local pointer variable 'req' used 4706, # assignment within conditional expression 4804, # unsafe use of type 'bool' in operation 4996, # this function or variable may be unsafe. diff --git a/script/upload.py b/script/upload.py index 281300554ef3..931eb92f7e06 100755 --- a/script/upload.py +++ b/script/upload.py @@ -85,10 +85,6 @@ def main(): os.path.join(DIST_DIR, MKSNAPSHOT_NAME)) if PLATFORM == 'win32': - # Upload PDBs to Windows symbol server. - execute([sys.executable, - os.path.join(SOURCE_ROOT, 'script', 'upload-windows-pdb.py')]) - # Upload node headers. execute([sys.executable, os.path.join(SOURCE_ROOT, 'script', 'upload-node-headers.py'), From b3905e867e710764a5aa648053a8addd6478abb8 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 23 Jun 2015 14:22:17 +0800 Subject: [PATCH 0341/1293] Bump v0.28.3 --- atom.gyp | 2 +- atom/browser/resources/mac/Info.plist | 2 +- atom/browser/resources/win/atom.rc | 8 ++++---- atom/common/atom_version.h | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/atom.gyp b/atom.gyp index 14e96d90b37a..423c59e862e5 100644 --- a/atom.gyp +++ b/atom.gyp @@ -4,7 +4,7 @@ 'product_name%': 'Electron', 'company_name%': 'GitHub, Inc', 'company_abbr%': 'github', - 'version%': '0.28.2', + 'version%': '0.28.3', 'atom_source_root': 'CFBundleIconFile atom.icns CFBundleVersion - 0.28.2 + 0.28.3 LSMinimumSystemVersion 10.8.0 NSMainNibFile diff --git a/atom/browser/resources/win/atom.rc b/atom/browser/resources/win/atom.rc index ab4a871b959f..4d10a902fe8e 100644 --- a/atom/browser/resources/win/atom.rc +++ b/atom/browser/resources/win/atom.rc @@ -50,8 +50,8 @@ END // VS_VERSION_INFO VERSIONINFO - FILEVERSION 0,28,2,0 - PRODUCTVERSION 0,28,2,0 + FILEVERSION 0,28,3,0 + PRODUCTVERSION 0,28,3,0 FILEFLAGSMASK 0x3fL #ifdef _DEBUG FILEFLAGS 0x1L @@ -68,12 +68,12 @@ BEGIN BEGIN VALUE "CompanyName", "GitHub, Inc." VALUE "FileDescription", "Electron" - VALUE "FileVersion", "0.28.2" + VALUE "FileVersion", "0.28.3" VALUE "InternalName", "electron.exe" VALUE "LegalCopyright", "Copyright (C) 2015 GitHub, Inc. All rights reserved." VALUE "OriginalFilename", "electron.exe" VALUE "ProductName", "Electron" - VALUE "ProductVersion", "0.28.2" + VALUE "ProductVersion", "0.28.3" VALUE "SquirrelAwareVersion", "1" END END diff --git a/atom/common/atom_version.h b/atom/common/atom_version.h index 809d02cb2285..8b5cc05efc39 100644 --- a/atom/common/atom_version.h +++ b/atom/common/atom_version.h @@ -7,7 +7,7 @@ #define ATOM_MAJOR_VERSION 0 #define ATOM_MINOR_VERSION 28 -#define ATOM_PATCH_VERSION 2 +#define ATOM_PATCH_VERSION 3 #define ATOM_VERSION_IS_RELEASE 1 From 89c7028ed1fb91f341f4b30ddc3b740067f5d158 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 23 Jun 2015 16:09:34 +0800 Subject: [PATCH 0342/1293] Don't include routing ID in WebContents's ID --- atom/browser/api/lib/web-contents.coffee | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/atom/browser/api/lib/web-contents.coffee b/atom/browser/api/lib/web-contents.coffee index 8855b6d35f5f..67f106f6bb86 100644 --- a/atom/browser/api/lib/web-contents.coffee +++ b/atom/browser/api/lib/web-contents.coffee @@ -25,7 +25,7 @@ wrapWebContents = (webContents) -> webContents.once 'did-finish-load', @_executeJavaScript.bind(this, code) # The processId and routingId and identify a webContents. - webContents.getId = -> "#{@getProcessId()}-#{@getRoutingId()}" + webContents.getId = -> @getProcessId() webContents.equal = (other) -> @getId() is other.getId() # The navigation controller. From 52789ab96ff46a4d4db491e54e354f61e868878f Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 23 Jun 2015 16:16:10 +0800 Subject: [PATCH 0343/1293] Implement getId in C++ --- atom/browser/api/atom_api_web_contents.cc | 20 ++++++++++---------- atom/browser/api/atom_api_web_contents.h | 4 ++-- atom/browser/api/lib/web-contents.coffee | 4 ---- 3 files changed, 12 insertions(+), 16 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 8b26b724fa06..3db913382b7a 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -453,6 +453,14 @@ bool WebContents::IsAlive() const { return web_contents() != NULL; } +int WebContents::GetID() const { + return web_contents()->GetRenderProcessHost()->GetID(); +} + +bool WebContents::Equal(const WebContents* web_contents) const { + return GetID() == web_contents->GetID(); +} + void WebContents::LoadURL(const GURL& url, const mate::Dictionary& options) { content::NavigationController::LoadURLParams params(url); @@ -506,14 +514,6 @@ void WebContents::GoToOffset(int offset) { web_contents()->GetController().GoToOffset(offset); } -int WebContents::GetRoutingID() const { - return web_contents()->GetRoutingID(); -} - -int WebContents::GetProcessID() const { - return web_contents()->GetRenderProcessHost()->GetID(); -} - bool WebContents::IsCrashed() const { return web_contents()->IsCrashed(); } @@ -770,6 +770,8 @@ mate::ObjectTemplateBuilder WebContents::GetObjectTemplateBuilder( template_.Reset(isolate, mate::ObjectTemplateBuilder(isolate) .SetMethod("destroy", &WebContents::Destroy) .SetMethod("isAlive", &WebContents::IsAlive) + .SetMethod("getId", &WebContents::GetID) + .SetMethod("equal", &WebContents::Equal) .SetMethod("_loadUrl", &WebContents::LoadURL) .SetMethod("getTitle", &WebContents::GetTitle) .SetMethod("isLoading", &WebContents::IsLoading) @@ -779,8 +781,6 @@ mate::ObjectTemplateBuilder WebContents::GetObjectTemplateBuilder( .SetMethod("_goBack", &WebContents::GoBack) .SetMethod("_goForward", &WebContents::GoForward) .SetMethod("_goToOffset", &WebContents::GoToOffset) - .SetMethod("getRoutingId", &WebContents::GetRoutingID) - .SetMethod("getProcessId", &WebContents::GetProcessID) .SetMethod("isCrashed", &WebContents::IsCrashed) .SetMethod("setUserAgent", &WebContents::SetUserAgent) .SetMethod("insertCSS", &WebContents::InsertCSS) diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index 31f54134afac..a2bfda874cbd 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -68,6 +68,8 @@ class WebContents : public mate::EventEmitter, void Destroy(); bool IsAlive() const; + int GetID() const; + bool Equal(const WebContents* web_contents) const; void LoadURL(const GURL& url, const mate::Dictionary& options); base::string16 GetTitle() const; bool IsLoading() const; @@ -77,8 +79,6 @@ class WebContents : public mate::EventEmitter, void GoBack(); void GoForward(); void GoToOffset(int offset); - int GetRoutingID() const; - int GetProcessID() const; bool IsCrashed() const; void SetUserAgent(const std::string& user_agent); void InsertCSS(const std::string& css); diff --git a/atom/browser/api/lib/web-contents.coffee b/atom/browser/api/lib/web-contents.coffee index 67f106f6bb86..38e6caaaa6e8 100644 --- a/atom/browser/api/lib/web-contents.coffee +++ b/atom/browser/api/lib/web-contents.coffee @@ -24,10 +24,6 @@ wrapWebContents = (webContents) -> else webContents.once 'did-finish-load', @_executeJavaScript.bind(this, code) - # The processId and routingId and identify a webContents. - webContents.getId = -> @getProcessId() - webContents.equal = (other) -> @getId() is other.getId() - # The navigation controller. controller = new NavigationController(webContents) for name, method of NavigationController.prototype when method instanceof Function From 2d65c3bcd0a6d5e987ece2555531fb1b2eb60507 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 23 Jun 2015 16:19:12 +0800 Subject: [PATCH 0344/1293] Clean up SetAllowTransparency --- atom/browser/api/atom_api_web_contents.cc | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 3db913382b7a..d4dd40b81470 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -745,18 +745,15 @@ void WebContents::SetAllowTransparency(bool allow) { if (guest_opaque_ != allow) return; + auto render_view_host = web_contents()->GetRenderViewHost(); guest_opaque_ = !allow; - if (!web_contents()->GetRenderViewHost()->GetView()) + if (!render_view_host->GetView()) return; if (guest_opaque_) { - web_contents() - ->GetRenderViewHost() - ->GetView() - ->SetBackgroundColorToDefault(); + render_view_host->GetView()->SetBackgroundColorToDefault(); } else { - web_contents()->GetRenderViewHost()->GetView()->SetBackgroundColor( - SK_ColorTRANSPARENT); + render_view_host->GetView()->SetBackgroundColor(SK_ColorTRANSPARENT); } } From 015ef3e0140aa4080a3d3628f33cb1fdc675df5f Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 23 Jun 2015 16:34:22 +0800 Subject: [PATCH 0345/1293] Omit extra transfer of new-window event --- atom/browser/api/atom_api_web_contents.cc | 23 +++++++++++++++----- atom/browser/api/atom_api_window.cc | 2 +- atom/browser/api/lib/web-contents.coffee | 11 ---------- atom/browser/lib/guest-window-manager.coffee | 2 +- 4 files changed, 20 insertions(+), 18 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index d4dd40b81470..e87219d3710e 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -90,6 +90,22 @@ struct Converter { } }; +template<> +struct Converter { + static v8::Local ToV8(v8::Isolate* isolate, + WindowOpenDisposition val) { + std::string disposition = "other"; + switch (val) { + case CURRENT_TAB: disposition = "default"; break; + case NEW_FOREGROUND_TAB: disposition = "foreground-tab"; break; + case NEW_BACKGROUND_TAB: disposition = "background-tab"; break; + case NEW_POPUP: case NEW_WINDOW: disposition = "new-window"; break; + default: break; + } + return mate::ConvertToV8(isolate, disposition); + } +}; + } // namespace mate @@ -187,10 +203,7 @@ bool WebContents::ShouldCreateWebContents( const GURL& target_url, const std::string& partition_id, content::SessionStorageNamespace* session_storage_namespace) { - Emit("-new-window", - target_url, - frame_name, - static_cast(NEW_FOREGROUND_TAB)); + Emit("new-window", target_url, frame_name, NEW_FOREGROUND_TAB); return false; } @@ -202,7 +215,7 @@ content::WebContents* WebContents::OpenURLFromTab( content::WebContents* source, const content::OpenURLParams& params) { if (params.disposition != CURRENT_TAB) { - Emit("-new-window", params.url, "", static_cast(params.disposition)); + Emit("new-window", params.url, "", params.disposition); return nullptr; } diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index 0ad9a329e6cc..f19a353afa8c 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -58,7 +58,7 @@ void Window::WillCreatePopupWindow(const base::string16& frame_name, const GURL& target_url, const std::string& partition_id, WindowOpenDisposition disposition) { - Emit("-new-window", target_url, frame_name, static_cast(disposition)); + Emit("-new-window", target_url, frame_name); } void Window::WillNavigate(bool* prevent_default, const GURL& url) { diff --git a/atom/browser/api/lib/web-contents.coffee b/atom/browser/api/lib/web-contents.coffee index 38e6caaaa6e8..64aaf2bd415c 100644 --- a/atom/browser/api/lib/web-contents.coffee +++ b/atom/browser/api/lib/web-contents.coffee @@ -30,17 +30,6 @@ wrapWebContents = (webContents) -> do (name, method) -> webContents[name] = -> method.apply controller, arguments - # Translate |disposition| to string for 'new-window' event. - webContents.on '-new-window', (args..., disposition) -> - disposition = - switch disposition - when 2 then 'default' - when 4 then 'foreground-tab' - when 5 then 'background-tab' - when 6, 7 then 'new-window' - else 'other' - @emit 'new-window', args..., disposition - # Tell the rpc server that a render view has been deleted and we need to # release all objects owned by it. webContents.on 'render-view-deleted', (event, processId, routingId) -> diff --git a/atom/browser/lib/guest-window-manager.coffee b/atom/browser/lib/guest-window-manager.coffee index 14b0cafe8f53..aef8b0def24d 100644 --- a/atom/browser/lib/guest-window-manager.coffee +++ b/atom/browser/lib/guest-window-manager.coffee @@ -41,7 +41,7 @@ createGuest = (embedder, url, frameName, options) -> # Routed window.open messages. ipc.on 'ATOM_SHELL_GUEST_WINDOW_MANAGER_WINDOW_OPEN', (event, args...) -> [url, frameName, options] = args - event.sender.emit '-new-window', event, url, frameName, 7 + event.sender.emit 'new-window', event, url, frameName, 'new-window' if event.sender.isGuest() or event.defaultPrevented event.returnValue = null else From 1f97cee7c92cede93a6e7730d8a6510eaba0a62e Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 23 Jun 2015 16:43:55 +0800 Subject: [PATCH 0346/1293] Fix release render view with wrong ID --- atom/browser/api/atom_api_web_contents.cc | 4 +--- atom/browser/api/lib/web-contents.coffee | 4 ++-- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index e87219d3710e..85b0e3d8a85c 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -249,9 +249,7 @@ void WebContents::ExitFullscreenModeForTab(content::WebContents* source) { } void WebContents::RenderViewDeleted(content::RenderViewHost* render_view_host) { - Emit("render-view-deleted", - render_view_host->GetProcess()->GetID(), - render_view_host->GetRoutingID()); + Emit("render-view-deleted", render_view_host->GetProcess()->GetID()); } void WebContents::RenderProcessGone(base::TerminationStatus status) { diff --git a/atom/browser/api/lib/web-contents.coffee b/atom/browser/api/lib/web-contents.coffee index 64aaf2bd415c..b635ab2a5f26 100644 --- a/atom/browser/api/lib/web-contents.coffee +++ b/atom/browser/api/lib/web-contents.coffee @@ -32,8 +32,8 @@ wrapWebContents = (webContents) -> # Tell the rpc server that a render view has been deleted and we need to # release all objects owned by it. - webContents.on 'render-view-deleted', (event, processId, routingId) -> - process.emit 'ATOM_BROWSER_RELEASE_RENDER_VIEW', "#{processId}-#{routingId}" + webContents.on 'render-view-deleted', (event, processId) -> + process.emit 'ATOM_BROWSER_RELEASE_RENDER_VIEW', processId # Dispatch IPC messages to the ipc module. webContents.on 'ipc-message', (event, packed) -> From 197a9b4165dfbe954f0154a966acd5d43ccf3dd3 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 23 Jun 2015 17:22:14 +0800 Subject: [PATCH 0347/1293] Remove calls to v8::Isolate::GetCurrent It is generally a bad thing to do since we might have multiple Isolates. --- atom/browser/api/atom_api_cookies.cc | 38 +++++++++++------------ atom/browser/api/atom_api_menu.cc | 7 ++--- atom/browser/api/atom_api_protocol.cc | 7 ++--- atom/browser/api/atom_api_web_contents.cc | 5 ++- atom/browser/api/atom_api_window.cc | 16 +++++----- atom/browser/api/event_emitter.h | 9 +++--- vendor/native_mate | 2 +- 7 files changed, 38 insertions(+), 46 deletions(-) diff --git a/atom/browser/api/atom_api_cookies.cc b/atom/browser/api/atom_api_cookies.cc index 27abfcc65f58..0363032df878 100644 --- a/atom/browser/api/atom_api_cookies.cc +++ b/atom/browser/api/atom_api_cookies.cc @@ -46,18 +46,17 @@ bool GetCookieListFromStore( return true; } -void RunGetCookiesCallbackOnUIThread(const std::string& error_message, +void RunGetCookiesCallbackOnUIThread(v8::Isolate* isolate, + const std::string& error_message, const net::CookieList& cookie_list, const Cookies::CookiesCallback& callback) { DCHECK_CURRENTLY_ON(BrowserThread::UI); - v8::Isolate* isolate = v8::Isolate::GetCurrent(); v8::Locker locker(isolate); v8::HandleScope handle_scope(isolate); if (!error_message.empty()) { - v8::Local error = v8::String::NewFromUtf8(isolate, - error_message.c_str()); + v8::Local error = mate::ConvertToV8(isolate, error_message); callback.Run(error, v8::Null(isolate)); return; } @@ -65,17 +64,16 @@ void RunGetCookiesCallbackOnUIThread(const std::string& error_message, } void RunRemoveCookiesCallbackOnUIThread( + v8::Isolate* isolate, const std::string& error_message, const Cookies::CookiesCallback& callback) { DCHECK_CURRENTLY_ON(BrowserThread::UI); - v8::Isolate* isolate = v8::Isolate::GetCurrent(); v8::Locker locker(isolate); v8::HandleScope handle_scope(isolate); if (!error_message.empty()) { - v8::Local error = v8::String::NewFromUtf8(isolate, - error_message.c_str()); + v8::Local error = mate::ConvertToV8(isolate, error_message); callback.Run(error, v8::Null(isolate)); return; } @@ -83,24 +81,23 @@ void RunRemoveCookiesCallbackOnUIThread( callback.Run(v8::Null(isolate), v8::Null(isolate)); } -void RunSetCookiesCallbackOnUIThread(const std::string& error_message, +void RunSetCookiesCallbackOnUIThread(v8::Isolate* isolate, + const std::string& error_message, bool set_success, const Cookies::CookiesCallback& callback) { DCHECK_CURRENTLY_ON(BrowserThread::UI); - v8::Isolate* isolate = v8::Isolate::GetCurrent(); v8::Locker locker(isolate); v8::HandleScope handle_scope(isolate); if (!error_message.empty()) { - v8::Local error = v8::String::NewFromUtf8(isolate, - error_message.c_str()); + v8::Local error = mate::ConvertToV8(isolate, error_message); callback.Run(error, v8::Null(isolate)); return; } if (!set_success) { - v8::Local error = v8::String::NewFromUtf8(isolate, - "Failed to set cookies"); + v8::Local error = mate::ConvertToV8( + isolate, "Failed to set cookies"); callback.Run(error, v8::Null(isolate)); } @@ -209,8 +206,8 @@ void Cookies::GetCookiesOnIOThread(scoped_ptr filter, base::Bind(&Cookies::OnGetCookies, base::Unretained(this), Passed(&filter), callback))) { BrowserThread::PostTask(BrowserThread::UI, FROM_HERE, - base::Bind(&RunGetCookiesCallbackOnUIThread, "Url is not valid", - net::CookieList(), callback)); + base::Bind(&RunGetCookiesCallbackOnUIThread, isolate(), + "Url is not valid", net::CookieList(), callback)); } } @@ -223,7 +220,7 @@ void Cookies::OnGetCookies(scoped_ptr filter, result.push_back(cookie); } BrowserThread::PostTask(BrowserThread::UI, FROM_HERE, base::Bind( - &RunGetCookiesCallbackOnUIThread, "", result, callback)); + &RunGetCookiesCallbackOnUIThread, isolate(), "", result, callback)); } void Cookies::Remove(const mate::Dictionary& details, @@ -238,7 +235,7 @@ void Cookies::Remove(const mate::Dictionary& details, error_message = "Url is not valid."; } if (!error_message.empty()) { - RunRemoveCookiesCallbackOnUIThread(error_message, callback); + RunRemoveCookiesCallbackOnUIThread(isolate(), error_message, callback); return; } content::BrowserThread::PostTask(BrowserThread::IO, FROM_HERE, @@ -256,7 +253,7 @@ void Cookies::RemoveCookiesOnIOThread(const GURL& url, const std::string& name, void Cookies::OnRemoveCookies(const CookiesCallback& callback) { BrowserThread::PostTask(BrowserThread::UI, FROM_HERE, - base::Bind(&RunRemoveCookiesCallbackOnUIThread, "", callback)); + base::Bind(&RunRemoveCookiesCallbackOnUIThread, isolate(), "", callback)); } void Cookies::Set(const base::DictionaryValue& options, @@ -273,7 +270,7 @@ void Cookies::Set(const base::DictionaryValue& options, } if (!error_message.empty()) { - RunSetCookiesCallbackOnUIThread(error_message, false, callback); + RunSetCookiesCallbackOnUIThread(isolate(), error_message, false, callback); return; } @@ -328,7 +325,8 @@ void Cookies::SetCookiesOnIOThread(scoped_ptr details, void Cookies::OnSetCookies(const CookiesCallback& callback, bool set_success) { BrowserThread::PostTask(BrowserThread::UI, FROM_HERE, - base::Bind(&RunSetCookiesCallbackOnUIThread, "", set_success, callback)); + base::Bind(&RunSetCookiesCallbackOnUIThread, isolate(), "", set_success, + callback)); } mate::ObjectTemplateBuilder Cookies::GetObjectTemplateBuilder( diff --git a/atom/browser/api/atom_api_menu.cc b/atom/browser/api/atom_api_menu.cc index c0704a22d052..1eb5cb31d118 100644 --- a/atom/browser/api/atom_api_menu.cc +++ b/atom/browser/api/atom_api_menu.cc @@ -55,11 +55,10 @@ bool Menu::IsCommandIdVisible(int command_id) const { bool Menu::GetAcceleratorForCommandId(int command_id, ui::Accelerator* accelerator) { - v8::Isolate* isolate = v8::Isolate::GetCurrent(); - v8::Locker locker(isolate); - v8::HandleScope handle_scope(isolate); + v8::Locker locker(isolate()); + v8::HandleScope handle_scope(isolate()); v8::Local val = get_accelerator_.Run(command_id); - return mate::ConvertFromV8(isolate, val, accelerator); + return mate::ConvertFromV8(isolate(), val, accelerator); } void Menu::ExecuteCommand(int command_id, int event_flags) { diff --git a/atom/browser/api/atom_api_protocol.cc b/atom/browser/api/atom_api_protocol.cc index 0b7a5cfa7c34..e298ec790940 100644 --- a/atom/browser/api/atom_api_protocol.cc +++ b/atom/browser/api/atom_api_protocol.cc @@ -67,9 +67,8 @@ class CustomProtocolRequestJob : public AdapterRequestJob { void GetJobTypeInUI() override { DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI)); - v8::Isolate* isolate = v8::Isolate::GetCurrent(); - v8::Locker locker(isolate); - v8::HandleScope handle_scope(isolate); + v8::Locker locker(registry_->isolate()); + v8::HandleScope handle_scope(registry_->isolate()); // Call the JS handler. Protocol::JsProtocolHandler callback = @@ -85,7 +84,7 @@ class CustomProtocolRequestJob : public AdapterRequestJob { return; } else if (result->IsObject()) { v8::Local obj = result->ToObject(); - mate::Dictionary dict(isolate, obj); + mate::Dictionary dict(registry_->isolate(), obj); std::string name = mate::V8ToString(obj->GetConstructorName()); if (name == "RequestStringJob") { std::string mime_type, charset, data; diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 85b0e3d8a85c..420878664d22 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -310,9 +310,8 @@ void WebContents::DidStopLoading() { void WebContents::DidGetResourceResponseStart( const content::ResourceRequestDetails& details) { - v8::Isolate* isolate = v8::Isolate::GetCurrent(); - v8::Locker locker(isolate); - v8::HandleScope handle_scope(isolate); + v8::Locker locker(isolate()); + v8::HandleScope handle_scope(isolate()); base::DictionaryValue response_headers; net::HttpResponseHeaders* headers = details.headers.get(); diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index f19a353afa8c..21c6b327e8db 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -142,20 +142,18 @@ void Window::OnDevToolsFocus() { void Window::OnDevToolsOpened() { Emit("devtools-opened"); - v8::Isolate* isolate = v8::Isolate::GetCurrent(); - v8::Locker locker(isolate); - v8::HandleScope handle_scope(isolate); - auto handle = - WebContents::CreateFrom(isolate, window_->GetDevToolsWebContents()); - devtools_web_contents_.Reset(isolate, handle.ToV8()); + v8::Locker locker(isolate()); + v8::HandleScope handle_scope(isolate()); + auto handle = WebContents::CreateFrom(isolate(), + window_->GetDevToolsWebContents()); + devtools_web_contents_.Reset(isolate(), handle.ToV8()); } void Window::OnDevToolsClosed() { Emit("devtools-closed"); - v8::Isolate* isolate = v8::Isolate::GetCurrent(); - v8::Locker locker(isolate); - v8::HandleScope handle_scope(isolate); + v8::Locker locker(isolate()); + v8::HandleScope handle_scope(isolate()); devtools_web_contents_.Reset(); } diff --git a/atom/browser/api/event_emitter.h b/atom/browser/api/event_emitter.h index 3809407138a1..776fd5e2dd52 100644 --- a/atom/browser/api/event_emitter.h +++ b/atom/browser/api/event_emitter.h @@ -39,12 +39,11 @@ class EventEmitter : public Wrappable { content::WebContents* sender, IPC::Message* message, const Args&... args) { - v8::Isolate* isolate = v8::Isolate::GetCurrent(); - v8::Locker locker(isolate); - v8::HandleScope handle_scope(isolate); + v8::Locker locker(isolate()); + v8::HandleScope handle_scope(isolate()); - ValueArray converted = { ConvertToV8(isolate, args)... }; - return CallEmit(isolate, name, sender, message, converted); + ValueArray converted = { ConvertToV8(isolate(), args)... }; + return CallEmit(isolate(), name, sender, message, converted); } private: diff --git a/vendor/native_mate b/vendor/native_mate index ad207eeabb01..cad1fa50a95c 160000 --- a/vendor/native_mate +++ b/vendor/native_mate @@ -1 +1 @@ -Subproject commit ad207eeabb0185f74c017e70ca3411d522627ff0 +Subproject commit cad1fa50a95ca4185c435846e4868d5bd6cc94df From 78459b913b20ebc508ad2f1530a115d4faaf53f0 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 23 Jun 2015 19:46:37 +0800 Subject: [PATCH 0348/1293] Add EmitEvent function to replace node::MakeCallback --- atom/browser/api/event_emitter.cc | 21 +++------------ atom/browser/api/event_emitter.h | 17 ++++++------ atom/common/event_emitter_caller.cc | 33 ++++++++++++++++++++++++ atom/common/event_emitter_caller.h | 40 +++++++++++++++++++++++++++++ filenames.gypi | 2 ++ 5 files changed, 87 insertions(+), 26 deletions(-) create mode 100644 atom/common/event_emitter_caller.cc create mode 100644 atom/common/event_emitter_caller.h diff --git a/atom/browser/api/event_emitter.cc b/atom/browser/api/event_emitter.cc index 7fdcfa138c74..9cf7ba520c0f 100644 --- a/atom/browser/api/event_emitter.cc +++ b/atom/browser/api/event_emitter.cc @@ -8,8 +8,6 @@ #include "native_mate/arguments.h" #include "native_mate/object_template_builder.h" -#include "atom/common/node_includes.h" - namespace mate { namespace { @@ -38,11 +36,9 @@ v8::Local CreateEventObject(v8::Isolate* isolate) { EventEmitter::EventEmitter() { } -bool EventEmitter::CallEmit(v8::Isolate* isolate, - const base::StringPiece& name, - content::WebContents* sender, - IPC::Message* message, - ValueArray args) { +v8::Local EventEmitter::CreateEvent(v8::Isolate* isolate, + content::WebContents* sender, + IPC::Message* message) const { v8::Local event; bool use_native_event = sender && message; @@ -53,16 +49,7 @@ bool EventEmitter::CallEmit(v8::Isolate* isolate, } else { event = CreateEventObject(isolate); } - - // args = [name, event, args...]; - args.insert(args.begin(), event); - args.insert(args.begin(), mate::StringToV8(isolate, name)); - - // this.emit.apply(this, args); - node::MakeCallback(isolate, GetWrapper(isolate), "emit", args.size(), - &args[0]); - - return event->Get(StringToV8(isolate, "defaultPrevented"))->BooleanValue(); + return event; } } // namespace mate diff --git a/atom/browser/api/event_emitter.h b/atom/browser/api/event_emitter.h index 776fd5e2dd52..a249ce23f087 100644 --- a/atom/browser/api/event_emitter.h +++ b/atom/browser/api/event_emitter.h @@ -7,6 +7,7 @@ #include +#include "atom/common/event_emitter_caller.h" #include "native_mate/wrappable.h" namespace content { @@ -41,18 +42,16 @@ class EventEmitter : public Wrappable { const Args&... args) { v8::Locker locker(isolate()); v8::HandleScope handle_scope(isolate()); - - ValueArray converted = { ConvertToV8(isolate(), args)... }; - return CallEmit(isolate(), name, sender, message, converted); + v8::Local event = CreateEvent(isolate(), sender, message); + EmitEvent(isolate(), GetWrapper(isolate()), name, event, args...); + return event->Get( + StringToV8(isolate(), "defaultPrevented"))->BooleanValue(); } private: - // Lower level implementations. - bool CallEmit(v8::Isolate* isolate, - const base::StringPiece& name, - content::WebContents* sender, - IPC::Message* message, - ValueArray args); + v8::Local CreateEvent(v8::Isolate* isolate, + content::WebContents* sender, + IPC::Message* message) const; DISALLOW_COPY_AND_ASSIGN(EventEmitter); }; diff --git a/atom/common/event_emitter_caller.cc b/atom/common/event_emitter_caller.cc new file mode 100644 index 000000000000..85f56a233731 --- /dev/null +++ b/atom/common/event_emitter_caller.cc @@ -0,0 +1,33 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#include "atom/common/event_emitter_caller.h" + +namespace mate { + +namespace internal { + +v8::Local CallEmitWithArgs(v8::Isolate* isolate, + v8::Local obj, + ValueVector* args) { + v8::Local emit_name = StringToSymbol(isolate, "emit"); + v8::Local emit = obj->Get(emit_name); + if (emit.IsEmpty() || !emit->IsFunction()) { + isolate->ThrowException(v8::Exception::TypeError( + StringToV8(isolate, "\"emit\" is not a function"))); + return v8::Undefined(isolate); + } + + v8::MaybeLocal result = emit.As()->Call( + isolate->GetCurrentContext(), obj, args->size(), &args->front()); + if (result.IsEmpty()) { + return v8::Undefined(isolate); + } + + return result.ToLocalChecked(); +} + +} // namespace internal + +} // namespace mate diff --git a/atom/common/event_emitter_caller.h b/atom/common/event_emitter_caller.h new file mode 100644 index 000000000000..40755cb0d66f --- /dev/null +++ b/atom/common/event_emitter_caller.h @@ -0,0 +1,40 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#ifndef ATOM_COMMON_EVENT_EMITTER_CALLER_H_ +#define ATOM_COMMON_EVENT_EMITTER_CALLER_H_ + +#include + +#include "native_mate/converter.h" + +namespace mate { + +namespace internal { + +using ValueVector = std::vector>; + +v8::Local CallEmitWithArgs(v8::Isolate* isolate, + v8::Local obj, + ValueVector* args); + +} // namespace internal + +// obj.emit(name, args...); +// The caller is responsible of allocating a HandleScope. +template +v8::Local EmitEvent(v8::Isolate* isolate, + v8::Local obj, + const base::StringPiece& name, + const Args&... args) { + internal::ValueVector converted_args = { + ConvertToV8(isolate, name), + ConvertToV8(isolate, args)..., + }; + return internal::CallEmitWithArgs(isolate, obj, &converted_args); +} + +} // namespace mate + +#endif // ATOM_COMMON_EVENT_EMITTER_CALLER_H_ diff --git a/filenames.gypi b/filenames.gypi index d1e210580925..dfb8a0d9489c 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -249,6 +249,8 @@ 'atom/common/crash_reporter/win/crash_service_main.h', 'atom/common/draggable_region.cc', 'atom/common/draggable_region.h', + 'atom/common/event_emitter_caller.cc', + 'atom/common/event_emitter_caller.h', 'atom/common/google_api_key.h', 'atom/common/linux/application_info.cc', 'atom/common/native_mate_converters/accelerator_converter.cc', From 42e21d15bf0b6f3b9a80a52ea4053c4f3c86a50a Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 23 Jun 2015 20:14:03 +0800 Subject: [PATCH 0349/1293] Remove all calls to node::MakeCallback node::MakeCallback is doing too much for us, avoid calling it. --- atom/common/event_emitter_caller.h | 21 +++++++++++++++---- .../string16_converter.h | 6 ++++++ atom/common/node_bindings.cc | 4 ++-- atom/renderer/atom_render_view_observer.cc | 14 ++++++------- 4 files changed, 32 insertions(+), 13 deletions(-) diff --git a/atom/common/event_emitter_caller.h b/atom/common/event_emitter_caller.h index 40755cb0d66f..e8ad50a45378 100644 --- a/atom/common/event_emitter_caller.h +++ b/atom/common/event_emitter_caller.h @@ -21,15 +21,28 @@ v8::Local CallEmitWithArgs(v8::Isolate* isolate, } // namespace internal -// obj.emit(name, args...); +// obj.emit.apply(obj, name, args...); // The caller is responsible of allocating a HandleScope. -template +template v8::Local EmitEvent(v8::Isolate* isolate, v8::Local obj, - const base::StringPiece& name, + const StringType& name, + const internal::ValueVector& args) { + internal::ValueVector concatenated_args = { StringToV8(isolate, name) }; + concatenated_args.reserve(1 + args.size()); + concatenated_args.insert(concatenated_args.end(), args.begin(), args.end()); + return internal::CallEmitWithArgs(isolate, obj, &concatenated_args); +} + +// obj.emit(name, args...); +// The caller is responsible of allocating a HandleScope. +template +v8::Local EmitEvent(v8::Isolate* isolate, + v8::Local obj, + const StringType& name, const Args&... args) { internal::ValueVector converted_args = { - ConvertToV8(isolate, name), + StringToV8(isolate, name), ConvertToV8(isolate, args)..., }; return internal::CallEmitWithArgs(isolate, obj, &converted_args); diff --git a/atom/common/native_mate_converters/string16_converter.h b/atom/common/native_mate_converters/string16_converter.h index 9fff5be45f7a..e2a5b8ca489e 100644 --- a/atom/common/native_mate_converters/string16_converter.h +++ b/atom/common/native_mate_converters/string16_converter.h @@ -29,6 +29,12 @@ struct Converter { } }; +inline v8::Local StringToV8( + v8::Isolate* isolate, + const base::string16& input) { + return ConvertToV8(isolate, input).As(); +} + } // namespace mate #endif // ATOM_COMMON_NATIVE_MATE_CONVERTERS_STRING16_CONVERTER_H_ diff --git a/atom/common/node_bindings.cc b/atom/common/node_bindings.cc index 2d96d346d6f6..cc53fe7ab8c4 100644 --- a/atom/common/node_bindings.cc +++ b/atom/common/node_bindings.cc @@ -8,6 +8,7 @@ #include #include "atom/common/atom_command_line.h" +#include "atom/common/event_emitter_caller.h" #include "atom/common/native_mate_converters/file_path_converter.h" #include "base/command_line.h" #include "base/base_paths.h" @@ -185,8 +186,7 @@ void NodeBindings::LoadEnvironment(node::Environment* env) { if (node::use_debug_agent) node::EnableDebug(env); - v8::Local msg = mate::StringToV8(env->isolate(), "loaded"); - node::MakeCallback(env->isolate(), env->process_object(), "emit", 1, &msg); + mate::EmitEvent(env->isolate(), env->process_object(), "loaded"); } void NodeBindings::PrepareMessageLoop() { diff --git a/atom/renderer/atom_render_view_observer.cc b/atom/renderer/atom_render_view_observer.cc index d7d115feb8e3..02250091a4ab 100644 --- a/atom/renderer/atom_render_view_observer.cc +++ b/atom/renderer/atom_render_view_observer.cc @@ -7,8 +7,11 @@ #include #include -#include "atom/common/api/api_messages.h" +// Put this before event_emitter_caller.h to have string16 support. #include "atom/common/native_mate_converters/string16_converter.h" + +#include "atom/common/api/api_messages.h" +#include "atom/common/event_emitter_caller.h" #include "atom/common/native_mate_converters/value_converter.h" #include "atom/common/options_switches.h" #include "atom/renderer/atom_renderer_client.h" @@ -134,13 +137,10 @@ void AtomRenderViewObserver::OnBrowserMessage(const base::string16& channel, v8::Local context = frame->mainWorldScriptContext(); v8::Context::Scope context_scope(context); - std::vector> arguments = ListValueToVector( - isolate, args); - arguments.insert(arguments.begin(), mate::ConvertToV8(isolate, channel)); - v8::Local ipc; - if (GetIPCObject(isolate, context, &ipc)) - node::MakeCallback(isolate, ipc, "emit", arguments.size(), &arguments[0]); + if (GetIPCObject(isolate, context, &ipc)) { + mate::EmitEvent(isolate, ipc, channel, ListValueToVector(isolate, args)); + } } } // namespace atom From 8f429bc25a79e4c828c47d4f3e4bf8e6702bbbe3 Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Mon, 22 Jun 2015 17:13:49 +0530 Subject: [PATCH 0350/1293] browser: creating download manager delegate to handle downloads --- atom/browser/atom_browser_context.cc | 11 ++ atom/browser/atom_browser_context.h | 3 + .../browser/atom_download_manager_delegate.cc | 135 ++++++++++++++++++ atom/browser/atom_download_manager_delegate.h | 58 ++++++++ filenames.gypi | 2 + 5 files changed, 209 insertions(+) create mode 100644 atom/browser/atom_download_manager_delegate.cc create mode 100644 atom/browser/atom_download_manager_delegate.h diff --git a/atom/browser/atom_browser_context.cc b/atom/browser/atom_browser_context.cc index 64b80fb61453..66f1b4444a95 100644 --- a/atom/browser/atom_browser_context.cc +++ b/atom/browser/atom_browser_context.cc @@ -5,6 +5,7 @@ #include "atom/browser/atom_browser_context.h" #include "atom/browser/atom_browser_main_parts.h" +#include "atom/browser/atom_download_manager_delegate.h" #include "atom/browser/net/atom_url_request_job_factory.h" #include "atom/browser/net/asar/asar_protocol_handler.h" #include "atom/browser/net/http_protocol_handler.h" @@ -98,6 +99,16 @@ AtomBrowserContext::CreateHttpCacheBackendFactory( return brightray::BrowserContext::CreateHttpCacheBackendFactory(base_path); } +content::DownloadManagerDelegate* +AtomBrowserContext::GetDownloadManagerDelegate() { + if (!download_manager_delegate_.get()) { + auto download_manager = content::BrowserContext::GetDownloadManager(this); + download_manager_delegate_.reset( + new AtomDownloadManagerDelegate(download_manager)); + } + return download_manager_delegate_.get(); +} + content::BrowserPluginGuestManager* AtomBrowserContext::GetGuestManager() { if (!guest_manager_) guest_manager_.reset(new WebViewManager(this)); diff --git a/atom/browser/atom_browser_context.h b/atom/browser/atom_browser_context.h index 688a4977fa2d..4202ba970496 100644 --- a/atom/browser/atom_browser_context.h +++ b/atom/browser/atom_browser_context.h @@ -9,6 +9,7 @@ namespace atom { +class AtomDownloadManagerDelegate; class AtomURLRequestJobFactory; class WebViewManager; @@ -25,11 +26,13 @@ class AtomBrowserContext : public brightray::BrowserContext { const base::FilePath& base_path) override; // content::BrowserContext: + content::DownloadManagerDelegate* GetDownloadManagerDelegate() override; content::BrowserPluginGuestManager* GetGuestManager() override; AtomURLRequestJobFactory* job_factory() const { return job_factory_; } private: + scoped_ptr download_manager_delegate_; scoped_ptr guest_manager_; AtomURLRequestJobFactory* job_factory_; // Weak reference. diff --git a/atom/browser/atom_download_manager_delegate.cc b/atom/browser/atom_download_manager_delegate.cc new file mode 100644 index 000000000000..eb6f48efe851 --- /dev/null +++ b/atom/browser/atom_download_manager_delegate.cc @@ -0,0 +1,135 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#include "atom/browser/atom_download_manager_delegate.h" + +#include + +#include "atom/browser/native_window.h" +#include "atom/browser/ui/file_dialog.h" +#include "base/bind.h" +#include "base/files/file_util.h" +#include "content/public/browser/browser_context.h" +#include "content/public/browser/browser_thread.h" +#include "content/public/browser/download_manager.h" +#include "net/base/filename_util.h" + +namespace atom { + +AtomDownloadManagerDelegate::AtomDownloadManagerDelegate( + content::DownloadManager* manager) + : download_manager_(manager), + weak_ptr_factory_(this) {} + +AtomDownloadManagerDelegate::~AtomDownloadManagerDelegate() { + if (download_manager_) { + DCHECK_EQ(static_cast(this), + download_manager_->GetDelegate()); + download_manager_->SetDelegate(nullptr); + download_manager_ = nullptr; + } +} + +void AtomDownloadManagerDelegate::CreateDownloadPath( + const GURL& url, + const std::string& content_disposition, + const std::string& suggested_filename, + const std::string& mime_type, + const base::FilePath& default_download_path, + const CreateDownloadPathCallback& callback) { + DCHECK_CURRENTLY_ON(content::BrowserThread::FILE); + + auto generated_name = net::GenerateFileName(url, + content_disposition, + std::string(), + suggested_filename, + mime_type, + std::string()); + + if (!base::PathExists(default_download_path)) + base::CreateDirectory(default_download_path); + + base::FilePath path(default_download_path.Append(generated_name)); + content::BrowserThread::PostTask(content::BrowserThread::UI, FROM_HERE, + base::Bind(callback, path)); +} + +void AtomDownloadManagerDelegate::OnDownloadPathGenerated( + uint32 download_id, + const content::DownloadTargetCallback& callback, + const base::FilePath& default_path) { + DCHECK_CURRENTLY_ON(content::BrowserThread::UI); + + auto item = download_manager_->GetDownload(download_id); + if (!item) + return; + + file_dialog::Filters filters; + base::FilePath path; + auto owner_window_ = NativeWindow::FromWebContents(item->GetWebContents()); + if (!file_dialog::ShowSaveDialog( + owner_window_, item->GetURL().spec(), + default_path, filters, &path)) { + return; + } + + callback.Run(path, + content::DownloadItem::TARGET_DISPOSITION_PROMPT, + content::DOWNLOAD_DANGER_TYPE_NOT_DANGEROUS, path); +} + +void AtomDownloadManagerDelegate::Shutdown() { + weak_ptr_factory_.InvalidateWeakPtrs(); + download_manager_ = nullptr; +} + +bool AtomDownloadManagerDelegate::DetermineDownloadTarget( + content::DownloadItem* download, + const content::DownloadTargetCallback& callback) { + DCHECK_CURRENTLY_ON(content::BrowserThread::UI); + + if (default_download_path_.empty()) { + auto path = download_manager_->GetBrowserContext()->GetPath(); + default_download_path_ = path.Append(FILE_PATH_LITERAL("Downloads")); + } + + if (!download->GetForcedFilePath().empty()) { + callback.Run(download->GetForcedFilePath(), + content::DownloadItem::TARGET_DISPOSITION_OVERWRITE, + content::DOWNLOAD_DANGER_TYPE_NOT_DANGEROUS, + download->GetForcedFilePath()); + return true; + } + + CreateDownloadPathCallback download_path_callback = + base::Bind(&AtomDownloadManagerDelegate::OnDownloadPathGenerated, + weak_ptr_factory_.GetWeakPtr(), + download->GetId(), callback); + + content::BrowserThread::PostTask( + content::BrowserThread::FILE, FROM_HERE, + base::Bind(&AtomDownloadManagerDelegate::CreateDownloadPath, + weak_ptr_factory_.GetWeakPtr(), + download->GetURL(), + download->GetContentDisposition(), + download->GetSuggestedFilename(), + download->GetMimeType(), + default_download_path_, + download_path_callback)); + return true; +} + +bool AtomDownloadManagerDelegate::ShouldOpenDownload( + content::DownloadItem* download, + const content::DownloadOpenDelayedCallback& callback) { + return true; +} + +void AtomDownloadManagerDelegate::GetNextId( + const content::DownloadIdCallback& callback) { + static uint32 next_id = content::DownloadItem::kInvalidId + 1; + callback.Run(next_id++); +} + +} // namespace atom diff --git a/atom/browser/atom_download_manager_delegate.h b/atom/browser/atom_download_manager_delegate.h new file mode 100644 index 000000000000..e2d829243299 --- /dev/null +++ b/atom/browser/atom_download_manager_delegate.h @@ -0,0 +1,58 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#ifndef ATOM_BROWSER_ATOM_DOWNLOAD_MANAGER_DELEGATE_H_ +#define ATOM_BROWSER_ATOM_DOWNLOAD_MANAGER_DELEGATE_H_ + +#include + +#include "base/memory/weak_ptr.h" +#include "content/public/browser/download_manager_delegate.h" + +namespace content { +class DownloadManager; +} + +namespace atom { + +class AtomDownloadManagerDelegate : public content::DownloadManagerDelegate { + public: + using CreateDownloadPathCallback = + base::Callback; + + explicit AtomDownloadManagerDelegate(content::DownloadManager* manager); + virtual ~AtomDownloadManagerDelegate(); + + // Generate default file path to save the download. + void CreateDownloadPath(const GURL& url, + const std::string& suggested_filename, + const std::string& content_disposition, + const std::string& mime_type, + const base::FilePath& path, + const CreateDownloadPathCallback& callback); + void OnDownloadPathGenerated(uint32 download_id, + const content::DownloadTargetCallback& callback, + const base::FilePath& default_path); + + // content::DownloadManagerDelegate: + void Shutdown() override; + bool DetermineDownloadTarget( + content::DownloadItem* download, + const content::DownloadTargetCallback& callback) override; + bool ShouldOpenDownload( + content::DownloadItem* download, + const content::DownloadOpenDelayedCallback& callback) override; + void GetNextId(const content::DownloadIdCallback& callback) override; + + private: + content::DownloadManager* download_manager_; + base::FilePath default_download_path_; + base::WeakPtrFactory weak_ptr_factory_; + + DISALLOW_COPY_AND_ASSIGN(AtomDownloadManagerDelegate); +}; + +} // namespace atom + +#endif // ATOM_BROWSER_ATOM_DOWNLOAD_MANAGER_DELEGATE_H_ diff --git a/filenames.gypi b/filenames.gypi index d1e210580925..b36674fddf39 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -109,6 +109,8 @@ 'atom/browser/atom_browser_client.h', 'atom/browser/atom_browser_context.cc', 'atom/browser/atom_browser_context.h', + 'atom/browser/atom_download_manager_delegate.cc', + 'atom/browser/atom_download_manager_delegate.h', 'atom/browser/atom_browser_main_parts.cc', 'atom/browser/atom_browser_main_parts.h', 'atom/browser/atom_browser_main_parts_linux.cc', From 77dbec305f154659d587ec665253e015cfd20c78 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 23 Jun 2015 21:27:50 +0800 Subject: [PATCH 0351/1293] Emit ATOM_BROWSER_RELEASE_RENDER_VIEW in C++ --- atom/browser/api/atom_api_web_contents.cc | 13 ++++++++++++- atom/browser/api/lib/web-contents.coffee | 5 ----- 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 420878664d22..48a1e6a020de 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -12,6 +12,7 @@ #include "atom/browser/atom_browser_main_parts.h" #include "atom/browser/native_window.h" #include "atom/common/api/api_messages.h" +#include "atom/common/event_emitter_caller.h" #include "atom/common/native_mate_converters/gfx_converter.h" #include "atom/common/native_mate_converters/gurl_converter.h" #include "atom/common/native_mate_converters/image_converter.h" @@ -249,7 +250,17 @@ void WebContents::ExitFullscreenModeForTab(content::WebContents* source) { } void WebContents::RenderViewDeleted(content::RenderViewHost* render_view_host) { - Emit("render-view-deleted", render_view_host->GetProcess()->GetID()); + int process_id = render_view_host->GetProcess()->GetID(); + Emit("render-view-deleted", process_id); + + // process.emit('ATOM_BROWSER_RELEASE_RENDER_VIEW', processId); + // Tell the rpc server that a render view has been deleted and we need to + // release all objects owned by it. + v8::Locker locker(isolate()); + v8::HandleScope handle_scope(isolate()); + node::Environment* env = node::Environment::GetCurrent(isolate()); + mate::EmitEvent(isolate(), env->process_object(), + "ATOM_BROWSER_RELEASE_RENDER_VIEW", process_id); } void WebContents::RenderProcessGone(base::TerminationStatus status) { diff --git a/atom/browser/api/lib/web-contents.coffee b/atom/browser/api/lib/web-contents.coffee index b635ab2a5f26..35c11dfe4be1 100644 --- a/atom/browser/api/lib/web-contents.coffee +++ b/atom/browser/api/lib/web-contents.coffee @@ -30,11 +30,6 @@ wrapWebContents = (webContents) -> do (name, method) -> webContents[name] = -> method.apply controller, arguments - # Tell the rpc server that a render view has been deleted and we need to - # release all objects owned by it. - webContents.on 'render-view-deleted', (event, processId) -> - process.emit 'ATOM_BROWSER_RELEASE_RENDER_VIEW', processId - # Dispatch IPC messages to the ipc module. webContents.on 'ipc-message', (event, packed) -> [channel, args...] = packed From 6d9ca4f52bf610eb108d2e7b790c63f664666724 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 23 Jun 2015 22:11:59 +0800 Subject: [PATCH 0352/1293] Clean up coffee files --- atom/browser/api/lib/browser-window.coffee | 2 -- atom/browser/api/lib/web-contents.coffee | 4 +--- 2 files changed, 1 insertion(+), 5 deletions(-) diff --git a/atom/browser/api/lib/browser-window.coffee b/atom/browser/api/lib/browser-window.coffee index fc4667aa2c89..aa271763eca5 100644 --- a/atom/browser/api/lib/browser-window.coffee +++ b/atom/browser/api/lib/browser-window.coffee @@ -79,8 +79,6 @@ BrowserWindow::getPageTitle = -> @webContents.getTitle() BrowserWindow::isLoading = -> @webContents.isLoading() BrowserWindow::isWaitingForResponse = -> @webContents.isWaitingForResponse() BrowserWindow::stop = -> @webContents.stop() -BrowserWindow::getRoutingId = -> @webContents.getRoutingId() -BrowserWindow::getProcessId = -> @webContents.getProcessId() BrowserWindow::isCrashed = -> @webContents.isCrashed() BrowserWindow::executeJavaScriptInDevTools = (code) -> @devToolsWebContents?.executeJavaScript code BrowserWindow::openDevTools = -> @webContents.openDevTools.apply @webContents, arguments diff --git a/atom/browser/api/lib/web-contents.coffee b/atom/browser/api/lib/web-contents.coffee index 35c11dfe4be1..c07c54103385 100644 --- a/atom/browser/api/lib/web-contents.coffee +++ b/atom/browser/api/lib/web-contents.coffee @@ -79,9 +79,7 @@ wrapWebContents = (webContents) -> if options.printBackgrounds printingSetting.shouldPrintBackgrounds = options.printBackground - webContents._printToPDF printingSetting, callback - - webContents + @_printToPDF printingSetting, callback binding._setWrapWebContents wrapWebContents process.once 'exit', binding._clearWrapWebContents From 4359eb44721229918ca1366743d4e348e99b80b7 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 23 Jun 2015 23:02:49 +0800 Subject: [PATCH 0353/1293] mac: Set NSHighResolutionCapable in Info.plist, close #2020 --- atom/browser/resources/mac/Info.plist | 2 ++ 1 file changed, 2 insertions(+) diff --git a/atom/browser/resources/mac/Info.plist b/atom/browser/resources/mac/Info.plist index fe41ee7efc61..72bb2524fccf 100644 --- a/atom/browser/resources/mac/Info.plist +++ b/atom/browser/resources/mac/Info.plist @@ -26,5 +26,7 @@ AtomApplication NSSupportsAutomaticGraphicsSwitching + NSHighResolutionCapable + From 1f3a73e802f817840a9fc3b09316c9a32abc30b9 Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Mon, 22 Jun 2015 07:30:33 +0530 Subject: [PATCH 0354/1293] devtools: write to file in FILE thread --- atom/browser/common_web_contents_delegate.cc | 56 ++++++++++++++++---- atom/browser/common_web_contents_delegate.h | 6 +++ 2 files changed, 51 insertions(+), 11 deletions(-) diff --git a/atom/browser/common_web_contents_delegate.cc b/atom/browser/common_web_contents_delegate.cc index 285b93014e44..97fee2f755d1 100644 --- a/atom/browser/common_web_contents_delegate.cc +++ b/atom/browser/common_web_contents_delegate.cc @@ -15,11 +15,14 @@ #include "chrome/browser/printing/print_preview_message_handler.h" #include "chrome/browser/printing/print_view_manager_basic.h" #include "chrome/browser/ui/browser_dialogs.h" +#include "content/public/browser/browser_thread.h" #include "content/public/browser/child_process_security_policy.h" #include "content/public/browser/render_process_host.h" #include "content/public/browser/render_view_host.h" #include "storage/browser/fileapi/isolated_context.h" +using content::BrowserThread; + namespace atom { namespace { @@ -86,6 +89,22 @@ base::DictionaryValue* CreateFileSystemValue(const FileSystem& file_system) { return file_system_value; } +void WriteToFile(const base::FilePath& path, + const std::string& content) { + DCHECK_CURRENTLY_ON(BrowserThread::FILE); + DCHECK(!path.empty()); + + base::WriteFile(path, content.data(), content.size()); +} + +void AppendToFile(const base::FilePath& path, + const std::string& content) { + DCHECK_CURRENTLY_ON(BrowserThread::FILE); + DCHECK(!path.empty()); + + base::AppendToFile(path, content.data(), content.size()); +} + } // namespace CommonWebContentsDelegate::CommonWebContentsDelegate(bool is_guest) @@ -237,12 +256,11 @@ void CommonWebContentsDelegate::DevToolsSaveToFile( } saved_files_[url] = path; - base::WriteFile(path, content.data(), content.size()); - - // Notify devtools. - base::StringValue url_value(url); - web_contents_->CallClientFunction( - "DevToolsAPI.savedURL", &url_value, nullptr, nullptr); + BrowserThread::PostTaskAndReply( + BrowserThread::FILE, FROM_HERE, + base::Bind(&WriteToFile, path, content), + base::Bind(&CommonWebContentsDelegate::OnDevToolsSaveToFile, + base::Unretained(this), url)); } void CommonWebContentsDelegate::DevToolsAppendToFile( @@ -250,12 +268,12 @@ void CommonWebContentsDelegate::DevToolsAppendToFile( PathsMap::iterator it = saved_files_.find(url); if (it == saved_files_.end()) return; - base::AppendToFile(it->second, content.data(), content.size()); - // Notify devtools. - base::StringValue url_value(url); - web_contents_->CallClientFunction( - "DevToolsAPI.appendedToURL", &url_value, nullptr, nullptr); + BrowserThread::PostTaskAndReply( + BrowserThread::FILE, FROM_HERE, + base::Bind(&AppendToFile, it->second, content), + base::Bind(&CommonWebContentsDelegate::OnDevToolsAppendToFile, + base::Unretained(this), url)); } void CommonWebContentsDelegate::DevToolsAddFileSystem() { @@ -318,6 +336,22 @@ void CommonWebContentsDelegate::DevToolsRemoveFileSystem( nullptr); } +void CommonWebContentsDelegate::OnDevToolsSaveToFile( + const std::string& url) { + // Notify DevTools. + base::StringValue url_value(url); + web_contents_->CallClientFunction( + "DevToolsAPI.savedURL", &url_value, nullptr, nullptr); +} + +void CommonWebContentsDelegate::OnDevToolsAppendToFile( + const std::string& url) { + // Notify DevTools. + base::StringValue url_value(url); + web_contents_->CallClientFunction( + "DevToolsAPI.appendedToURL", &url_value, nullptr, nullptr); +} + void CommonWebContentsDelegate::SetHtmlApiFullscreen(bool enter_fullscreen) { // Window is already in fullscreen mode, save the state. if (enter_fullscreen && owner_window_->IsFullscreen()) { diff --git a/atom/browser/common_web_contents_delegate.h b/atom/browser/common_web_contents_delegate.h index 84564e0ce743..a50f4288613a 100644 --- a/atom/browser/common_web_contents_delegate.h +++ b/atom/browser/common_web_contents_delegate.h @@ -83,6 +83,12 @@ class CommonWebContentsDelegate void DevToolsRemoveFileSystem(const std::string& file_system_path) override; private: + // Callback for when DevToolsSaveToFile has completed. + void OnDevToolsSaveToFile(const std::string& url); + + // Callback for when DevToolsAppendToFile has completed. + void OnDevToolsAppendToFile(const std::string& url); + // Set fullscreen mode triggered by html api. void SetHtmlApiFullscreen(bool enter_fullscreen); From 33c2768a77df3e123a820c254d5d9f46ed9ecb2f Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 23 Jun 2015 23:40:41 +0800 Subject: [PATCH 0355/1293] Add app.defaultSession --- atom/browser/api/atom_api_app.cc | 14 +++++++++++++- atom/browser/api/atom_api_app.h | 3 +++ atom/browser/api/atom_api_session.cc | 8 ++++---- atom/browser/api/atom_api_session.h | 13 +++++-------- atom/browser/api/atom_api_web_contents.cc | 4 +++- 5 files changed, 28 insertions(+), 14 deletions(-) diff --git a/atom/browser/api/atom_api_app.cc b/atom/browser/api/atom_api_app.cc index 7468a4b8b837..2c52a19d800c 100644 --- a/atom/browser/api/atom_api_app.cc +++ b/atom/browser/api/atom_api_app.cc @@ -12,6 +12,7 @@ #endif #include "atom/browser/api/atom_api_menu.h" +#include "atom/browser/api/atom_api_session.h" #include "atom/browser/atom_browser_context.h" #include "atom/browser/atom_browser_main_parts.h" #include "atom/browser/browser.h" @@ -217,6 +218,16 @@ void App::SetAppUserModelId(const std::string& app_id) { #endif } +v8::Local App::DefaultSession(v8::Isolate* isolate) { + if (default_session_.IsEmpty()) { + auto browser_context = static_cast( + AtomBrowserMainParts::Get()->browser_context()); + auto handle = Session::Create(isolate, browser_context); + default_session_.Reset(isolate, handle.ToV8()); + } + return v8::Local::New(isolate, default_session_); +} + mate::ObjectTemplateBuilder App::GetObjectTemplateBuilder( v8::Isolate* isolate) { auto browser = base::Unretained(Browser::Get()); @@ -240,7 +251,8 @@ mate::ObjectTemplateBuilder App::GetObjectTemplateBuilder( .SetMethod("getPath", &App::GetPath) .SetMethod("resolveProxy", &App::ResolveProxy) .SetMethod("setDesktopName", &App::SetDesktopName) - .SetMethod("setAppUserModelId", &App::SetAppUserModelId); + .SetMethod("setAppUserModelId", &App::SetAppUserModelId) + .SetProperty("defaultSession", &App::DefaultSession); } // static diff --git a/atom/browser/api/atom_api_app.h b/atom/browser/api/atom_api_app.h index c2f9212b7ca7..7808cfe5fa21 100644 --- a/atom/browser/api/atom_api_app.h +++ b/atom/browser/api/atom_api_app.h @@ -62,6 +62,9 @@ class App : public mate::EventEmitter, void ResolveProxy(const GURL& url, ResolveProxyCallback callback); void SetDesktopName(const std::string& desktop_name); void SetAppUserModelId(const std::string& app_id); + v8::Local DefaultSession(v8::Isolate* isolate); + + v8::Global default_session_; DISALLOW_COPY_AND_ASSIGN(App); }; diff --git a/atom/browser/api/atom_api_session.cc b/atom/browser/api/atom_api_session.cc index 18806ebf41f3..7bddee1ccc97 100644 --- a/atom/browser/api/atom_api_session.cc +++ b/atom/browser/api/atom_api_session.cc @@ -5,7 +5,7 @@ #include "atom/browser/api/atom_api_session.h" #include "atom/browser/api/atom_api_cookies.h" -#include "content/public/browser/browser_context.h" +#include "atom/browser/atom_browser_context.h" #include "native_mate/callback.h" #include "native_mate/dictionary.h" #include "native_mate/object_template_builder.h" @@ -16,8 +16,8 @@ namespace atom { namespace api { -Session::Session(content::BrowserContext* browser_context): - browser_context_(browser_context) { +Session::Session(AtomBrowserContext* browser_context) + : browser_context_(browser_context) { } Session::~Session() { @@ -40,7 +40,7 @@ mate::ObjectTemplateBuilder Session::GetObjectTemplateBuilder( // static mate::Handle Session::Create( v8::Isolate* isolate, - content::BrowserContext* browser_context) { + AtomBrowserContext* browser_context) { return mate::CreateHandle(isolate, new Session(browser_context)); } diff --git a/atom/browser/api/atom_api_session.h b/atom/browser/api/atom_api_session.h index 4bdab0757709..bd12a3861568 100644 --- a/atom/browser/api/atom_api_session.h +++ b/atom/browser/api/atom_api_session.h @@ -8,21 +8,19 @@ #include "native_mate/handle.h" #include "native_mate/wrappable.h" -namespace content { -class BrowserContext; -} - namespace atom { +class AtomBrowserContext; + namespace api { class Session: public mate::Wrappable { public: static mate::Handle Create(v8::Isolate* isolate, - content::BrowserContext* browser_context); + AtomBrowserContext* browser_context); protected: - explicit Session(content::BrowserContext* browser_context); + explicit Session(AtomBrowserContext* browser_context); ~Session(); // mate::Wrappable implementations: @@ -34,8 +32,7 @@ class Session: public mate::Wrappable { v8::Global cookies_; - // The webContents which owns the Sesssion. - content::BrowserContext* browser_context_; + AtomBrowserContext* browser_context_; // weak ref DISALLOW_COPY_AND_ASSIGN(Session); }; diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 48a1e6a020de..c64db2810ec5 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -608,7 +608,9 @@ void WebContents::InspectServiceWorker() { v8::Local WebContents::Session(v8::Isolate* isolate) { if (session_.IsEmpty()) { - auto handle = Session::Create(isolate, web_contents()->GetBrowserContext()); + mate::Handle handle = Session::Create( + isolate, + static_cast(web_contents()->GetBrowserContext())); session_.Reset(isolate, handle.ToV8()); } return v8::Local::New(isolate, session_); From ea69e91e491150e8456c95b897c8f0e3a9555d09 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 24 Jun 2015 11:59:11 +0800 Subject: [PATCH 0356/1293] Move resolveProxy From app to session --- atom/browser/api/atom_api_app.cc | 47 ----------------------- atom/browser/api/atom_api_app.h | 6 --- atom/browser/api/atom_api_session.cc | 57 +++++++++++++++++++++++++++- atom/browser/api/atom_api_session.h | 8 ++++ 4 files changed, 64 insertions(+), 54 deletions(-) diff --git a/atom/browser/api/atom_api_app.cc b/atom/browser/api/atom_api_app.cc index 2c52a19d800c..0c298f131f56 100644 --- a/atom/browser/api/atom_api_app.cc +++ b/atom/browser/api/atom_api_app.cc @@ -17,7 +17,6 @@ #include "atom/browser/atom_browser_main_parts.h" #include "atom/browser/browser.h" #include "atom/common/native_mate_converters/file_path_converter.h" -#include "atom/common/native_mate_converters/gurl_converter.h" #include "base/command_line.h" #include "base/environment.h" #include "base/files/file_path.h" @@ -26,10 +25,6 @@ #include "native_mate/callback.h" #include "native_mate/dictionary.h" #include "native_mate/object_template_builder.h" -#include "net/base/load_flags.h" -#include "net/proxy/proxy_service.h" -#include "net/url_request/url_request_context.h" -#include "net/url_request/url_request_context_getter.h" #if defined(OS_WIN) #include "base/strings/utf_string_conversions.h" @@ -95,43 +90,6 @@ int GetPathConstant(const std::string& name) { return -1; } -class ResolveProxyHelper { - public: - ResolveProxyHelper(const GURL& url, App::ResolveProxyCallback callback) - : callback_(callback) { - auto browser_context = AtomBrowserMainParts::Get()->browser_context(); - net::ProxyService* proxy_service = browser_context-> - url_request_context_getter()->GetURLRequestContext()->proxy_service(); - - // Start the request. - int result = proxy_service->ResolveProxy( - url, net::LOAD_NORMAL, &proxy_info_, - base::Bind(&ResolveProxyHelper::OnResolveProxyCompleted, - base::Unretained(this)), - &pac_req_, nullptr, net::BoundNetLog()); - - // Completed synchronously. - if (result != net::ERR_IO_PENDING) - OnResolveProxyCompleted(result); - } - - void OnResolveProxyCompleted(int result) { - std::string proxy; - if (result == net::OK) - proxy = proxy_info_.ToPacString(); - callback_.Run(proxy); - - delete this; - } - - private: - App::ResolveProxyCallback callback_; - net::ProxyInfo proxy_info_; - net::ProxyService::PacRequest* pac_req_; - - DISALLOW_COPY_AND_ASSIGN(ResolveProxyHelper); -}; - } // namespace App::App() { @@ -200,10 +158,6 @@ void App::SetPath(mate::Arguments* args, args->ThrowError("Failed to set path"); } -void App::ResolveProxy(const GURL& url, ResolveProxyCallback callback) { - new ResolveProxyHelper(url, callback); -} - void App::SetDesktopName(const std::string& desktop_name) { #if defined(OS_LINUX) scoped_ptr env(base::Environment::Create()); @@ -249,7 +203,6 @@ mate::ObjectTemplateBuilder App::GetObjectTemplateBuilder( #endif .SetMethod("setPath", &App::SetPath) .SetMethod("getPath", &App::GetPath) - .SetMethod("resolveProxy", &App::ResolveProxy) .SetMethod("setDesktopName", &App::SetDesktopName) .SetMethod("setAppUserModelId", &App::SetAppUserModelId) .SetProperty("defaultSession", &App::DefaultSession); diff --git a/atom/browser/api/atom_api_app.h b/atom/browser/api/atom_api_app.h index 7808cfe5fa21..f3041757669f 100644 --- a/atom/browser/api/atom_api_app.h +++ b/atom/browser/api/atom_api_app.h @@ -9,11 +9,8 @@ #include "atom/browser/api/event_emitter.h" #include "atom/browser/browser_observer.h" -#include "base/callback.h" #include "native_mate/handle.h" -class GURL; - namespace base { class FilePath; } @@ -29,8 +26,6 @@ namespace api { class App : public mate::EventEmitter, public BrowserObserver { public: - typedef base::Callback ResolveProxyCallback; - static mate::Handle Create(v8::Isolate* isolate); protected: @@ -59,7 +54,6 @@ class App : public mate::EventEmitter, const std::string& name, const base::FilePath& path); - void ResolveProxy(const GURL& url, ResolveProxyCallback callback); void SetDesktopName(const std::string& desktop_name); void SetAppUserModelId(const std::string& app_id); v8::Local DefaultSession(v8::Isolate* isolate); diff --git a/atom/browser/api/atom_api_session.cc b/atom/browser/api/atom_api_session.cc index 7bddee1ccc97..0ff22889f7ae 100644 --- a/atom/browser/api/atom_api_session.cc +++ b/atom/browser/api/atom_api_session.cc @@ -4,11 +4,17 @@ #include "atom/browser/api/atom_api_session.h" +#include + #include "atom/browser/api/atom_api_cookies.h" #include "atom/browser/atom_browser_context.h" +#include "atom/common/native_mate_converters/gurl_converter.h" #include "native_mate/callback.h" -#include "native_mate/dictionary.h" #include "native_mate/object_template_builder.h" +#include "net/base/load_flags.h" +#include "net/proxy/proxy_service.h" +#include "net/url_request/url_request_context.h" +#include "net/url_request/url_request_context_getter.h" #include "atom/common/node_includes.h" @@ -16,6 +22,50 @@ namespace atom { namespace api { +namespace { + +class ResolveProxyHelper { + public: + ResolveProxyHelper(AtomBrowserContext* browser_context, + const GURL& url, + Session::ResolveProxyCallback callback) + : callback_(callback) { + net::ProxyService* proxy_service = browser_context-> + url_request_context_getter()->GetURLRequestContext()->proxy_service(); + + // Start the request. + int result = proxy_service->ResolveProxy( + url, net::LOAD_NORMAL, &proxy_info_, + base::Bind(&ResolveProxyHelper::OnResolveProxyCompleted, + base::Unretained(this)), + &pac_req_, nullptr, net::BoundNetLog()); + + // Completed synchronously. + if (result != net::ERR_IO_PENDING) + OnResolveProxyCompleted(result); + } + + void OnResolveProxyCompleted(int result) { + std::string proxy; + if (result == net::OK) + proxy = proxy_info_.ToPacString(); + callback_.Run(proxy); + + delete this; + } + + private: + Session::ResolveProxyCallback callback_; + net::ProxyInfo proxy_info_; + net::ProxyService::PacRequest* pac_req_; + + DISALLOW_COPY_AND_ASSIGN(ResolveProxyHelper); +}; + + + +} // namespace + Session::Session(AtomBrowserContext* browser_context) : browser_context_(browser_context) { } @@ -23,6 +73,10 @@ Session::Session(AtomBrowserContext* browser_context) Session::~Session() { } +void Session::ResolveProxy(const GURL& url, ResolveProxyCallback callback) { + new ResolveProxyHelper(browser_context_, url, callback); +} + v8::Local Session::Cookies(v8::Isolate* isolate) { if (cookies_.IsEmpty()) { auto handle = atom::api::Cookies::Create(isolate, browser_context_); @@ -34,6 +88,7 @@ v8::Local Session::Cookies(v8::Isolate* isolate) { mate::ObjectTemplateBuilder Session::GetObjectTemplateBuilder( v8::Isolate* isolate) { return mate::ObjectTemplateBuilder(isolate) + .SetMethod("resolveProxy", &Session::ResolveProxy) .SetProperty("cookies", &Session::Cookies); } diff --git a/atom/browser/api/atom_api_session.h b/atom/browser/api/atom_api_session.h index bd12a3861568..6e2c0fce1960 100644 --- a/atom/browser/api/atom_api_session.h +++ b/atom/browser/api/atom_api_session.h @@ -5,9 +5,14 @@ #ifndef ATOM_BROWSER_API_ATOM_API_SESSION_H_ #define ATOM_BROWSER_API_ATOM_API_SESSION_H_ +#include + +#include "base/callback.h" #include "native_mate/handle.h" #include "native_mate/wrappable.h" +class GURL; + namespace atom { class AtomBrowserContext; @@ -16,6 +21,8 @@ namespace api { class Session: public mate::Wrappable { public: + using ResolveProxyCallback = base::Callback; + static mate::Handle Create(v8::Isolate* isolate, AtomBrowserContext* browser_context); @@ -28,6 +35,7 @@ class Session: public mate::Wrappable { v8::Isolate* isolate) override; private: + void ResolveProxy(const GURL& url, ResolveProxyCallback callback); v8::Local Cookies(v8::Isolate* isolate); v8::Global cookies_; From 09a6e37a090c6035f085dd1a1227c5c257e8e93c Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 24 Jun 2015 12:01:19 +0800 Subject: [PATCH 0357/1293] Keep compatibility with app.resolveProxy --- atom/browser/api/lib/app.coffee | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/atom/browser/api/lib/app.coffee b/atom/browser/api/lib/app.coffee index aad56fd91238..a2ec8bd10c9f 100644 --- a/atom/browser/api/lib/app.coffee +++ b/atom/browser/api/lib/app.coffee @@ -26,12 +26,13 @@ if process.platform is 'darwin' setMenu: bindings.dockSetMenu # Be compatible with old API. -app.once 'ready', -> app.emit 'finish-launching' +app.once 'ready', -> @emit 'finish-launching' app.terminate = app.quit app.exit = process.exit -app.getHomeDir = -> app.getPath 'home' -app.getDataPath = -> app.getPath 'userData' -app.setDataPath = (path) -> app.setPath 'userData', path +app.getHomeDir = -> @getPath 'home' +app.getDataPath = -> @getPath 'userData' +app.setDataPath = (path) -> @setPath 'userData', path +app.resolveProxy = -> @defaultSession.resolveProxy.apply @defaultSession, arguments # Only one App object pemitted. module.exports = app From 13784e6551040c4cc03769711b441f490c25cd64 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Wed, 24 Jun 2015 12:49:43 +0800 Subject: [PATCH 0358/1293] More updates: use string instead of integer to identify blocker type. --- .../api/atom_api_power_save_blocker.cc | 34 +++++++------------ .../browser/api/atom_api_power_save_blocker.h | 4 +-- .../browser/api/lib/power-save-blocker.coffee | 7 +--- docs/api/power-save-blocker.md | 27 +++++++-------- 4 files changed, 29 insertions(+), 43 deletions(-) diff --git a/atom/browser/api/atom_api_power_save_blocker.cc b/atom/browser/api/atom_api_power_save_blocker.cc index 0e09d9b8c2bd..c75901cb1e31 100644 --- a/atom/browser/api/atom_api_power_save_blocker.cc +++ b/atom/browser/api/atom_api_power_save_blocker.cc @@ -4,18 +4,12 @@ #include "atom/browser/api/atom_api_power_save_blocker.h" +#include + #include "content/public/browser/power_save_blocker.h" -#include "native_mate/constructor.h" #include "native_mate/dictionary.h" - #include "atom/common/node_includes.h" -namespace { - -const char kPowerSaveBlockerDescription[] = "Electron"; - -} // namespace - namespace mate { template<> @@ -24,19 +18,15 @@ struct Converter { v8::Local val, content::PowerSaveBlocker::PowerSaveBlockerType* out) { using content::PowerSaveBlocker; - int type; + std::string type; if (!ConvertFromV8(isolate, val, &type)) return false; - switch (static_cast(type)) { - case PowerSaveBlocker::kPowerSaveBlockPreventAppSuspension: - *out = PowerSaveBlocker::kPowerSaveBlockPreventAppSuspension; - break; - case PowerSaveBlocker::kPowerSaveBlockPreventDisplaySleep: - *out = PowerSaveBlocker::kPowerSaveBlockPreventDisplaySleep; - break; - default: - return false; - } + if (type == "prevent-app-suspension") + *out = PowerSaveBlocker::kPowerSaveBlockPreventAppSuspension; + else if (type == "prevent-display-sleep") + *out = PowerSaveBlocker::kPowerSaveBlockPreventDisplaySleep; + else + return false; return true; } }; @@ -47,7 +37,9 @@ namespace atom { namespace api { -PowerSaveBlocker::PowerSaveBlocker() { +PowerSaveBlocker::PowerSaveBlocker() + : current_blocker_type_( + content::PowerSaveBlocker::kPowerSaveBlockPreventAppSuspension) { } PowerSaveBlocker::~PowerSaveBlocker() { @@ -81,7 +73,7 @@ void PowerSaveBlocker::UpdatePowerSaveBlocker() { content::PowerSaveBlocker::Create( new_blocker_type, content::PowerSaveBlocker::kReasonOther, - kPowerSaveBlockerDescription); + ATOM_PRODUCT_NAME); power_save_blocker_.swap(new_blocker); current_blocker_type_ = new_blocker_type; } diff --git a/atom/browser/api/atom_api_power_save_blocker.h b/atom/browser/api/atom_api_power_save_blocker.h index fdfb2d9cdec8..9861f2b0f7cd 100644 --- a/atom/browser/api/atom_api_power_save_blocker.h +++ b/atom/browser/api/atom_api_power_save_blocker.h @@ -44,8 +44,8 @@ class PowerSaveBlocker : public mate::Wrappable { content::PowerSaveBlocker::PowerSaveBlockerType current_blocker_type_; // Map from id to the corresponding blocker type for each request. - typedef std::map - PowerSaveBlockerTypeMap; + using PowerSaveBlockerTypeMap = + std::map; PowerSaveBlockerTypeMap power_save_blocker_types_; diff --git a/atom/browser/api/lib/power-save-blocker.coffee b/atom/browser/api/lib/power-save-blocker.coffee index 6ac8b9b01905..7f428bc40f19 100644 --- a/atom/browser/api/lib/power-save-blocker.coffee +++ b/atom/browser/api/lib/power-save-blocker.coffee @@ -1,8 +1,3 @@ bindings = process.atomBinding 'power_save_blocker' -powerSaveBlocker = bindings.powerSaveBlocker - -powerSaveBlocker.PREVENT_APP_SUSPENSION = 0 -powerSaveBlocker.PREVENT_DISPLAY_SLEEP = 1 - -module.exports = powerSaveBlocker +module.exports = bindings.powerSaveBlocker diff --git a/docs/api/power-save-blocker.md b/docs/api/power-save-blocker.md index e4de5a17d310..23b1252c6789 100644 --- a/docs/api/power-save-blocker.md +++ b/docs/api/power-save-blocker.md @@ -8,7 +8,7 @@ An example is: ```javascript var powerSaveBlocker = require('power-save-blocker'); -var id = powerSaveBlocker.start(powerSaveBlocker.PREVENT_DISPLAY_SLEEP); +var id = powerSaveBlocker.start('prevent-display-sleep'); console.log(powerSaveBlocker.isStarted(id)); powerSaveBlocker.stop(id); @@ -16,25 +16,24 @@ powerSaveBlocker.stop(id); ## powerSaveBlocker.start(type) -* `type` - Power save blocker type - * powerSaveBlocker.PREVENT_APP_SUSPENSION - Prevent the application from being - suspended. Keeps system active, but allows screen to be turned off. - Example use cases: downloading a file, playing audio. - * powerSaveBlocker.PREVENT_DISPLAY_SLEEP - Prevent the display from going to sleep. - Keeps system and screen active. - Example use case: playing video. +* `type` String - Power save blocker type + * `prevent-app-suspension` - Prevent the application from being suspended. + Keeps system active, but allows screen to be turned off. Example use cases: + downloading a file, playing audio. + * `prevent-display-sleep`- Prevent the display from going to sleep. Keeps system + and screen active. Example use case: playing video. Starts the power save blocker preventing the system entering lower-power mode. Returns an integer identified the power save blocker. **Note:** -`PREVENT_DISPLAY_SLEEP` has higher precedence level than `PREVENT_APP_SUSPENSION`. -Only the highest precedence type takes effect. In other words, `PREVENT_DISPLAY_SLEEP` -always take precedence over `PREVENT_APP_SUSPENSION`. +`prevent-display-sleep` has higher precedence level than `prevent-app-suspension`. +Only the highest precedence type takes effect. In other words, `prevent-display-sleep` +always take precedence over `prevent-app-suspension`. -For example, an API calling A requests for `PREVENT_APP_SUSPENSION`, and -another calling B requests for `PREVENT_DISPLAY_SLEEP`. `PREVENT_DISPLAY_SLEEP` -will be used until B stops its request. After that, `PREVENT_APP_SUSPENSION` is used. +For example, an API calling A requests for `prevent-app-suspension`, and +another calling B requests for `prevent-display-sleep`. `prevent-display-sleep` +will be used until B stops its request. After that, `prevent-app-suspension` is used. ## powerSaveBlocker.stop(id) From cd93b9412c2620aa01ab5534a94620d9d01f2738 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 24 Jun 2015 13:22:09 +0800 Subject: [PATCH 0359/1293] Add C++ version of IDWeakMap --- atom/common/id_weak_map.cc | 70 ++++++++++++++++++++++++++++++++++++++ atom/common/id_weak_map.h | 55 ++++++++++++++++++++++++++++++ filenames.gypi | 2 ++ 3 files changed, 127 insertions(+) create mode 100644 atom/common/id_weak_map.cc create mode 100644 atom/common/id_weak_map.h diff --git a/atom/common/id_weak_map.cc b/atom/common/id_weak_map.cc new file mode 100644 index 000000000000..556b9ba5d993 --- /dev/null +++ b/atom/common/id_weak_map.cc @@ -0,0 +1,70 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#include "atom/common/id_weak_map.h" + +#include + +#include "native_mate/converter.h" + +namespace atom { + +IDWeakMap::IDWeakMap() : next_id_(0) { +} + +IDWeakMap::~IDWeakMap() { +} + +int32_t IDWeakMap::Add(v8::Isolate* isolate, v8::Local object) { + int32_t id = GetNextID(); + object->SetHiddenValue(mate::StringToSymbol(isolate, "IDWeakMapKey"), + mate::Converter::ToV8(isolate, id)); + + auto global = make_linked_ptr(new v8::Global(isolate, object)); + global->SetWeak(this, &WeakCallback); + map_.emplace(id, global); + return id; +} + +v8::MaybeLocal IDWeakMap::Get(v8::Isolate* isolate, int32_t id) { + auto iter = map_.find(id); + if (iter == map_.end()) + return v8::MaybeLocal(); + else + return v8::Local::New(isolate, *iter->second); +} + +bool IDWeakMap::Has(int32_t id) const { + return map_.find(id) != map_.end(); +} + +std::vector IDWeakMap::Keys() const { + std::vector keys; + keys.reserve(map_.size()); + for (const auto& iter : map_) + keys.emplace_back(iter.first); + return keys; +} + +void IDWeakMap::Remove(int32_t id) { + auto iter = map_.find(id); + if (iter == map_.end()) + LOG(WARNING) << "Removing unexist object with ID " << id; + else + map_.erase(iter); +} + +int IDWeakMap::GetNextID() { + return ++next_id_; +} + +// static +void IDWeakMap::WeakCallback( + const v8::WeakCallbackData& data) { + int32_t id = data.GetValue()->GetHiddenValue( + mate::StringToV8(data.GetIsolate(), "IDWeakMapKey"))->Int32Value(); + data.GetParameter()->Remove(id); +} + +} // namespace atom diff --git a/atom/common/id_weak_map.h b/atom/common/id_weak_map.h new file mode 100644 index 000000000000..4ef3c05eb6da --- /dev/null +++ b/atom/common/id_weak_map.h @@ -0,0 +1,55 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#ifndef ATOM_COMMON_ID_WEAK_MAP_H_ +#define ATOM_COMMON_ID_WEAK_MAP_H_ + +#include +#include + +#include "base/memory/linked_ptr.h" +#include "v8/include/v8.h" + +namespace atom { + +// Like ES6's WeakMap, but the key is Integer and the value is Weak Pointer. +class IDWeakMap { + public: + IDWeakMap(); + ~IDWeakMap(); + + // Adds |object| to WeakMap and returns its allocated |id|. + int32_t Add(v8::Isolate* isolate, v8::Local object); + + // Gets the object from WeakMap by its |id|. + v8::MaybeLocal Get(v8::Isolate* isolate, int32_t id); + + // Whethere there is an object with |id| in this WeakMap. + bool Has(int32_t id) const; + + // Returns IDs of all available objects. + std::vector Keys() const; + + // Remove object with |id| in the WeakMap. + void Remove(int32_t key); + + private: + // Returns next available ID. + int GetNextID(); + + static void WeakCallback( + const v8::WeakCallbackData& data); + + // ID of next stored object. + int32_t next_id_; + + // Map of stored objects. + std::unordered_map>> map_; + + DISALLOW_COPY_AND_ASSIGN(IDWeakMap); +}; + +} // namespace atom + +#endif // ATOM_COMMON_ID_WEAK_MAP_H_ diff --git a/filenames.gypi b/filenames.gypi index f0c940ab52d5..8a23c38099d5 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -254,6 +254,8 @@ 'atom/common/event_emitter_caller.cc', 'atom/common/event_emitter_caller.h', 'atom/common/google_api_key.h', + 'atom/common/id_weak_map.cc', + 'atom/common/id_weak_map.h', 'atom/common/linux/application_info.cc', 'atom/common/native_mate_converters/accelerator_converter.cc', 'atom/common/native_mate_converters/accelerator_converter.h', From d02413de0071f8496087ae219e02c8f9105a5791 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 24 Jun 2015 13:35:39 +0800 Subject: [PATCH 0360/1293] Make the JS IDWeakMap a thin wrapper of C++ IDWeakMap --- atom/common/api/atom_api_id_weak_map.cc | 51 ++++++------------------- atom/common/api/atom_api_id_weak_map.h | 14 +------ atom/common/id_weak_map.cc | 2 +- atom/common/id_weak_map.h | 2 +- 4 files changed, 16 insertions(+), 53 deletions(-) diff --git a/atom/common/api/atom_api_id_weak_map.cc b/atom/common/api/atom_api_id_weak_map.cc index 614683c473a5..c5fbf09370f2 100644 --- a/atom/common/api/atom_api_id_weak_map.cc +++ b/atom/common/api/atom_api_id_weak_map.cc @@ -4,9 +4,6 @@ #include "atom/common/api/atom_api_id_weak_map.h" -#include - -#include "base/logging.h" #include "native_mate/constructor.h" #include "native_mate/object_template_builder.h" @@ -16,53 +13,37 @@ namespace atom { namespace api { -IDWeakMap::IDWeakMap() - : next_id_(0) { +IDWeakMap::IDWeakMap() { } IDWeakMap::~IDWeakMap() { } int32_t IDWeakMap::Add(v8::Isolate* isolate, v8::Local object) { - int32_t key = GetNextID(); - object->SetHiddenValue(mate::StringToV8(isolate, "IDWeakMapKey"), - mate::Converter::ToV8(isolate, key)); - - map_[key] = new mate::RefCountedPersistent(isolate, object); - map_[key]->SetWeak(this, WeakCallback); - return key; + return map_.Add(isolate, object); } v8::Local IDWeakMap::Get(v8::Isolate* isolate, int32_t key) { - if (!Has(key)) { - node::ThrowError(isolate, "Invalid key"); + v8::MaybeLocal result = map_.Get(isolate, key); + if (result.IsEmpty()) { + isolate->ThrowException(v8::Exception::Error( + mate::StringToV8(isolate, "Invalid key"))); return v8::Undefined(isolate); + } else { + return result.ToLocalChecked(); } - - return map_[key]->NewHandle(); } bool IDWeakMap::Has(int32_t key) const { - return map_.find(key) != map_.end(); + return map_.Has(key); } std::vector IDWeakMap::Keys() const { - std::vector keys; - keys.reserve(map_.size()); - for (auto it = map_.begin(); it != map_.end(); ++it) - keys.push_back(it->first); - return keys; + return map_.Keys(); } void IDWeakMap::Remove(int32_t key) { - if (Has(key)) - map_.erase(key); - else - LOG(WARNING) << "Object with key " << key << " is being GCed for twice."; -} - -int IDWeakMap::GetNextID() { - return ++next_id_; + map_.Remove(key); } // static @@ -76,14 +57,6 @@ void IDWeakMap::BuildPrototype(v8::Isolate* isolate, .SetMethod("remove", &IDWeakMap::Remove); } -// static -void IDWeakMap::WeakCallback( - const v8::WeakCallbackData& data) { - int32_t key = data.GetValue()->GetHiddenValue( - mate::StringToV8(data.GetIsolate(), "IDWeakMapKey"))->Int32Value(); - data.GetParameter()->Remove(key); -} - } // namespace api } // namespace atom @@ -99,7 +72,7 @@ void Initialize(v8::Local exports, v8::Local unused, isolate, "IDWeakMap", base::Bind(&mate::NewOperatorFactory)); - exports->Set(mate::StringToV8(isolate, "IDWeakMap"), constructor); + exports->Set(mate::StringToSymbol(isolate, "IDWeakMap"), constructor); } } // namespace diff --git a/atom/common/api/atom_api_id_weak_map.h b/atom/common/api/atom_api_id_weak_map.h index 0648ce925202..955bd83088ac 100644 --- a/atom/common/api/atom_api_id_weak_map.h +++ b/atom/common/api/atom_api_id_weak_map.h @@ -6,11 +6,9 @@ #ifndef ATOM_COMMON_API_ATOM_API_ID_WEAK_MAP_H_ #define ATOM_COMMON_API_ATOM_API_ID_WEAK_MAP_H_ -#include #include -#include "base/basictypes.h" -#include "native_mate/scoped_persistent.h" +#include "atom/common/id_weak_map.h" #include "native_mate/wrappable.h" namespace atom { @@ -33,16 +31,8 @@ class IDWeakMap : public mate::Wrappable { bool Has(int32_t key) const; std::vector Keys() const; void Remove(int32_t key); - int GetNextID(); - static void WeakCallback( - const v8::WeakCallbackData& data); - - int32_t next_id_; - - typedef scoped_refptr > - RefCountedV8Object; - std::map map_; + atom::IDWeakMap map_; DISALLOW_COPY_AND_ASSIGN(IDWeakMap); }; diff --git a/atom/common/id_weak_map.cc b/atom/common/id_weak_map.cc index 556b9ba5d993..68923b143dd5 100644 --- a/atom/common/id_weak_map.cc +++ b/atom/common/id_weak_map.cc @@ -55,7 +55,7 @@ void IDWeakMap::Remove(int32_t id) { map_.erase(iter); } -int IDWeakMap::GetNextID() { +int32_t IDWeakMap::GetNextID() { return ++next_id_; } diff --git a/atom/common/id_weak_map.h b/atom/common/id_weak_map.h index 4ef3c05eb6da..cd010984a093 100644 --- a/atom/common/id_weak_map.h +++ b/atom/common/id_weak_map.h @@ -36,7 +36,7 @@ class IDWeakMap { private: // Returns next available ID. - int GetNextID(); + int32_t GetNextID(); static void WeakCallback( const v8::WeakCallbackData& data); From 15f350edcbb44535b478485b84e7ab250be8f960 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 24 Jun 2015 13:38:55 +0800 Subject: [PATCH 0361/1293] Don't make IDWeakMap public API --- atom/browser/api/lib/browser-window.coffee | 2 +- atom/browser/lib/objects-registry.coffee | 2 +- atom/common/api/lib/id-weak-map.coffee | 3 --- filenames.gypi | 1 - 4 files changed, 2 insertions(+), 6 deletions(-) delete mode 100644 atom/common/api/lib/id-weak-map.coffee diff --git a/atom/browser/api/lib/browser-window.coffee b/atom/browser/api/lib/browser-window.coffee index aa271763eca5..475b98dde42f 100644 --- a/atom/browser/api/lib/browser-window.coffee +++ b/atom/browser/api/lib/browser-window.coffee @@ -1,5 +1,5 @@ EventEmitter = require('events').EventEmitter -IDWeakMap = require 'id-weak-map' +IDWeakMap = process.atomBinding('id_weak_map').IDWeakMap app = require 'app' ipc = require 'ipc' diff --git a/atom/browser/lib/objects-registry.coffee b/atom/browser/lib/objects-registry.coffee index e159730330e2..f102cbef894e 100644 --- a/atom/browser/lib/objects-registry.coffee +++ b/atom/browser/lib/objects-registry.coffee @@ -1,5 +1,5 @@ EventEmitter = require('events').EventEmitter -IDWeakMap = require 'id-weak-map' +IDWeakMap = process.atomBinding('id_weak_map').IDWeakMap v8Util = process.atomBinding 'v8_util' # Class to reference all objects. diff --git a/atom/common/api/lib/id-weak-map.coffee b/atom/common/api/lib/id-weak-map.coffee deleted file mode 100644 index 794573ba5e26..000000000000 --- a/atom/common/api/lib/id-weak-map.coffee +++ /dev/null @@ -1,3 +0,0 @@ -IDWeakMap = process.atomBinding('id_weak_map').IDWeakMap - -module.exports = IDWeakMap diff --git a/filenames.gypi b/filenames.gypi index 8a23c38099d5..da18fbe14f11 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -33,7 +33,6 @@ 'atom/common/api/lib/callbacks-registry.coffee', 'atom/common/api/lib/clipboard.coffee', 'atom/common/api/lib/crash-reporter.coffee', - 'atom/common/api/lib/id-weak-map.coffee', 'atom/common/api/lib/native-image.coffee', 'atom/common/api/lib/shell.coffee', 'atom/common/lib/init.coffee', From 7f0658efa7aa3f356c17e0406e4ecb3a15d2ac70 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 24 Jun 2015 14:36:05 +0800 Subject: [PATCH 0362/1293] Add mate::TrackableObject --- atom/browser/api/atom_api_web_contents.h | 4 +-- atom/browser/api/trackable_object.cc | 39 +++++++++++++++++++++ atom/browser/api/trackable_object.h | 43 ++++++++++++++++++++++++ atom/browser/atom_browser_main_parts.cc | 2 ++ atom/common/id_weak_map.cc | 4 +++ atom/common/id_weak_map.h | 3 ++ filenames.gypi | 2 ++ 7 files changed, 95 insertions(+), 2 deletions(-) create mode 100644 atom/browser/api/trackable_object.cc create mode 100644 atom/browser/api/trackable_object.h diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index a2bfda874cbd..d0179d7eb091 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -8,7 +8,7 @@ #include #include -#include "atom/browser/api/event_emitter.h" +#include "atom/browser/api/trackable_object.h" #include "atom/browser/common_web_contents_delegate.h" #include "content/public/browser/browser_plugin_guest_delegate.h" #include "content/public/common/favicon_url.h" @@ -46,7 +46,7 @@ struct SetSizeParams { scoped_ptr normal_size; }; -class WebContents : public mate::EventEmitter, +class WebContents : public mate::TrackableObject, public content::BrowserPluginGuestDelegate, public CommonWebContentsDelegate, public content::WebContentsObserver, diff --git a/atom/browser/api/trackable_object.cc b/atom/browser/api/trackable_object.cc new file mode 100644 index 000000000000..fb0762af5bc0 --- /dev/null +++ b/atom/browser/api/trackable_object.cc @@ -0,0 +1,39 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#include "atom/browser/api/trackable_object.h" + +namespace mate { + +atom::IDWeakMap TrackableObject::weak_map_; + +// static +TrackableObject* TrackableObject::FromWeakMapID(v8::Isolate* isolate, + int32_t id) { + v8::MaybeLocal object = weak_map_.Get(isolate, id); + if (object.IsEmpty()) + return nullptr; + + TrackableObject* self = nullptr; + mate::ConvertFromV8(isolate, object.ToLocalChecked(), &self); + return self; +} + +// static +void TrackableObject::ReleaseAllWeakReferences() { + weak_map_.Clear(); +} + +TrackableObject::TrackableObject() : weak_map_id_(0) { +} + +TrackableObject::~TrackableObject() { + weak_map_.Remove(weak_map_id_); +} + +void TrackableObject::AfterInit(v8::Isolate* isolate) { + weak_map_id_ = weak_map_.Add(isolate, GetWrapper(isolate)); +} + +} // namespace mate diff --git a/atom/browser/api/trackable_object.h b/atom/browser/api/trackable_object.h new file mode 100644 index 000000000000..e3030d32d239 --- /dev/null +++ b/atom/browser/api/trackable_object.h @@ -0,0 +1,43 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#ifndef ATOM_BROWSER_API_TRACKABLE_OBJECT_H_ +#define ATOM_BROWSER_API_TRACKABLE_OBJECT_H_ + +#include "atom/browser/api/event_emitter.h" +#include "atom/common/id_weak_map.h" + +namespace mate { + +// All instances of TrackableObject will be kept in a weak map and can be got +// from its ID. +class TrackableObject : public mate::EventEmitter { + public: + // Find out the TrackableObject from its ID in weak map: + static TrackableObject* FromWeakMapID(v8::Isolate* isolate, int32_t id); + + // Releases all weak references in weak map, called when app is terminating. + static void ReleaseAllWeakReferences(); + + // mate::Wrappable: + void AfterInit(v8::Isolate* isolate) override; + + // The ID in weak map. + int32_t weak_map_id() const { return weak_map_id_; } + + protected: + TrackableObject(); + ~TrackableObject() override; + + private: + static atom::IDWeakMap weak_map_; + + int32_t weak_map_id_; + + DISALLOW_COPY_AND_ASSIGN(TrackableObject); +}; + +} // namespace mate + +#endif // ATOM_BROWSER_API_TRACKABLE_OBJECT_H_ diff --git a/atom/browser/atom_browser_main_parts.cc b/atom/browser/atom_browser_main_parts.cc index a63ec9a703b2..b2a00452c75d 100644 --- a/atom/browser/atom_browser_main_parts.cc +++ b/atom/browser/atom_browser_main_parts.cc @@ -4,6 +4,7 @@ #include "atom/browser/atom_browser_main_parts.h" +#include "atom/browser/api/trackable_object.h" #include "atom/browser/atom_browser_client.h" #include "atom/browser/atom_browser_context.h" #include "atom/browser/browser.h" @@ -36,6 +37,7 @@ AtomBrowserMainParts::AtomBrowserMainParts() } AtomBrowserMainParts::~AtomBrowserMainParts() { + mate::TrackableObject::ReleaseAllWeakReferences(); } // static diff --git a/atom/common/id_weak_map.cc b/atom/common/id_weak_map.cc index 68923b143dd5..4b653cafee30 100644 --- a/atom/common/id_weak_map.cc +++ b/atom/common/id_weak_map.cc @@ -55,6 +55,10 @@ void IDWeakMap::Remove(int32_t id) { map_.erase(iter); } +void IDWeakMap::Clear() { + map_.clear(); +} + int32_t IDWeakMap::GetNextID() { return ++next_id_; } diff --git a/atom/common/id_weak_map.h b/atom/common/id_weak_map.h index cd010984a093..ce1a9a128798 100644 --- a/atom/common/id_weak_map.h +++ b/atom/common/id_weak_map.h @@ -34,6 +34,9 @@ class IDWeakMap { // Remove object with |id| in the WeakMap. void Remove(int32_t key); + // Clears the weak map. + void Clear(); + private: // Returns next available ID. int32_t GetNextID(); diff --git a/filenames.gypi b/filenames.gypi index da18fbe14f11..f5f7f8686c20 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -96,6 +96,8 @@ 'atom/browser/api/event.h', 'atom/browser/api/event_emitter.cc', 'atom/browser/api/event_emitter.h', + 'atom/browser/api/trackable_object.cc', + 'atom/browser/api/trackable_object.h', 'atom/browser/auto_updater.cc', 'atom/browser/auto_updater.h', 'atom/browser/auto_updater_delegate.h', From 552a12d2ee7cb13ad33c0ab8aad7b340235485d2 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 24 Jun 2015 14:49:08 +0800 Subject: [PATCH 0363/1293] Enable storing TrackableObject in other C++ class --- atom/browser/api/trackable_object.cc | 33 ++++++++++++++++++++++++++++ atom/browser/api/trackable_object.h | 13 ++++++++++- 2 files changed, 45 insertions(+), 1 deletion(-) diff --git a/atom/browser/api/trackable_object.cc b/atom/browser/api/trackable_object.cc index fb0762af5bc0..61f36fd904c4 100644 --- a/atom/browser/api/trackable_object.cc +++ b/atom/browser/api/trackable_object.cc @@ -4,8 +4,28 @@ #include "atom/browser/api/trackable_object.h" +#include "base/supports_user_data.h" + namespace mate { +namespace { + +const char* kTrackedObjectKey = "TrackedObjectKey"; + +class IDUserData : public base::SupportsUserData::Data { + public: + explicit IDUserData(int32_t id) : id_(id) {} + + operator int32_t() const { return id_; } + + private: + int32_t id_; + + DISALLOW_COPY_AND_ASSIGN(IDUserData); +}; + +} // namespace + atom::IDWeakMap TrackableObject::weak_map_; // static @@ -20,6 +40,15 @@ TrackableObject* TrackableObject::FromWeakMapID(v8::Isolate* isolate, return self; } +// static +TrackableObject* TrackableObject::FromWrappedClass( + v8::Isolate* isolate, base::SupportsUserData* wrapped) { + auto id = static_cast(wrapped->GetUserData(kTrackedObjectKey)); + if (!id) + return nullptr; + return FromWeakMapID(isolate, *id); +} + // static void TrackableObject::ReleaseAllWeakReferences() { weak_map_.Clear(); @@ -36,4 +65,8 @@ void TrackableObject::AfterInit(v8::Isolate* isolate) { weak_map_id_ = weak_map_.Add(isolate, GetWrapper(isolate)); } +void TrackableObject::Attach(base::SupportsUserData* wrapped) { + wrapped->SetUserData(kTrackedObjectKey, new IDUserData(weak_map_id_)); +} + } // namespace mate diff --git a/atom/browser/api/trackable_object.h b/atom/browser/api/trackable_object.h index e3030d32d239..b09fc35be8da 100644 --- a/atom/browser/api/trackable_object.h +++ b/atom/browser/api/trackable_object.h @@ -8,15 +8,23 @@ #include "atom/browser/api/event_emitter.h" #include "atom/common/id_weak_map.h" +namespace base { +class SupportsUserData; +} + namespace mate { // All instances of TrackableObject will be kept in a weak map and can be got // from its ID. class TrackableObject : public mate::EventEmitter { public: - // Find out the TrackableObject from its ID in weak map: + // Find out the TrackableObject from its ID in weak map. static TrackableObject* FromWeakMapID(v8::Isolate* isolate, int32_t id); + // Find out the TrackableObject from the class it wraps. + static TrackableObject* FromWrappedClass( + v8::Isolate* isolate, base::SupportsUserData* wrapped); + // Releases all weak references in weak map, called when app is terminating. static void ReleaseAllWeakReferences(); @@ -30,6 +38,9 @@ class TrackableObject : public mate::EventEmitter { TrackableObject(); ~TrackableObject() override; + // Wrap TrackableObject into a class that SupportsUserData. + void Attach(base::SupportsUserData* wrapped); + private: static atom::IDWeakMap weak_map_; From 1023b67d59f43ca6d92cf29d19c512fda6ccde6e Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 24 Jun 2015 15:09:50 +0800 Subject: [PATCH 0364/1293] Make sure each C++ WebContents has only one JS WebContents --- atom/browser/api/atom_api_web_contents.cc | 18 ++++++++++++++++++ atom/browser/api/atom_api_web_contents.h | 1 + atom/browser/api/trackable_object.cc | 2 +- atom/browser/api/trackable_object.h | 2 +- 4 files changed, 21 insertions(+), 2 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index c64db2810ec5..0aace7a3f81f 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -784,6 +784,11 @@ bool WebContents::IsGuest() const { return is_guest(); } +void WebContents::AfterInit(v8::Isolate* isolate) { + mate::TrackableObject::AfterInit(isolate); + AttachAsUserData(web_contents()); +} + mate::ObjectTemplateBuilder WebContents::GetObjectTemplateBuilder( v8::Isolate* isolate) { if (template_.IsEmpty()) @@ -873,6 +878,13 @@ gfx::Size WebContents::GetDefaultSize() const { // static mate::Handle WebContents::CreateFrom( v8::Isolate* isolate, brightray::InspectableWebContents* web_contents) { + // We have an existing WebContents object in JS. + auto existing = TrackableObject::FromWrappedClass( + isolate, web_contents->GetWebContents()); + if (existing) + return mate::CreateHandle(isolate, static_cast(existing)); + + // Otherwise create a new WebContents wrapper object. auto handle = mate::CreateHandle(isolate, new WebContents(web_contents)); g_wrap_web_contents.Run(handle.ToV8()); return handle; @@ -881,6 +893,12 @@ mate::Handle WebContents::CreateFrom( // static mate::Handle WebContents::CreateFrom( v8::Isolate* isolate, content::WebContents* web_contents) { + // We have an existing WebContents object in JS. + auto existing = TrackableObject::FromWrappedClass(isolate, web_contents); + if (existing) + return mate::CreateHandle(isolate, static_cast(existing)); + + // Otherwise create a new WebContents wrapper object. auto handle = mate::CreateHandle(isolate, new WebContents(web_contents)); g_wrap_web_contents.Run(handle.ToV8()); return handle; diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index d0179d7eb091..c109b1903af8 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -142,6 +142,7 @@ class WebContents : public mate::TrackableObject, ~WebContents(); // mate::Wrappable: + void AfterInit(v8::Isolate* isolate); mate::ObjectTemplateBuilder GetObjectTemplateBuilder( v8::Isolate* isolate) override; diff --git a/atom/browser/api/trackable_object.cc b/atom/browser/api/trackable_object.cc index 61f36fd904c4..417d5f6a170b 100644 --- a/atom/browser/api/trackable_object.cc +++ b/atom/browser/api/trackable_object.cc @@ -65,7 +65,7 @@ void TrackableObject::AfterInit(v8::Isolate* isolate) { weak_map_id_ = weak_map_.Add(isolate, GetWrapper(isolate)); } -void TrackableObject::Attach(base::SupportsUserData* wrapped) { +void TrackableObject::AttachAsUserData(base::SupportsUserData* wrapped) { wrapped->SetUserData(kTrackedObjectKey, new IDUserData(weak_map_id_)); } diff --git a/atom/browser/api/trackable_object.h b/atom/browser/api/trackable_object.h index b09fc35be8da..67e7ff45156c 100644 --- a/atom/browser/api/trackable_object.h +++ b/atom/browser/api/trackable_object.h @@ -39,7 +39,7 @@ class TrackableObject : public mate::EventEmitter { ~TrackableObject() override; // Wrap TrackableObject into a class that SupportsUserData. - void Attach(base::SupportsUserData* wrapped); + void AttachAsUserData(base::SupportsUserData* wrapped); private: static atom::IDWeakMap weak_map_; From 0ebd4d04ad3150396aeb5213395045cfcd79360f Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 24 Jun 2015 15:37:04 +0800 Subject: [PATCH 0365/1293] Make Session trackable --- atom/browser/api/atom_api_app.cc | 2 +- atom/browser/api/atom_api_session.cc | 7 ++++++- atom/browser/api/atom_api_session.h | 9 +++++---- atom/browser/api/atom_api_web_contents.cc | 9 +++------ atom/browser/api/atom_api_web_contents.h | 2 -- atom/browser/api/trackable_object.cc | 13 +++++++++++-- atom/browser/api/trackable_object.h | 1 + 7 files changed, 27 insertions(+), 16 deletions(-) diff --git a/atom/browser/api/atom_api_app.cc b/atom/browser/api/atom_api_app.cc index 0c298f131f56..ec9e86dd8440 100644 --- a/atom/browser/api/atom_api_app.cc +++ b/atom/browser/api/atom_api_app.cc @@ -176,7 +176,7 @@ v8::Local App::DefaultSession(v8::Isolate* isolate) { if (default_session_.IsEmpty()) { auto browser_context = static_cast( AtomBrowserMainParts::Get()->browser_context()); - auto handle = Session::Create(isolate, browser_context); + auto handle = Session::CreateFrom(isolate, browser_context); default_session_.Reset(isolate, handle.ToV8()); } return v8::Local::New(isolate, default_session_); diff --git a/atom/browser/api/atom_api_session.cc b/atom/browser/api/atom_api_session.cc index 0ff22889f7ae..8a718b56301d 100644 --- a/atom/browser/api/atom_api_session.cc +++ b/atom/browser/api/atom_api_session.cc @@ -68,6 +68,7 @@ class ResolveProxyHelper { Session::Session(AtomBrowserContext* browser_context) : browser_context_(browser_context) { + AttachAsUserData(browser_context); } Session::~Session() { @@ -93,9 +94,13 @@ mate::ObjectTemplateBuilder Session::GetObjectTemplateBuilder( } // static -mate::Handle Session::Create( +mate::Handle Session::CreateFrom( v8::Isolate* isolate, AtomBrowserContext* browser_context) { + auto existing = TrackableObject::FromWrappedClass(isolate, browser_context); + if (existing) + return mate::CreateHandle(isolate, static_cast(existing)); + return mate::CreateHandle(isolate, new Session(browser_context)); } diff --git a/atom/browser/api/atom_api_session.h b/atom/browser/api/atom_api_session.h index 6e2c0fce1960..9b1068dbd886 100644 --- a/atom/browser/api/atom_api_session.h +++ b/atom/browser/api/atom_api_session.h @@ -7,9 +7,9 @@ #include +#include "atom/browser/api/trackable_object.h" #include "base/callback.h" #include "native_mate/handle.h" -#include "native_mate/wrappable.h" class GURL; @@ -19,12 +19,13 @@ class AtomBrowserContext; namespace api { -class Session: public mate::Wrappable { +class Session: public mate::TrackableObject { public: using ResolveProxyCallback = base::Callback; - static mate::Handle Create(v8::Isolate* isolate, - AtomBrowserContext* browser_context); + // Gets or creates Session from the |browser_context|. + static mate::Handle CreateFrom( + v8::Isolate* isolate, AtomBrowserContext* browser_context); protected: explicit Session(AtomBrowserContext* browser_context); diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 0aace7a3f81f..790a665dcba6 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -155,6 +155,7 @@ WebContents::WebContents(content::WebContents* web_contents) auto_size_enabled_(false), is_full_page_plugin_(false), inspectable_web_contents_(nullptr) { + AttachAsUserData(web_contents); } WebContents::WebContents(const mate::Dictionary& options) @@ -176,6 +177,7 @@ WebContents::WebContents(const mate::Dictionary& options) if (options.Get("embedder", &embedder) && embedder) owner_window = NativeWindow::FromWebContents(embedder->web_contents()); + AttachAsUserData(web_contents); InitWithWebContents(web_contents, owner_window); inspectable_web_contents_ = managed_web_contents(); @@ -608,7 +610,7 @@ void WebContents::InspectServiceWorker() { v8::Local WebContents::Session(v8::Isolate* isolate) { if (session_.IsEmpty()) { - mate::Handle handle = Session::Create( + mate::Handle handle = Session::CreateFrom( isolate, static_cast(web_contents()->GetBrowserContext())); session_.Reset(isolate, handle.ToV8()); @@ -784,11 +786,6 @@ bool WebContents::IsGuest() const { return is_guest(); } -void WebContents::AfterInit(v8::Isolate* isolate) { - mate::TrackableObject::AfterInit(isolate); - AttachAsUserData(web_contents()); -} - mate::ObjectTemplateBuilder WebContents::GetObjectTemplateBuilder( v8::Isolate* isolate) { if (template_.IsEmpty()) diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index c109b1903af8..6e0f542e070d 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -142,7 +142,6 @@ class WebContents : public mate::TrackableObject, ~WebContents(); // mate::Wrappable: - void AfterInit(v8::Isolate* isolate); mate::ObjectTemplateBuilder GetObjectTemplateBuilder( v8::Isolate* isolate) override; @@ -241,7 +240,6 @@ class WebContents : public mate::TrackableObject, // Returns the default size of the guestview. gfx::Size GetDefaultSize() const; - v8::Global session_; // Stores whether the contents of the guest can be transparent. diff --git a/atom/browser/api/trackable_object.cc b/atom/browser/api/trackable_object.cc index 417d5f6a170b..6e2924fac9c2 100644 --- a/atom/browser/api/trackable_object.cc +++ b/atom/browser/api/trackable_object.cc @@ -54,7 +54,7 @@ void TrackableObject::ReleaseAllWeakReferences() { weak_map_.Clear(); } -TrackableObject::TrackableObject() : weak_map_id_(0) { +TrackableObject::TrackableObject() : weak_map_id_(0), wrapped_(nullptr) { } TrackableObject::~TrackableObject() { @@ -63,10 +63,19 @@ TrackableObject::~TrackableObject() { void TrackableObject::AfterInit(v8::Isolate* isolate) { weak_map_id_ = weak_map_.Add(isolate, GetWrapper(isolate)); + if (wrapped_) + AttachAsUserData(wrapped_); } void TrackableObject::AttachAsUserData(base::SupportsUserData* wrapped) { - wrapped->SetUserData(kTrackedObjectKey, new IDUserData(weak_map_id_)); + if (weak_map_id_ != 0) { + wrapped->SetUserData(kTrackedObjectKey, new IDUserData(weak_map_id_)); + wrapped_ = nullptr; + } else { + // If the TrackableObject is not ready yet then delay SetUserData until + // AfterInit is called. + wrapped_ = wrapped; + } } } // namespace mate diff --git a/atom/browser/api/trackable_object.h b/atom/browser/api/trackable_object.h index 67e7ff45156c..3233f6da91e0 100644 --- a/atom/browser/api/trackable_object.h +++ b/atom/browser/api/trackable_object.h @@ -45,6 +45,7 @@ class TrackableObject : public mate::EventEmitter { static atom::IDWeakMap weak_map_; int32_t weak_map_id_; + base::SupportsUserData* wrapped_; DISALLOW_COPY_AND_ASSIGN(TrackableObject); }; From c2f14e6053515d51ff925e589b6531981178eace Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 24 Jun 2015 16:14:49 +0800 Subject: [PATCH 0366/1293] Initialize defaultSession after app is ready --- atom/browser/api/atom_api_app.cc | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/atom/browser/api/atom_api_app.cc b/atom/browser/api/atom_api_app.cc index ec9e86dd8440..473111dbc7e1 100644 --- a/atom/browser/api/atom_api_app.cc +++ b/atom/browser/api/atom_api_app.cc @@ -133,6 +133,14 @@ void App::OnWillFinishLaunching() { } void App::OnFinishLaunching() { + // Create the defaultSession. + v8::Locker locker(isolate()); + v8::HandleScope handle_scope(isolate()); + auto browser_context = static_cast( + AtomBrowserMainParts::Get()->browser_context()); + auto handle = Session::CreateFrom(isolate(), browser_context); + default_session_.Reset(isolate(), handle.ToV8()); + Emit("ready"); } @@ -173,13 +181,10 @@ void App::SetAppUserModelId(const std::string& app_id) { } v8::Local App::DefaultSession(v8::Isolate* isolate) { - if (default_session_.IsEmpty()) { - auto browser_context = static_cast( - AtomBrowserMainParts::Get()->browser_context()); - auto handle = Session::CreateFrom(isolate, browser_context); - default_session_.Reset(isolate, handle.ToV8()); - } - return v8::Local::New(isolate, default_session_); + if (default_session_.IsEmpty()) + return v8::Null(isolate); + else + return v8::Local::New(isolate, default_session_); } mate::ObjectTemplateBuilder App::GetObjectTemplateBuilder( From 5e62b5975b1406cd6e000575a3b1e437d65c83b4 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 24 Jun 2015 16:37:48 +0800 Subject: [PATCH 0367/1293] Move "id" and "fromId" to C++ --- atom/browser/api/atom_api_window.cc | 13 +++++++++++-- atom/browser/api/atom_api_window.h | 5 +++-- atom/browser/api/lib/browser-window.coffee | 8 -------- vendor/native_mate | 2 +- 4 files changed, 15 insertions(+), 13 deletions(-) diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index 21c6b327e8db..317d5e49ed21 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -435,6 +435,10 @@ bool Window::IsVisibleOnAllWorkspaces() { return window_->IsVisibleOnAllWorkspaces(); } +int32_t Window::ID() const { + return weak_map_id(); +} + v8::Local Window::WebContents(v8::Isolate* isolate) { if (web_contents_.IsEmpty()) { auto handle = @@ -518,6 +522,7 @@ void Window::BuildPrototype(v8::Isolate* isolate, .SetMethod("showDefinitionForSelection", &Window::ShowDefinitionForSelection) #endif + .SetProperty("id", &Window::ID) .SetProperty("webContents", &Window::WebContents) .SetProperty("devToolsWebContents", &Window::DevToolsWebContents); } @@ -529,14 +534,18 @@ void Window::BuildPrototype(v8::Isolate* isolate, namespace { +using atom::api::Window; + void Initialize(v8::Local exports, v8::Local unused, v8::Local context, void* priv) { - using atom::api::Window; v8::Isolate* isolate = context->GetIsolate(); v8::Local constructor = mate::CreateConstructor( isolate, "BrowserWindow", base::Bind(&Window::New)); + mate::Dictionary browser_window(isolate, constructor); + browser_window.SetMethod("fromId", &mate::TrackableObject::FromWeakMapID); + mate::Dictionary dict(isolate, exports); - dict.Set("BrowserWindow", static_cast>(constructor)); + dict.Set("BrowserWindow", browser_window); } } // namespace diff --git a/atom/browser/api/atom_api_window.h b/atom/browser/api/atom_api_window.h index d2b9d28034df..c6a3dd632086 100644 --- a/atom/browser/api/atom_api_window.h +++ b/atom/browser/api/atom_api_window.h @@ -10,8 +10,8 @@ #include "base/memory/scoped_ptr.h" #include "ui/gfx/image/image.h" +#include "atom/browser/api/trackable_object.h" #include "atom/browser/native_window_observer.h" -#include "atom/browser/api/event_emitter.h" #include "native_mate/handle.h" class GURL; @@ -37,7 +37,7 @@ namespace api { class WebContents; -class Window : public mate::EventEmitter, +class Window : public mate::TrackableObject, public NativeWindowObserver { public: static mate::Wrappable* New(v8::Isolate* isolate, @@ -147,6 +147,7 @@ class Window : public mate::EventEmitter, void SetVisibleOnAllWorkspaces(bool visible); bool IsVisibleOnAllWorkspaces(); + int32_t ID() const; v8::Local WebContents(v8::Isolate* isolate); v8::Local DevToolsWebContents(v8::Isolate* isolate); diff --git a/atom/browser/api/lib/browser-window.coffee b/atom/browser/api/lib/browser-window.coffee index 475b98dde42f..68144dde911a 100644 --- a/atom/browser/api/lib/browser-window.coffee +++ b/atom/browser/api/lib/browser-window.coffee @@ -15,11 +15,6 @@ BrowserWindow::_init = -> menu = app.getApplicationMenu() @setMenu menu if menu? - # Remember the window ID. - Object.defineProperty this, 'id', - value: BrowserWindow.windows.add(this) - enumerable: true - # Make new windows requested by links behave like "window.open" @on '-new-window', (event, url, frameName) => event.sender = @webContents @@ -63,9 +58,6 @@ BrowserWindow.fromDevToolsWebContents = (webContents) -> windows = BrowserWindow.getAllWindows() return window for window in windows when window.devToolsWebContents?.equal webContents -BrowserWindow.fromId = (id) -> - BrowserWindow.windows.get id if BrowserWindow.windows.has id - # Helpers. BrowserWindow::loadUrl = -> @webContents.loadUrl.apply @webContents, arguments BrowserWindow::send = -> @webContents.send.apply @webContents, arguments diff --git a/vendor/native_mate b/vendor/native_mate index cad1fa50a95c..cc4e2fcd94b5 160000 --- a/vendor/native_mate +++ b/vendor/native_mate @@ -1 +1 @@ -Subproject commit cad1fa50a95ca4185c435846e4868d5bd6cc94df +Subproject commit cc4e2fcd94b5a22e6720f0fba1c586a89640f1f6 From 28d1fb8cad11e4de01da572277cf806f902c9490 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 24 Jun 2015 16:54:20 +0800 Subject: [PATCH 0368/1293] Add Values() method for IDWeakMap --- atom/common/id_weak_map.cc | 8 ++++++++ atom/common/id_weak_map.h | 3 +++ 2 files changed, 11 insertions(+) diff --git a/atom/common/id_weak_map.cc b/atom/common/id_weak_map.cc index 4b653cafee30..fc5fa13a43eb 100644 --- a/atom/common/id_weak_map.cc +++ b/atom/common/id_weak_map.cc @@ -47,6 +47,14 @@ std::vector IDWeakMap::Keys() const { return keys; } +std::vector> IDWeakMap::Values(v8::Isolate* isolate) { + std::vector> keys; + keys.reserve(map_.size()); + for (const auto& iter : map_) + keys.emplace_back(v8::Local::New(isolate, *iter.second)); + return keys; +} + void IDWeakMap::Remove(int32_t id) { auto iter = map_.find(id); if (iter == map_.end()) diff --git a/atom/common/id_weak_map.h b/atom/common/id_weak_map.h index ce1a9a128798..b16334d6cea1 100644 --- a/atom/common/id_weak_map.h +++ b/atom/common/id_weak_map.h @@ -31,6 +31,9 @@ class IDWeakMap { // Returns IDs of all available objects. std::vector Keys() const; + // Returns all objects. + std::vector> Values(v8::Isolate* isolate); + // Remove object with |id| in the WeakMap. void Remove(int32_t key); From cc8b22b5ff212901f6442da8ea140b961e9ef45c Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 24 Jun 2015 17:58:12 +0800 Subject: [PATCH 0369/1293] Make each class only have one weak map --- atom/browser/api/atom_api_session.h | 2 +- atom/browser/api/atom_api_web_contents.cc | 1 + atom/browser/api/atom_api_web_contents.h | 2 +- atom/browser/api/atom_api_window.cc | 6 +- atom/browser/api/atom_api_window.h | 2 +- atom/browser/api/lib/browser-window.coffee | 4 - atom/browser/api/trackable_object.cc | 57 +++++------- atom/browser/api/trackable_object.h | 103 ++++++++++++++++----- atom/browser/atom_browser_main_parts.cc | 8 +- atom/browser/atom_browser_main_parts.h | 10 ++ 10 files changed, 130 insertions(+), 65 deletions(-) diff --git a/atom/browser/api/atom_api_session.h b/atom/browser/api/atom_api_session.h index 9b1068dbd886..cd9f0a59a872 100644 --- a/atom/browser/api/atom_api_session.h +++ b/atom/browser/api/atom_api_session.h @@ -19,7 +19,7 @@ class AtomBrowserContext; namespace api { -class Session: public mate::TrackableObject { +class Session: public mate::TrackableObject { public: using ResolveProxyCallback = base::Callback; diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 790a665dcba6..027a74982192 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -424,6 +424,7 @@ void WebContents::WebContentsDestroyed() { // The RenderViewDeleted was not called when the WebContents is destroyed. RenderViewDeleted(web_contents()->GetRenderViewHost()); Emit("destroyed"); + RemoveFromWeakMap(); } void WebContents::NavigationEntryCommitted( diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index 6e0f542e070d..741b0398e777 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -46,7 +46,7 @@ struct SetSizeParams { scoped_ptr normal_size; }; -class WebContents : public mate::TrackableObject, +class WebContents : public mate::TrackableObject, public content::BrowserPluginGuestDelegate, public CommonWebContentsDelegate, public content::WebContentsObserver, diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index 317d5e49ed21..d764cee579e2 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -72,6 +72,7 @@ void Window::WillCloseWindow(bool* prevent_default) { void Window::OnWindowClosed() { Emit("closed"); + RemoveFromWeakMap(); window_->RemoveObserver(this); } @@ -542,7 +543,10 @@ void Initialize(v8::Local exports, v8::Local unused, v8::Local constructor = mate::CreateConstructor( isolate, "BrowserWindow", base::Bind(&Window::New)); mate::Dictionary browser_window(isolate, constructor); - browser_window.SetMethod("fromId", &mate::TrackableObject::FromWeakMapID); + browser_window.SetMethod("fromId", + &mate::TrackableObject::FromWeakMapID); + browser_window.SetMethod("getAllWindows", + &mate::TrackableObject::GetAll); mate::Dictionary dict(isolate, exports); dict.Set("BrowserWindow", browser_window); diff --git a/atom/browser/api/atom_api_window.h b/atom/browser/api/atom_api_window.h index c6a3dd632086..0c4cd76a8655 100644 --- a/atom/browser/api/atom_api_window.h +++ b/atom/browser/api/atom_api_window.h @@ -37,7 +37,7 @@ namespace api { class WebContents; -class Window : public mate::TrackableObject, +class Window : public mate::TrackableObject, public NativeWindowObserver { public: static mate::Wrappable* New(v8::Isolate* isolate, diff --git a/atom/browser/api/lib/browser-window.coffee b/atom/browser/api/lib/browser-window.coffee index 68144dde911a..15411fb85769 100644 --- a/atom/browser/api/lib/browser-window.coffee +++ b/atom/browser/api/lib/browser-window.coffee @@ -42,10 +42,6 @@ BrowserWindow::setMenu = (menu) -> @menu = menu # Keep a reference of menu in case of GC. @_setMenu menu -BrowserWindow.getAllWindows = -> - windows = BrowserWindow.windows - windows.get key for key in windows.keys() - BrowserWindow.getFocusedWindow = -> windows = BrowserWindow.getAllWindows() return window for window in windows when window.isFocused() diff --git a/atom/browser/api/trackable_object.cc b/atom/browser/api/trackable_object.cc index 6e2924fac9c2..ae9fa44230a0 100644 --- a/atom/browser/api/trackable_object.cc +++ b/atom/browser/api/trackable_object.cc @@ -4,6 +4,8 @@ #include "atom/browser/api/trackable_object.h" +#include "atom/browser/atom_browser_main_parts.h" +#include "base/bind.h" #include "base/supports_user_data.h" namespace mate { @@ -26,56 +28,41 @@ class IDUserData : public base::SupportsUserData::Data { } // namespace -atom::IDWeakMap TrackableObject::weak_map_; - -// static -TrackableObject* TrackableObject::FromWeakMapID(v8::Isolate* isolate, - int32_t id) { - v8::MaybeLocal object = weak_map_.Get(isolate, id); - if (object.IsEmpty()) - return nullptr; - - TrackableObject* self = nullptr; - mate::ConvertFromV8(isolate, object.ToLocalChecked(), &self); - return self; +TrackableObjectBase::TrackableObjectBase() + : weak_map_id_(0), wrapped_(nullptr) { } -// static -TrackableObject* TrackableObject::FromWrappedClass( - v8::Isolate* isolate, base::SupportsUserData* wrapped) { - auto id = static_cast(wrapped->GetUserData(kTrackedObjectKey)); - if (!id) - return nullptr; - return FromWeakMapID(isolate, *id); +TrackableObjectBase::~TrackableObjectBase() { } -// static -void TrackableObject::ReleaseAllWeakReferences() { - weak_map_.Clear(); -} - -TrackableObject::TrackableObject() : weak_map_id_(0), wrapped_(nullptr) { -} - -TrackableObject::~TrackableObject() { - weak_map_.Remove(weak_map_id_); -} - -void TrackableObject::AfterInit(v8::Isolate* isolate) { - weak_map_id_ = weak_map_.Add(isolate, GetWrapper(isolate)); +void TrackableObjectBase::AfterInit(v8::Isolate* isolate) { if (wrapped_) AttachAsUserData(wrapped_); } -void TrackableObject::AttachAsUserData(base::SupportsUserData* wrapped) { +void TrackableObjectBase::AttachAsUserData(base::SupportsUserData* wrapped) { if (weak_map_id_ != 0) { wrapped->SetUserData(kTrackedObjectKey, new IDUserData(weak_map_id_)); wrapped_ = nullptr; } else { - // If the TrackableObject is not ready yet then delay SetUserData until + // If the TrackableObjectBase is not ready yet then delay SetUserData until // AfterInit is called. wrapped_ = wrapped; } } +// static +int32_t TrackableObjectBase::GetIDFromWrappedClass(base::SupportsUserData* w) { + auto id = static_cast(w->GetUserData(kTrackedObjectKey)); + if (id) + return *id; + else + return 0; +} + +// static +void TrackableObjectBase::RegisterDestructionCallback(void (*c)()) { + atom::AtomBrowserMainParts::Get()->RegisterDestructionCallback(base::Bind(c)); +} + } // namespace mate diff --git a/atom/browser/api/trackable_object.h b/atom/browser/api/trackable_object.h index 3233f6da91e0..d915135f0971 100644 --- a/atom/browser/api/trackable_object.h +++ b/atom/browser/api/trackable_object.h @@ -5,6 +5,8 @@ #ifndef ATOM_BROWSER_API_TRACKABLE_OBJECT_H_ #define ATOM_BROWSER_API_TRACKABLE_OBJECT_H_ +#include + #include "atom/browser/api/event_emitter.h" #include "atom/common/id_weak_map.h" @@ -14,42 +16,101 @@ class SupportsUserData; namespace mate { -// All instances of TrackableObject will be kept in a weak map and can be got -// from its ID. -class TrackableObject : public mate::EventEmitter { +// Users should use TrackableObject instead. +class TrackableObjectBase : public mate::EventEmitter { public: - // Find out the TrackableObject from its ID in weak map. - static TrackableObject* FromWeakMapID(v8::Isolate* isolate, int32_t id); - - // Find out the TrackableObject from the class it wraps. - static TrackableObject* FromWrappedClass( - v8::Isolate* isolate, base::SupportsUserData* wrapped); - - // Releases all weak references in weak map, called when app is terminating. - static void ReleaseAllWeakReferences(); - - // mate::Wrappable: - void AfterInit(v8::Isolate* isolate) override; + TrackableObjectBase(); // The ID in weak map. int32_t weak_map_id() const { return weak_map_id_; } - protected: - TrackableObject(); - ~TrackableObject() override; - // Wrap TrackableObject into a class that SupportsUserData. void AttachAsUserData(base::SupportsUserData* wrapped); - private: - static atom::IDWeakMap weak_map_; + protected: + ~TrackableObjectBase() override; + + // mate::Wrappable: + void AfterInit(v8::Isolate* isolate) override; + + // Get the weak_map_id from SupportsUserData. + static int32_t GetIDFromWrappedClass(base::SupportsUserData* wrapped); + + // Register a callback that should be destroyed before JavaScript environment + // gets destroyed. + static void RegisterDestructionCallback(void (*callback)()); int32_t weak_map_id_; base::SupportsUserData* wrapped_; + private: + DISALLOW_COPY_AND_ASSIGN(TrackableObjectBase); +}; + +// All instances of TrackableObject will be kept in a weak map and can be got +// from its ID. +template +class TrackableObject : public TrackableObjectBase { + public: + // Finds out the TrackableObject from its ID in weak map. + static T* FromWeakMapID(v8::Isolate* isolate, int32_t id) { + v8::MaybeLocal object = weak_map_.Get(isolate, id); + if (object.IsEmpty()) + return nullptr; + + T* self = nullptr; + mate::ConvertFromV8(isolate, object.ToLocalChecked(), &self); + return self; + } + + // Finds out the TrackableObject from the class it wraps. + static T* FromWrappedClass(v8::Isolate* isolate, + base::SupportsUserData* wrapped) { + int32_t id = GetIDFromWrappedClass(wrapped); + if (!id) + return nullptr; + return FromWeakMapID(isolate, id); + } + + // Returns all objects in this class's weak map. + static std::vector> GetAll(v8::Isolate* isolate) { + return weak_map_.Values(isolate); + } + + TrackableObject() { + RegisterDestructionCallback(&TrackableObject::ReleaseAllWeakReferences); + } + + // Removes this instance from the weak map. + void RemoveFromWeakMap() { + if (weak_map_.Has(weak_map_id())) + weak_map_.Remove(weak_map_id()); + } + + protected: + ~TrackableObject() override { + RemoveFromWeakMap(); + } + + void AfterInit(v8::Isolate* isolate) override { + weak_map_id_ = weak_map_.Add(isolate, GetWrapper(isolate)); + TrackableObjectBase::AfterInit(isolate); + } + + private: + // Releases all weak references in weak map, called when app is terminating. + static void ReleaseAllWeakReferences() { + weak_map_.Clear(); + } + + static atom::IDWeakMap weak_map_; + DISALLOW_COPY_AND_ASSIGN(TrackableObject); }; +template +atom::IDWeakMap TrackableObject::weak_map_; + } // namespace mate #endif // ATOM_BROWSER_API_TRACKABLE_OBJECT_H_ diff --git a/atom/browser/atom_browser_main_parts.cc b/atom/browser/atom_browser_main_parts.cc index b2a00452c75d..15ffd05b39f0 100644 --- a/atom/browser/atom_browser_main_parts.cc +++ b/atom/browser/atom_browser_main_parts.cc @@ -37,7 +37,8 @@ AtomBrowserMainParts::AtomBrowserMainParts() } AtomBrowserMainParts::~AtomBrowserMainParts() { - mate::TrackableObject::ReleaseAllWeakReferences(); + for (const auto& callback : destruction_callbacks_) + callback.Run(); } // static @@ -46,6 +47,11 @@ AtomBrowserMainParts* AtomBrowserMainParts::Get() { return self_; } +void AtomBrowserMainParts::RegisterDestructionCallback( + const base::Closure& callback) { + destruction_callbacks_.push_back(callback); +} + brightray::BrowserContext* AtomBrowserMainParts::CreateBrowserContext() { return new AtomBrowserContext(); } diff --git a/atom/browser/atom_browser_main_parts.h b/atom/browser/atom_browser_main_parts.h index c7d688f7c323..2b308e8c9aff 100644 --- a/atom/browser/atom_browser_main_parts.h +++ b/atom/browser/atom_browser_main_parts.h @@ -5,6 +5,9 @@ #ifndef ATOM_BROWSER_ATOM_BROWSER_MAIN_PARTS_H_ #define ATOM_BROWSER_ATOM_BROWSER_MAIN_PARTS_H_ +#include + +#include "base/callback.h" #include "base/timer/timer.h" #include "brightray/browser/browser_main_parts.h" @@ -24,6 +27,10 @@ class AtomBrowserMainParts : public brightray::BrowserMainParts { static AtomBrowserMainParts* Get(); + // Register a callback that should be destroyed before JavaScript environment + // gets destroyed. + void RegisterDestructionCallback(const base::Closure& callback); + Browser* browser() { return browser_.get(); } protected: @@ -53,6 +60,9 @@ class AtomBrowserMainParts : public brightray::BrowserMainParts { base::Timer gc_timer_; + // List of callbacks should be executed before destroying JS env. + std::list destruction_callbacks_; + static AtomBrowserMainParts* self_; DISALLOW_COPY_AND_ASSIGN(AtomBrowserMainParts); From 8c83dfe918c3c1fa53776caf9e5217b36d8cf21b Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 24 Jun 2015 18:39:02 +0800 Subject: [PATCH 0370/1293] Remove usages of JS IDWeakMap in browser-window --- atom/browser/api/lib/browser-window.coffee | 9 --------- atom/browser/lib/guest-window-manager.coffee | 14 +++++--------- 2 files changed, 5 insertions(+), 18 deletions(-) diff --git a/atom/browser/api/lib/browser-window.coffee b/atom/browser/api/lib/browser-window.coffee index 15411fb85769..1aa84bb15c48 100644 --- a/atom/browser/api/lib/browser-window.coffee +++ b/atom/browser/api/lib/browser-window.coffee @@ -1,14 +1,10 @@ EventEmitter = require('events').EventEmitter -IDWeakMap = process.atomBinding('id_weak_map').IDWeakMap app = require 'app' ipc = require 'ipc' BrowserWindow = process.atomBinding('window').BrowserWindow BrowserWindow::__proto__ = EventEmitter.prototype -# Store all created windows in the weak map. -BrowserWindow.windows = new IDWeakMap - BrowserWindow::_init = -> # Simulate the application menu on platforms other than OS X. if process.platform isnt 'darwin' @@ -31,11 +27,6 @@ BrowserWindow::_init = -> @on 'focus', (event) => app.emit 'browser-window-focus', event, this - # Remove the window from weak map immediately when it's destroyed, since we - # could be iterating windows before GC happened. - @once 'closed', => - BrowserWindow.windows.remove @id if BrowserWindow.windows.has @id - BrowserWindow::setMenu = (menu) -> throw new TypeError('Invalid menu') unless menu is null or menu?.constructor?.name is 'Menu' diff --git a/atom/browser/lib/guest-window-manager.coffee b/atom/browser/lib/guest-window-manager.coffee index aef8b0def24d..e26c93513c9c 100644 --- a/atom/browser/lib/guest-window-manager.coffee +++ b/atom/browser/lib/guest-window-manager.coffee @@ -48,17 +48,14 @@ ipc.on 'ATOM_SHELL_GUEST_WINDOW_MANAGER_WINDOW_OPEN', (event, args...) -> event.returnValue = createGuest event.sender, args... ipc.on 'ATOM_SHELL_GUEST_WINDOW_MANAGER_WINDOW_CLOSE', (event, guestId) -> - return unless BrowserWindow.windows.has guestId - BrowserWindow.windows.get(guestId).destroy() + BrowserWindow.fromId(guestId)?.destroy() ipc.on 'ATOM_SHELL_GUEST_WINDOW_MANAGER_WINDOW_METHOD', (event, guestId, method, args...) -> - return unless BrowserWindow.windows.has guestId - BrowserWindow.windows.get(guestId)[method] args... + BrowserWindow.fromId(guestId)?[method] args... ipc.on 'ATOM_SHELL_GUEST_WINDOW_MANAGER_WINDOW_POSTMESSAGE', (event, guestId, message, targetOrigin) -> - return unless BrowserWindow.windows.has guestId - guestContents = BrowserWindow.windows.get(guestId).webContents - if guestContents.getUrl().indexOf(targetOrigin) is 0 or targetOrigin is '*' + guestContents = BrowserWindow.fromId(guestId)?.webContents + if guestContents?.getUrl().indexOf(targetOrigin) is 0 or targetOrigin is '*' guestContents.send 'ATOM_SHELL_GUEST_WINDOW_POSTMESSAGE', message, targetOrigin ipc.on 'ATOM_SHELL_GUEST_WINDOW_MANAGER_WINDOW_OPENER_POSTMESSAGE', (event, message, targetOrigin) -> @@ -67,5 +64,4 @@ ipc.on 'ATOM_SHELL_GUEST_WINDOW_MANAGER_WINDOW_OPENER_POSTMESSAGE', (event, mess embedder.send 'ATOM_SHELL_GUEST_WINDOW_POSTMESSAGE', message, targetOrigin ipc.on 'ATOM_SHELL_GUEST_WINDOW_MANAGER_WEB_CONTENTS_METHOD', (event, guestId, method, args...) -> - return unless BrowserWindow.windows.has guestId - BrowserWindow.windows.get(guestId).webContents?[method] args... + BrowserWindow.fromId(guestId)?.webContents?[method] args... From f198148c7987eb1d312927178ab41a5b30774e50 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 24 Jun 2015 19:04:08 +0800 Subject: [PATCH 0371/1293] Always initailize webContents in BrowserWindow --- atom/browser/api/atom_api_window.cc | 17 +++++++++++------ atom/browser/api/atom_api_window.h | 3 +++ 2 files changed, 14 insertions(+), 6 deletions(-) diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index d764cee579e2..0ee56dbce726 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -49,6 +49,13 @@ Window::~Window() { Destroy(); } +void Window::AfterInit(v8::Isolate* isolate) { + mate::TrackableObject::AfterInit(isolate); + auto web_contents = window_->managed_web_contents(); + auto handle = WebContents::CreateFrom(isolate, web_contents); + web_contents_.Reset(isolate, handle.ToV8()); +} + void Window::OnPageTitleUpdated(bool* prevent_default, const std::string& title) { *prevent_default = Emit("page-title-updated", title); @@ -441,12 +448,10 @@ int32_t Window::ID() const { } v8::Local Window::WebContents(v8::Isolate* isolate) { - if (web_contents_.IsEmpty()) { - auto handle = - WebContents::CreateFrom(isolate, window_->managed_web_contents()); - web_contents_.Reset(isolate, handle.ToV8()); - } - return v8::Local::New(isolate, web_contents_); + if (web_contents_.IsEmpty()) + return v8::Null(isolate); + else + return v8::Local::New(isolate, web_contents_); } v8::Local Window::DevToolsWebContents(v8::Isolate* isolate) { diff --git a/atom/browser/api/atom_api_window.h b/atom/browser/api/atom_api_window.h index 0c4cd76a8655..87eabaff7c1d 100644 --- a/atom/browser/api/atom_api_window.h +++ b/atom/browser/api/atom_api_window.h @@ -52,6 +52,9 @@ class Window : public mate::TrackableObject, explicit Window(const mate::Dictionary& options); virtual ~Window(); + // mate::Wrappable: + void AfterInit(v8::Isolate* isolate) override; + // NativeWindowObserver: void OnPageTitleUpdated(bool* prevent_default, const std::string& title) override; From 9b9108f789a6b4e04383b16cba2047f03c746bcd Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 24 Jun 2015 19:51:11 +0800 Subject: [PATCH 0372/1293] Remove JS override of setMenu --- atom/browser/api/atom_api_window.cc | 18 +++++++++++++++--- atom/browser/api/atom_api_window.h | 7 ++----- atom/browser/api/lib/browser-window.coffee | 6 ------ 3 files changed, 17 insertions(+), 14 deletions(-) diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index 0ee56dbce726..86399ce057d2 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -409,8 +409,20 @@ void Window::SetOverlayIcon(const gfx::Image& overlay, window_->SetOverlayIcon(overlay, description); } -void Window::SetMenu(ui::SimpleMenuModel* menu) { - window_->SetMenu(menu); +void Window::SetMenu(v8::Isolate* isolate, v8::Local value) { + mate::Handle menu; + if (value->IsObject() && + mate::V8ToString(value->ToObject()->GetConstructorName()) == "Menu" && + mate::ConvertFromV8(isolate, value, &menu)) { + menu_.Reset(isolate, menu.ToV8()); + window_->SetMenu(menu->model()); + } else if (value->IsNull()) { + menu_.Reset(); + window_->SetMenu(nullptr); + } else { + isolate->ThrowException(v8::Exception::TypeError( + mate::StringToV8(isolate, "Invalid Menu"))); + } } void Window::SetAutoHideMenuBar(bool auto_hide) { @@ -515,7 +527,7 @@ void Window::BuildPrototype(v8::Isolate* isolate, .SetMethod("capturePage", &Window::CapturePage) .SetMethod("setProgressBar", &Window::SetProgressBar) .SetMethod("setOverlayIcon", &Window::SetOverlayIcon) - .SetMethod("_setMenu", &Window::SetMenu) + .SetMethod("setMenu", &Window::SetMenu) .SetMethod("setAutoHideMenuBar", &Window::SetAutoHideMenuBar) .SetMethod("isMenuBarAutoHide", &Window::IsMenuBarAutoHide) .SetMethod("setMenuBarVisibility", &Window::SetMenuBarVisibility) diff --git a/atom/browser/api/atom_api_window.h b/atom/browser/api/atom_api_window.h index 87eabaff7c1d..a0403dde54f6 100644 --- a/atom/browser/api/atom_api_window.h +++ b/atom/browser/api/atom_api_window.h @@ -25,10 +25,6 @@ class Arguments; class Dictionary; } -namespace ui { -class SimpleMenuModel; -} - namespace atom { class NativeWindow; @@ -137,7 +133,7 @@ class Window : public mate::TrackableObject, void SetProgressBar(double progress); void SetOverlayIcon(const gfx::Image& overlay, const std::string& description); - void SetMenu(ui::SimpleMenuModel* menu); + void SetMenu(v8::Isolate* isolate, v8::Local menu); void SetAutoHideMenuBar(bool auto_hide); bool IsMenuBarAutoHide(); void SetMenuBarVisibility(bool visible); @@ -156,6 +152,7 @@ class Window : public mate::TrackableObject, v8::Global web_contents_; v8::Global devtools_web_contents_; + v8::Global menu_; scoped_ptr window_; diff --git a/atom/browser/api/lib/browser-window.coffee b/atom/browser/api/lib/browser-window.coffee index 1aa84bb15c48..66e0670dc20e 100644 --- a/atom/browser/api/lib/browser-window.coffee +++ b/atom/browser/api/lib/browser-window.coffee @@ -27,12 +27,6 @@ BrowserWindow::_init = -> @on 'focus', (event) => app.emit 'browser-window-focus', event, this -BrowserWindow::setMenu = (menu) -> - throw new TypeError('Invalid menu') unless menu is null or menu?.constructor?.name is 'Menu' - - @menu = menu # Keep a reference of menu in case of GC. - @_setMenu menu - BrowserWindow.getFocusedWindow = -> windows = BrowserWindow.getAllWindows() return window for window in windows when window.isFocused() From 7d05a12ee9e3856a28d33c808268ea71caf77dab Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 24 Jun 2015 20:10:07 +0800 Subject: [PATCH 0373/1293] Remove ActivateContents and DeactivateContents --- atom/browser/native_window.cc | 8 -------- atom/browser/native_window.h | 2 -- 2 files changed, 10 deletions(-) diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 5404eba59791..a8b8e26b4534 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -564,14 +564,6 @@ void NativeWindow::BeforeUnloadFired(content::WebContents* tab, } } -void NativeWindow::ActivateContents(content::WebContents* contents) { - FocusOnWebView(); -} - -void NativeWindow::DeactivateContents(content::WebContents* contents) { - BlurWebView(); -} - void NativeWindow::MoveContents(content::WebContents* source, const gfx::Rect& pos) { SetBounds(pos); diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index 0298101ce043..0dfc9e050b5a 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -235,8 +235,6 @@ class NativeWindow : public CommonWebContentsDelegate, void BeforeUnloadFired(content::WebContents* tab, bool proceed, bool* proceed_to_fire_unload) override; - void ActivateContents(content::WebContents* contents) override; - void DeactivateContents(content::WebContents* contents) override; void MoveContents(content::WebContents* source, const gfx::Rect& pos) override; void CloseContents(content::WebContents* source) override; From b822a83bc2cc721fc52b39acfe86d5a74a5c137e Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 24 Jun 2015 20:16:51 +0800 Subject: [PATCH 0374/1293] Remove usages of NotificationObserver --- atom/browser/native_window.cc | 42 +++++++++-------------------------- atom/browser/native_window.h | 14 ++---------- 2 files changed, 13 insertions(+), 43 deletions(-) diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index a8b8e26b4534..00142ada8cde 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -30,9 +30,6 @@ #include "brightray/browser/inspectable_web_contents_view.h" #include "content/browser/renderer_host/render_widget_host_impl.h" #include "content/public/browser/navigation_entry.h" -#include "content/public/browser/notification_details.h" -#include "content/public/browser/notification_source.h" -#include "content/public/browser/notification_types.h" #include "content/public/browser/plugin_service.h" #include "content/public/browser/render_process_host.h" #include "content/public/browser/render_view_host.h" @@ -140,10 +137,6 @@ NativeWindow::NativeWindow(content::WebContents* web_contents, CHROME_VERSION_STRING); web_contents->GetMutableRendererPrefs()->user_agent_override = content::BuildUserAgentFromProduct(product_name); - - // Get notified of title updated message. - registrar_.Add(this, content::NOTIFICATION_WEB_CONTENTS_TITLE_UPDATED, - content::Source(web_contents)); } NativeWindow::~NativeWindow() { @@ -430,10 +423,6 @@ void NativeWindow::NotifyWindowClosed() { is_closed_ = true; FOR_EACH_OBSERVER(NativeWindowObserver, observers_, OnWindowClosed()); - // Do not receive any notification after window has been closed, there is a - // crash that seems to be caused by this: http://git.io/YqMG5g. - registrar_.RemoveAll(); - WindowList::RemoveWindow(this); } @@ -605,6 +594,17 @@ void NativeWindow::BeforeUnloadFired(const base::TimeTicks& proceed_time) { // there are two virtual functions named BeforeUnloadFired. } +void NativeWindow::TitleWasSet(content::NavigationEntry* entry, + bool explicit_set) { + bool prevent_default = false; + std::string text = base::UTF16ToUTF8(entry->GetTitle()); + FOR_EACH_OBSERVER(NativeWindowObserver, + observers_, + OnPageTitleUpdated(&prevent_default, text)); + if (!prevent_default) + SetTitle(text); +} + bool NativeWindow::OnMessageReceived(const IPC::Message& message) { bool handled = true; IPC_BEGIN_MESSAGE_MAP(NativeWindow, message) @@ -616,26 +616,6 @@ bool NativeWindow::OnMessageReceived(const IPC::Message& message) { return handled; } -void NativeWindow::Observe(int type, - const content::NotificationSource& source, - const content::NotificationDetails& details) { - if (type == content::NOTIFICATION_WEB_CONTENTS_TITLE_UPDATED) { - std::pair* title = - content::Details>(details).ptr(); - - if (title->first) { - bool prevent_default = false; - std::string text = base::UTF16ToUTF8(title->first->GetTitle()); - FOR_EACH_OBSERVER(NativeWindowObserver, - observers_, - OnPageTitleUpdated(&prevent_default, text)); - - if (!prevent_default) - SetTitle(text); - } - } -} - void NativeWindow::DevToolsFocused() { FOR_EACH_OBSERVER(NativeWindowObserver, observers_, OnDevToolsFocus()); } diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index 0dfc9e050b5a..642eb0c904d7 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -16,8 +16,6 @@ #include "base/memory/scoped_ptr.h" #include "base/memory/weak_ptr.h" #include "base/observer_list.h" -#include "content/public/browser/notification_registrar.h" -#include "content/public/browser/notification_observer.h" #include "content/public/browser/readback_types.h" #include "native_mate/persistent_dictionary.h" #include "ui/gfx/image/image.h" @@ -51,8 +49,7 @@ namespace atom { struct DraggableRegion; class NativeWindow : public CommonWebContentsDelegate, - public content::WebContentsObserver, - public content::NotificationObserver { + public content::WebContentsObserver { public: typedef base::Callback CapturePageCallback; @@ -244,13 +241,9 @@ class NativeWindow : public CommonWebContentsDelegate, // Implementations of content::WebContentsObserver. void RenderViewCreated(content::RenderViewHost* render_view_host) override; void BeforeUnloadFired(const base::TimeTicks& proceed_time) override; + void TitleWasSet(content::NavigationEntry* entry, bool explicit_set) override; bool OnMessageReceived(const IPC::Message& message) override; - // Implementations of content::NotificationObserver. - void Observe(int type, - const content::NotificationSource& source, - const content::NotificationDetails& details) override; - // Implementations of brightray::InspectableWebContentsDelegate. void DevToolsFocused() override; void DevToolsOpened() override; @@ -280,9 +273,6 @@ class NativeWindow : public CommonWebContentsDelegate, const SkBitmap& bitmap, content::ReadbackResponse response); - // Notification manager. - content::NotificationRegistrar registrar_; - // Observers of this window. ObserverList observers_; From 87f44c42df4c497f60e264025173875d153344e9 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 24 Jun 2015 21:28:36 +0800 Subject: [PATCH 0375/1293] Handle close cancel in BeforeUnloadDialogCancelled --- atom/browser/native_window.cc | 14 +++++++------- atom/browser/native_window.h | 1 + 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 00142ada8cde..71fe65e0d8c6 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -544,13 +544,6 @@ void NativeWindow::BeforeUnloadFired(content::WebContents* tab, bool proceed, bool* proceed_to_fire_unload) { *proceed_to_fire_unload = proceed; - - if (!proceed) { - WindowList::WindowCloseCancelled(this); - - // Cancel unresponsive event when window close is cancelled. - window_unresposive_closure_.Cancel(); - } } void NativeWindow::MoveContents(content::WebContents* source, @@ -594,6 +587,13 @@ void NativeWindow::BeforeUnloadFired(const base::TimeTicks& proceed_time) { // there are two virtual functions named BeforeUnloadFired. } +void NativeWindow::BeforeUnloadDialogCancelled() { + WindowList::WindowCloseCancelled(this); + + // Cancel unresponsive event when window close is cancelled. + window_unresposive_closure_.Cancel(); +} + void NativeWindow::TitleWasSet(content::NavigationEntry* entry, bool explicit_set) { bool prevent_default = false; diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index 642eb0c904d7..4e6f9d113fb7 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -241,6 +241,7 @@ class NativeWindow : public CommonWebContentsDelegate, // Implementations of content::WebContentsObserver. void RenderViewCreated(content::RenderViewHost* render_view_host) override; void BeforeUnloadFired(const base::TimeTicks& proceed_time) override; + void BeforeUnloadDialogCancelled() override; void TitleWasSet(content::NavigationEntry* entry, bool explicit_set) override; bool OnMessageReceived(const IPC::Message& message) override; From 2532318beeea3d3b39423823f152ccb7b9a7a425 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 24 Jun 2015 21:44:27 +0800 Subject: [PATCH 0376/1293] Add type for WebContents --- atom/browser/api/atom_api_web_contents.cc | 5 ++++- atom/browser/api/atom_api_web_contents.h | 9 +++++++++ 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 027a74982192..63244922ce8f 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -144,6 +144,7 @@ content::ServiceWorkerContext* GetServiceWorkerContext( WebContents::WebContents(brightray::InspectableWebContents* web_contents) : WebContents(web_contents->GetWebContents()) { + type_ = BROWSER_WINDOW; inspectable_web_contents_ = web_contents; } @@ -154,6 +155,7 @@ WebContents::WebContents(content::WebContents* web_contents) guest_host_(nullptr), auto_size_enabled_(false), is_full_page_plugin_(false), + type_(REMOTE), inspectable_web_contents_(nullptr) { AttachAsUserData(web_contents); } @@ -163,7 +165,8 @@ WebContents::WebContents(const mate::Dictionary& options) guest_opaque_(true), guest_host_(nullptr), auto_size_enabled_(false), - is_full_page_plugin_(false) { + is_full_page_plugin_(false), + type_(WEB_VIEW) { auto browser_context = AtomBrowserMainParts::Get()->browser_context(); content::SiteInstance* site_instance = content::SiteInstance::CreateForURL( browser_context, GURL("chrome-guest://fake-host")); diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index 741b0398e777..d9e1e9c99388 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -220,6 +220,12 @@ class WebContents : public mate::TrackableObject, void OnGpuProcessCrashed(base::TerminationStatus exit_code) override; private: + enum Type { + BROWSER_WINDOW, // Used by BrowserWindow. + WEB_VIEW, // Used by . + REMOTE, // Thin wrap around an existing WebContents. + }; + // Called when received a message from renderer. void OnRendererMessage(const base::string16& channel, const base::ListValue& args); @@ -273,6 +279,9 @@ class WebContents : public mate::TrackableObject, // Whether the guest view is inside a plugin document. bool is_full_page_plugin_; + // The type of current WebContents. + Type type_; + // Current InspectableWebContents object, can be nullptr for WebContents of // devtools. It is a weak reference. brightray::InspectableWebContents* inspectable_web_contents_; From 2bfa9da82eb378e62ce60d310694a5543e31040d Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 24 Jun 2015 22:14:46 +0800 Subject: [PATCH 0377/1293] Store NativeWindow's weak ptr in WebContents --- atom/browser/api/atom_api_web_contents.cc | 7 +++++-- atom/browser/atom_download_manager_delegate.cc | 11 +++++++---- atom/browser/common_web_contents_delegate.cc | 3 +++ atom/browser/native_window.cc | 2 ++ atom/browser/native_window.h | 16 ++++++++++++++++ 5 files changed, 33 insertions(+), 6 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 63244922ce8f..1163820d2c54 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -177,8 +177,11 @@ WebContents::WebContents(const mate::Dictionary& options) NativeWindow* owner_window = nullptr; WebContents* embedder = nullptr; - if (options.Get("embedder", &embedder) && embedder) - owner_window = NativeWindow::FromWebContents(embedder->web_contents()); + if (options.Get("embedder", &embedder) && embedder) { + auto relay = NativeWindowRelay::FromWebContents(embedder->web_contents()); + if (relay) + owner_window = relay->window.get(); + } AttachAsUserData(web_contents); InitWithWebContents(web_contents, owner_window); diff --git a/atom/browser/atom_download_manager_delegate.cc b/atom/browser/atom_download_manager_delegate.cc index eb6f48efe851..46c4af2dc387 100644 --- a/atom/browser/atom_download_manager_delegate.cc +++ b/atom/browser/atom_download_manager_delegate.cc @@ -65,12 +65,15 @@ void AtomDownloadManagerDelegate::OnDownloadPathGenerated( if (!item) return; + NativeWindow* window = nullptr; + auto relay = NativeWindowRelay::FromWebContents(item->GetWebContents()); + if (relay) + window = relay->window.get(); + file_dialog::Filters filters; base::FilePath path; - auto owner_window_ = NativeWindow::FromWebContents(item->GetWebContents()); - if (!file_dialog::ShowSaveDialog( - owner_window_, item->GetURL().spec(), - default_path, filters, &path)) { + if (!file_dialog::ShowSaveDialog(window, item->GetURL().spec(), default_path, + filters, &path)) { return; } diff --git a/atom/browser/common_web_contents_delegate.cc b/atom/browser/common_web_contents_delegate.cc index 97fee2f755d1..5ab8ed0ee182 100644 --- a/atom/browser/common_web_contents_delegate.cc +++ b/atom/browser/common_web_contents_delegate.cc @@ -123,6 +123,9 @@ void CommonWebContentsDelegate::InitWithWebContents( owner_window_ = owner_window; web_contents->SetDelegate(this); + NativeWindowRelay* relay = new NativeWindowRelay(owner_window_->GetWeakPtr()); + web_contents->SetUserData(relay->key, relay); + printing::PrintViewManagerBasic::CreateForWebContents(web_contents); printing::PrintPreviewMessageHandler::CreateForWebContents(web_contents); diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 71fe65e0d8c6..e40459e2c75e 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -56,6 +56,8 @@ using content::NavigationEntry; using content::RenderWidgetHostView; using content::RenderWidgetHost; +DEFINE_WEB_CONTENTS_USER_DATA_KEY(atom::NativeWindowRelay); + namespace atom { namespace { diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index 4e6f9d113fb7..8f3a04c88661 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -17,6 +17,7 @@ #include "base/memory/weak_ptr.h" #include "base/observer_list.h" #include "content/public/browser/readback_types.h" +#include "content/public/browser/web_contents_user_data.h" #include "native_mate/persistent_dictionary.h" #include "ui/gfx/image/image.h" @@ -304,6 +305,21 @@ class NativeWindow : public CommonWebContentsDelegate, DISALLOW_COPY_AND_ASSIGN(NativeWindow); }; + +// This class provides a hook to get a NativeWindow from a WebContents. +class NativeWindowRelay : + public content::WebContentsUserData { + public: + explicit NativeWindowRelay(base::WeakPtr window) + : key(UserDataKey()), window(window) {} + + void* key; + base::WeakPtr window; + + private: + friend class content::WebContentsUserData; +}; + } // namespace atom #endif // ATOM_BROWSER_NATIVE_WINDOW_H_ From 19ca0117354ed4aa1cf11b8723292ac61358081d Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 24 Jun 2015 22:23:38 +0800 Subject: [PATCH 0378/1293] Discard is_guest_, use type_ instead --- atom/browser/api/atom_api_web_contents.cc | 32 ++++++++++++-------- atom/browser/api/atom_api_web_contents.h | 1 + atom/browser/common_web_contents_delegate.cc | 10 ++---- atom/browser/common_web_contents_delegate.h | 8 +---- atom/browser/native_window.cc | 3 +- 5 files changed, 24 insertions(+), 30 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 1163820d2c54..e5d31d76d5e5 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -149,8 +149,7 @@ WebContents::WebContents(brightray::InspectableWebContents* web_contents) } WebContents::WebContents(content::WebContents* web_contents) - : CommonWebContentsDelegate(false), - content::WebContentsObserver(web_contents), + : content::WebContentsObserver(web_contents), guest_opaque_(true), guest_host_(nullptr), auto_size_enabled_(false), @@ -161,8 +160,7 @@ WebContents::WebContents(content::WebContents* web_contents) } WebContents::WebContents(const mate::Dictionary& options) - : CommonWebContentsDelegate(true), - guest_opaque_(true), + : guest_opaque_(true), guest_host_(nullptr), auto_size_enabled_(false), is_full_page_plugin_(false), @@ -235,6 +233,10 @@ content::WebContents* WebContents::OpenURLFromTab( return CommonWebContentsDelegate::OpenURLFromTab(source, params); } +bool WebContents::IsPopupOrPanel(const content::WebContents* source) const { + return type_ == BROWSER_WINDOW; +} + void WebContents::HandleKeyboardEvent( content::WebContents* source, const content::NativeWebKeyboardEvent& event) { @@ -412,7 +414,7 @@ bool WebContents::OnMessageReceived(const IPC::Message& message) { } void WebContents::RenderViewReady() { - if (!is_guest()) + if (type_ != WEB_VIEW) return; // We don't want to accidentally set the opacity of an interstitial page. @@ -466,7 +468,7 @@ void WebContents::WillAttach(content::WebContents* embedder_web_contents, } void WebContents::Destroy() { - if (is_guest() && managed_web_contents()) { + if (type_ == WEB_VIEW && managed_web_contents()) { // When force destroying the "destroyed" event is not emitted. WebContentsDestroyed(); @@ -561,10 +563,11 @@ void WebContents::ExecuteJavaScript(const base::string16& code) { } void WebContents::OpenDevTools(mate::Arguments* args) { - if (!inspectable_web_contents()) + if (type_ == REMOTE) return; + bool detach = false; - if (is_guest()) { + if (type_ == WEB_VIEW) { detach = true; } else if (args && args->Length() == 1) { mate::Dictionary options; @@ -575,13 +578,14 @@ void WebContents::OpenDevTools(mate::Arguments* args) { } void WebContents::CloseDevTools() { - if (!inspectable_web_contents()) + if (type_ == REMOTE) return; + inspectable_web_contents()->CloseDevTools(); } bool WebContents::IsDevToolsOpened() { - if (!inspectable_web_contents()) + if (type_ == REMOTE) return false; return inspectable_web_contents()->IsDevToolsViewShowing(); } @@ -594,8 +598,9 @@ void WebContents::ToggleDevTools() { } void WebContents::InspectElement(int x, int y) { - if (!inspectable_web_contents()) + if (type_ == REMOTE) return; + OpenDevTools(nullptr); scoped_refptr agent( content::DevToolsAgentHost::GetOrCreateFor(web_contents())); @@ -603,8 +608,9 @@ void WebContents::InspectElement(int x, int y) { } void WebContents::InspectServiceWorker() { - if (!inspectable_web_contents()) + if (type_ == REMOTE) return; + for (const auto& agent_host : content::DevToolsAgentHost::GetOrCreateAll()) { if (agent_host->GetType() == content::DevToolsAgentHost::TYPE_SERVICE_WORKER) { @@ -790,7 +796,7 @@ void WebContents::SetAllowTransparency(bool allow) { } bool WebContents::IsGuest() const { - return is_guest(); + return type_ == WEB_VIEW; } mate::ObjectTemplateBuilder WebContents::GetObjectTemplateBuilder( diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index d9e1e9c99388..be874d9e35dc 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -164,6 +164,7 @@ class WebContents : public mate::TrackableObject, content::WebContents* OpenURLFromTab( content::WebContents* source, const content::OpenURLParams& params) override; + bool IsPopupOrPanel(const content::WebContents* source) const override; void HandleKeyboardEvent( content::WebContents* source, const content::NativeWebKeyboardEvent& event) override; diff --git a/atom/browser/common_web_contents_delegate.cc b/atom/browser/common_web_contents_delegate.cc index 5ab8ed0ee182..d66c7e0c6ae9 100644 --- a/atom/browser/common_web_contents_delegate.cc +++ b/atom/browser/common_web_contents_delegate.cc @@ -107,9 +107,8 @@ void AppendToFile(const base::FilePath& path, } // namespace -CommonWebContentsDelegate::CommonWebContentsDelegate(bool is_guest) - : is_guest_(is_guest), - owner_window_(nullptr), +CommonWebContentsDelegate::CommonWebContentsDelegate() + : owner_window_(nullptr), html_fullscreen_(false), native_fullscreen_(false) { } @@ -180,11 +179,6 @@ bool CommonWebContentsDelegate::CanOverscrollContent() const { return false; } -bool CommonWebContentsDelegate::IsPopupOrPanel( - const content::WebContents* source) const { - return !is_guest_; -} - content::JavaScriptDialogManager* CommonWebContentsDelegate::GetJavaScriptDialogManager( content::WebContents* source) { diff --git a/atom/browser/common_web_contents_delegate.h b/atom/browser/common_web_contents_delegate.h index a50f4288613a..5f361c0a0a83 100644 --- a/atom/browser/common_web_contents_delegate.h +++ b/atom/browser/common_web_contents_delegate.h @@ -23,7 +23,7 @@ class CommonWebContentsDelegate : public brightray::DefaultWebContentsDelegate, public brightray::InspectableWebContentsDelegate { public: - explicit CommonWebContentsDelegate(bool is_guest); + CommonWebContentsDelegate(); virtual ~CommonWebContentsDelegate(); // Create a InspectableWebContents object and takes onwership of @@ -44,8 +44,6 @@ class CommonWebContentsDelegate return web_contents_.get(); } - bool is_guest() const { return is_guest_; } - protected: // content::WebContentsDelegate: content::WebContents* OpenURLFromTab( @@ -55,7 +53,6 @@ class CommonWebContentsDelegate bool user_gesture, bool last_unlocked_by_target) override; bool CanOverscrollContent() const override; - bool IsPopupOrPanel(const content::WebContents* source) const override; content::JavaScriptDialogManager* GetJavaScriptDialogManager( content::WebContents* source) override; content::ColorChooser* OpenColorChooser( @@ -92,9 +89,6 @@ class CommonWebContentsDelegate // Set fullscreen mode triggered by html api. void SetHtmlApiFullscreen(bool enter_fullscreen); - // Whether this is guest WebContents or NativeWindow. - const bool is_guest_; - // The window that this WebContents belongs to. NativeWindow* owner_window_; diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index e40459e2c75e..e635daec2c03 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -85,8 +85,7 @@ std::string RemoveWhitespace(const std::string& str) { NativeWindow::NativeWindow(content::WebContents* web_contents, const mate::Dictionary& options) - : CommonWebContentsDelegate(false), - content::WebContentsObserver(web_contents), + : content::WebContentsObserver(web_contents), has_frame_(true), transparent_(false), enable_larger_than_screen_(false), From 4b61683cdf1992f1e85a1901d1885d1a6cbc1469 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 24 Jun 2015 22:29:44 +0800 Subject: [PATCH 0379/1293] Store NativeWindow in weak ptr --- atom/browser/common_web_contents_delegate.cc | 15 +++++++-------- atom/browser/common_web_contents_delegate.h | 4 +++- 2 files changed, 10 insertions(+), 9 deletions(-) diff --git a/atom/browser/common_web_contents_delegate.cc b/atom/browser/common_web_contents_delegate.cc index d66c7e0c6ae9..aee5375ce497 100644 --- a/atom/browser/common_web_contents_delegate.cc +++ b/atom/browser/common_web_contents_delegate.cc @@ -108,8 +108,7 @@ void AppendToFile(const base::FilePath& path, } // namespace CommonWebContentsDelegate::CommonWebContentsDelegate() - : owner_window_(nullptr), - html_fullscreen_(false), + : html_fullscreen_(false), native_fullscreen_(false) { } @@ -119,10 +118,10 @@ CommonWebContentsDelegate::~CommonWebContentsDelegate() { void CommonWebContentsDelegate::InitWithWebContents( content::WebContents* web_contents, NativeWindow* owner_window) { - owner_window_ = owner_window; + owner_window_ = owner_window->GetWeakPtr(); web_contents->SetDelegate(this); - NativeWindowRelay* relay = new NativeWindowRelay(owner_window_->GetWeakPtr()); + NativeWindowRelay* relay = new NativeWindowRelay(owner_window_); web_contents->SetUserData(relay->key, relay); printing::PrintViewManagerBasic::CreateForWebContents(web_contents); @@ -199,7 +198,7 @@ void CommonWebContentsDelegate::RunFileChooser( content::WebContents* guest, const content::FileChooserParams& params) { if (!web_dialog_helper_) - web_dialog_helper_.reset(new WebDialogHelper(owner_window_)); + web_dialog_helper_.reset(new WebDialogHelper(owner_window())); web_dialog_helper_->RunFileChooser(guest, params); } @@ -207,7 +206,7 @@ void CommonWebContentsDelegate::EnumerateDirectory(content::WebContents* guest, int request_id, const base::FilePath& path) { if (!web_dialog_helper_) - web_dialog_helper_.reset(new WebDialogHelper(owner_window_)); + web_dialog_helper_.reset(new WebDialogHelper(owner_window())); web_dialog_helper_->EnumerateDirectory(guest, request_id, path); } @@ -243,7 +242,7 @@ void CommonWebContentsDelegate::DevToolsSaveToFile( } else { file_dialog::Filters filters; base::FilePath default_path(base::FilePath::FromUTF8Unsafe(url)); - if (!file_dialog::ShowSaveDialog(owner_window_, url, default_path, + if (!file_dialog::ShowSaveDialog(owner_window(), url, default_path, filters, &path)) { base::StringValue url_value(url); web_contents_->CallClientFunction( @@ -278,7 +277,7 @@ void CommonWebContentsDelegate::DevToolsAddFileSystem() { base::FilePath default_path; std::vector paths; int flag = file_dialog::FILE_DIALOG_OPEN_DIRECTORY; - if (!file_dialog::ShowOpenDialog(owner_window_, "", default_path, + if (!file_dialog::ShowOpenDialog(owner_window(), "", default_path, filters, flag, &paths)) return; diff --git a/atom/browser/common_web_contents_delegate.h b/atom/browser/common_web_contents_delegate.h index 5f361c0a0a83..006ca024df43 100644 --- a/atom/browser/common_web_contents_delegate.h +++ b/atom/browser/common_web_contents_delegate.h @@ -44,6 +44,8 @@ class CommonWebContentsDelegate return web_contents_.get(); } + NativeWindow* owner_window() const { return owner_window_.get(); } + protected: // content::WebContentsDelegate: content::WebContents* OpenURLFromTab( @@ -90,7 +92,7 @@ class CommonWebContentsDelegate void SetHtmlApiFullscreen(bool enter_fullscreen); // The window that this WebContents belongs to. - NativeWindow* owner_window_; + base::WeakPtr owner_window_; // Whether window is fullscreened by HTML5 api. bool html_fullscreen_; From 081a4597e93e5b6bb5c7c2909fb63a98177fa0d6 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 24 Jun 2015 23:29:32 +0800 Subject: [PATCH 0380/1293] Pass isGuest when creating WebContents --- atom/browser/api/atom_api_web_contents.cc | 47 +++++++++++++------- atom/browser/common_web_contents_delegate.cc | 14 +++--- atom/browser/common_web_contents_delegate.h | 8 ++-- atom/browser/lib/guest-view-manager.coffee | 2 +- atom/browser/native_window.cc | 3 +- 5 files changed, 46 insertions(+), 28 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index e5d31d76d5e5..a7877fa6f59d 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -163,29 +163,42 @@ WebContents::WebContents(const mate::Dictionary& options) : guest_opaque_(true), guest_host_(nullptr), auto_size_enabled_(false), - is_full_page_plugin_(false), - type_(WEB_VIEW) { + is_full_page_plugin_(false) { + bool is_guest = false; + options.Get("isGuest", &is_guest); + + type_ = is_guest ? WEB_VIEW : BROWSER_WINDOW; + auto browser_context = AtomBrowserMainParts::Get()->browser_context(); - content::SiteInstance* site_instance = content::SiteInstance::CreateForURL( - browser_context, GURL("chrome-guest://fake-host")); - - content::WebContents::CreateParams params(browser_context, site_instance); - params.guest_delegate = this; - auto web_contents = content::WebContents::Create(params); - - NativeWindow* owner_window = nullptr; - WebContents* embedder = nullptr; - if (options.Get("embedder", &embedder) && embedder) { - auto relay = NativeWindowRelay::FromWebContents(embedder->web_contents()); - if (relay) - owner_window = relay->window.get(); + content::WebContents* web_contents; + if (is_guest) { + content::SiteInstance* site_instance = content::SiteInstance::CreateForURL( + browser_context, GURL("chrome-guest://fake-host")); + content::WebContents::CreateParams params(browser_context, site_instance); + params.guest_delegate = this; + web_contents = content::WebContents::Create(params); + } else { + content::WebContents::CreateParams params(browser_context); + web_contents = content::WebContents::Create(params); } + Observe(web_contents); AttachAsUserData(web_contents); - InitWithWebContents(web_contents, owner_window); + InitWithWebContents(web_contents); inspectable_web_contents_ = managed_web_contents(); - Observe(GetWebContents()); + if (is_guest) { + NativeWindow* owner_window = nullptr; + WebContents* embedder = nullptr; + if (options.Get("embedder", &embedder) && embedder) { + // New WebContents's owner_window is the embedder's owner_window. + auto relay = NativeWindowRelay::FromWebContents(embedder->web_contents()); + if (relay) + owner_window = relay->window.get(); + } + if (owner_window) + SetOwnerWindow(owner_window); + } } WebContents::~WebContents() { diff --git a/atom/browser/common_web_contents_delegate.cc b/atom/browser/common_web_contents_delegate.cc index aee5375ce497..af429929812a 100644 --- a/atom/browser/common_web_contents_delegate.cc +++ b/atom/browser/common_web_contents_delegate.cc @@ -116,14 +116,9 @@ CommonWebContentsDelegate::~CommonWebContentsDelegate() { } void CommonWebContentsDelegate::InitWithWebContents( - content::WebContents* web_contents, - NativeWindow* owner_window) { - owner_window_ = owner_window->GetWeakPtr(); + content::WebContents* web_contents) { web_contents->SetDelegate(this); - NativeWindowRelay* relay = new NativeWindowRelay(owner_window_); - web_contents->SetUserData(relay->key, relay); - printing::PrintViewManagerBasic::CreateForWebContents(web_contents); printing::PrintPreviewMessageHandler::CreateForWebContents(web_contents); @@ -132,6 +127,13 @@ void CommonWebContentsDelegate::InitWithWebContents( web_contents_->SetDelegate(this); } +void CommonWebContentsDelegate::SetOwnerWindow(NativeWindow* owner_window) { + content::WebContents* web_contents = GetWebContents(); + owner_window_ = owner_window->GetWeakPtr(); + NativeWindowRelay* relay = new NativeWindowRelay(owner_window_); + web_contents->SetUserData(relay->key, relay); +} + void CommonWebContentsDelegate::DestroyWebContents() { web_contents_.reset(); } diff --git a/atom/browser/common_web_contents_delegate.h b/atom/browser/common_web_contents_delegate.h index 006ca024df43..8c87548951b2 100644 --- a/atom/browser/common_web_contents_delegate.h +++ b/atom/browser/common_web_contents_delegate.h @@ -26,10 +26,12 @@ class CommonWebContentsDelegate CommonWebContentsDelegate(); virtual ~CommonWebContentsDelegate(); - // Create a InspectableWebContents object and takes onwership of + // Creates a InspectableWebContents object and takes onwership of // |web_contents|. - void InitWithWebContents(content::WebContents* web_contents, - NativeWindow* owner_window); + void InitWithWebContents(content::WebContents* web_contents); + + // Set the window as owner window. + void SetOwnerWindow(NativeWindow* owner_window); // Destroy the managed InspectableWebContents object. void DestroyWebContents(); diff --git a/atom/browser/lib/guest-view-manager.coffee b/atom/browser/lib/guest-view-manager.coffee index ea6be5547dde..4385d389c39d 100644 --- a/atom/browser/lib/guest-view-manager.coffee +++ b/atom/browser/lib/guest-view-manager.coffee @@ -38,7 +38,7 @@ createGuest = (embedder, params) -> webViewManager ?= process.atomBinding 'web_view_manager' id = getNextInstanceId embedder - guest = webContents.create {embedder} + guest = webContents.create {isGuest: true, embedder} guestInstances[id] = {guest, embedder} # Destroy guest when the embedder is gone or navigated. diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index e635daec2c03..4d85f7cc623c 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -94,7 +94,8 @@ NativeWindow::NativeWindow(content::WebContents* web_contents, has_dialog_attached_(false), zoom_factor_(1.0), weak_factory_(this) { - InitWithWebContents(web_contents, this); + InitWithWebContents(web_contents); + SetOwnerWindow(this); options.Get(switches::kFrame, &has_frame_); options.Get(switches::kTransparent, &transparent_); From 5236b0c0679fee48791b724ca7ab2d35f605d859 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 25 Jun 2015 09:47:57 +0800 Subject: [PATCH 0381/1293] Don't create WebContents in NativeWindow --- atom/browser/api/atom_api_window.cc | 21 +++++++++++---------- atom/browser/api/atom_api_window.h | 5 +---- atom/browser/native_window.cc | 19 +++++-------------- atom/browser/native_window.h | 18 +++++++++--------- atom/browser/native_window_mac.h | 6 +++--- atom/browser/native_window_mac.mm | 14 ++++++++------ atom/browser/native_window_views.cc | 12 +++++++----- atom/browser/native_window_views.h | 6 +++--- 8 files changed, 47 insertions(+), 54 deletions(-) diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index 86399ce057d2..9869e36cbad9 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -38,8 +38,16 @@ void OnCapturePageDone( } // namespace -Window::Window(const mate::Dictionary& options) - : window_(NativeWindow::Create(options)) { +Window::Window(v8::Isolate* isolate, const mate::Dictionary& options) { + // Creates the WebContents used by BrowserWindow. + mate::Dictionary web_contents_options(isolate, v8::Object::New(isolate)); + auto web_contents = WebContents::Create(isolate, web_contents_options); + web_contents_.Reset(isolate, web_contents.ToV8()); + + // Creates BrowserWindow. + window_.reset(NativeWindow::Create(web_contents->managed_web_contents(), + options)); + web_contents->SetOwnerWindow(window_.get()); window_->InitFromOptions(options); window_->AddObserver(this); } @@ -49,13 +57,6 @@ Window::~Window() { Destroy(); } -void Window::AfterInit(v8::Isolate* isolate) { - mate::TrackableObject::AfterInit(isolate); - auto web_contents = window_->managed_web_contents(); - auto handle = WebContents::CreateFrom(isolate, web_contents); - web_contents_.Reset(isolate, handle.ToV8()); -} - void Window::OnPageTitleUpdated(bool* prevent_default, const std::string& title) { *prevent_default = Emit("page-title-updated", title); @@ -173,7 +174,7 @@ mate::Wrappable* Window::New(v8::Isolate* isolate, "Cannot create BrowserWindow before app is ready"); return nullptr; } - return new Window(options); + return new Window(isolate, options); } void Window::Destroy() { diff --git a/atom/browser/api/atom_api_window.h b/atom/browser/api/atom_api_window.h index a0403dde54f6..f6c99ebda3fa 100644 --- a/atom/browser/api/atom_api_window.h +++ b/atom/browser/api/atom_api_window.h @@ -45,12 +45,9 @@ class Window : public mate::TrackableObject, NativeWindow* window() const { return window_.get(); } protected: - explicit Window(const mate::Dictionary& options); + Window(v8::Isolate* isolate, const mate::Dictionary& options); virtual ~Window(); - // mate::Wrappable: - void AfterInit(v8::Isolate* isolate) override; - // NativeWindowObserver: void OnPageTitleUpdated(bool* prevent_default, const std::string& title) override; diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 4d85f7cc623c..fc32ee71377d 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -83,9 +83,10 @@ std::string RemoveWhitespace(const std::string& str) { } // namespace -NativeWindow::NativeWindow(content::WebContents* web_contents, - const mate::Dictionary& options) - : content::WebContentsObserver(web_contents), +NativeWindow::NativeWindow( + brightray::InspectableWebContents* inspectable_web_contents, + const mate::Dictionary& options) + : content::WebContentsObserver(inspectable_web_contents->GetWebContents()), has_frame_(true), transparent_(false), enable_larger_than_screen_(false), @@ -94,9 +95,6 @@ NativeWindow::NativeWindow(content::WebContents* web_contents, has_dialog_attached_(false), zoom_factor_(1.0), weak_factory_(this) { - InitWithWebContents(web_contents); - SetOwnerWindow(this); - options.Get(switches::kFrame, &has_frame_); options.Get(switches::kTransparent, &transparent_); options.Get(switches::kEnableLargerThanScreen, &enable_larger_than_screen_); @@ -137,7 +135,7 @@ NativeWindow::NativeWindow(content::WebContents* web_contents, RemoveWhitespace(browser->GetName()).c_str(), browser->GetVersion().c_str(), CHROME_VERSION_STRING); - web_contents->GetMutableRendererPrefs()->user_agent_override = + web_contents()->GetMutableRendererPrefs()->user_agent_override = content::BuildUserAgentFromProduct(product_name); } @@ -147,13 +145,6 @@ NativeWindow::~NativeWindow() { NotifyWindowClosed(); } -// static -NativeWindow* NativeWindow::Create(const mate::Dictionary& options) { - auto browser_context = AtomBrowserMainParts::Get()->browser_context(); - content::WebContents::CreateParams create_params(browser_context); - return Create(content::WebContents::Create(create_params), options); -} - // static NativeWindow* NativeWindow::FromWebContents( content::WebContents* web_contents) { diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index 8f3a04c88661..0f0614568965 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -77,12 +77,9 @@ class NativeWindow : public CommonWebContentsDelegate, // Create window with existing WebContents, the caller is responsible for // managing the window's live. - static NativeWindow* Create(content::WebContents* web_contents, - const mate::Dictionary& options); - - // Create window with new WebContents, the caller is responsible for - // managing the window's live. - static NativeWindow* Create(const mate::Dictionary& options); + static NativeWindow* Create( + brightray::InspectableWebContents* inspectable_web_contents, + const mate::Dictionary& options); // Find a window from its WebContents static NativeWindow* FromWebContents(content::WebContents* web_contents); @@ -200,7 +197,7 @@ class NativeWindow : public CommonWebContentsDelegate, } brightray::InspectableWebContents* inspectable_web_contents() const { - return managed_web_contents(); + return inspectable_web_contents_; } bool has_frame() const { return has_frame_; } @@ -210,8 +207,8 @@ class NativeWindow : public CommonWebContentsDelegate, } protected: - explicit NativeWindow(content::WebContents* web_contents, - const mate::Dictionary& options); + NativeWindow(brightray::InspectableWebContents* inspectable_web_contents, + const mate::Dictionary& options); // Called when the window needs to update its draggable region. virtual void UpdateDraggableRegions( @@ -300,6 +297,9 @@ class NativeWindow : public CommonWebContentsDelegate, // Page's default zoom factor. double zoom_factor_; + // The page this window is viewing. + brightray::InspectableWebContents* inspectable_web_contents_; + base::WeakPtrFactory weak_factory_; DISALLOW_COPY_AND_ASSIGN(NativeWindow); diff --git a/atom/browser/native_window_mac.h b/atom/browser/native_window_mac.h index 8a6d141c34bf..7f9272bea72f 100644 --- a/atom/browser/native_window_mac.h +++ b/atom/browser/native_window_mac.h @@ -23,9 +23,9 @@ namespace atom { class NativeWindowMac : public NativeWindow { public: - explicit NativeWindowMac(content::WebContents* web_contents, - const mate::Dictionary& options); - virtual ~NativeWindowMac(); + NativeWindowMac(brightray::InspectableWebContents* inspectable_web_contents, + const mate::Dictionary& options); + ~NativeWindowMac() override; // NativeWindow implementation. void Close() override; diff --git a/atom/browser/native_window_mac.mm b/atom/browser/native_window_mac.mm index 8130d2c0fedd..093b18322242 100644 --- a/atom/browser/native_window_mac.mm +++ b/atom/browser/native_window_mac.mm @@ -104,7 +104,7 @@ static const CGFloat kAtomWindowCornerRadius = 4.0; - (void)windowDidMove:(NSNotification*)notification { // TODO(zcbenz): Remove the alias after figuring out a proper - // way to disptach move. + // way to disptach move. shell_->NotifyWindowMove(); shell_->NotifyWindowMoved(); } @@ -303,8 +303,9 @@ SkRegion* DraggableRegionsToSkRegion( } // namespace -NativeWindowMac::NativeWindowMac(content::WebContents* web_contents, - const mate::Dictionary& options) +NativeWindowMac::NativeWindowMac( + brightray::InspectableWebContents* web_contents, + const mate::Dictionary& options) : NativeWindow(web_contents, options), is_kiosk_(false), attention_request_id_(0) { @@ -834,9 +835,10 @@ void NativeWindowMac::InstallDraggableRegionView() { } // static -NativeWindow* NativeWindow::Create(content::WebContents* web_contents, - const mate::Dictionary& options) { - return new NativeWindowMac(web_contents, options); +NativeWindow* NativeWindow::Create( + brightray::InspectableWebContents* inspectable_web_contents, + const mate::Dictionary& options) { + return new NativeWindowMac(inspectable_web_contents, options); } } // namespace atom diff --git a/atom/browser/native_window_views.cc b/atom/browser/native_window_views.cc index 52309ba29774..4c7700d3f2be 100644 --- a/atom/browser/native_window_views.cc +++ b/atom/browser/native_window_views.cc @@ -142,8 +142,9 @@ class NativeWindowClientView : public views::ClientView { } // namespace -NativeWindowViews::NativeWindowViews(content::WebContents* web_contents, - const mate::Dictionary& options) +NativeWindowViews::NativeWindowViews( + brightray::InspectableWebContents* web_contents, + const mate::Dictionary& options) : NativeWindow(web_contents, options), window_(new views::Widget), web_view_(inspectable_web_contents()->GetView()->GetView()), @@ -973,9 +974,10 @@ ui::WindowShowState NativeWindowViews::GetRestoredState() { } // static -NativeWindow* NativeWindow::Create(content::WebContents* web_contents, - const mate::Dictionary& options) { - return new NativeWindowViews(web_contents, options); +NativeWindow* NativeWindow::Create( + brightray::InspectableWebContents* inspectable_web_contents, + const mate::Dictionary& options) { + return new NativeWindowViews(inspectable_web_contents, options); } } // namespace atom diff --git a/atom/browser/native_window_views.h b/atom/browser/native_window_views.h index becd1b9f9f2c..621122566e67 100644 --- a/atom/browser/native_window_views.h +++ b/atom/browser/native_window_views.h @@ -28,9 +28,9 @@ class NativeWindowViews : public NativeWindow, public views::WidgetDelegateView, public views::WidgetObserver { public: - explicit NativeWindowViews(content::WebContents* web_contents, - const mate::Dictionary& options); - virtual ~NativeWindowViews(); + NativeWindowViews(brightray::InspectableWebContents* inspectable_web_contents, + const mate::Dictionary& options); + ~NativeWindowViews() override; // NativeWindow: void Close() override; From fb5fe7a7140837c63631f2fde46bcc2690017f79 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 25 Jun 2015 11:07:23 +0800 Subject: [PATCH 0382/1293] Decouple WebContentsDelegate from NativeWindow --- atom/browser/api/atom_api_web_contents.cc | 97 ++++++++++++++-------- atom/browser/api/atom_api_web_contents.h | 14 +++- atom/browser/api/atom_api_window.cc | 25 +++--- atom/browser/api/atom_api_window.h | 7 +- atom/browser/api/lib/browser-window.coffee | 9 +- atom/browser/native_window.cc | 85 ++----------------- atom/browser/native_window.h | 52 +++++------- atom/browser/native_window_mac.h | 4 +- atom/browser/native_window_mac.mm | 4 +- atom/browser/native_window_views.h | 2 +- 10 files changed, 120 insertions(+), 179 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index a7877fa6f59d..dd059886d048 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -142,12 +142,6 @@ content::ServiceWorkerContext* GetServiceWorkerContext( } // namespace -WebContents::WebContents(brightray::InspectableWebContents* web_contents) - : WebContents(web_contents->GetWebContents()) { - type_ = BROWSER_WINDOW; - inspectable_web_contents_ = web_contents; -} - WebContents::WebContents(content::WebContents* web_contents) : content::WebContentsObserver(web_contents), guest_opaque_(true), @@ -210,8 +204,12 @@ bool WebContents::AddMessageToConsole(content::WebContents* source, const base::string16& message, int32 line_no, const base::string16& source_id) { - Emit("console-message", level, message, line_no, source_id); - return true; + if (type_ == BROWSER_WINDOW) { + return false; + } else { + Emit("console-message", level, message, line_no, source_id); + return true; + } } bool WebContents::ShouldCreateWebContents( @@ -223,19 +221,21 @@ bool WebContents::ShouldCreateWebContents( const GURL& target_url, const std::string& partition_id, content::SessionStorageNamespace* session_storage_namespace) { - Emit("new-window", target_url, frame_name, NEW_FOREGROUND_TAB); + if (type_ == BROWSER_WINDOW) + Emit("-new-window", target_url, frame_name, NEW_FOREGROUND_TAB); + else + Emit("new-window", target_url, frame_name, NEW_FOREGROUND_TAB); return false; } -void WebContents::CloseContents(content::WebContents* source) { - Emit("close"); -} - content::WebContents* WebContents::OpenURLFromTab( content::WebContents* source, const content::OpenURLParams& params) { if (params.disposition != CURRENT_TAB) { - Emit("new-window", params.url, "", params.disposition); + if (type_ == BROWSER_WINDOW) + Emit("-new-window", params.url, "", params.disposition); + else + Emit("new-window", params.url, "", params.disposition); return nullptr; } @@ -246,6 +246,31 @@ content::WebContents* WebContents::OpenURLFromTab( return CommonWebContentsDelegate::OpenURLFromTab(source, params); } +void WebContents::BeforeUnloadFired(content::WebContents* tab, + bool proceed, + bool* proceed_to_fire_unload) { + if (type_ == BROWSER_WINDOW) + *proceed_to_fire_unload = proceed; + else + *proceed_to_fire_unload = true; +} + +void WebContents::MoveContents(content::WebContents* source, + const gfx::Rect& pos) { + Emit("move", pos); +} + +void WebContents::CloseContents(content::WebContents* source) { + Emit("closed"); + if (type_ == BROWSER_WINDOW) + owner_window()->CloseContents(source); +} + +void WebContents::ActivateContents(content::WebContents* source) { + if (type_ == BROWSER_WINDOW) + owner_window()->CloseContents(source); +} + bool WebContents::IsPopupOrPanel(const content::WebContents* source) const { return type_ == BROWSER_WINDOW; } @@ -253,12 +278,12 @@ bool WebContents::IsPopupOrPanel(const content::WebContents* source) const { void WebContents::HandleKeyboardEvent( content::WebContents* source, const content::NativeWebKeyboardEvent& event) { - if (!attached()) - return; - - // Send the unhandled keyboard events back to the embedder to reprocess them. - embedder_web_contents_->GetDelegate()->HandleKeyboardEvent( - web_contents(), event); + if (type_ == BROWSER_WINDOW) { + owner_window()->HandleKeyboardEvent(source, event); + } else if (type_ == WEB_VIEW && !attached()) { + // Send the unhandled keyboard events back to the embedder. + embedder_web_contents_->GetDelegate()->HandleKeyboardEvent(source, event); + } } void WebContents::EnterFullscreenModeForTab(content::WebContents* source, @@ -272,6 +297,23 @@ void WebContents::ExitFullscreenModeForTab(content::WebContents* source) { Emit("leave-html-full-screen"); } +void WebContents::RendererUnresponsive(content::WebContents* source) { + Emit("unresponsive"); + if (type_ == BROWSER_WINDOW) + owner_window()->RendererUnresponsive(source); +} + +void WebContents::RendererResponsive(content::WebContents* source) { + Emit("responsive"); + if (type_ == BROWSER_WINDOW) + owner_window()->RendererResponsive(source); +} + +void WebContents::BeforeUnloadFired(const base::TimeTicks& proceed_time) { + // Do nothing, we override this method just to avoid compilation error since + // there are two virtual functions named BeforeUnloadFired. +} + void WebContents::RenderViewDeleted(content::RenderViewHost* render_view_host) { int process_id = render_view_host->GetProcess()->GetID(); Emit("render-view-deleted", process_id); @@ -898,21 +940,6 @@ gfx::Size WebContents::GetDefaultSize() const { } } -// static -mate::Handle WebContents::CreateFrom( - v8::Isolate* isolate, brightray::InspectableWebContents* web_contents) { - // We have an existing WebContents object in JS. - auto existing = TrackableObject::FromWrappedClass( - isolate, web_contents->GetWebContents()); - if (existing) - return mate::CreateHandle(isolate, static_cast(existing)); - - // Otherwise create a new WebContents wrapper object. - auto handle = mate::CreateHandle(isolate, new WebContents(web_contents)); - g_wrap_web_contents.Run(handle.ToV8()); - return handle; -} - // static mate::Handle WebContents::CreateFrom( v8::Isolate* isolate, content::WebContents* web_contents) { diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index be874d9e35dc..55f087742069 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -57,8 +57,6 @@ class WebContents : public mate::TrackableObject, PrintToPDFCallback; // Create from an existing WebContents. - static mate::Handle CreateFrom( - v8::Isolate* isolate, brightray::InspectableWebContents* web_contents); static mate::Handle CreateFrom( v8::Isolate* isolate, content::WebContents* web_contents); @@ -136,7 +134,6 @@ class WebContents : public mate::TrackableObject, } protected: - explicit WebContents(brightray::InspectableWebContents* web_contents); explicit WebContents(content::WebContents* web_contents); explicit WebContents(const mate::Dictionary& options); ~WebContents(); @@ -160,10 +157,16 @@ class WebContents : public mate::TrackableObject, const GURL& target_url, const std::string& partition_id, content::SessionStorageNamespace* session_storage_namespace) override; - void CloseContents(content::WebContents* source) override; content::WebContents* OpenURLFromTab( content::WebContents* source, const content::OpenURLParams& params) override; + void BeforeUnloadFired(content::WebContents* tab, + bool proceed, + bool* proceed_to_fire_unload) override; + void MoveContents(content::WebContents* source, + const gfx::Rect& pos) override; + void CloseContents(content::WebContents* source) override; + void ActivateContents(content::WebContents* contents) override; bool IsPopupOrPanel(const content::WebContents* source) const override; void HandleKeyboardEvent( content::WebContents* source, @@ -171,8 +174,11 @@ class WebContents : public mate::TrackableObject, void EnterFullscreenModeForTab(content::WebContents* source, const GURL& origin) override; void ExitFullscreenModeForTab(content::WebContents* source) override; + void RendererUnresponsive(content::WebContents* source) override; + void RendererResponsive(content::WebContents* source) override; // content::WebContentsObserver: + void BeforeUnloadFired(const base::TimeTicks& proceed_time) override; void RenderViewDeleted(content::RenderViewHost*) override; void RenderProcessGone(base::TerminationStatus status) override; void DocumentLoadedInFrame( diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index 9869e36cbad9..2dae7f8617f5 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -43,6 +43,7 @@ Window::Window(v8::Isolate* isolate, const mate::Dictionary& options) { mate::Dictionary web_contents_options(isolate, v8::Object::New(isolate)); auto web_contents = WebContents::Create(isolate, web_contents_options); web_contents_.Reset(isolate, web_contents.ToV8()); + api_web_contents_ = web_contents.get(); // Creates BrowserWindow. window_.reset(NativeWindow::Create(web_contents->managed_web_contents(), @@ -62,17 +63,6 @@ void Window::OnPageTitleUpdated(bool* prevent_default, *prevent_default = Emit("page-title-updated", title); } -void Window::WillCreatePopupWindow(const base::string16& frame_name, - const GURL& target_url, - const std::string& partition_id, - WindowOpenDisposition disposition) { - Emit("-new-window", target_url, frame_name); -} - -void Window::WillNavigate(bool* prevent_default, const GURL& url) { - *prevent_default = Emit("-will-navigate", url); -} - void Window::WillCloseWindow(bool* prevent_default) { *prevent_default = Emit("close"); } @@ -80,6 +70,12 @@ void Window::WillCloseWindow(bool* prevent_default) { void Window::OnWindowClosed() { Emit("closed"); + if (api_web_contents_) { + api_web_contents_->DestroyWebContents(); + api_web_contents_ = nullptr; + web_contents_.Reset(); + } + RemoveFromWeakMap(); window_->RemoveObserver(this); } @@ -153,8 +149,8 @@ void Window::OnDevToolsOpened() { v8::Locker locker(isolate()); v8::HandleScope handle_scope(isolate()); - auto handle = WebContents::CreateFrom(isolate(), - window_->GetDevToolsWebContents()); + auto handle = WebContents::CreateFrom( + isolate(), api_web_contents_->GetDevToolsWebContents()); devtools_web_contents_.Reset(isolate(), handle.ToV8()); } @@ -178,8 +174,7 @@ mate::Wrappable* Window::New(v8::Isolate* isolate, } void Window::Destroy() { - window_->DestroyWebContents(); - window_->CloseImmediately(); + window_->CloseContents(nullptr); } void Window::Close() { diff --git a/atom/browser/api/atom_api_window.h b/atom/browser/api/atom_api_window.h index f6c99ebda3fa..41383ea3e0ff 100644 --- a/atom/browser/api/atom_api_window.h +++ b/atom/browser/api/atom_api_window.h @@ -51,11 +51,6 @@ class Window : public mate::TrackableObject, // NativeWindowObserver: void OnPageTitleUpdated(bool* prevent_default, const std::string& title) override; - void WillCreatePopupWindow(const base::string16& frame_name, - const GURL& target_url, - const std::string& partition_id, - WindowOpenDisposition disposition) override; - void WillNavigate(bool* prevent_default, const GURL& url) override; void WillCloseWindow(bool* prevent_default) override; void OnWindowClosed() override; void OnWindowBlur() override; @@ -151,6 +146,8 @@ class Window : public mate::TrackableObject, v8::Global devtools_web_contents_; v8::Global menu_; + api::WebContents* api_web_contents_; + scoped_ptr window_; DISALLOW_COPY_AND_ASSIGN(Window); diff --git a/atom/browser/api/lib/browser-window.coffee b/atom/browser/api/lib/browser-window.coffee index 66e0670dc20e..24ae7b8deb37 100644 --- a/atom/browser/api/lib/browser-window.coffee +++ b/atom/browser/api/lib/browser-window.coffee @@ -12,14 +12,13 @@ BrowserWindow::_init = -> @setMenu menu if menu? # Make new windows requested by links behave like "window.open" - @on '-new-window', (event, url, frameName) => - event.sender = @webContents + @webContents.on '-new-window', (event, url, frameName) -> options = show: true, width: 800, height: 600 ipc.emit 'ATOM_SHELL_GUEST_WINDOW_MANAGER_WINDOW_OPEN', event, url, frameName, options - # Redirect "will-navigate" to webContents. - @on '-will-navigate', (event, url) => - @webContents.emit 'will-navigate', event, url + # window.move(...) + @webContents.on 'move', (event, size) => + @setSize size # Redirect focus/blur event to app instance too. @on 'blur', (event) => diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index fc32ee71377d..8748388ae558 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -94,6 +94,7 @@ NativeWindow::NativeWindow( node_integration_(true), has_dialog_attached_(false), zoom_factor_(1.0), + inspectable_web_contents_(inspectable_web_contents), weak_factory_(this) { options.Get(switches::kFrame, &has_frame_); options.Get(switches::kTransparent, &transparent_); @@ -341,6 +342,13 @@ void NativeWindow::CloseWebContents() { web_contents->Close(); } +content::WebContents* NativeWindow::GetWebContents() const { + if (inspectable_web_contents_) + return inspectable_web_contents_->GetWebContents(); + else + return nullptr; +} + void NativeWindow::AppendExtraCommandLineSwitches( base::CommandLine* command_line) { // Append --node-integration to renderer process. @@ -475,52 +483,6 @@ void NativeWindow::NotifyWindowLeaveHtmlFullScreen() { OnWindowLeaveHtmlFullScreen()); } -bool NativeWindow::ShouldCreateWebContents( - content::WebContents* web_contents, - int route_id, - int main_frame_route_id, - WindowContainerType window_container_type, - const base::string16& frame_name, - const GURL& target_url, - const std::string& partition_id, - content::SessionStorageNamespace* session_storage_namespace) { - FOR_EACH_OBSERVER(NativeWindowObserver, - observers_, - WillCreatePopupWindow(frame_name, - target_url, - partition_id, - NEW_FOREGROUND_TAB)); - return false; -} - -// In atom-shell all reloads and navigations started by renderer process would -// be redirected to this method, so we can have precise control of how we -// would open the url (in our case, is to restart the renderer process). See -// AtomRendererClient::ShouldFork for how this is done. -content::WebContents* NativeWindow::OpenURLFromTab( - content::WebContents* source, - const content::OpenURLParams& params) { - if (params.disposition != CURRENT_TAB) { - FOR_EACH_OBSERVER(NativeWindowObserver, - observers_, - WillCreatePopupWindow(base::string16(), - params.url, - "", - params.disposition)); - return nullptr; - } - - // Give user a chance to prevent navigation. - bool prevent_default = false; - FOR_EACH_OBSERVER(NativeWindowObserver, - observers_, - WillNavigate(&prevent_default, params.url)); - if (prevent_default) - return nullptr; - - return CommonWebContentsDelegate::OpenURLFromTab(source, params); -} - void NativeWindow::RenderViewCreated( content::RenderViewHost* render_view_host) { if (!transparent_) @@ -533,20 +495,8 @@ void NativeWindow::RenderViewCreated( impl->SetBackgroundOpaque(false); } -void NativeWindow::BeforeUnloadFired(content::WebContents* tab, - bool proceed, - bool* proceed_to_fire_unload) { - *proceed_to_fire_unload = proceed; -} - -void NativeWindow::MoveContents(content::WebContents* source, - const gfx::Rect& pos) { - SetBounds(pos); -} - void NativeWindow::CloseContents(content::WebContents* source) { - // Destroy the WebContents before we close the window. - DestroyWebContents(); + inspectable_web_contents_ = nullptr; // When the web contents is gone, close the window immediately, but the // memory will not be freed until you call delete. @@ -575,11 +525,6 @@ void NativeWindow::RendererResponsive(content::WebContents* source) { FOR_EACH_OBSERVER(NativeWindowObserver, observers_, OnRendererResponsive()); } -void NativeWindow::BeforeUnloadFired(const base::TimeTicks& proceed_time) { - // Do nothing, we override this method just to avoid compilation error since - // there are two virtual functions named BeforeUnloadFired. -} - void NativeWindow::BeforeUnloadDialogCancelled() { WindowList::WindowCloseCancelled(this); @@ -609,18 +554,6 @@ bool NativeWindow::OnMessageReceived(const IPC::Message& message) { return handled; } -void NativeWindow::DevToolsFocused() { - FOR_EACH_OBSERVER(NativeWindowObserver, observers_, OnDevToolsFocus()); -} - -void NativeWindow::DevToolsOpened() { - FOR_EACH_OBSERVER(NativeWindowObserver, observers_, OnDevToolsOpened()); -} - -void NativeWindow::DevToolsClosed() { - FOR_EACH_OBSERVER(NativeWindowObserver, observers_, OnDevToolsClosed()); -} - void NativeWindow::ScheduleUnresponsiveEvent(int ms) { if (!window_unresposive_closure_.IsCancelled()) return; diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index 0f0614568965..8fe514337bb9 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -9,7 +9,6 @@ #include #include -#include "atom/browser/common_web_contents_delegate.h" #include "atom/browser/native_window_observer.h" #include "atom/browser/ui/accelerator_util.h" #include "base/cancelable_callback.h" @@ -17,17 +16,22 @@ #include "base/memory/weak_ptr.h" #include "base/observer_list.h" #include "content/public/browser/readback_types.h" +#include "content/public/browser/web_contents_observer.h" #include "content/public/browser/web_contents_user_data.h" #include "native_mate/persistent_dictionary.h" #include "ui/gfx/image/image.h" +#include "ui/gfx/image/image_skia.h" namespace base { class CommandLine; } +namespace brightray { +class InspectableWebContents; +} + namespace content { -class BrowserContext; -class WebContents; +struct NativeWebKeyboardEvent; struct WebPreferences; } @@ -49,8 +53,7 @@ namespace atom { struct DraggableRegion; -class NativeWindow : public CommonWebContentsDelegate, - public content::WebContentsObserver { +class NativeWindow : public content::WebContentsObserver { public: typedef base::Callback CapturePageCallback; @@ -167,6 +170,17 @@ class NativeWindow : public CommonWebContentsDelegate, return weak_factory_.GetWeakPtr(); } + content::WebContents* GetWebContents() const; + + // Methods called by the WebContents. + virtual void CloseContents(content::WebContents* source); + virtual void RendererUnresponsive(content::WebContents* source); + virtual void RendererResponsive(content::WebContents* source); + virtual void ActivateContents(content::WebContents* contents) {} + virtual void HandleKeyboardEvent( + content::WebContents*, + const content::NativeWebKeyboardEvent& event) {} + // Called when renderer process is going to be started. void AppendExtraCommandLineSwitches(base::CommandLine* command_line); void OverrideWebkitPrefs(content::WebPreferences* prefs); @@ -214,40 +228,12 @@ class NativeWindow : public CommonWebContentsDelegate, virtual void UpdateDraggableRegions( const std::vector& regions) = 0; - // Implementations of content::WebContentsDelegate. - bool ShouldCreateWebContents( - content::WebContents* web_contents, - int route_id, - int main_frame_route_id, - WindowContainerType window_container_type, - const base::string16& frame_name, - const GURL& target_url, - const std::string& partition_id, - content::SessionStorageNamespace* session_storage_namespace) override; - content::WebContents* OpenURLFromTab( - content::WebContents* source, - const content::OpenURLParams& params) override; - void BeforeUnloadFired(content::WebContents* tab, - bool proceed, - bool* proceed_to_fire_unload) override; - void MoveContents(content::WebContents* source, - const gfx::Rect& pos) override; - void CloseContents(content::WebContents* source) override; - void RendererUnresponsive(content::WebContents* source) override; - void RendererResponsive(content::WebContents* source) override; - // Implementations of content::WebContentsObserver. void RenderViewCreated(content::RenderViewHost* render_view_host) override; - void BeforeUnloadFired(const base::TimeTicks& proceed_time) override; void BeforeUnloadDialogCancelled() override; void TitleWasSet(content::NavigationEntry* entry, bool explicit_set) override; bool OnMessageReceived(const IPC::Message& message) override; - // Implementations of brightray::InspectableWebContentsDelegate. - void DevToolsFocused() override; - void DevToolsOpened() override; - void DevToolsClosed() override; - // Whether window has standard frame. bool has_frame_; diff --git a/atom/browser/native_window_mac.h b/atom/browser/native_window_mac.h index 7f9272bea72f..67f4389ff703 100644 --- a/atom/browser/native_window_mac.h +++ b/atom/browser/native_window_mac.h @@ -27,7 +27,7 @@ class NativeWindowMac : public NativeWindow { const mate::Dictionary& options); ~NativeWindowMac() override; - // NativeWindow implementation. + // NativeWindow: void Close() override; void CloseImmediately() override; void Focus(bool focus) override; @@ -91,7 +91,7 @@ class NativeWindowMac : public NativeWindow { void UpdateDraggableRegions( const std::vector& regions) override; - // Implementations of content::WebContentsDelegate. + // NativeWindow: void HandleKeyboardEvent( content::WebContents*, const content::NativeWebKeyboardEvent&) override; diff --git a/atom/browser/native_window_mac.mm b/atom/browser/native_window_mac.mm index 093b18322242..5c17ee3009a3 100644 --- a/atom/browser/native_window_mac.mm +++ b/atom/browser/native_window_mac.mm @@ -386,9 +386,7 @@ NativeWindowMac::NativeWindowMac( } NativeWindowMac::~NativeWindowMac() { - // Force InspectableWebContents to be destroyed before we destroy window, - // because it may still be observing the window at this time. - DestroyWebContents(); + Observe(nullptr); } void NativeWindowMac::Close() { diff --git a/atom/browser/native_window_views.h b/atom/browser/native_window_views.h index 621122566e67..c446d5339de4 100644 --- a/atom/browser/native_window_views.h +++ b/atom/browser/native_window_views.h @@ -127,7 +127,7 @@ class NativeWindowViews : public NativeWindow, std::string* name, std::string* class_name) override; #endif - // content::WebContentsDelegate: + // NativeWindow: void ActivateContents(content::WebContents* contents) override; void HandleKeyboardEvent( content::WebContents*, From 2ea2413752c3280faf230a5bfb61bec6c2070880 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 25 Jun 2015 11:16:31 +0800 Subject: [PATCH 0383/1293] Set sender in EventEmitter.emit --- atom/browser/api/event_emitter.cc | 8 +++++--- atom/browser/api/event_emitter.h | 2 +- atom/browser/api/lib/web-contents.coffee | 2 -- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/atom/browser/api/event_emitter.cc b/atom/browser/api/event_emitter.cc index 9cf7ba520c0f..46a8e629e3f3 100644 --- a/atom/browser/api/event_emitter.cc +++ b/atom/browser/api/event_emitter.cc @@ -6,6 +6,7 @@ #include "atom/browser/api/event.h" #include "native_mate/arguments.h" +#include "native_mate/dictionary.h" #include "native_mate/object_template_builder.h" namespace mate { @@ -15,8 +16,8 @@ namespace { v8::Persistent event_template; void PreventDefault(mate::Arguments* args) { - args->GetThis()->Set(StringToV8(args->isolate(), "defaultPrevented"), - v8::True(args->isolate())); + mate::Dictionary self(args->isolate(), args->GetThis()); + self.Set("defaultPrevented", true); } // Create a pure JavaScript Event object. @@ -38,7 +39,7 @@ EventEmitter::EventEmitter() { v8::Local EventEmitter::CreateEvent(v8::Isolate* isolate, content::WebContents* sender, - IPC::Message* message) const { + IPC::Message* message) { v8::Local event; bool use_native_event = sender && message; @@ -49,6 +50,7 @@ v8::Local EventEmitter::CreateEvent(v8::Isolate* isolate, } else { event = CreateEventObject(isolate); } + mate::Dictionary(isolate, event).Set("sender", GetWrapper(isolate)); return event; } diff --git a/atom/browser/api/event_emitter.h b/atom/browser/api/event_emitter.h index a249ce23f087..43fbd84f61c4 100644 --- a/atom/browser/api/event_emitter.h +++ b/atom/browser/api/event_emitter.h @@ -51,7 +51,7 @@ class EventEmitter : public Wrappable { private: v8::Local CreateEvent(v8::Isolate* isolate, content::WebContents* sender, - IPC::Message* message) const; + IPC::Message* message); DISALLOW_COPY_AND_ASSIGN(EventEmitter); }; diff --git a/atom/browser/api/lib/web-contents.coffee b/atom/browser/api/lib/web-contents.coffee index c07c54103385..b2232b72cda6 100644 --- a/atom/browser/api/lib/web-contents.coffee +++ b/atom/browser/api/lib/web-contents.coffee @@ -33,12 +33,10 @@ wrapWebContents = (webContents) -> # Dispatch IPC messages to the ipc module. webContents.on 'ipc-message', (event, packed) -> [channel, args...] = packed - Object.defineProperty event, 'sender', value: webContents ipc.emit channel, event, args... webContents.on 'ipc-message-sync', (event, packed) -> [channel, args...] = packed Object.defineProperty event, 'returnValue', set: (value) -> event.sendReply JSON.stringify(value) - Object.defineProperty event, 'sender', value: webContents ipc.emit channel, event, args... webContents.printToPDF = (options, callback) -> From afa9f30aacf4a44c611425f520ea72ecec314c0e Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 25 Jun 2015 12:30:04 +0800 Subject: [PATCH 0384/1293] Add InspectableWebContentsViewDelegate --- atom/browser/native_window.cc | 15 +++++++++++++++ atom/browser/native_window.h | 11 +++++++++-- atom/browser/native_window_views.h | 2 +- vendor/brightray | 2 +- 4 files changed, 26 insertions(+), 4 deletions(-) diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 8748388ae558..3e2bbd1cc2fe 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -96,6 +96,8 @@ NativeWindow::NativeWindow( zoom_factor_(1.0), inspectable_web_contents_(inspectable_web_contents), weak_factory_(this) { + inspectable_web_contents->GetView()->SetDelegate(this); + options.Get(switches::kFrame, &has_frame_); options.Get(switches::kTransparent, &transparent_); options.Get(switches::kEnableLargerThanScreen, &enable_larger_than_screen_); @@ -496,6 +498,7 @@ void NativeWindow::RenderViewCreated( } void NativeWindow::CloseContents(content::WebContents* source) { + inspectable_web_contents_->GetView()->SetDelegate(nullptr); inspectable_web_contents_ = nullptr; // When the web contents is gone, close the window immediately, but the @@ -525,6 +528,18 @@ void NativeWindow::RendererResponsive(content::WebContents* source) { FOR_EACH_OBSERVER(NativeWindowObserver, observers_, OnRendererResponsive()); } +void NativeWindow::DevToolsFocused() { + FOR_EACH_OBSERVER(NativeWindowObserver, observers_, OnDevToolsFocus()); +} + +void NativeWindow::DevToolsOpened() { + FOR_EACH_OBSERVER(NativeWindowObserver, observers_, OnDevToolsOpened()); +} + +void NativeWindow::DevToolsClosed() { + FOR_EACH_OBSERVER(NativeWindowObserver, observers_, OnDevToolsClosed()); +} + void NativeWindow::BeforeUnloadDialogCancelled() { WindowList::WindowCloseCancelled(this); diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index 8fe514337bb9..c52a1e0a9a3e 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -15,6 +15,7 @@ #include "base/memory/scoped_ptr.h" #include "base/memory/weak_ptr.h" #include "base/observer_list.h" +#include "brightray/browser/inspectable_web_contents_view_delegate.h" #include "content/public/browser/readback_types.h" #include "content/public/browser/web_contents_observer.h" #include "content/public/browser/web_contents_user_data.h" @@ -53,7 +54,8 @@ namespace atom { struct DraggableRegion; -class NativeWindow : public content::WebContentsObserver { +class NativeWindow : public content::WebContentsObserver, + public brightray::InspectableWebContentsViewDelegate { public: typedef base::Callback CapturePageCallback; @@ -228,7 +230,12 @@ class NativeWindow : public content::WebContentsObserver { virtual void UpdateDraggableRegions( const std::vector& regions) = 0; - // Implementations of content::WebContentsObserver. + // brightray::InspectableWebContentsViewDelegate: + void DevToolsFocused() override; + void DevToolsOpened() override; + void DevToolsClosed() override; + + // content::WebContentsObserver: void RenderViewCreated(content::RenderViewHost* render_view_host) override; void BeforeUnloadDialogCancelled() override; void TitleWasSet(content::NavigationEntry* entry, bool explicit_set) override; diff --git a/atom/browser/native_window_views.h b/atom/browser/native_window_views.h index c446d5339de4..fe4e8a8eb0b1 100644 --- a/atom/browser/native_window_views.h +++ b/atom/browser/native_window_views.h @@ -120,7 +120,7 @@ class NativeWindowViews : public NativeWindow, bool ExecuteWindowsCommand(int command_id) override; #endif - // brightray::InspectableWebContentsDelegate: + // brightray::InspectableWebContentsViewDelegate: gfx::ImageSkia GetDevToolsWindowIcon() override; #if defined(USE_X11) void GetDevToolsWindowWMClass( diff --git a/vendor/brightray b/vendor/brightray index 20871355cb59..b05e019d2f66 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit 20871355cb590e009d7ee394a7d9da0e4666ea0b +Subproject commit b05e019d2f66023fad1ae2f16cc765e3d62ffd5e From eb370ba22ac01957624ed4433686cf54fc53a963 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 25 Jun 2015 13:08:11 +0800 Subject: [PATCH 0385/1293] Allowing destroying a closed window --- atom/browser/native_window.cc | 3 +++ atom/browser/native_window_views.cc | 3 ++- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 3e2bbd1cc2fe..01ed47464d17 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -498,6 +498,9 @@ void NativeWindow::RenderViewCreated( } void NativeWindow::CloseContents(content::WebContents* source) { + if (!inspectable_web_contents_) + return; + inspectable_web_contents_->GetView()->SetDelegate(nullptr); inspectable_web_contents_ = nullptr; diff --git a/atom/browser/native_window_views.cc b/atom/browser/native_window_views.cc index 4c7700d3f2be..e0e276fea640 100644 --- a/atom/browser/native_window_views.cc +++ b/atom/browser/native_window_views.cc @@ -16,7 +16,8 @@ #include "atom/common/draggable_region.h" #include "atom/common/options_switches.h" #include "base/strings/utf_string_conversions.h" -#include "browser/inspectable_web_contents_view.h" +#include "brightray/browser/inspectable_web_contents.h" +#include "brightray/browser/inspectable_web_contents_view.h" #include "content/public/browser/native_web_keyboard_event.h" #include "native_mate/dictionary.h" #include "ui/aura/window.h" From e41b0d4d2cec9ca6107f61b58df1bdb4b72d086c Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 25 Jun 2015 13:18:36 +0800 Subject: [PATCH 0386/1293] Remove NativeWindow::ActivateContents --- atom/browser/api/atom_api_web_contents.cc | 3 +-- atom/browser/api/lib/browser-window.coffee | 5 +++++ atom/browser/native_window.h | 1 - atom/browser/native_window_views.cc | 7 ------- atom/browser/native_window_views.h | 1 - 5 files changed, 6 insertions(+), 11 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index dd059886d048..ef49218e1819 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -267,8 +267,7 @@ void WebContents::CloseContents(content::WebContents* source) { } void WebContents::ActivateContents(content::WebContents* source) { - if (type_ == BROWSER_WINDOW) - owner_window()->CloseContents(source); + Emit("activate"); } bool WebContents::IsPopupOrPanel(const content::WebContents* source) const { diff --git a/atom/browser/api/lib/browser-window.coffee b/atom/browser/api/lib/browser-window.coffee index 24ae7b8deb37..4305b29e21f9 100644 --- a/atom/browser/api/lib/browser-window.coffee +++ b/atom/browser/api/lib/browser-window.coffee @@ -20,6 +20,11 @@ BrowserWindow::_init = -> @webContents.on 'move', (event, size) => @setSize size + # Hide the auto-hide menu when webContents is focused. + @webContents.on 'activate', => + if process.platform isnt 'darwin' and @isMenuBarAutoHide() and @isMenuBarVisible() + @setMenuBarVisibility false + # Redirect focus/blur event to app instance too. @on 'blur', (event) => app.emit 'browser-window-blur', event, this diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index c52a1e0a9a3e..cc14d7b1410a 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -178,7 +178,6 @@ class NativeWindow : public content::WebContentsObserver, virtual void CloseContents(content::WebContents* source); virtual void RendererUnresponsive(content::WebContents* source); virtual void RendererResponsive(content::WebContents* source); - virtual void ActivateContents(content::WebContents* contents) {} virtual void HandleKeyboardEvent( content::WebContents*, const content::NativeWebKeyboardEvent& event) {} diff --git a/atom/browser/native_window_views.cc b/atom/browser/native_window_views.cc index e0e276fea640..b4f511877d28 100644 --- a/atom/browser/native_window_views.cc +++ b/atom/browser/native_window_views.cc @@ -872,13 +872,6 @@ void NativeWindowViews::GetDevToolsWindowWMClass( } #endif -void NativeWindowViews::ActivateContents(content::WebContents* contents) { - NativeWindow::ActivateContents(contents); - // Hide menu bar when web view is clicked. - if (menu_bar_autohide_ && menu_bar_visible_) - SetMenuBarVisibility(false); -} - void NativeWindowViews::HandleKeyboardEvent( content::WebContents*, const content::NativeWebKeyboardEvent& event) { diff --git a/atom/browser/native_window_views.h b/atom/browser/native_window_views.h index fe4e8a8eb0b1..fa7e13c1c335 100644 --- a/atom/browser/native_window_views.h +++ b/atom/browser/native_window_views.h @@ -128,7 +128,6 @@ class NativeWindowViews : public NativeWindow, #endif // NativeWindow: - void ActivateContents(content::WebContents* contents) override; void HandleKeyboardEvent( content::WebContents*, const content::NativeWebKeyboardEvent& event) override; From 62c44ee47b8cb2eae067760c068f026af9d40cd5 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 25 Jun 2015 13:27:51 +0800 Subject: [PATCH 0387/1293] Rename CloseWebContents to RequestToClosePage --- atom/browser/native_window.cc | 16 ++++++++-------- atom/browser/native_window.h | 8 +++----- atom/browser/native_window_mac.mm | 2 +- atom/browser/native_window_views.cc | 2 +- 4 files changed, 13 insertions(+), 15 deletions(-) diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 01ed47464d17..a612ec614708 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -315,7 +315,14 @@ void NativeWindow::CapturePage(const gfx::Rect& rect, kBGRA_8888_SkColorType); } -void NativeWindow::CloseWebContents() { +content::WebContents* NativeWindow::GetWebContents() const { + if (inspectable_web_contents_) + return inspectable_web_contents_->GetWebContents(); + else + return nullptr; +} + +void NativeWindow::RequestToClosePage() { bool prevent_default = false; FOR_EACH_OBSERVER(NativeWindowObserver, observers_, @@ -344,13 +351,6 @@ void NativeWindow::CloseWebContents() { web_contents->Close(); } -content::WebContents* NativeWindow::GetWebContents() const { - if (inspectable_web_contents_) - return inspectable_web_contents_->GetWebContents(); - else - return nullptr; -} - void NativeWindow::AppendExtraCommandLineSwitches( base::CommandLine* command_line) { // Append --node-integration to renderer process. diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index cc14d7b1410a..db546d71b61e 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -163,17 +163,15 @@ class NativeWindow : public content::WebContentsObserver, virtual void SetMenuBarVisibility(bool visible); virtual bool IsMenuBarVisible(); - // The same with closing a tab in a real browser. - // - // Should be called by platform code when user want to close the window. - virtual void CloseWebContents(); - base::WeakPtr GetWeakPtr() { return weak_factory_.GetWeakPtr(); } content::WebContents* GetWebContents() const; + // Requests the WebContents to close, can be cancelled by the page. + virtual void RequestToClosePage(); + // Methods called by the WebContents. virtual void CloseContents(content::WebContents* source); virtual void RendererUnresponsive(content::WebContents* source); diff --git a/atom/browser/native_window_mac.mm b/atom/browser/native_window_mac.mm index 5c17ee3009a3..fc165665146d 100644 --- a/atom/browser/native_window_mac.mm +++ b/atom/browser/native_window_mac.mm @@ -149,7 +149,7 @@ static const CGFloat kAtomWindowCornerRadius = 4.0; // When user tries to close the window by clicking the close button, we do // not close the window immediately, instead we try to close the web page // fisrt, and when the web page is closed the window will also be closed. - shell_->CloseWebContents(); + shell_->RequestToClosePage(); return NO; } diff --git a/atom/browser/native_window_views.cc b/atom/browser/native_window_views.cc index b4f511877d28..42802c926356 100644 --- a/atom/browser/native_window_views.cc +++ b/atom/browser/native_window_views.cc @@ -133,7 +133,7 @@ class NativeWindowClientView : public views::ClientView { virtual ~NativeWindowClientView() {} bool CanClose() override { - static_cast(contents_view())->CloseWebContents(); + static_cast(contents_view())->RequestToClosePage(); return false; } From 9974a238c2b5ed02579ec0853d92b5e4b9540d28 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 25 Jun 2015 13:29:30 +0800 Subject: [PATCH 0388/1293] Fix the order of function definitions --- atom/browser/native_window.cc | 92 +++++++++++++++++------------------ 1 file changed, 46 insertions(+), 46 deletions(-) diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index a612ec614708..b75bfbb5ff7b 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -351,6 +351,40 @@ void NativeWindow::RequestToClosePage() { web_contents->Close(); } +void NativeWindow::CloseContents(content::WebContents* source) { + if (!inspectable_web_contents_) + return; + + inspectable_web_contents_->GetView()->SetDelegate(nullptr); + inspectable_web_contents_ = nullptr; + + // When the web contents is gone, close the window immediately, but the + // memory will not be freed until you call delete. + // In this way, it would be safe to manage windows via smart pointers. If you + // want to free memory when the window is closed, you can do deleting by + // overriding the OnWindowClosed method in the observer. + CloseImmediately(); + + // Do not sent "unresponsive" event after window is closed. + window_unresposive_closure_.Cancel(); +} + +void NativeWindow::RendererUnresponsive(content::WebContents* source) { + // Schedule the unresponsive shortly later, since we may receive the + // responsive event soon. This could happen after the whole application had + // blocked for a while. + // Also notice that when closing this event would be ignored because we have + // explicity started a close timeout counter. This is on purpose because we + // don't want the unresponsive event to be sent too early when user is closing + // the window. + ScheduleUnresponsiveEvent(50); +} + +void NativeWindow::RendererResponsive(content::WebContents* source) { + window_unresposive_closure_.Cancel(); + FOR_EACH_OBSERVER(NativeWindowObserver, observers_, OnRendererResponsive()); +} + void NativeWindow::AppendExtraCommandLineSwitches( base::CommandLine* command_line) { // Append --node-integration to renderer process. @@ -485,52 +519,6 @@ void NativeWindow::NotifyWindowLeaveHtmlFullScreen() { OnWindowLeaveHtmlFullScreen()); } -void NativeWindow::RenderViewCreated( - content::RenderViewHost* render_view_host) { - if (!transparent_) - return; - - content::RenderWidgetHostImpl* impl = content::RenderWidgetHostImpl::FromID( - render_view_host->GetProcess()->GetID(), - render_view_host->GetRoutingID()); - if (impl) - impl->SetBackgroundOpaque(false); -} - -void NativeWindow::CloseContents(content::WebContents* source) { - if (!inspectable_web_contents_) - return; - - inspectable_web_contents_->GetView()->SetDelegate(nullptr); - inspectable_web_contents_ = nullptr; - - // When the web contents is gone, close the window immediately, but the - // memory will not be freed until you call delete. - // In this way, it would be safe to manage windows via smart pointers. If you - // want to free memory when the window is closed, you can do deleting by - // overriding the OnWindowClosed method in the observer. - CloseImmediately(); - - // Do not sent "unresponsive" event after window is closed. - window_unresposive_closure_.Cancel(); -} - -void NativeWindow::RendererUnresponsive(content::WebContents* source) { - // Schedule the unresponsive shortly later, since we may receive the - // responsive event soon. This could happen after the whole application had - // blocked for a while. - // Also notice that when closing this event would be ignored because we have - // explicity started a close timeout counter. This is on purpose because we - // don't want the unresponsive event to be sent too early when user is closing - // the window. - ScheduleUnresponsiveEvent(50); -} - -void NativeWindow::RendererResponsive(content::WebContents* source) { - window_unresposive_closure_.Cancel(); - FOR_EACH_OBSERVER(NativeWindowObserver, observers_, OnRendererResponsive()); -} - void NativeWindow::DevToolsFocused() { FOR_EACH_OBSERVER(NativeWindowObserver, observers_, OnDevToolsFocus()); } @@ -543,6 +531,18 @@ void NativeWindow::DevToolsClosed() { FOR_EACH_OBSERVER(NativeWindowObserver, observers_, OnDevToolsClosed()); } +void NativeWindow::RenderViewCreated( + content::RenderViewHost* render_view_host) { + if (!transparent_) + return; + + content::RenderWidgetHostImpl* impl = content::RenderWidgetHostImpl::FromID( + render_view_host->GetProcess()->GetID(), + render_view_host->GetRoutingID()); + if (impl) + impl->SetBackgroundOpaque(false); +} + void NativeWindow::BeforeUnloadDialogCancelled() { WindowList::WindowCloseCancelled(this); From b2a8678c47374dd8413920016a622d41653f8435 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 25 Jun 2015 14:28:13 +0800 Subject: [PATCH 0389/1293] Move BrowserPluginGuestDelegate to a separate class --- atom/browser/api/atom_api_web_contents.cc | 158 ++----------------- atom/browser/api/atom_api_web_contents.h | 82 +--------- atom/browser/api/event_emitter.h | 6 +- atom/browser/web_view_guest_delegate.cc | 175 ++++++++++++++++++++++ atom/browser/web_view_guest_delegate.h | 122 +++++++++++++++ filenames.gypi | 2 + 6 files changed, 322 insertions(+), 223 deletions(-) create mode 100644 atom/browser/web_view_guest_delegate.cc create mode 100644 atom/browser/web_view_guest_delegate.h diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index ef49218e1819..4aa5c1c54e2c 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -11,6 +11,7 @@ #include "atom/browser/atom_browser_context.h" #include "atom/browser/atom_browser_main_parts.h" #include "atom/browser/native_window.h" +#include "atom/browser/web_view_guest_delegate.h" #include "atom/common/api/api_messages.h" #include "atom/common/event_emitter_caller.h" #include "atom/common/native_mate_converters/gfx_converter.h" @@ -24,14 +25,12 @@ #include "chrome/browser/printing/print_view_manager_basic.h" #include "chrome/browser/printing/print_preview_message_handler.h" #include "content/public/browser/favicon_status.h" -#include "content/public/browser/guest_host.h" #include "content/public/browser/navigation_details.h" #include "content/public/browser/navigation_entry.h" #include "content/public/browser/plugin_service.h" #include "content/public/browser/render_frame_host.h" #include "content/public/browser/render_process_host.h" #include "content/public/browser/render_view_host.h" -#include "content/public/browser/render_widget_host_view.h" #include "content/public/browser/resource_request_details.h" #include "content/public/browser/service_worker_context.h" #include "content/public/browser/storage_partition.h" @@ -57,10 +56,10 @@ struct PrintSettings { namespace mate { template<> -struct Converter { +struct Converter { static bool FromV8(v8::Isolate* isolate, v8::Local val, - atom::api::SetSizeParams* out) { + atom::SetSizeParams* out) { mate::Dictionary params; if (!ConvertFromV8(isolate, val, ¶ms)) return false; @@ -116,9 +115,6 @@ namespace api { namespace { -const int kDefaultWidth = 300; -const int kDefaultHeight = 300; - v8::Persistent template_; // The wrapWebContents funtion which is implemented in JavaScript @@ -144,20 +140,12 @@ content::ServiceWorkerContext* GetServiceWorkerContext( WebContents::WebContents(content::WebContents* web_contents) : content::WebContentsObserver(web_contents), - guest_opaque_(true), - guest_host_(nullptr), - auto_size_enabled_(false), - is_full_page_plugin_(false), type_(REMOTE), inspectable_web_contents_(nullptr) { AttachAsUserData(web_contents); } -WebContents::WebContents(const mate::Dictionary& options) - : guest_opaque_(true), - guest_host_(nullptr), - auto_size_enabled_(false), - is_full_page_plugin_(false) { +WebContents::WebContents(const mate::Dictionary& options) { bool is_guest = false; options.Get("isGuest", &is_guest); @@ -169,7 +157,8 @@ WebContents::WebContents(const mate::Dictionary& options) content::SiteInstance* site_instance = content::SiteInstance::CreateForURL( browser_context, GURL("chrome-guest://fake-host")); content::WebContents::CreateParams params(browser_context, site_instance); - params.guest_delegate = this; + guest_delegate_.reset(new WebViewGuestDelegate); + params.guest_delegate = guest_delegate_.get(); web_contents = content::WebContents::Create(params); } else { content::WebContents::CreateParams params(browser_context); @@ -182,6 +171,8 @@ WebContents::WebContents(const mate::Dictionary& options) inspectable_web_contents_ = managed_web_contents(); if (is_guest) { + guest_delegate_->Initialize(this); + NativeWindow* owner_window = nullptr; WebContents* embedder = nullptr; if (options.Get("embedder", &embedder) && embedder) { @@ -279,9 +270,9 @@ void WebContents::HandleKeyboardEvent( const content::NativeWebKeyboardEvent& event) { if (type_ == BROWSER_WINDOW) { owner_window()->HandleKeyboardEvent(source, event); - } else if (type_ == WEB_VIEW && !attached()) { + } else if (type_ == WEB_VIEW && guest_delegate_) { // Send the unhandled keyboard events back to the embedder. - embedder_web_contents_->GetDelegate()->HandleKeyboardEvent(source, event); + guest_delegate_->HandleKeyboardEvent(source, event); } } @@ -467,21 +458,6 @@ bool WebContents::OnMessageReceived(const IPC::Message& message) { return handled; } -void WebContents::RenderViewReady() { - if (type_ != WEB_VIEW) - return; - - // We don't want to accidentally set the opacity of an interstitial page. - // WebContents::GetRenderWidgetHostView will return the RWHV of an - // interstitial page if one is showing at this time. We only want opacity - // to apply to web pages. - auto render_view_host_view = web_contents()->GetRenderViewHost()->GetView(); - if (guest_opaque_) - render_view_host_view->SetBackgroundColorToDefault(); - else - render_view_host_view->SetBackgroundColor(SK_ColorTRANSPARENT); -} - void WebContents::WebContentsDestroyed() { // The RenderViewDeleted was not called when the WebContents is destroyed. RenderViewDeleted(web_contents()->GetRenderViewHost()); @@ -495,40 +471,12 @@ void WebContents::NavigationEntryCommitted( details.is_in_page, details.did_replace_entry); } -void WebContents::DidAttach(int guest_proxy_routing_id) { - Emit("did-attach"); -} - -content::WebContents* WebContents::GetOwnerWebContents() const { - return embedder_web_contents_; -} - -void WebContents::GuestSizeChanged(const gfx::Size& new_size) { - if (!auto_size_enabled_) - return; - GuestSizeChangedDueToAutoSize(guest_size_, new_size); - guest_size_ = new_size; -} - -void WebContents::SetGuestHost(content::GuestHost* guest_host) { - guest_host_ = guest_host; -} - -void WebContents::WillAttach(content::WebContents* embedder_web_contents, - int element_instance_id, - bool is_full_page_plugin) { - embedder_web_contents_ = embedder_web_contents; - is_full_page_plugin_ = is_full_page_plugin; -} - void WebContents::Destroy() { if (type_ == WEB_VIEW && managed_web_contents()) { // When force destroying the "destroyed" event is not emitted. WebContentsDestroyed(); - // Give the content module an opportunity to perform some cleanup. - guest_host_->WillDestroy(); - guest_host_ = nullptr; + guest_delegate_->Destroy(); Observe(nullptr); DestroyWebContents(); @@ -781,72 +729,13 @@ bool WebContents::SendIPCMessage(const base::string16& channel, } void WebContents::SetSize(const SetSizeParams& params) { - bool enable_auto_size = - params.enable_auto_size ? *params.enable_auto_size : auto_size_enabled_; - gfx::Size min_size = params.min_size ? *params.min_size : min_auto_size_; - gfx::Size max_size = params.max_size ? *params.max_size : max_auto_size_; - - if (params.normal_size) - normal_size_ = *params.normal_size; - - min_auto_size_ = min_size; - min_auto_size_.SetToMin(max_size); - max_auto_size_ = max_size; - max_auto_size_.SetToMax(min_size); - - enable_auto_size &= !min_auto_size_.IsEmpty() && !max_auto_size_.IsEmpty(); - - content::RenderViewHost* rvh = web_contents()->GetRenderViewHost(); - if (enable_auto_size) { - // Autosize is being enabled. - rvh->EnableAutoResize(min_auto_size_, max_auto_size_); - normal_size_.SetSize(0, 0); - } else { - // Autosize is being disabled. - // Use default width/height if missing from partially defined normal size. - if (normal_size_.width() && !normal_size_.height()) - normal_size_.set_height(GetDefaultSize().height()); - if (!normal_size_.width() && normal_size_.height()) - normal_size_.set_width(GetDefaultSize().width()); - - gfx::Size new_size; - if (!normal_size_.IsEmpty()) { - new_size = normal_size_; - } else if (!guest_size_.IsEmpty()) { - new_size = guest_size_; - } else { - new_size = GetDefaultSize(); - } - - if (auto_size_enabled_) { - // Autosize was previously enabled. - rvh->DisableAutoResize(new_size); - GuestSizeChangedDueToAutoSize(guest_size_, new_size); - } else { - // Autosize was already disabled. - guest_host_->SizeContents(new_size); - } - - guest_size_ = new_size; - } - - auto_size_enabled_ = enable_auto_size; + if (guest_delegate_) + guest_delegate_->SetSize(params); } void WebContents::SetAllowTransparency(bool allow) { - if (guest_opaque_ != allow) - return; - - auto render_view_host = web_contents()->GetRenderViewHost(); - guest_opaque_ = !allow; - if (!render_view_host->GetView()) - return; - - if (guest_opaque_) { - render_view_host->GetView()->SetBackgroundColorToDefault(); - } else { - render_view_host->GetView()->SetBackgroundColor(SK_ColorTRANSPARENT); - } + if (guest_delegate_) + guest_delegate_->SetAllowTransparency(allow); } bool WebContents::IsGuest() const { @@ -922,23 +811,6 @@ void WebContents::OnRendererMessageSync(const base::string16& channel, EmitWithSender(base::UTF16ToUTF8(channel), web_contents(), message, args); } -void WebContents::GuestSizeChangedDueToAutoSize(const gfx::Size& old_size, - const gfx::Size& new_size) { - Emit("size-changed", - old_size.width(), old_size.height(), - new_size.width(), new_size.height()); -} - -gfx::Size WebContents::GetDefaultSize() const { - if (is_full_page_plugin_) { - // Full page plugins default to the size of the owner's viewport. - return embedder_web_contents_->GetRenderWidgetHostView() - ->GetVisibleViewportSize(); - } else { - return gfx::Size(kDefaultWidth, kDefaultHeight); - } -} - // static mate::Handle WebContents::CreateFrom( v8::Isolate* isolate, content::WebContents* web_contents) { diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index 55f087742069..677daf41854d 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -10,7 +10,6 @@ #include "atom/browser/api/trackable_object.h" #include "atom/browser/common_web_contents_delegate.h" -#include "content/public/browser/browser_plugin_guest_delegate.h" #include "content/public/common/favicon_url.h" #include "content/public/browser/web_contents_observer.h" #include "content/public/browser/gpu_data_manager_observer.h" @@ -28,26 +27,12 @@ class Dictionary; namespace atom { +struct SetSizeParams; +class WebViewGuestDelegate; + namespace api { -// A struct of parameters for SetSize(). The parameters are all declared as -// scoped pointers since they are all optional. Null pointers indicate that the -// parameter has not been provided, and the last used value should be used. Note -// that when |enable_auto_size| is true, providing |normal_size| is not -// meaningful. This is because the normal size of the guestview is overridden -// whenever autosizing occurs. -struct SetSizeParams { - SetSizeParams() {} - ~SetSizeParams() {} - - scoped_ptr enable_auto_size; - scoped_ptr min_size; - scoped_ptr max_size; - scoped_ptr normal_size; -}; - class WebContents : public mate::TrackableObject, - public content::BrowserPluginGuestDelegate, public CommonWebContentsDelegate, public content::WebContentsObserver, public content::GpuDataManagerObserver { @@ -115,18 +100,11 @@ class WebContents : public mate::TrackableObject, bool SendIPCMessage(const base::string16& channel, const base::ListValue& args); - // Used to toggle autosize mode for this GuestView, and set both the automatic - // and normal sizes. + // Methods for creating . void SetSize(const SetSizeParams& params); - - // Sets the transparency of the guest. void SetAllowTransparency(bool allow); - bool IsGuest() const; - // Returns whether this guest has an associated embedder. - bool attached() const { return !!embedder_web_contents_; } - // Returns the current InspectableWebContents object, nullptr will be returned // if current WebContents can not beinspected, e.g. it is the devtools. brightray::InspectableWebContents* inspectable_web_contents() const { @@ -204,7 +182,6 @@ class WebContents : public mate::TrackableObject, const content::LoadCommittedDetails& details, const content::FrameNavigateParams& params) override; bool OnMessageReceived(const IPC::Message& message) override; - void RenderViewReady() override; void WebContentsDestroyed() override; void NavigationEntryCommitted( const content::LoadCommittedDetails& load_details) override; @@ -214,15 +191,6 @@ class WebContents : public mate::TrackableObject, void PluginCrashed(const base::FilePath& plugin_path, base::ProcessId plugin_pid) override; - // content::BrowserPluginGuestDelegate: - void DidAttach(int guest_proxy_routing_id) final; - content::WebContents* GetOwnerWebContents() const final; - void GuestSizeChanged(const gfx::Size& new_size) final; - void SetGuestHost(content::GuestHost* guest_host) final; - void WillAttach(content::WebContents* embedder_web_contents, - int element_instance_id, - bool is_full_page_plugin) final; - // content::GpuDataManagerObserver: void OnGpuProcessCrashed(base::TerminationStatus exit_code) override; @@ -242,49 +210,9 @@ class WebContents : public mate::TrackableObject, const base::ListValue& args, IPC::Message* message); - // This method is invoked when the contents auto-resized to give the container - // an opportunity to match it if it wishes. - // - // This gives the derived class an opportunity to inform its container element - // or perform other actions. - void GuestSizeChangedDueToAutoSize(const gfx::Size& old_size, - const gfx::Size& new_size); - - // Returns the default size of the guestview. - gfx::Size GetDefaultSize() const; - v8::Global session_; - // Stores whether the contents of the guest can be transparent. - bool guest_opaque_; - - // The WebContents that attaches this guest view. - content::WebContents* embedder_web_contents_; - - // The size of the container element. - gfx::Size element_size_; - - // The size of the guest content. Note: In autosize mode, the container - // element may not match the size of the guest. - gfx::Size guest_size_; - - // A pointer to the guest_host. - content::GuestHost* guest_host_; - - // Indicates whether autosize mode is enabled or not. - bool auto_size_enabled_; - - // The maximum size constraints of the container element in autosize mode. - gfx::Size max_auto_size_; - - // The minimum size constraints of the container element in autosize mode. - gfx::Size min_auto_size_; - - // The size that will be used when autosize mode is disabled. - gfx::Size normal_size_; - - // Whether the guest view is inside a plugin document. - bool is_full_page_plugin_; + scoped_ptr guest_delegate_; // The type of current WebContents. Type type_; diff --git a/atom/browser/api/event_emitter.h b/atom/browser/api/event_emitter.h index 43fbd84f61c4..7139b606483c 100644 --- a/atom/browser/api/event_emitter.h +++ b/atom/browser/api/event_emitter.h @@ -25,9 +25,6 @@ class EventEmitter : public Wrappable { public: typedef std::vector> ValueArray; - protected: - EventEmitter(); - // this.emit(name, new Event(), args...); template bool Emit(const base::StringPiece& name, const Args&... args) { @@ -48,6 +45,9 @@ class EventEmitter : public Wrappable { StringToV8(isolate(), "defaultPrevented"))->BooleanValue(); } + protected: + EventEmitter(); + private: v8::Local CreateEvent(v8::Isolate* isolate, content::WebContents* sender, diff --git a/atom/browser/web_view_guest_delegate.cc b/atom/browser/web_view_guest_delegate.cc new file mode 100644 index 000000000000..98fa72da22d4 --- /dev/null +++ b/atom/browser/web_view_guest_delegate.cc @@ -0,0 +1,175 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#include "atom/browser/web_view_guest_delegate.h" + +#include "atom/browser/api/atom_api_web_contents.h" +#include "content/public/browser/guest_host.h" +#include "content/public/browser/render_view_host.h" +#include "content/public/browser/render_widget_host_view.h" + +namespace atom { + +namespace { + +const int kDefaultWidth = 300; +const int kDefaultHeight = 300; + +} // namespace + +WebViewGuestDelegate::WebViewGuestDelegate() + : guest_opaque_(true), + guest_host_(nullptr), + auto_size_enabled_(false), + is_full_page_plugin_(false), + api_web_contents_(nullptr) { +} + +WebViewGuestDelegate::~WebViewGuestDelegate() { +} + +void WebViewGuestDelegate::Initialize(api::WebContents* api_web_contents) { + api_web_contents_ = api_web_contents; + Observe(api_web_contents->GetWebContents()); +} + +void WebViewGuestDelegate::Destroy() { + // Give the content module an opportunity to perform some cleanup. + guest_host_->WillDestroy(); + guest_host_ = nullptr; +} + +void WebViewGuestDelegate::SetSize(const SetSizeParams& params) { + bool enable_auto_size = + params.enable_auto_size ? *params.enable_auto_size : auto_size_enabled_; + gfx::Size min_size = params.min_size ? *params.min_size : min_auto_size_; + gfx::Size max_size = params.max_size ? *params.max_size : max_auto_size_; + + if (params.normal_size) + normal_size_ = *params.normal_size; + + min_auto_size_ = min_size; + min_auto_size_.SetToMin(max_size); + max_auto_size_ = max_size; + max_auto_size_.SetToMax(min_size); + + enable_auto_size &= !min_auto_size_.IsEmpty() && !max_auto_size_.IsEmpty(); + + auto rvh = web_contents()->GetRenderViewHost(); + if (enable_auto_size) { + // Autosize is being enabled. + rvh->EnableAutoResize(min_auto_size_, max_auto_size_); + normal_size_.SetSize(0, 0); + } else { + // Autosize is being disabled. + // Use default width/height if missing from partially defined normal size. + if (normal_size_.width() && !normal_size_.height()) + normal_size_.set_height(GetDefaultSize().height()); + if (!normal_size_.width() && normal_size_.height()) + normal_size_.set_width(GetDefaultSize().width()); + + gfx::Size new_size; + if (!normal_size_.IsEmpty()) { + new_size = normal_size_; + } else if (!guest_size_.IsEmpty()) { + new_size = guest_size_; + } else { + new_size = GetDefaultSize(); + } + + if (auto_size_enabled_) { + // Autosize was previously enabled. + rvh->DisableAutoResize(new_size); + GuestSizeChangedDueToAutoSize(guest_size_, new_size); + } else { + // Autosize was already disabled. + guest_host_->SizeContents(new_size); + } + + guest_size_ = new_size; + } + + auto_size_enabled_ = enable_auto_size; +} + +void WebViewGuestDelegate::SetAllowTransparency(bool allow) { + if (guest_opaque_ != allow) + return; + + auto render_view_host = web_contents()->GetRenderViewHost(); + guest_opaque_ = !allow; + if (!render_view_host->GetView()) + return; + + if (guest_opaque_) { + render_view_host->GetView()->SetBackgroundColorToDefault(); + } else { + render_view_host->GetView()->SetBackgroundColor(SK_ColorTRANSPARENT); + } +} + +void WebViewGuestDelegate::HandleKeyboardEvent( + content::WebContents* source, + const content::NativeWebKeyboardEvent& event) { + if (embedder_web_contents_) + embedder_web_contents_->GetDelegate()->HandleKeyboardEvent(source, event); +} + +void WebViewGuestDelegate::RenderViewReady() { + // We don't want to accidentally set the opacity of an interstitial page. + // WebContents::GetRenderWidgetHostView will return the RWHV of an + // interstitial page if one is showing at this time. We only want opacity + // to apply to web pages. + auto render_view_host_view = web_contents()->GetRenderViewHost()->GetView(); + if (guest_opaque_) + render_view_host_view->SetBackgroundColorToDefault(); + else + render_view_host_view->SetBackgroundColor(SK_ColorTRANSPARENT); +} + +void WebViewGuestDelegate::DidAttach(int guest_proxy_routing_id) { + api_web_contents_->Emit("did-attach"); +} + +content::WebContents* WebViewGuestDelegate::GetOwnerWebContents() const { + return embedder_web_contents_; +} + +void WebViewGuestDelegate::GuestSizeChanged(const gfx::Size& new_size) { + if (!auto_size_enabled_) + return; + GuestSizeChangedDueToAutoSize(guest_size_, new_size); + guest_size_ = new_size; +} + +void WebViewGuestDelegate::SetGuestHost(content::GuestHost* guest_host) { + guest_host_ = guest_host; +} + +void WebViewGuestDelegate::WillAttach( + content::WebContents* embedder_web_contents, + int element_instance_id, + bool is_full_page_plugin) { + embedder_web_contents_ = embedder_web_contents; + is_full_page_plugin_ = is_full_page_plugin; +} + +void WebViewGuestDelegate::GuestSizeChangedDueToAutoSize( + const gfx::Size& old_size, const gfx::Size& new_size) { + api_web_contents_->Emit("size-changed", + old_size.width(), old_size.height(), + new_size.width(), new_size.height()); +} + +gfx::Size WebViewGuestDelegate::GetDefaultSize() const { + if (is_full_page_plugin_) { + // Full page plugins default to the size of the owner's viewport. + return embedder_web_contents_->GetRenderWidgetHostView() + ->GetVisibleViewportSize(); + } else { + return gfx::Size(kDefaultWidth, kDefaultHeight); + } +} + +} // namespace atom diff --git a/atom/browser/web_view_guest_delegate.h b/atom/browser/web_view_guest_delegate.h new file mode 100644 index 000000000000..267b5b248af6 --- /dev/null +++ b/atom/browser/web_view_guest_delegate.h @@ -0,0 +1,122 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#ifndef ATOM_BROWSER_WEB_VIEW_GUEST_DELEGATE_H_ +#define ATOM_BROWSER_WEB_VIEW_GUEST_DELEGATE_H_ + +#include "content/public/browser/browser_plugin_guest_delegate.h" +#include "content/public/browser/web_contents_observer.h" + +namespace content { +struct NativeWebKeyboardEvent; +} + +namespace atom { + +namespace api { +class WebContents; +} + +// A struct of parameters for SetSize(). The parameters are all declared as +// scoped pointers since they are all optional. Null pointers indicate that the +// parameter has not been provided, and the last used value should be used. Note +// that when |enable_auto_size| is true, providing |normal_size| is not +// meaningful. This is because the normal size of the guestview is overridden +// whenever autosizing occurs. +struct SetSizeParams { + SetSizeParams() {} + ~SetSizeParams() {} + + scoped_ptr enable_auto_size; + scoped_ptr min_size; + scoped_ptr max_size; + scoped_ptr normal_size; +}; + +class WebViewGuestDelegate : public content::BrowserPluginGuestDelegate, + public content::WebContentsObserver { + public: + WebViewGuestDelegate(); + ~WebViewGuestDelegate() override; + + void Initialize(api::WebContents* api_web_contents); + + // Called when the WebContents is going to be destroyed. + void Destroy(); + + // Used to toggle autosize mode for this GuestView, and set both the automatic + // and normal sizes. + void SetSize(const SetSizeParams& params); + + // Sets the transparency of the guest. + void SetAllowTransparency(bool allow); + + // Transfer the keyboard event to embedder. + void HandleKeyboardEvent(content::WebContents* source, + const content::NativeWebKeyboardEvent& event); + + protected: + // content::WebContentsObserver: + void RenderViewReady() override; + + // content::BrowserPluginGuestDelegate: + void DidAttach(int guest_proxy_routing_id) final; + content::WebContents* GetOwnerWebContents() const final; + void GuestSizeChanged(const gfx::Size& new_size) final; + void SetGuestHost(content::GuestHost* guest_host) final; + void WillAttach(content::WebContents* embedder_web_contents, + int element_instance_id, + bool is_full_page_plugin) final; + + private: + // This method is invoked when the contents auto-resized to give the container + // an opportunity to match it if it wishes. + // + // This gives the derived class an opportunity to inform its container element + // or perform other actions. + void GuestSizeChangedDueToAutoSize(const gfx::Size& old_size, + const gfx::Size& new_size); + + // Returns the default size of the guestview. + gfx::Size GetDefaultSize() const; + + // Stores whether the contents of the guest can be transparent. + bool guest_opaque_; + + // The WebContents that attaches this guest view. + content::WebContents* embedder_web_contents_; + + // The size of the container element. + gfx::Size element_size_; + + // The size of the guest content. Note: In autosize mode, the container + // element may not match the size of the guest. + gfx::Size guest_size_; + + // A pointer to the guest_host. + content::GuestHost* guest_host_; + + // Indicates whether autosize mode is enabled or not. + bool auto_size_enabled_; + + // The maximum size constraints of the container element in autosize mode. + gfx::Size max_auto_size_; + + // The minimum size constraints of the container element in autosize mode. + gfx::Size min_auto_size_; + + // The size that will be used when autosize mode is disabled. + gfx::Size normal_size_; + + // Whether the guest view is inside a plugin document. + bool is_full_page_plugin_; + + api::WebContents* api_web_contents_; + + DISALLOW_COPY_AND_ASSIGN(WebViewGuestDelegate); +}; + +} // namespace atom + +#endif // ATOM_BROWSER_WEB_VIEW_GUEST_DELEGATE_H_ diff --git a/filenames.gypi b/filenames.gypi index 4d2ba9c904a2..562e65280d59 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -207,6 +207,8 @@ 'atom/browser/ui/x/window_state_watcher.h', 'atom/browser/ui/x/x_window_utils.cc', 'atom/browser/ui/x/x_window_utils.h', + 'atom/browser/web_view_guest_delegate.cc', + 'atom/browser/web_view_guest_delegate.h', 'atom/browser/web_view_manager.cc', 'atom/browser/web_view_manager.h', 'atom/browser/web_dialog_helper.cc', From 01dc0f973ce3c734a122b4f8e39a2b00a854df2e Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 25 Jun 2015 14:32:38 +0800 Subject: [PATCH 0390/1293] Remove inspectable_web_contents_ --- atom/browser/api/atom_api_web_contents.cc | 15 +++++++-------- atom/browser/api/atom_api_web_contents.h | 10 ---------- 2 files changed, 7 insertions(+), 18 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 4aa5c1c54e2c..849b60ee6fa1 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -140,8 +140,7 @@ content::ServiceWorkerContext* GetServiceWorkerContext( WebContents::WebContents(content::WebContents* web_contents) : content::WebContentsObserver(web_contents), - type_(REMOTE), - inspectable_web_contents_(nullptr) { + type_(REMOTE) { AttachAsUserData(web_contents); } @@ -168,7 +167,6 @@ WebContents::WebContents(const mate::Dictionary& options) { Observe(web_contents); AttachAsUserData(web_contents); InitWithWebContents(web_contents); - inspectable_web_contents_ = managed_web_contents(); if (is_guest) { guest_delegate_->Initialize(this); @@ -575,21 +573,22 @@ void WebContents::OpenDevTools(mate::Arguments* args) { mate::Dictionary options; args->GetNext(&options) && options.Get("detach", &detach); } - inspectable_web_contents()->SetCanDock(!detach); - inspectable_web_contents()->ShowDevTools(); + managed_web_contents()->SetCanDock(!detach); + managed_web_contents()->ShowDevTools(); } void WebContents::CloseDevTools() { if (type_ == REMOTE) return; - inspectable_web_contents()->CloseDevTools(); + managed_web_contents()->CloseDevTools(); } bool WebContents::IsDevToolsOpened() { if (type_ == REMOTE) return false; - return inspectable_web_contents()->IsDevToolsViewShowing(); + + return managed_web_contents()->IsDevToolsViewShowing(); } void WebContents::ToggleDevTools() { @@ -617,7 +616,7 @@ void WebContents::InspectServiceWorker() { if (agent_host->GetType() == content::DevToolsAgentHost::TYPE_SERVICE_WORKER) { OpenDevTools(nullptr); - inspectable_web_contents()->AttachTo(agent_host); + managed_web_contents()->AttachTo(agent_host); break; } } diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index 677daf41854d..9ef88e570405 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -105,12 +105,6 @@ class WebContents : public mate::TrackableObject, void SetAllowTransparency(bool allow); bool IsGuest() const; - // Returns the current InspectableWebContents object, nullptr will be returned - // if current WebContents can not beinspected, e.g. it is the devtools. - brightray::InspectableWebContents* inspectable_web_contents() const { - return inspectable_web_contents_; - } - protected: explicit WebContents(content::WebContents* web_contents); explicit WebContents(const mate::Dictionary& options); @@ -217,10 +211,6 @@ class WebContents : public mate::TrackableObject, // The type of current WebContents. Type type_; - // Current InspectableWebContents object, can be nullptr for WebContents of - // devtools. It is a weak reference. - brightray::InspectableWebContents* inspectable_web_contents_; - DISALLOW_COPY_AND_ASSIGN(WebContents); }; From 9f52b11761b88d3345773dd45f4f2ed6ce98dc7a Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 25 Jun 2015 14:54:00 +0800 Subject: [PATCH 0391/1293] Remove NativeWindow::GetWebContents --- atom/browser/api/atom_api_menu_mac.mm | 4 +-- atom/browser/api/atom_api_menu_views.cc | 2 +- atom/browser/atom_browser_client.cc | 2 +- atom/browser/native_window.cc | 34 ++++++++----------------- atom/browser/native_window.h | 2 -- atom/browser/native_window_mac.mm | 21 +++++++-------- atom/browser/native_window_views.cc | 4 +-- 7 files changed, 25 insertions(+), 44 deletions(-) diff --git a/atom/browser/api/atom_api_menu_mac.mm b/atom/browser/api/atom_api_menu_mac.mm index b61d1c69a87c..071753218d6a 100644 --- a/atom/browser/api/atom_api_menu_mac.mm +++ b/atom/browser/api/atom_api_menu_mac.mm @@ -22,7 +22,7 @@ void MenuMac::Popup(Window* window) { NativeWindow* native_window = window->window(); if (!native_window) return; - content::WebContents* web_contents = native_window->GetWebContents(); + content::WebContents* web_contents = native_window->web_contents(); if (!web_contents) return; @@ -54,7 +54,7 @@ void MenuMac::PopupAt(Window* window, int x, int y) { NativeWindow* native_window = window->window(); if (!native_window) return; - content::WebContents* web_contents = native_window->GetWebContents(); + content::WebContents* web_contents = native_window->web_contents(); if (!web_contents) return; diff --git a/atom/browser/api/atom_api_menu_views.cc b/atom/browser/api/atom_api_menu_views.cc index b06a1e79cbe0..45904dd8c033 100644 --- a/atom/browser/api/atom_api_menu_views.cc +++ b/atom/browser/api/atom_api_menu_views.cc @@ -24,7 +24,7 @@ void MenuViews::PopupAt(Window* window, int x, int y) { NativeWindow* native_window = static_cast(window->window()); if (!native_window) return; - content::WebContents* web_contents = native_window->GetWebContents(); + content::WebContents* web_contents = native_window->web_contents(); if (!web_contents) return; content::RenderWidgetHostView* view = web_contents->GetRenderWidgetHostView(); diff --git a/atom/browser/atom_browser_client.cc b/atom/browser/atom_browser_client.cc index a4e2734a6886..6c29c162e4ec 100644 --- a/atom/browser/atom_browser_client.cc +++ b/atom/browser/atom_browser_client.cc @@ -63,7 +63,7 @@ ProcessOwner GetProcessOwner(int process_id, // First search for NativeWindow. for (auto native_window : *WindowList::GetInstance()) - if (web_contents == native_window->GetWebContents()) { + if (web_contents == native_window->web_contents()) { *window = native_window; return OWNER_NATIVE_WINDOW; } diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index b75bfbb5ff7b..df717c8dec98 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -153,7 +153,7 @@ NativeWindow* NativeWindow::FromWebContents( content::WebContents* web_contents) { WindowList& window_list = *WindowList::GetInstance(); for (NativeWindow* window : window_list) { - if (window->GetWebContents() == web_contents) + if (window->web_contents() == web_contents) return window; } return nullptr; @@ -268,24 +268,22 @@ bool NativeWindow::HasModalDialog() { } void NativeWindow::FocusOnWebView() { - GetWebContents()->GetRenderViewHost()->Focus(); + web_contents()->GetRenderViewHost()->Focus(); } void NativeWindow::BlurWebView() { - GetWebContents()->GetRenderViewHost()->Blur(); + web_contents()->GetRenderViewHost()->Blur(); } bool NativeWindow::IsWebViewFocused() { - RenderWidgetHostView* host_view = - GetWebContents()->GetRenderViewHost()->GetView(); + auto host_view = web_contents()->GetRenderViewHost()->GetView(); return host_view && host_view->HasFocus(); } void NativeWindow::CapturePage(const gfx::Rect& rect, const CapturePageCallback& callback) { - content::WebContents* contents = GetWebContents(); - RenderWidgetHostView* const view = contents->GetRenderWidgetHostView(); - RenderWidgetHost* const host = view ? view->GetRenderWidgetHost() : nullptr; + const auto view = web_contents()->GetRenderWidgetHostView(); + const auto host = view ? view->GetRenderWidgetHost() : nullptr; if (!view || !host) { callback.Run(SkBitmap()); return; @@ -315,13 +313,6 @@ void NativeWindow::CapturePage(const gfx::Rect& rect, kBGRA_8888_SkColorType); } -content::WebContents* NativeWindow::GetWebContents() const { - if (inspectable_web_contents_) - return inspectable_web_contents_->GetWebContents(); - else - return nullptr; -} - void NativeWindow::RequestToClosePage() { bool prevent_default = false; FOR_EACH_OBSERVER(NativeWindowObserver, @@ -332,12 +323,6 @@ void NativeWindow::RequestToClosePage() { return; } - content::WebContents* web_contents(GetWebContents()); - if (!web_contents) { - CloseImmediately(); - return; - } - // Assume the window is not responding if it doesn't cancel the close and is // not closed in 5s, in this way we can quickly show the unresponsive // dialog when the window is busy executing some script withouth waiting for @@ -345,10 +330,10 @@ void NativeWindow::RequestToClosePage() { if (window_unresposive_closure_.IsCancelled()) ScheduleUnresponsiveEvent(5000); - if (web_contents->NeedToFireBeforeUnload()) - web_contents->DispatchBeforeUnload(false); + if (web_contents()->NeedToFireBeforeUnload()) + web_contents()->DispatchBeforeUnload(false); else - web_contents->Close(); + web_contents()->Close(); } void NativeWindow::CloseContents(content::WebContents* source) { @@ -357,6 +342,7 @@ void NativeWindow::CloseContents(content::WebContents* source) { inspectable_web_contents_->GetView()->SetDelegate(nullptr); inspectable_web_contents_ = nullptr; + Observe(nullptr); // When the web contents is gone, close the window immediately, but the // memory will not be freed until you call delete. diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index db546d71b61e..4441726e3396 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -167,8 +167,6 @@ class NativeWindow : public content::WebContentsObserver, return weak_factory_.GetWeakPtr(); } - content::WebContents* GetWebContents() const; - // Requests the WebContents to close, can be cancelled by the page. virtual void RequestToClosePage(); diff --git a/atom/browser/native_window_mac.mm b/atom/browser/native_window_mac.mm index fc165665146d..c0d358bb8f72 100644 --- a/atom/browser/native_window_mac.mm +++ b/atom/browser/native_window_mac.mm @@ -68,7 +68,7 @@ static const CGFloat kAtomWindowCornerRadius = 4.0; } - (void)windowDidBecomeMain:(NSNotification*)notification { - content::WebContents* web_contents = shell_->GetWebContents(); + content::WebContents* web_contents = shell_->web_contents(); if (!web_contents) return; @@ -82,7 +82,7 @@ static const CGFloat kAtomWindowCornerRadius = 4.0; } - (void)windowDidResignMain:(NSNotification*)notification { - content::WebContents* web_contents = shell_->GetWebContents(); + content::WebContents* web_contents = shell_->web_contents(); if (!web_contents) return; @@ -677,10 +677,9 @@ void NativeWindowMac::SetOverlayIcon(const gfx::Image& overlay, } void NativeWindowMac::ShowDefinitionForSelection() { - content::WebContents* web_contents = GetWebContents(); - if (!web_contents) + if (!web_contents()) return; - content::RenderWidgetHostView* rwhv = web_contents->GetRenderWidgetHostView(); + auto rwhv = web_contents()->GetRenderWidgetHostView(); if (!rwhv) return; rwhv->ShowDefinitionForSelection(); @@ -704,10 +703,9 @@ bool NativeWindowMac::IsVisibleOnAllWorkspaces() { bool NativeWindowMac::IsWithinDraggableRegion(NSPoint point) const { if (!draggable_region_) return false; - content::WebContents* web_contents = GetWebContents(); - if (!web_contents) + if (!web_contents()) return false; - NSView* webView = web_contents->GetNativeView(); + NSView* webView = web_contents()->GetNativeView(); NSInteger webViewHeight = NSHeight([webView bounds]); // |draggable_region_| is stored in local platform-indepdent coordiate system // while |point| is in local Cocoa coordinate system. Do the conversion @@ -814,16 +812,15 @@ void NativeWindowMac::UninstallView() { } void NativeWindowMac::ClipWebView() { - content::WebContents* web_contents = GetWebContents(); - if (!web_contents) + if (!web_contents()) return; - NSView* webView = web_contents->GetNativeView(); + NSView* webView = web_contents()->GetNativeView(); webView.layer.masksToBounds = YES; webView.layer.cornerRadius = kAtomWindowCornerRadius; } void NativeWindowMac::InstallDraggableRegionView() { - NSView* webView = GetWebContents()->GetNativeView(); + NSView* webView = web_contents()->GetNativeView(); base::scoped_nsobject controlRegion( [[ControlRegionView alloc] initWithShellWindow:this]); [controlRegion setFrame:NSMakeRect(0, 0, diff --git a/atom/browser/native_window_views.cc b/atom/browser/native_window_views.cc index 42802c926356..14a890475e55 100644 --- a/atom/browser/native_window_views.cc +++ b/atom/browser/native_window_views.cc @@ -728,9 +728,9 @@ void NativeWindowViews::OnWidgetActivationChanged( else NotifyWindowBlur(); - if (active && GetWebContents() && + if (active && inspectable_web_contents() && !inspectable_web_contents()->IsDevToolsViewShowing()) - GetWebContents()->Focus(); + web_contents()->Focus(); // Hide menu bar when window is blured. if (!active && menu_bar_autohide_ && menu_bar_visible_) From c15a9e7d5c220010ab42c2bfac58c2efb3dccbb9 Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Thu, 25 Jun 2015 14:13:01 +0530 Subject: [PATCH 0392/1293] session: using storageparttion to retrieve requestcontext --- atom/browser/api/atom_api_session.cc | 54 ++++++++++++++++++++-------- 1 file changed, 40 insertions(+), 14 deletions(-) diff --git a/atom/browser/api/atom_api_session.cc b/atom/browser/api/atom_api_session.cc index 8a718b56301d..d1f21e48c4a1 100644 --- a/atom/browser/api/atom_api_session.cc +++ b/atom/browser/api/atom_api_session.cc @@ -9,6 +9,9 @@ #include "atom/browser/api/atom_api_cookies.h" #include "atom/browser/atom_browser_context.h" #include "atom/common/native_mate_converters/gurl_converter.h" +#include "base/thread_task_runner_handle.h" +#include "content/public/browser/browser_thread.h" +#include "content/public/browser/storage_partition.h" #include "native_mate/callback.h" #include "native_mate/object_template_builder.h" #include "net/base/load_flags.h" @@ -29,35 +32,58 @@ class ResolveProxyHelper { ResolveProxyHelper(AtomBrowserContext* browser_context, const GURL& url, Session::ResolveProxyCallback callback) - : callback_(callback) { - net::ProxyService* proxy_service = browser_context-> - url_request_context_getter()->GetURLRequestContext()->proxy_service(); + : callback_(callback), + original_thread_(base::ThreadTaskRunnerHandle::Get()), + weak_ptr_factory_(this) { + scoped_refptr getter = + browser_context->GetDefaultStoragePartition(browser_context) + ->GetURLRequestContext(); - // Start the request. - int result = proxy_service->ResolveProxy( - url, net::LOAD_NORMAL, &proxy_info_, - base::Bind(&ResolveProxyHelper::OnResolveProxyCompleted, - base::Unretained(this)), - &pac_req_, nullptr, net::BoundNetLog()); - - // Completed synchronously. - if (result != net::ERR_IO_PENDING) - OnResolveProxyCompleted(result); + getter->GetNetworkTaskRunner()->PostTask( + FROM_HERE, + base::Bind(&ResolveProxyHelper::ResolveProxy, + weak_ptr_factory_.GetWeakPtr(), + getter, url)); } void OnResolveProxyCompleted(int result) { std::string proxy; if (result == net::OK) proxy = proxy_info_.ToPacString(); - callback_.Run(proxy); + original_thread_->PostTask(FROM_HERE, + base::Bind(callback_, proxy)); delete this; } private: + void ResolveProxy( + scoped_refptr getter, + const GURL& url) { + DCHECK_CURRENTLY_ON(content::BrowserThread::IO); + + net::ProxyService* proxy_service = + getter->GetURLRequestContext()->proxy_service(); + + net::CompletionCallback completion_callback = + base::Bind(&ResolveProxyHelper::OnResolveProxyCompleted, + weak_ptr_factory_.GetWeakPtr()); + + // Start the request. + int result = proxy_service->ResolveProxy( + url, net::LOAD_NORMAL, &proxy_info_, completion_callback, + &pac_req_, nullptr, net::BoundNetLog()); + + // Completed synchronously. + if (result != net::ERR_IO_PENDING) + completion_callback.Run(result); + } + Session::ResolveProxyCallback callback_; net::ProxyInfo proxy_info_; net::ProxyService::PacRequest* pac_req_; + scoped_refptr original_thread_; + base::WeakPtrFactory weak_ptr_factory_; DISALLOW_COPY_AND_ASSIGN(ResolveProxyHelper); }; From 0fbd908fb6557b4bb3388cc876af0c2a96fc0e43 Mon Sep 17 00:00:00 2001 From: deepak1556 Date: Thu, 11 Jun 2015 20:52:07 +0530 Subject: [PATCH 0393/1293] app: event to pass client certificate data --- atom/browser/api/atom_api_app.cc | 62 +++++++++++++++++++++++++++++ atom/browser/api/atom_api_app.h | 4 ++ atom/browser/atom_browser_client.cc | 13 +++--- atom/browser/browser.cc | 13 ++++++ atom/browser/browser.h | 6 +++ atom/browser/browser_observer.h | 17 ++++++++ docs/api/app.md | 24 +++++++++++ 7 files changed, 132 insertions(+), 7 deletions(-) diff --git a/atom/browser/api/atom_api_app.cc b/atom/browser/api/atom_api_app.cc index 473111dbc7e1..036c61b407fd 100644 --- a/atom/browser/api/atom_api_app.cc +++ b/atom/browser/api/atom_api_app.cc @@ -16,15 +16,18 @@ #include "atom/browser/atom_browser_context.h" #include "atom/browser/atom_browser_main_parts.h" #include "atom/browser/browser.h" +#include "atom/browser/api/atom_api_web_contents.h" #include "atom/common/native_mate_converters/file_path_converter.h" #include "base/command_line.h" #include "base/environment.h" #include "base/files/file_path.h" #include "base/path_service.h" #include "brightray/browser/brightray_paths.h" +#include "content/public/browser/client_certificate_delegate.h" #include "native_mate/callback.h" #include "native_mate/dictionary.h" #include "native_mate/object_template_builder.h" +#include "net/ssl/ssl_cert_request_info.h" #if defined(OS_WIN) #include "base/strings/utf_string_conversions.h" @@ -57,6 +60,21 @@ struct Converter { }; #endif +template<> +struct Converter> { + static v8::Local ToV8( + v8::Isolate* isolate, + const scoped_refptr& val) { + mate::Dictionary dict(isolate, v8::Object::New(isolate)); + std::string encoded_data; + net::X509Certificate::GetPEMEncoded( + val->os_cert_handle(), &encoded_data); + dict.Set("data", encoded_data); + dict.Set("issuerName", val->issuer().GetDisplayName()); + return dict.GetHandle(); + } +}; + } // namespace mate @@ -90,6 +108,29 @@ int GetPathConstant(const std::string& name) { return -1; } +void OnClientCertificateSelected( + v8::Isolate* isolate, + std::shared_ptr delegate, + mate::Arguments* args) { + v8::Locker locker(isolate); + v8::HandleScope handle_scope(isolate); + mate::Dictionary cert_data; + if (!(args->Length() == 1 && args->GetNext(&cert_data))) { + args->ThrowError(); + return; + } + + std::string encoded_data; + cert_data.Get("data", &encoded_data); + + auto certs = + net::X509Certificate::CreateCertificateListFromBytes( + encoded_data.data(), encoded_data.size(), + net::X509Certificate::FORMAT_AUTO); + + delegate->ContinueWithCertificate(certs[0].get()); +} + } // namespace App::App() { @@ -144,6 +185,27 @@ void App::OnFinishLaunching() { Emit("ready"); } +void App::OnSelectCertificate( + content::WebContents* web_contents, + net::SSLCertRequestInfo* cert_request_info, + scoped_ptr delegate) { + std::shared_ptr + shared_delegate(delegate.release()); + bool prevent_default = + Emit("select-certificate", + api::WebContents::CreateFrom(isolate(), web_contents), + cert_request_info->host_and_port.ToString(), + cert_request_info->client_certs, + base::Bind(&OnClientCertificateSelected, + isolate(), + shared_delegate)); + + // Default to first certificate from the platform store. + if (!prevent_default) + shared_delegate->ContinueWithCertificate( + cert_request_info->client_certs[0].get()); +} + base::FilePath App::GetPath(mate::Arguments* args, const std::string& name) { bool succeed = false; base::FilePath path; diff --git a/atom/browser/api/atom_api_app.h b/atom/browser/api/atom_api_app.h index f3041757669f..97489917dc26 100644 --- a/atom/browser/api/atom_api_app.h +++ b/atom/browser/api/atom_api_app.h @@ -42,6 +42,10 @@ class App : public mate::EventEmitter, void OnActivateWithNoOpenWindows() override; void OnWillFinishLaunching() override; void OnFinishLaunching() override; + void OnSelectCertificate( + content::WebContents* web_contents, + net::SSLCertRequestInfo* cert_request_info, + scoped_ptr delegate) override; // mate::Wrappable: mate::ObjectTemplateBuilder GetObjectTemplateBuilder( diff --git a/atom/browser/atom_browser_client.cc b/atom/browser/atom_browser_client.cc index 6c29c162e4ec..85e19cf234e2 100644 --- a/atom/browser/atom_browser_client.cc +++ b/atom/browser/atom_browser_client.cc @@ -9,6 +9,7 @@ #include "atom/browser/atom_browser_main_parts.h" #include "atom/browser/atom_quota_permission_context.h" #include "atom/browser/atom_speech_recognition_manager_delegate.h" +#include "atom/browser/browser.h" #include "atom/browser/native_window.h" #include "atom/browser/web_view_manager.h" #include "atom/browser/window_list.h" @@ -231,15 +232,13 @@ void AtomBrowserClient::SelectClientCertificate( auto cert_path = command_line->GetSwitchValueNative( switches::kClientCertificate); - // TODO(zcbenz): allow users to select certificate from - // client_cert list. Right now defaults to first certificate - // in the list. scoped_refptr certificate; - if (cert_path.empty()) { - if (!cert_request_info->client_certs.empty()) - certificate = cert_request_info->client_certs[0]; - } else { + if (!cert_path.empty()) { certificate = ImportCertFromFile(base::FilePath(cert_path)); + } else if (!cert_request_info->client_certs.empty()) { + Browser::Get()->ClientCertificateSelector(web_contents, + cert_request_info, + delegate.Pass()); } if (certificate.get()) diff --git a/atom/browser/browser.cc b/atom/browser/browser.cc index 123cfc4f9844..1ca682de15bb 100644 --- a/atom/browser/browser.cc +++ b/atom/browser/browser.cc @@ -9,6 +9,8 @@ #include "atom/browser/atom_browser_main_parts.h" #include "atom/browser/window_list.h" #include "base/message_loop/message_loop.h" +#include "content/public/browser/client_certificate_delegate.h" +#include "net/ssl/ssl_cert_request_info.h" namespace atom { @@ -104,6 +106,17 @@ void Browser::DidFinishLaunching() { FOR_EACH_OBSERVER(BrowserObserver, observers_, OnFinishLaunching()); } +void Browser::ClientCertificateSelector( + content::WebContents* web_contents, + net::SSLCertRequestInfo* cert_request_info, + scoped_ptr delegate) { + FOR_EACH_OBSERVER(BrowserObserver, + observers_, + OnSelectCertificate(web_contents, + cert_request_info, + delegate.Pass())); +} + void Browser::NotifyAndShutdown() { bool prevent_default = false; FOR_EACH_OBSERVER(BrowserObserver, observers_, OnWillQuit(&prevent_default)); diff --git a/atom/browser/browser.h b/atom/browser/browser.h index 8648d8853384..3e93c84b077f 100644 --- a/atom/browser/browser.h +++ b/atom/browser/browser.h @@ -115,6 +115,12 @@ class Browser : public WindowListObserver { void WillFinishLaunching(); void DidFinishLaunching(); + // Called when client certificate is required. + void ClientCertificateSelector( + content::WebContents* web_contents, + net::SSLCertRequestInfo* cert_request_info, + scoped_ptr delegate); + void AddObserver(BrowserObserver* obs) { observers_.AddObserver(obs); } diff --git a/atom/browser/browser_observer.h b/atom/browser/browser_observer.h index 4f9f436712d4..19f4bd85c1db 100644 --- a/atom/browser/browser_observer.h +++ b/atom/browser/browser_observer.h @@ -7,6 +7,17 @@ #include +#include "base/memory/scoped_ptr.h" + +namespace content { +class ClientCertificateDelegate; +class WebContents; +} + +namespace net { +class SSLCertRequestInfo; +} + namespace atom { class BrowserObserver { @@ -40,6 +51,12 @@ class BrowserObserver { virtual void OnWillFinishLaunching() {} virtual void OnFinishLaunching() {} + // The browser requires client certificate. + virtual void OnSelectCertificate( + content::WebContents* web_contents, + net::SSLCertRequestInfo* cert_request_info, + scoped_ptr delegate) {} + protected: virtual ~BrowserObserver() {} }; diff --git a/docs/api/app.md b/docs/api/app.md index 1564196ce810..d1b219cc15bd 100644 --- a/docs/api/app.md +++ b/docs/api/app.md @@ -101,6 +101,30 @@ Emitted when a [browserWindow](browser-window.md) gets blurred. Emitted when a [browserWindow](browser-window.md) gets focused. +### Event: 'select-certificate' + +Emitted when client certificate is requested. + +* `event` Event +* `webContents` [WebContents](browser-window.md#class-webcontents) +* `url` String +* `certificateList` [Objects] + * `data` PEM encoded data + * `issuerName` Issuer's Common Name +* `callback` Function + +``` +app.on('select-certificate', function(event, host, url, list, callback) { + event.preventDefault(); + callback(list[0]); +}) +``` + +`url` corresponds to the navigation entry requesting the client certificate, +`callback` needs to be called with an entry filtered from the list. +`event.preventDefault()` prevents from using the first certificate from +the store. + ## app.quit() Try to close all windows. The `before-quit` event will first be emitted. If all From d98cece115062cffdfc82c4bb9b764a9b3d05f8d Mon Sep 17 00:00:00 2001 From: Paul Betts Date: Wed, 17 Jun 2015 17:15:02 -0700 Subject: [PATCH 0394/1293] Create a new method for NativeWindowObserver for AppCommands --- atom/browser/native_window_observer.h | 3 +++ 1 file changed, 3 insertions(+) diff --git a/atom/browser/native_window_observer.h b/atom/browser/native_window_observer.h index 335a63149953..bfb3342cf22a 100644 --- a/atom/browser/native_window_observer.h +++ b/atom/browser/native_window_observer.h @@ -65,6 +65,9 @@ class NativeWindowObserver { // Called when renderer recovers. virtual void OnRendererResponsive() {} + + // Called on Windows when App Commands arrive (WM_APPCOMMAND) + virtual void OnExecuteWindowsCommand(int command) {} }; } // namespace atom From 37d18d512b1289bbea6cc61ab89938b9a28b4fff Mon Sep 17 00:00:00 2001 From: Paul Betts Date: Wed, 17 Jun 2015 17:15:52 -0700 Subject: [PATCH 0395/1293] Create a method to signal our Observer method --- atom/browser/native_window.cc | 5 +++++ atom/browser/native_window.h | 1 + 2 files changed, 6 insertions(+) diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index df717c8dec98..b49f2978ed2b 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -580,6 +580,11 @@ void NativeWindow::NotifyWindowUnresponsive() { OnRendererUnresponsive()); } +void NativeWindow::NotifyExecuteWindowsCommand(int command_id) { + FOR_EACH_OBSERVER(NativeWindowObserver, observers_, OnExecuteWindowsCommand(command_id)); +} + + void NativeWindow::OnCapturePageDone(const CapturePageCallback& callback, const SkBitmap& bitmap, content::ReadbackResponse response) { diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index 4441726e3396..4f302f832092 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -198,6 +198,7 @@ class NativeWindow : public content::WebContentsObserver, void NotifyWindowLeaveFullScreen(); void NotifyWindowEnterHtmlFullScreen(); void NotifyWindowLeaveHtmlFullScreen(); + void NotifyExecuteWindowsCommand(int command_id); void AddObserver(NativeWindowObserver* obs) { observers_.AddObserver(obs); From 794f89abf5a31dd5cb637b918b320e149e889af7 Mon Sep 17 00:00:00 2001 From: Paul Betts Date: Wed, 17 Jun 2015 17:16:08 -0700 Subject: [PATCH 0396/1293] In our widget delegate, signal our Observer --- atom/browser/native_window_views.cc | 3 +++ 1 file changed, 3 insertions(+) diff --git a/atom/browser/native_window_views.cc b/atom/browser/native_window_views.cc index 14a890475e55..f03ec73a1d78 100644 --- a/atom/browser/native_window_views.cc +++ b/atom/browser/native_window_views.cc @@ -855,7 +855,10 @@ bool NativeWindowViews::ExecuteWindowsCommand(int command_id) { is_minimized_ = false; } else if ((command_id & sc_mask) == SC_MAXIMIZE) { NotifyWindowMaximize(); + } else { + NotifyExecuteWindowsCommand(command_id & sc_mask); } + return false; } #endif From cec6895e679755b7b3bba39e17130dec421dc2de Mon Sep 17 00:00:00 2001 From: Paul Betts Date: Wed, 17 Jun 2015 17:31:50 -0700 Subject: [PATCH 0397/1293] Emit the message as an event --- atom/browser/api/atom_api_window.cc | 4 ++++ atom/browser/api/atom_api_window.h | 1 + 2 files changed, 5 insertions(+) diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index 2dae7f8617f5..3f960ad8c211 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -162,6 +162,10 @@ void Window::OnDevToolsClosed() { devtools_web_contents_.Reset(); } +void Window::OnExecuteWindowsCommand(int command_id) { + Emit("app-command", command_id); +} + // static mate::Wrappable* Window::New(v8::Isolate* isolate, const mate::Dictionary& options) { diff --git a/atom/browser/api/atom_api_window.h b/atom/browser/api/atom_api_window.h index 41383ea3e0ff..604b477cd1d2 100644 --- a/atom/browser/api/atom_api_window.h +++ b/atom/browser/api/atom_api_window.h @@ -71,6 +71,7 @@ class Window : public mate::TrackableObject, void OnDevToolsFocus() override; void OnDevToolsOpened() override; void OnDevToolsClosed() override; + void OnExecuteWindowsCommand(int command_id) override; private: // APIs for NativeWindow. From c2290ad058a606b09d566ba4fa72adabce7cebf2 Mon Sep 17 00:00:00 2001 From: Paul Betts Date: Fri, 19 Jun 2015 12:16:12 -0700 Subject: [PATCH 0398/1293] Add enum for media keys on Win32 --- atom/browser/api/lib/app-command.coffee | 55 +++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 atom/browser/api/lib/app-command.coffee diff --git a/atom/browser/api/lib/app-command.coffee b/atom/browser/api/lib/app-command.coffee new file mode 100644 index 000000000000..ad45bd713869 --- /dev/null +++ b/atom/browser/api/lib/app-command.coffee @@ -0,0 +1,55 @@ +module.exports = + APPCOMMAND_BROWSER_BACKWARD: 1 + APPCOMMAND_BROWSER_FORWARD: 2 + APPCOMMAND_BROWSER_REFRESH: 3 + APPCOMMAND_BROWSER_STOP: 4 + APPCOMMAND_BROWSER_SEARCH: 5 + APPCOMMAND_BROWSER_FAVORITES: 6 + APPCOMMAND_BROWSER_HOME: 7 + APPCOMMAND_VOLUME_MUTE: 8 + APPCOMMAND_VOLUME_DOWN: 9 + APPCOMMAND_VOLUME_UP: 10 + APPCOMMAND_MEDIA_NEXTTRACK: 11 + APPCOMMAND_MEDIA_PREVIOUSTRACK: 12 + APPCOMMAND_MEDIA_STOP: 13 + APPCOMMAND_MEDIA_PLAY_PAUSE: 14 + APPCOMMAND_LAUNCH_MAIL: 15 + APPCOMMAND_LAUNCH_MEDIA_SELECT: 16 + APPCOMMAND_LAUNCH_APP1: 17 + APPCOMMAND_LAUNCH_APP2: 18 + APPCOMMAND_BASS_DOWN: 19 + APPCOMMAND_BASS_BOOST: 20 + APPCOMMAND_BASS_UP: 21 + APPCOMMAND_TREBLE_DOWN: 22 + APPCOMMAND_TREBLE_UP: 23 + APPCOMMAND_MICROPHONE_VOLUME_MUTE: 24 + APPCOMMAND_MICROPHONE_VOLUME_DOWN: 25 + APPCOMMAND_MICROPHONE_VOLUME_UP: 26 + APPCOMMAND_HELP: 27 + APPCOMMAND_FIND: 28 + APPCOMMAND_NEW: 29 + APPCOMMAND_OPEN: 30 + APPCOMMAND_CLOSE: 31 + APPCOMMAND_SAVE: 32 + APPCOMMAND_PRINT: 33 + APPCOMMAND_UNDO: 34 + APPCOMMAND_REDO: 35 + APPCOMMAND_COPY: 36 + APPCOMMAND_CUT: 37 + APPCOMMAND_PASTE: 38 + APPCOMMAND_REPLY_TO_MAIL: 39 + APPCOMMAND_FORWARD_MAIL: 40 + APPCOMMAND_SEND_MAIL: 41 + APPCOMMAND_SPELL_CHECK: 42 + APPCOMMAND_DICTATE_OR_COMMAND_CONTROL_TOGGLE:43 + APPCOMMAND_MIC_ON_OFF_TOGGLE: 44 + APPCOMMAND_CORRECTION_LIST: 45 + APPCOMMAND_MEDIA_PLAY: 46 + APPCOMMAND_MEDIA_PAUSE: 47 + APPCOMMAND_MEDIA_RECORD: 48 + APPCOMMAND_MEDIA_FAST_FORWARD: 49 + APPCOMMAND_MEDIA_REWIND: 50 + APPCOMMAND_MEDIA_CHANNEL_UP: 51 + APPCOMMAND_MEDIA_CHANNEL_DOWN: 52 + APPCOMMAND_DELETE: 53 + APPCOMMAND_DWM_FLIP3D: 54 From 55a8862374231edfee1eeb8836a9e5f8a0abc4c1 Mon Sep 17 00:00:00 2001 From: Paul Betts Date: Fri, 19 Jun 2015 12:48:02 -0700 Subject: [PATCH 0399/1293] Add appcommand to files --- filenames.gypi | 1 + 1 file changed, 1 insertion(+) diff --git a/filenames.gypi b/filenames.gypi index 562e65280d59..98ea65442a88 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -9,6 +9,7 @@ ], 'coffee_sources': [ 'atom/browser/api/lib/app.coffee', + 'atom/browser/api/lib/app-command.coffee', 'atom/browser/api/lib/atom-delegate.coffee', 'atom/browser/api/lib/auto-updater.coffee', 'atom/browser/api/lib/browser-window.coffee', From b98154431c336618532629a6bf713cc500da18b5 Mon Sep 17 00:00:00 2001 From: Paul Betts Date: Fri, 19 Jun 2015 12:58:47 -0700 Subject: [PATCH 0400/1293] :memo: app commands --- docs/api/browser-window.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index b9c78b940ab3..31e7ca536650 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -219,6 +219,23 @@ Emitted when devtools is closed. Emitted when devtools is focused / opened. +### Event: 'app-command' (Windows): + +Emitted when an [App Command](https://msdn.microsoft.com/en-us/library/windows/desktop/ms646275(v=vs.85).aspx) is invoked. These are typically related to keyboard media keys or browser commands, as well as the "Back" button built into some mice on Windows. + + +```js +AppCommands = require('app-command'); + +someWindow.on('app-command', function(e, cmd) => { + // Navigate the window back when the user hits their mouse back button + if (cmd === AppCommands.APPCOMMAND_BROWSER_BACKWARD && + someWindow.webContents.canGoBack()) { + someWindow.webContents.goBack(); + } +}); +``` + ### Class Method: BrowserWindow.getAllWindows() Returns an array of all opened browser windows. From 1509aca78878f1a736361fedfc79277da67a47e8 Mon Sep 17 00:00:00 2001 From: Paul Betts Date: Fri, 19 Jun 2015 13:00:37 -0700 Subject: [PATCH 0401/1293] Invisible character tyranny --- atom/browser/api/lib/app-command.coffee | 108 ++++++++++++------------ 1 file changed, 54 insertions(+), 54 deletions(-) diff --git a/atom/browser/api/lib/app-command.coffee b/atom/browser/api/lib/app-command.coffee index ad45bd713869..94455dd150f4 100644 --- a/atom/browser/api/lib/app-command.coffee +++ b/atom/browser/api/lib/app-command.coffee @@ -1,55 +1,55 @@ module.exports = - APPCOMMAND_BROWSER_BACKWARD: 1 - APPCOMMAND_BROWSER_FORWARD: 2 - APPCOMMAND_BROWSER_REFRESH: 3 - APPCOMMAND_BROWSER_STOP: 4 - APPCOMMAND_BROWSER_SEARCH: 5 - APPCOMMAND_BROWSER_FAVORITES: 6 - APPCOMMAND_BROWSER_HOME: 7 - APPCOMMAND_VOLUME_MUTE: 8 - APPCOMMAND_VOLUME_DOWN: 9 - APPCOMMAND_VOLUME_UP: 10 - APPCOMMAND_MEDIA_NEXTTRACK: 11 - APPCOMMAND_MEDIA_PREVIOUSTRACK: 12 - APPCOMMAND_MEDIA_STOP: 13 - APPCOMMAND_MEDIA_PLAY_PAUSE: 14 - APPCOMMAND_LAUNCH_MAIL: 15 - APPCOMMAND_LAUNCH_MEDIA_SELECT: 16 - APPCOMMAND_LAUNCH_APP1: 17 - APPCOMMAND_LAUNCH_APP2: 18 - APPCOMMAND_BASS_DOWN: 19 - APPCOMMAND_BASS_BOOST: 20 - APPCOMMAND_BASS_UP: 21 - APPCOMMAND_TREBLE_DOWN: 22 - APPCOMMAND_TREBLE_UP: 23 - APPCOMMAND_MICROPHONE_VOLUME_MUTE: 24 - APPCOMMAND_MICROPHONE_VOLUME_DOWN: 25 - APPCOMMAND_MICROPHONE_VOLUME_UP: 26 - APPCOMMAND_HELP: 27 - APPCOMMAND_FIND: 28 - APPCOMMAND_NEW: 29 - APPCOMMAND_OPEN: 30 - APPCOMMAND_CLOSE: 31 - APPCOMMAND_SAVE: 32 - APPCOMMAND_PRINT: 33 - APPCOMMAND_UNDO: 34 - APPCOMMAND_REDO: 35 - APPCOMMAND_COPY: 36 - APPCOMMAND_CUT: 37 - APPCOMMAND_PASTE: 38 - APPCOMMAND_REPLY_TO_MAIL: 39 - APPCOMMAND_FORWARD_MAIL: 40 - APPCOMMAND_SEND_MAIL: 41 - APPCOMMAND_SPELL_CHECK: 42 - APPCOMMAND_DICTATE_OR_COMMAND_CONTROL_TOGGLE:43 - APPCOMMAND_MIC_ON_OFF_TOGGLE: 44 - APPCOMMAND_CORRECTION_LIST: 45 - APPCOMMAND_MEDIA_PLAY: 46 - APPCOMMAND_MEDIA_PAUSE: 47 - APPCOMMAND_MEDIA_RECORD: 48 - APPCOMMAND_MEDIA_FAST_FORWARD: 49 - APPCOMMAND_MEDIA_REWIND: 50 - APPCOMMAND_MEDIA_CHANNEL_UP: 51 - APPCOMMAND_MEDIA_CHANNEL_DOWN: 52 - APPCOMMAND_DELETE: 53 - APPCOMMAND_DWM_FLIP3D: 54 + APPCOMMAND_BROWSER_BACKWARD: 1 + APPCOMMAND_BROWSER_FORWARD: 2 + APPCOMMAND_BROWSER_REFRESH: 3 + APPCOMMAND_BROWSER_STOP: 4 + APPCOMMAND_BROWSER_SEARCH: 5 + APPCOMMAND_BROWSER_FAVORITES: 6 + APPCOMMAND_BROWSER_HOME: 7 + APPCOMMAND_VOLUME_MUTE: 8 + APPCOMMAND_VOLUME_DOWN: 9 + APPCOMMAND_VOLUME_UP: 10 + APPCOMMAND_MEDIA_NEXTTRACK: 11 + APPCOMMAND_MEDIA_PREVIOUSTRACK: 12 + APPCOMMAND_MEDIA_STOP: 13 + APPCOMMAND_MEDIA_PLAY_PAUSE: 14 + APPCOMMAND_LAUNCH_MAIL: 15 + APPCOMMAND_LAUNCH_MEDIA_SELECT: 16 + APPCOMMAND_LAUNCH_APP1: 17 + APPCOMMAND_LAUNCH_APP2: 18 + APPCOMMAND_BASS_DOWN: 19 + APPCOMMAND_BASS_BOOST: 20 + APPCOMMAND_BASS_UP: 21 + APPCOMMAND_TREBLE_DOWN: 22 + APPCOMMAND_TREBLE_UP: 23 + APPCOMMAND_MICROPHONE_VOLUME_MUTE: 24 + APPCOMMAND_MICROPHONE_VOLUME_DOWN: 25 + APPCOMMAND_MICROPHONE_VOLUME_UP: 26 + APPCOMMAND_HELP: 27 + APPCOMMAND_FIND: 28 + APPCOMMAND_NEW: 29 + APPCOMMAND_OPEN: 30 + APPCOMMAND_CLOSE: 31 + APPCOMMAND_SAVE: 32 + APPCOMMAND_PRINT: 33 + APPCOMMAND_UNDO: 34 + APPCOMMAND_REDO: 35 + APPCOMMAND_COPY: 36 + APPCOMMAND_CUT: 37 + APPCOMMAND_PASTE: 38 + APPCOMMAND_REPLY_TO_MAIL: 39 + APPCOMMAND_FORWARD_MAIL: 40 + APPCOMMAND_SEND_MAIL: 41 + APPCOMMAND_SPELL_CHECK: 42 + APPCOMMAND_DICTATE_OR_COMMAND_CONTROL_TOGGLE:43 + APPCOMMAND_MIC_ON_OFF_TOGGLE: 44 + APPCOMMAND_CORRECTION_LIST: 45 + APPCOMMAND_MEDIA_PLAY: 46 + APPCOMMAND_MEDIA_PAUSE: 47 + APPCOMMAND_MEDIA_RECORD: 48 + APPCOMMAND_MEDIA_FAST_FORWARD: 49 + APPCOMMAND_MEDIA_REWIND: 50 + APPCOMMAND_MEDIA_CHANNEL_UP: 51 + APPCOMMAND_MEDIA_CHANNEL_DOWN: 52 + APPCOMMAND_DELETE: 53 + APPCOMMAND_DWM_FLIP3D: 54 From 210417b4282361e0e12e2dcd1be472927d70e9e0 Mon Sep 17 00:00:00 2001 From: Paul Betts Date: Fri, 19 Jun 2015 13:04:28 -0700 Subject: [PATCH 0402/1293] cpplint see me rollin', he hatin' --- atom/browser/native_window.cc | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index b49f2978ed2b..47231e435d64 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -581,7 +581,9 @@ void NativeWindow::NotifyWindowUnresponsive() { } void NativeWindow::NotifyExecuteWindowsCommand(int command_id) { - FOR_EACH_OBSERVER(NativeWindowObserver, observers_, OnExecuteWindowsCommand(command_id)); + FOR_EACH_OBSERVER(NativeWindowObserver, + observers_, + OnExecuteWindowsCommand(command_id)); } From cde7c6a4ef92b18a54779f3d0354e21370bfde71 Mon Sep 17 00:00:00 2001 From: Paul Betts Date: Thu, 25 Jun 2015 11:25:55 -0500 Subject: [PATCH 0403/1293] Move app commands to strings --- atom/browser/api/atom_api_window.cc | 4 +- atom/browser/api/atom_api_window.h | 2 +- atom/browser/api/lib/app-command.coffee | 55 ----------- atom/browser/native_window.cc | 117 +++++++++++++++++++++++- atom/browser/native_window.h | 3 + atom/browser/native_window_observer.h | 2 +- filenames.gypi | 1 - vendor/brightray | 2 +- vendor/native_mate | 2 +- 9 files changed, 125 insertions(+), 63 deletions(-) delete mode 100644 atom/browser/api/lib/app-command.coffee diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index 3f960ad8c211..be615c9ad111 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -162,8 +162,8 @@ void Window::OnDevToolsClosed() { devtools_web_contents_.Reset(); } -void Window::OnExecuteWindowsCommand(int command_id) { - Emit("app-command", command_id); +void Window::OnExecuteWindowsCommand(std::string& command_name) { + Emit("app-command", command_name); } // static diff --git a/atom/browser/api/atom_api_window.h b/atom/browser/api/atom_api_window.h index 604b477cd1d2..248abf6f4300 100644 --- a/atom/browser/api/atom_api_window.h +++ b/atom/browser/api/atom_api_window.h @@ -71,7 +71,7 @@ class Window : public mate::TrackableObject, void OnDevToolsFocus() override; void OnDevToolsOpened() override; void OnDevToolsClosed() override; - void OnExecuteWindowsCommand(int command_id) override; + void OnExecuteWindowsCommand(std::string& command_name) override; private: // APIs for NativeWindow. diff --git a/atom/browser/api/lib/app-command.coffee b/atom/browser/api/lib/app-command.coffee deleted file mode 100644 index 94455dd150f4..000000000000 --- a/atom/browser/api/lib/app-command.coffee +++ /dev/null @@ -1,55 +0,0 @@ -module.exports = - APPCOMMAND_BROWSER_BACKWARD: 1 - APPCOMMAND_BROWSER_FORWARD: 2 - APPCOMMAND_BROWSER_REFRESH: 3 - APPCOMMAND_BROWSER_STOP: 4 - APPCOMMAND_BROWSER_SEARCH: 5 - APPCOMMAND_BROWSER_FAVORITES: 6 - APPCOMMAND_BROWSER_HOME: 7 - APPCOMMAND_VOLUME_MUTE: 8 - APPCOMMAND_VOLUME_DOWN: 9 - APPCOMMAND_VOLUME_UP: 10 - APPCOMMAND_MEDIA_NEXTTRACK: 11 - APPCOMMAND_MEDIA_PREVIOUSTRACK: 12 - APPCOMMAND_MEDIA_STOP: 13 - APPCOMMAND_MEDIA_PLAY_PAUSE: 14 - APPCOMMAND_LAUNCH_MAIL: 15 - APPCOMMAND_LAUNCH_MEDIA_SELECT: 16 - APPCOMMAND_LAUNCH_APP1: 17 - APPCOMMAND_LAUNCH_APP2: 18 - APPCOMMAND_BASS_DOWN: 19 - APPCOMMAND_BASS_BOOST: 20 - APPCOMMAND_BASS_UP: 21 - APPCOMMAND_TREBLE_DOWN: 22 - APPCOMMAND_TREBLE_UP: 23 - APPCOMMAND_MICROPHONE_VOLUME_MUTE: 24 - APPCOMMAND_MICROPHONE_VOLUME_DOWN: 25 - APPCOMMAND_MICROPHONE_VOLUME_UP: 26 - APPCOMMAND_HELP: 27 - APPCOMMAND_FIND: 28 - APPCOMMAND_NEW: 29 - APPCOMMAND_OPEN: 30 - APPCOMMAND_CLOSE: 31 - APPCOMMAND_SAVE: 32 - APPCOMMAND_PRINT: 33 - APPCOMMAND_UNDO: 34 - APPCOMMAND_REDO: 35 - APPCOMMAND_COPY: 36 - APPCOMMAND_CUT: 37 - APPCOMMAND_PASTE: 38 - APPCOMMAND_REPLY_TO_MAIL: 39 - APPCOMMAND_FORWARD_MAIL: 40 - APPCOMMAND_SEND_MAIL: 41 - APPCOMMAND_SPELL_CHECK: 42 - APPCOMMAND_DICTATE_OR_COMMAND_CONTROL_TOGGLE:43 - APPCOMMAND_MIC_ON_OFF_TOGGLE: 44 - APPCOMMAND_CORRECTION_LIST: 45 - APPCOMMAND_MEDIA_PLAY: 46 - APPCOMMAND_MEDIA_PAUSE: 47 - APPCOMMAND_MEDIA_RECORD: 48 - APPCOMMAND_MEDIA_FAST_FORWARD: 49 - APPCOMMAND_MEDIA_REWIND: 50 - APPCOMMAND_MEDIA_CHANNEL_UP: 51 - APPCOMMAND_MEDIA_CHANNEL_DOWN: 52 - APPCOMMAND_DELETE: 53 - APPCOMMAND_DWM_FLIP3D: 54 diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 47231e435d64..308a4842d139 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -581,9 +581,11 @@ void NativeWindow::NotifyWindowUnresponsive() { } void NativeWindow::NotifyExecuteWindowsCommand(int command_id) { + std::string command = AppCommandToString(command_id); + FOR_EACH_OBSERVER(NativeWindowObserver, observers_, - OnExecuteWindowsCommand(command_id)); + OnExecuteWindowsCommand(command)); } @@ -593,4 +595,117 @@ void NativeWindow::OnCapturePageDone(const CapturePageCallback& callback, callback.Run(bitmap); } +const char* NativeWindow::AppCommandToString(int command_id) { + switch(command_id) { + case APPCOMMAND_BROWSER_BACKWARD: + return "browser-backward"; + case APPCOMMAND_BROWSER_FORWARD: + return "browser-forward"; + case APPCOMMAND_BROWSER_REFRESH: + return "browser-refresh"; + case APPCOMMAND_BROWSER_STOP: + return "browser-stop"; + case APPCOMMAND_BROWSER_SEARCH: + return "browser-search"; + case APPCOMMAND_BROWSER_FAVORITES: + return "browser-favorites"; + case APPCOMMAND_BROWSER_HOME: + return "browser-home"; + case APPCOMMAND_VOLUME_MUTE: + return "volume-mute"; + case APPCOMMAND_VOLUME_DOWN: + return "volume-down"; + case APPCOMMAND_VOLUME_UP: + return "volume-up"; + case APPCOMMAND_MEDIA_NEXTTRACK: + return "media-nexttrack"; + case APPCOMMAND_MEDIA_PREVIOUSTRACK: + return "media-previoustrack"; + case APPCOMMAND_MEDIA_STOP: + return "media-stop"; + case APPCOMMAND_MEDIA_PLAY_PAUSE: + return "media-play_pause"; + case APPCOMMAND_LAUNCH_MAIL: + return "launch-mail"; + case APPCOMMAND_LAUNCH_MEDIA_SELECT: + return "launch-media-select"; + case APPCOMMAND_LAUNCH_APP1: + return "launch-app1"; + case APPCOMMAND_LAUNCH_APP2: + return "launch-app2"; + case APPCOMMAND_BASS_DOWN: + return "bass-down"; + case APPCOMMAND_BASS_BOOST: + return "bass-boost"; + case APPCOMMAND_BASS_UP: + return "bass-up"; + case APPCOMMAND_TREBLE_DOWN: + return "treble-down"; + case APPCOMMAND_TREBLE_UP: + return "treble-up"; + case APPCOMMAND_MICROPHONE_VOLUME_MUTE: + return "microphone-volume-mute"; + case APPCOMMAND_MICROPHONE_VOLUME_DOWN: + return "microphone-volume-down"; + case APPCOMMAND_MICROPHONE_VOLUME_UP: + return "microphone-volume-up"; + case APPCOMMAND_HELP: + return "help"; + case APPCOMMAND_FIND: + return "find"; + case APPCOMMAND_NEW: + return "new"; + case APPCOMMAND_OPEN: + return "open"; + case APPCOMMAND_CLOSE: + return "close"; + case APPCOMMAND_SAVE: + return "save"; + case APPCOMMAND_PRINT: + return "print"; + case APPCOMMAND_UNDO: + return "undo"; + case APPCOMMAND_REDO: + return "redo"; + case APPCOMMAND_COPY: + return "copy"; + case APPCOMMAND_CUT: + return "cut"; + case APPCOMMAND_PASTE: + return "paste"; + case APPCOMMAND_REPLY_TO_MAIL: + return "reply-to-mail"; + case APPCOMMAND_FORWARD_MAIL: + return "forward-mail"; + case APPCOMMAND_SEND_MAIL: + return "send-mail"; + case APPCOMMAND_SPELL_CHECK: + return "spell-check"; + case APPCOMMAND_DICTATE_OR_COMMAND_CONTROL_TOGGLE: + return "dictate-or-command-control-toggle"; + case APPCOMMAND_MIC_ON_OFF_TOGGLE: + return "mic-on-off-toggle"; + case APPCOMMAND_CORRECTION_LIST: + return "correction-list"; + case APPCOMMAND_MEDIA_PLAY: + return "media-play"; + case APPCOMMAND_MEDIA_PAUSE: + return "media-pause"; + case APPCOMMAND_MEDIA_RECORD: + return "media-record"; + case APPCOMMAND_MEDIA_FAST_FORWARD: + return "media-fast-forward"; + case APPCOMMAND_MEDIA_REWIND: + return "media-rewind"; + case APPCOMMAND_MEDIA_CHANNEL_UP: + return "media-channel-up"; + case APPCOMMAND_MEDIA_CHANNEL_DOWN: + return "media-channel-down"; + case APPCOMMAND_DELETE: + return "delete"; + default: + return ""; + } +} + } // namespace atom diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index 4f302f832092..d034baf739ec 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -261,6 +261,9 @@ class NativeWindow : public content::WebContentsObserver, const SkBitmap& bitmap, content::ReadbackResponse response); + // Convert Win32 WM_APPCOMMANDS to strings + const char* AppCommandToString(int command_id); + // Observers of this window. ObserverList observers_; diff --git a/atom/browser/native_window_observer.h b/atom/browser/native_window_observer.h index bfb3342cf22a..c8a2c5e3c703 100644 --- a/atom/browser/native_window_observer.h +++ b/atom/browser/native_window_observer.h @@ -67,7 +67,7 @@ class NativeWindowObserver { virtual void OnRendererResponsive() {} // Called on Windows when App Commands arrive (WM_APPCOMMAND) - virtual void OnExecuteWindowsCommand(int command) {} + virtual void OnExecuteWindowsCommand(std::string& command_name) {} }; } // namespace atom diff --git a/filenames.gypi b/filenames.gypi index 98ea65442a88..562e65280d59 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -9,7 +9,6 @@ ], 'coffee_sources': [ 'atom/browser/api/lib/app.coffee', - 'atom/browser/api/lib/app-command.coffee', 'atom/browser/api/lib/atom-delegate.coffee', 'atom/browser/api/lib/auto-updater.coffee', 'atom/browser/api/lib/browser-window.coffee', diff --git a/vendor/brightray b/vendor/brightray index b05e019d2f66..2dc473cada4f 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit b05e019d2f66023fad1ae2f16cc765e3d62ffd5e +Subproject commit 2dc473cada4f118880241c6cd62ffb59dc58ef50 diff --git a/vendor/native_mate b/vendor/native_mate index cc4e2fcd94b5..ad207eeabb01 160000 --- a/vendor/native_mate +++ b/vendor/native_mate @@ -1 +1 @@ -Subproject commit cc4e2fcd94b5a22e6720f0fba1c586a89640f1f6 +Subproject commit ad207eeabb0185f74c017e70ca3411d522627ff0 From 2a2158e0e34e9f2b715d37462ba84b08fa678bf3 Mon Sep 17 00:00:00 2001 From: Paul Betts Date: Thu, 25 Jun 2015 11:20:33 -0600 Subject: [PATCH 0404/1293] :memo: consistency --- docs/api/browser-window.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 31e7ca536650..81649ebdd3b6 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -219,7 +219,7 @@ Emitted when devtools is closed. Emitted when devtools is focused / opened. -### Event: 'app-command' (Windows): +### Event: 'app-command': Emitted when an [App Command](https://msdn.microsoft.com/en-us/library/windows/desktop/ms646275(v=vs.85).aspx) is invoked. These are typically related to keyboard media keys or browser commands, as well as the "Back" button built into some mice on Windows. @@ -236,6 +236,8 @@ someWindow.on('app-command', function(e, cmd) => { }); ``` +__Note__: This event is only fired on Windows + ### Class Method: BrowserWindow.getAllWindows() Returns an array of all opened browser windows. From 528e0f3efbdc781c6d5df8bef58c05b646d17826 Mon Sep 17 00:00:00 2001 From: Paul Betts Date: Thu, 25 Jun 2015 11:31:32 -0600 Subject: [PATCH 0405/1293] Revert submodule change --- vendor/brightray | 2 +- vendor/native_mate | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/vendor/brightray b/vendor/brightray index 2dc473cada4f..b05e019d2f66 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit 2dc473cada4f118880241c6cd62ffb59dc58ef50 +Subproject commit b05e019d2f66023fad1ae2f16cc765e3d62ffd5e diff --git a/vendor/native_mate b/vendor/native_mate index ad207eeabb01..cc4e2fcd94b5 160000 --- a/vendor/native_mate +++ b/vendor/native_mate @@ -1 +1 @@ -Subproject commit ad207eeabb0185f74c017e70ca3411d522627ff0 +Subproject commit cc4e2fcd94b5a22e6720f0fba1c586a89640f1f6 From 58efb3c01804efed79475d776d416296eef551cb Mon Sep 17 00:00:00 2001 From: Paul Betts Date: Thu, 25 Jun 2015 15:09:25 -0600 Subject: [PATCH 0406/1293] I forget cpplint every time --- atom/browser/api/atom_api_window.cc | 2 +- atom/browser/api/atom_api_window.h | 2 +- atom/browser/native_window.cc | 2 +- atom/browser/native_window_observer.h | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index be615c9ad111..9e8076fe8c91 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -162,7 +162,7 @@ void Window::OnDevToolsClosed() { devtools_web_contents_.Reset(); } -void Window::OnExecuteWindowsCommand(std::string& command_name) { +void Window::OnExecuteWindowsCommand(const std::string& command_name) { Emit("app-command", command_name); } diff --git a/atom/browser/api/atom_api_window.h b/atom/browser/api/atom_api_window.h index 248abf6f4300..5867b1e6281a 100644 --- a/atom/browser/api/atom_api_window.h +++ b/atom/browser/api/atom_api_window.h @@ -71,7 +71,7 @@ class Window : public mate::TrackableObject, void OnDevToolsFocus() override; void OnDevToolsOpened() override; void OnDevToolsClosed() override; - void OnExecuteWindowsCommand(std::string& command_name) override; + void OnExecuteWindowsCommand(const std::string& command_name) override; private: // APIs for NativeWindow. diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 308a4842d139..38bbedf39d5f 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -596,7 +596,7 @@ void NativeWindow::OnCapturePageDone(const CapturePageCallback& callback, } const char* NativeWindow::AppCommandToString(int command_id) { - switch(command_id) { + switch (command_id) { case APPCOMMAND_BROWSER_BACKWARD: return "browser-backward"; case APPCOMMAND_BROWSER_FORWARD: diff --git a/atom/browser/native_window_observer.h b/atom/browser/native_window_observer.h index c8a2c5e3c703..5b0a0c56b3de 100644 --- a/atom/browser/native_window_observer.h +++ b/atom/browser/native_window_observer.h @@ -67,7 +67,7 @@ class NativeWindowObserver { virtual void OnRendererResponsive() {} // Called on Windows when App Commands arrive (WM_APPCOMMAND) - virtual void OnExecuteWindowsCommand(std::string& command_name) {} + virtual void OnExecuteWindowsCommand(const std::string& command_name) {} }; } // namespace atom From ffd9c743de73782be8beb54d497836a4f1573a96 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 25 Jun 2015 20:28:07 +0800 Subject: [PATCH 0407/1293] Move gpu-crashed event to app --- atom/browser/api/atom_api_app.cc | 7 +++++++ atom/browser/api/atom_api_app.h | 7 ++++++- atom/browser/api/atom_api_web_contents.cc | 5 ----- atom/browser/api/atom_api_web_contents.h | 7 +------ 4 files changed, 14 insertions(+), 12 deletions(-) diff --git a/atom/browser/api/atom_api_app.cc b/atom/browser/api/atom_api_app.cc index 036c61b407fd..018ca1f85a36 100644 --- a/atom/browser/api/atom_api_app.cc +++ b/atom/browser/api/atom_api_app.cc @@ -24,6 +24,7 @@ #include "base/path_service.h" #include "brightray/browser/brightray_paths.h" #include "content/public/browser/client_certificate_delegate.h" +#include "content/public/browser/gpu_data_manager.h" #include "native_mate/callback.h" #include "native_mate/dictionary.h" #include "native_mate/object_template_builder.h" @@ -135,10 +136,12 @@ void OnClientCertificateSelected( App::App() { Browser::Get()->AddObserver(this); + content::GpuDataManager::GetInstance()->AddObserver(this); } App::~App() { Browser::Get()->RemoveObserver(this); + content::GpuDataManager::GetInstance()->RemoveObserver(this); } void App::OnBeforeQuit(bool* prevent_default) { @@ -206,6 +209,10 @@ void App::OnSelectCertificate( cert_request_info->client_certs[0].get()); } +void App::OnGpuProcessCrashed(base::TerminationStatus exit_code) { + Emit("gpu-crashed"); +} + base::FilePath App::GetPath(mate::Arguments* args, const std::string& name) { bool succeed = false; base::FilePath path; diff --git a/atom/browser/api/atom_api_app.h b/atom/browser/api/atom_api_app.h index 97489917dc26..040f7e3363a9 100644 --- a/atom/browser/api/atom_api_app.h +++ b/atom/browser/api/atom_api_app.h @@ -9,6 +9,7 @@ #include "atom/browser/api/event_emitter.h" #include "atom/browser/browser_observer.h" +#include "content/public/browser/gpu_data_manager_observer.h" #include "native_mate/handle.h" namespace base { @@ -24,7 +25,8 @@ namespace atom { namespace api { class App : public mate::EventEmitter, - public BrowserObserver { + public BrowserObserver, + public content::GpuDataManagerObserver { public: static mate::Handle Create(v8::Isolate* isolate); @@ -47,6 +49,9 @@ class App : public mate::EventEmitter, net::SSLCertRequestInfo* cert_request_info, scoped_ptr delegate) override; + // content::GpuDataManagerObserver: + void OnGpuProcessCrashed(base::TerminationStatus exit_code) override; + // mate::Wrappable: mate::ObjectTemplateBuilder GetObjectTemplateBuilder( v8::Isolate* isolate) override; diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 849b60ee6fa1..d07b03760d0b 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -328,11 +328,6 @@ void WebContents::PluginCrashed(const base::FilePath& plugin_path, Emit("plugin-crashed", info.name, info.version); } -void WebContents::OnGpuProcessCrashed(base::TerminationStatus exit_code) { - if (exit_code == base::TERMINATION_STATUS_PROCESS_CRASHED) - Emit("gpu-crashed"); -} - void WebContents::DocumentLoadedInFrame( content::RenderFrameHost* render_frame_host) { if (!render_frame_host->GetParent()) diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index 9ef88e570405..e6056d056574 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -12,7 +12,6 @@ #include "atom/browser/common_web_contents_delegate.h" #include "content/public/common/favicon_url.h" #include "content/public/browser/web_contents_observer.h" -#include "content/public/browser/gpu_data_manager_observer.h" #include "native_mate/handle.h" #include "ui/gfx/image/image.h" @@ -34,8 +33,7 @@ namespace api { class WebContents : public mate::TrackableObject, public CommonWebContentsDelegate, - public content::WebContentsObserver, - public content::GpuDataManagerObserver { + public content::WebContentsObserver { public: // For node.js callback function type: function(error, buffer) typedef base::Callback, v8::Local)> @@ -185,9 +183,6 @@ class WebContents : public mate::TrackableObject, void PluginCrashed(const base::FilePath& plugin_path, base::ProcessId plugin_pid) override; - // content::GpuDataManagerObserver: - void OnGpuProcessCrashed(base::TerminationStatus exit_code) override; - private: enum Type { BROWSER_WINDOW, // Used by BrowserWindow. From 5b5393e82bbae648534ef7cf9a2048a126b62e49 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 25 Jun 2015 21:53:22 +0800 Subject: [PATCH 0408/1293] docs: gpu-crashed is moved to app --- docs/api/app.md | 4 ++++ docs/api/browser-window.md | 4 ---- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/api/app.md b/docs/api/app.md index d1b219cc15bd..fd488555a71c 100644 --- a/docs/api/app.md +++ b/docs/api/app.md @@ -125,6 +125,10 @@ app.on('select-certificate', function(event, host, url, list, callback) { `event.preventDefault()` prevents from using the first certificate from the store. +### Event: 'gpu-crashed' + +Emitted when the gpu process is crashed. + ## app.quit() Try to close all windows. The `before-quit` event will first be emitted. If all diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index b9c78b940ab3..d76e58424041 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -757,10 +757,6 @@ Calling `event.preventDefault()` can prevent the navigation. Emitted when the renderer process is crashed. -### Event: 'gpu-crashed' - -Emitted when the gpu process is crashed. - ### Event: 'plugin-crashed' * `event` Event From a3ec50437d3deeece49d5222fc95ac9d89731965 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 25 Jun 2015 22:01:57 +0800 Subject: [PATCH 0409/1293] Rename event name to gpu-process-crashed --- atom/browser/api/atom_api_app.cc | 2 +- docs/api/app.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/atom/browser/api/atom_api_app.cc b/atom/browser/api/atom_api_app.cc index 018ca1f85a36..fea4deda5b1b 100644 --- a/atom/browser/api/atom_api_app.cc +++ b/atom/browser/api/atom_api_app.cc @@ -210,7 +210,7 @@ void App::OnSelectCertificate( } void App::OnGpuProcessCrashed(base::TerminationStatus exit_code) { - Emit("gpu-crashed"); + Emit("gpu-process-crashed"); } base::FilePath App::GetPath(mate::Arguments* args, const std::string& name) { diff --git a/docs/api/app.md b/docs/api/app.md index fd488555a71c..89df0e7bde99 100644 --- a/docs/api/app.md +++ b/docs/api/app.md @@ -125,7 +125,7 @@ app.on('select-certificate', function(event, host, url, list, callback) { `event.preventDefault()` prevents from using the first certificate from the store. -### Event: 'gpu-crashed' +### Event: 'gpu-process-crashed' Emitted when the gpu process is crashed. From edf60b852909124ba74e648df8705d8664448117 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 26 Jun 2015 10:37:09 +0800 Subject: [PATCH 0410/1293] spec: Remove grabage console.log --- spec/api-cookies-spec.coffee | 1 - 1 file changed, 1 deletion(-) diff --git a/spec/api-cookies-spec.coffee b/spec/api-cookies-spec.coffee index c526a1cc7489..de934234c140 100644 --- a/spec/api-cookies-spec.coffee +++ b/spec/api-cookies-spec.coffee @@ -14,7 +14,6 @@ describe 'cookies module', -> it 'should get cookies', (done) -> server = http.createServer (req, res) -> - console.log req res.setHeader('Set-Cookie', ['type=dummy']) res.end('finished') server.close() From 80e02d945cde72ac0b06494b9281b6a42e398d6a Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Fri, 26 Jun 2015 10:47:50 +0800 Subject: [PATCH 0411/1293] :memo: Fix a type error. --- docs/api/browser-window.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index b9c78b940ab3..0188063654a4 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -1102,9 +1102,9 @@ win.webContents.on('did-finish-load', function() { * `secure` Boolean - Whether the cookie is marked as Secure (typically HTTPS) * `http_only` Boolean - Whether the cookie is marked as HttpOnly * `session` Boolean - Whether the cookie is a session cookie or a persistent - * cookie with an expiration date. + cookie with an expiration date. * `expirationDate` Double - (Option) The expiration date of the cookie as - the number of seconds since the UNIX epoch. Not provided for session cookies. + the number of seconds since the UNIX epoch. Not provided for session cookies. ### WebContents.session.cookies.set(details, callback) From a96ff8500536f0697e839faabf797278a889fea5 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 26 Jun 2015 10:48:36 +0800 Subject: [PATCH 0412/1293] Clean up code in AtomBrowserClient --- atom/browser/atom_browser_client.cc | 42 +++++++++++++++-------------- 1 file changed, 22 insertions(+), 20 deletions(-) diff --git a/atom/browser/atom_browser_client.cc b/atom/browser/atom_browser_client.cc index 85e19cf234e2..87d72928275e 100644 --- a/atom/browser/atom_browser_client.cc +++ b/atom/browser/atom_browser_client.cc @@ -16,8 +16,8 @@ #include "atom/common/options_switches.h" #include "base/command_line.h" #include "base/files/file_util.h" -#include "base/strings/string_number_conversions.h" #include "base/strings/string_util.h" +#include "base/strings/string_number_conversions.h" #include "chrome/browser/printing/printing_message_filter.h" #include "chrome/browser/renderer_host/pepper/chrome_browser_pepper_host_factory.h" #include "chrome/browser/speech/tts_message_filter.h" @@ -78,6 +78,9 @@ ProcessOwner GetProcessOwner(int process_id, scoped_refptr ImportCertFromFile( const base::FilePath& path) { + if (path.empty()) + return nullptr; + std::string cert_data; if (!base::ReadFileToString(path, &cert_data)) return nullptr; @@ -113,9 +116,9 @@ AtomBrowserClient::~AtomBrowserClient() { void AtomBrowserClient::RenderProcessWillLaunch( content::RenderProcessHost* host) { - int id = host->GetID(); - host->AddFilter(new printing::PrintingMessageFilter(host->GetID())); - host->AddFilter(new TtsMessageFilter(id, host->GetBrowserContext())); + int process_id = host->GetID(); + host->AddFilter(new printing::PrintingMessageFilter(process_id)); + host->AddFilter(new TtsMessageFilter(process_id, host->GetBrowserContext())); } content::SpeechRecognitionManagerDelegate* @@ -211,12 +214,12 @@ void AtomBrowserClient::AppendExtraCommandLineSwitches( } void AtomBrowserClient::DidCreatePpapiPlugin( - content::BrowserPpapiHost* browser_host) { + content::BrowserPpapiHost* host) { auto command_line = base::CommandLine::ForCurrentProcess(); - if (command_line->HasSwitch(switches::kEnablePlugins)) - browser_host->GetPpapiHost()->AddHostFactoryFilter( - scoped_ptr( - new chrome::ChromeBrowserPepperHostFactory(browser_host))); + if (command_line->HasSwitch(switches::kEnablePlugins)) { + host->GetPpapiHost()->AddHostFactoryFilter( + make_scoped_ptr(new chrome::ChromeBrowserPepperHostFactory(host))); + } } content::QuotaPermissionContext* @@ -228,21 +231,20 @@ void AtomBrowserClient::SelectClientCertificate( content::WebContents* web_contents, net::SSLCertRequestInfo* cert_request_info, scoped_ptr delegate) { - auto command_line = base::CommandLine::ForCurrentProcess(); - auto cert_path = command_line->GetSwitchValueNative( - switches::kClientCertificate); + // --client-certificate=`path` + auto cmd = base::CommandLine::ForCurrentProcess(); + if (cmd->HasSwitch(switches::kClientCertificate)) { + auto cert_path = cmd->GetSwitchValuePath(switches::kClientCertificate); + auto certificate = ImportCertFromFile(cert_path); + if (certificate.get()) + delegate->ContinueWithCertificate(certificate.get()); + return; + } - scoped_refptr certificate; - if (!cert_path.empty()) { - certificate = ImportCertFromFile(base::FilePath(cert_path)); - } else if (!cert_request_info->client_certs.empty()) { + if (!cert_request_info->client_certs.empty()) Browser::Get()->ClientCertificateSelector(web_contents, cert_request_info, delegate.Pass()); - } - - if (certificate.get()) - delegate->ContinueWithCertificate(certificate.get()); } brightray::BrowserMainParts* AtomBrowserClient::OverrideCreateBrowserMainParts( From aa20f753351f7e57094b432f0291bf4c646e054d Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 26 Jun 2015 11:04:12 +0800 Subject: [PATCH 0413/1293] Clean up ResolveProxyHelper Since the ResolveProxyHelper is deleted after the callback is called, there is no need to use weak reference. --- atom/browser/api/atom_api_session.cc | 28 +++++++++------------------- vendor/brightray | 2 +- 2 files changed, 10 insertions(+), 20 deletions(-) diff --git a/atom/browser/api/atom_api_session.cc b/atom/browser/api/atom_api_session.cc index d1f21e48c4a1..d1eaca7994ab 100644 --- a/atom/browser/api/atom_api_session.cc +++ b/atom/browser/api/atom_api_session.cc @@ -33,17 +33,13 @@ class ResolveProxyHelper { const GURL& url, Session::ResolveProxyCallback callback) : callback_(callback), - original_thread_(base::ThreadTaskRunnerHandle::Get()), - weak_ptr_factory_(this) { - scoped_refptr getter = - browser_context->GetDefaultStoragePartition(browser_context) - ->GetURLRequestContext(); - - getter->GetNetworkTaskRunner()->PostTask( + original_thread_(base::ThreadTaskRunnerHandle::Get()) { + scoped_refptr context_getter = + browser_context->GetRequestContext(); + context_getter->GetNetworkTaskRunner()->PostTask( FROM_HERE, base::Bind(&ResolveProxyHelper::ResolveProxy, - weak_ptr_factory_.GetWeakPtr(), - getter, url)); + base::Unretained(this), context_getter, url)); } void OnResolveProxyCompleted(int result) { @@ -52,22 +48,19 @@ class ResolveProxyHelper { proxy = proxy_info_.ToPacString(); original_thread_->PostTask(FROM_HERE, base::Bind(callback_, proxy)); - delete this; } private: - void ResolveProxy( - scoped_refptr getter, - const GURL& url) { + void ResolveProxy(scoped_refptr context_getter, + const GURL& url) { DCHECK_CURRENTLY_ON(content::BrowserThread::IO); net::ProxyService* proxy_service = - getter->GetURLRequestContext()->proxy_service(); - + context_getter->GetURLRequestContext()->proxy_service(); net::CompletionCallback completion_callback = base::Bind(&ResolveProxyHelper::OnResolveProxyCompleted, - weak_ptr_factory_.GetWeakPtr()); + base::Unretained(this)); // Start the request. int result = proxy_service->ResolveProxy( @@ -83,13 +76,10 @@ class ResolveProxyHelper { net::ProxyInfo proxy_info_; net::ProxyService::PacRequest* pac_req_; scoped_refptr original_thread_; - base::WeakPtrFactory weak_ptr_factory_; DISALLOW_COPY_AND_ASSIGN(ResolveProxyHelper); }; - - } // namespace Session::Session(AtomBrowserContext* browser_context) diff --git a/vendor/brightray b/vendor/brightray index b05e019d2f66..b158824f01a1 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit b05e019d2f66023fad1ae2f16cc765e3d62ffd5e +Subproject commit b158824f01a1aee3bc2e062d2834e7ff3c91c838 From bff66caaa6c369ea7060204f00b44f796e9cf2dd Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 26 Jun 2015 11:16:50 +0800 Subject: [PATCH 0414/1293] Only convert command ID on Windows --- atom/browser/native_window.cc | 121 ---------------------------- atom/browser/native_window.h | 4 - atom/browser/native_window_views.cc | 69 +++++++++++++++- 3 files changed, 68 insertions(+), 126 deletions(-) diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 38bbedf39d5f..399b49349de7 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -580,14 +580,6 @@ void NativeWindow::NotifyWindowUnresponsive() { OnRendererUnresponsive()); } -void NativeWindow::NotifyExecuteWindowsCommand(int command_id) { - std::string command = AppCommandToString(command_id); - - FOR_EACH_OBSERVER(NativeWindowObserver, - observers_, - OnExecuteWindowsCommand(command)); -} - void NativeWindow::OnCapturePageDone(const CapturePageCallback& callback, const SkBitmap& bitmap, @@ -595,117 +587,4 @@ void NativeWindow::OnCapturePageDone(const CapturePageCallback& callback, callback.Run(bitmap); } -const char* NativeWindow::AppCommandToString(int command_id) { - switch (command_id) { - case APPCOMMAND_BROWSER_BACKWARD: - return "browser-backward"; - case APPCOMMAND_BROWSER_FORWARD: - return "browser-forward"; - case APPCOMMAND_BROWSER_REFRESH: - return "browser-refresh"; - case APPCOMMAND_BROWSER_STOP: - return "browser-stop"; - case APPCOMMAND_BROWSER_SEARCH: - return "browser-search"; - case APPCOMMAND_BROWSER_FAVORITES: - return "browser-favorites"; - case APPCOMMAND_BROWSER_HOME: - return "browser-home"; - case APPCOMMAND_VOLUME_MUTE: - return "volume-mute"; - case APPCOMMAND_VOLUME_DOWN: - return "volume-down"; - case APPCOMMAND_VOLUME_UP: - return "volume-up"; - case APPCOMMAND_MEDIA_NEXTTRACK: - return "media-nexttrack"; - case APPCOMMAND_MEDIA_PREVIOUSTRACK: - return "media-previoustrack"; - case APPCOMMAND_MEDIA_STOP: - return "media-stop"; - case APPCOMMAND_MEDIA_PLAY_PAUSE: - return "media-play_pause"; - case APPCOMMAND_LAUNCH_MAIL: - return "launch-mail"; - case APPCOMMAND_LAUNCH_MEDIA_SELECT: - return "launch-media-select"; - case APPCOMMAND_LAUNCH_APP1: - return "launch-app1"; - case APPCOMMAND_LAUNCH_APP2: - return "launch-app2"; - case APPCOMMAND_BASS_DOWN: - return "bass-down"; - case APPCOMMAND_BASS_BOOST: - return "bass-boost"; - case APPCOMMAND_BASS_UP: - return "bass-up"; - case APPCOMMAND_TREBLE_DOWN: - return "treble-down"; - case APPCOMMAND_TREBLE_UP: - return "treble-up"; - case APPCOMMAND_MICROPHONE_VOLUME_MUTE: - return "microphone-volume-mute"; - case APPCOMMAND_MICROPHONE_VOLUME_DOWN: - return "microphone-volume-down"; - case APPCOMMAND_MICROPHONE_VOLUME_UP: - return "microphone-volume-up"; - case APPCOMMAND_HELP: - return "help"; - case APPCOMMAND_FIND: - return "find"; - case APPCOMMAND_NEW: - return "new"; - case APPCOMMAND_OPEN: - return "open"; - case APPCOMMAND_CLOSE: - return "close"; - case APPCOMMAND_SAVE: - return "save"; - case APPCOMMAND_PRINT: - return "print"; - case APPCOMMAND_UNDO: - return "undo"; - case APPCOMMAND_REDO: - return "redo"; - case APPCOMMAND_COPY: - return "copy"; - case APPCOMMAND_CUT: - return "cut"; - case APPCOMMAND_PASTE: - return "paste"; - case APPCOMMAND_REPLY_TO_MAIL: - return "reply-to-mail"; - case APPCOMMAND_FORWARD_MAIL: - return "forward-mail"; - case APPCOMMAND_SEND_MAIL: - return "send-mail"; - case APPCOMMAND_SPELL_CHECK: - return "spell-check"; - case APPCOMMAND_DICTATE_OR_COMMAND_CONTROL_TOGGLE: - return "dictate-or-command-control-toggle"; - case APPCOMMAND_MIC_ON_OFF_TOGGLE: - return "mic-on-off-toggle"; - case APPCOMMAND_CORRECTION_LIST: - return "correction-list"; - case APPCOMMAND_MEDIA_PLAY: - return "media-play"; - case APPCOMMAND_MEDIA_PAUSE: - return "media-pause"; - case APPCOMMAND_MEDIA_RECORD: - return "media-record"; - case APPCOMMAND_MEDIA_FAST_FORWARD: - return "media-fast-forward"; - case APPCOMMAND_MEDIA_REWIND: - return "media-rewind"; - case APPCOMMAND_MEDIA_CHANNEL_UP: - return "media-channel-up"; - case APPCOMMAND_MEDIA_CHANNEL_DOWN: - return "media-channel-down"; - case APPCOMMAND_DELETE: - return "delete"; - default: - return ""; - } -} - } // namespace atom diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index d034baf739ec..4441726e3396 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -198,7 +198,6 @@ class NativeWindow : public content::WebContentsObserver, void NotifyWindowLeaveFullScreen(); void NotifyWindowEnterHtmlFullScreen(); void NotifyWindowLeaveHtmlFullScreen(); - void NotifyExecuteWindowsCommand(int command_id); void AddObserver(NativeWindowObserver* obs) { observers_.AddObserver(obs); @@ -261,9 +260,6 @@ class NativeWindow : public content::WebContentsObserver, const SkBitmap& bitmap, content::ReadbackResponse response); - // Convert Win32 WM_APPCOMMANDS to strings - const char* AppCommandToString(int command_id); - // Observers of this window. ObserverList observers_; diff --git a/atom/browser/native_window_views.cc b/atom/browser/native_window_views.cc index f03ec73a1d78..35cee1054f1b 100644 --- a/atom/browser/native_window_views.cc +++ b/atom/browser/native_window_views.cc @@ -124,6 +124,70 @@ bool IsAltModifier(const content::NativeWebKeyboardEvent& event) { (modifiers == (Modifiers::AltKey | Modifiers::IsRight)); } +#if defined(OS_WIN) +// Convert Win32 WM_APPCOMMANDS to strings. +const char* AppCommandToString(int command_id) { + switch (command_id) { + case APPCOMMAND_BROWSER_BACKWARD : return "browser-backward"; + case APPCOMMAND_BROWSER_FORWARD : return "browser-forward"; + case APPCOMMAND_BROWSER_REFRESH : return "browser-refresh"; + case APPCOMMAND_BROWSER_STOP : return "browser-stop"; + case APPCOMMAND_BROWSER_SEARCH : return "browser-search"; + case APPCOMMAND_BROWSER_FAVORITES : return "browser-favorites"; + case APPCOMMAND_BROWSER_HOME : return "browser-home"; + case APPCOMMAND_VOLUME_MUTE : return "volume-mute"; + case APPCOMMAND_VOLUME_DOWN : return "volume-down"; + case APPCOMMAND_VOLUME_UP : return "volume-up"; + case APPCOMMAND_MEDIA_NEXTTRACK : return "media-nexttrack"; + case APPCOMMAND_MEDIA_PREVIOUSTRACK : return "media-previoustrack"; + case APPCOMMAND_MEDIA_STOP : return "media-stop"; + case APPCOMMAND_MEDIA_PLAY_PAUSE : return "media-play_pause"; + case APPCOMMAND_LAUNCH_MAIL : return "launch-mail"; + case APPCOMMAND_LAUNCH_MEDIA_SELECT : return "launch-media-select"; + case APPCOMMAND_LAUNCH_APP1 : return "launch-app1"; + case APPCOMMAND_LAUNCH_APP2 : return "launch-app2"; + case APPCOMMAND_BASS_DOWN : return "bass-down"; + case APPCOMMAND_BASS_BOOST : return "bass-boost"; + case APPCOMMAND_BASS_UP : return "bass-up"; + case APPCOMMAND_TREBLE_DOWN : return "treble-down"; + case APPCOMMAND_TREBLE_UP : return "treble-up"; + case APPCOMMAND_MICROPHONE_VOLUME_MUTE : return "microphone-volume-mute"; + case APPCOMMAND_MICROPHONE_VOLUME_DOWN : return "microphone-volume-down"; + case APPCOMMAND_MICROPHONE_VOLUME_UP : return "microphone-volume-up"; + case APPCOMMAND_HELP : return "help"; + case APPCOMMAND_FIND : return "find"; + case APPCOMMAND_NEW : return "new"; + case APPCOMMAND_OPEN : return "open"; + case APPCOMMAND_CLOSE : return "close"; + case APPCOMMAND_SAVE : return "save"; + case APPCOMMAND_PRINT : return "print"; + case APPCOMMAND_UNDO : return "undo"; + case APPCOMMAND_REDO : return "redo"; + case APPCOMMAND_COPY : return "copy"; + case APPCOMMAND_CUT : return "cut"; + case APPCOMMAND_PASTE : return "paste"; + case APPCOMMAND_REPLY_TO_MAIL : return "reply-to-mail"; + case APPCOMMAND_FORWARD_MAIL : return "forward-mail"; + case APPCOMMAND_SEND_MAIL : return "send-mail"; + case APPCOMMAND_SPELL_CHECK : return "spell-check"; + case APPCOMMAND_MIC_ON_OFF_TOGGLE : return "mic-on-off-toggle"; + case APPCOMMAND_CORRECTION_LIST : return "correction-list"; + case APPCOMMAND_MEDIA_PLAY : return "media-play"; + case APPCOMMAND_MEDIA_PAUSE : return "media-pause"; + case APPCOMMAND_MEDIA_RECORD : return "media-record"; + case APPCOMMAND_MEDIA_FAST_FORWARD : return "media-fast-forward"; + case APPCOMMAND_MEDIA_REWIND : return "media-rewind"; + case APPCOMMAND_MEDIA_CHANNEL_UP : return "media-channel-up"; + case APPCOMMAND_MEDIA_CHANNEL_DOWN : return "media-channel-down"; + case APPCOMMAND_DELETE : return "delete"; + case APPCOMMAND_DICTATE_OR_COMMAND_CONTROL_TOGGLE: + return "dictate-or-command-control-toggle"; + default: + return "unkown"; + } +} +#endif + class NativeWindowClientView : public views::ClientView { public: NativeWindowClientView(views::Widget* widget, @@ -856,7 +920,10 @@ bool NativeWindowViews::ExecuteWindowsCommand(int command_id) { } else if ((command_id & sc_mask) == SC_MAXIMIZE) { NotifyWindowMaximize(); } else { - NotifyExecuteWindowsCommand(command_id & sc_mask); + std::string command = AppCommandToString(command_id & sc_mask); + FOR_EACH_OBSERVER(NativeWindowObserver, + observers_, + OnExecuteWindowsCommand(command)); } return false; From b5ff77ef0d7623aea10015c14268c0d9e038e256 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 26 Jun 2015 11:20:12 +0800 Subject: [PATCH 0415/1293] Small cleanups --- atom/browser/native_window.cc | 1 - atom/browser/native_window_views.cc | 1 - docs/api/browser-window.md | 10 +++------- 3 files changed, 3 insertions(+), 9 deletions(-) diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 399b49349de7..df717c8dec98 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -580,7 +580,6 @@ void NativeWindow::NotifyWindowUnresponsive() { OnRendererUnresponsive()); } - void NativeWindow::OnCapturePageDone(const CapturePageCallback& callback, const SkBitmap& bitmap, content::ReadbackResponse response) { diff --git a/atom/browser/native_window_views.cc b/atom/browser/native_window_views.cc index 35cee1054f1b..96997222e27e 100644 --- a/atom/browser/native_window_views.cc +++ b/atom/browser/native_window_views.cc @@ -925,7 +925,6 @@ bool NativeWindowViews::ExecuteWindowsCommand(int command_id) { observers_, OnExecuteWindowsCommand(command)); } - return false; } #endif diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 81649ebdd3b6..ca6e9b99b283 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -223,20 +223,16 @@ Emitted when devtools is focused / opened. Emitted when an [App Command](https://msdn.microsoft.com/en-us/library/windows/desktop/ms646275(v=vs.85).aspx) is invoked. These are typically related to keyboard media keys or browser commands, as well as the "Back" button built into some mice on Windows. - ```js -AppCommands = require('app-command'); - -someWindow.on('app-command', function(e, cmd) => { +someWindow.on('app-command', function(e, cmd) { // Navigate the window back when the user hits their mouse back button - if (cmd === AppCommands.APPCOMMAND_BROWSER_BACKWARD && - someWindow.webContents.canGoBack()) { + if (cmd === 'browser-backward' && someWindow.webContents.canGoBack()) { someWindow.webContents.goBack(); } }); ``` -__Note__: This event is only fired on Windows +__Note__: This event is only fired on Windows. ### Class Method: BrowserWindow.getAllWindows() From 637b642837e28ee8d29e69e7c0392b0d7ba72709 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 26 Jun 2015 12:04:15 +0800 Subject: [PATCH 0416/1293] Fix building on Windows --- atom/browser/api/event_emitter.cc | 6 +++--- atom/browser/api/event_emitter.h | 8 ++++---- atom/browser/browser_observer.h | 2 +- atom/browser/native_window.h | 6 +++--- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/atom/browser/api/event_emitter.cc b/atom/browser/api/event_emitter.cc index 46a8e629e3f3..7337830780f5 100644 --- a/atom/browser/api/event_emitter.cc +++ b/atom/browser/api/event_emitter.cc @@ -37,9 +37,9 @@ v8::Local CreateEventObject(v8::Isolate* isolate) { EventEmitter::EventEmitter() { } -v8::Local EventEmitter::CreateEvent(v8::Isolate* isolate, - content::WebContents* sender, - IPC::Message* message) { +v8::Local EventEmitter::CreateJSEvent(v8::Isolate* isolate, + content::WebContents* sender, + IPC::Message* message) { v8::Local event; bool use_native_event = sender && message; diff --git a/atom/browser/api/event_emitter.h b/atom/browser/api/event_emitter.h index 7139b606483c..6910df3a28d0 100644 --- a/atom/browser/api/event_emitter.h +++ b/atom/browser/api/event_emitter.h @@ -39,7 +39,7 @@ class EventEmitter : public Wrappable { const Args&... args) { v8::Locker locker(isolate()); v8::HandleScope handle_scope(isolate()); - v8::Local event = CreateEvent(isolate(), sender, message); + v8::Local event = CreateJSEvent(isolate(), sender, message); EmitEvent(isolate(), GetWrapper(isolate()), name, event, args...); return event->Get( StringToV8(isolate(), "defaultPrevented"))->BooleanValue(); @@ -49,9 +49,9 @@ class EventEmitter : public Wrappable { EventEmitter(); private: - v8::Local CreateEvent(v8::Isolate* isolate, - content::WebContents* sender, - IPC::Message* message); + v8::Local CreateJSEvent(v8::Isolate* isolate, + content::WebContents* sender, + IPC::Message* message); DISALLOW_COPY_AND_ASSIGN(EventEmitter); }; diff --git a/atom/browser/browser_observer.h b/atom/browser/browser_observer.h index 19f4bd85c1db..20fd08a2e911 100644 --- a/atom/browser/browser_observer.h +++ b/atom/browser/browser_observer.h @@ -8,9 +8,9 @@ #include #include "base/memory/scoped_ptr.h" +#include "content/public/browser/client_certificate_delegate.h" namespace content { -class ClientCertificateDelegate; class WebContents; } diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index 4441726e3396..0ac7aa50c915 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -248,6 +248,9 @@ class NativeWindow : public content::WebContentsObserver, // Window icon. gfx::ImageSkia icon_; + // Observers of this window. + ObserverList observers_; + private: // Schedule a notification unresponsive event. void ScheduleUnresponsiveEvent(int ms); @@ -260,9 +263,6 @@ class NativeWindow : public content::WebContentsObserver, const SkBitmap& bitmap, content::ReadbackResponse response); - // Observers of this window. - ObserverList observers_; - // The windows has been closed. bool is_closed_; From bf5b084945eb6bccbb27d08fea252a1a6402874f Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Wed, 24 Jun 2015 11:41:47 +0900 Subject: [PATCH 0417/1293] Fix some typos and translate more files --- README-ko.md | 2 +- docs/README-ko.md | 4 +- .../atom-shell-vs-node-webkit-ko.md | 49 +++++++ .../build-instructions-linux-ko.md | 100 ++++++++++++++ docs/development/build-instructions-mac-ko.md | 56 ++++++++ .../build-instructions-windows-ko.md | 128 ++++++++++++++++++ docs/development/build-system-overview-ko.md | 64 +++++++++ docs/development/coding-style-ko.md | 1 - .../setting-up-symbol-server-ko.md | 56 ++++++++ .../source-code-directory-structure-ko.md | 48 +++++++ docs/tutorial/application-distribution-ko.md | 10 +- docs/tutorial/application-packaging-ko.md | 96 ++++++------- .../desktop-environment-integration-ko.md | 125 +++++++---------- docs/tutorial/online-offline-events-ko.md | 2 +- docs/tutorial/quick-start-ko.md | 2 +- docs/tutorial/using-native-node-modules-ko.md | 2 - docs/tutorial/using-pepper-flash-plugin-ko.md | 28 ++-- .../using-selenium-and-webdriver-ko.md | 2 +- 18 files changed, 622 insertions(+), 153 deletions(-) create mode 100644 docs/development/atom-shell-vs-node-webkit-ko.md create mode 100644 docs/development/build-instructions-linux-ko.md create mode 100644 docs/development/build-instructions-mac-ko.md create mode 100644 docs/development/build-instructions-windows-ko.md create mode 100644 docs/development/build-system-overview-ko.md create mode 100644 docs/development/setting-up-symbol-server-ko.md create mode 100644 docs/development/source-code-directory-structure-ko.md diff --git a/README-ko.md b/README-ko.md index cc862a3e89e7..2b7efe7343f9 100644 --- a/README-ko.md +++ b/README-ko.md @@ -33,7 +33,7 @@ npm install electron-prebuilt --save-dev ## 참조문서 -[docs](https://github.com/preco21/electron/tree/master/docs) 에 프레임워크 사용 가이드와 API 레퍼런스가 있습니다. +[docs](https://github.com/atom/electron/tree/master/docs/README-ko.md) 에 프레임워크 사용 가이드와 API 레퍼런스가 있습니다. 또한, Electron을 빌드 하는 방법과 프로젝트에 기여하는 방법 문서에 포함되어 있으니 참고바랍니다. ## 커뮤니티 diff --git a/docs/README-ko.md b/docs/README-ko.md index 0a00d7a479df..c59a59d89c8c 100644 --- a/docs/README-ko.md +++ b/docs/README-ko.md @@ -58,7 +58,7 @@ ## 개발자용 * [코딩 스타일](development/coding-style-ko.md) -* [소스코드 구조](development/source-code-directory-structure-ko.md) +* [소스 코드 디렉터리 구조](development/source-code-directory-structure-ko.md) * [NW.js와 기술적으로 다른점 (이전 node-webkit)](development/atom-shell-vs-node-webkit-ko.md) * [빌드 시스템 개요](development/build-system-overview-ko.md) * [빌드 설명서 (Mac)](development/build-instructions-mac-ko.md) @@ -66,4 +66,4 @@ * [빌드 설명서 (Linux)](development/build-instructions-linux-ko.md) * [디버거에서 디버그 심볼 서버 설정](development/setting-up-symbol-server-ko.md) -이 문서는 (@preco21)[https://github.com/preco21]이 번역하였습니다. +이 문서는 [@preco21](https://github.com/preco21) 이 번역하였습니다. diff --git a/docs/development/atom-shell-vs-node-webkit-ko.md b/docs/development/atom-shell-vs-node-webkit-ko.md new file mode 100644 index 000000000000..efecb3abdec5 --- /dev/null +++ b/docs/development/atom-shell-vs-node-webkit-ko.md @@ -0,0 +1,49 @@ +# NW.js와 기술적으로 다른점 (이전 node-webkit) + +__알림: Electron은 이전까지 Atom Shell로 불려졌습니다.__ + +Like NW.js, Electron provides a platform to write desktop applications +with JavaScript and HTML and has Node integration to grant access to low level +system in web pages. + +But there are also fundamental differences between the two projects that make +Electron a completely separate product from NW.js: + +__1. 어플리케이션의 엔트리 포인트__ + +In NW.js, the main entry of an application is a web page. You specify a +main page in the `package.json` and it is opened in a browser window as +the application's main window. + +In Electron, the entry point is a JavaScript script. Instead of +providing a URL directly, you manually create a browser window and load +an HTML file using the API. You also need to listen to window events +to decide when to quit the application. + +Electron works more like the Node.js runtime. Electron's APIs are lower level +so you can use it for browser testing in place of [PhantomJS](http://phantomjs.org/). + +__2. 빌드 시스템__ + +In order to avoid the complexity of building the whole Chromium, Electron uses +[libchromiumcontent](https://github.com/brightray/libchromiumcontent) to access +Chromium's Content API. libchromiumcontent is a single, shared library that +includes the Chromium Content module and all its dependencies. Users don't +need a powerful machine to build Electron. + +__3. Node 통합__ + +In NW.js, the Node integration in web pages requires patching Chromium to +work, while in Electron we chose a different way to integrate libuv loop with +each platform's message loop to avoid hacking Chromium. See the +[`node_bindings`](../../atom/common/) code for how that was done. + +__4. 다중 컨텍스트__ + +If you are an experienced NW.js user, you should be familiar with the +concept of Node context and web context. These concepts were invented because +of how NW.js was implemented. + +By using the [multi-context](http://strongloop.com/strongblog/whats-new-node-js-v0-12-multiple-context-execution/) +feature of Node, Electron doesn't introduce a new JavaScript context in web +pages. diff --git a/docs/development/build-instructions-linux-ko.md b/docs/development/build-instructions-linux-ko.md new file mode 100644 index 000000000000..57a8b3ec6403 --- /dev/null +++ b/docs/development/build-instructions-linux-ko.md @@ -0,0 +1,100 @@ +# 빌드 설명서 (Linux) + +## 빌드전 요구사양 + +* Python 2.7.x. Some distributions like CentOS still use Python 2.6.x +so you may need to check your Python version with `python -V`. +* Node.js v0.12.x. There are various ways to install Node. One can download +source code from [Node.js] (http://nodejs.org) and compile from source. +Doing so permits installing Node to your own home directory as a standard user. +Or try repositories such as [NodeSource] (https://nodesource.com/blog/nodejs-v012-iojs-and-the-nodesource-linux-repositories) +* Clang 3.4 or later +* Development headers of GTK+ and libnotify + +On Ubuntu, install the following libraries: + +```bash +$ sudo apt-get install build-essential clang libdbus-1-dev libgtk2.0-dev \ + libnotify-dev libgnome-keyring-dev libgconf2-dev \ + libasound2-dev libcap-dev libcups2-dev libxtst-dev \ + libxss1 gcc-multilib g++-multilib +``` + +Other distributions may offer similar packages for installation via package +managers such as yum. Or one can compile from source code. + + +## 가상머신을 사용하여 빌드 하는 경우 + +If you plan to build electron on a virtual machine, you will need a fixed-size +device container of at least 25 gigabytes in size. + + +## 코드 가져오기 + +```bash +$ git clone https://github.com/atom/electron.git +``` + +## 부트 스트랩 + +The bootstrap script will download all necessary build dependencies and create +build project files. You must have Python 2.7.x for the script to succeed. +Downloading certain files could take a long time. Notice that we are using +`ninja` to build Electron so there is no `Makefile` generated. + +```bash +$ cd electron +$ ./script/bootstrap.py -v +``` + +## 빌드 하기 + +If you would like to build both `Release` and `Debug` targets: + +```bash +$ ./script/build.py +``` + +This script will cause a very large Electron executable to be placed in +the directory `out/R`. The file size is in excess of 1.3 gigabytes. This +happens because the Release target binary contains debugging symbols. +To reduce the file size, run the `create-dist.py` script: + +```bash +$ ./script/create-dist.py +``` + +This will put a working distribution with much smaller file sizes in +the `dist` directory. After running the create-dist.py script, you +may want to remove the 1.3+ gigabyte binary which is still in out/R. + +You can also build the `Debug` target only: + +```bash +$ ./script/build.py -c D +``` + +After building is done, you can find the `electron` debug binary +under `out/D`. + + +## 정리 하기 + + +To clean the build files: + +```bash +$ ./script/clean.py +``` + + +## 문제 해결 + +Make sure you have installed all the build dependencies. + +## 테스트 + +```bash +$ ./script/test.py +``` diff --git a/docs/development/build-instructions-mac-ko.md b/docs/development/build-instructions-mac-ko.md new file mode 100644 index 000000000000..13a73ccf5194 --- /dev/null +++ b/docs/development/build-instructions-mac-ko.md @@ -0,0 +1,56 @@ +# 빌드 설명서 (Mac) + +## 빌드전 요구 사항 + +* OS X >= 10.8 +* [Xcode](https://developer.apple.com/technologies/tools/) >= 5.1 +* [node.js](http://nodejs.org) (external). + +If you are using the python downloaded by Homebrew, you also need to install +following python modules: + +* pyobjc + +## 코드 가져오기 + +```bash +$ git clone https://github.com/atom/electron.git +``` + +## 부트 스트랩 + +The bootstrap script will download all necessary build dependencies and create +build project files. Notice that we're using `ninja` to build Electron so +there is no Xcode project generated. + +```bash +$ cd electron +$ ./script/bootstrap.py -v +``` + +## 빌드 하기 + +Build both `Release` and `Debug` targets: + +```bash +$ ./script/build.py +``` + +You can also only build the `Debug` target: + +```bash +$ ./script/build.py -c D +``` + +After building is done, you can find `Electron.app` under `out/D`. + +## 32비트 지원 + +Electron can only be built for 64bit target on OS X, and there is no plan to +support 32bit OS X in future. + +## 테스트 + +```bash +$ ./script/test.py +``` diff --git a/docs/development/build-instructions-windows-ko.md b/docs/development/build-instructions-windows-ko.md new file mode 100644 index 000000000000..492ec824f7be --- /dev/null +++ b/docs/development/build-instructions-windows-ko.md @@ -0,0 +1,128 @@ +# 빌드 설명서 (Windows) + +## 빌드전 요구 사항 + +* Windows 7 / Server 2008 R2 or higher +* Visual Studio 2013 - [download VS 2013 Community Edition for + free](http://www.visualstudio.com/products/visual-studio-community-vs) +* [Python 2.7](http://www.python.org/download/releases/2.7/) +* [Node.js](http://nodejs.org/download/) +* [git](http://git-scm.com) + +If you don't have a Windows installation at the moment, +[modern.ie](https://www.modern.ie/en-us/virtualization-tools#downloads) has +timebombed versions of Windows that you can use to build Electron. + +The building of Electron is done entirely with command-line scripts, so you +can use any editor you like to develop Electron, but it also means you can +not use Visual Studio for the development. Support of building with Visual +Studio will come in the future. + +**Note:** Even though Visual Studio is not used for building, it's still +**required** because we need the build toolchains it provided. + +## 코드 가져오기 + +```powershell +git clone https://github.com/atom/electron.git +``` + +## 부트 스트랩 + +The bootstrap script will download all necessary build dependencies and create +build project files. Notice that we're using `ninja` to build Electron so +there is no Visual Studio project generated. + +```powershell +cd electron +python script\bootstrap.py -v +``` + +## 빌드 하기 + +Build both Release and Debug targets: + +```powershell +python script\build.py +``` + +You can also only build the Debug target: + +```powershell +python script\build.py -c D +``` + +After building is done, you can find `atom.exe` under `out\D`. + +## 64비트 빌드 + +To build for the 64bit target, you need to pass `--target_arch=x64` when running +the bootstrap script: + +```powershell +python script\bootstrap.py -v --target_arch=x64 +``` + +The other building steps are exactly the same. + +## 테스트 + +```powershell +python script\test.py +``` + +## 문제 해결 + +### Command xxxx not found + +If you encountered an error like `Command xxxx not found`, you may try to use +the `VS2012 Command Prompt` console to execute the build scripts. + +### Fatal internal compiler error: C1001 + +Make sure you have the latest Visual Studio update installed. + +### Assertion failed: ((handle))->activecnt >= 0 + +If building under Cygwin, you may see `bootstrap.py` failed with following +error: + +``` +Assertion failed: ((handle))->activecnt >= 0, file src\win\pipe.c, line 1430 + +Traceback (most recent call last): + File "script/bootstrap.py", line 87, in + sys.exit(main()) + File "script/bootstrap.py", line 22, in main + update_node_modules('.') + File "script/bootstrap.py", line 56, in update_node_modules + execute([NPM, 'install']) + File "/home/zcbenz/codes/raven/script/lib/util.py", line 118, in execute + raise e +subprocess.CalledProcessError: Command '['npm.cmd', 'install']' returned non-zero exit status 3 +``` + +This is caused by a bug when using Cygwin python and Win32 node together. The +solution is to use the Win32 python to execute the bootstrap script (supposing +you have installed python under `C:\Python27`): + +```bash +/cygdrive/c/Python27/python.exe script/bootstrap.py +``` + +### LNK1181: cannot open input file 'kernel32.lib' + +Try reinstalling 32bit node.js. + +### Error: ENOENT, stat 'C:\Users\USERNAME\AppData\Roaming\npm' + +Simply making that directory [should fix the problem](http://stackoverflow.com/a/25095327/102704): + +```powershell +mkdir ~\AppData\Roaming\npm +``` + +### node-gyp is not recognized as an internal or external command + +You may get this error if you are using Git Bash for building, you should use +PowerShell or VS2012 Command Prompt instead. diff --git a/docs/development/build-system-overview-ko.md b/docs/development/build-system-overview-ko.md new file mode 100644 index 000000000000..4967b28c6426 --- /dev/null +++ b/docs/development/build-system-overview-ko.md @@ -0,0 +1,64 @@ +# 빌드 시스템 개요 + +Electron uses `gyp` for project generation, and `ninja` for building, project +configurations can be found in `.gyp` and `.gypi` files. + +## Gyp 파일들 + +Following `gyp` files contain the main rules of building Electron: + +* `atom.gyp` defines how Electron itself is built. +* `common.gypi` adjusts the build configurations of Node to make it build + together with Chromium. +* `vendor/brightray/brightray.gyp` defines how `brightray` is built, and + includes the default configurations of linking with Chromium. +* `vendor/brightray/brightray.gypi` includes general build configurations about + building. + +## 구성요소 빌드 + +Since Chromium is quite a large project, the final linking stage would take +quite a few minutes, making it hard for development. In order to solve this, +Chromium introduced the "component build", which builds each component as a +separate shared library, making linking very quick but sacrificing file size +and performance. + +In Electron we took a very similar approach: for `Debug` builds, the binary +will be linked to shared library version of Chromium's components to achieve +fast linking time; for `Release` builds, the binary will be linked to the static +library versions, so we can have the best possible binary size and performance. + +## 부트스트랩 최소화 + +All of Chromium's prebuilt binaries are downloaded when running the bootstrap +script. By default both static libraries and shared libraries will be +downloaded and the final size should be between 800MB and 2GB according to the +platform. + +If you only want to build Electron quickly for testing or development, you +can only download the shared library versions by passing the `--dev` parameter: + +```bash +$ ./script/bootstrap.py --dev +$ ./script/build.py -c D +``` + +## Two-phrase 프로젝트 생성 + +Electron links with different sets of libraries in `Release` and `Debug` +builds, however `gyp` doesn't support configuring different link settings for +different configurations. + +To work around this Electron uses a `gyp` variable +`libchromiumcontent_component` to control which link settings to use, and only +generates one target when running `gyp`. + +## 타겟 이름 + +Unlike most projects that use `Release` and `Debug` as target names, Electron +uses `R` and `D` instead. This is because `gyp` randomly crashes if there is +only one `Release` or `Debug` build configuration is defined, and Electron has +to only generate one target for one time as stated above. + +This only affects developers, if you are only building Electron for rebranding +you are not affected. diff --git a/docs/development/coding-style-ko.md b/docs/development/coding-style-ko.md index 40328cd6c5e3..fc2d1f498dfa 100644 --- a/docs/development/coding-style-ko.md +++ b/docs/development/coding-style-ko.md @@ -4,7 +4,6 @@ C++과 Python스크립트는 Chromium의 [코딩 스타일](http://www.chromium.org/developers/coding-style)을 따릅니다. 파이선 스크립트 `script/cpplint.py`를 사용하여 모든 파일이 해당 코딩스타일에 맞게 코딩 되었는지 확인할 수 있습니다. - 파이선의 버전은 2.7을 사용합니다. ## CoffeeScript diff --git a/docs/development/setting-up-symbol-server-ko.md b/docs/development/setting-up-symbol-server-ko.md new file mode 100644 index 000000000000..c4d2f2c4ebd7 --- /dev/null +++ b/docs/development/setting-up-symbol-server-ko.md @@ -0,0 +1,56 @@ +# 디버거에서 디버그 심볼 서버 설정 + +Debug symbols allow you to have better debugging sessions. They have information +about the functions contained in executables and dynamic libraries and provide +you with information to get clean call stacks. A Symbol Server allows the +debugger to load the correct symbols, binaries and sources automatically without +forcing users to download large debugging files. The server functions like +[Microsoft's symbol server](http://support.microsoft.com/kb/311503) so the +documentation there can be useful. + +Note that because released Electron builds are heavily optimized, debugging is +not always easy. The debugger will not be able to show you the content of all +variables and the execution path can seem strange because of inlining, tail +calls, and other compiler optimizations. The only workaround is to build an +unoptimized local build. + +The official symbol server URL for Electron is +http://54.249.141.255:8086/atom-shell/symbols. +You cannot visit this URL directly: you must add it to the symbol path of your +debugging tool. In the examples below, a local cache directory is used to avoid +repeatedly fetching the PDB from the server. Replace `c:\code\symbols` with an +appropriate cache directory on your machine. + +## Windbg에서 심볼 서버 사용하기 + +The Windbg symbol path is configured with a string value delimited with asterisk +characters. To use only the Electron symbol server, add the following entry to +your symbol path (__note:__ you can replace `c:\code\symbols` with any writable +directory on your computer, if you'd prefer a different location for downloaded +symbols): + +``` +SRV*c:\code\symbols\*http://54.249.141.255:8086/atom-shell/symbols +``` + +Set this string as `_NT_SYMBOL_PATH` in the environment, using the Windbg menus, +or by typing the `.sympath` command. If you would like to get symbols from +Microsoft's symbol server as well, you should list that first: + +``` +SRV*c:\code\symbols\*http://msdl.microsoft.com/download/symbols;SRV*c:\code\symbols\*http://54.249.141.255:8086/atom-shell/symbols +``` + +## Using the symbol server in Visual Studio + + + + +## 문제 해결: Symbols will not load + +Type the following commands in Windbg to print why symbols are not loading: + +``` +> !sym noisy +> .reload /f chromiumcontent.dll +``` diff --git a/docs/development/source-code-directory-structure-ko.md b/docs/development/source-code-directory-structure-ko.md new file mode 100644 index 000000000000..8b768b115748 --- /dev/null +++ b/docs/development/source-code-directory-structure-ko.md @@ -0,0 +1,48 @@ +# 소스 코드 디렉터리 구조 + +## 개요 + +Electron의 소스 코드는 몇 개의 파트로 분리되어 있습니다. 우리는 Chromium의 분리 규칙(separation conventions)을 주로 따르고 있습니다. + +이미 [Chromium의 멀티 프로세스 아키텍쳐](http://dev.chromium.org/developers/design-documents/multi-process-architecture)에 익숙해져 있다면 소스 코드를 이해하기 쉬울 것입니다. + +## 소스 코드 구조 + +* **atom** - Electron의 소스코드. + * **app** - 시스템 엔트리 코드. + * **browser** - 주 윈도우를 포함한 프론트엔드, UI, 그리고 메인 프로세스에 관련된 것들. 주 랜더러와 웹 페이지 관리관련 코드. + * **lib** - 메인 프로세스 초기화 코드의 자바스크립트 파트. + * **ui** - 크로스 플랫폼에 대응하는 UI 구현. + * **cocoa** - 코코아 특정 소스 코드. + * **gtk** - GTK+ 특정 소스 코드. + * **win** - Windows GUI 특정 소스 코드. + * **default_app** - 어플리케이션이 제공되지 않으면 기본적으로 사용될 페이지. + * **api** - 메인 프로세스 API들의 구현. + * **lib** - API 구현의 자바스크립트 파트. + * **net** - 네트워크 관련 코드. + * **mac** - Mac 특정 Objective-C 소스 코드. + * **resources** - 아이콘들, 플랫폼 종속성 파일들, 기타 등등. + * **renderer** - 렌더러 프로세스에서 작동하는 코드들. + * **lib** - 렌더러 프로세스 초기화 코드의 자바스크립트 파트. + * **api** - 렌더러 프로세스 API들의 구현. + * **lib** - API 구현의 자바스크립트 파트. + * **common** - 메인 프로세스와 렌더러 프로세스에서 공유하는 코드. 유틸리티 함수와 node 메시지 루프를 Chromium의 메시지 루프에 통합시킨 코드가 포함. + * **lib** - 공통 자바스크립트 초기화 코드. + * **api** - 공통 API들의 구현, Electron의 빌트인 모듈 기초 코드들. + * **lib** - API 구현의 자바스크립트 파트. +* **chromium_src** - 복사된 Chromium 소스 코드. +* **docs** - 참조 문서. +* **spec** - 자동화된 테스트. +* **atom.gyp** - Electron의 빌드 규칙. +* **common.gypi** - 컴파일러 설정 및 `node` 와 `breakpad` 등의 구성요소를 위한 빌드 규칙. + +## 그외 디렉터리 구조 + +* **script** - 개발목적으로 사용되는 빌드, 패키징, 테스트, 기타등을 실행하는 스크립트. +* **tools** - gyp 파일에서 사용되는 헬퍼 스크립트, `script`와는 다르게 유저로부터 직접 실행되지 않는 스크립트들을 이곳에 넣습니다. +* **vendor** - 소스코드의 서드파티 종속성 코드, 소스 코드 디렉터리가 겹쳐 혼란을 일으킬 수 있기 때문에, + 우리는 `third_party`와 같은 Chromium 소스 코드 디렉터리에서 사용된 폴더 이름을 사용하지 않았습니다. +* **node_modules** - 빌드에 사용되는 node 서드파티 모듈. +* **out** - `ninja`의 임시 출력 디렉터리. +* **dist** - 배포용 바이너리를 빌드할 때 사용하는 `script/create-dist.py` 스크립트로부터 만들어지는 임시 디렉터리. +* **external_binaries** - `gyp`를 통한 빌드가 지원하지 않아 따로 다운로드된 서드파티 프레임워크 바이너리들. diff --git a/docs/tutorial/application-distribution-ko.md b/docs/tutorial/application-distribution-ko.md index fff2453fc0a5..43d9ce7f695f 100644 --- a/docs/tutorial/application-distribution-ko.md +++ b/docs/tutorial/application-distribution-ko.md @@ -1,4 +1,4 @@ -# 어플리케이션 배포 +# 어플리케이션 배포 Electron 어플리케이션을 배포할 때는 어플리케이션 폴더의 이름을 `app`으로 지정한 후 Electron 실행파일의 리소스 디렉터리에 집어넣어야합니다. 리소스 디렉터리는 OS X에선 `Electron.app/Contents/Resources/` Windows와 Linux에선 `resources/` 입니다. @@ -48,7 +48,7 @@ electron/resources/ └── app.asar ``` -자세한 내용은 [어플리케이션 패키징](application-packaging.md)에서 찾아볼 수 있습니다. +자세한 내용은 [어플리케이션 패키징](application-packaging-ko.md)에서 찾아볼 수 있습니다. ## 다운로드한 바이너리의 리소스를 앱에 맞게 수정하기 @@ -97,11 +97,11 @@ MyApp.app/Contents ### Linux 실행파일 `electron`의 이름을 원하는 대로 바꿀 수 있습니다. -리눅스 어플리케이션의 아이콘은 [.desktop file](https://developer.gnome.org/integration-guide/stable/desktop-files.html.en)을 사용하여 지정할 수 있습니다. +리눅스 어플리케이션의 아이콘은 [.desktop](https://developer.gnome.org/integration-guide/stable/desktop-files.html.en) 파일을 사용하여 지정할 수 있습니다. ### 역자주-자동화 -일일이 Electron의 리소스를 수정하는 것은 상당히 귀찮고 복잡합니다. +배포시에 Electron의 리소스를 일일이 수정하는 것은 매우 귀찮고 복잡합니다. 하지만 이 작업을 자동화 시킬 수 있는 몇가지 방법이 있습니다: * [electron-builder](https://github.com/loopline-systems/electron-builder) @@ -135,4 +135,4 @@ $ script/build.py -c Release -t myapp Electron의 소스코드를 수정하고 다시 빌드하는 작업은 상당히 복잡합니다. 이를 해결하기 위해 [grunt-build-atom-shell](https://github.com/paulcbetts/grunt-build-atom-shell)를 사용하여 빌드를 자동화 시킬 수 있습니다. -이 툴을 사용하면 자동적으로 `.gyp`파일을 수정하고 다시 빌드합니다. 그리고 어플리케이션의 네이티브 Node 모듈 또한 새로운 실행파일 이름으로 매치 시킵니다. +이 툴을 사용하면 자동으로 `.gyp`파일을 수정하고 다시 빌드합니다. 그리고 어플리케이션의 네이티브 Node 모듈 또한 새로운 실행파일 이름으로 매치 시킵니다. diff --git a/docs/tutorial/application-packaging-ko.md b/docs/tutorial/application-packaging-ko.md index 3e4798f1f523..31314a1c9c0c 100644 --- a/docs/tutorial/application-packaging-ko.md +++ b/docs/tutorial/application-packaging-ko.md @@ -1,37 +1,37 @@ -# ø̼ Ű¡ +# 어플리케이션 패키징 -ø̼ ҽ ҽڵ带 κ ȣϱ , ణ ø̼ [asar][asar] ī̺ Ű¡ ֽϴ. +어플리케이션의 리소스와 소스코드를 유저로부터 보호하기 위해, 약간의 구조 변경으로 어플리케이션을 [asar][asar] 아카이브로 패키징 할 수 있습니다. -## `asar` ī̺ +## `asar` 아카이브 생성 -[asar][asar]ī̺ tar ҽ ϳ Ϸ ϴ. -׸ Electron Ƿ о ֽϴ. +[asar][asar]아카이브는 tar과 비슷한 포맷으로 모든 리소스를 하나의 파일로 만듭니다. +그리고 Electron은 압축해제 없이 임의로 모든 파일을 읽어들일 수 있습니다. -  ܰ踦 ø̼ `asar` ī̺ ֽϴ: +다음 몇가지 단계를 통해 어플리케이션을 `asar` 아카이브로 압축할 수 있습니다: -### 1. asar ƿƼ ġ +### 1. asar 유틸리티 설치 ```bash $ npm install -g asar ``` -### 2. `asar pack` Ŀǵ Ű¡ +### 2. `asar pack` 커맨드로 앱 패키징 ```bash $ asar pack your-app app.asar ``` -## `asar` ī̺ ϱ +## `asar` 아카이브 사용하기 -Electron ΰ API ֽϴ: Node.js Node API, Chromiumκ Web API. - API `asar` о ֵ մϴ. +Electron은 두가지의 API를 가지고 있습니다: Node.js로 부터 제공된 Node API, Chromium으로부터 제공된 Web API. +두 API 모두 `asar`에서 읽어들일 수 있도록 지원합니다. ### Node API -`fs.readFile` `require` Node API ϱ Electron `asar` ī̺갡 ͸ -ġ߽ϴ. ׷ ī̺ ο ҽ ýó ֽϴ. +`fs.readFile` 와 `require` 같은 Node API들을 지원하기 위해 Electron에선 `asar` 아카이브가 가상의 디렉터리 구조를 가지도록 +패치했습니다. 그래서 아카이브 내부에서 리소스들을 정상적인 파일 시스템처럼 접근할 수 있습니다. -, `/path/to` ο `example.asar` ī̺갡 ִٰ ϸ: +예를들어, `/path/to`라는 경로에 `example.asar`라는 아카이브가 있다고 가정하면: ```bash $ asar list /path/to/example.asar @@ -43,27 +43,27 @@ $ asar list /path/to/example.asar /static/jquery.min.js ``` -`asar` ī̺꿡 ֽϴ: +`asar` 아카이브에선 다음과 같이 파일을 읽을 수 있습니다: ```javascript var fs = require('fs'); fs.readFileSync('/path/to/example.asar/file.txt'); ``` -ī̺ Ʈ ͸ մϴ: +아카이브 내의 루트 디렉터리를 리스팅합니다: ```javascript var fs = require('fs'); fs.readdirSync('/path/to/example.asar'); ``` -ī̺ ϱ: +아카이브 안의 모듈 사용하기: ```javascript require('/path/to/example.asar/dir/module.js'); ``` -`BrowserWindow` Ŭ ̿ ϴ ǥ ֽϴ: +`BrowserWindow` 클래스를 이용해 원하는 웹 페이지도 표시할 수 있습니다: ```javascript var BrowserWindow = require('browser-window'); @@ -73,10 +73,10 @@ win.loadUrl('file:///path/to/example.asar/static/index.html'); ### Web API - , ī̺ `file:` Ͽ û ֽϴ. - Node API ͸ ϴ. +웹 페이지 내에선, 아카이브 내의 파일을 `file:` 프로토콜을 사용하여 요청할 수 있습니다. +이 또한 Node API와 같이 가상 디렉터리 구조를 가집니다. -, jQuery `$.get` Ͽ ֽϴ: +예를들어, jQuery의 `$.get`을 사용하여 파일을 가져올 수 있습니다: ```html ``` -### `asar` ī̺긦 Ϲ Ϸ ϱ +### `asar` 아카이브를 일반 파일로 취급하기 -`asar` ī̺ üũ(checksum) ˻ϱ ؼ, `asar` ī̺긦 ״ о鿩 ʿ䰡 ֽϴ. - ۾ ϱ `original-fs` ϴ Ʈ `fs` ſ ֽϴ. - `asar` ֽϴ. ״θ оԴϴ: +`asar` 아카이브의 체크섬(checksum)등을 검사하기 위해선, `asar` 아카이브를 파일 그대로 읽어들여야 할 필요가 있습니다. +이 작업을 하기 위해 `original-fs`라고 하는 빌트인 모듈을 `fs` 모듈 대신에 사용할 수 있습니다. +이 모듈은 `asar` 지원이 빠져있습니다. 즉 파일 그대로를 읽어들입니다: ```javascript var originalFs = require('original-fs'); originalFs.readFileSync('/path/to/example.asar'); ``` -## Node API Ѱ +## Node API의 한계 -`asar` ī̺긦 Node API ִ ͸ ۵ϵ ؿ, (low-level) Node API Ѱ谡 ֽϴ. +`asar` 아카이브를 Node API가 최대한 디렉터리 구조로 작동하도록 노력해왔지만, 여전히 저수준(low-level) Node API 때문에 한계가 있습니다. Even though we tried hard to make `asar` archives in the Node API work like directories as much as possible, there are still limitations due to the low-level nature of the Node API. -### ī̺ б Դϴ +### 아카이브는 읽기 전용입니다 -ī̺ ⺻δ Node API , `asar` ī̺꿡 ۵ ʽϴ. +아카이브는 수정할 수 없으며 기본적으로는 Node API로 파일을 수정할 수 있지만, `asar` 아카이브에선 작동하지 않습니다. -### ī̺ ͸ ۾ η ϸ ȵ˴ϴ +### 아카이브 안의 디렉터리를 작업 경로로 설정하면 안됩니다 -`asar` ī̺ ͸ó ֵ Ǿ, װ Ͻý ͸ ƴ ͸Դϴ. -׷ API ϴ `cwd` ɼ `asar` ī̺ ͸ η ϸ ߿ ߻ ֽϴ. +`asar` 아카이브는 디렉터리처럼 사용할 수 있도록 구현되었지만, 그것은 실제 파일시스템의 디렉터리가 아닌 가상의 디렉터리입니다. +그런 이유로 몇몇 API에서 지원하는 `cwd` 옵션을 `asar` 아카이브 안의 디렉터리 경로로 지정하면 나중에 문제가 발생할 수 있습니다. -### Ư API +### 특정 API로 인한 예외적인 압축 해제 - `fs` API `asar` ī̺ ʰ ٷ ī̺긦 аų , - API ý θ ۵ϹǷ API Electron - API ϰ ۵ ֵ ϱ ӽðο ش ϵ մϴ. ۾ ణ 带 ҷ ų ֽϴ. +많은 `fs` API가 `asar` 아카이브의 압축을 해제하지 않고 바로 아카이브를 읽거나 정보를 가져올 수 있으나, +몇몇 API는 시스템의 실제 파일의 경로를 기반으로 작동하므로 이 API들을 사용할 땐 Electron은 +이 API가 원할하게 작동할 수 있도록 하기 위해 임시경로에 해당 파일들의 압축을 해제합니다. 이 작업은 약간의 오버헤드를 불러 일으킬 수 있습니다. -شϴ API Լ ϴ: +해당하는 API 함수는 다음과 같습니다: * `child_process.execFile` * `fs.open` * `fs.openSync` * `process.dlopen` - Used by `require` on native modules -### `fs.stat` ߸ ͽ +### `fs.stat`의 잘못된 스테이터스 -`fs.stat` ȯǴ `Stats` ü API `asar` ī̺긦 Ÿ ϴ. -ֳϸ ī̺ ͸ δ Ͻýۿ ʱ Դϴ. -׷ ũ Ÿ Ȯ `Stats` ü ŷؼ ȵ˴ϴ. +`fs.stat` 로 부터 반환되는 `Stats` 객체와 비슷한 API들은 `asar` 아카이브를 타겟으로 할 경우 가상의 예측된 정보를 가집니다. +왜냐하면 아카이브의 디렉터리 경로는 실제 파일시스템에 존재하지 않기 때문입니다. +그러한 이유로 파일 크기와 파일 타입 등을 확인할 때 `Stats` 객체를 신뢰해선 안됩니다. ## Adding unpacked files in `asar` archive - ٿ , Node API ȣ ش ӽ մϴ. - ɹ ߻ ֽϴ. ׸ Ʈ ߸ ų ֽϴ. +전술한 바와 같이, 몇몇 Node API는 호출 시 해당 파일을 임시폴더에 압축을 해제합니다. +따로 성능문제가 발생할 수 있습니다. 그리고 백신 소프트웨어의 잘못된 오진을 일으킬 수도 있습니다. - ذϷ, `--unpack` ɼ ȰϿ Ǯ · ؾ մϴ. - node Ƽ ̺귯 unpack · մϴ: +이 문제를 해결하려면, `--unpack` 옵션을 활용하여 파일을 압축이 풀려진 상태로 유지해야 합니다. +다음의 예제는 node 네이티브 모듈의 공유 라이브러리를 unpack 상태로 유지합니다: ```bash $ asar pack app app.asar --unpack *.node ``` -Ŀǵ带 , ͸ `app.asar` ܿ `app.asar.unpacked` ˴ϴ. - ȿ unpack ɼǿ ϵ Ǯ · ԵǾ ֽϴ. - ø̼ ݵ ش Ͽմϴ. +커맨드를 실행한 후, 같은 디렉터리에 `app.asar` 파일 외에 `app.asar.unpacked` 폴더가 같이 생성됩니다. +이 폴더안에 unpack 옵션에서 설정한 파일들이 압축이 풀린 상태로 포함되어 있습니다. +유저에게 어플리케이션을 배포할 때 반드시 해당 폴더도 같이 배포하여야합니다. [asar]: https://github.com/atom/asar diff --git a/docs/tutorial/desktop-environment-integration-ko.md b/docs/tutorial/desktop-environment-integration-ko.md index fbf002154434..73dc47f05790 100644 --- a/docs/tutorial/desktop-environment-integration-ko.md +++ b/docs/tutorial/desktop-environment-integration-ko.md @@ -1,36 +1,30 @@ # 데스크톱 환경 통합 -Different operating systems provide different features on integrating desktop -applications into their desktop environments. For example, on Windows -applications can put shortcuts in the JumpList of task bar, and on Mac -applications can put a custom menu in the dock menu. +어플리케이션을 배포할 서로 다른 운영체제 시스템의 환경과 기능에 맞춰 사용 환경을 통합할 수 있습니다. +예를 들어, Windows에선 태스크바의 JumpList에 바로가기를 추가할 수 있고, Mac(OS X)에선 dock menu에 커스텀 메뉴를 추가할 수 있습니다. -This guide explains how to integrate your application into those desktop -environments with Electron APIs. +이 가이드는 Electron API를 이용하여 각 운영체제 시스템의 기능을 활용하는 방법을 설명합니다. ## 최근 사용한 문서 (Windows & OS X) -Windows and OS X provide easy access to a list of recent documents opened by -the application via JumpList and dock menu. +Windows와 OS X는 dock menu나 JumpList등을 통하여 최근 문서 리스트에 쉽게 접근할 수 있습니다. __JumpList:__ -![JumpList Recent Files](http://i.msdn.microsoft.com/dynimg/IC420538.png) +![JumpList 최근 문서](http://i.msdn.microsoft.com/dynimg/IC420538.png) -__Application dock menu:__ +__어플리케이션 dock menu:__ -To add a file to recent documents, you can use -[app.addRecentDocument][addrecentdocument] API: +파일을 최근 문서에 추가하려면, [app.addRecentDocument][addrecentdocument] API를 사용할 수 있습니다: ```javascript var app = require('app'); app.addRecentDocument('/Users/USERNAME/Desktop/work.type'); ``` -And you can use [app.clearRecentDocuments](clearrecentdocuments) API to empty -the recent documents list: +그리고 [app.clearRecentDocuments](clearrecentdocuments) API로 최근 문서 리스트를 비울 수 있습니다: ```javascript app.clearRecentDocuments(); @@ -38,30 +32,26 @@ app.clearRecentDocuments(); ### Windows에서 주의할 점 -In order to be able to use this feature on Windows, your application has to be -registered as a handler of the file type of the document, otherwise the file -won't appear in JumpList even after you have added it. You can find everything -on registering your application in [Application Registration][app-registration]. +이 기능을 Windows에서 사용할 땐, 운영체제 시스템에 어플리케이션에서 사용하는 파일 확장자가 등록되어 있어야 합니다. +그렇지 않은 경우 파일을 JumpList에 추가해도 추가되지 않습니다. +어플리케이션 등록에 관련된 API의 모든 내용은 [Application Registration][app-registration]에서 찾아볼 수 있습니다. -When a user clicks a file from JumpList, a new instance of your application will -be started with the path of the file added as a command line argument. +유저가 JumpList에서 파일을 클릭할 경우, 클릭된 파일의 경로가 커맨드 라인 인자로 추가되어 새로운 인스턴스의 어플리케이션이 실행됩니다. ### OS X에서 주의할 점 -When a file is requested from the recent documents menu, the `open-file` event -of `app` module would be emitted for it. +파일이 최근 문서 메뉴에서 요청될 경우, `app` 모듈의 `open-file` 이벤트가 호출됩니다. ## 커스텀 독 메뉴 (OS X) -OS X enables developers to specify a custom menu for the dock, which usually -contains some shortcuts for commonly used features of your application: +OS X는 개발자가 dock에 커스텀 메뉴를 만들 수 있도록 허용하고 있습니다. +보통 어플리케이션의 특정 기능 바로가기를 만들 때 사용합니다: -__Dock menu of Terminal.app:__ +__Terminal.app의 dock menu:__ -To set your custom dock menu, you can use the `app.dock.setMenu` API, which is -only available on OS X: +커스텀 dock menu를 설정하려면, `app.dock.setMenu` API를 사용하면 됩니다. OS X에서만 사용 가능합니다: ```javascript var app = require('app'); @@ -79,36 +69,29 @@ app.dock.setMenu(dockMenu); ## 사용자 작업 (Windows) -On Windows you can specify custom actions in the `Tasks` category of JumpList, -as quoted from MSDN: +Windows에선 JumpList의 `Tasks` 카테고리에 원하는 작업을 설정할 수 있습니다. +MSDN에선 해당 기능을 다음과 같이 설명하고 있습니다: -> Applications define tasks based on both the program's features and the key -> things a user is expected to do with them. Tasks should be context-free, in -> that the application does not need to be running for them to work. They -> should also be the statistically most common actions that a normal user would -> perform in an application, such as compose an email message or open the -> calendar in a mail program, create a new document in a word processor, launch -> an application in a certain mode, or launch one of its subcommands. An -> application should not clutter the menu with advanced features that standard -> users won't need or one-time actions such as registration. Do not use tasks -> for promotional items such as upgrades or special offers. +> 어플리케이션 작업은 프로그램의 기능 그리고 주요사양 두가지를 기반으로 유저의 행동을 예측하여 정의합니다. +> 실행할 필요가 없는 어플리케이션 작업은 작동하지 않을 때 반드시 context-free를 유지해야 합니다. +> 작업은 일반 사용자가 프로그램을 실행하거나, 이메일 프로그램으로 이메일을 작성하거나 달력을 불러오고, +> 워드 프로세서로 새 문서를 작성, 특정 모드, 부속 명령으로 프로그램을 실행하는 등의 +> 통계적, 일반적으로 가장 많이 사용되는 작업인지를 고려해야 합니다. +> 어플리케이션 작업은 일반 유저가 필요로 하지 않는 고급 기능을 조잡하게 채우거나 등록과 같은 일회성의 작업을 포함해선 안됩니다. +> 작업에 특별 이벤트 또는 업그레이드 등의 홍보성 작업을 추가하면 안됩니다. > -> It is strongly recommended that the task list be static. It should remain the -> same regardless of the state or status of the application. While it is -> possible to vary the list dynamically, you should consider that this could -> confuse the user who does not expect that portion of the destination list to -> change. +> 작업 리스트는 가능한 한 정적으로 유지되는 것을 적극 권장합니다. +> 이것은 동일한 상태 또는 응용 프로그램의 상태에 관계없이 유지되어야 합니다. +> 작업 목록은 동적으로 변경할 수 있지만, 몇몇 유저는 예상하지 못한 작업 목록 변경에 혼동할 수 있다는 점을 고려해야 합니다. -__Tasks of Internet Explorer:__ +__Internet Explorer의 작업:__ ![IE](http://i.msdn.microsoft.com/dynimg/IC420539.png) -Unlike the dock menu in OS X which is a real menu, user tasks in Windows work -like application shortcuts that when user clicks a task, a program would be -executed with specified arguments. +OS X의 말 그대로 메뉴로 작동하는 dock menu 와는 달리, Windows의 사용자 작업은 어플리케이션 바로가기처럼 작동합니다. +유저가 작업을 클릭할 시, 설정한 인자와 함께 새로운 어플리케이션이 실행됩니다. -To set user tasks for your application, you can use -[app.setUserTasks][setusertaskstasks] API: +사용자 작업을 설정하려면 [app.setUserTasks][setusertaskstasks] API를 사용하여 구현할 수 있습니다: ```javascript var app = require('app'); @@ -124,66 +107,54 @@ app.setUserTasks([ ]); ``` -To clean your tasks list, just call `app.setUserTasks` with empty array: +작업 리스트를 비우려면, 간단히 `app.setUserTasks` 메서드의 첫번째 인자에 빈 배열을 넣어 호출하면 됩니다: ```javascript app.setUserTasks([]); ``` -The user tasks will still show even after your application closes, so the icon -and program path specified for a task should exist until your application is -uninstalled. +사용자 작업 리스트는 어플리케이션이 종료되어도 태스크바에 여전히 보존됩니다. 그러므로 어플리케이션이 삭제되기 전까지 이 기능이 제대로 작동하도록 하기 위해 반드시 프로그램 경로와 아이콘 경로를 지정해야 합니다. ## Unity 런처 숏컷 기능 (Linux) -In Unity, you can add custom entries to its launcher via modifying `.desktop` -file, see [Adding shortcuts to a launcher][unity-launcher]. +Unity 환경에선, `.desktop` 파일을 수정함으로써 런처에 새로운 커스텀 엔트리를 추가할 수 있습니다. [Adding shortcuts to a launcher][unity-launcher] 가이드를 참고하세요. -__Launcher shortcuts of Audacious:__ +__Audacious의 런처 숏컷:__ ![audacious](https://help.ubuntu.com/community/UnityLaunchersAndDesktopFiles?action=AttachFile&do=get&target=shortcuts.png) ## Taskbar progress 기능 (Windows & Unity) -On Windows, a taskbar button can be used to display a progress bar. This enables -a window to provide progress information to the user without the user having to -switch to the window itself. +Windows에선 태스크바의 어플리케이션 버튼에 progress bar를 추가할 수 있습니다. +이 기능은 사용자가 어플리케이션의 창을 열지 않고도 어플리케이션의 작업의 상태 정보를 시각적으로 보여줄 수 있도록 해줍니다. -The Unity DE also has a similar feature that allows you to specify the progress -bar in the launcher. +또한 Unity DE도 런처에 progress bar를 부착할 수 있습니다. -__Progress bar in taskbar button:__ +__태스크바 버튼의 progress bar:__ ![Taskbar Progress Bar](https://cloud.githubusercontent.com/assets/639601/5081682/16691fda-6f0e-11e4-9676-49b6418f1264.png) -__Progress bar in Unity launcher:__ +__Unity 런처의 progress bar:__ ![Unity Launcher](https://cloud.githubusercontent.com/assets/639601/5081747/4a0a589e-6f0f-11e4-803f-91594716a546.png) -To set the progress bar for a Window, you can use the -[BrowserWindow.setProgressBar][setprogressbar] API: +이 기능은 [BrowserWindow.setProgressBar][setprogressbar] API를 사용하여 구현할 수 있습니다: ```javascript var window = new BrowserWindow({...}); window.setProgressBar(0.5); ``` -## 윈도우 파일 제시 (OS X) +## 윈도우 대표 파일 제시 (OS X) -On OS X a window can set its represented file, so the file's icon can show in -the title bar, and when users Command-Click or Control-Click on the tile a path -popup will show. +OS X는 윈도우에서 대표 파일을 설정할 수 있습니다. 쉽게 말해, 타이틀바에서 파일 아이콘을 볼 수 있을 때, 사용자가 Command-Click 또는 Control-Click 할 경우 파일 경로 팝업이 보여집니다. +또한 윈도우의 상태도 지정할 수 있습니다. 쉽게 말해, 로드된 문서의 수정여부를 타이틀바 파일 아이콘에 표시할 수 있습니다. -You can also set the edited state of a window so that the file icon can indicate -whether the document in this window has been modified. - -__Represented file popup menu:__ +__대표 파일 팝업 메뉴:__ -To set the represented file of window, you can use the -[BrowserWindow.setRepresentedFilename][setrepresentedfilename] and -[BrowserWindow.setDocumentEdited][setdocumentedited] APIs: +대표 파일 관련 API는 [BrowserWindow.setRepresentedFilename][setrepresentedfilename] 과 [BrowserWindow.setDocumentEdited][setdocumentedited]를 사용할 수 있습니다: ```javascript var window = new BrowserWindow({...}); diff --git a/docs/tutorial/online-offline-events-ko.md b/docs/tutorial/online-offline-events-ko.md index bf4a4124c396..0aa6a8aae4c0 100644 --- a/docs/tutorial/online-offline-events-ko.md +++ b/docs/tutorial/online-offline-events-ko.md @@ -1,4 +1,4 @@ -# 온라인/오프라인 이벤트 +# 온라인/오프라인 이벤트 온라인/오프라인 이벤트는 다음 예제와 같이 랜더러 프로세스에서 표준 HTML5 API를 이용하여 구현할 수 있습니다. diff --git a/docs/tutorial/quick-start-ko.md b/docs/tutorial/quick-start-ko.md index 9cd5f51230f2..204cf11eb215 100644 --- a/docs/tutorial/quick-start-ko.md +++ b/docs/tutorial/quick-start-ko.md @@ -1,4 +1,4 @@ -# 시작하기 +# 시작하기 ## 소개 diff --git a/docs/tutorial/using-native-node-modules-ko.md b/docs/tutorial/using-native-node-modules-ko.md index c36346b6536f..e78e93f5730b 100644 --- a/docs/tutorial/using-native-node-modules-ko.md +++ b/docs/tutorial/using-native-node-modules-ko.md @@ -38,8 +38,6 @@ $ cd /path-to-module/ $ HOME=~/.electron-gyp node-gyp rebuild --target=0.25.0 --arch=ia64 --dist-url=https://atom.io/download/atom-shell ``` - - `HOME=~/.electron-gyp`은 변경할 헤더의 위치를 찾습니다. `--target=0.25.0`은 Electron의 버전입니다. `--dist-url=...`은 헤더를 다운로드 하는 주소입니다. `--arch=ia64`는 64비트 시스템을 타겟으로 빌드 한다는 것을 `node-gyp`에게 알려줍니다. diff --git a/docs/tutorial/using-pepper-flash-plugin-ko.md b/docs/tutorial/using-pepper-flash-plugin-ko.md index 92dce61716ef..478c669b49be 100644 --- a/docs/tutorial/using-pepper-flash-plugin-ko.md +++ b/docs/tutorial/using-pepper-flash-plugin-ko.md @@ -1,16 +1,16 @@ -# Pepper ÷ ÷ ϱ +# Pepper 플래시 플러그인 사용하기 -ʿϴٸ Pepper ÷ ÷ ֽϴ. Electron pepper ÷ ÷ ϱ ؼ, pepper ÷ ÷ ġ ־մϴ. +필요하다면 Pepper 플래시 플러그인을 사용할 수 있습니다. Electron에서 pepper 플래시 플러그인을 사용하기 위해서는, 따로 pepper 플래시 플러그인의 위치를 지정해 주어야합니다. -## ÷ ÷ غϱ +## 플래시 플러그인 준비하기 -ũ `chrome://plugins` `` ÷ ÷ ġ ã ֽϴ. -Electron ÷ ÷ ϱ ؼ ; մϴ. +크롬 브라우저의 `chrome://plugins` 페이지에 접속한 후 `세부정보`에서 플래시 플러그인의 위치와 버전을 찾을 수 있습니다. +Electron에서 플래시 플러그인을 지원하기 위해선 이 두 가지를 복사해 와야 합니다. -## Electron ġ ߰ +## Electron 스위치 추가 -÷ ϱ `--ppapi-flash-path` `ppapi-flash-version` ÷׸ ready ̺Ʈ ȣDZ ߰ؾմϴ. -׸ `browser-window` `plugins` ġ ߰ؾմϴ. +플러그인을 사용하기 위해 직접적으로 `--ppapi-flash-path` 와 `ppapi-flash-version` 플래그를 ready 이벤트가 호출되기 전에 추가해야합니다. +그리고 `browser-window`에 `plugins` 스위치도 추가해야합니다. ```javascript var app = require('app'); @@ -30,10 +30,10 @@ app.on('window-all-closed', function() { } }); -// ÷ ÷ ġ մϴ. -// Windows , /path/to/pepflashplayer.dll -// Mac , /path/to/PepperFlashPlayer.plugin -// Linux , /path/to/libpepflashplayer.so +// 플래시 플러그인의 위치를 설정합니다. +// Windows의 경우, /path/to/pepflashplayer.dll +// Mac의 경우, /path/to/PepperFlashPlayer.plugin +// Linux의 경우, /path/to/libpepflashplayer.so app.commandLine.appendSwitch('ppapi-flash-path', '/path/to/libpepflashplayer.so'); // Specify flash version, for example, v17.0.0.169 @@ -52,8 +52,8 @@ app.on('ready', function() { }); ``` -## `` ±׸ ̿Ͽ ÷ Ȱȭ -`plugins` Ӽ `` ±׿ ߰մϴ. +## `` 태그를 이용하여 플러그인을 활성화 +`plugins` 속성을 `` 태그에 추가합니다. ```html ``` diff --git a/docs/tutorial/using-selenium-and-webdriver-ko.md b/docs/tutorial/using-selenium-and-webdriver-ko.md index ddd391653879..22c6f79429c9 100644 --- a/docs/tutorial/using-selenium-and-webdriver-ko.md +++ b/docs/tutorial/using-selenium-and-webdriver-ko.md @@ -3,7 +3,7 @@ [ChromeDriver - WebDriver for Chrome][chrome-driver]로 부터 인용: > WebDriver는 많은 브라우저에서 웹 앱을 자동적으로 테스트하는 툴입니다. -> 이 툴은 웹 페이지를 자동으로 탐색하고, 유저 폼을 사용하거나, 자바스크립트를 실행하는 등의 작업을 수행할 수 있습니다. +> 이 툴킷은 웹 페이지를 자동으로 탐색하고, 유저 폼을 사용하거나, 자바스크립트를 실행하는 등의 작업을 수행할 수 있습니다. > ChromeDriver는 Chromium의 WebDriver wire 프로토콜 스텐드얼론 서버 구현입니다. > Chromium 과 WebDriver 팀 멤버에 의해 개발되었습니다. From ebb031dafebaada7eb24b9599dc8e45b22183f79 Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Fri, 26 Jun 2015 02:32:51 +0900 Subject: [PATCH 0418/1293] Fix typos, add more files --- docs/api/accelerator-ko.md | 2 +- docs/api/app-ko.md | 289 +++++ docs/api/auto-updater-ko.md | 143 +++ docs/api/browser-window-ko.md | 1022 +++++++++++++++++ docs/api/chrome-command-line-switches-ko.md | 109 ++ docs/api/clipboard-ko.md | 90 ++ docs/api/content-tracing-ko.md | 137 +++ docs/api/crash-reporter-ko.md | 61 + docs/api/dialog-ko.md | 92 ++ docs/api/file-object-ko.md | 30 + docs/api/frameless-window-ko.md | 89 ++ docs/api/global-shortcut-ko.md | 49 + docs/api/ipc-main-process-ko.md | 49 + docs/api/ipc-renderer-ko.md | 29 + docs/api/menu-item-ko.md | 14 +- docs/api/menu-ko.md | 330 ++++++ docs/api/native-image-ko.md | 139 +++ docs/api/power-monitor-ko.md | 2 +- docs/api/process-ko.md | 13 + docs/api/protocol-ko.md | 121 ++ docs/api/remote-ko.md | 159 +++ docs/api/screen-ko.md | 105 ++ docs/api/shell-ko.md | 39 + docs/api/synopsis-ko.md | 44 + docs/api/tray-ko.md | 2 +- docs/api/web-frame-ko.md | 66 ++ docs/api/web-view-tag-ko.md | 8 +- docs/api/window-open-ko.md | 60 + .../atom-shell-vs-node-webkit-ko.md | 45 +- .../build-instructions-linux-ko.md | 58 +- docs/development/build-instructions-mac-ko.md | 17 +- .../build-instructions-windows-ko.md | 54 +- docs/development/build-system-overview-ko.md | 67 +- docs/development/coding-style-ko.md | 10 +- .../source-code-directory-structure-ko.md | 4 +- docs/tutorial/application-distribution-ko.md | 6 +- docs/tutorial/application-packaging-ko.md | 36 +- docs/tutorial/debugging-main-process-ko.md | 4 +- .../desktop-environment-integration-ko.md | 30 +- docs/tutorial/devtools-extension-ko.md | 11 +- docs/tutorial/online-offline-events-ko.md | 2 +- docs/tutorial/quick-start-ko.md | 32 +- docs/tutorial/using-native-node-modules-ko.md | 8 +- docs/tutorial/using-pepper-flash-plugin-ko.md | 2 +- .../using-selenium-and-webdriver-ko.md | 10 +- 45 files changed, 3450 insertions(+), 239 deletions(-) create mode 100644 docs/api/app-ko.md create mode 100644 docs/api/auto-updater-ko.md create mode 100644 docs/api/browser-window-ko.md create mode 100644 docs/api/chrome-command-line-switches-ko.md create mode 100644 docs/api/clipboard-ko.md create mode 100644 docs/api/content-tracing-ko.md create mode 100644 docs/api/crash-reporter-ko.md create mode 100644 docs/api/dialog-ko.md create mode 100644 docs/api/file-object-ko.md create mode 100644 docs/api/frameless-window-ko.md create mode 100644 docs/api/global-shortcut-ko.md create mode 100644 docs/api/ipc-main-process-ko.md create mode 100644 docs/api/ipc-renderer-ko.md create mode 100644 docs/api/menu-ko.md create mode 100644 docs/api/native-image-ko.md create mode 100644 docs/api/process-ko.md create mode 100644 docs/api/protocol-ko.md create mode 100644 docs/api/remote-ko.md create mode 100644 docs/api/screen-ko.md create mode 100644 docs/api/shell-ko.md create mode 100644 docs/api/synopsis-ko.md create mode 100644 docs/api/web-frame-ko.md create mode 100644 docs/api/window-open-ko.md diff --git a/docs/api/accelerator-ko.md b/docs/api/accelerator-ko.md index 67f94b60a6cb..9e72543a4cc6 100644 --- a/docs/api/accelerator-ko.md +++ b/docs/api/accelerator-ko.md @@ -1,4 +1,4 @@ -# Accelerator +# Accelerator Accelerator는 키보드 단축키를 표현하는 문자열입니다, 여러 혼합키와 키코드를 `+` 문자를 이용하여 결합할 수 있습니다. diff --git a/docs/api/app-ko.md b/docs/api/app-ko.md new file mode 100644 index 000000000000..e0dd37ea836d --- /dev/null +++ b/docs/api/app-ko.md @@ -0,0 +1,289 @@ +# app + +The `app` module is responsible for controlling the application's life time. + +The example of quitting the whole application when the last window is closed: + +```javascript +var app = require('app'); +app.on('window-all-closed', function() { + app.quit(); +}); +``` + +## Event: will-finish-launching + +Emitted when application has done basic startup. On Windows and Linux it is the +same with `ready` event, on OS X this event represents the +`applicationWillFinishLaunching` message of `NSApplication`, usually you would +setup listeners to `open-file` and `open-url` events here, and start the crash +reporter and auto updater. + +Under most cases you should just do everything in `ready` event. + +## Event: ready + +Emitted when Electron has done everything initialization. + +## Event: window-all-closed + +Emitted when all windows have been closed. + +This event is only emitted when the application is not going to quit. If a +user pressed `Cmd + Q`, or the developer called `app.quit()`, Electron would +first try to close all windows and then emit the `will-quit` event, and in +this case the `window-all-closed` would not be emitted. + +## Event: before-quit + +* `event` Event + +Emitted before the application starts closing its windows. +Calling `event.preventDefault()` will prevent the default behaviour, which is +terminating the application. + +## Event: will-quit + +* `event` Event + +Emitted when all windows have been closed and the application will quit. +Calling `event.preventDefault()` will prevent the default behaviour, which is +terminating the application. + +See description of `window-all-closed` for the differences between `will-quit` +and it. + +## Event: quit + +Emitted when application is quitting. + +## Event: open-file + +* `event` Event +* `path` String + +Emitted when user wants to open a file with the application, it usually happens +when the application is already opened and then OS wants to reuse the +application to open file. But it is also emitted when a file is dropped onto the +dock and the application is not yet running. Make sure to listen to open-file +very early in your application startup to handle this case (even before the +`ready` event is emitted). + +You should call `event.preventDefault()` if you want to handle this event. + +## Event: open-url + +* `event` Event +* `url` String + +Emitted when user wants to open a URL with the application, this URL scheme +must be registered to be opened by your application. + +You should call `event.preventDefault()` if you want to handle this event. + +## Event: activate-with-no-open-windows + +Emitted when the application is activated while there is no opened windows. It +usually happens when user has closed all of application's windows and then +click on the application's dock icon. + +## Event: browser-window-blur + +* `event` Event +* `window` BrowserWindow + +Emitted when a [browserWindow](browser-window.md) gets blurred. + +## Event: browser-window-focus + +* `event` Event +* `window` BrowserWindow + +Emitted when a [browserWindow](browser-window.md) gets focused. + +## app.quit() + +Try to close all windows. The `before-quit` event will first be emitted. If all +windows are successfully closed, the `will-quit` event will be emitted and by +default the application would be terminated. + +This method guarantees all `beforeunload` and `unload` handlers are correctly +executed. It is possible that a window cancels the quitting by returning +`false` in `beforeunload` handler. + +## app.getPath(name) + +* `name` String + +Retrieves a path to a special directory or file associated with `name`. On +failure an `Error` would throw. + +You can request following paths by the names: + +* `home`: User's home directory +* `appData`: Per-user application data directory, by default it is pointed to: + * `%APPDATA%` on Windows + * `$XDG_CONFIG_HOME` or `~/.config` on Linux + * `~/Library/Application Support` on OS X +* `userData`: The directory for storing your app's configuration files, by + default it is the `appData` directory appended with your app's name +* `cache`: Per-user application cache directory, by default it is pointed to: + * `%APPDATA%` on Window, which doesn't has a universal place for cache + * `$XDG_CACHE_HOME` or `~/.cache` on Linux + * `~/Library/Caches` on OS X +* `userCache`: The directory for placing your app's caches, by default it is the + `cache` directory appended with your app's name +* `temp`: Temporary directory +* `userDesktop`: The current user's Desktop directory +* `exe`: The current executable file +* `module`: The `libchromiumcontent` library + +## app.setPath(name, path) + +* `name` String +* `path` String + +Overrides the `path` to a special directory or file associated with `name`. if +the path specifies a directory that does not exist, the directory will be +created by this method. On failure an `Error` would throw. + +You can only override paths of `name`s defined in `app.getPath`. + +By default web pages' cookies and caches will be stored under `userData` +directory, if you want to change this location, you have to override the +`userData` path before the `ready` event of `app` module gets emitted. + +## app.getVersion() + +Returns the version of loaded application, if no version is found in +application's `package.json`, the version of current bundle or executable would +be returned. + +## app.getName() + +Returns current application's name, the name in `package.json` would be +used. + +Usually the `name` field of `package.json` is a short lowercased name, according +to the spec of npm modules. So usually you should also specify a `productName` +field, which is your application's full capitalized name, and it will be +preferred over `name` by Electron. + +## app.resolveProxy(url, callback) + +* `url` URL +* `callback` Function + +Resolves the proxy information for `url`, the `callback` would be called with +`callback(proxy)` when the request is done. + +## app.addRecentDocument(path) + +* `path` String + +Adds `path` to recent documents list. + +This list is managed by the system, on Windows you can visit the list from task +bar, and on Mac you can visit it from dock menu. + +## app.clearRecentDocuments() + +Clears the recent documents list. + +## app.setUserTasks(tasks) + +* `tasks` Array - Array of `Task` objects + +Adds `tasks` to the [Tasks][tasks] category of JumpList on Windows. + +The `tasks` is an array of `Task` objects in following format: + +* `Task` Object + * `program` String - Path of the program to execute, usually you should + specify `process.execPath` which opens current program + * `arguments` String - The arguments of command line when `program` is + executed + * `title` String - The string to be displayed in a JumpList + * `description` String - Description of this task + * `iconPath` String - The absolute path to an icon to be displayed in a + JumpList, it can be arbitrary resource file that contains an icon, usually + you can specify `process.execPath` to show the icon of the program + * `iconIndex` Integer - The icon index in the icon file. If an icon file + consists of two or more icons, set this value to identify the icon. If an + icon file consists of one icon, this value is 0 + +**Note:** This API is only available on Windows. + +## app.commandLine.appendSwitch(switch, [value]) + +Append a switch [with optional value] to Chromium's command line. + +**Note:** This will not affect `process.argv`, and is mainly used by developers +to control some low-level Chromium behaviors. + +## app.commandLine.appendArgument(value) + +Append an argument to Chromium's command line. The argument will quoted properly. + +**Note:** This will not affect `process.argv`. + +## app.dock.bounce([type]) + +* `type` String - Can be `critical` or `informational`, the default is + `informational` + +When `critical` is passed, the dock icon will bounce until either the +application becomes active or the request is canceled. + +When `informational` is passed, the dock icon will bounce for one second. The +request, though, remains active until either the application becomes active or +the request is canceled. + +An ID representing the request would be returned. + +**Note:** This API is only available on Mac. + +## app.dock.cancelBounce(id) + +* `id` Integer + +Cancel the bounce of `id`. + +**Note:** This API is only available on Mac. + +## app.dock.setBadge(text) + +* `text` String + +Sets the string to be displayed in the dock’s badging area. + +**Note:** This API is only available on Mac. + +## app.dock.getBadge() + +Returns the badge string of the dock. + +**Note:** This API is only available on Mac. + +## app.dock.hide() + +Hides the dock icon. + +**Note:** This API is only available on Mac. + +## app.dock.show() + +Shows the dock icon. + +**Note:** This API is only available on Mac. + +## app.dock.setMenu(menu) + +* `menu` Menu + +Sets the application [dock menu][dock-menu]. + +**Note:** This API is only available on Mac. + +[dock-menu]:https://developer.apple.com/library/mac/documentation/Carbon/Conceptual/customizing_docktile/concepts/dockconcepts.html#//apple_ref/doc/uid/TP30000986-CH2-TPXREF103 +[tasks]:http://msdn.microsoft.com/en-us/library/windows/desktop/dd378460(v=vs.85).aspx#tasks diff --git a/docs/api/auto-updater-ko.md b/docs/api/auto-updater-ko.md new file mode 100644 index 000000000000..4bc0b252f68b --- /dev/null +++ b/docs/api/auto-updater-ko.md @@ -0,0 +1,143 @@ +# auto-updater + +**This module has only been implemented for OS X.** + +Check out [atom/grunt-atom-shell-installer](https://github.com/atom/grunt-atom-shell-installer) +for building a Windows installer for your app. + +The `auto-updater` module is a simple wrap around the +[Squirrel.Mac](https://github.com/Squirrel/Squirrel.Mac) framework. + +Squirrel.Mac requires that your `.app` folder is signed using the +[codesign](https://developer.apple.com/library/mac/documentation/Darwin/Reference/ManPages/man1/codesign.1.html) +utility for updates to be installed. + +## Squirrel + +Squirrel is an OS X framework focused on making application updates **as safe +and transparent as updates to a website**. + +Instead of publishing a feed of versions from which your app must select, +Squirrel updates to the version your server tells it to. This allows you to +intelligently update your clients based on the request you give to Squirrel. + +Your request can include authentication details, custom headers or a request +body so that your server has the context it needs in order to supply the most +suitable update. + +The update JSON Squirrel requests should be dynamically generated based on +criteria in the request, and whether an update is required. Squirrel relies +on server side support for determining whether an update is required, see +[Server Support](#server-support). + +Squirrel's installer is also designed to be fault tolerant, and ensure that any +updates installed are valid. + +## Update Requests + +Squirrel is indifferent to the request the client application provides for +update checking. `Accept: application/json` is added to the request headers +because Squirrel is responsible for parsing the response. + +For the requirements imposed on the responses and the body format of an update +response see [Server Support](#server-support). + +Your update request must *at least* include a version identifier so that the +server can determine whether an update for this specific version is required. It +may also include other identifying criteria such as operating system version or +username, to allow the server to deliver as fine grained an update as you +would like. + +How you include the version identifier or other criteria is specific to the +server that you are requesting updates from. A common approach is to use query +parameters, like this: + +```javascript +// On the main process +var app = require('app'); +var autoUpdater = require('auto-updater'); +autoUpdater.setFeedUrl('http://mycompany.com/myapp/latest?version=' + app.getVersion()); +``` + +## Server Support + +Your server should determine whether an update is required based on the +[Update Request](#update-requests) your client issues. + +If an update is required your server should respond with a status code of +[200 OK](http://tools.ietf.org/html/rfc2616#section-10.2.1) and include the +[update JSON](#update-json-format) in the body. Squirrel **will** download and +install this update, even if the version of the update is the same as the +currently running version. To save redundantly downloading the same version +multiple times your server must not inform the client to update. + +If no update is required your server must respond with a status code of +[204 No Content](http://tools.ietf.org/html/rfc2616#section-10.2.5). Squirrel +will check for an update again at the interval you specify. + +## Update JSON Format + +When an update is available, Squirrel expects the following schema in response +to the update request provided: + +```json +{ + "url": "http://mycompany.com/myapp/releases/myrelease", + "name": "My Release Name", + "notes": "Theses are some release notes innit", + "pub_date": "2013-09-18T12:29:53+01:00", +} +``` + +The only required key is "url", the others are optional. + +Squirrel will request "url" with `Accept: application/zip` and only supports +installing ZIP updates. If future update formats are supported their MIME type +will be added to the `Accept` header so that your server can return the +appropriate format. + +`pub_date` if present must be formatted according to ISO 8601. + +## Event: error + +* `event` Event +* `message` String + +Emitted when there is an error updating. + +## Event: checking-for-update + +Emitted when checking for update has started. + +## Event: update-available + +Emitted when there is an available update, the update would be downloaded +automatically. + +## Event: update-not-available + +Emitted when there is no available update. + +## Event: update-downloaded + +* `event` Event +* `releaseNotes` String +* `releaseName` String +* `releaseDate` Date +* `updateUrl` String +* `quitAndUpdate` Function + +Emitted when update has been downloaded, calling `quitAndUpdate()` would restart +the application and install the update. + +## autoUpdater.setFeedUrl(url) + +* `url` String + +Set the `url` and initialize the auto updater. The `url` could not be changed +once it is set. + +## autoUpdater.checkForUpdates() + +Ask the server whether there is an update, you have to call `setFeedUrl` before +using this API. diff --git a/docs/api/browser-window-ko.md b/docs/api/browser-window-ko.md new file mode 100644 index 000000000000..d46feff475d8 --- /dev/null +++ b/docs/api/browser-window-ko.md @@ -0,0 +1,1022 @@ +# browser-window + +The `BrowserWindow` class gives you ability to create a browser window, an +example is: + +```javascript +var BrowserWindow = require('browser-window'); + +var win = new BrowserWindow({ width: 800, height: 600, show: false }); +win.on('closed', function() { + win = null; +}); + +win.loadUrl('https://github.com'); +win.show(); +``` + +You can also create a window without chrome by using +[Frameless Window](frameless-window.md) API. + +## Class: BrowserWindow + +`BrowserWindow` is an +[EventEmitter](http://nodejs.org/api/events.html#events_class_events_eventemitter). + +### new BrowserWindow(options) + +* `options` Object + * `x` Integer - Window's left offset to screen + * `y` Integer - Window's top offset to screen + * `width` Integer - Window's width + * `height` Integer - Window's height + * `use-content-size` Boolean - The `width` and `height` would be used as web + page's size, which means the actual window's size will include window + frame's size and be slightly larger. + * `center` Boolean - Show window in the center of the screen + * `min-width` Integer - Minimum width + * `min-height` Integer - Minimum height + * `max-width` Integer - Maximum width + * `max-height` Integer - Maximum height + * `resizable` Boolean - Whether window is resizable + * `always-on-top` Boolean - Whether the window should always stay on top of + other windows + * `fullscreen` Boolean - Whether the window should show in fullscreen, when + set to `false` the fullscreen button would also be hidden on OS X + * `skip-taskbar` Boolean - Do not show window in taskbar + * `zoom-factor` Number - The default zoom factor of the page, zoom factor is + zoom percent / 100, so `3.0` represents `300%` + * `kiosk` Boolean - The kiosk mode + * `title` String - Default window title + * `icon` [NativeImage](native-image.md) - The window icon, when omitted on + Windows the executable's icon would be used as window icon + * `show` Boolean - Whether window should be shown when created + * `frame` Boolean - Specify `false` to create a + [Frameless Window](frameless-window.md) + * `node-integration` Boolean - Whether node integration is enabled, default + is `true` + * `accept-first-mouse` Boolean - Whether the web view accepts a single + mouse-down event that simultaneously activates the window + * `disable-auto-hide-cursor` Boolean - Do not hide cursor when typing + * `auto-hide-menu-bar` Boolean - Auto hide the menu bar unless the `Alt` + key is pressed. + * `enable-larger-than-screen` Boolean - Enable the window to be resized larger + than screen. + * `dark-theme` Boolean - Forces using dark theme for the window, only works on + some GTK+3 desktop environments + * `preload` String - Specifies a script that will be loaded before other + scripts run in the window. This script will always have access to node APIs + no matter whether node integration is turned on for the window, and the path + of `preload` script has to be absolute path. + * `transparent` Boolean - Makes the window [transparent](frameless-window.md) + * `type` String - Specifies the type of the window, possible types are + `desktop`, `dock`, `toolbar`, `splash`, `notification`. This only works on + Linux. + * `standard-window` Boolean - Uses the OS X's standard window instead of the + textured window. Defaults to `true`. + * `web-preferences` Object - Settings of web page's features + * `javascript` Boolean + * `web-security` Boolean + * `images` Boolean + * `java` Boolean + * `text-areas-are-resizable` Boolean + * `webgl` Boolean + * `webaudio` Boolean + * `plugins` Boolean - Whether plugins should be enabled, currently only + `NPAPI` plugins are supported. + * `extra-plugin-dirs` Array - Array of paths that would be searched for + plugins. Note that if you want to add a directory under your app, you + should use `__dirname` or `process.resourcesPath` to join the paths to + make them absolute, using relative paths would make Electron search + under current working directory. + * `experimental-features` Boolean + * `experimental-canvas-features` Boolean + * `subpixel-font-scaling` Boolean + * `overlay-scrollbars` Boolean + * `overlay-fullscreen-video` Boolean + * `shared-worker` Boolean + * `direct-write` Boolean - Whether the DirectWrite font rendering system on + Windows is enabled + * `page-visibility` Boolean - Page would be forced to be always in visible + or hidden state once set, instead of reflecting current window's + visibility. Users can set it to `true` to prevent throttling of DOM + timers. + +Creates a new `BrowserWindow` with native properties set by the `options`. +Usually you only need to set the `width` and `height`, other properties will +have decent default values. + +### Event: 'page-title-updated' + +* `event` Event + +Emitted when the document changed its title, calling `event.preventDefault()` +would prevent the native window's title to change. + +### Event: 'close' + +* `event` Event + +Emitted when the window is going to be closed. It's emitted before the +`beforeunload` and `unload` event of DOM, calling `event.preventDefault()` +would cancel the close. + +Usually you would want to use the `beforeunload` handler to decide whether the +window should be closed, which will also be called when the window is +reloaded. In Electron, returning an empty string or `false` would cancel the +close. An example is: + +```javascript +window.onbeforeunload = function(e) { + console.log('I do not want to be closed'); + + // Unlike usual browsers, in which a string should be returned and the user is + // prompted to confirm the page unload, Electron gives developers more options. + // Returning empty string or false would prevent the unloading now. + // You can also use the dialog API to let the user confirm closing the application. + return false; +}; +``` + +### Event: 'closed' + +Emitted when the window is closed. After you have received this event you should +remove the reference to the window and avoid using it anymore. + +### Event: 'unresponsive' + +Emitted when the web page becomes unresponsive. + +### Event: 'responsive' + +Emitted when the unresponsive web page becomes responsive again. + +### Event: 'blur' + +Emitted when window loses focus. + +### Event: 'focus' + +Emitted when window gains focus. + +### Event: 'maximize' + +Emitted when window is maximized. + +### Event: 'unmaximize' + +Emitted when window exits from maximized state. + +### Event: 'minimize' + +Emitted when window is minimized. + +### Event: 'restore' + +Emitted when window is restored from minimized state. + +### Event: 'resize' + +Emitted when window is getting resized. + +### Event: 'move' + +Emitted when the window is getting moved to a new position. + +__Note__: On OS X this event is just an alias of `moved`. + +### Event: 'moved' + +Emitted once when the window is moved to a new position. + +__Note__: This event is available only on OS X. + +### Event: 'enter-full-screen' + +Emitted when window enters full screen state. + +### Event: 'leave-full-screen' + +Emitted when window leaves full screen state. + +### Event: 'enter-html-full-screen' + +Emitted when window enters full screen state triggered by html api. + +### Event: 'leave-html-full-screen' + +Emitted when window leaves full screen state triggered by html api. + +### Event: 'devtools-opened' + +Emitted when devtools is opened. + +### Event: 'devtools-closed' + +Emitted when devtools is closed. + +### Event: 'devtools-focused' + +Emitted when devtools is focused / opened. + +### Class Method: BrowserWindow.getAllWindows() + +Returns an array of all opened browser windows. + +### Class Method: BrowserWindow.getFocusedWindow() + +Returns the window that is focused in this application. + +### Class Method: BrowserWindow.fromWebContents(webContents) + +* `webContents` WebContents + +Find a window according to the `webContents` it owns + +### Class Method: BrowserWindow.fromId(id) + +* `id` Integer + +Find a window according to its ID. + +### Class Method: BrowserWindow.addDevToolsExtension(path) + +* `path` String + +Adds devtools extension located at `path`, and returns extension's name. + +The extension will be remembered so you only need to call this API once, this +API is not for programming use. + +### Class Method: BrowserWindow.removeDevToolsExtension(name) + +* `name` String + +Remove the devtools extension whose name is `name`. + +### BrowserWindow.webContents + +The `WebContents` object this window owns, all web page related events and +operations would be done via it. + +**Note:** Users should never store this object because it may become `null` +when the renderer process (web page) has crashed. + +### BrowserWindow.devToolsWebContents + +Get the `WebContents` of devtools of this window. + +**Note:** Users should never store this object because it may become `null` +when the devtools has been closed. + +### BrowserWindow.id + +Get the unique ID of this window. + +### BrowserWindow.destroy() + +Force closing the window, the `unload` and `beforeunload` event won't be emitted +for the web page, and `close` event would also not be emitted +for this window, but it would guarantee the `closed` event to be emitted. + +You should only use this method when the renderer process (web page) has crashed. + +### BrowserWindow.close() + +Try to close the window, this has the same effect with user manually clicking +the close button of the window. The web page may cancel the close though, see +the [close event](#event-close). + +### BrowserWindow.focus() + +Focus on the window. + +### BrowserWindow.isFocused() + +Returns whether the window is focused. + +### BrowserWindow.show() + +Shows and gives focus to the window. + +### BrowserWindow.showInactive() + +Shows the window but doesn't focus on it. + +### BrowserWindow.hide() + +Hides the window. + +### BrowserWindow.isVisible() + +Returns whether the window is visible to the user. + +### BrowserWindow.maximize() + +Maximizes the window. + +### BrowserWindow.unmaximize() + +Unmaximizes the window. + +### BrowserWindow.isMaximized() + +Returns whether the window is maximized. + +### BrowserWindow.minimize() + +Minimizes the window. On some platforms the minimized window will be shown in +the Dock. + +### BrowserWindow.restore() + +Restores the window from minimized state to its previous state. + +### BrowserWindow.isMinimized() + +Returns whether the window is minimized. + +### BrowserWindow.setFullScreen(flag) + +* `flag` Boolean + +Sets whether the window should be in fullscreen mode. + +### BrowserWindow.isFullScreen() + +Returns whether the window is in fullscreen mode. + +### BrowserWindow.setBounds(options) + +* `options` Object + * `x` Integer + * `y` Integer + * `width` Integer + * `height` Integer + +Resizes and moves the window to `width`, `height`, `x`, `y`. + +### BrowserWindow.getBounds() + +Returns an object that contains window's width, height, x and y values. + +### BrowserWindow.setSize(width, height) + +* `width` Integer +* `height` Integer + +Resizes the window to `width` and `height`. + +### BrowserWindow.getSize() + +Returns an array that contains window's width and height. + +### BrowserWindow.setContentSize(width, height) + +* `width` Integer +* `height` Integer + +Resizes the window's client area (e.g. the web page) to `width` and `height`. + +### BrowserWindow.getContentSize() + +Returns an array that contains window's client area's width and height. + +### BrowserWindow.setMinimumSize(width, height) + +* `width` Integer +* `height` Integer + +Sets the minimum size of window to `width` and `height`. + +### BrowserWindow.getMinimumSize() + +Returns an array that contains window's minimum width and height. + +### BrowserWindow.setMaximumSize(width, height) + +* `width` Integer +* `height` Integer + +Sets the maximum size of window to `width` and `height`. + +### BrowserWindow.getMaximumSize() + +Returns an array that contains window's maximum width and height. + +### BrowserWindow.setResizable(resizable) + +* `resizable` Boolean + +Sets whether the window can be manually resized by user. + +### BrowserWindow.isResizable() + +Returns whether the window can be manually resized by user. + +### BrowserWindow.setAlwaysOnTop(flag) + +* `flag` Boolean + +Sets whether the window should show always on top of other windows. After +setting this, the window is still a normal window, not a toolbox window which +can not be focused on. + +### BrowserWindow.isAlwaysOnTop() + +Returns whether the window is always on top of other windows. + +### BrowserWindow.center() + +Moves window to the center of the screen. + +### BrowserWindow.setPosition(x, y) + +* `x` Integer +* `y` Integer + +Moves window to `x` and `y`. + +### BrowserWindow.getPosition() + +Returns an array that contains window's current position. + +### BrowserWindow.setTitle(title) + +* `title` String + +Changes the title of native window to `title`. + +### BrowserWindow.getTitle() + +Returns the title of the native window. + +**Note:** The title of web page can be different from the title of the native +window. + +### BrowserWindow.flashFrame(flag) + +* `flag` Boolean + +Starts or stops flashing the window to attract user's attention. + +### BrowserWindow.setSkipTaskbar(skip) + +* `skip` Boolean + +Makes the window not show in the taskbar. + +### BrowserWindow.setKiosk(flag) + +* `flag` Boolean + +Enters or leaves the kiosk mode. + +### BrowserWindow.isKiosk() + +Returns whether the window is in kiosk mode. + +### BrowserWindow.setRepresentedFilename(filename) + +* `filename` String + +Sets the pathname of the file the window represents, and the icon of the file +will show in window's title bar. + +__Note__: This API is only available on OS X. + +### BrowserWindow.getRepresentedFilename() + +Returns the pathname of the file the window represents. + +__Note__: This API is only available on OS X. + +### BrowserWindow.setDocumentEdited(edited) + +* `edited` Boolean + +Specifies whether the window’s document has been edited, and the icon in title +bar will become grey when set to `true`. + +__Note__: This API is only available on OS X. + +### BrowserWindow.IsDocumentEdited() + +Whether the window's document has been edited. + +__Note__: This API is only available on OS X. + +### BrowserWindow.openDevTools([options]) + +* `options` Object + * `detach` Boolean - opens devtools in a new window + +Opens the developer tools. + +### BrowserWindow.closeDevTools() + +Closes the developer tools. + +### BrowserWindow.toggleDevTools() + +Toggle the developer tools. + +### BrowserWindow.inspectElement(x, y) + +* `x` Integer +* `y` Integer + +Starts inspecting element at position (`x`, `y`). + +### BrowserWindow.inspectServiceWorker() + +Opens the developer tools for the service worker context present in the web contents. + +### BrowserWindow.focusOnWebView() + +### BrowserWindow.blurWebView() + +### BrowserWindow.capturePage([rect, ]callback) + +* `rect` Object - The area of page to be captured + * `x` Integer + * `y` Integer + * `width` Integer + * `height` Integer +* `callback` Function + +Captures the snapshot of page within `rect`, upon completion `callback` would be +called with `callback(image)`, the `image` is an instance of +[NativeImage](native-image.md) that stores data of the snapshot. Omitting the +`rect` would capture the whole visible page. + +**Note:** Be sure to read documents on remote buffer in +[remote](remote.md) if you are going to use this API in renderer +process. + +### BrowserWindow.print([options]) + +Same with `webContents.print([options])` + +### BrowserWindow.printToPDF(options, callback) + +Same with `webContents.printToPDF(options, callback)` + +### BrowserWindow.loadUrl(url, [options]) + +Same with `webContents.loadUrl(url, [options])`. + +### BrowserWindow.reload() + +Same with `webContents.reload`. + +### BrowserWindow.setMenu(menu) + +* `menu` Menu + +Sets the `menu` as the window's menu bar, setting it to `null` will remove the +menu bar. + +__Note:__ This API is not available on OS X. + +### BrowserWindow.setProgressBar(progress) + +* `progress` Double + +Sets progress value in progress bar. Valid range is [0, 1.0]. + +Remove progress bar when progress < 0; +Change to indeterminate mode when progress > 1. + +On Linux platform, only supports Unity desktop environment, you need to specify +the `*.desktop` file name to `desktopName` field in `package.json`. By default, +it will assume `app.getName().desktop`. + +### BrowserWindow.setOverlayIcon(overlay, description) + +* `overlay` [NativeImage](native-image.md) - the icon to display on the bottom +right corner of the taskbar icon. If this parameter is `null`, the overlay is +cleared +* `description` String - a description that will be provided to Accessibility +screen readers + +Sets a 16px overlay onto the current taskbar icon, usually used to convey some sort of application status or to passively notify the user. + +__Note:__ This API is only available on Windows (Windows 7 and above) + +### BrowserWindow.showDefinitionForSelection() + +Shows pop-up dictionary that searches the selected word on the page. + +__Note__: This API is only available on OS X. + +### BrowserWindow.setAutoHideMenuBar(hide) + +* `hide` Boolean + +Sets whether the window menu bar should hide itself automatically. Once set the +menu bar will only show when users press the single `Alt` key. + +If the menu bar is already visible, calling `setAutoHideMenuBar(true)` won't +hide it immediately. + +### BrowserWindow.isMenuBarAutoHide() + +Returns whether menu bar automatically hides itself. + +### BrowserWindow.setMenuBarVisibility(visible) + +* `visible` Boolean + +Sets whether the menu bar should be visible. If the menu bar is auto-hide, users +can still bring up the menu bar by pressing the single `Alt` key. + +### BrowserWindow.isMenuBarVisible() + +Returns whether the menu bar is visible. + +### BrowserWindow.setVisibleOnAllWorkspaces(visible) + +* `visible` Boolean + +Sets whether the window should be visible on all workspaces. + +**Note:** This API does nothing on Windows. + +### BrowserWindow.isVisibleOnAllWorkspaces() + +Returns whether the window is visible on all workspaces. + +**Note:** This API always returns false on Windows. + +## Class: WebContents + +A `WebContents` is responsible for rendering and controlling a web page. + +`WebContents` is an +[EventEmitter](http://nodejs.org/api/events.html#events_class_events_eventemitter). + +### Event: 'did-finish-load' + +Emitted when the navigation is done, i.e. the spinner of the tab will stop +spinning, and the `onload` event was dispatched. + +### Event: 'did-fail-load' + +* `event` Event +* `errorCode` Integer +* `errorDescription` String + +This event is like `did-finish-load`, but emitted when the load failed or was +cancelled, e.g. `window.stop()` is invoked. + +### Event: 'did-frame-finish-load' + +* `event` Event +* `isMainFrame` Boolean + +Emitted when a frame has done navigation. + +### Event: 'did-start-loading' + +Corresponds to the points in time when the spinner of the tab starts spinning. + +### Event: 'did-stop-loading' + +Corresponds to the points in time when the spinner of the tab stops spinning. + +### Event: 'did-get-response-details' + +* `event` Event +* `status` Boolean +* `newUrl` String +* `originalUrl` String +* `httpResponseCode` Integer +* `requestMethod` String +* `referrer` String +* `headers` Object + +Emitted when details regarding a requested resource is available. +`status` indicates the socket connection to download the resource. + +### Event: 'did-get-redirect-request' + +* `event` Event +* `oldUrl` String +* `newUrl` String +* `isMainFrame` Boolean + +Emitted when a redirect was received while requesting a resource. + +### Event: 'dom-ready' + +* `event` Event + +Emitted when document in the given frame is loaded. + +### Event: 'page-favicon-updated' + +* `event` Event +* `favicons` Array - Array of Urls + +Emitted when page receives favicon urls. + +### Event: 'new-window' + +* `event` Event +* `url` String +* `frameName` String +* `disposition` String - Can be `default`, `foreground-tab`, `background-tab`, + `new-window` and `other` + +Emitted when the page requested to open a new window for `url`. It could be +requested by `window.open` or an external link like ``. + +By default a new `BrowserWindow` will be created for the `url`. + +Calling `event.preventDefault()` can prevent creating new windows. + +### Event: 'will-navigate' + +* `event` Event +* `url` String + +Emitted when user or the page wants to start an navigation, it can happen when +`window.location` object is changed or user clicks a link in the page. + +This event will not emit when the navigation is started programmatically with APIs +like `WebContents.loadUrl` and `WebContents.back`. + +Calling `event.preventDefault()` can prevent the navigation. + +### Event: 'crashed' + +Emitted when the renderer process is crashed. + +### Event: 'gpu-crashed' + +Emitted when the gpu process is crashed. + +### Event: 'plugin-crashed' + +* `event` Event +* `name` String +* `version` String + +Emitted when a plugin process is crashed. + +### Event: 'destroyed' + +Emitted when the WebContents is destroyed. + +### WebContents.loadUrl(url, [options]) + +* `url` URL +* `options` URL + * `httpReferrer` String - A HTTP Referer url + * `userAgent` String - A user agent originating the request + +Loads the `url` in the window, the `url` must contains the protocol prefix, +e.g. the `http://` or `file://`. + +### WebContents.getUrl() + +Returns URL of current web page. + +### WebContents.getTitle() + +Returns the title of web page. + +### WebContents.isLoading() + +Returns whether web page is still loading resources. + +### WebContents.isWaitingForResponse() + +Returns whether web page is waiting for a first-response for the main resource +of the page. + +### WebContents.stop() + +Stops any pending navigation. + +### WebContents.reload() + +Reloads current page. + +### WebContents.reloadIgnoringCache() + +Reloads current page and ignores cache. + +### WebContents.canGoBack() + +Returns whether the web page can go back. + +### WebContents.canGoForward() + +Returns whether the web page can go forward. + +### WebContents.canGoToOffset(offset) + +* `offset` Integer + +Returns whether the web page can go to `offset`. + +### WebContents.clearHistory() + +Clears the navigation history. + +### WebContents.goBack() + +Makes the web page go back. + +### WebContents.goForward() + +Makes the web page go forward. + +### WebContents.goToIndex(index) + +* `index` Integer + +Navigates to the specified absolute index. + +### WebContents.goToOffset(offset) + +* `offset` Integer + +Navigates to the specified offset from the "current entry". + +### WebContents.isCrashed() + +Whether the renderer process has crashed. + +### WebContents.setUserAgent(userAgent) + +* `userAgent` String + +Overrides the user agent for this page. + +### WebContents.insertCSS(css) + +* `css` String + +Injects CSS into this page. + +### WebContents.executeJavaScript(code) + +* `code` String + +Evaluates `code` in page. + +### WebContents.setAudioMuted(muted) + ++ `muted` Boolean + +Set the page muted. + +### WebContents.isAudioMuted() + +Returns whether this page has been muted. + +### WebContents.undo() + +Executes editing command `undo` in page. + +### WebContents.redo() + +Executes editing command `redo` in page. + +### WebContents.cut() + +Executes editing command `cut` in page. + +### WebContents.copy() + +Executes editing command `copy` in page. + +### WebContents.paste() + +Executes editing command `paste` in page. + +### WebContents.pasteAndMatchStyle() + +Executes editing command `pasteAndMatchStyle` in page. + +### WebContents.delete() + +Executes editing command `delete` in page. + +### WebContents.selectAll() + +Executes editing command `selectAll` in page. + +### WebContents.unselect() + +Executes editing command `unselect` in page. + +### WebContents.replace(text) + +* `text` String + +Executes editing command `replace` in page. + +### WebContents.replaceMisspelling(text) + +* `text` String + +Executes editing command `replaceMisspelling` in page. + +### WebContents.hasServiceWorker(callback) + +* `callback` Function + +Checks if any serviceworker is registered and returns boolean as +response to `callback`. + +### WebContents.unregisterServiceWorker(callback) + +* `callback` Function + +Unregisters any serviceworker if present and returns boolean as +response to `callback` when the JS promise is fullfilled or false +when the JS promise is rejected. + +### WebContents.print([options]) + +* `options` Object + * `silent` Boolean - Don't ask user for print settings, defaults to `false` + * `printBackground` Boolean - Also prints the background color and image of + the web page, defaults to `false`. + +Prints window's web page. When `silent` is set to `false`, Electron will pick +up system's default printer and default settings for printing. + +Calling `window.print()` in web page is equivalent to call +`WebContents.print({silent: false, printBackground: false})`. + +**Note:** On Windows, the print API relies on `pdf.dll`. If your application +doesn't need print feature, you can safely remove `pdf.dll` in saving binary +size. + +### WebContents.printToPDF(options, callback) + +* `options` Object + * `marginsType` Integer - Specify the type of margins to use + * 0 - default + * 1 - none + * 2 - minimum + * `printBackground` Boolean - Whether to print CSS backgrounds. + * `printSelectionOnly` Boolean - Whether to print selection only. + * `landscape` Boolean - `true` for landscape, `false` for portrait. + +* `callback` Function - `function(error, data) {}` + * `error` Error + * `data` Buffer - PDF file content + +Prints windows' web page as PDF with Chromium's preview printing custom +settings. + +By default, the options will be +`{marginsType:0, printBackgrounds:false, printSelectionOnly:false, + landscape:false}`. + +### WebContents.send(channel[, args...]) + +* `channel` String + +Send `args..` to the web page via `channel` in asynchronous message, the web +page can handle it by listening to the `channel` event of `ipc` module. + +An example of sending messages from the main process to the renderer process: + +```javascript +// On the main process. +var window = null; +app.on('ready', function() { + window = new BrowserWindow({width: 800, height: 600}); + window.loadUrl('file://' + __dirname + '/index.html'); + window.webContents.on('did-finish-load', function() { + window.webContents.send('ping', 'whoooooooh!'); + }); +}); +``` + +```html +// index.html + + + + + +``` + +**Note:** + +1. The IPC message handler in web pages do not have a `event` parameter, which + is different from the handlers on the main process. +2. There is no way to send synchronous messages from the main process to a + renderer process, because it would be very easy to cause dead locks. diff --git a/docs/api/chrome-command-line-switches-ko.md b/docs/api/chrome-command-line-switches-ko.md new file mode 100644 index 000000000000..49e5424e5e67 --- /dev/null +++ b/docs/api/chrome-command-line-switches-ko.md @@ -0,0 +1,109 @@ +# Supported Chrome command line switches + +The following command lines switches in Chrome browser are also supported in +Electron, you can use [app.commandLine.appendSwitch][append-switch] to append +them in your app's main script before the [ready][ready] event of [app][app] +module is emitted: + +```javascript +var app = require('app'); +app.commandLine.appendSwitch('remote-debugging-port', '8315'); +app.commandLine.appendSwitch('host-rules', 'MAP * 127.0.0.1'); + +app.on('ready', function() { + // Your code here +}); +``` + +## --client-certificate=`path` + +Sets `path` of client certificate file. + +## --ignore-connections-limit=`domains` + +Ignore the connections limit for `domains` list seperated by `,`. + +## --disable-http-cache + +Disables the disk cache for HTTP requests. + +## --remote-debugging-port=`port` + +Enables remote debug over HTTP on the specified `port`. + +## --proxy-server=`address:port` + +Uses a specified proxy server, overrides system settings. This switch only +affects HTTP and HTTPS requests. + +## --no-proxy-server + +Don't use a proxy server, always make direct connections. Overrides any other +proxy server flags that are passed. + +## --host-rules=`rules` + +Comma-separated list of `rules` that control how hostnames are mapped. + +For example: + +* `MAP * 127.0.0.1` Forces all hostnames to be mapped to 127.0.0.1 +* `MAP *.google.com proxy` Forces all google.com subdomains to be resolved to + "proxy". +* `MAP test.com [::1]:77` Forces "test.com" to resolve to IPv6 loopback. Will + also force the port of the resulting socket address to be 77. +* `MAP * baz, EXCLUDE www.google.com` Remaps everything to "baz", except for + "www.google.com". + +These mappings apply to the endpoint host in a net request (the TCP connect +and host resolver in a direct connection, and the `CONNECT` in an http proxy +connection, and the endpoint host in a `SOCKS` proxy connection). + +## --host-resolver-rules=`rules` + +Like `--host-rules` but these `rules` only apply to the host resolver. + +[app]: app.md +[append-switch]: app.md#appcommandlineappendswitchswitch-value +[ready]: app.md#event-ready + +## --ignore-certificate-errors + +Ignores certificate related errors. + +## --ppapi-flash-path=`path` + +Sets `path` of pepper flash plugin. + +## --ppapi-flash-version=`version` + +Sets `version` of pepper flash plugin. + +## --log-net-log=`path` + +Enables saving net log events and writes them to `path`. + +## --v=`log_level` + +Gives the default maximal active V-logging level; 0 is the default. Normally +positive values are used for V-logging levels. + +Passing `--v=-1` will disable logging. + +## --vmodule=`pattern` + +Gives the per-module maximal V-logging levels to override the value given by +`--v`. E.g. `my_module=2,foo*=3` would change the logging level for all code in +source files `my_module.*` and `foo*.*`. + +Any pattern containing a forward or backward slash will be tested against the +whole pathname and not just the module. E.g. `*/foo/bar/*=2` would change the +logging level for all code in source files under a `foo/bar` directory. + +To disable all chromium related logs and only enable your application logs you +can do: + +```javascript +app.commandLine.appendSwitch('v', -1); +app.commandLine.appendSwitch('vmodule', 'console=0'); +``` diff --git a/docs/api/clipboard-ko.md b/docs/api/clipboard-ko.md new file mode 100644 index 000000000000..35167e31730a --- /dev/null +++ b/docs/api/clipboard-ko.md @@ -0,0 +1,90 @@ +# clipboard + +The `clipboard` provides methods to do copy/paste operations. An example of +writing a string to clipboard: + +```javascript +var clipboard = require('clipboard'); +clipboard.writeText('Example String'); +``` + +On X Window systems, there is also a selection clipboard, to manipulate in it +you need to pass `selection` to each method: + +```javascript +var clipboard = require('clipboard'); +clipboard.writeText('Example String', 'selection'); +console.log(clipboard.readText('selection')); +``` + +## clipboard.readText([type]) + +* `type` String + +Returns the content in clipboard as plain text. + +## clipboard.writeText(text[, type]) + +* `text` String +* `type` String + +Writes the `text` into clipboard as plain text. + +## clipboard.readHtml([type]) + +* `type` String + +Returns the content in clipboard as markup. + +## clipboard.writeHtml(markup[, type]) + +* `markup` String +* `type` String + +Writes the `markup` into clipboard. + +## clipboard.readImage([type]) + +* `type` String + +Returns the content in clipboard as [NativeImage](native-image.md). + +## clipboard.writeImage(image[, type]) + +* `image` [NativeImage](native-image.md) +* `type` String + +Writes the `image` into clipboard. + +## clipboard.clear([type]) + +* `type` String + +Clears everything in clipboard. + +## clipboard.availableFormats([type]) + +Returns an array of supported `format` for the clipboard `type`. + +## clipboard.has(data[, type]) + +* `data` String +* `type` String + +Returns whether clipboard supports the format of specified `data`. + +```javascript +var clipboard = require('clipboard'); +console.log(clipboard.has('

selection

')); +``` + +**Note:** This API is experimental and could be removed in future. + +## clipboard.read(data[, type]) + +* `data` String +* `type` String + +Reads the `data` in clipboard. + +**Note:** This API is experimental and could be removed in future. diff --git a/docs/api/content-tracing-ko.md b/docs/api/content-tracing-ko.md new file mode 100644 index 000000000000..a0896c2a7182 --- /dev/null +++ b/docs/api/content-tracing-ko.md @@ -0,0 +1,137 @@ +# content-tracing + +The `content-trace` module is used to collect tracing data generated by the +underlying Chromium content module. This module does not include a web interface +so you need to open `chrome://tracing/` in a Chrome browser and load the generated +file to view the result. + +```javascript +var tracing = require('content-tracing'); +tracing.startRecording('*', tracing.DEFAULT_OPTIONS, function() { + console.log('Tracing started'); + + setTimeout(function() { + tracing.stopRecording('', function(path) { + console.log('Tracing data recorded to ' + path); + }); + }, 5000); +}); +``` + +## tracing.getCategories(callback) + +* `callback` Function + +Get a set of category groups. The category groups can change as new code paths +are reached. + +Once all child processes have acked to the `getCategories` request, `callback` +is invoked with an array of category groups. + +## tracing.startRecording(categoryFilter, options, callback) + +* `categoryFilter` String +* `options` Integer +* `callback` Function + +Start recording on all processes. + +Recording begins immediately locally, and asynchronously on child processes +as soon as they receive the EnableRecording request. Once all child processes +have acked to the `startRecording` request, `callback` will be called back. + +`categoryFilter` is a filter to control what category groups should be +traced. A filter can have an optional `-` prefix to exclude category groups +that contain a matching category. Having both included and excluded +category patterns in the same list is not supported. + +Examples: + +* `test_MyTest*`, +* `test_MyTest*,test_OtherStuff`, +* `"-excluded_category1,-excluded_category2` + +`options` controls what kind of tracing is enabled, it could be a OR-ed +combination of `tracing.DEFAULT_OPTIONS`, `tracing.ENABLE_SYSTRACE`, +`tracing.ENABLE_SAMPLING` and `tracing.RECORD_CONTINUOUSLY`. + +## tracing.stopRecording(resultFilePath, callback) + +* `resultFilePath` String +* `callback` Function + +Stop recording on all processes. + +Child processes typically are caching trace data and only rarely flush and send +trace data back to the main process. That is because it may be an expensive +operation to send the trace data over IPC, and we would like to avoid much +runtime overhead of tracing. So, to end tracing, we must asynchronously ask all +child processes to flush any pending trace data. + +Once all child processes have acked to the `stopRecording` request, `callback` +will be called back with a file that contains the traced data. + +Trace data will be written into `resultFilePath` if it is not empty, or into a +temporary file. The actual file path will be passed to `callback` if it's not +null. + +## tracing.startMonitoring(categoryFilter, options, callback) + +* `categoryFilter` String +* `options` Integer +* `callback` Function + +Start monitoring on all processes. + +Monitoring begins immediately locally, and asynchronously on child processes as +soon as they receive the `startMonitoring` request. + +Once all child processes have acked to the `startMonitoring` request, +`callback` will be called back. + +## tracing.stopMonitoring(callback); + +* `callback` Function + +Stop monitoring on all processes. + +Once all child processes have acked to the `stopMonitoring` request, `callback` +is called back. + +## tracing.captureMonitoringSnapshot(resultFilePath, callback) + +* `resultFilePath` String +* `callback` Function + +Get the current monitoring traced data. + +Child processes typically are caching trace data and only rarely flush and send +trace data back to the main process. That is because it may be an expensive +operation to send the trace data over IPC, and we would like to avoid unneeded +runtime overhead of tracing. So, to end tracing, we must asynchronously ask all +child processes to flush any pending trace data. + +Once all child processes have acked to the `captureMonitoringSnapshot` request, +the `callback` will be invoked with a file that contains the traced data. + + +## tracing.getTraceBufferUsage(callback) + +* `callback` Function + +Get the maximum across processes of trace buffer percent full state. When the +TraceBufferUsage value is determined, the `callback` is called. + +## tracing.setWatchEvent(categoryName, eventName, callback) + +* `categoryName` String +* `eventName` String +* `callback` Function + +`callback` will will be called every time the given event occurs on any +process. + +## tracing.cancelWatchEvent() + +Cancel the watch event. If tracing is enabled, this may race with the watch +event callback. diff --git a/docs/api/crash-reporter-ko.md b/docs/api/crash-reporter-ko.md new file mode 100644 index 000000000000..1302d9b457e2 --- /dev/null +++ b/docs/api/crash-reporter-ko.md @@ -0,0 +1,61 @@ +# crash-reporter + +An example of automatically submitting crash reporters to remote server: + +```javascript +crashReporter = require('crash-reporter'); +crashReporter.start({ + productName: 'YourName', + companyName: 'YourCompany', + submitUrl: 'https://your-domain.com/url-to-submit', + autoSubmit: true +}); +``` + +## crashReporter.start(options) + +* `options` Object + * `productName` String, default: Electron + * `companyName` String, default: GitHub, Inc + * `submitUrl` String, default: http://54.249.141.255:1127/post + * URL that crash reports would be sent to as POST + * `autoSubmit` Boolean, default: true + * Send the crash report without user interaction + * `ignoreSystemCrashHandler` Boolean, default: false + * `extra` Object + * An object you can define which content will be send along with the report. + * Only string properties are send correctly. + * Nested objects are not supported. + +Developers are required to call the API before using other crashReporter APIs. + + +**Note:** On OS X, electron uses a new `crashpad` client, which is different +with the `breakpad` on Windows and Linux. To enable crash collection feature, +you are required to call `crashReporter.start` API to initiliaze `crashpad` in +main process, even you only collect crash report in renderer process. + +## crashReporter.getLastCrashReport() + +Returns the date and ID of last crash report, when there was no crash report +sent or the crash reporter is not started, `null` will be returned. + +## crashReporter.getUploadedReports() + +Returns all uploaded crash reports, each report contains date and uploaded ID. + +# crash-reporter payload + +The crash reporter will send the following data to the `submitUrl` as `POST`: + +* `rept` String - e.g. 'electron-crash-service' +* `ver` String - The version of Electron +* `platform` String - e.g. 'win32' +* `process_type` String - e.g. 'renderer' +* `ptime` Number +* `_version` String - The version in `package.json` +* `_productName` String - The product name in the crashReporter `options` object +* `prod` String - Name of the underlying product. In this case Electron +* `_companyName` String - The company name in the crashReporter `options` object +* `upload_file_minidump` File - The crashreport as file +* All level one properties of the `extra` object in the crashReporter `options` object diff --git a/docs/api/dialog-ko.md b/docs/api/dialog-ko.md new file mode 100644 index 000000000000..04ed3fe07979 --- /dev/null +++ b/docs/api/dialog-ko.md @@ -0,0 +1,92 @@ +# dialog + +The `dialog` module provides APIs to show native system dialogs, so web +applications can deliver the same user experience as native applications. + +An example of showing a dialog to select multiple files and directories: + +```javascript +var win = ...; // window in which to show the dialog +var dialog = require('dialog'); +console.log(dialog.showOpenDialog({ properties: [ 'openFile', 'openDirectory', 'multiSelections' ]})); +``` + +**Note for OS X**: If you want to present dialogs as sheets, the only thing you have to do is provide a `BrowserWindow` reference in the `browserWindow` parameter. + +## dialog.showOpenDialog([browserWindow], [options], [callback]) + +* `browserWindow` BrowserWindow +* `options` Object + * `title` String + * `defaultPath` String + * `filters` Array + * `properties` Array - Contains which features the dialog should use, can + contain `openFile`, `openDirectory`, `multiSelections` and + `createDirectory` +* `callback` Function + +On success, returns an array of file paths chosen by the user, otherwise +returns `undefined`. + +The `filters` specifies an array of file types that can be displayed or +selected, an example is: + +```javascript +{ + filters: [ + { name: 'Images', extensions: ['jpg', 'png', 'gif'] }, + { name: 'Movies', extensions: ['mkv', 'avi', 'mp4'] }, + { name: 'Custom File Type', extensions: ['as'] } + ] +} +``` + +If a `callback` is passed, the API call would be asynchronous and the result +would be passed via `callback(filenames)` + +**Note:** On Windows and Linux, an open dialog can not be both a file selector +and a directory selector, so if you set `properties` to +`['openFile', 'openDirectory']` on these platforms, a directory selector will be shown. + +## dialog.showSaveDialog([browserWindow], [options], [callback]) + +* `browserWindow` BrowserWindow +* `options` Object + * `title` String + * `defaultPath` String + * `filters` Array +* `callback` Function + +On success, returns the path of the file chosen by the user, otherwise returns +`undefined`. + +The `filters` specifies an array of file types that can be displayed, see +`dialog.showOpenDialog` for an example. + +If a `callback` is passed, the API call will be asynchronous and the result +will be passed via `callback(filename)` + +## dialog.showMessageBox([browserWindow], options, [callback]) + +* `browserWindow` BrowserWindow +* `options` Object + * `type` String - Can be `"none"`, `"info"` or `"warning"` + * `buttons` Array - Array of texts for buttons + * `title` String - Title of the message box, some platforms will not show it + * `message` String - Content of the message box + * `detail` String - Extra information of the message + * `icon` [NativeImage](native-image.md) +* `callback` Function + +Shows a message box, it will block until the message box is closed. It returns +the index of the clicked button. + +If a `callback` is passed, the API call will be asynchronous and the result +will be passed via `callback(response)` + +## dialog.showErrorBox(title, content) + +Runs a modal dialog that shows an error message. + +This API can be called safely before the `ready` event of `app` module emits, it +is usually used to report errors in early stage of startup. diff --git a/docs/api/file-object-ko.md b/docs/api/file-object-ko.md new file mode 100644 index 000000000000..ea11e01a7526 --- /dev/null +++ b/docs/api/file-object-ko.md @@ -0,0 +1,30 @@ +# `File` object + +The DOM's File interface provides abstraction around native files, in order to +let users work on native files directly with HTML5 file API, Electron has +added a `path` attribute to `File` interface which exposes the file's real path +on filesystem. + +Example on getting real path of a dragged file: + +```html +
+ Drag your file here +
+ + +``` diff --git a/docs/api/frameless-window-ko.md b/docs/api/frameless-window-ko.md new file mode 100644 index 000000000000..fb3c6f5a824f --- /dev/null +++ b/docs/api/frameless-window-ko.md @@ -0,0 +1,89 @@ +# Frameless window + +A frameless window is a window that has no chrome. + +## Create a frameless window + +To create a frameless window, you only need to specify `frame` to `false` in +[BrowserWindow](browser-window.md)'s `options`: + + +```javascript +var BrowserWindow = require('browser-window'); +var win = new BrowserWindow({ width: 800, height: 600, frame: false }); +``` + +## Transparent window + +By setting the `transparent` option to `true`, you can also make the frameless +window transparent: + +```javascript +var win = new BrowserWindow({ transparent: true, frame: false }); +``` + +### Limitations + +* You can not click through the transparent area, we are going to introduce an + API to set window shape to solve this, but currently blocked at an + [upstream bug](https://code.google.com/p/chromium/issues/detail?id=387234). +* Transparent window is not resizable, setting `resizable` to `true` may make + transparent window stop working on some platforms. +* The `blur` filter only applies to the web page, so there is no way to apply + blur effect to the content below the window. +* On Windows transparent window will not work when DWM is disabled. +* On Linux users have to put `--enable-transparent-visuals --disable-gpu` in + command line to disable GPU and allow ARGB to make transparent window, this is + caused by an upstream bug that [alpha channel doesn't work on some NVidia + drivers](https://code.google.com/p/chromium/issues/detail?id=369209) on Linux. +* On Mac the native window shadow will not show for transparent window. + +## Draggable region + +By default, the frameless window is non-draggable. Apps need to specify +`-webkit-app-region: drag` in CSS to tell Electron which regions are draggable +(like the OS's standard titlebar), and apps can also use +`-webkit-app-region: no-drag` to exclude the non-draggable area from the + draggable region. Note that only rectangular shape is currently supported. + +To make the whole window draggable, you can add `-webkit-app-region: drag` as +`body`'s style: + +```html + + +``` + +And note that if you have made the whole window draggable, you must also mark +buttons as non-draggable, otherwise it would be impossible for users to click on +them: + +```css +button { + -webkit-app-region: no-drag; +} +``` + +If you're only using a custom titlebar, you also need to make buttons in +titlebar non-draggable. + +## Text selection + +One thing on frameless window is that the dragging behaviour may conflict with +selecting text, for example, when you drag the titlebar, you may accidentally +select the text on titlebar. To prevent this, you need to disable text +selection on dragging area like this: + +```css +.titlebar { + -webkit-user-select: none; + -webkit-app-region: drag; +} +``` + +## Context menu + +On some platforms, the draggable area would be treated as non-client frame, so +when you right click on it a system menu would be popuped. To make context menu +behave correctly on all platforms, you should never custom context menu on +draggable areas. diff --git a/docs/api/global-shortcut-ko.md b/docs/api/global-shortcut-ko.md new file mode 100644 index 000000000000..a8f3ac183df0 --- /dev/null +++ b/docs/api/global-shortcut-ko.md @@ -0,0 +1,49 @@ +# global-shortcut + +The `global-shortcut` module can register/unregister a global keyboard shortcut +in operating system, so that you can customize the operations for various shortcuts. +Note that the shortcut is global, even if the app does not get focused, it will still work. + +```javascript +var globalShortcut = require('global-shortcut'); + +// Register a 'ctrl+x' shortcut listener. +var ret = globalShortcut.register('ctrl+x', function() { console.log('ctrl+x is pressed'); }) + +if (!ret) { + console.log('registration failed'); +} + +// Check whether a shortcut is registered. +console.log(globalShortcut.isRegistered('ctrl+x')); + +// Unregister a shortcut. +globalShortcut.unregister('ctrl+x'); + +// Unregister all shortcuts. +globalShortcut.unregisterAll(); +``` + +## globalShortcut.register(accelerator, callback) + +* `accelerator` [Accelerator](accelerator.md) +* `callback` Function + +Registers a global shortcut of `accelerator`, the `callback` would be called when +the registered shortcut is pressed by user. + +## globalShortcut.isRegistered(accelerator) + +* `accelerator` [Accelerator](accelerator.md) + +Returns `true` or `false` depending on if the shortcut `accelerator` is registered. + +## globalShortcut.unregister(accelerator) + +* `accelerator` [Accelerator](accelerator.md) + +Unregisters the global shortcut of `keycode`. + +## globalShortcut.unregisterAll() + +Unregisters all the global shortcuts. diff --git a/docs/api/ipc-main-process-ko.md b/docs/api/ipc-main-process-ko.md new file mode 100644 index 000000000000..2487737baf52 --- /dev/null +++ b/docs/api/ipc-main-process-ko.md @@ -0,0 +1,49 @@ +# ipc (main process) + +Handles asynchronous and synchronous message sent from a renderer process (web +page). + +The messages sent from a renderer would be emitted to this module, the event name +is the `channel` when sending message. To reply a synchronous message, you need +to set `event.returnValue`, to send an asynchronous back to the sender, you can +use `event.sender.send(...)`. + +It's also possible to send messages from main process to the renderer process, +see [WebContents.send](browser-window.md#webcontentssendchannel-args) for more. + +An example of sending and handling messages: + +```javascript +// In main process. +var ipc = require('ipc'); +ipc.on('asynchronous-message', function(event, arg) { + console.log(arg); // prints "ping" + event.sender.send('asynchronous-reply', 'pong'); +}); + +ipc.on('synchronous-message', function(event, arg) { + console.log(arg); // prints "ping" + event.returnValue = 'pong'; +}); +``` + +```javascript +// In renderer process (web page). +var ipc = require('ipc'); +console.log(ipc.sendSync('synchronous-message', 'ping')); // prints "pong" + +ipc.on('asynchronous-reply', function(arg) { + console.log(arg); // prints "pong" +}); +ipc.send('asynchronous-message', 'ping'); +``` + +## Class: Event + +### Event.returnValue + +Assign to this to return an value to synchronous messages. + +### Event.sender + +The `WebContents` that sent the message. diff --git a/docs/api/ipc-renderer-ko.md b/docs/api/ipc-renderer-ko.md new file mode 100644 index 000000000000..75d26ce5438c --- /dev/null +++ b/docs/api/ipc-renderer-ko.md @@ -0,0 +1,29 @@ +# ipc (renderer) + +The `ipc` module provides a few methods so you can send synchronous and +asynchronous messages to the main process, and also receive messages sent from +main process. If you want to make use of modules of main process from renderer +process, you might consider using the [remote](remote.md) module. + +See [ipc (main process)](ipc-main-process.md) for examples. + +## ipc.send(channel[, args...]) + +Send `args..` to the renderer via `channel` in asynchronous message, the main +process can handle it by listening to the `channel` event of `ipc` module. + +## ipc.sendSync(channel[, args...]) + +Send `args..` to the renderer via `channel` in synchronous message, and returns +the result sent from main process. The main process can handle it by listening to +the `channel` event of `ipc` module, and returns by setting `event.returnValue`. + +**Note:** Usually developers should never use this API, since sending +synchronous message would block the whole renderer process. + +## ipc.sendToHost(channel[, args...]) + +Like `ipc.send` but the message will be sent to the host page instead of the +main process. + +This is mainly used by the page in `` to communicate with host page. diff --git a/docs/api/menu-item-ko.md b/docs/api/menu-item-ko.md index 09c2b782a228..519b7fb237a3 100644 --- a/docs/api/menu-item-ko.md +++ b/docs/api/menu-item-ko.md @@ -1,13 +1,13 @@ -# menu-item +# menu-item ## Class: MenuItem ### new MenuItem(options) * `options` Object - * `click` Function - ޴ Ŭ ȣǴ ݹԼ - * `selector` String - First Responder Ŭ ȣ Ǵ (OS X ) - * `type` String - `MenuItem` Ÿ `normal`, `separator`, `submenu`, `checkbox` Ǵ `radio` 밡 + * `click` Function - 메뉴 아이템이 클릭될 때 호출되는 콜백함수 + * `selector` String - First Responder가 클릭될 때 호출 되는 선택자 (OS X 전용) + * `type` String - `MenuItem`의 타입 `normal`, `separator`, `submenu`, `checkbox` 또는 `radio` 사용가능 * `label` String * `sublabel` String * `accelerator` [Accelerator](accelerator.md) @@ -15,6 +15,6 @@ * `enabled` Boolean * `visible` Boolean * `checked` Boolean - * `submenu` Menu - ޴ մϴ. `type` `submenu` ݵ ؾմϴ. Ϲ ޴ ֽϴ. - * `id` String - ޴ ۿ Ű մϴ. Ű `position` ɼǿ ֽϴ. - * `position` String - ̸ `id` ̿Ͽ ޴ ġ ϰ մϴ. + * `submenu` Menu - 보조메뉴를 설정합니다. `type`이 `submenu`일 경우 반드시 설정해야합니다. 일반 메뉴 아이템일 경우 생략할 수 있습니다. + * `id` String - 현재 메뉴 아이템에 대해 유일키를 지정합니다. 이 키는 이후 `position` 옵션에서 사용할 수 있습니다. + * `position` String - 미리 지정한 `id`를 이용하여 메뉴 아이템의 위치를 세밀하게 조정합니다. diff --git a/docs/api/menu-ko.md b/docs/api/menu-ko.md new file mode 100644 index 000000000000..62e07530f260 --- /dev/null +++ b/docs/api/menu-ko.md @@ -0,0 +1,330 @@ +# menu + +The `Menu` class is used to create native menus that can be used as +application menus and context menus. Each menu consists of multiple menu +items, and each menu item can have a submenu. + +Below is an example of creating a menu dynamically in a web page by using +the [remote](remote.md) module, and showing it when the user right clicks +the page: + +```html + + +``` + +Another example of creating the application menu with the simple template API: + +```html + + +``` + +## Class: Menu + +### new Menu() + +Creates a new menu. + +### Class Method: Menu.setApplicationMenu(menu) + +* `menu` Menu + +Sets `menu` as the application menu on OS X. On Windows and Linux, the `menu` +will be set as each window's top menu. + +### Class Method: Menu.sendActionToFirstResponder(action) + +* `action` String + +Sends the `action` to the first responder of application, this is used for +emulating default Cocoa menu behaviors, usually you would just use the +`selector` property of `MenuItem`. + +**Note:** This method is OS X only. + +### Class Method: Menu.buildFromTemplate(template) + +* `template` Array + +Generally, the `template` is just an array of `options` for constructing +[MenuItem](menu-item.md), the usage can be referenced above. + +You can also attach other fields to element of the `template`, and they will +become properties of the constructed menu items. + +### Menu.popup(browserWindow, [x, y]) + +* `browserWindow` BrowserWindow +* `x` Number +* `y` Number + +Popups this menu as a context menu in the `browserWindow`. You can optionally +provide a `(x,y)` coordinate to place the menu at, otherwise it will be placed +at the current mouse cursor position. + +### Menu.append(menuItem) + +* `menuItem` MenuItem + +Appends the `menuItem` to the menu. + +### Menu.insert(pos, menuItem) + +* `pos` Integer +* `menuItem` MenuItem + +Inserts the `menuItem` to the `pos` position of the menu. + +### Menu.items + +Get the array containing the menu's items. + +## Notes on OS X application menu + +OS X has a completely different style of application menu from Windows and +Linux, and here are some notes on making your app's menu more native-like. + +### Standard menus + +On OS X there are many system defined standard menus, like the `Services` and +`Windows` menus. To make your menu a standard menu, you can just set your menu's +label to one of followings, and Electron will recognize them and make them +become standard menus: + +* `Window` +* `Help` +* `Services` + +### Standard menu item actions + +OS X has provided standard actions for some menu items (which are called +`selector`s), like `About xxx`, `Hide xxx`, and `Hide Others`. To set the action +of a menu item to a standard action, you can set the `selector` attribute of the +menu item. + +### Main menu's name + +On OS X the label of application menu's first item is always your app's name, +no matter what label you set. To change it you have to change your app's name +by modifying your app bundle's `Info.plist` file. See +[About Information Property List Files](https://developer.apple.com/library/ios/documentation/general/Reference/InfoPlistKeyReference/Articles/AboutInformationPropertyListFiles.html) +for more. + + +## Menu item position + +You can make use of `position` and `id` to control how the item would be placed +when building a menu with `Menu.buildFromTemplate`. + +The `position` attribute of `MenuItem` has the form `[placement]=[id]` where +placement is one of `before`, `after`, or `endof` and `id` is the unique ID of +an existing item in the menu: + +* `before` - Inserts this item before the id referenced item. If the + referenced item doesn't exist the item will be inserted at the end of + the menu. +* `after` - Inserts this item after id referenced item. If the referenced + item doesn't exist the item will be inserted at the end of the menu. +* `endof` - Inserts this item at the end of the logical group containing + the id referenced item. (Groups are created by separator items). If + the referenced item doesn't exist a new separator group is created with + the given id and this item is inserted after that separator. + +When an item is positioned following unpositioned items are inserted after +it, until a new item is positioned. So if you want to position a group of +menu items in the same location you only need to specify a position for +the first item. + +### Examples + +Template: + +```javascript +[ + {label: '4', id: '4'}, + {label: '5', id: '5'}, + {label: '1', id: '1', position: 'before=4'}, + {label: '2', id: '2'}, + {label: '3', id: '3'} +] +``` + +Menu: + +``` +- 1 +- 2 +- 3 +- 4 +- 5 +``` + +Template: + +```javascript +[ + {label: 'a', position: 'endof=letters'}, + {label: '1', position: 'endof=numbers'}, + {label: 'b', position: 'endof=letters'}, + {label: '2', position: 'endof=numbers'}, + {label: 'c', position: 'endof=letters'}, + {label: '3', position: 'endof=numbers'} +] +``` + +Menu: + +``` +- --- +- a +- b +- c +- --- +- 1 +- 2 +- 3 +``` diff --git a/docs/api/native-image-ko.md b/docs/api/native-image-ko.md new file mode 100644 index 000000000000..55b896725c3a --- /dev/null +++ b/docs/api/native-image-ko.md @@ -0,0 +1,139 @@ +# NativeImage + +In Electron for the APIs that take images, you can pass either file paths or +`NativeImage` instances. When passing `null`, an empty image will be used. + +For example, when creating a tray or setting a window's icon, you can pass an image +file path as a `String`: + +```javascript +var appIcon = new Tray('/Users/somebody/images/icon.png'); +var window = new BrowserWindow({icon: '/Users/somebody/images/window.png'}); +``` + +Or read the image from the clipboard: + +```javascript +var clipboard = require('clipboard'); +var image = clipboard.readImage(); +var appIcon = new Tray(image); +``` + +## Supported formats + +Currently `PNG` and `JPEG` are supported. It is recommended to use `PNG` +because of its support for transparency and lossless compression. + +## High resolution image + +On platforms that have high-DPI support, you can append `@2x` after image's +file name's base name to mark it as a high resolution image. + +For example if `icon.png` is a normal image that has standard resolution, the +`icon@2x.png` would be treated as a high resolution image that has double DPI +density. + +If you want to support displays with different DPI density at the same time, you +can put images with different sizes in the same folder, and use the filename +without DPI suffixes, like this: + +```text +images/ +├── icon.png +├── icon@2x.png +└── icon@3x.png +``` + + +```javascript +var appIcon = new Tray('/Users/somebody/images/icon.png'); +``` + +Following suffixes as DPI denses are also supported: + +* `@1x` +* `@1.25x` +* `@1.33x` +* `@1.4x` +* `@1.5x` +* `@1.8x` +* `@2x` +* `@2.5x` +* `@3x` +* `@4x` +* `@5x` + +## Template image + +Template images consist of black and clear colors (and an alpha channel). +Template images are not intended to be used as standalone images and are usually +mixed with other content to create the desired final appearance. + +The most common case is to use template image for menu bar icon so it can adapt +to both light and dark menu bars. + +Template image is only supported on Mac. + +To mark an image as template image, its filename should end with the word +`Template`, examples are: + +* `xxxTemplate.png` +* `xxxTemplate@2x.png` + +## nativeImage.createEmpty() + +Creates an empty `NativeImage` instance. + +## nativeImage.createFromPath(path) + +* `path` String + +Creates a new `NativeImage` instance from a file located at `path`. + +## nativeImage.createFromBuffer(buffer[, scaleFactor]) + +* `buffer` [Buffer][buffer] +* `scaleFactor` Double + +Creates a new `NativeImage` instance from `buffer`. The `scaleFactor` is 1.0 by +default. + +## nativeImage.createFromDataUrl(dataUrl) + +* `dataUrl` String + +Creates a new `NativeImage` instance from `dataUrl`. + +## Class: NativeImage + +This class is used to represent an image. + +### NativeImage.toPng() + +Returns a [Buffer][buffer] that contains image's `PNG` encoded data. + +### NativeImage.toJpeg(quality) + +* `quality` Integer + +Returns a [Buffer][buffer] that contains image's `JPEG` encoded data. + +### NativeImage.toDataUrl() + +Returns the data URL of image. + +### NativeImage.isEmpty() + +Returns whether the image is empty. + +### NativeImage.getSize() + +Returns the size of the image. + +[buffer]: https://iojs.org/api/buffer.html#buffer_class_buffer + +### NativeImage.setTemplateImage(option) + +* `option` Boolean + +Marks the image as template image. diff --git a/docs/api/power-monitor-ko.md b/docs/api/power-monitor-ko.md index e21c70a77fea..387ae45389fb 100644 --- a/docs/api/power-monitor-ko.md +++ b/docs/api/power-monitor-ko.md @@ -1,4 +1,4 @@ -# power-monitor +# power-monitor `power-monitor` 모듈은 PC의 파워 상태를 나타냅니다. (주로 노트북 등에서 사용됩니다) 이 모듈은 메인 프로세스에서만 사용할 수 있으며, (remote 모듈(RPC)을 사용해도 작동이 됩니다) diff --git a/docs/api/process-ko.md b/docs/api/process-ko.md new file mode 100644 index 000000000000..29c6e053544f --- /dev/null +++ b/docs/api/process-ko.md @@ -0,0 +1,13 @@ +# Process object + +The `process` object in Electron has the following differences from the one in +upstream node: + +* `process.type` String - Process's type, can be `browser` (i.e. main process) or `renderer`. +* `process.versions['electron']` String - Version of Electron. +* `process.versions['chrome']` String - Version of Chromium. +* `process.resourcesPath` String - Path to JavaScript source code. + +## process.hang + +Causes the main thread of the current process hang. diff --git a/docs/api/protocol-ko.md b/docs/api/protocol-ko.md new file mode 100644 index 000000000000..a66d2d9fb480 --- /dev/null +++ b/docs/api/protocol-ko.md @@ -0,0 +1,121 @@ +# protocol + +The `protocol` module can register a new protocol or intercept an existing +protocol, so you can customize the response to the requests for various protocols. + +An example of implementing a protocol that has the same effect with the +`file://` protocol: + +```javascript +var app = require('app'); +var path = require('path'); + +app.on('ready', function() { + var protocol = require('protocol'); + protocol.registerProtocol('atom', function(request) { + var url = request.url.substr(7) + return new protocol.RequestFileJob(path.normalize(__dirname + '/' + url)); + }); +}); +``` + +**Note:** This module can only be used after the `ready` event +was emitted. + +## protocol.registerProtocol(scheme, handler) + +* `scheme` String +* `handler` Function + +Registers a custom protocol of `scheme`, the `handler` would be called with +`handler(request)` when the a request with registered `scheme` is made. + +You need to return a request job in the `handler` to specify which type of +response you would like to send. + +## protocol.unregisterProtocol(scheme) + +* `scheme` String + +Unregisters the custom protocol of `scheme`. + +## protocol.registerStandardSchemes(value) + +* `value` Array + +`value` is an array of custom schemes to be registered to the standard. + +## protocol.isHandledProtocol(scheme) + +* `scheme` String + +Returns whether the `scheme` can be handled already. + +## protocol.interceptProtocol(scheme, handler) + +* `scheme` String +* `handler` Function + +Intercepts an existing protocol with `scheme`, returning `null` or `undefined` +in `handler` would use the original protocol handler to handle the request. + +## protocol.uninterceptProtocol(scheme) + +* `scheme` String + +Unintercepts a protocol. + +## Class: protocol.RequestFileJob(path) + +* `path` String + +Create a request job which would query a file of `path` and set corresponding +mime types. + +## Class: protocol.RequestStringJob(options) + +* `options` Object + * `mimeType` String - Default is `text/plain` + * `charset` String - Default is `UTF-8` + * `data` String + +Create a request job which sends a string as response. + +## Class: protocol.RequestBufferJob(options) + +* `options` Object + * `mimeType` String - Default is `application/octet-stream` + * `encoding` String - Default is `UTF-8` + * `data` Buffer + +Create a request job which sends a buffer as response. + +## Class: protocol.RequestHttpJob(options) + +* `options` Object + * `url` String + * `method` String - Default is `GET` + * `referrer` String + +Send a request to `url` and pipe the response back. + +## Class: protocol.RequestErrorJob(code) + +* `code` Integer + +Create a request job which sets appropriate network error message to console. +Default message is `net::ERR_NOT_IMPLEMENTED`. Code should be in the following +range. + +* Ranges: + * 0- 99 System related errors + * 100-199 Connection related errors + * 200-299 Certificate errors + * 300-399 HTTP errors + * 400-499 Cache errors + * 500-599 ? + * 600-699 FTP errors + * 700-799 Certificate manager errors + * 800-899 DNS resolver errors + +Check the [network error list](https://code.google.com/p/chromium/codesearch#chromium/src/net/base/net_error_list.h) for code and message relations. diff --git a/docs/api/remote-ko.md b/docs/api/remote-ko.md new file mode 100644 index 000000000000..b7db7a8edb85 --- /dev/null +++ b/docs/api/remote-ko.md @@ -0,0 +1,159 @@ +# remote + +The `remote` module provides a simple way to do inter-process communication +between the renderer process and the main process. + +In Electron, only GUI-unrelated modules are available in the renderer process. +Without the `remote` module, users who wanted to call a main process API in +the renderer process would have to explicitly send inter-process messages +to the main process. With the `remote` module, users can invoke methods of +main process object without explicitly sending inter-process messages, +similar to Java's +[RMI](http://en.wikipedia.org/wiki/Java_remote_method_invocation). + +An example of creating a browser window in renderer process: + +```javascript +var remote = require('remote'); +var BrowserWindow = remote.require('browser-window'); +var win = new BrowserWindow({ width: 800, height: 600 }); +win.loadUrl('https://github.com'); +``` + +Note: for the reverse (access renderer process from main process), you can use [webContents.executeJavascript](https://github.com/atom/electron/blob/master/docs/api/browser-window.md#browserwindowwebcontents). + +## Remote objects + +Each object (including functions) returned by the `remote` module represents an +object in the main process (we call it a remote object or remote function). +When you invoke methods of a remote object, call a remote function, or create +a new object with the remote constructor (function), you are actually sending +synchronous inter-process messages. + +In the example above, both `BrowserWindow` and `win` were remote objects and +`new BrowserWindow` didn't create a `BrowserWindow` object in the renderer process. +Instead, it created a `BrowserWindow` object in the main process and returned the +corresponding remote object in the renderer process, namely the `win` object. + +## Lifetime of remote objects + +Electron makes sure that as long as the remote object in the renderer process +lives (in other words, has not been garbage collected), the corresponding object +in the main process would never be released. When the remote object has been +garbage collected, the corresponding object in the main process would be +dereferenced. + +If the remote object is leaked in renderer process (e.g. stored in a map but never +freed), the corresponding object in the main process would also be leaked, +so you should be very careful not to leak remote objects. + +Primary value types like strings and numbers, however, are sent by copy. + +## Passing callbacks to the main process + +Some APIs in the main process accept callbacks, and it would be tempting to +pass callbacks when calling a remote function. The `remote` module does support +doing this, but you should also be extremely careful with this. + +First, in order to avoid deadlocks, the callbacks passed to the main process +are called asynchronously, so you should not expect the main process to +get the return value of the passed callbacks. + +Second, the callbacks passed to the main process will not get released +automatically after they are called. Instead, they will persistent until the +main process garbage-collects them. + +For example, the following code seems innocent at first glance. It installs a +callback for the `close` event on a remote object: + +```javascript +var remote = require('remote'); +remote.getCurrentWindow().on('close', function() { + // blabla... +}); +``` + +The problem is that the callback would be stored in the main process until you +explicitly uninstall it! So each time you reload your window, the callback would +be installed again and previous callbacks would just leak. To make things +worse, since the context of previously installed callbacks have been released, +when the `close` event was emitted, exceptions would be raised in the main process. + +Generally, unless you are clear what you are doing, you should always avoid +passing callbacks to the main process. + +## Remote buffer + +An instance of node's `Buffer` is an object, so when you get a `Buffer` from +the main process, what you get is indeed a remote object (let's call it remote +buffer), and everything would just follow the rules of remote objects. + +However you should remember that although a remote buffer behaves like the real +`Buffer`, it's not a `Buffer` at all. If you pass a remote buffer to node APIs +that accept a `Buffer`, you should assume the remote buffer would be treated +like a normal object, instead of a `Buffer`. + +For example, you can call `BrowserWindow.capturePage` in the renderer process, which +returns a `Buffer` by calling the passed callback: + +```javascript +var remote = require('remote'); +var fs = require('fs'); +remote.getCurrentWindow().capturePage(function(image) { + var buf = image.toPng(); + fs.writeFile('/tmp/screenshot.png', buf, function(err) { + console.log(err); + }); +}); +``` + +But you may be surprised to find that the file written was corrupted. This is +because when you called `fs.writeFile`, thinking that `buf` was a `Buffer` when +in fact it was a remote buffer, and it was converted to string before it was +written to the file. Since `buf` contained binary data and could not be represented +by a UTF-8 encoded string, the written file was corrupted. + +The work-around is to write the `buf` in the main process, where it is a real +`Buffer`: + +```javascript +var remote = require('remote'); +remote.getCurrentWindow().capturePage(function(image) { + var buf = image.toPng(); + remote.require('fs').writeFile('/tmp/screenshot.png', buf, function(err) { + console.log(err); + }); +}); +``` + +The same thing could happen for all native types, but usually it would just +throw a type error. The `Buffer` deserves your special attention because it +might be converted to string, and APIs accepting `Buffer` usually accept string +too, and data corruption could happen when it contains binary data. + +## remote.require(module) + +* `module` String + +Returns the object returned by `require(module)` in the main process. + +## remote.getCurrentWindow() + +Returns the [BrowserWindow](browser-window.md) object which this web page +belongs to. + +## remote.getCurrentWebContent() + +Returns the WebContents object of this web page. + +## remote.getGlobal(name) + +* `name` String + +Returns the global variable of `name` (e.g. `global[name]`) in the main +process. + +## remote.process + +Returns the `process` object in the main process. This is the same as +`remote.getGlobal('process')`, but gets cached. diff --git a/docs/api/screen-ko.md b/docs/api/screen-ko.md new file mode 100644 index 000000000000..c554863586cc --- /dev/null +++ b/docs/api/screen-ko.md @@ -0,0 +1,105 @@ +# screen + +Gets various info about screen size, displays, cursor position, etc. You should +not use this module until the `ready` event of `app` module gets emitted. + +`screen` is an [EventEmitter](http://nodejs.org/api/events.html#events_class_events_eventemitter). + +Make sure to note that in the renderer / DevTools, `window.screen` is a reserved DOM property, so writing `screen = require('screen')` won't work. In our examples below, we use `atomScreen` as the variable name instead. + +An example of creating a window that fills the whole screen: + +```javascript +var app = require('app'); +var BrowserWindow = require('browser-window'); + +var mainWindow; + +app.on('ready', function() { + var atomScreen = require('screen'); + var size = atomScreen.getPrimaryDisplay().workAreaSize; + mainWindow = new BrowserWindow({ width: size.width, height: size.height }); +}); +``` + +Another example of creating a window in the external display: + +```javascript +var app = require('app'); +var BrowserWindow = require('browser-window'); + +var mainWindow; + +app.on('ready', function() { + var atomScreen = require('screen'); + var displays = atomScreen.getAllDisplays(); + var externalDisplay = null; + for (var i in displays) { + if (displays[i].bounds.x > 0 || displays[i].bounds.y > 0) { + externalDisplay = displays[i]; + break; + } + } + + if (externalDisplay) { + mainWindow = new BrowserWindow({ + x: externalDisplay.bounds.x + 50, + y: externalDisplay.bounds.y + 50, + }); + } +}); +``` + +## Event: display-added + +* `event` Event +* `newDisplay` Object + +Emitted when `newDisplay` has been added. + +## Event: display-removed + +* `event` Event +* `oldDisplay` Object + +Emitted when `oldDisplay` has been removed. + +## Event: display-metrics-changed + +* `event` Event +* `display` Object +* `changedMetrics` Array + +Emitted when a `display` has one or more metrics changed, `changedMetrics` is +an array of strings that describe the changes. Possible changes are `bounds`, +`workArea`, `scaleFactor` and `rotation`. + +## screen.getCursorScreenPoint() + +Returns the current absolute position of the mouse pointer. + +## screen.getPrimaryDisplay() + +Returns the primary display. + +## screen.getAllDisplays() + +Returns an array of displays that are currently available. + +## screen.getDisplayNearestPoint(point) + +* `point` Object + * `x` Integer + * `y` Integer + +Returns the display nearest the specified point. + +## screen.getDisplayMatching(rect) + +* `rect` Object + * `x` Integer + * `y` Integer + * `width` Integer + * `height` Integer + +Returns the display that most closely intersects the provided bounds. diff --git a/docs/api/shell-ko.md b/docs/api/shell-ko.md new file mode 100644 index 000000000000..0d8879637feb --- /dev/null +++ b/docs/api/shell-ko.md @@ -0,0 +1,39 @@ +# shell + +The `shell` module provides functions related to desktop integration. + +An example of opening a URL in default browser: + +```javascript +var shell = require('shell'); +shell.openExternal('https://github.com'); +``` + +## shell.showItemInFolder(fullPath) + +* `fullPath` String + +Show the given file in a file manager. If possible, select the file. + +## shell.openItem(fullPath) + +* `fullPath` String + +Open the given file in the desktop's default manner. + +## shell.openExternal(url) + +* `url` String + +Open the given external protocol URL in the desktop's default manner. (For +example, mailto: URLs in the default mail user agent.) + +## shell.moveItemToTrash(fullPath) + +* `fullPath` String + +Move the given file to trash and returns boolean status for the operation. + +## shell.beep() + +Play the beep sound. diff --git a/docs/api/synopsis-ko.md b/docs/api/synopsis-ko.md new file mode 100644 index 000000000000..89c897c3bc4d --- /dev/null +++ b/docs/api/synopsis-ko.md @@ -0,0 +1,44 @@ +# Synopsis + +All of [node.js's built-in modules](http://nodejs.org/api/) are available in +Electron, and third-party node modules are fully supported too (including the +[native modules](../tutorial/using-native-node-modules.md)). + +Electron also provides some extra built-in modules for developing native +desktop applications. Some modules are only available on the main process, some +are only available on the renderer process, and some can be used on both processes. +The basic rule is: if a module is GUI or low-level system related, then it should +be only available on the main process. You need to be familiar with the concept of +[main process vs. renderer process](../tutorial/quick-start.md#the-main-process) +scripts to be able to use those modules. + +The main process script is just like a normal `node.js` script: + +```javascript +var app = require('app'); +var BrowserWindow = require('browser-window'); + +var window = null; + +app.on('ready', function() { + window = new BrowserWindow({width: 800, height: 600}); + window.loadUrl('https://github.com'); +}); +``` + +The web page is no different than a normal web page, except for the extra +ability to use node modules: + +```html + + + + + + +``` + +To run your app, read [Run your app](../tutorial/quick-start.md#run-your-app). diff --git a/docs/api/tray-ko.md b/docs/api/tray-ko.md index 2678b6812dc8..145302b65f65 100644 --- a/docs/api/tray-ko.md +++ b/docs/api/tray-ko.md @@ -1,4 +1,4 @@ -# Tray +# Tray `Tray`는 OS의 알림영역에 아이콘을 표시합니다. 보통 컨텍스트 메뉴(context menu)를 같이 사용합니다. diff --git a/docs/api/web-frame-ko.md b/docs/api/web-frame-ko.md new file mode 100644 index 000000000000..71f61d09ea45 --- /dev/null +++ b/docs/api/web-frame-ko.md @@ -0,0 +1,66 @@ +# web-frame + +The `web-frame` module can custom the rendering of current web page. + +An example of zooming current page to 200%. + +```javascript +var webFrame = require('web-frame'); +webFrame.setZoomFactor(2); +``` + +## webFrame.setZoomFactor(factor) + +* `factor` Number - Zoom factor + +Changes the zoom factor to the specified factor, zoom factor is +zoom percent / 100, so 300% = 3.0. + +## webFrame.getZoomFactor() + +Returns the current zoom factor. + +## webFrame.setZoomLevel(level) + +* `level` Number - Zoom level + +Changes the zoom level to the specified level, 0 is "original size", and each +increment above or below represents zooming 20% larger or smaller to default +limits of 300% and 50% of original size, respectively. + +## webFrame.getZoomLevel() + +Returns the current zoom level. + +## webFrame.setSpellCheckProvider(language, autoCorrectWord, provider) + +* `language` String +* `autoCorrectWord` Boolean +* `provider` Object + +Sets a provider for spell checking in input fields and text areas. + +The `provider` must be an object that has a `spellCheck` method that returns +whether the word passed is correctly spelled. + +An example of using [node-spellchecker][spellchecker] as provider: + +```javascript +require('web-frame').setSpellCheckProvider("en-US", true, { + spellCheck: function(text) { + return !(require('spellchecker').isMisspelled(text)); + } +}); +``` + +## webFrame.registerUrlSchemeAsSecure(scheme) + +* `scheme` String + +Sets the `scheme` as secure scheme. + +Secure schemes do not trigger mixed content warnings. For example, `https` and +`data` are secure schemes because they cannot be corrupted by active network +attackers. + +[spellchecker]: https://github.com/atom/node-spellchecker diff --git a/docs/api/web-view-tag-ko.md b/docs/api/web-view-tag-ko.md index 198deec8dd6c..2ff07ccc126f 100644 --- a/docs/api/web-view-tag-ko.md +++ b/docs/api/web-view-tag-ko.md @@ -1,4 +1,4 @@ -# `` ± +# `` 태그 Use the `webview` tag to embed 'guest' content (such as web pages) in your Electron app. The guest content is contained within the `webview` container; @@ -10,7 +10,7 @@ app; it doesn't have the same permissions as your web page and all interactions between your app and embedded content will be asynchronous. This keeps your app safe from the embedded content. -## +## 예제 To embed a web page in your app, add the `webview` tag to your app's embedder page (this is the app page that will display the guest content). In its simplest @@ -45,7 +45,7 @@ and displays a "loading..." message during the load time: ``` -## ± Ӽ +## 태그 속성 ### src @@ -308,7 +308,7 @@ page can handle it by listening to the `channel` event of `ipc` module. See [WebContents.send](browser-window-ko.md#webcontentssendchannel-args) for examples. -## DOM ̺Ʈ +## DOM 이벤트 ### did-finish-load diff --git a/docs/api/window-open-ko.md b/docs/api/window-open-ko.md new file mode 100644 index 000000000000..dccba9121bff --- /dev/null +++ b/docs/api/window-open-ko.md @@ -0,0 +1,60 @@ +# `window.open` function + +When `window.open` is called to create a new window in web page, a new instance +of `BrowserWindow` will be created for the `url`, and a proxy will be returned +to `window.open` to let the page to have limited control over it. + +The proxy only has some limited standard functionality implemented to be +compatible with traditional web pages, for full control of the created window +you should create a `BrowserWindow` directly. + +## window.open(url, [frameName[, features]]) + +* `url` String +* `frameName` String +* `features` String + +Creates a new window and returns an instance of `BrowserWindowProxy` class. + +## window.opener.postMessage(message, targetOrigin) + +* `message` String +* `targetOrigin` String + +Sends a message to the parent window with the specified origin or `*` for no +origin preference. + +## Class: BrowserWindowProxy + +### BrowserWindowProxy.blur() + +Removes focus from the child window. + +### BrowserWindowProxy.close() + +Forcefully closes the child window without calling its unload event. + +### BrowserWindowProxy.closed + +Set to true after the child window gets closed. + +### BrowserWindowProxy.eval(code) + +* `code` String + +Evaluates the code in the child window. + +### BrowserWindowProxy.focus() + +Focuses the child window (brings the window to front). + +### BrowserWindowProxy.postMessage(message, targetOrigin) + +* `message` String +* `targetOrigin` String + +Sends a message to the child window with the specified origin or `*` for no +origin preference. + +In addition to these methods, the child window implements `window.opener` object +with no properties and a single method: diff --git a/docs/development/atom-shell-vs-node-webkit-ko.md b/docs/development/atom-shell-vs-node-webkit-ko.md index efecb3abdec5..f688204d537d 100644 --- a/docs/development/atom-shell-vs-node-webkit-ko.md +++ b/docs/development/atom-shell-vs-node-webkit-ko.md @@ -1,49 +1,34 @@ -# NW.js와 기술적으로 다른점 (이전 node-webkit) +# NW.js와 기술적으로 다른점 (이전 node-webkit) __알림: Electron은 이전까지 Atom Shell로 불려졌습니다.__ -Like NW.js, Electron provides a platform to write desktop applications -with JavaScript and HTML and has Node integration to grant access to low level -system in web pages. +NW.js 처럼 Electron은 JavaScript와 HTML 그리고 Node 통합환경을 제공함으로써 웹 페이지에서 저수준 시스템에 접근할 수 있는 웹 기반 데스크탑 어플리케이션을 작성할 수 있도록 합니다. -But there are also fundamental differences between the two projects that make -Electron a completely separate product from NW.js: +하지만 Electron과 NW.js는 근본적인 개발흐름의 차이도 있습니다: __1. 어플리케이션의 엔트리 포인트__ -In NW.js, the main entry of an application is a web page. You specify a -main page in the `package.json` and it is opened in a browser window as -the application's main window. +NW.js에선 어플리케이션의 엔트리 포인트로 웹 페이지를 사용합니다. +`package.json`내의 main 필드에 메인 웹 페이지(index.html) 파일을 지정하면 어플리케이션의 메인 윈도우로 열리게 됩니다. -In Electron, the entry point is a JavaScript script. Instead of -providing a URL directly, you manually create a browser window and load -an HTML file using the API. You also need to listen to window events -to decide when to quit the application. +Electron에선 JavaScript를 엔트리 포인트로 사용합니다. URL을 직접 제공하는 대신 API를 사용하여 직접 브라우저 창과 HTML 파일을 로드할 수 있습니다. +또한 윈도우의 종료시기를 결정하는 이벤트를 리스닝해야합니다. -Electron works more like the Node.js runtime. Electron's APIs are lower level -so you can use it for browser testing in place of [PhantomJS](http://phantomjs.org/). +Electron은 Node.js 런타임과 비슷하게 작동합니다. Electron의 API는 저수준이기에 브라우저 테스팅을 위해 [PhantomJS](http://phantomjs.org/)를 사용할 수도 있습니다. __2. 빌드 시스템__ -In order to avoid the complexity of building the whole Chromium, Electron uses -[libchromiumcontent](https://github.com/brightray/libchromiumcontent) to access -Chromium's Content API. libchromiumcontent is a single, shared library that -includes the Chromium Content module and all its dependencies. Users don't -need a powerful machine to build Electron. +Electron은 Chromium의 모든것을 빌드하는 복잡성을 피하기 위해 [libchromiumcontent](https://github.com/brightray/libchromiumcontent)를 사용하여 +Chromium의 Content API에 접근합니다. libchromiumcontent은 단일 공유 라이브러리이고 Chromium Content 모듈과 종속성 라이브러리들을 포함합니다. +유저는 Electron을 빌드 하기 위해 높은 사양의 빌드용 컴퓨터를 구비할 필요가 없습니다. __3. Node 통합__ -In NW.js, the Node integration in web pages requires patching Chromium to -work, while in Electron we chose a different way to integrate libuv loop with -each platform's message loop to avoid hacking Chromium. See the -[`node_bindings`](../../atom/common/) code for how that was done. +NW.js는 웹 페이지에서 require를 사용할 수 있도록 Chromium을 패치했습니다. 한편 Electron은 Chromium의 해킹을 방지하기 위해 libuv loop와 각 플랫폼의 메시지 루프에 통합하는 등의 다른 방법을 채택하였습니다. +[`node_bindings`](../../atom/common/) 코드를 보면 이 부분이 어떻게 구현됬는지를 알 수 있습니다. __4. 다중 컨텍스트__ -If you are an experienced NW.js user, you should be familiar with the -concept of Node context and web context. These concepts were invented because -of how NW.js was implemented. +만약 NW.js를 사용해본적이 있다면 Node context와 Web context의 개념을 잘 알고 있을겁니다. 이 개념은 NW.js가 구현된 방식에 따라 만들어졌습니다. -By using the [multi-context](http://strongloop.com/strongblog/whats-new-node-js-v0-12-multiple-context-execution/) -feature of Node, Electron doesn't introduce a new JavaScript context in web -pages. +Node의 [다중 컨텍스트](http://strongloop.com/strongblog/whats-new-node-js-v0-12-multiple-context-execution/)를 사용할 경우 Electron은 웹 페이지에서 새로운 JavaScript 컨텍스트를 생성하지 않습니다. diff --git a/docs/development/build-instructions-linux-ko.md b/docs/development/build-instructions-linux-ko.md index 57a8b3ec6403..d70e27967ea6 100644 --- a/docs/development/build-instructions-linux-ko.md +++ b/docs/development/build-instructions-linux-ko.md @@ -2,16 +2,14 @@ ## 빌드전 요구사양 -* Python 2.7.x. Some distributions like CentOS still use Python 2.6.x -so you may need to check your Python version with `python -V`. -* Node.js v0.12.x. There are various ways to install Node. One can download -source code from [Node.js] (http://nodejs.org) and compile from source. -Doing so permits installing Node to your own home directory as a standard user. -Or try repositories such as [NodeSource] (https://nodesource.com/blog/nodejs-v012-iojs-and-the-nodesource-linux-repositories) -* Clang 3.4 or later -* Development headers of GTK+ and libnotify +* Python 2.7.x. 몇몇 CentOS와 같은 배포판들은 아직도 Python 2.6.x 버전을 사용합니다. 그래서 `python -V`를 통해 버전을 확인해 줄 필요가 있습니다. +* Node.js v0.12.x. Node를 설치하는 방법은 여러가지가 있습니다. 그중 하나는 [Node.js](http://nodejs.org) 사이트에서 소스코드를 받아 빌드하는 방법입니다. +이렇게 하면 Node를 일반 유저로 홈 디렉터리에 설치할 수 있습니다. 또는 [NodeSource](https://nodesource.com/blog/nodejs-v012-iojs-and-the-nodesource-linux-repositories) 에서 받아올 수도 있습니다. +자세한 내용은 [Node.js 설치 방법](https://github.com/joyent/node/wiki/Installation) 을 참고하세요. +* Clang 3.4 또는 최신 버전 +* GTK+ 와 libnotify의 개발용 헤더 -On Ubuntu, install the following libraries: +Ubuntu를 사용하고 있다면 다음 커맨드로 설치하면 합니다: ```bash $ sudo apt-get install build-essential clang libdbus-1-dev libgtk2.0-dev \ @@ -20,14 +18,12 @@ $ sudo apt-get install build-essential clang libdbus-1-dev libgtk2.0-dev \ libxss1 gcc-multilib g++-multilib ``` -Other distributions may offer similar packages for installation via package -managers such as yum. Or one can compile from source code. - +다른 배포판의 경우 yum과 같은 패키지 매니저를 통해 패키지를 설치 할 수 있습니다. 패키지의 이름은 대부분 비슷할 것입니다. +또는 소스코드를 내려받아 직접 빌드하는 방법도 있습니다. ## 가상머신을 사용하여 빌드 하는 경우 -If you plan to build electron on a virtual machine, you will need a fixed-size -device container of at least 25 gigabytes in size. +만약 Electron을 가상머신으로 빌드 할 계획이라면 해당 가상머신의 스토리지를 최소 25GB 이상을 확보해 놓아야 합니다. ## 코드 가져오기 @@ -38,10 +34,10 @@ $ git clone https://github.com/atom/electron.git ## 부트 스트랩 -The bootstrap script will download all necessary build dependencies and create -build project files. You must have Python 2.7.x for the script to succeed. -Downloading certain files could take a long time. Notice that we are using -`ninja` to build Electron so there is no `Makefile` generated. +부트스트랩 스크립트는 필수적인 빌드 종속성 라이브러리들을 모두 다운로드하고 프로젝트 파일을 생성합니다. +스크립트가 정상적으로 작동하기 위해선 Python 2.7.x 버전이 필요합니다. +아마 다운로드 작업이 상당히 많은 시간을 소요할 것입니다. +참고로 Electron은 빌드 툴체인으로 `ninja`를 사용하므로 `Makefile`은 생성되지 않습니다. ```bash $ cd electron @@ -50,48 +46,42 @@ $ ./script/bootstrap.py -v ## 빌드 하기 -If you would like to build both `Release` and `Debug` targets: +`Release` 와 `Debug` 두 타겟 모두 빌드 합니다: ```bash $ ./script/build.py ``` -This script will cause a very large Electron executable to be placed in -the directory `out/R`. The file size is in excess of 1.3 gigabytes. This -happens because the Release target binary contains debugging symbols. -To reduce the file size, run the `create-dist.py` script: +이 스크립트는 `out/R` 디렉터리에 크기가 매우 큰 Electron 실행 파일을 배치합니다. 파일 크기는 1.3GB를 초과합니다. +이러한 문제가 발생하는 이유는 Release 타겟 바이너리가 디버그 심볼을 포함하기 때문입니다. +파일 크기를 줄이려면 `create-dist.py` 스크립트를 실행하세요: ```bash $ ./script/create-dist.py ``` -This will put a working distribution with much smaller file sizes in -the `dist` directory. After running the create-dist.py script, you -may want to remove the 1.3+ gigabyte binary which is still in out/R. +이 스크립트는 매우 작은 배포판을 `dist` 디렉터리에 생성합니다. +create-dist.py 스크립트를 실행한 이후 1.3GB를 초과하는 공간을 차지하는 out/R 폴더의 실행파일 바이너리는 삭제해도 됩니다. -You can also build the `Debug` target only: +`Debug` 타겟만 빌드 할 수도 있습니다: ```bash $ ./script/build.py -c D ``` -After building is done, you can find the `electron` debug binary -under `out/D`. - +빌드가 모두 끝나면 `out/D` 디렉터리에서 `electron` 디버그 바이너리를 찾을 수 있습니다. ## 정리 하기 - -To clean the build files: +빌드 파일들을 정리합니다: ```bash $ ./script/clean.py ``` - ## 문제 해결 -Make sure you have installed all the build dependencies. +개발 종속성 라이브러리들을 제대로 설치했는지 확인하세요. ## 테스트 diff --git a/docs/development/build-instructions-mac-ko.md b/docs/development/build-instructions-mac-ko.md index 13a73ccf5194..6608c2e45266 100644 --- a/docs/development/build-instructions-mac-ko.md +++ b/docs/development/build-instructions-mac-ko.md @@ -6,8 +6,7 @@ * [Xcode](https://developer.apple.com/technologies/tools/) >= 5.1 * [node.js](http://nodejs.org) (external). -If you are using the python downloaded by Homebrew, you also need to install -following python modules: +만약 Homebrew를 이용해 파이선을 설치했다면 다음 파이선 모듈도 같이 설치해야 합니다: * pyobjc @@ -19,9 +18,8 @@ $ git clone https://github.com/atom/electron.git ## 부트 스트랩 -The bootstrap script will download all necessary build dependencies and create -build project files. Notice that we're using `ninja` to build Electron so -there is no Xcode project generated. +부트스트랩 스크립트는 필수적인 빌드 종속성 라이브러리들을 모두 다운로드하고 프로젝트 파일을 생성합니다. +참고로 Electron은 빌드 툴체인으로 `ninja`를 사용하므로 Xcode 프로젝트는 생성되지 않습니다. ```bash $ cd electron @@ -30,24 +28,23 @@ $ ./script/bootstrap.py -v ## 빌드 하기 -Build both `Release` and `Debug` targets: +`Release` 와 `Debug` 두 타겟 모두 빌드 합니다: ```bash $ ./script/build.py ``` -You can also only build the `Debug` target: +`Debug` 타겟만 빌드 할 수도 있습니다: ```bash $ ./script/build.py -c D ``` -After building is done, you can find `Electron.app` under `out/D`. +빌드가 모두 끝나면 `out/D` 디렉터리에서 `Electron.app` 실행 파일을 찾을 수 있습니다. ## 32비트 지원 -Electron can only be built for 64bit target on OS X, and there is no plan to -support 32bit OS X in future. +Electron은 현재 OS X 64비트 빌드만 지원하고 있습니다. 그리고 앞으로도 OS X 32비트는 지원할 계획이 없습니다. ## 테스트 diff --git a/docs/development/build-instructions-windows-ko.md b/docs/development/build-instructions-windows-ko.md index 492ec824f7be..3611bcddf722 100644 --- a/docs/development/build-instructions-windows-ko.md +++ b/docs/development/build-instructions-windows-ko.md @@ -1,25 +1,23 @@ -# 빌드 설명서 (Windows) +# 빌드 설명서 (Windows) ## 빌드전 요구 사항 -* Windows 7 / Server 2008 R2 or higher -* Visual Studio 2013 - [download VS 2013 Community Edition for - free](http://www.visualstudio.com/products/visual-studio-community-vs) +* Windows 7 / Server 2008 R2 또는 최신 버전 +* Visual Studio 2013 - [VS 2013 커뮤니티 에디션 무료 다운로드](http://www.visualstudio.com/products/visual-studio-community-vs) * [Python 2.7](http://www.python.org/download/releases/2.7/) * [Node.js](http://nodejs.org/download/) * [git](http://git-scm.com) +아직 Windows를 설치하지 않았다면 [modern.ie](https://www.modern.ie/en-us/virtualization-tools#downloads)에서 Electron을 빌드할 수 있는 timebombed Windows 버전을 확인할 수 있습니다. + If you don't have a Windows installation at the moment, [modern.ie](https://www.modern.ie/en-us/virtualization-tools#downloads) has timebombed versions of Windows that you can use to build Electron. -The building of Electron is done entirely with command-line scripts, so you -can use any editor you like to develop Electron, but it also means you can -not use Visual Studio for the development. Support of building with Visual -Studio will come in the future. +Electron은 전적으로 command-line 스크립트를 사용하여 빌드합니다. 그렇기에 Electron을 개발하는데 아무런 에디터나 사용할 수 있습니다. +하지만 이 말은 Visual Studio를 개발을 위해 사용할 수 없다는 말이 됩니다. 나중에 Visual Studio를 이용한 빌드 방법도 제공할 예정입니다. -**Note:** Even though Visual Studio is not used for building, it's still -**required** because we need the build toolchains it provided. +**참고:** Visual Studio가 빌드에 사용되지 않더라도 제공된 빌드 툴체인이 **필수적으로** 사용되므로 여전히 필요합니다. ## 코드 가져오기 @@ -29,9 +27,8 @@ git clone https://github.com/atom/electron.git ## 부트 스트랩 -The bootstrap script will download all necessary build dependencies and create -build project files. Notice that we're using `ninja` to build Electron so -there is no Visual Studio project generated. +부트스트랩 스크립트는 필수적인 빌드 종속성 라이브러리들을 모두 다운로드하고 프로젝트 파일을 생성합니다. +참고로 Electron은 빌드 툴체인으로 `ninja`를 사용하므로 Visual Studio 프로젝트는 생성되지 않습니다. ```powershell cd electron @@ -40,30 +37,29 @@ python script\bootstrap.py -v ## 빌드 하기 -Build both Release and Debug targets: +`Release` 와 `Debug` 두 타겟 모두 빌드 합니다: ```powershell python script\build.py ``` -You can also only build the Debug target: +`Debug` 타겟만 빌드 할 수도 있습니다: ```powershell python script\build.py -c D ``` -After building is done, you can find `atom.exe` under `out\D`. +빌드가 모두 끝나면 `out/D` 디렉터리에서 `atom.exe` 실행 파일을 찾을 수 있습니다. ## 64비트 빌드 -To build for the 64bit target, you need to pass `--target_arch=x64` when running -the bootstrap script: +64비트를 타겟으로 빌드 하려면 부트스트랩 스크립트를 실행할 때 `--target_arch=x64` 인자를 같이 넘겨주면 됩니다: ```powershell python script\bootstrap.py -v --target_arch=x64 ``` -The other building steps are exactly the same. +다른 빌드 단계도 정확하게 같습니다. ## 테스트 @@ -75,17 +71,15 @@ python script\test.py ### Command xxxx not found -If you encountered an error like `Command xxxx not found`, you may try to use -the `VS2012 Command Prompt` console to execute the build scripts. +만약 `Command xxxx not found`와 같은 형식의 에러가 발생했다면 `VS2012 Command Prompt` 콘솔로 빌드 스크립트를 실행해볼 필요가 있습니다. ### Fatal internal compiler error: C1001 -Make sure you have the latest Visual Studio update installed. +Visual Studio가 업데이트까지 완벽하게 설치된 최신버전인지 확인하세요. ### Assertion failed: ((handle))->activecnt >= 0 -If building under Cygwin, you may see `bootstrap.py` failed with following -error: +Cygwin에서 빌드 할 경우 `bootstrap.py` 스크립트가 다음의 에러와 함께 빌드에 실패할 수 있습니다: ``` Assertion failed: ((handle))->activecnt >= 0, file src\win\pipe.c, line 1430 @@ -102,9 +96,8 @@ Traceback (most recent call last): subprocess.CalledProcessError: Command '['npm.cmd', 'install']' returned non-zero exit status 3 ``` -This is caused by a bug when using Cygwin python and Win32 node together. The -solution is to use the Win32 python to execute the bootstrap script (supposing -you have installed python under `C:\Python27`): +이 버그는 Cygwin python과 Win32 node를 같이 사용할 경우 발생합니다. +부트스트랩 스크립트에서 Win32 python을 사용함으로써 이 문제를 해결할 수 있습니다 (`C:\Python27` 디렉터리에 python이 설치되었다는 것을 가정하면): ```bash /cygdrive/c/Python27/python.exe script/bootstrap.py @@ -112,11 +105,11 @@ you have installed python under `C:\Python27`): ### LNK1181: cannot open input file 'kernel32.lib' -Try reinstalling 32bit node.js. +32bit node.js를 다시 설치하세요. ### Error: ENOENT, stat 'C:\Users\USERNAME\AppData\Roaming\npm' -Simply making that directory [should fix the problem](http://stackoverflow.com/a/25095327/102704): +간단하게 해당 디렉터리를 생성하면 [문제가 해결될 겁니다](http://stackoverflow.com/a/25095327/102704): ```powershell mkdir ~\AppData\Roaming\npm @@ -124,5 +117,4 @@ mkdir ~\AppData\Roaming\npm ### node-gyp is not recognized as an internal or external command -You may get this error if you are using Git Bash for building, you should use -PowerShell or VS2012 Command Prompt instead. +Git Bash로 빌드 했을 때 이러한 에러가 발생할 수 있습니다. 반드시 PowerShell이나 VS2012 Command Prompt에서 빌드를 진행해야 합니다. diff --git a/docs/development/build-system-overview-ko.md b/docs/development/build-system-overview-ko.md index 4967b28c6426..92fd50008529 100644 --- a/docs/development/build-system-overview-ko.md +++ b/docs/development/build-system-overview-ko.md @@ -1,64 +1,51 @@ -# 빌드 시스템 개요 +# 빌드 시스템 개요 -Electron uses `gyp` for project generation, and `ninja` for building, project -configurations can be found in `.gyp` and `.gypi` files. +Electron은 프로젝트 생성을 위해 `gyp`를 사용하며 `ninja`를 이용하여 빌드합니다. +프로젝트 설정은 `.gyp` 와 `.gypi` 파일에서 볼 수 있습니다. -## Gyp 파일들 +## gyp 파일들 -Following `gyp` files contain the main rules of building Electron: +Electron을 빌드 할 때 `gyp` 파일들은 다음과 같은 규칙을 따릅니다: -* `atom.gyp` defines how Electron itself is built. -* `common.gypi` adjusts the build configurations of Node to make it build - together with Chromium. -* `vendor/brightray/brightray.gyp` defines how `brightray` is built, and - includes the default configurations of linking with Chromium. -* `vendor/brightray/brightray.gypi` includes general build configurations about - building. +* `atom.gyp`는 Electron의 빌드 과정 자체를 정의합니다. +* `common.gypi`는 Node가 Chromium과 함께 빌드될 수 있도록 조정한 빌드 설정입니다. +* `vendor/brightray/brightray.gyp`는 `brightray`의 빌드 과정을 정의하고 Chromium과의 링킹에 대한 기본적인 설정을 포함합니다. +* `vendor/brightray/brightray.gypi`는 빌드에 대한 일반적인 설정이 포함되어 있습니다. ## 구성요소 빌드 -Since Chromium is quite a large project, the final linking stage would take -quite a few minutes, making it hard for development. In order to solve this, -Chromium introduced the "component build", which builds each component as a -separate shared library, making linking very quick but sacrificing file size -and performance. +Chromium은 꽤나 큰 프로젝트입니다. 이 때문에 최종 링킹 작업은 상당한 시간이 소요될 수 있습니다. +이러한 문제로 인해 개발 시 빌드 작업을 까다롭게 만듭니다. 이 문제를 해결하기 위해 Chromium은 "component build"를 도입했습니다. +이는 각각의 컴포넌트를 각각 따로 분리하여 공유 라이브러리로 빌드 합니다. 이렇게 되면 링킹작업은 매우 빨라지지만 파일 크기와 성능이 느려집니다. -In Electron we took a very similar approach: for `Debug` builds, the binary -will be linked to shared library version of Chromium's components to achieve -fast linking time; for `Release` builds, the binary will be linked to the static -library versions, so we can have the best possible binary size and performance. +Electron도 상당히 비슷한 접근을 했습니다: +`Debug`빌드 시 바이너리는 공유 라이브러리 버전의 Chromium 컴포넌트를 사용해서 링크 속도를 높이고 +`Release`빌드 시엔 정적 라이브러리 버전의 컴포넌트를 사용합니다. +이렇게 각 빌드의 단점을 상호 보완하여 디버그 시 빌드 속도는 향상되고 배포판 빌드 시 공유 라이브러리의 단점은 제거했습니다. ## 부트스트랩 최소화 -All of Chromium's prebuilt binaries are downloaded when running the bootstrap -script. By default both static libraries and shared libraries will be -downloaded and the final size should be between 800MB and 2GB according to the -platform. +모든 사전 빌드 된 Chromium 바이너리들은 부트스트랩 스크립트가 실행될 때 다운로드됩니다. +기본적으로 공유 라이브러리와 정적 라이브러리 모두 다운로드되며 최종 전체 파일 크기는 플랫폼에 따라 800MB에서 2GB까지 차지합니다. -If you only want to build Electron quickly for testing or development, you -can only download the shared library versions by passing the `--dev` parameter: +만약 빠르게 Electron의 개발 또는 테스트만 하고 싶다면 `--dev` 플래그를 추가하여 공유 라이브러리만 다운로드할 수 있습니다: ```bash $ ./script/bootstrap.py --dev $ ./script/build.py -c D ``` -## Two-phrase 프로젝트 생성 +## 프로젝트 생성 (two-phrase) -Electron links with different sets of libraries in `Release` and `Debug` -builds, however `gyp` doesn't support configuring different link settings for -different configurations. +Electron은 `Release`와 `Debug` 빌드가 서로 다른 라이브러리 링크 방식을 사용합니다. +그러나 `gyp`는 따로 빌드 설정을 분리하여 라이브러리 링크 방식을 정의하는 것을 지원하지 않습니다. -To work around this Electron uses a `gyp` variable -`libchromiumcontent_component` to control which link settings to use, and only -generates one target when running `gyp`. +이러한 문제를 해결하기 위해 Electron은 링크 설정을 제어하는 `gyp` 변수 `libchromiumcontent_component`를 사용하고 `gyp`를 실행할 때 단 하나의 타겟만을 생성합니다. ## 타겟 이름 -Unlike most projects that use `Release` and `Debug` as target names, Electron -uses `R` and `D` instead. This is because `gyp` randomly crashes if there is -only one `Release` or `Debug` build configuration is defined, and Electron has -to only generate one target for one time as stated above. +많은 프로젝트에서 타겟 이름을 `Release` 와 `Debug`를 사용하는데 반해 Electron은 `R`과 `D`를 대신 사용합니다. +이유는 가끔 알 수 없는 이유(randomly)로 `Release` 와 `Debug` 중 하나만 빌드 설정에 정의되어 있을때 `gyp`가 크래시를 일으키는데 +전술한 바와 같이 Electron은 한번에 한개의 타겟만을 생성할 수 있기 때문입니다. -This only affects developers, if you are only building Electron for rebranding -you are not affected. +이 문제는 개발자에게만 영향을 미칩니다. 만약 단순히 Electron을 rebranding 하기 위해 빌드 한다면 이 문제에 신경 쓸 필요가 없습니다. diff --git a/docs/development/coding-style-ko.md b/docs/development/coding-style-ko.md index fc2d1f498dfa..92aa3b4ed173 100644 --- a/docs/development/coding-style-ko.md +++ b/docs/development/coding-style-ko.md @@ -8,15 +8,15 @@ C++과 Python스크립트는 Chromium의 [코딩 스타일](http://www.chromium. ## CoffeeScript -CoffeeScript의 경우 GitHub의 [스타일 가이드](https://github.com/styleguide/javascript)를 따릅니다, 동시에 다음 규칙도 따릅니다: +CoffeeScript의 경우 GitHub의 [스타일 가이드](https://github.com/styleguide/javascript)를 따릅니다. 동시에 다음 규칙도 따릅니다: -* Google의 코딩 스타일에도 맞추기 위해, 파일의 끝에는 **절대** 개행을 삽입해선 안됩니다. +* Google의 코딩 스타일에도 맞추기 위해 파일의 끝에는 **절대** 개행을 삽입해선 안됩니다. * 파일 이름의 공백은 `_`대신에 `-`을 사용하여야 합니다. 예를 들어 `file_name.coffee`를 -`file-name.coffee`로 고쳐야합니다, 왜냐하면 [github/atom](https://github.com/github/atom) 에서 사용되는 모듈의 이름은 -보통 `module-name`형식이기 때문입니다, 이 규칙은 '.coffee' 파일에만 적용됩니다. +`file-name.coffee`로 고쳐야합니다. 왜냐하면 [github/atom](https://github.com/github/atom) 에서 사용되는 모듈의 이름은 +보통 `module-name`형식이기 때문입니다. 이 규칙은 '.coffee' 파일에만 적용됩니다. ## API 이름 -새로운 API를 만들 땐, getter, setter스타일 대신 jQuery의 one-function스타일을 사용해야 합니다. 예를 들어, +새로운 API를 만들 땐 getter, setter스타일 대신 jQuery의 one-function스타일을 사용해야 합니다. 예를 들어 `.getText()`와 `.setText(text)`대신에 `.text([text])`형식으로 설계하면 됩니다. 포럼에 이 문제에 대한 [논의](https://github.com/atom/electron/issues/46)가 있습니다. diff --git a/docs/development/source-code-directory-structure-ko.md b/docs/development/source-code-directory-structure-ko.md index 8b768b115748..f0c9cde40780 100644 --- a/docs/development/source-code-directory-structure-ko.md +++ b/docs/development/source-code-directory-structure-ko.md @@ -39,8 +39,8 @@ Electron의 소스 코드는 몇 개의 파트로 분리되어 있습니다. 우 ## 그외 디렉터리 구조 * **script** - 개발목적으로 사용되는 빌드, 패키징, 테스트, 기타등을 실행하는 스크립트. -* **tools** - gyp 파일에서 사용되는 헬퍼 스크립트, `script`와는 다르게 유저로부터 직접 실행되지 않는 스크립트들을 이곳에 넣습니다. -* **vendor** - 소스코드의 서드파티 종속성 코드, 소스 코드 디렉터리가 겹쳐 혼란을 일으킬 수 있기 때문에, +* **tools** - gyp 파일에서 사용되는 헬퍼 스크립트 `script`와는 다르게 유저로부터 직접 실행되지 않는 스크립트들을 이곳에 넣습니다. +* **vendor** - 소스코드의 서드파티 종속성 코드 소스 코드 디렉터리가 겹쳐 혼란을 일으킬 수 있기 때문에 우리는 `third_party`와 같은 Chromium 소스 코드 디렉터리에서 사용된 폴더 이름을 사용하지 않았습니다. * **node_modules** - 빌드에 사용되는 node 서드파티 모듈. * **out** - `ninja`의 임시 출력 디렉터리. diff --git a/docs/tutorial/application-distribution-ko.md b/docs/tutorial/application-distribution-ko.md index 43d9ce7f695f..a1bb5bc65044 100644 --- a/docs/tutorial/application-distribution-ko.md +++ b/docs/tutorial/application-distribution-ko.md @@ -23,12 +23,12 @@ electron/resources/app └── index.html ``` -그리고 `Electron.app`을 실행하면 (Linux에선 `electron` Windows에선 `electron.exe`입니다), Electron은 해당 앱을 실행시킵니다. +그리고 `Electron.app`을 실행하면(Linux에선 `electron` Windows에선 `electron.exe`입니다) Electron은 해당 앱을 실행시킵니다. 최종 사용자에게는 이 `electron` 폴더(Electron.app)를 배포하면 됩니다. ## asar로 앱 패키징 하기 -소스파일 전체를 복사해서 배포하는 것과는 별개로, [asar](https://github.com/atom/asar) 아카이브를 통해 +소스파일 전체를 복사해서 배포하는 것과는 별개로 [asar](https://github.com/atom/asar) 아카이브를 통해 어플리케이션의 소스코드가 사용자에게 노출되는 것을 방지할 수 있습니다. `asar` 아카이브를 사용할 땐 단순히 `app` 폴더 대신에 어플리케이션을 패키징한 `app.asar` 파일로 대체하면됩니다. @@ -52,7 +52,7 @@ electron/resources/ ## 다운로드한 바이너리의 리소스를 앱에 맞게 수정하기 -어플리케이션을 Electron에 번들링한 후, 해당 어플리케이션에 맞게 리브랜딩 할 수 있습니다. +어플리케이션을 Electron에 번들링한 후 해당 어플리케이션에 맞게 리브랜딩 할 수 있습니다. ### Windows diff --git a/docs/tutorial/application-packaging-ko.md b/docs/tutorial/application-packaging-ko.md index 31314a1c9c0c..da72a9b2954a 100644 --- a/docs/tutorial/application-packaging-ko.md +++ b/docs/tutorial/application-packaging-ko.md @@ -1,6 +1,6 @@ # 어플리케이션 패키징 -어플리케이션의 리소스와 소스코드를 유저로부터 보호하기 위해, 약간의 구조 변경으로 어플리케이션을 [asar][asar] 아카이브로 패키징 할 수 있습니다. +어플리케이션의 리소스와 소스코드를 유저로부터 보호하기 위해 약간의 구조 변경으로 어플리케이션을 [asar][asar] 아카이브로 패키징 할 수 있습니다. ## `asar` 아카이브 생성 @@ -23,7 +23,7 @@ $ asar pack your-app app.asar ## `asar` 아카이브 사용하기 -Electron은 두가지의 API를 가지고 있습니다: Node.js로 부터 제공된 Node API, Chromium으로부터 제공된 Web API. +Electron은 Node.js로 부터 제공된 Node API와 Chromium으로부터 제공된 Web API 두가지의 API를 가지고 있습니다. 두 API 모두 `asar`에서 읽어들일 수 있도록 지원합니다. ### Node API @@ -31,7 +31,7 @@ Electron은 두가지의 API를 가지고 있습니다: Node.js로 부터 제공 `fs.readFile` 와 `require` 같은 Node API들을 지원하기 위해 Electron에선 `asar` 아카이브가 가상의 디렉터리 구조를 가지도록 패치했습니다. 그래서 아카이브 내부에서 리소스들을 정상적인 파일 시스템처럼 접근할 수 있습니다. -예를들어, `/path/to`라는 경로에 `example.asar`라는 아카이브가 있다고 가정하면: +예를들어 `/path/to`라는 경로에 `example.asar`라는 아카이브가 있다고 가정하면: ```bash $ asar list /path/to/example.asar @@ -73,10 +73,10 @@ win.loadUrl('file:///path/to/example.asar/static/index.html'); ### Web API -웹 페이지 내에선, 아카이브 내의 파일을 `file:` 프로토콜을 사용하여 요청할 수 있습니다. +웹 페이지 내에선 아카이브 내의 파일을 `file:` 프로토콜을 사용하여 요청할 수 있습니다. 이 또한 Node API와 같이 가상 디렉터리 구조를 가집니다. -예를들어, jQuery의 `$.get`을 사용하여 파일을 가져올 수 있습니다: +예를들어 jQuery의 `$.get`을 사용하여 파일을 가져올 수 있습니다: ```html + + diff --git a/spec/webview-spec.coffee b/spec/webview-spec.coffee index a1a1724380cc..451276adf49a 100644 --- a/spec/webview-spec.coffee +++ b/spec/webview-spec.coffee @@ -191,6 +191,14 @@ describe ' tag', -> webview.src = "file://#{fixtures}/pages/a.html" document.body.appendChild webview + describe 'close event', -> + it 'should fire when interior page calls window.close', -> + webview.addEventListener 'close', -> + done() + + webview.src = "file://#{fixtures}/pages/close.html" + document.body.appendChild webview + describe '.reload()', -> it 'should emit beforeunload handler', (done) -> listener = (e) -> @@ -217,6 +225,6 @@ describe ' tag', -> webview.removeEventListener 'ipc-message', listener done() webview.addEventListener 'ipc-message', listener - webview.setAttribute 'nodeintegration', 'on' + webview.setAttribute 'nodeintegration', 'on' webview.src = "file://#{fixtures}/pages/history.html" document.body.appendChild webview From 7b19b6b4f2dc72c03aa9be4a3a279b7d6a617dd7 Mon Sep 17 00:00:00 2001 From: Hank Bao Date: Thu, 9 Jul 2015 12:30:37 +0800 Subject: [PATCH 0566/1293] Update global-shortcut.md Make it clear that the `global-shortcut` module should not be used until the ready event of app module gets emitted. --- docs/api/global-shortcut.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/api/global-shortcut.md b/docs/api/global-shortcut.md index 871357f89f9f..95fd5caf1fe8 100644 --- a/docs/api/global-shortcut.md +++ b/docs/api/global-shortcut.md @@ -3,6 +3,7 @@ The `global-shortcut` module can register/unregister a global keyboard shortcut in operating system, so that you can customize the operations for various shortcuts. Note that the shortcut is global, even if the app does not get focused, it will still work. +You should not use this module until the ready event of app module gets emitted. ```javascript var globalShortcut = require('global-shortcut'); From fb99bfac526e7dbbd085d223787841ad714715e1 Mon Sep 17 00:00:00 2001 From: Hank Bao Date: Thu, 9 Jul 2015 17:03:58 +0800 Subject: [PATCH 0567/1293] Update sample code in global-shortcut.md --- docs/api/global-shortcut.md | 29 ++++++++++++++++++----------- 1 file changed, 18 insertions(+), 11 deletions(-) diff --git a/docs/api/global-shortcut.md b/docs/api/global-shortcut.md index 95fd5caf1fe8..d9a77ce6ce30 100644 --- a/docs/api/global-shortcut.md +++ b/docs/api/global-shortcut.md @@ -6,23 +6,30 @@ Note that the shortcut is global, even if the app does not get focused, it will You should not use this module until the ready event of app module gets emitted. ```javascript +var app = require('app'); var globalShortcut = require('global-shortcut'); -// Register a 'ctrl+x' shortcut listener. -var ret = globalShortcut.register('ctrl+x', function() { console.log('ctrl+x is pressed'); }) +app.on('ready', function() { + // Register a 'ctrl+x' shortcut listener. + var ret = globalShortcut.register('ctrl+x', function() { + console.log('ctrl+x is pressed'); + }) -if (!ret) { - console.log('registration failed'); -} + if (!ret) { + console.log('registration failed'); + } -// Check whether a shortcut is registered. -console.log(globalShortcut.isRegistered('ctrl+x')); + // Check whether a shortcut is registered. + console.log(globalShortcut.isRegistered('ctrl+x')); +}); -// Unregister a shortcut. -globalShortcut.unregister('ctrl+x'); +app.on('will-quit', function() { + // Unregister a shortcut. + globalShortcut.unregister('ctrl+x'); -// Unregister all shortcuts. -globalShortcut.unregisterAll(); + // Unregister all shortcuts. + globalShortcut.unregisterAll(); +}); ``` ## globalShortcut.register(accelerator, callback) From da00329d78869bab7d3d8be08dd1d87893ede0ff Mon Sep 17 00:00:00 2001 From: Robo Date: Sun, 5 Jul 2015 23:23:07 +0530 Subject: [PATCH 0568/1293] protocol: cleanup --- atom/browser/api/atom_api_protocol.cc | 111 ++++++++++++------ atom/browser/api/atom_api_protocol.h | 20 +++- .../net/atom_url_request_job_factory.cc | 20 ++-- .../net/atom_url_request_job_factory.h | 4 +- docs/api/protocol.md | 7 +- spec/api-protocol-spec.coffee | 50 +++++--- 6 files changed, 138 insertions(+), 74 deletions(-) diff --git a/atom/browser/api/atom_api_protocol.cc b/atom/browser/api/atom_api_protocol.cc index e298ec790940..a6d37237632e 100644 --- a/atom/browser/api/atom_api_protocol.cc +++ b/atom/browser/api/atom_api_protocol.cc @@ -25,12 +25,16 @@ namespace mate { template<> struct Converter { static v8::Local ToV8(v8::Isolate* isolate, - const net::URLRequest* val) { - return mate::ObjectTemplateBuilder(isolate) - .SetValue("method", val->method()) - .SetValue("url", val->url().spec()) - .SetValue("referrer", val->referrer()) - .Build()->NewInstance(); + const net::URLRequest* val) { + if (val) { + return mate::ObjectTemplateBuilder(isolate) + .SetValue("method", val->method()) + .SetValue("url", val->url().spec()) + .SetValue("referrer", val->referrer()) + .Build()->NewInstance(); + } else { + return v8::Null(isolate); + } } }; @@ -65,7 +69,7 @@ class CustomProtocolRequestJob : public AdapterRequestJob { // AdapterRequestJob: void GetJobTypeInUI() override { - DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI)); + DCHECK_CURRENTLY_ON(BrowserThread::UI); v8::Locker locker(registry_->isolate()); v8::HandleScope handle_scope(registry_->isolate()); @@ -73,7 +77,8 @@ class CustomProtocolRequestJob : public AdapterRequestJob { // Call the JS handler. Protocol::JsProtocolHandler callback = registry_->GetProtocolHandler(request()->url().scheme()); - v8::Local result = callback.Run(request()); + v8::Local result = + callback.Run(v8::Null(registry_->isolate()), request()); // Determine the type of the job we are going to create. if (result->IsString()) { @@ -202,6 +207,51 @@ Protocol::JsProtocolHandler Protocol::GetProtocolHandler( return protocol_handlers_[scheme]; } +void Protocol::OnRegisterProtocol(const std::string& scheme, + const JsProtocolHandler& callback, + bool is_handled) { + DCHECK_CURRENTLY_ON(BrowserThread::UI); + v8::Locker locker(isolate()); + v8::HandleScope handle_scope(isolate()); + + if (is_handled || ContainsKey(protocol_handlers_, scheme)) { + callback.Run(v8::Exception::Error( + mate::StringToV8(isolate(), "The Scheme is already registered")), + nullptr); + return; + } + + protocol_handlers_[scheme] = callback; + BrowserThread::PostTask(BrowserThread::IO, FROM_HERE, + base::Bind(&Protocol::RegisterProtocolInIO, + base::Unretained(this), scheme)); +} + +void Protocol::OnInterceptProtocol(const std::string& scheme, + const JsProtocolHandler& callback, + bool is_handled) { + DCHECK_CURRENTLY_ON(BrowserThread::UI); + v8::Locker locker(isolate()); + v8::HandleScope handle_scope(isolate()); + if (!is_handled) { + callback.Run(v8::Exception::Error( + mate::StringToV8(isolate(), "Scheme does not exist.")), nullptr); + return; + } + + if (ContainsKey(protocol_handlers_, scheme)) { + callback.Run(v8::Exception::Error( + mate::StringToV8(isolate(), "Cannot intercept custom protocols.")), + nullptr); + return; + } + + protocol_handlers_[scheme] = callback; + BrowserThread::PostTask(BrowserThread::IO, FROM_HERE, + base::Bind(&Protocol::InterceptProtocolInIO, + base::Unretained(this), scheme)); +} + mate::ObjectTemplateBuilder Protocol::GetObjectTemplateBuilder( v8::Isolate* isolate) { return mate::ObjectTemplateBuilder(isolate) @@ -216,15 +266,10 @@ mate::ObjectTemplateBuilder Protocol::GetObjectTemplateBuilder( void Protocol::RegisterProtocol(v8::Isolate* isolate, const std::string& scheme, const JsProtocolHandler& callback) { - if (ContainsKey(protocol_handlers_, scheme) || - job_factory_->IsHandledProtocol(scheme)) - return node::ThrowError(isolate, "The scheme is already registered"); - - protocol_handlers_[scheme] = callback; - BrowserThread::PostTask(BrowserThread::IO, - FROM_HERE, - base::Bind(&Protocol::RegisterProtocolInIO, - base::Unretained(this), scheme)); + IsHandledProtocol(scheme, + base::Bind(&Protocol::OnRegisterProtocol, + base::Unretained(this), + scheme, callback)); } void Protocol::UnregisterProtocol(v8::Isolate* isolate, @@ -245,24 +290,22 @@ void Protocol::RegisterStandardSchemes( atom::AtomBrowserClient::SetCustomSchemes(schemes); } -bool Protocol::IsHandledProtocol(const std::string& scheme) { - return job_factory_->IsHandledProtocol(scheme); +void Protocol::IsHandledProtocol(const std::string& scheme, + const CompletionCallback& callback) { + BrowserThread::PostTaskAndReplyWithResult(BrowserThread::IO, FROM_HERE, + base::Bind(&AtomURLRequestJobFactory::IsHandledProtocol, + base::Unretained(job_factory_), scheme), + callback); } void Protocol::InterceptProtocol(v8::Isolate* isolate, const std::string& scheme, const JsProtocolHandler& callback) { - if (!job_factory_->HasProtocolHandler(scheme)) - return node::ThrowError(isolate, "Scheme does not exist."); - - if (ContainsKey(protocol_handlers_, scheme)) - return node::ThrowError(isolate, "Cannot intercept custom procotols"); - - protocol_handlers_[scheme] = callback; - BrowserThread::PostTask(BrowserThread::IO, - FROM_HERE, - base::Bind(&Protocol::InterceptProtocolInIO, - base::Unretained(this), scheme)); + BrowserThread::PostTaskAndReplyWithResult(BrowserThread::IO, FROM_HERE, + base::Bind(&AtomURLRequestJobFactory::HasProtocolHandler, + base::Unretained(job_factory_), scheme), + base::Bind(&Protocol::OnInterceptProtocol, + base::Unretained(this), scheme, callback)); } void Protocol::UninterceptProtocol(v8::Isolate* isolate, @@ -279,7 +322,7 @@ void Protocol::UninterceptProtocol(v8::Isolate* isolate, } void Protocol::RegisterProtocolInIO(const std::string& scheme) { - DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO)); + DCHECK_CURRENTLY_ON(BrowserThread::IO); job_factory_->SetProtocolHandler(scheme, new CustomProtocolHandler(this)); BrowserThread::PostTask(BrowserThread::UI, @@ -290,7 +333,7 @@ void Protocol::RegisterProtocolInIO(const std::string& scheme) { } void Protocol::UnregisterProtocolInIO(const std::string& scheme) { - DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO)); + DCHECK_CURRENTLY_ON(BrowserThread::IO); job_factory_->SetProtocolHandler(scheme, NULL); BrowserThread::PostTask(BrowserThread::UI, @@ -301,7 +344,7 @@ void Protocol::UnregisterProtocolInIO(const std::string& scheme) { } void Protocol::InterceptProtocolInIO(const std::string& scheme) { - DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO)); + DCHECK_CURRENTLY_ON(BrowserThread::IO); ProtocolHandler* original_handler = job_factory_->GetProtocolHandler(scheme); if (original_handler == NULL) { @@ -322,7 +365,7 @@ void Protocol::InterceptProtocolInIO(const std::string& scheme) { } void Protocol::UninterceptProtocolInIO(const std::string& scheme) { - DCHECK(BrowserThread::CurrentlyOn(BrowserThread::IO)); + DCHECK_CURRENTLY_ON(BrowserThread::IO); CustomProtocolHandler* handler = static_cast( job_factory_->GetProtocolHandler(scheme)); diff --git a/atom/browser/api/atom_api_protocol.h b/atom/browser/api/atom_api_protocol.h index 1b17b630c5e6..147b9e1912a9 100644 --- a/atom/browser/api/atom_api_protocol.h +++ b/atom/browser/api/atom_api_protocol.h @@ -26,8 +26,10 @@ namespace api { class Protocol : public mate::EventEmitter { public: - typedef base::Callback(const net::URLRequest*)> - JsProtocolHandler; + using JsProtocolHandler = + base::Callback(v8::Local, + const net::URLRequest*)>; + using CompletionCallback = base::Callback; static mate::Handle Create( v8::Isolate* isolate, AtomBrowserContext* browser_context); @@ -46,6 +48,15 @@ class Protocol : public mate::EventEmitter { private: typedef std::map ProtocolHandlersMap; + // Callback called if protocol can be registered. + void OnRegisterProtocol(const std::string& scheme, + const JsProtocolHandler& callback, + bool is_handled); + // Callback called if protocol can be intercepted. + void OnInterceptProtocol(const std::string& scheme, + const JsProtocolHandler& callback, + bool is_handled); + // Register schemes to standard scheme list. void RegisterStandardSchemes(const std::vector& schemes); @@ -57,9 +68,8 @@ class Protocol : public mate::EventEmitter { void UnregisterProtocol(v8::Isolate* isolate, const std::string& scheme); // Returns whether a scheme has been registered. - // FIXME Should accept a callback and be asynchronous so we do not have to use - // locks. - bool IsHandledProtocol(const std::string& scheme); + void IsHandledProtocol(const std::string& scheme, + const CompletionCallback& callback); // Intercept/unintercept an existing protocol handler. void InterceptProtocol(v8::Isolate* isolate, diff --git a/atom/browser/net/atom_url_request_job_factory.cc b/atom/browser/net/atom_url_request_job_factory.cc index ed1fb97e2c1c..00942b2ad057 100644 --- a/atom/browser/net/atom_url_request_job_factory.cc +++ b/atom/browser/net/atom_url_request_job_factory.cc @@ -6,9 +6,12 @@ #include "atom/browser/net/atom_url_request_job_factory.h" #include "base/stl_util.h" +#include "content/public/browser/browser_thread.h" #include "net/base/load_flags.h" #include "net/url_request/url_request.h" +using content::BrowserThread; + namespace atom { typedef net::URLRequestJobFactory::ProtocolHandler ProtocolHandler; @@ -22,9 +25,7 @@ AtomURLRequestJobFactory::~AtomURLRequestJobFactory() { bool AtomURLRequestJobFactory::SetProtocolHandler( const std::string& scheme, ProtocolHandler* protocol_handler) { - DCHECK(CalledOnValidThread()); - - base::AutoLock locked(lock_); + DCHECK_CURRENTLY_ON(BrowserThread::IO); if (!protocol_handler) { ProtocolHandlerMap::iterator it = protocol_handler_map_.find(scheme); @@ -45,10 +46,9 @@ bool AtomURLRequestJobFactory::SetProtocolHandler( ProtocolHandler* AtomURLRequestJobFactory::ReplaceProtocol( const std::string& scheme, ProtocolHandler* protocol_handler) { - DCHECK(CalledOnValidThread()); + DCHECK_CURRENTLY_ON(BrowserThread::IO); DCHECK(protocol_handler); - base::AutoLock locked(lock_); if (!ContainsKey(protocol_handler_map_, scheme)) return nullptr; ProtocolHandler* original_protocol_handler = protocol_handler_map_[scheme]; @@ -58,9 +58,8 @@ ProtocolHandler* AtomURLRequestJobFactory::ReplaceProtocol( ProtocolHandler* AtomURLRequestJobFactory::GetProtocolHandler( const std::string& scheme) const { - DCHECK(CalledOnValidThread()); + DCHECK_CURRENTLY_ON(BrowserThread::IO); - base::AutoLock locked(lock_); ProtocolHandlerMap::const_iterator it = protocol_handler_map_.find(scheme); if (it == protocol_handler_map_.end()) return nullptr; @@ -69,7 +68,6 @@ ProtocolHandler* AtomURLRequestJobFactory::GetProtocolHandler( bool AtomURLRequestJobFactory::HasProtocolHandler( const std::string& scheme) const { - base::AutoLock locked(lock_); return ContainsKey(protocol_handler_map_, scheme); } @@ -77,9 +75,8 @@ net::URLRequestJob* AtomURLRequestJobFactory::MaybeCreateJobWithProtocolHandler( const std::string& scheme, net::URLRequest* request, net::NetworkDelegate* network_delegate) const { - DCHECK(CalledOnValidThread()); + DCHECK_CURRENTLY_ON(BrowserThread::IO); - base::AutoLock locked(lock_); ProtocolHandlerMap::const_iterator it = protocol_handler_map_.find(scheme); if (it == protocol_handler_map_.end()) return nullptr; @@ -101,7 +98,8 @@ net::URLRequestJob* AtomURLRequestJobFactory::MaybeInterceptResponse( bool AtomURLRequestJobFactory::IsHandledProtocol( const std::string& scheme) const { - DCHECK(CalledOnValidThread()); + DCHECK_CURRENTLY_ON(BrowserThread::IO); + return HasProtocolHandler(scheme) || net::URLRequest::IsHandledProtocol(scheme); } diff --git a/atom/browser/net/atom_url_request_job_factory.h b/atom/browser/net/atom_url_request_job_factory.h index a083e51483c7..ce2a18a85e66 100644 --- a/atom/browser/net/atom_url_request_job_factory.h +++ b/atom/browser/net/atom_url_request_job_factory.h @@ -56,12 +56,10 @@ class AtomURLRequestJobFactory : public net::URLRequestJobFactory { bool IsSafeRedirectTarget(const GURL& location) const override; private: - typedef std::map ProtocolHandlerMap; + using ProtocolHandlerMap = std::map; ProtocolHandlerMap protocol_handler_map_; - mutable base::Lock lock_; - DISALLOW_COPY_AND_ASSIGN(AtomURLRequestJobFactory); }; diff --git a/docs/api/protocol.md b/docs/api/protocol.md index c6dd373b586c..dbcdb577ca9c 100644 --- a/docs/api/protocol.md +++ b/docs/api/protocol.md @@ -28,7 +28,7 @@ was emitted. * `handler` Function Registers a custom protocol of `scheme`, the `handler` would be called with -`handler(request)` when the a request with registered `scheme` is made. +`handler(error, request)` when the a request with registered `scheme` is made. You need to return a request job in the `handler` to specify which type of response you would like to send. @@ -45,11 +45,12 @@ Unregisters the custom protocol of `scheme`. `value` is an array of custom schemes to be registered to the standard. -## protocol.isHandledProtocol(scheme) +## protocol.isHandledProtocol(scheme, callback) * `scheme` String +* `callback` Function -Returns whether the `scheme` can be handled already. +`callback` returns a boolean whether the `scheme` can be handled already. ## protocol.interceptProtocol(scheme, handler) diff --git a/spec/api-protocol-spec.coffee b/spec/api-protocol-spec.coffee index 3ad1cbd91fad..4fb00b9a2d4f 100644 --- a/spec/api-protocol-spec.coffee +++ b/spec/api-protocol-spec.coffee @@ -7,17 +7,19 @@ protocol = remote.require 'protocol' describe 'protocol module', -> describe 'protocol.registerProtocol', -> - it 'throws error when scheme is already registered', (done) -> - register = -> protocol.registerProtocol('test1', ->) + it 'error when scheme is already registered', (done) -> + register = -> + protocol.registerProtocol 'test1', (error, request) -> + assert error instanceof Error + protocol.unregisterProtocol 'test1' + done() protocol.once 'registered', (event, scheme) -> assert.equal scheme, 'test1' - assert.throws register, /The scheme is already registered/ - protocol.unregisterProtocol 'test1' - done() + register() register() it 'calls the callback when scheme is visited', (done) -> - protocol.registerProtocol 'test2', (request) -> + protocol.registerProtocol 'test2', (error, request) -> assert.equal request.url, 'test2://test2' protocol.unregisterProtocol 'test2' done() @@ -169,16 +171,28 @@ describe 'protocol module', -> protocol.unregisterProtocol 'atom-file-job' describe 'protocol.isHandledProtocol', -> - it 'returns true if the scheme can be handled', -> - assert.equal protocol.isHandledProtocol('file'), true - assert.equal protocol.isHandledProtocol('http'), true - assert.equal protocol.isHandledProtocol('https'), true - assert.equal protocol.isHandledProtocol('atom'), false + it 'returns true if the file scheme can be handled', (done) -> + protocol.isHandledProtocol 'file', (result) -> + assert.equal result, true + done() + it 'returns true if the http scheme can be handled', (done) -> + protocol.isHandledProtocol 'http', (result) -> + assert.equal result, true + done() + it 'returns true if the https scheme can be handled', (done) -> + protocol.isHandledProtocol 'https', (result) -> + assert.equal result, true + done() + it 'returns false if the atom scheme cannot be handled', (done) -> + protocol.isHandledProtocol 'atom', (result) -> + assert.equal result, false + done() describe 'protocol.interceptProtocol', -> - it 'throws error when scheme is not a registered one', -> - register = -> protocol.interceptProtocol('test-intercept', ->) - assert.throws register, /Scheme does not exist/ + it 'throws error when scheme is not a registered one', (done) -> + protocol.interceptProtocol 'test-intercept', (error, request) -> + assert error instanceof Error + done() it 'throws error when scheme is a custom protocol', (done) -> protocol.once 'unregistered', (event, scheme) -> @@ -186,9 +200,9 @@ describe 'protocol module', -> done() protocol.once 'registered', (event, scheme) -> assert.equal scheme, 'atom' - register = -> protocol.interceptProtocol('test-intercept', ->) - assert.throws register, /Scheme does not exist/ - protocol.unregisterProtocol scheme + protocol.interceptProtocol 'test-intercept', (error, request) -> + assert error instanceof Error + protocol.unregisterProtocol scheme protocol.registerProtocol('atom', ->) it 'returns original job when callback returns nothing', (done) -> @@ -206,7 +220,7 @@ describe 'protocol module', -> error: (xhr, errorType, error) -> free() assert false, 'Got error: ' + errorType + ' ' + error - protocol.interceptProtocol targetScheme, (request) -> + protocol.interceptProtocol targetScheme, (error, request) -> if process.platform is 'win32' pathInUrl = path.normalize request.url.substr(8) assert.equal pathInUrl.toLowerCase(), __filename.toLowerCase() From 2cd5fb5694cf0ab50955c3a7b40cc4e07ad64c40 Mon Sep 17 00:00:00 2001 From: Robo Date: Tue, 7 Jul 2015 20:13:13 +0530 Subject: [PATCH 0569/1293] add compatibility will old api --- atom/browser/api/atom_api_protocol.cc | 152 +++++++++++--------------- atom/browser/api/atom_api_protocol.h | 33 +++--- atom/browser/api/lib/protocol.coffee | 23 ++++ docs/api/protocol.md | 17 ++- spec/api-protocol-spec.coffee | 43 ++++---- 5 files changed, 139 insertions(+), 129 deletions(-) diff --git a/atom/browser/api/atom_api_protocol.cc b/atom/browser/api/atom_api_protocol.cc index a6d37237632e..fa498a7fa99c 100644 --- a/atom/browser/api/atom_api_protocol.cc +++ b/atom/browser/api/atom_api_protocol.cc @@ -25,16 +25,12 @@ namespace mate { template<> struct Converter { static v8::Local ToV8(v8::Isolate* isolate, - const net::URLRequest* val) { - if (val) { - return mate::ObjectTemplateBuilder(isolate) - .SetValue("method", val->method()) - .SetValue("url", val->url().spec()) - .SetValue("referrer", val->referrer()) - .Build()->NewInstance(); - } else { - return v8::Null(isolate); - } + const net::URLRequest* val) { + return mate::ObjectTemplateBuilder(isolate) + .SetValue("method", val->method()) + .SetValue("url", val->url().spec()) + .SetValue("referrer", val->referrer()) + .Build()->NewInstance(); } }; @@ -77,8 +73,7 @@ class CustomProtocolRequestJob : public AdapterRequestJob { // Call the JS handler. Protocol::JsProtocolHandler callback = registry_->GetProtocolHandler(request()->url().scheme()); - v8::Local result = - callback.Run(v8::Null(registry_->isolate()), request()); + v8::Local result = callback.Run(request()); // Determine the type of the job we are going to create. if (result->IsString()) { @@ -208,81 +203,88 @@ Protocol::JsProtocolHandler Protocol::GetProtocolHandler( } void Protocol::OnRegisterProtocol(const std::string& scheme, - const JsProtocolHandler& callback, - bool is_handled) { + const JsProtocolHandler& handler, + const JsCompletionCallback& callback, + int is_handled) { DCHECK_CURRENTLY_ON(BrowserThread::UI); v8::Locker locker(isolate()); v8::HandleScope handle_scope(isolate()); if (is_handled || ContainsKey(protocol_handlers_, scheme)) { callback.Run(v8::Exception::Error( - mate::StringToV8(isolate(), "The Scheme is already registered")), - nullptr); + mate::StringToV8(isolate(), "The Scheme is already registered"))); return; } - protocol_handlers_[scheme] = callback; - BrowserThread::PostTask(BrowserThread::IO, FROM_HERE, - base::Bind(&Protocol::RegisterProtocolInIO, - base::Unretained(this), scheme)); + protocol_handlers_[scheme] = handler; + BrowserThread::PostTaskAndReply(BrowserThread::IO, FROM_HERE, + base::Bind(&Protocol::RegisterProtocolInIO, + base::Unretained(this), scheme), + base::Bind(callback, v8::Null(isolate()))); } void Protocol::OnInterceptProtocol(const std::string& scheme, - const JsProtocolHandler& callback, - bool is_handled) { + const JsProtocolHandler& handler, + const JsCompletionCallback& callback, + int is_handled) { DCHECK_CURRENTLY_ON(BrowserThread::UI); v8::Locker locker(isolate()); v8::HandleScope handle_scope(isolate()); if (!is_handled) { callback.Run(v8::Exception::Error( - mate::StringToV8(isolate(), "Scheme does not exist.")), nullptr); + mate::StringToV8(isolate(), "Scheme does not exist."))); return; } if (ContainsKey(protocol_handlers_, scheme)) { callback.Run(v8::Exception::Error( - mate::StringToV8(isolate(), "Cannot intercept custom protocols.")), - nullptr); + mate::StringToV8(isolate(), "Cannot intercept custom protocols."))); return; } - protocol_handlers_[scheme] = callback; - BrowserThread::PostTask(BrowserThread::IO, FROM_HERE, - base::Bind(&Protocol::InterceptProtocolInIO, - base::Unretained(this), scheme)); + protocol_handlers_[scheme] = handler; + BrowserThread::PostTaskAndReply(BrowserThread::IO, FROM_HERE, + base::Bind(&Protocol::InterceptProtocolInIO, + base::Unretained(this), scheme), + base::Bind(callback, v8::Null(isolate()))); } mate::ObjectTemplateBuilder Protocol::GetObjectTemplateBuilder( v8::Isolate* isolate) { return mate::ObjectTemplateBuilder(isolate) - .SetMethod("registerProtocol", &Protocol::RegisterProtocol) - .SetMethod("unregisterProtocol", &Protocol::UnregisterProtocol) + .SetMethod("_registerProtocol", &Protocol::RegisterProtocol) + .SetMethod("_unregisterProtocol", &Protocol::UnregisterProtocol) .SetMethod("registerStandardSchemes", &Protocol::RegisterStandardSchemes) .SetMethod("isHandledProtocol", &Protocol::IsHandledProtocol) - .SetMethod("interceptProtocol", &Protocol::InterceptProtocol) - .SetMethod("uninterceptProtocol", &Protocol::UninterceptProtocol); + .SetMethod("_interceptProtocol", &Protocol::InterceptProtocol) + .SetMethod("_uninterceptProtocol", &Protocol::UninterceptProtocol); } void Protocol::RegisterProtocol(v8::Isolate* isolate, const std::string& scheme, - const JsProtocolHandler& callback) { + const JsProtocolHandler& handler, + const JsCompletionCallback& callback) { IsHandledProtocol(scheme, base::Bind(&Protocol::OnRegisterProtocol, base::Unretained(this), - scheme, callback)); + scheme, handler, callback)); } void Protocol::UnregisterProtocol(v8::Isolate* isolate, - const std::string& scheme) { + const std::string& scheme, + const JsCompletionCallback& callback) { ProtocolHandlersMap::iterator it(protocol_handlers_.find(scheme)); - if (it == protocol_handlers_.end()) - return node::ThrowError(isolate, "The scheme has not been registered"); + if (it == protocol_handlers_.end()) { + callback.Run(v8::Exception::Error( + mate::StringToV8(isolate, "The Scheme has not been registered"))); + return; + } protocol_handlers_.erase(it); - BrowserThread::PostTask(BrowserThread::IO, - FROM_HERE, - base::Bind(&Protocol::UnregisterProtocolInIO, - base::Unretained(this), scheme)); + BrowserThread::PostTaskAndReply(BrowserThread::IO, FROM_HERE, + base::Bind(&Protocol::UnregisterProtocolInIO, + base::Unretained(this), scheme), + base::Bind(callback, v8::Null(isolate))); } void Protocol::RegisterStandardSchemes( @@ -291,7 +293,7 @@ void Protocol::RegisterStandardSchemes( } void Protocol::IsHandledProtocol(const std::string& scheme, - const CompletionCallback& callback) { + const net::CompletionCallback& callback) { BrowserThread::PostTaskAndReplyWithResult(BrowserThread::IO, FROM_HERE, base::Bind(&AtomURLRequestJobFactory::IsHandledProtocol, base::Unretained(job_factory_), scheme), @@ -300,68 +302,54 @@ void Protocol::IsHandledProtocol(const std::string& scheme, void Protocol::InterceptProtocol(v8::Isolate* isolate, const std::string& scheme, - const JsProtocolHandler& callback) { + const JsProtocolHandler& handler, + const JsCompletionCallback& callback) { BrowserThread::PostTaskAndReplyWithResult(BrowserThread::IO, FROM_HERE, base::Bind(&AtomURLRequestJobFactory::HasProtocolHandler, base::Unretained(job_factory_), scheme), base::Bind(&Protocol::OnInterceptProtocol, - base::Unretained(this), scheme, callback)); + base::Unretained(this), scheme, handler, callback)); } void Protocol::UninterceptProtocol(v8::Isolate* isolate, - const std::string& scheme) { + const std::string& scheme, + const JsCompletionCallback& callback) { ProtocolHandlersMap::iterator it(protocol_handlers_.find(scheme)); - if (it == protocol_handlers_.end()) - return node::ThrowError(isolate, "The scheme has not been registered"); + if (it == protocol_handlers_.end()) { + callback.Run(v8::Exception::Error( + mate::StringToV8(isolate, "The Scheme has not been registered"))); + return; + } protocol_handlers_.erase(it); - BrowserThread::PostTask(BrowserThread::IO, - FROM_HERE, - base::Bind(&Protocol::UninterceptProtocolInIO, - base::Unretained(this), scheme)); + BrowserThread::PostTaskAndReply(BrowserThread::IO, FROM_HERE, + base::Bind(&Protocol::UninterceptProtocolInIO, + base::Unretained(this), scheme), + base::Bind(callback, v8::Null(isolate))); } void Protocol::RegisterProtocolInIO(const std::string& scheme) { DCHECK_CURRENTLY_ON(BrowserThread::IO); job_factory_->SetProtocolHandler(scheme, new CustomProtocolHandler(this)); - BrowserThread::PostTask(BrowserThread::UI, - FROM_HERE, - base::Bind(&Protocol::EmitEventInUI, - base::Unretained(this), - "registered", scheme)); } void Protocol::UnregisterProtocolInIO(const std::string& scheme) { DCHECK_CURRENTLY_ON(BrowserThread::IO); job_factory_->SetProtocolHandler(scheme, NULL); - BrowserThread::PostTask(BrowserThread::UI, - FROM_HERE, - base::Bind(&Protocol::EmitEventInUI, - base::Unretained(this), - "unregistered", scheme)); } void Protocol::InterceptProtocolInIO(const std::string& scheme) { DCHECK_CURRENTLY_ON(BrowserThread::IO); ProtocolHandler* original_handler = job_factory_->GetProtocolHandler(scheme); - if (original_handler == NULL) { - BrowserThread::PostTask(BrowserThread::UI, FROM_HERE, base::Bind( - &Protocol::EmitEventInUI, - base::Unretained(this), - "error", "There is no protocol handler to intercpet")); - return; + if (original_handler == nullptr) { + NOTREACHED(); } job_factory_->ReplaceProtocol( scheme, new CustomProtocolHandler(this, original_handler)); - BrowserThread::PostTask(BrowserThread::UI, - FROM_HERE, - base::Bind(&Protocol::EmitEventInUI, - base::Unretained(this), - "intercepted", scheme)); } void Protocol::UninterceptProtocolInIO(const std::string& scheme) { @@ -369,28 +357,14 @@ void Protocol::UninterceptProtocolInIO(const std::string& scheme) { CustomProtocolHandler* handler = static_cast( job_factory_->GetProtocolHandler(scheme)); - if (handler->original_handler() == NULL) { - BrowserThread::PostTask(BrowserThread::UI, FROM_HERE, base::Bind( - &Protocol::EmitEventInUI, - base::Unretained(this), - "error", "The protocol is not intercpeted")); - return; + if (handler->original_handler() == nullptr) { + NOTREACHED(); } // Reset the protocol handler to the orignal one and delete current protocol // handler. ProtocolHandler* original_handler = handler->ReleaseDefaultProtocolHandler(); delete job_factory_->ReplaceProtocol(scheme, original_handler); - BrowserThread::PostTask(BrowserThread::UI, - FROM_HERE, - base::Bind(&Protocol::EmitEventInUI, - base::Unretained(this), - "unintercepted", scheme)); -} - -void Protocol::EmitEventInUI(const std::string& event, - const std::string& parameter) { - Emit(event, parameter); } // static diff --git a/atom/browser/api/atom_api_protocol.h b/atom/browser/api/atom_api_protocol.h index 147b9e1912a9..148620a0fef7 100644 --- a/atom/browser/api/atom_api_protocol.h +++ b/atom/browser/api/atom_api_protocol.h @@ -12,6 +12,7 @@ #include "atom/browser/api/event_emitter.h" #include "base/callback.h" #include "native_mate/handle.h" +#include "net/base/completion_callback.h" namespace net { class URLRequest; @@ -27,9 +28,8 @@ namespace api { class Protocol : public mate::EventEmitter { public: using JsProtocolHandler = - base::Callback(v8::Local, - const net::URLRequest*)>; - using CompletionCallback = base::Callback; + base::Callback(const net::URLRequest*)>; + using JsCompletionCallback = base::Callback)>; static mate::Handle Create( v8::Isolate* isolate, AtomBrowserContext* browser_context); @@ -50,12 +50,14 @@ class Protocol : public mate::EventEmitter { // Callback called if protocol can be registered. void OnRegisterProtocol(const std::string& scheme, - const JsProtocolHandler& callback, - bool is_handled); + const JsProtocolHandler& handler, + const JsCompletionCallback& callback, + int is_handled); // Callback called if protocol can be intercepted. void OnInterceptProtocol(const std::string& scheme, - const JsProtocolHandler& callback, - bool is_handled); + const JsProtocolHandler& handler, + const JsCompletionCallback& callback, + int is_handled); // Register schemes to standard scheme list. void RegisterStandardSchemes(const std::vector& schemes); @@ -64,18 +66,22 @@ class Protocol : public mate::EventEmitter { // |callback|. void RegisterProtocol(v8::Isolate* isolate, const std::string& scheme, - const JsProtocolHandler& callback); - void UnregisterProtocol(v8::Isolate* isolate, const std::string& scheme); + const JsProtocolHandler& handler, + const JsCompletionCallback& callback); + void UnregisterProtocol(v8::Isolate* isolate, const std::string& scheme, + const JsCompletionCallback& callback); // Returns whether a scheme has been registered. void IsHandledProtocol(const std::string& scheme, - const CompletionCallback& callback); + const net::CompletionCallback& callback); // Intercept/unintercept an existing protocol handler. void InterceptProtocol(v8::Isolate* isolate, const std::string& scheme, - const JsProtocolHandler& callback); - void UninterceptProtocol(v8::Isolate* isolate, const std::string& scheme); + const JsProtocolHandler& handler, + const JsCompletionCallback& callback); + void UninterceptProtocol(v8::Isolate* isolate, const std::string& scheme, + const JsCompletionCallback& callback); // The networking related operations have to be done in IO thread. void RegisterProtocolInIO(const std::string& scheme); @@ -83,9 +89,6 @@ class Protocol : public mate::EventEmitter { void InterceptProtocolInIO(const std::string& scheme); void UninterceptProtocolInIO(const std::string& scheme); - // Do protocol.emit(event, parameter) under UI thread. - void EmitEventInUI(const std::string& event, const std::string& parameter); - AtomBrowserContext* browser_context_; AtomURLRequestJobFactory* job_factory_; ProtocolHandlersMap protocol_handlers_; diff --git a/atom/browser/api/lib/protocol.coffee b/atom/browser/api/lib/protocol.coffee index ff4bc5ba9a66..6e22329318b4 100644 --- a/atom/browser/api/lib/protocol.coffee +++ b/atom/browser/api/lib/protocol.coffee @@ -6,6 +6,29 @@ EventEmitter = require('events').EventEmitter protocol.__proto__ = EventEmitter.prototype +GetWrappedCallback = (scheme, callback, notification) -> + wrappedCallback = (error) -> + if not callback? + if error + throw error + else + protocol.emit notification, scheme + else + callback error, scheme + +# Compatibility with old api. +protocol.registerProtocol = (scheme, handler, callback) -> + protocol._registerProtocol scheme, handler, GetWrappedCallback(scheme, callback, 'registered') + +protocol.unregisterProtocol = (scheme, callback) -> + protocol._unregisterProtocol scheme, GetWrappedCallback(scheme, callback, 'unregistered') + +protocol.interceptProtocol = (scheme, handler, callback) -> + protocol._interceptProtocol scheme, handler, GetWrappedCallback(scheme, callback, 'intercepted') + +protocol.uninterceptProtocol = (scheme, callback) -> + protocol._uninterceptProtocol scheme, GetWrappedCallback(scheme, callback, 'unintercepted') + protocol.RequestStringJob = class RequestStringJob constructor: ({mimeType, charset, data}) -> diff --git a/docs/api/protocol.md b/docs/api/protocol.md index dbcdb577ca9c..a076e3640daa 100644 --- a/docs/api/protocol.md +++ b/docs/api/protocol.md @@ -15,6 +15,9 @@ app.on('ready', function() { protocol.registerProtocol('atom', function(request) { var url = request.url.substr(7) return new protocol.RequestFileJob(path.normalize(__dirname + '/' + url)); + }, function (error, scheme) { + if (!error) + console.log(scheme, ' registered successfully') }); }); ``` @@ -22,20 +25,22 @@ app.on('ready', function() { **Note:** This module can only be used after the `ready` event was emitted. -## protocol.registerProtocol(scheme, handler) +## protocol.registerProtocol(scheme, handler, callback) * `scheme` String * `handler` Function +* `callback` Function Registers a custom protocol of `scheme`, the `handler` would be called with -`handler(error, request)` when the a request with registered `scheme` is made. +`handler(request)` when the a request with registered `scheme` is made. You need to return a request job in the `handler` to specify which type of response you would like to send. -## protocol.unregisterProtocol(scheme) +## protocol.unregisterProtocol(scheme, callback) * `scheme` String +* `callback` Function Unregisters the custom protocol of `scheme`. @@ -52,17 +57,19 @@ Unregisters the custom protocol of `scheme`. `callback` returns a boolean whether the `scheme` can be handled already. -## protocol.interceptProtocol(scheme, handler) +## protocol.interceptProtocol(scheme, handler, callback) * `scheme` String * `handler` Function +* `callback` Function Intercepts an existing protocol with `scheme`, returning `null` or `undefined` in `handler` would use the original protocol handler to handle the request. -## protocol.uninterceptProtocol(scheme) +## protocol.uninterceptProtocol(scheme, callback) * `scheme` String +* `callback` Function Unintercepts a protocol. diff --git a/spec/api-protocol-spec.coffee b/spec/api-protocol-spec.coffee index 4fb00b9a2d4f..3ddcdf62ca4f 100644 --- a/spec/api-protocol-spec.coffee +++ b/spec/api-protocol-spec.coffee @@ -9,17 +9,18 @@ describe 'protocol module', -> describe 'protocol.registerProtocol', -> it 'error when scheme is already registered', (done) -> register = -> - protocol.registerProtocol 'test1', (error, request) -> - assert error instanceof Error - protocol.unregisterProtocol 'test1' - done() - protocol.once 'registered', (event, scheme) -> - assert.equal scheme, 'test1' - register() + protocol.registerProtocol 'test1', ((request) ->), (error, scheme) -> + if error? + protocol.unregisterProtocol 'test1', (error, scheme) -> + assert.equal scheme, 'test1' + done() + else + assert.equal scheme, 'test1' + register() register() it 'calls the callback when scheme is visited', (done) -> - protocol.registerProtocol 'test2', (error, request) -> + protocol.registerProtocol 'test2', (request) -> assert.equal request.url, 'test2://test2' protocol.unregisterProtocol 'test2' done() @@ -28,7 +29,7 @@ describe 'protocol module', -> describe 'protocol.unregisterProtocol', -> it 'throws error when scheme does not exist', -> unregister = -> protocol.unregisterProtocol 'test3' - assert.throws unregister, /The scheme has not been registered/ + assert.throws unregister, /The Scheme has not been registered/ describe 'registered protocol callback', -> it 'returns string should send the string as request content', (done) -> @@ -190,37 +191,39 @@ describe 'protocol module', -> describe 'protocol.interceptProtocol', -> it 'throws error when scheme is not a registered one', (done) -> - protocol.interceptProtocol 'test-intercept', (error, request) -> - assert error instanceof Error - done() + protocol.interceptProtocol 'test-intercept', ( ->), (error, scheme) -> + if error? + assert.equal scheme, 'test-intercept' + done() it 'throws error when scheme is a custom protocol', (done) -> - protocol.once 'unregistered', (event, scheme) -> + protocol.once 'unregistered', (scheme) -> assert.equal scheme, 'atom' done() - protocol.once 'registered', (event, scheme) -> + protocol.once 'registered', (scheme) -> assert.equal scheme, 'atom' - protocol.interceptProtocol 'test-intercept', (error, request) -> - assert error instanceof Error - protocol.unregisterProtocol scheme + protocol.interceptProtocol 'test-intercept', (->), (error, newScheme) -> + if error? + assert.equal newScheme, 'test-intercept' + protocol.unregisterProtocol scheme protocol.registerProtocol('atom', ->) it 'returns original job when callback returns nothing', (done) -> targetScheme = 'file' - protocol.once 'intercepted', (event, scheme) -> + protocol.once 'intercepted', (scheme) -> assert.equal scheme, targetScheme free = -> protocol.uninterceptProtocol targetScheme $.ajax url: "#{targetScheme}://#{__filename}", success: -> - protocol.once 'unintercepted', (event, scheme) -> + protocol.once 'unintercepted', (scheme) -> assert.equal scheme, targetScheme done() free() error: (xhr, errorType, error) -> free() assert false, 'Got error: ' + errorType + ' ' + error - protocol.interceptProtocol targetScheme, (error, request) -> + protocol.interceptProtocol targetScheme, (request) -> if process.platform is 'win32' pathInUrl = path.normalize request.url.substr(8) assert.equal pathInUrl.toLowerCase(), __filename.toLowerCase() From fc9612a5ed7e71dd02433b9a5ee8e16936356fe4 Mon Sep 17 00:00:00 2001 From: Hank Bao Date: Thu, 9 Jul 2015 22:49:16 +0800 Subject: [PATCH 0570/1293] Fix sample code indention --- docs/api/global-shortcut.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/api/global-shortcut.md b/docs/api/global-shortcut.md index d9a77ce6ce30..16399cfbfe49 100644 --- a/docs/api/global-shortcut.md +++ b/docs/api/global-shortcut.md @@ -10,25 +10,25 @@ var app = require('app'); var globalShortcut = require('global-shortcut'); app.on('ready', function() { - // Register a 'ctrl+x' shortcut listener. - var ret = globalShortcut.register('ctrl+x', function() { - console.log('ctrl+x is pressed'); - }) + // Register a 'ctrl+x' shortcut listener. + var ret = globalShortcut.register('ctrl+x', function() { + console.log('ctrl+x is pressed'); + }) - if (!ret) { - console.log('registration failed'); - } + if (!ret) { + console.log('registration failed'); + } - // Check whether a shortcut is registered. - console.log(globalShortcut.isRegistered('ctrl+x')); + // Check whether a shortcut is registered. + console.log(globalShortcut.isRegistered('ctrl+x')); }); app.on('will-quit', function() { - // Unregister a shortcut. - globalShortcut.unregister('ctrl+x'); + // Unregister a shortcut. + globalShortcut.unregister('ctrl+x'); - // Unregister all shortcuts. - globalShortcut.unregisterAll(); + // Unregister all shortcuts. + globalShortcut.unregisterAll(); }); ``` From a0784bd0386f9b090fa7a01a253b9af780e4811a Mon Sep 17 00:00:00 2001 From: Paul Betts Date: Thu, 9 Jul 2015 15:57:17 -0700 Subject: [PATCH 0571/1293] Add a new renderer switch to pass down the app model ID --- atom/common/options_switches.cc | 3 +++ atom/common/options_switches.h | 2 ++ 2 files changed, 5 insertions(+) diff --git a/atom/common/options_switches.cc b/atom/common/options_switches.cc index 71469b9601b6..8f457116ec3a 100644 --- a/atom/common/options_switches.cc +++ b/atom/common/options_switches.cc @@ -107,6 +107,9 @@ const char kDisableHttpCache[] = "disable-http-cache"; // Register schemes to standard. const char kRegisterStandardSchemes[] = "register-standard-schemes"; +// The browser process app model ID +const char kAppUserModelId[] = "app-user-model-id"; + } // namespace switches } // namespace atom diff --git a/atom/common/options_switches.h b/atom/common/options_switches.h index fc25208a60ac..2dd48ee32a1a 100644 --- a/atom/common/options_switches.h +++ b/atom/common/options_switches.h @@ -58,6 +58,8 @@ extern const char kPageVisibility[]; extern const char kDisableHttpCache[]; extern const char kRegisterStandardSchemes[]; +extern const char kAppUserModelId[]; + } // namespace switches } // namespace atom From 779583adf52fc64f79be87ee5c79857b59bbf964 Mon Sep 17 00:00:00 2001 From: Paul Betts Date: Thu, 9 Jul 2015 15:57:52 -0700 Subject: [PATCH 0572/1293] Append the app user model ID as a switch --- atom/browser/native_window.cc | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index a1c839679c08..031366e1df5c 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -50,6 +50,7 @@ #if defined(OS_WIN) #include "ui/gfx/switches.h" +#include #endif using content::NavigationEntry; @@ -388,6 +389,16 @@ void NativeWindow::AppendExtraCommandLineSwitches( command_line->AppendSwitchASCII(switches::kZoomFactor, base::DoubleToString(zoom_factor_)); +#if defined(OS_WIN) + PWSTR explicit_app_id; + + if (SUCCEEDED(GetCurrentProcessExplicitAppUserModelID(&explicit_app_id))) { + base::string16 appId = base::string16(explicit_app_id); + command_line->AppendSwitchNative(switches::kAppUserModelId, appId); + CoTaskMemFree(explicit_app_id); + } +#endif + if (web_preferences_.IsEmpty()) return; From 35aaad68d78b35c0183ff5d4fbdb7cc1b2c6fb75 Mon Sep 17 00:00:00 2001 From: Paul Betts Date: Thu, 9 Jul 2015 16:48:02 -0700 Subject: [PATCH 0573/1293] Set the AppUserModelId on the renderer side --- atom/renderer/atom_renderer_client.cc | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/atom/renderer/atom_renderer_client.cc b/atom/renderer/atom_renderer_client.cc index e2a114af0141..c05203917308 100644 --- a/atom/renderer/atom_renderer_client.cc +++ b/atom/renderer/atom_renderer_client.cc @@ -27,6 +27,10 @@ #include "atom/common/node_includes.h" +#if defined(OS_WIN) +#include +#endif + namespace atom { namespace { @@ -87,6 +91,15 @@ void AtomRendererClient::WebKitInitialized() { blink::WebCustomElement::addEmbedderCustomElementName("webview"); blink::WebCustomElement::addEmbedderCustomElementName("browserplugin"); +#if defined(OS_WIN) + base::CommandLine* command_line = base::CommandLine::ForCurrentProcess(); + base::string16 explicit_app_id = command_line->GetSwitchValueNative(switches::kAppUserModelId); + + if (explicit_app_id.length() > 0) { + SetCurrentProcessExplicitAppUserModelID(explicit_app_id.c_str()); + } +#endif + node_bindings_->Initialize(); node_bindings_->PrepareMessageLoop(); From 39c6e2d2e52503b22c81d65cbced8f3fb9a3070f Mon Sep 17 00:00:00 2001 From: Paul Betts Date: Thu, 9 Jul 2015 17:00:19 -0700 Subject: [PATCH 0574/1293] Linter fixes --- atom/browser/native_window.cc | 5 ++++- atom/renderer/atom_renderer_client.cc | 6 ++++-- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 031366e1df5c..bd5a5c4666d9 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -8,6 +8,10 @@ #include #include +#if defined(OS_WIN) +#include +#endif + #include "atom/browser/atom_browser_context.h" #include "atom/browser/atom_browser_main_parts.h" #include "atom/browser/browser.h" @@ -50,7 +54,6 @@ #if defined(OS_WIN) #include "ui/gfx/switches.h" -#include #endif using content::NavigationEntry; diff --git a/atom/renderer/atom_renderer_client.cc b/atom/renderer/atom_renderer_client.cc index c05203917308..178be339008d 100644 --- a/atom/renderer/atom_renderer_client.cc +++ b/atom/renderer/atom_renderer_client.cc @@ -92,8 +92,10 @@ void AtomRendererClient::WebKitInitialized() { blink::WebCustomElement::addEmbedderCustomElementName("browserplugin"); #if defined(OS_WIN) - base::CommandLine* command_line = base::CommandLine::ForCurrentProcess(); - base::string16 explicit_app_id = command_line->GetSwitchValueNative(switches::kAppUserModelId); + base::CommandLine* command_line = + base::CommandLine::ForCurrentProcess(); + base::string16 explicit_app_id = + command_line->GetSwitchValueNative(switches::kAppUserModelId); if (explicit_app_id.length() > 0) { SetCurrentProcessExplicitAppUserModelID(explicit_app_id.c_str()); From 4379d24e9df11ced6849488b7492c4353ce30aa5 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 10 Jul 2015 10:38:15 +0800 Subject: [PATCH 0575/1293] Event "close" => "closed", fix #2149 --- atom/browser/api/atom_api_web_contents.cc | 2 +- spec/webview-spec.coffee | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index e2d1b31ae3fa..8db86f35934a 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -250,7 +250,7 @@ void WebContents::MoveContents(content::WebContents* source, } void WebContents::CloseContents(content::WebContents* source) { - Emit("closed"); + Emit("close"); if (type_ == BROWSER_WINDOW) owner_window()->CloseContents(source); } diff --git a/spec/webview-spec.coffee b/spec/webview-spec.coffee index 451276adf49a..704bdd7f3fd8 100644 --- a/spec/webview-spec.coffee +++ b/spec/webview-spec.coffee @@ -192,7 +192,7 @@ describe ' tag', -> document.body.appendChild webview describe 'close event', -> - it 'should fire when interior page calls window.close', -> + it 'should fire when interior page calls window.close', (done) -> webview.addEventListener 'close', -> done() From 260ec96edd9fad146ddbbf3be4abcf483d59c501 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 10 Jul 2015 11:36:25 +0800 Subject: [PATCH 0576/1293] Resolve relative urls in window.open, fix #2166 --- atom/renderer/lib/override.coffee | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/atom/renderer/lib/override.coffee b/atom/renderer/lib/override.coffee index f87c66037bd4..fad18943e772 100644 --- a/atom/renderer/lib/override.coffee +++ b/atom/renderer/lib/override.coffee @@ -2,6 +2,12 @@ process = global.process ipc = require 'ipc' remote = require 'remote' +# Helper function to resolve relative url. +a = document.createElement 'a' +resolveUrl = (url) -> + a.href = url + a.href + # Window object returned by "window.open". class BrowserWindowProxy constructor: (@guestId) -> @@ -49,6 +55,9 @@ window.open = (url, frameName='', features='') -> options.width ?= 800 options.height ?= 600 + # Resolve relative urls. + url = resolveUrl url + (options[name] = parseInt(options[name], 10) if options[name]?) for name in ints # Inherit the node-integration option of current window. From 2d3e938a7f489e35ce739db7c4aa4171d422b95b Mon Sep 17 00:00:00 2001 From: Robo Date: Tue, 7 Jul 2015 10:47:33 +0530 Subject: [PATCH 0577/1293] clipboard: api to write multiple formats to same writer --- atom/common/api/atom_api_clipboard.cc | 30 ++++++++++++++++++++++++++- docs/api/clipboard.md | 14 +++++++++++++ spec/api-clipboard-spec.coffee | 18 ++++++++++++++++ 3 files changed, 61 insertions(+), 1 deletion(-) diff --git a/atom/common/api/atom_api_clipboard.cc b/atom/common/api/atom_api_clipboard.cc index 273d30d96770..0837a3dc93f0 100644 --- a/atom/common/api/atom_api_clipboard.cc +++ b/atom/common/api/atom_api_clipboard.cc @@ -7,6 +7,7 @@ #include "atom/common/native_mate_converters/image_converter.h" #include "atom/common/native_mate_converters/string16_converter.h" +#include "base/strings/utf_string_conversions.h" #include "native_mate/arguments.h" #include "native_mate/dictionary.h" #include "third_party/skia/include/core/SkBitmap.h" @@ -50,9 +51,35 @@ std::string Read(const std::string& format_string, return data; } +void Write(const mate::Dictionary& data, + mate::Arguments* args) { + ui::ScopedClipboardWriter writer(GetClipboardType(args)); + base::string16 text, html; + gfx::Image image; + + if (data.Get("text", &text)) + writer.WriteText(text); + + if (data.Get("html", &html)) + writer.WriteHTML(html, std::string()); + + if (data.Get("image", &image)) + writer.WriteImage(image.AsBitmap()); +} + base::string16 ReadText(mate::Arguments* args) { base::string16 data; - ui::Clipboard::GetForCurrentThread()->ReadText(GetClipboardType(args), &data); + ui::Clipboard* clipboard = ui::Clipboard::GetForCurrentThread(); + auto type = GetClipboardType(args); + if (clipboard->IsFormatAvailable( + ui::Clipboard::GetPlainTextWFormatType(), type)) { + clipboard->ReadText(type, &data); + } else if (clipboard->IsFormatAvailable( + ui::Clipboard::GetPlainTextFormatType(), type)) { + std::string result; + clipboard->ReadAsciiText(type, &result); + data = base::ASCIIToUTF16(result); + } return data; } @@ -99,6 +126,7 @@ void Initialize(v8::Local exports, v8::Local unused, dict.SetMethod("availableFormats", &AvailableFormats); dict.SetMethod("has", &Has); dict.SetMethod("read", &Read); + dict.SetMethod("write", &Write); dict.SetMethod("readText", &ReadText); dict.SetMethod("writeText", &WriteText); dict.SetMethod("readHtml", &ReadHtml); diff --git a/docs/api/clipboard.md b/docs/api/clipboard.md index b9ca8b3a9b90..572e91e96637 100644 --- a/docs/api/clipboard.md +++ b/docs/api/clipboard.md @@ -88,3 +88,17 @@ console.log(clipboard.has('

selection

')); Reads the `data` in clipboard. **Note:** This API is experimental and could be removed in future. + +## clipboard.write(data[, type]) + +* `data` Object + * `text` String + * `html` String + * `image` [NativeImage](native-image.md) +* `type` String + +```javascript +var clipboard = require('clipboard'); +clipboard.write({text: 'test', html: "test"}); +``` +Writes the `data` iinto clipboard. diff --git a/spec/api-clipboard-spec.coffee b/spec/api-clipboard-spec.coffee index 135ed6cf1570..ddb38825e35f 100644 --- a/spec/api-clipboard-spec.coffee +++ b/spec/api-clipboard-spec.coffee @@ -32,3 +32,21 @@ describe 'clipboard module', -> 'Hi' clipboard.writeHtml text assert.equal clipboard.readHtml(), markup + + describe 'clipboard.write()', -> + it 'returns data correctly', -> + text = 'test' + p = path.join fixtures, 'assets', 'logo.png' + i = nativeImage.createFromPath p + markup = + if process.platform is 'darwin' + 'Hi' + else if process.platform is 'linux' + 'Hi' + else + 'Hi' + clipboard.write {text: "test", html: 'Hi', image: p} + assert.equal clipboard.readText(), text + assert.equal clipboard.readHtml(), markup + assert.equal clipboard.readImage().toDataUrl(), i.toDataUrl() From c56b3425a919254b4821dfbce1282bcb66d60551 Mon Sep 17 00:00:00 2001 From: Robo Date: Thu, 9 Jul 2015 14:48:45 +0530 Subject: [PATCH 0578/1293] read/write protocol handler map in IO --- atom/browser/api/atom_api_protocol.cc | 194 ++++++++++++++------------ atom/browser/api/atom_api_protocol.h | 41 +++--- spec/api-protocol-spec.coffee | 6 +- 3 files changed, 128 insertions(+), 113 deletions(-) diff --git a/atom/browser/api/atom_api_protocol.cc b/atom/browser/api/atom_api_protocol.cc index fa498a7fa99c..65ba3039d153 100644 --- a/atom/browser/api/atom_api_protocol.cc +++ b/atom/browser/api/atom_api_protocol.cc @@ -36,7 +36,6 @@ struct Converter { } // namespace mate - namespace atom { namespace api { @@ -189,6 +188,26 @@ class CustomProtocolHandler : public ProtocolHandler { DISALLOW_COPY_AND_ASSIGN(CustomProtocolHandler); }; +std::string ConvertErrorCode(int error_code) { + switch (error_code) { + case Protocol::ERR_SCHEME_REGISTERED: + return "The Scheme is already registered"; + case Protocol::ERR_SCHEME_UNREGISTERED: + return "The Scheme has not been registered"; + case Protocol::ERR_SCHEME_INTERCEPTED: + return "There is no protocol handler to intercept"; + case Protocol::ERR_SCHEME_UNINTERCEPTED: + return "The protocol is not intercepted"; + case Protocol::ERR_NO_SCHEME: + return "The Scheme does not exist."; + case Protocol::ERR_SCHEME: + return "Cannot intercept custom protocols"; + default: + NOTREACHED(); + return std::string(); + } +} + } // namespace Protocol::Protocol(AtomBrowserContext* browser_context) @@ -202,91 +221,32 @@ Protocol::JsProtocolHandler Protocol::GetProtocolHandler( return protocol_handlers_[scheme]; } -void Protocol::OnRegisterProtocol(const std::string& scheme, - const JsProtocolHandler& handler, - const JsCompletionCallback& callback, - int is_handled) { +void Protocol::OnIOActionCompleted(const JsCompletionCallback& callback, + int error) { DCHECK_CURRENTLY_ON(BrowserThread::UI); v8::Locker locker(isolate()); v8::HandleScope handle_scope(isolate()); - if (is_handled || ContainsKey(protocol_handlers_, scheme)) { + if (error) { callback.Run(v8::Exception::Error( - mate::StringToV8(isolate(), "The Scheme is already registered"))); + mate::StringToV8(isolate(), ConvertErrorCode(error)))); return; } - protocol_handlers_[scheme] = handler; - BrowserThread::PostTaskAndReply(BrowserThread::IO, FROM_HERE, - base::Bind(&Protocol::RegisterProtocolInIO, - base::Unretained(this), scheme), - base::Bind(callback, v8::Null(isolate()))); -} - -void Protocol::OnInterceptProtocol(const std::string& scheme, - const JsProtocolHandler& handler, - const JsCompletionCallback& callback, - int is_handled) { - DCHECK_CURRENTLY_ON(BrowserThread::UI); - v8::Locker locker(isolate()); - v8::HandleScope handle_scope(isolate()); - if (!is_handled) { - callback.Run(v8::Exception::Error( - mate::StringToV8(isolate(), "Scheme does not exist."))); - return; - } - - if (ContainsKey(protocol_handlers_, scheme)) { - callback.Run(v8::Exception::Error( - mate::StringToV8(isolate(), "Cannot intercept custom protocols."))); - return; - } - - protocol_handlers_[scheme] = handler; - BrowserThread::PostTaskAndReply(BrowserThread::IO, FROM_HERE, - base::Bind(&Protocol::InterceptProtocolInIO, - base::Unretained(this), scheme), - base::Bind(callback, v8::Null(isolate()))); + callback.Run(v8::Null(isolate())); } mate::ObjectTemplateBuilder Protocol::GetObjectTemplateBuilder( v8::Isolate* isolate) { return mate::ObjectTemplateBuilder(isolate) - .SetMethod("_registerProtocol", &Protocol::RegisterProtocol) - .SetMethod("_unregisterProtocol", &Protocol::UnregisterProtocol) .SetMethod("registerStandardSchemes", &Protocol::RegisterStandardSchemes) .SetMethod("isHandledProtocol", &Protocol::IsHandledProtocol) + .SetMethod("_registerProtocol", &Protocol::RegisterProtocol) + .SetMethod("_unregisterProtocol", &Protocol::UnregisterProtocol) .SetMethod("_interceptProtocol", &Protocol::InterceptProtocol) .SetMethod("_uninterceptProtocol", &Protocol::UninterceptProtocol); } -void Protocol::RegisterProtocol(v8::Isolate* isolate, - const std::string& scheme, - const JsProtocolHandler& handler, - const JsCompletionCallback& callback) { - IsHandledProtocol(scheme, - base::Bind(&Protocol::OnRegisterProtocol, - base::Unretained(this), - scheme, handler, callback)); -} - -void Protocol::UnregisterProtocol(v8::Isolate* isolate, - const std::string& scheme, - const JsCompletionCallback& callback) { - ProtocolHandlersMap::iterator it(protocol_handlers_.find(scheme)); - if (it == protocol_handlers_.end()) { - callback.Run(v8::Exception::Error( - mate::StringToV8(isolate, "The Scheme has not been registered"))); - return; - } - - protocol_handlers_.erase(it); - BrowserThread::PostTaskAndReply(BrowserThread::IO, FROM_HERE, - base::Bind(&Protocol::UnregisterProtocolInIO, - base::Unretained(this), scheme), - base::Bind(callback, v8::Null(isolate))); -} - void Protocol::RegisterStandardSchemes( const std::vector& schemes) { atom::AtomBrowserClient::SetCustomSchemes(schemes); @@ -300,71 +260,119 @@ void Protocol::IsHandledProtocol(const std::string& scheme, callback); } +void Protocol::RegisterProtocol(v8::Isolate* isolate, + const std::string& scheme, + const JsProtocolHandler& handler, + const JsCompletionCallback& callback) { + BrowserThread::PostTaskAndReplyWithResult(BrowserThread::IO, FROM_HERE, + base::Bind(&Protocol::RegisterProtocolInIO, + base::Unretained(this), scheme, handler), + base::Bind(&Protocol::OnIOActionCompleted, + base::Unretained(this), callback)); +} + +void Protocol::UnregisterProtocol(v8::Isolate* isolate, + const std::string& scheme, + const JsCompletionCallback& callback) { + BrowserThread::PostTaskAndReplyWithResult(BrowserThread::IO, FROM_HERE, + base::Bind(&Protocol::UnregisterProtocolInIO, + base::Unretained(this), scheme), + base::Bind(&Protocol::OnIOActionCompleted, + base::Unretained(this), callback)); +} + void Protocol::InterceptProtocol(v8::Isolate* isolate, const std::string& scheme, const JsProtocolHandler& handler, const JsCompletionCallback& callback) { BrowserThread::PostTaskAndReplyWithResult(BrowserThread::IO, FROM_HERE, - base::Bind(&AtomURLRequestJobFactory::HasProtocolHandler, - base::Unretained(job_factory_), scheme), - base::Bind(&Protocol::OnInterceptProtocol, - base::Unretained(this), scheme, handler, callback)); + base::Bind(&Protocol::InterceptProtocolInIO, + base::Unretained(this), scheme, handler), + base::Bind(&Protocol::OnIOActionCompleted, + base::Unretained(this), callback)); } void Protocol::UninterceptProtocol(v8::Isolate* isolate, const std::string& scheme, const JsCompletionCallback& callback) { + BrowserThread::PostTaskAndReplyWithResult(BrowserThread::IO, FROM_HERE, + base::Bind(&Protocol::UninterceptProtocolInIO, + base::Unretained(this), scheme), + base::Bind(&Protocol::OnIOActionCompleted, + base::Unretained(this), callback)); +} + +int Protocol::RegisterProtocolInIO(const std::string& scheme, + const JsProtocolHandler& handler) { + DCHECK_CURRENTLY_ON(BrowserThread::IO); + + if (ContainsKey(protocol_handlers_, scheme) || + job_factory_->IsHandledProtocol(scheme)) { + return ERR_SCHEME_REGISTERED; + } + + protocol_handlers_[scheme] = handler; + job_factory_->SetProtocolHandler(scheme, new CustomProtocolHandler(this)); + + return OK; +} + +int Protocol::UnregisterProtocolInIO(const std::string& scheme) { + DCHECK_CURRENTLY_ON(BrowserThread::IO); + ProtocolHandlersMap::iterator it(protocol_handlers_.find(scheme)); if (it == protocol_handlers_.end()) { - callback.Run(v8::Exception::Error( - mate::StringToV8(isolate, "The Scheme has not been registered"))); - return; + return ERR_SCHEME_UNREGISTERED; } protocol_handlers_.erase(it); - BrowserThread::PostTaskAndReply(BrowserThread::IO, FROM_HERE, - base::Bind(&Protocol::UninterceptProtocolInIO, - base::Unretained(this), scheme), - base::Bind(callback, v8::Null(isolate))); -} - -void Protocol::RegisterProtocolInIO(const std::string& scheme) { - DCHECK_CURRENTLY_ON(BrowserThread::IO); - - job_factory_->SetProtocolHandler(scheme, new CustomProtocolHandler(this)); -} - -void Protocol::UnregisterProtocolInIO(const std::string& scheme) { - DCHECK_CURRENTLY_ON(BrowserThread::IO); - job_factory_->SetProtocolHandler(scheme, NULL); + + return OK; } -void Protocol::InterceptProtocolInIO(const std::string& scheme) { +int Protocol::InterceptProtocolInIO(const std::string& scheme, + const JsProtocolHandler& handler) { DCHECK_CURRENTLY_ON(BrowserThread::IO); + if (!job_factory_->HasProtocolHandler(scheme)) + return ERR_NO_SCHEME; + + if (ContainsKey(protocol_handlers_, scheme)) + return ERR_SCHEME; + + protocol_handlers_[scheme] = handler; ProtocolHandler* original_handler = job_factory_->GetProtocolHandler(scheme); if (original_handler == nullptr) { - NOTREACHED(); + return ERR_SCHEME_INTERCEPTED; } job_factory_->ReplaceProtocol( scheme, new CustomProtocolHandler(this, original_handler)); + + return OK; } -void Protocol::UninterceptProtocolInIO(const std::string& scheme) { +int Protocol::UninterceptProtocolInIO(const std::string& scheme) { DCHECK_CURRENTLY_ON(BrowserThread::IO); + ProtocolHandlersMap::iterator it(protocol_handlers_.find(scheme)); + if (it == protocol_handlers_.end()) + return ERR_SCHEME_UNREGISTERED; + + protocol_handlers_.erase(it); CustomProtocolHandler* handler = static_cast( job_factory_->GetProtocolHandler(scheme)); if (handler->original_handler() == nullptr) { - NOTREACHED(); + return ERR_SCHEME_UNINTERCEPTED; } // Reset the protocol handler to the orignal one and delete current protocol // handler. ProtocolHandler* original_handler = handler->ReleaseDefaultProtocolHandler(); delete job_factory_->ReplaceProtocol(scheme, original_handler); + + return OK; } // static diff --git a/atom/browser/api/atom_api_protocol.h b/atom/browser/api/atom_api_protocol.h index 148620a0fef7..b4d56018baf3 100644 --- a/atom/browser/api/atom_api_protocol.h +++ b/atom/browser/api/atom_api_protocol.h @@ -31,6 +31,16 @@ class Protocol : public mate::EventEmitter { base::Callback(const net::URLRequest*)>; using JsCompletionCallback = base::Callback)>; + enum { + OK = 0, + ERR_SCHEME_REGISTERED, + ERR_SCHEME_UNREGISTERED, + ERR_SCHEME_INTERCEPTED, + ERR_SCHEME_UNINTERCEPTED, + ERR_NO_SCHEME, + ERR_SCHEME + }; + static mate::Handle Create( v8::Isolate* isolate, AtomBrowserContext* browser_context); @@ -48,20 +58,17 @@ class Protocol : public mate::EventEmitter { private: typedef std::map ProtocolHandlersMap; - // Callback called if protocol can be registered. - void OnRegisterProtocol(const std::string& scheme, - const JsProtocolHandler& handler, - const JsCompletionCallback& callback, - int is_handled); - // Callback called if protocol can be intercepted. - void OnInterceptProtocol(const std::string& scheme, - const JsProtocolHandler& handler, - const JsCompletionCallback& callback, - int is_handled); + // Callback called after performing action on IO thread. + void OnIOActionCompleted(const JsCompletionCallback& callback, + int error); // Register schemes to standard scheme list. void RegisterStandardSchemes(const std::vector& schemes); + // Returns whether a scheme has been registered. + void IsHandledProtocol(const std::string& scheme, + const net::CompletionCallback& callback); + // Register/unregister an networking |scheme| which would be handled by // |callback|. void RegisterProtocol(v8::Isolate* isolate, @@ -71,10 +78,6 @@ class Protocol : public mate::EventEmitter { void UnregisterProtocol(v8::Isolate* isolate, const std::string& scheme, const JsCompletionCallback& callback); - // Returns whether a scheme has been registered. - void IsHandledProtocol(const std::string& scheme, - const net::CompletionCallback& callback); - // Intercept/unintercept an existing protocol handler. void InterceptProtocol(v8::Isolate* isolate, const std::string& scheme, @@ -84,10 +87,12 @@ class Protocol : public mate::EventEmitter { const JsCompletionCallback& callback); // The networking related operations have to be done in IO thread. - void RegisterProtocolInIO(const std::string& scheme); - void UnregisterProtocolInIO(const std::string& scheme); - void InterceptProtocolInIO(const std::string& scheme); - void UninterceptProtocolInIO(const std::string& scheme); + int RegisterProtocolInIO(const std::string& scheme, + const JsProtocolHandler& handler); + int UnregisterProtocolInIO(const std::string& scheme); + int InterceptProtocolInIO(const std::string& scheme, + const JsProtocolHandler& handler); + int UninterceptProtocolInIO(const std::string& scheme); AtomBrowserContext* browser_context_; AtomURLRequestJobFactory* job_factory_; diff --git a/spec/api-protocol-spec.coffee b/spec/api-protocol-spec.coffee index 3ddcdf62ca4f..b65002a63189 100644 --- a/spec/api-protocol-spec.coffee +++ b/spec/api-protocol-spec.coffee @@ -28,8 +28,10 @@ describe 'protocol module', -> describe 'protocol.unregisterProtocol', -> it 'throws error when scheme does not exist', -> - unregister = -> protocol.unregisterProtocol 'test3' - assert.throws unregister, /The Scheme has not been registered/ + protocol.unregisterProtocol 'test3', (->), (error, scheme) -> + if (error) + assert.equal scheme, 'test3' + done() describe 'registered protocol callback', -> it 'returns string should send the string as request content', (done) -> From 6383eb876ed451d84ada751c0f0ff37440d49cd0 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 10 Jul 2015 12:14:25 +0800 Subject: [PATCH 0579/1293] Fix failed specs caused by window.open url parsing --- spec/api-browser-window-spec.coffee | 2 +- spec/webview-spec.coffee | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/spec/api-browser-window-spec.coffee b/spec/api-browser-window-spec.coffee index e7406f9a2afd..ce1282439a2d 100644 --- a/spec/api-browser-window-spec.coffee +++ b/spec/api-browser-window-spec.coffee @@ -192,7 +192,7 @@ describe 'browser-window module', -> it 'emits when window.open is called', (done) -> w.webContents.once 'new-window', (e, url, frameName) -> e.preventDefault() - assert.equal url, 'http://host' + assert.equal url, 'http://host/' assert.equal frameName, 'host' done() w.loadUrl "file://#{fixtures}/pages/window-open.html" diff --git a/spec/webview-spec.coffee b/spec/webview-spec.coffee index 704bdd7f3fd8..cd22e57a18bf 100644 --- a/spec/webview-spec.coffee +++ b/spec/webview-spec.coffee @@ -144,7 +144,7 @@ describe ' tag', -> describe 'new-window event', -> it 'emits when window.open is called', (done) -> webview.addEventListener 'new-window', (e) -> - assert.equal e.url, 'http://host' + assert.equal e.url, 'http://host/' assert.equal e.frameName, 'host' done() webview.src = "file://#{fixtures}/pages/window-open.html" From 5ae57baf11e6a5b0486a8e6397b90965730eb694 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 10 Jul 2015 13:29:46 +0800 Subject: [PATCH 0580/1293] Allow more insecure content when web-security is off Close #2076 --- atom/browser/native_window.cc | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index a1c839679c08..c9f209a3a2b4 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -419,8 +419,6 @@ void NativeWindow::OverrideWebkitPrefs(content::WebPreferences* prefs) { std::vector list; if (web_preferences_.Get("javascript", &b)) prefs->javascript_enabled = b; - if (web_preferences_.Get("web-security", &b)) - prefs->web_security_enabled = b; if (web_preferences_.Get("images", &b)) prefs->images_enabled = b; if (web_preferences_.Get("java", &b)) @@ -431,6 +429,11 @@ void NativeWindow::OverrideWebkitPrefs(content::WebPreferences* prefs) { prefs->experimental_webgl_enabled = b; if (web_preferences_.Get("webaudio", &b)) prefs->webaudio_enabled = b; + if (web_preferences_.Get("web-security", &b)) { + prefs->web_security_enabled = b; + prefs->allow_displaying_insecure_content = !b; + prefs->allow_running_insecure_content = !b; + } if (web_preferences_.Get("extra-plugin-dirs", &list)) { if (content::PluginService::GetInstance()->NPAPIPluginsSupported()) { for (size_t i = 0; i < list.size(); ++i) From 967c273ddb8d0694109b930b8a86f6ef1576da6c Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 10 Jul 2015 13:54:30 +0800 Subject: [PATCH 0581/1293] Always use top window's context for resolving url Refs #2166. --- atom/renderer/lib/override.coffee | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/atom/renderer/lib/override.coffee b/atom/renderer/lib/override.coffee index fad18943e772..85914b116fd6 100644 --- a/atom/renderer/lib/override.coffee +++ b/atom/renderer/lib/override.coffee @@ -3,7 +3,7 @@ ipc = require 'ipc' remote = require 'remote' # Helper function to resolve relative url. -a = document.createElement 'a' +a = window.top.document.createElement 'a' resolveUrl = (url) -> a.href = url a.href From 628fb5f5e97cb262a1f9916f4e5a357a805428ed Mon Sep 17 00:00:00 2001 From: Robo Date: Thu, 2 Jul 2015 19:42:18 +0530 Subject: [PATCH 0582/1293] app: api to clear data from different storage types --- atom/browser/api/atom_api_session.cc | 96 +++++++++++++++++++ atom/browser/api/atom_api_session.h | 6 ++ docs/api/browser-window.md | 26 ++++- ...es-spec.coffee => api-session-spec.coffee} | 17 +++- spec/fixtures/api/localstorage.html | 11 +++ 5 files changed, 150 insertions(+), 6 deletions(-) rename spec/{api-cookies-spec.coffee => api-session-spec.coffee} (80%) create mode 100644 spec/fixtures/api/localstorage.html diff --git a/atom/browser/api/atom_api_session.cc b/atom/browser/api/atom_api_session.cc index d1eaca7994ab..4236fddc136c 100644 --- a/atom/browser/api/atom_api_session.cc +++ b/atom/browser/api/atom_api_session.cc @@ -10,17 +10,67 @@ #include "atom/browser/atom_browser_context.h" #include "atom/common/native_mate_converters/gurl_converter.h" #include "base/thread_task_runner_handle.h" +#include "base/strings/string_util.h" #include "content/public/browser/browser_thread.h" #include "content/public/browser/storage_partition.h" #include "native_mate/callback.h" #include "native_mate/object_template_builder.h" #include "net/base/load_flags.h" +#include "net/disk_cache/disk_cache.h" #include "net/proxy/proxy_service.h" #include "net/url_request/url_request_context.h" #include "net/url_request/url_request_context_getter.h" #include "atom/common/node_includes.h" +using content::BrowserThread; +using content::StoragePartition; + +namespace { + +int GetStorageMask(const std::vector& storage_types) { + int storage_mask = 0; + + for (auto &it : storage_types) { + auto type = base::StringToLowerASCII(it); + if (type == "appcache") { + storage_mask |= StoragePartition::REMOVE_DATA_MASK_APPCACHE; + } else if (type == "cookies") { + storage_mask |= StoragePartition::REMOVE_DATA_MASK_COOKIES; + } else if (type == "filesystem") { + storage_mask |= StoragePartition::REMOVE_DATA_MASK_FILE_SYSTEMS; + } else if (type == "indexdb") { + storage_mask |= StoragePartition::REMOVE_DATA_MASK_INDEXEDDB; + } else if (type == "localstorage") { + storage_mask |= StoragePartition::REMOVE_DATA_MASK_LOCAL_STORAGE; + } else if (type == "shadercache") { + storage_mask |= StoragePartition::REMOVE_DATA_MASK_SHADER_CACHE; + } else if (type == "websql") { + storage_mask |= StoragePartition::REMOVE_DATA_MASK_WEBSQL; + } else if (type == "serviceworkers") { + storage_mask |= StoragePartition::REMOVE_DATA_MASK_SERVICE_WORKERS; + } + } + + return storage_mask; +} + +int GetQuotaMask(const std::vector& quota_types) { + int quota_mask = 0; + + for (auto &type : quota_types) { + if (type == "temporary") { + quota_mask |= StoragePartition::QUOTA_MANAGED_STORAGE_MASK_TEMPORARY; + } else if (type == "persistent") { + quota_mask |= StoragePartition::QUOTA_MANAGED_STORAGE_MASK_PERSISTENT; + } + } + + return quota_mask; +} + +} // namespace + namespace atom { namespace api { @@ -80,6 +130,30 @@ class ResolveProxyHelper { DISALLOW_COPY_AND_ASSIGN(ResolveProxyHelper); }; +void Noop(int result) { + DCHECK(result == net::OK); +} + +void DoClearCache(disk_cache::Backend** cache_ptr, + int result) { + DCHECK(result == net::OK); + if (cache_ptr && *cache_ptr) + (*cache_ptr)->DoomAllEntries(base::Bind(&Noop)); +} + +void ClearHttpCacheOnIO(net::URLRequestContextGetter* getter) { + typedef disk_cache::Backend* Backendptr; + Backendptr* cache_ptr = new Backendptr(nullptr); + auto request_context = getter->GetURLRequestContext(); + net::CompletionCallback callback(base::Bind(&DoClearCache, + base::Owned(cache_ptr))); + auto http_cache = request_context->http_transaction_factory()->GetCache(); + int rv = http_cache->GetBackend(cache_ptr, callback); + + if (rv != net::ERR_IO_PENDING) + callback.Run(net::OK); +} + } // namespace Session::Session(AtomBrowserContext* browser_context) @@ -94,6 +168,26 @@ void Session::ResolveProxy(const GURL& url, ResolveProxyCallback callback) { new ResolveProxyHelper(browser_context_, url, callback); } +void Session::ClearCache(const base::Closure& callback) { + auto getter = browser_context_->GetRequestContext(); + BrowserThread::PostTaskAndReply(BrowserThread::IO, FROM_HERE, + base::Bind(&ClearHttpCacheOnIO, + base::Unretained(getter)), + callback); +} + +void Session::ClearStorageData(const GURL& origin, + const std::vector& storage_types, + const std::vector& quota_types, + const base::Closure& callback) { + auto storage_partition = + content::BrowserContext::GetStoragePartition(browser_context_, nullptr); + storage_partition->ClearData( + GetStorageMask(storage_types), GetQuotaMask(quota_types), origin, + content::StoragePartition::OriginMatcherFunction(), + base::Time(), base::Time::Max(), callback); +} + v8::Local Session::Cookies(v8::Isolate* isolate) { if (cookies_.IsEmpty()) { auto handle = atom::api::Cookies::Create(isolate, browser_context_); @@ -106,6 +200,8 @@ mate::ObjectTemplateBuilder Session::GetObjectTemplateBuilder( v8::Isolate* isolate) { return mate::ObjectTemplateBuilder(isolate) .SetMethod("resolveProxy", &Session::ResolveProxy) + .SetMethod("clearCache", &Session::ClearCache) + .SetMethod("clearStorageData", &Session::ClearStorageData) .SetProperty("cookies", &Session::Cookies); } diff --git a/atom/browser/api/atom_api_session.h b/atom/browser/api/atom_api_session.h index cd9f0a59a872..ec9083d3054a 100644 --- a/atom/browser/api/atom_api_session.h +++ b/atom/browser/api/atom_api_session.h @@ -6,6 +6,7 @@ #define ATOM_BROWSER_API_ATOM_API_SESSION_H_ #include +#include #include "atom/browser/api/trackable_object.h" #include "base/callback.h" @@ -37,6 +38,11 @@ class Session: public mate::TrackableObject { private: void ResolveProxy(const GURL& url, ResolveProxyCallback callback); + void ClearCache(const base::Closure& callback); + void ClearStorageData(const GURL& origin, + const std::vector& storage_types, + const std::vector& quota_types, + const base::Closure& callback); v8::Local Cookies(v8::Isolate* isolate); v8::Global cookies_; diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index a339b855bb71..7850fcabbdc8 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -1055,7 +1055,9 @@ app.on('ready', function() { 2. There is no way to send synchronous messages from the main process to a renderer process, because it would be very easy to cause dead locks. -## Class: WebContents.session.cookies +## Class: Session + +### Session.cookies The `cookies` gives you ability to query and modify cookies, an example is: @@ -1091,7 +1093,7 @@ win.webContents.on('did-finish-load', function() { }); ``` -### WebContents.session.cookies.get(details, callback) +### Session.cookies.get(details, callback) * `details` Object * `url` String - Retrieves cookies which are associated with `url`. @@ -1118,7 +1120,7 @@ win.webContents.on('did-finish-load', function() { the number of seconds since the UNIX epoch. Not provided for session cookies. -### WebContents.session.cookies.set(details, callback) +### Session.cookies.set(details, callback) * `details` Object * `url` String - Retrieves cookies which are associated with `url` @@ -1134,10 +1136,26 @@ win.webContents.on('did-finish-load', function() { * `callback` Function - function(error) * `error` Error -### WebContents.session.cookies.remove(details, callback) +### Session.cookies.remove(details, callback) * `details` Object * `url` String - The URL associated with the cookie * `name` String - The name of cookie to remove * `callback` Function - function(error) * `error` Error + +### Session.clearCache() + +Clears the session's http cache. + +### Session.clearStorageData(origin, storageType, quotaType, callback) + +* `origin` String - should follow `window.location.origin` representation `scheme`://`host`:`port` +* `storageType` Array - specifies the type of storage, can contain - + `appcache`, `cookies`, `filesystem`, `indexdb`, `localstorage`, `shadercache`, `websql`, + `serviceworkers` +* `quotaType` Array - specifies the storage quota type, can contain - + `temporary`, `persistent` +* `callback` Function + +`callback` is invoked when the deletion process is scheduled. diff --git a/spec/api-cookies-spec.coffee b/spec/api-session-spec.coffee similarity index 80% rename from spec/api-cookies-spec.coffee rename to spec/api-session-spec.coffee index de934234c140..d439b6373cda 100644 --- a/spec/api-cookies-spec.coffee +++ b/spec/api-session-spec.coffee @@ -4,12 +4,12 @@ http = require 'http' path = require 'path' BrowserWindow = remote.require 'browser-window' -describe 'cookies module', -> +describe 'session module', -> fixtures = path.resolve __dirname, 'fixtures' w = null url = "http://127.0.0.1" - beforeEach -> w = new BrowserWindow(show: true) + beforeEach -> w = new BrowserWindow(show: false, width: 400, height: 400) afterEach -> w.destroy() it 'should get cookies', (done) -> @@ -69,3 +69,16 @@ describe 'cookies module', -> throw error if error assert.equal 0, cookies_list.length done() + + describe 'session.clearStorageData(options)', -> + fixtures = path.resolve __dirname, 'fixtures' + it 'clears localstorage data', (done) -> + ipc = remote.require('ipc') + ipc.on 'count', (event, count) -> + ipc.removeAllListeners 'count' + assert not count + done() + w.loadUrl 'file://' + path.join(fixtures, 'api', 'localstorage.html') + w.webContents.on 'did-finish-load', -> + w.webContents.session.clearStorageData "file://", ['localstorage'], ['persistent'], -> + w.webContents.send 'getcount' diff --git a/spec/fixtures/api/localstorage.html b/spec/fixtures/api/localstorage.html new file mode 100644 index 000000000000..8110a0b4be6a --- /dev/null +++ b/spec/fixtures/api/localstorage.html @@ -0,0 +1,11 @@ + + + + + From e0e4c1b54cba8463fdb6a00c11fccef687b0e341 Mon Sep 17 00:00:00 2001 From: Robo Date: Fri, 10 Jul 2015 13:56:21 +0530 Subject: [PATCH 0583/1293] doc: kProxyPacUrl support --- docs/api/chrome-command-line-switches.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/api/chrome-command-line-switches.md b/docs/api/chrome-command-line-switches.md index 62bfa2450ca0..d55dea4c1b5a 100644 --- a/docs/api/chrome-command-line-switches.md +++ b/docs/api/chrome-command-line-switches.md @@ -36,6 +36,10 @@ Enables remote debug over HTTP on the specified `port`. Uses a specified proxy server, overrides system settings. This switch only affects HTTP and HTTPS requests. +## --proxy-pac-url=`url` + +Uses the PAC script at the specified `url`. + ## --no-proxy-server Don't use a proxy server, always make direct connections. Overrides any other From d6ae874038400a0c9367f8a6c14d62e5a951c907 Mon Sep 17 00:00:00 2001 From: JP Richardson Date: Fri, 10 Jul 2015 14:38:03 -0500 Subject: [PATCH 0584/1293] emit error object on process.on('uncaughtException') in renderer Chromium added the actual `error` object to the 5th parameter in `window.onerror`. This should be emitted as opposed to the `errorMsg` string. Worse yet, since `errorMsg` wasn't an instance of `Error`, any code that assumes this in any `process.on('uncaughtException')` handler would fail. Also, correctly emitting the error provides the stack trace. This is now an HTML5 standard. Sources: - https://html.spec.whatwg.org/multipage/webappapis.html#errorevent - https://mikewest.org/2013/08/debugging-runtime-errors-with-window-onerror - https://code.google.com/p/chromium/issues/detail?id=147127 --- atom/renderer/lib/init.coffee | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/atom/renderer/lib/init.coffee b/atom/renderer/lib/init.coffee index 470715626b13..196891554dd9 100644 --- a/atom/renderer/lib/init.coffee +++ b/atom/renderer/lib/init.coffee @@ -77,7 +77,7 @@ if nodeIntegration in ['true', 'all', 'except-iframe', 'manual-enable-iframe'] global.__dirname = __dirname # Redirect window.onerror to uncaughtException. - window.onerror = (error) -> + window.onerror = (message, filename, lineno, colno, error) -> if global.process.listeners('uncaughtException').length > 0 global.process.emit 'uncaughtException', error true From 124919611832c26645f5d436776971ab7c346805 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Sat, 11 Jul 2015 19:46:26 -0700 Subject: [PATCH 0585/1293] Fix docs typo It was breaking the docs site build because it's a code block type --- docs/api/browser-window-ko.md | 2 +- docs/api/browser-window.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/browser-window-ko.md b/docs/api/browser-window-ko.md index 5a793d080aae..38b78459d25a 100644 --- a/docs/api/browser-window-ko.md +++ b/docs/api/browser-window-ko.md @@ -1059,7 +1059,7 @@ app.on('ready', function() { The `cookies` gives you ability to query and modify cookies, an example is: -```javascipt +```javascript var BrowserWindow = require('browser-window'); var win = new BrowserWindow({ width: 800, height: 600 }); diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index a339b855bb71..4375c8684b14 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -1059,7 +1059,7 @@ app.on('ready', function() { The `cookies` gives you ability to query and modify cookies, an example is: -```javascipt +```javascript var BrowserWindow = require('browser-window'); var win = new BrowserWindow({ width: 800, height: 600 }); From cb4309bbd995979095995eb437cd844611643c73 Mon Sep 17 00:00:00 2001 From: Robo Date: Mon, 13 Jul 2015 02:20:15 +0530 Subject: [PATCH 0586/1293] webContents: set http useragent settings when overriding user agent --- atom/browser/api/atom_api_web_contents.cc | 36 +++++++++++++++++++++++ atom/browser/native_window.cc | 23 --------------- 2 files changed, 36 insertions(+), 23 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 8db86f35934a..c84ace171af6 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -6,12 +6,15 @@ #include +#include "atom/browser/browser.h" #include "atom/browser/api/atom_api_session.h" #include "atom/browser/atom_browser_client.h" #include "atom/browser/atom_browser_context.h" #include "atom/browser/atom_browser_main_parts.h" #include "atom/browser/native_window.h" #include "atom/browser/web_view_guest_delegate.h" +#include "atom/common/atom_version.h" +#include "atom/common/chrome_version.h" #include "atom/common/api/api_messages.h" #include "atom/common/event_emitter_caller.h" #include "atom/common/native_mate_converters/gfx_converter.h" @@ -20,6 +23,7 @@ #include "atom/common/native_mate_converters/string16_converter.h" #include "atom/common/native_mate_converters/value_converter.h" #include "base/strings/string_util.h" +#include "base/strings/stringprintf.h" #include "base/strings/utf_string_conversions.h" #include "brightray/browser/inspectable_web_contents.h" #include "chrome/browser/printing/print_view_manager_basic.h" @@ -36,10 +40,12 @@ #include "content/public/browser/storage_partition.h" #include "content/public/browser/site_instance.h" #include "content/public/browser/web_contents.h" +#include "content/public/common/user_agent.h" #include "native_mate/callback.h" #include "native_mate/dictionary.h" #include "native_mate/object_template_builder.h" #include "net/http/http_response_headers.h" +#include "net/url_request/static_http_user_agent_settings.h" #include "net/url_request/url_request_context.h" #include "atom/common/node_includes.h" @@ -51,6 +57,20 @@ struct PrintSettings { bool print_background; }; +std::string RemoveWhitespace(const std::string& str) { + std::string trimmed; + if (base::RemoveChars(str, " ", &trimmed)) + return trimmed; + else + return str; +} + +void SetUserAgentInIO(scoped_refptr getter, + std::string user_agent) { + getter->GetURLRequestContext()->set_http_user_agent_settings( + new net::StaticHttpUserAgentSettings("en-us,en", user_agent)); +} + } // namespace namespace mate { @@ -167,6 +187,7 @@ WebContents::WebContents(const mate::Dictionary& options) { Observe(web_contents); AttachAsUserData(web_contents); InitWithWebContents(web_contents); + SetUserAgent(std::string()); if (is_guest) { guest_delegate_->Initialize(this); @@ -546,7 +567,22 @@ bool WebContents::IsCrashed() const { } void WebContents::SetUserAgent(const std::string& user_agent) { + if (user_agent.empty()) { + // Default User Agent. + Browser* browser = Browser::Get(); + std::string product_name = base::StringPrintf( + "%s/%s Chrome/%s " ATOM_PRODUCT_NAME "/" ATOM_VERSION_STRING, + RemoveWhitespace(browser->GetName()).c_str(), + browser->GetVersion().c_str(), + CHROME_VERSION_STRING); + const_cast(user_agent) = + content::BuildUserAgentFromProduct(product_name); + } web_contents()->SetUserAgentOverride(user_agent); + scoped_refptr getter = + web_contents()->GetBrowserContext()->GetRequestContext(); + getter->GetNetworkTaskRunner()->PostTask(FROM_HERE, + base::Bind(&SetUserAgentInIO, getter, user_agent)); } void WebContents::InsertCSS(const std::string& css) { diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index c9f209a3a2b4..b9e765315b6a 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -10,11 +10,8 @@ #include "atom/browser/atom_browser_context.h" #include "atom/browser/atom_browser_main_parts.h" -#include "atom/browser/browser.h" #include "atom/browser/window_list.h" #include "atom/common/api/api_messages.h" -#include "atom/common/atom_version.h" -#include "atom/common/chrome_version.h" #include "atom/common/native_mate_converters/image_converter.h" #include "atom/common/native_mate_converters/file_path_converter.h" #include "atom/common/options_switches.h" @@ -24,7 +21,6 @@ #include "base/prefs/pref_service.h" #include "base/message_loop/message_loop.h" #include "base/strings/string_number_conversions.h" -#include "base/strings/stringprintf.h" #include "base/strings/utf_string_conversions.h" #include "brightray/browser/inspectable_web_contents.h" #include "brightray/browser/inspectable_web_contents_view.h" @@ -36,7 +32,6 @@ #include "content/public/browser/render_widget_host_view.h" #include "content/public/common/content_switches.h" #include "content/public/common/renderer_preferences.h" -#include "content/public/common/user_agent.h" #include "content/public/common/web_preferences.h" #include "ipc/ipc_message_macros.h" #include "native_mate/dictionary.h" @@ -73,14 +68,6 @@ const char* kWebRuntimeFeatures[] = { switches::kPageVisibility, }; -std::string RemoveWhitespace(const std::string& str) { - std::string trimmed; - if (base::RemoveChars(str, " ", &trimmed)) - return trimmed; - else - return str; -} - } // namespace NativeWindow::NativeWindow( @@ -130,16 +117,6 @@ NativeWindow::NativeWindow( options.Get(switches::kZoomFactor, &zoom_factor_); WindowList::AddWindow(this); - - // Override the user agent to contain application and atom-shell's version. - Browser* browser = Browser::Get(); - std::string product_name = base::StringPrintf( - "%s/%s Chrome/%s " ATOM_PRODUCT_NAME "/" ATOM_VERSION_STRING, - RemoveWhitespace(browser->GetName()).c_str(), - browser->GetVersion().c_str(), - CHROME_VERSION_STRING); - web_contents()->GetMutableRendererPrefs()->user_agent_override = - content::BuildUserAgentFromProduct(product_name); } NativeWindow::~NativeWindow() { From 04606a9f97b37d3563f365f48258f3fe9eeb4f6a Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Mon, 13 Jul 2015 13:51:18 +0800 Subject: [PATCH 0587/1293] Enable 'accept' attribute in 'input' label. --- atom/browser/web_dialog_helper.cc | 51 +++++++++++++++++++++++++++++-- 1 file changed, 49 insertions(+), 2 deletions(-) diff --git a/atom/browser/web_dialog_helper.cc b/atom/browser/web_dialog_helper.cc index f6f233453582..bbf16b5fc23c 100644 --- a/atom/browser/web_dialog_helper.cc +++ b/atom/browser/web_dialog_helper.cc @@ -4,17 +4,61 @@ #include "atom/browser/web_dialog_helper.h" +#include #include #include "atom/browser/ui/file_dialog.h" #include "base/bind.h" #include "base/files/file_enumerator.h" +#include "base/files/file_path.h" #include "base/strings/utf_string_conversions.h" #include "content/public/browser/render_view_host.h" #include "content/public/browser/web_contents.h" #include "content/public/common/file_chooser_file_info.h" +#include "net/base/mime_util.h" #include "ui/shell_dialogs/selected_file_info.h" +namespace { + +file_dialog::Filters GetFileTypesFromAcceptType( + const std::vector& accept_types) { + file_dialog::Filters filters; + if (accept_types.empty()) + return filters; + + std::vector extensions; + + for (const auto& accept_type : accept_types) { + std::string ascii_type = base::UTF16ToASCII(accept_type); + if (ascii_type[0] == '.') { + // If the type starts with a period it is assumed to be a file extension, + // like `.txt`, // so we just have to add it to the list. + base::FilePath::StringType extension( + ascii_type.begin(), ascii_type.end()); + // Skip the first character. + extensions.push_back(extension.substr(1)); + } else { + if (ascii_type == "image/*" || ascii_type == "audio/*" || + ascii_type == "video/*") { + // For MIME Type + net::GetExtensionsForMimeType(ascii_type, &extensions); + } + } + } + + filters.push_back(file_dialog::Filter()); + for (const auto& extension : extensions) { +#if defined(OS_WIN) + filters[0].second.push_back(base::UTF16ToASCII(extension)); +#else + filters[0].second.push_back(extension); +#endif + } + return filters; +} + +} // namespace + namespace atom { WebDialogHelper::WebDialogHelper(NativeWindow* window) @@ -25,15 +69,18 @@ WebDialogHelper::WebDialogHelper(NativeWindow* window) WebDialogHelper::~WebDialogHelper() { } + void WebDialogHelper::RunFileChooser(content::WebContents* web_contents, const content::FileChooserParams& params) { std::vector result; + file_dialog::Filters filters = GetFileTypesFromAcceptType( + params.accept_types); if (params.mode == content::FileChooserParams::Save) { base::FilePath path; if (file_dialog::ShowSaveDialog(window_, base::UTF16ToUTF8(params.title), params.default_file_name, - file_dialog::Filters(), + filters, &path)) { content::FileChooserFileInfo info; info.file_path = path; @@ -59,7 +106,7 @@ void WebDialogHelper::RunFileChooser(content::WebContents* web_contents, if (file_dialog::ShowOpenDialog(window_, base::UTF16ToUTF8(params.title), params.default_file_name, - file_dialog::Filters(), + filters, flags, &paths)) { for (auto& path : paths) { From eadd2f8de6e29dccefc73c6b8b30568c203b7822 Mon Sep 17 00:00:00 2001 From: LYK Date: Mon, 13 Jul 2015 23:29:06 +0900 Subject: [PATCH 0588/1293] Update README-ko.md Remove a personal email address and repository. --- docs/README-ko.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/README-ko.md b/docs/README-ko.md index 50c4b2c9c9ca..b48c6a42c516 100644 --- a/docs/README-ko.md +++ b/docs/README-ko.md @@ -66,6 +66,3 @@ * [빌드 설명서 (Windows)](development/build-instructions-windows-ko.md) * [빌드 설명서 (Linux)](development/build-instructions-linux-ko.md) * [디버거에서 디버그 심볼 서버 설정](development/setting-up-symbol-server-ko.md) - -이 문서는 [@preco21](https://github.com/preco21) 에 의해 번역되었습니다. -문서내에서 오타나 잘못된 번역이 발견될 경우 해당 repo를 fork한 후 수정하여 PR을 올리거나 `plusb21@gmail.com` 이메일로 알려주시면 감사하겠습니다. From 9e8a118d104030127f371b79f846a4390b2ec674 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 14 Jul 2015 03:23:19 +0800 Subject: [PATCH 0589/1293] Cleanup code --- atom/browser/native_window.cc | 11 +++++------ atom/renderer/atom_renderer_client.cc | 20 +++++++++----------- 2 files changed, 14 insertions(+), 17 deletions(-) diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index bfac0b6fb7bc..26cb3985386f 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -393,12 +393,11 @@ void NativeWindow::AppendExtraCommandLineSwitches( base::DoubleToString(zoom_factor_)); #if defined(OS_WIN) - PWSTR explicit_app_id; - - if (SUCCEEDED(GetCurrentProcessExplicitAppUserModelID(&explicit_app_id))) { - base::string16 appId = base::string16(explicit_app_id); - command_line->AppendSwitchNative(switches::kAppUserModelId, appId); - CoTaskMemFree(explicit_app_id); + // Append --app-user-model-id. + PWSTR current_app_id; + if (SUCCEEDED(GetCurrentProcessExplicitAppUserModelID(¤t_app_id))) { + command_line->AppendSwitchNative(switches::kAppUserModelId, current_app_id); + CoTaskMemFree(current_app_id); } #endif diff --git a/atom/renderer/atom_renderer_client.cc b/atom/renderer/atom_renderer_client.cc index 178be339008d..0311f8b540b0 100644 --- a/atom/renderer/atom_renderer_client.cc +++ b/atom/renderer/atom_renderer_client.cc @@ -91,17 +91,6 @@ void AtomRendererClient::WebKitInitialized() { blink::WebCustomElement::addEmbedderCustomElementName("webview"); blink::WebCustomElement::addEmbedderCustomElementName("browserplugin"); -#if defined(OS_WIN) - base::CommandLine* command_line = - base::CommandLine::ForCurrentProcess(); - base::string16 explicit_app_id = - command_line->GetSwitchValueNative(switches::kAppUserModelId); - - if (explicit_app_id.length() > 0) { - SetCurrentProcessExplicitAppUserModelID(explicit_app_id.c_str()); - } -#endif - node_bindings_->Initialize(); node_bindings_->PrepareMessageLoop(); @@ -117,6 +106,15 @@ void AtomRendererClient::WebKitInitialized() { void AtomRendererClient::RenderThreadStarted() { content::RenderThread::Get()->AddObserver(this); + +#if defined(OS_WIN) + base::CommandLine* command_line = base::CommandLine::ForCurrentProcess(); + base::string16 app_id = + command_line->GetSwitchValueNative(switches::kAppUserModelId); + if (!app_id.empty()) { + SetCurrentProcessExplicitAppUserModelID(app_id.c_str()); + } +#endif } void AtomRendererClient::RenderFrameCreated( From 6840d424cdae00389f0651143a13663906d606a0 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 13 Jul 2015 12:41:07 -0700 Subject: [PATCH 0590/1293] docs: Add WebContents.session --- docs/api/browser-window.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 7850fcabbdc8..ec6d10c7aaeb 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -784,6 +784,10 @@ Emitted when a plugin process is crashed. Emitted when the WebContents is destroyed. +### WebContents.session + +Returns the `Session` object used by this WebContents. + ### WebContents.loadUrl(url, [options]) * `url` URL From 7dba4d1d8d1c48326fee5ad82de490a430275c6f Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 13 Jul 2015 14:27:07 -0700 Subject: [PATCH 0591/1293] Call callback of ClearCache after cache is doomed --- atom/browser/api/atom_api_session.cc | 48 ++++++++++++++++------------ atom/browser/api/atom_api_session.h | 4 +-- 2 files changed, 30 insertions(+), 22 deletions(-) diff --git a/atom/browser/api/atom_api_session.cc b/atom/browser/api/atom_api_session.cc index 4236fddc136c..9f8595697984 100644 --- a/atom/browser/api/atom_api_session.cc +++ b/atom/browser/api/atom_api_session.cc @@ -130,28 +130,37 @@ class ResolveProxyHelper { DISALLOW_COPY_AND_ASSIGN(ResolveProxyHelper); }; -void Noop(int result) { - DCHECK(result == net::OK); +// Runs the callback in UI thread. +void RunCallbackInUI(const net::CompletionCallback& callback, int result) { + BrowserThread::PostTask( + BrowserThread::UI, FROM_HERE, base::Bind(callback, result)); } -void DoClearCache(disk_cache::Backend** cache_ptr, +// Callback of HttpCache::GetBackend. +void OnGetBackend(disk_cache::Backend** backend_ptr, + const net::CompletionCallback& callback, int result) { - DCHECK(result == net::OK); - if (cache_ptr && *cache_ptr) - (*cache_ptr)->DoomAllEntries(base::Bind(&Noop)); + if (result != net::OK) { + RunCallbackInUI(callback, result); + } else if (backend_ptr && *backend_ptr) { + (*backend_ptr)->DoomAllEntries(base::Bind(&RunCallbackInUI, callback)); + } else { + RunCallbackInUI(callback, net::ERR_FAILED); + } } -void ClearHttpCacheOnIO(net::URLRequestContextGetter* getter) { - typedef disk_cache::Backend* Backendptr; - Backendptr* cache_ptr = new Backendptr(nullptr); - auto request_context = getter->GetURLRequestContext(); - net::CompletionCallback callback(base::Bind(&DoClearCache, - base::Owned(cache_ptr))); +void ClearHttpCacheInIO(content::BrowserContext* browser_context, + const net::CompletionCallback& callback) { + auto request_context = + browser_context->GetRequestContext()->GetURLRequestContext(); auto http_cache = request_context->http_transaction_factory()->GetCache(); - int rv = http_cache->GetBackend(cache_ptr, callback); + disk_cache::Backend** backend_ptr = nullptr; + net::CompletionCallback on_get_backend = + base::Bind(&OnGetBackend, base::Owned(backend_ptr), callback); + int rv = http_cache->GetBackend(backend_ptr, on_get_backend); if (rv != net::ERR_IO_PENDING) - callback.Run(net::OK); + on_get_backend.Run(net::OK); } } // namespace @@ -168,12 +177,11 @@ void Session::ResolveProxy(const GURL& url, ResolveProxyCallback callback) { new ResolveProxyHelper(browser_context_, url, callback); } -void Session::ClearCache(const base::Closure& callback) { - auto getter = browser_context_->GetRequestContext(); - BrowserThread::PostTaskAndReply(BrowserThread::IO, FROM_HERE, - base::Bind(&ClearHttpCacheOnIO, - base::Unretained(getter)), - callback); +void Session::ClearCache(const net::CompletionCallback& callback) { + BrowserThread::PostTask(BrowserThread::IO, FROM_HERE, + base::Bind(&ClearHttpCacheInIO, + base::Unretained(browser_context_), + callback)); } void Session::ClearStorageData(const GURL& origin, diff --git a/atom/browser/api/atom_api_session.h b/atom/browser/api/atom_api_session.h index ec9083d3054a..9b0f6b23214a 100644 --- a/atom/browser/api/atom_api_session.h +++ b/atom/browser/api/atom_api_session.h @@ -9,8 +9,8 @@ #include #include "atom/browser/api/trackable_object.h" -#include "base/callback.h" #include "native_mate/handle.h" +#include "net/base/completion_callback.h" class GURL; @@ -38,7 +38,7 @@ class Session: public mate::TrackableObject { private: void ResolveProxy(const GURL& url, ResolveProxyCallback callback); - void ClearCache(const base::Closure& callback); + void ClearCache(const net::CompletionCallback& callback); void ClearStorageData(const GURL& origin, const std::vector& storage_types, const std::vector& quota_types, From 868dee55de1144f77595470755eb78a4becae4f0 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 13 Jul 2015 15:13:17 -0700 Subject: [PATCH 0592/1293] The options of clearStorageData should be optional --- atom/browser/api/atom_api_session.cc | 90 +++++++++++++++++++--------- atom/browser/api/atom_api_session.h | 10 ++-- docs/api/browser-window.md | 26 ++++---- 3 files changed, 83 insertions(+), 43 deletions(-) diff --git a/atom/browser/api/atom_api_session.cc b/atom/browser/api/atom_api_session.cc index 9f8595697984..93f8de52dd45 100644 --- a/atom/browser/api/atom_api_session.cc +++ b/atom/browser/api/atom_api_session.cc @@ -5,6 +5,7 @@ #include "atom/browser/api/atom_api_session.h" #include +#include #include "atom/browser/api/atom_api_cookies.h" #include "atom/browser/atom_browser_context.h" @@ -28,49 +29,74 @@ using content::StoragePartition; namespace { -int GetStorageMask(const std::vector& storage_types) { - int storage_mask = 0; +struct ClearStorageDataOptions { + GURL origin; + uint32 storage_types = StoragePartition::REMOVE_DATA_MASK_ALL; + uint32 quota_types = StoragePartition::QUOTA_MANAGED_STORAGE_MASK_ALL; +}; - for (auto &it : storage_types) { +uint32 GetStorageMask(const std::vector& storage_types) { + uint32 storage_mask = 0; + for (const auto& it : storage_types) { auto type = base::StringToLowerASCII(it); - if (type == "appcache") { + if (type == "appcache") storage_mask |= StoragePartition::REMOVE_DATA_MASK_APPCACHE; - } else if (type == "cookies") { + else if (type == "cookies") storage_mask |= StoragePartition::REMOVE_DATA_MASK_COOKIES; - } else if (type == "filesystem") { + else if (type == "filesystem") storage_mask |= StoragePartition::REMOVE_DATA_MASK_FILE_SYSTEMS; - } else if (type == "indexdb") { + else if (type == "indexdb") storage_mask |= StoragePartition::REMOVE_DATA_MASK_INDEXEDDB; - } else if (type == "localstorage") { + else if (type == "localstorage") storage_mask |= StoragePartition::REMOVE_DATA_MASK_LOCAL_STORAGE; - } else if (type == "shadercache") { + else if (type == "shadercache") storage_mask |= StoragePartition::REMOVE_DATA_MASK_SHADER_CACHE; - } else if (type == "websql") { + else if (type == "websql") storage_mask |= StoragePartition::REMOVE_DATA_MASK_WEBSQL; - } else if (type == "serviceworkers") { + else if (type == "serviceworkers") storage_mask |= StoragePartition::REMOVE_DATA_MASK_SERVICE_WORKERS; - } } - return storage_mask; } -int GetQuotaMask(const std::vector& quota_types) { - int quota_mask = 0; - - for (auto &type : quota_types) { - if (type == "temporary") { +uint32 GetQuotaMask(const std::vector& quota_types) { + uint32 quota_mask = 0; + for (const auto& it : quota_types) { + auto type = base::StringToLowerASCII(it); + if (type == "temporary") quota_mask |= StoragePartition::QUOTA_MANAGED_STORAGE_MASK_TEMPORARY; - } else if (type == "persistent") { + else if (type == "persistent") quota_mask |= StoragePartition::QUOTA_MANAGED_STORAGE_MASK_PERSISTENT; - } + else if (type == "syncable") + quota_mask |= StoragePartition::QUOTA_MANAGED_STORAGE_MASK_SYNCABLE; } - return quota_mask; } } // namespace +namespace mate { + +template<> +struct Converter { + static bool FromV8(v8::Isolate* isolate, + v8::Local val, + ClearStorageDataOptions* out) { + mate::Dictionary options; + if (!ConvertFromV8(isolate, val, &options)) + return false; + options.Get("origin", &out->origin); + std::vector types; + if (options.Get("storages", &types)) + out->storage_types = GetStorageMask(types); + if (options.Get("quotas", &types)) + out->quota_types = GetQuotaMask(types); + return true; + } +}; + +} // namespace mate + namespace atom { namespace api { @@ -154,8 +180,12 @@ void ClearHttpCacheInIO(content::BrowserContext* browser_context, auto request_context = browser_context->GetRequestContext()->GetURLRequestContext(); auto http_cache = request_context->http_transaction_factory()->GetCache(); + if (!http_cache) + RunCallbackInUI(callback, net::ERR_FAILED); - disk_cache::Backend** backend_ptr = nullptr; + // Call GetBackend and make the backend's ptr accessable in OnGetBackend. + using BackendPtr = disk_cache::Backend*; + BackendPtr* backend_ptr = new BackendPtr(nullptr); net::CompletionCallback on_get_backend = base::Bind(&OnGetBackend, base::Owned(backend_ptr), callback); int rv = http_cache->GetBackend(backend_ptr, on_get_backend); @@ -184,14 +214,20 @@ void Session::ClearCache(const net::CompletionCallback& callback) { callback)); } -void Session::ClearStorageData(const GURL& origin, - const std::vector& storage_types, - const std::vector& quota_types, - const base::Closure& callback) { +void Session::ClearStorageData(mate::Arguments* args) { + // clearStorageData([options, ]callback) + ClearStorageDataOptions options; + args->GetNext(&options); + base::Closure callback; + if (!args->GetNext(&callback)) { + args->ThrowError(); + return; + } + auto storage_partition = content::BrowserContext::GetStoragePartition(browser_context_, nullptr); storage_partition->ClearData( - GetStorageMask(storage_types), GetQuotaMask(quota_types), origin, + options.storage_types, options.quota_types, options.origin, content::StoragePartition::OriginMatcherFunction(), base::Time(), base::Time::Max(), callback); } diff --git a/atom/browser/api/atom_api_session.h b/atom/browser/api/atom_api_session.h index 9b0f6b23214a..59e1a9380796 100644 --- a/atom/browser/api/atom_api_session.h +++ b/atom/browser/api/atom_api_session.h @@ -6,7 +6,6 @@ #define ATOM_BROWSER_API_ATOM_API_SESSION_H_ #include -#include #include "atom/browser/api/trackable_object.h" #include "native_mate/handle.h" @@ -14,6 +13,10 @@ class GURL; +namespace mate { +class Arguments; +} + namespace atom { class AtomBrowserContext; @@ -39,10 +42,7 @@ class Session: public mate::TrackableObject { private: void ResolveProxy(const GURL& url, ResolveProxyCallback callback); void ClearCache(const net::CompletionCallback& callback); - void ClearStorageData(const GURL& origin, - const std::vector& storage_types, - const std::vector& quota_types, - const base::Closure& callback); + void ClearStorageData(mate::Arguments* args); v8::Local Cookies(v8::Isolate* isolate); v8::Global cookies_; diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index ec6d10c7aaeb..fca705bdf759 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -1148,18 +1148,22 @@ win.webContents.on('did-finish-load', function() { * `callback` Function - function(error) * `error` Error -### Session.clearCache() +### Session.clearCache(callback) -Clears the session's http cache. +* `callback` Function - Called when operation is done -### Session.clearStorageData(origin, storageType, quotaType, callback) +Clears the session's HTTP cache. -* `origin` String - should follow `window.location.origin` representation `scheme`://`host`:`port` -* `storageType` Array - specifies the type of storage, can contain - - `appcache`, `cookies`, `filesystem`, `indexdb`, `localstorage`, `shadercache`, `websql`, - `serviceworkers` -* `quotaType` Array - specifies the storage quota type, can contain - - `temporary`, `persistent` -* `callback` Function +### Session.clearStorageData([options, ]callback) -`callback` is invoked when the deletion process is scheduled. +* `options` Object + * `origin` String - Should follow `window.location.origin`'s representation + `scheme://host:port` + * `storages` Array - The types of storages to clear, can contain: + `appcache`, `cookies`, `filesystem`, `indexdb`, `localstorage`, + `shadercache`, `websql`, `serviceworkers` + * `quotas` Array - The types of quotas to clear, can contain: + `temporary`, `persistent`, `syncable` +* `callback` Function - Called when operation is done + +Clears the data of web storages. From f8df377631beb30a972e3b149b16aa7cffb28b84 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 13 Jul 2015 15:14:28 -0700 Subject: [PATCH 0593/1293] Update brightray, refs #1599 --- vendor/brightray | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/brightray b/vendor/brightray index e0c977c5e76e..6a38d97aa8f4 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit e0c977c5e76ef79e89f6eeb3117fc5d355fbaf22 +Subproject commit 6a38d97aa8f4e1ab1842416f632a2a45adfbc738 From 83e8ceceda64d47b304b6c2db676470ae45daf72 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 13 Jul 2015 15:22:40 -0700 Subject: [PATCH 0594/1293] Fix session specs --- spec/api-session-spec.coffee | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/spec/api-session-spec.coffee b/spec/api-session-spec.coffee index d439b6373cda..f957860f91b8 100644 --- a/spec/api-session-spec.coffee +++ b/spec/api-session-spec.coffee @@ -80,5 +80,9 @@ describe 'session module', -> done() w.loadUrl 'file://' + path.join(fixtures, 'api', 'localstorage.html') w.webContents.on 'did-finish-load', -> - w.webContents.session.clearStorageData "file://", ['localstorage'], ['persistent'], -> + options = + origin: "file://", + storages: ['localstorage'], + quotas: ['persistent'], + w.webContents.session.clearStorageData options, -> w.webContents.send 'getcount' From e5f852d7d5fbd18b3702cabaf5e5ba981a6540ad Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 13 Jul 2015 15:26:35 -0700 Subject: [PATCH 0595/1293] docs: Adds the dependencies of arm target Close #2181 --- docs/development/build-instructions-linux.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/development/build-instructions-linux.md b/docs/development/build-instructions-linux.md index 161f77d9956e..3fe3b53c210f 100644 --- a/docs/development/build-instructions-linux.md +++ b/docs/development/build-instructions-linux.md @@ -48,7 +48,15 @@ $ ./script/bootstrap.py -v ### Cross compilation -If you want to cross compile for `arm` or `ia32` targets, you can pass the +If you want to build for `arm` target, you should also install following +dependencies: + +```bash +$ sudo apt-get install libc6-dev-armhf-cross linux-libc-dev-armhf-cross \ + g++-arm-linux-gnueabihf +``` + +And to cross compile for `arm` or `ia32` targets, you should pass the `--target_arch` parameter to the `bootstrap.py` script: ```bash From 5863ed4c33fde2b72f1a94f071aeb528ccc4e911 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 13 Jul 2015 21:49:29 -0700 Subject: [PATCH 0596/1293] win: Also map MESSAGE_BOX_TYPE_QUESTION to TD_INFORMATION_ICON --- atom/browser/ui/message_box_win.cc | 1 + 1 file changed, 1 insertion(+) diff --git a/atom/browser/ui/message_box_win.cc b/atom/browser/ui/message_box_win.cc index 9487013d3206..dae518deb4dc 100644 --- a/atom/browser/ui/message_box_win.cc +++ b/atom/browser/ui/message_box_win.cc @@ -98,6 +98,7 @@ int ShowMessageBoxUTF16(HWND parent, // Show icon according to dialog's type. switch (type) { case MESSAGE_BOX_TYPE_INFORMATION: + case MESSAGE_BOX_TYPE_QUESTION: config.pszMainIcon = TD_INFORMATION_ICON; break; case MESSAGE_BOX_TYPE_WARNING: From 5708b7fbecd3de89589be36554b73e969eda0a15 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 14 Jul 2015 02:32:20 -0700 Subject: [PATCH 0597/1293] Fix the ill cookie test --- spec/api-session-spec.coffee | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/spec/api-session-spec.coffee b/spec/api-session-spec.coffee index f957860f91b8..2999d1519d58 100644 --- a/spec/api-session-spec.coffee +++ b/spec/api-session-spec.coffee @@ -46,14 +46,15 @@ describe 'session module', -> w.loadUrl 'file://' + path.join(fixtures, 'page', 'a.html') w.webContents.on 'did-finish-load', ()-> w.webContents.session.cookies.set {url: url, name: 'key', value: 'dummy2'}, (error) -> - throw error if error + return done(error) if error w.webContents.session.cookies.get {url: url}, (error, cookies_list) -> - throw error if error - assert.equal 2, cookies_list.length + return done(error) if error for cookie in cookies_list if cookie.name is 'key' assert.equal 'dummy2', cookie.value - done(); + done() + return + done('Can not find cookie') it 'should remove cookies', (done) -> w.loadUrl 'file://' + path.join(fixtures, 'page', 'a.html') From 7f0607242002b638eb3186ce49c85b85e58e99e1 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 14 Jul 2015 17:19:46 +0800 Subject: [PATCH 0598/1293] Avoiding creating static STL containers It is OK under most cases, but if you happen to also use COM in your application, you will have heap corruptions. --- atom/browser/api/trackable_object.h | 25 +++++++++++++++++-------- 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/atom/browser/api/trackable_object.h b/atom/browser/api/trackable_object.h index d915135f0971..656904cc45d0 100644 --- a/atom/browser/api/trackable_object.h +++ b/atom/browser/api/trackable_object.h @@ -9,6 +9,7 @@ #include "atom/browser/api/event_emitter.h" #include "atom/common/id_weak_map.h" +#include "base/memory/scoped_ptr.h" namespace base { class SupportsUserData; @@ -54,7 +55,10 @@ class TrackableObject : public TrackableObjectBase { public: // Finds out the TrackableObject from its ID in weak map. static T* FromWeakMapID(v8::Isolate* isolate, int32_t id) { - v8::MaybeLocal object = weak_map_.Get(isolate, id); + if (!weak_map_) + return nullptr; + + v8::MaybeLocal object = weak_map_->Get(isolate, id); if (object.IsEmpty()) return nullptr; @@ -74,7 +78,10 @@ class TrackableObject : public TrackableObjectBase { // Returns all objects in this class's weak map. static std::vector> GetAll(v8::Isolate* isolate) { - return weak_map_.Values(isolate); + if (weak_map_) + return weak_map_->Values(isolate); + else + return std::vector>(); } TrackableObject() { @@ -83,8 +90,8 @@ class TrackableObject : public TrackableObjectBase { // Removes this instance from the weak map. void RemoveFromWeakMap() { - if (weak_map_.Has(weak_map_id())) - weak_map_.Remove(weak_map_id()); + if (weak_map_ && weak_map_->Has(weak_map_id())) + weak_map_->Remove(weak_map_id()); } protected: @@ -93,23 +100,25 @@ class TrackableObject : public TrackableObjectBase { } void AfterInit(v8::Isolate* isolate) override { - weak_map_id_ = weak_map_.Add(isolate, GetWrapper(isolate)); + if (!weak_map_) + weak_map_.reset(new atom::IDWeakMap); + weak_map_id_ = weak_map_->Add(isolate, GetWrapper(isolate)); TrackableObjectBase::AfterInit(isolate); } private: // Releases all weak references in weak map, called when app is terminating. static void ReleaseAllWeakReferences() { - weak_map_.Clear(); + weak_map_.reset(); } - static atom::IDWeakMap weak_map_; + static scoped_ptr weak_map_; DISALLOW_COPY_AND_ASSIGN(TrackableObject); }; template -atom::IDWeakMap TrackableObject::weak_map_; +scoped_ptr TrackableObject::weak_map_; } // namespace mate From b3c51e46e71da8308b9245409731a9fd37a5f401 Mon Sep 17 00:00:00 2001 From: Peter Butcher Date: Tue, 14 Jul 2015 16:37:52 +0100 Subject: [PATCH 0599/1293] Update window-open.md Just an irritating typo. --- docs/api/window-open.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/window-open.md b/docs/api/window-open.md index 23bcf2b95f33..fa10b2e7d055 100644 --- a/docs/api/window-open.md +++ b/docs/api/window-open.md @@ -2,7 +2,7 @@ When `window.open` is called to create a new window in web page, a new instance of `BrowserWindow` will be created for the `url`, and a proxy will be returned -to `window.open` to let the page to have limited control over it. +to `window.open` to let the page have limited control over it. The proxy only has some limited standard functionality implemented to be compatible with traditional web pages, for full control of the created window From ce2422612884b4189a98a6db6a85242fc267112b Mon Sep 17 00:00:00 2001 From: Jeffrey Morgan Date: Tue, 14 Jul 2015 16:58:15 +0100 Subject: [PATCH 0600/1293] Update global-shortcut.md Improved the grammar and code formatting of global-shortcut.md. --- docs/api/global-shortcut.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/api/global-shortcut.md b/docs/api/global-shortcut.md index 16399cfbfe49..54da5638d194 100644 --- a/docs/api/global-shortcut.md +++ b/docs/api/global-shortcut.md @@ -1,9 +1,9 @@ # global-shortcut The `global-shortcut` module can register/unregister a global keyboard shortcut -in operating system, so that you can customize the operations for various shortcuts. -Note that the shortcut is global, even if the app does not get focused, it will still work. -You should not use this module until the ready event of app module gets emitted. +with the operating system, so that you can customize the operations for various shortcuts. +Note that the shortcut is global; it will work even if the app does not have the keyboard focus. +You should not use this module until the `ready` event of the app module is emitted. ```javascript var app = require('app'); @@ -37,14 +37,14 @@ app.on('will-quit', function() { * `accelerator` [Accelerator](accelerator.md) * `callback` Function -Registers a global shortcut of `accelerator`, the `callback` would be called when -the registered shortcut is pressed by user. +Registers a global shortcut of `accelerator`. The `callback` is called when +the registered shortcut is pressed by the user. ## globalShortcut.isRegistered(accelerator) * `accelerator` [Accelerator](accelerator.md) -Returns `true` or `false` depending on if the shortcut `accelerator` is registered. +Returns `true` or `false` depending on whether the shortcut `accelerator` is registered. ## globalShortcut.unregister(accelerator) From 020ccd80188a4fddae803de0849c8cfefd55652c Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 14 Jul 2015 08:59:06 -0700 Subject: [PATCH 0601/1293] spec: Cookie test should not rely on cookie's count Other apps can also write cookie to `file://` protocol. --- spec/api-session-spec.coffee | 42 ++++++++++++++++-------------------- 1 file changed, 19 insertions(+), 23 deletions(-) diff --git a/spec/api-session-spec.coffee b/spec/api-session-spec.coffee index 2999d1519d58..95e495e46520 100644 --- a/spec/api-session-spec.coffee +++ b/spec/api-session-spec.coffee @@ -5,6 +5,7 @@ path = require 'path' BrowserWindow = remote.require 'browser-window' describe 'session module', -> + @timeout 10000 fixtures = path.resolve __dirname, 'fixtures' w = null url = "http://127.0.0.1" @@ -22,29 +23,27 @@ describe 'session module', -> server.listen port, '127.0.0.1', -> {port} = server.address() w.loadUrl "#{url}:#{port}" - w.webContents.on 'did-finish-load', ()-> + w.webContents.on 'did-finish-load', -> w.webContents.session.cookies.get {url: url}, (error, cookies) -> - throw error if error - assert.equal 1, cookies.length + return done(error) if error assert.equal 'type', cookies[0].name assert.equal 'dummy', cookies[0].value done() - it 'should overwrite the existent cookie', (done) -> + it 'should over-write the existent cookie', (done) -> w.loadUrl 'file://' + path.join(fixtures, 'page', 'a.html') - w.webContents.on 'did-finish-load', ()-> + w.webContents.on 'did-finish-load', -> w.webContents.session.cookies.set {url: url, name: 'type', value: 'dummy2'}, (error) -> - throw error if error + return done(error) if error w.webContents.session.cookies.get {url: url}, (error, cookies_list) -> - throw error if error - assert.equal 1, cookies_list.length + return done(error) if error assert.equal 'type', cookies_list[0].name assert.equal 'dummy2', cookies_list[0].value done() it 'should set new cookie', (done) -> w.loadUrl 'file://' + path.join(fixtures, 'page', 'a.html') - w.webContents.on 'did-finish-load', ()-> + w.webContents.on 'did-finish-load', -> w.webContents.session.cookies.set {url: url, name: 'key', value: 'dummy2'}, (error) -> return done(error) if error w.webContents.session.cookies.get {url: url}, (error, cookies_list) -> @@ -52,24 +51,21 @@ describe 'session module', -> for cookie in cookies_list if cookie.name is 'key' assert.equal 'dummy2', cookie.value - done() - return + return done() done('Can not find cookie') it 'should remove cookies', (done) -> w.loadUrl 'file://' + path.join(fixtures, 'page', 'a.html') - w.webContents.on 'did-finish-load', ()-> - w.webContents.session.cookies.get {url: url}, (error, cookies_list) -> - count = 0 - for cookie in cookies_list - w.webContents.session.cookies.remove {url: url, name: cookie.name}, (error) -> - throw error if error - ++count - if count == cookies_list.length - w.webContents.session.cookies.get {url: url}, (error, cookies_list) -> - throw error if error - assert.equal 0, cookies_list.length - done() + w.webContents.on 'did-finish-load', -> + w.webContents.session.cookies.set {url: url, name: 'key', value: 'dummy2'}, (error) -> + return done(error) if error + w.webContents.session.cookies.remove {url: url, name: 'key'}, (error) -> + return done(error) if error + w.webContents.session.cookies.get {url: url}, (error, list) -> + return done(error) if error + for cookie in list when cookie.name is 'key' + return done('Cookie not deleted') + done() describe 'session.clearStorageData(options)', -> fixtures = path.resolve __dirname, 'fixtures' From 346fb745f279c79fa22d45643ecbdf329d04f8d2 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 14 Jul 2015 09:14:22 -0700 Subject: [PATCH 0602/1293] No need to actually create a page for cookie test --- spec/api-session-spec.coffee | 74 ++++++++++++++++-------------------- 1 file changed, 32 insertions(+), 42 deletions(-) diff --git a/spec/api-session-spec.coffee b/spec/api-session-spec.coffee index 95e495e46520..bd7c9bde5923 100644 --- a/spec/api-session-spec.coffee +++ b/spec/api-session-spec.coffee @@ -1,7 +1,8 @@ -assert = require 'assert' -remote = require 'remote' -http = require 'http' -path = require 'path' +assert = require 'assert' +remote = require 'remote' +http = require 'http' +path = require 'path' +app = remote.require 'app' BrowserWindow = remote.require 'browser-window' describe 'session module', -> @@ -15,7 +16,7 @@ describe 'session module', -> it 'should get cookies', (done) -> server = http.createServer (req, res) -> - res.setHeader('Set-Cookie', ['type=dummy']) + res.setHeader('Set-Cookie', ['0=0']) res.end('finished') server.close() @@ -24,48 +25,37 @@ describe 'session module', -> {port} = server.address() w.loadUrl "#{url}:#{port}" w.webContents.on 'did-finish-load', -> - w.webContents.session.cookies.get {url: url}, (error, cookies) -> + w.webContents.session.cookies.get {url: url}, (error, list) -> return done(error) if error - assert.equal 'type', cookies[0].name - assert.equal 'dummy', cookies[0].value - done() - - it 'should over-write the existent cookie', (done) -> - w.loadUrl 'file://' + path.join(fixtures, 'page', 'a.html') - w.webContents.on 'did-finish-load', -> - w.webContents.session.cookies.set {url: url, name: 'type', value: 'dummy2'}, (error) -> - return done(error) if error - w.webContents.session.cookies.get {url: url}, (error, cookies_list) -> - return done(error) if error - assert.equal 'type', cookies_list[0].name - assert.equal 'dummy2', cookies_list[0].value - done() - - it 'should set new cookie', (done) -> - w.loadUrl 'file://' + path.join(fixtures, 'page', 'a.html') - w.webContents.on 'did-finish-load', -> - w.webContents.session.cookies.set {url: url, name: 'key', value: 'dummy2'}, (error) -> - return done(error) if error - w.webContents.session.cookies.get {url: url}, (error, cookies_list) -> - return done(error) if error - for cookie in cookies_list - if cookie.name is 'key' - assert.equal 'dummy2', cookie.value - return done() + for cookie in list when cookie.name is '0' + if cookie.value is '0' + return done() + else + return done("cookie value is #{cookie.value} while expecting 0") done('Can not find cookie') - it 'should remove cookies', (done) -> - w.loadUrl 'file://' + path.join(fixtures, 'page', 'a.html') - w.webContents.on 'did-finish-load', -> - w.webContents.session.cookies.set {url: url, name: 'key', value: 'dummy2'}, (error) -> + it 'should over-write the existent cookie', (done) -> + app.defaultSession.cookies.set {url: url, name: '1', value: '1'}, (error) -> + return done(error) if error + app.defaultSession.cookies.get {url: url}, (error, list) -> return done(error) if error - w.webContents.session.cookies.remove {url: url, name: 'key'}, (error) -> + for cookie in list when cookie.name is '1' + if cookie.value is '1' + return done() + else + return done("cookie value is #{cookie.value} while expecting 1") + done('Can not find cookie') + + it 'should remove cookies', (done) -> + app.defaultSession.cookies.set {url: url, name: '2', value: '2'}, (error) -> + return done(error) if error + app.defaultSession.cookies.remove {url: url, name: '2'}, (error) -> + return done(error) if error + app.defaultSession.cookies.get {url: url}, (error, list) -> return done(error) if error - w.webContents.session.cookies.get {url: url}, (error, list) -> - return done(error) if error - for cookie in list when cookie.name is 'key' - return done('Cookie not deleted') - done() + for cookie in list when cookie.name is '2' + return done('Cookie not deleted') + done() describe 'session.clearStorageData(options)', -> fixtures = path.resolve __dirname, 'fixtures' From 096439dce7d3e9438ede6fbcdfca2291cd5504e3 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 14 Jul 2015 08:38:54 -0700 Subject: [PATCH 0603/1293] Don't expose "global" when node integration is off --- atom/renderer/lib/init.coffee | 1 + 1 file changed, 1 insertion(+) diff --git a/atom/renderer/lib/init.coffee b/atom/renderer/lib/init.coffee index 196891554dd9..32d3ee76d1b9 100644 --- a/atom/renderer/lib/init.coffee +++ b/atom/renderer/lib/init.coffee @@ -93,6 +93,7 @@ else delete global.process delete global.setImmediate delete global.clearImmediate + delete global.global # Load the script specfied by the "preload" attribute. if preloadScript From b6e8420bf2bd6bab0bad52aae8f1871907ec19a2 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 14 Jul 2015 08:42:03 -0700 Subject: [PATCH 0604/1293] spec: Check if window.global is set --- spec/fixtures/pages/c.html | 2 +- spec/webview-spec.coffee | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/spec/fixtures/pages/c.html b/spec/fixtures/pages/c.html index f0e33fde5ea1..bc55104ec535 100644 --- a/spec/fixtures/pages/c.html +++ b/spec/fixtures/pages/c.html @@ -1,7 +1,7 @@ diff --git a/spec/webview-spec.coffee b/spec/webview-spec.coffee index cd22e57a18bf..b47c72ac0fb8 100644 --- a/spec/webview-spec.coffee +++ b/spec/webview-spec.coffee @@ -34,7 +34,7 @@ describe ' tag', -> describe 'nodeintegration attribute', -> it 'inserts no node symbols when not set', (done) -> webview.addEventListener 'console-message', (e) -> - assert.equal e.message, 'undefined undefined undefined' + assert.equal e.message, 'undefined undefined undefined undefined' done() webview.src = "file://#{fixtures}/pages/c.html" document.body.appendChild webview From 56dfef8d0d5da95f9189412dc4d8770b4d0f5770 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 14 Jul 2015 11:38:30 -0700 Subject: [PATCH 0605/1293] spec: Test user agent in websocket --- spec/chromium-spec.coffee | 23 +++++++++++++++++++++++ spec/package.json | 3 ++- 2 files changed, 25 insertions(+), 1 deletion(-) diff --git a/spec/chromium-spec.coffee b/spec/chromium-spec.coffee index 88a3487cc9d2..8ca7e9800fe5 100644 --- a/spec/chromium-spec.coffee +++ b/spec/chromium-spec.coffee @@ -2,6 +2,7 @@ assert = require 'assert' http = require 'http' https = require 'https' path = require 'path' +ws = require 'ws' describe 'chromium feature', -> fixtures = path.resolve __dirname, 'fixtures' @@ -88,3 +89,25 @@ describe 'chromium feature', -> navigator.webkitPersistentStorage.requestQuota 1024 * 1024, (grantedBytes) -> assert.equal grantedBytes, 1048576 done() + + describe 'websockets', -> + wss = null + server = null + WebSocketServer = ws.Server + + afterEach -> + wss.close() + server.close() + + it 'has user agent', (done) -> + server = http.createServer() + server.listen 0, '127.0.0.1', -> + port = server.address().port + wss = new WebSocketServer(server: server) + wss.on 'error', done + wss.on 'connection', (ws) -> + if ws.upgradeReq.headers['user-agent'] + done() + else + done('user agent is empty') + websocket = new WebSocket("ws://127.0.0.1:#{port}") diff --git a/spec/package.json b/spec/package.json index 6e9489e601d8..6343832dcc8e 100644 --- a/spec/package.json +++ b/spec/package.json @@ -11,6 +11,7 @@ "q": "0.9.7", "runas": "2.x", "temp": "0.8.1", - "walkdir": "0.0.7" + "walkdir": "0.0.7", + "ws": "0.7.2" } } From 940db1d1ddcd15030b25399de6ae63c50b2a14d4 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 14 Jul 2015 11:40:07 -0700 Subject: [PATCH 0606/1293] Provide default user agent in BrowserContext --- atom/browser/api/atom_api_web_contents.cc | 25 ----------------------- atom/browser/atom_browser_context.cc | 24 ++++++++++++++++++++++ atom/browser/atom_browser_context.h | 1 + vendor/brightray | 2 +- 4 files changed, 26 insertions(+), 26 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index c84ace171af6..5490b505860a 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -6,15 +6,12 @@ #include -#include "atom/browser/browser.h" #include "atom/browser/api/atom_api_session.h" #include "atom/browser/atom_browser_client.h" #include "atom/browser/atom_browser_context.h" #include "atom/browser/atom_browser_main_parts.h" #include "atom/browser/native_window.h" #include "atom/browser/web_view_guest_delegate.h" -#include "atom/common/atom_version.h" -#include "atom/common/chrome_version.h" #include "atom/common/api/api_messages.h" #include "atom/common/event_emitter_caller.h" #include "atom/common/native_mate_converters/gfx_converter.h" @@ -23,7 +20,6 @@ #include "atom/common/native_mate_converters/string16_converter.h" #include "atom/common/native_mate_converters/value_converter.h" #include "base/strings/string_util.h" -#include "base/strings/stringprintf.h" #include "base/strings/utf_string_conversions.h" #include "brightray/browser/inspectable_web_contents.h" #include "chrome/browser/printing/print_view_manager_basic.h" @@ -40,7 +36,6 @@ #include "content/public/browser/storage_partition.h" #include "content/public/browser/site_instance.h" #include "content/public/browser/web_contents.h" -#include "content/public/common/user_agent.h" #include "native_mate/callback.h" #include "native_mate/dictionary.h" #include "native_mate/object_template_builder.h" @@ -57,14 +52,6 @@ struct PrintSettings { bool print_background; }; -std::string RemoveWhitespace(const std::string& str) { - std::string trimmed; - if (base::RemoveChars(str, " ", &trimmed)) - return trimmed; - else - return str; -} - void SetUserAgentInIO(scoped_refptr getter, std::string user_agent) { getter->GetURLRequestContext()->set_http_user_agent_settings( @@ -187,7 +174,6 @@ WebContents::WebContents(const mate::Dictionary& options) { Observe(web_contents); AttachAsUserData(web_contents); InitWithWebContents(web_contents); - SetUserAgent(std::string()); if (is_guest) { guest_delegate_->Initialize(this); @@ -567,17 +553,6 @@ bool WebContents::IsCrashed() const { } void WebContents::SetUserAgent(const std::string& user_agent) { - if (user_agent.empty()) { - // Default User Agent. - Browser* browser = Browser::Get(); - std::string product_name = base::StringPrintf( - "%s/%s Chrome/%s " ATOM_PRODUCT_NAME "/" ATOM_VERSION_STRING, - RemoveWhitespace(browser->GetName()).c_str(), - browser->GetVersion().c_str(), - CHROME_VERSION_STRING); - const_cast(user_agent) = - content::BuildUserAgentFromProduct(product_name); - } web_contents()->SetUserAgentOverride(user_agent); scoped_refptr getter = web_contents()->GetBrowserContext()->GetRequestContext(); diff --git a/atom/browser/atom_browser_context.cc b/atom/browser/atom_browser_context.cc index 66f1b4444a95..d7c8b8dbbcc3 100644 --- a/atom/browser/atom_browser_context.cc +++ b/atom/browser/atom_browser_context.cc @@ -6,16 +6,22 @@ #include "atom/browser/atom_browser_main_parts.h" #include "atom/browser/atom_download_manager_delegate.h" +#include "atom/browser/browser.h" #include "atom/browser/net/atom_url_request_job_factory.h" #include "atom/browser/net/asar/asar_protocol_handler.h" #include "atom/browser/net/http_protocol_handler.h" #include "atom/browser/web_view_manager.h" +#include "atom/common/atom_version.h" +#include "atom/common/chrome_version.h" #include "atom/common/options_switches.h" #include "base/command_line.h" +#include "base/strings/string_util.h" +#include "base/strings/stringprintf.h" #include "base/threading/sequenced_worker_pool.h" #include "base/threading/worker_pool.h" #include "content/public/browser/browser_thread.h" #include "content/public/common/url_constants.h" +#include "content/public/common/user_agent.h" #include "net/ftp/ftp_network_layer.h" #include "net/url_request/data_protocol_handler.h" #include "net/url_request/ftp_protocol_handler.h" @@ -37,6 +43,14 @@ class NoCacheBackend : public net::HttpCache::BackendFactory { } }; +std::string RemoveWhitespace(const std::string& str) { + std::string trimmed; + if (base::RemoveChars(str, " ", &trimmed)) + return trimmed; + else + return str; +} + } // namespace AtomBrowserContext::AtomBrowserContext() @@ -46,6 +60,16 @@ AtomBrowserContext::AtomBrowserContext() AtomBrowserContext::~AtomBrowserContext() { } +std::string AtomBrowserContext::GetUserAgent() { + Browser* browser = Browser::Get(); + std::string user_agent = base::StringPrintf( + "%s/%s Chrome/%s " ATOM_PRODUCT_NAME "/" ATOM_VERSION_STRING, + RemoveWhitespace(browser->GetName()).c_str(), + browser->GetVersion().c_str(), + CHROME_VERSION_STRING); + return content::BuildUserAgentFromProduct(user_agent); +} + net::URLRequestJobFactory* AtomBrowserContext::CreateURLRequestJobFactory( content::ProtocolHandlerMap* handlers, content::URLRequestInterceptorScopedVector* interceptors) { diff --git a/atom/browser/atom_browser_context.h b/atom/browser/atom_browser_context.h index 4202ba970496..dd01c42dd7ef 100644 --- a/atom/browser/atom_browser_context.h +++ b/atom/browser/atom_browser_context.h @@ -19,6 +19,7 @@ class AtomBrowserContext : public brightray::BrowserContext { virtual ~AtomBrowserContext(); // brightray::URLRequestContextGetter::Delegate: + std::string GetUserAgent() override; net::URLRequestJobFactory* CreateURLRequestJobFactory( content::ProtocolHandlerMap* handlers, content::URLRequestInterceptorScopedVector* interceptors) override; diff --git a/vendor/brightray b/vendor/brightray index 6a38d97aa8f4..6328c6104131 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit 6a38d97aa8f4e1ab1842416f632a2a45adfbc738 +Subproject commit 6328c6104131e623da87f479ea305b83169099b8 From 1615c97ce882b607dca37a499369418fa64c1d77 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 14 Jul 2015 12:12:55 -0700 Subject: [PATCH 0607/1293] Don't set two "Electron"s in user agent --- atom/browser/atom_browser_context.cc | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/atom/browser/atom_browser_context.cc b/atom/browser/atom_browser_context.cc index d7c8b8dbbcc3..1874d5b03b19 100644 --- a/atom/browser/atom_browser_context.cc +++ b/atom/browser/atom_browser_context.cc @@ -62,11 +62,18 @@ AtomBrowserContext::~AtomBrowserContext() { std::string AtomBrowserContext::GetUserAgent() { Browser* browser = Browser::Get(); - std::string user_agent = base::StringPrintf( - "%s/%s Chrome/%s " ATOM_PRODUCT_NAME "/" ATOM_VERSION_STRING, - RemoveWhitespace(browser->GetName()).c_str(), - browser->GetVersion().c_str(), - CHROME_VERSION_STRING); + std::string name = RemoveWhitespace(browser->GetName()); + std::string user_agent; + if (name == ATOM_PRODUCT_NAME) { + user_agent = "Chrome/" CHROME_VERSION_STRING " " + ATOM_PRODUCT_NAME "/" ATOM_VERSION_STRING; + } else { + user_agent = base::StringPrintf( + "%s/%s Chrome/%s " ATOM_PRODUCT_NAME "/" ATOM_VERSION_STRING, + name.c_str(), + browser->GetVersion().c_str(), + CHROME_VERSION_STRING); + } return content::BuildUserAgentFromProduct(user_agent); } From 053594eae838af2cfe51f12ccc60fc0c088a7409 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 14 Jul 2015 12:13:25 -0700 Subject: [PATCH 0608/1293] Set default user agent for WebContents --- atom/browser/api/atom_api_web_contents.cc | 11 ++++++++--- atom/browser/api/atom_api_web_contents.h | 3 +++ 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 5490b505860a..6311e1eaf9a4 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -149,6 +149,7 @@ WebContents::WebContents(content::WebContents* web_contents) : content::WebContentsObserver(web_contents), type_(REMOTE) { AttachAsUserData(web_contents); + web_contents->SetUserAgentOverride(GetBrowserContext()->GetUserAgent()); } WebContents::WebContents(const mate::Dictionary& options) { @@ -175,6 +176,8 @@ WebContents::WebContents(const mate::Dictionary& options) { AttachAsUserData(web_contents); InitWithWebContents(web_contents); + web_contents->SetUserAgentOverride(GetBrowserContext()->GetUserAgent()); + if (is_guest) { guest_delegate_->Initialize(this); @@ -630,9 +633,7 @@ void WebContents::InspectServiceWorker() { v8::Local WebContents::Session(v8::Isolate* isolate) { if (session_.IsEmpty()) { - mate::Handle handle = Session::CreateFrom( - isolate, - static_cast(web_contents()->GetBrowserContext())); + auto handle = Session::CreateFrom(isolate, GetBrowserContext()); session_.Reset(isolate, handle.ToV8()); } return v8::Local::New(isolate, session_); @@ -807,6 +808,10 @@ bool WebContents::IsDestroyed() const { return !IsAlive(); } +AtomBrowserContext* WebContents::GetBrowserContext() const { + return static_cast(web_contents()->GetBrowserContext()); +} + void WebContents::OnRendererMessage(const base::string16& channel, const base::ListValue& args) { // webContents.emit(channel, new Event(), args...); diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index 085f82e3dd64..bb6b22ac84e2 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -27,6 +27,7 @@ class Dictionary; namespace atom { struct SetSizeParams; +class AtomBrowserContext; class WebViewGuestDelegate; namespace api { @@ -191,6 +192,8 @@ class WebContents : public mate::TrackableObject, REMOTE, // Thin wrap around an existing WebContents. }; + AtomBrowserContext* GetBrowserContext() const; + // Called when received a message from renderer. void OnRendererMessage(const base::string16& channel, const base::ListValue& args); From c6f870d4e4866c7c1cd0aef1443df03c8abe6762 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 14 Jul 2015 12:16:13 -0700 Subject: [PATCH 0609/1293] Fix cpplint warnings --- atom/browser/atom_browser_context.h | 2 ++ 1 file changed, 2 insertions(+) diff --git a/atom/browser/atom_browser_context.h b/atom/browser/atom_browser_context.h index dd01c42dd7ef..513cc86bca68 100644 --- a/atom/browser/atom_browser_context.h +++ b/atom/browser/atom_browser_context.h @@ -5,6 +5,8 @@ #ifndef ATOM_BROWSER_ATOM_BROWSER_CONTEXT_H_ #define ATOM_BROWSER_ATOM_BROWSER_CONTEXT_H_ +#include + #include "brightray/browser/browser_context.h" namespace atom { From 1e9eccf959492e81956b40cc69ccacb8159c3379 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 14 Jul 2015 15:13:41 -0700 Subject: [PATCH 0610/1293] Forward the crashed event to BrowserWindow, fix #2201 --- atom/browser/api/lib/browser-window.coffee | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/atom/browser/api/lib/browser-window.coffee b/atom/browser/api/lib/browser-window.coffee index d021c3733509..e7a79d99fcba 100644 --- a/atom/browser/api/lib/browser-window.coffee +++ b/atom/browser/api/lib/browser-window.coffee @@ -26,6 +26,10 @@ BrowserWindow::_init = -> if process.platform isnt 'darwin' and @isMenuBarAutoHide() and @isMenuBarVisible() @setMenuBarVisibility false + # Forward the crashed event. + @webContents.on 'crashed', => + @emit 'crashed' + # Redirect focus/blur event to app instance too. @on 'blur', (event) => app.emit 'browser-window-blur', event, this From de5bc32d0b4050548934aa52b4162fdbac888e70 Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Wed, 8 Jul 2015 12:33:23 +0900 Subject: [PATCH 0611/1293] Fix typos, update some files --- README-ko.md | 3 +- docs/api/chrome-command-line-switches-ko.md | 40 +++++++++---------- docs/api/frameless-window-ko.md | 18 ++++----- docs/api/native-image-ko.md | 2 +- docs/api/remote-ko.md | 2 +- docs/api/shell-ko.md | 2 +- .../build-instructions-linux-ko.md | 8 ++++ docs/tutorial/application-packaging-ko.md | 4 +- docs/tutorial/devtools-extension-ko.md | 6 ++- docs/tutorial/using-native-node-modules-ko.md | 5 +-- 10 files changed, 47 insertions(+), 43 deletions(-) diff --git a/README-ko.md b/README-ko.md index 824bac66519e..fb38a44794c9 100644 --- a/README-ko.md +++ b/README-ko.md @@ -2,6 +2,7 @@ [![Build Status](https://travis-ci.org/atom/electron.svg?branch=master)](https://travis-ci.org/atom/electron) [![devDependency Status](https://david-dm.org/atom/electron/dev-status.svg)](https://david-dm.org/atom/electron#info=devDependencies) +[![Join the Electron Community on Slack](http://atom-slack.herokuapp.com/badge.svg)](http://atom-slack.herokuapp.com/) ### [Electron](https://github.com/atom/electron/) 한국어 참조문서 @@ -34,7 +35,7 @@ npm install electron-prebuilt --save-dev ## 참조문서 [docs](https://github.com/atom/electron/tree/master/docs/README-ko.md) 에 프레임워크 사용 가이드와 API 레퍼런스가 있습니다. -추가적으로 Electron을 빌드 하는 방법과 프로젝트에 기여하는 방법도 문서에 포함되어 있으니 참고하기 바랍니다. +추가적으로 Electron을 빌드 하는 방법과 프로젝트에 기여하는 방법이 문서에 포함되어 있으니 참고하시기 바랍니다. ## 커뮤니티 diff --git a/docs/api/chrome-command-line-switches-ko.md b/docs/api/chrome-command-line-switches-ko.md index ca519ec6a2be..35ea805ccd4e 100644 --- a/docs/api/chrome-command-line-switches-ko.md +++ b/docs/api/chrome-command-line-switches-ko.md @@ -1,9 +1,8 @@ # 크롬 Command-Line 스위치 지원 -The following command lines switches in Chrome browser are also supported in -Electron, you can use [app.commandLine.appendSwitch][append-switch] to append -them in your app's main script before the [ready][ready] event of [app][app] -module is emitted: +다음 Command-Line 스위치들은 크롬 브라우저에서 제공되는 추가 옵션이며 Electron에서도 지원합니다. +[app][app]의 [ready][ready]이벤트가 작동하기 전에 [app.commandLine.appendSwitch][append-switch] API를 사용하면 +어플리케이션 내부에서 스위치들을 추가할 수 있습니다: ```javascript var app = require('app'); @@ -17,35 +16,33 @@ app.on('ready', function() { ## --client-certificate=`path` -Sets `path` of client certificate file. +`path`를 클라이언트 인증서로 설정합니다. ## --ignore-connections-limit=`domains` -Ignore the connections limit for `domains` list seperated by `,`. +`domains` 리스트(`,`로 구분)의 연결 제한을 무시합니다. ## --disable-http-cache -Disables the disk cache for HTTP requests. +HTTP 요청 캐시를 비활성화 합니다. ## --remote-debugging-port=`port` -Enables remote debug over HTTP on the specified `port`. +지정한 `port`에 HTTP기반의 리모트 디버거를 활성화 시킵니다. (개발자 콘솔) ## --proxy-server=`address:port` -Uses a specified proxy server, overrides system settings. This switch only -affects HTTP and HTTPS requests. +시스템 설정의 프록시 서버를 무시하고 지정한 서버로 연결합니다. HTTP와 HTTPS 요청에만 적용됩니다. ## --no-proxy-server -Don't use a proxy server, always make direct connections. Overrides any other -proxy server flags that are passed. +프록시 서버를 사용하지 않습니다. 다른 프록시 서버 플래그 및 설정을 무시하고 언제나 직접 연결을 사용합니다. ## --host-rules=`rules` -Comma-separated list of `rules` that control how hostnames are mapped. +Hostname 맵핑 규칙을 설정합니다. (`,`로 분리) -For example: +예시: * `MAP * 127.0.0.1` Forces all hostnames to be mapped to 127.0.0.1 * `MAP *.google.com proxy` Forces all google.com subdomains to be resolved to @@ -61,7 +58,7 @@ connection, and the endpoint host in a `SOCKS` proxy connection). ## --host-resolver-rules=`rules` -Like `--host-rules` but these `rules` only apply to the host resolver. +`--host-rules` 플래그와 비슷하지만 이 플래그는 host resolver에만 적용됩니다. [app]: app-ko.md [append-switch]: app-ko.md#appcommandlineappendswitchswitch-value @@ -69,26 +66,25 @@ Like `--host-rules` but these `rules` only apply to the host resolver. ## --ignore-certificate-errors -Ignores certificate related errors. +인증서 에러를 무시합니다. ## --ppapi-flash-path=`path` -Sets `path` of pepper flash plugin. +Pepper 플래시 플러그인의 위치를 설정합니다. ## --ppapi-flash-version=`version` -Sets `version` of pepper flash plugin. +Pepper 플래시 플러그인의 버전을 설정합니다. ## --log-net-log=`path` -Enables saving net log events and writes them to `path`. +Net log 이벤트를 지정한 `path`에 로그로 기록합니다. ## --v=`log_level` -Gives the default maximal active V-logging level; 0 is the default. Normally -positive values are used for V-logging levels. +기본 V-logging 최대 활성화 레벨을 지정합니다. 기본값은 0입니다. 기본적으로 양수를 레벨로 사용합니다. -Passing `--v=-1` will disable logging. +`--v=-1`를 사용하면 로깅이 비활성화 됩니다. ## --vmodule=`pattern` diff --git a/docs/api/frameless-window-ko.md b/docs/api/frameless-window-ko.md index 31982c07e672..8315f48ec8ee 100644 --- a/docs/api/frameless-window-ko.md +++ b/docs/api/frameless-window-ko.md @@ -1,19 +1,17 @@ # Frameless window -A frameless window is a window that has no chrome. +frameless window는 테두리가 없는 윈도우 창을 말합니다. -## Create a frameless window - -To create a frameless window, you only need to specify `frame` to `false` in -[BrowserWindow](browser-window-ko.md)'s `options`: +## Frameless window 만들기 +Frameless window를 만드려면 [BrowserWindow](browser-window-ko.md) 객체의 `options`에서 `frame` 옵션을 `false`로 지정하기만 하면됩니다: ```javascript var BrowserWindow = require('browser-window'); var win = new BrowserWindow({ width: 800, height: 600, frame: false }); ``` -## Transparent window +## 투명한 윈도우 By setting the `transparent` option to `true`, you can also make the frameless window transparent: @@ -22,7 +20,7 @@ window transparent: var win = new BrowserWindow({ transparent: true, frame: false }); ``` -### Limitations +### API의 한계 * You can not click through the transparent area, we are going to introduce an API to set window shape to solve this, but currently blocked at an @@ -38,7 +36,7 @@ var win = new BrowserWindow({ transparent: true, frame: false }); drivers](https://code.google.com/p/chromium/issues/detail?id=369209) on Linux. * On Mac the native window shadow will not show for transparent window. -## Draggable region +## 드래그 가능 위치 지정 By default, the frameless window is non-draggable. Apps need to specify `-webkit-app-region: drag` in CSS to tell Electron which regions are draggable @@ -67,7 +65,7 @@ button { If you're only using a custom titlebar, you also need to make buttons in titlebar non-draggable. -## Text selection +## 텍스트 선택 One thing on frameless window is that the dragging behaviour may conflict with selecting text, for example, when you drag the titlebar, you may accidentally @@ -81,7 +79,7 @@ selection on dragging area like this: } ``` -## Context menu +## 컨텍스트 메뉴 On some platforms, the draggable area would be treated as non-client frame, so when you right click on it a system menu would be popuped. To make context menu diff --git a/docs/api/native-image-ko.md b/docs/api/native-image-ko.md index 45bef9956f6e..192bbcfb6252 100644 --- a/docs/api/native-image-ko.md +++ b/docs/api/native-image-ko.md @@ -102,7 +102,7 @@ var appIcon = new Tray('/Users/somebody/images/icon.png'); ### NativeImage.toJpeg(quality) -* `quality` Integer +* `quality` Integer (0 - 100 사이의 값) `JPEG` 이미지를 인코딩한 데이터를 [Buffer][buffer]로 반환합니다. diff --git a/docs/api/remote-ko.md b/docs/api/remote-ko.md index c42c60d35d9e..0feb53ece5ee 100644 --- a/docs/api/remote-ko.md +++ b/docs/api/remote-ko.md @@ -142,7 +142,7 @@ Returns the object returned by `require(module)` in the main process. Returns the [BrowserWindow](browser-window-ko.md) object which this web page belongs to. -## remote.getCurrentWebContent() +## remote.getCurrentWebContents() Returns the WebContents object of this web page. diff --git a/docs/api/shell-ko.md b/docs/api/shell-ko.md index 2c312465335a..5811afdcb930 100644 --- a/docs/api/shell-ko.md +++ b/docs/api/shell-ko.md @@ -25,7 +25,7 @@ shell.openExternal('https://github.com'); * `url` String -제공된 외부 프로토콜 URL을 기반으로 데스크톱의 기본 프로그램으로 엽니다. (예를들어 mailto: URL은 해당 URL을 기본 메일 에이전트로 엽니다.) +제공된 외부 프로토콜 URL을 기반으로 데스크톱의 기본 프로그램으로 엽니다. (예를 들어 mailto: URL은 해당 URL을 기본 메일 에이전트로 엽니다.) 역자주: 폴더는 'file:\\\\C:\\'와 같이 지정하여 열 수 있습니다. (`\\`로 경로를 표현한 이유는 Escape 문자열을 참고하세요.) ## shell.moveItemToTrash(fullPath) diff --git a/docs/development/build-instructions-linux-ko.md b/docs/development/build-instructions-linux-ko.md index d70e27967ea6..ec955f3439a7 100644 --- a/docs/development/build-instructions-linux-ko.md +++ b/docs/development/build-instructions-linux-ko.md @@ -44,6 +44,14 @@ $ cd electron $ ./script/bootstrap.py -v ``` +### 크로스 컴파일 + +크로스 컴파일을 하려면 `bootstrap.py` 스크립트의 `--target_arch` 파라미터에 `arm` 또는 `ia32` 타겟 아키텍쳐를 전달하면 됩니다. + +```bash +$ ./script/bootstrap.py -v --target_arch=arm +``` + ## 빌드 하기 `Release` 와 `Debug` 두 타겟 모두 빌드 합니다: diff --git a/docs/tutorial/application-packaging-ko.md b/docs/tutorial/application-packaging-ko.md index da72a9b2954a..4d00eb8c814a 100644 --- a/docs/tutorial/application-packaging-ko.md +++ b/docs/tutorial/application-packaging-ko.md @@ -31,7 +31,7 @@ Electron은 Node.js로 부터 제공된 Node API와 Chromium으로부터 제공 `fs.readFile` 와 `require` 같은 Node API들을 지원하기 위해 Electron에선 `asar` 아카이브가 가상의 디렉터리 구조를 가지도록 패치했습니다. 그래서 아카이브 내부에서 리소스들을 정상적인 파일 시스템처럼 접근할 수 있습니다. -예를들어 `/path/to`라는 경로에 `example.asar`라는 아카이브가 있다고 가정하면: +예를 들어 `/path/to`라는 경로에 `example.asar`라는 아카이브가 있다고 가정하면: ```bash $ asar list /path/to/example.asar @@ -76,7 +76,7 @@ win.loadUrl('file:///path/to/example.asar/static/index.html'); 웹 페이지 내에선 아카이브 내의 파일을 `file:` 프로토콜을 사용하여 요청할 수 있습니다. 이 또한 Node API와 같이 가상 디렉터리 구조를 가집니다. -예를들어 jQuery의 `$.get`을 사용하여 파일을 가져올 수 있습니다: +예를 들어 jQuery의 `$.get`을 사용하여 파일을 가져올 수 있습니다: ```html ``` -Another example of creating the application menu with the simple template API: +다음 예제는 template API를 활용하여 어플리케이션 메뉴를 만드는 간단한 예제입니다: ```html @@ -167,34 +165,30 @@ Menu.setApplicationMenu(menu); ### new Menu() -Creates a new menu. +새로운 메뉴를 생성합니다. ### Class Method: Menu.setApplicationMenu(menu) * `menu` Menu -Sets `menu` as the application menu on OS X. On Windows and Linux, the `menu` -will be set as each window's top menu. +지정한 `menu`를 이용하여 어플리케이션 메뉴를 만듭니다. OS X에선 상단바에 표시되며 Windows와 Linux에선 각 창의 상단에 표시됩니다. ### Class Method: Menu.sendActionToFirstResponder(action) * `action` String -Sends the `action` to the first responder of application, this is used for -emulating default Cocoa menu behaviors, usually you would just use the -`selector` property of `MenuItem`. +`action`을 어플리케이션의 first responder에 전달합니다. +이 함수는 Cocoa 메뉴 동작을 에뮬레이트 하는데 사용되며 보통 `MenuItem`의 `selector` 속성에 사용됩니다. -**Note:** This method is OS X only. +**알림:** 이 함수는 OS X에서만 사용할 수 있습니다. ### Class Method: Menu.buildFromTemplate(template) * `template` Array -Generally, the `template` is just an array of `options` for constructing -[MenuItem](menu-item-ko.md), the usage can be referenced above. +기본적으로 `template`는 [MenuItem](menu-item-ko.md)을 생성할 때 사용하는 `options`의 배열입니다. 사용법은 위에서 설명한 것과 같습니다. -You can also attach other fields to element of the `template`, and they will -become properties of the constructed menu items. +또한 `template`에는 다른 속성도 추가할 수 있으며 메뉴가 만들어질 때 해당 메뉴 아이템의 프로퍼티로 변환됩니다. ### Menu.popup(browserWindow, [x, y]) @@ -202,86 +196,70 @@ become properties of the constructed menu items. * `x` Number * `y` Number -Popups this menu as a context menu in the `browserWindow`. You can optionally -provide a `(x,y)` coordinate to place the menu at, otherwise it will be placed -at the current mouse cursor position. +메뉴를 `browserWindow` 안에서 팝업으로 표시합니다. +옵션으로 메뉴를 표시할 `(x,y)` 좌표를 임의로 지정할 수 있습니다. 따로 지정하지 않은 경우 마우스 커서 위치에 표시됩니다. ### Menu.append(menuItem) * `menuItem` MenuItem -Appends the `menuItem` to the menu. +메뉴의 리스트 끝에 `menuItem`을 삽입합니다. ### Menu.insert(pos, menuItem) * `pos` Integer * `menuItem` MenuItem -Inserts the `menuItem` to the `pos` position of the menu. +`pos` 위치에 `menuItem`을 삽입합니다. ### Menu.items -Get the array containing the menu's items. +메뉴가 가지고 있는 메뉴 아이템들의 배열입니다. -## Notes on OS X application menu +## OS X 어플리케이션 메뉴에 대해 알아 둬야 할 것들 -OS X has a completely different style of application menu from Windows and -Linux, and here are some notes on making your app's menu more native-like. +OS X에선 Windows, Linux와 달리 완전히 다른 어플리케이션 메뉴 스타일을 가지고 있습니다. +어플리케이션을 네이티브처럼 작동할 수 있도록 하기 위해선 다음의 몇 가지 유의 사항을 숙지해야 합니다. -### Standard menus +### 기본 메뉴 -On OS X there are many system defined standard menus, like the `Services` and -`Windows` menus. To make your menu a standard menu, you can just set your menu's -label to one of followings, and Electron will recognize them and make them -become standard menus: +OS X엔 `Services`나 `Windows`와 같은 많은 시스템 지정 기본 메뉴가 있습니다. +기본 메뉴를 만들려면 다음 중 하나를 메뉴의 라벨로 지정하기만 하면 됩니다. +그러면 Electron이 자동으로 인식하여 해당 메뉴를 기본 메뉴로 만듭니다: * `Window` * `Help` * `Services` -### Standard menu item actions +### 기본 메뉴 아이템 동작 -OS X has provided standard actions for some menu items (which are called -`selector`s), like `About xxx`, `Hide xxx`, and `Hide Others`. To set the action -of a menu item to a standard action, you can set the `selector` attribute of the -menu item. +OS X는 몇몇의 메뉴 아이템에 대해 `About xxx`, `Hide xxx`, `Hide Others`와 같은 기본 동작을 제공하고 있습니다. (`selector`라고 불립니다) +메뉴 아이템의 기본 동작을 지정하려면 메뉴 아이템의 `selector` 속성을 사용하면 됩니다. -### Main menu's name +### 메인 메뉴의 이름 -On OS X the label of application menu's first item is always your app's name, -no matter what label you set. To change it you have to change your app's name -by modifying your app bundle's `Info.plist` file. See -[About Information Property List Files](https://developer.apple.com/library/ios/documentation/general/Reference/InfoPlistKeyReference/Articles/AboutInformationPropertyListFiles.html) -for more. +OS X에선 지정한 어플리케이션 메뉴에 상관없이 메뉴의 첫번째 라벨은 언제나 어플리케이션의 이름이 됩니다. +어플리케이션 이름을 변경하려면 앱 번들내의 `Info.plist` 파일을 수정해야합니다. +자세한 내용은 [About Information Property List Files](https://developer.apple.com/library/ios/documentation/general/Reference/InfoPlistKeyReference/Articles/AboutInformationPropertyListFiles.html)을 참고하세요. +## 메뉴 아이템 위치 -## Menu item position +`Menu.buildFromTemplate`로 메뉴를 만들 때 `position`과 `id`를 사용해서 아이템의 위치를 지정할 수 있습니다. -You can make use of `position` and `id` to control how the item would be placed -when building a menu with `Menu.buildFromTemplate`. +`MenuItem`의 `position` 속성은 `[placement]=[id]`와 같은 형식을 가지며 `placement`는 +`before`, `after`, `endof` 속성 중 한가지를 사용할 수 있고 `id`는 메뉴 아이템이 가지는 유일 ID 입니다: -The `position` attribute of `MenuItem` has the form `[placement]=[id]` where -placement is one of `before`, `after`, or `endof` and `id` is the unique ID of -an existing item in the menu: +* `before` - 이 아이템을 지정한 id 이전의 위치에 삽입합니다. 만약 참조된 아이템이 없을 경우 메뉴의 맨 뒤에 삽입됩니다. +* `after` - 이 아이템을 지정한 id 다음의 위치에 삽입합니다. 만약 참조된 아이템이 없을 경우 메뉴의 맨 뒤에 삽입됩니다. +* `endof` - 이 아이템을 id의 논리 그룹에 맞춰서 각 그룹의 항목 뒤에 삽입합니다. (그룹은 분리자 아이템에 의해 만들어집니다) + 만약 참조된 아이템의 분리자 그룹이 존재하지 않을 경우 지정된 id로 새로운 분리자 그룹을 만든 후 해당 그룹의 뒤에 삽입됩니다. -* `before` - Inserts this item before the id referenced item. If the - referenced item doesn't exist the item will be inserted at the end of - the menu. -* `after` - Inserts this item after id referenced item. If the referenced - item doesn't exist the item will be inserted at the end of the menu. -* `endof` - Inserts this item at the end of the logical group containing - the id referenced item. (Groups are created by separator items). If - the referenced item doesn't exist a new separator group is created with - the given id and this item is inserted after that separator. +위치를 지정한 아이템의 뒤에 위치가 지정되지 않은 아이템이 있을 경우 해당 아이템의 위치가 지정되기 전까지 이전에 위치가 지정된 아이템의 위치 지정을 따릅니다. +이에 따라 위치를 이동하고 싶은 특정 그룹의 아이템들이 있을 경우 해당 그룹의 맨 첫번째 메뉴 아이템의 위치만을 지정하면 됩니다. -When an item is positioned following unpositioned items are inserted after -it, until a new item is positioned. So if you want to position a group of -menu items in the same location you only need to specify a position for -the first item. +### 예제 -### Examples - -Template: +메뉴 템플릿: ```javascript [ @@ -293,7 +271,7 @@ Template: ] ``` -Menu: +메뉴: ``` - 1 @@ -303,7 +281,7 @@ Menu: - 5 ``` -Template: +메뉴 템플릿: ```javascript [ @@ -316,7 +294,7 @@ Template: ] ``` -Menu: +메뉴: ``` - --- diff --git a/docs/api/protocol-ko.md b/docs/api/protocol-ko.md index 26fc4eb740c4..20243ab95824 100644 --- a/docs/api/protocol-ko.md +++ b/docs/api/protocol-ko.md @@ -19,18 +19,20 @@ app.on('ready', function() { **알림:** 이 모듈은 app의 `ready` 이벤트가 발생한 이후에만 사용할 수 있습니다. -## protocol.registerProtocol(scheme, handler) +## protocol.registerProtocol(scheme, handler, callback) * `scheme` String * `handler` Function +* `callback` Function -지정한 `scheme`을 기반으로 커스텀 프로토콜을 등록합니다. 등록한 `scheme` 프로토콜에 요청이 들어올 경우 `request` 인자와 함께 `handler` 함수가 호출됩니다. +지정한 `scheme`을 기반으로 커스텀 프로토콜을 등록합니다. `handler`는 등록한 `scheme` 프로토콜에 요청이 들어올 경우 `request` 인자와 함께 `handler(request)` 형식으로 호출됩니다. -호출된 `handler` 함수에선 요청에 대한 해당 프로토콜의 작업 결과를 응답(반환) 해야 할 필요가 있습니다. +`handler` 함수에선 요청에 대한 해당 프로토콜의 작업 결과를 응답(반환) 해야 합니다. -## protocol.unregisterProtocol(scheme) +## protocol.unregisterProtocol(scheme, callback) * `scheme` String +* `callback` Function 지정한 `scheme` 프로토콜을 등록 해제합니다. @@ -40,23 +42,27 @@ app.on('ready', function() { 지정한 `value` 배열을 사용하여 미리 지정된 스킴으로 등록합니다. -## protocol.isHandledProtocol(scheme) +## protocol.isHandledProtocol(scheme, callback) * `scheme` String +* `callback` Function 해당 `scheme`에 처리자(handler)가 등록되었는지 확인합니다. +지정한 `callback`에 결과가 boolean 값으로 반환됩니다. -## protocol.interceptProtocol(scheme, handler) +## protocol.interceptProtocol(scheme, handler, callback) * `scheme` String * `handler` Function +* `callback` Function 지정한 `scheme`의 작업을 `handler`로 변경합니다. `handler`에서 `null` 또는 `undefined`를 반환 할 경우 해당 프로토콜의 기본 동작(응답)으로 대체 됩니다. -## protocol.uninterceptProtocol(scheme) +## protocol.uninterceptProtocol(scheme, callback) * `scheme` String +* `callback` Function 변경된 프로토콜의 작업을 해제합니다. diff --git a/docs/api/remote-ko.md b/docs/api/remote-ko.md index 0feb53ece5ee..11d62dd27194 100644 --- a/docs/api/remote-ko.md +++ b/docs/api/remote-ko.md @@ -1,7 +1,6 @@ # remote -The `remote` module provides a simple way to do inter-process communication -between the renderer process and the main process. +`remote` 모듈은 메인 프로세스와 랜더러 프로세스 사이에 inter-process 통신을 하기 위한 가장 간단한 방법입니다. In Electron, only GUI-unrelated modules are available in the renderer process. Without the `remote` module, users who wanted to call a main process API in diff --git a/docs/api/screen-ko.md b/docs/api/screen-ko.md index c554863586cc..6b508991e4f7 100644 --- a/docs/api/screen-ko.md +++ b/docs/api/screen-ko.md @@ -1,13 +1,14 @@ # screen -Gets various info about screen size, displays, cursor position, etc. You should -not use this module until the `ready` event of `app` module gets emitted. +`screen` 모듈은 화면 크기, 디스플레이, 커서 위치 등등의 다양한 정보를 가져옵니다. +이 모듈은 `app` 모듈의 `ready` 이벤트가 발생하기 전까지 사용할 수 없습니다. -`screen` is an [EventEmitter](http://nodejs.org/api/events.html#events_class_events_eventemitter). +`screen`은 [EventEmitter](http://nodejs.org/api/events.html#events_class_events_eventemitter)를 상속 받았습니다. -Make sure to note that in the renderer / DevTools, `window.screen` is a reserved DOM property, so writing `screen = require('screen')` won't work. In our examples below, we use `atomScreen` as the variable name instead. +한가지 주의할 점은 랜더러 / DevTools에선 이 모듈의 이름인 `screen`은 이미 DOM 속성에 `window.screen`로 존재 하므로 `screen = require('screen')`를 +사용할 수 없습니다. 밑의 예제와 같이 `atomScreen`등의 이름으로 변수 이름을 대체하여 사용해야 합니다. -An example of creating a window that fills the whole screen: +다음 예제는 화면 전체를 채우는 윈도우 창을 생성합니다: ```javascript var app = require('app'); @@ -22,7 +23,7 @@ app.on('ready', function() { }); ``` -Another example of creating a window in the external display: +다음 예제는 확장 디스플레이에 윈도우를 생성합니다: ```javascript var app = require('app'); @@ -55,14 +56,14 @@ app.on('ready', function() { * `event` Event * `newDisplay` Object -Emitted when `newDisplay` has been added. +새로운 디스플레이가 추가되면 발생합니다. ## Event: display-removed * `event` Event * `oldDisplay` Object -Emitted when `oldDisplay` has been removed. +기존의 디스플레이가 제거되면 발생합니다. ## Event: display-metrics-changed @@ -70,21 +71,21 @@ Emitted when `oldDisplay` has been removed. * `display` Object * `changedMetrics` Array -Emitted when a `display` has one or more metrics changed, `changedMetrics` is -an array of strings that describe the changes. Possible changes are `bounds`, -`workArea`, `scaleFactor` and `rotation`. +`display`의 하나 또는 다수의 매트릭스가 변경될 경우 발생합니다. +`changedMetrics`는 변경에 대한 정보를 담은 문자열의 배열입니다. +`bounds`, `workArea`, `scaleFactor`, `rotation`등이 변경될 수 있습니다. ## screen.getCursorScreenPoint() -Returns the current absolute position of the mouse pointer. +현재 마우스 포인터의 절대 위치를 반환합니다. ## screen.getPrimaryDisplay() -Returns the primary display. +기본 디스플레이를 반환합니다. ## screen.getAllDisplays() -Returns an array of displays that are currently available. +사용 가능한 모든 디스플레이를 배열로 반환합니다. ## screen.getDisplayNearestPoint(point) @@ -92,7 +93,7 @@ Returns an array of displays that are currently available. * `x` Integer * `y` Integer -Returns the display nearest the specified point. +지정한 좌표에 가까운 디스플레이를 반환합니다. ## screen.getDisplayMatching(rect) @@ -102,4 +103,4 @@ Returns the display nearest the specified point. * `width` Integer * `height` Integer -Returns the display that most closely intersects the provided bounds. +지정한 범위에 가장 가깝게 교차한 디스플레이를 반환합니다. diff --git a/docs/api/shell-ko.md b/docs/api/shell-ko.md index 5811afdcb930..d9ceea106a54 100644 --- a/docs/api/shell-ko.md +++ b/docs/api/shell-ko.md @@ -26,7 +26,7 @@ shell.openExternal('https://github.com'); * `url` String 제공된 외부 프로토콜 URL을 기반으로 데스크톱의 기본 프로그램으로 엽니다. (예를 들어 mailto: URL은 해당 URL을 기본 메일 에이전트로 엽니다.) -역자주: 폴더는 'file:\\\\C:\\'와 같이 지정하여 열 수 있습니다. (`\\`로 경로를 표현한 이유는 Escape 문자열을 참고하세요.) +역주: 폴더는 'file:\\\\C:\\'와 같이 지정하여 열 수 있습니다. (`\\`로 경로를 표현한 이유는 Escape 문자열을 참고하세요.) ## shell.moveItemToTrash(fullPath) diff --git a/docs/development/build-instructions-linux-ko.md b/docs/development/build-instructions-linux-ko.md index ec955f3439a7..3d7f9389f77b 100644 --- a/docs/development/build-instructions-linux-ko.md +++ b/docs/development/build-instructions-linux-ko.md @@ -89,7 +89,16 @@ $ ./script/clean.py ## 문제 해결 -개발 종속성 라이브러리들을 제대로 설치했는지 확인하세요. +개발 종속성 라이브러리들을 제대로 설치했는지 확인하세요. + +## libtinfo.so.5 동적 링크 라이브러리를 로드하는 도중 에러가 발생할 경우 + +미리 빌드된 `clang`은 `libtinfo.so.5`로 링크를 시도합니다. +플랫폼에 따라 적당한 `libncurses` symlink를 추가하세요. + +```bash +$ sudo ln -s /usr/lib/libncurses.so.5 /usr/lib/libtinfo.so.5 +``` ## 테스트 diff --git a/docs/development/build-system-overview-ko.md b/docs/development/build-system-overview-ko.md index 92fd50008529..7198fa831b92 100644 --- a/docs/development/build-system-overview-ko.md +++ b/docs/development/build-system-overview-ko.md @@ -25,9 +25,14 @@ Electron도 상당히 비슷한 접근을 했습니다: ## 부트스트랩 최소화 -모든 사전 빌드 된 Chromium 바이너리들은 부트스트랩 스크립트가 실행될 때 다운로드됩니다. +Prebuilt된 모든 Chromium 바이너리들은 부트스트랩 스크립트가 실행될 때 다운로드됩니다. 기본적으로 공유 라이브러리와 정적 라이브러리 모두 다운로드되며 최종 전체 파일 크기는 플랫폼에 따라 800MB에서 2GB까지 차지합니다. +기본적으로 libchromiumcontent는 Amazon Web Service를 통해 다운로드 됩니다. +만약 `LIBCHROMIUMCONTENT_MIRROR` 환경 변수가 설정되어 있으면 부트스트랩은 해당 링크를 사용하여 바이너리를 다운로드 합니다. +[libchromiumcontent-qiniu-mirror](https://github.com/hokein/libchromiumcontent-qiniu-mirror)는 libchromiumcontent의 미러입니다. +만약 AWS에 접근할 수 없다면 `export LIBCHROMIUMCONTENT_MIRROR=http://7xk3d2.dl1.z0.glb.clouddn.com/`를 통해 다운로드 할 수 있습니다. + 만약 빠르게 Electron의 개발 또는 테스트만 하고 싶다면 `--dev` 플래그를 추가하여 공유 라이브러리만 다운로드할 수 있습니다: ```bash diff --git a/docs/tutorial/application-distribution-ko.md b/docs/tutorial/application-distribution-ko.md index a1bb5bc65044..0b6ff631ad70 100644 --- a/docs/tutorial/application-distribution-ko.md +++ b/docs/tutorial/application-distribution-ko.md @@ -99,7 +99,7 @@ MyApp.app/Contents 실행파일 `electron`의 이름을 원하는 대로 바꿀 수 있습니다. 리눅스 어플리케이션의 아이콘은 [.desktop](https://developer.gnome.org/integration-guide/stable/desktop-files.html.en) 파일을 사용하여 지정할 수 있습니다. -### 역자주-자동화 +### 역주-자동화 배포시에 Electron의 리소스를 일일이 수정하는 것은 매우 귀찮고 복잡합니다. 하지만 이 작업을 자동화 시킬 수 있는 몇가지 방법이 있습니다: diff --git a/docs/tutorial/quick-start-ko.md b/docs/tutorial/quick-start-ko.md index e5ef8662cd7a..a49b7e017609 100644 --- a/docs/tutorial/quick-start-ko.md +++ b/docs/tutorial/quick-start-ko.md @@ -75,6 +75,8 @@ var mainWindow = null; // 모든 창이 닫히면 어플리케이션 종료. app.on('window-all-closed', function() { + // OSX의 대부분의 어플리케이션에선 유저가 Cmd + Q 커맨드로 확실하게 종료하기 전까지는 + // 어플리케이션이 메뉴바에 남아 계속 실행됩니다. if (process.platform != 'darwin') { app.quit(); } @@ -112,16 +114,16 @@ app.on('ready', function() {

헬로 월드!

- 우리는 io.js 버전과 - Electron 버전을 사용합니다. + 이 어플리케이션은 io.js 과 + Electron 을 사용합니다. ``` ## 앱 실행하기 -앱을 작성한 후 [어플리케이션 배포](./application-distribution-ko.md) 가이드를 따라 앱을 패키징 하고 -패키징한 앱을 실행해 볼 수 있습니다. 또한 Electron 실행파일을 다운로드 받아 바로 실행해 볼 수도 있습니다. +앱을 작성한 후 [어플리케이션 배포](./application-distribution-ko.md) 가이드를 따라 앱을 패키징 하고 패키징한 앱을 실행할 수 있습니다. +또는 Electron 실행파일을 다운로드 받아 바로 실행해 볼 수도 있습니다. Windows의 경우: diff --git a/docs/tutorial/using-native-node-modules-ko.md b/docs/tutorial/using-native-node-modules-ko.md index da68c475ba83..1e67ee25305d 100644 --- a/docs/tutorial/using-native-node-modules-ko.md +++ b/docs/tutorial/using-native-node-modules-ko.md @@ -1,6 +1,6 @@ # 네이티브 node 모듈 사용하기 -__역자주: 현재 Electron은 node.js대신 io.js를 사용합니다. 문서에 기재된 버전과 다를 수 있습니다__ +__역주: 현재 Electron은 node.js대신 io.js를 사용합니다. 문서에 기재된 버전과 다를 수 있습니다__ Electron에선 node.js 네이티브 모듈이 지원됩니다. 하지만 Electron은 공식 node.js의 V8 엔진과는 달리 다른 V8 버전을 사용합니다. 그런 이유로 네이티브 모듈을 사용하기 위해선 Electron의 V8 버전에 맞춰 네이티브 모듈을 다시 빌드하고 헤더를 변경해야 합니다. @@ -34,11 +34,11 @@ Node 모듈을 `node-gyp`를 사용하여 Electron을 타겟으로 빌드할 땐 ```bash $ cd /path-to-module/ -$ HOME=~/.electron-gyp node-gyp rebuild --target=0.25.0 --arch=ia64 --dist-url=https://atom.io/download/atom-shell +$ HOME=~/.electron-gyp node-gyp rebuild --target=0.29.1 --arch=x64 --dist-url=https://atom.io/download/atom-shell ``` -`HOME=~/.electron-gyp`은 변경할 헤더의 위치를 찾습니다. `--target=0.25.0`은 Electron의 버전입니다. -`--dist-url=...`은 헤더를 다운로드 하는 주소입니다. `--arch=ia64`는 64비트 시스템을 타겟으로 빌드 한다는 것을 `node-gyp`에게 알려줍니다. +`HOME=~/.electron-gyp`은 변경할 헤더의 위치를 찾습니다. `--target=0.29.1`은 Electron의 버전입니다. +`--dist-url=...`은 헤더를 다운로드 하는 주소입니다. `--arch=x64`는 64비트 시스템을 타겟으로 빌드 한다는 것을 `node-gyp`에게 알려줍니다. ### npm을 이용한 방법 @@ -47,7 +47,7 @@ $ HOME=~/.electron-gyp node-gyp rebuild --target=0.25.0 --arch=ia64 --dist-url=h ```bash export npm_config_disturl=https://atom.io/download/atom-shell -export npm_config_target=0.25.0 +export npm_config_target=0.29.1 export npm_config_arch=x64 HOME=~/.electron-gyp npm install module-name ``` From eb81810a52498e73b224a63dbf241248f6a9daad Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Sun, 12 Jul 2015 12:53:28 +0900 Subject: [PATCH 0613/1293] Revert "Update APIs, check grammars" This reverts commit d1eb971263f72deae84541d12b3bdd6d5972365a. --- docs/README-ko.md | 5 +- docs/api/app-ko.md | 4 - docs/api/auto-updater-ko.md | 2 +- docs/api/chrome-command-line-switches-ko.md | 20 +-- docs/api/clipboard-ko.md | 15 --- docs/api/content-tracing-ko.md | 6 +- docs/api/crash-reporter-ko.md | 63 +++++----- docs/api/dialog-ko.md | 72 ++++++----- docs/api/frameless-window-ko.md | 68 ++++++----- docs/api/menu-ko.md | 114 +++++++++++------- docs/api/protocol-ko.md | 20 ++- docs/api/remote-ko.md | 3 +- docs/api/screen-ko.md | 33 +++-- docs/api/shell-ko.md | 2 +- .../build-instructions-linux-ko.md | 11 +- docs/development/build-system-overview-ko.md | 7 +- docs/tutorial/application-distribution-ko.md | 2 +- docs/tutorial/quick-start-ko.md | 10 +- docs/tutorial/using-native-node-modules-ko.md | 10 +- 19 files changed, 232 insertions(+), 235 deletions(-) diff --git a/docs/README-ko.md b/docs/README-ko.md index 6e0daa59fd2b..50c4b2c9c9ca 100644 --- a/docs/README-ko.md +++ b/docs/README-ko.md @@ -67,6 +67,5 @@ * [빌드 설명서 (Linux)](development/build-instructions-linux-ko.md) * [디버거에서 디버그 심볼 서버 설정](development/setting-up-symbol-server-ko.md) -이 참조문서는 [@preco21](https://github.com/preco21)에 의해 번역되었습니다. -문서내에서 오타나 잘못된 번역을 발견하면 `plusb21@gmail.com` 이메일로 알려주시면 감사하겠습니다. -원본과는 달리 항시 최신버전을 유지할 수 없으므로 원본을 같이 참고하는 것을 권장합니다. +이 문서는 [@preco21](https://github.com/preco21) 에 의해 번역되었습니다. +문서내에서 오타나 잘못된 번역이 발견될 경우 해당 repo를 fork한 후 수정하여 PR을 올리거나 `plusb21@gmail.com` 이메일로 알려주시면 감사하겠습니다. diff --git a/docs/api/app-ko.md b/docs/api/app-ko.md index 434d0620282a..293cfd965a39 100644 --- a/docs/api/app-ko.md +++ b/docs/api/app-ko.md @@ -139,10 +139,6 @@ This method guarantees all `beforeunload` and `unload` handlers are correctly executed. It is possible that a window cancels the quitting by returning `false` in `beforeunload` handler. -## app.getAppPath() - -Returns the current application directory. - ## app.getPath(name) * `name` String diff --git a/docs/api/auto-updater-ko.md b/docs/api/auto-updater-ko.md index bcfc3b562682..0894fc3485fb 100644 --- a/docs/api/auto-updater-ko.md +++ b/docs/api/auto-updater-ko.md @@ -1,6 +1,6 @@ # auto-updater -**이 모듈은 현재 OS X에서만 사용할 수 있습니다.** +**This module has only been implemented for OS X.** Check out [atom/grunt-electron-installer](https://github.com/atom/grunt-electron-installer) for building a Windows installer for your app. diff --git a/docs/api/chrome-command-line-switches-ko.md b/docs/api/chrome-command-line-switches-ko.md index ed8cf55e06ec..35ea805ccd4e 100644 --- a/docs/api/chrome-command-line-switches-ko.md +++ b/docs/api/chrome-command-line-switches-ko.md @@ -51,8 +51,10 @@ Hostname 맵핑 규칙을 설정합니다. (`,`로 분리) also force the port of the resulting socket address to be 77. * `MAP * baz, EXCLUDE www.google.com` Remaps everything to "baz", except for "www.google.com". - -이 맵핑은 네트워크 요청시의 endpoint를 지정합니다. (TCP 연결과 직접 연결의 호스트 resolver, http 프록시 연결의 `CONNECT`, `SOCKS` 프록시 연결의 endpoint 호스트) + +These mappings apply to the endpoint host in a net request (the TCP connect +and host resolver in a direct connection, and the `CONNECT` in an http proxy +connection, and the endpoint host in a `SOCKS` proxy connection). ## --host-resolver-rules=`rules` @@ -86,14 +88,16 @@ Net log 이벤트를 지정한 `path`에 로그로 기록합니다. ## --vmodule=`pattern` -`--v` 옵션에 전달된 값을 덮어쓰고 모듈당 최대 V-logging 레벨을 지정합니다. -예를 들어 `my_module=2,foo*=3`는 `my_module.*`, `foo*.*`와 같은 파일 이름 패턴을 가진 모든 소스 코드들의 로깅 레벨을 각각 2와 3으로 설정합니다. +Gives the per-module maximal V-logging levels to override the value given by +`--v`. E.g. `my_module=2,foo*=3` would change the logging level for all code in +source files `my_module.*` and `foo*.*`. -슬래시(`/`), 백슬래시(`\`)를 포함하는 모든 패턴은 모듈뿐만 아니라 모든 경로명에 대해서도 테스트 됩니다. -예를 들어 `*/foo/bar/*=2` 표현식은 `foo/bar` 디렉터리 안의 모든 소스 코드의 로깅 레벨을 2로 지정합니다. - -모든 크로미움과 관련된 로그를 비활성화하고 어플리케이션의 로그만 활성화 하려면 다음과 같이 코드를 작성하면 됩니다: +Any pattern containing a forward or backward slash will be tested against the +whole pathname and not just the module. E.g. `*/foo/bar/*=2` would change the +logging level for all code in source files under a `foo/bar` directory. +To disable all chromium related logs and only enable your application logs you +can do: ```javascript app.commandLine.appendSwitch('v', -1); diff --git a/docs/api/clipboard-ko.md b/docs/api/clipboard-ko.md index bc6c82786cb7..3ee0164e9759 100644 --- a/docs/api/clipboard-ko.md +++ b/docs/api/clipboard-ko.md @@ -86,18 +86,3 @@ console.log(clipboard.has('

selection

')); 클립보드로부터 `data`를 읽어들입니다. **알림:** 이 API는 실험적인 기능이며 차후 최신버전에서 제외될 수 있습니다. - -## clipboard.write(data[, type]) - -* `data` Object - * `text` String - * `html` String - * `image` [NativeImage](native-image.md) -* `type` String - -```javascript -var clipboard = require('clipboard'); -clipboard.write({text: 'test', html: "test"}); -``` - -`data`를 클립보드에 씁니다. diff --git a/docs/api/content-tracing-ko.md b/docs/api/content-tracing-ko.md index e9fa3158a2fb..a0896c2a7182 100644 --- a/docs/api/content-tracing-ko.md +++ b/docs/api/content-tracing-ko.md @@ -1,7 +1,9 @@ # content-tracing -`content-trace` 모듈은 Chromium 컨텐츠 모듈단에서 생성된 데이터를 수집하고 추적하는데 사용됩니다. -이 모듈은 웹 인터페이스를 포함하고 있지 않으며 크롬 브라우저에서 `chrome://tracing/` 페이지를 열어 생성된 파일을 로드하면 결과를 볼 수 있습니다. +The `content-trace` module is used to collect tracing data generated by the +underlying Chromium content module. This module does not include a web interface +so you need to open `chrome://tracing/` in a Chrome browser and load the generated +file to view the result. ```javascript var tracing = require('content-tracing'); diff --git a/docs/api/crash-reporter-ko.md b/docs/api/crash-reporter-ko.md index b8c076a7ceae..1302d9b457e2 100644 --- a/docs/api/crash-reporter-ko.md +++ b/docs/api/crash-reporter-ko.md @@ -1,6 +1,6 @@ # crash-reporter -다음 예제는 윈격 서버에 어플리케이션 오류 정보를 자동으로 보고하는 예제입니다: +An example of automatically submitting crash reporters to remote server: ```javascript crashReporter = require('crash-reporter'); @@ -15,46 +15,47 @@ crashReporter.start({ ## crashReporter.start(options) * `options` Object - * `productName` String, 기본값: Electron - * `companyName` String, 기본값: GitHub, Inc - * `submitUrl` String, 기본값: http://54.249.141.255:1127/post - * Crash Reporter는 POST 방식으로 해당 URL에 전송됩니다. - * `autoSubmit` Boolean, 기본값: true - * true로 지정할 경우 유저의 승인 없이 자동으로 오류를 보고합니다. - * `ignoreSystemCrashHandler` Boolean, 기본값: false + * `productName` String, default: Electron + * `companyName` String, default: GitHub, Inc + * `submitUrl` String, default: http://54.249.141.255:1127/post + * URL that crash reports would be sent to as POST + * `autoSubmit` Boolean, default: true + * Send the crash report without user interaction + * `ignoreSystemCrashHandler` Boolean, default: false * `extra` Object - * 오류보고 시 같이 보낼 추가 정보를 지정하는 객체입니다. - * 문자열로 된 속성만 정상적으로 보내집니다. - * 중첩 객체는 지원되지 않습니다. (Nested objects are not supported) - -다른 crashReporter API들을 사용하기 전에 이 함수를 먼저 호출해야 합니다. + * An object you can define which content will be send along with the report. + * Only string properties are send correctly. + * Nested objects are not supported. + +Developers are required to call the API before using other crashReporter APIs. -**알림:** OS X에선 Windows와 Linux의 `breakpad`와 달리 새로운 `crashpad` 클라이언트를 사용합니다. -오류 수집 기능을 활성화 시키려면 오류를 수집하고 싶은 메인 프로세스나 랜더러 프로세스에서 -`crashReporter.start` 함수를 호출하여 `crashpad`를 초기화 해야합니다. +**Note:** On OS X, electron uses a new `crashpad` client, which is different +with the `breakpad` on Windows and Linux. To enable crash collection feature, +you are required to call `crashReporter.start` API to initiliaze `crashpad` in +main process, even you only collect crash report in renderer process. ## crashReporter.getLastCrashReport() -마지막 오류보고의 날짜와 ID를 반환합니다. -이전 오류보고가 없거나 Crash Reporter가 시작되지 않았을 경우 `null`이 반환됩니다. +Returns the date and ID of last crash report, when there was no crash report +sent or the crash reporter is not started, `null` will be returned. ## crashReporter.getUploadedReports() -모든 업로드된 오류보고를 반환합니다. 각 보고는 날짜와 업로드 ID를 포함하고 있습니다. +Returns all uploaded crash reports, each report contains date and uploaded ID. -# crash-reporter 오류보고 형식 +# crash-reporter payload -Crash Reporter는 다음과 같은 데이터를 `submitUrl`에 `POST` 방식으로 전송합니다: +The crash reporter will send the following data to the `submitUrl` as `POST`: -* `rept` String - 예시 'electron-crash-service' -* `ver` String - Electron의 버전 -* `platform` String - 예시 'win32' -* `process_type` String - 예시 'renderer' +* `rept` String - e.g. 'electron-crash-service' +* `ver` String - The version of Electron +* `platform` String - e.g. 'win32' +* `process_type` String - e.g. 'renderer' * `ptime` Number -* `_version` String - `package.json`내의 `version` 필드 -* `_productName` String - Crash Reporter의 `options` 객체에서 정의한 제품명. -* `prod` String - 기본 제품의 이름. 이 경우 Electron으로 표시됩니다. -* `_companyName` String - Crash Reporter의 `options` 객체에서 정의한 회사명. -* `upload_file_minidump` File - 오류보고 파일 -* Crash Reporter의 `options` 객체에서 정의한 `extra` 객체의 속성들. +* `_version` String - The version in `package.json` +* `_productName` String - The product name in the crashReporter `options` object +* `prod` String - Name of the underlying product. In this case Electron +* `_companyName` String - The company name in the crashReporter `options` object +* `upload_file_minidump` File - The crashreport as file +* All level one properties of the `extra` object in the crashReporter `options` object diff --git a/docs/api/dialog-ko.md b/docs/api/dialog-ko.md index a16daebb6f3a..25c4abfa7631 100644 --- a/docs/api/dialog-ko.md +++ b/docs/api/dialog-ko.md @@ -1,17 +1,17 @@ # dialog -`dialog` 모듈은 네이티브 시스템의 대화 상자를 조작할 때 사용할 수 있는 API입니다. -웹 어플리케이션에서 일반 네이티브 어플리케이션과 같은 사용자 경험을 제공할 수 있습니다. +The `dialog` module provides APIs to show native system dialogs, so web +applications can deliver the same user experience as native applications. -다음 예제는 파일과 디렉터리를 다중으로 선택하는 대화 상자를 표시하는 예제입니다: +An example of showing a dialog to select multiple files and directories: ```javascript -var win = ...; // 대화 상자를 사용할 창 객체 +var win = ...; // window in which to show the dialog var dialog = require('dialog'); console.log(dialog.showOpenDialog({ properties: [ 'openFile', 'openDirectory', 'multiSelections' ]})); ``` -**OS X 주의**: 대화 상자를 시트처럼 보여지게 하려면 `browserWindow` 인자에 `BrowserWindow` 객체의 참조를 제공하면 됩니다. +**Note for OS X**: If you want to present dialogs as sheets, the only thing you have to do is provide a `BrowserWindow` reference in the `browserWindow` parameter. ## dialog.showOpenDialog([browserWindow], [options], [callback]) @@ -20,15 +20,16 @@ console.log(dialog.showOpenDialog({ properties: [ 'openFile', 'openDirectory', ' * `title` String * `defaultPath` String * `filters` Array - * `properties` Array - 대화 상자가 사용할 기능(모드)이 담긴 배열입니다. - 다음을 포함할 수 있습니다: `openFile`, `openDirectory`, `multiSelections`, `createDirectory` + * `properties` Array - Contains which features the dialog should use, can + contain `openFile`, `openDirectory`, `multiSelections` and + `createDirectory` * `callback` Function -사용할 대화 상자의 기능이 담긴 배열입니다. 다음을 포함할 수 있습니다: `openFile`, `openDirectory`, `multiSelections`, `createDirectory` +On success, returns an array of file paths chosen by the user, otherwise +returns `undefined`. -작업에 성공하면 유저가 선택한 파일의 경로를 포함한 배열을 반환합니다. 그 외의 경우엔 `undefined`를 반환합니다. - -`filters`를 지정하면 유저가 선택 가능한 파일 형식을 지정할 수 있습니다. 예제는 다음과 같습니다: +The `filters` specifies an array of file types that can be displayed or +selected, an example is: ```javascript { @@ -40,10 +41,12 @@ console.log(dialog.showOpenDialog({ properties: [ 'openFile', 'openDirectory', ' } ``` -`callback`이 전달되면 메소드가 비동기로 작동되며 결과는 `callback(filenames)`을 통해 전달됩니다. +If a `callback` is passed, the API call would be asynchronous and the result +would be passed via `callback(filenames)` -Windows와 Linux에선 파일 선택 모드, 디렉터리 선택 모드를 동시에 사용할 수 없습니다. -그래서 이 두 플랫폼에선 `properties`를 `['openFile', 'openDirectory']`로 설정하면 디렉터리 선택 대화 상자가 표시됩니다. +**Note:** On Windows and Linux, an open dialog can not be both a file selector +and a directory selector, so if you set `properties` to +`['openFile', 'openDirectory']` on these platforms, a directory selector will be shown. ## dialog.showSaveDialog([browserWindow], [options], [callback]) @@ -54,41 +57,36 @@ Windows와 Linux에선 파일 선택 모드, 디렉터리 선택 모드를 동 * `filters` Array * `callback` Function -작업에 성공하면 +On success, returns the path of the file chosen by the user, otherwise returns +`undefined`. -작업에 성공하면 유저가 선택한 파일의 경로를 포함한 배열을 반환합니다. 그 외의 경우엔 `undefined`를 반환합니다. +The `filters` specifies an array of file types that can be displayed, see +`dialog.showOpenDialog` for an example. -`filters`를 지정하면 유저가 저장 가능한 파일 형식을 지정할 수 있습니다. 사용 방법은 `dialog.showOpenDialog`의 `filters` 속성과 같습니다. - -`callback`이 전달되면 메소드가 비동기로 작동되며 결과는 `callback(filename)`을 통해 전달됩니다. +If a `callback` is passed, the API call will be asynchronous and the result +will be passed via `callback(filename)` ## dialog.showMessageBox([browserWindow], options, [callback]) * `browserWindow` BrowserWindow * `options` Object - ** `type` String - `"none"`, `"info"`, `"error"`, `"question"`, `"warning"` 중 하나를 사용할 수 있습니다. - * `buttons` Array - 버튼들의 라벨을 포함한 배열입니다. - * `title` String - 메시지 상자의 제목입니다. 몇몇 플랫폼에선 보이지 않을 수 있습니다. - * `message` String - 메시지 상자의 본문 내용입니다. - * `detail` String - 메시지의 추가 정보입니다. + * `type` String - Can be `"none"`, `"info"` or `"warning"` + * `buttons` Array - Array of texts for buttons + * `title` String - Title of the message box, some platforms will not show it + * `message` String - Content of the message box + * `detail` String - Extra information of the message * `icon` [NativeImage](native-image-ko.md) - * `cancelId` Integer - 유저가 대화 상자의 버튼을 클릭하지 않고 대화 상자를 취소했을 때 반환되는 버튼의 index입니다. - 기본적으로 버튼 리스트가 "cancel" 또는 "no" 라벨을 가지고 있을 때 해당 버튼의 index를 반환합니다. 따로 두 라벨이 지정되지 않은 경우 0을 반환합니다. - OS X와 Windows에선 `cancelId` 지정 여부에 상관없이 "Cancel" 버튼이 언제나 `cancelId`로 지정됩니다. * `callback` Function -메시지 상자를 표시합니다. `browserWindow`를 지정하면 메시지 상자가 완전히 닫힐 때까지는 창을 사용할 수 없습니다. -완료시 유저가 선택한 버튼의 index를 반환합니다. +Shows a message box, it will block until the message box is closed. It returns +the index of the clicked button. -역주: 부정을 표현하는 "아니오", "취소"와 같은 한글 단어는 지원되지 않습니다. -만약 OS X 또는 Windows에서 "확인", "취소"와 같은 순서로 버튼을 지정하게 될 때 Alt + f4로 해당 대화 상자를 끄게 되면 "확인"을 누른걸로 판단되어 버립니다. -이를 해결하려면 "Cancel"을 대신 사용하거나 BrowserWindow API를 사용하여 메시지 상자를 직접 구현해야합니다. - -`callback`이 전달되면 메소드가 비동기로 작동되며 결과는 `callback(response)`을 통해 전달됩니다. +If a `callback` is passed, the API call will be asynchronous and the result +will be passed via `callback(response)` ## dialog.showErrorBox(title, content) -에러 메시지를 보여주는 모달 대화 상자를 표시합니다. +Runs a modal dialog that shows an error message. -이 API는 `app` 모듈의 `ready` 이벤트가 발생하기 전에 사용할 수 있습니다. -이 메소드는 보통 어플리케이션이 시작되기 전에 특정한 에러를 표시하기 위해 사용됩니다. +This API can be called safely before the `ready` event of `app` module emits, it +is usually used to report errors in early stage of startup. diff --git a/docs/api/frameless-window-ko.md b/docs/api/frameless-window-ko.md index 420b277d9b17..8315f48ec8ee 100644 --- a/docs/api/frameless-window-ko.md +++ b/docs/api/frameless-window-ko.md @@ -1,19 +1,20 @@ -# Frameless 윈도우 +# Frameless window -Frameless 윈도우는 테두리가 없는 윈도우 창을 말합니다. +frameless window는 테두리가 없는 윈도우 창을 말합니다. -## Frameless 윈도우 만들기 +## Frameless window 만들기 -Frameless 윈도우를 만드려면 [BrowserWindow](browser-window-ko.md) 객체의 `options`에서 `frame` 옵션을 `false`로 지정하기만 하면됩니다: +Frameless window를 만드려면 [BrowserWindow](browser-window-ko.md) 객체의 `options`에서 `frame` 옵션을 `false`로 지정하기만 하면됩니다: ```javascript var BrowserWindow = require('browser-window'); var win = new BrowserWindow({ width: 800, height: 600, frame: false }); ``` -## 투명한 창 만들기 +## 투명한 윈도우 -Frameless 윈도우의 창의 배경을 투명하게 만들고 싶다면 `transparent` 옵션을 `true`로 바꿔주기만 하면됩니다: +By setting the `transparent` option to `true`, you can also make the frameless +window transparent: ```javascript var win = new BrowserWindow({ transparent: true, frame: false }); @@ -21,32 +22,39 @@ var win = new BrowserWindow({ transparent: true, frame: false }); ### API의 한계 - - -* 투명한 영역을 통과하여 클릭할 수 없습니다. 우리는 이 문제를 해결하기 위해 API를 제공할 예정이지만 현재로써는 - [upstream 버그](https://code.google.com/p/chromium/issues/detail?id=387234)로 인해 중단된 상태입니다. -* 투명한 창은 크기를 조절할 수 없습니다. `resizable` 속성을 `true`로 할 경우 몇몇 플랫폼에선 윈도우 크래시가 일어납니다. -* `blur` 필터는 웹 페이지에서만 적용됩니다. 윈도우 아래 컨텐츠에는 블러 효과를 적용할 방법이 없습니다. -* Windows에선 DWM(데스크톱 창 관리자)가 비활성화되어 있을 경우 작동하지 않습니다. -* Linux를 사용할 경우 [alpha channel doesn't work on some NVidia drivers](https://code.google.com/p/chromium/issues/detail?id=369209) - upstream 버그가 있으므로 CLI 옵션에 `--enable-transparent-visuals --disable-gpu`을 추가해야 합니다. - 이 옵션은 GPU의 사용을 중단하고 윈도우를 생성하는데 ARGB를 사용할 수 있도록 해줍니다. -* OS X(Mac)에선 네이티브 윈도우의 그림자가 투명한 창에선 보이지 않습니다. +* You can not click through the transparent area, we are going to introduce an + API to set window shape to solve this, but currently blocked at an + [upstream bug](https://code.google.com/p/chromium/issues/detail?id=387234). +* Transparent window is not resizable, setting `resizable` to `true` may make + transparent window stop working on some platforms. +* The `blur` filter only applies to the web page, so there is no way to apply + blur effect to the content below the window. +* On Windows transparent window will not work when DWM is disabled. +* On Linux users have to put `--enable-transparent-visuals --disable-gpu` in + command line to disable GPU and allow ARGB to make transparent window, this is + caused by an upstream bug that [alpha channel doesn't work on some NVidia + drivers](https://code.google.com/p/chromium/issues/detail?id=369209) on Linux. +* On Mac the native window shadow will not show for transparent window. ## 드래그 가능 위치 지정 -기본적으로 Frameless 윈도우는 드래그 할 수 없습니다. -어플리케이션의 CSS에서 특정 범위를 `-webkit-app-region: drag`로 지정하면 OS의 기본 타이틀바 처럼 드래그 되도록 할 수 있습니다. -그리고 `-webkit-app-region: no-drag`를 지정해서 드래그 불가능 영역을 만들 수도 있습니다. 현재 사각형 형태의 범위만 지원합니다. +By default, the frameless window is non-draggable. Apps need to specify +`-webkit-app-region: drag` in CSS to tell Electron which regions are draggable +(like the OS's standard titlebar), and apps can also use +`-webkit-app-region: no-drag` to exclude the non-draggable area from the + draggable region. Note that only rectangular shape is currently supported. -창 전체를 드래그 가능하게 만드려면 `-webkit-app-region: drag`을 `body`의 스타일에 지정하면 됩니다: +To make the whole window draggable, you can add `-webkit-app-region: drag` as +`body`'s style: ```html ``` -참고로 창 전체를 드래그 영역으로 지정할 경우 사용자가 버튼을 클릭할 수 없게 되므로 버튼은 드래그 불가능 영역으로 지정해야 합니다: +And note that if you have made the whole window draggable, you must also mark +buttons as non-draggable, otherwise it would be impossible for users to click on +them: ```css button { @@ -54,13 +62,15 @@ button { } ``` -또한 커스텀 타이틀바를 만들어 사용할 때 타이틀바 내부의 버튼도 드래그 불가능 영역으로 지정해야 합니다. +If you're only using a custom titlebar, you also need to make buttons in +titlebar non-draggable. ## 텍스트 선택 -한가지, Frameless 윈도우에서 텍스트가 선택되는 드래그 동작은 혼란을 야기할 수 있습니다. -예를 들어 타이틀바를 드래그 할 때 타이틀바의 텍스트를 실수로 선택할 수 있습니다. -이를 방지하기 위해선 다음과 같이 드래그 영역의 텍스트 선택 동작을 비활성화해야 할 필요가 있습니다: +One thing on frameless window is that the dragging behaviour may conflict with +selecting text, for example, when you drag the titlebar, you may accidentally +select the text on titlebar. To prevent this, you need to disable text +selection on dragging area like this: ```css .titlebar { @@ -71,5 +81,7 @@ button { ## 컨텍스트 메뉴 -몇몇 플랫폼에선 드래그 가능 영역이 non-client 프레임으로 처리됩니다. 그래서 이 영역에서 오른쪽 클릭을 할 경우 시스템 메뉴가 팝업 됩니다. -그래서 컨텍스트 메뉴 지정이 모든 플랫폼에서 정상적으로 작동하게 하려면 커스텀 컨텍스트 메뉴를 드래그 영역 내에 만들어선 안됩니다. +On some platforms, the draggable area would be treated as non-client frame, so +when you right click on it a system menu would be popuped. To make context menu +behave correctly on all platforms, you should never custom context menu on +draggable areas. diff --git a/docs/api/menu-ko.md b/docs/api/menu-ko.md index 234aad4afeee..3ac62012f675 100644 --- a/docs/api/menu-ko.md +++ b/docs/api/menu-ko.md @@ -1,10 +1,12 @@ # menu -`Menu` 클래스는 어플리케이션 메뉴와 컨텍스트 메뉴를 만들 때 사용할 수 있습니다. -각 메뉴는 여러 개의 메뉴 아이템으로 구성되어 있으며 서브 메뉴를 가질 수도 있습니다. +The `Menu` class is used to create native menus that can be used as +application menus and context menus. Each menu consists of multiple menu +items, and each menu item can have a submenu. -다음 예제는 웹 페이지 내에서 [remote](remote-ko.md) 모듈을 활용하여 동적으로 메뉴를 생성하는 예제입니다. -그리고 이 예제에서 만들어진 메뉴는 유저가 페이지에서 오른쪽 클릭을 할 때 마우스 위치에 팝업으로 표시됩니다: +Below is an example of creating a menu dynamically in a web page by using +the [remote](remote-ko.md) module, and showing it when the user right clicks +the page: ```html @@ -25,7 +27,7 @@ window.addEventListener('contextmenu', function (e) { ``` -다음 예제는 template API를 활용하여 어플리케이션 메뉴를 만드는 간단한 예제입니다: +Another example of creating the application menu with the simple template API: ```html @@ -165,30 +167,34 @@ Menu.setApplicationMenu(menu); ### new Menu() -새로운 메뉴를 생성합니다. +Creates a new menu. ### Class Method: Menu.setApplicationMenu(menu) * `menu` Menu -지정한 `menu`를 이용하여 어플리케이션 메뉴를 만듭니다. OS X에선 상단바에 표시되며 Windows와 Linux에선 각 창의 상단에 표시됩니다. +Sets `menu` as the application menu on OS X. On Windows and Linux, the `menu` +will be set as each window's top menu. ### Class Method: Menu.sendActionToFirstResponder(action) * `action` String -`action`을 어플리케이션의 first responder에 전달합니다. -이 함수는 Cocoa 메뉴 동작을 에뮬레이트 하는데 사용되며 보통 `MenuItem`의 `selector` 속성에 사용됩니다. +Sends the `action` to the first responder of application, this is used for +emulating default Cocoa menu behaviors, usually you would just use the +`selector` property of `MenuItem`. -**알림:** 이 함수는 OS X에서만 사용할 수 있습니다. +**Note:** This method is OS X only. ### Class Method: Menu.buildFromTemplate(template) * `template` Array -기본적으로 `template`는 [MenuItem](menu-item-ko.md)을 생성할 때 사용하는 `options`의 배열입니다. 사용법은 위에서 설명한 것과 같습니다. +Generally, the `template` is just an array of `options` for constructing +[MenuItem](menu-item-ko.md), the usage can be referenced above. -또한 `template`에는 다른 속성도 추가할 수 있으며 메뉴가 만들어질 때 해당 메뉴 아이템의 프로퍼티로 변환됩니다. +You can also attach other fields to element of the `template`, and they will +become properties of the constructed menu items. ### Menu.popup(browserWindow, [x, y]) @@ -196,70 +202,86 @@ Menu.setApplicationMenu(menu); * `x` Number * `y` Number -메뉴를 `browserWindow` 안에서 팝업으로 표시합니다. -옵션으로 메뉴를 표시할 `(x,y)` 좌표를 임의로 지정할 수 있습니다. 따로 지정하지 않은 경우 마우스 커서 위치에 표시됩니다. +Popups this menu as a context menu in the `browserWindow`. You can optionally +provide a `(x,y)` coordinate to place the menu at, otherwise it will be placed +at the current mouse cursor position. ### Menu.append(menuItem) * `menuItem` MenuItem -메뉴의 리스트 끝에 `menuItem`을 삽입합니다. +Appends the `menuItem` to the menu. ### Menu.insert(pos, menuItem) * `pos` Integer * `menuItem` MenuItem -`pos` 위치에 `menuItem`을 삽입합니다. +Inserts the `menuItem` to the `pos` position of the menu. ### Menu.items -메뉴가 가지고 있는 메뉴 아이템들의 배열입니다. +Get the array containing the menu's items. -## OS X 어플리케이션 메뉴에 대해 알아 둬야 할 것들 +## Notes on OS X application menu -OS X에선 Windows, Linux와 달리 완전히 다른 어플리케이션 메뉴 스타일을 가지고 있습니다. -어플리케이션을 네이티브처럼 작동할 수 있도록 하기 위해선 다음의 몇 가지 유의 사항을 숙지해야 합니다. +OS X has a completely different style of application menu from Windows and +Linux, and here are some notes on making your app's menu more native-like. -### 기본 메뉴 +### Standard menus -OS X엔 `Services`나 `Windows`와 같은 많은 시스템 지정 기본 메뉴가 있습니다. -기본 메뉴를 만들려면 다음 중 하나를 메뉴의 라벨로 지정하기만 하면 됩니다. -그러면 Electron이 자동으로 인식하여 해당 메뉴를 기본 메뉴로 만듭니다: +On OS X there are many system defined standard menus, like the `Services` and +`Windows` menus. To make your menu a standard menu, you can just set your menu's +label to one of followings, and Electron will recognize them and make them +become standard menus: * `Window` * `Help` * `Services` -### 기본 메뉴 아이템 동작 +### Standard menu item actions -OS X는 몇몇의 메뉴 아이템에 대해 `About xxx`, `Hide xxx`, `Hide Others`와 같은 기본 동작을 제공하고 있습니다. (`selector`라고 불립니다) -메뉴 아이템의 기본 동작을 지정하려면 메뉴 아이템의 `selector` 속성을 사용하면 됩니다. +OS X has provided standard actions for some menu items (which are called +`selector`s), like `About xxx`, `Hide xxx`, and `Hide Others`. To set the action +of a menu item to a standard action, you can set the `selector` attribute of the +menu item. -### 메인 메뉴의 이름 +### Main menu's name -OS X에선 지정한 어플리케이션 메뉴에 상관없이 메뉴의 첫번째 라벨은 언제나 어플리케이션의 이름이 됩니다. -어플리케이션 이름을 변경하려면 앱 번들내의 `Info.plist` 파일을 수정해야합니다. -자세한 내용은 [About Information Property List Files](https://developer.apple.com/library/ios/documentation/general/Reference/InfoPlistKeyReference/Articles/AboutInformationPropertyListFiles.html)을 참고하세요. +On OS X the label of application menu's first item is always your app's name, +no matter what label you set. To change it you have to change your app's name +by modifying your app bundle's `Info.plist` file. See +[About Information Property List Files](https://developer.apple.com/library/ios/documentation/general/Reference/InfoPlistKeyReference/Articles/AboutInformationPropertyListFiles.html) +for more. -## 메뉴 아이템 위치 -`Menu.buildFromTemplate`로 메뉴를 만들 때 `position`과 `id`를 사용해서 아이템의 위치를 지정할 수 있습니다. +## Menu item position -`MenuItem`의 `position` 속성은 `[placement]=[id]`와 같은 형식을 가지며 `placement`는 -`before`, `after`, `endof` 속성 중 한가지를 사용할 수 있고 `id`는 메뉴 아이템이 가지는 유일 ID 입니다: +You can make use of `position` and `id` to control how the item would be placed +when building a menu with `Menu.buildFromTemplate`. -* `before` - 이 아이템을 지정한 id 이전의 위치에 삽입합니다. 만약 참조된 아이템이 없을 경우 메뉴의 맨 뒤에 삽입됩니다. -* `after` - 이 아이템을 지정한 id 다음의 위치에 삽입합니다. 만약 참조된 아이템이 없을 경우 메뉴의 맨 뒤에 삽입됩니다. -* `endof` - 이 아이템을 id의 논리 그룹에 맞춰서 각 그룹의 항목 뒤에 삽입합니다. (그룹은 분리자 아이템에 의해 만들어집니다) - 만약 참조된 아이템의 분리자 그룹이 존재하지 않을 경우 지정된 id로 새로운 분리자 그룹을 만든 후 해당 그룹의 뒤에 삽입됩니다. +The `position` attribute of `MenuItem` has the form `[placement]=[id]` where +placement is one of `before`, `after`, or `endof` and `id` is the unique ID of +an existing item in the menu: -위치를 지정한 아이템의 뒤에 위치가 지정되지 않은 아이템이 있을 경우 해당 아이템의 위치가 지정되기 전까지 이전에 위치가 지정된 아이템의 위치 지정을 따릅니다. -이에 따라 위치를 이동하고 싶은 특정 그룹의 아이템들이 있을 경우 해당 그룹의 맨 첫번째 메뉴 아이템의 위치만을 지정하면 됩니다. +* `before` - Inserts this item before the id referenced item. If the + referenced item doesn't exist the item will be inserted at the end of + the menu. +* `after` - Inserts this item after id referenced item. If the referenced + item doesn't exist the item will be inserted at the end of the menu. +* `endof` - Inserts this item at the end of the logical group containing + the id referenced item. (Groups are created by separator items). If + the referenced item doesn't exist a new separator group is created with + the given id and this item is inserted after that separator. -### 예제 +When an item is positioned following unpositioned items are inserted after +it, until a new item is positioned. So if you want to position a group of +menu items in the same location you only need to specify a position for +the first item. -메뉴 템플릿: +### Examples + +Template: ```javascript [ @@ -271,7 +293,7 @@ OS X에선 지정한 어플리케이션 메뉴에 상관없이 메뉴의 첫번 ] ``` -메뉴: +Menu: ``` - 1 @@ -281,7 +303,7 @@ OS X에선 지정한 어플리케이션 메뉴에 상관없이 메뉴의 첫번 - 5 ``` -메뉴 템플릿: +Template: ```javascript [ @@ -294,7 +316,7 @@ OS X에선 지정한 어플리케이션 메뉴에 상관없이 메뉴의 첫번 ] ``` -메뉴: +Menu: ``` - --- diff --git a/docs/api/protocol-ko.md b/docs/api/protocol-ko.md index 20243ab95824..26fc4eb740c4 100644 --- a/docs/api/protocol-ko.md +++ b/docs/api/protocol-ko.md @@ -19,20 +19,18 @@ app.on('ready', function() { **알림:** 이 모듈은 app의 `ready` 이벤트가 발생한 이후에만 사용할 수 있습니다. -## protocol.registerProtocol(scheme, handler, callback) +## protocol.registerProtocol(scheme, handler) * `scheme` String * `handler` Function -* `callback` Function -지정한 `scheme`을 기반으로 커스텀 프로토콜을 등록합니다. `handler`는 등록한 `scheme` 프로토콜에 요청이 들어올 경우 `request` 인자와 함께 `handler(request)` 형식으로 호출됩니다. +지정한 `scheme`을 기반으로 커스텀 프로토콜을 등록합니다. 등록한 `scheme` 프로토콜에 요청이 들어올 경우 `request` 인자와 함께 `handler` 함수가 호출됩니다. -`handler` 함수에선 요청에 대한 해당 프로토콜의 작업 결과를 응답(반환) 해야 합니다. +호출된 `handler` 함수에선 요청에 대한 해당 프로토콜의 작업 결과를 응답(반환) 해야 할 필요가 있습니다. -## protocol.unregisterProtocol(scheme, callback) +## protocol.unregisterProtocol(scheme) * `scheme` String -* `callback` Function 지정한 `scheme` 프로토콜을 등록 해제합니다. @@ -42,27 +40,23 @@ app.on('ready', function() { 지정한 `value` 배열을 사용하여 미리 지정된 스킴으로 등록합니다. -## protocol.isHandledProtocol(scheme, callback) +## protocol.isHandledProtocol(scheme) * `scheme` String -* `callback` Function 해당 `scheme`에 처리자(handler)가 등록되었는지 확인합니다. -지정한 `callback`에 결과가 boolean 값으로 반환됩니다. -## protocol.interceptProtocol(scheme, handler, callback) +## protocol.interceptProtocol(scheme, handler) * `scheme` String * `handler` Function -* `callback` Function 지정한 `scheme`의 작업을 `handler`로 변경합니다. `handler`에서 `null` 또는 `undefined`를 반환 할 경우 해당 프로토콜의 기본 동작(응답)으로 대체 됩니다. -## protocol.uninterceptProtocol(scheme, callback) +## protocol.uninterceptProtocol(scheme) * `scheme` String -* `callback` Function 변경된 프로토콜의 작업을 해제합니다. diff --git a/docs/api/remote-ko.md b/docs/api/remote-ko.md index 11d62dd27194..0feb53ece5ee 100644 --- a/docs/api/remote-ko.md +++ b/docs/api/remote-ko.md @@ -1,6 +1,7 @@ # remote -`remote` 모듈은 메인 프로세스와 랜더러 프로세스 사이에 inter-process 통신을 하기 위한 가장 간단한 방법입니다. +The `remote` module provides a simple way to do inter-process communication +between the renderer process and the main process. In Electron, only GUI-unrelated modules are available in the renderer process. Without the `remote` module, users who wanted to call a main process API in diff --git a/docs/api/screen-ko.md b/docs/api/screen-ko.md index 6b508991e4f7..c554863586cc 100644 --- a/docs/api/screen-ko.md +++ b/docs/api/screen-ko.md @@ -1,14 +1,13 @@ # screen -`screen` 모듈은 화면 크기, 디스플레이, 커서 위치 등등의 다양한 정보를 가져옵니다. -이 모듈은 `app` 모듈의 `ready` 이벤트가 발생하기 전까지 사용할 수 없습니다. +Gets various info about screen size, displays, cursor position, etc. You should +not use this module until the `ready` event of `app` module gets emitted. -`screen`은 [EventEmitter](http://nodejs.org/api/events.html#events_class_events_eventemitter)를 상속 받았습니다. +`screen` is an [EventEmitter](http://nodejs.org/api/events.html#events_class_events_eventemitter). -한가지 주의할 점은 랜더러 / DevTools에선 이 모듈의 이름인 `screen`은 이미 DOM 속성에 `window.screen`로 존재 하므로 `screen = require('screen')`를 -사용할 수 없습니다. 밑의 예제와 같이 `atomScreen`등의 이름으로 변수 이름을 대체하여 사용해야 합니다. +Make sure to note that in the renderer / DevTools, `window.screen` is a reserved DOM property, so writing `screen = require('screen')` won't work. In our examples below, we use `atomScreen` as the variable name instead. -다음 예제는 화면 전체를 채우는 윈도우 창을 생성합니다: +An example of creating a window that fills the whole screen: ```javascript var app = require('app'); @@ -23,7 +22,7 @@ app.on('ready', function() { }); ``` -다음 예제는 확장 디스플레이에 윈도우를 생성합니다: +Another example of creating a window in the external display: ```javascript var app = require('app'); @@ -56,14 +55,14 @@ app.on('ready', function() { * `event` Event * `newDisplay` Object -새로운 디스플레이가 추가되면 발생합니다. +Emitted when `newDisplay` has been added. ## Event: display-removed * `event` Event * `oldDisplay` Object -기존의 디스플레이가 제거되면 발생합니다. +Emitted when `oldDisplay` has been removed. ## Event: display-metrics-changed @@ -71,21 +70,21 @@ app.on('ready', function() { * `display` Object * `changedMetrics` Array -`display`의 하나 또는 다수의 매트릭스가 변경될 경우 발생합니다. -`changedMetrics`는 변경에 대한 정보를 담은 문자열의 배열입니다. -`bounds`, `workArea`, `scaleFactor`, `rotation`등이 변경될 수 있습니다. +Emitted when a `display` has one or more metrics changed, `changedMetrics` is +an array of strings that describe the changes. Possible changes are `bounds`, +`workArea`, `scaleFactor` and `rotation`. ## screen.getCursorScreenPoint() -현재 마우스 포인터의 절대 위치를 반환합니다. +Returns the current absolute position of the mouse pointer. ## screen.getPrimaryDisplay() -기본 디스플레이를 반환합니다. +Returns the primary display. ## screen.getAllDisplays() -사용 가능한 모든 디스플레이를 배열로 반환합니다. +Returns an array of displays that are currently available. ## screen.getDisplayNearestPoint(point) @@ -93,7 +92,7 @@ app.on('ready', function() { * `x` Integer * `y` Integer -지정한 좌표에 가까운 디스플레이를 반환합니다. +Returns the display nearest the specified point. ## screen.getDisplayMatching(rect) @@ -103,4 +102,4 @@ app.on('ready', function() { * `width` Integer * `height` Integer -지정한 범위에 가장 가깝게 교차한 디스플레이를 반환합니다. +Returns the display that most closely intersects the provided bounds. diff --git a/docs/api/shell-ko.md b/docs/api/shell-ko.md index d9ceea106a54..5811afdcb930 100644 --- a/docs/api/shell-ko.md +++ b/docs/api/shell-ko.md @@ -26,7 +26,7 @@ shell.openExternal('https://github.com'); * `url` String 제공된 외부 프로토콜 URL을 기반으로 데스크톱의 기본 프로그램으로 엽니다. (예를 들어 mailto: URL은 해당 URL을 기본 메일 에이전트로 엽니다.) -역주: 폴더는 'file:\\\\C:\\'와 같이 지정하여 열 수 있습니다. (`\\`로 경로를 표현한 이유는 Escape 문자열을 참고하세요.) +역자주: 폴더는 'file:\\\\C:\\'와 같이 지정하여 열 수 있습니다. (`\\`로 경로를 표현한 이유는 Escape 문자열을 참고하세요.) ## shell.moveItemToTrash(fullPath) diff --git a/docs/development/build-instructions-linux-ko.md b/docs/development/build-instructions-linux-ko.md index 3d7f9389f77b..ec955f3439a7 100644 --- a/docs/development/build-instructions-linux-ko.md +++ b/docs/development/build-instructions-linux-ko.md @@ -89,16 +89,7 @@ $ ./script/clean.py ## 문제 해결 -개발 종속성 라이브러리들을 제대로 설치했는지 확인하세요. - -## libtinfo.so.5 동적 링크 라이브러리를 로드하는 도중 에러가 발생할 경우 - -미리 빌드된 `clang`은 `libtinfo.so.5`로 링크를 시도합니다. -플랫폼에 따라 적당한 `libncurses` symlink를 추가하세요. - -```bash -$ sudo ln -s /usr/lib/libncurses.so.5 /usr/lib/libtinfo.so.5 -``` +개발 종속성 라이브러리들을 제대로 설치했는지 확인하세요. ## 테스트 diff --git a/docs/development/build-system-overview-ko.md b/docs/development/build-system-overview-ko.md index 7198fa831b92..92fd50008529 100644 --- a/docs/development/build-system-overview-ko.md +++ b/docs/development/build-system-overview-ko.md @@ -25,14 +25,9 @@ Electron도 상당히 비슷한 접근을 했습니다: ## 부트스트랩 최소화 -Prebuilt된 모든 Chromium 바이너리들은 부트스트랩 스크립트가 실행될 때 다운로드됩니다. +모든 사전 빌드 된 Chromium 바이너리들은 부트스트랩 스크립트가 실행될 때 다운로드됩니다. 기본적으로 공유 라이브러리와 정적 라이브러리 모두 다운로드되며 최종 전체 파일 크기는 플랫폼에 따라 800MB에서 2GB까지 차지합니다. -기본적으로 libchromiumcontent는 Amazon Web Service를 통해 다운로드 됩니다. -만약 `LIBCHROMIUMCONTENT_MIRROR` 환경 변수가 설정되어 있으면 부트스트랩은 해당 링크를 사용하여 바이너리를 다운로드 합니다. -[libchromiumcontent-qiniu-mirror](https://github.com/hokein/libchromiumcontent-qiniu-mirror)는 libchromiumcontent의 미러입니다. -만약 AWS에 접근할 수 없다면 `export LIBCHROMIUMCONTENT_MIRROR=http://7xk3d2.dl1.z0.glb.clouddn.com/`를 통해 다운로드 할 수 있습니다. - 만약 빠르게 Electron의 개발 또는 테스트만 하고 싶다면 `--dev` 플래그를 추가하여 공유 라이브러리만 다운로드할 수 있습니다: ```bash diff --git a/docs/tutorial/application-distribution-ko.md b/docs/tutorial/application-distribution-ko.md index 0b6ff631ad70..a1bb5bc65044 100644 --- a/docs/tutorial/application-distribution-ko.md +++ b/docs/tutorial/application-distribution-ko.md @@ -99,7 +99,7 @@ MyApp.app/Contents 실행파일 `electron`의 이름을 원하는 대로 바꿀 수 있습니다. 리눅스 어플리케이션의 아이콘은 [.desktop](https://developer.gnome.org/integration-guide/stable/desktop-files.html.en) 파일을 사용하여 지정할 수 있습니다. -### 역주-자동화 +### 역자주-자동화 배포시에 Electron의 리소스를 일일이 수정하는 것은 매우 귀찮고 복잡합니다. 하지만 이 작업을 자동화 시킬 수 있는 몇가지 방법이 있습니다: diff --git a/docs/tutorial/quick-start-ko.md b/docs/tutorial/quick-start-ko.md index a49b7e017609..e5ef8662cd7a 100644 --- a/docs/tutorial/quick-start-ko.md +++ b/docs/tutorial/quick-start-ko.md @@ -75,8 +75,6 @@ var mainWindow = null; // 모든 창이 닫히면 어플리케이션 종료. app.on('window-all-closed', function() { - // OSX의 대부분의 어플리케이션에선 유저가 Cmd + Q 커맨드로 확실하게 종료하기 전까지는 - // 어플리케이션이 메뉴바에 남아 계속 실행됩니다. if (process.platform != 'darwin') { app.quit(); } @@ -114,16 +112,16 @@ app.on('ready', function() {

헬로 월드!

- 이 어플리케이션은 io.js 과 - Electron 을 사용합니다. + 우리는 io.js 버전과 + Electron 버전을 사용합니다. ``` ## 앱 실행하기 -앱을 작성한 후 [어플리케이션 배포](./application-distribution-ko.md) 가이드를 따라 앱을 패키징 하고 패키징한 앱을 실행할 수 있습니다. -또는 Electron 실행파일을 다운로드 받아 바로 실행해 볼 수도 있습니다. +앱을 작성한 후 [어플리케이션 배포](./application-distribution-ko.md) 가이드를 따라 앱을 패키징 하고 +패키징한 앱을 실행해 볼 수 있습니다. 또한 Electron 실행파일을 다운로드 받아 바로 실행해 볼 수도 있습니다. Windows의 경우: diff --git a/docs/tutorial/using-native-node-modules-ko.md b/docs/tutorial/using-native-node-modules-ko.md index 1e67ee25305d..da68c475ba83 100644 --- a/docs/tutorial/using-native-node-modules-ko.md +++ b/docs/tutorial/using-native-node-modules-ko.md @@ -1,6 +1,6 @@ # 네이티브 node 모듈 사용하기 -__역주: 현재 Electron은 node.js대신 io.js를 사용합니다. 문서에 기재된 버전과 다를 수 있습니다__ +__역자주: 현재 Electron은 node.js대신 io.js를 사용합니다. 문서에 기재된 버전과 다를 수 있습니다__ Electron에선 node.js 네이티브 모듈이 지원됩니다. 하지만 Electron은 공식 node.js의 V8 엔진과는 달리 다른 V8 버전을 사용합니다. 그런 이유로 네이티브 모듈을 사용하기 위해선 Electron의 V8 버전에 맞춰 네이티브 모듈을 다시 빌드하고 헤더를 변경해야 합니다. @@ -34,11 +34,11 @@ Node 모듈을 `node-gyp`를 사용하여 Electron을 타겟으로 빌드할 땐 ```bash $ cd /path-to-module/ -$ HOME=~/.electron-gyp node-gyp rebuild --target=0.29.1 --arch=x64 --dist-url=https://atom.io/download/atom-shell +$ HOME=~/.electron-gyp node-gyp rebuild --target=0.25.0 --arch=ia64 --dist-url=https://atom.io/download/atom-shell ``` -`HOME=~/.electron-gyp`은 변경할 헤더의 위치를 찾습니다. `--target=0.29.1`은 Electron의 버전입니다. -`--dist-url=...`은 헤더를 다운로드 하는 주소입니다. `--arch=x64`는 64비트 시스템을 타겟으로 빌드 한다는 것을 `node-gyp`에게 알려줍니다. +`HOME=~/.electron-gyp`은 변경할 헤더의 위치를 찾습니다. `--target=0.25.0`은 Electron의 버전입니다. +`--dist-url=...`은 헤더를 다운로드 하는 주소입니다. `--arch=ia64`는 64비트 시스템을 타겟으로 빌드 한다는 것을 `node-gyp`에게 알려줍니다. ### npm을 이용한 방법 @@ -47,7 +47,7 @@ $ HOME=~/.electron-gyp node-gyp rebuild --target=0.29.1 --arch=x64 --dist-url=ht ```bash export npm_config_disturl=https://atom.io/download/atom-shell -export npm_config_target=0.29.1 +export npm_config_target=0.25.0 export npm_config_arch=x64 HOME=~/.electron-gyp npm install module-name ``` From e510384375b29518945abd70a0201b2d7190d6c1 Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Sun, 12 Jul 2015 13:23:54 +0900 Subject: [PATCH 0614/1293] Revert "Revert "Update APIs, check grammars"" This reverts commit 5e083473e7b4d3a6014d35e68618594765151afe. --- docs/README-ko.md | 5 +- docs/api/app-ko.md | 4 + docs/api/auto-updater-ko.md | 2 +- docs/api/chrome-command-line-switches-ko.md | 20 ++- docs/api/clipboard-ko.md | 15 +++ docs/api/content-tracing-ko.md | 6 +- docs/api/crash-reporter-ko.md | 63 +++++----- docs/api/dialog-ko.md | 72 +++++------ docs/api/frameless-window-ko.md | 68 +++++------ docs/api/menu-ko.md | 114 +++++++----------- docs/api/protocol-ko.md | 20 +-- docs/api/remote-ko.md | 3 +- docs/api/screen-ko.md | 33 ++--- docs/api/shell-ko.md | 2 +- .../build-instructions-linux-ko.md | 11 +- docs/development/build-system-overview-ko.md | 7 +- docs/tutorial/application-distribution-ko.md | 2 +- docs/tutorial/quick-start-ko.md | 10 +- docs/tutorial/using-native-node-modules-ko.md | 10 +- 19 files changed, 235 insertions(+), 232 deletions(-) diff --git a/docs/README-ko.md b/docs/README-ko.md index 50c4b2c9c9ca..6e0daa59fd2b 100644 --- a/docs/README-ko.md +++ b/docs/README-ko.md @@ -67,5 +67,6 @@ * [빌드 설명서 (Linux)](development/build-instructions-linux-ko.md) * [디버거에서 디버그 심볼 서버 설정](development/setting-up-symbol-server-ko.md) -이 문서는 [@preco21](https://github.com/preco21) 에 의해 번역되었습니다. -문서내에서 오타나 잘못된 번역이 발견될 경우 해당 repo를 fork한 후 수정하여 PR을 올리거나 `plusb21@gmail.com` 이메일로 알려주시면 감사하겠습니다. +이 참조문서는 [@preco21](https://github.com/preco21)에 의해 번역되었습니다. +문서내에서 오타나 잘못된 번역을 발견하면 `plusb21@gmail.com` 이메일로 알려주시면 감사하겠습니다. +원본과는 달리 항시 최신버전을 유지할 수 없으므로 원본을 같이 참고하는 것을 권장합니다. diff --git a/docs/api/app-ko.md b/docs/api/app-ko.md index 293cfd965a39..434d0620282a 100644 --- a/docs/api/app-ko.md +++ b/docs/api/app-ko.md @@ -139,6 +139,10 @@ This method guarantees all `beforeunload` and `unload` handlers are correctly executed. It is possible that a window cancels the quitting by returning `false` in `beforeunload` handler. +## app.getAppPath() + +Returns the current application directory. + ## app.getPath(name) * `name` String diff --git a/docs/api/auto-updater-ko.md b/docs/api/auto-updater-ko.md index 0894fc3485fb..bcfc3b562682 100644 --- a/docs/api/auto-updater-ko.md +++ b/docs/api/auto-updater-ko.md @@ -1,6 +1,6 @@ # auto-updater -**This module has only been implemented for OS X.** +**이 모듈은 현재 OS X에서만 사용할 수 있습니다.** Check out [atom/grunt-electron-installer](https://github.com/atom/grunt-electron-installer) for building a Windows installer for your app. diff --git a/docs/api/chrome-command-line-switches-ko.md b/docs/api/chrome-command-line-switches-ko.md index 35ea805ccd4e..ed8cf55e06ec 100644 --- a/docs/api/chrome-command-line-switches-ko.md +++ b/docs/api/chrome-command-line-switches-ko.md @@ -51,10 +51,8 @@ Hostname 맵핑 규칙을 설정합니다. (`,`로 분리) also force the port of the resulting socket address to be 77. * `MAP * baz, EXCLUDE www.google.com` Remaps everything to "baz", except for "www.google.com". - -These mappings apply to the endpoint host in a net request (the TCP connect -and host resolver in a direct connection, and the `CONNECT` in an http proxy -connection, and the endpoint host in a `SOCKS` proxy connection). + +이 맵핑은 네트워크 요청시의 endpoint를 지정합니다. (TCP 연결과 직접 연결의 호스트 resolver, http 프록시 연결의 `CONNECT`, `SOCKS` 프록시 연결의 endpoint 호스트) ## --host-resolver-rules=`rules` @@ -88,16 +86,14 @@ Net log 이벤트를 지정한 `path`에 로그로 기록합니다. ## --vmodule=`pattern` -Gives the per-module maximal V-logging levels to override the value given by -`--v`. E.g. `my_module=2,foo*=3` would change the logging level for all code in -source files `my_module.*` and `foo*.*`. +`--v` 옵션에 전달된 값을 덮어쓰고 모듈당 최대 V-logging 레벨을 지정합니다. +예를 들어 `my_module=2,foo*=3`는 `my_module.*`, `foo*.*`와 같은 파일 이름 패턴을 가진 모든 소스 코드들의 로깅 레벨을 각각 2와 3으로 설정합니다. -Any pattern containing a forward or backward slash will be tested against the -whole pathname and not just the module. E.g. `*/foo/bar/*=2` would change the -logging level for all code in source files under a `foo/bar` directory. +슬래시(`/`), 백슬래시(`\`)를 포함하는 모든 패턴은 모듈뿐만 아니라 모든 경로명에 대해서도 테스트 됩니다. +예를 들어 `*/foo/bar/*=2` 표현식은 `foo/bar` 디렉터리 안의 모든 소스 코드의 로깅 레벨을 2로 지정합니다. + +모든 크로미움과 관련된 로그를 비활성화하고 어플리케이션의 로그만 활성화 하려면 다음과 같이 코드를 작성하면 됩니다: -To disable all chromium related logs and only enable your application logs you -can do: ```javascript app.commandLine.appendSwitch('v', -1); diff --git a/docs/api/clipboard-ko.md b/docs/api/clipboard-ko.md index 3ee0164e9759..bc6c82786cb7 100644 --- a/docs/api/clipboard-ko.md +++ b/docs/api/clipboard-ko.md @@ -86,3 +86,18 @@ console.log(clipboard.has('

selection

')); 클립보드로부터 `data`를 읽어들입니다. **알림:** 이 API는 실험적인 기능이며 차후 최신버전에서 제외될 수 있습니다. + +## clipboard.write(data[, type]) + +* `data` Object + * `text` String + * `html` String + * `image` [NativeImage](native-image.md) +* `type` String + +```javascript +var clipboard = require('clipboard'); +clipboard.write({text: 'test', html: "test"}); +``` + +`data`를 클립보드에 씁니다. diff --git a/docs/api/content-tracing-ko.md b/docs/api/content-tracing-ko.md index a0896c2a7182..e9fa3158a2fb 100644 --- a/docs/api/content-tracing-ko.md +++ b/docs/api/content-tracing-ko.md @@ -1,9 +1,7 @@ # content-tracing -The `content-trace` module is used to collect tracing data generated by the -underlying Chromium content module. This module does not include a web interface -so you need to open `chrome://tracing/` in a Chrome browser and load the generated -file to view the result. +`content-trace` 모듈은 Chromium 컨텐츠 모듈단에서 생성된 데이터를 수집하고 추적하는데 사용됩니다. +이 모듈은 웹 인터페이스를 포함하고 있지 않으며 크롬 브라우저에서 `chrome://tracing/` 페이지를 열어 생성된 파일을 로드하면 결과를 볼 수 있습니다. ```javascript var tracing = require('content-tracing'); diff --git a/docs/api/crash-reporter-ko.md b/docs/api/crash-reporter-ko.md index 1302d9b457e2..b8c076a7ceae 100644 --- a/docs/api/crash-reporter-ko.md +++ b/docs/api/crash-reporter-ko.md @@ -1,6 +1,6 @@ # crash-reporter -An example of automatically submitting crash reporters to remote server: +다음 예제는 윈격 서버에 어플리케이션 오류 정보를 자동으로 보고하는 예제입니다: ```javascript crashReporter = require('crash-reporter'); @@ -15,47 +15,46 @@ crashReporter.start({ ## crashReporter.start(options) * `options` Object - * `productName` String, default: Electron - * `companyName` String, default: GitHub, Inc - * `submitUrl` String, default: http://54.249.141.255:1127/post - * URL that crash reports would be sent to as POST - * `autoSubmit` Boolean, default: true - * Send the crash report without user interaction - * `ignoreSystemCrashHandler` Boolean, default: false + * `productName` String, 기본값: Electron + * `companyName` String, 기본값: GitHub, Inc + * `submitUrl` String, 기본값: http://54.249.141.255:1127/post + * Crash Reporter는 POST 방식으로 해당 URL에 전송됩니다. + * `autoSubmit` Boolean, 기본값: true + * true로 지정할 경우 유저의 승인 없이 자동으로 오류를 보고합니다. + * `ignoreSystemCrashHandler` Boolean, 기본값: false * `extra` Object - * An object you can define which content will be send along with the report. - * Only string properties are send correctly. - * Nested objects are not supported. - -Developers are required to call the API before using other crashReporter APIs. + * 오류보고 시 같이 보낼 추가 정보를 지정하는 객체입니다. + * 문자열로 된 속성만 정상적으로 보내집니다. + * 중첩 객체는 지원되지 않습니다. (Nested objects are not supported) + +다른 crashReporter API들을 사용하기 전에 이 함수를 먼저 호출해야 합니다. -**Note:** On OS X, electron uses a new `crashpad` client, which is different -with the `breakpad` on Windows and Linux. To enable crash collection feature, -you are required to call `crashReporter.start` API to initiliaze `crashpad` in -main process, even you only collect crash report in renderer process. +**알림:** OS X에선 Windows와 Linux의 `breakpad`와 달리 새로운 `crashpad` 클라이언트를 사용합니다. +오류 수집 기능을 활성화 시키려면 오류를 수집하고 싶은 메인 프로세스나 랜더러 프로세스에서 +`crashReporter.start` 함수를 호출하여 `crashpad`를 초기화 해야합니다. ## crashReporter.getLastCrashReport() -Returns the date and ID of last crash report, when there was no crash report -sent or the crash reporter is not started, `null` will be returned. +마지막 오류보고의 날짜와 ID를 반환합니다. +이전 오류보고가 없거나 Crash Reporter가 시작되지 않았을 경우 `null`이 반환됩니다. ## crashReporter.getUploadedReports() -Returns all uploaded crash reports, each report contains date and uploaded ID. +모든 업로드된 오류보고를 반환합니다. 각 보고는 날짜와 업로드 ID를 포함하고 있습니다. -# crash-reporter payload +# crash-reporter 오류보고 형식 -The crash reporter will send the following data to the `submitUrl` as `POST`: +Crash Reporter는 다음과 같은 데이터를 `submitUrl`에 `POST` 방식으로 전송합니다: -* `rept` String - e.g. 'electron-crash-service' -* `ver` String - The version of Electron -* `platform` String - e.g. 'win32' -* `process_type` String - e.g. 'renderer' +* `rept` String - 예시 'electron-crash-service' +* `ver` String - Electron의 버전 +* `platform` String - 예시 'win32' +* `process_type` String - 예시 'renderer' * `ptime` Number -* `_version` String - The version in `package.json` -* `_productName` String - The product name in the crashReporter `options` object -* `prod` String - Name of the underlying product. In this case Electron -* `_companyName` String - The company name in the crashReporter `options` object -* `upload_file_minidump` File - The crashreport as file -* All level one properties of the `extra` object in the crashReporter `options` object +* `_version` String - `package.json`내의 `version` 필드 +* `_productName` String - Crash Reporter의 `options` 객체에서 정의한 제품명. +* `prod` String - 기본 제품의 이름. 이 경우 Electron으로 표시됩니다. +* `_companyName` String - Crash Reporter의 `options` 객체에서 정의한 회사명. +* `upload_file_minidump` File - 오류보고 파일 +* Crash Reporter의 `options` 객체에서 정의한 `extra` 객체의 속성들. diff --git a/docs/api/dialog-ko.md b/docs/api/dialog-ko.md index 25c4abfa7631..a16daebb6f3a 100644 --- a/docs/api/dialog-ko.md +++ b/docs/api/dialog-ko.md @@ -1,17 +1,17 @@ # dialog -The `dialog` module provides APIs to show native system dialogs, so web -applications can deliver the same user experience as native applications. +`dialog` 모듈은 네이티브 시스템의 대화 상자를 조작할 때 사용할 수 있는 API입니다. +웹 어플리케이션에서 일반 네이티브 어플리케이션과 같은 사용자 경험을 제공할 수 있습니다. -An example of showing a dialog to select multiple files and directories: +다음 예제는 파일과 디렉터리를 다중으로 선택하는 대화 상자를 표시하는 예제입니다: ```javascript -var win = ...; // window in which to show the dialog +var win = ...; // 대화 상자를 사용할 창 객체 var dialog = require('dialog'); console.log(dialog.showOpenDialog({ properties: [ 'openFile', 'openDirectory', 'multiSelections' ]})); ``` -**Note for OS X**: If you want to present dialogs as sheets, the only thing you have to do is provide a `BrowserWindow` reference in the `browserWindow` parameter. +**OS X 주의**: 대화 상자를 시트처럼 보여지게 하려면 `browserWindow` 인자에 `BrowserWindow` 객체의 참조를 제공하면 됩니다. ## dialog.showOpenDialog([browserWindow], [options], [callback]) @@ -20,16 +20,15 @@ console.log(dialog.showOpenDialog({ properties: [ 'openFile', 'openDirectory', ' * `title` String * `defaultPath` String * `filters` Array - * `properties` Array - Contains which features the dialog should use, can - contain `openFile`, `openDirectory`, `multiSelections` and - `createDirectory` + * `properties` Array - 대화 상자가 사용할 기능(모드)이 담긴 배열입니다. + 다음을 포함할 수 있습니다: `openFile`, `openDirectory`, `multiSelections`, `createDirectory` * `callback` Function -On success, returns an array of file paths chosen by the user, otherwise -returns `undefined`. +사용할 대화 상자의 기능이 담긴 배열입니다. 다음을 포함할 수 있습니다: `openFile`, `openDirectory`, `multiSelections`, `createDirectory` -The `filters` specifies an array of file types that can be displayed or -selected, an example is: +작업에 성공하면 유저가 선택한 파일의 경로를 포함한 배열을 반환합니다. 그 외의 경우엔 `undefined`를 반환합니다. + +`filters`를 지정하면 유저가 선택 가능한 파일 형식을 지정할 수 있습니다. 예제는 다음과 같습니다: ```javascript { @@ -41,12 +40,10 @@ selected, an example is: } ``` -If a `callback` is passed, the API call would be asynchronous and the result -would be passed via `callback(filenames)` +`callback`이 전달되면 메소드가 비동기로 작동되며 결과는 `callback(filenames)`을 통해 전달됩니다. -**Note:** On Windows and Linux, an open dialog can not be both a file selector -and a directory selector, so if you set `properties` to -`['openFile', 'openDirectory']` on these platforms, a directory selector will be shown. +Windows와 Linux에선 파일 선택 모드, 디렉터리 선택 모드를 동시에 사용할 수 없습니다. +그래서 이 두 플랫폼에선 `properties`를 `['openFile', 'openDirectory']`로 설정하면 디렉터리 선택 대화 상자가 표시됩니다. ## dialog.showSaveDialog([browserWindow], [options], [callback]) @@ -57,36 +54,41 @@ and a directory selector, so if you set `properties` to * `filters` Array * `callback` Function -On success, returns the path of the file chosen by the user, otherwise returns -`undefined`. +작업에 성공하면 -The `filters` specifies an array of file types that can be displayed, see -`dialog.showOpenDialog` for an example. +작업에 성공하면 유저가 선택한 파일의 경로를 포함한 배열을 반환합니다. 그 외의 경우엔 `undefined`를 반환합니다. -If a `callback` is passed, the API call will be asynchronous and the result -will be passed via `callback(filename)` +`filters`를 지정하면 유저가 저장 가능한 파일 형식을 지정할 수 있습니다. 사용 방법은 `dialog.showOpenDialog`의 `filters` 속성과 같습니다. + +`callback`이 전달되면 메소드가 비동기로 작동되며 결과는 `callback(filename)`을 통해 전달됩니다. ## dialog.showMessageBox([browserWindow], options, [callback]) * `browserWindow` BrowserWindow * `options` Object - * `type` String - Can be `"none"`, `"info"` or `"warning"` - * `buttons` Array - Array of texts for buttons - * `title` String - Title of the message box, some platforms will not show it - * `message` String - Content of the message box - * `detail` String - Extra information of the message + ** `type` String - `"none"`, `"info"`, `"error"`, `"question"`, `"warning"` 중 하나를 사용할 수 있습니다. + * `buttons` Array - 버튼들의 라벨을 포함한 배열입니다. + * `title` String - 메시지 상자의 제목입니다. 몇몇 플랫폼에선 보이지 않을 수 있습니다. + * `message` String - 메시지 상자의 본문 내용입니다. + * `detail` String - 메시지의 추가 정보입니다. * `icon` [NativeImage](native-image-ko.md) + * `cancelId` Integer - 유저가 대화 상자의 버튼을 클릭하지 않고 대화 상자를 취소했을 때 반환되는 버튼의 index입니다. + 기본적으로 버튼 리스트가 "cancel" 또는 "no" 라벨을 가지고 있을 때 해당 버튼의 index를 반환합니다. 따로 두 라벨이 지정되지 않은 경우 0을 반환합니다. + OS X와 Windows에선 `cancelId` 지정 여부에 상관없이 "Cancel" 버튼이 언제나 `cancelId`로 지정됩니다. * `callback` Function -Shows a message box, it will block until the message box is closed. It returns -the index of the clicked button. +메시지 상자를 표시합니다. `browserWindow`를 지정하면 메시지 상자가 완전히 닫힐 때까지는 창을 사용할 수 없습니다. +완료시 유저가 선택한 버튼의 index를 반환합니다. -If a `callback` is passed, the API call will be asynchronous and the result -will be passed via `callback(response)` +역주: 부정을 표현하는 "아니오", "취소"와 같은 한글 단어는 지원되지 않습니다. +만약 OS X 또는 Windows에서 "확인", "취소"와 같은 순서로 버튼을 지정하게 될 때 Alt + f4로 해당 대화 상자를 끄게 되면 "확인"을 누른걸로 판단되어 버립니다. +이를 해결하려면 "Cancel"을 대신 사용하거나 BrowserWindow API를 사용하여 메시지 상자를 직접 구현해야합니다. + +`callback`이 전달되면 메소드가 비동기로 작동되며 결과는 `callback(response)`을 통해 전달됩니다. ## dialog.showErrorBox(title, content) -Runs a modal dialog that shows an error message. +에러 메시지를 보여주는 모달 대화 상자를 표시합니다. -This API can be called safely before the `ready` event of `app` module emits, it -is usually used to report errors in early stage of startup. +이 API는 `app` 모듈의 `ready` 이벤트가 발생하기 전에 사용할 수 있습니다. +이 메소드는 보통 어플리케이션이 시작되기 전에 특정한 에러를 표시하기 위해 사용됩니다. diff --git a/docs/api/frameless-window-ko.md b/docs/api/frameless-window-ko.md index 8315f48ec8ee..420b277d9b17 100644 --- a/docs/api/frameless-window-ko.md +++ b/docs/api/frameless-window-ko.md @@ -1,20 +1,19 @@ -# Frameless window +# Frameless 윈도우 -frameless window는 테두리가 없는 윈도우 창을 말합니다. +Frameless 윈도우는 테두리가 없는 윈도우 창을 말합니다. -## Frameless window 만들기 +## Frameless 윈도우 만들기 -Frameless window를 만드려면 [BrowserWindow](browser-window-ko.md) 객체의 `options`에서 `frame` 옵션을 `false`로 지정하기만 하면됩니다: +Frameless 윈도우를 만드려면 [BrowserWindow](browser-window-ko.md) 객체의 `options`에서 `frame` 옵션을 `false`로 지정하기만 하면됩니다: ```javascript var BrowserWindow = require('browser-window'); var win = new BrowserWindow({ width: 800, height: 600, frame: false }); ``` -## 투명한 윈도우 +## 투명한 창 만들기 -By setting the `transparent` option to `true`, you can also make the frameless -window transparent: +Frameless 윈도우의 창의 배경을 투명하게 만들고 싶다면 `transparent` 옵션을 `true`로 바꿔주기만 하면됩니다: ```javascript var win = new BrowserWindow({ transparent: true, frame: false }); @@ -22,39 +21,32 @@ var win = new BrowserWindow({ transparent: true, frame: false }); ### API의 한계 -* You can not click through the transparent area, we are going to introduce an - API to set window shape to solve this, but currently blocked at an - [upstream bug](https://code.google.com/p/chromium/issues/detail?id=387234). -* Transparent window is not resizable, setting `resizable` to `true` may make - transparent window stop working on some platforms. -* The `blur` filter only applies to the web page, so there is no way to apply - blur effect to the content below the window. -* On Windows transparent window will not work when DWM is disabled. -* On Linux users have to put `--enable-transparent-visuals --disable-gpu` in - command line to disable GPU and allow ARGB to make transparent window, this is - caused by an upstream bug that [alpha channel doesn't work on some NVidia - drivers](https://code.google.com/p/chromium/issues/detail?id=369209) on Linux. -* On Mac the native window shadow will not show for transparent window. + + +* 투명한 영역을 통과하여 클릭할 수 없습니다. 우리는 이 문제를 해결하기 위해 API를 제공할 예정이지만 현재로써는 + [upstream 버그](https://code.google.com/p/chromium/issues/detail?id=387234)로 인해 중단된 상태입니다. +* 투명한 창은 크기를 조절할 수 없습니다. `resizable` 속성을 `true`로 할 경우 몇몇 플랫폼에선 윈도우 크래시가 일어납니다. +* `blur` 필터는 웹 페이지에서만 적용됩니다. 윈도우 아래 컨텐츠에는 블러 효과를 적용할 방법이 없습니다. +* Windows에선 DWM(데스크톱 창 관리자)가 비활성화되어 있을 경우 작동하지 않습니다. +* Linux를 사용할 경우 [alpha channel doesn't work on some NVidia drivers](https://code.google.com/p/chromium/issues/detail?id=369209) + upstream 버그가 있으므로 CLI 옵션에 `--enable-transparent-visuals --disable-gpu`을 추가해야 합니다. + 이 옵션은 GPU의 사용을 중단하고 윈도우를 생성하는데 ARGB를 사용할 수 있도록 해줍니다. +* OS X(Mac)에선 네이티브 윈도우의 그림자가 투명한 창에선 보이지 않습니다. ## 드래그 가능 위치 지정 -By default, the frameless window is non-draggable. Apps need to specify -`-webkit-app-region: drag` in CSS to tell Electron which regions are draggable -(like the OS's standard titlebar), and apps can also use -`-webkit-app-region: no-drag` to exclude the non-draggable area from the - draggable region. Note that only rectangular shape is currently supported. +기본적으로 Frameless 윈도우는 드래그 할 수 없습니다. +어플리케이션의 CSS에서 특정 범위를 `-webkit-app-region: drag`로 지정하면 OS의 기본 타이틀바 처럼 드래그 되도록 할 수 있습니다. +그리고 `-webkit-app-region: no-drag`를 지정해서 드래그 불가능 영역을 만들 수도 있습니다. 현재 사각형 형태의 범위만 지원합니다. -To make the whole window draggable, you can add `-webkit-app-region: drag` as -`body`'s style: +창 전체를 드래그 가능하게 만드려면 `-webkit-app-region: drag`을 `body`의 스타일에 지정하면 됩니다: ```html ``` -And note that if you have made the whole window draggable, you must also mark -buttons as non-draggable, otherwise it would be impossible for users to click on -them: +참고로 창 전체를 드래그 영역으로 지정할 경우 사용자가 버튼을 클릭할 수 없게 되므로 버튼은 드래그 불가능 영역으로 지정해야 합니다: ```css button { @@ -62,15 +54,13 @@ button { } ``` -If you're only using a custom titlebar, you also need to make buttons in -titlebar non-draggable. +또한 커스텀 타이틀바를 만들어 사용할 때 타이틀바 내부의 버튼도 드래그 불가능 영역으로 지정해야 합니다. ## 텍스트 선택 -One thing on frameless window is that the dragging behaviour may conflict with -selecting text, for example, when you drag the titlebar, you may accidentally -select the text on titlebar. To prevent this, you need to disable text -selection on dragging area like this: +한가지, Frameless 윈도우에서 텍스트가 선택되는 드래그 동작은 혼란을 야기할 수 있습니다. +예를 들어 타이틀바를 드래그 할 때 타이틀바의 텍스트를 실수로 선택할 수 있습니다. +이를 방지하기 위해선 다음과 같이 드래그 영역의 텍스트 선택 동작을 비활성화해야 할 필요가 있습니다: ```css .titlebar { @@ -81,7 +71,5 @@ selection on dragging area like this: ## 컨텍스트 메뉴 -On some platforms, the draggable area would be treated as non-client frame, so -when you right click on it a system menu would be popuped. To make context menu -behave correctly on all platforms, you should never custom context menu on -draggable areas. +몇몇 플랫폼에선 드래그 가능 영역이 non-client 프레임으로 처리됩니다. 그래서 이 영역에서 오른쪽 클릭을 할 경우 시스템 메뉴가 팝업 됩니다. +그래서 컨텍스트 메뉴 지정이 모든 플랫폼에서 정상적으로 작동하게 하려면 커스텀 컨텍스트 메뉴를 드래그 영역 내에 만들어선 안됩니다. diff --git a/docs/api/menu-ko.md b/docs/api/menu-ko.md index 3ac62012f675..234aad4afeee 100644 --- a/docs/api/menu-ko.md +++ b/docs/api/menu-ko.md @@ -1,12 +1,10 @@ # menu -The `Menu` class is used to create native menus that can be used as -application menus and context menus. Each menu consists of multiple menu -items, and each menu item can have a submenu. +`Menu` 클래스는 어플리케이션 메뉴와 컨텍스트 메뉴를 만들 때 사용할 수 있습니다. +각 메뉴는 여러 개의 메뉴 아이템으로 구성되어 있으며 서브 메뉴를 가질 수도 있습니다. -Below is an example of creating a menu dynamically in a web page by using -the [remote](remote-ko.md) module, and showing it when the user right clicks -the page: +다음 예제는 웹 페이지 내에서 [remote](remote-ko.md) 모듈을 활용하여 동적으로 메뉴를 생성하는 예제입니다. +그리고 이 예제에서 만들어진 메뉴는 유저가 페이지에서 오른쪽 클릭을 할 때 마우스 위치에 팝업으로 표시됩니다: ```html @@ -27,7 +25,7 @@ window.addEventListener('contextmenu', function (e) { ``` -Another example of creating the application menu with the simple template API: +다음 예제는 template API를 활용하여 어플리케이션 메뉴를 만드는 간단한 예제입니다: ```html @@ -167,34 +165,30 @@ Menu.setApplicationMenu(menu); ### new Menu() -Creates a new menu. +새로운 메뉴를 생성합니다. ### Class Method: Menu.setApplicationMenu(menu) * `menu` Menu -Sets `menu` as the application menu on OS X. On Windows and Linux, the `menu` -will be set as each window's top menu. +지정한 `menu`를 이용하여 어플리케이션 메뉴를 만듭니다. OS X에선 상단바에 표시되며 Windows와 Linux에선 각 창의 상단에 표시됩니다. ### Class Method: Menu.sendActionToFirstResponder(action) * `action` String -Sends the `action` to the first responder of application, this is used for -emulating default Cocoa menu behaviors, usually you would just use the -`selector` property of `MenuItem`. +`action`을 어플리케이션의 first responder에 전달합니다. +이 함수는 Cocoa 메뉴 동작을 에뮬레이트 하는데 사용되며 보통 `MenuItem`의 `selector` 속성에 사용됩니다. -**Note:** This method is OS X only. +**알림:** 이 함수는 OS X에서만 사용할 수 있습니다. ### Class Method: Menu.buildFromTemplate(template) * `template` Array -Generally, the `template` is just an array of `options` for constructing -[MenuItem](menu-item-ko.md), the usage can be referenced above. +기본적으로 `template`는 [MenuItem](menu-item-ko.md)을 생성할 때 사용하는 `options`의 배열입니다. 사용법은 위에서 설명한 것과 같습니다. -You can also attach other fields to element of the `template`, and they will -become properties of the constructed menu items. +또한 `template`에는 다른 속성도 추가할 수 있으며 메뉴가 만들어질 때 해당 메뉴 아이템의 프로퍼티로 변환됩니다. ### Menu.popup(browserWindow, [x, y]) @@ -202,86 +196,70 @@ become properties of the constructed menu items. * `x` Number * `y` Number -Popups this menu as a context menu in the `browserWindow`. You can optionally -provide a `(x,y)` coordinate to place the menu at, otherwise it will be placed -at the current mouse cursor position. +메뉴를 `browserWindow` 안에서 팝업으로 표시합니다. +옵션으로 메뉴를 표시할 `(x,y)` 좌표를 임의로 지정할 수 있습니다. 따로 지정하지 않은 경우 마우스 커서 위치에 표시됩니다. ### Menu.append(menuItem) * `menuItem` MenuItem -Appends the `menuItem` to the menu. +메뉴의 리스트 끝에 `menuItem`을 삽입합니다. ### Menu.insert(pos, menuItem) * `pos` Integer * `menuItem` MenuItem -Inserts the `menuItem` to the `pos` position of the menu. +`pos` 위치에 `menuItem`을 삽입합니다. ### Menu.items -Get the array containing the menu's items. +메뉴가 가지고 있는 메뉴 아이템들의 배열입니다. -## Notes on OS X application menu +## OS X 어플리케이션 메뉴에 대해 알아 둬야 할 것들 -OS X has a completely different style of application menu from Windows and -Linux, and here are some notes on making your app's menu more native-like. +OS X에선 Windows, Linux와 달리 완전히 다른 어플리케이션 메뉴 스타일을 가지고 있습니다. +어플리케이션을 네이티브처럼 작동할 수 있도록 하기 위해선 다음의 몇 가지 유의 사항을 숙지해야 합니다. -### Standard menus +### 기본 메뉴 -On OS X there are many system defined standard menus, like the `Services` and -`Windows` menus. To make your menu a standard menu, you can just set your menu's -label to one of followings, and Electron will recognize them and make them -become standard menus: +OS X엔 `Services`나 `Windows`와 같은 많은 시스템 지정 기본 메뉴가 있습니다. +기본 메뉴를 만들려면 다음 중 하나를 메뉴의 라벨로 지정하기만 하면 됩니다. +그러면 Electron이 자동으로 인식하여 해당 메뉴를 기본 메뉴로 만듭니다: * `Window` * `Help` * `Services` -### Standard menu item actions +### 기본 메뉴 아이템 동작 -OS X has provided standard actions for some menu items (which are called -`selector`s), like `About xxx`, `Hide xxx`, and `Hide Others`. To set the action -of a menu item to a standard action, you can set the `selector` attribute of the -menu item. +OS X는 몇몇의 메뉴 아이템에 대해 `About xxx`, `Hide xxx`, `Hide Others`와 같은 기본 동작을 제공하고 있습니다. (`selector`라고 불립니다) +메뉴 아이템의 기본 동작을 지정하려면 메뉴 아이템의 `selector` 속성을 사용하면 됩니다. -### Main menu's name +### 메인 메뉴의 이름 -On OS X the label of application menu's first item is always your app's name, -no matter what label you set. To change it you have to change your app's name -by modifying your app bundle's `Info.plist` file. See -[About Information Property List Files](https://developer.apple.com/library/ios/documentation/general/Reference/InfoPlistKeyReference/Articles/AboutInformationPropertyListFiles.html) -for more. +OS X에선 지정한 어플리케이션 메뉴에 상관없이 메뉴의 첫번째 라벨은 언제나 어플리케이션의 이름이 됩니다. +어플리케이션 이름을 변경하려면 앱 번들내의 `Info.plist` 파일을 수정해야합니다. +자세한 내용은 [About Information Property List Files](https://developer.apple.com/library/ios/documentation/general/Reference/InfoPlistKeyReference/Articles/AboutInformationPropertyListFiles.html)을 참고하세요. +## 메뉴 아이템 위치 -## Menu item position +`Menu.buildFromTemplate`로 메뉴를 만들 때 `position`과 `id`를 사용해서 아이템의 위치를 지정할 수 있습니다. -You can make use of `position` and `id` to control how the item would be placed -when building a menu with `Menu.buildFromTemplate`. +`MenuItem`의 `position` 속성은 `[placement]=[id]`와 같은 형식을 가지며 `placement`는 +`before`, `after`, `endof` 속성 중 한가지를 사용할 수 있고 `id`는 메뉴 아이템이 가지는 유일 ID 입니다: -The `position` attribute of `MenuItem` has the form `[placement]=[id]` where -placement is one of `before`, `after`, or `endof` and `id` is the unique ID of -an existing item in the menu: +* `before` - 이 아이템을 지정한 id 이전의 위치에 삽입합니다. 만약 참조된 아이템이 없을 경우 메뉴의 맨 뒤에 삽입됩니다. +* `after` - 이 아이템을 지정한 id 다음의 위치에 삽입합니다. 만약 참조된 아이템이 없을 경우 메뉴의 맨 뒤에 삽입됩니다. +* `endof` - 이 아이템을 id의 논리 그룹에 맞춰서 각 그룹의 항목 뒤에 삽입합니다. (그룹은 분리자 아이템에 의해 만들어집니다) + 만약 참조된 아이템의 분리자 그룹이 존재하지 않을 경우 지정된 id로 새로운 분리자 그룹을 만든 후 해당 그룹의 뒤에 삽입됩니다. -* `before` - Inserts this item before the id referenced item. If the - referenced item doesn't exist the item will be inserted at the end of - the menu. -* `after` - Inserts this item after id referenced item. If the referenced - item doesn't exist the item will be inserted at the end of the menu. -* `endof` - Inserts this item at the end of the logical group containing - the id referenced item. (Groups are created by separator items). If - the referenced item doesn't exist a new separator group is created with - the given id and this item is inserted after that separator. +위치를 지정한 아이템의 뒤에 위치가 지정되지 않은 아이템이 있을 경우 해당 아이템의 위치가 지정되기 전까지 이전에 위치가 지정된 아이템의 위치 지정을 따릅니다. +이에 따라 위치를 이동하고 싶은 특정 그룹의 아이템들이 있을 경우 해당 그룹의 맨 첫번째 메뉴 아이템의 위치만을 지정하면 됩니다. -When an item is positioned following unpositioned items are inserted after -it, until a new item is positioned. So if you want to position a group of -menu items in the same location you only need to specify a position for -the first item. +### 예제 -### Examples - -Template: +메뉴 템플릿: ```javascript [ @@ -293,7 +271,7 @@ Template: ] ``` -Menu: +메뉴: ``` - 1 @@ -303,7 +281,7 @@ Menu: - 5 ``` -Template: +메뉴 템플릿: ```javascript [ @@ -316,7 +294,7 @@ Template: ] ``` -Menu: +메뉴: ``` - --- diff --git a/docs/api/protocol-ko.md b/docs/api/protocol-ko.md index 26fc4eb740c4..20243ab95824 100644 --- a/docs/api/protocol-ko.md +++ b/docs/api/protocol-ko.md @@ -19,18 +19,20 @@ app.on('ready', function() { **알림:** 이 모듈은 app의 `ready` 이벤트가 발생한 이후에만 사용할 수 있습니다. -## protocol.registerProtocol(scheme, handler) +## protocol.registerProtocol(scheme, handler, callback) * `scheme` String * `handler` Function +* `callback` Function -지정한 `scheme`을 기반으로 커스텀 프로토콜을 등록합니다. 등록한 `scheme` 프로토콜에 요청이 들어올 경우 `request` 인자와 함께 `handler` 함수가 호출됩니다. +지정한 `scheme`을 기반으로 커스텀 프로토콜을 등록합니다. `handler`는 등록한 `scheme` 프로토콜에 요청이 들어올 경우 `request` 인자와 함께 `handler(request)` 형식으로 호출됩니다. -호출된 `handler` 함수에선 요청에 대한 해당 프로토콜의 작업 결과를 응답(반환) 해야 할 필요가 있습니다. +`handler` 함수에선 요청에 대한 해당 프로토콜의 작업 결과를 응답(반환) 해야 합니다. -## protocol.unregisterProtocol(scheme) +## protocol.unregisterProtocol(scheme, callback) * `scheme` String +* `callback` Function 지정한 `scheme` 프로토콜을 등록 해제합니다. @@ -40,23 +42,27 @@ app.on('ready', function() { 지정한 `value` 배열을 사용하여 미리 지정된 스킴으로 등록합니다. -## protocol.isHandledProtocol(scheme) +## protocol.isHandledProtocol(scheme, callback) * `scheme` String +* `callback` Function 해당 `scheme`에 처리자(handler)가 등록되었는지 확인합니다. +지정한 `callback`에 결과가 boolean 값으로 반환됩니다. -## protocol.interceptProtocol(scheme, handler) +## protocol.interceptProtocol(scheme, handler, callback) * `scheme` String * `handler` Function +* `callback` Function 지정한 `scheme`의 작업을 `handler`로 변경합니다. `handler`에서 `null` 또는 `undefined`를 반환 할 경우 해당 프로토콜의 기본 동작(응답)으로 대체 됩니다. -## protocol.uninterceptProtocol(scheme) +## protocol.uninterceptProtocol(scheme, callback) * `scheme` String +* `callback` Function 변경된 프로토콜의 작업을 해제합니다. diff --git a/docs/api/remote-ko.md b/docs/api/remote-ko.md index 0feb53ece5ee..11d62dd27194 100644 --- a/docs/api/remote-ko.md +++ b/docs/api/remote-ko.md @@ -1,7 +1,6 @@ # remote -The `remote` module provides a simple way to do inter-process communication -between the renderer process and the main process. +`remote` 모듈은 메인 프로세스와 랜더러 프로세스 사이에 inter-process 통신을 하기 위한 가장 간단한 방법입니다. In Electron, only GUI-unrelated modules are available in the renderer process. Without the `remote` module, users who wanted to call a main process API in diff --git a/docs/api/screen-ko.md b/docs/api/screen-ko.md index c554863586cc..6b508991e4f7 100644 --- a/docs/api/screen-ko.md +++ b/docs/api/screen-ko.md @@ -1,13 +1,14 @@ # screen -Gets various info about screen size, displays, cursor position, etc. You should -not use this module until the `ready` event of `app` module gets emitted. +`screen` 모듈은 화면 크기, 디스플레이, 커서 위치 등등의 다양한 정보를 가져옵니다. +이 모듈은 `app` 모듈의 `ready` 이벤트가 발생하기 전까지 사용할 수 없습니다. -`screen` is an [EventEmitter](http://nodejs.org/api/events.html#events_class_events_eventemitter). +`screen`은 [EventEmitter](http://nodejs.org/api/events.html#events_class_events_eventemitter)를 상속 받았습니다. -Make sure to note that in the renderer / DevTools, `window.screen` is a reserved DOM property, so writing `screen = require('screen')` won't work. In our examples below, we use `atomScreen` as the variable name instead. +한가지 주의할 점은 랜더러 / DevTools에선 이 모듈의 이름인 `screen`은 이미 DOM 속성에 `window.screen`로 존재 하므로 `screen = require('screen')`를 +사용할 수 없습니다. 밑의 예제와 같이 `atomScreen`등의 이름으로 변수 이름을 대체하여 사용해야 합니다. -An example of creating a window that fills the whole screen: +다음 예제는 화면 전체를 채우는 윈도우 창을 생성합니다: ```javascript var app = require('app'); @@ -22,7 +23,7 @@ app.on('ready', function() { }); ``` -Another example of creating a window in the external display: +다음 예제는 확장 디스플레이에 윈도우를 생성합니다: ```javascript var app = require('app'); @@ -55,14 +56,14 @@ app.on('ready', function() { * `event` Event * `newDisplay` Object -Emitted when `newDisplay` has been added. +새로운 디스플레이가 추가되면 발생합니다. ## Event: display-removed * `event` Event * `oldDisplay` Object -Emitted when `oldDisplay` has been removed. +기존의 디스플레이가 제거되면 발생합니다. ## Event: display-metrics-changed @@ -70,21 +71,21 @@ Emitted when `oldDisplay` has been removed. * `display` Object * `changedMetrics` Array -Emitted when a `display` has one or more metrics changed, `changedMetrics` is -an array of strings that describe the changes. Possible changes are `bounds`, -`workArea`, `scaleFactor` and `rotation`. +`display`의 하나 또는 다수의 매트릭스가 변경될 경우 발생합니다. +`changedMetrics`는 변경에 대한 정보를 담은 문자열의 배열입니다. +`bounds`, `workArea`, `scaleFactor`, `rotation`등이 변경될 수 있습니다. ## screen.getCursorScreenPoint() -Returns the current absolute position of the mouse pointer. +현재 마우스 포인터의 절대 위치를 반환합니다. ## screen.getPrimaryDisplay() -Returns the primary display. +기본 디스플레이를 반환합니다. ## screen.getAllDisplays() -Returns an array of displays that are currently available. +사용 가능한 모든 디스플레이를 배열로 반환합니다. ## screen.getDisplayNearestPoint(point) @@ -92,7 +93,7 @@ Returns an array of displays that are currently available. * `x` Integer * `y` Integer -Returns the display nearest the specified point. +지정한 좌표에 가까운 디스플레이를 반환합니다. ## screen.getDisplayMatching(rect) @@ -102,4 +103,4 @@ Returns the display nearest the specified point. * `width` Integer * `height` Integer -Returns the display that most closely intersects the provided bounds. +지정한 범위에 가장 가깝게 교차한 디스플레이를 반환합니다. diff --git a/docs/api/shell-ko.md b/docs/api/shell-ko.md index 5811afdcb930..d9ceea106a54 100644 --- a/docs/api/shell-ko.md +++ b/docs/api/shell-ko.md @@ -26,7 +26,7 @@ shell.openExternal('https://github.com'); * `url` String 제공된 외부 프로토콜 URL을 기반으로 데스크톱의 기본 프로그램으로 엽니다. (예를 들어 mailto: URL은 해당 URL을 기본 메일 에이전트로 엽니다.) -역자주: 폴더는 'file:\\\\C:\\'와 같이 지정하여 열 수 있습니다. (`\\`로 경로를 표현한 이유는 Escape 문자열을 참고하세요.) +역주: 폴더는 'file:\\\\C:\\'와 같이 지정하여 열 수 있습니다. (`\\`로 경로를 표현한 이유는 Escape 문자열을 참고하세요.) ## shell.moveItemToTrash(fullPath) diff --git a/docs/development/build-instructions-linux-ko.md b/docs/development/build-instructions-linux-ko.md index ec955f3439a7..3d7f9389f77b 100644 --- a/docs/development/build-instructions-linux-ko.md +++ b/docs/development/build-instructions-linux-ko.md @@ -89,7 +89,16 @@ $ ./script/clean.py ## 문제 해결 -개발 종속성 라이브러리들을 제대로 설치했는지 확인하세요. +개발 종속성 라이브러리들을 제대로 설치했는지 확인하세요. + +## libtinfo.so.5 동적 링크 라이브러리를 로드하는 도중 에러가 발생할 경우 + +미리 빌드된 `clang`은 `libtinfo.so.5`로 링크를 시도합니다. +플랫폼에 따라 적당한 `libncurses` symlink를 추가하세요. + +```bash +$ sudo ln -s /usr/lib/libncurses.so.5 /usr/lib/libtinfo.so.5 +``` ## 테스트 diff --git a/docs/development/build-system-overview-ko.md b/docs/development/build-system-overview-ko.md index 92fd50008529..7198fa831b92 100644 --- a/docs/development/build-system-overview-ko.md +++ b/docs/development/build-system-overview-ko.md @@ -25,9 +25,14 @@ Electron도 상당히 비슷한 접근을 했습니다: ## 부트스트랩 최소화 -모든 사전 빌드 된 Chromium 바이너리들은 부트스트랩 스크립트가 실행될 때 다운로드됩니다. +Prebuilt된 모든 Chromium 바이너리들은 부트스트랩 스크립트가 실행될 때 다운로드됩니다. 기본적으로 공유 라이브러리와 정적 라이브러리 모두 다운로드되며 최종 전체 파일 크기는 플랫폼에 따라 800MB에서 2GB까지 차지합니다. +기본적으로 libchromiumcontent는 Amazon Web Service를 통해 다운로드 됩니다. +만약 `LIBCHROMIUMCONTENT_MIRROR` 환경 변수가 설정되어 있으면 부트스트랩은 해당 링크를 사용하여 바이너리를 다운로드 합니다. +[libchromiumcontent-qiniu-mirror](https://github.com/hokein/libchromiumcontent-qiniu-mirror)는 libchromiumcontent의 미러입니다. +만약 AWS에 접근할 수 없다면 `export LIBCHROMIUMCONTENT_MIRROR=http://7xk3d2.dl1.z0.glb.clouddn.com/`를 통해 다운로드 할 수 있습니다. + 만약 빠르게 Electron의 개발 또는 테스트만 하고 싶다면 `--dev` 플래그를 추가하여 공유 라이브러리만 다운로드할 수 있습니다: ```bash diff --git a/docs/tutorial/application-distribution-ko.md b/docs/tutorial/application-distribution-ko.md index a1bb5bc65044..0b6ff631ad70 100644 --- a/docs/tutorial/application-distribution-ko.md +++ b/docs/tutorial/application-distribution-ko.md @@ -99,7 +99,7 @@ MyApp.app/Contents 실행파일 `electron`의 이름을 원하는 대로 바꿀 수 있습니다. 리눅스 어플리케이션의 아이콘은 [.desktop](https://developer.gnome.org/integration-guide/stable/desktop-files.html.en) 파일을 사용하여 지정할 수 있습니다. -### 역자주-자동화 +### 역주-자동화 배포시에 Electron의 리소스를 일일이 수정하는 것은 매우 귀찮고 복잡합니다. 하지만 이 작업을 자동화 시킬 수 있는 몇가지 방법이 있습니다: diff --git a/docs/tutorial/quick-start-ko.md b/docs/tutorial/quick-start-ko.md index e5ef8662cd7a..a49b7e017609 100644 --- a/docs/tutorial/quick-start-ko.md +++ b/docs/tutorial/quick-start-ko.md @@ -75,6 +75,8 @@ var mainWindow = null; // 모든 창이 닫히면 어플리케이션 종료. app.on('window-all-closed', function() { + // OSX의 대부분의 어플리케이션에선 유저가 Cmd + Q 커맨드로 확실하게 종료하기 전까지는 + // 어플리케이션이 메뉴바에 남아 계속 실행됩니다. if (process.platform != 'darwin') { app.quit(); } @@ -112,16 +114,16 @@ app.on('ready', function() {

헬로 월드!

- 우리는 io.js 버전과 - Electron 버전을 사용합니다. + 이 어플리케이션은 io.js 과 + Electron 을 사용합니다. ``` ## 앱 실행하기 -앱을 작성한 후 [어플리케이션 배포](./application-distribution-ko.md) 가이드를 따라 앱을 패키징 하고 -패키징한 앱을 실행해 볼 수 있습니다. 또한 Electron 실행파일을 다운로드 받아 바로 실행해 볼 수도 있습니다. +앱을 작성한 후 [어플리케이션 배포](./application-distribution-ko.md) 가이드를 따라 앱을 패키징 하고 패키징한 앱을 실행할 수 있습니다. +또는 Electron 실행파일을 다운로드 받아 바로 실행해 볼 수도 있습니다. Windows의 경우: diff --git a/docs/tutorial/using-native-node-modules-ko.md b/docs/tutorial/using-native-node-modules-ko.md index da68c475ba83..1e67ee25305d 100644 --- a/docs/tutorial/using-native-node-modules-ko.md +++ b/docs/tutorial/using-native-node-modules-ko.md @@ -1,6 +1,6 @@ # 네이티브 node 모듈 사용하기 -__역자주: 현재 Electron은 node.js대신 io.js를 사용합니다. 문서에 기재된 버전과 다를 수 있습니다__ +__역주: 현재 Electron은 node.js대신 io.js를 사용합니다. 문서에 기재된 버전과 다를 수 있습니다__ Electron에선 node.js 네이티브 모듈이 지원됩니다. 하지만 Electron은 공식 node.js의 V8 엔진과는 달리 다른 V8 버전을 사용합니다. 그런 이유로 네이티브 모듈을 사용하기 위해선 Electron의 V8 버전에 맞춰 네이티브 모듈을 다시 빌드하고 헤더를 변경해야 합니다. @@ -34,11 +34,11 @@ Node 모듈을 `node-gyp`를 사용하여 Electron을 타겟으로 빌드할 땐 ```bash $ cd /path-to-module/ -$ HOME=~/.electron-gyp node-gyp rebuild --target=0.25.0 --arch=ia64 --dist-url=https://atom.io/download/atom-shell +$ HOME=~/.electron-gyp node-gyp rebuild --target=0.29.1 --arch=x64 --dist-url=https://atom.io/download/atom-shell ``` -`HOME=~/.electron-gyp`은 변경할 헤더의 위치를 찾습니다. `--target=0.25.0`은 Electron의 버전입니다. -`--dist-url=...`은 헤더를 다운로드 하는 주소입니다. `--arch=ia64`는 64비트 시스템을 타겟으로 빌드 한다는 것을 `node-gyp`에게 알려줍니다. +`HOME=~/.electron-gyp`은 변경할 헤더의 위치를 찾습니다. `--target=0.29.1`은 Electron의 버전입니다. +`--dist-url=...`은 헤더를 다운로드 하는 주소입니다. `--arch=x64`는 64비트 시스템을 타겟으로 빌드 한다는 것을 `node-gyp`에게 알려줍니다. ### npm을 이용한 방법 @@ -47,7 +47,7 @@ $ HOME=~/.electron-gyp node-gyp rebuild --target=0.25.0 --arch=ia64 --dist-url=h ```bash export npm_config_disturl=https://atom.io/download/atom-shell -export npm_config_target=0.25.0 +export npm_config_target=0.29.1 export npm_config_arch=x64 HOME=~/.electron-gyp npm install module-name ``` From 0dfcc7a9b38663c2aab72122cbbde159345d85f2 Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Sun, 12 Jul 2015 14:54:55 +0900 Subject: [PATCH 0615/1293] Update changes as upstream --- docs/README-ko.md | 2 +- docs/api/global-shortcut-ko.md | 28 +++++++++++++++++----------- 2 files changed, 18 insertions(+), 12 deletions(-) diff --git a/docs/README-ko.md b/docs/README-ko.md index 6e0daa59fd2b..135d6b5c657f 100644 --- a/docs/README-ko.md +++ b/docs/README-ko.md @@ -69,4 +69,4 @@ 이 참조문서는 [@preco21](https://github.com/preco21)에 의해 번역되었습니다. 문서내에서 오타나 잘못된 번역을 발견하면 `plusb21@gmail.com` 이메일로 알려주시면 감사하겠습니다. -원본과는 달리 항시 최신버전을 유지할 수 없으므로 원본을 같이 참고하는 것을 권장합니다. +문서는 항시 최신버전을 유지할 수 없으므로 원본을 같이 참고하는 것을 권장합니다. diff --git a/docs/api/global-shortcut-ko.md b/docs/api/global-shortcut-ko.md index 6626882368bc..a69dd4ee4ce4 100644 --- a/docs/api/global-shortcut-ko.md +++ b/docs/api/global-shortcut-ko.md @@ -2,25 +2,31 @@ `global-shortcut` 모듈은 사용자가 다양한 단축키 작업을 정의 할 수 있도록 운영체제의 전역 키보드 단축키를 설정 등록/해제 하는 방법을 제공합니다. 참고로 설정된 단축키는 어플리케이션이 백그라운드로 작동(창이 포커스 되지 않음) 할 때도 여전히 계속 작동합니다. +이 모듈은 `app` 모듈의 `ready` 이밴트 이전에 사용할 수 없습니다. ```javascript +var app = require('app'); var globalShortcut = require('global-shortcut'); -// 'ctrl+x' 단축키를 리스너에 등록합니다. -var ret = globalShortcut.register('ctrl+x', function() { console.log('ctrl+x is pressed'); }) +app.on('ready', function() { + // 'ctrl+x' 단축키를 리스너에 등록합니다. + var ret = globalShortcut.register('ctrl+x', function() { console.log('ctrl+x is pressed'); }) -if (!ret) { - console.log('registration failed'); -} + if (!ret) { + console.log('registration failed'); + } -// 단축키가 등록되었는지 확인합니다. -console.log(globalShortcut.isRegistered('ctrl+x')); + // 단축키가 등록되었는지 확인합니다. + console.log(globalShortcut.isRegistered('ctrl+x')); +}); -// 단축키의 등록을 해제합니다. -globalShortcut.unregister('ctrl+x'); +app.on('will-quit', function() { + // 단축키의 등록을 해제합니다. + globalShortcut.unregister('ctrl+x'); -// 모든 단축키의 등록을 해제합니다. -globalShortcut.unregisterAll(); + // 모든 단축키의 등록을 해제합니다. + globalShortcut.unregisterAll(); +}); ``` ## globalShortcut.register(accelerator, callback) From 26163e581249e0b1e48ea98a8e868497279566b8 Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Wed, 15 Jul 2015 08:07:09 +0900 Subject: [PATCH 0616/1293] Prepare update forked repo --- docs/api/content-tracing-ko.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/api/content-tracing-ko.md b/docs/api/content-tracing-ko.md index e9fa3158a2fb..a66a4635bdbd 100644 --- a/docs/api/content-tracing-ko.md +++ b/docs/api/content-tracing-ko.md @@ -20,6 +20,8 @@ tracing.startRecording('*', tracing.DEFAULT_OPTIONS, function() { * `callback` Function +카테고리 그룹 set을 가져옵니다. 카테고리 그룹은 도달 대상이 되는 코드 경로를 변경할 수 있습니다. + Get a set of category groups. The category groups can change as new code paths are reached. From b52491400877b87525b1bd29356cddd0bf8739c3 Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Wed, 15 Jul 2015 08:30:02 +0900 Subject: [PATCH 0617/1293] Update as upstream --- docs/api/browser-window-ko.md | 52 ++++++++++++++----- docs/api/chrome-command-line-switches-ko.md | 4 ++ docs/api/global-shortcut-ko.md | 22 ++++---- docs/api/protocol-ko.md | 3 ++ .../build-instructions-linux-ko.md | 9 +++- 5 files changed, 65 insertions(+), 25 deletions(-) diff --git a/docs/api/browser-window-ko.md b/docs/api/browser-window-ko.md index 38b78459d25a..29a07661409d 100644 --- a/docs/api/browser-window-ko.md +++ b/docs/api/browser-window-ko.md @@ -16,7 +16,7 @@ win.show(); ``` You can also create a window without chrome by using -[Frameless Window](frameless-window-ko.md) API. +[Frameless Window](frameless-window.md) API. ## Class: BrowserWindow @@ -48,11 +48,11 @@ You can also create a window without chrome by using zoom percent / 100, so `3.0` represents `300%` * `kiosk` Boolean - The kiosk mode * `title` String - Default window title - * `icon` [NativeImage](native-image-ko.md) - The window icon, when omitted on + * `icon` [NativeImage](native-image.md) - The window icon, when omitted on Windows the executable's icon would be used as window icon * `show` Boolean - Whether window should be shown when created * `frame` Boolean - Specify `false` to create a - [Frameless Window](frameless-window-ko.md) + [Frameless Window](frameless-window.md) * `node-integration` Boolean - Whether node integration is enabled, default is `true` * `accept-first-mouse` Boolean - Whether the web view accepts a single @@ -68,7 +68,7 @@ You can also create a window without chrome by using scripts run in the window. This script will always have access to node APIs no matter whether node integration is turned on for the window, and the path of `preload` script has to be absolute path. - * `transparent` Boolean - Makes the window [transparent](frameless-window-ko.md) + * `transparent` Boolean - Makes the window [transparent](frameless-window.md) * `type` String - Specifies the type of the window, possible types are `desktop`, `dock`, `toolbar`, `splash`, `notification`. This only works on Linux. @@ -566,11 +566,11 @@ Opens the developer tools for the service worker context present in the web cont Captures the snapshot of page within `rect`, upon completion `callback` would be called with `callback(image)`, the `image` is an instance of -[NativeImage](native-image-ko.md) that stores data of the snapshot. Omitting the +[NativeImage](native-image.md) that stores data of the snapshot. Omitting the `rect` would capture the whole visible page. **Note:** Be sure to read documents on remote buffer in -[remote](remote-ko.md) if you are going to use this API in renderer +[remote](remote.md) if you are going to use this API in renderer process. ### BrowserWindow.print([options]) @@ -613,7 +613,7 @@ it will assume `app.getName().desktop`. ### BrowserWindow.setOverlayIcon(overlay, description) -* `overlay` [NativeImage](native-image-ko.md) - the icon to display on the bottom +* `overlay` [NativeImage](native-image.md) - the icon to display on the bottom right corner of the taskbar icon. If this parameter is `null`, the overlay is cleared * `description` String - a description that will be provided to Accessibility @@ -784,6 +784,10 @@ Emitted when a plugin process is crashed. Emitted when the WebContents is destroyed. +### WebContents.session + +Returns the `Session` object used by this WebContents. + ### WebContents.loadUrl(url, [options]) * `url` URL @@ -1055,7 +1059,9 @@ app.on('ready', function() { 2. There is no way to send synchronous messages from the main process to a renderer process, because it would be very easy to cause dead locks. -## Class: WebContents.session.cookies +## Class: Session + +### Session.cookies The `cookies` gives you ability to query and modify cookies, an example is: @@ -1091,7 +1097,7 @@ win.webContents.on('did-finish-load', function() { }); ``` -### WebContents.session.cookies.get(details, callback) +### Session.cookies.get(details, callback) * `details` Object * `url` String - Retrieves cookies which are associated with `url`. @@ -1113,12 +1119,12 @@ win.webContents.on('did-finish-load', function() { * `secure` Boolean - Whether the cookie is marked as Secure (typically HTTPS) * `http_only` Boolean - Whether the cookie is marked as HttpOnly * `session` Boolean - Whether the cookie is a session cookie or a persistent - cookie with an expiration date. + cookie with an expiration date. * `expirationDate` Double - (Option) The expiration date of the cookie as - the number of seconds since the UNIX epoch. Not provided for session cookies. + the number of seconds since the UNIX epoch. Not provided for session cookies. -### WebContents.session.cookies.set(details, callback) +### Session.cookies.set(details, callback) * `details` Object * `url` String - Retrieves cookies which are associated with `url` @@ -1134,10 +1140,30 @@ win.webContents.on('did-finish-load', function() { * `callback` Function - function(error) * `error` Error -### WebContents.session.cookies.remove(details, callback) +### Session.cookies.remove(details, callback) * `details` Object * `url` String - The URL associated with the cookie * `name` String - The name of cookie to remove * `callback` Function - function(error) * `error` Error + +### Session.clearCache(callback) + +* `callback` Function - Called when operation is done + +Clears the session's HTTP cache. + +### Session.clearStorageData([options, ]callback) + +* `options` Object + * `origin` String - Should follow `window.location.origin`'s representation + `scheme://host:port` + * `storages` Array - The types of storages to clear, can contain: + `appcache`, `cookies`, `filesystem`, `indexdb`, `localstorage`, + `shadercache`, `websql`, `serviceworkers` + * `quotas` Array - The types of quotas to clear, can contain: + `temporary`, `persistent`, `syncable` +* `callback` Function - Called when operation is done + +Clears the data of web storages. diff --git a/docs/api/chrome-command-line-switches-ko.md b/docs/api/chrome-command-line-switches-ko.md index ed8cf55e06ec..7d1a7011eff6 100644 --- a/docs/api/chrome-command-line-switches-ko.md +++ b/docs/api/chrome-command-line-switches-ko.md @@ -34,6 +34,10 @@ HTTP 요청 캐시를 비활성화 합니다. 시스템 설정의 프록시 서버를 무시하고 지정한 서버로 연결합니다. HTTP와 HTTPS 요청에만 적용됩니다. +## --proxy-pac-url=`url` + +지정한 `url`의 PAC 스크립트를 사용합니다. + ## --no-proxy-server 프록시 서버를 사용하지 않습니다. 다른 프록시 서버 플래그 및 설정을 무시하고 언제나 직접 연결을 사용합니다. diff --git a/docs/api/global-shortcut-ko.md b/docs/api/global-shortcut-ko.md index a69dd4ee4ce4..6ad3fb5109fc 100644 --- a/docs/api/global-shortcut-ko.md +++ b/docs/api/global-shortcut-ko.md @@ -9,23 +9,23 @@ var app = require('app'); var globalShortcut = require('global-shortcut'); app.on('ready', function() { - // 'ctrl+x' 단축키를 리스너에 등록합니다. - var ret = globalShortcut.register('ctrl+x', function() { console.log('ctrl+x is pressed'); }) + // 'ctrl+x' 단축키를 리스너에 등록합니다. + var ret = globalShortcut.register('ctrl+x', function() { console.log('ctrl+x is pressed'); }) - if (!ret) { - console.log('registration failed'); - } + if (!ret) { + console.log('registration failed'); + } - // 단축키가 등록되었는지 확인합니다. - console.log(globalShortcut.isRegistered('ctrl+x')); + // 단축키가 등록되었는지 확인합니다. + console.log(globalShortcut.isRegistered('ctrl+x')); }); app.on('will-quit', function() { - // 단축키의 등록을 해제합니다. - globalShortcut.unregister('ctrl+x'); + // 단축키의 등록을 해제합니다. + globalShortcut.unregister('ctrl+x'); - // 모든 단축키의 등록을 해제합니다. - globalShortcut.unregisterAll(); + // 모든 단축키의 등록을 해제합니다. + globalShortcut.unregisterAll(); }); ``` diff --git a/docs/api/protocol-ko.md b/docs/api/protocol-ko.md index 20243ab95824..ef1e15ebf03d 100644 --- a/docs/api/protocol-ko.md +++ b/docs/api/protocol-ko.md @@ -13,6 +13,9 @@ app.on('ready', function() { protocol.registerProtocol('atom', function(request) { var url = request.url.substr(7) return new protocol.RequestFileJob(path.normalize(__dirname + '/' + url)); + }, function (error, scheme) { + if (!error) + console.log(scheme, ' registered successfully') }); }); ``` diff --git a/docs/development/build-instructions-linux-ko.md b/docs/development/build-instructions-linux-ko.md index 3d7f9389f77b..c946e9adeaad 100644 --- a/docs/development/build-instructions-linux-ko.md +++ b/docs/development/build-instructions-linux-ko.md @@ -46,7 +46,14 @@ $ ./script/bootstrap.py -v ### 크로스 컴파일 -크로스 컴파일을 하려면 `bootstrap.py` 스크립트의 `--target_arch` 파라미터에 `arm` 또는 `ia32` 타겟 아키텍쳐를 전달하면 됩니다. +`arm` 아키텍쳐로 빌드 하려면 먼저 종속성 라이브러리를 설치해야 합니다: + +```bash +$ sudo apt-get install libc6-dev-armhf-cross linux-libc-dev-armhf-cross \ + g++-arm-linux-gnueabihf +``` + +그리고 `bootstrap.py` 스크립트의 `--target_arch` 파라미터에 `arm` 또는 `ia32` 아키텍쳐를 지정하여 크로스 컴파일 할 수 있습니다: ```bash $ ./script/bootstrap.py -v --target_arch=arm From e54fda6b34dc000648d955c27afa79cf21e21988 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Wed, 15 Jul 2015 18:26:39 +0800 Subject: [PATCH 0618/1293] Introduce Electron custom statusItem view. Reimplement tray functions on OS X by using custom statusItem view. --- atom/browser/ui/tray_icon_cocoa.h | 7 +- atom/browser/ui/tray_icon_cocoa.mm | 166 +++++++++++++++++++++++------ 2 files changed, 135 insertions(+), 38 deletions(-) diff --git a/atom/browser/ui/tray_icon_cocoa.h b/atom/browser/ui/tray_icon_cocoa.h index 5723cb6b2196..d4cfd431e466 100644 --- a/atom/browser/ui/tray_icon_cocoa.h +++ b/atom/browser/ui/tray_icon_cocoa.h @@ -13,7 +13,7 @@ #include "base/mac/scoped_nsobject.h" @class AtomMenuController; -@class StatusItemController; +@class StatusItemView; namespace atom { @@ -30,9 +30,8 @@ class TrayIconCocoa : public TrayIcon { void SetContextMenu(ui::SimpleMenuModel* menu_model) override; private: - base::scoped_nsobject item_; - - base::scoped_nsobject controller_; + // Atom custom view for NSStatusItem. + base::scoped_nsobject status_item_view_; // Status menu shown when right-clicking the system icon. base::scoped_nsobject menu_; diff --git a/atom/browser/ui/tray_icon_cocoa.mm b/atom/browser/ui/tray_icon_cocoa.mm index f989b9b580e2..11efbe0aee90 100644 --- a/atom/browser/ui/tray_icon_cocoa.mm +++ b/atom/browser/ui/tray_icon_cocoa.mm @@ -9,35 +9,142 @@ #include "ui/gfx/image/image.h" #include "ui/gfx/screen.h" -@interface StatusItemController : NSObject { + +const CGFloat kStatusItemLength = 26; +const CGFloat kMargin = 3; + +@interface StatusItemView : NSView { atom::TrayIconCocoa* trayIcon_; // weak + AtomMenuController* menu_controller_; // weak + BOOL isHighlightEnable_; + BOOL inMouseEventSequence_; + base::scoped_nsobject image_; + base::scoped_nsobject alternateImage_; + base::scoped_nsobject title_; + base::scoped_nsobject statusItem_; } -- (id)initWithIcon:(atom::TrayIconCocoa*)icon; -- (void)handleClick:(id)sender; -- (void)handleDoubleClick:(id)sender; -@end // @interface StatusItemController +@end // @interface StatusItemView -@implementation StatusItemController +@implementation StatusItemView - (id)initWithIcon:(atom::TrayIconCocoa*)icon { trayIcon_ = icon; + isHighlightEnable_ = YES; + statusItem_.reset([[[NSStatusBar systemStatusBar] statusItemWithLength: + NSVariableStatusItemLength] retain]); + NSRect frame = NSMakeRect(0, 0, 26, [[statusItem_ statusBar] thickness]); + if ((self = [super initWithFrame:frame])) { + [statusItem_ setView:self]; + } return self; } -- (void)handleClick:(id)sender { - // Get the frame of the NSStatusItem. - NSRect frame = [NSApp currentEvent].window.frame; - gfx::Rect bounds(frame.origin.x, 0, NSWidth(frame), NSHeight(frame)); - // Flip coordinates to gfx (0,0 in top-left corner) using current screen. - NSScreen* screen = [[NSScreen screens] objectAtIndex:0]; - bounds.set_y(NSHeight([screen frame]) - NSMaxY(frame)); - - trayIcon_->NotifyClicked(bounds); +- (void)removeItem { + [[NSStatusBar systemStatusBar] removeStatusItem:statusItem_]; + statusItem_.reset(); } -- (void)handleDoubleClick:(id)sender { - trayIcon_->NotifyDoubleClicked(); +- (void)drawRect:(NSRect)dirtyRect { + BOOL highlight = [self shouldHighlight]; + [statusItem_ drawStatusBarBackgroundInRect:[self bounds] + withHighlight:highlight]; + NSRect icon_frame = NSMakeRect(0, + 0, + kStatusItemLength, + [[statusItem_ statusBar] thickness]); + NSRect icon_draw_rect = NSInsetRect(icon_frame, kMargin, kMargin); + if (highlight && alternateImage_) { + [alternateImage_ drawInRect:icon_draw_rect + fromRect:NSZeroRect + operation:NSCompositeSourceOver + fraction:1]; + } else { + [image_ drawInRect:icon_draw_rect + fromRect:NSZeroRect + operation:NSCompositeSourceOver + fraction:1]; + } + if (title_) { + NSAttributedString* attributes = + [[NSAttributedString alloc] initWithString:title_ + attributes:[self titleAttributes]]; + CGFloat title_width = [attributes size].width; + NSRect title_rect = NSMakeRect(kStatusItemLength, + 0, + title_width + kStatusItemLength, + [[statusItem_ statusBar] thickness]); + [title_ drawInRect:title_rect + withAttributes:[self titleAttributes]]; + [statusItem_ setLength:title_width + kStatusItemLength]; + } +} + +- (NSDictionary *)titleAttributes { + NSFont* font = [NSFont menuBarFontOfSize:0]; + NSColor* foregroundColor = [NSColor blackColor]; + + return [NSDictionary dictionaryWithObjectsAndKeys: + font, NSFontAttributeName, + foregroundColor, NSForegroundColorAttributeName, + nil]; +} + +- (void)setImage:(NSImage*)image { + image_.reset([image copy]); +} + +- (void)setAlternateImage:(NSImage*)image { + alternateImage_.reset([image copy]); +} + +- (void)setHighlight:(BOOL)highlight { + isHighlightEnable_ = highlight; +} + +-(void)setTitle:(NSString*) title { + //title_= [title retain]; + title_.reset([title copy]); +} + +- (void)setMenuController:(AtomMenuController*)menu { + menu_controller_ = menu; +} + +-(void)mouseDown:(NSEvent *)event { + inMouseEventSequence_ = YES; + [self setNeedsDisplay:YES]; +} + +-(void)mouseUp:(NSEvent *)event { + if (!inMouseEventSequence_) { + // If the menu is showing, when user clicked the tray icon, the `mouseDown` + // event will be dissmissed, we need to close the menu at this time. + [self setNeedsDisplay:YES]; + return; + } + inMouseEventSequence_ = NO; + if (event.clickCount == 1) { + if (menu_controller_) { + [statusItem_ popUpStatusItemMenu:[menu_controller_ menu]]; + } + + NSRect frame = event.window.frame; + gfx::Rect bounds(frame.origin.x, 0, NSWidth(frame), NSHeight(frame)); + NSScreen* screen = [[NSScreen screens] objectAtIndex:0]; + bounds.set_y(NSHeight([screen frame]) - NSMaxY(frame)); + trayIcon_->NotifyClicked(bounds); + } + + if (event.clickCount == 2 && !menu_controller_) { + trayIcon_->NotifyDoubleClicked(); + } + [self setNeedsDisplay:YES]; +} + +-(BOOL) shouldHighlight { + BOOL is_menu_open = [menu_controller_ isMenuOpen]; + return isHighlightEnable_ && (inMouseEventSequence_ || is_menu_open); } @end @@ -45,45 +152,36 @@ namespace atom { TrayIconCocoa::TrayIconCocoa() { - controller_.reset([[StatusItemController alloc] initWithIcon:this]); - - item_.reset([[[NSStatusBar systemStatusBar] - statusItemWithLength:NSVariableStatusItemLength] retain]); - [item_ setEnabled:YES]; - [item_ setTarget:controller_]; - [item_ setAction:@selector(handleClick:)]; - [item_ setDoubleAction:@selector(handleDoubleClick:)]; - [item_ setHighlightMode:YES]; + status_item_view_.reset([[StatusItemView alloc] initWithIcon:this]); } TrayIconCocoa::~TrayIconCocoa() { - // Remove the status item from the status bar. - [[NSStatusBar systemStatusBar] removeStatusItem:item_]; + [status_item_view_ removeItem]; } void TrayIconCocoa::SetImage(const gfx::Image& image) { - [item_ setImage:image.AsNSImage()]; + [status_item_view_ setImage:image.AsNSImage()]; } void TrayIconCocoa::SetPressedImage(const gfx::Image& image) { - [item_ setAlternateImage:image.AsNSImage()]; + [status_item_view_ setAlternateImage:image.AsNSImage()]; } void TrayIconCocoa::SetToolTip(const std::string& tool_tip) { - [item_ setToolTip:base::SysUTF8ToNSString(tool_tip)]; + [status_item_view_ setToolTip:base::SysUTF8ToNSString(tool_tip)]; } void TrayIconCocoa::SetTitle(const std::string& title) { - [item_ setTitle:base::SysUTF8ToNSString(title)]; + [status_item_view_ setTitle:base::SysUTF8ToNSString(title)]; } void TrayIconCocoa::SetHighlightMode(bool highlight) { - [item_ setHighlightMode:highlight]; + [status_item_view_ setHighlight:highlight]; } void TrayIconCocoa::SetContextMenu(ui::SimpleMenuModel* menu_model) { menu_.reset([[AtomMenuController alloc] initWithModel:menu_model]); - [item_ setMenu:[menu_ menu]]; + [status_item_view_ setMenuController:menu_.get()]; } // static From cca4f4abd588d7fe3970d3cca6d7f0f5d6b86282 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Wed, 15 Jul 2015 19:23:12 +0800 Subject: [PATCH 0619/1293] Implement 'right-clicked' tray event on OS X. --- atom/browser/api/atom_api_tray.cc | 4 ++++ atom/browser/api/atom_api_tray.h | 1 + atom/browser/ui/tray_icon.cc | 4 ++++ atom/browser/ui/tray_icon.h | 1 + atom/browser/ui/tray_icon_cocoa.mm | 19 +++++++++++++------ atom/browser/ui/tray_icon_observer.h | 1 + 6 files changed, 24 insertions(+), 6 deletions(-) diff --git a/atom/browser/api/atom_api_tray.cc b/atom/browser/api/atom_api_tray.cc index 649967a2b1eb..7c1bfdfac95a 100644 --- a/atom/browser/api/atom_api_tray.cc +++ b/atom/browser/api/atom_api_tray.cc @@ -60,6 +60,10 @@ void Tray::OnBalloonClosed() { Emit("balloon-closed"); } +void Tray::OnRightClicked(const gfx::Rect& bounds) { + Emit("right-clicked", bounds); +} + bool Tray::IsDestroyed() const { return !tray_icon_; } diff --git a/atom/browser/api/atom_api_tray.h b/atom/browser/api/atom_api_tray.h index 1a4a498d16b9..366a847ac602 100644 --- a/atom/browser/api/atom_api_tray.h +++ b/atom/browser/api/atom_api_tray.h @@ -46,6 +46,7 @@ class Tray : public mate::EventEmitter, void OnBalloonShow() override; void OnBalloonClicked() override; void OnBalloonClosed() override; + void OnRightClicked(const gfx::Rect&) override; // mate::Wrappable: bool IsDestroyed() const override; diff --git a/atom/browser/ui/tray_icon.cc b/atom/browser/ui/tray_icon.cc index a3878f718a62..4f801faf862e 100644 --- a/atom/browser/ui/tray_icon.cc +++ b/atom/browser/ui/tray_icon.cc @@ -46,4 +46,8 @@ void TrayIcon::NotifyBalloonClosed() { FOR_EACH_OBSERVER(TrayIconObserver, observers_, OnBalloonClosed()); } +void TrayIcon::NotifyRightClicked(const gfx::Rect& bounds) { + FOR_EACH_OBSERVER(TrayIconObserver, observers_, OnRightClicked(bounds)); +} + } // namespace atom diff --git a/atom/browser/ui/tray_icon.h b/atom/browser/ui/tray_icon.h index 7dc67da1bac4..4e097e0ac84a 100644 --- a/atom/browser/ui/tray_icon.h +++ b/atom/browser/ui/tray_icon.h @@ -56,6 +56,7 @@ class TrayIcon { void NotifyBalloonShow(); void NotifyBalloonClicked(); void NotifyBalloonClosed(); + void NotifyRightClicked(const gfx::Rect& bounds = gfx::Rect()); protected: TrayIcon(); diff --git a/atom/browser/ui/tray_icon_cocoa.mm b/atom/browser/ui/tray_icon_cocoa.mm index 11efbe0aee90..2d0acdd6aaf4 100644 --- a/atom/browser/ui/tray_icon_cocoa.mm +++ b/atom/browser/ui/tray_icon_cocoa.mm @@ -75,7 +75,7 @@ const CGFloat kMargin = 3; title_width + kStatusItemLength, [[statusItem_ statusBar] thickness]); [title_ drawInRect:title_rect - withAttributes:[self titleAttributes]]; + withAttributes:[self titleAttributes]]; [statusItem_ setLength:title_width + kStatusItemLength]; } } @@ -129,11 +129,7 @@ const CGFloat kMargin = 3; [statusItem_ popUpStatusItemMenu:[menu_controller_ menu]]; } - NSRect frame = event.window.frame; - gfx::Rect bounds(frame.origin.x, 0, NSWidth(frame), NSHeight(frame)); - NSScreen* screen = [[NSScreen screens] objectAtIndex:0]; - bounds.set_y(NSHeight([screen frame]) - NSMaxY(frame)); - trayIcon_->NotifyClicked(bounds); + trayIcon_->NotifyClicked([self getBoundsFromEvent:event]); } if (event.clickCount == 2 && !menu_controller_) { @@ -142,11 +138,22 @@ const CGFloat kMargin = 3; [self setNeedsDisplay:YES]; } +- (void)rightMouseUp:(NSEvent*)event { + trayIcon_->NotifyRightClicked([self getBoundsFromEvent:event]); +} + -(BOOL) shouldHighlight { BOOL is_menu_open = [menu_controller_ isMenuOpen]; return isHighlightEnable_ && (inMouseEventSequence_ || is_menu_open); } +-(gfx::Rect) getBoundsFromEvent:(NSEvent*)event { + NSRect frame = event.window.frame; + gfx::Rect bounds(frame.origin.x, 0, NSWidth(frame), NSHeight(frame)); + NSScreen* screen = [[NSScreen screens] objectAtIndex:0]; + bounds.set_y(NSHeight([screen frame]) - NSMaxY(frame)); + return bounds; +} @end namespace atom { diff --git a/atom/browser/ui/tray_icon_observer.h b/atom/browser/ui/tray_icon_observer.h index 3a34888b5318..061115efdc64 100644 --- a/atom/browser/ui/tray_icon_observer.h +++ b/atom/browser/ui/tray_icon_observer.h @@ -18,6 +18,7 @@ class TrayIconObserver { virtual void OnBalloonShow() {} virtual void OnBalloonClicked() {} virtual void OnBalloonClosed() {} + virtual void OnRightClicked(const gfx::Rect&) {} protected: virtual ~TrayIconObserver() {} From 5ad3fff6a08c1df45e3fb601ecbf202b776ab82b Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Wed, 15 Jul 2015 20:03:05 +0800 Subject: [PATCH 0620/1293] Implement 'right-clicked' tray event on Windows. --- atom/browser/ui/win/notify_icon.cc | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/atom/browser/ui/win/notify_icon.cc b/atom/browser/ui/win/notify_icon.cc index 955a047fe1f5..64329a63e5e4 100644 --- a/atom/browser/ui/win/notify_icon.cc +++ b/atom/browser/ui/win/notify_icon.cc @@ -47,21 +47,22 @@ NotifyIcon::~NotifyIcon() { void NotifyIcon::HandleClickEvent(const gfx::Point& cursor_pos, bool left_mouse_click) { + NOTIFYICONIDENTIFIER icon_id; + memset(&icon_id, 0, sizeof(NOTIFYICONIDENTIFIER)); + icon_id.uID = icon_id_; + icon_id.hWnd = window_; + icon_id.cbSize = sizeof(NOTIFYICONIDENTIFIER); + RECT rect = { 0 }; + Shell_NotifyIconGetRect(&icon_id, &rect); + // Pass to the observer if appropriate. if (left_mouse_click) { - NOTIFYICONIDENTIFIER icon_id; - memset(&icon_id, 0, sizeof(NOTIFYICONIDENTIFIER)); - icon_id.uID = icon_id_; - icon_id.hWnd = window_; - icon_id.cbSize = sizeof(NOTIFYICONIDENTIFIER); - - RECT rect = { 0 }; - Shell_NotifyIconGetRect(&icon_id, &rect); - NotifyClicked(gfx::Rect(rect)); return; } + NotifyRightClicked(gfx::Rect(rect)); + if (!menu_model_) return; From 38c33d69ae2b1c7d6bcdd86069933d848d44513b Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Wed, 15 Jul 2015 20:13:59 +0800 Subject: [PATCH 0621/1293] :memo: 'right-clicked' doc. --- docs/api/tray.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/docs/api/tray.md b/docs/api/tray.md index 25c9cb451b1d..6d1bbb75ec6c 100644 --- a/docs/api/tray.md +++ b/docs/api/tray.md @@ -25,7 +25,6 @@ app.on('ready', function(){ __Platform limitations:__ -* On OS X `clicked` event will be ignored if the tray icon has context menu. * On Linux app indicator will be used if it is supported, otherwise `GtkStatusIcon` will be used instead. * App indicator will only be showed when it has context menu. @@ -57,6 +56,20 @@ Emitted when the tray icon is clicked. __Note:__ The `bounds` payload is only implemented on OS X and Windows 7 or newer. +### Event: 'right-clicked' + +* `event` +* `bounds` Object - the bounds of tray icon + * `x` Integer + * `y` Integer + * `width` Integer + * `height` Integer + +Emitted when the tray icon is right clicked. + +__Note:__ This is only implemented on OS X and Windows. On Windows, this event +will be emitted if the tray icon has context menu. + ### Event: 'double-clicked' Emitted when the tray icon is double clicked. From 00c484c68bf55376b00a47081f4f937cfcaabf21 Mon Sep 17 00:00:00 2001 From: Antonio Stoilkov Date: Wed, 15 Jul 2015 17:29:02 +0300 Subject: [PATCH 0622/1293] fix typo in browser-window.md --- docs/api/browser-window.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 61f985ed9518..48a118ffa3c2 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -760,7 +760,7 @@ Calling `event.preventDefault()` can prevent creating new windows. * `event` Event * `url` String -Emitted when user or the page wants to start an navigation, it can happen when +Emitted when user or the page wants to start a navigation, it can happen when `window.location` object is changed or user clicks a link in the page. This event will not emit when the navigation is started programmatically with APIs From ca2cb9c9ba5c24a3bdfc5debf0d85305b171c95a Mon Sep 17 00:00:00 2001 From: mhkeller Date: Wed, 15 Jul 2015 10:34:33 -0400 Subject: [PATCH 0623/1293] valid example json, fix https://github.com/atom/electron/issues/2228 --- docs/api/auto-updater.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/auto-updater.md b/docs/api/auto-updater.md index 709d0c0f2766..8da46e2083c9 100644 --- a/docs/api/auto-updater.md +++ b/docs/api/auto-updater.md @@ -85,7 +85,7 @@ to the update request provided: "url": "http://mycompany.com/myapp/releases/myrelease", "name": "My Release Name", "notes": "Theses are some release notes innit", - "pub_date": "2013-09-18T12:29:53+01:00", + "pub_date": "2013-09-18T12:29:53+01:00" } ``` From 9ee0d46734d1e357775833e2c4645c8073842dc9 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 15 Jul 2015 13:11:01 -0700 Subject: [PATCH 0624/1293] Use CTRL+SHIFT+I for toggling devtools, fix #2205 --- atom/browser/default_app/main.js | 2 +- docs/tutorial/quick-start.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/atom/browser/default_app/main.js b/atom/browser/default_app/main.js index 838cb4c2bb2e..fd3a6b596b6b 100644 --- a/atom/browser/default_app/main.js +++ b/atom/browser/default_app/main.js @@ -237,7 +237,7 @@ app.once('ready', function() { }, { label: 'Toggle &Developer Tools', - accelerator: 'Alt+Ctrl+I', + accelerator: 'Shift+Ctrl+I', click: function() { var focusedWindow = BrowserWindow.getFocusedWindow(); if (focusedWindow) diff --git a/docs/tutorial/quick-start.md b/docs/tutorial/quick-start.md index 8f723bbcf64e..fc6d38674c8e 100644 --- a/docs/tutorial/quick-start.md +++ b/docs/tutorial/quick-start.md @@ -82,7 +82,7 @@ var mainWindow = null; // Quit when all windows are closed. app.on('window-all-closed', function() { - // On OSX it is common for applications and their menu bar + // On OSX it is common for applications and their menu bar // to stay active until the user quits explicitly with Cmd + Q if (process.platform != 'darwin') { app.quit(); From 4baaf03ac700cb8c9e21bc1a9271cc913bb66fa1 Mon Sep 17 00:00:00 2001 From: Jeffrey Morgan Date: Tue, 14 Jul 2015 21:28:57 +0100 Subject: [PATCH 0625/1293] Improve grammar and comments Improve the grammar and sentence structure of the text and improve the code comments. --- docs/tutorial/quick-start.md | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/docs/tutorial/quick-start.md b/docs/tutorial/quick-start.md index fc6d38674c8e..ae60fb27ec71 100644 --- a/docs/tutorial/quick-start.md +++ b/docs/tutorial/quick-start.md @@ -4,39 +4,40 @@ Electron enables you to create desktop applications with pure JavaScript by providing a runtime with rich native APIs. You could see it as a variant of the io.js runtime which is focused on desktop applications instead of web servers. -It doesn't mean Electron is a JavaScript binding to GUI libraries. Instead, +This doesn't mean Electron is a JavaScript binding to GUI libraries. Instead, Electron uses web pages as its GUI, so you could also see it as a minimal Chromium browser, controlled by JavaScript. ### Main process In Electron, the process that runs `package.json`'s `main` script is called -__the main process__. The script that runs in the main process, can display GUI by +__the main process__. The script that runs in the main process can display a GUI by creating web pages. ### Renderer process Since Electron uses Chromium for displaying web pages, Chromium's -multi-processes architecture is also used. Each web page in Electron runs in +multi-process architecture is also used. Each web page in Electron runs in its own process, which is called __the renderer process__. -In normal browsers web pages usually run in a sandboxed environment and are not -allowed access to native resources. Electron users however, have the power to use +In normal browsers, web pages usually run in a sandboxed environment and are not +allowed access to native resources. Electron users, however, have the power to use io.js APIs in web pages allowing lower level operating system interactions. ### Differences between main process and renderer process The main process creates web pages by creating `BrowserWindow` instances. Each `BrowserWindow` instance runs the web page in its own renderer process. When a `BrowserWindow` instance is destroyed, the corresponding renderer process -would also be terminated. +is also terminated. The main process manages all web pages and their corresponding renderer -processes, each renderer process is isolated and only cares +processes. Each renderer process is isolated and only cares about the web page running in it. In web pages, it is not allowed to call native GUI related APIs because managing -native GUI resources in web pages is very dangerous and easy to leak resources. -If you want to do GUI operations in web pages, you have to communicate with -the main process to do it there. +native GUI resources in web pages is very dangerous and it is easy to leak resources. +If you want to perform GUI operations in a web page, the renderer process of the web +page must communicate with the main process to request the main process perform those +operations. In Electron, we have provided the [ipc](../api/ipc-renderer.md) module for communication between main process and renderer process. And there is also a @@ -77,20 +78,20 @@ var BrowserWindow = require('browser-window'); // Module to create native brows require('crash-reporter').start(); // Keep a global reference of the window object, if you don't, the window will -// be closed automatically when the javascript object is GCed. +// be closed automatically when the JavaScript object is GCed. var mainWindow = null; // Quit when all windows are closed. app.on('window-all-closed', function() { - // On OSX it is common for applications and their menu bar + // On OS X it is common for applications and their menu bar // to stay active until the user quits explicitly with Cmd + Q if (process.platform != 'darwin') { app.quit(); } }); -// This method will be called when Electron has done everything -// initialization and ready for creating browser windows. +// This method will be called when Electron has finished +// initialization and is ready to create browser windows. app.on('ready', function() { // Create the browser window. mainWindow = new BrowserWindow({width: 800, height: 600}); From 002eb1a3266c2540b5c0d90752819bffc8cae52c Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Thu, 16 Jul 2015 10:49:55 +0800 Subject: [PATCH 0626/1293] Simplify code logic and fix object-c code style. --- atom/browser/ui/tray_icon_cocoa.mm | 75 ++++++++++++++++++------------ 1 file changed, 45 insertions(+), 30 deletions(-) diff --git a/atom/browser/ui/tray_icon_cocoa.mm b/atom/browser/ui/tray_icon_cocoa.mm index 2d0acdd6aaf4..514631c21065 100644 --- a/atom/browser/ui/tray_icon_cocoa.mm +++ b/atom/browser/ui/tray_icon_cocoa.mm @@ -9,13 +9,12 @@ #include "ui/gfx/image/image.h" #include "ui/gfx/screen.h" - const CGFloat kStatusItemLength = 26; const CGFloat kMargin = 3; @interface StatusItemView : NSView { atom::TrayIconCocoa* trayIcon_; // weak - AtomMenuController* menu_controller_; // weak + AtomMenuController* menuController_; // weak BOOL isHighlightEnable_; BOOL inMouseEventSequence_; base::scoped_nsobject image_; @@ -33,7 +32,10 @@ const CGFloat kMargin = 3; isHighlightEnable_ = YES; statusItem_.reset([[[NSStatusBar systemStatusBar] statusItemWithLength: NSVariableStatusItemLength] retain]); - NSRect frame = NSMakeRect(0, 0, 26, [[statusItem_ statusBar] thickness]); + NSRect frame = NSMakeRect(0, + 0, + kStatusItemLength, + [[statusItem_ statusBar] thickness]); if ((self = [super initWithFrame:frame])) { [statusItem_ setView:self]; } @@ -46,38 +48,52 @@ const CGFloat kMargin = 3; } - (void)drawRect:(NSRect)dirtyRect { + // Draw the tray icon and title that align with NSSStatusItem, layout: + // ---------------- + // | icon | title | + /// ---------------- BOOL highlight = [self shouldHighlight]; - [statusItem_ drawStatusBarBackgroundInRect:[self bounds] + CGFloat titleWidth = [self titleWidth]; + // Calculate the total icon bounds. + NSRect statusItemBounds = NSMakeRect(0, + 0, + kStatusItemLength + titleWidth, + [[statusItem_ statusBar] thickness]); + [statusItem_ drawStatusBarBackgroundInRect:statusItemBounds withHighlight:highlight]; - NSRect icon_frame = NSMakeRect(0, - 0, - kStatusItemLength, - [[statusItem_ statusBar] thickness]); - NSRect icon_draw_rect = NSInsetRect(icon_frame, kMargin, kMargin); + [statusItem_ setLength:titleWidth + kStatusItemLength]; + if (title_) { + NSRect titleDrawRect = NSMakeRect(kStatusItemLength, + 0, + titleWidth + kStatusItemLength, + [[statusItem_ statusBar] thickness]); + [title_ drawInRect:titleDrawRect + withAttributes:[self titleAttributes]]; + } + + NSRect iconRect = NSMakeRect(0, + 0, + kStatusItemLength, + [[statusItem_ statusBar] thickness]); if (highlight && alternateImage_) { - [alternateImage_ drawInRect:icon_draw_rect + [alternateImage_ drawInRect:NSInsetRect(iconRect, kMargin, kMargin) fromRect:NSZeroRect operation:NSCompositeSourceOver fraction:1]; } else { - [image_ drawInRect:icon_draw_rect + [image_ drawInRect:NSInsetRect(iconRect, kMargin, kMargin) fromRect:NSZeroRect operation:NSCompositeSourceOver fraction:1]; } - if (title_) { - NSAttributedString* attributes = - [[NSAttributedString alloc] initWithString:title_ - attributes:[self titleAttributes]]; - CGFloat title_width = [attributes size].width; - NSRect title_rect = NSMakeRect(kStatusItemLength, - 0, - title_width + kStatusItemLength, - [[statusItem_ statusBar] thickness]); - [title_ drawInRect:title_rect - withAttributes:[self titleAttributes]]; - [statusItem_ setLength:title_width + kStatusItemLength]; - } +} + +- (CGFloat) titleWidth { + if (!title_) return 0; + NSAttributedString* attributes = + [[NSAttributedString alloc] initWithString:title_ + attributes:[self titleAttributes]]; + return [attributes size].width; } - (NSDictionary *)titleAttributes { @@ -103,12 +119,11 @@ const CGFloat kMargin = 3; } -(void)setTitle:(NSString*) title { - //title_= [title retain]; title_.reset([title copy]); } - (void)setMenuController:(AtomMenuController*)menu { - menu_controller_ = menu; + menuController_ = menu; } -(void)mouseDown:(NSEvent *)event { @@ -125,14 +140,14 @@ const CGFloat kMargin = 3; } inMouseEventSequence_ = NO; if (event.clickCount == 1) { - if (menu_controller_) { - [statusItem_ popUpStatusItemMenu:[menu_controller_ menu]]; + if (menuController_) { + [statusItem_ popUpStatusItemMenu:[menuController_ menu]]; } trayIcon_->NotifyClicked([self getBoundsFromEvent:event]); } - if (event.clickCount == 2 && !menu_controller_) { + if (event.clickCount == 2 && !menuController_) { trayIcon_->NotifyDoubleClicked(); } [self setNeedsDisplay:YES]; @@ -143,7 +158,7 @@ const CGFloat kMargin = 3; } -(BOOL) shouldHighlight { - BOOL is_menu_open = [menu_controller_ isMenuOpen]; + BOOL is_menu_open = [menuController_ isMenuOpen]; return isHighlightEnable_ && (inMouseEventSequence_ || is_menu_open); } From 4421fbf9f36986d9e8c0302b1ccbfdcebe67cd62 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Thu, 16 Jul 2015 10:50:53 +0800 Subject: [PATCH 0627/1293] Implement 'tray.popContextMenu' API on OS X. --- atom/browser/api/atom_api_tray.cc | 5 +++++ atom/browser/api/atom_api_tray.h | 1 + atom/browser/ui/tray_icon.cc | 3 +++ atom/browser/ui/tray_icon.h | 2 ++ atom/browser/ui/tray_icon_cocoa.h | 1 + atom/browser/ui/tray_icon_cocoa.mm | 15 +++++++++++++++ 6 files changed, 27 insertions(+) diff --git a/atom/browser/api/atom_api_tray.cc b/atom/browser/api/atom_api_tray.cc index 7c1bfdfac95a..6fd9599d32bc 100644 --- a/atom/browser/api/atom_api_tray.cc +++ b/atom/browser/api/atom_api_tray.cc @@ -106,6 +106,10 @@ void Tray::DisplayBalloon(mate::Arguments* args, tray_icon_->DisplayBalloon(icon, title, content); } +void Tray::PopContextMenu() { + tray_icon_->PopContextMenu(); +} + void Tray::SetContextMenu(mate::Arguments* args, Menu* menu) { tray_icon_->SetContextMenu(menu->model()); } @@ -121,6 +125,7 @@ void Tray::BuildPrototype(v8::Isolate* isolate, .SetMethod("setTitle", &Tray::SetTitle) .SetMethod("setHighlightMode", &Tray::SetHighlightMode) .SetMethod("displayBalloon", &Tray::DisplayBalloon) + .SetMethod("popContextMenu", &Tray::PopContextMenu) .SetMethod("_setContextMenu", &Tray::SetContextMenu); } diff --git a/atom/browser/api/atom_api_tray.h b/atom/browser/api/atom_api_tray.h index 366a847ac602..e7df28548c17 100644 --- a/atom/browser/api/atom_api_tray.h +++ b/atom/browser/api/atom_api_tray.h @@ -58,6 +58,7 @@ class Tray : public mate::EventEmitter, void SetTitle(mate::Arguments* args, const std::string& title); void SetHighlightMode(mate::Arguments* args, bool highlight); void DisplayBalloon(mate::Arguments* args, const mate::Dictionary& options); + void PopContextMenu(); void SetContextMenu(mate::Arguments* args, Menu* menu); private: diff --git a/atom/browser/ui/tray_icon.cc b/atom/browser/ui/tray_icon.cc index 4f801faf862e..7f67a02160a6 100644 --- a/atom/browser/ui/tray_icon.cc +++ b/atom/browser/ui/tray_icon.cc @@ -26,6 +26,9 @@ void TrayIcon::DisplayBalloon(const gfx::Image& icon, const base::string16& contents) { } +void TrayIcon::PopContextMenu() { +} + void TrayIcon::NotifyClicked(const gfx::Rect& bounds) { FOR_EACH_OBSERVER(TrayIconObserver, observers_, OnClicked(bounds)); } diff --git a/atom/browser/ui/tray_icon.h b/atom/browser/ui/tray_icon.h index 4e097e0ac84a..e57d751b0713 100644 --- a/atom/browser/ui/tray_icon.h +++ b/atom/browser/ui/tray_icon.h @@ -46,6 +46,8 @@ class TrayIcon { const base::string16& title, const base::string16& contents); + virtual void PopContextMenu(); + // Set the context menu for this icon. virtual void SetContextMenu(ui::SimpleMenuModel* menu_model) = 0; diff --git a/atom/browser/ui/tray_icon_cocoa.h b/atom/browser/ui/tray_icon_cocoa.h index d4cfd431e466..eb80250f6fc0 100644 --- a/atom/browser/ui/tray_icon_cocoa.h +++ b/atom/browser/ui/tray_icon_cocoa.h @@ -27,6 +27,7 @@ class TrayIconCocoa : public TrayIcon { void SetToolTip(const std::string& tool_tip) override; void SetTitle(const std::string& title) override; void SetHighlightMode(bool highlight) override; + void PopContextMenu() override; void SetContextMenu(ui::SimpleMenuModel* menu_model) override; private: diff --git a/atom/browser/ui/tray_icon_cocoa.mm b/atom/browser/ui/tray_icon_cocoa.mm index 514631c21065..f751f131b4e2 100644 --- a/atom/browser/ui/tray_icon_cocoa.mm +++ b/atom/browser/ui/tray_icon_cocoa.mm @@ -153,6 +153,17 @@ const CGFloat kMargin = 3; [self setNeedsDisplay:YES]; } +- (void)popContextMenu { + if (menuController_ && ![menuController_ isMenuOpen]) { + // redraw the dray icon to show highlight if it is enabled. + [self setNeedsDisplay:YES]; + [statusItem_ popUpStatusItemMenu:[menuController_ menu]]; + // The popUpStatusItemMenu returns only after the showing menu is closed. + // When it returns, we need to redraw the tray icon to not show highlight. + [self setNeedsDisplay:YES]; + } +} + - (void)rightMouseUp:(NSEvent*)event { trayIcon_->NotifyRightClicked([self getBoundsFromEvent:event]); } @@ -201,6 +212,10 @@ void TrayIconCocoa::SetHighlightMode(bool highlight) { [status_item_view_ setHighlight:highlight]; } +void TrayIconCocoa::PopContextMenu() { + [status_item_view_ popContextMenu]; +} + void TrayIconCocoa::SetContextMenu(ui::SimpleMenuModel* menu_model) { menu_.reset([[AtomMenuController alloc] initWithModel:menu_model]); [status_item_view_ setMenuController:menu_.get()]; From ed4c69343f5f9bf77cec5ec84f3a363261b82b21 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Thu, 16 Jul 2015 11:39:49 +0800 Subject: [PATCH 0628/1293] Add 'tray.popContextMenu()' Windows implementation. --- atom/browser/api/atom_api_tray.cc | 6 +++-- atom/browser/api/atom_api_tray.h | 2 +- atom/browser/ui/tray_icon.cc | 2 +- atom/browser/ui/tray_icon.h | 2 +- atom/browser/ui/win/notify_icon.cc | 36 +++++++++++++++--------------- atom/browser/ui/win/notify_icon.h | 1 + 6 files changed, 26 insertions(+), 23 deletions(-) diff --git a/atom/browser/api/atom_api_tray.cc b/atom/browser/api/atom_api_tray.cc index 6fd9599d32bc..bf3a521d76e7 100644 --- a/atom/browser/api/atom_api_tray.cc +++ b/atom/browser/api/atom_api_tray.cc @@ -106,8 +106,10 @@ void Tray::DisplayBalloon(mate::Arguments* args, tray_icon_->DisplayBalloon(icon, title, content); } -void Tray::PopContextMenu() { - tray_icon_->PopContextMenu(); +void Tray::PopContextMenu(mate::Arguments* args) { + gfx::Point pos; + args->GetNext(&pos); + tray_icon_->PopContextMenu(pos); } void Tray::SetContextMenu(mate::Arguments* args, Menu* menu) { diff --git a/atom/browser/api/atom_api_tray.h b/atom/browser/api/atom_api_tray.h index e7df28548c17..5b40937d717a 100644 --- a/atom/browser/api/atom_api_tray.h +++ b/atom/browser/api/atom_api_tray.h @@ -58,7 +58,7 @@ class Tray : public mate::EventEmitter, void SetTitle(mate::Arguments* args, const std::string& title); void SetHighlightMode(mate::Arguments* args, bool highlight); void DisplayBalloon(mate::Arguments* args, const mate::Dictionary& options); - void PopContextMenu(); + void PopContextMenu(mate::Arguments* args); void SetContextMenu(mate::Arguments* args, Menu* menu); private: diff --git a/atom/browser/ui/tray_icon.cc b/atom/browser/ui/tray_icon.cc index 7f67a02160a6..ab1ebfa67790 100644 --- a/atom/browser/ui/tray_icon.cc +++ b/atom/browser/ui/tray_icon.cc @@ -26,7 +26,7 @@ void TrayIcon::DisplayBalloon(const gfx::Image& icon, const base::string16& contents) { } -void TrayIcon::PopContextMenu() { +void TrayIcon::PopContextMenu(const gfx::Point& pos) { } void TrayIcon::NotifyClicked(const gfx::Rect& bounds) { diff --git a/atom/browser/ui/tray_icon.h b/atom/browser/ui/tray_icon.h index e57d751b0713..a9e9b414ec94 100644 --- a/atom/browser/ui/tray_icon.h +++ b/atom/browser/ui/tray_icon.h @@ -46,7 +46,7 @@ class TrayIcon { const base::string16& title, const base::string16& contents); - virtual void PopContextMenu(); + virtual void PopContextMenu(const gfx::Point& pos); // Set the context menu for this icon. virtual void SetContextMenu(ui::SimpleMenuModel* menu_model) = 0; diff --git a/atom/browser/ui/win/notify_icon.cc b/atom/browser/ui/win/notify_icon.cc index 64329a63e5e4..bc9ff46f939a 100644 --- a/atom/browser/ui/win/notify_icon.cc +++ b/atom/browser/ui/win/notify_icon.cc @@ -62,24 +62,7 @@ void NotifyIcon::HandleClickEvent(const gfx::Point& cursor_pos, } NotifyRightClicked(gfx::Rect(rect)); - - if (!menu_model_) - return; - - // Set our window as the foreground window, so the context menu closes when - // we click away from it. - if (!SetForegroundWindow(window_)) - return; - - views::MenuRunner menu_runner( - menu_model_, - views::MenuRunner::CONTEXT_MENU | views::MenuRunner::HAS_MNEMONICS); - ignore_result(menu_runner.RunMenuAt( - NULL, - NULL, - gfx::Rect(cursor_pos, gfx::Size()), - views::MENU_ANCHOR_TOPLEFT, - ui::MENU_SOURCE_MOUSE)); + PopContextMenu(cursor_pos); } void NotifyIcon::ResetIcon() { @@ -152,6 +135,23 @@ void NotifyIcon::DisplayBalloon(const gfx::Image& icon, LOG(WARNING) << "Unable to create status tray balloon."; } +void NotifyIcon::PopContextMenu(const gfx::Point& pos) { + // Set our window as the foreground window, so the context menu closes when + // we click away from it. + if (!SetForegroundWindow(window_)) + return; + + views::MenuRunner menu_runner( + menu_model_, + views::MenuRunner::CONTEXT_MENU | views::MenuRunner::HAS_MNEMONICS); + ignore_result(menu_runner.RunMenuAt( + NULL, + NULL, + gfx::Rect(pos, gfx::Size()), + views::MENU_ANCHOR_TOPLEFT, + ui::MENU_SOURCE_MOUSE)); +} + void NotifyIcon::SetContextMenu(ui::SimpleMenuModel* menu_model) { menu_model_ = menu_model; } diff --git a/atom/browser/ui/win/notify_icon.h b/atom/browser/ui/win/notify_icon.h index 12eea1fcf725..8e00f1267920 100644 --- a/atom/browser/ui/win/notify_icon.h +++ b/atom/browser/ui/win/notify_icon.h @@ -49,6 +49,7 @@ class NotifyIcon : public TrayIcon { void DisplayBalloon(const gfx::Image& icon, const base::string16& title, const base::string16& contents) override; + void PopContextMenu(const gfx::Point& pos) override; void SetContextMenu(ui::SimpleMenuModel* menu_model) override; private: From 736fe0c1db8c2fb5502eb1a6bb5d3cca9c63f750 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Thu, 16 Jul 2015 11:43:42 +0800 Subject: [PATCH 0629/1293] Fix OS X build error. --- atom/browser/ui/tray_icon_cocoa.h | 2 +- atom/browser/ui/tray_icon_cocoa.mm | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/atom/browser/ui/tray_icon_cocoa.h b/atom/browser/ui/tray_icon_cocoa.h index eb80250f6fc0..9aa801ec5ead 100644 --- a/atom/browser/ui/tray_icon_cocoa.h +++ b/atom/browser/ui/tray_icon_cocoa.h @@ -27,7 +27,7 @@ class TrayIconCocoa : public TrayIcon { void SetToolTip(const std::string& tool_tip) override; void SetTitle(const std::string& title) override; void SetHighlightMode(bool highlight) override; - void PopContextMenu() override; + void PopContextMenu(const gfx::Point& pos) override; void SetContextMenu(ui::SimpleMenuModel* menu_model) override; private: diff --git a/atom/browser/ui/tray_icon_cocoa.mm b/atom/browser/ui/tray_icon_cocoa.mm index f751f131b4e2..8d1748e3f6d1 100644 --- a/atom/browser/ui/tray_icon_cocoa.mm +++ b/atom/browser/ui/tray_icon_cocoa.mm @@ -212,7 +212,7 @@ void TrayIconCocoa::SetHighlightMode(bool highlight) { [status_item_view_ setHighlight:highlight]; } -void TrayIconCocoa::PopContextMenu() { +void TrayIconCocoa::PopContextMenu(const gfx::Point& pos) { [status_item_view_ popContextMenu]; } From 17628b3e40a8793cc4e65f5e4bc62948520ee1cd Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Thu, 16 Jul 2015 11:53:13 +0800 Subject: [PATCH 0630/1293] :memo: tray.popContextMenu API. --- docs/api/tray.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/api/tray.md b/docs/api/tray.md index 6d1bbb75ec6c..fe0e2542b3a3 100644 --- a/docs/api/tray.md +++ b/docs/api/tray.md @@ -144,6 +144,15 @@ Displays a tray balloon. __Note:__ This is only implemented on Windows. +### Tray.popContextMenu([position]) + +* `position` Object - The pop position + * `x` Integer + * `y` Integer + +__Note:__ This is only implemented on OS X and Windows. +The `position` is only available on Windows, and it is (0, 0) by default. + ### Tray.setContextMenu(menu) * `menu` Menu From 2cd6ad1a9712cdf9cf97564de1d3c382ce2f7c3f Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Thu, 16 Jul 2015 18:36:45 +0800 Subject: [PATCH 0631/1293] More code style fixing. --- atom/browser/ui/tray_icon_cocoa.mm | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/atom/browser/ui/tray_icon_cocoa.mm b/atom/browser/ui/tray_icon_cocoa.mm index 8d1748e3f6d1..4dcb6d2782c1 100644 --- a/atom/browser/ui/tray_icon_cocoa.mm +++ b/atom/browser/ui/tray_icon_cocoa.mm @@ -9,9 +9,13 @@ #include "ui/gfx/image/image.h" #include "ui/gfx/screen.h" +namespace { + const CGFloat kStatusItemLength = 26; const CGFloat kMargin = 3; +} // namespace + @interface StatusItemView : NSView { atom::TrayIconCocoa* trayIcon_; // weak AtomMenuController* menuController_; // weak @@ -88,7 +92,7 @@ const CGFloat kMargin = 3; } } -- (CGFloat) titleWidth { +- (CGFloat)titleWidth { if (!title_) return 0; NSAttributedString* attributes = [[NSAttributedString alloc] initWithString:title_ @@ -96,7 +100,7 @@ const CGFloat kMargin = 3; return [attributes size].width; } -- (NSDictionary *)titleAttributes { +- (NSDictionary*)titleAttributes { NSFont* font = [NSFont menuBarFontOfSize:0]; NSColor* foregroundColor = [NSColor blackColor]; @@ -108,6 +112,7 @@ const CGFloat kMargin = 3; - (void)setImage:(NSImage*)image { image_.reset([image copy]); + [self setNeedsDisplay:YES]; } - (void)setAlternateImage:(NSImage*)image { @@ -118,20 +123,21 @@ const CGFloat kMargin = 3; isHighlightEnable_ = highlight; } --(void)setTitle:(NSString*) title { +- (void)setTitle:(NSString*)title { title_.reset([title copy]); + [self setNeedsDisplay:YES]; } - (void)setMenuController:(AtomMenuController*)menu { menuController_ = menu; } --(void)mouseDown:(NSEvent *)event { +- (void)mouseDown:(NSEvent*)event { inMouseEventSequence_ = YES; [self setNeedsDisplay:YES]; } --(void)mouseUp:(NSEvent *)event { +- (void)mouseUp:(NSEvent*)event { if (!inMouseEventSequence_) { // If the menu is showing, when user clicked the tray icon, the `mouseDown` // event will be dissmissed, we need to close the menu at this time. @@ -168,12 +174,12 @@ const CGFloat kMargin = 3; trayIcon_->NotifyRightClicked([self getBoundsFromEvent:event]); } --(BOOL) shouldHighlight { +- (BOOL)shouldHighlight { BOOL is_menu_open = [menuController_ isMenuOpen]; return isHighlightEnable_ && (inMouseEventSequence_ || is_menu_open); } --(gfx::Rect) getBoundsFromEvent:(NSEvent*)event { +- (gfx::Rect)getBoundsFromEvent:(NSEvent*)event { NSRect frame = event.window.frame; gfx::Rect bounds(frame.origin.x, 0, NSWidth(frame), NSHeight(frame)); NSScreen* screen = [[NSScreen screens] objectAtIndex:0]; From a2c26b8c744c8417db590604b37331ccf2ba8eb8 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 16 Jul 2015 03:48:35 -0700 Subject: [PATCH 0632/1293] Fix hanlding trailing slash in asar package, close #2222 --- atom/common/asar/archive.cc | 5 +++++ spec/asar-spec.coffee | 9 +++++++++ 2 files changed, 14 insertions(+) diff --git a/atom/common/asar/archive.cc b/atom/common/asar/archive.cc index 79b82416cd0a..be99530c9c98 100644 --- a/atom/common/asar/archive.cc +++ b/atom/common/asar/archive.cc @@ -54,6 +54,11 @@ bool GetChildNode(const base::DictionaryValue* root, const std::string& name, const base::DictionaryValue* dir, const base::DictionaryValue** out) { + if (name == "") { + *out = root; + return true; + } + const base::DictionaryValue* files = NULL; return GetFilesNode(root, dir, &files) && files->GetDictionaryWithoutPathExpansion(name, out); diff --git a/spec/asar-spec.coffee b/spec/asar-spec.coffee index 977676a1936a..a49417258fec 100644 --- a/spec/asar-spec.coffee +++ b/spec/asar-spec.coffee @@ -85,6 +85,11 @@ describe 'asar package', -> done() describe 'fs.lstatSync', -> + it 'handles path with trailing slash correctly', -> + p = path.join fixtures, 'asar', 'a.asar', 'link2', 'link2', 'file1' + fs.lstatSync p + fs.lstatSync p + '/' + it 'returns information of root', -> p = path.join fixtures, 'asar', 'a.asar' stats = fs.lstatSync p @@ -136,6 +141,10 @@ describe 'asar package', -> assert.throws throws, /ENOENT/ describe 'fs.lstat', -> + it 'handles path with trailing slash correctly', (done) -> + p = path.join fixtures, 'asar', 'a.asar', 'link2', 'link2', 'file1' + fs.lstat p + '/', done + it 'returns information of root', (done) -> p = path.join fixtures, 'asar', 'a.asar' stats = fs.lstat p, (err, stats) -> From 21e5054facefa4c54b0927df7248560069ee00dd Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Mon, 13 Jul 2015 16:19:30 +0800 Subject: [PATCH 0633/1293] Make remember last used directory. --- atom/browser/web_dialog_helper.cc | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/atom/browser/web_dialog_helper.cc b/atom/browser/web_dialog_helper.cc index bbf16b5fc23c..93cb32cba7c7 100644 --- a/atom/browser/web_dialog_helper.cc +++ b/atom/browser/web_dialog_helper.cc @@ -7,10 +7,13 @@ #include #include +#include "atom/browser/atom_browser_context.h" +#include "atom/browser/native_window.h" #include "atom/browser/ui/file_dialog.h" #include "base/bind.h" #include "base/files/file_enumerator.h" #include "base/files/file_path.h" +#include "base/prefs/pref_service.h" #include "base/strings/utf_string_conversions.h" #include "content/public/browser/render_view_host.h" #include "content/public/browser/web_contents.h" @@ -20,6 +23,8 @@ namespace { +const char kSelectFileLastDirectory[] = "selectfile.last_directory"; + file_dialog::Filters GetFileTypesFromAcceptType( const std::vector& accept_types) { file_dialog::Filters filters; @@ -103,9 +108,13 @@ void WebDialogHelper::RunFileChooser(content::WebContents* web_contents, } std::vector paths; + AtomBrowserContext* browser_context = static_cast( + window_->web_contents()->GetBrowserContext()); + base::FilePath default_file_path = browser_context->prefs()->GetFilePath( + kSelectFileLastDirectory).Append(params.default_file_name); if (file_dialog::ShowOpenDialog(window_, base::UTF16ToUTF8(params.title), - params.default_file_name, + default_file_path, filters, flags, &paths)) { @@ -115,6 +124,10 @@ void WebDialogHelper::RunFileChooser(content::WebContents* web_contents, info.display_name = path.BaseName().value(); result.push_back(info); } + if (!paths.empty()) { + browser_context->prefs()->SetFilePath(kSelectFileLastDirectory, + paths[0].DirName()); + } } } From db6d8de5dc6875f12bab2aee565eea36a278354f Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 16 Jul 2015 06:32:09 -0700 Subject: [PATCH 0634/1293] docs: Say more about standard scheme --- docs/api/protocol.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/api/protocol.md b/docs/api/protocol.md index a076e3640daa..2734546516e3 100644 --- a/docs/api/protocol.md +++ b/docs/api/protocol.md @@ -37,6 +37,11 @@ Registers a custom protocol of `scheme`, the `handler` would be called with You need to return a request job in the `handler` to specify which type of response you would like to send. +By default the scheme is treated like `http:`, which is parsed differently +from protocols that follows "generic URI syntax" like `file:`, so you probably +want to call `protocol.registerStandardSchemes` to make your scheme treated as +standard scheme. + ## protocol.unregisterProtocol(scheme, callback) * `scheme` String @@ -48,7 +53,11 @@ Unregisters the custom protocol of `scheme`. * `value` Array -`value` is an array of custom schemes to be registered to the standard. +`value` is an array of custom schemes to be registered as standard schemes. + +A standard scheme adheres to what RFC 3986 calls +[generic URI syntax](https://tools.ietf.org/html/rfc3986#section-3). This +includes `file:` and `filesystem:`. ## protocol.isHandledProtocol(scheme, callback) From 88ab23def9d14188f4797d90cd60bbe68e4cd259 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 16 Jul 2015 06:36:10 -0700 Subject: [PATCH 0635/1293] Update brightray for #1852 --- vendor/brightray | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/brightray b/vendor/brightray index 6328c6104131..c5f41a6edf61 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit 6328c6104131e623da87f479ea305b83169099b8 +Subproject commit c5f41a6edf6109e862c4c286d0c156e0099678e0 From 8eb87c5d2bb6efd643d3a0c55aa7d1c2e2a2fd87 Mon Sep 17 00:00:00 2001 From: Robo Date: Mon, 13 Jul 2015 21:10:44 +0530 Subject: [PATCH 0636/1293] protocol: create separate request context for fetch job --- atom/browser/api/atom_api_protocol.cc | 5 ++--- atom/browser/api/atom_api_protocol.h | 3 --- atom/browser/net/adapter_request_job.cc | 4 +--- atom/browser/net/adapter_request_job.h | 3 +-- atom/browser/net/url_request_fetch_job.cc | 17 ++++++++++++++--- atom/browser/net/url_request_fetch_job.h | 6 ++++-- 6 files changed, 22 insertions(+), 16 deletions(-) diff --git a/atom/browser/api/atom_api_protocol.cc b/atom/browser/api/atom_api_protocol.cc index 65ba3039d153..89b5bc86a40d 100644 --- a/atom/browser/api/atom_api_protocol.cc +++ b/atom/browser/api/atom_api_protocol.cc @@ -132,7 +132,7 @@ class CustomProtocolRequestJob : public AdapterRequestJob { BrowserThread::PostTask(BrowserThread::IO, FROM_HERE, base::Bind(&AdapterRequestJob::CreateHttpJobAndStart, GetWeakPtr(), - registry_->browser_context(), url, method, referrer)); + url, method, referrer)); return; } } @@ -211,8 +211,7 @@ std::string ConvertErrorCode(int error_code) { } // namespace Protocol::Protocol(AtomBrowserContext* browser_context) - : browser_context_(browser_context), - job_factory_(browser_context->job_factory()) { + : job_factory_(browser_context->job_factory()) { CHECK(job_factory_); } diff --git a/atom/browser/api/atom_api_protocol.h b/atom/browser/api/atom_api_protocol.h index b4d56018baf3..3e6f950241cb 100644 --- a/atom/browser/api/atom_api_protocol.h +++ b/atom/browser/api/atom_api_protocol.h @@ -46,8 +46,6 @@ class Protocol : public mate::EventEmitter { JsProtocolHandler GetProtocolHandler(const std::string& scheme); - AtomBrowserContext* browser_context() const { return browser_context_; } - protected: explicit Protocol(AtomBrowserContext* browser_context); @@ -94,7 +92,6 @@ class Protocol : public mate::EventEmitter { const JsProtocolHandler& handler); int UninterceptProtocolInIO(const std::string& scheme); - AtomBrowserContext* browser_context_; AtomURLRequestJobFactory* job_factory_; ProtocolHandlersMap protocol_handlers_; diff --git a/atom/browser/net/adapter_request_job.cc b/atom/browser/net/adapter_request_job.cc index 20be9a708945..8dc472a75f91 100644 --- a/atom/browser/net/adapter_request_job.cc +++ b/atom/browser/net/adapter_request_job.cc @@ -4,7 +4,6 @@ #include "atom/browser/net/adapter_request_job.h" -#include "atom/browser/atom_browser_context.h" #include "base/threading/sequenced_worker_pool.h" #include "atom/browser/net/url_request_buffer_job.h" #include "atom/browser/net/url_request_fetch_job.h" @@ -115,7 +114,6 @@ void AdapterRequestJob::CreateFileJobAndStart(const base::FilePath& path) { } void AdapterRequestJob::CreateHttpJobAndStart( - AtomBrowserContext* browser_context, const GURL& url, const std::string& method, const std::string& referrer) { @@ -124,7 +122,7 @@ void AdapterRequestJob::CreateHttpJobAndStart( return; } - real_job_ = new URLRequestFetchJob(browser_context, request(), + real_job_ = new URLRequestFetchJob(request(), network_delegate(), url, method, referrer); real_job_->Start(); } diff --git a/atom/browser/net/adapter_request_job.h b/atom/browser/net/adapter_request_job.h index 6aff376f3021..040738b649ab 100644 --- a/atom/browser/net/adapter_request_job.h +++ b/atom/browser/net/adapter_request_job.h @@ -61,8 +61,7 @@ class AdapterRequestJob : public net::URLRequestJob { const std::string& charset, scoped_refptr data); void CreateFileJobAndStart(const base::FilePath& path); - void CreateHttpJobAndStart(AtomBrowserContext* browser_context, - const GURL& url, + void CreateHttpJobAndStart(const GURL& url, const std::string& method, const std::string& referrer); void CreateJobFromProtocolHandlerAndStart(); diff --git a/atom/browser/net/url_request_fetch_job.cc b/atom/browser/net/url_request_fetch_job.cc index e353ff170879..d823051ed8d9 100644 --- a/atom/browser/net/url_request_fetch_job.cc +++ b/atom/browser/net/url_request_fetch_job.cc @@ -7,13 +7,14 @@ #include #include -#include "atom/browser/atom_browser_context.h" #include "base/strings/string_util.h" +#include "base/thread_task_runner_handle.h" #include "net/base/io_buffer.h" #include "net/base/net_errors.h" #include "net/http/http_response_headers.h" #include "net/url_request/url_fetcher.h" #include "net/url_request/url_fetcher_response_writer.h" +#include "net/url_request/url_request_context_builder.h" #include "net/url_request/url_request_status.h" namespace atom { @@ -74,7 +75,6 @@ class ResponsePiper : public net::URLFetcherResponseWriter { } // namespace URLRequestFetchJob::URLRequestFetchJob( - AtomBrowserContext* browser_context, net::URLRequest* request, net::NetworkDelegate* network_delegate, const GURL& url, @@ -90,7 +90,7 @@ URLRequestFetchJob::URLRequestFetchJob( request_type = GetRequestType(method); fetcher_.reset(net::URLFetcher::Create(url, request_type, this)); - fetcher_->SetRequestContext(browser_context->url_request_context_getter()); + fetcher_->SetRequestContext(GetRequestContext()); fetcher_->SaveResponseWithWriter(make_scoped_ptr(new ResponsePiper(this))); // Use |request|'s referrer if |referrer| is not specified. @@ -107,6 +107,17 @@ URLRequestFetchJob::URLRequestFetchJob( } } +net::URLRequestContextGetter* URLRequestFetchJob::GetRequestContext() { + if (!url_request_context_getter_.get()) { + auto task_runner = base::ThreadTaskRunnerHandle::Get(); + net::URLRequestContextBuilder builder; + builder.set_proxy_service(net::ProxyService::CreateDirect()); + url_request_context_getter_ = + new net::TrivialURLRequestContextGetter(builder.Build(), task_runner); + } + return url_request_context_getter_.get(); +} + void URLRequestFetchJob::HeadersCompleted() { response_info_.reset(new net::HttpResponseInfo); response_info_->headers = fetcher_->GetResponseHeaders(); diff --git a/atom/browser/net/url_request_fetch_job.h b/atom/browser/net/url_request_fetch_job.h index d598e3223618..8f3a41056133 100644 --- a/atom/browser/net/url_request_fetch_job.h +++ b/atom/browser/net/url_request_fetch_job.h @@ -7,6 +7,7 @@ #include +#include "net/url_request/url_request_context_getter.h" #include "net/url_request/url_fetcher_delegate.h" #include "net/url_request/url_request_job.h" @@ -17,13 +18,13 @@ class AtomBrowserContext; class URLRequestFetchJob : public net::URLRequestJob, public net::URLFetcherDelegate { public: - URLRequestFetchJob(AtomBrowserContext* browser_context, - net::URLRequest* request, + URLRequestFetchJob(net::URLRequest* request, net::NetworkDelegate* network_delegate, const GURL& url, const std::string& method, const std::string& referrer); + net::URLRequestContextGetter* GetRequestContext(); void HeadersCompleted(); int DataAvailable(net::IOBuffer* buffer, int num_bytes); @@ -41,6 +42,7 @@ class URLRequestFetchJob : public net::URLRequestJob, void OnURLFetchComplete(const net::URLFetcher* source) override; private: + scoped_refptr url_request_context_getter_; scoped_ptr fetcher_; scoped_refptr pending_buffer_; int pending_buffer_size_; From 57244e4718d14150fbc213a733ca3935b59a792b Mon Sep 17 00:00:00 2001 From: Robo Date: Wed, 15 Jul 2015 18:05:38 +0530 Subject: [PATCH 0637/1293] use request context from session if provided --- atom/browser/api/atom_api_protocol.cc | 22 +++++++++++++++++++++- atom/browser/api/atom_api_session.cc | 4 ++++ atom/browser/api/atom_api_session.h | 2 ++ atom/browser/api/lib/protocol.coffee | 2 +- atom/browser/net/adapter_request_job.cc | 3 ++- atom/browser/net/adapter_request_job.h | 9 ++++++--- atom/browser/net/url_request_fetch_job.cc | 8 +++++++- atom/browser/net/url_request_fetch_job.h | 3 ++- docs/api/protocol.md | 1 + 9 files changed, 46 insertions(+), 8 deletions(-) diff --git a/atom/browser/api/atom_api_protocol.cc b/atom/browser/api/atom_api_protocol.cc index 89b5bc86a40d..3b9eeb9fb783 100644 --- a/atom/browser/api/atom_api_protocol.cc +++ b/atom/browser/api/atom_api_protocol.cc @@ -7,6 +7,7 @@ #include "atom/browser/atom_browser_client.h" #include "atom/browser/atom_browser_context.h" #include "atom/browser/atom_browser_main_parts.h" +#include "atom/browser/api/atom_api_session.h" #include "atom/browser/net/adapter_request_job.h" #include "atom/browser/net/atom_url_request_job_factory.h" #include "atom/common/native_mate_converters/file_path_converter.h" @@ -34,6 +35,23 @@ struct Converter { } }; +template<> +struct Converter { + static bool FromV8(v8::Isolate* isolate, v8::Local val, + net::URLRequestContextGetter** out) { + if (val->IsNull() || val->IsUndefined()) { + *out = nullptr; + return true; + } + + atom::api::Session* session; + if (!Converter::FromV8(isolate, val, &session)) + return false; + *out = session->GetBrowserContext()->GetRequestContext(); + return true; + } +}; + } // namespace mate namespace atom { @@ -126,13 +144,15 @@ class CustomProtocolRequestJob : public AdapterRequestJob { } else if (name == "RequestHttpJob") { GURL url; std::string method, referrer; + net::URLRequestContextGetter* getter; dict.Get("url", &url); dict.Get("method", &method); dict.Get("referrer", &referrer); + dict.Get("session", &getter); BrowserThread::PostTask(BrowserThread::IO, FROM_HERE, base::Bind(&AdapterRequestJob::CreateHttpJobAndStart, GetWeakPtr(), - url, method, referrer)); + base::Unretained(getter), url, method, referrer)); return; } } diff --git a/atom/browser/api/atom_api_session.cc b/atom/browser/api/atom_api_session.cc index 93f8de52dd45..b489df4c44ef 100644 --- a/atom/browser/api/atom_api_session.cc +++ b/atom/browser/api/atom_api_session.cc @@ -203,6 +203,10 @@ Session::Session(AtomBrowserContext* browser_context) Session::~Session() { } +AtomBrowserContext* Session::GetBrowserContext() const { + return browser_context_; +} + void Session::ResolveProxy(const GURL& url, ResolveProxyCallback callback) { new ResolveProxyHelper(browser_context_, url, callback); } diff --git a/atom/browser/api/atom_api_session.h b/atom/browser/api/atom_api_session.h index 59e1a9380796..debe01ef9dbc 100644 --- a/atom/browser/api/atom_api_session.h +++ b/atom/browser/api/atom_api_session.h @@ -31,6 +31,8 @@ class Session: public mate::TrackableObject { static mate::Handle CreateFrom( v8::Isolate* isolate, AtomBrowserContext* browser_context); + AtomBrowserContext* GetBrowserContext() const; + protected: explicit Session(AtomBrowserContext* browser_context); ~Session(); diff --git a/atom/browser/api/lib/protocol.coffee b/atom/browser/api/lib/protocol.coffee index 6e22329318b4..4a661523509c 100644 --- a/atom/browser/api/lib/protocol.coffee +++ b/atom/browser/api/lib/protocol.coffee @@ -59,6 +59,6 @@ class RequestErrorJob protocol.RequestHttpJob = class RequestHttpJob - constructor: ({@url, @method, @referrer}) -> + constructor: ({@session, @url, @method, @referrer}) -> module.exports = protocol diff --git a/atom/browser/net/adapter_request_job.cc b/atom/browser/net/adapter_request_job.cc index 8dc472a75f91..d9c9b467d48c 100644 --- a/atom/browser/net/adapter_request_job.cc +++ b/atom/browser/net/adapter_request_job.cc @@ -114,6 +114,7 @@ void AdapterRequestJob::CreateFileJobAndStart(const base::FilePath& path) { } void AdapterRequestJob::CreateHttpJobAndStart( + net::URLRequestContextGetter* request_context_getter, const GURL& url, const std::string& method, const std::string& referrer) { @@ -122,7 +123,7 @@ void AdapterRequestJob::CreateHttpJobAndStart( return; } - real_job_ = new URLRequestFetchJob(request(), + real_job_ = new URLRequestFetchJob(request_context_getter, request(), network_delegate(), url, method, referrer); real_job_->Start(); } diff --git a/atom/browser/net/adapter_request_job.h b/atom/browser/net/adapter_request_job.h index 040738b649ab..768718584d03 100644 --- a/atom/browser/net/adapter_request_job.h +++ b/atom/browser/net/adapter_request_job.h @@ -10,6 +10,7 @@ #include "base/memory/ref_counted_memory.h" #include "base/memory/weak_ptr.h" #include "net/url_request/url_request_context.h" +#include "net/url_request/url_request_context_getter.h" #include "net/url_request/url_request_job.h" #include "net/url_request/url_request_job_factory.h" #include "v8/include/v8.h" @@ -61,9 +62,11 @@ class AdapterRequestJob : public net::URLRequestJob { const std::string& charset, scoped_refptr data); void CreateFileJobAndStart(const base::FilePath& path); - void CreateHttpJobAndStart(const GURL& url, - const std::string& method, - const std::string& referrer); + void CreateHttpJobAndStart( + net::URLRequestContextGetter* request_context_getter, + const GURL& url, + const std::string& method, + const std::string& referrer); void CreateJobFromProtocolHandlerAndStart(); private: diff --git a/atom/browser/net/url_request_fetch_job.cc b/atom/browser/net/url_request_fetch_job.cc index d823051ed8d9..5389b8bb6216 100644 --- a/atom/browser/net/url_request_fetch_job.cc +++ b/atom/browser/net/url_request_fetch_job.cc @@ -75,6 +75,7 @@ class ResponsePiper : public net::URLFetcherResponseWriter { } // namespace URLRequestFetchJob::URLRequestFetchJob( + net::URLRequestContextGetter* request_context_getter, net::URLRequest* request, net::NetworkDelegate* network_delegate, const GURL& url, @@ -90,7 +91,12 @@ URLRequestFetchJob::URLRequestFetchJob( request_type = GetRequestType(method); fetcher_.reset(net::URLFetcher::Create(url, request_type, this)); - fetcher_->SetRequestContext(GetRequestContext()); + // Use request context if provided else create one. + if (request_context_getter) + fetcher_->SetRequestContext(request_context_getter); + else + fetcher_->SetRequestContext(GetRequestContext()); + fetcher_->SaveResponseWithWriter(make_scoped_ptr(new ResponsePiper(this))); // Use |request|'s referrer if |referrer| is not specified. diff --git a/atom/browser/net/url_request_fetch_job.h b/atom/browser/net/url_request_fetch_job.h index 8f3a41056133..228af7904fe9 100644 --- a/atom/browser/net/url_request_fetch_job.h +++ b/atom/browser/net/url_request_fetch_job.h @@ -18,7 +18,8 @@ class AtomBrowserContext; class URLRequestFetchJob : public net::URLRequestJob, public net::URLFetcherDelegate { public: - URLRequestFetchJob(net::URLRequest* request, + URLRequestFetchJob(net::URLRequestContextGetter* request_context_getter, + net::URLRequest* request, net::NetworkDelegate* network_delegate, const GURL& url, const std::string& method, diff --git a/docs/api/protocol.md b/docs/api/protocol.md index a076e3640daa..38fd7e5ba160 100644 --- a/docs/api/protocol.md +++ b/docs/api/protocol.md @@ -101,6 +101,7 @@ Create a request job which sends a buffer as response. ## Class: protocol.RequestHttpJob(options) * `options` Object + * `session` [Session](browser-window.md#class-session) * `url` String * `method` String - Default is `GET` * `referrer` String From 7ab8134613577b9092f5e8e81f1c883174bee222 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 17 Jul 2015 00:54:57 +0800 Subject: [PATCH 0638/1293] Don't upload PDB files in CI Somehow it is blocking. --- script/upload.py | 4 ---- 1 file changed, 4 deletions(-) diff --git a/script/upload.py b/script/upload.py index 9757fe60635e..6fc421e6b7a2 100755 --- a/script/upload.py +++ b/script/upload.py @@ -90,10 +90,6 @@ def main(): upload_atom_shell(github, release, os.path.join(DIST_DIR, MKSNAPSHOT_NAME)) if PLATFORM == 'win32' and not tag_exists: - # Upload PDBs to Windows symbol server. - execute([sys.executable, - os.path.join(SOURCE_ROOT, 'script', 'upload-windows-pdb.py')]) - # Upload node headers. execute([sys.executable, os.path.join(SOURCE_ROOT, 'script', 'upload-node-headers.py'), From 135aca02af8aef5792984d47bf1c7a35a11f90a3 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 17 Jul 2015 01:01:25 +0800 Subject: [PATCH 0639/1293] Bump v0.30.0 --- atom.gyp | 2 +- atom/browser/resources/mac/Info.plist | 2 +- atom/browser/resources/win/atom.rc | 8 ++++---- atom/common/atom_version.h | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/atom.gyp b/atom.gyp index 83ea66adbabd..d8da82cd548f 100644 --- a/atom.gyp +++ b/atom.gyp @@ -4,7 +4,7 @@ 'product_name%': 'Electron', 'company_name%': 'GitHub, Inc', 'company_abbr%': 'github', - 'version%': '0.29.2', + 'version%': '0.30.0', }, 'includes': [ 'filenames.gypi', diff --git a/atom/browser/resources/mac/Info.plist b/atom/browser/resources/mac/Info.plist index edbeda36e8a5..68ce951ed4d4 100644 --- a/atom/browser/resources/mac/Info.plist +++ b/atom/browser/resources/mac/Info.plist @@ -17,7 +17,7 @@ CFBundleIconFile atom.icns CFBundleVersion - 0.29.2 + 0.30.0 LSMinimumSystemVersion 10.8.0 NSMainNibFile diff --git a/atom/browser/resources/win/atom.rc b/atom/browser/resources/win/atom.rc index 7f6d618d48dc..80714c55fd25 100644 --- a/atom/browser/resources/win/atom.rc +++ b/atom/browser/resources/win/atom.rc @@ -56,8 +56,8 @@ END // VS_VERSION_INFO VERSIONINFO - FILEVERSION 0,29,2,0 - PRODUCTVERSION 0,29,2,0 + FILEVERSION 0,30,0,0 + PRODUCTVERSION 0,30,0,0 FILEFLAGSMASK 0x3fL #ifdef _DEBUG FILEFLAGS 0x1L @@ -74,12 +74,12 @@ BEGIN BEGIN VALUE "CompanyName", "GitHub, Inc." VALUE "FileDescription", "Electron" - VALUE "FileVersion", "0.29.2" + VALUE "FileVersion", "0.30.0" VALUE "InternalName", "electron.exe" VALUE "LegalCopyright", "Copyright (C) 2015 GitHub, Inc. All rights reserved." VALUE "OriginalFilename", "electron.exe" VALUE "ProductName", "Electron" - VALUE "ProductVersion", "0.29.2" + VALUE "ProductVersion", "0.30.0" VALUE "SquirrelAwareVersion", "1" END END diff --git a/atom/common/atom_version.h b/atom/common/atom_version.h index f8543df72785..64d0c7bfd73d 100644 --- a/atom/common/atom_version.h +++ b/atom/common/atom_version.h @@ -6,8 +6,8 @@ #define ATOM_VERSION_H #define ATOM_MAJOR_VERSION 0 -#define ATOM_MINOR_VERSION 29 -#define ATOM_PATCH_VERSION 2 +#define ATOM_MINOR_VERSION 30 +#define ATOM_PATCH_VERSION 0 #define ATOM_VERSION_IS_RELEASE 1 From 666aca7803d1287d4765adaa8408f41189b42b99 Mon Sep 17 00:00:00 2001 From: "Michael S. Barthelemy" Date: Thu, 16 Jul 2015 13:54:51 -0400 Subject: [PATCH 0640/1293] add function maintainAspectRatioOfInteriorContent to BrowserWindow in order to enforce an aspect ratio for an electron window --- atom/browser/api/atom_api_window.cc | 5 +++++ atom/browser/api/atom_api_window.h | 1 + atom/browser/native_window.cc | 13 +++++++++++++ atom/browser/native_window.h | 7 +++++++ atom/browser/native_window_mac.mm | 27 +++++++++++++++++++++++++++ 5 files changed, 53 insertions(+) diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index d5bce5891135..ae907b0669d5 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -249,6 +249,10 @@ bool Window::IsFullscreen() { return window_->IsFullscreen(); } +void Window::MaintainAspectRatioOfInteriorContent(double aspectRatio, double extraWidth, double extraHeight) { + window_->MaintainAspectRatioOfInteriorContent(aspectRatio, gfx::Size(extraWidth, extraHeight)); +} + void Window::SetBounds(const gfx::Rect& bounds) { window_->SetBounds(bounds); } @@ -498,6 +502,7 @@ void Window::BuildPrototype(v8::Isolate* isolate, .SetMethod("isMinimized", &Window::IsMinimized) .SetMethod("setFullScreen", &Window::SetFullScreen) .SetMethod("isFullScreen", &Window::IsFullscreen) + .SetMethod("maintainAspectRatioOfInteriorContent", &Window::MaintainAspectRatioOfInteriorContent) .SetMethod("getBounds", &Window::GetBounds) .SetMethod("setBounds", &Window::SetBounds) .SetMethod("getSize", &Window::GetSize) diff --git a/atom/browser/api/atom_api_window.h b/atom/browser/api/atom_api_window.h index 5cdb49e41bbf..8c27f5b36a6f 100644 --- a/atom/browser/api/atom_api_window.h +++ b/atom/browser/api/atom_api_window.h @@ -95,6 +95,7 @@ class Window : public mate::TrackableObject, bool IsMinimized(); void SetFullScreen(bool fullscreen); bool IsFullscreen(); + void MaintainAspectRatioOfInteriorContent(double aspectRatio, double extraWidth, double extraHeight); void SetBounds(const gfx::Rect& bounds); gfx::Rect GetBounds(); void SetSize(int width, int height); diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 2a093cc81200..8e21876fdfa3 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -195,6 +195,19 @@ void NativeWindow::InitFromOptions(const mate::Dictionary& options) { Show(); } +double NativeWindow::GetInteriorContentAspectRatio() { + return interiorContentAspectRatio; +} + +gfx::Size NativeWindow::GetInteriorContentExtraSize() { + return interiorContentExtraSize; +} + +void NativeWindow::MaintainAspectRatioOfInteriorContent(double aspectRatio, const gfx::Size& extraSize) { + interiorContentAspectRatio = aspectRatio; + interiorContentExtraSize = extraSize; +} + void NativeWindow::SetSize(const gfx::Size& size) { SetBounds(gfx::Rect(GetPosition(), size)); } diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index 0ac7aa50c915..e9e159a7ea3b 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -107,6 +107,9 @@ class NativeWindow : public content::WebContentsObserver, virtual bool IsMinimized() = 0; virtual void SetFullScreen(bool fullscreen) = 0; virtual bool IsFullscreen() const = 0; + double GetInteriorContentAspectRatio(); + virtual gfx::Size GetInteriorContentExtraSize(); + virtual void MaintainAspectRatioOfInteriorContent(double aspectRatio, const gfx::Size& extraSize); virtual void SetBounds(const gfx::Rect& bounds) = 0; virtual gfx::Rect GetBounds() = 0; virtual void SetSize(const gfx::Size& size); @@ -285,6 +288,10 @@ class NativeWindow : public content::WebContentsObserver, // Page's default zoom factor. double zoom_factor_; + // Used to maintain the aspect ratio of a view which is inside of the content view. + double interiorContentAspectRatio = 0.0; + gfx::Size interiorContentExtraSize; + // The page this window is viewing. brightray::InspectableWebContents* inspectable_web_contents_; diff --git a/atom/browser/native_window_mac.mm b/atom/browser/native_window_mac.mm index c0d358bb8f72..de7e8ad77967 100644 --- a/atom/browser/native_window_mac.mm +++ b/atom/browser/native_window_mac.mm @@ -95,6 +95,33 @@ static const CGFloat kAtomWindowCornerRadius = 4.0; shell_->NotifyWindowBlur(); } +- (NSSize)windowWillResize:(NSWindow *)sender toSize:(NSSize)frameSize { + NSSize newSize = frameSize; + double interiorContentAspectRatio = shell_->GetInteriorContentAspectRatio(); + + if (interiorContentAspectRatio > 0.0) { + NSRect windowFrame = [sender frame]; + NSRect contentViewBounds = [[sender contentView] bounds]; + gfx::Size interiorContentExtraSize = shell_->GetInteriorContentExtraSize(); + double extraWidthPlusFrame = windowFrame.size.width - contentViewBounds.size.width + interiorContentExtraSize.width(); + double extraHeightPlusFrame = windowFrame.size.height - contentViewBounds.size.height + interiorContentExtraSize.height(); + + newSize.width = roundf(((frameSize.height - extraHeightPlusFrame) * interiorContentAspectRatio) + extraWidthPlusFrame); + + // If the new width is less than the frame size use it as the primary constraint. This ensures that the value returned + // by this method will never be larger than the users requested window size. + if (newSize.width < frameSize.width) { + newSize.height = roundf(((newSize.width - extraWidthPlusFrame) / interiorContentAspectRatio) + extraHeightPlusFrame); + } + else { + newSize.width = roundf(((newSize.height - extraHeightPlusFrame) * interiorContentAspectRatio) + extraWidthPlusFrame); + newSize.height = roundf(((frameSize.width - extraWidthPlusFrame) / interiorContentAspectRatio) + extraHeightPlusFrame); + } + } + + return newSize; +} + - (void)windowDidResize:(NSNotification*)notification { if (!shell_->has_frame()) shell_->ClipWebView(); From 10faf314d4ba72b62875ee603eb7154459f95dbc Mon Sep 17 00:00:00 2001 From: "Michael S. Barthelemy" Date: Thu, 16 Jul 2015 14:26:48 -0400 Subject: [PATCH 0641/1293] fix line length issue --- atom/browser/native_window.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index e9e159a7ea3b..248a8a5338d7 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -288,7 +288,8 @@ class NativeWindow : public content::WebContentsObserver, // Page's default zoom factor. double zoom_factor_; - // Used to maintain the aspect ratio of a view which is inside of the content view. + // Used to maintain the aspect ratio of a view which is inside of the + // content view. double interiorContentAspectRatio = 0.0; gfx::Size interiorContentExtraSize; From 7cdfa4443875aad549ef1d7eddbc9abeb481abab Mon Sep 17 00:00:00 2001 From: "Michael S. Barthelemy" Date: Thu, 16 Jul 2015 14:31:01 -0400 Subject: [PATCH 0642/1293] shorten names --- atom/browser/api/atom_api_window.cc | 6 +++--- atom/browser/api/atom_api_window.h | 2 +- atom/browser/native_window.cc | 2 +- atom/browser/native_window.h | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index ae907b0669d5..85fbcb872bc0 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -249,8 +249,8 @@ bool Window::IsFullscreen() { return window_->IsFullscreen(); } -void Window::MaintainAspectRatioOfInteriorContent(double aspectRatio, double extraWidth, double extraHeight) { - window_->MaintainAspectRatioOfInteriorContent(aspectRatio, gfx::Size(extraWidth, extraHeight)); +void Window::MaintainContentAspectRatio(double aspectRatio, double width, double height) { + window_->MaintainContentAspectRatio(aspectRatio, gfx::Size(width, height)); } void Window::SetBounds(const gfx::Rect& bounds) { @@ -502,7 +502,7 @@ void Window::BuildPrototype(v8::Isolate* isolate, .SetMethod("isMinimized", &Window::IsMinimized) .SetMethod("setFullScreen", &Window::SetFullScreen) .SetMethod("isFullScreen", &Window::IsFullscreen) - .SetMethod("maintainAspectRatioOfInteriorContent", &Window::MaintainAspectRatioOfInteriorContent) + .SetMethod("maintainContentAspectRatio", &Window::MaintainContentAspectRatio) .SetMethod("getBounds", &Window::GetBounds) .SetMethod("setBounds", &Window::SetBounds) .SetMethod("getSize", &Window::GetSize) diff --git a/atom/browser/api/atom_api_window.h b/atom/browser/api/atom_api_window.h index 8c27f5b36a6f..21f61b5d5e00 100644 --- a/atom/browser/api/atom_api_window.h +++ b/atom/browser/api/atom_api_window.h @@ -95,7 +95,7 @@ class Window : public mate::TrackableObject, bool IsMinimized(); void SetFullScreen(bool fullscreen); bool IsFullscreen(); - void MaintainAspectRatioOfInteriorContent(double aspectRatio, double extraWidth, double extraHeight); + void MaintainContentAspectRatio(double aspectRatio, double width, double height); void SetBounds(const gfx::Rect& bounds); gfx::Rect GetBounds(); void SetSize(int width, int height); diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 8e21876fdfa3..5014c041cf7b 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -203,7 +203,7 @@ gfx::Size NativeWindow::GetInteriorContentExtraSize() { return interiorContentExtraSize; } -void NativeWindow::MaintainAspectRatioOfInteriorContent(double aspectRatio, const gfx::Size& extraSize) { +void NativeWindow::MaintainContentAspectRatio(double aspectRatio, const gfx::Size& extraSize) { interiorContentAspectRatio = aspectRatio; interiorContentExtraSize = extraSize; } diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index 248a8a5338d7..b73ff47dbdf7 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -109,7 +109,7 @@ class NativeWindow : public content::WebContentsObserver, virtual bool IsFullscreen() const = 0; double GetInteriorContentAspectRatio(); virtual gfx::Size GetInteriorContentExtraSize(); - virtual void MaintainAspectRatioOfInteriorContent(double aspectRatio, const gfx::Size& extraSize); + virtual void MaintainContentAspectRatio(double aspectRatio, const gfx::Size& extraSize); virtual void SetBounds(const gfx::Rect& bounds) = 0; virtual gfx::Rect GetBounds() = 0; virtual void SetSize(const gfx::Size& size); From d0c61766409f5b23280142b06a34c15e462e6dcd Mon Sep 17 00:00:00 2001 From: "Michael S. Barthelemy" Date: Thu, 16 Jul 2015 14:45:27 -0400 Subject: [PATCH 0643/1293] wrap lines to meet Travis CI build requirements --- atom/browser/api/atom_api_window.cc | 6 ++++-- atom/browser/api/atom_api_window.h | 3 ++- atom/browser/native_window.cc | 3 ++- atom/browser/native_window.h | 3 ++- 4 files changed, 10 insertions(+), 5 deletions(-) diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index 85fbcb872bc0..e6d4ff4d4134 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -249,7 +249,8 @@ bool Window::IsFullscreen() { return window_->IsFullscreen(); } -void Window::MaintainContentAspectRatio(double aspectRatio, double width, double height) { +void Window::MaintainContentAspectRatio(double aspectRatio, + double width, double height) { window_->MaintainContentAspectRatio(aspectRatio, gfx::Size(width, height)); } @@ -502,7 +503,8 @@ void Window::BuildPrototype(v8::Isolate* isolate, .SetMethod("isMinimized", &Window::IsMinimized) .SetMethod("setFullScreen", &Window::SetFullScreen) .SetMethod("isFullScreen", &Window::IsFullscreen) - .SetMethod("maintainContentAspectRatio", &Window::MaintainContentAspectRatio) + .SetMethod("maintainContentAspectRatio", + &Window::MaintainContentAspectRatio) .SetMethod("getBounds", &Window::GetBounds) .SetMethod("setBounds", &Window::SetBounds) .SetMethod("getSize", &Window::GetSize) diff --git a/atom/browser/api/atom_api_window.h b/atom/browser/api/atom_api_window.h index 21f61b5d5e00..313892a6b286 100644 --- a/atom/browser/api/atom_api_window.h +++ b/atom/browser/api/atom_api_window.h @@ -95,7 +95,8 @@ class Window : public mate::TrackableObject, bool IsMinimized(); void SetFullScreen(bool fullscreen); bool IsFullscreen(); - void MaintainContentAspectRatio(double aspectRatio, double width, double height); + void MaintainContentAspectRatio(double aspectRatio, + double width, double height); void SetBounds(const gfx::Rect& bounds); gfx::Rect GetBounds(); void SetSize(int width, int height); diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 5014c041cf7b..544bfad46870 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -203,7 +203,8 @@ gfx::Size NativeWindow::GetInteriorContentExtraSize() { return interiorContentExtraSize; } -void NativeWindow::MaintainContentAspectRatio(double aspectRatio, const gfx::Size& extraSize) { +void NativeWindow::MaintainContentAspectRatio(double aspectRatio, + const gfx::Size& extraSize) { interiorContentAspectRatio = aspectRatio; interiorContentExtraSize = extraSize; } diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index b73ff47dbdf7..ee0628422270 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -109,7 +109,8 @@ class NativeWindow : public content::WebContentsObserver, virtual bool IsFullscreen() const = 0; double GetInteriorContentAspectRatio(); virtual gfx::Size GetInteriorContentExtraSize(); - virtual void MaintainContentAspectRatio(double aspectRatio, const gfx::Size& extraSize); + virtual void MaintainContentAspectRatio(double aspectRatio, + const gfx::Size& extraSize); virtual void SetBounds(const gfx::Rect& bounds) = 0; virtual gfx::Rect GetBounds() = 0; virtual void SetSize(const gfx::Size& size); From de3ccc4b98fd2275b64e22fae41d19322ddc1b4b Mon Sep 17 00:00:00 2001 From: Robo Date: Fri, 17 Jul 2015 02:00:43 +0530 Subject: [PATCH 0644/1293] use current session when not defined --- atom/browser/api/atom_api_protocol.cc | 10 ++++++---- atom/browser/api/atom_api_protocol.h | 3 +++ atom/browser/api/atom_api_session.cc | 4 ---- atom/browser/api/atom_api_session.h | 2 +- 4 files changed, 10 insertions(+), 9 deletions(-) diff --git a/atom/browser/api/atom_api_protocol.cc b/atom/browser/api/atom_api_protocol.cc index 3b9eeb9fb783..d7af58802792 100644 --- a/atom/browser/api/atom_api_protocol.cc +++ b/atom/browser/api/atom_api_protocol.cc @@ -39,7 +39,7 @@ template<> struct Converter { static bool FromV8(v8::Isolate* isolate, v8::Local val, net::URLRequestContextGetter** out) { - if (val->IsNull() || val->IsUndefined()) { + if (val->IsNull()) { *out = nullptr; return true; } @@ -47,7 +47,7 @@ struct Converter { atom::api::Session* session; if (!Converter::FromV8(isolate, val, &session)) return false; - *out = session->GetBrowserContext()->GetRequestContext(); + *out = session->browser_context()->GetRequestContext(); return true; } }; @@ -144,7 +144,8 @@ class CustomProtocolRequestJob : public AdapterRequestJob { } else if (name == "RequestHttpJob") { GURL url; std::string method, referrer; - net::URLRequestContextGetter* getter; + net::URLRequestContextGetter* getter = + registry_->browser_context()->GetRequestContext(); dict.Get("url", &url); dict.Get("method", &method); dict.Get("referrer", &referrer); @@ -231,7 +232,8 @@ std::string ConvertErrorCode(int error_code) { } // namespace Protocol::Protocol(AtomBrowserContext* browser_context) - : job_factory_(browser_context->job_factory()) { + : browser_context_(browser_context), + job_factory_(browser_context->job_factory()) { CHECK(job_factory_); } diff --git a/atom/browser/api/atom_api_protocol.h b/atom/browser/api/atom_api_protocol.h index 3e6f950241cb..b4d56018baf3 100644 --- a/atom/browser/api/atom_api_protocol.h +++ b/atom/browser/api/atom_api_protocol.h @@ -46,6 +46,8 @@ class Protocol : public mate::EventEmitter { JsProtocolHandler GetProtocolHandler(const std::string& scheme); + AtomBrowserContext* browser_context() const { return browser_context_; } + protected: explicit Protocol(AtomBrowserContext* browser_context); @@ -92,6 +94,7 @@ class Protocol : public mate::EventEmitter { const JsProtocolHandler& handler); int UninterceptProtocolInIO(const std::string& scheme); + AtomBrowserContext* browser_context_; AtomURLRequestJobFactory* job_factory_; ProtocolHandlersMap protocol_handlers_; diff --git a/atom/browser/api/atom_api_session.cc b/atom/browser/api/atom_api_session.cc index b489df4c44ef..93f8de52dd45 100644 --- a/atom/browser/api/atom_api_session.cc +++ b/atom/browser/api/atom_api_session.cc @@ -203,10 +203,6 @@ Session::Session(AtomBrowserContext* browser_context) Session::~Session() { } -AtomBrowserContext* Session::GetBrowserContext() const { - return browser_context_; -} - void Session::ResolveProxy(const GURL& url, ResolveProxyCallback callback) { new ResolveProxyHelper(browser_context_, url, callback); } diff --git a/atom/browser/api/atom_api_session.h b/atom/browser/api/atom_api_session.h index debe01ef9dbc..8e14c3a37834 100644 --- a/atom/browser/api/atom_api_session.h +++ b/atom/browser/api/atom_api_session.h @@ -31,7 +31,7 @@ class Session: public mate::TrackableObject { static mate::Handle CreateFrom( v8::Isolate* isolate, AtomBrowserContext* browser_context); - AtomBrowserContext* GetBrowserContext() const; + AtomBrowserContext* browser_context() const { return browser_context_; } protected: explicit Session(AtomBrowserContext* browser_context); From 8cf9df2d8d75960460d36714f8503768278e6911 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 16 Jul 2015 15:17:45 -0700 Subject: [PATCH 0645/1293] docs: Mention null session of RequestHttpJob --- docs/api/protocol.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/api/protocol.md b/docs/api/protocol.md index ad863f4c74fb..03e979615fe2 100644 --- a/docs/api/protocol.md +++ b/docs/api/protocol.md @@ -110,7 +110,9 @@ Create a request job which sends a buffer as response. ## Class: protocol.RequestHttpJob(options) * `options` Object - * `session` [Session](browser-window.md#class-session) + * `session` [Session](browser-window.md#class-session) - By default it is + the app's default session, setting it to `null` will create a new session + for the requests * `url` String * `method` String - Default is `GET` * `referrer` String From 72d332dfa046e79a94eb3745ce7e8b0d855b572b Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Fri, 17 Jul 2015 09:18:16 +0900 Subject: [PATCH 0646/1293] Translate little files into korean --- docs/api/auto-updater-ko.md | 38 ++++++++++++++-------------------- docs/api/content-tracing-ko.md | 2 +- docs/api/remote-ko.md | 2 +- 3 files changed, 17 insertions(+), 25 deletions(-) diff --git a/docs/api/auto-updater-ko.md b/docs/api/auto-updater-ko.md index bcfc3b562682..9466bd190957 100644 --- a/docs/api/auto-updater-ko.md +++ b/docs/api/auto-updater-ko.md @@ -2,38 +2,30 @@ **이 모듈은 현재 OS X에서만 사용할 수 있습니다.** -Check out [atom/grunt-electron-installer](https://github.com/atom/grunt-electron-installer) -for building a Windows installer for your app. +Windows 어플리케이션 인스톨러를 생성하려면 [atom/grunt-electron-installer](https://github.com/atom/grunt-electron-installer)를 참고하세요. -The `auto-updater` module is a simple wrap around the -[Squirrel.Mac](https://github.com/Squirrel/Squirrel.Mac) framework. +`auto-updater` 모듈은 [Squirrel.Mac](https://github.com/Squirrel/Squirrel.Mac) 프레임워크의 간단한 Wrapper입니다. -Squirrel.Mac requires that your `.app` folder is signed using the +Squirrel.Mac은 업데이트 설치를 위해 `.app` 폴더에 [codesign](https://developer.apple.com/library/mac/documentation/Darwin/Reference/ManPages/man1/codesign.1.html) -utility for updates to be installed. +툴을 사용한 서명을 요구합니다. ## Squirrel -Squirrel is an OS X framework focused on making application updates **as safe -and transparent as updates to a website**. +Squirrel은 어플리케이션이 **안전하고 투명한 웹사이트 업데이트**를 할 수 있도록 하는데 초점이 맞춰진 OS X 프레임워크입니다. -Instead of publishing a feed of versions from which your app must select, -Squirrel updates to the version your server tells it to. This allows you to -intelligently update your clients based on the request you give to Squirrel. +Squirrel은 사용자에게 어플리케이션의 업데이트를 알릴 필요 없이 서버가 지시하는 버전을 받아온 후 자동으로 업데이트합니다. +이 기능을 사용하면 Squirrel을 통해 클라이언트의 어플리케이션을 지능적으로 업데이트 할 수 있습니다. -Your request can include authentication details, custom headers or a request -body so that your server has the context it needs in order to supply the most -suitable update. +요청시 커스텀 헤더 또는 요청 본문에 인증 정보를 포함시킬 수도 있습니다. +서버에선 이러한 요청을 분류 처리하여 적당한 업데이트를 제공할 수 있습니다. -The update JSON Squirrel requests should be dynamically generated based on -criteria in the request, and whether an update is required. Squirrel relies -on server side support for determining whether an update is required, see -[Server Support](#server-support). +Squirrel JSON 업데이트 요청시 처리는 반드시 어떤 업데이트가 필요한지 요청의 기준에 맞춰 동적으로 생성되어야 합니다. +Squirrel은 사용해야 하는 업데이트 선택하는 과정을 서버에 의존합니다. [서버 지원](#server-support)을 참고하세요. -Squirrel's installer is also designed to be fault tolerant, and ensure that any -updates installed are valid. +Squirrel의 인스톨러는 오류에 관대하게 설계되었습니다. 그리고 업데이트가 유효한지 확인합니다. -## Update Requests +## 업데이트 요청 Squirrel is indifferent to the request the client application provides for update checking. `Accept: application/json` is added to the request headers @@ -59,7 +51,7 @@ var autoUpdater = require('auto-updater'); autoUpdater.setFeedUrl('http://mycompany.com/myapp/latest?version=' + app.getVersion()); ``` -## Server Support +## 서버 지원 Your server should determine whether an update is required based on the [Update Request](#update-requests) your client issues. @@ -75,7 +67,7 @@ If no update is required your server must respond with a status code of [204 No Content](http://tools.ietf.org/html/rfc2616#section-10.2.5). Squirrel will check for an update again at the interval you specify. -## Update JSON Format +## JSON 포맷 업데이트 When an update is available, Squirrel expects the following schema in response to the update request provided: diff --git a/docs/api/content-tracing-ko.md b/docs/api/content-tracing-ko.md index a66a4635bdbd..defa29fda959 100644 --- a/docs/api/content-tracing-ko.md +++ b/docs/api/content-tracing-ko.md @@ -20,7 +20,7 @@ tracing.startRecording('*', tracing.DEFAULT_OPTIONS, function() { * `callback` Function -카테고리 그룹 set을 가져옵니다. 카테고리 그룹은 도달 대상이 되는 코드 경로를 변경할 수 있습니다. +카테고리 그룹 세트를 가져옵니다. 카테고리 그룹은 도달 대상이 되는 코드 경로를 변경할 수 있습니다. Get a set of category groups. The category groups can change as new code paths are reached. diff --git a/docs/api/remote-ko.md b/docs/api/remote-ko.md index 11d62dd27194..a4e1d46ed2ef 100644 --- a/docs/api/remote-ko.md +++ b/docs/api/remote-ko.md @@ -21,7 +21,7 @@ win.loadUrl('https://github.com'); Note: for the reverse (access renderer process from main process), you can use [webContents.executeJavascript](https://github.com/atom/electron/blob/master/docs/api/browser-window-ko.md#browserwindowwebcontents). -## Remote objects +## Remote 객체 Each object (including functions) returned by the `remote` module represents an object in the main process (we call it a remote object or remote function). From 0b7a1a1eef075628a1d4c1d1c654e51ed9c2166d Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Fri, 17 Jul 2015 13:28:13 +0900 Subject: [PATCH 0647/1293] Fix typos, Improve grammer --- docs/README-ko.md | 4 ---- docs/api/auto-updater-ko.md | 2 +- docs/api/global-shortcut-ko.md | 5 +++-- docs/api/protocol-ko.md | 20 ++++++++++++++------ docs/tutorial/quick-start-ko.md | 4 ++-- 5 files changed, 20 insertions(+), 15 deletions(-) diff --git a/docs/README-ko.md b/docs/README-ko.md index 135d6b5c657f..b48c6a42c516 100644 --- a/docs/README-ko.md +++ b/docs/README-ko.md @@ -66,7 +66,3 @@ * [빌드 설명서 (Windows)](development/build-instructions-windows-ko.md) * [빌드 설명서 (Linux)](development/build-instructions-linux-ko.md) * [디버거에서 디버그 심볼 서버 설정](development/setting-up-symbol-server-ko.md) - -이 참조문서는 [@preco21](https://github.com/preco21)에 의해 번역되었습니다. -문서내에서 오타나 잘못된 번역을 발견하면 `plusb21@gmail.com` 이메일로 알려주시면 감사하겠습니다. -문서는 항시 최신버전을 유지할 수 없으므로 원본을 같이 참고하는 것을 권장합니다. diff --git a/docs/api/auto-updater-ko.md b/docs/api/auto-updater-ko.md index 9466bd190957..ca23a4ad114b 100644 --- a/docs/api/auto-updater-ko.md +++ b/docs/api/auto-updater-ko.md @@ -77,7 +77,7 @@ to the update request provided: "url": "http://mycompany.com/myapp/releases/myrelease", "name": "My Release Name", "notes": "Theses are some release notes innit", - "pub_date": "2013-09-18T12:29:53+01:00", + "pub_date": "2013-09-18T12:29:53+01:00" } ``` diff --git a/docs/api/global-shortcut-ko.md b/docs/api/global-shortcut-ko.md index 6ad3fb5109fc..25c1d320870e 100644 --- a/docs/api/global-shortcut-ko.md +++ b/docs/api/global-shortcut-ko.md @@ -1,8 +1,9 @@ # global-shortcut -`global-shortcut` 모듈은 사용자가 다양한 단축키 작업을 정의 할 수 있도록 운영체제의 전역 키보드 단축키를 설정 등록/해제 하는 방법을 제공합니다. +`global-shortcut` 모듈은 운영체제의 전역 키보드 단축키를 설정 등록/해제 하는 방법을 제공합니다. +이 모듈을 사용하여 사용자가 다양한 단축키 작업을 할 수 있도록 단축키를 정의 할 수 있습니다. 참고로 설정된 단축키는 어플리케이션이 백그라운드로 작동(창이 포커스 되지 않음) 할 때도 여전히 계속 작동합니다. -이 모듈은 `app` 모듈의 `ready` 이밴트 이전에 사용할 수 없습니다. +이 모듈은 `app` 모듈의 `ready` 이벤트 이전에 사용할 수 없습니다. ```javascript var app = require('app'); diff --git a/docs/api/protocol-ko.md b/docs/api/protocol-ko.md index ef1e15ebf03d..3c0152fd2484 100644 --- a/docs/api/protocol-ko.md +++ b/docs/api/protocol-ko.md @@ -32,6 +32,9 @@ app.on('ready', function() { `handler` 함수에선 요청에 대한 해당 프로토콜의 작업 결과를 응답(반환) 해야 합니다. +기본적으로 스킴은 `http:`와 비슷합니다. `file:`과 같이 "표준 URI 구문"을 다르게 해석되게 하려면 +`protocol.registerStandardSchemes` 메서드를 이용해서 사용자 정의 스킴을 표준 스킴으로 만들 수 있습니다. + ## protocol.unregisterProtocol(scheme, callback) * `scheme` String @@ -43,7 +46,10 @@ app.on('ready', function() { * `value` Array -지정한 `value` 배열을 사용하여 미리 지정된 스킴으로 등록합니다. +지정한 `value` 배열을 사용하여 미리 지정된 표준 스킴으로 등록합니다. + +표준 스킴은 RFC 3986 [표준 URI 구문](https://tools.ietf.org/html/rfc3986#section-3)에 해당합니다. +이 표준은 `file:`과 `filesystem:`을 포함합니다. ## protocol.isHandledProtocol(scheme, callback) @@ -78,8 +84,8 @@ app.on('ready', function() { ## Class: protocol.RequestStringJob(options) * `options` Object - * `mimeType` String - `text/plain`이 기본 - * `charset` String - `UTF-8`이 기본 + * `mimeType` String - 기본값: `text/plain` + * `charset` String - 기본값: `UTF-8` * `data` String 문자열을 반환하는 request 작업을 생성합니다. @@ -87,8 +93,8 @@ app.on('ready', function() { ## Class: protocol.RequestBufferJob(options) * `options` Object - * `mimeType` String - Default is `application/octet-stream` - * `encoding` String - Default is `UTF-8` + * `mimeType` String - 기본값: `application/octet-stream` + * `encoding` String - 기본값: `UTF-8` * `data` Buffer 버퍼를 반환하는 request 작업을 생성합니다. @@ -96,8 +102,10 @@ app.on('ready', function() { ## Class: protocol.RequestHttpJob(options) * `options` Object + * `session` [Session](browser-window.md#class-session) - 기본적으로 이 옵션은 어플리케이션의 기본 세션입니다. + `null`로 설정하면 요청을 위한 새로운 세션을 만듭니다. * `url` String - * `method` String - Default is `GET` + * `method` String - 기본값: `GET` * `referrer` String `url`의 요청 결과를 그대로 반환하는 request 작업을 생성합니다. diff --git a/docs/tutorial/quick-start-ko.md b/docs/tutorial/quick-start-ko.md index a49b7e017609..cba30e30dbf9 100644 --- a/docs/tutorial/quick-start-ko.md +++ b/docs/tutorial/quick-start-ko.md @@ -75,8 +75,8 @@ var mainWindow = null; // 모든 창이 닫히면 어플리케이션 종료. app.on('window-all-closed', function() { - // OSX의 대부분의 어플리케이션에선 유저가 Cmd + Q 커맨드로 확실하게 종료하기 전까지는 - // 어플리케이션이 메뉴바에 남아 계속 실행됩니다. + // OS X의 대부분의 어플리케이션은 유저가 Cmd + Q 커맨드로 확실하게 종료하기 전까지 + // 메뉴바에 남아 계속 실행됩니다. if (process.platform != 'darwin') { app.quit(); } From 6656afd57f70a06a71107a92d4848ad6c6a98d98 Mon Sep 17 00:00:00 2001 From: "Michael S. Barthelemy" Date: Fri, 17 Jul 2015 10:25:30 -0400 Subject: [PATCH 0648/1293] fix bug with computing the case where we should constrain via height --- atom/browser/native_window_mac.mm | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/atom/browser/native_window_mac.mm b/atom/browser/native_window_mac.mm index de7e8ad77967..f543aae1628d 100644 --- a/atom/browser/native_window_mac.mm +++ b/atom/browser/native_window_mac.mm @@ -114,8 +114,8 @@ static const CGFloat kAtomWindowCornerRadius = 4.0; newSize.height = roundf(((newSize.width - extraWidthPlusFrame) / interiorContentAspectRatio) + extraHeightPlusFrame); } else { - newSize.width = roundf(((newSize.height - extraHeightPlusFrame) * interiorContentAspectRatio) + extraWidthPlusFrame); newSize.height = roundf(((frameSize.width - extraWidthPlusFrame) / interiorContentAspectRatio) + extraHeightPlusFrame); + newSize.width = roundf(((newSize.height - extraHeightPlusFrame) * interiorContentAspectRatio) + extraWidthPlusFrame); } } From 5010c15ffc431004c489dc4ada2662c3dbe5d924 Mon Sep 17 00:00:00 2001 From: Jeffrey Morgan Date: Sat, 18 Jul 2015 15:40:01 +0100 Subject: [PATCH 0649/1293] Improve grammar and sentence structure of app.md Improve the grammar and sentence structure of app.md. Replace references to Mac with OS X for consistency with other docs and use the OS X nomenclature of notification rather than message. --- docs/api/app.md | 148 ++++++++++++++++++++++++------------------------ 1 file changed, 74 insertions(+), 74 deletions(-) diff --git a/docs/api/app.md b/docs/api/app.md index 99576c4e4161..7e47b446f6d3 100644 --- a/docs/api/app.md +++ b/docs/api/app.md @@ -1,8 +1,8 @@ # app -The `app` module is responsible for controlling the application's life time. +The `app` module is responsible for controlling the application's lifecycle. -The example of quitting the whole application when the last window is closed: +The following example shows how to quit the application when the last window is closed: ```javascript var app = require('app'); @@ -13,26 +13,26 @@ app.on('window-all-closed', function() { ## Event: will-finish-launching -Emitted when application has done basic startup. On Windows and Linux it is the -same with `ready` event, on OS X this event represents the -`applicationWillFinishLaunching` message of `NSApplication`, usually you would -setup listeners to `open-file` and `open-url` events here, and start the crash -reporter and auto updater. +Emitted when the application has finished basic startup. On Windows and Linux, +the `will-finish-launching` event is the same as the `ready` event; on OS X, +this event represents the `applicationWillFinishLaunching` notification of `NSApplication`. +You would usually set up listeners for the `open-file` and `open-url` events here, +and start the crash reporter and auto updater. -Under most cases you should just do everything in `ready` event. +In most cases, you should just do everything in the `ready` event handler. ## Event: ready -Emitted when Electron has done everything initialization. +Emitted when Electron has finsished initialization. ## Event: window-all-closed Emitted when all windows have been closed. -This event is only emitted when the application is not going to quit. If a +This event is only emitted when the application is not going to quit. If the user pressed `Cmd + Q`, or the developer called `app.quit()`, Electron would -first try to close all windows and then emit the `will-quit` event, and in -this case the `window-all-closed` would not be emitted. +first try to close all the windows and then emit the `will-quit` event, and in +this case the `window-all-closed` event would not be emitted. ## Event: before-quit @@ -50,23 +50,23 @@ Emitted when all windows have been closed and the application will quit. Calling `event.preventDefault()` will prevent the default behaviour, which is terminating the application. -See description of `window-all-closed` for the differences between `will-quit` -and it. +See the description of the `window-all-closed` event for the differences between the `will-quit` +and `window-all-closed` events. ## Event: quit -Emitted when application is quitting. +Emitted when the application is quitting. ## Event: open-file * `event` Event * `path` String -Emitted when user wants to open a file with the application, it usually happens -when the application is already opened and then OS wants to reuse the -application to open file. But it is also emitted when a file is dropped onto the -dock and the application is not yet running. Make sure to listen to open-file -very early in your application startup to handle this case (even before the +Emitted when the user wants to open a file with the application. The `open-file` event +is usually emitted when the application is already open and the OS wants to reuse the +application to open the file. `open-file` is also emitted when a file is dropped onto the +dock and the application is not yet running. Make sure to listen for the `open-file` +event very early in your application startup to handle this case (even before the `ready` event is emitted). You should call `event.preventDefault()` if you want to handle this event. @@ -76,16 +76,16 @@ You should call `event.preventDefault()` if you want to handle this event. * `event` Event * `url` String -Emitted when user wants to open a URL with the application, this URL scheme +Emitted when the user wants to open a URL with the application. The URL scheme must be registered to be opened by your application. You should call `event.preventDefault()` if you want to handle this event. ## Event: activate-with-no-open-windows -Emitted when the application is activated while there is no opened windows. It -usually happens when user has closed all of application's windows and then -click on the application's dock icon. +Emitted when the application is activated while there are no open windows, which +usually happens when the user has closed all of the application's windows and then +clicks on the application's dock icon. ## Event: browser-window-blur @@ -103,7 +103,7 @@ Emitted when a [browserWindow](browser-window.md) gets focused. ### Event: 'select-certificate' -Emitted when client certificate is requested. +Emitted when a client certificate is requested. * `event` Event * `webContents` [WebContents](browser-window.md#class-webcontents) @@ -120,24 +120,24 @@ app.on('select-certificate', function(event, host, url, list, callback) { }) ``` -`url` corresponds to the navigation entry requesting the client certificate, +`url` corresponds to the navigation entry requesting the client certificate. `callback` needs to be called with an entry filtered from the list. -`event.preventDefault()` prevents from using the first certificate from -the store. +`event.preventDefault()` prevents the application from using the first certificate +from the store. ### Event: 'gpu-process-crashed' -Emitted when the gpu process is crashed. +Emitted when the gpu process crashes. ## app.quit() Try to close all windows. The `before-quit` event will first be emitted. If all windows are successfully closed, the `will-quit` event will be emitted and by -default the application would be terminated. +default the application will terminate. -This method guarantees all `beforeunload` and `unload` handlers are correctly +This method guarantees that all `beforeunload` and `unload` event handlers are correctly executed. It is possible that a window cancels the quitting by returning -`false` in `beforeunload` handler. +`false` in the `beforeunload` event handler. ## app.getAppPath() @@ -148,19 +148,19 @@ Returns the current application directory. * `name` String Retrieves a path to a special directory or file associated with `name`. On -failure an `Error` would throw. +failure an `Error` is thrown. -You can request following paths by the names: +You can request the following paths by the name: * `home`: User's home directory -* `appData`: Per-user application data directory, by default it is pointed to: +* `appData`: Per-user application data directory, which by default points to: * `%APPDATA%` on Windows * `$XDG_CONFIG_HOME` or `~/.config` on Linux * `~/Library/Application Support` on OS X -* `userData`: The directory for storing your app's configuration files, by +* `userData`: The directory for storing your app's configuration files, which by default it is the `appData` directory appended with your app's name -* `cache`: Per-user application cache directory, by default it is pointed to: - * `%APPDATA%` on Window, which doesn't has a universal place for cache +* `cache`: Per-user application cache directory, which by default points to: + * `%APPDATA%` on Windows (which doesn't have a universal cache location) * `$XDG_CACHE_HOME` or `~/.cache` on Linux * `~/Library/Caches` on OS X * `userCache`: The directory for placing your app's caches, by default it is the @@ -175,30 +175,30 @@ You can request following paths by the names: * `name` String * `path` String -Overrides the `path` to a special directory or file associated with `name`. if +Overrides the `path` to a special directory or file associated with `name`. If the path specifies a directory that does not exist, the directory will be -created by this method. On failure an `Error` would throw. +created by this method. On failure an `Error` is thrown. You can only override paths of `name`s defined in `app.getPath`. -By default web pages' cookies and caches will be stored under `userData` -directory, if you want to change this location, you have to override the -`userData` path before the `ready` event of `app` module gets emitted. +By default, web pages' cookies and caches will be stored under the `userData` +directory. If you want to change this location, you have to override the +`userData` path before the `ready` event of the `app` module is emitted. ## app.getVersion() -Returns the version of loaded application, if no version is found in -application's `package.json`, the version of current bundle or executable would -be returned. +Returns the version of the loaded application. If no version is found in the +application's `package.json` file, the version of the current bundle or executable is +returned. ## app.getName() -Returns current application's name, the name in `package.json` would be -used. +Returns the current application's name, which is the name in the application's +`package.json` file. Usually the `name` field of `package.json` is a short lowercased name, according -to the spec of npm modules. So usually you should also specify a `productName` -field, which is your application's full capitalized name, and it will be +to the npm modules spec. You should usually also specify a `productName` +field, which is your application's full capitalized name, and which will be preferred over `name` by Electron. ## app.resolveProxy(url, callback) @@ -206,17 +206,17 @@ preferred over `name` by Electron. * `url` URL * `callback` Function -Resolves the proxy information for `url`, the `callback` would be called with -`callback(proxy)` when the request is done. +Resolves the proxy information for `url`. The `callback` will be called with +`callback(proxy)` when the request is performed. ## app.addRecentDocument(path) * `path` String -Adds `path` to recent documents list. +Adds `path` to the recent documents list. -This list is managed by the system, on Windows you can visit the list from task -bar, and on Mac you can visit it from dock menu. +This list is managed by the OS. On Windows you can visit the list from the task +bar, and on OS X you can visit it from dock menu. ## app.clearRecentDocuments() @@ -226,20 +226,20 @@ Clears the recent documents list. * `tasks` Array - Array of `Task` objects -Adds `tasks` to the [Tasks][tasks] category of JumpList on Windows. +Adds `tasks` to the [Tasks][tasks] category of the JumpList on Windows. -The `tasks` is an array of `Task` objects in following format: +`tasks` is an array of `Task` objects in following format: * `Task` Object * `program` String - Path of the program to execute, usually you should - specify `process.execPath` which opens current program - * `arguments` String - The arguments of command line when `program` is + specify `process.execPath` which opens the current program + * `arguments` String - The command line arguments when `program` is executed * `title` String - The string to be displayed in a JumpList * `description` String - Description of this task * `iconPath` String - The absolute path to an icon to be displayed in a - JumpList, it can be arbitrary resource file that contains an icon, usually - you can specify `process.execPath` to show the icon of the program + JumpList, which can be an arbitrary resource file that contains an icon. You can + usually specify `process.execPath` to show the icon of the program * `iconIndex` Integer - The icon index in the icon file. If an icon file consists of two or more icons, set this value to identify the icon. If an icon file consists of one icon, this value is 0 @@ -255,25 +255,25 @@ to control some low-level Chromium behaviors. ## app.commandLine.appendArgument(value) -Append an argument to Chromium's command line. The argument will quoted properly. +Append an argument to Chromium's command line. The argument will be quoted correctly. **Note:** This will not affect `process.argv`. ## app.dock.bounce([type]) -* `type` String - Can be `critical` or `informational`, the default is +* `type` String - Can be `critical` or `informational`. The default is `informational` When `critical` is passed, the dock icon will bounce until either the application becomes active or the request is canceled. -When `informational` is passed, the dock icon will bounce for one second. The -request, though, remains active until either the application becomes active or +When `informational` is passed, the dock icon will bounce for one second. However, +the request remains active until either the application becomes active or the request is canceled. -An ID representing the request would be returned. +An ID representing the request is returned. -**Note:** This API is only available on Mac. +**Note:** This API is only available on OS X. ## app.dock.cancelBounce(id) @@ -281,7 +281,7 @@ An ID representing the request would be returned. Cancel the bounce of `id`. -**Note:** This API is only available on Mac. +**Note:** This API is only available on OS X. ## app.dock.setBadge(text) @@ -289,33 +289,33 @@ Cancel the bounce of `id`. Sets the string to be displayed in the dock’s badging area. -**Note:** This API is only available on Mac. +**Note:** This API is only available on OS X. ## app.dock.getBadge() Returns the badge string of the dock. -**Note:** This API is only available on Mac. +**Note:** This API is only available on OS X. ## app.dock.hide() Hides the dock icon. -**Note:** This API is only available on Mac. +**Note:** This API is only available on OS X. ## app.dock.show() Shows the dock icon. -**Note:** This API is only available on Mac. +**Note:** This API is only available on OS X. ## app.dock.setMenu(menu) * `menu` Menu -Sets the application [dock menu][dock-menu]. +Sets the application's [dock menu][dock-menu]. -**Note:** This API is only available on Mac. +**Note:** This API is only available on OS X. [dock-menu]:https://developer.apple.com/library/mac/documentation/Carbon/Conceptual/customizing_docktile/concepts/dockconcepts.html#//apple_ref/doc/uid/TP30000986-CH2-TPXREF103 [tasks]:http://msdn.microsoft.com/en-us/library/windows/desktop/dd378460(v=vs.85).aspx#tasks From 73790fcef5ba66ffe3f195e342caeb09c136780f Mon Sep 17 00:00:00 2001 From: Matias Insaurralde Date: Sun, 19 Jul 2015 17:39:59 -0400 Subject: [PATCH 0650/1293] preparing README-es --- docs/README-es.md | 68 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 68 insertions(+) create mode 100644 docs/README-es.md diff --git a/docs/README-es.md b/docs/README-es.md new file mode 100644 index 000000000000..16ecc3afd4b3 --- /dev/null +++ b/docs/README-es.md @@ -0,0 +1,68 @@ +## Guías + +* [Application distribution](tutorial/application-distribution.md) +* [Application packaging](tutorial/application-packaging.md) +* [Utilizando módulos nativos](tutorial/using-native-node-modules.md) +* [Depurando el proceso principal](tutorial/debugging-main-process.md) +* [Utilizando Selenium y WebDriver](tutorial/using-selenium-and-webdriver.md) +* [Extensión DevTools](tutorial/devtools-extension.md) +* [Utilizando el plugin pepper flash](tutorial/using-pepper-flash-plugin.md) + +## Tutoriales + +* [Quick start](tutorial/quick-start.md) +* [Integración con el entorno de escritorio](tutorial/desktop-environment-integration.md) +* [Detección del evento en línea/fuera de línea](tutorial/online-offline-events.md) + +## API + +* [Sinopsis](api/synopsis.md) +* [Proceso](api/process.md) +* [Supported Chrome command line switches](api/chrome-command-line-switches.md) + +Elementos DOM customizados: + +* [`File` object](api/file-object.md) +* [`` tag](api/web-view-tag.md) +* [`window.open` function](api/window-open.md) + +Módulos para el proceso principal: + +* [app](api/app.md) +* [auto-updater](api/auto-updater.md) +* [browser-window](api/browser-window.md) +* [content-tracing](api/content-tracing.md) +* [dialog](api/dialog.md) +* [global-shortcut](api/global-shortcut.md) +* [ipc (main process)](api/ipc-main-process.md) +* [menu](api/menu.md) +* [menu-item](api/menu-item.md) +* [power-monitor](api/power-monitor.md) +* [power-save-blocker](api/power-save-blocker.md) +* [protocol](api/protocol.md) +* [tray](api/tray.md) + +Módulos para el renderer (página web): + +* [ipc (renderer)](api/ipc-renderer.md) +* [remote](api/remote.md) +* [web-frame](api/web-frame.md) + +Módulos para ambos procesos: + +* [clipboard](api/clipboard.md) +* [crash-reporter](api/crash-reporter.md) +* [native-image](api/native-image.md) +* [screen](api/screen.md) +* [shell](api/shell.md) + +## Desarrollo + +* [Guía de estilo](development/coding-style.md) +* [Estructura de directorio](development/source-code-directory-structure.md) +* [Diferencias técnicas con NW.js (anteriormente conocido como node-webkit)](development/atom-shell-vs-node-webkit.md) +* [Build system overview](development/build-system-overview.md) +* [Build instructions (Mac)](development/build-instructions-mac.md) +* [Build instructions (Windows)](development/build-instructions-windows.md) +* [Build instructions (Linux)](development/build-instructions-linux.md) +* [Setting up symbol server in debugger](development/setting-up-symbol-server.md) From d3055a5ca09fba35b9960573ae8a64fe217e9512 Mon Sep 17 00:00:00 2001 From: Robo Date: Thu, 16 Jul 2015 20:06:48 +0530 Subject: [PATCH 0651/1293] session: api to set proxy --- atom/browser/api/atom_api_session.cc | 30 +++++++++++++++++++---- atom/browser/api/atom_api_session.h | 1 + docs/api/browser-window.md | 36 ++++++++++++++++++++++++++++ 3 files changed, 62 insertions(+), 5 deletions(-) diff --git a/atom/browser/api/atom_api_session.cc b/atom/browser/api/atom_api_session.cc index 93f8de52dd45..483b730d1c70 100644 --- a/atom/browser/api/atom_api_session.cc +++ b/atom/browser/api/atom_api_session.cc @@ -19,6 +19,7 @@ #include "net/base/load_flags.h" #include "net/disk_cache/disk_cache.h" #include "net/proxy/proxy_service.h" +#include "net/proxy/proxy_config_service_fixed.h" #include "net/url_request/url_request_context.h" #include "net/url_request/url_request_context_getter.h" @@ -157,9 +158,10 @@ class ResolveProxyHelper { }; // Runs the callback in UI thread. -void RunCallbackInUI(const net::CompletionCallback& callback, int result) { +template +void RunCallbackInUI(const base::Callback& callback, T... result) { BrowserThread::PostTask( - BrowserThread::UI, FROM_HERE, base::Bind(callback, result)); + BrowserThread::UI, FROM_HERE, base::Bind(callback, result...)); } // Callback of HttpCache::GetBackend. @@ -169,9 +171,9 @@ void OnGetBackend(disk_cache::Backend** backend_ptr, if (result != net::OK) { RunCallbackInUI(callback, result); } else if (backend_ptr && *backend_ptr) { - (*backend_ptr)->DoomAllEntries(base::Bind(&RunCallbackInUI, callback)); + (*backend_ptr)->DoomAllEntries(base::Bind(&RunCallbackInUI, callback)); } else { - RunCallbackInUI(callback, net::ERR_FAILED); + RunCallbackInUI(callback, net::ERR_FAILED); } } @@ -181,7 +183,7 @@ void ClearHttpCacheInIO(content::BrowserContext* browser_context, browser_context->GetRequestContext()->GetURLRequestContext(); auto http_cache = request_context->http_transaction_factory()->GetCache(); if (!http_cache) - RunCallbackInUI(callback, net::ERR_FAILED); + RunCallbackInUI(callback, net::ERR_FAILED); // Call GetBackend and make the backend's ptr accessable in OnGetBackend. using BackendPtr = disk_cache::Backend*; @@ -193,6 +195,16 @@ void ClearHttpCacheInIO(content::BrowserContext* browser_context, on_get_backend.Run(net::OK); } +void SetProxyInIO(net::URLRequestContextGetter* getter, + const std::string& proxy, + const base::Closure& callback) { + net::ProxyConfig config; + config.proxy_rules().ParseFromString(proxy); + auto proxy_service = getter->GetURLRequestContext()->proxy_service(); + proxy_service->ResetConfigService(new net::ProxyConfigServiceFixed(config)); + RunCallbackInUI(callback); +} + } // namespace Session::Session(AtomBrowserContext* browser_context) @@ -232,6 +244,13 @@ void Session::ClearStorageData(mate::Arguments* args) { base::Time(), base::Time::Max(), callback); } +void Session::SetProxy(const std::string& proxy, + const base::Closure& callback) { + auto getter = browser_context_->GetRequestContext(); + BrowserThread::PostTask(BrowserThread::IO, FROM_HERE, + base::Bind(&SetProxyInIO, base::Unretained(getter), proxy, callback)); +} + v8::Local Session::Cookies(v8::Isolate* isolate) { if (cookies_.IsEmpty()) { auto handle = atom::api::Cookies::Create(isolate, browser_context_); @@ -246,6 +265,7 @@ mate::ObjectTemplateBuilder Session::GetObjectTemplateBuilder( .SetMethod("resolveProxy", &Session::ResolveProxy) .SetMethod("clearCache", &Session::ClearCache) .SetMethod("clearStorageData", &Session::ClearStorageData) + .SetMethod("setProxy", &Session::SetProxy) .SetProperty("cookies", &Session::Cookies); } diff --git a/atom/browser/api/atom_api_session.h b/atom/browser/api/atom_api_session.h index 8e14c3a37834..3963ed21189a 100644 --- a/atom/browser/api/atom_api_session.h +++ b/atom/browser/api/atom_api_session.h @@ -45,6 +45,7 @@ class Session: public mate::TrackableObject { void ResolveProxy(const GURL& url, ResolveProxyCallback callback); void ClearCache(const net::CompletionCallback& callback); void ClearStorageData(mate::Arguments* args); + void SetProxy(const std::string& proxy, const base::Closure& callback); v8::Local Cookies(v8::Isolate* isolate); v8::Global cookies_; diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 48a118ffa3c2..ebd511fff0db 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -1167,3 +1167,39 @@ Clears the session's HTTP cache. * `callback` Function - Called when operation is done Clears the data of web storages. + +### Session.setProxy(config, callback) + +* `config` String +* `callback` Function - Called when operation is done + +Parses the `config` indicating which proxies to use for the session. + +``` +config = scheme-proxies[";"] +scheme-proxies = ["="] +url-scheme = "http" | "https" | "ftp" | "socks" +proxy-uri-list = [","] +proxy-uri = ["://"][":"] + + For example: + "http=foopy:80;ftp=foopy2" -- use HTTP proxy "foopy:80" for http:// + URLs, and HTTP proxy "foopy2:80" for + ftp:// URLs. + "foopy:80" -- use HTTP proxy "foopy:80" for all URLs. + "foopy:80,bar,direct://" -- use HTTP proxy "foopy:80" for all URLs, + failing over to "bar" if "foopy:80" is + unavailable, and after that using no + proxy. + "socks4://foopy" -- use SOCKS v4 proxy "foopy:1080" for all + URLs. + "http=foopy,socks5://bar.com -- use HTTP proxy "foopy" for http URLs, + and fail over to the SOCKS5 proxy + "bar.com" if "foopy" is unavailable. + "http=foopy,direct:// -- use HTTP proxy "foopy" for http URLs, + and use no proxy if "foopy" is + unavailable. + "http=foopy;socks=foopy2 -- use HTTP proxy "foopy" for http URLs, + and use socks4://foopy2 for all other + URLs. +``` From f6263f8c6b13a1ebfe7908ea185a8e8c02e42a49 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 20 Jul 2015 18:27:49 +0800 Subject: [PATCH 0652/1293] Update brightray for #2238 --- vendor/brightray | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/brightray b/vendor/brightray index c5f41a6edf61..1c79219c5c8e 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit c5f41a6edf6109e862c4c286d0c156e0099678e0 +Subproject commit 1c79219c5c8e8636208f1aaf2c937d11acba34ea From d342c9a6dff2077d50bb34ad33ac6cb70441a81c Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Sun, 19 Jul 2015 12:12:28 +0800 Subject: [PATCH 0653/1293] Implement 'drop-files' tray event on OS X. --- atom/browser/api/atom_api_tray.cc | 4 ++++ atom/browser/api/atom_api_tray.h | 6 ++++-- atom/browser/ui/tray_icon.cc | 4 ++++ atom/browser/ui/tray_icon.h | 2 ++ atom/browser/ui/tray_icon_cocoa.mm | 20 ++++++++++++++++++++ atom/browser/ui/tray_icon_observer.h | 8 ++++++-- docs/api/tray.md | 9 +++++++++ 7 files changed, 49 insertions(+), 4 deletions(-) diff --git a/atom/browser/api/atom_api_tray.cc b/atom/browser/api/atom_api_tray.cc index bf3a521d76e7..a209537c940f 100644 --- a/atom/browser/api/atom_api_tray.cc +++ b/atom/browser/api/atom_api_tray.cc @@ -64,6 +64,10 @@ void Tray::OnRightClicked(const gfx::Rect& bounds) { Emit("right-clicked", bounds); } +void Tray::OnDropFiles(const std::vector& files) { + Emit("drop-files", files); +} + bool Tray::IsDestroyed() const { return !tray_icon_; } diff --git a/atom/browser/api/atom_api_tray.h b/atom/browser/api/atom_api_tray.h index 5b40937d717a..10ea3836819e 100644 --- a/atom/browser/api/atom_api_tray.h +++ b/atom/browser/api/atom_api_tray.h @@ -6,6 +6,7 @@ #define ATOM_BROWSER_API_ATOM_API_TRAY_H_ #include +#include #include "atom/browser/api/event_emitter.h" #include "atom/browser/ui/tray_icon_observer.h" @@ -41,12 +42,13 @@ class Tray : public mate::EventEmitter, virtual ~Tray(); // TrayIconObserver: - void OnClicked(const gfx::Rect&) override; + void OnClicked(const gfx::Rect& bounds) override; void OnDoubleClicked() override; void OnBalloonShow() override; void OnBalloonClicked() override; void OnBalloonClosed() override; - void OnRightClicked(const gfx::Rect&) override; + void OnRightClicked(const gfx::Rect& bounds) override; + void OnDropFiles(const std::vector& files) override; // mate::Wrappable: bool IsDestroyed() const override; diff --git a/atom/browser/ui/tray_icon.cc b/atom/browser/ui/tray_icon.cc index ab1ebfa67790..456cbe47a5a3 100644 --- a/atom/browser/ui/tray_icon.cc +++ b/atom/browser/ui/tray_icon.cc @@ -53,4 +53,8 @@ void TrayIcon::NotifyRightClicked(const gfx::Rect& bounds) { FOR_EACH_OBSERVER(TrayIconObserver, observers_, OnRightClicked(bounds)); } +void TrayIcon::NotfiyDropFiles(const std::vector& files) { + FOR_EACH_OBSERVER(TrayIconObserver, observers_, OnDropFiles(files)); +} + } // namespace atom diff --git a/atom/browser/ui/tray_icon.h b/atom/browser/ui/tray_icon.h index a9e9b414ec94..d6885699d01d 100644 --- a/atom/browser/ui/tray_icon.h +++ b/atom/browser/ui/tray_icon.h @@ -6,6 +6,7 @@ #define ATOM_BROWSER_UI_TRAY_ICON_H_ #include +#include #include "atom/browser/ui/tray_icon_observer.h" #include "base/observer_list.h" @@ -59,6 +60,7 @@ class TrayIcon { void NotifyBalloonClicked(); void NotifyBalloonClosed(); void NotifyRightClicked(const gfx::Rect& bounds = gfx::Rect()); + void NotfiyDropFiles(const std::vector& files); protected: TrayIcon(); diff --git a/atom/browser/ui/tray_icon_cocoa.mm b/atom/browser/ui/tray_icon_cocoa.mm index 4dcb6d2782c1..fddbd8c16eb0 100644 --- a/atom/browser/ui/tray_icon_cocoa.mm +++ b/atom/browser/ui/tray_icon_cocoa.mm @@ -41,6 +41,8 @@ const CGFloat kMargin = 3; kStatusItemLength, [[statusItem_ statusBar] thickness]); if ((self = [super initWithFrame:frame])) { + [self registerForDraggedTypes: + [NSArray arrayWithObjects:NSFilenamesPboardType, nil]]; [statusItem_ setView:self]; } return self; @@ -174,6 +176,24 @@ const CGFloat kMargin = 3; trayIcon_->NotifyRightClicked([self getBoundsFromEvent:event]); } +- (NSDragOperation)draggingEntered:(id )sender { + return NSDragOperationCopy; +} + +- (BOOL)performDragOperation:(id )sender { + NSPasteboard* pboard = [sender draggingPasteboard]; + + if ([[pboard types] containsObject:NSFilenamesPboardType]) { + std::vector dropFiles; + NSArray* files = [pboard propertyListForType:NSFilenamesPboardType]; + for (NSString* file in files) + dropFiles.push_back(base::SysNSStringToUTF8(file)); + trayIcon_->NotfiyDropFiles(dropFiles); + return YES; + } + return NO; +} + - (BOOL)shouldHighlight { BOOL is_menu_open = [menuController_ isMenuOpen]; return isHighlightEnable_ && (inMouseEventSequence_ || is_menu_open); diff --git a/atom/browser/ui/tray_icon_observer.h b/atom/browser/ui/tray_icon_observer.h index 061115efdc64..6c9839a38a1f 100644 --- a/atom/browser/ui/tray_icon_observer.h +++ b/atom/browser/ui/tray_icon_observer.h @@ -5,6 +5,9 @@ #ifndef ATOM_BROWSER_UI_TRAY_ICON_OBSERVER_H_ #define ATOM_BROWSER_UI_TRAY_ICON_OBSERVER_H_ +#include +#include + namespace gfx { class Rect; } @@ -13,12 +16,13 @@ namespace atom { class TrayIconObserver { public: - virtual void OnClicked(const gfx::Rect&) {} + virtual void OnClicked(const gfx::Rect& bounds) {} virtual void OnDoubleClicked() {} virtual void OnBalloonShow() {} virtual void OnBalloonClicked() {} virtual void OnBalloonClosed() {} - virtual void OnRightClicked(const gfx::Rect&) {} + virtual void OnRightClicked(const gfx::Rect& bounds) {} + virtual void OnDropFiles(const std::vector& files) {} protected: virtual ~TrayIconObserver() {} diff --git a/docs/api/tray.md b/docs/api/tray.md index fe0e2542b3a3..30225dd6f3ed 100644 --- a/docs/api/tray.md +++ b/docs/api/tray.md @@ -95,6 +95,15 @@ closes it. __Note:__ This is only implemented on Windows. +### Event: 'drop-files' + +* `event` +* `files` Array - the file path of dropped files. + +Emitted when dragged files are dropped in the tray icon. + +__Note:__ This is only implemented on OS X. + ### Tray.destroy() Destroys the tray icon immediately. From f25cf7481fc310afbd32d1954e56e43f40ef7027 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 21 Jul 2015 10:16:02 +0800 Subject: [PATCH 0654/1293] spec: Test setContentSize for frameless window --- spec/api-browser-window-spec.coffee | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/spec/api-browser-window-spec.coffee b/spec/api-browser-window-spec.coffee index ce1282439a2d..c63254261779 100644 --- a/spec/api-browser-window-spec.coffee +++ b/spec/api-browser-window-spec.coffee @@ -117,6 +117,15 @@ describe 'browser-window module', -> assert.equal after[0], size[0] assert.equal after[1], size[1] + it 'works for framless window', -> + w.destroy() + w = new BrowserWindow(show: false, frame: false, width: 400, height: 400) + size = [400, 400] + w.setContentSize size[0], size[1] + after = w.getContentSize() + assert.equal after[0], size[0] + assert.equal after[1], size[1] + describe 'BrowserWindow.fromId(id)', -> it 'returns the window with id', -> assert.equal w.id, BrowserWindow.fromId(w.id).id @@ -134,6 +143,16 @@ describe 'browser-window module', -> assert.equal size[0], 400 assert.equal size[1], 400 + it 'works for framless window', -> + w.destroy() + w = new BrowserWindow(show: false, frame: false, width: 400, height: 400, 'use-content-size': true) + contentSize = w.getContentSize() + assert.equal contentSize[0], 400 + assert.equal contentSize[1], 400 + size = w.getSize() + assert.equal size[0], 400 + assert.equal size[1], 400 + describe '"enable-larger-than-screen" option', -> return if process.platform is 'linux' From 3ea878941b7fcc7110cc26bd4f256d9f769a5fe0 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 21 Jul 2015 10:29:05 +0800 Subject: [PATCH 0655/1293] mac: Always call SetSize for framless window --- atom/browser/native_window_mac.mm | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/atom/browser/native_window_mac.mm b/atom/browser/native_window_mac.mm index c0d358bb8f72..8d5cf7d414cf 100644 --- a/atom/browser/native_window_mac.mm +++ b/atom/browser/native_window_mac.mm @@ -357,7 +357,7 @@ NativeWindowMac::NativeWindowMac( // On OS X the initial window size doesn't include window frame. bool use_content_size = false; options.Get(switches::kUseContentSize, &use_content_size); - if (has_frame_ && !use_content_size) + if (!has_frame_ || !use_content_size) SetSize(gfx::Size(width, height)); // Enable the NSView to accept first mouse event. @@ -494,6 +494,11 @@ gfx::Rect NativeWindowMac::GetBounds() { } void NativeWindowMac::SetContentSize(const gfx::Size& size) { + if (!has_frame_) { + SetSize(size); + return; + } + NSRect frame_nsrect = [window_ frame]; NSSize frame = frame_nsrect.size; NSSize content = [window_ contentRectForFrameRect:frame_nsrect].size; From 891d107a5169875634d260f5375aead19249db6d Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 21 Jul 2015 10:34:37 +0800 Subject: [PATCH 0656/1293] mac: Always use GetSize for frameless window --- atom/browser/native_window_mac.mm | 3 +++ 1 file changed, 3 insertions(+) diff --git a/atom/browser/native_window_mac.mm b/atom/browser/native_window_mac.mm index 8d5cf7d414cf..a4c6ee038761 100644 --- a/atom/browser/native_window_mac.mm +++ b/atom/browser/native_window_mac.mm @@ -512,6 +512,9 @@ void NativeWindowMac::SetContentSize(const gfx::Size& size) { } gfx::Size NativeWindowMac::GetContentSize() { + if (!has_frame_) + return GetSize(); + NSRect bounds = [[window_ contentView] bounds]; return gfx::Size(bounds.size.width, bounds.size.height); } From 59269a70a0fc128fda86a693f19d9caa0d58a140 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 21 Jul 2015 11:27:24 +0800 Subject: [PATCH 0657/1293] docs: Mention libappindicator1 is required, close #1347 --- docs/api/tray.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/api/tray.md b/docs/api/tray.md index 30225dd6f3ed..847b0b2cf818 100644 --- a/docs/api/tray.md +++ b/docs/api/tray.md @@ -27,6 +27,8 @@ __Platform limitations:__ * On Linux app indicator will be used if it is supported, otherwise `GtkStatusIcon` will be used instead. +* On Linux distributions that only have app indicator support, you have to + install `libappindicator1` to make tray icon work. * App indicator will only be showed when it has context menu. * When app indicator is used on Linux, `clicked` event is ignored. From 462e6e0a826950535a14e6854901797f648e9bcc Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Wed, 22 Jul 2015 12:25:10 +0800 Subject: [PATCH 0658/1293] Implement getUserAgent API. --- atom/browser/api/atom_api_web_contents.cc | 5 +++++ atom/browser/api/atom_api_web_contents.h | 1 + atom/renderer/lib/web-view/web-view.coffee | 1 + docs/api/browser-window.md | 4 ++++ docs/api/web-view-tag.md | 4 ++++ 5 files changed, 15 insertions(+) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 6311e1eaf9a4..4bd1e9b6d6e8 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -563,6 +563,10 @@ void WebContents::SetUserAgent(const std::string& user_agent) { base::Bind(&SetUserAgentInIO, getter, user_agent)); } +std::string WebContents::GetUserAgent() { + return web_contents()->GetUserAgentOverride(); +} + void WebContents::InsertCSS(const std::string& css) { web_contents()->InsertCSS(css); } @@ -767,6 +771,7 @@ mate::ObjectTemplateBuilder WebContents::GetObjectTemplateBuilder( .SetMethod("_goToOffset", &WebContents::GoToOffset) .SetMethod("isCrashed", &WebContents::IsCrashed) .SetMethod("setUserAgent", &WebContents::SetUserAgent) + .SetMethod("getUserAgent", &WebContents::GetUserAgent) .SetMethod("insertCSS", &WebContents::InsertCSS) .SetMethod("_executeJavaScript", &WebContents::ExecuteJavaScript) .SetMethod("openDevTools", &WebContents::OpenDevTools) diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index bb6b22ac84e2..e3dc363972d4 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -63,6 +63,7 @@ class WebContents : public mate::TrackableObject, void GoToOffset(int offset); bool IsCrashed() const; void SetUserAgent(const std::string& user_agent); + std::string GetUserAgent(); void InsertCSS(const std::string& css); void ExecuteJavaScript(const base::string16& code); void OpenDevTools(mate::Arguments* args); diff --git a/atom/renderer/lib/web-view/web-view.coffee b/atom/renderer/lib/web-view/web-view.coffee index 72fee948d137..eedee732938f 100644 --- a/atom/renderer/lib/web-view/web-view.coffee +++ b/atom/renderer/lib/web-view/web-view.coffee @@ -269,6 +269,7 @@ registerWebViewElement = -> "goToOffset" "isCrashed" "setUserAgent" + "getUserAgent" "executeJavaScript" "insertCSS" "openDevTools" diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index ebd511fff0db..f202884f51c6 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -875,6 +875,10 @@ Whether the renderer process has crashed. Overrides the user agent for this page. +### WebContents.getUserAgent() + +Returns a `String` represents the user agent for this page. + ### WebContents.insertCSS(css) * `css` String diff --git a/docs/api/web-view-tag.md b/docs/api/web-view-tag.md index 54e82ef3a7bc..973b62f5b767 100644 --- a/docs/api/web-view-tag.md +++ b/docs/api/web-view-tag.md @@ -215,6 +215,10 @@ Whether the renderer process has crashed. Overrides the user agent for guest page. +### ``.getUserAgent() + +Returns a `String` represents the user agent for guest page. + ### ``.insertCSS(css) * `css` String From 58f1907579f28f66211ea0716ba94ec34f681d94 Mon Sep 17 00:00:00 2001 From: Robo Date: Wed, 22 Jul 2015 13:54:39 +0530 Subject: [PATCH 0659/1293] protocol: copy headers from original request for custom request job --- atom/browser/net/adapter_request_job.cc | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/atom/browser/net/adapter_request_job.cc b/atom/browser/net/adapter_request_job.cc index d9c9b467d48c..5f584c2f7314 100644 --- a/atom/browser/net/adapter_request_job.cc +++ b/atom/browser/net/adapter_request_job.cc @@ -131,10 +131,13 @@ void AdapterRequestJob::CreateHttpJobAndStart( void AdapterRequestJob::CreateJobFromProtocolHandlerAndStart() { real_job_ = protocol_handler_->MaybeCreateJob(request(), network_delegate()); - if (!real_job_.get()) + if (!real_job_.get()) { CreateErrorJobAndStart(net::ERR_NOT_IMPLEMENTED); - else + } else { + // Copy headers from original request. + real_job_->SetExtraRequestHeaders(request()->extra_request_headers()); real_job_->Start(); + } } } // namespace atom From 6d25c81bd1385f43c832e70787732dc265135ce9 Mon Sep 17 00:00:00 2001 From: "Michael S. Barthelemy" Date: Wed, 22 Jul 2015 10:23:31 -0400 Subject: [PATCH 0660/1293] changes requested for pull request #2250 into electron master --- atom/browser/api/atom_api_window.cc | 8 +++----- atom/browser/api/atom_api_window.h | 3 +-- atom/browser/native_window.cc | 16 ++++++++-------- atom/browser/native_window.h | 11 +++++------ atom/browser/native_window_mac.mm | 24 ++++++++++++------------ docs/api/browser-window.md | 11 +++++++++++ 6 files changed, 40 insertions(+), 33 deletions(-) diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index e6d4ff4d4134..49a41cf51a93 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -249,9 +249,8 @@ bool Window::IsFullscreen() { return window_->IsFullscreen(); } -void Window::MaintainContentAspectRatio(double aspectRatio, - double width, double height) { - window_->MaintainContentAspectRatio(aspectRatio, gfx::Size(width, height)); +void Window::SetAspectRatio(double aspectRatio, gfx::Size extraSize) { + window_->SetAspectRatio(aspectRatio, extraSize); } void Window::SetBounds(const gfx::Rect& bounds) { @@ -503,8 +502,7 @@ void Window::BuildPrototype(v8::Isolate* isolate, .SetMethod("isMinimized", &Window::IsMinimized) .SetMethod("setFullScreen", &Window::SetFullScreen) .SetMethod("isFullScreen", &Window::IsFullscreen) - .SetMethod("maintainContentAspectRatio", - &Window::MaintainContentAspectRatio) + .SetMethod("setAspectRatio", &Window::SetAspectRatio) .SetMethod("getBounds", &Window::GetBounds) .SetMethod("setBounds", &Window::SetBounds) .SetMethod("getSize", &Window::GetSize) diff --git a/atom/browser/api/atom_api_window.h b/atom/browser/api/atom_api_window.h index 313892a6b286..e0345bc2e3bf 100644 --- a/atom/browser/api/atom_api_window.h +++ b/atom/browser/api/atom_api_window.h @@ -95,8 +95,7 @@ class Window : public mate::TrackableObject, bool IsMinimized(); void SetFullScreen(bool fullscreen); bool IsFullscreen(); - void MaintainContentAspectRatio(double aspectRatio, - double width, double height); + void SetAspectRatio(double aspectRatio, gfx::Size extraSize); void SetBounds(const gfx::Rect& bounds); gfx::Rect GetBounds(); void SetSize(int width, int height); diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 544bfad46870..56999af945c5 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -195,18 +195,18 @@ void NativeWindow::InitFromOptions(const mate::Dictionary& options) { Show(); } -double NativeWindow::GetInteriorContentAspectRatio() { - return interiorContentAspectRatio; +double NativeWindow::GetAspectRatio() { + return aspectRatio_; } -gfx::Size NativeWindow::GetInteriorContentExtraSize() { - return interiorContentExtraSize; +gfx::Size NativeWindow::GetAspectRatioExtraSize() { + return aspectRatioExtraSize_; } -void NativeWindow::MaintainContentAspectRatio(double aspectRatio, - const gfx::Size& extraSize) { - interiorContentAspectRatio = aspectRatio; - interiorContentExtraSize = extraSize; +void NativeWindow::SetAspectRatio(double aspectRatio, + const gfx::Size& extraSize) { + aspectRatio_ = aspectRatio; + aspectRatioExtraSize_ = extraSize; } void NativeWindow::SetSize(const gfx::Size& size) { diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index ee0628422270..cc0bd7b8f5a2 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -107,10 +107,9 @@ class NativeWindow : public content::WebContentsObserver, virtual bool IsMinimized() = 0; virtual void SetFullScreen(bool fullscreen) = 0; virtual bool IsFullscreen() const = 0; - double GetInteriorContentAspectRatio(); - virtual gfx::Size GetInteriorContentExtraSize(); - virtual void MaintainContentAspectRatio(double aspectRatio, - const gfx::Size& extraSize); + double GetAspectRatio(); + virtual gfx::Size GetAspectRatioExtraSize(); + virtual void SetAspectRatio(double aspectRatio, const gfx::Size& extraSize); virtual void SetBounds(const gfx::Rect& bounds) = 0; virtual gfx::Rect GetBounds() = 0; virtual void SetSize(const gfx::Size& size); @@ -291,8 +290,8 @@ class NativeWindow : public content::WebContentsObserver, // Used to maintain the aspect ratio of a view which is inside of the // content view. - double interiorContentAspectRatio = 0.0; - gfx::Size interiorContentExtraSize; + double aspectRatio_ = 0.0; + gfx::Size aspectRatioExtraSize_; // The page this window is viewing. brightray::InspectableWebContents* inspectable_web_contents_; diff --git a/atom/browser/native_window_mac.mm b/atom/browser/native_window_mac.mm index f543aae1628d..9c13518c302d 100644 --- a/atom/browser/native_window_mac.mm +++ b/atom/browser/native_window_mac.mm @@ -97,25 +97,25 @@ static const CGFloat kAtomWindowCornerRadius = 4.0; - (NSSize)windowWillResize:(NSWindow *)sender toSize:(NSSize)frameSize { NSSize newSize = frameSize; - double interiorContentAspectRatio = shell_->GetInteriorContentAspectRatio(); + double aspectRatio = shell_->GetAspectRatio(); - if (interiorContentAspectRatio > 0.0) { - NSRect windowFrame = [sender frame]; - NSRect contentViewBounds = [[sender contentView] bounds]; - gfx::Size interiorContentExtraSize = shell_->GetInteriorContentExtraSize(); - double extraWidthPlusFrame = windowFrame.size.width - contentViewBounds.size.width + interiorContentExtraSize.width(); - double extraHeightPlusFrame = windowFrame.size.height - contentViewBounds.size.height + interiorContentExtraSize.height(); + if (aspectRatio > 0.0) { + gfx::Size windowFrameSize = shell_->GetSize(); + gfx::Size contentViewSize = shell_->GetContentSize(); + gfx::Size aspectRatioExtraSize = shell_->GetAspectRatioExtraSize(); + double extraWidthPlusFrame = windowFrameSize.width() - contentViewSize.width() + aspectRatioExtraSize.width(); + double extraHeightPlusFrame = windowFrameSize.height() - contentViewSize.height() + aspectRatioExtraSize.height(); - newSize.width = roundf(((frameSize.height - extraHeightPlusFrame) * interiorContentAspectRatio) + extraWidthPlusFrame); + newSize.width = roundf(((frameSize.height - extraHeightPlusFrame) * aspectRatio) + extraWidthPlusFrame); // If the new width is less than the frame size use it as the primary constraint. This ensures that the value returned // by this method will never be larger than the users requested window size. - if (newSize.width < frameSize.width) { - newSize.height = roundf(((newSize.width - extraWidthPlusFrame) / interiorContentAspectRatio) + extraHeightPlusFrame); + if (newSize.width <= frameSize.width) { + newSize.height = roundf(((newSize.width - extraWidthPlusFrame) / aspectRatio) + extraHeightPlusFrame); } else { - newSize.height = roundf(((frameSize.width - extraWidthPlusFrame) / interiorContentAspectRatio) + extraHeightPlusFrame); - newSize.width = roundf(((newSize.height - extraHeightPlusFrame) * interiorContentAspectRatio) + extraWidthPlusFrame); + newSize.height = roundf(((frameSize.width - extraWidthPlusFrame) / aspectRatio) + extraHeightPlusFrame); + newSize.width = roundf(((newSize.height - extraHeightPlusFrame) * aspectRatio) + extraWidthPlusFrame); } } diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 48a118ffa3c2..25e2ba2958e7 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -361,6 +361,17 @@ Sets whether the window should be in fullscreen mode. Returns whether the window is in fullscreen mode. +### BrowserWindow.setAspectRatio(aspectRatio, [extraSize]) + +* `aspectRatio` The aspect ratio we want to maintain for some portion of the content view. +* `rect` Object - The extra size to not be included in the aspect ratio to be maintained. + * `width` Integer + * `height` Integer + +This will have a window maintain an aspect ratio. The extra size allows a developer to be able to have space, specifified in pixels, not included within the aspect ratio calculations. This API already takes into account the difference between a window's size and it's content size. + +Consider a normal window with an HD video player and associated controls. Perhaps there are 15 pixels of controls on the left edge, 25 pixels of controls on the right edge and 50 pixels of controls below the player. In order to maintain a 16:9 aspect ratio (standard aspect ratio for HD @1920x1080) within the player itself we would call this function with arguments of 16/9 and [ 40, 50 ]. The second argument doesn't care where the extra width and height are within the content view — only that they exist. Just sum any extra width and height areas you have within the overall content view. + ### BrowserWindow.setBounds(options) * `options` Object From d701e1aa40438cb2403eb3fac69138ee78fd6f10 Mon Sep 17 00:00:00 2001 From: Eran Tiktin Date: Wed, 22 Jul 2015 18:13:50 +0300 Subject: [PATCH 0661/1293] Update dialog.md Added a comment about the fact that on Windows, the "question" message box uses the same icon as the "info" message box (Electron uses the task dialog API instead of the message box API). This is because Microsoft's API doesn't supply a default question icon (see `pszIcon` in https://msdn.microsoft.com/en-us/library/windows/desktop/bb760540(v=vs.85).aspx). --- docs/api/dialog.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/dialog.md b/docs/api/dialog.md index 9e123b381c51..f6b65a1bb06c 100644 --- a/docs/api/dialog.md +++ b/docs/api/dialog.md @@ -70,7 +70,7 @@ will be passed via `callback(filename)` * `browserWindow` BrowserWindow * `options` Object - * `type` String - Can be `"none"`, `"info"`, `"error"`, `"question"` or `"warning"` + * `type` String - Can be `"none"`, `"info"`, `"error"`, `"question"` or `"warning"`. On Windows, "question" displays the same icon as "info", unless if you set an icon using the "icon" option * `buttons` Array - Array of texts for buttons * `title` String - Title of the message box, some platforms will not show it * `message` String - Content of the message box From a1ec07e07e6d5fd8735746e19357e70c0276dce8 Mon Sep 17 00:00:00 2001 From: Robo Date: Wed, 22 Jul 2015 21:45:08 +0530 Subject: [PATCH 0662/1293] read post-filtered data when filters are present --- atom/browser/net/adapter_request_job.cc | 11 ++++++++++- atom/browser/net/adapter_request_job.h | 2 ++ 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/atom/browser/net/adapter_request_job.cc b/atom/browser/net/adapter_request_job.cc index 5f584c2f7314..2be25b657513 100644 --- a/atom/browser/net/adapter_request_job.cc +++ b/atom/browser/net/adapter_request_job.cc @@ -43,7 +43,11 @@ bool AdapterRequestJob::ReadRawData(net::IOBuffer* buf, int buf_size, int *bytes_read) { DCHECK(!real_job_.get()); - return real_job_->ReadRawData(buf, buf_size, bytes_read); + // Read post-filtered data if available. + if (real_job_->HasFilter()) + return real_job_->Read(buf, buf_size, bytes_read); + else + return real_job_->ReadRawData(buf, buf_size, bytes_read); } bool AdapterRequestJob::IsRedirectResponse(GURL* location, @@ -75,6 +79,11 @@ int AdapterRequestJob::GetResponseCode() const { return real_job_->GetResponseCode(); } +void AdapterRequestJob::GetLoadTimingInfo( + net::LoadTimingInfo* load_timing_info) const { + real_job_->GetLoadTimingInfo(load_timing_info); +} + base::WeakPtr AdapterRequestJob::GetWeakPtr() { return weak_factory_.GetWeakPtr(); } diff --git a/atom/browser/net/adapter_request_job.h b/atom/browser/net/adapter_request_job.h index 768718584d03..bca549a2eef2 100644 --- a/atom/browser/net/adapter_request_job.h +++ b/atom/browser/net/adapter_request_job.h @@ -46,6 +46,8 @@ class AdapterRequestJob : public net::URLRequestJob { bool GetCharset(std::string* charset) override; void GetResponseInfo(net::HttpResponseInfo* info) override; int GetResponseCode() const override; + void GetLoadTimingInfo( + net::LoadTimingInfo* load_timing_info) const override; base::WeakPtr GetWeakPtr(); From 97c90d31d3866fa2fc44bd2f56d5de9e6203ffd8 Mon Sep 17 00:00:00 2001 From: Robo Date: Wed, 22 Jul 2015 21:54:12 +0530 Subject: [PATCH 0663/1293] get jsprotocolhandler in IO thread --- atom/browser/api/atom_api_protocol.cc | 13 +++++++++---- atom/browser/net/adapter_request_job.cc | 6 +----- atom/browser/net/adapter_request_job.h | 2 +- 3 files changed, 11 insertions(+), 10 deletions(-) diff --git a/atom/browser/api/atom_api_protocol.cc b/atom/browser/api/atom_api_protocol.cc index d7af58802792..53aef95b7657 100644 --- a/atom/browser/api/atom_api_protocol.cc +++ b/atom/browser/api/atom_api_protocol.cc @@ -80,16 +80,13 @@ class CustomProtocolRequestJob : public AdapterRequestJob { registry_(registry) { } - // AdapterRequestJob: - void GetJobTypeInUI() override { + void GetJobTypeInUI(const Protocol::JsProtocolHandler& callback) { DCHECK_CURRENTLY_ON(BrowserThread::UI); v8::Locker locker(registry_->isolate()); v8::HandleScope handle_scope(registry_->isolate()); // Call the JS handler. - Protocol::JsProtocolHandler callback = - registry_->GetProtocolHandler(request()->url().scheme()); v8::Local result = callback.Run(request()); // Determine the type of the job we are going to create. @@ -172,6 +169,14 @@ class CustomProtocolRequestJob : public AdapterRequestJob { GetWeakPtr(), net::ERR_NOT_IMPLEMENTED)); } + // AdapterRequestJob: + void GetJobType() override { + BrowserThread::PostTask(BrowserThread::UI, FROM_HERE, + base::Bind(&CustomProtocolRequestJob::GetJobTypeInUI, + base::Unretained(this), + registry_->GetProtocolHandler(request()->url().scheme()))); + } + private: Protocol* registry_; // Weak, the Protocol class is expected to live forever. }; diff --git a/atom/browser/net/adapter_request_job.cc b/atom/browser/net/adapter_request_job.cc index 2be25b657513..5c41c6f65aac 100644 --- a/atom/browser/net/adapter_request_job.cc +++ b/atom/browser/net/adapter_request_job.cc @@ -27,11 +27,7 @@ AdapterRequestJob::AdapterRequestJob(ProtocolHandler* protocol_handler, void AdapterRequestJob::Start() { DCHECK(!real_job_.get()); - content::BrowserThread::PostTask( - content::BrowserThread::UI, - FROM_HERE, - base::Bind(&AdapterRequestJob::GetJobTypeInUI, - weak_factory_.GetWeakPtr())); + GetJobType(); } void AdapterRequestJob::Kill() { diff --git a/atom/browser/net/adapter_request_job.h b/atom/browser/net/adapter_request_job.h index bca549a2eef2..b1d28b1446c1 100644 --- a/atom/browser/net/adapter_request_job.h +++ b/atom/browser/net/adapter_request_job.h @@ -54,7 +54,7 @@ class AdapterRequestJob : public net::URLRequestJob { ProtocolHandler* default_protocol_handler() { return protocol_handler_; } // Override this function to determine which job should be started. - virtual void GetJobTypeInUI() = 0; + virtual void GetJobType() = 0; void CreateErrorJobAndStart(int error_code); void CreateStringJobAndStart(const std::string& mime_type, From df35700b940369289371cc92e4b66c47ddad6c76 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 23 Jul 2015 10:07:58 +0800 Subject: [PATCH 0664/1293] Style fixes * Use under_score for variable names in C++ * Use const& when possible * Line length <= 80 --- atom/browser/api/atom_api_window.cc | 4 +-- atom/browser/api/atom_api_window.h | 2 +- atom/browser/native_window.cc | 29 ++++++++++----------- atom/browser/native_window.h | 12 +++++---- atom/browser/native_window_mac.mm | 39 ++++++++++++++++++----------- 5 files changed, 50 insertions(+), 36 deletions(-) diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index 49a41cf51a93..c4e6b06af06f 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -249,8 +249,8 @@ bool Window::IsFullscreen() { return window_->IsFullscreen(); } -void Window::SetAspectRatio(double aspectRatio, gfx::Size extraSize) { - window_->SetAspectRatio(aspectRatio, extraSize); +void Window::SetAspectRatio(double aspect_ratio, const gfx::Size& extraSize) { + window_->SetAspectRatio(aspect_ratio, extraSize); } void Window::SetBounds(const gfx::Rect& bounds) { diff --git a/atom/browser/api/atom_api_window.h b/atom/browser/api/atom_api_window.h index e0345bc2e3bf..f807ab135f28 100644 --- a/atom/browser/api/atom_api_window.h +++ b/atom/browser/api/atom_api_window.h @@ -95,7 +95,7 @@ class Window : public mate::TrackableObject, bool IsMinimized(); void SetFullScreen(bool fullscreen); bool IsFullscreen(); - void SetAspectRatio(double aspectRatio, gfx::Size extraSize); + void SetAspectRatio(double aspect_ratio, const gfx::Size& extraSize); void SetBounds(const gfx::Rect& bounds); gfx::Rect GetBounds(); void SetSize(int width, int height); diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 56999af945c5..c03ab1ac24a4 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -85,6 +85,7 @@ NativeWindow::NativeWindow( node_integration_(true), has_dialog_attached_(false), zoom_factor_(1.0), + aspect_ratio_(0.0), inspectable_web_contents_(inspectable_web_contents), weak_factory_(this) { inspectable_web_contents->GetView()->SetDelegate(this); @@ -195,20 +196,6 @@ void NativeWindow::InitFromOptions(const mate::Dictionary& options) { Show(); } -double NativeWindow::GetAspectRatio() { - return aspectRatio_; -} - -gfx::Size NativeWindow::GetAspectRatioExtraSize() { - return aspectRatioExtraSize_; -} - -void NativeWindow::SetAspectRatio(double aspectRatio, - const gfx::Size& extraSize) { - aspectRatio_ = aspectRatio; - aspectRatioExtraSize_ = extraSize; -} - void NativeWindow::SetSize(const gfx::Size& size) { SetBounds(gfx::Rect(GetPosition(), size)); } @@ -260,6 +247,20 @@ bool NativeWindow::IsMenuBarVisible() { return true; } +double NativeWindow::GetAspectRatio() { + return aspect_ratio_; +} + +gfx::Size NativeWindow::GetAspectRatioExtraSize() { + return aspect_ratio_extraSize_; +} + +void NativeWindow::SetAspectRatio(double aspect_ratio, + const gfx::Size& extra_size) { + aspect_ratio_ = aspect_ratio; + aspect_ratio_extraSize_ = extra_size; +} + bool NativeWindow::HasModalDialog() { return has_dialog_attached_; } diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index cc0bd7b8f5a2..b9c2486b791b 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -107,9 +107,6 @@ class NativeWindow : public content::WebContentsObserver, virtual bool IsMinimized() = 0; virtual void SetFullScreen(bool fullscreen) = 0; virtual bool IsFullscreen() const = 0; - double GetAspectRatio(); - virtual gfx::Size GetAspectRatioExtraSize(); - virtual void SetAspectRatio(double aspectRatio, const gfx::Size& extraSize); virtual void SetBounds(const gfx::Rect& bounds) = 0; virtual gfx::Rect GetBounds() = 0; virtual void SetSize(const gfx::Size& size); @@ -166,6 +163,11 @@ class NativeWindow : public content::WebContentsObserver, virtual void SetMenuBarVisibility(bool visible); virtual bool IsMenuBarVisible(); + // Set the aspect ratio when resizing window. + double GetAspectRatio(); + gfx::Size GetAspectRatioExtraSize(); + void SetAspectRatio(double aspect_ratio, const gfx::Size& extra_size); + base::WeakPtr GetWeakPtr() { return weak_factory_.GetWeakPtr(); } @@ -290,8 +292,8 @@ class NativeWindow : public content::WebContentsObserver, // Used to maintain the aspect ratio of a view which is inside of the // content view. - double aspectRatio_ = 0.0; - gfx::Size aspectRatioExtraSize_; + double aspect_ratio_; + gfx::Size aspect_ratio_extraSize_; // The page this window is viewing. brightray::InspectableWebContents* inspectable_web_contents_; diff --git a/atom/browser/native_window_mac.mm b/atom/browser/native_window_mac.mm index b69785045a8b..d5f12bde13dd 100644 --- a/atom/browser/native_window_mac.mm +++ b/atom/browser/native_window_mac.mm @@ -95,27 +95,38 @@ static const CGFloat kAtomWindowCornerRadius = 4.0; shell_->NotifyWindowBlur(); } -- (NSSize)windowWillResize:(NSWindow *)sender toSize:(NSSize)frameSize { +- (NSSize)windowWillResize:(NSWindow*)sender toSize:(NSSize)frameSize { NSSize newSize = frameSize; double aspectRatio = shell_->GetAspectRatio(); if (aspectRatio > 0.0) { - gfx::Size windowFrameSize = shell_->GetSize(); - gfx::Size contentViewSize = shell_->GetContentSize(); - gfx::Size aspectRatioExtraSize = shell_->GetAspectRatioExtraSize(); - double extraWidthPlusFrame = windowFrameSize.width() - contentViewSize.width() + aspectRatioExtraSize.width(); - double extraHeightPlusFrame = windowFrameSize.height() - contentViewSize.height() + aspectRatioExtraSize.height(); + gfx::Size windowSize = shell_->GetSize(); + gfx::Size contentSize = shell_->GetContentSize(); + gfx::Size extraSize = shell_->GetAspectRatioExtraSize(); - newSize.width = roundf(((frameSize.height - extraHeightPlusFrame) * aspectRatio) + extraWidthPlusFrame); + double extraWidthPlusFrame = + windowSize.width() - contentSize.width() + extraSize.width(); + double extraHeightPlusFrame = + windowSize.height() - contentSize.height() + extraSize.height(); - // If the new width is less than the frame size use it as the primary constraint. This ensures that the value returned - // by this method will never be larger than the users requested window size. + newSize.width = + roundf((frameSize.height - extraHeightPlusFrame) * aspectRatio + + extraWidthPlusFrame); + + // If the new width is less than the frame size use it as the primary + // constraint. This ensures that the value returned by this method will + // never be larger than the users requested window size. if (newSize.width <= frameSize.width) { - newSize.height = roundf(((newSize.width - extraWidthPlusFrame) / aspectRatio) + extraHeightPlusFrame); - } - else { - newSize.height = roundf(((frameSize.width - extraWidthPlusFrame) / aspectRatio) + extraHeightPlusFrame); - newSize.width = roundf(((newSize.height - extraHeightPlusFrame) * aspectRatio) + extraWidthPlusFrame); + newSize.height = + roundf((newSize.width - extraWidthPlusFrame) / aspectRatio + + extraHeightPlusFrame); + } else { + newSize.height = + roundf((frameSize.width - extraWidthPlusFrame) / aspectRatio + + extraHeightPlusFrame); + newSize.width = + roundf((newSize.height - extraHeightPlusFrame) * aspectRatio + + extraWidthPlusFrame); } } From 72eb87a6312316ba595c2709348f12d5c8cd52bc Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 23 Jul 2015 10:14:02 +0800 Subject: [PATCH 0665/1293] Make the extraSize of BrowserWindow.setAspectRatio optional --- atom/browser/api/atom_api_window.cc | 10 ++++++---- atom/browser/api/atom_api_window.h | 2 +- docs/api/browser-window.md | 4 +++- 3 files changed, 10 insertions(+), 6 deletions(-) diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index c4e6b06af06f..5f7c2503fced 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -249,10 +249,6 @@ bool Window::IsFullscreen() { return window_->IsFullscreen(); } -void Window::SetAspectRatio(double aspect_ratio, const gfx::Size& extraSize) { - window_->SetAspectRatio(aspect_ratio, extraSize); -} - void Window::SetBounds(const gfx::Rect& bounds) { window_->SetBounds(bounds); } @@ -455,6 +451,12 @@ void Window::ShowDefinitionForSelection() { } #endif +void Window::SetAspectRatio(double aspect_ratio, mate::Arguments* args) { + gfx::Size extra_size; + args->GetNext(&extra_size); + window_->SetAspectRatio(aspect_ratio, extra_size); +} + void Window::SetVisibleOnAllWorkspaces(bool visible) { return window_->SetVisibleOnAllWorkspaces(visible); } diff --git a/atom/browser/api/atom_api_window.h b/atom/browser/api/atom_api_window.h index f807ab135f28..cc2b3a64b5e9 100644 --- a/atom/browser/api/atom_api_window.h +++ b/atom/browser/api/atom_api_window.h @@ -95,7 +95,6 @@ class Window : public mate::TrackableObject, bool IsMinimized(); void SetFullScreen(bool fullscreen); bool IsFullscreen(); - void SetAspectRatio(double aspect_ratio, const gfx::Size& extraSize); void SetBounds(const gfx::Rect& bounds); gfx::Rect GetBounds(); void SetSize(int width, int height); @@ -135,6 +134,7 @@ class Window : public mate::TrackableObject, bool IsMenuBarAutoHide(); void SetMenuBarVisibility(bool visible); bool IsMenuBarVisible(); + void SetAspectRatio(double aspect_ratio, mate::Arguments* args); #if defined(OS_MACOSX) void ShowDefinitionForSelection(); diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 445265e54471..c8fc39a53f1f 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -361,7 +361,7 @@ Sets whether the window should be in fullscreen mode. Returns whether the window is in fullscreen mode. -### BrowserWindow.setAspectRatio(aspectRatio, [extraSize]) +### BrowserWindow.setAspectRatio(aspectRatio[, extraSize]) * `aspectRatio` The aspect ratio we want to maintain for some portion of the content view. * `rect` Object - The extra size to not be included in the aspect ratio to be maintained. @@ -372,6 +372,8 @@ This will have a window maintain an aspect ratio. The extra size allows a develo Consider a normal window with an HD video player and associated controls. Perhaps there are 15 pixels of controls on the left edge, 25 pixels of controls on the right edge and 50 pixels of controls below the player. In order to maintain a 16:9 aspect ratio (standard aspect ratio for HD @1920x1080) within the player itself we would call this function with arguments of 16/9 and [ 40, 50 ]. The second argument doesn't care where the extra width and height are within the content view — only that they exist. Just sum any extra width and height areas you have within the overall content view. +__Note__: This API is only implemented on OS X. + ### BrowserWindow.setBounds(options) * `options` Object From eb92e9cdd80c518c2ac2bb87287cfdf9eb4dee0a Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 23 Jul 2015 13:46:34 +0800 Subject: [PATCH 0666/1293] Use node::MakeCallback to emit events in C++ Fix #2165 --- atom/common/event_emitter_caller.cc | 19 ++++--------------- 1 file changed, 4 insertions(+), 15 deletions(-) diff --git a/atom/common/event_emitter_caller.cc b/atom/common/event_emitter_caller.cc index 85f56a233731..3dbdc9db956d 100644 --- a/atom/common/event_emitter_caller.cc +++ b/atom/common/event_emitter_caller.cc @@ -4,6 +4,8 @@ #include "atom/common/event_emitter_caller.h" +#include "atom/common/node_includes.h" + namespace mate { namespace internal { @@ -11,21 +13,8 @@ namespace internal { v8::Local CallEmitWithArgs(v8::Isolate* isolate, v8::Local obj, ValueVector* args) { - v8::Local emit_name = StringToSymbol(isolate, "emit"); - v8::Local emit = obj->Get(emit_name); - if (emit.IsEmpty() || !emit->IsFunction()) { - isolate->ThrowException(v8::Exception::TypeError( - StringToV8(isolate, "\"emit\" is not a function"))); - return v8::Undefined(isolate); - } - - v8::MaybeLocal result = emit.As()->Call( - isolate->GetCurrentContext(), obj, args->size(), &args->front()); - if (result.IsEmpty()) { - return v8::Undefined(isolate); - } - - return result.ToLocalChecked(); + return node::MakeCallback( + isolate, obj, "emit", args->size(), &args->front()); } } // namespace internal From da724d65d703a34a379b29527bbbc20dcbd4e4f4 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 23 Jul 2015 14:16:43 +0800 Subject: [PATCH 0667/1293] Add |options| for ShowMessageBox --- atom/browser/api/atom_api_dialog.cc | 7 ++++--- atom/browser/api/lib/dialog.coffee | 1 + atom/browser/ui/message_box.h | 7 +++++++ atom/browser/ui/message_box_gtk.cc | 2 ++ atom/browser/ui/message_box_mac.mm | 2 ++ atom/browser/ui/message_box_win.cc | 2 ++ 6 files changed, 18 insertions(+), 3 deletions(-) diff --git a/atom/browser/api/atom_api_dialog.cc b/atom/browser/api/atom_api_dialog.cc index b5fd655d6f26..695c11e336ee 100644 --- a/atom/browser/api/atom_api_dialog.cc +++ b/atom/browser/api/atom_api_dialog.cc @@ -42,6 +42,7 @@ namespace { void ShowMessageBox(int type, const std::vector& buttons, int cancel_id, + int options, const std::vector& texts, const gfx::ImageSkia& icon, atom::NativeWindow* window, @@ -59,11 +60,11 @@ void ShowMessageBox(int type, peek, &callback)) { atom::ShowMessageBox(window, (atom::MessageBoxType)type, buttons, cancel_id, - title, message, detail, icon, callback); + options, title, message, detail, icon, callback); } else { int chosen = atom::ShowMessageBox(window, (atom::MessageBoxType)type, - buttons, cancel_id, title, message, - detail, icon); + buttons, cancel_id, options, title, + message, detail, icon); args->Return(chosen); } } diff --git a/atom/browser/api/lib/dialog.coffee b/atom/browser/api/lib/dialog.coffee index 7a60b7f846e0..35ef6240918c 100644 --- a/atom/browser/api/lib/dialog.coffee +++ b/atom/browser/api/lib/dialog.coffee @@ -104,6 +104,7 @@ module.exports = binding.showMessageBox messageBoxType, options.buttons, options.cancelId, + 0, [options.title, options.message, options.detail], options.icon, window, diff --git a/atom/browser/ui/message_box.h b/atom/browser/ui/message_box.h index 817da2c56998..22cfa267b256 100644 --- a/atom/browser/ui/message_box.h +++ b/atom/browser/ui/message_box.h @@ -27,12 +27,18 @@ enum MessageBoxType { MESSAGE_BOX_TYPE_QUESTION, }; +enum MessageBoxOptions { + MESSAGE_BOX_NONE = 0, + MESSAGE_BOX_NO_LINKS = 1 << 0, +}; + typedef base::Callback MessageBoxCallback; int ShowMessageBox(NativeWindow* parent_window, MessageBoxType type, const std::vector& buttons, int cancel_id, + int options, const std::string& title, const std::string& message, const std::string& detail, @@ -42,6 +48,7 @@ void ShowMessageBox(NativeWindow* parent_window, MessageBoxType type, const std::vector& buttons, int cancel_id, + int options, const std::string& title, const std::string& message, const std::string& detail, diff --git a/atom/browser/ui/message_box_gtk.cc b/atom/browser/ui/message_box_gtk.cc index 07695d49845c..41682190e60e 100644 --- a/atom/browser/ui/message_box_gtk.cc +++ b/atom/browser/ui/message_box_gtk.cc @@ -162,6 +162,7 @@ int ShowMessageBox(NativeWindow* parent, MessageBoxType type, const std::vector& buttons, int cancel_id, + int options, const std::string& title, const std::string& message, const std::string& detail, @@ -174,6 +175,7 @@ void ShowMessageBox(NativeWindow* parent, MessageBoxType type, const std::vector& buttons, int cancel_id, + int options, const std::string& title, const std::string& message, const std::string& detail, diff --git a/atom/browser/ui/message_box_mac.mm b/atom/browser/ui/message_box_mac.mm index 8fe3b7d060c3..e518af653da4 100644 --- a/atom/browser/ui/message_box_mac.mm +++ b/atom/browser/ui/message_box_mac.mm @@ -95,6 +95,7 @@ int ShowMessageBox(NativeWindow* parent_window, MessageBoxType type, const std::vector& buttons, int cancel_id, + int options, const std::string& title, const std::string& message, const std::string& detail, @@ -127,6 +128,7 @@ void ShowMessageBox(NativeWindow* parent_window, MessageBoxType type, const std::vector& buttons, int cancel_id, + int options, const std::string& title, const std::string& message, const std::string& detail, diff --git a/atom/browser/ui/message_box_win.cc b/atom/browser/ui/message_box_win.cc index dae518deb4dc..d8e088072306 100644 --- a/atom/browser/ui/message_box_win.cc +++ b/atom/browser/ui/message_box_win.cc @@ -163,6 +163,7 @@ int ShowMessageBox(NativeWindow* parent, MessageBoxType type, const std::vector& buttons, int cancel_id, + int options, const std::string& title, const std::string& message, const std::string& detail, @@ -190,6 +191,7 @@ void ShowMessageBox(NativeWindow* parent, MessageBoxType type, const std::vector& buttons, int cancel_id, + int options, const std::string& title, const std::string& message, const std::string& detail, From 1578d2fda9b00616b12e7592a6dede87c2f8bf0a Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 23 Jul 2015 15:00:42 +0800 Subject: [PATCH 0668/1293] Allow the C++ JS binding function to accept arbitrary long arguments --- atom/browser/api/atom_api_dialog.cc | 11 +++-------- atom/browser/api/lib/dialog.coffee | 4 +++- vendor/native_mate | 2 +- 3 files changed, 7 insertions(+), 10 deletions(-) diff --git a/atom/browser/api/atom_api_dialog.cc b/atom/browser/api/atom_api_dialog.cc index 695c11e336ee..47021407e1ea 100644 --- a/atom/browser/api/atom_api_dialog.cc +++ b/atom/browser/api/atom_api_dialog.cc @@ -43,17 +43,12 @@ void ShowMessageBox(int type, const std::vector& buttons, int cancel_id, int options, - const std::vector& texts, + const std::string& title, + const std::string& message, + const std::string& detail, const gfx::ImageSkia& icon, atom::NativeWindow* window, mate::Arguments* args) { - // FIXME We are exceeding the parameters limit of base::Bind here, so we have - // to pass some parameters in an array. We should remove this once we have - // variadic template support in base::Bind. - const std::string& title = texts[0]; - const std::string& message = texts[1]; - const std::string& detail = texts[2]; - v8::Local peek = args->PeekNext(); atom::MessageBoxCallback callback; if (mate::Converter::FromV8(args->isolate(), diff --git a/atom/browser/api/lib/dialog.coffee b/atom/browser/api/lib/dialog.coffee index 35ef6240918c..a1dcaafe78fe 100644 --- a/atom/browser/api/lib/dialog.coffee +++ b/atom/browser/api/lib/dialog.coffee @@ -105,7 +105,9 @@ module.exports = options.buttons, options.cancelId, 0, - [options.title, options.message, options.detail], + options.title, + options.message, + options.detail, options.icon, window, callback diff --git a/vendor/native_mate b/vendor/native_mate index 41cd6d13c9c9..656e403f0102 160000 --- a/vendor/native_mate +++ b/vendor/native_mate @@ -1 +1 @@ -Subproject commit 41cd6d13c9c9be164f427864277f3cc36b69eb39 +Subproject commit 656e403f0102c59428261c1eaad22912d2bbd3c5 From cc2a9f617d755da98e915d772ad8813b2feb0d4a Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 23 Jul 2015 17:20:43 +0800 Subject: [PATCH 0669/1293] Add noLink option for showMessageBox --- atom/browser/api/lib/dialog.coffee | 7 ++++++- atom/browser/ui/message_box.h | 4 ++-- atom/browser/ui/message_box_win.cc | 7 +++++-- docs/api/dialog.md | 7 ++++++- 4 files changed, 19 insertions(+), 6 deletions(-) diff --git a/atom/browser/api/lib/dialog.coffee b/atom/browser/api/lib/dialog.coffee index a1dcaafe78fe..0843af04282e 100644 --- a/atom/browser/api/lib/dialog.coffee +++ b/atom/browser/api/lib/dialog.coffee @@ -11,6 +11,9 @@ fileDialogProperties = messageBoxTypes = ['none', 'info', 'warning', 'error', 'question'] +messageBoxOptions = + noLink: 1 << 0 + parseArgs = (window, options, callback) -> unless window is null or window?.constructor is BrowserWindow # Shift. @@ -101,10 +104,12 @@ module.exports = options.cancelId = i break + flags = if options.noLink then messageBoxOptions.noLink else 0 + binding.showMessageBox messageBoxType, options.buttons, options.cancelId, - 0, + flags, options.title, options.message, options.detail, diff --git a/atom/browser/ui/message_box.h b/atom/browser/ui/message_box.h index 22cfa267b256..92052d3de4a4 100644 --- a/atom/browser/ui/message_box.h +++ b/atom/browser/ui/message_box.h @@ -28,8 +28,8 @@ enum MessageBoxType { }; enum MessageBoxOptions { - MESSAGE_BOX_NONE = 0, - MESSAGE_BOX_NO_LINKS = 1 << 0, + MESSAGE_BOX_NONE = 0, + MESSAGE_BOX_NO_LINK = 1 << 0, }; typedef base::Callback MessageBoxCallback; diff --git a/atom/browser/ui/message_box_win.cc b/atom/browser/ui/message_box_win.cc index d8e088072306..194a0d79f8f8 100644 --- a/atom/browser/ui/message_box_win.cc +++ b/atom/browser/ui/message_box_win.cc @@ -72,6 +72,7 @@ int ShowMessageBoxUTF16(HWND parent, MessageBoxType type, const std::vector& buttons, int cancel_id, + int options, const base::string16& title, const base::string16& message, const base::string16& detail, @@ -126,7 +127,8 @@ int ShowMessageBoxUTF16(HWND parent, if (dialog_buttons.size() > 0) { config.pButtons = &dialog_buttons.front(); config.cButtons = dialog_buttons.size(); - config.dwFlags |= TDF_USE_COMMAND_LINKS; // custom buttons as links. + if (!(options & MESSAGE_BOX_NO_LINK)) + config.dwFlags |= TDF_USE_COMMAND_LINKS; // custom buttons as links. } int id = 0; @@ -181,6 +183,7 @@ int ShowMessageBox(NativeWindow* parent, type, utf16_buttons, cancel_id, + options, base::UTF8ToUTF16(title), base::UTF8ToUTF16(message), base::UTF8ToUTF16(detail), @@ -214,7 +217,7 @@ void ShowMessageBox(NativeWindow* parent, } void ShowErrorBox(const base::string16& title, const base::string16& content) { - ShowMessageBoxUTF16(NULL, MESSAGE_BOX_TYPE_ERROR, {}, 0, L"Error", title, + ShowMessageBoxUTF16(NULL, MESSAGE_BOX_TYPE_ERROR, {}, 0, 0, L"Error", title, content, gfx::ImageSkia()); } diff --git a/docs/api/dialog.md b/docs/api/dialog.md index f6b65a1bb06c..d9336c0c8a3a 100644 --- a/docs/api/dialog.md +++ b/docs/api/dialog.md @@ -80,7 +80,12 @@ will be passed via `callback(filename)` instead of clicking the buttons of the dialog. By default it is the index of the buttons that have "cancel" or "no" as label, or 0 if there is no such buttons. On OS X and Windows the index of "Cancel" button will always be - used as `cancelId`, not matter whether it is already specified. + used as `cancelId`, not matter whether it is already specified + * `noLink` Boolean - On Windows Electron would try to figure out which ones of + the `buttons` are common buttons (like "Cancel" or "Yes"), and show the + others as command links in the dialog, this can make the dialog appear in + the style of modern Windows apps. If you don't like this behavior, you can + specify `noLink` to `true` * `callback` Function Shows a message box, it will block until the message box is closed. It returns From 6c44553456a17ec1db55fb4edb5bd31e0298fd90 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 23 Jul 2015 17:28:04 +0800 Subject: [PATCH 0670/1293] Show all buttons as custom buttons when noLink is specified --- atom/browser/ui/message_box_win.cc | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/atom/browser/ui/message_box_win.cc b/atom/browser/ui/message_box_win.cc index 194a0d79f8f8..58d1badc3bfd 100644 --- a/atom/browser/ui/message_box_win.cc +++ b/atom/browser/ui/message_box_win.cc @@ -123,7 +123,12 @@ int ShowMessageBoxUTF16(HWND parent, // and custom buttons in pButtons. std::map id_map; std::vector dialog_buttons; - MapToCommonID(buttons, &id_map, &config.dwCommonButtons, &dialog_buttons); + if (options & MESSAGE_BOX_NO_LINK) { + for (size_t i = 0; i < buttons.size(); ++i) + dialog_buttons.push_back({i + kIDStart, buttons[i].c_str()}); + } else { + MapToCommonID(buttons, &id_map, &config.dwCommonButtons, &dialog_buttons); + } if (dialog_buttons.size() > 0) { config.pButtons = &dialog_buttons.front(); config.cButtons = dialog_buttons.size(); @@ -146,13 +151,14 @@ void RunMessageBoxInNewThread(base::Thread* thread, MessageBoxType type, const std::vector& buttons, int cancel_id, + int options, const std::string& title, const std::string& message, const std::string& detail, const gfx::ImageSkia& icon, const MessageBoxCallback& callback) { - int result = ShowMessageBox(parent, type, buttons, cancel_id, title, message, - detail, icon); + int result = ShowMessageBox(parent, type, buttons, cancel_id, options, title, + message, detail, icon); content::BrowserThread::PostTask( content::BrowserThread::UI, FROM_HERE, base::Bind(callback, result)); content::BrowserThread::DeleteSoon( @@ -212,8 +218,8 @@ void ShowMessageBox(NativeWindow* parent, unretained->message_loop()->PostTask( FROM_HERE, base::Bind(&RunMessageBoxInNewThread, base::Unretained(unretained), - parent, type, buttons, cancel_id, title, message, detail, icon, - callback)); + parent, type, buttons, cancel_id, options, title, message, + detail, icon, callback)); } void ShowErrorBox(const base::string16& title, const base::string16& content) { From 452619990e8748ff1d95406d7369b43e65166770 Mon Sep 17 00:00:00 2001 From: Jeffrey Morgan Date: Thu, 23 Jul 2015 17:55:57 +0100 Subject: [PATCH 0671/1293] Improve grammar and punctuation of accelerator.md Improve the grammar, sentence structure, punctuation and formatting of `accelerator.md`. --- docs/api/accelerator.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/api/accelerator.md b/docs/api/accelerator.md index a9755ed653b0..8c1b3e70ce4c 100644 --- a/docs/api/accelerator.md +++ b/docs/api/accelerator.md @@ -1,6 +1,6 @@ # Accelerator -An accelerator is string that represents a keyboard shortcut, it can contain +An accelerator is a string that represents a keyboard shortcut. It can contain multiple modifiers and key codes, combined by the `+` character. Examples: @@ -10,11 +10,11 @@ Examples: ## Platform notice -On Linux and Windows, the `Command` key would not have any effect, you can +On Linux and Windows, the `Command` key does not have any effect so use `CommandOrControl` which represents `Command` on OS X and `Control` on Linux and Windows to define some accelerators. -The `Super` key is mapped to the `Windows` key on Windows and Linux and +The `Super` key is mapped onto the `Windows` key on Windows and Linux and onto `Cmd` on OS X. ## Available modifiers From d138c2970c2711306ddae1e9d0fa953be2227d60 Mon Sep 17 00:00:00 2001 From: Jeffrey Morgan Date: Thu, 23 Jul 2015 17:57:42 +0100 Subject: [PATCH 0672/1293] Improve grammar and punctuation of auto-updater.md Improve the grammar, sentence structure, punctuation and formatting of `auto-updater.md`. --- docs/api/auto-updater.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/api/auto-updater.md b/docs/api/auto-updater.md index 8da46e2083c9..a14e3ecd91f0 100644 --- a/docs/api/auto-updater.md +++ b/docs/api/auto-updater.md @@ -3,9 +3,9 @@ **This module has only been implemented for OS X.** Check out [atom/grunt-electron-installer](https://github.com/atom/grunt-electron-installer) -for building a Windows installer for your app. +to build a Windows installer for your app. -The `auto-updater` module is a simple wrap around the +The `auto-updater` module is a simple wrapper around the [Squirrel.Mac](https://github.com/Squirrel/Squirrel.Mac) framework. Squirrel.Mac requires that your `.app` folder is signed using the @@ -26,11 +26,11 @@ body so that your server has the context it needs in order to supply the most suitable update. The update JSON Squirrel requests should be dynamically generated based on -criteria in the request, and whether an update is required. Squirrel relies -on server side support for determining whether an update is required, see +criteria in the request and whether an update is required. Squirrel relies +on server-side support to determine whether an update is required. See [Server Support](#server-support). -Squirrel's installer is also designed to be fault tolerant, and ensure that any +Squirrel's installer is designed to be fault tolerant and ensures that any updates installed are valid. ## Update Requests @@ -40,11 +40,11 @@ update checking. `Accept: application/json` is added to the request headers because Squirrel is responsible for parsing the response. For the requirements imposed on the responses and the body format of an update -response see [Server Support](#server-support). +response, see [Server Support](#server-support). Your update request must *at least* include a version identifier so that the server can determine whether an update for this specific version is required. It -may also include other identifying criteria such as operating system version or +may also include other identifying criteria, such as operating system version or username, to allow the server to deliver as fine grained an update as you would like. @@ -64,7 +64,7 @@ autoUpdater.setFeedUrl('http://mycompany.com/myapp/latest?version=' + app.getVer Your server should determine whether an update is required based on the [Update Request](#update-requests) your client issues. -If an update is required your server should respond with a status code of +If an update is required, your server should respond with a status code of [200 OK](http://tools.ietf.org/html/rfc2616#section-10.2.1) and include the [update JSON](#update-json-format) in the body. Squirrel **will** download and install this update, even if the version of the update is the same as the @@ -89,29 +89,29 @@ to the update request provided: } ``` -The only required key is "url", the others are optional. +The only required key is "url"; the others are optional. Squirrel will request "url" with `Accept: application/zip` and only supports installing ZIP updates. If future update formats are supported their MIME type will be added to the `Accept` header so that your server can return the appropriate format. -`pub_date` if present must be formatted according to ISO 8601. +`pub_date` (if present) must be formatted according to ISO 8601. ## Event: error * `event` Event * `message` String -Emitted when there is an error updating. +Emitted when there is an error while updating. ## Event: checking-for-update -Emitted when checking for update has started. +Emitted when checking for an update has started. ## Event: update-available -Emitted when there is an available update, the update would be downloaded +Emitted when there is an available update. The update is downloaded automatically. ## Event: update-not-available @@ -127,17 +127,17 @@ Emitted when there is no available update. * `updateUrl` String * `quitAndUpdate` Function -Emitted when update has been downloaded, calling `quitAndUpdate()` would restart +Emitted when an update has been downloaded. Calling `quitAndUpdate()` will restart the application and install the update. ## autoUpdater.setFeedUrl(url) * `url` String -Set the `url` and initialize the auto updater. The `url` could not be changed +Set the `url` and initialize the auto updater. The `url` cannot be changed once it is set. ## autoUpdater.checkForUpdates() -Ask the server whether there is an update, you have to call `setFeedUrl` before +Ask the server whether there is an update. You must call `setFeedUrl` before using this API. From adab7697006a3a402b99436be3a35e34a4ef1c76 Mon Sep 17 00:00:00 2001 From: Jeffrey Morgan Date: Thu, 23 Jul 2015 17:59:51 +0100 Subject: [PATCH 0673/1293] Improve grammar and punctuation of `chrome-command-line-switches.md` Improve the grammar, sentence structure, punctuation and formatting of `chrome-command-line-switches.md` --- docs/api/chrome-command-line-switches.md | 28 ++++++++++++------------ 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/api/chrome-command-line-switches.md b/docs/api/chrome-command-line-switches.md index d55dea4c1b5a..94bb200168ff 100644 --- a/docs/api/chrome-command-line-switches.md +++ b/docs/api/chrome-command-line-switches.md @@ -1,8 +1,8 @@ # Supported Chrome command line switches -The following command lines switches in Chrome browser are also supported in -Electron, you can use [app.commandLine.appendSwitch][append-switch] to append -them in your app's main script before the [ready][ready] event of [app][app] +This page lists the command line switches used by the Chrome browser that are also supported by +Electron. You can use [app.commandLine.appendSwitch][append-switch] to append +them to your app's main script before the [ready][ready] event of [app][app] module is emitted: ```javascript @@ -17,11 +17,11 @@ app.on('ready', function() { ## --client-certificate=`path` -Sets `path` of client certificate file. +Sets the `path` of client certificate file. ## --ignore-connections-limit=`domains` -Ignore the connections limit for `domains` list seperated by `,`. +Ignore the connections limit for `domains` list separated by `,`. ## --disable-http-cache @@ -29,11 +29,11 @@ Disables the disk cache for HTTP requests. ## --remote-debugging-port=`port` -Enables remote debug over HTTP on the specified `port`. +Enables remote debugging over HTTP on the specified `port`. ## --proxy-server=`address:port` -Uses a specified proxy server, overrides system settings. This switch only +Use a specified proxy server, which overrides the system setting. This switch only affects HTTP and HTTPS requests. ## --proxy-pac-url=`url` @@ -42,12 +42,12 @@ Uses the PAC script at the specified `url`. ## --no-proxy-server -Don't use a proxy server, always make direct connections. Overrides any other +Don't use a proxy server and always make direct connections. Overrides any other proxy server flags that are passed. ## --host-rules=`rules` -Comma-separated list of `rules` that control how hostnames are mapped. +A comma-separated list of `rules` that control how hostnames are mapped. For example: @@ -60,7 +60,7 @@ For example: "www.google.com". These mappings apply to the endpoint host in a net request (the TCP connect -and host resolver in a direct connection, and the `CONNECT` in an http proxy +and host resolver in a direct connection, and the `CONNECT` in an HTTP proxy connection, and the endpoint host in a `SOCKS` proxy connection). ## --host-resolver-rules=`rules` @@ -77,15 +77,15 @@ Ignores certificate related errors. ## --ppapi-flash-path=`path` -Sets `path` of pepper flash plugin. +Sets the `path` of the pepper flash plugin. ## --ppapi-flash-version=`version` -Sets `version` of pepper flash plugin. +Sets the `version` of the pepper flash plugin. ## --log-net-log=`path` -Enables saving net log events and writes them to `path`. +Enables net log events to be saved and writes them to `path`. ## --v=`log_level` @@ -102,7 +102,7 @@ source files `my_module.*` and `foo*.*`. Any pattern containing a forward or backward slash will be tested against the whole pathname and not just the module. E.g. `*/foo/bar/*=2` would change the -logging level for all code in source files under a `foo/bar` directory. +logging level for all code in the source files under a `foo/bar` directory. To disable all chromium related logs and only enable your application logs you can do: From 32b84bd3f9af942a1189ea0f3150898127771931 Mon Sep 17 00:00:00 2001 From: Jeffrey Morgan Date: Thu, 23 Jul 2015 18:01:00 +0100 Subject: [PATCH 0674/1293] Improve grammar and punctuation of clipboard.md Improve the grammar, sentence structure, punctuation and formatting of `clipboard.md`. --- docs/api/clipboard.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/api/clipboard.md b/docs/api/clipboard.md index 572e91e96637..b2331b6279cc 100644 --- a/docs/api/clipboard.md +++ b/docs/api/clipboard.md @@ -1,14 +1,14 @@ # clipboard -The `clipboard` provides methods to do copy/paste operations. An example of -writing a string to clipboard: +The `clipboard` provides methods to perform copy and paste operations. The following example +shows how to write a string to the clipboard: ```javascript var clipboard = require('clipboard'); clipboard.writeText('Example String'); ``` -On X Window systems, there is also a selection clipboard, to manipulate in it +On X Window systems, there is also a selection clipboard. To manipulate it you need to pass `selection` to each method: ```javascript @@ -21,46 +21,46 @@ console.log(clipboard.readText('selection')); * `type` String -Returns the content in clipboard as plain text. +Returns the content in the clipboard as plain text. ## clipboard.writeText(text[, type]) * `text` String * `type` String -Writes the `text` into clipboard as plain text. +Writes the `text` into the clipboard as plain text. ## clipboard.readHtml([type]) * `type` String -Returns the content in clipboard as markup. +Returns the content in the clipboard as markup. ## clipboard.writeHtml(markup[, type]) * `markup` String * `type` String -Writes the `markup` into clipboard. +Writes `markup` into the clipboard. ## clipboard.readImage([type]) * `type` String -Returns the content in clipboard as [NativeImage](native-image.md). +Returns the content in the clipboard as a [NativeImage](native-image.md). ## clipboard.writeImage(image[, type]) * `image` [NativeImage](native-image.md) * `type` String -Writes the `image` into clipboard. +Writes `image` into the clipboard. ## clipboard.clear([type]) * `type` String -Clears everything in clipboard. +Clears the clipboard. ## clipboard.availableFormats([type]) @@ -71,7 +71,7 @@ Returns an array of supported `format` for the clipboard `type`. * `data` String * `type` String -Returns whether clipboard supports the format of specified `data`. +Returns whether the clipboard supports the format of specified `data`. ```javascript var clipboard = require('clipboard'); @@ -85,7 +85,7 @@ console.log(clipboard.has('

selection

')); * `data` String * `type` String -Reads the `data` in clipboard. +Reads `data` from the clipboard. **Note:** This API is experimental and could be removed in future. @@ -101,4 +101,4 @@ Reads the `data` in clipboard. var clipboard = require('clipboard'); clipboard.write({text: 'test', html: "test"}); ``` -Writes the `data` iinto clipboard. +Writes `data` into clipboard. From 8b4815fd95d862ee1e6fc8a3dc6f94044198ad2b Mon Sep 17 00:00:00 2001 From: Jeffrey Morgan Date: Thu, 23 Jul 2015 18:02:45 +0100 Subject: [PATCH 0675/1293] Improve grammar and punctuation of crash-reporter.md Improve the grammar, sentence structure, punctuation and formatting of `crash-reporter.md`. --- docs/api/crash-reporter.md | 29 ++++++++++++++--------------- 1 file changed, 14 insertions(+), 15 deletions(-) diff --git a/docs/api/crash-reporter.md b/docs/api/crash-reporter.md index ec937e5252a5..da35008ea7f4 100644 --- a/docs/api/crash-reporter.md +++ b/docs/api/crash-reporter.md @@ -1,6 +1,6 @@ # crash-reporter -An example of automatically submitting crash reporters to a remote server: +The following is an example of automatically submitting a crash report to a remote server: ```javascript crashReporter = require('crash-reporter'); @@ -18,31 +18,30 @@ crashReporter.start({ * `productName` String, default: Electron * `companyName` String, default: GitHub, Inc * `submitUrl` String, default: http://54.249.141.255:1127/post - * URL that crash reports would be sent to as POST + * URL that crash reports will be sent to as POST * `autoSubmit` Boolean, default: true * Send the crash report without user interaction * `ignoreSystemCrashHandler` Boolean, default: false * `extra` Object - * An object you can define which content will be send along with the report. + * An object you can define that will be sent along with the report. * Only string properties are sent correctly. * Nested objects are not supported. -Developers are required to call this method before using other crashReporter APIs. +Developers are required to call this method before using other `crashReporter` APIs. - -**Note:** On OS X, electron uses a new `crashpad` client, which is different -with the `breakpad` on Windows and Linux. To enable crash collection feature, -you are required to call `crashReporter.start` API to initialize `crashpad` in -main process and in each renderer process that you wish to collect crash reports. +**Note:** On OS X, Electron uses a new `crashpad` client, which is different +from `breakpad` on Windows and Linux. To enable the crash collection feature, +you are required to call `crashReporter.start` API to initialize `crashpad` in the +main process and in each renderer process from which you wish to collect crash reports. ## crashReporter.getLastCrashReport() -Returns the date and ID of the last crash report, when there was no crash report -sent or the crash reporter is not started, `null` will be returned. +Returns the date and ID of the last crash report. If no crash reports have been +sent or the crash reporter has not been started, `null` is returned. ## crashReporter.getUploadedReports() -Returns all uploaded crash reports, each report contains date and uploaded ID. +Returns all uploaded crash reports. Each report contains the date and uploaded ID. # crash-reporter payload @@ -54,8 +53,8 @@ The crash reporter will send the following data to the `submitUrl` as `POST`: * `process_type` String - e.g. 'renderer' * `ptime` Number * `_version` String - The version in `package.json` -* `_productName` String - The product name in the crashReporter `options` object +* `_productName` String - The product name in the `crashReporter` `options` object * `prod` String - Name of the underlying product. In this case Electron -* `_companyName` String - The company name in the crashReporter `options` object +* `_companyName` String - The company name in the `crashReporter` `options` object * `upload_file_minidump` File - The crashreport as file -* All level one properties of the `extra` object in the crashReporter `options` object +* All level one properties of the `extra` object in the `crashReporter` `options` object From 63258f9f53efa3b9ff18e7df4c95572787c620e3 Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Fri, 24 Jul 2015 02:39:55 +0900 Subject: [PATCH 0676/1293] Update as upstream, Fix typos --- docs/api/app-ko.md | 321 --------- docs/api/browser-window-ko.md | 1169 --------------------------------- docs/api/dialog-ko.md | 14 +- docs/api/tray-ko.md | 34 +- docs/api/web-view-tag-ko.md | 4 + 5 files changed, 46 insertions(+), 1496 deletions(-) delete mode 100644 docs/api/app-ko.md delete mode 100644 docs/api/browser-window-ko.md diff --git a/docs/api/app-ko.md b/docs/api/app-ko.md deleted file mode 100644 index 434d0620282a..000000000000 --- a/docs/api/app-ko.md +++ /dev/null @@ -1,321 +0,0 @@ -# app - -The `app` module is responsible for controlling the application's life time. - -The example of quitting the whole application when the last window is closed: - -```javascript -var app = require('app'); -app.on('window-all-closed', function() { - app.quit(); -}); -``` - -## Event: will-finish-launching - -Emitted when application has done basic startup. On Windows and Linux it is the -same with `ready` event, on OS X this event represents the -`applicationWillFinishLaunching` message of `NSApplication`, usually you would -setup listeners to `open-file` and `open-url` events here, and start the crash -reporter and auto updater. - -Under most cases you should just do everything in `ready` event. - -## Event: ready - -Emitted when Electron has done everything initialization. - -## Event: window-all-closed - -Emitted when all windows have been closed. - -This event is only emitted when the application is not going to quit. If a -user pressed `Cmd + Q`, or the developer called `app.quit()`, Electron would -first try to close all windows and then emit the `will-quit` event, and in -this case the `window-all-closed` would not be emitted. - -## Event: before-quit - -* `event` Event - -Emitted before the application starts closing its windows. -Calling `event.preventDefault()` will prevent the default behaviour, which is -terminating the application. - -## Event: will-quit - -* `event` Event - -Emitted when all windows have been closed and the application will quit. -Calling `event.preventDefault()` will prevent the default behaviour, which is -terminating the application. - -See description of `window-all-closed` for the differences between `will-quit` -and it. - -## Event: quit - -Emitted when application is quitting. - -## Event: open-file - -* `event` Event -* `path` String - -Emitted when user wants to open a file with the application, it usually happens -when the application is already opened and then OS wants to reuse the -application to open file. But it is also emitted when a file is dropped onto the -dock and the application is not yet running. Make sure to listen to open-file -very early in your application startup to handle this case (even before the -`ready` event is emitted). - -You should call `event.preventDefault()` if you want to handle this event. - -## Event: open-url - -* `event` Event -* `url` String - -Emitted when user wants to open a URL with the application, this URL scheme -must be registered to be opened by your application. - -You should call `event.preventDefault()` if you want to handle this event. - -## Event: activate-with-no-open-windows - -Emitted when the application is activated while there is no opened windows. It -usually happens when user has closed all of application's windows and then -click on the application's dock icon. - -## Event: browser-window-blur - -* `event` Event -* `window` BrowserWindow - -Emitted when a [browserWindow](browser-window-ko.md) gets blurred. - -## Event: browser-window-focus - -* `event` Event -* `window` BrowserWindow - -Emitted when a [browserWindow](browser-window-ko.md) gets focused. - -### Event: 'select-certificate' - -Emitted when client certificate is requested. - -* `event` Event -* `webContents` [WebContents](browser-window-ko.md#class-webcontents) -* `url` String -* `certificateList` [Objects] - * `data` PEM encoded data - * `issuerName` Issuer's Common Name -* `callback` Function - -``` -app.on('select-certificate', function(event, host, url, list, callback) { - event.preventDefault(); - callback(list[0]); -}) -``` - -`url` corresponds to the navigation entry requesting the client certificate, -`callback` needs to be called with an entry filtered from the list. -`event.preventDefault()` prevents from using the first certificate from -the store. - -### Event: 'gpu-process-crashed' - -Emitted when the gpu process is crashed. - -## app.quit() - -Try to close all windows. The `before-quit` event will first be emitted. If all -windows are successfully closed, the `will-quit` event will be emitted and by -default the application would be terminated. - -This method guarantees all `beforeunload` and `unload` handlers are correctly -executed. It is possible that a window cancels the quitting by returning -`false` in `beforeunload` handler. - -## app.getAppPath() - -Returns the current application directory. - -## app.getPath(name) - -* `name` String - -Retrieves a path to a special directory or file associated with `name`. On -failure an `Error` would throw. - -You can request following paths by the names: - -* `home`: User's home directory -* `appData`: Per-user application data directory, by default it is pointed to: - * `%APPDATA%` on Windows - * `$XDG_CONFIG_HOME` or `~/.config` on Linux - * `~/Library/Application Support` on OS X -* `userData`: The directory for storing your app's configuration files, by - default it is the `appData` directory appended with your app's name -* `cache`: Per-user application cache directory, by default it is pointed to: - * `%APPDATA%` on Window, which doesn't has a universal place for cache - * `$XDG_CACHE_HOME` or `~/.cache` on Linux - * `~/Library/Caches` on OS X -* `userCache`: The directory for placing your app's caches, by default it is the - `cache` directory appended with your app's name -* `temp`: Temporary directory -* `userDesktop`: The current user's Desktop directory -* `exe`: The current executable file -* `module`: The `libchromiumcontent` library - -## app.setPath(name, path) - -* `name` String -* `path` String - -Overrides the `path` to a special directory or file associated with `name`. if -the path specifies a directory that does not exist, the directory will be -created by this method. On failure an `Error` would throw. - -You can only override paths of `name`s defined in `app.getPath`. - -By default web pages' cookies and caches will be stored under `userData` -directory, if you want to change this location, you have to override the -`userData` path before the `ready` event of `app` module gets emitted. - -## app.getVersion() - -Returns the version of loaded application, if no version is found in -application's `package.json`, the version of current bundle or executable would -be returned. - -## app.getName() - -Returns current application's name, the name in `package.json` would be -used. - -Usually the `name` field of `package.json` is a short lowercased name, according -to the spec of npm modules. So usually you should also specify a `productName` -field, which is your application's full capitalized name, and it will be -preferred over `name` by Electron. - -## app.resolveProxy(url, callback) - -* `url` URL -* `callback` Function - -Resolves the proxy information for `url`, the `callback` would be called with -`callback(proxy)` when the request is done. - -## app.addRecentDocument(path) - -* `path` String - -Adds `path` to recent documents list. - -This list is managed by the system, on Windows you can visit the list from task -bar, and on Mac you can visit it from dock menu. - -## app.clearRecentDocuments() - -Clears the recent documents list. - -## app.setUserTasks(tasks) - -* `tasks` Array - Array of `Task` objects - -Adds `tasks` to the [Tasks][tasks] category of JumpList on Windows. - -The `tasks` is an array of `Task` objects in following format: - -* `Task` Object - * `program` String - Path of the program to execute, usually you should - specify `process.execPath` which opens current program - * `arguments` String - The arguments of command line when `program` is - executed - * `title` String - The string to be displayed in a JumpList - * `description` String - Description of this task - * `iconPath` String - The absolute path to an icon to be displayed in a - JumpList, it can be arbitrary resource file that contains an icon, usually - you can specify `process.execPath` to show the icon of the program - * `iconIndex` Integer - The icon index in the icon file. If an icon file - consists of two or more icons, set this value to identify the icon. If an - icon file consists of one icon, this value is 0 - -**Note:** This API is only available on Windows. - -## app.commandLine.appendSwitch(switch, [value]) - -Append a switch [with optional value] to Chromium's command line. - -**Note:** This will not affect `process.argv`, and is mainly used by developers -to control some low-level Chromium behaviors. - -## app.commandLine.appendArgument(value) - -Append an argument to Chromium's command line. The argument will quoted properly. - -**Note:** This will not affect `process.argv`. - -## app.dock.bounce([type]) - -* `type` String - Can be `critical` or `informational`, the default is - `informational` - -When `critical` is passed, the dock icon will bounce until either the -application becomes active or the request is canceled. - -When `informational` is passed, the dock icon will bounce for one second. The -request, though, remains active until either the application becomes active or -the request is canceled. - -An ID representing the request would be returned. - -**Note:** This API is only available on Mac. - -## app.dock.cancelBounce(id) - -* `id` Integer - -Cancel the bounce of `id`. - -**Note:** This API is only available on Mac. - -## app.dock.setBadge(text) - -* `text` String - -Sets the string to be displayed in the dock’s badging area. - -**Note:** This API is only available on Mac. - -## app.dock.getBadge() - -Returns the badge string of the dock. - -**Note:** This API is only available on Mac. - -## app.dock.hide() - -Hides the dock icon. - -**Note:** This API is only available on Mac. - -## app.dock.show() - -Shows the dock icon. - -**Note:** This API is only available on Mac. - -## app.dock.setMenu(menu) - -* `menu` Menu - -Sets the application [dock menu][dock-menu]. - -**Note:** This API is only available on Mac. - -[dock-menu]:https://developer.apple.com/library/mac/documentation/Carbon/Conceptual/customizing_docktile/concepts/dockconcepts.html#//apple_ref/doc/uid/TP30000986-CH2-TPXREF103 -[tasks]:http://msdn.microsoft.com/en-us/library/windows/desktop/dd378460(v=vs.85).aspx#tasks diff --git a/docs/api/browser-window-ko.md b/docs/api/browser-window-ko.md deleted file mode 100644 index 29a07661409d..000000000000 --- a/docs/api/browser-window-ko.md +++ /dev/null @@ -1,1169 +0,0 @@ -# browser-window - -The `BrowserWindow` class gives you ability to create a browser window, an -example is: - -```javascript -var BrowserWindow = require('browser-window'); - -var win = new BrowserWindow({ width: 800, height: 600, show: false }); -win.on('closed', function() { - win = null; -}); - -win.loadUrl('https://github.com'); -win.show(); -``` - -You can also create a window without chrome by using -[Frameless Window](frameless-window.md) API. - -## Class: BrowserWindow - -`BrowserWindow` is an -[EventEmitter](http://nodejs.org/api/events.html#events_class_events_eventemitter). - -### new BrowserWindow(options) - -* `options` Object - * `x` Integer - Window's left offset to screen - * `y` Integer - Window's top offset to screen - * `width` Integer - Window's width - * `height` Integer - Window's height - * `use-content-size` Boolean - The `width` and `height` would be used as web - page's size, which means the actual window's size will include window - frame's size and be slightly larger. - * `center` Boolean - Show window in the center of the screen - * `min-width` Integer - Minimum width - * `min-height` Integer - Minimum height - * `max-width` Integer - Maximum width - * `max-height` Integer - Maximum height - * `resizable` Boolean - Whether window is resizable - * `always-on-top` Boolean - Whether the window should always stay on top of - other windows - * `fullscreen` Boolean - Whether the window should show in fullscreen, when - set to `false` the fullscreen button would also be hidden on OS X - * `skip-taskbar` Boolean - Do not show window in taskbar - * `zoom-factor` Number - The default zoom factor of the page, zoom factor is - zoom percent / 100, so `3.0` represents `300%` - * `kiosk` Boolean - The kiosk mode - * `title` String - Default window title - * `icon` [NativeImage](native-image.md) - The window icon, when omitted on - Windows the executable's icon would be used as window icon - * `show` Boolean - Whether window should be shown when created - * `frame` Boolean - Specify `false` to create a - [Frameless Window](frameless-window.md) - * `node-integration` Boolean - Whether node integration is enabled, default - is `true` - * `accept-first-mouse` Boolean - Whether the web view accepts a single - mouse-down event that simultaneously activates the window - * `disable-auto-hide-cursor` Boolean - Do not hide cursor when typing - * `auto-hide-menu-bar` Boolean - Auto hide the menu bar unless the `Alt` - key is pressed. - * `enable-larger-than-screen` Boolean - Enable the window to be resized larger - than screen. - * `dark-theme` Boolean - Forces using dark theme for the window, only works on - some GTK+3 desktop environments - * `preload` String - Specifies a script that will be loaded before other - scripts run in the window. This script will always have access to node APIs - no matter whether node integration is turned on for the window, and the path - of `preload` script has to be absolute path. - * `transparent` Boolean - Makes the window [transparent](frameless-window.md) - * `type` String - Specifies the type of the window, possible types are - `desktop`, `dock`, `toolbar`, `splash`, `notification`. This only works on - Linux. - * `standard-window` Boolean - Uses the OS X's standard window instead of the - textured window. Defaults to `true`. - * `web-preferences` Object - Settings of web page's features - * `javascript` Boolean - * `web-security` Boolean - * `images` Boolean - * `java` Boolean - * `text-areas-are-resizable` Boolean - * `webgl` Boolean - * `webaudio` Boolean - * `plugins` Boolean - Whether plugins should be enabled, currently only - `NPAPI` plugins are supported. - * `extra-plugin-dirs` Array - Array of paths that would be searched for - plugins. Note that if you want to add a directory under your app, you - should use `__dirname` or `process.resourcesPath` to join the paths to - make them absolute, using relative paths would make Electron search - under current working directory. - * `experimental-features` Boolean - * `experimental-canvas-features` Boolean - * `subpixel-font-scaling` Boolean - * `overlay-scrollbars` Boolean - * `overlay-fullscreen-video` Boolean - * `shared-worker` Boolean - * `direct-write` Boolean - Whether the DirectWrite font rendering system on - Windows is enabled - * `page-visibility` Boolean - Page would be forced to be always in visible - or hidden state once set, instead of reflecting current window's - visibility. Users can set it to `true` to prevent throttling of DOM - timers. - -Creates a new `BrowserWindow` with native properties set by the `options`. -Usually you only need to set the `width` and `height`, other properties will -have decent default values. - -### Event: 'page-title-updated' - -* `event` Event - -Emitted when the document changed its title, calling `event.preventDefault()` -would prevent the native window's title to change. - -### Event: 'close' - -* `event` Event - -Emitted when the window is going to be closed. It's emitted before the -`beforeunload` and `unload` event of DOM, calling `event.preventDefault()` -would cancel the close. - -Usually you would want to use the `beforeunload` handler to decide whether the -window should be closed, which will also be called when the window is -reloaded. In Electron, returning an empty string or `false` would cancel the -close. An example is: - -```javascript -window.onbeforeunload = function(e) { - console.log('I do not want to be closed'); - - // Unlike usual browsers, in which a string should be returned and the user is - // prompted to confirm the page unload, Electron gives developers more options. - // Returning empty string or false would prevent the unloading now. - // You can also use the dialog API to let the user confirm closing the application. - return false; -}; -``` - -### Event: 'closed' - -Emitted when the window is closed. After you have received this event you should -remove the reference to the window and avoid using it anymore. - -### Event: 'unresponsive' - -Emitted when the web page becomes unresponsive. - -### Event: 'responsive' - -Emitted when the unresponsive web page becomes responsive again. - -### Event: 'blur' - -Emitted when window loses focus. - -### Event: 'focus' - -Emitted when window gains focus. - -### Event: 'maximize' - -Emitted when window is maximized. - -### Event: 'unmaximize' - -Emitted when window exits from maximized state. - -### Event: 'minimize' - -Emitted when window is minimized. - -### Event: 'restore' - -Emitted when window is restored from minimized state. - -### Event: 'resize' - -Emitted when window is getting resized. - -### Event: 'move' - -Emitted when the window is getting moved to a new position. - -__Note__: On OS X this event is just an alias of `moved`. - -### Event: 'moved' - -Emitted once when the window is moved to a new position. - -__Note__: This event is available only on OS X. - -### Event: 'enter-full-screen' - -Emitted when window enters full screen state. - -### Event: 'leave-full-screen' - -Emitted when window leaves full screen state. - -### Event: 'enter-html-full-screen' - -Emitted when window enters full screen state triggered by html api. - -### Event: 'leave-html-full-screen' - -Emitted when window leaves full screen state triggered by html api. - -### Event: 'devtools-opened' - -Emitted when devtools is opened. - -### Event: 'devtools-closed' - -Emitted when devtools is closed. - -### Event: 'devtools-focused' - -Emitted when devtools is focused / opened. - -### Event: 'app-command': - -Emitted when an [App Command](https://msdn.microsoft.com/en-us/library/windows/desktop/ms646275(v=vs.85).aspx) is invoked. These are typically related to keyboard media keys or browser commands, as well as the "Back" button built into some mice on Windows. - -```js -someWindow.on('app-command', function(e, cmd) { - // Navigate the window back when the user hits their mouse back button - if (cmd === 'browser-backward' && someWindow.webContents.canGoBack()) { - someWindow.webContents.goBack(); - } -}); -``` - -__Note__: This event is only fired on Windows. - -### Class Method: BrowserWindow.getAllWindows() - -Returns an array of all opened browser windows. - -### Class Method: BrowserWindow.getFocusedWindow() - -Returns the window that is focused in this application. - -### Class Method: BrowserWindow.fromWebContents(webContents) - -* `webContents` WebContents - -Find a window according to the `webContents` it owns - -### Class Method: BrowserWindow.fromId(id) - -* `id` Integer - -Find a window according to its ID. - -### Class Method: BrowserWindow.addDevToolsExtension(path) - -* `path` String - -Adds devtools extension located at `path`, and returns extension's name. - -The extension will be remembered so you only need to call this API once, this -API is not for programming use. - -### Class Method: BrowserWindow.removeDevToolsExtension(name) - -* `name` String - -Remove the devtools extension whose name is `name`. - -### BrowserWindow.webContents - -The `WebContents` object this window owns, all web page related events and -operations would be done via it. - -**Note:** Users should never store this object because it may become `null` -when the renderer process (web page) has crashed. - -### BrowserWindow.devToolsWebContents - -Get the `WebContents` of devtools of this window. - -**Note:** Users should never store this object because it may become `null` -when the devtools has been closed. - -### BrowserWindow.id - -Get the unique ID of this window. - -### BrowserWindow.destroy() - -Force closing the window, the `unload` and `beforeunload` event won't be emitted -for the web page, and `close` event would also not be emitted -for this window, but it would guarantee the `closed` event to be emitted. - -You should only use this method when the renderer process (web page) has crashed. - -### BrowserWindow.close() - -Try to close the window, this has the same effect with user manually clicking -the close button of the window. The web page may cancel the close though, see -the [close event](#event-close). - -### BrowserWindow.focus() - -Focus on the window. - -### BrowserWindow.isFocused() - -Returns whether the window is focused. - -### BrowserWindow.show() - -Shows and gives focus to the window. - -### BrowserWindow.showInactive() - -Shows the window but doesn't focus on it. - -### BrowserWindow.hide() - -Hides the window. - -### BrowserWindow.isVisible() - -Returns whether the window is visible to the user. - -### BrowserWindow.maximize() - -Maximizes the window. - -### BrowserWindow.unmaximize() - -Unmaximizes the window. - -### BrowserWindow.isMaximized() - -Returns whether the window is maximized. - -### BrowserWindow.minimize() - -Minimizes the window. On some platforms the minimized window will be shown in -the Dock. - -### BrowserWindow.restore() - -Restores the window from minimized state to its previous state. - -### BrowserWindow.isMinimized() - -Returns whether the window is minimized. - -### BrowserWindow.setFullScreen(flag) - -* `flag` Boolean - -Sets whether the window should be in fullscreen mode. - -### BrowserWindow.isFullScreen() - -Returns whether the window is in fullscreen mode. - -### BrowserWindow.setBounds(options) - -* `options` Object - * `x` Integer - * `y` Integer - * `width` Integer - * `height` Integer - -Resizes and moves the window to `width`, `height`, `x`, `y`. - -### BrowserWindow.getBounds() - -Returns an object that contains window's width, height, x and y values. - -### BrowserWindow.setSize(width, height) - -* `width` Integer -* `height` Integer - -Resizes the window to `width` and `height`. - -### BrowserWindow.getSize() - -Returns an array that contains window's width and height. - -### BrowserWindow.setContentSize(width, height) - -* `width` Integer -* `height` Integer - -Resizes the window's client area (e.g. the web page) to `width` and `height`. - -### BrowserWindow.getContentSize() - -Returns an array that contains window's client area's width and height. - -### BrowserWindow.setMinimumSize(width, height) - -* `width` Integer -* `height` Integer - -Sets the minimum size of window to `width` and `height`. - -### BrowserWindow.getMinimumSize() - -Returns an array that contains window's minimum width and height. - -### BrowserWindow.setMaximumSize(width, height) - -* `width` Integer -* `height` Integer - -Sets the maximum size of window to `width` and `height`. - -### BrowserWindow.getMaximumSize() - -Returns an array that contains window's maximum width and height. - -### BrowserWindow.setResizable(resizable) - -* `resizable` Boolean - -Sets whether the window can be manually resized by user. - -### BrowserWindow.isResizable() - -Returns whether the window can be manually resized by user. - -### BrowserWindow.setAlwaysOnTop(flag) - -* `flag` Boolean - -Sets whether the window should show always on top of other windows. After -setting this, the window is still a normal window, not a toolbox window which -can not be focused on. - -### BrowserWindow.isAlwaysOnTop() - -Returns whether the window is always on top of other windows. - -### BrowserWindow.center() - -Moves window to the center of the screen. - -### BrowserWindow.setPosition(x, y) - -* `x` Integer -* `y` Integer - -Moves window to `x` and `y`. - -### BrowserWindow.getPosition() - -Returns an array that contains window's current position. - -### BrowserWindow.setTitle(title) - -* `title` String - -Changes the title of native window to `title`. - -### BrowserWindow.getTitle() - -Returns the title of the native window. - -**Note:** The title of web page can be different from the title of the native -window. - -### BrowserWindow.flashFrame(flag) - -* `flag` Boolean - -Starts or stops flashing the window to attract user's attention. - -### BrowserWindow.setSkipTaskbar(skip) - -* `skip` Boolean - -Makes the window not show in the taskbar. - -### BrowserWindow.setKiosk(flag) - -* `flag` Boolean - -Enters or leaves the kiosk mode. - -### BrowserWindow.isKiosk() - -Returns whether the window is in kiosk mode. - -### BrowserWindow.setRepresentedFilename(filename) - -* `filename` String - -Sets the pathname of the file the window represents, and the icon of the file -will show in window's title bar. - -__Note__: This API is only available on OS X. - -### BrowserWindow.getRepresentedFilename() - -Returns the pathname of the file the window represents. - -__Note__: This API is only available on OS X. - -### BrowserWindow.setDocumentEdited(edited) - -* `edited` Boolean - -Specifies whether the window’s document has been edited, and the icon in title -bar will become grey when set to `true`. - -__Note__: This API is only available on OS X. - -### BrowserWindow.IsDocumentEdited() - -Whether the window's document has been edited. - -__Note__: This API is only available on OS X. - -### BrowserWindow.openDevTools([options]) - -* `options` Object - * `detach` Boolean - opens devtools in a new window - -Opens the developer tools. - -### BrowserWindow.closeDevTools() - -Closes the developer tools. - -### BrowserWindow.isDevToolsOpened() - -Returns whether the developer tools are opened. - -### BrowserWindow.toggleDevTools() - -Toggle the developer tools. - -### BrowserWindow.inspectElement(x, y) - -* `x` Integer -* `y` Integer - -Starts inspecting element at position (`x`, `y`). - -### BrowserWindow.inspectServiceWorker() - -Opens the developer tools for the service worker context present in the web contents. - -### BrowserWindow.focusOnWebView() - -### BrowserWindow.blurWebView() - -### BrowserWindow.capturePage([rect, ]callback) - -* `rect` Object - The area of page to be captured - * `x` Integer - * `y` Integer - * `width` Integer - * `height` Integer -* `callback` Function - -Captures the snapshot of page within `rect`, upon completion `callback` would be -called with `callback(image)`, the `image` is an instance of -[NativeImage](native-image.md) that stores data of the snapshot. Omitting the -`rect` would capture the whole visible page. - -**Note:** Be sure to read documents on remote buffer in -[remote](remote.md) if you are going to use this API in renderer -process. - -### BrowserWindow.print([options]) - -Same with `webContents.print([options])` - -### BrowserWindow.printToPDF(options, callback) - -Same with `webContents.printToPDF(options, callback)` - -### BrowserWindow.loadUrl(url, [options]) - -Same with `webContents.loadUrl(url, [options])`. - -### BrowserWindow.reload() - -Same with `webContents.reload`. - -### BrowserWindow.setMenu(menu) - -* `menu` Menu - -Sets the `menu` as the window's menu bar, setting it to `null` will remove the -menu bar. - -__Note:__ This API is not available on OS X. - -### BrowserWindow.setProgressBar(progress) - -* `progress` Double - -Sets progress value in progress bar. Valid range is [0, 1.0]. - -Remove progress bar when progress < 0; -Change to indeterminate mode when progress > 1. - -On Linux platform, only supports Unity desktop environment, you need to specify -the `*.desktop` file name to `desktopName` field in `package.json`. By default, -it will assume `app.getName().desktop`. - -### BrowserWindow.setOverlayIcon(overlay, description) - -* `overlay` [NativeImage](native-image.md) - the icon to display on the bottom -right corner of the taskbar icon. If this parameter is `null`, the overlay is -cleared -* `description` String - a description that will be provided to Accessibility -screen readers - -Sets a 16px overlay onto the current taskbar icon, usually used to convey some sort of application status or to passively notify the user. - -__Note:__ This API is only available on Windows (Windows 7 and above) - -### BrowserWindow.showDefinitionForSelection() - -Shows pop-up dictionary that searches the selected word on the page. - -__Note__: This API is only available on OS X. - -### BrowserWindow.setAutoHideMenuBar(hide) - -* `hide` Boolean - -Sets whether the window menu bar should hide itself automatically. Once set the -menu bar will only show when users press the single `Alt` key. - -If the menu bar is already visible, calling `setAutoHideMenuBar(true)` won't -hide it immediately. - -### BrowserWindow.isMenuBarAutoHide() - -Returns whether menu bar automatically hides itself. - -### BrowserWindow.setMenuBarVisibility(visible) - -* `visible` Boolean - -Sets whether the menu bar should be visible. If the menu bar is auto-hide, users -can still bring up the menu bar by pressing the single `Alt` key. - -### BrowserWindow.isMenuBarVisible() - -Returns whether the menu bar is visible. - -### BrowserWindow.setVisibleOnAllWorkspaces(visible) - -* `visible` Boolean - -Sets whether the window should be visible on all workspaces. - -**Note:** This API does nothing on Windows. - -### BrowserWindow.isVisibleOnAllWorkspaces() - -Returns whether the window is visible on all workspaces. - -**Note:** This API always returns false on Windows. - -## Class: WebContents - -A `WebContents` is responsible for rendering and controlling a web page. - -`WebContents` is an -[EventEmitter](http://nodejs.org/api/events.html#events_class_events_eventemitter). - -### Event: 'did-finish-load' - -Emitted when the navigation is done, i.e. the spinner of the tab will stop -spinning, and the `onload` event was dispatched. - -### Event: 'did-fail-load' - -* `event` Event -* `errorCode` Integer -* `errorDescription` String - -This event is like `did-finish-load`, but emitted when the load failed or was -cancelled, e.g. `window.stop()` is invoked. - -### Event: 'did-frame-finish-load' - -* `event` Event -* `isMainFrame` Boolean - -Emitted when a frame has done navigation. - -### Event: 'did-start-loading' - -Corresponds to the points in time when the spinner of the tab starts spinning. - -### Event: 'did-stop-loading' - -Corresponds to the points in time when the spinner of the tab stops spinning. - -### Event: 'did-get-response-details' - -* `event` Event -* `status` Boolean -* `newUrl` String -* `originalUrl` String -* `httpResponseCode` Integer -* `requestMethod` String -* `referrer` String -* `headers` Object - -Emitted when details regarding a requested resource is available. -`status` indicates the socket connection to download the resource. - -### Event: 'did-get-redirect-request' - -* `event` Event -* `oldUrl` String -* `newUrl` String -* `isMainFrame` Boolean - -Emitted when a redirect was received while requesting a resource. - -### Event: 'dom-ready' - -* `event` Event - -Emitted when document in the given frame is loaded. - -### Event: 'page-favicon-updated' - -* `event` Event -* `favicons` Array - Array of Urls - -Emitted when page receives favicon urls. - -### Event: 'new-window' - -* `event` Event -* `url` String -* `frameName` String -* `disposition` String - Can be `default`, `foreground-tab`, `background-tab`, - `new-window` and `other` - -Emitted when the page requested to open a new window for `url`. It could be -requested by `window.open` or an external link like ``. - -By default a new `BrowserWindow` will be created for the `url`. - -Calling `event.preventDefault()` can prevent creating new windows. - -### Event: 'will-navigate' - -* `event` Event -* `url` String - -Emitted when user or the page wants to start an navigation, it can happen when -`window.location` object is changed or user clicks a link in the page. - -This event will not emit when the navigation is started programmatically with APIs -like `WebContents.loadUrl` and `WebContents.back`. - -Calling `event.preventDefault()` can prevent the navigation. - -### Event: 'crashed' - -Emitted when the renderer process is crashed. - -### Event: 'plugin-crashed' - -* `event` Event -* `name` String -* `version` String - -Emitted when a plugin process is crashed. - -### Event: 'destroyed' - -Emitted when the WebContents is destroyed. - -### WebContents.session - -Returns the `Session` object used by this WebContents. - -### WebContents.loadUrl(url, [options]) - -* `url` URL -* `options` URL - * `httpReferrer` String - A HTTP Referer url - * `userAgent` String - A user agent originating the request - -Loads the `url` in the window, the `url` must contains the protocol prefix, -e.g. the `http://` or `file://`. - -### WebContents.getUrl() - -Returns URL of current web page. - -### WebContents.getTitle() - -Returns the title of web page. - -### WebContents.isLoading() - -Returns whether web page is still loading resources. - -### WebContents.isWaitingForResponse() - -Returns whether web page is waiting for a first-response for the main resource -of the page. - -### WebContents.stop() - -Stops any pending navigation. - -### WebContents.reload() - -Reloads current page. - -### WebContents.reloadIgnoringCache() - -Reloads current page and ignores cache. - -### WebContents.canGoBack() - -Returns whether the web page can go back. - -### WebContents.canGoForward() - -Returns whether the web page can go forward. - -### WebContents.canGoToOffset(offset) - -* `offset` Integer - -Returns whether the web page can go to `offset`. - -### WebContents.clearHistory() - -Clears the navigation history. - -### WebContents.goBack() - -Makes the web page go back. - -### WebContents.goForward() - -Makes the web page go forward. - -### WebContents.goToIndex(index) - -* `index` Integer - -Navigates to the specified absolute index. - -### WebContents.goToOffset(offset) - -* `offset` Integer - -Navigates to the specified offset from the "current entry". - -### WebContents.isCrashed() - -Whether the renderer process has crashed. - -### WebContents.setUserAgent(userAgent) - -* `userAgent` String - -Overrides the user agent for this page. - -### WebContents.insertCSS(css) - -* `css` String - -Injects CSS into this page. - -### WebContents.executeJavaScript(code) - -* `code` String - -Evaluates `code` in page. - -### WebContents.setAudioMuted(muted) - -+ `muted` Boolean - -Set the page muted. - -### WebContents.isAudioMuted() - -Returns whether this page has been muted. - -### WebContents.undo() - -Executes editing command `undo` in page. - -### WebContents.redo() - -Executes editing command `redo` in page. - -### WebContents.cut() - -Executes editing command `cut` in page. - -### WebContents.copy() - -Executes editing command `copy` in page. - -### WebContents.paste() - -Executes editing command `paste` in page. - -### WebContents.pasteAndMatchStyle() - -Executes editing command `pasteAndMatchStyle` in page. - -### WebContents.delete() - -Executes editing command `delete` in page. - -### WebContents.selectAll() - -Executes editing command `selectAll` in page. - -### WebContents.unselect() - -Executes editing command `unselect` in page. - -### WebContents.replace(text) - -* `text` String - -Executes editing command `replace` in page. - -### WebContents.replaceMisspelling(text) - -* `text` String - -Executes editing command `replaceMisspelling` in page. - -### WebContents.hasServiceWorker(callback) - -* `callback` Function - -Checks if any serviceworker is registered and returns boolean as -response to `callback`. - -### WebContents.unregisterServiceWorker(callback) - -* `callback` Function - -Unregisters any serviceworker if present and returns boolean as -response to `callback` when the JS promise is fullfilled or false -when the JS promise is rejected. - -### WebContents.print([options]) - -* `options` Object - * `silent` Boolean - Don't ask user for print settings, defaults to `false` - * `printBackground` Boolean - Also prints the background color and image of - the web page, defaults to `false`. - -Prints window's web page. When `silent` is set to `false`, Electron will pick -up system's default printer and default settings for printing. - -Calling `window.print()` in web page is equivalent to call -`WebContents.print({silent: false, printBackground: false})`. - -**Note:** On Windows, the print API relies on `pdf.dll`. If your application -doesn't need print feature, you can safely remove `pdf.dll` in saving binary -size. - -### WebContents.printToPDF(options, callback) - -* `options` Object - * `marginsType` Integer - Specify the type of margins to use - * 0 - default - * 1 - none - * 2 - minimum - * `printBackground` Boolean - Whether to print CSS backgrounds. - * `printSelectionOnly` Boolean - Whether to print selection only. - * `landscape` Boolean - `true` for landscape, `false` for portrait. - -* `callback` Function - `function(error, data) {}` - * `error` Error - * `data` Buffer - PDF file content - -Prints windows' web page as PDF with Chromium's preview printing custom -settings. - -By default, an empty `options` will be regarded as -`{marginsType:0, printBackgrounds:false, printSelectionOnly:false, - landscape:false}`. - -```javascript -var BrowserWindow = require('browser-window'); -var fs = require('fs'); - -var win = new BrowserWindow({width: 800, height: 600}); -win.loadUrl("http://github.com"); - -win.webContents.on("did-finish-load", function() { - // Use default printing options - win.webContents.printToPDF({}, function(error, data) { - if (error) throw error; - fs.writeFile(dist, data, function(error) { - if (err) - alert('write pdf file error', error); - }) - }) -}); -``` - -### WebContents.send(channel[, args...]) - -* `channel` String - -Send `args..` to the web page via `channel` in asynchronous message, the web -page can handle it by listening to the `channel` event of `ipc` module. - -An example of sending messages from the main process to the renderer process: - -```javascript -// On the main process. -var window = null; -app.on('ready', function() { - window = new BrowserWindow({width: 800, height: 600}); - window.loadUrl('file://' + __dirname + '/index.html'); - window.webContents.on('did-finish-load', function() { - window.webContents.send('ping', 'whoooooooh!'); - }); -}); -``` - -```html -// index.html - - - - - -``` - -**Note:** - -1. The IPC message handler in web pages do not have a `event` parameter, which - is different from the handlers on the main process. -2. There is no way to send synchronous messages from the main process to a - renderer process, because it would be very easy to cause dead locks. - -## Class: Session - -### Session.cookies - -The `cookies` gives you ability to query and modify cookies, an example is: - -```javascript -var BrowserWindow = require('browser-window'); - -var win = new BrowserWindow({ width: 800, height: 600 }); - -win.loadUrl('https://github.com'); - -win.webContents.on('did-finish-load', function() { - // Query all cookies. - win.webContents.session.cookies.get({}, function(error, cookies) { - if (error) throw error; - console.log(cookies); - }); - - // Query all cookies that are associated with a specific url. - win.webContents.session.cookies.get({ url : "http://www.github.com" }, - function(error, cookies) { - if (error) throw error; - console.log(cookies); - }); - - // Set a cookie with the given cookie data; - // may overwrite equivalent cookies if they exist. - win.webContents.session.cookies.set( - { url : "http://www.github.com", name : "dummy_name", value : "dummy"}, - function(error, cookies) { - if (error) throw error; - console.log(cookies); - }); -}); -``` - -### Session.cookies.get(details, callback) - -* `details` Object - * `url` String - Retrieves cookies which are associated with `url`. - Empty imples retrieving cookies of all urls. - * `name` String - Filters cookies by name - * `domain` String - Retrieves cookies whose domains match or are subdomains of `domains` - * `path` String - Retrieves cookies whose path matches `path` - * `secure` Boolean - Filters cookies by their Secure property - * `session` Boolean - Filters out session or persistent cookies. -* `callback` Function - function(error, cookies) - * `error` Error - * `cookies` Array - array of `cookie` objects. - * `cookie` - Object - * `name` String - The name of the cookie - * `value` String - The value of the cookie - * `domain` String - The domain of the cookie - * `host_only` String - Whether the cookie is a host-only cookie - * `path` String - The path of the cookie - * `secure` Boolean - Whether the cookie is marked as Secure (typically HTTPS) - * `http_only` Boolean - Whether the cookie is marked as HttpOnly - * `session` Boolean - Whether the cookie is a session cookie or a persistent - cookie with an expiration date. - * `expirationDate` Double - (Option) The expiration date of the cookie as - the number of seconds since the UNIX epoch. Not provided for session cookies. - - -### Session.cookies.set(details, callback) - -* `details` Object - * `url` String - Retrieves cookies which are associated with `url` - * `name` String - The name of the cookie. Empty by default if omitted. - * `value` String - The value of the cookie. Empty by default if omitted. - * `domain` String - The domain of the cookie. Empty by default if omitted. - * `path` String - The path of the cookie. Empty by default if omitted. - * `secure` Boolean - Whether the cookie should be marked as Secure. Defaults to false. - * `session` Boolean - Whether the cookie should be marked as HttpOnly. Defaults to false. - * `expirationDate` Double - The expiration date of the cookie as the number of - seconds since the UNIX epoch. If omitted, the cookie becomes a session cookie. - -* `callback` Function - function(error) - * `error` Error - -### Session.cookies.remove(details, callback) - -* `details` Object - * `url` String - The URL associated with the cookie - * `name` String - The name of cookie to remove -* `callback` Function - function(error) - * `error` Error - -### Session.clearCache(callback) - -* `callback` Function - Called when operation is done - -Clears the session's HTTP cache. - -### Session.clearStorageData([options, ]callback) - -* `options` Object - * `origin` String - Should follow `window.location.origin`'s representation - `scheme://host:port` - * `storages` Array - The types of storages to clear, can contain: - `appcache`, `cookies`, `filesystem`, `indexdb`, `localstorage`, - `shadercache`, `websql`, `serviceworkers` - * `quotas` Array - The types of quotas to clear, can contain: - `temporary`, `persistent`, `syncable` -* `callback` Function - Called when operation is done - -Clears the data of web storages. diff --git a/docs/api/dialog-ko.md b/docs/api/dialog-ko.md index a16daebb6f3a..11b06f99ae9c 100644 --- a/docs/api/dialog-ko.md +++ b/docs/api/dialog-ko.md @@ -66,23 +66,27 @@ Windows와 Linux에선 파일 선택 모드, 디렉터리 선택 모드를 동 * `browserWindow` BrowserWindow * `options` Object - ** `type` String - `"none"`, `"info"`, `"error"`, `"question"`, `"warning"` 중 하나를 사용할 수 있습니다. + * `type` String - `"none"`, `"info"`, `"error"`, `"question"`, `"warning"` 중 하나를 사용할 수 있습니다. + Windows에선 따로 `icon`을 설정하지 않은 이상 "question"과 "info"는 같은 아이콘으로 표시됩니다. * `buttons` Array - 버튼들의 라벨을 포함한 배열입니다. - * `title` String - 메시지 상자의 제목입니다. 몇몇 플랫폼에선 보이지 않을 수 있습니다. - * `message` String - 메시지 상자의 본문 내용입니다. + * `title` String - 대화 상자의 제목입니다. 몇몇 플랫폼에선 보이지 않을 수 있습니다. + * `message` String - 대화 상자의 본문 내용입니다. * `detail` String - 메시지의 추가 정보입니다. * `icon` [NativeImage](native-image-ko.md) * `cancelId` Integer - 유저가 대화 상자의 버튼을 클릭하지 않고 대화 상자를 취소했을 때 반환되는 버튼의 index입니다. 기본적으로 버튼 리스트가 "cancel" 또는 "no" 라벨을 가지고 있을 때 해당 버튼의 index를 반환합니다. 따로 두 라벨이 지정되지 않은 경우 0을 반환합니다. OS X와 Windows에선 `cancelId` 지정 여부에 상관없이 "Cancel" 버튼이 언제나 `cancelId`로 지정됩니다. + * `noLink` Boolean - Windows Electron은 "Cancel"이나 "Yes"와 같은 흔히 사용되는 버튼을 찾으려고 시도하고 + 대화 상자 내에서 해당 버튼을 커맨드 링크처럼 만듭니다. 이 기능으로 앱을 좀 더 Modern Windows 앱처럼 만들 수 있습니다. + 이 기능을 원하지 않으면 `noLink`를 true로 지정하면 됩니다. * `callback` Function -메시지 상자를 표시합니다. `browserWindow`를 지정하면 메시지 상자가 완전히 닫힐 때까지는 창을 사용할 수 없습니다. +대화 상자를 표시합니다. `browserWindow`를 지정하면 대화 상자가 완전히 닫힐 때까지는 창을 사용할 수 없습니다. 완료시 유저가 선택한 버튼의 index를 반환합니다. 역주: 부정을 표현하는 "아니오", "취소"와 같은 한글 단어는 지원되지 않습니다. 만약 OS X 또는 Windows에서 "확인", "취소"와 같은 순서로 버튼을 지정하게 될 때 Alt + f4로 해당 대화 상자를 끄게 되면 "확인"을 누른걸로 판단되어 버립니다. -이를 해결하려면 "Cancel"을 대신 사용하거나 BrowserWindow API를 사용하여 메시지 상자를 직접 구현해야합니다. +이를 해결하려면 "Cancel"을 대신 사용하거나 BrowserWindow API를 사용하여 대화 상자를 직접 구현해야합니다. `callback`이 전달되면 메소드가 비동기로 작동되며 결과는 `callback(response)`을 통해 전달됩니다. diff --git a/docs/api/tray-ko.md b/docs/api/tray-ko.md index 145302b65f65..3d7120e69b98 100644 --- a/docs/api/tray-ko.md +++ b/docs/api/tray-ko.md @@ -24,8 +24,8 @@ app.on('ready', function(){ __플랫폼별 한계:__ -* OS X에서는 트레이 아이콘이 컨텍스트 메뉴를 가지고 있을 경우 `clicked` 이벤트는 무시됩니다. * Linux에서는 앱 알림 표시기(app indicator)가 지원되면 해당 기능을 사용합니다. 만약 지원하지 않으면 `GtkStatusIcon`을 대신 사용합니다. +* Linux 배포판이 앱 알림 표시기만 지원하고 있다면 `libappindicator1`를 설치하여 트레이 아이콘이 작동하도록 만들 수 있습니다. * 앱 알림 표시기는 컨텍스트 메뉴를 가지고 있을 때만 보입니다. * Linux에서 앱 알림 표시기가 사용될 경우, `clicked` 이벤트는 무시됩니다. @@ -55,6 +55,20 @@ __플랫폼별 한계:__ __주의:__ `bounds`는 OS X와 Window 7 이후 버전에서만 작동합니다. +### Event: 'right-clicked' + +* `event` +* `bounds` Object - 트레이 아이콘의 범위 + * `x` Integer + * `y` Integer + * `width` Integer + * `height` Integer + +트레이 아이콘을 오른쪽 클릭될 때 호출 됩니다. + +__주의:__ 이 기능은 Windows와 OS X에서만 사용할 수 있습니다. +Windows에서는 이 이벤트가 컨텍스트 메뉴를 가지고 있을 때만 호출됩니다. + ### Event: 'double-clicked' 트레이 아이콘이 더블 클릭될 때 호출됩니다. @@ -79,6 +93,15 @@ __주의:__ 이 기능은 Windows에서만 작동합니다. __주의:__ 이 기능은 Windows에서만 작동합니다. +### Event: 'drop-files' + +* `event` +* `files` Array - 드롭된 파일의 경로 + +트레이 아이콘에 파일이 드롭되면 호출됩니다. + +__주의:__ 이 기능은 OS X에서만 작동합니다. + ### Tray.destroy() 트레이 아이콘을 즉시 삭제시킵니다. @@ -130,6 +153,15 @@ __주의:__ 이 기능은 OS X에서만 작동합니다. __알림:__ 이 기능은 Windows에서만 작동합니다. +### Tray.popContextMenu([position]) + +* `position` Object - 팝 메뉴 위치 + * `x` Integer + * `y` Integer + +__주의:__ 이 기능은 Windows와 OS X에서만 작동합니다. +`position`은 Windows에서만 사용할 수 있으며 기본값은 (0, 0)입니다. + ### Tray.setContextMenu(menu) * `menu` Menu diff --git a/docs/api/web-view-tag-ko.md b/docs/api/web-view-tag-ko.md index 2ff07ccc126f..e6b3d6c99f5c 100644 --- a/docs/api/web-view-tag-ko.md +++ b/docs/api/web-view-tag-ko.md @@ -215,6 +215,10 @@ Whether the renderer process has crashed. Overrides the user agent for guest page. +### ``.getUserAgent() + +Returns a `String` represents the user agent for guest page. + ### ``.insertCSS(css) * `css` String From 8960aa956c669654c08c8a0727695ea81d1819e2 Mon Sep 17 00:00:00 2001 From: Yifei Teng Date: Thu, 23 Jul 2015 12:30:07 -0700 Subject: [PATCH 0677/1293] Only allow extensions explicitly specified by the user. Fixes #2296 --- atom/browser/ui/file_dialog_mac.mm | 14 -------------- 1 file changed, 14 deletions(-) diff --git a/atom/browser/ui/file_dialog_mac.mm b/atom/browser/ui/file_dialog_mac.mm index 9cd6c0380be6..96d230b1a1ea 100644 --- a/atom/browser/ui/file_dialog_mac.mm +++ b/atom/browser/ui/file_dialog_mac.mm @@ -18,25 +18,11 @@ namespace file_dialog { namespace { -CFStringRef CreateUTIFromExtension(const std::string& ext) { - base::ScopedCFTypeRef ext_cf(base::SysUTF8ToCFStringRef(ext)); - return UTTypeCreatePreferredIdentifierForTag( - kUTTagClassFilenameExtension, ext_cf.get(), NULL); -} - void SetAllowedFileTypes(NSSavePanel* dialog, const Filters& filters) { NSMutableSet* file_type_set = [NSMutableSet set]; for (size_t i = 0; i < filters.size(); ++i) { const Filter& filter = filters[i]; for (size_t j = 0; j < filter.second.size(); ++j) { - base::ScopedCFTypeRef uti( - CreateUTIFromExtension(filter.second[j])); - [file_type_set addObject:base::mac::CFToNSCast(uti.get())]; - - // Always allow the extension itself, in case the UTI doesn't map - // back to the original extension correctly. This occurs with dynamic - // UTIs on 10.7 and 10.8. - // See http://crbug.com/148840, http://openradar.me/12316273 base::ScopedCFTypeRef ext_cf( base::SysUTF8ToCFStringRef(filter.second[j])); [file_type_set addObject:base::mac::CFToNSCast(ext_cf.get())]; From d9ee8519e9d2da28673d74e877833d081e2ad094 Mon Sep 17 00:00:00 2001 From: Jeffrey Morgan Date: Thu, 23 Jul 2015 20:45:08 +0100 Subject: [PATCH 0678/1293] Correct error in chrome-command-line-switches.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Replace “to” with “in” to correct the error identified in `chrome-command-line-switches.md` by @OlsonDev. --- docs/api/chrome-command-line-switches.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/chrome-command-line-switches.md b/docs/api/chrome-command-line-switches.md index 94bb200168ff..2f995c99b219 100644 --- a/docs/api/chrome-command-line-switches.md +++ b/docs/api/chrome-command-line-switches.md @@ -2,7 +2,7 @@ This page lists the command line switches used by the Chrome browser that are also supported by Electron. You can use [app.commandLine.appendSwitch][append-switch] to append -them to your app's main script before the [ready][ready] event of [app][app] +them in your app's main script before the [ready][ready] event of [app][app] module is emitted: ```javascript From 959f5d61b79007e213bf3b838574e40ebcfb98f7 Mon Sep 17 00:00:00 2001 From: Craig Shoemaker Date: Thu, 23 Jul 2015 15:04:43 -0700 Subject: [PATCH 0679/1293] Windows/Linux compatibility changes - Updated accelerator to cross platform values - Added a warning to non-Mac users regarding the selector option --- docs/api/menu.md | 28 +++++++++++++++------------- 1 file changed, 15 insertions(+), 13 deletions(-) diff --git a/docs/api/menu.md b/docs/api/menu.md index db149a29680a..41779ee63bee 100644 --- a/docs/api/menu.md +++ b/docs/api/menu.md @@ -29,6 +29,8 @@ window.addEventListener('contextmenu', function (e) { Another example of creating the application menu with the simple template API: +**Note to Window and Linux users** the `selector` member of each menu item is a Mac-only [Accellerator option](https://github.com/atom/electron/blob/master/docs/api/accelerator.md). + ```html + diff --git a/spec/webview-spec.coffee b/spec/webview-spec.coffee index b47c72ac0fb8..55bbdbb01e65 100644 --- a/spec/webview-spec.coffee +++ b/spec/webview-spec.coffee @@ -228,3 +228,24 @@ describe ' tag', -> webview.setAttribute 'nodeintegration', 'on' webview.src = "file://#{fixtures}/pages/history.html" document.body.appendChild webview + + describe 'basic auth', -> + auth = require 'basic-auth' + + it 'should authenticate with correct credentials', (done) -> + message = 'Authenticated' + server = require('http').createServer (req, res) -> + credentials = auth(req) + if credentials.name == 'test' and credentials.pass == 'test' + res.end(message) + else + res.end('failed') + server.close() + server.listen 0, '127.0.0.1', -> + {port} = server.address() + webview.addEventListener 'ipc-message', (e) -> + assert.equal e.channel, message + done() + webview.src = "file://#{fixtures}/pages/basic-auth.html?port=#{port}" + webview.setAttribute 'nodeintegration', 'on' + document.body.appendChild webview From b52c07f65024d0cc5c6b3202b713115d0d5dfa89 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 24 Jul 2015 15:48:13 +0800 Subject: [PATCH 0685/1293] spec: Make dom-ready spec stronger --- docs/api/web-view-tag.md | 4 ++-- spec/api-browser-window-spec.coffee | 22 ---------------------- spec/fixtures/pages/dom-ready.html | 9 +++++++++ spec/fixtures/pages/f.html | 11 ----------- spec/webview-spec.coffee | 14 +++++++++++++- 5 files changed, 24 insertions(+), 36 deletions(-) create mode 100644 spec/fixtures/pages/dom-ready.html delete mode 100644 spec/fixtures/pages/f.html diff --git a/docs/api/web-view-tag.md b/docs/api/web-view-tag.md index 973b62f5b767..0ff54c161704 100644 --- a/docs/api/web-view-tag.md +++ b/docs/api/web-view-tag.md @@ -130,10 +130,10 @@ If "on", the guest page will have web security disabled. ## Methods -The webview element must be loaded before using the methods. +The webview element must be loaded before using the methods. **Example** ```javascript -webview.addEventListener("dom-ready", function(){ +webview.addEventListener("dom-ready", function() { webview.openDevTools(); }); ``` diff --git a/spec/api-browser-window-spec.coffee b/spec/api-browser-window-spec.coffee index a2f4a66769e3..1b5705016831 100644 --- a/spec/api-browser-window-spec.coffee +++ b/spec/api-browser-window-spec.coffee @@ -257,25 +257,3 @@ describe 'browser-window module', -> assert.equal url, 'https://www.github.com/' done() w.loadUrl "file://#{fixtures}/pages/will-navigate.html" - - describe 'dom-ready event', -> - return if isCI and process.platform is 'darwin' - it 'emits when document is loaded', (done) -> - ipc = remote.require 'ipc' - server = http.createServer (req, res) -> - action = url.parse(req.url, true).pathname - if action == '/logo.png' - img = fs.readFileSync(path.join(fixtures, 'assets', 'logo.png')) - res.writeHead(200, {'Content-Type': 'image/png'}) - setTimeout -> - res.end(img, 'binary') - , 2000 - server.close() - server.listen 62542, '127.0.0.1' - ipc.on 'dom-ready', (e, state) -> - ipc.removeAllListeners 'dom-ready' - assert.equal state, 'interactive' - done() - w.webContents.on 'did-finish-load', -> - w.close() - w.loadUrl "file://#{fixtures}/pages/f.html" diff --git a/spec/fixtures/pages/dom-ready.html b/spec/fixtures/pages/dom-ready.html new file mode 100644 index 000000000000..541852f9ab0c --- /dev/null +++ b/spec/fixtures/pages/dom-ready.html @@ -0,0 +1,9 @@ + + + + + + diff --git a/spec/fixtures/pages/f.html b/spec/fixtures/pages/f.html deleted file mode 100644 index e2003a3ab0d8..000000000000 --- a/spec/fixtures/pages/f.html +++ /dev/null @@ -1,11 +0,0 @@ - - - - - - diff --git a/spec/webview-spec.coffee b/spec/webview-spec.coffee index 55bbdbb01e65..7ab8969e7719 100644 --- a/spec/webview-spec.coffee +++ b/spec/webview-spec.coffee @@ -1,5 +1,6 @@ assert = require 'assert' path = require 'path' +http = require 'http' describe ' tag', -> fixtures = path.join __dirname, 'fixtures' @@ -234,7 +235,7 @@ describe ' tag', -> it 'should authenticate with correct credentials', (done) -> message = 'Authenticated' - server = require('http').createServer (req, res) -> + server = http.createServer (req, res) -> credentials = auth(req) if credentials.name == 'test' and credentials.pass == 'test' res.end(message) @@ -249,3 +250,14 @@ describe ' tag', -> webview.src = "file://#{fixtures}/pages/basic-auth.html?port=#{port}" webview.setAttribute 'nodeintegration', 'on' document.body.appendChild webview + + describe 'dom-ready event', -> + it 'emits when document is loaded', (done) -> + server = http.createServer (req) -> + # Never respond, so the page never finished loading. + server.listen 0, '127.0.0.1', -> + {port} = server.address() + webview.addEventListener 'dom-ready', -> + done() + webview.src = "file://#{fixtures}/pages/dom-ready.html?port=#{port}" + document.body.appendChild webview From 417e97eef0338546c23216f4117f48671e50f102 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 24 Jul 2015 15:49:19 +0800 Subject: [PATCH 0686/1293] spec: Don't reuse port in session spec --- spec/api-session-spec.coffee | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/spec/api-session-spec.coffee b/spec/api-session-spec.coffee index bd7c9bde5923..34a08ee50f09 100644 --- a/spec/api-session-spec.coffee +++ b/spec/api-session-spec.coffee @@ -20,8 +20,7 @@ describe 'session module', -> res.end('finished') server.close() - port = remote.process.port - server.listen port, '127.0.0.1', -> + server.listen 0, '127.0.0.1', -> {port} = server.address() w.loadUrl "#{url}:#{port}" w.webContents.on 'did-finish-load', -> From 73ded9d37830c4f947de4f8b4d91100558e4374e Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 24 Jul 2015 16:04:54 +0800 Subject: [PATCH 0687/1293] linux: Fix min/max size not working --- atom/browser/native_window_views.cc | 19 ++---------- atom/browser/ui/views/native_frame_view.cc | 35 ++++++++++++++++++++++ atom/browser/ui/views/native_frame_view.h | 34 +++++++++++++++++++++ filenames.gypi | 2 ++ 4 files changed, 73 insertions(+), 17 deletions(-) create mode 100644 atom/browser/ui/views/native_frame_view.cc create mode 100644 atom/browser/ui/views/native_frame_view.h diff --git a/atom/browser/native_window_views.cc b/atom/browser/native_window_views.cc index 9613a3955f94..dbd8bf26ce3d 100644 --- a/atom/browser/native_window_views.cc +++ b/atom/browser/native_window_views.cc @@ -36,6 +36,7 @@ #include "atom/browser/browser.h" #include "atom/browser/ui/views/global_menu_bar_x11.h" #include "atom/browser/ui/views/frameless_view.h" +#include "atom/browser/ui/views/native_frame_view.h" #include "atom/browser/ui/x/window_state_watcher.h" #include "atom/browser/ui/x/x_window_utils.h" #include "base/environment.h" @@ -491,14 +492,6 @@ gfx::Size NativeWindowViews::GetContentSize() { void NativeWindowViews::SetMinimumSize(const gfx::Size& size) { minimum_size_ = size; - -#if defined(USE_X11) - XSizeHints size_hints; - size_hints.flags = PMinSize; - size_hints.min_width = size.width(); - size_hints.min_height = size.height(); - XSetWMNormalHints(gfx::GetXDisplay(), GetAcceleratedWidget(), &size_hints); -#endif } gfx::Size NativeWindowViews::GetMinimumSize() { @@ -507,14 +500,6 @@ gfx::Size NativeWindowViews::GetMinimumSize() { void NativeWindowViews::SetMaximumSize(const gfx::Size& size) { maximum_size_ = size; - -#if defined(USE_X11) - XSizeHints size_hints; - size_hints.flags = PMaxSize; - size_hints.max_width = size.width(); - size_hints.max_height = size.height(); - XSetWMNormalHints(gfx::GetXDisplay(), GetAcceleratedWidget(), &size_hints); -#endif } gfx::Size NativeWindowViews::GetMaximumSize() { @@ -899,7 +884,7 @@ views::NonClientFrameView* NativeWindowViews::CreateNonClientFrameView( return frame_view; #else if (has_frame_) { - return new views::NativeFrameView(widget); + return new NativeFrameView(this, widget); } else { FramelessView* frame_view = new FramelessView; frame_view->Init(this, widget); diff --git a/atom/browser/ui/views/native_frame_view.cc b/atom/browser/ui/views/native_frame_view.cc new file mode 100644 index 000000000000..a434fb434961 --- /dev/null +++ b/atom/browser/ui/views/native_frame_view.cc @@ -0,0 +1,35 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#include "atom/browser/ui/views/native_frame_view.h" + +#include "atom/browser/native_window_views.h" + +namespace atom { + +namespace { + +const char kViewClassName[] = "AtomNativeFrameView"; + +} // namespace + +NativeFrameView::NativeFrameView(NativeWindowViews* window, + views::Widget* widget) + : views::NativeFrameView(widget), + window_(window) { +} + +gfx::Size NativeFrameView::GetMinimumSize() const { + return window_->GetMinimumSize(); +} + +gfx::Size NativeFrameView::GetMaximumSize() const { + return window_->GetMaximumSize(); +} + +const char* NativeFrameView::GetClassName() const { + return kViewClassName; +} + +} // namespace atom diff --git a/atom/browser/ui/views/native_frame_view.h b/atom/browser/ui/views/native_frame_view.h new file mode 100644 index 000000000000..acbe9cddc8dc --- /dev/null +++ b/atom/browser/ui/views/native_frame_view.h @@ -0,0 +1,34 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#ifndef ATOM_BROWSER_UI_VIEWS_NATIVE_FRAME_VIEW_H_ +#define ATOM_BROWSER_UI_VIEWS_NATIVE_FRAME_VIEW_H_ + +#include "ui/views/window/native_frame_view.h" + +namespace atom { + +class NativeWindowViews; + +// Like the views::NativeFrameView, but returns the min/max size from the +// NativeWindowViews. +class NativeFrameView : public views::NativeFrameView { + public: + NativeFrameView(NativeWindowViews* window, views::Widget* widget); + + protected: + // views::View: + gfx::Size GetMinimumSize() const override; + gfx::Size GetMaximumSize() const override; + const char* GetClassName() const override; + + private: + NativeWindowViews* window_; // weak ref. + + DISALLOW_COPY_AND_ASSIGN(NativeFrameView); +}; + +} // namespace atom + +#endif // ATOM_BROWSER_UI_VIEWS_NATIVE_FRAME_VIEW_H_ diff --git a/filenames.gypi b/filenames.gypi index 837dd3301cc8..ed51fc8fb47b 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -196,6 +196,8 @@ 'atom/browser/ui/views/menu_delegate.h', 'atom/browser/ui/views/menu_layout.cc', 'atom/browser/ui/views/menu_layout.h', + 'atom/browser/ui/views/native_frame_view.cc', + 'atom/browser/ui/views/native_frame_view.h', 'atom/browser/ui/views/submenu_button.cc', 'atom/browser/ui/views/submenu_button.h', 'atom/browser/ui/views/win_frame_view.cc', From 7ceca9f4269929b5a1c5e98e82a42b72e08f919e Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 24 Jul 2015 16:59:18 +0800 Subject: [PATCH 0688/1293] Bump v0.30.1 --- atom.gyp | 2 +- atom/browser/resources/mac/Info.plist | 2 +- atom/browser/resources/win/atom.rc | 8 ++++---- atom/common/atom_version.h | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/atom.gyp b/atom.gyp index d8da82cd548f..bf67c767c17f 100644 --- a/atom.gyp +++ b/atom.gyp @@ -4,7 +4,7 @@ 'product_name%': 'Electron', 'company_name%': 'GitHub, Inc', 'company_abbr%': 'github', - 'version%': '0.30.0', + 'version%': '0.30.1', }, 'includes': [ 'filenames.gypi', diff --git a/atom/browser/resources/mac/Info.plist b/atom/browser/resources/mac/Info.plist index 68ce951ed4d4..28d56286e968 100644 --- a/atom/browser/resources/mac/Info.plist +++ b/atom/browser/resources/mac/Info.plist @@ -17,7 +17,7 @@ CFBundleIconFile atom.icns CFBundleVersion - 0.30.0 + 0.30.1 LSMinimumSystemVersion 10.8.0 NSMainNibFile diff --git a/atom/browser/resources/win/atom.rc b/atom/browser/resources/win/atom.rc index 80714c55fd25..3485ad963c39 100644 --- a/atom/browser/resources/win/atom.rc +++ b/atom/browser/resources/win/atom.rc @@ -56,8 +56,8 @@ END // VS_VERSION_INFO VERSIONINFO - FILEVERSION 0,30,0,0 - PRODUCTVERSION 0,30,0,0 + FILEVERSION 0,30,1,0 + PRODUCTVERSION 0,30,1,0 FILEFLAGSMASK 0x3fL #ifdef _DEBUG FILEFLAGS 0x1L @@ -74,12 +74,12 @@ BEGIN BEGIN VALUE "CompanyName", "GitHub, Inc." VALUE "FileDescription", "Electron" - VALUE "FileVersion", "0.30.0" + VALUE "FileVersion", "0.30.1" VALUE "InternalName", "electron.exe" VALUE "LegalCopyright", "Copyright (C) 2015 GitHub, Inc. All rights reserved." VALUE "OriginalFilename", "electron.exe" VALUE "ProductName", "Electron" - VALUE "ProductVersion", "0.30.0" + VALUE "ProductVersion", "0.30.1" VALUE "SquirrelAwareVersion", "1" END END diff --git a/atom/common/atom_version.h b/atom/common/atom_version.h index 64d0c7bfd73d..0240a423bc4f 100644 --- a/atom/common/atom_version.h +++ b/atom/common/atom_version.h @@ -7,7 +7,7 @@ #define ATOM_MAJOR_VERSION 0 #define ATOM_MINOR_VERSION 30 -#define ATOM_PATCH_VERSION 0 +#define ATOM_PATCH_VERSION 1 #define ATOM_VERSION_IS_RELEASE 1 From 08383a69cea60db3d87fbe9842d21ffe0c4ef753 Mon Sep 17 00:00:00 2001 From: Paul Betts Date: Fri, 24 Jul 2015 03:10:03 -0700 Subject: [PATCH 0689/1293] Propagate User App Model ID to Tray Icon This PR prevents dozens of items showing up in the notification area preferences when using Squirrel for Windows, by ensuring that notification tray items are tied to the User App Model ID. --- atom/browser/ui/win/notify_icon.cc | 16 ++++++++++++++++ atom/browser/ui/win/notify_icon.h | 3 +++ 2 files changed, 19 insertions(+) diff --git a/atom/browser/ui/win/notify_icon.cc b/atom/browser/ui/win/notify_icon.cc index bc9ff46f939a..6f75bb311dae 100644 --- a/atom/browser/ui/win/notify_icon.cc +++ b/atom/browser/ui/win/notify_icon.cc @@ -4,7 +4,10 @@ #include "atom/browser/ui/win/notify_icon.h" +#include + #include "atom/browser/ui/win/notify_icon_host.h" +#include "base/md5.h" #include "base/strings/string_number_conversions.h" #include "base/strings/utf_string_conversions.h" #include "base/win/windows_version.h" @@ -26,6 +29,18 @@ NotifyIcon::NotifyIcon(NotifyIconHost* host, window_(window), message_id_(message), menu_model_(NULL) { + + // NB: If we have an App Model ID, we should propagate that to the tray. + // Doing this prevents duplicate items from showing up in the notification + // preferences (i.e. "Always Show / Show notifications only / etc") + PWSTR explicit_app_id; + + if (SUCCEEDED(GetCurrentProcessExplicitAppUserModelID(&explicit_app_id))) { + // GUIDs and MD5 hashes are the same length. So convenient! + MD5Sum(explicit_app_id, sizeof(wchar_t) * wcslen(explicit_app_id), (MD5Digest*)&tray_app_id_hash_); + CoTaskMemFree(explicit_app_id); + } + NOTIFYICONDATA icon_data; InitIconData(&icon_data); icon_data.uFlags = NIF_MESSAGE; @@ -161,6 +176,7 @@ void NotifyIcon::InitIconData(NOTIFYICONDATA* icon_data) { icon_data->cbSize = sizeof(NOTIFYICONDATA); icon_data->hWnd = window_; icon_data->uID = icon_id_; + memcpy(icon_data->guidItem, tray_app_id_hash_, sizeof(GUID)); } } // namespace atom diff --git a/atom/browser/ui/win/notify_icon.h b/atom/browser/ui/win/notify_icon.h index 8e00f1267920..56b4b4f09be8 100644 --- a/atom/browser/ui/win/notify_icon.h +++ b/atom/browser/ui/win/notify_icon.h @@ -75,6 +75,9 @@ class NotifyIcon : public TrayIcon { // The context menu. ui::SimpleMenuModel* menu_model_; + + // A hash of the app model ID + GUID tray_app_id_hash_; DISALLOW_COPY_AND_ASSIGN(NotifyIcon); }; From 75b08f510ee021b3a984095dce873769ae127fb8 Mon Sep 17 00:00:00 2001 From: Paul Betts Date: Fri, 24 Jul 2015 03:27:15 -0700 Subject: [PATCH 0690/1293] Fix up namespaces --- atom/browser/ui/win/notify_icon.cc | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/atom/browser/ui/win/notify_icon.cc b/atom/browser/ui/win/notify_icon.cc index 6f75bb311dae..e9b153b49ab6 100644 --- a/atom/browser/ui/win/notify_icon.cc +++ b/atom/browser/ui/win/notify_icon.cc @@ -29,18 +29,21 @@ NotifyIcon::NotifyIcon(NotifyIconHost* host, window_(window), message_id_(message), menu_model_(NULL) { - - // NB: If we have an App Model ID, we should propagate that to the tray. + + // NB: If we have an App Model ID, we should propagate that to the tray. // Doing this prevents duplicate items from showing up in the notification // preferences (i.e. "Always Show / Show notifications only / etc") PWSTR explicit_app_id; - + if (SUCCEEDED(GetCurrentProcessExplicitAppUserModelID(&explicit_app_id))) { // GUIDs and MD5 hashes are the same length. So convenient! - MD5Sum(explicit_app_id, sizeof(wchar_t) * wcslen(explicit_app_id), (MD5Digest*)&tray_app_id_hash_); + base::MD5Sum(explicit_app_id, + sizeof(wchar_t) * wcslen(explicit_app_id), + (base::MD5Digest*)&tray_app_id_hash_); + CoTaskMemFree(explicit_app_id); } - + NOTIFYICONDATA icon_data; InitIconData(&icon_data); icon_data.uFlags = NIF_MESSAGE; @@ -176,7 +179,7 @@ void NotifyIcon::InitIconData(NOTIFYICONDATA* icon_data) { icon_data->cbSize = sizeof(NOTIFYICONDATA); icon_data->hWnd = window_; icon_data->uID = icon_id_; - memcpy(icon_data->guidItem, tray_app_id_hash_, sizeof(GUID)); + memcpy((void*)&icon_data->guidItem, &tray_app_id_hash_, sizeof(GUID)); } } // namespace atom From 70feb08f8495eabbb44c3fae3064aaa5c836638e Mon Sep 17 00:00:00 2001 From: Paul Betts Date: Fri, 24 Jul 2015 03:30:23 -0700 Subject: [PATCH 0691/1293] Fix linting issues --- atom/browser/ui/win/notify_icon.cc | 7 +++++-- atom/browser/ui/win/notify_icon.h | 2 +- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/atom/browser/ui/win/notify_icon.cc b/atom/browser/ui/win/notify_icon.cc index e9b153b49ab6..787982d04dbf 100644 --- a/atom/browser/ui/win/notify_icon.cc +++ b/atom/browser/ui/win/notify_icon.cc @@ -40,7 +40,7 @@ NotifyIcon::NotifyIcon(NotifyIconHost* host, base::MD5Sum(explicit_app_id, sizeof(wchar_t) * wcslen(explicit_app_id), (base::MD5Digest*)&tray_app_id_hash_); - + CoTaskMemFree(explicit_app_id); } @@ -179,7 +179,10 @@ void NotifyIcon::InitIconData(NOTIFYICONDATA* icon_data) { icon_data->cbSize = sizeof(NOTIFYICONDATA); icon_data->hWnd = window_; icon_data->uID = icon_id_; - memcpy((void*)&icon_data->guidItem, &tray_app_id_hash_, sizeof(GUID)); + + memcpy(reinterpret_cast(&icon_data->guidItem), + &tray_app_id_hash_, + sizeof(GUID)); } } // namespace atom diff --git a/atom/browser/ui/win/notify_icon.h b/atom/browser/ui/win/notify_icon.h index 56b4b4f09be8..a52388d56298 100644 --- a/atom/browser/ui/win/notify_icon.h +++ b/atom/browser/ui/win/notify_icon.h @@ -75,7 +75,7 @@ class NotifyIcon : public TrayIcon { // The context menu. ui::SimpleMenuModel* menu_model_; - + // A hash of the app model ID GUID tray_app_id_hash_; From d485cfbca31a30de1f361d6aaa4148181defc9bf Mon Sep 17 00:00:00 2001 From: Craig Shoemaker Date: Fri, 24 Jul 2015 06:53:55 -0700 Subject: [PATCH 0692/1293] Fixed typo --- docs/api/menu.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/menu.md b/docs/api/menu.md index 41779ee63bee..06400d116917 100644 --- a/docs/api/menu.md +++ b/docs/api/menu.md @@ -29,7 +29,7 @@ window.addEventListener('contextmenu', function (e) { Another example of creating the application menu with the simple template API: -**Note to Window and Linux users** the `selector` member of each menu item is a Mac-only [Accellerator option](https://github.com/atom/electron/blob/master/docs/api/accelerator.md). +**Note to Window and Linux users** the `selector` member of each menu item is a Mac-only [Accelerator option](https://github.com/atom/electron/blob/master/docs/api/accelerator.md). ```html From 5e61974c24c90ebc81562a2f1259ae018db0aab0 Mon Sep 17 00:00:00 2001 From: Paul Betts Date: Fri, 24 Jul 2015 08:02:14 -0700 Subject: [PATCH 0693/1293] Set NIF_GUID if we have a GUID --- atom/browser/ui/win/notify_icon.cc | 20 ++++++++++++-------- atom/browser/ui/win/notify_icon.h | 1 + 2 files changed, 13 insertions(+), 8 deletions(-) diff --git a/atom/browser/ui/win/notify_icon.cc b/atom/browser/ui/win/notify_icon.cc index 787982d04dbf..6cf207d7b8e1 100644 --- a/atom/browser/ui/win/notify_icon.cc +++ b/atom/browser/ui/win/notify_icon.cc @@ -40,13 +40,14 @@ NotifyIcon::NotifyIcon(NotifyIconHost* host, base::MD5Sum(explicit_app_id, sizeof(wchar_t) * wcslen(explicit_app_id), (base::MD5Digest*)&tray_app_id_hash_); + has_tray_app_id_hash_ = true; CoTaskMemFree(explicit_app_id); } NOTIFYICONDATA icon_data; InitIconData(&icon_data); - icon_data.uFlags = NIF_MESSAGE; + icon_data.uFlags |= NIF_MESSAGE; icon_data.uCallbackMessage = message_id_; BOOL result = Shell_NotifyIcon(NIM_ADD, &icon_data); // This can happen if the explorer process isn't running when we try to @@ -89,7 +90,7 @@ void NotifyIcon::ResetIcon() { // Delete any previously existing icon. Shell_NotifyIcon(NIM_DELETE, &icon_data); InitIconData(&icon_data); - icon_data.uFlags = NIF_MESSAGE; + icon_data.uFlags |= NIF_MESSAGE; icon_data.uCallbackMessage = message_id_; icon_data.hIcon = icon_.Get(); // If we have an image, then set the NIF_ICON flag, which tells @@ -106,7 +107,7 @@ void NotifyIcon::SetImage(const gfx::Image& image) { // Create the icon. NOTIFYICONDATA icon_data; InitIconData(&icon_data); - icon_data.uFlags = NIF_ICON; + icon_data.uFlags |= NIF_ICON; icon_.Set(IconUtil::CreateHICONFromSkBitmap(image.AsBitmap())); icon_data.hIcon = icon_.Get(); BOOL result = Shell_NotifyIcon(NIM_MODIFY, &icon_data); @@ -123,7 +124,7 @@ void NotifyIcon::SetToolTip(const std::string& tool_tip) { // Create the icon. NOTIFYICONDATA icon_data; InitIconData(&icon_data); - icon_data.uFlags = NIF_TIP; + icon_data.uFlags |= NIF_TIP; wcscpy_s(icon_data.szTip, base::UTF8ToUTF16(tool_tip).c_str()); BOOL result = Shell_NotifyIcon(NIM_MODIFY, &icon_data); if (!result) @@ -135,7 +136,7 @@ void NotifyIcon::DisplayBalloon(const gfx::Image& icon, const base::string16& contents) { NOTIFYICONDATA icon_data; InitIconData(&icon_data); - icon_data.uFlags = NIF_INFO; + icon_data.uFlags |= NIF_INFO; icon_data.dwInfoFlags = NIIF_INFO; wcscpy_s(icon_data.szInfoTitle, title.c_str()); wcscpy_s(icon_data.szInfo, contents.c_str()); @@ -180,9 +181,12 @@ void NotifyIcon::InitIconData(NOTIFYICONDATA* icon_data) { icon_data->hWnd = window_; icon_data->uID = icon_id_; - memcpy(reinterpret_cast(&icon_data->guidItem), - &tray_app_id_hash_, - sizeof(GUID)); + if (has_tray_app_id_hash_) { + icon_data->uFlags |= NIF_GUID; + memcpy(reinterpret_cast(&icon_data->guidItem), + &tray_app_id_hash_, + sizeof(GUID)); + } } } // namespace atom diff --git a/atom/browser/ui/win/notify_icon.h b/atom/browser/ui/win/notify_icon.h index a52388d56298..25ba8c8dc439 100644 --- a/atom/browser/ui/win/notify_icon.h +++ b/atom/browser/ui/win/notify_icon.h @@ -78,6 +78,7 @@ class NotifyIcon : public TrayIcon { // A hash of the app model ID GUID tray_app_id_hash_; + bool has_tray_app_id_hash_; DISALLOW_COPY_AND_ASSIGN(NotifyIcon); }; From 9eeebedf5fcde6de4289aba6bc84f04dab4bb640 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Sun, 26 Jul 2015 11:43:23 +0800 Subject: [PATCH 0694/1293] Add pageSize option in printToPDF API. --- atom/browser/api/lib/web-contents.coffee | 80 ++++++++++++++++-------- 1 file changed, 54 insertions(+), 26 deletions(-) diff --git a/atom/browser/api/lib/web-contents.coffee b/atom/browser/api/lib/web-contents.coffee index b2232b72cda6..cb6cc7c0b3d8 100644 --- a/atom/browser/api/lib/web-contents.coffee +++ b/atom/browser/api/lib/web-contents.coffee @@ -6,6 +6,34 @@ ipc = require 'ipc' nextId = 0 getNextId = -> ++nextId +PDFPageSize = + A4: + custom_display_name: "A4" + height_microns: 297000 + name: "ISO_A4" + is_default: "true" + width_microns: 210000 + A3: + custom_display_name: "A3" + height_microns: 420000 + name: "ISO_A3" + width_microns: 297000 + Legal: + custom_display_name: "Legal" + height_microns: 355600 + name: "NA_LEGAL" + width_microns: 215900 + Letter: + custom_display_name: "Letter" + height_microns: 279400 + name: "NA_LETTER" + width_microns: 215900 + Tabloid: + height_microns: 431800 + name: "NA_LEDGER" + width_microns: 279400 + custom_display_name: "Tabloid" + wrapWebContents = (webContents) -> # webContents is an EventEmitter. webContents.__proto__ = EventEmitter.prototype @@ -41,32 +69,27 @@ wrapWebContents = (webContents) -> webContents.printToPDF = (options, callback) -> printingSetting = - pageRage:[], - mediaSize: - height_microns:297000, - is_default:true, - name:"ISO_A4", - width_microns:210000, - custom_display_name:"A4", - landscape:false, - color:2, - headerFooterEnabled:false, - marginsType:0, - isFirstRequest:false, - requestID: getNextId(), - previewModifiable:true, - printToPDF:true, - printWithCloudPrint:false, - printWithPrivet:false, - printWithExtension:false, - deviceName:"Save as PDF", - generateDraftData:true, - fitToPageEnabled:false, - duplex:0, - copies:1, - collate:true, - shouldPrintBackgrounds:false, - shouldPrintSelectionOnly:false + pageRage: [] + mediaSize: {} + landscape: false + color: 2 + headerFooterEnabled: false + marginsType: 0 + isFirstRequest: false + requestID: getNextId() + previewModifiable: true + printToPDF: true + printWithCloudPrint: false + printWithPrivet: false + printWithExtension: false + deviceName: "Save as PDF" + generateDraftData: true + fitToPageEnabled: false + duplex: 0 + copies: 1 + collate: true + shouldPrintBackgrounds: false + shouldPrintSelectionOnly: false if options.landscape printingSetting.landscape = options.landscape @@ -77,6 +100,11 @@ wrapWebContents = (webContents) -> if options.printBackgrounds printingSetting.shouldPrintBackgrounds = options.printBackground + if options.pageSize and PDFPageSize[options.pageSize] + printingSetting.mediaSize = PDFPageSize[options.pageSize] + else + printingSetting.mediaSize = PDFPageSize['A4'] + @_printToPDF printingSetting, callback binding._setWrapWebContents wrapWebContents From f53995d5550db47f05db28afff9694f782996303 Mon Sep 17 00:00:00 2001 From: Nishanth Shanmugham Date: Sat, 25 Jul 2015 20:56:35 -0700 Subject: [PATCH 0695/1293] Send bounding Rect on tray double click events --- atom/browser/api/atom_api_tray.cc | 4 ++-- atom/browser/api/atom_api_tray.h | 2 +- atom/browser/ui/tray_icon.cc | 4 ++-- atom/browser/ui/tray_icon.h | 2 +- atom/browser/ui/tray_icon_cocoa.mm | 2 +- atom/browser/ui/tray_icon_observer.h | 2 +- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/atom/browser/api/atom_api_tray.cc b/atom/browser/api/atom_api_tray.cc index a209537c940f..82b2d01c613b 100644 --- a/atom/browser/api/atom_api_tray.cc +++ b/atom/browser/api/atom_api_tray.cc @@ -44,8 +44,8 @@ void Tray::OnClicked(const gfx::Rect& bounds) { Emit("clicked", bounds); } -void Tray::OnDoubleClicked() { - Emit("double-clicked"); +void Tray::OnDoubleClicked(const gfx::Rect& bounds) { + Emit("double-clicked", bounds); } void Tray::OnBalloonShow() { diff --git a/atom/browser/api/atom_api_tray.h b/atom/browser/api/atom_api_tray.h index 10ea3836819e..f3b91f00c0f0 100644 --- a/atom/browser/api/atom_api_tray.h +++ b/atom/browser/api/atom_api_tray.h @@ -43,7 +43,7 @@ class Tray : public mate::EventEmitter, // TrayIconObserver: void OnClicked(const gfx::Rect& bounds) override; - void OnDoubleClicked() override; + void OnDoubleClicked(const gfx::Rect& bounds) override; void OnBalloonShow() override; void OnBalloonClicked() override; void OnBalloonClosed() override; diff --git a/atom/browser/ui/tray_icon.cc b/atom/browser/ui/tray_icon.cc index 456cbe47a5a3..b22250d35c8f 100644 --- a/atom/browser/ui/tray_icon.cc +++ b/atom/browser/ui/tray_icon.cc @@ -33,8 +33,8 @@ void TrayIcon::NotifyClicked(const gfx::Rect& bounds) { FOR_EACH_OBSERVER(TrayIconObserver, observers_, OnClicked(bounds)); } -void TrayIcon::NotifyDoubleClicked() { - FOR_EACH_OBSERVER(TrayIconObserver, observers_, OnDoubleClicked()); +void TrayIcon::NotifyDoubleClicked(const gfx::Rect& bounds) { + FOR_EACH_OBSERVER(TrayIconObserver, observers_, OnDoubleClicked(bounds)); } void TrayIcon::NotifyBalloonShow() { diff --git a/atom/browser/ui/tray_icon.h b/atom/browser/ui/tray_icon.h index d6885699d01d..5e362806f5d6 100644 --- a/atom/browser/ui/tray_icon.h +++ b/atom/browser/ui/tray_icon.h @@ -55,7 +55,7 @@ class TrayIcon { void AddObserver(TrayIconObserver* obs) { observers_.AddObserver(obs); } void RemoveObserver(TrayIconObserver* obs) { observers_.RemoveObserver(obs); } void NotifyClicked(const gfx::Rect& = gfx::Rect()); - void NotifyDoubleClicked(); + void NotifyDoubleClicked(const gfx::Rect& = gfx::Rect()); void NotifyBalloonShow(); void NotifyBalloonClicked(); void NotifyBalloonClosed(); diff --git a/atom/browser/ui/tray_icon_cocoa.mm b/atom/browser/ui/tray_icon_cocoa.mm index fddbd8c16eb0..59386ff8eb41 100644 --- a/atom/browser/ui/tray_icon_cocoa.mm +++ b/atom/browser/ui/tray_icon_cocoa.mm @@ -156,7 +156,7 @@ const CGFloat kMargin = 3; } if (event.clickCount == 2 && !menuController_) { - trayIcon_->NotifyDoubleClicked(); + trayIcon_->NotifyDoubleClicked([self getBoundsFromEvent:event]); } [self setNeedsDisplay:YES]; } diff --git a/atom/browser/ui/tray_icon_observer.h b/atom/browser/ui/tray_icon_observer.h index 6c9839a38a1f..474c6a771934 100644 --- a/atom/browser/ui/tray_icon_observer.h +++ b/atom/browser/ui/tray_icon_observer.h @@ -17,7 +17,7 @@ namespace atom { class TrayIconObserver { public: virtual void OnClicked(const gfx::Rect& bounds) {} - virtual void OnDoubleClicked() {} + virtual void OnDoubleClicked(const gfx::Rect& bounds) {} virtual void OnBalloonShow() {} virtual void OnBalloonClicked() {} virtual void OnBalloonClosed() {} From 74f2e9f102146e32b55d0c8a1ba4ee560fd6383e Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Sun, 26 Jul 2015 11:56:07 +0800 Subject: [PATCH 0696/1293] :memo: pageSize option. --- docs/api/browser-window.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index c8fc39a53f1f..cee68183f783 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -1001,6 +1001,12 @@ size. * 0 - default * 1 - none * 2 - minimum + * `pageSize` String - Specify page size of the generated PDF + * `A4` + * `A3` + * `Legal` + * `Letter` + * `Tabloid` * `printBackground` Boolean - Whether to print CSS backgrounds. * `printSelectionOnly` Boolean - Whether to print selection only. * `landscape` Boolean - `true` for landscape, `false` for portrait. @@ -1027,9 +1033,10 @@ win.webContents.on("did-finish-load", function() { // Use default printing options win.webContents.printToPDF({}, function(error, data) { if (error) throw error; - fs.writeFile(dist, data, function(error) { + fs.writeFile("/tmp/print.pdf", data, function(error) { if (err) - alert('write pdf file error', error); + throw error; + console.log("Write PDF successfully."); }) }) }); From 1a074bb14850604350de072b53354dd216080866 Mon Sep 17 00:00:00 2001 From: Nishanth Shanmugham Date: Sat, 25 Jul 2015 21:16:15 -0700 Subject: [PATCH 0697/1293] Update tray double-click docs * Mention bounds payload --- docs/api/tray.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/api/tray.md b/docs/api/tray.md index 847b0b2cf818..9332822a32a8 100644 --- a/docs/api/tray.md +++ b/docs/api/tray.md @@ -76,6 +76,13 @@ will be emitted if the tray icon has context menu. Emitted when the tray icon is double clicked. +* `event` +* `bounds` Object - the bounds of tray icon + * `x` Integer + * `y` Integer + * `width` Integer + * `height` Integer + __Note:__ This is only implemented on OS X. ### Event: 'balloon-show' From 0700f08d6da7c7c7cabb18a878a3fc63efdb2346 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Sun, 26 Jul 2015 16:08:29 +0800 Subject: [PATCH 0698/1293] Copy pref_names files from Chromium. --- atom/browser/web_dialog_helper.cc | 7 +++---- chromium_src/chrome/common/pref_names.cc | 11 +++++++++++ chromium_src/chrome/common/pref_names.h | 11 +++++++++++ filenames.gypi | 2 ++ 4 files changed, 27 insertions(+), 4 deletions(-) create mode 100644 chromium_src/chrome/common/pref_names.cc diff --git a/atom/browser/web_dialog_helper.cc b/atom/browser/web_dialog_helper.cc index 93cb32cba7c7..7b467cfcdfcb 100644 --- a/atom/browser/web_dialog_helper.cc +++ b/atom/browser/web_dialog_helper.cc @@ -15,6 +15,7 @@ #include "base/files/file_path.h" #include "base/prefs/pref_service.h" #include "base/strings/utf_string_conversions.h" +#include "chrome/common/pref_names.h" #include "content/public/browser/render_view_host.h" #include "content/public/browser/web_contents.h" #include "content/public/common/file_chooser_file_info.h" @@ -23,8 +24,6 @@ namespace { -const char kSelectFileLastDirectory[] = "selectfile.last_directory"; - file_dialog::Filters GetFileTypesFromAcceptType( const std::vector& accept_types) { file_dialog::Filters filters; @@ -111,7 +110,7 @@ void WebDialogHelper::RunFileChooser(content::WebContents* web_contents, AtomBrowserContext* browser_context = static_cast( window_->web_contents()->GetBrowserContext()); base::FilePath default_file_path = browser_context->prefs()->GetFilePath( - kSelectFileLastDirectory).Append(params.default_file_name); + prefs::kSelectFileLastDirectory).Append(params.default_file_name); if (file_dialog::ShowOpenDialog(window_, base::UTF16ToUTF8(params.title), default_file_path, @@ -125,7 +124,7 @@ void WebDialogHelper::RunFileChooser(content::WebContents* web_contents, result.push_back(info); } if (!paths.empty()) { - browser_context->prefs()->SetFilePath(kSelectFileLastDirectory, + browser_context->prefs()->SetFilePath(prefs::kSelectFileLastDirectory, paths[0].DirName()); } } diff --git a/chromium_src/chrome/common/pref_names.cc b/chromium_src/chrome/common/pref_names.cc new file mode 100644 index 000000000000..3871fde2c2f0 --- /dev/null +++ b/chromium_src/chrome/common/pref_names.cc @@ -0,0 +1,11 @@ +// Copyright (c) 2012 The Chromium Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. + +#include "chrome/common/pref_names.h" + +namespace prefs { + +const char kSelectFileLastDirectory[] = "selectfile.last_directory"; + +} // namespace prefs diff --git a/chromium_src/chrome/common/pref_names.h b/chromium_src/chrome/common/pref_names.h index e69de29bb2d1..78bd2a04800b 100644 --- a/chromium_src/chrome/common/pref_names.h +++ b/chromium_src/chrome/common/pref_names.h @@ -0,0 +1,11 @@ +// Copyright (c) 2012 The Chromium Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. + +// Constants for the names of various preferences, for easier changing. + +namespace prefs { + +extern const char kSelectFileLastDirectory[]; + +} // namespace prefs diff --git a/filenames.gypi b/filenames.gypi index ed51fc8fb47b..82f9ea95d078 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -364,6 +364,8 @@ 'chromium_src/chrome/browser/ui/views/frame/global_menu_bar_registrar_x11.cc', 'chromium_src/chrome/browser/ui/views/frame/global_menu_bar_registrar_x11.h', 'chromium_src/chrome/common/chrome_utility_messages.h', + 'chromium_src/chrome/common/pref_names.cc', + 'chromium_src/chrome/common/pref_names.h', 'chromium_src/chrome/common/print_messages.cc', 'chromium_src/chrome/common/print_messages.h', 'chromium_src/chrome/common/tts_messages.h', From 2aa17debc8daa253eb81e0893f458125e5e324a1 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Sun, 26 Jul 2015 16:17:55 +0800 Subject: [PATCH 0699/1293] prefs' key needs to be registered before using. --- atom/browser/atom_browser_context.cc | 8 ++++++++ atom/browser/atom_browser_context.h | 1 + 2 files changed, 9 insertions(+) diff --git a/atom/browser/atom_browser_context.cc b/atom/browser/atom_browser_context.cc index 1874d5b03b19..65307d0ef7c1 100644 --- a/atom/browser/atom_browser_context.cc +++ b/atom/browser/atom_browser_context.cc @@ -15,10 +15,13 @@ #include "atom/common/chrome_version.h" #include "atom/common/options_switches.h" #include "base/command_line.h" +#include "base/files/file_path.h" +#include "base/prefs/pref_registry_simple.h" #include "base/strings/string_util.h" #include "base/strings/stringprintf.h" #include "base/threading/sequenced_worker_pool.h" #include "base/threading/worker_pool.h" +#include "chrome/common/pref_names.h" #include "content/public/browser/browser_thread.h" #include "content/public/common/url_constants.h" #include "content/public/common/user_agent.h" @@ -146,4 +149,9 @@ content::BrowserPluginGuestManager* AtomBrowserContext::GetGuestManager() { return guest_manager_.get(); } +void AtomBrowserContext::RegisterPrefs(PrefRegistrySimple* pref_registry) { + pref_registry->RegisterFilePathPref(prefs::kSelectFileLastDirectory, + base::FilePath()); +} + } // namespace atom diff --git a/atom/browser/atom_browser_context.h b/atom/browser/atom_browser_context.h index 513cc86bca68..d64a894070f8 100644 --- a/atom/browser/atom_browser_context.h +++ b/atom/browser/atom_browser_context.h @@ -31,6 +31,7 @@ class AtomBrowserContext : public brightray::BrowserContext { // content::BrowserContext: content::DownloadManagerDelegate* GetDownloadManagerDelegate() override; content::BrowserPluginGuestManager* GetGuestManager() override; + void RegisterPrefs(PrefRegistrySimple* pref_registry) override; AtomURLRequestJobFactory* job_factory() const { return job_factory_; } From fef53d18c4b694799b775bb53a764d8c803ceb2b Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Sun, 26 Jul 2015 16:30:02 +0800 Subject: [PATCH 0700/1293] Add `session.setDownloadPath` API. --- atom/browser/api/atom_api_session.cc | 11 ++++++++++- atom/browser/api/atom_api_session.h | 1 + atom/browser/atom_browser_context.cc | 2 ++ atom/browser/atom_download_manager_delegate.cc | 13 +++++++++++++ chromium_src/chrome/common/pref_names.cc | 1 + chromium_src/chrome/common/pref_names.h | 1 + 6 files changed, 28 insertions(+), 1 deletion(-) diff --git a/atom/browser/api/atom_api_session.cc b/atom/browser/api/atom_api_session.cc index 483b730d1c70..c864598a3191 100644 --- a/atom/browser/api/atom_api_session.cc +++ b/atom/browser/api/atom_api_session.cc @@ -10,8 +10,11 @@ #include "atom/browser/api/atom_api_cookies.h" #include "atom/browser/atom_browser_context.h" #include "atom/common/native_mate_converters/gurl_converter.h" -#include "base/thread_task_runner_handle.h" +#include "base/files/file_path.h" +#include "base/prefs/pref_service.h" #include "base/strings/string_util.h" +#include "base/thread_task_runner_handle.h" +#include "chrome/common/pref_names.h" #include "content/public/browser/browser_thread.h" #include "content/public/browser/storage_partition.h" #include "native_mate/callback.h" @@ -251,6 +254,11 @@ void Session::SetProxy(const std::string& proxy, base::Bind(&SetProxyInIO, base::Unretained(getter), proxy, callback)); } +void Session::SetDownloadPath(const std::string& path) { + browser_context_->prefs()->SetFilePath(prefs::kDownloadDefaultDirectory, + base::FilePath(path)); +} + v8::Local Session::Cookies(v8::Isolate* isolate) { if (cookies_.IsEmpty()) { auto handle = atom::api::Cookies::Create(isolate, browser_context_); @@ -266,6 +274,7 @@ mate::ObjectTemplateBuilder Session::GetObjectTemplateBuilder( .SetMethod("clearCache", &Session::ClearCache) .SetMethod("clearStorageData", &Session::ClearStorageData) .SetMethod("setProxy", &Session::SetProxy) + .SetMethod("setDownloadPath", &Session::SetDownloadPath) .SetProperty("cookies", &Session::Cookies); } diff --git a/atom/browser/api/atom_api_session.h b/atom/browser/api/atom_api_session.h index 3963ed21189a..a8c0e2444955 100644 --- a/atom/browser/api/atom_api_session.h +++ b/atom/browser/api/atom_api_session.h @@ -46,6 +46,7 @@ class Session: public mate::TrackableObject { void ClearCache(const net::CompletionCallback& callback); void ClearStorageData(mate::Arguments* args); void SetProxy(const std::string& proxy, const base::Closure& callback); + void SetDownloadPath(const std::string& path); v8::Local Cookies(v8::Isolate* isolate); v8::Global cookies_; diff --git a/atom/browser/atom_browser_context.cc b/atom/browser/atom_browser_context.cc index 65307d0ef7c1..f04fbca747e6 100644 --- a/atom/browser/atom_browser_context.cc +++ b/atom/browser/atom_browser_context.cc @@ -152,6 +152,8 @@ content::BrowserPluginGuestManager* AtomBrowserContext::GetGuestManager() { void AtomBrowserContext::RegisterPrefs(PrefRegistrySimple* pref_registry) { pref_registry->RegisterFilePathPref(prefs::kSelectFileLastDirectory, base::FilePath()); + pref_registry->RegisterFilePathPref(prefs::kDownloadDefaultDirectory, + base::FilePath()); } } // namespace atom diff --git a/atom/browser/atom_download_manager_delegate.cc b/atom/browser/atom_download_manager_delegate.cc index 46c4af2dc387..7e393f7d2c21 100644 --- a/atom/browser/atom_download_manager_delegate.cc +++ b/atom/browser/atom_download_manager_delegate.cc @@ -6,10 +6,13 @@ #include +#include "atom/browser/atom_browser_context.h" #include "atom/browser/native_window.h" #include "atom/browser/ui/file_dialog.h" #include "base/bind.h" #include "base/files/file_util.h" +#include "base/prefs/pref_service.h" +#include "chrome/common/pref_names.h" #include "content/public/browser/browser_context.h" #include "content/public/browser/browser_thread.h" #include "content/public/browser/download_manager.h" @@ -77,6 +80,11 @@ void AtomDownloadManagerDelegate::OnDownloadPathGenerated( return; } + // Remeber the last selected download directory. + AtomBrowserContext* browser_context = static_cast( + download_manager_->GetBrowserContext()); + browser_context->prefs()->SetFilePath(prefs::kDownloadDefaultDirectory, + path.DirName()); callback.Run(path, content::DownloadItem::TARGET_DISPOSITION_PROMPT, content::DOWNLOAD_DANGER_TYPE_NOT_DANGEROUS, path); @@ -92,6 +100,11 @@ bool AtomDownloadManagerDelegate::DetermineDownloadTarget( const content::DownloadTargetCallback& callback) { DCHECK_CURRENTLY_ON(content::BrowserThread::UI); + AtomBrowserContext* browser_context = static_cast( + download_manager_->GetBrowserContext()); + default_download_path_ = browser_context->prefs()->GetFilePath( + prefs::kDownloadDefaultDirectory); + // If users didn't set download path, use 'Downloads' directory by default. if (default_download_path_.empty()) { auto path = download_manager_->GetBrowserContext()->GetPath(); default_download_path_ = path.Append(FILE_PATH_LITERAL("Downloads")); diff --git a/chromium_src/chrome/common/pref_names.cc b/chromium_src/chrome/common/pref_names.cc index 3871fde2c2f0..3e3a73b99837 100644 --- a/chromium_src/chrome/common/pref_names.cc +++ b/chromium_src/chrome/common/pref_names.cc @@ -7,5 +7,6 @@ namespace prefs { const char kSelectFileLastDirectory[] = "selectfile.last_directory"; +const char kDownloadDefaultDirectory[] = "download.default_directory"; } // namespace prefs diff --git a/chromium_src/chrome/common/pref_names.h b/chromium_src/chrome/common/pref_names.h index 78bd2a04800b..542a2d2c733f 100644 --- a/chromium_src/chrome/common/pref_names.h +++ b/chromium_src/chrome/common/pref_names.h @@ -7,5 +7,6 @@ namespace prefs { extern const char kSelectFileLastDirectory[]; +extern const char kDownloadDefaultDirectory[]; } // namespace prefs From 7f0cb0ce1b00bc1122b4e6620fac9073693f517b Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Sun, 26 Jul 2015 16:52:02 +0800 Subject: [PATCH 0701/1293] :memo: session.setDownloadPath API. --- docs/api/browser-window.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index c8fc39a53f1f..766b9ce92439 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -1220,3 +1220,7 @@ proxy-uri = ["://"][":"] and use socks4://foopy2 for all other URLs. ``` + +### Session.setDownloadPath(path) + +* `path` String - The download location From b0e73532de0330c6b67363b249e6ec6074d85f1c Mon Sep 17 00:00:00 2001 From: Robo Date: Mon, 27 Jul 2015 02:51:41 +0530 Subject: [PATCH 0702/1293] protocol: fix request headers in urlRequestFetchJob --- atom/browser/net/url_request_fetch_job.cc | 5 +---- spec/api-protocol-spec.coffee | 1 + 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/atom/browser/net/url_request_fetch_job.cc b/atom/browser/net/url_request_fetch_job.cc index 5389b8bb6216..abad38d7f4d5 100644 --- a/atom/browser/net/url_request_fetch_job.cc +++ b/atom/browser/net/url_request_fetch_job.cc @@ -107,10 +107,7 @@ URLRequestFetchJob::URLRequestFetchJob( } // Use |request|'s headers. - net::HttpRequestHeaders headers; - if (request->GetFullRequestHeaders(&headers)) { - fetcher_->SetExtraRequestHeaders(headers.ToString()); - } + fetcher_->SetExtraRequestHeaders(request->extra_request_headers().ToString()); } net::URLRequestContextGetter* URLRequestFetchJob::GetRequestContext() { diff --git a/spec/api-protocol-spec.coffee b/spec/api-protocol-spec.coffee index b65002a63189..4f2fb79da372 100644 --- a/spec/api-protocol-spec.coffee +++ b/spec/api-protocol-spec.coffee @@ -81,6 +81,7 @@ describe 'protocol module', -> it 'returns RequestHttpJob should send respone', (done) -> server = http.createServer (req, res) -> + assert.notEqual req.headers.accept, '' res.writeHead(200, {'Content-Type': 'text/plain'}) res.end('hello') server.close() From b6f6bf9778e1e49cb2e5192e7d6ddbd427b8ddf4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Machist=C3=A9=20N=2E=20Quintana?= Date: Sun, 26 Jul 2015 20:26:10 -0400 Subject: [PATCH 0703/1293] :memo: Reorganize the Run Your App section --- docs/tutorial/quick-start.md | 36 +++++++++++++++++++++++++++++------- 1 file changed, 29 insertions(+), 7 deletions(-) diff --git a/docs/tutorial/quick-start.md b/docs/tutorial/quick-start.md index ae60fb27ec71..ec3fba9bbfd1 100644 --- a/docs/tutorial/quick-start.md +++ b/docs/tutorial/quick-start.md @@ -130,24 +130,41 @@ Finally the `index.html` is the web page you want to show: ## Run your app -After you're done writing your app, you can create a distribution by -following the [Application distribution](./application-distribution.md) guide -and then execute the packaged app. You can also just use the downloaded -Electron binary to execute your app directly. +Once you've created your initial `main.js`, `index.html`, and `package.json` files, +you'll probably want to try running your app locally to test it and make sure it's +working as expected. -On Windows: +### electron-prebuilt +If you've installed `electron-prebuilt` globally with `npm`, then you need only +run the following in your app's source directory: + +```bash +electron . +``` + +If you've installed it locally, then run: + +```bash +./node_modules/.bin/electron . +``` + +### Manually Downloaded Electron Binary +If you downloaded Electron manually, you can also just use the included +binary to execute your app directly. + +#### Windows ```bash $ .\electron\electron.exe your-app\ ``` -On Linux: +#### Linux ```bash $ ./electron/electron your-app/ ``` -On OS X: +#### OS X ```bash $ ./Electron.app/Contents/MacOS/Electron your-app/ @@ -155,3 +172,8 @@ $ ./Electron.app/Contents/MacOS/Electron your-app/ `Electron.app` here is part of the Electron's release package, you can download it from [here](https://github.com/atom/electron/releases). + +### Run as a distribution +After you're done writing your app, you can create a distribution by +following the [Application distribution](./application-distribution.md) guide +and then execute the packaged app. From f2b2c58758464d1aece8340e694f7416a425b2de Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Machist=C3=A9=20N=2E=20Quintana?= Date: Sun, 26 Jul 2015 20:31:01 -0400 Subject: [PATCH 0704/1293] :memo: :art: Grammar fix --- docs/tutorial/quick-start.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorial/quick-start.md b/docs/tutorial/quick-start.md index ec3fba9bbfd1..197cf0d3b32b 100644 --- a/docs/tutorial/quick-start.md +++ b/docs/tutorial/quick-start.md @@ -176,4 +176,4 @@ it from [here](https://github.com/atom/electron/releases). ### Run as a distribution After you're done writing your app, you can create a distribution by following the [Application distribution](./application-distribution.md) guide -and then execute the packaged app. +and then executing the packaged app. From 59c3efd44bbbcc1523bdf4f7715b30ecddc4aa84 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Mon, 27 Jul 2015 09:09:32 +0800 Subject: [PATCH 0705/1293] Correct the override comment. --- atom/browser/atom_browser_context.h | 2 ++ 1 file changed, 2 insertions(+) diff --git a/atom/browser/atom_browser_context.h b/atom/browser/atom_browser_context.h index d64a894070f8..3455916fa5b3 100644 --- a/atom/browser/atom_browser_context.h +++ b/atom/browser/atom_browser_context.h @@ -31,6 +31,8 @@ class AtomBrowserContext : public brightray::BrowserContext { // content::BrowserContext: content::DownloadManagerDelegate* GetDownloadManagerDelegate() override; content::BrowserPluginGuestManager* GetGuestManager() override; + + // brightray::BrowserContext:: void RegisterPrefs(PrefRegistrySimple* pref_registry) override; AtomURLRequestJobFactory* job_factory() const { return job_factory_; } From faf10183d8275daedb23659641135e236418c973 Mon Sep 17 00:00:00 2001 From: Matias Insaurralde Date: Sun, 26 Jul 2015 22:57:43 -0400 Subject: [PATCH 0706/1293] first docs --- docs/README-es.md | 34 ++-- docs/tutorial/application-distribution-es.md | 114 ++++++++++++ docs/tutorial/application-packaging-es.md | 157 ++++++++++++++++ docs/tutorial/debugging-main-process-es.md | 45 +++++ .../desktop-environment-integration-es.md | 171 ++++++++++++++++++ docs/tutorial/devtools-extension-es.md | 49 +++++ docs/tutorial/online-offline-events-es.md | 80 ++++++++ docs/tutorial/quick-start-es.md | 154 ++++++++++++++++ docs/tutorial/using-native-node-modules-es.md | 57 ++++++ docs/tutorial/using-pepper-flash-plugin-es.md | 58 ++++++ .../using-selenium-and-webdriver-es.md | 72 ++++++++ 11 files changed, 974 insertions(+), 17 deletions(-) create mode 100644 docs/tutorial/application-distribution-es.md create mode 100644 docs/tutorial/application-packaging-es.md create mode 100644 docs/tutorial/debugging-main-process-es.md create mode 100644 docs/tutorial/desktop-environment-integration-es.md create mode 100644 docs/tutorial/devtools-extension-es.md create mode 100644 docs/tutorial/online-offline-events-es.md create mode 100644 docs/tutorial/quick-start-es.md create mode 100644 docs/tutorial/using-native-node-modules-es.md create mode 100644 docs/tutorial/using-pepper-flash-plugin-es.md create mode 100644 docs/tutorial/using-selenium-and-webdriver-es.md diff --git a/docs/README-es.md b/docs/README-es.md index 16ecc3afd4b3..991c80b069f3 100644 --- a/docs/README-es.md +++ b/docs/README-es.md @@ -1,16 +1,16 @@ ## Guías -* [Application distribution](tutorial/application-distribution.md) -* [Application packaging](tutorial/application-packaging.md) -* [Utilizando módulos nativos](tutorial/using-native-node-modules.md) -* [Depurando el proceso principal](tutorial/debugging-main-process.md) -* [Utilizando Selenium y WebDriver](tutorial/using-selenium-and-webdriver.md) -* [Extensión DevTools](tutorial/devtools-extension.md) -* [Utilizando el plugin pepper flash](tutorial/using-pepper-flash-plugin.md) +* [Distribución de aplicaciones](tutorial/application-distribution-es.md) +* [Empaquetamiento de aplicaciones](tutorial/application-packaging-es.md) +* [Utilizando módulos nativos](tutorial/using-native-node-modules-es.md) +* [Depurando el proceso principal](tutorial/debugging-main-process-es.md) +* [Utilizando Selenium y WebDriver](tutorial/using-selenium-and-webdriver-es.md) +* [Extensión DevTools](tutorial/devtools-extension-es.md) +* [Utilizando el plugin pepper flash](tutorial/using-pepper-flash-plugin-es.md) ## Tutoriales -* [Quick start](tutorial/quick-start.md) +* [Introducción](tutorial/quick-start.md) * [Integración con el entorno de escritorio](tutorial/desktop-environment-integration.md) * [Detección del evento en línea/fuera de línea](tutorial/online-offline-events.md) @@ -18,7 +18,7 @@ * [Sinopsis](api/synopsis.md) * [Proceso](api/process.md) -* [Supported Chrome command line switches](api/chrome-command-line-switches.md) +* [Parámetros CLI soportados (Chrome)](api/chrome-command-line-switches.md) Elementos DOM customizados: @@ -26,7 +26,7 @@ Elementos DOM customizados: * [`` tag](api/web-view-tag.md) * [`window.open` function](api/window-open.md) -Módulos para el proceso principal: +Módulos del proceso principal: * [app](api/app.md) * [auto-updater](api/auto-updater.md) @@ -42,13 +42,13 @@ Módulos para el proceso principal: * [protocol](api/protocol.md) * [tray](api/tray.md) -Módulos para el renderer (página web): +Módulos del renderer (página web): * [ipc (renderer)](api/ipc-renderer.md) * [remote](api/remote.md) * [web-frame](api/web-frame.md) -Módulos para ambos procesos: +Módulos de ambos procesos: * [clipboard](api/clipboard.md) * [crash-reporter](api/crash-reporter.md) @@ -61,8 +61,8 @@ Módulos para ambos procesos: * [Guía de estilo](development/coding-style.md) * [Estructura de directorio](development/source-code-directory-structure.md) * [Diferencias técnicas con NW.js (anteriormente conocido como node-webkit)](development/atom-shell-vs-node-webkit.md) -* [Build system overview](development/build-system-overview.md) -* [Build instructions (Mac)](development/build-instructions-mac.md) -* [Build instructions (Windows)](development/build-instructions-windows.md) -* [Build instructions (Linux)](development/build-instructions-linux.md) -* [Setting up symbol server in debugger](development/setting-up-symbol-server.md) +* [Sistema de compilación](development/build-system-overview.md) +* [Instrucciones de compilación (Mac)](development/build-instructions-mac.md) +* [Instrucciones de compilación (Windows)](development/build-instructions-windows.md) +* [Instrucciones de compilación (Linux)](development/build-instructions-linux.md) +* [Configurando un servidor de símbolos en el depurador](development/setting-up-symbol-server.md) diff --git a/docs/tutorial/application-distribution-es.md b/docs/tutorial/application-distribution-es.md new file mode 100644 index 000000000000..644da8c3c87b --- /dev/null +++ b/docs/tutorial/application-distribution-es.md @@ -0,0 +1,114 @@ +# Distribución de aplicaciones + +Para distribuir tu aplicación con Electron, debes nombrar al directorio de tu aplicación +como `app`, y ponerlo bajo el directorio de recursos de Electron (en OSX es `Electron.app/Contents/Resources/`, +en Linux y Windows es `resources/`): + +En OSX: + +```text +electron/Electron.app/Contents/Resources/app/ +├── package.json +├── main.js +└── index.html +``` + +En Windows y Linux: + +```text +electron/resources/app +├── package.json +├── main.js +└── index.html +``` + +Posteriormente ejecutas `Electron.app` (o `electron` en Linux, `electron.exe` en Windows), +y Electron iniciará la aplicación. El directorio `electron` será la distribución que recibirán los usuarios finales. + +## Empaquetando tu aplicación como un archivo + +Además de copiar todos tus archivos fuente para la distribución, también puedes +empaquetar tu aplicación como un archivo [asar](https://github.com/atom/asar) +y de esta forma evitar la exposición del código fuente de tu aplicación a los usuarios. + +Para usar un archivo `asar` en reemplazo de la carpeta `app`, debes renombrar +el archivo a `app.asar`, y ponerlo bajo el directorio de recursos de Electron (como arriba), +Electron intentará leer el archivo y ejecutar la aplicación desde él. + +En OS X: + +```text +electron/Electron.app/Contents/Resources/ +└── app.asar +``` + +En Windows y Linux: + +```text +electron/resources/ +└── app.asar +``` + +Más detalles en [Empaquetamiento de aplicaciones](application-packaging-es.md). + +## Rebranding con binarios descargados + +Luego de empaquetar tu aplicación con Electron, podría ser útil agregar tu marca +antes de realizar la distribución. + +### Windows + +Puedes renombrar `electron.exe` a cualquier nombre que desees, y editar su ícono y otras informaciones +con herramientas como [rcedit](https://github.com/atom/rcedit) o [ResEdit](http://www.resedit.net). + +### OS X + +Puedes renombrar `Electron.app` a cualquier nombre que desees. También debes modificar los campos +`CFBundleDisplayName`, `CFBundleIdentifier` y `CFBundleName` en los siguientes archivos: + +* `Electron.app/Contents/Info.plist` +* `Electron.app/Contents/Frameworks/Electron Helper.app/Contents/Info.plist` + +También puedes renombrar el helper de la aplicación para evitar que aparezca como `Electron Helper` +en el Monitor de Actividades. + +La estructura de una aplicación renombrada sería así: + +``` +MyApp.app/Contents +├── Info.plist +├── MacOS/ +│   └── MyApp +└── Frameworks/ + ├── MyApp Helper EH.app + | ├── Info.plist + | └── MacOS/ + |    └── MyApp Helper EH + ├── MyApp Helper NP.app + | ├── Info.plist + | └── MacOS/ + |    └── MyApp Helper NP + └── MyApp Helper.app + ├── Info.plist + └── MacOS/ +    └── MyApp Helper +``` + +### Linux + +Puedes renombrar el ejectuable `electron` a cualquier nombre que desees. + +## Rebranding desde el código fuente de Electron + +También es posible agregar tu marca a Electron mediante un build personalizado. +Para realizar esto debes modificar el archivo `atom.gyp`. + +### grunt-build-atom-shell + +La modificación del código de Electron para agregar tu marca puede resultar complicada, una tarea Grunt +se ha creado para manejar esto de forma automatizada: + +[grunt-build-atom-shell](https://github.com/paulcbetts/grunt-build-atom-shell). + +Esta tarea se encargará de modificar el archivo `.gyp`, compilar el código +y reconstruir los módulos nativos de la aplicación para que coincidan con el nuevo nombre. diff --git a/docs/tutorial/application-packaging-es.md b/docs/tutorial/application-packaging-es.md new file mode 100644 index 000000000000..56698c1aaecb --- /dev/null +++ b/docs/tutorial/application-packaging-es.md @@ -0,0 +1,157 @@ +# Empaquetamiento de aplicaciones + +Para proteger los recursos y el código fuente de tu aplicación, puedes optar por empaquetar +tu aplicación en un paquete [asar][asar]. + +## Generando un archivo `asar` + +Un paquete [asar][asar] es un formato sencillo similar a tar, este formato concatena todos los archivos en uno, +Electron puede leer el contenido sin desempaquetar todos los archivos. + +A continuación, los pasos para empaquetar tu aplicación con `asar`: + +### 1. Instalar asar + +```bash +$ npm install -g asar +``` + +### 2. Empaquetar utilizando `asar pack` + +```bash +$ asar pack your-app app.asar +``` + +## Utilizando los paquetes `asar` + +En Electron existen dos tipos de APIs: las APIs de Node, proveídas por Node.js, +y las APIs Web, proveídas por Chromium. Ambas APIs soportan la lecutra de paquetes `asar`. + +### API Node + +Con parches especiales en Electron, las APIs de Node como `fs.readFile` and `require` +tratan los paquetes `asar` como directorios virtuales, y el contenido es accesible como si se tratara +de archivos normales en el sistema de archivos. + +Por ejemplo, supongamos que tenemos un paquete `example.asar` bajo `/path/to`: + +```bash +$ asar list /path/to/example.asar +/app.js +/file.txt +/dir/module.js +/static/index.html +/static/main.css +/static/jquery.min.js +``` + +Leer un archivo de nuestro paquete `asar`: + +```javascript +var fs = require('fs'); +fs.readFileSync('/path/to/example.asar/file.txt'); +``` + +Listar todos los archivos de la raíz: + +```javascript +var fs = require('fs'); +fs.readdirSync('/path/to/example.asar'); +``` + +Utilizar un módulo que se encuentra dentro del archivo: + +```javascript +require('/path/to/example.asar/dir/module.js'); +``` + +También puedes mostrar una página web contenida en un `asar` utilizando `BrowserWindow`. + +```javascript +var BrowserWindow = require('browser-window'); +var win = new BrowserWindow({width: 800, height: 600}); +win.loadUrl('file:///path/to/example.asar/static/index.html'); +``` + +### API Web + +En una págin web, los archivos que se encuentran en el paquete son accesibles a través del protocolo `file:`. +Al igual que la API Node, los paquetes `asar` son tratados como directorios. + +Por ejemplo, para obtener un archivo con `$.get`: + +```html + +``` + +### Utilizando un paquete `asar` como un archivo normal + +En algunas situaciones necesitaremos acceder al paquete `asar` como archivo, por ejemplo, +si necesitaramos verificar la integridad del archivo con un checksum. +Para casos así es posible utilizar el módulo `original-fs`, que provee la API `fs` original: + +```javascript +var originalFs = require('original-fs'); +originalFs.readFileSync('/path/to/example.asar'); +``` + +## Limitaciones de la API Node: + +A pesar de que hemos intentado que los paquetes `asar` funcionen como directorios de la mejor forma posible, +aún existen limitaciones debido a la naturaleza de bajo nivel de la API Node. + +### Los paquetes son de sólo lecutra + +Los paquetes `asar` no pueden ser modificados, por lo cual todas las funciones que modifiquen archivos +no funcionarán. + +## Los directorios del paquete no pueden establecerse como working directories + +A pesar de que los paquetes `asar` son manejados virtualmente como directorios, +estos directorios no existen en el sistema de archivos, por lo cual no es posible establecerlos +como working directory, el uso de la opción `cwd` en algunas APIs podría causar errores. + +### Desempaquetamiento adicional en algunas APIs + +La mayoría de las APIs `fs` pueden leer u obtener información sobre un archivo en un paquete `asar` sin +la necesidad de desempaquetarlo, pero algunas APIs requieren la ruta real. En estos casos Electron extraerá +el archivo a una ruta temporal. Esto agrega un overhead a algunas APIs. + +Las APIs que requieren el desempaquetamiento adicional son: + +* `child_process.execFile` +* `fs.open` +* `fs.openSync` +* `process.dlopen` - Utilizado po `require` en los módulos nativos + +### Información falsa en `fs.stat` + +El objeto `Stats` retornado por `fs.stat` y otras funciones relacionadas, +no es preciso, ya que los archivos del paquete `asar` no existen el sistema de archivos. +La utilización del objeto `Stats` sólo es recomendable para obtener el tamaño del archivo y/o +comprobar el tipo de archivo. + + +## Agregando archivos al paquete `asar` + +Como se menciona arriba, algunas APIs de Node desempaquetarán archivos cuando exista una llamada +que los referencie, además de los problemas de rendimiento que esto podría ocasionar, también +podría accionar alertas falsas en software antivirus. + +Para lidiar con esto, puedes desempaquetar algunos archivos utilizando la opción `--unpack`, +a continuación un ejemplo que excluye las librerías compartidas de los módulos nativos: + +```bash +$ asar pack app app.asar --unpack *.node +``` + +Después de ejecutar este comando, además del archivo `app.asar`, también se creará +un directorio `app.asar.unpacked`, que contendrá los archivos desempaquetados. +Este directorio deberá copiarse junto con el archivo `app.asar` a la hora de distribuir la aplicación. + +[asar]: https://github.com/atom/asar diff --git a/docs/tutorial/debugging-main-process-es.md b/docs/tutorial/debugging-main-process-es.md new file mode 100644 index 000000000000..1a764036e37a --- /dev/null +++ b/docs/tutorial/debugging-main-process-es.md @@ -0,0 +1,45 @@ +# Depurando el proceso principal + +Los devtools sólo pueden depurar las páginas web (el código del proceso renderer). +Para depurar el código del proceso principal, Electron provee dos opciones para la línea de comandos: `--debug` y `--debug-brk`. + +## Opciones para la línea de comandos + +### `--debug=[port]` + +Esta opción escuchará mensajes del protocolo de depuración V8 en `port`, por defecto `port` es `5858`. + +### `--debug-brk=[port]` + +Similar a `--debug` pero realiza una pausa en la primera línea del script. + +## Utilizando node-inspector para depuración + +__Nota:__ Electron utiliza node v0.11.13, esta versión aún no funciona bien con node-inspector, +el proceso principal podría fallar al inspeccionar el objeto `process`. + +### 1. Iniciar [node-inspector][node-inspector] + +```bash +$ node-inspector +``` + +### 2. Activar el modo de depuración en Electron + +Es posible iniciar Electron con la opción de depuración: + +```bash +$ electron --debug=5858 your/app +``` + +o, pausar el script en la primera línea: + +```bash +$ electron --debug-brk=5858 your/app +``` + +### 3. Cargar la interfaz del depurador + +Abre http://127.0.0.1:8080/debug?ws=127.0.0.1:8080&port=5858 en Chrome. + +[node-inspector]: https://github.com/node-inspector/node-inspector diff --git a/docs/tutorial/desktop-environment-integration-es.md b/docs/tutorial/desktop-environment-integration-es.md new file mode 100644 index 000000000000..f19f36326f3e --- /dev/null +++ b/docs/tutorial/desktop-environment-integration-es.md @@ -0,0 +1,171 @@ +# Integración con el entorno de escritorio + +Los sistemas operativos proveen diferentes características para integrar aplicaciones +en sus entornos de escritorio. Por ejemplo, en Windows, las aplicaciones pueden agregar accesos directos +en la JumpList de la barra de tareas, y en Mac, las aplicaciones pueden agregar un menú personalizado en el dock. + +Esta guía explica cómo integrar tu aplicación en esos entornos de escritorio a través de las APIs de Electron. + +## Documentos recientes (Windows y OS X) + +Windows y OS X proveen un acceso sencillo a la lista de documentos recientes. + +__JumpList:__ + +![JumpList, Archivos recientes](http://i.msdn.microsoft.com/dynimg/IC420538.png) + +__Menú Dock:__ + + + +Para agregar un archivo a la lista de documentos recientes, puedes utilizar: +[app.addRecentDocument][addrecentdocument] API: + +```javascript +var app = require('app'); +app.addRecentDocument('/Users/USERNAME/Desktop/work.type'); +``` + +También puedes utilizar [app.clearRecentDocuments](clearrecentdocuments) para vaciar la lista de documentos recientes: + +```javascript +app.clearRecentDocuments(); +``` + +### Notas sobre Windows + +Para activar esta característica en Windows, tu aplicación debe registrar un handler +para el tipo de archivo que quieres utilizar, de lo contrario el archivo no aparecerá +en la JumpList, aún después de agregarlo. Puedes encontrar más información sobre el proceso de +registrar tu aplicación en [Application Registration][app-registration]. + +Cuando un usuario haga click en un archivo de la JumpList, una nueva instancia de tu aplicación +se iniciará, la ruta del archivo se agregará como un argumento de la línea de comandos. + +### Notas sobre OS X + +Cuando un archivo es solicitado desde el menú de documentos recientes, el evento `open-file` +del módulo `app` será emitido. + +## Menú dock personalizado (OS X) + +OS X permite a los desarrolladores definir un menú personalizado para el dock, +el cual usualmente contiene algunos accesos directos a las características más comunes +de tu aplicación: + +__Menú dock de Terminal.app:__ + + + +Para establecer tu menú dock, puedes utilizar la API `app.dock.setMenu`, la cual sólo está disponible para OSX: + +```javascript +var app = require('app'); +var Menu = require('menu'); +var dockMenu = Menu.buildFromTemplate([ + { label: 'New Window', click: function() { console.log('New Window'); } }, + { label: 'New Window with Settings', submenu: [ + { label: 'Basic' }, + { label: 'Pro'} + ]}, + { label: 'New Command...'} +]); +app.dock.setMenu(dockMenu); +``` + +## Tareas de usuario (Windows) + +En Windows puedes especificar acciones personalizadas en la categoría `Tasks` del JumpList, +tal como menciona MSDN: + + +> Las aplicaciones definen tareas basadas en las características del programa +> y las acciones clave que se esperan de un usuario. Las tareas deben ser +> libres de contexto, es decir, la aplicación no debe encontrarse en ejecución +> para que estas acciones funcionen. También deberían ser las acciones estadísticamente +> más comunes que un usuario normal realizaría en tu aplicación, como por ejemplo, +> redactar un mensaje de correo electrónico, crear un documento en el procesador de textos, +> ejecutar una aplicación en cierto modo, o ejecutar alguno de sus subcomandos. Una aplicación +> no debería popular el menú con características avanzadas que el usuario estándar no necesita +> ni con acciones que sólo se realizan una vez, como por ejemplo, el registro. No utilices +> las tareas para mostrar elementos promocionales como actualizaciones u ofertas especiales. +> +> Es recomendable que la lista de tareas sea estática. Debe mantenerse a pesar +> de los cambios de estado de la aplicación. Aunque exista la posibilidad de variar +> el contenido de la lista dinámicamente, debes considerar que podría ser confuso +> para un usuario que no espera que el destino de la lista cambie. + +__Tareas de Internet Explorer:__ + +![IE](http://i.msdn.microsoft.com/dynimg/IC420539.png) + +A diferencia del menú dock en OS X, el cual es un menú real, las tareas de usuario en Windows +funcionan como accesos directos de aplicación, que al ser clickeados, lanzan el programa +con argumentos específicos. + +Para establecer las tareas de usuario en tu aplicación, puedes utilizar: +[app.setUserTasks][setusertaskstasks] API: + +```javascript +var app = require('app'); +app.setUserTasks([ + { + program: process.execPath, + arguments: '--new-window', + iconPath: process.execPath, + iconIndex: 0, + title: 'New Window', + description: 'Create a new window' + } +]); +``` + +Para purgar la lista de tareas, puedes llamar a `app.setUserTasks` con un array vacío: + +```javascript +app.setUserTasks([]); +``` + +Las tareas de usuario aún serán visibles después de cerrar tu aplicación, por lo cual +el ícono y la ruta del programa deben existir hasta que la aplicación sea desinstalada. + +## Accesos directos en el lanzador Unity (Linux) + +En Unity, es posible agregar algunas entradas personalizadas, modificando el archivo `.desktop`, +ver [Adding shortcuts to a launcher][unity-launcher]. + +__Accesos directos de Audacious:__ + +![audacious](https://help.ubuntu.com/community/UnityLaunchersAndDesktopFiles?action=AttachFile&do=get&target=shortcuts.png) + +## Barra de progreso en la barra de tareas (Windows y Unity) + +En Windows, un botón en la barra de tareas puede utilizarse para mostrar una barra de progreso. Esto permite +que una ventana muestre la información de progreso al usuario, sin que el usuario tenga la ventana de la aplicación activa. + +El entorno de escritorio Unity también posee una característica similar que permite mostrar una barra de progreso en el lanzador. + +__Barra de progreso en un botón de la barra de herramientas:__ + +![Taskbar Progress Bar](https://cloud.githubusercontent.com/assets/639601/5081682/16691fda-6f0e-11e4-9676-49b6418f1264.png) + +__Barra de progreso en el lanzador Unity:__ + +![Unity Launcher](https://cloud.githubusercontent.com/assets/639601/5081747/4a0a589e-6f0f-11e4-803f-91594716a546.png) + +Para establecer la barra de progreso de una ventana, puedes utilizar +[BrowserWindow.setProgressBar][setprogressbar] API: + +```javascript +var window = new BrowserWindow({...}); +window.setProgressBar(0.5); +``` + +[addrecentdocument]: ../api/app.md#appaddrecentdocumentpath +[clearrecentdocuments]: ../api/app.md#appclearrecentdocuments +[setusertaskstasks]: ../api/app.md#appsetusertaskstasks +[setprogressbar]: ../api/browser-window.md#browserwindowsetprogressbarprogress +[setrepresentedfilename]: ../api/browser-window.md#browserwindowsetrepresentedfilenamefilename +[setdocumentedited]: ../api/browser-window.md#browserwindowsetdocumenteditededited +[app-registration]: http://msdn.microsoft.com/en-us/library/windows/desktop/ee872121(v=vs.85).aspx +[unity-launcher]: https://help.ubuntu.com/community/UnityLaunchersAndDesktopFiles#Adding_shortcuts_to_a_launcher diff --git a/docs/tutorial/devtools-extension-es.md b/docs/tutorial/devtools-extension-es.md new file mode 100644 index 000000000000..f54c3e0eaa83 --- /dev/null +++ b/docs/tutorial/devtools-extension-es.md @@ -0,0 +1,49 @@ +# Extensión DevTools + +Para facilitar la depuración, Electron provee un soporte básico para la extensión +[Chrome DevTools Extension][devtools-extension]. + +Para la mayoría de las extensiones devtools, simplemente puedes descargar el código fuente +y utilizar `BrowserWindow.addDevToolsExtension` para cargarlas, las extensiones cargadas +serán recordadas para que no sea necesario llamar a la función cada vez que creas una ventana. + +Por ejemplo, para usar la extensión [React DevTools Extension](https://github.com/facebook/react-devtools), primero debes descargar el código fuente: + +```bash +$ cd /some-directory +$ git clone --recursive https://github.com/facebook/react-devtools.git +``` + +Luego cargas la aplicación en Electron, abriendo devtools en cualquier ventana, +y ejecutando este código en la consola devtools: + +```javascript +require('remote').require('browser-window').addDevToolsExtension('/some-directory/react-devtools'); +``` + +Para remover una extensión, puedes utilizar `BrowserWindow.removeDevToolsExtension` +especificando el nombre, y esta ya no se cargará la siguiente vez que abras devtools: + +```javascript +require('remote').require('browser-window').removeDevToolsExtension('React Developer Tools'); +``` + +## Formato de las extensiones devtools + +Idealmente todas las extensiones devtools escritas para Chrome pueden ser cargadas por Electron, +pero para ello deben estar en un directorio plano, las extensiones empaquetadas como `crx` +no pueden ser cargadas por Chrome a no ser que halles una forma de extraerlas a un directorio. + +## Páginas en segundo plano (background) + +Electron no soporta la característica de páginas en segundo plano de las extensiones de Chrome, +las extensiones que utilizan esta característica podrían no funcionar. + +## APIs `chrome.*` + +Algunas extensiones utilizan las APIs `chrome.*`, hemos realizado un esfuerzo +para implementar esas APIs en Electron, sin embargo no han sido implementadas en su totalidad. + +Dado que no todas las funciones `chrome.*` han sido implementadas, si la extensión devtools está utilizando otras APIs más allá de `chrome.devtools.*`, es muy probable que no funcione. Puedes reportar fallos en el issue tracker para que podamos agregar soporte a esas APIs. + +[devtools-extension]: https://developer.chrome.com/extensions/devtools diff --git a/docs/tutorial/online-offline-events-es.md b/docs/tutorial/online-offline-events-es.md new file mode 100644 index 000000000000..0e43f9b16109 --- /dev/null +++ b/docs/tutorial/online-offline-events-es.md @@ -0,0 +1,80 @@ +# Detección del evento en línea/fuera de línea + +La detección de estos eventos puede ser implementada en el proceso renderer utilizando las APIs HTML5 estándar, +como en este ejemplo: + +_main.js_ + +```javascript +var app = require('app'); +var BrowserWindow = require('browser-window'); +var onlineStatusWindow; + +app.on('ready', function() { + onlineStatusWindow = new BrowserWindow({ width: 0, height: 0, show: false }); + onlineStatusWindow.loadUrl('file://' + __dirname + '/online-status.html'); +}); +``` + +_online-status.html_ + +```html + + + + + + +``` + +Existen casos en donde necesitas responder a estos eventos desde el proceso principal. +El proceso principal no posee un objeto `navigator`, por lo tanto no puede detectar estos eventos directamente. +Es posible reenviar el evento al proceso principal mediante la utilidad de intercomunicación entre procesos (ipc): + +_main.js_ + +```javascript +var app = require('app'); +var ipc = require('ipc'); +var BrowserWindow = require('browser-window'); +var onlineStatusWindow; + +app.on('ready', function() { + onlineStatusWindow = new BrowserWindow({ width: 0, height: 0, show: false }); + onlineStatusWindow.loadUrl('file://' + __dirname + '/online-status.html'); +}); + +ipc.on('online-status-changed', function(event, status) { + console.log(status); +}); +``` + +_online-status.html_ + +```html + + + + + + +``` diff --git a/docs/tutorial/quick-start-es.md b/docs/tutorial/quick-start-es.md new file mode 100644 index 000000000000..5c3095deb3ef --- /dev/null +++ b/docs/tutorial/quick-start-es.md @@ -0,0 +1,154 @@ +# Intro + +## Introducción + +Electron permite la creación de aplicaciones de escritorio utilizando JavaScript puro, a través de un runtime con APIs nativas. Puedes verlo como una variante de io.js, enfocado en aplicaciones de escritorio, en vez de servidores web. + +Esto no significa que Electron sea un binding de librerías GUI para JavaScript. +Electron utiliza páginas web como su GUI, por lo cual puedes verlo como un navegador Chromium mínimo, +controlado por JavaScript. + +### El proceso principal (main process) + +En Electron, el proceso que ejecuta el script `main` del `package.json` se llama __el proceso principal__. +El script que corre en el proceso principal puede crear páginas para mostrar la GUI. + +### El proceso renderer (renderer process) + +Dado que Electron utiliza Chromium para mostrar las páginas web, +también es utilizada la arquitectura multiproceso de Chromium. +Cada página web en Electron se ejecuta en su propio proceso, +el cual es llamado __el proceso renderer__. + +En los navegadores normales, las páginas web usualmente se ejecutan en un entorno +sandbox y no tienen acceso a los recursos nativos. Los usuarios de Electron tienen el poder +de utilizar las APIs de io.js en las páginas web, permitiendo interacciones de bajo nivel con el sistema operativo. + +### Diferencias entre el proceso principal y el proceso renderer + +El proceso principal crea páginas web mediante instancias de `BrowserWindow`. Cada instancia de `BrowserWindow` ejecuta su propia página web y su propio proceso renderer. +Cuando una instancia de `BrowserWindow` es destruida, también su proceso renderer correspondiente acaba. + +El proceso principal gestiona las páginas web y sus correspondientes procesos renderer. +Cada proceso renderer es aislado y sólo considera relevante la página web que corre en él. + +En las páginas web, no está permitido llamar a APIs relacionadas a la GUI nativa +porque la gestión de los recursos GUI nativos es peligrosa, y tiende a que ocurran leaks de memoria. +Si deseas realizar operaciones GUI en una página web, el proceso renderer de la página web debe comunicarse +con el proceso principal, y solicitar a este que realice esas operaciones. + +En Electron, hemos proveído el módulo [ipc](../api/ipc-renderer.md) para la comunicación +entre el proceso principal y el proceso renderer. Y también hay un módulo [remote](../api/remote.md) +para comunicación al estilo RPC. + +## Escribe tu primera aplicación Electron + +Generalmente, una aplicación Electron tendrá la siguiente estructura: + +```text +your-app/ +├── package.json +├── main.js +└── index.html +``` + +El formato de `package.json` es exactamente el mismo que cualquier módulo Node, +y el script especificado en el campo `main` será el script de arranque de tu aplicación, +a ser ejecutado por el proceso principal. Un ejemplo de `package.json` podría verse así: + +```json +{ + "name" : "your-app", + "version" : "0.1.0", + "main" : "main.js" +} +``` + +El `main.js` debería crear las ventanas y gestionar los eventos del sistema, un ejemplo típico sería: +example being: + +```javascript +var app = require('app'); // Módulo para controlar el ciclo de vida de la aplicación. +var BrowserWindow = require('browser-window'); // Módulo para crear uan ventana de navegador. + +// Reportar crashes a nuestro servidor. +require('crash-reporter').start(); + +// Mantener una referencia global al objeto window, si no lo haces, esta ventana +// se cerrará automáticamente cuando el objeto JavaScript sea recolectado (garbage collected): +var mainWindow = null; + +// Salir de todas las ventanas cuando se cierren. +app.on('window-all-closed', function() { + // En OS X es común que las aplicaciones y su barra de menú + // se mantengan activas hasta que el usuario cierre la aplicación + // explícitamente utilizando Cmd + Q + if (process.platform != 'darwin') { + app.quit(); + } +}); + +// Este método será llamado cuando Electron haya finalizado la inicialización +// y esté listo para crear ventanas de navegador. +app.on('ready', function() { + // Crear la ventana. + mainWindow = new BrowserWindow({width: 800, height: 600}); + + // cargar el index.html de nuestra aplicación. + mainWindow.loadUrl('file://' + __dirname + '/index.html'); + + // Desplegar devtools. + mainWindow.openDevTools(); + + // Evento emitido cuando se cierra la ventana. + mainWindow.on('closed', function() { + // Eliminar la referencia del objeto window. + // En el caso de soportar multiples ventanas, es usual almacenar + // los objetos window en un array, este es el momento en el que debes eliminar el elemento correspondiente. + mainWindow = null; + }); +}); +``` + +Finalmente el `index.html` es la página web que mostraremos: + +```html + + + + Hello World! + + +

Hello World!

+ We are using io.js + and Electron . + + +``` + +## Ejecutar la aplicación + +Cuando termines de escribir tu aplicación, puedes distribuirla +siguiendo la [guía de distribución](./application-distribution-es.md) +y luego ejecutar la aplicación empaquetada. También puedes utilizar el binario de Electron +para ejecutar tu aplicación de forma directa. + +En Windows: + +```bash +$ .\electron\electron.exe your-app\ +``` + +En Linux: + +```bash +$ ./electron/electron your-app/ +``` + +En OS X: + +```bash +$ ./Electron.app/Contents/MacOS/Electron your-app/ +``` + +`Electron.app` es parte del paquete de release de Electron, puedes descargarlo [aquí](https://github.com/atom/electron/releases). diff --git a/docs/tutorial/using-native-node-modules-es.md b/docs/tutorial/using-native-node-modules-es.md new file mode 100644 index 000000000000..78409049ad93 --- /dev/null +++ b/docs/tutorial/using-native-node-modules-es.md @@ -0,0 +1,57 @@ +# Utilizando módulos Node nativos + +Los módulos Node nativos son soportados por Electron, pero dado que Electron +está utilizando una versión distinta de V8, debes especificar manualmente la +ubicación de las cabeceras de Electron a la hora de compilar módulos nativos. + +## Compatibilidad de módulos nativos + +A partir de Node v0.11.x han habido cambios vitales en la API de V8. +Es de esperar que los módulos escritos para Node v0.10.x no funcionen con Node v0.11.x. +Electron utiliza Node v.0.11.13 internamente, y por este motivo tiene el mismo problema. + +Para resolver esto, debes usar módulos que soporten Node v0.11.x, +[muchos módulos](https://www.npmjs.org/browse/depended/nan) soportan ambas versiones. +En el caso de los módulos antiguos que sólo soportan Node v0.10.x, debes usar el módulo +[nan](https://github.com/rvagg/nan) para portarlos a v0.11.x. + +## ¿Cómo instalar módulos nativos? + +### La forma fácil + +La forma más sencilla de recompilar módulos nativos es a través del paquete +[`electron-rebuild`](https://github.com/paulcbetts/electron-rebuild), +el cual abstrae y maneja los pasos de descargar las cabeceras y compilar los módulos nativos: + +```sh +npm install --save-dev electron-rebuild + +# Ejecuta esto cada vez que ejecutes npm install +./node_modules/.bin/electron-rebuild +``` + +### La forma node-gyp + +Para compilar módulos Node con las cabeceras de Electron, debes indicar a `node-gyp` +desde dónde descargar las cabeceras y cuál versión usar: + +```bash +$ cd /path-to-module/ +$ HOME=~/.electron-gyp node-gyp rebuild --target=0.29.1 --arch=x64 --dist-url=https://atom.io/download/atom-shell +``` + +Los cambios en `HOME=~/.electron-gyp` fueron para especificar la ruta de las cabeceras. +La opción `--target=0.29.1` es la versión de Electron. La opción `--dist-url=...` especifica +dónde descargar las cabeceras. `--arch=x64` indica que el módulo será compilado para un sistema de 64bit. + +### La forma npm + +También puedes usar `npm` para instalar módulos, los pasos son exactamente igual a otros módulos Node, +con la excepción de que necesitas establecer algunas variables de entorno primero: + +```bash +export npm_config_disturl=https://atom.io/download/atom-shell +export npm_config_target=0.29.1 +export npm_config_arch=x64 +HOME=~/.electron-gyp npm install module-name +``` diff --git a/docs/tutorial/using-pepper-flash-plugin-es.md b/docs/tutorial/using-pepper-flash-plugin-es.md new file mode 100644 index 000000000000..fbb2b6f83aa0 --- /dev/null +++ b/docs/tutorial/using-pepper-flash-plugin-es.md @@ -0,0 +1,58 @@ +# Utilizando el plugin Pepper Flash + +El plugin Pepper Flash es soportado ahora. Para utilizar pepper flash en Electron, debes especificar la ubicación del plugin manualmente y activarlo en tu aplicación. + +## Preparar una copia del plugin Flash + +En OSX y Linux, el detalle del plugin puede encontrarse accediendo a `chrome://plugins` en el navegador. Su ubicación y versión son útiles para el soporte. También puedes copiarlo a otro lugar. + +## Agrega la opción a Electron + +Puedes agregar la opción `--ppapi-flash-path` y `ppapi-flash-version` o utilizar el método `app.commandLine.appendSwitch` antes del evento ready de la aplicación. +También puedes agregar la opción `plugins` de `browser-window`. Por ejemplo, + +```javascript +var app = require('app'); +var BrowserWindow = require('browser-window'); + +// Report crashes to our server. +require('crash-reporter').start(); + +// Keep a global reference of the window object, if you don't, the window will +// be closed automatically when the javascript object is GCed. +var mainWindow = null; + +// Quit when all windows are closed. +app.on('window-all-closed', function() { + if (process.platform != 'darwin') { + app.quit(); + } +}); + +// Specify flash path. +// On Windows, it might be /path/to/pepflashplayer.dll +// On Mac, /path/to/PepperFlashPlayer.plugin +// On Linux, /path/to/libpepflashplayer.so +app.commandLine.appendSwitch('ppapi-flash-path', '/path/to/libpepflashplayer.so'); + +// Specify flash version, for example, v17.0.0.169 +app.commandLine.appendSwitch('ppapi-flash-version', '17.0.0.169'); + +app.on('ready', function() { + mainWindow = new BrowserWindow({ + 'width': 800, + 'height': 600, + 'web-preferences': { + 'plugins': true + } + }); + mainWindow.loadUrl('file://' + __dirname + '/index.html'); + // Something else +}); +``` + +## Activar el plugin flash en una etiqueta `` +Agrega el atributo `plugins`. +```html + +``` diff --git a/docs/tutorial/using-selenium-and-webdriver-es.md b/docs/tutorial/using-selenium-and-webdriver-es.md new file mode 100644 index 000000000000..7d9989057056 --- /dev/null +++ b/docs/tutorial/using-selenium-and-webdriver-es.md @@ -0,0 +1,72 @@ +# Utilizando Selenium y WebDriver + +De [ChromeDriver - WebDriver for Chrome][chrome-driver]: + +> WebDriver es una herramienta de código abierto para automatizar el testing de aplicaciones web +> en varios navegadores. WebDriver provee funciones de navegación, entrada de usuario, +> ejecución de JavaScript, y más. ChromeDriver es un servidor standalone que implementa +> el protocolo de WebDriver para Chromium. Se encuentra en desarrollo por los miembros de +> Chromium y WebDriver. + +En la página de [lanzamientos](https://github.com/atom/electron/releases) de Electron encontrarás paquetes de `chromedriver`. + +## Ajustando parámetros con WebDriverJs + +[WebDriverJs](https://code.google.com/p/selenium/wiki/WebDriverJs) provee +un paquete Node para realizar testing con web driver, lo usaremos como ejemplo. + +### 1. Inicia chrome driver + +Primero necesitas descargar el binario `chromedriver` y ejecutarlo: + +```bash +$ ./chromedriver +Starting ChromeDriver (v2.10.291558) on port 9515 +Only local connections are allowed. +``` + +Recuerda el puerto `9515`, lo utilizaremos después. + +### 2. Instala WebDriverJS + +```bash +$ npm install selenium-webdriver +``` + +### 3. Conecta chrome driver + +El uso de `selenium-webdriver` junto con Electron es básicamente el mismo que el original, +excepto que necesitas especificar manualmente cómo se conectará el chrome driver +y dónde encontrará el binario de Electron: + +```javascript +var webdriver = require('selenium-webdriver'); + +var driver = new webdriver.Builder() + // El puerto "9515" es que abre chrome driver. + .usingServer('http://localhost:9515') + .withCapabilities({chromeOptions: { + // Aquí especificamos la ruta a Electron + binary: '/Path-to-Your-App.app/Contents/MacOS/Atom'}}) + .forBrowser('electron') + .build(); + +driver.get('http://www.google.com'); +driver.findElement(webdriver.By.name('q')).sendKeys('webdriver'); +driver.findElement(webdriver.By.name('btnG')).click(); +driver.wait(function() { + return driver.getTitle().then(function(title) { + return title === 'webdriver - Google Search'; + }); +}, 1000); + +driver.quit(); +``` + +## Workflow + +Para probar tu aplicación sin recompilar Electron, simplemente [copia](https://github.com/atom/electron/blob/master/docs/tutorial/application-distribution.md) las fuentes de tu aplicación en el directorio de recursos de Electron. + +[chrome-driver]: https://sites.google.com/a/chromium.org/chromedriver/ + + From ad7e4a77db83a1790a2d3e92e3b1541560f99355 Mon Sep 17 00:00:00 2001 From: Matias Insaurralde Date: Sun, 26 Jul 2015 22:59:19 -0400 Subject: [PATCH 0707/1293] custom dom texts --- docs/README-es.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/README-es.md b/docs/README-es.md index 991c80b069f3..a278de95bd43 100644 --- a/docs/README-es.md +++ b/docs/README-es.md @@ -22,9 +22,9 @@ Elementos DOM customizados: -* [`File` object](api/file-object.md) -* [`` tag](api/web-view-tag.md) -* [`window.open` function](api/window-open.md) +* [Objeto `File`](api/file-object.md) +* [Etiqueta ``](api/web-view-tag.md) +* [Función `window.open`](api/window-open.md) Módulos del proceso principal: From 9211109088cce2855a27f7a921abe5eb45d567c2 Mon Sep 17 00:00:00 2001 From: Nishanth Shanmugham Date: Sun, 26 Jul 2015 21:58:48 -0700 Subject: [PATCH 0708/1293] Add NativeImage.IsTemplateImage method * Rename internal function that determines template image filename patterns * Add the new IsTemplateMethod --- atom/common/api/atom_api_native_image.cc | 7 +++++-- atom/common/api/atom_api_native_image.h | 2 ++ atom/common/api/atom_api_native_image_mac.mm | 4 ++++ 3 files changed, 11 insertions(+), 2 deletions(-) diff --git a/atom/common/api/atom_api_native_image.cc b/atom/common/api/atom_api_native_image.cc index bd66ad511f75..af173dda3e9a 100644 --- a/atom/common/api/atom_api_native_image.cc +++ b/atom/common/api/atom_api_native_image.cc @@ -113,7 +113,7 @@ bool PopulateImageSkiaRepsFromPath(gfx::ImageSkia* image, } #if defined(OS_MACOSX) -bool IsTemplateImage(const base::FilePath& path) { +bool IsTemplateFilename(const base::FilePath& path) { return (MatchPattern(path.value(), "*Template.*") || MatchPattern(path.value(), "*Template@*x.*")); } @@ -139,6 +139,7 @@ mate::ObjectTemplateBuilder NativeImage::GetObjectTemplateBuilder( .SetMethod("isEmpty", &NativeImage::IsEmpty) .SetMethod("getSize", &NativeImage::GetSize) .SetMethod("setTemplateImage", &NativeImage::SetTemplateImage) + .SetMethod("isTemplateImage", &NativeImage::IsTemplateImage) .Build()); return mate::ObjectTemplateBuilder( @@ -180,6 +181,8 @@ gfx::Size NativeImage::GetSize() { #if !defined(OS_MACOSX) void NativeImage::SetTemplateImage(bool setAsTemplate) { } +bool NativeImage::IsTemplateImage() { +} #endif // static @@ -217,7 +220,7 @@ mate::Handle NativeImage::CreateFromPath( gfx::Image image(image_skia); mate::Handle handle = Create(isolate, image); #if defined(OS_MACOSX) - if (IsTemplateImage(path)) + if (IsTemplateFilename(path)) handle->SetTemplateImage(true); #endif return handle; diff --git a/atom/common/api/atom_api_native_image.h b/atom/common/api/atom_api_native_image.h index 8cb43d06e152..1f0fe946ba51 100644 --- a/atom/common/api/atom_api_native_image.h +++ b/atom/common/api/atom_api_native_image.h @@ -67,6 +67,8 @@ class NativeImage : public mate::Wrappable { // Mark the image as template image. void SetTemplateImage(bool setAsTemplate); + // Determine if the image is a template image. + bool IsTemplateImage(); gfx::Image image_; diff --git a/atom/common/api/atom_api_native_image_mac.mm b/atom/common/api/atom_api_native_image_mac.mm index a80462766bc2..a9e5225b815d 100644 --- a/atom/common/api/atom_api_native_image_mac.mm +++ b/atom/common/api/atom_api_native_image_mac.mm @@ -14,6 +14,10 @@ void NativeImage::SetTemplateImage(bool setAsTemplate) { [image_.AsNSImage() setTemplate:setAsTemplate]; } +bool NativeImage::IsTemplateImage() { + return [image_.AsNSImage() isTemplate]; +} + } // namespace api } // namespace atom From 51111430b3ca75a2616108ae876f0457d626c613 Mon Sep 17 00:00:00 2001 From: Nishanth Shanmugham Date: Sun, 26 Jul 2015 21:59:43 -0700 Subject: [PATCH 0709/1293] Add NativeImage docs for IsTemplateImage --- docs/api/native-image.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/api/native-image.md b/docs/api/native-image.md index ed12819d26c4..5c6bf11659c5 100644 --- a/docs/api/native-image.md +++ b/docs/api/native-image.md @@ -132,6 +132,10 @@ Returns the size of the image. [buffer]: https://iojs.org/api/buffer.html#buffer_class_buffer +### NativeImage.isTemplateImage() + +Returns whether the image is a template image. + ### NativeImage.setTemplateImage(option) * `option` Boolean From 99a8f29de9db1c415a0352d669e6177afb1c4421 Mon Sep 17 00:00:00 2001 From: Nishanth Shanmugham Date: Mon, 27 Jul 2015 00:41:20 -0700 Subject: [PATCH 0710/1293] Move event type functions to a common event_util file --- atom/browser/ui/cocoa/atom_menu_controller.mm | 50 +------------------ atom/browser/ui/event_util.h | 17 +++++++ atom/browser/ui/event_util_mac.mm | 47 +++++++++++++++++ filenames.gypi | 2 + 4 files changed, 68 insertions(+), 48 deletions(-) create mode 100644 atom/browser/ui/event_util.h create mode 100644 atom/browser/ui/event_util_mac.mm diff --git a/atom/browser/ui/cocoa/atom_menu_controller.mm b/atom/browser/ui/cocoa/atom_menu_controller.mm index 176f2db7e145..fbfaea94110f 100644 --- a/atom/browser/ui/cocoa/atom_menu_controller.mm +++ b/atom/browser/ui/cocoa/atom_menu_controller.mm @@ -4,6 +4,7 @@ // found in the LICENSE file. #import "atom/browser/ui/cocoa/atom_menu_controller.h" +#import "atom/browser/ui/event_util.h" #include "base/logging.h" #include "base/strings/sys_string_conversions.h" @@ -13,53 +14,6 @@ #include "ui/base/models/simple_menu_model.h" #include "ui/gfx/image/image.h" -namespace { - -bool isLeftButtonEvent(NSEvent* event) { - NSEventType type = [event type]; - return type == NSLeftMouseDown || - type == NSLeftMouseDragged || - type == NSLeftMouseUp; -} - -bool isRightButtonEvent(NSEvent* event) { - NSEventType type = [event type]; - return type == NSRightMouseDown || - type == NSRightMouseDragged || - type == NSRightMouseUp; -} - -bool isMiddleButtonEvent(NSEvent* event) { - if ([event buttonNumber] != 2) - return false; - - NSEventType type = [event type]; - return type == NSOtherMouseDown || - type == NSOtherMouseDragged || - type == NSOtherMouseUp; -} - -int EventFlagsFromNSEventWithModifiers(NSEvent* event, NSUInteger modifiers) { - int flags = 0; - flags |= (modifiers & NSAlphaShiftKeyMask) ? ui::EF_CAPS_LOCK_DOWN : 0; - flags |= (modifiers & NSShiftKeyMask) ? ui::EF_SHIFT_DOWN : 0; - flags |= (modifiers & NSControlKeyMask) ? ui::EF_CONTROL_DOWN : 0; - flags |= (modifiers & NSAlternateKeyMask) ? ui::EF_ALT_DOWN : 0; - flags |= (modifiers & NSCommandKeyMask) ? ui::EF_COMMAND_DOWN : 0; - flags |= isLeftButtonEvent(event) ? ui::EF_LEFT_MOUSE_BUTTON : 0; - flags |= isRightButtonEvent(event) ? ui::EF_RIGHT_MOUSE_BUTTON : 0; - flags |= isMiddleButtonEvent(event) ? ui::EF_MIDDLE_MOUSE_BUTTON : 0; - return flags; -} - -// Retrieves a bitsum of ui::EventFlags from NSEvent. -int EventFlagsFromNSEvent(NSEvent* event) { - NSUInteger modifiers = [event modifierFlags]; - return EventFlagsFromNSEventWithModifiers(event, modifiers); -} - -} // namespace - @interface AtomMenuController (Private) - (void)addSeparatorToMenu:(NSMenu*)menu atIndex:(int)index; @@ -246,7 +200,7 @@ int EventFlagsFromNSEvent(NSEvent* event) { [[sender representedObject] pointerValue]); DCHECK(model); if (model) { - int event_flags = EventFlagsFromNSEvent([NSApp currentEvent]); + int event_flags = event_util::EventFlagsFromNSEvent([NSApp currentEvent]); model->ActivatedAt(modelIndex, event_flags); } } diff --git a/atom/browser/ui/event_util.h b/atom/browser/ui/event_util.h new file mode 100644 index 000000000000..59a624d6bf96 --- /dev/null +++ b/atom/browser/ui/event_util.h @@ -0,0 +1,17 @@ +#ifndef ATOM_BROWSER_UI_EVENT_UTIL_H_ +#define ATOM_BROWSER_UI_EVENT_UTIL_H_ + +#import + +namespace event_util { + +bool isLeftButtonEvent(NSEvent* event); +bool isRightButtonEvent(NSEvent* event); +bool isMiddleButtonEvent(NSEvent* event); + +// Retrieves a bitsum of ui::EventFlags from NSEvent. +int EventFlagsFromNSEvent(NSEvent* event); + +} // namespace event_util + +#endif // ATOM_BROWSER_UI_EVENT_UTIL_H_ diff --git a/atom/browser/ui/event_util_mac.mm b/atom/browser/ui/event_util_mac.mm new file mode 100644 index 000000000000..5226b155b74e --- /dev/null +++ b/atom/browser/ui/event_util_mac.mm @@ -0,0 +1,47 @@ +#include "atom/browser/ui/event_util.h" +#include "ui/base/accelerators/accelerator.h" + +namespace event_util { + bool isLeftButtonEvent(NSEvent* event) { + NSEventType type = [event type]; + return type == NSLeftMouseDown || + type == NSLeftMouseDragged || + type == NSLeftMouseUp; + } + + bool isRightButtonEvent(NSEvent* event) { + NSEventType type = [event type]; + return type == NSRightMouseDown || + type == NSRightMouseDragged || + type == NSRightMouseUp; + } + + bool isMiddleButtonEvent(NSEvent* event) { + if ([event buttonNumber] != 2) + return false; + + NSEventType type = [event type]; + return type == NSOtherMouseDown || + type == NSOtherMouseDragged || + type == NSOtherMouseUp; + } + + int EventFlagsFromNSEventWithModifiers(NSEvent* event, NSUInteger modifiers) { + int flags = 0; + flags |= (modifiers & NSAlphaShiftKeyMask) ? ui::EF_CAPS_LOCK_DOWN : 0; + flags |= (modifiers & NSShiftKeyMask) ? ui::EF_SHIFT_DOWN : 0; + flags |= (modifiers & NSControlKeyMask) ? ui::EF_CONTROL_DOWN : 0; + flags |= (modifiers & NSAlternateKeyMask) ? ui::EF_ALT_DOWN : 0; + flags |= (modifiers & NSCommandKeyMask) ? ui::EF_COMMAND_DOWN : 0; + flags |= isLeftButtonEvent(event) ? ui::EF_LEFT_MOUSE_BUTTON : 0; + flags |= isRightButtonEvent(event) ? ui::EF_RIGHT_MOUSE_BUTTON : 0; + flags |= isMiddleButtonEvent(event) ? ui::EF_MIDDLE_MOUSE_BUTTON : 0; + return flags; + } + + // Retrieves a bitsum of ui::EventFlags from NSEvent. + int EventFlagsFromNSEvent(NSEvent* event) { + NSUInteger modifiers = [event modifierFlags]; + return EventFlagsFromNSEventWithModifiers(event, modifiers); + } +} // namespace event_util diff --git a/filenames.gypi b/filenames.gypi index ed51fc8fb47b..7d756e3beb7d 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -170,6 +170,8 @@ 'atom/browser/ui/cocoa/atom_menu_controller.mm', 'atom/browser/ui/cocoa/event_processing_window.h', 'atom/browser/ui/cocoa/event_processing_window.mm', + 'atom/browser/ui/event_util.h', + 'atom/browser/ui/event_util_mac.mm', 'atom/browser/ui/file_dialog.h', 'atom/browser/ui/file_dialog_gtk.cc', 'atom/browser/ui/file_dialog_mac.mm', From 74b45221950b03bbdcee1dbe84a604db33d415f6 Mon Sep 17 00:00:00 2001 From: Nishanth Shanmugham Date: Mon, 27 Jul 2015 03:15:51 -0700 Subject: [PATCH 0711/1293] Add keyboard modifiers payload to tray click events * Add keyboard and mouse button bitsum to Tray click events payload * Move getBoundsFromRect: to common event_util file * Update documentation --- atom/browser/api/atom_api_tray.cc | 12 +++++------ atom/browser/api/atom_api_tray.h | 6 +++--- atom/browser/ui/event_util.h | 9 +++++--- atom/browser/ui/event_util_mac.mm | 32 ++++++++++++++++++++++------ atom/browser/ui/tray_icon.cc | 15 +++++++------ atom/browser/ui/tray_icon.h | 7 +++--- atom/browser/ui/tray_icon_cocoa.mm | 20 ++++++++--------- atom/browser/ui/tray_icon_observer.h | 6 +++--- docs/api/tray.md | 5 ++++- 9 files changed, 70 insertions(+), 42 deletions(-) diff --git a/atom/browser/api/atom_api_tray.cc b/atom/browser/api/atom_api_tray.cc index 82b2d01c613b..a849c03f59a0 100644 --- a/atom/browser/api/atom_api_tray.cc +++ b/atom/browser/api/atom_api_tray.cc @@ -40,12 +40,12 @@ mate::Wrappable* Tray::New(v8::Isolate* isolate, const gfx::Image& image) { return new Tray(image); } -void Tray::OnClicked(const gfx::Rect& bounds) { - Emit("clicked", bounds); +void Tray::OnClicked(const gfx::Rect& bounds, int modifiers) { + Emit("clicked", bounds, modifiers); } -void Tray::OnDoubleClicked(const gfx::Rect& bounds) { - Emit("double-clicked", bounds); +void Tray::OnDoubleClicked(const gfx::Rect& bounds, int modifiers) { + Emit("double-clicked", bounds, modifiers); } void Tray::OnBalloonShow() { @@ -60,8 +60,8 @@ void Tray::OnBalloonClosed() { Emit("balloon-closed"); } -void Tray::OnRightClicked(const gfx::Rect& bounds) { - Emit("right-clicked", bounds); +void Tray::OnRightClicked(const gfx::Rect& bounds, int modifiers) { + Emit("right-clicked", bounds, modifiers); } void Tray::OnDropFiles(const std::vector& files) { diff --git a/atom/browser/api/atom_api_tray.h b/atom/browser/api/atom_api_tray.h index f3b91f00c0f0..10340677813f 100644 --- a/atom/browser/api/atom_api_tray.h +++ b/atom/browser/api/atom_api_tray.h @@ -42,12 +42,12 @@ class Tray : public mate::EventEmitter, virtual ~Tray(); // TrayIconObserver: - void OnClicked(const gfx::Rect& bounds) override; - void OnDoubleClicked(const gfx::Rect& bounds) override; + void OnClicked(const gfx::Rect& bounds, int modifiers) override; + void OnDoubleClicked(const gfx::Rect& bounds, int modifiers) override; void OnBalloonShow() override; void OnBalloonClicked() override; void OnBalloonClosed() override; - void OnRightClicked(const gfx::Rect& bounds) override; + void OnRightClicked(const gfx::Rect& bounds, int modifiers) override; void OnDropFiles(const std::vector& files) override; // mate::Wrappable: diff --git a/atom/browser/ui/event_util.h b/atom/browser/ui/event_util.h index 59a624d6bf96..b7278edaee82 100644 --- a/atom/browser/ui/event_util.h +++ b/atom/browser/ui/event_util.h @@ -2,16 +2,19 @@ #define ATOM_BROWSER_UI_EVENT_UTIL_H_ #import +#include "ui/gfx/geometry/rect.h" namespace event_util { -bool isLeftButtonEvent(NSEvent* event); -bool isRightButtonEvent(NSEvent* event); -bool isMiddleButtonEvent(NSEvent* event); +bool IsLeftButtonEvent(NSEvent* event); +bool IsRightButtonEvent(NSEvent* event); +bool IsMiddleButtonEvent(NSEvent* event); // Retrieves a bitsum of ui::EventFlags from NSEvent. int EventFlagsFromNSEvent(NSEvent* event); +gfx::Rect GetBoundsFromEvent(NSEvent* event); + } // namespace event_util #endif // ATOM_BROWSER_UI_EVENT_UTIL_H_ diff --git a/atom/browser/ui/event_util_mac.mm b/atom/browser/ui/event_util_mac.mm index 5226b155b74e..13188fdcf823 100644 --- a/atom/browser/ui/event_util_mac.mm +++ b/atom/browser/ui/event_util_mac.mm @@ -1,22 +1,24 @@ #include "atom/browser/ui/event_util.h" -#include "ui/base/accelerators/accelerator.h" + +#include "ui/events/event_constants.h" namespace event_util { - bool isLeftButtonEvent(NSEvent* event) { + + bool IsLeftButtonEvent(NSEvent* event) { NSEventType type = [event type]; return type == NSLeftMouseDown || type == NSLeftMouseDragged || type == NSLeftMouseUp; } - bool isRightButtonEvent(NSEvent* event) { + bool IsRightButtonEvent(NSEvent* event) { NSEventType type = [event type]; return type == NSRightMouseDown || type == NSRightMouseDragged || type == NSRightMouseUp; } - bool isMiddleButtonEvent(NSEvent* event) { + bool IsMiddleButtonEvent(NSEvent* event) { if ([event buttonNumber] != 2) return false; @@ -33,9 +35,9 @@ namespace event_util { flags |= (modifiers & NSControlKeyMask) ? ui::EF_CONTROL_DOWN : 0; flags |= (modifiers & NSAlternateKeyMask) ? ui::EF_ALT_DOWN : 0; flags |= (modifiers & NSCommandKeyMask) ? ui::EF_COMMAND_DOWN : 0; - flags |= isLeftButtonEvent(event) ? ui::EF_LEFT_MOUSE_BUTTON : 0; - flags |= isRightButtonEvent(event) ? ui::EF_RIGHT_MOUSE_BUTTON : 0; - flags |= isMiddleButtonEvent(event) ? ui::EF_MIDDLE_MOUSE_BUTTON : 0; + flags |= IsLeftButtonEvent(event) ? ui::EF_LEFT_MOUSE_BUTTON : 0; + flags |= IsRightButtonEvent(event) ? ui::EF_RIGHT_MOUSE_BUTTON : 0; + flags |= IsMiddleButtonEvent(event) ? ui::EF_MIDDLE_MOUSE_BUTTON : 0; return flags; } @@ -44,4 +46,20 @@ namespace event_util { NSUInteger modifiers = [event modifierFlags]; return EventFlagsFromNSEventWithModifiers(event, modifiers); } + + gfx::Rect GetBoundsFromEvent(NSEvent* event) { + NSRect frame = event.window.frame; + + gfx::Rect bounds( + frame.origin.x, + 0, + NSWidth(frame), + NSHeight(frame) + ); + + NSScreen* screen = [[NSScreen screens] objectAtIndex:0]; + bounds.set_y(NSHeight([screen frame]) - NSMaxY(frame)); + return bounds; + } + } // namespace event_util diff --git a/atom/browser/ui/tray_icon.cc b/atom/browser/ui/tray_icon.cc index b22250d35c8f..d706d81868eb 100644 --- a/atom/browser/ui/tray_icon.cc +++ b/atom/browser/ui/tray_icon.cc @@ -29,12 +29,14 @@ void TrayIcon::DisplayBalloon(const gfx::Image& icon, void TrayIcon::PopContextMenu(const gfx::Point& pos) { } -void TrayIcon::NotifyClicked(const gfx::Rect& bounds) { - FOR_EACH_OBSERVER(TrayIconObserver, observers_, OnClicked(bounds)); +void TrayIcon::NotifyClicked(const gfx::Rect& bounds, int modifiers) { + FOR_EACH_OBSERVER(TrayIconObserver, observers_, + OnClicked(bounds, modifiers)); } -void TrayIcon::NotifyDoubleClicked(const gfx::Rect& bounds) { - FOR_EACH_OBSERVER(TrayIconObserver, observers_, OnDoubleClicked(bounds)); +void TrayIcon::NotifyDoubleClicked(const gfx::Rect& bounds, int modifiers) { + FOR_EACH_OBSERVER(TrayIconObserver, observers_, + OnDoubleClicked(bounds, modifiers)); } void TrayIcon::NotifyBalloonShow() { @@ -49,8 +51,9 @@ void TrayIcon::NotifyBalloonClosed() { FOR_EACH_OBSERVER(TrayIconObserver, observers_, OnBalloonClosed()); } -void TrayIcon::NotifyRightClicked(const gfx::Rect& bounds) { - FOR_EACH_OBSERVER(TrayIconObserver, observers_, OnRightClicked(bounds)); +void TrayIcon::NotifyRightClicked(const gfx::Rect& bounds, int modifiers) { + FOR_EACH_OBSERVER(TrayIconObserver, observers_, + OnRightClicked(bounds, modifiers)); } void TrayIcon::NotfiyDropFiles(const std::vector& files) { diff --git a/atom/browser/ui/tray_icon.h b/atom/browser/ui/tray_icon.h index 5e362806f5d6..a60622db9505 100644 --- a/atom/browser/ui/tray_icon.h +++ b/atom/browser/ui/tray_icon.h @@ -54,12 +54,13 @@ class TrayIcon { void AddObserver(TrayIconObserver* obs) { observers_.AddObserver(obs); } void RemoveObserver(TrayIconObserver* obs) { observers_.RemoveObserver(obs); } - void NotifyClicked(const gfx::Rect& = gfx::Rect()); - void NotifyDoubleClicked(const gfx::Rect& = gfx::Rect()); + void NotifyClicked(const gfx::Rect& = gfx::Rect(), int modifiers = 0); + void NotifyDoubleClicked(const gfx::Rect& = gfx::Rect(), int modifiers = 0); void NotifyBalloonShow(); void NotifyBalloonClicked(); void NotifyBalloonClosed(); - void NotifyRightClicked(const gfx::Rect& bounds = gfx::Rect()); + void NotifyRightClicked(const gfx::Rect& bounds = gfx::Rect(), + int modifiers = 0); void NotfiyDropFiles(const std::vector& files); protected: diff --git a/atom/browser/ui/tray_icon_cocoa.mm b/atom/browser/ui/tray_icon_cocoa.mm index 59386ff8eb41..3329619c99a7 100644 --- a/atom/browser/ui/tray_icon_cocoa.mm +++ b/atom/browser/ui/tray_icon_cocoa.mm @@ -5,6 +5,7 @@ #include "atom/browser/ui/tray_icon_cocoa.h" #include "atom/browser/ui/cocoa/atom_menu_controller.h" +#include "atom/browser/ui/event_util.h" #include "base/strings/sys_string_conversions.h" #include "ui/gfx/image/image.h" #include "ui/gfx/screen.h" @@ -147,16 +148,21 @@ const CGFloat kMargin = 3; return; } inMouseEventSequence_ = NO; + + // Single click if (event.clickCount == 1) { if (menuController_) { [statusItem_ popUpStatusItemMenu:[menuController_ menu]]; } - trayIcon_->NotifyClicked([self getBoundsFromEvent:event]); + trayIcon_->NotifyClicked(event_util::GetBoundsFromEvent(event), + event_util::EventFlagsFromNSEvent(event)); } + // Double click if (event.clickCount == 2 && !menuController_) { - trayIcon_->NotifyDoubleClicked([self getBoundsFromEvent:event]); + trayIcon_->NotifyDoubleClicked(event_util::GetBoundsFromEvent(event), + event_util::EventFlagsFromNSEvent(event)); } [self setNeedsDisplay:YES]; } @@ -173,7 +179,8 @@ const CGFloat kMargin = 3; } - (void)rightMouseUp:(NSEvent*)event { - trayIcon_->NotifyRightClicked([self getBoundsFromEvent:event]); + trayIcon_->NotifyRightClicked(event_util::GetBoundsFromEvent(event), + event_util::EventFlagsFromNSEvent(event)); } - (NSDragOperation)draggingEntered:(id )sender { @@ -199,13 +206,6 @@ const CGFloat kMargin = 3; return isHighlightEnable_ && (inMouseEventSequence_ || is_menu_open); } -- (gfx::Rect)getBoundsFromEvent:(NSEvent*)event { - NSRect frame = event.window.frame; - gfx::Rect bounds(frame.origin.x, 0, NSWidth(frame), NSHeight(frame)); - NSScreen* screen = [[NSScreen screens] objectAtIndex:0]; - bounds.set_y(NSHeight([screen frame]) - NSMaxY(frame)); - return bounds; -} @end namespace atom { diff --git a/atom/browser/ui/tray_icon_observer.h b/atom/browser/ui/tray_icon_observer.h index 474c6a771934..fa8090d7d6c5 100644 --- a/atom/browser/ui/tray_icon_observer.h +++ b/atom/browser/ui/tray_icon_observer.h @@ -16,12 +16,12 @@ namespace atom { class TrayIconObserver { public: - virtual void OnClicked(const gfx::Rect& bounds) {} - virtual void OnDoubleClicked(const gfx::Rect& bounds) {} + virtual void OnClicked(const gfx::Rect& bounds, int modifiers) {} + virtual void OnDoubleClicked(const gfx::Rect& bounds, int modifiers) {} virtual void OnBalloonShow() {} virtual void OnBalloonClicked() {} virtual void OnBalloonClosed() {} - virtual void OnRightClicked(const gfx::Rect& bounds) {} + virtual void OnRightClicked(const gfx::Rect& bounds, int modifiers) {} virtual void OnDropFiles(const std::vector& files) {} protected: diff --git a/docs/api/tray.md b/docs/api/tray.md index 9332822a32a8..e35a43587331 100644 --- a/docs/api/tray.md +++ b/docs/api/tray.md @@ -53,6 +53,7 @@ Creates a new tray icon associated with the `image`. * `y` Integer * `width` Integer * `height` Integer +* [`modifiers`](https://code.google.com/p/chromium/codesearch#chromium/src/ui/events/event_constants.h&l=77) number - bitsum of keyboard modifiers and mouse keys Emitted when the tray icon is clicked. @@ -66,6 +67,7 @@ __Note:__ The `bounds` payload is only implemented on OS X and Windows 7 or newe * `y` Integer * `width` Integer * `height` Integer +* [`modifiers`](https://code.google.com/p/chromium/codesearch#chromium/src/ui/events/event_constants.h&l=77) number - bitsum of keyboard modifiers and mouse keys Emitted when the tray icon is right clicked. @@ -82,7 +84,8 @@ Emitted when the tray icon is double clicked. * `y` Integer * `width` Integer * `height` Integer - +* [`modifiers`](https://code.google.com/p/chromium/codesearch#chromium/src/ui/events/event_constants.h&l=77) number - bitsum of keyboard modifiers and mouse keys + __Note:__ This is only implemented on OS X. ### Event: 'balloon-show' From a44f14d76ef8d0444f4375f3773fecd36ad1c20c Mon Sep 17 00:00:00 2001 From: Nishanth Shanmugham Date: Mon, 27 Jul 2015 03:33:15 -0700 Subject: [PATCH 0712/1293] Fix code formatting issues --- atom/browser/ui/event_util.h | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/atom/browser/ui/event_util.h b/atom/browser/ui/event_util.h index b7278edaee82..b5f9e7224d70 100644 --- a/atom/browser/ui/event_util.h +++ b/atom/browser/ui/event_util.h @@ -1,3 +1,7 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + #ifndef ATOM_BROWSER_UI_EVENT_UTIL_H_ #define ATOM_BROWSER_UI_EVENT_UTIL_H_ @@ -15,6 +19,6 @@ int EventFlagsFromNSEvent(NSEvent* event); gfx::Rect GetBoundsFromEvent(NSEvent* event); -} // namespace event_util +} // namespace event_util -#endif // ATOM_BROWSER_UI_EVENT_UTIL_H_ +#endif // ATOM_BROWSER_UI_EVENT_UTIL_H_ From 617bff8ec85b4717316d0fe8e258868e4f9f6e05 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Tue, 28 Jul 2015 10:30:36 +0800 Subject: [PATCH 0713/1293] Fix a missing the specified mime type check in accept attribute. --- atom/browser/web_dialog_helper.cc | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/atom/browser/web_dialog_helper.cc b/atom/browser/web_dialog_helper.cc index 93cb32cba7c7..a37d357d47dc 100644 --- a/atom/browser/web_dialog_helper.cc +++ b/atom/browser/web_dialog_helper.cc @@ -43,14 +43,15 @@ file_dialog::Filters GetFileTypesFromAcceptType( // Skip the first character. extensions.push_back(extension.substr(1)); } else { - if (ascii_type == "image/*" || ascii_type == "audio/*" || - ascii_type == "video/*") { - // For MIME Type - net::GetExtensionsForMimeType(ascii_type, &extensions); - } + // For MIME Type, `audio/*, vidio/*, image/* + net::GetExtensionsForMimeType(ascii_type, &extensions); } } + // If no valid exntesion is added, return empty filters. + if (extensions.empty()) + return filters; + filters.push_back(file_dialog::Filter()); for (const auto& extension : extensions) { #if defined(OS_WIN) From b10560a5b09cf6558d884f64b8d9fd218d4d9913 Mon Sep 17 00:00:00 2001 From: Jeffrey Morgan Date: Tue, 28 Jul 2015 16:51:41 +0100 Subject: [PATCH 0714/1293] Fix typo in auto-updater.md --- docs/api/auto-updater.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/auto-updater.md b/docs/api/auto-updater.md index a14e3ecd91f0..5274fc6c467e 100644 --- a/docs/api/auto-updater.md +++ b/docs/api/auto-updater.md @@ -107,7 +107,7 @@ Emitted when there is an error while updating. ## Event: checking-for-update -Emitted when checking for an update has started. +Emitted when checking if an update has started. ## Event: update-available From 11589a7bde78bc69b9548a1cb700a0a9933916a5 Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Wed, 29 Jul 2015 02:21:32 +0900 Subject: [PATCH 0715/1293] Update as upstream --- docs/api/web-view-tag-ko.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/web-view-tag-ko.md b/docs/api/web-view-tag-ko.md index e6b3d6c99f5c..9054d1824823 100644 --- a/docs/api/web-view-tag-ko.md +++ b/docs/api/web-view-tag-ko.md @@ -130,10 +130,10 @@ If "on", the guest page will have web security disabled. ## API -The webview element must be loaded before using the methods. +The webview element must be loaded before using the methods. **Example** ```javascript -webview.addEventListener("dom-ready", function(){ +webview.addEventListener("dom-ready", function() { webview.openDevTools(); }); ``` From b08af8947384f101ee8587bbae166d57ab439961 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 29 Jul 2015 11:22:12 +0800 Subject: [PATCH 0716/1293] Style fix for #2328 --- atom/browser/ui/win/notify_icon.cc | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/atom/browser/ui/win/notify_icon.cc b/atom/browser/ui/win/notify_icon.cc index 6cf207d7b8e1..450fd0814044 100644 --- a/atom/browser/ui/win/notify_icon.cc +++ b/atom/browser/ui/win/notify_icon.cc @@ -28,20 +28,18 @@ NotifyIcon::NotifyIcon(NotifyIconHost* host, icon_id_(id), window_(window), message_id_(message), - menu_model_(NULL) { - + menu_model_(NULL), + has_tray_app_id_hash_(false) { // NB: If we have an App Model ID, we should propagate that to the tray. // Doing this prevents duplicate items from showing up in the notification // preferences (i.e. "Always Show / Show notifications only / etc") PWSTR explicit_app_id; - if (SUCCEEDED(GetCurrentProcessExplicitAppUserModelID(&explicit_app_id))) { // GUIDs and MD5 hashes are the same length. So convenient! base::MD5Sum(explicit_app_id, - sizeof(wchar_t) * wcslen(explicit_app_id), - (base::MD5Digest*)&tray_app_id_hash_); + sizeof(wchar_t) * wcslen(explicit_app_id), + reinterpret_cast(&tray_app_id_hash_)); has_tray_app_id_hash_ = true; - CoTaskMemFree(explicit_app_id); } @@ -184,8 +182,8 @@ void NotifyIcon::InitIconData(NOTIFYICONDATA* icon_data) { if (has_tray_app_id_hash_) { icon_data->uFlags |= NIF_GUID; memcpy(reinterpret_cast(&icon_data->guidItem), - &tray_app_id_hash_, - sizeof(GUID)); + &tray_app_id_hash_, + sizeof(GUID)); } } From 42ce91323c429d4f99eba5b44261e966f00a856c Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 29 Jul 2015 11:28:20 +0800 Subject: [PATCH 0717/1293] docs: Small style fix for #2337 --- docs/api/tray.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/api/tray.md b/docs/api/tray.md index 9332822a32a8..dcb88dd4f75a 100644 --- a/docs/api/tray.md +++ b/docs/api/tray.md @@ -74,15 +74,15 @@ will be emitted if the tray icon has context menu. ### Event: 'double-clicked' -Emitted when the tray icon is double clicked. - * `event` * `bounds` Object - the bounds of tray icon * `x` Integer * `y` Integer * `width` Integer * `height` Integer - + +Emitted when the tray icon is double clicked. + __Note:__ This is only implemented on OS X. ### Event: 'balloon-show' From 2c97cd64cf31b0284b0cf8731e063f118f9c8240 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 29 Jul 2015 11:48:40 +0800 Subject: [PATCH 0718/1293] Minor style fix for #2352 --- atom/common/api/atom_api_native_image.cc | 1 + atom/common/api/atom_api_native_image_mac.mm | 2 +- docs/api/native-image.md | 8 ++++---- 3 files changed, 6 insertions(+), 5 deletions(-) diff --git a/atom/common/api/atom_api_native_image.cc b/atom/common/api/atom_api_native_image.cc index af173dda3e9a..ee9bb71a4d21 100644 --- a/atom/common/api/atom_api_native_image.cc +++ b/atom/common/api/atom_api_native_image.cc @@ -181,6 +181,7 @@ gfx::Size NativeImage::GetSize() { #if !defined(OS_MACOSX) void NativeImage::SetTemplateImage(bool setAsTemplate) { } + bool NativeImage::IsTemplateImage() { } #endif diff --git a/atom/common/api/atom_api_native_image_mac.mm b/atom/common/api/atom_api_native_image_mac.mm index a9e5225b815d..ad72d4b14924 100644 --- a/atom/common/api/atom_api_native_image_mac.mm +++ b/atom/common/api/atom_api_native_image_mac.mm @@ -15,7 +15,7 @@ void NativeImage::SetTemplateImage(bool setAsTemplate) { } bool NativeImage::IsTemplateImage() { - return [image_.AsNSImage() isTemplate]; + return [image_.AsNSImage() isTemplate]; } } // namespace api diff --git a/docs/api/native-image.md b/docs/api/native-image.md index 5c6bf11659c5..aa2326da64e2 100644 --- a/docs/api/native-image.md +++ b/docs/api/native-image.md @@ -132,12 +132,12 @@ Returns the size of the image. [buffer]: https://iojs.org/api/buffer.html#buffer_class_buffer -### NativeImage.isTemplateImage() - -Returns whether the image is a template image. - ### NativeImage.setTemplateImage(option) * `option` Boolean Marks the image as template image. + +### NativeImage.isTemplateImage() + +Returns whether the image is a template image. From 66553eea1ab39fd454b4ee3ca0c4cbdf24fa9c15 Mon Sep 17 00:00:00 2001 From: Robo Date: Fri, 24 Jul 2015 15:09:11 +0530 Subject: [PATCH 0719/1293] webContents: api to add/remove path from devtools workspace --- atom/browser/api/atom_api_web_contents.cc | 19 +++++++++++ atom/browser/api/atom_api_web_contents.h | 8 +++-- atom/browser/common_web_contents_delegate.cc | 33 +++++++++++--------- atom/browser/common_web_contents_delegate.h | 5 +-- docs/api/browser-window.md | 12 +++++++ 5 files changed, 59 insertions(+), 18 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index b79338548063..7070b7d6ebab 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -14,6 +14,7 @@ #include "atom/browser/web_view_guest_delegate.h" #include "atom/common/api/api_messages.h" #include "atom/common/event_emitter_caller.h" +#include "atom/common/native_mate_converters/file_path_converter.h" #include "atom/common/native_mate_converters/gfx_converter.h" #include "atom/common/native_mate_converters/gurl_converter.h" #include "atom/common/native_mate_converters/image_converter.h" @@ -689,6 +690,22 @@ void WebContents::PrintToPDF(const base::DictionaryValue& setting, PrintToPDF(setting, callback); } +void WebContents::AddWorkSpace(const base::FilePath& path) { + if (path.empty()) { + node::ThrowError(isolate(), "path cannot be empty"); + return; + } + DevToolsAddFileSystem(path); +} + +void WebContents::RemoveWorkSpace(const base::FilePath& path) { + if (path.empty()) { + node::ThrowError(isolate(), "path cannot be empty"); + return; + } + DevToolsRemoveFileSystem(path); +} + void WebContents::Undo() { web_contents()->Undo(); } @@ -812,6 +829,8 @@ mate::ObjectTemplateBuilder WebContents::GetObjectTemplateBuilder( .SetMethod("inspectServiceWorker", &WebContents::InspectServiceWorker) .SetMethod("print", &WebContents::Print) .SetMethod("_printToPDF", &WebContents::PrintToPDF) + .SetMethod("addWorkSpace", &WebContents::AddWorkSpace) + .SetMethod("removeWorkSpace", &WebContents::RemoveWorkSpace) .SetProperty("session", &WebContents::Session) .Build()); diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index 1dcf5f4f6d29..68e0ad310529 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -37,8 +37,8 @@ class WebContents : public mate::TrackableObject, public content::WebContentsObserver { public: // For node.js callback function type: function(error, buffer) - typedef base::Callback, v8::Local)> - PrintToPDFCallback; + using PrintToPDFCallback = + base::Callback, v8::Local)>; // Create from an existing WebContents. static mate::Handle CreateFrom( @@ -83,6 +83,10 @@ class WebContents : public mate::TrackableObject, void PrintToPDF(const base::DictionaryValue& setting, const PrintToPDFCallback& callback); + // DevTools workspace api. + void AddWorkSpace(const base::FilePath& path); + void RemoveWorkSpace(const base::FilePath& path); + // Editing commands. void Undo(); void Redo(); diff --git a/atom/browser/common_web_contents_delegate.cc b/atom/browser/common_web_contents_delegate.cc index af429929812a..3cef7c6d68cc 100644 --- a/atom/browser/common_web_contents_delegate.cc +++ b/atom/browser/common_web_contents_delegate.cc @@ -274,16 +274,21 @@ void CommonWebContentsDelegate::DevToolsAppendToFile( base::Unretained(this), url)); } -void CommonWebContentsDelegate::DevToolsAddFileSystem() { - file_dialog::Filters filters; - base::FilePath default_path; - std::vector paths; - int flag = file_dialog::FILE_DIALOG_OPEN_DIRECTORY; - if (!file_dialog::ShowOpenDialog(owner_window(), "", default_path, - filters, flag, &paths)) - return; +void CommonWebContentsDelegate::DevToolsAddFileSystem( + const base::FilePath& file_system_path) { + base::FilePath path = file_system_path; + if (path.empty()) { + file_dialog::Filters filters; + base::FilePath default_path; + std::vector paths; + int flag = file_dialog::FILE_DIALOG_OPEN_DIRECTORY; + if (!file_dialog::ShowOpenDialog(owner_window(), "", default_path, + filters, flag, &paths)) + return; + + path = paths[0]; + } - base::FilePath path = paths[0]; std::string registered_name; std::string file_system_id = RegisterFileSystem(GetDevToolsWebContents(), path, @@ -313,20 +318,20 @@ void CommonWebContentsDelegate::DevToolsAddFileSystem() { } void CommonWebContentsDelegate::DevToolsRemoveFileSystem( - const std::string& file_system_path) { + const base::FilePath& file_system_path) { if (!web_contents_) return; - base::FilePath path = base::FilePath::FromUTF8Unsafe(file_system_path); - storage::IsolatedContext::GetInstance()->RevokeFileSystemByPath(path); + storage::IsolatedContext::GetInstance()-> + RevokeFileSystemByPath(file_system_path); for (auto it = saved_paths_.begin(); it != saved_paths_.end(); ++it) - if (it->second == path) { + if (it->second == file_system_path) { saved_paths_.erase(it); break; } - base::StringValue file_system_path_value(file_system_path); + base::StringValue file_system_path_value(file_system_path.AsUTF8Unsafe()); web_contents_->CallClientFunction( "DevToolsAPI.fileSystemRemoved", &file_system_path_value, diff --git a/atom/browser/common_web_contents_delegate.h b/atom/browser/common_web_contents_delegate.h index 8c87548951b2..e21cd24e9107 100644 --- a/atom/browser/common_web_contents_delegate.h +++ b/atom/browser/common_web_contents_delegate.h @@ -80,8 +80,9 @@ class CommonWebContentsDelegate bool save_as) override; void DevToolsAppendToFile(const std::string& url, const std::string& content) override; - void DevToolsAddFileSystem() override; - void DevToolsRemoveFileSystem(const std::string& file_system_path) override; + void DevToolsAddFileSystem(const base::FilePath& path) override; + void DevToolsRemoveFileSystem( + const base::FilePath& file_system_path) override; private: // Callback for when DevToolsSaveToFile has completed. diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index cee68183f783..cb4941daaa7f 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -1042,6 +1042,18 @@ win.webContents.on("did-finish-load", function() { }); ``` +### WebContents.addWorkSpace(path) + +* `path` String + +Adds the specified path to devtools workspace. + +### WebContents.removeWorkSpace(path) + +* `path` String + +Removes the specified path from devtools workspace. + ### WebContents.send(channel[, args...]) * `channel` String From 9afa94f4b8a9f9ebe6ac3851f638bcfbd71ddc2e Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 29 Jul 2015 12:36:01 +0800 Subject: [PATCH 0720/1293] win: Implement double-clicked event --- atom/browser/ui/win/notify_icon.cc | 15 +++++++++------ atom/browser/ui/win/notify_icon.h | 4 +++- atom/browser/ui/win/notify_icon_host.cc | 7 ++++++- atom/common/api/atom_api_native_image.cc | 1 + 4 files changed, 19 insertions(+), 8 deletions(-) diff --git a/atom/browser/ui/win/notify_icon.cc b/atom/browser/ui/win/notify_icon.cc index 450fd0814044..ed422b882a8f 100644 --- a/atom/browser/ui/win/notify_icon.cc +++ b/atom/browser/ui/win/notify_icon.cc @@ -63,7 +63,8 @@ NotifyIcon::~NotifyIcon() { } void NotifyIcon::HandleClickEvent(const gfx::Point& cursor_pos, - bool left_mouse_click) { + bool left_mouse_click, + bool double_button_click) { NOTIFYICONIDENTIFIER icon_id; memset(&icon_id, 0, sizeof(NOTIFYICONIDENTIFIER)); icon_id.uID = icon_id_; @@ -72,14 +73,16 @@ void NotifyIcon::HandleClickEvent(const gfx::Point& cursor_pos, RECT rect = { 0 }; Shell_NotifyIconGetRect(&icon_id, &rect); - // Pass to the observer if appropriate. if (left_mouse_click) { - NotifyClicked(gfx::Rect(rect)); + if (double_button_click) // double left click + NotifyDoubleClicked(gfx::Rect(rect)); + else // single left click + NotifyClicked(gfx::Rect(rect)); return; + } else if (!double_button_click) { // single right click + NotifyRightClicked(gfx::Rect(rect)); + PopContextMenu(cursor_pos); } - - NotifyRightClicked(gfx::Rect(rect)); - PopContextMenu(cursor_pos); } void NotifyIcon::ResetIcon() { diff --git a/atom/browser/ui/win/notify_icon.h b/atom/browser/ui/win/notify_icon.h index 25ba8c8dc439..c004d5f39405 100644 --- a/atom/browser/ui/win/notify_icon.h +++ b/atom/browser/ui/win/notify_icon.h @@ -33,7 +33,9 @@ class NotifyIcon : public TrayIcon { // Handles a click event from the user - if |left_button_click| is true and // there is a registered observer, passes the click event to the observer, // otherwise displays the context menu if there is one. - void HandleClickEvent(const gfx::Point& cursor_pos, bool left_button_click); + void HandleClickEvent(const gfx::Point& cursor_pos, + bool left_button_click, + bool double_button_click); // Re-creates the status tray icon now after the taskbar has been created. void ResetIcon(); diff --git a/atom/browser/ui/win/notify_icon_host.cc b/atom/browser/ui/win/notify_icon_host.cc index 4aac629f248a..33ac722a5377 100644 --- a/atom/browser/ui/win/notify_icon_host.cc +++ b/atom/browser/ui/win/notify_icon_host.cc @@ -146,12 +146,17 @@ LRESULT CALLBACK NotifyIconHost::WndProc(HWND hwnd, case WM_LBUTTONDOWN: case WM_RBUTTONDOWN: + case WM_LBUTTONDBLCLK: + case WM_RBUTTONDBLCLK: case WM_CONTEXTMENU: // Walk our icons, find which one was clicked on, and invoke its // HandleClickEvent() method. gfx::Point cursor_pos( gfx::Screen::GetNativeScreen()->GetCursorScreenPoint()); - win_icon->HandleClickEvent(cursor_pos, lparam == WM_LBUTTONDOWN); + win_icon->HandleClickEvent( + cursor_pos, + (lparam == WM_LBUTTONDOWN || lparam == WM_LBUTTONDBLCLK), + (lparam == WM_LBUTTONDBLCLK || lparam == WM_RBUTTONDBLCLK)); return TRUE; } } diff --git a/atom/common/api/atom_api_native_image.cc b/atom/common/api/atom_api_native_image.cc index ee9bb71a4d21..7819e314178c 100644 --- a/atom/common/api/atom_api_native_image.cc +++ b/atom/common/api/atom_api_native_image.cc @@ -183,6 +183,7 @@ void NativeImage::SetTemplateImage(bool setAsTemplate) { } bool NativeImage::IsTemplateImage() { + return false; } #endif From fc92ceb0b6cc7a56e8a3d3ff40fcad56ba4a81e0 Mon Sep 17 00:00:00 2001 From: Taichiro Yoshida Date: Wed, 29 Jul 2015 13:41:11 +0900 Subject: [PATCH 0721/1293] do not overwrite `node-integration` option If `node-integration` option pass to window.open, do not overwrite by current window's one --- atom/renderer/lib/override.coffee | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/atom/renderer/lib/override.coffee b/atom/renderer/lib/override.coffee index 85914b116fd6..aea7feb3cbfe 100644 --- a/atom/renderer/lib/override.coffee +++ b/atom/renderer/lib/override.coffee @@ -61,7 +61,7 @@ window.open = (url, frameName='', features='') -> (options[name] = parseInt(options[name], 10) if options[name]?) for name in ints # Inherit the node-integration option of current window. - unless options['node-integration'] + unless options['node-integration']? for arg in process.argv when arg.indexOf('--node-integration=') is 0 options['node-integration'] = arg.substr(-4) is 'true' break From 15273c1f7ac10af886ade2e103fb83d12f4f4d9f Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 29 Jul 2015 12:41:40 +0800 Subject: [PATCH 0722/1293] docs: Don't say things that are expected --- docs/api/tray.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/api/tray.md b/docs/api/tray.md index 47b5d7e3fed6..935430b7feaa 100644 --- a/docs/api/tray.md +++ b/docs/api/tray.md @@ -71,8 +71,7 @@ __Note:__ The `bounds` payload is only implemented on OS X and Windows 7 or newe Emitted when the tray icon is right clicked. -__Note:__ This is only implemented on OS X and Windows. On Windows, this event -will be emitted if the tray icon has context menu. +__Note:__ This is only implemented on OS X and Windows. ### Event: 'double-clicked' @@ -86,7 +85,7 @@ will be emitted if the tray icon has context menu. Emitted when the tray icon is double clicked. -__Note:__ This is only implemented on OS X. +__Note:__ This is only implemented on OS X and Windows. ### Event: 'balloon-show' @@ -171,9 +170,10 @@ __Note:__ This is only implemented on Windows. * `x` Integer * `y` Integer -__Note:__ This is only implemented on OS X and Windows. The `position` is only available on Windows, and it is (0, 0) by default. +__Note:__ This is only implemented on OS X and Windows. + ### Tray.setContextMenu(menu) * `menu` Menu From 74248253f591ca20b42a154bf39225f747a0fd3a Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 29 Jul 2015 12:55:44 +0800 Subject: [PATCH 0723/1293] win: Set GUID when getting icon's bounds --- atom/browser/ui/win/notify_icon.cc | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/atom/browser/ui/win/notify_icon.cc b/atom/browser/ui/win/notify_icon.cc index ed422b882a8f..b58b5931276c 100644 --- a/atom/browser/ui/win/notify_icon.cc +++ b/atom/browser/ui/win/notify_icon.cc @@ -70,6 +70,11 @@ void NotifyIcon::HandleClickEvent(const gfx::Point& cursor_pos, icon_id.uID = icon_id_; icon_id.hWnd = window_; icon_id.cbSize = sizeof(NOTIFYICONIDENTIFIER); + if (has_tray_app_id_hash_) + memcpy(reinterpret_cast(&icon_id.guidItem), + &tray_app_id_hash_, + sizeof(GUID)); + RECT rect = { 0 }; Shell_NotifyIconGetRect(&icon_id, &rect); From d42fd6fc7ee307d6a463c4f52e7acf9e78f54a3d Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 29 Jul 2015 13:10:51 +0800 Subject: [PATCH 0724/1293] win: Pass modifers in 'clicked' events --- atom/browser/ui/win/notify_icon.cc | 7 ++++--- atom/browser/ui/win/notify_icon.h | 1 + atom/browser/ui/win/notify_icon_host.cc | 14 ++++++++++++++ 3 files changed, 19 insertions(+), 3 deletions(-) diff --git a/atom/browser/ui/win/notify_icon.cc b/atom/browser/ui/win/notify_icon.cc index b58b5931276c..fd9a90ae1d5d 100644 --- a/atom/browser/ui/win/notify_icon.cc +++ b/atom/browser/ui/win/notify_icon.cc @@ -63,6 +63,7 @@ NotifyIcon::~NotifyIcon() { } void NotifyIcon::HandleClickEvent(const gfx::Point& cursor_pos, + int modifiers, bool left_mouse_click, bool double_button_click) { NOTIFYICONIDENTIFIER icon_id; @@ -80,12 +81,12 @@ void NotifyIcon::HandleClickEvent(const gfx::Point& cursor_pos, if (left_mouse_click) { if (double_button_click) // double left click - NotifyDoubleClicked(gfx::Rect(rect)); + NotifyDoubleClicked(gfx::Rect(rect), modifiers); else // single left click - NotifyClicked(gfx::Rect(rect)); + NotifyClicked(gfx::Rect(rect), modifiers); return; } else if (!double_button_click) { // single right click - NotifyRightClicked(gfx::Rect(rect)); + NotifyRightClicked(gfx::Rect(rect), modifiers); PopContextMenu(cursor_pos); } } diff --git a/atom/browser/ui/win/notify_icon.h b/atom/browser/ui/win/notify_icon.h index c004d5f39405..a28a00ff0d6a 100644 --- a/atom/browser/ui/win/notify_icon.h +++ b/atom/browser/ui/win/notify_icon.h @@ -34,6 +34,7 @@ class NotifyIcon : public TrayIcon { // there is a registered observer, passes the click event to the observer, // otherwise displays the context menu if there is one. void HandleClickEvent(const gfx::Point& cursor_pos, + int modifiers, bool left_button_click, bool double_button_click); diff --git a/atom/browser/ui/win/notify_icon_host.cc b/atom/browser/ui/win/notify_icon_host.cc index 33ac722a5377..c34e14375e76 100644 --- a/atom/browser/ui/win/notify_icon_host.cc +++ b/atom/browser/ui/win/notify_icon_host.cc @@ -11,7 +11,9 @@ #include "base/stl_util.h" #include "base/threading/non_thread_safe.h" #include "base/threading/thread.h" +#include "base/win/win_util.h" #include "base/win/wrapped_window_proc.h" +#include "ui/events/event_constants.h" #include "ui/gfx/screen.h" #include "ui/gfx/win/hwnd_util.h" @@ -26,6 +28,17 @@ const UINT kBaseIconId = 2; const wchar_t kNotifyIconHostWindowClass[] = L"Electron_NotifyIconHostWindow"; +int GetKeyboardModifers() { + int modifiers = ui::EF_NONE; + if (base::win::IsShiftPressed()) + modifiers |= ui::EF_SHIFT_DOWN; + if (base::win::IsCtrlPressed()) + modifiers |= ui::EF_CONTROL_DOWN; + if (base::win::IsAltPressed()) + modifiers |= ui::EF_ALT_DOWN; + return modifiers; +} + } // namespace NotifyIconHost::NotifyIconHost() @@ -155,6 +168,7 @@ LRESULT CALLBACK NotifyIconHost::WndProc(HWND hwnd, gfx::Screen::GetNativeScreen()->GetCursorScreenPoint()); win_icon->HandleClickEvent( cursor_pos, + GetKeyboardModifers(), (lparam == WM_LBUTTONDOWN || lparam == WM_LBUTTONDBLCLK), (lparam == WM_LBUTTONDBLCLK || lparam == WM_RBUTTONDBLCLK)); return TRUE; From 45f5a10d5df6a950fff69e58e224b7dcf3bfa95b Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Wed, 29 Jul 2015 13:27:07 +0800 Subject: [PATCH 0725/1293] Use NSImageView to draw tray icon. * Fixes Tempate image doesn't show correctly in dark mode. * Fixes the tray icon is stretched showing in menubar. * Fixes title color will not reversed in dark mode. --- atom/browser/ui/tray_icon_cocoa.mm | 73 ++++++++++++++++++------------ 1 file changed, 45 insertions(+), 28 deletions(-) diff --git a/atom/browser/ui/tray_icon_cocoa.mm b/atom/browser/ui/tray_icon_cocoa.mm index 0f5a768e5d59..c4f3975afedb 100644 --- a/atom/browser/ui/tray_icon_cocoa.mm +++ b/atom/browser/ui/tray_icon_cocoa.mm @@ -12,8 +12,8 @@ namespace { -const CGFloat kStatusItemLength = 26; -const CGFloat kMargin = 3; +// By default, OS X sets 4px to tray image as left and right padding margin. +const CGFloat kHorizontalMargin = 4; } // namespace @@ -24,6 +24,7 @@ const CGFloat kMargin = 3; BOOL inMouseEventSequence_; base::scoped_nsobject image_; base::scoped_nsobject alternateImage_; + base::scoped_nsobject image_view_; base::scoped_nsobject title_; base::scoped_nsobject statusItem_; } @@ -37,11 +38,17 @@ const CGFloat kMargin = 3; isHighlightEnable_ = YES; statusItem_.reset([[[NSStatusBar systemStatusBar] statusItemWithLength: NSVariableStatusItemLength] retain]); + CGFloat itemLength = [[statusItem_ statusBar] thickness]; NSRect frame = NSMakeRect(0, 0, - kStatusItemLength, - [[statusItem_ statusBar] thickness]); + itemLength, + itemLength); if ((self = [super initWithFrame:frame])) { + image_view_.reset([[[NSImageView alloc] initWithFrame:frame] retain]); + // Unregister image_view_ as a dragged destination, allows its parent view + // (StatusItemView) handle dragging events. + [image_view_ unregisterDraggedTypes]; + [self addSubview:image_view_]; [self registerForDraggedTypes: [NSArray arrayWithObjects:NSFilenamesPboardType, nil]]; [statusItem_ setView:self]; @@ -55,44 +62,53 @@ const CGFloat kMargin = 3; } - (void)drawRect:(NSRect)dirtyRect { - // Draw the tray icon and title that align with NSSStatusItem, layout: + // Draw the tray icon and title that align with NSStatusItem, layout: // ---------------- // | icon | title | /// ---------------- BOOL highlight = [self shouldHighlight]; CGFloat titleWidth = [self titleWidth]; - // Calculate the total icon bounds. + CGFloat statusItemHeight = [[statusItem_ statusBar] thickness]; + CGFloat iconWidth =((highlight && alternateImage_) ? + [alternateImage_ size].width : [image_ size].width) + + 2 * kHorizontalMargin; + NSRect iconRect = NSMakeRect(0, 0, iconWidth, statusItemHeight); + + // Calculate the total status item bounds. + CGFloat statusItemWidth = iconWidth + titleWidth; + // If title is set, need to add right margin to the title. + if (title_) { + statusItemWidth += kHorizontalMargin; + } NSRect statusItemBounds = NSMakeRect(0, 0, - kStatusItemLength + titleWidth, - [[statusItem_ statusBar] thickness]); + statusItemWidth, + statusItemHeight); [statusItem_ drawStatusBarBackgroundInRect:statusItemBounds withHighlight:highlight]; - [statusItem_ setLength:titleWidth + kStatusItemLength]; + [statusItem_ setLength:statusItemWidth]; + + // Custom ImageView + [image_view_ setFrame: iconRect]; + if (highlight && alternateImage_) { + [image_view_ setImage:alternateImage_]; + } else { + [image_view_ setImage:image_]; + } + if (title_) { - NSRect titleDrawRect = NSMakeRect(kStatusItemLength, + NSRect titleDrawRect = NSMakeRect(iconWidth, 0, - titleWidth + kStatusItemLength, - [[statusItem_ statusBar] thickness]); + statusItemWidth - kHorizontalMargin, + statusItemHeight); [title_ drawInRect:titleDrawRect withAttributes:[self titleAttributes]]; } +} - NSRect iconRect = NSMakeRect(0, - 0, - kStatusItemLength, - [[statusItem_ statusBar] thickness]); - if (highlight && alternateImage_) { - [alternateImage_ drawInRect:NSInsetRect(iconRect, kMargin, kMargin) - fromRect:NSZeroRect - operation:NSCompositeSourceOver - fraction:1]; - } else { - [image_ drawInRect:NSInsetRect(iconRect, kMargin, kMargin) - fromRect:NSZeroRect - operation:NSCompositeSourceOver - fraction:1]; - } +- (BOOL) isDarkMode { + return [[[NSAppearance currentAppearance] name] hasPrefix: + NSAppearanceNameVibrantDark]; } - (CGFloat)titleWidth { @@ -105,7 +121,8 @@ const CGFloat kMargin = 3; - (NSDictionary*)titleAttributes { NSFont* font = [NSFont menuBarFontOfSize:0]; - NSColor* foregroundColor = [NSColor blackColor]; + NSColor* foregroundColor = + [self isDarkMode] ? [NSColor whiteColor] : [NSColor blackColor]; return [NSDictionary dictionaryWithObjectsAndKeys: font, NSFontAttributeName, From 877830e4a1159f7bd31eb0c91b6859a3d7cb351f Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Wed, 29 Jul 2015 14:03:07 +0800 Subject: [PATCH 0726/1293] No need for default_download_path_ member. --- atom/browser/atom_browser_context.h | 2 +- atom/browser/atom_download_manager_delegate.cc | 8 ++++---- atom/browser/atom_download_manager_delegate.h | 1 - 3 files changed, 5 insertions(+), 6 deletions(-) diff --git a/atom/browser/atom_browser_context.h b/atom/browser/atom_browser_context.h index 3455916fa5b3..c1ff613b8c07 100644 --- a/atom/browser/atom_browser_context.h +++ b/atom/browser/atom_browser_context.h @@ -32,7 +32,7 @@ class AtomBrowserContext : public brightray::BrowserContext { content::DownloadManagerDelegate* GetDownloadManagerDelegate() override; content::BrowserPluginGuestManager* GetGuestManager() override; - // brightray::BrowserContext:: + // brightray::BrowserContext: void RegisterPrefs(PrefRegistrySimple* pref_registry) override; AtomURLRequestJobFactory* job_factory() const { return job_factory_; } diff --git a/atom/browser/atom_download_manager_delegate.cc b/atom/browser/atom_download_manager_delegate.cc index 7e393f7d2c21..b573a396332f 100644 --- a/atom/browser/atom_download_manager_delegate.cc +++ b/atom/browser/atom_download_manager_delegate.cc @@ -102,12 +102,12 @@ bool AtomDownloadManagerDelegate::DetermineDownloadTarget( AtomBrowserContext* browser_context = static_cast( download_manager_->GetBrowserContext()); - default_download_path_ = browser_context->prefs()->GetFilePath( + base::FilePath default_download_path = browser_context->prefs()->GetFilePath( prefs::kDownloadDefaultDirectory); // If users didn't set download path, use 'Downloads' directory by default. - if (default_download_path_.empty()) { + if (default_download_path.empty()) { auto path = download_manager_->GetBrowserContext()->GetPath(); - default_download_path_ = path.Append(FILE_PATH_LITERAL("Downloads")); + default_download_path = path.Append(FILE_PATH_LITERAL("Downloads")); } if (!download->GetForcedFilePath().empty()) { @@ -131,7 +131,7 @@ bool AtomDownloadManagerDelegate::DetermineDownloadTarget( download->GetContentDisposition(), download->GetSuggestedFilename(), download->GetMimeType(), - default_download_path_, + default_download_path, download_path_callback)); return true; } diff --git a/atom/browser/atom_download_manager_delegate.h b/atom/browser/atom_download_manager_delegate.h index e2d829243299..2df3a7d45a6b 100644 --- a/atom/browser/atom_download_manager_delegate.h +++ b/atom/browser/atom_download_manager_delegate.h @@ -47,7 +47,6 @@ class AtomDownloadManagerDelegate : public content::DownloadManagerDelegate { private: content::DownloadManager* download_manager_; - base::FilePath default_download_path_; base::WeakPtrFactory weak_ptr_factory_; DISALLOW_COPY_AND_ASSIGN(AtomDownloadManagerDelegate); From f40155645c4a1c60d00db5dc248575d9b78153d8 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Wed, 29 Jul 2015 14:13:28 +0800 Subject: [PATCH 0727/1293] :memo: say more about setDownloadPath API. --- docs/api/browser-window.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 766b9ce92439..b1c670a34a8b 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -1224,3 +1224,6 @@ proxy-uri = ["://"][":"] ### Session.setDownloadPath(path) * `path` String - The download location + +Sets download saving directory. By default, the download directory will be the +`Downloads` under the respective app folder. From 625143426a23507e7fb70714d29314b2f8a17bca Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 29 Jul 2015 14:24:45 +0800 Subject: [PATCH 0728/1293] Enable using custom events when emitting --- atom/browser/api/event_emitter.cc | 13 ++++++++++--- atom/browser/api/event_emitter.h | 28 +++++++++++++++++++++++----- 2 files changed, 33 insertions(+), 8 deletions(-) diff --git a/atom/browser/api/event_emitter.cc b/atom/browser/api/event_emitter.cc index 7337830780f5..aa0b6c8781a3 100644 --- a/atom/browser/api/event_emitter.cc +++ b/atom/browser/api/event_emitter.cc @@ -37,9 +37,8 @@ v8::Local CreateEventObject(v8::Isolate* isolate) { EventEmitter::EventEmitter() { } -v8::Local EventEmitter::CreateJSEvent(v8::Isolate* isolate, - content::WebContents* sender, - IPC::Message* message) { +v8::Local EventEmitter::CreateJSEvent( + v8::Isolate* isolate, content::WebContents* sender, IPC::Message* message) { v8::Local event; bool use_native_event = sender && message; @@ -54,4 +53,12 @@ v8::Local EventEmitter::CreateJSEvent(v8::Isolate* isolate, return event; } +v8::Local EventEmitter::CreateCustomEvent( + v8::Isolate* isolate, v8::Local custom_event) { + v8::Local event = CreateEventObject(isolate); + event->SetPrototype(custom_event->CreationContext(), custom_event); + mate::Dictionary(isolate, event).Set("sender", GetWrapper(isolate)); + return event; +} + } // namespace mate diff --git a/atom/browser/api/event_emitter.h b/atom/browser/api/event_emitter.h index 6910df3a28d0..178c61d853ca 100644 --- a/atom/browser/api/event_emitter.h +++ b/atom/browser/api/event_emitter.h @@ -25,6 +25,14 @@ class EventEmitter : public Wrappable { public: typedef std::vector> ValueArray; + // this.emit(name, event, args...); + template + bool EmitCustomEvent(const base::StringPiece& name, + v8::Local event, + const Args&... args) { + return EmitWithEvent(name, CreateCustomEvent(isolate(), event), args...); + } + // this.emit(name, new Event(), args...); template bool Emit(const base::StringPiece& name, const Args&... args) { @@ -37,21 +45,31 @@ class EventEmitter : public Wrappable { content::WebContents* sender, IPC::Message* message, const Args&... args) { - v8::Locker locker(isolate()); - v8::HandleScope handle_scope(isolate()); v8::Local event = CreateJSEvent(isolate(), sender, message); - EmitEvent(isolate(), GetWrapper(isolate()), name, event, args...); - return event->Get( - StringToV8(isolate(), "defaultPrevented"))->BooleanValue(); + return EmitWithEvent(name, event, args...); } protected: EventEmitter(); private: + // this.emit(name, event, args...); + template + bool EmitWithEvent(const base::StringPiece& name, + v8::Local event, + const Args&... args) { + v8::Locker locker(isolate()); + v8::HandleScope handle_scope(isolate()); + EmitEvent(isolate(), GetWrapper(isolate()), name, event, args...); + return event->Get( + StringToV8(isolate(), "defaultPrevented"))->BooleanValue(); + } + v8::Local CreateJSEvent(v8::Isolate* isolate, content::WebContents* sender, IPC::Message* message); + v8::Local CreateCustomEvent( + v8::Isolate* isolate, v8::Local event); DISALLOW_COPY_AND_ASSIGN(EventEmitter); }; From 8d22eeb3be7ce0b4d6c1393cf686f63fa3aa21c1 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 29 Jul 2015 14:25:12 +0800 Subject: [PATCH 0729/1293] Use DOM's way of telling modifiers --- atom/browser/api/atom_api_tray.cc | 31 +++++++++++++++++++++++++------ atom/browser/api/atom_api_tray.h | 4 +++- 2 files changed, 28 insertions(+), 7 deletions(-) diff --git a/atom/browser/api/atom_api_tray.cc b/atom/browser/api/atom_api_tray.cc index a849c03f59a0..82f78519aeb3 100644 --- a/atom/browser/api/atom_api_tray.cc +++ b/atom/browser/api/atom_api_tray.cc @@ -14,6 +14,7 @@ #include "atom/common/native_mate_converters/string16_converter.h" #include "native_mate/constructor.h" #include "native_mate/dictionary.h" +#include "ui/events/event_constants.h" #include "ui/gfx/image/image.h" #include "atom/common/node_includes.h" @@ -41,11 +42,24 @@ mate::Wrappable* Tray::New(v8::Isolate* isolate, const gfx::Image& image) { } void Tray::OnClicked(const gfx::Rect& bounds, int modifiers) { - Emit("clicked", bounds, modifiers); + v8::Locker locker(isolate()); + v8::HandleScope handle_scope(isolate()); + EmitCustomEvent("clicked", + ModifiersToObject(isolate(), modifiers), bounds); } void Tray::OnDoubleClicked(const gfx::Rect& bounds, int modifiers) { - Emit("double-clicked", bounds, modifiers); + v8::Locker locker(isolate()); + v8::HandleScope handle_scope(isolate()); + EmitCustomEvent("double-clicked", + ModifiersToObject(isolate(), modifiers), bounds); +} + +void Tray::OnRightClicked(const gfx::Rect& bounds, int modifiers) { + v8::Locker locker(isolate()); + v8::HandleScope handle_scope(isolate()); + EmitCustomEvent("right-clicked", + ModifiersToObject(isolate(), modifiers), bounds); } void Tray::OnBalloonShow() { @@ -60,10 +74,6 @@ void Tray::OnBalloonClosed() { Emit("balloon-closed"); } -void Tray::OnRightClicked(const gfx::Rect& bounds, int modifiers) { - Emit("right-clicked", bounds, modifiers); -} - void Tray::OnDropFiles(const std::vector& files) { Emit("drop-files", files); } @@ -120,6 +130,15 @@ void Tray::SetContextMenu(mate::Arguments* args, Menu* menu) { tray_icon_->SetContextMenu(menu->model()); } +v8::Local Tray::ModifiersToObject(v8::Isolate* isolate, + int modifiers) { + mate::Dictionary obj(isolate, v8::Object::New(isolate)); + obj.Set("shiftKey", static_cast(modifiers & ui::EF_SHIFT_DOWN)); + obj.Set("ctrlKey", static_cast(modifiers & ui::EF_CONTROL_DOWN)); + obj.Set("altKey", static_cast(modifiers & ui::EF_ALT_DOWN)); + return obj.GetHandle(); +} + // static void Tray::BuildPrototype(v8::Isolate* isolate, v8::Local prototype) { diff --git a/atom/browser/api/atom_api_tray.h b/atom/browser/api/atom_api_tray.h index 10340677813f..02f7418fe41d 100644 --- a/atom/browser/api/atom_api_tray.h +++ b/atom/browser/api/atom_api_tray.h @@ -44,10 +44,10 @@ class Tray : public mate::EventEmitter, // TrayIconObserver: void OnClicked(const gfx::Rect& bounds, int modifiers) override; void OnDoubleClicked(const gfx::Rect& bounds, int modifiers) override; + void OnRightClicked(const gfx::Rect& bounds, int modifiers) override; void OnBalloonShow() override; void OnBalloonClicked() override; void OnBalloonClosed() override; - void OnRightClicked(const gfx::Rect& bounds, int modifiers) override; void OnDropFiles(const std::vector& files) override; // mate::Wrappable: @@ -64,6 +64,8 @@ class Tray : public mate::EventEmitter, void SetContextMenu(mate::Arguments* args, Menu* menu); private: + v8::Local ModifiersToObject(v8::Isolate* isolate, int modifiers); + scoped_ptr tray_icon_; DISALLOW_COPY_AND_ASSIGN(Tray); From 3e1a5b229ce2750182ec1ac1070142d73dd03d02 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 29 Jul 2015 14:27:32 +0800 Subject: [PATCH 0730/1293] docs: modifiers removed --- docs/api/tray.md | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/docs/api/tray.md b/docs/api/tray.md index 935430b7feaa..5c8c88018f71 100644 --- a/docs/api/tray.md +++ b/docs/api/tray.md @@ -47,13 +47,15 @@ Creates a new tray icon associated with the `image`. ### Event: 'clicked' -* `event` +* `event` Event + * `altKey` Boolean + * `shiftKey` Boolean + * `ctrlKey` Boolean * `bounds` Object - the bounds of tray icon * `x` Integer * `y` Integer * `width` Integer * `height` Integer -* [`modifiers`][modifiers] Integer - bitsum of keyboard modifiers and mouse keys Emitted when the tray icon is clicked. @@ -61,13 +63,15 @@ __Note:__ The `bounds` payload is only implemented on OS X and Windows 7 or newe ### Event: 'right-clicked' -* `event` +* `event` Event + * `altKey` Boolean + * `shiftKey` Boolean + * `ctrlKey` Boolean * `bounds` Object - the bounds of tray icon * `x` Integer * `y` Integer * `width` Integer * `height` Integer -* [`modifiers`][modifiers] Integer - bitsum of keyboard modifiers and mouse keys Emitted when the tray icon is right clicked. @@ -75,13 +79,15 @@ __Note:__ This is only implemented on OS X and Windows. ### Event: 'double-clicked' -* `event` +* `event` Event + * `altKey` Boolean + * `shiftKey` Boolean + * `ctrlKey` Boolean * `bounds` Object - the bounds of tray icon * `x` Integer * `y` Integer * `width` Integer * `height` Integer -* [`modifiers`][modifiers] Integer - bitsum of keyboard modifiers and mouse keys Emitted when the tray icon is double clicked. @@ -181,4 +187,3 @@ __Note:__ This is only implemented on OS X and Windows. Sets the context menu for this icon. [event-emitter]: http://nodejs.org/api/events.html#events_class_events_eventemitter -[modifiers]: https://code.google.com/p/chromium/codesearch#chromium/src/ui/events/event_constants.h&l=77 From b2f03fc2d878061d3c001dbc2cb21676db6e35fd Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 29 Jul 2015 14:44:08 +0800 Subject: [PATCH 0731/1293] Add metaKey --- atom/browser/api/atom_api_tray.cc | 1 + atom/browser/ui/win/notify_icon_host.cc | 8 ++++++++ docs/api/tray.md | 3 +++ 3 files changed, 12 insertions(+) diff --git a/atom/browser/api/atom_api_tray.cc b/atom/browser/api/atom_api_tray.cc index 82f78519aeb3..0f07737da2bf 100644 --- a/atom/browser/api/atom_api_tray.cc +++ b/atom/browser/api/atom_api_tray.cc @@ -136,6 +136,7 @@ v8::Local Tray::ModifiersToObject(v8::Isolate* isolate, obj.Set("shiftKey", static_cast(modifiers & ui::EF_SHIFT_DOWN)); obj.Set("ctrlKey", static_cast(modifiers & ui::EF_CONTROL_DOWN)); obj.Set("altKey", static_cast(modifiers & ui::EF_ALT_DOWN)); + obj.Set("metaKey", static_cast(modifiers & ui::EF_COMMAND_DOWN)); return obj.GetHandle(); } diff --git a/atom/browser/ui/win/notify_icon_host.cc b/atom/browser/ui/win/notify_icon_host.cc index c34e14375e76..2c84837e714d 100644 --- a/atom/browser/ui/win/notify_icon_host.cc +++ b/atom/browser/ui/win/notify_icon_host.cc @@ -5,6 +5,7 @@ #include "atom/browser/ui/win/notify_icon_host.h" #include +#include #include "atom/browser/ui/win/notify_icon.h" #include "base/bind.h" @@ -28,6 +29,11 @@ const UINT kBaseIconId = 2; const wchar_t kNotifyIconHostWindowClass[] = L"Electron_NotifyIconHostWindow"; +bool IsWinPressed() { + return ((::GetKeyState(VK_LWIN) & 0x8000) == 0x8000) || + ((::GetKeyState(VK_RWIN) & 0x8000) == 0x8000); +} + int GetKeyboardModifers() { int modifiers = ui::EF_NONE; if (base::win::IsShiftPressed()) @@ -36,6 +42,8 @@ int GetKeyboardModifers() { modifiers |= ui::EF_CONTROL_DOWN; if (base::win::IsAltPressed()) modifiers |= ui::EF_ALT_DOWN; + if (IsWinPressed()) + modifiers |= ui::EF_COMMAND_DOWN; return modifiers; } diff --git a/docs/api/tray.md b/docs/api/tray.md index 5c8c88018f71..3d3ebc280f5a 100644 --- a/docs/api/tray.md +++ b/docs/api/tray.md @@ -51,6 +51,7 @@ Creates a new tray icon associated with the `image`. * `altKey` Boolean * `shiftKey` Boolean * `ctrlKey` Boolean + * `metaKey` Boolean * `bounds` Object - the bounds of tray icon * `x` Integer * `y` Integer @@ -67,6 +68,7 @@ __Note:__ The `bounds` payload is only implemented on OS X and Windows 7 or newe * `altKey` Boolean * `shiftKey` Boolean * `ctrlKey` Boolean + * `metaKey` Boolean * `bounds` Object - the bounds of tray icon * `x` Integer * `y` Integer @@ -83,6 +85,7 @@ __Note:__ This is only implemented on OS X and Windows. * `altKey` Boolean * `shiftKey` Boolean * `ctrlKey` Boolean + * `metaKey` Boolean * `bounds` Object - the bounds of tray icon * `x` Integer * `y` Integer From b786772819b0e2dd8d9038441a3bb0c39982cc26 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 29 Jul 2015 14:50:56 +0800 Subject: [PATCH 0732/1293] Update brightray for #2324 --- vendor/brightray | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/brightray b/vendor/brightray index 1c79219c5c8e..84a41fb634a9 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit 1c79219c5c8e8636208f1aaf2c937d11acba34ea +Subproject commit 84a41fb634a96699f34c6ba0b15b8d5c8faf82e6 From 77a8a3d33c952acf169417e820b114103a332066 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Wed, 29 Jul 2015 16:09:32 +0800 Subject: [PATCH 0733/1293] Add `allow-running-insecure-content`, `allow-display-insecure-content` in BrowserWindow option. --- atom/browser/native_window.cc | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index c03ab1ac24a4..ca5df45d1782 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -434,6 +434,10 @@ void NativeWindow::OverrideWebkitPrefs(content::WebPreferences* prefs) { prefs->experimental_webgl_enabled = b; if (web_preferences_.Get("webaudio", &b)) prefs->webaudio_enabled = b; + if (web_preferences_.Get("allow-displaying-insecure-content", &b)) + prefs->allow_displaying_insecure_content = b; + if (web_preferences_.Get("allow-running-insecure-content", &b)) + prefs->allow_running_insecure_content = b; if (web_preferences_.Get("web-security", &b)) { prefs->web_security_enabled = b; prefs->allow_displaying_insecure_content = !b; From 1d0568dd5b73b06326831d6866f94240521ace5c Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Wed, 29 Jul 2015 16:15:16 +0800 Subject: [PATCH 0734/1293] :memo: `allow-running-insecure-content` and `allow-displaying-insecure-content`. --- docs/api/browser-window.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index cee68183f783..b6f254460763 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -76,7 +76,15 @@ You can also create a window without chrome by using textured window. Defaults to `true`. * `web-preferences` Object - Settings of web page's features * `javascript` Boolean - * `web-security` Boolean + * `web-security` Boolean - When setting `false`, it will disable the same-origin + policy(Ususally using testing websites by people) and set `allow_displaying_insecure_content` + and `allow_running_insecure_content` to `true`. + * `allow-displaying-insecure-content` Boolean - Allow a https page to display + content like image from http URLs. This option will be overrided to `true` + when `web-security` option is set. + * `allow-running-insecure-content` Boolean - Allow a https page to run JavaScript, + CSS or plugins from http URLs. This option will be overrided to `true` when + `web-security` option is set. * `images` Boolean * `java` Boolean * `text-areas-are-resizable` Boolean From b311969f0e8275a1c0414066a0481ff77a274277 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 29 Jul 2015 17:16:23 +0800 Subject: [PATCH 0735/1293] Update brightray for #2327 --- vendor/brightray | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/brightray b/vendor/brightray index 84a41fb634a9..956ee8a3296f 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit 84a41fb634a96699f34c6ba0b15b8d5c8faf82e6 +Subproject commit 956ee8a3296f2ea8eaf48b6d6c9bbb7ba26d4c1a From f154da38e6f9f2299b95981e831fe08533bc69e6 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Wed, 29 Jul 2015 18:07:06 +0800 Subject: [PATCH 0736/1293] Make 'allow-displaying-insecure-content' and 'allow-running-insecure-content' higher priority than `web-security`. --- atom/browser/native_window.cc | 8 ++++---- docs/api/browser-window.md | 11 +++++------ 2 files changed, 9 insertions(+), 10 deletions(-) diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index ca5df45d1782..ac3efc604e07 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -434,15 +434,15 @@ void NativeWindow::OverrideWebkitPrefs(content::WebPreferences* prefs) { prefs->experimental_webgl_enabled = b; if (web_preferences_.Get("webaudio", &b)) prefs->webaudio_enabled = b; - if (web_preferences_.Get("allow-displaying-insecure-content", &b)) - prefs->allow_displaying_insecure_content = b; - if (web_preferences_.Get("allow-running-insecure-content", &b)) - prefs->allow_running_insecure_content = b; if (web_preferences_.Get("web-security", &b)) { prefs->web_security_enabled = b; prefs->allow_displaying_insecure_content = !b; prefs->allow_running_insecure_content = !b; } + if (web_preferences_.Get("allow-displaying-insecure-content", &b)) + prefs->allow_displaying_insecure_content = b; + if (web_preferences_.Get("allow-running-insecure-content", &b)) + prefs->allow_running_insecure_content = b; if (web_preferences_.Get("extra-plugin-dirs", &list)) { if (content::PluginService::GetInstance()->NPAPIPluginsSupported()) { for (size_t i = 0; i < list.size(); ++i) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index b6f254460763..f8830632caa6 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -77,14 +77,13 @@ You can also create a window without chrome by using * `web-preferences` Object - Settings of web page's features * `javascript` Boolean * `web-security` Boolean - When setting `false`, it will disable the same-origin - policy(Ususally using testing websites by people) and set `allow_displaying_insecure_content` - and `allow_running_insecure_content` to `true`. + policy(Usually using testing websites by people), and set `allow_displaying_insecure_content` + and `allow_running_insecure_content` to `true` if these two options are not + set by user. * `allow-displaying-insecure-content` Boolean - Allow a https page to display - content like image from http URLs. This option will be overrided to `true` - when `web-security` option is set. + content like image from http URLs. * `allow-running-insecure-content` Boolean - Allow a https page to run JavaScript, - CSS or plugins from http URLs. This option will be overrided to `true` when - `web-security` option is set. + CSS or plugins from http URLs. * `images` Boolean * `java` Boolean * `text-areas-are-resizable` Boolean From 643ed27fd4c92c3715dc3df441ad157fc16ad9fd Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 29 Jul 2015 18:26:20 +0800 Subject: [PATCH 0737/1293] Check whether entry is null This fixes the crash in #7877. --- atom/browser/native_window.cc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index c03ab1ac24a4..8bf25dce9e3f 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -549,7 +549,7 @@ void NativeWindow::BeforeUnloadDialogCancelled() { void NativeWindow::TitleWasSet(content::NavigationEntry* entry, bool explicit_set) { bool prevent_default = false; - std::string text = base::UTF16ToUTF8(entry->GetTitle()); + std::string text = entry ? base::UTF16ToUTF8(entry->GetTitle()) : ""; FOR_EACH_OBSERVER(NativeWindowObserver, observers_, OnPageTitleUpdated(&prevent_default, text)); From f9d59155425ae7f8111c4c861a4d49a99d36a00f Mon Sep 17 00:00:00 2001 From: Tim Ruffles Date: Wed, 29 Jul 2015 13:45:30 +0100 Subject: [PATCH 0738/1293] more accuracy around why to use ASAR 'protect' implies a lot more security than ASAR provides (none). I asked around #2374 to get some understanding of what ASAR does do for you. --- docs/tutorial/application-packaging.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/tutorial/application-packaging.md b/docs/tutorial/application-packaging.md index 0741b2572447..7568204fb62f 100644 --- a/docs/tutorial/application-packaging.md +++ b/docs/tutorial/application-packaging.md @@ -1,6 +1,6 @@ # Application packaging -To protect your app's resources and source code from the users, you can choose +To mitigate [issues](https://github.com/joyent/node/issues/6960) around long path names on Windows, slightly speed up `require` and conceal your source code from cursory inspection you can choose to package your app into an [asar][asar] archive with little changes to your source code. @@ -161,3 +161,4 @@ After running the command, apart from the `app.asar`, there is also an should copy it together with `app.asar` when shipping it to users. [asar]: https://github.com/atom/asar + From 90bd32c6800bbb7cd20a4c1fe8a1fe7e781ca104 Mon Sep 17 00:00:00 2001 From: Vivek Patel Date: Wed, 29 Jul 2015 15:04:34 +0200 Subject: [PATCH 0739/1293] Replaced 'browser' with 'main' "A JavaScript error occured in the browser process" is confusing. Replacing it with 'main', just like everywhere else. --- atom/browser/lib/init.coffee | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/atom/browser/lib/init.coffee b/atom/browser/lib/init.coffee index 678d7422b0c6..e61323bfdcc0 100644 --- a/atom/browser/lib/init.coffee +++ b/atom/browser/lib/init.coffee @@ -38,7 +38,7 @@ process.on 'uncaughtException', (error) -> # Show error in GUI. stack = error.stack ? "#{error.name}: #{error.message}" message = "Uncaught Exception:\n#{stack}" - require('dialog').showErrorBox 'A JavaScript error occured in the browser process', message + require('dialog').showErrorBox 'A JavaScript error occured in the main process', message # Emit 'exit' event on quit. app = require 'app' From 05def654c3cba14fcd809bed6f04cb06e45f3852 Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Thu, 30 Jul 2015 09:56:27 +0900 Subject: [PATCH 0740/1293] Translate web-view-tag-tag-ko.md, improve grammer --- docs/api/content-tracing-ko.md | 5 +- docs/api/screen-ko.md | 6 +- docs/api/web-view-tag-ko.md | 207 ++++++++---------- .../build-instructions-windows-ko.md | 2 +- 4 files changed, 99 insertions(+), 121 deletions(-) diff --git a/docs/api/content-tracing-ko.md b/docs/api/content-tracing-ko.md index defa29fda959..9758d9236aa8 100644 --- a/docs/api/content-tracing-ko.md +++ b/docs/api/content-tracing-ko.md @@ -20,10 +20,7 @@ tracing.startRecording('*', tracing.DEFAULT_OPTIONS, function() { * `callback` Function -카테고리 그룹 세트를 가져옵니다. 카테고리 그룹은 도달 대상이 되는 코드 경로를 변경할 수 있습니다. - -Get a set of category groups. The category groups can change as new code paths -are reached. +카테고리 그룹 세트를 가져옵니다. 카테고리 그룹은 도달된 코드 경로를 변경할 수 있습니다. Once all child processes have acked to the `getCategories` request, `callback` is invoked with an array of category groups. diff --git a/docs/api/screen-ko.md b/docs/api/screen-ko.md index 6b508991e4f7..44f0c1ea58b3 100644 --- a/docs/api/screen-ko.md +++ b/docs/api/screen-ko.md @@ -56,14 +56,14 @@ app.on('ready', function() { * `event` Event * `newDisplay` Object -새로운 디스플레이가 추가되면 발생합니다. +새로운 디스플레이가 추가되면 발생하는 이벤트입니다. ## Event: display-removed * `event` Event * `oldDisplay` Object -기존의 디스플레이가 제거되면 발생합니다. +기존의 디스플레이가 제거되면 발생하는 이벤트입니다. ## Event: display-metrics-changed @@ -71,7 +71,7 @@ app.on('ready', function() { * `display` Object * `changedMetrics` Array -`display`의 하나 또는 다수의 매트릭스가 변경될 경우 발생합니다. +`display`의 하나 또는 다수의 매트릭스가 변경될 때 발생하는 이벤트입니다. `changedMetrics`는 변경에 대한 정보를 담은 문자열의 배열입니다. `bounds`, `workArea`, `scaleFactor`, `rotation`등이 변경될 수 있습니다. diff --git a/docs/api/web-view-tag-ko.md b/docs/api/web-view-tag-ko.md index 9054d1824823..abef526d7876 100644 --- a/docs/api/web-view-tag-ko.md +++ b/docs/api/web-view-tag-ko.md @@ -1,31 +1,24 @@ # `` 태그 -Use the `webview` tag to embed 'guest' content (such as web pages) in your -Electron app. The guest content is contained within the `webview` container; -an embedder page within your app controls how the guest content is laid out and -rendered. +`guest` 컨텐츠(웹 페이지)를 Electron 앱 페이지에 삽입하기 위해 `webview` 태그를 사용할 수 있습니다. +게스트 컨텐츠는 `webview` 컨테이너에 담겨 대상 페이지에 삽입되고 해당 페이지에선 게스트 컨텐츠의 배치 및 렌더링 과정을 조작할 수 있습니다. -Different from the `iframe`, the `webview` runs in a separate process than your -app; it doesn't have the same permissions as your web page and all interactions -between your app and embedded content will be asynchronous. This keeps your app -safe from the embedded content. +`iframe`과 `webview`의 차이는 어플리케이션과 프로세스가 분리되어 돌아간다는 점입니다. +그것은 모든 권한이 웹 페이지와 같지 않고 모든 앱과 임베디드(게스트) 컨텐츠간의 상호작용이 비동기로 작동한다는 것을 의미합니다. +이에 따라 임베디드 컨텐츠로부터 어플리케이션을 안전하게 유지할 수 있습니다. ## 예제 -To embed a web page in your app, add the `webview` tag to your app's embedder -page (this is the app page that will display the guest content). In its simplest -form, the `webview` tag includes the `src` of the web page and css styles that -control the appearance of the `webview` container: +웹 페이지를 어플리케이션에 삽입하려면 `webview` 태그를 사용해 원하는 타겟 페이지에 추가하면 됩니다. (게스트 컨텐츠가 앱 페이지에 추가 됩니다) +간단한 예로 `webview` 태그의 `src` 속성에 페이지를 지정하고 css 스타일을 이용해서 컨테이너의 외관을 설정할 수 있습니다: ```html ``` -If you want to control the guest content in any way, you can write JavaScript -that listens for `webview` events and responds to those events using the -`webview` methods. Here's sample code with two event listeners: one that listens -for the web page to start loading, the other for the web page to stop loading, -and displays a "loading..." message during the load time: +게스트 컨텐츠를 조작하기 위해 자바스크립트로 `webview` 태그의 이벤트를 리스닝 하여 응답을 받을 수 있습니다. +다음 예제를 참고하세요: 첫번째 리스너는 페이지 로딩 시작시의 이벤트를 확인하고 두번째 리스너는 페이지의 로딩이 끝난시점을 확인합니다. +그리고 페이지를 로드하는 동안 "loading..." 메시지를 표시합니다. ```html + + + From 2a305207990e5d09a1b541006108ecdb0fa5e27a Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 4 Aug 2015 15:47:12 +0800 Subject: [PATCH 0762/1293] Only set window.opener for windows opened by window.open --- atom/browser/lib/guest-window-manager.coffee | 3 +++ atom/renderer/lib/override.coffee | 2 +- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/atom/browser/lib/guest-window-manager.coffee b/atom/browser/lib/guest-window-manager.coffee index 6f5040ce21d3..f92c1a46c051 100644 --- a/atom/browser/lib/guest-window-manager.coffee +++ b/atom/browser/lib/guest-window-manager.coffee @@ -64,3 +64,6 @@ ipc.on 'ATOM_SHELL_GUEST_WINDOW_MANAGER_WINDOW_OPENER_POSTMESSAGE', (event, mess ipc.on 'ATOM_SHELL_GUEST_WINDOW_MANAGER_WEB_CONTENTS_METHOD', (event, guestId, method, args...) -> BrowserWindow.fromId(guestId)?.webContents?[method] args... + +ipc.on 'ATOM_SHELL_GUEST_WINDOW_MANAGER_IS_GUEST_WINDOW', (event) -> + event.returnValue = v8Util.getHiddenValue(event.sender, 'embedder') isnt undefined diff --git a/atom/renderer/lib/override.coffee b/atom/renderer/lib/override.coffee index aea7feb3cbfe..d0f1fabc4ac9 100644 --- a/atom/renderer/lib/override.coffee +++ b/atom/renderer/lib/override.coffee @@ -91,7 +91,7 @@ window.prompt = -> throw new Error('prompt() is and will not be supported.') # Simple implementation of postMessage. -unless process.guestInstanceId? +if ipc.sendSync 'ATOM_SHELL_GUEST_WINDOW_MANAGER_IS_GUEST_WINDOW' window.opener = postMessage: (message, targetOrigin='*') -> ipc.send 'ATOM_SHELL_GUEST_WINDOW_MANAGER_WINDOW_OPENER_POSTMESSAGE', message, targetOrigin From 69b20d25ee0277a2c55d4be46842274e84940b23 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 4 Aug 2015 16:48:10 +0800 Subject: [PATCH 0763/1293] Update brightray for #2294 --- vendor/brightray | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/brightray b/vendor/brightray index 956ee8a3296f..328fde765587 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit 956ee8a3296f2ea8eaf48b6d6c9bbb7ba26d4c1a +Subproject commit 328fde7655872f48285582af82a40e60118493f1 From 1347c61c8ebaa02a947e303dcab89ed675228673 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 4 Aug 2015 17:13:05 +0800 Subject: [PATCH 0764/1293] Set AppUserModelID for all renderer processes --- atom/browser/atom_browser_client.cc | 14 ++++++++++++++ atom/browser/native_window.cc | 13 ------------- 2 files changed, 14 insertions(+), 13 deletions(-) diff --git a/atom/browser/atom_browser_client.cc b/atom/browser/atom_browser_client.cc index f98f2b2a8873..65fd7cd031dd 100644 --- a/atom/browser/atom_browser_client.cc +++ b/atom/browser/atom_browser_client.cc @@ -4,6 +4,10 @@ #include "atom/browser/atom_browser_client.h" +#if defined(OS_WIN) +#include +#endif + #include "atom/browser/atom_access_token_store.h" #include "atom/browser/atom_browser_context.h" #include "atom/browser/atom_browser_main_parts.h" @@ -190,10 +194,20 @@ void AtomBrowserClient::AppendExtraCommandLineSwitches( if (process_type != "renderer") return; + // The registered standard schemes. if (!g_custom_schemes.empty()) command_line->AppendSwitchASCII(switches::kRegisterStandardSchemes, g_custom_schemes); +#if defined(OS_WIN) + // Append --app-user-model-id. + PWSTR current_app_id; + if (SUCCEEDED(GetCurrentProcessExplicitAppUserModelID(¤t_app_id))) { + command_line->AppendSwitchNative(switches::kAppUserModelId, current_app_id); + CoTaskMemFree(current_app_id); + } +#endif + NativeWindow* window; WebViewManager::WebViewInfo info; ProcessOwner owner = GetProcessOwner(process_id, &window, &info); diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index fb9bab766dd8..d3c40f928272 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -8,10 +8,6 @@ #include #include -#if defined(OS_WIN) -#include -#endif - #include "atom/browser/atom_browser_context.h" #include "atom/browser/atom_browser_main_parts.h" #include "atom/browser/window_list.h" @@ -384,15 +380,6 @@ void NativeWindow::AppendExtraCommandLineSwitches( command_line->AppendSwitchASCII(switches::kZoomFactor, base::DoubleToString(zoom_factor_)); -#if defined(OS_WIN) - // Append --app-user-model-id. - PWSTR current_app_id; - if (SUCCEEDED(GetCurrentProcessExplicitAppUserModelID(¤t_app_id))) { - command_line->AppendSwitchNative(switches::kAppUserModelId, current_app_id); - CoTaskMemFree(current_app_id); - } -#endif - if (web_preferences_.IsEmpty()) return; From 14803e4cf88467a3fe5cad29bc8308e3fe574404 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 4 Aug 2015 19:18:12 +0800 Subject: [PATCH 0765/1293] Close handle when waiting is end --- atom/common/crash_reporter/crash_reporter_win.cc | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/atom/common/crash_reporter/crash_reporter_win.cc b/atom/common/crash_reporter/crash_reporter_win.cc index a348cf012612..5c4f9fb4f24f 100644 --- a/atom/common/crash_reporter/crash_reporter_win.cc +++ b/atom/common/crash_reporter/crash_reporter_win.cc @@ -51,8 +51,10 @@ void CrashReporterWin::InitBreakpad(const std::string& product_name, // Wait until the crash service is started. HANDLE waiting_event = ::CreateEventW(NULL, TRUE, FALSE, L"g_atom_shell_crash_service"); - if (waiting_event != INVALID_HANDLE_VALUE) + if (waiting_event != NULL) { WaitForSingleObject(waiting_event, 1000); + CloseHandle(waiting_event); + } // ExceptionHandler() attaches our handler and ~ExceptionHandler() detaches // it, so we must explicitly reset *before* we instantiate our new handler From db58048077f604f46814a7e5dff3d87a1fd7e3f3 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 4 Aug 2015 19:30:35 +0800 Subject: [PATCH 0766/1293] Use different name for wait events for different apps --- atom/common/crash_reporter/crash_reporter_win.cc | 12 +++++++----- atom/common/crash_reporter/win/crash_service.cc | 14 ++++++++------ atom/common/crash_reporter/win/crash_service.h | 3 ++- .../crash_reporter/win/crash_service_main.cc | 3 ++- 4 files changed, 19 insertions(+), 13 deletions(-) diff --git a/atom/common/crash_reporter/crash_reporter_win.cc b/atom/common/crash_reporter/crash_reporter_win.cc index 5c4f9fb4f24f..be096da80e2c 100644 --- a/atom/common/crash_reporter/crash_reporter_win.cc +++ b/atom/common/crash_reporter/crash_reporter_win.cc @@ -21,6 +21,7 @@ const MINIDUMP_TYPE kSmallDumpType = static_cast( MiniDumpWithProcessThreadData | // Get PEB and TEB. MiniDumpWithUnloadedModules); // Get unloaded modules when available. +const wchar_t kWaitEventFormat[] = L"$1CrashServiceWaitEvent"; const wchar_t kPipeNameFormat[] = L"\\\\.\\pipe\\$1 Crash Service"; } // namespace @@ -47,13 +48,14 @@ void CrashReporterWin::InitBreakpad(const std::string& product_name, base::string16 pipe_name = ReplaceStringPlaceholders( kPipeNameFormat, base::UTF8ToUTF16(product_name), NULL); + base::string16 wait_name = ReplaceStringPlaceholders( + kWaitEventFormat, base::UTF8ToUTF16(product_name), NULL); // Wait until the crash service is started. - HANDLE waiting_event = - ::CreateEventW(NULL, TRUE, FALSE, L"g_atom_shell_crash_service"); - if (waiting_event != NULL) { - WaitForSingleObject(waiting_event, 1000); - CloseHandle(waiting_event); + HANDLE wait_event = ::CreateEventW(NULL, TRUE, FALSE, wait_name.c_str()); + if (wait_event != NULL) { + WaitForSingleObject(wait_event, 1000); + CloseHandle(wait_event); } // ExceptionHandler() attaches our handler and ~ExceptionHandler() detaches diff --git a/atom/common/crash_reporter/win/crash_service.cc b/atom/common/crash_reporter/win/crash_service.cc index 10e0fdfcc555..611c39219bfd 100644 --- a/atom/common/crash_reporter/win/crash_service.cc +++ b/atom/common/crash_reporter/win/crash_service.cc @@ -14,6 +14,7 @@ #include "base/files/file_util.h" #include "base/logging.h" #include "base/strings/string_number_conversions.h" +#include "base/strings/string_util.h" #include "base/time/time.h" #include "base/win/windows_version.h" #include "vendor/breakpad/src/client/windows/crash_generation/client_info.h" @@ -24,6 +25,7 @@ namespace breakpad { namespace { +const wchar_t kWaitEventFormat[] = L"$1CrashServiceWaitEvent"; const wchar_t kTestPipeName[] = L"\\\\.\\pipe\\ChromeCrashServices"; const wchar_t kGoogleReportURL[] = L"https://clients2.google.com/cr/report"; @@ -193,7 +195,8 @@ CrashService::~CrashService() { delete sender_; } -bool CrashService::Initialize(const base::FilePath& operating_dir, +bool CrashService::Initialize(const base::string16& application_name, + const base::FilePath& operating_dir, const base::FilePath& dumps_path) { using google_breakpad::CrashReportSender; using google_breakpad::CrashGenerationServer; @@ -298,11 +301,10 @@ bool CrashService::Initialize(const base::FilePath& operating_dir, // Create or open an event to signal the browser process that the crash // service is initialized. - HANDLE running_event = - ::CreateEventW(NULL, TRUE, TRUE, L"g_atom_shell_crash_service"); - // If the browser already had the event open, the CreateEvent call did not - // signal it. We need to do it manually. - ::SetEvent(running_event); + base::string16 wait_name = ReplaceStringPlaceholders( + kWaitEventFormat, application_name, NULL); + HANDLE wait_event = ::CreateEventW(NULL, TRUE, FALSE, wait_name.c_str()); + ::SetEvent(wait_event); return true; } diff --git a/atom/common/crash_reporter/win/crash_service.h b/atom/common/crash_reporter/win/crash_service.h index 730e4da3c6b2..7195ec2a958c 100644 --- a/atom/common/crash_reporter/win/crash_service.h +++ b/atom/common/crash_reporter/win/crash_service.h @@ -37,7 +37,8 @@ class CrashService { // other members in that case. |operating_dir| is where the CrashService // should store breakpad's checkpoint file. |dumps_path| is the directory // where the crash dumps should be stored. - bool Initialize(const base::FilePath& operating_dir, + bool Initialize(const base::string16& application_name, + const base::FilePath& operating_dir, const base::FilePath& dumps_path); // Command line switches: diff --git a/atom/common/crash_reporter/win/crash_service_main.cc b/atom/common/crash_reporter/win/crash_service_main.cc index 0bd72deba9e9..7a5eeb10133a 100644 --- a/atom/common/crash_reporter/win/crash_service_main.cc +++ b/atom/common/crash_reporter/win/crash_service_main.cc @@ -77,7 +77,8 @@ int Main(const wchar_t* cmd) { cmd_line.AppendSwitchNative("pipe-name", pipe_name); breakpad::CrashService crash_service; - if (!crash_service.Initialize(operating_dir, operating_dir)) + if (!crash_service.Initialize(application_name, operating_dir, + operating_dir)) return 2; VLOG(1) << "Ready to process crash requests"; From c872b1a770c49df662fded29005ab760ed2dfe0c Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 4 Aug 2015 19:35:46 +0800 Subject: [PATCH 0767/1293] Use different name for window class name --- atom/common/crash_reporter/win/crash_service.cc | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/atom/common/crash_reporter/win/crash_service.cc b/atom/common/crash_reporter/win/crash_service.cc index 611c39219bfd..d315b0b9419e 100644 --- a/atom/common/crash_reporter/win/crash_service.cc +++ b/atom/common/crash_reporter/win/crash_service.cc @@ -26,6 +26,8 @@ namespace breakpad { namespace { const wchar_t kWaitEventFormat[] = L"$1CrashServiceWaitEvent"; +const wchar_t kClassNameFormat[] = L"$1CrashServiceWindow"; + const wchar_t kTestPipeName[] = L"\\\\.\\pipe\\ChromeCrashServices"; const wchar_t kGoogleReportURL[] = L"https://clients2.google.com/cr/report"; @@ -113,13 +115,18 @@ LRESULT __stdcall CrashSvcWndProc(HWND hwnd, UINT message, // This is the main and only application window. HWND g_top_window = NULL; -bool CreateTopWindow(HINSTANCE instance, bool visible) { +bool CreateTopWindow(HINSTANCE instance, + const base::string16& application_name, + bool visible) { + base::string16 class_name = ReplaceStringPlaceholders( + kClassNameFormat, application_name, NULL); + WNDCLASSEXW wcx = {0}; wcx.cbSize = sizeof(wcx); wcx.style = CS_HREDRAW | CS_VREDRAW; wcx.lpfnWndProc = CrashSvcWndProc; wcx.hInstance = instance; - wcx.lpszClassName = L"crash_svc_class"; + wcx.lpszClassName = class_name.c_str(); ATOM atom = ::RegisterClassExW(&wcx); DWORD style = visible ? WS_POPUPWINDOW | WS_VISIBLE : WS_OVERLAPPED; @@ -263,6 +270,7 @@ bool CrashService::Initialize(const base::string16& application_name, } if (!CreateTopWindow(::GetModuleHandleW(NULL), + application_name, !cmd_line.HasSwitch(kNoWindow))) { LOG(ERROR) << "could not create window"; if (security_attributes.lpSecurityDescriptor) From 613e5c77ea8386f37b8c6c3a89cbac7ed66936aa Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Tue, 4 Aug 2015 19:45:44 +0800 Subject: [PATCH 0768/1293] Check context menu when calling popContextMenu API. --- atom/browser/ui/win/notify_icon.cc | 3 +++ 1 file changed, 3 insertions(+) diff --git a/atom/browser/ui/win/notify_icon.cc b/atom/browser/ui/win/notify_icon.cc index fd9a90ae1d5d..962dc871b5b6 100644 --- a/atom/browser/ui/win/notify_icon.cc +++ b/atom/browser/ui/win/notify_icon.cc @@ -162,6 +162,9 @@ void NotifyIcon::DisplayBalloon(const gfx::Image& icon, } void NotifyIcon::PopContextMenu(const gfx::Point& pos) { + // Returns if context menu isn't set. + if (!menu_model_) + return; // Set our window as the foreground window, so the context menu closes when // we click away from it. if (!SetForegroundWindow(window_)) From 7910fe7785dafcb6b16780c5414bca382dc0efd4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Machist=C3=A9=20N=2E=20Quintana?= Date: Tue, 4 Aug 2015 08:27:17 -0400 Subject: [PATCH 0769/1293] Only build pushes on Travis for master branch [ci skip] --- .travis.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.travis.yml b/.travis.yml index ff7272e3e576..4d4cd5dde9f0 100644 --- a/.travis.yml +++ b/.travis.yml @@ -22,3 +22,7 @@ matrix: - env: TARGET_ARCH=ia32 script: './script/cibuild' + +branches: + only: + - master From 50f226e34e3a8c27628b62890f9075eb137312c2 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 4 Aug 2015 21:56:17 +0800 Subject: [PATCH 0770/1293] win: Use app name as default title of message box TaskDialogIndirect doesn't allow empty name, if we set empty title it will show "electron.exe" in title. --- atom/browser/ui/message_box_win.cc | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/atom/browser/ui/message_box_win.cc b/atom/browser/ui/message_box_win.cc index 58d1badc3bfd..051f8f5eff6c 100644 --- a/atom/browser/ui/message_box_win.cc +++ b/atom/browser/ui/message_box_win.cc @@ -10,6 +10,7 @@ #include #include +#include "atom/browser/browser.h" #include "atom/browser/native_window_views.h" #include "base/callback.h" #include "base/strings/string_util.h" @@ -87,7 +88,12 @@ int ShowMessageBoxUTF16(HWND parent, config.hInstance = GetModuleHandle(NULL); config.dwFlags = flags; - if (!title.empty()) + // TaskDialogIndirect doesn't allow empty name, if we set empty title it + // will show "electron.exe" in title. + base::string16 app_name = base::UTF8ToUTF16(Browser::Get()->GetName()); + if (title.empty()) + config.pszWindowTitle = app_name.c_str(); + else config.pszWindowTitle = title.c_str(); base::win::ScopedHICON hicon; From 6b65a6611996523f9f26d1e6e408a7cddf7d1b35 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 4 Aug 2015 22:52:44 +0800 Subject: [PATCH 0771/1293] Update brightray for #2263 --- vendor/brightray | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/brightray b/vendor/brightray index 328fde765587..f4470ee48a74 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit 328fde7655872f48285582af82a40e60118493f1 +Subproject commit f4470ee48a748888bccba21845bfd65caaa1a6ce From 3b05b135a513d658f216009faab3e9b6745cdd5c Mon Sep 17 00:00:00 2001 From: Robo Date: Wed, 5 Aug 2015 01:42:57 +0530 Subject: [PATCH 0772/1293] tracing: fix api and docs --- atom/browser/api/atom_api_content_tracing.cc | 32 +++++++++++++++++--- atom/browser/api/lib/content-tracing.coffee | 6 ---- docs/api/content-tracing.md | 30 +++++++++++++----- 3 files changed, 50 insertions(+), 18 deletions(-) diff --git a/atom/browser/api/atom_api_content_tracing.cc b/atom/browser/api/atom_api_content_tracing.cc index 6da450185cd7..9507d19d399a 100644 --- a/atom/browser/api/atom_api_content_tracing.cc +++ b/atom/browser/api/atom_api_content_tracing.cc @@ -7,6 +7,7 @@ #include "atom/common/native_mate_converters/file_path_converter.h" #include "base/bind.h" +#include "base/files/file_util.h" #include "content/public/browser/tracing_controller.h" #include "native_mate/callback.h" #include "native_mate/dictionary.h" @@ -46,6 +47,31 @@ struct Converter { namespace { +using CompletionCallback = base::Callback; + +scoped_refptr GetTraceDataSink( + const base::FilePath& path, const CompletionCallback& callback) { + base::FilePath result_file_path = path; + if (result_file_path.empty() && !base::CreateTemporaryFile(&result_file_path)) + LOG(ERROR) << "Creating temporary file failed"; + + return TracingController::CreateFileSink(result_file_path, + base::Bind(callback, + result_file_path)); +} + +void StopRecording(const base::FilePath& path, + const CompletionCallback& callback) { + TracingController::GetInstance()->DisableRecording( + GetTraceDataSink(path, callback)); +} + +void CaptureMonitoringSnapshot(const base::FilePath& path, + const CompletionCallback& callback) { + TracingController::GetInstance()->CaptureMonitoringSnapshot( + GetTraceDataSink(path, callback)); +} + void Initialize(v8::Local exports, v8::Local unused, v8::Local context, void* priv) { auto controller = base::Unretained(TracingController::GetInstance()); @@ -54,14 +80,12 @@ void Initialize(v8::Local exports, v8::Local unused, &TracingController::GetCategories, controller)); dict.SetMethod("startRecording", base::Bind( &TracingController::EnableRecording, controller)); - dict.SetMethod("stopRecording", base::Bind( - &TracingController::DisableRecording, controller, nullptr)); + dict.SetMethod("stopRecording", &StopRecording); dict.SetMethod("startMonitoring", base::Bind( &TracingController::EnableMonitoring, controller)); dict.SetMethod("stopMonitoring", base::Bind( &TracingController::DisableMonitoring, controller)); - dict.SetMethod("captureMonitoringSnapshot", base::Bind( - &TracingController::CaptureMonitoringSnapshot, controller, nullptr)); + dict.SetMethod("captureMonitoringSnapshot", &CaptureMonitoringSnapshot); dict.SetMethod("getTraceBufferUsage", base::Bind( &TracingController::GetTraceBufferUsage, controller)); dict.SetMethod("setWatchEvent", base::Bind( diff --git a/atom/browser/api/lib/content-tracing.coffee b/atom/browser/api/lib/content-tracing.coffee index 774661a1b867..08cd36e4aa59 100644 --- a/atom/browser/api/lib/content-tracing.coffee +++ b/atom/browser/api/lib/content-tracing.coffee @@ -1,7 +1 @@ module.exports = process.atomBinding 'content_tracing' - -# Mirrored from content::TracingController::Options -module.exports.DEFAULT_OPTIONS = 0 -module.exports.ENABLE_SYSTRACE = 1 << 0 -module.exports.ENABLE_SAMPLING = 1 << 1 -module.exports.RECORD_CONTINUOUSLY = 1 << 2 diff --git a/docs/api/content-tracing.md b/docs/api/content-tracing.md index c7575ba8a23f..eab7b15d7129 100644 --- a/docs/api/content-tracing.md +++ b/docs/api/content-tracing.md @@ -28,10 +28,10 @@ are reached. Once all child processes have acked to the `getCategories` request, `callback` is invoked with an array of category groups. -## tracing.startRecording(categoryFilter, options, callback) +## tracing.startRecording(categoryFilter, traceOptions, callback) * `categoryFilter` String -* `options` Integer +* `traceOptions` String * `callback` Function Start recording on all processes. @@ -51,9 +51,23 @@ Examples: * `test_MyTest*,test_OtherStuff`, * `"-excluded_category1,-excluded_category2` -`options` controls what kind of tracing is enabled, it could be a OR-ed -combination of `tracing.DEFAULT_OPTIONS`, `tracing.ENABLE_SYSTRACE`, -`tracing.ENABLE_SAMPLING` and `tracing.RECORD_CONTINUOUSLY`. +`traceOptions` controls what kind of tracing is enabled, it is a comma-delimited list. +Possible options are: + +* `record-until-full` +* `record-continuously` +* `trace-to-console` +* `enable-sampling` +* `enable-systrace` + +The first 3 options are trace recoding modes and hence mutually exclusive. +If more than one trace recording modes appear in the `traceOptions` string, +the last one takes precedence. If none of the trace recording mode is specified, +recording mode is `record-until-full`. + +The trace option will first be reset to the default option (record_mode set to +`record-until-full`, enable_sampling and enable_systrace set to false) +before options parsed from `traceOptions` are applied on it. ## tracing.stopRecording(resultFilePath, callback) @@ -75,10 +89,10 @@ Trace data will be written into `resultFilePath` if it is not empty, or into a temporary file. The actual file path will be passed to `callback` if it's not null. -## tracing.startMonitoring(categoryFilter, options, callback) +## tracing.startMonitoring(categoryFilter, traceOptions, callback) * `categoryFilter` String -* `options` Integer +* `traceOptions` String * `callback` Function Start monitoring on all processes. @@ -107,7 +121,7 @@ Get the current monitoring traced data. Child processes typically are caching trace data and only rarely flush and send trace data back to the main process. That is because it may be an expensive -operation to send the trace data over IPC, and we would like to avoid unneeded +operation to send the trace data over IPC, and we would like to avoid unneeded runtime overhead of tracing. So, to end tracing, we must asynchronously ask all child processes to flush any pending trace data. From 58c04862365b421000f042b12e33047537f9c110 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 5 Aug 2015 12:32:22 +0800 Subject: [PATCH 0773/1293] Remove duplicate UpdateDraggableRegions --- atom/browser/native_window.cc | 28 ++++++++++++++++++++++ atom/browser/native_window.h | 15 ++++++++---- atom/browser/native_window_mac.h | 9 -------- atom/browser/native_window_mac.mm | 36 ++--------------------------- atom/browser/native_window_views.cc | 27 ++-------------------- atom/browser/native_window_views.h | 7 ------ 6 files changed, 43 insertions(+), 79 deletions(-) diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index d3c40f928272..c9d68df640a5 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -68,6 +68,25 @@ const char* kWebRuntimeFeatures[] = { switches::kPageVisibility, }; +// Convert draggable regions in raw format to SkRegion format. Caller is +// responsible for deleting the returned SkRegion instance. +SkRegion* DraggableRegionsToSkRegion( + const std::vector& regions) { + SkRegion* sk_region = new SkRegion; + for (std::vector::const_iterator iter = regions.begin(); + iter != regions.end(); + ++iter) { + const DraggableRegion& region = *iter; + sk_region->op( + region.bounds.x(), + region.bounds.y(), + region.bounds.right(), + region.bounds.bottom(), + region.draggable ? SkRegion::kUnion_Op : SkRegion::kDifference_Op); + } + return sk_region; +} + } // namespace NativeWindow::NativeWindow( @@ -559,6 +578,15 @@ bool NativeWindow::OnMessageReceived(const IPC::Message& message) { return handled; } +void NativeWindow::UpdateDraggableRegions( + const std::vector& regions) { + // Draggable region is not supported for non-frameless window. + if (has_frame_) + return; + + draggable_region_.reset(DraggableRegionsToSkRegion(regions)); +} + void NativeWindow::ScheduleUnresponsiveEvent(int ms) { if (!window_unresposive_closure_.IsCancelled()) return; diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index b9c2486b791b..611ff82011c5 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -23,6 +23,8 @@ #include "ui/gfx/image/image.h" #include "ui/gfx/image/image_skia.h" +class SkRegion; + namespace base { class CommandLine; } @@ -217,6 +219,7 @@ class NativeWindow : public content::WebContentsObserver, } bool has_frame() const { return has_frame_; } + SkRegion* draggable_region() const { return draggable_region_.get(); } void set_has_dialog_attached(bool has_dialog_attached) { has_dialog_attached_ = has_dialog_attached; @@ -226,10 +229,6 @@ class NativeWindow : public content::WebContentsObserver, NativeWindow(brightray::InspectableWebContents* inspectable_web_contents, const mate::Dictionary& options); - // Called when the window needs to update its draggable region. - virtual void UpdateDraggableRegions( - const std::vector& regions) = 0; - // brightray::InspectableWebContentsViewDelegate: void DevToolsFocused() override; void DevToolsOpened() override; @@ -257,6 +256,10 @@ class NativeWindow : public content::WebContentsObserver, ObserverList observers_; private: + // Called when the window needs to update its draggable region. + void UpdateDraggableRegions( + const std::vector& regions); + // Schedule a notification unresponsive event. void ScheduleUnresponsiveEvent(int ms); @@ -298,6 +301,10 @@ class NativeWindow : public content::WebContentsObserver, // The page this window is viewing. brightray::InspectableWebContents* inspectable_web_contents_; + // For custom drag, the whole window is non-draggable and the draggable region + // has to been explicitly provided. + scoped_ptr draggable_region_; // used in custom drag. + base::WeakPtrFactory weak_factory_; DISALLOW_COPY_AND_ASSIGN(NativeWindow); diff --git a/atom/browser/native_window_mac.h b/atom/browser/native_window_mac.h index 67f4389ff703..e54dc6ad87f6 100644 --- a/atom/browser/native_window_mac.h +++ b/atom/browser/native_window_mac.h @@ -11,13 +11,11 @@ #include #include "base/mac/scoped_nsobject.h" -#include "base/memory/scoped_ptr.h" #include "atom/browser/native_window.h" @class AtomNSWindow; @class AtomNSWindowDelegate; @class FullSizeContentView; -class SkRegion; namespace atom { @@ -88,9 +86,6 @@ class NativeWindowMac : public NativeWindow { void ClipWebView(); protected: - void UpdateDraggableRegions( - const std::vector& regions) override; - // NativeWindow: void HandleKeyboardEvent( content::WebContents*, @@ -117,10 +112,6 @@ class NativeWindowMac : public NativeWindow { // The presentation options before entering kiosk mode. NSApplicationPresentationOptions kiosk_options_; - // For custom drag, the whole window is non-draggable and the draggable region - // has to been explicitly provided. - scoped_ptr draggable_region_; // used in custom drag. - // Mouse location since the last mouse event, in screen coordinates. This is // used in custom drag to compute the window movement. NSPoint last_mouse_offset_; diff --git a/atom/browser/native_window_mac.mm b/atom/browser/native_window_mac.mm index 295c0ac5400a..8a0955b2903c 100644 --- a/atom/browser/native_window_mac.mm +++ b/atom/browser/native_window_mac.mm @@ -318,29 +318,6 @@ static const CGFloat kAtomWindowCornerRadius = 4.0; namespace atom { -namespace { - -// Convert draggable regions in raw format to SkRegion format. Caller is -// responsible for deleting the returned SkRegion instance. -SkRegion* DraggableRegionsToSkRegion( - const std::vector& regions) { - SkRegion* sk_region = new SkRegion; - for (std::vector::const_iterator iter = regions.begin(); - iter != regions.end(); - ++iter) { - const DraggableRegion& region = *iter; - sk_region->op( - region.bounds.x(), - region.bounds.y(), - region.bounds.right(), - region.bounds.bottom(), - region.draggable ? SkRegion::kUnion_Op : SkRegion::kDifference_Op); - } - return sk_region; -} - -} // namespace - NativeWindowMac::NativeWindowMac( brightray::InspectableWebContents* web_contents, const mate::Dictionary& options) @@ -747,7 +724,7 @@ bool NativeWindowMac::IsVisibleOnAllWorkspaces() { } bool NativeWindowMac::IsWithinDraggableRegion(NSPoint point) const { - if (!draggable_region_) + if (!draggable_region()) return false; if (!web_contents()) return false; @@ -756,7 +733,7 @@ bool NativeWindowMac::IsWithinDraggableRegion(NSPoint point) const { // |draggable_region_| is stored in local platform-indepdent coordiate system // while |point| is in local Cocoa coordinate system. Do the conversion // to match these two. - return draggable_region_->contains(point.x, webViewHeight - point.y); + return draggable_region()->contains(point.x, webViewHeight - point.y); } void NativeWindowMac::HandleMouseEvent(NSEvent* event) { @@ -776,15 +753,6 @@ void NativeWindowMac::HandleMouseEvent(NSEvent* event) { } } -void NativeWindowMac::UpdateDraggableRegions( - const std::vector& regions) { - // Draggable region is not supported for non-frameless window. - if (has_frame_) - return; - - draggable_region_.reset(DraggableRegionsToSkRegion(regions)); -} - void NativeWindowMac::HandleKeyboardEvent( content::WebContents*, const content::NativeWebKeyboardEvent& event) { diff --git a/atom/browser/native_window_views.cc b/atom/browser/native_window_views.cc index 62cf51f4d84e..35aea41eb549 100644 --- a/atom/browser/native_window_views.cc +++ b/atom/browser/native_window_views.cc @@ -753,29 +753,6 @@ gfx::AcceleratedWidget NativeWindowViews::GetAcceleratedWidget() { return GetNativeWindow()->GetHost()->GetAcceleratedWidget(); } -void NativeWindowViews::UpdateDraggableRegions( - const std::vector& regions) { - if (has_frame_) - return; - - SkRegion* draggable_region = new SkRegion; - - // By default, the whole window is non-draggable. We need to explicitly - // include those draggable regions. - for (std::vector::const_iterator iter = regions.begin(); - iter != regions.end(); ++iter) { - const DraggableRegion& region = *iter; - draggable_region->op( - region.bounds.x(), - region.bounds.y(), - region.bounds.right(), - region.bounds.bottom(), - region.draggable ? SkRegion::kUnion_Op : SkRegion::kDifference_Op); - } - - draggable_region_.reset(draggable_region); -} - void NativeWindowViews::OnWidgetActivationChanged( views::Widget* widget, bool active) { if (widget != window_.get()) @@ -858,8 +835,8 @@ bool NativeWindowViews::ShouldDescendIntoChildForEventHandling( gfx::NativeView child, const gfx::Point& location) { // App window should claim mouse events that fall within the draggable region. - if (draggable_region_ && - draggable_region_->contains(location.x(), location.y())) + if (draggable_region() && + draggable_region()->contains(location.x(), location.y())) return false; // And the events on border for dragging resizable frameless window. diff --git a/atom/browser/native_window_views.h b/atom/browser/native_window_views.h index fa7e13c1c335..dcf1f603a4f4 100644 --- a/atom/browser/native_window_views.h +++ b/atom/browser/native_window_views.h @@ -82,14 +82,9 @@ class NativeWindowViews : public NativeWindow, gfx::AcceleratedWidget GetAcceleratedWidget(); - SkRegion* draggable_region() const { return draggable_region_.get(); } views::Widget* widget() const { return window_.get(); } private: - // NativeWindow: - void UpdateDraggableRegions( - const std::vector& regions) override; - // views::WidgetObserver: void OnWidgetActivationChanged( views::Widget* widget, bool active) override; @@ -177,8 +172,6 @@ class NativeWindowViews : public NativeWindow, gfx::Size maximum_size_; gfx::Size widget_size_; - scoped_ptr draggable_region_; - DISALLOW_COPY_AND_ASSIGN(NativeWindowViews); }; From 438a5acc0f7eefd90b706fbf276a99dae5a43d26 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 5 Aug 2015 12:34:45 +0800 Subject: [PATCH 0774/1293] Use ranged for loop --- atom/browser/native_window.cc | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index c9d68df640a5..0461b7d74eb8 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -70,13 +70,10 @@ const char* kWebRuntimeFeatures[] = { // Convert draggable regions in raw format to SkRegion format. Caller is // responsible for deleting the returned SkRegion instance. -SkRegion* DraggableRegionsToSkRegion( +scoped_ptr DraggableRegionsToSkRegion( const std::vector& regions) { - SkRegion* sk_region = new SkRegion; - for (std::vector::const_iterator iter = regions.begin(); - iter != regions.end(); - ++iter) { - const DraggableRegion& region = *iter; + scoped_ptr sk_region(new SkRegion); + for (const DraggableRegion& region : regions) { sk_region->op( region.bounds.x(), region.bounds.y(), @@ -84,7 +81,7 @@ SkRegion* DraggableRegionsToSkRegion( region.bounds.bottom(), region.draggable ? SkRegion::kUnion_Op : SkRegion::kDifference_Op); } - return sk_region; + return sk_region.Pass(); } } // namespace @@ -583,8 +580,7 @@ void NativeWindow::UpdateDraggableRegions( // Draggable region is not supported for non-frameless window. if (has_frame_) return; - - draggable_region_.reset(DraggableRegionsToSkRegion(regions)); + draggable_region_ = DraggableRegionsToSkRegion(regions); } void NativeWindow::ScheduleUnresponsiveEvent(int ms) { From 58b1172025ad754939aeefe7af2f2fe4b3e225ea Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 5 Aug 2015 12:46:32 +0800 Subject: [PATCH 0775/1293] Avoid exposing data members to subclass --- atom/browser/native_window.cc | 6 +++++ atom/browser/native_window.h | 41 ++++++++++++++++------------- atom/browser/native_window_mac.mm | 18 ++++++------- atom/browser/native_window_views.cc | 34 +++++++++++------------- 4 files changed, 53 insertions(+), 46 deletions(-) diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 0461b7d74eb8..96085846bca8 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -522,6 +522,12 @@ void NativeWindow::NotifyWindowLeaveHtmlFullScreen() { OnWindowLeaveHtmlFullScreen()); } +void NativeWindow::NotifyWindowExecuteWindowsCommand( + const std::string& command) { + FOR_EACH_OBSERVER(NativeWindowObserver, observers_, + OnExecuteWindowsCommand(command)); +} + void NativeWindow::DevToolsFocused() { FOR_EACH_OBSERVER(NativeWindowObserver, observers_, OnDevToolsFocus()); } diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index 611ff82011c5..8919d529df03 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -205,11 +205,11 @@ class NativeWindow : public content::WebContentsObserver, void NotifyWindowLeaveFullScreen(); void NotifyWindowEnterHtmlFullScreen(); void NotifyWindowLeaveHtmlFullScreen(); + void NotifyWindowExecuteWindowsCommand(const std::string& command); void AddObserver(NativeWindowObserver* obs) { observers_.AddObserver(obs); } - void RemoveObserver(NativeWindowObserver* obs) { observers_.RemoveObserver(obs); } @@ -219,7 +219,10 @@ class NativeWindow : public content::WebContentsObserver, } bool has_frame() const { return has_frame_; } + bool transparent() const { return transparent_; } SkRegion* draggable_region() const { return draggable_region_.get(); } + bool enable_larger_than_screen() const { return enable_larger_than_screen_; } + gfx::ImageSkia icon() const { return icon_; } void set_has_dialog_attached(bool has_dialog_attached) { has_dialog_attached_ = has_dialog_attached; @@ -240,21 +243,6 @@ class NativeWindow : public content::WebContentsObserver, void TitleWasSet(content::NavigationEntry* entry, bool explicit_set) override; bool OnMessageReceived(const IPC::Message& message) override; - // Whether window has standard frame. - bool has_frame_; - - // Whether window is transparent. - bool transparent_; - - // Whether window can be resized larger than screen. - bool enable_larger_than_screen_; - - // Window icon. - gfx::ImageSkia icon_; - - // Observers of this window. - ObserverList observers_; - private: // Called when the window needs to update its draggable region. void UpdateDraggableRegions( @@ -271,6 +259,22 @@ class NativeWindow : public content::WebContentsObserver, const SkBitmap& bitmap, content::ReadbackResponse response); + // Whether window has standard frame. + bool has_frame_; + + // Whether window is transparent. + bool transparent_; + + // For custom drag, the whole window is non-draggable and the draggable region + // has to been explicitly provided. + scoped_ptr draggable_region_; // used in custom drag. + + // Whether window can be resized larger than screen. + bool enable_larger_than_screen_; + + // Window icon. + gfx::ImageSkia icon_; + // The windows has been closed. bool is_closed_; @@ -301,9 +305,8 @@ class NativeWindow : public content::WebContentsObserver, // The page this window is viewing. brightray::InspectableWebContents* inspectable_web_contents_; - // For custom drag, the whole window is non-draggable and the draggable region - // has to been explicitly provided. - scoped_ptr draggable_region_; // used in custom drag. + // Observers of this window. + ObserverList observers_; base::WeakPtrFactory weak_factory_; diff --git a/atom/browser/native_window_mac.mm b/atom/browser/native_window_mac.mm index 8a0955b2903c..d9ac903590f2 100644 --- a/atom/browser/native_window_mac.mm +++ b/atom/browser/native_window_mac.mm @@ -340,7 +340,7 @@ NativeWindowMac::NativeWindowMac( NSUInteger styleMask = NSTitledWindowMask | NSClosableWindowMask | NSMiniaturizableWindowMask | NSResizableWindowMask; - if (!useStandardWindow || transparent_ || !has_frame_) { + if (!useStandardWindow || transparent() || !has_frame()) { styleMask |= NSTexturedBackgroundWindowMask; } @@ -350,12 +350,12 @@ NativeWindowMac::NativeWindowMac( backing:NSBackingStoreBuffered defer:YES]); [window_ setShell:this]; - [window_ setEnableLargerThanScreen:enable_larger_than_screen_]; + [window_ setEnableLargerThanScreen:enable_larger_than_screen()]; window_delegate_.reset([[AtomNSWindowDelegate alloc] initWithShell:this]); [window_ setDelegate:window_delegate_]; - if (transparent_) { + if (transparent()) { // Make window has transparent background. [window_ setOpaque:NO]; [window_ setHasShadow:NO]; @@ -363,7 +363,7 @@ NativeWindowMac::NativeWindowMac( } // Remove non-transparent corners, see http://git.io/vfonD. - if (!has_frame_) + if (!has_frame()) [window_ setOpaque:NO]; // We will manage window's lifetime ourselves. @@ -372,7 +372,7 @@ NativeWindowMac::NativeWindowMac( // On OS X the initial window size doesn't include window frame. bool use_content_size = false; options.Get(switches::kUseContentSize, &use_content_size); - if (!has_frame_ || !use_content_size) + if (!has_frame() || !use_content_size) SetSize(gfx::Size(width, height)); // Enable the NSView to accept first mouse event. @@ -509,7 +509,7 @@ gfx::Rect NativeWindowMac::GetBounds() { } void NativeWindowMac::SetContentSize(const gfx::Size& size) { - if (!has_frame_) { + if (!has_frame()) { SetSize(size); return; } @@ -527,7 +527,7 @@ void NativeWindowMac::SetContentSize(const gfx::Size& size) { } gfx::Size NativeWindowMac::GetContentSize() { - if (!has_frame_) + if (!has_frame()) return GetSize(); NSRect bounds = [[window_ contentView] bounds]; @@ -588,7 +588,7 @@ void NativeWindowMac::Center() { void NativeWindowMac::SetTitle(const std::string& title) { // We don't want the title to show in transparent window. - if (transparent_) + if (transparent()) return; [window_ setTitle:base::SysUTF8ToNSString(title)]; @@ -779,7 +779,7 @@ void NativeWindowMac::HandleKeyboardEvent( void NativeWindowMac::InstallView() { NSView* view = inspectable_web_contents()->GetView()->GetNativeView(); - if (has_frame_) { + if (has_frame()) { // Add layer with white background for the contents view. base::scoped_nsobject layer([[CALayer alloc] init]); [layer setBackgroundColor:CGColorGetConstantColor(kCGColorWhite)]; diff --git a/atom/browser/native_window_views.cc b/atom/browser/native_window_views.cc index 35aea41eb549..cb28f2dd9871 100644 --- a/atom/browser/native_window_views.cc +++ b/atom/browser/native_window_views.cc @@ -232,7 +232,7 @@ NativeWindowViews::NativeWindowViews( options.Get(switches::kResizable, &resizable_); #endif - if (enable_larger_than_screen_) + if (enable_larger_than_screen()) // We need to set a default maximum window size here otherwise Windows // will not allow us to resize the window larger than scree. // Setting directly to INT_MAX somehow doesn't work, so we just devide @@ -252,9 +252,9 @@ NativeWindowViews::NativeWindowViews( params.bounds = bounds; params.delegate = this; params.type = views::Widget::InitParams::TYPE_WINDOW; - params.remove_standard_frame = !has_frame_; + params.remove_standard_frame = !has_frame(); - if (transparent_) + if (transparent()) params.opacity = views::Widget::InitParams::TRANSLUCENT_WINDOW; #if defined(USE_X11) @@ -312,24 +312,24 @@ NativeWindowViews::NativeWindowViews( set_background(views::Background::CreateStandardPanelBackground()); AddChildView(web_view_); - if (has_frame_ && + if (has_frame() && options.Get(switches::kUseContentSize, &use_content_size_) && use_content_size_) bounds = ContentBoundsToWindowBounds(bounds); #if defined(OS_WIN) - if (!has_frame_) { + if (!has_frame()) { // Set Window style so that we get a minimize and maximize animation when // frameless. DWORD frame_style = WS_THICKFRAME | WS_MINIMIZEBOX | WS_MAXIMIZEBOX | WS_CAPTION; // We should not show a frame for transparent window. - if (transparent_) + if (transparent()) frame_style &= ~(WS_THICKFRAME | WS_CAPTION); ::SetWindowLong(GetAcceleratedWidget(), GWL_STYLE, frame_style); } - if (transparent_) { + if (transparent()) { // Transparent window on Windows has to have WS_EX_COMPOSITED style. LONG ex_style = ::GetWindowLong(GetAcceleratedWidget(), GWL_EXSTYLE); ex_style |= WS_EX_COMPOSITED; @@ -339,14 +339,14 @@ NativeWindowViews::NativeWindowViews( // TODO(zcbenz): This was used to force using native frame on Windows 2003, we // should check whether setting it in InitParams can work. - if (has_frame_) { + if (has_frame()) { window_->set_frame_type(views::Widget::FrameType::FRAME_TYPE_FORCE_NATIVE); window_->FrameTypeChanged(); } // The given window is most likely not rectangular since it uses // transparency and has no standard frame, don't show a shadow for it. - if (transparent_ && !has_frame_) + if (transparent() && !has_frame()) wm::SetShadowType(GetNativeWindow(), wm::SHADOW_TYPE_NONE); window_->UpdateWindowIcon(); @@ -469,7 +469,7 @@ gfx::Rect NativeWindowViews::GetBounds() { } void NativeWindowViews::SetContentSize(const gfx::Size& size) { - if (!has_frame_) { + if (!has_frame()) { NativeWindow::SetSize(size); return; } @@ -480,7 +480,7 @@ void NativeWindowViews::SetContentSize(const gfx::Size& size) { } gfx::Size NativeWindowViews::GetContentSize() { - if (!has_frame_) + if (!has_frame()) return GetSize(); gfx::Size content_size = @@ -628,7 +628,7 @@ void NativeWindowViews::SetMenu(ui::MenuModel* menu_model) { #endif // Do not show menu bar in frameless window. - if (!has_frame_) + if (!has_frame()) return; if (!menu_bar_) { @@ -812,7 +812,7 @@ bool NativeWindowViews::ShouldHandleSystemCommands() const { } gfx::ImageSkia NativeWindowViews::GetWindowAppIcon() { - return icon_; + return icon(); } gfx::ImageSkia NativeWindowViews::GetWindowIcon() { @@ -840,7 +840,7 @@ bool NativeWindowViews::ShouldDescendIntoChildForEventHandling( return false; // And the events on border for dragging resizable frameless window. - if (!has_frame_ && CanResize()) { + if (!has_frame() && CanResize()) { FramelessView* frame = static_cast( window_->non_client_view()->frame_view()); return frame->ResizingBorderHitTest(location) == HTNOWHERE; @@ -860,7 +860,7 @@ views::NonClientFrameView* NativeWindowViews::CreateNonClientFrameView( frame_view->Init(this, widget); return frame_view; #else - if (has_frame_) { + if (has_frame()) { return new NativeFrameView(this, widget); } else { FramelessView* frame_view = new FramelessView; @@ -892,9 +892,7 @@ bool NativeWindowViews::ExecuteWindowsCommand(int command_id) { NotifyWindowMaximize(); } else { std::string command = AppCommandToString(command_id); - FOR_EACH_OBSERVER(NativeWindowObserver, - observers_, - OnExecuteWindowsCommand(command)); + NotifyWindowExecuteWindowsCommand(command); } return false; } From adbb909b39238254b55f12ab432de380adb1ae0c Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 5 Aug 2015 13:16:03 +0800 Subject: [PATCH 0776/1293] Move ShouldUseGlobalMenuBar to x_window_utils --- atom/browser/native_window_views.cc | 39 ----------------------------- atom/browser/ui/x/x_window_utils.cc | 36 ++++++++++++++++++++++++++ atom/browser/ui/x/x_window_utils.h | 3 +++ 3 files changed, 39 insertions(+), 39 deletions(-) diff --git a/atom/browser/native_window_views.cc b/atom/browser/native_window_views.cc index cb28f2dd9871..63867111040f 100644 --- a/atom/browser/native_window_views.cc +++ b/atom/browser/native_window_views.cc @@ -43,9 +43,6 @@ #include "base/nix/xdg_util.h" #include "base/strings/string_util.h" #include "chrome/browser/ui/libgtk2ui/unity_service.h" -#include "dbus/bus.h" -#include "dbus/object_proxy.h" -#include "dbus/message.h" #include "ui/base/x/x11_util.h" #include "ui/gfx/x/x11_types.h" #include "ui/views/window/native_frame_view.h" @@ -70,42 +67,6 @@ const int kMenuBarHeight = 20; const int kMenuBarHeight = 25; #endif -#if defined(USE_X11) -// Returns true if the bus name "com.canonical.AppMenu.Registrar" is available. -bool ShouldUseGlobalMenuBar() { - dbus::Bus::Options options; - scoped_refptr bus(new dbus::Bus(options)); - - dbus::ObjectProxy* object_proxy = - bus->GetObjectProxy(DBUS_SERVICE_DBUS, dbus::ObjectPath(DBUS_PATH_DBUS)); - dbus::MethodCall method_call(DBUS_INTERFACE_DBUS, "ListNames"); - scoped_ptr response(object_proxy->CallMethodAndBlock( - &method_call, dbus::ObjectProxy::TIMEOUT_USE_DEFAULT)); - if (!response) { - bus->ShutdownAndBlock(); - return false; - } - - dbus::MessageReader reader(response.get()); - dbus::MessageReader array_reader(NULL); - if (!reader.PopArray(&array_reader)) { - bus->ShutdownAndBlock(); - return false; - } - while (array_reader.HasMoreData()) { - std::string name; - if (array_reader.PopString(&name) && - name == "com.canonical.AppMenu.Registrar") { - bus->ShutdownAndBlock(); - return true; - } - } - - bus->ShutdownAndBlock(); - return false; -} -#endif - bool IsAltKey(const content::NativeWebKeyboardEvent& event) { #if defined(USE_X11) // 164 and 165 represent VK_LALT and VK_RALT. diff --git a/atom/browser/ui/x/x_window_utils.cc b/atom/browser/ui/x/x_window_utils.cc index eaef5475b777..a15affb05f1b 100644 --- a/atom/browser/ui/x/x_window_utils.cc +++ b/atom/browser/ui/x/x_window_utils.cc @@ -7,6 +7,9 @@ #include #include "base/strings/string_util.h" +#include "dbus/bus.h" +#include "dbus/object_proxy.h" +#include "dbus/message.h" #include "ui/base/x/x11_util.h" namespace atom { @@ -46,4 +49,37 @@ void SetWindowType(::Window xwindow, const std::string& type) { reinterpret_cast(&window_type), 1); } +bool ShouldUseGlobalMenuBar() { + dbus::Bus::Options options; + scoped_refptr bus(new dbus::Bus(options)); + + dbus::ObjectProxy* object_proxy = + bus->GetObjectProxy(DBUS_SERVICE_DBUS, dbus::ObjectPath(DBUS_PATH_DBUS)); + dbus::MethodCall method_call(DBUS_INTERFACE_DBUS, "ListNames"); + scoped_ptr response(object_proxy->CallMethodAndBlock( + &method_call, dbus::ObjectProxy::TIMEOUT_USE_DEFAULT)); + if (!response) { + bus->ShutdownAndBlock(); + return false; + } + + dbus::MessageReader reader(response.get()); + dbus::MessageReader array_reader(NULL); + if (!reader.PopArray(&array_reader)) { + bus->ShutdownAndBlock(); + return false; + } + while (array_reader.HasMoreData()) { + std::string name; + if (array_reader.PopString(&name) && + name == "com.canonical.AppMenu.Registrar") { + bus->ShutdownAndBlock(); + return true; + } + } + + bus->ShutdownAndBlock(); + return false; +} + } // namespace atom diff --git a/atom/browser/ui/x/x_window_utils.h b/atom/browser/ui/x/x_window_utils.h index ccf56d1eb9cf..16f3ddac6ccd 100644 --- a/atom/browser/ui/x/x_window_utils.h +++ b/atom/browser/ui/x/x_window_utils.h @@ -22,6 +22,9 @@ void SetWMSpecState(::Window xwindow, bool enabled, ::Atom state); // Sets the _NET_WM_WINDOW_TYPE of window. void SetWindowType(::Window xwindow, const std::string& type); +// Returns true if the bus name "com.canonical.AppMenu.Registrar" is available. +bool ShouldUseGlobalMenuBar(); + } // namespace atom #endif // ATOM_BROWSER_UI_X_X_WINDOW_UTILS_H_ From bbd6c927b1e3a146ce78787c5ea8fb6227466608 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 5 Aug 2015 13:18:41 +0800 Subject: [PATCH 0777/1293] Remove a few unused headers --- atom/browser/native_window_views.cc | 3 --- 1 file changed, 3 deletions(-) diff --git a/atom/browser/native_window_views.cc b/atom/browser/native_window_views.cc index 63867111040f..5f3472a7ffdb 100644 --- a/atom/browser/native_window_views.cc +++ b/atom/browser/native_window_views.cc @@ -20,7 +20,6 @@ #include "brightray/browser/inspectable_web_contents_view.h" #include "content/public/browser/native_web_keyboard_event.h" #include "native_mate/dictionary.h" -#include "ui/aura/window.h" #include "ui/aura/window_tree_host.h" #include "ui/base/hit_test.h" #include "ui/gfx/image/image.h" @@ -39,8 +38,6 @@ #include "atom/browser/ui/views/native_frame_view.h" #include "atom/browser/ui/x/window_state_watcher.h" #include "atom/browser/ui/x/x_window_utils.h" -#include "base/environment.h" -#include "base/nix/xdg_util.h" #include "base/strings/string_util.h" #include "chrome/browser/ui/libgtk2ui/unity_service.h" #include "ui/base/x/x11_util.h" From 54af048f04c3194530081c56e10c567a14195339 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Sun, 2 Aug 2015 11:11:29 +0800 Subject: [PATCH 0778/1293] win: Add BrowserWindow.setThumbarButtons API. --- atom/browser/api/atom_api_window.cc | 34 +++++ atom/browser/api/atom_api_window.h | 8 ++ .../atom_desktop_window_tree_host_win.cc | 44 +++++++ .../atom_desktop_window_tree_host_win.h | 41 ++++++ atom/browser/native_window.h | 8 ++ atom/browser/native_window_views.cc | 22 ++++ atom/browser/native_window_views.h | 9 ++ atom/browser/ui/win/thumbar_host.cc | 122 ++++++++++++++++++ atom/browser/ui/win/thumbar_host.h | 51 ++++++++ filenames.gypi | 4 + 10 files changed, 343 insertions(+) create mode 100644 atom/browser/atom_desktop_window_tree_host_win.cc create mode 100644 atom/browser/atom_desktop_window_tree_host_win.h create mode 100644 atom/browser/ui/win/thumbar_host.cc create mode 100644 atom/browser/ui/win/thumbar_host.h diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index 5f7c2503fced..bcdc57c3c704 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -20,6 +20,30 @@ #include "atom/common/node_includes.h" +#if defined(OS_WIN) +#include "atom/browser/ui/win/thumbar_host.h" +#endif + +namespace mate { + +#if defined(OS_WIN) +template<> +struct Converter { + static bool FromV8(v8::Isolate* isolate, v8::Handle val, + atom::ThumbarHost::ThumbarButton* out) { + mate::Dictionary dict; + if (!ConvertFromV8(isolate, val, &dict)) + return false; + dict.Get("click", &(out->clicked_callback)); + dict.Get("tooltip", &(out->tooltip)); + dict.Get("flags", &out->flags); + return dict.Get("icon", &(out->icon)); + } +}; +#endif + +} // namespace mate + namespace atom { namespace api { @@ -413,6 +437,13 @@ void Window::SetOverlayIcon(const gfx::Image& overlay, window_->SetOverlayIcon(overlay, description); } +#if defined(OS_WIN) +void Window::SetThumbarButtons( + const std::vector& buttons) { + window_->SetThumbarButtons(buttons); +} +#endif + void Window::SetMenu(v8::Isolate* isolate, v8::Local value) { mate::Handle menu; if (value->IsObject() && @@ -538,6 +569,9 @@ void Window::BuildPrototype(v8::Isolate* isolate, .SetMethod("capturePage", &Window::CapturePage) .SetMethod("setProgressBar", &Window::SetProgressBar) .SetMethod("setOverlayIcon", &Window::SetOverlayIcon) +#if defined(OS_WIN) + .SetMethod("setThumbarButtons", &Window::SetThumbarButtons) +#endif .SetMethod("setMenu", &Window::SetMenu) .SetMethod("setAutoHideMenuBar", &Window::SetAutoHideMenuBar) .SetMethod("isMenuBarAutoHide", &Window::IsMenuBarAutoHide) diff --git a/atom/browser/api/atom_api_window.h b/atom/browser/api/atom_api_window.h index cc2b3a64b5e9..fdb10825a6ca 100644 --- a/atom/browser/api/atom_api_window.h +++ b/atom/browser/api/atom_api_window.h @@ -14,6 +14,10 @@ #include "atom/browser/native_window_observer.h" #include "native_mate/handle.h" +#if defined(OS_WIN) +#include "atom/browser/ui/win/thumbar_host.h" +#endif + class GURL; namespace gfx { @@ -129,6 +133,10 @@ class Window : public mate::TrackableObject, void SetProgressBar(double progress); void SetOverlayIcon(const gfx::Image& overlay, const std::string& description); +#if defined(OS_WIN) + void SetThumbarButtons( + const std::vector& buttons); +#endif void SetMenu(v8::Isolate* isolate, v8::Local menu); void SetAutoHideMenuBar(bool auto_hide); bool IsMenuBarAutoHide(); diff --git a/atom/browser/atom_desktop_window_tree_host_win.cc b/atom/browser/atom_desktop_window_tree_host_win.cc new file mode 100644 index 000000000000..9c5ebf0f42c2 --- /dev/null +++ b/atom/browser/atom_desktop_window_tree_host_win.cc @@ -0,0 +1,44 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#include "atom/browser/atom_desktop_window_tree_host_win.h" +#include "atom/browser/ui/win/thumbar_host.h" + +namespace atom { + +AtomDesktopWindowTreeHostWin::AtomDesktopWindowTreeHostWin( + views::internal::NativeWidgetDelegate* native_widget_delegate, + views::DesktopNativeWidgetAura* desktop_native_widget_aura) + : views::DesktopWindowTreeHostWin(native_widget_delegate, + desktop_native_widget_aura) { +} + +AtomDesktopWindowTreeHostWin::~AtomDesktopWindowTreeHostWin() { +} + +bool AtomDesktopWindowTreeHostWin::SetThumbarButtons( + HWND window, + const std::vector& buttons) { + if (!thumbar_host_.get()) { + thumbar_host_.reset(new ThumbarHost(window)); + } + return thumbar_host_->SetThumbarButtons(buttons); +} + +bool AtomDesktopWindowTreeHostWin::PreHandleMSG(UINT message, + WPARAM w_param, + LPARAM l_param, + LRESULT* result) { + switch (message) { + case WM_COMMAND: { + int id = LOWORD(w_param); + if (thumbar_host_ && thumbar_host_->HandleThumbarButtonEvent(id)) + return true; + } + } + + return false; +} + +} // namespace atom diff --git a/atom/browser/atom_desktop_window_tree_host_win.h b/atom/browser/atom_desktop_window_tree_host_win.h new file mode 100644 index 000000000000..0271d06e6af2 --- /dev/null +++ b/atom/browser/atom_desktop_window_tree_host_win.h @@ -0,0 +1,41 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#ifndef ATOM_BROWSER_ATOM_DESKTOP_WINDOW_TREE_HOST_WIN_H_ +#define ATOM_BROWSER_ATOM_DESKTOP_WINDOW_TREE_HOST_WIN_H_ + +#include + +#include + +#include "atom/browser/ui/win/thumbar_host.h" +#include "base/memory/scoped_ptr.h" +#include "ui/views/widget/desktop_aura/desktop_window_tree_host_win.h" + +namespace atom { + +class AtomDesktopWindowTreeHostWin : public views::DesktopWindowTreeHostWin { + public: + AtomDesktopWindowTreeHostWin( + views::internal::NativeWidgetDelegate* native_widget_delegate, + views::DesktopNativeWidgetAura* desktop_native_widget_aura); + ~AtomDesktopWindowTreeHostWin(); + + bool SetThumbarButtons( + HWND window, + const std::vector& buttons); + + protected: + bool PreHandleMSG(UINT message, + WPARAM w_param, + LPARAM l_param, + LRESULT* result) override; + + private: + scoped_ptr thumbar_host_; +}; + +} // namespace atom + +#endif // ATOM_BROWSER_ATOM_DESKTOP_WINDOW_TREE_HOST_WIN_H_ diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index 8919d529df03..0ae22214f563 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -23,6 +23,10 @@ #include "ui/gfx/image/image.h" #include "ui/gfx/image/image_skia.h" +#if defined(OS_WIN) +#include "atom/browser/ui/win/thumbar_host.h" +#endif + class SkRegion; namespace base { @@ -144,6 +148,10 @@ class NativeWindow : public content::WebContentsObserver, const std::string& description) = 0; virtual void SetVisibleOnAllWorkspaces(bool visible) = 0; virtual bool IsVisibleOnAllWorkspaces() = 0; +#if defined(OS_WIN) + virtual bool SetThumbarButtons( + const std::vector& buttons) = 0; +#endif virtual bool IsClosed() const { return is_closed_; } diff --git a/atom/browser/native_window_views.cc b/atom/browser/native_window_views.cc index 5f3472a7ffdb..e0221fbde597 100644 --- a/atom/browser/native_window_views.cc +++ b/atom/browser/native_window_views.cc @@ -27,6 +27,7 @@ #include "ui/views/controls/webview/unhandled_keyboard_event_handler.h" #include "ui/views/controls/webview/webview.h" #include "ui/views/window/client_view.h" +#include "ui/views/widget/desktop_aura/desktop_native_widget_aura.h" #include "ui/views/widget/native_widget_private.h" #include "ui/views/widget/widget.h" #include "ui/wm/core/shadow_types.h" @@ -44,6 +45,7 @@ #include "ui/gfx/x/x11_types.h" #include "ui/views/window/native_frame_view.h" #elif defined(OS_WIN) +#include "atom/browser/atom_desktop_window_tree_host_win.h" #include "atom/browser/ui/views/win_frame_view.h" #include "base/win/scoped_comptr.h" #include "base/win/windows_version.h" @@ -215,6 +217,14 @@ NativeWindowViews::NativeWindowViews( if (transparent()) params.opacity = views::Widget::InitParams::TRANSLUCENT_WINDOW; +#if defined(OS_WIN) + params.native_widget = + new views::DesktopNativeWidgetAura(window_.get()); + atom_desktop_window_tree_host_win_ = new AtomDesktopWindowTreeHostWin( + window_.get(), + static_cast(params.native_widget)); + params.desktop_window_tree_host = atom_desktop_window_tree_host_win_; +#endif #if defined(USE_X11) std::string name = Browser::Get()->GetName(); // Set WM_WINDOW_ROLE. @@ -707,6 +717,18 @@ bool NativeWindowViews::IsVisibleOnAllWorkspaces() { return false; } +#if defined(OS_WIN) +bool NativeWindowViews::SetThumbarButtons( + const std::vector& buttons) { + if (atom_desktop_window_tree_host_win_) { + return atom_desktop_window_tree_host_win_->SetThumbarButtons( + views::HWNDForNativeWindow(window_->GetNativeWindow()), + buttons); + } + return false; +} +#endif + gfx::AcceleratedWidget NativeWindowViews::GetAcceleratedWidget() { return GetNativeWindow()->GetHost()->GetAcceleratedWidget(); } diff --git a/atom/browser/native_window_views.h b/atom/browser/native_window_views.h index dcf1f603a4f4..94c0c04373f7 100644 --- a/atom/browser/native_window_views.h +++ b/atom/browser/native_window_views.h @@ -23,6 +23,9 @@ namespace atom { class GlobalMenuBarX11; class MenuBar; class WindowStateWatcher; +#if defined(OS_WIN) +class AtomDesktopWindowTreeHostWin; +#endif class NativeWindowViews : public NativeWindow, public views::WidgetDelegateView, @@ -79,6 +82,10 @@ class NativeWindowViews : public NativeWindow, bool IsMenuBarVisible() override; void SetVisibleOnAllWorkspaces(bool visible) override; bool IsVisibleOnAllWorkspaces() override; +#if defined(OS_WIN) + bool SetThumbarButtons( + const std::vector& buttons) override; +#endif gfx::AcceleratedWidget GetAcceleratedWidget(); @@ -154,6 +161,8 @@ class NativeWindowViews : public NativeWindow, // Handles window state events. scoped_ptr window_state_watcher_; #elif defined(OS_WIN) + // Weak ref. + AtomDesktopWindowTreeHostWin* atom_desktop_window_tree_host_win_; // Records window was whether restored from minimized state or maximized // state. bool is_minimized_; diff --git a/atom/browser/ui/win/thumbar_host.cc b/atom/browser/ui/win/thumbar_host.cc new file mode 100644 index 000000000000..22e9ba8c4169 --- /dev/null +++ b/atom/browser/ui/win/thumbar_host.cc @@ -0,0 +1,122 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#include "atom/browser/ui/win/thumbar_host.h" + +#include + +#include "base/win/scoped_comptr.h" +#include "base/win/win_util.h" +#include "base/win/wrapped_window_proc.h" +#include "base/strings/utf_string_conversions.h" +#include "third_party/skia/include/core/SkBitmap.h" +#include "ui/gfx/icon_util.h" +#include "ui/gfx/win/hwnd_util.h" + +namespace atom { + +namespace { + +// The thumbnail toolbar has a maximum of seven buttons due to the limited room. +const int kMaxButtonsCount = 7; + +bool GetThumbarButtonFlags(const std::vector& flags, + THUMBBUTTONFLAGS* out) { + if (flags.empty()) { + *out = THBF_ENABLED; + return true; + } + THUMBBUTTONFLAGS result = static_cast(0); + for (const auto& flag : flags) { + if (flag == "enabled") { + result |= THBF_ENABLED; + } else if (flag == "disabled") { + result |= THBF_DISABLED; + } else if (flag == "dismissonclick") { + result |= THBF_DISMISSONCLICK; + } else if (flag == "nobackground") { + result |= THBF_NOBACKGROUND; + } else if (flag == "hidden") { + result |= THBF_HIDDEN; + } else if (flag == "noninteractive") { + result |= THBF_NONINTERACTIVE; + } else { + return false; + } + } + *out = result; + return true; +} + +} // namespace + +ThumbarHost::ThumbarHost(HWND window) : is_initialized_(false), + window_(window) { +} + +ThumbarHost::~ThumbarHost() { +} + +bool ThumbarHost::SetThumbarButtons( + const std::vector& buttons) { + THUMBBUTTON thumb_buttons[kMaxButtonsCount]; + thumbar_button_clicked_callback_map_.clear(); + + // Once a toolbar with a set of buttons is added to thumbnail, there is no way + // to remove it without re-creating the window. + // To achieve to re-set thumbar buttons, we initialize the buttons with + // HIDDEN state and only updated the caller's specified buttons. + // + // Initialize all thumb buttons with HIDDEN state. + for (int i = 0; i < kMaxButtonsCount; ++i) { + thumb_buttons[i].iId = i; + thumb_buttons[i].dwFlags = THBF_HIDDEN; + } + + // Update the callers' specified buttons. + for (size_t i = 0; i < buttons.size(); ++i) { + if (!GetThumbarButtonFlags(buttons[i].flags, &thumb_buttons[i].dwFlags)) + return false; + thumb_buttons[i].dwMask = THB_ICON | THB_FLAGS; + thumb_buttons[i].hIcon = IconUtil::CreateHICONFromSkBitmap( + buttons[i].icon.AsBitmap()); + if (!buttons[i].tooltip.empty()) { + thumb_buttons[i].dwMask |= THB_TOOLTIP; + wcscpy_s(thumb_buttons[i].szTip, + base::UTF8ToUTF16(buttons[i].tooltip).c_str()); + } + + thumbar_button_clicked_callback_map_[i] = + buttons[i].clicked_callback; + } + + base::win::ScopedComPtr taskbar; + if (FAILED(taskbar.CreateInstance(CLSID_TaskbarList, + nullptr, + CLSCTX_INPROC_SERVER)) || + FAILED(taskbar->HrInit())) { + return false; + } + if (!is_initialized_) { + is_initialized_ = true; + return taskbar->ThumbBarAddButtons( + window_, kMaxButtonsCount, thumb_buttons) == S_OK; + } + + return taskbar->ThumbBarUpdateButtons( + window_, kMaxButtonsCount, thumb_buttons) == S_OK; +} + +bool ThumbarHost::HandleThumbarButtonEvent(int button_id) { + if (thumbar_button_clicked_callback_map_.find(button_id) != + thumbar_button_clicked_callback_map_.end()) { + auto callback = thumbar_button_clicked_callback_map_[button_id]; + if (!callback.is_null()) + callback.Run(); + return true; + } + return false; +} + +} // namespace atom diff --git a/atom/browser/ui/win/thumbar_host.h b/atom/browser/ui/win/thumbar_host.h new file mode 100644 index 000000000000..2ab3b06a381d --- /dev/null +++ b/atom/browser/ui/win/thumbar_host.h @@ -0,0 +1,51 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#ifndef ATOM_BROWSER_UI_WIN_THUMBAR_HOST_H_ +#define ATOM_BROWSER_UI_WIN_THUMBAR_HOST_H_ + +#include + +#include +#include +#include + +#include "base/callback.h" +#include "ui/gfx/image/image.h" + +namespace atom { + +class ThumbarHost { + public: + using ThumbarButtonClickedCallback = base::Callback; + + struct ThumbarButton { + std::string tooltip; + gfx::Image icon; + std::vector flags; + ThumbarButtonClickedCallback clicked_callback; + }; + + explicit ThumbarHost(HWND window); + ~ThumbarHost(); + + bool SetThumbarButtons( + const std::vector& buttons); + bool HandleThumbarButtonEvent(int button_id); + + private: + using ThumbarButtonClickedCallbackMap = std::map< + int, ThumbarButtonClickedCallback>; + ThumbarButtonClickedCallbackMap thumbar_button_clicked_callback_map_; + + bool is_initialized_; + + HWND window_; + + DISALLOW_COPY_AND_ASSIGN(ThumbarHost); +}; + +} // namespace atom + +#endif // ATOM_BROWSER_UI_WIN_THUMBAR_HOST_H_ diff --git a/filenames.gypi b/filenames.gypi index 82f9ea95d078..3b3d3a4cc48f 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -119,6 +119,8 @@ 'atom/browser/atom_browser_main_parts.h', 'atom/browser/atom_browser_main_parts_linux.cc', 'atom/browser/atom_browser_main_parts_mac.mm', + "atom/browser/atom_desktop_window_tree_host_win.cc", + "atom/browser/atom_desktop_window_tree_host_win.h", 'atom/browser/atom_javascript_dialog_manager.cc', 'atom/browser/atom_javascript_dialog_manager.h', 'atom/browser/atom_quota_permission_context.cc', @@ -206,6 +208,8 @@ 'atom/browser/ui/win/notify_icon_host.h', 'atom/browser/ui/win/notify_icon.cc', 'atom/browser/ui/win/notify_icon.h', + 'atom/browser/ui/win/thumbar_host.cc', + 'atom/browser/ui/win/thumbar_host.h', 'atom/browser/ui/x/window_state_watcher.cc', 'atom/browser/ui/x/window_state_watcher.h', 'atom/browser/ui/x/x_window_utils.cc', From 97ab780305abda01e3aacc9898e0967d798b3649 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Sun, 2 Aug 2015 13:07:55 +0800 Subject: [PATCH 0779/1293] :memo: BrowserWindow.setThumbarButton API. --- docs/api/browser-window.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index add5cfff8ba9..73f9c97de58d 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -643,6 +643,35 @@ Sets a 16px overlay onto the current taskbar icon, usually used to convey some s __Note:__ This API is only available on Windows (Windows 7 and above) + +### BrowserWindow.setThumbarButtons(buttons) + +* `buttons` Array of `button` objects + * `button` Object + * `icon` [NativeImage](native-image.md) - The icon showing in thumbnail toolbar. + * `tooltip` String - (Option) - The text of the button's tooltip. + * `flags` Array of Strings - (Option) Control specific states and behaviors + of the button. By default, it uses `enabled`. + * `enabled` - The button is active and available to the user. + * `disabled` - The button is disabled. It is present, but has a visual state + that indicates that it will not respond to user action. + * `dismissonclick` - When the button is clicked, the taskbar button's flyout + closes immediately. + * `nobackground` - Do not draw a button border, use only the image. + * `hidden` - The button is not shown to the user. + * `noninteractive` - The button is enabled but not interactive; no pressed + button state is drawn. This value is intended for instances where the button + is used in a notification. + * `click` - Function + +Add a thumbnail toolbar with a specified set of buttons to the thumbnail image of +a window in a taskbar button layout. + +__Note:__ This API is only available on Windows (Windows 7 and above). +Once you setup the thumbnail toolbar, the toolbar cannot be removed due to the +platform's limitation. But you can call the API with an empty array to clean the +buttons. + ### BrowserWindow.showDefinitionForSelection() Shows pop-up dictionary that searches the selected word on the page. From ad01a1731afa7d4c6f37eb960621c6baee6051b2 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Sun, 2 Aug 2015 13:09:42 +0800 Subject: [PATCH 0780/1293] :memo: say more about thumbnail toolbar. --- .../desktop-environment-integration.md | 54 +++++++++++++++++++ 1 file changed, 54 insertions(+) diff --git a/docs/tutorial/desktop-environment-integration.md b/docs/tutorial/desktop-environment-integration.md index 0691b15f4091..80b4c456938b 100644 --- a/docs/tutorial/desktop-environment-integration.md +++ b/docs/tutorial/desktop-environment-integration.md @@ -134,6 +134,59 @@ The user tasks will still show even after your application closes, so the icon and program path specified for a task should exist until your application is uninstalled. +## Thumbnail Toolbars + +On Windows, you can add a thumbnail toolbar with specified buttons in a taskbar +layout of an application window. It provides users a way to access to a particualr +window's command without restoring or activating the window. + +From MSDN, it's illustrated: + +> This toolbar is simply the familiar standard toolbar common control. It has a +> maximum of seven buttons. Each button's ID, image, tooltip, and state are defined +> in a structure, which is then passed to the taskbar. The application can show, +> enable, disable, or hide buttons from the thumbnail toolbar as required by its +> current state. +> +> For example, Windows Media Player might offer standard media transport controls +> such as play, pause, mute, and stop. + +__Thumbnail toolbar of Windows Media Player:__ + +![player](https://i-msdn.sec.s-msft.com/dynimg/IC420540.png) + +You can use [BrowserWindow.setThumbarButtons][setthumbarbuttons] to set thumbnail +toolbar in your application: + +``` +var BrowserWindow = require('browser-window'); +var path = require('path'); +var win = new BrowserWindow({ + width: 800, + height: 600 +}); +win.setThumbarButtons([ + { + tooltip: "button1", + icon: path.join(__dirname, 'button1.png'), + click: function() { console.log("button2 clicked"); } + }, + { + tooltip: "button2", + icon: path.join(__dirname, 'button2.png'), + flags:['enabled', 'dismissonclick'], + click: function() { console.log("button2 clicked."); } + } +]); +``` + +To clean thumbnail toolbar buttons, just call `BrowserWindow.setThumbarButtons` +with an empty array: + +```javascript +win.setThumbarButtons([]); +``` + ## Unity launcher shortcuts (Linux) In Unity, you can add custom entries to its launcher via modifying `.desktop` @@ -199,3 +252,4 @@ window.setDocumentEdited(true); [setdocumentedited]: ../api/browser-window.md#browserwindowsetdocumenteditededited [app-registration]: http://msdn.microsoft.com/en-us/library/windows/desktop/ee872121(v=vs.85).aspx [unity-launcher]: https://help.ubuntu.com/community/UnityLaunchersAndDesktopFiles#Adding_shortcuts_to_a_launcher +[setthumbarbuttons]: ../api/browser-window.md#browserwindowsetthumbarbuttonsbuttons From dfd076a3e5e364dfa0e1b02ad9d77ecc293bdd55 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Wed, 5 Aug 2015 13:04:21 +0800 Subject: [PATCH 0781/1293] Move atom_desktop_window_tree_host_win to atom/browser/ui/win directory. --- atom/browser/native_window_views.cc | 2 +- .../{ => ui/win}/atom_desktop_window_tree_host_win.cc | 2 +- .../{ => ui/win}/atom_desktop_window_tree_host_win.h | 6 +++--- 3 files changed, 5 insertions(+), 5 deletions(-) rename atom/browser/{ => ui/win}/atom_desktop_window_tree_host_win.cc (95%) rename atom/browser/{ => ui/win}/atom_desktop_window_tree_host_win.h (83%) diff --git a/atom/browser/native_window_views.cc b/atom/browser/native_window_views.cc index e0221fbde597..018f294b8df1 100644 --- a/atom/browser/native_window_views.cc +++ b/atom/browser/native_window_views.cc @@ -45,8 +45,8 @@ #include "ui/gfx/x/x11_types.h" #include "ui/views/window/native_frame_view.h" #elif defined(OS_WIN) -#include "atom/browser/atom_desktop_window_tree_host_win.h" #include "atom/browser/ui/views/win_frame_view.h" +#include "atom/browser/ui/win/atom_desktop_window_tree_host_win.h" #include "base/win/scoped_comptr.h" #include "base/win/windows_version.h" #include "ui/base/win/shell.h" diff --git a/atom/browser/atom_desktop_window_tree_host_win.cc b/atom/browser/ui/win/atom_desktop_window_tree_host_win.cc similarity index 95% rename from atom/browser/atom_desktop_window_tree_host_win.cc rename to atom/browser/ui/win/atom_desktop_window_tree_host_win.cc index 9c5ebf0f42c2..55912612ebba 100644 --- a/atom/browser/atom_desktop_window_tree_host_win.cc +++ b/atom/browser/ui/win/atom_desktop_window_tree_host_win.cc @@ -2,7 +2,7 @@ // Use of this source code is governed by the MIT license that can be // found in the LICENSE file. -#include "atom/browser/atom_desktop_window_tree_host_win.h" +#include "atom/browser/ui/win/atom_desktop_window_tree_host_win.h" #include "atom/browser/ui/win/thumbar_host.h" namespace atom { diff --git a/atom/browser/atom_desktop_window_tree_host_win.h b/atom/browser/ui/win/atom_desktop_window_tree_host_win.h similarity index 83% rename from atom/browser/atom_desktop_window_tree_host_win.h rename to atom/browser/ui/win/atom_desktop_window_tree_host_win.h index 0271d06e6af2..7f2abf801ad3 100644 --- a/atom/browser/atom_desktop_window_tree_host_win.h +++ b/atom/browser/ui/win/atom_desktop_window_tree_host_win.h @@ -2,8 +2,8 @@ // Use of this source code is governed by the MIT license that can be // found in the LICENSE file. -#ifndef ATOM_BROWSER_ATOM_DESKTOP_WINDOW_TREE_HOST_WIN_H_ -#define ATOM_BROWSER_ATOM_DESKTOP_WINDOW_TREE_HOST_WIN_H_ +#ifndef ATOM_BROWSER_UI_WIN_ATOM_DESKTOP_WINDOW_TREE_HOST_WIN_H_ +#define ATOM_BROWSER_UI_WIN_ATOM_DESKTOP_WINDOW_TREE_HOST_WIN_H_ #include @@ -38,4 +38,4 @@ class AtomDesktopWindowTreeHostWin : public views::DesktopWindowTreeHostWin { } // namespace atom -#endif // ATOM_BROWSER_ATOM_DESKTOP_WINDOW_TREE_HOST_WIN_H_ +#endif // ATOM_BROWSER_UI_WIN_ATOM_DESKTOP_WINDOW_TREE_HOST_WIN_H_ From 1505dc207be7a9b633ce6b8f5cc94c876875ff2c Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 5 Aug 2015 14:12:55 +0800 Subject: [PATCH 0782/1293] mac: Disable resizing window when changing style mask --- atom/browser/native_window_mac.mm | 30 ++++++++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/atom/browser/native_window_mac.mm b/atom/browser/native_window_mac.mm index d9ac903590f2..b0649c4a80cf 100644 --- a/atom/browser/native_window_mac.mm +++ b/atom/browser/native_window_mac.mm @@ -20,7 +20,26 @@ #include "content/public/browser/render_widget_host_view.h" #include "native_mate/dictionary.h" -static const CGFloat kAtomWindowCornerRadius = 4.0; +namespace { + +// The radius of rounded corner. +const CGFloat kAtomWindowCornerRadius = 4.0; + +// Prevents window from resizing during the scope. +class ScopedDisableResize { + public: + ScopedDisableResize() { disable_resize_ = true; } + ~ScopedDisableResize() { disable_resize_ = false; } + + static bool IsResizeDisabled() { return disable_resize_; } + + private: + static bool disable_resize_; +}; + +bool ScopedDisableResize::disable_resize_ = false; + +} // namespace @interface NSView (PrivateMethods) - (CGFloat)roundedCornerRadius; @@ -214,8 +233,12 @@ static const CGFloat kAtomWindowCornerRadius = 4.0; enable_larger_than_screen_ = enable; } -// Enable the window to be larger than screen. - (NSRect)constrainFrameRect:(NSRect)frameRect toScreen:(NSScreen*)screen { + // Resizing is disabled. + if (ScopedDisableResize::IsResizeDisabled()) + return [self frame]; + + // Enable the window to be larger than screen. if (enable_larger_than_screen_) return frameRect; else @@ -561,6 +584,9 @@ gfx::Size NativeWindowMac::GetMaximumSize() { } void NativeWindowMac::SetResizable(bool resizable) { + // Change styleMask for frameless causes the window to change size, so we have + // to explicitly disables that. + ScopedDisableResize disable_resize; if (resizable) { [[window_ standardWindowButton:NSWindowZoomButton] setEnabled:YES]; [window_ setStyleMask:[window_ styleMask] | NSResizableWindowMask]; From 5871428c8378eb01b417d97c6611eff1cb92e637 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 5 Aug 2015 14:20:08 +0800 Subject: [PATCH 0783/1293] spec: BrowserWindow.setResizable should not change window size --- spec/api-browser-window-spec.coffee | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/spec/api-browser-window-spec.coffee b/spec/api-browser-window-spec.coffee index 1b5705016831..fa7a8ae33a9c 100644 --- a/spec/api-browser-window-spec.coffee +++ b/spec/api-browser-window-spec.coffee @@ -129,6 +129,14 @@ describe 'browser-window module', -> it 'returns the window with id', -> assert.equal w.id, BrowserWindow.fromId(w.id).id + describe 'BrowserWindow.setResizable(resizable)', -> + it 'does not change window size for frameless window', -> + w.destroy() + w = new BrowserWindow(show: true, frame: false) + s = w.getSize() + w.setResizable not w.isResizable() + assert.deepEqual s, w.getSize() + describe '"use-content-size" option', -> it 'make window created with content size when used', -> w.destroy() From 2f04f76e699a65208ef14c273727f7bf1cc4fd7b Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 5 Aug 2015 15:49:37 +0800 Subject: [PATCH 0784/1293] ImageSkiaRep doesn't release memory --- atom/common/api/atom_api_native_image.cc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/atom/common/api/atom_api_native_image.cc b/atom/common/api/atom_api_native_image.cc index 7819e314178c..40a73a7de3f7 100644 --- a/atom/common/api/atom_api_native_image.cc +++ b/atom/common/api/atom_api_native_image.cc @@ -78,7 +78,7 @@ bool AddImageSkiaRep(gfx::ImageSkia* image, if (!decoded) return false; - image->AddRepresentation(gfx::ImageSkiaRep(*decoded.release(), scale_factor)); + image->AddRepresentation(gfx::ImageSkiaRep(*decoded, scale_factor)); return true; } From 78eac4116c656b7bb7cb2c539984726068cb7a71 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Wed, 5 Aug 2015 13:47:59 +0800 Subject: [PATCH 0785/1293] Polish thumbar code. * Fix a memory leak in thumbar initialization. * Check the number of thumbar buttons, should be <= 7. * Correct to check thumbar button click event. --- atom/browser/native_window_views.cc | 2 +- .../win/atom_desktop_window_tree_host_win.cc | 8 +++- atom/browser/ui/win/thumbar_host.cc | 43 +++++++++++++------ atom/browser/ui/win/thumbar_host.h | 2 +- docs/api/browser-window.md | 43 ++++++++++--------- filenames.gypi | 4 +- 6 files changed, 64 insertions(+), 38 deletions(-) diff --git a/atom/browser/native_window_views.cc b/atom/browser/native_window_views.cc index 018f294b8df1..eda98dc4f853 100644 --- a/atom/browser/native_window_views.cc +++ b/atom/browser/native_window_views.cc @@ -27,7 +27,6 @@ #include "ui/views/controls/webview/unhandled_keyboard_event_handler.h" #include "ui/views/controls/webview/webview.h" #include "ui/views/window/client_view.h" -#include "ui/views/widget/desktop_aura/desktop_native_widget_aura.h" #include "ui/views/widget/native_widget_private.h" #include "ui/views/widget/widget.h" #include "ui/wm/core/shadow_types.h" @@ -52,6 +51,7 @@ #include "ui/base/win/shell.h" #include "ui/gfx/icon_util.h" #include "ui/gfx/win/dpi.h" +#include "ui/views/widget/desktop_aura/desktop_native_widget_aura.h" #include "ui/views/win/hwnd_util.h" #endif diff --git a/atom/browser/ui/win/atom_desktop_window_tree_host_win.cc b/atom/browser/ui/win/atom_desktop_window_tree_host_win.cc index 55912612ebba..5c5833f64c09 100644 --- a/atom/browser/ui/win/atom_desktop_window_tree_host_win.cc +++ b/atom/browser/ui/win/atom_desktop_window_tree_host_win.cc @@ -3,6 +3,9 @@ // found in the LICENSE file. #include "atom/browser/ui/win/atom_desktop_window_tree_host_win.h" + +#include + #include "atom/browser/ui/win/thumbar_host.h" namespace atom { @@ -32,8 +35,11 @@ bool AtomDesktopWindowTreeHostWin::PreHandleMSG(UINT message, LRESULT* result) { switch (message) { case WM_COMMAND: { + // Handle thumbar button click message. int id = LOWORD(w_param); - if (thumbar_host_ && thumbar_host_->HandleThumbarButtonEvent(id)) + int thbn_message = HIWORD(w_param); + if (thbn_message == THBN_CLICKED && thumbar_host_ && + thumbar_host_->HandleThumbarButtonEvent(id)) return true; } } diff --git a/atom/browser/ui/win/thumbar_host.cc b/atom/browser/ui/win/thumbar_host.cc index 22e9ba8c4169..2d82cd4c6cdb 100644 --- a/atom/browser/ui/win/thumbar_host.cc +++ b/atom/browser/ui/win/thumbar_host.cc @@ -18,9 +18,14 @@ namespace atom { namespace { +// From MSDN: https://msdn.microsoft.com/en-us/library/windows/desktop/ +// dd378460(v=vs.85).aspx#thumbbars // The thumbnail toolbar has a maximum of seven buttons due to the limited room. const int kMaxButtonsCount = 7; +// The base id of Thumbar button. +const int kButtonIdBase = 40001; + bool GetThumbarButtonFlags(const std::vector& flags, THUMBBUTTONFLAGS* out) { if (flags.empty()) { @@ -60,7 +65,18 @@ ThumbarHost::~ThumbarHost() { bool ThumbarHost::SetThumbarButtons( const std::vector& buttons) { - THUMBBUTTON thumb_buttons[kMaxButtonsCount]; + if (buttons.size() > kMaxButtonsCount) + return false; + + base::win::ScopedComPtr taskbar; + if (FAILED(taskbar.CreateInstance(CLSID_TaskbarList, + nullptr, + CLSCTX_INPROC_SERVER)) || + FAILED(taskbar->HrInit())) { + return false; + } + + THUMBBUTTON thumb_buttons[kMaxButtonsCount] = {}; thumbar_button_clicked_callback_map_.clear(); // Once a toolbar with a set of buttons is added to thumbnail, there is no way @@ -70,7 +86,8 @@ bool ThumbarHost::SetThumbarButtons( // // Initialize all thumb buttons with HIDDEN state. for (int i = 0; i < kMaxButtonsCount; ++i) { - thumb_buttons[i].iId = i; + thumb_buttons[i].iId = kButtonIdBase + i; + thumb_buttons[i].dwMask = THB_FLAGS; // dwFlags is valid. thumb_buttons[i].dwFlags = THBF_HIDDEN; } @@ -87,25 +104,25 @@ bool ThumbarHost::SetThumbarButtons( base::UTF8ToUTF16(buttons[i].tooltip).c_str()); } - thumbar_button_clicked_callback_map_[i] = + thumbar_button_clicked_callback_map_[thumb_buttons[i].iId] = buttons[i].clicked_callback; } - base::win::ScopedComPtr taskbar; - if (FAILED(taskbar.CreateInstance(CLSID_TaskbarList, - nullptr, - CLSCTX_INPROC_SERVER)) || - FAILED(taskbar->HrInit())) { - return false; - } + bool is_success = false; if (!is_initialized_) { is_initialized_ = true; - return taskbar->ThumbBarAddButtons( + is_success = taskbar->ThumbBarAddButtons( + window_, kMaxButtonsCount, thumb_buttons) == S_OK; + } else { + is_success = taskbar->ThumbBarUpdateButtons( window_, kMaxButtonsCount, thumb_buttons) == S_OK; } - return taskbar->ThumbBarUpdateButtons( - window_, kMaxButtonsCount, thumb_buttons) == S_OK; + // Release thumb_buttons' icons, the taskbar makes its own copy. + for (size_t i = 0; i < buttons.size(); ++i) { + ::DestroyIcon(thumb_buttons[i].hIcon); + } + return is_success; } bool ThumbarHost::HandleThumbarButtonEvent(int button_id) { diff --git a/atom/browser/ui/win/thumbar_host.h b/atom/browser/ui/win/thumbar_host.h index 2ab3b06a381d..40d0ae7400e8 100644 --- a/atom/browser/ui/win/thumbar_host.h +++ b/atom/browser/ui/win/thumbar_host.h @@ -18,7 +18,7 @@ namespace atom { class ThumbarHost { public: - using ThumbarButtonClickedCallback = base::Callback; + using ThumbarButtonClickedCallback = base::Closure; struct ThumbarButton { std::string tooltip; diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 73f9c97de58d..60b9b84735d0 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -648,29 +648,32 @@ __Note:__ This API is only available on Windows (Windows 7 and above) * `buttons` Array of `button` objects * `button` Object - * `icon` [NativeImage](native-image.md) - The icon showing in thumbnail toolbar. - * `tooltip` String - (Option) - The text of the button's tooltip. - * `flags` Array of Strings - (Option) Control specific states and behaviors - of the button. By default, it uses `enabled`. - * `enabled` - The button is active and available to the user. - * `disabled` - The button is disabled. It is present, but has a visual state - that indicates that it will not respond to user action. - * `dismissonclick` - When the button is clicked, the taskbar button's flyout - closes immediately. - * `nobackground` - Do not draw a button border, use only the image. - * `hidden` - The button is not shown to the user. - * `noninteractive` - The button is enabled but not interactive; no pressed - button state is drawn. This value is intended for instances where the button - is used in a notification. - * `click` - Function + * `icon` [NativeImage](native-image.md) - The icon showing in thumbnail + toolbar. + * `tooltip` String - (Option) - The text of the button's tooltip. + * `flags` Array of Strings - (Option) Control specific states and behaviors + of the button. By default, it uses `enabled`. + * `enabled` - The button is active and available to the user. + * `disabled` - The button is disabled. It is present, but has a visual + state that indicates that it will not respond to user action. + * `dismissonclick` - When the button is clicked, the taskbar button's + flyout closes immediately. + * `nobackground` - Do not draw a button border, use only the image. + * `hidden` - The button is not shown to the user. + * `noninteractive` - The button is enabled but not interactive; no + pressed button state is drawn. This value is intended for instances + where the button is used in a notification. + * `click` - Function -Add a thumbnail toolbar with a specified set of buttons to the thumbnail image of -a window in a taskbar button layout. +Add a thumbnail toolbar with a specified set of buttons to the thumbnail image +of a window in a taskbar button layout. Returns a `Boolean` object indicates +whether the thumbnail has been added successfully. __Note:__ This API is only available on Windows (Windows 7 and above). -Once you setup the thumbnail toolbar, the toolbar cannot be removed due to the -platform's limitation. But you can call the API with an empty array to clean the -buttons. +The number of buttons in thumbnail toolbar should be no greater than 7 due to +the limited room. Once you setup the thumbnail toolbar, the toolbar cannot be +removed due to the platform's limitation. But you can call the API with an empty +array to clean the buttons. ### BrowserWindow.showDefinitionForSelection() diff --git a/filenames.gypi b/filenames.gypi index 3b3d3a4cc48f..45aaac7c2778 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -119,8 +119,6 @@ 'atom/browser/atom_browser_main_parts.h', 'atom/browser/atom_browser_main_parts_linux.cc', 'atom/browser/atom_browser_main_parts_mac.mm', - "atom/browser/atom_desktop_window_tree_host_win.cc", - "atom/browser/atom_desktop_window_tree_host_win.h", 'atom/browser/atom_javascript_dialog_manager.cc', 'atom/browser/atom_javascript_dialog_manager.h', 'atom/browser/atom_quota_permission_context.cc', @@ -204,6 +202,8 @@ 'atom/browser/ui/views/submenu_button.h', 'atom/browser/ui/views/win_frame_view.cc', 'atom/browser/ui/views/win_frame_view.h', + "atom/browser/ui/win/atom_desktop_window_tree_host_win.cc", + "atom/browser/ui/win/atom_desktop_window_tree_host_win.h", 'atom/browser/ui/win/notify_icon_host.cc', 'atom/browser/ui/win/notify_icon_host.h', 'atom/browser/ui/win/notify_icon.cc', From 6b8d4a43a34fc17c03471e8ecf3db4b19336390b Mon Sep 17 00:00:00 2001 From: Robo Date: Wed, 5 Aug 2015 13:33:08 +0530 Subject: [PATCH 0786/1293] override: intialise BrowserWindowProxy.closed --- atom/renderer/lib/override.coffee | 1 + spec/chromium-spec.coffee | 1 + 2 files changed, 2 insertions(+) diff --git a/atom/renderer/lib/override.coffee b/atom/renderer/lib/override.coffee index d0f1fabc4ac9..d8c6c0a86d79 100644 --- a/atom/renderer/lib/override.coffee +++ b/atom/renderer/lib/override.coffee @@ -11,6 +11,7 @@ resolveUrl = (url) -> # Window object returned by "window.open". class BrowserWindowProxy constructor: (@guestId) -> + @closed = false ipc.on 'ATOM_SHELL_GUEST_WINDOW_MANAGER_WINDOW_CLOSED', (guestId) => if guestId is @guestId @closed = true diff --git a/spec/chromium-spec.coffee b/spec/chromium-spec.coffee index 375f98966bea..32fd5bed6742 100644 --- a/spec/chromium-spec.coffee +++ b/spec/chromium-spec.coffee @@ -37,6 +37,7 @@ describe 'chromium feature', -> describe 'window.open', -> it 'returns a BrowserWindowProxy object', -> b = window.open 'about:blank', 'test', 'show=no' + assert.equal b.closed, false assert.equal b.constructor.name, 'BrowserWindowProxy' b.close() From 0a7a4c0d0a58bdc6cc3a060fb3a807c2fccd5686 Mon Sep 17 00:00:00 2001 From: Robo Date: Wed, 5 Aug 2015 17:20:23 +0530 Subject: [PATCH 0787/1293] webview: adding load-commit event --- atom/browser/lib/guest-view-manager.coffee | 1 + atom/browser/web_view_guest_delegate.cc | 8 ++++++++ atom/browser/web_view_guest_delegate.h | 3 +++ atom/renderer/lib/web-view/guest-view-internal.coffee | 2 ++ atom/renderer/lib/web-view/web-view-attributes.coffee | 2 +- atom/renderer/lib/web-view/web-view.coffee | 6 +++--- docs/api/web-view-tag.md | 9 +++++++++ 7 files changed, 27 insertions(+), 4 deletions(-) diff --git a/atom/browser/lib/guest-view-manager.coffee b/atom/browser/lib/guest-view-manager.coffee index 4385d389c39d..971c15cb1b85 100644 --- a/atom/browser/lib/guest-view-manager.coffee +++ b/atom/browser/lib/guest-view-manager.coffee @@ -3,6 +3,7 @@ webContents = require 'web-contents' webViewManager = null # Doesn't exist in early initialization. supportedWebViewEvents = [ + 'load-commit' 'did-finish-load' 'did-fail-load' 'did-frame-finish-load' diff --git a/atom/browser/web_view_guest_delegate.cc b/atom/browser/web_view_guest_delegate.cc index 98fa72da22d4..38f4da4c1f96 100644 --- a/atom/browser/web_view_guest_delegate.cc +++ b/atom/browser/web_view_guest_delegate.cc @@ -5,7 +5,9 @@ #include "atom/browser/web_view_guest_delegate.h" #include "atom/browser/api/atom_api_web_contents.h" +#include "atom/common/native_mate_converters/gurl_converter.h" #include "content/public/browser/guest_host.h" +#include "content/public/browser/render_frame_host.h" #include "content/public/browser/render_view_host.h" #include "content/public/browser/render_widget_host_view.h" @@ -128,6 +130,12 @@ void WebViewGuestDelegate::RenderViewReady() { render_view_host_view->SetBackgroundColor(SK_ColorTRANSPARENT); } +void WebViewGuestDelegate::DidCommitProvisionalLoadForFrame( + content::RenderFrameHost* render_frame_host, + const GURL& url, ui::PageTransition transition_type) { + api_web_contents_->Emit("load-commit", url, !render_frame_host->GetParent()); +} + void WebViewGuestDelegate::DidAttach(int guest_proxy_routing_id) { api_web_contents_->Emit("did-attach"); } diff --git a/atom/browser/web_view_guest_delegate.h b/atom/browser/web_view_guest_delegate.h index 267b5b248af6..3312b46104a0 100644 --- a/atom/browser/web_view_guest_delegate.h +++ b/atom/browser/web_view_guest_delegate.h @@ -59,6 +59,9 @@ class WebViewGuestDelegate : public content::BrowserPluginGuestDelegate, protected: // content::WebContentsObserver: void RenderViewReady() override; + void DidCommitProvisionalLoadForFrame( + content::RenderFrameHost* render_frame_host, + const GURL& url, ui::PageTransition transition_type) override; // content::BrowserPluginGuestDelegate: void DidAttach(int guest_proxy_routing_id) final; diff --git a/atom/renderer/lib/web-view/guest-view-internal.coffee b/atom/renderer/lib/web-view/guest-view-internal.coffee index b62418d146d9..44db5e304db4 100644 --- a/atom/renderer/lib/web-view/guest-view-internal.coffee +++ b/atom/renderer/lib/web-view/guest-view-internal.coffee @@ -4,6 +4,7 @@ webFrame = require 'web-frame' requestId = 0 WEB_VIEW_EVENTS = + 'load-commit': ['url', 'isMainFrame'] 'did-finish-load': [] 'did-fail-load': ['errorCode', 'errorDescription'] 'did-frame-finish-load': ['isMainFrame'] @@ -32,6 +33,7 @@ dispatchEvent = (webView, event, args...) -> for f, i in WEB_VIEW_EVENTS[event] domEvent[f] = args[i] webView.dispatchEvent domEvent + webView.onLoadCommit domEvent if event == 'load-commit' module.exports = registerEvents: (webView, viewInstanceId) -> diff --git a/atom/renderer/lib/web-view/web-view-attributes.coffee b/atom/renderer/lib/web-view/web-view-attributes.coffee index 82229aae57b1..acca826a9e3d 100644 --- a/atom/renderer/lib/web-view/web-view-attributes.coffee +++ b/atom/renderer/lib/web-view/web-view-attributes.coffee @@ -120,7 +120,7 @@ class SrcAttribute extends WebViewAttribute '' setValueIgnoreMutation: (value) -> - WebViewAttribute::setValueIgnoreMutation value + WebViewAttribute::setValueIgnoreMutation.call(this, value) # takeRecords() is needed to clear queued up src mutations. Without it, it # is possible for this change to get picked up asyncronously by src's # mutation observer |observer|, and then get handled even though we do not diff --git a/atom/renderer/lib/web-view/web-view.coffee b/atom/renderer/lib/web-view/web-view.coffee index eedee732938f..35fbe17796f4 100644 --- a/atom/renderer/lib/web-view/web-view.coffee +++ b/atom/renderer/lib/web-view/web-view.coffee @@ -157,10 +157,10 @@ class WebViewImpl enumerable: true # Updates state upon loadcommit. - onLoadCommit: (@baseUrlForDataUrl, @currentEntryIndex, @entryCount, @processId, url, isTopLevel) -> + onLoadCommit: (webViewEvent) -> oldValue = @webviewNode.getAttribute webViewConstants.ATTRIBUTE_SRC - newValue = url - if isTopLevel and (oldValue != newValue) + newValue = webViewEvent.url + if webViewEvent.isMainFrame and (oldValue != newValue) # Touching the src attribute triggers a navigation. To avoid # triggering a page reload on every guest-initiated navigation, # we do not handle this mutation diff --git a/docs/api/web-view-tag.md b/docs/api/web-view-tag.md index a74f5fb50c77..07d84324dd4b 100644 --- a/docs/api/web-view-tag.md +++ b/docs/api/web-view-tag.md @@ -335,6 +335,15 @@ examples. ## DOM events +### load-commit + +* `url` String +* `isMainFrame` Boolean + +Fired when a load has committed. This includes navigation within the current +document as well as subframe document-level loads, but does not include +asynchronous resource loads. + ### did-finish-load Fired when the navigation is done, i.e. the spinner of the tab will stop From 2f1cb8b52a195655f85be428a953c41c0644b039 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Wed, 5 Aug 2015 22:26:18 +0800 Subject: [PATCH 0788/1293] Expose NativeWindow.setThumbarButtons API to all platforms. --- atom/browser/api/atom_api_window.cc | 16 +++------------- atom/browser/api/atom_api_window.h | 9 ++------- atom/browser/native_window.cc | 5 +++++ atom/browser/native_window.h | 18 ++++++++++-------- atom/browser/native_window_views.cc | 6 +++--- atom/browser/native_window_views.h | 4 +--- .../win/atom_desktop_window_tree_host_win.cc | 3 ++- .../ui/win/atom_desktop_window_tree_host_win.h | 3 ++- atom/browser/ui/win/thumbar_host.cc | 6 ++++-- atom/browser/ui/win/thumbar_host.h | 17 +++-------------- 10 files changed, 35 insertions(+), 52 deletions(-) diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index bcdc57c3c704..0b2c8c9ece79 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -20,17 +20,12 @@ #include "atom/common/node_includes.h" -#if defined(OS_WIN) -#include "atom/browser/ui/win/thumbar_host.h" -#endif - namespace mate { -#if defined(OS_WIN) template<> -struct Converter { +struct Converter { static bool FromV8(v8::Isolate* isolate, v8::Handle val, - atom::ThumbarHost::ThumbarButton* out) { + atom::NativeWindow::ThumbarButton* out) { mate::Dictionary dict; if (!ConvertFromV8(isolate, val, &dict)) return false; @@ -40,7 +35,6 @@ struct Converter { return dict.Get("icon", &(out->icon)); } }; -#endif } // namespace mate @@ -437,12 +431,10 @@ void Window::SetOverlayIcon(const gfx::Image& overlay, window_->SetOverlayIcon(overlay, description); } -#if defined(OS_WIN) void Window::SetThumbarButtons( - const std::vector& buttons) { + const std::vector& buttons) { window_->SetThumbarButtons(buttons); } -#endif void Window::SetMenu(v8::Isolate* isolate, v8::Local value) { mate::Handle menu; @@ -569,9 +561,7 @@ void Window::BuildPrototype(v8::Isolate* isolate, .SetMethod("capturePage", &Window::CapturePage) .SetMethod("setProgressBar", &Window::SetProgressBar) .SetMethod("setOverlayIcon", &Window::SetOverlayIcon) -#if defined(OS_WIN) .SetMethod("setThumbarButtons", &Window::SetThumbarButtons) -#endif .SetMethod("setMenu", &Window::SetMenu) .SetMethod("setAutoHideMenuBar", &Window::SetAutoHideMenuBar) .SetMethod("isMenuBarAutoHide", &Window::IsMenuBarAutoHide) diff --git a/atom/browser/api/atom_api_window.h b/atom/browser/api/atom_api_window.h index fdb10825a6ca..7742c8a9fa9b 100644 --- a/atom/browser/api/atom_api_window.h +++ b/atom/browser/api/atom_api_window.h @@ -11,13 +11,10 @@ #include "base/memory/scoped_ptr.h" #include "ui/gfx/image/image.h" #include "atom/browser/api/trackable_object.h" +#include "atom/browser/native_window.h" #include "atom/browser/native_window_observer.h" #include "native_mate/handle.h" -#if defined(OS_WIN) -#include "atom/browser/ui/win/thumbar_host.h" -#endif - class GURL; namespace gfx { @@ -133,10 +130,8 @@ class Window : public mate::TrackableObject, void SetProgressBar(double progress); void SetOverlayIcon(const gfx::Image& overlay, const std::string& description); -#if defined(OS_WIN) void SetThumbarButtons( - const std::vector& buttons); -#endif + const std::vector& buttons); void SetMenu(v8::Isolate* isolate, v8::Local menu); void SetAutoHideMenuBar(bool auto_hide); bool IsMenuBarAutoHide(); diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 96085846bca8..91770af316e3 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -277,6 +277,11 @@ bool NativeWindow::HasModalDialog() { return has_dialog_attached_; } +bool NativeWindow::SetThumbarButtons( + const std::vector& buttons) { + return false; +} + void NativeWindow::FocusOnWebView() { web_contents()->GetRenderViewHost()->Focus(); } diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index 0ae22214f563..d461215222d6 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -23,10 +23,6 @@ #include "ui/gfx/image/image.h" #include "ui/gfx/image/image_skia.h" -#if defined(OS_WIN) -#include "atom/browser/ui/win/thumbar_host.h" -#endif - class SkRegion; namespace base { @@ -63,7 +59,15 @@ struct DraggableRegion; class NativeWindow : public content::WebContentsObserver, public brightray::InspectableWebContentsViewDelegate { public: - typedef base::Callback CapturePageCallback; + using CapturePageCallback = base::Callback; + using ThumbarButtonClickedCallback = base::Closure; + + struct ThumbarButton { + std::string tooltip; + gfx::Image icon; + std::vector flags; + ThumbarButtonClickedCallback clicked_callback; + }; class DialogScope { public: @@ -148,10 +152,8 @@ class NativeWindow : public content::WebContentsObserver, const std::string& description) = 0; virtual void SetVisibleOnAllWorkspaces(bool visible) = 0; virtual bool IsVisibleOnAllWorkspaces() = 0; -#if defined(OS_WIN) virtual bool SetThumbarButtons( - const std::vector& buttons) = 0; -#endif + const std::vector& buttons); virtual bool IsClosed() const { return is_closed_; } diff --git a/atom/browser/native_window_views.cc b/atom/browser/native_window_views.cc index eda98dc4f853..acb7de33f4d6 100644 --- a/atom/browser/native_window_views.cc +++ b/atom/browser/native_window_views.cc @@ -717,17 +717,17 @@ bool NativeWindowViews::IsVisibleOnAllWorkspaces() { return false; } -#if defined(OS_WIN) bool NativeWindowViews::SetThumbarButtons( - const std::vector& buttons) { + const std::vector& buttons) { +#if defined(OS_WIN) if (atom_desktop_window_tree_host_win_) { return atom_desktop_window_tree_host_win_->SetThumbarButtons( views::HWNDForNativeWindow(window_->GetNativeWindow()), buttons); } +#endif return false; } -#endif gfx::AcceleratedWidget NativeWindowViews::GetAcceleratedWidget() { return GetNativeWindow()->GetHost()->GetAcceleratedWidget(); diff --git a/atom/browser/native_window_views.h b/atom/browser/native_window_views.h index 94c0c04373f7..792a72c75624 100644 --- a/atom/browser/native_window_views.h +++ b/atom/browser/native_window_views.h @@ -82,10 +82,8 @@ class NativeWindowViews : public NativeWindow, bool IsMenuBarVisible() override; void SetVisibleOnAllWorkspaces(bool visible) override; bool IsVisibleOnAllWorkspaces() override; -#if defined(OS_WIN) bool SetThumbarButtons( - const std::vector& buttons) override; -#endif + const std::vector& buttons) override; gfx::AcceleratedWidget GetAcceleratedWidget(); diff --git a/atom/browser/ui/win/atom_desktop_window_tree_host_win.cc b/atom/browser/ui/win/atom_desktop_window_tree_host_win.cc index 5c5833f64c09..157cb610fb3a 100644 --- a/atom/browser/ui/win/atom_desktop_window_tree_host_win.cc +++ b/atom/browser/ui/win/atom_desktop_window_tree_host_win.cc @@ -6,6 +6,7 @@ #include +#include "atom/browser/native_window.h" #include "atom/browser/ui/win/thumbar_host.h" namespace atom { @@ -22,7 +23,7 @@ AtomDesktopWindowTreeHostWin::~AtomDesktopWindowTreeHostWin() { bool AtomDesktopWindowTreeHostWin::SetThumbarButtons( HWND window, - const std::vector& buttons) { + const std::vector& buttons) { if (!thumbar_host_.get()) { thumbar_host_.reset(new ThumbarHost(window)); } diff --git a/atom/browser/ui/win/atom_desktop_window_tree_host_win.h b/atom/browser/ui/win/atom_desktop_window_tree_host_win.h index 7f2abf801ad3..fc09b6503b80 100644 --- a/atom/browser/ui/win/atom_desktop_window_tree_host_win.h +++ b/atom/browser/ui/win/atom_desktop_window_tree_host_win.h @@ -9,6 +9,7 @@ #include +#include "atom/browser/native_window.h" #include "atom/browser/ui/win/thumbar_host.h" #include "base/memory/scoped_ptr.h" #include "ui/views/widget/desktop_aura/desktop_window_tree_host_win.h" @@ -24,7 +25,7 @@ class AtomDesktopWindowTreeHostWin : public views::DesktopWindowTreeHostWin { bool SetThumbarButtons( HWND window, - const std::vector& buttons); + const std::vector& buttons); protected: bool PreHandleMSG(UINT message, diff --git a/atom/browser/ui/win/thumbar_host.cc b/atom/browser/ui/win/thumbar_host.cc index 2d82cd4c6cdb..af57ef4e5c64 100644 --- a/atom/browser/ui/win/thumbar_host.cc +++ b/atom/browser/ui/win/thumbar_host.cc @@ -6,6 +6,8 @@ #include +#include + #include "base/win/scoped_comptr.h" #include "base/win/win_util.h" #include "base/win/wrapped_window_proc.h" @@ -64,7 +66,7 @@ ThumbarHost::~ThumbarHost() { } bool ThumbarHost::SetThumbarButtons( - const std::vector& buttons) { + const std::vector& buttons) { if (buttons.size() > kMaxButtonsCount) return false; @@ -112,7 +114,7 @@ bool ThumbarHost::SetThumbarButtons( if (!is_initialized_) { is_initialized_ = true; is_success = taskbar->ThumbBarAddButtons( - window_, kMaxButtonsCount, thumb_buttons) == S_OK; + window_, buttons.size(), thumb_buttons) == S_OK; } else { is_success = taskbar->ThumbBarUpdateButtons( window_, kMaxButtonsCount, thumb_buttons) == S_OK; diff --git a/atom/browser/ui/win/thumbar_host.h b/atom/browser/ui/win/thumbar_host.h index 40d0ae7400e8..d14bbaeda305 100644 --- a/atom/browser/ui/win/thumbar_host.h +++ b/atom/browser/ui/win/thumbar_host.h @@ -8,35 +8,24 @@ #include #include -#include #include -#include "base/callback.h" -#include "ui/gfx/image/image.h" +#include "atom/browser/native_window.h" namespace atom { class ThumbarHost { public: - using ThumbarButtonClickedCallback = base::Closure; - - struct ThumbarButton { - std::string tooltip; - gfx::Image icon; - std::vector flags; - ThumbarButtonClickedCallback clicked_callback; - }; - explicit ThumbarHost(HWND window); ~ThumbarHost(); bool SetThumbarButtons( - const std::vector& buttons); + const std::vector& buttons); bool HandleThumbarButtonEvent(int button_id); private: using ThumbarButtonClickedCallbackMap = std::map< - int, ThumbarButtonClickedCallback>; + int, NativeWindow::ThumbarButtonClickedCallback>; ThumbarButtonClickedCallbackMap thumbar_button_clicked_callback_map_; bool is_initialized_; From d175a685864371ae28e5fd4d803570b9c144777c Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 6 Aug 2015 10:15:27 +0800 Subject: [PATCH 0789/1293] Add MessageHandlerDelegate --- atom/browser/native_window_views.cc | 4 +-- atom/browser/native_window_views.h | 7 +++++ .../win/atom_desktop_window_tree_host_win.cc | 4 ++- .../win/atom_desktop_window_tree_host_win.h | 15 +++++++---- .../ui/win/message_handler_delegate.cc | 14 ++++++++++ .../browser/ui/win/message_handler_delegate.h | 26 +++++++++++++++++++ filenames.gypi | 6 +++-- 7 files changed, 66 insertions(+), 10 deletions(-) create mode 100644 atom/browser/ui/win/message_handler_delegate.cc create mode 100644 atom/browser/ui/win/message_handler_delegate.h diff --git a/atom/browser/native_window_views.cc b/atom/browser/native_window_views.cc index acb7de33f4d6..a4fdfc7993b6 100644 --- a/atom/browser/native_window_views.cc +++ b/atom/browser/native_window_views.cc @@ -221,11 +221,11 @@ NativeWindowViews::NativeWindowViews( params.native_widget = new views::DesktopNativeWidgetAura(window_.get()); atom_desktop_window_tree_host_win_ = new AtomDesktopWindowTreeHostWin( + this, window_.get(), static_cast(params.native_widget)); params.desktop_window_tree_host = atom_desktop_window_tree_host_win_; -#endif -#if defined(USE_X11) +#elif defined(USE_X11) std::string name = Browser::Get()->GetName(); // Set WM_WINDOW_ROLE. params.wm_role_name = "browser-window"; diff --git a/atom/browser/native_window_views.h b/atom/browser/native_window_views.h index 792a72c75624..3adfa4cd0dc1 100644 --- a/atom/browser/native_window_views.h +++ b/atom/browser/native_window_views.h @@ -14,6 +14,10 @@ #include "ui/views/widget/widget_delegate.h" #include "ui/views/widget/widget_observer.h" +#if defined(OS_WIN) +#include "atom/browser/ui/win/message_handler_delegate.h" +#endif + namespace views { class UnhandledKeyboardEventHandler; } @@ -28,6 +32,9 @@ class AtomDesktopWindowTreeHostWin; #endif class NativeWindowViews : public NativeWindow, +#if defined(OS_WIN) + public MessageHandlerDelegate, +#endif public views::WidgetDelegateView, public views::WidgetObserver { public: diff --git a/atom/browser/ui/win/atom_desktop_window_tree_host_win.cc b/atom/browser/ui/win/atom_desktop_window_tree_host_win.cc index 157cb610fb3a..f291e66d794e 100644 --- a/atom/browser/ui/win/atom_desktop_window_tree_host_win.cc +++ b/atom/browser/ui/win/atom_desktop_window_tree_host_win.cc @@ -12,10 +12,12 @@ namespace atom { AtomDesktopWindowTreeHostWin::AtomDesktopWindowTreeHostWin( + MessageHandlerDelegate* delegate, views::internal::NativeWidgetDelegate* native_widget_delegate, views::DesktopNativeWidgetAura* desktop_native_widget_aura) : views::DesktopWindowTreeHostWin(native_widget_delegate, - desktop_native_widget_aura) { + desktop_native_widget_aura), + delegate_(delegate) { } AtomDesktopWindowTreeHostWin::~AtomDesktopWindowTreeHostWin() { diff --git a/atom/browser/ui/win/atom_desktop_window_tree_host_win.h b/atom/browser/ui/win/atom_desktop_window_tree_host_win.h index fc09b6503b80..7681ef6a95d8 100644 --- a/atom/browser/ui/win/atom_desktop_window_tree_host_win.h +++ b/atom/browser/ui/win/atom_desktop_window_tree_host_win.h @@ -16,25 +16,30 @@ namespace atom { +class MessageHandlerDelegate; + class AtomDesktopWindowTreeHostWin : public views::DesktopWindowTreeHostWin { public: AtomDesktopWindowTreeHostWin( + MessageHandlerDelegate* delegate, views::internal::NativeWidgetDelegate* native_widget_delegate, views::DesktopNativeWidgetAura* desktop_native_widget_aura); - ~AtomDesktopWindowTreeHostWin(); + ~AtomDesktopWindowTreeHostWin() override; bool SetThumbarButtons( HWND window, const std::vector& buttons); protected: - bool PreHandleMSG(UINT message, - WPARAM w_param, - LPARAM l_param, - LRESULT* result) override; + bool PreHandleMSG( + UINT message, WPARAM w_param, LPARAM l_param, LRESULT* result) override; private: + MessageHandlerDelegate* delegate_; // weak ref + scoped_ptr thumbar_host_; + + DISALLOW_COPY_AND_ASSIGN(AtomDesktopWindowTreeHostWin); }; } // namespace atom diff --git a/atom/browser/ui/win/message_handler_delegate.cc b/atom/browser/ui/win/message_handler_delegate.cc new file mode 100644 index 000000000000..791d1fd816d9 --- /dev/null +++ b/atom/browser/ui/win/message_handler_delegate.cc @@ -0,0 +1,14 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#include "atom/browser/ui/win/message_handler_delegate.h" + +namespace atom { + +bool MessageHandlerDelegate::PreHandleMSG( + UINT message, WPARAM w_param, LPARAM l_param, LRESULT* result) { + return false; +} + +} // namespace atom diff --git a/atom/browser/ui/win/message_handler_delegate.h b/atom/browser/ui/win/message_handler_delegate.h new file mode 100644 index 000000000000..d8cfcf7fc43b --- /dev/null +++ b/atom/browser/ui/win/message_handler_delegate.h @@ -0,0 +1,26 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#ifndef ATOM_BROWSER_UI_WIN_MESSAGE_HANDLER_DELEGATE_H_ +#define ATOM_BROWSER_UI_WIN_MESSAGE_HANDLER_DELEGATE_H_ + +#include + +namespace atom { + +class MessageHandlerDelegate { + public: + // Catch-all message handling and filtering. Called before + // HWNDMessageHandler's built-in handling, which may pre-empt some + // expectations in Views/Aura if messages are consumed. Returns true if the + // message was consumed by the delegate and should not be processed further + // by the HWNDMessageHandler. In this case, |result| is returned. |result| is + // not modified otherwise. + virtual bool PreHandleMSG( + UINT message, WPARAM w_param, LPARAM l_param, LRESULT* result); +}; + +} // namespace atom + +#endif // ATOM_BROWSER_UI_WIN_MESSAGE_HANDLER_DELEGATE_H_ diff --git a/filenames.gypi b/filenames.gypi index 45aaac7c2778..40832b74f6a3 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -202,8 +202,10 @@ 'atom/browser/ui/views/submenu_button.h', 'atom/browser/ui/views/win_frame_view.cc', 'atom/browser/ui/views/win_frame_view.h', - "atom/browser/ui/win/atom_desktop_window_tree_host_win.cc", - "atom/browser/ui/win/atom_desktop_window_tree_host_win.h", + 'atom/browser/ui/win/atom_desktop_window_tree_host_win.cc', + 'atom/browser/ui/win/atom_desktop_window_tree_host_win.h', + 'atom/browser/ui/win/message_handler_delegate.cc', + 'atom/browser/ui/win/message_handler_delegate.h', 'atom/browser/ui/win/notify_icon_host.cc', 'atom/browser/ui/win/notify_icon_host.h', 'atom/browser/ui/win/notify_icon.cc', From 39af10cc8d59baa198daf05b4004d8a1a25fe6c8 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 6 Aug 2015 10:25:50 +0800 Subject: [PATCH 0790/1293] Move thumbar_host_ from TreeHost to NativeWindow --- atom/browser/native_window_views.cc | 24 ++++++++++---- atom/browser/native_window_views.h | 10 ++++++ .../win/atom_desktop_window_tree_host_win.cc | 33 +++---------------- .../win/atom_desktop_window_tree_host_win.h | 8 ----- 4 files changed, 32 insertions(+), 43 deletions(-) diff --git a/atom/browser/native_window_views.cc b/atom/browser/native_window_views.cc index a4fdfc7993b6..09e10608d271 100644 --- a/atom/browser/native_window_views.cc +++ b/atom/browser/native_window_views.cc @@ -46,6 +46,7 @@ #elif defined(OS_WIN) #include "atom/browser/ui/views/win_frame_view.h" #include "atom/browser/ui/win/atom_desktop_window_tree_host_win.h" +#include "atom/browser/ui/win/thumbar_host.h" #include "base/win/scoped_comptr.h" #include "base/win/windows_version.h" #include "ui/base/win/shell.h" @@ -720,13 +721,12 @@ bool NativeWindowViews::IsVisibleOnAllWorkspaces() { bool NativeWindowViews::SetThumbarButtons( const std::vector& buttons) { #if defined(OS_WIN) - if (atom_desktop_window_tree_host_win_) { - return atom_desktop_window_tree_host_win_->SetThumbarButtons( - views::HWNDForNativeWindow(window_->GetNativeWindow()), - buttons); - } -#endif + if (!thumbar_host_) + thumbar_host_.reset(new ThumbarHost(GetAcceleratedWidget())); + return thumbar_host_->SetThumbarButtons(buttons); +#else return false; +#endif } gfx::AcceleratedWidget NativeWindowViews::GetAcceleratedWidget() { @@ -890,6 +890,18 @@ void NativeWindowViews::GetDevToolsWindowWMClass( } #endif +#if defined(OS_WIN) +bool NativeWindowViews::PreHandleMSG( + UINT message, WPARAM w_param, LPARAM l_param, LRESULT* result) { + // Handle thumbar button click message. + if (message == WM_COMMAND && HIWORD(w_param) == THBN_CLICKED && + thumbar_host_) + return thumbar_host_->HandleThumbarButtonEvent(LOWORD(w_param)); + else + return false; +} +#endif + void NativeWindowViews::HandleKeyboardEvent( content::WebContents*, const content::NativeWebKeyboardEvent& event) { diff --git a/atom/browser/native_window_views.h b/atom/browser/native_window_views.h index 3adfa4cd0dc1..647467548d9d 100644 --- a/atom/browser/native_window_views.h +++ b/atom/browser/native_window_views.h @@ -27,8 +27,10 @@ namespace atom { class GlobalMenuBarX11; class MenuBar; class WindowStateWatcher; + #if defined(OS_WIN) class AtomDesktopWindowTreeHostWin; +class ThumbarHost; #endif class NativeWindowViews : public NativeWindow, @@ -134,6 +136,12 @@ class NativeWindowViews : public NativeWindow, std::string* name, std::string* class_name) override; #endif +#if defined(OS_WIN) + // MessageHandlerDelegate: + bool PreHandleMSG( + UINT message, WPARAM w_param, LPARAM l_param, LRESULT* result) override; +#endif + // NativeWindow: void HandleKeyboardEvent( content::WebContents*, @@ -171,6 +179,8 @@ class NativeWindowViews : public NativeWindow, // Records window was whether restored from minimized state or maximized // state. bool is_minimized_; + // In charge of running thumbar related APIs. + scoped_ptr thumbar_host_; #endif // Handles unhandled keyboard messages coming back from the renderer process. diff --git a/atom/browser/ui/win/atom_desktop_window_tree_host_win.cc b/atom/browser/ui/win/atom_desktop_window_tree_host_win.cc index f291e66d794e..84a6d9aa3e50 100644 --- a/atom/browser/ui/win/atom_desktop_window_tree_host_win.cc +++ b/atom/browser/ui/win/atom_desktop_window_tree_host_win.cc @@ -4,10 +4,7 @@ #include "atom/browser/ui/win/atom_desktop_window_tree_host_win.h" -#include - -#include "atom/browser/native_window.h" -#include "atom/browser/ui/win/thumbar_host.h" +#include "atom/browser/ui/win/message_handler_delegate.h" namespace atom { @@ -23,31 +20,9 @@ AtomDesktopWindowTreeHostWin::AtomDesktopWindowTreeHostWin( AtomDesktopWindowTreeHostWin::~AtomDesktopWindowTreeHostWin() { } -bool AtomDesktopWindowTreeHostWin::SetThumbarButtons( - HWND window, - const std::vector& buttons) { - if (!thumbar_host_.get()) { - thumbar_host_.reset(new ThumbarHost(window)); - } - return thumbar_host_->SetThumbarButtons(buttons); -} - -bool AtomDesktopWindowTreeHostWin::PreHandleMSG(UINT message, - WPARAM w_param, - LPARAM l_param, - LRESULT* result) { - switch (message) { - case WM_COMMAND: { - // Handle thumbar button click message. - int id = LOWORD(w_param); - int thbn_message = HIWORD(w_param); - if (thbn_message == THBN_CLICKED && thumbar_host_ && - thumbar_host_->HandleThumbarButtonEvent(id)) - return true; - } - } - - return false; +bool AtomDesktopWindowTreeHostWin::PreHandleMSG( + UINT message, WPARAM w_param, LPARAM l_param, LRESULT* result) { + return delegate_->PreHandleMSG(message, w_param, l_param, result); } } // namespace atom diff --git a/atom/browser/ui/win/atom_desktop_window_tree_host_win.h b/atom/browser/ui/win/atom_desktop_window_tree_host_win.h index 7681ef6a95d8..47e4cb6aed2a 100644 --- a/atom/browser/ui/win/atom_desktop_window_tree_host_win.h +++ b/atom/browser/ui/win/atom_desktop_window_tree_host_win.h @@ -10,8 +10,6 @@ #include #include "atom/browser/native_window.h" -#include "atom/browser/ui/win/thumbar_host.h" -#include "base/memory/scoped_ptr.h" #include "ui/views/widget/desktop_aura/desktop_window_tree_host_win.h" namespace atom { @@ -26,10 +24,6 @@ class AtomDesktopWindowTreeHostWin : public views::DesktopWindowTreeHostWin { views::DesktopNativeWidgetAura* desktop_native_widget_aura); ~AtomDesktopWindowTreeHostWin() override; - bool SetThumbarButtons( - HWND window, - const std::vector& buttons); - protected: bool PreHandleMSG( UINT message, WPARAM w_param, LPARAM l_param, LRESULT* result) override; @@ -37,8 +31,6 @@ class AtomDesktopWindowTreeHostWin : public views::DesktopWindowTreeHostWin { private: MessageHandlerDelegate* delegate_; // weak ref - scoped_ptr thumbar_host_; - DISALLOW_COPY_AND_ASSIGN(AtomDesktopWindowTreeHostWin); }; From 8f8c3aef878f54698b847bd0d4a551a686582539 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 6 Aug 2015 10:30:22 +0800 Subject: [PATCH 0791/1293] ThumbarHost => TaskbarHost --- atom/browser/native_window_views.cc | 12 ++++++------ atom/browser/native_window_views.h | 6 +++--- .../ui/win/{thumbar_host.cc => taskbar_host.cc} | 10 +++++----- .../ui/win/{thumbar_host.h => taskbar_host.h} | 14 +++++++------- filenames.gypi | 4 ++-- 5 files changed, 23 insertions(+), 23 deletions(-) rename atom/browser/ui/win/{thumbar_host.cc => taskbar_host.cc} (94%) rename atom/browser/ui/win/{thumbar_host.h => taskbar_host.h} (72%) diff --git a/atom/browser/native_window_views.cc b/atom/browser/native_window_views.cc index 09e10608d271..c7fd0b8b3524 100644 --- a/atom/browser/native_window_views.cc +++ b/atom/browser/native_window_views.cc @@ -46,7 +46,7 @@ #elif defined(OS_WIN) #include "atom/browser/ui/views/win_frame_view.h" #include "atom/browser/ui/win/atom_desktop_window_tree_host_win.h" -#include "atom/browser/ui/win/thumbar_host.h" +#include "atom/browser/ui/win/taskbar_host.h" #include "base/win/scoped_comptr.h" #include "base/win/windows_version.h" #include "ui/base/win/shell.h" @@ -721,9 +721,9 @@ bool NativeWindowViews::IsVisibleOnAllWorkspaces() { bool NativeWindowViews::SetThumbarButtons( const std::vector& buttons) { #if defined(OS_WIN) - if (!thumbar_host_) - thumbar_host_.reset(new ThumbarHost(GetAcceleratedWidget())); - return thumbar_host_->SetThumbarButtons(buttons); + if (!taskbar_host_) + taskbar_host_.reset(new TaskbarHost(GetAcceleratedWidget())); + return taskbar_host_->SetThumbarButtons(buttons); #else return false; #endif @@ -895,8 +895,8 @@ bool NativeWindowViews::PreHandleMSG( UINT message, WPARAM w_param, LPARAM l_param, LRESULT* result) { // Handle thumbar button click message. if (message == WM_COMMAND && HIWORD(w_param) == THBN_CLICKED && - thumbar_host_) - return thumbar_host_->HandleThumbarButtonEvent(LOWORD(w_param)); + taskbar_host_) + return taskbar_host_->HandleThumbarButtonEvent(LOWORD(w_param)); else return false; } diff --git a/atom/browser/native_window_views.h b/atom/browser/native_window_views.h index 647467548d9d..0cc79facab12 100644 --- a/atom/browser/native_window_views.h +++ b/atom/browser/native_window_views.h @@ -30,7 +30,7 @@ class WindowStateWatcher; #if defined(OS_WIN) class AtomDesktopWindowTreeHostWin; -class ThumbarHost; +class TaskbarHost; #endif class NativeWindowViews : public NativeWindow, @@ -179,8 +179,8 @@ class NativeWindowViews : public NativeWindow, // Records window was whether restored from minimized state or maximized // state. bool is_minimized_; - // In charge of running thumbar related APIs. - scoped_ptr thumbar_host_; + // In charge of running taskbar related APIs. + scoped_ptr taskbar_host_; #endif // Handles unhandled keyboard messages coming back from the renderer process. diff --git a/atom/browser/ui/win/thumbar_host.cc b/atom/browser/ui/win/taskbar_host.cc similarity index 94% rename from atom/browser/ui/win/thumbar_host.cc rename to atom/browser/ui/win/taskbar_host.cc index af57ef4e5c64..6f74a7d9cb37 100644 --- a/atom/browser/ui/win/thumbar_host.cc +++ b/atom/browser/ui/win/taskbar_host.cc @@ -2,7 +2,7 @@ // Use of this source code is governed by the MIT license that can be // found in the LICENSE file. -#include "atom/browser/ui/win/thumbar_host.h" +#include "atom/browser/ui/win/taskbar_host.h" #include @@ -58,14 +58,14 @@ bool GetThumbarButtonFlags(const std::vector& flags, } // namespace -ThumbarHost::ThumbarHost(HWND window) : is_initialized_(false), +TaskbarHost::TaskbarHost(HWND window) : is_initialized_(false), window_(window) { } -ThumbarHost::~ThumbarHost() { +TaskbarHost::~TaskbarHost() { } -bool ThumbarHost::SetThumbarButtons( +bool TaskbarHost::SetThumbarButtons( const std::vector& buttons) { if (buttons.size() > kMaxButtonsCount) return false; @@ -127,7 +127,7 @@ bool ThumbarHost::SetThumbarButtons( return is_success; } -bool ThumbarHost::HandleThumbarButtonEvent(int button_id) { +bool TaskbarHost::HandleThumbarButtonEvent(int button_id) { if (thumbar_button_clicked_callback_map_.find(button_id) != thumbar_button_clicked_callback_map_.end()) { auto callback = thumbar_button_clicked_callback_map_[button_id]; diff --git a/atom/browser/ui/win/thumbar_host.h b/atom/browser/ui/win/taskbar_host.h similarity index 72% rename from atom/browser/ui/win/thumbar_host.h rename to atom/browser/ui/win/taskbar_host.h index d14bbaeda305..e0a9dc89ff4b 100644 --- a/atom/browser/ui/win/thumbar_host.h +++ b/atom/browser/ui/win/taskbar_host.h @@ -2,8 +2,8 @@ // Use of this source code is governed by the MIT license that can be // found in the LICENSE file. -#ifndef ATOM_BROWSER_UI_WIN_THUMBAR_HOST_H_ -#define ATOM_BROWSER_UI_WIN_THUMBAR_HOST_H_ +#ifndef ATOM_BROWSER_UI_WIN_TASKBAR_HOST_H_ +#define ATOM_BROWSER_UI_WIN_TASKBAR_HOST_H_ #include @@ -14,10 +14,10 @@ namespace atom { -class ThumbarHost { +class TaskbarHost { public: - explicit ThumbarHost(HWND window); - ~ThumbarHost(); + explicit TaskbarHost(HWND window); + ~TaskbarHost(); bool SetThumbarButtons( const std::vector& buttons); @@ -32,9 +32,9 @@ class ThumbarHost { HWND window_; - DISALLOW_COPY_AND_ASSIGN(ThumbarHost); + DISALLOW_COPY_AND_ASSIGN(TaskbarHost); }; } // namespace atom -#endif // ATOM_BROWSER_UI_WIN_THUMBAR_HOST_H_ +#endif // ATOM_BROWSER_UI_WIN_TASKBAR_HOST_H_ diff --git a/filenames.gypi b/filenames.gypi index 40832b74f6a3..f7b9fca5e717 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -210,8 +210,8 @@ 'atom/browser/ui/win/notify_icon_host.h', 'atom/browser/ui/win/notify_icon.cc', 'atom/browser/ui/win/notify_icon.h', - 'atom/browser/ui/win/thumbar_host.cc', - 'atom/browser/ui/win/thumbar_host.h', + 'atom/browser/ui/win/taskbar_host.cc', + 'atom/browser/ui/win/taskbar_host.h', 'atom/browser/ui/x/window_state_watcher.cc', 'atom/browser/ui/x/window_state_watcher.h', 'atom/browser/ui/x/x_window_utils.cc', From a28f70e85ca232ae084f3e8ac5cf9420a6d4ff93 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 6 Aug 2015 11:10:34 +0800 Subject: [PATCH 0792/1293] Decouple TaskbarHost from NativeWindow --- atom/browser/api/atom_api_window.cc | 25 ++++++++++++++++++++----- atom/browser/api/atom_api_window.h | 3 +-- atom/browser/native_window.cc | 5 ----- atom/browser/native_window.h | 18 ++++++------------ atom/browser/native_window_views.cc | 17 ++--------------- atom/browser/native_window_views.h | 10 ++++++---- atom/browser/ui/win/taskbar_host.cc | 9 ++++----- atom/browser/ui/win/taskbar_host.h | 21 +++++++++++++-------- 8 files changed, 52 insertions(+), 56 deletions(-) diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index 0b2c8c9ece79..2cbe8be566e2 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -18,14 +18,20 @@ #include "native_mate/dictionary.h" #include "ui/gfx/geometry/rect.h" +#if defined(OS_WIN) +#include "atom/browser/native_window_views.h" +#include "atom/browser/ui/win/taskbar_host.h" +#endif + #include "atom/common/node_includes.h" +#if defined(OS_WIN) namespace mate { template<> -struct Converter { +struct Converter { static bool FromV8(v8::Isolate* isolate, v8::Handle val, - atom::NativeWindow::ThumbarButton* out) { + atom::TaskbarHost::ThumbarButton* out) { mate::Dictionary dict; if (!ConvertFromV8(isolate, val, &dict)) return false; @@ -37,6 +43,7 @@ struct Converter { }; } // namespace mate +#endif namespace atom { @@ -431,9 +438,17 @@ void Window::SetOverlayIcon(const gfx::Image& overlay, window_->SetOverlayIcon(overlay, description); } -void Window::SetThumbarButtons( - const std::vector& buttons) { - window_->SetThumbarButtons(buttons); +void Window::SetThumbarButtons(mate::Arguments* args) { +#if defined(OS_WIN) + std::vector buttons; + if (!args->GetNext(&buttons)) { + args->ThrowError(); + return; + } + auto window = static_cast(window_.get()); + window->taskbar_host().SetThumbarButtons(window->GetAcceleratedWidget(), + buttons); +#endif } void Window::SetMenu(v8::Isolate* isolate, v8::Local value) { diff --git a/atom/browser/api/atom_api_window.h b/atom/browser/api/atom_api_window.h index 7742c8a9fa9b..389c03ab9d40 100644 --- a/atom/browser/api/atom_api_window.h +++ b/atom/browser/api/atom_api_window.h @@ -130,8 +130,7 @@ class Window : public mate::TrackableObject, void SetProgressBar(double progress); void SetOverlayIcon(const gfx::Image& overlay, const std::string& description); - void SetThumbarButtons( - const std::vector& buttons); + void SetThumbarButtons(mate::Arguments* args); void SetMenu(v8::Isolate* isolate, v8::Local menu); void SetAutoHideMenuBar(bool auto_hide); bool IsMenuBarAutoHide(); diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 91770af316e3..96085846bca8 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -277,11 +277,6 @@ bool NativeWindow::HasModalDialog() { return has_dialog_attached_; } -bool NativeWindow::SetThumbarButtons( - const std::vector& buttons) { - return false; -} - void NativeWindow::FocusOnWebView() { web_contents()->GetRenderViewHost()->Focus(); } diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index d461215222d6..b9294d38c931 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -60,14 +60,6 @@ class NativeWindow : public content::WebContentsObserver, public brightray::InspectableWebContentsViewDelegate { public: using CapturePageCallback = base::Callback; - using ThumbarButtonClickedCallback = base::Closure; - - struct ThumbarButton { - std::string tooltip; - gfx::Image icon; - std::vector flags; - ThumbarButtonClickedCallback clicked_callback; - }; class DialogScope { public: @@ -103,6 +95,7 @@ class NativeWindow : public content::WebContentsObserver, virtual void Close() = 0; virtual void CloseImmediately() = 0; + virtual bool IsClosed() const { return is_closed_; } virtual void Focus(bool focus) = 0; virtual bool IsFocused() = 0; virtual void Show() = 0; @@ -147,16 +140,17 @@ class NativeWindow : public content::WebContentsObserver, virtual void SetMenu(ui::MenuModel* menu); virtual bool HasModalDialog(); virtual gfx::NativeWindow GetNativeWindow() = 0; + + // Taskbar/Dock APIs. virtual void SetProgressBar(double progress) = 0; virtual void SetOverlayIcon(const gfx::Image& overlay, const std::string& description) = 0; + + // Workspace APIs. virtual void SetVisibleOnAllWorkspaces(bool visible) = 0; virtual bool IsVisibleOnAllWorkspaces() = 0; - virtual bool SetThumbarButtons( - const std::vector& buttons); - - virtual bool IsClosed() const { return is_closed_; } + // Webview APIs. virtual void FocusOnWebView(); virtual void BlurWebView(); virtual bool IsWebViewFocused(); diff --git a/atom/browser/native_window_views.cc b/atom/browser/native_window_views.cc index c7fd0b8b3524..759249e5aa4e 100644 --- a/atom/browser/native_window_views.cc +++ b/atom/browser/native_window_views.cc @@ -46,7 +46,6 @@ #elif defined(OS_WIN) #include "atom/browser/ui/views/win_frame_view.h" #include "atom/browser/ui/win/atom_desktop_window_tree_host_win.h" -#include "atom/browser/ui/win/taskbar_host.h" #include "base/win/scoped_comptr.h" #include "base/win/windows_version.h" #include "ui/base/win/shell.h" @@ -718,17 +717,6 @@ bool NativeWindowViews::IsVisibleOnAllWorkspaces() { return false; } -bool NativeWindowViews::SetThumbarButtons( - const std::vector& buttons) { -#if defined(OS_WIN) - if (!taskbar_host_) - taskbar_host_.reset(new TaskbarHost(GetAcceleratedWidget())); - return taskbar_host_->SetThumbarButtons(buttons); -#else - return false; -#endif -} - gfx::AcceleratedWidget NativeWindowViews::GetAcceleratedWidget() { return GetNativeWindow()->GetHost()->GetAcceleratedWidget(); } @@ -894,9 +882,8 @@ void NativeWindowViews::GetDevToolsWindowWMClass( bool NativeWindowViews::PreHandleMSG( UINT message, WPARAM w_param, LPARAM l_param, LRESULT* result) { // Handle thumbar button click message. - if (message == WM_COMMAND && HIWORD(w_param) == THBN_CLICKED && - taskbar_host_) - return taskbar_host_->HandleThumbarButtonEvent(LOWORD(w_param)); + if (message == WM_COMMAND && HIWORD(w_param) == THBN_CLICKED) + return taskbar_host_.HandleThumbarButtonEvent(LOWORD(w_param)); else return false; } diff --git a/atom/browser/native_window_views.h b/atom/browser/native_window_views.h index 0cc79facab12..355f5bd38ef3 100644 --- a/atom/browser/native_window_views.h +++ b/atom/browser/native_window_views.h @@ -16,6 +16,7 @@ #if defined(OS_WIN) #include "atom/browser/ui/win/message_handler_delegate.h" +#include "atom/browser/ui/win/taskbar_host.h" #endif namespace views { @@ -30,7 +31,6 @@ class WindowStateWatcher; #if defined(OS_WIN) class AtomDesktopWindowTreeHostWin; -class TaskbarHost; #endif class NativeWindowViews : public NativeWindow, @@ -91,13 +91,15 @@ class NativeWindowViews : public NativeWindow, bool IsMenuBarVisible() override; void SetVisibleOnAllWorkspaces(bool visible) override; bool IsVisibleOnAllWorkspaces() override; - bool SetThumbarButtons( - const std::vector& buttons) override; gfx::AcceleratedWidget GetAcceleratedWidget(); views::Widget* widget() const { return window_.get(); } +#if defined(OS_WIN) + TaskbarHost& taskbar_host() { return taskbar_host_; } +#endif + private: // views::WidgetObserver: void OnWidgetActivationChanged( @@ -180,7 +182,7 @@ class NativeWindowViews : public NativeWindow, // state. bool is_minimized_; // In charge of running taskbar related APIs. - scoped_ptr taskbar_host_; + TaskbarHost taskbar_host_; #endif // Handles unhandled keyboard messages coming back from the renderer process. diff --git a/atom/browser/ui/win/taskbar_host.cc b/atom/browser/ui/win/taskbar_host.cc index 6f74a7d9cb37..3173215a4f6b 100644 --- a/atom/browser/ui/win/taskbar_host.cc +++ b/atom/browser/ui/win/taskbar_host.cc @@ -58,15 +58,14 @@ bool GetThumbarButtonFlags(const std::vector& flags, } // namespace -TaskbarHost::TaskbarHost(HWND window) : is_initialized_(false), - window_(window) { +TaskbarHost::TaskbarHost() : is_initialized_(false) { } TaskbarHost::~TaskbarHost() { } bool TaskbarHost::SetThumbarButtons( - const std::vector& buttons) { + HWND window, const std::vector& buttons) { if (buttons.size() > kMaxButtonsCount) return false; @@ -114,10 +113,10 @@ bool TaskbarHost::SetThumbarButtons( if (!is_initialized_) { is_initialized_ = true; is_success = taskbar->ThumbBarAddButtons( - window_, buttons.size(), thumb_buttons) == S_OK; + window, buttons.size(), thumb_buttons) == S_OK; } else { is_success = taskbar->ThumbBarUpdateButtons( - window_, kMaxButtonsCount, thumb_buttons) == S_OK; + window, kMaxButtonsCount, thumb_buttons) == S_OK; } // Release thumb_buttons' icons, the taskbar makes its own copy. diff --git a/atom/browser/ui/win/taskbar_host.h b/atom/browser/ui/win/taskbar_host.h index e0a9dc89ff4b..2c81a9cdb371 100644 --- a/atom/browser/ui/win/taskbar_host.h +++ b/atom/browser/ui/win/taskbar_host.h @@ -10,28 +10,33 @@ #include #include -#include "atom/browser/native_window.h" +#include "base/callback.h" +#include "ui/gfx/image/image.h" namespace atom { class TaskbarHost { public: - explicit TaskbarHost(HWND window); - ~TaskbarHost(); + struct ThumbarButton { + std::string tooltip; + gfx::Image icon; + std::vector flags; + base::Closure clicked_callback; + }; + + TaskbarHost(); + virtual ~TaskbarHost(); bool SetThumbarButtons( - const std::vector& buttons); + HWND window, const std::vector& buttons); bool HandleThumbarButtonEvent(int button_id); private: - using ThumbarButtonClickedCallbackMap = std::map< - int, NativeWindow::ThumbarButtonClickedCallback>; + using ThumbarButtonClickedCallbackMap = std::map; ThumbarButtonClickedCallbackMap thumbar_button_clicked_callback_map_; bool is_initialized_; - HWND window_; - DISALLOW_COPY_AND_ASSIGN(TaskbarHost); }; From 958658513c0b33aa90694ec2797c995526e5555a Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 6 Aug 2015 12:44:07 +0800 Subject: [PATCH 0793/1293] Refactor code in taskbarHost --- atom/browser/api/atom_api_window.cc | 10 ++- atom/browser/api/atom_api_window.h | 2 +- atom/browser/ui/win/taskbar_host.cc | 128 ++++++++++++++-------------- atom/browser/ui/win/taskbar_host.h | 11 ++- docs/api/browser-window.md | 29 ++++--- 5 files changed, 92 insertions(+), 88 deletions(-) diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index 2cbe8be566e2..6ff1dfc00628 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -438,16 +438,18 @@ void Window::SetOverlayIcon(const gfx::Image& overlay, window_->SetOverlayIcon(overlay, description); } -void Window::SetThumbarButtons(mate::Arguments* args) { +bool Window::SetThumbarButtons(mate::Arguments* args) { #if defined(OS_WIN) std::vector buttons; if (!args->GetNext(&buttons)) { args->ThrowError(); - return; + return false; } auto window = static_cast(window_.get()); - window->taskbar_host().SetThumbarButtons(window->GetAcceleratedWidget(), - buttons); + return window->taskbar_host().SetThumbarButtons( + window->GetAcceleratedWidget(), buttons); +#else + return false; #endif } diff --git a/atom/browser/api/atom_api_window.h b/atom/browser/api/atom_api_window.h index 389c03ab9d40..de2f093ea3e1 100644 --- a/atom/browser/api/atom_api_window.h +++ b/atom/browser/api/atom_api_window.h @@ -130,7 +130,7 @@ class Window : public mate::TrackableObject, void SetProgressBar(double progress); void SetOverlayIcon(const gfx::Image& overlay, const std::string& description); - void SetThumbarButtons(mate::Arguments* args); + bool SetThumbarButtons(mate::Arguments* args); void SetMenu(v8::Isolate* isolate, v8::Local menu); void SetAutoHideMenuBar(bool auto_hide); bool IsMenuBarAutoHide(); diff --git a/atom/browser/ui/win/taskbar_host.cc b/atom/browser/ui/win/taskbar_host.cc index 3173215a4f6b..a6ab44d0723d 100644 --- a/atom/browser/ui/win/taskbar_host.cc +++ b/atom/browser/ui/win/taskbar_host.cc @@ -8,49 +8,40 @@ #include +#include "base/stl_util.h" #include "base/win/scoped_comptr.h" -#include "base/win/win_util.h" -#include "base/win/wrapped_window_proc.h" +#include "base/win/scoped_gdi_object.h" #include "base/strings/utf_string_conversions.h" #include "third_party/skia/include/core/SkBitmap.h" #include "ui/gfx/icon_util.h" -#include "ui/gfx/win/hwnd_util.h" namespace atom { namespace { -// From MSDN: https://msdn.microsoft.com/en-us/library/windows/desktop/ -// dd378460(v=vs.85).aspx#thumbbars +// From MSDN: https://msdn.microsoft.com/en-us/library/windows/desktop/dd378460(v=vs.85).aspx#thumbbars // The thumbnail toolbar has a maximum of seven buttons due to the limited room. -const int kMaxButtonsCount = 7; +const size_t kMaxButtonsCount = 7; // The base id of Thumbar button. const int kButtonIdBase = 40001; bool GetThumbarButtonFlags(const std::vector& flags, THUMBBUTTONFLAGS* out) { - if (flags.empty()) { - *out = THBF_ENABLED; - return true; - } - THUMBBUTTONFLAGS result = static_cast(0); + THUMBBUTTONFLAGS result = THBF_ENABLED; // THBF_ENABLED == 0 for (const auto& flag : flags) { - if (flag == "enabled") { - result |= THBF_ENABLED; - } else if (flag == "disabled") { + if (flag == "disabled") result |= THBF_DISABLED; - } else if (flag == "dismissonclick") { + else if (flag == "dismissonclick") result |= THBF_DISMISSONCLICK; - } else if (flag == "nobackground") { + else if (flag == "nobackground") result |= THBF_NOBACKGROUND; - } else if (flag == "hidden") { + else if (flag == "hidden") result |= THBF_HIDDEN; - } else if (flag == "noninteractive") { + else if (flag == "noninteractive") result |= THBF_NONINTERACTIVE; - } else { + else return false; - } } *out = result; return true; @@ -58,7 +49,7 @@ bool GetThumbarButtonFlags(const std::vector& flags, } // namespace -TaskbarHost::TaskbarHost() : is_initialized_(false) { +TaskbarHost::TaskbarHost() : thumbar_buttons_added_(false) { } TaskbarHost::~TaskbarHost() { @@ -66,9 +57,6 @@ TaskbarHost::~TaskbarHost() { bool TaskbarHost::SetThumbarButtons( HWND window, const std::vector& buttons) { - if (buttons.size() > kMaxButtonsCount) - return false; - base::win::ScopedComPtr taskbar; if (FAILED(taskbar.CreateInstance(CLSID_TaskbarList, nullptr, @@ -77,59 +65,67 @@ bool TaskbarHost::SetThumbarButtons( return false; } + callback_map_.clear(); + + // The number of buttons in thumbar can not be changed once it is created, + // so we have to claim kMaxButtonsCount buttons initialy in case users add + // more buttons later. + base::win::ScopedHICON icons[kMaxButtonsCount] = {}; THUMBBUTTON thumb_buttons[kMaxButtonsCount] = {}; - thumbar_button_clicked_callback_map_.clear(); - // Once a toolbar with a set of buttons is added to thumbnail, there is no way - // to remove it without re-creating the window. - // To achieve to re-set thumbar buttons, we initialize the buttons with - // HIDDEN state and only updated the caller's specified buttons. - // - // Initialize all thumb buttons with HIDDEN state. - for (int i = 0; i < kMaxButtonsCount; ++i) { - thumb_buttons[i].iId = kButtonIdBase + i; - thumb_buttons[i].dwMask = THB_FLAGS; // dwFlags is valid. - thumb_buttons[i].dwFlags = THBF_HIDDEN; - } + for (size_t i = 0; i < kMaxButtonsCount; ++i) { + THUMBBUTTON& thumb_button = thumb_buttons[i]; - // Update the callers' specified buttons. - for (size_t i = 0; i < buttons.size(); ++i) { - if (!GetThumbarButtonFlags(buttons[i].flags, &thumb_buttons[i].dwFlags)) - return false; - thumb_buttons[i].dwMask = THB_ICON | THB_FLAGS; - thumb_buttons[i].hIcon = IconUtil::CreateHICONFromSkBitmap( - buttons[i].icon.AsBitmap()); - if (!buttons[i].tooltip.empty()) { - thumb_buttons[i].dwMask |= THB_TOOLTIP; - wcscpy_s(thumb_buttons[i].szTip, - base::UTF8ToUTF16(buttons[i].tooltip).c_str()); + // Set ID. + thumb_button.iId = kButtonIdBase + i; + thumb_button.dwMask = THB_FLAGS; + + if (i >= buttons.size()) { + // This button is used to occupy the place in toolbar, and it does not + // show. + thumb_button.dwFlags = THBF_HIDDEN; + continue; } - thumbar_button_clicked_callback_map_[thumb_buttons[i].iId] = - buttons[i].clicked_callback; + // This button is user's button. + const ThumbarButton& button = buttons[i]; + + // Generate flags. + thumb_button.dwFlags = THBF_ENABLED; + if (!GetThumbarButtonFlags(button.flags, &thumb_button.dwFlags)) + return false; + + // Set icon. + if (!button.icon.IsEmpty()) { + thumb_button.dwMask |= THB_ICON; + icons[i] = IconUtil::CreateHICONFromSkBitmap(button.icon.AsBitmap()); + thumb_button.hIcon = icons[i].Get(); + } + + // Set tooltip. + if (!button.tooltip.empty()) { + thumb_button.dwMask |= THB_TOOLTIP; + wcscpy_s(thumb_button.szTip, base::UTF8ToUTF16(button.tooltip).c_str()); + } + + // Save callback. + callback_map_[thumb_button.iId] = button.clicked_callback; } - bool is_success = false; - if (!is_initialized_) { - is_initialized_ = true; - is_success = taskbar->ThumbBarAddButtons( - window, buttons.size(), thumb_buttons) == S_OK; - } else { - is_success = taskbar->ThumbBarUpdateButtons( - window, kMaxButtonsCount, thumb_buttons) == S_OK; - } + // Finally add them to taskbar. + HRESULT r; + if (thumbar_buttons_added_) + r = taskbar->ThumbBarUpdateButtons(window, kMaxButtonsCount, thumb_buttons); + else + r = taskbar->ThumbBarAddButtons(window, kMaxButtonsCount, thumb_buttons); - // Release thumb_buttons' icons, the taskbar makes its own copy. - for (size_t i = 0; i < buttons.size(); ++i) { - ::DestroyIcon(thumb_buttons[i].hIcon); - } - return is_success; + thumbar_buttons_added_ = true; + return SUCCEEDED(r); } bool TaskbarHost::HandleThumbarButtonEvent(int button_id) { - if (thumbar_button_clicked_callback_map_.find(button_id) != - thumbar_button_clicked_callback_map_.end()) { - auto callback = thumbar_button_clicked_callback_map_[button_id]; + if (ContainsKey(callback_map_, button_id)) { + auto callback = callback_map_[button_id]; if (!callback.is_null()) callback.Run(); return true; diff --git a/atom/browser/ui/win/taskbar_host.h b/atom/browser/ui/win/taskbar_host.h index 2c81a9cdb371..f3172902af11 100644 --- a/atom/browser/ui/win/taskbar_host.h +++ b/atom/browser/ui/win/taskbar_host.h @@ -8,6 +8,7 @@ #include #include +#include #include #include "base/callback.h" @@ -27,15 +28,19 @@ class TaskbarHost { TaskbarHost(); virtual ~TaskbarHost(); + // Add or update the buttons in thumbar bool SetThumbarButtons( HWND window, const std::vector& buttons); + + // Called by the window that there is a button in thumbar clicked. bool HandleThumbarButtonEvent(int button_id); private: - using ThumbarButtonClickedCallbackMap = std::map; - ThumbarButtonClickedCallbackMap thumbar_button_clicked_callback_map_; + using CallbackMap = std::map; + CallbackMap callback_map_; - bool is_initialized_; + // Whether we have already added the buttons to thumbar. + bool thumbar_buttons_added_; DISALLOW_COPY_AND_ASSIGN(TaskbarHost); }; diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 60b9b84735d0..612b3ce4f3f0 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -646,23 +646,24 @@ __Note:__ This API is only available on Windows (Windows 7 and above) ### BrowserWindow.setThumbarButtons(buttons) -* `buttons` Array of `button` objects +* `buttons` Array * `button` Object * `icon` [NativeImage](native-image.md) - The icon showing in thumbnail toolbar. - * `tooltip` String - (Option) - The text of the button's tooltip. - * `flags` Array of Strings - (Option) Control specific states and behaviors - of the button. By default, it uses `enabled`. - * `enabled` - The button is active and available to the user. - * `disabled` - The button is disabled. It is present, but has a visual - state that indicates that it will not respond to user action. - * `dismissonclick` - When the button is clicked, the taskbar button's - flyout closes immediately. - * `nobackground` - Do not draw a button border, use only the image. - * `hidden` - The button is not shown to the user. - * `noninteractive` - The button is enabled but not interactive; no - pressed button state is drawn. This value is intended for instances - where the button is used in a notification. + * `tooltip` String (optional) - The text of the button's tooltip. + * `flags` Array (optional) - Control specific states and behaviors + of the button. By default, it uses `enabled`. It can include following + Strings: + * `enabled` - The button is active and available to the user. + * `disabled` - The button is disabled. It is present, but has a visual + state that indicates that it will not respond to user action. + * `dismissonclick` - When the button is clicked, the taskbar button's + flyout closes immediately. + * `nobackground` - Do not draw a button border, use only the image. + * `hidden` - The button is not shown to the user. + * `noninteractive` - The button is enabled but not interactive; no + pressed button state is drawn. This value is intended for instances + where the button is used in a notification. * `click` - Function Add a thumbnail toolbar with a specified set of buttons to the thumbnail image From 2d6f8350cb5ac89f7527449e823196084256f761 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 6 Aug 2015 12:54:00 +0800 Subject: [PATCH 0794/1293] Move SetProgressBar to TaskbarHost --- atom/browser/native_window_views.cc | 19 +------------------ atom/browser/ui/win/taskbar_host.cc | 19 +++++++++++++++++++ atom/browser/ui/win/taskbar_host.h | 5 ++++- 3 files changed, 24 insertions(+), 19 deletions(-) diff --git a/atom/browser/native_window_views.cc b/atom/browser/native_window_views.cc index 759249e5aa4e..868ca5da1929 100644 --- a/atom/browser/native_window_views.cc +++ b/atom/browser/native_window_views.cc @@ -621,24 +621,7 @@ gfx::NativeWindow NativeWindowViews::GetNativeWindow() { void NativeWindowViews::SetProgressBar(double progress) { #if defined(OS_WIN) - if (base::win::GetVersion() < base::win::VERSION_WIN7) - return; - base::win::ScopedComPtr taskbar; - if (FAILED(taskbar.CreateInstance(CLSID_TaskbarList, NULL, - CLSCTX_INPROC_SERVER) || - FAILED(taskbar->HrInit()))) { - return; - } - HWND frame = views::HWNDForNativeWindow(GetNativeWindow()); - if (progress > 1.0) { - taskbar->SetProgressState(frame, TBPF_INDETERMINATE); - } else if (progress < 0) { - taskbar->SetProgressState(frame, TBPF_NOPROGRESS); - } else if (progress >= 0) { - taskbar->SetProgressValue(frame, - static_cast(progress * 100), - 100); - } + taskbar_host_.SetProgressBar(GetAcceleratedWidget(), progress); #elif defined(USE_X11) if (unity::IsRunning()) { unity::SetProgressFraction(progress); diff --git a/atom/browser/ui/win/taskbar_host.cc b/atom/browser/ui/win/taskbar_host.cc index a6ab44d0723d..e3ee3fcd47c6 100644 --- a/atom/browser/ui/win/taskbar_host.cc +++ b/atom/browser/ui/win/taskbar_host.cc @@ -123,6 +123,25 @@ bool TaskbarHost::SetThumbarButtons( return SUCCEEDED(r); } +bool TaskbarHost::SetProgressBar(HWND window, double value) { + base::win::ScopedComPtr taskbar; + if (FAILED(taskbar.CreateInstance(CLSID_TaskbarList, + nullptr, + CLSCTX_INPROC_SERVER)) || + FAILED(taskbar->HrInit())) { + return false; + } + + HRESULT r; + if (value > 1.0) + r = taskbar->SetProgressState(window, TBPF_INDETERMINATE); + else if (value < 0) + r = taskbar->SetProgressState(window, TBPF_NOPROGRESS); + else + r= taskbar->SetProgressValue(window, static_cast(value * 100), 100); + return SUCCEEDED(r); +} + bool TaskbarHost::HandleThumbarButtonEvent(int button_id) { if (ContainsKey(callback_map_, button_id)) { auto callback = callback_map_[button_id]; diff --git a/atom/browser/ui/win/taskbar_host.h b/atom/browser/ui/win/taskbar_host.h index f3172902af11..22ea4cbb31a2 100644 --- a/atom/browser/ui/win/taskbar_host.h +++ b/atom/browser/ui/win/taskbar_host.h @@ -28,10 +28,13 @@ class TaskbarHost { TaskbarHost(); virtual ~TaskbarHost(); - // Add or update the buttons in thumbar + // Add or update the buttons in thumbar. bool SetThumbarButtons( HWND window, const std::vector& buttons); + // Sets the progress state in taskbar. + bool SetProgressBar(HWND window, double value); + // Called by the window that there is a button in thumbar clicked. bool HandleThumbarButtonEvent(int button_id); From 8da7803f3e488d918507560d9e6c203e5fd0dee1 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 6 Aug 2015 12:58:40 +0800 Subject: [PATCH 0795/1293] Save the taskbar object --- atom/browser/ui/win/taskbar_host.cc | 39 ++++++++++++++--------------- atom/browser/ui/win/taskbar_host.h | 9 ++++++- 2 files changed, 27 insertions(+), 21 deletions(-) diff --git a/atom/browser/ui/win/taskbar_host.cc b/atom/browser/ui/win/taskbar_host.cc index e3ee3fcd47c6..1ffc567f7b00 100644 --- a/atom/browser/ui/win/taskbar_host.cc +++ b/atom/browser/ui/win/taskbar_host.cc @@ -4,12 +4,9 @@ #include "atom/browser/ui/win/taskbar_host.h" -#include - #include #include "base/stl_util.h" -#include "base/win/scoped_comptr.h" #include "base/win/scoped_gdi_object.h" #include "base/strings/utf_string_conversions.h" #include "third_party/skia/include/core/SkBitmap.h" @@ -57,13 +54,8 @@ TaskbarHost::~TaskbarHost() { bool TaskbarHost::SetThumbarButtons( HWND window, const std::vector& buttons) { - base::win::ScopedComPtr taskbar; - if (FAILED(taskbar.CreateInstance(CLSID_TaskbarList, - nullptr, - CLSCTX_INPROC_SERVER)) || - FAILED(taskbar->HrInit())) { + if (!InitailizeTaskbar()) return false; - } callback_map_.clear(); @@ -115,30 +107,26 @@ bool TaskbarHost::SetThumbarButtons( // Finally add them to taskbar. HRESULT r; if (thumbar_buttons_added_) - r = taskbar->ThumbBarUpdateButtons(window, kMaxButtonsCount, thumb_buttons); + r = taskbar_->ThumbBarUpdateButtons(window, kMaxButtonsCount, + thumb_buttons); else - r = taskbar->ThumbBarAddButtons(window, kMaxButtonsCount, thumb_buttons); + r = taskbar_->ThumbBarAddButtons(window, kMaxButtonsCount, thumb_buttons); thumbar_buttons_added_ = true; return SUCCEEDED(r); } bool TaskbarHost::SetProgressBar(HWND window, double value) { - base::win::ScopedComPtr taskbar; - if (FAILED(taskbar.CreateInstance(CLSID_TaskbarList, - nullptr, - CLSCTX_INPROC_SERVER)) || - FAILED(taskbar->HrInit())) { + if (!InitailizeTaskbar()) return false; - } HRESULT r; if (value > 1.0) - r = taskbar->SetProgressState(window, TBPF_INDETERMINATE); + r = taskbar_->SetProgressState(window, TBPF_INDETERMINATE); else if (value < 0) - r = taskbar->SetProgressState(window, TBPF_NOPROGRESS); + r = taskbar_->SetProgressState(window, TBPF_NOPROGRESS); else - r= taskbar->SetProgressValue(window, static_cast(value * 100), 100); + r= taskbar_->SetProgressValue(window, static_cast(value * 100), 100); return SUCCEEDED(r); } @@ -152,4 +140,15 @@ bool TaskbarHost::HandleThumbarButtonEvent(int button_id) { return false; } +bool TaskbarHost::InitailizeTaskbar() { + if (FAILED(taskbar_.CreateInstance(CLSID_TaskbarList, + nullptr, + CLSCTX_INPROC_SERVER)) || + FAILED(taskbar_->HrInit())) { + return false; + } else { + return true; + } +} + } // namespace atom diff --git a/atom/browser/ui/win/taskbar_host.h b/atom/browser/ui/win/taskbar_host.h index 22ea4cbb31a2..755f867eb132 100644 --- a/atom/browser/ui/win/taskbar_host.h +++ b/atom/browser/ui/win/taskbar_host.h @@ -5,13 +5,14 @@ #ifndef ATOM_BROWSER_UI_WIN_TASKBAR_HOST_H_ #define ATOM_BROWSER_UI_WIN_TASKBAR_HOST_H_ -#include +#include #include #include #include #include "base/callback.h" +#include "base/win/scoped_comptr.h" #include "ui/gfx/image/image.h" namespace atom { @@ -39,9 +40,15 @@ class TaskbarHost { bool HandleThumbarButtonEvent(int button_id); private: + // Initailize the taskbar object. + bool InitailizeTaskbar(); + using CallbackMap = std::map; CallbackMap callback_map_; + // The COM object of taskbar. + base::win::ScopedComPtr taskbar_; + // Whether we have already added the buttons to thumbar. bool thumbar_buttons_added_; From 6e75af5c0f159981ce44eadae618976895119696 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 6 Aug 2015 13:07:00 +0800 Subject: [PATCH 0796/1293] Move SetOverlayIcon to TaskbarHost --- atom/browser/native_window_views.cc | 25 +------------------------ atom/browser/ui/win/taskbar_host.cc | 11 +++++++++++ atom/browser/ui/win/taskbar_host.h | 6 +++++- 3 files changed, 17 insertions(+), 25 deletions(-) diff --git a/atom/browser/native_window_views.cc b/atom/browser/native_window_views.cc index 868ca5da1929..45697c96683c 100644 --- a/atom/browser/native_window_views.cc +++ b/atom/browser/native_window_views.cc @@ -4,10 +4,6 @@ #include "atom/browser/native_window_views.h" -#if defined(OS_WIN) -#include -#endif - #include #include @@ -46,13 +42,9 @@ #elif defined(OS_WIN) #include "atom/browser/ui/views/win_frame_view.h" #include "atom/browser/ui/win/atom_desktop_window_tree_host_win.h" -#include "base/win/scoped_comptr.h" -#include "base/win/windows_version.h" #include "ui/base/win/shell.h" -#include "ui/gfx/icon_util.h" #include "ui/gfx/win/dpi.h" #include "ui/views/widget/desktop_aura/desktop_native_widget_aura.h" -#include "ui/views/win/hwnd_util.h" #endif namespace atom { @@ -632,22 +624,7 @@ void NativeWindowViews::SetProgressBar(double progress) { void NativeWindowViews::SetOverlayIcon(const gfx::Image& overlay, const std::string& description) { #if defined(OS_WIN) - if (base::win::GetVersion() < base::win::VERSION_WIN7) - return; - - base::win::ScopedComPtr taskbar; - if (FAILED(taskbar.CreateInstance(CLSID_TaskbarList, NULL, - CLSCTX_INPROC_SERVER) || - FAILED(taskbar->HrInit()))) { - return; - } - - HWND frame = views::HWNDForNativeWindow(GetNativeWindow()); - - std::wstring wstr = std::wstring(description.begin(), description.end()); - taskbar->SetOverlayIcon(frame, - IconUtil::CreateHICONFromSkBitmap(overlay.AsBitmap()), - wstr.c_str()); + taskbar_host_.SetOverlayIcon(GetAcceleratedWidget(), overlay, description); #endif } diff --git a/atom/browser/ui/win/taskbar_host.cc b/atom/browser/ui/win/taskbar_host.cc index 1ffc567f7b00..edbc78ce5c83 100644 --- a/atom/browser/ui/win/taskbar_host.cc +++ b/atom/browser/ui/win/taskbar_host.cc @@ -130,6 +130,17 @@ bool TaskbarHost::SetProgressBar(HWND window, double value) { return SUCCEEDED(r); } +bool TaskbarHost::SetOverlayIcon( + HWND window, const gfx::Image& overlay, const std::string& text) { + if (!InitailizeTaskbar()) + return false; + + base::win::ScopedHICON icon( + IconUtil::CreateHICONFromSkBitmap(overlay.AsBitmap())); + return SUCCEEDED( + taskbar_->SetOverlayIcon(window, icon, base::UTF8ToUTF16(text).c_str())); +} + bool TaskbarHost::HandleThumbarButtonEvent(int button_id) { if (ContainsKey(callback_map_, button_id)) { auto callback = callback_map_[button_id]; diff --git a/atom/browser/ui/win/taskbar_host.h b/atom/browser/ui/win/taskbar_host.h index 755f867eb132..185b88a6b5b6 100644 --- a/atom/browser/ui/win/taskbar_host.h +++ b/atom/browser/ui/win/taskbar_host.h @@ -33,9 +33,13 @@ class TaskbarHost { bool SetThumbarButtons( HWND window, const std::vector& buttons); - // Sets the progress state in taskbar. + // Set the progress state in taskbar. bool SetProgressBar(HWND window, double value); + // Set the overlay icon in taskbar. + bool SetOverlayIcon( + HWND window, const gfx::Image& overlay, const std::string& text); + // Called by the window that there is a button in thumbar clicked. bool HandleThumbarButtonEvent(int button_id); From 454085eb95d854c3bfbe5785e88536715e96e266 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 6 Aug 2015 13:07:39 +0800 Subject: [PATCH 0797/1293] Fix cpplint warning --- atom/browser/ui/win/taskbar_host.cc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/atom/browser/ui/win/taskbar_host.cc b/atom/browser/ui/win/taskbar_host.cc index edbc78ce5c83..c728e4664c3a 100644 --- a/atom/browser/ui/win/taskbar_host.cc +++ b/atom/browser/ui/win/taskbar_host.cc @@ -126,7 +126,7 @@ bool TaskbarHost::SetProgressBar(HWND window, double value) { else if (value < 0) r = taskbar_->SetProgressState(window, TBPF_NOPROGRESS); else - r= taskbar_->SetProgressValue(window, static_cast(value * 100), 100); + r = taskbar_->SetProgressValue(window, static_cast(value * 100), 100); return SUCCEEDED(r); } From 744059b8bd8132d5fd1cfd757accc60b45ba55e2 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 6 Aug 2015 15:22:17 +0800 Subject: [PATCH 0798/1293] Check button size --- atom/browser/ui/win/taskbar_host.cc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/atom/browser/ui/win/taskbar_host.cc b/atom/browser/ui/win/taskbar_host.cc index c728e4664c3a..a8e6ff2926cd 100644 --- a/atom/browser/ui/win/taskbar_host.cc +++ b/atom/browser/ui/win/taskbar_host.cc @@ -54,7 +54,7 @@ TaskbarHost::~TaskbarHost() { bool TaskbarHost::SetThumbarButtons( HWND window, const std::vector& buttons) { - if (!InitailizeTaskbar()) + if (buttons.size() > kMaxButtonsCount || !InitailizeTaskbar()) return false; callback_map_.clear(); From fb60f7946fe3bd6562aed26c2a2a6d120e49de5a Mon Sep 17 00:00:00 2001 From: Alex Ryan Date: Thu, 6 Aug 2015 22:15:59 -0700 Subject: [PATCH 0799/1293] Fixed typo --- docs/api/app.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/app.md b/docs/api/app.md index 7e47b446f6d3..8223643a375f 100644 --- a/docs/api/app.md +++ b/docs/api/app.md @@ -23,7 +23,7 @@ In most cases, you should just do everything in the `ready` event handler. ## Event: ready -Emitted when Electron has finsished initialization. +Emitted when Electron has finished initialization. ## Event: window-all-closed From 24ba712aa5ae47d95ec45cc964b53882ee6e8c06 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 7 Aug 2015 19:35:12 +0800 Subject: [PATCH 0800/1293] Update libchromiumcontent to have WebScopedRunV8Script --- script/lib/config.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/script/lib/config.py b/script/lib/config.py index 82640153a17c..144ec87c677b 100644 --- a/script/lib/config.py +++ b/script/lib/config.py @@ -8,7 +8,7 @@ import sys BASE_URL = os.getenv('LIBCHROMIUMCONTENT_MIRROR') or \ 'http://gh-contractor-zcbenz.s3.amazonaws.com/libchromiumcontent' -LIBCHROMIUMCONTENT_COMMIT = '8c7f5b9adb9372130a9295b7e0fb19355f613cf9' +LIBCHROMIUMCONTENT_COMMIT = 'dd51a41b42246b0b5159bfad5e327c8cf10bc585' PLATFORM = { 'cygwin': 'win32', From 5d3445cebb23eef45cc68508cefa4626e82160d7 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 7 Aug 2015 15:06:09 +0800 Subject: [PATCH 0801/1293] Style fix --- atom/renderer/atom_render_view_observer.cc | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/atom/renderer/atom_render_view_observer.cc b/atom/renderer/atom_render_view_observer.cc index eb59fe03d3b3..686481327f5b 100644 --- a/atom/renderer/atom_render_view_observer.cc +++ b/atom/renderer/atom_render_view_observer.cc @@ -162,8 +162,7 @@ void AtomRenderViewObserver::OnJavaScriptExecuteRequest( v8::HandleScope handle_scope(isolate); blink::WebFrame* frame = render_view()->GetWebView()->mainFrame(); - frame->executeScriptAndReturnValue( - blink::WebScriptSource(code)); + frame->executeScriptAndReturnValue(blink::WebScriptSource(code)); } } // namespace atom From ab44edd2948b2e133b6ba64b717ac974935618f5 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 7 Aug 2015 15:10:14 +0800 Subject: [PATCH 0802/1293] Perform microtask checkpoint after diving into libuv --- atom/common/node_bindings.cc | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/atom/common/node_bindings.cc b/atom/common/node_bindings.cc index 8f5dd07428ad..b329589552ba 100644 --- a/atom/common/node_bindings.cc +++ b/atom/common/node_bindings.cc @@ -19,6 +19,7 @@ #include "content/public/common/content_paths.h" #include "native_mate/locker.h" #include "native_mate/dictionary.h" +#include "third_party/WebKit/public/web/WebScopedMicrotaskSuppression.h" #include "atom/common/node_includes.h" @@ -227,6 +228,10 @@ void NodeBindings::UvRunOnce() { // Enter node context while dealing with uv events. v8::Context::Scope context_scope(env->context()); + // Perform microtask checkpoint after running JavaScript. + scoped_ptr script_scope( + is_browser_ ? nullptr : new blink::WebScopedRunV8Script(env->isolate())); + // Deal with uv events. int r = uv_run(uv_loop_, UV_RUN_NOWAIT); if (r == 0 || uv_loop_->stop_flag != 0) From 74fa2c809d7727d3ff792b7f29abd5a797be1095 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 7 Aug 2015 15:18:33 +0800 Subject: [PATCH 0803/1293] Make every JS function call is wrapped with V8RecursionScope --- atom/common/event_emitter_caller.cc | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/atom/common/event_emitter_caller.cc b/atom/common/event_emitter_caller.cc index 3dbdc9db956d..68c48217a364 100644 --- a/atom/common/event_emitter_caller.cc +++ b/atom/common/event_emitter_caller.cc @@ -4,15 +4,33 @@ #include "atom/common/event_emitter_caller.h" +#include "base/memory/scoped_ptr.h" +#include "third_party/WebKit/public/web/WebScopedMicrotaskSuppression.h" + #include "atom/common/node_includes.h" namespace mate { namespace internal { +namespace { + +// Returns whether current process is browser process, currently we detect it +// by checking whether current has used V8 Lock, but it might be a bad idea. +inline bool IsBrowserProcess() { + return v8::Locker::IsActive(); +} + +} // namespace + v8::Local CallEmitWithArgs(v8::Isolate* isolate, v8::Local obj, ValueVector* args) { + // Perform microtask checkpoint after running JavaScript. + scoped_ptr script_scope( + IsBrowserProcess() ? nullptr : new blink::WebScopedRunV8Script(isolate)); + // Use node::MakeCallback to call the callback, and it will also run pending + // tasks in Node.js. return node::MakeCallback( isolate, obj, "emit", args->size(), &args->front()); } From 3402871741e5b4517664fc479f6e483c9d2d1a42 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 7 Aug 2015 16:55:16 +0800 Subject: [PATCH 0804/1293] spec: Check the time when Promise's callback is called --- spec/chromium-spec.coffee | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/spec/chromium-spec.coffee b/spec/chromium-spec.coffee index 32fd5bed6742..704e5bbcac74 100644 --- a/spec/chromium-spec.coffee +++ b/spec/chromium-spec.coffee @@ -135,3 +135,32 @@ describe 'chromium feature', -> else done('user agent is empty') websocket = new WebSocket("ws://127.0.0.1:#{port}") + + describe 'Promise', -> + it 'resolves correctly in Node.js calls', (done) -> + document.registerElement('x-element', { + prototype: Object.create(HTMLElement.prototype, { + createdCallback: { value: -> } + }) + }) + + setImmediate -> + called = false + Promise.resolve().then -> + done(if called then undefined else new Error('wrong sequnce')) + document.createElement 'x-element' + called = true + + it 'resolves correctly in Electron calls', (done) -> + document.registerElement('y-element', { + prototype: Object.create(HTMLElement.prototype, { + createdCallback: { value: -> } + }) + }) + + remote.getGlobal('setImmediate') -> + called = false + Promise.resolve().then -> + done(if called then undefined else new Error('wrong sequnce')) + document.createElement 'y-element' + called = true From 2ff104d0125e3434cc1a0e6de57cc9938c70481a Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 7 Aug 2015 18:10:19 +0800 Subject: [PATCH 0805/1293] Move callback converter from native mate to electron --- atom/browser/api/atom_api_app.cc | 2 +- atom/browser/api/atom_api_content_tracing.cc | 2 +- atom/browser/api/atom_api_cookies.cc | 2 +- atom/browser/api/atom_api_dialog.cc | 2 +- atom/browser/api/atom_api_global_shortcut.cc | 2 +- atom/browser/api/atom_api_menu.cc | 2 +- atom/browser/api/atom_api_protocol.cc | 2 +- atom/browser/api/atom_api_session.cc | 2 +- atom/browser/api/atom_api_web_contents.cc | 2 +- atom/browser/api/atom_api_window.cc | 2 +- atom/common/api/atom_api_asar.cc | 2 +- atom/common/native_mate_converters/callback.h | 439 ++++++++++++++++++ atom/renderer/api/atom_api_web_frame.cc | 2 +- filenames.gypi | 1 + vendor/native_mate | 2 +- 15 files changed, 453 insertions(+), 13 deletions(-) create mode 100644 atom/common/native_mate_converters/callback.h diff --git a/atom/browser/api/atom_api_app.cc b/atom/browser/api/atom_api_app.cc index fea4deda5b1b..c25b3be5f4d6 100644 --- a/atom/browser/api/atom_api_app.cc +++ b/atom/browser/api/atom_api_app.cc @@ -17,6 +17,7 @@ #include "atom/browser/atom_browser_main_parts.h" #include "atom/browser/browser.h" #include "atom/browser/api/atom_api_web_contents.h" +#include "atom/common/native_mate_converters/callback.h" #include "atom/common/native_mate_converters/file_path_converter.h" #include "base/command_line.h" #include "base/environment.h" @@ -25,7 +26,6 @@ #include "brightray/browser/brightray_paths.h" #include "content/public/browser/client_certificate_delegate.h" #include "content/public/browser/gpu_data_manager.h" -#include "native_mate/callback.h" #include "native_mate/dictionary.h" #include "native_mate/object_template_builder.h" #include "net/ssl/ssl_cert_request_info.h" diff --git a/atom/browser/api/atom_api_content_tracing.cc b/atom/browser/api/atom_api_content_tracing.cc index 9507d19d399a..e404a8f26ca6 100644 --- a/atom/browser/api/atom_api_content_tracing.cc +++ b/atom/browser/api/atom_api_content_tracing.cc @@ -5,11 +5,11 @@ #include #include +#include "atom/common/native_mate_converters/callback.h" #include "atom/common/native_mate_converters/file_path_converter.h" #include "base/bind.h" #include "base/files/file_util.h" #include "content/public/browser/tracing_controller.h" -#include "native_mate/callback.h" #include "native_mate/dictionary.h" #include "atom/common/node_includes.h" diff --git a/atom/browser/api/atom_api_cookies.cc b/atom/browser/api/atom_api_cookies.cc index 0363032df878..040efe1c360b 100644 --- a/atom/browser/api/atom_api_cookies.cc +++ b/atom/browser/api/atom_api_cookies.cc @@ -4,13 +4,13 @@ #include "atom/browser/api/atom_api_cookies.h" +#include "atom/common/native_mate_converters/callback.h" #include "atom/common/native_mate_converters/gurl_converter.h" #include "atom/common/native_mate_converters/value_converter.h" #include "base/bind.h" #include "base/time/time.h" #include "content/public/browser/browser_context.h" #include "content/public/browser/browser_thread.h" -#include "native_mate/callback.h" #include "native_mate/dictionary.h" #include "native_mate/object_template_builder.h" #include "net/cookies/cookie_monster.h" diff --git a/atom/browser/api/atom_api_dialog.cc b/atom/browser/api/atom_api_dialog.cc index 47021407e1ea..40ee4d0d9b51 100644 --- a/atom/browser/api/atom_api_dialog.cc +++ b/atom/browser/api/atom_api_dialog.cc @@ -10,9 +10,9 @@ #include "atom/browser/native_window.h" #include "atom/browser/ui/file_dialog.h" #include "atom/browser/ui/message_box.h" +#include "atom/common/native_mate_converters/callback.h" #include "atom/common/native_mate_converters/file_path_converter.h" #include "atom/common/native_mate_converters/image_converter.h" -#include "native_mate/callback.h" #include "native_mate/dictionary.h" #include "atom/common/node_includes.h" diff --git a/atom/browser/api/atom_api_global_shortcut.cc b/atom/browser/api/atom_api_global_shortcut.cc index 47bebe9d12bd..f5a03e4abf90 100644 --- a/atom/browser/api/atom_api_global_shortcut.cc +++ b/atom/browser/api/atom_api_global_shortcut.cc @@ -7,8 +7,8 @@ #include #include "atom/common/native_mate_converters/accelerator_converter.h" +#include "atom/common/native_mate_converters/callback.h" #include "base/stl_util.h" -#include "native_mate/callback.h" #include "native_mate/dictionary.h" #include "atom/common/node_includes.h" diff --git a/atom/browser/api/atom_api_menu.cc b/atom/browser/api/atom_api_menu.cc index 1eb5cb31d118..915e152b3a68 100644 --- a/atom/browser/api/atom_api_menu.cc +++ b/atom/browser/api/atom_api_menu.cc @@ -6,9 +6,9 @@ #include "atom/browser/native_window.h" #include "atom/common/native_mate_converters/accelerator_converter.h" +#include "atom/common/native_mate_converters/callback.h" #include "atom/common/native_mate_converters/image_converter.h" #include "atom/common/native_mate_converters/string16_converter.h" -#include "native_mate/callback.h" #include "native_mate/constructor.h" #include "native_mate/dictionary.h" #include "native_mate/object_template_builder.h" diff --git a/atom/browser/api/atom_api_protocol.cc b/atom/browser/api/atom_api_protocol.cc index 53aef95b7657..1241a95a718f 100644 --- a/atom/browser/api/atom_api_protocol.cc +++ b/atom/browser/api/atom_api_protocol.cc @@ -10,10 +10,10 @@ #include "atom/browser/api/atom_api_session.h" #include "atom/browser/net/adapter_request_job.h" #include "atom/browser/net/atom_url_request_job_factory.h" +#include "atom/common/native_mate_converters/callback.h" #include "atom/common/native_mate_converters/file_path_converter.h" #include "atom/common/native_mate_converters/gurl_converter.h" #include "content/public/browser/browser_thread.h" -#include "native_mate/callback.h" #include "native_mate/dictionary.h" #include "net/url_request/url_request_context.h" diff --git a/atom/browser/api/atom_api_session.cc b/atom/browser/api/atom_api_session.cc index 19efd2d32ac8..b8b1434dd70d 100644 --- a/atom/browser/api/atom_api_session.cc +++ b/atom/browser/api/atom_api_session.cc @@ -9,6 +9,7 @@ #include "atom/browser/api/atom_api_cookies.h" #include "atom/browser/atom_browser_context.h" +#include "atom/common/native_mate_converters/callback.h" #include "atom/common/native_mate_converters/gurl_converter.h" #include "atom/common/native_mate_converters/file_path_converter.h" #include "base/files/file_path.h" @@ -18,7 +19,6 @@ #include "chrome/common/pref_names.h" #include "content/public/browser/browser_thread.h" #include "content/public/browser/storage_partition.h" -#include "native_mate/callback.h" #include "native_mate/object_template_builder.h" #include "net/base/load_flags.h" #include "net/disk_cache/disk_cache.h" diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 1f68a4d8ad1d..6adcf5377357 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -14,6 +14,7 @@ #include "atom/browser/web_view_guest_delegate.h" #include "atom/common/api/api_messages.h" #include "atom/common/event_emitter_caller.h" +#include "atom/common/native_mate_converters/callback.h" #include "atom/common/native_mate_converters/file_path_converter.h" #include "atom/common/native_mate_converters/gfx_converter.h" #include "atom/common/native_mate_converters/gurl_converter.h" @@ -37,7 +38,6 @@ #include "content/public/browser/storage_partition.h" #include "content/public/browser/site_instance.h" #include "content/public/browser/web_contents.h" -#include "native_mate/callback.h" #include "native_mate/dictionary.h" #include "native_mate/object_template_builder.h" #include "net/http/http_response_headers.h" diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index 6ff1dfc00628..e6d16fe6fa59 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -8,12 +8,12 @@ #include "atom/browser/api/atom_api_web_contents.h" #include "atom/browser/browser.h" #include "atom/browser/native_window.h" +#include "atom/common/native_mate_converters/callback.h" #include "atom/common/native_mate_converters/gfx_converter.h" #include "atom/common/native_mate_converters/gurl_converter.h" #include "atom/common/native_mate_converters/image_converter.h" #include "atom/common/native_mate_converters/string16_converter.h" #include "content/public/browser/render_process_host.h" -#include "native_mate/callback.h" #include "native_mate/constructor.h" #include "native_mate/dictionary.h" #include "ui/gfx/geometry/rect.h" diff --git a/atom/common/api/atom_api_asar.cc b/atom/common/api/atom_api_asar.cc index 07d7c608d16d..24e9ce9b0668 100644 --- a/atom/common/api/atom_api_asar.cc +++ b/atom/common/api/atom_api_asar.cc @@ -8,9 +8,9 @@ #include "atom_natives.h" // NOLINT: This file is generated with coffee2c. #include "atom/common/asar/archive.h" +#include "atom/common/native_mate_converters/callback.h" #include "atom/common/native_mate_converters/file_path_converter.h" #include "native_mate/arguments.h" -#include "native_mate/callback.h" #include "native_mate/dictionary.h" #include "native_mate/object_template_builder.h" #include "native_mate/wrappable.h" diff --git a/atom/common/native_mate_converters/callback.h b/atom/common/native_mate_converters/callback.h new file mode 100644 index 000000000000..5dfcf9b25136 --- /dev/null +++ b/atom/common/native_mate_converters/callback.h @@ -0,0 +1,439 @@ +// Copyright (c) 2015 GitHub, Inc. All rights reserved. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#include "base/bind.h" +#include "base/callback.h" +#include "native_mate/function_template.h" +#include "native_mate/locker.h" +#include "native_mate/scoped_persistent.h" + +namespace mate { + +namespace internal { + +typedef scoped_refptr > SafeV8Function; + +// This set of templates invokes a V8::Function by converting the C++ types. +template +struct V8FunctionInvoker; + +template +struct V8FunctionInvoker()> { + static v8::Local Go(v8::Isolate* isolate, SafeV8Function function) { + Locker locker(isolate); + v8::EscapableHandleScope handle_scope(isolate); + v8::Local holder = function->NewHandle(); + v8::Local context = holder->CreationContext(); + v8::Context::Scope context_scope(context); + v8::Local val(holder->Call(holder, 0, NULL)); + return handle_scope.Escape(val); + } +}; + +template +struct V8FunctionInvoker { + static R Go(v8::Isolate* isolate, SafeV8Function function) { + R ret; + Locker locker(isolate); + MATE_HANDLE_SCOPE(isolate); + v8::Local holder = function->NewHandle(); + v8::Local context = holder->CreationContext(); + v8::Context::Scope context_scope(context); + v8::Local val(holder->Call(holder, 0, NULL)); + Converter::FromV8(isolate, val, &ret); + return ret; + } +}; + +template<> +struct V8FunctionInvoker { + static void Go(v8::Isolate* isolate, SafeV8Function function) { + Locker locker(isolate); + MATE_HANDLE_SCOPE(isolate); + v8::Local holder = function->NewHandle(); + v8::Local context = holder->CreationContext(); + v8::Context::Scope context_scope(context); + holder->Call(holder, 0, NULL); + } +}; + +template +struct V8FunctionInvoker(P1)> { + static v8::Local Go(v8::Isolate* isolate, SafeV8Function function, P1 a1) { + Locker locker(isolate); + v8::EscapableHandleScope handle_scope(isolate); + v8::Local holder = function->NewHandle(); + v8::Local context = holder->CreationContext(); + v8::Context::Scope context_scope(context); + v8::Local args[] = { + ConvertToV8(isolate, a1), + }; + v8::Local val(holder->Call(holder, arraysize(args), args)); + return handle_scope.Escape(val); + } +}; + +template +struct V8FunctionInvoker { + static R Go(v8::Isolate* isolate, SafeV8Function function, P1 a1) { + R ret; + Locker locker(isolate); + MATE_HANDLE_SCOPE(isolate); + v8::Local holder = function->NewHandle(); + v8::Local context = holder->CreationContext(); + v8::Context::Scope context_scope(context); + v8::Local args[] = { + ConvertToV8(isolate, a1), + }; + v8::Local val(holder->Call(holder, arraysize(args), args)); + Converter::FromV8(isolate, val, &ret); + return ret; + } +}; + +template +struct V8FunctionInvoker { + static void Go(v8::Isolate* isolate, SafeV8Function function, P1 a1) { + Locker locker(isolate); + MATE_HANDLE_SCOPE(isolate); + v8::Local holder = function->NewHandle(); + v8::Local context = holder->CreationContext(); + v8::Context::Scope context_scope(context); + v8::Local args[] = { + ConvertToV8(isolate, a1), + }; + holder->Call(holder, arraysize(args), args); + } +}; + +template +struct V8FunctionInvoker(P1, P2)> { + static v8::Local Go(v8::Isolate* isolate, SafeV8Function function, P1 a1, + P2 a2) { + Locker locker(isolate); + v8::EscapableHandleScope handle_scope(isolate); + v8::Local holder = function->NewHandle(); + v8::Local context = holder->CreationContext(); + v8::Context::Scope context_scope(context); + v8::Local args[] = { + ConvertToV8(isolate, a1), + ConvertToV8(isolate, a2), + }; + v8::Local val(holder->Call(holder, arraysize(args), args)); + return handle_scope.Escape(val); + } +}; + +template +struct V8FunctionInvoker { + static R Go(v8::Isolate* isolate, SafeV8Function function, P1 a1, P2 a2) { + R ret; + Locker locker(isolate); + MATE_HANDLE_SCOPE(isolate); + v8::Local holder = function->NewHandle(); + v8::Local context = holder->CreationContext(); + v8::Context::Scope context_scope(context); + v8::Local args[] = { + ConvertToV8(isolate, a1), + ConvertToV8(isolate, a2), + }; + v8::Local val(holder->Call(holder, arraysize(args), args)); + Converter::FromV8(isolate, val, &ret); + return ret; + } +}; + +template +struct V8FunctionInvoker { + static void Go(v8::Isolate* isolate, SafeV8Function function, P1 a1, P2 a2) { + Locker locker(isolate); + MATE_HANDLE_SCOPE(isolate); + v8::Local holder = function->NewHandle(); + v8::Local context = holder->CreationContext(); + v8::Context::Scope context_scope(context); + v8::Local args[] = { + ConvertToV8(isolate, a1), + ConvertToV8(isolate, a2), + }; + holder->Call(holder, arraysize(args), args); + } +}; + +template +struct V8FunctionInvoker(P1, P2, P3)> { + static v8::Local Go(v8::Isolate* isolate, SafeV8Function function, P1 a1, + P2 a2, P3 a3) { + Locker locker(isolate); + v8::EscapableHandleScope handle_scope(isolate); + v8::Local holder = function->NewHandle(); + v8::Local context = holder->CreationContext(); + v8::Context::Scope context_scope(context); + v8::Local args[] = { + ConvertToV8(isolate, a1), + ConvertToV8(isolate, a2), + ConvertToV8(isolate, a3), + }; + v8::Local val(holder->Call(holder, arraysize(args), args)); + return handle_scope.Escape(val); + } +}; + +template +struct V8FunctionInvoker { + static R Go(v8::Isolate* isolate, SafeV8Function function, P1 a1, P2 a2, + P3 a3) { + R ret; + Locker locker(isolate); + MATE_HANDLE_SCOPE(isolate); + v8::Local holder = function->NewHandle(); + v8::Local context = holder->CreationContext(); + v8::Context::Scope context_scope(context); + v8::Local args[] = { + ConvertToV8(isolate, a1), + ConvertToV8(isolate, a2), + ConvertToV8(isolate, a3), + }; + v8::Local val(holder->Call(holder, arraysize(args), args)); + Converter::FromV8(isolate, val, &ret); + return ret; + } +}; + +template +struct V8FunctionInvoker { + static void Go(v8::Isolate* isolate, SafeV8Function function, P1 a1, P2 a2, + P3 a3) { + Locker locker(isolate); + MATE_HANDLE_SCOPE(isolate); + v8::Local holder = function->NewHandle(); + v8::Local context = holder->CreationContext(); + v8::Context::Scope context_scope(context); + v8::Local args[] = { + ConvertToV8(isolate, a1), + ConvertToV8(isolate, a2), + ConvertToV8(isolate, a3), + }; + holder->Call(holder, arraysize(args), args); + } +}; + +template +struct V8FunctionInvoker(P1, P2, P3, P4)> { + static v8::Local Go(v8::Isolate* isolate, SafeV8Function function, P1 a1, + P2 a2, P3 a3, P4 a4) { + Locker locker(isolate); + v8::EscapableHandleScope handle_scope(isolate); + v8::Local holder = function->NewHandle(); + v8::Local context = holder->CreationContext(); + v8::Context::Scope context_scope(context); + v8::Local args[] = { + ConvertToV8(isolate, a1), + ConvertToV8(isolate, a2), + ConvertToV8(isolate, a3), + ConvertToV8(isolate, a4), + }; + v8::Local val(holder->Call(holder, arraysize(args), args)); + return handle_scope.Escape(val); + } +}; + +template +struct V8FunctionInvoker { + static R Go(v8::Isolate* isolate, SafeV8Function function, P1 a1, P2 a2, + P3 a3, P4 a4) { + R ret; + Locker locker(isolate); + MATE_HANDLE_SCOPE(isolate); + v8::Local holder = function->NewHandle(); + v8::Local context = holder->CreationContext(); + v8::Context::Scope context_scope(context); + v8::Local args[] = { + ConvertToV8(isolate, a1), + ConvertToV8(isolate, a2), + ConvertToV8(isolate, a3), + ConvertToV8(isolate, a4), + }; + v8::Local val(holder->Call(holder, arraysize(args), args)); + Converter::FromV8(isolate, val, &ret); + return ret; + } +}; + +template +struct V8FunctionInvoker { + static void Go(v8::Isolate* isolate, SafeV8Function function, P1 a1, P2 a2, + P3 a3, P4 a4) { + Locker locker(isolate); + MATE_HANDLE_SCOPE(isolate); + v8::Local holder = function->NewHandle(); + v8::Local context = holder->CreationContext(); + v8::Context::Scope context_scope(context); + v8::Local args[] = { + ConvertToV8(isolate, a1), + ConvertToV8(isolate, a2), + ConvertToV8(isolate, a3), + ConvertToV8(isolate, a4), + }; + holder->Call(holder, arraysize(args), args); + } +}; + +template +struct V8FunctionInvoker(P1, P2, P3, P4, P5)> { + static v8::Local Go(v8::Isolate* isolate, SafeV8Function function, P1 a1, + P2 a2, P3 a3, P4 a4, P5 a5) { + Locker locker(isolate); + v8::EscapableHandleScope handle_scope(isolate); + v8::Local holder = function->NewHandle(); + v8::Local context = holder->CreationContext(); + v8::Context::Scope context_scope(context); + v8::Local args[] = { + ConvertToV8(isolate, a1), + ConvertToV8(isolate, a2), + ConvertToV8(isolate, a3), + ConvertToV8(isolate, a4), + ConvertToV8(isolate, a5), + }; + v8::Local val(holder->Call(holder, arraysize(args), args)); + return handle_scope.Escape(val); + } +}; + +template +struct V8FunctionInvoker { + static R Go(v8::Isolate* isolate, SafeV8Function function, P1 a1, P2 a2, + P3 a3, P4 a4, P5 a5) { + R ret; + Locker locker(isolate); + MATE_HANDLE_SCOPE(isolate); + v8::Local holder = function->NewHandle(); + v8::Local context = holder->CreationContext(); + v8::Context::Scope context_scope(context); + v8::Local args[] = { + ConvertToV8(isolate, a1), + ConvertToV8(isolate, a2), + ConvertToV8(isolate, a3), + ConvertToV8(isolate, a4), + ConvertToV8(isolate, a5), + }; + v8::Local val(holder->Call(holder, arraysize(args), args)); + Converter::FromV8(isolate, val, &ret); + return ret; + } +}; + +template +struct V8FunctionInvoker { + static void Go(v8::Isolate* isolate, SafeV8Function function, P1 a1, P2 a2, + P3 a3, P4 a4, P5 a5) { + Locker locker(isolate); + MATE_HANDLE_SCOPE(isolate); + v8::Local holder = function->NewHandle(); + v8::Local context = holder->CreationContext(); + v8::Context::Scope context_scope(context); + v8::Local args[] = { + ConvertToV8(isolate, a1), + ConvertToV8(isolate, a2), + ConvertToV8(isolate, a3), + ConvertToV8(isolate, a4), + ConvertToV8(isolate, a5), + }; + holder->Call(holder, arraysize(args), args); + } +}; + +template +struct V8FunctionInvoker(P1, P2, P3, P4, P5, P6)> { + static v8::Local Go(v8::Isolate* isolate, SafeV8Function function, P1 a1, + P2 a2, P3 a3, P4 a4, P5 a5, P6 a6) { + Locker locker(isolate); + v8::EscapableHandleScope handle_scope(isolate); + v8::Local holder = function->NewHandle(); + v8::Local context = holder->CreationContext(); + v8::Context::Scope context_scope(context); + v8::Local args[] = { + ConvertToV8(isolate, a1), + ConvertToV8(isolate, a2), + ConvertToV8(isolate, a3), + ConvertToV8(isolate, a4), + ConvertToV8(isolate, a5), + ConvertToV8(isolate, a6), + }; + v8::Local val(holder->Call(holder, arraysize(args), args)); + return handle_scope.Escape(val); + } +}; + +template +struct V8FunctionInvoker { + static R Go(v8::Isolate* isolate, SafeV8Function function, P1 a1, P2 a2, + P3 a3, P4 a4, P5 a5, P6 a6) { + R ret; + Locker locker(isolate); + MATE_HANDLE_SCOPE(isolate); + v8::Local holder = function->NewHandle(); + v8::Local context = holder->CreationContext(); + v8::Context::Scope context_scope(context); + v8::Local args[] = { + ConvertToV8(isolate, a1), + ConvertToV8(isolate, a2), + ConvertToV8(isolate, a3), + ConvertToV8(isolate, a4), + ConvertToV8(isolate, a5), + ConvertToV8(isolate, a6), + }; + v8::Local val(holder->Call(holder, arraysize(args), args)); + Converter::FromV8(isolate, val, &ret); + return ret; + } +}; + +template +struct V8FunctionInvoker { + static void Go(v8::Isolate* isolate, SafeV8Function function, P1 a1, P2 a2, + P3 a3, P4 a4, P5 a5, P6 a6) { + Locker locker(isolate); + MATE_HANDLE_SCOPE(isolate); + v8::Local holder = function->NewHandle(); + v8::Local context = holder->CreationContext(); + v8::Context::Scope context_scope(context); + v8::Local args[] = { + ConvertToV8(isolate, a1), + ConvertToV8(isolate, a2), + ConvertToV8(isolate, a3), + ConvertToV8(isolate, a4), + ConvertToV8(isolate, a5), + ConvertToV8(isolate, a6), + }; + holder->Call(holder, arraysize(args), args); + } +}; + +} // namespace internal + +template +struct Converter > { + static v8::Local ToV8(v8::Isolate* isolate, + const base::Callback& val) { + return CreateFunctionTemplate(isolate, val)->GetFunction(); + } + static bool FromV8(v8::Isolate* isolate, + v8::Local val, + base::Callback* out) { + if (!val->IsFunction()) + return false; + + internal::SafeV8Function function( + new RefCountedPersistent(isolate, val)); + *out = base::Bind(&internal::V8FunctionInvoker::Go, isolate, function); + return true; + } +}; + +} // namespace mate diff --git a/atom/renderer/api/atom_api_web_frame.cc b/atom/renderer/api/atom_api_web_frame.cc index 783650516bfa..d2c4ed2fa7b0 100644 --- a/atom/renderer/api/atom_api_web_frame.cc +++ b/atom/renderer/api/atom_api_web_frame.cc @@ -4,11 +4,11 @@ #include "atom/renderer/api/atom_api_web_frame.h" +#include "atom/common/native_mate_converters/callback.h" #include "atom/common/native_mate_converters/gfx_converter.h" #include "atom/common/native_mate_converters/string16_converter.h" #include "atom/renderer/api/atom_api_spell_check_client.h" #include "content/public/renderer/render_frame.h" -#include "native_mate/callback.h" #include "native_mate/dictionary.h" #include "native_mate/object_template_builder.h" #include "third_party/WebKit/public/web/WebDocument.h" diff --git a/filenames.gypi b/filenames.gypi index f7b9fca5e717..977eb1686fd9 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -274,6 +274,7 @@ 'atom/common/linux/application_info.cc', 'atom/common/native_mate_converters/accelerator_converter.cc', 'atom/common/native_mate_converters/accelerator_converter.h', + 'atom/common/native_mate_converters/callback.h', 'atom/common/native_mate_converters/file_path_converter.h', 'atom/common/native_mate_converters/gfx_converter.cc', 'atom/common/native_mate_converters/gfx_converter.h', diff --git a/vendor/native_mate b/vendor/native_mate index 656e403f0102..ebcf4c022467 160000 --- a/vendor/native_mate +++ b/vendor/native_mate @@ -1 +1 @@ -Subproject commit 656e403f0102c59428261c1eaad22912d2bbd3c5 +Subproject commit ebcf4c022467a43a5379446e1c031ffd10438b9c From 5c18d894530cf84bdcfa1890a485216f4a1cee38 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 7 Aug 2015 19:15:36 +0800 Subject: [PATCH 0806/1293] Reimplement callback.h with C++11 --- atom/common/native_mate_converters/callback.h | 418 ++---------------- 1 file changed, 34 insertions(+), 384 deletions(-) diff --git a/atom/common/native_mate_converters/callback.h b/atom/common/native_mate_converters/callback.h index 5dfcf9b25136..e7dc6af249f8 100644 --- a/atom/common/native_mate_converters/callback.h +++ b/atom/common/native_mate_converters/callback.h @@ -2,6 +2,8 @@ // Use of this source code is governed by the MIT license that can be // found in the LICENSE file. +#include + #include "base/bind.h" #include "base/callback.h" #include "native_mate/function_template.h" @@ -14,407 +16,55 @@ namespace internal { typedef scoped_refptr > SafeV8Function; -// This set of templates invokes a V8::Function by converting the C++ types. -template -struct V8FunctionInvoker; +template +struct V8FunctionInvoker {}; -template -struct V8FunctionInvoker()> { - static v8::Local Go(v8::Isolate* isolate, SafeV8Function function) { +template +struct V8FunctionInvoker(ArgTypes...)> { + static v8::Local Go(v8::Isolate* isolate, SafeV8Function function, + ArgTypes... raw) { Locker locker(isolate); v8::EscapableHandleScope handle_scope(isolate); v8::Local holder = function->NewHandle(); v8::Local context = holder->CreationContext(); v8::Context::Scope context_scope(context); - v8::Local val(holder->Call(holder, 0, NULL)); - return handle_scope.Escape(val); + std::vector> args = { ConvertToV8(isolate, raw)... }; + v8::Local ret(holder->Call(holder, args.size(), &args.front())); + return handle_scope.Escape(ret); } }; -template -struct V8FunctionInvoker { - static R Go(v8::Isolate* isolate, SafeV8Function function) { - R ret; +template +struct V8FunctionInvoker { + static void Go(v8::Isolate* isolate, SafeV8Function function, + ArgTypes... raw) { Locker locker(isolate); - MATE_HANDLE_SCOPE(isolate); + v8::HandleScope handle_scope(isolate); v8::Local holder = function->NewHandle(); v8::Local context = holder->CreationContext(); v8::Context::Scope context_scope(context); - v8::Local val(holder->Call(holder, 0, NULL)); - Converter::FromV8(isolate, val, &ret); + std::vector> args = { ConvertToV8(isolate, raw)... }; + holder->Call(holder, args.size(), &args.front()); + } +}; + +template +struct V8FunctionInvoker { + static ReturnType Go(v8::Isolate* isolate, SafeV8Function function, + ArgTypes... raw) { + Locker locker(isolate); + v8::HandleScope handle_scope(isolate); + v8::Local holder = function->NewHandle(); + v8::Local context = holder->CreationContext(); + v8::Context::Scope context_scope(context); + ReturnType ret; + std::vector> args = { ConvertToV8(isolate, raw)... }; + v8::Local val(holder->Call(holder, args.size(), &args.front())); + Converter::FromV8(isolate, val, &ret); return ret; } }; -template<> -struct V8FunctionInvoker { - static void Go(v8::Isolate* isolate, SafeV8Function function) { - Locker locker(isolate); - MATE_HANDLE_SCOPE(isolate); - v8::Local holder = function->NewHandle(); - v8::Local context = holder->CreationContext(); - v8::Context::Scope context_scope(context); - holder->Call(holder, 0, NULL); - } -}; - -template -struct V8FunctionInvoker(P1)> { - static v8::Local Go(v8::Isolate* isolate, SafeV8Function function, P1 a1) { - Locker locker(isolate); - v8::EscapableHandleScope handle_scope(isolate); - v8::Local holder = function->NewHandle(); - v8::Local context = holder->CreationContext(); - v8::Context::Scope context_scope(context); - v8::Local args[] = { - ConvertToV8(isolate, a1), - }; - v8::Local val(holder->Call(holder, arraysize(args), args)); - return handle_scope.Escape(val); - } -}; - -template -struct V8FunctionInvoker { - static R Go(v8::Isolate* isolate, SafeV8Function function, P1 a1) { - R ret; - Locker locker(isolate); - MATE_HANDLE_SCOPE(isolate); - v8::Local holder = function->NewHandle(); - v8::Local context = holder->CreationContext(); - v8::Context::Scope context_scope(context); - v8::Local args[] = { - ConvertToV8(isolate, a1), - }; - v8::Local val(holder->Call(holder, arraysize(args), args)); - Converter::FromV8(isolate, val, &ret); - return ret; - } -}; - -template -struct V8FunctionInvoker { - static void Go(v8::Isolate* isolate, SafeV8Function function, P1 a1) { - Locker locker(isolate); - MATE_HANDLE_SCOPE(isolate); - v8::Local holder = function->NewHandle(); - v8::Local context = holder->CreationContext(); - v8::Context::Scope context_scope(context); - v8::Local args[] = { - ConvertToV8(isolate, a1), - }; - holder->Call(holder, arraysize(args), args); - } -}; - -template -struct V8FunctionInvoker(P1, P2)> { - static v8::Local Go(v8::Isolate* isolate, SafeV8Function function, P1 a1, - P2 a2) { - Locker locker(isolate); - v8::EscapableHandleScope handle_scope(isolate); - v8::Local holder = function->NewHandle(); - v8::Local context = holder->CreationContext(); - v8::Context::Scope context_scope(context); - v8::Local args[] = { - ConvertToV8(isolate, a1), - ConvertToV8(isolate, a2), - }; - v8::Local val(holder->Call(holder, arraysize(args), args)); - return handle_scope.Escape(val); - } -}; - -template -struct V8FunctionInvoker { - static R Go(v8::Isolate* isolate, SafeV8Function function, P1 a1, P2 a2) { - R ret; - Locker locker(isolate); - MATE_HANDLE_SCOPE(isolate); - v8::Local holder = function->NewHandle(); - v8::Local context = holder->CreationContext(); - v8::Context::Scope context_scope(context); - v8::Local args[] = { - ConvertToV8(isolate, a1), - ConvertToV8(isolate, a2), - }; - v8::Local val(holder->Call(holder, arraysize(args), args)); - Converter::FromV8(isolate, val, &ret); - return ret; - } -}; - -template -struct V8FunctionInvoker { - static void Go(v8::Isolate* isolate, SafeV8Function function, P1 a1, P2 a2) { - Locker locker(isolate); - MATE_HANDLE_SCOPE(isolate); - v8::Local holder = function->NewHandle(); - v8::Local context = holder->CreationContext(); - v8::Context::Scope context_scope(context); - v8::Local args[] = { - ConvertToV8(isolate, a1), - ConvertToV8(isolate, a2), - }; - holder->Call(holder, arraysize(args), args); - } -}; - -template -struct V8FunctionInvoker(P1, P2, P3)> { - static v8::Local Go(v8::Isolate* isolate, SafeV8Function function, P1 a1, - P2 a2, P3 a3) { - Locker locker(isolate); - v8::EscapableHandleScope handle_scope(isolate); - v8::Local holder = function->NewHandle(); - v8::Local context = holder->CreationContext(); - v8::Context::Scope context_scope(context); - v8::Local args[] = { - ConvertToV8(isolate, a1), - ConvertToV8(isolate, a2), - ConvertToV8(isolate, a3), - }; - v8::Local val(holder->Call(holder, arraysize(args), args)); - return handle_scope.Escape(val); - } -}; - -template -struct V8FunctionInvoker { - static R Go(v8::Isolate* isolate, SafeV8Function function, P1 a1, P2 a2, - P3 a3) { - R ret; - Locker locker(isolate); - MATE_HANDLE_SCOPE(isolate); - v8::Local holder = function->NewHandle(); - v8::Local context = holder->CreationContext(); - v8::Context::Scope context_scope(context); - v8::Local args[] = { - ConvertToV8(isolate, a1), - ConvertToV8(isolate, a2), - ConvertToV8(isolate, a3), - }; - v8::Local val(holder->Call(holder, arraysize(args), args)); - Converter::FromV8(isolate, val, &ret); - return ret; - } -}; - -template -struct V8FunctionInvoker { - static void Go(v8::Isolate* isolate, SafeV8Function function, P1 a1, P2 a2, - P3 a3) { - Locker locker(isolate); - MATE_HANDLE_SCOPE(isolate); - v8::Local holder = function->NewHandle(); - v8::Local context = holder->CreationContext(); - v8::Context::Scope context_scope(context); - v8::Local args[] = { - ConvertToV8(isolate, a1), - ConvertToV8(isolate, a2), - ConvertToV8(isolate, a3), - }; - holder->Call(holder, arraysize(args), args); - } -}; - -template -struct V8FunctionInvoker(P1, P2, P3, P4)> { - static v8::Local Go(v8::Isolate* isolate, SafeV8Function function, P1 a1, - P2 a2, P3 a3, P4 a4) { - Locker locker(isolate); - v8::EscapableHandleScope handle_scope(isolate); - v8::Local holder = function->NewHandle(); - v8::Local context = holder->CreationContext(); - v8::Context::Scope context_scope(context); - v8::Local args[] = { - ConvertToV8(isolate, a1), - ConvertToV8(isolate, a2), - ConvertToV8(isolate, a3), - ConvertToV8(isolate, a4), - }; - v8::Local val(holder->Call(holder, arraysize(args), args)); - return handle_scope.Escape(val); - } -}; - -template -struct V8FunctionInvoker { - static R Go(v8::Isolate* isolate, SafeV8Function function, P1 a1, P2 a2, - P3 a3, P4 a4) { - R ret; - Locker locker(isolate); - MATE_HANDLE_SCOPE(isolate); - v8::Local holder = function->NewHandle(); - v8::Local context = holder->CreationContext(); - v8::Context::Scope context_scope(context); - v8::Local args[] = { - ConvertToV8(isolate, a1), - ConvertToV8(isolate, a2), - ConvertToV8(isolate, a3), - ConvertToV8(isolate, a4), - }; - v8::Local val(holder->Call(holder, arraysize(args), args)); - Converter::FromV8(isolate, val, &ret); - return ret; - } -}; - -template -struct V8FunctionInvoker { - static void Go(v8::Isolate* isolate, SafeV8Function function, P1 a1, P2 a2, - P3 a3, P4 a4) { - Locker locker(isolate); - MATE_HANDLE_SCOPE(isolate); - v8::Local holder = function->NewHandle(); - v8::Local context = holder->CreationContext(); - v8::Context::Scope context_scope(context); - v8::Local args[] = { - ConvertToV8(isolate, a1), - ConvertToV8(isolate, a2), - ConvertToV8(isolate, a3), - ConvertToV8(isolate, a4), - }; - holder->Call(holder, arraysize(args), args); - } -}; - -template -struct V8FunctionInvoker(P1, P2, P3, P4, P5)> { - static v8::Local Go(v8::Isolate* isolate, SafeV8Function function, P1 a1, - P2 a2, P3 a3, P4 a4, P5 a5) { - Locker locker(isolate); - v8::EscapableHandleScope handle_scope(isolate); - v8::Local holder = function->NewHandle(); - v8::Local context = holder->CreationContext(); - v8::Context::Scope context_scope(context); - v8::Local args[] = { - ConvertToV8(isolate, a1), - ConvertToV8(isolate, a2), - ConvertToV8(isolate, a3), - ConvertToV8(isolate, a4), - ConvertToV8(isolate, a5), - }; - v8::Local val(holder->Call(holder, arraysize(args), args)); - return handle_scope.Escape(val); - } -}; - -template -struct V8FunctionInvoker { - static R Go(v8::Isolate* isolate, SafeV8Function function, P1 a1, P2 a2, - P3 a3, P4 a4, P5 a5) { - R ret; - Locker locker(isolate); - MATE_HANDLE_SCOPE(isolate); - v8::Local holder = function->NewHandle(); - v8::Local context = holder->CreationContext(); - v8::Context::Scope context_scope(context); - v8::Local args[] = { - ConvertToV8(isolate, a1), - ConvertToV8(isolate, a2), - ConvertToV8(isolate, a3), - ConvertToV8(isolate, a4), - ConvertToV8(isolate, a5), - }; - v8::Local val(holder->Call(holder, arraysize(args), args)); - Converter::FromV8(isolate, val, &ret); - return ret; - } -}; - -template -struct V8FunctionInvoker { - static void Go(v8::Isolate* isolate, SafeV8Function function, P1 a1, P2 a2, - P3 a3, P4 a4, P5 a5) { - Locker locker(isolate); - MATE_HANDLE_SCOPE(isolate); - v8::Local holder = function->NewHandle(); - v8::Local context = holder->CreationContext(); - v8::Context::Scope context_scope(context); - v8::Local args[] = { - ConvertToV8(isolate, a1), - ConvertToV8(isolate, a2), - ConvertToV8(isolate, a3), - ConvertToV8(isolate, a4), - ConvertToV8(isolate, a5), - }; - holder->Call(holder, arraysize(args), args); - } -}; - -template -struct V8FunctionInvoker(P1, P2, P3, P4, P5, P6)> { - static v8::Local Go(v8::Isolate* isolate, SafeV8Function function, P1 a1, - P2 a2, P3 a3, P4 a4, P5 a5, P6 a6) { - Locker locker(isolate); - v8::EscapableHandleScope handle_scope(isolate); - v8::Local holder = function->NewHandle(); - v8::Local context = holder->CreationContext(); - v8::Context::Scope context_scope(context); - v8::Local args[] = { - ConvertToV8(isolate, a1), - ConvertToV8(isolate, a2), - ConvertToV8(isolate, a3), - ConvertToV8(isolate, a4), - ConvertToV8(isolate, a5), - ConvertToV8(isolate, a6), - }; - v8::Local val(holder->Call(holder, arraysize(args), args)); - return handle_scope.Escape(val); - } -}; - -template -struct V8FunctionInvoker { - static R Go(v8::Isolate* isolate, SafeV8Function function, P1 a1, P2 a2, - P3 a3, P4 a4, P5 a5, P6 a6) { - R ret; - Locker locker(isolate); - MATE_HANDLE_SCOPE(isolate); - v8::Local holder = function->NewHandle(); - v8::Local context = holder->CreationContext(); - v8::Context::Scope context_scope(context); - v8::Local args[] = { - ConvertToV8(isolate, a1), - ConvertToV8(isolate, a2), - ConvertToV8(isolate, a3), - ConvertToV8(isolate, a4), - ConvertToV8(isolate, a5), - ConvertToV8(isolate, a6), - }; - v8::Local val(holder->Call(holder, arraysize(args), args)); - Converter::FromV8(isolate, val, &ret); - return ret; - } -}; - -template -struct V8FunctionInvoker { - static void Go(v8::Isolate* isolate, SafeV8Function function, P1 a1, P2 a2, - P3 a3, P4 a4, P5 a5, P6 a6) { - Locker locker(isolate); - MATE_HANDLE_SCOPE(isolate); - v8::Local holder = function->NewHandle(); - v8::Local context = holder->CreationContext(); - v8::Context::Scope context_scope(context); - v8::Local args[] = { - ConvertToV8(isolate, a1), - ConvertToV8(isolate, a2), - ConvertToV8(isolate, a3), - ConvertToV8(isolate, a4), - ConvertToV8(isolate, a5), - ConvertToV8(isolate, a6), - }; - holder->Call(holder, arraysize(args), args); - } -}; - } // namespace internal template From 1bb0dde360e0da83f955aba4407b4d9a6a9ce6e6 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 7 Aug 2015 19:34:00 +0800 Subject: [PATCH 0807/1293] Use WebScopedRunV8Script in converted C++ functions --- atom/browser/api/atom_api_web_contents.cc | 2 +- atom/browser/api/event_emitter.h | 2 +- atom/common/{ => api}/event_emitter_caller.cc | 16 +++------ atom/common/{ => api}/event_emitter_caller.h | 6 ++-- atom/common/api/locker.cc | 17 ++++++++++ atom/common/api/locker.h | 34 +++++++++++++++++++ atom/common/native_mate_converters/callback.h | 17 +++++++++- atom/common/node_bindings.cc | 4 +-- atom/renderer/atom_render_view_observer.cc | 2 +- filenames.gypi | 6 ++-- script/lib/config.py | 2 +- vendor/native_mate | 2 +- 12 files changed, 85 insertions(+), 25 deletions(-) rename atom/common/{ => api}/event_emitter_caller.cc (69%) rename atom/common/{ => api}/event_emitter_caller.h (92%) create mode 100644 atom/common/api/locker.cc create mode 100644 atom/common/api/locker.h diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 6adcf5377357..63707f8dcc2d 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -13,7 +13,7 @@ #include "atom/browser/native_window.h" #include "atom/browser/web_view_guest_delegate.h" #include "atom/common/api/api_messages.h" -#include "atom/common/event_emitter_caller.h" +#include "atom/common/api/event_emitter_caller.h" #include "atom/common/native_mate_converters/callback.h" #include "atom/common/native_mate_converters/file_path_converter.h" #include "atom/common/native_mate_converters/gfx_converter.h" diff --git a/atom/browser/api/event_emitter.h b/atom/browser/api/event_emitter.h index 178c61d853ca..4fb953b63992 100644 --- a/atom/browser/api/event_emitter.h +++ b/atom/browser/api/event_emitter.h @@ -7,7 +7,7 @@ #include -#include "atom/common/event_emitter_caller.h" +#include "atom/common/api/event_emitter_caller.h" #include "native_mate/wrappable.h" namespace content { diff --git a/atom/common/event_emitter_caller.cc b/atom/common/api/event_emitter_caller.cc similarity index 69% rename from atom/common/event_emitter_caller.cc rename to atom/common/api/event_emitter_caller.cc index 68c48217a364..6b0a07ad414a 100644 --- a/atom/common/event_emitter_caller.cc +++ b/atom/common/api/event_emitter_caller.cc @@ -2,8 +2,9 @@ // Use of this source code is governed by the MIT license that can be // found in the LICENSE file. -#include "atom/common/event_emitter_caller.h" +#include "atom/common/api/event_emitter_caller.h" +#include "atom/common/api/locker.h" #include "base/memory/scoped_ptr.h" #include "third_party/WebKit/public/web/WebScopedMicrotaskSuppression.h" @@ -13,22 +14,13 @@ namespace mate { namespace internal { -namespace { - -// Returns whether current process is browser process, currently we detect it -// by checking whether current has used V8 Lock, but it might be a bad idea. -inline bool IsBrowserProcess() { - return v8::Locker::IsActive(); -} - -} // namespace - v8::Local CallEmitWithArgs(v8::Isolate* isolate, v8::Local obj, ValueVector* args) { // Perform microtask checkpoint after running JavaScript. scoped_ptr script_scope( - IsBrowserProcess() ? nullptr : new blink::WebScopedRunV8Script(isolate)); + Locker::IsBrowserProcess() ? + nullptr : new blink::WebScopedRunV8Script(isolate)); // Use node::MakeCallback to call the callback, and it will also run pending // tasks in Node.js. return node::MakeCallback( diff --git a/atom/common/event_emitter_caller.h b/atom/common/api/event_emitter_caller.h similarity index 92% rename from atom/common/event_emitter_caller.h rename to atom/common/api/event_emitter_caller.h index e8ad50a45378..a2567da9d109 100644 --- a/atom/common/event_emitter_caller.h +++ b/atom/common/api/event_emitter_caller.h @@ -2,8 +2,8 @@ // Use of this source code is governed by the MIT license that can be // found in the LICENSE file. -#ifndef ATOM_COMMON_EVENT_EMITTER_CALLER_H_ -#define ATOM_COMMON_EVENT_EMITTER_CALLER_H_ +#ifndef ATOM_COMMON_API_EVENT_EMITTER_CALLER_H_ +#define ATOM_COMMON_API_EVENT_EMITTER_CALLER_H_ #include @@ -50,4 +50,4 @@ v8::Local EmitEvent(v8::Isolate* isolate, } // namespace mate -#endif // ATOM_COMMON_EVENT_EMITTER_CALLER_H_ +#endif // ATOM_COMMON_API_EVENT_EMITTER_CALLER_H_ diff --git a/atom/common/api/locker.cc b/atom/common/api/locker.cc new file mode 100644 index 000000000000..fe0b23479a46 --- /dev/null +++ b/atom/common/api/locker.cc @@ -0,0 +1,17 @@ +// Copyright 2014 The Chromium Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE.chromium file. + +#include "atom/common/api/locker.h" + +namespace mate { + +Locker::Locker(v8::Isolate* isolate) { + if (IsBrowserProcess()) + locker_.reset(new v8::Locker(isolate)); +} + +Locker::~Locker() { +} + +} // namespace mate diff --git a/atom/common/api/locker.h b/atom/common/api/locker.h new file mode 100644 index 000000000000..201217ff625a --- /dev/null +++ b/atom/common/api/locker.h @@ -0,0 +1,34 @@ +// Copyright 2014 The Chromium Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE.chromium file. + +#ifndef ATOM_COMMON_API_LOCKER_H_ +#define ATOM_COMMON_API_LOCKER_H_ + +#include "base/memory/scoped_ptr.h" +#include "v8/include/v8.h" + +namespace mate { + +// Only lock when lockers are used in current thread. +class Locker { + public: + explicit Locker(v8::Isolate* isolate); + ~Locker(); + + // Returns whether current process is browser process, currently we detect it + // by checking whether current has used V8 Lock, but it might be a bad idea. + static inline bool IsBrowserProcess() { return v8::Locker::IsActive(); } + + private: + void* operator new(size_t size); + void operator delete(void*, size_t); + + scoped_ptr locker_; + + DISALLOW_COPY_AND_ASSIGN(Locker); +}; + +} // namespace mate + +#endif // ATOM_COMMON_API_LOCKER_H_ diff --git a/atom/common/native_mate_converters/callback.h b/atom/common/native_mate_converters/callback.h index e7dc6af249f8..6e51cda79c49 100644 --- a/atom/common/native_mate_converters/callback.h +++ b/atom/common/native_mate_converters/callback.h @@ -2,13 +2,17 @@ // Use of this source code is governed by the MIT license that can be // found in the LICENSE file. +#ifndef ATOM_COMMON_NATIVE_MATE_CONVERTERS_CALLBACK_H_ +#define ATOM_COMMON_NATIVE_MATE_CONVERTERS_CALLBACK_H_ + #include +#include "atom/common/api/locker.h" #include "base/bind.h" #include "base/callback.h" #include "native_mate/function_template.h" -#include "native_mate/locker.h" #include "native_mate/scoped_persistent.h" +#include "third_party/WebKit/public/web/WebScopedMicrotaskSuppression.h" namespace mate { @@ -25,6 +29,9 @@ struct V8FunctionInvoker(ArgTypes...)> { ArgTypes... raw) { Locker locker(isolate); v8::EscapableHandleScope handle_scope(isolate); + scoped_ptr script_scope( + Locker::IsBrowserProcess() ? + nullptr : new blink::WebScopedRunV8Script(isolate)); v8::Local holder = function->NewHandle(); v8::Local context = holder->CreationContext(); v8::Context::Scope context_scope(context); @@ -40,6 +47,9 @@ struct V8FunctionInvoker { ArgTypes... raw) { Locker locker(isolate); v8::HandleScope handle_scope(isolate); + scoped_ptr script_scope( + Locker::IsBrowserProcess() ? + nullptr : new blink::WebScopedRunV8Script(isolate)); v8::Local holder = function->NewHandle(); v8::Local context = holder->CreationContext(); v8::Context::Scope context_scope(context); @@ -54,6 +64,9 @@ struct V8FunctionInvoker { ArgTypes... raw) { Locker locker(isolate); v8::HandleScope handle_scope(isolate); + scoped_ptr script_scope( + Locker::IsBrowserProcess() ? + nullptr : new blink::WebScopedRunV8Script(isolate)); v8::Local holder = function->NewHandle(); v8::Local context = holder->CreationContext(); v8::Context::Scope context_scope(context); @@ -87,3 +100,5 @@ struct Converter > { }; } // namespace mate + +#endif // ATOM_COMMON_NATIVE_MATE_CONVERTERS_CALLBACK_H_ diff --git a/atom/common/node_bindings.cc b/atom/common/node_bindings.cc index b329589552ba..304b6a711a5c 100644 --- a/atom/common/node_bindings.cc +++ b/atom/common/node_bindings.cc @@ -7,8 +7,9 @@ #include #include +#include "atom/common/api/event_emitter_caller.h" +#include "atom/common/api/locker.h" #include "atom/common/atom_command_line.h" -#include "atom/common/event_emitter_caller.h" #include "atom/common/native_mate_converters/file_path_converter.h" #include "base/command_line.h" #include "base/base_paths.h" @@ -17,7 +18,6 @@ #include "base/path_service.h" #include "content/public/browser/browser_thread.h" #include "content/public/common/content_paths.h" -#include "native_mate/locker.h" #include "native_mate/dictionary.h" #include "third_party/WebKit/public/web/WebScopedMicrotaskSuppression.h" diff --git a/atom/renderer/atom_render_view_observer.cc b/atom/renderer/atom_render_view_observer.cc index 686481327f5b..1f199ea445c6 100644 --- a/atom/renderer/atom_render_view_observer.cc +++ b/atom/renderer/atom_render_view_observer.cc @@ -11,7 +11,7 @@ #include "atom/common/native_mate_converters/string16_converter.h" #include "atom/common/api/api_messages.h" -#include "atom/common/event_emitter_caller.h" +#include "atom/common/api/event_emitter_caller.h" #include "atom/common/native_mate_converters/value_converter.h" #include "atom/common/options_switches.h" #include "atom/renderer/atom_renderer_client.h" diff --git a/filenames.gypi b/filenames.gypi index 977eb1686fd9..b062c6e932b9 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -238,6 +238,10 @@ 'atom/common/api/atom_api_v8_util.cc', 'atom/common/api/atom_bindings.cc', 'atom/common/api/atom_bindings.h', + 'atom/common/api/event_emitter_caller.cc', + 'atom/common/api/event_emitter_caller.h', + 'atom/common/api/locker.cc', + 'atom/common/api/locker.h', 'atom/common/api/object_life_monitor.cc', 'atom/common/api/object_life_monitor.h', 'atom/common/asar/archive.cc', @@ -266,8 +270,6 @@ 'atom/common/crash_reporter/win/crash_service_main.h', 'atom/common/draggable_region.cc', 'atom/common/draggable_region.h', - 'atom/common/event_emitter_caller.cc', - 'atom/common/event_emitter_caller.h', 'atom/common/google_api_key.h', 'atom/common/id_weak_map.cc', 'atom/common/id_weak_map.h', diff --git a/script/lib/config.py b/script/lib/config.py index 144ec87c677b..1298651b7edf 100644 --- a/script/lib/config.py +++ b/script/lib/config.py @@ -7,7 +7,7 @@ import sys BASE_URL = os.getenv('LIBCHROMIUMCONTENT_MIRROR') or \ - 'http://gh-contractor-zcbenz.s3.amazonaws.com/libchromiumcontent' + 'http://github-janky-artifacts.s3.amazonaws.com/libchromiumcontent' LIBCHROMIUMCONTENT_COMMIT = 'dd51a41b42246b0b5159bfad5e327c8cf10bc585' PLATFORM = { diff --git a/vendor/native_mate b/vendor/native_mate index ebcf4c022467..67d9eaa215e8 160000 --- a/vendor/native_mate +++ b/vendor/native_mate @@ -1 +1 @@ -Subproject commit ebcf4c022467a43a5379446e1c031ffd10438b9c +Subproject commit 67d9eaa215e8727d86dc7b1f7a10be8699848f1f From c51f349dfabd03e7cc82d25973faf53157424008 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 7 Aug 2015 21:26:24 +0800 Subject: [PATCH 0808/1293] Run microtask before handling pending process.nextTick tasks This follows the behavior of Node.js. --- atom/common/api/atom_bindings.cc | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/atom/common/api/atom_bindings.cc b/atom/common/api/atom_bindings.cc index fa4a88d58437..c748647f48d0 100644 --- a/atom/common/api/atom_bindings.cc +++ b/atom/common/api/atom_bindings.cc @@ -98,6 +98,10 @@ void AtomBindings::OnCallNextTick(uv_async_t* handle) { if (tick_info->in_tick()) continue; + if (tick_info->length() == 0) { + env->isolate()->RunMicrotasks(); + } + if (tick_info->length() == 0) { tick_info->set_index(0); continue; From 0bf5effe58b06732da5e2d2a48f2a5a4a8fcda6f Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 7 Aug 2015 22:04:59 +0800 Subject: [PATCH 0809/1293] Bump v0.30.3 --- atom.gyp | 2 +- atom/browser/resources/mac/Info.plist | 2 +- atom/browser/resources/win/atom.rc | 8 ++++---- atom/common/atom_version.h | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/atom.gyp b/atom.gyp index dc53c6b9575d..620464e22574 100644 --- a/atom.gyp +++ b/atom.gyp @@ -4,7 +4,7 @@ 'product_name%': 'Electron', 'company_name%': 'GitHub, Inc', 'company_abbr%': 'github', - 'version%': '0.30.2', + 'version%': '0.30.3', }, 'includes': [ 'filenames.gypi', diff --git a/atom/browser/resources/mac/Info.plist b/atom/browser/resources/mac/Info.plist index aad2ec56db68..23af6a804901 100644 --- a/atom/browser/resources/mac/Info.plist +++ b/atom/browser/resources/mac/Info.plist @@ -17,7 +17,7 @@ CFBundleIconFile atom.icns CFBundleVersion - 0.30.2 + 0.30.3 LSMinimumSystemVersion 10.8.0 NSMainNibFile diff --git a/atom/browser/resources/win/atom.rc b/atom/browser/resources/win/atom.rc index 68eff5577f08..2379d294a35c 100644 --- a/atom/browser/resources/win/atom.rc +++ b/atom/browser/resources/win/atom.rc @@ -56,8 +56,8 @@ END // VS_VERSION_INFO VERSIONINFO - FILEVERSION 0,30,2,0 - PRODUCTVERSION 0,30,2,0 + FILEVERSION 0,30,3,0 + PRODUCTVERSION 0,30,3,0 FILEFLAGSMASK 0x3fL #ifdef _DEBUG FILEFLAGS 0x1L @@ -74,12 +74,12 @@ BEGIN BEGIN VALUE "CompanyName", "GitHub, Inc." VALUE "FileDescription", "Electron" - VALUE "FileVersion", "0.30.2" + VALUE "FileVersion", "0.30.3" VALUE "InternalName", "electron.exe" VALUE "LegalCopyright", "Copyright (C) 2015 GitHub, Inc. All rights reserved." VALUE "OriginalFilename", "electron.exe" VALUE "ProductName", "Electron" - VALUE "ProductVersion", "0.30.2" + VALUE "ProductVersion", "0.30.3" VALUE "SquirrelAwareVersion", "1" END END diff --git a/atom/common/atom_version.h b/atom/common/atom_version.h index 5612bd6463fc..761c7463bb08 100644 --- a/atom/common/atom_version.h +++ b/atom/common/atom_version.h @@ -7,7 +7,7 @@ #define ATOM_MAJOR_VERSION 0 #define ATOM_MINOR_VERSION 30 -#define ATOM_PATCH_VERSION 2 +#define ATOM_PATCH_VERSION 3 #define ATOM_VERSION_IS_RELEASE 1 From bec7a399cbdf5ecb87a5691bfad675d81df8e2b9 Mon Sep 17 00:00:00 2001 From: Eran Tiktin Date: Sat, 8 Aug 2015 17:58:05 +0300 Subject: [PATCH 0810/1293] Add support for using .ico icon files on Windows NativeImage::CreateFromPath now supports loading .ico icon files on Windows. --- atom/common/api/atom_api_native_image.cc | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/atom/common/api/atom_api_native_image.cc b/atom/common/api/atom_api_native_image.cc index bd66ad511f75..1f1fc9ff2ab7 100644 --- a/atom/common/api/atom_api_native_image.cc +++ b/atom/common/api/atom_api_native_image.cc @@ -22,6 +22,9 @@ #include "ui/gfx/geometry/size.h" #include "ui/gfx/image/image_skia.h" #include "ui/gfx/image/image_util.h" +#if defined(OS_WIN) +#include "ui/gfx/icon_util.h" +#endif #include "atom/common/node_includes.h" @@ -213,7 +216,23 @@ mate::Handle NativeImage::CreateFromJPEG( mate::Handle NativeImage::CreateFromPath( v8::Isolate* isolate, const base::FilePath& path) { gfx::ImageSkia image_skia; - PopulateImageSkiaRepsFromPath(&image_skia, path); + if (path.MatchesExtension(FILE_PATH_LITERAL(".ico"))) { +#if defined(OS_WIN) + HICON icon = static_cast(LoadImage(NULL, + path.value().c_str(), + IMAGE_ICON, + 0, + 0, + LR_DEFAULTSIZE | LR_LOADFROMFILE)); + if (icon) { + scoped_ptr bitmap(IconUtil::CreateSkBitmapFromHICON(icon)); + image_skia = *(new gfx::ImageSkia(gfx::ImageSkiaRep(*bitmap, 1.0f))); + DestroyIcon(icon); + } +#endif + } else { + PopulateImageSkiaRepsFromPath(&image_skia, path); + } gfx::Image image(image_skia); mate::Handle handle = Create(isolate, image); #if defined(OS_MACOSX) From ab1b4c46b264919b6c92c0e079c385ac9d390908 Mon Sep 17 00:00:00 2001 From: Eran Tiktin Date: Sat, 8 Aug 2015 18:31:12 +0300 Subject: [PATCH 0811/1293] Converted tabs to spaces --- atom/common/api/atom_api_native_image.cc | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/atom/common/api/atom_api_native_image.cc b/atom/common/api/atom_api_native_image.cc index 1f1fc9ff2ab7..1594dcb8f8f7 100644 --- a/atom/common/api/atom_api_native_image.cc +++ b/atom/common/api/atom_api_native_image.cc @@ -219,11 +219,11 @@ mate::Handle NativeImage::CreateFromPath( if (path.MatchesExtension(FILE_PATH_LITERAL(".ico"))) { #if defined(OS_WIN) HICON icon = static_cast(LoadImage(NULL, - path.value().c_str(), - IMAGE_ICON, - 0, - 0, - LR_DEFAULTSIZE | LR_LOADFROMFILE)); + path.value().c_str(), + IMAGE_ICON, + 0, + 0, + LR_DEFAULTSIZE | LR_LOADFROMFILE)); if (icon) { scoped_ptr bitmap(IconUtil::CreateSkBitmapFromHICON(icon)); image_skia = *(new gfx::ImageSkia(gfx::ImageSkiaRep(*bitmap, 1.0f))); From c4950883907e09871a2a2811be774c7d252404a8 Mon Sep 17 00:00:00 2001 From: Eran Tiktin Date: Sat, 8 Aug 2015 19:08:09 +0300 Subject: [PATCH 0812/1293] Updated native-image.md Add a mention of the support for .ico files on Windows --- docs/api/native-image.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/api/native-image.md b/docs/api/native-image.md index ed12819d26c4..24540b500702 100644 --- a/docs/api/native-image.md +++ b/docs/api/native-image.md @@ -21,8 +21,10 @@ var appIcon = new Tray(image); ## Supported formats -Currently `PNG` and `JPEG` are supported. It is recommended to use `PNG` -because of its support for transparency and lossless compression. +Currently `PNG` and `JPEG` are supported. It is recommended to use `PNG` because +of its support for transparency and lossless compression. + +On Windows, you can also load `ICO` icon from a file path. ## High resolution image From b67070f0ae27b8ba32f861cc06f84d4b6900515d Mon Sep 17 00:00:00 2001 From: Eran Tiktin Date: Sat, 8 Aug 2015 20:03:34 +0300 Subject: [PATCH 0813/1293] Made the tests ignore the line ending I had 4 asar tests fail because, the testing assumed that the file content ends with UNIX line endings (\n), while it was using Windows line endings (git probably changed them when I cloned the project on Windows). Since the line ending is not what matters in the tests, I trimmed them and now all the tests pass as expected. --- spec/asar-spec.coffee | 42 +++++++++++++++++++++--------------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/spec/asar-spec.coffee b/spec/asar-spec.coffee index a49417258fec..4ef9337f3abe 100644 --- a/spec/asar-spec.coffee +++ b/spec/asar-spec.coffee @@ -10,11 +10,11 @@ describe 'asar package', -> describe 'fs.readFileSync', -> it 'reads a normal file', -> file1 = path.join fixtures, 'asar', 'a.asar', 'file1' - assert.equal fs.readFileSync(file1).toString(), 'file1\n' + assert.equal fs.readFileSync(file1).toString().trim(), 'file1' file2 = path.join fixtures, 'asar', 'a.asar', 'file2' - assert.equal fs.readFileSync(file2).toString(), 'file2\n' + assert.equal fs.readFileSync(file2).toString().trim(), 'file2' file3 = path.join fixtures, 'asar', 'a.asar', 'file3' - assert.equal fs.readFileSync(file3).toString(), 'file3\n' + assert.equal fs.readFileSync(file3).toString().trim(), 'file3' it 'reads from a empty file', -> file = path.join fixtures, 'asar', 'empty.asar', 'file1' @@ -24,13 +24,13 @@ describe 'asar package', -> it 'reads a linked file', -> p = path.join fixtures, 'asar', 'a.asar', 'link1' - assert.equal fs.readFileSync(p).toString(), 'file1\n' + assert.equal fs.readFileSync(p).toString().trim(), 'file1' it 'reads a file from linked directory', -> p = path.join fixtures, 'asar', 'a.asar', 'link2', 'file1' - assert.equal fs.readFileSync(p).toString(), 'file1\n' + assert.equal fs.readFileSync(p).toString().trim(), 'file1' p = path.join fixtures, 'asar', 'a.asar', 'link2', 'link2', 'file1' - assert.equal fs.readFileSync(p).toString(), 'file1\n' + assert.equal fs.readFileSync(p).toString().trim(), 'file1' it 'throws ENOENT error when can not find file', -> p = path.join fixtures, 'asar', 'a.asar', 'not-exist' @@ -47,14 +47,14 @@ describe 'asar package', -> it 'reads a normal file with unpacked files', -> p = path.join fixtures, 'asar', 'unpack.asar', 'a.txt' - assert.equal fs.readFileSync(p).toString(), 'a\n' + assert.equal fs.readFileSync(p).toString().trim(), 'a' describe 'fs.readFile', -> it 'reads a normal file', (done) -> p = path.join fixtures, 'asar', 'a.asar', 'file1' fs.readFile p, (err, content) -> assert.equal err, null - assert.equal String(content), 'file1\n' + assert.equal String(content).trim(), 'file1' done() it 'reads from a empty file', (done) -> @@ -68,14 +68,14 @@ describe 'asar package', -> p = path.join fixtures, 'asar', 'a.asar', 'link1' fs.readFile p, (err, content) -> assert.equal err, null - assert.equal String(content), 'file1\n' + assert.equal String(content).trim(), 'file1' done() it 'reads a file from linked directory', (done) -> p = path.join fixtures, 'asar', 'a.asar', 'link2', 'link2', 'file1' fs.readFile p, (err, content) -> assert.equal err, null - assert.equal String(content), 'file1\n' + assert.equal String(content).trim(), 'file1' done() it 'throws ENOENT error when can not find file', (done) -> @@ -342,7 +342,7 @@ describe 'asar package', -> fd = fs.openSync p, 'r' buffer = new Buffer(6) fs.readSync fd, buffer, 0, 6, 0 - assert.equal String(buffer), 'file1\n' + assert.equal String(buffer).trim(), 'file1' fs.closeSync fd it 'throws ENOENT error when can not find file', -> @@ -358,7 +358,7 @@ describe 'asar package', -> buffer = new Buffer(6) fs.read fd, buffer, 0, 6, 0, (err) -> assert.equal err, null - assert.equal String(buffer), 'file1\n' + assert.equal String(buffer).trim(), 'file1' fs.close fd, done it 'throws ENOENT error when can not find file', (done) -> @@ -390,15 +390,15 @@ describe 'asar package', -> it 'read a normal file', -> file1 = path.join fixtures, 'asar', 'a.asar', 'file1' - assert.equal internalModuleReadFile(file1).toString(), 'file1\n' + assert.equal internalModuleReadFile(file1).toString().trim(), 'file1' file2 = path.join fixtures, 'asar', 'a.asar', 'file2' - assert.equal internalModuleReadFile(file2).toString(), 'file2\n' + assert.equal internalModuleReadFile(file2).toString().trim(), 'file2' file3 = path.join fixtures, 'asar', 'a.asar', 'file3' - assert.equal internalModuleReadFile(file3).toString(), 'file3\n' + assert.equal internalModuleReadFile(file3).toString().trim(), 'file3' it 'reads a normal file with unpacked files', -> p = path.join fixtures, 'asar', 'unpack.asar', 'a.txt' - assert.equal internalModuleReadFile(p).toString(), 'a\n' + assert.equal internalModuleReadFile(p).toString().trim(), 'a' describe 'asar protocol', -> url = require 'url' @@ -409,25 +409,25 @@ describe 'asar package', -> it 'can request a file in package', (done) -> p = path.resolve fixtures, 'asar', 'a.asar', 'file1' $.get "file://#{p}", (data) -> - assert.equal data, 'file1\n' + assert.equal data.trim(), 'file1' done() it 'can request a file in package with unpacked files', (done) -> p = path.resolve fixtures, 'asar', 'unpack.asar', 'a.txt' $.get "file://#{p}", (data) -> - assert.equal data, 'a\n' + assert.equal data.trim(), 'a' done() it 'can request a linked file in package', (done) -> p = path.resolve fixtures, 'asar', 'a.asar', 'link2', 'link1' $.get "file://#{p}", (data) -> - assert.equal data, 'file1\n' + assert.equal data.trim(), 'file1' done() it 'can request a file in filesystem', (done) -> p = path.resolve fixtures, 'asar', 'file' $.get "file://#{p}", (data) -> - assert.equal data, 'file\n' + assert.equal data.trim(), 'file' done() it 'gets 404 when file is not found', (done) -> @@ -484,7 +484,7 @@ describe 'asar package', -> it 'recognize asar archvies', -> p = path.join fixtures, 'asar', 'a.asar', 'link1' - assert.equal gfs.readFileSync(p).toString(), 'file1\n' + assert.equal gfs.readFileSync(p).toString().trim(), 'file1' it 'does not touch global fs object', -> assert.notEqual fs.readdir, gfs.readdir From 850edd546c7f2dbf3d2299882f53a1ceee209c77 Mon Sep 17 00:00:00 2001 From: Eran Tiktin Date: Sat, 8 Aug 2015 21:57:29 +0300 Subject: [PATCH 0814/1293] Added support for reading .ico from asar If the file path is to an asar archive, we extract the file to temp, so LoadImage can load it --- atom/common/api/atom_api_native_image.cc | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/atom/common/api/atom_api_native_image.cc b/atom/common/api/atom_api_native_image.cc index 1594dcb8f8f7..1ad9ed0e367c 100644 --- a/atom/common/api/atom_api_native_image.cc +++ b/atom/common/api/atom_api_native_image.cc @@ -23,6 +23,7 @@ #include "ui/gfx/image/image_skia.h" #include "ui/gfx/image/image_util.h" #if defined(OS_WIN) +#include "atom/common/asar/archive.h" #include "ui/gfx/icon_util.h" #endif @@ -214,10 +215,22 @@ mate::Handle NativeImage::CreateFromJPEG( // static mate::Handle NativeImage::CreateFromPath( - v8::Isolate* isolate, const base::FilePath& path) { + v8::Isolate* isolate, const base::FilePath& file_path) { gfx::ImageSkia image_skia; + base::FilePath path(file_path); if (path.MatchesExtension(FILE_PATH_LITERAL(".ico"))) { #if defined(OS_WIN) + // If file is in asar archive, we extract it to a temp file so LoadImage can + // load it + base::FilePath asar_path, relative_path; + if (asar::GetAsarArchivePath(path, &asar_path, &relative_path)) { + std::shared_ptr archive = + asar::GetOrCreateAsarArchive(asar_path); + if (archive) { + archive->CopyFileOut(relative_path, &path); + } + } + HICON icon = static_cast(LoadImage(NULL, path.value().c_str(), IMAGE_ICON, From de441916d6e0e180a54f598ce0be3f8d7b5173e1 Mon Sep 17 00:00:00 2001 From: Eran Tiktin Date: Sat, 8 Aug 2015 23:25:27 +0300 Subject: [PATCH 0815/1293] Add a comment to build instructions about cpplint I added a mention of `cpplint.py` in the build instructions. The reason, is because it's easy to miss it's existence. Even if you noticed it's mentioned in `coding-style.md` you might mistakenly think that `test.py` runs it). --- docs/development/build-instructions-linux.md | 12 ++++++++++-- docs/development/build-instructions-mac.md | 8 ++++++++ docs/development/build-instructions-windows.md | 8 ++++++++ 3 files changed, 26 insertions(+), 2 deletions(-) diff --git a/docs/development/build-instructions-linux.md b/docs/development/build-instructions-linux.md index 3fe3b53c210f..6f4ce4e1468a 100644 --- a/docs/development/build-instructions-linux.md +++ b/docs/development/build-instructions-linux.md @@ -106,8 +106,8 @@ Make sure you have installed all the build dependencies. ### error while loading shared libraries: libtinfo.so.5 -Prebulit `clang` will try to link to `libtinfo.so.5`. Depending on the host architecture, -symlink to appropirate `libncurses` +Prebulit `clang` will try to link to `libtinfo.so.5`. Depending on the host +architecture, symlink to appropriate `libncurses` ```bash $ sudo ln -s /usr/lib/libncurses.so.5 /usr/lib/libtinfo.so.5 @@ -115,6 +115,14 @@ $ sudo ln -s /usr/lib/libncurses.so.5 /usr/lib/libtinfo.so.5 ## Tests +Test your changes confirm to the project coding style using: + +```bash +$ ./script/cpplint.py +``` + +Test functionality using: + ```bash $ ./script/test.py ``` diff --git a/docs/development/build-instructions-mac.md b/docs/development/build-instructions-mac.md index b0980a231250..af59f996f4a5 100644 --- a/docs/development/build-instructions-mac.md +++ b/docs/development/build-instructions-mac.md @@ -51,6 +51,14 @@ support 32bit OS X in future. ## Tests +Test your changes confirm to the project coding style using: + +```bash +$ ./script/cpplint.py +``` + +Test functionality using: + ```bash $ ./script/test.py ``` diff --git a/docs/development/build-instructions-windows.md b/docs/development/build-instructions-windows.md index 7f32b4645eb8..061011b5a1a4 100644 --- a/docs/development/build-instructions-windows.md +++ b/docs/development/build-instructions-windows.md @@ -67,6 +67,14 @@ The other building steps are exactly the same. ## Tests +Test your changes confirm to the project coding style using: + +```powershell +python script\cpplint.py +``` + +Test functionality using: + ```powershell python script\test.py ``` From 40c7e6e1797d972218320cc4d2d16e65da522400 Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Mon, 10 Aug 2015 03:33:32 +0900 Subject: [PATCH 0816/1293] Update as upstream, translate 2 files, fix some typos --- docs/api/auto-updater-ko.md | 70 +++++++------------ docs/api/content-tracing-ko.md | 69 ++++++++++-------- docs/api/remote-ko.md | 2 +- docs/api/web-frame-ko.md | 12 +++- docs/api/web-view-tag-ko.md | 17 ++++- .../build-instructions-linux-ko.md | 2 +- docs/tutorial/application-packaging-ko.md | 3 +- .../desktop-environment-integration-ko.md | 51 +++++++++++++- 8 files changed, 143 insertions(+), 83 deletions(-) diff --git a/docs/api/auto-updater-ko.md b/docs/api/auto-updater-ko.md index ca23a4ad114b..dd9adf86709a 100644 --- a/docs/api/auto-updater-ko.md +++ b/docs/api/auto-updater-ko.md @@ -12,7 +12,7 @@ Squirrel.Mac은 업데이트 설치를 위해 `.app` 폴더에 ## Squirrel -Squirrel은 어플리케이션이 **안전하고 투명한 웹사이트 업데이트**를 할 수 있도록 하는데 초점이 맞춰진 OS X 프레임워크입니다. +Squirrel은 어플리케이션이 **안전하고 투명한 업데이트**를 제공할 수 있도록 하는데 초점이 맞춰진 OS X 프레임워크입니다. Squirrel은 사용자에게 어플리케이션의 업데이트를 알릴 필요 없이 서버가 지시하는 버전을 받아온 후 자동으로 업데이트합니다. 이 기능을 사용하면 Squirrel을 통해 클라이언트의 어플리케이션을 지능적으로 업데이트 할 수 있습니다. @@ -27,22 +27,15 @@ Squirrel의 인스톨러는 오류에 관대하게 설계되었습니다. 그리 ## 업데이트 요청 -Squirrel is indifferent to the request the client application provides for -update checking. `Accept: application/json` is added to the request headers -because Squirrel is responsible for parsing the response. +Squirrel은 업데이트 확인을 위해 클라이언트 어플리케이션의 요청은 무시합니다. +Squirrel은 응답을 분석해야 할 책임이 있기 때문에 `Accept: application/json`이 요청 헤더에 추가됩니다. -For the requirements imposed on the responses and the body format of an update -response see [Server Support](#server-support). +업데이트 응답과 본문 포맷에 대한 요구 사항은 [Server Support](#server-support)를 참고하세요. -Your update request must *at least* include a version identifier so that the -server can determine whether an update for this specific version is required. It -may also include other identifying criteria such as operating system version or -username, to allow the server to deliver as fine grained an update as you -would like. +업데이트 요청에는 서버가 해당 어플리케이션이 어떤 버전을 사용해야 하는지 판단하기 위해 *반드시* 버전 식별자를 포함시켜야 합니다. +추가로 OS 버전, 사용자 이름 같은 다른 식별 기준을 포함하여 서버에서 적합한 어플리케이션을 제공할 수 있도록 할 수 있습니다. -How you include the version identifier or other criteria is specific to the -server that you are requesting updates from. A common approach is to use query -parameters, like this: +버전 식별자와 다른 기준을 특정하는 업데이트 요청 폼을 서버로 전달하기 위한 공통적인 방법으로 쿼리 인자를 사용하는 방법이 있습니다: ```javascript // On the main process @@ -53,24 +46,19 @@ autoUpdater.setFeedUrl('http://mycompany.com/myapp/latest?version=' + app.getVer ## 서버 지원 -Your server should determine whether an update is required based on the -[Update Request](#update-requests) your client issues. +업데이트를 제공하는 서버는 반드시 클라이언트로부터 받은 [Update Request](#update-requests)를 기반으로 업데이트를 처리할 수 있어야 합니다. -If an update is required your server should respond with a status code of -[200 OK](http://tools.ietf.org/html/rfc2616#section-10.2.1) and include the -[update JSON](#update-json-format) in the body. Squirrel **will** download and -install this update, even if the version of the update is the same as the -currently running version. To save redundantly downloading the same version -multiple times your server must not inform the client to update. +만약 업데이트 요청이 들어오면 서버는 반드시 [200 OK](http://tools.ietf.org/html/rfc2616#section-10.2.1) 상태 코드를 포함한 +[업데이트 JSON](#update-json-format)을 본문으로 보내야 합니다. +이 응답을 받으면 Squirrel은 이 업데이트를 다운로드할 것입니다. 참고로 현재 설치된 버전과 서버에서 받아온 새로운 버전이 같아도 상관하지 않고 무조건 받습니다. +업데이트시 버전 중복을 피하려면 서버에서 클라이언트 업데이트 요청에 대해 통보하지 않으면 됩니다. -If no update is required your server must respond with a status code of -[204 No Content](http://tools.ietf.org/html/rfc2616#section-10.2.5). Squirrel -will check for an update again at the interval you specify. +만약 따로 업데이트가 없다면 [204 No Content](http://tools.ietf.org/html/rfc2616#section-10.2.5) 상태 코드를 반환해야 합니다. +Squirrel은 지정한 시간이 지난 후 다시 업데이트를 확인합니다. ## JSON 포맷 업데이트 -When an update is available, Squirrel expects the following schema in response -to the update request provided: +업데이트가 사용 가능한 경우 Squirrel은 다음과 같은 구조의 json 데이터를 응답으로 받습니다: ```json { @@ -81,34 +69,31 @@ to the update request provided: } ``` -The only required key is "url", the others are optional. +응답 json 데이터에서 "url" 키는 필수적으로 포함해야 하고 다른 키들은 옵션입니다. -Squirrel will request "url" with `Accept: application/zip` and only supports -installing ZIP updates. If future update formats are supported their MIME type -will be added to the `Accept` header so that your server can return the -appropriate format. +Squirrel은 "url"로 `Accept: application/zip` 헤더와 함께 업데이트 zip 파일을 요청합니다. +향후 업데이트 포맷에 대해 서버에서 적절한 포맷을 반환할 수 있도록 MIME 타입을 `Accept` 헤더에 담아 요청합니다. -`pub_date` if present must be formatted according to ISO 8601. +`pub_date`은 ISO 8601 표준에 따라 포맷된 날짜입니다. ## Event: error * `event` Event * `message` String -Emitted when there is an error updating. +업데이트시 에러가 나면 발생하는 이벤트입니다. ## Event: checking-for-update -Emitted when checking for update has started. +업데이트를 확인하기 시작할 때 발생하는 이벤트입니다. ## Event: update-available -Emitted when there is an available update, the update would be downloaded -automatically. +사용 가능한 업데이트가 있을 때 발생하는 이벤트입니다. 이벤트는 자동으로 다운로드 됩니다. ## Event: update-not-available -Emitted when there is no available update. +사용 가능한 업데이트가 없을 때 발생하는 이벤트입니다. ## Event: update-downloaded @@ -119,17 +104,14 @@ Emitted when there is no available update. * `updateUrl` String * `quitAndUpdate` Function -Emitted when update has been downloaded, calling `quitAndUpdate()` would restart -the application and install the update. +업데이트의 다운로드가 완료되었을 때 발생하는 이벤트입니다. `quitAndUpdate()`를 호출하면 어플리케이션을 종료하고 업데이트를 설치합니다. ## autoUpdater.setFeedUrl(url) * `url` String -Set the `url` and initialize the auto updater. The `url` could not be changed -once it is set. +`url`을 설정하고 자동 업데이터를 초기화합니다. `url`은 한번 설정되면 변경할 수 없습니다. ## autoUpdater.checkForUpdates() -Ask the server whether there is an update, you have to call `setFeedUrl` before -using this API. +서버에 새로운 업데이트가 있는지 요청을 보내 확인합니다. API를 사용하기 전에 `setFeedUrl`를 호출해야 합니다. diff --git a/docs/api/content-tracing-ko.md b/docs/api/content-tracing-ko.md index 9758d9236aa8..72fd289669af 100644 --- a/docs/api/content-tracing-ko.md +++ b/docs/api/content-tracing-ko.md @@ -22,60 +22,68 @@ tracing.startRecording('*', tracing.DEFAULT_OPTIONS, function() { 카테고리 그룹 세트를 가져옵니다. 카테고리 그룹은 도달된 코드 경로를 변경할 수 있습니다. -Once all child processes have acked to the `getCategories` request, `callback` -is invoked with an array of category groups. +모든 child 프로세스가 `getCategories` 요청을 받으면 `callback`이 호출되며 인자에 카테고리 그룹의 배열이 전달됩니다. -## tracing.startRecording(categoryFilter, options, callback) +## tracing.startRecording(categoryFilter, traceOptions, callback) * `categoryFilter` String -* `options` Integer +* `traceOptions` String * `callback` Function -Start recording on all processes. +모든 프로세스에서 레코딩을 시작합니다. -Recording begins immediately locally, and asynchronously on child processes -as soon as they receive the EnableRecording request. Once all child processes -have acked to the `startRecording` request, `callback` will be called back. +레코딩은 지역적으로 즉시 실행됩니다. 그리고 비동기로 child 프로세스는 곧 EnableRecording 요청을 받게 됩니다. +모든 child 프로세스가 `startRecording` 요청을 받으면 `callback`이 호출됩니다. -`categoryFilter` is a filter to control what category groups should be -traced. A filter can have an optional `-` prefix to exclude category groups -that contain a matching category. Having both included and excluded -category patterns in the same list is not supported. +`categoryFilter`는 어떤 카테고리 그룹이 트레이싱 되어야 하는지 필터링할 수 있습니다. +필터는 `-` 접두사를 통해 특정 카테고리 그룹을 제외할 수 있습니다. +카테고리 패턴은 같은 리스트 내에서 포함과 제외를 함께 사용할 수 없습니다. -Examples: +예제: * `test_MyTest*`, * `test_MyTest*,test_OtherStuff`, * `"-excluded_category1,-excluded_category2` -`options` controls what kind of tracing is enabled, it could be a OR-ed -combination of `tracing.DEFAULT_OPTIONS`, `tracing.ENABLE_SYSTRACE`, -`tracing.ENABLE_SAMPLING` and `tracing.RECORD_CONTINUOUSLY`. +`traceOptions`은 어떤 종류의 트레이싱을 사용할 수 있는지 지정하고 콤마로 리스트를 구분합니다. + +사용할 수 있는 옵션은 다음과 같습니다: + +* `record-until-full` +* `record-continuously` +* `trace-to-console` +* `enable-sampling` +* `enable-systrace` + +첫번째부터 3번째까지의 옵션은 추적 레코딩 모드입니다. 이에 따라 상호 배타적입니다. +만약 레코딩 모드가 한 개 이상 지정되면 마지막 지정한 모드만 사용됩니다. +어떤 모드도 설정되지 않았다면 `record-until-full` 모드가 기본으로 사용됩니다. + +추적 옵션은 `traceOptions`이 파싱되어 적용되기 전까지 다음과 같은 기본값이 사용됩니다. + +`record-until-full`이 기본 모드, `enable-sampling`과 `enable-systrace`옵션은 포함되지 않음 ## tracing.stopRecording(resultFilePath, callback) * `resultFilePath` String * `callback` Function -Stop recording on all processes. +모든 프로세스에서 레코딩을 중지합니다. -Child processes typically are caching trace data and only rarely flush and send -trace data back to the main process. That is because it may be an expensive -operation to send the trace data over IPC, and we would like to avoid much -runtime overhead of tracing. So, to end tracing, we must asynchronously ask all -child processes to flush any pending trace data. +Child 프로세스는 일반적으로 추적 데이터와 희귀한 플러시 그리고 추적 데이터를 메인 프로세스로 보내는 작업에 대해 캐싱 합니다. +이러한 일을 하는 이유는 IPC를 통해 추적 데이터를 보내는 작업은 매우 비싼 연산을 동반하기 때문입니다. +우리는 추적에 의한 런타임 오버헤드를 피하는 것을 지향합니다. +그래서 트레이싱이 끝나면 모든 child 프로세스에 보류된 추적 데이터를 플러시 할 것인지 물어봅니다. -Once all child processes have acked to the `stopRecording` request, `callback` -will be called back with a file that contains the traced data. +모든 child 프로세스가 `stopRecording` 요청을 받으면 `callback`에 추적 데이터를 포함한 파일을 전달됩니다. -Trace data will be written into `resultFilePath` if it is not empty, or into a -temporary file. The actual file path will be passed to `callback` if it's not -null. +추적 데이터는 `resultFilePath` 해당 경로가 비어있는 경우에 한 해 해당 경로에 작성되거나 임시 파일에 작성됩니다. +실제 파일 경로는 null이 아닌 이상 `callback`을 통해 전달됩니다. -## tracing.startMonitoring(categoryFilter, options, callback) +## tracing.startMonitoring(categoryFilter, traceOptions, callback) * `categoryFilter` String -* `options` Integer +* `traceOptions` String * `callback` Function Start monitoring on all processes. @@ -104,14 +112,13 @@ Get the current monitoring traced data. Child processes typically are caching trace data and only rarely flush and send trace data back to the main process. That is because it may be an expensive -operation to send the trace data over IPC, and we would like to avoid unneeded +operation to send the trace data over IPC, and we would like to avoid unneeded runtime overhead of tracing. So, to end tracing, we must asynchronously ask all child processes to flush any pending trace data. Once all child processes have acked to the `captureMonitoringSnapshot` request, the `callback` will be invoked with a file that contains the traced data. - ## tracing.getTraceBufferUsage(callback) * `callback` Function diff --git a/docs/api/remote-ko.md b/docs/api/remote-ko.md index a4e1d46ed2ef..a28ce31d1a10 100644 --- a/docs/api/remote-ko.md +++ b/docs/api/remote-ko.md @@ -1,6 +1,6 @@ # remote -`remote` 모듈은 메인 프로세스와 랜더러 프로세스 사이에 inter-process 통신을 하기 위한 가장 간단한 방법입니다. +`remote` 모듈은 메인 프로세스와 랜더러 프로세스 사이에 inter-process 통신을 간단하게 추상화한 모듈입니다. In Electron, only GUI-unrelated modules are available in the renderer process. Without the `remote` module, users who wanted to call a main process API in diff --git a/docs/api/web-frame-ko.md b/docs/api/web-frame-ko.md index 2219de1065ce..4edbd4d6ec64 100644 --- a/docs/api/web-frame-ko.md +++ b/docs/api/web-frame-ko.md @@ -1,6 +1,6 @@ # web-frame -`web-frame` 모듈은 현재 웹 페이지의 랜더링 상태를 커스터마이즈 할 수 있도록 해줍니다. +`web-frame` 모듈은 현재 웹 페이지의 랜더링 상태를 설정 할 수 있도록 해줍니다. 다음 예제는 현재 페이지를 200% 줌 합니다. @@ -54,8 +54,14 @@ require('web-frame').setSpellCheckProvider("en-US", true, { * `scheme` String -지정한 `scheme`을 보안 스킴으로 설정합니다. +지정한 `scheme`을 보안 스킴으로 등록합니다. -보안 스킴은 혼합된 컨텐츠 경고를 발생시키지 않습니다. 예를 들어 `https` 와 `data`는 네트워크 공격자로부터 손상될 가능성이 없기 때문에 보안 스킴입니다. +보안 스킴은 혼합된 컨텐츠 경고를 발생시키지 않습니다. 예를 들어 `https` 와 `data`는 네트워크 공격자로부터 손상될 가능성이 없기 때문에 보안 스킴이라고 할 수 있습니다. + +## webFrame.registerUrlSchemeAsBypassingCsp(scheme) + +* `scheme` String + +페이지 컨텐츠의 보안 정책에 상관없이 이 `scheme`로부터 리소스가 로드됩니다. [spellchecker]: https://github.com/atom/node-spellchecker diff --git a/docs/api/web-view-tag-ko.md b/docs/api/web-view-tag-ko.md index abef526d7876..1feb3ec1555f 100644 --- a/docs/api/web-view-tag-ko.md +++ b/docs/api/web-view-tag-ko.md @@ -213,12 +213,18 @@ webview.addEventListener("dom-ready", function() { 게스트 페이지에 CSS를 삽입합니다. -### ``.executeJavaScript(code) +### ``.executeJavaScript(code[, userGesture]) * `code` String +* `userGesture` Boolean 게스트 페이지에서 자바스크립트 `code`를 실행합니다. +`userGesture`가 `true`로 설정되어 있으면 `requestFullScreen` HTML API 같이 +유저의 승인이 필요한 API를 유저의 승인을 무시하고 개발자가 API를 직접 사용할 수 있습니다. + +역주: 기본적으로 브라우저에선 전체화면, 웹캠, 파일 열기등의 API를 사용하려면 유저의 승인(이벤트)이 필요합니다. + ### ``.openDevTools() 게스트 페이지에 대한 개발자 툴을 엽니다. @@ -301,6 +307,15 @@ Service worker에 대한 개발자 툴을 엽니다. ## DOM 이벤트 +### load-commit + +* `url` String +* `isMainFrame` Boolean + +Fired when a load has committed. This includes navigation within the current +document as well as subframe document-level loads, but does not include +asynchronous resource loads. + ### did-finish-load 탐색이 끝나면 발생하는 이벤트입니다. 브라우저 탭의 스피너가 멈추고 `onload` 이벤트가 발생될 때를 생각하면 됩니다. diff --git a/docs/development/build-instructions-linux-ko.md b/docs/development/build-instructions-linux-ko.md index c946e9adeaad..520ebc302503 100644 --- a/docs/development/build-instructions-linux-ko.md +++ b/docs/development/build-instructions-linux-ko.md @@ -15,7 +15,7 @@ Ubuntu를 사용하고 있다면 다음 커맨드로 설치하면 합니다: $ sudo apt-get install build-essential clang libdbus-1-dev libgtk2.0-dev \ libnotify-dev libgnome-keyring-dev libgconf2-dev \ libasound2-dev libcap-dev libcups2-dev libxtst-dev \ - libxss1 gcc-multilib g++-multilib + libxss1 libnss3-dev gcc-multilib g++-multilib ``` 다른 배포판의 경우 yum과 같은 패키지 매니저를 통해 패키지를 설치 할 수 있습니다. 패키지의 이름은 대부분 비슷할 것입니다. diff --git a/docs/tutorial/application-packaging-ko.md b/docs/tutorial/application-packaging-ko.md index 4d00eb8c814a..1df14da291aa 100644 --- a/docs/tutorial/application-packaging-ko.md +++ b/docs/tutorial/application-packaging-ko.md @@ -1,6 +1,7 @@ # 어플리케이션 패키징 -어플리케이션의 리소스와 소스코드를 유저로부터 보호하기 위해 약간의 구조 변경으로 어플리케이션을 [asar][asar] 아카이브로 패키징 할 수 있습니다. +Windows에서 일어나는 긴 경로 이름에 대한 [issues](https://github.com/joyent/node/issues/6960)를 완화하고 `require` 속도를 약간 빠르게 하며 +어플리케이션의 리소스와 소스코드를 유저로부터 보호하기 위해 어플리케이션을 [asar][asar] 아카이브로 패키징 할 수 있습니다. ## `asar` 아카이브 생성 diff --git a/docs/tutorial/desktop-environment-integration-ko.md b/docs/tutorial/desktop-environment-integration-ko.md index cd87c2dfec6d..cb6d66a56477 100644 --- a/docs/tutorial/desktop-environment-integration-ko.md +++ b/docs/tutorial/desktop-environment-integration-ko.md @@ -113,7 +113,56 @@ app.setUserTasks([ app.setUserTasks([]); ``` -사용자 작업 리스트는 어플리케이션이 종료되어도 태스크바에 여전히 보존됩니다. 그러므로 어플리케이션이 삭제되기 전까지 이 기능이 제대로 작동하도록 하기 위해 반드시 프로그램 경로와 아이콘 경로를 지정해야 합니다. + +사용자 작업 리스트는 어플리케이션이 삭제되지 않는 한 종료되어도 태스크바에 보존됩니다. 이러한 이유로 반드시 프로그램 경로와 아이콘 경로를 지정해야 합니다. + +## 섬네일 툴바 + +Windows에선 작업 표시줄의 어플리케이션 선택시 나오는 미리보기에 특정한 섬네일 툴바를 추가할 수 있습니다. +이 기능은 유저가 윈도우를 활성화 하지 않고 특정한 커맨드를 실행시킬 수 있도록 할 수 있습니다. + +MSDN의 설명에 의하면: + +> 이 툴바는 표준 툴바의 공통 컨트롤과 비슷한 역할을 합니다. 버튼은 최대 7개 까지 만들 수 있습니다. +> 각 버튼의 구조엔 ID, 이미지, 툴팁, 상태등이 정의되어있습니다. 태스크바에 구조가 전달되면 어플리케이션이 +> 상태에 따라 버튼을 숨기거나, 활성화하거나, 비활성화 할 수 있습니다. +> +> 예를 들어, 윈도우 미디어 플레이어는(WMP) 기본적으로 +> 미디어 플레이어가 공통적으로 사용하는 재생, 일시정지, 음소거, 정지등의 컨트롤을 포함하고 있습니다. + +__Windows Media Player의 섬네일 툴바:__ + +![player](https://i-msdn.sec.s-msft.com/dynimg/IC420540.png) + +[BrowserWindow.setThumbarButtons][setthumbarbuttons] API를 통해 어플리케이션에 섬네일 툴바를 설정할 수 있습니다: + +```javascript +var BrowserWindow = require('browser-window'); +var path = require('path'); +var win = new BrowserWindow({ + width: 800, + height: 600 +}); +win.setThumbarButtons([ + { + tooltip: "button1", + icon: path.join(__dirname, 'button1.png'), + click: function() { console.log("button2 clicked"); } + }, + { + tooltip: "button2", + icon: path.join(__dirname, 'button2.png'), + flags:['enabled', 'dismissonclick'], + click: function() { console.log("button2 clicked."); } + } +]); +``` + +섬네일 툴바를 비우려면 간단히 `BrowserWindow.setThumbarButtons` API에 빈 배열을 전달하면 됩니다: + +```javascript +win.setThumbarButtons([]); +``` ## Unity 런처 숏컷 기능 (Linux) From 70be04a2d3fba1fabc478aadf17b4137f34559d4 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 10 Aug 2015 11:28:43 +0800 Subject: [PATCH 0817/1293] Upload headers with new filenames --- script/upload-node-headers.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/script/upload-node-headers.py b/script/upload-node-headers.py index 38cb2f7e16f5..230b08ed5ac7 100755 --- a/script/upload-node-headers.py +++ b/script/upload-node-headers.py @@ -40,11 +40,15 @@ def main(): args = parse_args() node_headers_dir = os.path.join(DIST_DIR, 'node-{0}'.format(args.version)) iojs_headers_dir = os.path.join(DIST_DIR, 'iojs-{0}'.format(args.version)) + iojs2_headers_dir = os.path.join(DIST_DIR, + 'iojs-{0}-headers'.format(args.version)) copy_headers(node_headers_dir) create_header_tarball(node_headers_dir) copy_headers(iojs_headers_dir) create_header_tarball(iojs_headers_dir) + copy_headers(iojs2_headers_dir) + create_header_tarball(iojs2_headers_dir) # Upload node's headers to S3. bucket, access_key, secret_key = s3_config() From 52d07eb30f3572891b7765b0f5d9d607aec70607 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 10 Aug 2015 11:42:14 +0800 Subject: [PATCH 0818/1293] Update checksums for new filenames --- script/upload-checksums.py | 1 + 1 file changed, 1 insertion(+) diff --git a/script/upload-checksums.py b/script/upload-checksums.py index c71425126363..776a5debdb64 100755 --- a/script/upload-checksums.py +++ b/script/upload-checksums.py @@ -40,6 +40,7 @@ def get_files_list(version): return [ 'node-{0}.tar.gz'.format(version), 'iojs-{0}.tar.gz'.format(version), + 'iojs-{0}-headers.tar.gz'.format(version), 'node.lib', 'x64/node.lib', 'win-x86/iojs.lib', From 0a49dcc623833d34e8a65d4c84cbf1df0cb8e858 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 10 Aug 2015 11:56:42 +0800 Subject: [PATCH 0819/1293] Delay the call of element resize callback to next tick --- atom/renderer/guest_view_container.cc | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/atom/renderer/guest_view_container.cc b/atom/renderer/guest_view_container.cc index 638df2177e48..7643f72b0e5b 100644 --- a/atom/renderer/guest_view_container.cc +++ b/atom/renderer/guest_view_container.cc @@ -7,6 +7,7 @@ #include #include "base/lazy_instance.h" +#include "ui/gfx/geometry/size.h" namespace atom { @@ -51,7 +52,9 @@ void GuestViewContainer::DidResizeElement(const gfx::Size& old_size, if (element_resize_callback_.is_null()) return; - element_resize_callback_.Run(old_size, new_size); + base::MessageLoop::current()->PostTask( + FROM_HERE, + base::Bind(element_resize_callback_, old_size, new_size)); } } // namespace atom From a3f3a35fd17349ce2d0e3c3b213e6d8f10855c99 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 10 Aug 2015 12:18:00 +0800 Subject: [PATCH 0820/1293] mac: Don't emit "clicked" event if there is menu attached --- atom/browser/ui/tray_icon_cocoa.mm | 21 ++++++++++++--------- 1 file changed, 12 insertions(+), 9 deletions(-) diff --git a/atom/browser/ui/tray_icon_cocoa.mm b/atom/browser/ui/tray_icon_cocoa.mm index 055ac12c4046..3ac865cce5ab 100644 --- a/atom/browser/ui/tray_icon_cocoa.mm +++ b/atom/browser/ui/tray_icon_cocoa.mm @@ -207,23 +207,26 @@ const CGFloat kVerticalTitleMargin = 2; } inMouseEventSequence_ = NO; - // Single click - if (event.clickCount == 1) { - if (menuController_) { - [statusItem_ popUpStatusItemMenu:[menuController_ menu]]; - } + // Show menu when single clicked on the icon. + if (event.clickCount == 1 && menuController_) + [statusItem_ popUpStatusItemMenu:[menuController_ menu]]; + // Don't emit click events when menu is showing. + if (menuController_) + return; + + // Single click event. + if (event.clickCount == 1) trayIcon_->NotifyClicked( [self getBoundsFromEvent:event], ui::EventFlagsFromModifiers([event modifierFlags])); - } - // Double click - if (event.clickCount == 2 && !menuController_) { + // Double click event. + if (event.clickCount == 2) trayIcon_->NotifyDoubleClicked( [self getBoundsFromEvent:event], ui::EventFlagsFromModifiers([event modifierFlags])); - } + [self setNeedsDisplay:YES]; } From 4b9ff309ece31507862a5279d545a8cb1b2b43b2 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 10 Aug 2015 12:39:05 +0800 Subject: [PATCH 0821/1293] Add our own MenuModel class --- atom/browser/api/atom_api_menu.cc | 2 +- atom/browser/api/atom_api_menu.h | 14 +++--- atom/browser/ui/atom_menu_model.cc | 22 +++++++++ atom/browser/ui/atom_menu_model.h | 47 +++++++++++++++++++ atom/browser/ui/cocoa/atom_menu_controller.mm | 5 +- filenames.gypi | 2 + 6 files changed, 81 insertions(+), 11 deletions(-) create mode 100644 atom/browser/ui/atom_menu_model.cc create mode 100644 atom/browser/ui/atom_menu_model.h diff --git a/atom/browser/api/atom_api_menu.cc b/atom/browser/api/atom_api_menu.cc index 915e152b3a68..356a4d4ce494 100644 --- a/atom/browser/api/atom_api_menu.cc +++ b/atom/browser/api/atom_api_menu.cc @@ -20,7 +20,7 @@ namespace atom { namespace api { Menu::Menu() - : model_(new ui::SimpleMenuModel(this)), + : model_(new AtomMenuModel(this)), parent_(NULL) { } diff --git a/atom/browser/api/atom_api_menu.h b/atom/browser/api/atom_api_menu.h index 0c2743878f78..33aafbc45d3b 100644 --- a/atom/browser/api/atom_api_menu.h +++ b/atom/browser/api/atom_api_menu.h @@ -8,9 +8,9 @@ #include #include "atom/browser/api/atom_api_window.h" +#include "atom/browser/ui/atom_menu_model.h" #include "base/callback.h" #include "base/memory/scoped_ptr.h" -#include "ui/base/models/simple_menu_model.h" #include "native_mate/wrappable.h" namespace atom { @@ -18,7 +18,7 @@ namespace atom { namespace api { class Menu : public mate::Wrappable, - public ui::SimpleMenuModel::Delegate { + public AtomMenuModel::Delegate { public: static mate::Wrappable* Create(); @@ -33,7 +33,7 @@ class Menu : public mate::Wrappable, static void SendActionToFirstResponder(const std::string& action); #endif - ui::SimpleMenuModel* model() const { return model_.get(); } + AtomMenuModel* model() const { return model_.get(); } protected: Menu(); @@ -42,7 +42,7 @@ class Menu : public mate::Wrappable, // mate::Wrappable: void AfterInit(v8::Isolate* isolate) override; - // ui::SimpleMenuModel::Delegate implementations: + // ui::SimpleMenuModel::Delegate: bool IsCommandIdChecked(int command_id) const override; bool IsCommandIdEnabled(int command_id) const override; bool IsCommandIdVisible(int command_id) const override; @@ -54,7 +54,7 @@ class Menu : public mate::Wrappable, virtual void Popup(Window* window) = 0; virtual void PopupAt(Window* window, int x, int y) = 0; - scoped_ptr model_; + scoped_ptr model_; Menu* parent_; private: @@ -102,9 +102,9 @@ class Menu : public mate::Wrappable, namespace mate { template<> -struct Converter { +struct Converter { static bool FromV8(v8::Isolate* isolate, v8::Local val, - ui::SimpleMenuModel** out) { + atom::AtomMenuModel** out) { // null would be tranfered to NULL. if (val->IsNull()) { *out = nullptr; diff --git a/atom/browser/ui/atom_menu_model.cc b/atom/browser/ui/atom_menu_model.cc new file mode 100644 index 000000000000..7d2d5e1b6a1f --- /dev/null +++ b/atom/browser/ui/atom_menu_model.cc @@ -0,0 +1,22 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#include "atom/browser/ui/atom_menu_model.h" + +namespace atom { + +AtomMenuModel::AtomMenuModel(Delegate* delegate) + : ui::SimpleMenuModel(delegate), + delegate_(delegate) { +} + +AtomMenuModel::~AtomMenuModel() { +} + +void AtomMenuModel::MenuClosed() { + ui::SimpleMenuModel::MenuClosed(); + FOR_EACH_OBSERVER(Observer, observers_, MenuClosed()); +} + +} // namespace atom diff --git a/atom/browser/ui/atom_menu_model.h b/atom/browser/ui/atom_menu_model.h new file mode 100644 index 000000000000..42e0e5dbc53a --- /dev/null +++ b/atom/browser/ui/atom_menu_model.h @@ -0,0 +1,47 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#ifndef ATOM_BROWSER_UI_ATOM_MENU_MODEL_H_ +#define ATOM_BROWSER_UI_ATOM_MENU_MODEL_H_ + +#include "base/observer_list.h" +#include "ui/base/models/simple_menu_model.h" + +namespace atom { + +class AtomMenuModel : public ui::SimpleMenuModel { + public: + class Delegate : public ui::SimpleMenuModel::Delegate { + public: + virtual ~Delegate() {} + }; + + class Observer { + public: + virtual ~Observer() {} + + // Notifies the menu has been closed. + virtual void MenuClosed() {} + }; + + explicit AtomMenuModel(Delegate* delegate); + virtual ~AtomMenuModel(); + + void AddObserver(Observer* obs) { observers_.AddObserver(obs); } + void RemoveObserver(Observer* obs) { observers_.RemoveObserver(obs); } + + // ui::SimpleMenuModel: + void MenuClosed() override; + + private: + Delegate* delegate_; // weak ref. + + ObserverList observers_; + + DISALLOW_COPY_AND_ASSIGN(AtomMenuModel); +}; + +} // namespace atom + +#endif // ATOM_BROWSER_UI_ATOM_MENU_MODEL_H_ diff --git a/atom/browser/ui/cocoa/atom_menu_controller.mm b/atom/browser/ui/cocoa/atom_menu_controller.mm index 962dd6b0ad36..d799a9f9b64d 100644 --- a/atom/browser/ui/cocoa/atom_menu_controller.mm +++ b/atom/browser/ui/cocoa/atom_menu_controller.mm @@ -5,12 +5,12 @@ #import "atom/browser/ui/cocoa/atom_menu_controller.h" +#include "atom/browser/ui/atom_menu_model.h" #include "base/logging.h" #include "base/strings/sys_string_conversions.h" #include "ui/base/accelerators/accelerator.h" #include "ui/base/accelerators/platform_accelerator_cocoa.h" #include "ui/base/l10n/l10n_util_mac.h" -#include "ui/base/models/simple_menu_model.h" #include "ui/events/cocoa/cocoa_event_utils.h" #include "ui/gfx/image/image.h" @@ -120,8 +120,7 @@ [item setTarget:nil]; [item setAction:nil]; ui::MenuModel* submenuModel = model->GetSubmenuModelAt(index); - NSMenu* submenu = - [self menuFromModel:(ui::SimpleMenuModel*)submenuModel]; + NSMenu* submenu = [self menuFromModel:submenuModel]; [submenu setTitle:[item title]]; [item setSubmenu:submenu]; diff --git a/filenames.gypi b/filenames.gypi index b062c6e932b9..40af1ebb1fe7 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -166,6 +166,8 @@ 'atom/browser/ui/accelerator_util.h', 'atom/browser/ui/accelerator_util_mac.mm', 'atom/browser/ui/accelerator_util_views.cc', + 'atom/browser/ui/atom_menu_model.cc', + 'atom/browser/ui/atom_menu_model.h', 'atom/browser/ui/cocoa/atom_menu_controller.h', 'atom/browser/ui/cocoa/atom_menu_controller.mm', 'atom/browser/ui/cocoa/event_processing_window.h', From 58dee04d5c2317cd9c597b3e0b4b2a885512ef36 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 10 Aug 2015 12:48:22 +0800 Subject: [PATCH 0822/1293] mac: Redraw icon when menu is closed --- atom/browser/ui/tray_icon_cocoa.h | 11 ++++++++++- atom/browser/ui/tray_icon_cocoa.mm | 14 +++++++++++++- 2 files changed, 23 insertions(+), 2 deletions(-) diff --git a/atom/browser/ui/tray_icon_cocoa.h b/atom/browser/ui/tray_icon_cocoa.h index 9aa801ec5ead..db53adcbe85d 100644 --- a/atom/browser/ui/tray_icon_cocoa.h +++ b/atom/browser/ui/tray_icon_cocoa.h @@ -9,6 +9,7 @@ #include +#include "atom/browser/ui/atom_menu_model.h" #include "atom/browser/ui/tray_icon.h" #include "base/mac/scoped_nsobject.h" @@ -17,7 +18,8 @@ namespace atom { -class TrayIconCocoa : public TrayIcon { +class TrayIconCocoa : public TrayIcon, + public AtomMenuModel::Observer { public: TrayIconCocoa(); virtual ~TrayIconCocoa(); @@ -30,6 +32,10 @@ class TrayIconCocoa : public TrayIcon { void PopContextMenu(const gfx::Point& pos) override; void SetContextMenu(ui::SimpleMenuModel* menu_model) override; + protected: + // AtomMenuModel::Observer: + void MenuClosed() override; + private: // Atom custom view for NSStatusItem. base::scoped_nsobject status_item_view_; @@ -37,6 +43,9 @@ class TrayIconCocoa : public TrayIcon { // Status menu shown when right-clicking the system icon. base::scoped_nsobject menu_; + // Used for unregistering observer. + AtomMenuModel* menu_model_; // weak ref. + DISALLOW_COPY_AND_ASSIGN(TrayIconCocoa); }; diff --git a/atom/browser/ui/tray_icon_cocoa.mm b/atom/browser/ui/tray_icon_cocoa.mm index 3ac865cce5ab..7c2214e06399 100644 --- a/atom/browser/ui/tray_icon_cocoa.mm +++ b/atom/browser/ui/tray_icon_cocoa.mm @@ -281,11 +281,13 @@ const CGFloat kVerticalTitleMargin = 2; namespace atom { -TrayIconCocoa::TrayIconCocoa() { +TrayIconCocoa::TrayIconCocoa() : menu_model_(nullptr) { } TrayIconCocoa::~TrayIconCocoa() { [status_item_view_ removeItem]; + if (menu_model_) + menu_model_->RemoveObserver(this); } void TrayIconCocoa::SetImage(const gfx::Image& image) { @@ -319,10 +321,20 @@ void TrayIconCocoa::PopContextMenu(const gfx::Point& pos) { } void TrayIconCocoa::SetContextMenu(ui::SimpleMenuModel* menu_model) { + // Substribe to MenuClosed event. + if (menu_model_) + menu_model_->RemoveObserver(this); + static_cast(menu_model)->AddObserver(this); + + // Create native menu. menu_.reset([[AtomMenuController alloc] initWithModel:menu_model]); [status_item_view_ setMenuController:menu_.get()]; } +void TrayIconCocoa::MenuClosed() { + [status_item_view_ setNeedsDisplay:YES]; +} + // static TrayIcon* TrayIcon::Create() { return new TrayIconCocoa; From 225140bd64e07b935d498335732b468b24c56c8c Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 10 Aug 2015 12:52:55 +0800 Subject: [PATCH 0823/1293] win: Don't emit right-clicked event when there is menu attached --- atom/browser/ui/win/notify_icon.cc | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/atom/browser/ui/win/notify_icon.cc b/atom/browser/ui/win/notify_icon.cc index 962dc871b5b6..ebc958384363 100644 --- a/atom/browser/ui/win/notify_icon.cc +++ b/atom/browser/ui/win/notify_icon.cc @@ -86,8 +86,10 @@ void NotifyIcon::HandleClickEvent(const gfx::Point& cursor_pos, NotifyClicked(gfx::Rect(rect), modifiers); return; } else if (!double_button_click) { // single right click - NotifyRightClicked(gfx::Rect(rect), modifiers); - PopContextMenu(cursor_pos); + if (menu_model_) + PopContextMenu(cursor_pos); + else + NotifyRightClicked(gfx::Rect(rect), modifiers); } } From 33eadad139136bce7f8c9fe4f152f8576aa7e69b Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 10 Aug 2015 13:00:15 +0800 Subject: [PATCH 0824/1293] popContextMenu => popUpContextMenu --- atom/browser/api/atom_api_tray.cc | 6 +++--- atom/browser/api/atom_api_tray.h | 2 +- atom/browser/api/lib/tray.coffee | 4 ++++ atom/browser/ui/tray_icon.cc | 2 +- atom/browser/ui/tray_icon.h | 2 +- atom/browser/ui/tray_icon_cocoa.h | 2 +- atom/browser/ui/tray_icon_cocoa.mm | 6 +++--- atom/browser/ui/win/notify_icon.cc | 4 ++-- atom/browser/ui/win/notify_icon.h | 2 +- docs/api/tray.md | 4 ++-- 10 files changed, 19 insertions(+), 15 deletions(-) diff --git a/atom/browser/api/atom_api_tray.cc b/atom/browser/api/atom_api_tray.cc index 0f07737da2bf..1382f015a63b 100644 --- a/atom/browser/api/atom_api_tray.cc +++ b/atom/browser/api/atom_api_tray.cc @@ -120,10 +120,10 @@ void Tray::DisplayBalloon(mate::Arguments* args, tray_icon_->DisplayBalloon(icon, title, content); } -void Tray::PopContextMenu(mate::Arguments* args) { +void Tray::PopUpContextMenu(mate::Arguments* args) { gfx::Point pos; args->GetNext(&pos); - tray_icon_->PopContextMenu(pos); + tray_icon_->PopUpContextMenu(pos); } void Tray::SetContextMenu(mate::Arguments* args, Menu* menu) { @@ -151,7 +151,7 @@ void Tray::BuildPrototype(v8::Isolate* isolate, .SetMethod("setTitle", &Tray::SetTitle) .SetMethod("setHighlightMode", &Tray::SetHighlightMode) .SetMethod("displayBalloon", &Tray::DisplayBalloon) - .SetMethod("popContextMenu", &Tray::PopContextMenu) + .SetMethod("popUpContextMenu", &Tray::PopUpContextMenu) .SetMethod("_setContextMenu", &Tray::SetContextMenu); } diff --git a/atom/browser/api/atom_api_tray.h b/atom/browser/api/atom_api_tray.h index 02f7418fe41d..dc9302597cf3 100644 --- a/atom/browser/api/atom_api_tray.h +++ b/atom/browser/api/atom_api_tray.h @@ -60,7 +60,7 @@ class Tray : public mate::EventEmitter, void SetTitle(mate::Arguments* args, const std::string& title); void SetHighlightMode(mate::Arguments* args, bool highlight); void DisplayBalloon(mate::Arguments* args, const mate::Dictionary& options); - void PopContextMenu(mate::Arguments* args); + void PopUpContextMenu(mate::Arguments* args); void SetContextMenu(mate::Arguments* args, Menu* menu); private: diff --git a/atom/browser/api/lib/tray.coffee b/atom/browser/api/lib/tray.coffee index 7d158a9a0104..1c225ddd403c 100644 --- a/atom/browser/api/lib/tray.coffee +++ b/atom/browser/api/lib/tray.coffee @@ -3,8 +3,12 @@ bindings = process.atomBinding 'tray' Tray = bindings.Tray Tray::__proto__ = EventEmitter.prototype + Tray::setContextMenu = (menu) -> @_setContextMenu menu @menu = menu # Keep a strong reference of menu. +# Keep compatibility with old APIs. +Tray::popContextMenu = Tray::popUpContextMenu + module.exports = Tray diff --git a/atom/browser/ui/tray_icon.cc b/atom/browser/ui/tray_icon.cc index cc19be6d8d86..12c6be2ea74e 100644 --- a/atom/browser/ui/tray_icon.cc +++ b/atom/browser/ui/tray_icon.cc @@ -26,7 +26,7 @@ void TrayIcon::DisplayBalloon(const gfx::Image& icon, const base::string16& contents) { } -void TrayIcon::PopContextMenu(const gfx::Point& pos) { +void TrayIcon::PopUpContextMenu(const gfx::Point& pos) { } void TrayIcon::NotifyClicked(const gfx::Rect& bounds, int modifiers) { diff --git a/atom/browser/ui/tray_icon.h b/atom/browser/ui/tray_icon.h index 6d917a53467c..55f1c41d19d7 100644 --- a/atom/browser/ui/tray_icon.h +++ b/atom/browser/ui/tray_icon.h @@ -47,7 +47,7 @@ class TrayIcon { const base::string16& title, const base::string16& contents); - virtual void PopContextMenu(const gfx::Point& pos); + virtual void PopUpContextMenu(const gfx::Point& pos); // Set the context menu for this icon. virtual void SetContextMenu(ui::SimpleMenuModel* menu_model) = 0; diff --git a/atom/browser/ui/tray_icon_cocoa.h b/atom/browser/ui/tray_icon_cocoa.h index db53adcbe85d..7781c93a1c03 100644 --- a/atom/browser/ui/tray_icon_cocoa.h +++ b/atom/browser/ui/tray_icon_cocoa.h @@ -29,7 +29,7 @@ class TrayIconCocoa : public TrayIcon, void SetToolTip(const std::string& tool_tip) override; void SetTitle(const std::string& title) override; void SetHighlightMode(bool highlight) override; - void PopContextMenu(const gfx::Point& pos) override; + void PopUpContextMenu(const gfx::Point& pos) override; void SetContextMenu(ui::SimpleMenuModel* menu_model) override; protected: diff --git a/atom/browser/ui/tray_icon_cocoa.mm b/atom/browser/ui/tray_icon_cocoa.mm index 7c2214e06399..d69fa8636b4f 100644 --- a/atom/browser/ui/tray_icon_cocoa.mm +++ b/atom/browser/ui/tray_icon_cocoa.mm @@ -230,7 +230,7 @@ const CGFloat kVerticalTitleMargin = 2; [self setNeedsDisplay:YES]; } -- (void)popContextMenu { +- (void)popUpContextMenu { if (menuController_ && ![menuController_ isMenuOpen]) { // Redraw the dray icon to show highlight if it is enabled. [self setNeedsDisplay:YES]; @@ -316,8 +316,8 @@ void TrayIconCocoa::SetHighlightMode(bool highlight) { [status_item_view_ setHighlight:highlight]; } -void TrayIconCocoa::PopContextMenu(const gfx::Point& pos) { - [status_item_view_ popContextMenu]; +void TrayIconCocoa::PopUpContextMenu(const gfx::Point& pos) { + [status_item_view_ popUpContextMenu]; } void TrayIconCocoa::SetContextMenu(ui::SimpleMenuModel* menu_model) { diff --git a/atom/browser/ui/win/notify_icon.cc b/atom/browser/ui/win/notify_icon.cc index ebc958384363..c4c0fe9141e3 100644 --- a/atom/browser/ui/win/notify_icon.cc +++ b/atom/browser/ui/win/notify_icon.cc @@ -87,7 +87,7 @@ void NotifyIcon::HandleClickEvent(const gfx::Point& cursor_pos, return; } else if (!double_button_click) { // single right click if (menu_model_) - PopContextMenu(cursor_pos); + PopUpContextMenu(cursor_pos); else NotifyRightClicked(gfx::Rect(rect), modifiers); } @@ -163,7 +163,7 @@ void NotifyIcon::DisplayBalloon(const gfx::Image& icon, LOG(WARNING) << "Unable to create status tray balloon."; } -void NotifyIcon::PopContextMenu(const gfx::Point& pos) { +void NotifyIcon::PopUpContextMenu(const gfx::Point& pos) { // Returns if context menu isn't set. if (!menu_model_) return; diff --git a/atom/browser/ui/win/notify_icon.h b/atom/browser/ui/win/notify_icon.h index a28a00ff0d6a..136186b689b9 100644 --- a/atom/browser/ui/win/notify_icon.h +++ b/atom/browser/ui/win/notify_icon.h @@ -52,7 +52,7 @@ class NotifyIcon : public TrayIcon { void DisplayBalloon(const gfx::Image& icon, const base::string16& title, const base::string16& contents) override; - void PopContextMenu(const gfx::Point& pos) override; + void PopUpContextMenu(const gfx::Point& pos) override; void SetContextMenu(ui::SimpleMenuModel* menu_model) override; private: diff --git a/docs/api/tray.md b/docs/api/tray.md index 3d3ebc280f5a..a67772746128 100644 --- a/docs/api/tray.md +++ b/docs/api/tray.md @@ -60,7 +60,7 @@ Creates a new tray icon associated with the `image`. Emitted when the tray icon is clicked. -__Note:__ The `bounds` payload is only implemented on OS X and Windows 7 or newer. +__Note:__ The `bounds` payload is only implemented on OS X and Windows. ### Event: 'right-clicked' @@ -173,7 +173,7 @@ Displays a tray balloon. __Note:__ This is only implemented on Windows. -### Tray.popContextMenu([position]) +### Tray.popUpContextMenu([position]) * `position` Object - The pop position * `x` Integer From c2959792704a79e057e65c0e0dad1d20be39c8e5 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 10 Aug 2015 15:02:16 +0800 Subject: [PATCH 0825/1293] BrowserContext::GetRequestContext can only be called on UI thread --- atom/browser/api/atom_api_cookies.cc | 23 +++++++++++------------ atom/browser/api/atom_api_cookies.h | 24 ++++++++++++++++++------ atom/browser/api/atom_api_session.cc | 11 ++++++----- 3 files changed, 35 insertions(+), 23 deletions(-) diff --git a/atom/browser/api/atom_api_cookies.cc b/atom/browser/api/atom_api_cookies.cc index 040efe1c360b..4d87d9b5b0ef 100644 --- a/atom/browser/api/atom_api_cookies.cc +++ b/atom/browser/api/atom_api_cookies.cc @@ -9,6 +9,7 @@ #include "atom/common/native_mate_converters/value_converter.h" #include "base/bind.h" #include "base/time/time.h" +#include "base/values.h" #include "content/public/browser/browser_context.h" #include "content/public/browser/browser_thread.h" #include "native_mate/dictionary.h" @@ -179,8 +180,8 @@ namespace atom { namespace api { -Cookies::Cookies(content::BrowserContext* browser_context) : - browser_context_(browser_context) { +Cookies::Cookies(content::BrowserContext* browser_context) + : request_context_getter_(browser_context->GetRequestContext()) { } Cookies::~Cookies() { @@ -198,11 +199,9 @@ void Cookies::Get(const base::DictionaryValue& options, void Cookies::GetCookiesOnIOThread(scoped_ptr filter, const CookiesCallback& callback) { - net::CookieStore* cookie_store = browser_context_->GetRequestContext() - ->GetURLRequestContext()->cookie_store(); std::string url; filter->GetString("url", &url); - if (!GetCookieListFromStore(cookie_store, url, + if (!GetCookieListFromStore(GetCookieStore(), url, base::Bind(&Cookies::OnGetCookies, base::Unretained(this), Passed(&filter), callback))) { BrowserThread::PostTask(BrowserThread::UI, FROM_HERE, @@ -245,9 +244,7 @@ void Cookies::Remove(const mate::Dictionary& details, void Cookies::RemoveCookiesOnIOThread(const GURL& url, const std::string& name, const CookiesCallback& callback) { - net::CookieStore* cookie_store = browser_context_->GetRequestContext() - ->GetURLRequestContext()->cookie_store(); - cookie_store->DeleteCookieAsync(url, name, + GetCookieStore()->DeleteCookieAsync(url, name, base::Bind(&Cookies::OnRemoveCookies, base::Unretained(this), callback)); } @@ -286,8 +283,6 @@ void Cookies::SetCookiesOnIOThread(scoped_ptr details, const GURL& url, const CookiesCallback& callback) { DCHECK_CURRENTLY_ON(BrowserThread::IO); - net::CookieStore* cookie_store = browser_context_->GetRequestContext() - ->GetURLRequestContext()->cookie_store(); std::string name, value, domain, path; bool secure = false; @@ -308,7 +303,7 @@ void Cookies::SetCookiesOnIOThread(scoped_ptr details, base::Time::FromDoubleT(expiration_date); } - cookie_store->GetCookieMonster()->SetCookieWithDetailsAsync( + GetCookieStore()->GetCookieMonster()->SetCookieWithDetailsAsync( url, name, value, @@ -337,6 +332,10 @@ mate::ObjectTemplateBuilder Cookies::GetObjectTemplateBuilder( .SetMethod("set", &Cookies::Set); } +net::CookieStore* Cookies::GetCookieStore() { + return request_context_getter_->GetURLRequestContext()->cookie_store(); +} + // static mate::Handle Cookies::Create( v8::Isolate* isolate, @@ -346,4 +345,4 @@ mate::Handle Cookies::Create( } // namespace api -} // namespace atom +} // namespace atotContext diff --git a/atom/browser/api/atom_api_cookies.h b/atom/browser/api/atom_api_cookies.h index 61357f05d75d..12cf4a220979 100644 --- a/atom/browser/api/atom_api_cookies.h +++ b/atom/browser/api/atom_api_cookies.h @@ -8,17 +8,27 @@ #include #include "base/callback.h" -#include "base/values.h" #include "native_mate/wrappable.h" #include "native_mate/handle.h" -#include "native_mate/dictionary.h" - #include "net/cookies/canonical_cookie.h" +namespace base { +class DictionaryValue; +} + namespace content { class BrowserContext; } +namespace mate { +class Dictionary; +} + +namespace net { +class CookieStore; +class URLRequestContextGetter; +} + namespace atom { namespace api { @@ -60,13 +70,15 @@ class Cookies : public mate::Wrappable { void OnSetCookies(const CookiesCallback& callback, bool set_success); - - // mate::Wrappable implementations: + // mate::Wrappable: mate::ObjectTemplateBuilder GetObjectTemplateBuilder( v8::Isolate* isolate) override; private: - content::BrowserContext* browser_context_; + // Must be called on IO thread. + net::CookieStore* GetCookieStore(); + + scoped_refptr request_context_getter_; DISALLOW_COPY_AND_ASSIGN(Cookies); }; diff --git a/atom/browser/api/atom_api_session.cc b/atom/browser/api/atom_api_session.cc index b8b1434dd70d..9961d6cc6601 100644 --- a/atom/browser/api/atom_api_session.cc +++ b/atom/browser/api/atom_api_session.cc @@ -19,6 +19,7 @@ #include "chrome/common/pref_names.h" #include "content/public/browser/browser_thread.h" #include "content/public/browser/storage_partition.h" +#include "native_mate/dictionary.h" #include "native_mate/object_template_builder.h" #include "net/base/load_flags.h" #include "net/disk_cache/disk_cache.h" @@ -181,10 +182,10 @@ void OnGetBackend(disk_cache::Backend** backend_ptr, } } -void ClearHttpCacheInIO(content::BrowserContext* browser_context, - const net::CompletionCallback& callback) { - auto request_context = - browser_context->GetRequestContext()->GetURLRequestContext(); +void ClearHttpCacheInIO( + const scoped_refptr& context_getter, + const net::CompletionCallback& callback) { + auto request_context = context_getter->GetURLRequestContext(); auto http_cache = request_context->http_transaction_factory()->GetCache(); if (!http_cache) RunCallbackInUI(callback, net::ERR_FAILED); @@ -226,7 +227,7 @@ void Session::ResolveProxy(const GURL& url, ResolveProxyCallback callback) { void Session::ClearCache(const net::CompletionCallback& callback) { BrowserThread::PostTask(BrowserThread::IO, FROM_HERE, base::Bind(&ClearHttpCacheInIO, - base::Unretained(browser_context_), + make_scoped_refptr(browser_context_->GetRequestContext()), callback)); } From 0644129fbe46580539423d21a004d2241e527732 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 10 Aug 2015 15:28:18 +0800 Subject: [PATCH 0826/1293] Pass net::URLRequestContextGetter in scoped_refptr --- atom/browser/api/atom_api_protocol.cc | 38 ++++++++++------------- atom/browser/api/atom_api_protocol.h | 8 +++-- atom/browser/api/atom_api_session.h | 8 ++--- atom/browser/net/adapter_request_job.cc | 2 +- atom/browser/net/adapter_request_job.h | 2 +- atom/browser/net/url_request_fetch_job.cc | 4 +-- atom/browser/net/url_request_fetch_job.h | 2 +- 7 files changed, 31 insertions(+), 33 deletions(-) diff --git a/atom/browser/api/atom_api_protocol.cc b/atom/browser/api/atom_api_protocol.cc index 1241a95a718f..fdc5ba422bd3 100644 --- a/atom/browser/api/atom_api_protocol.cc +++ b/atom/browser/api/atom_api_protocol.cc @@ -35,23 +35,6 @@ struct Converter { } }; -template<> -struct Converter { - static bool FromV8(v8::Isolate* isolate, v8::Local val, - net::URLRequestContextGetter** out) { - if (val->IsNull()) { - *out = nullptr; - return true; - } - - atom::api::Session* session; - if (!Converter::FromV8(isolate, val, &session)) - return false; - *out = session->browser_context()->GetRequestContext(); - return true; - } -}; - } // namespace mate namespace atom { @@ -141,16 +124,27 @@ class CustomProtocolRequestJob : public AdapterRequestJob { } else if (name == "RequestHttpJob") { GURL url; std::string method, referrer; - net::URLRequestContextGetter* getter = - registry_->browser_context()->GetRequestContext(); dict.Get("url", &url); dict.Get("method", &method); dict.Get("referrer", &referrer); - dict.Get("session", &getter); + + v8::Local value; + mate::Handle session; + scoped_refptr request_context_getter; + // "session" null -> pass nullptr; + // "session" a Session object -> use passed session. + // "session" undefined -> use current session; + if (dict.Get("session", &session)) + request_context_getter = + session->browser_context()->GetRequestContext(); + else if (dict.Get("session", &value) && value->IsNull()) + request_context_getter = nullptr; + else + request_context_getter = registry_->request_context_getter(); BrowserThread::PostTask(BrowserThread::IO, FROM_HERE, base::Bind(&AdapterRequestJob::CreateHttpJobAndStart, GetWeakPtr(), - base::Unretained(getter), url, method, referrer)); + request_context_getter, url, method, referrer)); return; } } @@ -237,7 +231,7 @@ std::string ConvertErrorCode(int error_code) { } // namespace Protocol::Protocol(AtomBrowserContext* browser_context) - : browser_context_(browser_context), + : request_context_getter_(browser_context->GetRequestContext()), job_factory_(browser_context->job_factory()) { CHECK(job_factory_); } diff --git a/atom/browser/api/atom_api_protocol.h b/atom/browser/api/atom_api_protocol.h index b4d56018baf3..4dec17a74340 100644 --- a/atom/browser/api/atom_api_protocol.h +++ b/atom/browser/api/atom_api_protocol.h @@ -16,6 +16,7 @@ namespace net { class URLRequest; +class URLRequestContextGetter; } namespace atom { @@ -46,7 +47,9 @@ class Protocol : public mate::EventEmitter { JsProtocolHandler GetProtocolHandler(const std::string& scheme); - AtomBrowserContext* browser_context() const { return browser_context_; } + net::URLRequestContextGetter* request_context_getter() { + return request_context_getter_.get(); + } protected: explicit Protocol(AtomBrowserContext* browser_context); @@ -94,7 +97,8 @@ class Protocol : public mate::EventEmitter { const JsProtocolHandler& handler); int UninterceptProtocolInIO(const std::string& scheme); - AtomBrowserContext* browser_context_; + scoped_refptr request_context_getter_; + AtomURLRequestJobFactory* job_factory_; ProtocolHandlersMap protocol_handlers_; diff --git a/atom/browser/api/atom_api_session.h b/atom/browser/api/atom_api_session.h index bd12b7589914..b353c61c2109 100644 --- a/atom/browser/api/atom_api_session.h +++ b/atom/browser/api/atom_api_session.h @@ -13,14 +13,14 @@ class GURL; -namespace mate { -class Arguments; -} - namespace base { class FilePath; } +namespace mate { +class Arguments; +} + namespace atom { class AtomBrowserContext; diff --git a/atom/browser/net/adapter_request_job.cc b/atom/browser/net/adapter_request_job.cc index 5c41c6f65aac..ca7dcf2e566b 100644 --- a/atom/browser/net/adapter_request_job.cc +++ b/atom/browser/net/adapter_request_job.cc @@ -119,7 +119,7 @@ void AdapterRequestJob::CreateFileJobAndStart(const base::FilePath& path) { } void AdapterRequestJob::CreateHttpJobAndStart( - net::URLRequestContextGetter* request_context_getter, + scoped_refptr request_context_getter, const GURL& url, const std::string& method, const std::string& referrer) { diff --git a/atom/browser/net/adapter_request_job.h b/atom/browser/net/adapter_request_job.h index b1d28b1446c1..afb9d5f55d07 100644 --- a/atom/browser/net/adapter_request_job.h +++ b/atom/browser/net/adapter_request_job.h @@ -65,7 +65,7 @@ class AdapterRequestJob : public net::URLRequestJob { scoped_refptr data); void CreateFileJobAndStart(const base::FilePath& path); void CreateHttpJobAndStart( - net::URLRequestContextGetter* request_context_getter, + scoped_refptr request_context_getter, const GURL& url, const std::string& method, const std::string& referrer); diff --git a/atom/browser/net/url_request_fetch_job.cc b/atom/browser/net/url_request_fetch_job.cc index abad38d7f4d5..ee4c67b371ee 100644 --- a/atom/browser/net/url_request_fetch_job.cc +++ b/atom/browser/net/url_request_fetch_job.cc @@ -75,7 +75,7 @@ class ResponsePiper : public net::URLFetcherResponseWriter { } // namespace URLRequestFetchJob::URLRequestFetchJob( - net::URLRequestContextGetter* request_context_getter, + scoped_refptr request_context_getter, net::URLRequest* request, net::NetworkDelegate* network_delegate, const GURL& url, @@ -93,7 +93,7 @@ URLRequestFetchJob::URLRequestFetchJob( fetcher_.reset(net::URLFetcher::Create(url, request_type, this)); // Use request context if provided else create one. if (request_context_getter) - fetcher_->SetRequestContext(request_context_getter); + fetcher_->SetRequestContext(request_context_getter.get()); else fetcher_->SetRequestContext(GetRequestContext()); diff --git a/atom/browser/net/url_request_fetch_job.h b/atom/browser/net/url_request_fetch_job.h index 228af7904fe9..a14e8dd1aae3 100644 --- a/atom/browser/net/url_request_fetch_job.h +++ b/atom/browser/net/url_request_fetch_job.h @@ -18,7 +18,7 @@ class AtomBrowserContext; class URLRequestFetchJob : public net::URLRequestJob, public net::URLFetcherDelegate { public: - URLRequestFetchJob(net::URLRequestContextGetter* request_context_getter, + URLRequestFetchJob(scoped_refptr context_getter, net::URLRequest* request, net::NetworkDelegate* network_delegate, const GURL& url, From 3379641fe211b37e7264c2e56de5a9f7c3f57c84 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 10 Aug 2015 15:31:29 +0800 Subject: [PATCH 0827/1293] Force request context to initialize beforing incepting protocol --- atom/browser/api/atom_api_protocol.cc | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/atom/browser/api/atom_api_protocol.cc b/atom/browser/api/atom_api_protocol.cc index fdc5ba422bd3..d7d308b306ed 100644 --- a/atom/browser/api/atom_api_protocol.cc +++ b/atom/browser/api/atom_api_protocol.cc @@ -355,6 +355,10 @@ int Protocol::InterceptProtocolInIO(const std::string& scheme, const JsProtocolHandler& handler) { DCHECK_CURRENTLY_ON(BrowserThread::IO); + // Force the request context to initialize, otherwise we might have nothing + // to intercept. + request_context_getter_->GetURLRequestContext(); + if (!job_factory_->HasProtocolHandler(scheme)) return ERR_NO_SCHEME; From 140ba2858afd32e1ee647bb6e39879cb7000a3e5 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 10 Aug 2015 15:36:47 +0800 Subject: [PATCH 0828/1293] Fix cpplint warnings --- atom/browser/api/atom_api_cookies.cc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/atom/browser/api/atom_api_cookies.cc b/atom/browser/api/atom_api_cookies.cc index 4d87d9b5b0ef..bf56a8dc13bd 100644 --- a/atom/browser/api/atom_api_cookies.cc +++ b/atom/browser/api/atom_api_cookies.cc @@ -345,4 +345,4 @@ mate::Handle Cookies::Create( } // namespace api -} // namespace atotContext +} // namespace atom From b4e836bf2ee20d4675f548c70754cf12db8fb7c8 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 10 Aug 2015 15:47:49 +0800 Subject: [PATCH 0829/1293] Bump v0.30.4 --- atom.gyp | 2 +- atom/browser/resources/mac/Info.plist | 2 +- atom/browser/resources/win/atom.rc | 8 ++++---- atom/common/atom_version.h | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/atom.gyp b/atom.gyp index 620464e22574..d24f193ac2db 100644 --- a/atom.gyp +++ b/atom.gyp @@ -4,7 +4,7 @@ 'product_name%': 'Electron', 'company_name%': 'GitHub, Inc', 'company_abbr%': 'github', - 'version%': '0.30.3', + 'version%': '0.30.4', }, 'includes': [ 'filenames.gypi', diff --git a/atom/browser/resources/mac/Info.plist b/atom/browser/resources/mac/Info.plist index 23af6a804901..a8c009acaff5 100644 --- a/atom/browser/resources/mac/Info.plist +++ b/atom/browser/resources/mac/Info.plist @@ -17,7 +17,7 @@ CFBundleIconFile atom.icns CFBundleVersion - 0.30.3 + 0.30.4 LSMinimumSystemVersion 10.8.0 NSMainNibFile diff --git a/atom/browser/resources/win/atom.rc b/atom/browser/resources/win/atom.rc index 2379d294a35c..b22d3d88f6c4 100644 --- a/atom/browser/resources/win/atom.rc +++ b/atom/browser/resources/win/atom.rc @@ -56,8 +56,8 @@ END // VS_VERSION_INFO VERSIONINFO - FILEVERSION 0,30,3,0 - PRODUCTVERSION 0,30,3,0 + FILEVERSION 0,30,4,0 + PRODUCTVERSION 0,30,4,0 FILEFLAGSMASK 0x3fL #ifdef _DEBUG FILEFLAGS 0x1L @@ -74,12 +74,12 @@ BEGIN BEGIN VALUE "CompanyName", "GitHub, Inc." VALUE "FileDescription", "Electron" - VALUE "FileVersion", "0.30.3" + VALUE "FileVersion", "0.30.4" VALUE "InternalName", "electron.exe" VALUE "LegalCopyright", "Copyright (C) 2015 GitHub, Inc. All rights reserved." VALUE "OriginalFilename", "electron.exe" VALUE "ProductName", "Electron" - VALUE "ProductVersion", "0.30.3" + VALUE "ProductVersion", "0.30.4" VALUE "SquirrelAwareVersion", "1" END END diff --git a/atom/common/atom_version.h b/atom/common/atom_version.h index 761c7463bb08..405a104a76f7 100644 --- a/atom/common/atom_version.h +++ b/atom/common/atom_version.h @@ -7,7 +7,7 @@ #define ATOM_MAJOR_VERSION 0 #define ATOM_MINOR_VERSION 30 -#define ATOM_PATCH_VERSION 3 +#define ATOM_PATCH_VERSION 4 #define ATOM_VERSION_IS_RELEASE 1 From 48ccb0f2ab25719b55798f3c7d7d1351966d6f97 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Tue, 4 Aug 2015 16:23:54 +0800 Subject: [PATCH 0830/1293] No gfx::SingletonHwnd::Observer any more. Using gfx::SingletonHwndObserver instead. --- .../extensions/global_shortcut_listener_win.cc | 10 ++++++++-- .../extensions/global_shortcut_listener_win.h | 14 +++++++------- 2 files changed, 15 insertions(+), 9 deletions(-) diff --git a/chromium_src/chrome/browser/extensions/global_shortcut_listener_win.cc b/chromium_src/chrome/browser/extensions/global_shortcut_listener_win.cc index 248ec6b890ef..8ed234d5e81b 100644 --- a/chromium_src/chrome/browser/extensions/global_shortcut_listener_win.cc +++ b/chromium_src/chrome/browser/extensions/global_shortcut_listener_win.cc @@ -4,11 +4,14 @@ #include "chrome/browser/extensions/global_shortcut_listener_win.h" +#include "base/bind.h" +#include "base/bind_helpers.h" #include "base/win/win_util.h" #include "content/public/browser/browser_thread.h" #include "ui/base/accelerators/accelerator.h" #include "ui/events/event_constants.h" #include "ui/events/keycodes/keyboard_code_conversion_win.h" +#include "ui/gfx/win/singleton_hwnd.h" using content::BrowserThread; @@ -35,14 +38,17 @@ GlobalShortcutListenerWin::~GlobalShortcutListenerWin() { void GlobalShortcutListenerWin::StartListening() { DCHECK(!is_listening_); // Don't start twice. DCHECK(!hotkey_ids_.empty()); // Also don't start if no hotkey is registered. - gfx::SingletonHwnd::GetInstance()->AddObserver(this); + singleton_hwnd_observer_.reset(new gfx::SingletonHwndObserver( + base::Bind( + &GlobalShortcutListenerWin::OnWndProc, base::Unretained(this)))); + is_listening_ = true; } void GlobalShortcutListenerWin::StopListening() { DCHECK(is_listening_); // No point if we are not already listening. DCHECK(hotkey_ids_.empty()); // Make sure the map is clean before ending. - gfx::SingletonHwnd::GetInstance()->RemoveObserver(this); + singleton_hwnd_observer_.reset(nullptr); is_listening_ = false; } diff --git a/chromium_src/chrome/browser/extensions/global_shortcut_listener_win.h b/chromium_src/chrome/browser/extensions/global_shortcut_listener_win.h index a155d8f8991f..b3917e9a160e 100644 --- a/chromium_src/chrome/browser/extensions/global_shortcut_listener_win.h +++ b/chromium_src/chrome/browser/extensions/global_shortcut_listener_win.h @@ -7,26 +7,24 @@ #include +#include "base/memory/scoped_ptr.h" #include "chrome/browser/extensions/global_shortcut_listener.h" #include "ui/gfx/win/singleton_hwnd.h" +#include "ui/gfx/win/singleton_hwnd_observer.h" namespace extensions { // Windows-specific implementation of the GlobalShortcutListener class that // listens for global shortcuts. Handles setting up a keyboard hook and // forwarding its output to the base class for processing. -class GlobalShortcutListenerWin : public GlobalShortcutListener, - public gfx::SingletonHwnd::Observer { +class GlobalShortcutListenerWin : public GlobalShortcutListener { public: GlobalShortcutListenerWin(); virtual ~GlobalShortcutListenerWin(); private: - // The implementation of our Window Proc, called by SingletonHwnd. - virtual void OnWndProc(HWND hwnd, - UINT message, - WPARAM wparam, - LPARAM lparam) override; + // The implementation of our Window Proc, called by SingletonHwndObserver. + void OnWndProc(HWND hwnd, UINT message, WPARAM wparam, LPARAM lparam); // GlobalShortcutListener implementation. virtual void StartListening() override; @@ -43,6 +41,8 @@ class GlobalShortcutListenerWin : public GlobalShortcutListener, typedef std::map HotkeyIdMap; HotkeyIdMap hotkey_ids_; + scoped_ptr singleton_hwnd_observer_; + DISALLOW_COPY_AND_ASSIGN(GlobalShortcutListenerWin); }; From d08392a0c473cc1a11308e13f27ca02a07d15383 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Tue, 4 Aug 2015 16:25:05 +0800 Subject: [PATCH 0831/1293] No need `base/float_util.h` since VS2013 supports well enough. --- chromium_src/chrome/browser/speech/tts_controller_impl.cc | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/chromium_src/chrome/browser/speech/tts_controller_impl.cc b/chromium_src/chrome/browser/speech/tts_controller_impl.cc index 272cafddb947..6b66b6a61960 100644 --- a/chromium_src/chrome/browser/speech/tts_controller_impl.cc +++ b/chromium_src/chrome/browser/speech/tts_controller_impl.cc @@ -7,7 +7,6 @@ #include #include -#include "base/float_util.h" #include "base/values.h" #include "chrome/browser/browser_process.h" #include "chrome/browser/speech/tts_platform.h" @@ -461,4 +460,4 @@ void TtsControllerImpl::SetTtsEngineDelegate( TtsEngineDelegate* TtsControllerImpl::GetTtsEngineDelegate() { return tts_engine_delegate_; -} \ No newline at end of file +} From 8fda1752641fcf485f51d192922f8f492e5b4a8c Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Tue, 4 Aug 2015 16:33:38 +0800 Subject: [PATCH 0832/1293] Update base::Value::CreateNullValue API changes. --- atom/common/native_mate_converters/v8_value_converter.cc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/atom/common/native_mate_converters/v8_value_converter.cc b/atom/common/native_mate_converters/v8_value_converter.cc index 87bc2e7c030f..0d5a25765470 100644 --- a/atom/common/native_mate_converters/v8_value_converter.cc +++ b/atom/common/native_mate_converters/v8_value_converter.cc @@ -211,7 +211,7 @@ base::Value* V8ValueConverter::FromV8ValueImpl( return NULL; if (val->IsNull()) - return base::Value::CreateNullValue(); + return base::Value::CreateNullValue().release(); if (val->IsBoolean()) return new base::FundamentalValue(val->ToBoolean()->Value()); @@ -271,7 +271,7 @@ base::Value* V8ValueConverter::FromV8Array( FromV8ValueState* state, v8::Isolate* isolate) const { if (!state->UpdateAndCheckUniqueness(val)) - return base::Value::CreateNullValue(); + return base::Value::CreateNullValue().release(); scoped_ptr scope; // If val was created in a different context than our current one, change to @@ -310,7 +310,7 @@ base::Value* V8ValueConverter::FromV8Object( FromV8ValueState* state, v8::Isolate* isolate) const { if (!state->UpdateAndCheckUniqueness(val)) - return base::Value::CreateNullValue(); + return base::Value::CreateNullValue().release(); scoped_ptr scope; // If val was created in a different context than our current one, change to From d003b1bb578cd1ee9f763a126da0e97758254ed2 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Tue, 4 Aug 2015 16:39:37 +0800 Subject: [PATCH 0833/1293] LoadV8Snapshot has been moved from gin::IsolateHolder to gin::V8Initializer. --- atom/app/node_main.cc | 3 ++- atom/browser/javascript_environment.cc | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/atom/app/node_main.cc b/atom/app/node_main.cc index 7446a0a71106..fe4f3fcbfa17 100644 --- a/atom/app/node_main.cc +++ b/atom/app/node_main.cc @@ -8,6 +8,7 @@ #include "atom/common/node_includes.h" #include "gin/array_buffer.h" #include "gin/public/isolate_holder.h" +#include "gin/v8_initializer.h" namespace atom { @@ -19,7 +20,7 @@ int NodeMain(int argc, char *argv[]) { int exit_code = 1; { - gin::IsolateHolder::LoadV8Snapshot(); + gin::V8Initializer::LoadV8Snapshot(); gin::IsolateHolder::Initialize( gin::IsolateHolder::kNonStrictMode, gin::ArrayBufferAllocator::SharedInstance()); diff --git a/atom/browser/javascript_environment.cc b/atom/browser/javascript_environment.cc index 887c59353ae4..3788fcad8b68 100644 --- a/atom/browser/javascript_environment.cc +++ b/atom/browser/javascript_environment.cc @@ -5,6 +5,7 @@ #include "atom/browser/javascript_environment.h" #include "gin/array_buffer.h" +#include "gin/v8_initializer.h" namespace atom { @@ -19,7 +20,7 @@ JavascriptEnvironment::JavascriptEnvironment() } bool JavascriptEnvironment::Initialize() { - gin::IsolateHolder::LoadV8Snapshot(); + gin::V8Initializer::LoadV8Snapshot(); gin::IsolateHolder::Initialize(gin::IsolateHolder::kNonStrictMode, gin::ArrayBufferAllocator::SharedInstance()); return true; From fc4031ec264294e63238a0f13dc702de44e7ed96 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Tue, 4 Aug 2015 16:41:51 +0800 Subject: [PATCH 0834/1293] Now the value in ScopedPtrHashMap is required to be scoped_ptr. --- atom/common/asar/archive.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/atom/common/asar/archive.h b/atom/common/asar/archive.h index 2acd17fd7ab4..dda7aa78e0c0 100644 --- a/atom/common/asar/archive.h +++ b/atom/common/asar/archive.h @@ -73,7 +73,8 @@ class Archive { scoped_ptr header_; // Cached external temporary files. - base::ScopedPtrHashMap external_files_; + base::ScopedPtrHashMap> + external_files_; DISALLOW_COPY_AND_ASSIGN(Archive); }; From 46c7ba734b6b63dcf241cf33e5bd595969f265dc Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Tue, 4 Aug 2015 16:46:11 +0800 Subject: [PATCH 0835/1293] Fix WillAttach API changes in content::BrowserPluginGuestDelegate. --- atom/browser/web_view_guest_delegate.cc | 3 ++- atom/browser/web_view_guest_delegate.h | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/atom/browser/web_view_guest_delegate.cc b/atom/browser/web_view_guest_delegate.cc index 38f4da4c1f96..efa21421c0d6 100644 --- a/atom/browser/web_view_guest_delegate.cc +++ b/atom/browser/web_view_guest_delegate.cc @@ -158,7 +158,8 @@ void WebViewGuestDelegate::SetGuestHost(content::GuestHost* guest_host) { void WebViewGuestDelegate::WillAttach( content::WebContents* embedder_web_contents, int element_instance_id, - bool is_full_page_plugin) { + bool is_full_page_plugin, + const base::Closure& completion_callback) { embedder_web_contents_ = embedder_web_contents; is_full_page_plugin_ = is_full_page_plugin; } diff --git a/atom/browser/web_view_guest_delegate.h b/atom/browser/web_view_guest_delegate.h index 3312b46104a0..65e0bcde1916 100644 --- a/atom/browser/web_view_guest_delegate.h +++ b/atom/browser/web_view_guest_delegate.h @@ -70,7 +70,8 @@ class WebViewGuestDelegate : public content::BrowserPluginGuestDelegate, void SetGuestHost(content::GuestHost* guest_host) final; void WillAttach(content::WebContents* embedder_web_contents, int element_instance_id, - bool is_full_page_plugin) final; + bool is_full_page_plugin, + const base::Closure& completion_callback) final; private: // This method is invoked when the contents auto-resized to give the container From 11ffb9dfb6898f24a26a40e767c17b6bd83783f8 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Tue, 4 Aug 2015 16:50:33 +0800 Subject: [PATCH 0836/1293] Fix node::Buffer API changes. --- atom/common/api/atom_api_native_image.cc | 13 +++++++------ .../printing/print_preview_message_handler.cc | 4 ++-- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/atom/common/api/atom_api_native_image.cc b/atom/common/api/atom_api_native_image.cc index 40a73a7de3f7..79fc0c0d6b1a 100644 --- a/atom/common/api/atom_api_native_image.cc +++ b/atom/common/api/atom_api_native_image.cc @@ -148,17 +148,18 @@ mate::ObjectTemplateBuilder NativeImage::GetObjectTemplateBuilder( v8::Local NativeImage::ToPNG(v8::Isolate* isolate) { scoped_refptr png = image_.As1xPNGBytes(); - return node::Buffer::New(isolate, - reinterpret_cast(png->front()), - png->size()); + return node::Buffer::Copy(isolate, + reinterpret_cast(png->front()), + static_cast(png->size())).ToLocalChecked(); } v8::Local NativeImage::ToJPEG(v8::Isolate* isolate, int quality) { std::vector output; gfx::JPEG1xEncodedDataFromImage(image_, quality, &output); - return node::Buffer::New(isolate, - reinterpret_cast(&output.front()), - output.size()); + return node::Buffer::Copy( + isolate, + reinterpret_cast(&output.front()), + static_cast(output.size())).ToLocalChecked(); } std::string NativeImage::ToDataURL() { diff --git a/chromium_src/chrome/browser/printing/print_preview_message_handler.cc b/chromium_src/chrome/browser/printing/print_preview_message_handler.cc index ca70ac2c58ef..613f3f2343ce 100644 --- a/chromium_src/chrome/browser/printing/print_preview_message_handler.cc +++ b/chromium_src/chrome/browser/printing/print_preview_message_handler.cc @@ -125,8 +125,8 @@ void PrintPreviewMessageHandler::RunPrintToPDFCallback( v8::Locker locker(isolate); v8::HandleScope handle_scope(isolate); if (data) { - v8::Local buffer = node::Buffer::Use(isolate, - data, static_cast(data_size)); + v8::Local buffer = node::Buffer::New(isolate, + data, static_cast(data_size)).ToLocalChecked(); print_to_pdf_callback_map_[request_id].Run(v8::Null(isolate), buffer); } else { v8::Local error_message = v8::String::NewFromUtf8(isolate, From 0e8a585157441358fac9e5a1ec389337f003ac17 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Tue, 4 Aug 2015 17:07:31 +0800 Subject: [PATCH 0837/1293] Fix content::BrowserPluginDelegate::DidResizeElement API changes. Chromium has removed old_size in DidResizeElement interface as the 'old_size' is internal. --- atom/renderer/guest_view_container.cc | 6 ++---- atom/renderer/guest_view_container.h | 6 ++---- atom/renderer/lib/web-view/web-view.coffee | 4 +--- 3 files changed, 5 insertions(+), 11 deletions(-) diff --git a/atom/renderer/guest_view_container.cc b/atom/renderer/guest_view_container.cc index 7643f72b0e5b..c0bc1427d68c 100644 --- a/atom/renderer/guest_view_container.cc +++ b/atom/renderer/guest_view_container.cc @@ -47,14 +47,12 @@ void GuestViewContainer::SetElementInstanceID(int element_instance_id) { std::make_pair(element_instance_id, this)); } -void GuestViewContainer::DidResizeElement(const gfx::Size& old_size, - const gfx::Size& new_size) { +void GuestViewContainer::DidResizeElement(const gfx::Size& new_size) { if (element_resize_callback_.is_null()) return; base::MessageLoop::current()->PostTask( - FROM_HERE, - base::Bind(element_resize_callback_, old_size, new_size)); + FROM_HERE, base::Bind(element_resize_callback_, new_size)); } } // namespace atom diff --git a/atom/renderer/guest_view_container.h b/atom/renderer/guest_view_container.h index b81f84cbd050..2846265cb2af 100644 --- a/atom/renderer/guest_view_container.h +++ b/atom/renderer/guest_view_container.h @@ -16,8 +16,7 @@ namespace atom { class GuestViewContainer : public content::BrowserPluginDelegate { public: - typedef base::Callback - ResizeCallback; + typedef base::Callback ResizeCallback; explicit GuestViewContainer(content::RenderFrame* render_frame); ~GuestViewContainer() override; @@ -28,8 +27,7 @@ class GuestViewContainer : public content::BrowserPluginDelegate { // content::BrowserPluginDelegate: void SetElementInstanceID(int element_instance_id) final; - void DidResizeElement(const gfx::Size& old_size, - const gfx::Size& new_size) final; + void DidResizeElement(const gfx::Size& new_size) final; private: int element_instance_id_; diff --git a/atom/renderer/lib/web-view/web-view.coffee b/atom/renderer/lib/web-view/web-view.coffee index 35fbe17796f4..f5bcf0496f8c 100644 --- a/atom/renderer/lib/web-view/web-view.coffee +++ b/atom/renderer/lib/web-view/web-view.coffee @@ -123,11 +123,9 @@ class WebViewImpl # changed. @dispatchEvent webViewEvent - onElementResize: (oldSize, newSize) -> + onElementResize: (newSize) -> # Dispatch the 'resize' event. resizeEvent = new Event('resize', bubbles: true) - resizeEvent.oldWidth = oldSize.width - resizeEvent.oldHeight = oldSize.height resizeEvent.newWidth = newSize.width resizeEvent.newHeight = newSize.height @dispatchEvent resizeEvent From f9fee9174aa96b9768d47552566eea9318c43db3 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Tue, 4 Aug 2015 17:10:35 +0800 Subject: [PATCH 0838/1293] net::URLFetcher::Create now returns object with scoped_ptr. --- atom/browser/net/url_request_fetch_job.cc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/atom/browser/net/url_request_fetch_job.cc b/atom/browser/net/url_request_fetch_job.cc index ee4c67b371ee..47ca0633c6ca 100644 --- a/atom/browser/net/url_request_fetch_job.cc +++ b/atom/browser/net/url_request_fetch_job.cc @@ -90,7 +90,7 @@ URLRequestFetchJob::URLRequestFetchJob( else request_type = GetRequestType(method); - fetcher_.reset(net::URLFetcher::Create(url, request_type, this)); + fetcher_ = net::URLFetcher::Create(url, request_type, this); // Use request context if provided else create one. if (request_context_getter) fetcher_->SetRequestContext(request_context_getter.get()); From 4e3187fbbda3bd1742881987a8bf2326a6c29b77 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Tue, 4 Aug 2015 17:16:08 +0800 Subject: [PATCH 0839/1293] No need to specify ffmpeg library as it's a normal built library in libchromiumcontent. --- atom.gyp | 3 --- 1 file changed, 3 deletions(-) diff --git a/atom.gyp b/atom.gyp index d24f193ac2db..99ae12452ac6 100644 --- a/atom.gyp +++ b/atom.gyp @@ -144,7 +144,6 @@ 'destination': '<(PRODUCT_DIR)', 'files': [ '<@(copied_libraries)', - '<(libchromiumcontent_dir)/ffmpegsumo.dll', '<(libchromiumcontent_dir)/libEGL.dll', '<(libchromiumcontent_dir)/libGLESv2.dll', '<(libchromiumcontent_dir)/icudtl.dat', @@ -193,7 +192,6 @@ 'destination': '<(PRODUCT_DIR)', 'files': [ '<@(copied_libraries)', - '<(libchromiumcontent_dir)/libffmpegsumo.so', '<(libchromiumcontent_dir)/icudtl.dat', '<(libchromiumcontent_dir)/content_shell.pak', '<(libchromiumcontent_dir)/natives_blob.bin', @@ -441,7 +439,6 @@ 'destination': '<(PRODUCT_DIR)/<(product_name) Framework.framework/Versions/A/Libraries', 'files': [ '<@(copied_libraries)', - '<(libchromiumcontent_dir)/ffmpegsumo.so', ], }, { From 28093a4d2d6b3eae728a1764f21fcdc8cb3db63e Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Thu, 6 Aug 2015 15:03:04 +0800 Subject: [PATCH 0840/1293] Fix a crash issue in GetProcessOwner if no renderer view host is found. --- atom/browser/atom_browser_client.cc | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/atom/browser/atom_browser_client.cc b/atom/browser/atom_browser_client.cc index 65fd7cd031dd..9a3ad00fa4cd 100644 --- a/atom/browser/atom_browser_client.cc +++ b/atom/browser/atom_browser_client.cc @@ -58,11 +58,15 @@ enum ProcessOwner { OWNER_GUEST_WEB_CONTENTS, OWNER_NONE, // it might be devtools though. }; + ProcessOwner GetProcessOwner(int process_id, NativeWindow** window, WebViewManager::WebViewInfo* info) { - auto web_contents = content::WebContents::FromRenderViewHost( - content::RenderViewHost::FromID(process_id, kDefaultRoutingID)); + content::RenderViewHost* rvh = content::RenderViewHost::FromID( + process_id, kDefaultRoutingID); + if (!rvh) + return OWNER_NONE; + auto web_contents = content::WebContents::FromRenderViewHost(rvh); if (!web_contents) return OWNER_NONE; From c5e540823b30efde052acfe04fc9a96cfdfc8683 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 11 Aug 2015 09:50:19 +0800 Subject: [PATCH 0841/1293] Update to Chrome 44 --- script/lib/config.py | 2 +- vendor/brightray | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/script/lib/config.py b/script/lib/config.py index 1298651b7edf..c30e5544075d 100644 --- a/script/lib/config.py +++ b/script/lib/config.py @@ -8,7 +8,7 @@ import sys BASE_URL = os.getenv('LIBCHROMIUMCONTENT_MIRROR') or \ 'http://github-janky-artifacts.s3.amazonaws.com/libchromiumcontent' -LIBCHROMIUMCONTENT_COMMIT = 'dd51a41b42246b0b5159bfad5e327c8cf10bc585' +LIBCHROMIUMCONTENT_COMMIT = '86d7fcb507e76a917840c31c37b32e501e16a1d4' PLATFORM = { 'cygwin': 'win32', diff --git a/vendor/brightray b/vendor/brightray index f4470ee48a74..3f4895f3fd7c 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit f4470ee48a748888bccba21845bfd65caaa1a6ce +Subproject commit 3f4895f3fd7cb2ec415b259c2808005512dec57f From 5c57f92ba53b8a3d7ee462f52c0f45dfdf06353e Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 11 Aug 2015 09:58:36 +0800 Subject: [PATCH 0842/1293] Update io.js to v3.0.0 --- vendor/node | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/node b/vendor/node index 7888f607ce74..02d6e45de63d 160000 --- a/vendor/node +++ b/vendor/node @@ -1 +1 @@ -Subproject commit 7888f607ce74cc100ceb78f3af258a55ee2f62c4 +Subproject commit 02d6e45de63d4bbb133cc73ab3937e5115fb4ddd From 4337c07425e441c35c0a88f080be4384e5e40deb Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 11 Aug 2015 10:02:46 +0800 Subject: [PATCH 0843/1293] Define node_byteorder and node_release_urlbase --- common.gypi | 2 ++ 1 file changed, 2 insertions(+) diff --git a/common.gypi b/common.gypi index 84c2b6c9826a..0735d99dd910 100644 --- a/common.gypi +++ b/common.gypi @@ -12,6 +12,8 @@ 'python': 'python', 'openssl_fips': '', 'openssl_no_asm': 1, + 'node_release_urlbase': 'https://atom.io/download/atom-shell', + 'node_byteorder': ' Date: Tue, 11 Aug 2015 10:08:34 +0800 Subject: [PATCH 0844/1293] Fix compilation warnings caused by chrome44 update --- atom/app/node_main.cc | 3 ++- vendor/brightray | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/atom/app/node_main.cc b/atom/app/node_main.cc index fe4f3fcbfa17..8823e583107c 100644 --- a/atom/app/node_main.cc +++ b/atom/app/node_main.cc @@ -5,11 +5,12 @@ #include "atom/app/node_main.h" #include "atom/browser/javascript_environment.h" -#include "atom/common/node_includes.h" #include "gin/array_buffer.h" #include "gin/public/isolate_holder.h" #include "gin/v8_initializer.h" +#include "atom/common/node_includes.h" + namespace atom { int NodeMain(int argc, char *argv[]) { diff --git a/vendor/brightray b/vendor/brightray index 3f4895f3fd7c..618311bc7053 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit 3f4895f3fd7cb2ec415b259c2808005512dec57f +Subproject commit 618311bc70531ae51b7e2daf65d9c6fc01bf0582 From cc34bc844d11562b6c5404d836ed9a4aaedece6f Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 11 Aug 2015 10:10:07 +0800 Subject: [PATCH 0845/1293] Tell compiler we want to ignore result of SetPrototype --- atom/browser/api/event_emitter.cc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/atom/browser/api/event_emitter.cc b/atom/browser/api/event_emitter.cc index aa0b6c8781a3..be7018dafa44 100644 --- a/atom/browser/api/event_emitter.cc +++ b/atom/browser/api/event_emitter.cc @@ -56,7 +56,7 @@ v8::Local EventEmitter::CreateJSEvent( v8::Local EventEmitter::CreateCustomEvent( v8::Isolate* isolate, v8::Local custom_event) { v8::Local event = CreateEventObject(isolate); - event->SetPrototype(custom_event->CreationContext(), custom_event); + (void)event->SetPrototype(custom_event->CreationContext(), custom_event); mate::Dictionary(isolate, event).Set("sender", GetWrapper(isolate)); return event; } From e43c63ae088bd63947c8ac49b6b70f44aa129c68 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 11 Aug 2015 10:25:27 +0800 Subject: [PATCH 0846/1293] Update chrome_version.h --- atom/common/chrome_version.h | 2 +- vendor/brightray | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/atom/common/chrome_version.h b/atom/common/chrome_version.h index 093ed4e98b05..54dd6bb5bb12 100644 --- a/atom/common/chrome_version.h +++ b/atom/common/chrome_version.h @@ -8,7 +8,7 @@ #ifndef ATOM_COMMON_CHROME_VERSION_H_ #define ATOM_COMMON_CHROME_VERSION_H_ -#define CHROME_VERSION_STRING "43.0.2357.65" +#define CHROME_VERSION_STRING "44.0.2403.125" #define CHROME_VERSION "v" CHROME_VERSION_STRING #endif // ATOM_COMMON_CHROME_VERSION_H_ diff --git a/vendor/brightray b/vendor/brightray index 618311bc7053..57d15371252d 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit 618311bc70531ae51b7e2daf65d9c6fc01bf0582 +Subproject commit 57d15371252d85a667316534a6da34f3df654380 From bc0619540950deeb09c10590f37d56e2c2a1069d Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 11 Aug 2015 10:40:02 +0800 Subject: [PATCH 0847/1293] Link with a few more static libraries on Linux and OS X --- script/lib/config.py | 2 +- vendor/brightray | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/script/lib/config.py b/script/lib/config.py index c30e5544075d..2c6d1a3b29c2 100644 --- a/script/lib/config.py +++ b/script/lib/config.py @@ -8,7 +8,7 @@ import sys BASE_URL = os.getenv('LIBCHROMIUMCONTENT_MIRROR') or \ 'http://github-janky-artifacts.s3.amazonaws.com/libchromiumcontent' -LIBCHROMIUMCONTENT_COMMIT = '86d7fcb507e76a917840c31c37b32e501e16a1d4' +LIBCHROMIUMCONTENT_COMMIT = '01345b4ef5f2a766e6f58dbbe7729fb089b357ba' PLATFORM = { 'cygwin': 'win32', diff --git a/vendor/brightray b/vendor/brightray index 57d15371252d..46b093d51475 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit 57d15371252d85a667316534a6da34f3df654380 +Subproject commit 46b093d514750aee66092ec64defe7bd8e1bc74d From 2dc533c4b9370e488f87d37c56737064ad2701a5 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 11 Aug 2015 10:55:27 +0800 Subject: [PATCH 0848/1293] Fix search path of ffmpeg It is somehow set to @load_path by Chromium. --- atom.gyp | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/atom.gyp b/atom.gyp index 99ae12452ac6..cabb43d4f70a 100644 --- a/atom.gyp +++ b/atom.gyp @@ -459,6 +459,16 @@ '${BUILT_PRODUCTS_DIR}/<(product_name) Framework.framework/Versions/A/<(product_name) Framework', ], }, + { + 'postbuild_name': 'Fix path of ffmpeg', + 'action': [ + 'install_name_tool', + '-change', + '@loader_path/libffmpeg.dylib', + '@rpath/libffmpeg.dylib', + '${BUILT_PRODUCTS_DIR}/<(product_name) Framework.framework/Versions/A/<(product_name) Framework', + ], + }, { 'postbuild_name': 'Add symlinks for framework subdirectories', 'action': [ From 0f990d40ccc9eb47df66c518bb166a95e5e6b5e3 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 11 Aug 2015 12:31:41 +0800 Subject: [PATCH 0849/1293] Use blink's allocator in Node's Buffer --- atom/renderer/atom_renderer_client.cc | 15 +++++++++++++++ script/lib/config.py | 2 +- vendor/node | 2 +- 3 files changed, 17 insertions(+), 2 deletions(-) diff --git a/atom/renderer/atom_renderer_client.cc b/atom/renderer/atom_renderer_client.cc index 0311f8b540b0..af526df9f75e 100644 --- a/atom/renderer/atom_renderer_client.cc +++ b/atom/renderer/atom_renderer_client.cc @@ -24,6 +24,7 @@ #include "third_party/WebKit/public/web/WebPluginParams.h" #include "third_party/WebKit/public/web/WebKit.h" #include "third_party/WebKit/public/web/WebRuntimeFeatures.h" +#include "third_party/WebKit/Source/wtf/ArrayBufferContents.h" #include "atom/common/node_includes.h" @@ -52,6 +53,17 @@ bool IsGuestFrame(blink::WebFrame* frame) { return frame->uniqueName().utf8() == "ATOM_SHELL_GUEST_WEB_VIEW"; } +void* BlinkAllocate(size_t size) { + void* ptr = nullptr; + WTF::ArrayBufferContents::allocateMemory( + size, WTF::ArrayBufferContents::DontInitialize, ptr); + return ptr; +} + +void BlinkFree(void* ptr, size_t size) { + WTF::ArrayBufferContents::freeMemory(ptr, size); +} + // Helper class to forward the messages to the client. class AtomRenderFrameObserver : public content::RenderFrameObserver { public: @@ -91,6 +103,9 @@ void AtomRendererClient::WebKitInitialized() { blink::WebCustomElement::addEmbedderCustomElementName("webview"); blink::WebCustomElement::addEmbedderCustomElementName("browserplugin"); + // Override Node's Buffer allocator with WTF's allocator. + node::Buffer::SetAllocator(&BlinkAllocate, &BlinkFree); + node_bindings_->Initialize(); node_bindings_->PrepareMessageLoop(); diff --git a/script/lib/config.py b/script/lib/config.py index 2c6d1a3b29c2..7132b9d63bf5 100644 --- a/script/lib/config.py +++ b/script/lib/config.py @@ -8,7 +8,7 @@ import sys BASE_URL = os.getenv('LIBCHROMIUMCONTENT_MIRROR') or \ 'http://github-janky-artifacts.s3.amazonaws.com/libchromiumcontent' -LIBCHROMIUMCONTENT_COMMIT = '01345b4ef5f2a766e6f58dbbe7729fb089b357ba' +LIBCHROMIUMCONTENT_COMMIT = '21768a17f4f1203a50df5c0908b788fa2ecb96ab' PLATFORM = { 'cygwin': 'win32', diff --git a/vendor/node b/vendor/node index 02d6e45de63d..6472143e3643 160000 --- a/vendor/node +++ b/vendor/node @@ -1 +1 @@ -Subproject commit 02d6e45de63d4bbb133cc73ab3937e5115fb4ddd +Subproject commit 6472143e364343f73ee6a9e1b67902cc5c30f7ef From e6a2b0a479391a09a148e2fb7ceac0f4a742cc4f Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 11 Aug 2015 15:39:17 +0800 Subject: [PATCH 0850/1293] Fix finding the WebContents of a pending renderer process Apparently after Chrome 44 a renderer process can be started before the corresponding render view is created, though it can be patched but from the source code Chromium is enforcing this everywhere now, so fixing it on our side seems the only reliable solution. This fix is very similar to what we did, but instead of blindly setting swapped process, we now remember which process the pending process is going to replace, so we should not have those race conditions. --- atom/browser/atom_browser_client.cc | 37 +++++++++++++++++++++-------- atom/browser/atom_browser_client.h | 14 +++++++++-- 2 files changed, 39 insertions(+), 12 deletions(-) diff --git a/atom/browser/atom_browser_client.cc b/atom/browser/atom_browser_client.cc index 9a3ad00fa4cd..6b3419272293 100644 --- a/atom/browser/atom_browser_client.cc +++ b/atom/browser/atom_browser_client.cc @@ -20,6 +20,7 @@ #include "atom/common/options_switches.h" #include "base/command_line.h" #include "base/files/file_util.h" +#include "base/stl_util.h" #include "base/strings/string_util.h" #include "base/strings/string_number_conversions.h" #include "chrome/browser/printing/printing_message_filter.h" @@ -62,20 +63,14 @@ enum ProcessOwner { ProcessOwner GetProcessOwner(int process_id, NativeWindow** window, WebViewManager::WebViewInfo* info) { - content::RenderViewHost* rvh = content::RenderViewHost::FromID( - process_id, kDefaultRoutingID); - if (!rvh) - return OWNER_NONE; - auto web_contents = content::WebContents::FromRenderViewHost(rvh); + content::WebContents* web_contents = content::WebContents::FromRenderViewHost( + content::RenderViewHost::FromID(process_id, kDefaultRoutingID)); if (!web_contents) return OWNER_NONE; // First search for NativeWindow. - for (auto native_window : *WindowList::GetInstance()) - if (web_contents == native_window->web_contents()) { - *window = native_window; - return OWNER_NATIVE_WINDOW; - } + if ((*window = NativeWindow::FromWebContents(web_contents))) + return OWNER_NATIVE_WINDOW; // Then search for guest WebContents. if (WebViewManager::GetInfoForWebContents(web_contents, info)) @@ -189,6 +184,13 @@ void AtomBrowserClient::OverrideSiteInstanceForNavigation( return; *new_instance = content::SiteInstance::CreateForURL(browser_context, url); + + // Remember the original renderer process of the pending renderer process. + auto current_process = current_instance->GetProcess(); + auto pending_process = (*new_instance)->GetProcess(); + pending_processes_[pending_process->GetID()] = current_process->GetID(); + // Clear the entry in map when process ends. + current_process->AddObserver(this); } void AtomBrowserClient::AppendExtraCommandLineSwitches( @@ -212,6 +214,10 @@ void AtomBrowserClient::AppendExtraCommandLineSwitches( } #endif + // If the process is a pending process, we should use the old one. + if (ContainsKey(pending_processes_, process_id)) + process_id = pending_processes_[process_id]; + NativeWindow* window; WebViewManager::WebViewInfo info; ProcessOwner owner = GetProcessOwner(process_id, &window, &info); @@ -268,4 +274,15 @@ brightray::BrowserMainParts* AtomBrowserClient::OverrideCreateBrowserMainParts( return new AtomBrowserMainParts; } +void AtomBrowserClient::RenderProcessHostDestroyed( + content::RenderProcessHost* host) { + int process_id = host->GetID(); + for (const auto& entry : pending_processes_) { + if (entry.first == process_id || entry.second == process_id) { + pending_processes_.erase(entry.first); + break; + } + } +} + } // namespace atom diff --git a/atom/browser/atom_browser_client.h b/atom/browser/atom_browser_client.h index f403a519d2f0..a0217efede9f 100644 --- a/atom/browser/atom_browser_client.h +++ b/atom/browser/atom_browser_client.h @@ -5,10 +5,12 @@ #ifndef ATOM_BROWSER_ATOM_BROWSER_CLIENT_H_ #define ATOM_BROWSER_ATOM_BROWSER_CLIENT_H_ +#include #include #include #include "brightray/browser/browser_client.h" +#include "content/public/browser/render_process_host_observer.h" namespace content { class QuotaPermissionContext; @@ -21,7 +23,8 @@ class SSLCertRequestInfo; namespace atom { -class AtomBrowserClient : public brightray::BrowserClient { +class AtomBrowserClient : public brightray::BrowserClient, + public content::RenderProcessHostObserver { public: AtomBrowserClient(); virtual ~AtomBrowserClient(); @@ -54,10 +57,17 @@ class AtomBrowserClient : public brightray::BrowserClient { net::SSLCertRequestInfo* cert_request_info, scoped_ptr delegate) override; - private: + // brightray::BrowserClient: brightray::BrowserMainParts* OverrideCreateBrowserMainParts( const content::MainFunctionParams&) override; + // content::RenderProcessHostObserver: + void RenderProcessHostDestroyed(content::RenderProcessHost* host) override; + + private: + // pending_render_process => current_render_process. + std::map pending_processes_; + DISALLOW_COPY_AND_ASSIGN(AtomBrowserClient); }; From a8681b00729b13ed7a72f7575e25e01dda35af19 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 11 Aug 2015 15:59:16 +0800 Subject: [PATCH 0851/1293] Fix emitting did-attach event --- atom/browser/web_view_guest_delegate.cc | 1 + 1 file changed, 1 insertion(+) diff --git a/atom/browser/web_view_guest_delegate.cc b/atom/browser/web_view_guest_delegate.cc index efa21421c0d6..8e1810c4a39b 100644 --- a/atom/browser/web_view_guest_delegate.cc +++ b/atom/browser/web_view_guest_delegate.cc @@ -162,6 +162,7 @@ void WebViewGuestDelegate::WillAttach( const base::Closure& completion_callback) { embedder_web_contents_ = embedder_web_contents; is_full_page_plugin_ = is_full_page_plugin; + completion_callback.Run(); } void WebViewGuestDelegate::GuestSizeChangedDueToAutoSize( From 1e9eaba4233057c6517871c409cc68a98a34f183 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 11 Aug 2015 23:38:59 +0800 Subject: [PATCH 0852/1293] win: Fix compiler warning --- atom/browser/atom_browser_client.cc | 3 ++- script/lib/config.py | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/atom/browser/atom_browser_client.cc b/atom/browser/atom_browser_client.cc index 6b3419272293..f116af0a667a 100644 --- a/atom/browser/atom_browser_client.cc +++ b/atom/browser/atom_browser_client.cc @@ -69,7 +69,8 @@ ProcessOwner GetProcessOwner(int process_id, return OWNER_NONE; // First search for NativeWindow. - if ((*window = NativeWindow::FromWebContents(web_contents))) + *window = NativeWindow::FromWebContents(web_contents); + if (window) return OWNER_NATIVE_WINDOW; // Then search for guest WebContents. diff --git a/script/lib/config.py b/script/lib/config.py index 7132b9d63bf5..9a5979bdbaef 100644 --- a/script/lib/config.py +++ b/script/lib/config.py @@ -8,7 +8,7 @@ import sys BASE_URL = os.getenv('LIBCHROMIUMCONTENT_MIRROR') or \ 'http://github-janky-artifacts.s3.amazonaws.com/libchromiumcontent' -LIBCHROMIUMCONTENT_COMMIT = '21768a17f4f1203a50df5c0908b788fa2ecb96ab' +LIBCHROMIUMCONTENT_COMMIT = 'e667b7cc5a04bc8e64960d47079d99446a263e85' PLATFORM = { 'cygwin': 'win32', From 8f32f9f5cb20c19101a25c624b66f180dd214034 Mon Sep 17 00:00:00 2001 From: Kevin Sawicki Date: Tue, 11 Aug 2015 09:45:45 -0700 Subject: [PATCH 0853/1293] Open Code of Conduct -> Contributor Covenant --- CONTRIBUTING.md | 4 ++-- README.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c86a6d1c2d21..61a8e474099a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,8 +2,8 @@ :+1::tada: First off, thanks for taking the time to contribute! :tada::+1: -This project adheres to the [Open Code of Conduct][code-of-conduct]. By participating, you are expected to uphold this code. -[code-of-conduct]: http://todogroup.org/opencodeofconduct/#Electron/opensource@github.com +This project adheres to the [Contributor Covenant 1.2](http://contributor-covenant.org/version/1/2/0). +By participating, you are expected to uphold this code. Please report unacceptable behavior to atom@github.com. The following is a set of guidelines for contributing to Electron. These are just guidelines, not rules, use your best judgment and feel free to diff --git a/README.md b/README.md index 764a6abfe9c3..8b7d36046a76 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,8 @@ editor](https://github.com/atom/atom). Follow [@ElectronJS](https://twitter.com/electronjs) on Twitter for important announcements. -This project adheres to the [Open Code of Conduct][code-of-conduct]. By participating, you are expected to uphold this code. -[code-of-conduct]: http://todogroup.org/opencodeofconduct/#Electron/opensource@github.com +This project adheres to the [Contributor Covenant 1.2](http://contributor-covenant.org/version/1/2/0). +By participating, you are expected to uphold this code. Please report unacceptable behavior to atom@github.com. ## Downloads From 96d53d279ec79bcd86e53b7f1aeb840ca32774c5 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 12 Aug 2015 13:30:19 +0800 Subject: [PATCH 0854/1293] Initial implementation of new protocol API --- atom/browser/api/atom_api_protocol.cc | 361 +----------------- atom/browser/api/atom_api_protocol.h | 118 +++--- atom/browser/api/lib/protocol.coffee | 58 --- atom/browser/atom_browser_client.cc | 2 +- atom/browser/atom_browser_context.cc | 35 +- atom/browser/lib/chrome-extension.coffee | 14 +- atom/browser/net/adapter_request_job.cc | 148 ------- atom/browser/net/adapter_request_job.h | 88 ----- .../net/atom_url_request_job_factory.cc | 19 +- .../net/atom_url_request_job_factory.h | 11 +- atom/browser/net/js_asker.cc | 106 +++++ atom/browser/net/js_asker.h | 85 +++++ atom/browser/net/url_request_string_job.cc | 26 +- atom/browser/net/url_request_string_job.h | 11 +- filenames.gypi | 4 +- vendor/brightray | 2 +- 16 files changed, 345 insertions(+), 743 deletions(-) delete mode 100644 atom/browser/net/adapter_request_job.cc delete mode 100644 atom/browser/net/adapter_request_job.h create mode 100644 atom/browser/net/js_asker.cc create mode 100644 atom/browser/net/js_asker.h diff --git a/atom/browser/api/atom_api_protocol.cc b/atom/browser/api/atom_api_protocol.cc index d7d308b306ed..18a3ccca57e7 100644 --- a/atom/browser/api/atom_api_protocol.cc +++ b/atom/browser/api/atom_api_protocol.cc @@ -7,15 +7,9 @@ #include "atom/browser/atom_browser_client.h" #include "atom/browser/atom_browser_context.h" #include "atom/browser/atom_browser_main_parts.h" -#include "atom/browser/api/atom_api_session.h" -#include "atom/browser/net/adapter_request_job.h" -#include "atom/browser/net/atom_url_request_job_factory.h" +#include "atom/browser/net/url_request_string_job.h" #include "atom/common/native_mate_converters/callback.h" -#include "atom/common/native_mate_converters/file_path_converter.h" -#include "atom/common/native_mate_converters/gurl_converter.h" -#include "content/public/browser/browser_thread.h" #include "native_mate/dictionary.h" -#include "net/url_request/url_request_context.h" #include "atom/common/node_includes.h" @@ -41,230 +35,18 @@ namespace atom { namespace api { -namespace { - -typedef net::URLRequestJobFactory::ProtocolHandler ProtocolHandler; - -scoped_refptr BufferToRefCountedBytes( - v8::Local buf) { - scoped_refptr data(new base::RefCountedBytes); - auto start = reinterpret_cast(node::Buffer::Data(buf)); - data->data().assign(start, start + node::Buffer::Length(buf)); - return data; -} - -class CustomProtocolRequestJob : public AdapterRequestJob { - public: - CustomProtocolRequestJob(Protocol* registry, - ProtocolHandler* protocol_handler, - net::URLRequest* request, - net::NetworkDelegate* network_delegate) - : AdapterRequestJob(protocol_handler, request, network_delegate), - registry_(registry) { - } - - void GetJobTypeInUI(const Protocol::JsProtocolHandler& callback) { - DCHECK_CURRENTLY_ON(BrowserThread::UI); - - v8::Locker locker(registry_->isolate()); - v8::HandleScope handle_scope(registry_->isolate()); - - // Call the JS handler. - v8::Local result = callback.Run(request()); - - // Determine the type of the job we are going to create. - if (result->IsString()) { - std::string data = mate::V8ToString(result); - BrowserThread::PostTask(BrowserThread::IO, FROM_HERE, - base::Bind(&AdapterRequestJob::CreateStringJobAndStart, - GetWeakPtr(), "text/plain", "UTF-8", data)); - return; - } else if (result->IsObject()) { - v8::Local obj = result->ToObject(); - mate::Dictionary dict(registry_->isolate(), obj); - std::string name = mate::V8ToString(obj->GetConstructorName()); - if (name == "RequestStringJob") { - std::string mime_type, charset, data; - dict.Get("mimeType", &mime_type); - dict.Get("charset", &charset); - dict.Get("data", &data); - - BrowserThread::PostTask(BrowserThread::IO, FROM_HERE, - base::Bind(&AdapterRequestJob::CreateStringJobAndStart, - GetWeakPtr(), mime_type, charset, data)); - return; - } else if (name == "RequestBufferJob") { - std::string mime_type, encoding; - v8::Local buffer; - dict.Get("mimeType", &mime_type); - dict.Get("encoding", &encoding); - dict.Get("data", &buffer); - - BrowserThread::PostTask(BrowserThread::IO, FROM_HERE, - base::Bind(&AdapterRequestJob::CreateBufferJobAndStart, - GetWeakPtr(), mime_type, encoding, - BufferToRefCountedBytes(buffer))); - return; - } else if (name == "RequestFileJob") { - base::FilePath path; - dict.Get("path", &path); - - BrowserThread::PostTask(BrowserThread::IO, FROM_HERE, - base::Bind(&AdapterRequestJob::CreateFileJobAndStart, - GetWeakPtr(), path)); - return; - } else if (name == "RequestErrorJob") { - int error = net::ERR_NOT_IMPLEMENTED; - dict.Get("error", &error); - - BrowserThread::PostTask(BrowserThread::IO, FROM_HERE, - base::Bind(&AdapterRequestJob::CreateErrorJobAndStart, - GetWeakPtr(), error)); - return; - } else if (name == "RequestHttpJob") { - GURL url; - std::string method, referrer; - dict.Get("url", &url); - dict.Get("method", &method); - dict.Get("referrer", &referrer); - - v8::Local value; - mate::Handle session; - scoped_refptr request_context_getter; - // "session" null -> pass nullptr; - // "session" a Session object -> use passed session. - // "session" undefined -> use current session; - if (dict.Get("session", &session)) - request_context_getter = - session->browser_context()->GetRequestContext(); - else if (dict.Get("session", &value) && value->IsNull()) - request_context_getter = nullptr; - else - request_context_getter = registry_->request_context_getter(); - - BrowserThread::PostTask(BrowserThread::IO, FROM_HERE, - base::Bind(&AdapterRequestJob::CreateHttpJobAndStart, GetWeakPtr(), - request_context_getter, url, method, referrer)); - return; - } - } - - // Try the default protocol handler if we have. - if (default_protocol_handler()) { - BrowserThread::PostTask(BrowserThread::IO, FROM_HERE, - base::Bind(&AdapterRequestJob::CreateJobFromProtocolHandlerAndStart, - GetWeakPtr())); - return; - } - - // Fallback to the not implemented error. - BrowserThread::PostTask(BrowserThread::IO, FROM_HERE, - base::Bind(&AdapterRequestJob::CreateErrorJobAndStart, - GetWeakPtr(), net::ERR_NOT_IMPLEMENTED)); - } - - // AdapterRequestJob: - void GetJobType() override { - BrowserThread::PostTask(BrowserThread::UI, FROM_HERE, - base::Bind(&CustomProtocolRequestJob::GetJobTypeInUI, - base::Unretained(this), - registry_->GetProtocolHandler(request()->url().scheme()))); - } - - private: - Protocol* registry_; // Weak, the Protocol class is expected to live forever. -}; - -// Always return the same CustomProtocolRequestJob for all requests, because -// the content API needs the ProtocolHandler to return a job immediately, and -// getting the real job from the JS requires asynchronous calls, so we have -// to create an adapter job first. -// Users can also pass an extra ProtocolHandler as the fallback one when -// registered handler doesn't want to deal with the request. -class CustomProtocolHandler : public ProtocolHandler { - public: - CustomProtocolHandler(api::Protocol* registry, - ProtocolHandler* protocol_handler = NULL) - : registry_(registry), protocol_handler_(protocol_handler) { - } - - net::URLRequestJob* MaybeCreateJob( - net::URLRequest* request, - net::NetworkDelegate* network_delegate) const override { - return new CustomProtocolRequestJob(registry_, protocol_handler_.get(), - request, network_delegate); - } - - ProtocolHandler* ReleaseDefaultProtocolHandler() { - return protocol_handler_.release(); - } - - ProtocolHandler* original_handler() { return protocol_handler_.get(); } - - private: - Protocol* registry_; // Weak, the Protocol class is expected to live forever. - scoped_ptr protocol_handler_; - - DISALLOW_COPY_AND_ASSIGN(CustomProtocolHandler); -}; - -std::string ConvertErrorCode(int error_code) { - switch (error_code) { - case Protocol::ERR_SCHEME_REGISTERED: - return "The Scheme is already registered"; - case Protocol::ERR_SCHEME_UNREGISTERED: - return "The Scheme has not been registered"; - case Protocol::ERR_SCHEME_INTERCEPTED: - return "There is no protocol handler to intercept"; - case Protocol::ERR_SCHEME_UNINTERCEPTED: - return "The protocol is not intercepted"; - case Protocol::ERR_NO_SCHEME: - return "The Scheme does not exist."; - case Protocol::ERR_SCHEME: - return "Cannot intercept custom protocols"; - default: - NOTREACHED(); - return std::string(); - } -} - -} // namespace - Protocol::Protocol(AtomBrowserContext* browser_context) : request_context_getter_(browser_context->GetRequestContext()), job_factory_(browser_context->job_factory()) { CHECK(job_factory_); } -Protocol::JsProtocolHandler Protocol::GetProtocolHandler( - const std::string& scheme) { - return protocol_handlers_[scheme]; -} - -void Protocol::OnIOActionCompleted(const JsCompletionCallback& callback, - int error) { - DCHECK_CURRENTLY_ON(BrowserThread::UI); - v8::Locker locker(isolate()); - v8::HandleScope handle_scope(isolate()); - - if (error) { - callback.Run(v8::Exception::Error( - mate::StringToV8(isolate(), ConvertErrorCode(error)))); - return; - } - - callback.Run(v8::Null(isolate())); -} - mate::ObjectTemplateBuilder Protocol::GetObjectTemplateBuilder( v8::Isolate* isolate) { return mate::ObjectTemplateBuilder(isolate) .SetMethod("registerStandardSchemes", &Protocol::RegisterStandardSchemes) - .SetMethod("isHandledProtocol", &Protocol::IsHandledProtocol) - .SetMethod("_registerProtocol", &Protocol::RegisterProtocol) - .SetMethod("_unregisterProtocol", &Protocol::UnregisterProtocol) - .SetMethod("_interceptProtocol", &Protocol::InterceptProtocol) - .SetMethod("_uninterceptProtocol", &Protocol::UninterceptProtocol); + .SetMethod("registerStringProtocol", + &Protocol::RegisterProtocol); } void Protocol::RegisterStandardSchemes( @@ -272,131 +54,28 @@ void Protocol::RegisterStandardSchemes( atom::AtomBrowserClient::SetCustomSchemes(schemes); } -void Protocol::IsHandledProtocol(const std::string& scheme, - const net::CompletionCallback& callback) { - BrowserThread::PostTaskAndReplyWithResult(BrowserThread::IO, FROM_HERE, - base::Bind(&AtomURLRequestJobFactory::IsHandledProtocol, - base::Unretained(job_factory_), scheme), - callback); -} +void Protocol::OnIOCompleted( + const CompletionCallback& callback, ProtocolError error) { + v8::Locker locker(isolate()); + v8::HandleScope handle_scope(isolate()); -void Protocol::RegisterProtocol(v8::Isolate* isolate, - const std::string& scheme, - const JsProtocolHandler& handler, - const JsCompletionCallback& callback) { - BrowserThread::PostTaskAndReplyWithResult(BrowserThread::IO, FROM_HERE, - base::Bind(&Protocol::RegisterProtocolInIO, - base::Unretained(this), scheme, handler), - base::Bind(&Protocol::OnIOActionCompleted, - base::Unretained(this), callback)); -} - -void Protocol::UnregisterProtocol(v8::Isolate* isolate, - const std::string& scheme, - const JsCompletionCallback& callback) { - BrowserThread::PostTaskAndReplyWithResult(BrowserThread::IO, FROM_HERE, - base::Bind(&Protocol::UnregisterProtocolInIO, - base::Unretained(this), scheme), - base::Bind(&Protocol::OnIOActionCompleted, - base::Unretained(this), callback)); -} - -void Protocol::InterceptProtocol(v8::Isolate* isolate, - const std::string& scheme, - const JsProtocolHandler& handler, - const JsCompletionCallback& callback) { - BrowserThread::PostTaskAndReplyWithResult(BrowserThread::IO, FROM_HERE, - base::Bind(&Protocol::InterceptProtocolInIO, - base::Unretained(this), scheme, handler), - base::Bind(&Protocol::OnIOActionCompleted, - base::Unretained(this), callback)); -} - -void Protocol::UninterceptProtocol(v8::Isolate* isolate, - const std::string& scheme, - const JsCompletionCallback& callback) { - BrowserThread::PostTaskAndReplyWithResult(BrowserThread::IO, FROM_HERE, - base::Bind(&Protocol::UninterceptProtocolInIO, - base::Unretained(this), scheme), - base::Bind(&Protocol::OnIOActionCompleted, - base::Unretained(this), callback)); -} - -int Protocol::RegisterProtocolInIO(const std::string& scheme, - const JsProtocolHandler& handler) { - DCHECK_CURRENTLY_ON(BrowserThread::IO); - - if (ContainsKey(protocol_handlers_, scheme) || - job_factory_->IsHandledProtocol(scheme)) { - return ERR_SCHEME_REGISTERED; + if (error == PROTOCOL_OK) { + callback.Run(v8::Null(isolate())); + } else { + std::string str = ErrorCodeToString(error); + callback.Run(v8::Exception::Error(mate::StringToV8(isolate(), str))); } - - protocol_handlers_[scheme] = handler; - job_factory_->SetProtocolHandler(scheme, new CustomProtocolHandler(this)); - - return OK; } -int Protocol::UnregisterProtocolInIO(const std::string& scheme) { - DCHECK_CURRENTLY_ON(BrowserThread::IO); - - ProtocolHandlersMap::iterator it(protocol_handlers_.find(scheme)); - if (it == protocol_handlers_.end()) { - return ERR_SCHEME_UNREGISTERED; +std::string Protocol::ErrorCodeToString(ProtocolError error) { + switch (error) { + case PROTOCOL_FAIL: return "Failed to manipulate protocol factory"; + case PROTOCOL_REGISTERED: return "The scheme has been registred"; + case PROTOCOL_NOT_REGISTERED: return "The scheme has not been registred"; + case PROTOCOL_INTERCEPTED: return "The scheme has been intercepted"; + case PROTOCOL_NOT_INTERCEPTED: return "The scheme has not been intercepted"; + default: return "Unexpected error"; } - - protocol_handlers_.erase(it); - job_factory_->SetProtocolHandler(scheme, NULL); - - return OK; -} - -int Protocol::InterceptProtocolInIO(const std::string& scheme, - const JsProtocolHandler& handler) { - DCHECK_CURRENTLY_ON(BrowserThread::IO); - - // Force the request context to initialize, otherwise we might have nothing - // to intercept. - request_context_getter_->GetURLRequestContext(); - - if (!job_factory_->HasProtocolHandler(scheme)) - return ERR_NO_SCHEME; - - if (ContainsKey(protocol_handlers_, scheme)) - return ERR_SCHEME; - - protocol_handlers_[scheme] = handler; - ProtocolHandler* original_handler = job_factory_->GetProtocolHandler(scheme); - if (original_handler == nullptr) { - return ERR_SCHEME_INTERCEPTED; - } - - job_factory_->ReplaceProtocol( - scheme, new CustomProtocolHandler(this, original_handler)); - - return OK; -} - -int Protocol::UninterceptProtocolInIO(const std::string& scheme) { - DCHECK_CURRENTLY_ON(BrowserThread::IO); - - ProtocolHandlersMap::iterator it(protocol_handlers_.find(scheme)); - if (it == protocol_handlers_.end()) - return ERR_SCHEME_UNREGISTERED; - - protocol_handlers_.erase(it); - CustomProtocolHandler* handler = static_cast( - job_factory_->GetProtocolHandler(scheme)); - if (handler->original_handler() == nullptr) { - return ERR_SCHEME_UNINTERCEPTED; - } - - // Reset the protocol handler to the orignal one and delete current protocol - // handler. - ProtocolHandler* original_handler = handler->ReleaseDefaultProtocolHandler(); - delete job_factory_->ReplaceProtocol(scheme, original_handler); - - return OK; } // static diff --git a/atom/browser/api/atom_api_protocol.h b/atom/browser/api/atom_api_protocol.h index 4dec17a74340..54dac9b13b9a 100644 --- a/atom/browser/api/atom_api_protocol.h +++ b/atom/browser/api/atom_api_protocol.h @@ -9,10 +9,11 @@ #include #include -#include "atom/browser/api/event_emitter.h" +#include "atom/browser/net/atom_url_request_job_factory.h" #include "base/callback.h" +#include "content/public/browser/browser_thread.h" #include "native_mate/handle.h" -#include "net/base/completion_callback.h" +#include "native_mate/wrappable.h" namespace net { class URLRequest; @@ -26,31 +27,15 @@ class AtomURLRequestJobFactory; namespace api { -class Protocol : public mate::EventEmitter { +class Protocol : public mate::Wrappable { public: - using JsProtocolHandler = - base::Callback(const net::URLRequest*)>; - using JsCompletionCallback = base::Callback)>; - - enum { - OK = 0, - ERR_SCHEME_REGISTERED, - ERR_SCHEME_UNREGISTERED, - ERR_SCHEME_INTERCEPTED, - ERR_SCHEME_UNINTERCEPTED, - ERR_NO_SCHEME, - ERR_SCHEME - }; + using Handler = + base::Callback)>; + using CompletionCallback = base::Callback)>; static mate::Handle Create( v8::Isolate* isolate, AtomBrowserContext* browser_context); - JsProtocolHandler GetProtocolHandler(const std::string& scheme); - - net::URLRequestContextGetter* request_context_getter() { - return request_context_getter_.get(); - } - protected: explicit Protocol(AtomBrowserContext* browser_context); @@ -59,48 +44,77 @@ class Protocol : public mate::EventEmitter { v8::Isolate* isolate); private: - typedef std::map ProtocolHandlersMap; + // Possible errors. + enum ProtocolError { + PROTOCOL_OK, // no error + PROTOCOL_FAIL, // operation failed, should never occur + PROTOCOL_REGISTERED, + PROTOCOL_NOT_REGISTERED, + PROTOCOL_INTERCEPTED, + PROTOCOL_NOT_INTERCEPTED, + }; - // Callback called after performing action on IO thread. - void OnIOActionCompleted(const JsCompletionCallback& callback, - int error); + // The protocol handler that will create a protocol handler for certain + // request job. + template + class CustomProtocolHandler + : public net::URLRequestJobFactory::ProtocolHandler { + public: + CustomProtocolHandler(v8::Isolate* isolate, const Handler& handler) + : isolate_(isolate), handler_(handler) {} + ~CustomProtocolHandler() override {} + + net::URLRequestJob* MaybeCreateJob( + net::URLRequest* request, + net::NetworkDelegate* network_delegate) const override { + return new RequestJob(request, network_delegate, isolate_, handler_); + } + + private: + v8::Isolate* isolate_; + Protocol::Handler handler_; + + DISALLOW_COPY_AND_ASSIGN(CustomProtocolHandler); + }; // Register schemes to standard scheme list. void RegisterStandardSchemes(const std::vector& schemes); - // Returns whether a scheme has been registered. - void IsHandledProtocol(const std::string& scheme, - const net::CompletionCallback& callback); - - // Register/unregister an networking |scheme| which would be handled by - // |callback|. + // Register the protocol with certain request job. + template void RegisterProtocol(v8::Isolate* isolate, const std::string& scheme, - const JsProtocolHandler& handler, - const JsCompletionCallback& callback); - void UnregisterProtocol(v8::Isolate* isolate, const std::string& scheme, - const JsCompletionCallback& callback); + const Handler& handler, + const CompletionCallback& callback) { + content::BrowserThread::PostTaskAndReplyWithResult( + content::BrowserThread::IO, FROM_HERE, + base::Bind(&Protocol::RegisterProtocolInIO, + base::Unretained(this), scheme, handler), + base::Bind(&Protocol::OnIOCompleted, + base::Unretained(this), callback)); + } + template + ProtocolError RegisterProtocolInIO(const std::string& scheme, + const Handler& handler) { + if (job_factory_->IsHandledProtocol(scheme)) + return PROTOCOL_REGISTERED; + scoped_ptr> protocol_handler( + new CustomProtocolHandler(isolate(), handler)); + if (job_factory_->SetProtocolHandler(scheme, protocol_handler.Pass())) + return PROTOCOL_OK; + else + return PROTOCOL_FAIL; + } - // Intercept/unintercept an existing protocol handler. - void InterceptProtocol(v8::Isolate* isolate, - const std::string& scheme, - const JsProtocolHandler& handler, - const JsCompletionCallback& callback); - void UninterceptProtocol(v8::Isolate* isolate, const std::string& scheme, - const JsCompletionCallback& callback); + // Convert error code to JS exception and call the callback. + void OnIOCompleted(const CompletionCallback& callback, ProtocolError error); - // The networking related operations have to be done in IO thread. - int RegisterProtocolInIO(const std::string& scheme, - const JsProtocolHandler& handler); - int UnregisterProtocolInIO(const std::string& scheme); - int InterceptProtocolInIO(const std::string& scheme, - const JsProtocolHandler& handler); - int UninterceptProtocolInIO(const std::string& scheme); + // Convert error code to string. + std::string ErrorCodeToString(ProtocolError error); scoped_refptr request_context_getter_; - AtomURLRequestJobFactory* job_factory_; - ProtocolHandlersMap protocol_handlers_; + AtomURLRequestJobFactory* job_factory_; // weak ref. DISALLOW_COPY_AND_ASSIGN(Protocol); }; diff --git a/atom/browser/api/lib/protocol.coffee b/atom/browser/api/lib/protocol.coffee index 4a661523509c..4a45c702507c 100644 --- a/atom/browser/api/lib/protocol.coffee +++ b/atom/browser/api/lib/protocol.coffee @@ -2,63 +2,5 @@ app = require 'app' throw new Error('Can not initialize protocol module before app is ready') unless app.isReady() protocol = process.atomBinding('protocol').protocol -EventEmitter = require('events').EventEmitter - -protocol.__proto__ = EventEmitter.prototype - -GetWrappedCallback = (scheme, callback, notification) -> - wrappedCallback = (error) -> - if not callback? - if error - throw error - else - protocol.emit notification, scheme - else - callback error, scheme - -# Compatibility with old api. -protocol.registerProtocol = (scheme, handler, callback) -> - protocol._registerProtocol scheme, handler, GetWrappedCallback(scheme, callback, 'registered') - -protocol.unregisterProtocol = (scheme, callback) -> - protocol._unregisterProtocol scheme, GetWrappedCallback(scheme, callback, 'unregistered') - -protocol.interceptProtocol = (scheme, handler, callback) -> - protocol._interceptProtocol scheme, handler, GetWrappedCallback(scheme, callback, 'intercepted') - -protocol.uninterceptProtocol = (scheme, callback) -> - protocol._uninterceptProtocol scheme, GetWrappedCallback(scheme, callback, 'unintercepted') - -protocol.RequestStringJob = -class RequestStringJob - constructor: ({mimeType, charset, data}) -> - if typeof data isnt 'string' and not data instanceof Buffer - throw new TypeError('Data should be string or Buffer') - - @mimeType = mimeType ? 'text/plain' - @charset = charset ? 'UTF-8' - @data = String data - -protocol.RequestBufferJob = -class RequestBufferJob - constructor: ({mimeType, encoding, data}) -> - if not data instanceof Buffer - throw new TypeError('Data should be Buffer') - - @mimeType = mimeType ? 'application/octet-stream' - @encoding = encoding ? 'utf8' - @data = new Buffer(data) - -protocol.RequestFileJob = -class RequestFileJob - constructor: (@path) -> - -protocol.RequestErrorJob = -class RequestErrorJob - constructor: (@error) -> - -protocol.RequestHttpJob = -class RequestHttpJob - constructor: ({@session, @url, @method, @referrer}) -> module.exports = protocol diff --git a/atom/browser/atom_browser_client.cc b/atom/browser/atom_browser_client.cc index f116af0a667a..8db71fd3030d 100644 --- a/atom/browser/atom_browser_client.cc +++ b/atom/browser/atom_browser_client.cc @@ -70,7 +70,7 @@ ProcessOwner GetProcessOwner(int process_id, // First search for NativeWindow. *window = NativeWindow::FromWebContents(web_contents); - if (window) + if (*window) return OWNER_NATIVE_WINDOW; // Then search for guest WebContents. diff --git a/atom/browser/atom_browser_context.cc b/atom/browser/atom_browser_context.cc index f04fbca747e6..583a6324a8f5 100644 --- a/atom/browser/atom_browser_context.cc +++ b/atom/browser/atom_browser_context.cc @@ -85,32 +85,37 @@ net::URLRequestJobFactory* AtomBrowserContext::CreateURLRequestJobFactory( content::URLRequestInterceptorScopedVector* interceptors) { scoped_ptr job_factory(job_factory_); - for (content::ProtocolHandlerMap::iterator it = handlers->begin(); - it != handlers->end(); ++it) - job_factory->SetProtocolHandler(it->first, it->second.release()); + for (auto& it : *handlers) { + job_factory->SetProtocolHandler(it.first, + make_scoped_ptr(it.second.release())); + } handlers->clear(); job_factory->SetProtocolHandler( - url::kDataScheme, new net::DataProtocolHandler); + url::kDataScheme, make_scoped_ptr(new net::DataProtocolHandler)); job_factory->SetProtocolHandler( - url::kFileScheme, new asar::AsarProtocolHandler( + url::kFileScheme, make_scoped_ptr(new asar::AsarProtocolHandler( BrowserThread::GetBlockingPool()->GetTaskRunnerWithShutdownBehavior( - base::SequencedWorkerPool::SKIP_ON_SHUTDOWN))); + base::SequencedWorkerPool::SKIP_ON_SHUTDOWN)))); job_factory->SetProtocolHandler( - url::kHttpScheme, new HttpProtocolHandler(url::kHttpScheme)); + url::kHttpScheme, + make_scoped_ptr(new HttpProtocolHandler(url::kHttpScheme))); job_factory->SetProtocolHandler( - url::kHttpsScheme, new HttpProtocolHandler(url::kHttpsScheme)); + url::kHttpsScheme, + make_scoped_ptr(new HttpProtocolHandler(url::kHttpsScheme))); job_factory->SetProtocolHandler( - url::kWsScheme, new HttpProtocolHandler(url::kWsScheme)); + url::kWsScheme, + make_scoped_ptr(new HttpProtocolHandler(url::kWsScheme))); job_factory->SetProtocolHandler( - url::kWssScheme, new HttpProtocolHandler(url::kWssScheme)); + url::kWssScheme, + make_scoped_ptr(new HttpProtocolHandler(url::kWssScheme))); - auto host_resolver = url_request_context_getter() - ->GetURLRequestContext() - ->host_resolver(); + auto host_resolver = + url_request_context_getter()->GetURLRequestContext()->host_resolver(); job_factory->SetProtocolHandler( - url::kFtpScheme, new net::FtpProtocolHandler( - new net::FtpNetworkLayer(host_resolver))); + url::kFtpScheme, + make_scoped_ptr(new net::FtpProtocolHandler( + new net::FtpNetworkLayer(host_resolver)))); // Set up interceptors in the reverse order. scoped_ptr top_job_factory = job_factory.Pass(); diff --git a/atom/browser/lib/chrome-extension.coffee b/atom/browser/lib/chrome-extension.coffee index 884a9e25d6eb..c29df5d96f66 100644 --- a/atom/browser/lib/chrome-extension.coffee +++ b/atom/browser/lib/chrome-extension.coffee @@ -64,14 +64,14 @@ app.once 'ready', -> catch e # The chrome-extension: can map a extension URL request to real file path. - protocol.registerProtocol 'chrome-extension', (request) -> - parsed = url.parse request.url - return unless parsed.hostname and parsed.path? - return unless /extension-\d+/.test parsed.hostname + # protocol.registerProtocol 'chrome-extension', (request) -> + # parsed = url.parse request.url + # return unless parsed.hostname and parsed.path? + # return unless /extension-\d+/.test parsed.hostname - directory = getPathForHost parsed.hostname - return unless directory? - return new protocol.RequestFileJob(path.join(directory, parsed.path)) + # directory = getPathForHost parsed.hostname + # return unless directory? + # return new protocol.RequestFileJob(path.join(directory, parsed.path)) BrowserWindow::_loadDevToolsExtensions = (extensionInfoArray) -> @devToolsWebContents?.executeJavaScript "DevToolsAPI.addExtensions(#{JSON.stringify(extensionInfoArray)});" diff --git a/atom/browser/net/adapter_request_job.cc b/atom/browser/net/adapter_request_job.cc deleted file mode 100644 index ca7dcf2e566b..000000000000 --- a/atom/browser/net/adapter_request_job.cc +++ /dev/null @@ -1,148 +0,0 @@ -// Copyright (c) 2013 GitHub, Inc. -// Use of this source code is governed by the MIT license that can be -// found in the LICENSE file. - -#include "atom/browser/net/adapter_request_job.h" - -#include "base/threading/sequenced_worker_pool.h" -#include "atom/browser/net/url_request_buffer_job.h" -#include "atom/browser/net/url_request_fetch_job.h" -#include "atom/browser/net/url_request_string_job.h" -#include "atom/browser/net/asar/url_request_asar_job.h" -#include "atom/common/asar/asar_util.h" -#include "content/public/browser/browser_thread.h" -#include "net/base/net_errors.h" -#include "net/url_request/url_request_error_job.h" -#include "net/url_request/url_request_file_job.h" - -namespace atom { - -AdapterRequestJob::AdapterRequestJob(ProtocolHandler* protocol_handler, - net::URLRequest* request, - net::NetworkDelegate* network_delegate) - : URLRequestJob(request, network_delegate), - protocol_handler_(protocol_handler), - weak_factory_(this) { -} - -void AdapterRequestJob::Start() { - DCHECK(!real_job_.get()); - GetJobType(); -} - -void AdapterRequestJob::Kill() { - if (real_job_.get()) // Kill could happen when real_job_ is created. - real_job_->Kill(); -} - -bool AdapterRequestJob::ReadRawData(net::IOBuffer* buf, - int buf_size, - int *bytes_read) { - DCHECK(!real_job_.get()); - // Read post-filtered data if available. - if (real_job_->HasFilter()) - return real_job_->Read(buf, buf_size, bytes_read); - else - return real_job_->ReadRawData(buf, buf_size, bytes_read); -} - -bool AdapterRequestJob::IsRedirectResponse(GURL* location, - int* http_status_code) { - DCHECK(!real_job_.get()); - return real_job_->IsRedirectResponse(location, http_status_code); -} - -net::Filter* AdapterRequestJob::SetupFilter() const { - DCHECK(!real_job_.get()); - return real_job_->SetupFilter(); -} - -bool AdapterRequestJob::GetMimeType(std::string* mime_type) const { - DCHECK(!real_job_.get()); - return real_job_->GetMimeType(mime_type); -} - -bool AdapterRequestJob::GetCharset(std::string* charset) { - DCHECK(!real_job_.get()); - return real_job_->GetCharset(charset); -} - -void AdapterRequestJob::GetResponseInfo(net::HttpResponseInfo* info) { - real_job_->GetResponseInfo(info); -} - -int AdapterRequestJob::GetResponseCode() const { - return real_job_->GetResponseCode(); -} - -void AdapterRequestJob::GetLoadTimingInfo( - net::LoadTimingInfo* load_timing_info) const { - real_job_->GetLoadTimingInfo(load_timing_info); -} - -base::WeakPtr AdapterRequestJob::GetWeakPtr() { - return weak_factory_.GetWeakPtr(); -} - -void AdapterRequestJob::CreateErrorJobAndStart(int error_code) { - real_job_ = new net::URLRequestErrorJob( - request(), network_delegate(), error_code); - real_job_->Start(); -} - -void AdapterRequestJob::CreateStringJobAndStart(const std::string& mime_type, - const std::string& charset, - const std::string& data) { - real_job_ = new URLRequestStringJob( - request(), network_delegate(), mime_type, charset, data); - real_job_->Start(); -} - -void AdapterRequestJob::CreateBufferJobAndStart( - const std::string& mime_type, - const std::string& charset, - scoped_refptr data) { - real_job_ = new URLRequestBufferJob( - request(), network_delegate(), mime_type, charset, data); - real_job_->Start(); -} - -void AdapterRequestJob::CreateFileJobAndStart(const base::FilePath& path) { - real_job_ = asar::CreateJobFromPath( - path, - request(), - network_delegate(), - content::BrowserThread::GetBlockingPool()-> - GetTaskRunnerWithShutdownBehavior( - base::SequencedWorkerPool::SKIP_ON_SHUTDOWN)); - real_job_->Start(); -} - -void AdapterRequestJob::CreateHttpJobAndStart( - scoped_refptr request_context_getter, - const GURL& url, - const std::string& method, - const std::string& referrer) { - if (!url.is_valid()) { - CreateErrorJobAndStart(net::ERR_INVALID_URL); - return; - } - - real_job_ = new URLRequestFetchJob(request_context_getter, request(), - network_delegate(), url, method, referrer); - real_job_->Start(); -} - -void AdapterRequestJob::CreateJobFromProtocolHandlerAndStart() { - real_job_ = protocol_handler_->MaybeCreateJob(request(), - network_delegate()); - if (!real_job_.get()) { - CreateErrorJobAndStart(net::ERR_NOT_IMPLEMENTED); - } else { - // Copy headers from original request. - real_job_->SetExtraRequestHeaders(request()->extra_request_headers()); - real_job_->Start(); - } -} - -} // namespace atom diff --git a/atom/browser/net/adapter_request_job.h b/atom/browser/net/adapter_request_job.h deleted file mode 100644 index afb9d5f55d07..000000000000 --- a/atom/browser/net/adapter_request_job.h +++ /dev/null @@ -1,88 +0,0 @@ -// Copyright (c) 2013 GitHub, Inc. -// Use of this source code is governed by the MIT license that can be -// found in the LICENSE file. - -#ifndef ATOM_BROWSER_NET_ADAPTER_REQUEST_JOB_H_ -#define ATOM_BROWSER_NET_ADAPTER_REQUEST_JOB_H_ - -#include - -#include "base/memory/ref_counted_memory.h" -#include "base/memory/weak_ptr.h" -#include "net/url_request/url_request_context.h" -#include "net/url_request/url_request_context_getter.h" -#include "net/url_request/url_request_job.h" -#include "net/url_request/url_request_job_factory.h" -#include "v8/include/v8.h" - -namespace base { -class FilePath; -} - -namespace atom { - -class AtomBrowserContext; - -// Ask JS which type of job it wants, and then delegate corresponding methods. -class AdapterRequestJob : public net::URLRequestJob { - public: - typedef net::URLRequestJobFactory::ProtocolHandler ProtocolHandler; - - AdapterRequestJob(ProtocolHandler* protocol_handler, - net::URLRequest* request, - net::NetworkDelegate* network_delegate); - - public: - // net::URLRequestJob: - void Start() override; - void Kill() override; - bool ReadRawData(net::IOBuffer* buf, - int buf_size, - int *bytes_read) override; - bool IsRedirectResponse(GURL* location, - int* http_status_code) override; - net::Filter* SetupFilter() const override; - bool GetMimeType(std::string* mime_type) const override; - bool GetCharset(std::string* charset) override; - void GetResponseInfo(net::HttpResponseInfo* info) override; - int GetResponseCode() const override; - void GetLoadTimingInfo( - net::LoadTimingInfo* load_timing_info) const override; - - base::WeakPtr GetWeakPtr(); - - ProtocolHandler* default_protocol_handler() { return protocol_handler_; } - - // Override this function to determine which job should be started. - virtual void GetJobType() = 0; - - void CreateErrorJobAndStart(int error_code); - void CreateStringJobAndStart(const std::string& mime_type, - const std::string& charset, - const std::string& data); - void CreateBufferJobAndStart(const std::string& mime_type, - const std::string& charset, - scoped_refptr data); - void CreateFileJobAndStart(const base::FilePath& path); - void CreateHttpJobAndStart( - scoped_refptr request_context_getter, - const GURL& url, - const std::string& method, - const std::string& referrer); - void CreateJobFromProtocolHandlerAndStart(); - - private: - // The delegated request job. - scoped_refptr real_job_; - - // Default protocol handler. - ProtocolHandler* protocol_handler_; - - base::WeakPtrFactory weak_factory_; - - DISALLOW_COPY_AND_ASSIGN(AdapterRequestJob); -}; - -} // namespace atom - -#endif // ATOM_BROWSER_NET_ADAPTER_REQUEST_JOB_H_ diff --git a/atom/browser/net/atom_url_request_job_factory.cc b/atom/browser/net/atom_url_request_job_factory.cc index 00942b2ad057..dbd8b4160cfd 100644 --- a/atom/browser/net/atom_url_request_job_factory.cc +++ b/atom/browser/net/atom_url_request_job_factory.cc @@ -23,10 +23,7 @@ AtomURLRequestJobFactory::~AtomURLRequestJobFactory() { } bool AtomURLRequestJobFactory::SetProtocolHandler( - const std::string& scheme, - ProtocolHandler* protocol_handler) { - DCHECK_CURRENTLY_ON(BrowserThread::IO); - + const std::string& scheme, scoped_ptr protocol_handler) { if (!protocol_handler) { ProtocolHandlerMap::iterator it = protocol_handler_map_.find(scheme); if (it == protocol_handler_map_.end()) @@ -39,21 +36,17 @@ bool AtomURLRequestJobFactory::SetProtocolHandler( if (ContainsKey(protocol_handler_map_, scheme)) return false; - protocol_handler_map_[scheme] = protocol_handler; + protocol_handler_map_[scheme] = protocol_handler.release(); return true; } -ProtocolHandler* AtomURLRequestJobFactory::ReplaceProtocol( - const std::string& scheme, - ProtocolHandler* protocol_handler) { - DCHECK_CURRENTLY_ON(BrowserThread::IO); - DCHECK(protocol_handler); - +scoped_ptr AtomURLRequestJobFactory::ReplaceProtocol( + const std::string& scheme, scoped_ptr protocol_handler) { if (!ContainsKey(protocol_handler_map_, scheme)) return nullptr; ProtocolHandler* original_protocol_handler = protocol_handler_map_[scheme]; - protocol_handler_map_[scheme] = protocol_handler; - return original_protocol_handler; + protocol_handler_map_[scheme] = protocol_handler.release(); + return make_scoped_ptr(original_protocol_handler); } ProtocolHandler* AtomURLRequestJobFactory::GetProtocolHandler( diff --git a/atom/browser/net/atom_url_request_job_factory.h b/atom/browser/net/atom_url_request_job_factory.h index ce2a18a85e66..dde36225b7af 100644 --- a/atom/browser/net/atom_url_request_job_factory.h +++ b/atom/browser/net/atom_url_request_job_factory.h @@ -10,8 +10,7 @@ #include #include -#include "base/basictypes.h" -#include "base/compiler_specific.h" +#include "base/memory/scoped_ptr.h" #include "base/synchronization/lock.h" #include "net/url_request/url_request_job_factory.h" @@ -25,13 +24,13 @@ class AtomURLRequestJobFactory : public net::URLRequestJobFactory { // Sets the ProtocolHandler for a scheme. Returns true on success, false on // failure (a ProtocolHandler already exists for |scheme|). On success, // URLRequestJobFactory takes ownership of |protocol_handler|. - bool SetProtocolHandler(const std::string& scheme, - ProtocolHandler* protocol_handler); + bool SetProtocolHandler( + const std::string& scheme, scoped_ptr protocol_handler); // Intercepts the ProtocolHandler for a scheme. Returns the original protocol // handler on success, otherwise returns NULL. - ProtocolHandler* ReplaceProtocol(const std::string& scheme, - ProtocolHandler* protocol_handler); + scoped_ptr ReplaceProtocol( + const std::string& scheme, scoped_ptr protocol_handler); // Returns the protocol handler registered with scheme. ProtocolHandler* GetProtocolHandler(const std::string& scheme) const; diff --git a/atom/browser/net/js_asker.cc b/atom/browser/net/js_asker.cc new file mode 100644 index 000000000000..a24e91021792 --- /dev/null +++ b/atom/browser/net/js_asker.cc @@ -0,0 +1,106 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#include "atom/browser/net/js_asker.h" + +#include "atom/common/native_mate_converters/callback.h" +#include "atom/common/native_mate_converters/v8_value_converter.h" +#include "native_mate/function_template.h" + +namespace atom { + +namespace internal { + +namespace { + +struct CallbackHolder { + ResponseCallback callback; +}; + +// Cached JavaScript version of |HandlerCallback|. +v8::Persistent g_handler_callback_; + +// Cached C++ version of |Function.prototype.bind|. +base::Callback( + v8::Local, v8::Local, v8::Local)> g_bind; + +// The callback which is passed to |handler|. +void HandlerCallback(v8::Local external, mate::Arguments* args) { + scoped_ptr holder( + static_cast(external->Value())); + CHECK(holder); + v8::Local value; + if (!args->GetNext(&value)) { + holder->callback.Run(false, nullptr); + return; + } + + V8ValueConverter converter; + v8::Local context = args->isolate()->GetCurrentContext(); + scoped_ptr options(converter.FromV8Value(value, context)); + holder->callback.Run(true, options.Pass()); +} + +// func.bind(...). +template +v8::Local BindFunctionWith(v8::Isolate* isolate, + v8::Local context, + v8::Local func, + ArgTypes... args) { + v8::MaybeLocal bind = func->Get(mate::StringToV8(isolate, "bind")); + CHECK(!bind.IsEmpty()); + v8::Local bind_func = + v8::Local::Cast(bind.ToLocalChecked()); + std::vector> converted = { + func, mate::ConvertToV8(isolate, args)..., + }; + return bind_func->Call( + context, func, converted.size(), &converted.front()).ToLocalChecked(); +} + +// Generate the callback that will be passed to |handler|. +v8::MaybeLocal GenerateCallback(v8::Isolate* isolate, + v8::Local context, + const ResponseCallback& callback) { + // The FunctionTemplate is cached. + if (g_handler_callback_.IsEmpty()) + g_handler_callback_.Reset( + isolate, + mate::CreateFunctionTemplate(isolate, base::Bind(&HandlerCallback))); + + v8::Local handler_callback = + v8::Local::New(isolate, g_handler_callback_); + CallbackHolder* holder = new CallbackHolder; + holder->callback = callback; + return BindFunctionWith(isolate, context, + handler_callback->GetFunction(), + v8::External::New(isolate, holder)); +} + +} // namespace + +void AskForOptions(v8::Isolate* isolate, + const JavaScriptHandler& handler, + net::URLRequest* request, + const ResponseCallback& callback) { + DCHECK_CURRENTLY_ON(content::BrowserThread::UI); + v8::Locker locker(isolate); + v8::HandleScope handle_scope(isolate); + v8::Local context = isolate->GetCurrentContext(); + v8::Context::Scope context_scope(context); + // We don't convert the callback to C++ directly because creating + // FunctionTemplate will cause memory leak since V8 never releases it. So we + // have to create the function object in JavaScript to work around it. + v8::MaybeLocal wrapped_callback = GenerateCallback( + isolate, context, callback); + if (wrapped_callback.IsEmpty()) { + callback.Run(false, nullptr); + return; + } + handler.Run(request, wrapped_callback.ToLocalChecked()); +} + +} // namespace internal + +} // namespace atom diff --git a/atom/browser/net/js_asker.h b/atom/browser/net/js_asker.h new file mode 100644 index 000000000000..a1bf972f63f9 --- /dev/null +++ b/atom/browser/net/js_asker.h @@ -0,0 +1,85 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#ifndef ATOM_BROWSER_NET_JS_ASKER_H_ +#define ATOM_BROWSER_NET_JS_ASKER_H_ + +#include "base/callback.h" +#include "base/memory/weak_ptr.h" +#include "base/values.h" +#include "content/public/browser/browser_thread.h" +#include "net/base/net_errors.h" +#include "net/url_request/url_request_job.h" +#include "v8/include/v8.h" + +namespace atom { + +using JavaScriptHandler = + base::Callback)>; + +namespace internal { + +using ResponseCallback = + base::Callback options)>; + +// Ask handler for options in UI thread. +void AskForOptions(v8::Isolate* isolate, + const JavaScriptHandler& handler, + net::URLRequest* request, + const ResponseCallback& callback); + +} // namespace internal + +template +class JsAsker : public RequestJob { + public: + JsAsker(net::URLRequest* request, + net::NetworkDelegate* network_delegate, + v8::Isolate* isolate, + const JavaScriptHandler& handler) + : RequestJob(request, network_delegate), + isolate_(isolate), + handler_(handler), + weak_factory_(this) {} + + // Subclass should do initailze work here. + virtual void StartAsync(scoped_ptr options) { + RequestJob::Start(); + } + + private: + // RequestJob: + void Start() override { + content::BrowserThread::PostTask( + content::BrowserThread::UI, FROM_HERE, + base::Bind(&internal::AskForOptions, + isolate_, + handler_, + RequestJob::request(), + base::Bind(&JsAsker::OnResponse, + weak_factory_.GetWeakPtr()))); + } + + // Called when the JS handler has sent the response, we need to decide whether + // to start, or fail the job. + void OnResponse(bool success, scoped_ptr options) { + if (success) { + StartAsync(options.Pass()); + } else { + RequestJob::NotifyStartError( + net::URLRequestStatus(net::URLRequestStatus::FAILED, + net::ERR_NOT_IMPLEMENTED)); + } + } + + v8::Isolate* isolate_; + JavaScriptHandler handler_; + base::WeakPtrFactory weak_factory_; + + DISALLOW_COPY_AND_ASSIGN(JsAsker); +}; + +} // namespace atom + +#endif // ATOM_BROWSER_NET_JS_ASKER_H_ diff --git a/atom/browser/net/url_request_string_job.cc b/atom/browser/net/url_request_string_job.cc index d0f205789a81..1afa95e5128c 100644 --- a/atom/browser/net/url_request_string_job.cc +++ b/atom/browser/net/url_request_string_job.cc @@ -12,13 +12,25 @@ namespace atom { URLRequestStringJob::URLRequestStringJob(net::URLRequest* request, net::NetworkDelegate* network_delegate, - const std::string& mime_type, - const std::string& charset, - const std::string& data) - : net::URLRequestSimpleJob(request, network_delegate), - mime_type_(mime_type), - charset_(charset), - data_(data) { + v8::Isolate* isolate, + const JavaScriptHandler& handler) + : JsAsker(request, network_delegate, isolate, + handler) { +} + +void URLRequestStringJob::StartAsync(scoped_ptr options) { + if (options) { + if (options->IsType(base::Value::TYPE_DICTIONARY)) { + base::DictionaryValue* dict = + static_cast(options.get()); + dict->GetString("mimeType", &mime_type_); + dict->GetString("charset", &charset_); + dict->GetString("data", &data_); + } else if (options->IsType(base::Value::TYPE_STRING)) { + options->GetAsString(&data_); + } + } + net::URLRequestSimpleJob::Start(); } int URLRequestStringJob::GetData( diff --git a/atom/browser/net/url_request_string_job.h b/atom/browser/net/url_request_string_job.h index 7ad250466aba..7a2e23acab05 100644 --- a/atom/browser/net/url_request_string_job.h +++ b/atom/browser/net/url_request_string_job.h @@ -5,19 +5,22 @@ #ifndef ATOM_BROWSER_NET_URL_REQUEST_STRING_JOB_H_ #define ATOM_BROWSER_NET_URL_REQUEST_STRING_JOB_H_ +#include "atom/browser/net/js_asker.h" #include "net/url_request/url_request_simple_job.h" #include namespace atom { -class URLRequestStringJob : public net::URLRequestSimpleJob { +class URLRequestStringJob : public JsAsker { public: URLRequestStringJob(net::URLRequest* request, net::NetworkDelegate* network_delegate, - const std::string& mime_type, - const std::string& charset, - const std::string& data); + v8::Isolate* isolate, + const JavaScriptHandler& handler); + + // JsAsker: + void StartAsync(scoped_ptr options) override; // URLRequestSimpleJob: int GetData(std::string* mime_type, diff --git a/filenames.gypi b/filenames.gypi index 40af1ebb1fe7..2dc110ef8594 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -146,8 +146,6 @@ 'atom/browser/native_window_mac.h', 'atom/browser/native_window_mac.mm', 'atom/browser/native_window_observer.h', - 'atom/browser/net/adapter_request_job.cc', - 'atom/browser/net/adapter_request_job.h', 'atom/browser/net/asar/asar_protocol_handler.cc', 'atom/browser/net/asar/asar_protocol_handler.h', 'atom/browser/net/asar/url_request_asar_job.cc', @@ -156,6 +154,8 @@ 'atom/browser/net/atom_url_request_job_factory.h', 'atom/browser/net/http_protocol_handler.cc', 'atom/browser/net/http_protocol_handler.h', + 'atom/browser/net/js_asker.cc', + 'atom/browser/net/js_asker.h', 'atom/browser/net/url_request_string_job.cc', 'atom/browser/net/url_request_string_job.h', 'atom/browser/net/url_request_buffer_job.cc', diff --git a/vendor/brightray b/vendor/brightray index 46b093d51475..cb8f80f473a5 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit 46b093d514750aee66092ec64defe7bd8e1bc74d +Subproject commit cb8f80f473a54fe1de72d478fd7809cf0c01fdb2 From ee51e37db7e1a0739d6bb2be463b4458b637e3c9 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 12 Aug 2015 13:43:27 +0800 Subject: [PATCH 0855/1293] Guard against callback being called twice --- atom/browser/net/js_asker.cc | 25 +++++++++++++++------- atom/browser/net/js_asker.h | 2 +- atom/browser/net/url_request_string_job.cc | 18 +++++++--------- 3 files changed, 26 insertions(+), 19 deletions(-) diff --git a/atom/browser/net/js_asker.cc b/atom/browser/net/js_asker.cc index a24e91021792..96c6736150e5 100644 --- a/atom/browser/net/js_asker.cc +++ b/atom/browser/net/js_asker.cc @@ -21,14 +21,21 @@ struct CallbackHolder { // Cached JavaScript version of |HandlerCallback|. v8::Persistent g_handler_callback_; -// Cached C++ version of |Function.prototype.bind|. -base::Callback( - v8::Local, v8::Local, v8::Local)> g_bind; - // The callback which is passed to |handler|. -void HandlerCallback(v8::Local external, mate::Arguments* args) { +void HandlerCallback(v8::Isolate* isolate, + v8::Local external, + v8::Local state, + mate::Arguments* args) { + // Check if the callback has already been called. + v8::Local called_symbol = mate::StringToSymbol(isolate, "called"); + if (state->Has(called_symbol)) + return; // no nothing + else + state->Set(called_symbol, v8::Boolean::New(isolate, true)); + + // If there is no argument passed then we failed. scoped_ptr holder( - static_cast(external->Value())); + static_cast(external->Value())); CHECK(holder); v8::Local value; if (!args->GetNext(&value)) { @@ -36,13 +43,14 @@ void HandlerCallback(v8::Local external, mate::Arguments* args) { return; } + // Pass whatever user passed to the actaul request job. V8ValueConverter converter; v8::Local context = args->isolate()->GetCurrentContext(); scoped_ptr options(converter.FromV8Value(value, context)); holder->callback.Run(true, options.Pass()); } -// func.bind(...). +// func.bind(func, ...). template v8::Local BindFunctionWith(v8::Isolate* isolate, v8::Local context, @@ -75,7 +83,8 @@ v8::MaybeLocal GenerateCallback(v8::Isolate* isolate, holder->callback = callback; return BindFunctionWith(isolate, context, handler_callback->GetFunction(), - v8::External::New(isolate, holder)); + v8::External::New(isolate, holder), + v8::Object::New(isolate)); } } // namespace diff --git a/atom/browser/net/js_asker.h b/atom/browser/net/js_asker.h index a1bf972f63f9..97b384e213f7 100644 --- a/atom/browser/net/js_asker.h +++ b/atom/browser/net/js_asker.h @@ -64,7 +64,7 @@ class JsAsker : public RequestJob { // Called when the JS handler has sent the response, we need to decide whether // to start, or fail the job. void OnResponse(bool success, scoped_ptr options) { - if (success) { + if (success && options) { StartAsync(options.Pass()); } else { RequestJob::NotifyStartError( diff --git a/atom/browser/net/url_request_string_job.cc b/atom/browser/net/url_request_string_job.cc index 1afa95e5128c..eec8176d734a 100644 --- a/atom/browser/net/url_request_string_job.cc +++ b/atom/browser/net/url_request_string_job.cc @@ -19,16 +19,14 @@ URLRequestStringJob::URLRequestStringJob(net::URLRequest* request, } void URLRequestStringJob::StartAsync(scoped_ptr options) { - if (options) { - if (options->IsType(base::Value::TYPE_DICTIONARY)) { - base::DictionaryValue* dict = - static_cast(options.get()); - dict->GetString("mimeType", &mime_type_); - dict->GetString("charset", &charset_); - dict->GetString("data", &data_); - } else if (options->IsType(base::Value::TYPE_STRING)) { - options->GetAsString(&data_); - } + if (options->IsType(base::Value::TYPE_DICTIONARY)) { + base::DictionaryValue* dict = + static_cast(options.get()); + dict->GetString("mimeType", &mime_type_); + dict->GetString("charset", &charset_); + dict->GetString("data", &data_); + } else if (options->IsType(base::Value::TYPE_STRING)) { + options->GetAsString(&data_); } net::URLRequestSimpleJob::Start(); } From 337460cdc278afbb2753680cf49b8442892db4bf Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 12 Aug 2015 13:50:31 +0800 Subject: [PATCH 0856/1293] Enable return error for arbitray request job --- atom/browser/net/js_asker.cc | 12 ++++++++++++ atom/browser/net/js_asker.h | 13 ++++++++----- 2 files changed, 20 insertions(+), 5 deletions(-) diff --git a/atom/browser/net/js_asker.cc b/atom/browser/net/js_asker.cc index 96c6736150e5..b53799b06fdd 100644 --- a/atom/browser/net/js_asker.cc +++ b/atom/browser/net/js_asker.cc @@ -110,6 +110,18 @@ void AskForOptions(v8::Isolate* isolate, handler.Run(request, wrapped_callback.ToLocalChecked()); } +bool IsErrorOptions(base::Value* value, int* error) { + if (value->IsType(base::Value::TYPE_DICTIONARY)) { + base::DictionaryValue* dict = static_cast(value); + if (dict->GetInteger("error", error)) + return true; + } else if (value->IsType(base::Value::TYPE_INTEGER)) { + if (value->GetAsInteger(error)) + return true; + } + return false; +} + } // namespace internal } // namespace atom diff --git a/atom/browser/net/js_asker.h b/atom/browser/net/js_asker.h index 97b384e213f7..0f5f05856cd3 100644 --- a/atom/browser/net/js_asker.h +++ b/atom/browser/net/js_asker.h @@ -29,6 +29,9 @@ void AskForOptions(v8::Isolate* isolate, net::URLRequest* request, const ResponseCallback& callback); +// Test whether the |options| means an error. +bool IsErrorOptions(base::Value* value, int* error); + } // namespace internal template @@ -63,13 +66,13 @@ class JsAsker : public RequestJob { // Called when the JS handler has sent the response, we need to decide whether // to start, or fail the job. - void OnResponse(bool success, scoped_ptr options) { - if (success && options) { - StartAsync(options.Pass()); + void OnResponse(bool success, scoped_ptr value) { + int error = net::ERR_NOT_IMPLEMENTED; + if (success && value && !internal::IsErrorOptions(value.get(), &error)) { + StartAsync(value.Pass()); } else { RequestJob::NotifyStartError( - net::URLRequestStatus(net::URLRequestStatus::FAILED, - net::ERR_NOT_IMPLEMENTED)); + net::URLRequestStatus(net::URLRequestStatus::FAILED, error)); } } From d2681d2ba1b18c719fa606d19d77a16f1cd80577 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 12 Aug 2015 15:18:31 +0800 Subject: [PATCH 0857/1293] Implement protocol.registerFileProtocol --- atom/browser/api/atom_api_protocol.cc | 5 +- atom/browser/lib/chrome-extension.coffee | 16 +- .../browser/net/asar/asar_protocol_handler.cc | 39 +-- atom/browser/net/asar/url_request_asar_job.cc | 271 +++++++++++++++--- atom/browser/net/asar/url_request_asar_job.h | 68 ++++- .../browser/net/url_request_async_asar_job.cc | 40 +++ atom/browser/net/url_request_async_asar_job.h | 30 ++ filenames.gypi | 2 + 8 files changed, 383 insertions(+), 88 deletions(-) create mode 100644 atom/browser/net/url_request_async_asar_job.cc create mode 100644 atom/browser/net/url_request_async_asar_job.h diff --git a/atom/browser/api/atom_api_protocol.cc b/atom/browser/api/atom_api_protocol.cc index 18a3ccca57e7..0bd6728b4cf7 100644 --- a/atom/browser/api/atom_api_protocol.cc +++ b/atom/browser/api/atom_api_protocol.cc @@ -8,6 +8,7 @@ #include "atom/browser/atom_browser_context.h" #include "atom/browser/atom_browser_main_parts.h" #include "atom/browser/net/url_request_string_job.h" +#include "atom/browser/net/url_request_async_asar_job.h" #include "atom/common/native_mate_converters/callback.h" #include "native_mate/dictionary.h" @@ -46,7 +47,9 @@ mate::ObjectTemplateBuilder Protocol::GetObjectTemplateBuilder( return mate::ObjectTemplateBuilder(isolate) .SetMethod("registerStandardSchemes", &Protocol::RegisterStandardSchemes) .SetMethod("registerStringProtocol", - &Protocol::RegisterProtocol); + &Protocol::RegisterProtocol) + .SetMethod("registerFileProtocol", + &Protocol::RegisterProtocol); } void Protocol::RegisterStandardSchemes( diff --git a/atom/browser/lib/chrome-extension.coffee b/atom/browser/lib/chrome-extension.coffee index c29df5d96f66..ccb52d37a4b4 100644 --- a/atom/browser/lib/chrome-extension.coffee +++ b/atom/browser/lib/chrome-extension.coffee @@ -64,14 +64,16 @@ app.once 'ready', -> catch e # The chrome-extension: can map a extension URL request to real file path. - # protocol.registerProtocol 'chrome-extension', (request) -> - # parsed = url.parse request.url - # return unless parsed.hostname and parsed.path? - # return unless /extension-\d+/.test parsed.hostname + chromeExtensionHandler = (request, callback) -> + parsed = url.parse request.url + return callback() unless parsed.hostname and parsed.path? + return callback() unless /extension-\d+/.test parsed.hostname - # directory = getPathForHost parsed.hostname - # return unless directory? - # return new protocol.RequestFileJob(path.join(directory, parsed.path)) + directory = getPathForHost parsed.hostname + return callback() unless directory? + callback path.join(directory, parsed.path) + protocol.registerFileProtocol 'chrome-extension', chromeExtensionHandler, -> + console.error 'Unable to register chrome-extension protocol' BrowserWindow::_loadDevToolsExtensions = (extensionInfoArray) -> @devToolsWebContents?.executeJavaScript "DevToolsAPI.addExtensions(#{JSON.stringify(extensionInfoArray)});" diff --git a/atom/browser/net/asar/asar_protocol_handler.cc b/atom/browser/net/asar/asar_protocol_handler.cc index 6d2a2cd5bf0a..324f8339c8c9 100644 --- a/atom/browser/net/asar/asar_protocol_handler.cc +++ b/atom/browser/net/asar/asar_protocol_handler.cc @@ -5,45 +5,11 @@ #include "atom/browser/net/asar/asar_protocol_handler.h" #include "atom/browser/net/asar/url_request_asar_job.h" -#include "atom/common/asar/archive.h" -#include "atom/common/asar/asar_util.h" #include "net/base/filename_util.h" #include "net/base/net_errors.h" -#include "net/url_request/url_request_error_job.h" -#include "net/url_request/url_request_file_job.h" namespace asar { -// static -net::URLRequestJob* CreateJobFromPath( - const base::FilePath& full_path, - net::URLRequest* request, - net::NetworkDelegate* network_delegate, - const scoped_refptr file_task_runner) { - // Create asar:// job when the path contains "xxx.asar/", otherwise treat the - // URL request as file://. - base::FilePath asar_path, relative_path; - if (!GetAsarArchivePath(full_path, &asar_path, &relative_path)) - return new net::URLRequestFileJob(request, network_delegate, full_path, - file_task_runner); - - std::shared_ptr archive = GetOrCreateAsarArchive(asar_path); - Archive::FileInfo file_info; - if (!archive || !archive->GetFileInfo(relative_path, &file_info)) - return new net::URLRequestErrorJob(request, network_delegate, - net::ERR_FILE_NOT_FOUND); - - if (file_info.unpacked) { - base::FilePath real_path; - archive->CopyFileOut(relative_path, &real_path); - return new net::URLRequestFileJob(request, network_delegate, real_path, - file_task_runner); - } - - return new URLRequestAsarJob(request, network_delegate, archive, - relative_path, file_info, file_task_runner); -} - AsarProtocolHandler::AsarProtocolHandler( const scoped_refptr& file_task_runner) : file_task_runner_(file_task_runner) {} @@ -56,8 +22,9 @@ net::URLRequestJob* AsarProtocolHandler::MaybeCreateJob( net::NetworkDelegate* network_delegate) const { base::FilePath full_path; net::FileURLToFilePath(request->url(), &full_path); - return CreateJobFromPath(full_path, request, network_delegate, - file_task_runner_); + URLRequestAsarJob* job = new URLRequestAsarJob(request, network_delegate); + job->Initialize(file_task_runner_, full_path); + return job; } bool AsarProtocolHandler::IsSafeRedirectTarget(const GURL& location) const { diff --git a/atom/browser/net/asar/url_request_asar_job.cc b/atom/browser/net/asar/url_request_asar_job.cc index 477c6610b1b1..33cb04c9ede8 100644 --- a/atom/browser/net/asar/url_request_asar_job.cc +++ b/atom/browser/net/asar/url_request_asar_job.cc @@ -6,47 +6,126 @@ #include +#include "base/bind.h" +#include "base/files/file_util.h" +#include "base/strings/string_util.h" +#include "base/synchronization/lock.h" +#include "base/task_runner.h" +#include "atom/common/asar/archive.h" +#include "atom/common/asar/asar_util.h" #include "net/base/file_stream.h" +#include "net/base/filename_util.h" #include "net/base/io_buffer.h" +#include "net/base/load_flags.h" #include "net/base/mime_util.h" #include "net/base/net_errors.h" +#include "net/filter/filter.h" +#include "net/http/http_util.h" #include "net/url_request/url_request_status.h" +#if defined(OS_WIN) +#include "base/win/shortcut.h" +#endif + namespace asar { +URLRequestAsarJob::FileMetaInfo::FileMetaInfo() + : file_size(0), + mime_type_result(false), + file_exists(false), + is_directory(false) { +} + URLRequestAsarJob::URLRequestAsarJob( net::URLRequest* request, - net::NetworkDelegate* network_delegate, - std::shared_ptr archive, - const base::FilePath& file_path, - const Archive::FileInfo& file_info, - const scoped_refptr& file_task_runner) + net::NetworkDelegate* network_delegate) : net::URLRequestJob(request, network_delegate), - archive_(archive), - file_path_(file_path), - file_info_(file_info), - stream_(new net::FileStream(file_task_runner)), + type_(TYPE_ERROR), remaining_bytes_(0), - file_task_runner_(file_task_runner), weak_ptr_factory_(this) {} URLRequestAsarJob::~URLRequestAsarJob() {} -void URLRequestAsarJob::Start() { - remaining_bytes_ = static_cast(file_info_.size); +void URLRequestAsarJob::Initialize( + const scoped_refptr file_task_runner, + const base::FilePath& file_path) { + // Determine whether it is an asar file. + base::FilePath asar_path, relative_path; + if (!GetAsarArchivePath(file_path, &asar_path, &relative_path)) { + InitializeFileJob(file_task_runner, file_path); + return; + } - int flags = base::File::FLAG_OPEN | - base::File::FLAG_READ | - base::File::FLAG_ASYNC; - int rv = stream_->Open(archive_->path(), flags, - base::Bind(&URLRequestAsarJob::DidOpen, - weak_ptr_factory_.GetWeakPtr())); - if (rv != net::ERR_IO_PENDING) - DidOpen(rv); + std::shared_ptr archive = GetOrCreateAsarArchive(asar_path); + Archive::FileInfo file_info; + if (!archive || !archive->GetFileInfo(relative_path, &file_info)) { + type_ = TYPE_ERROR; + return; + } + + if (file_info.unpacked) { + base::FilePath real_path; + archive->CopyFileOut(relative_path, &real_path); + InitializeFileJob(file_task_runner, real_path); + return; + } + + InitializeAsarJob(file_task_runner, archive, relative_path, file_info); +} + +void URLRequestAsarJob::InitializeAsarJob( + const scoped_refptr file_task_runner, + std::shared_ptr archive, + const base::FilePath& file_path, + const Archive::FileInfo& file_info) { + type_ = TYPE_ASAR; + file_task_runner_ = file_task_runner; + stream_.reset(new net::FileStream(file_task_runner_)); + archive_ = archive; + file_path_ = file_path; + file_info_ = file_info; +} + +void URLRequestAsarJob::InitializeFileJob( + const scoped_refptr file_task_runner, + const base::FilePath& file_path) { + type_ = TYPE_FILE; + file_task_runner_ = file_task_runner; + stream_.reset(new net::FileStream(file_task_runner_)); + file_path_ = file_path; +} + +void URLRequestAsarJob::Start() { + if (type_ == TYPE_ASAR) { + remaining_bytes_ = static_cast(file_info_.size); + + int flags = base::File::FLAG_OPEN | + base::File::FLAG_READ | + base::File::FLAG_ASYNC; + int rv = stream_->Open(archive_->path(), flags, + base::Bind(&URLRequestAsarJob::DidOpen, + weak_ptr_factory_.GetWeakPtr())); + if (rv != net::ERR_IO_PENDING) + DidOpen(rv); + } else if (type_ == TYPE_FILE) { + FileMetaInfo* meta_info = new FileMetaInfo(); + file_task_runner_->PostTaskAndReply( + FROM_HERE, + base::Bind(&URLRequestAsarJob::FetchMetaInfo, file_path_, + base::Unretained(meta_info)), + base::Bind(&URLRequestAsarJob::DidFetchMetaInfo, + weak_ptr_factory_.GetWeakPtr(), + base::Owned(meta_info))); + } else { + NotifyStartError(net::URLRequestStatus(net::URLRequestStatus::FAILED, + net::ERR_FILE_NOT_FOUND)); + } } void URLRequestAsarJob::Kill() { + stream_.reset(); weak_ptr_factory_.InvalidateWeakPtrs(); + URLRequestJob::Kill(); } @@ -85,8 +164,97 @@ bool URLRequestAsarJob::ReadRawData(net::IOBuffer* dest, return false; } +bool URLRequestAsarJob::IsRedirectResponse(GURL* location, + int* http_status_code) { + if (type_ != TYPE_FILE) + return false; +#if defined(OS_WIN) + // Follow a Windows shortcut. + // We just resolve .lnk file, ignore others. + if (!LowerCaseEqualsASCII(file_path_.Extension(), ".lnk")) + return false; + + base::FilePath new_path = file_path_; + bool resolved; + resolved = base::win::ResolveShortcut(new_path, &new_path, NULL); + + // If shortcut is not resolved succesfully, do not redirect. + if (!resolved) + return false; + + *location = net::FilePathToFileURL(new_path); + *http_status_code = 301; + return true; +#else + return false; +#endif +} + +net::Filter* URLRequestAsarJob::SetupFilter() const { + // Bug 9936 - .svgz files needs to be decompressed. + return LowerCaseEqualsASCII(file_path_.Extension(), ".svgz") + ? net::Filter::GZipFactory() : NULL; +} + bool URLRequestAsarJob::GetMimeType(std::string* mime_type) const { - return net::GetMimeTypeFromFile(file_path_, mime_type); + if (type_ == TYPE_ASAR) { + return net::GetMimeTypeFromFile(file_path_, mime_type); + } else { + if (meta_info_.mime_type_result) { + *mime_type = meta_info_.mime_type; + return true; + } + return false; + } +} + +void URLRequestAsarJob::SetExtraRequestHeaders( + const net::HttpRequestHeaders& headers) { + std::string range_header; + if (headers.GetHeader(net::HttpRequestHeaders::kRange, &range_header)) { + // We only care about "Range" header here. + std::vector ranges; + if (net::HttpUtil::ParseRangeHeader(range_header, &ranges)) { + if (ranges.size() == 1) { + byte_range_ = ranges[0]; + } else { + NotifyDone(net::URLRequestStatus( + net::URLRequestStatus::FAILED, + net::ERR_REQUEST_RANGE_NOT_SATISFIABLE)); + } + } + } +} + +void URLRequestAsarJob::FetchMetaInfo(const base::FilePath& file_path, + FileMetaInfo* meta_info) { + base::File::Info file_info; + meta_info->file_exists = base::GetFileInfo(file_path, &file_info); + if (meta_info->file_exists) { + meta_info->file_size = file_info.size; + meta_info->is_directory = file_info.is_directory; + } + // On Windows GetMimeTypeFromFile() goes to the registry. Thus it should be + // done in WorkerPool. + meta_info->mime_type_result = + net::GetMimeTypeFromFile(file_path, &meta_info->mime_type); +} + +void URLRequestAsarJob::DidFetchMetaInfo(const FileMetaInfo* meta_info) { + meta_info_ = *meta_info; + if (!meta_info_.file_exists || meta_info_.is_directory) { + DidOpen(net::ERR_FILE_NOT_FOUND); + return; + } + + int flags = base::File::FLAG_OPEN | + base::File::FLAG_READ | + base::File::FLAG_ASYNC; + int rv = stream_->Open(file_path_, flags, + base::Bind(&URLRequestAsarJob::DidOpen, + weak_ptr_factory_.GetWeakPtr())); + if (rv != net::ERR_IO_PENDING) + DidOpen(rv); } void URLRequestAsarJob::DidOpen(int result) { @@ -95,24 +263,59 @@ void URLRequestAsarJob::DidOpen(int result) { return; } - int rv = stream_->Seek(base::File::FROM_BEGIN, - file_info_.offset, - base::Bind(&URLRequestAsarJob::DidSeek, - weak_ptr_factory_.GetWeakPtr())); - if (rv != net::ERR_IO_PENDING) { - // stream_->Seek() failed, so pass an intentionally erroneous value - // into DidSeek(). - DidSeek(-1); + if (type_ == TYPE_ASAR) { + int rv = stream_->Seek(base::File::FROM_BEGIN, + file_info_.offset, + base::Bind(&URLRequestAsarJob::DidSeek, + weak_ptr_factory_.GetWeakPtr())); + if (rv != net::ERR_IO_PENDING) { + // stream_->Seek() failed, so pass an intentionally erroneous value + // into DidSeek(). + DidSeek(-1); + } + } else { + if (!byte_range_.ComputeBounds(meta_info_.file_size)) { + NotifyDone(net::URLRequestStatus(net::URLRequestStatus::FAILED, + net::ERR_REQUEST_RANGE_NOT_SATISFIABLE)); + return; + } + + remaining_bytes_ = byte_range_.last_byte_position() - + byte_range_.first_byte_position() + 1; + + if (remaining_bytes_ > 0 && byte_range_.first_byte_position() != 0) { + int rv = stream_->Seek(base::File::FROM_BEGIN, + byte_range_.first_byte_position(), + base::Bind(&URLRequestAsarJob::DidSeek, + weak_ptr_factory_.GetWeakPtr())); + if (rv != net::ERR_IO_PENDING) { + // stream_->Seek() failed, so pass an intentionally erroneous value + // into DidSeek(). + DidSeek(-1); + } + } else { + // We didn't need to call stream_->Seek() at all, so we pass to DidSeek() + // the value that would mean seek success. This way we skip the code + // handling seek failure. + DidSeek(byte_range_.first_byte_position()); + } } } void URLRequestAsarJob::DidSeek(int64 result) { - if (result != static_cast(file_info_.offset)) { - NotifyDone(net::URLRequestStatus(net::URLRequestStatus::FAILED, - net::ERR_REQUEST_RANGE_NOT_SATISFIABLE)); - return; + if (type_ == TYPE_ASAR) { + if (result != static_cast(file_info_.offset)) { + NotifyDone(net::URLRequestStatus(net::URLRequestStatus::FAILED, + net::ERR_REQUEST_RANGE_NOT_SATISFIABLE)); + return; + } + } else { + if (result != byte_range_.first_byte_position()) { + NotifyDone(net::URLRequestStatus(net::URLRequestStatus::FAILED, + net::ERR_REQUEST_RANGE_NOT_SATISFIABLE)); + return; + } } - set_expected_content_size(remaining_bytes_); NotifyHeadersComplete(); } diff --git a/atom/browser/net/asar/url_request_asar_job.h b/atom/browser/net/asar/url_request_asar_job.h index adcac85b37d7..15a723d79e89 100644 --- a/atom/browser/net/asar/url_request_asar_job.h +++ b/atom/browser/net/asar/url_request_asar_job.h @@ -8,10 +8,12 @@ #include #include +#include "atom/browser/net/js_asker.h" #include "atom/common/asar/archive.h" #include "base/files/file_path.h" #include "base/memory/ref_counted.h" #include "base/memory/weak_ptr.h" +#include "net/http/http_byte_range.h" #include "net/url_request/url_request_job.h" namespace base { @@ -34,11 +36,20 @@ net::URLRequestJob* CreateJobFromPath( class URLRequestAsarJob : public net::URLRequestJob { public: URLRequestAsarJob(net::URLRequest* request, - net::NetworkDelegate* network_delegate, - std::shared_ptr archive, - const base::FilePath& file_path, - const Archive::FileInfo& file_info, - const scoped_refptr& file_task_runner); + net::NetworkDelegate* network_delegate); + + void Initialize(const scoped_refptr file_task_runner, + const base::FilePath& file_path); + + protected: + virtual ~URLRequestAsarJob(); + + void InitializeAsarJob(const scoped_refptr file_task_runner, + std::shared_ptr archive, + const base::FilePath& file_path, + const Archive::FileInfo& file_info); + void InitializeFileJob(const scoped_refptr file_task_runner, + const base::FilePath& file_path); // net::URLRequestJob: void Start() override; @@ -46,12 +57,39 @@ class URLRequestAsarJob : public net::URLRequestJob { bool ReadRawData(net::IOBuffer* buf, int buf_size, int* bytes_read) override; + bool IsRedirectResponse(GURL* location, int* http_status_code) override; + net::Filter* SetupFilter() const override; bool GetMimeType(std::string* mime_type) const override; - - protected: - virtual ~URLRequestAsarJob(); + void SetExtraRequestHeaders(const net::HttpRequestHeaders& headers) override; private: + // Meta information about the file. It's used as a member in the + // URLRequestFileJob and also passed between threads because disk access is + // necessary to obtain it. + struct FileMetaInfo { + FileMetaInfo(); + + // Size of the file. + int64 file_size; + // Mime type associated with the file. + std::string mime_type; + // Result returned from GetMimeTypeFromFile(), i.e. flag showing whether + // obtaining of the mime type was successful. + bool mime_type_result; + // Flag showing whether the file exists. + bool file_exists; + // Flag showing whether the file name actually refers to a directory. + bool is_directory; + }; + + // Fetches file info on a background thread. + static void FetchMetaInfo(const base::FilePath& file_path, + FileMetaInfo* meta_info); + + // Callback after fetching file info on a background thread. + void DidFetchMetaInfo(const FileMetaInfo* meta_info); + + // Callback after opening file on a background thread. void DidOpen(int result); @@ -62,14 +100,24 @@ class URLRequestAsarJob : public net::URLRequestJob { // Callback after data is asynchronously read from the file into |buf|. void DidRead(scoped_refptr buf, int result); + // The type of this job. + enum JobType { + TYPE_ERROR, + TYPE_ASAR, + TYPE_FILE, + }; + JobType type_; + std::shared_ptr archive_; base::FilePath file_path_; Archive::FileInfo file_info_; scoped_ptr stream_; - int64 remaining_bytes_; + FileMetaInfo meta_info_; + scoped_refptr file_task_runner_; - const scoped_refptr file_task_runner_; + net::HttpByteRange byte_range_; + int64 remaining_bytes_; base::WeakPtrFactory weak_ptr_factory_; diff --git a/atom/browser/net/url_request_async_asar_job.cc b/atom/browser/net/url_request_async_asar_job.cc new file mode 100644 index 000000000000..eb6697b76f50 --- /dev/null +++ b/atom/browser/net/url_request_async_asar_job.cc @@ -0,0 +1,40 @@ +// Copyright (c) 2014 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#include "atom/browser/net/url_request_async_asar_job.h" + +namespace atom { + +UrlRequestAsyncAsarJob::UrlRequestAsyncAsarJob( + net::URLRequest* request, + net::NetworkDelegate* network_delegate, + v8::Isolate* isolate, + const JavaScriptHandler& handler) + : JsAsker(request, network_delegate, isolate, + handler) { +} + +void UrlRequestAsyncAsarJob::StartAsync(scoped_ptr options) { + base::FilePath::StringType file_path; + if (options->IsType(base::Value::TYPE_DICTIONARY)) { + static_cast(options.get())->GetString( + "path", &file_path); + } else if (options->IsType(base::Value::TYPE_STRING)) { + options->GetAsString(&file_path); + } + + if (file_path.empty()) { + NotifyStartError(net::URLRequestStatus( + net::URLRequestStatus::FAILED, net::ERR_NOT_IMPLEMENTED)); + } else { + asar::URLRequestAsarJob::Initialize( + content::BrowserThread::GetBlockingPool()-> + GetTaskRunnerWithShutdownBehavior( + base::SequencedWorkerPool::SKIP_ON_SHUTDOWN), + base::FilePath(file_path)); + asar::URLRequestAsarJob::Start(); + } +} + +} // namespace atom diff --git a/atom/browser/net/url_request_async_asar_job.h b/atom/browser/net/url_request_async_asar_job.h new file mode 100644 index 000000000000..0b9676e7f368 --- /dev/null +++ b/atom/browser/net/url_request_async_asar_job.h @@ -0,0 +1,30 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#ifndef ATOM_BROWSER_NET_URL_REQUEST_ASYNC_ASAR_JOB_H_ +#define ATOM_BROWSER_NET_URL_REQUEST_ASYNC_ASAR_JOB_H_ + +#include "atom/browser/net/asar/url_request_asar_job.h" +#include "atom/browser/net/js_asker.h" + +namespace atom { + +// Like URLRequestAsarJob, but asks the JavaScript handler for file path. +class UrlRequestAsyncAsarJob : public JsAsker { + public: + UrlRequestAsyncAsarJob(net::URLRequest* request, + net::NetworkDelegate* network_delegate, + v8::Isolate* isolate, + const JavaScriptHandler& handler); + + // JsAsker: + void StartAsync(scoped_ptr options) override; + + private: + DISALLOW_COPY_AND_ASSIGN(UrlRequestAsyncAsarJob); +}; + +} // namespace atom + +#endif // ATOM_BROWSER_NET_URL_REQUEST_ASYNC_ASAR_JOB_H_ diff --git a/filenames.gypi b/filenames.gypi index 2dc110ef8594..260c9a4c8a17 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -156,6 +156,8 @@ 'atom/browser/net/http_protocol_handler.h', 'atom/browser/net/js_asker.cc', 'atom/browser/net/js_asker.h', + 'atom/browser/net/url_request_async_asar_job.cc', + 'atom/browser/net/url_request_async_asar_job.h', 'atom/browser/net/url_request_string_job.cc', 'atom/browser/net/url_request_string_job.h', 'atom/browser/net/url_request_buffer_job.cc', From ebb1ddc0df116a17aec7fb5e50ab355db6fc7169 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 12 Aug 2015 15:39:33 +0800 Subject: [PATCH 0858/1293] Support converting Buffer to Value --- atom.gyp | 2 -- .../native_mate_converters/v8_value_converter.cc | 13 +++++++++++++ .../native_mate_converters/v8_value_converter.h | 4 +++- 3 files changed, 16 insertions(+), 3 deletions(-) diff --git a/atom.gyp b/atom.gyp index cabb43d4f70a..440eceee62d2 100644 --- a/atom.gyp +++ b/atom.gyp @@ -224,8 +224,6 @@ # Defined in Chromium but not exposed in its gyp file. 'V8_USE_EXTERNAL_STARTUP_DATA', 'ENABLE_PLUGINS', - # Needed by Node. - 'NODE_WANT_INTERNALS=1', ], 'sources': [ '<@(lib_sources)', diff --git a/atom/common/native_mate_converters/v8_value_converter.cc b/atom/common/native_mate_converters/v8_value_converter.cc index 0d5a25765470..2270f0e0fd3d 100644 --- a/atom/common/native_mate_converters/v8_value_converter.cc +++ b/atom/common/native_mate_converters/v8_value_converter.cc @@ -11,6 +11,7 @@ #include "base/logging.h" #include "base/memory/scoped_ptr.h" #include "base/values.h" +#include "vendor/node/src/node_buffer.h" namespace atom { @@ -258,6 +259,10 @@ base::Value* V8ValueConverter::FromV8ValueImpl( return FromV8Object(val->ToObject(), state, isolate); } + if (node::Buffer::HasInstance(val)) { + return FromNodeBuffer(val, state, isolate); + } + if (val->IsObject()) { return FromV8Object(val->ToObject(), state, isolate); } @@ -305,6 +310,14 @@ base::Value* V8ValueConverter::FromV8Array( return result; } +base::Value* V8ValueConverter::FromNodeBuffer( + v8::Local value, + FromV8ValueState* state, + v8::Isolate* isolate) const { + return base::BinaryValue::CreateWithCopiedBuffer( + node::Buffer::Data(value), node::Buffer::Length(value)); +} + base::Value* V8ValueConverter::FromV8Object( v8::Local val, FromV8ValueState* state, diff --git a/atom/common/native_mate_converters/v8_value_converter.h b/atom/common/native_mate_converters/v8_value_converter.h index 3a0f6374ccb4..db108ad9b043 100644 --- a/atom/common/native_mate_converters/v8_value_converter.h +++ b/atom/common/native_mate_converters/v8_value_converter.h @@ -48,7 +48,9 @@ class V8ValueConverter { base::Value* FromV8Array(v8::Local array, FromV8ValueState* state, v8::Isolate* isolate) const; - + base::Value* FromNodeBuffer(v8::Local value, + FromV8ValueState* state, + v8::Isolate* isolate) const; base::Value* FromV8Object(v8::Local object, FromV8ValueState* state, v8::Isolate* isolate) const; From 1f2d7d1cd8e54f2988f11ad38c6fe48426bbd575 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 12 Aug 2015 20:37:52 +0800 Subject: [PATCH 0859/1293] Implement protocol.registerBufferProtocol --- atom/browser/api/atom_api_protocol.cc | 5 ++- atom/browser/lib/chrome-extension.coffee | 4 +-- atom/browser/net/url_request_buffer_job.cc | 37 +++++++++++++++++----- atom/browser/net/url_request_buffer_job.h | 15 +++++---- 4 files changed, 44 insertions(+), 17 deletions(-) diff --git a/atom/browser/api/atom_api_protocol.cc b/atom/browser/api/atom_api_protocol.cc index 0bd6728b4cf7..366b6732d93d 100644 --- a/atom/browser/api/atom_api_protocol.cc +++ b/atom/browser/api/atom_api_protocol.cc @@ -7,8 +7,9 @@ #include "atom/browser/atom_browser_client.h" #include "atom/browser/atom_browser_context.h" #include "atom/browser/atom_browser_main_parts.h" -#include "atom/browser/net/url_request_string_job.h" #include "atom/browser/net/url_request_async_asar_job.h" +#include "atom/browser/net/url_request_buffer_job.h" +#include "atom/browser/net/url_request_string_job.h" #include "atom/common/native_mate_converters/callback.h" #include "native_mate/dictionary.h" @@ -48,6 +49,8 @@ mate::ObjectTemplateBuilder Protocol::GetObjectTemplateBuilder( .SetMethod("registerStandardSchemes", &Protocol::RegisterStandardSchemes) .SetMethod("registerStringProtocol", &Protocol::RegisterProtocol) + .SetMethod("registerBufferProtocol", + &Protocol::RegisterProtocol) .SetMethod("registerFileProtocol", &Protocol::RegisterProtocol); } diff --git a/atom/browser/lib/chrome-extension.coffee b/atom/browser/lib/chrome-extension.coffee index ccb52d37a4b4..df0d717cd9dd 100644 --- a/atom/browser/lib/chrome-extension.coffee +++ b/atom/browser/lib/chrome-extension.coffee @@ -72,8 +72,8 @@ app.once 'ready', -> directory = getPathForHost parsed.hostname return callback() unless directory? callback path.join(directory, parsed.path) - protocol.registerFileProtocol 'chrome-extension', chromeExtensionHandler, -> - console.error 'Unable to register chrome-extension protocol' + protocol.registerFileProtocol 'chrome-extension', chromeExtensionHandler, (error) -> + console.error 'Unable to register chrome-extension protocol' if error BrowserWindow::_loadDevToolsExtensions = (extensionInfoArray) -> @devToolsWebContents?.executeJavaScript "DevToolsAPI.addExtensions(#{JSON.stringify(extensionInfoArray)});" diff --git a/atom/browser/net/url_request_buffer_job.cc b/atom/browser/net/url_request_buffer_job.cc index a8233b88da46..5cfb60a750ef 100644 --- a/atom/browser/net/url_request_buffer_job.cc +++ b/atom/browser/net/url_request_buffer_job.cc @@ -13,13 +13,34 @@ namespace atom { URLRequestBufferJob::URLRequestBufferJob( net::URLRequest* request, net::NetworkDelegate* network_delegate, - const std::string& mime_type, - const std::string& charset, - scoped_refptr data) - : net::URLRequestSimpleJob(request, network_delegate), - mime_type_(mime_type), - charset_(charset), - buffer_data_(data) { + v8::Isolate* isolate, + const JavaScriptHandler& handler) + : JsAsker(request, network_delegate, isolate, + handler) { +} + +void URLRequestBufferJob::StartAsync(scoped_ptr options) { + const base::BinaryValue* binary = nullptr; + if (options->IsType(base::Value::TYPE_DICTIONARY)) { + base::DictionaryValue* dict = + static_cast(options.get()); + dict->GetString("mimeType", &mime_type_); + dict->GetString("charset", &charset_); + dict->GetBinary("data", &binary); + } else if (options->IsType(base::Value::TYPE_BINARY)) { + options->GetAsBinary(&binary); + } + + if (!binary) { + NotifyStartError(net::URLRequestStatus( + net::URLRequestStatus::FAILED, net::ERR_NOT_IMPLEMENTED)); + return; + } + + data_ = new base::RefCountedBytes( + reinterpret_cast(binary->GetBuffer()), + binary->GetSize()); + net::URLRequestSimpleJob::Start(); } int URLRequestBufferJob::GetRefCountedData( @@ -29,7 +50,7 @@ int URLRequestBufferJob::GetRefCountedData( const net::CompletionCallback& callback) const { *mime_type = mime_type_; *charset = charset_; - *data = buffer_data_; + *data = data_; return net::OK; } diff --git a/atom/browser/net/url_request_buffer_job.h b/atom/browser/net/url_request_buffer_job.h index cbdfbfa10d0b..c72e5b838506 100644 --- a/atom/browser/net/url_request_buffer_job.h +++ b/atom/browser/net/url_request_buffer_job.h @@ -7,19 +7,22 @@ #include +#include "atom/browser/net/js_asker.h" +#include "atom/common/node_includes.h" #include "base/memory/ref_counted_memory.h" #include "net/url_request/url_request_simple_job.h" -#include "atom/common/node_includes.h" namespace atom { -class URLRequestBufferJob : public net::URLRequestSimpleJob { +class URLRequestBufferJob : public JsAsker { public: URLRequestBufferJob(net::URLRequest* request, net::NetworkDelegate* network_delegate, - const std::string& mime_type, - const std::string& charset, - scoped_refptr data); + v8::Isolate* isolate, + const JavaScriptHandler& handler); + + // JsAsker: + void StartAsync(scoped_ptr options) override; // URLRequestSimpleJob: int GetRefCountedData(std::string* mime_type, @@ -30,7 +33,7 @@ class URLRequestBufferJob : public net::URLRequestSimpleJob { private: std::string mime_type_; std::string charset_; - scoped_refptr buffer_data_; + scoped_refptr data_; DISALLOW_COPY_AND_ASSIGN(URLRequestBufferJob); }; From f493eb34aedb5660990f03e5ebc6401ddad17bf0 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 12 Aug 2015 21:09:44 +0800 Subject: [PATCH 0860/1293] Implement protocol.registerHttpProtocol --- atom/browser/api/atom_api_protocol.cc | 5 ++- atom/browser/net/js_asker.cc | 4 +- atom/browser/net/js_asker.h | 4 +- atom/browser/net/url_request_buffer_job.h | 1 - atom/browser/net/url_request_fetch_job.cc | 55 +++++++++++++---------- atom/browser/net/url_request_fetch_job.h | 21 +++++---- 6 files changed, 52 insertions(+), 38 deletions(-) diff --git a/atom/browser/api/atom_api_protocol.cc b/atom/browser/api/atom_api_protocol.cc index 366b6732d93d..c0c2e5b512ca 100644 --- a/atom/browser/api/atom_api_protocol.cc +++ b/atom/browser/api/atom_api_protocol.cc @@ -9,6 +9,7 @@ #include "atom/browser/atom_browser_main_parts.h" #include "atom/browser/net/url_request_async_asar_job.h" #include "atom/browser/net/url_request_buffer_job.h" +#include "atom/browser/net/url_request_fetch_job.h" #include "atom/browser/net/url_request_string_job.h" #include "atom/common/native_mate_converters/callback.h" #include "native_mate/dictionary.h" @@ -52,7 +53,9 @@ mate::ObjectTemplateBuilder Protocol::GetObjectTemplateBuilder( .SetMethod("registerBufferProtocol", &Protocol::RegisterProtocol) .SetMethod("registerFileProtocol", - &Protocol::RegisterProtocol); + &Protocol::RegisterProtocol) + .SetMethod("registerHttpProtocol", + &Protocol::RegisterProtocol); } void Protocol::RegisterStandardSchemes( diff --git a/atom/browser/net/js_asker.cc b/atom/browser/net/js_asker.cc index b53799b06fdd..aa6192b057ac 100644 --- a/atom/browser/net/js_asker.cc +++ b/atom/browser/net/js_asker.cc @@ -47,7 +47,9 @@ void HandlerCallback(v8::Isolate* isolate, V8ValueConverter converter; v8::Local context = args->isolate()->GetCurrentContext(); scoped_ptr options(converter.FromV8Value(value, context)); - holder->callback.Run(true, options.Pass()); + content::BrowserThread::PostTask( + content::BrowserThread::IO, FROM_HERE, + base::Bind(holder->callback, true, base::Passed(&options))); } // func.bind(func, ...). diff --git a/atom/browser/net/js_asker.h b/atom/browser/net/js_asker.h index 0f5f05856cd3..4d7e888e15ab 100644 --- a/atom/browser/net/js_asker.h +++ b/atom/browser/net/js_asker.h @@ -47,9 +47,7 @@ class JsAsker : public RequestJob { weak_factory_(this) {} // Subclass should do initailze work here. - virtual void StartAsync(scoped_ptr options) { - RequestJob::Start(); - } + virtual void StartAsync(scoped_ptr options) = 0; private: // RequestJob: diff --git a/atom/browser/net/url_request_buffer_job.h b/atom/browser/net/url_request_buffer_job.h index c72e5b838506..de1a41234fef 100644 --- a/atom/browser/net/url_request_buffer_job.h +++ b/atom/browser/net/url_request_buffer_job.h @@ -8,7 +8,6 @@ #include #include "atom/browser/net/js_asker.h" -#include "atom/common/node_includes.h" #include "base/memory/ref_counted_memory.h" #include "net/url_request/url_request_simple_job.h" diff --git a/atom/browser/net/url_request_fetch_job.cc b/atom/browser/net/url_request_fetch_job.cc index 47ca0633c6ca..7e51c26ba2bb 100644 --- a/atom/browser/net/url_request_fetch_job.cc +++ b/atom/browser/net/url_request_fetch_job.cc @@ -75,42 +75,53 @@ class ResponsePiper : public net::URLFetcherResponseWriter { } // namespace URLRequestFetchJob::URLRequestFetchJob( - scoped_refptr request_context_getter, net::URLRequest* request, net::NetworkDelegate* network_delegate, - const GURL& url, - const std::string& method, - const std::string& referrer) - : net::URLRequestJob(request, network_delegate), + v8::Isolate* isolate, + const JavaScriptHandler& handler) + : JsAsker(request, network_delegate, isolate, handler), pending_buffer_size_(0) { +} + +void URLRequestFetchJob::StartAsync(scoped_ptr options) { + if (!options->IsType(base::Value::TYPE_DICTIONARY)) { + NotifyStartError(net::URLRequestStatus( + net::URLRequestStatus::FAILED, net::ERR_NOT_IMPLEMENTED)); + return; + } + + std::string url, method, referrer; + base::DictionaryValue* dict = + static_cast(options.get()); + dict->GetString("url", &url); + dict->GetString("method", &method); + dict->GetString("referrer", &referrer); + // Use |request|'s method if |method| is not specified. net::URLFetcher::RequestType request_type; if (method.empty()) - request_type = GetRequestType(request->method()); + request_type = GetRequestType(request()->method()); else request_type = GetRequestType(method); - fetcher_ = net::URLFetcher::Create(url, request_type, this); - // Use request context if provided else create one. - if (request_context_getter) - fetcher_->SetRequestContext(request_context_getter.get()); - else - fetcher_->SetRequestContext(GetRequestContext()); - + fetcher_ = net::URLFetcher::Create(GURL(url), request_type, this); + fetcher_->SetRequestContext(CreateRequestContext()); fetcher_->SaveResponseWithWriter(make_scoped_ptr(new ResponsePiper(this))); // Use |request|'s referrer if |referrer| is not specified. - if (referrer.empty()) { - fetcher_->SetReferrer(request->referrer()); - } else { + if (referrer.empty()) + fetcher_->SetReferrer(request()->referrer()); + else fetcher_->SetReferrer(referrer); - } // Use |request|'s headers. - fetcher_->SetExtraRequestHeaders(request->extra_request_headers().ToString()); + fetcher_->SetExtraRequestHeaders( + request()->extra_request_headers().ToString()); + + fetcher_->Start(); } -net::URLRequestContextGetter* URLRequestFetchJob::GetRequestContext() { +net::URLRequestContextGetter* URLRequestFetchJob::CreateRequestContext() { if (!url_request_context_getter_.get()) { auto task_runner = base::ThreadTaskRunnerHandle::Get(); net::URLRequestContextBuilder builder; @@ -150,12 +161,8 @@ int URLRequestFetchJob::DataAvailable(net::IOBuffer* buffer, int num_bytes) { return bytes_read; } -void URLRequestFetchJob::Start() { - fetcher_->Start(); -} - void URLRequestFetchJob::Kill() { - URLRequestJob::Kill(); + JsAsker::Kill(); fetcher_.reset(); } diff --git a/atom/browser/net/url_request_fetch_job.h b/atom/browser/net/url_request_fetch_job.h index a14e8dd1aae3..f2086c6366c6 100644 --- a/atom/browser/net/url_request_fetch_job.h +++ b/atom/browser/net/url_request_fetch_job.h @@ -7,6 +7,7 @@ #include +#include "atom/browser/net/js_asker.h" #include "net/url_request/url_request_context_getter.h" #include "net/url_request/url_fetcher_delegate.h" #include "net/url_request/url_request_job.h" @@ -15,22 +16,23 @@ namespace atom { class AtomBrowserContext; -class URLRequestFetchJob : public net::URLRequestJob, +class URLRequestFetchJob : public JsAsker, public net::URLFetcherDelegate { public: - URLRequestFetchJob(scoped_refptr context_getter, - net::URLRequest* request, + URLRequestFetchJob(net::URLRequest* request, net::NetworkDelegate* network_delegate, - const GURL& url, - const std::string& method, - const std::string& referrer); + v8::Isolate* isolate, + const JavaScriptHandler& handler); - net::URLRequestContextGetter* GetRequestContext(); + // Called by response writer. void HeadersCompleted(); int DataAvailable(net::IOBuffer* buffer, int num_bytes); + protected: + // JsAsker: + void StartAsync(scoped_ptr options) override; + // net::URLRequestJob: - void Start() override; void Kill() override; bool ReadRawData(net::IOBuffer* buf, int buf_size, @@ -43,6 +45,9 @@ class URLRequestFetchJob : public net::URLRequestJob, void OnURLFetchComplete(const net::URLFetcher* source) override; private: + // Create a independent request context. + net::URLRequestContextGetter* CreateRequestContext(); + scoped_refptr url_request_context_getter_; scoped_ptr fetcher_; scoped_refptr pending_buffer_; From 225321b5802deb76bfbab0567b95706e1cf5e9d2 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 12 Aug 2015 21:32:52 +0800 Subject: [PATCH 0861/1293] Make the completion callback optional --- atom/browser/api/atom_api_protocol.cc | 12 +++++++---- atom/browser/api/atom_api_protocol.h | 21 +++++++++++++++++++ atom/browser/net/asar/url_request_asar_job.cc | 1 + atom/browser/net/js_asker.cc | 2 ++ atom/browser/net/url_request_string_job.h | 4 ++-- vendor/native_mate | 2 +- 6 files changed, 35 insertions(+), 7 deletions(-) diff --git a/atom/browser/api/atom_api_protocol.cc b/atom/browser/api/atom_api_protocol.cc index c0c2e5b512ca..b7a4971a37dc 100644 --- a/atom/browser/api/atom_api_protocol.cc +++ b/atom/browser/api/atom_api_protocol.cc @@ -49,13 +49,13 @@ mate::ObjectTemplateBuilder Protocol::GetObjectTemplateBuilder( return mate::ObjectTemplateBuilder(isolate) .SetMethod("registerStandardSchemes", &Protocol::RegisterStandardSchemes) .SetMethod("registerStringProtocol", - &Protocol::RegisterProtocol) + &Protocol::JavaScriptRegisterProtocol) .SetMethod("registerBufferProtocol", - &Protocol::RegisterProtocol) + &Protocol::JavaScriptRegisterProtocol) .SetMethod("registerFileProtocol", - &Protocol::RegisterProtocol) + &Protocol::JavaScriptRegisterProtocol) .SetMethod("registerHttpProtocol", - &Protocol::RegisterProtocol); + &Protocol::JavaScriptRegisterProtocol); } void Protocol::RegisterStandardSchemes( @@ -65,6 +65,10 @@ void Protocol::RegisterStandardSchemes( void Protocol::OnIOCompleted( const CompletionCallback& callback, ProtocolError error) { + // The completion callback is optional. + if (callback.is_null()) + return; + v8::Locker locker(isolate()); v8::HandleScope handle_scope(isolate()); diff --git a/atom/browser/api/atom_api_protocol.h b/atom/browser/api/atom_api_protocol.h index 54dac9b13b9a..233ee00a290f 100644 --- a/atom/browser/api/atom_api_protocol.h +++ b/atom/browser/api/atom_api_protocol.h @@ -12,6 +12,8 @@ #include "atom/browser/net/atom_url_request_job_factory.h" #include "base/callback.h" #include "content/public/browser/browser_thread.h" +#include "native_mate/arguments.h" +#include "native_mate/dictionary.h" #include "native_mate/handle.h" #include "native_mate/wrappable.h" @@ -106,6 +108,25 @@ class Protocol : public mate::Wrappable { return PROTOCOL_FAIL; } + // Parse optional parameters for registerProtocol. + template + void JavaScriptRegisterProtocol(v8::Isolate* isolate, + const std::string& scheme, + mate::Arguments* args) { + // protocol.registerProtocol(scheme[, options], handler[, callback]); + mate::Dictionary options = mate::Dictionary::CreateEmpty(isolate); + Handler handler; + CompletionCallback callback; + args->GetNext(&options); + if (!args->GetNext(&handler)) { + args->ThrowError(); + return; + } + args->GetNext(&callback); + + RegisterProtocol(isolate, scheme, handler, callback); + } + // Convert error code to JS exception and call the callback. void OnIOCompleted(const CompletionCallback& callback, ProtocolError error); diff --git a/atom/browser/net/asar/url_request_asar_job.cc b/atom/browser/net/asar/url_request_asar_job.cc index 33cb04c9ede8..de019f6d9420 100644 --- a/atom/browser/net/asar/url_request_asar_job.cc +++ b/atom/browser/net/asar/url_request_asar_job.cc @@ -5,6 +5,7 @@ #include "atom/browser/net/asar/url_request_asar_job.h" #include +#include #include "base/bind.h" #include "base/files/file_util.h" diff --git a/atom/browser/net/js_asker.cc b/atom/browser/net/js_asker.cc index aa6192b057ac..bbaf093eb250 100644 --- a/atom/browser/net/js_asker.cc +++ b/atom/browser/net/js_asker.cc @@ -4,6 +4,8 @@ #include "atom/browser/net/js_asker.h" +#include + #include "atom/common/native_mate_converters/callback.h" #include "atom/common/native_mate_converters/v8_value_converter.h" #include "native_mate/function_template.h" diff --git a/atom/browser/net/url_request_string_job.h b/atom/browser/net/url_request_string_job.h index 7a2e23acab05..87b9181352c4 100644 --- a/atom/browser/net/url_request_string_job.h +++ b/atom/browser/net/url_request_string_job.h @@ -5,11 +5,11 @@ #ifndef ATOM_BROWSER_NET_URL_REQUEST_STRING_JOB_H_ #define ATOM_BROWSER_NET_URL_REQUEST_STRING_JOB_H_ +#include + #include "atom/browser/net/js_asker.h" #include "net/url_request/url_request_simple_job.h" -#include - namespace atom { class URLRequestStringJob : public JsAsker { diff --git a/vendor/native_mate b/vendor/native_mate index 67d9eaa215e8..24d31e204698 160000 --- a/vendor/native_mate +++ b/vendor/native_mate @@ -1 +1 @@ -Subproject commit 67d9eaa215e8727d86dc7b1f7a10be8699848f1f +Subproject commit 24d31e204698bafc65c50295167764fbb0f28bc0 From d9b845fcdfd5795aea716002b934a2835b892342 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 12 Aug 2015 22:57:25 +0800 Subject: [PATCH 0862/1293] Make session parameter work with null value --- atom/browser/api/atom_api_protocol.h | 19 +++++++++---- atom/browser/net/js_asker.h | 28 +++++++++++++------ .../browser/net/url_request_async_asar_job.cc | 7 ++--- atom/browser/net/url_request_async_asar_job.h | 5 +--- atom/browser/net/url_request_buffer_job.cc | 8 ++---- atom/browser/net/url_request_buffer_job.h | 5 +--- atom/browser/net/url_request_fetch_job.cc | 16 +++++++---- atom/browser/net/url_request_fetch_job.h | 5 +--- atom/browser/net/url_request_string_job.cc | 9 ++---- atom/browser/net/url_request_string_job.h | 5 +--- 10 files changed, 55 insertions(+), 52 deletions(-) diff --git a/atom/browser/api/atom_api_protocol.h b/atom/browser/api/atom_api_protocol.h index 233ee00a290f..22d89896cfdf 100644 --- a/atom/browser/api/atom_api_protocol.h +++ b/atom/browser/api/atom_api_protocol.h @@ -62,18 +62,26 @@ class Protocol : public mate::Wrappable { class CustomProtocolHandler : public net::URLRequestJobFactory::ProtocolHandler { public: - CustomProtocolHandler(v8::Isolate* isolate, const Handler& handler) - : isolate_(isolate), handler_(handler) {} + CustomProtocolHandler( + v8::Isolate* isolate, + scoped_refptr request_context, + const Handler& handler) + : isolate_(isolate), + request_context_(request_context), + handler_(handler) {} ~CustomProtocolHandler() override {} net::URLRequestJob* MaybeCreateJob( net::URLRequest* request, net::NetworkDelegate* network_delegate) const override { - return new RequestJob(request, network_delegate, isolate_, handler_); + RequestJob* request_job = new RequestJob(request, network_delegate); + request_job->SetHandlerInfo(isolate_, request_context_, handler_); + return request_job; } private: v8::Isolate* isolate_; + scoped_refptr request_context_; Protocol::Handler handler_; DISALLOW_COPY_AND_ASSIGN(CustomProtocolHandler); @@ -101,7 +109,8 @@ class Protocol : public mate::Wrappable { if (job_factory_->IsHandledProtocol(scheme)) return PROTOCOL_REGISTERED; scoped_ptr> protocol_handler( - new CustomProtocolHandler(isolate(), handler)); + new CustomProtocolHandler( + isolate(), request_context_getter_, handler)); if (job_factory_->SetProtocolHandler(scheme, protocol_handler.Pass())) return PROTOCOL_OK; else @@ -135,7 +144,7 @@ class Protocol : public mate::Wrappable { scoped_refptr request_context_getter_; - AtomURLRequestJobFactory* job_factory_; // weak ref. + AtomURLRequestJobFactory* job_factory_; // weak ref DISALLOW_COPY_AND_ASSIGN(Protocol); }; diff --git a/atom/browser/net/js_asker.h b/atom/browser/net/js_asker.h index 4d7e888e15ab..63b3199890c6 100644 --- a/atom/browser/net/js_asker.h +++ b/atom/browser/net/js_asker.h @@ -6,10 +6,12 @@ #define ATOM_BROWSER_NET_JS_ASKER_H_ #include "base/callback.h" +#include "base/memory/ref_counted.h" #include "base/memory/weak_ptr.h" #include "base/values.h" #include "content/public/browser/browser_thread.h" #include "net/base/net_errors.h" +#include "net/url_request/url_request_context_getter.h" #include "net/url_request/url_request_job.h" #include "v8/include/v8.h" @@ -37,18 +39,26 @@ bool IsErrorOptions(base::Value* value, int* error); template class JsAsker : public RequestJob { public: - JsAsker(net::URLRequest* request, - net::NetworkDelegate* network_delegate, - v8::Isolate* isolate, - const JavaScriptHandler& handler) - : RequestJob(request, network_delegate), - isolate_(isolate), - handler_(handler), - weak_factory_(this) {} + JsAsker(net::URLRequest* request, net::NetworkDelegate* network_delegate) + : RequestJob(request, network_delegate), weak_factory_(this) {} + + // Called by |CustomProtocolHandler| to store handler related information. + void SetHandlerInfo( + v8::Isolate* isolate, + scoped_refptr request_context_getter, + const JavaScriptHandler& handler) { + isolate_ = isolate; + request_context_getter_ = request_context_getter; + handler_ = handler; + } // Subclass should do initailze work here. virtual void StartAsync(scoped_ptr options) = 0; + net::URLRequestContextGetter* request_context_getter() const { + return request_context_getter_.get(); + } + private: // RequestJob: void Start() override { @@ -75,7 +85,9 @@ class JsAsker : public RequestJob { } v8::Isolate* isolate_; + scoped_refptr request_context_getter_; JavaScriptHandler handler_; + base::WeakPtrFactory weak_factory_; DISALLOW_COPY_AND_ASSIGN(JsAsker); diff --git a/atom/browser/net/url_request_async_asar_job.cc b/atom/browser/net/url_request_async_asar_job.cc index eb6697b76f50..ba0189e5f6e0 100644 --- a/atom/browser/net/url_request_async_asar_job.cc +++ b/atom/browser/net/url_request_async_asar_job.cc @@ -8,11 +8,8 @@ namespace atom { UrlRequestAsyncAsarJob::UrlRequestAsyncAsarJob( net::URLRequest* request, - net::NetworkDelegate* network_delegate, - v8::Isolate* isolate, - const JavaScriptHandler& handler) - : JsAsker(request, network_delegate, isolate, - handler) { + net::NetworkDelegate* network_delegate) + : JsAsker(request, network_delegate) { } void UrlRequestAsyncAsarJob::StartAsync(scoped_ptr options) { diff --git a/atom/browser/net/url_request_async_asar_job.h b/atom/browser/net/url_request_async_asar_job.h index 0b9676e7f368..748b96d84d28 100644 --- a/atom/browser/net/url_request_async_asar_job.h +++ b/atom/browser/net/url_request_async_asar_job.h @@ -13,10 +13,7 @@ namespace atom { // Like URLRequestAsarJob, but asks the JavaScript handler for file path. class UrlRequestAsyncAsarJob : public JsAsker { public: - UrlRequestAsyncAsarJob(net::URLRequest* request, - net::NetworkDelegate* network_delegate, - v8::Isolate* isolate, - const JavaScriptHandler& handler); + UrlRequestAsyncAsarJob(net::URLRequest*, net::NetworkDelegate*); // JsAsker: void StartAsync(scoped_ptr options) override; diff --git a/atom/browser/net/url_request_buffer_job.cc b/atom/browser/net/url_request_buffer_job.cc index 5cfb60a750ef..7eb3aaed243c 100644 --- a/atom/browser/net/url_request_buffer_job.cc +++ b/atom/browser/net/url_request_buffer_job.cc @@ -11,12 +11,8 @@ namespace atom { URLRequestBufferJob::URLRequestBufferJob( - net::URLRequest* request, - net::NetworkDelegate* network_delegate, - v8::Isolate* isolate, - const JavaScriptHandler& handler) - : JsAsker(request, network_delegate, isolate, - handler) { + net::URLRequest* request, net::NetworkDelegate* network_delegate) + : JsAsker(request, network_delegate) { } void URLRequestBufferJob::StartAsync(scoped_ptr options) { diff --git a/atom/browser/net/url_request_buffer_job.h b/atom/browser/net/url_request_buffer_job.h index de1a41234fef..e6fecdba8301 100644 --- a/atom/browser/net/url_request_buffer_job.h +++ b/atom/browser/net/url_request_buffer_job.h @@ -15,10 +15,7 @@ namespace atom { class URLRequestBufferJob : public JsAsker { public: - URLRequestBufferJob(net::URLRequest* request, - net::NetworkDelegate* network_delegate, - v8::Isolate* isolate, - const JavaScriptHandler& handler); + URLRequestBufferJob(net::URLRequest*, net::NetworkDelegate*); // JsAsker: void StartAsync(scoped_ptr options) override; diff --git a/atom/browser/net/url_request_fetch_job.cc b/atom/browser/net/url_request_fetch_job.cc index 7e51c26ba2bb..57fab397fd97 100644 --- a/atom/browser/net/url_request_fetch_job.cc +++ b/atom/browser/net/url_request_fetch_job.cc @@ -75,11 +75,8 @@ class ResponsePiper : public net::URLFetcherResponseWriter { } // namespace URLRequestFetchJob::URLRequestFetchJob( - net::URLRequest* request, - net::NetworkDelegate* network_delegate, - v8::Isolate* isolate, - const JavaScriptHandler& handler) - : JsAsker(request, network_delegate, isolate, handler), + net::URLRequest* request, net::NetworkDelegate* network_delegate) + : JsAsker(request, network_delegate), pending_buffer_size_(0) { } @@ -91,11 +88,13 @@ void URLRequestFetchJob::StartAsync(scoped_ptr options) { } std::string url, method, referrer; + base::Value* session = nullptr; base::DictionaryValue* dict = static_cast(options.get()); dict->GetString("url", &url); dict->GetString("method", &method); dict->GetString("referrer", &referrer); + dict->Get("session", &session); // Use |request|'s method if |method| is not specified. net::URLFetcher::RequestType request_type; @@ -105,9 +104,14 @@ void URLRequestFetchJob::StartAsync(scoped_ptr options) { request_type = GetRequestType(method); fetcher_ = net::URLFetcher::Create(GURL(url), request_type, this); - fetcher_->SetRequestContext(CreateRequestContext()); fetcher_->SaveResponseWithWriter(make_scoped_ptr(new ResponsePiper(this))); + // When |session| is set to |null| we use a new request context for fetch job. + if (session && session->IsType(base::Value::TYPE_NULL)) + fetcher_->SetRequestContext(CreateRequestContext()); + else + fetcher_->SetRequestContext(request_context_getter()); + // Use |request|'s referrer if |referrer| is not specified. if (referrer.empty()) fetcher_->SetReferrer(request()->referrer()); diff --git a/atom/browser/net/url_request_fetch_job.h b/atom/browser/net/url_request_fetch_job.h index f2086c6366c6..189cebf01b18 100644 --- a/atom/browser/net/url_request_fetch_job.h +++ b/atom/browser/net/url_request_fetch_job.h @@ -19,10 +19,7 @@ class AtomBrowserContext; class URLRequestFetchJob : public JsAsker, public net::URLFetcherDelegate { public: - URLRequestFetchJob(net::URLRequest* request, - net::NetworkDelegate* network_delegate, - v8::Isolate* isolate, - const JavaScriptHandler& handler); + URLRequestFetchJob(net::URLRequest*, net::NetworkDelegate*); // Called by response writer. void HeadersCompleted(); diff --git a/atom/browser/net/url_request_string_job.cc b/atom/browser/net/url_request_string_job.cc index eec8176d734a..428a87f54b1e 100644 --- a/atom/browser/net/url_request_string_job.cc +++ b/atom/browser/net/url_request_string_job.cc @@ -10,12 +10,9 @@ namespace atom { -URLRequestStringJob::URLRequestStringJob(net::URLRequest* request, - net::NetworkDelegate* network_delegate, - v8::Isolate* isolate, - const JavaScriptHandler& handler) - : JsAsker(request, network_delegate, isolate, - handler) { +URLRequestStringJob::URLRequestStringJob( + net::URLRequest* request, net::NetworkDelegate* network_delegate) + : JsAsker(request, network_delegate) { } void URLRequestStringJob::StartAsync(scoped_ptr options) { diff --git a/atom/browser/net/url_request_string_job.h b/atom/browser/net/url_request_string_job.h index 87b9181352c4..713185c0cd1d 100644 --- a/atom/browser/net/url_request_string_job.h +++ b/atom/browser/net/url_request_string_job.h @@ -14,10 +14,7 @@ namespace atom { class URLRequestStringJob : public JsAsker { public: - URLRequestStringJob(net::URLRequest* request, - net::NetworkDelegate* network_delegate, - v8::Isolate* isolate, - const JavaScriptHandler& handler); + URLRequestStringJob(net::URLRequest*, net::NetworkDelegate*); // JsAsker: void StartAsync(scoped_ptr options) override; From 94c1fb32a7d69d30c3f84b66ed37f16cf6c9a033 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 12 Aug 2015 23:07:15 +0800 Subject: [PATCH 0863/1293] Try work around VS's bug --- atom/browser/net/js_asker.cc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/atom/browser/net/js_asker.cc b/atom/browser/net/js_asker.cc index bbaf093eb250..487033d156b0 100644 --- a/atom/browser/net/js_asker.cc +++ b/atom/browser/net/js_asker.cc @@ -65,7 +65,8 @@ v8::Local BindFunctionWith(v8::Isolate* isolate, v8::Local bind_func = v8::Local::Cast(bind.ToLocalChecked()); std::vector> converted = { - func, mate::ConvertToV8(isolate, args)..., + v8::Local::Cast(func), + mate::ConvertToV8(isolate, args)..., }; return bind_func->Call( context, func, converted.size(), &converted.front()).ToLocalChecked(); From 78171e2072e5f1fc3797f561cfee5b8d7183fe70 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 12 Aug 2015 23:14:20 +0800 Subject: [PATCH 0864/1293] Don't use C++11 to not crash VS --- atom/browser/net/js_asker.cc | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/atom/browser/net/js_asker.cc b/atom/browser/net/js_asker.cc index 487033d156b0..b17027570f4a 100644 --- a/atom/browser/net/js_asker.cc +++ b/atom/browser/net/js_asker.cc @@ -54,22 +54,20 @@ void HandlerCallback(v8::Isolate* isolate, base::Bind(holder->callback, true, base::Passed(&options))); } -// func.bind(func, ...). -template +// func.bind(func, arg1, arg2). +// NB(zcbenz): Using C++11 version crashes VS. v8::Local BindFunctionWith(v8::Isolate* isolate, v8::Local context, v8::Local func, - ArgTypes... args) { + v8::Local arg1, + v8::Local arg2) { v8::MaybeLocal bind = func->Get(mate::StringToV8(isolate, "bind")); CHECK(!bind.IsEmpty()); v8::Local bind_func = v8::Local::Cast(bind.ToLocalChecked()); - std::vector> converted = { - v8::Local::Cast(func), - mate::ConvertToV8(isolate, args)..., - }; + v8::Local converted[] = { func, arg1, arg2 }; return bind_func->Call( - context, func, converted.size(), &converted.front()).ToLocalChecked(); + context, func, arraysize(converted), converted).ToLocalChecked(); } // Generate the callback that will be passed to |handler|. @@ -86,8 +84,7 @@ v8::MaybeLocal GenerateCallback(v8::Isolate* isolate, v8::Local::New(isolate, g_handler_callback_); CallbackHolder* holder = new CallbackHolder; holder->callback = callback; - return BindFunctionWith(isolate, context, - handler_callback->GetFunction(), + return BindFunctionWith(isolate, context, handler_callback->GetFunction(), v8::External::New(isolate, holder), v8::Object::New(isolate)); } From d0ef43bd12095a4c71af4bf5dd1be5aacd29d0ef Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 12 Aug 2015 23:16:17 +0800 Subject: [PATCH 0865/1293] Completion callback is called on IO thread --- atom/browser/net/js_asker.cc | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/atom/browser/net/js_asker.cc b/atom/browser/net/js_asker.cc index b17027570f4a..d838ae39638f 100644 --- a/atom/browser/net/js_asker.cc +++ b/atom/browser/net/js_asker.cc @@ -41,7 +41,9 @@ void HandlerCallback(v8::Isolate* isolate, CHECK(holder); v8::Local value; if (!args->GetNext(&value)) { - holder->callback.Run(false, nullptr); + content::BrowserThread::PostTask( + content::BrowserThread::IO, FROM_HERE, + base::Bind(holder->callback, false, nullptr)); return; } From 777f99193f1e09b0e4ef8614c051b0651cc904af Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 13 Aug 2015 13:44:37 +0800 Subject: [PATCH 0866/1293] Update native_mate to fix VS compilation error --- vendor/native_mate | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/native_mate b/vendor/native_mate index 24d31e204698..b41635e80921 160000 --- a/vendor/native_mate +++ b/vendor/native_mate @@ -1 +1 @@ -Subproject commit 24d31e204698bafc65c50295167764fbb0f28bc0 +Subproject commit b41635e80921bddbf1a36f030490e063cd593477 From 05fd81ebdc3d97eab89f4c99e38b5eecae5e112b Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 13 Aug 2015 19:26:18 +0800 Subject: [PATCH 0867/1293] Implement protocol.unregisterProtocol --- atom/browser/api/atom_api_protocol.cc | 29 +++++++++++++++++++++++---- atom/browser/api/atom_api_protocol.h | 28 +++++++------------------- 2 files changed, 32 insertions(+), 25 deletions(-) diff --git a/atom/browser/api/atom_api_protocol.cc b/atom/browser/api/atom_api_protocol.cc index b7a4971a37dc..7571ee0e8377 100644 --- a/atom/browser/api/atom_api_protocol.cc +++ b/atom/browser/api/atom_api_protocol.cc @@ -49,13 +49,14 @@ mate::ObjectTemplateBuilder Protocol::GetObjectTemplateBuilder( return mate::ObjectTemplateBuilder(isolate) .SetMethod("registerStandardSchemes", &Protocol::RegisterStandardSchemes) .SetMethod("registerStringProtocol", - &Protocol::JavaScriptRegisterProtocol) + &Protocol::RegisterProtocol) .SetMethod("registerBufferProtocol", - &Protocol::JavaScriptRegisterProtocol) + &Protocol::RegisterProtocol) .SetMethod("registerFileProtocol", - &Protocol::JavaScriptRegisterProtocol) + &Protocol::RegisterProtocol) .SetMethod("registerHttpProtocol", - &Protocol::JavaScriptRegisterProtocol); + &Protocol::RegisterProtocol) + .SetMethod("unregisterProtocol", &Protocol::UnregisterProtocol); } void Protocol::RegisterStandardSchemes( @@ -63,6 +64,26 @@ void Protocol::RegisterStandardSchemes( atom::AtomBrowserClient::SetCustomSchemes(schemes); } +void Protocol::UnregisterProtocol( + const std::string& scheme, mate::Arguments* args) { + CompletionCallback callback; + args->GetNext(&callback); + content::BrowserThread::PostTaskAndReplyWithResult( + content::BrowserThread::IO, FROM_HERE, + base::Bind(&Protocol::UnregisterProtocolInIO, + base::Unretained(this), scheme), + base::Bind(&Protocol::OnIOCompleted, + base::Unretained(this), callback)); +} + +Protocol::ProtocolError Protocol::UnregisterProtocolInIO( + const std::string& scheme) { + if (!job_factory_->HasProtocolHandler(scheme)) + return PROTOCOL_NOT_REGISTERED; + job_factory_->SetProtocolHandler(scheme, nullptr); + return PROTOCOL_OK; +} + void Protocol::OnIOCompleted( const CompletionCallback& callback, ProtocolError error) { // The completion callback is optional. diff --git a/atom/browser/api/atom_api_protocol.h b/atom/browser/api/atom_api_protocol.h index 22d89896cfdf..c409d34c434d 100644 --- a/atom/browser/api/atom_api_protocol.h +++ b/atom/browser/api/atom_api_protocol.h @@ -92,10 +92,11 @@ class Protocol : public mate::Wrappable { // Register the protocol with certain request job. template - void RegisterProtocol(v8::Isolate* isolate, - const std::string& scheme, + void RegisterProtocol(const std::string& scheme, const Handler& handler, - const CompletionCallback& callback) { + mate::Arguments* args) { + CompletionCallback callback; + args->GetNext(&callback); content::BrowserThread::PostTaskAndReplyWithResult( content::BrowserThread::IO, FROM_HERE, base::Bind(&Protocol::RegisterProtocolInIO, @@ -117,24 +118,9 @@ class Protocol : public mate::Wrappable { return PROTOCOL_FAIL; } - // Parse optional parameters for registerProtocol. - template - void JavaScriptRegisterProtocol(v8::Isolate* isolate, - const std::string& scheme, - mate::Arguments* args) { - // protocol.registerProtocol(scheme[, options], handler[, callback]); - mate::Dictionary options = mate::Dictionary::CreateEmpty(isolate); - Handler handler; - CompletionCallback callback; - args->GetNext(&options); - if (!args->GetNext(&handler)) { - args->ThrowError(); - return; - } - args->GetNext(&callback); - - RegisterProtocol(isolate, scheme, handler, callback); - } + // Unregistered the protocol handler that handles |scheme|. + void UnregisterProtocol(const std::string& scheme, mate::Arguments* args); + ProtocolError UnregisterProtocolInIO(const std::string& scheme); // Convert error code to JS exception and call the callback. void OnIOCompleted(const CompletionCallback& callback, ProtocolError error); From 374d83ed9c9acd1bdf154b7de6b1bd7c69ff7caf Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 13 Aug 2015 19:33:53 +0800 Subject: [PATCH 0868/1293] Implement protocol.isHandledProtocol --- atom/browser/api/atom_api_protocol.cc | 16 +++++++++++++++- atom/browser/api/atom_api_protocol.h | 8 +++++++- 2 files changed, 22 insertions(+), 2 deletions(-) diff --git a/atom/browser/api/atom_api_protocol.cc b/atom/browser/api/atom_api_protocol.cc index 7571ee0e8377..9170f16b482c 100644 --- a/atom/browser/api/atom_api_protocol.cc +++ b/atom/browser/api/atom_api_protocol.cc @@ -56,7 +56,8 @@ mate::ObjectTemplateBuilder Protocol::GetObjectTemplateBuilder( &Protocol::RegisterProtocol) .SetMethod("registerHttpProtocol", &Protocol::RegisterProtocol) - .SetMethod("unregisterProtocol", &Protocol::UnregisterProtocol); + .SetMethod("unregisterProtocol", &Protocol::UnregisterProtocol) + .SetMethod("isHandledProtocol", &Protocol::IsHandledProtocol); } void Protocol::RegisterStandardSchemes( @@ -84,6 +85,19 @@ Protocol::ProtocolError Protocol::UnregisterProtocolInIO( return PROTOCOL_OK; } +void Protocol::IsHandledProtocol(const std::string& scheme, + const BooleanCallback& callback) { + content::BrowserThread::PostTaskAndReplyWithResult( + content::BrowserThread::IO, FROM_HERE, + base::Bind(&Protocol::IsHandledProtocolInIO, + base::Unretained(this), scheme), + callback); +} + +bool Protocol::IsHandledProtocolInIO(const std::string& scheme) { + return job_factory_->IsHandledProtocol(scheme); +} + void Protocol::OnIOCompleted( const CompletionCallback& callback, ProtocolError error) { // The completion callback is optional. diff --git a/atom/browser/api/atom_api_protocol.h b/atom/browser/api/atom_api_protocol.h index c409d34c434d..05e3f6073932 100644 --- a/atom/browser/api/atom_api_protocol.h +++ b/atom/browser/api/atom_api_protocol.h @@ -34,6 +34,7 @@ class Protocol : public mate::Wrappable { using Handler = base::Callback)>; using CompletionCallback = base::Callback)>; + using BooleanCallback = base::Callback; static mate::Handle Create( v8::Isolate* isolate, AtomBrowserContext* browser_context); @@ -118,10 +119,15 @@ class Protocol : public mate::Wrappable { return PROTOCOL_FAIL; } - // Unregistered the protocol handler that handles |scheme|. + // Unregister the protocol handler that handles |scheme|. void UnregisterProtocol(const std::string& scheme, mate::Arguments* args); ProtocolError UnregisterProtocolInIO(const std::string& scheme); + // Whether the protocol has handler registered. + void IsHandledProtocol(const std::string& scheme, + const BooleanCallback& callback); + bool IsHandledProtocolInIO(const std::string& scheme); + // Convert error code to JS exception and call the callback. void OnIOCompleted(const CompletionCallback& callback, ProtocolError error); From 773e932e987bfafc2fa6d00ac8748c3b07b29023 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 13 Aug 2015 20:10:05 +0800 Subject: [PATCH 0869/1293] Implement protocol.interceptProtocol --- atom/browser/api/atom_api_protocol.cc | 10 ++++++- atom/browser/api/atom_api_protocol.h | 40 +++++++++++++++++++++++++++ 2 files changed, 49 insertions(+), 1 deletion(-) diff --git a/atom/browser/api/atom_api_protocol.cc b/atom/browser/api/atom_api_protocol.cc index 9170f16b482c..f190bae616ce 100644 --- a/atom/browser/api/atom_api_protocol.cc +++ b/atom/browser/api/atom_api_protocol.cc @@ -57,7 +57,15 @@ mate::ObjectTemplateBuilder Protocol::GetObjectTemplateBuilder( .SetMethod("registerHttpProtocol", &Protocol::RegisterProtocol) .SetMethod("unregisterProtocol", &Protocol::UnregisterProtocol) - .SetMethod("isHandledProtocol", &Protocol::IsHandledProtocol); + .SetMethod("isHandledProtocol", &Protocol::IsHandledProtocol) + .SetMethod("interceptStringProtocol", + &Protocol::InterceptProtocol) + .SetMethod("interceptBufferProtocol", + &Protocol::InterceptProtocol) + .SetMethod("interceptFileProtocol", + &Protocol::InterceptProtocol) + .SetMethod("interceptHttpProtocol", + &Protocol::InterceptProtocol); } void Protocol::RegisterStandardSchemes( diff --git a/atom/browser/api/atom_api_protocol.h b/atom/browser/api/atom_api_protocol.h index 05e3f6073932..ce8f087ad082 100644 --- a/atom/browser/api/atom_api_protocol.h +++ b/atom/browser/api/atom_api_protocol.h @@ -11,6 +11,7 @@ #include "atom/browser/net/atom_url_request_job_factory.h" #include "base/callback.h" +#include "base/containers/scoped_ptr_hash_map.h" #include "content/public/browser/browser_thread.h" #include "native_mate/arguments.h" #include "native_mate/dictionary.h" @@ -128,6 +129,39 @@ class Protocol : public mate::Wrappable { const BooleanCallback& callback); bool IsHandledProtocolInIO(const std::string& scheme); + // Replace the protocol handler with a new one. + template + void InterceptProtocol(const std::string& scheme, + const Handler& handler, + mate::Arguments* args) { + CompletionCallback callback; + args->GetNext(&callback); + content::BrowserThread::PostTaskAndReplyWithResult( + content::BrowserThread::IO, FROM_HERE, + base::Bind(&Protocol::InterceptProtocolInIO, + base::Unretained(this), scheme, handler), + base::Bind(&Protocol::OnIOCompleted, + base::Unretained(this), callback)); + } + template + ProtocolError InterceptProtocolInIO(const std::string& scheme, + const Handler& handler) { + if (!job_factory_->IsHandledProtocol(scheme)) + return PROTOCOL_NOT_REGISTERED; + // It is possible a protocol is handled but can not be intercepted. + if (!job_factory_->HasProtocolHandler(scheme)) + return PROTOCOL_FAIL; + if (ContainsKey(original_protocols_, scheme)) + return PROTOCOL_INTERCEPTED; + scoped_ptr> protocol_handler( + new CustomProtocolHandler( + isolate(), request_context_getter_, handler)); + original_protocols_.set( + scheme, + job_factory_->ReplaceProtocol(scheme, protocol_handler.Pass())); + return PROTOCOL_OK; + } + // Convert error code to JS exception and call the callback. void OnIOCompleted(const CompletionCallback& callback, ProtocolError error); @@ -136,6 +170,12 @@ class Protocol : public mate::Wrappable { scoped_refptr request_context_getter_; + // Map that stores the original protocols of schemes. + using OriginalProtocolsMap = base::ScopedPtrHashMap< + std::string, + scoped_ptr>; + OriginalProtocolsMap original_protocols_; + AtomURLRequestJobFactory* job_factory_; // weak ref DISALLOW_COPY_AND_ASSIGN(Protocol); From 741c8f3d983c4625c8b8b6b51b20dfce7768f7b2 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 13 Aug 2015 20:19:02 +0800 Subject: [PATCH 0870/1293] Implement protocol.uninterceptProtocol --- atom/browser/api/atom_api_protocol.cc | 24 +++++++++++++++++++++++- atom/browser/api/atom_api_protocol.h | 4 ++++ 2 files changed, 27 insertions(+), 1 deletion(-) diff --git a/atom/browser/api/atom_api_protocol.cc b/atom/browser/api/atom_api_protocol.cc index f190bae616ce..e2f536462f48 100644 --- a/atom/browser/api/atom_api_protocol.cc +++ b/atom/browser/api/atom_api_protocol.cc @@ -65,7 +65,8 @@ mate::ObjectTemplateBuilder Protocol::GetObjectTemplateBuilder( .SetMethod("interceptFileProtocol", &Protocol::InterceptProtocol) .SetMethod("interceptHttpProtocol", - &Protocol::InterceptProtocol); + &Protocol::InterceptProtocol) + .SetMethod("uninterceptProtocol", &Protocol::UninterceptProtocol); } void Protocol::RegisterStandardSchemes( @@ -106,6 +107,27 @@ bool Protocol::IsHandledProtocolInIO(const std::string& scheme) { return job_factory_->IsHandledProtocol(scheme); } +void Protocol::UninterceptProtocol( + const std::string& scheme, mate::Arguments* args) { + CompletionCallback callback; + args->GetNext(&callback); + content::BrowserThread::PostTaskAndReplyWithResult( + content::BrowserThread::IO, FROM_HERE, + base::Bind(&Protocol::UninterceptProtocolInIO, + base::Unretained(this), scheme), + base::Bind(&Protocol::OnIOCompleted, + base::Unretained(this), callback)); +} + +Protocol::ProtocolError Protocol::UninterceptProtocolInIO( + const std::string& scheme) { + if (!original_protocols_.contains(scheme)) + return PROTOCOL_NOT_INTERCEPTED; + job_factory_->ReplaceProtocol(scheme, + original_protocols_.take_and_erase(scheme)); + return PROTOCOL_OK; +} + void Protocol::OnIOCompleted( const CompletionCallback& callback, ProtocolError error) { // The completion callback is optional. diff --git a/atom/browser/api/atom_api_protocol.h b/atom/browser/api/atom_api_protocol.h index ce8f087ad082..2e706c4157fd 100644 --- a/atom/browser/api/atom_api_protocol.h +++ b/atom/browser/api/atom_api_protocol.h @@ -162,6 +162,10 @@ class Protocol : public mate::Wrappable { return PROTOCOL_OK; } + // Restore the |scheme| to its original protocol handler. + void UninterceptProtocol(const std::string& scheme, mate::Arguments* args); + ProtocolError UninterceptProtocolInIO(const std::string& scheme); + // Convert error code to JS exception and call the callback. void OnIOCompleted(const CompletionCallback& callback, ProtocolError error); From 02714d466cf761ce892ece919b3df5aeddbd34ad Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 13 Aug 2015 21:21:23 +0800 Subject: [PATCH 0871/1293] Fix crash when requesting invalid url --- atom/browser/net/url_request_fetch_job.cc | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/atom/browser/net/url_request_fetch_job.cc b/atom/browser/net/url_request_fetch_job.cc index 57fab397fd97..eacaada19358 100644 --- a/atom/browser/net/url_request_fetch_job.cc +++ b/atom/browser/net/url_request_fetch_job.cc @@ -96,6 +96,14 @@ void URLRequestFetchJob::StartAsync(scoped_ptr options) { dict->GetString("referrer", &referrer); dict->Get("session", &session); + // Check if URL is valid. + GURL formated_url(url); + if (!formated_url.is_valid()) { + NotifyStartError(net::URLRequestStatus( + net::URLRequestStatus::FAILED, net::ERR_INVALID_URL)); + return; + } + // Use |request|'s method if |method| is not specified. net::URLFetcher::RequestType request_type; if (method.empty()) @@ -103,7 +111,7 @@ void URLRequestFetchJob::StartAsync(scoped_ptr options) { else request_type = GetRequestType(method); - fetcher_ = net::URLFetcher::Create(GURL(url), request_type, this); + fetcher_ = net::URLFetcher::Create(formated_url, request_type, this); fetcher_->SaveResponseWithWriter(make_scoped_ptr(new ResponsePiper(this))); // When |session| is set to |null| we use a new request context for fetch job. From 467ba6b7a9f91eac4008fb468ae8479d8f022397 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 13 Aug 2015 21:24:27 +0800 Subject: [PATCH 0872/1293] Rename protocol.isHandledProtocol to protocol.isProtocolHandled --- atom/browser/api/atom_api_protocol.cc | 10 +- atom/browser/api/atom_api_protocol.h | 4 +- spec/api-protocol-spec.coffee | 449 ++++++++++++-------------- spec/static/main.js | 2 +- 4 files changed, 222 insertions(+), 243 deletions(-) diff --git a/atom/browser/api/atom_api_protocol.cc b/atom/browser/api/atom_api_protocol.cc index e2f536462f48..f77f3229ed0a 100644 --- a/atom/browser/api/atom_api_protocol.cc +++ b/atom/browser/api/atom_api_protocol.cc @@ -57,7 +57,7 @@ mate::ObjectTemplateBuilder Protocol::GetObjectTemplateBuilder( .SetMethod("registerHttpProtocol", &Protocol::RegisterProtocol) .SetMethod("unregisterProtocol", &Protocol::UnregisterProtocol) - .SetMethod("isHandledProtocol", &Protocol::IsHandledProtocol) + .SetMethod("isProtocolHandled", &Protocol::IsProtocolHandled) .SetMethod("interceptStringProtocol", &Protocol::InterceptProtocol) .SetMethod("interceptBufferProtocol", @@ -94,16 +94,16 @@ Protocol::ProtocolError Protocol::UnregisterProtocolInIO( return PROTOCOL_OK; } -void Protocol::IsHandledProtocol(const std::string& scheme, - const BooleanCallback& callback) { +void Protocol::IsProtocolHandled(const std::string& scheme, + const BooleanCallback& callback) { content::BrowserThread::PostTaskAndReplyWithResult( content::BrowserThread::IO, FROM_HERE, - base::Bind(&Protocol::IsHandledProtocolInIO, + base::Bind(&Protocol::IsProtocolHandledInIO, base::Unretained(this), scheme), callback); } -bool Protocol::IsHandledProtocolInIO(const std::string& scheme) { +bool Protocol::IsProtocolHandledInIO(const std::string& scheme) { return job_factory_->IsHandledProtocol(scheme); } diff --git a/atom/browser/api/atom_api_protocol.h b/atom/browser/api/atom_api_protocol.h index 2e706c4157fd..966fcd8726b3 100644 --- a/atom/browser/api/atom_api_protocol.h +++ b/atom/browser/api/atom_api_protocol.h @@ -125,9 +125,9 @@ class Protocol : public mate::Wrappable { ProtocolError UnregisterProtocolInIO(const std::string& scheme); // Whether the protocol has handler registered. - void IsHandledProtocol(const std::string& scheme, + void IsProtocolHandled(const std::string& scheme, const BooleanCallback& callback); - bool IsHandledProtocolInIO(const std::string& scheme); + bool IsProtocolHandledInIO(const std::string& scheme); // Replace the protocol handler with a new one. template diff --git a/spec/api-protocol-spec.coffee b/spec/api-protocol-spec.coffee index 4f2fb79da372..f42ce17287b1 100644 --- a/spec/api-protocol-spec.coffee +++ b/spec/api-protocol-spec.coffee @@ -1,278 +1,257 @@ assert = require 'assert' -ipc = require 'ipc' http = require 'http' path = require 'path' remote = require 'remote' protocol = remote.require 'protocol' describe 'protocol module', -> - describe 'protocol.registerProtocol', -> - it 'error when scheme is already registered', (done) -> - register = -> - protocol.registerProtocol 'test1', ((request) ->), (error, scheme) -> - if error? - protocol.unregisterProtocol 'test1', (error, scheme) -> - assert.equal scheme, 'test1' - done() - else - assert.equal scheme, 'test1' - register() - register() + protocolName = 'sp' + text = 'valar morghulis' - it 'calls the callback when scheme is visited', (done) -> - protocol.registerProtocol 'test2', (request) -> - assert.equal request.url, 'test2://test2' - protocol.unregisterProtocol 'test2' - done() - $.get 'test2://test2', -> + afterEach (done) -> + protocol.unregisterProtocol protocolName, -> done() describe 'protocol.unregisterProtocol', -> - it 'throws error when scheme does not exist', -> - protocol.unregisterProtocol 'test3', (->), (error, scheme) -> - if (error) - assert.equal scheme, 'test3' + it 'returns error when scheme does not exist', (done) -> + protocol.unregisterProtocol 'not-exist', (error) -> + assert.notEqual error, null + done() + + describe 'protocol.register(Any)Protocol', -> + emptyHandler = (request, callback) -> callback() + it 'throws error when scheme is already registered', (done) -> + protocol.registerStringProtocol protocolName, emptyHandler, (error) -> + assert.equal error, null + protocol.registerBufferProtocol protocolName, emptyHandler, (error) -> + assert.notEqual error, null done() - describe 'registered protocol callback', -> - it 'returns string should send the string as request content', (done) -> - handler = remote.createFunctionWithReturnValue 'valar morghulis' - protocol.registerProtocol 'atom-string', handler + it 'does not crash when handler is called twice', (done) -> + doubleHandler = (request, callback) -> + callback(text) + callback() + protocol.registerStringProtocol protocolName, doubleHandler, (error) -> + $.ajax + url: "#{protocolName}://fake-host" + success: (data) -> + assert.equal data, text + done() + error: (xhr, errorType, error) -> + done(error) - $.ajax - url: 'atom-string://fake-host' - success: (data) -> - assert.equal data, handler() - protocol.unregisterProtocol 'atom-string' - done() - error: (xhr, errorType, error) -> - assert false, 'Got error: ' + errorType + ' ' + error - protocol.unregisterProtocol 'atom-string' + it 'sends error when callback is called with nothing', (done) -> + protocol.registerBufferProtocol protocolName, emptyHandler, (error) -> + $.ajax + url: "#{protocolName}://fake-host" + success: (data) -> + done('request succeeded but it should not') + error: (xhr, errorType, error) -> + assert.equal errorType, 'error' + done() - it 'returns RequestStringJob should send string', (done) -> - data = 'valar morghulis' - job = new protocol.RequestStringJob(mimeType: 'text/html', data: data) - handler = remote.createFunctionWithReturnValue job - protocol.registerProtocol 'atom-string-job', handler + it 'does not crash when callback is called in next tick', (done) -> + handler = (request, callback) -> + setImmediate -> callback(text) + protocol.registerStringProtocol protocolName, handler, (error) -> + $.ajax + url: "#{protocolName}://fake-host" + success: (data) -> + assert.equal data, text + done() + error: (xhr, errorType, error) -> + done(error) - $.ajax - url: 'atom-string-job://fake-host' - success: (response) -> - assert.equal response, data - protocol.unregisterProtocol 'atom-string-job' - done() - error: (xhr, errorType, error) -> - assert false, 'Got error: ' + errorType + ' ' + error - protocol.unregisterProtocol 'atom-string-job' + describe 'protocol.registerStringProtocol', -> + it 'sends string as response', (done) -> + handler = (request, callback) -> callback(text) + protocol.registerStringProtocol protocolName, handler, (error) -> + $.ajax + url: "#{protocolName}://fake-host" + success: (data) -> + assert.equal data, text + done() + error: (xhr, errorType, error) -> + done(error) - it 'returns RequestErrorJob should send error', (done) -> - data = 'valar morghulis' - job = new protocol.RequestErrorJob(-6) - handler = remote.createFunctionWithReturnValue job - protocol.registerProtocol 'atom-error-job', handler + it 'sends object as response', (done) -> + handler = (request, callback) -> callback(data: text, mimeType: 'text/html') + protocol.registerStringProtocol protocolName, handler, (error) -> + $.ajax + url: "#{protocolName}://fake-host" + success: (data, statux, request) -> + assert.equal data, text + done() + error: (xhr, errorType, error) -> + done(error) - $.ajax - url: 'atom-error-job://fake-host' - success: (response) -> - assert false, 'should not reach here' - error: (xhr, errorType, error) -> - assert errorType, 'error' - protocol.unregisterProtocol 'atom-error-job' - done() + it 'fails when sending object other than string', (done) -> + handler = (request, callback) -> callback(new Date) + protocol.registerBufferProtocol protocolName, handler, (error) -> + $.ajax + url: "#{protocolName}://fake-host" + success: (data) -> + done('request succeeded but it should not') + error: (xhr, errorType, error) -> + assert.equal errorType, 'error' + done() - it 'returns RequestHttpJob should send respone', (done) -> + describe 'protocol.registerBufferProtocol', -> + buffer = new Buffer(text) + + it 'sends Buffer as response', (done) -> + handler = (request, callback) -> callback(buffer) + protocol.registerBufferProtocol protocolName, handler, (error) -> + $.ajax + url: "#{protocolName}://fake-host" + success: (data) -> + assert.equal data, text + done() + error: (xhr, errorType, error) -> + done(error) + + it 'sends object as response', (done) -> + handler = (request, callback) -> callback(data: buffer, mimeType: 'text/html') + protocol.registerBufferProtocol protocolName, handler, (error) -> + $.ajax + url: "#{protocolName}://fake-host" + success: (data, statux, request) -> + assert.equal data, text + done() + error: (xhr, errorType, error) -> + done(error) + + it 'fails when sending string', (done) -> + handler = (request, callback) -> callback(text) + protocol.registerBufferProtocol protocolName, handler, (error) -> + $.ajax + url: "#{protocolName}://fake-host" + success: (data) -> + done('request succeeded but it should not') + error: (xhr, errorType, error) -> + assert.equal errorType, 'error' + done() + + describe 'protocol.registerFileProtocol', -> + filePath = path.join __dirname, 'fixtures', 'asar', 'a.asar', 'file1' + fileContent = require('fs').readFileSync(filePath) + + normalPath = path.join __dirname, 'fixtures', 'pages', 'a.html' + normalContent = require('fs').readFileSync(normalPath) + + it 'sends file path as response', (done) -> + handler = (request, callback) -> callback(filePath) + protocol.registerFileProtocol protocolName, handler, (error) -> + $.ajax + url: "#{protocolName}://fake-host" + success: (data) -> + assert.equal data, String(fileContent) + done() + error: (xhr, errorType, error) -> + done(error) + + it 'sends object as response', (done) -> + handler = (request, callback) -> callback(path: filePath) + protocol.registerFileProtocol protocolName, handler, (error) -> + $.ajax + url: "#{protocolName}://fake-host" + success: (data, statux, request) -> + assert.equal data, String(fileContent) + done() + error: (xhr, errorType, error) -> + done(error) + + it 'can send normal file', (done) -> + handler = (request, callback) -> callback(normalPath) + protocol.registerFileProtocol protocolName, handler, (error) -> + $.ajax + url: "#{protocolName}://fake-host" + success: (data) -> + assert.equal data, String(normalContent) + done() + error: (xhr, errorType, error) -> + done(error) + + it 'fails when sending unexist-file', (done) -> + fakeFilePath = path.join __dirname, 'fixtures', 'asar', 'a.asar', 'not-exist' + handler = (request, callback) -> callback(fakeFilePath) + protocol.registerBufferProtocol protocolName, handler, (error) -> + $.ajax + url: "#{protocolName}://fake-host" + success: (data) -> + done('request succeeded but it should not') + error: (xhr, errorType, error) -> + assert.equal errorType, 'error' + done() + + it 'fails when sending unsupported content', (done) -> + handler = (request, callback) -> callback(new Date) + protocol.registerBufferProtocol protocolName, handler, (error) -> + $.ajax + url: "#{protocolName}://fake-host" + success: (data) -> + done('request succeeded but it should not') + error: (xhr, errorType, error) -> + assert.equal errorType, 'error' + done() + + describe 'protocol.registerHttpProtocol', -> + it 'sends url as response', (done) -> server = http.createServer (req, res) -> assert.notEqual req.headers.accept, '' - res.writeHead(200, {'Content-Type': 'text/plain'}) - res.end('hello') + res.end(text) server.close() server.listen 0, '127.0.0.1', -> {port} = server.address() url = "http://127.0.0.1:#{port}" - job = new protocol.RequestHttpJob({url}) - handler = remote.createFunctionWithReturnValue job - protocol.registerProtocol 'atom-http-job', handler + handler = (request, callback) -> callback({url}) + protocol.registerHttpProtocol protocolName, handler, (error) -> + $.ajax + url: "#{protocolName}://fake-host" + success: (data) -> + assert.equal data, text + done() + error: (xhr, errorType, error) -> + done(error) + it 'fails when sending invalid url', (done) -> + handler = (request, callback) -> callback({url: 'url'}) + protocol.registerHttpProtocol protocolName, handler, (error) -> $.ajax - url: 'atom-http-job://fake-host' + url: "#{protocolName}://fake-host" success: (data) -> - assert.equal data, 'hello' - protocol.unregisterProtocol 'atom-http-job' - done() + done('request succeeded but it should not') error: (xhr, errorType, error) -> - assert false, 'Got error: ' + errorType + ' ' + error - protocol.unregisterProtocol 'atom-http-job' + assert.equal errorType, 'error' + done() - it 'returns RequestBufferJob should send buffer', (done) -> - data = new Buffer("hello") - job = new protocol.RequestBufferJob(data: data) - handler = remote.createFunctionWithReturnValue job - protocol.registerProtocol 'atom-buffer-job', handler - - $.ajax - url: 'atom-buffer-job://fake-host' - success: (response) -> - assert.equal response.length, data.length - buf = new Buffer(response.length) - buf.write(response) - assert buf.equals(data) - protocol.unregisterProtocol 'atom-buffer-job' - done() - error: (xhr, errorType, error) -> - assert false, 'Got error: ' + errorType + ' ' + error - protocol.unregisterProtocol 'atom-buffer-job' - - it 'returns RequestFileJob should send file', (done) -> - job = new protocol.RequestFileJob(__filename) - handler = remote.createFunctionWithReturnValue job - protocol.registerProtocol 'atom-file-job', handler - - $.ajax - url: 'atom-file-job://' + __filename - success: (data) -> - content = require('fs').readFileSync __filename - assert.equal data, String(content) - protocol.unregisterProtocol 'atom-file-job' - done() - error: (xhr, errorType, error) -> - assert false, 'Got error: ' + errorType + ' ' + error - protocol.unregisterProtocol 'atom-file-job' - - it 'returns RequestFileJob should send file from asar archive', (done) -> - p = path.join __dirname, 'fixtures', 'asar', 'a.asar', 'file1' - job = new protocol.RequestFileJob(p) - handler = remote.createFunctionWithReturnValue job - protocol.registerProtocol 'atom-file-job', handler - - $.ajax - url: 'atom-file-job://' + p - success: (data) -> - content = require('fs').readFileSync(p) - assert.equal data, String(content) - protocol.unregisterProtocol 'atom-file-job' - done() - error: (xhr, errorType, error) -> - assert false, 'Got error: ' + errorType + ' ' + error - protocol.unregisterProtocol 'atom-file-job' - - it 'returns RequestFileJob should send file from asar archive with unpacked file', (done) -> - p = path.join __dirname, 'fixtures', 'asar', 'unpack.asar', 'a.txt' - job = new protocol.RequestFileJob(p) - handler = remote.createFunctionWithReturnValue job - protocol.registerProtocol 'atom-file-job', handler - - $.ajax - url: 'atom-file-job://' + p - success: (response) -> - data = require('fs').readFileSync(p) - assert.equal response.length, data.length - buf = new Buffer(response.length) - buf.write(response) - assert buf.equals(data) - protocol.unregisterProtocol 'atom-file-job' - done() - error: (xhr, errorType, error) -> - assert false, 'Got error: ' + errorType + ' ' + error - protocol.unregisterProtocol 'atom-file-job' + it 'fails when sending unsupported content', (done) -> + handler = (request, callback) -> callback(new Date) + protocol.registerHttpProtocol protocolName, handler, (error) -> + $.ajax + url: "#{protocolName}://fake-host" + success: (data) -> + done('request succeeded but it should not') + error: (xhr, errorType, error) -> + assert.equal errorType, 'error' + done() describe 'protocol.isHandledProtocol', -> - it 'returns true if the file scheme can be handled', (done) -> + it 'returns true for file:', (done) -> protocol.isHandledProtocol 'file', (result) -> assert.equal result, true done() - it 'returns true if the http scheme can be handled', (done) -> + + it 'returns true for http:', (done) -> protocol.isHandledProtocol 'http', (result) -> assert.equal result, true done() - it 'returns true if the https scheme can be handled', (done) -> + + it 'returns true for https:', (done) -> protocol.isHandledProtocol 'https', (result) -> assert.equal result, true done() - it 'returns false if the atom scheme cannot be handled', (done) -> + + it 'returns false when scheme is not registred', (done) -> protocol.isHandledProtocol 'atom', (result) -> assert.equal result, false done() - - describe 'protocol.interceptProtocol', -> - it 'throws error when scheme is not a registered one', (done) -> - protocol.interceptProtocol 'test-intercept', ( ->), (error, scheme) -> - if error? - assert.equal scheme, 'test-intercept' - done() - - it 'throws error when scheme is a custom protocol', (done) -> - protocol.once 'unregistered', (scheme) -> - assert.equal scheme, 'atom' - done() - protocol.once 'registered', (scheme) -> - assert.equal scheme, 'atom' - protocol.interceptProtocol 'test-intercept', (->), (error, newScheme) -> - if error? - assert.equal newScheme, 'test-intercept' - protocol.unregisterProtocol scheme - protocol.registerProtocol('atom', ->) - - it 'returns original job when callback returns nothing', (done) -> - targetScheme = 'file' - protocol.once 'intercepted', (scheme) -> - assert.equal scheme, targetScheme - free = -> protocol.uninterceptProtocol targetScheme - $.ajax - url: "#{targetScheme}://#{__filename}", - success: -> - protocol.once 'unintercepted', (scheme) -> - assert.equal scheme, targetScheme - done() - free() - error: (xhr, errorType, error) -> - free() - assert false, 'Got error: ' + errorType + ' ' + error - protocol.interceptProtocol targetScheme, (request) -> - if process.platform is 'win32' - pathInUrl = path.normalize request.url.substr(8) - assert.equal pathInUrl.toLowerCase(), __filename.toLowerCase() - else - assert.equal request.url, "#{targetScheme}://#{__filename}" - - it 'can override original protocol handler', (done) -> - handler = remote.createFunctionWithReturnValue 'valar morghulis' - protocol.once 'intercepted', -> - free = -> protocol.uninterceptProtocol 'file' - $.ajax - url: 'file://fake-host' - success: (data) -> - protocol.once 'unintercepted', -> - assert.equal data, handler() - done() - free() - error: (xhr, errorType, error) -> - assert false, 'Got error: ' + errorType + ' ' + error - free() - protocol.interceptProtocol 'file', handler - - it 'can override http protocol handler', (done) -> - handler = remote.createFunctionWithReturnValue 'valar morghulis' - protocol.once 'intercepted', -> - protocol.uninterceptProtocol 'http' - done() - protocol.interceptProtocol 'http', handler - - it 'can override https protocol handler', (done) -> - handler = remote.createFunctionWithReturnValue 'valar morghulis' - protocol.once 'intercepted', -> - protocol.uninterceptProtocol 'https' - done() - protocol.interceptProtocol 'https', handler - - it 'can override ws protocol handler', (done) -> - handler = remote.createFunctionWithReturnValue 'valar morghulis' - protocol.once 'intercepted', -> - protocol.uninterceptProtocol 'ws' - done() - protocol.interceptProtocol 'ws', handler - - it 'can override wss protocol handler', (done) -> - handler = remote.createFunctionWithReturnValue 'valar morghulis' - protocol.once 'intercepted', -> - protocol.uninterceptProtocol 'wss' - done() - protocol.interceptProtocol 'wss', handler diff --git a/spec/static/main.js b/spec/static/main.js index 601926716e96..4eb415dab222 100644 --- a/spec/static/main.js +++ b/spec/static/main.js @@ -135,7 +135,7 @@ app.on('ready', function() { app.setApplicationMenu(menu); // Test if using protocol module would crash. - require('protocol').registerProtocol('test-if-crashes', function() {}); + require('protocol').registerStringProtocol('test-if-crashes', function() {}); window = new BrowserWindow({ title: 'Electron Tests', From a88f951b2f86aee7c6a47ca1977cc93aaf229f6e Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 13 Aug 2015 22:26:27 +0800 Subject: [PATCH 0873/1293] Always set headers for response When intercepting HTTP protocols Chromium will assume there is always headers set, so we have to provide headers for all the responses to avoid the crash. --- atom/browser/net/js_asker.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/atom/browser/net/js_asker.h b/atom/browser/net/js_asker.h index 63b3199890c6..9c45446abcbb 100644 --- a/atom/browser/net/js_asker.h +++ b/atom/browser/net/js_asker.h @@ -11,6 +11,7 @@ #include "base/values.h" #include "content/public/browser/browser_thread.h" #include "net/base/net_errors.h" +#include "net/http/http_response_headers.h" #include "net/url_request/url_request_context_getter.h" #include "net/url_request/url_request_job.h" #include "v8/include/v8.h" @@ -71,6 +72,9 @@ class JsAsker : public RequestJob { base::Bind(&JsAsker::OnResponse, weak_factory_.GetWeakPtr()))); } + void GetResponseInfo(net::HttpResponseInfo* info) override { + info->headers = new net::HttpResponseHeaders(""); + } // Called when the JS handler has sent the response, we need to decide whether // to start, or fail the job. From 62d5c89f62b9b66592e679003fbef822388aa008 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 13 Aug 2015 22:39:11 +0800 Subject: [PATCH 0874/1293] spec: Rewrite tests for new protocol API --- spec/api-protocol-spec.coffee | 109 ++++++++++++++++++++++++++++++---- 1 file changed, 97 insertions(+), 12 deletions(-) diff --git a/spec/api-protocol-spec.coffee b/spec/api-protocol-spec.coffee index f42ce17287b1..f540a63ec406 100644 --- a/spec/api-protocol-spec.coffee +++ b/spec/api-protocol-spec.coffee @@ -9,13 +9,8 @@ describe 'protocol module', -> text = 'valar morghulis' afterEach (done) -> - protocol.unregisterProtocol protocolName, -> done() - - describe 'protocol.unregisterProtocol', -> - it 'returns error when scheme does not exist', (done) -> - protocol.unregisterProtocol 'not-exist', (error) -> - assert.notEqual error, null - done() + protocol.unregisterProtocol protocolName, -> + protocol.uninterceptProtocol 'http', -> done() describe 'protocol.register(Any)Protocol', -> emptyHandler = (request, callback) -> callback() @@ -61,6 +56,12 @@ describe 'protocol module', -> error: (xhr, errorType, error) -> done(error) + describe 'protocol.unregisterProtocol', -> + it 'returns error when scheme does not exist', (done) -> + protocol.unregisterProtocol 'not-exist', (error) -> + assert.notEqual error, null + done() + describe 'protocol.registerStringProtocol', -> it 'sends string as response', (done) -> handler = (request, callback) -> callback(text) @@ -235,23 +236,107 @@ describe 'protocol module', -> assert.equal errorType, 'error' done() - describe 'protocol.isHandledProtocol', -> + describe 'protocol.isProtocolHandled', -> it 'returns true for file:', (done) -> - protocol.isHandledProtocol 'file', (result) -> + protocol.isProtocolHandled 'file', (result) -> assert.equal result, true done() it 'returns true for http:', (done) -> - protocol.isHandledProtocol 'http', (result) -> + protocol.isProtocolHandled 'http', (result) -> assert.equal result, true done() it 'returns true for https:', (done) -> - protocol.isHandledProtocol 'https', (result) -> + protocol.isProtocolHandled 'https', (result) -> assert.equal result, true done() it 'returns false when scheme is not registred', (done) -> - protocol.isHandledProtocol 'atom', (result) -> + protocol.isProtocolHandled 'no-exist', (result) -> assert.equal result, false done() + + it 'returns true for custom protocol', (done) -> + emptyHandler = (request, callback) -> callback() + protocol.registerStringProtocol protocolName, emptyHandler, (error) -> + assert.equal error, null + protocol.isProtocolHandled protocolName, (result) -> + assert.equal result, true + done() + + it 'returns true for intercepted protocol', (done) -> + emptyHandler = (request, callback) -> callback() + protocol.interceptStringProtocol 'http', emptyHandler, (error) -> + assert.equal error, null + protocol.isProtocolHandled 'http', (result) -> + assert.equal result, true + done() + + describe 'protocol.intercept(Any)Protocol', -> + emptyHandler = (request, callback) -> callback() + + it 'throws error when scheme is already intercepted', (done) -> + protocol.interceptStringProtocol 'http', emptyHandler, (error) -> + assert.equal error, null + protocol.interceptBufferProtocol 'http', emptyHandler, (error) -> + assert.notEqual error, null + done() + + it 'does not crash when handler is called twice', (done) -> + doubleHandler = (request, callback) -> + callback(text) + callback() + protocol.interceptStringProtocol 'http', doubleHandler, (error) -> + $.ajax + url: 'http://fake-host' + success: (data) -> + assert.equal data, text + done() + error: (xhr, errorType, error) -> + done(error) + + it 'sends error when callback is called with nothing', (done) -> + protocol.interceptBufferProtocol 'http', emptyHandler, (error) -> + $.ajax + url: 'http://fake-host' + success: (data) -> + done('request succeeded but it should not') + error: (xhr, errorType, error) -> + assert.equal errorType, 'error' + done() + + describe 'protocol.interceptStringProtocol', -> + it 'can intercept http protocol', (done) -> + handler = (request, callback) -> callback(text) + protocol.interceptStringProtocol 'http', handler, (error) -> + $.ajax + url: 'http://fake-host' + success: (data) -> + assert.equal data, text + done() + error: (xhr, errorType, error) -> + done(error) + + describe 'protocol.interceptBufferProtocol', -> + it 'can intercept http protocol', (done) -> + handler = (request, callback) -> callback(new Buffer(text)) + protocol.interceptBufferProtocol 'http', handler, (error) -> + $.ajax + url: 'http://fake-host' + success: (data) -> + assert.equal data, text + done() + error: (xhr, errorType, error) -> + done(error) + + describe 'protocol.uninterceptProtocol', -> + it 'returns error when scheme does not exist', (done) -> + protocol.uninterceptProtocol 'not-exist', (error) -> + assert.notEqual error, null + done() + + it 'returns error when scheme is not intercepted', (done) -> + protocol.uninterceptProtocol 'http', (error) -> + assert.notEqual error, null + done() From 86eb0a5eaabdac9c1724078ba8e77b5cfd5f96bf Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 14 Aug 2015 12:40:03 +0800 Subject: [PATCH 0875/1293] Create both Uint8Array and ArrayBuffer from blink --- atom/renderer/atom_renderer_client.cc | 42 +++++++++++++++++++++------ vendor/node | 2 +- 2 files changed, 34 insertions(+), 10 deletions(-) diff --git a/atom/renderer/atom_renderer_client.cc b/atom/renderer/atom_renderer_client.cc index af526df9f75e..04a89fed3889 100644 --- a/atom/renderer/atom_renderer_client.cc +++ b/atom/renderer/atom_renderer_client.cc @@ -7,6 +7,7 @@ #include #include "atom/common/api/atom_bindings.h" +#include "atom/common/native_mate_converters/callback.h" #include "atom/common/node_bindings.h" #include "atom/common/options_switches.h" #include "atom/renderer/atom_render_view_observer.h" @@ -19,6 +20,8 @@ #include "content/public/renderer/render_frame.h" #include "content/public/renderer/render_frame_observer.h" #include "content/public/renderer/render_thread.h" +#include "third_party/WebKit/public/web/WebArrayBuffer.h" +#include "third_party/WebKit/public/web/WebArrayBufferConverter.h" #include "third_party/WebKit/public/web/WebCustomElement.h" #include "third_party/WebKit/public/web/WebLocalFrame.h" #include "third_party/WebKit/public/web/WebPluginParams.h" @@ -53,15 +56,35 @@ bool IsGuestFrame(blink::WebFrame* frame) { return frame->uniqueName().utf8() == "ATOM_SHELL_GUEST_WEB_VIEW"; } -void* BlinkAllocate(size_t size) { - void* ptr = nullptr; - WTF::ArrayBufferContents::allocateMemory( - size, WTF::ArrayBufferContents::DontInitialize, ptr); - return ptr; +// global.Uint8Array; +v8::Local GetUint8ArrayConstructor( + v8::Isolate* isolate, v8::Local context) { + v8::Local constructor = context->Global()->Get( + mate::StringToV8(isolate, "Uint8Array")); + return v8::Local::Cast(constructor); } -void BlinkFree(void* ptr, size_t size) { - WTF::ArrayBufferContents::freeMemory(ptr, size); +// new ArrayBuffer(size); +v8::Local BlinkArrayBufferCreate( + v8::Isolate* isolate, size_t size) { + blink::WebArrayBuffer buffer = blink::WebArrayBuffer::create(size, 1); + return v8::Local::Cast( + blink::WebArrayBufferConverter::toV8Value( + &buffer, isolate->GetCurrentContext()->Global(), isolate)); +} + +// new Uint8Array(array_buffer, offset, size); +v8::Local BlinkUint8ArrayCreate( + v8::Local ab, size_t offset, size_t size) { + v8::Local context = ab->CreationContext(); + v8::Isolate* isolate = context->GetIsolate(); + v8::Local constructor = + GetUint8ArrayConstructor(isolate, context); + v8::Local args[] = { + ab, mate::ConvertToV8(isolate, offset), mate::ConvertToV8(isolate, size) + }; + return v8::Local::Cast(constructor->NewInstance( + context, arraysize(args), args).ToLocalChecked()); } // Helper class to forward the messages to the client. @@ -103,8 +126,9 @@ void AtomRendererClient::WebKitInitialized() { blink::WebCustomElement::addEmbedderCustomElementName("webview"); blink::WebCustomElement::addEmbedderCustomElementName("browserplugin"); - // Override Node's Buffer allocator with WTF's allocator. - node::Buffer::SetAllocator(&BlinkAllocate, &BlinkFree); + // Override Node's ArrayBuffer with DOM's ArrayBuffer. + node::Buffer::SetArrayBufferCreator(&BlinkArrayBufferCreate, + &BlinkUint8ArrayCreate); node_bindings_->Initialize(); node_bindings_->PrepareMessageLoop(); diff --git a/vendor/node b/vendor/node index 6472143e3643..81645132a9d3 160000 --- a/vendor/node +++ b/vendor/node @@ -1 +1 @@ -Subproject commit 6472143e364343f73ee6a9e1b67902cc5c30f7ef +Subproject commit 81645132a9d3dfadb6404714e208d3b419f878ea From 7d97bb6fe0a6feef886d927ea894bcb2f3521577 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 14 Aug 2015 13:44:18 +0800 Subject: [PATCH 0876/1293] docs: Rewrite docs for new protocol API --- docs/api/protocol.md | 205 +++++++++++++++++++++++-------------------- 1 file changed, 112 insertions(+), 93 deletions(-) diff --git a/docs/api/protocol.md b/docs/api/protocol.md index 03e979615fe2..a256bf30a73d 100644 --- a/docs/api/protocol.md +++ b/docs/api/protocol.md @@ -1,7 +1,7 @@ # protocol -The `protocol` module can register a new protocol or intercept an existing -protocol, so you can customize the response to the requests for various protocols. +The `protocol` module can register a custom protocol or intercept an existing +protocol. An example of implementing a protocol that has the same effect with the `file://` protocol: @@ -12,130 +12,149 @@ var path = require('path'); app.on('ready', function() { var protocol = require('protocol'); - protocol.registerProtocol('atom', function(request) { - var url = request.url.substr(7) - return new protocol.RequestFileJob(path.normalize(__dirname + '/' + url)); - }, function (error, scheme) { - if (!error) - console.log(scheme, ' registered successfully') + protocol.registerFileProtocol('atom', function(request, callback) { + var url = request.url.substr(7); + callback({path: path.normalize(__dirname + '/' + url)}); + }, function (error) { + if (error) + console.error('Failed to register protocol') }); }); ``` -**Note:** This module can only be used after the `ready` event -was emitted. +**Note:** This module can only be used after the `ready` event was emitted. -## protocol.registerProtocol(scheme, handler, callback) +## protocol.registerStandardSchemes(schemes) + +* `schemes` Array - Custom schemes to be registered as standard schemes. + +A standard scheme adheres to what RFC 3986 calls +[generic URI syntax](https://tools.ietf.org/html/rfc3986#section-3). This +includes `file:` and `filesystem:`. + +## protocol.registerFileProtocol(scheme, handler[, completion]) * `scheme` String * `handler` Function -* `callback` Function +* `completion` Function -Registers a custom protocol of `scheme`, the `handler` would be called with -`handler(request)` when the a request with registered `scheme` is made. +Registers a protocol of `scheme` that will send file as response, the `handler` +will be called with `handler(request, callback)` when a `request` is going to be +created with `scheme`, and `completion` will be called with `completion(null)` +when `scheme` is successfully registered, or `completion(error)` when failed. -You need to return a request job in the `handler` to specify which type of -response you would like to send. +To handle the `request`, the `callback` should be called with either file's path +or an object that has `path` property, e.g. `callback(filePath)` or +`callback({path: filePath})`. + +When `callback` is called with nothing, or a number, or an object that has +`error` property, the `request` will be failed with the `error` number you +specified. For the available error numbers you can use, please check: +https://code.google.com/p/chromium/codesearch#chromium/src/net/base/net_error_list.h By default the scheme is treated like `http:`, which is parsed differently from protocols that follows "generic URI syntax" like `file:`, so you probably want to call `protocol.registerStandardSchemes` to make your scheme treated as standard scheme. -## protocol.unregisterProtocol(scheme, callback) +## protocol.registerBufferProtocol(scheme, handler[, completion]) * `scheme` String -* `callback` Function +* `handler` Function +* `completion` Function + +Registers a protocol of `scheme` that will send `Buffer` as response, the +`callback` should be called with either an `Buffer` object, or an object that +has `data`, `mimeType`, `chart` properties. + +Example: + +```javascript +protocol.registerBufferProtocol('atom', function(request, callback) { + callback({mimeType: 'text/html', data: new Buffer('
Response
')}); +}, function (error) { + if (error) + console.error('Failed to register protocol') +}); +``` + +## protocol.registerStringProtocol(scheme, handler[, completion]) + +* `scheme` String +* `handler` Function +* `completion` Function + +Registers a protocol of `scheme` that will send `String` as response, the +`callback` should be called with either a `String`, or an object that +has `data`, `mimeType`, `chart` properties. + +## protocol.registerHttpProtocol(scheme, handler[, completion]) + +* `scheme` String +* `handler` Function +* `completion` Function + +Registers a protocol of `scheme` that will send a HTTP request as response, the +`callback` should be called with an object that has `url`, `method`, `referer`, +`session` properties. + +By default the HTTP request will reuse current session, if you want the request +to have different session you should specify `session` to `null`. + +## protocol.unregisterProtocol(scheme[, completion]) + +* `scheme` String +* `completion` Function Unregisters the custom protocol of `scheme`. -## protocol.registerStandardSchemes(value) - -* `value` Array - -`value` is an array of custom schemes to be registered as standard schemes. - -A standard scheme adheres to what RFC 3986 calls -[generic URI syntax](https://tools.ietf.org/html/rfc3986#section-3). This -includes `file:` and `filesystem:`. - -## protocol.isHandledProtocol(scheme, callback) +## protocol.isProtocolHandled(scheme, callback) * `scheme` String * `callback` Function -`callback` returns a boolean whether the `scheme` can be handled already. +The `callback` will be called with a boolean that indicates whether there is +already a handler for `scheme`. -## protocol.interceptProtocol(scheme, handler, callback) +## protocol.interceptFileProtocol(scheme, handler[, completion]) * `scheme` String * `handler` Function * `callback` Function -Intercepts an existing protocol with `scheme`, returning `null` or `undefined` -in `handler` would use the original protocol handler to handle the request. +Intercepts `scheme` protocol and use `handler` as the protocol's new handler +which sends file as response. -## protocol.uninterceptProtocol(scheme, callback) +## protocol.interceptStringProtocol(scheme, handler[, completion]) + +* `scheme` String +* `handler` Function +* `callback` Function + +Intercepts `scheme` protocol and use `handler` as the protocol's new handler +which sends String as response. + +## protocol.interceptBufferProtocol(scheme, handler[, completion]) + +* `scheme` String +* `handler` Function +* `callback` Function + +Intercepts `scheme` protocol and use `handler` as the protocol's new handler +which sends `Buffer` as response. + +## protocol.interceptHttpProtocol(scheme, handler[, completion]) + +* `scheme` String +* `handler` Function +* `callback` Function + +Intercepts `scheme` protocol and use `handler` as the protocol's new handler +which sends a new HTTP request as response. + +## protocol.uninterceptProtocol(scheme[, completion]) * `scheme` String * `callback` Function -Unintercepts a protocol. - -## Class: protocol.RequestFileJob(path) - -* `path` String - -Create a request job which would query a file of `path` and set corresponding -mime types. - -## Class: protocol.RequestStringJob(options) - -* `options` Object - * `mimeType` String - Default is `text/plain` - * `charset` String - Default is `UTF-8` - * `data` String - -Create a request job which sends a string as response. - -## Class: protocol.RequestBufferJob(options) - -* `options` Object - * `mimeType` String - Default is `application/octet-stream` - * `encoding` String - Default is `UTF-8` - * `data` Buffer - -Create a request job which sends a buffer as response. - -## Class: protocol.RequestHttpJob(options) - -* `options` Object - * `session` [Session](browser-window.md#class-session) - By default it is - the app's default session, setting it to `null` will create a new session - for the requests - * `url` String - * `method` String - Default is `GET` - * `referrer` String - -Send a request to `url` and pipe the response back. - -## Class: protocol.RequestErrorJob(code) - -* `code` Integer - -Create a request job which sets appropriate network error message to console. -Default message is `net::ERR_NOT_IMPLEMENTED`. Code should be in the following -range. - -* Ranges: - * 0- 99 System related errors - * 100-199 Connection related errors - * 200-299 Certificate errors - * 300-399 HTTP errors - * 400-499 Cache errors - * 500-599 ? - * 600-699 FTP errors - * 700-799 Certificate manager errors - * 800-899 DNS resolver errors - -Check the [network error list](https://code.google.com/p/chromium/codesearch#chromium/src/net/base/net_error_list.h) for code and message relations. +Remove the interceptor installed for `scheme` and restore its original handler. From 092f9d2c461b28f26f6bc1c7d206409df0db9a34 Mon Sep 17 00:00:00 2001 From: Olivier Forget Date: Fri, 14 Aug 2015 10:25:18 -0700 Subject: [PATCH 0877/1293] Clarify that MSVS 2015 will not work in Windows build docs. --- docs/development/build-instructions-windows.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/development/build-instructions-windows.md b/docs/development/build-instructions-windows.md index 061011b5a1a4..e090f25832cd 100644 --- a/docs/development/build-instructions-windows.md +++ b/docs/development/build-instructions-windows.md @@ -4,7 +4,7 @@ * Windows 7 / Server 2008 R2 or higher * Visual Studio 2013 - [download VS 2013 Community Edition for - free](http://www.visualstudio.com/products/visual-studio-community-vs) + free](https://www.visualstudio.com/downloads/download-visual-studio-vs) * [Python 2.7](http://www.python.org/download/releases/2.7/) * [Node.js](http://nodejs.org/download/) * [git](http://git-scm.com) @@ -21,6 +21,8 @@ Studio will come in the future. **Note:** Even though Visual Studio is not used for building, it's still **required** because we need the build toolchains it provides. +**Note:** Visual Studio 2015 will not work. Please make sure to get MSVS **2013**. + ## Getting the code ```powershell From 6f25996fa1e4fd8b6db9eb995bb9ebf6d76dd8af Mon Sep 17 00:00:00 2001 From: Eran Tiktin Date: Sun, 16 Aug 2015 23:20:09 +0300 Subject: [PATCH 0878/1293] Fixed typo --- atom/browser/lib/init.coffee | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/atom/browser/lib/init.coffee b/atom/browser/lib/init.coffee index e61323bfdcc0..069eed8d1b53 100644 --- a/atom/browser/lib/init.coffee +++ b/atom/browser/lib/init.coffee @@ -38,7 +38,7 @@ process.on 'uncaughtException', (error) -> # Show error in GUI. stack = error.stack ? "#{error.name}: #{error.message}" message = "Uncaught Exception:\n#{stack}" - require('dialog').showErrorBox 'A JavaScript error occured in the main process', message + require('dialog').showErrorBox 'A JavaScript error occurred in the main process', message # Emit 'exit' event on quit. app = require 'app' From 763dcc545dc7b0d3abeda94fcb1a51be3f82e475 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Mon, 17 Aug 2015 13:20:36 +0800 Subject: [PATCH 0879/1293] Correct generation of GUID on Windows. --- atom/browser/ui/win/notify_icon.cc | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/atom/browser/ui/win/notify_icon.cc b/atom/browser/ui/win/notify_icon.cc index 962dc871b5b6..48d0f875bcd0 100644 --- a/atom/browser/ui/win/notify_icon.cc +++ b/atom/browser/ui/win/notify_icon.cc @@ -39,6 +39,16 @@ NotifyIcon::NotifyIcon(NotifyIconHost* host, base::MD5Sum(explicit_app_id, sizeof(wchar_t) * wcslen(explicit_app_id), reinterpret_cast(&tray_app_id_hash_)); + + // Set the GUID to version 4 as described in RFC 4122, section 4.4. + // The format of GUID version 4 must be like + // xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx, where y is one of [8, 9, A, B]. + tray_app_id_hash_.Data3 &= 0x0fff; + tray_app_id_hash_.Data3 |= 0x4000; + + // Set y to one of [8, 9, A, B]. + tray_app_id_hash_.Data4[0] = 1; + has_tray_app_id_hash_ = true; CoTaskMemFree(explicit_app_id); } From acffc713e09559955d9f9f33d1d7e3bfde3d64fc Mon Sep 17 00:00:00 2001 From: Petr Felzmann Date: Mon, 17 Aug 2015 10:52:10 +0200 Subject: [PATCH 0880/1293] Fix formatting of print and printToPDF methods --- docs/api/web-view-tag.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/web-view-tag.md b/docs/api/web-view-tag.md index 07d84324dd4b..f8490b624c73 100644 --- a/docs/api/web-view-tag.md +++ b/docs/api/web-view-tag.md @@ -315,11 +315,11 @@ Executes editing command `replace` in page. Executes editing command `replaceMisspelling` in page. -### `.print([options])` +### ``.print([options]) Prints webview's web page. Same with `webContents.print([options])`. -### `.printToPDF(options, callback)` +### ``.printToPDF(options, callback) Prints webview's web page as PDF, Same with `webContents.printToPDF(options, callback)` From 7842a90c5ed299fc13ea2b68d5bf8bd0198fa704 Mon Sep 17 00:00:00 2001 From: Petr Felzmann Date: Mon, 17 Aug 2015 15:03:04 +0200 Subject: [PATCH 0881/1293] Fix absolute url to github --- docs/api/remote.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/api/remote.md b/docs/api/remote.md index b01f47d169c4..0c31d7613529 100644 --- a/docs/api/remote.md +++ b/docs/api/remote.md @@ -20,7 +20,8 @@ var win = new BrowserWindow({ width: 800, height: 600 }); win.loadUrl('https://github.com'); ``` -Note: for the reverse (access renderer process from main process), you can use [webContents.executeJavascript](https://github.com/atom/electron/blob/master/docs/api/browser-window.md#browserwindowwebcontents). +Note: for the reverse (access renderer process from main process), you can use +[webContents.executeJavascript](browser-window.md#webcontents-executejavascript-code). ## Remote objects From 69e1e3c0bdf0dbadd65b3ae048a5c9a38d8aef91 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Tue, 18 Aug 2015 09:28:02 +0800 Subject: [PATCH 0882/1293] Fix a typing error in option checking: printBackgrounds => printBackground --- atom/browser/api/lib/web-contents.coffee | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/atom/browser/api/lib/web-contents.coffee b/atom/browser/api/lib/web-contents.coffee index 06615e31608f..1bb82dec1a66 100644 --- a/atom/browser/api/lib/web-contents.coffee +++ b/atom/browser/api/lib/web-contents.coffee @@ -97,7 +97,7 @@ wrapWebContents = (webContents) -> printingSetting.marginsType = options.marginsType if options.printSelectionOnly printingSetting.shouldPrintSelectionOnly = options.printSelectionOnly - if options.printBackgrounds + if options.printBackground printingSetting.shouldPrintBackgrounds = options.printBackground if options.pageSize and PDFPageSize[options.pageSize] From 129d92b30acc2a778b65dc139f113cf10511c4f7 Mon Sep 17 00:00:00 2001 From: Eran Tiktin Date: Tue, 18 Aug 2015 19:34:14 +0300 Subject: [PATCH 0883/1293] Update browser-window.md Update the `beforeunload` example to use `e.returnValue = false` instead of `return false`, since `e.returnValue` always works while the `return` works only in certain conditions. See #2481 for details. --- docs/api/browser-window.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 612b3ce4f3f0..dda22e586674 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -141,7 +141,7 @@ window.onbeforeunload = function(e) { // prompted to confirm the page unload, Electron gives developers more options. // Returning empty string or false would prevent the unloading now. // You can also use the dialog API to let the user confirm closing the application. - return false; + e.returnValue = false; }; ``` From 4e6dc49646c18cabc7c4d9dadac06578234891ca Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Wed, 19 Aug 2015 09:44:33 +0800 Subject: [PATCH 0884/1293] :memo: Fix a typing error: printBackgrounds => printBackground --- docs/api/browser-window-ko.md | 2 +- docs/api/browser-window.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/browser-window-ko.md b/docs/api/browser-window-ko.md index 38b78459d25a..9b8db778f9be 100644 --- a/docs/api/browser-window-ko.md +++ b/docs/api/browser-window-ko.md @@ -992,7 +992,7 @@ Prints windows' web page as PDF with Chromium's preview printing custom settings. By default, an empty `options` will be regarded as -`{marginsType:0, printBackgrounds:false, printSelectionOnly:false, +`{marginsType:0, printBackground:false, printSelectionOnly:false, landscape:false}`. ```javascript diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index add5cfff8ba9..ed9acb3d0cf3 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -1031,7 +1031,7 @@ Prints windows' web page as PDF with Chromium's preview printing custom settings. By default, an empty `options` will be regarded as -`{marginsType:0, printBackgrounds:false, printSelectionOnly:false, +`{marginsType:0, printBackground:false, printSelectionOnly:false, landscape:false}`. ```javascript From 624b6b97626d9baef48f60b67d84031b0a614870 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Wed, 19 Aug 2015 18:28:48 +0200 Subject: [PATCH 0885/1293] Standardize app.md --- docs/api/app.md | 138 +++++++++++++++++++++++++----------------------- 1 file changed, 72 insertions(+), 66 deletions(-) diff --git a/docs/api/app.md b/docs/api/app.md index 8223643a375f..2a625ec3c18e 100644 --- a/docs/api/app.md +++ b/docs/api/app.md @@ -11,7 +11,11 @@ app.on('window-all-closed', function() { }); ``` -## Event: will-finish-launching +## Events + +The following are events on `app`. + +### Event: 'will-finish-launching' Emitted when the application has finished basic startup. On Windows and Linux, the `will-finish-launching` event is the same as the `ready` event; on OS X, @@ -21,20 +25,20 @@ and start the crash reporter and auto updater. In most cases, you should just do everything in the `ready` event handler. -## Event: ready +### Event: 'ready' Emitted when Electron has finished initialization. -## Event: window-all-closed +### Event: 'window-all-closed' Emitted when all windows have been closed. This event is only emitted when the application is not going to quit. If the -user pressed `Cmd + Q`, or the developer called `app.quit()`, Electron would +user pressed `Cmd + Q`, or the developer called `app.quit()`, Electron will first try to close all the windows and then emit the `will-quit` event, and in this case the `window-all-closed` event would not be emitted. -## Event: before-quit +### Event: 'before-quit' * `event` Event @@ -42,7 +46,7 @@ Emitted before the application starts closing its windows. Calling `event.preventDefault()` will prevent the default behaviour, which is terminating the application. -## Event: will-quit +### Event: 'will-quit' * `event` Event @@ -50,14 +54,13 @@ Emitted when all windows have been closed and the application will quit. Calling `event.preventDefault()` will prevent the default behaviour, which is terminating the application. -See the description of the `window-all-closed` event for the differences between the `will-quit` -and `window-all-closed` events. +See the description of the `window-all-closed` event for the differences between the `will-quit` and `window-all-closed` events. -## Event: quit +### Event: 'quit' Emitted when the application is quitting. -## Event: open-file +### Event: 'open-file' * `event` Event * `path` String @@ -71,7 +74,7 @@ event very early in your application startup to handle this case (even before th You should call `event.preventDefault()` if you want to handle this event. -## Event: open-url +### Event: 'open-url' * `event` Event * `url` String @@ -81,20 +84,20 @@ must be registered to be opened by your application. You should call `event.preventDefault()` if you want to handle this event. -## Event: activate-with-no-open-windows +### Event: 'activate-with-no-open-windows' Emitted when the application is activated while there are no open windows, which usually happens when the user has closed all of the application's windows and then clicks on the application's dock icon. -## Event: browser-window-blur +### Event: 'browser-window-blur' * `event` Event * `window` BrowserWindow Emitted when a [browserWindow](browser-window.md) gets blurred. -## Event: browser-window-focus +### Event: 'browser-window-focus' * `event` Event * `window` BrowserWindow @@ -113,25 +116,28 @@ Emitted when a client certificate is requested. * `issuerName` Issuer's Common Name * `callback` Function -``` +```javascript app.on('select-certificate', function(event, host, url, list, callback) { event.preventDefault(); callback(list[0]); }) ``` -`url` corresponds to the navigation entry requesting the client certificate. -`callback` needs to be called with an entry filtered from the list. -`event.preventDefault()` prevents the application from using the first certificate +The `url` corresponds to the navigation entry requesting the client certificate and `callback` needs to be called with an entry filtered from the list. +Using `event.preventDefault()` prevents the application from using the first certificate from the store. ### Event: 'gpu-process-crashed' Emitted when the gpu process crashes. -## app.quit() +## Methods -Try to close all windows. The `before-quit` event will first be emitted. If all +The following are methods on the `app` class. + +### `app.quit()` + +Try to close all windows. The `before-quit` event will emitted first. If all windows are successfully closed, the `will-quit` event will be emitted and by default the application will terminate. @@ -139,11 +145,11 @@ This method guarantees that all `beforeunload` and `unload` event handlers are c executed. It is possible that a window cancels the quitting by returning `false` in the `beforeunload` event handler. -## app.getAppPath() +### `app.getAppPath()` Returns the current application directory. -## app.getPath(name) +### `app.getPath(name)` * `name` String @@ -152,25 +158,25 @@ failure an `Error` is thrown. You can request the following paths by the name: -* `home`: User's home directory -* `appData`: Per-user application data directory, which by default points to: +* `home` User's home directory. +* `appData` Per-user application data directory, which by default points to: * `%APPDATA%` on Windows * `$XDG_CONFIG_HOME` or `~/.config` on Linux * `~/Library/Application Support` on OS X -* `userData`: The directory for storing your app's configuration files, which by - default it is the `appData` directory appended with your app's name -* `cache`: Per-user application cache directory, which by default points to: +* `userData` The directory for storing your app's configuration files, which by + default it is the `appData` directory appended with your app's name. +* `cache` Per-user application cache directory, which by default points to: * `%APPDATA%` on Windows (which doesn't have a universal cache location) * `$XDG_CACHE_HOME` or `~/.cache` on Linux * `~/Library/Caches` on OS X -* `userCache`: The directory for placing your app's caches, by default it is the - `cache` directory appended with your app's name -* `temp`: Temporary directory -* `userDesktop`: The current user's Desktop directory -* `exe`: The current executable file -* `module`: The `libchromiumcontent` library +* `userCache` The directory for placing your app's caches, by default it is the + `cache` directory appended with your app's name. +* `temp` Temporary directory. +* `userDesktop` The current user's Desktop directory. +* `exe` The current executable file. +* `module` The `libchromiumcontent` library. -## app.setPath(name, path) +### `app.setPath(name, path)` * `name` String * `path` String @@ -179,19 +185,19 @@ Overrides the `path` to a special directory or file associated with `name`. If the path specifies a directory that does not exist, the directory will be created by this method. On failure an `Error` is thrown. -You can only override paths of `name`s defined in `app.getPath`. +You can only override paths of a `name` defined in `app.getPath`. -By default, web pages' cookies and caches will be stored under the `userData` +By default, web pages's cookies and caches will be stored under the `userData` directory. If you want to change this location, you have to override the `userData` path before the `ready` event of the `app` module is emitted. -## app.getVersion() +### `app.getVersion()` Returns the version of the loaded application. If no version is found in the application's `package.json` file, the version of the current bundle or executable is returned. -## app.getName() +### `app.getName()` Returns the current application's name, which is the name in the application's `package.json` file. @@ -201,7 +207,7 @@ to the npm modules spec. You should usually also specify a `productName` field, which is your application's full capitalized name, and which will be preferred over `name` by Electron. -## app.resolveProxy(url, callback) +### `app.resolveProxy(url, callback)` * `url` URL * `callback` Function @@ -209,7 +215,7 @@ preferred over `name` by Electron. Resolves the proxy information for `url`. The `callback` will be called with `callback(proxy)` when the request is performed. -## app.addRecentDocument(path) +### `app.addRecentDocument(path)` * `path` String @@ -218,11 +224,11 @@ Adds `path` to the recent documents list. This list is managed by the OS. On Windows you can visit the list from the task bar, and on OS X you can visit it from dock menu. -## app.clearRecentDocuments() +### `app.clearRecentDocuments()` Clears the recent documents list. -## app.setUserTasks(tasks) +### `app.setUserTasks(tasks)` * `tasks` Array - Array of `Task` objects @@ -230,36 +236,36 @@ Adds `tasks` to the [Tasks][tasks] category of the JumpList on Windows. `tasks` is an array of `Task` objects in following format: -* `Task` Object - * `program` String - Path of the program to execute, usually you should - specify `process.execPath` which opens the current program - * `arguments` String - The command line arguments when `program` is - executed - * `title` String - The string to be displayed in a JumpList - * `description` String - Description of this task - * `iconPath` String - The absolute path to an icon to be displayed in a - JumpList, which can be an arbitrary resource file that contains an icon. You can - usually specify `process.execPath` to show the icon of the program - * `iconIndex` Integer - The icon index in the icon file. If an icon file - consists of two or more icons, set this value to identify the icon. If an - icon file consists of one icon, this value is 0 +`Task` Object +* `program` String - Path of the program to execute, usually you should + specify `process.execPath` which opens the current program. +* `arguments` String - The command line arguments when `program` is + executed. +* `title` String - The string to be displayed in a JumpList. +* `description` String - Description of this task. +* `iconPath` String - The absolute path to an icon to be displayed in a + JumpList, which can be an arbitrary resource file that contains an icon. You can + usually specify `process.execPath` to show the icon of the program. +* `iconIndex` Integer - The icon index in the icon file. If an icon file + consists of two or more icons, set this value to identify the icon. If an + icon file consists of one icon, this value is 0. **Note:** This API is only available on Windows. -## app.commandLine.appendSwitch(switch, [value]) +### `app.commandLine.appendSwitch(switch[, value])` -Append a switch [with optional value] to Chromium's command line. +Append a switch (with optional `value`) to Chromium's command line. **Note:** This will not affect `process.argv`, and is mainly used by developers to control some low-level Chromium behaviors. -## app.commandLine.appendArgument(value) +### `app.commandLine.appendArgument(value)` Append an argument to Chromium's command line. The argument will be quoted correctly. **Note:** This will not affect `process.argv`. -## app.dock.bounce([type]) +### app.dock.bounce([type]) * `type` String - Can be `critical` or `informational`. The default is `informational` @@ -271,11 +277,11 @@ When `informational` is passed, the dock icon will bounce for one second. Howeve the request remains active until either the application becomes active or the request is canceled. -An ID representing the request is returned. +Returns an ID representing the request. **Note:** This API is only available on OS X. -## app.dock.cancelBounce(id) +### `app.dock.cancelBounce(id)` * `id` Integer @@ -283,7 +289,7 @@ Cancel the bounce of `id`. **Note:** This API is only available on OS X. -## app.dock.setBadge(text) +### `app.dock.setBadge(text)` * `text` String @@ -291,25 +297,25 @@ Sets the string to be displayed in the dock’s badging area. **Note:** This API is only available on OS X. -## app.dock.getBadge() +### `app.dock.getBadge()` Returns the badge string of the dock. **Note:** This API is only available on OS X. -## app.dock.hide() +### `app.dock.hide()` Hides the dock icon. **Note:** This API is only available on OS X. -## app.dock.show() +### `app.dock.show()` Shows the dock icon. **Note:** This API is only available on OS X. -## app.dock.setMenu(menu) +### `app.dock.setMenu(menu)` * `menu` Menu From 714745cdd7add683c54ad6bf2e1e82914aef3eae Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Wed, 19 Aug 2015 18:51:36 +0200 Subject: [PATCH 0886/1293] Add 'returns' and change h2 descriptions --- docs/api/app.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/docs/api/app.md b/docs/api/app.md index 2a625ec3c18e..6a54dba3021a 100644 --- a/docs/api/app.md +++ b/docs/api/app.md @@ -13,7 +13,7 @@ app.on('window-all-closed', function() { ## Events -The following are events on `app`. +The `app` object emits the following events: ### Event: 'will-finish-launching' @@ -40,6 +40,8 @@ this case the `window-all-closed` event would not be emitted. ### Event: 'before-quit' +Returns: + * `event` Event Emitted before the application starts closing its windows. @@ -48,6 +50,8 @@ terminating the application. ### Event: 'will-quit' +Returns: + * `event` Event Emitted when all windows have been closed and the application will quit. @@ -62,6 +66,8 @@ Emitted when the application is quitting. ### Event: 'open-file' +Returns: + * `event` Event * `path` String @@ -76,6 +82,8 @@ You should call `event.preventDefault()` if you want to handle this event. ### Event: 'open-url' +Returns: + * `event` Event * `url` String @@ -92,6 +100,8 @@ clicks on the application's dock icon. ### Event: 'browser-window-blur' +Returns: + * `event` Event * `window` BrowserWindow @@ -99,6 +109,8 @@ Emitted when a [browserWindow](browser-window.md) gets blurred. ### Event: 'browser-window-focus' +Returns: + * `event` Event * `window` BrowserWindow @@ -108,6 +120,8 @@ Emitted when a [browserWindow](browser-window.md) gets focused. Emitted when a client certificate is requested. +Returns: + * `event` Event * `webContents` [WebContents](browser-window.md#class-webcontents) * `url` String @@ -133,7 +147,7 @@ Emitted when the gpu process crashes. ## Methods -The following are methods on the `app` class. +The `app` object has the following methods: ### `app.quit()` From 454413f69ab6a33e9bc6baa7429390246ed529f0 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Wed, 19 Aug 2015 18:55:11 +0200 Subject: [PATCH 0887/1293] Standardize auto-updater.md --- docs/api/auto-updater.md | 28 ++++++++++++++++++++-------- 1 file changed, 20 insertions(+), 8 deletions(-) diff --git a/docs/api/auto-updater.md b/docs/api/auto-updater.md index 5274fc6c467e..b2ebcc40a447 100644 --- a/docs/api/auto-updater.md +++ b/docs/api/auto-updater.md @@ -1,4 +1,4 @@ -# auto-updater +# autoUpdater **This module has only been implemented for OS X.** @@ -98,27 +98,35 @@ appropriate format. `pub_date` (if present) must be formatted according to ISO 8601. -## Event: error +## Events + +The `autoUpdater` object emits the following events: + +### Event: 'error' + +Returns: * `event` Event * `message` String Emitted when there is an error while updating. -## Event: checking-for-update +### Event: 'checking-for-update' Emitted when checking if an update has started. -## Event: update-available +### Event: 'update-available' Emitted when there is an available update. The update is downloaded automatically. -## Event: update-not-available +### Event: 'update-not-available' Emitted when there is no available update. -## Event: update-downloaded +### Event: 'update-downloaded' + +Returns: * `event` Event * `releaseNotes` String @@ -130,14 +138,18 @@ Emitted when there is no available update. Emitted when an update has been downloaded. Calling `quitAndUpdate()` will restart the application and install the update. -## autoUpdater.setFeedUrl(url) +## Methods + +The `autoUpdater` object has the following methods: + +### `autoUpdater.setFeedUrl(url)` * `url` String Set the `url` and initialize the auto updater. The `url` cannot be changed once it is set. -## autoUpdater.checkForUpdates() +### `autoUpdater.checkForUpdates()` Ask the server whether there is an update. You must call `setFeedUrl` before using this API. From 172cc22d90a9f14694496bfc842370e9914dc9bb Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Thu, 20 Aug 2015 07:50:07 +0900 Subject: [PATCH 0888/1293] Fix some typos, update as upstream --- docs/api/remote-ko.md | 2 +- docs/api/web-view-tag-ko.md | 8 ++++++++ docs/development/build-instructions-linux-ko.md | 8 ++++++++ docs/development/build-instructions-mac-ko.md | 8 ++++++++ docs/development/build-instructions-windows-ko.md | 8 ++++++++ docs/tutorial/desktop-environment-integration-ko.md | 1 + 6 files changed, 34 insertions(+), 1 deletion(-) diff --git a/docs/api/remote-ko.md b/docs/api/remote-ko.md index a28ce31d1a10..47e05b9e16d0 100644 --- a/docs/api/remote-ko.md +++ b/docs/api/remote-ko.md @@ -19,7 +19,7 @@ var win = new BrowserWindow({ width: 800, height: 600 }); win.loadUrl('https://github.com'); ``` -Note: for the reverse (access renderer process from main process), you can use [webContents.executeJavascript](https://github.com/atom/electron/blob/master/docs/api/browser-window-ko.md#browserwindowwebcontents). +Note: for the reverse (access renderer process from main process), you can use [webContents.executeJavascript](browser-window.md#webcontents-executejavascript-code). ## Remote 객체 diff --git a/docs/api/web-view-tag-ko.md b/docs/api/web-view-tag-ko.md index 1feb3ec1555f..32a5a835516f 100644 --- a/docs/api/web-view-tag-ko.md +++ b/docs/api/web-view-tag-ko.md @@ -296,6 +296,14 @@ Service worker에 대한 개발자 툴을 엽니다. 페이지에서 `replaceMisspelling` 커맨드를 실행합니다. +### ``.print([options]) + +Webview 페이지를 인쇄합니다. `webContents.print([options])` 메서드와 같습니다. + +### ``.printToPDF(options, callback) + +Webview 페이지를 PDF 형식으로 인쇄합니다. `webContents.printToPDF(options, callback)` 메서드와 같습니다. + ### ``.send(channel[, args...]) * `channel` String diff --git a/docs/development/build-instructions-linux-ko.md b/docs/development/build-instructions-linux-ko.md index 520ebc302503..285b933dd921 100644 --- a/docs/development/build-instructions-linux-ko.md +++ b/docs/development/build-instructions-linux-ko.md @@ -109,6 +109,14 @@ $ sudo ln -s /usr/lib/libncurses.so.5 /usr/lib/libtinfo.so.5 ## 테스트 +프로젝트 코딩 스타일을 확인하려면: + +```bash +$ ./script/cpplint.py +``` + +테스트를 실행하려면: + ```bash $ ./script/test.py ``` diff --git a/docs/development/build-instructions-mac-ko.md b/docs/development/build-instructions-mac-ko.md index 6608c2e45266..ffab481c5c7c 100644 --- a/docs/development/build-instructions-mac-ko.md +++ b/docs/development/build-instructions-mac-ko.md @@ -48,6 +48,14 @@ Electron은 현재 OS X 64비트 빌드만 지원하고 있습니다. 그리고 ## 테스트 +프로젝트 코딩 스타일을 확인하려면: + +```bash +$ ./script/cpplint.py +``` + +테스트를 실행하려면: + ```bash $ ./script/test.py ``` diff --git a/docs/development/build-instructions-windows-ko.md b/docs/development/build-instructions-windows-ko.md index ec582ed3a290..eb1283e7c4bc 100644 --- a/docs/development/build-instructions-windows-ko.md +++ b/docs/development/build-instructions-windows-ko.md @@ -60,6 +60,14 @@ python script\bootstrap.py -v --target_arch=x64 ## 테스트 +프로젝트 코딩 스타일을 확인하려면: + +```powershell +python script\cpplint.py +``` + +테스트를 실행하려면: + ```powershell python script\test.py ``` diff --git a/docs/tutorial/desktop-environment-integration-ko.md b/docs/tutorial/desktop-environment-integration-ko.md index cb6d66a56477..68f5562dbb52 100644 --- a/docs/tutorial/desktop-environment-integration-ko.md +++ b/docs/tutorial/desktop-environment-integration-ko.md @@ -219,3 +219,4 @@ window.setDocumentEdited(true); [setdocumentedited]: ../api/browser-window-ko.md#browserwindowsetdocumenteditededited [app-registration]: http://msdn.microsoft.com/en-us/library/windows/desktop/ee872121(v=vs.85).aspx [unity-launcher]: https://help.ubuntu.com/community/UnityLaunchersAndDesktopFiles#Adding_shortcuts_to_a_launcher +[setthumbarbuttons]: ../api/browser-window.md#browserwindowsetthumbarbuttonsbuttons From f386342a7caca3cda3f7065f18fc6930897e1ec1 Mon Sep 17 00:00:00 2001 From: Eran Tiktin Date: Thu, 20 Aug 2015 19:26:20 +0300 Subject: [PATCH 0889/1293] Fix memory leak and confirming to style guide Fixed according to @hokein 's suggestions. --- atom/common/api/atom_api_native_image.cc | 39 ++++++++++++------------ 1 file changed, 20 insertions(+), 19 deletions(-) diff --git a/atom/common/api/atom_api_native_image.cc b/atom/common/api/atom_api_native_image.cc index 6d15331c5e9e..f36e675fb981 100644 --- a/atom/common/api/atom_api_native_image.cc +++ b/atom/common/api/atom_api_native_image.cc @@ -11,6 +11,7 @@ #include "atom/common/native_mate_converters/file_path_converter.h" #include "atom/common/native_mate_converters/gfx_converter.h" #include "atom/common/native_mate_converters/gurl_converter.h" +#include "atom/common/node_includes.h" #include "base/base64.h" #include "base/strings/string_util.h" #include "native_mate/dictionary.h" @@ -22,13 +23,13 @@ #include "ui/gfx/geometry/size.h" #include "ui/gfx/image/image_skia.h" #include "ui/gfx/image/image_util.h" + #if defined(OS_WIN) #include "atom/common/asar/archive.h" +#include "base/win/scoped_gdi_object.h" #include "ui/gfx/icon_util.h" #endif -#include "atom/common/node_includes.h" - namespace atom { namespace api { @@ -220,41 +221,41 @@ mate::Handle NativeImage::CreateFromJPEG( // static mate::Handle NativeImage::CreateFromPath( - v8::Isolate* isolate, const base::FilePath& file_path) { + v8::Isolate* isolate, const base::FilePath& path) { gfx::ImageSkia image_skia; - base::FilePath path(file_path); - if (path.MatchesExtension(FILE_PATH_LITERAL(".ico"))) { + base::FilePath image_path(path); + if (image_path.MatchesExtension(FILE_PATH_LITERAL(".ico"))) { #if defined(OS_WIN) // If file is in asar archive, we extract it to a temp file so LoadImage can - // load it + // load it. base::FilePath asar_path, relative_path; - if (asar::GetAsarArchivePath(path, &asar_path, &relative_path)) { + if (asar::GetAsarArchivePath(image_path, &asar_path, &relative_path)) { std::shared_ptr archive = - asar::GetOrCreateAsarArchive(asar_path); + asar::GetOrCreateAsarArchive(asar_path); if (archive) { - archive->CopyFileOut(relative_path, &path); + archive->CopyFileOut(relative_path, &image_path); } } - HICON icon = static_cast(LoadImage(NULL, - path.value().c_str(), - IMAGE_ICON, - 0, - 0, - LR_DEFAULTSIZE | LR_LOADFROMFILE)); + // Load the icon from file. + base::win::ScopedHICON icon( + static_cast( + LoadImage(NULL, image_path.value().c_str(), IMAGE_ICON, 0, 0, + LR_DEFAULTSIZE | LR_LOADFROMFILE))); + if (icon) { + // Convert the icon from the Windows specific HICON to gfx::ImageSkia. scoped_ptr bitmap(IconUtil::CreateSkBitmapFromHICON(icon)); - image_skia = *(new gfx::ImageSkia(gfx::ImageSkiaRep(*bitmap, 1.0f))); - DestroyIcon(icon); + image_skia = gfx::ImageSkia(gfx::ImageSkiaRep(*bitmap, 1.0f)); } #endif } else { - PopulateImageSkiaRepsFromPath(&image_skia, path); + PopulateImageSkiaRepsFromPath(&image_skia, image_path); } gfx::Image image(image_skia); mate::Handle handle = Create(isolate, image); #if defined(OS_MACOSX) - if (IsTemplateFilename(path)) + if (IsTemplateFilename(image_path)) handle->SetTemplateImage(true); #endif return handle; From e628c7b37d2231ca0641201502ba5c7875a8d9fe Mon Sep 17 00:00:00 2001 From: Matt Mastracci Date: Thu, 20 Aug 2015 19:59:58 -0600 Subject: [PATCH 0890/1293] Fix for issue 1968: use uv_backend_timeout to determine timeout to match other platforms --- atom/common/node_bindings_win.cc | 45 ++++++++++++-------------------- 1 file changed, 17 insertions(+), 28 deletions(-) diff --git a/atom/common/node_bindings_win.cc b/atom/common/node_bindings_win.cc index b1ecaa570607..b8de4f59da3b 100644 --- a/atom/common/node_bindings_win.cc +++ b/atom/common/node_bindings_win.cc @@ -22,37 +22,26 @@ NodeBindingsWin::~NodeBindingsWin() { } void NodeBindingsWin::PollEvents() { - // Unlike Unix, in which we can just rely on one backend fd to determine - // whether we should iterate libuv loop, on Window, IOCP is just one part - // of the libuv loop, we should also check whether we have other types of - // events. - bool block = uv_loop_->idle_handles == NULL && - uv_loop_->pending_reqs_tail == NULL && - uv_loop_->endgame_handles == NULL && - !uv_loop_->stop_flag && - (uv_loop_->active_handles > 0 || - !QUEUE_EMPTY(&uv_loop_->active_reqs)); + // If there are other kinds of events pending, uv_backend_timeout will + // instruct us not to wait. + DWORD bytes, timeout; + ULONG_PTR key; + OVERLAPPED* overlapped; - // When there is no other types of events, we block on the IOCP. - if (block) { - DWORD bytes, timeout; - ULONG_PTR key; - OVERLAPPED* overlapped; + timeout = uv_backend_timeout(uv_loop_); - timeout = uv_backend_timeout(uv_loop_); - GetQueuedCompletionStatus(uv_loop_->iocp, - &bytes, - &key, - &overlapped, - timeout); + GetQueuedCompletionStatus(uv_loop_->iocp, + &bytes, + &key, + &overlapped, + timeout); - // Give the event back so libuv can deal with it. - if (overlapped != NULL) - PostQueuedCompletionStatus(uv_loop_->iocp, - bytes, - key, - overlapped); - } + // Give the event back so libuv can deal with it. + if (overlapped != NULL) + PostQueuedCompletionStatus(uv_loop_->iocp, + bytes, + key, + overlapped); } // static From 351dc4ed6b2946594b98d5435c253089a81bfe4a Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Fri, 21 Aug 2015 11:33:02 +0900 Subject: [PATCH 0891/1293] Translate more files, fix outdated remote.md section Translate content-tracing(50%), remote docs. Fix `Remote buffer` section as outdated. --- docs/api/content-tracing-ko.md | 20 +++-- docs/api/remote-ko.md | 139 ++++++++------------------------- docs/api/remote.md | 49 ------------ 3 files changed, 43 insertions(+), 165 deletions(-) diff --git a/docs/api/content-tracing-ko.md b/docs/api/content-tracing-ko.md index 72fd289669af..22409d4f256c 100644 --- a/docs/api/content-tracing-ko.md +++ b/docs/api/content-tracing-ko.md @@ -86,29 +86,26 @@ Child 프로세스는 일반적으로 추적 데이터와 희귀한 플러시 * `traceOptions` String * `callback` Function -Start monitoring on all processes. +모든 프로세스에서 모니터링을 시작합니다. -Monitoring begins immediately locally, and asynchronously on child processes as -soon as they receive the `startMonitoring` request. +모니터링은 지역적으로 즉시 시작됩니다. 그리고 이내 자식 프로세스들이 `startMonitoring` 비동기 요청을 받습니다. -Once all child processes have acked to the `startMonitoring` request, -`callback` will be called back. +모든 자식 프로세스가 `startMonitoring` 요청을 받으면 `callback`이 호출됩니다. ## tracing.stopMonitoring(callback); * `callback` Function -Stop monitoring on all processes. +모든 프로세스에서 모니터링을 중단합니다. -Once all child processes have acked to the `stopMonitoring` request, `callback` -is called back. +모든 자식 프로세스가 `stopMonitoring` 요청을 받으면 `callback`이 호출됩니다. ## tracing.captureMonitoringSnapshot(resultFilePath, callback) * `resultFilePath` String * `callback` Function -Get the current monitoring traced data. +현재 모니터링 추적 데이터를 가져옵니다. Child processes typically are caching trace data and only rarely flush and send trace data back to the main process. That is because it may be an expensive @@ -137,5 +134,6 @@ process. ## tracing.cancelWatchEvent() -Cancel the watch event. If tracing is enabled, this may race with the watch -event callback. +Watch 이벤트를 중단합니다. 만약 추적이 활성화되어 있다면 이 함수는 watch 이벤트 콜백과 race가 일어날 것입니다. + +Cancel the watch event. If tracing is enabled, this may race with the watch event callback. diff --git a/docs/api/remote-ko.md b/docs/api/remote-ko.md index 47e05b9e16d0..64232bdc31af 100644 --- a/docs/api/remote-ko.md +++ b/docs/api/remote-ko.md @@ -1,16 +1,13 @@ # remote -`remote` 모듈은 메인 프로세스와 랜더러 프로세스 사이에 inter-process 통신을 간단하게 추상화한 모듈입니다. +`remote` 모듈은 메인 프로세스와 랜더러 프로세스 사이에 inter-process 통신을 간단하게 추상화 한 모듈입니다. -In Electron, only GUI-unrelated modules are available in the renderer process. -Without the `remote` module, users who wanted to call a main process API in -the renderer process would have to explicitly send inter-process messages -to the main process. With the `remote` module, users can invoke methods of -main process object without explicitly sending inter-process messages, -similar to Java's -[RMI](http://en.wikipedia.org/wiki/Java_remote_method_invocation). +Electron의 랜더러 프로세스에선 GUI와 관련 없는 모듈만 사용할 수 있습니다. +기본적으로 랜더러 프로세스에서 메인 프로세스의 API를 사용하려면 inter-process 통신을 사용해야 합니다. +하지만 `remote` 모듈을 사용하면 따로 inter-process 통신을 사용하지 않고 직접 명시적으로 사용할 수 있습니다. +Java의 [RMI](http://en.wikipedia.org/wiki/Java_remote_method_invocation)와 개념이 비슷합니다. -An example of creating a browser window in renderer process: +다음 예제는 랜더러 프로세스에서 브라우저 창을 만드는 예제입니다: ```javascript var remote = require('remote'); @@ -19,51 +16,38 @@ var win = new BrowserWindow({ width: 800, height: 600 }); win.loadUrl('https://github.com'); ``` -Note: for the reverse (access renderer process from main process), you can use [webContents.executeJavascript](browser-window.md#webcontents-executejavascript-code). +알림: 반대로 하려면(메인 프로세스에서 랜더러 프로세스에 접근) [webContents.executeJavascript](browser-window.md#webcontents-executejavascript-code) API를 사용하면 됩니다. ## Remote 객체 -Each object (including functions) returned by the `remote` module represents an -object in the main process (we call it a remote object or remote function). -When you invoke methods of a remote object, call a remote function, or create -a new object with the remote constructor (function), you are actually sending -synchronous inter-process messages. +`remote` 모듈로부터 반환된 각 객체(함수 포함)는 메인 프로세스의 객체를 추상화 한 객체입니다. (우리는 그것을 remote 객체 또는 remote 함수라고 부릅니다) +Remote 모듈의 함수를 호출하거나, 객체에 접근하거나, 생성자로 객체를 생성하는 등의 작업은 실질적으로 동기형 inter-process 메시지를 보냅니다. -In the example above, both `BrowserWindow` and `win` were remote objects and -`new BrowserWindow` didn't create a `BrowserWindow` object in the renderer process. -Instead, it created a `BrowserWindow` object in the main process and returned the -corresponding remote object in the renderer process, namely the `win` object. +위의 예제에서 사용한 두 `BrowserWindow`와 `win`은 remote 객체입니다. 그리고 `new BrowserWindow`이 생성하는 `BrowserWindow` 객체는 랜더러 프로세스에서 생성되지 않습니다. +대신에 이 `BrowserWindow` 객체는 메인 프로세스에서 생성되며 랜더러 프로세스에 `win` 객체와 같이 이에 대응하는 remote 객체를 반환합니다. -## Lifetime of remote objects +## Remote 객체의 일생 -Electron makes sure that as long as the remote object in the renderer process -lives (in other words, has not been garbage collected), the corresponding object -in the main process would never be released. When the remote object has been -garbage collected, the corresponding object in the main process would be -dereferenced. +Electron은 랜더러 프로세스의 remote 객체가 살아있는 한(다시 말해서 GC(garbage collection)가 일어나지 않습니다) 대응하는 메인 프로세스의 객체는 릴리즈되지 않습니다. +Remote 객체가 GC 되려면 대응하는 메인 프로세스 내부 객체의 참조가 해제되어야만 합니다. -If the remote object is leaked in renderer process (e.g. stored in a map but never -freed), the corresponding object in the main process would also be leaked, -so you should be very careful not to leak remote objects. +만약 remote 객체가 랜더러 프로세스에서 누수가 생겼다면 (예시: 맵에 저장하고 할당 해제하지 않음) 대응하는 메인 프로세스의 객체도 누수가 생깁니다. +그래서 remote 객체를 사용할 땐 메모리 누수가 생기지 않도록 매우 주의해서 사용해야 합니다. -Primary value types like strings and numbers, however, are sent by copy. +참고로 문자열, 숫자와 같은 원시 값 타입은 복사에 의한 참조로 전달됩니다. -## Passing callbacks to the main process +## 메인 프로세스로 콜백 넘기기 -Some APIs in the main process accept callbacks, and it would be tempting to -pass callbacks when calling a remote function. The `remote` module does support -doing this, but you should also be extremely careful with this. +몇몇 메인 프로세스의 API는 콜백 함수를 사용합니다. 그리고 보통 remote 함수를 호출할 때 콜백 함수를 넘길 것입니다. +`remote` 모듈은 이를 지원합니다. 하지만 반드시 주의해서 사용해야 합니다. -First, in order to avoid deadlocks, the callbacks passed to the main process -are called asynchronously, so you should not expect the main process to -get the return value of the passed callbacks. +첫째, 데드락을 피하기 위해 메인 프로세스로 전달된 콜백들은 비동기로 호출됩니다. +그래서 전달된 콜백들이 언제나 값을 반환할 것이라고 기대하면 안 됩니다. -Second, the callbacks passed to the main process will not get released -automatically after they are called. Instead, they will persistent until the -main process garbage-collects them. +둘째, 콜백들은 메인 프로세스로 전송되고 호출된 후에도 자동으로 참조가 릴리즈 되지 않습니다. +참조는 메인 프로세스에서 GC가 일어나기 전까지 계속 남아있게 됩니다. -For example, the following code seems innocent at first glance. It installs a -callback for the `close` event on a remote object: +다음 코드를 보면 느낌이 팟 하고 올 것입니다. 이 예제는 remote 객체에 `close` 이벤트 콜백을 설치합니다: ```javascript var remote = require('remote'); @@ -72,87 +56,32 @@ remote.getCurrentWindow().on('close', function() { }); ``` -The problem is that the callback would be stored in the main process until you -explicitly uninstall it! So each time you reload your window, the callback would -be installed again and previous callbacks would just leak. To make things -worse, since the context of previously installed callbacks have been released, -when the `close` event was emitted, exceptions would be raised in the main process. +문제는 이 이벤트는 명시적으로 제거하지 않는 이상 계속해서 메인 프로세스에 남아있게 된다는 것입니다. +그래서 매 창을 새로고침 할 때마다 콜백이 새롭게 설치되며 이전 콜백은 떨궈져 누수가 됩니다. +설상가상으로 이전에 설치한 콜백의 콘텍스트가 릴리즈 되고 나서 `close` 이벤트가 발생하면 예외가 발생하고 메인 프로세스가 작동 중지됩니다. -Generally, unless you are clear what you are doing, you should always avoid -passing callbacks to the main process. - -## Remote buffer - -An instance of node's `Buffer` is an object, so when you get a `Buffer` from -the main process, what you get is indeed a remote object (let's call it remote -buffer), and everything would just follow the rules of remote objects. - -However you should remember that although a remote buffer behaves like the real -`Buffer`, it's not a `Buffer` at all. If you pass a remote buffer to node APIs -that accept a `Buffer`, you should assume the remote buffer would be treated -like a normal object, instead of a `Buffer`. - -For example, you can call `BrowserWindow.capturePage` in the renderer process, which -returns a `Buffer` by calling the passed callback: - -```javascript -var remote = require('remote'); -var fs = require('fs'); -remote.getCurrentWindow().capturePage(function(image) { - var buf = image.toPng(); - fs.writeFile('/tmp/screenshot.png', buf, function(err) { - console.log(err); - }); -}); -``` - -But you may be surprised to find that the file written was corrupted. This is -because when you called `fs.writeFile`, thinking that `buf` was a `Buffer` when -in fact it was a remote buffer, and it was converted to string before it was -written to the file. Since `buf` contained binary data and could not be represented -by a UTF-8 encoded string, the written file was corrupted. - -The work-around is to write the `buf` in the main process, where it is a real -`Buffer`: - -```javascript -var remote = require('remote'); -remote.getCurrentWindow().capturePage(function(image) { - var buf = image.toPng(); - remote.require('fs').writeFile('/tmp/screenshot.png', buf, function(err) { - console.log(err); - }); -}); -``` - -The same thing could happen for all native types, but usually it would just -throw a type error. The `Buffer` deserves your special attention because it -might be converted to string, and APIs accepting `Buffer` usually accept string -too, and data corruption could happen when it contains binary data. +일반적으로 정확히 무엇을 할 것인지 잘 알고 있지 않는 이상 웬만하면 메인 프로세스로 콜백 함수를 넘기는 건 자제하는 게 좋습니다. ## remote.require(module) * `module` String -Returns the object returned by `require(module)` in the main process. +메인 프로세스의 `require(module)` API를 실행한 후 결과 객체를 반환합니다. ## remote.getCurrentWindow() -Returns the [BrowserWindow](browser-window-ko.md) object which this web page -belongs to. +현재 웹 페이지가 들어있는 [BrowserWindow](browser-window-ko.md) 객체를 반환합니다. ## remote.getCurrentWebContents() -Returns the WebContents object of this web page. +현재 웹 페이지의 WebContents 객체를 반환합니다. ## remote.getGlobal(name) * `name` String -Returns the global variable of `name` (e.g. `global[name]`) in the main -process. +메인 프로세스의 전역 변수(`name`)를 가져옵니다. (예시: `global[name]`) ## remote.process -Returns the `process` object in the main process. This is the same as -`remote.getGlobal('process')`, but gets cached. +메인 프로세스의 `process` 객체를 반환합니다. `remote.getGlobal('process')`와 같습니다. 하지만 캐시 됩니다. diff --git a/docs/api/remote.md b/docs/api/remote.md index b01f47d169c4..9836374ee475 100644 --- a/docs/api/remote.md +++ b/docs/api/remote.md @@ -82,55 +82,6 @@ when the `close` event was emitted, exceptions would be raised in the main proce Generally, unless you are clear what you are doing, you should always avoid passing callbacks to the main process. -## Remote buffer - -An instance of node's `Buffer` is an object, so when you get a `Buffer` from -the main process, what you get is indeed a remote object (let's call it remote -buffer), and everything would just follow the rules of remote objects. - -However you should remember that although a remote buffer behaves like the real -`Buffer`, it's not a `Buffer` at all. If you pass a remote buffer to node APIs -that accept a `Buffer`, you should assume the remote buffer would be treated -like a normal object, instead of a `Buffer`. - -For example, you can call `BrowserWindow.capturePage` in the renderer process, which -returns a `Buffer` by calling the passed callback: - -```javascript -var remote = require('remote'); -var fs = require('fs'); -remote.getCurrentWindow().capturePage(function(image) { - var buf = image.toPng(); - fs.writeFile('/tmp/screenshot.png', buf, function(err) { - console.log(err); - }); -}); -``` - -But you may be surprised to find that the file written was corrupted. This is -because when you called `fs.writeFile`, thinking that `buf` was a `Buffer` when -in fact it was a remote buffer, and it was converted to string before it was -written to the file. Since `buf` contained binary data and could not be represented -by a UTF-8 encoded string, the written file was corrupted. - -The work-around is to write the `buf` in the main process, where it is a real -`Buffer`: - -```javascript -var remote = require('remote'); -remote.getCurrentWindow().capturePage(function(image) { - var buf = image.toPng(); - remote.require('fs').writeFile('/tmp/screenshot.png', buf, function(err) { - console.log(err); - }); -}); -``` - -The same thing could happen for all native types, but usually it would just -throw a type error. The `Buffer` deserves your special attention because it -might be converted to string, and APIs accepting `Buffer` usually accept string -too, and data corruption could happen when it contains binary data. - ## remote.require(module) * `module` String From 82fc98848a8e91fd0baca854ee4f4fde212ea638 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 21 Aug 2015 12:06:38 +0800 Subject: [PATCH 0892/1293] win: Move the ICO reading code into a separate function --- atom/common/api/atom_api_native_image.cc | 57 +++++++++++++----------- 1 file changed, 31 insertions(+), 26 deletions(-) diff --git a/atom/common/api/atom_api_native_image.cc b/atom/common/api/atom_api_native_image.cc index f36e675fb981..5324a6b5486b 100644 --- a/atom/common/api/atom_api_native_image.cc +++ b/atom/common/api/atom_api_native_image.cc @@ -124,6 +124,33 @@ bool IsTemplateFilename(const base::FilePath& path) { } #endif +#if defined(OS_WIN) +bool ReadImageSkiaFromICO(gfx::ImageSkia* image, const base::FilePath& path) { + // If file is in asar archive, we extract it to a temp file so LoadImage can + // load it. + base::FilePath asar_path, relative_path; + base::FilePath image_path(path); + if (asar::GetAsarArchivePath(image_path, &asar_path, &relative_path)) { + std::shared_ptr archive = + asar::GetOrCreateAsarArchive(asar_path); + if (archive) + archive->CopyFileOut(relative_path, &image_path); + } + + // Load the icon from file. + base::win::ScopedHICON icon(static_cast( + LoadImage(NULL, image_path.value().c_str(), IMAGE_ICON, 0, 0, + LR_DEFAULTSIZE | LR_LOADFROMFILE))); + if (!icon) + return false; + + // Convert the icon from the Windows specific HICON to gfx::ImageSkia. + scoped_ptr bitmap(IconUtil::CreateSkBitmapFromHICON(icon)); + image->AddRepresentation(gfx::ImageSkiaRep(*bitmap, 1.0f)); + return true; +} +#endif + v8::Persistent template_; } // namespace @@ -223,39 +250,17 @@ mate::Handle NativeImage::CreateFromJPEG( mate::Handle NativeImage::CreateFromPath( v8::Isolate* isolate, const base::FilePath& path) { gfx::ImageSkia image_skia; - base::FilePath image_path(path); - if (image_path.MatchesExtension(FILE_PATH_LITERAL(".ico"))) { + if (path.MatchesExtension(FILE_PATH_LITERAL(".ico"))) { #if defined(OS_WIN) - // If file is in asar archive, we extract it to a temp file so LoadImage can - // load it. - base::FilePath asar_path, relative_path; - if (asar::GetAsarArchivePath(image_path, &asar_path, &relative_path)) { - std::shared_ptr archive = - asar::GetOrCreateAsarArchive(asar_path); - if (archive) { - archive->CopyFileOut(relative_path, &image_path); - } - } - - // Load the icon from file. - base::win::ScopedHICON icon( - static_cast( - LoadImage(NULL, image_path.value().c_str(), IMAGE_ICON, 0, 0, - LR_DEFAULTSIZE | LR_LOADFROMFILE))); - - if (icon) { - // Convert the icon from the Windows specific HICON to gfx::ImageSkia. - scoped_ptr bitmap(IconUtil::CreateSkBitmapFromHICON(icon)); - image_skia = gfx::ImageSkia(gfx::ImageSkiaRep(*bitmap, 1.0f)); - } + ReadImageSkiaFromICO(&image_skia, path); #endif } else { - PopulateImageSkiaRepsFromPath(&image_skia, image_path); + PopulateImageSkiaRepsFromPath(&image_skia, path); } gfx::Image image(image_skia); mate::Handle handle = Create(isolate, image); #if defined(OS_MACOSX) - if (IsTemplateFilename(image_path)) + if (IsTemplateFilename(path)) handle->SetTemplateImage(true); #endif return handle; From e016100860e77fbefcf7042780621d64b61ac5b7 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 21 Aug 2015 11:43:50 +0800 Subject: [PATCH 0893/1293] Bump v0.30.5 --- atom.gyp | 2 +- atom/browser/resources/mac/Info.plist | 2 +- atom/browser/resources/win/atom.rc | 8 ++++---- atom/common/atom_version.h | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/atom.gyp b/atom.gyp index d24f193ac2db..ca91c896f534 100644 --- a/atom.gyp +++ b/atom.gyp @@ -4,7 +4,7 @@ 'product_name%': 'Electron', 'company_name%': 'GitHub, Inc', 'company_abbr%': 'github', - 'version%': '0.30.4', + 'version%': '0.30.5', }, 'includes': [ 'filenames.gypi', diff --git a/atom/browser/resources/mac/Info.plist b/atom/browser/resources/mac/Info.plist index a8c009acaff5..4fefcc678307 100644 --- a/atom/browser/resources/mac/Info.plist +++ b/atom/browser/resources/mac/Info.plist @@ -17,7 +17,7 @@ CFBundleIconFile atom.icns CFBundleVersion - 0.30.4 + 0.30.5 LSMinimumSystemVersion 10.8.0 NSMainNibFile diff --git a/atom/browser/resources/win/atom.rc b/atom/browser/resources/win/atom.rc index b22d3d88f6c4..762d33992373 100644 --- a/atom/browser/resources/win/atom.rc +++ b/atom/browser/resources/win/atom.rc @@ -56,8 +56,8 @@ END // VS_VERSION_INFO VERSIONINFO - FILEVERSION 0,30,4,0 - PRODUCTVERSION 0,30,4,0 + FILEVERSION 0,30,5,0 + PRODUCTVERSION 0,30,5,0 FILEFLAGSMASK 0x3fL #ifdef _DEBUG FILEFLAGS 0x1L @@ -74,12 +74,12 @@ BEGIN BEGIN VALUE "CompanyName", "GitHub, Inc." VALUE "FileDescription", "Electron" - VALUE "FileVersion", "0.30.4" + VALUE "FileVersion", "0.30.5" VALUE "InternalName", "electron.exe" VALUE "LegalCopyright", "Copyright (C) 2015 GitHub, Inc. All rights reserved." VALUE "OriginalFilename", "electron.exe" VALUE "ProductName", "Electron" - VALUE "ProductVersion", "0.30.4" + VALUE "ProductVersion", "0.30.5" VALUE "SquirrelAwareVersion", "1" END END diff --git a/atom/common/atom_version.h b/atom/common/atom_version.h index 405a104a76f7..bacde65d27d5 100644 --- a/atom/common/atom_version.h +++ b/atom/common/atom_version.h @@ -7,7 +7,7 @@ #define ATOM_MAJOR_VERSION 0 #define ATOM_MINOR_VERSION 30 -#define ATOM_PATCH_VERSION 4 +#define ATOM_PATCH_VERSION 5 #define ATOM_VERSION_IS_RELEASE 1 From c566ba575fc0813ad865a7e3bf56e3577da4b649 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Fri, 21 Aug 2015 11:06:29 +0800 Subject: [PATCH 0894/1293] Linux: make * extension filter works. --- 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 6eab9ef89f7b..463ad987a8b0 100644 --- a/atom/browser/ui/file_dialog_gtk.cc +++ b/atom/browser/ui/file_dialog_gtk.cc @@ -19,6 +19,9 @@ namespace { // Makes sure that .jpg also shows .JPG. gboolean FileFilterCaseInsensitive(const GtkFileFilterInfo* file_info, std::string* file_extension) { + // Makes .* file extension matches all file types. + if (*file_extension == ".*") + return true; return EndsWith(file_info->filename, *file_extension, false); } From 5f663dbf0ab4621a2401b71ed89bceb66275ad49 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Fri, 21 Aug 2015 12:15:20 +0800 Subject: [PATCH 0895/1293] mac: make * extension filter works. --- atom/browser/ui/file_dialog_mac.mm | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/atom/browser/ui/file_dialog_mac.mm b/atom/browser/ui/file_dialog_mac.mm index 96d230b1a1ea..1cbe46e3b55b 100644 --- a/atom/browser/ui/file_dialog_mac.mm +++ b/atom/browser/ui/file_dialog_mac.mm @@ -23,6 +23,12 @@ void SetAllowedFileTypes(NSSavePanel* dialog, const Filters& filters) { for (size_t i = 0; i < filters.size(); ++i) { const Filter& filter = filters[i]; for (size_t j = 0; j < filter.second.size(); ++j) { + // If we meet a '*' file extension, we allow all the file types and no + // need to set the specified file types. + if (filter.second[j] == "*") { + [dialog setAllowsOtherFileTypes:YES]; + return; + } base::ScopedCFTypeRef ext_cf( base::SysUTF8ToCFStringRef(filter.second[j])); [file_type_set addObject:base::mac::CFToNSCast(ext_cf.get())]; From c18ec7f5bc7424cf4e8021bbeda0e7c7b41e885e Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 21 Aug 2015 13:49:15 +0800 Subject: [PATCH 0896/1293] runas@3.x --- package.json | 2 +- spec/package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 1942bcbc9a04..2986a380c4ea 100644 --- a/package.json +++ b/package.json @@ -5,7 +5,7 @@ "coffee-script": "^1.9.2", "coffeelint": "^1.9.4", "request": "*", - "runas": "^2.0.0" + "runas": "3.x" }, "private": true, "scripts": { diff --git a/spec/package.json b/spec/package.json index 6343832dcc8e..a3b0d590effa 100644 --- a/spec/package.json +++ b/spec/package.json @@ -9,7 +9,7 @@ "graceful-fs": "3.0.5", "mocha": "2.1.0", "q": "0.9.7", - "runas": "2.x", + "runas": "3.x", "temp": "0.8.1", "walkdir": "0.0.7", "ws": "0.7.2" From 0ee6e5334a9d913cbe3f615a1418d998f05de0f0 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 21 Aug 2015 13:58:49 +0800 Subject: [PATCH 0897/1293] Now working at 0.31.0 --- atom.gyp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/atom.gyp b/atom.gyp index 440eceee62d2..08885b3ef532 100644 --- a/atom.gyp +++ b/atom.gyp @@ -4,7 +4,7 @@ 'product_name%': 'Electron', 'company_name%': 'GitHub, Inc', 'company_abbr%': 'github', - 'version%': '0.30.4', + 'version%': '0.31.0', }, 'includes': [ 'filenames.gypi', From 1bd8a9869a17f78ef16e67d63f4e81cf2461676c Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 21 Aug 2015 14:18:04 +0800 Subject: [PATCH 0898/1293] Run build script on arm and ia32 Linux --- script/cibuild | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/script/cibuild b/script/cibuild index c282bb0275a4..67623beba402 100755 --- a/script/cibuild +++ b/script/cibuild @@ -69,9 +69,9 @@ def main(): run_script('build.py', ['-c', 'R']) run_script('create-dist.py') run_script('upload.py') - elif PLATFORM == 'win32' or target_arch == 'x64': + else: run_script('build.py', ['-c', 'D']) - if PLATFORM != 'win32': + if PLATFORM != 'win32' and target_arch == 'x64': run_script('test.py', ['--ci']) run_script('clean.py') From bc5ebb99117891ba0becfa382fdc13a141e03c5b Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 21 Aug 2015 14:28:37 +0800 Subject: [PATCH 0899/1293] Update to io.js v3.1.0 --- vendor/node | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/node b/vendor/node index 81645132a9d3..205b013ac86e 160000 --- a/vendor/node +++ b/vendor/node @@ -1 +1 @@ -Subproject commit 81645132a9d3dfadb6404714e208d3b419f878ea +Subproject commit 205b013ac86e5500678a791cd54f305580fa4f4b From 627fe75a6aa210b97169df2b47e23e2fbcf23cdd Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 21 Aug 2015 16:14:47 +0800 Subject: [PATCH 0900/1293] Update brightray to fix building on Linux --- vendor/brightray | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/brightray b/vendor/brightray index cb8f80f473a5..b69b097f0e2e 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit cb8f80f473a54fe1de72d478fd7809cf0c01fdb2 +Subproject commit b69b097f0e2ecafa3e293100101de2807426212c From 00e5290dc8417424c15344fbce96eb71382179f9 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 21 Aug 2015 14:21:27 +0800 Subject: [PATCH 0901/1293] win: Update libchromium to fix .pdb missing errors --- script/lib/config.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/script/lib/config.py b/script/lib/config.py index 9a5979bdbaef..d67b00f0b4ad 100644 --- a/script/lib/config.py +++ b/script/lib/config.py @@ -8,7 +8,7 @@ import sys BASE_URL = os.getenv('LIBCHROMIUMCONTENT_MIRROR') or \ 'http://github-janky-artifacts.s3.amazonaws.com/libchromiumcontent' -LIBCHROMIUMCONTENT_COMMIT = 'e667b7cc5a04bc8e64960d47079d99446a263e85' +LIBCHROMIUMCONTENT_COMMIT = 'e738bafd994983408ea6c0871a054984e41519fc' PLATFORM = { 'cygwin': 'win32', From cf6a904f957bfe44eb47728045652259ce532a74 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 21 Aug 2015 16:21:20 +0800 Subject: [PATCH 0902/1293] win: Fix release build --- script/lib/config.py | 2 +- vendor/brightray | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/script/lib/config.py b/script/lib/config.py index d67b00f0b4ad..c363a83a5f44 100644 --- a/script/lib/config.py +++ b/script/lib/config.py @@ -8,7 +8,7 @@ import sys BASE_URL = os.getenv('LIBCHROMIUMCONTENT_MIRROR') or \ 'http://github-janky-artifacts.s3.amazonaws.com/libchromiumcontent' -LIBCHROMIUMCONTENT_COMMIT = 'e738bafd994983408ea6c0871a054984e41519fc' +LIBCHROMIUMCONTENT_COMMIT = '42200d8ec0b77c7491d3a09611c23eb771e0862d' PLATFORM = { 'cygwin': 'win32', diff --git a/vendor/brightray b/vendor/brightray index b69b097f0e2e..939a7b814282 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit b69b097f0e2ecafa3e293100101de2807426212c +Subproject commit 939a7b814282a6433b8d7e3c9cfc74451360c07f From 61b7a3afe301578e896dc5b96895d937b4885d30 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 21 Aug 2015 16:27:29 +0800 Subject: [PATCH 0903/1293] No need to ship ffmpeg in dist --- script/create-dist.py | 2 -- 1 file changed, 2 deletions(-) diff --git a/script/create-dist.py b/script/create-dist.py index dbecc0a1eb72..c978641df320 100755 --- a/script/create-dist.py +++ b/script/create-dist.py @@ -31,7 +31,6 @@ TARGET_BINARIES = { '{0}.exe'.format(PROJECT_NAME), # 'electron.exe' 'content_shell.pak', 'd3dcompiler_47.dll', - 'ffmpegsumo.dll', 'icudtl.dat', 'libEGL.dll', 'libGLESv2.dll', @@ -50,7 +49,6 @@ TARGET_BINARIES = { PROJECT_NAME, # 'electron' 'content_shell.pak', 'icudtl.dat', - 'libffmpegsumo.so', 'libnode.so', 'natives_blob.bin', 'snapshot_blob.bin', From d931a49e891363ee714df49cd084decbeb47ab8b Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 21 Aug 2015 18:02:58 +0800 Subject: [PATCH 0904/1293] Warn about removed protocol APIs --- atom/browser/api/lib/protocol.coffee | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/atom/browser/api/lib/protocol.coffee b/atom/browser/api/lib/protocol.coffee index 4a45c702507c..13f2a6d10270 100644 --- a/atom/browser/api/lib/protocol.coffee +++ b/atom/browser/api/lib/protocol.coffee @@ -3,4 +3,22 @@ throw new Error('Can not initialize protocol module before app is ready') unless protocol = process.atomBinding('protocol').protocol +# Warn about removed APIs. +logAndThrow = (callback, message) -> + console.error message + if callback then callback(new Error(message)) else throw new Error(message) +protocol.registerProtocol = (scheme, handler, callback) -> + logAndThrow callback, + 'registerProtocol API has been replaced by the + register[File/Http/Buffer/String]Protocol API family, please + switch to the new APIs.' +protocol.isHandledProtocol = (scheme, callback) -> + logAndThrow callback, + 'isHandledProtocol API has been replaced by isProtocolHandled.' +protocol.interceptProtocol = (scheme, handler, callback) -> + logAndThrow callback, + 'interceptProtocol API has been replaced by the + intercept[File/Http/Buffer/String]Protocol API family, please + switch to the new APIs.' + module.exports = protocol From a839f70a9989b170ae5976598dc4b8729a17bd54 Mon Sep 17 00:00:00 2001 From: LeMoussel Date: Fri, 21 Aug 2015 12:09:31 +0200 Subject: [PATCH 0905/1293] Update using-selenium-and-webdriver.md Add an example of how to use webdriverio with electron --- docs/tutorial/using-selenium-and-webdriver.md | 46 +++++++++++++++++++ 1 file changed, 46 insertions(+) diff --git a/docs/tutorial/using-selenium-and-webdriver.md b/docs/tutorial/using-selenium-and-webdriver.md index 13934c01b086..29d95576227e 100644 --- a/docs/tutorial/using-selenium-and-webdriver.md +++ b/docs/tutorial/using-selenium-and-webdriver.md @@ -70,6 +70,52 @@ driver.wait(function() { driver.quit(); ``` +## Setting up with WebdriverIO + +[WebdriverIO](http://webdriver.io/) provided a Node package for testing with web driver. + +### 1. Start chrome driver + +First you need to download the `chromedriver` binary, and run it: + +```bash +$ chromedriver --url-base=/wd/hub --port=9515 +Starting ChromeDriver (v2.10.291558) on port 9515 +Only local connections are allowed. +``` + +Remember the port number `9515`, which will be used later + +### 2. Install WebDriverJS + +```bash +$ npm install webdriverio +``` + +### 3. Connect to chrome driver +```javascript +var webdriverio = require('webdriverio'); +var options = { + host: "localhost", // Use localhost as chrome driver server + port: 9515, // "9515" is the port opened by chrome driver. + desiredCapabilities: { + browserName: 'chrome', + chromeOptions: {binary: '/Path-to-Your-App.app/Electron'} // Path to your Electron binary. + } +}; + +webdriverio + .remote(options) + .init() + .url('http://google.com') + .setValue('#q', 'webdriverio') + .click('#btnG') + .title(function(err, res) { + console.log('Title was: ' + res.value); + }) + .end(); +``` + ## Workflow To test your application without rebuilding Electron, simply [place](https://github.com/atom/electron/blob/master/docs/tutorial/application-distribution.md) your app source into Electron's resource directory. From 68a98d5dc215d04f4049acaa2175506d17ffcb97 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 21 Aug 2015 19:51:56 +0800 Subject: [PATCH 0906/1293] Bump v0.31.0 --- atom/browser/resources/mac/Info.plist | 2 +- atom/browser/resources/win/atom.rc | 8 ++++---- atom/common/atom_version.h | 4 ++-- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/atom/browser/resources/mac/Info.plist b/atom/browser/resources/mac/Info.plist index 4fefcc678307..a9076b830eb4 100644 --- a/atom/browser/resources/mac/Info.plist +++ b/atom/browser/resources/mac/Info.plist @@ -17,7 +17,7 @@ CFBundleIconFile atom.icns CFBundleVersion - 0.30.5 + 0.31.0 LSMinimumSystemVersion 10.8.0 NSMainNibFile diff --git a/atom/browser/resources/win/atom.rc b/atom/browser/resources/win/atom.rc index 762d33992373..c97106298bf8 100644 --- a/atom/browser/resources/win/atom.rc +++ b/atom/browser/resources/win/atom.rc @@ -56,8 +56,8 @@ END // VS_VERSION_INFO VERSIONINFO - FILEVERSION 0,30,5,0 - PRODUCTVERSION 0,30,5,0 + FILEVERSION 0,31,0,0 + PRODUCTVERSION 0,31,0,0 FILEFLAGSMASK 0x3fL #ifdef _DEBUG FILEFLAGS 0x1L @@ -74,12 +74,12 @@ BEGIN BEGIN VALUE "CompanyName", "GitHub, Inc." VALUE "FileDescription", "Electron" - VALUE "FileVersion", "0.30.5" + VALUE "FileVersion", "0.31.0" VALUE "InternalName", "electron.exe" VALUE "LegalCopyright", "Copyright (C) 2015 GitHub, Inc. All rights reserved." VALUE "OriginalFilename", "electron.exe" VALUE "ProductName", "Electron" - VALUE "ProductVersion", "0.30.5" + VALUE "ProductVersion", "0.31.0" VALUE "SquirrelAwareVersion", "1" END END diff --git a/atom/common/atom_version.h b/atom/common/atom_version.h index bacde65d27d5..483bf382c265 100644 --- a/atom/common/atom_version.h +++ b/atom/common/atom_version.h @@ -6,8 +6,8 @@ #define ATOM_VERSION_H #define ATOM_MAJOR_VERSION 0 -#define ATOM_MINOR_VERSION 30 -#define ATOM_PATCH_VERSION 5 +#define ATOM_MINOR_VERSION 31 +#define ATOM_PATCH_VERSION 0 #define ATOM_VERSION_IS_RELEASE 1 From d7cf4609185816c7ac8e520968ab4b726a533c95 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 21 Aug 2015 20:16:56 +0800 Subject: [PATCH 0907/1293] docs: callback => completion in some places --- docs/api/protocol.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/api/protocol.md b/docs/api/protocol.md index a256bf30a73d..be0cad0d5de0 100644 --- a/docs/api/protocol.md +++ b/docs/api/protocol.md @@ -120,7 +120,7 @@ already a handler for `scheme`. * `scheme` String * `handler` Function -* `callback` Function +* `completion` Function Intercepts `scheme` protocol and use `handler` as the protocol's new handler which sends file as response. @@ -129,7 +129,7 @@ which sends file as response. * `scheme` String * `handler` Function -* `callback` Function +* `completion` Function Intercepts `scheme` protocol and use `handler` as the protocol's new handler which sends String as response. @@ -138,7 +138,7 @@ which sends String as response. * `scheme` String * `handler` Function -* `callback` Function +* `completion` Function Intercepts `scheme` protocol and use `handler` as the protocol's new handler which sends `Buffer` as response. @@ -147,7 +147,7 @@ which sends `Buffer` as response. * `scheme` String * `handler` Function -* `callback` Function +* `completion` Function Intercepts `scheme` protocol and use `handler` as the protocol's new handler which sends a new HTTP request as response. @@ -155,6 +155,6 @@ which sends a new HTTP request as response. ## protocol.uninterceptProtocol(scheme[, completion]) * `scheme` String -* `callback` Function +* `completion` Function Remove the interceptor installed for `scheme` and restore its original handler. From db2f0a68e8ff337bb22c8a815fcbcaa3530839ac Mon Sep 17 00:00:00 2001 From: Eran Tiktin Date: Fri, 21 Aug 2015 21:18:37 +0300 Subject: [PATCH 0908/1293] Update dialog.md with info about filter extensions There was some confusion about the correct way to add an `All Files` filter (see #2525), so I added it to the example. Also added a short note about the extension syntax. This is related to PR #2547. --- docs/api/dialog.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/api/dialog.md b/docs/api/dialog.md index d9336c0c8a3a..22dd58db2d14 100644 --- a/docs/api/dialog.md +++ b/docs/api/dialog.md @@ -36,10 +36,12 @@ selected, an example is: filters: [ { name: 'Images', extensions: ['jpg', 'png', 'gif'] }, { name: 'Movies', extensions: ['mkv', 'avi', 'mp4'] }, - { name: 'Custom File Type', extensions: ['as'] } + { name: 'Custom File Type', extensions: ['as'] }, + { name: 'All Files', extensions: ['*'] } ] } ``` +The `extensions` array should contain extensions without wildcards or dots (e.g. `'png'` is good, `'.png'` and `'*.png'` are bad). To show all files, use the `'*'` wildcard (no other wildcard is supported). If a `callback` is passed, the API call would be asynchronous and the result would be passed via `callback(filenames)` From 79c602c3ccb3cbf0c3709aa7f3b861657bab5a9e Mon Sep 17 00:00:00 2001 From: Eran Tiktin Date: Fri, 21 Aug 2015 22:23:49 +0300 Subject: [PATCH 0909/1293] Update coding-style with info about Chromium's types When I first tried to add something to the C++ code, I was a bit overwhelmed by all the special types and abstractions. The info added will hopefully make it a bit easier to start, by directing users to the right place. --- docs/development/coding-style.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/development/coding-style.md b/docs/development/coding-style.md index df7f42e4a74e..7b72174c6be1 100644 --- a/docs/development/coding-style.md +++ b/docs/development/coding-style.md @@ -8,6 +8,13 @@ script `script/cpplint.py` to check whether all files confirm. The python's version we are using now is Python 2.7. +The C++ code uses a lot of Chromium's abstractions and types, so it's +recommended to get acquainted with them. A good place to start is +Chromium's [Important Abstractions and Data Structures] +(https://www.chromium.org/developers/coding-style/important-abstractions-and-data-structures) +document. The document mentions some special types, scoped types (that +automatically release their memory when going out of scope), logging mechanisms etc. + ## CoffeeScript For CoffeeScript, we follow GitHub's [Style From b1406fbad93e65c6bd54c646cdb3fe37aed1c0dc Mon Sep 17 00:00:00 2001 From: Eran Tiktin Date: Sat, 22 Aug 2015 04:20:52 +0300 Subject: [PATCH 0910/1293] Fix no close button in message box on Windows This resolves #2293. --- atom/browser/ui/message_box_win.cc | 6 +++--- atom/renderer/lib/override.coffee | 5 ++++- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/atom/browser/ui/message_box_win.cc b/atom/browser/ui/message_box_win.cc index 051f8f5eff6c..ecdc96770bb2 100644 --- a/atom/browser/ui/message_box_win.cc +++ b/atom/browser/ui/message_box_win.cc @@ -78,9 +78,9 @@ int ShowMessageBoxUTF16(HWND parent, const base::string16& message, const base::string16& detail, const gfx::ImageSkia& icon) { - TASKDIALOG_FLAGS flags = TDF_SIZE_TO_CONTENT; // show all content. - if (cancel_id != 0) - flags |= TDF_ALLOW_DIALOG_CANCELLATION; // allow dialog to be cancelled. + TASKDIALOG_FLAGS flags = + TDF_SIZE_TO_CONTENT | // Show all content. + TDF_ALLOW_DIALOG_CANCELLATION; // Allow canceling the dialog. TASKDIALOGCONFIG config = { 0 }; config.cbSize = sizeof(config); diff --git a/atom/renderer/lib/override.coffee b/atom/renderer/lib/override.coffee index d8c6c0a86d79..a413178442f2 100644 --- a/atom/renderer/lib/override.coffee +++ b/atom/renderer/lib/override.coffee @@ -80,12 +80,15 @@ window.alert = (message, title='') -> buttons = ['OK'] message = message.toString() dialog.showMessageBox remote.getCurrentWindow(), {message, title, buttons} + # Alert should always return undefined. + return # And the confirm(). window.confirm = (message, title='') -> dialog = remote.require 'dialog' buttons = ['OK', 'Cancel'] - not dialog.showMessageBox remote.getCurrentWindow(), {message, title, buttons} + cancelId = 1 + not dialog.showMessageBox remote.getCurrentWindow(), {message, title, buttons, cancelId} # But we do not support prompt(). window.prompt = -> From 9232620023daa476d384ea9f48f8cc9f92356e00 Mon Sep 17 00:00:00 2001 From: Eran Tiktin Date: Sat, 22 Aug 2015 04:26:09 +0300 Subject: [PATCH 0911/1293] Fixed comment spacing --- atom/browser/ui/message_box_win.cc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/atom/browser/ui/message_box_win.cc b/atom/browser/ui/message_box_win.cc index ecdc96770bb2..697a7ad410a2 100644 --- a/atom/browser/ui/message_box_win.cc +++ b/atom/browser/ui/message_box_win.cc @@ -79,8 +79,8 @@ int ShowMessageBoxUTF16(HWND parent, const base::string16& detail, const gfx::ImageSkia& icon) { TASKDIALOG_FLAGS flags = - TDF_SIZE_TO_CONTENT | // Show all content. - TDF_ALLOW_DIALOG_CANCELLATION; // Allow canceling the dialog. + TDF_SIZE_TO_CONTENT | // Show all content. + TDF_ALLOW_DIALOG_CANCELLATION; // Allow canceling the dialog. TASKDIALOGCONFIG config = { 0 }; config.cbSize = sizeof(config); From c686fc4d6b176b85c8ef1ec4568aaec63fec5c12 Mon Sep 17 00:00:00 2001 From: Eran Tiktin Date: Sat, 22 Aug 2015 05:09:37 +0300 Subject: [PATCH 0912/1293] Made sure that lines are not longer than 80 characters --- docs/api/dialog.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/docs/api/dialog.md b/docs/api/dialog.md index 22dd58db2d14..084e6bae0c4a 100644 --- a/docs/api/dialog.md +++ b/docs/api/dialog.md @@ -11,7 +11,9 @@ var dialog = require('dialog'); console.log(dialog.showOpenDialog({ properties: [ 'openFile', 'openDirectory', 'multiSelections' ]})); ``` -**Note for OS X**: If you want to present dialogs as sheets, the only thing you have to do is provide a `BrowserWindow` reference in the `browserWindow` parameter. +**Note for OS X**: If you want to present dialogs as sheets, the only thing you +have to do is provide a `BrowserWindow` reference in the `browserWindow` +parameter. ## dialog.showOpenDialog([browserWindow], [options], [callback]) @@ -41,14 +43,17 @@ selected, an example is: ] } ``` -The `extensions` array should contain extensions without wildcards or dots (e.g. `'png'` is good, `'.png'` and `'*.png'` are bad). To show all files, use the `'*'` wildcard (no other wildcard is supported). +The `extensions` array should contain extensions without wildcards or dots (e.g. +`'png'` is good, `'.png'` and `'*.png'` are bad). To show all files, use the +`'*'` wildcard (no other wildcard is supported). If a `callback` is passed, the API call would be asynchronous and the result would be passed via `callback(filenames)` **Note:** On Windows and Linux, an open dialog can not be both a file selector and a directory selector, so if you set `properties` to -`['openFile', 'openDirectory']` on these platforms, a directory selector will be shown. +`['openFile', 'openDirectory']` on these platforms, a directory selector will be +shown. ## dialog.showSaveDialog([browserWindow], [options], [callback]) @@ -72,7 +77,9 @@ will be passed via `callback(filename)` * `browserWindow` BrowserWindow * `options` Object - * `type` String - Can be `"none"`, `"info"`, `"error"`, `"question"` or `"warning"`. On Windows, "question" displays the same icon as "info", unless if you set an icon using the "icon" option + * `type` String - Can be `"none"`, `"info"`, `"error"`, `"question"` or + `"warning"`. On Windows, "question" displays the same icon as "info", unless + if you set an icon using the "icon" option * `buttons` Array - Array of texts for buttons * `title` String - Title of the message box, some platforms will not show it * `message` String - Content of the message box From acc0c616c4366b3a92419b78ad76be82251eeece Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Sat, 22 Aug 2015 14:07:45 +0200 Subject: [PATCH 0913/1293] Spec out doc styleguide --- docs/styleguide.md | 63 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 63 insertions(+) create mode 100644 docs/styleguide.md diff --git a/docs/styleguide.md b/docs/styleguide.md new file mode 100644 index 000000000000..a6189a79f258 --- /dev/null +++ b/docs/styleguide.md @@ -0,0 +1,63 @@ +# Electron Documentation Styleguide + +Find the appropriate section for your task: [reading Electron documentation](#) or [writing Electron documentation](#). + +## Writing Electron Documentation + +These are the ways that we construct the Electron documentation. + +- Maximum one `h1` title per page. +- Use `bash` instead of `cmd` in code blocks (because of syntax highlighter). +- Doc `h1` titles should match object name (i.e. `browser-window` → `BrowserWindow`). + - Hyphen separated filenames, however, are fine. +- No headers following headers, add at least a one-sentence description. +- Methods headers are wrapped in `code` ticks. +- Event headers are wrapped in singe 'quotation' marks. +- No nesting lists more than 2 levels (unfortunately because of markdown renderer). +- Add section titles: Events, Class Methods and Instance Methods. +- Use 'will' over 'would' when describing outcomes. +- Events and methods are `h3` headers. +- Optional arguments written as `function (required[, optional])`. + +## Reading Electron Documentation + +Here are some tips for understanding Electron documentation syntax. + +### Methods + +An example of [method](https://developer.mozilla.org/en-US/docs/Glossary/Method) documentation: + +--- + +`methodName(required[, optional]))` + +* `require` String, **required** +* `optional` Integer + +--- + +The method name is followed by the arguments it takes. Optional arguments are notated by brackets surrounding the optional argument as well as the comma required if this optional argument follows another argument. + +Below the method is more detailed information on each of the arguments. The type of argument is notated by either the common types: [`String`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), [`Number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number), [`Object`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object), [`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array) or a custom type like Electron's [`webContent`](api/web-content.md). + +### Events + +An example of [event](https://developer.mozilla.org/en-US/docs/Web/API/Event) documentation: + +--- + +Event: 'wake-up' + +Returns: + +* `time` String + +--- + +The event is a string that is used after a `.on` listener method. If it returns a value it and its type is noted below. If you were to listen and respond to this event it might look something like this: + +```javascript +Alarm.on('wake-up', function(time) { + console.log(time) +}) +``` From 3f52a9131273b230ca2d6822e3c4e4708420219d Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Sat, 22 Aug 2015 14:21:01 +0200 Subject: [PATCH 0914/1293] Create directory for KO translations --- {docs => docs-translations/ko}/README-ko.md | 0 {docs => docs-translations/ko}/api/accelerator-ko.md | 0 {docs => docs-translations/ko}/api/auto-updater-ko.md | 0 .../ko}/api/chrome-command-line-switches-ko.md | 0 {docs => docs-translations/ko}/api/clipboard-ko.md | 0 {docs => docs-translations/ko}/api/content-tracing-ko.md | 0 {docs => docs-translations/ko}/api/crash-reporter-ko.md | 0 {docs => docs-translations/ko}/api/file-object-ko.md | 0 {docs => docs-translations/ko}/api/frameless-window-ko.md | 0 {docs => docs-translations/ko}/api/global-shortcut-ko.md | 0 {docs => docs-translations/ko}/api/ipc-main-process-ko.md | 0 {docs => docs-translations/ko}/api/ipc-renderer-ko.md | 0 {docs => docs-translations/ko}/api/menu-item-ko.md | 0 {docs => docs-translations/ko}/api/native-image-ko.md | 0 {docs => docs-translations/ko}/api/power-monitor-ko.md | 0 {docs => docs-translations/ko}/api/power-save-blocker-ko.md | 0 {docs => docs-translations/ko}/api/process-ko.md | 0 {docs => docs-translations/ko}/api/protocol-ko.md | 0 {docs => docs-translations/ko}/api/remote-ko.md | 0 {docs => docs-translations/ko}/api/screen-ko.md | 0 {docs => docs-translations/ko}/api/shell-ko.md | 0 {docs => docs-translations/ko}/api/synopsis-ko.md | 0 {docs => docs-translations/ko}/api/tray-ko.md | 0 {docs => docs-translations/ko}/api/web-frame-ko.md | 0 {docs => docs-translations/ko}/api/web-view-tag-ko.md | 0 {docs => docs-translations/ko}/api/window-open-ko.md | 0 .../ko}/development/atom-shell-vs-node-webkit-ko.md | 0 .../ko}/development/build-instructions-linux-ko.md | 0 .../ko}/development/build-instructions-mac-ko.md | 0 .../ko}/development/build-instructions-windows-ko.md | 0 .../ko}/development/build-system-overview-ko.md | 0 {docs => docs-translations/ko}/development/coding-style-ko.md | 0 .../ko}/development/setting-up-symbol-server-ko.md | 0 .../ko}/development/source-code-directory-structure-ko.md | 0 .../ko}/tutorial/application-distribution-ko.md | 0 .../ko}/tutorial/application-packaging-ko.md | 0 .../ko}/tutorial/debugging-main-process-ko.md | 0 .../ko}/tutorial/desktop-environment-integration-ko.md | 0 {docs => docs-translations/ko}/tutorial/devtools-extension-ko.md | 0 .../ko}/tutorial/online-offline-events-ko.md | 0 {docs => docs-translations/ko}/tutorial/quick-start-ko.md | 0 .../ko}/tutorial/using-native-node-modules-ko.md | 0 .../ko}/tutorial/using-pepper-flash-plugin-ko.md | 0 .../ko}/tutorial/using-selenium-and-webdriver-ko.md | 0 44 files changed, 0 insertions(+), 0 deletions(-) rename {docs => docs-translations/ko}/README-ko.md (100%) rename {docs => docs-translations/ko}/api/accelerator-ko.md (100%) rename {docs => docs-translations/ko}/api/auto-updater-ko.md (100%) rename {docs => docs-translations/ko}/api/chrome-command-line-switches-ko.md (100%) rename {docs => docs-translations/ko}/api/clipboard-ko.md (100%) rename {docs => docs-translations/ko}/api/content-tracing-ko.md (100%) rename {docs => docs-translations/ko}/api/crash-reporter-ko.md (100%) rename {docs => docs-translations/ko}/api/file-object-ko.md (100%) rename {docs => docs-translations/ko}/api/frameless-window-ko.md (100%) rename {docs => docs-translations/ko}/api/global-shortcut-ko.md (100%) rename {docs => docs-translations/ko}/api/ipc-main-process-ko.md (100%) rename {docs => docs-translations/ko}/api/ipc-renderer-ko.md (100%) rename {docs => docs-translations/ko}/api/menu-item-ko.md (100%) rename {docs => docs-translations/ko}/api/native-image-ko.md (100%) rename {docs => docs-translations/ko}/api/power-monitor-ko.md (100%) rename {docs => docs-translations/ko}/api/power-save-blocker-ko.md (100%) rename {docs => docs-translations/ko}/api/process-ko.md (100%) rename {docs => docs-translations/ko}/api/protocol-ko.md (100%) rename {docs => docs-translations/ko}/api/remote-ko.md (100%) rename {docs => docs-translations/ko}/api/screen-ko.md (100%) rename {docs => docs-translations/ko}/api/shell-ko.md (100%) rename {docs => docs-translations/ko}/api/synopsis-ko.md (100%) rename {docs => docs-translations/ko}/api/tray-ko.md (100%) rename {docs => docs-translations/ko}/api/web-frame-ko.md (100%) rename {docs => docs-translations/ko}/api/web-view-tag-ko.md (100%) rename {docs => docs-translations/ko}/api/window-open-ko.md (100%) rename {docs => docs-translations/ko}/development/atom-shell-vs-node-webkit-ko.md (100%) rename {docs => docs-translations/ko}/development/build-instructions-linux-ko.md (100%) rename {docs => docs-translations/ko}/development/build-instructions-mac-ko.md (100%) rename {docs => docs-translations/ko}/development/build-instructions-windows-ko.md (100%) rename {docs => docs-translations/ko}/development/build-system-overview-ko.md (100%) rename {docs => docs-translations/ko}/development/coding-style-ko.md (100%) rename {docs => docs-translations/ko}/development/setting-up-symbol-server-ko.md (100%) rename {docs => docs-translations/ko}/development/source-code-directory-structure-ko.md (100%) rename {docs => docs-translations/ko}/tutorial/application-distribution-ko.md (100%) rename {docs => docs-translations/ko}/tutorial/application-packaging-ko.md (100%) rename {docs => docs-translations/ko}/tutorial/debugging-main-process-ko.md (100%) rename {docs => docs-translations/ko}/tutorial/desktop-environment-integration-ko.md (100%) rename {docs => docs-translations/ko}/tutorial/devtools-extension-ko.md (100%) rename {docs => docs-translations/ko}/tutorial/online-offline-events-ko.md (100%) rename {docs => docs-translations/ko}/tutorial/quick-start-ko.md (100%) rename {docs => docs-translations/ko}/tutorial/using-native-node-modules-ko.md (100%) rename {docs => docs-translations/ko}/tutorial/using-pepper-flash-plugin-ko.md (100%) rename {docs => docs-translations/ko}/tutorial/using-selenium-and-webdriver-ko.md (100%) diff --git a/docs/README-ko.md b/docs-translations/ko/README-ko.md similarity index 100% rename from docs/README-ko.md rename to docs-translations/ko/README-ko.md diff --git a/docs/api/accelerator-ko.md b/docs-translations/ko/api/accelerator-ko.md similarity index 100% rename from docs/api/accelerator-ko.md rename to docs-translations/ko/api/accelerator-ko.md diff --git a/docs/api/auto-updater-ko.md b/docs-translations/ko/api/auto-updater-ko.md similarity index 100% rename from docs/api/auto-updater-ko.md rename to docs-translations/ko/api/auto-updater-ko.md diff --git a/docs/api/chrome-command-line-switches-ko.md b/docs-translations/ko/api/chrome-command-line-switches-ko.md similarity index 100% rename from docs/api/chrome-command-line-switches-ko.md rename to docs-translations/ko/api/chrome-command-line-switches-ko.md diff --git a/docs/api/clipboard-ko.md b/docs-translations/ko/api/clipboard-ko.md similarity index 100% rename from docs/api/clipboard-ko.md rename to docs-translations/ko/api/clipboard-ko.md diff --git a/docs/api/content-tracing-ko.md b/docs-translations/ko/api/content-tracing-ko.md similarity index 100% rename from docs/api/content-tracing-ko.md rename to docs-translations/ko/api/content-tracing-ko.md diff --git a/docs/api/crash-reporter-ko.md b/docs-translations/ko/api/crash-reporter-ko.md similarity index 100% rename from docs/api/crash-reporter-ko.md rename to docs-translations/ko/api/crash-reporter-ko.md diff --git a/docs/api/file-object-ko.md b/docs-translations/ko/api/file-object-ko.md similarity index 100% rename from docs/api/file-object-ko.md rename to docs-translations/ko/api/file-object-ko.md diff --git a/docs/api/frameless-window-ko.md b/docs-translations/ko/api/frameless-window-ko.md similarity index 100% rename from docs/api/frameless-window-ko.md rename to docs-translations/ko/api/frameless-window-ko.md diff --git a/docs/api/global-shortcut-ko.md b/docs-translations/ko/api/global-shortcut-ko.md similarity index 100% rename from docs/api/global-shortcut-ko.md rename to docs-translations/ko/api/global-shortcut-ko.md diff --git a/docs/api/ipc-main-process-ko.md b/docs-translations/ko/api/ipc-main-process-ko.md similarity index 100% rename from docs/api/ipc-main-process-ko.md rename to docs-translations/ko/api/ipc-main-process-ko.md diff --git a/docs/api/ipc-renderer-ko.md b/docs-translations/ko/api/ipc-renderer-ko.md similarity index 100% rename from docs/api/ipc-renderer-ko.md rename to docs-translations/ko/api/ipc-renderer-ko.md diff --git a/docs/api/menu-item-ko.md b/docs-translations/ko/api/menu-item-ko.md similarity index 100% rename from docs/api/menu-item-ko.md rename to docs-translations/ko/api/menu-item-ko.md diff --git a/docs/api/native-image-ko.md b/docs-translations/ko/api/native-image-ko.md similarity index 100% rename from docs/api/native-image-ko.md rename to docs-translations/ko/api/native-image-ko.md diff --git a/docs/api/power-monitor-ko.md b/docs-translations/ko/api/power-monitor-ko.md similarity index 100% rename from docs/api/power-monitor-ko.md rename to docs-translations/ko/api/power-monitor-ko.md diff --git a/docs/api/power-save-blocker-ko.md b/docs-translations/ko/api/power-save-blocker-ko.md similarity index 100% rename from docs/api/power-save-blocker-ko.md rename to docs-translations/ko/api/power-save-blocker-ko.md diff --git a/docs/api/process-ko.md b/docs-translations/ko/api/process-ko.md similarity index 100% rename from docs/api/process-ko.md rename to docs-translations/ko/api/process-ko.md diff --git a/docs/api/protocol-ko.md b/docs-translations/ko/api/protocol-ko.md similarity index 100% rename from docs/api/protocol-ko.md rename to docs-translations/ko/api/protocol-ko.md diff --git a/docs/api/remote-ko.md b/docs-translations/ko/api/remote-ko.md similarity index 100% rename from docs/api/remote-ko.md rename to docs-translations/ko/api/remote-ko.md diff --git a/docs/api/screen-ko.md b/docs-translations/ko/api/screen-ko.md similarity index 100% rename from docs/api/screen-ko.md rename to docs-translations/ko/api/screen-ko.md diff --git a/docs/api/shell-ko.md b/docs-translations/ko/api/shell-ko.md similarity index 100% rename from docs/api/shell-ko.md rename to docs-translations/ko/api/shell-ko.md diff --git a/docs/api/synopsis-ko.md b/docs-translations/ko/api/synopsis-ko.md similarity index 100% rename from docs/api/synopsis-ko.md rename to docs-translations/ko/api/synopsis-ko.md diff --git a/docs/api/tray-ko.md b/docs-translations/ko/api/tray-ko.md similarity index 100% rename from docs/api/tray-ko.md rename to docs-translations/ko/api/tray-ko.md diff --git a/docs/api/web-frame-ko.md b/docs-translations/ko/api/web-frame-ko.md similarity index 100% rename from docs/api/web-frame-ko.md rename to docs-translations/ko/api/web-frame-ko.md diff --git a/docs/api/web-view-tag-ko.md b/docs-translations/ko/api/web-view-tag-ko.md similarity index 100% rename from docs/api/web-view-tag-ko.md rename to docs-translations/ko/api/web-view-tag-ko.md diff --git a/docs/api/window-open-ko.md b/docs-translations/ko/api/window-open-ko.md similarity index 100% rename from docs/api/window-open-ko.md rename to docs-translations/ko/api/window-open-ko.md diff --git a/docs/development/atom-shell-vs-node-webkit-ko.md b/docs-translations/ko/development/atom-shell-vs-node-webkit-ko.md similarity index 100% rename from docs/development/atom-shell-vs-node-webkit-ko.md rename to docs-translations/ko/development/atom-shell-vs-node-webkit-ko.md diff --git a/docs/development/build-instructions-linux-ko.md b/docs-translations/ko/development/build-instructions-linux-ko.md similarity index 100% rename from docs/development/build-instructions-linux-ko.md rename to docs-translations/ko/development/build-instructions-linux-ko.md diff --git a/docs/development/build-instructions-mac-ko.md b/docs-translations/ko/development/build-instructions-mac-ko.md similarity index 100% rename from docs/development/build-instructions-mac-ko.md rename to docs-translations/ko/development/build-instructions-mac-ko.md diff --git a/docs/development/build-instructions-windows-ko.md b/docs-translations/ko/development/build-instructions-windows-ko.md similarity index 100% rename from docs/development/build-instructions-windows-ko.md rename to docs-translations/ko/development/build-instructions-windows-ko.md diff --git a/docs/development/build-system-overview-ko.md b/docs-translations/ko/development/build-system-overview-ko.md similarity index 100% rename from docs/development/build-system-overview-ko.md rename to docs-translations/ko/development/build-system-overview-ko.md diff --git a/docs/development/coding-style-ko.md b/docs-translations/ko/development/coding-style-ko.md similarity index 100% rename from docs/development/coding-style-ko.md rename to docs-translations/ko/development/coding-style-ko.md diff --git a/docs/development/setting-up-symbol-server-ko.md b/docs-translations/ko/development/setting-up-symbol-server-ko.md similarity index 100% rename from docs/development/setting-up-symbol-server-ko.md rename to docs-translations/ko/development/setting-up-symbol-server-ko.md diff --git a/docs/development/source-code-directory-structure-ko.md b/docs-translations/ko/development/source-code-directory-structure-ko.md similarity index 100% rename from docs/development/source-code-directory-structure-ko.md rename to docs-translations/ko/development/source-code-directory-structure-ko.md diff --git a/docs/tutorial/application-distribution-ko.md b/docs-translations/ko/tutorial/application-distribution-ko.md similarity index 100% rename from docs/tutorial/application-distribution-ko.md rename to docs-translations/ko/tutorial/application-distribution-ko.md diff --git a/docs/tutorial/application-packaging-ko.md b/docs-translations/ko/tutorial/application-packaging-ko.md similarity index 100% rename from docs/tutorial/application-packaging-ko.md rename to docs-translations/ko/tutorial/application-packaging-ko.md diff --git a/docs/tutorial/debugging-main-process-ko.md b/docs-translations/ko/tutorial/debugging-main-process-ko.md similarity index 100% rename from docs/tutorial/debugging-main-process-ko.md rename to docs-translations/ko/tutorial/debugging-main-process-ko.md diff --git a/docs/tutorial/desktop-environment-integration-ko.md b/docs-translations/ko/tutorial/desktop-environment-integration-ko.md similarity index 100% rename from docs/tutorial/desktop-environment-integration-ko.md rename to docs-translations/ko/tutorial/desktop-environment-integration-ko.md diff --git a/docs/tutorial/devtools-extension-ko.md b/docs-translations/ko/tutorial/devtools-extension-ko.md similarity index 100% rename from docs/tutorial/devtools-extension-ko.md rename to docs-translations/ko/tutorial/devtools-extension-ko.md diff --git a/docs/tutorial/online-offline-events-ko.md b/docs-translations/ko/tutorial/online-offline-events-ko.md similarity index 100% rename from docs/tutorial/online-offline-events-ko.md rename to docs-translations/ko/tutorial/online-offline-events-ko.md diff --git a/docs/tutorial/quick-start-ko.md b/docs-translations/ko/tutorial/quick-start-ko.md similarity index 100% rename from docs/tutorial/quick-start-ko.md rename to docs-translations/ko/tutorial/quick-start-ko.md diff --git a/docs/tutorial/using-native-node-modules-ko.md b/docs-translations/ko/tutorial/using-native-node-modules-ko.md similarity index 100% rename from docs/tutorial/using-native-node-modules-ko.md rename to docs-translations/ko/tutorial/using-native-node-modules-ko.md diff --git a/docs/tutorial/using-pepper-flash-plugin-ko.md b/docs-translations/ko/tutorial/using-pepper-flash-plugin-ko.md similarity index 100% rename from docs/tutorial/using-pepper-flash-plugin-ko.md rename to docs-translations/ko/tutorial/using-pepper-flash-plugin-ko.md diff --git a/docs/tutorial/using-selenium-and-webdriver-ko.md b/docs-translations/ko/tutorial/using-selenium-and-webdriver-ko.md similarity index 100% rename from docs/tutorial/using-selenium-and-webdriver-ko.md rename to docs-translations/ko/tutorial/using-selenium-and-webdriver-ko.md From 6c984fac7c0be5fdc16cf99f1d3448f90f74a782 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Sat, 22 Aug 2015 14:23:57 +0200 Subject: [PATCH 0915/1293] Add file to KO translation docs --- {docs => docs-translations/ko}/api/dialog-ko.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename {docs => docs-translations/ko}/api/dialog-ko.md (100%) diff --git a/docs/api/dialog-ko.md b/docs-translations/ko/api/dialog-ko.md similarity index 100% rename from docs/api/dialog-ko.md rename to docs-translations/ko/api/dialog-ko.md From 04967de2ed060c22f119668441b072f3eb3aef81 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Sat, 22 Aug 2015 14:24:35 +0200 Subject: [PATCH 0916/1293] Move file to JP translation docs --- {docs/tutorial => docs-translations/jp}/quick-start-jp.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename {docs/tutorial => docs-translations/jp}/quick-start-jp.md (100%) diff --git a/docs/tutorial/quick-start-jp.md b/docs-translations/jp/quick-start-jp.md similarity index 100% rename from docs/tutorial/quick-start-jp.md rename to docs-translations/jp/quick-start-jp.md From 1964bb2accac9b9de41fdee310f88972659bb7fb Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Sat, 22 Aug 2015 14:24:43 +0200 Subject: [PATCH 0917/1293] Move files to ES translation docs --- {docs => docs-translations/es}/README-es.md | 0 .../es}/tutorial/application-distribution-es.md | 0 .../es}/tutorial/application-packaging-es.md | 0 .../es}/tutorial/debugging-main-process-es.md | 0 .../es}/tutorial/desktop-environment-integration-es.md | 0 {docs => docs-translations/es}/tutorial/devtools-extension-es.md | 0 .../es}/tutorial/online-offline-events-es.md | 0 {docs => docs-translations/es}/tutorial/quick-start-es.md | 0 .../es}/tutorial/using-native-node-modules-es.md | 0 .../es}/tutorial/using-pepper-flash-plugin-es.md | 0 .../es}/tutorial/using-selenium-and-webdriver-es.md | 0 11 files changed, 0 insertions(+), 0 deletions(-) rename {docs => docs-translations/es}/README-es.md (100%) rename {docs => docs-translations/es}/tutorial/application-distribution-es.md (100%) rename {docs => docs-translations/es}/tutorial/application-packaging-es.md (100%) rename {docs => docs-translations/es}/tutorial/debugging-main-process-es.md (100%) rename {docs => docs-translations/es}/tutorial/desktop-environment-integration-es.md (100%) rename {docs => docs-translations/es}/tutorial/devtools-extension-es.md (100%) rename {docs => docs-translations/es}/tutorial/online-offline-events-es.md (100%) rename {docs => docs-translations/es}/tutorial/quick-start-es.md (100%) rename {docs => docs-translations/es}/tutorial/using-native-node-modules-es.md (100%) rename {docs => docs-translations/es}/tutorial/using-pepper-flash-plugin-es.md (100%) rename {docs => docs-translations/es}/tutorial/using-selenium-and-webdriver-es.md (100%) diff --git a/docs/README-es.md b/docs-translations/es/README-es.md similarity index 100% rename from docs/README-es.md rename to docs-translations/es/README-es.md diff --git a/docs/tutorial/application-distribution-es.md b/docs-translations/es/tutorial/application-distribution-es.md similarity index 100% rename from docs/tutorial/application-distribution-es.md rename to docs-translations/es/tutorial/application-distribution-es.md diff --git a/docs/tutorial/application-packaging-es.md b/docs-translations/es/tutorial/application-packaging-es.md similarity index 100% rename from docs/tutorial/application-packaging-es.md rename to docs-translations/es/tutorial/application-packaging-es.md diff --git a/docs/tutorial/debugging-main-process-es.md b/docs-translations/es/tutorial/debugging-main-process-es.md similarity index 100% rename from docs/tutorial/debugging-main-process-es.md rename to docs-translations/es/tutorial/debugging-main-process-es.md diff --git a/docs/tutorial/desktop-environment-integration-es.md b/docs-translations/es/tutorial/desktop-environment-integration-es.md similarity index 100% rename from docs/tutorial/desktop-environment-integration-es.md rename to docs-translations/es/tutorial/desktop-environment-integration-es.md diff --git a/docs/tutorial/devtools-extension-es.md b/docs-translations/es/tutorial/devtools-extension-es.md similarity index 100% rename from docs/tutorial/devtools-extension-es.md rename to docs-translations/es/tutorial/devtools-extension-es.md diff --git a/docs/tutorial/online-offline-events-es.md b/docs-translations/es/tutorial/online-offline-events-es.md similarity index 100% rename from docs/tutorial/online-offline-events-es.md rename to docs-translations/es/tutorial/online-offline-events-es.md diff --git a/docs/tutorial/quick-start-es.md b/docs-translations/es/tutorial/quick-start-es.md similarity index 100% rename from docs/tutorial/quick-start-es.md rename to docs-translations/es/tutorial/quick-start-es.md diff --git a/docs/tutorial/using-native-node-modules-es.md b/docs-translations/es/tutorial/using-native-node-modules-es.md similarity index 100% rename from docs/tutorial/using-native-node-modules-es.md rename to docs-translations/es/tutorial/using-native-node-modules-es.md diff --git a/docs/tutorial/using-pepper-flash-plugin-es.md b/docs-translations/es/tutorial/using-pepper-flash-plugin-es.md similarity index 100% rename from docs/tutorial/using-pepper-flash-plugin-es.md rename to docs-translations/es/tutorial/using-pepper-flash-plugin-es.md diff --git a/docs/tutorial/using-selenium-and-webdriver-es.md b/docs-translations/es/tutorial/using-selenium-and-webdriver-es.md similarity index 100% rename from docs/tutorial/using-selenium-and-webdriver-es.md rename to docs-translations/es/tutorial/using-selenium-and-webdriver-es.md From f05ee4205dbe2029a94322b08363dfa36263f87e Mon Sep 17 00:00:00 2001 From: Eran Tiktin Date: Sat, 22 Aug 2015 19:50:54 +0300 Subject: [PATCH 0918/1293] Fix path comparison in api-ipc-spec One of the tests failed because in one of the paths the drive letter was upper case `C` and in the other it was lower case `c`. Paths in Windows are case insensitive, so this shouldn't fail. The fix was to lower case the paths before comparison (only on Windows). --- spec/api-ipc-spec.coffee | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/spec/api-ipc-spec.coffee b/spec/api-ipc-spec.coffee index 7c6148b559b0..142f06c00ff3 100644 --- a/spec/api-ipc-spec.coffee +++ b/spec/api-ipc-spec.coffee @@ -5,6 +5,13 @@ remote = require 'remote' BrowserWindow = remote.require 'browser-window' +comparePaths = (path1, path2) -> + if process.platform is 'win32' + # Paths in Windows are case insensitive. + path1 = path1.toLowerCase() + path2 = path2.toLowerCase() + assert.equal path1, path2 + describe 'ipc module', -> fixtures = path.join __dirname, 'fixtures' @@ -19,8 +26,8 @@ describe 'ipc module', -> assert.equal a.id, 1127 it 'should search module from the user app', -> - assert.equal path.normalize(remote.process.mainModule.filename), path.resolve(__dirname, 'static', 'main.js') - assert.equal path.normalize(remote.process.mainModule.paths[0]), path.resolve(__dirname, 'static', 'node_modules') + comparePaths path.normalize(remote.process.mainModule.filename), path.resolve(__dirname, 'static', 'main.js') + comparePaths path.normalize(remote.process.mainModule.paths[0]), path.resolve(__dirname, 'static', 'node_modules') describe 'remote.createFunctionWithReturnValue', -> it 'should be called in browser synchronously', -> From d7fda9c8cc93cbc5bbe5863d93ad187a8a6fd421 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Sun, 23 Aug 2015 11:17:19 +0200 Subject: [PATCH 0919/1293] Add links to docs translations --- docs/README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/README.md b/docs/README.md index d61df787c9da..a16113864d21 100644 --- a/docs/README.md +++ b/docs/README.md @@ -66,3 +66,9 @@ Modules for both processes: * [Build instructions (Windows)](development/build-instructions-windows.md) * [Build instructions (Linux)](development/build-instructions-linux.md) * [Setting up symbol server in debugger](development/setting-up-symbol-server.md) + +## Documentation Translations + +- [Korean](https://github.com/atom/electron/tree/master/docs-translations/ko) +- [Japanese](https://github.com/atom/electron/tree/master/docs-translations/jp) +- [Spanish](https://github.com/atom/electron/tree/master/docs-translations/es) From 29c39a3245ef4f759ab55344a2c51fd8a3055701 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Sun, 23 Aug 2015 17:19:37 +0200 Subject: [PATCH 0920/1293] Add documentation translation links --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 8b7d36046a76..ace7116c469a 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,12 @@ Guides and the API reference are located in the [docs](https://github.com/atom/electron/tree/master/docs) directory. It also contains documents describing how to build and contribute to Electron. +## Documentation Translations + +- [Korean](https://github.com/atom/electron/tree/master/docs-translations/ko) +- [Japanese](https://github.com/atom/electron/tree/master/docs-translations/jp) +- [Spanish](https://github.com/atom/electron/tree/master/docs-translations/es) + ## Community There is an [`electron` category on the Atom forums](http://discuss.atom.io/category/electron) From a0fea286320128377955fa369108a6b59229fcf3 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 24 Aug 2015 15:50:02 +0800 Subject: [PATCH 0921/1293] asar@0.7.x --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 2986a380c4ea..2ccaa24d3c0e 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "electron", "devDependencies": { - "asar": "0.5.0", + "asar": "0.7.x", "coffee-script": "^1.9.2", "coffeelint": "^1.9.4", "request": "*", From 33737498ec009a9fa67eb9350b6ca3e355a400e1 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 24 Aug 2015 16:17:15 +0800 Subject: [PATCH 0922/1293] Make sure guest view is destroyed immediately when embeder is closed --- atom/browser/lib/guest-view-manager.coffee | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/atom/browser/lib/guest-view-manager.coffee b/atom/browser/lib/guest-view-manager.coffee index 971c15cb1b85..398cdb5d9495 100644 --- a/atom/browser/lib/guest-view-manager.coffee +++ b/atom/browser/lib/guest-view-manager.coffee @@ -30,6 +30,10 @@ guestInstances = {} embedderElementsMap = {} reverseEmbedderElementsMap = {} +# Moves the last element of array to the first one. +moveLastToFirst = (list) -> + list.unshift list.pop() + # Generate guestInstanceId. getNextInstanceId = (webContents) -> ++nextInstanceId @@ -46,7 +50,13 @@ createGuest = (embedder, params) -> destroyEvents = ['destroyed', 'crashed', 'did-navigate-to-different-page'] destroy = -> destroyGuest embedder, id if guestInstances[id]? - embedder.once event, destroy for event in destroyEvents + for event in destroyEvents + embedder.once event, destroy + # Users might also listen to the crashed event, so We must ensure the guest + # is destroyed before users' listener gets called. It is done by moving our + # listener to the first one in queue. + listeners = embedder._events[event] + moveLastToFirst listeners if Array.isArray listeners guest.once 'destroyed', -> embedder.removeListener event, destroy for event in destroyEvents From 9b84dc4e1afbd5fdeed1d85abbc4a855ab091aeb Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Mon, 24 Aug 2015 14:38:29 +0200 Subject: [PATCH 0923/1293] Line wrap 80 --- docs/api/app.md | 58 +++++++++++++++++++++------------------- docs/api/auto-updater.md | 4 +-- docs/styleguide.md | 27 +++++++++++++------ 3 files changed, 52 insertions(+), 37 deletions(-) diff --git a/docs/api/app.md b/docs/api/app.md index 6a54dba3021a..a79b84a285a3 100644 --- a/docs/api/app.md +++ b/docs/api/app.md @@ -2,7 +2,8 @@ The `app` module is responsible for controlling the application's lifecycle. -The following example shows how to quit the application when the last window is closed: +The following example shows how to quit the application when the last window is +closed: ```javascript var app = require('app'); @@ -19,9 +20,9 @@ The `app` object emits the following events: Emitted when the application has finished basic startup. On Windows and Linux, the `will-finish-launching` event is the same as the `ready` event; on OS X, -this event represents the `applicationWillFinishLaunching` notification of `NSApplication`. -You would usually set up listeners for the `open-file` and `open-url` events here, -and start the crash reporter and auto updater. +this event represents the `applicationWillFinishLaunching` notification of +`NSApplication`. You would usually set up listeners for the `open-file` and +`open-url` events here, and start the crash reporter and auto updater. In most cases, you should just do everything in the `ready` event handler. @@ -58,7 +59,8 @@ Emitted when all windows have been closed and the application will quit. Calling `event.preventDefault()` will prevent the default behaviour, which is terminating the application. -See the description of the `window-all-closed` event for the differences between the `will-quit` and `window-all-closed` events. +See the description of the `window-all-closed` event for the differences between +the `will-quit` and `window-all-closed` events. ### Event: 'quit' @@ -71,12 +73,12 @@ Returns: * `event` Event * `path` String -Emitted when the user wants to open a file with the application. The `open-file` event -is usually emitted when the application is already open and the OS wants to reuse the -application to open the file. `open-file` is also emitted when a file is dropped onto the -dock and the application is not yet running. Make sure to listen for the `open-file` -event very early in your application startup to handle this case (even before the -`ready` event is emitted). +Emitted when the user wants to open a file with the application. The `open-file` +event is usually emitted when the application is already open and the OS wants +to reuse the application to open the file. `open-file` is also emitted when a +file is dropped onto the dock and the application is not yet running. Make sure +to listen for the `open-file` event very early in your application startup to +handle this case (even before the `ready` event is emitted). You should call `event.preventDefault()` if you want to handle this event. @@ -95,8 +97,8 @@ You should call `event.preventDefault()` if you want to handle this event. ### Event: 'activate-with-no-open-windows' Emitted when the application is activated while there are no open windows, which -usually happens when the user has closed all of the application's windows and then -clicks on the application's dock icon. +usually happens when the user has closed all of the application's windows and +then clicks on the application's dock icon. ### Event: 'browser-window-blur' @@ -137,9 +139,10 @@ app.on('select-certificate', function(event, host, url, list, callback) { }) ``` -The `url` corresponds to the navigation entry requesting the client certificate and `callback` needs to be called with an entry filtered from the list. -Using `event.preventDefault()` prevents the application from using the first certificate -from the store. +The `url` corresponds to the navigation entry requesting the client certificate +and `callback` needs to be called with an entry filtered from the list. Using +`event.preventDefault()` prevents the application from using the first +certificate from the store. ### Event: 'gpu-process-crashed' @@ -155,9 +158,9 @@ Try to close all windows. The `before-quit` event will emitted first. If all windows are successfully closed, the `will-quit` event will be emitted and by default the application will terminate. -This method guarantees that all `beforeunload` and `unload` event handlers are correctly -executed. It is possible that a window cancels the quitting by returning -`false` in the `beforeunload` event handler. +This method guarantees that all `beforeunload` and `unload` event handlers are +correctly executed. It is possible that a window cancels the quitting by +returning `false` in the `beforeunload` event handler. ### `app.getAppPath()` @@ -208,8 +211,8 @@ directory. If you want to change this location, you have to override the ### `app.getVersion()` Returns the version of the loaded application. If no version is found in the -application's `package.json` file, the version of the current bundle or executable is -returned. +application's `package.json` file, the version of the current bundle or +executable is returned. ### `app.getName()` @@ -258,8 +261,8 @@ Adds `tasks` to the [Tasks][tasks] category of the JumpList on Windows. * `title` String - The string to be displayed in a JumpList. * `description` String - Description of this task. * `iconPath` String - The absolute path to an icon to be displayed in a - JumpList, which can be an arbitrary resource file that contains an icon. You can - usually specify `process.execPath` to show the icon of the program. + JumpList, which can be an arbitrary resource file that contains an icon. You + can usually specify `process.execPath` to show the icon of the program. * `iconIndex` Integer - The icon index in the icon file. If an icon file consists of two or more icons, set this value to identify the icon. If an icon file consists of one icon, this value is 0. @@ -275,7 +278,8 @@ to control some low-level Chromium behaviors. ### `app.commandLine.appendArgument(value)` -Append an argument to Chromium's command line. The argument will be quoted correctly. +Append an argument to Chromium's command line. The argument will be quoted +correctly. **Note:** This will not affect `process.argv`. @@ -287,9 +291,9 @@ Append an argument to Chromium's command line. The argument will be quoted corre When `critical` is passed, the dock icon will bounce until either the application becomes active or the request is canceled. -When `informational` is passed, the dock icon will bounce for one second. However, -the request remains active until either the application becomes active or -the request is canceled. +When `informational` is passed, the dock icon will bounce for one second. +However, the request remains active until either the application becomes active +or the request is canceled. Returns an ID representing the request. diff --git a/docs/api/auto-updater.md b/docs/api/auto-updater.md index b2ebcc40a447..4e1dc5e0deb4 100644 --- a/docs/api/auto-updater.md +++ b/docs/api/auto-updater.md @@ -135,8 +135,8 @@ Returns: * `updateUrl` String * `quitAndUpdate` Function -Emitted when an update has been downloaded. Calling `quitAndUpdate()` will restart -the application and install the update. +Emitted when an update has been downloaded. Calling `quitAndUpdate()` will +restart the application and install the update. ## Methods diff --git a/docs/styleguide.md b/docs/styleguide.md index a6189a79f258..e10cfc3313e3 100644 --- a/docs/styleguide.md +++ b/docs/styleguide.md @@ -1,6 +1,7 @@ # Electron Documentation Styleguide -Find the appropriate section for your task: [reading Electron documentation](#) or [writing Electron documentation](#). +Find the appropriate section for your task: [reading Electron documentation](#) +or [writing Electron documentation](#). ## Writing Electron Documentation @@ -8,12 +9,14 @@ These are the ways that we construct the Electron documentation. - Maximum one `h1` title per page. - Use `bash` instead of `cmd` in code blocks (because of syntax highlighter). -- Doc `h1` titles should match object name (i.e. `browser-window` → `BrowserWindow`). +- Doc `h1` titles should match object name (i.e. `browser-window` → + `BrowserWindow`). - Hyphen separated filenames, however, are fine. - No headers following headers, add at least a one-sentence description. - Methods headers are wrapped in `code` ticks. - Event headers are wrapped in singe 'quotation' marks. -- No nesting lists more than 2 levels (unfortunately because of markdown renderer). +- No nesting lists more than 2 levels (unfortunately because of markdown + renderer). - Add section titles: Events, Class Methods and Instance Methods. - Use 'will' over 'would' when describing outcomes. - Events and methods are `h3` headers. @@ -25,7 +28,8 @@ Here are some tips for understanding Electron documentation syntax. ### Methods -An example of [method](https://developer.mozilla.org/en-US/docs/Glossary/Method) documentation: +An example of [method](https://developer.mozilla.org/en-US/docs/Glossary/Method) +documentation: --- @@ -36,13 +40,18 @@ An example of [method](https://developer.mozilla.org/en-US/docs/Glossary/Method) --- -The method name is followed by the arguments it takes. Optional arguments are notated by brackets surrounding the optional argument as well as the comma required if this optional argument follows another argument. +The method name is followed by the arguments it takes. Optional arguments are +notated by brackets surrounding the optional argument as well as the comma +required if this optional argument follows another argument. -Below the method is more detailed information on each of the arguments. The type of argument is notated by either the common types: [`String`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), [`Number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number), [`Object`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object), [`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array) or a custom type like Electron's [`webContent`](api/web-content.md). +Below the method is more detailed information on each of the arguments. The type +of argument is notated by either the common types: [`String`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), [`Number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number), [`Object`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object), [`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array) +or a custom type like Electron's [`webContent`](api/web-content.md). ### Events -An example of [event](https://developer.mozilla.org/en-US/docs/Web/API/Event) documentation: +An example of [event](https://developer.mozilla.org/en-US/docs/Web/API/Event) +documentation: --- @@ -54,7 +63,9 @@ Returns: --- -The event is a string that is used after a `.on` listener method. If it returns a value it and its type is noted below. If you were to listen and respond to this event it might look something like this: +The event is a string that is used after a `.on` listener method. If it returns +a value it and its type is noted below. If you were to listen and respond to +this event it might look something like this: ```javascript Alarm.on('wake-up', function(time) { From d87c8a829141d06477986448f328dcb87a8bc7a1 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Mon, 24 Aug 2015 14:56:19 +0200 Subject: [PATCH 0924/1293] Add optional notation --- docs/api/app.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/app.md b/docs/api/app.md index a79b84a285a3..4ca67225b3f3 100644 --- a/docs/api/app.md +++ b/docs/api/app.md @@ -285,7 +285,7 @@ correctly. ### app.dock.bounce([type]) -* `type` String - Can be `critical` or `informational`. The default is +* `type` String (optional) - Can be `critical` or `informational`. The default is `informational` When `critical` is passed, the dock icon will bounce until either the From 7a23add23b51d5c107510504272942b509fe0c99 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Mon, 24 Aug 2015 21:14:38 +0800 Subject: [PATCH 0925/1293] Support index.js module resolution at startup of Electron. --- atom/browser/lib/init.coffee | 5 ++++- docs/tutorial/quick-start.md | 3 +++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/atom/browser/lib/init.coffee b/atom/browser/lib/init.coffee index 069eed8d1b53..1299364d2fa6 100644 --- a/atom/browser/lib/init.coffee +++ b/atom/browser/lib/init.coffee @@ -92,5 +92,8 @@ app.setAppPath packagePath # Load the chrome extension support. require './chrome-extension' +# Set main startup script of the app. +mainStartupScript = packageJson.main or 'index.js' + # Finally load app's main.js and transfer control to C++. -Module._load path.join(packagePath, packageJson.main), Module, true +Module._load path.join(packagePath, mainStartupScript), Module, true diff --git a/docs/tutorial/quick-start.md b/docs/tutorial/quick-start.md index 197cf0d3b32b..8fc696e0bcda 100644 --- a/docs/tutorial/quick-start.md +++ b/docs/tutorial/quick-start.md @@ -67,6 +67,9 @@ like this: } ``` +__Note__: If the `main` field is not present in `package.json`, Electron will +attempt to load an `index.js`. + The `main.js` should create windows and handle system events, a typical example being: From 90392e92316c620aed1ae84ac8061a367afb8793 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Mon, 24 Aug 2015 14:35:43 -0700 Subject: [PATCH 0926/1293] Standardize clipboard --- docs/api/clipboard.md | 61 +++++++++++++++++++++++-------------------- 1 file changed, 33 insertions(+), 28 deletions(-) diff --git a/docs/api/clipboard.md b/docs/api/clipboard.md index b2331b6279cc..c66b8c839f73 100644 --- a/docs/api/clipboard.md +++ b/docs/api/clipboard.md @@ -1,7 +1,6 @@ # clipboard -The `clipboard` provides methods to perform copy and paste operations. The following example -shows how to write a string to the clipboard: +The `clipboard` object provides methods to perform copy and paste operations. The following example shows how to write a string to the clipboard: ```javascript var clipboard = require('clipboard'); @@ -17,59 +16,65 @@ clipboard.writeText('Example String', 'selection'); console.log(clipboard.readText('selection')); ``` -## clipboard.readText([type]) +## Methods -* `type` String +The `clipboard` object has the following methods: + +### `clipboard.readText([type])` + +* `type` String (optional) Returns the content in the clipboard as plain text. -## clipboard.writeText(text[, type]) +### `clipboard.writeText(text[, type])` * `text` String -* `type` String +* `type` String (optional) Writes the `text` into the clipboard as plain text. -## clipboard.readHtml([type]) +### `clipboard.readHtml([type])` -* `type` String +* `type` String (optional) Returns the content in the clipboard as markup. -## clipboard.writeHtml(markup[, type]) +### `clipboard.writeHtml(markup[, type])` * `markup` String -* `type` String +* `type` String (optional) -Writes `markup` into the clipboard. +Writes `markup` to the clipboard. -## clipboard.readImage([type]) +### `clipboard.readImage([type])` -* `type` String +* `type` String (optional) Returns the content in the clipboard as a [NativeImage](native-image.md). -## clipboard.writeImage(image[, type]) +### `clipboard.writeImage(image[, type])` * `image` [NativeImage](native-image.md) -* `type` String +* `type` String (optional) -Writes `image` into the clipboard. +Writes `image` to the clipboard. -## clipboard.clear([type]) +### `clipboard.clear([type])` -* `type` String +* `type` String (optional) -Clears the clipboard. +Clears the clipboard content. -## clipboard.availableFormats([type]) +### `clipboard.availableFormats([type])` -Returns an array of supported `format` for the clipboard `type`. +* `type` String (optional) -## clipboard.has(data[, type]) +Returns an array of supported formats for the clipboard `type`. + +### `clipboard.has(data[, type])` _Experimental_ * `data` String -* `type` String +* `type` String (optional) Returns whether the clipboard supports the format of specified `data`. @@ -80,25 +85,25 @@ console.log(clipboard.has('

selection

')); **Note:** This API is experimental and could be removed in future. -## clipboard.read(data[, type]) +### `clipboard.read(data[, type])` _Experimental_ * `data` String -* `type` String +* `type` String (optional) Reads `data` from the clipboard. **Note:** This API is experimental and could be removed in future. -## clipboard.write(data[, type]) +### `clipboard.write(data[, type])` * `data` Object * `text` String * `html` String * `image` [NativeImage](native-image.md) -* `type` String +* `type` String (optional) ```javascript var clipboard = require('clipboard'); clipboard.write({text: 'test', html: "test"}); ``` -Writes `data` into clipboard. +Writes `data` to the clipboard. From 5018fe1e1737513f679df96075dd0dd5a44e577c Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Mon, 24 Aug 2015 15:14:13 -0700 Subject: [PATCH 0927/1293] Revert "Add links to docs translations" This reverts commit d7fda9c8cc93cbc5bbe5863d93ad187a8a6fd421. --- docs/README.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/docs/README.md b/docs/README.md index a16113864d21..d61df787c9da 100644 --- a/docs/README.md +++ b/docs/README.md @@ -66,9 +66,3 @@ Modules for both processes: * [Build instructions (Windows)](development/build-instructions-windows.md) * [Build instructions (Linux)](development/build-instructions-linux.md) * [Setting up symbol server in debugger](development/setting-up-symbol-server.md) - -## Documentation Translations - -- [Korean](https://github.com/atom/electron/tree/master/docs-translations/ko) -- [Japanese](https://github.com/atom/electron/tree/master/docs-translations/jp) -- [Spanish](https://github.com/atom/electron/tree/master/docs-translations/es) From f74ce9cc1cd47f3617170227606b624fec262029 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Mon, 24 Aug 2015 15:18:40 -0700 Subject: [PATCH 0928/1293] Add items to style guide list --- docs/styleguide.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/styleguide.md b/docs/styleguide.md index e10cfc3313e3..9a81771598d2 100644 --- a/docs/styleguide.md +++ b/docs/styleguide.md @@ -14,13 +14,17 @@ These are the ways that we construct the Electron documentation. - Hyphen separated filenames, however, are fine. - No headers following headers, add at least a one-sentence description. - Methods headers are wrapped in `code` ticks. -- Event headers are wrapped in singe 'quotation' marks. +- Event headers are wrapped in single 'quotation' marks. - No nesting lists more than 2 levels (unfortunately because of markdown renderer). - Add section titles: Events, Class Methods and Instance Methods. - Use 'will' over 'would' when describing outcomes. - Events and methods are `h3` headers. - Optional arguments written as `function (required[, optional])`. +- Optional arguments are denoted when called out in list. +- Line length is 80-column wrapped. +- Platform specific methods are noted in italics following method header. + - ```### `method(foo, bar)` _Mac_``` ## Reading Electron Documentation From 7f72207e6636c39b8485716689fab125b5513f37 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Mon, 24 Aug 2015 15:33:07 -0700 Subject: [PATCH 0929/1293] Add platform label where applicable --- docs/api/app.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/api/app.md b/docs/api/app.md index 4ca67225b3f3..7e5ec57d5a41 100644 --- a/docs/api/app.md +++ b/docs/api/app.md @@ -245,7 +245,7 @@ bar, and on OS X you can visit it from dock menu. Clears the recent documents list. -### `app.setUserTasks(tasks)` +### `app.setUserTasks(tasks)` _Windows_ * `tasks` Array - Array of `Task` objects @@ -283,7 +283,7 @@ correctly. **Note:** This will not affect `process.argv`. -### app.dock.bounce([type]) +### `app.dock.bounce([type])` _OS X_ * `type` String (optional) - Can be `critical` or `informational`. The default is `informational` @@ -299,7 +299,7 @@ Returns an ID representing the request. **Note:** This API is only available on OS X. -### `app.dock.cancelBounce(id)` +### `app.dock.cancelBounce(id)` _OS X_ * `id` Integer @@ -307,7 +307,7 @@ Cancel the bounce of `id`. **Note:** This API is only available on OS X. -### `app.dock.setBadge(text)` +### `app.dock.setBadge(text)` _OS X_ * `text` String @@ -315,25 +315,25 @@ Sets the string to be displayed in the dock’s badging area. **Note:** This API is only available on OS X. -### `app.dock.getBadge()` +### `app.dock.getBadge()` _OS X_ Returns the badge string of the dock. **Note:** This API is only available on OS X. -### `app.dock.hide()` +### `app.dock.hide()` _OS X_ Hides the dock icon. **Note:** This API is only available on OS X. -### `app.dock.show()` +### `app.dock.show()` _OS X_ Shows the dock icon. **Note:** This API is only available on OS X. -### `app.dock.setMenu(menu)` +### `app.dock.setMenu(menu)` _OS X_ * `menu` Menu From 7a158773f346ef1b93c39b18d7dc5fcc4ee98592 Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Tue, 25 Aug 2015 08:04:07 +0900 Subject: [PATCH 0930/1293] Remove remain sentences --- docs/api/content-tracing-ko.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/api/content-tracing-ko.md b/docs/api/content-tracing-ko.md index 22409d4f256c..a0f5e3f90635 100644 --- a/docs/api/content-tracing-ko.md +++ b/docs/api/content-tracing-ko.md @@ -135,5 +135,3 @@ process. ## tracing.cancelWatchEvent() Watch 이벤트를 중단합니다. 만약 추적이 활성화되어 있다면 이 함수는 watch 이벤트 콜백과 race가 일어날 것입니다. - -Cancel the watch event. If tracing is enabled, this may race with the watch event callback. From 3740161caa2cc749f0b0b3e879968ba42a136edd Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Tue, 25 Aug 2015 08:04:07 +0900 Subject: [PATCH 0931/1293] Remove remain sentences --- docs-translations/ko/api/content-tracing-ko.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs-translations/ko/api/content-tracing-ko.md b/docs-translations/ko/api/content-tracing-ko.md index 22409d4f256c..a0f5e3f90635 100644 --- a/docs-translations/ko/api/content-tracing-ko.md +++ b/docs-translations/ko/api/content-tracing-ko.md @@ -135,5 +135,3 @@ process. ## tracing.cancelWatchEvent() Watch 이벤트를 중단합니다. 만약 추적이 활성화되어 있다면 이 함수는 watch 이벤트 콜백과 race가 일어날 것입니다. - -Cancel the watch event. If tracing is enabled, this may race with the watch event callback. From 5a37f964342992da3be5f3fa41ab203322028a8c Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Tue, 25 Aug 2015 10:14:52 +0900 Subject: [PATCH 0932/1293] Remove comments about remote buffer Remove comments about remote buffer in browser-window.md, because remote buffer now supports in remote module. --- docs/api/browser-window.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 30df1d93371d..14621ed5a1e6 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -589,10 +589,6 @@ called with `callback(image)`, the `image` is an instance of [NativeImage](native-image.md) that stores data of the snapshot. Omitting the `rect` would capture the whole visible page. -**Note:** Be sure to read documents on remote buffer in -[remote](remote.md) if you are going to use this API in renderer -process. - ### BrowserWindow.print([options]) Same with `webContents.print([options])` From 1518ff6d221710d57295987b922648248059fba0 Mon Sep 17 00:00:00 2001 From: Robo Date: Tue, 18 Aug 2015 22:32:34 +0530 Subject: [PATCH 0933/1293] webContents: exit tabbed fullscreen when esc key is pressed --- atom/browser/api/atom_api_web_contents.cc | 5 ++++- atom/browser/common_web_contents_delegate.h | 2 ++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 63707f8dcc2d..59a50d5656ce 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -277,7 +277,10 @@ bool WebContents::IsPopupOrPanel(const content::WebContents* source) const { void WebContents::HandleKeyboardEvent( content::WebContents* source, const content::NativeWebKeyboardEvent& event) { - if (type_ == BROWSER_WINDOW) { + if (event.windowsKeyCode == ui::VKEY_ESCAPE && is_html_fullscreen()) { + // Escape exits tabbed fullscreen mode. + ExitFullscreenModeForTab(source); + } else if (type_ == BROWSER_WINDOW) { owner_window()->HandleKeyboardEvent(source, event); } else if (type_ == WEB_VIEW && guest_delegate_) { // Send the unhandled keyboard events back to the embedder. diff --git a/atom/browser/common_web_contents_delegate.h b/atom/browser/common_web_contents_delegate.h index e21cd24e9107..495b5501a0d1 100644 --- a/atom/browser/common_web_contents_delegate.h +++ b/atom/browser/common_web_contents_delegate.h @@ -48,6 +48,8 @@ class CommonWebContentsDelegate NativeWindow* owner_window() const { return owner_window_.get(); } + bool is_html_fullscreen() const { return html_fullscreen_; } + protected: // content::WebContentsDelegate: content::WebContents* OpenURLFromTab( From 5dc5f52f32628f314da94634b599dcb95ef3ebb5 Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Tue, 25 Aug 2015 14:43:37 +0900 Subject: [PATCH 0934/1293] Fix typos and improve grammer, translate more files Translate content-tracing-ko.md file. Fix typos, improve grammer in tutorials and update as upstream. --- README-ko.md | 29 +-- .../ko/api/content-tracing-ko.md | 22 +-- docs-translations/ko/api/dialog-ko.md | 7 +- {docs => docs-translations/ko}/api/menu-ko.md | 9 +- docs-translations/ko/api/native-image-ko.md | 2 + docs-translations/ko/api/protocol-ko.md | 180 ++++++++++-------- .../tutorial/application-distribution-ko.md | 11 +- .../ko/tutorial/application-packaging-ko.md | 6 +- .../ko/tutorial/quick-start-ko.md | 23 ++- 9 files changed, 156 insertions(+), 133 deletions(-) rename {docs => docs-translations/ko}/api/menu-ko.md (94%) diff --git a/README-ko.md b/README-ko.md index fb38a44794c9..91459c6adf2e 100644 --- a/README-ko.md +++ b/README-ko.md @@ -8,23 +8,22 @@ :zap: *이전까지 Atom Shell로 알려져 있었습니다* :zap: +Electron 프레임워크는 JavaScript, HTML 그리고 CSS를 사용하여 Cross-Platform 데스크톱 어플리케이션을 개발할 수 있도록 해주는 프레임워크입니다. 이 프레임워크는 [io.js](http://iojs.org) 와 +[Chromium](http://www.chromium.org)을 기반으로 만들어 졌으며 [Atom Editor](https://github.com/atom/atom)에 사용되고 있습니다. -Electron은 JavaScript, HTML 그리고 CSS를 이용하여 Cross-Platform 데스크톱 어플리케이션을 개발할 수 있도록 해주는 프레임워크입니다. 이 프레임워크는 [io.js](http://iojs.org) 와 -[Chromium](http://www.chromium.org) 을 기반으로 만들어 졌으며 [Atom Editor](https://github.com/atom/atom) 에 사용되고 있습니다. - -Electron에 대한 중요한 알림을 받으려면 Twitter에서 [@ElectronJS](https://twitter.com/electronjs)를 Follow하세요. +Electron에 대한 중요한 알림을 받고 싶다면 Twitter에서 [@ElectronJS](https://twitter.com/electronjs)를 팔로우 하세요. ## 다운로드 Linux, Windows, Mac용으로 미리 빌드된 Electron 바이너리와 디버그 심볼이 준비되어 있습니다. [releases](https://github.com/atom/electron/releases) 페이지에서 받아 볼 수 있습니다. -또한 [`npm`](https://docs.npmjs.com/)을 이용하여 미리 빌드된 Electron 바이너리를 받을 수 있습니다: +또한 [`npm`](https://docs.npmjs.com/)을 통해 미리 빌드된 Electron 바이너리를 받을 수도 있습니다: ```sh -# $PATH에 `electron`을 등록하고 전역에 설치합니다. +# $PATH에 `electron` 커맨드를 등록하고 전역에 설치합니다. npm install electron-prebuilt -g -# 개발용 dependency로 설치합니다. +# 개발 의존성 모듈 형태로 설치합니다. npm install electron-prebuilt --save-dev ``` @@ -32,13 +31,19 @@ npm install electron-prebuilt --save-dev - [China](https://npm.taobao.org/mirrors/electron) -## 참조문서 +## 참조 문서 -[docs](https://github.com/atom/electron/tree/master/docs/README-ko.md) 에 프레임워크 사용 가이드와 API 레퍼런스가 있습니다. -추가적으로 Electron을 빌드 하는 방법과 프로젝트에 기여하는 방법이 문서에 포함되어 있으니 참고하시기 바랍니다. +[Docs](https://github.com/atom/electron/tree/master/docs/README-ko.md)에 개발 가이드와 API 레퍼런스가 있습니다. +Electron을 빌드 하는 방법과 프로젝트에 기여하는 방법도 문서에 포함되어 있으니 참고하시기 바랍니다. + +## 참조 문서(번역) + +- [한국어](https://github.com/atom/electron/tree/master/docs-translations/ko) +- [일본어](https://github.com/atom/electron/tree/master/docs-translations/jp) +- [스페인어](https://github.com/atom/electron/tree/master/docs-translations/es) ## 커뮤니티 -[Atom 포럼내의 `electron` 카테고리](http://discuss.atom.io/category/electron) 와 Freenode `#atom-shell` 채팅채널이 있습니다. +[Atom 포럼내의 `electron` 카테고리](http://discuss.atom.io/category/electron)와 Freenode `#atom-shell` 채팅 채널에서 활발하게 토론이 이어지고 있습니다. -[awesome-electron](https://github.com/sindresorhus/awesome-electron) 에 커뮤니티가 운영중인 유용한 예제 앱과 툴, 리소스가 있으니 한번 탐색해 보시기 바랍니다. +[awesome-electron](https://github.com/sindresorhus/awesome-electron) 프로젝트엔 커뮤니티가 운영중인 유용한 예제 어플리케이션과 도구, 리소스가 있으니 한번 참고해 보시기 바랍니다. diff --git a/docs-translations/ko/api/content-tracing-ko.md b/docs-translations/ko/api/content-tracing-ko.md index a0f5e3f90635..1ec019d92831 100644 --- a/docs-translations/ko/api/content-tracing-ko.md +++ b/docs-translations/ko/api/content-tracing-ko.md @@ -72,8 +72,8 @@ tracing.startRecording('*', tracing.DEFAULT_OPTIONS, function() { Child 프로세스는 일반적으로 추적 데이터와 희귀한 플러시 그리고 추적 데이터를 메인 프로세스로 보내는 작업에 대해 캐싱 합니다. 이러한 일을 하는 이유는 IPC를 통해 추적 데이터를 보내는 작업은 매우 비싼 연산을 동반하기 때문입니다. -우리는 추적에 의한 런타임 오버헤드를 피하는 것을 지향합니다. -그래서 트레이싱이 끝나면 모든 child 프로세스에 보류된 추적 데이터를 플러시 할 것인지 물어봅니다. +우리는 추적에 의한 런타임 오버헤드를 피하고자 합니다. +그래서 추적이 끝나면 모든 child 프로세스에 보류된 추적 데이터를 플러시 할 것인지 물어봅니다. 모든 child 프로세스가 `stopRecording` 요청을 받으면 `callback`에 추적 데이터를 포함한 파일을 전달됩니다. @@ -107,21 +107,18 @@ Child 프로세스는 일반적으로 추적 데이터와 희귀한 플러시 현재 모니터링 추적 데이터를 가져옵니다. -Child processes typically are caching trace data and only rarely flush and send -trace data back to the main process. That is because it may be an expensive -operation to send the trace data over IPC, and we would like to avoid unneeded -runtime overhead of tracing. So, to end tracing, we must asynchronously ask all -child processes to flush any pending trace data. +자식 프로세스들은 일반적으로 추적 데이터를 캐싱하며 드물게 플러시 하거나 메인 프로세스로 추적 데이터를 보냅니다. +왜냐하면 IPC를 통해 추적 데이터를 보내는데에는 많은 자원을 소비하기 때문입니다. +그리고 우리는 추적시 발생하는 불필요한 런타임 오버헤드를 피하고자 합니다. +그래서 추적이 끝나면 반드시 비동기로 자식 프로세스들의 보류된 추적 데이터를 플러시 할 것인지 물어봅니다. -Once all child processes have acked to the `captureMonitoringSnapshot` request, -the `callback` will be invoked with a file that contains the traced data. +모든 자식 프로세스가 `captureMonitoringSnapshot` 요청을 받으면 추적 데이터 파일을 포함하는 `callback`이 호출됩니다. ## tracing.getTraceBufferUsage(callback) * `callback` Function -Get the maximum across processes of trace buffer percent full state. When the -TraceBufferUsage value is determined, the `callback` is called. +추적 버퍼 % 전체 상태의 프로세스간 최대치를 가져옵니다. TraceBufferUsage 값이 결정되면 `callback`이 호출됩니다. ## tracing.setWatchEvent(categoryName, eventName, callback) @@ -129,8 +126,7 @@ TraceBufferUsage value is determined, the `callback` is called. * `eventName` String * `callback` Function -`callback` will will be called every time the given event occurs on any -process. +`callback`은 지정된 이벤트가 어떤 작업을 발생시킬 때마다 호출됩니다. ## tracing.cancelWatchEvent() diff --git a/docs-translations/ko/api/dialog-ko.md b/docs-translations/ko/api/dialog-ko.md index 11b06f99ae9c..2f24c659f913 100644 --- a/docs-translations/ko/api/dialog-ko.md +++ b/docs-translations/ko/api/dialog-ko.md @@ -35,11 +35,16 @@ console.log(dialog.showOpenDialog({ properties: [ 'openFile', 'openDirectory', ' filters: [ { name: 'Images', extensions: ['jpg', 'png', 'gif'] }, { name: 'Movies', extensions: ['mkv', 'avi', 'mp4'] }, - { name: 'Custom File Type', extensions: ['as'] } + { name: 'Custom File Type', extensions: ['as'] }, + { name: 'All Files', extensions: ['*'] } ] } ``` +`extensions` 배열은 반드시 와일드카드와 마침표를 제외한 파일 확장자를 포함시켜야 합니다. +예를 들어 `'png'`는 가능하지만 `'.png'`와 `'*.png'`는 안됩니다. +모든 파일을 보여주려면 `'*'`와 같은 와일드카드를 사용하면 됩니다. (다른 와일드카드는 지원하지 않습니다) + `callback`이 전달되면 메소드가 비동기로 작동되며 결과는 `callback(filenames)`을 통해 전달됩니다. Windows와 Linux에선 파일 선택 모드, 디렉터리 선택 모드를 동시에 사용할 수 없습니다. diff --git a/docs/api/menu-ko.md b/docs-translations/ko/api/menu-ko.md similarity index 94% rename from docs/api/menu-ko.md rename to docs-translations/ko/api/menu-ko.md index fa285dc03e33..7f2b5ad90c80 100644 --- a/docs/api/menu-ko.md +++ b/docs-translations/ko/api/menu-ko.md @@ -1,10 +1,11 @@ # menu -`Menu` 클래스는 어플리케이션 메뉴와 컨텍스트 메뉴를 만들 때 사용할 수 있습니다. -각 메뉴는 여러 개의 메뉴 아이템으로 구성되어 있으며 서브 메뉴를 가질 수도 있습니다. +`Menu` 클래스는 어플리케이션 메뉴와 컨텍스트 메뉴를 만들 때 사용됩니다. +메뉴는 여러 개의 메뉴 아이템으로 구성되고 서브 메뉴를 가질 수도 있습니다. 다음 예제는 웹 페이지 내에서 [remote](remote-ko.md) 모듈을 활용하여 동적으로 메뉴를 생성하는 예제입니다. -그리고 이 예제에서 만들어진 메뉴는 유저가 페이지에서 오른쪽 클릭을 할 때 마우스 위치에 팝업으로 표시됩니다: + +이 예제에서 만들어진 메뉴는 유저가 페이지에서 오른쪽 클릭을 할 때 마우스 위치에 팝업 형태로 표시됩니다: ```html @@ -27,7 +28,7 @@ window.addEventListener('contextmenu', function (e) { 다음 예제는 template API를 활용하여 어플리케이션 메뉴를 만드는 간단한 예제입니다: -**Windows 와 Linux 주의:** 각 메뉴 아이템의 `selector` 멤버는 Mac 운영체제 전용입니다. [Accelerator 옵션](https://github.com/atom/electron/blob/master/docs/api/accelerator-ko.md) +**Windows 와 Linux 유저 주의:** 각 메뉴 아이템의 `selector` 멤버는 Mac 운영체제 전용입니다. [Accelerator 옵션](https://github.com/atom/electron/blob/master/docs/api/accelerator-ko.md) ```html diff --git a/docs-translations/ko/api/native-image-ko.md b/docs-translations/ko/api/native-image-ko.md index e56ecfc3feb2..ba85266d2193 100644 --- a/docs-translations/ko/api/native-image-ko.md +++ b/docs-translations/ko/api/native-image-ko.md @@ -21,6 +21,8 @@ var appIcon = new Tray(image); 현재 `PNG` 와 `JPEG` 포맷을 지원하고 있습니다. 손실 없는 이미지 압축과 투명도 지원을 위해 `PNG` 사용을 권장합니다. +그리고 Windows에서는 `ICO` 포맷도 사용할 수 있습니다. + ## 고해상도 이미지 플랫폼이 high-DPI를 지원하는 경우 `@2x`와 같이 이미지의 파일명 뒤에 접미사를 추가하여 고해상도 이미지로 지정할 수 있습니다. diff --git a/docs-translations/ko/api/protocol-ko.md b/docs-translations/ko/api/protocol-ko.md index 3c0152fd2484..45cd69eea63b 100644 --- a/docs-translations/ko/api/protocol-ko.md +++ b/docs-translations/ko/api/protocol-ko.md @@ -1,6 +1,6 @@ # protocol -`protocol` 모듈은 여러 프로토콜의 요청과 응답을 커스터마이즈 할 수 있도록 이미 있는 프로토콜을 변경하거나 새로운 프로토콜을 만드는 방법을 제공합니다. +`protocol` 모듈은 이미 있는 프로토콜의 동작을 가로채거나 새로운 프로토콜을 만들 수 있는 기능을 제공합니다. 다음 예제는 `file://` 프로토콜과 같은 일을 하는 커스텀 프로토콜을 설정합니다: @@ -10,122 +10,136 @@ var path = require('path'); app.on('ready', function() { var protocol = require('protocol'); - protocol.registerProtocol('atom', function(request) { - var url = request.url.substr(7) - return new protocol.RequestFileJob(path.normalize(__dirname + '/' + url)); - }, function (error, scheme) { - if (!error) - console.log(scheme, ' registered successfully') + protocol.registerFileProtocol('atom', function(request, callback) { + var url = request.url.substr(7); + callback({path: path.normalize(__dirname + '/' + url)}); + }, function (error) { + if (error) + console.error('Failed to register protocol') }); }); ``` -**알림:** 이 모듈은 app의 `ready` 이벤트가 발생한 이후에만 사용할 수 있습니다. +**알림:** 이 모듈은 `ready` 이벤트가 호출된 이후에만 사용할 수 있습니다. -## protocol.registerProtocol(scheme, handler, callback) +## protocol.registerStandardSchemes(schemes) + +* `schemes` Array - 표준 스킴으로 등록할 커스텀 스킴 리스트 + +표준 스킴의 형식은 RFC 3986 [일반 URI 구문](https://tools.ietf.org/html/rfc3986#section-3) 표준을 따릅니다. +이 형식은 `file:`과 `filesystem:`을 포함합니다. + +## protocol.registerFileProtocol(scheme, handler[, completion]) * `scheme` String * `handler` Function -* `callback` Function +* `completion` Function -지정한 `scheme`을 기반으로 커스텀 프로토콜을 등록합니다. `handler`는 등록한 `scheme` 프로토콜에 요청이 들어올 경우 `request` 인자와 함께 `handler(request)` 형식으로 호출됩니다. +`scheme`에 파일을 응답으로 보내는 프로토콜을 등록합니다. +`handler`는 `request`가 `scheme`와 함께 생성될 때 `handler(request, callback)` 형식으로 호출됩니다. +`completion`은 `scheme`가 성공적으로 등록되었을 때 `completion(null)` 형식으로 호출되고 +등록에 실패했을 땐 `completion(error)` 형식으로 에러 내용을 담아 호출됩니다. -`handler` 함수에선 요청에 대한 해당 프로토콜의 작업 결과를 응답(반환) 해야 합니다. +`request`를 처리할 때 반드시 파일 경로 또는 `path` 속성을 포함하는 객체를 인자에 포함하여 `callback`을 호출해야 합니다. +예: `callback(filePath)` 또는 `callback({path: filePath})`. -기본적으로 스킴은 `http:`와 비슷합니다. `file:`과 같이 "표준 URI 구문"을 다르게 해석되게 하려면 -`protocol.registerStandardSchemes` 메서드를 이용해서 사용자 정의 스킴을 표준 스킴으로 만들 수 있습니다. +만약 `callback`이 아무 인자도 없이 호출되거나 숫자나 `error` 프로퍼티를 가진 객체가 인자로 전달될 경우 +`request`는 지정한 `error` 코드(숫자)를 출력합니다. +사용할 수 있는 에러 코드는 다음 링크에서 확인할 수 있습니다: https://code.google.com/p/chromium/codesearch#chromium/src/net/base/net_error_list.h -## protocol.unregisterProtocol(scheme, callback) +기본적으로 스킴은 `http:`와 같이 처리됩니다. `file:`과 같이 "일반적인 URI 문법"과는 다르게 인식되는 프로토콜은 +`protocol.registerStandardSchemes`을 사용하여 표준 스킴으로 처리되도록 할 수 있습니다. -* `scheme` String -* `callback` Function - -지정한 `scheme` 프로토콜을 등록 해제합니다. - -## protocol.registerStandardSchemes(value) - -* `value` Array - -지정한 `value` 배열을 사용하여 미리 지정된 표준 스킴으로 등록합니다. - -표준 스킴은 RFC 3986 [표준 URI 구문](https://tools.ietf.org/html/rfc3986#section-3)에 해당합니다. -이 표준은 `file:`과 `filesystem:`을 포함합니다. - -## protocol.isHandledProtocol(scheme, callback) - -* `scheme` String -* `callback` Function - -해당 `scheme`에 처리자(handler)가 등록되었는지 확인합니다. -지정한 `callback`에 결과가 boolean 값으로 반환됩니다. - -## protocol.interceptProtocol(scheme, handler, callback) +## protocol.registerBufferProtocol(scheme, handler[, completion]) * `scheme` String * `handler` Function -* `callback` Function +* `completion` Function -지정한 `scheme`의 작업을 `handler`로 변경합니다. -`handler`에서 `null` 또는 `undefined`를 반환 할 경우 해당 프로토콜의 기본 동작(응답)으로 대체 됩니다. +`scheme`에 `Buffer`를 응답으로 보내는 프로토콜을 등록합니다. +반드시 `Buffer` 또는 `data`, `mimeType`, `chart` 속성을 포함한 객체 중 하나를 인자에 포함하여 `callback`을 호출해야 합니다. -## protocol.uninterceptProtocol(scheme, callback) +예제: + +```javascript +protocol.registerBufferProtocol('atom', function(request, callback) { + callback({mimeType: 'text/html', data: new Buffer('
Response
')}); +}, function (error) { + if (error) + console.error('Failed to register protocol') +}); +``` + +## protocol.registerStringProtocol(scheme, handler[, completion]) + +* `scheme` String +* `handler` Function +* `completion` Function + +`scheme`에 `문자열`를 응답으로 보내는 프로토콜을 등록합니다. +반드시 `문자열` 또는 `data`, `mimeType`, `chart` 속성을 포함한 객체 중 하나를 인자에 포함하여 `callback`을 호출해야 합니다. + +## protocol.registerHttpProtocol(scheme, handler[, completion]) + +* `scheme` String +* `handler` Function +* `completion` Function + + +`scheme`에 HTTP 요청을 응답으로 보내는 프로토콜을 등록합니다. +반드시 `url`, `method`, `referer`, `session` 속성을 포함하는 객체를 인자에 포함하여 `callback`을 호출해야 합니다. + +기본적으로 HTTP 요청은 현재 세션을 재사용합니다. 만약 서로 다른 세션에 요청을 보내고 싶으면 `session`을 `null`로 지정해야 합니다. + +## protocol.unregisterProtocol(scheme[, completion]) + +* `scheme` String +* `completion` Function + +`scheme`의 커스텀 프로토콜 등록을 해제합니다. + +## protocol.isProtocolHandled(scheme, callback) * `scheme` String * `callback` Function -변경된 프로토콜의 작업을 해제합니다. +`scheme`에 동작(handler)이 등록되어 있는지 여부를 확인합니다. `callback`으로 결과(boolean)가 반환됩니다. -## Class: protocol.RequestFileJob(path) +## protocol.interceptFileProtocol(scheme, handler[, completion]) -* `path` String +* `scheme` String +* `handler` Function +* `completion` Function -`path` 경로를 기반으로 파일을 반환하는 request 작업을 생성합니다. 그리고 해당 파일에 상응하는 mime type을 지정합니다. +`scheme` 프로토콜을 가로채고 `handler`를 파일 전송에 대한 새로운 동작으로 사용합니다. -## Class: protocol.RequestStringJob(options) +## protocol.interceptStringProtocol(scheme, handler[, completion]) -* `options` Object - * `mimeType` String - 기본값: `text/plain` - * `charset` String - 기본값: `UTF-8` - * `data` String +* `scheme` String +* `handler` Function +* `completion` Function -문자열을 반환하는 request 작업을 생성합니다. +`scheme` 프로토콜을 가로채고 `handler`를 문자열 전송에 대한 새로운 동작으로 사용합니다. -## Class: protocol.RequestBufferJob(options) +## protocol.interceptBufferProtocol(scheme, handler[, completion]) -* `options` Object - * `mimeType` String - 기본값: `application/octet-stream` - * `encoding` String - 기본값: `UTF-8` - * `data` Buffer +* `scheme` String +* `handler` Function +* `completion` Function -버퍼를 반환하는 request 작업을 생성합니다. +`scheme` 프로토콜을 가로채고 `handler`를 `Buffer` 전송에 대한 새로운 동작으로 사용합니다. -## Class: protocol.RequestHttpJob(options) +## protocol.interceptHttpProtocol(scheme, handler[, completion]) -* `options` Object - * `session` [Session](browser-window.md#class-session) - 기본적으로 이 옵션은 어플리케이션의 기본 세션입니다. - `null`로 설정하면 요청을 위한 새로운 세션을 만듭니다. - * `url` String - * `method` String - 기본값: `GET` - * `referrer` String +* `scheme` String +* `handler` Function +* `completion` Function -`url`의 요청 결과를 그대로 반환하는 request 작업을 생성합니다. +`scheme` 프로토콜을 가로채고 `handler`를 HTTP 프로토콜의 요청에 대한 새로운 동작으로 사용합니다. -## Class: protocol.RequestErrorJob(code) +## protocol.uninterceptProtocol(scheme[, completion]) -* `code` Integer +* `scheme` String +* `completion` Function -콘솔에 특정한 네트워크 에러 메시지를 설정하는 request 작업을 생성합니다. -기본 메시지는 `net::ERR_NOT_IMPLEMENTED`입니다. 사용할 수 있는 코드의 범위는 다음과 같습니다. - -* 범위: - * 0- 99 System related errors - * 100-199 Connection related errors - * 200-299 Certificate errors - * 300-399 HTTP errors - * 400-499 Cache errors - * 500-599 ? - * 600-699 FTP errors - * 700-799 Certificate manager errors - * 800-899 DNS resolver errors - -에러 코드와 메시지에 대해 자세하게 알아보려면 [네트워크 에러 리스트](https://code.google.com/p/chromium/codesearch#chromium/src/net/base/net_error_list.h)를 참고하기 바랍니다. +가로챈 `scheme`를 삭제하고 기본 핸들러로 복구합니다. diff --git a/docs-translations/ko/tutorial/application-distribution-ko.md b/docs-translations/ko/tutorial/application-distribution-ko.md index 0b6ff631ad70..043ced1ec47c 100644 --- a/docs-translations/ko/tutorial/application-distribution-ko.md +++ b/docs-translations/ko/tutorial/application-distribution-ko.md @@ -1,6 +1,6 @@ # 어플리케이션 배포 -Electron 어플리케이션을 배포할 때는 어플리케이션 폴더의 이름을 `app`으로 지정한 후 Electron 실행파일의 리소스 디렉터리에 집어넣어야합니다. +Electron 어플리케이션을 배포하려면 어플리케이션 폴더 이름을 `app`으로 지정한 후 Electron 실행파일의 리소스 디렉터리에 집어넣기만 하면 됩니다. 리소스 디렉터리는 OS X에선 `Electron.app/Contents/Resources/` Windows와 Linux에선 `resources/` 입니다. 예제: @@ -23,8 +23,8 @@ electron/resources/app └── index.html ``` -그리고 `Electron.app`을 실행하면(Linux에선 `electron` Windows에선 `electron.exe`입니다) Electron은 해당 앱을 실행시킵니다. -최종 사용자에게는 이 `electron` 폴더(Electron.app)를 배포하면 됩니다. +그리고 `Electron.app`을 실행하면(Linux에선 `electron` Windows에선 `electron.exe`입니다) Electron 앱이 실행시킵니다. +최종 사용자에겐 이 `electron` 폴더(Electron.app)를 배포하면 됩니다. ## asar로 앱 패키징 하기 @@ -101,7 +101,7 @@ MyApp.app/Contents ### 역주-자동화 -배포시에 Electron의 리소스를 일일이 수정하는 것은 매우 귀찮고 복잡합니다. +어플리케이션 배포시 Electron의 리소스를 일일이 수정하는 것은 매우 귀찮고 복잡합니다. 하지만 이 작업을 자동화 시킬 수 있는 몇가지 방법이 있습니다: * [electron-builder](https://github.com/loopline-systems/electron-builder) @@ -110,6 +110,7 @@ MyApp.app/Contents ## Electron 소스코드를 다시 빌드하여 리소스 수정하기 또한 Electron 소스코드를 다시 빌드할 때 어플리케이션 이름을 변경할 수 있습니다. + `GYP_DEFINES` 환경변수를 사용하여 다음과 같이 다시 빌드할 수 있습니다: __Windows__ @@ -133,6 +134,6 @@ $ script/build.py -c Release -t myapp ### grunt-build-atom-shell Electron의 소스코드를 수정하고 다시 빌드하는 작업은 상당히 복잡합니다. -이를 해결하기 위해 [grunt-build-atom-shell](https://github.com/paulcbetts/grunt-build-atom-shell)를 사용하여 빌드를 자동화 시킬 수 있습니다. +일일이 소스코드를 수정하는 대신 [grunt-build-atom-shell](https://github.com/paulcbetts/grunt-build-atom-shell)을 사용하여 빌드를 자동화 시킬 수 있습니다. 이 툴을 사용하면 자동으로 `.gyp`파일을 수정하고 다시 빌드합니다. 그리고 어플리케이션의 네이티브 Node 모듈 또한 새로운 실행파일 이름으로 매치 시킵니다. diff --git a/docs-translations/ko/tutorial/application-packaging-ko.md b/docs-translations/ko/tutorial/application-packaging-ko.md index 1df14da291aa..893ac0e2e59f 100644 --- a/docs-translations/ko/tutorial/application-packaging-ko.md +++ b/docs-translations/ko/tutorial/application-packaging-ko.md @@ -1,11 +1,11 @@ # 어플리케이션 패키징 Windows에서 일어나는 긴 경로 이름에 대한 [issues](https://github.com/joyent/node/issues/6960)를 완화하고 `require` 속도를 약간 빠르게 하며 -어플리케이션의 리소스와 소스코드를 유저로부터 보호하기 위해 어플리케이션을 [asar][asar] 아카이브로 패키징 할 수 있습니다. +어플리케이션의 리소스와 소스코드를 좋지 않은 사용자로부터 보호하기 위해 어플리케이션을 [asar][asar] 아카이브로 패키징 할 수 있습니다. ## `asar` 아카이브 생성 -[asar][asar]아카이브는 tar과 비슷한 포맷으로 모든 리소스를 하나의 파일로 만듭니다. +[asar][asar] 아카이브는 tar과 비슷한 포맷으로 모든 리소스를 하나의 파일로 만듭니다. 그리고 Electron은 압축해제 없이 임의로 모든 파일을 읽어들일 수 있습니다. 다음 몇가지 단계를 통해 어플리케이션을 `asar` 아카이브로 압축할 수 있습니다: @@ -29,7 +29,7 @@ Electron은 Node.js로 부터 제공된 Node API와 Chromium으로부터 제공 ### Node API -`fs.readFile` 와 `require` 같은 Node API들을 지원하기 위해 Electron에선 `asar` 아카이브가 가상의 디렉터리 구조를 가지도록 +Electron에선 `fs.readFile`과 `require` 같은 Node API들을 지원하기 위해 `asar` 아카이브가 가상의 디렉터리 구조를 가지도록 패치했습니다. 그래서 아카이브 내부에서 리소스들을 정상적인 파일 시스템처럼 접근할 수 있습니다. 예를 들어 `/path/to`라는 경로에 `example.asar`라는 아카이브가 있다고 가정하면: diff --git a/docs-translations/ko/tutorial/quick-start-ko.md b/docs-translations/ko/tutorial/quick-start-ko.md index 51b18874f393..1d548c6f01c0 100644 --- a/docs-translations/ko/tutorial/quick-start-ko.md +++ b/docs-translations/ko/tutorial/quick-start-ko.md @@ -2,17 +2,16 @@ ## 소개 -Electron은 자바스크립트와 함께 제공되는 풍부한 네이티브 API를 이용하여 데스크톱 어플리케이션을 만들 수 있도록 해주는 프레임워크입니다. -이 프레임워크의 io.js(node.js)는 웹 서버 개발이 아닌 데스크톱 어플리케이션 개발에 초점을 맞췄습니다. +Electron은 자바스크립트와 함께 제공된 풍부한 네이티브 API를 사용하여 멋진 데스크탑 어플리케이션을 만들 수 있도록 해주는 프레임워크입니다. +이 프레임워크의 io.js(node.js)는 웹 서버 개발이 아닌 데스크탑 어플리케이션 개발에 초점을 맞췄습니다. -이것은 Electron이 GUI 라이브러리의 자바스크립트 바인딩이라는 뜻이 아닙니다. -대신에, Electron은 웹 페이지의 GUI를 사용합니다. 쉽게 말해 Electron은 자바스크립트를 사용하여 조작하는 작은 Chromium - 브라우저로 볼 수 있습니다. +이 말은 Electron이 GUI 라이브러리의 자바스크립트 바인딩이라는 뜻이 아닙니다. +대신, Electron은 웹 페이지의 GUI를 사용합니다. 쉽게 말해 Electron은 자바스크립트를 사용하여 조작하는 작은 Chromium 브라우저로 볼 수 있습니다. ### 메인 프로세스 Electron은 실행될 때 __메인 프로세스__ 로 불리는 `package.json`의 `main` 스크립트를 호출합니다. -이 스크립트는 메인 프로세스에서 작동합니다. GUI 컴포넌트를 컨트롤하거나 웹 페이지 창을 생성할 수 있습니다. +이 스크립트는 메인 프로세스에서 작동합니다. GUI 컴포넌트를 조작하거나 웹 페이지 창을 생성할 수 있습니다. ### 랜더러 프로세스 @@ -31,7 +30,7 @@ Electron 프로세스 내에서 작동하는 웹 페이지는 __랜더러 프로 랜더러 프로세스는 각각의 프로세스에 고립되며 웹 페이지의 작동에만 영향을 끼칩니다. 웹 페이지 내에서 네이티브 GUI 리소스를 관리하는 것은 보안에 취약하고 리소스를 누수시킬 수 있기 때문에 -웹 페이지 내에서는 네이티브 GUI와 관련된 API를 호출할 수 없도록 되어 있습니다. +기본적으로 웹 페이지 내에서는 네이티브 GUI와 관련된 API를 호출할 수 없도록 되어 있습니다. 만약 웹 페이지 내에서 GUI작업이 필요하다면 메인 프로세스에서 그 작업을 할 수 있도록 메인 프로세스와 통신을 해야합니다. Electron에는 메인 프로세스와 랜더러 프로세스간에 통신을 할 수 있도록 [ipc](../api/ipc-renderer-ko.md) 모듈을 제공하고 있습니다. @@ -48,8 +47,8 @@ your-app/ └── index.html ``` -`package.json`은 node 모듈의 package.json과 같습니다. 그리고 `main` 필드를 지정하여 -메인 프로세스로 사용할 어플리케이션 시작점을 정의할 수 있습니다. +`package.json`은 node 모듈의 package.json과 같습니다. +그리고 `main` 필드에 스크립트 파일을 집어넣어 메인 프로세스로 사용할 엔트리 포인트를 지정할 수 있습니다. 예를 들어 사용할 수 있는 `package.json`은 다음과 같습니다: ```json @@ -104,7 +103,7 @@ app.on('ready', function() { }); ``` -마지막으로 사용자에게 보여줄 `index.html` 웹 페이지의 예제입니다: +마지막으로, 사용자에게 보여줄 `index.html` 웹 페이지의 예제입니다: ```html @@ -169,9 +168,9 @@ $ ./electron/electron your-app/ $ ./Electron.app/Contents/MacOS/Electron your-app/ ``` -앱 실행파일은 `Electron`의 release 패키지에 포함되어 있습니다. +어플리케이션 실행파일은 `Electron`의 release 패키지에 포함되어 있습니다. [여기](https://github.com/atom/electron/releases)에서 다운로드 받을 수 있습니다. ### 배포용 파일 만들기 -모든 앱 작성이 끝났다면 [어플리케이션 배포](./application-distribution-ko.md) 가이드를 보고 본격적으로 제작한 앱을 배포할 수 있습니다. \ No newline at end of file +어플리케이션 작성을 완료했다면 [어플리케이션 배포](./application-distribution-ko.md) 가이드를 통해 본격적으로 제작한 앱을 배포할 수 있습니다. \ No newline at end of file From 291a60444aacaa0fe6773c4e257e5ccc3c1f9d54 Mon Sep 17 00:00:00 2001 From: Christian Bromann Date: Mon, 24 Aug 2015 23:15:59 -0700 Subject: [PATCH 0935/1293] minor wording fix, updated example --- docs/tutorial/using-selenium-and-webdriver.md | 21 ++++++++++--------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/docs/tutorial/using-selenium-and-webdriver.md b/docs/tutorial/using-selenium-and-webdriver.md index 29d95576227e..f3b7310dfbe5 100644 --- a/docs/tutorial/using-selenium-and-webdriver.md +++ b/docs/tutorial/using-selenium-and-webdriver.md @@ -72,7 +72,7 @@ driver.quit(); ## Setting up with WebdriverIO -[WebdriverIO](http://webdriver.io/) provided a Node package for testing with web driver. +[WebdriverIO](http://webdriver.io/) provides a Node package for testing with web driver. ### 1. Start chrome driver @@ -86,7 +86,7 @@ Only local connections are allowed. Remember the port number `9515`, which will be used later -### 2. Install WebDriverJS +### 2. Install WebdriverIO ```bash $ npm install webdriverio @@ -96,22 +96,23 @@ $ npm install webdriverio ```javascript var webdriverio = require('webdriverio'); var options = { - host: "localhost", // Use localhost as chrome driver server + host: "localhost", // Use localhost as chrome driver server port: 9515, // "9515" is the port opened by chrome driver. desiredCapabilities: { - browserName: 'chrome', - chromeOptions: {binary: '/Path-to-Your-App.app/Electron'} // Path to your Electron binary. - } + browserName: 'chrome', + chromeOptions: {binary: '/Path-to-Your-App.app/Electron'} // Path to your Electron binary. + } }; -webdriverio - .remote(options) +var client = webdriverio.remote(options); + +client .init() .url('http://google.com') .setValue('#q', 'webdriverio') .click('#btnG') - .title(function(err, res) { - console.log('Title was: ' + res.value); + .getTitle().then(function(title) { + console.log('Title was: ' + title); }) .end(); ``` From c9965f0ffddf174d26ad52489f2a47ce938723c1 Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Tue, 25 Aug 2015 17:06:16 +0900 Subject: [PATCH 0936/1293] Fix link target in README.md --- README-ko.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README-ko.md b/README-ko.md index 91459c6adf2e..bbe1333cf553 100644 --- a/README-ko.md +++ b/README-ko.md @@ -1,4 +1,4 @@ -[![Electron Logo](http://electron.atom.io/images/electron-logo.svg)](http://electron.atom.io/) +[![Electron Logo](http://electron.atom.io/images/electron-logo.svg)](http://electron.atom.io/) [![Build Status](https://travis-ci.org/atom/electron.svg?branch=master)](https://travis-ci.org/atom/electron) [![devDependency Status](https://david-dm.org/atom/electron/dev-status.svg)](https://david-dm.org/atom/electron#info=devDependencies) @@ -33,7 +33,7 @@ npm install electron-prebuilt --save-dev ## 참조 문서 -[Docs](https://github.com/atom/electron/tree/master/docs/README-ko.md)에 개발 가이드와 API 레퍼런스가 있습니다. +[Docs](https://github.com/atom/electron/tree/master/docs/README.md)에 개발 가이드와 API 레퍼런스가 있습니다. Electron을 빌드 하는 방법과 프로젝트에 기여하는 방법도 문서에 포함되어 있으니 참고하시기 바랍니다. ## 참조 문서(번역) From 703ced32dbaf27bee957aaac94e858f043594496 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Tue, 25 Aug 2015 04:49:48 -0700 Subject: [PATCH 0937/1293] Standardize content-tracing --- docs/api/content-tracing.md | 72 ++++++++++++++++++------------------- 1 file changed, 35 insertions(+), 37 deletions(-) diff --git a/docs/api/content-tracing.md b/docs/api/content-tracing.md index eab7b15d7129..85dc313001df 100644 --- a/docs/api/content-tracing.md +++ b/docs/api/content-tracing.md @@ -1,9 +1,9 @@ -# content-tracing +# content-trace The `content-trace` module is used to collect tracing data generated by the underlying Chromium content module. This module does not include a web interface -so you need to open `chrome://tracing/` in a Chrome browser and load the generated -file to view the result. +so you need to open `chrome://tracing/` in a Chrome browser and load the +generated file to view the result. ```javascript var tracing = require('content-tracing'); @@ -18,17 +18,20 @@ tracing.startRecording('*', tracing.DEFAULT_OPTIONS, function() { }); ``` -## tracing.getCategories(callback) +## Methods + +- The `content-trace` module has the following methods: + +### `tracing.getCategories(callback)` * `callback` Function Get a set of category groups. The category groups can change as new code paths are reached. -Once all child processes have acked to the `getCategories` request, `callback` -is invoked with an array of category groups. +Once all child processes have acked to the `getCategories` request, `callback` is invoked with an array of category groups. -## tracing.startRecording(categoryFilter, traceOptions, callback) +### `tracing.startRecording(categoryFilter, traceOptions, callback)` * `categoryFilter` String * `traceOptions` String @@ -36,9 +39,9 @@ is invoked with an array of category groups. Start recording on all processes. -Recording begins immediately locally, and asynchronously on child processes +Recording begins immediately locally and asynchronously on child processes as soon as they receive the EnableRecording request. Once all child processes -have acked to the `startRecording` request, `callback` will be called back. +have acked to the `startRecording` request the `callback` will be called. `categoryFilter` is a filter to control what category groups should be traced. A filter can have an optional `-` prefix to exclude category groups @@ -51,8 +54,8 @@ Examples: * `test_MyTest*,test_OtherStuff`, * `"-excluded_category1,-excluded_category2` -`traceOptions` controls what kind of tracing is enabled, it is a comma-delimited list. -Possible options are: +`traceOptions` controls what kind of tracing is enabled, it is a comma-delimited +list. Possible options are: * `record-until-full` * `record-continuously` @@ -66,10 +69,10 @@ the last one takes precedence. If none of the trace recording mode is specified, recording mode is `record-until-full`. The trace option will first be reset to the default option (record_mode set to -`record-until-full`, enable_sampling and enable_systrace set to false) +`record-until-full`, enable_sampling and enable_systrace set to `false`) before options parsed from `traceOptions` are applied on it. -## tracing.stopRecording(resultFilePath, callback) +### `tracing.stopRecording(resultFilePath, callback)` * `resultFilePath` String * `callback` Function @@ -78,18 +81,17 @@ Stop recording on all processes. Child processes typically are caching trace data and only rarely flush and send trace data back to the main process. That is because it may be an expensive -operation to send the trace data over IPC, and we would like to avoid much -runtime overhead of tracing. So, to end tracing, we must asynchronously ask all +operation to send the trace data over IPC, and we would like to avoid runtime overhead of tracing. So, to end tracing, we must asynchronously ask all child processes to flush any pending trace data. Once all child processes have acked to the `stopRecording` request, `callback` -will be called back with a file that contains the traced data. +will be called with a file that contains the traced data. -Trace data will be written into `resultFilePath` if it is not empty, or into a +Trace data will be written into `resultFilePath` if it is not empty or into a temporary file. The actual file path will be passed to `callback` if it's not -null. +`null`. -## tracing.startMonitoring(categoryFilter, traceOptions, callback) +### `tracing.startMonitoring(categoryFilter, traceOptions, callback)` * `categoryFilter` String * `traceOptions` String @@ -97,22 +99,21 @@ null. Start monitoring on all processes. -Monitoring begins immediately locally, and asynchronously on child processes as +Monitoring begins immediately locally and asynchronously on child processes as soon as they receive the `startMonitoring` request. -Once all child processes have acked to the `startMonitoring` request, -`callback` will be called back. +Once all child processes have acked to the `startMonitoring` request the +`callback` will be called. -## tracing.stopMonitoring(callback); +### `tracing.stopMonitoring(callback)` * `callback` Function Stop monitoring on all processes. -Once all child processes have acked to the `stopMonitoring` request, `callback` -is called back. +Once all child processes have acked to the `stopMonitoring` request the `callback` is called. -## tracing.captureMonitoringSnapshot(resultFilePath, callback) +### `tracing.captureMonitoringSnapshot(resultFilePath, callback)` * `resultFilePath` String * `callback` Function @@ -121,22 +122,19 @@ Get the current monitoring traced data. Child processes typically are caching trace data and only rarely flush and send trace data back to the main process. That is because it may be an expensive -operation to send the trace data over IPC, and we would like to avoid unneeded -runtime overhead of tracing. So, to end tracing, we must asynchronously ask all -child processes to flush any pending trace data. +operation to send the trace data over IPC and we would like to avoid unneeded +runtime overhead from tracing. So, to end tracing, we must asynchronously ask all child processes to flush any pending trace data. -Once all child processes have acked to the `captureMonitoringSnapshot` request, -the `callback` will be invoked with a file that contains the traced data. +Once all child processes have acked to the `captureMonitoringSnapshot` request the `callback` will be called with a file that contains the traced data. -## tracing.getTraceBufferUsage(callback) +### `tracing.getTraceBufferUsage(callback)` * `callback` Function -Get the maximum across processes of trace buffer percent full state. When the -TraceBufferUsage value is determined, the `callback` is called. +Get the maximum usage across processes of trace buffer as a percentage of the full state. When the TraceBufferUsage value is determined the `callback` is called. -## tracing.setWatchEvent(categoryName, eventName, callback) +### `tracing.setWatchEvent(categoryName, eventName, callback)` * `categoryName` String * `eventName` String @@ -145,7 +143,7 @@ TraceBufferUsage value is determined, the `callback` is called. `callback` will will be called every time the given event occurs on any process. -## tracing.cancelWatchEvent() +### `tracing.cancelWatchEvent()` -Cancel the watch event. If tracing is enabled, this may race with the watch +Cancel the watch event. If tracing is enabled this may race with the watch event callback. From a67767dbead63ee172d142a91e2f018a8cbd5287 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Tue, 25 Aug 2015 05:01:57 -0700 Subject: [PATCH 0938/1293] Standardize crash-reporter --- docs/api/crash-reporter.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/docs/api/crash-reporter.md b/docs/api/crash-reporter.md index da35008ea7f4..c7f2f20f4f04 100644 --- a/docs/api/crash-reporter.md +++ b/docs/api/crash-reporter.md @@ -1,5 +1,7 @@ # crash-reporter +The `crash-reporter` module enables sending your app's crash reports. + The following is an example of automatically submitting a crash report to a remote server: ```javascript @@ -12,7 +14,11 @@ crashReporter.start({ }); ``` -## crashReporter.start(options) +## Methods + +The `crash-reporter` module has the following methods: + +### `crashReporter.start(options)` * `options` Object * `productName` String, default: Electron @@ -31,19 +37,18 @@ Developers are required to call this method before using other `crashReporter` A **Note:** On OS X, Electron uses a new `crashpad` client, which is different from `breakpad` on Windows and Linux. To enable the crash collection feature, -you are required to call `crashReporter.start` API to initialize `crashpad` in the -main process and in each renderer process from which you wish to collect crash reports. +you are required to call the `crashReporter.start` API to initialize `crashpad` in the main process and in each renderer process from which you wish to collect crash reports. -## crashReporter.getLastCrashReport() +### `crashReporter.getLastCrashReport()` Returns the date and ID of the last crash report. If no crash reports have been sent or the crash reporter has not been started, `null` is returned. -## crashReporter.getUploadedReports() +### `crashReporter.getUploadedReports()` Returns all uploaded crash reports. Each report contains the date and uploaded ID. -# crash-reporter payload +## crash-reporter Payload The crash reporter will send the following data to the `submitUrl` as `POST`: From 2c7ccffe1aeee3adc72231dbb7b004a1516bc43b Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Tue, 25 Aug 2015 05:16:20 -0700 Subject: [PATCH 0939/1293] Line wrap at 80-col --- docs/api/clipboard.md | 3 ++- docs/api/content-tracing.md | 19 +++++++++++++------ docs/api/crash-reporter.md | 19 +++++++++++++------ 3 files changed, 28 insertions(+), 13 deletions(-) diff --git a/docs/api/clipboard.md b/docs/api/clipboard.md index c66b8c839f73..030c2e476950 100644 --- a/docs/api/clipboard.md +++ b/docs/api/clipboard.md @@ -1,6 +1,7 @@ # clipboard -The `clipboard` object provides methods to perform copy and paste operations. The following example shows how to write a string to the clipboard: +The `clipboard` object provides methods to perform copy and paste operations. +The following example shows how to write a string to the clipboard: ```javascript var clipboard = require('clipboard'); diff --git a/docs/api/content-tracing.md b/docs/api/content-tracing.md index 85dc313001df..264eda975d44 100644 --- a/docs/api/content-tracing.md +++ b/docs/api/content-tracing.md @@ -29,7 +29,8 @@ tracing.startRecording('*', tracing.DEFAULT_OPTIONS, function() { Get a set of category groups. The category groups can change as new code paths are reached. -Once all child processes have acked to the `getCategories` request, `callback` is invoked with an array of category groups. +Once all child processes have acked to the `getCategories` request, `callback` +is invoked with an array of category groups. ### `tracing.startRecording(categoryFilter, traceOptions, callback)` @@ -81,7 +82,8 @@ Stop recording on all processes. Child processes typically are caching trace data and only rarely flush and send trace data back to the main process. That is because it may be an expensive -operation to send the trace data over IPC, and we would like to avoid runtime overhead of tracing. So, to end tracing, we must asynchronously ask all +operation to send the trace data over IPC, and we would like to avoid runtime +overhead of tracing. So, to end tracing, we must asynchronously ask all child processes to flush any pending trace data. Once all child processes have acked to the `stopRecording` request, `callback` @@ -111,7 +113,8 @@ Once all child processes have acked to the `startMonitoring` request the Stop monitoring on all processes. -Once all child processes have acked to the `stopMonitoring` request the `callback` is called. +Once all child processes have acked to the `stopMonitoring` request the +`callback` is called. ### `tracing.captureMonitoringSnapshot(resultFilePath, callback)` @@ -123,16 +126,20 @@ Get the current monitoring traced data. Child processes typically are caching trace data and only rarely flush and send trace data back to the main process. That is because it may be an expensive operation to send the trace data over IPC and we would like to avoid unneeded -runtime overhead from tracing. So, to end tracing, we must asynchronously ask all child processes to flush any pending trace data. +runtime overhead from tracing. So, to end tracing, we must asynchronously ask +all child processes to flush any pending trace data. -Once all child processes have acked to the `captureMonitoringSnapshot` request the `callback` will be called with a file that contains the traced data. +Once all child processes have acked to the `captureMonitoringSnapshot` request +the `callback` will be called with a file that contains the traced data. ### `tracing.getTraceBufferUsage(callback)` * `callback` Function -Get the maximum usage across processes of trace buffer as a percentage of the full state. When the TraceBufferUsage value is determined the `callback` is called. +Get the maximum usage across processes of trace buffer as a percentage of the +full state. When the TraceBufferUsage value is determined the `callback` is +called. ### `tracing.setWatchEvent(categoryName, eventName, callback)` diff --git a/docs/api/crash-reporter.md b/docs/api/crash-reporter.md index c7f2f20f4f04..cf000db1fc49 100644 --- a/docs/api/crash-reporter.md +++ b/docs/api/crash-reporter.md @@ -2,7 +2,8 @@ The `crash-reporter` module enables sending your app's crash reports. -The following is an example of automatically submitting a crash report to a remote server: +The following is an example of automatically submitting a crash report to a +remote server: ```javascript crashReporter = require('crash-reporter'); @@ -33,11 +34,14 @@ The `crash-reporter` module has the following methods: * Only string properties are sent correctly. * Nested objects are not supported. -Developers are required to call this method before using other `crashReporter` APIs. +Developers are required to call this method before using other `crashReporter` +APIs. **Note:** On OS X, Electron uses a new `crashpad` client, which is different from `breakpad` on Windows and Linux. To enable the crash collection feature, -you are required to call the `crashReporter.start` API to initialize `crashpad` in the main process and in each renderer process from which you wish to collect crash reports. +you are required to call the `crashReporter.start` API to initialize `crashpad` +in the main process and in each renderer process from which you wish to collect +crash reports. ### `crashReporter.getLastCrashReport()` @@ -58,8 +62,11 @@ The crash reporter will send the following data to the `submitUrl` as `POST`: * `process_type` String - e.g. 'renderer' * `ptime` Number * `_version` String - The version in `package.json` -* `_productName` String - The product name in the `crashReporter` `options` object +* `_productName` String - The product name in the `crashReporter` `options` + object * `prod` String - Name of the underlying product. In this case Electron -* `_companyName` String - The company name in the `crashReporter` `options` object +* `_companyName` String - The company name in the `crashReporter` `options` + object * `upload_file_minidump` File - The crashreport as file -* All level one properties of the `extra` object in the `crashReporter` `options` object +* All level one properties of the `extra` object in the `crashReporter` + `options` object From d2288815f8b8fd65ac3d94485b85ea3c6e66e382 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Tue, 25 Aug 2015 05:18:02 -0700 Subject: [PATCH 0940/1293] List punctuation in crash-reporter --- docs/api/crash-reporter.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/api/crash-reporter.md b/docs/api/crash-reporter.md index cf000db1fc49..71c185d6aa51 100644 --- a/docs/api/crash-reporter.md +++ b/docs/api/crash-reporter.md @@ -22,13 +22,13 @@ The `crash-reporter` module has the following methods: ### `crashReporter.start(options)` * `options` Object - * `productName` String, default: Electron - * `companyName` String, default: GitHub, Inc - * `submitUrl` String, default: http://54.249.141.255:1127/post - * URL that crash reports will be sent to as POST - * `autoSubmit` Boolean, default: true - * Send the crash report without user interaction - * `ignoreSystemCrashHandler` Boolean, default: false + * `productName` String, default: Electron. + * `companyName` String, default: GitHub, Inc. + * `submitUrl` String, default: http://54.249.141.255:1127/post. + * URL that crash reports will be sent to as POST. + * `autoSubmit` Boolean, default: `true`. + * Send the crash report without user interaction. + * `ignoreSystemCrashHandler` Boolean, default: `false`. * `extra` Object * An object you can define that will be sent along with the report. * Only string properties are sent correctly. @@ -56,17 +56,17 @@ Returns all uploaded crash reports. Each report contains the date and uploaded I The crash reporter will send the following data to the `submitUrl` as `POST`: -* `rept` String - e.g. 'electron-crash-service' -* `ver` String - The version of Electron -* `platform` String - e.g. 'win32' -* `process_type` String - e.g. 'renderer' +* `rept` String - e.g. 'electron-crash-service'. +* `ver` String - The version of Electron. +* `platform` String - e.g. 'win32'. +* `process_type` String - e.g. 'renderer'. * `ptime` Number -* `_version` String - The version in `package.json` +* `_version` String - The version in `package.json`. * `_productName` String - The product name in the `crashReporter` `options` - object -* `prod` String - Name of the underlying product. In this case Electron + object. +* `prod` String - Name of the underlying product. In this case Electron. * `_companyName` String - The company name in the `crashReporter` `options` - object -* `upload_file_minidump` File - The crashreport as file -* All level one properties of the `extra` object in the `crashReporter` + object. +* `upload_file_minidump` File - The crash report as file. +* All level one properties of the `extra` object in the `crashReporter`. `options` object From 6a7113e3ce744fd6ab45e64840acaa115b527ab6 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 25 Aug 2015 20:30:50 +0800 Subject: [PATCH 0941/1293] Update brightray --- vendor/brightray | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/brightray b/vendor/brightray index 939a7b814282..9267238d929a 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit 939a7b814282a6433b8d7e3c9cfc74451360c07f +Subproject commit 9267238d929a09491d58f3c2f49abb6ed9272483 From 81ed608b9c02a62805c723b9a60c72c254329b56 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Tue, 25 Aug 2015 05:46:06 -0700 Subject: [PATCH 0942/1293] Standardize dialog --- docs/api/dialog.md | 79 ++++++++++++++++++++++++---------------------- 1 file changed, 42 insertions(+), 37 deletions(-) diff --git a/docs/api/dialog.md b/docs/api/dialog.md index 084e6bae0c4a..c5818aafd4c8 100644 --- a/docs/api/dialog.md +++ b/docs/api/dialog.md @@ -1,7 +1,8 @@ # dialog -The `dialog` module provides APIs to show native system dialogs, so web -applications can deliver the same user experience as native applications. +The `dialog` module provides APIs to show native system dialogs, such as opening +files or alerting, so web applications can deliver the same user experience as +native applications. An example of showing a dialog to select multiple files and directories: @@ -15,23 +16,27 @@ console.log(dialog.showOpenDialog({ properties: [ 'openFile', 'openDirectory', ' have to do is provide a `BrowserWindow` reference in the `browserWindow` parameter. -## dialog.showOpenDialog([browserWindow], [options], [callback]) +## Methods -* `browserWindow` BrowserWindow -* `options` Object +The `dialog` module has the following methods: + +### `dialog.showOpenDialog([browserWindow][, options][, callback])` + +* `browserWindow` BrowserWindow (optional) +* `options` Object (optional) * `title` String * `defaultPath` String * `filters` Array * `properties` Array - Contains which features the dialog should use, can contain `openFile`, `openDirectory`, `multiSelections` and `createDirectory` -* `callback` Function +* `callback` Function (optional) -On success, returns an array of file paths chosen by the user, otherwise -returns `undefined`. +On success this method returns an array of file paths chosen by the user, +otherwise it returns `undefined`. The `filters` specifies an array of file types that can be displayed or -selected, an example is: +selected when you want to limit the user to a specific type. For example: ```javascript { @@ -44,28 +49,28 @@ selected, an example is: } ``` The `extensions` array should contain extensions without wildcards or dots (e.g. -`'png'` is good, `'.png'` and `'*.png'` are bad). To show all files, use the +`'png'` is good but `'.png'` and `'*.png'` are bad). To show all files, use the `'*'` wildcard (no other wildcard is supported). -If a `callback` is passed, the API call would be asynchronous and the result -would be passed via `callback(filenames)` +If a `callback` is passed, the API call will be asynchronous and the result +wil be passed via `callback(filenames)` **Note:** On Windows and Linux, an open dialog can not be both a file selector and a directory selector, so if you set `properties` to `['openFile', 'openDirectory']` on these platforms, a directory selector will be shown. -## dialog.showSaveDialog([browserWindow], [options], [callback]) +### `dialog.showSaveDialog([browserWindow][, options][, callback])` -* `browserWindow` BrowserWindow -* `options` Object +* `browserWindow` BrowserWindow (optional) +* `options` Object (optional) * `title` String * `defaultPath` String * `filters` Array -* `callback` Function +* `callback` Function (optional) -On success, returns the path of the file chosen by the user, otherwise returns -`undefined`. +On success this method returns the path of the file chosen by the user, +otherwise it returns `undefined`. The `filters` specifies an array of file types that can be displayed, see `dialog.showOpenDialog` for an example. @@ -73,39 +78,39 @@ The `filters` specifies an array of file types that can be displayed, see If a `callback` is passed, the API call will be asynchronous and the result will be passed via `callback(filename)` -## dialog.showMessageBox([browserWindow], options, [callback]) +### `dialog.showMessageBox([browserWindow][, options][, callback])` -* `browserWindow` BrowserWindow -* `options` Object +* `browserWindow` BrowserWindow (optional) +* `options` Object (optional) * `type` String - Can be `"none"`, `"info"`, `"error"`, `"question"` or `"warning"`. On Windows, "question" displays the same icon as "info", unless - if you set an icon using the "icon" option - * `buttons` Array - Array of texts for buttons - * `title` String - Title of the message box, some platforms will not show it - * `message` String - Content of the message box - * `detail` String - Extra information of the message + you set an icon using the "icon" option. + * `buttons` Array - Array of texts for buttons. + * `title` String - Title of the message box, some platforms will not show it. + * `message` String - Content of the message box. + * `detail` String - Extra information of the message. * `icon` [NativeImage](native-image.md) * `cancelId` Integer - The value will be returned when user cancels the dialog instead of clicking the buttons of the dialog. By default it is the index of the buttons that have "cancel" or "no" as label, or 0 if there is no such buttons. On OS X and Windows the index of "Cancel" button will always be - used as `cancelId`, not matter whether it is already specified - * `noLink` Boolean - On Windows Electron would try to figure out which ones of + used as `cancelId`, not matter whether it is already specified. + * `noLink` Boolean - On Windows Electron will try to figure out which one of the `buttons` are common buttons (like "Cancel" or "Yes"), and show the - others as command links in the dialog, this can make the dialog appear in + others as command links in the dialog. This can make the dialog appear in the style of modern Windows apps. If you don't like this behavior, you can - specify `noLink` to `true` + set `noLink` to `true`. * `callback` Function -Shows a message box, it will block until the message box is closed. It returns -the index of the clicked button. +Shows a message box, it will block the process until the message box is closed. +It returns the index of the clicked button. If a `callback` is passed, the API call will be asynchronous and the result -will be passed via `callback(response)` +will be passed via `callback(response)`. -## dialog.showErrorBox(title, content) +### `dialog.showErrorBox(title, content)` -Runs a modal dialog that shows an error message. +Displays a modal dialog that shows an error message. -This API can be called safely before the `ready` event of `app` module emits, it -is usually used to report errors in early stage of startup. +This API can be called safely before the `ready` event the `app` module emits, +it is usually used to report errors in early stage of startup. From 864c8df63945f8998712465e49a10b37567bb2ee Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Tue, 25 Aug 2015 05:48:24 -0700 Subject: [PATCH 0943/1293] Standardize file-object --- docs/api/file-object.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/api/file-object.md b/docs/api/file-object.md index 36154cdd6a1f..c98b8bd19ec6 100644 --- a/docs/api/file-object.md +++ b/docs/api/file-object.md @@ -1,11 +1,10 @@ # `File` object The DOM's File interface provides abstraction around native files, in order to -let users work on native files directly with HTML5 file API, Electron has -added a `path` attribute to `File` interface which exposes the file's real path -on filesystem. +let users work on native files directly with the HTML5 file API. Electron has +added a `path` attribute to the `File` interface which exposes the file's real path on filesystem. -Example on getting real path of a dragged file: +Example on getting a real path from a dragged-onto-the-app file: ```html
From 638bb9b0b16f24537f0af8059fe21eb7183d1e54 Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Tue, 25 Aug 2015 21:54:20 +0900 Subject: [PATCH 0944/1293] Rename xx-ko.md to xx.md --- docs-translations/ko/README-ko.md | 68 ------------------- docs-translations/ko/README.md | 68 +++++++++++++++++++ .../api/{accelerator-ko.md => accelerator.md} | 0 .../{auto-updater-ko.md => auto-updater.md} | 0 ...-ko.md => chrome-command-line-switches.md} | 6 +- .../ko/api/{clipboard-ko.md => clipboard.md} | 4 +- ...ntent-tracing-ko.md => content-tracing.md} | 0 ...crash-reporter-ko.md => crash-reporter.md} | 0 .../ko/api/{dialog-ko.md => dialog.md} | 2 +- .../api/{file-object-ko.md => file-object.md} | 0 ...eless-window-ko.md => frameless-window.md} | 2 +- ...obal-shortcut-ko.md => global-shortcut.md} | 6 +- ...main-process-ko.md => ipc-main-process.md} | 2 +- .../{ipc-renderer-ko.md => ipc-renderer.md} | 4 +- .../ko/api/{menu-item-ko.md => menu-item.md} | 4 +- .../ko/api/{menu-ko.md => menu.md} | 6 +- .../{native-image-ko.md => native-image.md} | 0 .../{power-monitor-ko.md => power-monitor.md} | 0 ...ve-blocker-ko.md => power-save-blocker.md} | 0 .../ko/api/{process-ko.md => process.md} | 0 .../ko/api/{protocol-ko.md => protocol.md} | 0 .../ko/api/{remote-ko.md => remote.md} | 2 +- .../ko/api/{screen-ko.md => screen.md} | 0 .../ko/api/{shell-ko.md => shell.md} | 0 .../ko/api/{synopsis-ko.md => synopsis.md} | 6 +- .../ko/api/{tray-ko.md => tray.md} | 8 +-- .../ko/api/{web-frame-ko.md => web-frame.md} | 0 .../{web-view-tag-ko.md => web-view-tag.md} | 2 +- .../api/{window-open-ko.md => window-open.md} | 0 ...kit-ko.md => atom-shell-vs-node-webkit.md} | 0 ...inux-ko.md => build-instructions-linux.md} | 0 ...ns-mac-ko.md => build-instructions-mac.md} | 0 ...ws-ko.md => build-instructions-windows.md} | 0 ...verview-ko.md => build-system-overview.md} | 0 .../{coding-style-ko.md => coding-style.md} | 0 ...rver-ko.md => setting-up-symbol-server.md} | 0 ....md => source-code-directory-structure.md} | 0 ...tion-ko.md => application-distribution.md} | 2 +- ...ckaging-ko.md => application-packaging.md} | 0 ...rocess-ko.md => debugging-main-process.md} | 0 ....md => desktop-environment-integration.md} | 12 ++-- ...-extension-ko.md => devtools-extension.md} | 0 ...-events-ko.md => online-offline-events.md} | 0 .../{quick-start-ko.md => quick-start.md} | 8 +-- ...les-ko.md => using-native-node-modules.md} | 0 ...gin-ko.md => using-pepper-flash-plugin.md} | 0 ...-ko.md => using-selenium-and-webdriver.md} | 2 +- vendor/node | 2 +- 48 files changed, 108 insertions(+), 108 deletions(-) delete mode 100644 docs-translations/ko/README-ko.md create mode 100644 docs-translations/ko/README.md rename docs-translations/ko/api/{accelerator-ko.md => accelerator.md} (100%) rename docs-translations/ko/api/{auto-updater-ko.md => auto-updater.md} (100%) rename docs-translations/ko/api/{chrome-command-line-switches-ko.md => chrome-command-line-switches.md} (97%) rename docs-translations/ko/api/{clipboard-ko.md => clipboard.md} (94%) rename docs-translations/ko/api/{content-tracing-ko.md => content-tracing.md} (100%) rename docs-translations/ko/api/{crash-reporter-ko.md => crash-reporter.md} (100%) rename docs-translations/ko/api/{dialog-ko.md => dialog.md} (99%) rename docs-translations/ko/api/{file-object-ko.md => file-object.md} (100%) rename docs-translations/ko/api/{frameless-window-ko.md => frameless-window.md} (97%) rename docs-translations/ko/api/{global-shortcut-ko.md => global-shortcut.md} (92%) rename docs-translations/ko/api/{ipc-main-process-ko.md => ipc-main-process.md} (92%) rename docs-translations/ko/api/{ipc-renderer-ko.md => ipc-renderer.md} (85%) rename docs-translations/ko/api/{menu-item-ko.md => menu-item.md} (90%) rename docs-translations/ko/api/{menu-ko.md => menu.md} (95%) rename docs-translations/ko/api/{native-image-ko.md => native-image.md} (100%) rename docs-translations/ko/api/{power-monitor-ko.md => power-monitor.md} (100%) rename docs-translations/ko/api/{power-save-blocker-ko.md => power-save-blocker.md} (100%) rename docs-translations/ko/api/{process-ko.md => process.md} (100%) rename docs-translations/ko/api/{protocol-ko.md => protocol.md} (100%) rename docs-translations/ko/api/{remote-ko.md => remote.md} (99%) rename docs-translations/ko/api/{screen-ko.md => screen.md} (100%) rename docs-translations/ko/api/{shell-ko.md => shell.md} (100%) rename docs-translations/ko/api/{synopsis-ko.md => synopsis.md} (81%) rename docs-translations/ko/api/{tray-ko.md => tray.md} (96%) rename docs-translations/ko/api/{web-frame-ko.md => web-frame.md} (100%) rename docs-translations/ko/api/{web-view-tag-ko.md => web-view-tag.md} (99%) rename docs-translations/ko/api/{window-open-ko.md => window-open.md} (100%) rename docs-translations/ko/development/{atom-shell-vs-node-webkit-ko.md => atom-shell-vs-node-webkit.md} (100%) rename docs-translations/ko/development/{build-instructions-linux-ko.md => build-instructions-linux.md} (100%) rename docs-translations/ko/development/{build-instructions-mac-ko.md => build-instructions-mac.md} (100%) rename docs-translations/ko/development/{build-instructions-windows-ko.md => build-instructions-windows.md} (100%) rename docs-translations/ko/development/{build-system-overview-ko.md => build-system-overview.md} (100%) rename docs-translations/ko/development/{coding-style-ko.md => coding-style.md} (100%) rename docs-translations/ko/development/{setting-up-symbol-server-ko.md => setting-up-symbol-server.md} (100%) rename docs-translations/ko/development/{source-code-directory-structure-ko.md => source-code-directory-structure.md} (100%) rename docs-translations/ko/tutorial/{application-distribution-ko.md => application-distribution.md} (99%) rename docs-translations/ko/tutorial/{application-packaging-ko.md => application-packaging.md} (100%) rename docs-translations/ko/tutorial/{debugging-main-process-ko.md => debugging-main-process.md} (100%) rename docs-translations/ko/tutorial/{desktop-environment-integration-ko.md => desktop-environment-integration.md} (95%) rename docs-translations/ko/tutorial/{devtools-extension-ko.md => devtools-extension.md} (100%) rename docs-translations/ko/tutorial/{online-offline-events-ko.md => online-offline-events.md} (100%) rename docs-translations/ko/tutorial/{quick-start-ko.md => quick-start.md} (92%) rename docs-translations/ko/tutorial/{using-native-node-modules-ko.md => using-native-node-modules.md} (100%) rename docs-translations/ko/tutorial/{using-pepper-flash-plugin-ko.md => using-pepper-flash-plugin.md} (100%) rename docs-translations/ko/tutorial/{using-selenium-and-webdriver-ko.md => using-selenium-and-webdriver.md} (95%) diff --git a/docs-translations/ko/README-ko.md b/docs-translations/ko/README-ko.md deleted file mode 100644 index b48c6a42c516..000000000000 --- a/docs-translations/ko/README-ko.md +++ /dev/null @@ -1,68 +0,0 @@ -## 개발 가이드 - -* [어플리케이션 배포](tutorial/application-distribution-ko.md) -* [어플리케이션 패키징](tutorial/application-packaging-ko.md) -* [네이티브 node 모듈 사용하기](tutorial/using-native-node-modules-ko.md) -* [메인 프로세스 디버깅하기](tutorial/debugging-main-process-ko.md) -* [Selenium 과 WebDriver 사용하기](tutorial/using-selenium-and-webdriver-ko.md) -* [개발자 콘솔 확장기능](tutorial/devtools-extension-ko.md) -* [Pepper 플래시 플러그인 사용하기](tutorial/using-pepper-flash-plugin-ko.md) - -## 튜토리얼 - -* [시작하기](tutorial/quick-start-ko.md) -* [데스크톱 환경 통합](tutorial/desktop-environment-integration-ko.md) -* [온라인/오프라인 이벤트](tutorial/online-offline-events-ko.md) - -## API 레퍼런스 - -* [개요](api/synopsis-ko.md) -* [프로세스 객체](api/process-ko.md) -* [크롬 Command-Line 스위치 지원](api/chrome-command-line-switches-ko.md) - -커스텀 DOM Element: - -* [`File` 객체](api/file-object-ko.md) -* [`` 태그](api/web-view-tag-ko.md) -* [`window.open` 함수](api/window-open-ko.md) - -메인 프로세스를 위한 모듈들: - -* [app](api/app-ko.md) -* [auto-updater](api/auto-updater-ko.md) -* [browser-window](api/browser-window-ko.md) -* [content-tracing](api/content-tracing-ko.md) -* [dialog](api/dialog-ko.md) -* [global-shortcut](api/global-shortcut-ko.md) -* [ipc (main process)](api/ipc-main-process-ko.md) -* [menu](api/menu-ko.md) -* [menu-item](api/menu-item-ko.md) -* [power-monitor](api/power-monitor-ko.md) -* [power-save-blocker](api/power-save-blocker-ko.md) -* [protocol](api/protocol-ko.md) -* [tray](api/tray-ko.md) - -랜더러 프로세스를 위한 모듈들 (웹 페이지): - -* [ipc (renderer)](api/ipc-renderer-ko.md) -* [remote](api/remote-ko.md) -* [web-frame](api/web-frame-ko.md) - -두 프로세스에서 모두 사용 가능한 모듈들: - -* [clipboard](api/clipboard-ko.md) -* [crash-reporter](api/crash-reporter-ko.md) -* [native-image](api/native-image-ko.md) -* [screen](api/screen-ko.md) -* [shell](api/shell-ko.md) - -## 개발자용 - -* [코딩 스타일](development/coding-style-ko.md) -* [소스 코드 디렉터리 구조](development/source-code-directory-structure-ko.md) -* [NW.js와 기술적으로 다른점 (이전 node-webkit)](development/atom-shell-vs-node-webkit-ko.md) -* [빌드 시스템 개요](development/build-system-overview-ko.md) -* [빌드 설명서 (Mac)](development/build-instructions-mac-ko.md) -* [빌드 설명서 (Windows)](development/build-instructions-windows-ko.md) -* [빌드 설명서 (Linux)](development/build-instructions-linux-ko.md) -* [디버거에서 디버그 심볼 서버 설정](development/setting-up-symbol-server-ko.md) diff --git a/docs-translations/ko/README.md b/docs-translations/ko/README.md new file mode 100644 index 000000000000..51bf0a36d07f --- /dev/null +++ b/docs-translations/ko/README.md @@ -0,0 +1,68 @@ +## 개발 가이드 + +* [어플리케이션 배포](tutorial/application-distribution.md) +* [어플리케이션 패키징](tutorial/application-packaging.md) +* [네이티브 node 모듈 사용하기](tutorial/using-native-node-modules.md) +* [메인 프로세스 디버깅하기](tutorial/debugging-main-process.md) +* [Selenium 과 WebDriver 사용하기](tutorial/using-selenium-and-webdriver.md) +* [개발자 콘솔 확장기능](tutorial/devtools-extension.md) +* [Pepper 플래시 플러그인 사용하기](tutorial/using-pepper-flash-plugin.md) + +## 튜토리얼 + +* [시작하기](tutorial/quick-start.md) +* [데스크톱 환경 통합](tutorial/desktop-environment-integration.md) +* [온라인/오프라인 이벤트](tutorial/online-offline-events.md) + +## API 레퍼런스 + +* [개요](api/synopsis.md) +* [프로세스 객체](api/process.md) +* [크롬 Command-Line 스위치 지원](api/chrome-command-line-switches.md) + +커스텀 DOM Element: + +* [`File` 객체](api/file-object.md) +* [`` 태그](api/web-view-tag.md) +* [`window.open` 함수](api/window-open.md) + +메인 프로세스를 위한 모듈들: + +* [app](api/app.md) +* [auto-updater](api/auto-updater.md) +* [browser-window](api/browser-window.md) +* [content-tracing](api/content-tracing.md) +* [dialog](api/dialog.md) +* [global-shortcut](api/global-shortcut.md) +* [ipc (main process)](api/ipc-main-process.md) +* [menu](api/menu.md) +* [menu-item](api/menu-item.md) +* [power-monitor](api/power-monitor.md) +* [power-save-blocker](api/power-save-blocker.md) +* [protocol](api/protocol.md) +* [tray](api/tray.md) + +랜더러 프로세스를 위한 모듈들 (웹 페이지): + +* [ipc (renderer)](api/ipc-renderer.md) +* [remote](api/remote.md) +* [web-frame](api/web-frame.md) + +두 프로세스에서 모두 사용 가능한 모듈들: + +* [clipboard](api/clipboard.md) +* [crash-reporter](api/crash-reporter.md) +* [native-image](api/native-image.md) +* [screen](api/screen.md) +* [shell](api/shell.md) + +## 개발자용 + +* [코딩 스타일](development/coding-style.md) +* [소스 코드 디렉터리 구조](development/source-code-directory-structure.md) +* [NW.js와 기술적으로 다른점 (이전 node-webkit)](development/atom-shell-vs-node-webkit.md) +* [빌드 시스템 개요](development/build-system-overview.md) +* [빌드 설명서 (Mac)](development/build-instructions-mac.md) +* [빌드 설명서 (Windows)](development/build-instructions-windows.md) +* [빌드 설명서 (Linux)](development/build-instructions-linux.md) +* [디버거에서 디버그 심볼 서버 설정](development/setting-up-symbol-server.md) diff --git a/docs-translations/ko/api/accelerator-ko.md b/docs-translations/ko/api/accelerator.md similarity index 100% rename from docs-translations/ko/api/accelerator-ko.md rename to docs-translations/ko/api/accelerator.md diff --git a/docs-translations/ko/api/auto-updater-ko.md b/docs-translations/ko/api/auto-updater.md similarity index 100% rename from docs-translations/ko/api/auto-updater-ko.md rename to docs-translations/ko/api/auto-updater.md diff --git a/docs-translations/ko/api/chrome-command-line-switches-ko.md b/docs-translations/ko/api/chrome-command-line-switches.md similarity index 97% rename from docs-translations/ko/api/chrome-command-line-switches-ko.md rename to docs-translations/ko/api/chrome-command-line-switches.md index 7d1a7011eff6..5b9bf4722042 100644 --- a/docs-translations/ko/api/chrome-command-line-switches-ko.md +++ b/docs-translations/ko/api/chrome-command-line-switches.md @@ -62,9 +62,9 @@ Hostname 맵핑 규칙을 설정합니다. (`,`로 분리) `--host-rules` 플래그와 비슷하지만 이 플래그는 host resolver에만 적용됩니다. -[app]: app-ko.md -[append-switch]: app-ko.md#appcommandlineappendswitchswitch-value -[ready]: app-ko.md#event-ready +[app]: app.md +[append-switch]: app.md#appcommandlineappendswitchswitch-value +[ready]: app.md#event-ready ## --ignore-certificate-errors diff --git a/docs-translations/ko/api/clipboard-ko.md b/docs-translations/ko/api/clipboard.md similarity index 94% rename from docs-translations/ko/api/clipboard-ko.md rename to docs-translations/ko/api/clipboard.md index bc6c82786cb7..a6b29c2a377f 100644 --- a/docs-translations/ko/api/clipboard-ko.md +++ b/docs-translations/ko/api/clipboard.md @@ -45,11 +45,11 @@ console.log(clipboard.readText('selection')); * `type` String -클립보드로부터 [NativeImage](native-image-ko.md)로 이미지를 읽어들입니다. +클립보드로부터 [NativeImage](native-image.md)로 이미지를 읽어들입니다. ## clipboard.writeImage(image[, type]) -* `image` [NativeImage](native-image-ko.md) +* `image` [NativeImage](native-image.md) * `type` String 클립보드에 `image`를 씁니다. diff --git a/docs-translations/ko/api/content-tracing-ko.md b/docs-translations/ko/api/content-tracing.md similarity index 100% rename from docs-translations/ko/api/content-tracing-ko.md rename to docs-translations/ko/api/content-tracing.md diff --git a/docs-translations/ko/api/crash-reporter-ko.md b/docs-translations/ko/api/crash-reporter.md similarity index 100% rename from docs-translations/ko/api/crash-reporter-ko.md rename to docs-translations/ko/api/crash-reporter.md diff --git a/docs-translations/ko/api/dialog-ko.md b/docs-translations/ko/api/dialog.md similarity index 99% rename from docs-translations/ko/api/dialog-ko.md rename to docs-translations/ko/api/dialog.md index 2f24c659f913..4f151f0b1ebb 100644 --- a/docs-translations/ko/api/dialog-ko.md +++ b/docs-translations/ko/api/dialog.md @@ -77,7 +77,7 @@ Windows와 Linux에선 파일 선택 모드, 디렉터리 선택 모드를 동 * `title` String - 대화 상자의 제목입니다. 몇몇 플랫폼에선 보이지 않을 수 있습니다. * `message` String - 대화 상자의 본문 내용입니다. * `detail` String - 메시지의 추가 정보입니다. - * `icon` [NativeImage](native-image-ko.md) + * `icon` [NativeImage](native-image.md) * `cancelId` Integer - 유저가 대화 상자의 버튼을 클릭하지 않고 대화 상자를 취소했을 때 반환되는 버튼의 index입니다. 기본적으로 버튼 리스트가 "cancel" 또는 "no" 라벨을 가지고 있을 때 해당 버튼의 index를 반환합니다. 따로 두 라벨이 지정되지 않은 경우 0을 반환합니다. OS X와 Windows에선 `cancelId` 지정 여부에 상관없이 "Cancel" 버튼이 언제나 `cancelId`로 지정됩니다. diff --git a/docs-translations/ko/api/file-object-ko.md b/docs-translations/ko/api/file-object.md similarity index 100% rename from docs-translations/ko/api/file-object-ko.md rename to docs-translations/ko/api/file-object.md diff --git a/docs-translations/ko/api/frameless-window-ko.md b/docs-translations/ko/api/frameless-window.md similarity index 97% rename from docs-translations/ko/api/frameless-window-ko.md rename to docs-translations/ko/api/frameless-window.md index 420b277d9b17..3dc45b824fd1 100644 --- a/docs-translations/ko/api/frameless-window-ko.md +++ b/docs-translations/ko/api/frameless-window.md @@ -4,7 +4,7 @@ Frameless 윈도우는 테두리가 없는 윈도우 창을 말합니다. ## Frameless 윈도우 만들기 -Frameless 윈도우를 만드려면 [BrowserWindow](browser-window-ko.md) 객체의 `options`에서 `frame` 옵션을 `false`로 지정하기만 하면됩니다: +Frameless 윈도우를 만드려면 [BrowserWindow](browser-window.md) 객체의 `options`에서 `frame` 옵션을 `false`로 지정하기만 하면됩니다: ```javascript var BrowserWindow = require('browser-window'); diff --git a/docs-translations/ko/api/global-shortcut-ko.md b/docs-translations/ko/api/global-shortcut.md similarity index 92% rename from docs-translations/ko/api/global-shortcut-ko.md rename to docs-translations/ko/api/global-shortcut.md index 25c1d320870e..d99085f448e5 100644 --- a/docs-translations/ko/api/global-shortcut-ko.md +++ b/docs-translations/ko/api/global-shortcut.md @@ -32,20 +32,20 @@ app.on('will-quit', function() { ## globalShortcut.register(accelerator, callback) -* `accelerator` [Accelerator](accelerator-ko.md) +* `accelerator` [Accelerator](accelerator.md) * `callback` Function `accelerator`로 표현된 전역 단축키를 등록합니다. 유저로부터 등록된 단축키가 눌렸을 경우 `callback` 함수가 호출됩니다. ## globalShortcut.isRegistered(accelerator) -* `accelerator` [Accelerator](accelerator-ko.md) +* `accelerator` [Accelerator](accelerator.md) 지정된 `accelerator` 단축키가 등록되었는지 여부를 확인합니다. 반환값은 boolean(true, false) 입니다. ## globalShortcut.unregister(accelerator) -* `accelerator` [Accelerator](accelerator-ko.md) +* `accelerator` [Accelerator](accelerator.md) `키코드`에 해당하는 전역 단축키를 등록 해제합니다. diff --git a/docs-translations/ko/api/ipc-main-process-ko.md b/docs-translations/ko/api/ipc-main-process.md similarity index 92% rename from docs-translations/ko/api/ipc-main-process-ko.md rename to docs-translations/ko/api/ipc-main-process.md index 7d0aba08efa5..7f6a091de46d 100644 --- a/docs-translations/ko/api/ipc-main-process-ko.md +++ b/docs-translations/ko/api/ipc-main-process.md @@ -6,7 +6,7 @@ 동기 메시지는 `event.returnValue`를 이용하여 반환값(답장)을 설정할 수 있습니다. 비동기 메시지라면 `event.sender.send(...)`를 사용하면 됩니다. 또한 메인 프로세스에서 랜더러 프로세스로 메시지를 보내는 것도 가능합니다. -자세한 내용은 [WebContents.send](browser-window-ko.md#webcontentssendchannel-args)를 참고 하세요. +자세한 내용은 [WebContents.send](browser-window.md#webcontentssendchannel-args)를 참고 하세요. 보내진 메시지들을 처리하는 예제입니다: diff --git a/docs-translations/ko/api/ipc-renderer-ko.md b/docs-translations/ko/api/ipc-renderer.md similarity index 85% rename from docs-translations/ko/api/ipc-renderer-ko.md rename to docs-translations/ko/api/ipc-renderer.md index e4664480447f..b8bbb7ffa14d 100644 --- a/docs-translations/ko/api/ipc-renderer-ko.md +++ b/docs-translations/ko/api/ipc-renderer.md @@ -1,9 +1,9 @@ # ipc (renderer) `ipc` 모듈은 메인 프로세스로 메시지를 동기 또는 비동기로 보내고 받을 수 있는 몇 가지 방법을 제공합니다. -만약 랜더러 프로세스에서 메인 프로세스의 모듈을 직접적으로 사용하고 싶다면 [remote](remote-ko.md) 모듈을 사용하는 것을 고려해보는 것이 좋습니다. +만약 랜더러 프로세스에서 메인 프로세스의 모듈을 직접적으로 사용하고 싶다면 [remote](remote.md) 모듈을 사용하는 것을 고려해보는 것이 좋습니다. -[ipc (main process)](ipc-main-process-ko.md)에서 예제를 볼 수 있습니다. +[ipc (main process)](ipc-main-process.md)에서 예제를 볼 수 있습니다. ## ipc.send(channel[, args...]) diff --git a/docs-translations/ko/api/menu-item-ko.md b/docs-translations/ko/api/menu-item.md similarity index 90% rename from docs-translations/ko/api/menu-item-ko.md rename to docs-translations/ko/api/menu-item.md index 8477451ff965..519b7fb237a3 100644 --- a/docs-translations/ko/api/menu-item-ko.md +++ b/docs-translations/ko/api/menu-item.md @@ -10,8 +10,8 @@ * `type` String - `MenuItem`의 타입 `normal`, `separator`, `submenu`, `checkbox` 또는 `radio` 사용가능 * `label` String * `sublabel` String - * `accelerator` [Accelerator](accelerator-ko.md) - * `icon` [NativeImage](native-image-ko.md) + * `accelerator` [Accelerator](accelerator.md) + * `icon` [NativeImage](native-image.md) * `enabled` Boolean * `visible` Boolean * `checked` Boolean diff --git a/docs-translations/ko/api/menu-ko.md b/docs-translations/ko/api/menu.md similarity index 95% rename from docs-translations/ko/api/menu-ko.md rename to docs-translations/ko/api/menu.md index 7f2b5ad90c80..3303a55d05f2 100644 --- a/docs-translations/ko/api/menu-ko.md +++ b/docs-translations/ko/api/menu.md @@ -3,7 +3,7 @@ `Menu` 클래스는 어플리케이션 메뉴와 컨텍스트 메뉴를 만들 때 사용됩니다. 메뉴는 여러 개의 메뉴 아이템으로 구성되고 서브 메뉴를 가질 수도 있습니다. -다음 예제는 웹 페이지 내에서 [remote](remote-ko.md) 모듈을 활용하여 동적으로 메뉴를 생성하는 예제입니다. +다음 예제는 웹 페이지 내에서 [remote](remote.md) 모듈을 활용하여 동적으로 메뉴를 생성하는 예제입니다. 이 예제에서 만들어진 메뉴는 유저가 페이지에서 오른쪽 클릭을 할 때 마우스 위치에 팝업 형태로 표시됩니다: @@ -28,7 +28,7 @@ window.addEventListener('contextmenu', function (e) { 다음 예제는 template API를 활용하여 어플리케이션 메뉴를 만드는 간단한 예제입니다: -**Windows 와 Linux 유저 주의:** 각 메뉴 아이템의 `selector` 멤버는 Mac 운영체제 전용입니다. [Accelerator 옵션](https://github.com/atom/electron/blob/master/docs/api/accelerator-ko.md) +**Windows 와 Linux 유저 주의:** 각 메뉴 아이템의 `selector` 멤버는 Mac 운영체제 전용입니다. [Accelerator 옵션](accelerator.md) ```html @@ -189,7 +189,7 @@ Menu.setApplicationMenu(menu); * `template` Array -기본적으로 `template`는 [MenuItem](menu-item-ko.md)을 생성할 때 사용하는 `options`의 배열입니다. 사용법은 위에서 설명한 것과 같습니다. +기본적으로 `template`는 [MenuItem](menu-item.md)을 생성할 때 사용하는 `options`의 배열입니다. 사용법은 위에서 설명한 것과 같습니다. 또한 `template`에는 다른 속성도 추가할 수 있으며 메뉴가 만들어질 때 해당 메뉴 아이템의 프로퍼티로 변환됩니다. diff --git a/docs-translations/ko/api/native-image-ko.md b/docs-translations/ko/api/native-image.md similarity index 100% rename from docs-translations/ko/api/native-image-ko.md rename to docs-translations/ko/api/native-image.md diff --git a/docs-translations/ko/api/power-monitor-ko.md b/docs-translations/ko/api/power-monitor.md similarity index 100% rename from docs-translations/ko/api/power-monitor-ko.md rename to docs-translations/ko/api/power-monitor.md diff --git a/docs-translations/ko/api/power-save-blocker-ko.md b/docs-translations/ko/api/power-save-blocker.md similarity index 100% rename from docs-translations/ko/api/power-save-blocker-ko.md rename to docs-translations/ko/api/power-save-blocker.md diff --git a/docs-translations/ko/api/process-ko.md b/docs-translations/ko/api/process.md similarity index 100% rename from docs-translations/ko/api/process-ko.md rename to docs-translations/ko/api/process.md diff --git a/docs-translations/ko/api/protocol-ko.md b/docs-translations/ko/api/protocol.md similarity index 100% rename from docs-translations/ko/api/protocol-ko.md rename to docs-translations/ko/api/protocol.md diff --git a/docs-translations/ko/api/remote-ko.md b/docs-translations/ko/api/remote.md similarity index 99% rename from docs-translations/ko/api/remote-ko.md rename to docs-translations/ko/api/remote.md index 64232bdc31af..c2713db4a910 100644 --- a/docs-translations/ko/api/remote-ko.md +++ b/docs-translations/ko/api/remote.md @@ -70,7 +70,7 @@ remote.getCurrentWindow().on('close', function() { ## remote.getCurrentWindow() -현재 웹 페이지가 들어있는 [BrowserWindow](browser-window-ko.md) 객체를 반환합니다. +현재 웹 페이지가 들어있는 [BrowserWindow](browser-window.md) 객체를 반환합니다. ## remote.getCurrentWebContents() diff --git a/docs-translations/ko/api/screen-ko.md b/docs-translations/ko/api/screen.md similarity index 100% rename from docs-translations/ko/api/screen-ko.md rename to docs-translations/ko/api/screen.md diff --git a/docs-translations/ko/api/shell-ko.md b/docs-translations/ko/api/shell.md similarity index 100% rename from docs-translations/ko/api/shell-ko.md rename to docs-translations/ko/api/shell.md diff --git a/docs-translations/ko/api/synopsis-ko.md b/docs-translations/ko/api/synopsis.md similarity index 81% rename from docs-translations/ko/api/synopsis-ko.md rename to docs-translations/ko/api/synopsis.md index 8754f2f15bf2..69ee4af354c7 100644 --- a/docs-translations/ko/api/synopsis-ko.md +++ b/docs-translations/ko/api/synopsis.md @@ -1,11 +1,11 @@ # 개요 -Electron은 모든 [node.js's built-in 모듈](http://nodejs.org/api/)과 third-party node 모듈을 완벽하게 지원합니다. ([네이티브 모듈](../tutorial/using-native-node-modules-ko.md)을 포함해서) +Electron은 모든 [node.js's built-in 모듈](http://nodejs.org/api/)과 third-party node 모듈을 완벽하게 지원합니다. ([네이티브 모듈](../tutorial/using-native-node-modules.md)을 포함해서) Electron은 네이티브 데스크톱 어플리케이션을 개발 할 수 있도록 추가적인 built-in 모듈을 제공합니다. 몇몇 모듈은 메인 프로세스에서만 사용할 수 있고 어떤 모듈은 랜더러 프로세스에서만 사용할 수 있습니다. 또한 두 프로세스 모두 사용할 수 있는 모듈도 있습니다. 기본적인 규칙은 다음과 같습니다: GUI와 저 수준 시스템에 관련된 모듈은 오직 메인 프로세스에서만 사용할 수 있습니다. -[메인 프로세스 vs. 랜더러 프로세스](../tutorial/quick-start-ko.md#메인 프로세스) 컨셉에 익숙해야 이 모듈들을 사용하기 쉬우므로 해당 문서를 정독하는 것을 권장합니다. +[메인 프로세스 vs. 랜더러 프로세스](../tutorial/quick-start.md#메인 프로세스) 컨셉에 익숙해야 이 모듈들을 사용하기 쉬우므로 해당 문서를 정독하는 것을 권장합니다. 메인 프로세스 스크립트는 일반 `node.js` 스크립트와 같습니다: @@ -36,4 +36,4 @@ app.on('ready', function() { ``` -어플리케이션을 실행하려면 [앱 실행하기](../tutorial/quick-start-ko.md#앱 실행하기) 문서를 참고하기 바랍니다. +어플리케이션을 실행하려면 [앱 실행하기](../tutorial/quick-start.md#앱 실행하기) 문서를 참고하기 바랍니다. diff --git a/docs-translations/ko/api/tray-ko.md b/docs-translations/ko/api/tray.md similarity index 96% rename from docs-translations/ko/api/tray-ko.md rename to docs-translations/ko/api/tray.md index a32ccbb1d0e2..05decef5a48f 100644 --- a/docs-translations/ko/api/tray-ko.md +++ b/docs-translations/ko/api/tray.md @@ -38,7 +38,7 @@ __플랫폼별 한계:__ ### new Tray(image) -* `image` [NativeImage](native-image-ko.md) +* `image` [NativeImage](native-image.md) 전달된 `image`를 이용하여 트레이 아이콘을 만듭니다. @@ -126,13 +126,13 @@ __주의:__ 이 기능은 OS X에서만 작동합니다. ### Tray.setImage(image) -* `image` [NativeImage](native-image-ko.md) +* `image` [NativeImage](native-image.md) `image`를 사용하여 트레이 아이콘의 이미지를 설정합니다. ### Tray.setPressedImage(image) -* `image` [NativeImage](native-image-ko.md) +* `image` [NativeImage](native-image.md) `image`를 사용하여 트레이 아이콘이 눌렸을 때의 이미지를 설정합니다. @@ -163,7 +163,7 @@ __주의:__ 이 기능은 OS X에서만 작동합니다. ### Tray.displayBalloon(options) * `options` Object - * `icon` [NativeImage](native-image-ko.md) + * `icon` [NativeImage](native-image.md) * `title` String * `content` String diff --git a/docs-translations/ko/api/web-frame-ko.md b/docs-translations/ko/api/web-frame.md similarity index 100% rename from docs-translations/ko/api/web-frame-ko.md rename to docs-translations/ko/api/web-frame.md diff --git a/docs-translations/ko/api/web-view-tag-ko.md b/docs-translations/ko/api/web-view-tag.md similarity index 99% rename from docs-translations/ko/api/web-view-tag-ko.md rename to docs-translations/ko/api/web-view-tag.md index 32a5a835516f..d2efdf17ea1f 100644 --- a/docs-translations/ko/api/web-view-tag-ko.md +++ b/docs-translations/ko/api/web-view-tag.md @@ -311,7 +311,7 @@ Webview 페이지를 PDF 형식으로 인쇄합니다. `webContents.printToPDF(o `channel`을 통해 게스트 페이지에 `args...` 비동기 메시지를 보냅니다. 게스트 페이지에선 `ipc` 모듈의 `channel` 이벤트를 사용하면 이 메시지를 받을 수 있습니다. -예제는 [WebContents.send](browser-window-ko.md#webcontentssendchannel-args)를 참고하세요. +예제는 [WebContents.send](browser-window.md#webcontentssendchannel-args)를 참고하세요. ## DOM 이벤트 diff --git a/docs-translations/ko/api/window-open-ko.md b/docs-translations/ko/api/window-open.md similarity index 100% rename from docs-translations/ko/api/window-open-ko.md rename to docs-translations/ko/api/window-open.md diff --git a/docs-translations/ko/development/atom-shell-vs-node-webkit-ko.md b/docs-translations/ko/development/atom-shell-vs-node-webkit.md similarity index 100% rename from docs-translations/ko/development/atom-shell-vs-node-webkit-ko.md rename to docs-translations/ko/development/atom-shell-vs-node-webkit.md diff --git a/docs-translations/ko/development/build-instructions-linux-ko.md b/docs-translations/ko/development/build-instructions-linux.md similarity index 100% rename from docs-translations/ko/development/build-instructions-linux-ko.md rename to docs-translations/ko/development/build-instructions-linux.md diff --git a/docs-translations/ko/development/build-instructions-mac-ko.md b/docs-translations/ko/development/build-instructions-mac.md similarity index 100% rename from docs-translations/ko/development/build-instructions-mac-ko.md rename to docs-translations/ko/development/build-instructions-mac.md diff --git a/docs-translations/ko/development/build-instructions-windows-ko.md b/docs-translations/ko/development/build-instructions-windows.md similarity index 100% rename from docs-translations/ko/development/build-instructions-windows-ko.md rename to docs-translations/ko/development/build-instructions-windows.md diff --git a/docs-translations/ko/development/build-system-overview-ko.md b/docs-translations/ko/development/build-system-overview.md similarity index 100% rename from docs-translations/ko/development/build-system-overview-ko.md rename to docs-translations/ko/development/build-system-overview.md diff --git a/docs-translations/ko/development/coding-style-ko.md b/docs-translations/ko/development/coding-style.md similarity index 100% rename from docs-translations/ko/development/coding-style-ko.md rename to docs-translations/ko/development/coding-style.md diff --git a/docs-translations/ko/development/setting-up-symbol-server-ko.md b/docs-translations/ko/development/setting-up-symbol-server.md similarity index 100% rename from docs-translations/ko/development/setting-up-symbol-server-ko.md rename to docs-translations/ko/development/setting-up-symbol-server.md diff --git a/docs-translations/ko/development/source-code-directory-structure-ko.md b/docs-translations/ko/development/source-code-directory-structure.md similarity index 100% rename from docs-translations/ko/development/source-code-directory-structure-ko.md rename to docs-translations/ko/development/source-code-directory-structure.md diff --git a/docs-translations/ko/tutorial/application-distribution-ko.md b/docs-translations/ko/tutorial/application-distribution.md similarity index 99% rename from docs-translations/ko/tutorial/application-distribution-ko.md rename to docs-translations/ko/tutorial/application-distribution.md index 043ced1ec47c..fac2ae48a140 100644 --- a/docs-translations/ko/tutorial/application-distribution-ko.md +++ b/docs-translations/ko/tutorial/application-distribution.md @@ -48,7 +48,7 @@ electron/resources/ └── app.asar ``` -자세한 내용은 [어플리케이션 패키징](application-packaging-ko.md)에서 찾아볼 수 있습니다. +자세한 내용은 [어플리케이션 패키징](application-packaging.md)에서 찾아볼 수 있습니다. ## 다운로드한 바이너리의 리소스를 앱에 맞게 수정하기 diff --git a/docs-translations/ko/tutorial/application-packaging-ko.md b/docs-translations/ko/tutorial/application-packaging.md similarity index 100% rename from docs-translations/ko/tutorial/application-packaging-ko.md rename to docs-translations/ko/tutorial/application-packaging.md diff --git a/docs-translations/ko/tutorial/debugging-main-process-ko.md b/docs-translations/ko/tutorial/debugging-main-process.md similarity index 100% rename from docs-translations/ko/tutorial/debugging-main-process-ko.md rename to docs-translations/ko/tutorial/debugging-main-process.md diff --git a/docs-translations/ko/tutorial/desktop-environment-integration-ko.md b/docs-translations/ko/tutorial/desktop-environment-integration.md similarity index 95% rename from docs-translations/ko/tutorial/desktop-environment-integration-ko.md rename to docs-translations/ko/tutorial/desktop-environment-integration.md index 68f5562dbb52..9d1b5ffadcc4 100644 --- a/docs-translations/ko/tutorial/desktop-environment-integration-ko.md +++ b/docs-translations/ko/tutorial/desktop-environment-integration.md @@ -211,12 +211,12 @@ window.setRepresentedFilename('/etc/passwd'); window.setDocumentEdited(true); ``` -[addrecentdocument]: ../api/app-ko.md#appaddrecentdocumentpath -[clearrecentdocuments]: ../api/app-ko.md#appclearrecentdocuments -[setusertaskstasks]: ../api/app-ko.md#appsetusertaskstasks -[setprogressbar]: ../api/browser-window-ko.md#browserwindowsetprogressbarprogress -[setrepresentedfilename]: ../api/browser-window-ko.md#browserwindowsetrepresentedfilenamefilename -[setdocumentedited]: ../api/browser-window-ko.md#browserwindowsetdocumenteditededited +[addrecentdocument]: ../api/app.md#appaddrecentdocumentpath +[clearrecentdocuments]: ../api/app.md#appclearrecentdocuments +[setusertaskstasks]: ../api/app.md#appsetusertaskstasks +[setprogressbar]: ../api/browser-window.md#browserwindowsetprogressbarprogress +[setrepresentedfilename]: ../api/browser-window.md#browserwindowsetrepresentedfilenamefilename +[setdocumentedited]: ../api/browser-window.md#browserwindowsetdocumenteditededited [app-registration]: http://msdn.microsoft.com/en-us/library/windows/desktop/ee872121(v=vs.85).aspx [unity-launcher]: https://help.ubuntu.com/community/UnityLaunchersAndDesktopFiles#Adding_shortcuts_to_a_launcher [setthumbarbuttons]: ../api/browser-window.md#browserwindowsetthumbarbuttonsbuttons diff --git a/docs-translations/ko/tutorial/devtools-extension-ko.md b/docs-translations/ko/tutorial/devtools-extension.md similarity index 100% rename from docs-translations/ko/tutorial/devtools-extension-ko.md rename to docs-translations/ko/tutorial/devtools-extension.md diff --git a/docs-translations/ko/tutorial/online-offline-events-ko.md b/docs-translations/ko/tutorial/online-offline-events.md similarity index 100% rename from docs-translations/ko/tutorial/online-offline-events-ko.md rename to docs-translations/ko/tutorial/online-offline-events.md diff --git a/docs-translations/ko/tutorial/quick-start-ko.md b/docs-translations/ko/tutorial/quick-start.md similarity index 92% rename from docs-translations/ko/tutorial/quick-start-ko.md rename to docs-translations/ko/tutorial/quick-start.md index 1d548c6f01c0..7564f1c8c4c9 100644 --- a/docs-translations/ko/tutorial/quick-start-ko.md +++ b/docs-translations/ko/tutorial/quick-start.md @@ -33,8 +33,8 @@ Electron 프로세스 내에서 작동하는 웹 페이지는 __랜더러 프로 기본적으로 웹 페이지 내에서는 네이티브 GUI와 관련된 API를 호출할 수 없도록 되어 있습니다. 만약 웹 페이지 내에서 GUI작업이 필요하다면 메인 프로세스에서 그 작업을 할 수 있도록 메인 프로세스와 통신을 해야합니다. -Electron에는 메인 프로세스와 랜더러 프로세스간에 통신을 할 수 있도록 [ipc](../api/ipc-renderer-ko.md) 모듈을 제공하고 있습니다. -또한 [remote](../api/remote-ko.md) 모듈을 사용하여 RPC 스타일로 통신할 수도 있습니다. +Electron에는 메인 프로세스와 랜더러 프로세스간에 통신을 할 수 있도록 [ipc](../api/ipc-renderer.md) 모듈을 제공하고 있습니다. +또한 [remote](../api/remote.md) 모듈을 사용하여 RPC 스타일로 통신할 수도 있습니다. ## 첫번째 Electron 앱 만들기 @@ -121,7 +121,7 @@ app.on('ready', function() { ## 앱 실행하기 -앱을 작성한 후 [어플리케이션 배포](./application-distribution-ko.md) 가이드를 따라 앱을 패키징 하고 패키징한 앱을 실행할 수 있습니다. +앱을 작성한 후 [어플리케이션 배포](application-distribution.md) 가이드를 따라 앱을 패키징 하고 패키징한 앱을 실행할 수 있습니다. 또는 Electron 실행파일을 다운로드 받아 바로 실행해 볼 수도 있습니다. ### electron-prebuilt @@ -173,4 +173,4 @@ $ ./Electron.app/Contents/MacOS/Electron your-app/ ### 배포용 파일 만들기 -어플리케이션 작성을 완료했다면 [어플리케이션 배포](./application-distribution-ko.md) 가이드를 통해 본격적으로 제작한 앱을 배포할 수 있습니다. \ No newline at end of file +어플리케이션 작성을 완료했다면 [어플리케이션 배포](application-distribution.md) 가이드를 통해 본격적으로 제작한 앱을 배포할 수 있습니다. \ No newline at end of file diff --git a/docs-translations/ko/tutorial/using-native-node-modules-ko.md b/docs-translations/ko/tutorial/using-native-node-modules.md similarity index 100% rename from docs-translations/ko/tutorial/using-native-node-modules-ko.md rename to docs-translations/ko/tutorial/using-native-node-modules.md diff --git a/docs-translations/ko/tutorial/using-pepper-flash-plugin-ko.md b/docs-translations/ko/tutorial/using-pepper-flash-plugin.md similarity index 100% rename from docs-translations/ko/tutorial/using-pepper-flash-plugin-ko.md rename to docs-translations/ko/tutorial/using-pepper-flash-plugin.md diff --git a/docs-translations/ko/tutorial/using-selenium-and-webdriver-ko.md b/docs-translations/ko/tutorial/using-selenium-and-webdriver.md similarity index 95% rename from docs-translations/ko/tutorial/using-selenium-and-webdriver-ko.md rename to docs-translations/ko/tutorial/using-selenium-and-webdriver.md index 80b56e23ada1..069a49e52798 100644 --- a/docs-translations/ko/tutorial/using-selenium-and-webdriver-ko.md +++ b/docs-translations/ko/tutorial/using-selenium-and-webdriver.md @@ -69,6 +69,6 @@ driver.quit(); ## 작업환경 따로 Electron을 다시 빌드하지 않는 경우 간단히 어플리케이션을 Electron의 리소스 디렉터리에 -[배치](https://github.com/atom/electron/blob/master/docs/tutorial/application-distribution-ko.md)하여 바로 테스트 할 수 있습니다. +[배치](application-distribution.md)하여 바로 테스트 할 수 있습니다. [chrome-driver]: https://sites.google.com/a/chromium.org/chromedriver/ diff --git a/vendor/node b/vendor/node index 205b013ac86e..902090af5375 160000 --- a/vendor/node +++ b/vendor/node @@ -1 +1 @@ -Subproject commit 205b013ac86e5500678a791cd54f305580fa4f4b +Subproject commit 902090af5375e497dded310575f19de5328a9bbc From 65046b05afbead0d3b6b8b6f1a6d71d520dd583a Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 25 Aug 2015 20:55:35 +0800 Subject: [PATCH 0945/1293] Update brightray and node * brightray: fix building on OS X * node: remove a not used patch --- vendor/brightray | 2 +- vendor/node | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/vendor/brightray b/vendor/brightray index 9267238d929a..5b2a73c68a98 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit 9267238d929a09491d58f3c2f49abb6ed9272483 +Subproject commit 5b2a73c68a986780e67eb2e738327d35c7c1c21e diff --git a/vendor/node b/vendor/node index 205b013ac86e..b9b6dd9f3fc0 160000 --- a/vendor/node +++ b/vendor/node @@ -1 +1 @@ -Subproject commit 205b013ac86e5500678a791cd54f305580fa4f4b +Subproject commit b9b6dd9f3fc095e66a3b89d3efd50f7c576da2c8 From 76416d5e477470654a89b9a7df5f4d45067db4f8 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Tue, 25 Aug 2015 05:56:38 -0700 Subject: [PATCH 0946/1293] Standardize frameless-window --- docs/api/frameless-window.md | 37 ++++++++++++++++-------------------- 1 file changed, 16 insertions(+), 21 deletions(-) diff --git a/docs/api/frameless-window.md b/docs/api/frameless-window.md index 498a65b225db..e712b6e22314 100644 --- a/docs/api/frameless-window.md +++ b/docs/api/frameless-window.md @@ -1,10 +1,10 @@ -# Frameless window +# Frameless Window -A frameless window is a window that has no chrome. +A frameless window is a window that has no [chrome]()—the parts of the window that display close, open, minify buttons and such. These are options on the [`BrowserWindow`](browser-window.md) class. ## Create a frameless window -To create a frameless window, you only need to specify `frame` to `false` in +To create a frameless window, you need to set `frame` to `false` in [BrowserWindow](browser-window.md)'s `options`: @@ -24,19 +24,18 @@ var win = new BrowserWindow({ transparent: true, frame: false }); ### Limitations -* You can not click through the transparent area, we are going to introduce an +* You can not click through the transparent area. We are going to introduce an API to set window shape to solve this, but currently blocked at an [upstream bug](https://code.google.com/p/chromium/issues/detail?id=387234). -* Transparent window is not resizable, setting `resizable` to `true` may make - transparent window stop working on some platforms. +* Transparent windows are not resizable. Setting `resizable` to `true` may make + a transparent window stop working on some platforms. * The `blur` filter only applies to the web page, so there is no way to apply - blur effect to the content below the window. -* On Windows transparent window will not work when DWM is disabled. + blur effect to the content below the window (i.e. other applications open on the user's system). +* On Windows operation shystems, transparent windows will not work when DWM is disabled. * On Linux users have to put `--enable-transparent-visuals --disable-gpu` in - command line to disable GPU and allow ARGB to make transparent window, this is - caused by an upstream bug that [alpha channel doesn't work on some NVidia + the command line to disable GPU and allow ARGB to make transparent window, this is caused by an upstream bug that [alpha channel doesn't work on some NVidia drivers](https://code.google.com/p/chromium/issues/detail?id=369209) on Linux. -* On Mac the native window shadow will not show for transparent window. +* On Mac the native window shadow will not be shown on a transparent window. ## Draggable region @@ -44,7 +43,7 @@ By default, the frameless window is non-draggable. Apps need to specify `-webkit-app-region: drag` in CSS to tell Electron which regions are draggable (like the OS's standard titlebar), and apps can also use `-webkit-app-region: no-drag` to exclude the non-draggable area from the - draggable region. Note that only rectangular shape is currently supported. + draggable region. Note that only rectangular shapes are currently supported. To make the whole window draggable, you can add `-webkit-app-region: drag` as `body`'s style: @@ -64,15 +63,11 @@ button { } ``` -If you're only using a custom titlebar, you also need to make buttons in -titlebar non-draggable. +If you're setting just a custom titlebar as draggable, you also need to make all buttons in titlebar non-draggable. ## Text selection -One thing on frameless window is that the dragging behaviour may conflict with -selecting text, for example, when you drag the titlebar, you may accidentally -select the text on titlebar. To prevent this, you need to disable text -selection on dragging area like this: +In a frameless window the dragging behaviour may conflict with selecting text. For example, when you drag the titlebar you may accidentally select the text on the titlebar. To prevent this, you need to disable text selection within a draggable area like this: ```css .titlebar { @@ -83,7 +78,7 @@ selection on dragging area like this: ## Context menu -On some platforms, the draggable area would be treated as non-client frame, so -when you right click on it a system menu would be popuped. To make context menu -behave correctly on all platforms, you should never custom context menu on +On some platforms, the draggable area will be treated as a non-client frame, so +when you right click on it a system menu will pop up. To make the context menu +behave correctly on all platforms you should never use a custom context menu on draggable areas. From aef4acb2e65bb1de43c2e98f010c4d4cae3780d6 Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Tue, 25 Aug 2015 22:14:33 +0900 Subject: [PATCH 0947/1293] Revert "Rename xx-ko.md to xx.md" This reverts commit 638bb9b0b16f24537f0af8059fe21eb7183d1e54. --- docs-translations/ko/README-ko.md | 68 +++++++++++++++++++ docs-translations/ko/README.md | 68 ------------------- .../api/{accelerator.md => accelerator-ko.md} | 0 .../{auto-updater.md => auto-updater-ko.md} | 0 ....md => chrome-command-line-switches-ko.md} | 6 +- .../ko/api/{clipboard.md => clipboard-ko.md} | 4 +- ...ntent-tracing.md => content-tracing-ko.md} | 0 ...crash-reporter.md => crash-reporter-ko.md} | 0 .../ko/api/{dialog.md => dialog-ko.md} | 2 +- .../api/{file-object.md => file-object-ko.md} | 0 ...eless-window.md => frameless-window-ko.md} | 2 +- ...obal-shortcut.md => global-shortcut-ko.md} | 6 +- ...main-process.md => ipc-main-process-ko.md} | 2 +- .../{ipc-renderer.md => ipc-renderer-ko.md} | 4 +- .../ko/api/{menu-item.md => menu-item-ko.md} | 4 +- .../ko/api/{menu.md => menu-ko.md} | 6 +- .../{native-image.md => native-image-ko.md} | 0 .../{power-monitor.md => power-monitor-ko.md} | 0 ...ve-blocker.md => power-save-blocker-ko.md} | 0 .../ko/api/{process.md => process-ko.md} | 0 .../ko/api/{protocol.md => protocol-ko.md} | 0 .../ko/api/{remote.md => remote-ko.md} | 2 +- .../ko/api/{screen.md => screen-ko.md} | 0 .../ko/api/{shell.md => shell-ko.md} | 0 .../ko/api/{synopsis.md => synopsis-ko.md} | 6 +- .../ko/api/{tray.md => tray-ko.md} | 8 +-- .../ko/api/{web-frame.md => web-frame-ko.md} | 0 .../{web-view-tag.md => web-view-tag-ko.md} | 2 +- .../api/{window-open.md => window-open-ko.md} | 0 ...kit.md => atom-shell-vs-node-webkit-ko.md} | 0 ...inux.md => build-instructions-linux-ko.md} | 0 ...ns-mac.md => build-instructions-mac-ko.md} | 0 ...ws.md => build-instructions-windows-ko.md} | 0 ...verview.md => build-system-overview-ko.md} | 0 .../{coding-style.md => coding-style-ko.md} | 0 ...rver.md => setting-up-symbol-server-ko.md} | 0 ... => source-code-directory-structure-ko.md} | 0 ...tion.md => application-distribution-ko.md} | 2 +- ...ckaging.md => application-packaging-ko.md} | 0 ...rocess.md => debugging-main-process-ko.md} | 0 ... => desktop-environment-integration-ko.md} | 12 ++-- ...-extension.md => devtools-extension-ko.md} | 0 ...-events.md => online-offline-events-ko.md} | 0 .../{quick-start.md => quick-start-ko.md} | 8 +-- ...les.md => using-native-node-modules-ko.md} | 0 ...gin.md => using-pepper-flash-plugin-ko.md} | 0 ....md => using-selenium-and-webdriver-ko.md} | 2 +- vendor/node | 2 +- 48 files changed, 108 insertions(+), 108 deletions(-) create mode 100644 docs-translations/ko/README-ko.md delete mode 100644 docs-translations/ko/README.md rename docs-translations/ko/api/{accelerator.md => accelerator-ko.md} (100%) rename docs-translations/ko/api/{auto-updater.md => auto-updater-ko.md} (100%) rename docs-translations/ko/api/{chrome-command-line-switches.md => chrome-command-line-switches-ko.md} (97%) rename docs-translations/ko/api/{clipboard.md => clipboard-ko.md} (94%) rename docs-translations/ko/api/{content-tracing.md => content-tracing-ko.md} (100%) rename docs-translations/ko/api/{crash-reporter.md => crash-reporter-ko.md} (100%) rename docs-translations/ko/api/{dialog.md => dialog-ko.md} (99%) rename docs-translations/ko/api/{file-object.md => file-object-ko.md} (100%) rename docs-translations/ko/api/{frameless-window.md => frameless-window-ko.md} (97%) rename docs-translations/ko/api/{global-shortcut.md => global-shortcut-ko.md} (92%) rename docs-translations/ko/api/{ipc-main-process.md => ipc-main-process-ko.md} (92%) rename docs-translations/ko/api/{ipc-renderer.md => ipc-renderer-ko.md} (85%) rename docs-translations/ko/api/{menu-item.md => menu-item-ko.md} (90%) rename docs-translations/ko/api/{menu.md => menu-ko.md} (95%) rename docs-translations/ko/api/{native-image.md => native-image-ko.md} (100%) rename docs-translations/ko/api/{power-monitor.md => power-monitor-ko.md} (100%) rename docs-translations/ko/api/{power-save-blocker.md => power-save-blocker-ko.md} (100%) rename docs-translations/ko/api/{process.md => process-ko.md} (100%) rename docs-translations/ko/api/{protocol.md => protocol-ko.md} (100%) rename docs-translations/ko/api/{remote.md => remote-ko.md} (99%) rename docs-translations/ko/api/{screen.md => screen-ko.md} (100%) rename docs-translations/ko/api/{shell.md => shell-ko.md} (100%) rename docs-translations/ko/api/{synopsis.md => synopsis-ko.md} (81%) rename docs-translations/ko/api/{tray.md => tray-ko.md} (96%) rename docs-translations/ko/api/{web-frame.md => web-frame-ko.md} (100%) rename docs-translations/ko/api/{web-view-tag.md => web-view-tag-ko.md} (99%) rename docs-translations/ko/api/{window-open.md => window-open-ko.md} (100%) rename docs-translations/ko/development/{atom-shell-vs-node-webkit.md => atom-shell-vs-node-webkit-ko.md} (100%) rename docs-translations/ko/development/{build-instructions-linux.md => build-instructions-linux-ko.md} (100%) rename docs-translations/ko/development/{build-instructions-mac.md => build-instructions-mac-ko.md} (100%) rename docs-translations/ko/development/{build-instructions-windows.md => build-instructions-windows-ko.md} (100%) rename docs-translations/ko/development/{build-system-overview.md => build-system-overview-ko.md} (100%) rename docs-translations/ko/development/{coding-style.md => coding-style-ko.md} (100%) rename docs-translations/ko/development/{setting-up-symbol-server.md => setting-up-symbol-server-ko.md} (100%) rename docs-translations/ko/development/{source-code-directory-structure.md => source-code-directory-structure-ko.md} (100%) rename docs-translations/ko/tutorial/{application-distribution.md => application-distribution-ko.md} (99%) rename docs-translations/ko/tutorial/{application-packaging.md => application-packaging-ko.md} (100%) rename docs-translations/ko/tutorial/{debugging-main-process.md => debugging-main-process-ko.md} (100%) rename docs-translations/ko/tutorial/{desktop-environment-integration.md => desktop-environment-integration-ko.md} (95%) rename docs-translations/ko/tutorial/{devtools-extension.md => devtools-extension-ko.md} (100%) rename docs-translations/ko/tutorial/{online-offline-events.md => online-offline-events-ko.md} (100%) rename docs-translations/ko/tutorial/{quick-start.md => quick-start-ko.md} (92%) rename docs-translations/ko/tutorial/{using-native-node-modules.md => using-native-node-modules-ko.md} (100%) rename docs-translations/ko/tutorial/{using-pepper-flash-plugin.md => using-pepper-flash-plugin-ko.md} (100%) rename docs-translations/ko/tutorial/{using-selenium-and-webdriver.md => using-selenium-and-webdriver-ko.md} (95%) diff --git a/docs-translations/ko/README-ko.md b/docs-translations/ko/README-ko.md new file mode 100644 index 000000000000..b48c6a42c516 --- /dev/null +++ b/docs-translations/ko/README-ko.md @@ -0,0 +1,68 @@ +## 개발 가이드 + +* [어플리케이션 배포](tutorial/application-distribution-ko.md) +* [어플리케이션 패키징](tutorial/application-packaging-ko.md) +* [네이티브 node 모듈 사용하기](tutorial/using-native-node-modules-ko.md) +* [메인 프로세스 디버깅하기](tutorial/debugging-main-process-ko.md) +* [Selenium 과 WebDriver 사용하기](tutorial/using-selenium-and-webdriver-ko.md) +* [개발자 콘솔 확장기능](tutorial/devtools-extension-ko.md) +* [Pepper 플래시 플러그인 사용하기](tutorial/using-pepper-flash-plugin-ko.md) + +## 튜토리얼 + +* [시작하기](tutorial/quick-start-ko.md) +* [데스크톱 환경 통합](tutorial/desktop-environment-integration-ko.md) +* [온라인/오프라인 이벤트](tutorial/online-offline-events-ko.md) + +## API 레퍼런스 + +* [개요](api/synopsis-ko.md) +* [프로세스 객체](api/process-ko.md) +* [크롬 Command-Line 스위치 지원](api/chrome-command-line-switches-ko.md) + +커스텀 DOM Element: + +* [`File` 객체](api/file-object-ko.md) +* [`` 태그](api/web-view-tag-ko.md) +* [`window.open` 함수](api/window-open-ko.md) + +메인 프로세스를 위한 모듈들: + +* [app](api/app-ko.md) +* [auto-updater](api/auto-updater-ko.md) +* [browser-window](api/browser-window-ko.md) +* [content-tracing](api/content-tracing-ko.md) +* [dialog](api/dialog-ko.md) +* [global-shortcut](api/global-shortcut-ko.md) +* [ipc (main process)](api/ipc-main-process-ko.md) +* [menu](api/menu-ko.md) +* [menu-item](api/menu-item-ko.md) +* [power-monitor](api/power-monitor-ko.md) +* [power-save-blocker](api/power-save-blocker-ko.md) +* [protocol](api/protocol-ko.md) +* [tray](api/tray-ko.md) + +랜더러 프로세스를 위한 모듈들 (웹 페이지): + +* [ipc (renderer)](api/ipc-renderer-ko.md) +* [remote](api/remote-ko.md) +* [web-frame](api/web-frame-ko.md) + +두 프로세스에서 모두 사용 가능한 모듈들: + +* [clipboard](api/clipboard-ko.md) +* [crash-reporter](api/crash-reporter-ko.md) +* [native-image](api/native-image-ko.md) +* [screen](api/screen-ko.md) +* [shell](api/shell-ko.md) + +## 개발자용 + +* [코딩 스타일](development/coding-style-ko.md) +* [소스 코드 디렉터리 구조](development/source-code-directory-structure-ko.md) +* [NW.js와 기술적으로 다른점 (이전 node-webkit)](development/atom-shell-vs-node-webkit-ko.md) +* [빌드 시스템 개요](development/build-system-overview-ko.md) +* [빌드 설명서 (Mac)](development/build-instructions-mac-ko.md) +* [빌드 설명서 (Windows)](development/build-instructions-windows-ko.md) +* [빌드 설명서 (Linux)](development/build-instructions-linux-ko.md) +* [디버거에서 디버그 심볼 서버 설정](development/setting-up-symbol-server-ko.md) diff --git a/docs-translations/ko/README.md b/docs-translations/ko/README.md deleted file mode 100644 index 51bf0a36d07f..000000000000 --- a/docs-translations/ko/README.md +++ /dev/null @@ -1,68 +0,0 @@ -## 개발 가이드 - -* [어플리케이션 배포](tutorial/application-distribution.md) -* [어플리케이션 패키징](tutorial/application-packaging.md) -* [네이티브 node 모듈 사용하기](tutorial/using-native-node-modules.md) -* [메인 프로세스 디버깅하기](tutorial/debugging-main-process.md) -* [Selenium 과 WebDriver 사용하기](tutorial/using-selenium-and-webdriver.md) -* [개발자 콘솔 확장기능](tutorial/devtools-extension.md) -* [Pepper 플래시 플러그인 사용하기](tutorial/using-pepper-flash-plugin.md) - -## 튜토리얼 - -* [시작하기](tutorial/quick-start.md) -* [데스크톱 환경 통합](tutorial/desktop-environment-integration.md) -* [온라인/오프라인 이벤트](tutorial/online-offline-events.md) - -## API 레퍼런스 - -* [개요](api/synopsis.md) -* [프로세스 객체](api/process.md) -* [크롬 Command-Line 스위치 지원](api/chrome-command-line-switches.md) - -커스텀 DOM Element: - -* [`File` 객체](api/file-object.md) -* [`` 태그](api/web-view-tag.md) -* [`window.open` 함수](api/window-open.md) - -메인 프로세스를 위한 모듈들: - -* [app](api/app.md) -* [auto-updater](api/auto-updater.md) -* [browser-window](api/browser-window.md) -* [content-tracing](api/content-tracing.md) -* [dialog](api/dialog.md) -* [global-shortcut](api/global-shortcut.md) -* [ipc (main process)](api/ipc-main-process.md) -* [menu](api/menu.md) -* [menu-item](api/menu-item.md) -* [power-monitor](api/power-monitor.md) -* [power-save-blocker](api/power-save-blocker.md) -* [protocol](api/protocol.md) -* [tray](api/tray.md) - -랜더러 프로세스를 위한 모듈들 (웹 페이지): - -* [ipc (renderer)](api/ipc-renderer.md) -* [remote](api/remote.md) -* [web-frame](api/web-frame.md) - -두 프로세스에서 모두 사용 가능한 모듈들: - -* [clipboard](api/clipboard.md) -* [crash-reporter](api/crash-reporter.md) -* [native-image](api/native-image.md) -* [screen](api/screen.md) -* [shell](api/shell.md) - -## 개발자용 - -* [코딩 스타일](development/coding-style.md) -* [소스 코드 디렉터리 구조](development/source-code-directory-structure.md) -* [NW.js와 기술적으로 다른점 (이전 node-webkit)](development/atom-shell-vs-node-webkit.md) -* [빌드 시스템 개요](development/build-system-overview.md) -* [빌드 설명서 (Mac)](development/build-instructions-mac.md) -* [빌드 설명서 (Windows)](development/build-instructions-windows.md) -* [빌드 설명서 (Linux)](development/build-instructions-linux.md) -* [디버거에서 디버그 심볼 서버 설정](development/setting-up-symbol-server.md) diff --git a/docs-translations/ko/api/accelerator.md b/docs-translations/ko/api/accelerator-ko.md similarity index 100% rename from docs-translations/ko/api/accelerator.md rename to docs-translations/ko/api/accelerator-ko.md diff --git a/docs-translations/ko/api/auto-updater.md b/docs-translations/ko/api/auto-updater-ko.md similarity index 100% rename from docs-translations/ko/api/auto-updater.md rename to docs-translations/ko/api/auto-updater-ko.md diff --git a/docs-translations/ko/api/chrome-command-line-switches.md b/docs-translations/ko/api/chrome-command-line-switches-ko.md similarity index 97% rename from docs-translations/ko/api/chrome-command-line-switches.md rename to docs-translations/ko/api/chrome-command-line-switches-ko.md index 5b9bf4722042..7d1a7011eff6 100644 --- a/docs-translations/ko/api/chrome-command-line-switches.md +++ b/docs-translations/ko/api/chrome-command-line-switches-ko.md @@ -62,9 +62,9 @@ Hostname 맵핑 규칙을 설정합니다. (`,`로 분리) `--host-rules` 플래그와 비슷하지만 이 플래그는 host resolver에만 적용됩니다. -[app]: app.md -[append-switch]: app.md#appcommandlineappendswitchswitch-value -[ready]: app.md#event-ready +[app]: app-ko.md +[append-switch]: app-ko.md#appcommandlineappendswitchswitch-value +[ready]: app-ko.md#event-ready ## --ignore-certificate-errors diff --git a/docs-translations/ko/api/clipboard.md b/docs-translations/ko/api/clipboard-ko.md similarity index 94% rename from docs-translations/ko/api/clipboard.md rename to docs-translations/ko/api/clipboard-ko.md index a6b29c2a377f..bc6c82786cb7 100644 --- a/docs-translations/ko/api/clipboard.md +++ b/docs-translations/ko/api/clipboard-ko.md @@ -45,11 +45,11 @@ console.log(clipboard.readText('selection')); * `type` String -클립보드로부터 [NativeImage](native-image.md)로 이미지를 읽어들입니다. +클립보드로부터 [NativeImage](native-image-ko.md)로 이미지를 읽어들입니다. ## clipboard.writeImage(image[, type]) -* `image` [NativeImage](native-image.md) +* `image` [NativeImage](native-image-ko.md) * `type` String 클립보드에 `image`를 씁니다. diff --git a/docs-translations/ko/api/content-tracing.md b/docs-translations/ko/api/content-tracing-ko.md similarity index 100% rename from docs-translations/ko/api/content-tracing.md rename to docs-translations/ko/api/content-tracing-ko.md diff --git a/docs-translations/ko/api/crash-reporter.md b/docs-translations/ko/api/crash-reporter-ko.md similarity index 100% rename from docs-translations/ko/api/crash-reporter.md rename to docs-translations/ko/api/crash-reporter-ko.md diff --git a/docs-translations/ko/api/dialog.md b/docs-translations/ko/api/dialog-ko.md similarity index 99% rename from docs-translations/ko/api/dialog.md rename to docs-translations/ko/api/dialog-ko.md index 4f151f0b1ebb..2f24c659f913 100644 --- a/docs-translations/ko/api/dialog.md +++ b/docs-translations/ko/api/dialog-ko.md @@ -77,7 +77,7 @@ Windows와 Linux에선 파일 선택 모드, 디렉터리 선택 모드를 동 * `title` String - 대화 상자의 제목입니다. 몇몇 플랫폼에선 보이지 않을 수 있습니다. * `message` String - 대화 상자의 본문 내용입니다. * `detail` String - 메시지의 추가 정보입니다. - * `icon` [NativeImage](native-image.md) + * `icon` [NativeImage](native-image-ko.md) * `cancelId` Integer - 유저가 대화 상자의 버튼을 클릭하지 않고 대화 상자를 취소했을 때 반환되는 버튼의 index입니다. 기본적으로 버튼 리스트가 "cancel" 또는 "no" 라벨을 가지고 있을 때 해당 버튼의 index를 반환합니다. 따로 두 라벨이 지정되지 않은 경우 0을 반환합니다. OS X와 Windows에선 `cancelId` 지정 여부에 상관없이 "Cancel" 버튼이 언제나 `cancelId`로 지정됩니다. diff --git a/docs-translations/ko/api/file-object.md b/docs-translations/ko/api/file-object-ko.md similarity index 100% rename from docs-translations/ko/api/file-object.md rename to docs-translations/ko/api/file-object-ko.md diff --git a/docs-translations/ko/api/frameless-window.md b/docs-translations/ko/api/frameless-window-ko.md similarity index 97% rename from docs-translations/ko/api/frameless-window.md rename to docs-translations/ko/api/frameless-window-ko.md index 3dc45b824fd1..420b277d9b17 100644 --- a/docs-translations/ko/api/frameless-window.md +++ b/docs-translations/ko/api/frameless-window-ko.md @@ -4,7 +4,7 @@ Frameless 윈도우는 테두리가 없는 윈도우 창을 말합니다. ## Frameless 윈도우 만들기 -Frameless 윈도우를 만드려면 [BrowserWindow](browser-window.md) 객체의 `options`에서 `frame` 옵션을 `false`로 지정하기만 하면됩니다: +Frameless 윈도우를 만드려면 [BrowserWindow](browser-window-ko.md) 객체의 `options`에서 `frame` 옵션을 `false`로 지정하기만 하면됩니다: ```javascript var BrowserWindow = require('browser-window'); diff --git a/docs-translations/ko/api/global-shortcut.md b/docs-translations/ko/api/global-shortcut-ko.md similarity index 92% rename from docs-translations/ko/api/global-shortcut.md rename to docs-translations/ko/api/global-shortcut-ko.md index d99085f448e5..25c1d320870e 100644 --- a/docs-translations/ko/api/global-shortcut.md +++ b/docs-translations/ko/api/global-shortcut-ko.md @@ -32,20 +32,20 @@ app.on('will-quit', function() { ## globalShortcut.register(accelerator, callback) -* `accelerator` [Accelerator](accelerator.md) +* `accelerator` [Accelerator](accelerator-ko.md) * `callback` Function `accelerator`로 표현된 전역 단축키를 등록합니다. 유저로부터 등록된 단축키가 눌렸을 경우 `callback` 함수가 호출됩니다. ## globalShortcut.isRegistered(accelerator) -* `accelerator` [Accelerator](accelerator.md) +* `accelerator` [Accelerator](accelerator-ko.md) 지정된 `accelerator` 단축키가 등록되었는지 여부를 확인합니다. 반환값은 boolean(true, false) 입니다. ## globalShortcut.unregister(accelerator) -* `accelerator` [Accelerator](accelerator.md) +* `accelerator` [Accelerator](accelerator-ko.md) `키코드`에 해당하는 전역 단축키를 등록 해제합니다. diff --git a/docs-translations/ko/api/ipc-main-process.md b/docs-translations/ko/api/ipc-main-process-ko.md similarity index 92% rename from docs-translations/ko/api/ipc-main-process.md rename to docs-translations/ko/api/ipc-main-process-ko.md index 7f6a091de46d..7d0aba08efa5 100644 --- a/docs-translations/ko/api/ipc-main-process.md +++ b/docs-translations/ko/api/ipc-main-process-ko.md @@ -6,7 +6,7 @@ 동기 메시지는 `event.returnValue`를 이용하여 반환값(답장)을 설정할 수 있습니다. 비동기 메시지라면 `event.sender.send(...)`를 사용하면 됩니다. 또한 메인 프로세스에서 랜더러 프로세스로 메시지를 보내는 것도 가능합니다. -자세한 내용은 [WebContents.send](browser-window.md#webcontentssendchannel-args)를 참고 하세요. +자세한 내용은 [WebContents.send](browser-window-ko.md#webcontentssendchannel-args)를 참고 하세요. 보내진 메시지들을 처리하는 예제입니다: diff --git a/docs-translations/ko/api/ipc-renderer.md b/docs-translations/ko/api/ipc-renderer-ko.md similarity index 85% rename from docs-translations/ko/api/ipc-renderer.md rename to docs-translations/ko/api/ipc-renderer-ko.md index b8bbb7ffa14d..e4664480447f 100644 --- a/docs-translations/ko/api/ipc-renderer.md +++ b/docs-translations/ko/api/ipc-renderer-ko.md @@ -1,9 +1,9 @@ # ipc (renderer) `ipc` 모듈은 메인 프로세스로 메시지를 동기 또는 비동기로 보내고 받을 수 있는 몇 가지 방법을 제공합니다. -만약 랜더러 프로세스에서 메인 프로세스의 모듈을 직접적으로 사용하고 싶다면 [remote](remote.md) 모듈을 사용하는 것을 고려해보는 것이 좋습니다. +만약 랜더러 프로세스에서 메인 프로세스의 모듈을 직접적으로 사용하고 싶다면 [remote](remote-ko.md) 모듈을 사용하는 것을 고려해보는 것이 좋습니다. -[ipc (main process)](ipc-main-process.md)에서 예제를 볼 수 있습니다. +[ipc (main process)](ipc-main-process-ko.md)에서 예제를 볼 수 있습니다. ## ipc.send(channel[, args...]) diff --git a/docs-translations/ko/api/menu-item.md b/docs-translations/ko/api/menu-item-ko.md similarity index 90% rename from docs-translations/ko/api/menu-item.md rename to docs-translations/ko/api/menu-item-ko.md index 519b7fb237a3..8477451ff965 100644 --- a/docs-translations/ko/api/menu-item.md +++ b/docs-translations/ko/api/menu-item-ko.md @@ -10,8 +10,8 @@ * `type` String - `MenuItem`의 타입 `normal`, `separator`, `submenu`, `checkbox` 또는 `radio` 사용가능 * `label` String * `sublabel` String - * `accelerator` [Accelerator](accelerator.md) - * `icon` [NativeImage](native-image.md) + * `accelerator` [Accelerator](accelerator-ko.md) + * `icon` [NativeImage](native-image-ko.md) * `enabled` Boolean * `visible` Boolean * `checked` Boolean diff --git a/docs-translations/ko/api/menu.md b/docs-translations/ko/api/menu-ko.md similarity index 95% rename from docs-translations/ko/api/menu.md rename to docs-translations/ko/api/menu-ko.md index 3303a55d05f2..7f2b5ad90c80 100644 --- a/docs-translations/ko/api/menu.md +++ b/docs-translations/ko/api/menu-ko.md @@ -3,7 +3,7 @@ `Menu` 클래스는 어플리케이션 메뉴와 컨텍스트 메뉴를 만들 때 사용됩니다. 메뉴는 여러 개의 메뉴 아이템으로 구성되고 서브 메뉴를 가질 수도 있습니다. -다음 예제는 웹 페이지 내에서 [remote](remote.md) 모듈을 활용하여 동적으로 메뉴를 생성하는 예제입니다. +다음 예제는 웹 페이지 내에서 [remote](remote-ko.md) 모듈을 활용하여 동적으로 메뉴를 생성하는 예제입니다. 이 예제에서 만들어진 메뉴는 유저가 페이지에서 오른쪽 클릭을 할 때 마우스 위치에 팝업 형태로 표시됩니다: @@ -28,7 +28,7 @@ window.addEventListener('contextmenu', function (e) { 다음 예제는 template API를 활용하여 어플리케이션 메뉴를 만드는 간단한 예제입니다: -**Windows 와 Linux 유저 주의:** 각 메뉴 아이템의 `selector` 멤버는 Mac 운영체제 전용입니다. [Accelerator 옵션](accelerator.md) +**Windows 와 Linux 유저 주의:** 각 메뉴 아이템의 `selector` 멤버는 Mac 운영체제 전용입니다. [Accelerator 옵션](https://github.com/atom/electron/blob/master/docs/api/accelerator-ko.md) ```html @@ -189,7 +189,7 @@ Menu.setApplicationMenu(menu); * `template` Array -기본적으로 `template`는 [MenuItem](menu-item.md)을 생성할 때 사용하는 `options`의 배열입니다. 사용법은 위에서 설명한 것과 같습니다. +기본적으로 `template`는 [MenuItem](menu-item-ko.md)을 생성할 때 사용하는 `options`의 배열입니다. 사용법은 위에서 설명한 것과 같습니다. 또한 `template`에는 다른 속성도 추가할 수 있으며 메뉴가 만들어질 때 해당 메뉴 아이템의 프로퍼티로 변환됩니다. diff --git a/docs-translations/ko/api/native-image.md b/docs-translations/ko/api/native-image-ko.md similarity index 100% rename from docs-translations/ko/api/native-image.md rename to docs-translations/ko/api/native-image-ko.md diff --git a/docs-translations/ko/api/power-monitor.md b/docs-translations/ko/api/power-monitor-ko.md similarity index 100% rename from docs-translations/ko/api/power-monitor.md rename to docs-translations/ko/api/power-monitor-ko.md diff --git a/docs-translations/ko/api/power-save-blocker.md b/docs-translations/ko/api/power-save-blocker-ko.md similarity index 100% rename from docs-translations/ko/api/power-save-blocker.md rename to docs-translations/ko/api/power-save-blocker-ko.md diff --git a/docs-translations/ko/api/process.md b/docs-translations/ko/api/process-ko.md similarity index 100% rename from docs-translations/ko/api/process.md rename to docs-translations/ko/api/process-ko.md diff --git a/docs-translations/ko/api/protocol.md b/docs-translations/ko/api/protocol-ko.md similarity index 100% rename from docs-translations/ko/api/protocol.md rename to docs-translations/ko/api/protocol-ko.md diff --git a/docs-translations/ko/api/remote.md b/docs-translations/ko/api/remote-ko.md similarity index 99% rename from docs-translations/ko/api/remote.md rename to docs-translations/ko/api/remote-ko.md index c2713db4a910..64232bdc31af 100644 --- a/docs-translations/ko/api/remote.md +++ b/docs-translations/ko/api/remote-ko.md @@ -70,7 +70,7 @@ remote.getCurrentWindow().on('close', function() { ## remote.getCurrentWindow() -현재 웹 페이지가 들어있는 [BrowserWindow](browser-window.md) 객체를 반환합니다. +현재 웹 페이지가 들어있는 [BrowserWindow](browser-window-ko.md) 객체를 반환합니다. ## remote.getCurrentWebContents() diff --git a/docs-translations/ko/api/screen.md b/docs-translations/ko/api/screen-ko.md similarity index 100% rename from docs-translations/ko/api/screen.md rename to docs-translations/ko/api/screen-ko.md diff --git a/docs-translations/ko/api/shell.md b/docs-translations/ko/api/shell-ko.md similarity index 100% rename from docs-translations/ko/api/shell.md rename to docs-translations/ko/api/shell-ko.md diff --git a/docs-translations/ko/api/synopsis.md b/docs-translations/ko/api/synopsis-ko.md similarity index 81% rename from docs-translations/ko/api/synopsis.md rename to docs-translations/ko/api/synopsis-ko.md index 69ee4af354c7..8754f2f15bf2 100644 --- a/docs-translations/ko/api/synopsis.md +++ b/docs-translations/ko/api/synopsis-ko.md @@ -1,11 +1,11 @@ # 개요 -Electron은 모든 [node.js's built-in 모듈](http://nodejs.org/api/)과 third-party node 모듈을 완벽하게 지원합니다. ([네이티브 모듈](../tutorial/using-native-node-modules.md)을 포함해서) +Electron은 모든 [node.js's built-in 모듈](http://nodejs.org/api/)과 third-party node 모듈을 완벽하게 지원합니다. ([네이티브 모듈](../tutorial/using-native-node-modules-ko.md)을 포함해서) Electron은 네이티브 데스크톱 어플리케이션을 개발 할 수 있도록 추가적인 built-in 모듈을 제공합니다. 몇몇 모듈은 메인 프로세스에서만 사용할 수 있고 어떤 모듈은 랜더러 프로세스에서만 사용할 수 있습니다. 또한 두 프로세스 모두 사용할 수 있는 모듈도 있습니다. 기본적인 규칙은 다음과 같습니다: GUI와 저 수준 시스템에 관련된 모듈은 오직 메인 프로세스에서만 사용할 수 있습니다. -[메인 프로세스 vs. 랜더러 프로세스](../tutorial/quick-start.md#메인 프로세스) 컨셉에 익숙해야 이 모듈들을 사용하기 쉬우므로 해당 문서를 정독하는 것을 권장합니다. +[메인 프로세스 vs. 랜더러 프로세스](../tutorial/quick-start-ko.md#메인 프로세스) 컨셉에 익숙해야 이 모듈들을 사용하기 쉬우므로 해당 문서를 정독하는 것을 권장합니다. 메인 프로세스 스크립트는 일반 `node.js` 스크립트와 같습니다: @@ -36,4 +36,4 @@ app.on('ready', function() { ``` -어플리케이션을 실행하려면 [앱 실행하기](../tutorial/quick-start.md#앱 실행하기) 문서를 참고하기 바랍니다. +어플리케이션을 실행하려면 [앱 실행하기](../tutorial/quick-start-ko.md#앱 실행하기) 문서를 참고하기 바랍니다. diff --git a/docs-translations/ko/api/tray.md b/docs-translations/ko/api/tray-ko.md similarity index 96% rename from docs-translations/ko/api/tray.md rename to docs-translations/ko/api/tray-ko.md index 05decef5a48f..a32ccbb1d0e2 100644 --- a/docs-translations/ko/api/tray.md +++ b/docs-translations/ko/api/tray-ko.md @@ -38,7 +38,7 @@ __플랫폼별 한계:__ ### new Tray(image) -* `image` [NativeImage](native-image.md) +* `image` [NativeImage](native-image-ko.md) 전달된 `image`를 이용하여 트레이 아이콘을 만듭니다. @@ -126,13 +126,13 @@ __주의:__ 이 기능은 OS X에서만 작동합니다. ### Tray.setImage(image) -* `image` [NativeImage](native-image.md) +* `image` [NativeImage](native-image-ko.md) `image`를 사용하여 트레이 아이콘의 이미지를 설정합니다. ### Tray.setPressedImage(image) -* `image` [NativeImage](native-image.md) +* `image` [NativeImage](native-image-ko.md) `image`를 사용하여 트레이 아이콘이 눌렸을 때의 이미지를 설정합니다. @@ -163,7 +163,7 @@ __주의:__ 이 기능은 OS X에서만 작동합니다. ### Tray.displayBalloon(options) * `options` Object - * `icon` [NativeImage](native-image.md) + * `icon` [NativeImage](native-image-ko.md) * `title` String * `content` String diff --git a/docs-translations/ko/api/web-frame.md b/docs-translations/ko/api/web-frame-ko.md similarity index 100% rename from docs-translations/ko/api/web-frame.md rename to docs-translations/ko/api/web-frame-ko.md diff --git a/docs-translations/ko/api/web-view-tag.md b/docs-translations/ko/api/web-view-tag-ko.md similarity index 99% rename from docs-translations/ko/api/web-view-tag.md rename to docs-translations/ko/api/web-view-tag-ko.md index d2efdf17ea1f..32a5a835516f 100644 --- a/docs-translations/ko/api/web-view-tag.md +++ b/docs-translations/ko/api/web-view-tag-ko.md @@ -311,7 +311,7 @@ Webview 페이지를 PDF 형식으로 인쇄합니다. `webContents.printToPDF(o `channel`을 통해 게스트 페이지에 `args...` 비동기 메시지를 보냅니다. 게스트 페이지에선 `ipc` 모듈의 `channel` 이벤트를 사용하면 이 메시지를 받을 수 있습니다. -예제는 [WebContents.send](browser-window.md#webcontentssendchannel-args)를 참고하세요. +예제는 [WebContents.send](browser-window-ko.md#webcontentssendchannel-args)를 참고하세요. ## DOM 이벤트 diff --git a/docs-translations/ko/api/window-open.md b/docs-translations/ko/api/window-open-ko.md similarity index 100% rename from docs-translations/ko/api/window-open.md rename to docs-translations/ko/api/window-open-ko.md diff --git a/docs-translations/ko/development/atom-shell-vs-node-webkit.md b/docs-translations/ko/development/atom-shell-vs-node-webkit-ko.md similarity index 100% rename from docs-translations/ko/development/atom-shell-vs-node-webkit.md rename to docs-translations/ko/development/atom-shell-vs-node-webkit-ko.md diff --git a/docs-translations/ko/development/build-instructions-linux.md b/docs-translations/ko/development/build-instructions-linux-ko.md similarity index 100% rename from docs-translations/ko/development/build-instructions-linux.md rename to docs-translations/ko/development/build-instructions-linux-ko.md diff --git a/docs-translations/ko/development/build-instructions-mac.md b/docs-translations/ko/development/build-instructions-mac-ko.md similarity index 100% rename from docs-translations/ko/development/build-instructions-mac.md rename to docs-translations/ko/development/build-instructions-mac-ko.md diff --git a/docs-translations/ko/development/build-instructions-windows.md b/docs-translations/ko/development/build-instructions-windows-ko.md similarity index 100% rename from docs-translations/ko/development/build-instructions-windows.md rename to docs-translations/ko/development/build-instructions-windows-ko.md diff --git a/docs-translations/ko/development/build-system-overview.md b/docs-translations/ko/development/build-system-overview-ko.md similarity index 100% rename from docs-translations/ko/development/build-system-overview.md rename to docs-translations/ko/development/build-system-overview-ko.md diff --git a/docs-translations/ko/development/coding-style.md b/docs-translations/ko/development/coding-style-ko.md similarity index 100% rename from docs-translations/ko/development/coding-style.md rename to docs-translations/ko/development/coding-style-ko.md diff --git a/docs-translations/ko/development/setting-up-symbol-server.md b/docs-translations/ko/development/setting-up-symbol-server-ko.md similarity index 100% rename from docs-translations/ko/development/setting-up-symbol-server.md rename to docs-translations/ko/development/setting-up-symbol-server-ko.md diff --git a/docs-translations/ko/development/source-code-directory-structure.md b/docs-translations/ko/development/source-code-directory-structure-ko.md similarity index 100% rename from docs-translations/ko/development/source-code-directory-structure.md rename to docs-translations/ko/development/source-code-directory-structure-ko.md diff --git a/docs-translations/ko/tutorial/application-distribution.md b/docs-translations/ko/tutorial/application-distribution-ko.md similarity index 99% rename from docs-translations/ko/tutorial/application-distribution.md rename to docs-translations/ko/tutorial/application-distribution-ko.md index fac2ae48a140..043ced1ec47c 100644 --- a/docs-translations/ko/tutorial/application-distribution.md +++ b/docs-translations/ko/tutorial/application-distribution-ko.md @@ -48,7 +48,7 @@ electron/resources/ └── app.asar ``` -자세한 내용은 [어플리케이션 패키징](application-packaging.md)에서 찾아볼 수 있습니다. +자세한 내용은 [어플리케이션 패키징](application-packaging-ko.md)에서 찾아볼 수 있습니다. ## 다운로드한 바이너리의 리소스를 앱에 맞게 수정하기 diff --git a/docs-translations/ko/tutorial/application-packaging.md b/docs-translations/ko/tutorial/application-packaging-ko.md similarity index 100% rename from docs-translations/ko/tutorial/application-packaging.md rename to docs-translations/ko/tutorial/application-packaging-ko.md diff --git a/docs-translations/ko/tutorial/debugging-main-process.md b/docs-translations/ko/tutorial/debugging-main-process-ko.md similarity index 100% rename from docs-translations/ko/tutorial/debugging-main-process.md rename to docs-translations/ko/tutorial/debugging-main-process-ko.md diff --git a/docs-translations/ko/tutorial/desktop-environment-integration.md b/docs-translations/ko/tutorial/desktop-environment-integration-ko.md similarity index 95% rename from docs-translations/ko/tutorial/desktop-environment-integration.md rename to docs-translations/ko/tutorial/desktop-environment-integration-ko.md index 9d1b5ffadcc4..68f5562dbb52 100644 --- a/docs-translations/ko/tutorial/desktop-environment-integration.md +++ b/docs-translations/ko/tutorial/desktop-environment-integration-ko.md @@ -211,12 +211,12 @@ window.setRepresentedFilename('/etc/passwd'); window.setDocumentEdited(true); ``` -[addrecentdocument]: ../api/app.md#appaddrecentdocumentpath -[clearrecentdocuments]: ../api/app.md#appclearrecentdocuments -[setusertaskstasks]: ../api/app.md#appsetusertaskstasks -[setprogressbar]: ../api/browser-window.md#browserwindowsetprogressbarprogress -[setrepresentedfilename]: ../api/browser-window.md#browserwindowsetrepresentedfilenamefilename -[setdocumentedited]: ../api/browser-window.md#browserwindowsetdocumenteditededited +[addrecentdocument]: ../api/app-ko.md#appaddrecentdocumentpath +[clearrecentdocuments]: ../api/app-ko.md#appclearrecentdocuments +[setusertaskstasks]: ../api/app-ko.md#appsetusertaskstasks +[setprogressbar]: ../api/browser-window-ko.md#browserwindowsetprogressbarprogress +[setrepresentedfilename]: ../api/browser-window-ko.md#browserwindowsetrepresentedfilenamefilename +[setdocumentedited]: ../api/browser-window-ko.md#browserwindowsetdocumenteditededited [app-registration]: http://msdn.microsoft.com/en-us/library/windows/desktop/ee872121(v=vs.85).aspx [unity-launcher]: https://help.ubuntu.com/community/UnityLaunchersAndDesktopFiles#Adding_shortcuts_to_a_launcher [setthumbarbuttons]: ../api/browser-window.md#browserwindowsetthumbarbuttonsbuttons diff --git a/docs-translations/ko/tutorial/devtools-extension.md b/docs-translations/ko/tutorial/devtools-extension-ko.md similarity index 100% rename from docs-translations/ko/tutorial/devtools-extension.md rename to docs-translations/ko/tutorial/devtools-extension-ko.md diff --git a/docs-translations/ko/tutorial/online-offline-events.md b/docs-translations/ko/tutorial/online-offline-events-ko.md similarity index 100% rename from docs-translations/ko/tutorial/online-offline-events.md rename to docs-translations/ko/tutorial/online-offline-events-ko.md diff --git a/docs-translations/ko/tutorial/quick-start.md b/docs-translations/ko/tutorial/quick-start-ko.md similarity index 92% rename from docs-translations/ko/tutorial/quick-start.md rename to docs-translations/ko/tutorial/quick-start-ko.md index 7564f1c8c4c9..1d548c6f01c0 100644 --- a/docs-translations/ko/tutorial/quick-start.md +++ b/docs-translations/ko/tutorial/quick-start-ko.md @@ -33,8 +33,8 @@ Electron 프로세스 내에서 작동하는 웹 페이지는 __랜더러 프로 기본적으로 웹 페이지 내에서는 네이티브 GUI와 관련된 API를 호출할 수 없도록 되어 있습니다. 만약 웹 페이지 내에서 GUI작업이 필요하다면 메인 프로세스에서 그 작업을 할 수 있도록 메인 프로세스와 통신을 해야합니다. -Electron에는 메인 프로세스와 랜더러 프로세스간에 통신을 할 수 있도록 [ipc](../api/ipc-renderer.md) 모듈을 제공하고 있습니다. -또한 [remote](../api/remote.md) 모듈을 사용하여 RPC 스타일로 통신할 수도 있습니다. +Electron에는 메인 프로세스와 랜더러 프로세스간에 통신을 할 수 있도록 [ipc](../api/ipc-renderer-ko.md) 모듈을 제공하고 있습니다. +또한 [remote](../api/remote-ko.md) 모듈을 사용하여 RPC 스타일로 통신할 수도 있습니다. ## 첫번째 Electron 앱 만들기 @@ -121,7 +121,7 @@ app.on('ready', function() { ## 앱 실행하기 -앱을 작성한 후 [어플리케이션 배포](application-distribution.md) 가이드를 따라 앱을 패키징 하고 패키징한 앱을 실행할 수 있습니다. +앱을 작성한 후 [어플리케이션 배포](./application-distribution-ko.md) 가이드를 따라 앱을 패키징 하고 패키징한 앱을 실행할 수 있습니다. 또는 Electron 실행파일을 다운로드 받아 바로 실행해 볼 수도 있습니다. ### electron-prebuilt @@ -173,4 +173,4 @@ $ ./Electron.app/Contents/MacOS/Electron your-app/ ### 배포용 파일 만들기 -어플리케이션 작성을 완료했다면 [어플리케이션 배포](application-distribution.md) 가이드를 통해 본격적으로 제작한 앱을 배포할 수 있습니다. \ No newline at end of file +어플리케이션 작성을 완료했다면 [어플리케이션 배포](./application-distribution-ko.md) 가이드를 통해 본격적으로 제작한 앱을 배포할 수 있습니다. \ No newline at end of file diff --git a/docs-translations/ko/tutorial/using-native-node-modules.md b/docs-translations/ko/tutorial/using-native-node-modules-ko.md similarity index 100% rename from docs-translations/ko/tutorial/using-native-node-modules.md rename to docs-translations/ko/tutorial/using-native-node-modules-ko.md diff --git a/docs-translations/ko/tutorial/using-pepper-flash-plugin.md b/docs-translations/ko/tutorial/using-pepper-flash-plugin-ko.md similarity index 100% rename from docs-translations/ko/tutorial/using-pepper-flash-plugin.md rename to docs-translations/ko/tutorial/using-pepper-flash-plugin-ko.md diff --git a/docs-translations/ko/tutorial/using-selenium-and-webdriver.md b/docs-translations/ko/tutorial/using-selenium-and-webdriver-ko.md similarity index 95% rename from docs-translations/ko/tutorial/using-selenium-and-webdriver.md rename to docs-translations/ko/tutorial/using-selenium-and-webdriver-ko.md index 069a49e52798..80b56e23ada1 100644 --- a/docs-translations/ko/tutorial/using-selenium-and-webdriver.md +++ b/docs-translations/ko/tutorial/using-selenium-and-webdriver-ko.md @@ -69,6 +69,6 @@ driver.quit(); ## 작업환경 따로 Electron을 다시 빌드하지 않는 경우 간단히 어플리케이션을 Electron의 리소스 디렉터리에 -[배치](application-distribution.md)하여 바로 테스트 할 수 있습니다. +[배치](https://github.com/atom/electron/blob/master/docs/tutorial/application-distribution-ko.md)하여 바로 테스트 할 수 있습니다. [chrome-driver]: https://sites.google.com/a/chromium.org/chromedriver/ diff --git a/vendor/node b/vendor/node index 902090af5375..205b013ac86e 160000 --- a/vendor/node +++ b/vendor/node @@ -1 +1 @@ -Subproject commit 902090af5375e497dded310575f19de5328a9bbc +Subproject commit 205b013ac86e5500678a791cd54f305580fa4f4b From 50cbb5744bf9653da46d9ec378d67eb24b62b4d8 Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Tue, 25 Aug 2015 22:15:43 +0900 Subject: [PATCH 0948/1293] Revert "Fix link target in README.md" This reverts commit c9965f0ffddf174d26ad52489f2a47ce938723c1. --- README-ko.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README-ko.md b/README-ko.md index bbe1333cf553..91459c6adf2e 100644 --- a/README-ko.md +++ b/README-ko.md @@ -1,4 +1,4 @@ -[![Electron Logo](http://electron.atom.io/images/electron-logo.svg)](http://electron.atom.io/) +[![Electron Logo](http://electron.atom.io/images/electron-logo.svg)](http://electron.atom.io/) [![Build Status](https://travis-ci.org/atom/electron.svg?branch=master)](https://travis-ci.org/atom/electron) [![devDependency Status](https://david-dm.org/atom/electron/dev-status.svg)](https://david-dm.org/atom/electron#info=devDependencies) @@ -33,7 +33,7 @@ npm install electron-prebuilt --save-dev ## 참조 문서 -[Docs](https://github.com/atom/electron/tree/master/docs/README.md)에 개발 가이드와 API 레퍼런스가 있습니다. +[Docs](https://github.com/atom/electron/tree/master/docs/README-ko.md)에 개발 가이드와 API 레퍼런스가 있습니다. Electron을 빌드 하는 방법과 프로젝트에 기여하는 방법도 문서에 포함되어 있으니 참고하시기 바랍니다. ## 참조 문서(번역) From 2592d2cfcdf46f5794ddbf6b13911f680981775f Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Tue, 25 Aug 2015 22:17:01 +0900 Subject: [PATCH 0949/1293] Revert "Revert "Rename xx-ko.md to xx.md"" This reverts commit aef4acb2e65bb1de43c2e98f010c4d4cae3780d6. --- docs-translations/ko/README-ko.md | 68 ------------------- docs-translations/ko/README.md | 68 +++++++++++++++++++ .../api/{accelerator-ko.md => accelerator.md} | 0 .../{auto-updater-ko.md => auto-updater.md} | 0 ...-ko.md => chrome-command-line-switches.md} | 6 +- .../ko/api/{clipboard-ko.md => clipboard.md} | 4 +- ...ntent-tracing-ko.md => content-tracing.md} | 0 ...crash-reporter-ko.md => crash-reporter.md} | 0 .../ko/api/{dialog-ko.md => dialog.md} | 2 +- .../api/{file-object-ko.md => file-object.md} | 0 ...eless-window-ko.md => frameless-window.md} | 2 +- ...obal-shortcut-ko.md => global-shortcut.md} | 6 +- ...main-process-ko.md => ipc-main-process.md} | 2 +- .../{ipc-renderer-ko.md => ipc-renderer.md} | 4 +- .../ko/api/{menu-item-ko.md => menu-item.md} | 4 +- .../ko/api/{menu-ko.md => menu.md} | 6 +- .../{native-image-ko.md => native-image.md} | 0 .../{power-monitor-ko.md => power-monitor.md} | 0 ...ve-blocker-ko.md => power-save-blocker.md} | 0 .../ko/api/{process-ko.md => process.md} | 0 .../ko/api/{protocol-ko.md => protocol.md} | 0 .../ko/api/{remote-ko.md => remote.md} | 2 +- .../ko/api/{screen-ko.md => screen.md} | 0 .../ko/api/{shell-ko.md => shell.md} | 0 .../ko/api/{synopsis-ko.md => synopsis.md} | 6 +- .../ko/api/{tray-ko.md => tray.md} | 8 +-- .../ko/api/{web-frame-ko.md => web-frame.md} | 0 .../{web-view-tag-ko.md => web-view-tag.md} | 2 +- .../api/{window-open-ko.md => window-open.md} | 0 ...kit-ko.md => atom-shell-vs-node-webkit.md} | 0 ...inux-ko.md => build-instructions-linux.md} | 0 ...ns-mac-ko.md => build-instructions-mac.md} | 0 ...ws-ko.md => build-instructions-windows.md} | 0 ...verview-ko.md => build-system-overview.md} | 0 .../{coding-style-ko.md => coding-style.md} | 0 ...rver-ko.md => setting-up-symbol-server.md} | 0 ....md => source-code-directory-structure.md} | 0 ...tion-ko.md => application-distribution.md} | 2 +- ...ckaging-ko.md => application-packaging.md} | 0 ...rocess-ko.md => debugging-main-process.md} | 0 ....md => desktop-environment-integration.md} | 12 ++-- ...-extension-ko.md => devtools-extension.md} | 0 ...-events-ko.md => online-offline-events.md} | 0 .../{quick-start-ko.md => quick-start.md} | 8 +-- ...les-ko.md => using-native-node-modules.md} | 0 ...gin-ko.md => using-pepper-flash-plugin.md} | 0 ...-ko.md => using-selenium-and-webdriver.md} | 2 +- vendor/node | 2 +- 48 files changed, 108 insertions(+), 108 deletions(-) delete mode 100644 docs-translations/ko/README-ko.md create mode 100644 docs-translations/ko/README.md rename docs-translations/ko/api/{accelerator-ko.md => accelerator.md} (100%) rename docs-translations/ko/api/{auto-updater-ko.md => auto-updater.md} (100%) rename docs-translations/ko/api/{chrome-command-line-switches-ko.md => chrome-command-line-switches.md} (97%) rename docs-translations/ko/api/{clipboard-ko.md => clipboard.md} (94%) rename docs-translations/ko/api/{content-tracing-ko.md => content-tracing.md} (100%) rename docs-translations/ko/api/{crash-reporter-ko.md => crash-reporter.md} (100%) rename docs-translations/ko/api/{dialog-ko.md => dialog.md} (99%) rename docs-translations/ko/api/{file-object-ko.md => file-object.md} (100%) rename docs-translations/ko/api/{frameless-window-ko.md => frameless-window.md} (97%) rename docs-translations/ko/api/{global-shortcut-ko.md => global-shortcut.md} (92%) rename docs-translations/ko/api/{ipc-main-process-ko.md => ipc-main-process.md} (92%) rename docs-translations/ko/api/{ipc-renderer-ko.md => ipc-renderer.md} (85%) rename docs-translations/ko/api/{menu-item-ko.md => menu-item.md} (90%) rename docs-translations/ko/api/{menu-ko.md => menu.md} (95%) rename docs-translations/ko/api/{native-image-ko.md => native-image.md} (100%) rename docs-translations/ko/api/{power-monitor-ko.md => power-monitor.md} (100%) rename docs-translations/ko/api/{power-save-blocker-ko.md => power-save-blocker.md} (100%) rename docs-translations/ko/api/{process-ko.md => process.md} (100%) rename docs-translations/ko/api/{protocol-ko.md => protocol.md} (100%) rename docs-translations/ko/api/{remote-ko.md => remote.md} (99%) rename docs-translations/ko/api/{screen-ko.md => screen.md} (100%) rename docs-translations/ko/api/{shell-ko.md => shell.md} (100%) rename docs-translations/ko/api/{synopsis-ko.md => synopsis.md} (81%) rename docs-translations/ko/api/{tray-ko.md => tray.md} (96%) rename docs-translations/ko/api/{web-frame-ko.md => web-frame.md} (100%) rename docs-translations/ko/api/{web-view-tag-ko.md => web-view-tag.md} (99%) rename docs-translations/ko/api/{window-open-ko.md => window-open.md} (100%) rename docs-translations/ko/development/{atom-shell-vs-node-webkit-ko.md => atom-shell-vs-node-webkit.md} (100%) rename docs-translations/ko/development/{build-instructions-linux-ko.md => build-instructions-linux.md} (100%) rename docs-translations/ko/development/{build-instructions-mac-ko.md => build-instructions-mac.md} (100%) rename docs-translations/ko/development/{build-instructions-windows-ko.md => build-instructions-windows.md} (100%) rename docs-translations/ko/development/{build-system-overview-ko.md => build-system-overview.md} (100%) rename docs-translations/ko/development/{coding-style-ko.md => coding-style.md} (100%) rename docs-translations/ko/development/{setting-up-symbol-server-ko.md => setting-up-symbol-server.md} (100%) rename docs-translations/ko/development/{source-code-directory-structure-ko.md => source-code-directory-structure.md} (100%) rename docs-translations/ko/tutorial/{application-distribution-ko.md => application-distribution.md} (99%) rename docs-translations/ko/tutorial/{application-packaging-ko.md => application-packaging.md} (100%) rename docs-translations/ko/tutorial/{debugging-main-process-ko.md => debugging-main-process.md} (100%) rename docs-translations/ko/tutorial/{desktop-environment-integration-ko.md => desktop-environment-integration.md} (95%) rename docs-translations/ko/tutorial/{devtools-extension-ko.md => devtools-extension.md} (100%) rename docs-translations/ko/tutorial/{online-offline-events-ko.md => online-offline-events.md} (100%) rename docs-translations/ko/tutorial/{quick-start-ko.md => quick-start.md} (92%) rename docs-translations/ko/tutorial/{using-native-node-modules-ko.md => using-native-node-modules.md} (100%) rename docs-translations/ko/tutorial/{using-pepper-flash-plugin-ko.md => using-pepper-flash-plugin.md} (100%) rename docs-translations/ko/tutorial/{using-selenium-and-webdriver-ko.md => using-selenium-and-webdriver.md} (95%) diff --git a/docs-translations/ko/README-ko.md b/docs-translations/ko/README-ko.md deleted file mode 100644 index b48c6a42c516..000000000000 --- a/docs-translations/ko/README-ko.md +++ /dev/null @@ -1,68 +0,0 @@ -## 개발 가이드 - -* [어플리케이션 배포](tutorial/application-distribution-ko.md) -* [어플리케이션 패키징](tutorial/application-packaging-ko.md) -* [네이티브 node 모듈 사용하기](tutorial/using-native-node-modules-ko.md) -* [메인 프로세스 디버깅하기](tutorial/debugging-main-process-ko.md) -* [Selenium 과 WebDriver 사용하기](tutorial/using-selenium-and-webdriver-ko.md) -* [개발자 콘솔 확장기능](tutorial/devtools-extension-ko.md) -* [Pepper 플래시 플러그인 사용하기](tutorial/using-pepper-flash-plugin-ko.md) - -## 튜토리얼 - -* [시작하기](tutorial/quick-start-ko.md) -* [데스크톱 환경 통합](tutorial/desktop-environment-integration-ko.md) -* [온라인/오프라인 이벤트](tutorial/online-offline-events-ko.md) - -## API 레퍼런스 - -* [개요](api/synopsis-ko.md) -* [프로세스 객체](api/process-ko.md) -* [크롬 Command-Line 스위치 지원](api/chrome-command-line-switches-ko.md) - -커스텀 DOM Element: - -* [`File` 객체](api/file-object-ko.md) -* [`` 태그](api/web-view-tag-ko.md) -* [`window.open` 함수](api/window-open-ko.md) - -메인 프로세스를 위한 모듈들: - -* [app](api/app-ko.md) -* [auto-updater](api/auto-updater-ko.md) -* [browser-window](api/browser-window-ko.md) -* [content-tracing](api/content-tracing-ko.md) -* [dialog](api/dialog-ko.md) -* [global-shortcut](api/global-shortcut-ko.md) -* [ipc (main process)](api/ipc-main-process-ko.md) -* [menu](api/menu-ko.md) -* [menu-item](api/menu-item-ko.md) -* [power-monitor](api/power-monitor-ko.md) -* [power-save-blocker](api/power-save-blocker-ko.md) -* [protocol](api/protocol-ko.md) -* [tray](api/tray-ko.md) - -랜더러 프로세스를 위한 모듈들 (웹 페이지): - -* [ipc (renderer)](api/ipc-renderer-ko.md) -* [remote](api/remote-ko.md) -* [web-frame](api/web-frame-ko.md) - -두 프로세스에서 모두 사용 가능한 모듈들: - -* [clipboard](api/clipboard-ko.md) -* [crash-reporter](api/crash-reporter-ko.md) -* [native-image](api/native-image-ko.md) -* [screen](api/screen-ko.md) -* [shell](api/shell-ko.md) - -## 개발자용 - -* [코딩 스타일](development/coding-style-ko.md) -* [소스 코드 디렉터리 구조](development/source-code-directory-structure-ko.md) -* [NW.js와 기술적으로 다른점 (이전 node-webkit)](development/atom-shell-vs-node-webkit-ko.md) -* [빌드 시스템 개요](development/build-system-overview-ko.md) -* [빌드 설명서 (Mac)](development/build-instructions-mac-ko.md) -* [빌드 설명서 (Windows)](development/build-instructions-windows-ko.md) -* [빌드 설명서 (Linux)](development/build-instructions-linux-ko.md) -* [디버거에서 디버그 심볼 서버 설정](development/setting-up-symbol-server-ko.md) diff --git a/docs-translations/ko/README.md b/docs-translations/ko/README.md new file mode 100644 index 000000000000..51bf0a36d07f --- /dev/null +++ b/docs-translations/ko/README.md @@ -0,0 +1,68 @@ +## 개발 가이드 + +* [어플리케이션 배포](tutorial/application-distribution.md) +* [어플리케이션 패키징](tutorial/application-packaging.md) +* [네이티브 node 모듈 사용하기](tutorial/using-native-node-modules.md) +* [메인 프로세스 디버깅하기](tutorial/debugging-main-process.md) +* [Selenium 과 WebDriver 사용하기](tutorial/using-selenium-and-webdriver.md) +* [개발자 콘솔 확장기능](tutorial/devtools-extension.md) +* [Pepper 플래시 플러그인 사용하기](tutorial/using-pepper-flash-plugin.md) + +## 튜토리얼 + +* [시작하기](tutorial/quick-start.md) +* [데스크톱 환경 통합](tutorial/desktop-environment-integration.md) +* [온라인/오프라인 이벤트](tutorial/online-offline-events.md) + +## API 레퍼런스 + +* [개요](api/synopsis.md) +* [프로세스 객체](api/process.md) +* [크롬 Command-Line 스위치 지원](api/chrome-command-line-switches.md) + +커스텀 DOM Element: + +* [`File` 객체](api/file-object.md) +* [`` 태그](api/web-view-tag.md) +* [`window.open` 함수](api/window-open.md) + +메인 프로세스를 위한 모듈들: + +* [app](api/app.md) +* [auto-updater](api/auto-updater.md) +* [browser-window](api/browser-window.md) +* [content-tracing](api/content-tracing.md) +* [dialog](api/dialog.md) +* [global-shortcut](api/global-shortcut.md) +* [ipc (main process)](api/ipc-main-process.md) +* [menu](api/menu.md) +* [menu-item](api/menu-item.md) +* [power-monitor](api/power-monitor.md) +* [power-save-blocker](api/power-save-blocker.md) +* [protocol](api/protocol.md) +* [tray](api/tray.md) + +랜더러 프로세스를 위한 모듈들 (웹 페이지): + +* [ipc (renderer)](api/ipc-renderer.md) +* [remote](api/remote.md) +* [web-frame](api/web-frame.md) + +두 프로세스에서 모두 사용 가능한 모듈들: + +* [clipboard](api/clipboard.md) +* [crash-reporter](api/crash-reporter.md) +* [native-image](api/native-image.md) +* [screen](api/screen.md) +* [shell](api/shell.md) + +## 개발자용 + +* [코딩 스타일](development/coding-style.md) +* [소스 코드 디렉터리 구조](development/source-code-directory-structure.md) +* [NW.js와 기술적으로 다른점 (이전 node-webkit)](development/atom-shell-vs-node-webkit.md) +* [빌드 시스템 개요](development/build-system-overview.md) +* [빌드 설명서 (Mac)](development/build-instructions-mac.md) +* [빌드 설명서 (Windows)](development/build-instructions-windows.md) +* [빌드 설명서 (Linux)](development/build-instructions-linux.md) +* [디버거에서 디버그 심볼 서버 설정](development/setting-up-symbol-server.md) diff --git a/docs-translations/ko/api/accelerator-ko.md b/docs-translations/ko/api/accelerator.md similarity index 100% rename from docs-translations/ko/api/accelerator-ko.md rename to docs-translations/ko/api/accelerator.md diff --git a/docs-translations/ko/api/auto-updater-ko.md b/docs-translations/ko/api/auto-updater.md similarity index 100% rename from docs-translations/ko/api/auto-updater-ko.md rename to docs-translations/ko/api/auto-updater.md diff --git a/docs-translations/ko/api/chrome-command-line-switches-ko.md b/docs-translations/ko/api/chrome-command-line-switches.md similarity index 97% rename from docs-translations/ko/api/chrome-command-line-switches-ko.md rename to docs-translations/ko/api/chrome-command-line-switches.md index 7d1a7011eff6..5b9bf4722042 100644 --- a/docs-translations/ko/api/chrome-command-line-switches-ko.md +++ b/docs-translations/ko/api/chrome-command-line-switches.md @@ -62,9 +62,9 @@ Hostname 맵핑 규칙을 설정합니다. (`,`로 분리) `--host-rules` 플래그와 비슷하지만 이 플래그는 host resolver에만 적용됩니다. -[app]: app-ko.md -[append-switch]: app-ko.md#appcommandlineappendswitchswitch-value -[ready]: app-ko.md#event-ready +[app]: app.md +[append-switch]: app.md#appcommandlineappendswitchswitch-value +[ready]: app.md#event-ready ## --ignore-certificate-errors diff --git a/docs-translations/ko/api/clipboard-ko.md b/docs-translations/ko/api/clipboard.md similarity index 94% rename from docs-translations/ko/api/clipboard-ko.md rename to docs-translations/ko/api/clipboard.md index bc6c82786cb7..a6b29c2a377f 100644 --- a/docs-translations/ko/api/clipboard-ko.md +++ b/docs-translations/ko/api/clipboard.md @@ -45,11 +45,11 @@ console.log(clipboard.readText('selection')); * `type` String -클립보드로부터 [NativeImage](native-image-ko.md)로 이미지를 읽어들입니다. +클립보드로부터 [NativeImage](native-image.md)로 이미지를 읽어들입니다. ## clipboard.writeImage(image[, type]) -* `image` [NativeImage](native-image-ko.md) +* `image` [NativeImage](native-image.md) * `type` String 클립보드에 `image`를 씁니다. diff --git a/docs-translations/ko/api/content-tracing-ko.md b/docs-translations/ko/api/content-tracing.md similarity index 100% rename from docs-translations/ko/api/content-tracing-ko.md rename to docs-translations/ko/api/content-tracing.md diff --git a/docs-translations/ko/api/crash-reporter-ko.md b/docs-translations/ko/api/crash-reporter.md similarity index 100% rename from docs-translations/ko/api/crash-reporter-ko.md rename to docs-translations/ko/api/crash-reporter.md diff --git a/docs-translations/ko/api/dialog-ko.md b/docs-translations/ko/api/dialog.md similarity index 99% rename from docs-translations/ko/api/dialog-ko.md rename to docs-translations/ko/api/dialog.md index 2f24c659f913..4f151f0b1ebb 100644 --- a/docs-translations/ko/api/dialog-ko.md +++ b/docs-translations/ko/api/dialog.md @@ -77,7 +77,7 @@ Windows와 Linux에선 파일 선택 모드, 디렉터리 선택 모드를 동 * `title` String - 대화 상자의 제목입니다. 몇몇 플랫폼에선 보이지 않을 수 있습니다. * `message` String - 대화 상자의 본문 내용입니다. * `detail` String - 메시지의 추가 정보입니다. - * `icon` [NativeImage](native-image-ko.md) + * `icon` [NativeImage](native-image.md) * `cancelId` Integer - 유저가 대화 상자의 버튼을 클릭하지 않고 대화 상자를 취소했을 때 반환되는 버튼의 index입니다. 기본적으로 버튼 리스트가 "cancel" 또는 "no" 라벨을 가지고 있을 때 해당 버튼의 index를 반환합니다. 따로 두 라벨이 지정되지 않은 경우 0을 반환합니다. OS X와 Windows에선 `cancelId` 지정 여부에 상관없이 "Cancel" 버튼이 언제나 `cancelId`로 지정됩니다. diff --git a/docs-translations/ko/api/file-object-ko.md b/docs-translations/ko/api/file-object.md similarity index 100% rename from docs-translations/ko/api/file-object-ko.md rename to docs-translations/ko/api/file-object.md diff --git a/docs-translations/ko/api/frameless-window-ko.md b/docs-translations/ko/api/frameless-window.md similarity index 97% rename from docs-translations/ko/api/frameless-window-ko.md rename to docs-translations/ko/api/frameless-window.md index 420b277d9b17..3dc45b824fd1 100644 --- a/docs-translations/ko/api/frameless-window-ko.md +++ b/docs-translations/ko/api/frameless-window.md @@ -4,7 +4,7 @@ Frameless 윈도우는 테두리가 없는 윈도우 창을 말합니다. ## Frameless 윈도우 만들기 -Frameless 윈도우를 만드려면 [BrowserWindow](browser-window-ko.md) 객체의 `options`에서 `frame` 옵션을 `false`로 지정하기만 하면됩니다: +Frameless 윈도우를 만드려면 [BrowserWindow](browser-window.md) 객체의 `options`에서 `frame` 옵션을 `false`로 지정하기만 하면됩니다: ```javascript var BrowserWindow = require('browser-window'); diff --git a/docs-translations/ko/api/global-shortcut-ko.md b/docs-translations/ko/api/global-shortcut.md similarity index 92% rename from docs-translations/ko/api/global-shortcut-ko.md rename to docs-translations/ko/api/global-shortcut.md index 25c1d320870e..d99085f448e5 100644 --- a/docs-translations/ko/api/global-shortcut-ko.md +++ b/docs-translations/ko/api/global-shortcut.md @@ -32,20 +32,20 @@ app.on('will-quit', function() { ## globalShortcut.register(accelerator, callback) -* `accelerator` [Accelerator](accelerator-ko.md) +* `accelerator` [Accelerator](accelerator.md) * `callback` Function `accelerator`로 표현된 전역 단축키를 등록합니다. 유저로부터 등록된 단축키가 눌렸을 경우 `callback` 함수가 호출됩니다. ## globalShortcut.isRegistered(accelerator) -* `accelerator` [Accelerator](accelerator-ko.md) +* `accelerator` [Accelerator](accelerator.md) 지정된 `accelerator` 단축키가 등록되었는지 여부를 확인합니다. 반환값은 boolean(true, false) 입니다. ## globalShortcut.unregister(accelerator) -* `accelerator` [Accelerator](accelerator-ko.md) +* `accelerator` [Accelerator](accelerator.md) `키코드`에 해당하는 전역 단축키를 등록 해제합니다. diff --git a/docs-translations/ko/api/ipc-main-process-ko.md b/docs-translations/ko/api/ipc-main-process.md similarity index 92% rename from docs-translations/ko/api/ipc-main-process-ko.md rename to docs-translations/ko/api/ipc-main-process.md index 7d0aba08efa5..7f6a091de46d 100644 --- a/docs-translations/ko/api/ipc-main-process-ko.md +++ b/docs-translations/ko/api/ipc-main-process.md @@ -6,7 +6,7 @@ 동기 메시지는 `event.returnValue`를 이용하여 반환값(답장)을 설정할 수 있습니다. 비동기 메시지라면 `event.sender.send(...)`를 사용하면 됩니다. 또한 메인 프로세스에서 랜더러 프로세스로 메시지를 보내는 것도 가능합니다. -자세한 내용은 [WebContents.send](browser-window-ko.md#webcontentssendchannel-args)를 참고 하세요. +자세한 내용은 [WebContents.send](browser-window.md#webcontentssendchannel-args)를 참고 하세요. 보내진 메시지들을 처리하는 예제입니다: diff --git a/docs-translations/ko/api/ipc-renderer-ko.md b/docs-translations/ko/api/ipc-renderer.md similarity index 85% rename from docs-translations/ko/api/ipc-renderer-ko.md rename to docs-translations/ko/api/ipc-renderer.md index e4664480447f..b8bbb7ffa14d 100644 --- a/docs-translations/ko/api/ipc-renderer-ko.md +++ b/docs-translations/ko/api/ipc-renderer.md @@ -1,9 +1,9 @@ # ipc (renderer) `ipc` 모듈은 메인 프로세스로 메시지를 동기 또는 비동기로 보내고 받을 수 있는 몇 가지 방법을 제공합니다. -만약 랜더러 프로세스에서 메인 프로세스의 모듈을 직접적으로 사용하고 싶다면 [remote](remote-ko.md) 모듈을 사용하는 것을 고려해보는 것이 좋습니다. +만약 랜더러 프로세스에서 메인 프로세스의 모듈을 직접적으로 사용하고 싶다면 [remote](remote.md) 모듈을 사용하는 것을 고려해보는 것이 좋습니다. -[ipc (main process)](ipc-main-process-ko.md)에서 예제를 볼 수 있습니다. +[ipc (main process)](ipc-main-process.md)에서 예제를 볼 수 있습니다. ## ipc.send(channel[, args...]) diff --git a/docs-translations/ko/api/menu-item-ko.md b/docs-translations/ko/api/menu-item.md similarity index 90% rename from docs-translations/ko/api/menu-item-ko.md rename to docs-translations/ko/api/menu-item.md index 8477451ff965..519b7fb237a3 100644 --- a/docs-translations/ko/api/menu-item-ko.md +++ b/docs-translations/ko/api/menu-item.md @@ -10,8 +10,8 @@ * `type` String - `MenuItem`의 타입 `normal`, `separator`, `submenu`, `checkbox` 또는 `radio` 사용가능 * `label` String * `sublabel` String - * `accelerator` [Accelerator](accelerator-ko.md) - * `icon` [NativeImage](native-image-ko.md) + * `accelerator` [Accelerator](accelerator.md) + * `icon` [NativeImage](native-image.md) * `enabled` Boolean * `visible` Boolean * `checked` Boolean diff --git a/docs-translations/ko/api/menu-ko.md b/docs-translations/ko/api/menu.md similarity index 95% rename from docs-translations/ko/api/menu-ko.md rename to docs-translations/ko/api/menu.md index 7f2b5ad90c80..3303a55d05f2 100644 --- a/docs-translations/ko/api/menu-ko.md +++ b/docs-translations/ko/api/menu.md @@ -3,7 +3,7 @@ `Menu` 클래스는 어플리케이션 메뉴와 컨텍스트 메뉴를 만들 때 사용됩니다. 메뉴는 여러 개의 메뉴 아이템으로 구성되고 서브 메뉴를 가질 수도 있습니다. -다음 예제는 웹 페이지 내에서 [remote](remote-ko.md) 모듈을 활용하여 동적으로 메뉴를 생성하는 예제입니다. +다음 예제는 웹 페이지 내에서 [remote](remote.md) 모듈을 활용하여 동적으로 메뉴를 생성하는 예제입니다. 이 예제에서 만들어진 메뉴는 유저가 페이지에서 오른쪽 클릭을 할 때 마우스 위치에 팝업 형태로 표시됩니다: @@ -28,7 +28,7 @@ window.addEventListener('contextmenu', function (e) { 다음 예제는 template API를 활용하여 어플리케이션 메뉴를 만드는 간단한 예제입니다: -**Windows 와 Linux 유저 주의:** 각 메뉴 아이템의 `selector` 멤버는 Mac 운영체제 전용입니다. [Accelerator 옵션](https://github.com/atom/electron/blob/master/docs/api/accelerator-ko.md) +**Windows 와 Linux 유저 주의:** 각 메뉴 아이템의 `selector` 멤버는 Mac 운영체제 전용입니다. [Accelerator 옵션](accelerator.md) ```html @@ -189,7 +189,7 @@ Menu.setApplicationMenu(menu); * `template` Array -기본적으로 `template`는 [MenuItem](menu-item-ko.md)을 생성할 때 사용하는 `options`의 배열입니다. 사용법은 위에서 설명한 것과 같습니다. +기본적으로 `template`는 [MenuItem](menu-item.md)을 생성할 때 사용하는 `options`의 배열입니다. 사용법은 위에서 설명한 것과 같습니다. 또한 `template`에는 다른 속성도 추가할 수 있으며 메뉴가 만들어질 때 해당 메뉴 아이템의 프로퍼티로 변환됩니다. diff --git a/docs-translations/ko/api/native-image-ko.md b/docs-translations/ko/api/native-image.md similarity index 100% rename from docs-translations/ko/api/native-image-ko.md rename to docs-translations/ko/api/native-image.md diff --git a/docs-translations/ko/api/power-monitor-ko.md b/docs-translations/ko/api/power-monitor.md similarity index 100% rename from docs-translations/ko/api/power-monitor-ko.md rename to docs-translations/ko/api/power-monitor.md diff --git a/docs-translations/ko/api/power-save-blocker-ko.md b/docs-translations/ko/api/power-save-blocker.md similarity index 100% rename from docs-translations/ko/api/power-save-blocker-ko.md rename to docs-translations/ko/api/power-save-blocker.md diff --git a/docs-translations/ko/api/process-ko.md b/docs-translations/ko/api/process.md similarity index 100% rename from docs-translations/ko/api/process-ko.md rename to docs-translations/ko/api/process.md diff --git a/docs-translations/ko/api/protocol-ko.md b/docs-translations/ko/api/protocol.md similarity index 100% rename from docs-translations/ko/api/protocol-ko.md rename to docs-translations/ko/api/protocol.md diff --git a/docs-translations/ko/api/remote-ko.md b/docs-translations/ko/api/remote.md similarity index 99% rename from docs-translations/ko/api/remote-ko.md rename to docs-translations/ko/api/remote.md index 64232bdc31af..c2713db4a910 100644 --- a/docs-translations/ko/api/remote-ko.md +++ b/docs-translations/ko/api/remote.md @@ -70,7 +70,7 @@ remote.getCurrentWindow().on('close', function() { ## remote.getCurrentWindow() -현재 웹 페이지가 들어있는 [BrowserWindow](browser-window-ko.md) 객체를 반환합니다. +현재 웹 페이지가 들어있는 [BrowserWindow](browser-window.md) 객체를 반환합니다. ## remote.getCurrentWebContents() diff --git a/docs-translations/ko/api/screen-ko.md b/docs-translations/ko/api/screen.md similarity index 100% rename from docs-translations/ko/api/screen-ko.md rename to docs-translations/ko/api/screen.md diff --git a/docs-translations/ko/api/shell-ko.md b/docs-translations/ko/api/shell.md similarity index 100% rename from docs-translations/ko/api/shell-ko.md rename to docs-translations/ko/api/shell.md diff --git a/docs-translations/ko/api/synopsis-ko.md b/docs-translations/ko/api/synopsis.md similarity index 81% rename from docs-translations/ko/api/synopsis-ko.md rename to docs-translations/ko/api/synopsis.md index 8754f2f15bf2..69ee4af354c7 100644 --- a/docs-translations/ko/api/synopsis-ko.md +++ b/docs-translations/ko/api/synopsis.md @@ -1,11 +1,11 @@ # 개요 -Electron은 모든 [node.js's built-in 모듈](http://nodejs.org/api/)과 third-party node 모듈을 완벽하게 지원합니다. ([네이티브 모듈](../tutorial/using-native-node-modules-ko.md)을 포함해서) +Electron은 모든 [node.js's built-in 모듈](http://nodejs.org/api/)과 third-party node 모듈을 완벽하게 지원합니다. ([네이티브 모듈](../tutorial/using-native-node-modules.md)을 포함해서) Electron은 네이티브 데스크톱 어플리케이션을 개발 할 수 있도록 추가적인 built-in 모듈을 제공합니다. 몇몇 모듈은 메인 프로세스에서만 사용할 수 있고 어떤 모듈은 랜더러 프로세스에서만 사용할 수 있습니다. 또한 두 프로세스 모두 사용할 수 있는 모듈도 있습니다. 기본적인 규칙은 다음과 같습니다: GUI와 저 수준 시스템에 관련된 모듈은 오직 메인 프로세스에서만 사용할 수 있습니다. -[메인 프로세스 vs. 랜더러 프로세스](../tutorial/quick-start-ko.md#메인 프로세스) 컨셉에 익숙해야 이 모듈들을 사용하기 쉬우므로 해당 문서를 정독하는 것을 권장합니다. +[메인 프로세스 vs. 랜더러 프로세스](../tutorial/quick-start.md#메인 프로세스) 컨셉에 익숙해야 이 모듈들을 사용하기 쉬우므로 해당 문서를 정독하는 것을 권장합니다. 메인 프로세스 스크립트는 일반 `node.js` 스크립트와 같습니다: @@ -36,4 +36,4 @@ app.on('ready', function() { ``` -어플리케이션을 실행하려면 [앱 실행하기](../tutorial/quick-start-ko.md#앱 실행하기) 문서를 참고하기 바랍니다. +어플리케이션을 실행하려면 [앱 실행하기](../tutorial/quick-start.md#앱 실행하기) 문서를 참고하기 바랍니다. diff --git a/docs-translations/ko/api/tray-ko.md b/docs-translations/ko/api/tray.md similarity index 96% rename from docs-translations/ko/api/tray-ko.md rename to docs-translations/ko/api/tray.md index a32ccbb1d0e2..05decef5a48f 100644 --- a/docs-translations/ko/api/tray-ko.md +++ b/docs-translations/ko/api/tray.md @@ -38,7 +38,7 @@ __플랫폼별 한계:__ ### new Tray(image) -* `image` [NativeImage](native-image-ko.md) +* `image` [NativeImage](native-image.md) 전달된 `image`를 이용하여 트레이 아이콘을 만듭니다. @@ -126,13 +126,13 @@ __주의:__ 이 기능은 OS X에서만 작동합니다. ### Tray.setImage(image) -* `image` [NativeImage](native-image-ko.md) +* `image` [NativeImage](native-image.md) `image`를 사용하여 트레이 아이콘의 이미지를 설정합니다. ### Tray.setPressedImage(image) -* `image` [NativeImage](native-image-ko.md) +* `image` [NativeImage](native-image.md) `image`를 사용하여 트레이 아이콘이 눌렸을 때의 이미지를 설정합니다. @@ -163,7 +163,7 @@ __주의:__ 이 기능은 OS X에서만 작동합니다. ### Tray.displayBalloon(options) * `options` Object - * `icon` [NativeImage](native-image-ko.md) + * `icon` [NativeImage](native-image.md) * `title` String * `content` String diff --git a/docs-translations/ko/api/web-frame-ko.md b/docs-translations/ko/api/web-frame.md similarity index 100% rename from docs-translations/ko/api/web-frame-ko.md rename to docs-translations/ko/api/web-frame.md diff --git a/docs-translations/ko/api/web-view-tag-ko.md b/docs-translations/ko/api/web-view-tag.md similarity index 99% rename from docs-translations/ko/api/web-view-tag-ko.md rename to docs-translations/ko/api/web-view-tag.md index 32a5a835516f..d2efdf17ea1f 100644 --- a/docs-translations/ko/api/web-view-tag-ko.md +++ b/docs-translations/ko/api/web-view-tag.md @@ -311,7 +311,7 @@ Webview 페이지를 PDF 형식으로 인쇄합니다. `webContents.printToPDF(o `channel`을 통해 게스트 페이지에 `args...` 비동기 메시지를 보냅니다. 게스트 페이지에선 `ipc` 모듈의 `channel` 이벤트를 사용하면 이 메시지를 받을 수 있습니다. -예제는 [WebContents.send](browser-window-ko.md#webcontentssendchannel-args)를 참고하세요. +예제는 [WebContents.send](browser-window.md#webcontentssendchannel-args)를 참고하세요. ## DOM 이벤트 diff --git a/docs-translations/ko/api/window-open-ko.md b/docs-translations/ko/api/window-open.md similarity index 100% rename from docs-translations/ko/api/window-open-ko.md rename to docs-translations/ko/api/window-open.md diff --git a/docs-translations/ko/development/atom-shell-vs-node-webkit-ko.md b/docs-translations/ko/development/atom-shell-vs-node-webkit.md similarity index 100% rename from docs-translations/ko/development/atom-shell-vs-node-webkit-ko.md rename to docs-translations/ko/development/atom-shell-vs-node-webkit.md diff --git a/docs-translations/ko/development/build-instructions-linux-ko.md b/docs-translations/ko/development/build-instructions-linux.md similarity index 100% rename from docs-translations/ko/development/build-instructions-linux-ko.md rename to docs-translations/ko/development/build-instructions-linux.md diff --git a/docs-translations/ko/development/build-instructions-mac-ko.md b/docs-translations/ko/development/build-instructions-mac.md similarity index 100% rename from docs-translations/ko/development/build-instructions-mac-ko.md rename to docs-translations/ko/development/build-instructions-mac.md diff --git a/docs-translations/ko/development/build-instructions-windows-ko.md b/docs-translations/ko/development/build-instructions-windows.md similarity index 100% rename from docs-translations/ko/development/build-instructions-windows-ko.md rename to docs-translations/ko/development/build-instructions-windows.md diff --git a/docs-translations/ko/development/build-system-overview-ko.md b/docs-translations/ko/development/build-system-overview.md similarity index 100% rename from docs-translations/ko/development/build-system-overview-ko.md rename to docs-translations/ko/development/build-system-overview.md diff --git a/docs-translations/ko/development/coding-style-ko.md b/docs-translations/ko/development/coding-style.md similarity index 100% rename from docs-translations/ko/development/coding-style-ko.md rename to docs-translations/ko/development/coding-style.md diff --git a/docs-translations/ko/development/setting-up-symbol-server-ko.md b/docs-translations/ko/development/setting-up-symbol-server.md similarity index 100% rename from docs-translations/ko/development/setting-up-symbol-server-ko.md rename to docs-translations/ko/development/setting-up-symbol-server.md diff --git a/docs-translations/ko/development/source-code-directory-structure-ko.md b/docs-translations/ko/development/source-code-directory-structure.md similarity index 100% rename from docs-translations/ko/development/source-code-directory-structure-ko.md rename to docs-translations/ko/development/source-code-directory-structure.md diff --git a/docs-translations/ko/tutorial/application-distribution-ko.md b/docs-translations/ko/tutorial/application-distribution.md similarity index 99% rename from docs-translations/ko/tutorial/application-distribution-ko.md rename to docs-translations/ko/tutorial/application-distribution.md index 043ced1ec47c..fac2ae48a140 100644 --- a/docs-translations/ko/tutorial/application-distribution-ko.md +++ b/docs-translations/ko/tutorial/application-distribution.md @@ -48,7 +48,7 @@ electron/resources/ └── app.asar ``` -자세한 내용은 [어플리케이션 패키징](application-packaging-ko.md)에서 찾아볼 수 있습니다. +자세한 내용은 [어플리케이션 패키징](application-packaging.md)에서 찾아볼 수 있습니다. ## 다운로드한 바이너리의 리소스를 앱에 맞게 수정하기 diff --git a/docs-translations/ko/tutorial/application-packaging-ko.md b/docs-translations/ko/tutorial/application-packaging.md similarity index 100% rename from docs-translations/ko/tutorial/application-packaging-ko.md rename to docs-translations/ko/tutorial/application-packaging.md diff --git a/docs-translations/ko/tutorial/debugging-main-process-ko.md b/docs-translations/ko/tutorial/debugging-main-process.md similarity index 100% rename from docs-translations/ko/tutorial/debugging-main-process-ko.md rename to docs-translations/ko/tutorial/debugging-main-process.md diff --git a/docs-translations/ko/tutorial/desktop-environment-integration-ko.md b/docs-translations/ko/tutorial/desktop-environment-integration.md similarity index 95% rename from docs-translations/ko/tutorial/desktop-environment-integration-ko.md rename to docs-translations/ko/tutorial/desktop-environment-integration.md index 68f5562dbb52..9d1b5ffadcc4 100644 --- a/docs-translations/ko/tutorial/desktop-environment-integration-ko.md +++ b/docs-translations/ko/tutorial/desktop-environment-integration.md @@ -211,12 +211,12 @@ window.setRepresentedFilename('/etc/passwd'); window.setDocumentEdited(true); ``` -[addrecentdocument]: ../api/app-ko.md#appaddrecentdocumentpath -[clearrecentdocuments]: ../api/app-ko.md#appclearrecentdocuments -[setusertaskstasks]: ../api/app-ko.md#appsetusertaskstasks -[setprogressbar]: ../api/browser-window-ko.md#browserwindowsetprogressbarprogress -[setrepresentedfilename]: ../api/browser-window-ko.md#browserwindowsetrepresentedfilenamefilename -[setdocumentedited]: ../api/browser-window-ko.md#browserwindowsetdocumenteditededited +[addrecentdocument]: ../api/app.md#appaddrecentdocumentpath +[clearrecentdocuments]: ../api/app.md#appclearrecentdocuments +[setusertaskstasks]: ../api/app.md#appsetusertaskstasks +[setprogressbar]: ../api/browser-window.md#browserwindowsetprogressbarprogress +[setrepresentedfilename]: ../api/browser-window.md#browserwindowsetrepresentedfilenamefilename +[setdocumentedited]: ../api/browser-window.md#browserwindowsetdocumenteditededited [app-registration]: http://msdn.microsoft.com/en-us/library/windows/desktop/ee872121(v=vs.85).aspx [unity-launcher]: https://help.ubuntu.com/community/UnityLaunchersAndDesktopFiles#Adding_shortcuts_to_a_launcher [setthumbarbuttons]: ../api/browser-window.md#browserwindowsetthumbarbuttonsbuttons diff --git a/docs-translations/ko/tutorial/devtools-extension-ko.md b/docs-translations/ko/tutorial/devtools-extension.md similarity index 100% rename from docs-translations/ko/tutorial/devtools-extension-ko.md rename to docs-translations/ko/tutorial/devtools-extension.md diff --git a/docs-translations/ko/tutorial/online-offline-events-ko.md b/docs-translations/ko/tutorial/online-offline-events.md similarity index 100% rename from docs-translations/ko/tutorial/online-offline-events-ko.md rename to docs-translations/ko/tutorial/online-offline-events.md diff --git a/docs-translations/ko/tutorial/quick-start-ko.md b/docs-translations/ko/tutorial/quick-start.md similarity index 92% rename from docs-translations/ko/tutorial/quick-start-ko.md rename to docs-translations/ko/tutorial/quick-start.md index 1d548c6f01c0..7564f1c8c4c9 100644 --- a/docs-translations/ko/tutorial/quick-start-ko.md +++ b/docs-translations/ko/tutorial/quick-start.md @@ -33,8 +33,8 @@ Electron 프로세스 내에서 작동하는 웹 페이지는 __랜더러 프로 기본적으로 웹 페이지 내에서는 네이티브 GUI와 관련된 API를 호출할 수 없도록 되어 있습니다. 만약 웹 페이지 내에서 GUI작업이 필요하다면 메인 프로세스에서 그 작업을 할 수 있도록 메인 프로세스와 통신을 해야합니다. -Electron에는 메인 프로세스와 랜더러 프로세스간에 통신을 할 수 있도록 [ipc](../api/ipc-renderer-ko.md) 모듈을 제공하고 있습니다. -또한 [remote](../api/remote-ko.md) 모듈을 사용하여 RPC 스타일로 통신할 수도 있습니다. +Electron에는 메인 프로세스와 랜더러 프로세스간에 통신을 할 수 있도록 [ipc](../api/ipc-renderer.md) 모듈을 제공하고 있습니다. +또한 [remote](../api/remote.md) 모듈을 사용하여 RPC 스타일로 통신할 수도 있습니다. ## 첫번째 Electron 앱 만들기 @@ -121,7 +121,7 @@ app.on('ready', function() { ## 앱 실행하기 -앱을 작성한 후 [어플리케이션 배포](./application-distribution-ko.md) 가이드를 따라 앱을 패키징 하고 패키징한 앱을 실행할 수 있습니다. +앱을 작성한 후 [어플리케이션 배포](application-distribution.md) 가이드를 따라 앱을 패키징 하고 패키징한 앱을 실행할 수 있습니다. 또는 Electron 실행파일을 다운로드 받아 바로 실행해 볼 수도 있습니다. ### electron-prebuilt @@ -173,4 +173,4 @@ $ ./Electron.app/Contents/MacOS/Electron your-app/ ### 배포용 파일 만들기 -어플리케이션 작성을 완료했다면 [어플리케이션 배포](./application-distribution-ko.md) 가이드를 통해 본격적으로 제작한 앱을 배포할 수 있습니다. \ No newline at end of file +어플리케이션 작성을 완료했다면 [어플리케이션 배포](application-distribution.md) 가이드를 통해 본격적으로 제작한 앱을 배포할 수 있습니다. \ No newline at end of file diff --git a/docs-translations/ko/tutorial/using-native-node-modules-ko.md b/docs-translations/ko/tutorial/using-native-node-modules.md similarity index 100% rename from docs-translations/ko/tutorial/using-native-node-modules-ko.md rename to docs-translations/ko/tutorial/using-native-node-modules.md diff --git a/docs-translations/ko/tutorial/using-pepper-flash-plugin-ko.md b/docs-translations/ko/tutorial/using-pepper-flash-plugin.md similarity index 100% rename from docs-translations/ko/tutorial/using-pepper-flash-plugin-ko.md rename to docs-translations/ko/tutorial/using-pepper-flash-plugin.md diff --git a/docs-translations/ko/tutorial/using-selenium-and-webdriver-ko.md b/docs-translations/ko/tutorial/using-selenium-and-webdriver.md similarity index 95% rename from docs-translations/ko/tutorial/using-selenium-and-webdriver-ko.md rename to docs-translations/ko/tutorial/using-selenium-and-webdriver.md index 80b56e23ada1..069a49e52798 100644 --- a/docs-translations/ko/tutorial/using-selenium-and-webdriver-ko.md +++ b/docs-translations/ko/tutorial/using-selenium-and-webdriver.md @@ -69,6 +69,6 @@ driver.quit(); ## 작업환경 따로 Electron을 다시 빌드하지 않는 경우 간단히 어플리케이션을 Electron의 리소스 디렉터리에 -[배치](https://github.com/atom/electron/blob/master/docs/tutorial/application-distribution-ko.md)하여 바로 테스트 할 수 있습니다. +[배치](application-distribution.md)하여 바로 테스트 할 수 있습니다. [chrome-driver]: https://sites.google.com/a/chromium.org/chromedriver/ diff --git a/vendor/node b/vendor/node index 205b013ac86e..902090af5375 160000 --- a/vendor/node +++ b/vendor/node @@ -1 +1 @@ -Subproject commit 205b013ac86e5500678a791cd54f305580fa4f4b +Subproject commit 902090af5375e497dded310575f19de5328a9bbc From ecb162575680f501072a313fdb5e3baaf9e93b1f Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Tue, 25 Aug 2015 22:17:24 +0900 Subject: [PATCH 0950/1293] Revert "Rename xx-ko.md to xx.md" This reverts commit 638bb9b0b16f24537f0af8059fe21eb7183d1e54. --- docs-translations/ko/README-ko.md | 68 +++++++++++++++++++ docs-translations/ko/README.md | 68 ------------------- .../api/{accelerator.md => accelerator-ko.md} | 0 .../{auto-updater.md => auto-updater-ko.md} | 0 ....md => chrome-command-line-switches-ko.md} | 6 +- .../ko/api/{clipboard.md => clipboard-ko.md} | 4 +- ...ntent-tracing.md => content-tracing-ko.md} | 0 ...crash-reporter.md => crash-reporter-ko.md} | 0 .../ko/api/{dialog.md => dialog-ko.md} | 2 +- .../api/{file-object.md => file-object-ko.md} | 0 ...eless-window.md => frameless-window-ko.md} | 2 +- ...obal-shortcut.md => global-shortcut-ko.md} | 6 +- ...main-process.md => ipc-main-process-ko.md} | 2 +- .../{ipc-renderer.md => ipc-renderer-ko.md} | 4 +- .../ko/api/{menu-item.md => menu-item-ko.md} | 4 +- .../ko/api/{menu.md => menu-ko.md} | 6 +- .../{native-image.md => native-image-ko.md} | 0 .../{power-monitor.md => power-monitor-ko.md} | 0 ...ve-blocker.md => power-save-blocker-ko.md} | 0 .../ko/api/{process.md => process-ko.md} | 0 .../ko/api/{protocol.md => protocol-ko.md} | 0 .../ko/api/{remote.md => remote-ko.md} | 2 +- .../ko/api/{screen.md => screen-ko.md} | 0 .../ko/api/{shell.md => shell-ko.md} | 0 .../ko/api/{synopsis.md => synopsis-ko.md} | 6 +- .../ko/api/{tray.md => tray-ko.md} | 8 +-- .../ko/api/{web-frame.md => web-frame-ko.md} | 0 .../{web-view-tag.md => web-view-tag-ko.md} | 2 +- .../api/{window-open.md => window-open-ko.md} | 0 ...kit.md => atom-shell-vs-node-webkit-ko.md} | 0 ...inux.md => build-instructions-linux-ko.md} | 0 ...ns-mac.md => build-instructions-mac-ko.md} | 0 ...ws.md => build-instructions-windows-ko.md} | 0 ...verview.md => build-system-overview-ko.md} | 0 .../{coding-style.md => coding-style-ko.md} | 0 ...rver.md => setting-up-symbol-server-ko.md} | 0 ... => source-code-directory-structure-ko.md} | 0 ...tion.md => application-distribution-ko.md} | 2 +- ...ckaging.md => application-packaging-ko.md} | 0 ...rocess.md => debugging-main-process-ko.md} | 0 ... => desktop-environment-integration-ko.md} | 12 ++-- ...-extension.md => devtools-extension-ko.md} | 0 ...-events.md => online-offline-events-ko.md} | 0 .../{quick-start.md => quick-start-ko.md} | 8 +-- ...les.md => using-native-node-modules-ko.md} | 0 ...gin.md => using-pepper-flash-plugin-ko.md} | 0 ....md => using-selenium-and-webdriver-ko.md} | 2 +- vendor/node | 2 +- 48 files changed, 108 insertions(+), 108 deletions(-) create mode 100644 docs-translations/ko/README-ko.md delete mode 100644 docs-translations/ko/README.md rename docs-translations/ko/api/{accelerator.md => accelerator-ko.md} (100%) rename docs-translations/ko/api/{auto-updater.md => auto-updater-ko.md} (100%) rename docs-translations/ko/api/{chrome-command-line-switches.md => chrome-command-line-switches-ko.md} (97%) rename docs-translations/ko/api/{clipboard.md => clipboard-ko.md} (94%) rename docs-translations/ko/api/{content-tracing.md => content-tracing-ko.md} (100%) rename docs-translations/ko/api/{crash-reporter.md => crash-reporter-ko.md} (100%) rename docs-translations/ko/api/{dialog.md => dialog-ko.md} (99%) rename docs-translations/ko/api/{file-object.md => file-object-ko.md} (100%) rename docs-translations/ko/api/{frameless-window.md => frameless-window-ko.md} (97%) rename docs-translations/ko/api/{global-shortcut.md => global-shortcut-ko.md} (92%) rename docs-translations/ko/api/{ipc-main-process.md => ipc-main-process-ko.md} (92%) rename docs-translations/ko/api/{ipc-renderer.md => ipc-renderer-ko.md} (85%) rename docs-translations/ko/api/{menu-item.md => menu-item-ko.md} (90%) rename docs-translations/ko/api/{menu.md => menu-ko.md} (95%) rename docs-translations/ko/api/{native-image.md => native-image-ko.md} (100%) rename docs-translations/ko/api/{power-monitor.md => power-monitor-ko.md} (100%) rename docs-translations/ko/api/{power-save-blocker.md => power-save-blocker-ko.md} (100%) rename docs-translations/ko/api/{process.md => process-ko.md} (100%) rename docs-translations/ko/api/{protocol.md => protocol-ko.md} (100%) rename docs-translations/ko/api/{remote.md => remote-ko.md} (99%) rename docs-translations/ko/api/{screen.md => screen-ko.md} (100%) rename docs-translations/ko/api/{shell.md => shell-ko.md} (100%) rename docs-translations/ko/api/{synopsis.md => synopsis-ko.md} (81%) rename docs-translations/ko/api/{tray.md => tray-ko.md} (96%) rename docs-translations/ko/api/{web-frame.md => web-frame-ko.md} (100%) rename docs-translations/ko/api/{web-view-tag.md => web-view-tag-ko.md} (99%) rename docs-translations/ko/api/{window-open.md => window-open-ko.md} (100%) rename docs-translations/ko/development/{atom-shell-vs-node-webkit.md => atom-shell-vs-node-webkit-ko.md} (100%) rename docs-translations/ko/development/{build-instructions-linux.md => build-instructions-linux-ko.md} (100%) rename docs-translations/ko/development/{build-instructions-mac.md => build-instructions-mac-ko.md} (100%) rename docs-translations/ko/development/{build-instructions-windows.md => build-instructions-windows-ko.md} (100%) rename docs-translations/ko/development/{build-system-overview.md => build-system-overview-ko.md} (100%) rename docs-translations/ko/development/{coding-style.md => coding-style-ko.md} (100%) rename docs-translations/ko/development/{setting-up-symbol-server.md => setting-up-symbol-server-ko.md} (100%) rename docs-translations/ko/development/{source-code-directory-structure.md => source-code-directory-structure-ko.md} (100%) rename docs-translations/ko/tutorial/{application-distribution.md => application-distribution-ko.md} (99%) rename docs-translations/ko/tutorial/{application-packaging.md => application-packaging-ko.md} (100%) rename docs-translations/ko/tutorial/{debugging-main-process.md => debugging-main-process-ko.md} (100%) rename docs-translations/ko/tutorial/{desktop-environment-integration.md => desktop-environment-integration-ko.md} (95%) rename docs-translations/ko/tutorial/{devtools-extension.md => devtools-extension-ko.md} (100%) rename docs-translations/ko/tutorial/{online-offline-events.md => online-offline-events-ko.md} (100%) rename docs-translations/ko/tutorial/{quick-start.md => quick-start-ko.md} (92%) rename docs-translations/ko/tutorial/{using-native-node-modules.md => using-native-node-modules-ko.md} (100%) rename docs-translations/ko/tutorial/{using-pepper-flash-plugin.md => using-pepper-flash-plugin-ko.md} (100%) rename docs-translations/ko/tutorial/{using-selenium-and-webdriver.md => using-selenium-and-webdriver-ko.md} (95%) diff --git a/docs-translations/ko/README-ko.md b/docs-translations/ko/README-ko.md new file mode 100644 index 000000000000..b48c6a42c516 --- /dev/null +++ b/docs-translations/ko/README-ko.md @@ -0,0 +1,68 @@ +## 개발 가이드 + +* [어플리케이션 배포](tutorial/application-distribution-ko.md) +* [어플리케이션 패키징](tutorial/application-packaging-ko.md) +* [네이티브 node 모듈 사용하기](tutorial/using-native-node-modules-ko.md) +* [메인 프로세스 디버깅하기](tutorial/debugging-main-process-ko.md) +* [Selenium 과 WebDriver 사용하기](tutorial/using-selenium-and-webdriver-ko.md) +* [개발자 콘솔 확장기능](tutorial/devtools-extension-ko.md) +* [Pepper 플래시 플러그인 사용하기](tutorial/using-pepper-flash-plugin-ko.md) + +## 튜토리얼 + +* [시작하기](tutorial/quick-start-ko.md) +* [데스크톱 환경 통합](tutorial/desktop-environment-integration-ko.md) +* [온라인/오프라인 이벤트](tutorial/online-offline-events-ko.md) + +## API 레퍼런스 + +* [개요](api/synopsis-ko.md) +* [프로세스 객체](api/process-ko.md) +* [크롬 Command-Line 스위치 지원](api/chrome-command-line-switches-ko.md) + +커스텀 DOM Element: + +* [`File` 객체](api/file-object-ko.md) +* [`` 태그](api/web-view-tag-ko.md) +* [`window.open` 함수](api/window-open-ko.md) + +메인 프로세스를 위한 모듈들: + +* [app](api/app-ko.md) +* [auto-updater](api/auto-updater-ko.md) +* [browser-window](api/browser-window-ko.md) +* [content-tracing](api/content-tracing-ko.md) +* [dialog](api/dialog-ko.md) +* [global-shortcut](api/global-shortcut-ko.md) +* [ipc (main process)](api/ipc-main-process-ko.md) +* [menu](api/menu-ko.md) +* [menu-item](api/menu-item-ko.md) +* [power-monitor](api/power-monitor-ko.md) +* [power-save-blocker](api/power-save-blocker-ko.md) +* [protocol](api/protocol-ko.md) +* [tray](api/tray-ko.md) + +랜더러 프로세스를 위한 모듈들 (웹 페이지): + +* [ipc (renderer)](api/ipc-renderer-ko.md) +* [remote](api/remote-ko.md) +* [web-frame](api/web-frame-ko.md) + +두 프로세스에서 모두 사용 가능한 모듈들: + +* [clipboard](api/clipboard-ko.md) +* [crash-reporter](api/crash-reporter-ko.md) +* [native-image](api/native-image-ko.md) +* [screen](api/screen-ko.md) +* [shell](api/shell-ko.md) + +## 개발자용 + +* [코딩 스타일](development/coding-style-ko.md) +* [소스 코드 디렉터리 구조](development/source-code-directory-structure-ko.md) +* [NW.js와 기술적으로 다른점 (이전 node-webkit)](development/atom-shell-vs-node-webkit-ko.md) +* [빌드 시스템 개요](development/build-system-overview-ko.md) +* [빌드 설명서 (Mac)](development/build-instructions-mac-ko.md) +* [빌드 설명서 (Windows)](development/build-instructions-windows-ko.md) +* [빌드 설명서 (Linux)](development/build-instructions-linux-ko.md) +* [디버거에서 디버그 심볼 서버 설정](development/setting-up-symbol-server-ko.md) diff --git a/docs-translations/ko/README.md b/docs-translations/ko/README.md deleted file mode 100644 index 51bf0a36d07f..000000000000 --- a/docs-translations/ko/README.md +++ /dev/null @@ -1,68 +0,0 @@ -## 개발 가이드 - -* [어플리케이션 배포](tutorial/application-distribution.md) -* [어플리케이션 패키징](tutorial/application-packaging.md) -* [네이티브 node 모듈 사용하기](tutorial/using-native-node-modules.md) -* [메인 프로세스 디버깅하기](tutorial/debugging-main-process.md) -* [Selenium 과 WebDriver 사용하기](tutorial/using-selenium-and-webdriver.md) -* [개발자 콘솔 확장기능](tutorial/devtools-extension.md) -* [Pepper 플래시 플러그인 사용하기](tutorial/using-pepper-flash-plugin.md) - -## 튜토리얼 - -* [시작하기](tutorial/quick-start.md) -* [데스크톱 환경 통합](tutorial/desktop-environment-integration.md) -* [온라인/오프라인 이벤트](tutorial/online-offline-events.md) - -## API 레퍼런스 - -* [개요](api/synopsis.md) -* [프로세스 객체](api/process.md) -* [크롬 Command-Line 스위치 지원](api/chrome-command-line-switches.md) - -커스텀 DOM Element: - -* [`File` 객체](api/file-object.md) -* [`` 태그](api/web-view-tag.md) -* [`window.open` 함수](api/window-open.md) - -메인 프로세스를 위한 모듈들: - -* [app](api/app.md) -* [auto-updater](api/auto-updater.md) -* [browser-window](api/browser-window.md) -* [content-tracing](api/content-tracing.md) -* [dialog](api/dialog.md) -* [global-shortcut](api/global-shortcut.md) -* [ipc (main process)](api/ipc-main-process.md) -* [menu](api/menu.md) -* [menu-item](api/menu-item.md) -* [power-monitor](api/power-monitor.md) -* [power-save-blocker](api/power-save-blocker.md) -* [protocol](api/protocol.md) -* [tray](api/tray.md) - -랜더러 프로세스를 위한 모듈들 (웹 페이지): - -* [ipc (renderer)](api/ipc-renderer.md) -* [remote](api/remote.md) -* [web-frame](api/web-frame.md) - -두 프로세스에서 모두 사용 가능한 모듈들: - -* [clipboard](api/clipboard.md) -* [crash-reporter](api/crash-reporter.md) -* [native-image](api/native-image.md) -* [screen](api/screen.md) -* [shell](api/shell.md) - -## 개발자용 - -* [코딩 스타일](development/coding-style.md) -* [소스 코드 디렉터리 구조](development/source-code-directory-structure.md) -* [NW.js와 기술적으로 다른점 (이전 node-webkit)](development/atom-shell-vs-node-webkit.md) -* [빌드 시스템 개요](development/build-system-overview.md) -* [빌드 설명서 (Mac)](development/build-instructions-mac.md) -* [빌드 설명서 (Windows)](development/build-instructions-windows.md) -* [빌드 설명서 (Linux)](development/build-instructions-linux.md) -* [디버거에서 디버그 심볼 서버 설정](development/setting-up-symbol-server.md) diff --git a/docs-translations/ko/api/accelerator.md b/docs-translations/ko/api/accelerator-ko.md similarity index 100% rename from docs-translations/ko/api/accelerator.md rename to docs-translations/ko/api/accelerator-ko.md diff --git a/docs-translations/ko/api/auto-updater.md b/docs-translations/ko/api/auto-updater-ko.md similarity index 100% rename from docs-translations/ko/api/auto-updater.md rename to docs-translations/ko/api/auto-updater-ko.md diff --git a/docs-translations/ko/api/chrome-command-line-switches.md b/docs-translations/ko/api/chrome-command-line-switches-ko.md similarity index 97% rename from docs-translations/ko/api/chrome-command-line-switches.md rename to docs-translations/ko/api/chrome-command-line-switches-ko.md index 5b9bf4722042..7d1a7011eff6 100644 --- a/docs-translations/ko/api/chrome-command-line-switches.md +++ b/docs-translations/ko/api/chrome-command-line-switches-ko.md @@ -62,9 +62,9 @@ Hostname 맵핑 규칙을 설정합니다. (`,`로 분리) `--host-rules` 플래그와 비슷하지만 이 플래그는 host resolver에만 적용됩니다. -[app]: app.md -[append-switch]: app.md#appcommandlineappendswitchswitch-value -[ready]: app.md#event-ready +[app]: app-ko.md +[append-switch]: app-ko.md#appcommandlineappendswitchswitch-value +[ready]: app-ko.md#event-ready ## --ignore-certificate-errors diff --git a/docs-translations/ko/api/clipboard.md b/docs-translations/ko/api/clipboard-ko.md similarity index 94% rename from docs-translations/ko/api/clipboard.md rename to docs-translations/ko/api/clipboard-ko.md index a6b29c2a377f..bc6c82786cb7 100644 --- a/docs-translations/ko/api/clipboard.md +++ b/docs-translations/ko/api/clipboard-ko.md @@ -45,11 +45,11 @@ console.log(clipboard.readText('selection')); * `type` String -클립보드로부터 [NativeImage](native-image.md)로 이미지를 읽어들입니다. +클립보드로부터 [NativeImage](native-image-ko.md)로 이미지를 읽어들입니다. ## clipboard.writeImage(image[, type]) -* `image` [NativeImage](native-image.md) +* `image` [NativeImage](native-image-ko.md) * `type` String 클립보드에 `image`를 씁니다. diff --git a/docs-translations/ko/api/content-tracing.md b/docs-translations/ko/api/content-tracing-ko.md similarity index 100% rename from docs-translations/ko/api/content-tracing.md rename to docs-translations/ko/api/content-tracing-ko.md diff --git a/docs-translations/ko/api/crash-reporter.md b/docs-translations/ko/api/crash-reporter-ko.md similarity index 100% rename from docs-translations/ko/api/crash-reporter.md rename to docs-translations/ko/api/crash-reporter-ko.md diff --git a/docs-translations/ko/api/dialog.md b/docs-translations/ko/api/dialog-ko.md similarity index 99% rename from docs-translations/ko/api/dialog.md rename to docs-translations/ko/api/dialog-ko.md index 4f151f0b1ebb..2f24c659f913 100644 --- a/docs-translations/ko/api/dialog.md +++ b/docs-translations/ko/api/dialog-ko.md @@ -77,7 +77,7 @@ Windows와 Linux에선 파일 선택 모드, 디렉터리 선택 모드를 동 * `title` String - 대화 상자의 제목입니다. 몇몇 플랫폼에선 보이지 않을 수 있습니다. * `message` String - 대화 상자의 본문 내용입니다. * `detail` String - 메시지의 추가 정보입니다. - * `icon` [NativeImage](native-image.md) + * `icon` [NativeImage](native-image-ko.md) * `cancelId` Integer - 유저가 대화 상자의 버튼을 클릭하지 않고 대화 상자를 취소했을 때 반환되는 버튼의 index입니다. 기본적으로 버튼 리스트가 "cancel" 또는 "no" 라벨을 가지고 있을 때 해당 버튼의 index를 반환합니다. 따로 두 라벨이 지정되지 않은 경우 0을 반환합니다. OS X와 Windows에선 `cancelId` 지정 여부에 상관없이 "Cancel" 버튼이 언제나 `cancelId`로 지정됩니다. diff --git a/docs-translations/ko/api/file-object.md b/docs-translations/ko/api/file-object-ko.md similarity index 100% rename from docs-translations/ko/api/file-object.md rename to docs-translations/ko/api/file-object-ko.md diff --git a/docs-translations/ko/api/frameless-window.md b/docs-translations/ko/api/frameless-window-ko.md similarity index 97% rename from docs-translations/ko/api/frameless-window.md rename to docs-translations/ko/api/frameless-window-ko.md index 3dc45b824fd1..420b277d9b17 100644 --- a/docs-translations/ko/api/frameless-window.md +++ b/docs-translations/ko/api/frameless-window-ko.md @@ -4,7 +4,7 @@ Frameless 윈도우는 테두리가 없는 윈도우 창을 말합니다. ## Frameless 윈도우 만들기 -Frameless 윈도우를 만드려면 [BrowserWindow](browser-window.md) 객체의 `options`에서 `frame` 옵션을 `false`로 지정하기만 하면됩니다: +Frameless 윈도우를 만드려면 [BrowserWindow](browser-window-ko.md) 객체의 `options`에서 `frame` 옵션을 `false`로 지정하기만 하면됩니다: ```javascript var BrowserWindow = require('browser-window'); diff --git a/docs-translations/ko/api/global-shortcut.md b/docs-translations/ko/api/global-shortcut-ko.md similarity index 92% rename from docs-translations/ko/api/global-shortcut.md rename to docs-translations/ko/api/global-shortcut-ko.md index d99085f448e5..25c1d320870e 100644 --- a/docs-translations/ko/api/global-shortcut.md +++ b/docs-translations/ko/api/global-shortcut-ko.md @@ -32,20 +32,20 @@ app.on('will-quit', function() { ## globalShortcut.register(accelerator, callback) -* `accelerator` [Accelerator](accelerator.md) +* `accelerator` [Accelerator](accelerator-ko.md) * `callback` Function `accelerator`로 표현된 전역 단축키를 등록합니다. 유저로부터 등록된 단축키가 눌렸을 경우 `callback` 함수가 호출됩니다. ## globalShortcut.isRegistered(accelerator) -* `accelerator` [Accelerator](accelerator.md) +* `accelerator` [Accelerator](accelerator-ko.md) 지정된 `accelerator` 단축키가 등록되었는지 여부를 확인합니다. 반환값은 boolean(true, false) 입니다. ## globalShortcut.unregister(accelerator) -* `accelerator` [Accelerator](accelerator.md) +* `accelerator` [Accelerator](accelerator-ko.md) `키코드`에 해당하는 전역 단축키를 등록 해제합니다. diff --git a/docs-translations/ko/api/ipc-main-process.md b/docs-translations/ko/api/ipc-main-process-ko.md similarity index 92% rename from docs-translations/ko/api/ipc-main-process.md rename to docs-translations/ko/api/ipc-main-process-ko.md index 7f6a091de46d..7d0aba08efa5 100644 --- a/docs-translations/ko/api/ipc-main-process.md +++ b/docs-translations/ko/api/ipc-main-process-ko.md @@ -6,7 +6,7 @@ 동기 메시지는 `event.returnValue`를 이용하여 반환값(답장)을 설정할 수 있습니다. 비동기 메시지라면 `event.sender.send(...)`를 사용하면 됩니다. 또한 메인 프로세스에서 랜더러 프로세스로 메시지를 보내는 것도 가능합니다. -자세한 내용은 [WebContents.send](browser-window.md#webcontentssendchannel-args)를 참고 하세요. +자세한 내용은 [WebContents.send](browser-window-ko.md#webcontentssendchannel-args)를 참고 하세요. 보내진 메시지들을 처리하는 예제입니다: diff --git a/docs-translations/ko/api/ipc-renderer.md b/docs-translations/ko/api/ipc-renderer-ko.md similarity index 85% rename from docs-translations/ko/api/ipc-renderer.md rename to docs-translations/ko/api/ipc-renderer-ko.md index b8bbb7ffa14d..e4664480447f 100644 --- a/docs-translations/ko/api/ipc-renderer.md +++ b/docs-translations/ko/api/ipc-renderer-ko.md @@ -1,9 +1,9 @@ # ipc (renderer) `ipc` 모듈은 메인 프로세스로 메시지를 동기 또는 비동기로 보내고 받을 수 있는 몇 가지 방법을 제공합니다. -만약 랜더러 프로세스에서 메인 프로세스의 모듈을 직접적으로 사용하고 싶다면 [remote](remote.md) 모듈을 사용하는 것을 고려해보는 것이 좋습니다. +만약 랜더러 프로세스에서 메인 프로세스의 모듈을 직접적으로 사용하고 싶다면 [remote](remote-ko.md) 모듈을 사용하는 것을 고려해보는 것이 좋습니다. -[ipc (main process)](ipc-main-process.md)에서 예제를 볼 수 있습니다. +[ipc (main process)](ipc-main-process-ko.md)에서 예제를 볼 수 있습니다. ## ipc.send(channel[, args...]) diff --git a/docs-translations/ko/api/menu-item.md b/docs-translations/ko/api/menu-item-ko.md similarity index 90% rename from docs-translations/ko/api/menu-item.md rename to docs-translations/ko/api/menu-item-ko.md index 519b7fb237a3..8477451ff965 100644 --- a/docs-translations/ko/api/menu-item.md +++ b/docs-translations/ko/api/menu-item-ko.md @@ -10,8 +10,8 @@ * `type` String - `MenuItem`의 타입 `normal`, `separator`, `submenu`, `checkbox` 또는 `radio` 사용가능 * `label` String * `sublabel` String - * `accelerator` [Accelerator](accelerator.md) - * `icon` [NativeImage](native-image.md) + * `accelerator` [Accelerator](accelerator-ko.md) + * `icon` [NativeImage](native-image-ko.md) * `enabled` Boolean * `visible` Boolean * `checked` Boolean diff --git a/docs-translations/ko/api/menu.md b/docs-translations/ko/api/menu-ko.md similarity index 95% rename from docs-translations/ko/api/menu.md rename to docs-translations/ko/api/menu-ko.md index 3303a55d05f2..7f2b5ad90c80 100644 --- a/docs-translations/ko/api/menu.md +++ b/docs-translations/ko/api/menu-ko.md @@ -3,7 +3,7 @@ `Menu` 클래스는 어플리케이션 메뉴와 컨텍스트 메뉴를 만들 때 사용됩니다. 메뉴는 여러 개의 메뉴 아이템으로 구성되고 서브 메뉴를 가질 수도 있습니다. -다음 예제는 웹 페이지 내에서 [remote](remote.md) 모듈을 활용하여 동적으로 메뉴를 생성하는 예제입니다. +다음 예제는 웹 페이지 내에서 [remote](remote-ko.md) 모듈을 활용하여 동적으로 메뉴를 생성하는 예제입니다. 이 예제에서 만들어진 메뉴는 유저가 페이지에서 오른쪽 클릭을 할 때 마우스 위치에 팝업 형태로 표시됩니다: @@ -28,7 +28,7 @@ window.addEventListener('contextmenu', function (e) { 다음 예제는 template API를 활용하여 어플리케이션 메뉴를 만드는 간단한 예제입니다: -**Windows 와 Linux 유저 주의:** 각 메뉴 아이템의 `selector` 멤버는 Mac 운영체제 전용입니다. [Accelerator 옵션](accelerator.md) +**Windows 와 Linux 유저 주의:** 각 메뉴 아이템의 `selector` 멤버는 Mac 운영체제 전용입니다. [Accelerator 옵션](https://github.com/atom/electron/blob/master/docs/api/accelerator-ko.md) ```html @@ -189,7 +189,7 @@ Menu.setApplicationMenu(menu); * `template` Array -기본적으로 `template`는 [MenuItem](menu-item.md)을 생성할 때 사용하는 `options`의 배열입니다. 사용법은 위에서 설명한 것과 같습니다. +기본적으로 `template`는 [MenuItem](menu-item-ko.md)을 생성할 때 사용하는 `options`의 배열입니다. 사용법은 위에서 설명한 것과 같습니다. 또한 `template`에는 다른 속성도 추가할 수 있으며 메뉴가 만들어질 때 해당 메뉴 아이템의 프로퍼티로 변환됩니다. diff --git a/docs-translations/ko/api/native-image.md b/docs-translations/ko/api/native-image-ko.md similarity index 100% rename from docs-translations/ko/api/native-image.md rename to docs-translations/ko/api/native-image-ko.md diff --git a/docs-translations/ko/api/power-monitor.md b/docs-translations/ko/api/power-monitor-ko.md similarity index 100% rename from docs-translations/ko/api/power-monitor.md rename to docs-translations/ko/api/power-monitor-ko.md diff --git a/docs-translations/ko/api/power-save-blocker.md b/docs-translations/ko/api/power-save-blocker-ko.md similarity index 100% rename from docs-translations/ko/api/power-save-blocker.md rename to docs-translations/ko/api/power-save-blocker-ko.md diff --git a/docs-translations/ko/api/process.md b/docs-translations/ko/api/process-ko.md similarity index 100% rename from docs-translations/ko/api/process.md rename to docs-translations/ko/api/process-ko.md diff --git a/docs-translations/ko/api/protocol.md b/docs-translations/ko/api/protocol-ko.md similarity index 100% rename from docs-translations/ko/api/protocol.md rename to docs-translations/ko/api/protocol-ko.md diff --git a/docs-translations/ko/api/remote.md b/docs-translations/ko/api/remote-ko.md similarity index 99% rename from docs-translations/ko/api/remote.md rename to docs-translations/ko/api/remote-ko.md index c2713db4a910..64232bdc31af 100644 --- a/docs-translations/ko/api/remote.md +++ b/docs-translations/ko/api/remote-ko.md @@ -70,7 +70,7 @@ remote.getCurrentWindow().on('close', function() { ## remote.getCurrentWindow() -현재 웹 페이지가 들어있는 [BrowserWindow](browser-window.md) 객체를 반환합니다. +현재 웹 페이지가 들어있는 [BrowserWindow](browser-window-ko.md) 객체를 반환합니다. ## remote.getCurrentWebContents() diff --git a/docs-translations/ko/api/screen.md b/docs-translations/ko/api/screen-ko.md similarity index 100% rename from docs-translations/ko/api/screen.md rename to docs-translations/ko/api/screen-ko.md diff --git a/docs-translations/ko/api/shell.md b/docs-translations/ko/api/shell-ko.md similarity index 100% rename from docs-translations/ko/api/shell.md rename to docs-translations/ko/api/shell-ko.md diff --git a/docs-translations/ko/api/synopsis.md b/docs-translations/ko/api/synopsis-ko.md similarity index 81% rename from docs-translations/ko/api/synopsis.md rename to docs-translations/ko/api/synopsis-ko.md index 69ee4af354c7..8754f2f15bf2 100644 --- a/docs-translations/ko/api/synopsis.md +++ b/docs-translations/ko/api/synopsis-ko.md @@ -1,11 +1,11 @@ # 개요 -Electron은 모든 [node.js's built-in 모듈](http://nodejs.org/api/)과 third-party node 모듈을 완벽하게 지원합니다. ([네이티브 모듈](../tutorial/using-native-node-modules.md)을 포함해서) +Electron은 모든 [node.js's built-in 모듈](http://nodejs.org/api/)과 third-party node 모듈을 완벽하게 지원합니다. ([네이티브 모듈](../tutorial/using-native-node-modules-ko.md)을 포함해서) Electron은 네이티브 데스크톱 어플리케이션을 개발 할 수 있도록 추가적인 built-in 모듈을 제공합니다. 몇몇 모듈은 메인 프로세스에서만 사용할 수 있고 어떤 모듈은 랜더러 프로세스에서만 사용할 수 있습니다. 또한 두 프로세스 모두 사용할 수 있는 모듈도 있습니다. 기본적인 규칙은 다음과 같습니다: GUI와 저 수준 시스템에 관련된 모듈은 오직 메인 프로세스에서만 사용할 수 있습니다. -[메인 프로세스 vs. 랜더러 프로세스](../tutorial/quick-start.md#메인 프로세스) 컨셉에 익숙해야 이 모듈들을 사용하기 쉬우므로 해당 문서를 정독하는 것을 권장합니다. +[메인 프로세스 vs. 랜더러 프로세스](../tutorial/quick-start-ko.md#메인 프로세스) 컨셉에 익숙해야 이 모듈들을 사용하기 쉬우므로 해당 문서를 정독하는 것을 권장합니다. 메인 프로세스 스크립트는 일반 `node.js` 스크립트와 같습니다: @@ -36,4 +36,4 @@ app.on('ready', function() { ``` -어플리케이션을 실행하려면 [앱 실행하기](../tutorial/quick-start.md#앱 실행하기) 문서를 참고하기 바랍니다. +어플리케이션을 실행하려면 [앱 실행하기](../tutorial/quick-start-ko.md#앱 실행하기) 문서를 참고하기 바랍니다. diff --git a/docs-translations/ko/api/tray.md b/docs-translations/ko/api/tray-ko.md similarity index 96% rename from docs-translations/ko/api/tray.md rename to docs-translations/ko/api/tray-ko.md index 05decef5a48f..a32ccbb1d0e2 100644 --- a/docs-translations/ko/api/tray.md +++ b/docs-translations/ko/api/tray-ko.md @@ -38,7 +38,7 @@ __플랫폼별 한계:__ ### new Tray(image) -* `image` [NativeImage](native-image.md) +* `image` [NativeImage](native-image-ko.md) 전달된 `image`를 이용하여 트레이 아이콘을 만듭니다. @@ -126,13 +126,13 @@ __주의:__ 이 기능은 OS X에서만 작동합니다. ### Tray.setImage(image) -* `image` [NativeImage](native-image.md) +* `image` [NativeImage](native-image-ko.md) `image`를 사용하여 트레이 아이콘의 이미지를 설정합니다. ### Tray.setPressedImage(image) -* `image` [NativeImage](native-image.md) +* `image` [NativeImage](native-image-ko.md) `image`를 사용하여 트레이 아이콘이 눌렸을 때의 이미지를 설정합니다. @@ -163,7 +163,7 @@ __주의:__ 이 기능은 OS X에서만 작동합니다. ### Tray.displayBalloon(options) * `options` Object - * `icon` [NativeImage](native-image.md) + * `icon` [NativeImage](native-image-ko.md) * `title` String * `content` String diff --git a/docs-translations/ko/api/web-frame.md b/docs-translations/ko/api/web-frame-ko.md similarity index 100% rename from docs-translations/ko/api/web-frame.md rename to docs-translations/ko/api/web-frame-ko.md diff --git a/docs-translations/ko/api/web-view-tag.md b/docs-translations/ko/api/web-view-tag-ko.md similarity index 99% rename from docs-translations/ko/api/web-view-tag.md rename to docs-translations/ko/api/web-view-tag-ko.md index d2efdf17ea1f..32a5a835516f 100644 --- a/docs-translations/ko/api/web-view-tag.md +++ b/docs-translations/ko/api/web-view-tag-ko.md @@ -311,7 +311,7 @@ Webview 페이지를 PDF 형식으로 인쇄합니다. `webContents.printToPDF(o `channel`을 통해 게스트 페이지에 `args...` 비동기 메시지를 보냅니다. 게스트 페이지에선 `ipc` 모듈의 `channel` 이벤트를 사용하면 이 메시지를 받을 수 있습니다. -예제는 [WebContents.send](browser-window.md#webcontentssendchannel-args)를 참고하세요. +예제는 [WebContents.send](browser-window-ko.md#webcontentssendchannel-args)를 참고하세요. ## DOM 이벤트 diff --git a/docs-translations/ko/api/window-open.md b/docs-translations/ko/api/window-open-ko.md similarity index 100% rename from docs-translations/ko/api/window-open.md rename to docs-translations/ko/api/window-open-ko.md diff --git a/docs-translations/ko/development/atom-shell-vs-node-webkit.md b/docs-translations/ko/development/atom-shell-vs-node-webkit-ko.md similarity index 100% rename from docs-translations/ko/development/atom-shell-vs-node-webkit.md rename to docs-translations/ko/development/atom-shell-vs-node-webkit-ko.md diff --git a/docs-translations/ko/development/build-instructions-linux.md b/docs-translations/ko/development/build-instructions-linux-ko.md similarity index 100% rename from docs-translations/ko/development/build-instructions-linux.md rename to docs-translations/ko/development/build-instructions-linux-ko.md diff --git a/docs-translations/ko/development/build-instructions-mac.md b/docs-translations/ko/development/build-instructions-mac-ko.md similarity index 100% rename from docs-translations/ko/development/build-instructions-mac.md rename to docs-translations/ko/development/build-instructions-mac-ko.md diff --git a/docs-translations/ko/development/build-instructions-windows.md b/docs-translations/ko/development/build-instructions-windows-ko.md similarity index 100% rename from docs-translations/ko/development/build-instructions-windows.md rename to docs-translations/ko/development/build-instructions-windows-ko.md diff --git a/docs-translations/ko/development/build-system-overview.md b/docs-translations/ko/development/build-system-overview-ko.md similarity index 100% rename from docs-translations/ko/development/build-system-overview.md rename to docs-translations/ko/development/build-system-overview-ko.md diff --git a/docs-translations/ko/development/coding-style.md b/docs-translations/ko/development/coding-style-ko.md similarity index 100% rename from docs-translations/ko/development/coding-style.md rename to docs-translations/ko/development/coding-style-ko.md diff --git a/docs-translations/ko/development/setting-up-symbol-server.md b/docs-translations/ko/development/setting-up-symbol-server-ko.md similarity index 100% rename from docs-translations/ko/development/setting-up-symbol-server.md rename to docs-translations/ko/development/setting-up-symbol-server-ko.md diff --git a/docs-translations/ko/development/source-code-directory-structure.md b/docs-translations/ko/development/source-code-directory-structure-ko.md similarity index 100% rename from docs-translations/ko/development/source-code-directory-structure.md rename to docs-translations/ko/development/source-code-directory-structure-ko.md diff --git a/docs-translations/ko/tutorial/application-distribution.md b/docs-translations/ko/tutorial/application-distribution-ko.md similarity index 99% rename from docs-translations/ko/tutorial/application-distribution.md rename to docs-translations/ko/tutorial/application-distribution-ko.md index fac2ae48a140..043ced1ec47c 100644 --- a/docs-translations/ko/tutorial/application-distribution.md +++ b/docs-translations/ko/tutorial/application-distribution-ko.md @@ -48,7 +48,7 @@ electron/resources/ └── app.asar ``` -자세한 내용은 [어플리케이션 패키징](application-packaging.md)에서 찾아볼 수 있습니다. +자세한 내용은 [어플리케이션 패키징](application-packaging-ko.md)에서 찾아볼 수 있습니다. ## 다운로드한 바이너리의 리소스를 앱에 맞게 수정하기 diff --git a/docs-translations/ko/tutorial/application-packaging.md b/docs-translations/ko/tutorial/application-packaging-ko.md similarity index 100% rename from docs-translations/ko/tutorial/application-packaging.md rename to docs-translations/ko/tutorial/application-packaging-ko.md diff --git a/docs-translations/ko/tutorial/debugging-main-process.md b/docs-translations/ko/tutorial/debugging-main-process-ko.md similarity index 100% rename from docs-translations/ko/tutorial/debugging-main-process.md rename to docs-translations/ko/tutorial/debugging-main-process-ko.md diff --git a/docs-translations/ko/tutorial/desktop-environment-integration.md b/docs-translations/ko/tutorial/desktop-environment-integration-ko.md similarity index 95% rename from docs-translations/ko/tutorial/desktop-environment-integration.md rename to docs-translations/ko/tutorial/desktop-environment-integration-ko.md index 9d1b5ffadcc4..68f5562dbb52 100644 --- a/docs-translations/ko/tutorial/desktop-environment-integration.md +++ b/docs-translations/ko/tutorial/desktop-environment-integration-ko.md @@ -211,12 +211,12 @@ window.setRepresentedFilename('/etc/passwd'); window.setDocumentEdited(true); ``` -[addrecentdocument]: ../api/app.md#appaddrecentdocumentpath -[clearrecentdocuments]: ../api/app.md#appclearrecentdocuments -[setusertaskstasks]: ../api/app.md#appsetusertaskstasks -[setprogressbar]: ../api/browser-window.md#browserwindowsetprogressbarprogress -[setrepresentedfilename]: ../api/browser-window.md#browserwindowsetrepresentedfilenamefilename -[setdocumentedited]: ../api/browser-window.md#browserwindowsetdocumenteditededited +[addrecentdocument]: ../api/app-ko.md#appaddrecentdocumentpath +[clearrecentdocuments]: ../api/app-ko.md#appclearrecentdocuments +[setusertaskstasks]: ../api/app-ko.md#appsetusertaskstasks +[setprogressbar]: ../api/browser-window-ko.md#browserwindowsetprogressbarprogress +[setrepresentedfilename]: ../api/browser-window-ko.md#browserwindowsetrepresentedfilenamefilename +[setdocumentedited]: ../api/browser-window-ko.md#browserwindowsetdocumenteditededited [app-registration]: http://msdn.microsoft.com/en-us/library/windows/desktop/ee872121(v=vs.85).aspx [unity-launcher]: https://help.ubuntu.com/community/UnityLaunchersAndDesktopFiles#Adding_shortcuts_to_a_launcher [setthumbarbuttons]: ../api/browser-window.md#browserwindowsetthumbarbuttonsbuttons diff --git a/docs-translations/ko/tutorial/devtools-extension.md b/docs-translations/ko/tutorial/devtools-extension-ko.md similarity index 100% rename from docs-translations/ko/tutorial/devtools-extension.md rename to docs-translations/ko/tutorial/devtools-extension-ko.md diff --git a/docs-translations/ko/tutorial/online-offline-events.md b/docs-translations/ko/tutorial/online-offline-events-ko.md similarity index 100% rename from docs-translations/ko/tutorial/online-offline-events.md rename to docs-translations/ko/tutorial/online-offline-events-ko.md diff --git a/docs-translations/ko/tutorial/quick-start.md b/docs-translations/ko/tutorial/quick-start-ko.md similarity index 92% rename from docs-translations/ko/tutorial/quick-start.md rename to docs-translations/ko/tutorial/quick-start-ko.md index 7564f1c8c4c9..1d548c6f01c0 100644 --- a/docs-translations/ko/tutorial/quick-start.md +++ b/docs-translations/ko/tutorial/quick-start-ko.md @@ -33,8 +33,8 @@ Electron 프로세스 내에서 작동하는 웹 페이지는 __랜더러 프로 기본적으로 웹 페이지 내에서는 네이티브 GUI와 관련된 API를 호출할 수 없도록 되어 있습니다. 만약 웹 페이지 내에서 GUI작업이 필요하다면 메인 프로세스에서 그 작업을 할 수 있도록 메인 프로세스와 통신을 해야합니다. -Electron에는 메인 프로세스와 랜더러 프로세스간에 통신을 할 수 있도록 [ipc](../api/ipc-renderer.md) 모듈을 제공하고 있습니다. -또한 [remote](../api/remote.md) 모듈을 사용하여 RPC 스타일로 통신할 수도 있습니다. +Electron에는 메인 프로세스와 랜더러 프로세스간에 통신을 할 수 있도록 [ipc](../api/ipc-renderer-ko.md) 모듈을 제공하고 있습니다. +또한 [remote](../api/remote-ko.md) 모듈을 사용하여 RPC 스타일로 통신할 수도 있습니다. ## 첫번째 Electron 앱 만들기 @@ -121,7 +121,7 @@ app.on('ready', function() { ## 앱 실행하기 -앱을 작성한 후 [어플리케이션 배포](application-distribution.md) 가이드를 따라 앱을 패키징 하고 패키징한 앱을 실행할 수 있습니다. +앱을 작성한 후 [어플리케이션 배포](./application-distribution-ko.md) 가이드를 따라 앱을 패키징 하고 패키징한 앱을 실행할 수 있습니다. 또는 Electron 실행파일을 다운로드 받아 바로 실행해 볼 수도 있습니다. ### electron-prebuilt @@ -173,4 +173,4 @@ $ ./Electron.app/Contents/MacOS/Electron your-app/ ### 배포용 파일 만들기 -어플리케이션 작성을 완료했다면 [어플리케이션 배포](application-distribution.md) 가이드를 통해 본격적으로 제작한 앱을 배포할 수 있습니다. \ No newline at end of file +어플리케이션 작성을 완료했다면 [어플리케이션 배포](./application-distribution-ko.md) 가이드를 통해 본격적으로 제작한 앱을 배포할 수 있습니다. \ No newline at end of file diff --git a/docs-translations/ko/tutorial/using-native-node-modules.md b/docs-translations/ko/tutorial/using-native-node-modules-ko.md similarity index 100% rename from docs-translations/ko/tutorial/using-native-node-modules.md rename to docs-translations/ko/tutorial/using-native-node-modules-ko.md diff --git a/docs-translations/ko/tutorial/using-pepper-flash-plugin.md b/docs-translations/ko/tutorial/using-pepper-flash-plugin-ko.md similarity index 100% rename from docs-translations/ko/tutorial/using-pepper-flash-plugin.md rename to docs-translations/ko/tutorial/using-pepper-flash-plugin-ko.md diff --git a/docs-translations/ko/tutorial/using-selenium-and-webdriver.md b/docs-translations/ko/tutorial/using-selenium-and-webdriver-ko.md similarity index 95% rename from docs-translations/ko/tutorial/using-selenium-and-webdriver.md rename to docs-translations/ko/tutorial/using-selenium-and-webdriver-ko.md index 069a49e52798..80b56e23ada1 100644 --- a/docs-translations/ko/tutorial/using-selenium-and-webdriver.md +++ b/docs-translations/ko/tutorial/using-selenium-and-webdriver-ko.md @@ -69,6 +69,6 @@ driver.quit(); ## 작업환경 따로 Electron을 다시 빌드하지 않는 경우 간단히 어플리케이션을 Electron의 리소스 디렉터리에 -[배치](application-distribution.md)하여 바로 테스트 할 수 있습니다. +[배치](https://github.com/atom/electron/blob/master/docs/tutorial/application-distribution-ko.md)하여 바로 테스트 할 수 있습니다. [chrome-driver]: https://sites.google.com/a/chromium.org/chromedriver/ diff --git a/vendor/node b/vendor/node index 902090af5375..205b013ac86e 160000 --- a/vendor/node +++ b/vendor/node @@ -1 +1 @@ -Subproject commit 902090af5375e497dded310575f19de5328a9bbc +Subproject commit 205b013ac86e5500678a791cd54f305580fa4f4b From fcf2be78cb8e9267f82a8dc17f61cdbec7418132 Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Tue, 25 Aug 2015 22:28:27 +0900 Subject: [PATCH 0951/1293] Reset and remove unrelated files --- README-ko.md | 4 +- docs-translations/ko/README-ko.md | 68 ------------------- docs-translations/ko/README.md | 68 +++++++++++++++++++ .../api/{accelerator-ko.md => accelerator.md} | 0 .../{auto-updater-ko.md => auto-updater.md} | 0 ...-ko.md => chrome-command-line-switches.md} | 6 +- .../ko/api/{clipboard-ko.md => clipboard.md} | 4 +- ...ntent-tracing-ko.md => content-tracing.md} | 0 ...crash-reporter-ko.md => crash-reporter.md} | 0 .../ko/api/{dialog-ko.md => dialog.md} | 2 +- .../api/{file-object-ko.md => file-object.md} | 0 ...eless-window-ko.md => frameless-window.md} | 2 +- ...obal-shortcut-ko.md => global-shortcut.md} | 6 +- ...main-process-ko.md => ipc-main-process.md} | 2 +- .../{ipc-renderer-ko.md => ipc-renderer.md} | 4 +- .../ko/api/{menu-item-ko.md => menu-item.md} | 4 +- .../ko/api/{menu-ko.md => menu.md} | 6 +- .../{native-image-ko.md => native-image.md} | 0 .../{power-monitor-ko.md => power-monitor.md} | 0 ...ve-blocker-ko.md => power-save-blocker.md} | 0 .../ko/api/{process-ko.md => process.md} | 0 .../ko/api/{protocol-ko.md => protocol.md} | 0 .../ko/api/{remote-ko.md => remote.md} | 2 +- .../ko/api/{screen-ko.md => screen.md} | 0 .../ko/api/{shell-ko.md => shell.md} | 0 .../ko/api/{synopsis-ko.md => synopsis.md} | 6 +- .../ko/api/{tray-ko.md => tray.md} | 8 +-- .../ko/api/{web-frame-ko.md => web-frame.md} | 0 .../{web-view-tag-ko.md => web-view-tag.md} | 2 +- .../api/{window-open-ko.md => window-open.md} | 0 ...kit-ko.md => atom-shell-vs-node-webkit.md} | 0 ...inux-ko.md => build-instructions-linux.md} | 0 ...ns-mac-ko.md => build-instructions-mac.md} | 0 ...ws-ko.md => build-instructions-windows.md} | 0 ...verview-ko.md => build-system-overview.md} | 0 .../{coding-style-ko.md => coding-style.md} | 0 ...rver-ko.md => setting-up-symbol-server.md} | 0 ....md => source-code-directory-structure.md} | 0 ...tion-ko.md => application-distribution.md} | 2 +- ...ckaging-ko.md => application-packaging.md} | 0 ...rocess-ko.md => debugging-main-process.md} | 0 ....md => desktop-environment-integration.md} | 12 ++-- ...-extension-ko.md => devtools-extension.md} | 0 ...-events-ko.md => online-offline-events.md} | 0 .../{quick-start-ko.md => quick-start.md} | 8 +-- ...les-ko.md => using-native-node-modules.md} | 0 ...gin-ko.md => using-pepper-flash-plugin.md} | 0 ...-ko.md => using-selenium-and-webdriver.md} | 2 +- 48 files changed, 109 insertions(+), 109 deletions(-) delete mode 100644 docs-translations/ko/README-ko.md create mode 100644 docs-translations/ko/README.md rename docs-translations/ko/api/{accelerator-ko.md => accelerator.md} (100%) rename docs-translations/ko/api/{auto-updater-ko.md => auto-updater.md} (100%) rename docs-translations/ko/api/{chrome-command-line-switches-ko.md => chrome-command-line-switches.md} (97%) rename docs-translations/ko/api/{clipboard-ko.md => clipboard.md} (94%) rename docs-translations/ko/api/{content-tracing-ko.md => content-tracing.md} (100%) rename docs-translations/ko/api/{crash-reporter-ko.md => crash-reporter.md} (100%) rename docs-translations/ko/api/{dialog-ko.md => dialog.md} (99%) rename docs-translations/ko/api/{file-object-ko.md => file-object.md} (100%) rename docs-translations/ko/api/{frameless-window-ko.md => frameless-window.md} (97%) rename docs-translations/ko/api/{global-shortcut-ko.md => global-shortcut.md} (92%) rename docs-translations/ko/api/{ipc-main-process-ko.md => ipc-main-process.md} (92%) rename docs-translations/ko/api/{ipc-renderer-ko.md => ipc-renderer.md} (85%) rename docs-translations/ko/api/{menu-item-ko.md => menu-item.md} (90%) rename docs-translations/ko/api/{menu-ko.md => menu.md} (95%) rename docs-translations/ko/api/{native-image-ko.md => native-image.md} (100%) rename docs-translations/ko/api/{power-monitor-ko.md => power-monitor.md} (100%) rename docs-translations/ko/api/{power-save-blocker-ko.md => power-save-blocker.md} (100%) rename docs-translations/ko/api/{process-ko.md => process.md} (100%) rename docs-translations/ko/api/{protocol-ko.md => protocol.md} (100%) rename docs-translations/ko/api/{remote-ko.md => remote.md} (99%) rename docs-translations/ko/api/{screen-ko.md => screen.md} (100%) rename docs-translations/ko/api/{shell-ko.md => shell.md} (100%) rename docs-translations/ko/api/{synopsis-ko.md => synopsis.md} (81%) rename docs-translations/ko/api/{tray-ko.md => tray.md} (96%) rename docs-translations/ko/api/{web-frame-ko.md => web-frame.md} (100%) rename docs-translations/ko/api/{web-view-tag-ko.md => web-view-tag.md} (99%) rename docs-translations/ko/api/{window-open-ko.md => window-open.md} (100%) rename docs-translations/ko/development/{atom-shell-vs-node-webkit-ko.md => atom-shell-vs-node-webkit.md} (100%) rename docs-translations/ko/development/{build-instructions-linux-ko.md => build-instructions-linux.md} (100%) rename docs-translations/ko/development/{build-instructions-mac-ko.md => build-instructions-mac.md} (100%) rename docs-translations/ko/development/{build-instructions-windows-ko.md => build-instructions-windows.md} (100%) rename docs-translations/ko/development/{build-system-overview-ko.md => build-system-overview.md} (100%) rename docs-translations/ko/development/{coding-style-ko.md => coding-style.md} (100%) rename docs-translations/ko/development/{setting-up-symbol-server-ko.md => setting-up-symbol-server.md} (100%) rename docs-translations/ko/development/{source-code-directory-structure-ko.md => source-code-directory-structure.md} (100%) rename docs-translations/ko/tutorial/{application-distribution-ko.md => application-distribution.md} (99%) rename docs-translations/ko/tutorial/{application-packaging-ko.md => application-packaging.md} (100%) rename docs-translations/ko/tutorial/{debugging-main-process-ko.md => debugging-main-process.md} (100%) rename docs-translations/ko/tutorial/{desktop-environment-integration-ko.md => desktop-environment-integration.md} (95%) rename docs-translations/ko/tutorial/{devtools-extension-ko.md => devtools-extension.md} (100%) rename docs-translations/ko/tutorial/{online-offline-events-ko.md => online-offline-events.md} (100%) rename docs-translations/ko/tutorial/{quick-start-ko.md => quick-start.md} (92%) rename docs-translations/ko/tutorial/{using-native-node-modules-ko.md => using-native-node-modules.md} (100%) rename docs-translations/ko/tutorial/{using-pepper-flash-plugin-ko.md => using-pepper-flash-plugin.md} (100%) rename docs-translations/ko/tutorial/{using-selenium-and-webdriver-ko.md => using-selenium-and-webdriver.md} (95%) diff --git a/README-ko.md b/README-ko.md index 91459c6adf2e..bbe1333cf553 100644 --- a/README-ko.md +++ b/README-ko.md @@ -1,4 +1,4 @@ -[![Electron Logo](http://electron.atom.io/images/electron-logo.svg)](http://electron.atom.io/) +[![Electron Logo](http://electron.atom.io/images/electron-logo.svg)](http://electron.atom.io/) [![Build Status](https://travis-ci.org/atom/electron.svg?branch=master)](https://travis-ci.org/atom/electron) [![devDependency Status](https://david-dm.org/atom/electron/dev-status.svg)](https://david-dm.org/atom/electron#info=devDependencies) @@ -33,7 +33,7 @@ npm install electron-prebuilt --save-dev ## 참조 문서 -[Docs](https://github.com/atom/electron/tree/master/docs/README-ko.md)에 개발 가이드와 API 레퍼런스가 있습니다. +[Docs](https://github.com/atom/electron/tree/master/docs/README.md)에 개발 가이드와 API 레퍼런스가 있습니다. Electron을 빌드 하는 방법과 프로젝트에 기여하는 방법도 문서에 포함되어 있으니 참고하시기 바랍니다. ## 참조 문서(번역) diff --git a/docs-translations/ko/README-ko.md b/docs-translations/ko/README-ko.md deleted file mode 100644 index b48c6a42c516..000000000000 --- a/docs-translations/ko/README-ko.md +++ /dev/null @@ -1,68 +0,0 @@ -## 개발 가이드 - -* [어플리케이션 배포](tutorial/application-distribution-ko.md) -* [어플리케이션 패키징](tutorial/application-packaging-ko.md) -* [네이티브 node 모듈 사용하기](tutorial/using-native-node-modules-ko.md) -* [메인 프로세스 디버깅하기](tutorial/debugging-main-process-ko.md) -* [Selenium 과 WebDriver 사용하기](tutorial/using-selenium-and-webdriver-ko.md) -* [개발자 콘솔 확장기능](tutorial/devtools-extension-ko.md) -* [Pepper 플래시 플러그인 사용하기](tutorial/using-pepper-flash-plugin-ko.md) - -## 튜토리얼 - -* [시작하기](tutorial/quick-start-ko.md) -* [데스크톱 환경 통합](tutorial/desktop-environment-integration-ko.md) -* [온라인/오프라인 이벤트](tutorial/online-offline-events-ko.md) - -## API 레퍼런스 - -* [개요](api/synopsis-ko.md) -* [프로세스 객체](api/process-ko.md) -* [크롬 Command-Line 스위치 지원](api/chrome-command-line-switches-ko.md) - -커스텀 DOM Element: - -* [`File` 객체](api/file-object-ko.md) -* [`` 태그](api/web-view-tag-ko.md) -* [`window.open` 함수](api/window-open-ko.md) - -메인 프로세스를 위한 모듈들: - -* [app](api/app-ko.md) -* [auto-updater](api/auto-updater-ko.md) -* [browser-window](api/browser-window-ko.md) -* [content-tracing](api/content-tracing-ko.md) -* [dialog](api/dialog-ko.md) -* [global-shortcut](api/global-shortcut-ko.md) -* [ipc (main process)](api/ipc-main-process-ko.md) -* [menu](api/menu-ko.md) -* [menu-item](api/menu-item-ko.md) -* [power-monitor](api/power-monitor-ko.md) -* [power-save-blocker](api/power-save-blocker-ko.md) -* [protocol](api/protocol-ko.md) -* [tray](api/tray-ko.md) - -랜더러 프로세스를 위한 모듈들 (웹 페이지): - -* [ipc (renderer)](api/ipc-renderer-ko.md) -* [remote](api/remote-ko.md) -* [web-frame](api/web-frame-ko.md) - -두 프로세스에서 모두 사용 가능한 모듈들: - -* [clipboard](api/clipboard-ko.md) -* [crash-reporter](api/crash-reporter-ko.md) -* [native-image](api/native-image-ko.md) -* [screen](api/screen-ko.md) -* [shell](api/shell-ko.md) - -## 개발자용 - -* [코딩 스타일](development/coding-style-ko.md) -* [소스 코드 디렉터리 구조](development/source-code-directory-structure-ko.md) -* [NW.js와 기술적으로 다른점 (이전 node-webkit)](development/atom-shell-vs-node-webkit-ko.md) -* [빌드 시스템 개요](development/build-system-overview-ko.md) -* [빌드 설명서 (Mac)](development/build-instructions-mac-ko.md) -* [빌드 설명서 (Windows)](development/build-instructions-windows-ko.md) -* [빌드 설명서 (Linux)](development/build-instructions-linux-ko.md) -* [디버거에서 디버그 심볼 서버 설정](development/setting-up-symbol-server-ko.md) diff --git a/docs-translations/ko/README.md b/docs-translations/ko/README.md new file mode 100644 index 000000000000..51bf0a36d07f --- /dev/null +++ b/docs-translations/ko/README.md @@ -0,0 +1,68 @@ +## 개발 가이드 + +* [어플리케이션 배포](tutorial/application-distribution.md) +* [어플리케이션 패키징](tutorial/application-packaging.md) +* [네이티브 node 모듈 사용하기](tutorial/using-native-node-modules.md) +* [메인 프로세스 디버깅하기](tutorial/debugging-main-process.md) +* [Selenium 과 WebDriver 사용하기](tutorial/using-selenium-and-webdriver.md) +* [개발자 콘솔 확장기능](tutorial/devtools-extension.md) +* [Pepper 플래시 플러그인 사용하기](tutorial/using-pepper-flash-plugin.md) + +## 튜토리얼 + +* [시작하기](tutorial/quick-start.md) +* [데스크톱 환경 통합](tutorial/desktop-environment-integration.md) +* [온라인/오프라인 이벤트](tutorial/online-offline-events.md) + +## API 레퍼런스 + +* [개요](api/synopsis.md) +* [프로세스 객체](api/process.md) +* [크롬 Command-Line 스위치 지원](api/chrome-command-line-switches.md) + +커스텀 DOM Element: + +* [`File` 객체](api/file-object.md) +* [`` 태그](api/web-view-tag.md) +* [`window.open` 함수](api/window-open.md) + +메인 프로세스를 위한 모듈들: + +* [app](api/app.md) +* [auto-updater](api/auto-updater.md) +* [browser-window](api/browser-window.md) +* [content-tracing](api/content-tracing.md) +* [dialog](api/dialog.md) +* [global-shortcut](api/global-shortcut.md) +* [ipc (main process)](api/ipc-main-process.md) +* [menu](api/menu.md) +* [menu-item](api/menu-item.md) +* [power-monitor](api/power-monitor.md) +* [power-save-blocker](api/power-save-blocker.md) +* [protocol](api/protocol.md) +* [tray](api/tray.md) + +랜더러 프로세스를 위한 모듈들 (웹 페이지): + +* [ipc (renderer)](api/ipc-renderer.md) +* [remote](api/remote.md) +* [web-frame](api/web-frame.md) + +두 프로세스에서 모두 사용 가능한 모듈들: + +* [clipboard](api/clipboard.md) +* [crash-reporter](api/crash-reporter.md) +* [native-image](api/native-image.md) +* [screen](api/screen.md) +* [shell](api/shell.md) + +## 개발자용 + +* [코딩 스타일](development/coding-style.md) +* [소스 코드 디렉터리 구조](development/source-code-directory-structure.md) +* [NW.js와 기술적으로 다른점 (이전 node-webkit)](development/atom-shell-vs-node-webkit.md) +* [빌드 시스템 개요](development/build-system-overview.md) +* [빌드 설명서 (Mac)](development/build-instructions-mac.md) +* [빌드 설명서 (Windows)](development/build-instructions-windows.md) +* [빌드 설명서 (Linux)](development/build-instructions-linux.md) +* [디버거에서 디버그 심볼 서버 설정](development/setting-up-symbol-server.md) diff --git a/docs-translations/ko/api/accelerator-ko.md b/docs-translations/ko/api/accelerator.md similarity index 100% rename from docs-translations/ko/api/accelerator-ko.md rename to docs-translations/ko/api/accelerator.md diff --git a/docs-translations/ko/api/auto-updater-ko.md b/docs-translations/ko/api/auto-updater.md similarity index 100% rename from docs-translations/ko/api/auto-updater-ko.md rename to docs-translations/ko/api/auto-updater.md diff --git a/docs-translations/ko/api/chrome-command-line-switches-ko.md b/docs-translations/ko/api/chrome-command-line-switches.md similarity index 97% rename from docs-translations/ko/api/chrome-command-line-switches-ko.md rename to docs-translations/ko/api/chrome-command-line-switches.md index 7d1a7011eff6..5b9bf4722042 100644 --- a/docs-translations/ko/api/chrome-command-line-switches-ko.md +++ b/docs-translations/ko/api/chrome-command-line-switches.md @@ -62,9 +62,9 @@ Hostname 맵핑 규칙을 설정합니다. (`,`로 분리) `--host-rules` 플래그와 비슷하지만 이 플래그는 host resolver에만 적용됩니다. -[app]: app-ko.md -[append-switch]: app-ko.md#appcommandlineappendswitchswitch-value -[ready]: app-ko.md#event-ready +[app]: app.md +[append-switch]: app.md#appcommandlineappendswitchswitch-value +[ready]: app.md#event-ready ## --ignore-certificate-errors diff --git a/docs-translations/ko/api/clipboard-ko.md b/docs-translations/ko/api/clipboard.md similarity index 94% rename from docs-translations/ko/api/clipboard-ko.md rename to docs-translations/ko/api/clipboard.md index bc6c82786cb7..a6b29c2a377f 100644 --- a/docs-translations/ko/api/clipboard-ko.md +++ b/docs-translations/ko/api/clipboard.md @@ -45,11 +45,11 @@ console.log(clipboard.readText('selection')); * `type` String -클립보드로부터 [NativeImage](native-image-ko.md)로 이미지를 읽어들입니다. +클립보드로부터 [NativeImage](native-image.md)로 이미지를 읽어들입니다. ## clipboard.writeImage(image[, type]) -* `image` [NativeImage](native-image-ko.md) +* `image` [NativeImage](native-image.md) * `type` String 클립보드에 `image`를 씁니다. diff --git a/docs-translations/ko/api/content-tracing-ko.md b/docs-translations/ko/api/content-tracing.md similarity index 100% rename from docs-translations/ko/api/content-tracing-ko.md rename to docs-translations/ko/api/content-tracing.md diff --git a/docs-translations/ko/api/crash-reporter-ko.md b/docs-translations/ko/api/crash-reporter.md similarity index 100% rename from docs-translations/ko/api/crash-reporter-ko.md rename to docs-translations/ko/api/crash-reporter.md diff --git a/docs-translations/ko/api/dialog-ko.md b/docs-translations/ko/api/dialog.md similarity index 99% rename from docs-translations/ko/api/dialog-ko.md rename to docs-translations/ko/api/dialog.md index 2f24c659f913..4f151f0b1ebb 100644 --- a/docs-translations/ko/api/dialog-ko.md +++ b/docs-translations/ko/api/dialog.md @@ -77,7 +77,7 @@ Windows와 Linux에선 파일 선택 모드, 디렉터리 선택 모드를 동 * `title` String - 대화 상자의 제목입니다. 몇몇 플랫폼에선 보이지 않을 수 있습니다. * `message` String - 대화 상자의 본문 내용입니다. * `detail` String - 메시지의 추가 정보입니다. - * `icon` [NativeImage](native-image-ko.md) + * `icon` [NativeImage](native-image.md) * `cancelId` Integer - 유저가 대화 상자의 버튼을 클릭하지 않고 대화 상자를 취소했을 때 반환되는 버튼의 index입니다. 기본적으로 버튼 리스트가 "cancel" 또는 "no" 라벨을 가지고 있을 때 해당 버튼의 index를 반환합니다. 따로 두 라벨이 지정되지 않은 경우 0을 반환합니다. OS X와 Windows에선 `cancelId` 지정 여부에 상관없이 "Cancel" 버튼이 언제나 `cancelId`로 지정됩니다. diff --git a/docs-translations/ko/api/file-object-ko.md b/docs-translations/ko/api/file-object.md similarity index 100% rename from docs-translations/ko/api/file-object-ko.md rename to docs-translations/ko/api/file-object.md diff --git a/docs-translations/ko/api/frameless-window-ko.md b/docs-translations/ko/api/frameless-window.md similarity index 97% rename from docs-translations/ko/api/frameless-window-ko.md rename to docs-translations/ko/api/frameless-window.md index 420b277d9b17..3dc45b824fd1 100644 --- a/docs-translations/ko/api/frameless-window-ko.md +++ b/docs-translations/ko/api/frameless-window.md @@ -4,7 +4,7 @@ Frameless 윈도우는 테두리가 없는 윈도우 창을 말합니다. ## Frameless 윈도우 만들기 -Frameless 윈도우를 만드려면 [BrowserWindow](browser-window-ko.md) 객체의 `options`에서 `frame` 옵션을 `false`로 지정하기만 하면됩니다: +Frameless 윈도우를 만드려면 [BrowserWindow](browser-window.md) 객체의 `options`에서 `frame` 옵션을 `false`로 지정하기만 하면됩니다: ```javascript var BrowserWindow = require('browser-window'); diff --git a/docs-translations/ko/api/global-shortcut-ko.md b/docs-translations/ko/api/global-shortcut.md similarity index 92% rename from docs-translations/ko/api/global-shortcut-ko.md rename to docs-translations/ko/api/global-shortcut.md index 25c1d320870e..d99085f448e5 100644 --- a/docs-translations/ko/api/global-shortcut-ko.md +++ b/docs-translations/ko/api/global-shortcut.md @@ -32,20 +32,20 @@ app.on('will-quit', function() { ## globalShortcut.register(accelerator, callback) -* `accelerator` [Accelerator](accelerator-ko.md) +* `accelerator` [Accelerator](accelerator.md) * `callback` Function `accelerator`로 표현된 전역 단축키를 등록합니다. 유저로부터 등록된 단축키가 눌렸을 경우 `callback` 함수가 호출됩니다. ## globalShortcut.isRegistered(accelerator) -* `accelerator` [Accelerator](accelerator-ko.md) +* `accelerator` [Accelerator](accelerator.md) 지정된 `accelerator` 단축키가 등록되었는지 여부를 확인합니다. 반환값은 boolean(true, false) 입니다. ## globalShortcut.unregister(accelerator) -* `accelerator` [Accelerator](accelerator-ko.md) +* `accelerator` [Accelerator](accelerator.md) `키코드`에 해당하는 전역 단축키를 등록 해제합니다. diff --git a/docs-translations/ko/api/ipc-main-process-ko.md b/docs-translations/ko/api/ipc-main-process.md similarity index 92% rename from docs-translations/ko/api/ipc-main-process-ko.md rename to docs-translations/ko/api/ipc-main-process.md index 7d0aba08efa5..7f6a091de46d 100644 --- a/docs-translations/ko/api/ipc-main-process-ko.md +++ b/docs-translations/ko/api/ipc-main-process.md @@ -6,7 +6,7 @@ 동기 메시지는 `event.returnValue`를 이용하여 반환값(답장)을 설정할 수 있습니다. 비동기 메시지라면 `event.sender.send(...)`를 사용하면 됩니다. 또한 메인 프로세스에서 랜더러 프로세스로 메시지를 보내는 것도 가능합니다. -자세한 내용은 [WebContents.send](browser-window-ko.md#webcontentssendchannel-args)를 참고 하세요. +자세한 내용은 [WebContents.send](browser-window.md#webcontentssendchannel-args)를 참고 하세요. 보내진 메시지들을 처리하는 예제입니다: diff --git a/docs-translations/ko/api/ipc-renderer-ko.md b/docs-translations/ko/api/ipc-renderer.md similarity index 85% rename from docs-translations/ko/api/ipc-renderer-ko.md rename to docs-translations/ko/api/ipc-renderer.md index e4664480447f..b8bbb7ffa14d 100644 --- a/docs-translations/ko/api/ipc-renderer-ko.md +++ b/docs-translations/ko/api/ipc-renderer.md @@ -1,9 +1,9 @@ # ipc (renderer) `ipc` 모듈은 메인 프로세스로 메시지를 동기 또는 비동기로 보내고 받을 수 있는 몇 가지 방법을 제공합니다. -만약 랜더러 프로세스에서 메인 프로세스의 모듈을 직접적으로 사용하고 싶다면 [remote](remote-ko.md) 모듈을 사용하는 것을 고려해보는 것이 좋습니다. +만약 랜더러 프로세스에서 메인 프로세스의 모듈을 직접적으로 사용하고 싶다면 [remote](remote.md) 모듈을 사용하는 것을 고려해보는 것이 좋습니다. -[ipc (main process)](ipc-main-process-ko.md)에서 예제를 볼 수 있습니다. +[ipc (main process)](ipc-main-process.md)에서 예제를 볼 수 있습니다. ## ipc.send(channel[, args...]) diff --git a/docs-translations/ko/api/menu-item-ko.md b/docs-translations/ko/api/menu-item.md similarity index 90% rename from docs-translations/ko/api/menu-item-ko.md rename to docs-translations/ko/api/menu-item.md index 8477451ff965..519b7fb237a3 100644 --- a/docs-translations/ko/api/menu-item-ko.md +++ b/docs-translations/ko/api/menu-item.md @@ -10,8 +10,8 @@ * `type` String - `MenuItem`의 타입 `normal`, `separator`, `submenu`, `checkbox` 또는 `radio` 사용가능 * `label` String * `sublabel` String - * `accelerator` [Accelerator](accelerator-ko.md) - * `icon` [NativeImage](native-image-ko.md) + * `accelerator` [Accelerator](accelerator.md) + * `icon` [NativeImage](native-image.md) * `enabled` Boolean * `visible` Boolean * `checked` Boolean diff --git a/docs-translations/ko/api/menu-ko.md b/docs-translations/ko/api/menu.md similarity index 95% rename from docs-translations/ko/api/menu-ko.md rename to docs-translations/ko/api/menu.md index 7f2b5ad90c80..3303a55d05f2 100644 --- a/docs-translations/ko/api/menu-ko.md +++ b/docs-translations/ko/api/menu.md @@ -3,7 +3,7 @@ `Menu` 클래스는 어플리케이션 메뉴와 컨텍스트 메뉴를 만들 때 사용됩니다. 메뉴는 여러 개의 메뉴 아이템으로 구성되고 서브 메뉴를 가질 수도 있습니다. -다음 예제는 웹 페이지 내에서 [remote](remote-ko.md) 모듈을 활용하여 동적으로 메뉴를 생성하는 예제입니다. +다음 예제는 웹 페이지 내에서 [remote](remote.md) 모듈을 활용하여 동적으로 메뉴를 생성하는 예제입니다. 이 예제에서 만들어진 메뉴는 유저가 페이지에서 오른쪽 클릭을 할 때 마우스 위치에 팝업 형태로 표시됩니다: @@ -28,7 +28,7 @@ window.addEventListener('contextmenu', function (e) { 다음 예제는 template API를 활용하여 어플리케이션 메뉴를 만드는 간단한 예제입니다: -**Windows 와 Linux 유저 주의:** 각 메뉴 아이템의 `selector` 멤버는 Mac 운영체제 전용입니다. [Accelerator 옵션](https://github.com/atom/electron/blob/master/docs/api/accelerator-ko.md) +**Windows 와 Linux 유저 주의:** 각 메뉴 아이템의 `selector` 멤버는 Mac 운영체제 전용입니다. [Accelerator 옵션](accelerator.md) ```html @@ -189,7 +189,7 @@ Menu.setApplicationMenu(menu); * `template` Array -기본적으로 `template`는 [MenuItem](menu-item-ko.md)을 생성할 때 사용하는 `options`의 배열입니다. 사용법은 위에서 설명한 것과 같습니다. +기본적으로 `template`는 [MenuItem](menu-item.md)을 생성할 때 사용하는 `options`의 배열입니다. 사용법은 위에서 설명한 것과 같습니다. 또한 `template`에는 다른 속성도 추가할 수 있으며 메뉴가 만들어질 때 해당 메뉴 아이템의 프로퍼티로 변환됩니다. diff --git a/docs-translations/ko/api/native-image-ko.md b/docs-translations/ko/api/native-image.md similarity index 100% rename from docs-translations/ko/api/native-image-ko.md rename to docs-translations/ko/api/native-image.md diff --git a/docs-translations/ko/api/power-monitor-ko.md b/docs-translations/ko/api/power-monitor.md similarity index 100% rename from docs-translations/ko/api/power-monitor-ko.md rename to docs-translations/ko/api/power-monitor.md diff --git a/docs-translations/ko/api/power-save-blocker-ko.md b/docs-translations/ko/api/power-save-blocker.md similarity index 100% rename from docs-translations/ko/api/power-save-blocker-ko.md rename to docs-translations/ko/api/power-save-blocker.md diff --git a/docs-translations/ko/api/process-ko.md b/docs-translations/ko/api/process.md similarity index 100% rename from docs-translations/ko/api/process-ko.md rename to docs-translations/ko/api/process.md diff --git a/docs-translations/ko/api/protocol-ko.md b/docs-translations/ko/api/protocol.md similarity index 100% rename from docs-translations/ko/api/protocol-ko.md rename to docs-translations/ko/api/protocol.md diff --git a/docs-translations/ko/api/remote-ko.md b/docs-translations/ko/api/remote.md similarity index 99% rename from docs-translations/ko/api/remote-ko.md rename to docs-translations/ko/api/remote.md index 64232bdc31af..c2713db4a910 100644 --- a/docs-translations/ko/api/remote-ko.md +++ b/docs-translations/ko/api/remote.md @@ -70,7 +70,7 @@ remote.getCurrentWindow().on('close', function() { ## remote.getCurrentWindow() -현재 웹 페이지가 들어있는 [BrowserWindow](browser-window-ko.md) 객체를 반환합니다. +현재 웹 페이지가 들어있는 [BrowserWindow](browser-window.md) 객체를 반환합니다. ## remote.getCurrentWebContents() diff --git a/docs-translations/ko/api/screen-ko.md b/docs-translations/ko/api/screen.md similarity index 100% rename from docs-translations/ko/api/screen-ko.md rename to docs-translations/ko/api/screen.md diff --git a/docs-translations/ko/api/shell-ko.md b/docs-translations/ko/api/shell.md similarity index 100% rename from docs-translations/ko/api/shell-ko.md rename to docs-translations/ko/api/shell.md diff --git a/docs-translations/ko/api/synopsis-ko.md b/docs-translations/ko/api/synopsis.md similarity index 81% rename from docs-translations/ko/api/synopsis-ko.md rename to docs-translations/ko/api/synopsis.md index 8754f2f15bf2..69ee4af354c7 100644 --- a/docs-translations/ko/api/synopsis-ko.md +++ b/docs-translations/ko/api/synopsis.md @@ -1,11 +1,11 @@ # 개요 -Electron은 모든 [node.js's built-in 모듈](http://nodejs.org/api/)과 third-party node 모듈을 완벽하게 지원합니다. ([네이티브 모듈](../tutorial/using-native-node-modules-ko.md)을 포함해서) +Electron은 모든 [node.js's built-in 모듈](http://nodejs.org/api/)과 third-party node 모듈을 완벽하게 지원합니다. ([네이티브 모듈](../tutorial/using-native-node-modules.md)을 포함해서) Electron은 네이티브 데스크톱 어플리케이션을 개발 할 수 있도록 추가적인 built-in 모듈을 제공합니다. 몇몇 모듈은 메인 프로세스에서만 사용할 수 있고 어떤 모듈은 랜더러 프로세스에서만 사용할 수 있습니다. 또한 두 프로세스 모두 사용할 수 있는 모듈도 있습니다. 기본적인 규칙은 다음과 같습니다: GUI와 저 수준 시스템에 관련된 모듈은 오직 메인 프로세스에서만 사용할 수 있습니다. -[메인 프로세스 vs. 랜더러 프로세스](../tutorial/quick-start-ko.md#메인 프로세스) 컨셉에 익숙해야 이 모듈들을 사용하기 쉬우므로 해당 문서를 정독하는 것을 권장합니다. +[메인 프로세스 vs. 랜더러 프로세스](../tutorial/quick-start.md#메인 프로세스) 컨셉에 익숙해야 이 모듈들을 사용하기 쉬우므로 해당 문서를 정독하는 것을 권장합니다. 메인 프로세스 스크립트는 일반 `node.js` 스크립트와 같습니다: @@ -36,4 +36,4 @@ app.on('ready', function() { ``` -어플리케이션을 실행하려면 [앱 실행하기](../tutorial/quick-start-ko.md#앱 실행하기) 문서를 참고하기 바랍니다. +어플리케이션을 실행하려면 [앱 실행하기](../tutorial/quick-start.md#앱 실행하기) 문서를 참고하기 바랍니다. diff --git a/docs-translations/ko/api/tray-ko.md b/docs-translations/ko/api/tray.md similarity index 96% rename from docs-translations/ko/api/tray-ko.md rename to docs-translations/ko/api/tray.md index a32ccbb1d0e2..05decef5a48f 100644 --- a/docs-translations/ko/api/tray-ko.md +++ b/docs-translations/ko/api/tray.md @@ -38,7 +38,7 @@ __플랫폼별 한계:__ ### new Tray(image) -* `image` [NativeImage](native-image-ko.md) +* `image` [NativeImage](native-image.md) 전달된 `image`를 이용하여 트레이 아이콘을 만듭니다. @@ -126,13 +126,13 @@ __주의:__ 이 기능은 OS X에서만 작동합니다. ### Tray.setImage(image) -* `image` [NativeImage](native-image-ko.md) +* `image` [NativeImage](native-image.md) `image`를 사용하여 트레이 아이콘의 이미지를 설정합니다. ### Tray.setPressedImage(image) -* `image` [NativeImage](native-image-ko.md) +* `image` [NativeImage](native-image.md) `image`를 사용하여 트레이 아이콘이 눌렸을 때의 이미지를 설정합니다. @@ -163,7 +163,7 @@ __주의:__ 이 기능은 OS X에서만 작동합니다. ### Tray.displayBalloon(options) * `options` Object - * `icon` [NativeImage](native-image-ko.md) + * `icon` [NativeImage](native-image.md) * `title` String * `content` String diff --git a/docs-translations/ko/api/web-frame-ko.md b/docs-translations/ko/api/web-frame.md similarity index 100% rename from docs-translations/ko/api/web-frame-ko.md rename to docs-translations/ko/api/web-frame.md diff --git a/docs-translations/ko/api/web-view-tag-ko.md b/docs-translations/ko/api/web-view-tag.md similarity index 99% rename from docs-translations/ko/api/web-view-tag-ko.md rename to docs-translations/ko/api/web-view-tag.md index 32a5a835516f..d2efdf17ea1f 100644 --- a/docs-translations/ko/api/web-view-tag-ko.md +++ b/docs-translations/ko/api/web-view-tag.md @@ -311,7 +311,7 @@ Webview 페이지를 PDF 형식으로 인쇄합니다. `webContents.printToPDF(o `channel`을 통해 게스트 페이지에 `args...` 비동기 메시지를 보냅니다. 게스트 페이지에선 `ipc` 모듈의 `channel` 이벤트를 사용하면 이 메시지를 받을 수 있습니다. -예제는 [WebContents.send](browser-window-ko.md#webcontentssendchannel-args)를 참고하세요. +예제는 [WebContents.send](browser-window.md#webcontentssendchannel-args)를 참고하세요. ## DOM 이벤트 diff --git a/docs-translations/ko/api/window-open-ko.md b/docs-translations/ko/api/window-open.md similarity index 100% rename from docs-translations/ko/api/window-open-ko.md rename to docs-translations/ko/api/window-open.md diff --git a/docs-translations/ko/development/atom-shell-vs-node-webkit-ko.md b/docs-translations/ko/development/atom-shell-vs-node-webkit.md similarity index 100% rename from docs-translations/ko/development/atom-shell-vs-node-webkit-ko.md rename to docs-translations/ko/development/atom-shell-vs-node-webkit.md diff --git a/docs-translations/ko/development/build-instructions-linux-ko.md b/docs-translations/ko/development/build-instructions-linux.md similarity index 100% rename from docs-translations/ko/development/build-instructions-linux-ko.md rename to docs-translations/ko/development/build-instructions-linux.md diff --git a/docs-translations/ko/development/build-instructions-mac-ko.md b/docs-translations/ko/development/build-instructions-mac.md similarity index 100% rename from docs-translations/ko/development/build-instructions-mac-ko.md rename to docs-translations/ko/development/build-instructions-mac.md diff --git a/docs-translations/ko/development/build-instructions-windows-ko.md b/docs-translations/ko/development/build-instructions-windows.md similarity index 100% rename from docs-translations/ko/development/build-instructions-windows-ko.md rename to docs-translations/ko/development/build-instructions-windows.md diff --git a/docs-translations/ko/development/build-system-overview-ko.md b/docs-translations/ko/development/build-system-overview.md similarity index 100% rename from docs-translations/ko/development/build-system-overview-ko.md rename to docs-translations/ko/development/build-system-overview.md diff --git a/docs-translations/ko/development/coding-style-ko.md b/docs-translations/ko/development/coding-style.md similarity index 100% rename from docs-translations/ko/development/coding-style-ko.md rename to docs-translations/ko/development/coding-style.md diff --git a/docs-translations/ko/development/setting-up-symbol-server-ko.md b/docs-translations/ko/development/setting-up-symbol-server.md similarity index 100% rename from docs-translations/ko/development/setting-up-symbol-server-ko.md rename to docs-translations/ko/development/setting-up-symbol-server.md diff --git a/docs-translations/ko/development/source-code-directory-structure-ko.md b/docs-translations/ko/development/source-code-directory-structure.md similarity index 100% rename from docs-translations/ko/development/source-code-directory-structure-ko.md rename to docs-translations/ko/development/source-code-directory-structure.md diff --git a/docs-translations/ko/tutorial/application-distribution-ko.md b/docs-translations/ko/tutorial/application-distribution.md similarity index 99% rename from docs-translations/ko/tutorial/application-distribution-ko.md rename to docs-translations/ko/tutorial/application-distribution.md index 043ced1ec47c..fac2ae48a140 100644 --- a/docs-translations/ko/tutorial/application-distribution-ko.md +++ b/docs-translations/ko/tutorial/application-distribution.md @@ -48,7 +48,7 @@ electron/resources/ └── app.asar ``` -자세한 내용은 [어플리케이션 패키징](application-packaging-ko.md)에서 찾아볼 수 있습니다. +자세한 내용은 [어플리케이션 패키징](application-packaging.md)에서 찾아볼 수 있습니다. ## 다운로드한 바이너리의 리소스를 앱에 맞게 수정하기 diff --git a/docs-translations/ko/tutorial/application-packaging-ko.md b/docs-translations/ko/tutorial/application-packaging.md similarity index 100% rename from docs-translations/ko/tutorial/application-packaging-ko.md rename to docs-translations/ko/tutorial/application-packaging.md diff --git a/docs-translations/ko/tutorial/debugging-main-process-ko.md b/docs-translations/ko/tutorial/debugging-main-process.md similarity index 100% rename from docs-translations/ko/tutorial/debugging-main-process-ko.md rename to docs-translations/ko/tutorial/debugging-main-process.md diff --git a/docs-translations/ko/tutorial/desktop-environment-integration-ko.md b/docs-translations/ko/tutorial/desktop-environment-integration.md similarity index 95% rename from docs-translations/ko/tutorial/desktop-environment-integration-ko.md rename to docs-translations/ko/tutorial/desktop-environment-integration.md index 68f5562dbb52..9d1b5ffadcc4 100644 --- a/docs-translations/ko/tutorial/desktop-environment-integration-ko.md +++ b/docs-translations/ko/tutorial/desktop-environment-integration.md @@ -211,12 +211,12 @@ window.setRepresentedFilename('/etc/passwd'); window.setDocumentEdited(true); ``` -[addrecentdocument]: ../api/app-ko.md#appaddrecentdocumentpath -[clearrecentdocuments]: ../api/app-ko.md#appclearrecentdocuments -[setusertaskstasks]: ../api/app-ko.md#appsetusertaskstasks -[setprogressbar]: ../api/browser-window-ko.md#browserwindowsetprogressbarprogress -[setrepresentedfilename]: ../api/browser-window-ko.md#browserwindowsetrepresentedfilenamefilename -[setdocumentedited]: ../api/browser-window-ko.md#browserwindowsetdocumenteditededited +[addrecentdocument]: ../api/app.md#appaddrecentdocumentpath +[clearrecentdocuments]: ../api/app.md#appclearrecentdocuments +[setusertaskstasks]: ../api/app.md#appsetusertaskstasks +[setprogressbar]: ../api/browser-window.md#browserwindowsetprogressbarprogress +[setrepresentedfilename]: ../api/browser-window.md#browserwindowsetrepresentedfilenamefilename +[setdocumentedited]: ../api/browser-window.md#browserwindowsetdocumenteditededited [app-registration]: http://msdn.microsoft.com/en-us/library/windows/desktop/ee872121(v=vs.85).aspx [unity-launcher]: https://help.ubuntu.com/community/UnityLaunchersAndDesktopFiles#Adding_shortcuts_to_a_launcher [setthumbarbuttons]: ../api/browser-window.md#browserwindowsetthumbarbuttonsbuttons diff --git a/docs-translations/ko/tutorial/devtools-extension-ko.md b/docs-translations/ko/tutorial/devtools-extension.md similarity index 100% rename from docs-translations/ko/tutorial/devtools-extension-ko.md rename to docs-translations/ko/tutorial/devtools-extension.md diff --git a/docs-translations/ko/tutorial/online-offline-events-ko.md b/docs-translations/ko/tutorial/online-offline-events.md similarity index 100% rename from docs-translations/ko/tutorial/online-offline-events-ko.md rename to docs-translations/ko/tutorial/online-offline-events.md diff --git a/docs-translations/ko/tutorial/quick-start-ko.md b/docs-translations/ko/tutorial/quick-start.md similarity index 92% rename from docs-translations/ko/tutorial/quick-start-ko.md rename to docs-translations/ko/tutorial/quick-start.md index 1d548c6f01c0..7564f1c8c4c9 100644 --- a/docs-translations/ko/tutorial/quick-start-ko.md +++ b/docs-translations/ko/tutorial/quick-start.md @@ -33,8 +33,8 @@ Electron 프로세스 내에서 작동하는 웹 페이지는 __랜더러 프로 기본적으로 웹 페이지 내에서는 네이티브 GUI와 관련된 API를 호출할 수 없도록 되어 있습니다. 만약 웹 페이지 내에서 GUI작업이 필요하다면 메인 프로세스에서 그 작업을 할 수 있도록 메인 프로세스와 통신을 해야합니다. -Electron에는 메인 프로세스와 랜더러 프로세스간에 통신을 할 수 있도록 [ipc](../api/ipc-renderer-ko.md) 모듈을 제공하고 있습니다. -또한 [remote](../api/remote-ko.md) 모듈을 사용하여 RPC 스타일로 통신할 수도 있습니다. +Electron에는 메인 프로세스와 랜더러 프로세스간에 통신을 할 수 있도록 [ipc](../api/ipc-renderer.md) 모듈을 제공하고 있습니다. +또한 [remote](../api/remote.md) 모듈을 사용하여 RPC 스타일로 통신할 수도 있습니다. ## 첫번째 Electron 앱 만들기 @@ -121,7 +121,7 @@ app.on('ready', function() { ## 앱 실행하기 -앱을 작성한 후 [어플리케이션 배포](./application-distribution-ko.md) 가이드를 따라 앱을 패키징 하고 패키징한 앱을 실행할 수 있습니다. +앱을 작성한 후 [어플리케이션 배포](application-distribution.md) 가이드를 따라 앱을 패키징 하고 패키징한 앱을 실행할 수 있습니다. 또는 Electron 실행파일을 다운로드 받아 바로 실행해 볼 수도 있습니다. ### electron-prebuilt @@ -173,4 +173,4 @@ $ ./Electron.app/Contents/MacOS/Electron your-app/ ### 배포용 파일 만들기 -어플리케이션 작성을 완료했다면 [어플리케이션 배포](./application-distribution-ko.md) 가이드를 통해 본격적으로 제작한 앱을 배포할 수 있습니다. \ No newline at end of file +어플리케이션 작성을 완료했다면 [어플리케이션 배포](application-distribution.md) 가이드를 통해 본격적으로 제작한 앱을 배포할 수 있습니다. \ No newline at end of file diff --git a/docs-translations/ko/tutorial/using-native-node-modules-ko.md b/docs-translations/ko/tutorial/using-native-node-modules.md similarity index 100% rename from docs-translations/ko/tutorial/using-native-node-modules-ko.md rename to docs-translations/ko/tutorial/using-native-node-modules.md diff --git a/docs-translations/ko/tutorial/using-pepper-flash-plugin-ko.md b/docs-translations/ko/tutorial/using-pepper-flash-plugin.md similarity index 100% rename from docs-translations/ko/tutorial/using-pepper-flash-plugin-ko.md rename to docs-translations/ko/tutorial/using-pepper-flash-plugin.md diff --git a/docs-translations/ko/tutorial/using-selenium-and-webdriver-ko.md b/docs-translations/ko/tutorial/using-selenium-and-webdriver.md similarity index 95% rename from docs-translations/ko/tutorial/using-selenium-and-webdriver-ko.md rename to docs-translations/ko/tutorial/using-selenium-and-webdriver.md index 80b56e23ada1..069a49e52798 100644 --- a/docs-translations/ko/tutorial/using-selenium-and-webdriver-ko.md +++ b/docs-translations/ko/tutorial/using-selenium-and-webdriver.md @@ -69,6 +69,6 @@ driver.quit(); ## 작업환경 따로 Electron을 다시 빌드하지 않는 경우 간단히 어플리케이션을 Electron의 리소스 디렉터리에 -[배치](https://github.com/atom/electron/blob/master/docs/tutorial/application-distribution-ko.md)하여 바로 테스트 할 수 있습니다. +[배치](application-distribution.md)하여 바로 테스트 할 수 있습니다. [chrome-driver]: https://sites.google.com/a/chromium.org/chromedriver/ From eea04e513d7ed92ac8a6d50e747e00c89ac0ce5b Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Tue, 25 Aug 2015 22:46:28 +0900 Subject: [PATCH 0952/1293] Update as upstream --- .../ko/development/coding-style.md | 7 +++ .../tutorial/using-selenium-and-webdriver.md | 49 ++++++++++++++++++- 2 files changed, 55 insertions(+), 1 deletion(-) diff --git a/docs-translations/ko/development/coding-style.md b/docs-translations/ko/development/coding-style.md index 92aa3b4ed173..1b88be8487c1 100644 --- a/docs-translations/ko/development/coding-style.md +++ b/docs-translations/ko/development/coding-style.md @@ -4,8 +4,15 @@ C++과 Python스크립트는 Chromium의 [코딩 스타일](http://www.chromium.org/developers/coding-style)을 따릅니다. 파이선 스크립트 `script/cpplint.py`를 사용하여 모든 파일이 해당 코딩스타일에 맞게 코딩 되었는지 확인할 수 있습니다. + 파이선의 버전은 2.7을 사용합니다. +C++ 코드는 많은 Chromium의 추상화와 타입을 사용합니다. 그래서 이에 대해 잘 알고 있어야 합니다. +이와 관련하여 시작하기 좋은 장소로 Chromium의 [Important Abstractions and Data Structures] +(https://www.chromium.org/developers/coding-style/important-abstractions-and-data-structures) 문서가 있습니다. +이 문서에선 몇가지 특별한 타입과 스코프 타입(스코프 밖으로 나가면 자동으로 메모리에서 할당을 해제합니다. 스마트 포인터로 보시면 됩니다), +로깅 메커니즘 등을 언급하고 있습니다. + ## CoffeeScript CoffeeScript의 경우 GitHub의 [스타일 가이드](https://github.com/styleguide/javascript)를 따릅니다. 동시에 다음 규칙도 따릅니다: diff --git a/docs-translations/ko/tutorial/using-selenium-and-webdriver.md b/docs-translations/ko/tutorial/using-selenium-and-webdriver.md index 069a49e52798..b6178184d661 100644 --- a/docs-translations/ko/tutorial/using-selenium-and-webdriver.md +++ b/docs-translations/ko/tutorial/using-selenium-and-webdriver.md @@ -29,7 +29,7 @@ Starting ChromeDriver (v2.10.291558) on port 9515 Only local connections are allowed. ``` -곧 사용하므로 포트 `9515`를 기억해 놓습니다. +포트 `9515`는 나중에 사용하므로 기억해 놓읍시다 ### 2. WebDriverJS 설치 @@ -66,6 +66,53 @@ driver.wait(function() { driver.quit(); ``` +## WebdriverIO 설정하기 + +[WebdriverIO](http://webdriver.io/)는 웹 드라이버와 함께 테스트를 위해 제공되는 node 패키지입니다. + +### 1. 크롬 드라이버 시작 + +먼저, `chromedriver` 바이너리를 다운로드 받고 실행합니다: + +```bash +$ chromedriver --url-base=/wd/hub --port=9515 +Starting ChromeDriver (v2.10.291558) on port 9515 +Only local connections are allowed. +``` + +포트 `9515`는 나중에 사용하므로 기억해 놓읍시다 + +### 2. WebDriverIO 설치 + +```bash +$ npm install webdriverio +``` + +### 3. 크롬 드라이버에 연결 +```javascript +var webdriverio = require('webdriverio'); +var options = { + host: "localhost", // Use localhost as chrome driver server + port: 9515, // "9515" is the port opened by chrome driver. + desiredCapabilities: { + browserName: 'chrome', + chromeOptions: {binary: '/Path-to-Your-App.app/Electron'} // Path to your Electron binary. + } +}; + +var client = webdriverio.remote(options); + +client + .init() + .url('http://google.com') + .setValue('#q', 'webdriverio') + .click('#btnG') + .getTitle().then(function(title) { + console.log('Title was: ' + title); + }) + .end(); +``` + ## 작업환경 따로 Electron을 다시 빌드하지 않는 경우 간단히 어플리케이션을 Electron의 리소스 디렉터리에 From 28a4069520c2ca8f753ab74fc44e436943db3303 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Tue, 25 Aug 2015 10:05:48 -0700 Subject: [PATCH 0953/1293] =?UTF-8?q?Mac=20=E2=86=92=20OS=20X?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/styleguide.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/styleguide.md b/docs/styleguide.md index 9a81771598d2..23c590e64211 100644 --- a/docs/styleguide.md +++ b/docs/styleguide.md @@ -24,7 +24,7 @@ These are the ways that we construct the Electron documentation. - Optional arguments are denoted when called out in list. - Line length is 80-column wrapped. - Platform specific methods are noted in italics following method header. - - ```### `method(foo, bar)` _Mac_``` + - ```### `method(foo, bar)` _OS X_``` ## Reading Electron Documentation From aeb37941bb32d6c28723e4d50947e9f36c300fdf Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Tue, 25 Aug 2015 10:12:21 -0700 Subject: [PATCH 0954/1293] Replace platform notes with one general note --- docs/api/app.md | 17 ++--------------- 1 file changed, 2 insertions(+), 15 deletions(-) diff --git a/docs/api/app.md b/docs/api/app.md index 7e5ec57d5a41..db34d37ec59e 100644 --- a/docs/api/app.md +++ b/docs/api/app.md @@ -152,6 +152,8 @@ Emitted when the gpu process crashes. The `app` object has the following methods: +**Note** Some methods are only available on specific operating systems and are labeled as such. + ### `app.quit()` Try to close all windows. The `before-quit` event will emitted first. If all @@ -267,7 +269,6 @@ Adds `tasks` to the [Tasks][tasks] category of the JumpList on Windows. consists of two or more icons, set this value to identify the icon. If an icon file consists of one icon, this value is 0. -**Note:** This API is only available on Windows. ### `app.commandLine.appendSwitch(switch[, value])` @@ -297,49 +298,35 @@ or the request is canceled. Returns an ID representing the request. -**Note:** This API is only available on OS X. - ### `app.dock.cancelBounce(id)` _OS X_ * `id` Integer Cancel the bounce of `id`. -**Note:** This API is only available on OS X. - ### `app.dock.setBadge(text)` _OS X_ * `text` String Sets the string to be displayed in the dock’s badging area. -**Note:** This API is only available on OS X. - ### `app.dock.getBadge()` _OS X_ Returns the badge string of the dock. -**Note:** This API is only available on OS X. - ### `app.dock.hide()` _OS X_ Hides the dock icon. -**Note:** This API is only available on OS X. - ### `app.dock.show()` _OS X_ Shows the dock icon. -**Note:** This API is only available on OS X. - ### `app.dock.setMenu(menu)` _OS X_ * `menu` Menu Sets the application's [dock menu][dock-menu]. -**Note:** This API is only available on OS X. - [dock-menu]:https://developer.apple.com/library/mac/documentation/Carbon/Conceptual/customizing_docktile/concepts/dockconcepts.html#//apple_ref/doc/uid/TP30000986-CH2-TPXREF103 [tasks]:http://msdn.microsoft.com/en-us/library/windows/desktop/dd378460(v=vs.85).aspx#tasks From 5a8f60fe32f0c4ff7505c4c92b5196ebbaaacd66 Mon Sep 17 00:00:00 2001 From: Eran Tiktin Date: Tue, 25 Aug 2015 23:28:41 +0300 Subject: [PATCH 0955/1293] Update build-instructions-windows The build instructions mistakenly said that you can find `atom.exe` under `out\D` instead of `electron.exe`. I fixed that and mentioned that the release build will be to `out\R`. --- docs/development/build-instructions-windows.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/development/build-instructions-windows.md b/docs/development/build-instructions-windows.md index e090f25832cd..ddf551002262 100644 --- a/docs/development/build-instructions-windows.md +++ b/docs/development/build-instructions-windows.md @@ -54,7 +54,8 @@ You can also only build the Debug target: python script\build.py -c D ``` -After building is done, you can find `atom.exe` under `out\D`. +After building is done, you can find `electron.exe` under `out\D` (debug +target) or under `out\R` (release target). ## 64bit build From 290b221d7902bf9f221f7f0020d0cd069542fad1 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 26 Aug 2015 15:45:38 +0800 Subject: [PATCH 0956/1293] mac: Do not set rounded corner by adding layer --- atom/browser/native_window_mac.h | 3 -- atom/browser/native_window_mac.mm | 58 +++++++++---------------------- vendor/brightray | 2 +- 3 files changed, 17 insertions(+), 46 deletions(-) diff --git a/atom/browser/native_window_mac.h b/atom/browser/native_window_mac.h index e54dc6ad87f6..20ad60531498 100644 --- a/atom/browser/native_window_mac.h +++ b/atom/browser/native_window_mac.h @@ -82,9 +82,6 @@ class NativeWindowMac : public NativeWindow { // Called to handle a mouse event. void HandleMouseEvent(NSEvent* event); - // Clip web view to rounded corner. - void ClipWebView(); - protected: // NativeWindow: void HandleKeyboardEvent( diff --git a/atom/browser/native_window_mac.mm b/atom/browser/native_window_mac.mm index b0649c4a80cf..64f7c11f997b 100644 --- a/atom/browser/native_window_mac.mm +++ b/atom/browser/native_window_mac.mm @@ -22,9 +22,6 @@ namespace { -// The radius of rounded corner. -const CGFloat kAtomWindowCornerRadius = 4.0; - // Prevents window from resizing during the scope. class ScopedDisableResize { public: @@ -41,10 +38,6 @@ bool ScopedDisableResize::disable_resize_ = false; } // namespace -@interface NSView (PrivateMethods) -- (CGFloat)roundedCornerRadius; -@end - // This view always takes the size of its superview. It is intended to be used // as a NSWindow's contentView. It is needed because NSWindow's implementation // explicitly resizes the contentView at inopportune times. @@ -153,9 +146,6 @@ bool ScopedDisableResize::disable_resize_ = false; } - (void)windowDidResize:(NSNotification*)notification { - if (!shell_->has_frame()) - shell_->ClipWebView(); - shell_->NotifyWindowResize(); } @@ -613,8 +603,8 @@ void NativeWindowMac::Center() { } void NativeWindowMac::SetTitle(const std::string& title) { - // We don't want the title to show in transparent window. - if (transparent()) + // We don't want the title to show in transparent or frameless window. + if (transparent() || !has_frame()) return; [window_ setTitle:base::SysUTF8ToNSString(title)]; @@ -804,35 +794,27 @@ void NativeWindowMac::HandleKeyboardEvent( } void NativeWindowMac::InstallView() { + // Make sure the bottom corner is rounded: http://crbug.com/396264. + [[window_ contentView] setWantsLayer:YES]; + NSView* view = inspectable_web_contents()->GetView()->GetNativeView(); if (has_frame()) { - // Add layer with white background for the contents view. - base::scoped_nsobject layer([[CALayer alloc] init]); - [layer setBackgroundColor:CGColorGetConstantColor(kCGColorWhite)]; - [view setLayer:layer]; [view setFrame:[[window_ contentView] bounds]]; [[window_ contentView] addSubview:view]; } else { - if (base::mac::IsOSYosemiteOrLater()) { - // In OSX 10.10, adding subviews to the root view for the NSView hierarchy - // produces warnings. To eliminate the warnings, we resize the contentView - // to fill the window, and add subviews to that. - // http://crbug.com/380412 - content_view_.reset([[FullSizeContentView alloc] init]); - [content_view_ - setAutoresizingMask:NSViewWidthSizable | NSViewHeightSizable]; - [content_view_ setFrame:[[[window_ contentView] superview] bounds]]; - [window_ setContentView:content_view_]; + // In OSX 10.10, adding subviews to the root view for the NSView hierarchy + // produces warnings. To eliminate the warnings, we resize the contentView + // to fill the window, and add subviews to that. + // http://crbug.com/380412 + content_view_.reset([[FullSizeContentView alloc] init]); + [content_view_ + setAutoresizingMask:NSViewWidthSizable | NSViewHeightSizable]; + [content_view_ setFrame:[[[window_ contentView] superview] bounds]]; + [window_ setContentView:content_view_]; - [view setFrame:[content_view_ bounds]]; - [content_view_ addSubview:view]; - } else { - NSView* frameView = [[window_ contentView] superview]; - [view setFrame:[frameView bounds]]; - [frameView addSubview:view]; - } + [view setFrame:[content_view_ bounds]]; + [content_view_ addSubview:view]; - ClipWebView(); InstallDraggableRegionView(); [[window_ standardWindowButton:NSWindowZoomButton] setHidden:YES]; @@ -851,14 +833,6 @@ void NativeWindowMac::UninstallView() { [view removeFromSuperview]; } -void NativeWindowMac::ClipWebView() { - if (!web_contents()) - return; - NSView* webView = web_contents()->GetNativeView(); - webView.layer.masksToBounds = YES; - webView.layer.cornerRadius = kAtomWindowCornerRadius; -} - void NativeWindowMac::InstallDraggableRegionView() { NSView* webView = web_contents()->GetNativeView(); base::scoped_nsobject controlRegion( diff --git a/vendor/brightray b/vendor/brightray index 5b2a73c68a98..0bf81275795b 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit 5b2a73c68a986780e67eb2e738327d35c7c1c21e +Subproject commit 0bf81275795b15eb361a1fd213ae9c7c1f60bdea From 2b051e38845f4658d46f2ffd99a206e0c9f17ad8 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Wed, 26 Aug 2015 16:28:22 +0800 Subject: [PATCH 0957/1293] mac: make tray's behavior more official when getting clicked quickly multiple times. --- atom/browser/ui/tray_icon_cocoa.mm | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/atom/browser/ui/tray_icon_cocoa.mm b/atom/browser/ui/tray_icon_cocoa.mm index d69fa8636b4f..ec6a6a3e1964 100644 --- a/atom/browser/ui/tray_icon_cocoa.mm +++ b/atom/browser/ui/tray_icon_cocoa.mm @@ -207,8 +207,14 @@ const CGFloat kVerticalTitleMargin = 2; } inMouseEventSequence_ = NO; - // Show menu when single clicked on the icon. - if (event.clickCount == 1 && menuController_) + // Show menu when there is a context menu. + // NB(hokein): Make tray's behavior more like official one's. + // When the tray icon gets clicked quickly multiple times, the + // event.clickCount doesn't always return 1. Instead, it returns a value that + // counts the clicked times. + // So we don't check the clickCount here, just pop up the menu for each click + // event. + if (menuController_) [statusItem_ popUpStatusItemMenu:[menuController_ menu]]; // Don't emit click events when menu is showing. From be18a114e21f56cac3c317161d2481d739a76dec Mon Sep 17 00:00:00 2001 From: Robo Date: Wed, 26 Aug 2015 15:52:28 +0530 Subject: [PATCH 0958/1293] nativemate: increase recursion depth --- atom/common/native_mate_converters/v8_value_converter.cc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/atom/common/native_mate_converters/v8_value_converter.cc b/atom/common/native_mate_converters/v8_value_converter.cc index 2270f0e0fd3d..a6358b363eea 100644 --- a/atom/common/native_mate_converters/v8_value_converter.cc +++ b/atom/common/native_mate_converters/v8_value_converter.cc @@ -17,7 +17,7 @@ namespace atom { namespace { -const int kMaxRecursionDepth = 20; +const int kMaxRecursionDepth = 100; } // namespace From 840095b444272e5f6a9bf0cad3ee5be910236848 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Thu, 20 Aug 2015 15:17:53 +0200 Subject: [PATCH 0959/1293] Break out methods, standardize --- docs/api/browser-window.md | 499 ++++++++++++++++++++----------------- docs/api/session.md | 166 ++++++++++++ docs/api/web-contents.md | 468 ++++++++++++++++++++++++++++++++++ 3 files changed, 903 insertions(+), 230 deletions(-) create mode 100644 docs/api/session.md create mode 100644 docs/api/web-contents.md diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 14621ed5a1e6..056db9a3ef97 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -1,7 +1,6 @@ -# browser-window +# BrowserWindow -The `BrowserWindow` class gives you ability to create a browser window, an -example is: +The `BrowserWindow` class gives you the ability to create a browser window, for example: ```javascript var BrowserWindow = require('browser-window'); @@ -15,7 +14,7 @@ win.loadUrl('https://github.com'); win.show(); ``` -You can also create a window without chrome by using +You can also create a window without Chrome by using [Frameless Window](frameless-window.md) API. ## Class: BrowserWindow @@ -23,98 +22,104 @@ You can also create a window without chrome by using `BrowserWindow` is an [EventEmitter](http://nodejs.org/api/events.html#events_class_events_eventemitter). -### new BrowserWindow(options) +It creates a new `BrowserWindow` with native properties as set by the `options`. +Properties `width` and `height` are required. -* `options` Object - * `x` Integer - Window's left offset to screen - * `y` Integer - Window's top offset to screen - * `width` Integer - Window's width - * `height` Integer - Window's height - * `use-content-size` Boolean - The `width` and `height` would be used as web - page's size, which means the actual window's size will include window - frame's size and be slightly larger. - * `center` Boolean - Show window in the center of the screen - * `min-width` Integer - Minimum width - * `min-height` Integer - Minimum height - * `max-width` Integer - Maximum width - * `max-height` Integer - Maximum height - * `resizable` Boolean - Whether window is resizable - * `always-on-top` Boolean - Whether the window should always stay on top of - other windows - * `fullscreen` Boolean - Whether the window should show in fullscreen, when - set to `false` the fullscreen button would also be hidden on OS X - * `skip-taskbar` Boolean - Do not show window in taskbar - * `zoom-factor` Number - The default zoom factor of the page, zoom factor is - zoom percent / 100, so `3.0` represents `300%` - * `kiosk` Boolean - The kiosk mode - * `title` String - Default window title - * `icon` [NativeImage](native-image.md) - The window icon, when omitted on - Windows the executable's icon would be used as window icon - * `show` Boolean - Whether window should be shown when created - * `frame` Boolean - Specify `false` to create a - [Frameless Window](frameless-window.md) - * `node-integration` Boolean - Whether node integration is enabled, default - is `true` - * `accept-first-mouse` Boolean - Whether the web view accepts a single - mouse-down event that simultaneously activates the window - * `disable-auto-hide-cursor` Boolean - Do not hide cursor when typing - * `auto-hide-menu-bar` Boolean - Auto hide the menu bar unless the `Alt` - key is pressed. - * `enable-larger-than-screen` Boolean - Enable the window to be resized larger - than screen. - * `dark-theme` Boolean - Forces using dark theme for the window, only works on - some GTK+3 desktop environments - * `preload` String - Specifies a script that will be loaded before other - scripts run in the window. This script will always have access to node APIs - no matter whether node integration is turned on for the window, and the path - of `preload` script has to be absolute path. - * `transparent` Boolean - Makes the window [transparent](frameless-window.md) - * `type` String - Specifies the type of the window, possible types are - `desktop`, `dock`, `toolbar`, `splash`, `notification`. This only works on - Linux. - * `standard-window` Boolean - Uses the OS X's standard window instead of the - textured window. Defaults to `true`. - * `web-preferences` Object - Settings of web page's features - * `javascript` Boolean - * `web-security` Boolean - When setting `false`, it will disable the same-origin - policy(Usually using testing websites by people), and set `allow_displaying_insecure_content` - and `allow_running_insecure_content` to `true` if these two options are not - set by user. - * `allow-displaying-insecure-content` Boolean - Allow a https page to display - content like image from http URLs. - * `allow-running-insecure-content` Boolean - Allow a https page to run JavaScript, - CSS or plugins from http URLs. - * `images` Boolean - * `java` Boolean - * `text-areas-are-resizable` Boolean - * `webgl` Boolean - * `webaudio` Boolean - * `plugins` Boolean - Whether plugins should be enabled, currently only - `NPAPI` plugins are supported. - * `extra-plugin-dirs` Array - Array of paths that would be searched for - plugins. Note that if you want to add a directory under your app, you - should use `__dirname` or `process.resourcesPath` to join the paths to - make them absolute, using relative paths would make Electron search - under current working directory. - * `experimental-features` Boolean - * `experimental-canvas-features` Boolean - * `subpixel-font-scaling` Boolean - * `overlay-scrollbars` Boolean - * `overlay-fullscreen-video` Boolean - * `shared-worker` Boolean - * `direct-write` Boolean - Whether the DirectWrite font rendering system on - Windows is enabled - * `page-visibility` Boolean - Page would be forced to be always in visible - or hidden state once set, instead of reflecting current window's - visibility. Users can set it to `true` to prevent throttling of DOM - timers. +### `new BrowserWindow(options)` -Creates a new `BrowserWindow` with native properties set by the `options`. -Usually you only need to set the `width` and `height`, other properties will -have decent default values. +`options` Object, properties: + +* `width` Integer **required** - Window's width. +* `height` Integer **required** - Window's height. +* `x` Integer - Window's left offset from screen. +* `y` Integer - Window's top offset from screen. +* `use-content-size` Boolean - The `width` and `height` would be used as web + page's size, which means the actual window's size will include window + frame's size and be slightly larger. +* `center` Boolean - Show window in the center of the screen. +* `min-width` Integer - Window's minimum width. +* `min-height` Integer - Window's minimum height. +* `max-width` Integer - Window's maximum width. +* `max-height` Integer - Window's maximum height. +* `resizable` Boolean - Whether window is resizable. +* `always-on-top` Boolean - Whether the window should always stay on top of + other windows. +* `fullscreen` Boolean - Whether the window should show in fullscreen. When + set to `false` the fullscreen button will also be hidden on OS X. +* `skip-taskbar` Boolean - Whether to show the window in taskbar. +* `zoom-factor` Number - The default zoom factor of the page, `3.0` represents +`300%`. +* `kiosk` Boolean - The kiosk mode. +* `title` String - Default window title. +* `icon` [NativeImage](native-image.md) - The window icon, when omitted on + Windows the executable's icon would be used as window icon. +* `show` Boolean - Whether window should be shown when created. +* `frame` Boolean - Specify `false` to create a +[Frameless Window](frameless-window.md). +* `node-integration` Boolean - Whether node integration is enabled. Default + is `true`. +* `accept-first-mouse` Boolean - Whether the web view accepts a single + mouse-down event that simultaneously activates the window. +* `disable-auto-hide-cursor` Boolean - Whether to hide cursor when typing. +* `auto-hide-menu-bar` Boolean - Auto hide the menu bar unless the `Alt` + key is pressed. +* `enable-larger-than-screen` Boolean - Enable the window to be resized larger + than screen. +* `dark-theme` Boolean - Forces using dark theme for the window, only works on + some GTK+3 desktop environments. +* `preload` String - Specifies a script that will be loaded before other + scripts run in the window. This script will always have access to node APIs + no matter whether node integration is turned on for the window, and the path + of `preload` script has to be absolute path. +* `transparent` Boolean - Makes the window [transparent](frameless-window.md). +* `type` String - Specifies the type of the window, possible types are + `desktop`, `dock`, `toolbar`, `splash`, `notification`. This only works on + Linux. +* `standard-window` Boolean - Uses the OS X's standard window instead of the + textured window. Defaults to `true`. +* `web-preferences` Object - Settings of web page's features, properties: + * `javascript` Boolean + * `web-security` Boolean - When setting `false`, it will disable the same-origin + policy (Usually using testing websites by people), and set `allow_displaying_insecure_content` + and `allow_running_insecure_content` to `true` if these two options are not + set by user. + * `allow-displaying-insecure-content` Boolean - Allow an https page to display + content like images from http URLs. + * `allow-running-insecure-content` Boolean - Allow a https page to run JavaScript, + CSS or plugins from http URLs. + * `images` Boolean + * `java` Boolean + * `text-areas-are-resizable` Boolean + * `webgl` Boolean + * `webaudio` Boolean + * `plugins` Boolean - Whether plugins should be enabled, currently only + `NPAPI` plugins are supported. + * `extra-plugin-dirs` Array - Array of paths that would be searched for + plugins. Note that if you want to add a directory under your app, you + should use `__dirname` or `process.resourcesPath` to join the paths to + make them absolute, using relative paths would make Electron search + under current working directory. + * `experimental-features` Boolean + * `experimental-canvas-features` Boolean + * `subpixel-font-scaling` Boolean + * `overlay-scrollbars` Boolean + * `overlay-fullscreen-video` Boolean + * `shared-worker` Boolean + * `direct-write` Boolean - Whether the DirectWrite font rendering system on + Windows is enabled. + * `page-visibility` Boolean - Page would be forced to be always in visible + or hidden state once set, instead of reflecting current window's + visibility. Users can set it to `true` to prevent throttling of DOM + timers. + +## Events + +The `BrowserWindow` object emits the following events: ### Event: 'page-title-updated' +Returns: + * `event` Event Emitted when the document changed its title, calling `event.preventDefault()` @@ -122,16 +127,18 @@ would prevent the native window's title to change. ### Event: 'close' +Returns: + * `event` Event Emitted when the window is going to be closed. It's emitted before the -`beforeunload` and `unload` event of DOM, calling `event.preventDefault()` -would cancel the close. +`beforeunload` and `unload` event of the DOM. Calling `event.preventDefault()` +will cancel the close. Usually you would want to use the `beforeunload` handler to decide whether the window should be closed, which will also be called when the window is reloaded. In Electron, returning an empty string or `false` would cancel the -close. An example is: +close. For example: ```javascript window.onbeforeunload = function(e) { @@ -139,7 +146,7 @@ window.onbeforeunload = function(e) { // Unlike usual browsers, in which a string should be returned and the user is // prompted to confirm the page unload, Electron gives developers more options. - // Returning empty string or false would prevent the unloading now. + // Returning an empty string or false will prevent the unloading. // You can also use the dialog API to let the user confirm closing the application. e.returnValue = false; }; @@ -160,11 +167,11 @@ Emitted when the unresponsive web page becomes responsive again. ### Event: 'blur' -Emitted when window loses focus. +Emitted when the window loses focus. ### Event: 'focus' -Emitted when window gains focus. +Emitted when the window gains focus. ### Event: 'maximize' @@ -172,19 +179,19 @@ Emitted when window is maximized. ### Event: 'unmaximize' -Emitted when window exits from maximized state. +Emitted when the window exits from maximized state. ### Event: 'minimize' -Emitted when window is minimized. +Emitted when the window is minimized. ### Event: 'restore' -Emitted when window is restored from minimized state. +Emitted when the window is restored from minimized state. ### Event: 'resize' -Emitted when window is getting resized. +Emitted when the window is getting resized. ### Event: 'move' @@ -200,19 +207,19 @@ __Note__: This event is available only on OS X. ### Event: 'enter-full-screen' -Emitted when window enters full screen state. +Emitted when the window enters full screen state. ### Event: 'leave-full-screen' -Emitted when window leaves full screen state. +Emitted when the window leaves full screen state. ### Event: 'enter-html-full-screen' -Emitted when window enters full screen state triggered by html api. +Emitted when the window enters full screen state triggered by html api. ### Event: 'leave-html-full-screen' -Emitted when window leaves full screen state triggered by html api. +Emitted when the window leaves full screen state triggered by html api. ### Event: 'devtools-opened' @@ -228,7 +235,7 @@ Emitted when devtools is focused / opened. ### Event: 'app-command': -Emitted when an [App Command](https://msdn.microsoft.com/en-us/library/windows/desktop/ms646275(v=vs.85).aspx) is invoked. These are typically related to keyboard media keys or browser commands, as well as the "Back" button built into some mice on Windows. +Emitted when an [App Command](https://msdn.microsoft.com/en-us/library/windows/desktop/ms646275(v=vs.85).aspx is invoked. These are typically related to keyboard media keys or browser commands, as well as the "Back" button built into some mice on Windows. ```js someWindow.on('app-command', function(e, cmd) { @@ -241,27 +248,31 @@ someWindow.on('app-command', function(e, cmd) { __Note__: This event is only fired on Windows. -### Class Method: BrowserWindow.getAllWindows() +## Methods + +The `BrowserWindow` object has the following methods: + +### `BrowserWindow.getAllWindows()` Returns an array of all opened browser windows. -### Class Method: BrowserWindow.getFocusedWindow() +### `BrowserWindow.getFocusedWindow()` Returns the window that is focused in this application. -### Class Method: BrowserWindow.fromWebContents(webContents) +### `BrowserWindow.fromWebContents(webContents)` -* `webContents` WebContents +* `webContents` [WebContents](#webcontents) -Find a window according to the `webContents` it owns +Find a window according to the `webContents` it owns. -### Class Method: BrowserWindow.fromId(id) +### `BrowserWindow.fromId(id)` * `id` Integer Find a window according to its ID. -### Class Method: BrowserWindow.addDevToolsExtension(path) +### `BrowserWindow.addDevToolsExtension(path)` * `path` String @@ -270,186 +281,201 @@ Adds devtools extension located at `path`, and returns extension's name. The extension will be remembered so you only need to call this API once, this API is not for programming use. -### Class Method: BrowserWindow.removeDevToolsExtension(name) +### `BrowserWindow.removeDevToolsExtension(name)` * `name` String Remove the devtools extension whose name is `name`. -### BrowserWindow.webContents +## Instance Methods + +Objects created with `new BrowserWindow` have the following instance methods: + +```javascript +var BrowserWindow = require('browser-window'); + +// In this example `win` is our instance +var win = new BroswerWindow({width: 800, height: 1500}); + +``` + +### `win.webContents` The `WebContents` object this window owns, all web page related events and -operations would be done via it. +operations will be done via it. + +See the [`webContents` documentation](web-contents.md) for its methods and events. **Note:** Users should never store this object because it may become `null` when the renderer process (web page) has crashed. -### BrowserWindow.devToolsWebContents +### `win.devToolsWebContents` -Get the `WebContents` of devtools of this window. +Get the `WebContents` of devtools for this window. **Note:** Users should never store this object because it may become `null` when the devtools has been closed. -### BrowserWindow.id +### `win.id` Get the unique ID of this window. -### BrowserWindow.destroy() +### `win.destroy()` Force closing the window, the `unload` and `beforeunload` event won't be emitted -for the web page, and `close` event would also not be emitted -for this window, but it would guarantee the `closed` event to be emitted. +for the web page, and `close` event will also not be emitted +for this window, but it guarantees the `closed` event will be emitted. You should only use this method when the renderer process (web page) has crashed. -### BrowserWindow.close() +### `win.close()` Try to close the window, this has the same effect with user manually clicking the close button of the window. The web page may cancel the close though, see the [close event](#event-close). -### BrowserWindow.focus() +### `win.focus()` Focus on the window. -### BrowserWindow.isFocused() +### `win.isFocused()` -Returns whether the window is focused. +Returns a boolean, whether the window is focused. -### BrowserWindow.show() +### `win.show()` Shows and gives focus to the window. -### BrowserWindow.showInactive() +### `win.showInactive()` Shows the window but doesn't focus on it. -### BrowserWindow.hide() +### `win.hide()` Hides the window. -### BrowserWindow.isVisible() +### `win.isVisible()` -Returns whether the window is visible to the user. +Returns a boolean, whether the window is visible to the user. -### BrowserWindow.maximize() +### `win.maximize()` Maximizes the window. -### BrowserWindow.unmaximize() +### `win.unmaximize()` Unmaximizes the window. -### BrowserWindow.isMaximized() +### `win.isMaximized()` -Returns whether the window is maximized. +Returns a boolean, whether the window is maximized. -### BrowserWindow.minimize() +### `win.minimize()` Minimizes the window. On some platforms the minimized window will be shown in the Dock. -### BrowserWindow.restore() +### `win.restore()` Restores the window from minimized state to its previous state. -### BrowserWindow.isMinimized() +### `win.isMinimized()` -Returns whether the window is minimized. +Returns a boolean, whether the window is minimized. -### BrowserWindow.setFullScreen(flag) +### `win.setFullScreen(flag)` * `flag` Boolean Sets whether the window should be in fullscreen mode. -### BrowserWindow.isFullScreen() +### `win.isFullScreen()` -Returns whether the window is in fullscreen mode. +Returns a boolean, whether the window is in fullscreen mode. -### BrowserWindow.setAspectRatio(aspectRatio[, extraSize]) +### `win.setAspectRatio(aspectRatio[, extraSize])` * `aspectRatio` The aspect ratio we want to maintain for some portion of the content view. -* `rect` Object - The extra size to not be included in the aspect ratio to be maintained. +* `rect` Object - The extra size to not be included in the aspect ratio to be maintained. Properties: * `width` Integer * `height` Integer -This will have a window maintain an aspect ratio. The extra size allows a developer to be able to have space, specifified in pixels, not included within the aspect ratio calculations. This API already takes into account the difference between a window's size and it's content size. +This will have a window maintain an aspect ratio. The extra size allows a developer to have space, specified in pixels, not included within the aspect ratio calculations. This API already takes into account the difference between a window's size and its content size. -Consider a normal window with an HD video player and associated controls. Perhaps there are 15 pixels of controls on the left edge, 25 pixels of controls on the right edge and 50 pixels of controls below the player. In order to maintain a 16:9 aspect ratio (standard aspect ratio for HD @1920x1080) within the player itself we would call this function with arguments of 16/9 and [ 40, 50 ]. The second argument doesn't care where the extra width and height are within the content view — only that they exist. Just sum any extra width and height areas you have within the overall content view. +Consider a normal window with an HD video player and associated controls. Perhaps there are 15 pixels of controls on the left edge, 25 pixels of controls on the right edge and 50 pixels of controls below the player. In order to maintain a 16:9 aspect ratio (standard aspect ratio for HD @1920x1080) within the player itself we would call this function with arguments of 16/9 and [ 40, 50 ]. The second argument doesn't care where the extra width and height are within the content view--only that they exist. Just sum any extra width and height areas you have within the overall content view. __Note__: This API is only implemented on OS X. -### BrowserWindow.setBounds(options) +### `win.setBounds(options)` -* `options` Object - * `x` Integer - * `y` Integer - * `width` Integer - * `height` Integer +`options` Object, properties: + +* `x` Integer +* `y` Integer +* `width` Integer +* `height` Integer Resizes and moves the window to `width`, `height`, `x`, `y`. -### BrowserWindow.getBounds() +### `win.getBounds()` Returns an object that contains window's width, height, x and y values. -### BrowserWindow.setSize(width, height) +### `win.setSize(width, height)` * `width` Integer * `height` Integer Resizes the window to `width` and `height`. -### BrowserWindow.getSize() +### `win.getSize()` Returns an array that contains window's width and height. -### BrowserWindow.setContentSize(width, height) +### `win.setContentSize(width, height)` * `width` Integer * `height` Integer Resizes the window's client area (e.g. the web page) to `width` and `height`. -### BrowserWindow.getContentSize() +### `win.getContentSize()` Returns an array that contains window's client area's width and height. -### BrowserWindow.setMinimumSize(width, height) +### `win.setMinimumSize(width, height)` * `width` Integer * `height` Integer Sets the minimum size of window to `width` and `height`. -### BrowserWindow.getMinimumSize() +### `win.getMinimumSize()` Returns an array that contains window's minimum width and height. -### BrowserWindow.setMaximumSize(width, height) +### `win.setMaximumSize(width, height)` * `width` Integer * `height` Integer Sets the maximum size of window to `width` and `height`. -### BrowserWindow.getMaximumSize() +### `win.getMaximumSize()` Returns an array that contains window's maximum width and height. -### BrowserWindow.setResizable(resizable) +### `win.setResizable(resizable)` * `resizable` Boolean Sets whether the window can be manually resized by user. -### BrowserWindow.isResizable() +### `win.isResizable()` Returns whether the window can be manually resized by user. -### BrowserWindow.setAlwaysOnTop(flag) +### `win.setAlwaysOnTop(flag)` * `flag` Boolean @@ -457,61 +483,61 @@ Sets whether the window should show always on top of other windows. After setting this, the window is still a normal window, not a toolbox window which can not be focused on. -### BrowserWindow.isAlwaysOnTop() +### `win.isAlwaysOnTop()` Returns whether the window is always on top of other windows. -### BrowserWindow.center() +### `win.center()` Moves window to the center of the screen. -### BrowserWindow.setPosition(x, y) +### `win.setPosition(x, y)` * `x` Integer * `y` Integer Moves window to `x` and `y`. -### BrowserWindow.getPosition() +### `win.getPosition()` Returns an array that contains window's current position. -### BrowserWindow.setTitle(title) +### `win.setTitle(title)` * `title` String Changes the title of native window to `title`. -### BrowserWindow.getTitle() +### `win.getTitle()` Returns the title of the native window. **Note:** The title of web page can be different from the title of the native window. -### BrowserWindow.flashFrame(flag) +### `win.flashFrame(flag)` * `flag` Boolean Starts or stops flashing the window to attract user's attention. -### BrowserWindow.setSkipTaskbar(skip) +### `win.setSkipTaskbar(skip)` * `skip` Boolean Makes the window not show in the taskbar. -### BrowserWindow.setKiosk(flag) +### `win.setKiosk(flag)` * `flag` Boolean Enters or leaves the kiosk mode. -### BrowserWindow.isKiosk() +### `win.isKiosk()` Returns whether the window is in kiosk mode. -### BrowserWindow.setRepresentedFilename(filename) +### `win.setRepresentedFilename(filename)` * `filename` String @@ -520,13 +546,13 @@ will show in window's title bar. __Note__: This API is only available on OS X. -### BrowserWindow.getRepresentedFilename() +### `win.getRepresentedFilename()` Returns the pathname of the file the window represents. __Note__: This API is only available on OS X. -### BrowserWindow.setDocumentEdited(edited) +### `win.setDocumentEdited(edited)` * `edited` Boolean @@ -535,77 +561,85 @@ bar will become grey when set to `true`. __Note__: This API is only available on OS X. -### BrowserWindow.IsDocumentEdited() +### `win.IsDocumentEdited()` Whether the window's document has been edited. __Note__: This API is only available on OS X. -### BrowserWindow.openDevTools([options]) +### `win.openDevTools([options])` -* `options` Object +* `options` Object, optional. Properties: * `detach` Boolean - opens devtools in a new window Opens the developer tools. -### BrowserWindow.closeDevTools() +### `win.closeDevTools()` Closes the developer tools. -### BrowserWindow.isDevToolsOpened() +### `win.isDevToolsOpened()` Returns whether the developer tools are opened. -### BrowserWindow.toggleDevTools() +### `win.toggleDevTools()` Toggle the developer tools. -### BrowserWindow.inspectElement(x, y) +### `win.inspectElement(x, y)` * `x` Integer * `y` Integer Starts inspecting element at position (`x`, `y`). -### BrowserWindow.inspectServiceWorker() +### `win.inspectServiceWorker()` Opens the developer tools for the service worker context present in the web contents. -### BrowserWindow.focusOnWebView() +### `win.focusOnWebView()` -### BrowserWindow.blurWebView() +### `win.blurWebView()` -### BrowserWindow.capturePage([rect, ]callback) +### `win.capturePage([rect, ]callback)` -* `rect` Object - The area of page to be captured +* `rect` Object - The area of page to be captured, properties: * `x` Integer * `y` Integer * `width` Integer * `height` Integer * `callback` Function -Captures the snapshot of page within `rect`, upon completion `callback` would be -called with `callback(image)`, the `image` is an instance of -[NativeImage](native-image.md) that stores data of the snapshot. Omitting the -`rect` would capture the whole visible page. +Captures a snapshot of the page within `rect`. Upon completion `callback` will be +called with `callback(image)`. The `image` is an instance of +[NativeImage](native-image.md) that stores data of the snapshot. Omitting +`rect` will capture the whole visible page. +<<<<<<< HEAD ### BrowserWindow.print([options]) +======= +**Note:** Be sure to read documents on remote buffer in +[remote](remote.md) if you are going to use this API in renderer +process. -Same with `webContents.print([options])` +### `win.print([options])` +>>>>>>> Break out methods, standardize -### BrowserWindow.printToPDF(options, callback) +Same as `webContents.print([options])` -Same with `webContents.printToPDF(options, callback)` +### `win.printToPDF(options, callback)` -### BrowserWindow.loadUrl(url, [options]) +Same as `webContents.printToPDF(options, callback)` -Same with `webContents.loadUrl(url, [options])`. +### `win.loadUrl(url[, options])` -### BrowserWindow.reload() +Same as `webContents.loadUrl(url[, options])`. -Same with `webContents.reload`. +### `win.reload()` -### BrowserWindow.setMenu(menu) +Same as `webContents.reload`. + +### `win.setMenu(menu)` * `menu` Menu @@ -614,7 +648,7 @@ menu bar. __Note:__ This API is not available on OS X. -### BrowserWindow.setProgressBar(progress) +### `win.setProgressBar(progress)` * `progress` Double @@ -627,7 +661,7 @@ On Linux platform, only supports Unity desktop environment, you need to specify the `*.desktop` file name to `desktopName` field in `package.json`. By default, it will assume `app.getName().desktop`. -### BrowserWindow.setOverlayIcon(overlay, description) +### `win.setOverlayIcon(overlay, description)` * `overlay` [NativeImage](native-image.md) - the icon to display on the bottom right corner of the taskbar icon. If this parameter is `null`, the overlay is @@ -640,27 +674,29 @@ Sets a 16px overlay onto the current taskbar icon, usually used to convey some s __Note:__ This API is only available on Windows (Windows 7 and above) -### BrowserWindow.setThumbarButtons(buttons) +### `win.setThumbarButtons(buttons)` -* `buttons` Array - * `button` Object - * `icon` [NativeImage](native-image.md) - The icon showing in thumbnail - toolbar. - * `tooltip` String (optional) - The text of the button's tooltip. - * `flags` Array (optional) - Control specific states and behaviors - of the button. By default, it uses `enabled`. It can include following - Strings: - * `enabled` - The button is active and available to the user. - * `disabled` - The button is disabled. It is present, but has a visual - state that indicates that it will not respond to user action. - * `dismissonclick` - When the button is clicked, the taskbar button's - flyout closes immediately. - * `nobackground` - Do not draw a button border, use only the image. - * `hidden` - The button is not shown to the user. - * `noninteractive` - The button is enabled but not interactive; no - pressed button state is drawn. This value is intended for instances - where the button is used in a notification. - * `click` - Function +`buttons` Array od `button` Objects: + +`button` Object, properties: + +* `icon` [NativeImage](native-image.md) - The icon showing in thumbnail + toolbar. +* `tooltip` String (optional) - The text of the button's tooltip. +* `flags` Array (optional) - Control specific states and behaviors + of the button. By default, it uses `enabled`. It can include following + Strings: + * `enabled` - The button is active and available to the user. + * `disabled` - The button is disabled. It is present, but has a visual + state that indicates that it will not respond to user action. + * `dismissonclick` - When the button is clicked, the taskbar button's + flyout closes immediately. + * `nobackground` - Do not draw a button border, use only the image. + * `hidden` - The button is not shown to the user. + * `noninteractive` - The button is enabled but not interactive; no + pressed button state is drawn. This value is intended for instances + where the button is used in a notification. +* `click` - Function Add a thumbnail toolbar with a specified set of buttons to the thumbnail image of a window in a taskbar button layout. Returns a `Boolean` object indicates @@ -672,13 +708,13 @@ the limited room. Once you setup the thumbnail toolbar, the toolbar cannot be removed due to the platform's limitation. But you can call the API with an empty array to clean the buttons. -### BrowserWindow.showDefinitionForSelection() +### `win.showDefinitionForSelection()` Shows pop-up dictionary that searches the selected word on the page. __Note__: This API is only available on OS X. -### BrowserWindow.setAutoHideMenuBar(hide) +### `win.setAutoHideMenuBar(hide)` * `hide` Boolean @@ -688,22 +724,22 @@ menu bar will only show when users press the single `Alt` key. If the menu bar is already visible, calling `setAutoHideMenuBar(true)` won't hide it immediately. -### BrowserWindow.isMenuBarAutoHide() +### `win.isMenuBarAutoHide()` Returns whether menu bar automatically hides itself. -### BrowserWindow.setMenuBarVisibility(visible) +### `win.setMenuBarVisibility(visible)` * `visible` Boolean Sets whether the menu bar should be visible. If the menu bar is auto-hide, users can still bring up the menu bar by pressing the single `Alt` key. -### BrowserWindow.isMenuBarVisible() +### `win.isMenuBarVisible()` Returns whether the menu bar is visible. -### BrowserWindow.setVisibleOnAllWorkspaces(visible) +### `win.setVisibleOnAllWorkspaces(visible)` * `visible` Boolean @@ -711,11 +747,12 @@ Sets whether the window should be visible on all workspaces. **Note:** This API does nothing on Windows. -### BrowserWindow.isVisibleOnAllWorkspaces() +### `win.isVisibleOnAllWorkspaces()` Returns whether the window is visible on all workspaces. **Note:** This API always returns false on Windows. +<<<<<<< HEAD ## Class: WebContents @@ -1287,3 +1324,5 @@ proxy-uri = ["://"][":"] Sets download saving directory. By default, the download directory will be the `Downloads` under the respective app folder. +======= +>>>>>>> Break out methods, standardize diff --git a/docs/api/session.md b/docs/api/session.md new file mode 100644 index 000000000000..2211dce34ced --- /dev/null +++ b/docs/api/session.md @@ -0,0 +1,166 @@ +# session + +The `session` object is a property of [`webContents`](web-contents.md) which is a property of [`BrowserWindow`](browser-window.md). You can access it through an instance of `BrowserWindow`. For example: + +```javascript +var BrowserWindow = require('browser-window'); + +var win = new BroswerWindow({ width: 800, height: 600 }); +win.loadUrl("http://github.com"); + +var session = win.webContents.session +``` + +## Methods + +The `session` object has the following methods: + +### session.cookies + +The `cookies` gives you ability to query and modify cookies, an example is: + +```javascript +var BrowserWindow = require('browser-window'); + +var win = new BrowserWindow({ width: 800, height: 600 }); + +win.loadUrl('https://github.com'); + +win.webContents.on('did-finish-load', function() { + // Query all cookies. + win.webContents.session.cookies.get({}, function(error, cookies) { + if (error) throw error; + console.log(cookies); + }); + + // Query all cookies that are associated with a specific url. + win.webContents.session.cookies.get({ url : "http://www.github.com" }, + function(error, cookies) { + if (error) throw error; + console.log(cookies); + }); + + // Set a cookie with the given cookie data; + // may overwrite equivalent cookies if they exist. + win.webContents.session.cookies.set( + { url : "http://www.github.com", name : "dummy_name", value : "dummy"}, + function(error, cookies) { + if (error) throw error; + console.log(cookies); + }); +}); +``` + +### `session.cookies.get(details, callback)` + +`details` Object + +* `url` String - Retrieves cookies which are associated with `url`. + Empty implies retrieving cookies of all urls. +* `name` String - Filters cookies by name +* `domain` String - Retrieves cookies whose domains match or are subdomains of `domains` +* `path` String - Retrieves cookies whose path matches `path` +* `secure` Boolean - Filters cookies by their Secure property +* `session` Boolean - Filters out session or persistent cookies. +* `callback` Function - function(error, cookies) +* `error` Error +* `cookies` Array - array of `cookie` objects, properties: + * `name` String - The name of the cookie. + * `value` String - The value of the cookie. + * `domain` String - The domain of the cookie. + * `host_only` String - Whether the cookie is a host-only cookie. + * `path` String - The path of the cookie. + * `secure` Boolean - Whether the cookie is marked as Secure (typically HTTPS). + * `http_only` Boolean - Whether the cookie is marked as HttpOnly. + * `session` Boolean - Whether the cookie is a session cookie or a persistent + cookie with an expiration date. + * `expirationDate` Double - (Option) The expiration date of the cookie as + the number of seconds since the UNIX epoch. Not provided for session cookies. + +### `session.cookies.set(details, callback)` + +`details` Object + +* `url` String - Retrieves cookies which are associated with `url` +* `name` String - The name of the cookie. Empty by default if omitted. +* `value` String - The value of the cookie. Empty by default if omitted. +* `domain` String - The domain of the cookie. Empty by default if omitted. +* `path` String - The path of the cookie. Empty by default if omitted. +* `secure` Boolean - Whether the cookie should be marked as Secure. Defaults to false. +* `session` Boolean - Whether the cookie should be marked as HttpOnly. Defaults to false. +* `expirationDate` Double - The expiration date of the cookie as the number of + seconds since the UNIX epoch. If omitted, the cookie becomes a session cookie. + +* `callback` Function - function(error) + * `error` Error + +### `session.cookies.remove(details, callback)` + +* `details` Object + * `url` String - The URL associated with the cookie + * `name` String - The name of cookie to remove +* `callback` Function - function(error) + * `error` Error + +### `session.clearCache(callback)` + +* `callback` Function - Called when operation is done + +Clears the session’s HTTP cache. + +### `session.clearStorageData([options, ]callback)` + +* `options` Object + * `origin` String - Should follow `window.location.origin`’s representation + `scheme://host:port` + * `storages` Array - The types of storages to clear, can contain: + `appcache`, `cookies`, `filesystem`, `indexdb`, `local storage`, + `shadercache`, `websql`, `serviceworkers` + * `quotas` Array - The types of quotas to clear, can contain: + `temporary`, `persistent`, `syncable` +* `callback` Function - Called when operation is done + +Clears the data of web storages. + +### `session.setProxy(config, callback)` + +* `config` String +* `callback` Function - Called when operation is done + +Parses the `config` indicating which proxies to use for the session. + +``` +config = scheme-proxies[";"] +scheme-proxies = ["="] +url-scheme = "http" | "https" | "ftp" | "socks" +proxy-uri-list = [","] +proxy-uri = ["://"][":"] + + For example: + "http=foopy:80;ftp=foopy2" -- use HTTP proxy "foopy:80" for http:// + URLs, and HTTP proxy "foopy2:80" for + ftp:// URLs. + "foopy:80" -- use HTTP proxy "foopy:80" for all URLs. + "foopy:80,bar,direct://" -- use HTTP proxy "foopy:80" for all URLs, + failing over to "bar" if "foopy:80" is + unavailable, and after that using no + proxy. + "socks4://foopy" -- use SOCKS v4 proxy "foopy:1080" for all + URLs. + "http=foopy,socks5://bar.com -- use HTTP proxy "foopy" for http URLs, + and fail over to the SOCKS5 proxy + "bar.com" if "foopy" is unavailable. + "http=foopy,direct:// -- use HTTP proxy "foopy" for http URLs, + and use no proxy if "foopy" is + unavailable. + "http=foopy;socks=foopy2 -- use HTTP proxy "foopy" for http URLs, + and use socks4://foopy2 for all other + URLs. +``` + +### `session.setDownloadPath(path)` + +* `path` String - The download location + +Sets download saving directory. By default, the download directory will be the +`Downloads` under the respective app folder. diff --git a/docs/api/web-contents.md b/docs/api/web-contents.md new file mode 100644 index 000000000000..29987471881e --- /dev/null +++ b/docs/api/web-contents.md @@ -0,0 +1,468 @@ +# webContents + +`webContents` is an +[EventEmitter](http://nodejs.org/api/events.html#events_class_events_eventemitter). + +It is responsible for rendering and controlling a web page and is a property of the [`BrowserWindow`](browser-window.md) object. An example of accessing the `webContents` object: + +```javascript +var BrowserWindow = require('browser-window'); + +var win = new BroswerWindow({width: 800, height: 1500}); +win.loadUrl("http://github.com"); + +var webContents = win.webContents + +``` + +## Events + +The `webContents` object emits the following events: + +### Event: 'did-finish-load' + +Emitted when the navigation is done, i.e. the spinner of the tab has stopped +spinning, and the `onload` event was dispatched. + +### Event: 'did-fail-load' + +Returns: + +* `event` Event +* `errorCode` Integer +* `errorDescription` String + +This event is like `did-finish-load` but emitted when the load failed or was +cancelled, e.g. `window.stop()` is invoked. + +### Event: 'did-frame-finish-load' + +Returns: + +* `event` Event +* `isMainFrame` Boolean + +Emitted when a frame has done navigation. + +### Event: 'did-start-loading' + +Corresponds to the points in time when the spinner of the tab started spinning. + +### Event: 'did-stop-loading' + +Corresponds to the points in time when the spinner of the tab stopped spinning. + +### Event: 'did-get-response-details' + +Returns: + +* `event` Event +* `status` Boolean +* `newUrl` String +* `originalUrl` String +* `httpResponseCode` Integer +* `requestMethod` String +* `referrer` String +* `headers` Object + +Emitted when details regarding a requested resource is available. +`status` indicates the socket connection to download the resource. + +### Event: 'did-get-redirect-request' + +Returns: + +* `event` Event +* `oldUrl` String +* `newUrl` String +* `isMainFrame` Boolean + +Emitted when a redirect was received while requesting a resource. + +### Event: 'dom-ready' + +Returns: + +* `event` Event + +Emitted when the document in the given frame is loaded. + +### Event: 'page-favicon-updated' + +Returns: + +* `event` Event +* `favicons` Array - Array of Urls + +Emitted when page receives favicon urls. + +### Event: 'new-window' + +Returns: + +* `event` Event +* `url` String +* `frameName` String +* `disposition` String - Can be `default`, `foreground-tab`, `background-tab`, + `new-window` and `other` + +Emitted when the page requests to open a new window for a `url`. It could be +requested by `window.open` or an external link like ``. + +By default a new `BrowserWindow` will be created for the `url`. + +Calling `event.preventDefault()` can prevent creating new windows. + +### Event: 'will-navigate' + +Returns: + +* `event` Event +* `url` String + +Emitted when user or the page wants to start a navigation, it can happen when +`window.location` object is changed or user clicks a link in the page. + +This event will not emit when the navigation is started programmatically with APIs +like `webContents.loadUrl` and `webContents.back`. + +Calling `event.preventDefault()` can prevent the navigation. + +### Event: 'crashed' + +Emitted when the renderer process has crashed. + +### Event: 'plugin-crashed' + +Returns: + +* `event` Event +* `name` String +* `version` String + +Emitted when a plugin process has crashed. + +### Event: 'destroyed' + +Emitted when `webContents` is destroyed. + +## Instance Methods + +The `webContents` object has the following instance methods: + +### `webContents.session` + +Returns the `Session` object used by this webContents. + +See [session documentation](session.md) for this object's methods. + +### `webContents.loadUrl(url[, options])` + +* `url` URL +* `options` Object, properties: + * `httpReferrer` String - A HTTP Referrer url + * `userAgent` String - A user agent originating the request + +Loads the `url` in the window, the `url` must contains the protocol prefix, +e.g. the `http://` or `file://`. + +### `webContents.getUrl()` + +```javascript +var BrowserWindow = require('browser-window'); + +var win = new BrowserWindow({width: 800, height: 600}); +win.loadUrl("http://github.com"); + +var currentUrl = win.webContents.getUrl(); +``` + +Returns URL of current web page. + +### `webContents.getTitle()` + +Returns the title of web page. + +### `webContents.isLoading()` + +Returns whether web page is still loading resources. + +### `webContents.isWaitingForResponse()` + +Returns whether web page is waiting for a first-response for the main resource +of the page. + +### `webContents.stop()` + +Stops any pending navigation. + +### `webContents.reload()` + +Reloads current page. + +### `webContents.reloadIgnoringCache()` + +Reloads current page and ignores cache. + +### `webContents.canGoBack()` + +Returns whether the web page can go back. + +### `webContents.canGoForward()` + +Returns whether the web page can go forward. + +### `webContents.canGoToOffset(offset)` + +* `offset` Integer + +Returns whether the web page can go to `offset`. + +### `webContents.clearHistory()` + +Clears the navigation history. + +### `webContents.goBack()` + +Makes the web page go back. + +### `webContents.goForward()` + +Makes the web page go forward. + +### `webContents.goToIndex(index)` + +* `index` Integer + +Navigates to the specified absolute index. + +### `webContents.goToOffset(offset)` + +* `offset` Integer + +Navigates to the specified offset from the "current entry". + +### `webContents.isCrashed()` + +Whether the renderer process has crashed. + +### `webContents.setUserAgent(userAgent)` + +* `userAgent` String + +Overrides the user agent for this page. + +### `webContents.getUserAgent()` + +Returns a `String` represents the user agent for this page. + +### `webContents.insertCSS(css)` + +* `css` String + +Injects CSS into this page. + +### `webContents.executeJavaScript(code[, userGesture])` + +* `code` String +* `userGesture` Boolean + +Evaluates `code` in page. + +In browser some HTML APIs like `requestFullScreen` can only be invoked if it +is started by user gesture, by specifying `userGesture` to `true` developers +can ignore this limitation. + +### `webContents.setAudioMuted(muted)` + ++ `muted` Boolean + +Set the page muted. + +### `webContents.isAudioMuted()` + +Returns whether this page has been muted. + +### `webContents.undo()` + +Executes editing command `undo` in page. + +### `webContents.redo()` + +Executes editing command `redo` in page. + +### `webContents.cut()` + +Executes editing command `cut` in page. + +### `webContents.copy()` + +Executes editing command `copy` in page. + +### `webContents.paste()` + +Executes editing command `paste` in page. + +### `webContents.pasteAndMatchStyle()` + +Executes editing command `pasteAndMatchStyle` in page. + +### `webContents.delete()` + +Executes editing command `delete` in page. + +### `webContents.selectAll()` + +Executes editing command `selectAll` in page. + +### `webContents.unselect()` + +Executes editing command `unselect` in page. + +### `webContents.replace(text)` + +* `text` String + +Executes editing command `replace` in page. + +### `webContents.replaceMisspelling(text)` + +* `text` String + +Executes editing command `replaceMisspelling` in page. + +### `webContents.hasServiceWorker(callback)` + +* `callback` Function + +Checks if any serviceworker is registered and returns boolean as +response to `callback`. + +### `webContents.unregisterServiceWorker(callback)` + +* `callback` Function + +Unregisters any serviceworker if present and returns boolean as +response to `callback` when the JS promise is fullfilled or false +when the JS promise is rejected. + +### `webContents.print([options])` + +`options` Object, properties: + +* `silent` Boolean - Don't ask user for print settings, defaults to `false` +* `printBackground` Boolean - Also prints the background color and image of + the web page, defaults to `false`. + +Prints window's web page. When `silent` is set to `false`, Electron will pick +up system's default printer and default settings for printing. + +Calling `window.print()` in web page is equivalent to call +`webContents.print({silent: false, printBackground: false})`. + +**Note:** On Windows, the print API relies on `pdf.dll`. If your application +doesn't need print feature, you can safely remove `pdf.dll` in saving binary +size. + +### `webContents.printToPDF(options, callback)` + +`options` Object, properties: + +* `marginsType` Integer - Specify the type of margins to use + * 0 - default + * 1 - none + * 2 - minimum +* `pageSize` String - Specify page size of the generated PDF + * `A4` + * `A3` + * `Legal` + * `Letter` + * `Tabloid` +* `printBackground` Boolean - Whether to print CSS backgrounds. +* `printSelectionOnly` Boolean - Whether to print selection only. +* `landscape` Boolean - `true` for landscape, `false` for portrait. + +`callback` Function - `function(error, data) {}` + +* `error` Error +* `data` Buffer - PDF file content + +Prints window's web page as PDF with Chromium's preview printing custom +settings. + +By default, an empty `options` will be regarded as +`{marginsType:0, printBackgrounds:false, printSelectionOnly:false, + landscape:false}`. + +```javascript +var BrowserWindow = require('browser-window'); +var fs = require('fs'); + +var win = new BrowserWindow({width: 800, height: 600}); +win.loadUrl("http://github.com"); + +win.webContents.on("did-finish-load", function() { + // Use default printing options + win.webContents.printToPDF({}, function(error, data) { + if (error) throw error; + fs.writeFile("/tmp/print.pdf", data, function(error) { + if (err) + throw error; + console.log("Write PDF successfully."); + }) + }) +}); +``` + +### `webContents.addWorkSpace(path)` + +* `path` String + +Adds the specified path to devtools workspace. + +### `webContents.removeWorkSpace(path)` + +* `path` String + +Removes the specified path from devtools workspace. + +### `webContents.send(channel[, args...])` + +* `channel` String + +Send `args..` to the web page via `channel` in an asynchronous message, the web +page can handle it by listening to the `channel` event of the `ipc` module. + +An example of sending messages from the main process to the renderer process: + +```javascript +// On the main process. +var window = null; +app.on('ready', function() { + window = new BrowserWindow({width: 800, height: 600}); + window.loadUrl('file://' + __dirname + '/index.html'); + window.webContents.on('did-finish-load', function() { + window.webContents.send('ping', 'whoooooooh!'); + }); +}); +``` + +```html + + + + + + +``` + +**Note:** + +1. The IPC message handler in web pages does not have an `event` parameter, which + is different from the handlers on the main process. +2. There is no way to send synchronous messages from the main process to a + renderer process, because it would be very easy to cause dead locks. From bc909ddf5e50f0c4b82f501c04e4f35797af0184 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Thu, 20 Aug 2015 15:25:22 +0200 Subject: [PATCH 0960/1293] Add new files to readme --- docs/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/README.md b/docs/README.md index d61df787c9da..754cef9babba 100644 --- a/docs/README.md +++ b/docs/README.md @@ -40,6 +40,8 @@ Modules for the main process: * [power-monitor](api/power-monitor.md) * [power-save-blocker](api/power-save-blocker.md) * [protocol](api/protocol.md) +* [session](api/session.md) +* [webContents](api/web-contents.md) * [tray](api/tray.md) Modules for the renderer process (web page): From 00de81771c479bb405f768b47f763e36280af256 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Thu, 20 Aug 2015 19:03:53 +0200 Subject: [PATCH 0961/1293] Text edits per commit comments --- docs/api/browser-window.md | 10 +++---- docs/api/session.md | 6 ++--- docs/api/web-contents.md | 53 +++++++++++++++++++++----------------- 3 files changed, 37 insertions(+), 32 deletions(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 056db9a3ef97..905e926bb094 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -14,7 +14,7 @@ win.loadUrl('https://github.com'); win.show(); ``` -You can also create a window without Chrome by using +You can also create a window without chrome by using [Frameless Window](frameless-window.md) API. ## Class: BrowserWindow @@ -146,7 +146,7 @@ window.onbeforeunload = function(e) { // Unlike usual browsers, in which a string should be returned and the user is // prompted to confirm the page unload, Electron gives developers more options. - // Returning an empty string or false will prevent the unloading. + // Returning an empty string or `false` will prevent the unloading. // You can also use the dialog API to let the user confirm closing the application. e.returnValue = false; }; @@ -295,7 +295,7 @@ Objects created with `new BrowserWindow` have the following instance methods: var BrowserWindow = require('browser-window'); // In this example `win` is our instance -var win = new BroswerWindow({width: 800, height: 1500}); +var win = new BrowserWindow({ width: 800, height: 600 }); ``` @@ -676,7 +676,7 @@ __Note:__ This API is only available on Windows (Windows 7 and above) ### `win.setThumbarButtons(buttons)` -`buttons` Array od `button` Objects: +`buttons` Array of `button` Objects: `button` Object, properties: @@ -688,7 +688,7 @@ __Note:__ This API is only available on Windows (Windows 7 and above) Strings: * `enabled` - The button is active and available to the user. * `disabled` - The button is disabled. It is present, but has a visual - state that indicates that it will not respond to user action. + state indicating it will not respond to user action. * `dismissonclick` - When the button is clicked, the taskbar button's flyout closes immediately. * `nobackground` - Do not draw a button border, use only the image. diff --git a/docs/api/session.md b/docs/api/session.md index 2211dce34ced..7812a43a135e 100644 --- a/docs/api/session.md +++ b/docs/api/session.md @@ -5,7 +5,7 @@ The `session` object is a property of [`webContents`](web-contents.md) which is ```javascript var BrowserWindow = require('browser-window'); -var win = new BroswerWindow({ width: 800, height: 600 }); +var win = new BrowserWindow({ width: 800, height: 600 }); win.loadUrl("http://github.com"); var session = win.webContents.session @@ -17,7 +17,7 @@ The `session` object has the following methods: ### session.cookies -The `cookies` gives you ability to query and modify cookies, an example is: +The `cookies` gives you ability to query and modify cookies. For example: ```javascript var BrowserWindow = require('browser-window'); @@ -33,7 +33,7 @@ win.webContents.on('did-finish-load', function() { console.log(cookies); }); - // Query all cookies that are associated with a specific url. + // Query all cookies associated with a specific url. win.webContents.session.cookies.get({ url : "http://www.github.com" }, function(error, cookies) { if (error) throw error; diff --git a/docs/api/web-contents.md b/docs/api/web-contents.md index 29987471881e..8e1420713cb7 100644 --- a/docs/api/web-contents.md +++ b/docs/api/web-contents.md @@ -8,7 +8,7 @@ It is responsible for rendering and controlling a web page and is a property of ```javascript var BrowserWindow = require('browser-window'); -var win = new BroswerWindow({width: 800, height: 1500}); +var win = new BrowserWindow({width: 800, height: 1500}); win.loadUrl("http://github.com"); var webContents = win.webContents @@ -163,7 +163,7 @@ See [session documentation](session.md) for this object's methods. * `httpReferrer` String - A HTTP Referrer url * `userAgent` String - A user agent originating the request -Loads the `url` in the window, the `url` must contains the protocol prefix, +Loads the `url` in the window, the `url` must contain the protocol prefix, e.g. the `http://` or `file://`. ### `webContents.getUrl()` @@ -177,11 +177,11 @@ win.loadUrl("http://github.com"); var currentUrl = win.webContents.getUrl(); ``` -Returns URL of current web page. +Returns URL of the current web page. ### `webContents.getTitle()` -Returns the title of web page. +Returns the title of the current web page. ### `webContents.isLoading()` @@ -189,7 +189,7 @@ Returns whether web page is still loading resources. ### `webContents.isWaitingForResponse()` -Returns whether web page is waiting for a first-response for the main resource +Returns whether the web page is waiting for a first-response for the main resource of the page. ### `webContents.stop()` @@ -198,7 +198,7 @@ Stops any pending navigation. ### `webContents.reload()` -Reloads current page. +Reloads the current web page. ### `webContents.reloadIgnoringCache()` @@ -206,11 +206,11 @@ Reloads current page and ignores cache. ### `webContents.canGoBack()` -Returns whether the web page can go back. +Returns whether the browser can go back to previous web page. ### `webContents.canGoForward()` -Returns whether the web page can go forward. +Returns whether the browser can go forward to next web page. ### `webContents.canGoToOffset(offset)` @@ -224,17 +224,17 @@ Clears the navigation history. ### `webContents.goBack()` -Makes the web page go back. +Makes the browser go back a web page. ### `webContents.goForward()` -Makes the web page go forward. +Makes the browser go forward a web page. ### `webContents.goToIndex(index)` * `index` Integer -Navigates to the specified absolute index. +Navigates browser to the specified absolute web page index. ### `webContents.goToOffset(offset)` @@ -254,13 +254,13 @@ Overrides the user agent for this page. ### `webContents.getUserAgent()` -Returns a `String` represents the user agent for this page. +Returns a `String` representing the user agent for this page. ### `webContents.insertCSS(css)` * `css` String -Injects CSS into this page. +Injects CSS into the current web page. ### `webContents.executeJavaScript(code[, userGesture])` @@ -269,15 +269,13 @@ Injects CSS into this page. Evaluates `code` in page. -In browser some HTML APIs like `requestFullScreen` can only be invoked if it -is started by user gesture, by specifying `userGesture` to `true` developers -can ignore this limitation. +In the browser window some HTML APIs like `requestFullScreen` can only be invoked by a gesture from the user. Setting `userGesture` to `true` will remove this limitation. ### `webContents.setAudioMuted(muted)` + `muted` Boolean -Set the page muted. +Mute the audio on the current web page. ### `webContents.isAudioMuted()` @@ -335,15 +333,15 @@ Executes editing command `replaceMisspelling` in page. * `callback` Function -Checks if any serviceworker is registered and returns boolean as +Checks if any ServiceWorker is registered and returns a boolean as response to `callback`. ### `webContents.unregisterServiceWorker(callback)` * `callback` Function -Unregisters any serviceworker if present and returns boolean as -response to `callback` when the JS promise is fullfilled or false +Unregisters any ServiceWorker if present and returns a boolean as +response to `callback` when the JS promise is fulfilled or false when the JS promise is rejected. ### `webContents.print([options])` @@ -361,7 +359,7 @@ Calling `window.print()` in web page is equivalent to call `webContents.print({silent: false, printBackground: false})`. **Note:** On Windows, the print API relies on `pdf.dll`. If your application -doesn't need print feature, you can safely remove `pdf.dll` in saving binary +doesn't need the print feature, you can safely remove `pdf.dll` to reduce binary size. ### `webContents.printToPDF(options, callback)` @@ -390,9 +388,16 @@ size. Prints window's web page as PDF with Chromium's preview printing custom settings. -By default, an empty `options` will be regarded as -`{marginsType:0, printBackgrounds:false, printSelectionOnly:false, - landscape:false}`. +By default, an empty `options` will be regarded as: + +```javascript +{ + marginsType:0, + printBackgrounds:false, + printSelectionOnly:false, + landscape:false +} +``` ```javascript var BrowserWindow = require('browser-window'); From c282d4c0ff88488ce8e9e2f84bbd3d30ae6c2055 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Mon, 24 Aug 2015 15:41:02 -0700 Subject: [PATCH 0962/1293] Line wrap 80-col --- docs/api/browser-window.md | 48 +++++++++++++++++++++++++++----------- docs/api/session.md | 16 +++++++++---- docs/api/web-contents.md | 16 ++++++++----- 3 files changed, 56 insertions(+), 24 deletions(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 905e926bb094..06fa17f2bfa2 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -1,6 +1,7 @@ # BrowserWindow -The `BrowserWindow` class gives you the ability to create a browser window, for example: +The `BrowserWindow` class gives you the ability to create a browser window, for +example: ```javascript var BrowserWindow = require('browser-window'); @@ -79,14 +80,14 @@ Properties `width` and `height` are required. textured window. Defaults to `true`. * `web-preferences` Object - Settings of web page's features, properties: * `javascript` Boolean - * `web-security` Boolean - When setting `false`, it will disable the same-origin - policy (Usually using testing websites by people), and set `allow_displaying_insecure_content` + * `web-security` Boolean - When setting `false`, it will disable the + same-origin policy (Usually using testing websites by people), and set `allow_displaying_insecure_content` and `allow_running_insecure_content` to `true` if these two options are not set by user. * `allow-displaying-insecure-content` Boolean - Allow an https page to display content like images from http URLs. - * `allow-running-insecure-content` Boolean - Allow a https page to run JavaScript, - CSS or plugins from http URLs. + * `allow-running-insecure-content` Boolean - Allow a https page to run + JavaScript, CSS or plugins from http URLs. * `images` Boolean * `java` Boolean * `text-areas-are-resizable` Boolean @@ -147,8 +148,13 @@ window.onbeforeunload = function(e) { // Unlike usual browsers, in which a string should be returned and the user is // prompted to confirm the page unload, Electron gives developers more options. // Returning an empty string or `false` will prevent the unloading. +<<<<<<< HEAD // You can also use the dialog API to let the user confirm closing the application. e.returnValue = false; +======= + // You can also use the dialog API to let the user confirm closing the app. + return false; +>>>>>>> Line wrap 80-col }; ``` @@ -235,7 +241,9 @@ Emitted when devtools is focused / opened. ### Event: 'app-command': -Emitted when an [App Command](https://msdn.microsoft.com/en-us/library/windows/desktop/ms646275(v=vs.85).aspx is invoked. These are typically related to keyboard media keys or browser commands, as well as the "Back" button built into some mice on Windows. +Emitted when an [App Command](https://msdn.microsoft.com/en-us/library/windows/desktop/ms646275(v=vs.85).aspx +is invoked. These are typically related to keyboard media keys or browser +commands, as well as the "Back" button built into some mice on Windows. ```js someWindow.on('app-command', function(e, cmd) { @@ -304,7 +312,8 @@ var win = new BrowserWindow({ width: 800, height: 600 }); The `WebContents` object this window owns, all web page related events and operations will be done via it. -See the [`webContents` documentation](web-contents.md) for its methods and events. +See the [`webContents` documentation](web-contents.md) for its methods and +events. **Note:** Users should never store this object because it may become `null` when the renderer process (web page) has crashed. @@ -395,14 +404,25 @@ Returns a boolean, whether the window is in fullscreen mode. ### `win.setAspectRatio(aspectRatio[, extraSize])` -* `aspectRatio` The aspect ratio we want to maintain for some portion of the content view. -* `rect` Object - The extra size to not be included in the aspect ratio to be maintained. Properties: +* `aspectRatio` The aspect ratio we want to maintain for some portion of the +content view. +* `rect` Object - The extra size to not be included in the aspect ratio to be +maintained. Properties: * `width` Integer * `height` Integer -This will have a window maintain an aspect ratio. The extra size allows a developer to have space, specified in pixels, not included within the aspect ratio calculations. This API already takes into account the difference between a window's size and its content size. +This will have a window maintain an aspect ratio. The extra size allows a +developer to have space, specified in pixels, not included within the aspect ratio calculations. This API already takes into account the difference between a +window's size and its content size. -Consider a normal window with an HD video player and associated controls. Perhaps there are 15 pixels of controls on the left edge, 25 pixels of controls on the right edge and 50 pixels of controls below the player. In order to maintain a 16:9 aspect ratio (standard aspect ratio for HD @1920x1080) within the player itself we would call this function with arguments of 16/9 and [ 40, 50 ]. The second argument doesn't care where the extra width and height are within the content view--only that they exist. Just sum any extra width and height areas you have within the overall content view. +Consider a normal window with an HD video player and associated controls. +Perhaps there are 15 pixels of controls on the left edge, 25 pixels of controls +on the right edge and 50 pixels of controls below the player. In order to +maintain a 16:9 aspect ratio (standard aspect ratio for HD @1920x1080) within +the player itself we would call this function with arguments of 16/9 and +[ 40, 50 ]. The second argument doesn't care where the extra width and height +are within the content view--only that they exist. Just sum any extra width and +height areas you have within the overall content view. __Note__: This API is only implemented on OS X. @@ -595,7 +615,8 @@ Starts inspecting element at position (`x`, `y`). ### `win.inspectServiceWorker()` -Opens the developer tools for the service worker context present in the web contents. +Opens the developer tools for the service worker context present in the web +contents. ### `win.focusOnWebView()` @@ -669,7 +690,8 @@ cleared * `description` String - a description that will be provided to Accessibility screen readers -Sets a 16px overlay onto the current taskbar icon, usually used to convey some sort of application status or to passively notify the user. +Sets a 16px overlay onto the current taskbar icon, usually used to convey some +sort of application status or to passively notify the user. __Note:__ This API is only available on Windows (Windows 7 and above) diff --git a/docs/api/session.md b/docs/api/session.md index 7812a43a135e..b589254087fe 100644 --- a/docs/api/session.md +++ b/docs/api/session.md @@ -1,6 +1,8 @@ # session -The `session` object is a property of [`webContents`](web-contents.md) which is a property of [`BrowserWindow`](browser-window.md). You can access it through an instance of `BrowserWindow`. For example: +The `session` object is a property of [`webContents`](web-contents.md) which is +a property of [`BrowserWindow`](browser-window.md). You can access it through an +instance of `BrowserWindow`. For example: ```javascript var BrowserWindow = require('browser-window'); @@ -58,7 +60,8 @@ win.webContents.on('did-finish-load', function() { * `url` String - Retrieves cookies which are associated with `url`. Empty implies retrieving cookies of all urls. * `name` String - Filters cookies by name -* `domain` String - Retrieves cookies whose domains match or are subdomains of `domains` +* `domain` String - Retrieves cookies whose domains match or are subdomains of + `domains` * `path` String - Retrieves cookies whose path matches `path` * `secure` Boolean - Filters cookies by their Secure property * `session` Boolean - Filters out session or persistent cookies. @@ -75,7 +78,8 @@ win.webContents.on('did-finish-load', function() { * `session` Boolean - Whether the cookie is a session cookie or a persistent cookie with an expiration date. * `expirationDate` Double - (Option) The expiration date of the cookie as - the number of seconds since the UNIX epoch. Not provided for session cookies. + the number of seconds since the UNIX epoch. Not provided for session + cookies. ### `session.cookies.set(details, callback)` @@ -86,8 +90,10 @@ win.webContents.on('did-finish-load', function() { * `value` String - The value of the cookie. Empty by default if omitted. * `domain` String - The domain of the cookie. Empty by default if omitted. * `path` String - The path of the cookie. Empty by default if omitted. -* `secure` Boolean - Whether the cookie should be marked as Secure. Defaults to false. -* `session` Boolean - Whether the cookie should be marked as HttpOnly. Defaults to false. +* `secure` Boolean - Whether the cookie should be marked as Secure. Defaults to + false. +* `session` Boolean - Whether the cookie should be marked as HttpOnly. Defaults + to false. * `expirationDate` Double - The expiration date of the cookie as the number of seconds since the UNIX epoch. If omitted, the cookie becomes a session cookie. diff --git a/docs/api/web-contents.md b/docs/api/web-contents.md index 8e1420713cb7..19193fc32f05 100644 --- a/docs/api/web-contents.md +++ b/docs/api/web-contents.md @@ -3,7 +3,9 @@ `webContents` is an [EventEmitter](http://nodejs.org/api/events.html#events_class_events_eventemitter). -It is responsible for rendering and controlling a web page and is a property of the [`BrowserWindow`](browser-window.md) object. An example of accessing the `webContents` object: +It is responsible for rendering and controlling a web page and is a property of +the [`BrowserWindow`](browser-window.md) object. An example of accessing the +`webContents` object: ```javascript var BrowserWindow = require('browser-window'); @@ -123,8 +125,8 @@ Returns: Emitted when user or the page wants to start a navigation, it can happen when `window.location` object is changed or user clicks a link in the page. -This event will not emit when the navigation is started programmatically with APIs -like `webContents.loadUrl` and `webContents.back`. +This event will not emit when the navigation is started programmatically with +APIs like `webContents.loadUrl` and `webContents.back`. Calling `event.preventDefault()` can prevent the navigation. @@ -189,8 +191,8 @@ Returns whether web page is still loading resources. ### `webContents.isWaitingForResponse()` -Returns whether the web page is waiting for a first-response for the main resource -of the page. +Returns whether the web page is waiting for a first-response for the main +resource of the page. ### `webContents.stop()` @@ -269,7 +271,9 @@ Injects CSS into the current web page. Evaluates `code` in page. -In the browser window some HTML APIs like `requestFullScreen` can only be invoked by a gesture from the user. Setting `userGesture` to `true` will remove this limitation. +In the browser window some HTML APIs like `requestFullScreen` can only be +invoked by a gesture from the user. Setting `userGesture` to `true` will remove +this limitation. ### `webContents.setAudioMuted(muted)` From 71f74f40421a86258d5acc21f52957d9cfb7361a Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Mon, 24 Aug 2015 15:45:54 -0700 Subject: [PATCH 0963/1293] Add platform label where applicable --- docs/api/browser-window.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 06fa17f2bfa2..b7ea92fb1351 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -660,7 +660,7 @@ Same as `webContents.loadUrl(url[, options])`. Same as `webContents.reload`. -### `win.setMenu(menu)` +### `win.setMenu(menu)` _OS X_ * `menu` Menu @@ -682,7 +682,7 @@ On Linux platform, only supports Unity desktop environment, you need to specify the `*.desktop` file name to `desktopName` field in `package.json`. By default, it will assume `app.getName().desktop`. -### `win.setOverlayIcon(overlay, description)` +### `win.setOverlayIcon(overlay, description)` _Windows_ * `overlay` [NativeImage](native-image.md) - the icon to display on the bottom right corner of the taskbar icon. If this parameter is `null`, the overlay is @@ -696,7 +696,7 @@ sort of application status or to passively notify the user. __Note:__ This API is only available on Windows (Windows 7 and above) -### `win.setThumbarButtons(buttons)` +### `win.setThumbarButtons(buttons)` _Windows_ `buttons` Array of `button` Objects: @@ -730,7 +730,7 @@ the limited room. Once you setup the thumbnail toolbar, the toolbar cannot be removed due to the platform's limitation. But you can call the API with an empty array to clean the buttons. -### `win.showDefinitionForSelection()` +### `win.showDefinitionForSelection()` _OS X_ Shows pop-up dictionary that searches the selected word on the page. From 38b519ceb5d3cf806115eaf054eab412ad8bc6cd Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Mon, 24 Aug 2015 15:55:53 -0700 Subject: [PATCH 0964/1293] Add (optional) notation --- docs/api/browser-window.md | 14 +++++++------- docs/api/session.md | 2 +- docs/api/web-contents.md | 9 +++++---- 3 files changed, 13 insertions(+), 12 deletions(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index b7ea92fb1351..8444412424eb 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -30,8 +30,8 @@ Properties `width` and `height` are required. `options` Object, properties: -* `width` Integer **required** - Window's width. -* `height` Integer **required** - Window's height. +* `width` Integer (**required**) - Window's width. +* `height` Integer (**required**) - Window's height. * `x` Integer - Window's left offset from screen. * `y` Integer - Window's top offset from screen. * `use-content-size` Boolean - The `width` and `height` would be used as web @@ -402,12 +402,12 @@ Sets whether the window should be in fullscreen mode. Returns a boolean, whether the window is in fullscreen mode. -### `win.setAspectRatio(aspectRatio[, extraSize])` +### `win.setAspectRatio(aspectRatio[, extraSize])` _OS X_ * `aspectRatio` The aspect ratio we want to maintain for some portion of the content view. -* `rect` Object - The extra size to not be included in the aspect ratio to be -maintained. Properties: +* `extraSize` Object (optional) - The extra size not to be included while +maintaining the aspect ratio. Properties: * `width` Integer * `height` Integer @@ -589,7 +589,7 @@ __Note__: This API is only available on OS X. ### `win.openDevTools([options])` -* `options` Object, optional. Properties: +* `options` Object (optional). Properties: * `detach` Boolean - opens devtools in a new window Opens the developer tools. @@ -624,7 +624,7 @@ contents. ### `win.capturePage([rect, ]callback)` -* `rect` Object - The area of page to be captured, properties: +* `rect` Object (optional)- The area of page to be captured, properties: * `x` Integer * `y` Integer * `width` Integer diff --git a/docs/api/session.md b/docs/api/session.md index b589254087fe..184d175227be 100644 --- a/docs/api/session.md +++ b/docs/api/session.md @@ -116,7 +116,7 @@ Clears the session’s HTTP cache. ### `session.clearStorageData([options, ]callback)` -* `options` Object +* `options` Object (optional) * `origin` String - Should follow `window.location.origin`’s representation `scheme://host:port` * `storages` Array - The types of storages to clear, can contain: diff --git a/docs/api/web-contents.md b/docs/api/web-contents.md index 19193fc32f05..fe68d8a6a6f2 100644 --- a/docs/api/web-contents.md +++ b/docs/api/web-contents.md @@ -161,7 +161,7 @@ See [session documentation](session.md) for this object's methods. ### `webContents.loadUrl(url[, options])` * `url` URL -* `options` Object, properties: +* `options` Object (optional). Properties: * `httpReferrer` String - A HTTP Referrer url * `userAgent` String - A user agent originating the request @@ -267,7 +267,7 @@ Injects CSS into the current web page. ### `webContents.executeJavaScript(code[, userGesture])` * `code` String -* `userGesture` Boolean +* `userGesture` Boolean (optional) Evaluates `code` in page. @@ -350,7 +350,7 @@ when the JS promise is rejected. ### `webContents.print([options])` -`options` Object, properties: +`options` Object (optional). Properties: * `silent` Boolean - Don't ask user for print settings, defaults to `false` * `printBackground` Boolean - Also prints the background color and image of @@ -438,8 +438,9 @@ Removes the specified path from devtools workspace. ### `webContents.send(channel[, args...])` * `channel` String +* `args...` (optional) -Send `args..` to the web page via `channel` in an asynchronous message, the web +Send `args...` to the web page via `channel` in an asynchronous message, the web page can handle it by listening to the `channel` event of the `ipc` module. An example of sending messages from the main process to the renderer process: From 5f1897713c650baad2c8996e0d451973989ac28d Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Wed, 26 Aug 2015 13:57:42 -0700 Subject: [PATCH 0965/1293] Edits, grammar, punctuation and merge conflicts --- docs/api/browser-window.md | 607 +------------------------------------ docs/api/session.md | 18 +- docs/api/web-contents.md | 73 +++-- 3 files changed, 56 insertions(+), 642 deletions(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 8444412424eb..14999b694a0d 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -1,6 +1,6 @@ # BrowserWindow -The `BrowserWindow` class gives you the ability to create a browser window, for +The `BrowserWindow` class gives you the ability to create a browser window. For example: ```javascript @@ -147,14 +147,9 @@ window.onbeforeunload = function(e) { // Unlike usual browsers, in which a string should be returned and the user is // prompted to confirm the page unload, Electron gives developers more options. - // Returning an empty string or `false` will prevent the unloading. -<<<<<<< HEAD + // Returning empty string or false would prevent the unloading now. // You can also use the dialog API to let the user confirm closing the application. e.returnValue = false; -======= - // You can also use the dialog API to let the user confirm closing the app. - return false; ->>>>>>> Line wrap 80-col }; ``` @@ -307,7 +302,7 @@ var win = new BrowserWindow({ width: 800, height: 600 }); ``` -### `win.webContents` +### `win.webContents()` The `WebContents` object this window owns, all web page related events and operations will be done via it. @@ -318,14 +313,14 @@ events. **Note:** Users should never store this object because it may become `null` when the renderer process (web page) has crashed. -### `win.devToolsWebContents` +### `win.devToolsWebContents()` Get the `WebContents` of devtools for this window. **Note:** Users should never store this object because it may become `null` when the devtools has been closed. -### `win.id` +### `win.id()` Get the unique ID of this window. @@ -335,7 +330,8 @@ Force closing the window, the `unload` and `beforeunload` event won't be emitted for the web page, and `close` event will also not be emitted for this window, but it guarantees the `closed` event will be emitted. -You should only use this method when the renderer process (web page) has crashed. +You should only use this method when the renderer process (web page) has +crashed. ### `win.close()` @@ -412,7 +408,8 @@ maintaining the aspect ratio. Properties: * `height` Integer This will have a window maintain an aspect ratio. The extra size allows a -developer to have space, specified in pixels, not included within the aspect ratio calculations. This API already takes into account the difference between a +developer to have space, specified in pixels, not included within the aspect +ratio calculations. This API already takes into account the difference between a window's size and its content size. Consider a normal window with an HD video player and associated controls. @@ -631,20 +628,12 @@ contents. * `height` Integer * `callback` Function -Captures a snapshot of the page within `rect`. Upon completion `callback` will be -called with `callback(image)`. The `image` is an instance of +Captures a snapshot of the page within `rect`. Upon completion `callback` will +be called with `callback(image)`. The `image` is an instance of [NativeImage](native-image.md) that stores data of the snapshot. Omitting `rect` will capture the whole visible page. -<<<<<<< HEAD -### BrowserWindow.print([options]) -======= -**Note:** Be sure to read documents on remote buffer in -[remote](remote.md) if you are going to use this API in renderer -process. - ### `win.print([options])` ->>>>>>> Break out methods, standardize Same as `webContents.print([options])` @@ -774,577 +763,3 @@ Sets whether the window should be visible on all workspaces. Returns whether the window is visible on all workspaces. **Note:** This API always returns false on Windows. -<<<<<<< HEAD - -## Class: WebContents - -A `WebContents` is responsible for rendering and controlling a web page. - -`WebContents` is an -[EventEmitter](http://nodejs.org/api/events.html#events_class_events_eventemitter). - -### Event: 'did-finish-load' - -Emitted when the navigation is done, i.e. the spinner of the tab will stop -spinning, and the `onload` event was dispatched. - -### Event: 'did-fail-load' - -* `event` Event -* `errorCode` Integer -* `errorDescription` String - -This event is like `did-finish-load`, but emitted when the load failed or was -cancelled, e.g. `window.stop()` is invoked. - -### Event: 'did-frame-finish-load' - -* `event` Event -* `isMainFrame` Boolean - -Emitted when a frame has done navigation. - -### Event: 'did-start-loading' - -Corresponds to the points in time when the spinner of the tab starts spinning. - -### Event: 'did-stop-loading' - -Corresponds to the points in time when the spinner of the tab stops spinning. - -### Event: 'did-get-response-details' - -* `event` Event -* `status` Boolean -* `newUrl` String -* `originalUrl` String -* `httpResponseCode` Integer -* `requestMethod` String -* `referrer` String -* `headers` Object - -Emitted when details regarding a requested resource is available. -`status` indicates the socket connection to download the resource. - -### Event: 'did-get-redirect-request' - -* `event` Event -* `oldUrl` String -* `newUrl` String -* `isMainFrame` Boolean - -Emitted when a redirect was received while requesting a resource. - -### Event: 'dom-ready' - -* `event` Event - -Emitted when document in the given frame is loaded. - -### Event: 'page-favicon-updated' - -* `event` Event -* `favicons` Array - Array of Urls - -Emitted when page receives favicon urls. - -### Event: 'new-window' - -* `event` Event -* `url` String -* `frameName` String -* `disposition` String - Can be `default`, `foreground-tab`, `background-tab`, - `new-window` and `other` - -Emitted when the page requested to open a new window for `url`. It could be -requested by `window.open` or an external link like ``. - -By default a new `BrowserWindow` will be created for the `url`. - -Calling `event.preventDefault()` can prevent creating new windows. - -### Event: 'will-navigate' - -* `event` Event -* `url` String - -Emitted when user or the page wants to start a navigation, it can happen when -`window.location` object is changed or user clicks a link in the page. - -This event will not emit when the navigation is started programmatically with APIs -like `WebContents.loadUrl` and `WebContents.back`. - -Calling `event.preventDefault()` can prevent the navigation. - -### Event: 'crashed' - -Emitted when the renderer process is crashed. - -### Event: 'plugin-crashed' - -* `event` Event -* `name` String -* `version` String - -Emitted when a plugin process is crashed. - -### Event: 'destroyed' - -Emitted when the WebContents is destroyed. - -### WebContents.session - -Returns the `Session` object used by this WebContents. - -### WebContents.loadUrl(url, [options]) - -* `url` URL -* `options` URL - * `httpReferrer` String - A HTTP Referer url - * `userAgent` String - A user agent originating the request - -Loads the `url` in the window, the `url` must contains the protocol prefix, -e.g. the `http://` or `file://`. - -### WebContents.getUrl() - -Returns URL of current web page. - -### WebContents.getTitle() - -Returns the title of web page. - -### WebContents.isLoading() - -Returns whether web page is still loading resources. - -### WebContents.isWaitingForResponse() - -Returns whether web page is waiting for a first-response for the main resource -of the page. - -### WebContents.stop() - -Stops any pending navigation. - -### WebContents.reload() - -Reloads current page. - -### WebContents.reloadIgnoringCache() - -Reloads current page and ignores cache. - -### WebContents.canGoBack() - -Returns whether the web page can go back. - -### WebContents.canGoForward() - -Returns whether the web page can go forward. - -### WebContents.canGoToOffset(offset) - -* `offset` Integer - -Returns whether the web page can go to `offset`. - -### WebContents.clearHistory() - -Clears the navigation history. - -### WebContents.goBack() - -Makes the web page go back. - -### WebContents.goForward() - -Makes the web page go forward. - -### WebContents.goToIndex(index) - -* `index` Integer - -Navigates to the specified absolute index. - -### WebContents.goToOffset(offset) - -* `offset` Integer - -Navigates to the specified offset from the "current entry". - -### WebContents.isCrashed() - -Whether the renderer process has crashed. - -### WebContents.setUserAgent(userAgent) - -* `userAgent` String - -Overrides the user agent for this page. - -### WebContents.getUserAgent() - -Returns a `String` represents the user agent for this page. - -### WebContents.insertCSS(css) - -* `css` String - -Injects CSS into this page. - -### WebContents.executeJavaScript(code[, userGesture]) - -* `code` String -* `userGesture` Boolean - -Evaluates `code` in page. - -In browser some HTML APIs like `requestFullScreen` can only be invoked if it -is started by user gesture, by specifying `userGesture` to `true` developers -can ignore this limitation. - -### WebContents.setAudioMuted(muted) - -+ `muted` Boolean - -Set the page muted. - -### WebContents.isAudioMuted() - -Returns whether this page has been muted. - -### WebContents.undo() - -Executes editing command `undo` in page. - -### WebContents.redo() - -Executes editing command `redo` in page. - -### WebContents.cut() - -Executes editing command `cut` in page. - -### WebContents.copy() - -Executes editing command `copy` in page. - -### WebContents.paste() - -Executes editing command `paste` in page. - -### WebContents.pasteAndMatchStyle() - -Executes editing command `pasteAndMatchStyle` in page. - -### WebContents.delete() - -Executes editing command `delete` in page. - -### WebContents.selectAll() - -Executes editing command `selectAll` in page. - -### WebContents.unselect() - -Executes editing command `unselect` in page. - -### WebContents.replace(text) - -* `text` String - -Executes editing command `replace` in page. - -### WebContents.replaceMisspelling(text) - -* `text` String - -Executes editing command `replaceMisspelling` in page. - -### WebContents.hasServiceWorker(callback) - -* `callback` Function - -Checks if any serviceworker is registered and returns boolean as -response to `callback`. - -### WebContents.unregisterServiceWorker(callback) - -* `callback` Function - -Unregisters any serviceworker if present and returns boolean as -response to `callback` when the JS promise is fullfilled or false -when the JS promise is rejected. - -### WebContents.print([options]) - -* `options` Object - * `silent` Boolean - Don't ask user for print settings, defaults to `false` - * `printBackground` Boolean - Also prints the background color and image of - the web page, defaults to `false`. - -Prints window's web page. When `silent` is set to `false`, Electron will pick -up system's default printer and default settings for printing. - -Calling `window.print()` in web page is equivalent to call -`WebContents.print({silent: false, printBackground: false})`. - -**Note:** On Windows, the print API relies on `pdf.dll`. If your application -doesn't need print feature, you can safely remove `pdf.dll` in saving binary -size. - -### WebContents.printToPDF(options, callback) - -* `options` Object - * `marginsType` Integer - Specify the type of margins to use - * 0 - default - * 1 - none - * 2 - minimum - * `pageSize` String - Specify page size of the generated PDF - * `A4` - * `A3` - * `Legal` - * `Letter` - * `Tabloid` - * `printBackground` Boolean - Whether to print CSS backgrounds. - * `printSelectionOnly` Boolean - Whether to print selection only. - * `landscape` Boolean - `true` for landscape, `false` for portrait. - -* `callback` Function - `function(error, data) {}` - * `error` Error - * `data` Buffer - PDF file content - -Prints windows' web page as PDF with Chromium's preview printing custom -settings. - -By default, an empty `options` will be regarded as -`{marginsType:0, printBackground:false, printSelectionOnly:false, - landscape:false}`. - -```javascript -var BrowserWindow = require('browser-window'); -var fs = require('fs'); - -var win = new BrowserWindow({width: 800, height: 600}); -win.loadUrl("http://github.com"); - -win.webContents.on("did-finish-load", function() { - // Use default printing options - win.webContents.printToPDF({}, function(error, data) { - if (error) throw error; - fs.writeFile("/tmp/print.pdf", data, function(error) { - if (err) - throw error; - console.log("Write PDF successfully."); - }) - }) -}); -``` - -### WebContents.addWorkSpace(path) - -* `path` String - -Adds the specified path to devtools workspace. - -### WebContents.removeWorkSpace(path) - -* `path` String - -Removes the specified path from devtools workspace. - -### WebContents.send(channel[, args...]) - -* `channel` String - -Send `args..` to the web page via `channel` in asynchronous message, the web -page can handle it by listening to the `channel` event of `ipc` module. - -An example of sending messages from the main process to the renderer process: - -```javascript -// On the main process. -var window = null; -app.on('ready', function() { - window = new BrowserWindow({width: 800, height: 600}); - window.loadUrl('file://' + __dirname + '/index.html'); - window.webContents.on('did-finish-load', function() { - window.webContents.send('ping', 'whoooooooh!'); - }); -}); -``` - -```html -// index.html - - - - - -``` - -**Note:** - -1. The IPC message handler in web pages do not have a `event` parameter, which - is different from the handlers on the main process. -2. There is no way to send synchronous messages from the main process to a - renderer process, because it would be very easy to cause dead locks. - -## Class: Session - -### Session.cookies - -The `cookies` gives you ability to query and modify cookies, an example is: - -```javascript -var BrowserWindow = require('browser-window'); - -var win = new BrowserWindow({ width: 800, height: 600 }); - -win.loadUrl('https://github.com'); - -win.webContents.on('did-finish-load', function() { - // Query all cookies. - win.webContents.session.cookies.get({}, function(error, cookies) { - if (error) throw error; - console.log(cookies); - }); - - // Query all cookies that are associated with a specific url. - win.webContents.session.cookies.get({ url : "http://www.github.com" }, - function(error, cookies) { - if (error) throw error; - console.log(cookies); - }); - - // Set a cookie with the given cookie data; - // may overwrite equivalent cookies if they exist. - win.webContents.session.cookies.set( - { url : "http://www.github.com", name : "dummy_name", value : "dummy"}, - function(error, cookies) { - if (error) throw error; - console.log(cookies); - }); -}); -``` - -### Session.cookies.get(details, callback) - -* `details` Object - * `url` String - Retrieves cookies which are associated with `url`. - Empty imples retrieving cookies of all urls. - * `name` String - Filters cookies by name - * `domain` String - Retrieves cookies whose domains match or are subdomains of `domains` - * `path` String - Retrieves cookies whose path matches `path` - * `secure` Boolean - Filters cookies by their Secure property - * `session` Boolean - Filters out session or persistent cookies. -* `callback` Function - function(error, cookies) - * `error` Error - * `cookies` Array - array of `cookie` objects. - * `cookie` - Object - * `name` String - The name of the cookie - * `value` String - The value of the cookie - * `domain` String - The domain of the cookie - * `host_only` String - Whether the cookie is a host-only cookie - * `path` String - The path of the cookie - * `secure` Boolean - Whether the cookie is marked as Secure (typically HTTPS) - * `http_only` Boolean - Whether the cookie is marked as HttpOnly - * `session` Boolean - Whether the cookie is a session cookie or a persistent - cookie with an expiration date. - * `expirationDate` Double - (Option) The expiration date of the cookie as - the number of seconds since the UNIX epoch. Not provided for session cookies. - - -### Session.cookies.set(details, callback) - -* `details` Object - * `url` String - Retrieves cookies which are associated with `url` - * `name` String - The name of the cookie. Empty by default if omitted. - * `value` String - The value of the cookie. Empty by default if omitted. - * `domain` String - The domain of the cookie. Empty by default if omitted. - * `path` String - The path of the cookie. Empty by default if omitted. - * `secure` Boolean - Whether the cookie should be marked as Secure. Defaults to false. - * `session` Boolean - Whether the cookie should be marked as HttpOnly. Defaults to false. - * `expirationDate` Double - The expiration date of the cookie as the number of - seconds since the UNIX epoch. If omitted, the cookie becomes a session cookie. - -* `callback` Function - function(error) - * `error` Error - -### Session.cookies.remove(details, callback) - -* `details` Object - * `url` String - The URL associated with the cookie - * `name` String - The name of cookie to remove -* `callback` Function - function(error) - * `error` Error - -### Session.clearCache(callback) - -* `callback` Function - Called when operation is done - -Clears the session's HTTP cache. - -### Session.clearStorageData([options, ]callback) - -* `options` Object - * `origin` String - Should follow `window.location.origin`'s representation - `scheme://host:port` - * `storages` Array - The types of storages to clear, can contain: - `appcache`, `cookies`, `filesystem`, `indexdb`, `localstorage`, - `shadercache`, `websql`, `serviceworkers` - * `quotas` Array - The types of quotas to clear, can contain: - `temporary`, `persistent`, `syncable` -* `callback` Function - Called when operation is done - -Clears the data of web storages. - -### Session.setProxy(config, callback) - -* `config` String -* `callback` Function - Called when operation is done - -Parses the `config` indicating which proxies to use for the session. - -``` -config = scheme-proxies[";"] -scheme-proxies = ["="] -url-scheme = "http" | "https" | "ftp" | "socks" -proxy-uri-list = [","] -proxy-uri = ["://"][":"] - - For example: - "http=foopy:80;ftp=foopy2" -- use HTTP proxy "foopy:80" for http:// - URLs, and HTTP proxy "foopy2:80" for - ftp:// URLs. - "foopy:80" -- use HTTP proxy "foopy:80" for all URLs. - "foopy:80,bar,direct://" -- use HTTP proxy "foopy:80" for all URLs, - failing over to "bar" if "foopy:80" is - unavailable, and after that using no - proxy. - "socks4://foopy" -- use SOCKS v4 proxy "foopy:1080" for all - URLs. - "http=foopy,socks5://bar.com -- use HTTP proxy "foopy" for http URLs, - and fail over to the SOCKS5 proxy - "bar.com" if "foopy" is unavailable. - "http=foopy,direct:// -- use HTTP proxy "foopy" for http URLs, - and use no proxy if "foopy" is - unavailable. - "http=foopy;socks=foopy2 -- use HTTP proxy "foopy" for http URLs, - and use socks4://foopy2 for all other - URLs. -``` - -### Session.setDownloadPath(path) - -* `path` String - The download location - -Sets download saving directory. By default, the download directory will be the -`Downloads` under the respective app folder. -======= ->>>>>>> Break out methods, standardize diff --git a/docs/api/session.md b/docs/api/session.md index 184d175227be..7b0c1b44c7dc 100644 --- a/docs/api/session.md +++ b/docs/api/session.md @@ -17,7 +17,7 @@ var session = win.webContents.session The `session` object has the following methods: -### session.cookies +### `session.cookies` The `cookies` gives you ability to query and modify cookies. For example: @@ -55,7 +55,7 @@ win.webContents.on('did-finish-load', function() { ### `session.cookies.get(details, callback)` -`details` Object +`details` Object, properties: * `url` String - Retrieves cookies which are associated with `url`. Empty implies retrieving cookies of all urls. @@ -83,7 +83,7 @@ win.webContents.on('did-finish-load', function() { ### `session.cookies.set(details, callback)` -`details` Object +`details` Object, properties: * `url` String - Retrieves cookies which are associated with `url` * `name` String - The name of the cookie. Empty by default if omitted. @@ -102,7 +102,7 @@ win.webContents.on('did-finish-load', function() { ### `session.cookies.remove(details, callback)` -* `details` Object +* `details` Object, proprties: * `url` String - The URL associated with the cookie * `name` String - The name of cookie to remove * `callback` Function - function(error) @@ -116,22 +116,22 @@ Clears the session’s HTTP cache. ### `session.clearStorageData([options, ]callback)` -* `options` Object (optional) +* `options` Object (optional), proprties: * `origin` String - Should follow `window.location.origin`’s representation - `scheme://host:port` + `scheme://host:port`. * `storages` Array - The types of storages to clear, can contain: `appcache`, `cookies`, `filesystem`, `indexdb`, `local storage`, `shadercache`, `websql`, `serviceworkers` * `quotas` Array - The types of quotas to clear, can contain: - `temporary`, `persistent`, `syncable` -* `callback` Function - Called when operation is done + `temporary`, `persistent`, `syncable`. +* `callback` Function - Called when operation is done. Clears the data of web storages. ### `session.setProxy(config, callback)` * `config` String -* `callback` Function - Called when operation is done +* `callback` Function - Called when operation is done. Parses the `config` indicating which proxies to use for the session. diff --git a/docs/api/web-contents.md b/docs/api/web-contents.md index fe68d8a6a6f2..89afae43d1c0 100644 --- a/docs/api/web-contents.md +++ b/docs/api/web-contents.md @@ -13,8 +13,7 @@ var BrowserWindow = require('browser-window'); var win = new BrowserWindow({width: 800, height: 1500}); win.loadUrl("http://github.com"); -var webContents = win.webContents - +var webContents = win.webContents; ``` ## Events @@ -67,7 +66,7 @@ Returns: * `referrer` String * `headers` Object -Emitted when details regarding a requested resource is available. +Emitted when details regarding a requested resource are available. `status` indicates the socket connection to download the resource. ### Event: 'did-get-redirect-request' @@ -79,7 +78,7 @@ Returns: * `newUrl` String * `isMainFrame` Boolean -Emitted when a redirect was received while requesting a resource. +Emitted when a redirect is received while requesting a resource. ### Event: 'dom-ready' @@ -106,14 +105,14 @@ Returns: * `url` String * `frameName` String * `disposition` String - Can be `default`, `foreground-tab`, `background-tab`, - `new-window` and `other` + `new-window` and `other`. Emitted when the page requests to open a new window for a `url`. It could be requested by `window.open` or an external link like ``. By default a new `BrowserWindow` will be created for the `url`. -Calling `event.preventDefault()` can prevent creating new windows. +Calling `event.preventDefault()` will prevent creating new windows. ### Event: 'will-navigate' @@ -122,13 +121,13 @@ Returns: * `event` Event * `url` String -Emitted when user or the page wants to start a navigation, it can happen when -`window.location` object is changed or user clicks a link in the page. +Emitted when a user or the page wants to start navigation. It can happen when the +`window.location` object is changed or a user clicks a link in the page. This event will not emit when the navigation is started programmatically with APIs like `webContents.loadUrl` and `webContents.back`. -Calling `event.preventDefault()` can prevent the navigation. +Calling `event.preventDefault()` will prevent the navigation. ### Event: 'crashed' @@ -154,16 +153,16 @@ The `webContents` object has the following instance methods: ### `webContents.session` -Returns the `Session` object used by this webContents. +Returns the `session` object used by this webContents. See [session documentation](session.md) for this object's methods. ### `webContents.loadUrl(url[, options])` * `url` URL -* `options` Object (optional). Properties: - * `httpReferrer` String - A HTTP Referrer url - * `userAgent` String - A user agent originating the request +* `options` Object (optional), properties: + * `httpReferrer` String - A HTTP Referrer url. + * `userAgent` String - A user agent originating the request. Loads the `url` in the window, the `url` must contain the protocol prefix, e.g. the `http://` or `file://`. @@ -191,7 +190,7 @@ Returns whether web page is still loading resources. ### `webContents.isWaitingForResponse()` -Returns whether the web page is waiting for a first-response for the main +Returns whether the web page is waiting for a first-response from the main resource of the page. ### `webContents.stop()` @@ -252,11 +251,11 @@ Whether the renderer process has crashed. * `userAgent` String -Overrides the user agent for this page. +Overrides the user agent for this web page. ### `webContents.getUserAgent()` -Returns a `String` representing the user agent for this page. +Returns a `String` representing the user agent for this web page. ### `webContents.insertCSS(css)` @@ -287,51 +286,51 @@ Returns whether this page has been muted. ### `webContents.undo()` -Executes editing command `undo` in page. +Executes the editing command `undo` in web page. ### `webContents.redo()` -Executes editing command `redo` in page. +Executes the editing command `redo` in web page. ### `webContents.cut()` -Executes editing command `cut` in page. +Executes the editing command `cut` in web page. ### `webContents.copy()` -Executes editing command `copy` in page. +Executes the editing command `copy` in web page. ### `webContents.paste()` -Executes editing command `paste` in page. +Executes the editing command `paste` in web page. ### `webContents.pasteAndMatchStyle()` -Executes editing command `pasteAndMatchStyle` in page. +Executes the editing command `pasteAndMatchStyle` in web page. ### `webContents.delete()` -Executes editing command `delete` in page. +Executes the editing command `delete` in web page. ### `webContents.selectAll()` -Executes editing command `selectAll` in page. +Executes the editing command `selectAll` in web page. ### `webContents.unselect()` -Executes editing command `unselect` in page. +Executes the editing command `unselect` in web page. ### `webContents.replace(text)` * `text` String -Executes editing command `replace` in page. +Executes the editing command `replace` in web page. ### `webContents.replaceMisspelling(text)` * `text` String -Executes editing command `replaceMisspelling` in page. +Executes the editing command `replaceMisspelling` in web page. ### `webContents.hasServiceWorker(callback)` @@ -350,7 +349,7 @@ when the JS promise is rejected. ### `webContents.print([options])` -`options` Object (optional). Properties: +`options` Object (optional), properties: * `silent` Boolean - Don't ask user for print settings, defaults to `false` * `printBackground` Boolean - Also prints the background color and image of @@ -359,7 +358,7 @@ when the JS promise is rejected. Prints window's web page. When `silent` is set to `false`, Electron will pick up system's default printer and default settings for printing. -Calling `window.print()` in web page is equivalent to call +Calling `window.print()` in web page is equivalent to calling `webContents.print({silent: false, printBackground: false})`. **Note:** On Windows, the print API relies on `pdf.dll`. If your application @@ -374,7 +373,7 @@ size. * 0 - default * 1 - none * 2 - minimum -* `pageSize` String - Specify page size of the generated PDF +* `pageSize` String - Specify page size of the generated PDF. * `A4` * `A3` * `Legal` @@ -387,7 +386,7 @@ size. `callback` Function - `function(error, data) {}` * `error` Error -* `data` Buffer - PDF file content +* `data` Buffer - PDF file content. Prints window's web page as PDF with Chromium's preview printing custom settings. @@ -396,10 +395,10 @@ By default, an empty `options` will be regarded as: ```javascript { - marginsType:0, - printBackgrounds:false, - printSelectionOnly:false, - landscape:false + marginsType: 0, + printBackground: false, + printSelectionOnly: false, + landscape: false } ``` @@ -472,7 +471,7 @@ app.on('ready', function() { **Note:** -1. The IPC message handler in web pages does not have an `event` parameter, which - is different from the handlers on the main process. +1. The IPC message handler in web pages does not have an `event` parameter, + which is different from the handlers on the main process. 2. There is no way to send synchronous messages from the main process to a renderer process, because it would be very easy to cause dead locks. From 4e781eb0421bf9caa3163b023cb2d609a90817cb Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Wed, 26 Aug 2015 14:05:47 -0700 Subject: [PATCH 0966/1293] Add platform labels --- docs/api/browser-window.md | 37 ++++++++----------------------------- 1 file changed, 8 insertions(+), 29 deletions(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 14999b694a0d..66218ecb3b73 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -200,12 +200,10 @@ Emitted when the window is getting moved to a new position. __Note__: On OS X this event is just an alias of `moved`. -### Event: 'moved' +### Event: 'moved' _OS X_ Emitted once when the window is moved to a new position. -__Note__: This event is available only on OS X. - ### Event: 'enter-full-screen' Emitted when the window enters full screen state. @@ -234,7 +232,7 @@ Emitted when devtools is closed. Emitted when devtools is focused / opened. -### Event: 'app-command': +### Event: 'app-command' _Windows_ Emitted when an [App Command](https://msdn.microsoft.com/en-us/library/windows/desktop/ms646275(v=vs.85).aspx is invoked. These are typically related to keyboard media keys or browser @@ -249,8 +247,6 @@ someWindow.on('app-command', function(e, cmd) { }); ``` -__Note__: This event is only fired on Windows. - ## Methods The `BrowserWindow` object has the following methods: @@ -421,8 +417,6 @@ the player itself we would call this function with arguments of 16/9 and are within the content view--only that they exist. Just sum any extra width and height areas you have within the overall content view. -__Note__: This API is only implemented on OS X. - ### `win.setBounds(options)` `options` Object, properties: @@ -554,36 +548,28 @@ Enters or leaves the kiosk mode. Returns whether the window is in kiosk mode. -### `win.setRepresentedFilename(filename)` +### `win.setRepresentedFilename(filename)` _OS X_ * `filename` String Sets the pathname of the file the window represents, and the icon of the file will show in window's title bar. -__Note__: This API is only available on OS X. - -### `win.getRepresentedFilename()` +### `win.getRepresentedFilename()` _OS X_ Returns the pathname of the file the window represents. -__Note__: This API is only available on OS X. - -### `win.setDocumentEdited(edited)` +### `win.setDocumentEdited(edited)` _OS X_ * `edited` Boolean Specifies whether the window’s document has been edited, and the icon in title bar will become grey when set to `true`. -__Note__: This API is only available on OS X. - -### `win.IsDocumentEdited()` +### `win.IsDocumentEdited()` _OS X_ Whether the window's document has been edited. -__Note__: This API is only available on OS X. - ### `win.openDevTools([options])` * `options` Object (optional). Properties: @@ -656,8 +642,6 @@ Same as `webContents.reload`. Sets the `menu` as the window's menu bar, setting it to `null` will remove the menu bar. -__Note:__ This API is not available on OS X. - ### `win.setProgressBar(progress)` * `progress` Double @@ -671,7 +655,7 @@ On Linux platform, only supports Unity desktop environment, you need to specify the `*.desktop` file name to `desktopName` field in `package.json`. By default, it will assume `app.getName().desktop`. -### `win.setOverlayIcon(overlay, description)` _Windows_ +### `win.setOverlayIcon(overlay, description)` _Windows 7+_ * `overlay` [NativeImage](native-image.md) - the icon to display on the bottom right corner of the taskbar icon. If this parameter is `null`, the overlay is @@ -682,10 +666,8 @@ screen readers Sets a 16px overlay onto the current taskbar icon, usually used to convey some sort of application status or to passively notify the user. -__Note:__ This API is only available on Windows (Windows 7 and above) - -### `win.setThumbarButtons(buttons)` _Windows_ +### `win.setThumbarButtons(buttons)` _Windows 7+_ `buttons` Array of `button` Objects: @@ -713,7 +695,6 @@ Add a thumbnail toolbar with a specified set of buttons to the thumbnail image of a window in a taskbar button layout. Returns a `Boolean` object indicates whether the thumbnail has been added successfully. -__Note:__ This API is only available on Windows (Windows 7 and above). The number of buttons in thumbnail toolbar should be no greater than 7 due to the limited room. Once you setup the thumbnail toolbar, the toolbar cannot be removed due to the platform's limitation. But you can call the API with an empty @@ -723,8 +704,6 @@ array to clean the buttons. Shows pop-up dictionary that searches the selected word on the page. -__Note__: This API is only available on OS X. - ### `win.setAutoHideMenuBar(hide)` * `hide` Boolean From 71fa87e4ed2b707f837ce56df326b3a1b18afe13 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Wed, 26 Aug 2015 14:14:59 -0700 Subject: [PATCH 0967/1293] Note about platform specific apis --- docs/api/browser-window.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 66218ecb3b73..dada6083ea61 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -117,6 +117,8 @@ Properties `width` and `height` are required. The `BrowserWindow` object emits the following events: ++**Note** Some events are only available on specific operating systems and are labeled as such. + ### Event: 'page-title-updated' Returns: @@ -290,6 +292,8 @@ Remove the devtools extension whose name is `name`. Objects created with `new BrowserWindow` have the following instance methods: ++**Note** Some methods are only available on specific operating systems and are labeled as such. + ```javascript var BrowserWindow = require('browser-window'); From 3001ef79806ae6b0941f8d97c9d05f43e08c9c0c Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Wed, 26 Aug 2015 14:56:00 -0700 Subject: [PATCH 0968/1293] General text edits to content-tracing --- docs/api/content-tracing.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/api/content-tracing.md b/docs/api/content-tracing.md index 264eda975d44..3e266b385581 100644 --- a/docs/api/content-tracing.md +++ b/docs/api/content-tracing.md @@ -1,6 +1,6 @@ -# content-trace +# content-tracing -The `content-trace` module is used to collect tracing data generated by the +The `content-tracing` module is used to collect tracing data generated by the underlying Chromium content module. This module does not include a web interface so you need to open `chrome://tracing/` in a Chrome browser and load the generated file to view the result. @@ -20,7 +20,7 @@ tracing.startRecording('*', tracing.DEFAULT_OPTIONS, function() { ## Methods -- The `content-trace` module has the following methods: +The `content-tracing` module has the following methods: ### `tracing.getCategories(callback)` @@ -29,8 +29,8 @@ tracing.startRecording('*', tracing.DEFAULT_OPTIONS, function() { Get a set of category groups. The category groups can change as new code paths are reached. -Once all child processes have acked to the `getCategories` request, `callback` -is invoked with an array of category groups. +Once all child processes have acknowledged the `getCategories` request the +`callback` is invoked with an array of category groups. ### `tracing.startRecording(categoryFilter, traceOptions, callback)` @@ -42,7 +42,7 @@ Start recording on all processes. Recording begins immediately locally and asynchronously on child processes as soon as they receive the EnableRecording request. Once all child processes -have acked to the `startRecording` request the `callback` will be called. +have acknowledged the `startRecording` request the `callback` will be called. `categoryFilter` is a filter to control what category groups should be traced. A filter can have an optional `-` prefix to exclude category groups @@ -66,8 +66,8 @@ list. Possible options are: The first 3 options are trace recoding modes and hence mutually exclusive. If more than one trace recording modes appear in the `traceOptions` string, -the last one takes precedence. If none of the trace recording mode is specified, -recording mode is `record-until-full`. +the last one takes precedence. If none of the trace recording modes is +specified, recording mode is `record-until-full`. The trace option will first be reset to the default option (record_mode set to `record-until-full`, enable_sampling and enable_systrace set to `false`) @@ -86,8 +86,8 @@ operation to send the trace data over IPC, and we would like to avoid runtime overhead of tracing. So, to end tracing, we must asynchronously ask all child processes to flush any pending trace data. -Once all child processes have acked to the `stopRecording` request, `callback` -will be called with a file that contains the traced data. +Once all child processes have acknowledged the `stopRecording` request, +`callback` will be called with a file that contains the traced data. Trace data will be written into `resultFilePath` if it is not empty or into a temporary file. The actual file path will be passed to `callback` if it's not @@ -104,7 +104,7 @@ Start monitoring on all processes. Monitoring begins immediately locally and asynchronously on child processes as soon as they receive the `startMonitoring` request. -Once all child processes have acked to the `startMonitoring` request the +Once all child processes have acknowledged the `startMonitoring` request the `callback` will be called. ### `tracing.stopMonitoring(callback)` @@ -113,7 +113,7 @@ Once all child processes have acked to the `startMonitoring` request the Stop monitoring on all processes. -Once all child processes have acked to the `stopMonitoring` request the +Once all child processes have acknowledged the `stopMonitoring` request the `callback` is called. ### `tracing.captureMonitoringSnapshot(resultFilePath, callback)` @@ -123,14 +123,14 @@ Once all child processes have acked to the `stopMonitoring` request the Get the current monitoring traced data. -Child processes typically are caching trace data and only rarely flush and send -trace data back to the main process. That is because it may be an expensive +Child processes are typically caching trace data and only rarely flush and send +trace data back to the main process. This is because it may be an expensive operation to send the trace data over IPC and we would like to avoid unneeded runtime overhead from tracing. So, to end tracing, we must asynchronously ask all child processes to flush any pending trace data. -Once all child processes have acked to the `captureMonitoringSnapshot` request -the `callback` will be called with a file that contains the traced data. +Once all child processes have acknowledged the `captureMonitoringSnapshot` +request the `callback` will be called with a file that contains the traced data. ### `tracing.getTraceBufferUsage(callback)` From 715a88026e70150c19dfcf7ece6e09384f054a6c Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Wed, 26 Aug 2015 16:28:44 -0700 Subject: [PATCH 0969/1293] Small edits --- docs/api/clipboard.md | 4 ++-- docs/api/crash-reporter.md | 5 +++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/api/clipboard.md b/docs/api/clipboard.md index 030c2e476950..7e113990b641 100644 --- a/docs/api/clipboard.md +++ b/docs/api/clipboard.md @@ -1,6 +1,6 @@ # clipboard -The `clipboard` object provides methods to perform copy and paste operations. +The `clipboard` module provides methods to perform copy and paste operations. The following example shows how to write a string to the clipboard: ```javascript @@ -19,7 +19,7 @@ console.log(clipboard.readText('selection')); ## Methods -The `clipboard` object has the following methods: +The `clipboard` module has the following methods: ### `clipboard.readText([type])` diff --git a/docs/api/crash-reporter.md b/docs/api/crash-reporter.md index 71c185d6aa51..7a898718e8ec 100644 --- a/docs/api/crash-reporter.md +++ b/docs/api/crash-reporter.md @@ -21,7 +21,7 @@ The `crash-reporter` module has the following methods: ### `crashReporter.start(options)` -* `options` Object +* `options` Object, properties: * `productName` String, default: Electron. * `companyName` String, default: GitHub, Inc. * `submitUrl` String, default: http://54.249.141.255:1127/post. @@ -50,7 +50,8 @@ sent or the crash reporter has not been started, `null` is returned. ### `crashReporter.getUploadedReports()` -Returns all uploaded crash reports. Each report contains the date and uploaded ID. +Returns all uploaded crash reports. Each report contains the date and uploaded +ID. ## crash-reporter Payload From 586b40710316f9811f63d188bd104e2b394d86f0 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Wed, 26 Aug 2015 16:41:25 -0700 Subject: [PATCH 0970/1293] Small edits and line wrap --- docs/api/dialog.md | 4 ++-- docs/api/file-object.md | 5 +++-- docs/api/frameless-window.md | 22 +++++++++++++++------- 3 files changed, 20 insertions(+), 11 deletions(-) diff --git a/docs/api/dialog.md b/docs/api/dialog.md index c5818aafd4c8..d00540e62df9 100644 --- a/docs/api/dialog.md +++ b/docs/api/dialog.md @@ -7,7 +7,7 @@ native applications. An example of showing a dialog to select multiple files and directories: ```javascript -var win = ...; // window in which to show the dialog +var win = ...; // BrowserWindow in which to show the dialog var dialog = require('dialog'); console.log(dialog.showOpenDialog({ properties: [ 'openFile', 'openDirectory', 'multiSelections' ]})); ``` @@ -55,7 +55,7 @@ The `extensions` array should contain extensions without wildcards or dots (e.g. If a `callback` is passed, the API call will be asynchronous and the result wil be passed via `callback(filenames)` -**Note:** On Windows and Linux, an open dialog can not be both a file selector +**Note:** On Windows and Linux an open dialog can not be both a file selector and a directory selector, so if you set `properties` to `['openFile', 'openDirectory']` on these platforms, a directory selector will be shown. diff --git a/docs/api/file-object.md b/docs/api/file-object.md index c98b8bd19ec6..01d49c39155f 100644 --- a/docs/api/file-object.md +++ b/docs/api/file-object.md @@ -1,8 +1,9 @@ # `File` object -The DOM's File interface provides abstraction around native files, in order to +The DOM's File interface provides abstraction around native files in order to let users work on native files directly with the HTML5 file API. Electron has -added a `path` attribute to the `File` interface which exposes the file's real path on filesystem. +added a `path` attribute to the `File` interface which exposes the file's real +path on filesystem. Example on getting a real path from a dragged-onto-the-app file: diff --git a/docs/api/frameless-window.md b/docs/api/frameless-window.md index e712b6e22314..8d5c578914c7 100644 --- a/docs/api/frameless-window.md +++ b/docs/api/frameless-window.md @@ -1,6 +1,6 @@ # Frameless Window -A frameless window is a window that has no [chrome]()—the parts of the window that display close, open, minify buttons and such. These are options on the [`BrowserWindow`](browser-window.md) class. +A frameless window is a window that has no [chrome](https://developer.mozilla.org/en-US/docs/Glossary/Chrome), the parts of the window, like toolbars, that are not a part of the webp page. These are options on the [`BrowserWindow`](browser-window.md) class. ## Create a frameless window @@ -30,11 +30,15 @@ var win = new BrowserWindow({ transparent: true, frame: false }); * Transparent windows are not resizable. Setting `resizable` to `true` may make a transparent window stop working on some platforms. * The `blur` filter only applies to the web page, so there is no way to apply - blur effect to the content below the window (i.e. other applications open on the user's system). -* On Windows operation shystems, transparent windows will not work when DWM is disabled. + blur effect to the content below the window (i.e. other applications open on + the user's system). +* On Windows operation shystems, transparent windows will not work when DWM is + disabled. * On Linux users have to put `--enable-transparent-visuals --disable-gpu` in - the command line to disable GPU and allow ARGB to make transparent window, this is caused by an upstream bug that [alpha channel doesn't work on some NVidia - drivers](https://code.google.com/p/chromium/issues/detail?id=369209) on Linux. + the command line to disable GPU and allow ARGB to make transparent window, + this is caused by an upstream bug that [alpha channel doesn't work on some + NVidia drivers](https://code.google.com/p/chromium/issues/detail?id=369209) on + Linux. * On Mac the native window shadow will not be shown on a transparent window. ## Draggable region @@ -63,11 +67,15 @@ button { } ``` -If you're setting just a custom titlebar as draggable, you also need to make all buttons in titlebar non-draggable. +If you're setting just a custom titlebar as draggable, you also need to make all +buttons in titlebar non-draggable. ## Text selection -In a frameless window the dragging behaviour may conflict with selecting text. For example, when you drag the titlebar you may accidentally select the text on the titlebar. To prevent this, you need to disable text selection within a draggable area like this: +In a frameless window the dragging behaviour may conflict with selecting text. +For example, when you drag the titlebar you may accidentally select the text on +the titlebar. To prevent this, you need to disable text selection within a +draggable area like this: ```css .titlebar { From ed8f143427bcf35842d56b5b804ffc4d61a824be Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Thu, 27 Aug 2015 09:06:12 +0900 Subject: [PATCH 0971/1293] Fix IMPORTANT Typos and update as upstream --- .../ko/development/build-instructions-windows.md | 2 +- docs-translations/ko/tutorial/quick-start.md | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs-translations/ko/development/build-instructions-windows.md b/docs-translations/ko/development/build-instructions-windows.md index eb1283e7c4bc..06c2349b3d9b 100644 --- a/docs-translations/ko/development/build-instructions-windows.md +++ b/docs-translations/ko/development/build-instructions-windows.md @@ -46,7 +46,7 @@ python script\build.py python script\build.py -c D ``` -빌드가 모두 끝나면 `out/D` 디렉터리에서 `atom.exe` 실행 파일을 찾을 수 있습니다. +빌드가 모두 끝나면 `out/D` (디버그 타겟) 또는 `out/R` (릴리즈 타겟) 디렉터리에서 `electron.exe` 실행 파일을 찾을 수 있습니다. ## 64비트 빌드 diff --git a/docs-translations/ko/tutorial/quick-start.md b/docs-translations/ko/tutorial/quick-start.md index 7564f1c8c4c9..963ebca4dacd 100644 --- a/docs-translations/ko/tutorial/quick-start.md +++ b/docs-translations/ko/tutorial/quick-start.md @@ -59,7 +59,9 @@ your-app/ } ``` -`main.js`에서 창을 만들거나 시스템 이벤트를 처리할 수 있습니다. 대표적인 예제로 다음과 같이 작성할 수 있습니다: +__알림__: 만약 `main` 필드가 `package.json`에 설정되어 있지 않으면 Electron은 자동으로 같은 디렉터리의 `index.js`를 로드합니다. + +반드시 `main.js`에서 창을 만들고 시스템 이밴트를 처리해야합니다. 대표적인 예제로 다음과 같이 작성할 수 있습니다: ```javascript var app = require('app'); // 어플리케이션 기반을 조작 하는 모듈. From ade5b142f83763125f7b3f364a6a2d00f11067de Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Thu, 27 Aug 2015 09:19:24 +0900 Subject: [PATCH 0972/1293] Update as upstream --- docs-translations/ko/api/auto-updater.md | 24 +++++--- docs-translations/ko/styleguide.md | 78 ++++++++++++++++++++++++ 2 files changed, 94 insertions(+), 8 deletions(-) create mode 100644 docs-translations/ko/styleguide.md diff --git a/docs-translations/ko/api/auto-updater.md b/docs-translations/ko/api/auto-updater.md index dd9adf86709a..369f58297be4 100644 --- a/docs-translations/ko/api/auto-updater.md +++ b/docs-translations/ko/api/auto-updater.md @@ -1,4 +1,4 @@ -# auto-updater +# autoUpdater **이 모듈은 현재 OS X에서만 사용할 수 있습니다.** @@ -76,26 +76,30 @@ Squirrel은 "url"로 `Accept: application/zip` 헤더와 함께 업데이트 zip `pub_date`은 ISO 8601 표준에 따라 포맷된 날짜입니다. -## Event: error +## Events + +`autoUpdater` 객체는 다음과 같은 이벤트를 발생시킵니다: + +### Event: 'error' * `event` Event * `message` String 업데이트시 에러가 나면 발생하는 이벤트입니다. -## Event: checking-for-update +### Event: 'checking-for-update' 업데이트를 확인하기 시작할 때 발생하는 이벤트입니다. -## Event: update-available +### Event: 'update-available' 사용 가능한 업데이트가 있을 때 발생하는 이벤트입니다. 이벤트는 자동으로 다운로드 됩니다. -## Event: update-not-available +### Event: 'update-not-available' 사용 가능한 업데이트가 없을 때 발생하는 이벤트입니다. -## Event: update-downloaded +### Event: 'update-downloaded' * `event` Event * `releaseNotes` String @@ -106,12 +110,16 @@ Squirrel은 "url"로 `Accept: application/zip` 헤더와 함께 업데이트 zip 업데이트의 다운로드가 완료되었을 때 발생하는 이벤트입니다. `quitAndUpdate()`를 호출하면 어플리케이션을 종료하고 업데이트를 설치합니다. -## autoUpdater.setFeedUrl(url) +## Methods + +`autoUpdater` 객체에서 사용할 수 있는 메서드입니다: + +### `autoUpdater.setFeedUrl(url)` * `url` String `url`을 설정하고 자동 업데이터를 초기화합니다. `url`은 한번 설정되면 변경할 수 없습니다. -## autoUpdater.checkForUpdates() +### `autoUpdater.checkForUpdates()` 서버에 새로운 업데이트가 있는지 요청을 보내 확인합니다. API를 사용하기 전에 `setFeedUrl`를 호출해야 합니다. diff --git a/docs-translations/ko/styleguide.md b/docs-translations/ko/styleguide.md new file mode 100644 index 000000000000..065d37f5cd17 --- /dev/null +++ b/docs-translations/ko/styleguide.md @@ -0,0 +1,78 @@ +# Electron Documentation Styleguide + +Find the appropriate section for your task: [reading Electron documentation](#) +or [writing Electron documentation](#). + +## Writing Electron Documentation + +These are the ways that we construct the Electron documentation. + +- Maximum one `h1` title per page. +- Use `bash` instead of `cmd` in code blocks (because of syntax highlighter). +- Doc `h1` titles should match object name (i.e. `browser-window` + `BrowserWindow`). + - Hyphen separated filenames, however, are fine. +- No headers following headers, add at least a one-sentence description. +- Methods headers are wrapped in `code` ticks. +- Event headers are wrapped in single 'quotation' marks. +- No nesting lists more than 2 levels (unfortunately because of markdown + renderer). +- Add section titles: Events, Class Methods and Instance Methods. +- Use 'will' over 'would' when describing outcomes. +- Events and methods are `h3` headers. +- Optional arguments written as `function (required[, optional])`. +- Optional arguments are denoted when called out in list. +- Line length is 80-column wrapped. +- Platform specific methods are noted in italics following method header. + - ```### `method(foo, bar)` _OS X_``` + +## Reading Electron Documentation + +Here are some tips for understanding Electron documentation syntax. + +### Methods + +An example of [method](https://developer.mozilla.org/en-US/docs/Glossary/Method) +documentation: + +--- + +`methodName(required[, optional]))` + +* `require` String, **required** +* `optional` Integer + +--- + +The method name is followed by the arguments it takes. Optional arguments are +notated by brackets surrounding the optional argument as well as the comma +required if this optional argument follows another argument. + +Below the method is more detailed information on each of the arguments. The type +of argument is notated by either the common types: [`String`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), [`Number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number), [`Object`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object), [`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array) +or a custom type like Electron's [`webContent`](api/web-content.md). + +### Events + +An example of [event](https://developer.mozilla.org/en-US/docs/Web/API/Event) +documentation: + +--- + +Event: 'wake-up' + +Returns: + +* `time` String + +--- + +The event is a string that is used after a `.on` listener method. If it returns +a value it and its type is noted below. If you were to listen and respond to +this event it might look something like this: + +```javascript +Alarm.on('wake-up', function(time) { + console.log(time) +}) +``` \ No newline at end of file From f96c76584f21626a2eb054ef844444f16e744590 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Wed, 26 Aug 2015 17:27:17 -0700 Subject: [PATCH 0973/1293] First run at ipc-m-p edits --- docs/api/ipc-main-process.md | 52 ++++++++++++++++++++++++++---------- 1 file changed, 38 insertions(+), 14 deletions(-) diff --git a/docs/api/ipc-main-process.md b/docs/api/ipc-main-process.md index d558f7fb24d6..b29d56f6ba37 100644 --- a/docs/api/ipc-main-process.md +++ b/docs/api/ipc-main-process.md @@ -1,17 +1,19 @@ # ipc (main process) -Handles asynchronous and synchronous message sent from a renderer process (web -page). +The `ipc` module, when used in the main process, handles asynchronous and synchronous messages sent from a renderer process (web page). Messages sent from a renderer will be emitted to this module. -The messages sent from a renderer would be emitted to this module, the event name -is the `channel` when sending message. To reply a synchronous message, you need -to set `event.returnValue`, to send an asynchronous back to the sender, you can -use `event.sender.send(...)`. +## Sending Messages -It's also possible to send messages from main process to the renderer process, -see [WebContents.send](browser-window.md#webcontentssendchannel-args) for more. +It is also possible to send messages from the main process to the renderer +process, see [WebContents.send](browser-window.md#webcontentssendchannel-args) +for more information. -An example of sending and handling messages: +- When sending a message, the event name is the `channel`. +- To reply a synchronous message, you need to set `event.returnValue`. +- To send an asynchronous back to the sender, you can use `event.sender.send(...)`. + +An example of sending and handling messages between the render and main +processes: ```javascript // In main process. @@ -38,12 +40,34 @@ ipc.on('asynchronous-reply', function(arg) { ipc.send('asynchronous-message', 'ping'); ``` -## Class: Event +## Methods -### Event.returnValue +The `ipc` module has the following method: -Assign to this to return an value to synchronous messages. +### `ipc.on(channel, callback)` -### Event.sender +* `channel` String - The event name. +* `callback` Function -The `WebContents` that sent the message. +When the event occurs the `callback` is called with an `event` object and a +message, `arg`. + +## IPC Events + +The `event` object passed to the `callback` has the following methods: + +### `Event.returnValue` + +Set this to the value to be returned in a synchronous message. + +### `Event.sender` + +Returns the `WebContents` that sent the message. + +### `Event.sender.send(channel, arg)` + +* `channel` String - The event name. +* `arg` + +This sends an asynchronous message back to the render process. The message, +`arg`, can be any value. From a34a16653eb50529c42d92933ba94cca0b3b6e0f Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Wed, 26 Aug 2015 17:32:47 -0700 Subject: [PATCH 0974/1293] Standardize global-shortcut --- docs/api/global-shortcut.md | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/docs/api/global-shortcut.md b/docs/api/global-shortcut.md index 54da5638d194..52ec17326c63 100644 --- a/docs/api/global-shortcut.md +++ b/docs/api/global-shortcut.md @@ -1,9 +1,12 @@ # global-shortcut The `global-shortcut` module can register/unregister a global keyboard shortcut -with the operating system, so that you can customize the operations for various shortcuts. -Note that the shortcut is global; it will work even if the app does not have the keyboard focus. -You should not use this module until the `ready` event of the app module is emitted. +with the operating system so that you can customize the operations for various +shortcuts. + +Note that the shortcut is global; it will work even if the app does +not have the keyboard focus. You should not use this module until the `ready` +event of the app module is emitted. ```javascript var app = require('app'); @@ -32,7 +35,11 @@ app.on('will-quit', function() { }); ``` -## globalShortcut.register(accelerator, callback) +## Methods + +The `global-shortcut` module has the following methods: + +### `globalShortcut.register(accelerator, callback)` * `accelerator` [Accelerator](accelerator.md) * `callback` Function @@ -40,18 +47,18 @@ app.on('will-quit', function() { Registers a global shortcut of `accelerator`. The `callback` is called when the registered shortcut is pressed by the user. -## globalShortcut.isRegistered(accelerator) +### `globalShortcut.isRegistered(accelerator)` * `accelerator` [Accelerator](accelerator.md) Returns `true` or `false` depending on whether the shortcut `accelerator` is registered. -## globalShortcut.unregister(accelerator) +### `globalShortcut.unregister(accelerator)` * `accelerator` [Accelerator](accelerator.md) -Unregisters the global shortcut of `keycode`. +Unregisters the global shortcut of `accelerator`. -## globalShortcut.unregisterAll() +### `globalShortcut.unregisterAll()` Unregisters all the global shortcuts. From 71f46c02877fd1d42b5e6de195572ab2727d2503 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Wed, 26 Aug 2015 17:52:45 -0700 Subject: [PATCH 0975/1293] =?UTF-8?q?arg=20=E2=86=92=20message?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/api/ipc-main-process.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/api/ipc-main-process.md b/docs/api/ipc-main-process.md index b29d56f6ba37..197b98e418be 100644 --- a/docs/api/ipc-main-process.md +++ b/docs/api/ipc-main-process.md @@ -64,10 +64,9 @@ Set this to the value to be returned in a synchronous message. Returns the `WebContents` that sent the message. -### `Event.sender.send(channel, arg)` +### `Event.sender.send(channel[, message])` * `channel` String - The event name. -* `arg` +* `message` (optional) -This sends an asynchronous message back to the render process. The message, -`arg`, can be any value. +This sends an asynchronous message back to the render process. The `message` can be any value. From a1f17069ec3a742bc83697c4bbf4c73a1a669834 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Wed, 26 Aug 2015 17:56:10 -0700 Subject: [PATCH 0976/1293] First run t ipc-r --- docs/api/ipc-renderer.md | 44 +++++++++++++++++++++++++--------------- 1 file changed, 28 insertions(+), 16 deletions(-) diff --git a/docs/api/ipc-renderer.md b/docs/api/ipc-renderer.md index 3aee11d781c9..0d7b49aba701 100644 --- a/docs/api/ipc-renderer.md +++ b/docs/api/ipc-renderer.md @@ -1,29 +1,41 @@ # ipc (renderer) The `ipc` module provides a few methods so you can send synchronous and -asynchronous messages to the main process, and also receive messages sent from -main process. If you want to make use of modules of main process from renderer +asynchronous messages from the render process (web page) to the main process. You can also receive messages returned from the main process. + +**Note**: If you want to make use of modules in the main process from the renderer process, you might consider using the [remote](remote.md) module. -See [ipc (main process)](ipc-main-process.md) for examples. +See [ipc (main process)](ipc-main-process.md) for code examples. -## ipc.send(channel[, args...]) +## Methods -Send `args..` to the renderer via `channel` in asynchronous message, the main -process can handle it by listening to the `channel` event of `ipc` module. +The `ipc` module has the following methods for sending messages: -## ipc.sendSync(channel[, args...]) +**Note**: When using these methods to send a `message` you must also listen for it in the main process with [`ipc (main process)`](ipc-main-process.md). -Send `args..` to the renderer via `channel` in synchronous message, and returns -the result sent from main process. The main process can handle it by listening to -the `channel` event of `ipc` module, and returns by setting `event.returnValue`. +### `ipc.send(channel[, message])` -**Note:** Usually developers should never use this API, since sending -synchronous message would block the whole renderer process. +* `channel` String - The event name. +* `message` (optional) -## ipc.sendToHost(channel[, args...]) +Send a `message` (any type) to the main process asynchronously via a `channel`. The main process handles it by listening for the `channel` event with `ipc`. -Like `ipc.send` but the message will be sent to the host page instead of the -main process. +### `ipc.sendSync(channel[, message])` -This is mainly used by the page in `` to communicate with host page. +* `channel` String - The event name. +* `message` (optional) + +Send a `message` (any type) to the main process synchronously via a `channel`. A result is returned from the main process. + +The main process handles it by listening for the `channel` event with `ipc` and replies by setting the `event.returnValue`. + +**Note:** Sending a synchronous message will block the whole renderer process so +using this method is not recommended. + +### `ipc.sendToHost(channel[, message])` + +* `channel` String - The event name. +* `message` (optional) + +Like `ipc.send` but the message will be sent to the host page in a `` instead of the main process. From a6c21666f443c68760e8ad410d3ab6627ba9b615 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 27 Aug 2015 10:45:39 +0800 Subject: [PATCH 0977/1293] win: Add compatibility information in manifest --- atom/browser/resources/win/atom.manifest | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/atom/browser/resources/win/atom.manifest b/atom/browser/resources/win/atom.manifest index 324364f81232..84970c717288 100644 --- a/atom/browser/resources/win/atom.manifest +++ b/atom/browser/resources/win/atom.manifest @@ -1,6 +1,21 @@ + + + + + + + + + + + + + + + From ab859067aaa4d275c252f8bc3c913ba3463f6003 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 27 Aug 2015 11:42:06 +0800 Subject: [PATCH 0978/1293] win: Delay quitting until next tick of message loop This fixes app.quit() not working when it is called before the message loop starts to run. --- atom/browser/browser.cc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/atom/browser/browser.cc b/atom/browser/browser.cc index 1ca682de15bb..3419ecbe330d 100644 --- a/atom/browser/browser.cc +++ b/atom/browser/browser.cc @@ -45,7 +45,8 @@ void Browser::Shutdown() { FOR_EACH_OBSERVER(BrowserObserver, observers_, OnQuit()); is_quiting_ = true; - base::MessageLoop::current()->Quit(); + base::MessageLoop::current()->PostTask( + FROM_HERE, base::MessageLoop::QuitWhenIdleClosure()); } std::string Browser::GetVersion() const { From a1a6ea6fe12a4c56ec93b92d3d1288d6d505a8c5 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 27 Aug 2015 12:25:28 +0800 Subject: [PATCH 0979/1293] Revert "Remove our own debugger implementation" This reverts commit 1d148fe2fb0d7013d7d6633539de952e71d756f1. --- atom/browser/atom_browser_main_parts.cc | 8 + atom/browser/atom_browser_main_parts.h | 2 + atom/browser/node_debugger.cc | 202 ++++++++++++++++++++++++ atom/browser/node_debugger.h | 59 +++++++ atom/common/node_bindings.cc | 5 - filenames.gypi | 2 + 6 files changed, 273 insertions(+), 5 deletions(-) create mode 100644 atom/browser/node_debugger.cc create mode 100644 atom/browser/node_debugger.h diff --git a/atom/browser/atom_browser_main_parts.cc b/atom/browser/atom_browser_main_parts.cc index 15ffd05b39f0..c472b8742f06 100644 --- a/atom/browser/atom_browser_main_parts.cc +++ b/atom/browser/atom_browser_main_parts.cc @@ -9,6 +9,7 @@ #include "atom/browser/atom_browser_context.h" #include "atom/browser/browser.h" #include "atom/browser/javascript_environment.h" +#include "atom/browser/node_debugger.h" #include "atom/common/api/atom_bindings.h" #include "atom/common/node_bindings.h" #include "base/command_line.h" @@ -69,9 +70,16 @@ void AtomBrowserMainParts::PostEarlyInitialization() { node_bindings_->Initialize(); + // Support the "--debug" switch. + node_debugger_.reset(new NodeDebugger(js_env_->isolate())); + // Create the global environment. global_env = node_bindings_->CreateEnvironment(js_env_->context()); + // Make sure node can get correct environment when debugging. + if (node_debugger_->IsRunning()) + global_env->AssignToContext(v8::Debug::GetDebugContext()); + // Add atom-shell extended APIs. atom_bindings_->BindTo(js_env_->isolate(), global_env->process_object()); diff --git a/atom/browser/atom_browser_main_parts.h b/atom/browser/atom_browser_main_parts.h index 2b308e8c9aff..97663a72404e 100644 --- a/atom/browser/atom_browser_main_parts.h +++ b/atom/browser/atom_browser_main_parts.h @@ -19,6 +19,7 @@ class AtomBindings; class Browser; class JavascriptEnvironment; class NodeBindings; +class NodeDebugger; class AtomBrowserMainParts : public brightray::BrowserMainParts { public: @@ -57,6 +58,7 @@ class AtomBrowserMainParts : public brightray::BrowserMainParts { scoped_ptr js_env_; scoped_ptr node_bindings_; scoped_ptr atom_bindings_; + scoped_ptr node_debugger_; base::Timer gc_timer_; diff --git a/atom/browser/node_debugger.cc b/atom/browser/node_debugger.cc new file mode 100644 index 000000000000..4e2302763c7e --- /dev/null +++ b/atom/browser/node_debugger.cc @@ -0,0 +1,202 @@ +// Copyright (c) 2014 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#include "atom/browser/node_debugger.h" + +#include + +#include "base/bind.h" +#include "base/command_line.h" +#include "base/strings/string_number_conversions.h" +#include "base/strings/stringprintf.h" +#include "base/strings/utf_string_conversions.h" +#include "content/public/browser/browser_thread.h" +#include "net/socket/tcp_listen_socket.h" + +#include "atom/common/node_includes.h" + +namespace atom { + +namespace { + +// NodeDebugger is stored in Isolate's data, slots 0, 1, 3 have already been +// taken by gin, blink and node, using 2 is a safe option for now. +const int kIsolateSlot = 2; + +const char* kContentLength = "Content-Length"; + +} // namespace + +NodeDebugger::NodeDebugger(v8::Isolate* isolate) + : isolate_(isolate), + thread_("NodeDebugger"), + content_length_(-1), + weak_factory_(this) { + bool use_debug_agent = false; + int port = 5858; + bool wait_for_connection = false; + + std::string port_str; + base::CommandLine* cmd = base::CommandLine::ForCurrentProcess(); + if (cmd->HasSwitch("debug")) { + use_debug_agent = true; + port_str = cmd->GetSwitchValueASCII("debug"); + } + if (cmd->HasSwitch("debug-brk")) { + use_debug_agent = true; + wait_for_connection = true; + port_str = cmd->GetSwitchValueASCII("debug-brk"); + } + + if (use_debug_agent) { + if (!port_str.empty()) + base::StringToInt(port_str, &port); + + isolate_->SetData(kIsolateSlot, this); + v8::Debug::SetMessageHandler(DebugMessageHandler); + + if (wait_for_connection) + v8::Debug::DebugBreak(isolate_); + + // Start a new IO thread. + base::Thread::Options options; + options.message_loop_type = base::MessageLoop::TYPE_IO; + if (!thread_.StartWithOptions(options)) { + LOG(ERROR) << "Unable to start debugger thread"; + return; + } + + // Start the server in new IO thread. + thread_.message_loop()->PostTask( + FROM_HERE, + base::Bind(&NodeDebugger::StartServer, weak_factory_.GetWeakPtr(), + port)); + } +} + +NodeDebugger::~NodeDebugger() { + thread_.Stop(); +} + +bool NodeDebugger::IsRunning() const { + return thread_.IsRunning(); +} + +void NodeDebugger::StartServer(int port) { + server_ = net::TCPListenSocket::CreateAndListen("127.0.0.1", port, this); + if (!server_) { + LOG(ERROR) << "Cannot start debugger server"; + return; + } +} + +void NodeDebugger::CloseSession() { + accepted_socket_.reset(); +} + +void NodeDebugger::OnMessage(const std::string& message) { + if (message.find("\"type\":\"request\",\"command\":\"disconnect\"}") != + std::string::npos) + CloseSession(); + + base::string16 message16 = base::UTF8ToUTF16(message); + v8::Debug::SendCommand( + isolate_, + reinterpret_cast(message16.data()), message16.size()); + + content::BrowserThread::PostTask( + content::BrowserThread::UI, FROM_HERE, + base::Bind(&v8::Debug::ProcessDebugMessages)); +} + +void NodeDebugger::SendMessage(const std::string& message) { + if (accepted_socket_) { + std::string header = base::StringPrintf( + "%s: %d\r\n\r\n", kContentLength, static_cast(message.size())); + accepted_socket_->Send(header); + accepted_socket_->Send(message); + } +} + +void NodeDebugger::SendConnectMessage() { + accepted_socket_->Send(base::StringPrintf( + "Type: connect\r\n" + "V8-Version: %s\r\n" + "Protocol-Version: 1\r\n" + "Embedding-Host: %s\r\n" + "%s: 0\r\n", + v8::V8::GetVersion(), ATOM_PRODUCT_NAME, kContentLength), true); +} + +// static +void NodeDebugger::DebugMessageHandler(const v8::Debug::Message& message) { + NodeDebugger* self = static_cast( + message.GetIsolate()->GetData(kIsolateSlot)); + + if (self) { + std::string message8(*v8::String::Utf8Value(message.GetJSON())); + self->thread_.message_loop()->PostTask( + FROM_HERE, + base::Bind(&NodeDebugger::SendMessage, self->weak_factory_.GetWeakPtr(), + message8)); + } +} + +void NodeDebugger::DidAccept(net::StreamListenSocket* server, + scoped_ptr socket) { + // Only accept one session. + if (accepted_socket_) { + socket->Send(std::string("Remote debugging session already active"), true); + return; + } + + accepted_socket_ = socket.Pass(); + SendConnectMessage(); +} + +void NodeDebugger::DidRead(net::StreamListenSocket* socket, + const char* data, + int len) { + buffer_.append(data, len); + + do { + if (buffer_.size() == 0) + return; + + // Read the "Content-Length" header. + if (content_length_ < 0) { + size_t pos = buffer_.find("\r\n\r\n"); + if (pos == std::string::npos) + return; + + // We can be sure that the header is "Content-Length: xxx\r\n". + std::string content_length = buffer_.substr(16, pos - 16); + if (!base::StringToInt(content_length, &content_length_)) { + DidClose(accepted_socket_.get()); + return; + } + + // Strip header from buffer. + buffer_ = buffer_.substr(pos + 4); + } + + // Read the message. + if (buffer_.size() >= static_cast(content_length_)) { + std::string message = buffer_.substr(0, content_length_); + buffer_ = buffer_.substr(content_length_); + + OnMessage(message); + + // Get ready for next message. + content_length_ = -1; + } + } while (true); +} + +void NodeDebugger::DidClose(net::StreamListenSocket* socket) { + // If we lost the connection, then simulate a disconnect msg: + OnMessage("{\"seq\":1,\"type\":\"request\",\"command\":\"disconnect\"}"); +} + +} // namespace atom diff --git a/atom/browser/node_debugger.h b/atom/browser/node_debugger.h new file mode 100644 index 000000000000..6ee5b1e20688 --- /dev/null +++ b/atom/browser/node_debugger.h @@ -0,0 +1,59 @@ +// Copyright (c) 2014 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#ifndef ATOM_BROWSER_NODE_DEBUGGER_H_ +#define ATOM_BROWSER_NODE_DEBUGGER_H_ + +#include + +#include "base/memory/scoped_ptr.h" +#include "base/memory/weak_ptr.h" +#include "base/threading/thread.h" +#include "net/socket/stream_listen_socket.h" +#include "v8/include/v8-debug.h" + +namespace atom { + +// Add support for node's "--debug" switch. +class NodeDebugger : public net::StreamListenSocket::Delegate { + public: + explicit NodeDebugger(v8::Isolate* isolate); + virtual ~NodeDebugger(); + + bool IsRunning() const; + + private: + void StartServer(int port); + void CloseSession(); + void OnMessage(const std::string& message); + void SendMessage(const std::string& message); + void SendConnectMessage(); + + static void DebugMessageHandler(const v8::Debug::Message& message); + + // net::StreamListenSocket::Delegate: + void DidAccept(net::StreamListenSocket* server, + scoped_ptr socket) override; + void DidRead(net::StreamListenSocket* socket, + const char* data, + int len) override; + void DidClose(net::StreamListenSocket* socket) override; + + v8::Isolate* isolate_; + + base::Thread thread_; + scoped_ptr server_; + scoped_ptr accepted_socket_; + + std::string buffer_; + int content_length_; + + base::WeakPtrFactory weak_factory_; + + DISALLOW_COPY_AND_ASSIGN(NodeDebugger); +}; + +} // namespace atom + +#endif // ATOM_BROWSER_NODE_DEBUGGER_H_ diff --git a/atom/common/node_bindings.cc b/atom/common/node_bindings.cc index 304b6a711a5c..827033bbccbc 100644 --- a/atom/common/node_bindings.cc +++ b/atom/common/node_bindings.cc @@ -180,14 +180,9 @@ node::Environment* NodeBindings::CreateEnvironment( void NodeBindings::LoadEnvironment(node::Environment* env) { node::node_isolate = env->isolate(); - if (node::use_debug_agent) - node::StartDebug(env, node::debug_wait_connect); node::LoadEnvironment(env); - if (node::use_debug_agent) - node::EnableDebug(env); - mate::EmitEvent(env->isolate(), env->process_object(), "loaded"); } diff --git a/filenames.gypi b/filenames.gypi index 260c9a4c8a17..b4015921e809 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -164,6 +164,8 @@ 'atom/browser/net/url_request_buffer_job.h', 'atom/browser/net/url_request_fetch_job.cc', 'atom/browser/net/url_request_fetch_job.h', + 'atom/browser/node_debugger.cc', + 'atom/browser/node_debugger.h', 'atom/browser/ui/accelerator_util.cc', 'atom/browser/ui/accelerator_util.h', 'atom/browser/ui/accelerator_util_mac.mm', From e7791a5486f7f6f44e27995102d345665b5e9596 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 27 Aug 2015 12:59:54 +0800 Subject: [PATCH 0980/1293] Import the TCPListenSocket removed by Chromium --- atom/browser/node_debugger.cc | 14 +- atom/browser/node_debugger.h | 19 +- .../stream_listen_socket.cc | 330 ++++++++++++++++++ .../stream_listen_socket.h | 151 ++++++++ .../embedded_test_server/tcp_listen_socket.cc | 118 +++++++ .../embedded_test_server/tcp_listen_socket.h | 55 +++ filenames.gypi | 4 + 7 files changed, 676 insertions(+), 15 deletions(-) create mode 100644 chromium_src/net/test/embedded_test_server/stream_listen_socket.cc create mode 100644 chromium_src/net/test/embedded_test_server/stream_listen_socket.h create mode 100644 chromium_src/net/test/embedded_test_server/tcp_listen_socket.cc create mode 100644 chromium_src/net/test/embedded_test_server/tcp_listen_socket.h diff --git a/atom/browser/node_debugger.cc b/atom/browser/node_debugger.cc index 4e2302763c7e..beaf682a8d4b 100644 --- a/atom/browser/node_debugger.cc +++ b/atom/browser/node_debugger.cc @@ -12,7 +12,7 @@ #include "base/strings/stringprintf.h" #include "base/strings/utf_string_conversions.h" #include "content/public/browser/browser_thread.h" -#include "net/socket/tcp_listen_socket.h" +#include "net/test/embedded_test_server/tcp_listen_socket.h" #include "atom/common/node_includes.h" @@ -84,7 +84,8 @@ bool NodeDebugger::IsRunning() const { } void NodeDebugger::StartServer(int port) { - server_ = net::TCPListenSocket::CreateAndListen("127.0.0.1", port, this); + server_ = net::test_server::TCPListenSocket::CreateAndListen( + "127.0.0.1", port, this); if (!server_) { LOG(ERROR) << "Cannot start debugger server"; return; @@ -143,8 +144,9 @@ void NodeDebugger::DebugMessageHandler(const v8::Debug::Message& message) { } } -void NodeDebugger::DidAccept(net::StreamListenSocket* server, - scoped_ptr socket) { +void NodeDebugger::DidAccept( + net::test_server::StreamListenSocket* server, + scoped_ptr socket) { // Only accept one session. if (accepted_socket_) { socket->Send(std::string("Remote debugging session already active"), true); @@ -155,7 +157,7 @@ void NodeDebugger::DidAccept(net::StreamListenSocket* server, SendConnectMessage(); } -void NodeDebugger::DidRead(net::StreamListenSocket* socket, +void NodeDebugger::DidRead(net::test_server::StreamListenSocket* socket, const char* data, int len) { buffer_.append(data, len); @@ -194,7 +196,7 @@ void NodeDebugger::DidRead(net::StreamListenSocket* socket, } while (true); } -void NodeDebugger::DidClose(net::StreamListenSocket* socket) { +void NodeDebugger::DidClose(net::test_server::StreamListenSocket* socket) { // If we lost the connection, then simulate a disconnect msg: OnMessage("{\"seq\":1,\"type\":\"request\",\"command\":\"disconnect\"}"); } diff --git a/atom/browser/node_debugger.h b/atom/browser/node_debugger.h index 6ee5b1e20688..bf77cb72da64 100644 --- a/atom/browser/node_debugger.h +++ b/atom/browser/node_debugger.h @@ -10,13 +10,13 @@ #include "base/memory/scoped_ptr.h" #include "base/memory/weak_ptr.h" #include "base/threading/thread.h" -#include "net/socket/stream_listen_socket.h" +#include "net/test/embedded_test_server/stream_listen_socket.h" #include "v8/include/v8-debug.h" namespace atom { // Add support for node's "--debug" switch. -class NodeDebugger : public net::StreamListenSocket::Delegate { +class NodeDebugger : public net::test_server::StreamListenSocket::Delegate { public: explicit NodeDebugger(v8::Isolate* isolate); virtual ~NodeDebugger(); @@ -32,19 +32,20 @@ class NodeDebugger : public net::StreamListenSocket::Delegate { static void DebugMessageHandler(const v8::Debug::Message& message); - // net::StreamListenSocket::Delegate: - void DidAccept(net::StreamListenSocket* server, - scoped_ptr socket) override; - void DidRead(net::StreamListenSocket* socket, + // net::test_server::StreamListenSocket::Delegate: + void DidAccept( + net::test_server::StreamListenSocket* server, + scoped_ptr socket) override; + void DidRead(net::test_server::StreamListenSocket* socket, const char* data, int len) override; - void DidClose(net::StreamListenSocket* socket) override; + void DidClose(net::test_server::StreamListenSocket* socket) override; v8::Isolate* isolate_; base::Thread thread_; - scoped_ptr server_; - scoped_ptr accepted_socket_; + scoped_ptr server_; + scoped_ptr accepted_socket_; std::string buffer_; int content_length_; diff --git a/chromium_src/net/test/embedded_test_server/stream_listen_socket.cc b/chromium_src/net/test/embedded_test_server/stream_listen_socket.cc new file mode 100644 index 000000000000..1056983a8e2f --- /dev/null +++ b/chromium_src/net/test/embedded_test_server/stream_listen_socket.cc @@ -0,0 +1,330 @@ +// Copyright (c) 2012 The Chromium Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. + +#include "net/test/embedded_test_server/stream_listen_socket.h" + +#if defined(OS_WIN) +// winsock2.h must be included first in order to ensure it is included before +// windows.h. +#include +#elif defined(OS_POSIX) +#include +#include +#include +#include +#include +#include "net/base/net_errors.h" +#endif + +#include "base/logging.h" +#include "base/memory/ref_counted.h" +#include "base/memory/scoped_ptr.h" +#include "base/posix/eintr_wrapper.h" +#include "base/sys_byteorder.h" +#include "base/threading/platform_thread.h" +#include "build/build_config.h" +#include "net/base/ip_endpoint.h" +#include "net/base/net_errors.h" +#include "net/base/net_util.h" +#include "net/socket/socket_descriptor.h" + +using std::string; + +#if defined(OS_WIN) +typedef int socklen_t; +#endif // defined(OS_WIN) + +namespace net { + +namespace test_server { + +namespace { + +const int kReadBufSize = 4096; + +} // namespace + +#if defined(OS_WIN) +const int StreamListenSocket::kSocketError = SOCKET_ERROR; +#elif defined(OS_POSIX) +const int StreamListenSocket::kSocketError = -1; +#endif + +StreamListenSocket::StreamListenSocket(SocketDescriptor s, + StreamListenSocket::Delegate* del) + : socket_delegate_(del), + socket_(s), + reads_paused_(false), + has_pending_reads_(false) { +#if defined(OS_WIN) + socket_event_ = WSACreateEvent(); + // TODO(ibrar): error handling in case of socket_event_ == WSA_INVALID_EVENT. + WatchSocket(NOT_WAITING); +#elif defined(OS_POSIX) + wait_state_ = NOT_WAITING; +#endif +} + +StreamListenSocket::~StreamListenSocket() { + CloseSocket(); +#if defined(OS_WIN) + if (socket_event_) { + WSACloseEvent(socket_event_); + socket_event_ = WSA_INVALID_EVENT; + } +#endif +} + +void StreamListenSocket::Send(const char* bytes, + int len, + bool append_linefeed) { + SendInternal(bytes, len); + if (append_linefeed) + SendInternal("\r\n", 2); +} + +void StreamListenSocket::Send(const string& str, bool append_linefeed) { + Send(str.data(), static_cast(str.length()), append_linefeed); +} + +int StreamListenSocket::GetLocalAddress(IPEndPoint* address) const { + SockaddrStorage storage; + if (getsockname(socket_, storage.addr, &storage.addr_len)) { +#if defined(OS_WIN) + int err = WSAGetLastError(); +#else + int err = errno; +#endif + return MapSystemError(err); + } + if (!address->FromSockAddr(storage.addr, storage.addr_len)) + return ERR_ADDRESS_INVALID; + return OK; +} + +int StreamListenSocket::GetPeerAddress(IPEndPoint* address) const { + SockaddrStorage storage; + if (getpeername(socket_, storage.addr, &storage.addr_len)) { +#if defined(OS_WIN) + int err = WSAGetLastError(); +#else + int err = errno; +#endif + return MapSystemError(err); + } + + if (!address->FromSockAddr(storage.addr, storage.addr_len)) + return ERR_ADDRESS_INVALID; + + return OK; +} + +SocketDescriptor StreamListenSocket::AcceptSocket() { + SocketDescriptor conn = HANDLE_EINTR(accept(socket_, NULL, NULL)); + if (conn == kInvalidSocket) + LOG(ERROR) << "Error accepting connection."; + else + SetNonBlocking(conn); + return conn; +} + +void StreamListenSocket::SendInternal(const char* bytes, int len) { + char* send_buf = const_cast(bytes); + int len_left = len; + while (true) { + int sent = HANDLE_EINTR(send(socket_, send_buf, len_left, 0)); + if (sent == len_left) { // A shortcut to avoid extraneous checks. + break; + } + if (sent == kSocketError) { +#if defined(OS_WIN) + if (WSAGetLastError() != WSAEWOULDBLOCK) { + LOG(ERROR) << "send failed: WSAGetLastError()==" << WSAGetLastError(); +#elif defined(OS_POSIX) + if (errno != EWOULDBLOCK && errno != EAGAIN) { + LOG(ERROR) << "send failed: errno==" << errno; +#endif + break; + } + // Otherwise we would block, and now we have to wait for a retry. + // Fall through to PlatformThread::YieldCurrentThread() + } else { + // sent != len_left according to the shortcut above. + // Shift the buffer start and send the remainder after a short while. + send_buf += sent; + len_left -= sent; + } + base::PlatformThread::YieldCurrentThread(); + } +} + +void StreamListenSocket::Listen() { + int backlog = 10; // TODO(erikkay): maybe don't allow any backlog? + if (listen(socket_, backlog) == -1) { + // TODO(erikkay): error handling. + LOG(ERROR) << "Could not listen on socket."; + return; + } +#if defined(OS_POSIX) + WatchSocket(WAITING_ACCEPT); +#endif +} + +void StreamListenSocket::Read() { + char buf[kReadBufSize + 1]; // +1 for null termination. + int len; + do { + len = HANDLE_EINTR(recv(socket_, buf, kReadBufSize, 0)); + if (len == kSocketError) { +#if defined(OS_WIN) + int err = WSAGetLastError(); + if (err == WSAEWOULDBLOCK) { +#elif defined(OS_POSIX) + if (errno == EWOULDBLOCK || errno == EAGAIN) { +#endif + break; + } else { + // TODO(ibrar): some error handling required here. + break; + } + } else if (len == 0) { +#if defined(OS_POSIX) + // In Windows, Close() is called by OnObjectSignaled. In POSIX, we need + // to call it here. + Close(); +#endif + } else { + // TODO(ibrar): maybe change DidRead to take a length instead. + DCHECK_GT(len, 0); + DCHECK_LE(len, kReadBufSize); + buf[len] = 0; // Already create a buffer with +1 length. + socket_delegate_->DidRead(this, buf, len); + } + } while (len == kReadBufSize); +} + +void StreamListenSocket::Close() { +#if defined(OS_POSIX) + if (wait_state_ == NOT_WAITING) + return; + wait_state_ = NOT_WAITING; +#endif + UnwatchSocket(); + socket_delegate_->DidClose(this); +} + +void StreamListenSocket::CloseSocket() { + if (socket_ != kInvalidSocket) { + UnwatchSocket(); +#if defined(OS_WIN) + closesocket(socket_); +#elif defined(OS_POSIX) + close(socket_); +#endif + } +} + +void StreamListenSocket::WatchSocket(WaitState state) { +#if defined(OS_WIN) + WSAEventSelect(socket_, socket_event_, FD_ACCEPT | FD_CLOSE | FD_READ); + watcher_.StartWatching(socket_event_, this); +#elif defined(OS_POSIX) + // Implicitly calls StartWatchingFileDescriptor(). + base::MessageLoopForIO::current()->WatchFileDescriptor( + socket_, true, base::MessageLoopForIO::WATCH_READ, &watcher_, this); + wait_state_ = state; +#endif +} + +void StreamListenSocket::UnwatchSocket() { +#if defined(OS_WIN) + watcher_.StopWatching(); +#elif defined(OS_POSIX) + watcher_.StopWatchingFileDescriptor(); +#endif +} + +// TODO(ibrar): We can add these functions into OS dependent files. +#if defined(OS_WIN) +// MessageLoop watcher callback. +void StreamListenSocket::OnObjectSignaled(HANDLE object) { + WSANETWORKEVENTS ev; + if (kSocketError == WSAEnumNetworkEvents(socket_, socket_event_, &ev)) { + // TODO + return; + } + + // If both FD_CLOSE and FD_READ are set we only call Read(). + // This will cause OnObjectSignaled to be called immediately again + // unless this socket is destroyed in Read(). + if ((ev.lNetworkEvents & (FD_CLOSE | FD_READ)) == FD_CLOSE) { + Close(); + // Close might have deleted this object. We should return immediately. + return; + } + // The object was reset by WSAEnumNetworkEvents. Watch for the next signal. + watcher_.StartWatching(object, this); + + if (ev.lNetworkEvents == 0) { + // Occasionally the event is set even though there is no new data. + // The net seems to think that this is ignorable. + return; + } + if (ev.lNetworkEvents & FD_ACCEPT) { + Accept(); + } + if (ev.lNetworkEvents & FD_READ) { + if (reads_paused_) { + has_pending_reads_ = true; + } else { + Read(); + // Read might have deleted this object. We should return immediately. + } + } +} +#elif defined(OS_POSIX) +void StreamListenSocket::OnFileCanReadWithoutBlocking(int fd) { + switch (wait_state_) { + case WAITING_ACCEPT: + Accept(); + break; + case WAITING_READ: + if (reads_paused_) { + has_pending_reads_ = true; + } else { + Read(); + } + break; + default: + // Close() is called by Read() in the Linux case. + NOTREACHED(); + break; + } +} + +void StreamListenSocket::OnFileCanWriteWithoutBlocking(int fd) { + // MessagePumpLibevent callback, we don't listen for write events + // so we shouldn't ever reach here. + NOTREACHED(); +} + +#endif + +void StreamListenSocket::PauseReads() { + DCHECK(!reads_paused_); + reads_paused_ = true; +} + +void StreamListenSocket::ResumeReads() { + DCHECK(reads_paused_); + reads_paused_ = false; + if (has_pending_reads_) { + has_pending_reads_ = false; + Read(); + } +} + +} // namespace test_server + +} // namespace net diff --git a/chromium_src/net/test/embedded_test_server/stream_listen_socket.h b/chromium_src/net/test/embedded_test_server/stream_listen_socket.h new file mode 100644 index 000000000000..02a8b9827a2e --- /dev/null +++ b/chromium_src/net/test/embedded_test_server/stream_listen_socket.h @@ -0,0 +1,151 @@ +// Copyright (c) 2012 The Chromium Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. + +// Stream-based listen socket implementation that handles reading and writing +// to the socket, but does not handle creating the socket nor connecting +// sockets, which are handled by subclasses on creation and in Accept, +// respectively. + +// StreamListenSocket handles IO asynchronously in the specified MessageLoop. +// This class is NOT thread safe. It uses WSAEVENT handles to monitor activity +// in a given MessageLoop. This means that callbacks will happen in that loop's +// thread always and that all other methods (including constructor and +// destructor) should also be called from the same thread. + +#ifndef NET_TEST_EMBEDDED_TEST_SERVER_STREAM_LISTEN_SOCKET_H_ +#define NET_TEST_EMBEDDED_TEST_SERVER_STREAM_LISTEN_SOCKET_H_ + +#include "build/build_config.h" + +#if defined(OS_WIN) +#include +#endif +#include +#if defined(OS_WIN) +#include "base/win/object_watcher.h" +#elif defined(OS_POSIX) +#include "base/message_loop/message_loop.h" +#endif + +#include "base/basictypes.h" +#include "base/compiler_specific.h" +#include "base/memory/scoped_ptr.h" +#include "net/base/net_export.h" +#include "net/socket/socket_descriptor.h" + +namespace net { + +class IPEndPoint; + +namespace test_server { + +class StreamListenSocket : +#if defined(OS_WIN) + public base::win::ObjectWatcher::Delegate { +#elif defined(OS_POSIX) + public base::MessageLoopForIO::Watcher { +#endif + + public: + ~StreamListenSocket() override; + + // TODO(erikkay): this delegate should really be split into two parts + // to split up the listener from the connected socket. Perhaps this class + // should be split up similarly. + class Delegate { + public: + // |server| is the original listening Socket, connection is the new + // Socket that was created. + virtual void DidAccept(StreamListenSocket* server, + scoped_ptr connection) = 0; + virtual void DidRead(StreamListenSocket* connection, + const char* data, + int len) = 0; + virtual void DidClose(StreamListenSocket* sock) = 0; + + protected: + virtual ~Delegate() {} + }; + + // Send data to the socket. + void Send(const char* bytes, int len, bool append_linefeed = false); + void Send(const std::string& str, bool append_linefeed = false); + + // Copies the local address to |address|. Returns a network error code. + // This method is virtual to support unit testing. + virtual int GetLocalAddress(IPEndPoint* address) const; + // Copies the peer address to |address|. Returns a network error code. + // This method is virtual to support unit testing. + virtual int GetPeerAddress(IPEndPoint* address) const; + + static const int kSocketError; + + protected: + enum WaitState { NOT_WAITING = 0, WAITING_ACCEPT = 1, WAITING_READ = 2 }; + + StreamListenSocket(SocketDescriptor s, Delegate* del); + + SocketDescriptor AcceptSocket(); + virtual void Accept() = 0; + + void Listen(); + void Read(); + void Close(); + void CloseSocket(); + + // Pass any value in case of Windows, because in Windows + // we are not using state. + void WatchSocket(WaitState state); + void UnwatchSocket(); + + Delegate* const socket_delegate_; + + private: + friend class TransportClientSocketTest; + + void SendInternal(const char* bytes, int len); + +#if defined(OS_WIN) + // ObjectWatcher delegate. + void OnObjectSignaled(HANDLE object) override; + base::win::ObjectWatcher watcher_; + HANDLE socket_event_; +#elif defined(OS_POSIX) + // Called by MessagePumpLibevent when the socket is ready to do I/O. + void OnFileCanReadWithoutBlocking(int fd) override; + void OnFileCanWriteWithoutBlocking(int fd) override; + WaitState wait_state_; + // The socket's libevent wrapper. + base::MessageLoopForIO::FileDescriptorWatcher watcher_; +#endif + + // NOTE: This is for unit test use only! + // Pause/Resume calling Read(). Note that ResumeReads() will also call + // Read() if there is anything to read. + void PauseReads(); + void ResumeReads(); + + const SocketDescriptor socket_; + bool reads_paused_; + bool has_pending_reads_; + + DISALLOW_COPY_AND_ASSIGN(StreamListenSocket); +}; + +// Abstract factory that must be subclassed for each subclass of +// StreamListenSocket. +class StreamListenSocketFactory { + public: + virtual ~StreamListenSocketFactory() {} + + // Returns a new instance of StreamListenSocket or NULL if an error occurred. + virtual scoped_ptr CreateAndListen( + StreamListenSocket::Delegate* delegate) const = 0; +}; + +} // namespace test_server + +} // namespace net + +#endif // NET_TEST_EMBEDDED_TEST_SERVER_STREAM_LISTEN_SOCKET_H_ diff --git a/chromium_src/net/test/embedded_test_server/tcp_listen_socket.cc b/chromium_src/net/test/embedded_test_server/tcp_listen_socket.cc new file mode 100644 index 000000000000..418f34592127 --- /dev/null +++ b/chromium_src/net/test/embedded_test_server/tcp_listen_socket.cc @@ -0,0 +1,118 @@ +// Copyright (c) 2012 The Chromium Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. + +#include "net/test/embedded_test_server/tcp_listen_socket.h" + +#if defined(OS_WIN) +// winsock2.h must be included first in order to ensure it is included before +// windows.h. +#include +#elif defined(OS_POSIX) +#include +#include +#include +#include +#include +#include "net/base/net_errors.h" +#endif + +#include "base/logging.h" +#include "base/sys_byteorder.h" +#include "base/threading/platform_thread.h" +#include "build/build_config.h" +#include "net/base/net_util.h" +#include "net/base/winsock_init.h" +#include "net/socket/socket_descriptor.h" + +using std::string; + +namespace net { + +namespace test_server { + +// static +scoped_ptr TCPListenSocket::CreateAndListen( + const string& ip, + uint16 port, + StreamListenSocket::Delegate* del) { + SocketDescriptor s = CreateAndBind(ip, port); + if (s == kInvalidSocket) + return scoped_ptr(); + scoped_ptr sock(new TCPListenSocket(s, del)); + sock->Listen(); + return sock.Pass(); +} + +TCPListenSocket::TCPListenSocket(SocketDescriptor s, + StreamListenSocket::Delegate* del) + : StreamListenSocket(s, del) { +} + +TCPListenSocket::~TCPListenSocket() { +} + +SocketDescriptor TCPListenSocket::CreateAndBind(const string& ip, uint16 port) { + SocketDescriptor s = CreatePlatformSocket(AF_INET, SOCK_STREAM, IPPROTO_TCP); + if (s != kInvalidSocket) { +#if defined(OS_POSIX) + // Allow rapid reuse. + static const int kOn = 1; + setsockopt(s, SOL_SOCKET, SO_REUSEADDR, &kOn, sizeof(kOn)); +#endif + sockaddr_in addr; + memset(&addr, 0, sizeof(addr)); + addr.sin_family = AF_INET; + addr.sin_addr.s_addr = inet_addr(ip.c_str()); + addr.sin_port = base::HostToNet16(port); + if (bind(s, reinterpret_cast(&addr), sizeof(addr))) { +#if defined(OS_WIN) + closesocket(s); +#elif defined(OS_POSIX) + close(s); +#endif + LOG(ERROR) << "Could not bind socket to " << ip << ":" << port; + s = kInvalidSocket; + } + } + return s; +} + +SocketDescriptor TCPListenSocket::CreateAndBindAnyPort(const string& ip, + uint16* port) { + SocketDescriptor s = CreateAndBind(ip, 0); + if (s == kInvalidSocket) + return kInvalidSocket; + sockaddr_in addr; + socklen_t addr_size = sizeof(addr); + bool failed = getsockname(s, reinterpret_cast(&addr), + &addr_size) != 0; + if (addr_size != sizeof(addr)) + failed = true; + if (failed) { + LOG(ERROR) << "Could not determine bound port, getsockname() failed"; +#if defined(OS_WIN) + closesocket(s); +#elif defined(OS_POSIX) + close(s); +#endif + return kInvalidSocket; + } + *port = base::NetToHost16(addr.sin_port); + return s; +} + +void TCPListenSocket::Accept() { + SocketDescriptor conn = AcceptSocket(); + if (conn == kInvalidSocket) + return; + scoped_ptr sock(new TCPListenSocket(conn, socket_delegate_)); +#if defined(OS_POSIX) + sock->WatchSocket(WAITING_READ); +#endif + socket_delegate_->DidAccept(this, sock.Pass()); +} + +} // namespace test_server + +} // namespace net diff --git a/chromium_src/net/test/embedded_test_server/tcp_listen_socket.h b/chromium_src/net/test/embedded_test_server/tcp_listen_socket.h new file mode 100644 index 000000000000..12b3fa40745e --- /dev/null +++ b/chromium_src/net/test/embedded_test_server/tcp_listen_socket.h @@ -0,0 +1,55 @@ +// Copyright (c) 2012 The Chromium Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. + +#ifndef NET_TEST_EMBEDDED_TEST_SERVER_TCP_LISTEN_SOCKET_H_ +#define NET_TEST_EMBEDDED_TEST_SERVER_TCP_LISTEN_SOCKET_H_ + +#include + +#include "base/basictypes.h" +#include "net/base/net_export.h" +#include "net/socket/socket_descriptor.h" +#include "net/test/embedded_test_server/stream_listen_socket.h" + +namespace net { + +namespace test_server { + +// Implements a TCP socket. +class TCPListenSocket : public StreamListenSocket { + public: + ~TCPListenSocket() override; + + // Listen on port for the specified IP address. Use 127.0.0.1 to only + // accept local connections. + static scoped_ptr CreateAndListen( + const std::string& ip, + uint16 port, + StreamListenSocket::Delegate* del); + + protected: + TCPListenSocket(SocketDescriptor s, StreamListenSocket::Delegate* del); + + // Implements StreamListenSocket::Accept. + void Accept() override; + + private: + friend class EmbeddedTestServer; + friend class TCPListenSocketTester; + + // Get raw TCP socket descriptor bound to ip:port. + static SocketDescriptor CreateAndBind(const std::string& ip, uint16 port); + + // Get raw TCP socket descriptor bound to ip and return port it is bound to. + static SocketDescriptor CreateAndBindAnyPort(const std::string& ip, + uint16* port); + + DISALLOW_COPY_AND_ASSIGN(TCPListenSocket); +}; + +} // namespace test_server + +} // namespace net + +#endif // NET_TEST_EMBEDDED_TEST_SERVER_TCP_LISTEN_SOCKET_H_ diff --git a/filenames.gypi b/filenames.gypi index b4015921e809..feb35789afe1 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -412,6 +412,10 @@ 'chromium_src/chrome/utility/utility_message_handler.h', 'chromium_src/library_loaders/libspeechd_loader.cc', 'chromium_src/library_loaders/libspeechd.h', + 'chromium_src/net/test/embedded_test_server/stream_listen_socket.cc', + 'chromium_src/net/test/embedded_test_server/stream_listen_socket.h', + 'chromium_src/net/test/embedded_test_server/tcp_listen_socket.cc', + 'chromium_src/net/test/embedded_test_server/tcp_listen_socket.h', '<@(native_mate_files)', '<(SHARED_INTERMEDIATE_DIR)/atom_natives.h', ], From 573c959a75080ce8aec1e99713f2e3f7bfcb6ec5 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 27 Aug 2015 13:16:19 +0800 Subject: [PATCH 0981/1293] Use our debugger implementation in Node --- atom/app/node_main.cc | 19 +++++++++---------- atom/common/node_bindings.cc | 5 ----- 2 files changed, 9 insertions(+), 15 deletions(-) diff --git a/atom/app/node_main.cc b/atom/app/node_main.cc index 8823e583107c..356fe03e139d 100644 --- a/atom/app/node_main.cc +++ b/atom/app/node_main.cc @@ -5,15 +5,18 @@ #include "atom/app/node_main.h" #include "atom/browser/javascript_environment.h" +#include "atom/browser/node_debugger.h" +#include "atom/common/node_includes.h" +#include "base/command_line.h" #include "gin/array_buffer.h" #include "gin/public/isolate_holder.h" #include "gin/v8_initializer.h" -#include "atom/common/node_includes.h" - namespace atom { int NodeMain(int argc, char *argv[]) { + base::CommandLine::Init(argc, argv); + argv = uv_setup_args(argc, argv); int exec_argc; const char** exec_argv; @@ -31,17 +34,13 @@ int NodeMain(int argc, char *argv[]) { gin_env.isolate(), uv_default_loop(), gin_env.context(), argc, argv, exec_argc, exec_argv); - // Start debugger. - node::node_isolate = gin_env.isolate(); - if (node::use_debug_agent) - node::StartDebug(env, node::debug_wait_connect); + // Start our custom debugger implementation. + NodeDebugger node_debugger(gin_env.isolate()); + if (node_debugger.IsRunning()) + env->AssignToContext(v8::Debug::GetDebugContext()); node::LoadEnvironment(env); - // Enable debugger. - if (node::use_debug_agent) - node::EnableDebug(env); - bool more; do { more = uv_run(env->event_loop(), UV_RUN_ONCE); diff --git a/atom/common/node_bindings.cc b/atom/common/node_bindings.cc index 827033bbccbc..e6d59f2ed366 100644 --- a/atom/common/node_bindings.cc +++ b/atom/common/node_bindings.cc @@ -137,11 +137,6 @@ void NodeBindings::Initialize() { AtomCommandLine::InitializeFromCommandLine(); #endif - // Parse the debug args. - auto args = AtomCommandLine::argv(); - for (const std::string& arg : args) - node::ParseDebugOpt(arg.c_str()); - // Init node. // (we assume node::Init would not modify the parameters under embedded mode). node::Init(nullptr, nullptr, nullptr, nullptr); From 134ccb550cd0cab442ea3ef396dc0f39e7d7fc53 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 27 Aug 2015 13:30:04 +0800 Subject: [PATCH 0982/1293] Use libuv to wake up main thread --- atom/browser/node_debugger.cc | 11 ++++++++--- atom/browser/node_debugger.h | 5 +++++ 2 files changed, 13 insertions(+), 3 deletions(-) diff --git a/atom/browser/node_debugger.cc b/atom/browser/node_debugger.cc index beaf682a8d4b..da5602a88137 100644 --- a/atom/browser/node_debugger.cc +++ b/atom/browser/node_debugger.cc @@ -59,6 +59,8 @@ NodeDebugger::NodeDebugger(v8::Isolate* isolate) if (wait_for_connection) v8::Debug::DebugBreak(isolate_); + uv_async_init(uv_default_loop(), &weak_up_ui_handle_, ProcessMessageInUI); + // Start a new IO thread. base::Thread::Options options; options.message_loop_type = base::MessageLoop::TYPE_IO; @@ -106,9 +108,7 @@ void NodeDebugger::OnMessage(const std::string& message) { isolate_, reinterpret_cast(message16.data()), message16.size()); - content::BrowserThread::PostTask( - content::BrowserThread::UI, FROM_HERE, - base::Bind(&v8::Debug::ProcessDebugMessages)); + uv_async_send(&weak_up_ui_handle_); } void NodeDebugger::SendMessage(const std::string& message) { @@ -130,6 +130,11 @@ void NodeDebugger::SendConnectMessage() { v8::V8::GetVersion(), ATOM_PRODUCT_NAME, kContentLength), true); } +// static +void NodeDebugger::ProcessMessageInUI(uv_async_t* handle) { + v8::Debug::ProcessDebugMessages(); +} + // static void NodeDebugger::DebugMessageHandler(const v8::Debug::Message& message) { NodeDebugger* self = static_cast( diff --git a/atom/browser/node_debugger.h b/atom/browser/node_debugger.h index bf77cb72da64..aedf7b2c0310 100644 --- a/atom/browser/node_debugger.h +++ b/atom/browser/node_debugger.h @@ -12,6 +12,7 @@ #include "base/threading/thread.h" #include "net/test/embedded_test_server/stream_listen_socket.h" #include "v8/include/v8-debug.h" +#include "vendor/node/deps/uv/include/uv.h" namespace atom { @@ -30,6 +31,8 @@ class NodeDebugger : public net::test_server::StreamListenSocket::Delegate { void SendMessage(const std::string& message); void SendConnectMessage(); + static void ProcessMessageInUI(uv_async_t* handle); + static void DebugMessageHandler(const v8::Debug::Message& message); // net::test_server::StreamListenSocket::Delegate: @@ -43,6 +46,8 @@ class NodeDebugger : public net::test_server::StreamListenSocket::Delegate { v8::Isolate* isolate_; + uv_async_t weak_up_ui_handle_; + base::Thread thread_; scoped_ptr server_; scoped_ptr accepted_socket_; From e432638b7dcf4f6160d48dd77848c0d6fe58fa95 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 27 Aug 2015 13:51:46 +0800 Subject: [PATCH 0983/1293] Update node: Remove unneeded exports --- atom/common/node_bindings.cc | 3 --- vendor/node | 2 +- 2 files changed, 1 insertion(+), 4 deletions(-) diff --git a/atom/common/node_bindings.cc b/atom/common/node_bindings.cc index e6d59f2ed366..8c03f1459967 100644 --- a/atom/common/node_bindings.cc +++ b/atom/common/node_bindings.cc @@ -174,10 +174,7 @@ node::Environment* NodeBindings::CreateEnvironment( } void NodeBindings::LoadEnvironment(node::Environment* env) { - node::node_isolate = env->isolate(); - node::LoadEnvironment(env); - mate::EmitEvent(env->isolate(), env->process_object(), "loaded"); } diff --git a/vendor/node b/vendor/node index b9b6dd9f3fc0..8253eb682526 160000 --- a/vendor/node +++ b/vendor/node @@ -1 +1 @@ -Subproject commit b9b6dd9f3fc095e66a3b89d3efd50f7c576da2c8 +Subproject commit 8253eb68252639db471090edb059eaa4fea4ce46 From e99b8c3a2b920ca285849609993c3d9bed4f159e Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 27 Aug 2015 15:22:02 +0800 Subject: [PATCH 0984/1293] Fix leak of handle when emitting events --- atom/browser/api/event_emitter.h | 2 ++ 1 file changed, 2 insertions(+) diff --git a/atom/browser/api/event_emitter.h b/atom/browser/api/event_emitter.h index 4fb953b63992..42816d42a45b 100644 --- a/atom/browser/api/event_emitter.h +++ b/atom/browser/api/event_emitter.h @@ -45,6 +45,8 @@ class EventEmitter : public Wrappable { content::WebContents* sender, IPC::Message* message, const Args&... args) { + v8::Locker locker(isolate()); + v8::HandleScope handle_scope(isolate()); v8::Local event = CreateJSEvent(isolate(), sender, message); return EmitWithEvent(name, event, args...); } From f7c75d36ba610fc40f37a2dbae56882bc0f3d32a Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 27 Aug 2015 15:23:23 +0800 Subject: [PATCH 0985/1293] Do not create remote object for simple return values of APIs --- atom/browser/lib/rpc-server.coffee | 10 +++++++--- atom/common/native_mate_converters/gfx_converter.cc | 12 ++++++++---- .../native_mate_converters/v8_value_converter.cc | 11 +++++------ vendor/native_mate | 2 +- 4 files changed, 21 insertions(+), 14 deletions(-) diff --git a/atom/browser/lib/rpc-server.coffee b/atom/browser/lib/rpc-server.coffee index 3eba472570a7..d19b5cf0659c 100644 --- a/atom/browser/lib/rpc-server.coffee +++ b/atom/browser/lib/rpc-server.coffee @@ -4,7 +4,7 @@ objectsRegistry = require './objects-registry.js' v8Util = process.atomBinding 'v8_util' # Convert a real value into meta data. -valueToMeta = (sender, value) -> +valueToMeta = (sender, value, optimizeSimpleObject=false) -> meta = type: typeof value meta.type = 'buffer' if Buffer.isBuffer value @@ -12,6 +12,10 @@ valueToMeta = (sender, value) -> meta.type = 'array' if Array.isArray value meta.type = 'promise' if value? and value.constructor.name is 'Promise' + # Treat simple objects as value. + if optimizeSimpleObject and meta.type is 'object' and v8Util.getHiddenValue value, 'simple' + meta.type = 'value' + # Treat the arguments object as array. meta.type = 'array' if meta.type is 'object' and value.callee? and value.length? @@ -80,11 +84,11 @@ unwrapArgs = (sender, args) -> callFunction = (event, func, caller, args) -> if v8Util.getHiddenValue(func, 'asynchronous') and typeof args[args.length - 1] isnt 'function' args.push (ret) -> - event.returnValue = valueToMeta event.sender, ret + event.returnValue = valueToMeta event.sender, ret, true func.apply caller, args else ret = func.apply caller, args - event.returnValue = valueToMeta event.sender, ret + event.returnValue = valueToMeta event.sender, ret, true # Send by BrowserWindow when its render view is deleted. process.on 'ATOM_BROWSER_RELEASE_RENDER_VIEW', (id) -> diff --git a/atom/common/native_mate_converters/gfx_converter.cc b/atom/common/native_mate_converters/gfx_converter.cc index 6620276b584e..37e7aeb3a48b 100644 --- a/atom/common/native_mate_converters/gfx_converter.cc +++ b/atom/common/native_mate_converters/gfx_converter.cc @@ -14,7 +14,8 @@ namespace mate { v8::Local Converter::ToV8(v8::Isolate* isolate, const gfx::Point& val) { - mate::Dictionary dict(isolate, v8::Object::New(isolate)); + mate::Dictionary dict = mate::Dictionary::CreateEmpty(isolate); + dict.SetHidden("simple", true); dict.Set("x", val.x()); dict.Set("y", val.y()); return dict.GetHandle(); @@ -35,7 +36,8 @@ bool Converter::FromV8(v8::Isolate* isolate, v8::Local Converter::ToV8(v8::Isolate* isolate, const gfx::Size& val) { - mate::Dictionary dict(isolate, v8::Object::New(isolate)); + mate::Dictionary dict = mate::Dictionary::CreateEmpty(isolate); + dict.SetHidden("simple", true); dict.Set("width", val.width()); dict.Set("height", val.height()); return dict.GetHandle(); @@ -56,7 +58,8 @@ bool Converter::FromV8(v8::Isolate* isolate, v8::Local Converter::ToV8(v8::Isolate* isolate, const gfx::Rect& val) { - mate::Dictionary dict(isolate, v8::Object::New(isolate)); + mate::Dictionary dict = mate::Dictionary::CreateEmpty(isolate); + dict.SetHidden("simple", true); dict.Set("x", val.x()); dict.Set("y", val.y()); dict.Set("width", val.width()); @@ -95,7 +98,8 @@ struct Converter { v8::Local Converter::ToV8(v8::Isolate* isolate, const gfx::Display& val) { - mate::Dictionary dict(isolate, v8::Object::New(isolate)); + mate::Dictionary dict = mate::Dictionary::CreateEmpty(isolate); + dict.SetHidden("simple", true); dict.Set("id", val.id()); dict.Set("bounds", val.bounds()); dict.Set("workArea", val.work_area()); diff --git a/atom/common/native_mate_converters/v8_value_converter.cc b/atom/common/native_mate_converters/v8_value_converter.cc index a6358b363eea..a91e614fc6dd 100644 --- a/atom/common/native_mate_converters/v8_value_converter.cc +++ b/atom/common/native_mate_converters/v8_value_converter.cc @@ -11,6 +11,7 @@ #include "base/logging.h" #include "base/memory/scoped_ptr.h" #include "base/values.h" +#include "native_mate/dictionary.h" #include "vendor/node/src/node_buffer.h" namespace atom { @@ -179,7 +180,8 @@ v8::Local V8ValueConverter::ToV8Array( v8::Local V8ValueConverter::ToV8Object( v8::Isolate* isolate, const base::DictionaryValue* val) const { - v8::Local result(v8::Object::New(isolate)); + mate::Dictionary result = mate::Dictionary::CreateEmpty(isolate); + result.SetHidden("simple", true); for (base::DictionaryValue::Iterator iter(*val); !iter.IsAtEnd(); iter.Advance()) { @@ -188,17 +190,14 @@ v8::Local V8ValueConverter::ToV8Object( CHECK(!child_v8.IsEmpty()); v8::TryCatch try_catch; - result->Set( - v8::String::NewFromUtf8(isolate, key.c_str(), v8::String::kNormalString, - key.length()), - child_v8); + result.Set(key, child_v8); if (try_catch.HasCaught()) { LOG(ERROR) << "Setter for property " << key.c_str() << " threw an " << "exception."; } } - return result; + return result.GetHandle(); } base::Value* V8ValueConverter::FromV8ValueImpl( diff --git a/vendor/native_mate b/vendor/native_mate index b41635e80921..f5e34deb1a52 160000 --- a/vendor/native_mate +++ b/vendor/native_mate @@ -1 +1 @@ -Subproject commit b41635e80921bddbf1a36f030490e063cd593477 +Subproject commit f5e34deb1a5226b4e7e620cb65fce0225471d4d9 From bd64f5ced2b5d2680d9bf2cea28ec038dfe62b49 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 27 Aug 2015 16:41:51 +0800 Subject: [PATCH 0986/1293] Use V8's new SetWeak method --- atom/common/api/object_life_monitor.cc | 50 ++++++++++++++++++-------- atom/common/api/object_life_monitor.h | 21 +++++++---- atom/common/id_weak_map.cc | 31 +++++++++------- atom/common/id_weak_map.h | 3 -- vendor/native_mate | 2 +- 5 files changed, 70 insertions(+), 37 deletions(-) diff --git a/atom/common/api/object_life_monitor.cc b/atom/common/api/object_life_monitor.cc index 18d2a3a4d53f..9b7c7fe6d05f 100644 --- a/atom/common/api/object_life_monitor.cc +++ b/atom/common/api/object_life_monitor.cc @@ -5,32 +5,52 @@ #include "atom/common/api/object_life_monitor.h" -#include "native_mate/compat.h" +#include "base/bind.h" +#include "base/message_loop/message_loop.h" namespace atom { // static void ObjectLifeMonitor::BindTo(v8::Isolate* isolate, v8::Local target, - v8::Local destructor) { - target->SetHiddenValue(MATE_STRING_NEW(isolate, "destructor"), destructor); - - ObjectLifeMonitor* olm = new ObjectLifeMonitor(); - olm->handle_.reset(isolate, target); - olm->handle_.SetWeak(olm, WeakCallback); + v8::Local destructor) { + new ObjectLifeMonitor(isolate, target, destructor); } -ObjectLifeMonitor::ObjectLifeMonitor() { +ObjectLifeMonitor::ObjectLifeMonitor(v8::Isolate* isolate, + v8::Local target, + v8::Local destructor) + : isolate_(isolate), + context_(isolate, isolate->GetCurrentContext()), + target_(isolate, target), + destructor_(isolate, destructor), + weak_ptr_factory_(this) { + target_.SetWeak(this, OnObjectGC, v8::WeakCallbackType::kParameter); } // static -void ObjectLifeMonitor::WeakCallback( - const v8::WeakCallbackData& data) { - // destructor.call(object, object); - v8::Local obj = data.GetValue(); - v8::Local::Cast(obj->GetHiddenValue( - MATE_STRING_NEW(data.GetIsolate(), "destructor")))->Call(obj, 0, NULL); - delete data.GetParameter(); +void ObjectLifeMonitor::OnObjectGC( + const v8::WeakCallbackInfo& data) { + // Usually FirstWeakCallback should do nothing other than reset |object_| + // and then set a second weak callback to run later. We can sidestep that, + // because posting a task to the current message loop is all but free - but + // DO NOT add any more work to this method. The only acceptable place to add + // code is RunCallback. + ObjectLifeMonitor* self = data.GetParameter(); + self->target_.Reset(); + base::MessageLoop::current()->PostTask( + FROM_HERE, base::Bind(&ObjectLifeMonitor::RunCallback, + self->weak_ptr_factory_.GetWeakPtr())); +} + +void ObjectLifeMonitor::RunCallback() { + v8::HandleScope handle_scope(isolate_); + v8::Local context = v8::Local::New( + isolate_, context_); + v8::Context::Scope context_scope(context); + v8::Local::New(isolate_, destructor_)->Call( + context->Global(), 0, nullptr); + delete this; } } // namespace atom diff --git a/atom/common/api/object_life_monitor.h b/atom/common/api/object_life_monitor.h index e8dbbcf65f15..90216d8227a5 100644 --- a/atom/common/api/object_life_monitor.h +++ b/atom/common/api/object_life_monitor.h @@ -6,7 +6,8 @@ #define ATOM_COMMON_API_OBJECT_LIFE_MONITOR_H_ #include "base/basictypes.h" -#include "native_mate/scoped_persistent.h" +#include "base/memory/weak_ptr.h" +#include "v8/include/v8.h" namespace atom { @@ -14,15 +15,23 @@ class ObjectLifeMonitor { public: static void BindTo(v8::Isolate* isolate, v8::Local target, - v8::Local destructor); + v8::Local destructor); private: - ObjectLifeMonitor(); + ObjectLifeMonitor(v8::Isolate* isolate, + v8::Local target, + v8::Local destructor); - static void WeakCallback( - const v8::WeakCallbackData& data); + static void OnObjectGC(const v8::WeakCallbackInfo& data); - mate::ScopedPersistent handle_; + void RunCallback(); + + v8::Isolate* isolate_; + v8::Global context_; + v8::Global target_; + v8::Global destructor_; + + base::WeakPtrFactory weak_ptr_factory_; DISALLOW_COPY_AND_ASSIGN(ObjectLifeMonitor); }; diff --git a/atom/common/id_weak_map.cc b/atom/common/id_weak_map.cc index 4e86d7309a82..0be16765ac4c 100644 --- a/atom/common/id_weak_map.cc +++ b/atom/common/id_weak_map.cc @@ -10,6 +10,23 @@ namespace atom { +namespace { + +struct ObjectKey { + ObjectKey(int id, IDWeakMap* map) : id(id), map(map) {} + int id; + IDWeakMap* map; +}; + +void OnObjectGC(const v8::WeakCallbackInfo& data) { + ObjectKey* key = data.GetParameter(); + LOG(ERROR) << "OnObjectGC: " << key->id; + key->map->Remove(key->id); + delete key; +} + +} // namespace + IDWeakMap::IDWeakMap() : next_id_(0) { } @@ -18,11 +35,9 @@ IDWeakMap::~IDWeakMap() { int32_t IDWeakMap::Add(v8::Isolate* isolate, v8::Local object) { int32_t id = GetNextID(); - object->SetHiddenValue(mate::StringToSymbol(isolate, "IDWeakMapKey"), - mate::Converter::ToV8(isolate, id)); - auto global = make_linked_ptr(new v8::Global(isolate, object)); - global->SetWeak(this, &WeakCallback); + ObjectKey* key = new ObjectKey(id, this); + global->SetWeak(key, OnObjectGC, v8::WeakCallbackType::kParameter); map_[id] = global; return id; } @@ -71,12 +86,4 @@ int32_t IDWeakMap::GetNextID() { return ++next_id_; } -// static -void IDWeakMap::WeakCallback( - const v8::WeakCallbackData& data) { - int32_t id = data.GetValue()->GetHiddenValue( - mate::StringToV8(data.GetIsolate(), "IDWeakMapKey"))->Int32Value(); - data.GetParameter()->Remove(id); -} - } // namespace atom diff --git a/atom/common/id_weak_map.h b/atom/common/id_weak_map.h index b16334d6cea1..9fe71ebb616f 100644 --- a/atom/common/id_weak_map.h +++ b/atom/common/id_weak_map.h @@ -44,9 +44,6 @@ class IDWeakMap { // Returns next available ID. int32_t GetNextID(); - static void WeakCallback( - const v8::WeakCallbackData& data); - // ID of next stored object. int32_t next_id_; diff --git a/vendor/native_mate b/vendor/native_mate index f5e34deb1a52..8ca005eb4159 160000 --- a/vendor/native_mate +++ b/vendor/native_mate @@ -1 +1 @@ -Subproject commit f5e34deb1a5226b4e7e620cb65fce0225471d4d9 +Subproject commit 8ca005eb41591f583ebab804945311903f866ad6 From e4c01f3187417f6404a826d646f3136696dc9578 Mon Sep 17 00:00:00 2001 From: Heilig Benedek Date: Thu, 27 Aug 2015 11:22:39 +0200 Subject: [PATCH 0987/1293] Offscreen render support base --- .gitmodules | 2 +- atom/app/atom_main.cc | 8 ++-- atom/browser/api/atom_api_window.cc | 11 +++++ atom/browser/api/atom_api_window.h | 1 + atom/browser/native_window.cc | 58 ++++++++++++++++++++++++++- atom/browser/native_window.h | 30 ++++++++++++++ atom/browser/native_window_observer.h | 2 + atom/common/options_switches.cc | 2 + atom/common/options_switches.h | 2 + vendor/native_mate | 2 +- 10 files changed, 112 insertions(+), 6 deletions(-) diff --git a/.gitmodules b/.gitmodules index c6e53ed39a69..a3afcef28c84 100644 --- a/.gitmodules +++ b/.gitmodules @@ -12,7 +12,7 @@ url = https://github.com/atom/chromium-breakpad.git [submodule "vendor/native_mate"] path = vendor/native_mate - url = https://github.com/zcbenz/native-mate.git + url = https://github.com/brenca/native-mate.git [submodule "vendor/crashpad"] path = vendor/crashpad url = https://github.com/atom/crashpad.git diff --git a/atom/app/atom_main.cc b/atom/app/atom_main.cc index 47be348522f1..5677adb2eed3 100644 --- a/atom/app/atom_main.cc +++ b/atom/app/atom_main.cc @@ -90,9 +90,11 @@ int APIENTRY wWinMain(HINSTANCE instance, HINSTANCE, wchar_t* cmd, int) { if (env->GetVar("OS", &os) && os != "cygwin") { AttachConsole(ATTACH_PARENT_PROCESS); - FILE* dontcare; - freopen_s(&dontcare, "CON", "w", stdout); - freopen_s(&dontcare, "CON", "w", stderr); + FILE* dontcare, *out, *err; + out = fopen("out.txt", "w"); + err = fopen("err.txt", "w"); + freopen_s(&out, "CON", "w", stdout); + freopen_s(&err, "CON", "w", stderr); freopen_s(&dontcare, "CON", "r", stdin); } diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index e6d16fe6fa59..c19cf6f7d945 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -17,6 +17,7 @@ #include "native_mate/constructor.h" #include "native_mate/dictionary.h" #include "ui/gfx/geometry/rect.h" +#include "v8/include/v8.h" #if defined(OS_WIN) #include "atom/browser/native_window_views.h" @@ -92,6 +93,16 @@ void Window::WillCloseWindow(bool* prevent_default) { *prevent_default = Emit("close"); } +void Window::OnFrameRendered(scoped_ptr rgb, const int size) { + v8::Locker locker(isolate()); + v8::HandleScope handle_scope(isolate()); + + v8::Local data = v8::ArrayBuffer::New(isolate(), rgb.get(), size); + v8::Local uint_data = v8::Uint8ClampedArray::New(data, 0, size); + + Emit("frame-rendered", uint_data, size); +} + void Window::OnWindowClosed() { if (api_web_contents_) { api_web_contents_->DestroyWebContents(); diff --git a/atom/browser/api/atom_api_window.h b/atom/browser/api/atom_api_window.h index de2f093ea3e1..925aa6749714 100644 --- a/atom/browser/api/atom_api_window.h +++ b/atom/browser/api/atom_api_window.h @@ -53,6 +53,7 @@ class Window : public mate::TrackableObject, void OnPageTitleUpdated(bool* prevent_default, const std::string& title) override; void WillCloseWindow(bool* prevent_default) override; + void OnFrameRendered(scoped_ptr rgb, const int size) override; void OnWindowClosed() override; void OnWindowBlur() override; void OnWindowFocus() override; diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 96085846bca8..b21d04aa2389 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -8,6 +8,9 @@ #include #include +#include "content/public/browser/render_widget_host_view_frame_subscriber.h" +#include "media/base/video_frame.h" +#include "media/base/yuv_convert.h" #include "atom/browser/atom_browser_context.h" #include "atom/browser/atom_browser_main_parts.h" #include "atom/browser/window_list.h" @@ -147,8 +150,9 @@ NativeWindow* NativeWindow::FromWebContents( content::WebContents* web_contents) { WindowList& window_list = *WindowList::GetInstance(); for (NativeWindow* window : window_list) { - if (window->web_contents() == web_contents) + if (window->web_contents() == web_contents){ return window; + } } return nullptr; } @@ -201,6 +205,9 @@ void NativeWindow::InitFromOptions(const mate::Dictionary& options) { options.Get(switches::kTitle, &title); SetTitle(title); + offscreen_ = false; + options.Get(switches::kOffScreenRender, &offscreen_); + // Then show it. bool show = true; options.Get(switches::kShow, &show); @@ -540,6 +547,18 @@ void NativeWindow::DevToolsClosed() { FOR_EACH_OBSERVER(NativeWindowObserver, observers_, OnDevToolsClosed()); } +void NativeWindow::RenderViewReady(){ + if(offscreen_){ + const auto view = web_contents()->GetRenderWidgetHostView(); + + scoped_ptr subscriber(new RenderSubscriber( + view->GetVisibleViewportSize(), base::Bind(&NativeWindow::OnFrameReceived, base::Unretained(this)) + )); + + view->BeginFrameSubscription(subscriber.Pass()); + } +} + void NativeWindow::RenderViewCreated( content::RenderViewHost* render_view_host) { if (!transparent_) @@ -617,4 +636,41 @@ void NativeWindow::OnCapturePageDone(const CapturePageCallback& callback, callback.Run(bitmap); } +void NativeWindow::OnFrameReceived(bool result, scoped_refptr frame) { + if(result){ + gfx::Rect rect = frame->visible_rect(); + + const int rgb_arr_size = rect.width()*rect.height()*4; + scoped_ptr rgb_bytes(new uint8[rgb_arr_size]); + + // Convert a frame of YUV to 32 bit ARGB. + media::ConvertYUVToRGB32(frame->data(media::VideoFrame::kYPlane), + frame->data(media::VideoFrame::kUPlane), + frame->data(media::VideoFrame::kVPlane), + rgb_bytes.get(), + rect.width(), rect.height(), + frame->stride(media::VideoFrame::kYPlane), + frame->stride(media::VideoFrame::kUVPlane), + rect.width()*4, + media::YV12); + + FOR_EACH_OBSERVER(NativeWindowObserver, + observers_, + OnFrameRendered(rgb_bytes.Pass(), rgb_arr_size)); + } +} + +bool RenderSubscriber::ShouldCaptureFrame(const gfx::Rect& damage_rect, + base::TimeTicks present_time, + scoped_refptr* storage, + DeliverFrameCallback* callback) { + last_present_time_ = present_time; + *storage = media::VideoFrame::CreateFrame(media::VideoFrame::YV12, size_, + gfx::Rect(size_), size_, + base::TimeDelta()); + + *callback = base::Bind(&RenderSubscriber::CallbackMethod, callback_, *storage); + return true; +} + } // namespace atom diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index b9294d38c931..793bd614c8d8 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -9,6 +9,8 @@ #include #include +#include "media/base/video_frame.h" +#include "content/public/browser/render_widget_host_view_frame_subscriber.h" #include "atom/browser/native_window_observer.h" #include "atom/browser/ui/accelerator_util.h" #include "base/cancelable_callback.h" @@ -232,6 +234,8 @@ class NativeWindow : public content::WebContentsObserver, has_dialog_attached_ = has_dialog_attached; } + void OnFrameReceived(bool result, scoped_refptr frame); + protected: NativeWindow(brightray::InspectableWebContents* inspectable_web_contents, const mate::Dictionary& options); @@ -243,6 +247,7 @@ class NativeWindow : public content::WebContentsObserver, // content::WebContentsObserver: void RenderViewCreated(content::RenderViewHost* render_view_host) override; + void RenderViewReady() override; void BeforeUnloadDialogCancelled() override; void TitleWasSet(content::NavigationEntry* entry, bool explicit_set) override; bool OnMessageReceived(const IPC::Message& message) override; @@ -263,6 +268,8 @@ class NativeWindow : public content::WebContentsObserver, const SkBitmap& bitmap, content::ReadbackResponse response); + bool offscreen_; + // Whether window has standard frame. bool has_frame_; @@ -317,6 +324,29 @@ class NativeWindow : public content::WebContentsObserver, DISALLOW_COPY_AND_ASSIGN(NativeWindow); }; +class RenderSubscriber : public content::RenderWidgetHostViewFrameSubscriber { + public: + RenderSubscriber(gfx::Size size, base::Callback)> callback) : size_(size), callback_(callback) {} + + bool ShouldCaptureFrame(const gfx::Rect& damage_rect, + base::TimeTicks present_time, + scoped_refptr* storage, + DeliverFrameCallback* callback) override; + + base::TimeTicks last_present_time() const { return last_present_time_; } + + static void CallbackMethod(base::Callback)> callback, + scoped_refptr frame, + base::TimeTicks present_time, + bool success) { + callback.Run(success, frame); + } + + private: + gfx::Size size_; + base::Callback)> callback_; + base::TimeTicks last_present_time_; +}; // This class provides a hook to get a NativeWindow from a WebContents. class NativeWindowRelay : diff --git a/atom/browser/native_window_observer.h b/atom/browser/native_window_observer.h index 5b0a0c56b3de..db6587de1f44 100644 --- a/atom/browser/native_window_observer.h +++ b/atom/browser/native_window_observer.h @@ -27,6 +27,8 @@ class NativeWindowObserver { const std::string& partition_id, WindowOpenDisposition disposition) {} + virtual void OnFrameRendered(scoped_ptr rgb, const int size) {} + // Called when user is starting an navigation in web page. virtual void WillNavigate(bool* prevent_default, const GURL& url) {} diff --git a/atom/common/options_switches.cc b/atom/common/options_switches.cc index 8f457116ec3a..73a54157fabd 100644 --- a/atom/common/options_switches.cc +++ b/atom/common/options_switches.cc @@ -110,6 +110,8 @@ const char kRegisterStandardSchemes[] = "register-standard-schemes"; // The browser process app model ID const char kAppUserModelId[] = "app-user-model-id"; +const char kOffScreenRender[] = "offscreen-render"; + } // namespace switches } // namespace atom diff --git a/atom/common/options_switches.h b/atom/common/options_switches.h index 2dd48ee32a1a..edd37ff03589 100644 --- a/atom/common/options_switches.h +++ b/atom/common/options_switches.h @@ -60,6 +60,8 @@ extern const char kRegisterStandardSchemes[]; extern const char kAppUserModelId[]; +extern const char kOffScreenRender[]; + } // namespace switches } // namespace atom diff --git a/vendor/native_mate b/vendor/native_mate index 67d9eaa215e8..31b6395d9938 160000 --- a/vendor/native_mate +++ b/vendor/native_mate @@ -1 +1 @@ -Subproject commit 67d9eaa215e8727d86dc7b1f7a10be8699848f1f +Subproject commit 31b6395d9938558ea39a77ef2f432beaf2dcd4cb From 64e8ce0c07959bf3415fe36d57234527f1e1dea9 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 27 Aug 2015 19:01:34 +0800 Subject: [PATCH 0988/1293] Don't rely on IDWeakMap for bookkeeping remote objects It frees us from using C++ to track JS objects, thus improves the performance of collecting memory. --- atom/browser/lib/objects-registry.coffee | 115 ++++++++++------------- atom/browser/lib/rpc-server.coffee | 6 +- atom/common/api/atom_api_v8_util.cc | 6 ++ atom/renderer/api/lib/remote.coffee | 2 +- 4 files changed, 59 insertions(+), 70 deletions(-) diff --git a/atom/browser/lib/objects-registry.coffee b/atom/browser/lib/objects-registry.coffee index f102cbef894e..ccfe2dbe0ad2 100644 --- a/atom/browser/lib/objects-registry.coffee +++ b/atom/browser/lib/objects-registry.coffee @@ -1,82 +1,65 @@ EventEmitter = require('events').EventEmitter -IDWeakMap = process.atomBinding('id_weak_map').IDWeakMap v8Util = process.atomBinding 'v8_util' -# Class to reference all objects. -class ObjectsStore - @stores = {} - - constructor: -> - @nextId = 0 - @objects = [] - - getNextId: -> - ++@nextId - - add: (obj) -> - id = @getNextId() - @objects[id] = obj - id - - has: (id) -> - @objects[id]? - - remove: (id) -> - throw new Error("Invalid key #{id} for ObjectsStore") unless @has id - delete @objects[id] - - get: (id) -> - throw new Error("Invalid key #{id} for ObjectsStore") unless @has id - @objects[id] - - @forRenderView: (key) -> - @stores[key] = new ObjectsStore unless @stores[key]? - @stores[key] - - @releaseForRenderView: (key) -> - delete @stores[key] - class ObjectsRegistry extends EventEmitter constructor: -> @setMaxListeners Number.MAX_VALUE + @nextId = 0 - # Objects in weak map will be not referenced (so we won't leak memory), and - # every object created in browser will have a unique id in weak map. - @objectsWeakMap = new IDWeakMap - @objectsWeakMap.add = (obj) -> - id = IDWeakMap::add.call this, obj - v8Util.setHiddenValue obj, 'atomId', id - id + # Stores all objects by ref-counting. + # (id) => {object, count} + @storage = {} + + # Stores the IDs of objects referenced by WebContents. + # (webContentsId) => {(id) => (count)} + @owners = {} # Register a new object, the object would be kept referenced until you release # it explicitly. - add: (key, obj) -> - # Some native objects may already been added to objectsWeakMap, be care not - # to add it twice. - @objectsWeakMap.add obj unless v8Util.getHiddenValue obj, 'atomId' - id = v8Util.getHiddenValue obj, 'atomId' + add: (webContentsId, obj) -> + id = @saveToStorage obj + # Remember the owner. + @owners[webContentsId] ?= {} + @owners[webContentsId][id] ?= 0 + @owners[webContentsId][id]++ + # Returns object's id + id - # Store and reference the object, then return the storeId which points to - # where the object is stored. The caller can later dereference the object - # with the storeId. - # We use a difference key because the same object can be referenced for - # multiple times by the same renderer view. - store = ObjectsStore.forRenderView key - storeId = store.add obj - - [id, storeId] - - # Get an object according to its id. + # Get an object according to its ID. get: (id) -> - @objectsWeakMap.get id + @storage[id]?.object - # Remove an object according to its storeId. - remove: (key, storeId) -> - ObjectsStore.forRenderView(key).remove storeId + # Dereference an object according to its ID. + remove: (webContentsId, id) -> + @dereference id, 1 + # Also reduce the count in owner. + pointer = @owners[webContentsId] + --pointer[id] + delete pointer[id] if pointer[id] is 0 - # Clear all references to objects from renderer view. - clear: (key) -> - @emit "clear-#{key}" - ObjectsStore.releaseForRenderView key + # Clear all references to objects refrenced by the WebContents. + clear: (webContentsId) -> + @emit "clear-#{webContentsId}" + return unless @owners[webContentsId]? + @dereference id, count for id, count of @owners[webContentsId] + delete @owners[webContentsId] + + # Private: Saves the object into storage and assigns an ID for it. + saveToStorage: (object) -> + id = v8Util.getHiddenValue object, 'atomId' + unless id + id = ++@nextId + @storage[id] = {count: 0, object} + v8Util.setHiddenValue object, 'atomId', id + ++@storage[id].count + id + + # Private: Dereference the object from store. + dereference: (id, count) -> + pointer = @storage[id] + pointer.count -= count + if pointer.count is 0 + v8Util.deleteHiddenValue pointer.object, 'atomId' + delete @storage[id] module.exports = new ObjectsRegistry diff --git a/atom/browser/lib/rpc-server.coffee b/atom/browser/lib/rpc-server.coffee index d19b5cf0659c..0a28d350e8a9 100644 --- a/atom/browser/lib/rpc-server.coffee +++ b/atom/browser/lib/rpc-server.coffee @@ -28,7 +28,7 @@ valueToMeta = (sender, value, optimizeSimpleObject=false) -> # Reference the original value if it's an object, because when it's # passed to renderer we would assume the renderer keeps a reference of # it. - [meta.id, meta.storeId] = objectsRegistry.add sender.getId(), value + meta.id = objectsRegistry.add sender.getId(), value meta.members = [] meta.members.push {name: prop, type: typeof field} for prop, field of value @@ -174,8 +174,8 @@ ipc.on 'ATOM_BROWSER_MEMBER_GET', (event, id, name) -> catch e event.returnValue = errorToMeta e -ipc.on 'ATOM_BROWSER_DEREFERENCE', (event, storeId) -> - objectsRegistry.remove event.sender.getId(), storeId +ipc.on 'ATOM_BROWSER_DEREFERENCE', (event, id) -> + objectsRegistry.remove event.sender.getId(), id ipc.on 'ATOM_BROWSER_GUEST_WEB_CONTENTS', (event, guestInstanceId) -> try diff --git a/atom/common/api/atom_api_v8_util.cc b/atom/common/api/atom_api_v8_util.cc index ae90fe1f37fc..21f23a97b456 100644 --- a/atom/common/api/atom_api_v8_util.cc +++ b/atom/common/api/atom_api_v8_util.cc @@ -28,6 +28,11 @@ void SetHiddenValue(v8::Local object, object->SetHiddenValue(key, value); } +void DeleteHiddenValue(v8::Local object, + v8::Local key) { + object->DeleteHiddenValue(key); +} + int32_t GetObjectHash(v8::Local object) { return object->GetIdentityHash(); } @@ -48,6 +53,7 @@ void Initialize(v8::Local exports, v8::Local unused, dict.SetMethod("createObjectWithName", &CreateObjectWithName); dict.SetMethod("getHiddenValue", &GetHiddenValue); dict.SetMethod("setHiddenValue", &SetHiddenValue); + dict.SetMethod("deleteHiddenValue", &DeleteHiddenValue); dict.SetMethod("getObjectHash", &GetObjectHash); dict.SetMethod("setDestructor", &SetDestructor); dict.SetMethod("takeHeapSnapshot", &TakeHeapSnapshot); diff --git a/atom/renderer/api/lib/remote.coffee b/atom/renderer/api/lib/remote.coffee index 29a24b1789ef..abd86e7eee0c 100644 --- a/atom/renderer/api/lib/remote.coffee +++ b/atom/renderer/api/lib/remote.coffee @@ -102,7 +102,7 @@ metaToValue = (meta) -> # Track delegate object's life time, and tell the browser to clean up # when the object is GCed. v8Util.setDestructor ret, -> - ipc.send 'ATOM_BROWSER_DEREFERENCE', meta.storeId + ipc.send 'ATOM_BROWSER_DEREFERENCE', meta.id # Remember object's id. v8Util.setHiddenValue ret, 'atomId', meta.id From 63eb4b72e2afdb7c0467e52172b017c804453cf2 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 27 Aug 2015 19:48:55 +0800 Subject: [PATCH 0989/1293] IDWeakMap is not used anly more in JS --- atom/common/api/atom_api_id_weak_map.cc | 80 ------------------------- atom/common/api/atom_api_id_weak_map.h | 44 -------------- atom/common/node_bindings.cc | 1 - filenames.gypi | 2 - 4 files changed, 127 deletions(-) delete mode 100644 atom/common/api/atom_api_id_weak_map.cc delete mode 100644 atom/common/api/atom_api_id_weak_map.h diff --git a/atom/common/api/atom_api_id_weak_map.cc b/atom/common/api/atom_api_id_weak_map.cc deleted file mode 100644 index c5fbf09370f2..000000000000 --- a/atom/common/api/atom_api_id_weak_map.cc +++ /dev/null @@ -1,80 +0,0 @@ -// Copyright (c) 2013 GitHub, Inc. -// Use of this source code is governed by the MIT license that can be -// found in the LICENSE file. - -#include "atom/common/api/atom_api_id_weak_map.h" - -#include "native_mate/constructor.h" -#include "native_mate/object_template_builder.h" - -#include "atom/common/node_includes.h" - -namespace atom { - -namespace api { - -IDWeakMap::IDWeakMap() { -} - -IDWeakMap::~IDWeakMap() { -} - -int32_t IDWeakMap::Add(v8::Isolate* isolate, v8::Local object) { - return map_.Add(isolate, object); -} - -v8::Local IDWeakMap::Get(v8::Isolate* isolate, int32_t key) { - v8::MaybeLocal result = map_.Get(isolate, key); - if (result.IsEmpty()) { - isolate->ThrowException(v8::Exception::Error( - mate::StringToV8(isolate, "Invalid key"))); - return v8::Undefined(isolate); - } else { - return result.ToLocalChecked(); - } -} - -bool IDWeakMap::Has(int32_t key) const { - return map_.Has(key); -} - -std::vector IDWeakMap::Keys() const { - return map_.Keys(); -} - -void IDWeakMap::Remove(int32_t key) { - map_.Remove(key); -} - -// static -void IDWeakMap::BuildPrototype(v8::Isolate* isolate, - v8::Local prototype) { - mate::ObjectTemplateBuilder(isolate, prototype) - .SetMethod("add", &IDWeakMap::Add) - .SetMethod("get", &IDWeakMap::Get) - .SetMethod("has", &IDWeakMap::Has) - .SetMethod("keys", &IDWeakMap::Keys) - .SetMethod("remove", &IDWeakMap::Remove); -} - -} // namespace api - -} // namespace atom - - -namespace { - -void Initialize(v8::Local exports, v8::Local unused, - v8::Local context, void* priv) { - using atom::api::IDWeakMap; - v8::Isolate* isolate = context->GetIsolate(); - v8::Local constructor = mate::CreateConstructor( - isolate, - "IDWeakMap", - base::Bind(&mate::NewOperatorFactory)); - exports->Set(mate::StringToSymbol(isolate, "IDWeakMap"), constructor); -} - -} // namespace - -NODE_MODULE_CONTEXT_AWARE_BUILTIN(atom_common_id_weak_map, Initialize) diff --git a/atom/common/api/atom_api_id_weak_map.h b/atom/common/api/atom_api_id_weak_map.h deleted file mode 100644 index 955bd83088ac..000000000000 --- a/atom/common/api/atom_api_id_weak_map.h +++ /dev/null @@ -1,44 +0,0 @@ -// Copyright (c) 2013 GitHub, Inc. -// Copyright (c) 2012 Intel Corp. All rights reserved. -// Use of this source code is governed by the MIT license that can be -// found in the LICENSE file. - -#ifndef ATOM_COMMON_API_ATOM_API_ID_WEAK_MAP_H_ -#define ATOM_COMMON_API_ATOM_API_ID_WEAK_MAP_H_ - -#include - -#include "atom/common/id_weak_map.h" -#include "native_mate/wrappable.h" - -namespace atom { - -namespace api { - -// Like ES6's WeakMap, but the key is Integer and the value is Weak Pointer. -class IDWeakMap : public mate::Wrappable { - public: - IDWeakMap(); - - static void BuildPrototype(v8::Isolate* isolate, - v8::Local prototype); - - private: - virtual ~IDWeakMap(); - - int32_t Add(v8::Isolate* isolate, v8::Local object); - v8::Local Get(v8::Isolate* isolate, int32_t key); - bool Has(int32_t key) const; - std::vector Keys() const; - void Remove(int32_t key); - - atom::IDWeakMap map_; - - DISALLOW_COPY_AND_ASSIGN(IDWeakMap); -}; - -} // namespace api - -} // namespace atom - -#endif // ATOM_COMMON_API_ATOM_API_ID_WEAK_MAP_H_ diff --git a/atom/common/node_bindings.cc b/atom/common/node_bindings.cc index 8c03f1459967..5aed5619f9cf 100644 --- a/atom/common/node_bindings.cc +++ b/atom/common/node_bindings.cc @@ -47,7 +47,6 @@ REFERENCE_MODULE(atom_browser_window); REFERENCE_MODULE(atom_common_asar); REFERENCE_MODULE(atom_common_clipboard); REFERENCE_MODULE(atom_common_crash_reporter); -REFERENCE_MODULE(atom_common_id_weak_map); REFERENCE_MODULE(atom_common_native_image); REFERENCE_MODULE(atom_common_screen); REFERENCE_MODULE(atom_common_shell); diff --git a/filenames.gypi b/filenames.gypi index feb35789afe1..af0c56e1ea69 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -235,8 +235,6 @@ 'atom/common/api/atom_api_asar.cc', 'atom/common/api/atom_api_clipboard.cc', 'atom/common/api/atom_api_crash_reporter.cc', - 'atom/common/api/atom_api_id_weak_map.cc', - 'atom/common/api/atom_api_id_weak_map.h', 'atom/common/api/atom_api_native_image.cc', 'atom/common/api/atom_api_native_image.h', 'atom/common/api/atom_api_native_image_mac.mm', From 7889e2750f3f6ab7ee3a9a6a9953827a8dca27e5 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 27 Aug 2015 20:21:05 +0800 Subject: [PATCH 0990/1293] Suppress the heap snapshot test It is failing in Travis CI but not in GitHub CI or my own machine, ignore it for now. --- spec/chromium-spec.coffee | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/chromium-spec.coffee b/spec/chromium-spec.coffee index 704e5bbcac74..f98c8a75c742 100644 --- a/spec/chromium-spec.coffee +++ b/spec/chromium-spec.coffee @@ -8,7 +8,7 @@ remote = require 'remote' describe 'chromium feature', -> fixtures = path.resolve __dirname, 'fixtures' - describe 'heap snapshot', -> + xdescribe 'heap snapshot', -> it 'does not crash', -> process.atomBinding('v8_util').takeHeapSnapshot() From 37244c3b085279ffc7c91ac9092c91341d1b0de2 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 27 Aug 2015 20:35:04 +0800 Subject: [PATCH 0991/1293] Remove extra output --- atom/common/id_weak_map.cc | 1 - 1 file changed, 1 deletion(-) diff --git a/atom/common/id_weak_map.cc b/atom/common/id_weak_map.cc index 0be16765ac4c..c5c4b60cac5c 100644 --- a/atom/common/id_weak_map.cc +++ b/atom/common/id_weak_map.cc @@ -20,7 +20,6 @@ struct ObjectKey { void OnObjectGC(const v8::WeakCallbackInfo& data) { ObjectKey* key = data.GetParameter(); - LOG(ERROR) << "OnObjectGC: " << key->id; key->map->Remove(key->id); delete key; } From 8a09cf5369cae07136ca8de92eba4aebd8c395f4 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 27 Aug 2015 22:08:25 +0800 Subject: [PATCH 0992/1293] Add webFrame.setZoomLevelLimits API --- atom/renderer/api/atom_api_web_frame.cc | 5 +++++ atom/renderer/api/atom_api_web_frame.h | 2 ++ docs/api/web-frame.md | 7 +++++++ 3 files changed, 14 insertions(+) diff --git a/atom/renderer/api/atom_api_web_frame.cc b/atom/renderer/api/atom_api_web_frame.cc index d2c4ed2fa7b0..6e2054453a79 100644 --- a/atom/renderer/api/atom_api_web_frame.cc +++ b/atom/renderer/api/atom_api_web_frame.cc @@ -50,6 +50,10 @@ double WebFrame::GetZoomFactor() const { return blink::WebView::zoomLevelToZoomFactor(GetZoomLevel()); } +void WebFrame::SetZoomLevelLimits(double min_level, double max_level) { + web_frame_->view()->setDefaultPageScaleLimits(min_level, max_level); +} + v8::Local WebFrame::RegisterEmbedderCustomElement( const base::string16& name, v8::Local options) { blink::WebExceptionCode c = 0; @@ -102,6 +106,7 @@ mate::ObjectTemplateBuilder WebFrame::GetObjectTemplateBuilder( .SetMethod("getZoomLevel", &WebFrame::GetZoomLevel) .SetMethod("setZoomFactor", &WebFrame::SetZoomFactor) .SetMethod("getZoomFactor", &WebFrame::GetZoomFactor) + .SetMethod("setZoomLevelLimits", &WebFrame::SetZoomLevelLimits) .SetMethod("registerEmbedderCustomElement", &WebFrame::RegisterEmbedderCustomElement) .SetMethod("registerElementResizeCallback", diff --git a/atom/renderer/api/atom_api_web_frame.h b/atom/renderer/api/atom_api_web_frame.h index 26b8178e98ab..f3895353b97c 100644 --- a/atom/renderer/api/atom_api_web_frame.h +++ b/atom/renderer/api/atom_api_web_frame.h @@ -41,6 +41,8 @@ class WebFrame : public mate::Wrappable { double SetZoomFactor(double factor); double GetZoomFactor() const; + void SetZoomLevelLimits(double min_level, double max_level); + v8::Local RegisterEmbedderCustomElement( const base::string16& name, v8::Local options); void RegisterElementResizeCallback( diff --git a/docs/api/web-frame.md b/docs/api/web-frame.md index e0b04bfe3f08..810c31a4ecdd 100644 --- a/docs/api/web-frame.md +++ b/docs/api/web-frame.md @@ -32,6 +32,13 @@ limits of 300% and 50% of original size, respectively. Returns the current zoom level. +## webFrame.setZoomLevelLimits(minimumLevel, maximumLevel) + +* `minimumLevel` Number +* `maximumLevel` Number + +Sets the maximum and minimum zoom level. + ## webFrame.setSpellCheckProvider(language, autoCorrectWord, provider) * `language` String From 16a0185ab577a0b421e45b57824cff2916ac5e35 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 27 Aug 2015 22:50:40 +0800 Subject: [PATCH 0993/1293] Opt into location services --- atom/browser/atom_access_token_store.cc | 2 ++ 1 file changed, 2 insertions(+) diff --git a/atom/browser/atom_access_token_store.cc b/atom/browser/atom_access_token_store.cc index 86ce1c215936..3d254f060188 100644 --- a/atom/browser/atom_access_token_store.cc +++ b/atom/browser/atom_access_token_store.cc @@ -9,6 +9,7 @@ #include "atom/browser/atom_browser_context.h" #include "atom/browser/atom_browser_main_parts.h" #include "atom/common/google_api_key.h" +#include "content/public/browser/geolocation_provider.h" namespace atom { @@ -24,6 +25,7 @@ const char* kGeolocationProviderUrl = } // namespace AtomAccessTokenStore::AtomAccessTokenStore() { + content::GeolocationProvider::GetInstance()->UserDidOptIntoLocationServices(); } AtomAccessTokenStore::~AtomAccessTokenStore() { From f74d7d71e6893da90a2546edf627f25fe10d5b11 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Thu, 27 Aug 2015 08:11:51 -0700 Subject: [PATCH 0994/1293] Edits per inline comments --- docs/api/content-tracing.md | 26 +++++++++++++------------- docs/api/crash-reporter.md | 4 ++-- 2 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/api/content-tracing.md b/docs/api/content-tracing.md index 3e266b385581..04ee6190a350 100644 --- a/docs/api/content-tracing.md +++ b/docs/api/content-tracing.md @@ -41,8 +41,8 @@ Once all child processes have acknowledged the `getCategories` request the Start recording on all processes. Recording begins immediately locally and asynchronously on child processes -as soon as they receive the EnableRecording request. Once all child processes -have acknowledged the `startRecording` request the `callback` will be called. +as soon as they receive the EnableRecording request. The `callback` will be +called once all child processes have acknowledged the `startRecording` request. `categoryFilter` is a filter to control what category groups should be traced. A filter can have an optional `-` prefix to exclude category groups @@ -66,11 +66,11 @@ list. Possible options are: The first 3 options are trace recoding modes and hence mutually exclusive. If more than one trace recording modes appear in the `traceOptions` string, -the last one takes precedence. If none of the trace recording modes is +the last one takes precedence. If none of the trace recording modes are specified, recording mode is `record-until-full`. -The trace option will first be reset to the default option (record_mode set to -`record-until-full`, enable_sampling and enable_systrace set to `false`) +The trace option will first be reset to the default option (`record_mode` set to +`record-until-full`, `enable_sampling` and `enable_systrace` set to `false`) before options parsed from `traceOptions` are applied on it. ### `tracing.stopRecording(resultFilePath, callback)` @@ -80,11 +80,11 @@ before options parsed from `traceOptions` are applied on it. Stop recording on all processes. -Child processes typically are caching trace data and only rarely flush and send -trace data back to the main process. That is because it may be an expensive -operation to send the trace data over IPC, and we would like to avoid runtime -overhead of tracing. So, to end tracing, we must asynchronously ask all -child processes to flush any pending trace data. +Child processes typically cache trace data and only rarely flush and send +trace data back to the main process. This helps to minimize the runtime overhead +of tracing since sending trace data over IPC can be an expensive operation. So, +to end tracing, we must asynchronously ask all child processes to flush any +pending trace data. Once all child processes have acknowledged the `stopRecording` request, `callback` will be called with a file that contains the traced data. @@ -123,7 +123,7 @@ Once all child processes have acknowledged the `stopMonitoring` request the Get the current monitoring traced data. -Child processes are typically caching trace data and only rarely flush and send +Child processes typically cache trace data and only rarely flush and send trace data back to the main process. This is because it may be an expensive operation to send the trace data over IPC and we would like to avoid unneeded runtime overhead from tracing. So, to end tracing, we must asynchronously ask @@ -152,5 +152,5 @@ process. ### `tracing.cancelWatchEvent()` -Cancel the watch event. If tracing is enabled this may race with the watch -event callback. +Cancel the watch event. This may lead to a race condition with the watch event +callback if tracing is enabled. diff --git a/docs/api/crash-reporter.md b/docs/api/crash-reporter.md index 7a898718e8ec..05cb806c0614 100644 --- a/docs/api/crash-reporter.md +++ b/docs/api/crash-reporter.md @@ -1,4 +1,4 @@ -# crash-reporter +# crashReporter The `crash-reporter` module enables sending your app's crash reports. @@ -34,7 +34,7 @@ The `crash-reporter` module has the following methods: * Only string properties are sent correctly. * Nested objects are not supported. -Developers are required to call this method before using other `crashReporter` +You are required to call this method before using other `crashReporter` APIs. **Note:** On OS X, Electron uses a new `crashpad` client, which is different From 4bc9bf76541ce6ab7e817cc27a3b75883d2cd4d3 Mon Sep 17 00:00:00 2001 From: Tim Ruffles Date: Thu, 27 Aug 2015 17:10:02 +0100 Subject: [PATCH 0995/1293] improve advice on callbacks passed from renderer to main Remote is a great feature, it's a shame to put people off unnecessarily. I think the original warnings given are too extreme The potential bugs that stem from not cleaning up event handlers (or any reference) are present in any Javascript code. We don't avoid using event-handlers in the DOM because we might forget to clean them up! I've added an example of the behaviour of return values from synchronously called callbacks from renderer, and have changed the advice from 'you shouldn't do this' to 'be careful when you do this'. --- docs/api/remote.md | 55 +++++++++++++++++++++++++++++++++++----------- 1 file changed, 42 insertions(+), 13 deletions(-) diff --git a/docs/api/remote.md b/docs/api/remote.md index eaa5f63e896a..c06920836cdb 100644 --- a/docs/api/remote.md +++ b/docs/api/remote.md @@ -52,16 +52,43 @@ Primary value types like strings and numbers, however, are sent by copy. ## Passing callbacks to the main process -Some APIs in the main process accept callbacks, and it would be tempting to -pass callbacks when calling a remote function. The `remote` module does support -doing this, but you should also be extremely careful with this. +Code in the main process can accept callbacks from the renderer - for instance the `remote` module - +but you should be extremely careful when using this feature. First, in order to avoid deadlocks, the callbacks passed to the main process -are called asynchronously, so you should not expect the main process to +are called asynchronously. You should not expect the main process to get the return value of the passed callbacks. -Second, the callbacks passed to the main process will not get released -automatically after they are called. Instead, they will persistent until the +For instance you can't use a function from the renderer process in a `Array.map` called in the main process: + +```javascript +// main process mapNumbers.js +exports.withRendererCallback = function(mapper) { + return [1,2,3].map(mapper); +} + +exports.withLocalCallback = function() { + return exports.mapNumbers(function(x) { + return x + 1; + }); +} + +// renderer process +var mapNumbers = require("remote").require("mapNumbers"); + +var withRendererCb = mapNumbers.withRendererCallback(function(x) { + return x + 1; +}) + +var withLocalCb = mapNumbers.withLocalCallback() + +console.log(withRendererCb, withLocalCb) // [true, true, true], [2, 3, 4] +``` + +As you can see, the renderer callback's synchronous return value was not as expected, +and didn't match the return value of an indentical callback that lives in the main process. + +Second, the callbacks passed to the main process will persist until the main process garbage-collects them. For example, the following code seems innocent at first glance. It installs a @@ -74,14 +101,16 @@ remote.getCurrentWindow().on('close', function() { }); ``` -The problem is that the callback would be stored in the main process until you -explicitly uninstall it! So each time you reload your window, the callback would -be installed again and previous callbacks would just leak. To make things -worse, since the context of previously installed callbacks have been released, -when the `close` event was emitted, exceptions would be raised in the main process. +But remember the callback is referenced by the main process until you +explicitly uninstall it! If you do not, each time you reload your window the callback will +be installed again, leaking one callback each restart. -Generally, unless you are clear what you are doing, you should always avoid -passing callbacks to the main process. +To make things worse, since the context of previously installed callbacks have been released, +when the `close` event was emitted exceptions would be raised in the main process. + +To avoid this problem, ensure you clean up any references to renderer callbacks passed to the main +process. This involves cleaning up event handlers, or ensuring the main process is explicitly told to deference +callbacks that came from a renderer process that is exiting. ## remote.require(module) From d02ced87b8481262f489ae4d87ff5366459ea263 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Thu, 27 Aug 2015 10:13:25 -0700 Subject: [PATCH 0996/1293] =?UTF-8?q?message=20=E2=86=92=20arg,=2080-col?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/api/ipc-main-process.md | 7 ++++--- docs/api/ipc-renderer.md | 29 ++++++++++++++++++++--------- 2 files changed, 24 insertions(+), 12 deletions(-) diff --git a/docs/api/ipc-main-process.md b/docs/api/ipc-main-process.md index 197b98e418be..c34564ef82ef 100644 --- a/docs/api/ipc-main-process.md +++ b/docs/api/ipc-main-process.md @@ -64,9 +64,10 @@ Set this to the value to be returned in a synchronous message. Returns the `WebContents` that sent the message. -### `Event.sender.send(channel[, message])` +### `Event.sender.send(channel[, arg1][, arg2][, ...])` * `channel` String - The event name. -* `message` (optional) +* `arg` (optional) -This sends an asynchronous message back to the render process. The `message` can be any value. +This sends an asynchronous message back to the render process. Optionally, there +can be one or a series of arguments, `arg`, which can have any type. diff --git a/docs/api/ipc-renderer.md b/docs/api/ipc-renderer.md index 0d7b49aba701..4a5995663884 100644 --- a/docs/api/ipc-renderer.md +++ b/docs/api/ipc-renderer.md @@ -1,7 +1,8 @@ # ipc (renderer) The `ipc` module provides a few methods so you can send synchronous and -asynchronous messages from the render process (web page) to the main process. You can also receive messages returned from the main process. +asynchronous messages from the render process (web page) to the main process. +You can also receive messages returned from the main process. **Note**: If you want to make use of modules in the main process from the renderer process, you might consider using the [remote](remote.md) module. @@ -12,30 +13,40 @@ See [ipc (main process)](ipc-main-process.md) for code examples. The `ipc` module has the following methods for sending messages: -**Note**: When using these methods to send a `message` you must also listen for it in the main process with [`ipc (main process)`](ipc-main-process.md). +**Note**: When using these methods to send a `message` you must also listen +for it in the main process with [`ipc (main process)`](ipc-main-process.md). -### `ipc.send(channel[, message])` +### `ipc.send(channel[, arg1][, arg2][, ...])` * `channel` String - The event name. * `message` (optional) -Send a `message` (any type) to the main process asynchronously via a `channel`. The main process handles it by listening for the `channel` event with `ipc`. +Send an event to the main process asynchronously via a `channel`. Optionally, +there can be a message: one or a series of arguments, `arg`, which can have any +type. The main process handles it by listening for the `channel` event with +`ipc`. -### `ipc.sendSync(channel[, message])` +### `ipc.sendSync(channel[, arg1][, arg2][, ...])` * `channel` String - The event name. * `message` (optional) -Send a `message` (any type) to the main process synchronously via a `channel`. A result is returned from the main process. +Send an event to the main process synchronously via a `channel`. Optionally, +there can be a message: one or a series of arguments, `arg`, which can have any +type. The main process handles it by listening for the `channel` event with +`ipc`. -The main process handles it by listening for the `channel` event with `ipc` and replies by setting the `event.returnValue`. +The main process handles it by listening for the `channel` event with `ipc` and +replies by setting the `event.returnValue`. **Note:** Sending a synchronous message will block the whole renderer process so using this method is not recommended. -### `ipc.sendToHost(channel[, message])` +### `ipc.sendToHost(channel[, arg1][, arg2][, ...])` * `channel` String - The event name. * `message` (optional) -Like `ipc.send` but the message will be sent to the host page in a `` instead of the main process. +Like `ipc.send` but the event will be sent to the host page in a `` +instead of the main process. Optionally, there can be a message: one or a series +of arguments, `arg`, which can have any type. From 5337d8c23f732b7c600e3fa964df699aad08809b Mon Sep 17 00:00:00 2001 From: Eran Tiktin Date: Thu, 27 Aug 2015 23:05:06 +0300 Subject: [PATCH 0997/1293] Ignore native module tests on Windows debug build This resolves #2558. There are no more errors when running test.py on the debug build in Windows. When running the release build the tests will be executed as usual. --- .gitignore | 1 + .../development/build-instructions-windows.md | 11 +++++++- spec/modules-spec.coffee | 22 +++++++++------ spec/webview-spec.coffee | 28 +++++++++++-------- 4 files changed, 40 insertions(+), 22 deletions(-) diff --git a/.gitignore b/.gitignore index 0c6f4cb79dd0..73bf6b258099 100644 --- a/.gitignore +++ b/.gitignore @@ -17,3 +17,4 @@ node_modules/ *.pyc debug.log npm-debug.log +atom/common/chrome_version.h diff --git a/docs/development/build-instructions-windows.md b/docs/development/build-instructions-windows.md index ddf551002262..840c809f09a5 100644 --- a/docs/development/build-instructions-windows.md +++ b/docs/development/build-instructions-windows.md @@ -54,7 +54,7 @@ You can also only build the Debug target: python script\build.py -c D ``` -After building is done, you can find `electron.exe` under `out\D` (debug +After building is done, you can find `electron.exe` under `out\D` (debug target) or under `out\R` (release target). ## 64bit build @@ -82,6 +82,15 @@ Test functionality using: python script\test.py ``` +Tests that include native modules (e.g. `runas`) can't be executed with the +debug build (see #2558 for details), but they will work with the release build. + +To run the tests with the release build use: + +```powershell +python script\test.py -R +``` + ## Troubleshooting ### Command xxxx not found diff --git a/spec/modules-spec.coffee b/spec/modules-spec.coffee index 545d55e7d324..e7bdac36b3e3 100644 --- a/spec/modules-spec.coffee +++ b/spec/modules-spec.coffee @@ -7,16 +7,20 @@ describe 'third-party module', -> fixtures = path.join __dirname, 'fixtures' temp.track() - describe 'runas', -> - it 'can be required in renderer', -> - require 'runas' + # If the test is executed with the debug build on Windows, we will skip it + # because native modules don't work with the debug build (see issue #2558). + if process.platform isnt 'win32' or + process.execPath.toLowerCase().indexOf('\\out\\d\\') is -1 + describe 'runas', -> + it 'can be required in renderer', -> + require 'runas' - it 'can be required in node binary', (done) -> - runas = path.join fixtures, 'module', 'runas.js' - child = require('child_process').fork runas - child.on 'message', (msg) -> - assert.equal msg, 'ok' - done() + it 'can be required in node binary', (done) -> + runas = path.join fixtures, 'module', 'runas.js' + child = require('child_process').fork runas + child.on 'message', (msg) -> + assert.equal msg, 'ok' + done() describe 'q', -> Q = require 'q' diff --git a/spec/webview-spec.coffee b/spec/webview-spec.coffee index ba3478fca557..7c2cd1a92adc 100644 --- a/spec/webview-spec.coffee +++ b/spec/webview-spec.coffee @@ -48,18 +48,22 @@ describe ' tag', -> webview.src = "file://#{fixtures}/pages/d.html" document.body.appendChild webview - it 'loads native modules when navigation happens', (done) -> - listener = (e) -> - webview.removeEventListener 'did-finish-load', listener - listener2 = (e) -> - assert.equal e.message, 'function' - done() - webview.addEventListener 'console-message', listener2 - webview.reload() - webview.addEventListener 'did-finish-load', listener - webview.setAttribute 'nodeintegration', 'on' - webview.src = "file://#{fixtures}/pages/native-module.html" - document.body.appendChild webview + # If the test is executed with the debug build on Windows, we will skip it + # because native modules don't work with the debug build (see issue #2558). + if process.platform isnt 'win32' or + process.execPath.toLowerCase().indexOf('\\out\\d\\') is -1 + it 'loads native modules when navigation happens', (done) -> + listener = (e) -> + webview.removeEventListener 'did-finish-load', listener + listener2 = (e) -> + assert.equal e.message, 'function' + done() + webview.addEventListener 'console-message', listener2 + webview.reload() + webview.addEventListener 'did-finish-load', listener + webview.setAttribute 'nodeintegration', 'on' + webview.src = "file://#{fixtures}/pages/native-module.html" + document.body.appendChild webview describe 'preload attribute', -> it 'loads the script before other scripts in window', (done) -> From c2073a3c452a97b375cf8b4f7953b64d060a734e Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Fri, 28 Aug 2015 10:34:48 -0700 Subject: [PATCH 0998/1293] Consolidate note on experimental APIs --- docs/api/clipboard.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/api/clipboard.md b/docs/api/clipboard.md index 7e113990b641..a99605baea18 100644 --- a/docs/api/clipboard.md +++ b/docs/api/clipboard.md @@ -21,6 +21,8 @@ console.log(clipboard.readText('selection')); The `clipboard` module has the following methods: +**Note:** Experimental APIs are marked as such and could be removed in future. + ### `clipboard.readText([type])` * `type` String (optional) @@ -84,8 +86,6 @@ var clipboard = require('clipboard'); console.log(clipboard.has('

selection

')); ``` -**Note:** This API is experimental and could be removed in future. - ### `clipboard.read(data[, type])` _Experimental_ * `data` String @@ -93,8 +93,6 @@ console.log(clipboard.has('

selection

')); Reads `data` from the clipboard. -**Note:** This API is experimental and could be removed in future. - ### `clipboard.write(data[, type])` * `data` Object From 221eff7fec620eb609cc6318d5512ac5ca0463c6 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Fri, 28 Aug 2015 10:50:02 -0700 Subject: [PATCH 0999/1293] :arrow_down: list level --- docs/api/crash-reporter.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/docs/api/crash-reporter.md b/docs/api/crash-reporter.md index 05cb806c0614..310c0bbc31fe 100644 --- a/docs/api/crash-reporter.md +++ b/docs/api/crash-reporter.md @@ -21,18 +21,19 @@ The `crash-reporter` module has the following methods: ### `crashReporter.start(options)` -* `options` Object, properties: - * `productName` String, default: Electron. - * `companyName` String, default: GitHub, Inc. - * `submitUrl` String, default: http://54.249.141.255:1127/post. - * URL that crash reports will be sent to as POST. - * `autoSubmit` Boolean, default: `true`. - * Send the crash report without user interaction. - * `ignoreSystemCrashHandler` Boolean, default: `false`. - * `extra` Object - * An object you can define that will be sent along with the report. - * Only string properties are sent correctly. - * Nested objects are not supported. +`options` Object, properties: + +* `productName` String, default: Electron. +* `companyName` String, default: GitHub, Inc. +* `submitUrl` String, default: http://54.249.141.255:1127/post. + * URL that crash reports will be sent to as POST. +* `autoSubmit` Boolean, default: `true`. + * Send the crash report without user interaction. +* `ignoreSystemCrashHandler` Boolean, default: `false`. +* `extra` Object + * An object you can define that will be sent along with the report. + * Only string properties are sent correctly. + * Nested objects are not supported. You are required to call this method before using other `crashReporter` APIs. From bbf2cbb6f6d31fe853ced5831515ab30edfb6354 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Fri, 28 Aug 2015 10:50:30 -0700 Subject: [PATCH 1000/1293] Small edits --- docs/api/content-tracing.md | 1 + docs/api/crash-reporter.md | 3 ++- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/api/content-tracing.md b/docs/api/content-tracing.md index 04ee6190a350..954b52efcc9e 100644 --- a/docs/api/content-tracing.md +++ b/docs/api/content-tracing.md @@ -7,6 +7,7 @@ generated file to view the result. ```javascript var tracing = require('content-tracing'); + tracing.startRecording('*', tracing.DEFAULT_OPTIONS, function() { console.log('Tracing started'); diff --git a/docs/api/crash-reporter.md b/docs/api/crash-reporter.md index 310c0bbc31fe..86670fcc90c9 100644 --- a/docs/api/crash-reporter.md +++ b/docs/api/crash-reporter.md @@ -6,7 +6,8 @@ The following is an example of automatically submitting a crash report to a remote server: ```javascript -crashReporter = require('crash-reporter'); +var crashReporter = require('crash-reporter'); + crashReporter.start({ productName: 'YourName', companyName: 'YourCompany', From aa03fddb623adc893257293e01519aed2911cb91 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Fri, 28 Aug 2015 10:57:20 -0700 Subject: [PATCH 1001/1293] =?UTF-8?q?contentTracing=20=E2=86=92=20tracing?= =?UTF-8?q?=20=E2=86=92=20content-tracing?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/api/content-tracing.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/api/content-tracing.md b/docs/api/content-tracing.md index 954b52efcc9e..7d36fe9f5dd3 100644 --- a/docs/api/content-tracing.md +++ b/docs/api/content-tracing.md @@ -1,4 +1,4 @@ -# content-tracing +# contentTracing The `content-tracing` module is used to collect tracing data generated by the underlying Chromium content module. This module does not include a web interface @@ -6,7 +6,7 @@ so you need to open `chrome://tracing/` in a Chrome browser and load the generated file to view the result. ```javascript -var tracing = require('content-tracing'); +var contentTracing = require('content-tracing'); tracing.startRecording('*', tracing.DEFAULT_OPTIONS, function() { console.log('Tracing started'); @@ -23,7 +23,7 @@ tracing.startRecording('*', tracing.DEFAULT_OPTIONS, function() { The `content-tracing` module has the following methods: -### `tracing.getCategories(callback)` +### `contentTracing.getCategories(callback)` * `callback` Function @@ -33,7 +33,7 @@ are reached. Once all child processes have acknowledged the `getCategories` request the `callback` is invoked with an array of category groups. -### `tracing.startRecording(categoryFilter, traceOptions, callback)` +### `contentTracing.startRecording(categoryFilter, traceOptions, callback)` * `categoryFilter` String * `traceOptions` String @@ -74,7 +74,7 @@ The trace option will first be reset to the default option (`record_mode` set to `record-until-full`, `enable_sampling` and `enable_systrace` set to `false`) before options parsed from `traceOptions` are applied on it. -### `tracing.stopRecording(resultFilePath, callback)` +### `contentTracing.stopRecording(resultFilePath, callback)` * `resultFilePath` String * `callback` Function @@ -94,7 +94,7 @@ Trace data will be written into `resultFilePath` if it is not empty or into a temporary file. The actual file path will be passed to `callback` if it's not `null`. -### `tracing.startMonitoring(categoryFilter, traceOptions, callback)` +### `contentTracing.startMonitoring(categoryFilter, traceOptions, callback)` * `categoryFilter` String * `traceOptions` String @@ -108,7 +108,7 @@ soon as they receive the `startMonitoring` request. Once all child processes have acknowledged the `startMonitoring` request the `callback` will be called. -### `tracing.stopMonitoring(callback)` +### `contentTracing.stopMonitoring(callback)` * `callback` Function @@ -117,7 +117,7 @@ Stop monitoring on all processes. Once all child processes have acknowledged the `stopMonitoring` request the `callback` is called. -### `tracing.captureMonitoringSnapshot(resultFilePath, callback)` +### `contentTracing.captureMonitoringSnapshot(resultFilePath, callback)` * `resultFilePath` String * `callback` Function @@ -134,7 +134,7 @@ Once all child processes have acknowledged the `captureMonitoringSnapshot` request the `callback` will be called with a file that contains the traced data. -### `tracing.getTraceBufferUsage(callback)` +### `contentTracing.getTraceBufferUsage(callback)` * `callback` Function @@ -142,7 +142,7 @@ Get the maximum usage across processes of trace buffer as a percentage of the full state. When the TraceBufferUsage value is determined the `callback` is called. -### `tracing.setWatchEvent(categoryName, eventName, callback)` +### `contentTracing.setWatchEvent(categoryName, eventName, callback)` * `categoryName` String * `eventName` String @@ -151,7 +151,7 @@ called. `callback` will will be called every time the given event occurs on any process. -### `tracing.cancelWatchEvent()` +### `contentTracing.cancelWatchEvent()` Cancel the watch event. This may lead to a race condition with the watch event callback if tracing is enabled. From 852d982057bb3858c7373512c22ecdfddd6a354b Mon Sep 17 00:00:00 2001 From: fscherwi Date: Fri, 28 Aug 2015 22:04:42 +0200 Subject: [PATCH 1002/1293] :arrow_up: asar@0.8.x --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 2ccaa24d3c0e..101fdeee257a 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "electron", "devDependencies": { - "asar": "0.7.x", + "asar": "0.8.x", "coffee-script": "^1.9.2", "coffeelint": "^1.9.4", "request": "*", From dd28a2ef146343c96878d8957c0bf58697c3b3d1 Mon Sep 17 00:00:00 2001 From: Brandon Nozaki Miller Date: Fri, 28 Aug 2015 14:16:05 -0700 Subject: [PATCH 1003/1293] Update documentation to clarify bundled node/io.js version --- docs/tutorial/using-native-node-modules.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/tutorial/using-native-node-modules.md b/docs/tutorial/using-native-node-modules.md index 6b9631296f4c..918c8a67a94a 100644 --- a/docs/tutorial/using-native-node-modules.md +++ b/docs/tutorial/using-native-node-modules.md @@ -7,14 +7,14 @@ the location of Electron's headers when building native modules. ## Native Node module compatibility Since Node v0.11.x there were vital changes in the V8 API. So generally all -native modules written for Node v0.10.x wouldn't work for Node v0.11.x. And -because Electron internally uses Node v0.11.13, it carries with the same +native modules written for Node v0.10.x wouldn't work for newer Node or io.js versions. And +because Electron internally uses __io.js v3.1.0__, it carries with the same problem. -To solve this, you should use modules that support Node v0.11.x, +To solve this, you should use modules that support Node v0.11.x or later, [many modules](https://www.npmjs.org/browse/depended/nan) do support both now. For old modules that only support Node v0.10.x, you should use the -[nan](https://github.com/rvagg/nan) module to port it to v0.11.x. +[nan](https://github.com/rvagg/nan) module to port it to v0.11.x or later versions of Node or io.js. ## How to install native modules From dbc1855b42a4aaeeb2bc5d35f3e3f9cd179509da Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Fri, 28 Aug 2015 14:21:37 -0700 Subject: [PATCH 1004/1293] Small edits --- docs/api/global-shortcut.md | 5 +++-- docs/api/ipc-main-process.md | 11 +++++++---- docs/api/ipc-renderer.md | 2 +- 3 files changed, 11 insertions(+), 7 deletions(-) diff --git a/docs/api/global-shortcut.md b/docs/api/global-shortcut.md index 52ec17326c63..f9ca654cf50a 100644 --- a/docs/api/global-shortcut.md +++ b/docs/api/global-shortcut.md @@ -4,7 +4,7 @@ The `global-shortcut` module can register/unregister a global keyboard shortcut with the operating system so that you can customize the operations for various shortcuts. -Note that the shortcut is global; it will work even if the app does +**Note**: The shortcut is global; it will work even if the app does not have the keyboard focus. You should not use this module until the `ready` event of the app module is emitted. @@ -51,7 +51,8 @@ the registered shortcut is pressed by the user. * `accelerator` [Accelerator](accelerator.md) -Returns `true` or `false` depending on whether the shortcut `accelerator` is registered. +Returns `true` or `false` depending on whether the shortcut `accelerator` is +registered. ### `globalShortcut.unregister(accelerator)` diff --git a/docs/api/ipc-main-process.md b/docs/api/ipc-main-process.md index c34564ef82ef..bbb581fcfc9b 100644 --- a/docs/api/ipc-main-process.md +++ b/docs/api/ipc-main-process.md @@ -1,6 +1,8 @@ # ipc (main process) -The `ipc` module, when used in the main process, handles asynchronous and synchronous messages sent from a renderer process (web page). Messages sent from a renderer will be emitted to this module. +The `ipc` module, when used in the main process, handles asynchronous and +synchronous messages sent from a renderer process (web page). Messages sent from +a renderer will be emitted to this module. ## Sending Messages @@ -10,7 +12,8 @@ for more information. - When sending a message, the event name is the `channel`. - To reply a synchronous message, you need to set `event.returnValue`. -- To send an asynchronous back to the sender, you can use `event.sender.send(...)`. +- To send an asynchronous back to the sender, you can use + `event.sender.send(...)`. An example of sending and handling messages between the render and main processes: @@ -40,9 +43,9 @@ ipc.on('asynchronous-reply', function(arg) { ipc.send('asynchronous-message', 'ping'); ``` -## Methods +## Listening for Messages -The `ipc` module has the following method: +The `ipc` module has the following method to listen for events: ### `ipc.on(channel, callback)` diff --git a/docs/api/ipc-renderer.md b/docs/api/ipc-renderer.md index 4a5995663884..12cd11aec777 100644 --- a/docs/api/ipc-renderer.md +++ b/docs/api/ipc-renderer.md @@ -2,7 +2,7 @@ The `ipc` module provides a few methods so you can send synchronous and asynchronous messages from the render process (web page) to the main process. -You can also receive messages returned from the main process. +You can also receive replies from the main process. **Note**: If you want to make use of modules in the main process from the renderer process, you might consider using the [remote](remote.md) module. From 8ee91bce44798a64fe969c7b5f1ba4d6e230c373 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Fri, 28 Aug 2015 14:57:14 -0700 Subject: [PATCH 1005/1293] =?UTF-8?q?message=20=E2=86=92=20arg?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/api/ipc-renderer.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/api/ipc-renderer.md b/docs/api/ipc-renderer.md index 12cd11aec777..3adb0bc95476 100644 --- a/docs/api/ipc-renderer.md +++ b/docs/api/ipc-renderer.md @@ -19,7 +19,7 @@ for it in the main process with [`ipc (main process)`](ipc-main-process.md). ### `ipc.send(channel[, arg1][, arg2][, ...])` * `channel` String - The event name. -* `message` (optional) +* `arg` (optional) Send an event to the main process asynchronously via a `channel`. Optionally, there can be a message: one or a series of arguments, `arg`, which can have any @@ -29,7 +29,7 @@ type. The main process handles it by listening for the `channel` event with ### `ipc.sendSync(channel[, arg1][, arg2][, ...])` * `channel` String - The event name. -* `message` (optional) +* `arg` (optional) Send an event to the main process synchronously via a `channel`. Optionally, there can be a message: one or a series of arguments, `arg`, which can have any @@ -45,7 +45,7 @@ using this method is not recommended. ### `ipc.sendToHost(channel[, arg1][, arg2][, ...])` * `channel` String - The event name. -* `message` (optional) +* `arg` (optional) Like `ipc.send` but the event will be sent to the host page in a `` instead of the main process. Optionally, there can be a message: one or a series From 58081ca9e9faee876f9f47ac72856da6a9bbe1d2 Mon Sep 17 00:00:00 2001 From: gellert Date: Sat, 29 Aug 2015 00:45:00 +0200 Subject: [PATCH 1006/1293] setOffscreenRender and api docs added --- atom/browser/api/atom_api_window.cc | 5 ++++ atom/browser/api/atom_api_window.h | 1 + atom/browser/native_window.cc | 45 ++++++++++++++++++++--------- atom/browser/native_window.h | 17 +++++++---- docs/api/browser-window.md | 16 ++++++++++ 5 files changed, 65 insertions(+), 19 deletions(-) diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index c19cf6f7d945..df14e2317620 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -440,6 +440,10 @@ void Window::CapturePage(mate::Arguments* args) { rect, base::Bind(&OnCapturePageDone, args->isolate(), callback)); } +void Window::SetOffscreenRender(bool isOffscreen) { + window_->SetOffscreenRender(isOffscreen); +} + void Window::SetProgressBar(double progress) { window_->SetProgressBar(progress); } @@ -602,6 +606,7 @@ void Window::BuildPrototype(v8::Isolate* isolate, #if defined(OS_MACOSX) .SetMethod("showDefinitionForSelection", &Window::ShowDefinitionForSelection) + .SetMethod("setOffscreenRender", &Window::SetOffscreenRender) #endif .SetProperty("id", &Window::ID, true) .SetProperty("webContents", &Window::WebContents, true) diff --git a/atom/browser/api/atom_api_window.h b/atom/browser/api/atom_api_window.h index 925aa6749714..8163ecbdd975 100644 --- a/atom/browser/api/atom_api_window.h +++ b/atom/browser/api/atom_api_window.h @@ -138,6 +138,7 @@ class Window : public mate::TrackableObject, void SetMenuBarVisibility(bool visible); bool IsMenuBarVisible(); void SetAspectRatio(double aspect_ratio, mate::Arguments* args); + void SetOffscreenRender(bool isOffscreen); #if defined(OS_MACOSX) void ShowDefinitionForSelection(); diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index b21d04aa2389..fc911d00a079 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -330,6 +330,29 @@ void NativeWindow::CapturePage(const gfx::Rect& rect, kBGRA_8888_SkColorType); } +void NativeWindow::SetOffscreenRender(bool isOffscreen) { + if (!isOffscreen && !offscreen_) return; + + const auto view = web_contents()->GetRenderWidgetHostView(); + + if (view) { + if (isOffscreen) { + scoped_ptr subscriber( + new RenderSubscriber( + view->GetVisibleViewportSize(), + base::Bind(&NativeWindow::OnFrameReceived, base::Unretained(this)) + ) + ); + + view->BeginFrameSubscription(subscriber.Pass()); + } else { + view->EndFrameSubscription(); + } + + offscreen_ = isOffscreen; + } +} + void NativeWindow::RequestToClosePage() { bool prevent_default = false; FOR_EACH_OBSERVER(NativeWindowObserver, @@ -548,15 +571,7 @@ void NativeWindow::DevToolsClosed() { } void NativeWindow::RenderViewReady(){ - if(offscreen_){ - const auto view = web_contents()->GetRenderWidgetHostView(); - - scoped_ptr subscriber(new RenderSubscriber( - view->GetVisibleViewportSize(), base::Bind(&NativeWindow::OnFrameReceived, base::Unretained(this)) - )); - - view->BeginFrameSubscription(subscriber.Pass()); - } + SetOffscreenRender(offscreen_); } void NativeWindow::RenderViewCreated( @@ -636,11 +651,12 @@ void NativeWindow::OnCapturePageDone(const CapturePageCallback& callback, callback.Run(bitmap); } -void NativeWindow::OnFrameReceived(bool result, scoped_refptr frame) { - if(result){ +void NativeWindow::OnFrameReceived(bool result, + scoped_refptr frame) { + if (result) { gfx::Rect rect = frame->visible_rect(); - const int rgb_arr_size = rect.width()*rect.height()*4; + const int rgb_arr_size = rect.width() * rect.height() * 4; scoped_ptr rgb_bytes(new uint8[rgb_arr_size]); // Convert a frame of YUV to 32 bit ARGB. @@ -651,7 +667,7 @@ void NativeWindow::OnFrameReceived(bool result, scoped_refptr rect.width(), rect.height(), frame->stride(media::VideoFrame::kYPlane), frame->stride(media::VideoFrame::kUVPlane), - rect.width()*4, + rect.width() * 4, media::YV12); FOR_EACH_OBSERVER(NativeWindowObserver, @@ -660,7 +676,8 @@ void NativeWindow::OnFrameReceived(bool result, scoped_refptr } } -bool RenderSubscriber::ShouldCaptureFrame(const gfx::Rect& damage_rect, +bool RenderSubscriber::ShouldCaptureFrame( + const gfx::Rect& damage_rect, base::TimeTicks present_time, scoped_refptr* storage, DeliverFrameCallback* callback) { diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index 793bd614c8d8..a07e7d641ba7 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -162,6 +162,9 @@ class NativeWindow : public content::WebContentsObserver, virtual void CapturePage(const gfx::Rect& rect, const CapturePageCallback& callback); + // Offscreen render + virtual void SetOffscreenRender(bool isOffscreen); + // Show popup dictionary. virtual void ShowDefinitionForSelection(); @@ -326,7 +329,10 @@ class NativeWindow : public content::WebContentsObserver, class RenderSubscriber : public content::RenderWidgetHostViewFrameSubscriber { public: - RenderSubscriber(gfx::Size size, base::Callback)> callback) : size_(size), callback_(callback) {} + RenderSubscriber( + gfx::Size size, + base::Callback)> callback) + : size_(size), callback_(callback) { } bool ShouldCaptureFrame(const gfx::Rect& damage_rect, base::TimeTicks present_time, @@ -335,10 +341,11 @@ class RenderSubscriber : public content::RenderWidgetHostViewFrameSubscriber { base::TimeTicks last_present_time() const { return last_present_time_; } - static void CallbackMethod(base::Callback)> callback, - scoped_refptr frame, - base::TimeTicks present_time, - bool success) { + static void CallbackMethod( + base::Callback)> callback, + scoped_refptr frame, + base::TimeTicks present_time, + bool success) { callback.Run(success, frame); } diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 612b3ce4f3f0..f0b8abc2792f 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -74,6 +74,8 @@ You can also create a window without chrome by using Linux. * `standard-window` Boolean - Uses the OS X's standard window instead of the textured window. Defaults to `true`. + * `offscreen-render` Boolean - The frame of the window will be accessible + through the `frame-rendered` event in a buffer. Defaults to `false`. * `web-preferences` Object - Settings of web page's features * `javascript` Boolean * `web-security` Boolean - When setting `false`, it will disable the same-origin @@ -226,6 +228,15 @@ Emitted when devtools is closed. Emitted when devtools is focused / opened. +### Event: 'frame-rendered' + +* `event` Event +* `frame` Buffer +* `size` Number + +Emitted when *offscreen render* is enabled, the current frame's pixel data +and size are available. + ### Event: 'app-command': Emitted when an [App Command](https://msdn.microsoft.com/en-us/library/windows/desktop/ms646275(v=vs.85).aspx) is invoked. These are typically related to keyboard media keys or browser commands, as well as the "Back" button built into some mice on Windows. @@ -721,6 +732,11 @@ Returns whether the window is visible on all workspaces. **Note:** This API always returns false on Windows. +### BrowserWindow.setOffscreenRender(isOffscreen) + +Sets the offscreen rendering, if `true` the `frame-rendered` event will fire, +when the frame changes. + ## Class: WebContents A `WebContents` is responsible for rendering and controlling a web page. From 33a19f9071b8d7a76cd583545451bc2f6815c135 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Fri, 28 Aug 2015 16:19:28 -0700 Subject: [PATCH 1007/1293] Edits and standardization --- docs/api/menu-item.md | 9 +++- docs/api/menu.md | 95 +++++++++++++++++++++++-------------------- 2 files changed, 60 insertions(+), 44 deletions(-) diff --git a/docs/api/menu-item.md b/docs/api/menu-item.md index 360a48ab98e0..88535ad93e30 100644 --- a/docs/api/menu-item.md +++ b/docs/api/menu-item.md @@ -1,7 +1,14 @@ -# menu-item +# menuItem + +The `menu-item` module allows you to add items to an application or content +[`menu`](menu.md). + +See [`menu`](menu.md) for examples. ## Class: MenuItem +Create a new `MenuItem` with the following method: + ### new MenuItem(options) * `options` Object diff --git a/docs/api/menu.md b/docs/api/menu.md index 06400d116917..b6a0c75571cc 100644 --- a/docs/api/menu.md +++ b/docs/api/menu.md @@ -1,12 +1,17 @@ # menu -The `Menu` class is used to create native menus that can be used as -application menus and context menus. Each menu consists of multiple menu -items, and each menu item can have a submenu. +The `menu` class is used to create native menus that can be used as +application menus and +[context menus](https://developer.mozilla.org/en-US/docs/Mozilla/Tech/XUL/PopupGuide/ContextMenus). +This module is a main process module which can be used in a render process via +the `remote` module. -Below is an example of creating a menu dynamically in a web page by using -the [remote](remote.md) module, and showing it when the user right clicks -the page: +Each menu consists of multiple [menu items](menu-item.md) and each menu item can +have a submenu. + +Below is an example of creating a menu dynamically in a web page +(render process) by using the [remote](remote.md) module, and showing it when +the user right clicks the page: ```html @@ -27,9 +32,11 @@ window.addEventListener('contextmenu', function (e) { ``` -Another example of creating the application menu with the simple template API: +An example of creating the application menu in the render process with the +simple template API: -**Note to Window and Linux users** the `selector` member of each menu item is a Mac-only [Accelerator option](https://github.com/atom/electron/blob/master/docs/api/accelerator.md). +**Note to Window and Linux users** the `selector` member of each menu item is a +Mac-only [Accelerator option](https://github.com/atom/electron/blob/master/docs/api/accelerator.md). ```html @@ -167,102 +174,104 @@ Menu.setApplicationMenu(menu); ## Class: Menu -### new Menu() +### `new Menu()` Creates a new menu. -### Class Method: Menu.setApplicationMenu(menu) +## Methods + +The `menu` class has the following methods: + +### `Menu.setApplicationMenu(menu)` * `menu` Menu Sets `menu` as the application menu on OS X. On Windows and Linux, the `menu` will be set as each window's top menu. -### Class Method: Menu.sendActionToFirstResponder(action) +### `Menu.sendActionToFirstResponder(action)` _OS X_ * `action` String -Sends the `action` to the first responder of application, this is used for +Sends the `action` to the first responder of application. This is used for emulating default Cocoa menu behaviors, usually you would just use the `selector` property of `MenuItem`. -**Note:** This method is OS X only. - -### Class Method: Menu.buildFromTemplate(template) +### `Menu.buildFromTemplate(template)` * `template` Array -Generally, the `template` is just an array of `options` for constructing -[MenuItem](menu-item.md), the usage can be referenced above. +Generally, the `template` is just an array of `options` for constructing a +[MenuItem](menu-item.md). The usage can be referenced above. -You can also attach other fields to element of the `template`, and they will -become properties of the constructed menu items. +You can also attach other fields to the element of the `template` and they +will become properties of the constructed menu items. -### Menu.popup(browserWindow, [x, y]) +### `Menu.popup(browserWindow[, x, y])` * `browserWindow` BrowserWindow -* `x` Number -* `y` Number +* `x` Number (optional) +* `y` Number (optional) -Popups this menu as a context menu in the `browserWindow`. You can optionally -provide a `(x,y)` coordinate to place the menu at, otherwise it will be placed -at the current mouse cursor position. +Pops up this menu as a context menu in the `browserWindow`. You +can optionally provide a `x,y` coordinate to place the menu at, otherwise it +will be placed at the current mouse cursor position. -### Menu.append(menuItem) +### `Menu.append(menuItem)` * `menuItem` MenuItem Appends the `menuItem` to the menu. -### Menu.insert(pos, menuItem) +### `Menu.insert(pos, menuItem)` * `pos` Integer * `menuItem` MenuItem Inserts the `menuItem` to the `pos` position of the menu. -### Menu.items +### `Menu.items()` -Get the array containing the menu's items. +Get an array containing the menu's items. -## Notes on OS X application menu +## Notes on OS X Application Menu OS X has a completely different style of application menu from Windows and -Linux, and here are some notes on making your app's menu more native-like. +Linux, here are some notes on making your app's menu more native-like. -### Standard menus +### Standard Menus On OS X there are many system defined standard menus, like the `Services` and `Windows` menus. To make your menu a standard menu, you can just set your menu's -label to one of followings, and Electron will recognize them and make them +label to one of following and Electron will recognize them and make them become standard menus: * `Window` * `Help` * `Services` -### Standard menu item actions +### Standard Menu Item Actions OS X has provided standard actions for some menu items (which are called `selector`s), like `About xxx`, `Hide xxx`, and `Hide Others`. To set the action of a menu item to a standard action, you can set the `selector` attribute of the menu item. -### Main menu's name +### Main Menu's Name On OS X the label of application menu's first item is always your app's name, no matter what label you set. To change it you have to change your app's name by modifying your app bundle's `Info.plist` file. See [About Information Property List Files](https://developer.apple.com/library/ios/documentation/general/Reference/InfoPlistKeyReference/Articles/AboutInformationPropertyListFiles.html) -for more. +for more information. -## Menu item position +## Menu Item Position -You can make use of `position` and `id` to control how the item would be placed +You can make use of `position` and `id` to control how the item will be placed when building a menu with `Menu.buildFromTemplate`. -The `position` attribute of `MenuItem` has the form `[placement]=[id]` where +The `position` attribute of `MenuItem` has the form `[placement]=[id]`, where placement is one of `before`, `after`, or `endof` and `id` is the unique ID of an existing item in the menu: @@ -272,12 +281,12 @@ an existing item in the menu: * `after` - Inserts this item after id referenced item. If the referenced item doesn't exist the item will be inserted at the end of the menu. * `endof` - Inserts this item at the end of the logical group containing - the id referenced item. (Groups are created by separator items). If - the referenced item doesn't exist a new separator group is created with + the id referenced item (groups are created by separator items). If + the referenced item doesn't exist, a new separator group is created with the given id and this item is inserted after that separator. -When an item is positioned following unpositioned items are inserted after -it, until a new item is positioned. So if you want to position a group of +When an item is positioned, all un-positioned items are inserted after +it until a new item is positioned. So if you want to position a group of menu items in the same location you only need to specify a position for the first item. From e8461b6f90b71e0d527bea493f702616de07e893 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Fri, 28 Aug 2015 16:35:22 -0700 Subject: [PATCH 1008/1293] Capital Ms --- docs/api/menu-item.md | 2 +- docs/api/menu.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/menu-item.md b/docs/api/menu-item.md index 88535ad93e30..71b69b850a69 100644 --- a/docs/api/menu-item.md +++ b/docs/api/menu-item.md @@ -1,4 +1,4 @@ -# menuItem +# MenuItem The `menu-item` module allows you to add items to an application or content [`menu`](menu.md). diff --git a/docs/api/menu.md b/docs/api/menu.md index b6a0c75571cc..eaa486390fd9 100644 --- a/docs/api/menu.md +++ b/docs/api/menu.md @@ -1,4 +1,4 @@ -# menu +# Menu The `menu` class is used to create native menus that can be used as application menus and From a38d34d368aad6313acb28ee8f3f0edd9ffabea3 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Fri, 28 Aug 2015 21:33:45 -0700 Subject: [PATCH 1009/1293] Standardize native-image --- docs/api/native-image.md | 70 ++++++++++++++++++++++------------------ 1 file changed, 39 insertions(+), 31 deletions(-) diff --git a/docs/api/native-image.md b/docs/api/native-image.md index 4d4fb4bbf5be..03b1a309113e 100644 --- a/docs/api/native-image.md +++ b/docs/api/native-image.md @@ -1,17 +1,17 @@ # NativeImage -In Electron for the APIs that take images, you can pass either file paths or -`NativeImage` instances. When passing `null`, an empty image will be used. +In Electron, for the APIs that take images, you can pass either file paths or +`NativeImage` instances. An empty image will be used when `null` is passed. -For example, when creating a tray or setting a window's icon, you can pass an image -file path as a `String`: +For example, when creating a tray or setting a window's icon, you can pass an +image file path as a `String`: ```javascript var appIcon = new Tray('/Users/somebody/images/icon.png'); var window = new BrowserWindow({icon: '/Users/somebody/images/window.png'}); ``` -Or read the image from the clipboard: +Or read the image from the clipboard which returns a `NativeImage`: ```javascript var clipboard = require('clipboard'); @@ -31,7 +31,7 @@ On Windows, you can also load `ICO` icon from a file path. On platforms that have high-DPI support, you can append `@2x` after image's file name's base name to mark it as a high resolution image. -For example if `icon.png` is a normal image that has standard resolution, the +For example if `icon.png` is a normal image that has standard resolution, then `icon@2x.png` would be treated as a high resolution image that has double DPI density. @@ -65,7 +65,7 @@ Following suffixes as DPI denses are also supported: * `@4x` * `@5x` -## Template image +## Template Image Template images consist of black and clear colors (and an alpha channel). Template images are not intended to be used as standalone images and are usually @@ -74,72 +74,80 @@ mixed with other content to create the desired final appearance. The most common case is to use template image for menu bar icon so it can adapt to both light and dark menu bars. -Template image is only supported on Mac. +Template image is only supported on OS X. -To mark an image as template image, its filename should end with the word +To mark an image as a template image, its filename should end with the word `Template`, examples are: * `xxxTemplate.png` * `xxxTemplate@2x.png` -## nativeImage.createEmpty() +## Methods + +The `NativeImage` class has the following methods: + +### `NativeImage.createEmpty()` Creates an empty `NativeImage` instance. -## nativeImage.createFromPath(path) +### `NativeImage.createFromPath(path)` * `path` String Creates a new `NativeImage` instance from a file located at `path`. -## nativeImage.createFromBuffer(buffer[, scaleFactor]) +### `NativeImage.createFromBuffer(buffer[, scaleFactor])` * `buffer` [Buffer][buffer] -* `scaleFactor` Double +* `scaleFactor` Double (optional) -Creates a new `NativeImage` instance from `buffer`. The `scaleFactor` is 1.0 by -default. +Creates a new `NativeImage` instance from `buffer`. The default `scaleFactor` is +1.0. -## nativeImage.createFromDataUrl(dataUrl) +### `NativeImage.createFromDataUrl(dataUrl)` * `dataUrl` String Creates a new `NativeImage` instance from `dataUrl`. -## Class: NativeImage +## Instance Methods -This class is used to represent an image. +The following methods are available on instances of `nativeImage` -### NativeImage.toPng() +```javascript +var image = nativeImage.createFromPath('/Users/somebody/images/icon.png') +``` -Returns a [Buffer][buffer] that contains image's `PNG` encoded data. +### `image.toPng()` -### NativeImage.toJpeg(quality) +Returns a [Buffer][buffer] that contains the image's `PNG` encoded data. -* `quality` Integer between 0 - 100 (required) +### `image.toJpeg(quality)` -Returns a [Buffer][buffer] that contains image's `JPEG` encoded data. +* `quality` Integer between 0 - 100 (**required**) -### NativeImage.toDataUrl() +Returns a [Buffer][buffer] that contains the image's `JPEG` encoded data. -Returns the data URL of image. +### `image.toDataUrl()` -### NativeImage.isEmpty() +Returns the data URL of the image. -Returns whether the image is empty. +### `image.isEmpty()` -### NativeImage.getSize() +Returns a boolean whether the image is empty. + +### `image.getSize()` Returns the size of the image. [buffer]: https://iojs.org/api/buffer.html#buffer_class_buffer -### NativeImage.setTemplateImage(option) +### `image.setTemplateImage(option)` * `option` Boolean Marks the image as template image. -### NativeImage.isTemplateImage() +### `image.isTemplateImage()` -Returns whether the image is a template image. +Returns a boolean whether the image is a template image. From 83aa9df1ee70b88e63e1e5bb474fd65f6196d5dc Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Fri, 28 Aug 2015 21:37:07 -0700 Subject: [PATCH 1010/1293] Standardize power-monitor --- docs/api/power-monitor.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/docs/api/power-monitor.md b/docs/api/power-monitor.md index 4643110f35bb..c9a33cc1a128 100644 --- a/docs/api/power-monitor.md +++ b/docs/api/power-monitor.md @@ -1,10 +1,10 @@ # power-monitor -The `power-monitor` module is used to monitor the power state change. You can -only use it on the main process. You should not use this module until the `ready` -event of `app` module gets emitted. +The `power-monitor` module is used to monitor power state changes. You can +only use it on the main process. You should not use this module until the `ready` +event of the `app` module is emitted. -An example is: +For example: ```javascript var app = require('app'); @@ -16,18 +16,22 @@ app.on('ready', function() { }); ``` -## Event: suspend +## Events + +The `power-monitor` module emits the following events: + +### Event: 'suspend' Emitted when the system is suspending. -## Event: resume +### Event: 'resume' Emitted when system is resuming. -## Event: on-ac +### Event: 'on-ac' Emitted when the system changes to AC power. -## Event: on-battery +### Event: 'on-battery' Emitted when system changes to battery power. From 91150839be96fbcad156de4f9757d41bc1da07ba Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Fri, 28 Aug 2015 21:44:13 -0700 Subject: [PATCH 1011/1293] Standardize power-save-blocker --- docs/api/power-save-blocker.md | 44 +++++++++++++++++++--------------- 1 file changed, 25 insertions(+), 19 deletions(-) diff --git a/docs/api/power-save-blocker.md b/docs/api/power-save-blocker.md index 23b1252c6789..451dde105da8 100644 --- a/docs/api/power-save-blocker.md +++ b/docs/api/power-save-blocker.md @@ -1,9 +1,10 @@ -# power-save-blocker +# powerSaveBlocker The `power-save-blocker` module is used to block the system from entering -low-power(sleep) mode, allowing app to keep system and screen active. +low-power (sleep) mode thus allowing the app to keep the system and screen +active. -An example is: +For example: ```javascript var powerSaveBlocker = require('power-save-blocker'); @@ -14,35 +15,40 @@ console.log(powerSaveBlocker.isStarted(id)); powerSaveBlocker.stop(id); ``` -## powerSaveBlocker.start(type) +## Methods -* `type` String - Power save blocker type +The `powerSaveBlocker` module has the following methods: + +### `powerSaveBlocker.start(type)` + +* `type` String - Power save blocker type. * `prevent-app-suspension` - Prevent the application from being suspended. - Keeps system active, but allows screen to be turned off. Example use cases: - downloading a file, playing audio. - * `prevent-display-sleep`- Prevent the display from going to sleep. Keeps system - and screen active. Example use case: playing video. + Keeps system active but allows screen to be turned off. Example use cases: + downloading a file or playing audio. + * `prevent-display-sleep`- Prevent the display from going to sleep. Keeps + system and screen active. Example use case: playing video. -Starts the power save blocker preventing the system entering lower-power mode. -Returns an integer identified the power save blocker. +Starts the power save blocker preventing the system from entering lower-power +mode. Returns an integer identifying the power save blocker. -**Note:** -`prevent-display-sleep` has higher precedence level than `prevent-app-suspension`. -Only the highest precedence type takes effect. In other words, `prevent-display-sleep` -always take precedence over `prevent-app-suspension`. +**Note:** `prevent-display-sleep` has higher has precedence over +`prevent-app-suspension`. Only the highest precedence type takes effect. In +other words, `prevent-display-sleep` always take precedence over +`prevent-app-suspension`. For example, an API calling A requests for `prevent-app-suspension`, and another calling B requests for `prevent-display-sleep`. `prevent-display-sleep` -will be used until B stops its request. After that, `prevent-app-suspension` is used. +will be used until B stops its request. After that, `prevent-app-suspension` +is used. -## powerSaveBlocker.stop(id) +### `powerSaveBlocker.stop(id)` * `id` Integer - The power save blocker id returned by `powerSaveBlocker.start`. Stops the specified power save blocker. -## powerSaveBlocker.isStarted(id) +### `powerSaveBlocker.isStarted(id)` * `id` Integer - The power save blocker id returned by `powerSaveBlocker.start`. -Returns whether the corresponding `powerSaveBlocker` starts. +Returns a boolean whether the corresponding `powerSaveBlocker` has started. From a5969fd0764db21ee4f7589d0a09a1ccb7343744 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Fri, 28 Aug 2015 21:47:31 -0700 Subject: [PATCH 1012/1293] Standardize process --- docs/api/process.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/api/process.md b/docs/api/process.md index c9efa22fe0f9..15a1cca19f08 100644 --- a/docs/api/process.md +++ b/docs/api/process.md @@ -1,13 +1,18 @@ -# Process object +# Process The `process` object in Electron has the following differences from the one in upstream node: -* `process.type` String - Process's type, can be `browser` (i.e. main process) or `renderer`. +* `process.type` String - Process's type, can be `browser` (i.e. main process) + or `renderer`. * `process.versions['electron']` String - Version of Electron. * `process.versions['chrome']` String - Version of Chromium. * `process.resourcesPath` String - Path to JavaScript source code. -## process.hang +# Methods + +The `process` object has the following method: + +### `process.hang` Causes the main thread of the current process hang. From b7599992724951a37b844f168a802008bb834229 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Fri, 28 Aug 2015 22:03:39 -0700 Subject: [PATCH 1013/1293] Standardize protocol --- docs/api/protocol.md | 108 ++++++++++++++++++++++--------------------- 1 file changed, 56 insertions(+), 52 deletions(-) diff --git a/docs/api/protocol.md b/docs/api/protocol.md index be0cad0d5de0..ba4160d7c321 100644 --- a/docs/api/protocol.md +++ b/docs/api/protocol.md @@ -3,7 +3,7 @@ The `protocol` module can register a custom protocol or intercept an existing protocol. -An example of implementing a protocol that has the same effect with the +An example of implementing a protocol that has the same effect as the `file://` protocol: ```javascript @@ -24,48 +24,52 @@ app.on('ready', function() { **Note:** This module can only be used after the `ready` event was emitted. -## protocol.registerStandardSchemes(schemes) +## Methods + +The `protocol` module has the following methods: + +### `protocol.registerStandardSchemes(schemes)` * `schemes` Array - Custom schemes to be registered as standard schemes. -A standard scheme adheres to what RFC 3986 calls +A standard `scheme` adheres to what RFC 3986 calls [generic URI syntax](https://tools.ietf.org/html/rfc3986#section-3). This includes `file:` and `filesystem:`. -## protocol.registerFileProtocol(scheme, handler[, completion]) +### `protocol.registerFileProtocol(scheme, handler[, completion])` * `scheme` String * `handler` Function -* `completion` Function +* `completion` Function (optional) -Registers a protocol of `scheme` that will send file as response, the `handler` +Registers a protocol of `scheme` that will send the file as a response. The `handler` will be called with `handler(request, callback)` when a `request` is going to be -created with `scheme`, and `completion` will be called with `completion(null)` +created with `scheme` and `completion` will be called with `completion(null)` when `scheme` is successfully registered, or `completion(error)` when failed. -To handle the `request`, the `callback` should be called with either file's path -or an object that has `path` property, e.g. `callback(filePath)` or +To handle the `request`, the `callback` should be called with either the file's +path or an object that has a `path` property, e.g. `callback(filePath)` or `callback({path: filePath})`. -When `callback` is called with nothing, or a number, or an object that has -`error` property, the `request` will be failed with the `error` number you -specified. For the available error numbers you can use, please check: +When `callback` is called with nothing, a number, or an object that has an +`error` property, the `request` will fail with the `error` number you +specified. For the available error numbers you can use, please see: https://code.google.com/p/chromium/codesearch#chromium/src/net/base/net_error_list.h -By default the scheme is treated like `http:`, which is parsed differently -from protocols that follows "generic URI syntax" like `file:`, so you probably -want to call `protocol.registerStandardSchemes` to make your scheme treated as +By default the `scheme` is treated like `http:`, which is parsed differently +from protocols that follow "generic URI syntax" like `file:`, so you probably +want to call `protocol.registerStandardSchemes` to have your scheme treated as a standard scheme. -## protocol.registerBufferProtocol(scheme, handler[, completion]) +### `protocol.registerBufferProtocol(scheme, handler[, completion])` * `scheme` String * `handler` Function -* `completion` Function +* `completion` Function (optional) -Registers a protocol of `scheme` that will send `Buffer` as response, the -`callback` should be called with either an `Buffer` object, or an object that -has `data`, `mimeType`, `chart` properties. +Registers a protocol of `scheme` that will send a `Buffer` as a response. The +`callback` should be called with either a `Buffer` object or an object that +has the `data`, `mimeType`, and `chart` properties. Example: @@ -78,37 +82,37 @@ protocol.registerBufferProtocol('atom', function(request, callback) { }); ``` -## protocol.registerStringProtocol(scheme, handler[, completion]) +### `protocol.registerStringProtocol(scheme, handler[, completion])` * `scheme` String * `handler` Function -* `completion` Function +* `completion` Function (optional) -Registers a protocol of `scheme` that will send `String` as response, the -`callback` should be called with either a `String`, or an object that -has `data`, `mimeType`, `chart` properties. +Registers a protocol of `scheme` that will send a `String` as a response. The +`callback` should be called with either a `String` or an object that has the +`data`, `mimeType`, and `chart` properties. -## protocol.registerHttpProtocol(scheme, handler[, completion]) +### `protocol.registerHttpProtocol(scheme, handler[, completion])` * `scheme` String * `handler` Function -* `completion` Function +* `completion` Function (optional) -Registers a protocol of `scheme` that will send a HTTP request as response, the -`callback` should be called with an object that has `url`, `method`, `referer`, -`session` properties. +Registers a protocol of `scheme` that will send an HTTP request as a response. +The `callback` should be called with an object that has the `url`, `method`, +`referer`, and `session` properties. -By default the HTTP request will reuse current session, if you want the request -to have different session you should specify `session` to `null`. +By default the HTTP request will reuse the current session. If you want the +request to have a different session you should set `session` to `null`. -## protocol.unregisterProtocol(scheme[, completion]) +### `protocol.unregisterProtocol(scheme[, completion])` * `scheme` String -* `completion` Function +* `completion` Function (optional) Unregisters the custom protocol of `scheme`. -## protocol.isProtocolHandled(scheme, callback) +### `protocol.isProtocolHandled(scheme, callback)` * `scheme` String * `callback` Function @@ -116,43 +120,43 @@ Unregisters the custom protocol of `scheme`. The `callback` will be called with a boolean that indicates whether there is already a handler for `scheme`. -## protocol.interceptFileProtocol(scheme, handler[, completion]) +### `protocol.interceptFileProtocol(scheme, handler[, completion])` * `scheme` String * `handler` Function -* `completion` Function +* `completion` Function (optional) -Intercepts `scheme` protocol and use `handler` as the protocol's new handler -which sends file as response. +Intercepts `scheme` protocol and uses `handler` as the protocol's new handler +which sends a file as a response. -## protocol.interceptStringProtocol(scheme, handler[, completion]) +### `protocol.interceptStringProtocol(scheme, handler[, completion])` * `scheme` String * `handler` Function -* `completion` Function +* `completion` Function (optional) -Intercepts `scheme` protocol and use `handler` as the protocol's new handler -which sends String as response. +Intercepts `scheme` protocol and uses `handler` as the protocol's new handler +which sends a `String` as a response. -## protocol.interceptBufferProtocol(scheme, handler[, completion]) +## `protocol.interceptBufferProtocol(scheme, handler[, completion])` * `scheme` String * `handler` Function -* `completion` Function +* `completion` Function (optional) -Intercepts `scheme` protocol and use `handler` as the protocol's new handler -which sends `Buffer` as response. +Intercepts `scheme` protocol and uses `handler` as the protocol's new handler +which sends a `Buffer` as a response. -## protocol.interceptHttpProtocol(scheme, handler[, completion]) +## `protocol.interceptHttpProtocol(scheme, handler[, completion])` * `scheme` String * `handler` Function -* `completion` Function +* `completion` Function (optional) -Intercepts `scheme` protocol and use `handler` as the protocol's new handler -which sends a new HTTP request as response. +Intercepts `scheme` protocol and uses `handler` as the protocol's new handler +which sends a new HTTP request as a response. -## protocol.uninterceptProtocol(scheme[, completion]) +## `protocol.uninterceptProtocol(scheme[, completion])` * `scheme` String * `completion` Function From 50736296a7de8bb4ee733c7110433e9d4af30c7a Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Fri, 28 Aug 2015 22:17:35 -0700 Subject: [PATCH 1014/1293] Standardize remote --- docs/api/remote.md | 85 ++++++++++++++++++++++++++-------------------- 1 file changed, 48 insertions(+), 37 deletions(-) diff --git a/docs/api/remote.md b/docs/api/remote.md index c06920836cdb..5658b0781656 100644 --- a/docs/api/remote.md +++ b/docs/api/remote.md @@ -1,29 +1,29 @@ # remote The `remote` module provides a simple way to do inter-process communication -between the renderer process and the main process. +between the renderer process (web page) and the main process. In Electron, only GUI-unrelated modules are available in the renderer process. -Without the `remote` module, users who wanted to call a main process API in +Without the `remote` module, users who want to call a main process API in the renderer process would have to explicitly send inter-process messages -to the main process. With the `remote` module, users can invoke methods of -main process object without explicitly sending inter-process messages, -similar to Java's -[RMI](http://en.wikipedia.org/wiki/Java_remote_method_invocation). +to the main process. With the `remote` module, users can invoke methods of the +main process object without explicitly sending inter-process messages, similar +to Java's [RMI](http://en.wikipedia.org/wiki/Java_remote_method_invocation). -An example of creating a browser window in renderer process: +An example of creating a browser window from a renderer process: ```javascript var remote = require('remote'); var BrowserWindow = remote.require('browser-window'); + var win = new BrowserWindow({ width: 800, height: 600 }); win.loadUrl('https://github.com'); ``` -Note: for the reverse (access renderer process from main process), you can use -[webContents.executeJavascript](browser-window.md#webcontents-executejavascript-code). +**Note**: for the reverse (access the renderer process from the main process), +you can use [webContents.executeJavascript](browser-window.md#webcontents-executejavascript-code). -## Remote objects +## Remote Objects Each object (including functions) returned by the `remote` module represents an object in the main process (we call it a remote object or remote function). @@ -36,30 +36,31 @@ In the example above, both `BrowserWindow` and `win` were remote objects and Instead, it created a `BrowserWindow` object in the main process and returned the corresponding remote object in the renderer process, namely the `win` object. -## Lifetime of remote objects +## Lifetime of Remote Objects Electron makes sure that as long as the remote object in the renderer process lives (in other words, has not been garbage collected), the corresponding object -in the main process would never be released. When the remote object has been -garbage collected, the corresponding object in the main process would be +in the main process will never be released. When the remote object has been +garbage collected, the corresponding object in the main process will be dereferenced. -If the remote object is leaked in renderer process (e.g. stored in a map but never -freed), the corresponding object in the main process would also be leaked, +If the remote object is leaked in the renderer process (e.g. stored in a map but +never freed), the corresponding object in the main process will also be leaked, so you should be very careful not to leak remote objects. Primary value types like strings and numbers, however, are sent by copy. ## Passing callbacks to the main process -Code in the main process can accept callbacks from the renderer - for instance the `remote` module - -but you should be extremely careful when using this feature. +Code in the main process can accept callbacks from the renderer - for instance +the `remote` module - but you should be extremely careful when using this feature. First, in order to avoid deadlocks, the callbacks passed to the main process are called asynchronously. You should not expect the main process to get the return value of the passed callbacks. -For instance you can't use a function from the renderer process in a `Array.map` called in the main process: +For instance you can't use a function from the renderer process in an +`Array.map` called in the main process: ```javascript // main process mapNumbers.js @@ -69,10 +70,12 @@ exports.withRendererCallback = function(mapper) { exports.withLocalCallback = function() { return exports.mapNumbers(function(x) { - return x + 1; + return x + 1; }); } +``` +```javascript // renderer process var mapNumbers = require("remote").require("mapNumbers"); @@ -85,8 +88,9 @@ var withLocalCb = mapNumbers.withLocalCallback() console.log(withRendererCb, withLocalCb) // [true, true, true], [2, 3, 4] ``` -As you can see, the renderer callback's synchronous return value was not as expected, -and didn't match the return value of an indentical callback that lives in the main process. +As you can see, the renderer callback's synchronous return value was not as +expected, and didn't match the return value of an identical callback that lives +in the main process. Second, the callbacks passed to the main process will persist until the main process garbage-collects them. @@ -96,45 +100,52 @@ callback for the `close` event on a remote object: ```javascript var remote = require('remote'); + remote.getCurrentWindow().on('close', function() { // blabla... }); ``` But remember the callback is referenced by the main process until you -explicitly uninstall it! If you do not, each time you reload your window the callback will -be installed again, leaking one callback each restart. +explicitly uninstall it. If you do not, each time you reload your window the +callback will be installed again, leaking one callback for each restart. -To make things worse, since the context of previously installed callbacks have been released, -when the `close` event was emitted exceptions would be raised in the main process. +To make things worse, since the context of previously installed callbacks have +been released, when the `close` event was emitted exceptions will be raised in +the main process. -To avoid this problem, ensure you clean up any references to renderer callbacks passed to the main -process. This involves cleaning up event handlers, or ensuring the main process is explicitly told to deference -callbacks that came from a renderer process that is exiting. +To avoid this problem, ensure you clean up any references to renderer callbacks +passed to the main process. This involves cleaning up event handlers, or +ensuring the main process is explicitly told to deference callbacks that came +from a renderer process that is exiting. -## remote.require(module) +## Methods + +The `remote` module has the following methods: + +### `remote.require(module)` * `module` String Returns the object returned by `require(module)` in the main process. -## remote.getCurrentWindow() +### `remote.getCurrentWindow()` -Returns the [BrowserWindow](browser-window.md) object which this web page -belongs to. +Returns the [`BrowserWindow`](browser-window.md) object to which this web page +belongs. -## remote.getCurrentWebContents() +### `remote.getCurrentWebContents()` -Returns the WebContents object of this web page. +Returns the [`WebContents`](web-contents.md) object of this web page. -## remote.getGlobal(name) +### `remote.getGlobal(name)` * `name` String Returns the global variable of `name` (e.g. `global[name]`) in the main process. -## remote.process +### `remote.process` Returns the `process` object in the main process. This is the same as -`remote.getGlobal('process')`, but gets cached. +`remote.getGlobal('process')` but is cached. From e6e09a8a7cd1911a964e018e24b9ab7d37d1dad5 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Fri, 28 Aug 2015 22:24:54 -0700 Subject: [PATCH 1015/1293] Standardize screen --- docs/api/screen.md | 41 +++++++++++++++++++++++++++++------------ 1 file changed, 29 insertions(+), 12 deletions(-) diff --git a/docs/api/screen.md b/docs/api/screen.md index bc93ec5f892b..c22530ca8d0a 100644 --- a/docs/api/screen.md +++ b/docs/api/screen.md @@ -1,11 +1,14 @@ # screen -Gets various info about screen size, displays, cursor position, etc. You should -not use this module until the `ready` event of `app` module gets emitted. +The `screen` module retrieves information about screen size, displays, cursor +position, etc. You should not use this module until the `ready` event of the +`app` module is emitted. `screen` is an [EventEmitter](http://nodejs.org/api/events.html#events_class_events_eventemitter). -Make sure to note that in the renderer / DevTools, `window.screen` is a reserved DOM property, so writing `screen = require('screen')` won't work. In our examples below, we use `atomScreen` as the variable name instead. +**Note**: In the renderer / DevTools, `window.screen` is a reserved +DOM property, so writing `var screen = require('screen')` will not work. In our +examples below, we use `atomScreen` as the variable name instead. An example of creating a window that fills the whole screen: @@ -50,43 +53,57 @@ app.on('ready', function() { }); ``` -## Event: display-added +## Events + +The `screen` module emits the following events: + +### Event: 'display-added' + +Returns: * `event` Event * `newDisplay` Object Emitted when `newDisplay` has been added. -## Event: display-removed +### Event: 'display-removed' + +Returns: * `event` Event * `oldDisplay` Object Emitted when `oldDisplay` has been removed. -## Event: display-metrics-changed +### Event: 'display-metrics-changed' + +Returns: * `event` Event * `display` Object * `changedMetrics` Array -Emitted when a `display` has one or more metrics changed, `changedMetrics` is +Emitted when one or more metrics change in a `display`. The `changedMetrics` is an array of strings that describe the changes. Possible changes are `bounds`, `workArea`, `scaleFactor` and `rotation`. -## screen.getCursorScreenPoint() +## Methods + +The `screen` module has the following methods: + +### `screen.getCursorScreenPoint()` Returns the current absolute position of the mouse pointer. -## screen.getPrimaryDisplay() +### `screen.getPrimaryDisplay()` Returns the primary display. -## screen.getAllDisplays() +### `screen.getAllDisplays()` Returns an array of displays that are currently available. -## screen.getDisplayNearestPoint(point) +### `screen.getDisplayNearestPoint(point)` * `point` Object * `x` Integer @@ -94,7 +111,7 @@ Returns an array of displays that are currently available. Returns the display nearest the specified point. -## screen.getDisplayMatching(rect) +### `screen.getDisplayMatching(rect)` * `rect` Object * `x` Integer From a2cc936a3b01f23b6f9c632307eda95f4bcf620f Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Fri, 28 Aug 2015 22:28:30 -0700 Subject: [PATCH 1016/1293] Standardize shell --- docs/api/shell.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/docs/api/shell.md b/docs/api/shell.md index f0848875a975..662fa588f3f0 100644 --- a/docs/api/shell.md +++ b/docs/api/shell.md @@ -2,38 +2,43 @@ The `shell` module provides functions related to desktop integration. -An example of opening a URL in default browser: +An example of opening a URL in the user's default browser: ```javascript var shell = require('shell'); + shell.openExternal('https://github.com'); ``` -## shell.showItemInFolder(fullPath) +## Methods + +The `shell` module has the following methods: + +### `shell.showItemInFolder(fullPath)` * `fullPath` String Show the given file in a file manager. If possible, select the file. -## shell.openItem(fullPath) +### `shell.openItem(fullPath)` * `fullPath` String Open the given file in the desktop's default manner. -## shell.openExternal(url) +### `shell.openExternal(url)` * `url` String Open the given external protocol URL in the desktop's default manner. (For -example, mailto: URLs in the default mail user agent.) +example, mailto: URLs in the user's default mail agent.) -## shell.moveItemToTrash(fullPath) +### `shell.moveItemToTrash(fullPath)` * `fullPath` String -Move the given file to trash and returns boolean status for the operation. +Move the given file to trash and returns a boolean status for the operation. -## shell.beep() +### `shell.beep()` Play the beep sound. From e8a04981bbafd2ed707b1cc3be168d1f9762d128 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Fri, 28 Aug 2015 22:46:31 -0700 Subject: [PATCH 1017/1293] Standardize synopsis --- docs/api/synopsis.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/docs/api/synopsis.md b/docs/api/synopsis.md index 10daf2b68e78..4634151bfbec 100644 --- a/docs/api/synopsis.md +++ b/docs/api/synopsis.md @@ -1,18 +1,22 @@ # Synopsis -All of [node.js's built-in modules](http://nodejs.org/api/) are available in -Electron, and third-party node modules are fully supported too (including the -[native modules](../tutorial/using-native-node-modules.md)). +All of [Node.js's built-in modules](http://nodejs.org/api/) are available in +Electron and third-party node modules also fully supported as well (including +the [native modules](../tutorial/using-native-node-modules.md)). Electron also provides some extra built-in modules for developing native desktop applications. Some modules are only available on the main process, some -are only available on the renderer process, and some can be used on both processes. -The basic rule is: if a module is GUI or low-level system related, then it should -be only available on the main process. You need to be familiar with the concept of +are only available on the renderer process (web page), and some can be used on +both processes. + +The basic rule is: if a module is +[GUI](https://en.wikipedia.org/wiki/Graphical_user_interface) or low-level +system related, then it should be only available on the main process. You need +to be familiar with the concept of [main process vs. renderer process](../tutorial/quick-start.md#the-main-process) scripts to be able to use those modules. -The main process script is just like a normal `node.js` script: +The main process script is just like a normal Node.js script: ```javascript var app = require('app'); @@ -26,7 +30,7 @@ app.on('ready', function() { }); ``` -The web page is no different than a normal web page, except for the extra +The render process is no different than a normal web page, except for the extra ability to use node modules: ```html From b1fc18f405a77aad212123888ed384f6583afe18 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Fri, 28 Aug 2015 22:46:39 -0700 Subject: [PATCH 1018/1293] Standardize tray --- docs/api/tray.md | 86 ++++++++++++++++++++++-------------------------- 1 file changed, 40 insertions(+), 46 deletions(-) diff --git a/docs/api/tray.md b/docs/api/tray.md index a67772746128..c9ebf20543fe 100644 --- a/docs/api/tray.md +++ b/docs/api/tray.md @@ -1,6 +1,6 @@ -# tray +# Tray -A `Tray` represents an icon in operating system's notification area, it is +A `Tray` represents an icon in an operating system's notification area, it is usually attached with a context menu. ```javascript @@ -25,26 +25,33 @@ app.on('ready', function(){ __Platform limitations:__ -* On Linux app indicator will be used if it is supported, otherwise +* On Linux the app indicator will be used if it is supported, otherwise `GtkStatusIcon` will be used instead. * On Linux distributions that only have app indicator support, you have to - install `libappindicator1` to make tray icon work. -* App indicator will only be showed when it has context menu. -* When app indicator is used on Linux, `clicked` event is ignored. + install `libappindicator1` to make the tray icon work. +* App indicator will only be shown when it has a context menu. +* When app indicator is used on Linux, the `clicked` event is ignored. -So if you want to keep exact same behaviors on all platforms, you should not -rely on `clicked` event and always attach a context menu to the tray icon. +If you want to keep exact same behaviors on all platforms, you should not +rely on the `clicked` event and always attach a context menu to the tray icon. ## Class: Tray `Tray` is an [EventEmitter][event-emitter]. -### new Tray(image) +### `new Tray(image)` * `image` [NativeImage](native-image.md) Creates a new tray icon associated with the `image`. +## Events + +The `Tray` module emits the following events: + +**Note:** Some events are only available on specific operating systems and are +labeled as such. + ### Event: 'clicked' * `event` Event @@ -52,7 +59,7 @@ Creates a new tray icon associated with the `image`. * `shiftKey` Boolean * `ctrlKey` Boolean * `metaKey` Boolean -* `bounds` Object - the bounds of tray icon +* `bounds` Object - the bounds of tray icon. * `x` Integer * `y` Integer * `width` Integer @@ -62,14 +69,14 @@ Emitted when the tray icon is clicked. __Note:__ The `bounds` payload is only implemented on OS X and Windows. -### Event: 'right-clicked' +### Event: 'right-clicked' _OS X_ _Windows_ * `event` Event * `altKey` Boolean * `shiftKey` Boolean * `ctrlKey` Boolean * `metaKey` Boolean -* `bounds` Object - the bounds of tray icon +* `bounds` Object - the bounds of tray icon. * `x` Integer * `y` Integer * `width` Integer @@ -77,9 +84,7 @@ __Note:__ The `bounds` payload is only implemented on OS X and Windows. Emitted when the tray icon is right clicked. -__Note:__ This is only implemented on OS X and Windows. - -### Event: 'double-clicked' +### Event: 'double-clicked' _OS X_ _Windows_ * `event` Event * `altKey` Boolean @@ -94,75 +99,68 @@ __Note:__ This is only implemented on OS X and Windows. Emitted when the tray icon is double clicked. -__Note:__ This is only implemented on OS X and Windows. - -### Event: 'balloon-show' +### Event: 'balloon-show' _Windows_ Emitted when the tray balloon shows. -__Note:__ This is only implemented on Windows. - -### Event: 'balloon-clicked' +### Event: 'balloon-clicked' _Windows_ Emitted when the tray balloon is clicked. -__Note:__ This is only implemented on Windows. - -### Event: 'balloon-closed' +### Event: 'balloon-closed' _Windows_ Emitted when the tray balloon is closed because of timeout or user manually closes it. -__Note:__ This is only implemented on Windows. - -### Event: 'drop-files' +### Event: 'drop-files' _OS X_ * `event` * `files` Array - the file path of dropped files. Emitted when dragged files are dropped in the tray icon. -__Note:__ This is only implemented on OS X. +## Methods -### Tray.destroy() +The `Tray` module has the following methods: + +**Note**: Some methods are only available on specific operating systems and area +labeled as such. + +### `Tray.destroy()` Destroys the tray icon immediately. -### Tray.setImage(image) +### `Tray.setImage(image)` * `image` [NativeImage](native-image.md) Sets the `image` associated with this tray icon. -### Tray.setPressedImage(image) +### `Tray.setPressedImage(image)` _OS X_ * `image` [NativeImage](native-image.md) Sets the `image` associated with this tray icon when pressed on OS X. -### Tray.setToolTip(toolTip) +### `Tray.setToolTip(toolTip)` * `toolTip` String Sets the hover text for this tray icon. -### Tray.setTitle(title) +### `Tray.setTitle(title)` _OS X_ * `title` String Sets the title displayed aside of the tray icon in the status bar. -__Note:__ This is only implemented on OS X. - -### Tray.setHighlightMode(highlight) +### `Tray.setHighlightMode(highlight)` _OS X_ * `highlight` Boolean Sets whether the tray icon is highlighted when it is clicked. -__Note:__ This is only implemented on OS X. - -### Tray.displayBalloon(options) +### `Tray.displayBalloon(options)` _Windows_ * `options` Object * `icon` [NativeImage](native-image.md) @@ -171,19 +169,15 @@ __Note:__ This is only implemented on OS X. Displays a tray balloon. -__Note:__ This is only implemented on Windows. +### `Tray.popUpContextMenu([position])` _OS X_ _Windows_ -### Tray.popUpContextMenu([position]) - -* `position` Object - The pop position +* `position` Object (optional)- The pop up position. * `x` Integer * `y` Integer The `position` is only available on Windows, and it is (0, 0) by default. -__Note:__ This is only implemented on OS X and Windows. - -### Tray.setContextMenu(menu) +### `Tray.setContextMenu(menu)` * `menu` Menu From 2c3ed90ff3fafef13046f82dc7cb38761b427fc3 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Fri, 28 Aug 2015 23:20:49 -0700 Subject: [PATCH 1019/1293] Standardize web-frame --- docs/api/web-frame.md | 33 +++++++++++++++++++-------------- 1 file changed, 19 insertions(+), 14 deletions(-) diff --git a/docs/api/web-frame.md b/docs/api/web-frame.md index 810c31a4ecdd..4d42dd78ea50 100644 --- a/docs/api/web-frame.md +++ b/docs/api/web-frame.md @@ -1,45 +1,50 @@ -# web-frame +# webFrame -The `web-frame` module can custom the rendering of current web page. +The `web-frame` module customizes the rendering of the current web page. An example of zooming current page to 200%. ```javascript var webFrame = require('web-frame'); + webFrame.setZoomFactor(2); ``` -## webFrame.setZoomFactor(factor) +## Methods -* `factor` Number - Zoom factor +The `web-frame` module has the following methods: + +### `webFrame.setZoomFactor(factor)` + +* `factor` Number - Zoom factor. Changes the zoom factor to the specified factor, zoom factor is zoom percent / 100, so 300% = 3.0. -## webFrame.getZoomFactor() +### `webFrame.getZoomFactor()` Returns the current zoom factor. -## webFrame.setZoomLevel(level) +### `webFrame.setZoomLevel(level)` * `level` Number - Zoom level -Changes the zoom level to the specified level, 0 is "original size", and each +Changes the zoom level to the specified level. The "original size" is 0 and each increment above or below represents zooming 20% larger or smaller to default limits of 300% and 50% of original size, respectively. -## webFrame.getZoomLevel() +### `webFrame.getZoomLevel()` Returns the current zoom level. -## webFrame.setZoomLevelLimits(minimumLevel, maximumLevel) +### `webFrame.setZoomLevelLimits(minimumLevel, maximumLevel)` * `minimumLevel` Number * `maximumLevel` Number Sets the maximum and minimum zoom level. -## webFrame.setSpellCheckProvider(language, autoCorrectWord, provider) +### `webFrame.setSpellCheckProvider(language, autoCorrectWord, provider)` * `language` String * `autoCorrectWord` Boolean @@ -60,7 +65,7 @@ require('web-frame').setSpellCheckProvider("en-US", true, { }); ``` -## webFrame.registerUrlSchemeAsSecure(scheme) +### `webFrame.registerUrlSchemeAsSecure(scheme)` * `scheme` String @@ -70,11 +75,11 @@ Secure schemes do not trigger mixed content warnings. For example, `https` and `data` are secure schemes because they cannot be corrupted by active network attackers. -## webFrame.registerUrlSchemeAsBypassingCsp(scheme) +### `webFrame.registerUrlSchemeAsBypassingCsp(scheme)` * `scheme` String -Resources will be loaded from this `scheme` regardless of -page's Content Security Policy. +Resources will be loaded from this `scheme` regardless of the current page's +Content Security Policy. [spellchecker]: https://github.com/atom/node-spellchecker From 8d40714f78ed74f134e7fca5acf24a6a5c3de175 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Fri, 28 Aug 2015 23:20:59 -0700 Subject: [PATCH 1020/1293] Standardize web-view-tag --- docs/api/web-view-tag.md | 227 ++++++++++++++++++++++----------------- 1 file changed, 129 insertions(+), 98 deletions(-) diff --git a/docs/api/web-view-tag.md b/docs/api/web-view-tag.md index f8490b624c73..e555607b6b03 100644 --- a/docs/api/web-view-tag.md +++ b/docs/api/web-view-tag.md @@ -1,12 +1,12 @@ -# `` tag +# The `` tag Use the `webview` tag to embed 'guest' content (such as web pages) in your -Electron app. The guest content is contained within the `webview` container; -an embedder page within your app controls how the guest content is laid out and +Electron app. The guest content is contained within the `webview` container. +An embedder page within your app controls how the guest content is laid out and rendered. -Different from the `iframe`, the `webview` runs in a separate process than your -app; it doesn't have the same permissions as your web page and all interactions +Different from an `iframe`, the `webview` runs in a separate process than your +app. It doesn't have the same permissions as your web page and all interactions between your app and embedded content will be asynchronous. This keeps your app safe from the embedded content. @@ -45,9 +45,11 @@ and displays a "loading..." message during the load time: ``` -## Tag attributes +## Tag Attributes -### src +The `webview` tag has the following attributes: + +### `src` ```html @@ -61,7 +63,7 @@ Assigning `src` its own value will reload the current page. The `src` attribute can also accept data URLs, such as `data:text/plain,Hello, world!`. -### autosize +### `autosize` ```html @@ -69,11 +71,11 @@ The `src` attribute can also accept data URLs, such as If "on", the `webview` container will automatically resize within the bounds specified by the attributes `minwidth`, `minheight`, `maxwidth`, and -`maxheight`. These contraints do not impact the `webview` UNLESS `autosize` is +`maxheight`. These constraints do not impact the `webview` UNLESS `autosize` is enabled. When `autosize` is enabled, the `webview` container size cannot be less than the minimum values or greater than the maximum. -### nodeintegration +### `nodeintegration` ```html @@ -82,7 +84,7 @@ than the minimum values or greater than the maximum. If "on", the guest page in `webview` will have node integration and can use node APIs like `require` and `process` to access low level system resources. -### plugins +### `plugins` ```html @@ -90,7 +92,7 @@ APIs like `require` and `process` to access low level system resources. If "on", the guest page in `webview` will be able to use browser plugins. -### preload +### `preload` ```html @@ -102,9 +104,9 @@ will be loaded by `require` in guest page under the hood. When the guest page doesn't have node integration this script will still have access to all Node APIs, but global objects injected by Node will be deleted -after this script has done execution. +after this script has completed execution. -### httpreferrer +### `httpreferrer` ```html @@ -112,15 +114,16 @@ after this script has done execution. Sets the referrer URL for the guest page. -### useragent +### `useragent` ```html ``` -Sets the user agent for the guest page before the page is navigated to. Once the page is loaded, use the `setUserAgent` method to change the user agent. +Sets the user agent for the guest page before the page is navigated to. Once the +page is loaded, use the `setUserAgent` method to change the user agent. -### disablewebsecurity +### `disablewebsecurity` ```html @@ -130,7 +133,10 @@ If "on", the guest page will have web security disabled. ## Methods -The webview element must be loaded before using the methods. +The `webview` tag has the following methods: + +**Note**: The webview element must be loaded before using the methods. + **Example** ```javascript webview.addEventListener("dom-ready", function() { @@ -138,194 +144,195 @@ webview.addEventListener("dom-ready", function() { }); ``` -### ``.getUrl() +### `.getUrl()` Returns URL of guest page. -### ``.getTitle() +### `.getTitle()` Returns the title of guest page. -### ``.isLoading() +### `.isLoading()` -Returns whether guest page is still loading resources. +Returns a boolean whether guest page is still loading resources. -### ``.isWaitingForResponse() +### `.isWaitingForResponse()` -Returns whether guest page is waiting for a first-response for the main resource -of the page. +Returns a boolean whether guest page is waiting for a first-response for the +main resource of the page. -### ``.stop() +### `.stop()` Stops any pending navigation. -### ``.reload() +### `.reload()` Reloads guest page. -### ``.reloadIgnoringCache() +### `.reloadIgnoringCache()` Reloads guest page and ignores cache. -### ``.canGoBack() +### `.canGoBack()` -Returns whether guest page can go back. +Returns a boolean whether guest page can go back. -### ``.canGoForward() +### `.canGoForward()` -Returns whether guest page can go forward. +Returns a boolean whether guest page can go forward. -### ``.canGoToOffset(offset) +### `.canGoToOffset(offset)` * `offset` Integer -Returns whether guest page can go to `offset`. +Returns a boolean whether guest page can go to `offset`. -### ``.clearHistory() +### `.clearHistory()` Clears the navigation history. -### ``.goBack() +### `.goBack()` Makes guest page go back. -### ``.goForward() +### `.goForward()` Makes guest page go forward. -### ``.goToIndex(index) +### `.goToIndex(index)` * `index` Integer Navigates to the specified absolute index. -### ``.goToOffset(offset) +### `.goToOffset(offset)` * `offset` Integer Navigates to the specified offset from the "current entry". -### ``.isCrashed() +### `.isCrashed()` Whether the renderer process has crashed. -### ``.setUserAgent(userAgent) +### `.setUserAgent(userAgent)` * `userAgent` String Overrides the user agent for guest page. -### ``.getUserAgent() +### `.getUserAgent()` -Returns a `String` represents the user agent for guest page. +Returns a `String` representing the user agent for guest page. -### ``.insertCSS(css) +### `.insertCSS(css)` * `css` String Injects CSS into guest page. -### ``.executeJavaScript(code, userGesture) +### `.executeJavaScript(code, userGesture)` * `code` String -* `userGesture` Boolean - Default false +* `userGesture` Boolean - Default `false`. -Evaluates `code` in page. If `userGesture` is set will create user gesture context, -HTML api like `requestFullScreen` which require user action can take advantage -of this option for automation. +Evaluates `code` in page. If `userGesture` is set, it will create user gesture +context. HTML API like `requestFullScreen` which require user action can take +advantage of this option for automation. -### ``.openDevTools() +### `.openDevTools()` Opens a devtools window for guest page. -### ``.closeDevTools() +### `.closeDevTools()` Closes the devtools window of guest page. -### ``.isDevToolsOpened() +### `.isDevToolsOpened()` -Returns whether guest page has a devtools window attached. +Returns a boolean whether guest page has a devtools window attached. -### ``.inspectElement(x, y) +### `.inspectElement(x, y)` * `x` Integer * `y` Integer Starts inspecting element at position (`x`, `y`) of guest page. -### ``.inspectServiceWorker() +### `.inspectServiceWorker()` Opens the devtools for the service worker context present in the guest page. -### ``.setAudioMuted(muted) +### `.setAudioMuted(muted)` -+ `muted` Boolean +* `muted` Boolean Set guest page muted. -### ``.isAudioMuted() +### `.isAudioMuted()` Returns whether guest page has been muted. -### ``.undo() +### `.undo()` Executes editing command `undo` in page. -### ``.redo() +### `.redo()` Executes editing command `redo` in page. -### ``.cut() +### `.cut()` Executes editing command `cut` in page. -### ``.copy() +### `.copy()` Executes editing command `copy` in page. -### ``.paste() +### `.paste()` Executes editing command `paste` in page. -### ``.pasteAndMatchStyle() +### `.pasteAndMatchStyle()` Executes editing command `pasteAndMatchStyle` in page. -### ``.delete() +### `.delete()` Executes editing command `delete` in page. -### ``.selectAll() +### `.selectAll()` Executes editing command `selectAll` in page. -### ``.unselect() +### `.unselect()` Executes editing command `unselect` in page. -### ``.replace(text) +### ``.replaceMisspelling(text) +### `.replaceMisspelling(text)` * `text` String Executes editing command `replaceMisspelling` in page. -### ``.print([options]) +### `.print([options])` -Prints webview's web page. Same with `webContents.print([options])`. +Prints `webview`'s web page. Same with `webContents.print([options])`. -### ``.printToPDF(options, callback) +### `.printToPDF(options, callback)` Prints webview's web page as PDF, Same with `webContents.printToPDF(options, callback)` -### ``.send(channel[, args...]) +### `.send(channel[, args...])` * `channel` String +* `arg` (optional) Send `args..` to guest page via `channel` in asynchronous message, the guest page can handle it by listening to the `channel` event of `ipc` module. @@ -335,7 +342,11 @@ examples. ## DOM events -### load-commit +The following DOM events are available to the `webview` tag: + +### Event: 'load-commit' + +Returns: * `url` String * `isMainFrame` Boolean @@ -344,12 +355,14 @@ Fired when a load has committed. This includes navigation within the current document as well as subframe document-level loads, but does not include asynchronous resource loads. -### did-finish-load +### Event: 'did-finish-load' Fired when the navigation is done, i.e. the spinner of the tab will stop -spinning, and the `onload` event was dispatched. +spinning, and the `onload` event is dispatched. -### did-fail-load +### Event: 'did-fail-load' + +Returns: * `errorCode` Integer * `errorDescription` String @@ -357,21 +370,25 @@ spinning, and the `onload` event was dispatched. This event is like `did-finish-load`, but fired when the load failed or was cancelled, e.g. `window.stop()` is invoked. -### did-frame-finish-load +### Event: 'did-frame-finish-load' + +Returns: * `isMainFrame` Boolean Fired when a frame has done navigation. -### did-start-loading +### Event: 'did-start-loading' Corresponds to the points in time when the spinner of the tab starts spinning. -### did-stop-loading +### Event: 'did-stop-loading' Corresponds to the points in time when the spinner of the tab stops spinning. -### did-get-response-details +### Event: 'did-get-response-details' + +Returns: * `status` Boolean * `newUrl` String @@ -384,7 +401,9 @@ Corresponds to the points in time when the spinner of the tab stops spinning. Fired when details regarding a requested resource is available. `status` indicates socket connection to download the resource. -### did-get-redirect-request +### Event: 'did-get-redirect-request' + +Returns: * `oldUrl` String * `newUrl` String @@ -392,11 +411,13 @@ Fired when details regarding a requested resource is available. Fired when a redirect was received while requesting a resource. -### dom-ready +### Event: 'dom-ready' Fired when document in the given frame is loaded. -### page-title-set +### Event: 'page-title-set' + +Returns: * `title` String * `explicitSet` Boolean @@ -404,21 +425,25 @@ Fired when document in the given frame is loaded. Fired when page title is set during navigation. `explicitSet` is false when title is synthesised from file url. -### page-favicon-updated +### Event: 'page-favicon-updated' -* `favicons` Array - Array of Urls +Returns: + +* `favicons` Array - Array of Urls. Fired when page receives favicon urls. -### enter-html-full-screen +### Event: 'enter-html-full-screen' -Fired when page enters fullscreen triggered by html api. +Fired when page enters fullscreen triggered by HTML API. -### leave-html-full-screen +### Event: 'leave-html-full-screen' -Fired when page leaves fullscreen triggered by html api. +Fired when page leaves fullscreen triggered by HTML API. -### console-message +### Event: 'console-message' + +Returns: * `level` Integer * `message` String @@ -436,7 +461,9 @@ webview.addEventListener('console-message', function(e) { }); ``` -### new-window +### Event: 'new-window' + +Returns: * `url` String * `frameName` String @@ -453,7 +480,7 @@ webview.addEventListener('new-window', function(e) { }); ``` -### close +### Event: 'close' Fired when the guest page attempts to close itself. @@ -466,7 +493,9 @@ webview.addEventListener('close', function() { }); ``` -### ipc-message +### Event: 'ipc-message' + +Returns: * `channel` String * `args` Array @@ -493,21 +522,23 @@ ipc.on('ping', function() { }); ``` -### crashed +### Event: 'crashed' Fired when the renderer process is crashed. -### gpu-crashed +### Event: 'gpu-crashed' Fired when the gpu process is crashed. -### plugin-crashed +### Event: 'plugin-crashed' + +Returns: * `name` String * `version` String Fired when a plugin process is crashed. -### destroyed +### Event: 'destroyed' Fired when the WebContents is destroyed. From 955ae78e33ab675fb82909c8b37d7d87f1c75a25 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Fri, 28 Aug 2015 23:21:09 -0700 Subject: [PATCH 1021/1293] Standardize window-open --- docs/api/window-open.md | 35 +++++++++++++++++++---------------- 1 file changed, 19 insertions(+), 16 deletions(-) diff --git a/docs/api/window-open.md b/docs/api/window-open.md index fa10b2e7d055..c574d5d036ee 100644 --- a/docs/api/window-open.md +++ b/docs/api/window-open.md @@ -1,22 +1,22 @@ -# `window.open` function +# The `window.open` function -When `window.open` is called to create a new window in web page, a new instance -of `BrowserWindow` will be created for the `url`, and a proxy will be returned +When `window.open` is called to create a new window in a web page, a new instance +of `BrowserWindow` will be created for the `url` and a proxy will be returned to `window.open` to let the page have limited control over it. -The proxy only has some limited standard functionality implemented to be -compatible with traditional web pages, for full control of the created window +The proxy has limited standard functionality implemented to be +compatible with traditional web pages. For full control of the new window you should create a `BrowserWindow` directly. -## window.open(url, [frameName[, features]]) +### `window.open(url[, frameName][, features])` * `url` String -* `frameName` String -* `features` String +* `frameName` String (optional) +* `features` String (optional) Creates a new window and returns an instance of `BrowserWindowProxy` class. -## window.opener.postMessage(message, targetOrigin) +### `window.opener.postMessage(message, targetOrigin)` * `message` String * `targetOrigin` String @@ -26,29 +26,32 @@ origin preference. ## Class: BrowserWindowProxy -### BrowserWindowProxy.blur() +The `BrowserWindowProxy` object is returned from `window.open` and provides +limited functionality with the child window. + +### `BrowserWindowProxy.blur()` Removes focus from the child window. -### BrowserWindowProxy.close() +### `BrowserWindowProxy.close()` Forcefully closes the child window without calling its unload event. -### BrowserWindowProxy.closed +### `BrowserWindowProxy.closed` Set to true after the child window gets closed. -### BrowserWindowProxy.eval(code) +### `BrowserWindowProxy.eval(code)` * `code` String Evaluates the code in the child window. -### BrowserWindowProxy.focus() +### `BrowserWindowProxy.focus()` Focuses the child window (brings the window to front). -### BrowserWindowProxy.postMessage(message, targetOrigin) +### `BrowserWindowProxy.postMessage(message, targetOrigin)` * `message` String * `targetOrigin` String @@ -57,4 +60,4 @@ Sends a message to the child window with the specified origin or `*` for no origin preference. In addition to these methods, the child window implements `window.opener` object -with no properties and a single method: +with no properties and a single method. From 39e3506add35f63002625a08edb716cebeb94b3f Mon Sep 17 00:00:00 2001 From: appetizermonster Date: Sat, 29 Aug 2015 18:04:30 +0900 Subject: [PATCH 1022/1293] Fix typo --- docs/api/frameless-window.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/frameless-window.md b/docs/api/frameless-window.md index 8d5c578914c7..a326bbd8c196 100644 --- a/docs/api/frameless-window.md +++ b/docs/api/frameless-window.md @@ -32,7 +32,7 @@ var win = new BrowserWindow({ transparent: true, frame: false }); * The `blur` filter only applies to the web page, so there is no way to apply blur effect to the content below the window (i.e. other applications open on the user's system). -* On Windows operation shystems, transparent windows will not work when DWM is +* On Windows operation systems, transparent windows will not work when DWM is disabled. * On Linux users have to put `--enable-transparent-visuals --disable-gpu` in the command line to disable GPU and allow ARGB to make transparent window, From 8757da6c4742c19d7008cf35cfdc5883665c2c4f Mon Sep 17 00:00:00 2001 From: Robo Date: Sat, 29 Aug 2015 19:20:09 +0530 Subject: [PATCH 1023/1293] renderer: send referrer for all naviagtions --- atom/renderer/atom_renderer_client.cc | 1 + 1 file changed, 1 insertion(+) diff --git a/atom/renderer/atom_renderer_client.cc b/atom/renderer/atom_renderer_client.cc index 04a89fed3889..86c9eb1cdeb6 100644 --- a/atom/renderer/atom_renderer_client.cc +++ b/atom/renderer/atom_renderer_client.cc @@ -229,6 +229,7 @@ bool AtomRendererClient::ShouldFork(blink::WebFrame* frame, // FIXME We only support GET here because http method will be ignored when // the OpenURLFromTab is triggered, which means form posting would not work, // we should solve this by patching Chromium in future. + *send_referrer = true; return http_method == "GET"; } From cfc5ecb05d68c33ebae71c288b2d7a6a966a3015 Mon Sep 17 00:00:00 2001 From: Eran Tiktin Date: Sat, 29 Aug 2015 20:05:15 +0300 Subject: [PATCH 1024/1293] Update web-frame.md phrasing --- docs/api/web-frame.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/api/web-frame.md b/docs/api/web-frame.md index 810c31a4ecdd..82d5fcc49d79 100644 --- a/docs/api/web-frame.md +++ b/docs/api/web-frame.md @@ -1,6 +1,7 @@ # web-frame -The `web-frame` module can custom the rendering of current web page. +The `web-frame` module allows you to customize the rendering of the current +web page. An example of zooming current page to 200%. From eab88ea09cc49a5180269f615393e349fa3589d8 Mon Sep 17 00:00:00 2001 From: Fritz Lin Date: Sun, 30 Aug 2015 22:53:40 +0800 Subject: [PATCH 1025/1293] Setting up docs translation in Chinese :+1: --- README.md | 1 + docs-translations/cn/README.md | 70 ++++++++++++++++++++++++++++++++++ 2 files changed, 71 insertions(+) create mode 100644 docs-translations/cn/README.md diff --git a/README.md b/README.md index ace7116c469a..32e5da2fafb3 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,7 @@ contains documents describing how to build and contribute to Electron. - [Korean](https://github.com/atom/electron/tree/master/docs-translations/ko) - [Japanese](https://github.com/atom/electron/tree/master/docs-translations/jp) - [Spanish](https://github.com/atom/electron/tree/master/docs-translations/es) +- [Chinese](https://github.com/atom/electron/tree/master/docs-translations/cn) ## Community diff --git a/docs-translations/cn/README.md b/docs-translations/cn/README.md new file mode 100644 index 000000000000..124d030c46ee --- /dev/null +++ b/docs-translations/cn/README.md @@ -0,0 +1,70 @@ +## 向导 + +* [应用部署](tutorial/application-distribution.md) +* [应用打包](tutorial/application-packaging.md) +* [使用原生模块](tutorial/using-native-node-modules.md) +* [主进程调试](tutorial/debugging-main-process.md) +* [使用 Selenium 和 WebDriver](tutorial/using-selenium-and-webdriver.md) +* [调试工具扩展](tutorial/devtools-extension.md) +* [使用 PepperFlash 插件](tutorial/using-pepper-flash-plugin.md) + +## 教程 + +* [快速入门](tutorial/quick-start.md) +* [桌面环境集成](tutorial/desktop-environment-integration.md) +* [在线/离线事件探测](tutorial/online-offline-events.md) + +## API文档 + +* [简介](api/synopsis.md) +* [进程对象](api/process.md) +* [支持的Chrome命令行开关](api/chrome-command-line-switches.md) + +定制的DOM元素: + +* [`File`对象](api/file-object.md) +* [``标签](api/web-view-tag.md) +* [`window.open`函数](api/window-open.md) + +主进程可用的模块: + +* [app](api/app.md) +* [auto-updater](api/auto-updater.md) +* [browser-window](api/browser-window.md) +* [content-tracing](api/content-tracing.md) +* [dialog](api/dialog.md) +* [global-shortcut](api/global-shortcut.md) +* [ipc (main process)](api/ipc-main-process.md) +* [menu](api/menu.md) +* [menu-item](api/menu-item.md) +* [power-monitor](api/power-monitor.md) +* [power-save-blocker](api/power-save-blocker.md) +* [protocol](api/protocol.md) +* [session](api/session.md) +* [webContents](api/web-contents.md) +* [tray](api/tray.md) + +渲染进程(网页)可用的模块: + +* [ipc (renderer)](api/ipc-renderer.md) +* [remote](api/remote.md) +* [web-frame](api/web-frame.md) + +两种进程都可用的模块: + +* [clipboard](api/clipboard.md) +* [crash-reporter](api/crash-reporter.md) +* [native-image](api/native-image.md) +* [screen](api/screen.md) +* [shell](api/shell.md) + +## 开发 + +* [编码规范](development/coding-style.md) +* [源码文件结构](development/source-code-directory-structure.md) +* [与 NW.js (原名 node-webkit) 在技术上的差异](development/atom-shell-vs-node-webkit.md) +* [构建系统概况](development/build-system-overview.md) +* [构建步骤 (Mac)](development/build-instructions-mac.md) +* [构建步骤 (Windows)](development/build-instructions-windows.md) +* [构建步骤 (Linux)](development/build-instructions-linux.md) +* [在调试中使用 SymbolServer](development/setting-up-symbol-server.md) From 9ee063ca14ce62955bf90ab0c9f6edb7ad4c86c4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Samy=20Pess=C3=A9?= Date: Mon, 31 Aug 2015 00:07:36 +0200 Subject: [PATCH 1026/1293] Add section about server implementations --- docs/api/auto-updater.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/api/auto-updater.md b/docs/api/auto-updater.md index 4e1dc5e0deb4..3901e1be2062 100644 --- a/docs/api/auto-updater.md +++ b/docs/api/auto-updater.md @@ -98,6 +98,10 @@ appropriate format. `pub_date` (if present) must be formatted according to ISO 8601. +## Update server implementations + +[Nuts](https://github.com/GitbookIO/nuts) is an open source implementation of the update server described above, it integrates beautifully with GitHub releases. Nuts manages downloads and updates, it’s compatible with `Squirrel.Mac` and `Squirrel.Windows` so you get cross-platform support out of the box. + ## Events The `autoUpdater` object emits the following events: From 9c46be9d479a51767f7a58ca9a1525ac669e0886 Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Mon, 31 Aug 2015 09:52:28 +0900 Subject: [PATCH 1027/1293] Translate styleguide.md --- docs-translations/ko/styleguide.md | 73 ++++++++++++++---------------- 1 file changed, 33 insertions(+), 40 deletions(-) diff --git a/docs-translations/ko/styleguide.md b/docs-translations/ko/styleguide.md index 065d37f5cd17..e63a016e8780 100644 --- a/docs-translations/ko/styleguide.md +++ b/docs-translations/ko/styleguide.md @@ -1,61 +1,55 @@ -# Electron Documentation Styleguide +# Electron 문서 스타일 가이드 -Find the appropriate section for your task: [reading Electron documentation](#) -or [writing Electron documentation](#). +[Electron 문서 읽기](#) 와 [Electron 문서 작성하기](#) 중 적당히 필요한 부분을 찾아 참고하세요: -## Writing Electron Documentation +## Electron 문서 작성하기 -These are the ways that we construct the Electron documentation. +Electron 문서를 작성하는 규칙은 다음과 같습니다. -- Maximum one `h1` title per page. -- Use `bash` instead of `cmd` in code blocks (because of syntax highlighter). -- Doc `h1` titles should match object name (i.e. `browser-window` - `BrowserWindow`). - - Hyphen separated filenames, however, are fine. -- No headers following headers, add at least a one-sentence description. -- Methods headers are wrapped in `code` ticks. -- Event headers are wrapped in single 'quotation' marks. -- No nesting lists more than 2 levels (unfortunately because of markdown - renderer). -- Add section titles: Events, Class Methods and Instance Methods. -- Use 'will' over 'would' when describing outcomes. -- Events and methods are `h3` headers. -- Optional arguments written as `function (required[, optional])`. -- Optional arguments are denoted when called out in list. -- Line length is 80-column wrapped. -- Platform specific methods are noted in italics following method header. +- `h1` 제목은 페이지당 한 개만 사용할 수 있습니다. +- 코드 블럭에서 터미널 언어 선택시 `cmd` 대신 `bash`를 사용합니다. (syntax highlighter를 사용하기 위해서) +- 문서의 `h1` 제목은 반드시 현재 객체 이름과 같게 해야 합니다. (예시: `browser-window` → `BrowserWindow`) + - 하이픈(-)으로 구분되었던 어떻게 되었던 간에 예시와 같이 작성합니다. +- 헤더 밑에 헤더를 바로 사용하지 않습니다. 한 줄이라도 좋으니 헤더와 헤더 사이에 설명 추가합니다. +- 메서드 헤더는 `code` 틱으로 표시합니다. +- 이벤트 헤더는 한 '따옴표'로 표시합니다. +- 리스트를 2 단계 이상 중첩하지 않습니다. (안타깝게도 markdown 랜더러가 지원하지 않습니다) +- 섹션에 대한 제목을 추가합니다: Events, Class 메서드 그리고 인스턴스 메서드등. +- 어떤 '것'의 사용 결과를 설명할 때 '될 것입니다' 형식을 사용하여 설명합니다. +- 이벤트와 메서드에는 `h3` 헤더를 사용합니다. +- 선택적 인수는 `function (required[, optional])` 형식으로 작성합니다. +- 선택적 인수는 목록에서 호출되면 표시합니다. +- 문장의 길이는 한 줄당 80 칸을 유지합니다. +- 플랫폼 특정 메서드 헤더는 이탈릭체로 표시합니다. - ```### `method(foo, bar)` _OS X_``` -## Reading Electron Documentation +## Electron 문서 읽기 -Here are some tips for understanding Electron documentation syntax. +Electron 문서 구조를 이해하는 데 참고할 수 있는 유용한 도움말입니다. -### Methods +### 메서드 -An example of [method](https://developer.mozilla.org/en-US/docs/Glossary/Method) -documentation: +[메서드](https://developer.mozilla.org/en-US/docs/Glossary/Method) 문서의 예제입니다: --- `methodName(required[, optional]))` -* `require` String, **required** +* `require` String, **필수** * `optional` Integer --- -The method name is followed by the arguments it takes. Optional arguments are -notated by brackets surrounding the optional argument as well as the comma -required if this optional argument follows another argument. +메서드 이름은 인수가 무엇을 받는지에 따라 결정됩니다. 선택적 인수는 브라켓([, ])으로 묶어 +이 인수가 다른 인수뒤에 선택적으로 사용할 수 있다는 것을 설명합니다. -Below the method is more detailed information on each of the arguments. The type -of argument is notated by either the common types: [`String`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), [`Number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number), [`Object`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object), [`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array) -or a custom type like Electron's [`webContent`](api/web-content.md). +메서드의 밑에선 각 인수에 대해 자세한 설명을 합니다. 인수의 타입은 일반적인 타입 중 하나를 받거나: +[`String`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), [`Number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number), [`Object`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object), [`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array) +Electron의 [`webContent`](api/web-content.md)같은 커스텀 타입을 받습니다. ### Events -An example of [event](https://developer.mozilla.org/en-US/docs/Web/API/Event) -documentation: +[Event](https://developer.mozilla.org/en-US/docs/Web/API/Event) 문서의 예제입니다: --- @@ -67,12 +61,11 @@ Returns: --- -The event is a string that is used after a `.on` listener method. If it returns -a value it and its type is noted below. If you were to listen and respond to -this event it might look something like this: +이벤트는 `.on` 리스너 메서드로 사용할 수 있습니다. 만약 이벤트에서 값을 반환한다면 문서에서 표시된 대로 +일정한 타입의 값을 반환합니다. 이벤트를 처리하거나 응답하려 한다면 다음과 같이 사용할 수 있습니다: ```javascript Alarm.on('wake-up', function(time) { console.log(time) }) -``` \ No newline at end of file +``` From 3d4f0dfc44003956dc1abbac5e8fe87ef82b56a1 Mon Sep 17 00:00:00 2001 From: Fritz Lin Date: Mon, 31 Aug 2015 11:02:37 +0800 Subject: [PATCH 1028/1293] Move cn to zh-CN for future traditional Chinese translations ref #2649 --- README.md | 2 +- docs-translations/{cn => zh-CN}/README.md | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename docs-translations/{cn => zh-CN}/README.md (100%) diff --git a/README.md b/README.md index 32e5da2fafb3..7f398cbd943b 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ contains documents describing how to build and contribute to Electron. - [Korean](https://github.com/atom/electron/tree/master/docs-translations/ko) - [Japanese](https://github.com/atom/electron/tree/master/docs-translations/jp) - [Spanish](https://github.com/atom/electron/tree/master/docs-translations/es) -- [Chinese](https://github.com/atom/electron/tree/master/docs-translations/cn) +- [Simplified Chinese](https://github.com/atom/electron/tree/master/docs-translations/zh-CN) ## Community diff --git a/docs-translations/cn/README.md b/docs-translations/zh-CN/README.md similarity index 100% rename from docs-translations/cn/README.md rename to docs-translations/zh-CN/README.md From 2c6210cf9c6487d812010102edd789952dba0dde Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Sun, 30 Aug 2015 20:52:37 -0700 Subject: [PATCH 1029/1293] Update code example --- docs/api/native-image.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/api/native-image.md b/docs/api/native-image.md index 03b1a309113e..467940c4f74e 100644 --- a/docs/api/native-image.md +++ b/docs/api/native-image.md @@ -115,7 +115,9 @@ Creates a new `NativeImage` instance from `dataUrl`. The following methods are available on instances of `nativeImage` ```javascript -var image = nativeImage.createFromPath('/Users/somebody/images/icon.png') +var NativeImage = require('native-image'); + +var image = NativeImage.createFromPath('/Users/somebody/images/icon.png'); ``` ### `image.toPng()` From 254cdc0e6ca4b467f7eda28b4083d0bfc669e532 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Sun, 30 Aug 2015 20:52:46 -0700 Subject: [PATCH 1030/1293] Text edits --- docs/api/native-image.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/api/native-image.md b/docs/api/native-image.md index 467940c4f74e..4b90fcfce612 100644 --- a/docs/api/native-image.md +++ b/docs/api/native-image.md @@ -29,15 +29,15 @@ On Windows, you can also load `ICO` icon from a file path. ## High resolution image On platforms that have high-DPI support, you can append `@2x` after image's -file name's base name to mark it as a high resolution image. +base filename to mark it as a high resolution image. For example if `icon.png` is a normal image that has standard resolution, then `icon@2x.png` would be treated as a high resolution image that has double DPI density. -If you want to support displays with different DPI density at the same time, you -can put images with different sizes in the same folder, and use the filename -without DPI suffixes, like this: +If you want to support displays with different DPI densities at the same time, +you can put images with different sizes in the same folder and use the filename +without DPI suffixes. For example: ```text images/ @@ -51,7 +51,7 @@ images/ var appIcon = new Tray('/Users/somebody/images/icon.png'); ``` -Following suffixes as DPI denses are also supported: +Following suffixes for DPI are also supported: * `@1x` * `@1.25x` @@ -71,13 +71,13 @@ Template images consist of black and clear colors (and an alpha channel). Template images are not intended to be used as standalone images and are usually mixed with other content to create the desired final appearance. -The most common case is to use template image for menu bar icon so it can adapt -to both light and dark menu bars. +The most common case is to use template images for a menu bar icon so it can +adapt to both light and dark menu bars. -Template image is only supported on OS X. +**Note**: Template image is only supported on OS X. To mark an image as a template image, its filename should end with the word -`Template`, examples are: +`Template`. For example: * `xxxTemplate.png` * `xxxTemplate@2x.png` @@ -112,7 +112,7 @@ Creates a new `NativeImage` instance from `dataUrl`. ## Instance Methods -The following methods are available on instances of `nativeImage` +The following methods are available on instances of `nativeImage`: ```javascript var NativeImage = require('native-image'); From cb62afca23c62807f8d35b9efe806ea9bdf38393 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Sun, 30 Aug 2015 21:10:02 -0700 Subject: [PATCH 1031/1293] Minor text edits --- docs/api/web-view-tag.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/web-view-tag.md b/docs/api/web-view-tag.md index e555607b6b03..4e8ded6651f9 100644 --- a/docs/api/web-view-tag.md +++ b/docs/api/web-view-tag.md @@ -237,7 +237,7 @@ Injects CSS into guest page. * `userGesture` Boolean - Default `false`. Evaluates `code` in page. If `userGesture` is set, it will create user gesture -context. HTML API like `requestFullScreen` which require user action can take +context. HTML APIs like `requestFullScreen`, which require user action, can take advantage of this option for automation. ### `.openDevTools()` From 1e5b7af490855875c68bb8152d6db41c25f25373 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Sun, 30 Aug 2015 22:30:01 -0700 Subject: [PATCH 1032/1293] Standardize atom vs nw --- docs/development/atom-shell-vs-node-webkit.md | 27 +++++++++---------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/docs/development/atom-shell-vs-node-webkit.md b/docs/development/atom-shell-vs-node-webkit.md index ab8f6ab6dbdc..c1fffa304ab5 100644 --- a/docs/development/atom-shell-vs-node-webkit.md +++ b/docs/development/atom-shell-vs-node-webkit.md @@ -1,18 +1,18 @@ -# Technical differences to NW.js (formerly node-webkit) +# Technical Differences Between Electron and NW.js (formerly node-webkit) __Note: Electron was previously named Atom Shell.__ Like NW.js, Electron provides a platform to write desktop applications -with JavaScript and HTML and has Node integration to grant access to low level -system in web pages. +with JavaScript and HTML and has Node integration to grant access to the low +level system from web pages. But there are also fundamental differences between the two projects that make Electron a completely separate product from NW.js: -__1. Entry of application__ +__1. Entry of Application__ -In NW.js, the main entry of an application is a web page. You specify a -main page in the `package.json` and it is opened in a browser window as +In NW.js the main entry point of an application is a web page. You specify a +main page URL in the `package.json` and it is opened in a browser window as the application's main window. In Electron, the entry point is a JavaScript script. Instead of @@ -23,19 +23,18 @@ to decide when to quit the application. Electron works more like the Node.js runtime. Electron's APIs are lower level so you can use it for browser testing in place of [PhantomJS](http://phantomjs.org/). -__2. Build system__ +__2. Build System__ -In order to avoid the complexity of building the whole Chromium, Electron uses -[libchromiumcontent](https://github.com/brightray/libchromiumcontent) to access -Chromium's Content API. libchromiumcontent is a single, shared library that -includes the Chromium Content module and all its dependencies. Users don't +In order to avoid the complexity of building all of Chromium, Electron uses [`libchromiumcontent`](https://github.com/brightray/libchromiumcontent) to access +Chromium's Content API. `libchromiumcontent` is a single shared library that +includes the Chromium Content module and all of its dependencies. Users don't need a powerful machine to build Electron. -__3. Node integration__ +__3. Node Integration__ In NW.js, the Node integration in web pages requires patching Chromium to -work, while in Electron we chose a different way to integrate libuv loop with -each platform's message loop to avoid hacking Chromium. See the +work, while in Electron we chose a different way to integrate the libuv loop +with each platform's message loop to avoid hacking Chromium. See the [`node_bindings`](../../atom/common/) code for how that was done. __4. Multi-context__ From 22062798461f4a9ac0f0613aa13474abbc18376c Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Sun, 30 Aug 2015 22:30:12 -0700 Subject: [PATCH 1033/1293] Standardize build linux --- docs/development/build-instructions-linux.md | 40 ++++++++++---------- 1 file changed, 21 insertions(+), 19 deletions(-) diff --git a/docs/development/build-instructions-linux.md b/docs/development/build-instructions-linux.md index 0e15252ca41f..d715c7344cf0 100644 --- a/docs/development/build-instructions-linux.md +++ b/docs/development/build-instructions-linux.md @@ -1,15 +1,17 @@ -# Build instructions (Linux) +# Build Instructions (Linux) + +Follow the guidelines below for building Electron on Linux. ## Prerequisites * Python 2.7.x. Some distributions like CentOS still use Python 2.6.x -so you may need to check your Python version with `python -V`. -* Node.js v0.12.x. There are various ways to install Node. One can download -source code from [Node.js] (http://nodejs.org) and compile from source. -Doing so permits installing Node to your own home directory as a standard user. -Or try repositories such as [NodeSource] (https://nodesource.com/blog/nodejs-v012-iojs-and-the-nodesource-linux-repositories) -* Clang 3.4 or later -* Development headers of GTK+ and libnotify + so you may need to check your Python version with `python -V`. +* Node.js v0.12.x. There are various ways to install Node. You can download + source code from [Node.js](http://nodejs.org) and compile from source. + Doing so permits installing Node on your own home directory as a standard user. + Or try repositories such as [NodeSource](https://nodesource.com/blog/nodejs-v012-iojs-and-the-nodesource-linux-repositories). +* Clang 3.4 or later. +* Development headers of GTK+ and libnotify. On Ubuntu, install the following libraries: @@ -21,14 +23,14 @@ $ sudo apt-get install build-essential clang libdbus-1-dev libgtk2.0-dev \ ``` Other distributions may offer similar packages for installation via package -managers such as yum. Or one can compile from source code. +managers such as `yum`. Or you can compile from source code. ## If You Use Virtual Machines For Building -If you plan to build electron on a virtual machine, you will need a fixed-size +If you plan to build Electron on a virtual machine you will need a fixed-size device container of at least 25 gigabytes in size. -## Getting the code +## Getting the Code ```bash $ git clone https://github.com/atom/electron.git @@ -37,8 +39,8 @@ $ git clone https://github.com/atom/electron.git ## Bootstrapping The bootstrap script will download all necessary build dependencies and create -build project files. You must have Python 2.7.x for the script to succeed. -Downloading certain files could take a long time. Notice that we are using +the build project files. You must have Python 2.7.x for the script to succeed. +Downloading certain files can take a long time. Notice that we are using `ninja` to build Electron so there is no `Makefile` generated. ```bash @@ -48,7 +50,7 @@ $ ./script/bootstrap.py -v ### Cross compilation -If you want to build for `arm` target, you should also install following +If you want to build for an `arm` target you should also install the following dependencies: ```bash @@ -82,7 +84,7 @@ $ ./script/create-dist.py This will put a working distribution with much smaller file sizes in the `dist` directory. After running the create-dist.py script, you -may want to remove the 1.3+ gigabyte binary which is still in out/R. +may want to remove the 1.3+ gigabyte binary which is still in `out/R`. You can also build the `Debug` target only: @@ -102,12 +104,12 @@ $ ./script/clean.py ## Troubleshooting -Make sure you have installed all the build dependencies. +Make sure you have installed all of the build dependencies. -### error while loading shared libraries: libtinfo.so.5 +### Error While Loading Shared Libraries: libtinfo.so.5 Prebulit `clang` will try to link to `libtinfo.so.5`. Depending on the host -architecture, symlink to appropriate `libncurses` +architecture, symlink to appropriate `libncurses`: ```bash $ sudo ln -s /usr/lib/libncurses.so.5 /usr/lib/libtinfo.so.5 @@ -115,7 +117,7 @@ $ sudo ln -s /usr/lib/libncurses.so.5 /usr/lib/libtinfo.so.5 ## Tests -Test your changes confirm to the project coding style using: +Test your changes conform to the project coding style using: ```bash $ ./script/cpplint.py From d93b6c1caee38672efe11a7a5b3b47ae25a12f00 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Sun, 30 Aug 2015 22:30:23 -0700 Subject: [PATCH 1034/1293] Standardize build mac --- docs/development/build-instructions-mac.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/development/build-instructions-mac.md b/docs/development/build-instructions-mac.md index af59f996f4a5..a8e59714255e 100644 --- a/docs/development/build-instructions-mac.md +++ b/docs/development/build-instructions-mac.md @@ -1,17 +1,19 @@ -# Build instructions (Mac) +# Build Instructions (Mac) + +Follow the guidelines below for building Electron on Mac. ## Prerequisites * OS X >= 10.8 * [Xcode](https://developer.apple.com/technologies/tools/) >= 5.1 -* [node.js](http://nodejs.org) (external). +* [node.js](http://nodejs.org) (external) -If you are using the python downloaded by Homebrew, you also need to install +If you are using the Python downloaded by Homebrew, you also need to install following python modules: * pyobjc -## Getting the code +## Getting the Code ```bash $ git clone https://github.com/atom/electron.git @@ -20,7 +22,7 @@ $ git clone https://github.com/atom/electron.git ## Bootstrapping The bootstrap script will download all necessary build dependencies and create -build project files. Notice that we're using `ninja` to build Electron so +the build project files. Notice that we're using `ninja` to build Electron so there is no Xcode project generated. ```bash @@ -44,14 +46,14 @@ $ ./script/build.py -c D After building is done, you can find `Electron.app` under `out/D`. -## 32bit support +## 32bit Support -Electron can only be built for 64bit target on OS X, and there is no plan to +Electron can only be built for a 64bit target on OS X and there is no plan to support 32bit OS X in future. ## Tests -Test your changes confirm to the project coding style using: +Test your changes conform to the project coding style using: ```bash $ ./script/cpplint.py From 009e228218f18502641ee642594614660044f0d7 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Sun, 30 Aug 2015 22:30:36 -0700 Subject: [PATCH 1035/1293] Standardize build win --- .../development/build-instructions-windows.md | 42 ++++++++++--------- 1 file changed, 22 insertions(+), 20 deletions(-) diff --git a/docs/development/build-instructions-windows.md b/docs/development/build-instructions-windows.md index 840c809f09a5..82138008197d 100644 --- a/docs/development/build-instructions-windows.md +++ b/docs/development/build-instructions-windows.md @@ -1,29 +1,30 @@ -# Build instructions (Windows) +# Build Instructions (Windows) + +Follow the guidelines below for building Electron on Windows. ## Prerequisites * Windows 7 / Server 2008 R2 or higher * Visual Studio 2013 - [download VS 2013 Community Edition for - free](https://www.visualstudio.com/downloads/download-visual-studio-vs) + free](https://www.visualstudio.com/downloads/download-visual-studio-vs). * [Python 2.7](http://www.python.org/download/releases/2.7/) * [Node.js](http://nodejs.org/download/) -* [git](http://git-scm.com) +* [Git](http://git-scm.com) -If you don't have a Windows installation at the moment, -[modern.ie](https://www.modern.ie/en-us/virtualization-tools#downloads) has -timebombed versions of Windows that you can use to build Electron. +If you don't currently have a Windows installation, [modern.ie](https://www.modern.ie/en-us/virtualization-tools#downloads) +has timebombed versions of Windows that you can use to build Electron. -The building of Electron is done entirely with command-line scripts, so you -can use any editor you like to develop Electron, but it also means you can -not use Visual Studio for the development. Support of building with Visual -Studio will come in the future. +Building Electron is done entirely with command-line scripts and cannot be done +with Visual Studio. You can develop Electron with any editor but support for +building with Visual Studio will come in the future. **Note:** Even though Visual Studio is not used for building, it's still **required** because we need the build toolchains it provides. -**Note:** Visual Studio 2015 will not work. Please make sure to get MSVS **2013**. +**Note:** Visual Studio 2015 will not work. Please make sure to get MSVS +**2013**. -## Getting the code +## Getting the Code ```powershell git clone https://github.com/atom/electron.git @@ -32,7 +33,7 @@ git clone https://github.com/atom/electron.git ## Bootstrapping The bootstrap script will download all necessary build dependencies and create -build project files. Notice that we're using `ninja` to build Electron so +the build project files. Notice that we're using `ninja` to build Electron so there is no Visual Studio project generated. ```powershell @@ -57,7 +58,7 @@ python script\build.py -c D After building is done, you can find `electron.exe` under `out\D` (debug target) or under `out\R` (release target). -## 64bit build +## 64bit Build To build for the 64bit target, you need to pass `--target_arch=x64` when running the bootstrap script: @@ -70,7 +71,7 @@ The other building steps are exactly the same. ## Tests -Test your changes confirm to the project coding style using: +Test your changes conform to the project coding style using: ```powershell python script\cpplint.py @@ -83,7 +84,8 @@ python script\test.py ``` Tests that include native modules (e.g. `runas`) can't be executed with the -debug build (see #2558 for details), but they will work with the release build. +debug build (see [#2558](https://github.com/atom/electron/issues/2558) for +details), but they will work with the release build. To run the tests with the release build use: @@ -122,9 +124,9 @@ Traceback (most recent call last): subprocess.CalledProcessError: Command '['npm.cmd', 'install']' returned non-zero exit status 3 ``` -This is caused by a bug when using Cygwin python and Win32 node together. The -solution is to use the Win32 python to execute the bootstrap script (supposing -you have installed python under `C:\Python27`): +This is caused by a bug when using Cygwin Python and Win32 Node together. The +solution is to use the Win32 Python to execute the bootstrap script (assuming +you have installed Python under `C:\Python27`): ```bash /cygdrive/c/Python27/python.exe script/bootstrap.py @@ -132,7 +134,7 @@ you have installed python under `C:\Python27`): ### LNK1181: cannot open input file 'kernel32.lib' -Try reinstalling 32bit node.js. +Try reinstalling 32bit Node.js. ### Error: ENOENT, stat 'C:\Users\USERNAME\AppData\Roaming\npm' From 842ba6aea64af2ddd0232f792eb3e31f8bd347dd Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Sun, 30 Aug 2015 22:31:07 -0700 Subject: [PATCH 1036/1293] Standardize overview --- docs/development/build-system-overview.md | 59 ++++++++++++----------- 1 file changed, 30 insertions(+), 29 deletions(-) diff --git a/docs/development/build-system-overview.md b/docs/development/build-system-overview.md index 59510f437f8b..856c53273ff2 100644 --- a/docs/development/build-system-overview.md +++ b/docs/development/build-system-overview.md @@ -1,71 +1,72 @@ -# Build system overview +# Build System Overview -Electron uses `gyp` for project generation, and `ninja` for building, project -configurations can be found in `.gyp` and `.gypi` files. +Electron uses `gyp` for project generation and `ninja` for building. Project +configurations can be found in the `.gyp` and `.gypi` files. -## Gyp files +## Gyp Files -Following `gyp` files contain the main rules of building Electron: +Following `gyp` files contain the main rules for building Electron: * `atom.gyp` defines how Electron itself is built. * `common.gypi` adjusts the build configurations of Node to make it build together with Chromium. -* `vendor/brightray/brightray.gyp` defines how `brightray` is built, and - includes the default configurations of linking with Chromium. +* `vendor/brightray/brightray.gyp` defines how `brightray` is built and + includes the default configurations for linking with Chromium. * `vendor/brightray/brightray.gypi` includes general build configurations about building. -## Component build +## Component Build -Since Chromium is quite a large project, the final linking stage would take -quite a few minutes, making it hard for development. In order to solve this, -Chromium introduced the "component build", which builds each component as a -separate shared library, making linking very quick but sacrificing file size +Since Chromium is quite a large project, the final linking stage can take +quite a few minutes, which makes it hard for development. In order to solve +this, Chromium introduced the "component build", which builds each component as +a separate shared library, making linking very quick but sacrificing file size and performance. In Electron we took a very similar approach: for `Debug` builds, the binary -will be linked to shared library version of Chromium's components to achieve +will be linked to a shared library version of Chromium's components to achieve fast linking time; for `Release` builds, the binary will be linked to the static library versions, so we can have the best possible binary size and performance. -## Minimal bootstrapping +## Minimal Bootstrapping -All of Chromium's prebuilt binaries(libchromiumcontent) are downloaded when +All of Chromium's prebuilt binaries (`libchromiumcontent`) are downloaded when running the bootstrap script. By default both static libraries and shared libraries will be downloaded and the final size should be between 800MB and 2GB -according to the platform. +depending on the platform. -By default, libchromiumcontent is downloaded from Amazon Web Services. -If the `LIBCHROMIUMCONTENT_MIRROR` environment variable is set, bootrstrap +By default, `libchromiumcontent` is downloaded from Amazon Web Services. +If the `LIBCHROMIUMCONTENT_MIRROR` environment variable is set, the bootstrap script will download from it. -[libchromiumcontent-qiniu-mirror](https://github.com/hokein/libchromiumcontent-qiniu-mirror) -is a mirror for libchromiumcontent. If you have trouble in accessing AWS, you can -switch download address to it via `export LIBCHROMIUMCONTENT_MIRROR=http://7xk3d2.dl1.z0.glb.clouddn.com/` +[`libchromiumcontent-qiniu-mirror`](https://github.com/hokein/libchromiumcontent-qiniu-mirror) +is a mirror for `libchromiumcontent`. If you have trouble in accessing AWS, you +can switch the download address to it via +`export LIBCHROMIUMCONTENT_MIRROR=http://7xk3d2.dl1.z0.glb.clouddn.com/` If you only want to build Electron quickly for testing or development, you -can only download the shared library versions by passing the `--dev` parameter: +can download just the shared library versions by passing the `--dev` parameter: ```bash $ ./script/bootstrap.py --dev $ ./script/build.py -c D ``` -## Two-phrase project generation +## Two-Phrase Project Generation Electron links with different sets of libraries in `Release` and `Debug` -builds, however `gyp` doesn't support configuring different link settings for +builds. `gyp`, however, doesn't support configuring different link settings for different configurations. To work around this Electron uses a `gyp` variable -`libchromiumcontent_component` to control which link settings to use, and only +`libchromiumcontent_component` to control which link settings to use and only generates one target when running `gyp`. -## Target names +## Target Names Unlike most projects that use `Release` and `Debug` as target names, Electron uses `R` and `D` instead. This is because `gyp` randomly crashes if there is -only one `Release` or `Debug` build configuration is defined, and Electron has -to only generate one target for one time as stated above. +only one `Release` or `Debug` build configuration defined, and Electron only has +to generate one target at a time as stated above. -This only affects developers, if you are only building Electron for rebranding +This only affects developers, if you are just building Electron for rebranding you are not affected. From e0542945ce101cf67abf32dbbf7e7b1c48405be2 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Sun, 30 Aug 2015 22:31:14 -0700 Subject: [PATCH 1037/1293] Standardize code style --- docs/development/coding-style.md | 32 +++++++++++++++++--------------- 1 file changed, 17 insertions(+), 15 deletions(-) diff --git a/docs/development/coding-style.md b/docs/development/coding-style.md index 7b72174c6be1..a86ee32417db 100644 --- a/docs/development/coding-style.md +++ b/docs/development/coding-style.md @@ -1,35 +1,37 @@ -# Coding style +# Coding Style + +These are the style guidelines for coding in Electron. ## C++ and Python -For C++ and Python, we just follow Chromium's [Coding -Style](http://www.chromium.org/developers/coding-style), there is also a -script `script/cpplint.py` to check whether all files confirm. +For C++ and Python, we follow Chromium's [Coding +Style](http://www.chromium.org/developers/coding-style). There is also a +script `script/cpplint.py` to check whether all files conform. -The python's version we are using now is Python 2.7. +The Python version we are using now is Python 2.7. -The C++ code uses a lot of Chromium's abstractions and types, so it's -recommended to get acquainted with them. A good place to start is -Chromium's [Important Abstractions and Data Structures] -(https://www.chromium.org/developers/coding-style/important-abstractions-and-data-structures) -document. The document mentions some special types, scoped types (that -automatically release their memory when going out of scope), logging mechanisms etc. +The C++ code uses a lot of Chromium's abstractions and types, so it's +recommended to get acquainted with them. A good place to start is +Chromium's [Important Abstractions and Data Structures](https://www.chromium.org/developers/coding-style/important-abstractions-and-data-structures) +document. The document mentions some special types, scoped types (that +automatically release their memory when going out of scope), logging mechanisms +etc. ## CoffeeScript For CoffeeScript, we follow GitHub's [Style -Guide](https://github.com/styleguide/javascript), and also following rules: +Guide](https://github.com/styleguide/javascript) and the following rules: * Files should **NOT** end with new line, because we want to match Google's styles. * File names should be concatenated with `-` instead of `_`, e.g. `file-name.coffee` rather than `file_name.coffee`, because in [github/atom](https://github.com/github/atom) module names are usually in - the `module-name` form, this rule only applies to `.coffee` files. + the `module-name` form. This rule only applies to `.coffee` files. ## API Names When creating a new API, we should prefer getters and setters instead of -jQuery's one-function style, for example, `.getText()` and `.setText(text)` +jQuery's one-function style. For example, `.getText()` and `.setText(text)` are preferred to `.text([text])`. There is a -[discussion](https://github.com/atom/electron/issues/46) of this. +[discussion](https://github.com/atom/electron/issues/46) on this. From 29c865f0e1408aa9c63f673ab91a15a31cde1006 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Sun, 30 Aug 2015 22:31:25 -0700 Subject: [PATCH 1038/1293] Standardize symbol server --- docs/development/setting-up-symbol-server.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/development/setting-up-symbol-server.md b/docs/development/setting-up-symbol-server.md index 3149755b98de..1dc31f7056d2 100644 --- a/docs/development/setting-up-symbol-server.md +++ b/docs/development/setting-up-symbol-server.md @@ -1,4 +1,4 @@ -# Setting up symbol server in debugger +# Setting Up Symbol Server in Debugger Debug symbols allow you to have better debugging sessions. They have information about the functions contained in executables and dynamic libraries and provide @@ -16,16 +16,16 @@ unoptimized local build. The official symbol server URL for Electron is http://54.249.141.255:8086/atom-shell/symbols. -You cannot visit this URL directly: you must add it to the symbol path of your +You cannot visit this URL directly, you must add it to the symbol path of your debugging tool. In the examples below, a local cache directory is used to avoid -repeatedly fetching the PDB from the server. Replace `c:\code\symbols` with an +repeatedly fetching the PDB from the server. Replace `c:\code\symbols` with an appropriate cache directory on your machine. -## Using the symbol server in Windbg +## Using the Symbol Server in Windbg The Windbg symbol path is configured with a string value delimited with asterisk characters. To use only the Electron symbol server, add the following entry to -your symbol path (__note:__ you can replace `c:\code\symbols` with any writable +your symbol path (__Note:__ you can replace `c:\code\symbols` with any writable directory on your computer, if you'd prefer a different location for downloaded symbols): From 2c79e9fd41986b4c553ac3c6b78fd4bebc3a368f Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Sun, 30 Aug 2015 22:31:43 -0700 Subject: [PATCH 1039/1293] Standardize dir structure --- .../development/source-code-directory-structure.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/docs/development/source-code-directory-structure.md b/docs/development/source-code-directory-structure.md index 486f553ab604..4b2c29d3e497 100644 --- a/docs/development/source-code-directory-structure.md +++ b/docs/development/source-code-directory-structure.md @@ -1,15 +1,13 @@ -# Source code directory structure +# Source Code Directory Structure -## Overview - -The source code of Electron is separated into a few parts, and we are mostly +The source code of Electron is separated into a few parts, mostly following Chromium on the separation conventions. You may need to become familiar with [Chromium's multi-process architecture](http://dev.chromium.org/developers/design-documents/multi-process-architecture) to understand the source code better. -## Structure of source code +## Structure of Source Code * **atom** - Source code of Electron. * **app** - System entry code. @@ -45,18 +43,18 @@ to understand the source code better. * **common.gypi** - Compiler specific settings and building rules for other components like `node` and `breakpad`. -## Structure of other directories +## Structure of Other Directories * **script** - Scripts used for development purpose like building, packaging, testing, etc. * **tools** - Helper scripts used by gyp files, unlike `script`, scripts put here should never be invoked by users directly. * **vendor** - Source code of third party dependencies, we didn't use - `third_party` as name because it would confuse with the same directory in + `third_party` as name because it would confuse it with the same directory in Chromium's source code tree. * **node_modules** - Third party node modules used for building. * **out** - Temporary output directory of `ninja`. * **dist** - Temporary directory created by `script/create-dist.py` script when creating an distribution. * **external_binaries** - Downloaded binaries of third-party frameworks which - do not support to be built via `gyp`. + do not support building with `gyp`. From c67268a74f088354e8ed4f9e2d7880120af3c690 Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Mon, 31 Aug 2015 14:48:47 +0900 Subject: [PATCH 1040/1293] Improve grammar, update as upstream --- README-ko.md | 2 +- docs-translations/ko/README.md | 8 ++- docs-translations/ko/api/clipboard.md | 54 +++++++++-------- docs-translations/ko/api/content-tracing.md | 51 ++++++++-------- docs-translations/ko/api/crash-reporter.md | 59 +++++++++++-------- docs-translations/ko/api/dialog.md | 59 ++++++++++--------- docs-translations/ko/api/file-object.md | 7 ++- docs-translations/ko/api/frameless-window.md | 44 +++++++------- docs-translations/ko/api/menu-item.md | 2 +- docs-translations/ko/api/menu.md | 4 +- docs-translations/ko/api/remote.md | 56 ++++++++++++++---- docs-translations/ko/api/web-frame.md | 11 +++- docs-translations/ko/api/window-open.md | 6 +- .../development/build-instructions-windows.md | 9 +++ .../development/setting-up-symbol-server.md | 2 +- docs-translations/ko/styleguide.md | 4 +- .../ko/tutorial/application-packaging.md | 2 +- .../ko/tutorial/using-native-node-modules.md | 24 ++++---- docs/api/content-tracing.md | 4 +- 19 files changed, 237 insertions(+), 171 deletions(-) diff --git a/README-ko.md b/README-ko.md index bbe1333cf553..00cfe43732de 100644 --- a/README-ko.md +++ b/README-ko.md @@ -36,7 +36,7 @@ npm install electron-prebuilt --save-dev [Docs](https://github.com/atom/electron/tree/master/docs/README.md)에 개발 가이드와 API 레퍼런스가 있습니다. Electron을 빌드 하는 방법과 프로젝트에 기여하는 방법도 문서에 포함되어 있으니 참고하시기 바랍니다. -## 참조 문서(번역) +## 참조 문서 (번역) - [한국어](https://github.com/atom/electron/tree/master/docs-translations/ko) - [일본어](https://github.com/atom/electron/tree/master/docs-translations/jp) diff --git a/docs-translations/ko/README.md b/docs-translations/ko/README.md index 51bf0a36d07f..89112b11c835 100644 --- a/docs-translations/ko/README.md +++ b/docs-translations/ko/README.md @@ -20,11 +20,11 @@ * [프로세스 객체](api/process.md) * [크롬 Command-Line 스위치 지원](api/chrome-command-line-switches.md) -커스텀 DOM Element: +커스텀 DOM elements: * [`File` 객체](api/file-object.md) * [`` 태그](api/web-view-tag.md) -* [`window.open` 함수](api/window-open.md) +* [`window.open` 메서드](api/window-open.md) 메인 프로세스를 위한 모듈들: @@ -40,6 +40,8 @@ * [power-monitor](api/power-monitor.md) * [power-save-blocker](api/power-save-blocker.md) * [protocol](api/protocol.md) +* [session](api/session.md) +* [webContents](api/web-contents.md) * [tray](api/tray.md) 랜더러 프로세스를 위한 모듈들 (웹 페이지): @@ -60,7 +62,7 @@ * [코딩 스타일](development/coding-style.md) * [소스 코드 디렉터리 구조](development/source-code-directory-structure.md) -* [NW.js와 기술적으로 다른점 (이전 node-webkit)](development/atom-shell-vs-node-webkit.md) +* [NW.js(node-webkit)와 기술적으로 다른점](development/atom-shell-vs-node-webkit.md) * [빌드 시스템 개요](development/build-system-overview.md) * [빌드 설명서 (Mac)](development/build-instructions-mac.md) * [빌드 설명서 (Windows)](development/build-instructions-windows.md) diff --git a/docs-translations/ko/api/clipboard.md b/docs-translations/ko/api/clipboard.md index a6b29c2a377f..5143a4c3b113 100644 --- a/docs-translations/ko/api/clipboard.md +++ b/docs-translations/ko/api/clipboard.md @@ -1,6 +1,6 @@ # clipboard -`clipboard`는 복사/붙여넣기 작업을 수행하는 방법을 제공합니다. 다음 예제는 클립보드에 문자열을 씁니다: +`clipboard` 모듈은 복사/붙여넣기 작업을 수행하는 방법을 제공합니다. 다음 예제는 클립보드에 문자열을 씁니다: ```javascript var clipboard = require('clipboard'); @@ -15,59 +15,65 @@ clipboard.writeText('Example String', 'selection'); console.log(clipboard.readText('selection')); ``` -## clipboard.readText([type]) +## Methods -* `type` String +`clipboard` 모듈은 다음과 같은 메서드를 가지고 있습니다: + +**알림:** Experimental 마크가 붙은 API는 실험적인 기능이며 차후 최신 버전에서 제거될 수 있습니다. + +### `clipboard.readText([type])` + +* `type` String (optional) 클립보드 컨텐츠를 `plain text`로 반환합니다. -## clipboard.writeText(text[, type]) +### `clipboard.writeText(text[, type])` * `text` String -* `type` String +* `type` String (optional) 클립보드에 `plain text`로 문자열을 씁니다. -## clipboard.readHtml([type]) +### `clipboard.readHtml([type])` -* `type` String +* `type` String (optional) 클립보드 컨텐츠를 `markup`으로 반환합니다. -## clipboard.writeHtml(markup[, type]) +### `clipboard.writeHtml(markup[, type])` * `markup` String -* `type` String +* `type` String (optional) 클립보드에 `markup`으로 씁니다. -## clipboard.readImage([type]) +### `clipboard.readImage([type])` -* `type` String +* `type` String (optional) 클립보드로부터 [NativeImage](native-image.md)로 이미지를 읽어들입니다. -## clipboard.writeImage(image[, type]) +### `clipboard.writeImage(image[, type])` * `image` [NativeImage](native-image.md) -* `type` String +* `type` String (optional) 클립보드에 `image`를 씁니다. -## clipboard.clear([type]) +### `clipboard.clear([type])` -* `type` String +* `type` String (optional) 클립보드에 저장된 모든 컨텐츠를 삭제합니다. -## clipboard.availableFormats([type]) +### clipboard.availableFormats([type]) 클립보드의 `type`에 해당하는 지원하는 `format`을 문자열로 반환합니다. -## clipboard.has(data[, type]) +### `clipboard.has(data[, type])` * `data` String -* `type` String +* `type` String (optional) 클립보드가 지정한 `data`의 형식을 지원하는지 확인합니다. @@ -76,24 +82,20 @@ var clipboard = require('clipboard'); console.log(clipboard.has('

selection

')); ``` -**알림:** 이 API는 실험적인 기능이며 차후 최신버전에서 제외될 수 있습니다. - -## clipboard.read(data[, type]) +### `clipboard.read(data[, type])` _Experimental_ * `data` String -* `type` String +* `type` String (optional) 클립보드로부터 `data`를 읽어들입니다. -**알림:** 이 API는 실험적인 기능이며 차후 최신버전에서 제외될 수 있습니다. - -## clipboard.write(data[, type]) +### `clipboard.write(data[, type])` _Experimental_ * `data` Object * `text` String * `html` String * `image` [NativeImage](native-image.md) -* `type` String +* `type` String (optional) ```javascript var clipboard = require('clipboard'); diff --git a/docs-translations/ko/api/content-tracing.md b/docs-translations/ko/api/content-tracing.md index 1ec019d92831..f6010d156f6a 100644 --- a/docs-translations/ko/api/content-tracing.md +++ b/docs-translations/ko/api/content-tracing.md @@ -1,30 +1,35 @@ -# content-tracing +# contentTracing -`content-trace` 모듈은 Chromium 컨텐츠 모듈단에서 생성된 데이터를 수집하고 추적하는데 사용됩니다. +`content-tracing` 모듈은 Chromium 컨텐츠 모듈단에서 생성된 데이터를 수집하고 추적하는데 사용됩니다. 이 모듈은 웹 인터페이스를 포함하고 있지 않으며 크롬 브라우저에서 `chrome://tracing/` 페이지를 열어 생성된 파일을 로드하면 결과를 볼 수 있습니다. ```javascript -var tracing = require('content-tracing'); -tracing.startRecording('*', tracing.DEFAULT_OPTIONS, function() { +var contentTracing = require('content-tracing'); + +contentTracing.startRecording('*', contentTracing.DEFAULT_OPTIONS, function() { console.log('Tracing started'); setTimeout(function() { - tracing.stopRecording('', function(path) { + contentTracing.stopRecording('', function(path) { console.log('Tracing data recorded to ' + path); }); }, 5000); }); -``` +`` -## tracing.getCategories(callback) +## Methods + +`content-tracing` 모듈은 다음과 같은 메서드를 가지고 있습니다: + +### `contentTracing.getCategories(callback)` * `callback` Function 카테고리 그룹 세트를 가져옵니다. 카테고리 그룹은 도달된 코드 경로를 변경할 수 있습니다. -모든 child 프로세스가 `getCategories` 요청을 받으면 `callback`이 호출되며 인자에 카테고리 그룹의 배열이 전달됩니다. +모든 child 프로세스가 `getCategories` 요청을 승인하면 `callback`이 한 번 호출되며 인자에 카테고리 그룹의 배열이 전달됩니다. -## tracing.startRecording(categoryFilter, traceOptions, callback) +### `contentTracing.startRecording(categoryFilter, traceOptions, callback)` * `categoryFilter` String * `traceOptions` String @@ -33,7 +38,7 @@ tracing.startRecording('*', tracing.DEFAULT_OPTIONS, function() { 모든 프로세스에서 레코딩을 시작합니다. 레코딩은 지역적으로 즉시 실행됩니다. 그리고 비동기로 child 프로세스는 곧 EnableRecording 요청을 받게 됩니다. -모든 child 프로세스가 `startRecording` 요청을 받으면 `callback`이 호출됩니다. +모든 child 프로세스가 `startRecording` 요청을 승인하면 `callback`이 한 번 호출됩니다. `categoryFilter`는 어떤 카테고리 그룹이 트레이싱 되어야 하는지 필터링할 수 있습니다. 필터는 `-` 접두사를 통해 특정 카테고리 그룹을 제외할 수 있습니다. @@ -63,7 +68,7 @@ tracing.startRecording('*', tracing.DEFAULT_OPTIONS, function() { `record-until-full`이 기본 모드, `enable-sampling`과 `enable-systrace`옵션은 포함되지 않음 -## tracing.stopRecording(resultFilePath, callback) +## `contentTracing.stopRecording(resultFilePath, callback)` * `resultFilePath` String * `callback` Function @@ -75,12 +80,12 @@ Child 프로세스는 일반적으로 추적 데이터와 희귀한 플러시 우리는 추적에 의한 런타임 오버헤드를 피하고자 합니다. 그래서 추적이 끝나면 모든 child 프로세스에 보류된 추적 데이터를 플러시 할 것인지 물어봅니다. -모든 child 프로세스가 `stopRecording` 요청을 받으면 `callback`에 추적 데이터를 포함한 파일을 전달됩니다. +모든 child 프로세스가 `stopRecording` 요청을 승인하면 `callback`에 추적 데이터 파일을 포함하여 한 번 호출됩니다. 추적 데이터는 `resultFilePath` 해당 경로가 비어있는 경우에 한 해 해당 경로에 작성되거나 임시 파일에 작성됩니다. 실제 파일 경로는 null이 아닌 이상 `callback`을 통해 전달됩니다. -## tracing.startMonitoring(categoryFilter, traceOptions, callback) +### `contentTracing.startMonitoring(categoryFilter, traceOptions, callback)` * `categoryFilter` String * `traceOptions` String @@ -90,17 +95,17 @@ Child 프로세스는 일반적으로 추적 데이터와 희귀한 플러시 모니터링은 지역적으로 즉시 시작됩니다. 그리고 이내 자식 프로세스들이 `startMonitoring` 비동기 요청을 받습니다. -모든 자식 프로세스가 `startMonitoring` 요청을 받으면 `callback`이 호출됩니다. +모든 자식 프로세스가 `startMonitoring` 요청을 승인하면 `callback`이 한 번 호출됩니다. -## tracing.stopMonitoring(callback); +### `contentTracing.stopMonitoring(callback)` * `callback` Function 모든 프로세스에서 모니터링을 중단합니다. -모든 자식 프로세스가 `stopMonitoring` 요청을 받으면 `callback`이 호출됩니다. +모든 자식 프로세스가 `stopMonitoring` 요청을 승인하면 `callback`이 한 번 호출됩니다. -## tracing.captureMonitoringSnapshot(resultFilePath, callback) +### `contentTracing.captureMonitoringSnapshot(resultFilePath, callback)` * `resultFilePath` String * `callback` Function @@ -112,15 +117,15 @@ Child 프로세스는 일반적으로 추적 데이터와 희귀한 플러시 그리고 우리는 추적시 발생하는 불필요한 런타임 오버헤드를 피하고자 합니다. 그래서 추적이 끝나면 반드시 비동기로 자식 프로세스들의 보류된 추적 데이터를 플러시 할 것인지 물어봅니다. -모든 자식 프로세스가 `captureMonitoringSnapshot` 요청을 받으면 추적 데이터 파일을 포함하는 `callback`이 호출됩니다. +모든 자식 프로세스가 `captureMonitoringSnapshot` 요청을 승인하면 추적 데이터 파일을 포함하는 `callback`이 한 번 호출됩니다. -## tracing.getTraceBufferUsage(callback) +### `contentTracing.getTraceBufferUsage(callback)` * `callback` Function -추적 버퍼 % 전체 상태의 프로세스간 최대치를 가져옵니다. TraceBufferUsage 값이 결정되면 `callback`이 호출됩니다. +추적 버퍼 % 전체 상태의 프로세스간 최대치를 가져옵니다. TraceBufferUsage 값이 결정되면 `callback`이 한 번 호출됩니다. -## tracing.setWatchEvent(categoryName, eventName, callback) +### `contentTracing.setWatchEvent(categoryName, eventName, callback)` * `categoryName` String * `eventName` String @@ -128,6 +133,6 @@ Child 프로세스는 일반적으로 추적 데이터와 희귀한 플러시 `callback`은 지정된 이벤트가 어떤 작업을 발생시킬 때마다 호출됩니다. -## tracing.cancelWatchEvent() +### `contentTracing.cancelWatchEvent()` -Watch 이벤트를 중단합니다. 만약 추적이 활성화되어 있다면 이 함수는 watch 이벤트 콜백과 race가 일어날 것입니다. +Watch 이벤트를 중단합니다. 만약 추적이 활성화되어 있다면 이 메서드는 watch 이벤트 콜백과 race가 일어날 것입니다. diff --git a/docs-translations/ko/api/crash-reporter.md b/docs-translations/ko/api/crash-reporter.md index b8c076a7ceae..53b5d3b7924c 100644 --- a/docs-translations/ko/api/crash-reporter.md +++ b/docs-translations/ko/api/crash-reporter.md @@ -1,9 +1,12 @@ -# crash-reporter +# crashReporter -다음 예제는 윈격 서버에 어플리케이션 오류 정보를 자동으로 보고하는 예제입니다: +`crash-reporter` 모듈은 어플리케이션의 크래시 정보를 자동으로 원격 서버에 업로드하는데 사용합니다. + +다음 예제는 윈격 서버에 어플리케이션 크래시 정보를 자동으로 보고하는 예제입니다: ```javascript -crashReporter = require('crash-reporter'); +var crashReporter = require('crash-reporter'); + crashReporter.start({ productName: 'YourName', companyName: 'YourCompany', @@ -12,38 +15,42 @@ crashReporter.start({ }); ``` -## crashReporter.start(options) +## Methods -* `options` Object - * `productName` String, 기본값: Electron - * `companyName` String, 기본값: GitHub, Inc - * `submitUrl` String, 기본값: http://54.249.141.255:1127/post - * Crash Reporter는 POST 방식으로 해당 URL에 전송됩니다. - * `autoSubmit` Boolean, 기본값: true - * true로 지정할 경우 유저의 승인 없이 자동으로 오류를 보고합니다. - * `ignoreSystemCrashHandler` Boolean, 기본값: false - * `extra` Object - * 오류보고 시 같이 보낼 추가 정보를 지정하는 객체입니다. - * 문자열로 된 속성만 정상적으로 보내집니다. - * 중첩 객체는 지원되지 않습니다. (Nested objects are not supported) +`crash-reporter` 모듈은 다음과 같은 메서드를 가지고 있습니다: + +### `crashReporter.start(options)` + +* `options` Object, properties: + +* `productName` String, 기본값: Electron +* `companyName` String, 기본값: GitHub, Inc +* `submitUrl` String, 기본값: http://54.249.141.255:1127/post + * 크래시 리포트는 POST 방식으로 이 URL로 전송됩니다. +* `autoSubmit` Boolean, 기본값: true + * true로 지정할 경우 유저의 승인 없이 자동으로 오류를 보고합니다. +* `ignoreSystemCrashHandler` Boolean, 기본값: false +* `extra` Object + * 크래시 리포트 시 같이 보낼 추가 정보를 지정하는 객체입니다. + * 문자열로 된 속성만 정상적으로 보내집니다. + * 중첩 객체는 지원되지 않습니다. (Nested objects are not supported) -다른 crashReporter API들을 사용하기 전에 이 함수를 먼저 호출해야 합니다. - +다른 crashReporter API를 사용하기 전에 이 메서드를 먼저 호출해야 합니다. **알림:** OS X에선 Windows와 Linux의 `breakpad`와 달리 새로운 `crashpad` 클라이언트를 사용합니다. 오류 수집 기능을 활성화 시키려면 오류를 수집하고 싶은 메인 프로세스나 랜더러 프로세스에서 -`crashReporter.start` 함수를 호출하여 `crashpad`를 초기화 해야합니다. +`crashReporter.start` 메서드를 호출하여 `crashpad`를 초기화 해야합니다. -## crashReporter.getLastCrashReport() +### `crashReporter.getLastCrashReport()` -마지막 오류보고의 날짜와 ID를 반환합니다. -이전 오류보고가 없거나 Crash Reporter가 시작되지 않았을 경우 `null`이 반환됩니다. +마지막 크래시 리포트의 날짜와 ID를 반환합니다. +이전 크래시 리포트가 없거나 Crash Reporter가 시작되지 않았을 경우 `null`이 반환됩니다. -## crashReporter.getUploadedReports() +### `crashReporter.getUploadedReports()` -모든 업로드된 오류보고를 반환합니다. 각 보고는 날짜와 업로드 ID를 포함하고 있습니다. +모든 업로드된 크래시 리포트를 반환합니다. 각 보고는 날짜와 업로드 ID를 포함하고 있습니다. -# crash-reporter 오류보고 형식 +## crash-reporter 업로드 형식 Crash Reporter는 다음과 같은 데이터를 `submitUrl`에 `POST` 방식으로 전송합니다: @@ -56,5 +63,5 @@ Crash Reporter는 다음과 같은 데이터를 `submitUrl`에 `POST` 방식으 * `_productName` String - Crash Reporter의 `options` 객체에서 정의한 제품명. * `prod` String - 기본 제품의 이름. 이 경우 Electron으로 표시됩니다. * `_companyName` String - Crash Reporter의 `options` 객체에서 정의한 회사명. -* `upload_file_minidump` File - 오류보고 파일 +* `upload_file_minidump` File - 크래시 리포트 파일 * Crash Reporter의 `options` 객체에서 정의한 `extra` 객체의 속성들. diff --git a/docs-translations/ko/api/dialog.md b/docs-translations/ko/api/dialog.md index 4f151f0b1ebb..0c8bdec74a66 100644 --- a/docs-translations/ko/api/dialog.md +++ b/docs-translations/ko/api/dialog.md @@ -1,34 +1,39 @@ # dialog -`dialog` 모듈은 네이티브 시스템의 대화 상자를 조작할 때 사용할 수 있는 API입니다. -웹 어플리케이션에서 일반 네이티브 어플리케이션과 같은 사용자 경험을 제공할 수 있습니다. +`dialog` 모듈은 파일 열기, 알림과 같은 네이티브 시스템의 대화 상자를 조작할 때 사용할 수 있는 모듈입니다. +이 모듈을 사용하면 웹 어플리케이션에서 일반 네이티브 어플리케이션과 비슷한 사용자 경험을 제공할 수 있습니다. 다음 예제는 파일과 디렉터리를 다중으로 선택하는 대화 상자를 표시하는 예제입니다: ```javascript -var win = ...; // 대화 상자를 사용할 창 객체 +var win = ...; // 대화 상자를 사용할 BrowserWindow 객체 var dialog = require('dialog'); console.log(dialog.showOpenDialog({ properties: [ 'openFile', 'openDirectory', 'multiSelections' ]})); ``` -**OS X 주의**: 대화 상자를 시트처럼 보여지게 하려면 `browserWindow` 인자에 `BrowserWindow` 객체의 참조를 제공하면 됩니다. +**OS X 알림**: 대화 상자를 시트처럼 보여지게 하려면 `browserWindow` 인자에 `BrowserWindow` 객체의 참조를 제공하면 됩니다. -## dialog.showOpenDialog([browserWindow], [options], [callback]) +## Methods -* `browserWindow` BrowserWindow -* `options` Object +`dialog` 모듈은 다음과 같은 메서드를 가지고 있습니다: + +### `dialog.showOpenDialog([browserWindow][, options][, callback])` + +* `browserWindow` BrowserWindow (optional) +* `options` Object (optional) * `title` String * `defaultPath` String * `filters` Array * `properties` Array - 대화 상자가 사용할 기능(모드)이 담긴 배열입니다. 다음을 포함할 수 있습니다: `openFile`, `openDirectory`, `multiSelections`, `createDirectory` -* `callback` Function +* `callback` Function (optional) 사용할 대화 상자의 기능이 담긴 배열입니다. 다음을 포함할 수 있습니다: `openFile`, `openDirectory`, `multiSelections`, `createDirectory` -작업에 성공하면 유저가 선택한 파일의 경로를 포함한 배열을 반환합니다. 그 외의 경우엔 `undefined`를 반환합니다. +작업에 성공하면 콜백으로 유저가 선택한 파일의 경로를 포함한 배열을 반환합니다. 그 외엔 `undefined`를 반환합니다. -`filters`를 지정하면 유저가 선택 가능한 파일 형식을 지정할 수 있습니다. 예제는 다음과 같습니다: +`filters`를 지정하면 유저가 선택 가능한 파일 형식을 지정할 수 있습니다. +유저가 선택할 수 있는 타입에 제한을 두려면 다음과 같이 할 수 있습니다: ```javascript { @@ -42,32 +47,30 @@ console.log(dialog.showOpenDialog({ properties: [ 'openFile', 'openDirectory', ' ``` `extensions` 배열은 반드시 와일드카드와 마침표를 제외한 파일 확장자를 포함시켜야 합니다. -예를 들어 `'png'`는 가능하지만 `'.png'`와 `'*.png'`는 안됩니다. +(예를 들어 `'png'`는 가능하지만 `'.png'`와 `'*.png'`는 안됩니다) 모든 파일을 보여주려면 `'*'`와 같은 와일드카드를 사용하면 됩니다. (다른 와일드카드는 지원하지 않습니다) `callback`이 전달되면 메소드가 비동기로 작동되며 결과는 `callback(filenames)`을 통해 전달됩니다. -Windows와 Linux에선 파일 선택 모드, 디렉터리 선택 모드를 동시에 사용할 수 없습니다. -그래서 이 두 플랫폼에선 `properties`를 `['openFile', 'openDirectory']`로 설정하면 디렉터리 선택 대화 상자가 표시됩니다. +**알림:** Windows와 Linux에선 파일 선택 모드, 디렉터리 선택 모드를 동시에 사용할 수 없습니다. +이러한 이유로 `properties`를 `['openFile', 'openDirectory']`로 설정하면 디렉터리 선택 대화 상자가 표시됩니다. -## dialog.showSaveDialog([browserWindow], [options], [callback]) +### `dialog.showSaveDialog([browserWindow][, options][, callback])` -* `browserWindow` BrowserWindow -* `options` Object +* `browserWindow` BrowserWindow (optional) +* `options` Object (optional) * `title` String * `defaultPath` String * `filters` Array -* `callback` Function +* `callback` Function (optional) -작업에 성공하면 - -작업에 성공하면 유저가 선택한 파일의 경로를 포함한 배열을 반환합니다. 그 외의 경우엔 `undefined`를 반환합니다. +작업에 성공하면 콜백으로 유저가 선택한 파일의 경로를 포함한 배열을 반환합니다. 그 외엔 `undefined`를 반환합니다. `filters`를 지정하면 유저가 저장 가능한 파일 형식을 지정할 수 있습니다. 사용 방법은 `dialog.showOpenDialog`의 `filters` 속성과 같습니다. `callback`이 전달되면 메소드가 비동기로 작동되며 결과는 `callback(filename)`을 통해 전달됩니다. -## dialog.showMessageBox([browserWindow], options, [callback]) +### `dialog.showMessageBox([browserWindow][, options][, callback])` * `browserWindow` BrowserWindow * `options` Object @@ -78,26 +81,26 @@ Windows와 Linux에선 파일 선택 모드, 디렉터리 선택 모드를 동 * `message` String - 대화 상자의 본문 내용입니다. * `detail` String - 메시지의 추가 정보입니다. * `icon` [NativeImage](native-image.md) - * `cancelId` Integer - 유저가 대화 상자의 버튼을 클릭하지 않고 대화 상자를 취소했을 때 반환되는 버튼의 index입니다. - 기본적으로 버튼 리스트가 "cancel" 또는 "no" 라벨을 가지고 있을 때 해당 버튼의 index를 반환합니다. 따로 두 라벨이 지정되지 않은 경우 0을 반환합니다. + * `cancelId` Integer - 유저가 대화 상자의 버튼을 클릭하지 않고 대화 상자를 취소했을 때 반환되는 버튼의 인덱스입니다. + 기본적으로 버튼 리스트가 "cancel" 또는 "no" 라벨을 가지고 있을 때 해당 버튼의 인덱스를 반환합니다. 따로 두 라벨이 지정되지 않은 경우 0을 반환합니다. OS X와 Windows에선 `cancelId` 지정 여부에 상관없이 "Cancel" 버튼이 언제나 `cancelId`로 지정됩니다. * `noLink` Boolean - Windows Electron은 "Cancel"이나 "Yes"와 같은 흔히 사용되는 버튼을 찾으려고 시도하고 대화 상자 내에서 해당 버튼을 커맨드 링크처럼 만듭니다. 이 기능으로 앱을 좀 더 Modern Windows 앱처럼 만들 수 있습니다. 이 기능을 원하지 않으면 `noLink`를 true로 지정하면 됩니다. * `callback` Function -대화 상자를 표시합니다. `browserWindow`를 지정하면 대화 상자가 완전히 닫힐 때까지는 창을 사용할 수 없습니다. -완료시 유저가 선택한 버튼의 index를 반환합니다. +대화 상자를 표시합니다. `browserWindow`를 지정하면 대화 상자가 완전히 닫힐 때까지 지정한 창을 사용할 수 없습니다. +완료 시 유저가 선택한 버튼의 인덱스를 반환합니다. 역주: 부정을 표현하는 "아니오", "취소"와 같은 한글 단어는 지원되지 않습니다. -만약 OS X 또는 Windows에서 "확인", "취소"와 같은 순서로 버튼을 지정하게 될 때 Alt + f4로 해당 대화 상자를 끄게 되면 "확인"을 누른걸로 판단되어 버립니다. +만약 OS X 또는 Windows에서 "확인", "취소"와 같은 순서로 버튼을 지정하게 될 때 Alt + f4로 해당 대화 상자를 끄게 되면 "확인"을 누른 것으로 판단되어 버립니다. 이를 해결하려면 "Cancel"을 대신 사용하거나 BrowserWindow API를 사용하여 대화 상자를 직접 구현해야합니다. `callback`이 전달되면 메소드가 비동기로 작동되며 결과는 `callback(response)`을 통해 전달됩니다. -## dialog.showErrorBox(title, content) +### `dialog.showErrorBox(title, content)` -에러 메시지를 보여주는 모달 대화 상자를 표시합니다. +에러 메시지를 보여주는 대화 상자를 표시합니다. 이 API는 `app` 모듈의 `ready` 이벤트가 발생하기 전에 사용할 수 있습니다. 이 메소드는 보통 어플리케이션이 시작되기 전에 특정한 에러를 표시하기 위해 사용됩니다. diff --git a/docs-translations/ko/api/file-object.md b/docs-translations/ko/api/file-object.md index 470d5a871ccf..6006220647dd 100644 --- a/docs-translations/ko/api/file-object.md +++ b/docs-translations/ko/api/file-object.md @@ -1,9 +1,10 @@ # `File` 객체 -DOM의 File 인터페이스는 네이티브 파일을 추상화 합니다. 유저가 직접적으로 HTML5 File API를 사용하여 작업할 때 파일의 경로를 -알 수 있도록 Electron은 파일시스템의 실제 파일 경로를 담은 `path` 속성을 File 인터페이스에 추가하였습니다. +DOM의 File 인터페이스는 네이티브 파일을 추상화 합니다. +유저가 직접 HTML5 File API를 이용하여 작업할 때 선택된 파일의 경로를 알 수 있도록 +Electron은 파일의 실제 경로를 담은 `path` 속성을 File 인터페이스에 추가하였습니다. -다음 예제는 drag n drop한 파일의 실제 경로를 가져옵니다: +다음 예제는 앱으로 드래그 앤 드롭한 파일의 실제 경로를 가져옵니다: ```html
diff --git a/docs-translations/ko/api/frameless-window.md b/docs-translations/ko/api/frameless-window.md index 3dc45b824fd1..a398087e37b4 100644 --- a/docs-translations/ko/api/frameless-window.md +++ b/docs-translations/ko/api/frameless-window.md @@ -1,10 +1,12 @@ -# Frameless 윈도우 +# Frameless Window -Frameless 윈도우는 테두리가 없는 윈도우 창을 말합니다. +Frameless Window는 [테두리](https://developer.mozilla.org/en-US/docs/Glossary/Chrome)가 없는 창입니다. +이 기능은 윈도우 창의 일부분인 툴바와 같이 웹 페이지의 일부분이 아닌 부분을 보이지 않도록 합니다. +[`BrowserWindow`](browser-window.md) 클래스의 옵션에서 설정할 수 있습니다. -## Frameless 윈도우 만들기 +## Frameless Window 만들기 -Frameless 윈도우를 만드려면 [BrowserWindow](browser-window.md) 객체의 `options`에서 `frame` 옵션을 `false`로 지정하기만 하면됩니다: +Frameless Window를 만드려면 [BrowserWindow](browser-window.md) 객체의 `options`에서 `frame` 옵션을 `false`로 지정하면 됩니다: ```javascript var BrowserWindow = require('browser-window'); @@ -13,7 +15,7 @@ var win = new BrowserWindow({ width: 800, height: 600, frame: false }); ## 투명한 창 만들기 -Frameless 윈도우의 창의 배경을 투명하게 만들고 싶다면 `transparent` 옵션을 `true`로 바꿔주기만 하면됩니다: +Frameless Window의 창의 배경을 투명하게 만들고 싶다면 `transparent` 옵션을 `true`로 바꿔주기만 하면됩니다: ```javascript var win = new BrowserWindow({ transparent: true, frame: false }); @@ -21,22 +23,20 @@ var win = new BrowserWindow({ transparent: true, frame: false }); ### API의 한계 - - -* 투명한 영역을 통과하여 클릭할 수 없습니다. 우리는 이 문제를 해결하기 위해 API를 제공할 예정이지만 현재로써는 +* 투명한 영역을 통과하여 클릭할 수 없습니다. 우리는 이 문제를 해결하기 위해 API를 제공할 예정이었지만 현재로써는 [upstream 버그](https://code.google.com/p/chromium/issues/detail?id=387234)로 인해 중단된 상태입니다. -* 투명한 창은 크기를 조절할 수 없습니다. `resizable` 속성을 `true`로 할 경우 몇몇 플랫폼에선 윈도우 크래시가 일어납니다. -* `blur` 필터는 웹 페이지에서만 적용됩니다. 윈도우 아래 컨텐츠에는 블러 효과를 적용할 방법이 없습니다. -* Windows에선 DWM(데스크톱 창 관리자)가 비활성화되어 있을 경우 작동하지 않습니다. -* Linux를 사용할 경우 [alpha channel doesn't work on some NVidia drivers](https://code.google.com/p/chromium/issues/detail?id=369209) - upstream 버그가 있으므로 CLI 옵션에 `--enable-transparent-visuals --disable-gpu`을 추가해야 합니다. +* 투명한 창은 크기를 조절할 수 없습니다. `resizable` 속성을 `true`로 할 경우 몇몇 플랫폼에선 크래시가 일어납니다. +* `blur` 필터는 웹 페이지에서만 적용됩니다. 윈도우 아래 컨텐츠에는 블러 효과를 적용할 방법이 없습니다. (예시: 유저의 시스템에 열린 다른 어플리케이션) +* Windows에선 DWM(데스크톱 창 관리자)가 비활성화되어 있을 경우 투명한 창이 작동하지 않습니다. +* Linux를 사용할 경우 [alpha channel doesn't work on some NVidia drivers](https://code.google.com/p/chromium/issues/detail?id=369209) + upstream 버그가 있는 관계로 투명한 창 기능을 사용하려면 CLI 옵션에 `--enable-transparent-visuals --disable-gpu`을 추가해야 합니다. 이 옵션은 GPU의 사용을 중단하고 윈도우를 생성하는데 ARGB를 사용할 수 있도록 해줍니다. -* OS X(Mac)에선 네이티브 윈도우의 그림자가 투명한 창에선 보이지 않습니다. +* OS X(Mac)에선 네이티브 창에서 보여지는 그림자가 투명한 창에선 보이지 않습니다. ## 드래그 가능 위치 지정 -기본적으로 Frameless 윈도우는 드래그 할 수 없습니다. -어플리케이션의 CSS에서 특정 범위를 `-webkit-app-region: drag`로 지정하면 OS의 기본 타이틀바 처럼 드래그 되도록 할 수 있습니다. +기본적으로 Frameless Window는 드래그 할 수 없습니다. +어플리케이션의 CSS에서 특정 범위를 `-webkit-app-region: drag`로 지정하면 OS의 기본 타이틀 바 처럼 드래그 되도록 할 수 있습니다. 그리고 `-webkit-app-region: no-drag`를 지정해서 드래그 불가능 영역을 만들 수도 있습니다. 현재 사각형 형태의 범위만 지원합니다. 창 전체를 드래그 가능하게 만드려면 `-webkit-app-region: drag`을 `body`의 스타일에 지정하면 됩니다: @@ -54,13 +54,13 @@ button { } ``` -또한 커스텀 타이틀바를 만들어 사용할 때 타이틀바 내부의 버튼도 드래그 불가능 영역으로 지정해야 합니다. +따로 커스텀 타이틀 바를 만들어 사용할 때는 타이틀 바 내부의 모든 버튼을 드래그 불가능 영역으로 지정해야 합니다. ## 텍스트 선택 -한가지, Frameless 윈도우에서 텍스트가 선택되는 드래그 동작은 혼란을 야기할 수 있습니다. -예를 들어 타이틀바를 드래그 할 때 타이틀바의 텍스트를 실수로 선택할 수 있습니다. -이를 방지하기 위해선 다음과 같이 드래그 영역의 텍스트 선택 동작을 비활성화해야 할 필요가 있습니다: +Frameless Window에서 텍스트가 선택되는 드래그 동작은 혼란을 야기할 수 있습니다. +예를 들어 타이틀 바를 드래그 할 때 타이틀 바의 텍스트를 실수로 선택할 수 있습니다. +이를 방지하기 위해 다음과 같이 드래그 영역의 텍스트 선택 기능을 비활성화해야 할 필요가 있습니다: ```css .titlebar { @@ -71,5 +71,5 @@ button { ## 컨텍스트 메뉴 -몇몇 플랫폼에선 드래그 가능 영역이 non-client 프레임으로 처리됩니다. 그래서 이 영역에서 오른쪽 클릭을 할 경우 시스템 메뉴가 팝업 됩니다. -그래서 컨텍스트 메뉴 지정이 모든 플랫폼에서 정상적으로 작동하게 하려면 커스텀 컨텍스트 메뉴를 드래그 영역 내에 만들어선 안됩니다. +몇몇 플랫폼에선 드래그 가능 영역이 non-client 프레임으로 처리됩니다. 이러한 플랫폼에선 드래그 가능 영역에서 오른쪽 클릭 할 경우 시스템 메뉴가 팝업 됩니다. +이러한 이유로 컨텍스트 메뉴 지정 시 모든 플랫폼에서 정상적으로 작동하게 하려면 커스텀 컨텍스트 메뉴를 드래그 영역 내에 만들어선 안됩니다. diff --git a/docs-translations/ko/api/menu-item.md b/docs-translations/ko/api/menu-item.md index 519b7fb237a3..4d79fb1d44fa 100644 --- a/docs-translations/ko/api/menu-item.md +++ b/docs-translations/ko/api/menu-item.md @@ -5,7 +5,7 @@ ### new MenuItem(options) * `options` Object - * `click` Function - 메뉴 아이템이 클릭될 때 호출되는 콜백함수 + * `click` Function - 메뉴 아이템이 클릭될 때 호출되는 콜백 함수 * `selector` String - First Responder가 클릭될 때 호출 되는 선택자 (OS X 전용) * `type` String - `MenuItem`의 타입 `normal`, `separator`, `submenu`, `checkbox` 또는 `radio` 사용가능 * `label` String diff --git a/docs-translations/ko/api/menu.md b/docs-translations/ko/api/menu.md index 3303a55d05f2..62e26f13685b 100644 --- a/docs-translations/ko/api/menu.md +++ b/docs-translations/ko/api/menu.md @@ -181,9 +181,9 @@ Menu.setApplicationMenu(menu); * `action` String `action`을 어플리케이션의 first responder에 전달합니다. -이 함수는 Cocoa 메뉴 동작을 에뮬레이트 하는데 사용되며 보통 `MenuItem`의 `selector` 속성에 사용됩니다. +이 메서드는 Cocoa 메뉴 동작을 에뮬레이트 하는데 사용되며 보통 `MenuItem`의 `selector` 속성에 사용됩니다. -**알림:** 이 함수는 OS X에서만 사용할 수 있습니다. +**알림:** 이 메서드는 OS X에서만 사용할 수 있습니다. ### Class Method: Menu.buildFromTemplate(template) diff --git a/docs-translations/ko/api/remote.md b/docs-translations/ko/api/remote.md index c2713db4a910..8700ba21c57f 100644 --- a/docs-translations/ko/api/remote.md +++ b/docs-translations/ko/api/remote.md @@ -20,8 +20,8 @@ win.loadUrl('https://github.com'); ## Remote 객체 -`remote` 모듈로부터 반환된 각 객체(함수 포함)는 메인 프로세스의 객체를 추상화 한 객체입니다. (우리는 그것을 remote 객체 또는 remote 함수라고 부릅니다) -Remote 모듈의 함수를 호출하거나, 객체에 접근하거나, 생성자로 객체를 생성하는 등의 작업은 실질적으로 동기형 inter-process 메시지를 보냅니다. +`remote` 모듈로부터 반환된 각 객체(메서드 포함)는 메인 프로세스의 객체를 추상화 한 객체입니다. (우리는 그것을 remote 객체 또는 remote 함수라고 부릅니다) +Remote 모듈의 메서드를 호출하거나, 객체에 접근하거나, 생성자로 객체를 생성하는 등의 작업은 실질적으로 동기형 inter-process 메시지를 보냅니다. 위의 예제에서 사용한 두 `BrowserWindow`와 `win`은 remote 객체입니다. 그리고 `new BrowserWindow`이 생성하는 `BrowserWindow` 객체는 랜더러 프로세스에서 생성되지 않습니다. 대신에 이 `BrowserWindow` 객체는 메인 프로세스에서 생성되며 랜더러 프로세스에 `win` 객체와 같이 이에 대응하는 remote 객체를 반환합니다. @@ -38,16 +38,45 @@ Remote 객체가 GC 되려면 대응하는 메인 프로세스 내부 객체의 ## 메인 프로세스로 콜백 넘기기 -몇몇 메인 프로세스의 API는 콜백 함수를 사용합니다. 그리고 보통 remote 함수를 호출할 때 콜백 함수를 넘길 것입니다. -`remote` 모듈은 이를 지원합니다. 하지만 반드시 주의해서 사용해야 합니다. +메인 프로세스의 코드는 `remote` 모듈을 통해 랜더러 프로세스가 전달하는 콜백 함수를 받을 수 있습니다. +하지만 이 작업은 반드시 주의를 기울여 사용해야 합니다. 첫째, 데드락을 피하기 위해 메인 프로세스로 전달된 콜백들은 비동기로 호출됩니다. -그래서 전달된 콜백들이 언제나 값을 반환할 것이라고 기대하면 안 됩니다. +이러한 이유로 메인 프로세스로 전달된 콜백들의 반환 값을 내부 함수에서 언제나 정상적으로 받을 것이라고 예측해선 안됩니다. -둘째, 콜백들은 메인 프로세스로 전송되고 호출된 후에도 자동으로 참조가 릴리즈 되지 않습니다. -참조는 메인 프로세스에서 GC가 일어나기 전까지 계속 남아있게 됩니다. +예를 들어 메인 프로세스에서 `Array.map` 같은 메서드를 사용할 때 랜더러 프로세스에서 전달된 함수를 사용해선 안됩니다: -다음 코드를 보면 느낌이 팟 하고 올 것입니다. 이 예제는 remote 객체에 `close` 이벤트 콜백을 설치합니다: +```javascript +// mapNumbers.js 메인 프로세스 +exports.withRendererCallback = function(mapper) { + return [1,2,3].map(mapper); +} + +exports.withLocalCallback = function() { + return exports.mapNumbers(function(x) { + return x + 1; + }); +} + +// 랜더러 프로세스 +var mapNumbers = require("remote").require("mapNumbers"); + +var withRendererCb = mapNumbers.withRendererCallback(function(x) { + return x + 1; +}) + +var withLocalCb = mapNumbers.withLocalCallback() + +console.log(withRendererCb, withLocalCb) // [true, true, true], [2, 3, 4] +``` + +보다시피 랜더러 콜백의 동기 반환 값은 예상되지 않은 처리입니다. +그리고 메인 프로세스에서 처리한 함수의 반환 값과 일치하지 않습니다. + +둘째, 콜백들은 메인 프로세스로 전달, 호출된 이후에도 자동으로 함수의 참조가 릴리즈 되지 않습니다. +함수 참조는 메인 프로세스에서 GC가 일어나기 전까지 계속 프로세스에 남아있게 됩니다. + +다음 코드를 보면 느낌이 올 것입니다. 이 예제는 remote 객체에 `close` 이벤트 콜백을 설치합니다: ```javascript var remote = require('remote'); @@ -56,11 +85,14 @@ remote.getCurrentWindow().on('close', function() { }); ``` -문제는 이 이벤트는 명시적으로 제거하지 않는 이상 계속해서 메인 프로세스에 남아있게 된다는 것입니다. -그래서 매 창을 새로고침 할 때마다 콜백이 새롭게 설치되며 이전 콜백은 떨궈져 누수가 됩니다. -설상가상으로 이전에 설치한 콜백의 콘텍스트가 릴리즈 되고 나서 `close` 이벤트가 발생하면 예외가 발생하고 메인 프로세스가 작동 중지됩니다. +하지만 이 코드 처럼 이벤트를 명시적으로 제거하지 않는 이상 콜백 함수의 참조가 계속해서 메인 프로세스에 남아있게 됩니다. +만약 명시적으로 콜백을 제거하지 않으면 매 번 창을 새로고침 할 때마다 콜백을 새로 설치합니다. +게다가 이전 콜백이 제거되지 않고 계속해서 쌓이면서 메모리 누수가 발생합니다. -일반적으로 정확히 무엇을 할 것인지 잘 알고 있지 않는 이상 웬만하면 메인 프로세스로 콜백 함수를 넘기는 건 자제하는 게 좋습니다. +설상가상으로 이전에 설치된 콜백의 콘텍스트가 릴리즈 되고 난 후(예: 페이지 새로고침) `close` 이벤트가 발생하면 예외가 발생하고 메인 프로세스가 작동 중지됩니다. + +이러한 문제를 피하려면 랜더러 프로세스에서 메인 프로세스로 넘긴 함수의 참조를 사용 후 확실하게 제거해야 합니다. +작업 후 이벤트 콜백을 포함하여 책임 있게 함수의 참조를 제거하거나 메인 프로세스에서 랜더러 프로세스가 종료될 때 내부적으로 함수 참조를 제거하도록 설계해야 합니다. ## remote.require(module) diff --git a/docs-translations/ko/api/web-frame.md b/docs-translations/ko/api/web-frame.md index 4edbd4d6ec64..9829520901d2 100644 --- a/docs-translations/ko/api/web-frame.md +++ b/docs-translations/ko/api/web-frame.md @@ -1,8 +1,8 @@ # web-frame -`web-frame` 모듈은 현재 웹 페이지의 랜더링 상태를 설정 할 수 있도록 해줍니다. +`web-frame` 모듈은 현재 웹 페이지의 랜더링 상태를 설정 할 수 있도록 관련 유틸리티를 제공하는 모듈입니다. -다음 예제는 현재 페이지를 200% 줌 합니다. +다음 예제는 현재 페이지를 200% 줌 합니다: ```javascript var webFrame = require('web-frame'); @@ -30,6 +30,13 @@ webFrame.setZoomFactor(2); 현재 줌 레벨을 반환합니다. +## webFrame.setZoomLevelLimits(minimumLevel, maximumLevel) + +* `minimumLevel` Number +* `maximumLevel` Number + +줌 레벨의 최대, 최소치를 지정합니다. + ## webFrame.setSpellCheckProvider(language, autoCorrectWord, provider) * `language` String diff --git a/docs-translations/ko/api/window-open.md b/docs-translations/ko/api/window-open.md index a93bfda84178..d4e0509e9ec6 100644 --- a/docs-translations/ko/api/window-open.md +++ b/docs-translations/ko/api/window-open.md @@ -1,6 +1,6 @@ -# `window.open` 함수 +# `window.open` 메서드 -`window.open` 함수가 호출되면 새 창에서 새로운 페이지를 불러옵니다. +`window.open` 메서드가 호출되면 새 창에서 새로운 페이지를 불러옵니다. 이 창은 `url`로 부터 만들어진 `BrowserWindow`의 새 인스턴스이며 본 객체 대신 페이지의 컨트롤이 제한된 프록시 객체를 반환합니다. 프록시 객체는 기존의 웹 페이지와 호환될 수 있도록 일부 제한된 표준 기능만 가지고 있습니다. @@ -54,4 +54,4 @@ Forcefully closes the child window without calling its unload event. 자식 윈도우에 메시지를 보냅니다. 특정한 origin을 지정할 수도 있으며 `*`를 지정하면 따로 origin 설정을 사용하지 않습니다. -참고로 자식 윈도우의 `window.opener` 객체에는 다른 속성 없이 이 함수 하나만 구현되어 있습니다. +참고로 자식 윈도우의 `window.opener` 객체에는 다른 속성 없이 이 메서드 한 개만 구현되어 있습니다. diff --git a/docs-translations/ko/development/build-instructions-windows.md b/docs-translations/ko/development/build-instructions-windows.md index 06c2349b3d9b..df829de319d5 100644 --- a/docs-translations/ko/development/build-instructions-windows.md +++ b/docs-translations/ko/development/build-instructions-windows.md @@ -72,6 +72,15 @@ python script\cpplint.py python script\test.py ``` +테스트 실행시 `runas`와 같은 네이티브 모듈을 포함하는데 이 모듈은 디버그 빌드에서 같이 사용할 수 없습니다. +하지만 여전히 릴리즈 빌드에선 사용할 수 있습니다. + +릴리즈 빌드로 테스트를 실행하려면 다음 커맨드를 사용하면 됩니다: + +```powershell +python script\test.py -R +``` + ## 문제 해결 ### Command xxxx not found diff --git a/docs-translations/ko/development/setting-up-symbol-server.md b/docs-translations/ko/development/setting-up-symbol-server.md index 4d965a04da94..ed43e0fae295 100644 --- a/docs-translations/ko/development/setting-up-symbol-server.md +++ b/docs-translations/ko/development/setting-up-symbol-server.md @@ -1,6 +1,6 @@ # 디버거에서 디버그 심볼 서버 설정 -디버그 심볼은 디버깅 세션을 더 좋게 개선해 줍니다. 디버그 심볼은 실행 파일과 동적 링크 라이브러리에서 함수에 대한 정보를 담고 있으며 명료한 함수 호출 스텍 정보를 제공합니다. +디버그 심볼은 디버깅 세션을 더 좋게 개선해 줍니다. 디버그 심볼은 실행 파일과 동적 링크 라이브러리에서 메서드에 대한 정보를 담고 있으며 명료한 함수 호출 스텍 정보를 제공합니다. 심볼 서버는 유저가 크기가 큰 디버깅용 파일을 필수적으로 다운로드 받지 않고도 디버거가 알맞은 심볼, 바이너리 그리고 소스를 자동적으로 로드할 수 있도록 해줍니다. 서버 사용법은 [Microsoft의 심볼 서버](http://support.microsoft.com/kb/311503)와 비슷합니다. 이 문서를 참조하세요. diff --git a/docs-translations/ko/styleguide.md b/docs-translations/ko/styleguide.md index e63a016e8780..1916f80c68ef 100644 --- a/docs-translations/ko/styleguide.md +++ b/docs-translations/ko/styleguide.md @@ -27,9 +27,9 @@ Electron 문서를 작성하는 규칙은 다음과 같습니다. Electron 문서 구조를 이해하는 데 참고할 수 있는 유용한 도움말입니다. -### 메서드 +### Methods -[메서드](https://developer.mozilla.org/en-US/docs/Glossary/Method) 문서의 예제입니다: +[Method](https://developer.mozilla.org/en-US/docs/Glossary/Method) 문서의 예제입니다: --- diff --git a/docs-translations/ko/tutorial/application-packaging.md b/docs-translations/ko/tutorial/application-packaging.md index 893ac0e2e59f..4c799d71da4f 100644 --- a/docs-translations/ko/tutorial/application-packaging.md +++ b/docs-translations/ko/tutorial/application-packaging.md @@ -118,7 +118,7 @@ originalFs.readFileSync('/path/to/example.asar'); 몇몇 API는 시스템의 실제 파일의 경로를 기반으로 작동하므로 이 API들을 사용할 땐 Electron은 이 API가 원할하게 작동할 수 있도록 하기 위해 임시경로에 해당 파일들의 압축을 해제합니다. 이 작업은 약간의 오버헤드를 불러 일으킬 수 있습니다. -해당하는 API 함수는 다음과 같습니다: +해당하는 API 메서드는 다음과 같습니다: * `child_process.execFile` * `fs.open` diff --git a/docs-translations/ko/tutorial/using-native-node-modules.md b/docs-translations/ko/tutorial/using-native-node-modules.md index 1e67ee25305d..1dd23e5f1dcf 100644 --- a/docs-translations/ko/tutorial/using-native-node-modules.md +++ b/docs-translations/ko/tutorial/using-native-node-modules.md @@ -1,25 +1,23 @@ # 네이티브 node 모듈 사용하기 -__역주: 현재 Electron은 node.js대신 io.js를 사용합니다. 문서에 기재된 버전과 다를 수 있습니다__ - -Electron에선 node.js 네이티브 모듈이 지원됩니다. 하지만 Electron은 공식 node.js의 V8 엔진과는 달리 다른 V8 버전을 사용합니다. -그런 이유로 네이티브 모듈을 사용하기 위해선 Electron의 V8 버전에 맞춰 네이티브 모듈을 다시 빌드하고 헤더를 변경해야 합니다. +Electron에선 node.js 네이티브 모듈이 지원됩니다. 하지만 Electron은 공식 node.js의 V8 엔진과는 다른 V8 버전을 사용합니다. +이러한 이유로 네이티브 모듈을 사용하기 위해선 Electron의 V8 버전에 맞춰 네이티브 모듈을 다시 빌드하고 헤더를 변경해야 합니다. ## 네이티브 node 모듈 호환성 -Node v0.11.x 버전부터는 V8 API의 중대한 변경이 있었습니다. 하지만 일반적으로 모든 네이티브 모듈은 Node v0.10.x 버전을 타겟으로 작성 되었기 때문에 -Node v0.11.x 버전에선 작동하지 않습니다. Electron은 내부적으로 Node v0.11.13 버전을 사용합니다. 그래서 위에서 설명한 문제가 발생합니다. +Node v0.11.x 버전부터는 V8 API의 중대한 변경이 있었습니다. 하지만 대부분의 네이티브 모듈은 Node v0.10.x 버전을 타겟으로 작성 되었기 때문에 +새로운 Node 또는 io.js 버전에서 작동하지 않을 수 있습니다. Electron은 내부적으로 __io.js v3.1.0__ 버전을 사용하기 때문에 이러한 호환성 문제가 발생할 수 있습니다. -이 문제를 해결하기 위해 모듈이 Node v0.11.x 버전을 지원할 수 있도록 해야합니다. -현재 [많은 모듈들](https://www.npmjs.org/browse/depended/nan)이 안정적으로 두 버전 모두 지원하고 있지만 오래된 모듈의 경우 Node v0.10.x 버전만을 지원하고 있습니다. -예를 들어 [nan](https://github.com/rvagg/nan) 모듈을 사용해야 하는 경우 Node v0.11.x 버전으로 포팅 할 필요가 있습니다. +이 문제를 해결하기 위해선 모듈이 v0.11.x 또는 최신 버전을 지원할 수 있도록 변경해야 합니다. +현재 [많은 모듈들](https://www.npmjs.org/browse/depended/nan)이 안정적으로 두 버전 모두 지원하고 있지만 오래된 모듈의 경우 여전히 Node v0.10.x 버전만을 지원하고 있습니다. +예를 들어 [nan](https://github.com/rvagg/nan) 모듈을 사용해야 한다면 Node v0.11.x 또는 최신 버전의 Node와 io.js로 포팅 할 필요가 있습니다. ## 네이티브 모듈 설치하는 방법 ### 쉬운 방법 - 권장 -[`electron-rebuild`](https://github.com/paulcbetts/electron-rebuild) 패키지를 사용하면 아주 빠르고 정확하게 네이티브 모듈을 다시 빌드할 수 있습니다. -다음의 간단한 절차를 통해 자동으로 헤더를 다운로드하고 네이티브 모듈을 빌드할 수 있습니다: +[`electron-rebuild`](https://github.com/paulcbetts/electron-rebuild) 패키지를 사용하면 빠르고 간단하게 네이티브 모듈을 다시 빌드할 수 있습니다. +간단한 절차를 통해 자동으로 헤더를 다운로드하고 네이티브 모듈을 빌드할 수 있습니다: ```sh npm install --save-dev electron-rebuild @@ -30,7 +28,7 @@ npm install --save-dev electron-rebuild ### node-gyp을 이용한 방법 -Node 모듈을 `node-gyp`를 사용하여 Electron을 타겟으로 빌드할 땐 `node-gyp`에 헤더 다운로드 주소와 버전을 알려주어야합니다: +Node 모듈을 `node-gyp`를 사용하여 Electron을 타겟으로 빌드할 때는 `node-gyp`에 헤더 다운로드 주소와 버전을 알려주어야 합니다: ```bash $ cd /path-to-module/ @@ -43,7 +41,7 @@ $ HOME=~/.electron-gyp node-gyp rebuild --target=0.29.1 --arch=x64 --dist-url=ht ### npm을 이용한 방법 또한 `npm`을 사용하여 모듈을 설치할 수도 있습니다. -환경변수가 필요한 것을 제외하고는 일반 Node 모듈을 설치하는 방법과 완전히 똑같습니다: +환경변수가 필요한 것을 제외하고 일반 Node 모듈을 설치하는 방법과 완전히 똑같습니다: ```bash export npm_config_disturl=https://atom.io/download/atom-shell diff --git a/docs/api/content-tracing.md b/docs/api/content-tracing.md index 7d36fe9f5dd3..9161f5f362a1 100644 --- a/docs/api/content-tracing.md +++ b/docs/api/content-tracing.md @@ -8,11 +8,11 @@ generated file to view the result. ```javascript var contentTracing = require('content-tracing'); -tracing.startRecording('*', tracing.DEFAULT_OPTIONS, function() { +contentTracing.startRecording('*', contentTracing.DEFAULT_OPTIONS, function() { console.log('Tracing started'); setTimeout(function() { - tracing.stopRecording('', function(path) { + contentTracing.stopRecording('', function(path) { console.log('Tracing data recorded to ' + path); }); }, 5000); From ed01698444ed31f91aceb630054b61baadae0faa Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Mon, 31 Aug 2015 15:11:06 +0900 Subject: [PATCH 1041/1293] Update as upstream --- docs-translations/ko/api/auto-updater.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs-translations/ko/api/auto-updater.md b/docs-translations/ko/api/auto-updater.md index 369f58297be4..71005c3750c9 100644 --- a/docs-translations/ko/api/auto-updater.md +++ b/docs-translations/ko/api/auto-updater.md @@ -76,6 +76,12 @@ Squirrel은 "url"로 `Accept: application/zip` 헤더와 함께 업데이트 zip `pub_date`은 ISO 8601 표준에 따라 포맷된 날짜입니다. +## 업데이트 서버 구현 + +[Nuts](https://github.com/GitbookIO/nuts)는 위 업데이트 서버의 오픈 소스 구현입니다. +이 구현은 Github 릴리즈와 통합되어 있습니다. Nuts는 `Squirrel.Mac`과 `Squirrel.Windows`를 지원하고 다운로드와 업데이트를 관리합니다. +이 구현을 사용하면 cross-platform 지원을 신경 쓸 필요가 없습니다. + ## Events `autoUpdater` 객체는 다음과 같은 이벤트를 발생시킵니다: From a6b86e924a97e0ef56687855c2a61bbf10749a02 Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Mon, 31 Aug 2015 15:13:41 +0900 Subject: [PATCH 1042/1293] Small changes Improve grammar --- docs-translations/ko/api/auto-updater.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs-translations/ko/api/auto-updater.md b/docs-translations/ko/api/auto-updater.md index 71005c3750c9..ca4da0043b07 100644 --- a/docs-translations/ko/api/auto-updater.md +++ b/docs-translations/ko/api/auto-updater.md @@ -78,8 +78,8 @@ Squirrel은 "url"로 `Accept: application/zip` 헤더와 함께 업데이트 zip ## 업데이트 서버 구현 -[Nuts](https://github.com/GitbookIO/nuts)는 위 업데이트 서버의 오픈 소스 구현입니다. -이 구현은 Github 릴리즈와 통합되어 있습니다. Nuts는 `Squirrel.Mac`과 `Squirrel.Windows`를 지원하고 다운로드와 업데이트를 관리합니다. +[Nuts](https://github.com/GitbookIO/nuts)는 위에서 설명한 업데이트 서버의 오픈 소스 구현입니다. +이 구현은 Github 릴리즈와 완벽하게 통합되어 있습니다. Nuts는 `Squirrel.Mac`과 `Squirrel.Windows`를 지원하고 다운로드와 업데이트를 관리합니다. 이 구현을 사용하면 cross-platform 지원을 신경 쓸 필요가 없습니다. ## Events From aed487ef40cff53652d288c243671dabd8a2510c Mon Sep 17 00:00:00 2001 From: Robo Date: Mon, 31 Aug 2015 00:22:01 +0530 Subject: [PATCH 1043/1293] app: add will-download event to defaultSession --- atom/browser/api/atom_api_session.cc | 33 ++++++++++++++++++++++++ atom/browser/api/atom_api_session.h | 8 +++++- atom/browser/api/atom_api_web_contents.h | 2 +- atom/browser/api/lib/app.coffee | 6 +++-- docs/api/app.md | 32 +++++++++++++++++++++++ 5 files changed, 77 insertions(+), 4 deletions(-) diff --git a/atom/browser/api/atom_api_session.cc b/atom/browser/api/atom_api_session.cc index 9961d6cc6601..0b7640e416b5 100644 --- a/atom/browser/api/atom_api_session.cc +++ b/atom/browser/api/atom_api_session.cc @@ -9,6 +9,7 @@ #include "atom/browser/api/atom_api_cookies.h" #include "atom/browser/atom_browser_context.h" +#include "atom/browser/api/atom_api_web_contents.h" #include "atom/common/native_mate_converters/callback.h" #include "atom/common/native_mate_converters/gurl_converter.h" #include "atom/common/native_mate_converters/file_path_converter.h" @@ -101,6 +102,19 @@ struct Converter { } }; +template<> +struct Converter { + static v8::Local ToV8(v8::Isolate* isolate, + content::DownloadItem* val) { + return mate::ObjectTemplateBuilder(isolate) + .SetValue("url", val->GetURL()) + .SetValue("filename", val->GetSuggestedFilename()) + .SetValue("mimeType", val->GetMimeType()) + .SetValue("hasUserGesture", val->HasUserGesture()) + .Build()->NewInstance(); + } +}; + } // namespace mate namespace atom { @@ -215,9 +229,28 @@ void SetProxyInIO(net::URLRequestContextGetter* getter, Session::Session(AtomBrowserContext* browser_context) : browser_context_(browser_context) { AttachAsUserData(browser_context); + // Observe DownloadManger to get download notifications. + auto download_manager = + content::BrowserContext::GetDownloadManager(browser_context); + download_manager->AddObserver(this); } Session::~Session() { + auto download_manager = + content::BrowserContext::GetDownloadManager(browser_context_); + download_manager->RemoveObserver(this); +} + +void Session::OnDownloadCreated(content::DownloadManager* manager, + content::DownloadItem* item) { + auto web_contents = item->GetWebContents(); + bool prevent_default = Emit("will-download", item, + api::WebContents::CreateFrom(isolate(), + web_contents)); + if (prevent_default) { + item->Cancel(true); + item->Remove(); + } } void Session::ResolveProxy(const GURL& url, ResolveProxyCallback callback) { diff --git a/atom/browser/api/atom_api_session.h b/atom/browser/api/atom_api_session.h index b353c61c2109..c06348974ff4 100644 --- a/atom/browser/api/atom_api_session.h +++ b/atom/browser/api/atom_api_session.h @@ -8,6 +8,7 @@ #include #include "atom/browser/api/trackable_object.h" +#include "content/public/browser/download_manager.h" #include "native_mate/handle.h" #include "net/base/completion_callback.h" @@ -27,7 +28,8 @@ class AtomBrowserContext; namespace api { -class Session: public mate::TrackableObject { +class Session: public mate::TrackableObject, + public content::DownloadManager::Observer { public: using ResolveProxyCallback = base::Callback; @@ -41,6 +43,10 @@ class Session: public mate::TrackableObject { explicit Session(AtomBrowserContext* browser_context); ~Session(); + // content::DownloadManager::Observer: + void OnDownloadCreated(content::DownloadManager* manager, + content::DownloadItem* item) override; + // mate::Wrappable implementations: mate::ObjectTemplateBuilder GetObjectTemplateBuilder( v8::Isolate* isolate) override; diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index 2fbc1d899777..45027309ea65 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -10,8 +10,8 @@ #include "atom/browser/api/trackable_object.h" #include "atom/browser/common_web_contents_delegate.h" -#include "content/public/common/favicon_url.h" #include "content/public/browser/web_contents_observer.h" +#include "content/public/common/favicon_url.h" #include "native_mate/handle.h" #include "ui/gfx/image/image.h" diff --git a/atom/browser/api/lib/app.coffee b/atom/browser/api/lib/app.coffee index 3e05106d1927..f71297c596f0 100644 --- a/atom/browser/api/lib/app.coffee +++ b/atom/browser/api/lib/app.coffee @@ -32,8 +32,10 @@ app.setAppPath = (path) -> app.getAppPath = -> appPath -# Be compatible with old API. -app.once 'ready', -> @emit 'finish-launching' +app.once 'ready', -> + app.defaultSession.__proto__ = EventEmitter.prototype + # Be compatible with old API. + @emit 'finish-launching' app.terminate = app.quit app.exit = process.exit app.getHomeDir = -> @getPath 'home' diff --git a/docs/api/app.md b/docs/api/app.md index db34d37ec59e..8951adf45cfd 100644 --- a/docs/api/app.md +++ b/docs/api/app.md @@ -330,3 +330,35 @@ Sets the application's [dock menu][dock-menu]. [dock-menu]:https://developer.apple.com/library/mac/documentation/Carbon/Conceptual/customizing_docktile/concepts/dockconcepts.html#//apple_ref/doc/uid/TP30000986-CH2-TPXREF103 [tasks]:http://msdn.microsoft.com/en-us/library/windows/desktop/dd378460(v=vs.85).aspx#tasks + +## `app.defaultSession` + +The default session of the app available once the (ready)[app.md#event-ready] event is fired. + +```javascript +app.on('ready', function() { + var defaultSession = app.defaultSession; +}) +``` + +### Event: 'will-download' + +* `event` Event +* `downloadItem` Object + * `url` String + * `filename` String + * `mimeType` String + * `hasUserGesture` Boolean +* `webContents` (WebContents)[web-contents.md] + +Fired when a download is about to start. Calling `preventDefault()` +will cancel the download. + +```javascript +app.defaultSession.on('will-download', function(e, downloadItem, webContents) { + e.preventDefault(); + require('request')(downloadItem.url, function(data) { + require('fs').writeFileSync('/somewhere', data); + }); +}); +``` From af52eda0eb224ce3081d1a8c8c95d6c97dccd2e7 Mon Sep 17 00:00:00 2001 From: Robo Date: Sat, 29 Aug 2015 20:44:52 +0530 Subject: [PATCH 1044/1293] process: api to set file descriptor soft limit --- atom/common/api/atom_bindings.cc | 4 ++++ docs/api/app.md | 1 - docs/api/process.md | 7 +++++++ 3 files changed, 11 insertions(+), 1 deletion(-) diff --git a/atom/common/api/atom_bindings.cc b/atom/common/api/atom_bindings.cc index c748647f48d0..d6fb355e09d8 100644 --- a/atom/common/api/atom_bindings.cc +++ b/atom/common/api/atom_bindings.cc @@ -11,6 +11,7 @@ #include "atom/common/chrome_version.h" #include "atom/common/native_mate_converters/string16_converter.h" #include "base/logging.h" +#include "base/process/process_metrics.h" #include "native_mate/dictionary.h" #include "atom/common/node_includes.h" @@ -61,6 +62,9 @@ void AtomBindings::BindTo(v8::Isolate* isolate, dict.SetMethod("crash", &Crash); dict.SetMethod("hang", &Hang); dict.SetMethod("log", &Log); +#if defined(OS_POSIX) + dict.SetMethod("setFdLimit", &base::SetFdLimit); +#endif dict.SetMethod("activateUvLoop", base::Bind(&AtomBindings::ActivateUVLoop, base::Unretained(this))); diff --git a/docs/api/app.md b/docs/api/app.md index db34d37ec59e..07b26f2c5663 100644 --- a/docs/api/app.md +++ b/docs/api/app.md @@ -269,7 +269,6 @@ Adds `tasks` to the [Tasks][tasks] category of the JumpList on Windows. consists of two or more icons, set this value to identify the icon. If an icon file consists of one icon, this value is 0. - ### `app.commandLine.appendSwitch(switch[, value])` Append a switch (with optional `value`) to Chromium's command line. diff --git a/docs/api/process.md b/docs/api/process.md index c9efa22fe0f9..930a5860fc44 100644 --- a/docs/api/process.md +++ b/docs/api/process.md @@ -11,3 +11,10 @@ upstream node: ## process.hang Causes the main thread of the current process hang. + +## process.setFdLimit(maxDescriptors) _OS X_ _Linux_ + +* `maxDescriptors` Integer + +Sets the file descriptor soft limit to `maxDescriptors` or the OS hard +limit, whichever is lower for the current process. From 9ecc4bcb7d858b3cd0f80bc37fdb459768ea07be Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 31 Aug 2015 21:38:18 +0800 Subject: [PATCH 1045/1293] Fork renderer process for webview Previously it was disabled because Chrome doesn't support swapping renderer process before, it seeems to work fine now, so we enable it to see how it goes. --- atom/renderer/atom_renderer_client.cc | 19 ++++--------------- atom/renderer/lib/init.coffee | 2 -- 2 files changed, 4 insertions(+), 17 deletions(-) diff --git a/atom/renderer/atom_renderer_client.cc b/atom/renderer/atom_renderer_client.cc index 86c9eb1cdeb6..21ced4aedb86 100644 --- a/atom/renderer/atom_renderer_client.cc +++ b/atom/renderer/atom_renderer_client.cc @@ -52,10 +52,6 @@ bool IsSwitchEnabled(base::CommandLine* command_line, return true; } -bool IsGuestFrame(blink::WebFrame* frame) { - return frame->uniqueName().utf8() == "ATOM_SHELL_GUEST_WEB_VIEW"; -} - // global.Uint8Array; v8::Local GetUint8ArrayConstructor( v8::Isolate* isolate, v8::Local context) { @@ -189,14 +185,11 @@ bool AtomRendererClient::OverrideCreatePlugin( void AtomRendererClient::DidCreateScriptContext( blink::WebFrame* frame, v8::Handle context) { - // Only attach node bindings in main frame or guest frame. - if (!IsGuestFrame(frame)) { - if (main_frame_) - return; + if (main_frame_) + return; - // The first web frame is the main frame. - main_frame_ = frame; - } + // The first web frame is the main frame. + main_frame_ = frame; // Give the node loop a run to make sure everything is ready. node_bindings_->RunMessageLoop(); @@ -221,10 +214,6 @@ bool AtomRendererClient::ShouldFork(blink::WebFrame* frame, bool is_initial_navigation, bool is_server_redirect, bool* send_referrer) { - // Never fork renderer process for guests. - if (IsGuestFrame(frame)) - return false; - // Handle all the navigations and reloads in browser. // FIXME We only support GET here because http method will be ignored when // the OpenURLFromTab is triggered, which means form posting would not work, diff --git a/atom/renderer/lib/init.coffee b/atom/renderer/lib/init.coffee index 32d3ee76d1b9..9825f75be928 100644 --- a/atom/renderer/lib/init.coffee +++ b/atom/renderer/lib/init.coffee @@ -29,8 +29,6 @@ for arg in process.argv if arg.indexOf('--guest-instance-id=') == 0 # This is a guest web view. process.guestInstanceId = parseInt arg.substr(arg.indexOf('=') + 1) - # Set the frame name to make AtomRendererClient recognize this guest. - require('web-frame').setName 'ATOM_SHELL_GUEST_WEB_VIEW' else if arg.indexOf('--node-integration=') == 0 nodeIntegration = arg.substr arg.indexOf('=') + 1 else if arg.indexOf('--preload=') == 0 From ebedb606843056bab9f16946a0812432e437c8f2 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 31 Aug 2015 21:59:13 +0800 Subject: [PATCH 1046/1293] Insert node integration for all main frames --- atom/renderer/atom_renderer_client.cc | 9 +++------ atom/renderer/atom_renderer_client.h | 3 --- 2 files changed, 3 insertions(+), 9 deletions(-) diff --git a/atom/renderer/atom_renderer_client.cc b/atom/renderer/atom_renderer_client.cc index 21ced4aedb86..e17e8bf3db9b 100644 --- a/atom/renderer/atom_renderer_client.cc +++ b/atom/renderer/atom_renderer_client.cc @@ -109,8 +109,7 @@ class AtomRenderFrameObserver : public content::RenderFrameObserver { AtomRendererClient::AtomRendererClient() : node_bindings_(NodeBindings::Create(false)), - atom_bindings_(new AtomBindings), - main_frame_(nullptr) { + atom_bindings_(new AtomBindings) { } AtomRendererClient::~AtomRendererClient() { @@ -185,12 +184,10 @@ bool AtomRendererClient::OverrideCreatePlugin( void AtomRendererClient::DidCreateScriptContext( blink::WebFrame* frame, v8::Handle context) { - if (main_frame_) + // Only insert node integration for the main frame. + if (frame->parent()) return; - // The first web frame is the main frame. - main_frame_ = frame; - // Give the node loop a run to make sure everything is ready. node_bindings_->RunMessageLoop(); diff --git a/atom/renderer/atom_renderer_client.h b/atom/renderer/atom_renderer_client.h index 68201f3cd435..e59547cf8eb1 100644 --- a/atom/renderer/atom_renderer_client.h +++ b/atom/renderer/atom_renderer_client.h @@ -64,9 +64,6 @@ class AtomRendererClient : public content::ContentRendererClient, scoped_ptr node_bindings_; scoped_ptr atom_bindings_; - // The main frame. - blink::WebFrame* main_frame_; - DISALLOW_COPY_AND_ASSIGN(AtomRendererClient); }; From c59c0bd5b3893bf720ea04699386dc5520934626 Mon Sep 17 00:00:00 2001 From: Heilig Benedek Date: Mon, 31 Aug 2015 18:32:33 +0200 Subject: [PATCH 1047/1293] Mouse event handling and keyboard event handling (not totally working yet) --- atom/browser/api/atom_api_window.cc | 142 ++++++++++++++++++++++++++++ atom/browser/api/atom_api_window.h | 2 + atom/browser/native_window.cc | 67 ++++++++++++- atom/browser/native_window.h | 7 ++ atom/common/event_types.cc | 45 +++++++++ atom/common/event_types.h | 48 ++++++++++ atom/common/options_switches.cc | 10 ++ atom/common/options_switches.h | 10 ++ filenames.gypi | 2 + 9 files changed, 330 insertions(+), 3 deletions(-) create mode 100644 atom/common/event_types.cc create mode 100644 atom/common/event_types.h diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index c19cf6f7d945..977a241a7da7 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -8,6 +8,8 @@ #include "atom/browser/api/atom_api_web_contents.h" #include "atom/browser/browser.h" #include "atom/browser/native_window.h" +#include "atom/common/options_switches.h" +#include "atom/common/event_types.h" #include "atom/common/native_mate_converters/callback.h" #include "atom/common/native_mate_converters/gfx_converter.h" #include "atom/common/native_mate_converters/gurl_converter.h" @@ -516,6 +518,144 @@ bool Window::IsVisibleOnAllWorkspaces() { return window_->IsVisibleOnAllWorkspaces(); } +void Window::SendKeyboardEvent(v8::Isolate* isolate, const mate::Dictionary& data){ + auto type = blink::WebInputEvent::Type::Char; + int modifiers = 0; + int keycode = 0; + std::string type_str = ""; + std::vector modifier_array; + + data.Get(switches::kMouseEventType, &type_str); + data.Get(switches::kModifiers, &modifier_array); + data.Get(switches::kKeyCode, &keycode); + + if(type_str.compare(event_types::kKeyDown) == 0){ + type = blink::WebInputEvent::Type::KeyDown; + }else if(type_str.compare(event_types::kKeyUp) == 0){ + type = blink::WebInputEvent::Type::KeyUp; + }else if(type_str.compare(event_types::kChar) == 0){ + type = blink::WebInputEvent::Type::Char; + } + + for(std::vector::iterator mod = modifier_array.begin(); mod != modifier_array.end(); ++mod) { + if(mod->compare(event_types::kModifierIsKeyPad) == 0){ + modifiers = modifiers & blink::WebInputEvent::Modifiers::IsKeyPad; + }else if(mod->compare(event_types::kModifierIsAutoRepeat) == 0){ + modifiers = modifiers & blink::WebInputEvent::Modifiers::IsAutoRepeat; + }else if(mod->compare(event_types::kModifierIsLeft) == 0){ + modifiers = modifiers & blink::WebInputEvent::Modifiers::IsLeft; + }else if(mod->compare(event_types::kModifierIsRight) == 0){ + modifiers = modifiers & blink::WebInputEvent::Modifiers::IsRight; + }else if(mod->compare(event_types::kModifierShiftKey) == 0){ + modifiers = modifiers & blink::WebInputEvent::Modifiers::ShiftKey; + }else if(mod->compare(event_types::kModifierControlKey) == 0){ + modifiers = modifiers & blink::WebInputEvent::Modifiers::ControlKey; + }else if(mod->compare(event_types::kModifierAltKey) == 0){ + modifiers = modifiers & blink::WebInputEvent::Modifiers::AltKey; + }else if(mod->compare(event_types::kModifierMetaKey) == 0){ + modifiers = modifiers & blink::WebInputEvent::Modifiers::MetaKey; + }else if(mod->compare(event_types::kModifierCapsLockOn) == 0){ + modifiers = modifiers & blink::WebInputEvent::Modifiers::CapsLockOn; + }else if(mod->compare(event_types::kModifierNumLockOn) == 0){ + modifiers = modifiers & blink::WebInputEvent::Modifiers::NumLockOn; + } + } + + window_->SendKeyboardEvent(type, modifiers, keycode); +} + +void Window::SendMouseEvent(v8::Isolate* isolate, const mate::Dictionary& data){ + int x, y, movementX, movementY, clickCount; + std::string type_str = ""; + std::string button_str = ""; + std::vector modifier_array; + + blink::WebInputEvent::Type type = blink::WebInputEvent::Type::MouseMove; + blink::WebMouseEvent::Button button = blink::WebMouseEvent::Button::ButtonNone; + int modifiers = 0; + + data.Get(switches::kMouseEventType, &type_str); + data.Get(switches::kMouseEventButton, &button_str); + data.Get(switches::kModifiers, &modifier_array); + + if(type_str.compare(event_types::kMouseDown) == 0){ + type = blink::WebInputEvent::Type::MouseDown; + }else if(type_str.compare(event_types::kMouseUp) == 0){ + type = blink::WebInputEvent::Type::MouseUp; + }else if(type_str.compare(event_types::kMouseMove) == 0){ + type = blink::WebInputEvent::Type::MouseMove; + }else if(type_str.compare(event_types::kMouseEnter) == 0){ + type = blink::WebInputEvent::Type::MouseEnter; + }else if(type_str.compare(event_types::kMouseLeave) == 0){ + type = blink::WebInputEvent::Type::MouseLeave; + }else if(type_str.compare(event_types::kContextMenu) == 0){ + type = blink::WebInputEvent::Type::ContextMenu; + }else if(type_str.compare(event_types::kMouseWheel) == 0){ + type = blink::WebInputEvent::Type::MouseWheel; + } + + if(button_str.compare(event_types::kMouseLeftButton) == 0){ + modifiers = modifiers & blink::WebInputEvent::Modifiers::LeftButtonDown; + button = blink::WebMouseEvent::Button::ButtonLeft; + }else if(button_str.compare(event_types::kMouseRightButton) == 0){ + modifiers = modifiers & blink::WebInputEvent::Modifiers::RightButtonDown; + button = blink::WebMouseEvent::Button::ButtonRight; + }else if(button_str.compare(event_types::kMouseMiddleButton) == 0){ + modifiers = modifiers & blink::WebInputEvent::Modifiers::MiddleButtonDown; + button = blink::WebMouseEvent::Button::ButtonMiddle; + } + + for(std::vector::iterator mod = modifier_array.begin(); mod != modifier_array.end(); ++mod) { + if(mod->compare(event_types::kModifierLeftButtonDown) == 0){ + modifiers = modifiers & blink::WebInputEvent::Modifiers::LeftButtonDown; + }else if(mod->compare(event_types::kModifierMiddleButtonDown) == 0){ + modifiers = modifiers & blink::WebInputEvent::Modifiers::MiddleButtonDown; + }else if(mod->compare(event_types::kModifierRightButtonDown) == 0){ + modifiers = modifiers & blink::WebInputEvent::Modifiers::RightButtonDown; + }else if(mod->compare(event_types::kModifierShiftKey) == 0){ + modifiers = modifiers & blink::WebInputEvent::Modifiers::ShiftKey; + }else if(mod->compare(event_types::kModifierControlKey) == 0){ + modifiers = modifiers & blink::WebInputEvent::Modifiers::ControlKey; + }else if(mod->compare(event_types::kModifierAltKey) == 0){ + modifiers = modifiers & blink::WebInputEvent::Modifiers::AltKey; + }else if(mod->compare(event_types::kModifierMetaKey) == 0){ + modifiers = modifiers & blink::WebInputEvent::Modifiers::MetaKey; + }else if(mod->compare(event_types::kModifierCapsLockOn) == 0){ + modifiers = modifiers & blink::WebInputEvent::Modifiers::CapsLockOn; + }else if(mod->compare(event_types::kModifierNumLockOn) == 0){ + modifiers = modifiers & blink::WebInputEvent::Modifiers::NumLockOn; + } + } + + if(type == blink::WebInputEvent::Type::MouseWheel){ + bool precise = true; + + x = 0; + y = 0; + data.Get(switches::kX, &x); + data.Get(switches::kY, &y); + data.Get(switches::kMouseWheelPrecise, &precise); + + window_->SendMouseWheelEvent(modifiers, x, y, precise); + }else{ + if (data.Get(switches::kX, &x) && data.Get(switches::kY, &y)) { + if(!data.Get(switches::kMovementX, &movementX)){ + movementX = 0; + } + + if(!data.Get(switches::kMovementY, &movementY)){ + movementY = 0; + } + + if(!data.Get(switches::kClickCount, &clickCount)){ + clickCount = 0; + } + + window_->SendMouseEvent(type, modifiers, button, x, y, movementX, movementY, clickCount); + } + } +} + int32_t Window::ID() const { return weak_map_id(); } @@ -599,6 +739,8 @@ void Window::BuildPrototype(v8::Isolate* isolate, &Window::SetVisibleOnAllWorkspaces) .SetMethod("isVisibleOnAllWorkspaces", &Window::IsVisibleOnAllWorkspaces) + .SetMethod("sendMouseEvent", &Window::SendMouseEvent) + .SetMethod("sendKeyboardEvent", &Window::SendKeyboardEvent) #if defined(OS_MACOSX) .SetMethod("showDefinitionForSelection", &Window::ShowDefinitionForSelection) diff --git a/atom/browser/api/atom_api_window.h b/atom/browser/api/atom_api_window.h index 925aa6749714..8bff9769469e 100644 --- a/atom/browser/api/atom_api_window.h +++ b/atom/browser/api/atom_api_window.h @@ -138,6 +138,8 @@ class Window : public mate::TrackableObject, void SetMenuBarVisibility(bool visible); bool IsMenuBarVisible(); void SetAspectRatio(double aspect_ratio, mate::Arguments* args); + void SendKeyboardEvent(v8::Isolate* isolate, const mate::Dictionary& data); + void SendMouseEvent(v8::Isolate* isolate, const mate::Dictionary& data); #if defined(OS_MACOSX) void ShowDefinitionForSelection(); diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index b21d04aa2389..da7218d2ea74 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -9,6 +9,8 @@ #include #include "content/public/browser/render_widget_host_view_frame_subscriber.h" +#include "content/public/browser/native_web_keyboard_event.h" +#include "third_party/WebKit/public/web/WebInputEvent.h" #include "media/base/video_frame.h" #include "media/base/yuv_convert.h" #include "atom/browser/atom_browser_context.h" @@ -547,10 +549,69 @@ void NativeWindow::DevToolsClosed() { FOR_EACH_OBSERVER(NativeWindowObserver, observers_, OnDevToolsClosed()); } -void NativeWindow::RenderViewReady(){ - if(offscreen_){ - const auto view = web_contents()->GetRenderWidgetHostView(); +void NativeWindow::SendKeyboardEvent(blink::WebInputEvent::Type type, int modifiers, int keycode){ + auto keyb_event = new content::NativeWebKeyboardEvent; + keyb_event->nativeKeyCode = keycode; + keyb_event->windowsKeyCode = keycode; + keyb_event->setKeyIdentifierFromWindowsKeyCode(); + keyb_event->type = type; + keyb_event->modifiers = modifiers; + keyb_event->isSystemKey = false; + keyb_event->timeStampSeconds = base::Time::Now().ToDoubleT(); + keyb_event->skip_in_browser = false; + + if (type == blink::WebInputEvent::Char || type == blink::WebInputEvent::KeyDown) { + keyb_event->text[0] = keycode; + keyb_event->unmodifiedText[0] = keycode; + } + + const auto view = web_contents()->GetRenderWidgetHostView(); + const auto host = view ? view->GetRenderWidgetHost() : nullptr; + host->ForwardKeyboardEvent(*keyb_event); +} + +void NativeWindow::SendMouseEvent(blink::WebInputEvent::Type type, int modifiers, blink::WebMouseEvent::Button button, int x, int y, int movementX, int movementY, int clickCount){ + auto mouse_event = new blink::WebMouseEvent(); + + mouse_event->x = x; + mouse_event->y = y; + mouse_event->windowX = x; + mouse_event->windowY = y; + mouse_event->clickCount = clickCount; + mouse_event->type = type; + mouse_event->modifiers = modifiers; + mouse_event->button = button; + + mouse_event->timeStampSeconds = base::Time::Now().ToDoubleT(); + + const auto view = web_contents()->GetRenderWidgetHostView(); + const auto host = view ? view->GetRenderWidgetHost() : nullptr; + host->ForwardMouseEvent(*mouse_event); +} + +void NativeWindow::SendMouseWheelEvent(int modifiers, int x, int y, bool precise){ + auto wheel_event = new blink::WebMouseWheelEvent(); + + wheel_event->type = blink::WebInputEvent::MouseWheel; + wheel_event->deltaX = x; + wheel_event->deltaY = y; + if(x) wheel_event->wheelTicksX = x > 0.0f ? 1.0f : -1.0f; + if(y) wheel_event->wheelTicksY = y > 0.0f ? 1.0f : -1.0f; + wheel_event->modifiers = modifiers; + wheel_event->hasPreciseScrollingDeltas = precise; + wheel_event->canScroll = true; + + const auto view = web_contents()->GetRenderWidgetHostView(); + const auto host = view ? view->GetRenderWidgetHost() : nullptr; + host->ForwardWheelEvent(*wheel_event); +} + +void NativeWindow::DidFinishLoad(content::RenderFrameHost* render_frame_host, const GURL& validated_url) { + const auto view = web_contents()->GetRenderWidgetHostView(); + const auto host = view ? view->GetRenderWidgetHost() : nullptr; + + if(offscreen_){ scoped_ptr subscriber(new RenderSubscriber( view->GetVisibleViewportSize(), base::Bind(&NativeWindow::OnFrameReceived, base::Unretained(this)) )); diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index 793bd614c8d8..88686ee22f59 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -11,6 +11,8 @@ #include "media/base/video_frame.h" #include "content/public/browser/render_widget_host_view_frame_subscriber.h" +#include "content/public/browser/native_web_keyboard_event.h" +#include "third_party/WebKit/public/web/WebInputEvent.h" #include "atom/browser/native_window_observer.h" #include "atom/browser/ui/accelerator_util.h" #include "base/cancelable_callback.h" @@ -236,6 +238,10 @@ class NativeWindow : public content::WebContentsObserver, void OnFrameReceived(bool result, scoped_refptr frame); + void SendKeyboardEvent(blink::WebInputEvent::Type type, int modifiers, int keycode); + void SendMouseEvent(blink::WebInputEvent::Type type, int modifiers, blink::WebMouseEvent::Button button, int x, int y, int movementX, int movementY, int clickCount); + void SendMouseWheelEvent(int modifiers, int x, int y, bool clickCount); + protected: NativeWindow(brightray::InspectableWebContents* inspectable_web_contents, const mate::Dictionary& options); @@ -248,6 +254,7 @@ class NativeWindow : public content::WebContentsObserver, // content::WebContentsObserver: void RenderViewCreated(content::RenderViewHost* render_view_host) override; void RenderViewReady() override; + void DidFinishLoad(content::RenderFrameHost* render_frame_host, const GURL& validated_url) override; void BeforeUnloadDialogCancelled() override; void TitleWasSet(content::NavigationEntry* entry, bool explicit_set) override; bool OnMessageReceived(const IPC::Message& message) override; diff --git a/atom/common/event_types.cc b/atom/common/event_types.cc new file mode 100644 index 000000000000..dd87783e68bd --- /dev/null +++ b/atom/common/event_types.cc @@ -0,0 +1,45 @@ +// Copyright (c) 2013 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#include "atom/common/event_types.h" + +namespace atom { + +namespace event_types { + +const char kMouseDown[] = "down"; +const char kMouseUp[] = "up"; +const char kMouseMove[] = "move"; +const char kMouseEnter[] = "enter"; +const char kMouseLeave[] = "leave"; +const char kContextMenu[] = "context-menu"; +const char kMouseWheel[] = "wheel"; + +const char kKeyDown[] = "key-down"; +const char kKeyUp[] = "key-up"; +const char kChar[] = "char"; + +const char kMouseLeftButton[] = "left"; +const char kMouseRightButton[] = "right"; +const char kMouseMiddleButton[] = "middle"; + +const char kModifierLeftButtonDown[] = "left-button-down"; +const char kModifierMiddleButtonDown[] = "middle-button-down"; +const char kModifierRightButtonDown[] = "right-button-down"; + +const char kModifierShiftKey[] = "shift"; +const char kModifierControlKey[] = "control"; +const char kModifierAltKey[] = "alt"; +const char kModifierMetaKey[] = "meta"; +const char kModifierCapsLockOn[] = "caps-lock"; +const char kModifierNumLockOn[] = "num-lock"; + +const char kModifierIsKeyPad[] = "keypad"; +const char kModifierIsAutoRepeat[] = "auto-repeat"; +const char kModifierIsLeft[] = "left"; +const char kModifierIsRight[] = "right"; + +} // namespace switches + +} // namespace atom diff --git a/atom/common/event_types.h b/atom/common/event_types.h new file mode 100644 index 000000000000..b7eae781fc42 --- /dev/null +++ b/atom/common/event_types.h @@ -0,0 +1,48 @@ +// Copyright (c) 2013 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#ifndef ATOM_COMMON_EVENT_TYPES_H_ +#define ATOM_COMMON_EVENT_TYPES_H_ + +namespace atom { + +namespace event_types { + +extern const char kMouseDown[]; +extern const char kMouseUp[]; +extern const char kMouseMove[]; +extern const char kMouseEnter[]; +extern const char kMouseLeave[]; +extern const char kContextMenu[]; +extern const char kMouseWheel[]; + +extern const char kKeyDown[]; +extern const char kKeyUp[]; +extern const char kChar[]; + +extern const char kMouseLeftButton[]; +extern const char kMouseRightButton[]; +extern const char kMouseMiddleButton[]; + +extern const char kModifierLeftButtonDown[]; +extern const char kModifierMiddleButtonDown[]; +extern const char kModifierRightButtonDown[]; + +extern const char kModifierShiftKey[]; +extern const char kModifierControlKey[]; +extern const char kModifierAltKey[]; +extern const char kModifierMetaKey[]; +extern const char kModifierCapsLockOn[]; +extern const char kModifierNumLockOn[]; + +extern const char kModifierIsKeyPad[]; +extern const char kModifierIsAutoRepeat[]; +extern const char kModifierIsLeft[]; +extern const char kModifierIsRight[]; + +} // namespace switches + +} // namespace atom + +#endif // ATOM_COMMON_EVENT_TYPES_H_ diff --git a/atom/common/options_switches.cc b/atom/common/options_switches.cc index 73a54157fabd..ee70080ae6ae 100644 --- a/atom/common/options_switches.cc +++ b/atom/common/options_switches.cc @@ -112,6 +112,16 @@ const char kAppUserModelId[] = "app-user-model-id"; const char kOffScreenRender[] = "offscreen-render"; +const char kModifiers[] = "modifiers"; +const char kKeyCode[] = "keycode"; + +const char kMovementX[] = "movement-x"; +const char kMovementY[] = "movement-y"; +const char kClickCount[] = "click-count"; +const char kMouseEventType[] = "type"; +const char kMouseEventButton[] = "button"; +const char kMouseWheelPrecise[] = "precise"; + } // namespace switches } // namespace atom diff --git a/atom/common/options_switches.h b/atom/common/options_switches.h index edd37ff03589..505305deb49c 100644 --- a/atom/common/options_switches.h +++ b/atom/common/options_switches.h @@ -62,6 +62,16 @@ extern const char kAppUserModelId[]; extern const char kOffScreenRender[]; +extern const char kModifiers[]; +extern const char kKeyCode[]; + +extern const char kMovementX[]; +extern const char kMovementY[]; +extern const char kClickCount[]; +extern const char kMouseEventType[]; +extern const char kMouseEventButton[]; +extern const char kMouseWheelPrecise[]; + } // namespace switches } // namespace atom diff --git a/filenames.gypi b/filenames.gypi index 40af1ebb1fe7..2e84b73c2c11 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -301,6 +301,8 @@ 'atom/common/node_includes.h', 'atom/common/options_switches.cc', 'atom/common/options_switches.h', + 'atom/common/event_types.cc', + 'atom/common/event_types.h', 'atom/common/platform_util.h', 'atom/common/platform_util_linux.cc', 'atom/common/platform_util_mac.mm', From 625ee387f3fbf9cac3cb3c71fd5b8aa5143cf312 Mon Sep 17 00:00:00 2001 From: huangruichang <532079207@qq.com> Date: Tue, 1 Sep 2015 00:34:00 +0800 Subject: [PATCH 1048/1293] * add quick-start.md for zh-CN --- .../zh-CN/tutorial/quick-start.md | 136 ++++++++++++++++++ 1 file changed, 136 insertions(+) create mode 100644 docs-translations/zh-CN/tutorial/quick-start.md diff --git a/docs-translations/zh-CN/tutorial/quick-start.md b/docs-translations/zh-CN/tutorial/quick-start.md new file mode 100644 index 000000000000..fe54cbe9e308 --- /dev/null +++ b/docs-translations/zh-CN/tutorial/quick-start.md @@ -0,0 +1,136 @@ +# 快速入门 + +## 简介 +Electron 可以让你使用纯 JavaScript 调用丰富的原生 APIs 来创造桌面应用。你可以把它看作是专注于桌面应用而不是 web 服务器的，io.js 的一个变体。 + +这不意味着 Electron 是绑定了 GUI 库的 JavaScript。相反，Electron 使用 web 页面作为它的 GUI，所以你能把它看作成一个被 JavaScript 控制的，精简版的 Chromium 浏览器。 + +## 主进程 +在 Electron 里，运行 `package.json` 里 `main` 脚本的进程被称为**主进程**。在主进程运行的脚本可以以创建 web 页面的形式展示 GUI。 + +## 渲染进程 +由于 Electron 使用 Chromium 来展示页面，所以 Chromium 的多进程结构也被充分利用。每个 Electron 的页面都在运行着自己的进程，这样的进程我们称之为**渲染进程**。 + +在一般浏览器中，网页通常会在沙盒环境下运行，并且不允许访问原生资源。然后，Electron 用户拥有在网页中调用 io.js 的 APIs 的能力，从而创造出低等的、与操作系统的交互。 + +## 主进程与渲染进程的区别 +主进程使用 BroswerWindow 实例创建网页。每个 BroswerWindow 实例都在自己的渲染进程里运行着一个网页。当一个 BroswerWindow 实例被销毁，相应的渲染进程也会被终止。 + +主进程管理所有页面和与之对应的渲染进程。每个渲染进程都是相互独立的，并且只关心他们自己的网页。 + +由于在网页里管理原生 GUI 资源是非常危险而且容易造成资源泄露的，所以在网页面调用 GUI 相关的 APIs 是不被允许的。如果你想在网页里使用 GUI 操作，其对应的渲染进程必须与主进程进行通讯，请求主进程进行相关的 GUI 操作。 + +在 Electron,我们提供用于在主进程与渲染进程之间通讯的 [ipc][1] 模块。并且也有一个远程进程调用风格的通讯模块 [remote][2]。 + +# 打造你第一个 Electron 应用 +大体上，一个 Electron 应用的目录结构如下： +```` +your-app/ +├── package.json +├── main.js +└── index.html +```` +`package.json `的格式和 Node 的完全一致，并且那个被 `main` 字段声明的脚本文件是你的应用的启动脚本，它运行在主进程上。你应用里的 `package.json` 看起来应该像： +```` +{ + "name" : "your-app", + "version" : "0.1.0", + "main" : "main.js" +} +```` +**注意**：如果 `main` 字段没有在 `package.json` 声明，Electron会优先加载 `index.js`。 + +`main.js` 应该用于创建窗口和处理系统时间，一个典型的例子如下： +```` +var app = require('app'); // 控制应用生命周期的模块。 +var BrowserWindow = require('browser-window'); // 创建原生浏览器窗口的模块 + +// 给我们的服务器发送异常报告。 +require('crash-reporter').start(); + +// 保持一个对于 window 对象的全局引用，不然，当 JavaScript 被 GC， +// window 会被自动地关闭 +var mainWindow = null; + +// 当所有窗口被关闭了，退出。 +app.on('window-all-closed', function() { + // 在 OS X 上，通常用户在明确地按下 Cmd + Q 之前 + // 应用会保持活动状态 + if (process.platform != 'darwin') { + app.quit(); + } +}); + +// 当 Electron 完成了初始化并且准备创建浏览器窗口的时候 +// 这个方法就被调用 +app.on('ready', function() { + // 创建浏览器窗口。 + mainWindow = new BrowserWindow({width: 800, height: 600}); + + // 加载应用的 index.html + mainWindow.loadUrl('file://' + __dirname + '/index.html'); + + // 打开开发工具 + mainWindow.openDevTools(); + + // 当 window 被关闭，这个事件会被发出 + mainWindow.on('closed', function() { + // 取消引用 window 对象，如果你的应用支持多窗口的话， + // 通常会把多个 window 对象存放在一个数组里面， + // 但这次不是。 + mainWindow = null; + }); +}); +```` +最后，你想展示的 `index.html` ： +```` + + + + Hello World! + + +

Hello World!

+ We are using io.js + and Electron . + + +```` + +# 运行你的应用 +一旦你创建了最初的 `main.js`， `index.html` 和 `package.json` 这几个文件，你可能会想尝试在本地运行并测试，看看是不是和期望的那样正常运行。 + +## electron-prebuild +如果你已经用 `npm` 全局安装了 `electron-prebuilt`，你只需要按照如下方式直接运行你的应用： +```` +electron . +```` +如果你是局部安装，那运行： +```` +./node_modules/.bin/electron . +```` + +## 手工下载 Electron 二进制文件 +如果你手工下载了 Electron 的二进制文件，你也可以直接使用其中的二进制文件直接运行你的应用。 +### Windows +```` +$ .\electron\electron.exe your-app\ +```` +### Linux +```` +$ ./electron/electron your-app/ +```` +### OS X +```` +$ ./Electron.app/Contents/MacOS/Electron your-app/ +```` +`Electron.app` 里面是 Electron 发布包，你可以在[这里][3]下载到。 + +# 以发行版本运行 +在你完成了你的应用后，你可以按照[应用部署][4]指导发布一个版本，并且以已经打包好的形式运行应用。 + + + [1]: https://github.com/atom/electron/blob/master/docs-translations/zh-CN/api/ipc-renderer.md + [2]: https://github.com/atom/electron/blob/master/docs-translations/zh-CN/api/remote.md + [3]: https://github.com/atom/electron/releases + [4]: https://github.com/atom/electron/blob/master/docs-translations/zh-CN/tutorial/application-distribution.md \ No newline at end of file From afff32dc8dbae0ec58a26809a81cf1543079da47 Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Tue, 1 Sep 2015 08:09:35 +0900 Subject: [PATCH 1049/1293] Improve grammar --- docs-translations/ko/api/window-open.md | 6 +++--- docs-translations/ko/tutorial/quick-start.md | 11 ++++++----- .../ko/tutorial/using-native-node-modules.md | 4 ++-- 3 files changed, 11 insertions(+), 10 deletions(-) diff --git a/docs-translations/ko/api/window-open.md b/docs-translations/ko/api/window-open.md index d4e0509e9ec6..706d7e090bb8 100644 --- a/docs-translations/ko/api/window-open.md +++ b/docs-translations/ko/api/window-open.md @@ -1,9 +1,9 @@ # `window.open` 메서드 -`window.open` 메서드가 호출되면 새 창에서 새로운 페이지를 불러옵니다. -이 창은 `url`로 부터 만들어진 `BrowserWindow`의 새 인스턴스이며 본 객체 대신 페이지의 컨트롤이 제한된 프록시 객체를 반환합니다. +`window.open` 메서드가 호출되면 새 창을 생성하고 `url` 페이지를 불러옵니다. +이 창은 지정한 `url`을 로드하여 만들어진 `BrowserWindow`의 새 인스턴스이며 본래 창 객체 대신 페이지의 컨트롤이 제한된 프록시 객체를 반환합니다. -프록시 객체는 기존의 웹 페이지와 호환될 수 있도록 일부 제한된 표준 기능만 가지고 있습니다. +프록시 객체는 브라우저의 웹 페이지 창과 호환될 수 있도록 일부 제한된 표준 기능만 가지고 있습니다. 창의 모든 컨트롤을 가지려면 `BrowserWindow`를 직접 생성하여 작업해야 합니다. ## window.open(url, [frameName[, features]]) diff --git a/docs-translations/ko/tutorial/quick-start.md b/docs-translations/ko/tutorial/quick-start.md index 963ebca4dacd..39d9edfdbfb4 100644 --- a/docs-translations/ko/tutorial/quick-start.md +++ b/docs-translations/ko/tutorial/quick-start.md @@ -10,23 +10,24 @@ Electron은 자바스크립트와 함께 제공된 풍부한 네이티브 API를 ### 메인 프로세스 -Electron은 실행될 때 __메인 프로세스__ 로 불리는 `package.json`의 `main` 스크립트를 호출합니다. +Electron은 실행될 때 __메인 프로세스__로 불리는 `package.json`의 `main` 스크립트를 호출합니다. 이 스크립트는 메인 프로세스에서 작동합니다. GUI 컴포넌트를 조작하거나 웹 페이지 창을 생성할 수 있습니다. ### 랜더러 프로세스 Electron이 웹페이지를 보여줄 때 Chromium의 multi-processes 구조도 같이 사용됩니다. -Electron 프로세스 내에서 작동하는 웹 페이지는 __랜더러 프로세스__ 라고 불립니다. +Electron 프로세스 내에서 작동하는 웹 페이지를 __랜더러 프로세스__ 라고 불립니다. 보통 일반 브라우저의 웹 페이지들은 샌드박스가 적용된 환경에서 작동하며 네이티브 리소스에는 접근할 수 없도록 되어 있습니다. 하지만 Electron은 웹 페이지 내에서 io.js(node.js) API를 사용하여 low-level 수준으로 운영체제와 상호작용할 수 있습니다. ### 메인 프로세스와 랜더러 프로세스의 차이점 -메인 프로세스는 `BrowserWindow` Class를 이용하여 창을 만들 수 있습니다. `BrowserWindow` 인스턴스는 -따로 분리된 프로세스에서 랜더링 되며 `BrowserWindow` 인스턴스가 소멸할 때 해당하는 랜더러 프로세스도 같이 소멸합니다. +메인 프로세스는 `BrowserWindow` Class를 사용하여 새로운 창을 만들 수 있습니다. +`BrowserWindow` 인스턴스는 따로 분리된 프로세스에서 랜더링 되며 이 프로세스를 랜더러 프로세스라고 합니다. +`BrowserWindow` 인스턴스가 소멸할 때 그 창의 랜더러 프로세스도 같이 소멸합니다. -메인 프로세스는 모든 웹 페이지와 그에 해당하는 랜더러 프로세스를 관리하며 +메인 프로세스는 모든 웹 페이지와 랜더러 프로세스를 관리하며 랜더러 프로세스는 각각의 프로세스에 고립되며 웹 페이지의 작동에만 영향을 끼칩니다. 웹 페이지 내에서 네이티브 GUI 리소스를 관리하는 것은 보안에 취약하고 리소스를 누수시킬 수 있기 때문에 diff --git a/docs-translations/ko/tutorial/using-native-node-modules.md b/docs-translations/ko/tutorial/using-native-node-modules.md index 1dd23e5f1dcf..5b8f71210550 100644 --- a/docs-translations/ko/tutorial/using-native-node-modules.md +++ b/docs-translations/ko/tutorial/using-native-node-modules.md @@ -1,4 +1,4 @@ -# 네이티브 node 모듈 사용하기 +# 네이티브 node 모듈 사용하기 Electron에선 node.js 네이티브 모듈이 지원됩니다. 하지만 Electron은 공식 node.js의 V8 엔진과는 다른 V8 버전을 사용합니다. 이러한 이유로 네이티브 모듈을 사용하기 위해선 Electron의 V8 버전에 맞춰 네이티브 모듈을 다시 빌드하고 헤더를 변경해야 합니다. @@ -14,7 +14,7 @@ Node v0.11.x 버전부터는 V8 API의 중대한 변경이 있었습니다. 하 ## 네이티브 모듈 설치하는 방법 -### 쉬운 방법 - 권장 +### 쉬운 방법 [`electron-rebuild`](https://github.com/paulcbetts/electron-rebuild) 패키지를 사용하면 빠르고 간단하게 네이티브 모듈을 다시 빌드할 수 있습니다. 간단한 절차를 통해 자동으로 헤더를 다운로드하고 네이티브 모듈을 빌드할 수 있습니다: From eb3769f98e0386e221d8b06fec082b303cbc8afc Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Tue, 1 Sep 2015 09:57:43 +0900 Subject: [PATCH 1050/1293] Update as upstream, improve grammar --- README-ko.md | 2 +- docs-translations/ko/api/auto-updater.md | 2 +- docs-translations/ko/api/clipboard.md | 2 +- docs-translations/ko/api/crash-reporter.md | 2 +- docs-translations/ko/api/dialog.md | 2 +- docs-translations/ko/api/global-shortcut.md | 19 ++++--- docs-translations/ko/api/ipc-main-process.md | 51 ++++++++++++++----- docs-translations/ko/api/ipc-renderer.md | 46 ++++++++++++----- docs-translations/ko/api/menu.md | 2 +- .../ko/api/power-save-blocker.md | 2 +- docs-translations/ko/api/process.md | 6 +++ docs-translations/ko/api/protocol.md | 2 +- docs-translations/ko/api/remote.md | 2 +- docs-translations/ko/api/tray.md | 2 +- docs-translations/ko/api/window-open.md | 4 +- .../development/atom-shell-vs-node-webkit.md | 2 +- .../development/build-instructions-linux.md | 4 +- .../ko/development/build-instructions-mac.md | 2 +- .../development/build-instructions-windows.md | 4 +- docs-translations/ko/styleguide.md | 2 +- .../ko/tutorial/application-packaging.md | 2 +- .../ko/tutorial/debugging-main-process.md | 4 +- .../ko/tutorial/online-offline-events.md | 8 +-- docs-translations/ko/tutorial/quick-start.md | 2 +- .../ko/tutorial/using-native-node-modules.md | 2 +- .../ko/tutorial/using-pepper-flash-plugin.md | 3 +- 26 files changed, 119 insertions(+), 62 deletions(-) diff --git a/README-ko.md b/README-ko.md index 00cfe43732de..1b895c159798 100644 --- a/README-ko.md +++ b/README-ko.md @@ -6,7 +6,7 @@ ### [Electron](https://github.com/atom/electron/) 한국어 참조문서 -:zap: *이전까지 Atom Shell로 알려져 있었습니다* :zap: +:zap: *프레임워크 이름이 Atom Shell에서 Electron으로 바뀌었습니다* :zap: Electron 프레임워크는 JavaScript, HTML 그리고 CSS를 사용하여 Cross-Platform 데스크톱 어플리케이션을 개발할 수 있도록 해주는 프레임워크입니다. 이 프레임워크는 [io.js](http://iojs.org) 와 [Chromium](http://www.chromium.org)을 기반으로 만들어 졌으며 [Atom Editor](https://github.com/atom/atom)에 사용되고 있습니다. diff --git a/docs-translations/ko/api/auto-updater.md b/docs-translations/ko/api/auto-updater.md index ca4da0043b07..1b586d5cdd5d 100644 --- a/docs-translations/ko/api/auto-updater.md +++ b/docs-translations/ko/api/auto-updater.md @@ -17,7 +17,7 @@ Squirrel은 어플리케이션이 **안전하고 투명한 업데이트**를 제 Squirrel은 사용자에게 어플리케이션의 업데이트를 알릴 필요 없이 서버가 지시하는 버전을 받아온 후 자동으로 업데이트합니다. 이 기능을 사용하면 Squirrel을 통해 클라이언트의 어플리케이션을 지능적으로 업데이트 할 수 있습니다. -요청시 커스텀 헤더 또는 요청 본문에 인증 정보를 포함시킬 수도 있습니다. +또한 요청시 커스텀 헤더 또는 요청 본문에 인증 정보를 포함시킬 수 있습니다. 서버에선 이러한 요청을 분류 처리하여 적당한 업데이트를 제공할 수 있습니다. Squirrel JSON 업데이트 요청시 처리는 반드시 어떤 업데이트가 필요한지 요청의 기준에 맞춰 동적으로 생성되어야 합니다. diff --git a/docs-translations/ko/api/clipboard.md b/docs-translations/ko/api/clipboard.md index 5143a4c3b113..080078274e01 100644 --- a/docs-translations/ko/api/clipboard.md +++ b/docs-translations/ko/api/clipboard.md @@ -19,7 +19,7 @@ console.log(clipboard.readText('selection')); `clipboard` 모듈은 다음과 같은 메서드를 가지고 있습니다: -**알림:** Experimental 마크가 붙은 API는 실험적인 기능이며 차후 최신 버전에서 제거될 수 있습니다. +**참고:** Experimental 마크가 붙은 API는 실험적인 기능이며 차후 최신 버전에서 제거될 수 있습니다. ### `clipboard.readText([type])` diff --git a/docs-translations/ko/api/crash-reporter.md b/docs-translations/ko/api/crash-reporter.md index 53b5d3b7924c..3a7bc35f0982 100644 --- a/docs-translations/ko/api/crash-reporter.md +++ b/docs-translations/ko/api/crash-reporter.md @@ -37,7 +37,7 @@ crashReporter.start({ 다른 crashReporter API를 사용하기 전에 이 메서드를 먼저 호출해야 합니다. -**알림:** OS X에선 Windows와 Linux의 `breakpad`와 달리 새로운 `crashpad` 클라이언트를 사용합니다. +**참고:** OS X에선 Windows와 Linux의 `breakpad`와 달리 새로운 `crashpad` 클라이언트를 사용합니다. 오류 수집 기능을 활성화 시키려면 오류를 수집하고 싶은 메인 프로세스나 랜더러 프로세스에서 `crashReporter.start` 메서드를 호출하여 `crashpad`를 초기화 해야합니다. diff --git a/docs-translations/ko/api/dialog.md b/docs-translations/ko/api/dialog.md index 0c8bdec74a66..08530c054797 100644 --- a/docs-translations/ko/api/dialog.md +++ b/docs-translations/ko/api/dialog.md @@ -52,7 +52,7 @@ console.log(dialog.showOpenDialog({ properties: [ 'openFile', 'openDirectory', ' `callback`이 전달되면 메소드가 비동기로 작동되며 결과는 `callback(filenames)`을 통해 전달됩니다. -**알림:** Windows와 Linux에선 파일 선택 모드, 디렉터리 선택 모드를 동시에 사용할 수 없습니다. +**참고:** Windows와 Linux에선 파일 선택 모드, 디렉터리 선택 모드를 동시에 사용할 수 없습니다. 이러한 이유로 `properties`를 `['openFile', 'openDirectory']`로 설정하면 디렉터리 선택 대화 상자가 표시됩니다. ### `dialog.showSaveDialog([browserWindow][, options][, callback])` diff --git a/docs-translations/ko/api/global-shortcut.md b/docs-translations/ko/api/global-shortcut.md index d99085f448e5..b6ad3fe89b86 100644 --- a/docs-translations/ko/api/global-shortcut.md +++ b/docs-translations/ko/api/global-shortcut.md @@ -1,8 +1,9 @@ # global-shortcut -`global-shortcut` 모듈은 운영체제의 전역 키보드 단축키를 설정 등록/해제 하는 방법을 제공합니다. +`global-shortcut` 모듈은 운영체제의 전역 키보드 단축키를 등록/해제 하는 방법을 제공합니다. 이 모듈을 사용하여 사용자가 다양한 단축키 작업을 할 수 있도록 단축키를 정의 할 수 있습니다. -참고로 설정된 단축키는 어플리케이션이 백그라운드로 작동(창이 포커스 되지 않음) 할 때도 여전히 계속 작동합니다. + +**참고:** 등록된 단축키는 어플리케이션이 백그라운드로 작동(창이 포커스 되지 않음) 할 때도 계속해서 작동합니다. 이 모듈은 `app` 모듈의 `ready` 이벤트 이전에 사용할 수 없습니다. ```javascript @@ -30,25 +31,29 @@ app.on('will-quit', function() { }); ``` -## globalShortcut.register(accelerator, callback) +## Methods + +`global-shortcut` 모듈은 다음과 같은 메서드를 가지고 있습니다: + +### `globalShortcut.register(accelerator, callback)` * `accelerator` [Accelerator](accelerator.md) * `callback` Function `accelerator`로 표현된 전역 단축키를 등록합니다. 유저로부터 등록된 단축키가 눌렸을 경우 `callback` 함수가 호출됩니다. -## globalShortcut.isRegistered(accelerator) +### `globalShortcut.isRegistered(accelerator)` * `accelerator` [Accelerator](accelerator.md) 지정된 `accelerator` 단축키가 등록되었는지 여부를 확인합니다. 반환값은 boolean(true, false) 입니다. -## globalShortcut.unregister(accelerator) +### `globalShortcut.unregister(accelerator)` * `accelerator` [Accelerator](accelerator.md) -`키코드`에 해당하는 전역 단축키를 등록 해제합니다. +`accelerator`에 해당하는 전역 단축키를 등록 해제합니다. -## globalShortcut.unregisterAll() +### `globalShortcut.unregisterAll()` 모든 전역 단축키 등록을 해제합니다. diff --git a/docs-translations/ko/api/ipc-main-process.md b/docs-translations/ko/api/ipc-main-process.md index 7f6a091de46d..496afd203318 100644 --- a/docs-translations/ko/api/ipc-main-process.md +++ b/docs-translations/ko/api/ipc-main-process.md @@ -1,17 +1,21 @@ # ipc (main process) -랜더러 프로세스(웹 페이지)로 부터 동기 또는 비동기로 메시지를 받아 처리합니다. +`ipc` (main process) 모듈은 메인 프로세스에서 사용할 때 랜더러 프로세스(웹 페이지)에서 전달된 동기 또는 비동기 메시지를 보내고 받는 방법을 제공합니다. +랜더러 프로세스에서 메시지를 전달하면 이 모듈을 통해 메시지를 받을 수 있습니다. -랜더러로부터 발신된 메시지들은 모두 이 모듈에서 `channel` 이라는 특정 이벤트 이름을 통해 수신할 수 있습니다. -동기 메시지는 `event.returnValue`를 이용하여 반환값(답장)을 설정할 수 있습니다. 비동기 메시지라면 `event.sender.send(...)`를 사용하면 됩니다. +## 메시지 전송 -또한 메인 프로세스에서 랜더러 프로세스로 메시지를 보내는 것도 가능합니다. -자세한 내용은 [WebContents.send](browser-window.md#webcontentssendchannel-args)를 참고 하세요. +물론 메인 프로세스에서 랜더러 프로세스로 메시지를 보내는 것도 가능합니다. +자세한 내용은 [WebContents.send](browser-window.md#webcontentssendchannel-args)를 참고하세요. -보내진 메시지들을 처리하는 예제입니다: +- 메시지를 전송할 때 이벤트 이름은 `channel`이 됩니다. +- 메시지에 동기로 응답할 땐 반드시 `event.returnValue`를 설정해야 합니다. +- 메시지를 비동기로 응답할 땐 `event.sender.send(...)` 메서드를 사용할 수 있습니다. + +랜더러 프로세스와 메인 프로세스간에 메시지를 전달하고 받는 예제입니다: ```javascript -// 메인 프로세스에서 처리. +// 메인 프로세스 var ipc = require('ipc'); ipc.on('asynchronous-message', function(event, arg) { console.log(arg); // prints "ping" @@ -25,7 +29,7 @@ ipc.on('synchronous-message', function(event, arg) { ``` ```javascript -// 랜더러 프로세스에서의 처리 (web page). +// 랜더러 프로세스 (web page) var ipc = require('ipc'); console.log(ipc.sendSync('synchronous-message', 'ping')); // prints "pong" @@ -35,12 +39,33 @@ ipc.on('asynchronous-reply', function(arg) { ipc.send('asynchronous-message', 'ping'); ``` -## Class: Event +## 메시지 리스닝 -### Event.returnValue +`ipc` 모듈은 다음과 같은 이벤트 메서드를 가지고 있습니다: -동기 메시지를 설정합니다. +### `ipc.on(channel, callback)` -### Event.sender +* `channel` String - 이벤트 이름 +* `callback` Function -메시지를 보내온 sender `WebContents` 객체입니다. +이벤트가 발생하면 `callback`에 `event` 객체와 `arg` 메시지가 포함되어 호출됩니다. + +## IPC Events + +`callback`에서 전달된 `event` 객체는 다음과 같은 메서드와 속성을 가지고 있습니다: + +### `Event.returnValue` + +이 메시지를 지정하면 동기 메시지를 전달합니다. + +### `Event.sender` + +메시지를 보낸 `WebContents` 객체를 반환합니다. + +### `Event.sender.send(channel[, arg1][, arg2][, ...])` + +* `channel` String - The event name. +* `arg` (optional) + +랜더러 프로세스로 비동기 메시지를 전달합니다. +옵션으로 `arg`에 한 개 또는 여러 개의 메시지를 포함할 수 있습니다. 모든 타입을 사용할 수 있습니다. diff --git a/docs-translations/ko/api/ipc-renderer.md b/docs-translations/ko/api/ipc-renderer.md index b8bbb7ffa14d..67864c4e1157 100644 --- a/docs-translations/ko/api/ipc-renderer.md +++ b/docs-translations/ko/api/ipc-renderer.md @@ -1,25 +1,45 @@ # ipc (renderer) -`ipc` 모듈은 메인 프로세스로 메시지를 동기 또는 비동기로 보내고 받을 수 있는 몇 가지 방법을 제공합니다. -만약 랜더러 프로세스에서 메인 프로세스의 모듈을 직접적으로 사용하고 싶다면 [remote](remote.md) 모듈을 사용하는 것을 고려해보는 것이 좋습니다. +`ipc` (renderer) 모듈은 메인 프로세스로 동기 또는 비동기 메시지를 보내고 받는 방법을 제공합니다. +물론 메인 프로세스로부터 받은 메시지에 응답할 수도 있습니다. -[ipc (main process)](ipc-main-process.md)에서 예제를 볼 수 있습니다. +**참고:** 만약 랜더러 프로세스에서 메인 프로세스의 모듈을 직접적 사용하고 싶다면 [remote](remote.md) 모듈을 사용하는 것을 고려해보는 것이 좋습니다. -## ipc.send(channel[, args...]) +[ipc (main process)](ipc-main-process.md)에서 예제를 확인 할 수 있습니다. -지정한 `channel`을 통해 `args..`를 비동기로 메시지를 보냅니다. 메인 프로세스는 `ipc` 모듈의 `channel` 이벤트를 통해 메시지를 받을 수 있습니다. +## Methods -## ipc.sendSync(channel[, args...]) +`ipc` 모듈은 다음과 같은 메서드를 가지고 있습니다: -지정한 `channel`을 통해 `args..`를 동기로 메시지를 보냅니다. 그리고 메인 프로세스에서 보낸 결과를 반환합니다. -메인 프로세스는 `ipc` 모듈의 `channel` 이벤트를 통해 메시지를 받을 수 있습니다. 그리고 `event.returnValue`를 통해 반환값을 설정할 수 있습니다. +**참고:** 이 메소드들을 사용하여 `message`를 보낼 땐 반드시 메인 프로세스의 +[`ipc (main process)`](ipc-main-process.md) 모듈에서도 이벤트 리스너를 등록해 두어야 합니다. -역자 주: `channel`은 이벤트 이름입니다. +### `ipc.send(channel[, arg1][, arg2][, ...])` -**알림:** 보통 개발자들은 해당 API를 사용하려 하지 않습니다. 동기 ipc 작업은 랜더러 프로세스의 모든 작업을 중단시킵니다. +* `channel` String - 이벤트 이름 +* `arg` (optional) -## ipc.sendToHost(channel[, args...]) +`channel`을 통해 메인 프로세스에 비동기 메시지를 보냅니다. +옵션으로 `arg`에 한 개 또는 여러 개의 메시지를 포함할 수 있습니다. 모든 타입을 사용할 수 있습니다. +메인 프로세스는 `ipc`를 통해 `channel` 이벤트를 리스닝 할 수 있습니다. -`ipc.send`와 비슷하지만 메시지를 메인 프로세스 대신 호스트 페이지로 보냅니다. +### `ipc.sendSync(channel[, arg1][, arg2][, ...])` -이 메소드는 보통 ``와 호스트 페이지 간의 통신에 사용됩니다. +* `channel` String - 이벤트 이름 +* `arg` (optional) + +`channel`을 통해 메인 프로세스에 동기 메시지를 보냅니다. +옵션으로 `arg`에 한 개 또는 여러 개의 메시지를 포함할 수 있습니다. 모든 타입을 사용할 수 있습니다. +메인 프로세스는 `ipc`를 통해 `channel` 이벤트를 리스닝 할 수 있습니다. + +메인 프로세스에선 `ipc` 모듈의 `channel` 이벤트를 통해 받은 `event.returnValue`로 회신 할 수 있습니다. + +**참고:** 동기 메시징은 모든 랜더러 프로세스의 작업을 일시 중단시킵니다. 이 메서드를 사용하는 것을 권장하지 않습니다. + +### `ipc.sendToHost(channel[, arg1][, arg2][, ...])` + +* `channel` String - 이벤트 이름 +* `arg` (optional) + +`ipc.send`와 비슷하지만 이벤트를 메인 프로세스 대신 호스트 페이지내의 ``로 보냅니다. +옵션으로 `arg`에 한 개 또는 여러 개의 메시지를 포함할 수 있습니다. 모든 타입을 사용할 수 있습니다. diff --git a/docs-translations/ko/api/menu.md b/docs-translations/ko/api/menu.md index 62e26f13685b..6636158cdda5 100644 --- a/docs-translations/ko/api/menu.md +++ b/docs-translations/ko/api/menu.md @@ -183,7 +183,7 @@ Menu.setApplicationMenu(menu); `action`을 어플리케이션의 first responder에 전달합니다. 이 메서드는 Cocoa 메뉴 동작을 에뮬레이트 하는데 사용되며 보통 `MenuItem`의 `selector` 속성에 사용됩니다. -**알림:** 이 메서드는 OS X에서만 사용할 수 있습니다. +**참고:** 이 메서드는 OS X에서만 사용할 수 있습니다. ### Class Method: Menu.buildFromTemplate(template) diff --git a/docs-translations/ko/api/power-save-blocker.md b/docs-translations/ko/api/power-save-blocker.md index e686891a5ca5..03bb3bf2a245 100644 --- a/docs-translations/ko/api/power-save-blocker.md +++ b/docs-translations/ko/api/power-save-blocker.md @@ -23,7 +23,7 @@ powerSaveBlocker.stop(id); Power save blocker를 시작하고 시스템이 저전력 모드(슬립)로 진입하는 것을 막습니다. 정수로 된 식별 ID를 반환합니다. -**알림:** +**참고:** `prevent-display-sleep` 모드는 `prevent-app-suspension` 보다 우선순위가 높습니다. 가장 높은 우선순위의 모드만 작동합니다. 다시 말해 `prevent-display-sleep` 모드는 언제나 `prevent-app-suspension` 모드의 효과를 덮어씌웁니다. diff --git a/docs-translations/ko/api/process.md b/docs-translations/ko/api/process.md index b5f98266b8b3..09b57d1b869b 100644 --- a/docs-translations/ko/api/process.md +++ b/docs-translations/ko/api/process.md @@ -10,3 +10,9 @@ Electron의 `process` 객체는 기존의 node와는 달리 약간의 차이점 ## process.hang 현재 프로세스의 주 스레드를 중단시킵니다. + +## process.setFdLimit(maxDescriptors) _OS X_ _Linux_ + +* `maxDescriptors` Integer + +`maxDescriptors`에 file descriptor 소프트 리미트를 설정하거나 OS 하드 리미트를 설정합니다. 값은 현재 프로세스에 대해 낮은 값이어야 합니다. diff --git a/docs-translations/ko/api/protocol.md b/docs-translations/ko/api/protocol.md index 45cd69eea63b..0a1c04b6dcd6 100644 --- a/docs-translations/ko/api/protocol.md +++ b/docs-translations/ko/api/protocol.md @@ -20,7 +20,7 @@ app.on('ready', function() { }); ``` -**알림:** 이 모듈은 `ready` 이벤트가 호출된 이후에만 사용할 수 있습니다. +**참고:** 이 모듈은 `ready` 이벤트가 호출된 이후에만 사용할 수 있습니다. ## protocol.registerStandardSchemes(schemes) diff --git a/docs-translations/ko/api/remote.md b/docs-translations/ko/api/remote.md index 8700ba21c57f..d5ee74cfb1e8 100644 --- a/docs-translations/ko/api/remote.md +++ b/docs-translations/ko/api/remote.md @@ -16,7 +16,7 @@ var win = new BrowserWindow({ width: 800, height: 600 }); win.loadUrl('https://github.com'); ``` -알림: 반대로 하려면(메인 프로세스에서 랜더러 프로세스에 접근) [webContents.executeJavascript](browser-window.md#webcontents-executejavascript-code) API를 사용하면 됩니다. +**참고:** 반대로 하려면(메인 프로세스에서 랜더러 프로세스에 접근) [webContents.executeJavascript](browser-window.md#webcontents-executejavascript-code) API를 사용하면 됩니다. ## Remote 객체 diff --git a/docs-translations/ko/api/tray.md b/docs-translations/ko/api/tray.md index 05decef5a48f..8ee015f98c37 100644 --- a/docs-translations/ko/api/tray.md +++ b/docs-translations/ko/api/tray.md @@ -169,7 +169,7 @@ __주의:__ 이 기능은 OS X에서만 작동합니다. 트레이에 알림풍선을 생성합니다. -__알림:__ 이 기능은 Windows에서만 작동합니다. +__주의:__ 이 기능은 Windows에서만 작동합니다. ### Tray.popContextMenu([position]) diff --git a/docs-translations/ko/api/window-open.md b/docs-translations/ko/api/window-open.md index 706d7e090bb8..6d7c0b9fabbe 100644 --- a/docs-translations/ko/api/window-open.md +++ b/docs-translations/ko/api/window-open.md @@ -19,7 +19,7 @@ * `message` String * `targetOrigin` String -부모 윈도우에 메시지를 보냅니다. 특정한 origin을 지정할 수도 있으며 `*`를 지정하면 따로 origin 설정을 사용하지 않습니다. +부모 윈도우에 메시지를 보냅니다. origin을 특정할 수 있으며 `*`를 지정하면 따로 origin 설정을 사용하지 않습니다. ## Class: BrowserWindowProxy @@ -52,6 +52,6 @@ Forcefully closes the child window without calling its unload event. * `message` String * `targetOrigin` String -자식 윈도우에 메시지를 보냅니다. 특정한 origin을 지정할 수도 있으며 `*`를 지정하면 따로 origin 설정을 사용하지 않습니다. +자식 윈도우에 메시지를 보냅니다. origin을 특정할 수 있으며 `*`를 지정하면 따로 origin 설정을 사용하지 않습니다. 참고로 자식 윈도우의 `window.opener` 객체에는 다른 속성 없이 이 메서드 한 개만 구현되어 있습니다. diff --git a/docs-translations/ko/development/atom-shell-vs-node-webkit.md b/docs-translations/ko/development/atom-shell-vs-node-webkit.md index f688204d537d..aa0d3e19058f 100644 --- a/docs-translations/ko/development/atom-shell-vs-node-webkit.md +++ b/docs-translations/ko/development/atom-shell-vs-node-webkit.md @@ -1,6 +1,6 @@ # NW.js와 기술적으로 다른점 (이전 node-webkit) -__알림: Electron은 이전까지 Atom Shell로 불려졌습니다.__ +__주의: Electron은 Atom Shell의 새로운 이름입니다.__ NW.js 처럼 Electron은 JavaScript와 HTML 그리고 Node 통합환경을 제공함으로써 웹 페이지에서 저수준 시스템에 접근할 수 있는 웹 기반 데스크탑 어플리케이션을 작성할 수 있도록 합니다. diff --git a/docs-translations/ko/development/build-instructions-linux.md b/docs-translations/ko/development/build-instructions-linux.md index 285b933dd921..adcdab8357ea 100644 --- a/docs-translations/ko/development/build-instructions-linux.md +++ b/docs-translations/ko/development/build-instructions-linux.md @@ -4,7 +4,7 @@ * Python 2.7.x. 몇몇 CentOS와 같은 배포판들은 아직도 Python 2.6.x 버전을 사용합니다. 그래서 `python -V`를 통해 버전을 확인해 줄 필요가 있습니다. * Node.js v0.12.x. Node를 설치하는 방법은 여러가지가 있습니다. 그중 하나는 [Node.js](http://nodejs.org) 사이트에서 소스코드를 받아 빌드하는 방법입니다. -이렇게 하면 Node를 일반 유저로 홈 디렉터리에 설치할 수 있습니다. 또는 [NodeSource](https://nodesource.com/blog/nodejs-v012-iojs-and-the-nodesource-linux-repositories) 에서 받아올 수도 있습니다. +이렇게 하면 Node를 일반 유저로 홈 디렉터리에 설치할 수 있습니다. 또는 [NodeSource](https://nodesource.com/blog/nodejs-v012-iojs-and-the-nodesource-linux-repositories)에서 소스 파일을 받아올 수 있습니다. 자세한 내용은 [Node.js 설치 방법](https://github.com/joyent/node/wiki/Installation) 을 참고하세요. * Clang 3.4 또는 최신 버전 * GTK+ 와 libnotify의 개발용 헤더 @@ -78,7 +78,7 @@ $ ./script/create-dist.py 이 스크립트는 매우 작은 배포판을 `dist` 디렉터리에 생성합니다. create-dist.py 스크립트를 실행한 이후 1.3GB를 초과하는 공간을 차지하는 out/R 폴더의 실행파일 바이너리는 삭제해도 됩니다. -`Debug` 타겟만 빌드 할 수도 있습니다: +또는 `Debug` 타겟만 빌드 할 수 있습니다: ```bash $ ./script/build.py -c D diff --git a/docs-translations/ko/development/build-instructions-mac.md b/docs-translations/ko/development/build-instructions-mac.md index ffab481c5c7c..eeed5a4df4ec 100644 --- a/docs-translations/ko/development/build-instructions-mac.md +++ b/docs-translations/ko/development/build-instructions-mac.md @@ -34,7 +34,7 @@ $ ./script/bootstrap.py -v $ ./script/build.py ``` -`Debug` 타겟만 빌드 할 수도 있습니다: +또는 `Debug` 타겟만 빌드 할 수 있습니다: ```bash $ ./script/build.py -c D diff --git a/docs-translations/ko/development/build-instructions-windows.md b/docs-translations/ko/development/build-instructions-windows.md index df829de319d5..22734b1ec236 100644 --- a/docs-translations/ko/development/build-instructions-windows.md +++ b/docs-translations/ko/development/build-instructions-windows.md @@ -9,7 +9,7 @@ * [git](http://git-scm.com) 현재 Windows를 설치하지 않았다면 [modern.ie](https://www.modern.ie/en-us/virtualization-tools#downloads)에서 -사용기한이 정해져있는 무료 가상머신 버전의 Windows를 받아 Electron을 빌드할 수도 있습니다. +사용 기한이 정해져있는 무료 가상머신 버전의 Windows를 받아 Electron을 빌드하는 방법도 있습니다. Electron은 전적으로 command-line 스크립트를 사용하여 빌드합니다. 그렇기에 Electron을 개발하는데 아무런 에디터나 사용할 수 있습니다. 하지만 이 말은 Visual Studio를 개발을 위해 사용할 수 없다는 말이 됩니다. 나중에 Visual Studio를 이용한 빌드 방법도 제공할 예정입니다. @@ -40,7 +40,7 @@ python script\bootstrap.py -v python script\build.py ``` -`Debug` 타겟만 빌드 할 수도 있습니다: +또는 `Debug` 타겟만 빌드 할 수 있습니다: ```powershell python script\build.py -c D diff --git a/docs-translations/ko/styleguide.md b/docs-translations/ko/styleguide.md index 1916f80c68ef..1168556a3d7b 100644 --- a/docs-translations/ko/styleguide.md +++ b/docs-translations/ko/styleguide.md @@ -41,7 +41,7 @@ Electron 문서 구조를 이해하는 데 참고할 수 있는 유용한 도움 --- 메서드 이름은 인수가 무엇을 받는지에 따라 결정됩니다. 선택적 인수는 브라켓([, ])으로 묶어 -이 인수가 다른 인수뒤에 선택적으로 사용할 수 있다는 것을 설명합니다. +이 인수가 다른 인수뒤에서 선택적으로 사용될 수 있다는 것을 표시합니다. 메서드의 밑에선 각 인수에 대해 자세한 설명을 합니다. 인수의 타입은 일반적인 타입 중 하나를 받거나: [`String`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), [`Number`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number), [`Object`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object), [`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array) diff --git a/docs-translations/ko/tutorial/application-packaging.md b/docs-translations/ko/tutorial/application-packaging.md index 4c799d71da4f..0f8169089516 100644 --- a/docs-translations/ko/tutorial/application-packaging.md +++ b/docs-translations/ko/tutorial/application-packaging.md @@ -134,7 +134,7 @@ originalFs.readFileSync('/path/to/example.asar'); ## `asar` 아카이브에 미리 압축 해제된 파일 추가하기 전술한 바와 같이 몇몇 Node API는 호출 시 해당 파일을 임시폴더에 압축을 해제합니다. -따로 성능문제가 발생할 수 있습니다. 그리고 백신 소프트웨어의 잘못된 오진을 일으킬 수도 있습니다. +이 방법은 성능문제가 발생할 수 있습니다. 그리고 설계상 백신 소프트웨어에서 잘못 진단하여 바이러스로 판단 할 수도 있습니다. 이 문제를 해결하려면 `--unpack` 옵션을 활용하여 파일을 압축이 풀려진 상태로 유지해야 합니다. 다음의 예제는 node 네이티브 모듈의 공유 라이브러리를 unpack 상태로 유지합니다: diff --git a/docs-translations/ko/tutorial/debugging-main-process.md b/docs-translations/ko/tutorial/debugging-main-process.md index f396071cdd12..dcaf6bc9bf36 100644 --- a/docs-translations/ko/tutorial/debugging-main-process.md +++ b/docs-translations/ko/tutorial/debugging-main-process.md @@ -26,13 +26,13 @@ $ node-inspector ### 2. Electron용 디버그 모드 활성화 -다음과 같이 debung 플래그로 Electron을 실행할 수도 있습니다: +다음과 같이 debung 플래그로 Electron을 실행할 수 있습니다: ```bash $ electron --debug=5858 your/app ``` -또는 스크립트 첫번째 라인에서 일시정지: +또는 스크립트 첫번째 라인에서 일시 정지할 수 있습니다: ```bash $ electron --debug-brk=5858 your/app diff --git a/docs-translations/ko/tutorial/online-offline-events.md b/docs-translations/ko/tutorial/online-offline-events.md index 6a2e88fb3e43..3ccf20c7d568 100644 --- a/docs-translations/ko/tutorial/online-offline-events.md +++ b/docs-translations/ko/tutorial/online-offline-events.md @@ -35,10 +35,10 @@ _online-status.html_ ``` -필요한 경우 이 이벤트를 메인 프로세스로 보낼 수도 있습니다. -메인 프로세스는 `navigator` 오브젝트를 가지고 있지 않기 때문에 이 이벤트를 직접 사용할 수 없습니다. -이는 다음 예제와 같이 electron의 inter-process communication(ipc)유틸리티를 사용하여 -이벤트를 메인 프로세스로 전달하는 것으로 해결할 수 있습니다. +물론 필요하다면 이 이벤트를 메인 프로세스로 보낼 수도 있습니다. +하지만 메인 프로세스는 `navigator` 객체를 가지고 있지 않기 때문에 이 이벤트를 직접 사용할 수 없습니다. + +대신 다음 예제와 같이 Electron의 inter-process communication(ipc) 유틸리티를 사용하면 이벤트를 메인 프로세스로 전달할 수 있습니다. _main.js_ diff --git a/docs-translations/ko/tutorial/quick-start.md b/docs-translations/ko/tutorial/quick-start.md index 39d9edfdbfb4..37b48d993342 100644 --- a/docs-translations/ko/tutorial/quick-start.md +++ b/docs-translations/ko/tutorial/quick-start.md @@ -125,7 +125,7 @@ app.on('ready', function() { ## 앱 실행하기 앱을 작성한 후 [어플리케이션 배포](application-distribution.md) 가이드를 따라 앱을 패키징 하고 패키징한 앱을 실행할 수 있습니다. -또는 Electron 실행파일을 다운로드 받아 바로 실행해 볼 수도 있습니다. +또한 Electron 실행파일을 다운로드 받아 바로 실행해 볼 수도 있습니다. ### electron-prebuilt diff --git a/docs-translations/ko/tutorial/using-native-node-modules.md b/docs-translations/ko/tutorial/using-native-node-modules.md index 5b8f71210550..4584ebd460fe 100644 --- a/docs-translations/ko/tutorial/using-native-node-modules.md +++ b/docs-translations/ko/tutorial/using-native-node-modules.md @@ -40,7 +40,7 @@ $ HOME=~/.electron-gyp node-gyp rebuild --target=0.29.1 --arch=x64 --dist-url=ht ### npm을 이용한 방법 -또한 `npm`을 사용하여 모듈을 설치할 수도 있습니다. +또한 `npm`을 통해 설치할 수도 있습니다. 환경변수가 필요한 것을 제외하고 일반 Node 모듈을 설치하는 방법과 완전히 똑같습니다: ```bash diff --git a/docs-translations/ko/tutorial/using-pepper-flash-plugin.md b/docs-translations/ko/tutorial/using-pepper-flash-plugin.md index 4a471c2464e2..4577bc296fea 100644 --- a/docs-translations/ko/tutorial/using-pepper-flash-plugin.md +++ b/docs-translations/ko/tutorial/using-pepper-flash-plugin.md @@ -1,6 +1,7 @@ # Pepper 플래시 플러그인 사용하기 -필요하다면 Pepper 플래시 플러그인을 사용할 수 있습니다. Electron에서 pepper 플래시 플러그인을 사용하기 위해선 따로 pepper 플래시 플러그인의 위치를 지정해 주어야합니다. +작업에 필요한 경우 pepper 플래시 플러그인을 사용할 수 있습니다. +Electron에서 pepper 플래시 플러그인을 사용하기 위해선 따로 pepper 플래시 플러그인의 위치를 지정해 주어야합니다. ## 플래시 플러그인 준비하기 From e0a57a0a47bd225eefac896dcbc0733fbcad92fa Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Mon, 31 Aug 2015 19:10:29 -0700 Subject: [PATCH 1051/1293] Standardize app dist --- docs/tutorial/application-distribution.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/tutorial/application-distribution.md b/docs/tutorial/application-distribution.md index c0e8bebc4041..4f1f5202a008 100644 --- a/docs/tutorial/application-distribution.md +++ b/docs/tutorial/application-distribution.md @@ -1,9 +1,9 @@ -# Application distribution +# Application Distribution -To distribute your app with Electron, you should name the folder of your app -as `app`, and put it under Electron's resources directory (on OS X it is -`Electron.app/Contents/Resources/`, and on Linux and Windows it is -`resources/`), like this: +To distribute your app with Electron, the folder containing your app should be +named `app` and placed under Electron's resources directory (on OS X it is +`Electron.app/Contents/Resources/` and on Linux and Windows it is `resources/`), +like this: On OS X: @@ -24,12 +24,12 @@ electron/resources/app ``` Then execute `Electron.app` (or `electron` on Linux, `electron.exe` on Windows), -and Electron will start as your app. The `electron` directory would then be -your distribution that should be delivered to final users. +and Electron will start as your app. The `electron` directory will then be +your distribution to deliver to final users. -## Packaging your app into a file +## Packaging Your App into a File -Apart from shipping your app by copying all its sources files, you can also +Apart from shipping your app by copying all of its source files, you can also package your app into an [asar](https://github.com/atom/asar) archive to avoid exposing your app's source code to users. @@ -53,7 +53,7 @@ electron/resources/ More details can be found in [Application packaging](application-packaging.md). -## Rebranding with downloaded binaries +## Rebranding with Downloaded Binaries After bundling your app into Electron, you will want to rebrand Electron before distributing it to users. @@ -103,7 +103,7 @@ MyApp.app/Contents You can rename the `electron` executable to any name you like. -## Rebranding by rebuilding Electron from source +## Rebranding by Rebuilding Electron from Source It is also possible to rebrand Electron by changing the product name and building it from source. To do this you need to modify the `atom.gyp` file and From 96bb9b2757e9f8410fe69f5613b6c993359cac11 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Mon, 31 Aug 2015 19:12:33 -0700 Subject: [PATCH 1052/1293] Standardize app packaging --- docs/tutorial/application-packaging.md | 44 +++++++++++++------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/docs/tutorial/application-packaging.md b/docs/tutorial/application-packaging.md index 7568204fb62f..0cf3a6b596f4 100644 --- a/docs/tutorial/application-packaging.md +++ b/docs/tutorial/application-packaging.md @@ -1,18 +1,19 @@ -# Application packaging +# Application Packaging -To mitigate [issues](https://github.com/joyent/node/issues/6960) around long path names on Windows, slightly speed up `require` and conceal your source code from cursory inspection you can choose -to package your app into an [asar][asar] archive with little changes to your -source code. +To mitigate [issues](https://github.com/joyent/node/issues/6960) around long +path names on Windows, slightly speed up `require` and conceal your source code +from cursory inspection, you can choose to package your app into an [asar][asar] +archive with little changes to your source code. -## Generating `asar` archive +## Generating `asar` Archive An [asar][asar] archive is a simple tar-like format that concatenates files -into a single file, Electron can read arbitrary files from it without unpacking +into a single file. Electron can read arbitrary files from it without unpacking the whole file. -Following is the steps to package your app into an `asar` archive: +Steps to package your app into an `asar` archive: -### 1. Install the asar utility +### 1. Install the asar Utility ```bash $ npm install -g asar @@ -24,9 +25,9 @@ $ npm install -g asar $ asar pack your-app app.asar ``` -## Using `asar` archives +## Using `asar` Archives -In Electron there are two sets of APIs: Node APIs provided by Node.js, and Web +In Electron there are two sets of APIs: Node APIs provided by Node.js and Web APIs provided by Chromium. Both APIs support reading files from `asar` archives. ### Node API @@ -77,8 +78,8 @@ win.loadUrl('file:///path/to/example.asar/static/index.html'); ### Web API -In a web page, files in archive can be requested with the `file:` protocol. Like -the Node API, `asar` archives are treated as directories. +In a web page, files in an archive can be requested with the `file:` protocol. +Like the Node API, `asar` archives are treated as directories. For example, to get a file with `$.get`: @@ -91,7 +92,7 @@ $.get('file:///path/to/example.asar/file.txt', function(data) { ``` -### Treating `asar` archive as normal file +### Treating an `asar` Archive as a Normal File For some cases like verifying the `asar` archive's checksum, we need to read the content of `asar` archive as file. For this purpose you can use the built-in @@ -108,21 +109,21 @@ Even though we tried hard to make `asar` archives in the Node API work like directories as much as possible, there are still limitations due to the low-level nature of the Node API. -### Archives are read only +### Archives Are Read-only The archives can not be modified so all Node APIs that can modify files will not work with `asar` archives. -### Working directory can not be set to directories in archive +### Working Directory Can Not Be Set to Directories in Archive Though `asar` archives are treated as directories, there are no actual directories in the filesystem, so you can never set the working directory to -directories in `asar` archives, passing them to `cwd` option of some APIs will -also cause errors. +directories in `asar` archives. Passing them as the `cwd` option of some APIs +will also cause errors. -### Extra unpacking on some APIs +### Extra Unpacking on Some APIs -Most `fs` APIs can read file or get file's information from `asar` archives +Most `fs` APIs can read a file or get a file's information from `asar` archives without unpacking, but for some APIs that rely on passing the real file path to underlying system calls, Electron will extract the needed file into a temporary file and pass the path of the temporary file to the APIs to make them @@ -135,14 +136,14 @@ APIs that requires extra unpacking are: * `fs.openSync` * `process.dlopen` - Used by `require` on native modules -### Fake stat information of `fs.stat` +### Fake Stat Information of `fs.stat` The `Stats` object returned by `fs.stat` and its friends on files in `asar` archives is generated by guessing, because those files do not exist on the filesystem. So you should not trust the `Stats` object except for getting file size and checking file type. -## Adding unpacked files in `asar` archive +## Adding Unpacked Files in `asar` Archive As stated above, some Node APIs will unpack the file to filesystem when calling, apart from the performance issues, it could also lead to false alerts @@ -161,4 +162,3 @@ After running the command, apart from the `app.asar`, there is also an should copy it together with `app.asar` when shipping it to users. [asar]: https://github.com/atom/asar - From 0e4ae6f86475c2d06d02750efa86dbdc9e87b307 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Mon, 31 Aug 2015 19:12:57 -0700 Subject: [PATCH 1053/1293] Standardize debug main process --- docs/tutorial/debugging-main-process.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/docs/tutorial/debugging-main-process.md b/docs/tutorial/debugging-main-process.md index 5874dc5e779e..f4e345a2f3a5 100644 --- a/docs/tutorial/debugging-main-process.md +++ b/docs/tutorial/debugging-main-process.md @@ -1,25 +1,26 @@ -# Debugging the main process +# Debugging the Main Process -The devtools of browser window can only debug the renderer process scripts. -(I.e. the web pages.) In order to provide a way to debug the scripts of -the main process, Electron has provided the `--debug` and `--debug-brk` -switches. +The browser window devtools can only debug the renderer process scripts (i.e. +the web pages). In order to provide a way to debug the scripts from the main +process, Electron has provided the `--debug` and `--debug-brk` switches. -## Command line switches +## Command Line Switches + +Use the following command line switches to debug Electron's main process: ### `--debug=[port]` -When this switch is used Electron would listen for V8 debugger protocol -messages on `port`, the `port` is `5858` by default. +When this switch is used Electron will listen for V8 debugger protocol +messages on `port`. The default `port` is `5858`. ### `--debug-brk=[port]` Like `--debug` but pauses the script on the first line. -## Use node-inspector for debugging +## Use node-inspector for Debugging __Note:__ Electron uses node v0.11.13, which currently doesn't work very well -with node-inspector, and the main process would crash if you inspect the +with node-inspector, and the main process will crash if you inspect the `process` object under node-inspector's console. ### 1. Start the [node-inspector][node-inspector] server From c6269bf77a7f567124cdc5e740782e90984dbd4d Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Mon, 31 Aug 2015 19:13:27 -0700 Subject: [PATCH 1054/1293] Standardize desktop env integration --- .../desktop-environment-integration.md | 51 +++++++++---------- 1 file changed, 25 insertions(+), 26 deletions(-) diff --git a/docs/tutorial/desktop-environment-integration.md b/docs/tutorial/desktop-environment-integration.md index 80b4c456938b..3bde4b592407 100644 --- a/docs/tutorial/desktop-environment-integration.md +++ b/docs/tutorial/desktop-environment-integration.md @@ -1,8 +1,8 @@ -# Desktop environment integration +# Desktop Environment Integration -Different operating systems provide different features on integrating desktop -applications into their desktop environments. For example, on Windows -applications can put shortcuts in the JumpList of task bar, and on Mac +Different operating systems provide different features for integrating desktop +applications into their desktop environments. For example, on Windows, +applications can put shortcuts in the JumpList of task bar, and on Mac, applications can put a custom menu in the dock menu. This guide explains how to integrate your application into those desktop @@ -11,7 +11,7 @@ environments with Electron APIs. ## Recent documents (Windows & OS X) Windows and OS X provide easy access to a list of recent documents opened by -the application via JumpList and dock menu. +the application via JumpList or dock menu, respectively. __JumpList:__ @@ -21,7 +21,7 @@ __Application dock menu:__ -To add a file to recent documents, you can use +To add a file to recent documents, you can use the [app.addRecentDocument][addrecentdocument] API: ```javascript @@ -29,29 +29,28 @@ var app = require('app'); app.addRecentDocument('/Users/USERNAME/Desktop/work.type'); ``` -And you can use [app.clearRecentDocuments](clearrecentdocuments) API to empty +You can use [app.clearRecentDocuments](clearrecentdocuments) API to empty the recent documents list: ```javascript app.clearRecentDocuments(); ``` -### Windows notes +### Windows Notes In order to be able to use this feature on Windows, your application has to be registered as a handler of the file type of the document, otherwise the file won't appear in JumpList even after you have added it. You can find everything on registering your application in [Application Registration][app-registration]. -When a user clicks a file from JumpList, a new instance of your application will -be started with the path of the file added as a command line argument. +When a user clicks a file from the JumpList, a new instance of your application will be started with the path of the file added as a command line argument. -### OS X notes +### OS X Notes When a file is requested from the recent documents menu, the `open-file` event -of `app` module would be emitted for it. +of `app` module will be emitted for it. -## Custom dock menu (OS X) +## Custom Dock Menu (OS X) OS X enables developers to specify a custom menu for the dock, which usually contains some shortcuts for commonly used features of your application: @@ -77,7 +76,7 @@ var dockMenu = Menu.buildFromTemplate([ app.dock.setMenu(dockMenu); ``` -## User tasks (Windows) +## User Tasks (Windows) On Windows you can specify custom actions in the `Tasks` category of JumpList, as quoted from MSDN: @@ -104,7 +103,7 @@ __Tasks of Internet Explorer:__ ![IE](http://i.msdn.microsoft.com/dynimg/IC420539.png) Unlike the dock menu in OS X which is a real menu, user tasks in Windows work -like application shortcuts that when user clicks a task, a program would be +like application shortcuts such that when user clicks a task, a program will be executed with specified arguments. To set user tasks for your application, you can use @@ -124,7 +123,7 @@ app.setUserTasks([ ]); ``` -To clean your tasks list, just call `app.setUserTasks` with empty array: +To clean your tasks list, just call `app.setUserTasks` with an empty array: ```javascript app.setUserTasks([]); @@ -136,9 +135,9 @@ uninstalled. ## Thumbnail Toolbars -On Windows, you can add a thumbnail toolbar with specified buttons in a taskbar -layout of an application window. It provides users a way to access to a particualr -window's command without restoring or activating the window. +On Windows you can add a thumbnail toolbar with specified buttons in a taskbar +layout of an application window. It provides users a way to access to a +particular window's command without restoring or activating the window. From MSDN, it's illustrated: @@ -187,18 +186,18 @@ with an empty array: win.setThumbarButtons([]); ``` -## Unity launcher shortcuts (Linux) +## Unity Launcher Shortcuts (Linux) -In Unity, you can add custom entries to its launcher via modifying `.desktop` -file, see [Adding shortcuts to a launcher][unity-launcher]. +In Unity, you can add custom entries to its launcher via modifying the `.desktop` +file, see [Adding Shortcuts to a Launcher][unity-launcher]. __Launcher shortcuts of Audacious:__ ![audacious](https://help.ubuntu.com/community/UnityLaunchersAndDesktopFiles?action=AttachFile&do=get&target=shortcuts.png) -## Progress bar in taskbar (Windows & Unity) +## Progress Bar in Taskbar (Windows & Unity) -On Windows, a taskbar button can be used to display a progress bar. This enables +On Windows a taskbar button can be used to display a progress bar. This enables a window to provide progress information to the user without the user having to switch to the window itself. @@ -221,10 +220,10 @@ var window = new BrowserWindow({...}); window.setProgressBar(0.5); ``` -## Represented file of window (OS X) +## Represented File of Window (OS X) On OS X a window can set its represented file, so the file's icon can show in -the title bar, and when users Command-Click or Control-Click on the tile a path +the title bar and when users Command-Click or Control-Click on the tile a path popup will show. You can also set the edited state of a window so that the file icon can indicate From a5234224a6c3bfaf02cf18dc0a4ca7613cc35a5c Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Mon, 31 Aug 2015 19:17:41 -0700 Subject: [PATCH 1055/1293] Standardize devtools --- docs/tutorial/devtools-extension.md | 47 ++++++++++++++++------------- 1 file changed, 26 insertions(+), 21 deletions(-) diff --git a/docs/tutorial/devtools-extension.md b/docs/tutorial/devtools-extension.md index 731de4e13f8b..e9466f14b648 100644 --- a/docs/tutorial/devtools-extension.md +++ b/docs/tutorial/devtools-extension.md @@ -1,52 +1,57 @@ -# DevTools extension +# DevTools Extension -To make debugging easier, Electron has basic support for +To make debugging easier, Electron has basic support for the [Chrome DevTools Extension][devtools-extension]. -For most devtools extensions, you can simply download the source code and use -the `BrowserWindow.addDevToolsExtension` API to load them, the loaded extensions +For most DevTools extensions you can simply download the source code and use +the `BrowserWindow.addDevToolsExtension` API to load them. The loaded extensions will be remembered so you don't need to call the API every time when creating a window. -For example to use the [React DevTools Extension](https://github.com/facebook/react-devtools), first you need to download its -source code: +For example, to use the [React DevTools Extension](https://github.com/facebook/react-devtools) +, first you need to download its source code: ```bash $ cd /some-directory $ git clone --recursive https://github.com/facebook/react-devtools.git ``` -Then you can load the extension in Electron by opening devtools in any window, -and then running the following code in the devtools console: +Then you can load the extension in Electron by opening DevTools in any window, +and running the following code in the DevTools console: ```javascript require('remote').require('browser-window').addDevToolsExtension('/some-directory/react-devtools'); ``` -To unload the extension, you can call `BrowserWindow.removeDevToolsExtension` -API with its name and it will not load the next time you open the devtools: +To unload the extension, you can call the `BrowserWindow.removeDevToolsExtension` +API with its name and it will not load the next time you open the DevTools: ```javascript require('remote').require('browser-window').removeDevToolsExtension('React Developer Tools'); ``` -## Format of devtools extension +## Format of DevTools Extension -Ideally all devtools extension written for Chrome browser can be loaded by -Electron, but they have to be in a plain directory, for those packaged `crx` -extensions, there is no way for Electron to load them unless you find a way to -extract them into a directory. +Ideally all DevTools extensions written for the Chrome browser can be loaded by +Electron, but they have to be in a plain directory. For those packaged with +`crx` extensions, there is no way for Electron to load them unless you find a +way to extract them into a directory. -## Background pages +## Background Pages -Currently Electron doesn't support the background pages feature in chrome extensions, -so for some devtools extensions that rely on this feature, they may not work in Electron. +Currently Electron doesn't support the background pages feature in Chrome +extensions, so some DevTools extensions that rely on this feature may +not work in Electron. ## `chrome.*` APIs -Some chrome extensions use `chrome.*` APIs for some features, there has been some -effort to implement those APIs in Electron, however not all are implemented. +Some Chrome extensions may use `chrome.*` APIs for features and while there has +been some effort to implement those APIs in Electron, not all have been +implemented. -Given that not all `chrome.*` APIs are implemented if the devtools extension is using APIs other than `chrome.devtools.*`, the extension is very likely not to work. You can report failing extensions in the issue tracker so that we can add support for those APIs. +Given that not all `chrome.*` APIs are implemented if the DevTools extension is +using APIs other than `chrome.devtools.*`, the extension is very likely not to +work. You can report failing extensions in the issue tracker so that we can add +support for those APIs. [devtools-extension]: https://developer.chrome.com/extensions/devtools From 52916f70ed3d437337e8487c644df0247e3ff376 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Mon, 31 Aug 2015 19:17:59 -0700 Subject: [PATCH 1056/1293] Standardize online-offline --- docs/tutorial/online-offline-events.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/tutorial/online-offline-events.md b/docs/tutorial/online-offline-events.md index a8d669454069..88f9a32f2ec6 100644 --- a/docs/tutorial/online-offline-events.md +++ b/docs/tutorial/online-offline-events.md @@ -36,9 +36,9 @@ _online-status.html_ ``` -There may be instances where one wants to respond to these events in the -main process as well. The main process however does not have a -`navigator` object and thus cannot detect these events directly. Using +There may be instances where you want to respond to these events in the +main process as well. The main process however does not have a +`navigator` object and thus cannot detect these events directly. Using Electron's inter-process communication utilities, the events can be forwarded to the main process and handled as needed, as shown in the following example. From 6a2bd80a9a2bb35cbc78aceccb6df8912e4a8c0e Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Mon, 31 Aug 2015 19:18:46 -0700 Subject: [PATCH 1057/1293] Standardize quick-start --- docs/tutorial/quick-start.md | 56 ++++++++++++++++++++---------------- 1 file changed, 31 insertions(+), 25 deletions(-) diff --git a/docs/tutorial/quick-start.md b/docs/tutorial/quick-start.md index 8fc696e0bcda..93cd0ebc5bd9 100644 --- a/docs/tutorial/quick-start.md +++ b/docs/tutorial/quick-start.md @@ -1,20 +1,21 @@ -# Quick start +# Quick Start -## Introduction +Electron enables you to create desktop applications with pure JavaScript by +providing a runtime with rich native (operating system) APIs. You could see it +as a variant of the io.js runtime that is focused on desktop applications +instead of web servers. -Electron enables you to create desktop applications with pure JavaScript by providing a runtime with rich native APIs. You could see it as a variant of the io.js runtime which is focused on desktop applications instead of web servers. +This doesn't mean Electron is a JavaScript binding to graphical user interface +(GUI) libraries. Instead, Electron uses web pages as its GUI, so you could also +see it as a minimal Chromium browser, controlled by JavaScript. -This doesn't mean Electron is a JavaScript binding to GUI libraries. Instead, -Electron uses web pages as its GUI, so you could also see it as a minimal -Chromium browser, controlled by JavaScript. - -### Main process +### Main Process In Electron, the process that runs `package.json`'s `main` script is called -__the main process__. The script that runs in the main process can display a GUI by -creating web pages. +__the main process__. The script that runs in the main process can display a GUI +by creating web pages. -### Renderer process +### Renderer Process Since Electron uses Chromium for displaying web pages, Chromium's multi-process architecture is also used. Each web page in Electron runs in @@ -24,28 +25,30 @@ In normal browsers, web pages usually run in a sandboxed environment and are not allowed access to native resources. Electron users, however, have the power to use io.js APIs in web pages allowing lower level operating system interactions. -### Differences between main process and renderer process +### Differences Between Main Process and Renderer Process -The main process creates web pages by creating `BrowserWindow` instances. Each `BrowserWindow` instance runs the web page in its own renderer process. When a `BrowserWindow` instance is destroyed, the corresponding renderer process +The main process creates web pages by creating `BrowserWindow` instances. Each +`BrowserWindow` instance runs the web page in its own renderer process. When a +`BrowserWindow` instance is destroyed, the corresponding renderer process is also terminated. The main process manages all web pages and their corresponding renderer processes. Each renderer process is isolated and only cares about the web page running in it. -In web pages, it is not allowed to call native GUI related APIs because managing -native GUI resources in web pages is very dangerous and it is easy to leak resources. -If you want to perform GUI operations in a web page, the renderer process of the web -page must communicate with the main process to request the main process perform those -operations. +In web pages, calling native GUI related APIs is not allowed because managing +native GUI resources in web pages is very dangerous and it is easy to leak +resources. If you want to perform GUI operations in a web page, the renderer +process of the web page must communicate with the main process to request that +the main process perform those operations. In Electron, we have provided the [ipc](../api/ipc-renderer.md) module for -communication between main process and renderer process. And there is also a +communication between the main process and renderer process. There is also a [remote](../api/remote.md) module for RPC style communication. -## Write your first Electron app +## Write your First Electron App -Generally, an Electron app would be structured like this: +Generally, an Electron app is structured like this: ```text your-app/ @@ -56,7 +59,7 @@ your-app/ The format of `package.json` is exactly the same as that of Node's modules, and the script specified by the `main` field is the startup script of your app, -which will run on the main process. An example of your `package.json` might look +which will run the main process. An example of your `package.json` might look like this: ```json @@ -81,7 +84,7 @@ var BrowserWindow = require('browser-window'); // Module to create native brows require('crash-reporter').start(); // Keep a global reference of the window object, if you don't, the window will -// be closed automatically when the JavaScript object is GCed. +// be closed automatically when the JavaScript object is garbage collected. var mainWindow = null; // Quit when all windows are closed. @@ -102,7 +105,7 @@ app.on('ready', function() { // and load the index.html of the app. mainWindow.loadUrl('file://' + __dirname + '/index.html'); - // Open the devtools. + // Open the DevTools. mainWindow.openDevTools(); // Emitted when the window is closed. @@ -138,6 +141,7 @@ you'll probably want to try running your app locally to test it and make sure it working as expected. ### electron-prebuilt + If you've installed `electron-prebuilt` globally with `npm`, then you need only run the following in your app's source directory: @@ -152,6 +156,7 @@ If you've installed it locally, then run: ``` ### Manually Downloaded Electron Binary + If you downloaded Electron manually, you can also just use the included binary to execute your app directly. @@ -177,6 +182,7 @@ $ ./Electron.app/Contents/MacOS/Electron your-app/ it from [here](https://github.com/atom/electron/releases). ### Run as a distribution + After you're done writing your app, you can create a distribution by -following the [Application distribution](./application-distribution.md) guide +following the [Application Distribution](./application-distribution.md) guide and then executing the packaged app. From be73388918ebed45469a610c57a0b587f18817ef Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Mon, 31 Aug 2015 19:22:06 -0700 Subject: [PATCH 1058/1293] Standardize native modules --- docs/tutorial/using-native-node-modules.md | 29 ++++++++++++---------- 1 file changed, 16 insertions(+), 13 deletions(-) diff --git a/docs/tutorial/using-native-node-modules.md b/docs/tutorial/using-native-node-modules.md index 918c8a67a94a..4d61f70cf6db 100644 --- a/docs/tutorial/using-native-node-modules.md +++ b/docs/tutorial/using-native-node-modules.md @@ -1,37 +1,40 @@ -# Using native Node modules +# Using Native Node Modules The native Node modules are supported by Electron, but since Electron is using a different V8 version from official Node, you have to manually specify the location of Electron's headers when building native modules. -## Native Node module compatibility +## Native Node Module Compatibility Since Node v0.11.x there were vital changes in the V8 API. So generally all -native modules written for Node v0.10.x wouldn't work for newer Node or io.js versions. And -because Electron internally uses __io.js v3.1.0__, it carries with the same -problem. +native modules written for Node v0.10.x won't work for newer Node or io.js +versions. And because Electron internally uses __io.js v3.1.0__, it has the +same problem. To solve this, you should use modules that support Node v0.11.x or later, [many modules](https://www.npmjs.org/browse/depended/nan) do support both now. For old modules that only support Node v0.10.x, you should use the -[nan](https://github.com/rvagg/nan) module to port it to v0.11.x or later versions of Node or io.js. +[nan](https://github.com/rvagg/nan) module to port it to v0.11.x or later +versions of Node or io.js. -## How to install native modules +## How to Install Native Modules + +Three ways to install native modules: ### The Easy Way -The most straightforward way to rebuild native modules is via the -[`electron-rebuild`](https://github.com/paulcbetts/electron-rebuild) package, +The most straightforward way to rebuild native modules is via the +[`electron-rebuild`](https://github.com/paulcbetts/electron-rebuild) package, which handles the manual steps of downloading headers and building native modules: ```sh npm install --save-dev electron-rebuild -# Every time you run npm install, run this too +# Every time you run npm install, run this ./node_modules/.bin/electron-rebuild ``` -### The node-gyp way +### The node-gyp Way To build Node modules with headers of Electron, you need to tell `node-gyp` where to download headers and which version to use: @@ -46,9 +49,9 @@ The `HOME=~/.electron-gyp` changes where to find development headers. The where to download the headers. The `--arch=x64` says the module is built for 64bit system. -### The npm way +### The npm Way -You can also use `npm` to install modules, the steps are exactly the same with +You can also use `npm` to install modules. The steps are exactly the same with Node modules, except that you need to setup some environment variables: ```bash From cb4558e75b3b5019877934944c578c5a3e01f5d2 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Mon, 31 Aug 2015 19:23:43 -0700 Subject: [PATCH 1059/1293] Standardize pepper flash --- docs/tutorial/using-pepper-flash-plugin.md | 22 ++++++++++++++++------ 1 file changed, 16 insertions(+), 6 deletions(-) diff --git a/docs/tutorial/using-pepper-flash-plugin.md b/docs/tutorial/using-pepper-flash-plugin.md index 20b29c4114a9..5c8820c2fad4 100644 --- a/docs/tutorial/using-pepper-flash-plugin.md +++ b/docs/tutorial/using-pepper-flash-plugin.md @@ -1,14 +1,22 @@ # Using Pepper Flash Plugin -Pepper flash plugin is now supported. To use pepper flash plugin in Electron, you should manually specify the location of pepper flash plugin and then enable it in your application. +Electron now supports the Pepper Flash plugin. To use the Pepper Flash plugin in +Electron, you should manually specify the location of the Pepper Flash plugin +and then enable it in your application. -## Prepare a copy of flash plugin +## Prepare a Copy of Flash Plugin -On OS X and Linux, the detail of pepper flash plugin can be found by navigating `chrome://plugins` in Chrome browser. Its location and version are useful for electron's pepper flash support. You can also copy it to anywhere else. +On OS X and Linux, the details of the Pepper Flash plugin can be found by +navigating to `chrome://plugins` in the Chrome browser. Its location and version +are useful for Electron's Pepper Flash support. You can also copy it to another +location. -## Add Electron switch +## Add Electron Switch -You can directly add `--ppapi-flash-path` and `ppapi-flash-version` to electron commandline or by `app.commandLine.appendSwitch` method before app ready event. Also, add the `plugins` switch of `browser-window`. For example, +You can directly add `--ppapi-flash-path` and `ppapi-flash-version` to the +Electron command line or by using the `app.commandLine.appendSwitch` method +before the app ready event. Also, add the `plugins` switch of `browser-window`. +For example: ```javascript var app = require('app'); @@ -50,8 +58,10 @@ app.on('ready', function() { }); ``` -## Enable flash plugin in a `` tag +## Enable Flash Plugin in a `` Tag + Add `plugins` attribute to `` tag. + ```html ``` From d9c3830df73e636992e5e73fb4d4c66034de9b1a Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Mon, 31 Aug 2015 19:32:25 -0700 Subject: [PATCH 1060/1293] Standardize selenium and webdriver --- docs/tutorial/using-selenium-and-webdriver.md | 28 ++++++++++--------- 1 file changed, 15 insertions(+), 13 deletions(-) diff --git a/docs/tutorial/using-selenium-and-webdriver.md b/docs/tutorial/using-selenium-and-webdriver.md index f3b7310dfbe5..5bb6aa3e6c36 100644 --- a/docs/tutorial/using-selenium-and-webdriver.md +++ b/docs/tutorial/using-selenium-and-webdriver.md @@ -9,20 +9,20 @@ From [ChromeDriver - WebDriver for Chrome][chrome-driver]: > members of the Chromium and WebDriver teams. In Electron's [releases](https://github.com/atom/electron/releases) page you -can find archives of `chromedriver`, there is no difference between Electron's -distribution of `chromedriver` and upstream ones, so in order to use -`chromedriver` together with Electron, you will need some special setup. +can find archives of `chromedriver`. There is no difference between Electron's +distribution of `chromedriver` and the upstream ones, but in order to use +`chromedriver` with Electron, you will need a special setup. -Also notice that only minor version update releases (e.g. `vX.X.0` releases) +Also note that only minor version update releases (e.g. `vX.X.0` releases) include `chromedriver` archives, because `chromedriver` doesn't change as frequent as Electron itself. ## Setting up with WebDriverJs -[WebDriverJs](https://code.google.com/p/selenium/wiki/WebDriverJs) provided +[WebDriverJs](https://code.google.com/p/selenium/wiki/WebDriverJs) provides a Node package for testing with web driver, we will use it as an example. -### 1. Start chrome driver +### 1. Start ChromeDriver First you need to download the `chromedriver` binary, and run it: @@ -40,7 +40,7 @@ Remember the port number `9515`, which will be used later $ npm install selenium-webdriver ``` -### 3. Connect to chrome driver +### 3. Connect to ChromeDriver The usage of `selenium-webdriver` with Electron is basically the same with upstream, except that you have to manually specify how to connect chrome driver @@ -72,9 +72,10 @@ driver.quit(); ## Setting up with WebdriverIO -[WebdriverIO](http://webdriver.io/) provides a Node package for testing with web driver. +[WebdriverIO](http://webdriver.io/) provides a Node package for testing with web +driver. -### 1. Start chrome driver +### 1. Start ChromeDriver First you need to download the `chromedriver` binary, and run it: @@ -93,10 +94,11 @@ $ npm install webdriverio ``` ### 3. Connect to chrome driver + ```javascript var webdriverio = require('webdriverio'); var options = { - host: "localhost", // Use localhost as chrome driver server + host: "localhost", // Use localhost as chrome driver server port: 9515, // "9515" is the port opened by chrome driver. desiredCapabilities: { browserName: 'chrome', @@ -119,8 +121,8 @@ client ## Workflow -To test your application without rebuilding Electron, simply [place](https://github.com/atom/electron/blob/master/docs/tutorial/application-distribution.md) your app source into Electron's resource directory. +To test your application without rebuilding Electron, simply +[place](https://github.com/atom/electron/blob/master/docs/tutorial/application-distribution.md) +your app source into Electron's resource directory. [chrome-driver]: https://sites.google.com/a/chromium.org/chromedriver/ - - From 05d0f17447fe198d732b529e08a8f4209981cc79 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Mon, 31 Aug 2015 20:05:57 -0700 Subject: [PATCH 1061/1293] Updates from inline comments --- docs/api/web-frame.md | 2 +- docs/api/web-view-tag.md | 32 ++++++++++++++++---------------- 2 files changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/api/web-frame.md b/docs/api/web-frame.md index 4d42dd78ea50..1d472a87adff 100644 --- a/docs/api/web-frame.md +++ b/docs/api/web-frame.md @@ -29,7 +29,7 @@ Returns the current zoom factor. * `level` Number - Zoom level -Changes the zoom level to the specified level. The "original size" is 0 and each +Changes the zoom level to the specified level. The original size is 0 and each increment above or below represents zooming 20% larger or smaller to default limits of 300% and 50% of original size, respectively. diff --git a/docs/api/web-view-tag.md b/docs/api/web-view-tag.md index 4e8ded6651f9..d004c9522716 100644 --- a/docs/api/web-view-tag.md +++ b/docs/api/web-view-tag.md @@ -2,10 +2,10 @@ Use the `webview` tag to embed 'guest' content (such as web pages) in your Electron app. The guest content is contained within the `webview` container. -An embedder page within your app controls how the guest content is laid out and +An embedded page within your app controls how the guest content is laid out and rendered. -Different from an `iframe`, the `webview` runs in a separate process than your +Unlike an `iframe`, the `webview` runs in a separate process than your app. It doesn't have the same permissions as your web page and all interactions between your app and embedded content will be asynchronous. This keeps your app safe from the embedded content. @@ -71,7 +71,7 @@ The `src` attribute can also accept data URLs, such as If "on", the `webview` container will automatically resize within the bounds specified by the attributes `minwidth`, `minheight`, `maxwidth`, and -`maxheight`. These constraints do not impact the `webview` UNLESS `autosize` is +`maxheight`. These constraints do not impact the `webview` unless `autosize` is enabled. When `autosize` is enabled, the `webview` container size cannot be less than the minimum values or greater than the maximum. @@ -104,7 +104,7 @@ will be loaded by `require` in guest page under the hood. When the guest page doesn't have node integration this script will still have access to all Node APIs, but global objects injected by Node will be deleted -after this script has completed execution. +after this script has finished executing. ### `httpreferrer` @@ -158,7 +158,7 @@ Returns a boolean whether guest page is still loading resources. ### `.isWaitingForResponse()` -Returns a boolean whether guest page is waiting for a first-response for the +Returns a boolean whether the guest page is waiting for a first-response for the main resource of the page. ### `.stop()` @@ -167,25 +167,25 @@ Stops any pending navigation. ### `.reload()` -Reloads guest page. +Reloads the guest page. ### `.reloadIgnoringCache()` -Reloads guest page and ignores cache. +Reloads the guest page and ignores cache. ### `.canGoBack()` -Returns a boolean whether guest page can go back. +Returns a boolean whether the guest page can go back. ### `.canGoForward()` -Returns a boolean whether guest page can go forward. +Returns a boolean whether the guest page can go forward. ### `.canGoToOffset(offset)` * `offset` Integer -Returns a boolean whether guest page can go to `offset`. +Returns a boolean whether the guest page can go to `offset`. ### `.clearHistory()` @@ -193,11 +193,11 @@ Clears the navigation history. ### `.goBack()` -Makes guest page go back. +Makes the guest page go back. ### `.goForward()` -Makes guest page go forward. +Makes the guest page go forward. ### `.goToIndex(index)` @@ -219,7 +219,7 @@ Whether the renderer process has crashed. * `userAgent` String -Overrides the user agent for guest page. +Overrides the user agent for the guest page. ### `.getUserAgent()` @@ -229,7 +229,7 @@ Returns a `String` representing the user agent for guest page. * `css` String -Injects CSS into guest page. +Injects CSS into the guest page. ### `.executeJavaScript(code, userGesture)` @@ -237,8 +237,8 @@ Injects CSS into guest page. * `userGesture` Boolean - Default `false`. Evaluates `code` in page. If `userGesture` is set, it will create user gesture -context. HTML APIs like `requestFullScreen`, which require user action, can take -advantage of this option for automation. +context in the page. HTML APIs like `requestFullScreen`, which require user +action, can take advantage of this option for automation. ### `.openDevTools()` From a03df3ac5aef2cd5f0d35f24941d9aba6d7e8084 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Mon, 31 Aug 2015 20:17:14 -0700 Subject: [PATCH 1062/1293] "the" --- docs/api/web-view-tag.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/api/web-view-tag.md b/docs/api/web-view-tag.md index d004c9522716..6b64a0269c52 100644 --- a/docs/api/web-view-tag.md +++ b/docs/api/web-view-tag.md @@ -236,9 +236,9 @@ Injects CSS into the guest page. * `code` String * `userGesture` Boolean - Default `false`. -Evaluates `code` in page. If `userGesture` is set, it will create user gesture -context in the page. HTML APIs like `requestFullScreen`, which require user -action, can take advantage of this option for automation. +Evaluates `code` in page. If `userGesture` is set, it will the create user +gesture context in the page. HTML APIs like `requestFullScreen`, which require +user action, can take advantage of this option for automation. ### `.openDevTools()` From 50bfe9e335279491706c5c4ab13e53bc9c0bcdae Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 1 Sep 2015 11:29:39 +0800 Subject: [PATCH 1063/1293] Set source and origin correctly for window.opener.postMessage --- atom/browser/lib/guest-window-manager.coffee | 14 ++++++++++---- atom/renderer/lib/override.coffee | 18 +++++++++++++----- 2 files changed, 23 insertions(+), 9 deletions(-) diff --git a/atom/browser/lib/guest-window-manager.coffee b/atom/browser/lib/guest-window-manager.coffee index f92c1a46c051..861b0d10aa31 100644 --- a/atom/browser/lib/guest-window-manager.coffee +++ b/atom/browser/lib/guest-window-manager.coffee @@ -57,13 +57,19 @@ ipc.on 'ATOM_SHELL_GUEST_WINDOW_MANAGER_WINDOW_POSTMESSAGE', (event, guestId, me if guestContents?.getUrl().indexOf(targetOrigin) is 0 or targetOrigin is '*' guestContents.send 'ATOM_SHELL_GUEST_WINDOW_POSTMESSAGE', message, targetOrigin -ipc.on 'ATOM_SHELL_GUEST_WINDOW_MANAGER_WINDOW_OPENER_POSTMESSAGE', (event, message, targetOrigin) -> +ipc.on 'ATOM_SHELL_GUEST_WINDOW_MANAGER_WINDOW_OPENER_POSTMESSAGE', (event, guestId, message, targetOrigin, sourceOrigin) -> embedder = v8Util.getHiddenValue event.sender, 'embedder' if embedder?.getUrl().indexOf(targetOrigin) is 0 or targetOrigin is '*' - embedder.send 'ATOM_SHELL_GUEST_WINDOW_POSTMESSAGE', message, targetOrigin + embedder.send 'ATOM_SHELL_GUEST_WINDOW_POSTMESSAGE', guestId, message, sourceOrigin ipc.on 'ATOM_SHELL_GUEST_WINDOW_MANAGER_WEB_CONTENTS_METHOD', (event, guestId, method, args...) -> BrowserWindow.fromId(guestId)?.webContents?[method] args... -ipc.on 'ATOM_SHELL_GUEST_WINDOW_MANAGER_IS_GUEST_WINDOW', (event) -> - event.returnValue = v8Util.getHiddenValue(event.sender, 'embedder') isnt undefined +ipc.on 'ATOM_SHELL_GUEST_WINDOW_MANAGER_GET_GUEST_ID', (event) -> + embedder = v8Util.getHiddenValue event.sender, 'embedder' + if embedder? + guest = BrowserWindow.fromWebContents event.sender + if guest? + event.returnValue = guest.id + return + event.returnValue = null diff --git a/atom/renderer/lib/override.coffee b/atom/renderer/lib/override.coffee index a413178442f2..b60374e04754 100644 --- a/atom/renderer/lib/override.coffee +++ b/atom/renderer/lib/override.coffee @@ -94,14 +94,22 @@ window.confirm = (message, title='') -> window.prompt = -> throw new Error('prompt() is and will not be supported.') -# Simple implementation of postMessage. -if ipc.sendSync 'ATOM_SHELL_GUEST_WINDOW_MANAGER_IS_GUEST_WINDOW' +# Implement window.postMessage if current window is a guest window. +guestId = ipc.sendSync 'ATOM_SHELL_GUEST_WINDOW_MANAGER_GET_GUEST_ID' +if guestId? window.opener = postMessage: (message, targetOrigin='*') -> - ipc.send 'ATOM_SHELL_GUEST_WINDOW_MANAGER_WINDOW_OPENER_POSTMESSAGE', message, targetOrigin + ipc.send 'ATOM_SHELL_GUEST_WINDOW_MANAGER_WINDOW_OPENER_POSTMESSAGE', guestId, message, targetOrigin, location.origin -ipc.on 'ATOM_SHELL_GUEST_WINDOW_POSTMESSAGE', (message, targetOrigin) -> - window.postMessage message, targetOrigin +ipc.on 'ATOM_SHELL_GUEST_WINDOW_POSTMESSAGE', (guestId, message, sourceOrigin) -> + # Manually dispatch event instead of using postMessage because we also need to + # set event.source. + event = document.createEvent 'Event' + event.initEvent 'message', false, false + event.data = message + event.origin = sourceOrigin + event.source = new BrowserWindowProxy(guestId) + window.dispatchEvent event # Forward history operations to browser. sendHistoryOperation = (args...) -> From dddb5988182a6c9c065b8895b078c209d46f0eef Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 1 Sep 2015 11:51:28 +0800 Subject: [PATCH 1064/1293] spec: Node integration should work after POST --- spec/fixtures/pages/post.html | 10 ++++++++++ spec/webview-spec.coffee | 8 ++++++++ 2 files changed, 18 insertions(+) create mode 100644 spec/fixtures/pages/post.html diff --git a/spec/fixtures/pages/post.html b/spec/fixtures/pages/post.html new file mode 100644 index 000000000000..06f6f365492d --- /dev/null +++ b/spec/fixtures/pages/post.html @@ -0,0 +1,10 @@ + + +
+

+
+ + + diff --git a/spec/webview-spec.coffee b/spec/webview-spec.coffee index 7c2cd1a92adc..6eb391ac9483 100644 --- a/spec/webview-spec.coffee +++ b/spec/webview-spec.coffee @@ -48,6 +48,14 @@ describe ' tag', -> webview.src = "file://#{fixtures}/pages/d.html" document.body.appendChild webview + it 'loads node symbols after POST navigation when set', (done) -> + webview.addEventListener 'console-message', (e) -> + assert.equal e.message, 'function object object' + done() + webview.setAttribute 'nodeintegration', 'on' + webview.src = "file://#{fixtures}/pages/post.html" + document.body.appendChild webview + # If the test is executed with the debug build on Windows, we will skip it # because native modules don't work with the debug build (see issue #2558). if process.platform isnt 'win32' or From 316210d6c47b7e2358a30394e3eb657761faba82 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Mon, 31 Aug 2015 21:10:48 -0700 Subject: [PATCH 1065/1293] Add `$` notation --- .../development/build-instructions-windows.md | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/development/build-instructions-windows.md b/docs/development/build-instructions-windows.md index 82138008197d..733966f1da69 100644 --- a/docs/development/build-instructions-windows.md +++ b/docs/development/build-instructions-windows.md @@ -27,7 +27,7 @@ building with Visual Studio will come in the future. ## Getting the Code ```powershell -git clone https://github.com/atom/electron.git +$ git clone https://github.com/atom/electron.git ``` ## Bootstrapping @@ -37,8 +37,8 @@ the build project files. Notice that we're using `ninja` to build Electron so there is no Visual Studio project generated. ```powershell -cd electron -python script\bootstrap.py -v +$ cd electron +$ python script\bootstrap.py -v ``` ## Building @@ -46,13 +46,13 @@ python script\bootstrap.py -v Build both Release and Debug targets: ```powershell -python script\build.py +$ python script\build.py ``` You can also only build the Debug target: ```powershell -python script\build.py -c D +$ python script\build.py -c D ``` After building is done, you can find `electron.exe` under `out\D` (debug @@ -64,7 +64,7 @@ To build for the 64bit target, you need to pass `--target_arch=x64` when running the bootstrap script: ```powershell -python script\bootstrap.py -v --target_arch=x64 +$ python script\bootstrap.py -v --target_arch=x64 ``` The other building steps are exactly the same. @@ -74,13 +74,13 @@ The other building steps are exactly the same. Test your changes conform to the project coding style using: ```powershell -python script\cpplint.py +$ python script\cpplint.py ``` Test functionality using: ```powershell -python script\test.py +$ python script\test.py ``` Tests that include native modules (e.g. `runas`) can't be executed with the @@ -90,7 +90,7 @@ details), but they will work with the release build. To run the tests with the release build use: ```powershell -python script\test.py -R +$ python script\test.py -R ``` ## Troubleshooting @@ -128,8 +128,8 @@ This is caused by a bug when using Cygwin Python and Win32 Node together. The solution is to use the Win32 Python to execute the bootstrap script (assuming you have installed Python under `C:\Python27`): -```bash -/cygdrive/c/Python27/python.exe script/bootstrap.py +```powershell +$ /cygdrive/c/Python27/python.exe script/bootstrap.py ``` ### LNK1181: cannot open input file 'kernel32.lib' @@ -141,7 +141,7 @@ Try reinstalling 32bit Node.js. Simply making that directory [should fix the problem](http://stackoverflow.com/a/25095327/102704): ```powershell -mkdir ~\AppData\Roaming\npm +$ mkdir ~\AppData\Roaming\npm ``` ### node-gyp is not recognized as an internal or external command From 691d8dd9abb4249868a583ce4390d4bc8e236bd9 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Mon, 31 Aug 2015 21:13:05 -0700 Subject: [PATCH 1066/1293] Replace "Mac" with "OS X" --- docs-translations/es/README-es.md | 2 +- docs-translations/ko/README.md | 2 +- docs/README.md | 2 +- .../{build-instructions-mac.md => build-instructions-osx.md} | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) rename docs/development/{build-instructions-mac.md => build-instructions-osx.md} (92%) diff --git a/docs-translations/es/README-es.md b/docs-translations/es/README-es.md index a278de95bd43..617e66ec6f5b 100644 --- a/docs-translations/es/README-es.md +++ b/docs-translations/es/README-es.md @@ -62,7 +62,7 @@ Módulos de ambos procesos: * [Estructura de directorio](development/source-code-directory-structure.md) * [Diferencias técnicas con NW.js (anteriormente conocido como node-webkit)](development/atom-shell-vs-node-webkit.md) * [Sistema de compilación](development/build-system-overview.md) -* [Instrucciones de compilación (Mac)](development/build-instructions-mac.md) +* [Instrucciones de compilación (Mac)](development/build-instructions-osx.md) * [Instrucciones de compilación (Windows)](development/build-instructions-windows.md) * [Instrucciones de compilación (Linux)](development/build-instructions-linux.md) * [Configurando un servidor de símbolos en el depurador](development/setting-up-symbol-server.md) diff --git a/docs-translations/ko/README.md b/docs-translations/ko/README.md index 51bf0a36d07f..6441d282d8b6 100644 --- a/docs-translations/ko/README.md +++ b/docs-translations/ko/README.md @@ -62,7 +62,7 @@ * [소스 코드 디렉터리 구조](development/source-code-directory-structure.md) * [NW.js와 기술적으로 다른점 (이전 node-webkit)](development/atom-shell-vs-node-webkit.md) * [빌드 시스템 개요](development/build-system-overview.md) -* [빌드 설명서 (Mac)](development/build-instructions-mac.md) +* [빌드 설명서 (Mac)](development/build-instructions-osx.md) * [빌드 설명서 (Windows)](development/build-instructions-windows.md) * [빌드 설명서 (Linux)](development/build-instructions-linux.md) * [디버거에서 디버그 심볼 서버 설정](development/setting-up-symbol-server.md) diff --git a/docs/README.md b/docs/README.md index 754cef9babba..5d6d825d1bcb 100644 --- a/docs/README.md +++ b/docs/README.md @@ -64,7 +64,7 @@ Modules for both processes: * [Source code directory structure](development/source-code-directory-structure.md) * [Technical differences to NW.js (formerly node-webkit)](development/atom-shell-vs-node-webkit.md) * [Build system overview](development/build-system-overview.md) -* [Build instructions (Mac)](development/build-instructions-mac.md) +* [Build instructions (Mac)](development/build-instructions-osx.md) * [Build instructions (Windows)](development/build-instructions-windows.md) * [Build instructions (Linux)](development/build-instructions-linux.md) * [Setting up symbol server in debugger](development/setting-up-symbol-server.md) diff --git a/docs/development/build-instructions-mac.md b/docs/development/build-instructions-osx.md similarity index 92% rename from docs/development/build-instructions-mac.md rename to docs/development/build-instructions-osx.md index a8e59714255e..ac51bf0dc224 100644 --- a/docs/development/build-instructions-mac.md +++ b/docs/development/build-instructions-osx.md @@ -1,6 +1,6 @@ -# Build Instructions (Mac) +# Build Instructions (OS X) -Follow the guidelines below for building Electron on Mac. +Follow the guidelines below for building Electron on OS X. ## Prerequisites From c70513f7ce2f3773d869ea53bd3c547ce8c34067 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 1 Sep 2015 12:15:00 +0800 Subject: [PATCH 1067/1293] spec: window.opener.postMessage should set source and origin --- spec/chromium-spec.coffee | 9 +++++++++ spec/fixtures/pages/window-opener-postMessage.html | 7 +++++++ 2 files changed, 16 insertions(+) create mode 100644 spec/fixtures/pages/window-opener-postMessage.html diff --git a/spec/chromium-spec.coffee b/spec/chromium-spec.coffee index f98c8a75c742..c594a97f3b83 100644 --- a/spec/chromium-spec.coffee +++ b/spec/chromium-spec.coffee @@ -63,6 +63,15 @@ describe 'chromium feature', -> b.close() done(if opener isnt null then undefined else opener) + describe 'window.opener.postMessage', -> + it 'sets source and origin correctly', (done) -> + b = window.open "file://#{fixtures}/pages/window-opener-postMessage.html", 'test', 'show=no' + window.addEventListener 'message', (event) -> + b.close() + assert.equal event.source.guestId, b.guestId + assert.equal event.origin, 'file://' + done() + describe 'creating a Uint8Array under browser side', -> it 'does not crash', -> RUint8Array = remote.getGlobal 'Uint8Array' diff --git a/spec/fixtures/pages/window-opener-postMessage.html b/spec/fixtures/pages/window-opener-postMessage.html new file mode 100644 index 000000000000..5d0f8ede6d37 --- /dev/null +++ b/spec/fixtures/pages/window-opener-postMessage.html @@ -0,0 +1,7 @@ + + + + + From 889c98291825be8a218d07a5cd8567ed660112ff Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Mon, 31 Aug 2015 21:49:05 -0700 Subject: [PATCH 1068/1293] Source code structure as tree command --- .../source-code-directory-structure.md | 69 ++++++++++--------- 1 file changed, 36 insertions(+), 33 deletions(-) diff --git a/docs/development/source-code-directory-structure.md b/docs/development/source-code-directory-structure.md index 4b2c29d3e497..cbca7108526f 100644 --- a/docs/development/source-code-directory-structure.md +++ b/docs/development/source-code-directory-structure.md @@ -9,39 +9,42 @@ to understand the source code better. ## Structure of Source Code -* **atom** - Source code of Electron. - * **app** - System entry code. - * **browser** - The frontend including the main window, UI, and all of the - main process things. This talks to the renderer to manage web pages. - * **lib** - Javascript part of the main process initialization code. - * **ui** - Implementation of UI stuff for different platforms. - * **cocoa** - Cocoa specific source code. - * **gtk** - GTK+ specific source code. - * **win** - Windows GUI specific source code. - * **default_app** - The default page to show when Electron is started - without providing an app. - * **api** - The implementation of the main process APIs. - * **lib** - Javascript part of the API implementation. - * **net** - Network related code. - * **mac** - Mac specific Objective-C source code. - * **resources** - Icons, platform-dependent files, etc. - * **renderer** - Code that runs in renderer process. - * **lib** - Javascript part of renderer initialization code. - * **api** - The implementation of renderer process APIs. - * **lib** - Javascript part of the API implementation. - * **common** - Code that used by both the main and renderer processes, - including some utility functions and code to integrate node's message - loop into Chromium's message loop. - * **lib** - Common Javascript initialization code. - * **api** - The implementation of common APIs, and foundations of - Electron's built-in modules. - * **lib** - Javascript part of the API implementation. -* **chromium_src** - Source code that copied from Chromium. -* **docs** - Documentations. -* **spec** - Automatic tests. -* **atom.gyp** - Building rules of Electron. -* **common.gypi** - Compiler specific settings and building rules for other - components like `node` and `breakpad`. +``` +Electron +├──atom - Source code of Electron. +| ├── app - System entry code. +| ├── browser - The frontend including the main window, UI, and all of the +| | main process things. This talks to the renderer to manage web pages. +| |   ├── lib - Javascript part of the main process initialization code. +| | ├── ui - Implementation of UI stuff for different platforms. +| | | ├── cocoa - Cocoa specific source code. +| | | ├── gtk - GTK+ specific source code. +| | | └── win - Windows GUI specific source code. +| | ├── default_app - The default page to show when Electron is started +| | | without providing an app. +| | ├── api - The implementation of the main process APIs. +| | | └── lib - Javascript part of the API implementation. +| | ├── net - Network related code. +| | ├── mac - Mac specific Objective-C source code. +| | └── resources - Icons, platform-dependent files, etc. +| ├── renderer - Code that runs in renderer process. +| | ├── lib - Javascript part of renderer initialization code. +| | └── api - The implementation of renderer process APIs. +| | └── lib - Javascript part of the API implementation. +| └── common - Code that used by both the main and renderer processes, +| including some utility functions and code to integrate node's message +| loop into Chromium's message loop. +| ├── lib - Common Javascript initialization code. +| └── api - The implementation of common APIs, and foundations of +| Electron's built-in modules. +| └── lib - Javascript part of the API implementation. +├── chromium_src - Source code that copied from Chromium. +├── docs - Documentations. +├── spec - Automatic tests. +├── atom.gyp - Building rules of Electron. +└── common.gypi - Compiler specific settings and building rules for other + components like `node` and `breakpad`. +``` ## Structure of Other Directories From 10b53f7f731e984a505dee7fdc1d9cc2a65b060f Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Tue, 1 Sep 2015 17:48:43 +0800 Subject: [PATCH 1069/1293] Fix print spooler hangs when printing more than 3 pages on Windows. --- .../chrome/browser/printing/print_job.cc | 120 +++++++++--------- 1 file changed, 62 insertions(+), 58 deletions(-) diff --git a/chromium_src/chrome/browser/printing/print_job.cc b/chromium_src/chrome/browser/printing/print_job.cc index 6bcc58322124..65449ef121e3 100644 --- a/chromium_src/chrome/browser/printing/print_job.cc +++ b/chromium_src/chrome/browser/printing/print_job.cc @@ -220,64 +220,6 @@ PrintedDocument* PrintJob::document() const { return document_.get(); } -void PrintJob::UpdatePrintedDocument(PrintedDocument* new_document) { - if (document_.get() == new_document) - return; - - document_ = new_document; - - if (document_.get()) { - settings_ = document_->settings(); - } - - if (worker_) { - DCHECK(!is_job_pending_); - // Sync the document with the worker. - worker_->PostTask(FROM_HERE, - base::Bind(&HoldRefCallback, - make_scoped_refptr(this), - base::Bind(&PrintJobWorker::OnDocumentChanged, - base::Unretained(worker_.get()), - document_))); - } -} - -void PrintJob::OnNotifyPrintJobEvent(const JobEventDetails& event_details) { - switch (event_details.type()) { - case JobEventDetails::FAILED: { - settings_.Clear(); - // No need to cancel since the worker already canceled itself. - Stop(); - break; - } - case JobEventDetails::USER_INIT_DONE: - case JobEventDetails::DEFAULT_INIT_DONE: - case JobEventDetails::USER_INIT_CANCELED: { - DCHECK_EQ(event_details.document(), document_.get()); - break; - } - case JobEventDetails::NEW_DOC: - case JobEventDetails::NEW_PAGE: - case JobEventDetails::JOB_DONE: - case JobEventDetails::ALL_PAGES_REQUESTED: { - // Don't care. - break; - } - case JobEventDetails::DOC_DONE: { - // This will call Stop() and broadcast a JOB_DONE message. - base::MessageLoop::current()->PostTask( - FROM_HERE, base::Bind(&PrintJob::OnDocumentDone, this)); - break; - } - case JobEventDetails::PAGE_DONE: - break; - default: { - NOTREACHED(); - break; - } - } -} - #if defined(OS_WIN) class PrintJob::PdfToEmfState { @@ -375,6 +317,68 @@ void PrintJob::OnPdfToEmfPageConverted(int page_number, #endif // OS_WIN +void PrintJob::UpdatePrintedDocument(PrintedDocument* new_document) { + if (document_.get() == new_document) + return; + + document_ = new_document; + + if (document_.get()) { + settings_ = document_->settings(); + } + + if (worker_) { + DCHECK(!is_job_pending_); + // Sync the document with the worker. + worker_->PostTask(FROM_HERE, + base::Bind(&HoldRefCallback, + make_scoped_refptr(this), + base::Bind(&PrintJobWorker::OnDocumentChanged, + base::Unretained(worker_.get()), + document_))); + } +} + +void PrintJob::OnNotifyPrintJobEvent(const JobEventDetails& event_details) { + switch (event_details.type()) { + case JobEventDetails::FAILED: { + settings_.Clear(); + // No need to cancel since the worker already canceled itself. + Stop(); + break; + } + case JobEventDetails::USER_INIT_DONE: + case JobEventDetails::DEFAULT_INIT_DONE: + case JobEventDetails::USER_INIT_CANCELED: { + DCHECK_EQ(event_details.document(), document_.get()); + break; + } + case JobEventDetails::NEW_DOC: + case JobEventDetails::NEW_PAGE: + case JobEventDetails::JOB_DONE: + case JobEventDetails::ALL_PAGES_REQUESTED: { + // Don't care. + break; + } + case JobEventDetails::DOC_DONE: { + // This will call Stop() and broadcast a JOB_DONE message. + base::MessageLoop::current()->PostTask( + FROM_HERE, base::Bind(&PrintJob::OnDocumentDone, this)); + break; + } + case JobEventDetails::PAGE_DONE: +#if defined(OS_WIN) + ptd_to_emf_state_->OnPageProcessed( + base::Bind(&PrintJob::OnPdfToEmfPageConverted, this)); +#endif // OS_WIN + break; + default: { + NOTREACHED(); + break; + } + } +} + void PrintJob::OnDocumentDone() { // Be sure to live long enough. The instance could be destroyed by the // JOB_DONE broadcast. From 4062ca5f683bb9a12d9d2ec6209cdff259c059a5 Mon Sep 17 00:00:00 2001 From: Robo Date: Tue, 1 Sep 2015 15:32:14 +0530 Subject: [PATCH 1070/1293] implement wrapSession --- atom/browser/api/atom_api_session.cc | 42 +++++++++++++++++++++++----- atom/browser/api/lib/app.coffee | 15 +++++++--- atom/common/node_bindings.cc | 1 + docs/api/app.md | 32 --------------------- docs/api/session.md | 24 ++++++++++++++++ 5 files changed, 71 insertions(+), 43 deletions(-) diff --git a/atom/browser/api/atom_api_session.cc b/atom/browser/api/atom_api_session.cc index 0b7640e416b5..3ca15ab871fa 100644 --- a/atom/browser/api/atom_api_session.cc +++ b/atom/browser/api/atom_api_session.cc @@ -106,12 +106,12 @@ template<> struct Converter { static v8::Local ToV8(v8::Isolate* isolate, content::DownloadItem* val) { - return mate::ObjectTemplateBuilder(isolate) - .SetValue("url", val->GetURL()) - .SetValue("filename", val->GetSuggestedFilename()) - .SetValue("mimeType", val->GetMimeType()) - .SetValue("hasUserGesture", val->HasUserGesture()) - .Build()->NewInstance(); + mate::Dictionary dict(isolate, v8::Object::New(isolate)); + dict.Set("url", val->GetURL()); + dict.Set("filename", val->GetSuggestedFilename()); + dict.Set("mimeType", val->GetMimeType()); + dict.Set("hasUserGesture", val->HasUserGesture()); + return dict.GetHandle(); } }; @@ -123,6 +123,10 @@ namespace api { namespace { +// The wrapSession funtion which is implemented in JavaScript +using WrapSessionCallback = base::Callback)>; +WrapSessionCallback g_wrap_session; + class ResolveProxyHelper { public: ResolveProxyHelper(AtomBrowserContext* browser_context, @@ -321,9 +325,33 @@ mate::Handle Session::CreateFrom( if (existing) return mate::CreateHandle(isolate, static_cast(existing)); - return mate::CreateHandle(isolate, new Session(browser_context)); + auto handle = mate::CreateHandle(isolate, new Session(browser_context)); + g_wrap_session.Run(handle.ToV8()); + return handle; +} + +void SetWrapSession(const WrapSessionCallback& callback) { + g_wrap_session = callback; +} + +void ClearWrapSession() { + g_wrap_session.Reset(); } } // namespace api } // namespace atom + +namespace { + +void Initialize(v8::Local exports, v8::Local unused, + v8::Local context, void* priv) { + v8::Isolate* isolate = context->GetIsolate(); + mate::Dictionary dict(isolate, exports); + dict.SetMethod("_setWrapSession", &atom::api::SetWrapSession); + dict.SetMethod("_clearWrapSession", &atom::api::ClearWrapSession); +} + +} // namespace + +NODE_MODULE_CONTEXT_AWARE_BUILTIN(atom_browser_session, Initialize) diff --git a/atom/browser/api/lib/app.coffee b/atom/browser/api/lib/app.coffee index f71297c596f0..b3446e86e23a 100644 --- a/atom/browser/api/lib/app.coffee +++ b/atom/browser/api/lib/app.coffee @@ -1,10 +1,15 @@ EventEmitter = require('events').EventEmitter bindings = process.atomBinding 'app' +sessionBindings = process.atomBinding 'session' app = bindings.app app.__proto__ = EventEmitter.prototype +wrapSession = (session) -> + # session is an Event Emitter. + session.__proto__ = EventEmitter.prototype + app.setApplicationMenu = (menu) -> require('menu').setApplicationMenu menu @@ -32,10 +37,8 @@ app.setAppPath = (path) -> app.getAppPath = -> appPath -app.once 'ready', -> - app.defaultSession.__proto__ = EventEmitter.prototype - # Be compatible with old API. - @emit 'finish-launching' +# Be compatible with old API. +app.once 'ready', -> @emit 'finish-launching' app.terminate = app.quit app.exit = process.exit app.getHomeDir = -> @getPath 'home' @@ -43,5 +46,9 @@ app.getDataPath = -> @getPath 'userData' app.setDataPath = (path) -> @setPath 'userData', path app.resolveProxy = -> @defaultSession.resolveProxy.apply @defaultSession, arguments +# Session wrapper. +sessionBindings._setWrapSession wrapSession +process.once 'exit', sessionBindings._clearWrapSession + # Only one App object pemitted. module.exports = app diff --git a/atom/common/node_bindings.cc b/atom/common/node_bindings.cc index 5aed5619f9cf..09666a470b6c 100644 --- a/atom/common/node_bindings.cc +++ b/atom/common/node_bindings.cc @@ -40,6 +40,7 @@ REFERENCE_MODULE(atom_browser_power_monitor); REFERENCE_MODULE(atom_browser_power_save_blocker); REFERENCE_MODULE(atom_browser_protocol); REFERENCE_MODULE(atom_browser_global_shortcut); +REFERENCE_MODULE(atom_browser_session); REFERENCE_MODULE(atom_browser_tray); REFERENCE_MODULE(atom_browser_web_contents); REFERENCE_MODULE(atom_browser_web_view_manager); diff --git a/docs/api/app.md b/docs/api/app.md index 8951adf45cfd..db34d37ec59e 100644 --- a/docs/api/app.md +++ b/docs/api/app.md @@ -330,35 +330,3 @@ Sets the application's [dock menu][dock-menu]. [dock-menu]:https://developer.apple.com/library/mac/documentation/Carbon/Conceptual/customizing_docktile/concepts/dockconcepts.html#//apple_ref/doc/uid/TP30000986-CH2-TPXREF103 [tasks]:http://msdn.microsoft.com/en-us/library/windows/desktop/dd378460(v=vs.85).aspx#tasks - -## `app.defaultSession` - -The default session of the app available once the (ready)[app.md#event-ready] event is fired. - -```javascript -app.on('ready', function() { - var defaultSession = app.defaultSession; -}) -``` - -### Event: 'will-download' - -* `event` Event -* `downloadItem` Object - * `url` String - * `filename` String - * `mimeType` String - * `hasUserGesture` Boolean -* `webContents` (WebContents)[web-contents.md] - -Fired when a download is about to start. Calling `preventDefault()` -will cancel the download. - -```javascript -app.defaultSession.on('will-download', function(e, downloadItem, webContents) { - e.preventDefault(); - require('request')(downloadItem.url, function(data) { - require('fs').writeFileSync('/somewhere', data); - }); -}); -``` diff --git a/docs/api/session.md b/docs/api/session.md index 7b0c1b44c7dc..28a0c92ca655 100644 --- a/docs/api/session.md +++ b/docs/api/session.md @@ -13,6 +13,30 @@ win.loadUrl("http://github.com"); var session = win.webContents.session ``` +## Events + +### Event: 'will-download' + +* `event` Event +* `downloadItem` Object + * `url` String + * `filename` String + * `mimeType` String + * `hasUserGesture` Boolean +* `webContents` (WebContents)[web-contents.md] + +Fired when a download is about to start. Calling `preventDefault()` +will cancel the download. + +```javascript +session.on('will-download', function(e, downloadItem, webContents) { + e.preventDefault(); + require('request')(downloadItem.url, function(data) { + require('fs').writeFileSync('/somewhere', data); + }); +}); +``` + ## Methods The `session` object has the following methods: From 0cb20c48f6fa91131201f327da6d992599802c59 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 1 Sep 2015 20:16:28 +0800 Subject: [PATCH 1071/1293] docs: Small changes to will-download event --- docs/api/session.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/api/session.md b/docs/api/session.md index 28a0c92ca655..439cf8514e93 100644 --- a/docs/api/session.md +++ b/docs/api/session.md @@ -18,20 +18,21 @@ var session = win.webContents.session ### Event: 'will-download' * `event` Event -* `downloadItem` Object +* `item` Object * `url` String * `filename` String * `mimeType` String * `hasUserGesture` Boolean -* `webContents` (WebContents)[web-contents.md] +* `webContents` [WebContents](web-contents.md) -Fired when a download is about to start. Calling `preventDefault()` -will cancel the download. +Fired when Electron is about to download `item` in `webContents`. + +Calling `event.preventDefault()` will cancel the download. ```javascript -session.on('will-download', function(e, downloadItem, webContents) { - e.preventDefault(); - require('request')(downloadItem.url, function(data) { +session.on('will-download', function(event, item, webContents) { + event.preventDefault(); + require('request')(item.url, function(data) { require('fs').writeFileSync('/somewhere', data); }); }); From 17cc43152da044489ef31777b8864dec682cfa84 Mon Sep 17 00:00:00 2001 From: Vishesh Handa Date: Tue, 1 Sep 2015 16:01:44 +0200 Subject: [PATCH 1072/1293] Linux Build Instructions: Add list of packages for fedora --- docs/development/build-instructions-linux.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/development/build-instructions-linux.md b/docs/development/build-instructions-linux.md index 0e15252ca41f..444b7b566cf7 100644 --- a/docs/development/build-instructions-linux.md +++ b/docs/development/build-instructions-linux.md @@ -20,8 +20,16 @@ $ sudo apt-get install build-essential clang libdbus-1-dev libgtk2.0-dev \ libxss1 libnss3-dev gcc-multilib g++-multilib ``` +On Fedora, install the following libraries: + +```bash +$ sudo yum install clang dbus-devel gtk2-devel libnotify-devel libgnome-keyring-devel \ + xorg-x11-server-utils libcap-devel cups-devel libXtst-devel \ + alsa-lib-devel libXrandr-devel GConf2-devel nss-devel +``` + Other distributions may offer similar packages for installation via package -managers such as yum. Or one can compile from source code. +managers such as pacman. Or one can compile from source code. ## If You Use Virtual Machines For Building From 95133af0eebada235f7c330dd901b864f19848a0 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Tue, 1 Sep 2015 14:08:42 -0700 Subject: [PATCH 1073/1293] `y` required if `x` exists --- docs/api/menu.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/menu.md b/docs/api/menu.md index eaa486390fd9..1d6e4135157d 100644 --- a/docs/api/menu.md +++ b/docs/api/menu.md @@ -211,7 +211,7 @@ will become properties of the constructed menu items. * `browserWindow` BrowserWindow * `x` Number (optional) -* `y` Number (optional) +* `y` Number (**required** if `x` is used) Pops up this menu as a context menu in the `browserWindow`. You can optionally provide a `x,y` coordinate to place the menu at, otherwise it From 2c4753270204fc984228266dc9ba7114c7f12eb6 Mon Sep 17 00:00:00 2001 From: Carson McDonald Date: Tue, 1 Sep 2015 17:15:21 -0400 Subject: [PATCH 1074/1293] Fix link to app.addRecentDocument --- docs/tutorial/desktop-environment-integration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorial/desktop-environment-integration.md b/docs/tutorial/desktop-environment-integration.md index 80b4c456938b..8fd830f2be88 100644 --- a/docs/tutorial/desktop-environment-integration.md +++ b/docs/tutorial/desktop-environment-integration.md @@ -29,7 +29,7 @@ var app = require('app'); app.addRecentDocument('/Users/USERNAME/Desktop/work.type'); ``` -And you can use [app.clearRecentDocuments](clearrecentdocuments) API to empty +And you can use [app.clearRecentDocuments][clearrecentdocuments] API to empty the recent documents list: ```javascript From 2ead38b03ff6127306d30b7709fc07caecc364a3 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Tue, 1 Sep 2015 15:30:08 -0700 Subject: [PATCH 1075/1293] Text edits on remote --- docs/api/remote.md | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/docs/api/remote.md b/docs/api/remote.md index 5658b0781656..9490c1977932 100644 --- a/docs/api/remote.md +++ b/docs/api/remote.md @@ -6,7 +6,7 @@ between the renderer process (web page) and the main process. In Electron, only GUI-unrelated modules are available in the renderer process. Without the `remote` module, users who want to call a main process API in the renderer process would have to explicitly send inter-process messages -to the main process. With the `remote` module, users can invoke methods of the +to the main process. With the `remote` module, you can invoke methods of the main process object without explicitly sending inter-process messages, similar to Java's [RMI](http://en.wikipedia.org/wiki/Java_remote_method_invocation). @@ -32,15 +32,16 @@ a new object with the remote constructor (function), you are actually sending synchronous inter-process messages. In the example above, both `BrowserWindow` and `win` were remote objects and -`new BrowserWindow` didn't create a `BrowserWindow` object in the renderer process. -Instead, it created a `BrowserWindow` object in the main process and returned the -corresponding remote object in the renderer process, namely the `win` object. +`new BrowserWindow` didn't create a `BrowserWindow` object in the renderer +process. Instead, it created a `BrowserWindow` object in the main process and +returned the corresponding remote object in the renderer process, namely the +`win` object. ## Lifetime of Remote Objects Electron makes sure that as long as the remote object in the renderer process lives (in other words, has not been garbage collected), the corresponding object -in the main process will never be released. When the remote object has been +in the main process will not be released. When the remote object has been garbage collected, the corresponding object in the main process will be dereferenced. @@ -53,7 +54,8 @@ Primary value types like strings and numbers, however, are sent by copy. ## Passing callbacks to the main process Code in the main process can accept callbacks from the renderer - for instance -the `remote` module - but you should be extremely careful when using this feature. +the `remote` module - but you should be extremely careful when using this +feature. First, in order to avoid deadlocks, the callbacks passed to the main process are called asynchronously. You should not expect the main process to @@ -110,9 +112,9 @@ But remember the callback is referenced by the main process until you explicitly uninstall it. If you do not, each time you reload your window the callback will be installed again, leaking one callback for each restart. -To make things worse, since the context of previously installed callbacks have -been released, when the `close` event was emitted exceptions will be raised in -the main process. +To make things worse, since the context of previously installed callbacks has +been released, exceptions will be raised in the main process when the `close` +event is emitted . To avoid this problem, ensure you clean up any references to renderer callbacks passed to the main process. This involves cleaning up event handlers, or From 91c75d73dd2fbcdac7547d1a8bfa817047c0122e Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Tue, 1 Sep 2015 15:42:10 -0700 Subject: [PATCH 1076/1293] Text edits --- docs/api/synopsis.md | 4 ++-- docs/api/tray.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/api/synopsis.md b/docs/api/synopsis.md index 4634151bfbec..21f4ff2aa4de 100644 --- a/docs/api/synopsis.md +++ b/docs/api/synopsis.md @@ -6,7 +6,7 @@ the [native modules](../tutorial/using-native-node-modules.md)). Electron also provides some extra built-in modules for developing native desktop applications. Some modules are only available on the main process, some -are only available on the renderer process (web page), and some can be used on +are only available in the renderer process (web page), and some can be used in both processes. The basic rule is: if a module is @@ -30,7 +30,7 @@ app.on('ready', function() { }); ``` -The render process is no different than a normal web page, except for the extra +The renderer process is no different than a normal web page, except for the extra ability to use node modules: ```html diff --git a/docs/api/tray.md b/docs/api/tray.md index c9ebf20543fe..a673307804a7 100644 --- a/docs/api/tray.md +++ b/docs/api/tray.md @@ -123,7 +123,7 @@ Emitted when dragged files are dropped in the tray icon. The `Tray` module has the following methods: -**Note**: Some methods are only available on specific operating systems and area +**Note**: Some methods are only available on specific operating systems and are labeled as such. ### `Tray.destroy()` From 47d103af72d414760c1f9c4269b03c889daee5c3 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Tue, 1 Sep 2015 16:21:29 -0700 Subject: [PATCH 1077/1293] Text edits --- docs/api/native-image.md | 12 ++++++------ docs/api/power-save-blocker.md | 8 ++++---- docs/api/process.md | 2 +- 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/api/native-image.md b/docs/api/native-image.md index 4b90fcfce612..c00ec3a9458a 100644 --- a/docs/api/native-image.md +++ b/docs/api/native-image.md @@ -19,20 +19,20 @@ var image = clipboard.readImage(); var appIcon = new Tray(image); ``` -## Supported formats +## Supported Formats -Currently `PNG` and `JPEG` are supported. It is recommended to use `PNG` because -of its support for transparency and lossless compression. +Currently `PNG` and `JPEG` image formats are supported. `PNG` is recommended +because of its support for transparency and lossless compression. -On Windows, you can also load `ICO` icon from a file path. +On Windows, you can also load an `ICO` icon from a file path. -## High resolution image +## High Resolution Image On platforms that have high-DPI support, you can append `@2x` after image's base filename to mark it as a high resolution image. For example if `icon.png` is a normal image that has standard resolution, then -`icon@2x.png` would be treated as a high resolution image that has double DPI +`icon@2x.png` will be treated as a high resolution image that has double DPI density. If you want to support displays with different DPI densities at the same time, diff --git a/docs/api/power-save-blocker.md b/docs/api/power-save-blocker.md index 451dde105da8..26f0abc84808 100644 --- a/docs/api/power-save-blocker.md +++ b/docs/api/power-save-blocker.md @@ -1,7 +1,7 @@ # powerSaveBlocker The `power-save-blocker` module is used to block the system from entering -low-power (sleep) mode thus allowing the app to keep the system and screen +low-power (sleep) mode and thus allowing the app to keep the system and screen active. For example: @@ -28,12 +28,12 @@ The `powerSaveBlocker` module has the following methods: * `prevent-display-sleep`- Prevent the display from going to sleep. Keeps system and screen active. Example use case: playing video. -Starts the power save blocker preventing the system from entering lower-power -mode. Returns an integer identifying the power save blocker. +Starts preventing the system from entering lower-power mode. Returns an integer +identifying the power save blocker. **Note:** `prevent-display-sleep` has higher has precedence over `prevent-app-suspension`. Only the highest precedence type takes effect. In -other words, `prevent-display-sleep` always take precedence over +other words, `prevent-display-sleep` always takes precedence over `prevent-app-suspension`. For example, an API calling A requests for `prevent-app-suspension`, and diff --git a/docs/api/process.md b/docs/api/process.md index 15a1cca19f08..120b2853bed5 100644 --- a/docs/api/process.md +++ b/docs/api/process.md @@ -1,4 +1,4 @@ -# Process +# process The `process` object in Electron has the following differences from the one in upstream node: From dbcd0a4235ddcbd9ed28082984ca04a8f94ca285 Mon Sep 17 00:00:00 2001 From: Heilig Benedek Date: Wed, 2 Sep 2015 02:33:40 +0200 Subject: [PATCH 1078/1293] Key event sending update. --- atom/browser/api/atom_api_window.cc | 8 +++-- atom/browser/native_window.cc | 12 +++++-- atom/browser/native_window.h | 2 +- atom/common/event_types.cc | 4 +-- atom/common/options_switches.cc | 5 +-- atom/common/options_switches.h | 3 +- docs/api/browser-window.md | 55 +++++++++++++++++++++++++++++ 7 files changed, 77 insertions(+), 12 deletions(-) diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index 7ee19783b0f2..3c523f8ccdb4 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -526,12 +526,14 @@ void Window::SendKeyboardEvent(v8::Isolate* isolate, const mate::Dictionary& dat auto type = blink::WebInputEvent::Type::Char; int modifiers = 0; int keycode = 0; + int native = 0; std::string type_str = ""; std::vector modifier_array; - data.Get(switches::kMouseEventType, &type_str); + data.Get(switches::kEventType, &type_str); data.Get(switches::kModifiers, &modifier_array); data.Get(switches::kKeyCode, &keycode); + data.Get(switches::kNativeKeyCode, &native); if(type_str.compare(event_types::kKeyDown) == 0){ type = blink::WebInputEvent::Type::KeyDown; @@ -565,7 +567,7 @@ void Window::SendKeyboardEvent(v8::Isolate* isolate, const mate::Dictionary& dat } } - window_->SendKeyboardEvent(type, modifiers, keycode); + window_->SendKeyboardEvent(type, modifiers, keycode, native); } void Window::SendMouseEvent(v8::Isolate* isolate, const mate::Dictionary& data){ @@ -578,7 +580,7 @@ void Window::SendMouseEvent(v8::Isolate* isolate, const mate::Dictionary& data){ blink::WebMouseEvent::Button button = blink::WebMouseEvent::Button::ButtonNone; int modifiers = 0; - data.Get(switches::kMouseEventType, &type_str); + data.Get(switches::kEventType, &type_str); data.Get(switches::kMouseEventButton, &button_str); data.Get(switches::kModifiers, &modifier_array); diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index f28a3a8bd41f..a9e0631489a8 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -47,6 +47,7 @@ #include "ui/gfx/geometry/size.h" #include "ui/gfx/screen.h" #include "ui/gl/gpu_switching_manager.h" +#include "ui/events/event.h" #if defined(OS_WIN) #include "ui/gfx/switches.h" @@ -572,10 +573,10 @@ void NativeWindow::DevToolsClosed() { FOR_EACH_OBSERVER(NativeWindowObserver, observers_, OnDevToolsClosed()); } -void NativeWindow::SendKeyboardEvent(blink::WebInputEvent::Type type, int modifiers, int keycode){ +void NativeWindow::SendKeyboardEvent(blink::WebInputEvent::Type type, int modifiers, int keycode, int nativeKeycode){ auto keyb_event = new content::NativeWebKeyboardEvent; - keyb_event->nativeKeyCode = keycode; + keyb_event->nativeKeyCode = nativeKeycode; keyb_event->windowsKeyCode = keycode; keyb_event->setKeyIdentifierFromWindowsKeyCode(); keyb_event->type = type; @@ -584,7 +585,7 @@ void NativeWindow::SendKeyboardEvent(blink::WebInputEvent::Type type, int modifi keyb_event->timeStampSeconds = base::Time::Now().ToDoubleT(); keyb_event->skip_in_browser = false; - if (type == blink::WebInputEvent::Char || type == blink::WebInputEvent::KeyDown) { + if (type == blink::WebInputEvent::Char || type == blink::WebInputEvent::RawKeyDown) { keyb_event->text[0] = keycode; keyb_event->unmodifiedText[0] = keycode; } @@ -592,6 +593,11 @@ void NativeWindow::SendKeyboardEvent(blink::WebInputEvent::Type type, int modifi const auto view = web_contents()->GetRenderWidgetHostView(); const auto host = view ? view->GetRenderWidgetHost() : nullptr; host->ForwardKeyboardEvent(*keyb_event); + + if(keyb_event->type == blink::WebInputEvent::Type::KeyDown){ + keyb_event->type = blink::WebInputEvent::RawKeyDown; + host->ForwardKeyboardEvent(*keyb_event); + } } void NativeWindow::SendMouseEvent(blink::WebInputEvent::Type type, int modifiers, blink::WebMouseEvent::Button button, int x, int y, int movementX, int movementY, int clickCount){ diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index 8cc1d2ff2b9a..d361fcf69632 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -238,7 +238,7 @@ class NativeWindow : public content::WebContentsObserver, void OnFrameReceived(bool result, scoped_refptr frame); - void SendKeyboardEvent(blink::WebInputEvent::Type type, int modifiers, int keycode); + void SendKeyboardEvent(blink::WebInputEvent::Type type, int modifiers, int keycode, int nativeKeycode); void SendMouseEvent(blink::WebInputEvent::Type type, int modifiers, blink::WebMouseEvent::Button button, int x, int y, int movementX, int movementY, int clickCount); void SendMouseWheelEvent(int modifiers, int x, int y, bool clickCount); diff --git a/atom/common/event_types.cc b/atom/common/event_types.cc index dd87783e68bd..3d3b901ed3cc 100644 --- a/atom/common/event_types.cc +++ b/atom/common/event_types.cc @@ -16,8 +16,8 @@ const char kMouseLeave[] = "leave"; const char kContextMenu[] = "context-menu"; const char kMouseWheel[] = "wheel"; -const char kKeyDown[] = "key-down"; -const char kKeyUp[] = "key-up"; +const char kKeyDown[] = "down"; +const char kKeyUp[] = "up"; const char kChar[] = "char"; const char kMouseLeftButton[] = "left"; diff --git a/atom/common/options_switches.cc b/atom/common/options_switches.cc index ee70080ae6ae..b47e801c41b7 100644 --- a/atom/common/options_switches.cc +++ b/atom/common/options_switches.cc @@ -113,12 +113,13 @@ const char kAppUserModelId[] = "app-user-model-id"; const char kOffScreenRender[] = "offscreen-render"; const char kModifiers[] = "modifiers"; -const char kKeyCode[] = "keycode"; +const char kKeyCode[] = "code"; +const char kNativeKeyCode[] = "native"; const char kMovementX[] = "movement-x"; const char kMovementY[] = "movement-y"; const char kClickCount[] = "click-count"; -const char kMouseEventType[] = "type"; +const char kEventType[] = "type"; const char kMouseEventButton[] = "button"; const char kMouseWheelPrecise[] = "precise"; diff --git a/atom/common/options_switches.h b/atom/common/options_switches.h index 505305deb49c..062ee6846626 100644 --- a/atom/common/options_switches.h +++ b/atom/common/options_switches.h @@ -64,11 +64,12 @@ extern const char kOffScreenRender[]; extern const char kModifiers[]; extern const char kKeyCode[]; +extern const char kNativeKeyCode[]; extern const char kMovementX[]; extern const char kMovementY[]; extern const char kClickCount[]; -extern const char kMouseEventType[]; +extern const char kEventType[]; extern const char kMouseEventButton[]; extern const char kMouseWheelPrecise[]; diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index f0b8abc2792f..217844897aff 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -737,6 +737,61 @@ Returns whether the window is visible on all workspaces. Sets the offscreen rendering, if `true` the `frame-rendered` event will fire, when the frame changes. +### BrowserWindow.sendMouseEvent(options) + +Sends a mouse event to the BrowserWindow. +* `options` Object + * `type` String - The type of the mouse event. + * `down` String - Mouse down event. + * `up` String - Mouse up event. + * `move` String - Mouse move event. + * `enter` String - Mouse enter event. + * `leave` String - Mouse leave event. + * `context-menu` String - Context menu event. + * `wheel` String - Mouse wheel event. + * `x` Integer - The x component of the location of the mouse event. + * `y` Integer - The y component of the location of the mouse event. + * `movement-x` Integer - The x component of the mouse movement since the last event. + * `movement-y` Integer - The y component of the mouse movement since the last event. + * `button` String - The mouse button associated with the mouse event. Also sets the associated modifier values on the event. + * `left` String - The left button was pressed. + * `right` String - The right button was pressed. + * `middle` String - The middle button was pressed. + * `click-count` Integer - The number of clicks associated with the mouse event. + * `precise` Boolean - For the `wheel` event type, this option sets the `hasPreciseScrollingDeltas` option of the event. + * `modifiers` Array of Strings - The modifier values associated with the event. + * `left-button-down` String - The left mouse button was pressed. + * `middle-button-down` String - The right mouse button was pressed. + * `right-button-down` String - The middle mouse button was pressed. + * `shift` String - The shift key was pressed. + * `control` String - The control key was pressed. + * `alt` String - The alt key was pressed. + * `meta` String - The meta key was pressed. + * `caps-lock` String - The caps-lock key was pressed. + * `num-lock` String - The num-lock key was pressed. + +### BrowserWindow.sendKeyboardEvent(options) + +Sends a keyboard event to the BrowserWindow. +* `options` Object + * `type` String - The type of the keyboard event. + * `down` String - Key down event. + * `up` String - Key up event. + * `char` String - Character event. + * `code` Integer - The key code of the key that generated the event. + * `native` Integer - The native key code of the key that generated the event. + * `modifiers` Array of Strings - The modifier values associated with the event. + * `keypad` String - Sets the `IsKeyPad` option of the event. + * `auto-repeat` String - Sets the `IsAutoRepeat` option of the event. + * `left` String - Sets the `IsLeft` option of the event. + * `right` String - Sets the `IsRight` option of the event. + * `shift` String - The shift key was pressed. + * `control` String - The control key was pressed. + * `alt` String - The alt key was pressed. + * `meta` String - The meta key was pressed. + * `caps-lock` String - The caps-lock key was pressed. + * `num-lock` String - The num-lock key was pressed. + ## Class: WebContents A `WebContents` is responsible for rendering and controlling a web page. From d830badc571502fe3ea713531f0f98d6042bc8ed Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 1 Sep 2015 19:48:11 +0800 Subject: [PATCH 1079/1293] Add role property for MenuItem --- atom/browser/api/atom_api_menu.cc | 5 ++ atom/browser/api/atom_api_menu.h | 1 + atom/browser/api/lib/menu-item.coffee | 3 +- atom/browser/api/lib/menu.coffee | 1 + atom/browser/default_app/main.js | 29 +++++----- atom/browser/ui/atom_menu_model.cc | 13 +++++ atom/browser/ui/atom_menu_model.h | 6 ++ atom/browser/ui/cocoa/atom_menu_controller.h | 13 ----- atom/browser/ui/cocoa/atom_menu_controller.mm | 56 +++++++++++++++---- 9 files changed, 89 insertions(+), 38 deletions(-) diff --git a/atom/browser/api/atom_api_menu.cc b/atom/browser/api/atom_api_menu.cc index 356a4d4ce494..9bd724a9612e 100644 --- a/atom/browser/api/atom_api_menu.cc +++ b/atom/browser/api/atom_api_menu.cc @@ -107,6 +107,10 @@ void Menu::SetSublabel(int index, const base::string16& sublabel) { model_->SetSublabel(index, sublabel); } +void Menu::SetRole(int index, const base::string16& role) { + model_->SetRole(index, role); +} + void Menu::Clear() { model_->Clear(); } @@ -154,6 +158,7 @@ void Menu::BuildPrototype(v8::Isolate* isolate, .SetMethod("insertSubMenu", &Menu::InsertSubMenuAt) .SetMethod("setIcon", &Menu::SetIcon) .SetMethod("setSublabel", &Menu::SetSublabel) + .SetMethod("setRole", &Menu::SetRole) .SetMethod("clear", &Menu::Clear) .SetMethod("getIndexOfCommandId", &Menu::GetIndexOfCommandId) .SetMethod("getItemCount", &Menu::GetItemCount) diff --git a/atom/browser/api/atom_api_menu.h b/atom/browser/api/atom_api_menu.h index 33aafbc45d3b..0d93c0d46be6 100644 --- a/atom/browser/api/atom_api_menu.h +++ b/atom/browser/api/atom_api_menu.h @@ -73,6 +73,7 @@ class Menu : public mate::Wrappable, Menu* menu); void SetIcon(int index, const gfx::Image& image); void SetSublabel(int index, const base::string16& sublabel); + void SetRole(int index, const base::string16& role); void Clear(); int GetIndexOfCommandId(int command_id); int GetItemCount() const; diff --git a/atom/browser/api/lib/menu-item.coffee b/atom/browser/api/lib/menu-item.coffee index d8e896f8ffa1..7663b32996d8 100644 --- a/atom/browser/api/lib/menu-item.coffee +++ b/atom/browser/api/lib/menu-item.coffee @@ -9,12 +9,13 @@ class MenuItem constructor: (options) -> Menu = require 'menu' - {click, @selector, @type, @label, @sublabel, @accelerator, @icon, @enabled, @visible, @checked, @submenu} = options + {click, @selector, @type, @role, @label, @sublabel, @accelerator, @icon, @enabled, @visible, @checked, @submenu} = options @type = 'submenu' if not @type? and @submenu? throw new Error('Invalid submenu') if @type is 'submenu' and @submenu?.constructor isnt Menu @overrideReadOnlyProperty 'type', 'normal' + @overrideReadOnlyProperty 'role' @overrideReadOnlyProperty 'accelerator' @overrideReadOnlyProperty 'icon' @overrideReadOnlyProperty 'submenu' diff --git a/atom/browser/api/lib/menu.coffee b/atom/browser/api/lib/menu.coffee index af70af740aaf..35335ffcebe5 100644 --- a/atom/browser/api/lib/menu.coffee +++ b/atom/browser/api/lib/menu.coffee @@ -115,6 +115,7 @@ Menu::insert = (pos, item) -> @setSublabel pos, item.sublabel if item.sublabel? @setIcon pos, item.icon if item.icon? + @setRole pos, item.role if item.role? # Make menu accessable to items. item.overrideReadOnlyProperty 'menu', this diff --git a/atom/browser/default_app/main.js b/atom/browser/default_app/main.js index fd3a6b596b6b..99c4ad03320b 100644 --- a/atom/browser/default_app/main.js +++ b/atom/browser/default_app/main.js @@ -44,13 +44,14 @@ app.once('ready', function() { submenu: [ { label: 'About Electron', - selector: 'orderFrontStandardAboutPanel:' + role: 'about' }, { type: 'separator' }, { label: 'Services', + role: 'services', submenu: [] }, { @@ -59,16 +60,16 @@ app.once('ready', function() { { label: 'Hide Electron', accelerator: 'Command+H', - selector: 'hide:' + role: 'hide' }, { label: 'Hide Others', accelerator: 'Command+Shift+H', - selector: 'hideOtherApplications:' + role: 'hideothers:' }, { label: 'Show All', - selector: 'unhideAllApplications:' + role: 'unhide:' }, { type: 'separator' @@ -86,12 +87,12 @@ app.once('ready', function() { { label: 'Undo', accelerator: 'Command+Z', - selector: 'undo:' + role: 'undo' }, { label: 'Redo', accelerator: 'Shift+Command+Z', - selector: 'redo:' + role: 'redo' }, { type: 'separator' @@ -99,22 +100,22 @@ app.once('ready', function() { { label: 'Cut', accelerator: 'Command+X', - selector: 'cut:' + role: 'cut' }, { label: 'Copy', accelerator: 'Command+C', - selector: 'copy:' + role: 'copy' }, { label: 'Paste', accelerator: 'Command+V', - selector: 'paste:' + role: 'paste' }, { label: 'Select All', accelerator: 'Command+A', - selector: 'selectAll:' + role: 'selectall' }, ] }, @@ -152,28 +153,30 @@ app.once('ready', function() { }, { label: 'Window', + role: 'window', submenu: [ { label: 'Minimize', accelerator: 'Command+M', - selector: 'performMiniaturize:' + role: 'minimize' }, { label: 'Close', accelerator: 'Command+W', - selector: 'performClose:' + role: 'close' }, { type: 'separator' }, { label: 'Bring All to Front', - selector: 'arrangeInFront:' + role: 'front' }, ] }, { label: 'Help', + role: 'help', submenu: [ { label: 'Learn More', diff --git a/atom/browser/ui/atom_menu_model.cc b/atom/browser/ui/atom_menu_model.cc index 7d2d5e1b6a1f..9add7a22715e 100644 --- a/atom/browser/ui/atom_menu_model.cc +++ b/atom/browser/ui/atom_menu_model.cc @@ -4,6 +4,8 @@ #include "atom/browser/ui/atom_menu_model.h" +#include "base/stl_util.h" + namespace atom { AtomMenuModel::AtomMenuModel(Delegate* delegate) @@ -14,6 +16,17 @@ AtomMenuModel::AtomMenuModel(Delegate* delegate) AtomMenuModel::~AtomMenuModel() { } +void AtomMenuModel::SetRole(int index, const base::string16& role) { + roles_[index] = role; +} + +base::string16 AtomMenuModel::GetRoleAt(int index) { + if (ContainsKey(roles_, index)) + return roles_[index]; + else + return base::string16(); +} + void AtomMenuModel::MenuClosed() { ui::SimpleMenuModel::MenuClosed(); FOR_EACH_OBSERVER(Observer, observers_, MenuClosed()); diff --git a/atom/browser/ui/atom_menu_model.h b/atom/browser/ui/atom_menu_model.h index 42e0e5dbc53a..fe19a8dc2518 100644 --- a/atom/browser/ui/atom_menu_model.h +++ b/atom/browser/ui/atom_menu_model.h @@ -5,6 +5,8 @@ #ifndef ATOM_BROWSER_UI_ATOM_MENU_MODEL_H_ #define ATOM_BROWSER_UI_ATOM_MENU_MODEL_H_ +#include + #include "base/observer_list.h" #include "ui/base/models/simple_menu_model.h" @@ -31,12 +33,16 @@ class AtomMenuModel : public ui::SimpleMenuModel { void AddObserver(Observer* obs) { observers_.AddObserver(obs); } void RemoveObserver(Observer* obs) { observers_.RemoveObserver(obs); } + void SetRole(int index, const base::string16& role); + base::string16 GetRoleAt(int index); + // ui::SimpleMenuModel: void MenuClosed() override; private: Delegate* delegate_; // weak ref. + std::map roles_; ObserverList observers_; DISALLOW_COPY_AND_ASSIGN(AtomMenuModel); diff --git a/atom/browser/ui/cocoa/atom_menu_controller.h b/atom/browser/ui/cocoa/atom_menu_controller.h index da10e1b0ba66..f8c48aa5dcb5 100644 --- a/atom/browser/ui/cocoa/atom_menu_controller.h +++ b/atom/browser/ui/cocoa/atom_menu_controller.h @@ -59,17 +59,4 @@ class MenuModel; @end -// Exposed only for unit testing, do not call directly. -@interface AtomMenuController (PrivateExposedForTesting) -- (BOOL)validateUserInterfaceItem:(id)item; -@end - -// Protected methods that subclassers can override. -@interface AtomMenuController (Protected) -- (void)addItemToMenu:(NSMenu*)menu - atIndex:(NSInteger)index - fromModel:(ui::MenuModel*)model; -- (NSMenu*)menuFromModel:(ui::MenuModel*)model; -@end - #endif // ATOM_BROWSER_UI_COCOA_ATOM_MENU_CONTROLLER_H_ diff --git a/atom/browser/ui/cocoa/atom_menu_controller.mm b/atom/browser/ui/cocoa/atom_menu_controller.mm index d799a9f9b64d..e3aa78aa248c 100644 --- a/atom/browser/ui/cocoa/atom_menu_controller.mm +++ b/atom/browser/ui/cocoa/atom_menu_controller.mm @@ -8,16 +8,36 @@ #include "atom/browser/ui/atom_menu_model.h" #include "base/logging.h" #include "base/strings/sys_string_conversions.h" +#include "base/strings/utf_string_conversions.h" #include "ui/base/accelerators/accelerator.h" #include "ui/base/accelerators/platform_accelerator_cocoa.h" #include "ui/base/l10n/l10n_util_mac.h" #include "ui/events/cocoa/cocoa_event_utils.h" #include "ui/gfx/image/image.h" -@interface AtomMenuController (Private) -- (void)addSeparatorToMenu:(NSMenu*)menu - atIndex:(int)index; -@end +namespace { + +struct Role { + SEL selector; + const char* role; +}; +Role kRolesMap[] = { + { @selector(orderFrontStandardAboutPanel:), "about" }, + { @selector(hide:), "hide" }, + { @selector(hideOtherApplications:), "hideothers" }, + { @selector(unhideAllApplications:), "unhide" }, + { @selector(arrangeInFront:), "front" }, + { @selector(undo:), "undo" }, + { @selector(redo:), "redo" }, + { @selector(cut:), "cut" }, + { @selector(copy:), "copy" }, + { @selector(paste:), "paste" }, + { @selector(selectAll:), "selectall" }, + { @selector(performMiniaturize:), "minimize" }, + { @selector(performClose:), "close" }, +}; + +} // namespace @implementation AtomMenuController @@ -101,7 +121,9 @@ // associated with the entry in the model identified by |modelIndex|. - (void)addItemToMenu:(NSMenu*)menu atIndex:(NSInteger)index - fromModel:(ui::MenuModel*)model { + fromModel:(ui::MenuModel*)ui_model { + atom::AtomMenuModel* model = static_cast(ui_model); + base::string16 label16 = model->GetLabelAt(index); NSString* label = l10n_util::FixUpWindowsStyleLabel(label16); base::scoped_nsobject item( @@ -124,13 +146,13 @@ [submenu setTitle:[item title]]; [item setSubmenu:submenu]; - // Hack to set window and help menu. - if ([[item title] isEqualToString:@"Window"] && [submenu numberOfItems] > 0) + // Set submenu's role. + base::string16 role = model->GetRoleAt(index); + if (role == base::ASCIIToUTF16("window")) [NSApp setWindowsMenu:submenu]; - else if ([[item title] isEqualToString:@"Help"]) + else if (role == base::ASCIIToUTF16("help")) [NSApp setHelpMenu:submenu]; - if ([[item title] isEqualToString:@"Services"] && - [submenu numberOfItems] == 0) + if (role == base::ASCIIToUTF16("services")) [NSApp setServicesMenu:submenu]; } else { // The MenuModel works on indexes so we can't just set the command id as the @@ -139,7 +161,6 @@ // model. Setting the target to |self| allows this class to participate // in validation of the menu items. [item setTag:index]; - [item setTarget:self]; NSValue* modelObject = [NSValue valueWithPointer:model]; [item setRepresentedObject:modelObject]; // Retains |modelObject|. ui::Accelerator accelerator; @@ -153,6 +174,19 @@ platformAccelerator->modifier_mask()]; } } + + // Set menu item's role. + base::string16 role = model->GetRoleAt(index); + if (role.empty()) { + [item setTarget:self]; + } else { + for (const Role& pair : kRolesMap) { + if (role == base::ASCIIToUTF16(pair.role)) { + [item setAction:pair.selector]; + break; + } + } + } } [menu insertItem:item atIndex:index]; } From 7d07f10c253e3872c7c39e7a032acdf54316f477 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 1 Sep 2015 23:34:32 +0800 Subject: [PATCH 1080/1293] Assign actions for roles on Windows and Linux --- atom/browser/api/lib/browser-window.coffee | 6 ++++++ atom/browser/api/lib/menu-item.coffee | 19 ++++++++++++++++--- atom/browser/api/lib/menu.coffee | 3 ++- 3 files changed, 24 insertions(+), 4 deletions(-) diff --git a/atom/browser/api/lib/browser-window.coffee b/atom/browser/api/lib/browser-window.coffee index 68b5932a93b4..283e99641f47 100644 --- a/atom/browser/api/lib/browser-window.coffee +++ b/atom/browser/api/lib/browser-window.coffee @@ -62,6 +62,12 @@ BrowserWindow::loadUrl = -> @webContents.loadUrl.apply @webContents, arguments BrowserWindow::send = -> @webContents.send.apply @webContents, arguments # Be compatible with old API. +BrowserWindow::undo = -> @webContents.undo() +BrowserWindow::redo = -> @webContents.redo() +BrowserWindow::cut = -> @webContents.cut() +BrowserWindow::copy = -> @webContents.copy() +BrowserWindow::paste = -> @webContents.paste() +BrowserWindow::selectAll = -> @webContents.selectAll() BrowserWindow::restart = -> @webContents.reload() BrowserWindow::getUrl = -> @webContents.getUrl() BrowserWindow::reload = -> @webContents.reload.apply @webContents, arguments diff --git a/atom/browser/api/lib/menu-item.coffee b/atom/browser/api/lib/menu-item.coffee index 7663b32996d8..cfefeec4edbb 100644 --- a/atom/browser/api/lib/menu-item.coffee +++ b/atom/browser/api/lib/menu-item.coffee @@ -3,6 +3,17 @@ v8Util = process.atomBinding 'v8_util' nextCommandId = 0 +# Maps role to methods of webContents +rolesMap = + undo: 'undo' + redo: 'redo' + cut: 'cut' + copy: 'copy' + paste: 'paste' + selectall: 'selectAll' + minimize: 'minimize' + close: 'close' + class MenuItem @types = ['normal', 'separator', 'submenu', 'checkbox', 'radio'] @@ -28,12 +39,14 @@ class MenuItem throw new Error("Unknown menu type #{@type}") if MenuItem.types.indexOf(@type) is -1 @commandId = ++nextCommandId - @click = => + @click = (focusedWindow) => # Manually flip the checked flags when clicked. @checked = !@checked if @type in ['checkbox', 'radio'] - if typeof click is 'function' - click this, BrowserWindow.getFocusedWindow() + if @role and rolesMap[@role] and process.platform isnt 'darwin' + focusedWindow?[rolesMap[@role]]() + else if typeof click is 'function' + click this, focusedWindow else if typeof @selector is 'string' Menu.sendActionToFirstResponder @selector diff --git a/atom/browser/api/lib/menu.coffee b/atom/browser/api/lib/menu.coffee index 35335ffcebe5..3595ba1fe7db 100644 --- a/atom/browser/api/lib/menu.coffee +++ b/atom/browser/api/lib/menu.coffee @@ -67,7 +67,8 @@ Menu::_init = -> isCommandIdVisible: (commandId) => @commandsMap[commandId]?.visible getAcceleratorForCommandId: (commandId) => @commandsMap[commandId]?.accelerator getIconForCommandId: (commandId) => @commandsMap[commandId]?.icon - executeCommand: (commandId) => @commandsMap[commandId]?.click() + executeCommand: (commandId) => + @commandsMap[commandId]?.click BrowserWindow.getFocusedWindow() menuWillShow: => # Make sure radio groups have at least one menu item seleted. for id, group of @groupsMap From 009b27f5f153ee8ae46508af98456c06e4a1b471 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 1 Sep 2015 23:34:56 +0800 Subject: [PATCH 1081/1293] Unify the menu of default app --- atom/browser/default_app/main.js | 395 +++++++++++++------------------ 1 file changed, 165 insertions(+), 230 deletions(-) diff --git a/atom/browser/default_app/main.js b/atom/browser/default_app/main.js index 99c4ad03320b..4d854dc35cbc 100644 --- a/atom/browser/default_app/main.js +++ b/atom/browser/default_app/main.js @@ -36,241 +36,176 @@ app.once('ready', function() { if (Menu.getApplicationMenu()) return; - var template; + var template = [ + { + label: 'Edit', + submenu: [ + { + label: 'Undo', + accelerator: 'CmdOrCtrl+Z', + role: 'undo' + }, + { + label: 'Redo', + accelerator: 'Shift+CmdOrCtrl+Z', + role: 'redo' + }, + { + type: 'separator' + }, + { + label: 'Cut', + accelerator: 'CmdOrCtrl+X', + role: 'cut' + }, + { + label: 'Copy', + accelerator: 'CmdOrCtrl+C', + role: 'copy' + }, + { + label: 'Paste', + accelerator: 'CmdOrCtrl+V', + role: 'paste' + }, + { + label: 'Select All', + accelerator: 'CmdOrCtrl+A', + role: 'selectall' + }, + ] + }, + { + label: 'View', + submenu: [ + { + label: 'Reload', + accelerator: 'CmdOrCtrl+R', + click: function(item, focusedWindow) { + if (focusedWindow) + focusedWindow.reload(); + } + }, + { + label: 'Toggle Full Screen', + accelerator: (function() { + if (process.platform == 'darwin') + return 'Ctrl+Command+F'; + else + return 'F11'; + })(), + click: function(item, focusedWindow) { + if (focusedWindow) + focusedWindow.setFullScreen(!focusedWindow.isFullScreen()); + } + }, + { + label: 'Toggle Developer Tools', + accelerator: (function() { + if (process.platform == 'darwin') + return 'Alt+Command+I'; + else + return 'Ctrl+Shift+I'; + })(), + click: function(item, focusedWindow) { + if (focusedWindow) + focusedWindow.toggleDevTools(); + } + }, + ] + }, + { + label: 'Window', + role: 'window', + submenu: [ + { + label: 'Minimize', + accelerator: 'CmdOrCtrl+M', + role: 'minimize' + }, + { + label: 'Close', + accelerator: 'CmdOrCtrl+W', + role: 'close' + }, + ] + }, + { + label: 'Help', + role: 'help', + submenu: [ + { + label: 'Learn More', + click: function() { require('shell').openExternal('http://electron.atom.io') } + }, + { + label: 'Documentation', + click: function() { require('shell').openExternal('https://github.com/atom/electron/tree/master/docs#readme') } + }, + { + label: 'Community Discussions', + click: function() { require('shell').openExternal('https://discuss.atom.io/c/electron') } + }, + { + label: 'Search Issues', + click: function() { require('shell').openExternal('https://github.com/atom/electron/issues') } + } + ] + }, + ]; + if (process.platform == 'darwin') { - template = [ + template.unshift({ + label: 'Electron', + submenu: [ + { + label: 'About Electron', + role: 'about' + }, + { + type: 'separator' + }, + { + label: 'Services', + role: 'services', + submenu: [] + }, + { + type: 'separator' + }, + { + label: 'Hide Electron', + accelerator: 'Command+H', + role: 'hide' + }, + { + label: 'Hide Others', + accelerator: 'Command+Shift+H', + role: 'hideothers:' + }, + { + label: 'Show All', + role: 'unhide:' + }, + { + type: 'separator' + }, + { + label: 'Quit', + accelerator: 'Command+Q', + click: function() { app.quit(); } + }, + ] + }); + template[3].submenu.push( { - label: 'Electron', - submenu: [ - { - label: 'About Electron', - role: 'about' - }, - { - type: 'separator' - }, - { - label: 'Services', - role: 'services', - submenu: [] - }, - { - type: 'separator' - }, - { - label: 'Hide Electron', - accelerator: 'Command+H', - role: 'hide' - }, - { - label: 'Hide Others', - accelerator: 'Command+Shift+H', - role: 'hideothers:' - }, - { - label: 'Show All', - role: 'unhide:' - }, - { - type: 'separator' - }, - { - label: 'Quit', - accelerator: 'Command+Q', - click: function() { app.quit(); } - }, - ] + type: 'separator' }, { - label: 'Edit', - submenu: [ - { - label: 'Undo', - accelerator: 'Command+Z', - role: 'undo' - }, - { - label: 'Redo', - accelerator: 'Shift+Command+Z', - role: 'redo' - }, - { - type: 'separator' - }, - { - label: 'Cut', - accelerator: 'Command+X', - role: 'cut' - }, - { - label: 'Copy', - accelerator: 'Command+C', - role: 'copy' - }, - { - label: 'Paste', - accelerator: 'Command+V', - role: 'paste' - }, - { - label: 'Select All', - accelerator: 'Command+A', - role: 'selectall' - }, - ] - }, - { - label: 'View', - submenu: [ - { - label: 'Reload', - accelerator: 'Command+R', - click: function() { - var focusedWindow = BrowserWindow.getFocusedWindow(); - if (focusedWindow) - focusedWindow.reload(); - } - }, - { - label: 'Toggle Full Screen', - accelerator: 'Ctrl+Command+F', - click: function() { - var focusedWindow = BrowserWindow.getFocusedWindow(); - if (focusedWindow) - focusedWindow.setFullScreen(!focusedWindow.isFullScreen()); - } - }, - { - label: 'Toggle Developer Tools', - accelerator: 'Alt+Command+I', - click: function() { - var focusedWindow = BrowserWindow.getFocusedWindow(); - if (focusedWindow) - focusedWindow.toggleDevTools(); - } - }, - ] - }, - { - label: 'Window', - role: 'window', - submenu: [ - { - label: 'Minimize', - accelerator: 'Command+M', - role: 'minimize' - }, - { - label: 'Close', - accelerator: 'Command+W', - role: 'close' - }, - { - type: 'separator' - }, - { - label: 'Bring All to Front', - role: 'front' - }, - ] - }, - { - label: 'Help', - role: 'help', - submenu: [ - { - label: 'Learn More', - click: function() { require('shell').openExternal('http://electron.atom.io') } - }, - { - label: 'Documentation', - click: function() { require('shell').openExternal('https://github.com/atom/electron/tree/master/docs#readme') } - }, - { - label: 'Community Discussions', - click: function() { require('shell').openExternal('https://discuss.atom.io/c/electron') } - }, - { - label: 'Search Issues', - click: function() { require('shell').openExternal('https://github.com/atom/electron/issues') } - } - ] + label: 'Bring All to Front', + role: 'front' } - ]; - } else { - template = [ - { - label: '&File', - submenu: [ - { - label: '&Open', - accelerator: 'Ctrl+O', - }, - { - label: '&Close', - accelerator: 'Ctrl+W', - click: function() { - var focusedWindow = BrowserWindow.getFocusedWindow(); - if (focusedWindow) - focusedWindow.close(); - } - }, - ] - }, - { - label: '&View', - submenu: [ - { - label: '&Reload', - accelerator: 'Ctrl+R', - click: function() { - var focusedWindow = BrowserWindow.getFocusedWindow(); - if (focusedWindow) - focusedWindow.reload(); - } - }, - { - label: 'Toggle &Full Screen', - accelerator: 'F11', - click: function() { - var focusedWindow = BrowserWindow.getFocusedWindow(); - if (focusedWindow) - focusedWindow.setFullScreen(!focusedWindow.isFullScreen()); - } - }, - { - label: 'Toggle &Developer Tools', - accelerator: 'Shift+Ctrl+I', - click: function() { - var focusedWindow = BrowserWindow.getFocusedWindow(); - if (focusedWindow) - focusedWindow.toggleDevTools(); - } - }, - ] - }, - { - label: 'Help', - submenu: [ - { - label: 'Learn More', - click: function() { require('shell').openExternal('http://electron.atom.io') } - }, - { - label: 'Documentation', - click: function() { require('shell').openExternal('https://github.com/atom/electron/tree/master/docs#readme') } - }, - { - label: 'Community Discussions', - click: function() { require('shell').openExternal('https://discuss.atom.io/c/electron') } - }, - { - label: 'Search Issues', - click: function() { require('shell').openExternal('https://github.com/atom/electron/issues') } - } - ] - } - ]; + ); } var menu = Menu.buildFromTemplate(template); From 6bce5b560bc04b9caa720bb89a73f3096a0ac120 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 2 Sep 2015 09:19:18 +0800 Subject: [PATCH 1082/1293] docs: The "role" attribute of MenuItem --- docs/api/dialog.md | 3 +- docs/api/menu-item.md | 33 ++++++- docs/api/menu.md | 201 ++++++++++++++++++++++++------------------ 3 files changed, 147 insertions(+), 90 deletions(-) diff --git a/docs/api/dialog.md b/docs/api/dialog.md index d00540e62df9..0fadfa37f80c 100644 --- a/docs/api/dialog.md +++ b/docs/api/dialog.md @@ -48,12 +48,13 @@ selected when you want to limit the user to a specific type. For example: ] } ``` + The `extensions` array should contain extensions without wildcards or dots (e.g. `'png'` is good but `'.png'` and `'*.png'` are bad). To show all files, use the `'*'` wildcard (no other wildcard is supported). If a `callback` is passed, the API call will be asynchronous and the result -wil be passed via `callback(filenames)` +will be passed via `callback(filenames)` **Note:** On Windows and Linux an open dialog can not be both a file selector and a directory selector, so if you set `properties` to diff --git a/docs/api/menu-item.md b/docs/api/menu-item.md index 71b69b850a69..89524d9f2352 100644 --- a/docs/api/menu-item.md +++ b/docs/api/menu-item.md @@ -12,9 +12,10 @@ Create a new `MenuItem` with the following method: ### new MenuItem(options) * `options` Object - * `click` Function - Callback when the menu item is clicked - * `selector` String - Call the selector of first responder when clicked (OS - X only) + * `click` Function - Will be called with `click(menuItem, browserWindow)` when + the menu item is clicked + * `role` String - Define the action of the menu item, when specified the + `click` property will be ignored * `type` String - Can be `normal`, `separator`, `submenu`, `checkbox` or `radio` * `label` String @@ -30,3 +31,29 @@ Create a new `MenuItem` with the following method: as a reference to this item by the position attribute. * `position` String - This field allows fine-grained definition of the specific location within a given menu. + +When creating menu items, it is recommended to specify `role` instead of +manually implementing the behavior if there is matching action, so menu can have +best native experience. + +The `role` property can have following values: + +* `undo` +* `redo` +* `cut` +* `copy` +* `paste` +* `selectall` +* `minimize` - Minimize current window +* `close` - Close current window + +On OS X `role` can also have following additional values: + +* `about` - Map to the `orderFrontStandardAboutPanel` action +* `hide` - Map to the `hide` action +* `hideothers` - Map to the `hideOtherApplications` action +* `unhide` - Map to the `unhideAllApplications` action +* `front` - Map to the `arrangeInFront` action +* `window` - The submenu is a "Window" menu +* `help` - The submenu is a "Help" menu +* `services` - The submenu is a "Services" menu diff --git a/docs/api/menu.md b/docs/api/menu.md index 1d6e4135157d..49d6361bcf0b 100644 --- a/docs/api/menu.md +++ b/docs/api/menu.md @@ -35,68 +35,20 @@ window.addEventListener('contextmenu', function (e) { An example of creating the application menu in the render process with the simple template API: -**Note to Window and Linux users** the `selector` member of each menu item is a -Mac-only [Accelerator option](https://github.com/atom/electron/blob/master/docs/api/accelerator.md). - -```html - - ``` ## Class: Menu @@ -242,29 +272,26 @@ Linux, here are some notes on making your app's menu more native-like. ### Standard Menus On OS X there are many system defined standard menus, like the `Services` and -`Windows` menus. To make your menu a standard menu, you can just set your menu's -label to one of following and Electron will recognize them and make them +`Windows` menus. To make your menu a standard menu, you should set your menu's +`role` to one of following and Electron will recognize them and make them become standard menus: -* `Window` -* `Help` -* `Services` +* `window` +* `help` +* `services` ### Standard Menu Item Actions -OS X has provided standard actions for some menu items (which are called -`selector`s), like `About xxx`, `Hide xxx`, and `Hide Others`. To set the action -of a menu item to a standard action, you can set the `selector` attribute of the -menu item. +OS X has provided standard actions for some menu items, like `About xxx`, +`Hide xxx`, and `Hide Others`. To set the action of a menu item to a standard +action, you should set the `role` attribute of the menu item. ### Main Menu's Name On OS X the label of application menu's first item is always your app's name, no matter what label you set. To change it you have to change your app's name -by modifying your app bundle's `Info.plist` file. See -[About Information Property List Files](https://developer.apple.com/library/ios/documentation/general/Reference/InfoPlistKeyReference/Articles/AboutInformationPropertyListFiles.html) -for more information. - +by modifying your app bundle's `Info.plist` file. See [About Information +Property List Files][AboutInformationPropertyListFiles] for more information. ## Menu Item Position @@ -339,3 +366,5 @@ Menu: - 2 - 3 ``` + +[AboutInformationPropertyListFiles]: https://developer.apple.com/library/ios/documentation/general/Reference/InfoPlistKeyReference/Articles/AboutInformationPropertyListFiles.html From 0fa0aedd86105a33ba1d0019a6cc1e5832de491b Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Tue, 1 Sep 2015 19:08:31 -0700 Subject: [PATCH 1083/1293] Text edits --- docs/api/protocol.md | 22 ++++++++++++---------- docs/api/remote.md | 6 +++--- 2 files changed, 15 insertions(+), 13 deletions(-) diff --git a/docs/api/protocol.md b/docs/api/protocol.md index ba4160d7c321..795e4340c7ee 100644 --- a/docs/api/protocol.md +++ b/docs/api/protocol.md @@ -22,7 +22,8 @@ app.on('ready', function() { }); ``` -**Note:** This module can only be used after the `ready` event was emitted. +**Note:** This module can only be used after the `ready` event in the `app` +module is emitted. ## Methods @@ -42,10 +43,11 @@ includes `file:` and `filesystem:`. * `handler` Function * `completion` Function (optional) -Registers a protocol of `scheme` that will send the file as a response. The `handler` -will be called with `handler(request, callback)` when a `request` is going to be -created with `scheme` and `completion` will be called with `completion(null)` -when `scheme` is successfully registered, or `completion(error)` when failed. +Registers a protocol of `scheme` that will send the file as a response. The +`handler` will be called with `handler(request, callback)` when a `request` is +going to be created with `scheme`. `completion` will be called with +`completion(null)` when `scheme` is successfully registered or +`completion(error)` when failed. To handle the `request`, the `callback` should be called with either the file's path or an object that has a `path` property, e.g. `callback(filePath)` or @@ -53,13 +55,13 @@ path or an object that has a `path` property, e.g. `callback(filePath)` or When `callback` is called with nothing, a number, or an object that has an `error` property, the `request` will fail with the `error` number you -specified. For the available error numbers you can use, please see: -https://code.google.com/p/chromium/codesearch#chromium/src/net/base/net_error_list.h +specified. For the available error numbers you can use, please see the +[net error list](https://code.google.com/p/chromium/codesearch#chromium/src/net/base/net_error_list.h). By default the `scheme` is treated like `http:`, which is parsed differently -from protocols that follow "generic URI syntax" like `file:`, so you probably -want to call `protocol.registerStandardSchemes` to have your scheme treated as a -standard scheme. +than protocols that follow the "generic URI syntax" like `file:`, so you +probably want to call `protocol.registerStandardSchemes` to have your scheme +treated as a standard scheme. ### `protocol.registerBufferProtocol(scheme, handler[, completion])` diff --git a/docs/api/remote.md b/docs/api/remote.md index 9490c1977932..ccb16b4b3cc3 100644 --- a/docs/api/remote.md +++ b/docs/api/remote.md @@ -1,11 +1,11 @@ # remote The `remote` module provides a simple way to do inter-process communication -between the renderer process (web page) and the main process. +(IPC) between the renderer process (web page) and the main process. In Electron, only GUI-unrelated modules are available in the renderer process. Without the `remote` module, users who want to call a main process API in -the renderer process would have to explicitly send inter-process messages +the renderer process will have to explicitly send inter-process messages to the main process. With the `remote` module, you can invoke methods of the main process object without explicitly sending inter-process messages, similar to Java's [RMI](http://en.wikipedia.org/wiki/Java_remote_method_invocation). @@ -114,7 +114,7 @@ callback will be installed again, leaking one callback for each restart. To make things worse, since the context of previously installed callbacks has been released, exceptions will be raised in the main process when the `close` -event is emitted . +event is emitted. To avoid this problem, ensure you clean up any references to renderer callbacks passed to the main process. This involves cleaning up event handlers, or From f5f3278ffa82f7ce4fd4e0e6af1276a3c8cf1ced Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 2 Sep 2015 11:11:27 +0800 Subject: [PATCH 1084/1293] Bump v0.31.2 --- atom.gyp | 2 +- atom/browser/resources/mac/Info.plist | 2 +- atom/browser/resources/win/atom.rc | 8 ++++---- atom/common/atom_version.h | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/atom.gyp b/atom.gyp index 08885b3ef532..c0fc40187984 100644 --- a/atom.gyp +++ b/atom.gyp @@ -4,7 +4,7 @@ 'product_name%': 'Electron', 'company_name%': 'GitHub, Inc', 'company_abbr%': 'github', - 'version%': '0.31.0', + 'version%': '0.31.2', }, 'includes': [ 'filenames.gypi', diff --git a/atom/browser/resources/mac/Info.plist b/atom/browser/resources/mac/Info.plist index a9076b830eb4..73facdc7f565 100644 --- a/atom/browser/resources/mac/Info.plist +++ b/atom/browser/resources/mac/Info.plist @@ -17,7 +17,7 @@ CFBundleIconFile atom.icns CFBundleVersion - 0.31.0 + 0.31.2 LSMinimumSystemVersion 10.8.0 NSMainNibFile diff --git a/atom/browser/resources/win/atom.rc b/atom/browser/resources/win/atom.rc index c97106298bf8..7e7fea9f2fb3 100644 --- a/atom/browser/resources/win/atom.rc +++ b/atom/browser/resources/win/atom.rc @@ -56,8 +56,8 @@ END // VS_VERSION_INFO VERSIONINFO - FILEVERSION 0,31,0,0 - PRODUCTVERSION 0,31,0,0 + FILEVERSION 0,31,2,0 + PRODUCTVERSION 0,31,2,0 FILEFLAGSMASK 0x3fL #ifdef _DEBUG FILEFLAGS 0x1L @@ -74,12 +74,12 @@ BEGIN BEGIN VALUE "CompanyName", "GitHub, Inc." VALUE "FileDescription", "Electron" - VALUE "FileVersion", "0.31.0" + VALUE "FileVersion", "0.31.2" VALUE "InternalName", "electron.exe" VALUE "LegalCopyright", "Copyright (C) 2015 GitHub, Inc. All rights reserved." VALUE "OriginalFilename", "electron.exe" VALUE "ProductName", "Electron" - VALUE "ProductVersion", "0.31.0" + VALUE "ProductVersion", "0.31.2" VALUE "SquirrelAwareVersion", "1" END END diff --git a/atom/common/atom_version.h b/atom/common/atom_version.h index 483bf382c265..a0b865b0e2a6 100644 --- a/atom/common/atom_version.h +++ b/atom/common/atom_version.h @@ -7,7 +7,7 @@ #define ATOM_MAJOR_VERSION 0 #define ATOM_MINOR_VERSION 31 -#define ATOM_PATCH_VERSION 0 +#define ATOM_PATCH_VERSION 2 #define ATOM_VERSION_IS_RELEASE 1 From e71d2bd8e77e101891115db09529b5a5456b7a6a Mon Sep 17 00:00:00 2001 From: Antonio Stoilkov Date: Wed, 2 Sep 2015 14:18:17 +0300 Subject: [PATCH 1085/1293] Clarify Selenium and WebDriver documentation --- docs/tutorial/using-selenium-and-webdriver.md | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/docs/tutorial/using-selenium-and-webdriver.md b/docs/tutorial/using-selenium-and-webdriver.md index f3b7310dfbe5..058603784e22 100644 --- a/docs/tutorial/using-selenium-and-webdriver.md +++ b/docs/tutorial/using-selenium-and-webdriver.md @@ -8,14 +8,8 @@ From [ChromeDriver - WebDriver for Chrome][chrome-driver]: > implements WebDriver's wire protocol for Chromium. It is being developed by > members of the Chromium and WebDriver teams. -In Electron's [releases](https://github.com/atom/electron/releases) page you -can find archives of `chromedriver`, there is no difference between Electron's -distribution of `chromedriver` and upstream ones, so in order to use -`chromedriver` together with Electron, you will need some special setup. - -Also notice that only minor version update releases (e.g. `vX.X.0` releases) -include `chromedriver` archives, because `chromedriver` doesn't change as -frequent as Electron itself. +In order to use `chromedriver` together with Electron you have to tell it where to +find Electron and make it think Electron is Chrome browser. ## Setting up with WebDriverJs From e78db6ae078d7fd384a9de54ffd78a4cb74e62c8 Mon Sep 17 00:00:00 2001 From: huangruichang <532079207@qq.com> Date: Wed, 2 Sep 2015 20:12:22 +0800 Subject: [PATCH 1086/1293] * add desktop-environment-integration.md and and online-offline-events.md for zh-CN --- .../desktop-environment-integration.md | 167 ++++++++++++++++++ .../zh-CN/tutorial/online-offline-events.md | 72 ++++++++ 2 files changed, 239 insertions(+) create mode 100644 docs-translations/zh-CN/tutorial/desktop-environment-integration.md create mode 100644 docs-translations/zh-CN/tutorial/online-offline-events.md diff --git a/docs-translations/zh-CN/tutorial/desktop-environment-integration.md b/docs-translations/zh-CN/tutorial/desktop-environment-integration.md new file mode 100644 index 000000000000..f8fbdaaaf548 --- /dev/null +++ b/docs-translations/zh-CN/tutorial/desktop-environment-integration.md @@ -0,0 +1,167 @@ +# 桌面环境集成 +不同的操作系统在各自的桌面应用上提供了不同的特性。例如，在 windows 上应用曾经打开的文件会出现在任务栏的跳转列表，在 Mac 上，应用可以把自定义菜单放在鱼眼菜单上。 + +本章将会说明怎样使用 Electron APIs 把你的应用和桌面环境集成到一块。 + +## 最近文档 (Windows & OS X) +Windows 和 OS X 提供获取最近文档列表的便捷方式，那就是打开跳转列表或者鱼眼菜单。 + +跳转列表： +![JumpList][1] + +鱼眼菜单： +![Dock Menu][2] + +为了增加一个文件到最近文件列表，你可以使用 [app.addRecentDocument][3] API: + +```` +var app = require('app'); +app.addRecentDocument('/Users/USERNAME/Desktop/work.type'); +```` +或者你也可以使用 [app.clearRecentDocuments][4] API 来清空最近文件列表。 +```` +app.clearRecentDocuments(); +```` +## Windows 需注意 +为了这个特性在 Windows 上表现正常，你的应用需要被注册成为一种文件类型的句柄，否则，在你注册之前，文件不会出现在跳转列表。你可以在 [Application Registration][5] 里找到任何关于注册事宜的说明。 + +## OS X 需注意 +当一个文件被最近文件列表请求时，`app` 模块里的 `open-file` 事件将会被发出。 + +## 自定义的鱼眼菜单(OS X) +OS X 可以让开发者定制自己的菜单，通常会包含一些常用特性的快捷方式。 +### 菜单中的终端 +[Dock menu of Terminal.app][6] + +使用 `app.dock.setMenu` API 来设置你的菜单，这仅在 OS X 上可行： +```` +var app = require('app'); +var Menu = require('menu'); +var dockMenu = Menu.buildFromTemplate([ + { label: 'New Window', click: function() { console.log('New Window'); } }, + { label: 'New Window with Settings', submenu: [ + { label: 'Basic' }, + { label: 'Pro'} + ]}, + { label: 'New Command...'} +]); +app.dock.setMenu(dockMenu); +```` + +## 用户任务(Windows) +在 Windows，你可以特别定义跳转列表的 `Tasks` 目录的行为，引用 MSDN 的文档： + +> Applications define tasks based on both the program's features and the key things a user is expected to do with them. Tasks should be context-free, in that the application does not need to be running for them to work. They should also be the statistically most common actions that a normal user would perform in an application, such as compose an email message or open the calendar in a mail program, create a new document in a word processor, launch an application in a certain mode, or launch one of its subcommands. An application should not clutter the menu with advanced features that standard users won't need or one-time actions such as registration. Do not use tasks for promotional items such as upgrades or special offers. + +> It is strongly recommended that the task list be static. It should remain the same regardless of the state or status of the application. While it is possible to vary the list dynamically, you should consider that this could confuse the user who does not expect that portion of the destination list to change. + +### IE 的任务 +![IE][7] +不同于 OS X 的鱼眼菜单，Windows 上的用户任务表现得更像一个快捷方式，比如当用户点击一个任务，一个程序将会被传入特定的参数并且运行。 + +你可以使用 [app.setUserTasks][8] API 来设置你的应用中的用户任务： +```` +var app = require('app'); +app.setUserTasks([ + { + program: process.execPath, + arguments: '--new-window', + iconPath: process.execPath, + iconIndex: 0, + title: 'New Window', + description: 'Create a new window' + } +]); +```` +调用 `app.setUserTasks` 并传入空数组就可以清除你的任务列表： +```` +app.setUserTasks([]); +```` +当你的应用关闭时，用户任务会仍然会出现，在你的应用被卸载前，任务指定的图标和程序的路径必须是存在的。 + +### 缩略图工具栏 +在 Windows，你可以在任务栏上添加一个按钮来当作应用的缩略图工具栏。它将提供用户一种用户访问常用窗口的方式，并且不需要恢复或者激活窗口。 + +在 MSDN，它被如是说： +> This toolbar is simply the familiar standard toolbar common control. It has a maximum of seven buttons. Each button's ID, image, tooltip, and state are defined in a structure, which is then passed to the taskbar. The application can show, enable, disable, or hide buttons from the thumbnail toolbar as required by its current state. + +> For example, Windows Media Player might offer standard media transport controls such as play, pause, mute, and stop. + +### Windows Media Player 的缩略图工具栏 +![Thumbnail toolbar of Windows Media Player][9] +你可以使用 [BrowserWindow.setThumbarButtons][10] 来设置你的应用的缩略图工具栏。 +```` +var BrowserWindow = require('browser-window'); +var path = require('path'); +var win = new BrowserWindow({ + width: 800, + height: 600 +}); +win.setThumbarButtons([ + { + tooltip: "button1", + icon: path.join(__dirname, 'button1.png'), + click: function() { console.log("button2 clicked"); } + }, + { + tooltip: "button2", + icon: path.join(__dirname, 'button2.png'), + flags:['enabled', 'dismissonclick'], + click: function() { console.log("button2 clicked."); } + } +]); +```` +调用 `BrowserWindow.setThumbarButtons` 并传入空数组即可清空缩略图工具栏： +```` +win.setThumbarButtons([]); +```` + +## Unity launcher 快捷方式(Linux) +在 Unity,你可以通过改变 `.desktop` 文件来增加自定义运行器的快捷方式，详情看 [Adding shortcuts to a launcher][11]。 +### Audacious 运行器的快捷方式： +![Launcher shortcuts of Audacious][12] + +## 任务栏的进度条(Windows & Unity) +在 Windows，进度条可以出现在一个任务栏按钮之上。这可以提供进度信息给用户而不需要用户切换应用窗口。 + +Unity DE 也具有同样的特性，在运行器上显示进度条。 +### 在任务栏上的进度条： +![Progress bar in taskbar button][13] + +### 在 Unity 运行器上的进度条 +![Progress bar in Unity launcher][14] + +给一个窗口设置进度条，你可以调用 [BrowserWindow.setProgressBar][15] API： +```` +var window = new BrowserWindow({...}); +window.setProgressBar(0.5); +```` +在 OS X，一个窗口可以设置它展示的文件，文件的图标可以出现在标题栏，当用户 Command-Click 或者 Control-Click 标题栏，文件路径弹窗将会出现。 +### 展示文件弹窗菜单： +![Represented file popup menu][16] + +你可以调用 [BrowserWindow.setRepresentedFilename][17] 和 [BrowserWindow.setDocumentEdited][18] APIs： +```` +var window = new BrowserWindow({...}); +window.setRepresentedFilename('/etc/passwd'); +window.setDocumentEdited(true); +```` + + [1]:https://camo.githubusercontent.com/3310597e01f138b1d687e07aa618c50908a88dec/687474703a2f2f692e6d73646e2e6d6963726f736f66742e636f6d2f64796e696d672f49433432303533382e706e67 + [2]: https://cloud.githubusercontent.com/assets/639601/5069610/2aa80758-6e97-11e4-8cfb-c1a414a10774.png + [3]: https://github.com/atom/electron/blob/master/docs-translations/zh-CN/api/app.md + [4]: https://github.com/atom/electron/blob/master/docs/tutorial/clearrecentdocuments + [5]: https://msdn.microsoft.com/en-us/library/windows/desktop/ee872121%28v=vs.85%29.aspx + [6]: https://cloud.githubusercontent.com/assets/639601/5069962/6032658a-6e9c-11e4-9953-aa84006bdfff.png + [7]: https://camo.githubusercontent.com/30154e0cc36acfc968ac9ae076a8f0d6600dd736/687474703a2f2f692e6d73646e2e6d6963726f736f66742e636f6d2f64796e696d672f49433432303533392e706e67 + [8]: https://github.com/atom/electron/blob/master/docs/api/app.md#appsetusertaskstasks + [9]: https://camo.githubusercontent.com/098cb0f52f27084a80ec6429e51a195df3d8c333/68747470733a2f2f692d6d73646e2e7365632e732d6d7366742e636f6d2f64796e696d672f49433432303534302e706e67 + [10]: https://github.com/atom/electron/blob/master/docs-translations/zh-CN/api/browser-window.md + [11]: https://help.ubuntu.com/community/UnityLaunchersAndDesktopFiles#Adding_shortcuts_to_a_launcher + [12]: https://camo.githubusercontent.com/b6f54e2bc3206ebf8e08dd029529af9ec84d58ae/68747470733a2f2f68656c702e7562756e74752e636f6d2f636f6d6d756e6974792f556e6974794c61756e6368657273416e644465736b746f7046696c65733f616374696f6e3d41747461636846696c6526646f3d676574267461726765743d73686f7274637574732e706e67 + [13]: https://cloud.githubusercontent.com/assets/639601/5081682/16691fda-6f0e-11e4-9676-49b6418f1264.png + [14]: https://cloud.githubusercontent.com/assets/639601/5081747/4a0a589e-6f0f-11e4-803f-91594716a546.png + [15]: https://github.com/atom/electron/blob/master/docs-translations/zh-CN/api/browser-window.md + [16]: https://cloud.githubusercontent.com/assets/639601/5082061/670a949a-6f14-11e4-987a-9aaa04b23c1d.png + [17]: https://github.com/atom/electron/blob/master/docs-translations/zh-CN/api/browser-window.md + [18]: https://github.com/atom/electron/blob/master/docs-translations/zh-CN/api/browser-window.md \ No newline at end of file diff --git a/docs-translations/zh-CN/tutorial/online-offline-events.md b/docs-translations/zh-CN/tutorial/online-offline-events.md new file mode 100644 index 000000000000..de292490f0be --- /dev/null +++ b/docs-translations/zh-CN/tutorial/online-offline-events.md @@ -0,0 +1,72 @@ +# 在线/离线事件探测 +使用标准 HTML5 APIs 可以实现在线和离线事件的探测，就像以下例子： + +*main.js* +```` +var app = require('app'); +var BrowserWindow = require('browser-window'); +var onlineStatusWindow; + +app.on('ready', function() { + onlineStatusWindow = new BrowserWindow({ width: 0, height: 0, show: false }); + onlineStatusWindow.loadUrl('file://' + __dirname + '/online-status.html'); +}); +```` + +*online-status.html* +```` + + + + + + +```` + +也会有人想要在主进程也有回应这些事件的实例。然后主进程没有 `navigator` 对象因此不能直接探测在线还是离线。使用 Electron 的进程间通讯工具，事件就可以在主进程被使，就像下面的例子： + +*main.js* +```` +var app = require('app'); +var ipc = require('ipc'); +var BrowserWindow = require('browser-window'); +var onlineStatusWindow; + +app.on('ready', function() { + onlineStatusWindow = new BrowserWindow({ width: 0, height: 0, show: false }); + onlineStatusWindow.loadUrl('file://' + __dirname + '/online-status.html'); +}); + +ipc.on('online-status-changed', function(event, status) { + console.log(status); +}); +```` + +*online-status.html* +```` + + + + + + +```` \ No newline at end of file From 3914ff2ac50624cea0088607d354c258b5a47934 Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Thu, 3 Sep 2015 01:12:54 +0900 Subject: [PATCH 1087/1293] Fix many typos, update as upstream --- docs-translations/ko/README.md | 2 +- docs-translations/ko/api/global-shortcut.md | 2 +- docs-translations/ko/api/menu-item.md | 38 ++- docs-translations/ko/api/menu.md | 241 ++++++++++-------- docs-translations/ko/api/native-image.md | 60 +++-- docs-translations/ko/api/power-monitor.md | 12 +- .../ko/api/power-save-blocker.md | 25 +- docs-translations/ko/api/process.md | 10 +- docs-translations/ko/api/shell.md | 21 +- docs-translations/ko/api/synopsis.md | 13 +- docs-translations/ko/api/tray.md | 74 +++--- .../development/build-instructions-linux.md | 12 +- .../desktop-environment-integration.md | 2 +- .../tutorial/using-selenium-and-webdriver.md | 8 +- 14 files changed, 307 insertions(+), 213 deletions(-) diff --git a/docs-translations/ko/README.md b/docs-translations/ko/README.md index 89112b11c835..da377b6c61e1 100644 --- a/docs-translations/ko/README.md +++ b/docs-translations/ko/README.md @@ -17,7 +17,7 @@ ## API 레퍼런스 * [개요](api/synopsis.md) -* [프로세스 객체](api/process.md) +* [process](api/process.md) * [크롬 Command-Line 스위치 지원](api/chrome-command-line-switches.md) 커스텀 DOM elements: diff --git a/docs-translations/ko/api/global-shortcut.md b/docs-translations/ko/api/global-shortcut.md index b6ad3fe89b86..84c1c70798d7 100644 --- a/docs-translations/ko/api/global-shortcut.md +++ b/docs-translations/ko/api/global-shortcut.md @@ -1,7 +1,7 @@ # global-shortcut `global-shortcut` 모듈은 운영체제의 전역 키보드 단축키를 등록/해제 하는 방법을 제공합니다. -이 모듈을 사용하여 사용자가 다양한 단축키 작업을 할 수 있도록 단축키를 정의 할 수 있습니다. +이 모듈을 사용하여 사용자가 다양한 작업을 편하게 할 수 있도록 단축키를 정의 할 수 있습니다. **참고:** 등록된 단축키는 어플리케이션이 백그라운드로 작동(창이 포커스 되지 않음) 할 때도 계속해서 작동합니다. 이 모듈은 `app` 모듈의 `ready` 이벤트 이전에 사용할 수 없습니다. diff --git a/docs-translations/ko/api/menu-item.md b/docs-translations/ko/api/menu-item.md index 4d79fb1d44fa..8f1021009954 100644 --- a/docs-translations/ko/api/menu-item.md +++ b/docs-translations/ko/api/menu-item.md @@ -1,12 +1,18 @@ -# menu-item +# MenuItem + +`menu-item` 모듈은 어플리케이션 또는 컨텐츠 [`menu`](menu.md)에 아이템을 추가할 수 있도록 관련 클래스를 제공합니다. + +[`menu`](menu.md)에서 예제를 확인할 수 있습니다. ## Class: MenuItem +`MenuItem` 인스턴스 객체에서 사용할 수 있는 메서드입니다: + ### new MenuItem(options) * `options` Object - * `click` Function - 메뉴 아이템이 클릭될 때 호출되는 콜백 함수 - * `selector` String - First Responder가 클릭될 때 호출 되는 선택자 (OS X 전용) + * `click` Function - 메뉴 아이템이 클릭될 때 `click(menuItem, browserWindow)` 형태로 호출 되는 콜백 함수 + * `role` String - 메뉴 아이템의 액션을 정의합니다. 이 속성을 지정하면 `click` 속성이 무시됩니다. * `type` String - `MenuItem`의 타입 `normal`, `separator`, `submenu`, `checkbox` 또는 `radio` 사용가능 * `label` String * `sublabel` String @@ -18,3 +24,29 @@ * `submenu` Menu - 보조메뉴를 설정합니다. `type`이 `submenu`일 경우 반드시 설정해야합니다. 일반 메뉴 아이템일 경우 생략할 수 있습니다. * `id` String - 현재 메뉴 아이템에 대해 유일키를 지정합니다. 이 키는 이후 `position` 옵션에서 사용할 수 있습니다. * `position` String - 미리 지정한 `id`를 이용하여 메뉴 아이템의 위치를 세밀하게 조정합니다. + +When creating menu items, it is recommended to specify `role` instead of +manually implementing the behavior if there is matching action, so menu can have +best native experience. + +The `role` property can have following values: + +* `undo` +* `redo` +* `cut` +* `copy` +* `paste` +* `selectall` +* `minimize` - Minimize current window +* `close` - Close current window + +On OS X `role` can also have following additional values: + +* `about` - Map to the `orderFrontStandardAboutPanel` action +* `hide` - Map to the `hide` action +* `hideothers` - Map to the `hideOtherApplications` action +* `unhide` - Map to the `unhideAllApplications` action +* `front` - Map to the `arrangeInFront` action +* `window` - The submenu is a "Window" menu +* `help` - The submenu is a "Help" menu +* `services` - The submenu is a "Services" menu diff --git a/docs-translations/ko/api/menu.md b/docs-translations/ko/api/menu.md index 6636158cdda5..90ea6539829a 100644 --- a/docs-translations/ko/api/menu.md +++ b/docs-translations/ko/api/menu.md @@ -1,11 +1,12 @@ -# menu +# Menu -`Menu` 클래스는 어플리케이션 메뉴와 컨텍스트 메뉴를 만들 때 사용됩니다. -메뉴는 여러 개의 메뉴 아이템으로 구성되고 서브 메뉴를 가질 수도 있습니다. +`menu` 클래스는 어플리케이션 메뉴와 [컨텍스트 메뉴](https://developer.mozilla.org/en-US/docs/Mozilla/Tech/XUL/PopupGuide/ContextMenus)를 만들 때 사용됩니다. +이 모듈은 메인 프로세스용 모듈이지만 `remote` 모듈을 통해 랜더러 프로세스에서도 사용할 수 있습니다. + +각 메뉴는 여러 개의 [메뉴 아이템](menu-item.md)으로 구성되고 서브 메뉴를 가질 수도 있습니다. 다음 예제는 웹 페이지 내에서 [remote](remote.md) 모듈을 활용하여 동적으로 메뉴를 생성하는 예제입니다. - -이 예제에서 만들어진 메뉴는 유저가 페이지에서 오른쪽 클릭을 할 때 마우스 위치에 팝업 형태로 표시됩니다: +그리고 유저가 페이지에서 오른쪽 클릭을 할 때마다 마우스 위치에 팝업 형태로 메뉴를 표시합니다: ```html @@ -26,69 +27,22 @@ window.addEventListener('contextmenu', function (e) { ``` -다음 예제는 template API를 활용하여 어플리케이션 메뉴를 만드는 간단한 예제입니다: +또 하나의 예를 들자면 다음 예제는 랜더러 프로세스에서 template API를 사용하여 어플리케이션 메뉴를 만듭니다: -**Windows 와 Linux 유저 주의:** 각 메뉴 아이템의 `selector` 멤버는 Mac 운영체제 전용입니다. [Accelerator 옵션](accelerator.md) - -```html - - ``` ## Class: Menu -### new Menu() +### `new Menu()` 새로운 메뉴를 생성합니다. -### Class Method: Menu.setApplicationMenu(menu) +### Methods + +`menu` 클래스는 다음과 같은 메서드를 가지고 있습니다: + +### `Menu.setApplicationMenu(menu)` * `menu` Menu -지정한 `menu`를 이용하여 어플리케이션 메뉴를 만듭니다. OS X에선 상단바에 표시되며 Windows와 Linux에선 각 창의 상단에 표시됩니다. +지정한 `menu`를 어플리케이션 메뉴로 만듭니다. OS X에선 상단바에 표시되며 Windows와 Linux에선 각 창의 상단에 표시됩니다. -### Class Method: Menu.sendActionToFirstResponder(action) +### `Menu.sendActionToFirstResponder(action)` _OS X_ * `action` String @@ -185,7 +221,7 @@ Menu.setApplicationMenu(menu); **참고:** 이 메서드는 OS X에서만 사용할 수 있습니다. -### Class Method: Menu.buildFromTemplate(template) +### `Menu.buildFromTemplate(template)` * `template` Array @@ -193,57 +229,58 @@ Menu.setApplicationMenu(menu); 또한 `template`에는 다른 속성도 추가할 수 있으며 메뉴가 만들어질 때 해당 메뉴 아이템의 프로퍼티로 변환됩니다. -### Menu.popup(browserWindow, [x, y]) +### `Menu.popup(browserWindow[, x, y])` * `browserWindow` BrowserWindow -* `x` Number -* `y` Number +* `x` Number (optional) +* `y` Number (만약 `x`를 지정했을 경우 `y`도 필수로 지정해야 합니다) -메뉴를 `browserWindow` 안에서 팝업으로 표시합니다. -옵션으로 메뉴를 표시할 `(x,y)` 좌표를 임의로 지정할 수 있습니다. 따로 지정하지 않은 경우 마우스 커서 위치에 표시됩니다. +메뉴를 `browserWindow` 내부 팝업으로 표시합니다. +옵션으로 메뉴를 표시할 `(x,y)` 좌표를 지정할 수 있습니다. +따로 좌표를 지정하지 않은 경우 마우스 커서 위치에 표시됩니다. -### Menu.append(menuItem) +### `Menu.append(menuItem)` * `menuItem` MenuItem 메뉴의 리스트 끝에 `menuItem`을 삽입합니다. -### Menu.insert(pos, menuItem) +### `Menu.insert(pos, menuItem)` * `pos` Integer * `menuItem` MenuItem `pos` 위치에 `menuItem`을 삽입합니다. -### Menu.items +### `Menu.items()` 메뉴가 가지고 있는 메뉴 아이템들의 배열입니다. ## OS X 어플리케이션 메뉴에 대해 알아 둬야 할 것들 OS X에선 Windows, Linux와 달리 완전히 다른 어플리케이션 메뉴 스타일을 가지고 있습니다. -어플리케이션을 네이티브처럼 작동할 수 있도록 하기 위해선 다음의 몇 가지 유의 사항을 숙지해야 합니다. +그래서 어플리케이션을 네이티브처럼 작동할 수 있도록 하기 위해 다음 몇 가지 유의 사항을 숙지해야 합니다. ### 기본 메뉴 OS X엔 `Services`나 `Windows`와 같은 많은 시스템 지정 기본 메뉴가 있습니다. -기본 메뉴를 만들려면 다음 중 하나를 메뉴의 라벨로 지정하기만 하면 됩니다. +기본 메뉴를 만들려면 반드시 다음 리스트 중 한 가지를 선택하여 메뉴의 `role`로 지정해야 합니다. 그러면 Electron이 자동으로 인식하여 해당 메뉴를 기본 메뉴로 만듭니다: -* `Window` -* `Help` -* `Services` +* `window` +* `help` +* `services` -### 기본 메뉴 아이템 동작 +### 메뉴 아이템 기본 동작 -OS X는 몇몇의 메뉴 아이템에 대해 `About xxx`, `Hide xxx`, `Hide Others`와 같은 기본 동작을 제공하고 있습니다. (`selector`라고 불립니다) -메뉴 아이템의 기본 동작을 지정하려면 메뉴 아이템의 `selector` 속성을 사용하면 됩니다. +OS X는 몇가지 메뉴 아이템에 대해 `About xxx`, `Hide xxx`, `Hide Others`와 같은 기본 동작을 제공하고 있습니다. +메뉴 아이템의 기본 동작을 지정하려면 반드시 메뉴 아이템의 `role` 속성을 지정해야 합니다. ### 메인 메뉴의 이름 OS X에선 지정한 어플리케이션 메뉴에 상관없이 메뉴의 첫번째 라벨은 언제나 어플리케이션의 이름이 됩니다. 어플리케이션 이름을 변경하려면 앱 번들내의 `Info.plist` 파일을 수정해야합니다. -자세한 내용은 [About Information Property List Files](https://developer.apple.com/library/ios/documentation/general/Reference/InfoPlistKeyReference/Articles/AboutInformationPropertyListFiles.html)을 참고하세요. +자세한 내용은 [About Information Property List Files][AboutInformationPropertyListFiles] 문서를 참고하세요. ## 메뉴 아이템 위치 @@ -257,7 +294,7 @@ OS X에선 지정한 어플리케이션 메뉴에 상관없이 메뉴의 첫번 * `endof` - 이 아이템을 id의 논리 그룹에 맞춰서 각 그룹의 항목 뒤에 삽입합니다. (그룹은 분리자 아이템에 의해 만들어집니다) 만약 참조된 아이템의 분리자 그룹이 존재하지 않을 경우 지정된 id로 새로운 분리자 그룹을 만든 후 해당 그룹의 뒤에 삽입됩니다. -위치를 지정한 아이템의 뒤에 위치가 지정되지 않은 아이템이 있을 경우 해당 아이템의 위치가 지정되기 전까지 이전에 위치가 지정된 아이템의 위치 지정을 따릅니다. +위치를 지정한 아이템의 뒤에 위치가 지정되지 않은 아이템이 있을 경우 각 아이템의 위치가 지정되기 전까지 모든 아이템이 위치가 지정된 아이템의 뒤에 삽입됩니다. 이에 따라 위치를 이동하고 싶은 특정 그룹의 아이템들이 있을 경우 해당 그룹의 맨 첫번째 메뉴 아이템의 위치만을 지정하면 됩니다. ### 예제 @@ -309,3 +346,5 @@ OS X에선 지정한 어플리케이션 메뉴에 상관없이 메뉴의 첫번 - 2 - 3 ``` + +[AboutInformationPropertyListFiles]: https://developer.apple.com/library/ios/documentation/general/Reference/InfoPlistKeyReference/Articles/AboutInformationPropertyListFiles.html diff --git a/docs-translations/ko/api/native-image.md b/docs-translations/ko/api/native-image.md index ba85266d2193..423cedb98300 100644 --- a/docs-translations/ko/api/native-image.md +++ b/docs-translations/ko/api/native-image.md @@ -1,15 +1,16 @@ # NativeImage -Electron은 파일 경로나 `NativeImage` 인스턴스를 전달하여 사용하는 이미지 API를 가지고 있습니다. `null`을 전달할 경우 빈 이미지가 사용됩니다. +Electron은 파일 경로 또는 `NativeImage` 인스턴스를 통해 이미지를 사용할 수 있는 API를 가지고 있습니다. +`null`을 전달할 경우 빈 이미지가 생성됩니다. -예를 들어 트레이 메뉴를 만들거나 윈도우의 아이콘을 설정할 때 다음과 같이 `문자열`인 파일 경로를 전달할 수 있습니다: +예를 들어 트레이 메뉴를 만들거나 윈도우의 아이콘을 설정할 때 다음과 같이 파일 경로를 전달하여 이미지를 사용할 수 있습니다: ```javascript var appIcon = new Tray('/Users/somebody/images/icon.png'); var window = new BrowserWindow({icon: '/Users/somebody/images/window.png'}); ``` -또는 클립보드로부터 이미지를 읽어올 수 있습니다: +이 예제는 클립보드로부터 가져온 `NativeImage`로 트레이 메뉴를 생성합니다: ```javascript var clipboard = require('clipboard'); @@ -19,7 +20,8 @@ var appIcon = new Tray(image); ## 지원하는 포맷 -현재 `PNG` 와 `JPEG` 포맷을 지원하고 있습니다. 손실 없는 이미지 압축과 투명도 지원을 위해 `PNG` 사용을 권장합니다. +현재 `PNG` 와 `JPEG` 이미지 포맷을 지원하고 있습니다. +손실 없는 이미지 압축과 투명도 지원을 위해 `PNG` 사용을 권장합니다. 그리고 Windows에서는 `ICO` 포맷도 사용할 수 있습니다. @@ -27,9 +29,9 @@ var appIcon = new Tray(image); 플랫폼이 high-DPI를 지원하는 경우 `@2x`와 같이 이미지의 파일명 뒤에 접미사를 추가하여 고해상도 이미지로 지정할 수 있습니다. -예를 들어 `icon.png` 라는 기본 해상도의 이미지를 기준으로 크기를 두 배로 늘린 이미지를 `icon@2x.png`와 같이 이름을 지정하면 고해상도 이미지로 처리됩니다. +예를 들어 `icon.png` 라는 기본 해상도의 이미지를 기준으로 크기를 두 배로 늘린 이미지를 `icon@2x.png` 처럼 지정하면 고해상도 이미지로 처리됩니다. -서로 다른 해상도(DPI)의 이미지를 지원하고 싶다면 다중 해상도의 이미지를 접미사를 붙여 한 폴더에 넣으면 됩니다. 이 이미지를 사용(로드)할 땐 접미사를 붙이지 않습니다: +서로 다른 해상도(DPI)의 이미지를 같이 지원하고 싶다면 다중 해상도의 이미지를 접미사를 붙여 한 폴더에 같이 넣으면 됩니다. 이 이미지를 사용(로드)할 땐 따로 접미사를 붙이지 않습니다: ```text images/ @@ -64,69 +66,79 @@ var appIcon = new Tray('/Users/somebody/images/icon.png'); 가장 일반적으로 템플릿 이미지는 밝고 어두운 테마 색상으로 변경할 수 있는 메뉴 바 아이콘 등에 사용되고 있습니다. -템플릿 이미지는 Mac 운영체제만 지원합니다. +**참고:** 템플릿 이미지는 OS X 운영체제만 지원합니다. 템플릿 이미지를 지정하려면 다음 예제와 같이 파일명에 `Template` 문자열을 추가해야 합니다: * `xxxTemplate.png` * `xxxTemplate@2x.png` -## nativeImage.createEmpty() +## Methods + +`NativeImage` 클래스는 다음과 같은 메서드를 가지고 있습니다: + +### `NativeImage.createEmpty()` 빈 `NativeImage` 인스턴스를 만듭니다. -## nativeImage.createFromPath(path) +### `NativeImage.createFromPath(path)` * `path` String `path`로부터 이미지를 로드하여 새로운 `NativeImage` 인스턴스를 만듭니다. -## nativeImage.createFromBuffer(buffer[, scaleFactor]) +### `NativeImage.createFromBuffer(buffer[, scaleFactor])` * `buffer` [Buffer][buffer] -* `scaleFactor` Double +* `scaleFactor` Double (optional) `buffer`로부터 이미지를 로드하여 새로운 `NativeImage` 인스턴스를 만듭니다. `scaleFactor`는 1.0이 기본입니다. -## nativeImage.createFromDataUrl(dataUrl) +### `NativeImage.createFromDataUrl(dataUrl)` * `dataUrl` String `dataUrl`로부터 이미지를 로드하여 새로운 `NativeImage` 인스턴스를 만듭니다. -## Class: NativeImage +## Instance Methods -이미지를 표현한 클래스입니다. +`nativeImage` 인스턴스 객체에서 사용할 수 있는 메서드 입니다: -### NativeImage.toPng() +```javascript +var NativeImage = require('native-image'); + +var image = NativeImage.createFromPath('/Users/somebody/images/icon.png'); +``` + +### `image.toPng()` `PNG` 이미지를 인코딩한 데이터를 [Buffer][buffer]로 반환합니다. -### NativeImage.toJpeg(quality) +### `image.toJpeg(quality)` -* `quality` Integer (0 - 100 사이의 값) +* `quality` Integer 0 - 100 사이의 값 (**required**) `JPEG` 이미지를 인코딩한 데이터를 [Buffer][buffer]로 반환합니다. -### NativeImage.toDataUrl() +### `image.toDataUrl()` -이미지의 data URL을 반환합니다. +이미지를 data URL로 반환합니다. -### NativeImage.isEmpty() +### `image.isEmpty()` -이미지가 비었는지를 체크합니다. +이미지가 비었는지 확인합니다. -### NativeImage.getSize() +### `image.getSize()` 이미지의 사이즈를 반환합니다. -### NativeImage.setTemplateImage(option) +### `image.setTemplateImage(option)` * `option` Boolean 해당 이미지를 템플릿 이미지로 설정합니다. -### NativeImage.isTemplateImage() +### `image.isTemplateImage()` 이미지가 템플릿 이미지인지 확인합니다. diff --git a/docs-translations/ko/api/power-monitor.md b/docs-translations/ko/api/power-monitor.md index baa132f3736d..990bf54e48c0 100644 --- a/docs-translations/ko/api/power-monitor.md +++ b/docs-translations/ko/api/power-monitor.md @@ -16,18 +16,22 @@ app.on('ready', function() { }); ``` -## Event: suspend +## Events + +`power-monitor` 모듈은 다음과 같은 이벤트를 가지고 있습니다: + +## Event: `suspend` 시스템이 절전모드로 진입할 때 발생하는 이벤트입니다. -## Event: resume +## Event: `resume` 시스템의 절전모드가 해제될 때 발생하는 이벤트입니다. -## Event: on-ac +## Event: `on-ac` 시스템이 AC 어뎁터 충전기를 사용하기 시작할 때 발생하는 이벤트입니다. -## Event: on-battery +## Event: `on-battery` 시스템이 배터리를 사용하기 시작할 때 발생하는 이벤트입니다. diff --git a/docs-translations/ko/api/power-save-blocker.md b/docs-translations/ko/api/power-save-blocker.md index 03bb3bf2a245..0521a82b0e70 100644 --- a/docs-translations/ko/api/power-save-blocker.md +++ b/docs-translations/ko/api/power-save-blocker.md @@ -1,6 +1,6 @@ -# power-save-blocker +# powerSaveBlocker -`power-save-blocker` 모듈은 시스템이 저전력 모드(슬립)로 진입하는 것을 막고 앱 및 화면이 항상 활성화되어 있는 상태를 만들 수 있도록 해줍니다. +`power-save-blocker` 모듈은 시스템이 저전력(슬립) 모드로 진입하는 것을 막고 앱 시스템과 화면이 항상 활성화 상태를 유지할 수 있도록 하는 몇가지 유틸리티를 제공하는 모듈입니다. 예제: @@ -13,31 +13,34 @@ console.log(powerSaveBlocker.isStarted(id)); powerSaveBlocker.stop(id); ``` -## powerSaveBlocker.start(type) +## Methods + +`powerSaveBlocker` 모듈은 다음과 같은 메서드를 가지고 있습니다: + +### `powerSaveBlocker.start(type)` * `type` String - Power save blocker 종류 * `prevent-app-suspension` - 저전력 모드 등으로 인한 어플리케이션 작동 중단을 방지합니다. - 시스템을 항시 활성화 상태로 만듭니다, 하지만 화면은 자동으로 꺼질 수 있습니다. 사용 예시: 파일 다운로드, 음악 재생 등. + 시스템을 항시 활성화 상태로 만듭니다. 하지만 화면은 자동으로 꺼질 수 있습니다. 사용 예시: 파일 다운로드, 음악 재생 등. * `prevent-display-sleep`- 슬립 모드 등으로 인한 어플리케이션의 작동 중단을 방지합니다. 시스템을 항시 활성화 상태로 만들고 슬립 모드(화면 꺼짐)를 방지합니다. 사용 예시: 비디오 재생 등. -Power save blocker를 시작하고 시스템이 저전력 모드(슬립)로 진입하는 것을 막습니다. 정수로 된 식별 ID를 반환합니다. +시스템이 저전력 모드(슬립)로 진입하는 것을 막기 시작합니다. 정수로 된 식별 ID를 반환합니다. -**참고:** -`prevent-display-sleep` 모드는 `prevent-app-suspension` 보다 우선순위가 높습니다. -가장 높은 우선순위의 모드만 작동합니다. 다시 말해 `prevent-display-sleep` 모드는 언제나 `prevent-app-suspension` 모드의 효과를 덮어씌웁니다. +**참고:** `prevent-display-sleep` 모드는 `prevent-app-suspension` 보다 우선 순위가 높습니다. +두 모드 중 가장 높은 우선 순위의 모드만 작동합니다. 다시 말해 `prevent-display-sleep` 모드는 언제나 `prevent-app-suspension` 모드의 효과를 덮어씌웁니다. 예를 들어 A-요청이 `prevent-app-suspension` 모드를 사용하고 B-요청이 `prevent-display-sleep`를 사용하는 API 호출이 있었다 치면 `prevent-display-sleep` 모드를 사용하는 B의 작동이 중단(stop)되기 전까지 작동하다 B가 중단되면 `prevent-app-suspension` 모드를 사용하는 A가 작동하기 시작합니다. -## powerSaveBlocker.stop(id) +### `powerSaveBlocker.stop(id)` * `id` Integer - `powerSaveBlocker.start`로 부터 반환되는 power save blocker 식별 ID. 설정한 power save blocker를 중지합니다. -## powerSaveBlocker.isStarted(id) +### `powerSaveBlocker.isStarted(id)` * `id` Integer - `powerSaveBlocker.start`로 부터 반환되는 power save blocker 식별 ID. -해당하는 id의 `powerSaveBlocker`가 실행중인지 확인합니다. +지정한 id의 `powerSaveBlocker`가 실행 중인지 확인합니다. diff --git a/docs-translations/ko/api/process.md b/docs-translations/ko/api/process.md index 09b57d1b869b..f557f8cc6be5 100644 --- a/docs-translations/ko/api/process.md +++ b/docs-translations/ko/api/process.md @@ -1,4 +1,4 @@ -# 프로세스 객체 +# process Electron의 `process` 객체는 기존의 node와는 달리 약간의 차이점이 있습니다: @@ -7,11 +7,15 @@ Electron의 `process` 객체는 기존의 node와는 달리 약간의 차이점 * `process.versions['chrome']` String - Chromium의 버전. * `process.resourcesPath` String - JavaScript 소스코드의 경로. -## process.hang +## Methods + +`process` 객체는 다음과 같은 메서드를 가지고 있습니다: + +### `process.hang()` 현재 프로세스의 주 스레드를 중단시킵니다. -## process.setFdLimit(maxDescriptors) _OS X_ _Linux_ +### `process.setFdLimit(maxDescriptors)` _OS X_ _Linux_ * `maxDescriptors` Integer diff --git a/docs-translations/ko/api/shell.md b/docs-translations/ko/api/shell.md index d9ceea106a54..a84436f78071 100644 --- a/docs-translations/ko/api/shell.md +++ b/docs-translations/ko/api/shell.md @@ -1,34 +1,39 @@ # shell -`shell` 모듈은 데스크톱 환경 통합에 관련하여 제공되는 모듈입니다. +`shell` 모듈은 데스크톱 환경 통합에 관련한 유틸리티를 제공하는 모듈입니다. -다음 예제는 기본 브라우저로 설정된 URL을 엽니다: +다음 예제는 설정된 URL을 유저의 기본 브라우저로 엽니다: ```javascript var shell = require('shell'); shell.openExternal('https://github.com'); ``` -## shell.showItemInFolder(fullPath) +## Methods + +`shell` 모듈은 다음과 같은 메서드를 가지고 있습니다: + +### `shell.showItemInFolder(fullPath)` * `fullPath` String 지정한 파일을 탐색기에서 보여줍니다. 가능한 경우 탐색기 내에서 파일을 선택합니다. -## shell.openItem(fullPath) +### `shell.openItem(fullPath)` * `fullPath` String 지정한 파일을 데스크톱 기본 프로그램으로 엽니다. -## shell.openExternal(url) +### `shell.openExternal(url)` * `url` String -제공된 외부 프로토콜 URL을 기반으로 데스크톱의 기본 프로그램으로 엽니다. (예를 들어 mailto: URL은 해당 URL을 기본 메일 에이전트로 엽니다.) +제공된 외부 프로토콜 URL을 기반으로 데스크톱의 기본 프로그램으로 엽니다. (예를 들어 mailto: URL은 유저의 기본 이메일 에이전트로 URL을 엽니다.) + 역주: 폴더는 'file:\\\\C:\\'와 같이 지정하여 열 수 있습니다. (`\\`로 경로를 표현한 이유는 Escape 문자열을 참고하세요.) -## shell.moveItemToTrash(fullPath) +### `shell.moveItemToTrash(fullPath)` * `fullPath` String @@ -36,6 +41,6 @@ Move the given file to trash and returns boolean status for the operation. 지정한 파일을 휴지통으로 이동합니다. 작업의 성공여부를 boolean 형으로 리턴합니다. -## shell.beep() +### `shell.beep()` 비프음을 재생합니다. diff --git a/docs-translations/ko/api/synopsis.md b/docs-translations/ko/api/synopsis.md index 69ee4af354c7..3b1633da6d5d 100644 --- a/docs-translations/ko/api/synopsis.md +++ b/docs-translations/ko/api/synopsis.md @@ -1,14 +1,15 @@ # 개요 -Electron은 모든 [node.js's built-in 모듈](http://nodejs.org/api/)과 third-party node 모듈을 완벽하게 지원합니다. ([네이티브 모듈](../tutorial/using-native-node-modules.md)을 포함해서) +Electron은 모든 [Node.js의 built-in 모듈](http://nodejs.org/api/)과 third-party node 모듈을 완벽하게 지원합니다. ([네이티브 모듈](../tutorial/using-native-node-modules.md) 포함) Electron은 네이티브 데스크톱 어플리케이션을 개발 할 수 있도록 추가적인 built-in 모듈을 제공합니다. -몇몇 모듈은 메인 프로세스에서만 사용할 수 있고 어떤 모듈은 랜더러 프로세스에서만 사용할 수 있습니다. 또한 두 프로세스 모두 사용할 수 있는 모듈도 있습니다. -기본적인 규칙은 다음과 같습니다: GUI와 저 수준 시스템에 관련된 모듈은 오직 메인 프로세스에서만 사용할 수 있습니다. -[메인 프로세스 vs. 랜더러 프로세스](../tutorial/quick-start.md#메인 프로세스) 컨셉에 익숙해야 이 모듈들을 사용하기 쉬우므로 해당 문서를 정독하는 것을 권장합니다. +몇몇 모듈은 메인 프로세스에서만 사용할 수 있고 어떤 모듈은 랜더러 프로세스(웹 페이지)에서만 사용할 수 있습니다. +또한 두 프로세스 모두 사용할 수 있는 모듈도 있습니다. +기본적인 규칙으로 [GUI](https://en.wikipedia.org/wiki/Graphical_user_interface)와 저 수준 시스템에 관련된 모듈들은 오직 메인 프로세스에서만 사용할 수 있습니다. +[메인 프로세스 vs. 랜더러 프로세스](../tutorial/quick-start.md#메인 프로세스) 컨셉에 익숙해야 이 모듈들을 사용하기 쉬우므로 관련 문서를 읽어 보는 것을 권장합니다. -메인 프로세스 스크립트는 일반 `node.js` 스크립트와 같습니다: +메인 프로세스 스크립트는 일반 Node.js 스크립트와 비슷합니다: ```javascript var app = require('app'); @@ -22,7 +23,7 @@ app.on('ready', function() { }); ``` -웹 페이지 역시 예외적인 node module을 사용할 수 있다는 점을 제외하면 일반 웹 페이지와 다를게 없습니다: +랜더러 프로세스도 예외적인 node module들을 사용할 수 있다는 점을 제외하면 일반 웹 페이지와 크게 다를게 없습니다: ```html diff --git a/docs-translations/ko/api/tray.md b/docs-translations/ko/api/tray.md index 8ee015f98c37..beccf6d8b34a 100644 --- a/docs-translations/ko/api/tray.md +++ b/docs-translations/ko/api/tray.md @@ -1,6 +1,6 @@ # Tray -`Tray`는 OS의 알림영역에 아이콘을 표시합니다. 보통 컨텍스트 메뉴(context menu)를 같이 사용합니다. +`Tray`는 OS의 알림 영역에 아이콘을 표시합니다. 보통 컨텍스트 메뉴(context menu)를 같이 사용합니다. ```javascript var app = require('app'); @@ -29,19 +29,25 @@ __플랫폼별 한계:__ * 앱 알림 표시기는 컨텍스트 메뉴를 가지고 있을 때만 보입니다. * Linux에서 앱 알림 표시기가 사용될 경우, `clicked` 이벤트는 무시됩니다. -이러한 이유로 만약 Tray API가 모든 플랫폼에서 똑같이 작동하게 하고 싶다면, 설계시 `clicked` 이벤트에 의존하지 말아야합니다. -그리고 언제나 컨텍스트 메뉴를 포함해서 사용해야 합니다. +이러한 이유로 Tray API가 모든 플랫폼에서 똑같이 작동하게 하고 싶다면 `clicked` 이벤트에 의존해선 안됩니다. +그리고 언제나 컨텍스트 메뉴를 포함해야 합니다. ## Class: Tray `Tray`는 [EventEmitter][event-emitter]를 상속 받았습니다. -### new Tray(image) +### `new Tray(image)` * `image` [NativeImage](native-image.md) 전달된 `image`를 이용하여 트레이 아이콘을 만듭니다. +## Events + +`Tray` 모듈은 다음과 같은 이벤트를 가지고 있습니다: + +**참고:** 몇가지 이벤트는 특정한 플랫폼에서만 작동합니다. + ### Event: 'clicked' * `event` Event @@ -57,9 +63,9 @@ __플랫폼별 한계:__ 트레이 아이콘이 클릭될 때 발생하는 이벤트입니다. -__주의:__ `bounds`는 OS X 와 Windows 7 이후 버전에서만 작동합니다. +__주의:__ `bounds`는 OS X 와 Windows에서만 작동합니다. -### Event: 'right-clicked' +### Event: 'right-clicked' _OS X_ _Windows_ * `event` Event * `altKey` Boolean @@ -74,9 +80,7 @@ __주의:__ `bounds`는 OS X 와 Windows 7 이후 버전에서만 작동합니 트레이 아이콘을 오른쪽 클릭될 때 호출 됩니다. -__주의:__ 이 기능은 OS X 와 Windows 운영체제에서만 작동합니다. - -### Event: 'double-clicked' +### Event: 'double-clicked' _OS X_ _Windows_ * `event` Event * `altKey` Boolean @@ -91,76 +95,66 @@ __주의:__ 이 기능은 OS X 와 Windows 운영체제에서만 작동합니다 트레이 아이콘이 더블 클릭될 때 발생하는 이벤트입니다. -__주의:__ 이 기능은 OS X 와 Windows 운영체제에서만 작동합니다. - -### Event: 'balloon-show' +### Event: 'balloon-show' _Windows_ 알림풍선이 보여질 때 발생하는 이벤트입니다. -__주의:__ 이 기능은 Windows에서만 작동합니다. - -### Event: 'balloon-clicked' +### Event: 'balloon-clicked' _Windows_ 알림풍선이 클릭될 때 발생하는 이벤트입니다. -__주의:__ 이 기능은 Windows에서만 작동합니다. - -### Event: 'balloon-closed' +### Event: 'balloon-closed' _Windows_ 알림풍선이 시간이 지나 사라지거나 유저가 클릭하여 닫을 때 발생하는 이벤트입니다. -__주의:__ 이 기능은 Windows에서만 작동합니다. - -### Event: 'drop-files' +### Event: 'drop-files' _OS X_ * `event` * `files` Array - 드롭된 파일의 경로 트레이 아이콘에 파일이 드롭되면 발생하는 이벤트입니다. -__주의:__ 이 기능은 OS X에서만 작동합니다. +## Methods -### Tray.destroy() +`Tray` 모듈은 다음과 같은 메서드를 가지고 있습니다: + +**참고:** 몇가지 메서드는 특정한 플랫폼에서만 작동합니다. + +### `Tray.destroy()` 트레이 아이콘을 즉시 삭제시킵니다. -### Tray.setImage(image) +### `Tray.setImage(image)` * `image` [NativeImage](native-image.md) `image`를 사용하여 트레이 아이콘의 이미지를 설정합니다. -### Tray.setPressedImage(image) +### `Tray.setPressedImage(image)` _OS X_ * `image` [NativeImage](native-image.md) `image`를 사용하여 트레이 아이콘이 눌렸을 때의 이미지를 설정합니다. -__주의:__ 이 기능은 OS X에서만 작동합니다. - -### Tray.setToolTip(toolTip) +### `Tray.setToolTip(toolTip)` * `toolTip` String 트레이 아이콘의 툴팁 텍스트를 설정합니다. -### Tray.setTitle(title) +### `Tray.setTitle(title)` _OS X_ * `title` String 상태바에서 트레이 아이콘 옆에 표시되는 제목 텍스트를 설정합니다. -__주의:__ 이 기능은 OS X에서만 작동합니다. - -### Tray.setHighlightMode(highlight) +### `Tray.setHighlightMode(highlight)` _OS X_ * `highlight` Boolean 트레이 아이콘을 클릭했을 때 하이라이트 될지 설정합니다. -__주의:__ 이 기능은 OS X에서만 작동합니다. - -### Tray.displayBalloon(options) +### `Tray.displayBalloon(options)` _Windows_ * `options` Object * `icon` [NativeImage](native-image.md) @@ -169,19 +163,15 @@ __주의:__ 이 기능은 OS X에서만 작동합니다. 트레이에 알림풍선을 생성합니다. -__주의:__ 이 기능은 Windows에서만 작동합니다. +### `Tray.popContextMenu([position])` _OS X_ _Windows_ -### Tray.popContextMenu([position]) - -* `position` Object - 팝 메뉴 위치 +* `position` Object (optional) - 팝업 메뉴 위치 * `x` Integer * `y` Integer `position`은 Windows에서만 사용할 수 있으며 기본값은 (0, 0)입니다. -__주의:__ 이 기능은 Windows 와 OS X에서만 작동합니다. - -### Tray.setContextMenu(menu) +### `Tray.setContextMenu(menu)` * `menu` Menu diff --git a/docs-translations/ko/development/build-instructions-linux.md b/docs-translations/ko/development/build-instructions-linux.md index adcdab8357ea..e02c1341f993 100644 --- a/docs-translations/ko/development/build-instructions-linux.md +++ b/docs-translations/ko/development/build-instructions-linux.md @@ -9,7 +9,7 @@ * Clang 3.4 또는 최신 버전 * GTK+ 와 libnotify의 개발용 헤더 -Ubuntu를 사용하고 있다면 다음 커맨드로 설치하면 합니다: +Ubuntu를 사용하고 있다면 다음과 같이 라이브러리를 설치해야 합니다: ```bash $ sudo apt-get install build-essential clang libdbus-1-dev libgtk2.0-dev \ @@ -18,7 +18,15 @@ $ sudo apt-get install build-essential clang libdbus-1-dev libgtk2.0-dev \ libxss1 libnss3-dev gcc-multilib g++-multilib ``` -다른 배포판의 경우 yum과 같은 패키지 매니저를 통해 패키지를 설치 할 수 있습니다. 패키지의 이름은 대부분 비슷할 것입니다. +Fedora를 사용하고 있다면 다음과 같이 라이브러리를 설치해야 합니다: + +```bash +$ sudo yum install clang dbus-devel gtk2-devel libnotify-devel libgnome-keyring-devel \ + xorg-x11-server-utils libcap-devel cups-devel libXtst-devel \ + alsa-lib-devel libXrandr-devel GConf2-devel nss-devel +``` + +다른 배포판의 경우 pacman 같은 패키지 매니저를 통해 패키지를 설치 할 수 있습니다. 패키지의 이름은 대부분 위 예시와 비슷할 것입니다. 또는 소스코드를 내려받아 직접 빌드하는 방법도 있습니다. ## 가상머신을 사용하여 빌드 하는 경우 diff --git a/docs-translations/ko/tutorial/desktop-environment-integration.md b/docs-translations/ko/tutorial/desktop-environment-integration.md index 9d1b5ffadcc4..50b142f0bda1 100644 --- a/docs-translations/ko/tutorial/desktop-environment-integration.md +++ b/docs-translations/ko/tutorial/desktop-environment-integration.md @@ -24,7 +24,7 @@ var app = require('app'); app.addRecentDocument('/Users/USERNAME/Desktop/work.type'); ``` -그리고 [app.clearRecentDocuments](clearrecentdocuments) API로 최근 문서 리스트를 비울 수 있습니다: +그리고 [app.clearRecentDocuments][clearrecentdocuments] API로 최근 문서 리스트를 비울 수 있습니다: ```javascript app.clearRecentDocuments(); diff --git a/docs-translations/ko/tutorial/using-selenium-and-webdriver.md b/docs-translations/ko/tutorial/using-selenium-and-webdriver.md index b6178184d661..a29e8e2214ef 100644 --- a/docs-translations/ko/tutorial/using-selenium-and-webdriver.md +++ b/docs-translations/ko/tutorial/using-selenium-and-webdriver.md @@ -7,12 +7,8 @@ > ChromeDriver는 Chromium의 WebDriver wire 프로토콜 스텐드얼론 서버 구현입니다. > Chromium 과 WebDriver 팀 멤버에 의해 개발되었습니다. -Electron의 [releases](https://github.com/atom/electron/releases) 페이지에서 `chromedriver` 릴리즈 압축파일을 찾을 수 있습니다. -`chromedriver`의 Electron 배포판과 upstream과의 차이는 없습니다. -`chromedriver`와 Electron을 함께 사용하려면 몇가지 설정이 필요합니다. - -또한 releases에는 `chromedriver`를 포함하여 주 버전만 업데이트 됩니다. (예시: `vX.X.0` releases) -왜냐하면 `chromedriver`는 Electron 자체에서 자주 업데이트하지 않기 때문입니다. +Electron과 `chromedriver`를 같이 사옹하려면 드라이버에서 Electron을 찾을 수 있도록 해야 하고 +Electron은 Chrome 브라우저와 비슷하다는 점을 기억해야 합니다. ## WebDriverJs 설정하기 From 2f41641139cf0c1d4666423cf75ec16bb66db83f Mon Sep 17 00:00:00 2001 From: Timothy Cyrus Date: Wed, 2 Sep 2015 15:44:51 -0400 Subject: [PATCH 1088/1293] Update browser-window.md Fix App Command Web Link --- docs/api/browser-window.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index dada6083ea61..e9d2c7f6feb8 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -236,7 +236,7 @@ Emitted when devtools is focused / opened. ### Event: 'app-command' _Windows_ -Emitted when an [App Command](https://msdn.microsoft.com/en-us/library/windows/desktop/ms646275(v=vs.85).aspx +Emitted when an [App Command](https://msdn.microsoft.com/en-us/library/windows/desktop/ms646275(v=vs.85).aspx) is invoked. These are typically related to keyboard media keys or browser commands, as well as the "Back" button built into some mice on Windows. From b3eb6dc32b535cb2cce3168e765cd6b1a2c2feb5 Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Thu, 3 Sep 2015 08:28:12 +0900 Subject: [PATCH 1089/1293] Update as upstream --- docs-translations/ko/api/protocol.md | 65 +++++++++++++++------------- docs-translations/ko/api/remote.md | 34 +++++++++------ docs-translations/ko/api/screen.md | 36 ++++++++++----- 3 files changed, 80 insertions(+), 55 deletions(-) diff --git a/docs-translations/ko/api/protocol.md b/docs-translations/ko/api/protocol.md index 0a1c04b6dcd6..d79963239585 100644 --- a/docs-translations/ko/api/protocol.md +++ b/docs-translations/ko/api/protocol.md @@ -2,7 +2,7 @@ `protocol` 모듈은 이미 있는 프로토콜의 동작을 가로채거나 새로운 프로토콜을 만들 수 있는 기능을 제공합니다. -다음 예제는 `file://` 프로토콜과 같은 일을 하는 커스텀 프로토콜을 설정합니다: +다음 예제는 `file://` 프로토콜과 비슷한 일을 하는 커스텀 프로토콜을 설정합니다: ```javascript var app = require('app'); @@ -20,24 +20,28 @@ app.on('ready', function() { }); ``` -**참고:** 이 모듈은 `ready` 이벤트가 호출된 이후에만 사용할 수 있습니다. +**참고:** 이 모듈은 `app` 모듈의 `ready` 이벤트가 발생한 이후에만 사용할 수 있습니다. -## protocol.registerStandardSchemes(schemes) +## Methods + +`protocol` 모듈은 다음과 같은 메서드를 가지고 있습니다: + +### `protocol.registerStandardSchemes(schemes)` * `schemes` Array - 표준 스킴으로 등록할 커스텀 스킴 리스트 -표준 스킴의 형식은 RFC 3986 [일반 URI 구문](https://tools.ietf.org/html/rfc3986#section-3) 표준을 따릅니다. +표준 `scheme`의 형식은 RFC 3986 [일반 URI 구문](https://tools.ietf.org/html/rfc3986#section-3) 표준을 따릅니다. 이 형식은 `file:`과 `filesystem:`을 포함합니다. -## protocol.registerFileProtocol(scheme, handler[, completion]) +### `protocol.registerFileProtocol(scheme, handler[, completion])` * `scheme` String * `handler` Function -* `completion` Function +* `completion` Function (optional) `scheme`에 파일을 응답으로 보내는 프로토콜을 등록합니다. -`handler`는 `request`가 `scheme`와 함께 생성될 때 `handler(request, callback)` 형식으로 호출됩니다. -`completion`은 `scheme`가 성공적으로 등록되었을 때 `completion(null)` 형식으로 호출되고 +`handler`는 `scheme`와 함께 `request`가 생성될 때 `handler(request, callback)` 형식으로 호출됩니다. +`completion` 콜백은 `scheme`가 성공적으로 등록되었을 때 `completion(null)` 형식으로 호출되고 등록에 실패했을 땐 `completion(error)` 형식으로 에러 내용을 담아 호출됩니다. `request`를 처리할 때 반드시 파일 경로 또는 `path` 속성을 포함하는 객체를 인자에 포함하여 `callback`을 호출해야 합니다. @@ -45,16 +49,16 @@ app.on('ready', function() { 만약 `callback`이 아무 인자도 없이 호출되거나 숫자나 `error` 프로퍼티를 가진 객체가 인자로 전달될 경우 `request`는 지정한 `error` 코드(숫자)를 출력합니다. -사용할 수 있는 에러 코드는 다음 링크에서 확인할 수 있습니다: https://code.google.com/p/chromium/codesearch#chromium/src/net/base/net_error_list.h +사용할 수 있는 에러 코드는 [네트워크 에러 목록](https://code.google.com/p/chromium/codesearch#chromium/src/net/base/net_error_list.h)에서 확인할 수 있습니다. -기본적으로 스킴은 `http:`와 같이 처리됩니다. `file:`과 같이 "일반적인 URI 문법"과는 다르게 인식되는 프로토콜은 +기본적으로 `scheme`은 `http:`와 같이 처리됩니다. `file:`과 같이 "일반적인 URI 문법"과는 다르게 인식되는 프로토콜은 `protocol.registerStandardSchemes`을 사용하여 표준 스킴으로 처리되도록 할 수 있습니다. -## protocol.registerBufferProtocol(scheme, handler[, completion]) +### `protocol.registerBufferProtocol(scheme, handler[, completion])` * `scheme` String * `handler` Function -* `completion` Function +* `completion` Function (optional) `scheme`에 `Buffer`를 응답으로 보내는 프로토콜을 등록합니다. 반드시 `Buffer` 또는 `data`, `mimeType`, `chart` 속성을 포함한 객체 중 하나를 인자에 포함하여 `callback`을 호출해야 합니다. @@ -70,76 +74,75 @@ protocol.registerBufferProtocol('atom', function(request, callback) { }); ``` -## protocol.registerStringProtocol(scheme, handler[, completion]) +### `protocol.registerStringProtocol(scheme, handler[, completion])` * `scheme` String * `handler` Function -* `completion` Function +* `completion` Function (optional) -`scheme`에 `문자열`를 응답으로 보내는 프로토콜을 등록합니다. +`scheme`에 `문자열`을 응답으로 보내는 프로토콜을 등록합니다. 반드시 `문자열` 또는 `data`, `mimeType`, `chart` 속성을 포함한 객체 중 하나를 인자에 포함하여 `callback`을 호출해야 합니다. -## protocol.registerHttpProtocol(scheme, handler[, completion]) +### `protocol.registerHttpProtocol(scheme, handler[, completion])` * `scheme` String * `handler` Function -* `completion` Function - +* `completion` Function (optional) `scheme`에 HTTP 요청을 응답으로 보내는 프로토콜을 등록합니다. 반드시 `url`, `method`, `referer`, `session` 속성을 포함하는 객체를 인자에 포함하여 `callback`을 호출해야 합니다. 기본적으로 HTTP 요청은 현재 세션을 재사용합니다. 만약 서로 다른 세션에 요청을 보내고 싶으면 `session`을 `null`로 지정해야 합니다. -## protocol.unregisterProtocol(scheme[, completion]) +### `protocol.unregisterProtocol(scheme[, completion])` * `scheme` String -* `completion` Function +* `completion` Function (optional) `scheme`의 커스텀 프로토콜 등록을 해제합니다. -## protocol.isProtocolHandled(scheme, callback) +### `protocol.isProtocolHandled(scheme, callback)` * `scheme` String * `callback` Function `scheme`에 동작(handler)이 등록되어 있는지 여부를 확인합니다. `callback`으로 결과(boolean)가 반환됩니다. -## protocol.interceptFileProtocol(scheme, handler[, completion]) +### `protocol.interceptFileProtocol(scheme, handler[, completion])` * `scheme` String * `handler` Function -* `completion` Function +* `completion` Function (optional) `scheme` 프로토콜을 가로채고 `handler`를 파일 전송에 대한 새로운 동작으로 사용합니다. -## protocol.interceptStringProtocol(scheme, handler[, completion]) +### `protocol.interceptStringProtocol(scheme, handler[, completion])` * `scheme` String * `handler` Function -* `completion` Function +* `completion` Function (optional) `scheme` 프로토콜을 가로채고 `handler`를 문자열 전송에 대한 새로운 동작으로 사용합니다. -## protocol.interceptBufferProtocol(scheme, handler[, completion]) +### `protocol.interceptBufferProtocol(scheme, handler[, completion])` * `scheme` String * `handler` Function -* `completion` Function +* `completion` Function (optional) `scheme` 프로토콜을 가로채고 `handler`를 `Buffer` 전송에 대한 새로운 동작으로 사용합니다. -## protocol.interceptHttpProtocol(scheme, handler[, completion]) +### `protocol.interceptHttpProtocol(scheme, handler[, completion])` * `scheme` String * `handler` Function -* `completion` Function +* `completion` Function (optional) `scheme` 프로토콜을 가로채고 `handler`를 HTTP 프로토콜의 요청에 대한 새로운 동작으로 사용합니다. -## protocol.uninterceptProtocol(scheme[, completion]) +### `protocol.uninterceptProtocol(scheme[, completion])` * `scheme` String -* `completion` Function +* `completion` Function (optional) 가로챈 `scheme`를 삭제하고 기본 핸들러로 복구합니다. diff --git a/docs-translations/ko/api/remote.md b/docs-translations/ko/api/remote.md index d5ee74cfb1e8..34492a30556f 100644 --- a/docs-translations/ko/api/remote.md +++ b/docs-translations/ko/api/remote.md @@ -1,10 +1,10 @@ # remote -`remote` 모듈은 메인 프로세스와 랜더러 프로세스 사이에 inter-process 통신을 간단하게 추상화 한 모듈입니다. +`remote` 모듈은 메인 프로세스와 랜더러 프로세스(웹 페이지) 사이의 inter-process (IPC) 통신을 간단하게 추상화 한 모듈입니다. Electron의 랜더러 프로세스에선 GUI와 관련 없는 모듈만 사용할 수 있습니다. -기본적으로 랜더러 프로세스에서 메인 프로세스의 API를 사용하려면 inter-process 통신을 사용해야 합니다. -하지만 `remote` 모듈을 사용하면 따로 inter-process 통신을 사용하지 않고 직접 명시적으로 사용할 수 있습니다. +기본적으로 랜더러 프로세스에서 메인 프로세스의 API를 사용하려면 메인 프로세스와 inter-process 통신을 해야 합니다. +하지만 `remote` 모듈을 사용하면 따로 inter-process 통신을 하지 않고 직접 명시적으로 모듈을 사용할 수 있습니다. Java의 [RMI](http://en.wikipedia.org/wiki/Java_remote_method_invocation)와 개념이 비슷합니다. 다음 예제는 랜더러 프로세스에서 브라우저 창을 만드는 예제입니다: @@ -12,11 +12,12 @@ Java의 [RMI](http://en.wikipedia.org/wiki/Java_remote_method_invocation)와 개 ```javascript var remote = require('remote'); var BrowserWindow = remote.require('browser-window'); + var win = new BrowserWindow({ width: 800, height: 600 }); win.loadUrl('https://github.com'); ``` -**참고:** 반대로 하려면(메인 프로세스에서 랜더러 프로세스에 접근) [webContents.executeJavascript](browser-window.md#webcontents-executejavascript-code) API를 사용하면 됩니다. +**참고:** 반대로 메인 프로세스에서 랜더러 프로세스에 접근 하려면 [webContents.executeJavascript](browser-window.md#webcontents-executejavascript-code) 메서드를 사용하면 됩니다. ## Remote 객체 @@ -26,7 +27,7 @@ Remote 모듈의 메서드를 호출하거나, 객체에 접근하거나, 생성 위의 예제에서 사용한 두 `BrowserWindow`와 `win`은 remote 객체입니다. 그리고 `new BrowserWindow`이 생성하는 `BrowserWindow` 객체는 랜더러 프로세스에서 생성되지 않습니다. 대신에 이 `BrowserWindow` 객체는 메인 프로세스에서 생성되며 랜더러 프로세스에 `win` 객체와 같이 이에 대응하는 remote 객체를 반환합니다. -## Remote 객체의 일생 +## Remote 객체의 생명 주기 Electron은 랜더러 프로세스의 remote 객체가 살아있는 한(다시 말해서 GC(garbage collection)가 일어나지 않습니다) 대응하는 메인 프로세스의 객체는 릴리즈되지 않습니다. Remote 객체가 GC 되려면 대응하는 메인 프로세스 내부 객체의 참조가 해제되어야만 합니다. @@ -54,10 +55,12 @@ exports.withRendererCallback = function(mapper) { exports.withLocalCallback = function() { return exports.mapNumbers(function(x) { - return x + 1; + return x + 1; }); } +``` +```javascript // 랜더러 프로세스 var mapNumbers = require("remote").require("mapNumbers"); @@ -80,6 +83,7 @@ console.log(withRendererCb, withLocalCb) // [true, true, true], [2, 3, 4] ```javascript var remote = require('remote'); + remote.getCurrentWindow().on('close', function() { // blabla... }); @@ -94,26 +98,30 @@ remote.getCurrentWindow().on('close', function() { 이러한 문제를 피하려면 랜더러 프로세스에서 메인 프로세스로 넘긴 함수의 참조를 사용 후 확실하게 제거해야 합니다. 작업 후 이벤트 콜백을 포함하여 책임 있게 함수의 참조를 제거하거나 메인 프로세스에서 랜더러 프로세스가 종료될 때 내부적으로 함수 참조를 제거하도록 설계해야 합니다. -## remote.require(module) +## Methods + +`remote` 모듈은 다음과 같은 메서드를 가지고 있습니다: + +### `remote.require(module)` * `module` String 메인 프로세스의 `require(module)` API를 실행한 후 결과 객체를 반환합니다. -## remote.getCurrentWindow() +### `remote.getCurrentWindow()` -현재 웹 페이지가 들어있는 [BrowserWindow](browser-window.md) 객체를 반환합니다. +현재 웹 페이지가 들어있는 [`BrowserWindow`](browser-window.md) 객체를 반환합니다. -## remote.getCurrentWebContents() +### `remote.getCurrentWebContents()` -현재 웹 페이지의 WebContents 객체를 반환합니다. +현재 웹 페이지의 [`WebContents`](web-contents.md) 객체를 반환합니다. -## remote.getGlobal(name) +### `remote.getGlobal(name)` * `name` String 메인 프로세스의 전역 변수(`name`)를 가져옵니다. (예시: `global[name]`) -## remote.process +### `remote.process` 메인 프로세스의 `process` 객체를 반환합니다. `remote.getGlobal('process')`와 같습니다. 하지만 캐시 됩니다. diff --git a/docs-translations/ko/api/screen.md b/docs-translations/ko/api/screen.md index 44f0c1ea58b3..26975cbb1e27 100644 --- a/docs-translations/ko/api/screen.md +++ b/docs-translations/ko/api/screen.md @@ -5,8 +5,8 @@ `screen`은 [EventEmitter](http://nodejs.org/api/events.html#events_class_events_eventemitter)를 상속 받았습니다. -한가지 주의할 점은 랜더러 / DevTools에선 이 모듈의 이름인 `screen`은 이미 DOM 속성에 `window.screen`로 존재 하므로 `screen = require('screen')`를 -사용할 수 없습니다. 밑의 예제와 같이 `atomScreen`등의 이름으로 변수 이름을 대체하여 사용해야 합니다. +**참고:** 랜더러 / DevTools에선 이미 DOM 속성이 `window.screen`을 가지고 있으므로 `screen = require('screen')` 형식으로 모듈을 사용할 수 없습니다. +밑의 예제와 같이 `atomScreen` 같은 이름으로 모듈 이름을 대체하여 사용해야 합니다. 다음 예제는 화면 전체를 채우는 윈도우 창을 생성합니다: @@ -51,43 +51,57 @@ app.on('ready', function() { }); ``` -## Event: display-added +## Events + +`screen` 모듈은 다음과 같은 이벤트를 가지고 있습니다: + +### Event: 'display-added' + +Returns: * `event` Event * `newDisplay` Object 새로운 디스플레이가 추가되면 발생하는 이벤트입니다. -## Event: display-removed +### Event: 'display-removed' + +Returns: * `event` Event * `oldDisplay` Object 기존의 디스플레이가 제거되면 발생하는 이벤트입니다. -## Event: display-metrics-changed +### Event: 'display-metrics-changed' + +Returns: * `event` Event * `display` Object * `changedMetrics` Array -`display`의 하나 또는 다수의 매트릭스가 변경될 때 발생하는 이벤트입니다. +`display`에서 하나 또는 다수의 매트릭스가 변경될 때 발생하는 이벤트입니다. `changedMetrics`는 변경에 대한 정보를 담은 문자열의 배열입니다. `bounds`, `workArea`, `scaleFactor`, `rotation`등이 변경될 수 있습니다. -## screen.getCursorScreenPoint() +## Methods + +`screen` 모듈은 다음과 같은 메서드를 가지고 있습니다: + +### `screen.getCursorScreenPoint()` 현재 마우스 포인터의 절대 위치를 반환합니다. -## screen.getPrimaryDisplay() +### `screen.getPrimaryDisplay()` 기본 디스플레이를 반환합니다. -## screen.getAllDisplays() +### `screen.getAllDisplays()` 사용 가능한 모든 디스플레이를 배열로 반환합니다. -## screen.getDisplayNearestPoint(point) +### `screen.getDisplayNearestPoint(point)` * `point` Object * `x` Integer @@ -95,7 +109,7 @@ app.on('ready', function() { 지정한 좌표에 가까운 디스플레이를 반환합니다. -## screen.getDisplayMatching(rect) +### `screen.getDisplayMatching(rect)` * `rect` Object * `x` Integer From 66a1405d2b415c9b4cb97dd4ac2a3db173dd2957 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Wed, 2 Sep 2015 17:09:37 -0700 Subject: [PATCH 1090/1293] Fix conflict --- docs/tutorial/desktop-environment-integration.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/tutorial/desktop-environment-integration.md b/docs/tutorial/desktop-environment-integration.md index d827091bcd13..3132edffcc27 100644 --- a/docs/tutorial/desktop-environment-integration.md +++ b/docs/tutorial/desktop-environment-integration.md @@ -29,11 +29,7 @@ var app = require('app'); app.addRecentDocument('/Users/USERNAME/Desktop/work.type'); ``` -<<<<<<< HEAD -You can use [app.clearRecentDocuments](clearrecentdocuments) API to empty -======= And you can use [app.clearRecentDocuments][clearrecentdocuments] API to empty ->>>>>>> master the recent documents list: ```javascript From 27b77a06edadd044aa6a5bb34b163bff68988c9b Mon Sep 17 00:00:00 2001 From: John-Lin Date: Thu, 3 Sep 2015 03:04:57 +0800 Subject: [PATCH 1091/1293] Added zh-TW documents --- docs-translations/zh-TW/README.md | 70 ++++++++ .../zh-TW/tutorial/quick-start.md | 165 ++++++++++++++++++ 2 files changed, 235 insertions(+) create mode 100644 docs-translations/zh-TW/README.md create mode 100644 docs-translations/zh-TW/tutorial/quick-start.md diff --git a/docs-translations/zh-TW/README.md b/docs-translations/zh-TW/README.md new file mode 100644 index 000000000000..7c954034f21d --- /dev/null +++ b/docs-translations/zh-TW/README.md @@ -0,0 +1,70 @@ +## 導引 + +* [應用程式發布](tutorial/application-distribution.md) +* [應用程式打包](tutorial/application-packaging.md) +* [使用原生模組](tutorial/using-native-node-modules.md) +* [Debug 主行程](tutorial/debugging-main-process.md) +* [使用 Selenium 和 WebDriver](tutorial/using-selenium-and-webdriver.md) +* [DevTools 擴充](tutorial/devtools-extension.md) +* [使用 Pepper Flash 套件](tutorial/using-pepper-flash-plugin.md) + +## 教學 + +* [快速入門](tutorial/quick-start.md) +* [桌面環境整合](tutorial/desktop-environment-integration.md) +* [在線/離線事件偵測](tutorial/online-offline-events.md) + +## API 參考 + +* [提要](api/synopsis.md) +* [行程物件](api/process.md) +* [支援的 Chrome 命令行開關](api/chrome-command-line-switches.md) + +客製的 DOM 元素: + +* [`File`對象](api/file-object.md) +* [``物件](api/web-view-tag.md) +* [`window.open`函數](api/window-open.md) + +主行程可用的模組: + +* [app](api/app.md) +* [auto-updater](api/auto-updater.md) +* [browser-window](api/browser-window.md) +* [content-tracing](api/content-tracing.md) +* [dialog](api/dialog.md) +* [global-shortcut](api/global-shortcut.md) +* [ipc (main process)](api/ipc-main-process.md) +* [menu](api/menu.md) +* [menu-item](api/menu-item.md) +* [power-monitor](api/power-monitor.md) +* [power-save-blocker](api/power-save-blocker.md) +* [protocol](api/protocol.md) +* [session](api/session.md) +* [webContents](api/web-contents.md) +* [tray](api/tray.md) + +渲染行程可用的模組 (網頁): + +* [ipc (renderer)](api/ipc-renderer.md) +* [remote](api/remote.md) +* [web-frame](api/web-frame.md) + +兩種行程都可用的模組: + +* [clipboard](api/clipboard.md) +* [crash-reporter](api/crash-reporter.md) +* [native-image](api/native-image.md) +* [screen](api/screen.md) +* [shell](api/shell.md) + +## 開發 + +* [Coding style](development/coding-style.md) +* [源碼目錄結構](development/source-code-directory-structure.md) +* [與 NW.js (原名node-webkit) 在技術上的差異](development/atom-shell-vs-node-webkit.md) +* [構建系統概況](development/build-system-overview.md) +* [構建步驟 (Mac)](development/build-instructions-mac.md) +* [構建步驟 (Windows)](development/build-instructions-windows.md) +* [構建步驟 (Linux)](development/build-instructions-linux.md) +* [在 debugger 中使用 symbol server](development/setting-up-symbol-server.md) diff --git a/docs-translations/zh-TW/tutorial/quick-start.md b/docs-translations/zh-TW/tutorial/quick-start.md new file mode 100644 index 000000000000..aee2baa713bf --- /dev/null +++ b/docs-translations/zh-TW/tutorial/quick-start.md @@ -0,0 +1,165 @@ +# 快速入門 + +## 簡介 + +Electron 可以讓你使用純 JavaScript 提供豐富的原生的 APIs 來創造桌面應用程式。 +你可以把它視為一個 io.js 的變體，專注於桌面應用程式而不是 web 伺服器。 + +這不表示 Electron 是一個用 JavaScript 去綁定 GUI 函式庫。取而代之的，Electron 是使用網頁介面來作為它的 GUI ， +所以你可以把它看作是一個被 JavaScript 所控制且精簡化的 Chromium 瀏覽器。 + +## 主行程 + +在 Electron 裡，有個行程會去運行 `package.json` 裡的 `main` 腳本被稱為 __主行程__ 。 +這個腳本運行在主行程裏可以顯示一個 GUI 就由創建一個 web 頁面。 + +## 渲染行程 + +因為 Electron 使用 Chromium 來顯示網頁，所以 Chromium 的多行程架構也被充分利用。 +每一個網頁在 Electron 裏執行各自的行程，被稱為 __渲染行程__。 + +在一般瀏覽器中，網頁通常會在沙盒環境下運行，並且不允許存取原生資源。然而， +Electron 的用戶擁有在網頁中呼叫 io.js APIs 的能力，允許低級別操作與作業系統的交互作用。 + +## 主行程與渲染行程的區別 + +主行程創造網頁透過創造 `BroswerWindow` 實例。每一個 `BroswerWindow` 實例都在自己的渲染行程裡運行著一個網頁。 +當一個 `BroswerWindow` 實例被銷毀，對應的渲染行程也會被終止。主行程管理所有網頁和與之對應的渲染行程。 +每一個渲染行程都是相互獨立的，並且只關心他們自己的網頁。 + +在網頁中，是不允許呼叫原生 GUI 相關 APIs 因為管理原生 GUI 資源在網頁上是非常危險而且容易造成資源洩露。 +如果你想要在網頁中呼叫 GUI 相關的 APIs 的操作，網頁的渲染行程必須與主行程進行通訊，請求主行程進行相關的操作。 + +在 Electron ，我們提供用於在主行程與渲染行程之間通訊的 [ipc][1] 模組。並且也有一個遠端模使用 RPC 通訊方式 [remote][2]。 + +# 打造你第一個 Electron 應用 + +一般來說，一個 Electron 應用程式的目錄結構像下面這樣： + +```text +your-app/ +├── package.json +├── main.js +└── index.html +``` + +`package.json ` 的格式與 Node 的模組完全一樣，並且有個腳本被指定為 `main` 是用來啟動你的應用程式，它運行在主行程上。 +你應用裡的 一個範例在你的 `package.json` 看起來可能像這樣： + +```json +{ + "name" : "your-app", + "version" : "0.1.0", + "main" : "main.js" +} +``` + +__注意__：如果 `main` 沒有在 `package.json` 裏， Electron會嘗試載入 `index.js`。 + +`main.js` 用於創建視窗和處理系統事件，一個典型的例子如下： + +``` javascript +var app = require('app'); // 控制應用程式生命週期的模組。 +var BrowserWindow = require('browser-window'); // 創造原生瀏覽器窗口的模組 + +// 對我們的伺服器傳送異常報告。 +require('crash-reporter').start(); + +// 保持一個對於 window 物件的全域的引用，不然，當 JavaScript 被GC， +// window 會被自動地關閉 +var mainWindow = null; + +// 當所有窗口被關閉了，退出。 +app.on('window-all-closed', function() { +  // 在OS X 上，通常使用者在明確地按下 Cmd + Q 之前 +  // 應用會保持活動狀態 +  if (process.platform != 'darwin') { +    app.quit(); +  } +}); + +// 當Electron 完成了初始化並且準備創建瀏覽器視窗的時候 +// 這個方法就被調用 +app.on('ready', function() { +  // 創建瀏覽器視窗 +  mainWindow = new BrowserWindow({width: 800, height: 600}); + +  // 載入應用程式的 index.html +  mainWindow.loadUrl('file://' + __dirname + '/index.html'); + +  // 打開開發者工具 +  mainWindow.openDevTools(); + +  // 當window 被關閉，這個事件會被觸發 +  mainWindow.on('closed', function() { +    // 取消引用 window 物件，如果你的應用程式支援多視窗的話， +    // 通常會把多個 window 物件存放在一個數組裡面， +    // 但這次不是。 +    mainWindow = null; +  }); +}); +``` + +最後，你想顯示的 `index.html` ： + +```html + + +   +    Hello World! +   +   +    

Hello World!

+    We are using io.js +    and Electron . +   + +``` + +# 運行你的應用程式 + +一旦你創造了最初的 `main.js` ， `index.html` 和 `package.json` 這幾個文件，你可能會想嘗試在本地運行並測試，看看是不是和期望的那樣正常運行。 + +## electron-prebuild +如果你已經使用 `npm` 安裝了全域的 `electron-prebuilt`，那麼你只需要按照如下方式直接運行你的應用程式： + +```bash +electron . +``` + +如果你是局部性地安裝，那運行： + +```bash +./node_modules/.bin/electron . +``` + +## 手動下載 Electron Binary + +如果你手動下載了 Electron ，你可以直接使的 Binary 直接運行你的應用程式。 + +### Windows + +``` bash +$ .\electron\electron.exe your-app\ +``` + +### Linux + +``` bash +$ ./electron/electron your-app/ +``` + +### OS X + +``` bash +$ ./Electron.app/Contents/MacOS/Electron your-app/ +``` + +`Electron.app` 裡面是 Electron 釋出包，你可以在[這裡](https://github.com/atom/electron/releases)下載到。 + +# 作為版本發行 +在你完成了你的應用程式後，你可以依照 [應用部署](https://github.com/atom/electron/blob/master/docs/tutorial/application-distribution.md) 指南發布一個版本，並且運行已經打包好的應用程式。 + +[1]: https://github.com/atom/electron/blob/master/docs/api/ipc-renderer.md + +[2]: https://github.com/atom/electron/blob/master/docs/api/remote.md From d6daea12af1de8297f976fe450ca3c90d0f5540f Mon Sep 17 00:00:00 2001 From: Takashi Nakagawa Date: Thu, 3 Sep 2015 17:19:12 +0900 Subject: [PATCH 1092/1293] fix jp/quick-start-jp.md this change includes some typo, misspelled things in jp/quick-start-jp.md --- docs-translations/jp/quick-start-jp.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs-translations/jp/quick-start-jp.md b/docs-translations/jp/quick-start-jp.md index d64c5ae9a38f..aa26a8a55ab0 100644 --- a/docs-translations/jp/quick-start-jp.md +++ b/docs-translations/jp/quick-start-jp.md @@ -14,17 +14,17 @@ Electronでは、`package.json` の `main`で実行されるプロセスを __ Electronはウェブページを表示させるためにChromiumを使用しているので、Chromiumのマルチプロセスアーキテクチャが使用されることになります。Electronで実行されるウェブページはそれぞれ自身のプロセスで実行されます。それを __レンダラープロセス__ と呼びます。 -通常、ブラウザのウェブページはサウンドボックス環境で実行されネイティブなリソースへのアクセスができません。Electronではウェブページからio.jsのAPIを使って、ネイティブリソースへの権限が与えられます。そのおかげでウェブページの中からJavaScriptを使って低レベルなオペレーティングシステムとのインタラクションが可能になります。 +通常、ブラウザのウェブページはサンドボックス環境で実行されネイティブなリソースへのアクセスができません。Electronではウェブページからio.jsのAPIを使って、ネイティブリソースへの権限が与えられます。そのおかげでウェブページの中からJavaScriptを使って低レベルなオペレーティングシステムとのインタラクションが可能になります。 -### メインプロセスとリレンダラープロセスの違い +### メインプロセスとレンダラープロセスの違い -メインプロセスは `BrowserWindow` インスタンスを作ることによってウェブページをつくります。それぞれの `BrowserWindow` インスタンスはそれ自身の リレンダラープロセス上でウェブページを実行します。`BrowserWindow` インスタンスが破棄されると、対応するリレンダラープロセスも終了されます。 +メインプロセスは `BrowserWindow` インスタンスを作ることによってウェブページをつくります。それぞれの `BrowserWindow` インスタンスはそれ自身の レンダラープロセス上でウェブページを実行します。`BrowserWindow` インスタンスが破棄されると、対応するレンダラープロセスも終了されます。 -メインプロセスはすべてのウェブページとそれに対応するリレンダラープロセスを管理しています。それぞれのリレンダラープロセスは分離しているのでウェブページで実行されていることだけを気に留めておいてください。 +メインプロセスはすべてのウェブページとそれに対応するレンダラープロセスを管理しています。それぞれのレンダラープロセスは分離しているのでウェブページで実行されていることだけを気に留めておいてください。 ウェブページでは、GUI関連のAPIを呼ぶことはできません。なぜならば、ウェブページで管理しているネイティブのGUIリソースは非常に危険で簡単にリークしてしまうからです。もしウェブページ内でGUIを操作したい場合には、メインプロセスと通信をする必要があります。 -Electronでは、メインプロセスとリレンダラープロセスとのコミュニケーションをするために[ipc](../api/ipc-renderer.md)モジュールを提供しています。またそれと、RPC形式の通信を行う[remote](../api/remote.md)モジュールもあります。 +Electronでは、メインプロセスとレンダラープロセスとのコミュニケーションをするために[ipc](../api/ipc-renderer.md)モジュールを提供しています。またそれと、RPC形式の通信を行う[remote](../api/remote.md)モジュールもあります。 ## Electronアプリを作成する From f75458f78db2f558f9235b034109450b9d22bfa9 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 3 Sep 2015 17:20:48 +0900 Subject: [PATCH 1093/1293] Write output directly to stderr --- script/cibuild | 3 ++- spec/static/main.js | 4 ++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/script/cibuild b/script/cibuild index 67623beba402..08d59385c9e0 100755 --- a/script/cibuild +++ b/script/cibuild @@ -78,7 +78,8 @@ def main(): def run_script(script, args=[]): - print 'Running', script + sys.stderr.write('\nRunning ' + script +'\n') + sys.stderr.flush() script = os.path.join(SOURCE_ROOT, 'script', script) subprocess.check_call([sys.executable, script] + args) diff --git a/spec/static/main.js b/spec/static/main.js index 4eb415dab222..d8b53167c5e2 100644 --- a/spec/static/main.js +++ b/spec/static/main.js @@ -15,11 +15,11 @@ ipc.on('message', function(event, arg) { }); ipc.on('console.log', function(event, args) { - console.log.apply(console, args); + console.error.apply(console, args); }); ipc.on('console.error', function(event, args) { - console.log.apply(console, args); + console.error.apply(console, args); }); ipc.on('process.exit', function(event, code) { From c01d2fbbcd905e23b673ae3884efa187945ebf8b Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 3 Sep 2015 17:46:44 +0900 Subject: [PATCH 1094/1293] Suppress running tests on our OS X machine It gets stuck and I don't know the reason, ignore it for now and work on more important things, will fix it in future. --- script/cibuild | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/script/cibuild b/script/cibuild index 08d59385c9e0..db6f63abbf60 100755 --- a/script/cibuild +++ b/script/cibuild @@ -71,7 +71,7 @@ def main(): run_script('upload.py') else: run_script('build.py', ['-c', 'D']) - if PLATFORM != 'win32' and target_arch == 'x64': + if is_travis or PLATFORM == 'linux': run_script('test.py', ['--ci']) run_script('clean.py') From 992aada90f4bb53913e58d90f49b8ecce7bf02c1 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 3 Sep 2015 17:48:50 +0900 Subject: [PATCH 1095/1293] Can only run tests on x64 machine --- script/cibuild | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/script/cibuild b/script/cibuild index db6f63abbf60..38ce06969a22 100755 --- a/script/cibuild +++ b/script/cibuild @@ -71,7 +71,7 @@ def main(): run_script('upload.py') else: run_script('build.py', ['-c', 'D']) - if is_travis or PLATFORM == 'linux': + if (is_travis or PLATFORM == 'linux') and target_arch == 'x64': run_script('test.py', ['--ci']) run_script('clean.py') From 1db843244de2d128e003bfe5e997f893eaa81029 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 2 Sep 2015 14:23:15 +0800 Subject: [PATCH 1096/1293] Upgrade to Chrome 45 --- .gitignore | 1 - atom/common/chrome_version.h | 2 +- script/lib/config.py | 2 +- 3 files changed, 2 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index 73bf6b258099..0c6f4cb79dd0 100644 --- a/.gitignore +++ b/.gitignore @@ -17,4 +17,3 @@ node_modules/ *.pyc debug.log npm-debug.log -atom/common/chrome_version.h diff --git a/atom/common/chrome_version.h b/atom/common/chrome_version.h index 54dd6bb5bb12..250051683786 100644 --- a/atom/common/chrome_version.h +++ b/atom/common/chrome_version.h @@ -8,7 +8,7 @@ #ifndef ATOM_COMMON_CHROME_VERSION_H_ #define ATOM_COMMON_CHROME_VERSION_H_ -#define CHROME_VERSION_STRING "44.0.2403.125" +#define CHROME_VERSION_STRING "45.0.2454.85" #define CHROME_VERSION "v" CHROME_VERSION_STRING #endif // ATOM_COMMON_CHROME_VERSION_H_ diff --git a/script/lib/config.py b/script/lib/config.py index c363a83a5f44..3292823091ab 100644 --- a/script/lib/config.py +++ b/script/lib/config.py @@ -8,7 +8,7 @@ import sys BASE_URL = os.getenv('LIBCHROMIUMCONTENT_MIRROR') or \ 'http://github-janky-artifacts.s3.amazonaws.com/libchromiumcontent' -LIBCHROMIUMCONTENT_COMMIT = '42200d8ec0b77c7491d3a09611c23eb771e0862d' +LIBCHROMIUMCONTENT_COMMIT = '367552dc926aff4577e4743333922e7e6075c8e0' PLATFORM = { 'cygwin': 'win32', From 45491ca7aba545afd0eded3d19c96c4ec16fa774 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 2 Sep 2015 15:16:49 +0800 Subject: [PATCH 1097/1293] Fix API changes --- atom/browser/api/atom_api_content_tracing.cc | 26 +++++++------------ atom/browser/api/atom_api_web_contents.cc | 8 +++--- atom/browser/api/atom_api_web_contents.h | 8 +++--- atom/browser/browser.h | 2 +- atom/browser/native_window.h | 2 +- atom/browser/net/asar/url_request_asar_job.cc | 8 +++--- atom/browser/net/url_request_fetch_job.cc | 2 +- atom/browser/ui/atom_menu_model.h | 2 +- atom/browser/ui/tray_icon.h | 2 +- atom/browser/window_list.cc | 2 +- atom/browser/window_list.h | 3 ++- atom/common/api/atom_api_native_image.cc | 9 ++++--- atom/common/asar/archive.cc | 6 +++-- atom/renderer/atom_renderer_client.cc | 3 +-- atom/renderer/atom_renderer_client.h | 2 +- atom/renderer/guest_view_container.cc | 9 ++++++- atom/renderer/guest_view_container.h | 3 +++ .../pepper_flash_clipboard_message_filter.cc | 19 +++++++------- .../pepper_shared_memory_message_filter.cc | 12 ++------- .../printing/print_web_view_helper.cc | 13 +++++++--- docs/api/content-tracing.md | 14 +++++----- 21 files changed, 81 insertions(+), 74 deletions(-) diff --git a/atom/browser/api/atom_api_content_tracing.cc b/atom/browser/api/atom_api_content_tracing.cc index e404a8f26ca6..e4bf33c7b5c5 100644 --- a/atom/browser/api/atom_api_content_tracing.cc +++ b/atom/browser/api/atom_api_content_tracing.cc @@ -19,27 +19,19 @@ using content::TracingController; namespace mate { template<> -struct Converter { +struct Converter { static bool FromV8(v8::Isolate* isolate, v8::Local val, - base::trace_event::CategoryFilter* out) { - std::string filter; - if (!ConvertFromV8(isolate, val, &filter)) - return false; - *out = base::trace_event::CategoryFilter(filter); - return true; - } -}; - -template<> -struct Converter { - static bool FromV8(v8::Isolate* isolate, - v8::Local val, - base::trace_event::TraceOptions* out) { - std::string options; + base::trace_event::TraceConfig* out) { + Dictionary options; if (!ConvertFromV8(isolate, val, &options)) return false; - return out->SetFromString(options); + std::string category_filter, trace_options; + if (!options.Get("categoryFilter", &category_filter) || + !options.Get("traceOptions", &trace_options)) + return false; + *out = base::trace_event::TraceConfig(category_filter, trace_options); + return true; } }; diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 59a50d5656ce..5b723801cdeb 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -217,7 +217,7 @@ bool WebContents::ShouldCreateWebContents( int route_id, int main_frame_route_id, WindowContainerType window_container_type, - const base::string16& frame_name, + const std::string& frame_name, const GURL& target_url, const std::string& partition_id, content::SessionStorageNamespace* session_storage_namespace) { @@ -362,14 +362,16 @@ void WebContents::DidFailProvisionalLoad( content::RenderFrameHost* render_frame_host, const GURL& validated_url, int error_code, - const base::string16& error_description) { + const base::string16& error_description, + bool was_ignored_by_handler) { Emit("did-fail-load", error_code, error_description); } void WebContents::DidFailLoad(content::RenderFrameHost* render_frame_host, const GURL& validated_url, int error_code, - const base::string16& error_description) { + const base::string16& error_description, + bool was_ignored_by_handler) { Emit("did-fail-load", error_code, error_description); } diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index 45027309ea65..e75e88fd703e 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -135,7 +135,7 @@ class WebContents : public mate::TrackableObject, int route_id, int main_frame_route_id, WindowContainerType window_container_type, - const base::string16& frame_name, + const std::string& frame_name, const GURL& target_url, const std::string& partition_id, content::SessionStorageNamespace* session_storage_namespace) override; @@ -170,11 +170,13 @@ class WebContents : public mate::TrackableObject, void DidFailLoad(content::RenderFrameHost* render_frame_host, const GURL& validated_url, int error_code, - const base::string16& error_description) override; + const base::string16& error_description, + bool was_ignored_by_handler) override; void DidFailProvisionalLoad(content::RenderFrameHost* render_frame_host, const GURL& validated_url, int error_code, - const base::string16& error_description) override; + const base::string16& error_description, + bool was_ignored_by_handler) override; void DidStartLoading() override; void DidStopLoading() override; void DidGetResourceResponseStart( diff --git a/atom/browser/browser.h b/atom/browser/browser.h index 3e93c84b077f..dc412cefb046 100644 --- a/atom/browser/browser.h +++ b/atom/browser/browser.h @@ -153,7 +153,7 @@ class Browser : public WindowListObserver { void OnWindowAllClosed() override; // Observers of the browser. - ObserverList observers_; + base::ObserverList observers_; // Whether "ready" event has been emitted. bool is_ready_; diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index b9294d38c931..10889a5ccaf9 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -310,7 +310,7 @@ class NativeWindow : public content::WebContentsObserver, brightray::InspectableWebContents* inspectable_web_contents_; // Observers of this window. - ObserverList observers_; + base::ObserverList observers_; base::WeakPtrFactory weak_factory_; diff --git a/atom/browser/net/asar/url_request_asar_job.cc b/atom/browser/net/asar/url_request_asar_job.cc index de019f6d9420..88195a0d7c79 100644 --- a/atom/browser/net/asar/url_request_asar_job.cc +++ b/atom/browser/net/asar/url_request_asar_job.cc @@ -193,7 +193,7 @@ bool URLRequestAsarJob::IsRedirectResponse(GURL* location, net::Filter* URLRequestAsarJob::SetupFilter() const { // Bug 9936 - .svgz files needs to be decompressed. - return LowerCaseEqualsASCII(file_path_.Extension(), ".svgz") + return base::LowerCaseEqualsASCII(file_path_.Extension(), ".svgz") ? net::Filter::GZipFactory() : NULL; } @@ -265,8 +265,7 @@ void URLRequestAsarJob::DidOpen(int result) { } if (type_ == TYPE_ASAR) { - int rv = stream_->Seek(base::File::FROM_BEGIN, - file_info_.offset, + int rv = stream_->Seek(file_info_.offset, base::Bind(&URLRequestAsarJob::DidSeek, weak_ptr_factory_.GetWeakPtr())); if (rv != net::ERR_IO_PENDING) { @@ -285,8 +284,7 @@ void URLRequestAsarJob::DidOpen(int result) { byte_range_.first_byte_position() + 1; if (remaining_bytes_ > 0 && byte_range_.first_byte_position() != 0) { - int rv = stream_->Seek(base::File::FROM_BEGIN, - byte_range_.first_byte_position(), + int rv = stream_->Seek(byte_range_.first_byte_position(), base::Bind(&URLRequestAsarJob::DidSeek, weak_ptr_factory_.GetWeakPtr())); if (rv != net::ERR_IO_PENDING) { diff --git a/atom/browser/net/url_request_fetch_job.cc b/atom/browser/net/url_request_fetch_job.cc index eacaada19358..a8a16e286b30 100644 --- a/atom/browser/net/url_request_fetch_job.cc +++ b/atom/browser/net/url_request_fetch_job.cc @@ -23,7 +23,7 @@ namespace { // Convert string to RequestType. net::URLFetcher::RequestType GetRequestType(const std::string& raw) { - std::string method = StringToUpperASCII(raw); + std::string method = base::StringToUpperASCII(raw); if (method.empty() || method == "GET") return net::URLFetcher::GET; else if (method == "POST") diff --git a/atom/browser/ui/atom_menu_model.h b/atom/browser/ui/atom_menu_model.h index fe19a8dc2518..d091df9fb570 100644 --- a/atom/browser/ui/atom_menu_model.h +++ b/atom/browser/ui/atom_menu_model.h @@ -43,7 +43,7 @@ class AtomMenuModel : public ui::SimpleMenuModel { Delegate* delegate_; // weak ref. std::map roles_; - ObserverList observers_; + base::ObserverList observers_; DISALLOW_COPY_AND_ASSIGN(AtomMenuModel); }; diff --git a/atom/browser/ui/tray_icon.h b/atom/browser/ui/tray_icon.h index 55f1c41d19d7..af774ddbfb42 100644 --- a/atom/browser/ui/tray_icon.h +++ b/atom/browser/ui/tray_icon.h @@ -67,7 +67,7 @@ class TrayIcon { TrayIcon(); private: - ObserverList observers_; + base::ObserverList observers_; DISALLOW_COPY_AND_ASSIGN(TrayIcon); }; diff --git a/atom/browser/window_list.cc b/atom/browser/window_list.cc index 9a2089e57434..b3bec5d08c1c 100644 --- a/atom/browser/window_list.cc +++ b/atom/browser/window_list.cc @@ -13,7 +13,7 @@ namespace atom { // static -base::LazyInstance>::Leaky +base::LazyInstance>::Leaky WindowList::observers_ = LAZY_INSTANCE_INITIALIZER; // static diff --git a/atom/browser/window_list.h b/atom/browser/window_list.h index 7ba5a7957561..bfb9a2b0aecc 100644 --- a/atom/browser/window_list.h +++ b/atom/browser/window_list.h @@ -60,7 +60,8 @@ class WindowList { // A list of observers which will be notified of every window addition and // removal across all WindowLists. - static base::LazyInstance>::Leaky observers_; + static base::LazyInstance>::Leaky + observers_; static WindowList* instance_; diff --git a/atom/common/api/atom_api_native_image.cc b/atom/common/api/atom_api_native_image.cc index 879c73394293..df6c14dab350 100644 --- a/atom/common/api/atom_api_native_image.cc +++ b/atom/common/api/atom_api_native_image.cc @@ -14,6 +14,7 @@ #include "atom/common/node_includes.h" #include "base/base64.h" #include "base/strings/string_util.h" +#include "base/strings/pattern.h" #include "native_mate/dictionary.h" #include "native_mate/object_template_builder.h" #include "net/base/data_url.h" @@ -62,7 +63,7 @@ float GetScaleFactorFromPath(const base::FilePath& path) { // We don't try to convert string to float here because it is very very // expensive. for (unsigned i = 0; i < arraysize(kScaleFactorPairs); ++i) { - if (EndsWith(filename, kScaleFactorPairs[i].name, true)) + if (base::EndsWith(filename, kScaleFactorPairs[i].name, true)) return kScaleFactorPairs[i].scale; } @@ -104,7 +105,7 @@ bool PopulateImageSkiaRepsFromPath(gfx::ImageSkia* image, const base::FilePath& path) { bool succeed = false; std::string filename(path.BaseName().RemoveExtension().AsUTF8Unsafe()); - if (MatchPattern(filename, "*@*x")) + if (base::MatchPattern(filename, "*@*x")) // Don't search for other representations if the DPI has been specified. return AddImageSkiaRep(image, path, GetScaleFactorFromPath(path)); else @@ -119,8 +120,8 @@ bool PopulateImageSkiaRepsFromPath(gfx::ImageSkia* image, #if defined(OS_MACOSX) bool IsTemplateFilename(const base::FilePath& path) { - return (MatchPattern(path.value(), "*Template.*") || - MatchPattern(path.value(), "*Template@*x.*")); + return (base::MatchPattern(path.value(), "*Template.*") || + base::MatchPattern(path.value(), "*Template@*x.*")); } #endif diff --git a/atom/common/asar/archive.cc b/atom/common/asar/archive.cc index be99530c9c98..0b2f59ae0f18 100644 --- a/atom/common/asar/archive.cc +++ b/atom/common/asar/archive.cc @@ -136,7 +136,8 @@ bool Archive::Init() { } uint32 size; - if (!PickleIterator(Pickle(buf.data(), buf.size())).ReadUInt32(&size)) { + if (!base::PickleIterator(base::Pickle(buf.data(), buf.size())).ReadUInt32( + &size)) { LOG(ERROR) << "Failed to parse header size from " << path_.value(); return false; } @@ -149,7 +150,8 @@ bool Archive::Init() { } std::string header; - if (!PickleIterator(Pickle(buf.data(), buf.size())).ReadString(&header)) { + if (!base::PickleIterator(base::Pickle(buf.data(), buf.size())).ReadString( + &header)) { LOG(ERROR) << "Failed to parse header from " << path_.value(); return false; } diff --git a/atom/renderer/atom_renderer_client.cc b/atom/renderer/atom_renderer_client.cc index e17e8bf3db9b..ef5ac757d9f4 100644 --- a/atom/renderer/atom_renderer_client.cc +++ b/atom/renderer/atom_renderer_client.cc @@ -27,7 +27,6 @@ #include "third_party/WebKit/public/web/WebPluginParams.h" #include "third_party/WebKit/public/web/WebKit.h" #include "third_party/WebKit/public/web/WebRuntimeFeatures.h" -#include "third_party/WebKit/Source/wtf/ArrayBufferContents.h" #include "atom/common/node_includes.h" @@ -205,7 +204,7 @@ void AtomRendererClient::DidCreateScriptContext( node_bindings_->LoadEnvironment(env); } -bool AtomRendererClient::ShouldFork(blink::WebFrame* frame, +bool AtomRendererClient::ShouldFork(blink::WebLocalFrame* frame, const GURL& url, const std::string& http_method, bool is_initial_navigation, diff --git a/atom/renderer/atom_renderer_client.h b/atom/renderer/atom_renderer_client.h index e59547cf8eb1..206ed9f9b9b7 100644 --- a/atom/renderer/atom_renderer_client.h +++ b/atom/renderer/atom_renderer_client.h @@ -45,7 +45,7 @@ class AtomRendererClient : public content::ContentRendererClient, blink::WebLocalFrame* frame, const blink::WebPluginParams& params, blink::WebPlugin** plugin) override; - bool ShouldFork(blink::WebFrame* frame, + bool ShouldFork(blink::WebLocalFrame* frame, const GURL& url, const std::string& http_method, bool is_initial_navigation, diff --git a/atom/renderer/guest_view_container.cc b/atom/renderer/guest_view_container.cc index c0bc1427d68c..f50c3f78685c 100644 --- a/atom/renderer/guest_view_container.cc +++ b/atom/renderer/guest_view_container.cc @@ -6,7 +6,9 @@ #include +#include "base/bind.h" #include "base/lazy_instance.h" +#include "base/message_loop/message_loop.h" #include "ui/gfx/geometry/size.h" namespace atom { @@ -20,7 +22,8 @@ static base::LazyInstance g_guest_view_container_map = } // namespace GuestViewContainer::GuestViewContainer(content::RenderFrame* render_frame) - : render_frame_(render_frame) { + : render_frame_(render_frame), + weak_ptr_factory_(this) { } GuestViewContainer::~GuestViewContainer() { @@ -55,4 +58,8 @@ void GuestViewContainer::DidResizeElement(const gfx::Size& new_size) { FROM_HERE, base::Bind(element_resize_callback_, new_size)); } +base::WeakPtr GuestViewContainer::GetWeakPtr() { + return weak_ptr_factory_.GetWeakPtr(); +} + } // namespace atom diff --git a/atom/renderer/guest_view_container.h b/atom/renderer/guest_view_container.h index 2846265cb2af..3771c7adc4e6 100644 --- a/atom/renderer/guest_view_container.h +++ b/atom/renderer/guest_view_container.h @@ -28,6 +28,7 @@ class GuestViewContainer : public content::BrowserPluginDelegate { // content::BrowserPluginDelegate: void SetElementInstanceID(int element_instance_id) final; void DidResizeElement(const gfx::Size& new_size) final; + base::WeakPtr GetWeakPtr() final; private: int element_instance_id_; @@ -35,6 +36,8 @@ class GuestViewContainer : public content::BrowserPluginDelegate { ResizeCallback element_resize_callback_; + base::WeakPtrFactory weak_ptr_factory_; + DISALLOW_COPY_AND_ASSIGN(GuestViewContainer); }; diff --git a/chromium_src/chrome/browser/renderer_host/pepper/pepper_flash_clipboard_message_filter.cc b/chromium_src/chrome/browser/renderer_host/pepper/pepper_flash_clipboard_message_filter.cc index 4499b21aefe3..fdc054f59fbd 100644 --- a/chromium_src/chrome/browser/renderer_host/pepper/pepper_flash_clipboard_message_filter.cc +++ b/chromium_src/chrome/browser/renderer_host/pepper/pepper_flash_clipboard_message_filter.cc @@ -46,7 +46,8 @@ ui::ClipboardType ConvertClipboardType(uint32_t type) { // assume all data that is placed on the clipboard is UTF16 and pepper allows // arbitrary data so this change would require some reworking of the chrome // clipboard interface for custom data. -bool JumpToFormatInPickle(const base::string16& format, PickleIterator* iter) { +bool JumpToFormatInPickle(const base::string16& format, + base::PickleIterator* iter) { size_t size = 0; if (!iter->ReadSizeT(&size)) return false; @@ -66,22 +67,22 @@ bool JumpToFormatInPickle(const base::string16& format, PickleIterator* iter) { } bool IsFormatAvailableInPickle(const base::string16& format, - const Pickle& pickle) { - PickleIterator iter(pickle); + const base::Pickle& pickle) { + base::PickleIterator iter(pickle); return JumpToFormatInPickle(format, &iter); } std::string ReadDataFromPickle(const base::string16& format, - const Pickle& pickle) { + const base::Pickle& pickle) { std::string result; - PickleIterator iter(pickle); + base::PickleIterator iter(pickle); if (!JumpToFormatInPickle(format, &iter) || !iter.ReadString(&result)) return std::string(); return result; } bool WriteDataToPickle(const std::map& data, - Pickle* pickle) { + base::Pickle* pickle) { pickle->WriteSizeT(data.size()); for (std::map::const_iterator it = data.begin(); it != data.end(); @@ -187,7 +188,7 @@ int32_t PepperFlashClipboardMessageFilter::OnMsgIsFormatAvailable( std::string clipboard_data; clipboard->ReadData(ui::Clipboard::GetPepperCustomDataFormatType(), &clipboard_data); - Pickle pickle(clipboard_data.data(), clipboard_data.size()); + base::Pickle pickle(clipboard_data.data(), clipboard_data.size()); available = IsFormatAvailableInPickle(base::UTF8ToUTF16(format_name), pickle); } @@ -265,7 +266,7 @@ int32_t PepperFlashClipboardMessageFilter::OnMsgReadData( std::string clipboard_data; clipboard->ReadData(ui::Clipboard::GetPepperCustomDataFormatType(), &clipboard_data); - Pickle pickle(clipboard_data.data(), clipboard_data.size()); + base::Pickle pickle(clipboard_data.data(), clipboard_data.size()); if (IsFormatAvailableInPickle(format_name, pickle)) { result = PP_OK; clipboard_string = ReadDataFromPickle(format_name, pickle); @@ -340,7 +341,7 @@ int32_t PepperFlashClipboardMessageFilter::OnMsgWriteData( } if (custom_data_map.size() > 0) { - Pickle pickle; + base::Pickle pickle; if (WriteDataToPickle(custom_data_map, &pickle)) { scw.WritePickledData(pickle, ui::Clipboard::GetPepperCustomDataFormatType()); diff --git a/chromium_src/chrome/renderer/pepper/pepper_shared_memory_message_filter.cc b/chromium_src/chrome/renderer/pepper/pepper_shared_memory_message_filter.cc index e01aea741fc8..3ef6dff0c8bc 100644 --- a/chromium_src/chrome/renderer/pepper/pepper_shared_memory_message_filter.cc +++ b/chromium_src/chrome/renderer/pepper/pepper_shared_memory_message_filter.cc @@ -56,17 +56,9 @@ void PepperSharedMemoryMessageFilter::OnHostMsgCreateSharedMemory( ->GetVarTracker() ->TrackSharedMemoryHandle(instance, host_shm_handle, size); - base::PlatformFile host_handle = -#if defined(OS_WIN) - host_shm_handle; -#elif defined(OS_POSIX) - host_shm_handle.fd; -#else -#error Not implemented. -#endif // We set auto_close to false since we need our file descriptor to // actually be duplicated on linux. The shared memory destructor will // close the original handle for us. - plugin_handle->set_shmem(host_->ShareHandleWithRemote(host_handle, false), - size); + plugin_handle->set_shmem( + host_->ShareSharedMemoryHandleWithRemote(host_shm_handle), size); } diff --git a/chromium_src/chrome/renderer/printing/print_web_view_helper.cc b/chromium_src/chrome/renderer/printing/print_web_view_helper.cc index cba75b651b6b..20ac1fdc9b4f 100644 --- a/chromium_src/chrome/renderer/printing/print_web_view_helper.cc +++ b/chromium_src/chrome/renderer/printing/print_web_view_helper.cc @@ -427,9 +427,10 @@ class PrepareFrameAndViewForPrint : public blink::WebViewClient, // blink::WebFrameClient override: virtual blink::WebFrame* createChildFrame( blink::WebLocalFrame* parent, + blink::WebTreeScopeType scope, const blink::WebString& name, blink::WebSandboxFlags sandboxFlags); - virtual void frameDetached(blink::WebFrame* frame); + virtual void frameDetached(blink::WebFrame* frame, DetachType type); private: void CallOnReady(); @@ -548,7 +549,8 @@ void PrepareFrameAndViewForPrint::CopySelection( blink::WebView* web_view = blink::WebView::create(this); owns_web_view_ = true; content::RenderView::ApplyWebPreferences(prefs, web_view); - web_view->setMainFrame(blink::WebLocalFrame::create(this)); + web_view->setMainFrame( + blink::WebLocalFrame::create(blink::WebTreeScopeType::Document, this)); frame_.Reset(web_view->mainFrame()->toWebLocalFrame()); node_to_print_.reset(); @@ -573,14 +575,17 @@ void PrepareFrameAndViewForPrint::didStopLoading() { blink::WebFrame* PrepareFrameAndViewForPrint::createChildFrame( blink::WebLocalFrame* parent, + blink::WebTreeScopeType scope, const blink::WebString& name, blink::WebSandboxFlags sandboxFlags) { - blink::WebFrame* frame = blink::WebLocalFrame::create(this); + blink::WebFrame* frame = blink::WebLocalFrame::create(scope, this); parent->appendChild(frame); return frame; } -void PrepareFrameAndViewForPrint::frameDetached(blink::WebFrame* frame) { +void PrepareFrameAndViewForPrint::frameDetached(blink::WebFrame* frame, + DetachType type) { + DCHECK(type == DetachType::Remove); if (frame->parent()) frame->parent()->removeChild(frame); frame->close(); diff --git a/docs/api/content-tracing.md b/docs/api/content-tracing.md index 9161f5f362a1..2e05fc67668f 100644 --- a/docs/api/content-tracing.md +++ b/docs/api/content-tracing.md @@ -33,10 +33,11 @@ are reached. Once all child processes have acknowledged the `getCategories` request the `callback` is invoked with an array of category groups. -### `contentTracing.startRecording(categoryFilter, traceOptions, callback)` +### `contentTracing.startRecording(options, callback)` -* `categoryFilter` String -* `traceOptions` String +* `options` Object + * `categoryFilter` String + * `traceOptions` String * `callback` Function Start recording on all processes. @@ -94,10 +95,11 @@ Trace data will be written into `resultFilePath` if it is not empty or into a temporary file. The actual file path will be passed to `callback` if it's not `null`. -### `contentTracing.startMonitoring(categoryFilter, traceOptions, callback)` +### `contentTracing.startMonitoring(options, callback)` -* `categoryFilter` String -* `traceOptions` String +* `options` Object + * `categoryFilter` String + * `traceOptions` String * `callback` Function Start monitoring on all processes. From 262b66b93af57f5395ec0e532ccea28f4922b961 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 2 Sep 2015 15:52:17 +0800 Subject: [PATCH 1098/1293] Feed gin::PerIsolateData with a task runner --- atom/browser/atom_browser_main_parts.cc | 16 ++++++++-- atom/browser/atom_browser_main_parts.h | 5 +++ atom/browser/bridge_task_runner.cc | 42 +++++++++++++++++++++++++ atom/browser/bridge_task_runner.h | 35 +++++++++++++++++++++ filenames.gypi | 2 ++ 5 files changed, 97 insertions(+), 3 deletions(-) create mode 100644 atom/browser/bridge_task_runner.cc create mode 100644 atom/browser/bridge_task_runner.h diff --git a/atom/browser/atom_browser_main_parts.cc b/atom/browser/atom_browser_main_parts.cc index c472b8742f06..b4f61d0f195e 100644 --- a/atom/browser/atom_browser_main_parts.cc +++ b/atom/browser/atom_browser_main_parts.cc @@ -7,12 +7,14 @@ #include "atom/browser/api/trackable_object.h" #include "atom/browser/atom_browser_client.h" #include "atom/browser/atom_browser_context.h" +#include "atom/browser/bridge_task_runner.h" #include "atom/browser/browser.h" #include "atom/browser/javascript_environment.h" #include "atom/browser/node_debugger.h" #include "atom/common/api/atom_bindings.h" #include "atom/common/node_bindings.h" #include "base/command_line.h" +#include "base/thread_task_runner_handle.h" #include "chrome/browser/browser_process.h" #include "v8/include/v8-debug.h" @@ -64,9 +66,17 @@ void AtomBrowserMainParts::PostEarlyInitialization() { SetDPIFromGSettings(); #endif - // The ProxyResolverV8 has setup a complete V8 environment, in order to avoid - // conflicts we only initialize our V8 environment after that. - js_env_.reset(new JavascriptEnvironment); + { + // Temporary set the bridge_task_runner_ as current thread's task runner, + // so we can fool gin::PerIsolateData to use it as its task runner, instead + // of getting current message loop's task runner, which is null for now. + bridge_task_runner_ = new BridgeTaskRunner; + base::ThreadTaskRunnerHandle handle(bridge_task_runner_); + + // The ProxyResolverV8 has setup a complete V8 environment, in order to + // avoid conflicts we only initialize our V8 environment after that. + js_env_.reset(new JavascriptEnvironment); + } node_bindings_->Initialize(); diff --git a/atom/browser/atom_browser_main_parts.h b/atom/browser/atom_browser_main_parts.h index 97663a72404e..a2909cac53d0 100644 --- a/atom/browser/atom_browser_main_parts.h +++ b/atom/browser/atom_browser_main_parts.h @@ -20,6 +20,7 @@ class Browser; class JavascriptEnvironment; class NodeBindings; class NodeDebugger; +class BridgeTaskRunner; class AtomBrowserMainParts : public brightray::BrowserMainParts { public: @@ -54,6 +55,10 @@ class AtomBrowserMainParts : public brightray::BrowserMainParts { // A fake BrowserProcess object that used to feed the source code from chrome. scoped_ptr fake_browser_process_; + // The gin::PerIsolateData requires a task runner to create, so we feed it + // with a task runner that will post all work to main loop. + scoped_refptr bridge_task_runner_; + scoped_ptr browser_; scoped_ptr js_env_; scoped_ptr node_bindings_; diff --git a/atom/browser/bridge_task_runner.cc b/atom/browser/bridge_task_runner.cc new file mode 100644 index 000000000000..24572f3990d8 --- /dev/null +++ b/atom/browser/bridge_task_runner.cc @@ -0,0 +1,42 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#include "atom/browser/bridge_task_runner.h" + +#include "base/message_loop/message_loop.h" + +namespace atom { + +bool BridgeTaskRunner::PostDelayedTask( + const tracked_objects::Location& from_here, + const base::Closure& task, + base::TimeDelta delay) { + auto message_loop = base::MessageLoop::current(); + if (!message_loop) + return false; + + return message_loop->task_runner()->PostDelayedTask(from_here, task, delay); +} + +bool BridgeTaskRunner::RunsTasksOnCurrentThread() const { + auto message_loop = base::MessageLoop::current(); + if (!message_loop) + return false; + + return message_loop->task_runner()->RunsTasksOnCurrentThread(); +} + +bool BridgeTaskRunner::PostNonNestableDelayedTask( + const tracked_objects::Location& from_here, + const base::Closure& task, + base::TimeDelta delay) { + auto message_loop = base::MessageLoop::current(); + if (!message_loop) + return false; + + return message_loop->task_runner()->PostNonNestableDelayedTask( + from_here, task, delay); +} + +} // namespace atom diff --git a/atom/browser/bridge_task_runner.h b/atom/browser/bridge_task_runner.h new file mode 100644 index 000000000000..01bde48eb805 --- /dev/null +++ b/atom/browser/bridge_task_runner.h @@ -0,0 +1,35 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#ifndef ATOM_BROWSER_BRIDGE_TASK_RUNNER_H_ +#define ATOM_BROWSER_BRIDGE_TASK_RUNNER_H_ + +#include "base/single_thread_task_runner.h" + +namespace atom { + +// Post all tasks to the current message loop's task runner if available, +// otherwise fail silently. +class BridgeTaskRunner : public base::SingleThreadTaskRunner { + public: + BridgeTaskRunner() {} + ~BridgeTaskRunner() {} + + // base::SingleThreadTaskRunner: + bool PostDelayedTask(const tracked_objects::Location& from_here, + const base::Closure& task, + base::TimeDelta delay) override; + bool RunsTasksOnCurrentThread() const override; + bool PostNonNestableDelayedTask( + const tracked_objects::Location& from_here, + const base::Closure& task, + base::TimeDelta delay) override; + + private: + DISALLOW_COPY_AND_ASSIGN(BridgeTaskRunner); +}; + +} // namespace atom + +#endif // ATOM_BROWSER_BRIDGE_TASK_RUNNER_H_ diff --git a/filenames.gypi b/filenames.gypi index af0c56e1ea69..3ea01274cf71 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -125,6 +125,8 @@ 'atom/browser/atom_quota_permission_context.h', 'atom/browser/atom_speech_recognition_manager_delegate.cc', 'atom/browser/atom_speech_recognition_manager_delegate.h', + 'atom/browser/bridge_task_runner.cc', + 'atom/browser/bridge_task_runner.h', 'atom/browser/browser.cc', 'atom/browser/browser.h', 'atom/browser/browser_linux.cc', From 4254eb279f9921a8e263bb200dbaebaf792d207f Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 2 Sep 2015 17:30:07 +0800 Subject: [PATCH 1099/1293] Fix API changes on Linux --- atom/browser/ui/file_dialog_gtk.cc | 2 +- atom/browser/ui/x/x_window_utils.cc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/atom/browser/ui/file_dialog_gtk.cc b/atom/browser/ui/file_dialog_gtk.cc index 463ad987a8b0..5885ffe3611c 100644 --- a/atom/browser/ui/file_dialog_gtk.cc +++ b/atom/browser/ui/file_dialog_gtk.cc @@ -22,7 +22,7 @@ gboolean FileFilterCaseInsensitive(const GtkFileFilterInfo* file_info, // Makes .* file extension matches all file types. if (*file_extension == ".*") return true; - return EndsWith(file_info->filename, *file_extension, false); + return base::EndsWith(file_info->filename, *file_extension, false); } // Deletes |data| when gtk_file_filter_add_custom() is done with it. diff --git a/atom/browser/ui/x/x_window_utils.cc b/atom/browser/ui/x/x_window_utils.cc index a15affb05f1b..e57122839cd8 100644 --- a/atom/browser/ui/x/x_window_utils.cc +++ b/atom/browser/ui/x/x_window_utils.cc @@ -41,7 +41,7 @@ void SetWindowType(::Window xwindow, const std::string& type) { XDisplay* xdisplay = gfx::GetXDisplay(); std::string type_prefix = "_NET_WM_WINDOW_TYPE_"; ::Atom window_type = XInternAtom( - xdisplay, (type_prefix + StringToUpperASCII(type)).c_str(), False); + xdisplay, (type_prefix + base::StringToUpperASCII(type)).c_str(), False); XChangeProperty(xdisplay, xwindow, XInternAtom(xdisplay, "_NET_WM_WINDOW_TYPE", False), XA_ATOM, From ee0dc0d9266dcb8f9986964fbd810c56044fe9db Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 2 Sep 2015 17:31:08 +0800 Subject: [PATCH 1100/1293] Update clang --- common.gypi | 2 ++ script/update-clang.sh | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/common.gypi b/common.gypi index 0735d99dd910..a95e05620f02 100644 --- a/common.gypi +++ b/common.gypi @@ -85,6 +85,7 @@ '-Wno-deprecated-declarations', '-Wno-return-type', '-Wno-gnu-folding-constant', + '-Wno-shift-negative-value', ], }, 'conditions': [ @@ -99,6 +100,7 @@ '-Wno-unused-value', '-Wno-deprecated-declarations', '-Wno-return-type', + '-Wno-shift-negative-value', # Required when building as shared library. '-fPIC', ], diff --git a/script/update-clang.sh b/script/update-clang.sh index bf388c62fdbe..5f9b00da7d9a 100755 --- a/script/update-clang.sh +++ b/script/update-clang.sh @@ -8,7 +8,7 @@ # Do NOT CHANGE this if you don't know what you're doing -- see # https://code.google.com/p/chromium/wiki/UpdatingClang # Reverting problematic clang rolls is safe, though. -CLANG_REVISION=233105 +CLANG_REVISION=245965 # This is incremented when pushing a new build of Clang at the same revision. CLANG_SUB_REVISION=1 From c1d7ad9631d24ec558c50a2fa8f35803fefc61e8 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 2 Sep 2015 18:28:40 +0800 Subject: [PATCH 1101/1293] Devtools no longer uses iframes --- atom/renderer/lib/inspector.coffee | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/atom/renderer/lib/inspector.coffee b/atom/renderer/lib/inspector.coffee index 569f7e5ec178..126f68f9608e 100644 --- a/atom/renderer/lib/inspector.coffee +++ b/atom/renderer/lib/inspector.coffee @@ -1,11 +1,9 @@ window.onload = -> - inspectorFrame = document.getElementById('inspector-app-iframe').contentWindow - # Use menu API to show context menu. - inspectorFrame.eval 'InspectorFrontendHost.showContextMenuAtPoint = parent.createMenu' + InspectorFrontendHost.showContextMenuAtPoint = createMenu # Use dialog API to override file chooser dialog. - inspectorFrame.eval 'WebInspector.createFileSelectorElement = parent.createFileSelectorElement' + WebInspector.createFileSelectorElement = createFileSelectorElement convertToMenuTemplate = (items) -> template = [] @@ -60,7 +58,3 @@ createFileSelectorElement = (callback) -> fileSelectorElement.style.display = 'none' fileSelectorElement.click = showFileChooserDialog.bind this, callback return fileSelectorElement - -# Exposed for iframe. -window.createMenu = createMenu -window.createFileSelectorElement = createFileSelectorElement From 599e9b90bbfe76d52fdf8e0636f514395d6e3852 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 3 Sep 2015 10:28:50 +0800 Subject: [PATCH 1102/1293] Provide task runner for the node mode --- atom/app/atom_main.cc | 3 ++ atom/app/node_main.cc | 10 +++++- atom/app/uv_task_runner.cc | 55 +++++++++++++++++++++++++++++++ atom/app/uv_task_runner.h | 44 +++++++++++++++++++++++++ atom/browser/bridge_task_runner.h | 2 +- filenames.gypi | 2 ++ 6 files changed, 114 insertions(+), 2 deletions(-) create mode 100644 atom/app/uv_task_runner.cc create mode 100644 atom/app/uv_task_runner.h diff --git a/atom/app/atom_main.cc b/atom/app/atom_main.cc index 47be348522f1..26dcb9421266 100644 --- a/atom/app/atom_main.cc +++ b/atom/app/atom_main.cc @@ -33,6 +33,7 @@ #include "atom/app/node_main.h" #include "atom/common/atom_command_line.h" +#include "base/at_exit.h" #include "base/i18n/icu_util.h" #if defined(OS_WIN) @@ -134,6 +135,7 @@ int APIENTRY wWinMain(HINSTANCE instance, HINSTANCE, wchar_t* cmd, int) { if (env->GetVar("ATOM_SHELL_INTERNAL_RUN_AS_NODE", &node_indicator) && node_indicator == "1") { // Now that argv conversion is done, we can finally start. + base::AtExitManager atexit_manager; base::i18n::InitializeICU(); return atom::NodeMain(argc, argv); } else if (env->GetVar("ATOM_SHELL_INTERNAL_CRASH_SERVICE", @@ -165,6 +167,7 @@ int main(int argc, const char* argv[]) { char* node_indicator = getenv("ATOM_SHELL_INTERNAL_RUN_AS_NODE"); if (node_indicator != NULL && strcmp(node_indicator, "1") == 0) { base::i18n::InitializeICU(); + base::AtExitManager atexit_manager; return atom::NodeMain(argc, const_cast(argv)); } diff --git a/atom/app/node_main.cc b/atom/app/node_main.cc index 356fe03e139d..7efb1b40eece 100644 --- a/atom/app/node_main.cc +++ b/atom/app/node_main.cc @@ -4,10 +4,12 @@ #include "atom/app/node_main.h" +#include "atom/app/uv_task_runner.h" #include "atom/browser/javascript_environment.h" #include "atom/browser/node_debugger.h" #include "atom/common/node_includes.h" #include "base/command_line.h" +#include "base/thread_task_runner_handle.h" #include "gin/array_buffer.h" #include "gin/public/isolate_holder.h" #include "gin/v8_initializer.h" @@ -24,14 +26,20 @@ int NodeMain(int argc, char *argv[]) { int exit_code = 1; { + // Feed gin::PerIsolateData with a task runner. + uv_loop_t* loop = uv_default_loop(); + scoped_refptr uv_task_runner(new UvTaskRunner(loop)); + base::ThreadTaskRunnerHandle handle(uv_task_runner); + gin::V8Initializer::LoadV8Snapshot(); + gin::V8Initializer::LoadV8Natives(); gin::IsolateHolder::Initialize( gin::IsolateHolder::kNonStrictMode, gin::ArrayBufferAllocator::SharedInstance()); JavascriptEnvironment gin_env; node::Environment* env = node::CreateEnvironment( - gin_env.isolate(), uv_default_loop(), gin_env.context(), argc, argv, + gin_env.isolate(), loop, gin_env.context(), argc, argv, exec_argc, exec_argv); // Start our custom debugger implementation. diff --git a/atom/app/uv_task_runner.cc b/atom/app/uv_task_runner.cc new file mode 100644 index 000000000000..23463e44e2ef --- /dev/null +++ b/atom/app/uv_task_runner.cc @@ -0,0 +1,55 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#include "atom/app/uv_task_runner.h" + +#include "base/stl_util.h" + +namespace atom { + +UvTaskRunner::UvTaskRunner(uv_loop_t* loop) : loop_(loop) { +} + +UvTaskRunner::~UvTaskRunner() { + for (auto& iter : tasks_) { + uv_unref(reinterpret_cast(iter.first)); + delete iter.first; + } +} + +bool UvTaskRunner::PostDelayedTask(const tracked_objects::Location& from_here, + const base::Closure& task, + base::TimeDelta delay) { + uv_timer_t* timer = new uv_timer_t; + timer->data = this; + uv_timer_init(loop_, timer); + uv_timer_start(timer, UvTaskRunner::OnTimeout, delay.InMilliseconds(), 0); + tasks_[timer] = task; + return true; +} + +bool UvTaskRunner::RunsTasksOnCurrentThread() const { + return true; +} + +bool UvTaskRunner::PostNonNestableDelayedTask( + const tracked_objects::Location& from_here, + const base::Closure& task, + base::TimeDelta delay) { + return PostDelayedTask(from_here, task, delay);; +} + +// static +void UvTaskRunner::OnTimeout(uv_timer_t* timer) { + UvTaskRunner* self = static_cast(timer->data); + if (!ContainsKey(self->tasks_, timer)) + return; + + self->tasks_[timer].Run(); + self->tasks_.erase(timer); + uv_unref(reinterpret_cast(timer)); + delete timer; +} + +} // namespace atom diff --git a/atom/app/uv_task_runner.h b/atom/app/uv_task_runner.h new file mode 100644 index 000000000000..e4eac0155354 --- /dev/null +++ b/atom/app/uv_task_runner.h @@ -0,0 +1,44 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#ifndef ATOM_APP_UV_TASK_RUNNER_H_ +#define ATOM_APP_UV_TASK_RUNNER_H_ + +#include + +#include "base/callback.h" +#include "base/single_thread_task_runner.h" +#include "vendor/node/deps/uv/include/uv.h" + +namespace atom { + +// TaskRunner implementation that posts tasks into libuv's default loop. +class UvTaskRunner : public base::SingleThreadTaskRunner { + public: + explicit UvTaskRunner(uv_loop_t* loop); + ~UvTaskRunner() override; + + // base::SingleThreadTaskRunner: + bool PostDelayedTask(const tracked_objects::Location& from_here, + const base::Closure& task, + base::TimeDelta delay) override; + bool RunsTasksOnCurrentThread() const override; + bool PostNonNestableDelayedTask( + const tracked_objects::Location& from_here, + const base::Closure& task, + base::TimeDelta delay) override; + + private: + static void OnTimeout(uv_timer_t* timer); + + uv_loop_t* loop_; + + std::map tasks_; + + DISALLOW_COPY_AND_ASSIGN(UvTaskRunner); +}; + +} // namespace atom + +#endif // ATOM_APP_UV_TASK_RUNNER_H_ diff --git a/atom/browser/bridge_task_runner.h b/atom/browser/bridge_task_runner.h index 01bde48eb805..fb42aa3852f9 100644 --- a/atom/browser/bridge_task_runner.h +++ b/atom/browser/bridge_task_runner.h @@ -14,7 +14,7 @@ namespace atom { class BridgeTaskRunner : public base::SingleThreadTaskRunner { public: BridgeTaskRunner() {} - ~BridgeTaskRunner() {} + ~BridgeTaskRunner() override {} // base::SingleThreadTaskRunner: bool PostDelayedTask(const tracked_objects::Location& from_here, diff --git a/filenames.gypi b/filenames.gypi index 3ea01274cf71..807ccd32bb66 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -62,6 +62,8 @@ 'atom/app/atom_main_delegate_mac.mm', 'atom/app/node_main.cc', 'atom/app/node_main.h', + 'atom/app/uv_task_runner.cc', + 'atom/app/uv_task_runner.h', 'atom/browser/api/atom_api_app.cc', 'atom/browser/api/atom_api_app.h', 'atom/browser/api/atom_api_auto_updater.cc', From c81de98d2213ad1a917d96a3eb8a6b8998065439 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 3 Sep 2015 17:54:43 +0900 Subject: [PATCH 1103/1293] Update brightray to Chrome 45 --- vendor/brightray | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/brightray b/vendor/brightray index 0bf81275795b..4d8f5d879d48 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit 0bf81275795b15eb361a1fd213ae9c7c1f60bdea +Subproject commit 4d8f5d879d484db54895c3456ded3a3d3246415d From 2734d67a381f61382c3568151843bd5e127aaf84 Mon Sep 17 00:00:00 2001 From: John-Lin Date: Thu, 3 Sep 2015 17:10:32 +0800 Subject: [PATCH 1104/1293] add Traditional Chinese documents link in README to navigate --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 7f398cbd943b..81196554495f 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,7 @@ contains documents describing how to build and contribute to Electron. - [Japanese](https://github.com/atom/electron/tree/master/docs-translations/jp) - [Spanish](https://github.com/atom/electron/tree/master/docs-translations/es) - [Simplified Chinese](https://github.com/atom/electron/tree/master/docs-translations/zh-CN) +- [Traditional Chinese](https://github.com/atom/electron/tree/master/docs-translations/zh-TW) ## Community From 73af4c017d458026986e86931834fa27b64069df Mon Sep 17 00:00:00 2001 From: Takashi Nakagawa Date: Thu, 3 Sep 2015 18:17:51 +0900 Subject: [PATCH 1105/1293] remove -jp suffix from quick-start-jp.md --- docs-translations/jp/{quick-start-jp.md => quick-start.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs-translations/jp/{quick-start-jp.md => quick-start.md} (100%) diff --git a/docs-translations/jp/quick-start-jp.md b/docs-translations/jp/quick-start.md similarity index 100% rename from docs-translations/jp/quick-start-jp.md rename to docs-translations/jp/quick-start.md From 53b9d618311b878099c1939b034786ce6ae7f381 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 3 Sep 2015 20:07:29 +0800 Subject: [PATCH 1106/1293] Fix building on Windows --- atom/browser/net/asar/url_request_asar_job.cc | 2 +- atom/browser/ui/file_dialog_win.cc | 2 +- chromium_src/chrome/browser/printing/pdf_to_emf_converter.cc | 3 +-- chromium_src/chrome/common/chrome_utility_messages.h | 2 +- script/lib/config.py | 2 +- 5 files changed, 5 insertions(+), 6 deletions(-) diff --git a/atom/browser/net/asar/url_request_asar_job.cc b/atom/browser/net/asar/url_request_asar_job.cc index 88195a0d7c79..9b9a3c69d27f 100644 --- a/atom/browser/net/asar/url_request_asar_job.cc +++ b/atom/browser/net/asar/url_request_asar_job.cc @@ -172,7 +172,7 @@ bool URLRequestAsarJob::IsRedirectResponse(GURL* location, #if defined(OS_WIN) // Follow a Windows shortcut. // We just resolve .lnk file, ignore others. - if (!LowerCaseEqualsASCII(file_path_.Extension(), ".lnk")) + if (!base::LowerCaseEqualsASCII(file_path_.Extension(), ".lnk")) return false; base::FilePath new_path = file_path_; diff --git a/atom/browser/ui/file_dialog_win.cc b/atom/browser/ui/file_dialog_win.cc index 7fa68d521135..b169471c6e99 100644 --- a/atom/browser/ui/file_dialog_win.cc +++ b/atom/browser/ui/file_dialog_win.cc @@ -252,7 +252,7 @@ bool ShowSaveDialog(atom::NativeWindow* parent_window, bool matched = false; for (size_t i = 0; i < filter.second.size(); ++i) { - if (EndsWith(file_name, filter.second[i], false)) { + if (base::EndsWith(file_name, filter.second[i], false)) { matched = true; break;; } diff --git a/chromium_src/chrome/browser/printing/pdf_to_emf_converter.cc b/chromium_src/chrome/browser/printing/pdf_to_emf_converter.cc index 89bac3b68dca..9064cd961bd5 100644 --- a/chromium_src/chrome/browser/printing/pdf_to_emf_converter.cc +++ b/chromium_src/chrome/browser/printing/pdf_to_emf_converter.cc @@ -296,8 +296,7 @@ void PdfToEmfUtilityProcessHostClient::Start( // generate when sent to a metafile DC. utility_process_host_ = content::UtilityProcessHost::Create( - this, base::MessageLoop::current()->message_loop_proxy()) - ->AsWeakPtr(); + this, base::MessageLoop::current()->task_runner())->AsWeakPtr(); if (!utility_process_host_) return OnFailed(); // Should reply with OnProcessStarted(). diff --git a/chromium_src/chrome/common/chrome_utility_messages.h b/chromium_src/chrome/common/chrome_utility_messages.h index 1de0756c0d58..f146e1823e81 100644 --- a/chromium_src/chrome/common/chrome_utility_messages.h +++ b/chromium_src/chrome/common/chrome_utility_messages.h @@ -27,7 +27,7 @@ #if defined(OS_WIN) // A vector of filters, each being a Tuple containing a display string (i.e. // "Text Files") and a filter pattern (i.e. "*.txt"). -typedef std::vector> +typedef std::vector> GetOpenFileNameFilter; #endif // OS_WIN diff --git a/script/lib/config.py b/script/lib/config.py index 3292823091ab..3fed12000b48 100644 --- a/script/lib/config.py +++ b/script/lib/config.py @@ -8,7 +8,7 @@ import sys BASE_URL = os.getenv('LIBCHROMIUMCONTENT_MIRROR') or \ 'http://github-janky-artifacts.s3.amazonaws.com/libchromiumcontent' -LIBCHROMIUMCONTENT_COMMIT = '367552dc926aff4577e4743333922e7e6075c8e0' +LIBCHROMIUMCONTENT_COMMIT = 'f5489a774b719e9e979675c17b99ed45a05aacf7' PLATFORM = { 'cygwin': 'win32', From 3f546e6babbc9becc844cfb626045def83a358be Mon Sep 17 00:00:00 2001 From: Fritz Lin Date: Thu, 3 Sep 2015 22:27:22 +0800 Subject: [PATCH 1107/1293] Add docs-translations for zh-CN - development/coding-style - development/atom-shell-vs-node-webkit --- .../development/atom-shell-vs-node-webkit.md | 29 ++++++++++++++++++ .../zh-CN/development/coding-style.md | 30 +++++++++++++++++++ 2 files changed, 59 insertions(+) create mode 100644 docs-translations/zh-CN/development/atom-shell-vs-node-webkit.md create mode 100644 docs-translations/zh-CN/development/coding-style.md diff --git a/docs-translations/zh-CN/development/atom-shell-vs-node-webkit.md b/docs-translations/zh-CN/development/atom-shell-vs-node-webkit.md new file mode 100644 index 000000000000..cf6859d50645 --- /dev/null +++ b/docs-translations/zh-CN/development/atom-shell-vs-node-webkit.md @@ -0,0 +1,29 @@ +# Electron 和 NW.js (原名 node-webkit) 在技术上的差异 + +__备注：Electron 的原名是 Atom Shell。__ + +与 NW.js 相似，Electron 提供了一个能通过 JavaScript 和 HTML 创建桌面应用的平台，同时集成 Node 来授予网页访问底层系统的权限。 + +但是这两个项目也有本质上的区别，使得 Electron 和 NW.js 成为两个相互独立的产品。 + +__1. 应用的入口__ + +在 NW.js 中，一个应用的主入口是一个页面。你在 `package.json` 中指定一个主页面，它会作为应用的主窗口被打开。 + +在 Electron 中，入口是一个 JavaScript 脚本。不同于直接提供一个URL，你需要手动创建一个浏览器窗口，然后通过 API 加载 HTML 文件。你还可以监听窗口事件，决定何时让应用退出。 + +Electron 的工作方式更像 Node.js 运行时。 Electron 的 APIs 更加底层，因此你可以它替代 [PhantomJS](http://phantomjs.org/) 做浏览器测试。 + +__2. 构建系统__ + +为了避免构建整个 Chromium 带来的复杂度，Electron 通过 [`libchromiumcontent`](https://github.com/brightray/libchromiumcontent) 来访问 Chromium 的 Content API。`libchromiumcontent` 是一个独立的、引入了 Chromium Content 模块及其所有依赖的共享库。用户不需要一个强劲的机器来构建 Electron。 + +__3. Node 集成__ + +在 NW.js，网页中的 Node 集成需要通过给 Chromium 打补丁来实现。但在 Electron 中，我们选择了另一种方式：通过各个平台的消息循环与 libuv 的循环集成，避免了直接在 Chromium 上做改动。你可以看 [`node_bindings`](../../atom/common/) 来了解这是如何完成的。 + +__4. 多上下文__ + +如果你是有经验的 NW.js 用户，你应该会熟悉 Node 上下文和 web 上下文的概念。这些概念的产生源于 NW.js 的实现方式。 + +通过使用 Node 的[多上下文](http://strongloop.com/strongblog/whats-new-node-js-v0-12-multiple-context-execution/)特性，Electron不需要在网页中引入新的 JavaScript 上下文。 diff --git a/docs-translations/zh-CN/development/coding-style.md b/docs-translations/zh-CN/development/coding-style.md new file mode 100644 index 000000000000..82219467b16e --- /dev/null +++ b/docs-translations/zh-CN/development/coding-style.md @@ -0,0 +1,30 @@ +# 编码规范 + +以下是 Electron 项目中代码书写规范的指导方针。 + +## C++ 和 Python + +对于 C++ 和 Python，我们追随 Chromium 的[Coding +Style](http://www.chromium.org/developers/coding-style)。你可以通过 `script/cpplint.py` 来检验所有文件是否符合要求。 + +我们使用的 Pyhton 版本是 Python 2.7。 + +其中 C++ 代码中用到了许多 Chromium 的抽象和类型，我们希望你对其有所熟悉。一个好的去处是 +Chromium 的[重要的抽象和数据结构](https://www.chromium.org/developers/coding-style/important-abstractions-and-data-structures)。这个文档提到了一些特殊的类型、域内类型（当超出作用域时会自动释放内存）、日志机制等等。 + +## CoffeeScript + +对于 CoffeeScript，我们追随 GitHub 的[Style +Guide](https://github.com/styleguide/javascript) 及如下规则: + +* 文件不应该以换行结尾，因为我们要匹配 Google 的规范。 +* 文件名应该以 `-` 作连接而不是 `_`，等等。 + `file-name.coffee` 而不是 `file_name.coffee`，因为在 + [github/atom](https://github.com/github/atom) 模块名通常都是 `module-name` 的形式。这条规则仅应用于 `.coffee` 文件。 + +## API 名称 + +当新建一个API时，我们应该倾向于 getters 和 setters 的方式，而不是 +jQuery 的单函数形式。例如，`.getText()` 和 `.setText(text)` + 优于 `.text([text])`。这里是相关的 +[讨论记录](https://github.com/atom/electron/issues/46)。 From d180d3b1682e2d633ceb4e09bb675a1c463d8da5 Mon Sep 17 00:00:00 2001 From: Robo Date: Thu, 6 Aug 2015 20:31:05 +0530 Subject: [PATCH 1108/1293] webview: fix partition attribute --- atom/browser/api/atom_api_web_contents.cc | 10 ++++-- atom/browser/api/atom_api_web_view_manager.cc | 3 +- atom/browser/atom_browser_main_parts.cc | 32 +++++++++++++++++++ atom/browser/atom_browser_main_parts.h | 10 ++++++ atom/browser/lib/guest-view-manager.coffee | 13 +++++++- atom/browser/web_view_manager.cc | 15 +++++---- atom/browser/web_view_manager.h | 4 ++- 7 files changed, 74 insertions(+), 13 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 5b723801cdeb..da33451c1e7c 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -159,16 +159,20 @@ WebContents::WebContents(const mate::Dictionary& options) { type_ = is_guest ? WEB_VIEW : BROWSER_WINDOW; - auto browser_context = AtomBrowserMainParts::Get()->browser_context(); content::WebContents* web_contents; if (is_guest) { - content::SiteInstance* site_instance = content::SiteInstance::CreateForURL( - browser_context, GURL("chrome-guest://fake-host")); + GURL guest_site; + options.Get("partition", &guest_site); + auto browser_context = + AtomBrowserMainParts::Get()->GetBrowserContextForPartition(guest_site); + auto site_instance = + content::SiteInstance::CreateForURL(browser_context, guest_site); content::WebContents::CreateParams params(browser_context, site_instance); guest_delegate_.reset(new WebViewGuestDelegate); params.guest_delegate = guest_delegate_.get(); web_contents = content::WebContents::Create(params); } else { + auto browser_context = AtomBrowserMainParts::Get()->browser_context(); content::WebContents::CreateParams params(browser_context); web_contents = content::WebContents::Create(params); } diff --git a/atom/browser/api/atom_api_web_view_manager.cc b/atom/browser/api/atom_api_web_view_manager.cc index d77ea18d6d0c..c69285a6980d 100644 --- a/atom/browser/api/atom_api_web_view_manager.cc +++ b/atom/browser/api/atom_api_web_view_manager.cc @@ -43,7 +43,8 @@ struct Converter { return options.Get("nodeIntegration", &(out->node_integration)) && options.Get("plugins", &(out->plugins)) && - options.Get("disableWebSecurity", &(out->disable_web_security)); + options.Get("disableWebSecurity", &(out->disable_web_security)) && + options.Get("partitionId", &(out->partition_id)); } }; diff --git a/atom/browser/atom_browser_main_parts.cc b/atom/browser/atom_browser_main_parts.cc index b4f61d0f195e..189fc938698e 100644 --- a/atom/browser/atom_browser_main_parts.cc +++ b/atom/browser/atom_browser_main_parts.cc @@ -26,6 +26,21 @@ namespace atom { +namespace { + +const base::FilePath::CharType kStoragePartitionDirName[] = "Partitions"; + +void GetStoragePartitionConfig(const GURL& partition, + base::FilePath* partition_path, + bool* in_memory, + std::string* id) { + *in_memory = (partition.path() != "/persist"); + *id = partition.query(); + *partition_path = base::FilePath(kStoragePartitionDirName).AppendASCII(*id); +} + +} // namespace + // static AtomBrowserMainParts* AtomBrowserMainParts::self_ = NULL; @@ -40,6 +55,7 @@ AtomBrowserMainParts::AtomBrowserMainParts() } AtomBrowserMainParts::~AtomBrowserMainParts() { + STLDeleteValues(&browser_context_map_); for (const auto& callback : destruction_callbacks_) callback.Run(); } @@ -50,6 +66,22 @@ AtomBrowserMainParts* AtomBrowserMainParts::Get() { return self_; } +content::BrowserContext* AtomBrowserMainParts::GetBrowserContextForPartition( + const GURL& partition) { + std::string id; + bool in_memory; + base::FilePath partition_path; + GetStoragePartitionConfig(partition, &partition_path, &in_memory, &id); + auto item = browser_context_map_.find(id); + if (item != browser_context_map_.end()) + return item->second; + + auto browser_context = CreateBrowserContext(); + browser_context->Initialize(partition_path, in_memory); + browser_context_map_[id] = browser_context; + return browser_context; +} + void AtomBrowserMainParts::RegisterDestructionCallback( const base::Closure& callback) { destruction_callbacks_.push_back(callback); diff --git a/atom/browser/atom_browser_main_parts.h b/atom/browser/atom_browser_main_parts.h index a2909cac53d0..993340bfb422 100644 --- a/atom/browser/atom_browser_main_parts.h +++ b/atom/browser/atom_browser_main_parts.h @@ -6,10 +6,13 @@ #define ATOM_BROWSER_ATOM_BROWSER_MAIN_PARTS_H_ #include +#include +#include #include "base/callback.h" #include "base/timer/timer.h" #include "brightray/browser/browser_main_parts.h" +#include "content/public/browser/browser_context.h" class BrowserProcess; @@ -29,6 +32,10 @@ class AtomBrowserMainParts : public brightray::BrowserMainParts { static AtomBrowserMainParts* Get(); + // Returns the BrowserContext associated with the partition. + content::BrowserContext* GetBrowserContextForPartition( + const GURL& partition); + // Register a callback that should be destroyed before JavaScript environment // gets destroyed. void RegisterDestructionCallback(const base::Closure& callback); @@ -70,6 +77,9 @@ class AtomBrowserMainParts : public brightray::BrowserMainParts { // List of callbacks should be executed before destroying JS env. std::list destruction_callbacks_; + // partition_id => browser_context + std::map browser_context_map_; + static AtomBrowserMainParts* self_; DISALLOW_COPY_AND_ASSIGN(AtomBrowserMainParts); diff --git a/atom/browser/lib/guest-view-manager.coffee b/atom/browser/lib/guest-view-manager.coffee index 398cdb5d9495..c0a87a7ac1cb 100644 --- a/atom/browser/lib/guest-view-manager.coffee +++ b/atom/browser/lib/guest-view-manager.coffee @@ -1,3 +1,4 @@ +crypto = require 'crypto' ipc = require 'ipc' webContents = require 'web-contents' webViewManager = null # Doesn't exist in early initialization. @@ -38,12 +39,21 @@ moveLastToFirst = (list) -> getNextInstanceId = (webContents) -> ++nextInstanceId +# Generate URL encoded partition id. +getPartitionId = (partition='default') -> + persist = partition.startsWith('persist:') + # Guest site url will be chrome-guest://fake-host/{persist}?{partitionId} + partitionId = "chrome-guest://fake-host/" + partitionId += if persist then 'persist?' else '?' + partitionId += crypto.createHash('sha256').update(partition).digest('hex') + # Create a new guest instance. createGuest = (embedder, params) -> webViewManager ?= process.atomBinding 'web_view_manager' id = getNextInstanceId embedder - guest = webContents.create {isGuest: true, embedder} + partitionId = getPartitionId params.partition + guest = webContents.create {isGuest: true, partition: partitionId, embedder} guestInstances[id] = {guest, embedder} # Destroy guest when the embedder is gone or navigated. @@ -120,6 +130,7 @@ attachGuest = (embedder, elementInstanceId, guestInstanceId, params) -> plugins: params.plugins disableWebSecurity: params.disablewebsecurity preloadUrl: params.preload ? '' + partitionId: getPartitionId(params.partition) guest.attachParams = params embedderElementsMap[key] = guestInstanceId diff --git a/atom/browser/web_view_manager.cc b/atom/browser/web_view_manager.cc index 7dba6c06dd38..50e07230197f 100644 --- a/atom/browser/web_view_manager.cc +++ b/atom/browser/web_view_manager.cc @@ -48,7 +48,7 @@ void WebViewManager::AddGuest(int guest_instance_id, content::WebContents* web_contents, const WebViewInfo& info) { base::AutoLock auto_lock(lock_); - web_contents_embdder_map_[guest_instance_id] = { web_contents, embedder }; + web_contents_embedder_map_[guest_instance_id] = { web_contents, embedder }; webview_info_map_[web_contents] = info; // Map the element in embedder to guest. @@ -59,11 +59,12 @@ void WebViewManager::AddGuest(int guest_instance_id, void WebViewManager::RemoveGuest(int guest_instance_id) { base::AutoLock auto_lock(lock_); - if (!ContainsKey(web_contents_embdder_map_, guest_instance_id)) + if (!ContainsKey(web_contents_embedder_map_, guest_instance_id)) return; - auto web_contents = web_contents_embdder_map_[guest_instance_id].web_contents; - web_contents_embdder_map_.erase(guest_instance_id); + auto web_contents = + web_contents_embedder_map_[guest_instance_id].web_contents; + web_contents_embedder_map_.erase(guest_instance_id); webview_info_map_.erase(web_contents); // Remove the record of element in embedder too. @@ -82,15 +83,15 @@ content::WebContents* WebViewManager::GetGuestByInstanceID( return nullptr; int guest_instance_id = element_instance_id_to_guest_map_[key]; - if (ContainsKey(web_contents_embdder_map_, guest_instance_id)) - return web_contents_embdder_map_[guest_instance_id].web_contents; + if (ContainsKey(web_contents_embedder_map_, guest_instance_id)) + return web_contents_embedder_map_[guest_instance_id].web_contents; else return nullptr; } bool WebViewManager::ForEachGuest(content::WebContents* embedder_web_contents, const GuestCallback& callback) { - for (auto& item : web_contents_embdder_map_) + for (auto& item : web_contents_embedder_map_) if (item.second.embedder == embedder_web_contents && callback.Run(item.second.web_contents)) return true; diff --git a/atom/browser/web_view_manager.h b/atom/browser/web_view_manager.h index b1bea92702cc..d8ed857b444f 100644 --- a/atom/browser/web_view_manager.h +++ b/atom/browser/web_view_manager.h @@ -10,6 +10,7 @@ #include "base/files/file_path.h" #include "base/synchronization/lock.h" #include "content/public/browser/browser_plugin_guest_manager.h" +#include "content/public/browser/site_instance.h" namespace content { class BrowserContext; @@ -27,6 +28,7 @@ class WebViewManager : public content::BrowserPluginGuestManager { bool plugins; bool disable_web_security; base::FilePath preload_script; + GURL partition_id; }; // Finds the WebViewManager attached with |web_contents| and returns the @@ -57,7 +59,7 @@ class WebViewManager : public content::BrowserPluginGuestManager { content::WebContents* embedder; }; // guest_instance_id => (web_contents, embedder) - std::map web_contents_embdder_map_; + std::map web_contents_embedder_map_; struct ElementInstanceKey { int embedder_process_id; From 5189147021d9ca6d80c7cd53649b6a3b999dd7cb Mon Sep 17 00:00:00 2001 From: Robo Date: Thu, 27 Aug 2015 05:58:06 +0530 Subject: [PATCH 1109/1293] use embedders' browser context to retrieve webviewmanager --- atom/browser/web_view_manager.cc | 17 ++++------------- 1 file changed, 4 insertions(+), 13 deletions(-) diff --git a/atom/browser/web_view_manager.cc b/atom/browser/web_view_manager.cc index 50e07230197f..76915264c6fd 100644 --- a/atom/browser/web_view_manager.cc +++ b/atom/browser/web_view_manager.cc @@ -5,27 +5,18 @@ #include "atom/browser/web_view_manager.h" #include "atom/browser/atom_browser_context.h" +#include "atom/browser/atom_browser_main_parts.h" #include "content/public/browser/render_process_host.h" #include "content/public/browser/web_contents.h" namespace atom { -namespace { - -WebViewManager* GetManagerFromWebContents( - const content::WebContents* web_contents) { - auto context = web_contents->GetBrowserContext(); - if (!context) - return nullptr; - return static_cast(context->GetGuestManager()); -} - -} // namespace - // static bool WebViewManager::GetInfoForWebContents( const content::WebContents* web_contents, WebViewInfo* info) { - auto manager = GetManagerFromWebContents(web_contents); + // use embedders' browser context to retrieve WebViewManager. + auto manager = static_cast( + AtomBrowserMainParts::Get()->browser_context()->GetGuestManager()); if (!manager) return false; base::AutoLock auto_lock(manager->lock_); From 150b540e722c971a74304b303f2b16325b9477c5 Mon Sep 17 00:00:00 2001 From: Robo Date: Thu, 27 Aug 2015 06:57:03 +0530 Subject: [PATCH 1110/1293] add spec and docs --- docs/api/web-view-tag.md | 17 ++++++++++++++++ spec/fixtures/pages/partition/one.html | 5 +++++ spec/fixtures/pages/partition/two.html | 4 ++++ spec/webview-spec.coffee | 27 ++++++++++++++++++++++++++ 4 files changed, 53 insertions(+) create mode 100644 spec/fixtures/pages/partition/one.html create mode 100644 spec/fixtures/pages/partition/two.html diff --git a/docs/api/web-view-tag.md b/docs/api/web-view-tag.md index 6b64a0269c52..ec8529655272 100644 --- a/docs/api/web-view-tag.md +++ b/docs/api/web-view-tag.md @@ -131,6 +131,23 @@ page is loaded, use the `setUserAgent` method to change the user agent. If "on", the guest page will have web security disabled. +### partition + +```html + + +``` + +Sets the storage partition used by the `webview`. If the storage partition ID starts with `persist:`, +the `webview` will use a persistent storage partition available to all `webview` in the app with +the same storage partition ID. If the ID is unset or if there is no `persist:` prefix, the `webview` will +use an in-memory storage partition. By assigning the same partition ID, multiple `webview` +can share the same storage partition. + +This value can only be modified before the first navigation, since the storage partition of an active +renderer process cannot change. Subsequent attempts to modify the value will fail with a +DOM exception. + ## Methods The `webview` tag has the following methods: diff --git a/spec/fixtures/pages/partition/one.html b/spec/fixtures/pages/partition/one.html new file mode 100644 index 000000000000..765f721883f3 --- /dev/null +++ b/spec/fixtures/pages/partition/one.html @@ -0,0 +1,5 @@ + diff --git a/spec/fixtures/pages/partition/two.html b/spec/fixtures/pages/partition/two.html new file mode 100644 index 000000000000..ad22c341df95 --- /dev/null +++ b/spec/fixtures/pages/partition/two.html @@ -0,0 +1,4 @@ + diff --git a/spec/webview-spec.coffee b/spec/webview-spec.coffee index 6eb391ac9483..ae8cd5d45579 100644 --- a/spec/webview-spec.coffee +++ b/spec/webview-spec.coffee @@ -154,6 +154,33 @@ describe ' tag', -> webview.src = "data:text/html;base64,#{encoded}" document.body.appendChild webview + describe 'partition attribute', -> + isolatedWebview = null + beforeEach -> + isolatedWebview = new WebView + + afterEach -> + document.body.removeChild isolatedWebview + + it 'isolates storage for different id', (done) -> + listener = (e) -> + document.body.appendChild isolatedWebview + webview.removeEventListener 'did-finish-load', listener + listener2 = (e) -> + assert.equal e.message, "one 1" + webview.removeEventListener 'console-message', listener2 + listener3 = (e) -> + assert.equal e.message, " 0" + isolatedWebview.removeEventListener 'console-message', listener3 + done() + webview.addEventListener 'did-finish-load', listener + webview.addEventListener 'console-message', listener2 + webview.src = "file://#{fixtures}/pages/partition/one.html" + isolatedWebview.addEventListener 'console-message', listener3 + isolatedWebview.setAttribute 'partition', 'test' + isolatedWebview.src = "file://#{fixtures}/pages/partition/two.html" + document.body.appendChild webview + describe 'new-window event', -> it 'emits when window.open is called', (done) -> webview.addEventListener 'new-window', (e) -> From da5bac42f3efb9f28ed9dbb00747ba6052bc6250 Mon Sep 17 00:00:00 2001 From: Robo Date: Fri, 28 Aug 2015 13:00:50 +0530 Subject: [PATCH 1111/1293] use embedders' browser context when partition is not specified --- atom/browser/api/atom_api_web_contents.cc | 10 +++++++--- atom/browser/lib/guest-view-manager.coffee | 8 +++++--- docs/api/web-view-tag.md | 2 +- 3 files changed, 13 insertions(+), 7 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index da33451c1e7c..7cefe8e45e3d 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -159,12 +159,17 @@ WebContents::WebContents(const mate::Dictionary& options) { type_ = is_guest ? WEB_VIEW : BROWSER_WINDOW; + content::BrowserContext* browser_context = + AtomBrowserMainParts::Get()->browser_context(); content::WebContents* web_contents; if (is_guest) { GURL guest_site; options.Get("partition", &guest_site); - auto browser_context = - AtomBrowserMainParts::Get()->GetBrowserContextForPartition(guest_site); + // use hosts' browser_context when no partition is specified. + if (!guest_site.query().empty()) { + browser_context = AtomBrowserMainParts::Get() + ->GetBrowserContextForPartition(guest_site); + } auto site_instance = content::SiteInstance::CreateForURL(browser_context, guest_site); content::WebContents::CreateParams params(browser_context, site_instance); @@ -172,7 +177,6 @@ WebContents::WebContents(const mate::Dictionary& options) { params.guest_delegate = guest_delegate_.get(); web_contents = content::WebContents::Create(params); } else { - auto browser_context = AtomBrowserMainParts::Get()->browser_context(); content::WebContents::CreateParams params(browser_context); web_contents = content::WebContents::Create(params); } diff --git a/atom/browser/lib/guest-view-manager.coffee b/atom/browser/lib/guest-view-manager.coffee index c0a87a7ac1cb..8d86e8fae911 100644 --- a/atom/browser/lib/guest-view-manager.coffee +++ b/atom/browser/lib/guest-view-manager.coffee @@ -40,12 +40,14 @@ getNextInstanceId = (webContents) -> ++nextInstanceId # Generate URL encoded partition id. -getPartitionId = (partition='default') -> +getPartitionId = (partition) -> persist = partition.startsWith('persist:') # Guest site url will be chrome-guest://fake-host/{persist}?{partitionId} partitionId = "chrome-guest://fake-host/" - partitionId += if persist then 'persist?' else '?' - partitionId += crypto.createHash('sha256').update(partition).digest('hex') + if partition + partitionId += if persist then 'persist?' else '?' + partitionId += crypto.createHash('sha256').update(partition).digest('hex') + return partitionId # Create a new guest instance. createGuest = (embedder, params) -> diff --git a/docs/api/web-view-tag.md b/docs/api/web-view-tag.md index ec8529655272..cafcc5762e7a 100644 --- a/docs/api/web-view-tag.md +++ b/docs/api/web-view-tag.md @@ -140,7 +140,7 @@ If "on", the guest page will have web security disabled. Sets the storage partition used by the `webview`. If the storage partition ID starts with `persist:`, the `webview` will use a persistent storage partition available to all `webview` in the app with -the same storage partition ID. If the ID is unset or if there is no `persist:` prefix, the `webview` will +the same storage partition ID. if there is no `persist:` prefix, the `webview` will use an in-memory storage partition. By assigning the same partition ID, multiple `webview` can share the same storage partition. From 8f59c0b642b133a0df7bacd3a7a4c15b951ba259 Mon Sep 17 00:00:00 2001 From: Robo Date: Mon, 31 Aug 2015 23:53:31 +0530 Subject: [PATCH 1112/1293] create partitionId with encodedURIcomponent --- atom/browser/atom_browser_main_parts.cc | 22 +++++++-------- atom/browser/atom_browser_main_parts.h | 4 ++- atom/browser/lib/guest-view-manager.coffee | 11 +++++--- docs/api/web-view-tag.md | 3 +- spec/fixtures/pages/partition/one.html | 1 - spec/fixtures/pages/partition/two.html | 4 --- spec/webview-spec.coffee | 33 +++++++++------------- 7 files changed, 37 insertions(+), 41 deletions(-) delete mode 100644 spec/fixtures/pages/partition/two.html diff --git a/atom/browser/atom_browser_main_parts.cc b/atom/browser/atom_browser_main_parts.cc index 189fc938698e..4463115cfee5 100644 --- a/atom/browser/atom_browser_main_parts.cc +++ b/atom/browser/atom_browser_main_parts.cc @@ -28,15 +28,17 @@ namespace atom { namespace { -const base::FilePath::CharType kStoragePartitionDirName[] = "Partitions"; +const base::FilePath::CharType kStoragePartitionDirname[] = "Partitions"; void GetStoragePartitionConfig(const GURL& partition, base::FilePath* partition_path, bool* in_memory, std::string* id) { *in_memory = (partition.path() != "/persist"); - *id = partition.query(); - *partition_path = base::FilePath(kStoragePartitionDirName).AppendASCII(*id); + net::UnescapeRule::Type flags = + net::UnescapeRule::SPACES | net::UnescapeRule::URL_SPECIAL_CHARS; + *id = net::UnescapeURLComponent(partition.query(), flags); + *partition_path = base::FilePath(kStoragePartitionDirname).AppendASCII(*id); } } // namespace @@ -55,7 +57,6 @@ AtomBrowserMainParts::AtomBrowserMainParts() } AtomBrowserMainParts::~AtomBrowserMainParts() { - STLDeleteValues(&browser_context_map_); for (const auto& callback : destruction_callbacks_) callback.Run(); } @@ -72,14 +73,13 @@ content::BrowserContext* AtomBrowserMainParts::GetBrowserContextForPartition( bool in_memory; base::FilePath partition_path; GetStoragePartitionConfig(partition, &partition_path, &in_memory, &id); - auto item = browser_context_map_.find(id); - if (item != browser_context_map_.end()) - return item->second; + if (browser_context_map_.contains(id)) + return browser_context_map_.get(id); - auto browser_context = CreateBrowserContext(); - browser_context->Initialize(partition_path, in_memory); - browser_context_map_[id] = browser_context; - return browser_context; + scoped_ptr browser_context(CreateBrowserContext()); + browser_context->Initialize(partition_path.value(), in_memory); + browser_context_map_.set(id, browser_context.Pass()); + return browser_context_map_.get(id); } void AtomBrowserMainParts::RegisterDestructionCallback( diff --git a/atom/browser/atom_browser_main_parts.h b/atom/browser/atom_browser_main_parts.h index 993340bfb422..d952f432882f 100644 --- a/atom/browser/atom_browser_main_parts.h +++ b/atom/browser/atom_browser_main_parts.h @@ -10,6 +10,7 @@ #include #include "base/callback.h" +#include "base/containers/scoped_ptr_hash_map.h" #include "base/timer/timer.h" #include "brightray/browser/browser_main_parts.h" #include "content/public/browser/browser_context.h" @@ -78,7 +79,8 @@ class AtomBrowserMainParts : public brightray::BrowserMainParts { std::list destruction_callbacks_; // partition_id => browser_context - std::map browser_context_map_; + base::ScopedPtrHashMap> + browser_context_map_; static AtomBrowserMainParts* self_; diff --git a/atom/browser/lib/guest-view-manager.coffee b/atom/browser/lib/guest-view-manager.coffee index 8d86e8fae911..2f1c8312155a 100644 --- a/atom/browser/lib/guest-view-manager.coffee +++ b/atom/browser/lib/guest-view-manager.coffee @@ -1,4 +1,3 @@ -crypto = require 'crypto' ipc = require 'ipc' webContents = require 'web-contents' webViewManager = null # Doesn't exist in early initialization. @@ -41,12 +40,16 @@ getNextInstanceId = (webContents) -> # Generate URL encoded partition id. getPartitionId = (partition) -> - persist = partition.startsWith('persist:') # Guest site url will be chrome-guest://fake-host/{persist}?{partitionId} partitionId = "chrome-guest://fake-host/" if partition - partitionId += if persist then 'persist?' else '?' - partitionId += crypto.createHash('sha256').update(partition).digest('hex') + persist = partition.startsWith('persist:') + if persist + partition = partition.substring('persist:'.length) + partitionId += 'persist?' + else + partitionId += '?' + partitionId += encodeURIComponent(partition) return partitionId # Create a new guest instance. diff --git a/docs/api/web-view-tag.md b/docs/api/web-view-tag.md index cafcc5762e7a..c1b1f705e95b 100644 --- a/docs/api/web-view-tag.md +++ b/docs/api/web-view-tag.md @@ -142,7 +142,8 @@ Sets the storage partition used by the `webview`. If the storage partition ID st the `webview` will use a persistent storage partition available to all `webview` in the app with the same storage partition ID. if there is no `persist:` prefix, the `webview` will use an in-memory storage partition. By assigning the same partition ID, multiple `webview` -can share the same storage partition. +can share the same storage partition. If the storage partition ID is unset then default storage +of the app will be used. This value can only be modified before the first navigation, since the storage partition of an active renderer process cannot change. Subsequent attempts to modify the value will fail with a diff --git a/spec/fixtures/pages/partition/one.html b/spec/fixtures/pages/partition/one.html index 765f721883f3..ad22c341df95 100644 --- a/spec/fixtures/pages/partition/one.html +++ b/spec/fixtures/pages/partition/one.html @@ -1,5 +1,4 @@ diff --git a/spec/fixtures/pages/partition/two.html b/spec/fixtures/pages/partition/two.html deleted file mode 100644 index ad22c341df95..000000000000 --- a/spec/fixtures/pages/partition/two.html +++ /dev/null @@ -1,4 +0,0 @@ - diff --git a/spec/webview-spec.coffee b/spec/webview-spec.coffee index ae8cd5d45579..486efaa6ffb4 100644 --- a/spec/webview-spec.coffee +++ b/spec/webview-spec.coffee @@ -155,30 +155,25 @@ describe ' tag', -> document.body.appendChild webview describe 'partition attribute', -> - isolatedWebview = null - beforeEach -> - isolatedWebview = new WebView - - afterEach -> - document.body.removeChild isolatedWebview - it 'isolates storage for different id', (done) -> listener = (e) -> - document.body.appendChild isolatedWebview - webview.removeEventListener 'did-finish-load', listener - listener2 = (e) -> - assert.equal e.message, "one 1" - webview.removeEventListener 'console-message', listener2 - listener3 = (e) -> assert.equal e.message, " 0" - isolatedWebview.removeEventListener 'console-message', listener3 + webview.removeEventListener 'console-message', listener done() - webview.addEventListener 'did-finish-load', listener - webview.addEventListener 'console-message', listener2 + window.localStorage.setItem 'test', 'one' + webview.addEventListener 'console-message', listener + webview.src = "file://#{fixtures}/pages/partition/one.html" + webview.partition = "test" + document.body.appendChild webview + + it 'uses current session storage when no id is provided', (done) -> + listener = (e) -> + assert.equal e.message, "one 1" + webview.removeEventListener 'console-message', listener + done() + window.localStorage.setItem 'test', 'one' + webview.addEventListener 'console-message', listener webview.src = "file://#{fixtures}/pages/partition/one.html" - isolatedWebview.addEventListener 'console-message', listener3 - isolatedWebview.setAttribute 'partition', 'test' - isolatedWebview.src = "file://#{fixtures}/pages/partition/two.html" document.body.appendChild webview describe 'new-window event', -> From 03ba9533fbfbce42e1770c581b04fde9fcec4856 Mon Sep 17 00:00:00 2001 From: Robo Date: Thu, 3 Sep 2015 06:17:58 +0530 Subject: [PATCH 1113/1293] store webviewinfo as web contents userdata --- atom/browser/api/atom_api_web_view_manager.cc | 26 +++++++++++------- atom/browser/atom_browser_client.cc | 14 +++++++--- atom/browser/lib/guest-view-manager.coffee | 2 ++ atom/browser/web_view_constants.cc | 24 +++++++++++++++++ atom/browser/web_view_constants.h | 27 +++++++++++++++++++ atom/browser/web_view_guest_delegate.cc | 10 ++----- atom/browser/web_view_manager.cc | 23 +--------------- atom/browser/web_view_manager.h | 23 +++++++++------- filenames.gypi | 2 ++ spec/webview-spec.coffee | 17 ++++++++++++ 10 files changed, 114 insertions(+), 54 deletions(-) create mode 100644 atom/browser/web_view_constants.cc create mode 100644 atom/browser/web_view_constants.h diff --git a/atom/browser/api/atom_api_web_view_manager.cc b/atom/browser/api/atom_api_web_view_manager.cc index c69285a6980d..221d0d7118b4 100644 --- a/atom/browser/api/atom_api_web_view_manager.cc +++ b/atom/browser/api/atom_api_web_view_manager.cc @@ -3,6 +3,7 @@ // found in the LICENSE file. #include "atom/browser/api/atom_api_web_contents.h" +#include "atom/browser/web_view_constants.h" #include "atom/browser/web_view_manager.h" #include "atom/common/native_mate_converters/gurl_converter.h" #include "content/public/browser/browser_context.h" @@ -34,17 +35,19 @@ struct Converter { return false; GURL preload_url; - if (!options.Get("preloadUrl", &preload_url)) + if (!options.Get(atom::web_view::kPreloadUrl, &preload_url)) return false; if (!preload_url.is_empty() && !net::FileURLToFilePath(preload_url, &(out->preload_script))) return false; - return options.Get("nodeIntegration", &(out->node_integration)) && - options.Get("plugins", &(out->plugins)) && - options.Get("disableWebSecurity", &(out->disable_web_security)) && - options.Get("partitionId", &(out->partition_id)); + return options.Get(atom::web_view::kNodeIntegration, + &(out->node_integration)) && + options.Get(atom::web_view::kPlugins, &(out->plugins)) && + options.Get(atom::web_view::kPartitionId, &(out->partition_id)) && + options.Get(atom::web_view::kDisableWebSecurity, + &(out->disable_web_security)); } }; @@ -68,12 +71,15 @@ void AddGuest(int guest_instance_id, content::WebContents* guest_web_contents, atom::WebViewManager::WebViewInfo info) { auto manager = GetWebViewManager(embedder); - if (manager) { - info.guest_instance_id = guest_instance_id; - info.embedder = embedder; + if (manager) manager->AddGuest(guest_instance_id, element_instance_id, embedder, - guest_web_contents, info); - } + guest_web_contents); + + info.guest_instance_id = guest_instance_id; + info.embedder = embedder; + auto data = new atom::WebViewManager::WebViewInfoUserData(info); + guest_web_contents->SetUserData( + atom::web_view::kWebViewInfoKeyName, data); } void RemoveGuest(content::WebContents* embedder, int guest_instance_id) { diff --git a/atom/browser/atom_browser_client.cc b/atom/browser/atom_browser_client.cc index 8db71fd3030d..fad952d53365 100644 --- a/atom/browser/atom_browser_client.cc +++ b/atom/browser/atom_browser_client.cc @@ -16,6 +16,7 @@ #include "atom/browser/browser.h" #include "atom/browser/native_window.h" #include "atom/browser/web_view_manager.h" +#include "atom/browser/web_view_constants.h" #include "atom/browser/window_list.h" #include "atom/common/options_switches.h" #include "base/command_line.h" @@ -74,8 +75,12 @@ ProcessOwner GetProcessOwner(int process_id, return OWNER_NATIVE_WINDOW; // Then search for guest WebContents. - if (WebViewManager::GetInfoForWebContents(web_contents, info)) + auto data = static_cast( + web_contents->GetUserData(web_view::kWebViewInfoKeyName)); + if (data) { + *info = data->web_view_info(); return OWNER_GUEST_WEB_CONTENTS; + } return OWNER_NONE; } @@ -155,9 +160,10 @@ void AtomBrowserClient::OverrideWebkitPrefs( // Custom preferences of guest page. auto web_contents = content::WebContents::FromRenderViewHost(host); - WebViewManager::WebViewInfo info; - if (WebViewManager::GetInfoForWebContents(web_contents, &info)) { - prefs->web_security_enabled = !info.disable_web_security; + auto info = static_cast( + web_contents->GetUserData(web_view::kWebViewInfoKeyName)); + if (info) { + prefs->web_security_enabled = !info->web_view_info().disable_web_security; return; } diff --git a/atom/browser/lib/guest-view-manager.coffee b/atom/browser/lib/guest-view-manager.coffee index 2f1c8312155a..581274699085 100644 --- a/atom/browser/lib/guest-view-manager.coffee +++ b/atom/browser/lib/guest-view-manager.coffee @@ -48,6 +48,8 @@ getPartitionId = (partition) -> partition = partition.substring('persist:'.length) partitionId += 'persist?' else + # Just to differentiate from same persistant ID + partition += "_temp" partitionId += '?' partitionId += encodeURIComponent(partition) return partitionId diff --git a/atom/browser/web_view_constants.cc b/atom/browser/web_view_constants.cc new file mode 100644 index 000000000000..6f8314cbcf36 --- /dev/null +++ b/atom/browser/web_view_constants.cc @@ -0,0 +1,24 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#include "atom/browser/web_view_constants.h" + +namespace atom { + +namespace web_view { + +const char kPreloadUrl[] = "preloadUrl"; +const char kNodeIntegration[] = "nodeIntegration"; +const char kPlugins[] = "plugins"; +const char kDisableWebSecurity[] = "disableWebSecurity"; +const char kPartitionId[] = "partitionId"; + +const int kDefaultWidth = 300; +const int kDefaultHeight = 300; + +const char kWebViewInfoKeyName[] = "web_view_info"; + +} // namespace web_view + +} // namespace atom diff --git a/atom/browser/web_view_constants.h b/atom/browser/web_view_constants.h new file mode 100644 index 000000000000..0831bdbdf1d4 --- /dev/null +++ b/atom/browser/web_view_constants.h @@ -0,0 +1,27 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#ifndef ATOM_BROWSER_WEB_VIEW_CONSTANTS_H_ +#define ATOM_BROWSER_WEB_VIEW_CONSTANTS_H_ + +namespace atom { + +namespace web_view { + +extern const char kPreloadUrl[]; +extern const char kNodeIntegration[]; +extern const char kPlugins[]; +extern const char kDisableWebSecurity[]; +extern const char kPartitionId[]; + +extern const int kDefaultWidth; +extern const int kDefaultHeight; + +extern const char kWebViewInfoKeyName[]; + +} // namespace web_view + +} // namespace atom + +#endif // ATOM_BROWSER_WEB_VIEW_CONSTANTS_H_ diff --git a/atom/browser/web_view_guest_delegate.cc b/atom/browser/web_view_guest_delegate.cc index 8e1810c4a39b..a954cea8dc02 100644 --- a/atom/browser/web_view_guest_delegate.cc +++ b/atom/browser/web_view_guest_delegate.cc @@ -5,6 +5,7 @@ #include "atom/browser/web_view_guest_delegate.h" #include "atom/browser/api/atom_api_web_contents.h" +#include "atom/browser/web_view_constants.h" #include "atom/common/native_mate_converters/gurl_converter.h" #include "content/public/browser/guest_host.h" #include "content/public/browser/render_frame_host.h" @@ -13,13 +14,6 @@ namespace atom { -namespace { - -const int kDefaultWidth = 300; -const int kDefaultHeight = 300; - -} // namespace - WebViewGuestDelegate::WebViewGuestDelegate() : guest_opaque_(true), guest_host_(nullptr), @@ -178,7 +172,7 @@ gfx::Size WebViewGuestDelegate::GetDefaultSize() const { return embedder_web_contents_->GetRenderWidgetHostView() ->GetVisibleViewportSize(); } else { - return gfx::Size(kDefaultWidth, kDefaultHeight); + return gfx::Size(web_view::kDefaultWidth, web_view::kDefaultHeight); } } diff --git a/atom/browser/web_view_manager.cc b/atom/browser/web_view_manager.cc index 76915264c6fd..9d0b9337599f 100644 --- a/atom/browser/web_view_manager.cc +++ b/atom/browser/web_view_manager.cc @@ -11,22 +11,6 @@ namespace atom { -// static -bool WebViewManager::GetInfoForWebContents( - const content::WebContents* web_contents, WebViewInfo* info) { - // use embedders' browser context to retrieve WebViewManager. - auto manager = static_cast( - AtomBrowserMainParts::Get()->browser_context()->GetGuestManager()); - if (!manager) - return false; - base::AutoLock auto_lock(manager->lock_); - auto iter = manager->webview_info_map_.find(web_contents); - if (iter == manager->webview_info_map_.end()) - return false; - *info = iter->second; - return true; -} - WebViewManager::WebViewManager(content::BrowserContext* context) { } @@ -36,11 +20,9 @@ WebViewManager::~WebViewManager() { void WebViewManager::AddGuest(int guest_instance_id, int element_instance_id, content::WebContents* embedder, - content::WebContents* web_contents, - const WebViewInfo& info) { + content::WebContents* web_contents) { base::AutoLock auto_lock(lock_); web_contents_embedder_map_[guest_instance_id] = { web_contents, embedder }; - webview_info_map_[web_contents] = info; // Map the element in embedder to guest. int owner_process_id = embedder->GetRenderProcessHost()->GetID(); @@ -53,10 +35,7 @@ void WebViewManager::RemoveGuest(int guest_instance_id) { if (!ContainsKey(web_contents_embedder_map_, guest_instance_id)) return; - auto web_contents = - web_contents_embedder_map_[guest_instance_id].web_contents; web_contents_embedder_map_.erase(guest_instance_id); - webview_info_map_.erase(web_contents); // Remove the record of element in embedder too. for (const auto& element : element_instance_id_to_guest_map_) diff --git a/atom/browser/web_view_manager.h b/atom/browser/web_view_manager.h index d8ed857b444f..20c044849720 100644 --- a/atom/browser/web_view_manager.h +++ b/atom/browser/web_view_manager.h @@ -8,6 +8,7 @@ #include #include "base/files/file_path.h" +#include "base/supports_user_data.h" #include "base/synchronization/lock.h" #include "content/public/browser/browser_plugin_guest_manager.h" #include "content/public/browser/site_instance.h" @@ -31,10 +32,17 @@ class WebViewManager : public content::BrowserPluginGuestManager { GURL partition_id; }; - // Finds the WebViewManager attached with |web_contents| and returns the - // WebViewInfo of it. - static bool GetInfoForWebContents(const content::WebContents* web_contents, - WebViewInfo* info); + class WebViewInfoUserData : public base::SupportsUserData::Data { + public: + explicit WebViewInfoUserData(WebViewInfo info) + : web_view_info_(info) {} + ~WebViewInfoUserData() override {} + + WebViewInfo& web_view_info() { return web_view_info_; } + + private: + WebViewInfo web_view_info_; + }; explicit WebViewManager(content::BrowserContext* context); virtual ~WebViewManager(); @@ -42,8 +50,7 @@ class WebViewManager : public content::BrowserPluginGuestManager { void AddGuest(int guest_instance_id, int element_instance_id, content::WebContents* embedder, - content::WebContents* web_contents, - const WebViewInfo& info); + content::WebContents* web_contents); void RemoveGuest(int guest_instance_id); protected: @@ -83,10 +90,6 @@ class WebViewManager : public content::BrowserPluginGuestManager { // (embedder_process_id, element_instance_id) => guest_instance_id std::map element_instance_id_to_guest_map_; - typedef std::map WebViewInfoMap; - // web_contents => (guest_instance_id, embedder, ...) - WebViewInfoMap webview_info_map_; - base::Lock lock_; DISALLOW_COPY_AND_ASSIGN(WebViewManager); diff --git a/filenames.gypi b/filenames.gypi index 807ccd32bb66..2f97d01507e8 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -226,6 +226,8 @@ 'atom/browser/ui/x/window_state_watcher.h', 'atom/browser/ui/x/x_window_utils.cc', 'atom/browser/ui/x/x_window_utils.h', + 'atom/browser/web_view_constants.cc', + 'atom/browser/web_view_constants.h', 'atom/browser/web_view_guest_delegate.cc', 'atom/browser/web_view_guest_delegate.h', 'atom/browser/web_view_manager.cc', diff --git a/spec/webview-spec.coffee b/spec/webview-spec.coffee index 486efaa6ffb4..fe281510b40e 100644 --- a/spec/webview-spec.coffee +++ b/spec/webview-spec.coffee @@ -155,6 +155,23 @@ describe ' tag', -> document.body.appendChild webview describe 'partition attribute', -> + it 'inserts no node symbols when not set', (done) -> + webview.addEventListener 'console-message', (e) -> + assert.equal e.message, 'undefined undefined undefined undefined' + done() + webview.src = "file://#{fixtures}/pages/c.html" + webview.partition = "test" + document.body.appendChild webview + + it 'inserts node symbols when set', (done) -> + webview.addEventListener 'console-message', (e) -> + assert.equal e.message, 'function object object' + done() + webview.setAttribute 'nodeintegration', 'on' + webview.src = "file://#{fixtures}/pages/d.html" + webview.partition = "test" + document.body.appendChild webview + it 'isolates storage for different id', (done) -> listener = (e) -> assert.equal e.message, " 0" From f1e5a99881336115149c94a6274dfa05b9f70b0b Mon Sep 17 00:00:00 2001 From: Calvin Jeng Date: Fri, 4 Sep 2015 00:06:50 +0800 Subject: [PATCH 1114/1293] zh-tw translation --- .../zh-TW/tutorial/online-offline-events.md | 80 +++++++++++++++++++ 1 file changed, 80 insertions(+) create mode 100644 docs-translations/zh-TW/tutorial/online-offline-events.md diff --git a/docs-translations/zh-TW/tutorial/online-offline-events.md b/docs-translations/zh-TW/tutorial/online-offline-events.md new file mode 100644 index 000000000000..a4366f88a03a --- /dev/null +++ b/docs-translations/zh-TW/tutorial/online-offline-events.md @@ -0,0 +1,80 @@ +# 在線/離線事件偵測 + +我們可以在渲染引擎 (renderer) 的行程裡用標準的 HTML5 API 來實作在線與離線事件的偵測。 +請參考以下範例: + +_main.js_ + +```javascript +var app = require('app'); +var BrowserWindow = require('browser-window'); +var onlineStatusWindow; + +app.on('ready', function() { + onlineStatusWindow = new BrowserWindow({ width: 0, height: 0, show: false }); + onlineStatusWindow.loadUrl('file://' + __dirname + '/online-status.html'); +}); +``` + +_online-status.html_ + +```html + + + + + + +``` + +您也許有時候也會有想要在主行程裡回應這些事件的情況。然而，在主行程裡並沒有 `navigator` 這個物件，因此不能直接地偵測這些事件。 +但我們可以使用 Electron 所提供的跨行程 (inter-process) 溝通的工具，事件就可以被傳送到主程序內並做您所需的處理。 +請參考以下範例: + +_main.js_ + +```javascript +var app = require('app'); +var ipc = require('ipc'); +var BrowserWindow = require('browser-window'); +var onlineStatusWindow; + +app.on('ready', function() { + onlineStatusWindow = new BrowserWindow({ width: 0, height: 0, show: false }); + onlineStatusWindow.loadUrl('file://' + __dirname + '/online-status.html'); +}); + +ipc.on('online-status-changed', function(event, status) { + console.log(status); +}); +``` + +_online-status.html_ + +```html + + + + + + +``` From ae8ffae59ee32dc1360c238e99dfb0cdd44e991d Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Fri, 4 Sep 2015 16:01:43 +0900 Subject: [PATCH 1115/1293] Improve grammar, update as upstream --- README-ko.md | 2 +- docs-translations/ko/api/content-tracing.md | 14 +- docs-translations/ko/api/menu.md | 2 +- docs-translations/ko/api/web-frame.md | 27 +- docs-translations/ko/api/web-view-tag.md | 243 ++++++++++-------- docs-translations/ko/api/window-open.md | 22 +- .../development/atom-shell-vs-node-webkit.md | 7 +- .../development/build-instructions-linux.md | 12 +- ...tions-mac.md => build-instructions-osx.md} | 10 +- .../development/build-instructions-windows.md | 43 ++-- .../ko/development/build-system-overview.md | 12 +- .../ko/development/coding-style.md | 15 +- .../source-code-directory-structure.md | 65 ++--- .../ko/tutorial/application-distribution.md | 8 +- .../ko/tutorial/application-packaging.md | 8 +- .../ko/tutorial/debugging-main-process.md | 13 +- .../desktop-environment-integration.md | 10 +- .../ko/tutorial/devtools-extension.md | 24 +- .../ko/tutorial/online-offline-events.md | 4 +- docs-translations/ko/tutorial/quick-start.md | 17 +- .../ko/tutorial/using-native-node-modules.md | 6 +- .../ko/tutorial/using-pepper-flash-plugin.md | 10 +- .../tutorial/using-selenium-and-webdriver.md | 18 +- 23 files changed, 325 insertions(+), 267 deletions(-) rename docs-translations/ko/development/{build-instructions-mac.md => build-instructions-osx.md} (76%) diff --git a/README-ko.md b/README-ko.md index 1b895c159798..9e8b8e5a8673 100644 --- a/README-ko.md +++ b/README-ko.md @@ -6,7 +6,7 @@ ### [Electron](https://github.com/atom/electron/) 한국어 참조문서 -:zap: *프레임워크 이름이 Atom Shell에서 Electron으로 바뀌었습니다* :zap: +:zap: *프레임워크 이름이 Atom Shell에서 Electron으로 변경되었습니다* :zap: Electron 프레임워크는 JavaScript, HTML 그리고 CSS를 사용하여 Cross-Platform 데스크톱 어플리케이션을 개발할 수 있도록 해주는 프레임워크입니다. 이 프레임워크는 [io.js](http://iojs.org) 와 [Chromium](http://www.chromium.org)을 기반으로 만들어 졌으며 [Atom Editor](https://github.com/atom/atom)에 사용되고 있습니다. diff --git a/docs-translations/ko/api/content-tracing.md b/docs-translations/ko/api/content-tracing.md index f6010d156f6a..79c1d82b269a 100644 --- a/docs-translations/ko/api/content-tracing.md +++ b/docs-translations/ko/api/content-tracing.md @@ -29,10 +29,11 @@ contentTracing.startRecording('*', contentTracing.DEFAULT_OPTIONS, function() { 모든 child 프로세스가 `getCategories` 요청을 승인하면 `callback`이 한 번 호출되며 인자에 카테고리 그룹의 배열이 전달됩니다. -### `contentTracing.startRecording(categoryFilter, traceOptions, callback)` +### `contentTracing.startRecording(options, callback)` -* `categoryFilter` String -* `traceOptions` String +* `options` Object + * `categoryFilter` String + * `traceOptions` String * `callback` Function 모든 프로세스에서 레코딩을 시작합니다. @@ -85,10 +86,11 @@ Child 프로세스는 일반적으로 추적 데이터와 희귀한 플러시 추적 데이터는 `resultFilePath` 해당 경로가 비어있는 경우에 한 해 해당 경로에 작성되거나 임시 파일에 작성됩니다. 실제 파일 경로는 null이 아닌 이상 `callback`을 통해 전달됩니다. -### `contentTracing.startMonitoring(categoryFilter, traceOptions, callback)` +### `contentTracing.startMonitoring(options, callback)` -* `categoryFilter` String -* `traceOptions` String +* `options` Object + * `categoryFilter` String + * `traceOptions` String * `callback` Function 모든 프로세스에서 모니터링을 시작합니다. diff --git a/docs-translations/ko/api/menu.md b/docs-translations/ko/api/menu.md index 90ea6539829a..89abcf289a78 100644 --- a/docs-translations/ko/api/menu.md +++ b/docs-translations/ko/api/menu.md @@ -295,7 +295,7 @@ OS X에선 지정한 어플리케이션 메뉴에 상관없이 메뉴의 첫번 만약 참조된 아이템의 분리자 그룹이 존재하지 않을 경우 지정된 id로 새로운 분리자 그룹을 만든 후 해당 그룹의 뒤에 삽입됩니다. 위치를 지정한 아이템의 뒤에 위치가 지정되지 않은 아이템이 있을 경우 각 아이템의 위치가 지정되기 전까지 모든 아이템이 위치가 지정된 아이템의 뒤에 삽입됩니다. -이에 따라 위치를 이동하고 싶은 특정 그룹의 아이템들이 있을 경우 해당 그룹의 맨 첫번째 메뉴 아이템의 위치만을 지정하면 됩니다. +따라서 위치를 이동하고 싶은 특정 그룹의 아이템들이 있을 경우 해당 그룹의 맨 첫번째 메뉴 아이템의 위치만을 지정하면 됩니다. ### 예제 diff --git a/docs-translations/ko/api/web-frame.md b/docs-translations/ko/api/web-frame.md index 9829520901d2..d09114e559c8 100644 --- a/docs-translations/ko/api/web-frame.md +++ b/docs-translations/ko/api/web-frame.md @@ -1,4 +1,4 @@ -# web-frame +# webFrame `web-frame` 모듈은 현재 웹 페이지의 랜더링 상태를 설정 할 수 있도록 관련 유틸리티를 제공하는 모듈입니다. @@ -6,38 +6,43 @@ ```javascript var webFrame = require('web-frame'); + webFrame.setZoomFactor(2); ``` -## webFrame.setZoomFactor(factor) +## Methods + +`web-frame` 모듈은 다음과 같은 메서드를 가지고 있습니다: + +### `webFrame.setZoomFactor(factor)` * `factor` Number - Zoom 값 -지정한 값으로 페이지를 줌 합니다. 줌 값은 퍼센트 / 100입니다. (예시: 300% = 3.0) +지정한 값으로 페이지를 줌 합니다. 줌 값은 퍼센트를 100으로 나눈 값입니다. (예시: 300% = 3.0) -## webFrame.getZoomFactor() +### `webFrame.getZoomFactor()` 현재 줌 값을 반환합니다. -## webFrame.setZoomLevel(level) +### `webFrame.setZoomLevel(level)` * `level` Number - Zoom level 지정한 레벨로 줌 레벨을 변경합니다. 0은 "기본 크기" 입니다. 그리고 각각 레벨 값을 올리거나 내릴 때마다 20%씩 커지거나 작아지고 기본 크기의 50%부터 300%까지 조절 제한이 있습니다. -## webFrame.getZoomLevel() +### `webFrame.getZoomLevel()` 현재 줌 레벨을 반환합니다. -## webFrame.setZoomLevelLimits(minimumLevel, maximumLevel) +### `webFrame.setZoomLevelLimits(minimumLevel, maximumLevel)` * `minimumLevel` Number * `maximumLevel` Number 줌 레벨의 최대, 최소치를 지정합니다. -## webFrame.setSpellCheckProvider(language, autoCorrectWord, provider) +### `webFrame.setSpellCheckProvider(language, autoCorrectWord, provider)` * `language` String * `autoCorrectWord` Boolean @@ -57,7 +62,7 @@ require('web-frame').setSpellCheckProvider("en-US", true, { }); ``` -## webFrame.registerUrlSchemeAsSecure(scheme) +### `webFrame.registerUrlSchemeAsSecure(scheme)` * `scheme` String @@ -65,10 +70,10 @@ require('web-frame').setSpellCheckProvider("en-US", true, { 보안 스킴은 혼합된 컨텐츠 경고를 발생시키지 않습니다. 예를 들어 `https` 와 `data`는 네트워크 공격자로부터 손상될 가능성이 없기 때문에 보안 스킴이라고 할 수 있습니다. -## webFrame.registerUrlSchemeAsBypassingCsp(scheme) +### `webFrame.registerUrlSchemeAsBypassingCsp(scheme)` * `scheme` String -페이지 컨텐츠의 보안 정책에 상관없이 이 `scheme`로부터 리소스가 로드됩니다. +현재 페이지 컨텐츠의 보안 정책에 상관없이 이 `scheme`로부터 리소스가 로드됩니다. [spellchecker]: https://github.com/atom/node-spellchecker diff --git a/docs-translations/ko/api/web-view-tag.md b/docs-translations/ko/api/web-view-tag.md index d2efdf17ea1f..0ed8558fa2fd 100644 --- a/docs-translations/ko/api/web-view-tag.md +++ b/docs-translations/ko/api/web-view-tag.md @@ -3,9 +3,9 @@ `guest` 컨텐츠(웹 페이지)를 Electron 앱 페이지에 삽입하기 위해 `webview` 태그를 사용할 수 있습니다. 게스트 컨텐츠는 `webview` 컨테이너에 담겨 대상 페이지에 삽입되고 해당 페이지에선 게스트 컨텐츠의 배치 및 렌더링 과정을 조작할 수 있습니다. -`iframe`과 `webview`의 차이는 어플리케이션과 프로세스가 분리되어 돌아간다는 점입니다. -그것은 모든 권한이 웹 페이지와 같지 않고 모든 앱과 임베디드(게스트) 컨텐츠간의 상호작용이 비동기로 작동한다는 것을 의미합니다. -이에 따라 임베디드 컨텐츠로부터 어플리케이션을 안전하게 유지할 수 있습니다. +`iframe`과는 달리 `webview`는 어플리케이션과 분리된 프로세스에서 작동합니다. +이는 웹 페이지와 같은 권한을 가지지 않고 앱과 임베디드(게스트) 컨텐츠간의 모든 상호작용이 비동기로 작동한다는 것을 의미합니다. +따라서 임베디드 컨텐츠로부터 어플리케이션을 안전하게 유지할 수 있습니다. ## 예제 @@ -40,7 +40,9 @@ ## 태그 속성 -### src +`webview` 태그는 다음과 같은 속성을 가지고 있습니다: + +### `src` ```html @@ -52,17 +54,17 @@ `src` 속성은 `data:text/plain,Hello, world!` 같은 data URL도 사용할 수 있습니다. -### autosize +### `autosize` ```html ``` "on" 으로 지정하면 `webview` 컨테이너는 `minwidth`, `minheight`, `maxwidth`, `maxheight`에 맞춰서 자동으로 크기를 조절합니다. -이 조건은 `autosize`가 활성화되어있지 않는 한 따로 영향을 주지 않습니다. +이 속성들은 `autosize`가 활성화되어있지 않는 한 프레임에 영향을 주지 않습니다. `autosize`가 활성화 되어있으면 `webview` 컨테이너의 크기는 각각의 지정한 최대, 최소값에 따라 조절됩니다. -### nodeintegration +### `nodeintegration` ```html @@ -71,7 +73,7 @@ "on"으로 지정하면 `webview` 페이지 내에서 `require`와 `process 객체`같은 node.js API를 사용할 수 있습니다. 이를 지정하면 내부에서 로우레벨 리소스에 접근할 수 있습니다. -### plugins +### `plugins` ```html @@ -79,46 +81,48 @@ "on"으로 지정하면 `webview` 내부에서 브라우저 플러그인을 사용할 수 있습니다. -### preload +### `preload` ```html ``` -게스트 페이지가 로드되기 전에 실행할 스크립트를 지정합니다. +페이지가 로드되기 전에 실행할 스크립트를 지정합니다. 스크립트 URL은 `file:` 또는 `asar:` 프로토콜 중 하나를 반드시 사용해야 합니다. -왜냐하면 `require`를 사용해 게스트 페이지 내에서 스크립트를 로드하기 때문입니다. +왜냐하면 페이지 내에서 `require`를 사용하여 스크립트를 로드하기 때문입니다. -게스트 페이지가 nodeintegration을 활성화 하지 않았어도 지정된 스크립트는 정상적으로 돌아갑니다. +페이지가 nodeintegration을 활성화 하지 않아도 지정한 스크립트는 정상적으로 작동합니다. 하지만 스크립트 내에서 사용할 수 있는 global 객체는 스크립트 작동이 끝나면 삭제됩니다. -### httpreferrer +### `httpreferrer` ```html ``` -게스트 페이지의 referrer URL을 설정합니다. +페이지의 referrer URL을 설정합니다. -### useragent +### `useragent` ```html ``` -게스트 페이지의 `User-Agent`를 설정합니다. 페이지가 로드된 후엔 `setUserAgent` 메소드를 사용해서 변경할 수 있습니다. +페이지의 `User-Agent`를 설정합니다. 페이지가 로드된 후엔 `setUserAgent` 메소드를 사용해서 변경할 수 있습니다. -### disablewebsecurity +### `disablewebsecurity` ```html ``` -"on"으로 지정하면 게스트 페이지의 웹 보안을 해제합니다. +"on"으로 지정하면 페이지의 웹 보안을 해제합니다. -## API +## Methods -webview 메서드는 페이지 로드가 끝난 뒤에만 사용할 수 있습니다. +`webview` 태그는 다음과 같은 메서드를 가지고 있습니다: + +**참고:** Webview 메서드는 페이지 로드가 끝난 뒤에만 사용할 수 있습니다. **예제** ```javascript @@ -127,229 +131,240 @@ webview.addEventListener("dom-ready", function() { }); ``` -### ``.getUrl() +### `.getUrl()` -게스트 페이지의 URL을 반환합니다. +페이지의 URL을 반환합니다. -### ``.getTitle() +### `.getTitle()` -게스트 페이지의 제목을 반환합니다. +페이지의 제목을 반환합니다. -### ``.isLoading() +### `.isLoading()` -페이지가 아직 리소스를 로딩하고 있는지 확인합니다. +페이지가 아직 리소스를 로딩하고 있는지 확인합니다. 불린 값을 반환합니다. -### ``.isWaitingForResponse() +### `.isWaitingForResponse()` -게스트 페이지가 메인 리소스의 첫 응답을 기다리고 있는지 확인합니다. +페이지가 메인 리소스의 첫 응답을 기다리고 있는지 확인합니다. 불린 값을 반환합니다. -### ``.stop() +### `.stop()` 모든 탐색을 취소합니다. -### ``.reload() +### `.reload()` 페이지를 새로고침합니다. -### ``.reloadIgnoringCache() +### `.reloadIgnoringCache()` 캐시를 무시하고 페이지를 새로고침합니다. -### ``.canGoBack() +### `.canGoBack()` -페이지 히스토리를 한 칸 뒤로 가기를 할 수 있는지 확인합니다. +페이지 히스토리를 한 칸 뒤로 가기를 할 수 있는지 확인합니다. 불린 값을 반환합니다. -### ``.canGoForward() +### `.canGoForward()` -페이지 히스토리를 한 칸 앞으로 가기를 할 수 있는지 확인합니다. +페이지 히스토리를 한 칸 앞으로 가기를 할 수 있는지 확인합니다. 불린 값을 반환합니다. -### ``.canGoToOffset(offset) +### `.canGoToOffset(offset)` * `offset` Integer -페이지 히스토리를 `offset` 만큼 이동할 수 있는지 확인합니다. +페이지 히스토리를 `offset` 만큼 이동할 수 있는지 확인합니다. 불린값을 반환합니다. -### ``.clearHistory() +### `.clearHistory()` 탐색 히스토리를 비웁니다. -### ``.goBack() +### `.goBack()` 페이지 뒤로 가기를 실행합니다. -### ``.goForward() +### `.goForward()` 페이지 앞으로 가기를 실행합니다. -### ``.goToIndex(index) +### `.goToIndex(index)` * `index` Integer 페이지를 지정한 `index`로 이동합니다. -### ``.goToOffset(offset) +### `.goToOffset(offset)` * `offset` Integer -현재 페이지로 부터 `offset` 만큼 이동합니다. +페이지로부터 `offset` 만큼 이동합니다. -### ``.isCrashed() +### `.isCrashed()` 랜더러 프로세스가 크래시 됬는지 확인합니다. -### ``.setUserAgent(userAgent) +### `.setUserAgent(userAgent)` * `userAgent` String `User-Agent`를 지정합니다. -### ``.getUserAgent() +### `.getUserAgent()` -현재 페이지의 `User-Agent` 문자열을 가져옵니다. +페이지의 `User-Agent 문자열`을 가져옵니다. -### ``.insertCSS(css) +### `.insertCSS(css)` * `css` String -게스트 페이지에 CSS를 삽입합니다. +페이지에 CSS를 삽입합니다. -### ``.executeJavaScript(code[, userGesture]) +### `.executeJavaScript(code[, userGesture])` * `code` String * `userGesture` Boolean -게스트 페이지에서 자바스크립트 `code`를 실행합니다. +페이지에서 자바스크립트 `code`를 실행합니다. -`userGesture`가 `true`로 설정되어 있으면 `requestFullScreen` HTML API 같이 -유저의 승인이 필요한 API를 유저의 승인을 무시하고 개발자가 API를 직접 사용할 수 있습니다. +만약 `userGesture`가 `true`로 설정되어 있으면 페이지에 유저 제스쳐 컨텍스트를 만듭니다. +이 옵션을 활성화 시키면 `requestFullScreen`와 같은 HTML API에서 유저의 승인을 무시하고 개발자가 API를 바로 사용할 수 있도록 허용합니다. 역주: 기본적으로 브라우저에선 전체화면, 웹캠, 파일 열기등의 API를 사용하려면 유저의 승인(이벤트)이 필요합니다. -### ``.openDevTools() +### `.openDevTools()` -게스트 페이지에 대한 개발자 툴을 엽니다. +페이지에 대한 개발자 툴을 엽니다. -### ``.closeDevTools() +### `.closeDevTools()` -게스트 페이지에 대한 개발자 툴을 닫습니다. +페이지에 대한 개발자 툴을 닫습니다. -### ``.isDevToolsOpened() +### `.isDevToolsOpened()` -게스트 페이지에 대한 개발자 툴이 열려있는지 확인합니다. +페이지에 대한 개발자 툴이 열려있는지 확인합니다. 불린 값을 반환합니다. -### ``.inspectElement(x, y) +### `.inspectElement(x, y)` * `x` Integer * `y` Integer (`x`, `y`) 위치에 있는 엘리먼트를 inspect합니다. -### ``.inspectServiceWorker() +### `.inspectServiceWorker()` Service worker에 대한 개발자 툴을 엽니다. -### ``.undo() +### `.undo()` 페이지에서 실행 취소 커맨드를 실행합니다. -### ``.redo() +### `.redo()` 페이지에서 다시 실행 커맨드를 실행합니다. -### ``.cut() +### `.cut()` 페이지에서 잘라내기 커맨드를 실행합니다. -### ``.copy() +### `.copy()` 페이지에서 복사 커맨드를 실행합니다. -### ``.paste() +### `.paste()` 페이지에서 붙여넣기 커맨드를 실행합니다. -### ``.pasteAndMatchStyle() +### `.pasteAndMatchStyle()` 페이지에서 `pasteAndMatchStyle` 편집 커맨드를 실행합니다. -### ``.delete() +### `.delete()` 페이지에서 삭제 커맨드를 실행합니다. -### ``.selectAll() +### `.selectAll()` 페이지에서 전체 선택 커맨드를 실행합니다. -### ``.unselect() +### `.unselect()` 페이지에서 `unselect` 커맨드를 실행합니다. -### ``.replace(text) +### `.replace(text)` * `text` String 페이지에서 `replace` 커맨드를 실행합니다. -### ``.replaceMisspelling(text) +### `.replaceMisspelling(text)` * `text` String 페이지에서 `replaceMisspelling` 커맨드를 실행합니다. -### ``.print([options]) +### `.print([options])` Webview 페이지를 인쇄합니다. `webContents.print([options])` 메서드와 같습니다. -### ``.printToPDF(options, callback) +### `.printToPDF(options, callback)` Webview 페이지를 PDF 형식으로 인쇄합니다. `webContents.printToPDF(options, callback)` 메서드와 같습니다. -### ``.send(channel[, args...]) +### `.send(channel[, args...])` * `channel` String +* `args` (optional) -`channel`을 통해 게스트 페이지에 `args...` 비동기 메시지를 보냅니다. -게스트 페이지에선 `ipc` 모듈의 `channel` 이벤트를 사용하면 이 메시지를 받을 수 있습니다. +`channel`을 통해 페이지에 `args` 비동기 메시지를 보냅니다. +페이지에선 `ipc` 모듈의 `channel` 이벤트를 사용하면 이 메시지를 받을 수 있습니다. 예제는 [WebContents.send](browser-window.md#webcontentssendchannel-args)를 참고하세요. ## DOM 이벤트 -### load-commit +`webview` 태그는 다음과 같은 DOM 이벤트를 가지고 있습니다: + +### Event: 'load-commit' + +Returns: * `url` String * `isMainFrame` Boolean -Fired when a load has committed. This includes navigation within the current -document as well as subframe document-level loads, but does not include -asynchronous resource loads. +로드가 시작됬을 때 발생하는 이벤트입니다. +이 이벤트는 현재 문서내의 탐색뿐만 아니라 서브 프레임 문서 레벨의 로드도 포함됩니다. +하지만 비동기 리소스 로드는 포함되지 않습니다. -### did-finish-load +### Event: 'did-finish-load' -탐색이 끝나면 발생하는 이벤트입니다. 브라우저 탭의 스피너가 멈추고 `onload` 이벤트가 발생될 때를 생각하면 됩니다. +탐색이 끝나면 발생하는 이벤트입니다. 브라우저 탭의 스피너가 멈추고 `onload` 이벤트가 발생할 때를 생각하면 됩니다. -### did-fail-load +### Event: 'did-fail-load' + +Returns: * `errorCode` Integer * `errorDescription` String `did-finish-load`와 비슷합니다. 하지만 이 이벤트는 `window.stop()`과 같은 무언가로 인해 로드에 실패했을 때 발생하는 이벤트입니다. -### did-frame-finish-load +### Event: 'did-frame-finish-load' + +Returns: * `isMainFrame` Boolean 프레임의 탐색이 끝나면 발생하는 이벤트입니다. -### did-start-loading +### Event: 'did-start-loading' 브라우저 탭의 스피너가 돌기 시작할 때 처럼 페이지의 로드가 시작될 때 발생하는 이벤트입니다. -### did-stop-loading +### Event: 'did-stop-loading' 브라우저 탭의 스피너가 멈출 때 처럼 페이지의 로드가 끝나면 발생하는 이벤트입니다. -### did-get-response-details +### Event: 'did-get-response-details' + +Returns: * `status` Boolean * `newUrl` String @@ -362,7 +377,9 @@ asynchronous resource loads. 요청한 리소스에 관해 자세한 내용을 알 수 있을 때 발생하는 이벤트입니다. `status`는 리소스를 다운로드할 소켓 커낵션을 나타냅니다. -### did-get-redirect-request +### Event: 'did-get-redirect-request' + +Returns: * `oldUrl` String * `newUrl` String @@ -370,32 +387,38 @@ asynchronous resource loads. 리소스를 요청하고 받는 도중에 리다이렉트가 생기면 발생하는 이벤트입니다. -### dom-ready +### Event: 'dom-ready' -현재 프레임 문서의 로드가 끝나면 발생하는 이벤트입니다. +프레임 문서의 로드가 끝나면 발생하는 이벤트입니다. -### page-title-set +### Event: 'page-title-set' + +Returns: * `title` String * `explicitSet` Boolean 탐색하는 동안에 페이지의 제목이 설정되면 발생하는 이벤트입니다. `explicitSet`는 파일 URL에서 종합(synthesised)된 제목인 경우 false로 표시됩니다. -### page-favicon-updated +### Event: 'page-favicon-updated' -* `favicons` Array - Array of Urls +Returns: + +* `favicons` Array - URL 배열 페이지가 favicon URL을 받았을 때 발생하는 이벤트입니다. -### enter-html-full-screen +### Event: 'enter-html-full-screen' 페이지가 HTML API에 의해 전체 화면 모드에 돌입했을 때 발생하는 이벤트입니다. -### leave-html-full-screen +### Event: 'leave-html-full-screen' 페이지의 전체 화면 모드가 해제됬을 때 발생하는 이벤트입니다. -### console-message +### Event: 'console-message' + +Returns: * `level` Integer * `message` String @@ -412,14 +435,16 @@ webview.addEventListener('console-message', function(e) { }); ``` -### new-window +### Event: 'new-window' + +Returns: * `url` String * `frameName` String * `disposition` String - Can be `default`, `foreground-tab`, `background-tab`, `new-window` and `other` -게스트 페이지가 새로운 브라우저 창을 생성할 때 발생하는 이벤트입니다. +페이지가 새로운 브라우저 창을 생성할 때 발생하는 이벤트입니다. 다음 예제 코드는 새 URL을 시스템의 기본 브라우저로 여는 코드입니다. @@ -429,11 +454,11 @@ webview.addEventListener('new-window', function(e) { }); ``` -### close +### Event: 'close' -게스트 페이지가 자체적으로 닫힐 때 발생하는 이벤트입니다. +페이지가 자체적으로 닫힐 때 발생하는 이벤트입니다. -다음 예제 코드는 게스트 페이지가 자체적으로 닫힐 때 `webview`를 `about:blank` 페이지로 이동시키는 예제입니다. +다음 예제 코드는 페이지가 자체적으로 닫힐 때 `webview`를 `about:blank` 페이지로 이동시키는 예제입니다. ```javascript webview.addEventListener('close', function() { @@ -441,7 +466,9 @@ webview.addEventListener('close', function() { }); ``` -### ipc-message +### Event: 'ipc-message' + +Returns: * `channel` String * `args` Array @@ -467,21 +494,23 @@ ipc.on('ping', function() { }); ``` -### crashed +### Event: 'crashed' 랜더러 프로세스가 크래시 되었을 때 발생하는 이벤트입니다. -### gpu-crashed +### Event: 'gpu-crashed' GPU 프로세스가 크래시 되었을 때 발생하는 이벤트입니다. -### plugin-crashed +### Event: 'plugin-crashed' + +Returns: * `name` String * `version` String 플러그인 프로세스가 크래시 되었을 때 발생하는 이벤트입니다. -### destroyed +### Event: 'destroyed' WebContents가 파괴될 때 발생하는 이벤트입니다. diff --git a/docs-translations/ko/api/window-open.md b/docs-translations/ko/api/window-open.md index 6d7c0b9fabbe..4187672331f4 100644 --- a/docs-translations/ko/api/window-open.md +++ b/docs-translations/ko/api/window-open.md @@ -4,17 +4,17 @@ 이 창은 지정한 `url`을 로드하여 만들어진 `BrowserWindow`의 새 인스턴스이며 본래 창 객체 대신 페이지의 컨트롤이 제한된 프록시 객체를 반환합니다. 프록시 객체는 브라우저의 웹 페이지 창과 호환될 수 있도록 일부 제한된 표준 기능만 가지고 있습니다. -창의 모든 컨트롤을 가지려면 `BrowserWindow`를 직접 생성하여 작업해야 합니다. +창의 모든 컨트롤 권한을 가지려면 `BrowserWindow`를 직접 생성해서 사용해야 합니다. -## window.open(url, [frameName[, features]]) +### `window.open(url[, frameName][, features])` * `url` String -* `frameName` String -* `features` String +* `frameName` String (optional) +* `features` String (optional) `BrowserWindowProxy` 클래스의 객체를 반환하는 새로운 윈도우를 생성합니다. -## window.opener.postMessage(message, targetOrigin) +### `window.opener.postMessage(message, targetOrigin)` * `message` String * `targetOrigin` String @@ -23,31 +23,31 @@ ## Class: BrowserWindowProxy -### BrowserWindowProxy.blur() +### `BrowserWindowProxy.blur()` 자식 윈도우의 포커스를 해제합니다. -### BrowserWindowProxy.close() +### `BrowserWindowProxy.close()` 자식 윈도우를 강제로 닫습니다. unload 이벤트가 발생하지 않습니다. Forcefully closes the child window without calling its unload event. -### BrowserWindowProxy.closed +### `BrowserWindowProxy.closed` 자식 윈도우가 닫히면 true로 설정됩니다. -### BrowserWindowProxy.eval(code) +### `BrowserWindowProxy.eval(code)` * `code` String 자식 윈도우에서 특정 스크립트를 실행합니다. -### BrowserWindowProxy.focus() +### `BrowserWindowProxy.focus()` 자식 윈도우에 포커스를 맞춥니다. (창을 맨 앞으로 가져옵니다) -### BrowserWindowProxy.postMessage(message, targetOrigin) +### `BrowserWindowProxy.postMessage(message, targetOrigin)` * `message` String * `targetOrigin` String diff --git a/docs-translations/ko/development/atom-shell-vs-node-webkit.md b/docs-translations/ko/development/atom-shell-vs-node-webkit.md index aa0d3e19058f..ec35a2dbf1f4 100644 --- a/docs-translations/ko/development/atom-shell-vs-node-webkit.md +++ b/docs-translations/ko/development/atom-shell-vs-node-webkit.md @@ -1,15 +1,16 @@ -# NW.js와 기술적으로 다른점 (이전 node-webkit) +# Electron이 NW.js(node-webkit)와 기술적으로 다른점 __주의: Electron은 Atom Shell의 새로운 이름입니다.__ -NW.js 처럼 Electron은 JavaScript와 HTML 그리고 Node 통합환경을 제공함으로써 웹 페이지에서 저수준 시스템에 접근할 수 있는 웹 기반 데스크탑 어플리케이션을 작성할 수 있도록 합니다. +NW.js 처럼 Electron은 JavaScript와 HTML 그리고 Node 통합 환경을 제공함으로써 +웹 페이지에서 저 수준 시스템에 접근할 수 있도록 하여 웹 기반 데스크탑 어플리케이션을 작성할 수 있도록 하는 프레임워크 입니다. 하지만 Electron과 NW.js는 근본적인 개발흐름의 차이도 있습니다: __1. 어플리케이션의 엔트리 포인트__ NW.js에선 어플리케이션의 엔트리 포인트로 웹 페이지를 사용합니다. -`package.json`내의 main 필드에 메인 웹 페이지(index.html) 파일을 지정하면 어플리케이션의 메인 윈도우로 열리게 됩니다. +`package.json`내의 main 필드에 메인 웹 페이지(index.html) URL을 지정하면 어플리케이션의 메인 윈도우로 열리게 됩니다. Electron에선 JavaScript를 엔트리 포인트로 사용합니다. URL을 직접 제공하는 대신 API를 사용하여 직접 브라우저 창과 HTML 파일을 로드할 수 있습니다. 또한 윈도우의 종료시기를 결정하는 이벤트를 리스닝해야합니다. diff --git a/docs-translations/ko/development/build-instructions-linux.md b/docs-translations/ko/development/build-instructions-linux.md index e02c1341f993..cb254a80596d 100644 --- a/docs-translations/ko/development/build-instructions-linux.md +++ b/docs-translations/ko/development/build-instructions-linux.md @@ -1,11 +1,13 @@ # 빌드 설명서 (Linux) +이 가이드는 Linux 운영체제에서 Electron을 빌드하는 방법을 설명합니다. + ## 빌드전 요구사양 * Python 2.7.x. 몇몇 CentOS와 같은 배포판들은 아직도 Python 2.6.x 버전을 사용합니다. 그래서 `python -V`를 통해 버전을 확인해 줄 필요가 있습니다. * Node.js v0.12.x. Node를 설치하는 방법은 여러가지가 있습니다. 그중 하나는 [Node.js](http://nodejs.org) 사이트에서 소스코드를 받아 빌드하는 방법입니다. -이렇게 하면 Node를 일반 유저로 홈 디렉터리에 설치할 수 있습니다. 또는 [NodeSource](https://nodesource.com/blog/nodejs-v012-iojs-and-the-nodesource-linux-repositories)에서 소스 파일을 받아올 수 있습니다. -자세한 내용은 [Node.js 설치 방법](https://github.com/joyent/node/wiki/Installation) 을 참고하세요. + 이렇게 하면 Node를 일반 유저로 홈 디렉터리에 설치할 수 있습니다. 또는 [NodeSource](https://nodesource.com/blog/nodejs-v012-iojs-and-the-nodesource-linux-repositories)에서 소스 파일을 받아올 수 있습니다. + 자세한 내용은 [Node.js 설치 방법](https://github.com/joyent/node/wiki/Installation) 을 참고하세요. * Clang 3.4 또는 최신 버전 * GTK+ 와 libnotify의 개발용 헤더 @@ -54,7 +56,7 @@ $ ./script/bootstrap.py -v ### 크로스 컴파일 -`arm` 아키텍쳐로 빌드 하려면 먼저 종속성 라이브러리를 설치해야 합니다: +`arm` 아키텍쳐로 빌드 하려면 다음 종속성 라이브러리를 설치해야 합니다: ```bash $ sudo apt-get install libc6-dev-armhf-cross linux-libc-dev-armhf-cross \ @@ -84,7 +86,7 @@ $ ./script/create-dist.py ``` 이 스크립트는 매우 작은 배포판을 `dist` 디렉터리에 생성합니다. -create-dist.py 스크립트를 실행한 이후 1.3GB를 초과하는 공간을 차지하는 out/R 폴더의 실행파일 바이너리는 삭제해도 됩니다. +create-dist.py 스크립트를 실행한 이후부턴 1.3GB를 초과하는 공간을 차지하는 `out/R` 폴더의 바이너리는 삭제해도 됩니다. 또는 `Debug` 타겟만 빌드 할 수 있습니다: @@ -109,7 +111,7 @@ $ ./script/clean.py ## libtinfo.so.5 동적 링크 라이브러리를 로드하는 도중 에러가 발생할 경우 미리 빌드된 `clang`은 `libtinfo.so.5`로 링크를 시도합니다. -플랫폼에 따라 적당한 `libncurses` symlink를 추가하세요. +따라서 플랫폼에 따라 적당한 `libncurses` symlink를 추가하세요: ```bash $ sudo ln -s /usr/lib/libncurses.so.5 /usr/lib/libtinfo.so.5 diff --git a/docs-translations/ko/development/build-instructions-mac.md b/docs-translations/ko/development/build-instructions-osx.md similarity index 76% rename from docs-translations/ko/development/build-instructions-mac.md rename to docs-translations/ko/development/build-instructions-osx.md index eeed5a4df4ec..4951b975ae33 100644 --- a/docs-translations/ko/development/build-instructions-mac.md +++ b/docs-translations/ko/development/build-instructions-osx.md @@ -1,12 +1,14 @@ -# 빌드 설명서 (Mac) +# 빌드 설명서 (OS X) + +이 가이드는 OS X 운영체제에서 Electron을 빌드하는 방법을 설명합니다. ## 빌드전 요구 사항 * OS X >= 10.8 * [Xcode](https://developer.apple.com/technologies/tools/) >= 5.1 -* [node.js](http://nodejs.org) (external). +* [node.js](http://nodejs.org) (external) -만약 Homebrew를 이용해 파이선을 설치했다면 다음 파이선 모듈도 같이 설치해야 합니다: +만약 Homebrew를 이용해 파이선을 설치했다면 다음 Python 모듈도 같이 설치해야 합니다: * pyobjc @@ -44,7 +46,7 @@ $ ./script/build.py -c D ## 32비트 지원 -Electron은 현재 OS X 64비트 빌드만 지원하고 있습니다. 그리고 앞으로도 OS X 32비트는 지원할 계획이 없습니다. +Electron은 현재 OS X 64비트만 지원하고 있습니다. 그리고 앞으로도 OS X 32비트는 지원할 계획이 없습니다. ## 테스트 diff --git a/docs-translations/ko/development/build-instructions-windows.md b/docs-translations/ko/development/build-instructions-windows.md index 22734b1ec236..fa165ca153ac 100644 --- a/docs-translations/ko/development/build-instructions-windows.md +++ b/docs-translations/ko/development/build-instructions-windows.md @@ -1,25 +1,29 @@ # 빌드 설명서 (Windows) +이 가이드는 Windows 운영체제에서 Electron을 빌드하는 방법을 설명합니다. + ## 빌드전 요구 사항 * Windows 7 / Server 2008 R2 또는 최신 버전 * Visual Studio 2013 - [VS 2013 커뮤니티 에디션 무료 다운로드](http://www.visualstudio.com/products/visual-studio-community-vs) * [Python 2.7](http://www.python.org/download/releases/2.7/) * [Node.js](http://nodejs.org/download/) -* [git](http://git-scm.com) +* [Git](http://git-scm.com) -현재 Windows를 설치하지 않았다면 [modern.ie](https://www.modern.ie/en-us/virtualization-tools#downloads)에서 +현재 사용하고 있는 PC에 Windows를 설치하지 않았다면 [modern.ie](https://www.modern.ie/en-us/virtualization-tools#downloads)에서 사용 기한이 정해져있는 무료 가상머신 버전의 Windows를 받아 Electron을 빌드하는 방법도 있습니다. -Electron은 전적으로 command-line 스크립트를 사용하여 빌드합니다. 그렇기에 Electron을 개발하는데 아무런 에디터나 사용할 수 있습니다. -하지만 이 말은 Visual Studio를 개발을 위해 사용할 수 없다는 말이 됩니다. 나중에 Visual Studio를 이용한 빌드 방법도 제공할 예정입니다. +Electron은 모든 빌드를 command-line 스크립트를 통해 빌드합니다. 따라서 빌드에 Visual Studio를 사용할 수 없습니다. +하지만 여전히 Electron을 개발할 땐 아무 에디터나 사용할 수 있습니다. 빠른 시일내에 Visual Studio를 이용한 빌드도 지원할 계획입니다. -**참고:** Visual Studio가 빌드에 사용되지 않더라도 제공된 빌드 툴체인이 **필수적으로** 사용되므로 여전히 필요합니다. +**참고:** Visual Studio가 직접 빌드에 사용되지 않더라도 IDE와 같이 제공된 빌드 툴체인이 빌드에 **필수적으로** 사용되므로 여전히 필요합니다. + +**참고:** Visual Studio 2015는 사용할 수 없습니다. MSVS **2013**을 사용하고 있는지 확인해주세요. ## 코드 가져오기 ```powershell -git clone https://github.com/atom/electron.git +$ git clone https://github.com/atom/electron.git ``` ## 부트 스트랩 @@ -28,8 +32,8 @@ git clone https://github.com/atom/electron.git 참고로 Electron은 빌드 툴체인으로 `ninja`를 사용하므로 Visual Studio 프로젝트는 생성되지 않습니다. ```powershell -cd electron -python script\bootstrap.py -v +$ cd electron +$ python script\bootstrap.py -v ``` ## 빌드 하기 @@ -37,13 +41,13 @@ python script\bootstrap.py -v `Release` 와 `Debug` 두 타겟 모두 빌드 합니다: ```powershell -python script\build.py +$ python script\build.py ``` 또는 `Debug` 타겟만 빌드 할 수 있습니다: ```powershell -python script\build.py -c D +$ python script\build.py -c D ``` 빌드가 모두 끝나면 `out/D` (디버그 타겟) 또는 `out/R` (릴리즈 타겟) 디렉터리에서 `electron.exe` 실행 파일을 찾을 수 있습니다. @@ -53,7 +57,7 @@ python script\build.py -c D 64비트를 타겟으로 빌드 하려면 부트스트랩 스크립트를 실행할 때 `--target_arch=x64` 인자를 같이 넘겨주면 됩니다: ```powershell -python script\bootstrap.py -v --target_arch=x64 +$ python script\bootstrap.py -v --target_arch=x64 ``` 다른 빌드 단계도 정확하게 같습니다. @@ -63,13 +67,13 @@ python script\bootstrap.py -v --target_arch=x64 프로젝트 코딩 스타일을 확인하려면: ```powershell -python script\cpplint.py +$ python script\cpplint.py ``` 테스트를 실행하려면: ```powershell -python script\test.py +$ python script\test.py ``` 테스트 실행시 `runas`와 같은 네이티브 모듈을 포함하는데 이 모듈은 디버그 빌드에서 같이 사용할 수 없습니다. @@ -78,7 +82,7 @@ python script\test.py 릴리즈 빌드로 테스트를 실행하려면 다음 커맨드를 사용하면 됩니다: ```powershell -python script\test.py -R +$ python script\test.py -R ``` ## 문제 해결 @@ -110,23 +114,24 @@ Traceback (most recent call last): subprocess.CalledProcessError: Command '['npm.cmd', 'install']' returned non-zero exit status 3 ``` -이 버그는 Cygwin python과 Win32 node를 같이 사용할 때 발생합니다. -부트스트랩 스크립트에서 Win32 python을 사용함으로써 이 문제를 해결할 수 있습니다 (`C:\Python27` 디렉터리에 python이 설치되었다는 것을 가정하면): +이 버그는 Cygwin Python과 Win32 Node를 같이 사용할 때 발생합니다. +부트스트랩 스크립트에서 Win32 Python을 사용함으로써 이 문제를 해결할 수 있습니다. +`C:\Python27` 디렉터리에 Python이 설치되었다는 가정하에 다음 명령을 실행하면 됩니다: ```bash -/cygdrive/c/Python27/python.exe script/bootstrap.py +$ /cygdrive/c/Python27/python.exe script/bootstrap.py ``` ### LNK1181: cannot open input file 'kernel32.lib' -32bit node.js를 다시 설치하세요. +32비트 Node.js를 다시 설치하세요. ### Error: ENOENT, stat 'C:\Users\USERNAME\AppData\Roaming\npm' 간단하게 해당 디렉터리를 생성하면 [문제가 해결될 겁니다](http://stackoverflow.com/a/25095327/102704): ```powershell -mkdir ~\AppData\Roaming\npm +$ mkdir ~\AppData\Roaming\npm ``` ### node-gyp is not recognized as an internal or external command diff --git a/docs-translations/ko/development/build-system-overview.md b/docs-translations/ko/development/build-system-overview.md index 7198fa831b92..34f93a8881bd 100644 --- a/docs-translations/ko/development/build-system-overview.md +++ b/docs-translations/ko/development/build-system-overview.md @@ -3,7 +3,7 @@ Electron은 프로젝트 생성을 위해 `gyp`를 사용하며 `ninja`를 이용하여 빌드합니다. 프로젝트 설정은 `.gyp` 와 `.gypi` 파일에서 볼 수 있습니다. -## gyp 파일들 +## gyp 파일 Electron을 빌드 할 때 `gyp` 파일들은 다음과 같은 규칙을 따릅니다: @@ -15,8 +15,8 @@ Electron을 빌드 할 때 `gyp` 파일들은 다음과 같은 규칙을 따릅 ## 구성요소 빌드 Chromium은 꽤나 큰 프로젝트입니다. 이 때문에 최종 링킹 작업은 상당한 시간이 소요될 수 있습니다. -이러한 문제로 인해 개발 시 빌드 작업을 까다롭게 만듭니다. 이 문제를 해결하기 위해 Chromium은 "component build"를 도입했습니다. -이는 각각의 컴포넌트를 각각 따로 분리하여 공유 라이브러리로 빌드 합니다. 이렇게 되면 링킹작업은 매우 빨라지지만 파일 크기와 성능이 느려집니다. +이 문제는 보통 개발을 어렵게 만듭니다. 우리는 이 문제를 해결하기 위해 Chromium의 "component build" 방식을 도입했습니다. +이는 각각의 컴포넌트를 각각 따로 분리하여 공유 라이브러리로 빌드 합니다. 하지만 이 방식을 사용하면 링킹 작업은 매우 빨라지지만 파일 크기와 성능이 느려집니다. Electron도 상당히 비슷한 접근을 했습니다: `Debug`빌드 시 바이너리는 공유 라이브러리 버전의 Chromium 컴포넌트를 사용해서 링크 속도를 높이고 @@ -28,7 +28,7 @@ Electron도 상당히 비슷한 접근을 했습니다: Prebuilt된 모든 Chromium 바이너리들은 부트스트랩 스크립트가 실행될 때 다운로드됩니다. 기본적으로 공유 라이브러리와 정적 라이브러리 모두 다운로드되며 최종 전체 파일 크기는 플랫폼에 따라 800MB에서 2GB까지 차지합니다. -기본적으로 libchromiumcontent는 Amazon Web Service를 통해 다운로드 됩니다. +기본적으로 (`libchromiumcontent`)는 Amazon Web Service를 통해 다운로드 됩니다. 만약 `LIBCHROMIUMCONTENT_MIRROR` 환경 변수가 설정되어 있으면 부트스트랩은 해당 링크를 사용하여 바이너리를 다운로드 합니다. [libchromiumcontent-qiniu-mirror](https://github.com/hokein/libchromiumcontent-qiniu-mirror)는 libchromiumcontent의 미러입니다. 만약 AWS에 접근할 수 없다면 `export LIBCHROMIUMCONTENT_MIRROR=http://7xk3d2.dl1.z0.glb.clouddn.com/`를 통해 다운로드 할 수 있습니다. @@ -43,9 +43,9 @@ $ ./script/build.py -c D ## 프로젝트 생성 (two-phrase) Electron은 `Release`와 `Debug` 빌드가 서로 다른 라이브러리 링크 방식을 사용합니다. -그러나 `gyp`는 따로 빌드 설정을 분리하여 라이브러리 링크 방식을 정의하는 것을 지원하지 않습니다. +하지만 `gyp`는 따로 빌드 설정을 분리하여 라이브러리 링크 방식을 정의하는 것을 지원하지 않습니다. -이러한 문제를 해결하기 위해 Electron은 링크 설정을 제어하는 `gyp` 변수 `libchromiumcontent_component`를 사용하고 `gyp`를 실행할 때 단 하나의 타겟만을 생성합니다. +이 문제를 해결하기 위해 Electron은 링크 설정을 제어하는 `gyp` 변수 `libchromiumcontent_component`를 사용하고 `gyp`를 실행할 때 단 하나의 타겟만 생성합니다. ## 타겟 이름 diff --git a/docs-translations/ko/development/coding-style.md b/docs-translations/ko/development/coding-style.md index 1b88be8487c1..0dc16ba0ad68 100644 --- a/docs-translations/ko/development/coding-style.md +++ b/docs-translations/ko/development/coding-style.md @@ -1,21 +1,24 @@ # 코딩 스타일 +이 가이드는 Electron의 코딩 스타일에 관해 설명합니다. + ## C++과 Python -C++과 Python스크립트는 Chromium의 [코딩 스타일](http://www.chromium.org/developers/coding-style)을 따릅니다. +C++과 Python 스크립트는 Chromium의 [코딩 스타일](http://www.chromium.org/developers/coding-style)을 따릅니다. 파이선 스크립트 `script/cpplint.py`를 사용하여 모든 파일이 해당 코딩스타일에 맞게 코딩 되었는지 확인할 수 있습니다. -파이선의 버전은 2.7을 사용합니다. +Python 버전은 2.7을 사용합니다. -C++ 코드는 많은 Chromium의 추상화와 타입을 사용합니다. 그래서 이에 대해 잘 알고 있어야 합니다. +C++ 코드는 많은 Chromium의 추상화와 타입을 사용합니다. 따라서 Chromium 코드에 대해 잘 알고 있어야 합니다. 이와 관련하여 시작하기 좋은 장소로 Chromium의 [Important Abstractions and Data Structures] (https://www.chromium.org/developers/coding-style/important-abstractions-and-data-structures) 문서가 있습니다. -이 문서에선 몇가지 특별한 타입과 스코프 타입(스코프 밖으로 나가면 자동으로 메모리에서 할당을 해제합니다. 스마트 포인터로 보시면 됩니다), -로깅 메커니즘 등을 언급하고 있습니다. +이 문서에선 몇가지 특별한 타입과 스코프 타입(스코프 밖으로 나가면 자동으로 메모리에서 할당을 해제합니다. 스마트 포인터로 보시면 됩니다) +그리고 로깅 메커니즘 등을 언급하고 있습니다. ## CoffeeScript -CoffeeScript의 경우 GitHub의 [스타일 가이드](https://github.com/styleguide/javascript)를 따릅니다. 동시에 다음 규칙도 따릅니다: +CoffeeScript의 경우 GitHub의 [스타일 가이드](https://github.com/styleguide/javascript)를 기본으로 따릅니다. +그리고 다음 규칙을 따릅니다: * Google의 코딩 스타일에도 맞추기 위해 파일의 끝에는 **절대** 개행을 삽입해선 안됩니다. * 파일 이름의 공백은 `_`대신에 `-`을 사용하여야 합니다. 예를 들어 `file_name.coffee`를 diff --git a/docs-translations/ko/development/source-code-directory-structure.md b/docs-translations/ko/development/source-code-directory-structure.md index f0c9cde40780..f31d0847db75 100644 --- a/docs-translations/ko/development/source-code-directory-structure.md +++ b/docs-translations/ko/development/source-code-directory-structure.md @@ -1,40 +1,43 @@ # 소스 코드 디렉터리 구조 -## 개요 - -Electron의 소스 코드는 몇 개의 파트로 분리되어 있습니다. 우리는 Chromium의 분리 규칙(separation conventions)을 주로 따르고 있습니다. +Electron의 소스 코드는 몇 개의 파트로 분리되어 있습니다. 그리고 Chromium의 분리 규칙(separation conventions)을 주로 따르고 있습니다. 이미 [Chromium의 멀티 프로세스 아키텍쳐](http://dev.chromium.org/developers/design-documents/multi-process-architecture)에 익숙해져 있다면 소스 코드를 이해하기 쉬울 것입니다. ## 소스 코드 구조 -* **atom** - Electron의 소스코드. - * **app** - 시스템 엔트리 코드. - * **browser** - 주 윈도우를 포함한 프론트엔드, UI, 그리고 메인 프로세스에 관련된 것들. 주 랜더러와 웹 페이지 관리관련 코드. - * **lib** - 메인 프로세스 초기화 코드의 자바스크립트 파트. - * **ui** - 크로스 플랫폼에 대응하는 UI 구현. - * **cocoa** - 코코아 특정 소스 코드. - * **gtk** - GTK+ 특정 소스 코드. - * **win** - Windows GUI 특정 소스 코드. - * **default_app** - 어플리케이션이 제공되지 않으면 기본적으로 사용될 페이지. - * **api** - 메인 프로세스 API들의 구현. - * **lib** - API 구현의 자바스크립트 파트. - * **net** - 네트워크 관련 코드. - * **mac** - Mac 특정 Objective-C 소스 코드. - * **resources** - 아이콘들, 플랫폼 종속성 파일들, 기타 등등. - * **renderer** - 렌더러 프로세스에서 작동하는 코드들. - * **lib** - 렌더러 프로세스 초기화 코드의 자바스크립트 파트. - * **api** - 렌더러 프로세스 API들의 구현. - * **lib** - API 구현의 자바스크립트 파트. - * **common** - 메인 프로세스와 렌더러 프로세스에서 공유하는 코드. 유틸리티 함수와 node 메시지 루프를 Chromium의 메시지 루프에 통합시킨 코드가 포함. - * **lib** - 공통 자바스크립트 초기화 코드. - * **api** - 공통 API들의 구현, Electron의 빌트인 모듈 기초 코드들. - * **lib** - API 구현의 자바스크립트 파트. -* **chromium_src** - 복사된 Chromium 소스 코드. -* **docs** - 참조 문서. -* **spec** - 자동화된 테스트. -* **atom.gyp** - Electron의 빌드 규칙. -* **common.gypi** - 컴파일러 설정 및 `node` 와 `breakpad` 등의 구성요소를 위한 빌드 규칙. +``` +Electron +├──atom - Electron의 소스코드. +| ├── app - 시스템 엔트리 코드. +| ├── browser - 주 윈도우를 포함한 프론트엔드, UI, 그리고 메인 프로세스에 관련된 것들. +| | | 랜더러와 웹 페이지 관리 관련 코드. +| | ├── lib - 메인 프로세스 초기화 코드의 자바스크립트 파트. +| | ├── ui - 크로스 플랫폼에 대응하는 UI 구현. +| | | ├── cocoa - 코코아 특정 소스 코드. +| | | ├── gtk - GTK+ 특정 소스 코드. +| | | └── win - Windows GUI 특정 소스 코드. +| | ├── default_app - 어플리케이션이 제공되지 않으면 기본으로 사용되는 페이지. +| | ├── api - 메인 프로세스 API의 구현. +| | | └── lib - API 구현의 자바스크립트 파트. +| | ├── net - 네트워크 관련 코드. +| | ├── mac - Mac 특정 Objective-C 소스 코드. +| | └── resources - 아이콘들, 플랫폼 종속성 파일들, 기타 등등. +| ├── renderer - 랜더러 프로세스에서 작동하는 코드들. +| | ├── lib - 랜더러 프로세스 초기화 코드의 자바스크립트 파트. +| | └── api - 랜더러 프로세스 API들의 구현. +| | └── lib - API 구현의 자바스크립트 파트. +| └── common - 메인 프로세스와 랜더러 프로세스에서 공유하는 코드. +| | 유틸리티 함수와 node 메시지 루프를 Chromium의 메시지 루프에 통합시킨 코드도 포함. +| ├── lib - 공통 자바스크립트 초기화 코드. +| └── api - 공통 API들의 구현, Electron의 빌트인 모듈 기초 코드들. +| └── lib - API 구현의 자바스크립트 파트. +├── chromium_src - 복사된 Chromium 소스 코드. +├── docs - 참조 문서. +├── spec - 자동화된 테스트. +├── atom.gyp - Electron의 빌드 규칙. +└── common.gypi - 컴파일러 설정 및 `node` 와 `breakpad` 등의 구성요소를 위한 빌드 규칙. +``` ## 그외 디렉터리 구조 @@ -45,4 +48,4 @@ Electron의 소스 코드는 몇 개의 파트로 분리되어 있습니다. 우 * **node_modules** - 빌드에 사용되는 node 서드파티 모듈. * **out** - `ninja`의 임시 출력 디렉터리. * **dist** - 배포용 바이너리를 빌드할 때 사용하는 `script/create-dist.py` 스크립트로부터 만들어지는 임시 디렉터리. -* **external_binaries** - `gyp`를 통한 빌드가 지원하지 않아 따로 다운로드된 서드파티 프레임워크 바이너리들. +* **external_binaries** - `gyp` 빌드를 지원하지 않아 따로 다운로드된 서드파티 프레임워크 바이너리들. diff --git a/docs-translations/ko/tutorial/application-distribution.md b/docs-translations/ko/tutorial/application-distribution.md index fac2ae48a140..69269500733a 100644 --- a/docs-translations/ko/tutorial/application-distribution.md +++ b/docs-translations/ko/tutorial/application-distribution.md @@ -1,7 +1,9 @@ # 어플리케이션 배포 -Electron 어플리케이션을 배포하려면 어플리케이션 폴더 이름을 `app`으로 지정한 후 Electron 실행파일의 리소스 디렉터리에 집어넣기만 하면 됩니다. -리소스 디렉터리는 OS X에선 `Electron.app/Contents/Resources/` Windows와 Linux에선 `resources/` 입니다. +Electron 어플리케이션을 배포하는 방법은 간단합니다. + +먼저 폴더 이름을 `app`로 지정한 후 Electron 리소스 디렉터리에 폴더를 통째로 집어넣기만 하면 됩니다. +리소스 디렉터리는 OS X: `Electron.app/Contents/Resources/` Windows와 Linux: `resources/` 입니다. 예제: @@ -32,7 +34,7 @@ electron/resources/app 어플리케이션의 소스코드가 사용자에게 노출되는 것을 방지할 수 있습니다. `asar` 아카이브를 사용할 땐 단순히 `app` 폴더 대신에 어플리케이션을 패키징한 `app.asar` 파일로 대체하면됩니다. -이렇게 하면 Electron은 아카이브를 `app`폴더 대신 asar 아카이브를 기반으로 어플리케이션을 실행합니다. +Electron은 자동으로 `app`폴더 대신 asar 아카이브를 기반으로 어플리케이션을 실행합니다. OS X의 경우: diff --git a/docs-translations/ko/tutorial/application-packaging.md b/docs-translations/ko/tutorial/application-packaging.md index 0f8169089516..d7a96dbb4b43 100644 --- a/docs-translations/ko/tutorial/application-packaging.md +++ b/docs-translations/ko/tutorial/application-packaging.md @@ -8,7 +8,7 @@ Windows에서 일어나는 긴 경로 이름에 대한 [issues](https://github.c [asar][asar] 아카이브는 tar과 비슷한 포맷으로 모든 리소스를 하나의 파일로 만듭니다. 그리고 Electron은 압축해제 없이 임의로 모든 파일을 읽어들일 수 있습니다. -다음 몇가지 단계를 통해 어플리케이션을 `asar` 아카이브로 압축할 수 있습니다: +간단한 작업을 통해 어플리케이션을 `asar` 아카이브로 압축할 수 있습니다: ### 1. asar 유틸리티 설치 @@ -24,13 +24,13 @@ $ asar pack your-app app.asar ## `asar` 아카이브 사용하기 -Electron은 Node.js로 부터 제공된 Node API와 Chromium으로부터 제공된 Web API 두가지의 API를 가지고 있습니다. -두 API 모두 `asar`에서 읽어들일 수 있도록 지원합니다. +Electron은 Node.js로 부터 제공된 Node API와 Chromium으로부터 제공된 Web API 두 가지 API를 가지고 있습니다. +따라서 `asar` 아카이브는 두 API 모두 사용할 수 있도록 지원합니다. ### Node API Electron에선 `fs.readFile`과 `require` 같은 Node API들을 지원하기 위해 `asar` 아카이브가 가상의 디렉터리 구조를 가지도록 -패치했습니다. 그래서 아카이브 내부에서 리소스들을 정상적인 파일 시스템처럼 접근할 수 있습니다. +패치했습니다. 그래서 아카이브 내부 리소스들을 정상적인 파일 시스템처럼 접근할 수 있습니다. 예를 들어 `/path/to`라는 경로에 `example.asar`라는 아카이브가 있다고 가정하면: diff --git a/docs-translations/ko/tutorial/debugging-main-process.md b/docs-translations/ko/tutorial/debugging-main-process.md index dcaf6bc9bf36..c11f3db04f3a 100644 --- a/docs-translations/ko/tutorial/debugging-main-process.md +++ b/docs-translations/ko/tutorial/debugging-main-process.md @@ -1,13 +1,15 @@ # 메인 프로세스 디버깅하기 -브라우저 창의 개발자 콘솔은 랜더러 프로세스의 스크립트만 디버깅이 가능합니다. (다시말해 웹 페이지) -메인 프로세스의 디버깅 방법을 제공하기 위해 Electron은 `--debug` 과 `--debug-brk` 스위치들을 제공합니다. +브라우저 창의 개발자 콘솔은 웹 페이지 같은 랜더러 프로세스의 스크립트만 디버깅이 가능합니다. +대신 Electron은 메인 프로세스의 디버깅을 위해 `--debug` 과 `--debug-brk` 스위치들을 제공합니다. ## 커맨드 라인 스위치(command line switches) +다음 스위치들을 사용하여 Electron의 메인 프로세스를 디버깅 할 수 있습니다: + ### `--debug=[port]` -이 스위치를 사용하면 Electron은 지정한 `port`에 V8 디버거 프로토콜을 리스닝합니다. `port`는 `5858`이 기본적으로 사용됩니다. +이 스위치를 사용하면 Electron은 지정한 `port`에 V8 디버거 프로토콜을 리스닝합니다. 기본 `port`는 `5858` 입니다. ### `--debug-brk=[port]` @@ -15,8 +17,9 @@ ## node-inspector로 디버깅 하기 -__주의:__ Electron은 node v0.11.13 버전을 사용합니다. node-inspector는 현재 아주 잘 작동하지 않습니다. -그리고 메인 프로세스의 `process`를 node-inspector 콘솔 내에서 검사할 경우 크래시가 발생할 수 있습니다. +__참고:__ Electron은 node v0.11.13 버전을 사용합니다. +그리고 현재 node-inspector 유틸리티와 호환성 문제가 있습니다. +추가로 node-inspector 콘솔 내에서 메인 프로세스의 `process` 객체를 탐색할 경우 크래시가 발생할 수 있습니다. ### 1. [node-inspector][node-inspector] 서버 시작 diff --git a/docs-translations/ko/tutorial/desktop-environment-integration.md b/docs-translations/ko/tutorial/desktop-environment-integration.md index 50b142f0bda1..94f0ffa013a7 100644 --- a/docs-translations/ko/tutorial/desktop-environment-integration.md +++ b/docs-translations/ko/tutorial/desktop-environment-integration.md @@ -7,7 +7,7 @@ ## 최근 사용한 문서 (Windows & OS X) -Windows와 OS X는 dock menu나 JumpList등을 통하여 최근 문서 리스트에 쉽게 접근할 수 있습니다. +알다 싶이 Windows와 OS X는 JumpList 또는 dock 메뉴를 통해 최근 문서 리스트에 쉽게 접근할 수 있습니다. __JumpList:__ @@ -88,10 +88,10 @@ __Internet Explorer의 작업:__ ![IE](http://i.msdn.microsoft.com/dynimg/IC420539.png) -OS X의 말 그대로 메뉴로 작동하는 dock menu 와는 달리 Windows의 사용자 작업은 어플리케이션 바로가기처럼 작동합니다. -유저가 작업을 클릭할 시 설정한 인자와 함께 새로운 어플리케이션이 실행됩니다. +OS X의 dock menu(진짜 메뉴)와는 달리 Windows의 사용자 작업은 어플리케이션 바로 가기처럼 작동합니다. +유저가 작업을 클릭할 때 설정한 인자와 함께 새로운 어플리케이션이 실행됩니다. -사용자 작업을 설정하려면 [app.setUserTasks][setusertaskstasks] API를 사용하여 구현할 수 있습니다: +사용자 작업을 설정하려면 [app.setUserTasks][setusertaskstasks] 메서드를 통해 구현할 수 있습니다: ```javascript var app = require('app'); @@ -166,7 +166,7 @@ win.setThumbarButtons([]); ## Unity 런처 숏컷 기능 (Linux) -Unity 환경에선 `.desktop` 파일을 수정함으로써 런처에 새로운 커스텀 엔트리를 추가할 수 있습니다. [Adding shortcuts to a launcher][unity-launcher] 가이드를 참고하세요. +Unity 환경에선 `.desktop` 파일을 수정함으로써 런처에 새로운 커스텀 엔트리를 추가할 수 있습니다. [Adding Shortcuts to a Launcher][unity-launcher] 가이드를 참고하세요. __Audacious의 런처 숏컷:__ diff --git a/docs-translations/ko/tutorial/devtools-extension.md b/docs-translations/ko/tutorial/devtools-extension.md index 81ebed413429..e6a9b559c35f 100644 --- a/docs-translations/ko/tutorial/devtools-extension.md +++ b/docs-translations/ko/tutorial/devtools-extension.md @@ -2,8 +2,8 @@ 어플리케이션의 디버깅을 쉽게 하기 위해 Electron은 기본적으로 [Chrome DevTools Extension][devtools-extension]을 지원합니다. -개발자 콘솔 확장기능은 간단하게 사용할 확장기능 플러그인의 소스코드를 다운로드한 후 `BrowserWindow.addDevToolsExtension` API를 이용하여 -어플리케이션 내에 로드할 수 있습니다. 한가지 주의할 점은 확장기능 사용시 창이 생성될 때 마다 일일이 해당 API를 호출할 필요는 없습니다. +개발자 콘솔 확장 기능은 간단하게 사용할 확장 기능 플러그인의 소스 코드를 다운로드한 후 `BrowserWindow.addDevToolsExtension` API를 이용하여 +어플리케이션 내에 로드할 수 있습니다. 한가지 주의할 점은 확장 기능 사용시 창이 생성될 때 마다 일일이 해당 API를 호출할 필요는 없습니다. 예시로 [React DevTools Extension](https://github.com/facebook/react-devtools)을 사용합니다. @@ -14,34 +14,34 @@ $ cd /some-directory $ git clone --recursive https://github.com/facebook/react-devtools.git ``` -그리고 개발자 콘솔이 열린 창에서 다음의 코드를 콘솔에 입력하면 확장기능을 로드할 수 있습니다: +그리고 개발자 콘솔이 열린 창에서 다음의 코드를 콘솔에 입력하면 확장 기능을 로드할 수 있습니다: ```javascript require('remote').require('browser-window').addDevToolsExtension('/some-directory/react-devtools'); ``` -확장기능을 unload 하고 콘솔을 다시 열 때 해당 확장기능이 로드되지 않도록 하려면 `BrowserWindow.removeDevToolsExtension` API를 사용하면 됩니다: +확장 기능을 unload 하고 콘솔을 다시 열 때 해당 확장 기능이 로드되지 않도록 하려면 `BrowserWindow.removeDevToolsExtension` API를 사용하면 됩니다: ```javascript require('remote').require('browser-window').removeDevToolsExtension('React Developer Tools'); ``` -## 개발자 콘솔 확장기능의 구성 형식 +## 개발자 콘솔 확장 기능의 구성 형식 -완벽하게 모든 개발자 콘솔 확장은 Chrome 브라우저를 위해 작성되었기 때문에 Electron에서도 로드할 수 있습니다. -하지만 반드시 확장기능은 소스코드 그대로의 디렉터리(폴더) 형태여야 합니다. 그래서 `crx` 등의 포맷으로 패키징된 확장기능의 경우 -사용자가 직접 해당 패키지의 압축을 풀어서 로드하지 않는 이상은 Electron에서 해당 확장기능의 압축을 풀 방법이 없습니다. +모든 개발자 콘솔 확장은 완벽히 Chrome 브라우저를 위해 작성되었기 때문에 Electron에서도 로드할 수 있습니다. +하지만 반드시 확장 기능은 소스코드 그대로의 디렉터리(폴더) 형태여야 합니다. 그래서 `crx` 등의 포맷으로 패키징된 확장 기능의 경우 +사용자가 직접 해당 패키지의 압축을 풀어서 로드하지 않는 이상은 Electron에서 해당 확장 기능의 압축을 풀 방법이 없습니다. ## 백그라운드 페이지 현재 Electron은 Chrome에서 지원하는 백그라운드 페이지(background pages)를 지원하지 않습니다. -몇몇 확장기능은 이 기능에 의존하는 경우가 있는데 이 경우 해당 확장기능은 Electron에서 작동하지 않을 수 있습니다. +몇몇 확장 기능은 이 기능에 의존하는 경우가 있는데 이 경우 해당 확장 기능은 Electron에서 작동하지 않을 수 있습니다. ## `chrome.*` API -몇몇 Chrome 확장기능은 특정 기능을 사용하기 위해 `chrome.*` API를 사용하는데, Electron에선 이 API들을 구현하기 위해 노력했지만 안타깝게도 아직 모든 API가 구현되지는 않았습니다. +몇몇 Chrome 확장 기능은 특정 기능을 사용하기 위해 `chrome.*` API를 사용하는데, 이 API들을 구현하기 위해 노력했지만 안타깝게도 아직 모든 API가 구현되지는 않았습니다. -아직 모든 API가 구현되지 않았기 때문에 확장기능에서 `chrome.devtools.*` 대신 `chrome.*` API를 사용할 경우 확장기능이 제대로 작동하지 않을 수 있음을 감안해야 합니다. -만약 문제가 발생할 경우 Electron의 GitHub repo에 이슈를 올리면 해당 API를 추가하는데 많은 도움이 됩니다. +아직 모든 API가 구현되지 않았기 때문에 확장 기능에서 `chrome.devtools.*` 대신 `chrome.*` API를 사용할 경우 확장 기능이 제대로 작동하지 않을 수 있음을 감안해야 합니다. +만약 문제가 발생할 경우 Electron의 GitHub 저장소에 관련 이슈를 올리면 해당 API를 추가하는데 많은 도움이 됩니다. [devtools-extension]: https://developer.chrome.com/extensions/devtools diff --git a/docs-translations/ko/tutorial/online-offline-events.md b/docs-translations/ko/tutorial/online-offline-events.md index 3ccf20c7d568..57e0f48a3e0d 100644 --- a/docs-translations/ko/tutorial/online-offline-events.md +++ b/docs-translations/ko/tutorial/online-offline-events.md @@ -35,8 +35,8 @@ _online-status.html_ ``` -물론 필요하다면 이 이벤트를 메인 프로세스로 보낼 수도 있습니다. -하지만 메인 프로세스는 `navigator` 객체를 가지고 있지 않기 때문에 이 이벤트를 직접 사용할 수 없습니다. +메인 프로세스에서 이 이벤트를 처리할 필요가 있는 경우 이벤트를 메인 프로세스로 보낼 수 있습니다. +메인 프로세스는 `navigator` 객체를 가지고 있지 않기 때문에 이 이벤트를 직접 사용할 수 없습니다. 대신 다음 예제와 같이 Electron의 inter-process communication(ipc) 유틸리티를 사용하면 이벤트를 메인 프로세스로 전달할 수 있습니다. diff --git a/docs-translations/ko/tutorial/quick-start.md b/docs-translations/ko/tutorial/quick-start.md index 37b48d993342..4a642c253838 100644 --- a/docs-translations/ko/tutorial/quick-start.md +++ b/docs-translations/ko/tutorial/quick-start.md @@ -27,15 +27,14 @@ Electron 프로세스 내에서 작동하는 웹 페이지를 __랜더러 프로 `BrowserWindow` 인스턴스는 따로 분리된 프로세스에서 랜더링 되며 이 프로세스를 랜더러 프로세스라고 합니다. `BrowserWindow` 인스턴스가 소멸할 때 그 창의 랜더러 프로세스도 같이 소멸합니다. -메인 프로세스는 모든 웹 페이지와 랜더러 프로세스를 관리하며 -랜더러 프로세스는 각각의 프로세스에 고립되며 웹 페이지의 작동에만 영향을 끼칩니다. +메인 프로세스는 모든 웹 페이지와 랜더러 프로세스를 관리하며 랜더러 프로세스는 각각의 프로세스에 고립되며 웹 페이지의 작동에만 영향을 끼칩니다. -웹 페이지 내에서 네이티브 GUI 리소스를 관리하는 것은 보안에 취약하고 리소스를 누수시킬 수 있기 때문에 -기본적으로 웹 페이지 내에서는 네이티브 GUI와 관련된 API를 호출할 수 없도록 되어 있습니다. -만약 웹 페이지 내에서 GUI작업이 필요하다면 메인 프로세스에서 그 작업을 할 수 있도록 메인 프로세스와 통신을 해야합니다. +웹 페이지 내에선 기본적으로 네이티브 GUI와 관련된 API를 호출할 수 없도록 설계 되어 있습니다. +왜냐하면 웹 페이지 내에서 네이티브 GUI 리소스를 관리하는 것은 보안에 취약하고 리소스를 누수시킬 수 있기 때문입니다. +꼭 웹 페이지 내에서 API를 사용해야 한다면 메인 프로세스에서 그 작업을 처리할 수 있도록 메인 프로세스와 통신을 해야 합니다. -Electron에는 메인 프로세스와 랜더러 프로세스간에 통신을 할 수 있도록 [ipc](../api/ipc-renderer.md) 모듈을 제공하고 있습니다. -또한 [remote](../api/remote.md) 모듈을 사용하여 RPC 스타일로 통신할 수도 있습니다. +Electron에는 메인 프로세스와 랜더러 프로세스 사이에 통신을 할 수 있도록 [ipc](../api/ipc-renderer.md) 모듈을 제공하고 있습니다. +또는 [remote](../api/remote.md) 모듈을 사용하여 RPC 스타일로 통신할 수도 있습니다. ## 첫번째 Electron 앱 만들기 @@ -49,7 +48,7 @@ your-app/ ``` `package.json`은 node 모듈의 package.json과 같습니다. -그리고 `main` 필드에 스크립트 파일을 집어넣어 메인 프로세스로 사용할 엔트리 포인트를 지정할 수 있습니다. +그리고 `main` 필드에 스크립트 파일을 지정하면 메인 프로세스의 엔트리 포인트로 사용합니다. 예를 들어 사용할 수 있는 `package.json`은 다음과 같습니다: ```json @@ -176,4 +175,4 @@ $ ./Electron.app/Contents/MacOS/Electron your-app/ ### 배포용 파일 만들기 -어플리케이션 작성을 완료했다면 [어플리케이션 배포](application-distribution.md) 가이드를 통해 본격적으로 제작한 앱을 배포할 수 있습니다. \ No newline at end of file +어플리케이션 작성을 완료했다면 [어플리케이션 배포](application-distribution.md) 가이드를 통해 제작한 앱을 본격적으로 배포할 수 있습니다. \ No newline at end of file diff --git a/docs-translations/ko/tutorial/using-native-node-modules.md b/docs-translations/ko/tutorial/using-native-node-modules.md index 4584ebd460fe..f9cb2be3bf53 100644 --- a/docs-translations/ko/tutorial/using-native-node-modules.md +++ b/docs-translations/ko/tutorial/using-native-node-modules.md @@ -6,7 +6,7 @@ Electron에선 node.js 네이티브 모듈이 지원됩니다. 하지만 Electro ## 네이티브 node 모듈 호환성 Node v0.11.x 버전부터는 V8 API의 중대한 변경이 있었습니다. 하지만 대부분의 네이티브 모듈은 Node v0.10.x 버전을 타겟으로 작성 되었기 때문에 -새로운 Node 또는 io.js 버전에서 작동하지 않을 수 있습니다. Electron은 내부적으로 __io.js v3.1.0__ 버전을 사용하기 때문에 이러한 호환성 문제가 발생할 수 있습니다. +새로운 Node 또는 io.js 버전에서 작동하지 않을 수 있습니다. Electron은 내부적으로 __io.js v3.1.0__ 버전을 사용하기 때문에 호환성 문제가 발생할 수 있습니다. 이 문제를 해결하기 위해선 모듈이 v0.11.x 또는 최신 버전을 지원할 수 있도록 변경해야 합니다. 현재 [많은 모듈들](https://www.npmjs.org/browse/depended/nan)이 안정적으로 두 버전 모두 지원하고 있지만 오래된 모듈의 경우 여전히 Node v0.10.x 버전만을 지원하고 있습니다. @@ -14,6 +14,8 @@ Node v0.11.x 버전부터는 V8 API의 중대한 변경이 있었습니다. 하 ## 네이티브 모듈 설치하는 방법 +네이티브 모듈을 설치하는 방법은 세 가지 종류가 있습니다. + ### 쉬운 방법 [`electron-rebuild`](https://github.com/paulcbetts/electron-rebuild) 패키지를 사용하면 빠르고 간단하게 네이티브 모듈을 다시 빌드할 수 있습니다. @@ -22,7 +24,7 @@ Node v0.11.x 버전부터는 V8 API의 중대한 변경이 있었습니다. 하 ```sh npm install --save-dev electron-rebuild -# 필요한 네이티브 모듈을 `npm install`로 설치한 후 다음 작업을 실행하세요: +# 필요한 네이티브 모듈을 `npm install`로 설치한 후 다음 명령을 실행하세요: ./node_modules/.bin/electron-rebuild ``` diff --git a/docs-translations/ko/tutorial/using-pepper-flash-plugin.md b/docs-translations/ko/tutorial/using-pepper-flash-plugin.md index 4577bc296fea..f47f20d8a71e 100644 --- a/docs-translations/ko/tutorial/using-pepper-flash-plugin.md +++ b/docs-translations/ko/tutorial/using-pepper-flash-plugin.md @@ -1,7 +1,7 @@ # Pepper 플래시 플러그인 사용하기 -작업에 필요한 경우 pepper 플래시 플러그인을 사용할 수 있습니다. -Electron에서 pepper 플래시 플러그인을 사용하기 위해선 따로 pepper 플래시 플러그인의 위치를 지정해 주어야합니다. +Electron은 Pepper 플래시 플러그인을 지원합니다. +Pepper 플래시 플러그인을 사용하려면 Pepper 플래시 플러그인의 위치를 지정해야 합니다. ## 플래시 플러그인 준비하기 @@ -10,7 +10,7 @@ Electron에서 플래시 플러그인을 지원하기 위해선 이 두 가지 ## Electron 스위치 추가 -플러그인을 사용하기 위해 직접적으로 `--ppapi-flash-path` 와 `ppapi-flash-version` 플래그를 ready 이벤트가 호출되기 전에 추가해야합니다. +플러그인을 사용하려면 Electron 커맨드 라인에 `--ppapi-flash-path` 와 `ppapi-flash-version` 플래그를 app의 ready 이벤트가 호출되기 전에 추가해야 합니다. 그리고 `browser-window`에 `plugins` 스위치도 추가해야합니다. ```javascript @@ -20,8 +20,6 @@ var BrowserWindow = require('browser-window'); // Report crashes to our server. require('crash-reporter').start(); -// Keep a global reference of the window object, if you don't, the window will -// be closed automatically when the javascript object is GCed. var mainWindow = null; // Quit when all windows are closed. @@ -54,7 +52,9 @@ app.on('ready', function() { ``` ## `` 태그를 이용하여 플러그인을 활성화 + `plugins` 속성을 `` 태그에 추가합니다. + ```html ``` diff --git a/docs-translations/ko/tutorial/using-selenium-and-webdriver.md b/docs-translations/ko/tutorial/using-selenium-and-webdriver.md index a29e8e2214ef..33dc6311ce35 100644 --- a/docs-translations/ko/tutorial/using-selenium-and-webdriver.md +++ b/docs-translations/ko/tutorial/using-selenium-and-webdriver.md @@ -7,13 +7,13 @@ > ChromeDriver는 Chromium의 WebDriver wire 프로토콜 스텐드얼론 서버 구현입니다. > Chromium 과 WebDriver 팀 멤버에 의해 개발되었습니다. -Electron과 `chromedriver`를 같이 사옹하려면 드라이버에서 Electron을 찾을 수 있도록 해야 하고 +Electron에서 `chromedriver`를 사옹하려면 드라이버에서 Electron을 찾을 수 있도록 해야 하며 Electron은 Chrome 브라우저와 비슷하다는 점을 기억해야 합니다. ## WebDriverJs 설정하기 -[WebDriverJs](https://code.google.com/p/selenium/wiki/WebDriverJs)는 WebDriver를 사용하여 테스팅 할 수 있도록 도와주는 node 패키지입니다. -다음 예제를 참고하세요: +[WebDriverJs](https://code.google.com/p/selenium/wiki/WebDriverJs)는 WebDriver를 사용하여 테스트 할 수 있도록 도와주는 node 패키지입니다. +다음 예제를 참고하세요. ### 1. 크롬 드라이버 시작 @@ -25,7 +25,7 @@ Starting ChromeDriver (v2.10.291558) on port 9515 Only local connections are allowed. ``` -포트 `9515`는 나중에 사용하므로 기억해 놓읍시다 +포트 `9515`는 나중에 사용하므로 기억해 놓습니다. ### 2. WebDriverJS 설치 @@ -35,7 +35,7 @@ $ npm install selenium-webdriver ### 3. 크롬 드라이버에 연결 -`selenium-webdriver`를 Electron과 같이 사용할 땐 기본적으로 upstream과 같습니다. +`selenium-webdriver`를 Electron과 같이 사용하는 방법은 기본적으로 upstream과 같습니다. 한가지 다른점이 있다면 수동으로 크롬 드라이버 연결에 대해 설정하고 Electron 실행파일의 위치를 전달합니다: ```javascript @@ -45,7 +45,7 @@ var driver = new webdriver.Builder() // 작동하고 있는 크롬 드라이버의 포트 "9515"를 사용합니다. .usingServer('http://localhost:9515') .withCapabilities({chromeOptions: { - // 여기에 사용중인 Electron 바이너리의 경로를 기재하세요. + // 여기에 사용중인 Electron 바이너리의 경로를 지정하세요. binary: '/Path-to-Your-App.app/Contents/MacOS/Atom'}}) .forBrowser('electron') .build(); @@ -88,11 +88,11 @@ $ npm install webdriverio ```javascript var webdriverio = require('webdriverio'); var options = { - host: "localhost", // Use localhost as chrome driver server - port: 9515, // "9515" is the port opened by chrome driver. + host: "localhost", // localhost에서 작동중인 크롬 드라이버 서버를 사용합니다. + port: 9515, // 연결할 크롬 드라이버 서버의 포트를 설정합니다. desiredCapabilities: { browserName: 'chrome', - chromeOptions: {binary: '/Path-to-Your-App.app/Electron'} // Path to your Electron binary. + chromeOptions: {binary: '/Path-to-Your-App.app/Electron'} // Electron 바이너리의 위치 } }; From 05031a38e51e47da3be8c46650cc2d48e1e539c6 Mon Sep 17 00:00:00 2001 From: John-Lin Date: Fri, 4 Sep 2015 15:42:57 +0800 Subject: [PATCH 1116/1293] Add api docs translations --- .../zh-TW/api/ipc-main-process.md | 69 +++++++++++++++++++ 1 file changed, 69 insertions(+) create mode 100644 docs-translations/zh-TW/api/ipc-main-process.md diff --git a/docs-translations/zh-TW/api/ipc-main-process.md b/docs-translations/zh-TW/api/ipc-main-process.md new file mode 100644 index 000000000000..00e73efb4fc4 --- /dev/null +++ b/docs-translations/zh-TW/api/ipc-main-process.md @@ -0,0 +1,69 @@ +# ipc (主行程) + +當在主行程裡使用 `ipc` 模組，這個模組負責處理來自渲染行程（網頁）的非同步與同步訊息。 +來自渲染器的訊息將會被注入到這個模組裡。 + +## 傳送訊息 + +同樣的也可以透過主行程來傳送訊息到渲染行程，更多資訊請參考 [WebContents.send](browser-window.md#webcontentssendchannel-args) + +- 當傳送一個訊息， 事件名稱為 `channel` +- 回覆同步訊息，你需要設定 `event.returnValue` +- 送出一個非同步訊息回給發送端，你可以使用 `event.sender.send(...)` + +這裏是一個傳送和處理訊息的範例，在渲染行程與主行程之間： + +```javascript +// 在主行程裡 +var ipc = require('ipc'); +ipc.on('asynchronous-message', function(event, arg) { + console.log(arg); // 輸出 "ping" + event.sender.send('asynchronous-reply', 'pong'); +}); + +ipc.on('synchronous-message', function(event, arg) { + console.log(arg); // 輸出 "ping" + event.returnValue = 'pong'; +}); +``` + +```javascript +// 在渲染行程裡 (網頁). +var ipc = require('ipc'); +console.log(ipc.sendSync('synchronous-message', 'ping')); // 輸出 "pong" + +ipc.on('asynchronous-reply', function(arg) { + console.log(arg); // 輸出 "pong" +}); +ipc.send('asynchronous-message', 'ping'); +``` + +## 聆聽訊息 + +`ipc` 模組擁有下列幾個方法去聆聽事件： + +### `ipc.on(channel, callback)` + +* `channel` String - 事件名稱 +* `callback` Function + +當一個事件發生 `callback` 會帶著 `event` 物件和一個訊息 `arg` + +## IPC 事件 + +`event` 物件被傳入 `callback` 具有以下幾個方法： + +### `Event.returnValue` + +設定這個值可以回傳一個同步訊息 + +### `Event.sender` + +回傳 `WebContents` 可以送出訊息 + +### `Event.sender.send(channel[, arg1][, arg2][, ...])` + +* `channel` String - 事件名稱 +* `arg` (選用) + +此傳送訊息是非同步的訊息，至渲染行程，可以是一個一系列的參數 `arg` 可以是任何型態。 From 30c714a27f2edb4f54df64dbf06c106f2c8ae6d7 Mon Sep 17 00:00:00 2001 From: John-Lin Date: Fri, 4 Sep 2015 15:47:46 +0800 Subject: [PATCH 1117/1293] Fix typos in zh-TW README docs --- docs-translations/zh-TW/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs-translations/zh-TW/README.md b/docs-translations/zh-TW/README.md index 7c954034f21d..cc75ba51c144 100644 --- a/docs-translations/zh-TW/README.md +++ b/docs-translations/zh-TW/README.md @@ -2,8 +2,8 @@ * [應用程式發布](tutorial/application-distribution.md) * [應用程式打包](tutorial/application-packaging.md) -* [使用原生模組](tutorial/using-native-node-modules.md) -* [Debug 主行程](tutorial/debugging-main-process.md) +* [使用原生 node 模組](tutorial/using-native-node-modules.md) +* [主行程 Debug](tutorial/debugging-main-process.md) * [使用 Selenium 和 WebDriver](tutorial/using-selenium-and-webdriver.md) * [DevTools 擴充](tutorial/devtools-extension.md) * [使用 Pepper Flash 套件](tutorial/using-pepper-flash-plugin.md) @@ -22,7 +22,7 @@ 客製的 DOM 元素: -* [`File`對象](api/file-object.md) +* [`File`物件](api/file-object.md) * [``物件](api/web-view-tag.md) * [`window.open`函數](api/window-open.md) From 67026cccc867db6a01765d385d484f2aa9814b77 Mon Sep 17 00:00:00 2001 From: John-Lin Date: Fri, 4 Sep 2015 16:06:15 +0800 Subject: [PATCH 1118/1293] Add api/shell.md docs zh-TW translations --- docs-translations/zh-TW/api/shell.md | 46 ++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 docs-translations/zh-TW/api/shell.md diff --git a/docs-translations/zh-TW/api/shell.md b/docs-translations/zh-TW/api/shell.md new file mode 100644 index 000000000000..3f3c9ae951c2 --- /dev/null +++ b/docs-translations/zh-TW/api/shell.md @@ -0,0 +1,46 @@ +# shell + +`shell` 模組提供一些整合桌面應用的功能。 + + +一個範例示範如何利用使用者的預設瀏覽器開啟 URL: + +```javascript +var shell = require('shell'); + +shell.openExternal('https://github.com'); +``` + +## Methods + +`shell` 模組有以下幾個方法: + +### `shell.showItemInFolder(fullPath)` + +* `fullPath` String + +顯示在檔案管理中指定的檔案，如果可以的話，選擇該檔案。 + +### `shell.openItem(fullPath)` + +* `fullPath` String + +打開指定的檔案，在桌面的預設方式。 +Open the given file in the desktop's default manner. + +### `shell.openExternal(url)` + +* `url` String + +打開一個指定的外部協定 URL 在桌面的預設方式。（舉例來說 mailto: URLs 會打開使用者的預設信箱） + + +### `shell.moveItemToTrash(fullPath)` + +* `fullPath` String + +移動指定檔案至垃圾桶，並會對這個操作回傳一個 boolean 狀態 + +### `shell.beep()` + +播放 beep 聲音。 From e72e09719a118eaed3eacbbf562b31043c32ed01 Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Fri, 4 Sep 2015 18:05:28 +0900 Subject: [PATCH 1119/1293] Update web-view-tag.md * Update as upstream --- docs-translations/ko/api/web-view-tag.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs-translations/ko/api/web-view-tag.md b/docs-translations/ko/api/web-view-tag.md index 0ed8558fa2fd..e292e972dcd2 100644 --- a/docs-translations/ko/api/web-view-tag.md +++ b/docs-translations/ko/api/web-view-tag.md @@ -118,6 +118,23 @@ "on"으로 지정하면 페이지의 웹 보안을 해제합니다. +### `partition` + +```html + + +``` + +`webview`에서 사용하는 스토리지 파티션을 지정합니다. +스토리지 파티션 ID를 `persist:`로 시작하도록 지정하면 앱의 모든 `webview`에서 지정한 스토리지 파티션 ID를 사용하도록 할 수 있습니다. +만약 `persist:` 접두사가 없을 경우 `webview`는 인 메모리 스토리지 파티션을 사용합니다. +여러 `webview`에서 같은 파티션 ID를 사용하면 같은 스토리지 파티션을 공유합니다. +만약 스토리지 파티션 ID가 지정되지 않으면 앱의 기본 스토리지를 사용합니다. + +이 값은 첫 탐색 이전에만 지정할 수 있습니다. +즉. 작동중인 랜더러 프로세스의 스토리지 파티션은 변경할 수 없습니다. +이후 이 값을 바꾸려고 시도하면 DOM 예외를 발생시킵니다. + ## Methods `webview` 태그는 다음과 같은 메서드를 가지고 있습니다: From eb8ac2b5d8461bcfb6a1487fe5c57e68df12e882 Mon Sep 17 00:00:00 2001 From: Jonatas Freitas Date: Fri, 4 Sep 2015 11:42:37 -0300 Subject: [PATCH 1120/1293] Translate README.md to pt-BR --- docs-translations/pt-BR/README-pt-BR.md | 70 +++++++++++++++++++++++++ 1 file changed, 70 insertions(+) create mode 100644 docs-translations/pt-BR/README-pt-BR.md diff --git a/docs-translations/pt-BR/README-pt-BR.md b/docs-translations/pt-BR/README-pt-BR.md new file mode 100644 index 000000000000..0c8f6fb52ba7 --- /dev/null +++ b/docs-translations/pt-BR/README-pt-BR.md @@ -0,0 +1,70 @@ +## Guias + +* [Distribuir Aplicação](../../docs/tutorial/application-distribution-pt-BR.md) +* [Empacotamento da aplicação](../../docs/tutorial/application-packaging-pt-BR.md) +* [Usando módulos nativos](../../docs/tutorial/using-native-node-modules-pt-BR.md) +* [Depuração do processo principal](../../docs/tutorial/debugging-main-process-pt-BR.md) +* [Usando Selenium e WebDriver](../../docs/tutorial/using-selenium-and-webdriver-pt-BR.md) +* [Extensão DevTools](../../docs/tutorial/devtools-extension-pt-BR.md) +* [Usando o plugin papper flash](../../docs/tutorial/using-pepper-flash-plugin-pt-BR.md) + +## Tutoriais + +* [Introdução](../../docs/tutorial/quick-start.md) +* [A integração com o ambiente de desenvolvimento](../../docs/tutorial/desktop-environment-integration.md) +* [Evento de detecção on-line/off-line](../../docs/tutorial/online-offline-events.md) + +## API - Referencias + +* [Sinopse](../../docs/api/synopsis.md) +* [Processos](../../docs/api/process.md) +* [Parâmetros CLI suportados (Chrome)](../../docs/api/chrome-command-line-switches.md) + +DOM elementos personalizados: + +* [Objeto `File`](../../docs/api/file-object.md) +* [Tag ``](../../docs/api/web-view-tag.md) +* [Função `window.open`](../../docs/api/window-open.md) + +Os principais módulos: + +* [app](../../docs/api/app.md) +* [auto-updater](../../docs/api/auto-updater.md) +* [browser-window](../../docs/api/browser-window.md) +* [content-tracing](../../docs/api/content-tracing.md) +* [dialog](../../docs/api/dialog.md) +* [global-shortcut](../../docs/api/global-shortcut.md) +* [ipc (main process)](../../docs/api/ipc-main-process.md) +* [menu](../../docs/api/menu.md) +* [menu-item](../../docs/api/menu-item.md) +* [power-monitor](../../docs/api/power-monitor.md) +* [power-save-blocker](../../docs/api/power-save-blocker.md) +* [protocol](../../docs/api/protocol.md) +* [session](../../docs/api/session.md) +* [webContents](../../docs/api/web-contents.md) +* [tray](../../docs/api/tray.md) + +Módulos do renderizador (web page): + +* [ipc (renderer)](../../docs/api/ipc-renderer.md) +* [remote](../../docs/api/remote.md) +* [web-frame](../../docs/api/web-frame.md) + +Módulos de ambos os processos: + +* [clipboard](../../docs/api/clipboard.md) +* [crash-reporter](../../docs/api/crash-reporter.md) +* [native-image](../../docs/api/native-image.md) +* [screen](../../docs/api/screen.md) +* [shell](../../docs/api/shell.md) + +## Desenvolvimento + +* [Estilo de código](../../docs/development/coding-style.md) +* [Estrutura de diretórios padrão](../../docs/development/source-code-directory-structure.md) +* [Diferenças técnicas do NW.js (antigo node-webkit)](../../docs/development/atom-shell-vs-node-webkit.md) +* [Visão geral do build](../../docs/development/build-system-overview.md) +* [Instrução de build (Mac)](../../docs/development/build-instructions-osx.md) +* [Instrução de build (Windows)](../../docs/development/build-instructions-windows.md) +* [Instrução de build (Linux)](../../docs/development/build-instructions-linux.md) +* [Configurando um symbol server no debugger](../../docs/development/setting-up-symbol-server.md) \ No newline at end of file From 26dea993dfd9dbecd3298b55d2607da3bae62732 Mon Sep 17 00:00:00 2001 From: Jonatas Freitas Date: Fri, 4 Sep 2015 11:52:27 -0300 Subject: [PATCH 1121/1293] Added pt-BR translation in README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 81196554495f..68518052c016 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,7 @@ contains documents describing how to build and contribute to Electron. ## Documentation Translations +- [Brazilian Portuguese](https://github.com/atom/electron/tree/master/docs-translations/pt-BR) - [Korean](https://github.com/atom/electron/tree/master/docs-translations/ko) - [Japanese](https://github.com/atom/electron/tree/master/docs-translations/jp) - [Spanish](https://github.com/atom/electron/tree/master/docs-translations/es) From 5d6ac2296b45a20157136b5c96fbb7b83bb98f32 Mon Sep 17 00:00:00 2001 From: Jonatas Freitas Date: Fri, 4 Sep 2015 14:19:59 -0300 Subject: [PATCH 1122/1293] Translated styleguide. --- docs-translations/pt-BR/styleguide-pt-BR.md | 77 +++++++++++++++++++++ 1 file changed, 77 insertions(+) create mode 100644 docs-translations/pt-BR/styleguide-pt-BR.md diff --git a/docs-translations/pt-BR/styleguide-pt-BR.md b/docs-translations/pt-BR/styleguide-pt-BR.md new file mode 100644 index 000000000000..817fa3c81e39 --- /dev/null +++ b/docs-translations/pt-BR/styleguide-pt-BR.md @@ -0,0 +1,77 @@ +# Styleguide do Electron + +Localize a seção apropriada para a sua tarefa: [Lendo a documentação do Electron](#) +ou [Escrevendo documentação para o Electron](#). + +## Escrevendo documentação para o Electron + +Estas são as formas que escrevemos a documentação do Electron. + +- No Máximo um `h1` por página. +- Usar `bash` ao invés de` cmd` em blocos de código (por causa do syntax highlighter). +- Títulos `h1` deve coincidir com o nome do objeto (i.e. `browser-window` → +`BrowserWindow`). +- Nomes de arquivos separados por hífen. +- Adicionar pelo menos uma descrição a cada frase. +- Métodos de cabeçalhos são envolto em `code`. +- Cabeçalhos de eventos são envolto em single 'quotation' marks. +- Não há listas com identação com mais de 2 níveis (por causa do markdown). +- Adicione títulos nas seções: Events, Class Methods e Instance Methods. +- Use 'will' ao invéis de 'would' ao descrever os resultados. +- Eventos e métodos são com cabeçalhos `h3`. +- Argumentos opcionais escritos como `function (required[, optional])`. +- Argumentos opcionais são indicados quando chamado na lista. +- Comprimento da linha é de 80 caracteres com colunas quebradas. +- Métodos específicos para uma plataforma são postos em itálico seguindo o cabeçalho do método. + - ```### `method(foo, bar)` _OS X_``` + +## Lendo a documentação do Electron + +Aqui estão algumas dicas de como entender a sintaxe da documentacão do Electron. + +### Métodos + +Um exemplo de [method](https://developer.mozilla.org/en-US/docs/Glossary/Method) +documentação: + +--- + +`methodName(required[, optional]))` + +* `require` String, **required** +* `optional` Integer + +--- + +O nome do método é seguido pelos seus argumentos. Argumentos opcionais são +simbolizada por colchetes que cercam o argumento opcional, bem como a vírgula +requerido se este argumento opcional segue outro argumento. + +Abaixo o método é para obter informações detalhadas sobre cada um dos argumentos. O tipo +de argumento é simbolizada por qualquer um dos tipos mais comuns: [`String`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String), [` Number`](https : //developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number), [`Object`](https://developer.mozilla.org/en-US/docs/Web/JavaScript Referência/Global_Objects/Object), [`Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array) +ou um tipo personalizado como o de Electron [`webContent`](api/web-content.md). + +### Eventos + +Um exemplo de [evento](https://developer.mozilla.org/en-US/docs/Web/API/Event) +documentação: + +--- + +Event: 'wake-up' + +Returns: + +* `time` String + +--- + +O evento é uma cadeia que é utilizada após um `.on` em um método listner. Se ela retorna +-lhe um valor e seu tipo é observado abaixo. Se você quiser um método para esctuar e responder +crie algo parecido com o exemplo abaixo: + +```javascript +Alarm.on('wake-up', function(time) { + console.log(time) +}) +``` \ No newline at end of file From f91a7e6d04f5568e630093debe8578fa7761f67d Mon Sep 17 00:00:00 2001 From: Jonatas Freitas Date: Fri, 4 Sep 2015 14:25:32 -0300 Subject: [PATCH 1123/1293] Fix README links. --- docs-translations/pt-BR/README-pt-BR.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs-translations/pt-BR/README-pt-BR.md b/docs-translations/pt-BR/README-pt-BR.md index 0c8f6fb52ba7..111ab06a39bb 100644 --- a/docs-translations/pt-BR/README-pt-BR.md +++ b/docs-translations/pt-BR/README-pt-BR.md @@ -1,12 +1,12 @@ ## Guias -* [Distribuir Aplicação](../../docs/tutorial/application-distribution-pt-BR.md) -* [Empacotamento da aplicação](../../docs/tutorial/application-packaging-pt-BR.md) -* [Usando módulos nativos](../../docs/tutorial/using-native-node-modules-pt-BR.md) -* [Depuração do processo principal](../../docs/tutorial/debugging-main-process-pt-BR.md) -* [Usando Selenium e WebDriver](../../docs/tutorial/using-selenium-and-webdriver-pt-BR.md) -* [Extensão DevTools](../../docs/tutorial/devtools-extension-pt-BR.md) -* [Usando o plugin papper flash](../../docs/tutorial/using-pepper-flash-plugin-pt-BR.md) +* [Distribuir Aplicação](../../docs/tutorial/application-distribution.md) +* [Empacotamento da aplicação](../../docs/tutorial/application-packaging.md) +* [Usando módulos nativos](../../docs/tutorial/using-native-node-modules.md) +* [Depuração do processo principal](../../docs/tutorial/debugging-main-process.md) +* [Usando Selenium e WebDriver](../../docs/tutorial/using-selenium-and-webdriver.md) +* [Extensão DevTools](../../docs/tutorial/devtools-extension.md) +* [Usando o plugin papper flash](../../docs/tutorial/using-pepper-flash-plugin.md) ## Tutoriais From 0577e911b387b0453c83b21f411e91b8e0df3f5e Mon Sep 17 00:00:00 2001 From: Eran Tiktin Date: Fri, 4 Sep 2015 23:24:42 +0300 Subject: [PATCH 1124/1293] Fix build failing on Windows build.py would fail on Windows due to a couple of changes made in #2459. This commit fixes those issues. --- atom/browser/atom_browser_main_parts.cc | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/atom/browser/atom_browser_main_parts.cc b/atom/browser/atom_browser_main_parts.cc index 4463115cfee5..806c12b7eace 100644 --- a/atom/browser/atom_browser_main_parts.cc +++ b/atom/browser/atom_browser_main_parts.cc @@ -28,7 +28,8 @@ namespace atom { namespace { -const base::FilePath::CharType kStoragePartitionDirname[] = "Partitions"; +const base::FilePath::CharType kStoragePartitionDirname[] = + FILE_PATH_LITERAL("Partitions"); void GetStoragePartitionConfig(const GURL& partition, base::FilePath* partition_path, @@ -77,7 +78,7 @@ content::BrowserContext* AtomBrowserMainParts::GetBrowserContextForPartition( return browser_context_map_.get(id); scoped_ptr browser_context(CreateBrowserContext()); - browser_context->Initialize(partition_path.value(), in_memory); + browser_context->Initialize(partition_path.AsUTF8Unsafe(), in_memory); browser_context_map_.set(id, browser_context.Pass()); return browser_context_map_.get(id); } From b797804fd92a3bed68223f63434ed3d63ba0f349 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Fri, 4 Sep 2015 13:44:40 -0700 Subject: [PATCH 1125/1293] Use "in" over "on" --- docs/api/auto-updater.md | 2 +- docs/api/power-monitor.md | 2 +- docs/api/synopsis.md | 4 ++-- docs/api/web-contents.md | 4 ++-- docs/styleguide.md | 1 + 5 files changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/api/auto-updater.md b/docs/api/auto-updater.md index 3901e1be2062..9734f592c8fe 100644 --- a/docs/api/auto-updater.md +++ b/docs/api/auto-updater.md @@ -53,7 +53,7 @@ server that you are requesting updates from. A common approach is to use query parameters, like this: ```javascript -// On the main process +// In the main process var app = require('app'); var autoUpdater = require('auto-updater'); autoUpdater.setFeedUrl('http://mycompany.com/myapp/latest?version=' + app.getVersion()); diff --git a/docs/api/power-monitor.md b/docs/api/power-monitor.md index c9a33cc1a128..6ffb910e164d 100644 --- a/docs/api/power-monitor.md +++ b/docs/api/power-monitor.md @@ -1,7 +1,7 @@ # power-monitor The `power-monitor` module is used to monitor power state changes. You can -only use it on the main process. You should not use this module until the `ready` +only use it in the main process. You should not use this module until the `ready` event of the `app` module is emitted. For example: diff --git a/docs/api/synopsis.md b/docs/api/synopsis.md index 21f4ff2aa4de..85d9e3f8dfa6 100644 --- a/docs/api/synopsis.md +++ b/docs/api/synopsis.md @@ -5,13 +5,13 @@ Electron and third-party node modules also fully supported as well (including the [native modules](../tutorial/using-native-node-modules.md)). Electron also provides some extra built-in modules for developing native -desktop applications. Some modules are only available on the main process, some +desktop applications. Some modules are only available in the main process, some are only available in the renderer process (web page), and some can be used in both processes. The basic rule is: if a module is [GUI](https://en.wikipedia.org/wiki/Graphical_user_interface) or low-level -system related, then it should be only available on the main process. You need +system related, then it should be only available in the main process. You need to be familiar with the concept of [main process vs. renderer process](../tutorial/quick-start.md#the-main-process) scripts to be able to use those modules. diff --git a/docs/api/web-contents.md b/docs/api/web-contents.md index 89afae43d1c0..c49b64743bed 100644 --- a/docs/api/web-contents.md +++ b/docs/api/web-contents.md @@ -445,7 +445,7 @@ page can handle it by listening to the `channel` event of the `ipc` module. An example of sending messages from the main process to the renderer process: ```javascript -// On the main process. +// In the main process. var window = null; app.on('ready', function() { window = new BrowserWindow({width: 800, height: 600}); @@ -472,6 +472,6 @@ app.on('ready', function() { **Note:** 1. The IPC message handler in web pages does not have an `event` parameter, - which is different from the handlers on the main process. + which is different from the handlers in the main process. 2. There is no way to send synchronous messages from the main process to a renderer process, because it would be very easy to cause dead locks. diff --git a/docs/styleguide.md b/docs/styleguide.md index 23c590e64211..687b5c4dea3e 100644 --- a/docs/styleguide.md +++ b/docs/styleguide.md @@ -25,6 +25,7 @@ These are the ways that we construct the Electron documentation. - Line length is 80-column wrapped. - Platform specific methods are noted in italics following method header. - ```### `method(foo, bar)` _OS X_``` +- Prefer 'in the ___ process' over 'on' ## Reading Electron Documentation From b9da81ee6ac7114dbc10992a284b0225ded2c7c7 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Fri, 4 Sep 2015 13:50:26 -0700 Subject: [PATCH 1126/1293] Title Case --- docs/README.md | 56 +++++++++++++++++++++++++------------------------- 1 file changed, 28 insertions(+), 28 deletions(-) diff --git a/docs/README.md b/docs/README.md index 5d6d825d1bcb..4531c1d2a236 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,32 +1,32 @@ ## Guides -* [Application distribution](tutorial/application-distribution.md) -* [Application packaging](tutorial/application-packaging.md) -* [Using native node modules](tutorial/using-native-node-modules.md) -* [Debugging main process](tutorial/debugging-main-process.md) +* [Application Distribution](tutorial/application-distribution.md) +* [Application Packaging](tutorial/application-packaging.md) +* [Using Native Node Modules](tutorial/using-native-node-modules.md) +* [Debugging Main Process](tutorial/debugging-main-process.md) * [Using Selenium and WebDriver](tutorial/using-selenium-and-webdriver.md) -* [DevTools extension](tutorial/devtools-extension.md) -* [Using pepper flash plugin](tutorial/using-pepper-flash-plugin.md) +* [DevTools Extension](tutorial/devtools-extension.md) +* [Using Pepper Flash Plugin](tutorial/using-pepper-flash-plugin.md) ## Tutorials -* [Quick start](tutorial/quick-start.md) -* [Desktop environment integration](tutorial/desktop-environment-integration.md) -* [Online/offline event detection](tutorial/online-offline-events.md) +* [Quick Start](tutorial/quick-start.md) +* [Desktop Environment Integration](tutorial/desktop-environment-integration.md) +* [Online/Offline Event Detection](tutorial/online-offline-events.md) -## API references +## API References * [Synopsis](api/synopsis.md) -* [Process object](api/process.md) -* [Supported Chrome command line switches](api/chrome-command-line-switches.md) +* [Process Object](api/process.md) +* [Supported Chrome Command Line Switches](api/chrome-command-line-switches.md) -Custom DOM elements: +Custom DOM Elements: -* [`File` object](api/file-object.md) -* [`` tag](api/web-view-tag.md) -* [`window.open` function](api/window-open.md) +* [`File` Object](api/file-object.md) +* [`` Tag](api/web-view-tag.md) +* [`window.open` Function](api/window-open.md) -Modules for the main process: +Modules for the Main Process: * [app](api/app.md) * [auto-updater](api/auto-updater.md) @@ -41,16 +41,16 @@ Modules for the main process: * [power-save-blocker](api/power-save-blocker.md) * [protocol](api/protocol.md) * [session](api/session.md) -* [webContents](api/web-contents.md) +* [web-contents](api/web-contents.md) * [tray](api/tray.md) -Modules for the renderer process (web page): +Modules for the Renderer Process (Web Page): * [ipc (renderer)](api/ipc-renderer.md) * [remote](api/remote.md) * [web-frame](api/web-frame.md) -Modules for both processes: +Modules for Both Processes: * [clipboard](api/clipboard.md) * [crash-reporter](api/crash-reporter.md) @@ -60,11 +60,11 @@ Modules for both processes: ## Development -* [Coding style](development/coding-style.md) -* [Source code directory structure](development/source-code-directory-structure.md) -* [Technical differences to NW.js (formerly node-webkit)](development/atom-shell-vs-node-webkit.md) -* [Build system overview](development/build-system-overview.md) -* [Build instructions (Mac)](development/build-instructions-osx.md) -* [Build instructions (Windows)](development/build-instructions-windows.md) -* [Build instructions (Linux)](development/build-instructions-linux.md) -* [Setting up symbol server in debugger](development/setting-up-symbol-server.md) +* [Coding Style](development/coding-style.md) +* [Source Code Directory Structure](development/source-code-directory-structure.md) +* [Technical Differences to NW.js (formerly node-webkit)](development/atom-shell-vs-node-webkit.md) +* [Build System Overview](development/build-system-overview.md) +* [Build Instructions (Mac)](development/build-instructions-osx.md) +* [Build Instructions (Windows)](development/build-instructions-windows.md) +* [Build Instructions (Linux)](development/build-instructions-linux.md) +* [Setting Up Symbol Server in debugger](development/setting-up-symbol-server.md) From b980650b6e1f139d86a09c3c0055517b3a630002 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Fri, 4 Sep 2015 14:31:33 -0700 Subject: [PATCH 1127/1293] Use headers so titles are linkable --- docs/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/README.md b/docs/README.md index 4531c1d2a236..b2f95fe4b579 100644 --- a/docs/README.md +++ b/docs/README.md @@ -20,13 +20,13 @@ * [Process Object](api/process.md) * [Supported Chrome Command Line Switches](api/chrome-command-line-switches.md) -Custom DOM Elements: +### Custom DOM Elements: * [`File` Object](api/file-object.md) * [`` Tag](api/web-view-tag.md) * [`window.open` Function](api/window-open.md) -Modules for the Main Process: +### Modules for the Main Process: * [app](api/app.md) * [auto-updater](api/auto-updater.md) @@ -44,13 +44,13 @@ Modules for the Main Process: * [web-contents](api/web-contents.md) * [tray](api/tray.md) -Modules for the Renderer Process (Web Page): +### Modules for the Renderer Process (Web Page): * [ipc (renderer)](api/ipc-renderer.md) * [remote](api/remote.md) * [web-frame](api/web-frame.md) -Modules for Both Processes: +### Modules for Both Processes: * [clipboard](api/clipboard.md) * [crash-reporter](api/crash-reporter.md) From 1a1b45e088e02c3e35402dc07d112d03b17dceb8 Mon Sep 17 00:00:00 2001 From: Jonatas Freitas Date: Fri, 4 Sep 2015 19:01:31 -0300 Subject: [PATCH 1128/1293] application-distribution.md translated to pt-BR --- docs-translations/pt-BR/README-pt-BR.md | 2 +- .../application-distribution-pt-BR.md | 118 ++++++++++++++++++ 2 files changed, 119 insertions(+), 1 deletion(-) create mode 100644 docs-translations/pt-BR/tutorial/application-distribution-pt-BR.md diff --git a/docs-translations/pt-BR/README-pt-BR.md b/docs-translations/pt-BR/README-pt-BR.md index 111ab06a39bb..1fe9ab14b60e 100644 --- a/docs-translations/pt-BR/README-pt-BR.md +++ b/docs-translations/pt-BR/README-pt-BR.md @@ -1,6 +1,6 @@ ## Guias -* [Distribuir Aplicação](../../docs/tutorial/application-distribution.md) +* [Distribuir Aplicação](tutorial/application-distribution-pt-BR.md) * [Empacotamento da aplicação](../../docs/tutorial/application-packaging.md) * [Usando módulos nativos](../../docs/tutorial/using-native-node-modules.md) * [Depuração do processo principal](../../docs/tutorial/debugging-main-process.md) diff --git a/docs-translations/pt-BR/tutorial/application-distribution-pt-BR.md b/docs-translations/pt-BR/tutorial/application-distribution-pt-BR.md new file mode 100644 index 000000000000..41f2457c408b --- /dev/null +++ b/docs-translations/pt-BR/tutorial/application-distribution-pt-BR.md @@ -0,0 +1,118 @@ +# Distribuição de aplicações + +Para distribuir sua aplicação com o Electron, você deve nomear o diretório que contém sua aplicação como +`app` e dentro deste diretório colocar os recursos que você está utilizando (no OSX +`Electron.app/Contents/Resources/`, +no Linux e no Windows é em `resources/`): + +No OSX: + +```text +electron/Electron.app/Contents/Resources/app/ +├── package.json +├── main.js +└── index.html +``` + +No Windows e Linux: + +```text +electron/resources/app +├── package.json +├── main.js +└── index.html +``` + +Logo após execute `Electron.app` (ou `electron` no Linux e `electron.exe` no Windows), +e o Electron iniciaria a aplicação. O diretório `electron` será utilizado para criar a distribuição para +usuários finais. + +## Empacotando sua aplicação em um arquivo. + +Além de copiar todos os seus arquivos fontes para a distribuição, você também pode +empacotar seu aplicativo em um arquivo [asar](https://github.com/atom/asar) para evitar +de expor seu código fonte aos usuários finais. + +Para usar um arquivo `asar` ao invés da pasta `app` você precisa mudar o nome do +arquivo para `app.asar` e colocá-lo sob o diretório de recursos do Electron como +mostrado abaixo, então o Electron vai ler o arquivo e iniciar a aplicação a partir dele. + +No OSX: + +```text +electron/Electron.app/Contents/Resources/ +└── app.asar +``` + +No Windows e Linux: + +```text +electron/resources/ +└── app.asar +``` + +Mais detalhes podem ser encontrados em [Empacotamento da aplicação](../../../docs/tutorial/application-packaging.md). + +## Renomeando a marca Electron na sua distribuição + +Depois de empacotar seu aplicativo Electron, você vai querer renomear a marca Electron +antes de distribuí-lo aos usuários. + +### Janelas + +Você pode renomear `electron.exe` para o nome que desejar e editar o seu ícone e outras +informações com ferramentas como [rcedit](https://github.com/atom/rcedit) ou +[ResEdit](http://www.resedit.net). + +### OS X + +Você pode renomear `Electron.app` para o nome que desejar e também pode mudar o nome +do `CFBundleDisplayName`, `CFBundleIdentifier` e os campos em `CFBundleName` +nos seguinte arquivos: + +* `Electron.app/Contents/Info.plist` +* `Electron.app/Contents/frameworks/Electron Helper.app/Contents/Info.plist` + +Você também pode renomear o arquivo de ajuda para evitar a exibição de `Electron Helper` no +Monitor de Atividades, mas certifique-se de também renomear o arquivo de ajuda no executável do +aplicativo. + +A estrutura de uma aplicação renomada seria assim: + +``` +MyApp.app/Contents +├── Info.plist +├── MacOS/ +│   └── MyApp +└── Frameworks/ + ├── MyApp Helper EH.app + | ├── Info.plist + | └── MacOS/ + |    └── MyApp Helper EH + ├── MyApp Helper NP.app + | ├── Info.plist + | └── MacOS/ + |    └── MyApp Helper NP + └── MyApp Helper.app + ├── Info.plist + └── MacOS/ +    └── MyApp Helper +``` + +### Linux + +Você pode renomear o executável `electron` para o nome que desejar. + +## Renomeando a marca Electron do código fonte. + +Também é possível fazer renomear a marca Electron do código fonte, alterando o nome do produto e +reconstruí-lo a partir da fonte, para fazer isso você precisa modificar o arquivo `atom.gyp`. + +### grunt-build-atom-shell + +A modificação do código fonte do Electron para ganhar a sua marca pode ser muito complexa, por isso, +uma tarefa para o Grunt foi criado e irá cuidar desta tarefa automaticamente para você: +[grunt-build-atom-shell](https://github.com/paulcbetts/grunt-build-atom-shell). + +Esta tarefa irá automaticamente editar o arquivo `.gyp`, compilar o código +e reconstruir os módulos nativos da aplicação para utilizar o novo nome. \ No newline at end of file From dcbd8316dfd4ff465b044f51c77a4ba4d7c7f0f3 Mon Sep 17 00:00:00 2001 From: Eran Tiktin Date: Sat, 5 Sep 2015 01:06:52 +0300 Subject: [PATCH 1129/1293] Remove chrome_version.h from git chrome_version.h is dynamically generated by bootstrap.py so it shouldn't be in git --- atom/common/chrome_version.h | 14 -------------- 1 file changed, 14 deletions(-) delete mode 100644 atom/common/chrome_version.h diff --git a/atom/common/chrome_version.h b/atom/common/chrome_version.h deleted file mode 100644 index 250051683786..000000000000 --- a/atom/common/chrome_version.h +++ /dev/null @@ -1,14 +0,0 @@ -// Copyright (c) 2014 GitHub, Inc. -// Use of this source code is governed by the MIT license that can be -// found in the LICENSE file. - -// This file is generated by script/bootstrap.py, you should never modify it -// by hand. - -#ifndef ATOM_COMMON_CHROME_VERSION_H_ -#define ATOM_COMMON_CHROME_VERSION_H_ - -#define CHROME_VERSION_STRING "45.0.2454.85" -#define CHROME_VERSION "v" CHROME_VERSION_STRING - -#endif // ATOM_COMMON_CHROME_VERSION_H_ From 41e1555cf4cd223024a38bbe70b2b71a395f102d Mon Sep 17 00:00:00 2001 From: Eran Tiktin Date: Sat, 5 Sep 2015 01:11:37 +0300 Subject: [PATCH 1130/1293] Add chrome_version.h to gitignore --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 0c6f4cb79dd0..dc7a879cc8aa 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ .DS_Store +/atom/common/chrome_version.h /build/ /dist/ /external_binaries/ From a8d56df41e908bfc4420863492f36cee935d30a6 Mon Sep 17 00:00:00 2001 From: Eran Tiktin Date: Sat, 5 Sep 2015 01:29:12 +0300 Subject: [PATCH 1131/1293] Drop "-es" from file names When "README.md" is named "README-es.md", github doesn't show it's preview automatically. So I removed "-es" from all the docs. --- docs-translations/es/{README-es.md => README.md} | 14 +++++++------- ...tribution-es.md => application-distribution.md} | 0 ...on-packaging-es.md => application-packaging.md} | 0 ...ain-process-es.md => debugging-main-process.md} | 0 ...on-es.md => desktop-environment-integration.md} | 0 ...tools-extension-es.md => devtools-extension.md} | 0 ...fline-events-es.md => online-offline-events.md} | 0 .../tutorial/{quick-start-es.md => quick-start.md} | 0 ...-modules-es.md => using-native-node-modules.md} | 0 ...h-plugin-es.md => using-pepper-flash-plugin.md} | 0 ...river-es.md => using-selenium-and-webdriver.md} | 0 11 files changed, 7 insertions(+), 7 deletions(-) rename docs-translations/es/{README-es.md => README.md} (94%) rename docs-translations/es/tutorial/{application-distribution-es.md => application-distribution.md} (100%) rename docs-translations/es/tutorial/{application-packaging-es.md => application-packaging.md} (100%) rename docs-translations/es/tutorial/{debugging-main-process-es.md => debugging-main-process.md} (100%) rename docs-translations/es/tutorial/{desktop-environment-integration-es.md => desktop-environment-integration.md} (100%) rename docs-translations/es/tutorial/{devtools-extension-es.md => devtools-extension.md} (100%) rename docs-translations/es/tutorial/{online-offline-events-es.md => online-offline-events.md} (100%) rename docs-translations/es/tutorial/{quick-start-es.md => quick-start.md} (100%) rename docs-translations/es/tutorial/{using-native-node-modules-es.md => using-native-node-modules.md} (100%) rename docs-translations/es/tutorial/{using-pepper-flash-plugin-es.md => using-pepper-flash-plugin.md} (100%) rename docs-translations/es/tutorial/{using-selenium-and-webdriver-es.md => using-selenium-and-webdriver.md} (100%) diff --git a/docs-translations/es/README-es.md b/docs-translations/es/README.md similarity index 94% rename from docs-translations/es/README-es.md rename to docs-translations/es/README.md index 617e66ec6f5b..d95ad4ee8b8a 100644 --- a/docs-translations/es/README-es.md +++ b/docs-translations/es/README.md @@ -1,12 +1,12 @@ ## Guías -* [Distribución de aplicaciones](tutorial/application-distribution-es.md) -* [Empaquetamiento de aplicaciones](tutorial/application-packaging-es.md) -* [Utilizando módulos nativos](tutorial/using-native-node-modules-es.md) -* [Depurando el proceso principal](tutorial/debugging-main-process-es.md) -* [Utilizando Selenium y WebDriver](tutorial/using-selenium-and-webdriver-es.md) -* [Extensión DevTools](tutorial/devtools-extension-es.md) -* [Utilizando el plugin pepper flash](tutorial/using-pepper-flash-plugin-es.md) +* [Distribución de aplicaciones](tutorial/application-distribution.md) +* [Empaquetamiento de aplicaciones](tutorial/application-packaging.md) +* [Utilizando módulos nativos](tutorial/using-native-node-modules.md) +* [Depurando el proceso principal](tutorial/debugging-main-process.md) +* [Utilizando Selenium y WebDriver](tutorial/using-selenium-and-webdriver.md) +* [Extensión DevTools](tutorial/devtools-extension.md) +* [Utilizando el plugin pepper flash](tutorial/using-pepper-flash-plugin.md) ## Tutoriales diff --git a/docs-translations/es/tutorial/application-distribution-es.md b/docs-translations/es/tutorial/application-distribution.md similarity index 100% rename from docs-translations/es/tutorial/application-distribution-es.md rename to docs-translations/es/tutorial/application-distribution.md diff --git a/docs-translations/es/tutorial/application-packaging-es.md b/docs-translations/es/tutorial/application-packaging.md similarity index 100% rename from docs-translations/es/tutorial/application-packaging-es.md rename to docs-translations/es/tutorial/application-packaging.md diff --git a/docs-translations/es/tutorial/debugging-main-process-es.md b/docs-translations/es/tutorial/debugging-main-process.md similarity index 100% rename from docs-translations/es/tutorial/debugging-main-process-es.md rename to docs-translations/es/tutorial/debugging-main-process.md diff --git a/docs-translations/es/tutorial/desktop-environment-integration-es.md b/docs-translations/es/tutorial/desktop-environment-integration.md similarity index 100% rename from docs-translations/es/tutorial/desktop-environment-integration-es.md rename to docs-translations/es/tutorial/desktop-environment-integration.md diff --git a/docs-translations/es/tutorial/devtools-extension-es.md b/docs-translations/es/tutorial/devtools-extension.md similarity index 100% rename from docs-translations/es/tutorial/devtools-extension-es.md rename to docs-translations/es/tutorial/devtools-extension.md diff --git a/docs-translations/es/tutorial/online-offline-events-es.md b/docs-translations/es/tutorial/online-offline-events.md similarity index 100% rename from docs-translations/es/tutorial/online-offline-events-es.md rename to docs-translations/es/tutorial/online-offline-events.md diff --git a/docs-translations/es/tutorial/quick-start-es.md b/docs-translations/es/tutorial/quick-start.md similarity index 100% rename from docs-translations/es/tutorial/quick-start-es.md rename to docs-translations/es/tutorial/quick-start.md diff --git a/docs-translations/es/tutorial/using-native-node-modules-es.md b/docs-translations/es/tutorial/using-native-node-modules.md similarity index 100% rename from docs-translations/es/tutorial/using-native-node-modules-es.md rename to docs-translations/es/tutorial/using-native-node-modules.md diff --git a/docs-translations/es/tutorial/using-pepper-flash-plugin-es.md b/docs-translations/es/tutorial/using-pepper-flash-plugin.md similarity index 100% rename from docs-translations/es/tutorial/using-pepper-flash-plugin-es.md rename to docs-translations/es/tutorial/using-pepper-flash-plugin.md diff --git a/docs-translations/es/tutorial/using-selenium-and-webdriver-es.md b/docs-translations/es/tutorial/using-selenium-and-webdriver.md similarity index 100% rename from docs-translations/es/tutorial/using-selenium-and-webdriver-es.md rename to docs-translations/es/tutorial/using-selenium-and-webdriver.md From 0bc8e7b7876c0c21148be3db68a5f9b1f69a4aa3 Mon Sep 17 00:00:00 2001 From: Eran Tiktin Date: Sat, 5 Sep 2015 01:40:26 +0300 Subject: [PATCH 1132/1293] Update README.md Most of the links in the page were invalid because those docs aren't translated yet, so I changed them to point to the originals written in English. IMO that's a better experience than receiving 404. --- docs-translations/es/README.md | 76 +++++++++++++++++----------------- 1 file changed, 38 insertions(+), 38 deletions(-) diff --git a/docs-translations/es/README.md b/docs-translations/es/README.md index d95ad4ee8b8a..497cc4e05ccf 100644 --- a/docs-translations/es/README.md +++ b/docs-translations/es/README.md @@ -10,59 +10,59 @@ ## Tutoriales -* [Introducción](tutorial/quick-start.md) -* [Integración con el entorno de escritorio](tutorial/desktop-environment-integration.md) -* [Detección del evento en línea/fuera de línea](tutorial/online-offline-events.md) +* [Introducción](../../docs/tutorial/quick-start.md) +* [Integración con el entorno de escritorio](../../docs/tutorial/desktop-environment-integration.md) +* [Detección del evento en línea/fuera de línea](../../docs/tutorial/online-offline-events.md) ## API -* [Sinopsis](api/synopsis.md) -* [Proceso](api/process.md) -* [Parámetros CLI soportados (Chrome)](api/chrome-command-line-switches.md) +* [Sinopsis](../../docs/api/synopsis.md) +* [Proceso](../../docs/api/process.md) +* [Parámetros CLI soportados (Chrome)](../../docs/api/chrome-command-line-switches.md) Elementos DOM customizados: -* [Objeto `File`](api/file-object.md) -* [Etiqueta ``](api/web-view-tag.md) -* [Función `window.open`](api/window-open.md) +* [Objeto `File`](../../docs/api/file-object.md) +* [Etiqueta ``](../../docs/api/web-view-tag.md) +* [Función `window.open`](../../docs/api/window-open.md) Módulos del proceso principal: -* [app](api/app.md) -* [auto-updater](api/auto-updater.md) -* [browser-window](api/browser-window.md) -* [content-tracing](api/content-tracing.md) -* [dialog](api/dialog.md) -* [global-shortcut](api/global-shortcut.md) -* [ipc (main process)](api/ipc-main-process.md) -* [menu](api/menu.md) -* [menu-item](api/menu-item.md) -* [power-monitor](api/power-monitor.md) -* [power-save-blocker](api/power-save-blocker.md) -* [protocol](api/protocol.md) -* [tray](api/tray.md) +* [app](../../docs/api/app.md) +* [auto-updater](../../docs/api/auto-updater.md) +* [browser-window](../../docs/api/browser-window.md) +* [content-tracing](../../docs/api/content-tracing.md) +* [dialog](../../docs/api/dialog.md) +* [global-shortcut](../../docs/api/global-shortcut.md) +* [ipc (main process)](../../docs/api/ipc-main-process.md) +* [menu](../../docs/api/menu.md) +* [menu-item](../../docs/api/menu-item.md) +* [power-monitor](../../docs/api/power-monitor.md) +* [power-save-blocker](../../docs/api/power-save-blocker.md) +* [protocol](../../docs/api/protocol.md) +* [tray](../../docs/api/tray.md) Módulos del renderer (página web): -* [ipc (renderer)](api/ipc-renderer.md) -* [remote](api/remote.md) -* [web-frame](api/web-frame.md) +* [ipc (renderer)](../../docs/api/ipc-renderer.md) +* [remote](../../docs/api/remote.md) +* [web-frame](../../docs/api/web-frame.md) Módulos de ambos procesos: -* [clipboard](api/clipboard.md) -* [crash-reporter](api/crash-reporter.md) -* [native-image](api/native-image.md) -* [screen](api/screen.md) -* [shell](api/shell.md) +* [clipboard](../../docs/api/clipboard.md) +* [crash-reporter](../../docs/api/crash-reporter.md) +* [native-image](../../docs/api/native-image.md) +* [screen](../../docs/api/screen.md) +* [shell](../../docs/api/shell.md) ## Desarrollo -* [Guía de estilo](development/coding-style.md) -* [Estructura de directorio](development/source-code-directory-structure.md) -* [Diferencias técnicas con NW.js (anteriormente conocido como node-webkit)](development/atom-shell-vs-node-webkit.md) -* [Sistema de compilación](development/build-system-overview.md) -* [Instrucciones de compilación (Mac)](development/build-instructions-osx.md) -* [Instrucciones de compilación (Windows)](development/build-instructions-windows.md) -* [Instrucciones de compilación (Linux)](development/build-instructions-linux.md) -* [Configurando un servidor de símbolos en el depurador](development/setting-up-symbol-server.md) +* [Guía de estilo](../../docs/development/coding-style.md) +* [Estructura de directorio](../../docs/development/source-code-directory-structure.md) +* [Diferencias técnicas con NW.js (anteriormente conocido como node-webkit)](../../docs/development/atom-shell-vs-node-webkit.md) +* [Sistema de compilación](../../docs/development/build-system-overview.md) +* [Instrucciones de compilación (Mac)](../../docs/development/build-instructions-osx.md) +* [Instrucciones de compilación (Windows)](../../docs/development/build-instructions-windows.md) +* [Instrucciones de compilación (Linux)](../../docs/development/build-instructions-linux.md) +* [Configurando un servidor de símbolos en el depurador](../../docs/development/setting-up-symbol-server.md) From 3e4ad4c6963d88b960075eb8d9e32f628542d048 Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Sat, 5 Sep 2015 09:38:36 +0900 Subject: [PATCH 1133/1293] Update README-ko.md --- README-ko.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README-ko.md b/README-ko.md index 9e8b8e5a8673..29ac5a0951f0 100644 --- a/README-ko.md +++ b/README-ko.md @@ -38,9 +38,12 @@ Electron을 빌드 하는 방법과 프로젝트에 기여하는 방법도 문 ## 참조 문서 (번역) +- [브라질 포르투칼어](https://github.com/atom/electron/tree/master/docs-translations/pt-BR) - [한국어](https://github.com/atom/electron/tree/master/docs-translations/ko) - [일본어](https://github.com/atom/electron/tree/master/docs-translations/jp) - [스페인어](https://github.com/atom/electron/tree/master/docs-translations/es) +- [중국어 간체](https://github.com/atom/electron/tree/master/docs-translations/zh-CN) +- [중국어 번체](https://github.com/atom/electron/tree/master/docs-translations/zh-TW) ## 커뮤니티 From 38e948f55bab780c4a73f29469ada30881fb00ea Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Sat, 5 Sep 2015 09:42:28 +0900 Subject: [PATCH 1134/1293] Fix small typo --- docs-translations/ko/tutorial/quick-start.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-translations/ko/tutorial/quick-start.md b/docs-translations/ko/tutorial/quick-start.md index 4a642c253838..8c2e043061ec 100644 --- a/docs-translations/ko/tutorial/quick-start.md +++ b/docs-translations/ko/tutorial/quick-start.md @@ -128,7 +128,7 @@ app.on('ready', function() { ### electron-prebuilt -`npm`을 통해 `electron-prebuilt` 패키지를 전역에 설치하면 간단한 명령으로 앱을 실행해 볼 수 있습니다. +`npm`을 통해 `electron-prebuilt` 패키지를 전역에 설치하면 간단한 명령으로 앱을 실행할 수 있습니다. 앱 디렉터리 내에서 이렇게 실행합니다: From 943fe2c22d32620e2a82dfb7ef73f60b676bbe60 Mon Sep 17 00:00:00 2001 From: Jonatas Freitas Date: Sat, 5 Sep 2015 23:32:51 -0300 Subject: [PATCH 1135/1293] Change file names to follow styleguide --- docs-translations/pt-BR/{README-pt-BR.md => README.md} | 2 +- docs-translations/pt-BR/{styleguide-pt-BR.md => styleguide.md} | 0 ...cation-distribution-pt-BR.md => application-distribution.md} | 0 3 files changed, 1 insertion(+), 1 deletion(-) rename docs-translations/pt-BR/{README-pt-BR.md => README.md} (97%) rename docs-translations/pt-BR/{styleguide-pt-BR.md => styleguide.md} (100%) rename docs-translations/pt-BR/tutorial/{application-distribution-pt-BR.md => application-distribution.md} (100%) diff --git a/docs-translations/pt-BR/README-pt-BR.md b/docs-translations/pt-BR/README.md similarity index 97% rename from docs-translations/pt-BR/README-pt-BR.md rename to docs-translations/pt-BR/README.md index 1fe9ab14b60e..08834fc39c9f 100644 --- a/docs-translations/pt-BR/README-pt-BR.md +++ b/docs-translations/pt-BR/README.md @@ -1,6 +1,6 @@ ## Guias -* [Distribuir Aplicação](tutorial/application-distribution-pt-BR.md) +* [Distribuir Aplicação](tutorial/application-distribution.md) * [Empacotamento da aplicação](../../docs/tutorial/application-packaging.md) * [Usando módulos nativos](../../docs/tutorial/using-native-node-modules.md) * [Depuração do processo principal](../../docs/tutorial/debugging-main-process.md) diff --git a/docs-translations/pt-BR/styleguide-pt-BR.md b/docs-translations/pt-BR/styleguide.md similarity index 100% rename from docs-translations/pt-BR/styleguide-pt-BR.md rename to docs-translations/pt-BR/styleguide.md diff --git a/docs-translations/pt-BR/tutorial/application-distribution-pt-BR.md b/docs-translations/pt-BR/tutorial/application-distribution.md similarity index 100% rename from docs-translations/pt-BR/tutorial/application-distribution-pt-BR.md rename to docs-translations/pt-BR/tutorial/application-distribution.md From dd871812b7b2e1c8411949326d149694bb451b61 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Sat, 5 Sep 2015 01:44:22 +0900 Subject: [PATCH 1136/1293] Add WebContentsPrefrences class --- atom/browser/api/atom_api_web_contents.cc | 11 +++++++-- atom/browser/api/atom_api_web_contents.h | 2 +- atom/browser/web_contents_preferences.cc | 25 +++++++++++++++++++ atom/browser/web_contents_preferences.h | 30 +++++++++++++++++++++++ filenames.gypi | 6 +++-- 5 files changed, 69 insertions(+), 5 deletions(-) create mode 100644 atom/browser/web_contents_preferences.cc create mode 100644 atom/browser/web_contents_preferences.h diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 7cefe8e45e3d..d724d1ea4c1c 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -11,6 +11,7 @@ #include "atom/browser/atom_browser_context.h" #include "atom/browser/atom_browser_main_parts.h" #include "atom/browser/native_window.h" +#include "atom/browser/web_contents_preferences.h" #include "atom/browser/web_view_guest_delegate.h" #include "atom/common/api/api_messages.h" #include "atom/common/api/event_emitter_caller.h" @@ -153,7 +154,8 @@ WebContents::WebContents(content::WebContents* web_contents) web_contents->SetUserAgentOverride(GetBrowserContext()->GetUserAgent()); } -WebContents::WebContents(const mate::Dictionary& options) { +WebContents::WebContents(v8::Isolate* isolate, + const mate::Dictionary& options) { bool is_guest = false; options.Get("isGuest", &is_guest); @@ -185,6 +187,11 @@ WebContents::WebContents(const mate::Dictionary& options) { AttachAsUserData(web_contents); InitWithWebContents(web_contents); + // Save the preferences. + base::DictionaryValue web_preferences; + mate::ConvertFromV8(isolate, options.GetHandle(), &web_preferences); + new WebContentsPreferences(web_contents, std::move(web_preferences)); + web_contents->SetUserAgentOverride(GetBrowserContext()->GetUserAgent()); if (is_guest) { @@ -890,7 +897,7 @@ mate::Handle WebContents::CreateFrom( // static mate::Handle WebContents::Create( v8::Isolate* isolate, const mate::Dictionary& options) { - auto handle = mate::CreateHandle(isolate, new WebContents(options)); + auto handle = mate::CreateHandle(isolate, new WebContents(isolate, options)); g_wrap_web_contents.Run(handle.ToV8()); return handle; } diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index e75e88fd703e..5ea62dabff62 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -116,7 +116,7 @@ class WebContents : public mate::TrackableObject, protected: explicit WebContents(content::WebContents* web_contents); - explicit WebContents(const mate::Dictionary& options); + WebContents(v8::Isolate* isolate, const mate::Dictionary& options); ~WebContents(); // mate::Wrappable: diff --git a/atom/browser/web_contents_preferences.cc b/atom/browser/web_contents_preferences.cc new file mode 100644 index 000000000000..8b956c1b41ac --- /dev/null +++ b/atom/browser/web_contents_preferences.cc @@ -0,0 +1,25 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#include "atom/browser/web_contents_preferences.h" + +namespace atom { + +namespace { + +const char* kWebPreferencesKey = "WebContentsPreferences"; + +} // namespace + +WebContentsPreferences::WebContentsPreferences( + content::WebContents* web_contents, + base::DictionaryValue&& web_preferences) { + web_preferences_.Swap(&web_preferences); + web_contents->SetUserData(kWebPreferencesKey, this); +} + +WebContentsPreferences::~WebContentsPreferences() { +} + +} // namespace atom diff --git a/atom/browser/web_contents_preferences.h b/atom/browser/web_contents_preferences.h new file mode 100644 index 000000000000..bbbc4cf5e2e6 --- /dev/null +++ b/atom/browser/web_contents_preferences.h @@ -0,0 +1,30 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#ifndef ATOM_BROWSER_WEB_CONTENTS_PREFERENCES_H_ +#define ATOM_BROWSER_WEB_CONTENTS_PREFERENCES_H_ + +#include "base/values.h" +#include "content/public/browser/web_contents_user_data.h" + +namespace atom { + +class WebContentsPreferences + : public content::WebContentsUserData { + public: + WebContentsPreferences(content::WebContents* web_contents, + base::DictionaryValue&& web_preferences); + ~WebContentsPreferences() override; + + private: + friend class content::WebContentsUserData; + + base::DictionaryValue web_preferences_; + + DISALLOW_COPY_AND_ASSIGN(WebContentsPreferences); +}; + +} // namespace atom + +#endif // ATOM_BROWSER_WEB_CONTENTS_PREFERENCES_H_ diff --git a/filenames.gypi b/filenames.gypi index 2f97d01507e8..b4d3bcb5e186 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -226,14 +226,16 @@ 'atom/browser/ui/x/window_state_watcher.h', 'atom/browser/ui/x/x_window_utils.cc', 'atom/browser/ui/x/x_window_utils.h', + 'atom/browser/web_contents_preferences.cc', + 'atom/browser/web_contents_preferences.h', + 'atom/browser/web_dialog_helper.cc', + 'atom/browser/web_dialog_helper.h', 'atom/browser/web_view_constants.cc', 'atom/browser/web_view_constants.h', 'atom/browser/web_view_guest_delegate.cc', 'atom/browser/web_view_guest_delegate.h', 'atom/browser/web_view_manager.cc', 'atom/browser/web_view_manager.h', - 'atom/browser/web_dialog_helper.cc', - 'atom/browser/web_dialog_helper.h', 'atom/browser/window_list.cc', 'atom/browser/window_list.h', 'atom/browser/window_list_observer.h', From 0e92a3e3333fc98a69170f7b202e78bc6b8895e7 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Sat, 5 Sep 2015 01:51:14 +0900 Subject: [PATCH 1137/1293] Use options['web-preferences'] to create WebContents --- atom/browser/api/atom_api_window.cc | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index e6d16fe6fa59..c8c6437530e9 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -13,6 +13,7 @@ #include "atom/common/native_mate_converters/gurl_converter.h" #include "atom/common/native_mate_converters/image_converter.h" #include "atom/common/native_mate_converters/string16_converter.h" +#include "atom/common/options_switches.h" #include "content/public/browser/render_process_host.h" #include "native_mate/constructor.h" #include "native_mate/dictionary.h" @@ -64,9 +65,12 @@ void OnCapturePageDone( Window::Window(v8::Isolate* isolate, const mate::Dictionary& options) { + // Use options['web-preferences'] to create WebContents. + mate::Dictionary web_preferences = mate::Dictionary::CreateEmpty(isolate); + options.Get(switches::kWebPreferences, &web_preferences); + // Creates the WebContents used by BrowserWindow. - mate::Dictionary web_contents_options(isolate, v8::Object::New(isolate)); - auto web_contents = WebContents::Create(isolate, web_contents_options); + auto web_contents = WebContents::Create(isolate, web_preferences); web_contents_.Reset(isolate, web_contents.ToV8()); api_web_contents_ = web_contents.get(); From 96771c7098fa66a29fd5422158d900883c7803f3 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Sat, 5 Sep 2015 01:52:29 +0900 Subject: [PATCH 1138/1293] NPAPI has been removed, remove related option --- atom/browser/native_window.cc | 9 --------- atom/browser/web_contents_preferences.cc | 7 +++++++ atom/browser/web_contents_preferences.h | 4 ++++ 3 files changed, 11 insertions(+), 9 deletions(-) diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 96085846bca8..b0b99081e3c1 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -424,7 +424,6 @@ void NativeWindow::OverrideWebkitPrefs(content::WebPreferences* prefs) { return; bool b; - std::vector list; if (web_preferences_.Get("javascript", &b)) prefs->javascript_enabled = b; if (web_preferences_.Get("images", &b)) @@ -446,14 +445,6 @@ void NativeWindow::OverrideWebkitPrefs(content::WebPreferences* prefs) { prefs->allow_displaying_insecure_content = b; if (web_preferences_.Get("allow-running-insecure-content", &b)) prefs->allow_running_insecure_content = b; - if (web_preferences_.Get("extra-plugin-dirs", &list)) { - if (content::PluginService::GetInstance()->NPAPIPluginsSupported()) { - for (size_t i = 0; i < list.size(); ++i) - content::PluginService::GetInstance()->AddExtraPluginDir(list[i]); - } else { - LOG(WARNING) << "NPAPI plugins not supported on this platform"; - } - } } void NativeWindow::NotifyWindowClosed() { diff --git a/atom/browser/web_contents_preferences.cc b/atom/browser/web_contents_preferences.cc index 8b956c1b41ac..fbd2c7661a74 100644 --- a/atom/browser/web_contents_preferences.cc +++ b/atom/browser/web_contents_preferences.cc @@ -22,4 +22,11 @@ WebContentsPreferences::WebContentsPreferences( WebContentsPreferences::~WebContentsPreferences() { } +// static +WebContentsPreferences* WebContentsPreferences::From( + content::WebContents* web_contents) { + return static_cast( + web_contents->GetUserData(kWebPreferencesKey)); +} + } // namespace atom diff --git a/atom/browser/web_contents_preferences.h b/atom/browser/web_contents_preferences.h index bbbc4cf5e2e6..c4c50dc07072 100644 --- a/atom/browser/web_contents_preferences.h +++ b/atom/browser/web_contents_preferences.h @@ -10,9 +10,13 @@ namespace atom { +// Stores and applies the preferences of WebContents. class WebContentsPreferences : public content::WebContentsUserData { public: + // Get the preferences of |web_contents|. + static WebContentsPreferences* From(content::WebContents* web_contents); + WebContentsPreferences(content::WebContents* web_contents, base::DictionaryValue&& web_preferences); ~WebContentsPreferences() override; From 39975378bbc9943b7630910966fe78fc3efd5bf6 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Sat, 5 Sep 2015 02:04:09 +0900 Subject: [PATCH 1139/1293] Move AppendExtraCommandLineSwitches to WebContentsPreferences --- atom/browser/native_window.cc | 37 ------------------- atom/browser/web_contents_preferences.cc | 45 ++++++++++++++++++++++++ atom/browser/web_contents_preferences.h | 8 +++++ 3 files changed, 53 insertions(+), 37 deletions(-) diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index b0b99081e3c1..51762d9c00af 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -43,10 +43,6 @@ #include "ui/gfx/screen.h" #include "ui/gl/gpu_switching_manager.h" -#if defined(OS_WIN) -#include "ui/gfx/switches.h" -#endif - using content::NavigationEntry; using content::RenderWidgetHostView; using content::RenderWidgetHost; @@ -57,17 +53,6 @@ namespace atom { namespace { -// Array of available web runtime features. -const char* kWebRuntimeFeatures[] = { - switches::kExperimentalFeatures, - switches::kExperimentalCanvasFeatures, - switches::kSubpixelFontScaling, - switches::kOverlayScrollbars, - switches::kOverlayFullscreenVideo, - switches::kSharedWorker, - switches::kPageVisibility, -}; - // Convert draggable regions in raw format to SkRegion format. Caller is // responsible for deleting the returned SkRegion instance. scoped_ptr DraggableRegionsToSkRegion( @@ -395,28 +380,6 @@ void NativeWindow::AppendExtraCommandLineSwitches( if (zoom_factor_ != 1.0) command_line->AppendSwitchASCII(switches::kZoomFactor, base::DoubleToString(zoom_factor_)); - - if (web_preferences_.IsEmpty()) - return; - - bool b; -#if defined(OS_WIN) - // Check if DirectWrite is disabled. - if (web_preferences_.Get(switches::kDirectWrite, &b) && !b) - command_line->AppendSwitch(::switches::kDisableDirectWrite); -#endif - - // Check if plugins are enabled. - if (web_preferences_.Get("plugins", &b) && b) - command_line->AppendSwitch(switches::kEnablePlugins); - - // This set of options are not availabe in WebPreferences, so we have to pass - // them via command line and enable them in renderer procss. - for (size_t i = 0; i < arraysize(kWebRuntimeFeatures); ++i) { - const char* feature = kWebRuntimeFeatures[i]; - if (web_preferences_.Get(feature, &b)) - command_line->AppendSwitchASCII(feature, b ? "true" : "false"); - } } void NativeWindow::OverrideWebkitPrefs(content::WebPreferences* prefs) { diff --git a/atom/browser/web_contents_preferences.cc b/atom/browser/web_contents_preferences.cc index fbd2c7661a74..44525a8612e3 100644 --- a/atom/browser/web_contents_preferences.cc +++ b/atom/browser/web_contents_preferences.cc @@ -4,12 +4,31 @@ #include "atom/browser/web_contents_preferences.h" +#include "atom/common/options_switches.h" +#include "base/command_line.h" + +#if defined(OS_WIN) +#include "ui/gfx/switches.h" +#endif + namespace atom { namespace { +// Pointer as WebContents's user data key. const char* kWebPreferencesKey = "WebContentsPreferences"; +// Array of available web runtime features. +const char* kWebRuntimeFeatures[] = { + switches::kExperimentalFeatures, + switches::kExperimentalCanvasFeatures, + switches::kSubpixelFontScaling, + switches::kOverlayScrollbars, + switches::kOverlayFullscreenVideo, + switches::kSharedWorker, + switches::kPageVisibility, +}; + } // namespace WebContentsPreferences::WebContentsPreferences( @@ -29,4 +48,30 @@ WebContentsPreferences* WebContentsPreferences::From( web_contents->GetUserData(kWebPreferencesKey)); } +// static +void WebContentsPreferences::AppendExtraCommandLineSwitches( + content::WebContents* web_contents, base::CommandLine* command_line) { + WebContentsPreferences* self = From(web_contents); + CHECK(self); + + bool b; +#if defined(OS_WIN) + // Check if DirectWrite is disabled. + if (self->web_preferences_.GetBoolean(switches::kDirectWrite, &b) && !b) + command_line->AppendSwitch(::switches::kDisableDirectWrite); +#endif + + // Check if plugins are enabled. + if (self->web_preferences_.GetBoolean("plugins", &b) && b) + command_line->AppendSwitch(switches::kEnablePlugins); + + // This set of options are not availabe in WebPreferences, so we have to pass + // them via command line and enable them in renderer procss. + for (size_t i = 0; i < arraysize(kWebRuntimeFeatures); ++i) { + const char* feature = kWebRuntimeFeatures[i]; + if (self->web_preferences_.GetBoolean(feature, &b)) + command_line->AppendSwitchASCII(feature, b ? "true" : "false"); + } +} + } // namespace atom diff --git a/atom/browser/web_contents_preferences.h b/atom/browser/web_contents_preferences.h index c4c50dc07072..4c606f779d46 100644 --- a/atom/browser/web_contents_preferences.h +++ b/atom/browser/web_contents_preferences.h @@ -8,6 +8,10 @@ #include "base/values.h" #include "content/public/browser/web_contents_user_data.h" +namespace base { +class CommandLine; +} + namespace atom { // Stores and applies the preferences of WebContents. @@ -17,6 +21,10 @@ class WebContentsPreferences // Get the preferences of |web_contents|. static WebContentsPreferences* From(content::WebContents* web_contents); + // Append command paramters appending to |web_contents|'s preferences. + static void AppendExtraCommandLineSwitches( + content::WebContents* web_contents, base::CommandLine* command_line); + WebContentsPreferences(content::WebContents* web_contents, base::DictionaryValue&& web_preferences); ~WebContentsPreferences() override; From 880dce950db1a1ff9e7d2ffd37eabaf8d6b69c18 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Sat, 5 Sep 2015 02:12:32 +0900 Subject: [PATCH 1140/1293] Move OverrideWebkitPrefs to WebContentsPreferences --- atom/browser/atom_browser_client.cc | 5 +++- atom/browser/native_window.cc | 30 ----------------------- atom/browser/native_window.h | 2 -- atom/browser/web_contents_preferences.cc | 31 ++++++++++++++++++++++++ atom/browser/web_contents_preferences.h | 10 +++++++- 5 files changed, 44 insertions(+), 34 deletions(-) diff --git a/atom/browser/atom_browser_client.cc b/atom/browser/atom_browser_client.cc index fad952d53365..ce333a58579c 100644 --- a/atom/browser/atom_browser_client.cc +++ b/atom/browser/atom_browser_client.cc @@ -15,6 +15,7 @@ #include "atom/browser/atom_speech_recognition_manager_delegate.h" #include "atom/browser/browser.h" #include "atom/browser/native_window.h" +#include "atom/browser/web_contents_preferences.h" #include "atom/browser/web_view_manager.h" #include "atom/browser/web_view_constants.h" #include "atom/browser/window_list.h" @@ -169,7 +170,7 @@ void AtomBrowserClient::OverrideWebkitPrefs( NativeWindow* window = NativeWindow::FromWebContents(web_contents); if (window) - window->OverrideWebkitPrefs(prefs); + WebContentsPreferences::OverrideWebkitPrefs(web_contents, prefs); } std::string AtomBrowserClient::GetApplicationLocale() { @@ -231,6 +232,8 @@ void AtomBrowserClient::AppendExtraCommandLineSwitches( if (owner == OWNER_NATIVE_WINDOW) { window->AppendExtraCommandLineSwitches(command_line); + WebContentsPreferences::AppendExtraCommandLineSwitches( + window->web_contents(), command_line); } else if (owner == OWNER_GUEST_WEB_CONTENTS) { command_line->AppendSwitchASCII( switches::kGuestInstanceID, base::IntToString(info.guest_instance_id)); diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 51762d9c00af..eb7f314fe889 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -31,8 +31,6 @@ #include "content/public/browser/render_view_host.h" #include "content/public/browser/render_widget_host_view.h" #include "content/public/common/content_switches.h" -#include "content/public/common/renderer_preferences.h" -#include "content/public/common/web_preferences.h" #include "ipc/ipc_message_macros.h" #include "native_mate/dictionary.h" #include "ui/gfx/codec/png_codec.h" @@ -382,34 +380,6 @@ void NativeWindow::AppendExtraCommandLineSwitches( base::DoubleToString(zoom_factor_)); } -void NativeWindow::OverrideWebkitPrefs(content::WebPreferences* prefs) { - if (web_preferences_.IsEmpty()) - return; - - bool b; - if (web_preferences_.Get("javascript", &b)) - prefs->javascript_enabled = b; - if (web_preferences_.Get("images", &b)) - prefs->images_enabled = b; - if (web_preferences_.Get("java", &b)) - prefs->java_enabled = b; - if (web_preferences_.Get("text-areas-are-resizable", &b)) - prefs->text_areas_are_resizable = b; - if (web_preferences_.Get("webgl", &b)) - prefs->experimental_webgl_enabled = b; - if (web_preferences_.Get("webaudio", &b)) - prefs->webaudio_enabled = b; - if (web_preferences_.Get("web-security", &b)) { - prefs->web_security_enabled = b; - prefs->allow_displaying_insecure_content = !b; - prefs->allow_running_insecure_content = !b; - } - if (web_preferences_.Get("allow-displaying-insecure-content", &b)) - prefs->allow_displaying_insecure_content = b; - if (web_preferences_.Get("allow-running-insecure-content", &b)) - prefs->allow_running_insecure_content = b; -} - void NativeWindow::NotifyWindowClosed() { if (is_closed_) return; diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index 10889a5ccaf9..4f074010ec40 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -35,7 +35,6 @@ class InspectableWebContents; namespace content { struct NativeWebKeyboardEvent; -struct WebPreferences; } namespace gfx { @@ -191,7 +190,6 @@ class NativeWindow : public content::WebContentsObserver, // Called when renderer process is going to be started. void AppendExtraCommandLineSwitches(base::CommandLine* command_line); - void OverrideWebkitPrefs(content::WebPreferences* prefs); // Public API used by platform-dependent delegates and observers to send UI // related notifications. diff --git a/atom/browser/web_contents_preferences.cc b/atom/browser/web_contents_preferences.cc index 44525a8612e3..ad5e04fcdbf3 100644 --- a/atom/browser/web_contents_preferences.cc +++ b/atom/browser/web_contents_preferences.cc @@ -6,6 +6,7 @@ #include "atom/common/options_switches.h" #include "base/command_line.h" +#include "content/public/common/web_preferences.h" #if defined(OS_WIN) #include "ui/gfx/switches.h" @@ -74,4 +75,34 @@ void WebContentsPreferences::AppendExtraCommandLineSwitches( } } +void WebContentsPreferences::OverrideWebkitPrefs( + content::WebContents* web_contents, content::WebPreferences* prefs) { + WebContentsPreferences* self = From(web_contents); + CHECK(self); + + bool b; + if (self->web_preferences_.GetBoolean("javascript", &b)) + prefs->javascript_enabled = b; + if (self->web_preferences_.GetBoolean("images", &b)) + prefs->images_enabled = b; + if (self->web_preferences_.GetBoolean("java", &b)) + prefs->java_enabled = b; + if (self->web_preferences_.GetBoolean("text-areas-are-resizable", &b)) + prefs->text_areas_are_resizable = b; + if (self->web_preferences_.GetBoolean("webgl", &b)) + prefs->experimental_webgl_enabled = b; + if (self->web_preferences_.GetBoolean("webaudio", &b)) + prefs->webaudio_enabled = b; + if (self->web_preferences_.GetBoolean("web-security", &b)) { + prefs->web_security_enabled = b; + prefs->allow_displaying_insecure_content = !b; + prefs->allow_running_insecure_content = !b; + } + if (self->web_preferences_.GetBoolean("allow-displaying-insecure-content", + &b)) + prefs->allow_displaying_insecure_content = b; + if (self->web_preferences_.GetBoolean("allow-running-insecure-content", &b)) + prefs->allow_running_insecure_content = b; +} + } // namespace atom diff --git a/atom/browser/web_contents_preferences.h b/atom/browser/web_contents_preferences.h index 4c606f779d46..a2a63415047d 100644 --- a/atom/browser/web_contents_preferences.h +++ b/atom/browser/web_contents_preferences.h @@ -12,6 +12,10 @@ namespace base { class CommandLine; } +namespace content { +struct WebPreferences; +} + namespace atom { // Stores and applies the preferences of WebContents. @@ -21,10 +25,14 @@ class WebContentsPreferences // Get the preferences of |web_contents|. static WebContentsPreferences* From(content::WebContents* web_contents); - // Append command paramters appending to |web_contents|'s preferences. + // Append command paramters according to |web_contents|'s preferences. static void AppendExtraCommandLineSwitches( content::WebContents* web_contents, base::CommandLine* command_line); + // Modify the WebPreferences according to |web_contents|'s preferences. + static void OverrideWebkitPrefs( + content::WebContents* web_contents, content::WebPreferences* prefs); + WebContentsPreferences(content::WebContents* web_contents, base::DictionaryValue&& web_preferences); ~WebContentsPreferences() override; From 0b97d58a6f8f73d25097401e5cabec75222a6114 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Sat, 5 Sep 2015 02:33:13 +0900 Subject: [PATCH 1141/1293] Move a few options in NativeWindow to web-preferences --- atom/browser/api/atom_api_window.cc | 10 ++++++ atom/browser/atom_browser_client.cc | 2 +- atom/browser/native_window.cc | 40 ------------------------ atom/browser/native_window.h | 13 -------- atom/browser/web_contents_preferences.cc | 34 ++++++++++++++++++-- 5 files changed, 42 insertions(+), 57 deletions(-) diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index c8c6437530e9..586cfdb2a78d 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -69,6 +69,16 @@ Window::Window(v8::Isolate* isolate, const mate::Dictionary& options) { mate::Dictionary web_preferences = mate::Dictionary::CreateEmpty(isolate); options.Get(switches::kWebPreferences, &web_preferences); + // Be compatible with old options which are now in web_preferences. + std::string str; + double d; + if (options.Get(switches::kNodeIntegration, &str)) + web_preferences.Set(switches::kNodeIntegration, str); + if (options.Get(switches::kPreloadScript, &str)) + web_preferences.Set(switches::kPreloadScript, str); + if (options.Get(switches::kZoomFactor, &d)) + web_preferences.Set(switches::kZoomFactor, d); + // Creates the WebContents used by BrowserWindow. auto web_contents = WebContents::Create(isolate, web_preferences); web_contents_.Reset(isolate, web_contents.ToV8()); diff --git a/atom/browser/atom_browser_client.cc b/atom/browser/atom_browser_client.cc index ce333a58579c..fa9c8fb4abe2 100644 --- a/atom/browser/atom_browser_client.cc +++ b/atom/browser/atom_browser_client.cc @@ -39,6 +39,7 @@ #include "net/ssl/ssl_cert_request_info.h" #include "ppapi/host/ppapi_host.h" #include "ui/base/l10n/l10n_util.h" +#include "v8/include/v8.h" namespace atom { @@ -231,7 +232,6 @@ void AtomBrowserClient::AppendExtraCommandLineSwitches( ProcessOwner owner = GetProcessOwner(process_id, &window, &info); if (owner == OWNER_NATIVE_WINDOW) { - window->AppendExtraCommandLineSwitches(command_line); WebContentsPreferences::AppendExtraCommandLineSwitches( window->web_contents(), command_line); } else if (owner == OWNER_GUEST_WEB_CONTENTS) { diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index eb7f314fe889..997fe72c4ae7 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -15,12 +15,10 @@ #include "atom/common/native_mate_converters/image_converter.h" #include "atom/common/native_mate_converters/file_path_converter.h" #include "atom/common/options_switches.h" -#include "base/command_line.h" #include "base/files/file_util.h" #include "base/json/json_writer.h" #include "base/prefs/pref_service.h" #include "base/message_loop/message_loop.h" -#include "base/strings/string_number_conversions.h" #include "base/strings/utf_string_conversions.h" #include "brightray/browser/inspectable_web_contents.h" #include "brightray/browser/inspectable_web_contents_view.h" @@ -77,9 +75,7 @@ NativeWindow::NativeWindow( transparent_(false), enable_larger_than_screen_(false), is_closed_(false), - node_integration_(true), has_dialog_attached_(false), - zoom_factor_(1.0), aspect_ratio_(0.0), inspectable_web_contents_(inspectable_web_contents), weak_factory_(this) { @@ -88,7 +84,6 @@ NativeWindow::NativeWindow( options.Get(switches::kFrame, &has_frame_); options.Get(switches::kTransparent, &transparent_); options.Get(switches::kEnableLargerThanScreen, &enable_larger_than_screen_); - options.Get(switches::kNodeIntegration, &node_integration_); // Tell the content module to initialize renderer widget with transparent // mode. @@ -97,25 +92,6 @@ NativeWindow::NativeWindow( // Read icon before window is created. options.Get(switches::kIcon, &icon_); - // The "preload" option must be absolute path. - if (options.Get(switches::kPreloadScript, &preload_script_) && - !preload_script_.IsAbsolute()) { - LOG(ERROR) << "Path of \"preload\" script must be absolute."; - preload_script_.clear(); - } - - // Be compatible with old API of "node-integration" option. - std::string old_string_token; - if (options.Get(switches::kNodeIntegration, &old_string_token) && - old_string_token != "disable") - node_integration_ = true; - - // Read the web preferences. - options.Get(switches::kWebPreferences, &web_preferences_); - - // Read the zoom factor before any navigation. - options.Get(switches::kZoomFactor, &zoom_factor_); - WindowList::AddWindow(this); } @@ -364,22 +340,6 @@ void NativeWindow::RendererResponsive(content::WebContents* source) { FOR_EACH_OBSERVER(NativeWindowObserver, observers_, OnRendererResponsive()); } -void NativeWindow::AppendExtraCommandLineSwitches( - base::CommandLine* command_line) { - // Append --node-integration to renderer process. - command_line->AppendSwitchASCII(switches::kNodeIntegration, - node_integration_ ? "true" : "false"); - - // Append --preload. - if (!preload_script_.empty()) - command_line->AppendSwitchPath(switches::kPreloadScript, preload_script_); - - // Append --zoom-factor. - if (zoom_factor_ != 1.0) - command_line->AppendSwitchASCII(switches::kZoomFactor, - base::DoubleToString(zoom_factor_)); -} - void NativeWindow::NotifyWindowClosed() { if (is_closed_) return; diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index 4f074010ec40..a10eda912e50 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -19,7 +19,6 @@ #include "content/public/browser/readback_types.h" #include "content/public/browser/web_contents_observer.h" #include "content/public/browser/web_contents_user_data.h" -#include "native_mate/persistent_dictionary.h" #include "ui/gfx/image/image.h" #include "ui/gfx/image/image_skia.h" @@ -280,9 +279,6 @@ class NativeWindow : public content::WebContentsObserver, // The windows has been closed. bool is_closed_; - // Whether node integration is enabled. - bool node_integration_; - // There is a dialog that has been attached to window. bool has_dialog_attached_; @@ -290,15 +286,6 @@ class NativeWindow : public content::WebContentsObserver, // it should be cancelled when we can prove that the window is responsive. base::CancelableClosure window_unresposive_closure_; - // Web preferences. - mate::PersistentDictionary web_preferences_; - - // The script to load before page's JavaScript starts to run. - base::FilePath preload_script_; - - // Page's default zoom factor. - double zoom_factor_; - // Used to maintain the aspect ratio of a view which is inside of the // content view. double aspect_ratio_; diff --git a/atom/browser/web_contents_preferences.cc b/atom/browser/web_contents_preferences.cc index ad5e04fcdbf3..a5bb6172f514 100644 --- a/atom/browser/web_contents_preferences.cc +++ b/atom/browser/web_contents_preferences.cc @@ -6,7 +6,9 @@ #include "atom/common/options_switches.h" #include "base/command_line.h" +#include "base/strings/string_number_conversions.h" #include "content/public/common/web_preferences.h" +#include "storage/common/fileapi/file_system_util.h" // IsAbsolute #if defined(OS_WIN) #include "ui/gfx/switches.h" @@ -54,25 +56,51 @@ void WebContentsPreferences::AppendExtraCommandLineSwitches( content::WebContents* web_contents, base::CommandLine* command_line) { WebContentsPreferences* self = From(web_contents); CHECK(self); + base::DictionaryValue& web_preferences = self->web_preferences_; bool b; #if defined(OS_WIN) // Check if DirectWrite is disabled. - if (self->web_preferences_.GetBoolean(switches::kDirectWrite, &b) && !b) + if (web_preferences.GetBoolean(switches::kDirectWrite, &b) && !b) command_line->AppendSwitch(::switches::kDisableDirectWrite); #endif // Check if plugins are enabled. - if (self->web_preferences_.GetBoolean("plugins", &b) && b) + if (web_preferences.GetBoolean("plugins", &b) && b) command_line->AppendSwitch(switches::kEnablePlugins); // This set of options are not availabe in WebPreferences, so we have to pass // them via command line and enable them in renderer procss. for (size_t i = 0; i < arraysize(kWebRuntimeFeatures); ++i) { const char* feature = kWebRuntimeFeatures[i]; - if (self->web_preferences_.GetBoolean(feature, &b)) + if (web_preferences.GetBoolean(feature, &b)) command_line->AppendSwitchASCII(feature, b ? "true" : "false"); } + + // Check if we have node integration specified. + bool node_integration = true; + web_preferences.GetBoolean(switches::kNodeIntegration, &node_integration); + // Be compatible with old API of "node-integration" option. + std::string old_token; + if (web_preferences.GetString(switches::kNodeIntegration, &old_token) && + old_token != "disable") + node_integration = true; + command_line->AppendSwitchASCII(switches::kNodeIntegration, + node_integration ? "true" : "false"); + + // The preload script. + base::FilePath::StringType preload; + if (web_preferences.GetString(switches::kPreloadScript, &preload) && + !preload.empty() && + base::FilePath(preload).IsAbsolute()) + command_line->AppendSwitchNative(switches::kPreloadScript, preload); + + // The zoom factor. + double zoom_factor = 1.0; + if (web_preferences.GetDouble(switches::kZoomFactor, &zoom_factor) && + zoom_factor != 1.0) + command_line->AppendSwitchASCII(switches::kZoomFactor, + base::DoubleToString(zoom_factor)); } void WebContentsPreferences::OverrideWebkitPrefs( From b1afe538ee5e61b97d5340cbfcc8d920d2c14fd4 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Sat, 5 Sep 2015 10:57:39 +0900 Subject: [PATCH 1142/1293] Add undocumented "preload-url" option for web-preferences --- atom/browser/web_contents_preferences.cc | 19 ++++++++++++++----- atom/common/options_switches.cc | 3 +++ atom/common/options_switches.h | 1 + 3 files changed, 18 insertions(+), 5 deletions(-) diff --git a/atom/browser/web_contents_preferences.cc b/atom/browser/web_contents_preferences.cc index a5bb6172f514..269433e4d6b3 100644 --- a/atom/browser/web_contents_preferences.cc +++ b/atom/browser/web_contents_preferences.cc @@ -8,7 +8,7 @@ #include "base/command_line.h" #include "base/strings/string_number_conversions.h" #include "content/public/common/web_preferences.h" -#include "storage/common/fileapi/file_system_util.h" // IsAbsolute +#include "net/base/filename_util.h" #if defined(OS_WIN) #include "ui/gfx/switches.h" @@ -90,10 +90,19 @@ void WebContentsPreferences::AppendExtraCommandLineSwitches( // The preload script. base::FilePath::StringType preload; - if (web_preferences.GetString(switches::kPreloadScript, &preload) && - !preload.empty() && - base::FilePath(preload).IsAbsolute()) - command_line->AppendSwitchNative(switches::kPreloadScript, preload); + if (web_preferences.GetString(switches::kPreloadScript, &preload)) { + if (base::FilePath(preload).IsAbsolute()) + command_line->AppendSwitchNative(switches::kPreloadScript, preload); + else + LOG(ERROR) << "preload script must have abosulute path."; + } else if (web_preferences.GetString(switches::kPreloadUrl, &preload)) { + // Translate to file path if there is "preload-url" option. + base::FilePath preload_path; + if (net::FileURLToFilePath(GURL(preload), &preload_path)) + command_line->AppendSwitchPath(switches::kPreloadScript, preload_path); + else + LOG(ERROR) << "preload url must be file:// protocol."; + } // The zoom factor. double zoom_factor = 1.0; diff --git a/atom/common/options_switches.cc b/atom/common/options_switches.cc index 8f457116ec3a..ce5398e447f6 100644 --- a/atom/common/options_switches.cc +++ b/atom/common/options_switches.cc @@ -75,6 +75,9 @@ const char kGuestInstanceID[] = "guest-instance-id"; // Script that will be loaded by guest WebContents before other scripts. const char kPreloadScript[] = "preload"; +// Like --preload, but the passed argument is an URL. +const char kPreloadUrl[] = "preload-url"; + // Whether the window should be transparent. const char kTransparent[] = "transparent"; diff --git a/atom/common/options_switches.h b/atom/common/options_switches.h index 2dd48ee32a1a..c9298618bdfb 100644 --- a/atom/common/options_switches.h +++ b/atom/common/options_switches.h @@ -41,6 +41,7 @@ extern const char kPpapiFlashPath[]; extern const char kPpapiFlashVersion[]; extern const char kGuestInstanceID[]; extern const char kPreloadScript[]; +extern const char kPreloadUrl[]; extern const char kTransparent[]; extern const char kType[]; extern const char kDisableAutoHideCursor[]; From 9c235509a6c6822d74cc38b575231b29a6ff2e1b Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Sat, 5 Sep 2015 11:43:30 +0900 Subject: [PATCH 1143/1293] Read guest view's info from WebContentsPreferences --- atom/browser/api/atom_api_web_view_manager.cc | 41 ++--------- atom/browser/atom_browser_client.cc | 68 +++---------------- atom/browser/atom_browser_context.cc | 2 +- atom/browser/lib/guest-view-manager.coffee | 14 ++-- atom/browser/web_contents_preferences.cc | 19 +++++- atom/browser/web_contents_preferences.h | 3 + atom/browser/web_view_manager.cc | 5 +- atom/browser/web_view_manager.h | 37 +--------- 8 files changed, 45 insertions(+), 144 deletions(-) diff --git a/atom/browser/api/atom_api_web_view_manager.cc b/atom/browser/api/atom_api_web_view_manager.cc index 221d0d7118b4..83287ac8b2f1 100644 --- a/atom/browser/api/atom_api_web_view_manager.cc +++ b/atom/browser/api/atom_api_web_view_manager.cc @@ -3,14 +3,12 @@ // found in the LICENSE file. #include "atom/browser/api/atom_api_web_contents.h" -#include "atom/browser/web_view_constants.h" +#include "atom/browser/web_contents_preferences.h" #include "atom/browser/web_view_manager.h" -#include "atom/common/native_mate_converters/gurl_converter.h" +#include "atom/common/native_mate_converters/value_converter.h" +#include "atom/common/node_includes.h" #include "content/public/browser/browser_context.h" #include "native_mate/dictionary.h" -#include "net/base/filename_util.h" - -#include "atom/common/node_includes.h" namespace mate { @@ -26,31 +24,6 @@ struct Converter { } }; -template<> -struct Converter { - static bool FromV8(v8::Isolate* isolate, v8::Local val, - atom::WebViewManager::WebViewInfo* out) { - Dictionary options; - if (!ConvertFromV8(isolate, val, &options)) - return false; - - GURL preload_url; - if (!options.Get(atom::web_view::kPreloadUrl, &preload_url)) - return false; - - if (!preload_url.is_empty() && - !net::FileURLToFilePath(preload_url, &(out->preload_script))) - return false; - - return options.Get(atom::web_view::kNodeIntegration, - &(out->node_integration)) && - options.Get(atom::web_view::kPlugins, &(out->plugins)) && - options.Get(atom::web_view::kPartitionId, &(out->partition_id)) && - options.Get(atom::web_view::kDisableWebSecurity, - &(out->disable_web_security)); - } -}; - } // namespace mate namespace { @@ -69,17 +42,13 @@ void AddGuest(int guest_instance_id, int element_instance_id, content::WebContents* embedder, content::WebContents* guest_web_contents, - atom::WebViewManager::WebViewInfo info) { + const base::DictionaryValue& options) { auto manager = GetWebViewManager(embedder); if (manager) manager->AddGuest(guest_instance_id, element_instance_id, embedder, guest_web_contents); - info.guest_instance_id = guest_instance_id; - info.embedder = embedder; - auto data = new atom::WebViewManager::WebViewInfoUserData(info); - guest_web_contents->SetUserData( - atom::web_view::kWebViewInfoKeyName, data); + atom::WebContentsPreferences::From(guest_web_contents)->Merge(options); } void RemoveGuest(content::WebContents* embedder, int guest_instance_id) { diff --git a/atom/browser/atom_browser_client.cc b/atom/browser/atom_browser_client.cc index fa9c8fb4abe2..e45caceab01e 100644 --- a/atom/browser/atom_browser_client.cc +++ b/atom/browser/atom_browser_client.cc @@ -16,8 +16,6 @@ #include "atom/browser/browser.h" #include "atom/browser/native_window.h" #include "atom/browser/web_contents_preferences.h" -#include "atom/browser/web_view_manager.h" -#include "atom/browser/web_view_constants.h" #include "atom/browser/window_list.h" #include "atom/common/options_switches.h" #include "base/command_line.h" @@ -56,37 +54,6 @@ bool g_suppress_renderer_process_restart = false; // Custom schemes to be registered to standard. std::string g_custom_schemes = ""; -// Find out the owner of the child process according to |process_id|. -enum ProcessOwner { - OWNER_NATIVE_WINDOW, - OWNER_GUEST_WEB_CONTENTS, - OWNER_NONE, // it might be devtools though. -}; - -ProcessOwner GetProcessOwner(int process_id, - NativeWindow** window, - WebViewManager::WebViewInfo* info) { - content::WebContents* web_contents = content::WebContents::FromRenderViewHost( - content::RenderViewHost::FromID(process_id, kDefaultRoutingID)); - if (!web_contents) - return OWNER_NONE; - - // First search for NativeWindow. - *window = NativeWindow::FromWebContents(web_contents); - if (*window) - return OWNER_NATIVE_WINDOW; - - // Then search for guest WebContents. - auto data = static_cast( - web_contents->GetUserData(web_view::kWebViewInfoKeyName)); - if (data) { - *info = data->web_view_info(); - return OWNER_GUEST_WEB_CONTENTS; - } - - return OWNER_NONE; -} - scoped_refptr ImportCertFromFile( const base::FilePath& path) { if (path.empty()) @@ -162,16 +129,7 @@ void AtomBrowserClient::OverrideWebkitPrefs( // Custom preferences of guest page. auto web_contents = content::WebContents::FromRenderViewHost(host); - auto info = static_cast( - web_contents->GetUserData(web_view::kWebViewInfoKeyName)); - if (info) { - prefs->web_security_enabled = !info->web_view_info().disable_web_security; - return; - } - - NativeWindow* window = NativeWindow::FromWebContents(web_contents); - if (window) - WebContentsPreferences::OverrideWebkitPrefs(web_contents, prefs); + WebContentsPreferences::OverrideWebkitPrefs(web_contents, prefs); } std::string AtomBrowserClient::GetApplicationLocale() { @@ -227,24 +185,14 @@ void AtomBrowserClient::AppendExtraCommandLineSwitches( if (ContainsKey(pending_processes_, process_id)) process_id = pending_processes_[process_id]; - NativeWindow* window; - WebViewManager::WebViewInfo info; - ProcessOwner owner = GetProcessOwner(process_id, &window, &info); + // Get the WebContents of the render process. + content::WebContents* web_contents = content::WebContents::FromRenderViewHost( + content::RenderViewHost::FromID(process_id, kDefaultRoutingID)); + if (!web_contents) + return; - if (owner == OWNER_NATIVE_WINDOW) { - WebContentsPreferences::AppendExtraCommandLineSwitches( - window->web_contents(), command_line); - } else if (owner == OWNER_GUEST_WEB_CONTENTS) { - command_line->AppendSwitchASCII( - switches::kGuestInstanceID, base::IntToString(info.guest_instance_id)); - command_line->AppendSwitchASCII( - switches::kNodeIntegration, info.node_integration ? "true" : "false"); - if (info.plugins) - command_line->AppendSwitch(switches::kEnablePlugins); - if (!info.preload_script.empty()) - command_line->AppendSwitchPath( - switches::kPreloadScript, info.preload_script); - } + WebContentsPreferences::AppendExtraCommandLineSwitches( + web_contents, command_line); } void AtomBrowserClient::DidCreatePpapiPlugin( diff --git a/atom/browser/atom_browser_context.cc b/atom/browser/atom_browser_context.cc index 583a6324a8f5..43573b1c7076 100644 --- a/atom/browser/atom_browser_context.cc +++ b/atom/browser/atom_browser_context.cc @@ -150,7 +150,7 @@ AtomBrowserContext::GetDownloadManagerDelegate() { content::BrowserPluginGuestManager* AtomBrowserContext::GetGuestManager() { if (!guest_manager_) - guest_manager_.reset(new WebViewManager(this)); + guest_manager_.reset(new WebViewManager); return guest_manager_.get(); } diff --git a/atom/browser/lib/guest-view-manager.coffee b/atom/browser/lib/guest-view-manager.coffee index 581274699085..961da8ad1920 100644 --- a/atom/browser/lib/guest-view-manager.coffee +++ b/atom/browser/lib/guest-view-manager.coffee @@ -132,12 +132,14 @@ attachGuest = (embedder, elementInstanceId, guestInstanceId, params) -> return unless guestInstances[oldGuestInstanceId]? destroyGuest embedder, oldGuestInstanceId - webViewManager.addGuest guestInstanceId, elementInstanceId, embedder, guest, - nodeIntegration: params.nodeintegration - plugins: params.plugins - disableWebSecurity: params.disablewebsecurity - preloadUrl: params.preload ? '' - partitionId: getPartitionId(params.partition) + webPreferences = + 'guest-instance-id': guestInstanceId + 'node-integration': params.nodeintegration ? false + 'plugins': params.plugins + 'web-security': !params.disablewebsecurity + webPreferences['preload-url'] = params.preload if params.preload + webPreferences['partition'] = getPartitionId(params.partition) if params.partition + webViewManager.addGuest guestInstanceId, elementInstanceId, embedder, guest, webPreferences guest.attachParams = params embedderElementsMap[key] = guestInstanceId diff --git a/atom/browser/web_contents_preferences.cc b/atom/browser/web_contents_preferences.cc index 269433e4d6b3..ab7a700cc284 100644 --- a/atom/browser/web_contents_preferences.cc +++ b/atom/browser/web_contents_preferences.cc @@ -44,6 +44,10 @@ WebContentsPreferences::WebContentsPreferences( WebContentsPreferences::~WebContentsPreferences() { } +void WebContentsPreferences::Merge(const base::DictionaryValue& extend) { + web_preferences_.MergeDictionary(&extend); +} + // static WebContentsPreferences* WebContentsPreferences::From( content::WebContents* web_contents) { @@ -55,7 +59,9 @@ WebContentsPreferences* WebContentsPreferences::From( void WebContentsPreferences::AppendExtraCommandLineSwitches( content::WebContents* web_contents, base::CommandLine* command_line) { WebContentsPreferences* self = From(web_contents); - CHECK(self); + if (!self) + return; + base::DictionaryValue& web_preferences = self->web_preferences_; bool b; @@ -110,12 +116,21 @@ void WebContentsPreferences::AppendExtraCommandLineSwitches( zoom_factor != 1.0) command_line->AppendSwitchASCII(switches::kZoomFactor, base::DoubleToString(zoom_factor)); + + // --guest-instance-id, which is used to identify guest WebContents. + int guest_instance_id; + if (web_preferences.GetInteger(switches::kGuestInstanceID, + &guest_instance_id)) + command_line->AppendSwitchASCII(switches::kGuestInstanceID, + base::IntToString(guest_instance_id)); } +// static void WebContentsPreferences::OverrideWebkitPrefs( content::WebContents* web_contents, content::WebPreferences* prefs) { WebContentsPreferences* self = From(web_contents); - CHECK(self); + if (!self) + return; bool b; if (self->web_preferences_.GetBoolean("javascript", &b)) diff --git a/atom/browser/web_contents_preferences.h b/atom/browser/web_contents_preferences.h index a2a63415047d..1053dd9c1087 100644 --- a/atom/browser/web_contents_preferences.h +++ b/atom/browser/web_contents_preferences.h @@ -37,6 +37,9 @@ class WebContentsPreferences base::DictionaryValue&& web_preferences); ~WebContentsPreferences() override; + // $.extend(|web_preferences_|, |new_web_preferences|). + void Merge(const base::DictionaryValue& new_web_preferences); + private: friend class content::WebContentsUserData; diff --git a/atom/browser/web_view_manager.cc b/atom/browser/web_view_manager.cc index 9d0b9337599f..d404c1a43680 100644 --- a/atom/browser/web_view_manager.cc +++ b/atom/browser/web_view_manager.cc @@ -5,13 +5,12 @@ #include "atom/browser/web_view_manager.h" #include "atom/browser/atom_browser_context.h" -#include "atom/browser/atom_browser_main_parts.h" #include "content/public/browser/render_process_host.h" #include "content/public/browser/web_contents.h" namespace atom { -WebViewManager::WebViewManager(content::BrowserContext* context) { +WebViewManager::WebViewManager() { } WebViewManager::~WebViewManager() { @@ -21,7 +20,6 @@ void WebViewManager::AddGuest(int guest_instance_id, int element_instance_id, content::WebContents* embedder, content::WebContents* web_contents) { - base::AutoLock auto_lock(lock_); web_contents_embedder_map_[guest_instance_id] = { web_contents, embedder }; // Map the element in embedder to guest. @@ -31,7 +29,6 @@ void WebViewManager::AddGuest(int guest_instance_id, } void WebViewManager::RemoveGuest(int guest_instance_id) { - base::AutoLock auto_lock(lock_); if (!ContainsKey(web_contents_embedder_map_, guest_instance_id)) return; diff --git a/atom/browser/web_view_manager.h b/atom/browser/web_view_manager.h index 20c044849720..ff9a8ecba2ab 100644 --- a/atom/browser/web_view_manager.h +++ b/atom/browser/web_view_manager.h @@ -7,45 +7,14 @@ #include -#include "base/files/file_path.h" -#include "base/supports_user_data.h" -#include "base/synchronization/lock.h" #include "content/public/browser/browser_plugin_guest_manager.h" -#include "content/public/browser/site_instance.h" - -namespace content { -class BrowserContext; -class RenderProcessHost; -} namespace atom { class WebViewManager : public content::BrowserPluginGuestManager { public: - struct WebViewInfo { - int guest_instance_id; - content::WebContents* embedder; - bool node_integration; - bool plugins; - bool disable_web_security; - base::FilePath preload_script; - GURL partition_id; - }; - - class WebViewInfoUserData : public base::SupportsUserData::Data { - public: - explicit WebViewInfoUserData(WebViewInfo info) - : web_view_info_(info) {} - ~WebViewInfoUserData() override {} - - WebViewInfo& web_view_info() { return web_view_info_; } - - private: - WebViewInfo web_view_info_; - }; - - explicit WebViewManager(content::BrowserContext* context); - virtual ~WebViewManager(); + WebViewManager(); + ~WebViewManager() override; void AddGuest(int guest_instance_id, int element_instance_id, @@ -90,8 +59,6 @@ class WebViewManager : public content::BrowserPluginGuestManager { // (embedder_process_id, element_instance_id) => guest_instance_id std::map element_instance_id_to_guest_map_; - base::Lock lock_; - DISALLOW_COPY_AND_ASSIGN(WebViewManager); }; From f2bdca31b3f5ecf7303f2bd50a402551e1adb68e Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Sat, 5 Sep 2015 12:19:03 +0900 Subject: [PATCH 1144/1293] spec: webview test should avoid affecting each other --- spec/webview-spec.coffee | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/spec/webview-spec.coffee b/spec/webview-spec.coffee index fe281510b40e..3eeacb0ad0e5 100644 --- a/spec/webview-spec.coffee +++ b/spec/webview-spec.coffee @@ -160,7 +160,7 @@ describe ' tag', -> assert.equal e.message, 'undefined undefined undefined undefined' done() webview.src = "file://#{fixtures}/pages/c.html" - webview.partition = "test" + webview.partition = 'test1' document.body.appendChild webview it 'inserts node symbols when set', (done) -> @@ -169,7 +169,7 @@ describe ' tag', -> done() webview.setAttribute 'nodeintegration', 'on' webview.src = "file://#{fixtures}/pages/d.html" - webview.partition = "test" + webview.partition = 'test2' document.body.appendChild webview it 'isolates storage for different id', (done) -> @@ -180,7 +180,7 @@ describe ' tag', -> window.localStorage.setItem 'test', 'one' webview.addEventListener 'console-message', listener webview.src = "file://#{fixtures}/pages/partition/one.html" - webview.partition = "test" + webview.partition = 'test3' document.body.appendChild webview it 'uses current session storage when no id is provided', (done) -> From 3773f81fd5c21f1c7bca1a3eea1a9b452e716389 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Sat, 5 Sep 2015 19:47:44 +0800 Subject: [PATCH 1145/1293] Pass partition name instead of path to BrowserContext --- atom/browser/api/atom_api_web_contents.cc | 18 +++++++----- atom/browser/atom_browser_main_parts.cc | 34 ++++++---------------- atom/browser/atom_browser_main_parts.h | 2 +- atom/browser/lib/guest-view-manager.coffee | 27 ++++++----------- atom/browser/web_contents_preferences.cc | 6 ++-- atom/browser/web_contents_preferences.h | 2 +- vendor/brightray | 2 +- 7 files changed, 35 insertions(+), 56 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index d724d1ea4c1c..d8201973fd83 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -161,19 +161,21 @@ WebContents::WebContents(v8::Isolate* isolate, type_ = is_guest ? WEB_VIEW : BROWSER_WINDOW; + // TODO(zcbenz): Use host's BrowserContext when no partition is specified. content::BrowserContext* browser_context = AtomBrowserMainParts::Get()->browser_context(); content::WebContents* web_contents; if (is_guest) { - GURL guest_site; - options.Get("partition", &guest_site); - // use hosts' browser_context when no partition is specified. - if (!guest_site.query().empty()) { + std::string partition; + bool in_memory = false; + options.Get("partition", &partition); + options.Get("inMemory", &in_memory); + if (!partition.empty()) { browser_context = AtomBrowserMainParts::Get() - ->GetBrowserContextForPartition(guest_site); + ->GetBrowserContextForPartition(partition, in_memory); } - auto site_instance = - content::SiteInstance::CreateForURL(browser_context, guest_site); + content::SiteInstance* site_instance = content::SiteInstance::CreateForURL( + browser_context, GURL("chrome-guest://fake-host")); content::WebContents::CreateParams params(browser_context, site_instance); guest_delegate_.reset(new WebViewGuestDelegate); params.guest_delegate = guest_delegate_.get(); @@ -190,7 +192,7 @@ WebContents::WebContents(v8::Isolate* isolate, // Save the preferences. base::DictionaryValue web_preferences; mate::ConvertFromV8(isolate, options.GetHandle(), &web_preferences); - new WebContentsPreferences(web_contents, std::move(web_preferences)); + new WebContentsPreferences(web_contents, &web_preferences); web_contents->SetUserAgentOverride(GetBrowserContext()->GetUserAgent()); diff --git a/atom/browser/atom_browser_main_parts.cc b/atom/browser/atom_browser_main_parts.cc index 806c12b7eace..5fae6da14b21 100644 --- a/atom/browser/atom_browser_main_parts.cc +++ b/atom/browser/atom_browser_main_parts.cc @@ -26,24 +26,6 @@ namespace atom { -namespace { - -const base::FilePath::CharType kStoragePartitionDirname[] = - FILE_PATH_LITERAL("Partitions"); - -void GetStoragePartitionConfig(const GURL& partition, - base::FilePath* partition_path, - bool* in_memory, - std::string* id) { - *in_memory = (partition.path() != "/persist"); - net::UnescapeRule::Type flags = - net::UnescapeRule::SPACES | net::UnescapeRule::URL_SPECIAL_CHARS; - *id = net::UnescapeURLComponent(partition.query(), flags); - *partition_path = base::FilePath(kStoragePartitionDirname).AppendASCII(*id); -} - -} // namespace - // static AtomBrowserMainParts* AtomBrowserMainParts::self_ = NULL; @@ -69,18 +51,20 @@ AtomBrowserMainParts* AtomBrowserMainParts::Get() { } content::BrowserContext* AtomBrowserMainParts::GetBrowserContextForPartition( - const GURL& partition) { - std::string id; - bool in_memory; - base::FilePath partition_path; - GetStoragePartitionConfig(partition, &partition_path, &in_memory, &id); - if (browser_context_map_.contains(id)) - return browser_context_map_.get(id); + const std::string& partition, bool in_memory) { + if (browser_context_map_.contains(partition)) + return browser_context_map_.get(partition); scoped_ptr browser_context(CreateBrowserContext()); +<<<<<<< HEAD browser_context->Initialize(partition_path.AsUTF8Unsafe(), in_memory); browser_context_map_.set(id, browser_context.Pass()); return browser_context_map_.get(id); +======= + browser_context->Initialize(partition, in_memory); + browser_context_map_.set(partition, browser_context.Pass()); + return browser_context_map_.get(partition); +>>>>>>> Pass partition name instead of path to BrowserContext } void AtomBrowserMainParts::RegisterDestructionCallback( diff --git a/atom/browser/atom_browser_main_parts.h b/atom/browser/atom_browser_main_parts.h index d952f432882f..b7b179cf806f 100644 --- a/atom/browser/atom_browser_main_parts.h +++ b/atom/browser/atom_browser_main_parts.h @@ -35,7 +35,7 @@ class AtomBrowserMainParts : public brightray::BrowserMainParts { // Returns the BrowserContext associated with the partition. content::BrowserContext* GetBrowserContextForPartition( - const GURL& partition); + const std::string& partition, bool in_memory); // Register a callback that should be destroyed before JavaScript environment // gets destroyed. diff --git a/atom/browser/lib/guest-view-manager.coffee b/atom/browser/lib/guest-view-manager.coffee index 961da8ad1920..c7ec439f96f0 100644 --- a/atom/browser/lib/guest-view-manager.coffee +++ b/atom/browser/lib/guest-view-manager.coffee @@ -38,29 +38,21 @@ moveLastToFirst = (list) -> getNextInstanceId = (webContents) -> ++nextInstanceId -# Generate URL encoded partition id. -getPartitionId = (partition) -> - # Guest site url will be chrome-guest://fake-host/{persist}?{partitionId} - partitionId = "chrome-guest://fake-host/" - if partition - persist = partition.startsWith('persist:') - if persist - partition = partition.substring('persist:'.length) - partitionId += 'persist?' - else - # Just to differentiate from same persistant ID - partition += "_temp" - partitionId += '?' - partitionId += encodeURIComponent(partition) - return partitionId +# Parse the partition string. +parsePartition = (partition) -> + return ['', false] unless partition + if partition.startsWith 'persist:' + [partition.substr('persist:'.length), false] + else + [partition, true] # Create a new guest instance. createGuest = (embedder, params) -> webViewManager ?= process.atomBinding 'web_view_manager' id = getNextInstanceId embedder - partitionId = getPartitionId params.partition - guest = webContents.create {isGuest: true, partition: partitionId, embedder} + [partition, inMemory] = parsePartition params.partition + guest = webContents.create {isGuest: true, partition, inMemory, embedder} guestInstances[id] = {guest, embedder} # Destroy guest when the embedder is gone or navigated. @@ -138,7 +130,6 @@ attachGuest = (embedder, elementInstanceId, guestInstanceId, params) -> 'plugins': params.plugins 'web-security': !params.disablewebsecurity webPreferences['preload-url'] = params.preload if params.preload - webPreferences['partition'] = getPartitionId(params.partition) if params.partition webViewManager.addGuest guestInstanceId, elementInstanceId, embedder, guest, webPreferences guest.attachParams = params diff --git a/atom/browser/web_contents_preferences.cc b/atom/browser/web_contents_preferences.cc index ab7a700cc284..19ea826a5ff7 100644 --- a/atom/browser/web_contents_preferences.cc +++ b/atom/browser/web_contents_preferences.cc @@ -4,6 +4,8 @@ #include "atom/browser/web_contents_preferences.h" +#include + #include "atom/common/options_switches.h" #include "base/command_line.h" #include "base/strings/string_number_conversions.h" @@ -36,8 +38,8 @@ const char* kWebRuntimeFeatures[] = { WebContentsPreferences::WebContentsPreferences( content::WebContents* web_contents, - base::DictionaryValue&& web_preferences) { - web_preferences_.Swap(&web_preferences); + base::DictionaryValue* web_preferences) { + web_preferences_.Swap(web_preferences); web_contents->SetUserData(kWebPreferencesKey, this); } diff --git a/atom/browser/web_contents_preferences.h b/atom/browser/web_contents_preferences.h index 1053dd9c1087..310456725aaf 100644 --- a/atom/browser/web_contents_preferences.h +++ b/atom/browser/web_contents_preferences.h @@ -34,7 +34,7 @@ class WebContentsPreferences content::WebContents* web_contents, content::WebPreferences* prefs); WebContentsPreferences(content::WebContents* web_contents, - base::DictionaryValue&& web_preferences); + base::DictionaryValue* web_preferences); ~WebContentsPreferences() override; // $.extend(|web_preferences_|, |new_web_preferences|). diff --git a/vendor/brightray b/vendor/brightray index 4d8f5d879d48..55bab304fd1c 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit 4d8f5d879d484db54895c3456ded3a3d3246415d +Subproject commit 55bab304fd1c92a79e636bca0313f7cbda000c06 From ba25bed45b60053090cae072ebc1a5e918eac7ab Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Sat, 5 Sep 2015 20:03:40 +0800 Subject: [PATCH 1146/1293] Store BrowserContext in ref-counted ptr --- atom/browser/atom_browser_main_parts.cc | 16 +++++----------- atom/browser/atom_browser_main_parts.h | 3 +-- vendor/brightray | 2 +- 3 files changed, 7 insertions(+), 14 deletions(-) diff --git a/atom/browser/atom_browser_main_parts.cc b/atom/browser/atom_browser_main_parts.cc index 5fae6da14b21..e614f9b63658 100644 --- a/atom/browser/atom_browser_main_parts.cc +++ b/atom/browser/atom_browser_main_parts.cc @@ -52,19 +52,13 @@ AtomBrowserMainParts* AtomBrowserMainParts::Get() { content::BrowserContext* AtomBrowserMainParts::GetBrowserContextForPartition( const std::string& partition, bool in_memory) { - if (browser_context_map_.contains(partition)) - return browser_context_map_.get(partition); + if (ContainsKey(browser_context_map_, partition)) + return browser_context_map_[partition].get(); - scoped_ptr browser_context(CreateBrowserContext()); -<<<<<<< HEAD - browser_context->Initialize(partition_path.AsUTF8Unsafe(), in_memory); - browser_context_map_.set(id, browser_context.Pass()); - return browser_context_map_.get(id); -======= + brightray::BrowserContext* browser_context = CreateBrowserContext(); browser_context->Initialize(partition, in_memory); - browser_context_map_.set(partition, browser_context.Pass()); - return browser_context_map_.get(partition); ->>>>>>> Pass partition name instead of path to BrowserContext + browser_context_map_[partition] = make_scoped_refptr(browser_context); + return browser_context; } void AtomBrowserMainParts::RegisterDestructionCallback( diff --git a/atom/browser/atom_browser_main_parts.h b/atom/browser/atom_browser_main_parts.h index b7b179cf806f..de53f66788bc 100644 --- a/atom/browser/atom_browser_main_parts.h +++ b/atom/browser/atom_browser_main_parts.h @@ -10,7 +10,6 @@ #include #include "base/callback.h" -#include "base/containers/scoped_ptr_hash_map.h" #include "base/timer/timer.h" #include "brightray/browser/browser_main_parts.h" #include "content/public/browser/browser_context.h" @@ -79,7 +78,7 @@ class AtomBrowserMainParts : public brightray::BrowserMainParts { std::list destruction_callbacks_; // partition_id => browser_context - base::ScopedPtrHashMap> + std::map> browser_context_map_; static AtomBrowserMainParts* self_; diff --git a/vendor/brightray b/vendor/brightray index 55bab304fd1c..ca80107e3dec 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit 55bab304fd1c92a79e636bca0313f7cbda000c06 +Subproject commit ca80107e3dec28d5b49d64da9985525c3e2c4e84 From fafb28e41a59193c37d5282bf20a517c55ee9d6c Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Sat, 5 Sep 2015 20:54:36 +0800 Subject: [PATCH 1147/1293] Move management of browser context to BrowserContext --- atom/browser/api/atom_api_web_contents.cc | 6 ++---- atom/browser/atom_browser_context.cc | 16 ++++++++++++++-- atom/browser/atom_browser_context.h | 7 ++++--- atom/browser/atom_browser_main_parts.cc | 15 --------------- atom/browser/atom_browser_main_parts.h | 14 +------------- vendor/brightray | 2 +- 6 files changed, 22 insertions(+), 38 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index d8201973fd83..e91656570112 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -170,10 +170,8 @@ WebContents::WebContents(v8::Isolate* isolate, bool in_memory = false; options.Get("partition", &partition); options.Get("inMemory", &in_memory); - if (!partition.empty()) { - browser_context = AtomBrowserMainParts::Get() - ->GetBrowserContextForPartition(partition, in_memory); - } + if (!partition.empty()) + browser_context = brightray::BrowserContext::From(partition, in_memory); content::SiteInstance* site_instance = content::SiteInstance::CreateForURL( browser_context, GURL("chrome-guest://fake-host")); content::WebContents::CreateParams params(browser_context, site_instance); diff --git a/atom/browser/atom_browser_context.cc b/atom/browser/atom_browser_context.cc index 43573b1c7076..81973857b124 100644 --- a/atom/browser/atom_browser_context.cc +++ b/atom/browser/atom_browser_context.cc @@ -56,8 +56,10 @@ std::string RemoveWhitespace(const std::string& str) { } // namespace -AtomBrowserContext::AtomBrowserContext() - : job_factory_(new AtomURLRequestJobFactory) { +AtomBrowserContext::AtomBrowserContext(const std::string& partition, + bool in_memory) + : brightray::BrowserContext(partition, in_memory), + job_factory_(new AtomURLRequestJobFactory) { } AtomBrowserContext::~AtomBrowserContext() { @@ -162,3 +164,13 @@ void AtomBrowserContext::RegisterPrefs(PrefRegistrySimple* pref_registry) { } } // namespace atom + +namespace brightray { + +// static +BrowserContext* BrowserContext::Create(const std::string& partition, + bool in_memory) { + return new atom::AtomBrowserContext(partition, in_memory); +} + +} // namespace brightray diff --git a/atom/browser/atom_browser_context.h b/atom/browser/atom_browser_context.h index c1ff613b8c07..c99461ad9a86 100644 --- a/atom/browser/atom_browser_context.h +++ b/atom/browser/atom_browser_context.h @@ -17,8 +17,8 @@ class WebViewManager; class AtomBrowserContext : public brightray::BrowserContext { public: - AtomBrowserContext(); - virtual ~AtomBrowserContext(); + AtomBrowserContext(const std::string& partition, bool in_memory); + ~AtomBrowserContext() override; // brightray::URLRequestContextGetter::Delegate: std::string GetUserAgent() override; @@ -41,7 +41,8 @@ class AtomBrowserContext : public brightray::BrowserContext { scoped_ptr download_manager_delegate_; scoped_ptr guest_manager_; - AtomURLRequestJobFactory* job_factory_; // Weak reference. + // Managed by brightray::BrowserContext. + AtomURLRequestJobFactory* job_factory_; DISALLOW_COPY_AND_ASSIGN(AtomBrowserContext); }; diff --git a/atom/browser/atom_browser_main_parts.cc b/atom/browser/atom_browser_main_parts.cc index e614f9b63658..31a490464143 100644 --- a/atom/browser/atom_browser_main_parts.cc +++ b/atom/browser/atom_browser_main_parts.cc @@ -50,26 +50,11 @@ AtomBrowserMainParts* AtomBrowserMainParts::Get() { return self_; } -content::BrowserContext* AtomBrowserMainParts::GetBrowserContextForPartition( - const std::string& partition, bool in_memory) { - if (ContainsKey(browser_context_map_, partition)) - return browser_context_map_[partition].get(); - - brightray::BrowserContext* browser_context = CreateBrowserContext(); - browser_context->Initialize(partition, in_memory); - browser_context_map_[partition] = make_scoped_refptr(browser_context); - return browser_context; -} - void AtomBrowserMainParts::RegisterDestructionCallback( const base::Closure& callback) { destruction_callbacks_.push_back(callback); } -brightray::BrowserContext* AtomBrowserMainParts::CreateBrowserContext() { - return new AtomBrowserContext(); -} - void AtomBrowserMainParts::PostEarlyInitialization() { brightray::BrowserMainParts::PostEarlyInitialization(); diff --git a/atom/browser/atom_browser_main_parts.h b/atom/browser/atom_browser_main_parts.h index de53f66788bc..59ff7c977c82 100644 --- a/atom/browser/atom_browser_main_parts.h +++ b/atom/browser/atom_browser_main_parts.h @@ -6,7 +6,6 @@ #define ATOM_BROWSER_ATOM_BROWSER_MAIN_PARTS_H_ #include -#include #include #include "base/callback.h" @@ -32,10 +31,6 @@ class AtomBrowserMainParts : public brightray::BrowserMainParts { static AtomBrowserMainParts* Get(); - // Returns the BrowserContext associated with the partition. - content::BrowserContext* GetBrowserContextForPartition( - const std::string& partition, bool in_memory); - // Register a callback that should be destroyed before JavaScript environment // gets destroyed. void RegisterDestructionCallback(const base::Closure& callback); @@ -43,10 +38,7 @@ class AtomBrowserMainParts : public brightray::BrowserMainParts { Browser* browser() { return browser_.get(); } protected: - // Implementations of brightray::BrowserMainParts. - brightray::BrowserContext* CreateBrowserContext() override; - - // Implementations of content::BrowserMainParts. + // content::BrowserMainParts: void PostEarlyInitialization() override; void PreMainMessageLoopRun() override; #if defined(OS_MACOSX) @@ -77,10 +69,6 @@ class AtomBrowserMainParts : public brightray::BrowserMainParts { // List of callbacks should be executed before destroying JS env. std::list destruction_callbacks_; - // partition_id => browser_context - std::map> - browser_context_map_; - static AtomBrowserMainParts* self_; DISALLOW_COPY_AND_ASSIGN(AtomBrowserMainParts); diff --git a/vendor/brightray b/vendor/brightray index ca80107e3dec..b103a37d0533 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit ca80107e3dec28d5b49d64da9985525c3e2c4e84 +Subproject commit b103a37d05335766421f4228fcb392cc57f8ea67 From 0b1a3f3ef3b02bd76f411eef775913242d2ff3fb Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Sat, 5 Sep 2015 22:39:48 +0800 Subject: [PATCH 1148/1293] Manage the life of BrowserContext in Session --- atom/browser/api/atom_api_session.cc | 20 ++++++++---- atom/browser/api/atom_api_session.h | 8 +++-- atom/browser/api/atom_api_web_contents.cc | 37 ++++++++++++----------- atom/browser/atom_browser_context.cc | 6 ++-- vendor/brightray | 2 +- 5 files changed, 44 insertions(+), 29 deletions(-) diff --git a/atom/browser/api/atom_api_session.cc b/atom/browser/api/atom_api_session.cc index 3ca15ab871fa..db9d89c3dd60 100644 --- a/atom/browser/api/atom_api_session.cc +++ b/atom/browser/api/atom_api_session.cc @@ -241,7 +241,7 @@ Session::Session(AtomBrowserContext* browser_context) Session::~Session() { auto download_manager = - content::BrowserContext::GetDownloadManager(browser_context_); + content::BrowserContext::GetDownloadManager(browser_context()); download_manager->RemoveObserver(this); } @@ -258,7 +258,7 @@ void Session::OnDownloadCreated(content::DownloadManager* manager, } void Session::ResolveProxy(const GURL& url, ResolveProxyCallback callback) { - new ResolveProxyHelper(browser_context_, url, callback); + new ResolveProxyHelper(browser_context(), url, callback); } void Session::ClearCache(const net::CompletionCallback& callback) { @@ -279,7 +279,7 @@ void Session::ClearStorageData(mate::Arguments* args) { } auto storage_partition = - content::BrowserContext::GetStoragePartition(browser_context_, nullptr); + content::BrowserContext::GetStoragePartition(browser_context(), nullptr); storage_partition->ClearData( options.storage_types, options.quota_types, options.origin, content::StoragePartition::OriginMatcherFunction(), @@ -300,7 +300,7 @@ void Session::SetDownloadPath(const base::FilePath& path) { v8::Local Session::Cookies(v8::Isolate* isolate) { if (cookies_.IsEmpty()) { - auto handle = atom::api::Cookies::Create(isolate, browser_context_); + auto handle = atom::api::Cookies::Create(isolate, browser_context()); cookies_.Reset(isolate, handle.ToV8()); } return v8::Local::New(isolate, cookies_); @@ -319,8 +319,7 @@ mate::ObjectTemplateBuilder Session::GetObjectTemplateBuilder( // static mate::Handle Session::CreateFrom( - v8::Isolate* isolate, - AtomBrowserContext* browser_context) { + v8::Isolate* isolate, AtomBrowserContext* browser_context) { auto existing = TrackableObject::FromWrappedClass(isolate, browser_context); if (existing) return mate::CreateHandle(isolate, static_cast(existing)); @@ -330,6 +329,14 @@ mate::Handle Session::CreateFrom( return handle; } +// static +mate::Handle Session::FromPartition( + v8::Isolate* isolate, const std::string& partition, bool in_memory) { + auto browser_context = brightray::BrowserContext::From(partition, in_memory); + return CreateFrom(isolate, + static_cast(browser_context.get())); +} + void SetWrapSession(const WrapSessionCallback& callback) { g_wrap_session = callback; } @@ -348,6 +355,7 @@ void Initialize(v8::Local exports, v8::Local unused, v8::Local context, void* priv) { v8::Isolate* isolate = context->GetIsolate(); mate::Dictionary dict(isolate, exports); + dict.SetMethod("fromPartition", &atom::api::Session::FromPartition); dict.SetMethod("_setWrapSession", &atom::api::SetWrapSession); dict.SetMethod("_clearWrapSession", &atom::api::ClearWrapSession); } diff --git a/atom/browser/api/atom_api_session.h b/atom/browser/api/atom_api_session.h index c06348974ff4..d9799861401b 100644 --- a/atom/browser/api/atom_api_session.h +++ b/atom/browser/api/atom_api_session.h @@ -37,7 +37,11 @@ class Session: public mate::TrackableObject, static mate::Handle CreateFrom( v8::Isolate* isolate, AtomBrowserContext* browser_context); - AtomBrowserContext* browser_context() const { return browser_context_; } + // Gets the Session of |partition| and |in_memory|. + static mate::Handle FromPartition( + v8::Isolate* isolate, const std::string& partition, bool in_memory); + + AtomBrowserContext* browser_context() const { return browser_context_.get(); } protected: explicit Session(AtomBrowserContext* browser_context); @@ -61,7 +65,7 @@ class Session: public mate::TrackableObject, v8::Global cookies_; - AtomBrowserContext* browser_context_; // weak ref + scoped_refptr browser_context_; DISALLOW_COPY_AND_ASSIGN(Session); }; diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index e91656570112..77fbf9f1de8a 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -156,30 +156,36 @@ WebContents::WebContents(content::WebContents* web_contents) WebContents::WebContents(v8::Isolate* isolate, const mate::Dictionary& options) { + // Whether it is a guest WebContents. bool is_guest = false; options.Get("isGuest", &is_guest); - type_ = is_guest ? WEB_VIEW : BROWSER_WINDOW; - // TODO(zcbenz): Use host's BrowserContext when no partition is specified. - content::BrowserContext* browser_context = - AtomBrowserMainParts::Get()->browser_context(); + // Obtain the session. + std::string partition; + mate::Handle session; + if (options.Get("session", &session)) { + } else if (options.Get("partition", &partition)) { + bool in_memory = true; + options.Get("inMemory", &in_memory); + session = Session::FromPartition(isolate, partition, in_memory); + } else { + // Use the default session if not specified. + session = Session::FromPartition(isolate, "", false); + } + session_.Reset(isolate, session.ToV8()); + content::WebContents* web_contents; if (is_guest) { - std::string partition; - bool in_memory = false; - options.Get("partition", &partition); - options.Get("inMemory", &in_memory); - if (!partition.empty()) - browser_context = brightray::BrowserContext::From(partition, in_memory); content::SiteInstance* site_instance = content::SiteInstance::CreateForURL( - browser_context, GURL("chrome-guest://fake-host")); - content::WebContents::CreateParams params(browser_context, site_instance); + session->browser_context(), GURL("chrome-guest://fake-host")); + content::WebContents::CreateParams params( + session->browser_context(), site_instance); guest_delegate_.reset(new WebViewGuestDelegate); params.guest_delegate = guest_delegate_.get(); web_contents = content::WebContents::Create(params); } else { - content::WebContents::CreateParams params(browser_context); + content::WebContents::CreateParams params(session->browser_context()); web_contents = content::WebContents::Create(params); } @@ -496,6 +502,7 @@ void WebContents::NavigationEntryCommitted( } void WebContents::Destroy() { + session_.Reset(); if (type_ == WEB_VIEW && managed_web_contents()) { // When force destroying the "destroyed" event is not emitted. WebContentsDestroyed(); @@ -658,10 +665,6 @@ void WebContents::InspectServiceWorker() { } v8::Local WebContents::Session(v8::Isolate* isolate) { - if (session_.IsEmpty()) { - auto handle = Session::CreateFrom(isolate, GetBrowserContext()); - session_.Reset(isolate, handle.ToV8()); - } return v8::Local::New(isolate, session_); } diff --git a/atom/browser/atom_browser_context.cc b/atom/browser/atom_browser_context.cc index 81973857b124..d1ef09e70ff6 100644 --- a/atom/browser/atom_browser_context.cc +++ b/atom/browser/atom_browser_context.cc @@ -168,9 +168,9 @@ void AtomBrowserContext::RegisterPrefs(PrefRegistrySimple* pref_registry) { namespace brightray { // static -BrowserContext* BrowserContext::Create(const std::string& partition, - bool in_memory) { - return new atom::AtomBrowserContext(partition, in_memory); +scoped_refptr BrowserContext::Create( + const std::string& partition, bool in_memory) { + return make_scoped_refptr(new atom::AtomBrowserContext(partition, in_memory)); } } // namespace brightray diff --git a/vendor/brightray b/vendor/brightray index b103a37d0533..251521cb8c51 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit b103a37d05335766421f4228fcb392cc57f8ea67 +Subproject commit 251521cb8c51670dbd08ab9fd2dd45e249cbb596 From 2454dccde0bfbbd436e00dd0caa5afa0a427af6f Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Sat, 5 Sep 2015 23:22:38 +0800 Subject: [PATCH 1149/1293] docs: preload, node-integration, zoom-factor have been moved --- docs/api/browser-window.md | 28 +++++++++++++++++----------- docs/api/web-view-tag.md | 18 +++++++++--------- 2 files changed, 26 insertions(+), 20 deletions(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index e9d2c7f6feb8..3e19b5bfabfb 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -48,8 +48,6 @@ Properties `width` and `height` are required. * `fullscreen` Boolean - Whether the window should show in fullscreen. When set to `false` the fullscreen button will also be hidden on OS X. * `skip-taskbar` Boolean - Whether to show the window in taskbar. -* `zoom-factor` Number - The default zoom factor of the page, `3.0` represents -`300%`. * `kiosk` Boolean - The kiosk mode. * `title` String - Default window title. * `icon` [NativeImage](native-image.md) - The window icon, when omitted on @@ -57,8 +55,6 @@ Properties `width` and `height` are required. * `show` Boolean - Whether window should be shown when created. * `frame` Boolean - Specify `false` to create a [Frameless Window](frameless-window.md). -* `node-integration` Boolean - Whether node integration is enabled. Default - is `true`. * `accept-first-mouse` Boolean - Whether the web view accepts a single mouse-down event that simultaneously activates the window. * `disable-auto-hide-cursor` Boolean - Whether to hide cursor when typing. @@ -68,10 +64,6 @@ Properties `width` and `height` are required. than screen. * `dark-theme` Boolean - Forces using dark theme for the window, only works on some GTK+3 desktop environments. -* `preload` String - Specifies a script that will be loaded before other - scripts run in the window. This script will always have access to node APIs - no matter whether node integration is turned on for the window, and the path - of `preload` script has to be absolute path. * `transparent` Boolean - Makes the window [transparent](frameless-window.md). * `type` String - Specifies the type of the window, possible types are `desktop`, `dock`, `toolbar`, `splash`, `notification`. This only works on @@ -79,11 +71,25 @@ Properties `width` and `height` are required. * `standard-window` Boolean - Uses the OS X's standard window instead of the textured window. Defaults to `true`. * `web-preferences` Object - Settings of web page's features, properties: + * `node-integration` Boolean - Whether node integration is enabled. Default + is `true`. + * `preload` String - Specifies a script that will be loaded before other + scripts run in the page. This script will always have access to node APIs + no matter whether node integration is turned on for the page, and the path + of `preload` script has to be absolute path. + * `partition` String - Sets the session used by the page. If `partition` + starts with `persist:`, the page will use a persistent session available to + all pages in the app with the same `partition`. if there is no `persist:` + prefix, the page will use an in-memory session. By assigning the same + `partition`, multiple pages can share the same session. If the `partition` + is unset then default session of the app will be used. + * `zoom-factor` Number - The default zoom factor of the page, `3.0` represents + `300%`. * `javascript` Boolean * `web-security` Boolean - When setting `false`, it will disable the - same-origin policy (Usually using testing websites by people), and set `allow_displaying_insecure_content` - and `allow_running_insecure_content` to `true` if these two options are not - set by user. + same-origin policy (Usually using testing websites by people), and set + `allow_displaying_insecure_content` and `allow_running_insecure_content` to + `true` if these two options are not set by user. * `allow-displaying-insecure-content` Boolean - Allow an https page to display content like images from http URLs. * `allow-running-insecure-content` Boolean - Allow a https page to run diff --git a/docs/api/web-view-tag.md b/docs/api/web-view-tag.md index c1b1f705e95b..850390702168 100644 --- a/docs/api/web-view-tag.md +++ b/docs/api/web-view-tag.md @@ -138,16 +138,16 @@ If "on", the guest page will have web security disabled. ``` -Sets the storage partition used by the `webview`. If the storage partition ID starts with `persist:`, -the `webview` will use a persistent storage partition available to all `webview` in the app with -the same storage partition ID. if there is no `persist:` prefix, the `webview` will -use an in-memory storage partition. By assigning the same partition ID, multiple `webview` -can share the same storage partition. If the storage partition ID is unset then default storage -of the app will be used. +Sets the session used by the page. If `partition` starts with `persist:`, the +page will use a persistent session available to all pages in the app with the +same `partition`. if there is no `persist:` prefix, the page will use an +in-memory session. By assigning the same `partition`, multiple pages can share +the same session. If the `partition` is unset then default session of the app +will be used. -This value can only be modified before the first navigation, since the storage partition of an active -renderer process cannot change. Subsequent attempts to modify the value will fail with a -DOM exception. +This value can only be modified before the first navigation, since the session +of an active renderer process cannot change. Subsequent attempts to modify the +value will fail with a DOM exception. ## Methods From 5eb0bedbbca8b9062d11ea412230ee5ab19db4d3 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Sun, 6 Sep 2015 09:22:32 +0800 Subject: [PATCH 1150/1293] Parse partition in webContents.create --- atom/browser/api/atom_api_web_contents.cc | 7 +++++-- atom/browser/lib/guest-view-manager.coffee | 11 +---------- 2 files changed, 6 insertions(+), 12 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 77fbf9f1de8a..d22f7aab61fd 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -165,9 +165,12 @@ WebContents::WebContents(v8::Isolate* isolate, std::string partition; mate::Handle session; if (options.Get("session", &session)) { - } else if (options.Get("partition", &partition)) { + } else if (options.Get("partition", &partition) && !partition.empty()) { bool in_memory = true; - options.Get("inMemory", &in_memory); + if (base::StartsWith(partition, "persist:", base::CompareCase::SENSITIVE)) { + in_memory = false; + partition = partition.substr(8); + } session = Session::FromPartition(isolate, partition, in_memory); } else { // Use the default session if not specified. diff --git a/atom/browser/lib/guest-view-manager.coffee b/atom/browser/lib/guest-view-manager.coffee index c7ec439f96f0..1c05b65b2dc0 100644 --- a/atom/browser/lib/guest-view-manager.coffee +++ b/atom/browser/lib/guest-view-manager.coffee @@ -38,21 +38,12 @@ moveLastToFirst = (list) -> getNextInstanceId = (webContents) -> ++nextInstanceId -# Parse the partition string. -parsePartition = (partition) -> - return ['', false] unless partition - if partition.startsWith 'persist:' - [partition.substr('persist:'.length), false] - else - [partition, true] - # Create a new guest instance. createGuest = (embedder, params) -> webViewManager ?= process.atomBinding 'web_view_manager' id = getNextInstanceId embedder - [partition, inMemory] = parsePartition params.partition - guest = webContents.create {isGuest: true, partition, inMemory, embedder} + guest = webContents.create {isGuest: true, partition: params.partition, embedder} guestInstances[id] = {guest, embedder} # Destroy guest when the embedder is gone or navigated. From e2bd1abce635f39ef8dc20b73afdaca01130761a Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Sun, 6 Sep 2015 10:30:59 +0800 Subject: [PATCH 1151/1293] Make sure BrowserContext is destroyed on exit --- atom/browser/api/atom_api_session.cc | 20 ++++++++++++++------ atom/browser/api/atom_api_session.h | 7 ++++++- atom/browser/api/atom_api_web_contents.h | 4 +++- atom/browser/api/atom_api_window.cc | 5 ++++- atom/browser/api/atom_api_window.h | 4 +++- atom/browser/api/trackable_object.cc | 9 ++++++--- atom/browser/api/trackable_object.h | 12 ++++++++++-- vendor/brightray | 2 +- 8 files changed, 47 insertions(+), 16 deletions(-) diff --git a/atom/browser/api/atom_api_session.cc b/atom/browser/api/atom_api_session.cc index db9d89c3dd60..7d31626c1413 100644 --- a/atom/browser/api/atom_api_session.cc +++ b/atom/browser/api/atom_api_session.cc @@ -233,16 +233,16 @@ void SetProxyInIO(net::URLRequestContextGetter* getter, Session::Session(AtomBrowserContext* browser_context) : browser_context_(browser_context) { AttachAsUserData(browser_context); + // Observe DownloadManger to get download notifications. - auto download_manager = - content::BrowserContext::GetDownloadManager(browser_context); - download_manager->AddObserver(this); + content::BrowserContext::GetDownloadManager(browser_context)-> + AddObserver(this); } Session::~Session() { - auto download_manager = - content::BrowserContext::GetDownloadManager(browser_context()); - download_manager->RemoveObserver(this); + content::BrowserContext::GetDownloadManager(browser_context())-> + RemoveObserver(this); + Destroy(); } void Session::OnDownloadCreated(content::DownloadManager* manager, @@ -257,6 +257,14 @@ void Session::OnDownloadCreated(content::DownloadManager* manager, } } +bool Session::IsDestroyed() const { + return !browser_context_; +} + +void Session::Destroy() { + browser_context_ = nullptr; +} + void Session::ResolveProxy(const GURL& url, ResolveProxyCallback callback) { new ResolveProxyHelper(browser_context(), url, callback); } diff --git a/atom/browser/api/atom_api_session.h b/atom/browser/api/atom_api_session.h index d9799861401b..14406e57af5b 100644 --- a/atom/browser/api/atom_api_session.h +++ b/atom/browser/api/atom_api_session.h @@ -51,11 +51,15 @@ class Session: public mate::TrackableObject, void OnDownloadCreated(content::DownloadManager* manager, content::DownloadItem* item) override; - // mate::Wrappable implementations: + // mate::Wrappable: mate::ObjectTemplateBuilder GetObjectTemplateBuilder( v8::Isolate* isolate) override; + bool IsDestroyed() const override; private: + // mate::TrackableObject: + void Destroy() override; + void ResolveProxy(const GURL& url, ResolveProxyCallback callback); void ClearCache(const net::CompletionCallback& callback); void ClearStorageData(mate::Arguments* args); @@ -63,6 +67,7 @@ class Session: public mate::TrackableObject, void SetDownloadPath(const base::FilePath& path); v8::Local Cookies(v8::Isolate* isolate); + // Cached object for cookies API. v8::Global cookies_; scoped_refptr browser_context_; diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index 5ea62dabff62..e2e405b73853 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -48,7 +48,9 @@ class WebContents : public mate::TrackableObject, static mate::Handle Create( v8::Isolate* isolate, const mate::Dictionary& options); - void Destroy(); + // mate::TrackableObject: + void Destroy() override; + bool IsAlive() const; int GetID() const; bool Equal(const WebContents* web_contents) const; diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index 586cfdb2a78d..e171fa7698f0 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -221,7 +221,10 @@ bool Window::IsDestroyed() const { } void Window::Destroy() { - window_->CloseContents(nullptr); + if (window_) { + window_->CloseContents(nullptr); + window_.reset(); + } } void Window::Close() { diff --git a/atom/browser/api/atom_api_window.h b/atom/browser/api/atom_api_window.h index de2f093ea3e1..4384e03a249f 100644 --- a/atom/browser/api/atom_api_window.h +++ b/atom/browser/api/atom_api_window.h @@ -78,8 +78,10 @@ class Window : public mate::TrackableObject, bool IsDestroyed() const override; private: + // mate::TrackableObject: + void Destroy() override; + // APIs for NativeWindow. - void Destroy(); void Close(); bool IsClosed(); void Focus(); diff --git a/atom/browser/api/trackable_object.cc b/atom/browser/api/trackable_object.cc index ae9fa44230a0..50bfa59e6a7a 100644 --- a/atom/browser/api/trackable_object.cc +++ b/atom/browser/api/trackable_object.cc @@ -29,7 +29,9 @@ class IDUserData : public base::SupportsUserData::Data { } // namespace TrackableObjectBase::TrackableObjectBase() - : weak_map_id_(0), wrapped_(nullptr) { + : weak_map_id_(0), wrapped_(nullptr), weak_factory_(this) { + RegisterDestructionCallback( + base::Bind(&TrackableObjectBase::Destroy, weak_factory_.GetWeakPtr())); } TrackableObjectBase::~TrackableObjectBase() { @@ -61,8 +63,9 @@ int32_t TrackableObjectBase::GetIDFromWrappedClass(base::SupportsUserData* w) { } // static -void TrackableObjectBase::RegisterDestructionCallback(void (*c)()) { - atom::AtomBrowserMainParts::Get()->RegisterDestructionCallback(base::Bind(c)); +void TrackableObjectBase::RegisterDestructionCallback( + const base::Closure& closure) { + atom::AtomBrowserMainParts::Get()->RegisterDestructionCallback(closure); } } // namespace mate diff --git a/atom/browser/api/trackable_object.h b/atom/browser/api/trackable_object.h index 656904cc45d0..8ff7d1c04041 100644 --- a/atom/browser/api/trackable_object.h +++ b/atom/browser/api/trackable_object.h @@ -9,7 +9,9 @@ #include "atom/browser/api/event_emitter.h" #include "atom/common/id_weak_map.h" +#include "base/bind.h" #include "base/memory/scoped_ptr.h" +#include "base/memory/weak_ptr.h" namespace base { class SupportsUserData; @@ -28,6 +30,9 @@ class TrackableObjectBase : public mate::EventEmitter { // Wrap TrackableObject into a class that SupportsUserData. void AttachAsUserData(base::SupportsUserData* wrapped); + // Subclasses should implement this to destroy their native types. + virtual void Destroy() = 0; + protected: ~TrackableObjectBase() override; @@ -39,12 +44,14 @@ class TrackableObjectBase : public mate::EventEmitter { // Register a callback that should be destroyed before JavaScript environment // gets destroyed. - static void RegisterDestructionCallback(void (*callback)()); + static void RegisterDestructionCallback(const base::Closure& closure); int32_t weak_map_id_; base::SupportsUserData* wrapped_; private: + base::WeakPtrFactory weak_factory_; + DISALLOW_COPY_AND_ASSIGN(TrackableObjectBase); }; @@ -85,7 +92,8 @@ class TrackableObject : public TrackableObjectBase { } TrackableObject() { - RegisterDestructionCallback(&TrackableObject::ReleaseAllWeakReferences); + RegisterDestructionCallback( + base::Bind(&TrackableObject::ReleaseAllWeakReferences)); } // Removes this instance from the weak map. diff --git a/vendor/brightray b/vendor/brightray index 251521cb8c51..8d64120b51b4 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit 251521cb8c51670dbd08ab9fd2dd45e249cbb596 +Subproject commit 8d64120b51b48be46eaa419957b965c0ccfc6c8f From 512f89910df7352f6709578e8f6a143041cf6f9f Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Sun, 6 Sep 2015 11:07:38 +0800 Subject: [PATCH 1152/1293] docs: No more extra-plugin-dirs --- docs/api/browser-window.md | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 3e19b5bfabfb..d74e999379ba 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -99,13 +99,7 @@ Properties `width` and `height` are required. * `text-areas-are-resizable` Boolean * `webgl` Boolean * `webaudio` Boolean - * `plugins` Boolean - Whether plugins should be enabled, currently only - `NPAPI` plugins are supported. - * `extra-plugin-dirs` Array - Array of paths that would be searched for - plugins. Note that if you want to add a directory under your app, you - should use `__dirname` or `process.resourcesPath` to join the paths to - make them absolute, using relative paths would make Electron search - under current working directory. + * `plugins` Boolean - Whether plugins should be enabled. * `experimental-features` Boolean * `experimental-canvas-features` Boolean * `subpixel-font-scaling` Boolean From 342e0c6cf716d6009eca0ba4da303acf6d18b59f Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Sun, 6 Sep 2015 11:13:41 +0800 Subject: [PATCH 1153/1293] Remove dead code --- atom/browser/native_window.h | 7 ------- 1 file changed, 7 deletions(-) diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index a10eda912e50..b89e2b58e6e4 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -24,10 +24,6 @@ class SkRegion; -namespace base { -class CommandLine; -} - namespace brightray { class InspectableWebContents; } @@ -187,9 +183,6 @@ class NativeWindow : public content::WebContentsObserver, content::WebContents*, const content::NativeWebKeyboardEvent& event) {} - // Called when renderer process is going to be started. - void AppendExtraCommandLineSwitches(base::CommandLine* command_line); - // Public API used by platform-dependent delegates and observers to send UI // related notifications. void NotifyWindowClosed(); From 4537d88a580f5768b7c64c6b96d4a99a60c99f74 Mon Sep 17 00:00:00 2001 From: Dick Choi Date: Sun, 6 Sep 2015 12:36:27 +0900 Subject: [PATCH 1154/1293] fix typo Code block should be ended `` --- docs-translations/ko/api/content-tracing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-translations/ko/api/content-tracing.md b/docs-translations/ko/api/content-tracing.md index f6010d156f6a..6c8133823a9f 100644 --- a/docs-translations/ko/api/content-tracing.md +++ b/docs-translations/ko/api/content-tracing.md @@ -15,7 +15,7 @@ contentTracing.startRecording('*', contentTracing.DEFAULT_OPTIONS, function() { }); }, 5000); }); -`` +``` ## Methods From f56d71510409b40b36e0b7ad881838f4791833ff Mon Sep 17 00:00:00 2001 From: Jonatas Freitas Date: Sun, 6 Sep 2015 01:27:34 -0300 Subject: [PATCH 1155/1293] Translated application-packaging.md to pt-BR. --- docs-translations/pt-BR/README.md | 2 +- .../pt-BR/tutorial/application-packaging.md | 158 ++++++++++++++++++ 2 files changed, 159 insertions(+), 1 deletion(-) create mode 100644 docs-translations/pt-BR/tutorial/application-packaging.md diff --git a/docs-translations/pt-BR/README.md b/docs-translations/pt-BR/README.md index 08834fc39c9f..88fb26a5ea54 100644 --- a/docs-translations/pt-BR/README.md +++ b/docs-translations/pt-BR/README.md @@ -1,7 +1,7 @@ ## Guias * [Distribuir Aplicação](tutorial/application-distribution.md) -* [Empacotamento da aplicação](../../docs/tutorial/application-packaging.md) +* [Empacotamento da aplicação](tutorial/application-packaging.md) * [Usando módulos nativos](../../docs/tutorial/using-native-node-modules.md) * [Depuração do processo principal](../../docs/tutorial/debugging-main-process.md) * [Usando Selenium e WebDriver](../../docs/tutorial/using-selenium-and-webdriver.md) diff --git a/docs-translations/pt-BR/tutorial/application-packaging.md b/docs-translations/pt-BR/tutorial/application-packaging.md new file mode 100644 index 000000000000..f55cbb2f7d64 --- /dev/null +++ b/docs-translations/pt-BR/tutorial/application-packaging.md @@ -0,0 +1,158 @@ +# Empacotamento da aplicação + +Para proteger os recursos e o código fonte da sua aplicação você pode optar por +empacotar a sua aplicação em um arquivo [asar](https://github.com/atom/asar), isto é possível com poucas +alterações em seu código. + +## Gerando um arquivo `asar` + +Um arquivo [asar][asar] é um formato parecido com tar ou zip bem simples que concatena arquivos +em um único arquivo. O Electron pode ler arquivos arbitrários a partir dele sem descompacatar +o arquivo inteiro. + +Passos para empacotar a sua aplicação em um arquivo `asar`: + +### 1. Instale o utilitário asar + +```bash +$ npm install -g asar +``` + +### 2. Empacote a sua aplicação + +```bash +$ asar pack your-app app.asar +``` + +## Usando arquivos `asar` + +No Electron existem dois conjuntos de APIs: Node APIs fornecidas pelo Node.js e Web +APIs fornecidas pelo Chromium. Ambas as APIs suportam a leitura de arquivos `asar`. + +### Node API + +As API's do Node como `fs.readFile` e `require` tratam os pacotes `asar` +como diretórios virtuais e os arquivos dentro dele como arquivos normais. + +Por exemplo, temos um arquivo `example.asar` sob `/path/to`: + +```bash +$ asar list /path/to/example.asar +/app.js +/file.txt +/dir/module.js +/static/index.html +/static/main.css +/static/jquery.min.js +``` + +Lendo um arquivo em pacote `asar`: + +```javascript +var fs = require('fs'); +fs.readFileSync('/path/to/example.asar/file.txt'); +``` + +Listando todos os arquivos a partir da raiz: + +```javascript +var fs = require('fs'); +fs.readdirSync('/path/to/example.asar'); +``` + +Utilizando um módulo dentro do pacote `asar`: + +```javascript +require('/path/to/example.asar/dir/module.js'); +``` + +Você também pode renderizar uma página web apartir de um arquivo `asar` utilizando o módulo `BrowserWindow`: + +```javascript +var BrowserWindow = require('browser-window'); +var win = new BrowserWindow({width: 800, height: 600}); +win.loadUrl('file:///path/to/example.asar/static/index.html'); +``` + +### API Web + +Em uma página web, arquivos em um pacote `asar` pode ser solicitado com o protocolo `file:`. +Como a API Node, arquivos `asar` são tratadas como diretórios. + +Por exemplo, para obter um arquivo com `$ .get`: + +```html + +``` + +### Tratando um pacote `asar` como um arquivo normal + +Para alguns casos, precisamos verificar o checksum de um pacote `asar`, para fazer isto, precisamos ler +o arquivo `asar` como um arquivo normal. Para isto, você pode usar o built-in +`original-fs` que fornece a API `fs`, sem apoio a arquivos asar`: + +```javascript +var originalFs = require('original-fs'); +originalFs.readFileSync('/path/to/example.asar'); +``` + +## Limitaçõs na API Node + +Mesmo fazendo grandes esforços para pacotes `asar` ser tratado no Node como diretórios, +ainda existem limitações devido a natureza de baixo nível do Node + +### Arquivos `asar` são somente leitura + +Os arquivos `asar` não podem ser modificados. + +### Diretório de trabalho não pode ser comportar como diretório de arquivos + +Embora pacotes `asar` são tratadas como diretórios, não há +diretórios reais no sistema de arquivos, assim você nunca pode definir o diretório de trabalho para +diretórios em pacotes `asar`, passando-os como a opção `cwd` de algumas APIs +também irá causar erros. + +### Descompactação extra em algumas APIs + +A maioria das APIs `fs` pode ler um arquivo ou obter informações de um arquivo a partir de pacotes `asar` +sem descompacta-lo, mas para algumas APIs da rota real o Electron irá extrair o arquivo necessário para um +arquivo temporário e passar o caminho do arquivo temporário para as APIs, +isso adiciona um pouco de sobrecarga para essas APIs. + +APIs que requer descompactação extras são: + +* `child_process.execFile` +* `fs.open` +* `fs.openSync` +* `process.dlopen` - Usado por `require` em módulos nativos + +### Falsas informações de status do módulo `fs.stat` + +O objeto `Stats` retornado por` fs.stat` e outras funções relacionadas não são informações confiáveis, +você não deve confiar no objeto `Stats` exceto para obter o +tamanho do arquivo e verificação de tipo de arquivo. + +## Adicionando arquivos em um pacote `asar` + +Como dito acima, algumas APIs deo Node irá descompactar o arquivo para quando o filesystem +requsistar, além dos problemas de desempenho, ele também pode levar a falsos alertas +de vírus. + +Para contornar isso, você pode descompactar alguns arquivos usando a +opção `--unpack`, um exemplo de exclusão de bibliotecas compartilhadas de módulos nativos +é: + +```bash +$ asar pack app app.asar --unpack *.node +``` + +Depois de executar o comando, além do `app.asar`, há também +`app.asar.unpacked` pasta gerada que contém os arquivos descompactados, você +deve copiá-lo juntamente com `app.asar` quando enviá-lo para os usuários. + +Mais informações no repositório [asar](https://github.com/atom/asar) \ No newline at end of file From 8cc1046992e9bdd89c9b43944bfde01e344135e8 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 7 Sep 2015 11:05:27 +0800 Subject: [PATCH 1156/1293] Update to io.js 3.3.0 --- vendor/node | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/node b/vendor/node index 8253eb682526..5a8258dfabe7 160000 --- a/vendor/node +++ b/vendor/node @@ -1 +1 @@ -Subproject commit 8253eb68252639db471090edb059eaa4fea4ce46 +Subproject commit 5a8258dfabe7ce3e1489b13d3459ef1d6260d6a5 From 0a4fb2ec4f36b90e7e1b7f0755d89665fbe9bbd9 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 7 Sep 2015 11:12:42 +0800 Subject: [PATCH 1157/1293] Support externalized ArrayBuffer for node::Buffer --- atom/renderer/atom_renderer_client.cc | 42 ++------------- atom/renderer/node_array_buffer_bridge.cc | 66 +++++++++++++++++++++++ atom/renderer/node_array_buffer_bridge.h | 15 ++++++ filenames.gypi | 2 + 4 files changed, 86 insertions(+), 39 deletions(-) create mode 100644 atom/renderer/node_array_buffer_bridge.cc create mode 100644 atom/renderer/node_array_buffer_bridge.h diff --git a/atom/renderer/atom_renderer_client.cc b/atom/renderer/atom_renderer_client.cc index ef5ac757d9f4..b99372bf816d 100644 --- a/atom/renderer/atom_renderer_client.cc +++ b/atom/renderer/atom_renderer_client.cc @@ -7,11 +7,12 @@ #include #include "atom/common/api/atom_bindings.h" -#include "atom/common/native_mate_converters/callback.h" #include "atom/common/node_bindings.h" +#include "atom/common/node_includes.h" #include "atom/common/options_switches.h" #include "atom/renderer/atom_render_view_observer.h" #include "atom/renderer/guest_view_container.h" +#include "atom/renderer/node_array_buffer_bridge.h" #include "base/command_line.h" #include "chrome/renderer/pepper/pepper_helper.h" #include "chrome/renderer/printing/print_web_view_helper.h" @@ -20,16 +21,12 @@ #include "content/public/renderer/render_frame.h" #include "content/public/renderer/render_frame_observer.h" #include "content/public/renderer/render_thread.h" -#include "third_party/WebKit/public/web/WebArrayBuffer.h" -#include "third_party/WebKit/public/web/WebArrayBufferConverter.h" #include "third_party/WebKit/public/web/WebCustomElement.h" #include "third_party/WebKit/public/web/WebLocalFrame.h" #include "third_party/WebKit/public/web/WebPluginParams.h" #include "third_party/WebKit/public/web/WebKit.h" #include "third_party/WebKit/public/web/WebRuntimeFeatures.h" -#include "atom/common/node_includes.h" - #if defined(OS_WIN) #include #endif @@ -51,37 +48,6 @@ bool IsSwitchEnabled(base::CommandLine* command_line, return true; } -// global.Uint8Array; -v8::Local GetUint8ArrayConstructor( - v8::Isolate* isolate, v8::Local context) { - v8::Local constructor = context->Global()->Get( - mate::StringToV8(isolate, "Uint8Array")); - return v8::Local::Cast(constructor); -} - -// new ArrayBuffer(size); -v8::Local BlinkArrayBufferCreate( - v8::Isolate* isolate, size_t size) { - blink::WebArrayBuffer buffer = blink::WebArrayBuffer::create(size, 1); - return v8::Local::Cast( - blink::WebArrayBufferConverter::toV8Value( - &buffer, isolate->GetCurrentContext()->Global(), isolate)); -} - -// new Uint8Array(array_buffer, offset, size); -v8::Local BlinkUint8ArrayCreate( - v8::Local ab, size_t offset, size_t size) { - v8::Local context = ab->CreationContext(); - v8::Isolate* isolate = context->GetIsolate(); - v8::Local constructor = - GetUint8ArrayConstructor(isolate, context); - v8::Local args[] = { - ab, mate::ConvertToV8(isolate, offset), mate::ConvertToV8(isolate, size) - }; - return v8::Local::Cast(constructor->NewInstance( - context, arraysize(args), args).ToLocalChecked()); -} - // Helper class to forward the messages to the client. class AtomRenderFrameObserver : public content::RenderFrameObserver { public: @@ -120,9 +86,7 @@ void AtomRendererClient::WebKitInitialized() { blink::WebCustomElement::addEmbedderCustomElementName("webview"); blink::WebCustomElement::addEmbedderCustomElementName("browserplugin"); - // Override Node's ArrayBuffer with DOM's ArrayBuffer. - node::Buffer::SetArrayBufferCreator(&BlinkArrayBufferCreate, - &BlinkUint8ArrayCreate); + OverrideNodeArrayBuffer(); node_bindings_->Initialize(); node_bindings_->PrepareMessageLoop(); diff --git a/atom/renderer/node_array_buffer_bridge.cc b/atom/renderer/node_array_buffer_bridge.cc new file mode 100644 index 000000000000..80f2530524d2 --- /dev/null +++ b/atom/renderer/node_array_buffer_bridge.cc @@ -0,0 +1,66 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#include "atom/renderer/node_array_buffer_bridge.h" + +#include "base/basictypes.h" +#include "atom/common/node_includes.h" +#include "native_mate/converter.h" +#include "third_party/WebKit/public/web/WebArrayBuffer.h" +#include "third_party/WebKit/public/web/WebArrayBufferConverter.h" + +namespace atom { + +namespace { + +// global.Uint8Array; +v8::Local GetUint8ArrayConstructor( + v8::Isolate* isolate, v8::Local context) { + v8::Local constructor = context->Global()->Get( + mate::StringToV8(isolate, "Uint8Array")); + return v8::Local::Cast(constructor); +} + +// new ArrayBuffer(size); +v8::Local BlinkArrayBufferNew( + v8::Isolate* isolate, size_t size) { + blink::WebArrayBuffer buffer = blink::WebArrayBuffer::create(size, 1); + return v8::Local::Cast( + blink::WebArrayBufferConverter::toV8Value( + &buffer, isolate->GetCurrentContext()->Global(), isolate)); +} + +// new ArrayBuffer(data, size); +v8::Local BlinkArrayBufferNewWith( + v8::Isolate* isolate, void* data, size_t size) { + blink::WebArrayBuffer buffer = blink::WebArrayBuffer::createExternal( + data, size); + return v8::Local::Cast( + blink::WebArrayBufferConverter::toV8Value( + &buffer, isolate->GetCurrentContext()->Global(), isolate)); +} + +// new Uint8Array(array_buffer, offset, size); +v8::Local BlinkUint8ArrayNew( + v8::Local ab, size_t offset, size_t size) { + // Use the DOM's Uint8Array constructor to create Uint8Array. + v8::Local context = ab->CreationContext(); + v8::Isolate* isolate = context->GetIsolate(); + v8::Local constructor = + GetUint8ArrayConstructor(isolate, context); + v8::Local args[] = { + ab, mate::ConvertToV8(isolate, offset), mate::ConvertToV8(isolate, size) + }; + return v8::Local::Cast(constructor->NewInstance( + context, arraysize(args), args).ToLocalChecked()); +} + +} // namespace + +void OverrideNodeArrayBuffer() { + node::Buffer::SetArrayBufferCreator( + BlinkArrayBufferNew, BlinkArrayBufferNewWith, BlinkUint8ArrayNew); +} + +} // namespace atom diff --git a/atom/renderer/node_array_buffer_bridge.h b/atom/renderer/node_array_buffer_bridge.h new file mode 100644 index 000000000000..61d180699312 --- /dev/null +++ b/atom/renderer/node_array_buffer_bridge.h @@ -0,0 +1,15 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#ifndef ATOM_RENDERER_NODE_ARRAY_BUFFER_BRIDGE_H_ +#define ATOM_RENDERER_NODE_ARRAY_BUFFER_BRIDGE_H_ + +namespace atom { + +// Override Node's ArrayBuffer with DOM's ArrayBuffer. +void OverrideNodeArrayBuffer(); + +} // namespace atom + +#endif // ATOM_RENDERER_NODE_ARRAY_BUFFER_BRIDGE_H_ diff --git a/filenames.gypi b/filenames.gypi index b4d3bcb5e186..78a8e17f2f99 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -326,6 +326,8 @@ 'atom/renderer/atom_renderer_client.h', 'atom/renderer/guest_view_container.cc', 'atom/renderer/guest_view_container.h', + 'atom/renderer/node_array_buffer_bridge.cc', + 'atom/renderer/node_array_buffer_bridge.h', 'atom/utility/atom_content_utility_client.cc', 'atom/utility/atom_content_utility_client.h', 'chromium_src/chrome/browser/browser_process.cc', From 10bc0c20b11504226c6e7a9f06f36ba554d48cb8 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 7 Sep 2015 11:18:11 +0800 Subject: [PATCH 1158/1293] Update libchromiumcontent to have WebArrayBuffer::createExternal API --- script/lib/config.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/script/lib/config.py b/script/lib/config.py index 3fed12000b48..0df68bd773bf 100644 --- a/script/lib/config.py +++ b/script/lib/config.py @@ -8,7 +8,7 @@ import sys BASE_URL = os.getenv('LIBCHROMIUMCONTENT_MIRROR') or \ 'http://github-janky-artifacts.s3.amazonaws.com/libchromiumcontent' -LIBCHROMIUMCONTENT_COMMIT = 'f5489a774b719e9e979675c17b99ed45a05aacf7' +LIBCHROMIUMCONTENT_COMMIT = '8482fe555913dea3bde8a74f754524e2cfb02bc5' PLATFORM = { 'cygwin': 'win32', From 24bbe5dabf36b3a7a3937821d91db6caa9ebad60 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 7 Sep 2015 15:55:08 +0800 Subject: [PATCH 1159/1293] No need to define WebContentsPreferences::From --- atom/browser/api/atom_api_web_view_manager.cc | 4 +++- atom/browser/web_contents_preferences.cc | 18 +++++------------- atom/browser/web_contents_preferences.h | 3 --- 3 files changed, 8 insertions(+), 17 deletions(-) diff --git a/atom/browser/api/atom_api_web_view_manager.cc b/atom/browser/api/atom_api_web_view_manager.cc index 83287ac8b2f1..e57c5ffb6bb4 100644 --- a/atom/browser/api/atom_api_web_view_manager.cc +++ b/atom/browser/api/atom_api_web_view_manager.cc @@ -10,6 +10,8 @@ #include "content/public/browser/browser_context.h" #include "native_mate/dictionary.h" +using atom::WebContentsPreferences; + namespace mate { template<> @@ -48,7 +50,7 @@ void AddGuest(int guest_instance_id, manager->AddGuest(guest_instance_id, element_instance_id, embedder, guest_web_contents); - atom::WebContentsPreferences::From(guest_web_contents)->Merge(options); + WebContentsPreferences::FromWebContents(guest_web_contents)->Merge(options); } void RemoveGuest(content::WebContents* embedder, int guest_instance_id) { diff --git a/atom/browser/web_contents_preferences.cc b/atom/browser/web_contents_preferences.cc index 19ea826a5ff7..db55eddf7e2d 100644 --- a/atom/browser/web_contents_preferences.cc +++ b/atom/browser/web_contents_preferences.cc @@ -16,13 +16,12 @@ #include "ui/gfx/switches.h" #endif +DEFINE_WEB_CONTENTS_USER_DATA_KEY(atom::WebContentsPreferences); + namespace atom { namespace { -// Pointer as WebContents's user data key. -const char* kWebPreferencesKey = "WebContentsPreferences"; - // Array of available web runtime features. const char* kWebRuntimeFeatures[] = { switches::kExperimentalFeatures, @@ -40,7 +39,7 @@ WebContentsPreferences::WebContentsPreferences( content::WebContents* web_contents, base::DictionaryValue* web_preferences) { web_preferences_.Swap(web_preferences); - web_contents->SetUserData(kWebPreferencesKey, this); + web_contents->SetUserData(UserDataKey(), this); } WebContentsPreferences::~WebContentsPreferences() { @@ -50,17 +49,10 @@ void WebContentsPreferences::Merge(const base::DictionaryValue& extend) { web_preferences_.MergeDictionary(&extend); } -// static -WebContentsPreferences* WebContentsPreferences::From( - content::WebContents* web_contents) { - return static_cast( - web_contents->GetUserData(kWebPreferencesKey)); -} - // static void WebContentsPreferences::AppendExtraCommandLineSwitches( content::WebContents* web_contents, base::CommandLine* command_line) { - WebContentsPreferences* self = From(web_contents); + WebContentsPreferences* self = FromWebContents(web_contents); if (!self) return; @@ -130,7 +122,7 @@ void WebContentsPreferences::AppendExtraCommandLineSwitches( // static void WebContentsPreferences::OverrideWebkitPrefs( content::WebContents* web_contents, content::WebPreferences* prefs) { - WebContentsPreferences* self = From(web_contents); + WebContentsPreferences* self = FromWebContents(web_contents); if (!self) return; diff --git a/atom/browser/web_contents_preferences.h b/atom/browser/web_contents_preferences.h index 310456725aaf..83b485f449bc 100644 --- a/atom/browser/web_contents_preferences.h +++ b/atom/browser/web_contents_preferences.h @@ -22,9 +22,6 @@ namespace atom { class WebContentsPreferences : public content::WebContentsUserData { public: - // Get the preferences of |web_contents|. - static WebContentsPreferences* From(content::WebContents* web_contents); - // Append command paramters according to |web_contents|'s preferences. static void AppendExtraCommandLineSwitches( content::WebContents* web_contents, base::CommandLine* command_line); From 46b2b91a27846ee619997c60d8d313d829b48314 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 7 Sep 2015 16:12:31 +0800 Subject: [PATCH 1160/1293] Don't use Node's internal APIs --- atom/browser/api/atom_api_power_monitor.cc | 7 +++---- atom/browser/api/atom_api_screen.cc | 8 +++++--- atom/browser/api/atom_api_tray.cc | 3 ++- atom/browser/api/atom_api_web_contents.cc | 10 ++++++---- atom/browser/api/atom_api_web_contents.h | 4 ++-- atom/browser/api/atom_api_window.cc | 4 ++-- atom/renderer/api/atom_api_renderer_ipc.cc | 8 ++++---- vendor/node | 2 +- 8 files changed, 25 insertions(+), 21 deletions(-) diff --git a/atom/browser/api/atom_api_power_monitor.cc b/atom/browser/api/atom_api_power_monitor.cc index 093df2a1d4ef..31b35e10cea8 100644 --- a/atom/browser/api/atom_api_power_monitor.cc +++ b/atom/browser/api/atom_api_power_monitor.cc @@ -5,12 +5,11 @@ #include "atom/browser/api/atom_api_power_monitor.h" #include "atom/browser/browser.h" +#include "atom/common/node_includes.h" #include "base/power_monitor/power_monitor.h" #include "base/power_monitor/power_monitor_device_source.h" #include "native_mate/dictionary.h" -#include "atom/common/node_includes.h" - namespace atom { namespace api { @@ -41,9 +40,9 @@ void PowerMonitor::OnResume() { // static v8::Local PowerMonitor::Create(v8::Isolate* isolate) { if (!Browser::Get()->is_ready()) { - node::ThrowError( + isolate->ThrowException(v8::Exception::Error(mate::StringToV8( isolate, - "Cannot initialize \"power-monitor\" module before app is ready"); + "Cannot initialize \"power-monitor\" module before app is ready"))); return v8::Null(isolate); } diff --git a/atom/browser/api/atom_api_screen.cc b/atom/browser/api/atom_api_screen.cc index 9f81cf6eeff7..b73bda9ced84 100644 --- a/atom/browser/api/atom_api_screen.cc +++ b/atom/browser/api/atom_api_screen.cc @@ -113,14 +113,16 @@ mate::ObjectTemplateBuilder Screen::GetObjectTemplateBuilder( // static v8::Local Screen::Create(v8::Isolate* isolate) { if (!Browser::Get()->is_ready()) { - node::ThrowError(isolate, - "Cannot initialize \"screen\" module before app is ready"); + isolate->ThrowException(v8::Exception::Error(mate::StringToV8( + isolate, + "Cannot initialize \"screen\" module before app is ready"))); return v8::Null(isolate); } gfx::Screen* screen = gfx::Screen::GetNativeScreen(); if (!screen) { - node::ThrowError(isolate, "Failed to get screen information"); + isolate->ThrowException(v8::Exception::Error(mate::StringToV8( + isolate, "Failed to get screen information"))); return v8::Null(isolate); } diff --git a/atom/browser/api/atom_api_tray.cc b/atom/browser/api/atom_api_tray.cc index 1382f015a63b..90bcbcf3e2a7 100644 --- a/atom/browser/api/atom_api_tray.cc +++ b/atom/browser/api/atom_api_tray.cc @@ -35,7 +35,8 @@ Tray::~Tray() { // static mate::Wrappable* Tray::New(v8::Isolate* isolate, const gfx::Image& image) { if (!Browser::Get()->is_ready()) { - node::ThrowError(isolate, "Cannot create Tray before app is ready"); + isolate->ThrowException(v8::Exception::Error(mate::StringToV8( + isolate, "Cannot create Tray before app is ready"))); return nullptr; } return new Tray(image); diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index d22f7aab61fd..9cb52a1ec74d 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -717,17 +717,19 @@ void WebContents::PrintToPDF(const base::DictionaryValue& setting, PrintToPDF(setting, callback); } -void WebContents::AddWorkSpace(const base::FilePath& path) { +void WebContents::AddWorkSpace(mate::Arguments* args, + const base::FilePath& path) { if (path.empty()) { - node::ThrowError(isolate(), "path cannot be empty"); + args->ThrowError("path cannot be empty"); return; } DevToolsAddFileSystem(path); } -void WebContents::RemoveWorkSpace(const base::FilePath& path) { +void WebContents::RemoveWorkSpace(mate::Arguments* args, + const base::FilePath& path) { if (path.empty()) { - node::ThrowError(isolate(), "path cannot be empty"); + args->ThrowError("path cannot be empty"); return; } DevToolsRemoveFileSystem(path); diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index e2e405b73853..3c6bde9c24aa 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -87,8 +87,8 @@ class WebContents : public mate::TrackableObject, const PrintToPDFCallback& callback); // DevTools workspace api. - void AddWorkSpace(const base::FilePath& path); - void RemoveWorkSpace(const base::FilePath& path); + void AddWorkSpace(mate::Arguments* args, const base::FilePath& path); + void RemoveWorkSpace(mate::Arguments* args, const base::FilePath& path); // Editing commands. void Undo(); diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index e171fa7698f0..4acd101f3c98 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -209,8 +209,8 @@ void Window::OnExecuteWindowsCommand(const std::string& command_name) { mate::Wrappable* Window::New(v8::Isolate* isolate, const mate::Dictionary& options) { if (!Browser::Get()->is_ready()) { - node::ThrowError(isolate, - "Cannot create BrowserWindow before app is ready"); + isolate->ThrowException(v8::Exception::Error(mate::StringToV8( + isolate, "Cannot create BrowserWindow before app is ready"))); return nullptr; } return new Window(isolate, options); diff --git a/atom/renderer/api/atom_api_renderer_ipc.cc b/atom/renderer/api/atom_api_renderer_ipc.cc index d222f8f73b85..bd0b62656c1d 100644 --- a/atom/renderer/api/atom_api_renderer_ipc.cc +++ b/atom/renderer/api/atom_api_renderer_ipc.cc @@ -30,7 +30,7 @@ RenderView* GetCurrentRenderView() { return RenderView::FromWebView(view); } -void Send(v8::Isolate* isolate, +void Send(mate::Arguments* args, const base::string16& channel, const base::ListValue& arguments) { RenderView* render_view = GetCurrentRenderView(); @@ -41,10 +41,10 @@ void Send(v8::Isolate* isolate, render_view->GetRoutingID(), channel, arguments)); if (!success) - node::ThrowError(isolate, "Unable to send AtomViewHostMsg_Message"); + args->ThrowError("Unable to send AtomViewHostMsg_Message"); } -base::string16 SendSync(v8::Isolate* isolate, +base::string16 SendSync(mate::Arguments* args, const base::string16& channel, const base::ListValue& arguments) { base::string16 json; @@ -60,7 +60,7 @@ base::string16 SendSync(v8::Isolate* isolate, bool success = render_view->Send(message); if (!success) - node::ThrowError(isolate, "Unable to send AtomViewHostMsg_Message_Sync"); + args->ThrowError("Unable to send AtomViewHostMsg_Message_Sync"); return json; } diff --git a/vendor/node b/vendor/node index 5a8258dfabe7..c8962e460f3b 160000 --- a/vendor/node +++ b/vendor/node @@ -1 +1 @@ -Subproject commit 5a8258dfabe7ce3e1489b13d3459ef1d6260d6a5 +Subproject commit c8962e460f3bf03d405489a8380a5571730f5f8d From e365cb6b1c78fb0f9c78ff4f4c20766cca7bcf7a Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 7 Sep 2015 16:29:54 +0800 Subject: [PATCH 1161/1293] No longer needs to define node_includes.h at last --- atom/browser/api/atom_api_app.cc | 3 +-- atom/browser/api/atom_api_auto_updater.cc | 3 +-- atom/browser/api/atom_api_content_tracing.cc | 3 +-- atom/browser/api/atom_api_cookies.cc | 2 -- atom/browser/api/atom_api_power_save_blocker.cc | 2 +- atom/browser/api/atom_api_protocol.cc | 3 +-- atom/browser/api/atom_api_session.cc | 3 +-- atom/browser/api/atom_api_tray.cc | 3 +-- atom/browser/atom_browser_main_parts.cc | 3 +-- atom/common/api/atom_api_asar.cc | 3 +-- atom/common/api/atom_api_shell.cc | 3 +-- atom/common/api/atom_api_v8_util.cc | 3 +-- atom/common/api/event_emitter_caller.cc | 3 +-- atom/common/node_bindings.cc | 3 +-- atom/common/node_includes.h | 2 ++ atom/renderer/api/atom_api_renderer_ipc.cc | 3 +-- atom/renderer/atom_render_view_observer.cc | 3 +-- 17 files changed, 17 insertions(+), 31 deletions(-) diff --git a/atom/browser/api/atom_api_app.cc b/atom/browser/api/atom_api_app.cc index c25b3be5f4d6..e2d265c5da39 100644 --- a/atom/browser/api/atom_api_app.cc +++ b/atom/browser/api/atom_api_app.cc @@ -19,6 +19,7 @@ #include "atom/browser/api/atom_api_web_contents.h" #include "atom/common/native_mate_converters/callback.h" #include "atom/common/native_mate_converters/file_path_converter.h" +#include "atom/common/node_includes.h" #include "base/command_line.h" #include "base/environment.h" #include "base/files/file_path.h" @@ -34,8 +35,6 @@ #include "base/strings/utf_string_conversions.h" #endif -#include "atom/common/node_includes.h" - using atom::Browser; namespace mate { diff --git a/atom/browser/api/atom_api_auto_updater.cc b/atom/browser/api/atom_api_auto_updater.cc index 1691ac103e96..250aa3e45f64 100644 --- a/atom/browser/api/atom_api_auto_updater.cc +++ b/atom/browser/api/atom_api_auto_updater.cc @@ -7,11 +7,10 @@ #include "base/time/time.h" #include "atom/browser/auto_updater.h" #include "atom/browser/browser.h" +#include "atom/common/node_includes.h" #include "native_mate/dictionary.h" #include "native_mate/object_template_builder.h" -#include "atom/common/node_includes.h" - namespace atom { namespace api { diff --git a/atom/browser/api/atom_api_content_tracing.cc b/atom/browser/api/atom_api_content_tracing.cc index e4bf33c7b5c5..f29946d1f462 100644 --- a/atom/browser/api/atom_api_content_tracing.cc +++ b/atom/browser/api/atom_api_content_tracing.cc @@ -7,13 +7,12 @@ #include "atom/common/native_mate_converters/callback.h" #include "atom/common/native_mate_converters/file_path_converter.h" +#include "atom/common/node_includes.h" #include "base/bind.h" #include "base/files/file_util.h" #include "content/public/browser/tracing_controller.h" #include "native_mate/dictionary.h" -#include "atom/common/node_includes.h" - using content::TracingController; namespace mate { diff --git a/atom/browser/api/atom_api_cookies.cc b/atom/browser/api/atom_api_cookies.cc index bf56a8dc13bd..4f989eff7275 100644 --- a/atom/browser/api/atom_api_cookies.cc +++ b/atom/browser/api/atom_api_cookies.cc @@ -20,8 +20,6 @@ #include "net/url_request/url_request_context.h" #include "net/url_request/url_request_context_getter.h" -#include "atom/common/node_includes.h" - using atom::api::Cookies; using content::BrowserThread; diff --git a/atom/browser/api/atom_api_power_save_blocker.cc b/atom/browser/api/atom_api_power_save_blocker.cc index c75901cb1e31..58983e6c846a 100644 --- a/atom/browser/api/atom_api_power_save_blocker.cc +++ b/atom/browser/api/atom_api_power_save_blocker.cc @@ -6,9 +6,9 @@ #include +#include "atom/common/node_includes.h" #include "content/public/browser/power_save_blocker.h" #include "native_mate/dictionary.h" -#include "atom/common/node_includes.h" namespace mate { diff --git a/atom/browser/api/atom_api_protocol.cc b/atom/browser/api/atom_api_protocol.cc index f77f3229ed0a..661ab1b5cbdd 100644 --- a/atom/browser/api/atom_api_protocol.cc +++ b/atom/browser/api/atom_api_protocol.cc @@ -12,9 +12,8 @@ #include "atom/browser/net/url_request_fetch_job.h" #include "atom/browser/net/url_request_string_job.h" #include "atom/common/native_mate_converters/callback.h" -#include "native_mate/dictionary.h" - #include "atom/common/node_includes.h" +#include "native_mate/dictionary.h" using content::BrowserThread; diff --git a/atom/browser/api/atom_api_session.cc b/atom/browser/api/atom_api_session.cc index 7d31626c1413..f07ab8b78045 100644 --- a/atom/browser/api/atom_api_session.cc +++ b/atom/browser/api/atom_api_session.cc @@ -13,6 +13,7 @@ #include "atom/common/native_mate_converters/callback.h" #include "atom/common/native_mate_converters/gurl_converter.h" #include "atom/common/native_mate_converters/file_path_converter.h" +#include "atom/common/node_includes.h" #include "base/files/file_path.h" #include "base/prefs/pref_service.h" #include "base/strings/string_util.h" @@ -29,8 +30,6 @@ #include "net/url_request/url_request_context.h" #include "net/url_request/url_request_context_getter.h" -#include "atom/common/node_includes.h" - using content::BrowserThread; using content::StoragePartition; diff --git a/atom/browser/api/atom_api_tray.cc b/atom/browser/api/atom_api_tray.cc index 90bcbcf3e2a7..0f5829e19c14 100644 --- a/atom/browser/api/atom_api_tray.cc +++ b/atom/browser/api/atom_api_tray.cc @@ -12,13 +12,12 @@ #include "atom/common/native_mate_converters/gfx_converter.h" #include "atom/common/native_mate_converters/image_converter.h" #include "atom/common/native_mate_converters/string16_converter.h" +#include "atom/common/node_includes.h" #include "native_mate/constructor.h" #include "native_mate/dictionary.h" #include "ui/events/event_constants.h" #include "ui/gfx/image/image.h" -#include "atom/common/node_includes.h" - namespace atom { namespace api { diff --git a/atom/browser/atom_browser_main_parts.cc b/atom/browser/atom_browser_main_parts.cc index 31a490464143..61b98dfc40ec 100644 --- a/atom/browser/atom_browser_main_parts.cc +++ b/atom/browser/atom_browser_main_parts.cc @@ -13,6 +13,7 @@ #include "atom/browser/node_debugger.h" #include "atom/common/api/atom_bindings.h" #include "atom/common/node_bindings.h" +#include "atom/common/node_includes.h" #include "base/command_line.h" #include "base/thread_task_runner_handle.h" #include "chrome/browser/browser_process.h" @@ -22,8 +23,6 @@ #include "chrome/browser/ui/libgtk2ui/gtk2_util.h" #endif -#include "atom/common/node_includes.h" - namespace atom { // static diff --git a/atom/common/api/atom_api_asar.cc b/atom/common/api/atom_api_asar.cc index 24e9ce9b0668..4ea7d8c5c362 100644 --- a/atom/common/api/atom_api_asar.cc +++ b/atom/common/api/atom_api_asar.cc @@ -10,13 +10,12 @@ #include "atom/common/asar/archive.h" #include "atom/common/native_mate_converters/callback.h" #include "atom/common/native_mate_converters/file_path_converter.h" +#include "atom/common/node_includes.h" #include "native_mate/arguments.h" #include "native_mate/dictionary.h" #include "native_mate/object_template_builder.h" #include "native_mate/wrappable.h" -#include "atom/common/node_includes.h" - namespace { class Archive : public mate::Wrappable { diff --git a/atom/common/api/atom_api_shell.cc b/atom/common/api/atom_api_shell.cc index 013c5f5c6c84..a4599ee0c359 100644 --- a/atom/common/api/atom_api_shell.cc +++ b/atom/common/api/atom_api_shell.cc @@ -7,9 +7,8 @@ #include "atom/common/platform_util.h" #include "atom/common/native_mate_converters/file_path_converter.h" #include "atom/common/native_mate_converters/gurl_converter.h" -#include "native_mate/dictionary.h" - #include "atom/common/node_includes.h" +#include "native_mate/dictionary.h" namespace { diff --git a/atom/common/api/atom_api_v8_util.cc b/atom/common/api/atom_api_v8_util.cc index 21f23a97b456..bba3399a8dbd 100644 --- a/atom/common/api/atom_api_v8_util.cc +++ b/atom/common/api/atom_api_v8_util.cc @@ -3,11 +3,10 @@ // found in the LICENSE file. #include "atom/common/api/object_life_monitor.h" +#include "atom/common/node_includes.h" #include "native_mate/dictionary.h" #include "v8/include/v8-profiler.h" -#include "atom/common/node_includes.h" - namespace { v8::Local CreateObjectWithName(v8::Isolate* isolate, diff --git a/atom/common/api/event_emitter_caller.cc b/atom/common/api/event_emitter_caller.cc index 6b0a07ad414a..94eb9ce9e79a 100644 --- a/atom/common/api/event_emitter_caller.cc +++ b/atom/common/api/event_emitter_caller.cc @@ -5,11 +5,10 @@ #include "atom/common/api/event_emitter_caller.h" #include "atom/common/api/locker.h" +#include "atom/common/node_includes.h" #include "base/memory/scoped_ptr.h" #include "third_party/WebKit/public/web/WebScopedMicrotaskSuppression.h" -#include "atom/common/node_includes.h" - namespace mate { namespace internal { diff --git a/atom/common/node_bindings.cc b/atom/common/node_bindings.cc index 09666a470b6c..5aec200550ad 100644 --- a/atom/common/node_bindings.cc +++ b/atom/common/node_bindings.cc @@ -11,6 +11,7 @@ #include "atom/common/api/locker.h" #include "atom/common/atom_command_line.h" #include "atom/common/native_mate_converters/file_path_converter.h" +#include "atom/common/node_includes.h" #include "base/command_line.h" #include "base/base_paths.h" #include "base/files/file_path.h" @@ -21,8 +22,6 @@ #include "native_mate/dictionary.h" #include "third_party/WebKit/public/web/WebScopedMicrotaskSuppression.h" -#include "atom/common/node_includes.h" - using content::BrowserThread; // Force all builtin modules to be referenced so they can actually run their diff --git a/atom/common/node_includes.h b/atom/common/node_includes.h index 0c4189b2fac3..3876d8622913 100644 --- a/atom/common/node_includes.h +++ b/atom/common/node_includes.h @@ -5,6 +5,8 @@ #ifndef ATOM_COMMON_NODE_INCLUDES_H_ #define ATOM_COMMON_NODE_INCLUDES_H_ +#include "base/logging.h" + // Include common headers for using node APIs. #define BUILDING_NODE_EXTENSION diff --git a/atom/renderer/api/atom_api_renderer_ipc.cc b/atom/renderer/api/atom_api_renderer_ipc.cc index bd0b62656c1d..061293e80d03 100644 --- a/atom/renderer/api/atom_api_renderer_ipc.cc +++ b/atom/renderer/api/atom_api_renderer_ipc.cc @@ -5,13 +5,12 @@ #include "atom/common/api/api_messages.h" #include "atom/common/native_mate_converters/string16_converter.h" #include "atom/common/native_mate_converters/value_converter.h" +#include "atom/common/node_includes.h" #include "content/public/renderer/render_view.h" #include "native_mate/dictionary.h" #include "third_party/WebKit/public/web/WebLocalFrame.h" #include "third_party/WebKit/public/web/WebView.h" -#include "atom/common/node_includes.h" - using content::RenderView; using blink::WebLocalFrame; using blink::WebView; diff --git a/atom/renderer/atom_render_view_observer.cc b/atom/renderer/atom_render_view_observer.cc index 1f199ea445c6..456ca5ba4b24 100644 --- a/atom/renderer/atom_render_view_observer.cc +++ b/atom/renderer/atom_render_view_observer.cc @@ -13,6 +13,7 @@ #include "atom/common/api/api_messages.h" #include "atom/common/api/event_emitter_caller.h" #include "atom/common/native_mate_converters/value_converter.h" +#include "atom/common/node_includes.h" #include "atom/common/options_switches.h" #include "atom/renderer/atom_renderer_client.h" #include "base/command_line.h" @@ -31,8 +32,6 @@ #include "third_party/WebKit/public/web/WebView.h" #include "ui/base/resource/resource_bundle.h" -#include "atom/common/node_includes.h" - namespace atom { namespace { From 13722e26cd7e9c44380299b063fb7ad5bdb3081b Mon Sep 17 00:00:00 2001 From: John-Lin Date: Mon, 7 Sep 2015 17:36:14 +0800 Subject: [PATCH 1162/1293] add doc translation for power-monitor.md --- docs-translations/zh-TW/api/power-monitor.md | 36 ++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 docs-translations/zh-TW/api/power-monitor.md diff --git a/docs-translations/zh-TW/api/power-monitor.md b/docs-translations/zh-TW/api/power-monitor.md new file mode 100644 index 000000000000..e38dee3212da --- /dev/null +++ b/docs-translations/zh-TW/api/power-monitor.md @@ -0,0 +1,36 @@ +# power-monitor + +`power-monitor` 模組用來監看電源狀態的改變。你只能在主行程 (main process) 裡面使用。 +你應該要等到 `ready` 在 `app` 模組裡的事件被觸發 (emit)，再使用這個模組。 + +舉例來說: + +```javascript +var app = require('app'); + +app.on('ready', function() { + require('power-monitor').on('suspend', function() { + console.log('The system is going to sleep'); + }); +}); +``` + +## 事件 (Events) + +`power-monitor` 模組會觸發 (emits) 以下幾個事件: + +### 事件: 'suspend' + +當系統進入 睡眠 (suspend) 時觸發。 + +### 事件: 'resume' + +當系統 resume 時觸發。 + +### 事件: 'on-ac' + +當系統改變使用交流電源 (AC) 時觸發。 + +### 事件: 'on-battery' + +當系統改變使用電池店員時觸發。 From 66f7f2e6f28c566edb86ea84c1be46deef78cffa Mon Sep 17 00:00:00 2001 From: John-Lin Date: Mon, 7 Sep 2015 17:36:33 +0800 Subject: [PATCH 1163/1293] add doc translation for power-save-blocker.md --- .../zh-TW/api/power-save-blocker.md | 47 +++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 docs-translations/zh-TW/api/power-save-blocker.md diff --git a/docs-translations/zh-TW/api/power-save-blocker.md b/docs-translations/zh-TW/api/power-save-blocker.md new file mode 100644 index 000000000000..a652751c0bb8 --- /dev/null +++ b/docs-translations/zh-TW/api/power-save-blocker.md @@ -0,0 +1,47 @@ +# powerSaveBlocker + +`power-save-blocker` 模組是用來防止系統進入省電模式 low-power (sleep) mode +因此讓應用程式可以保持系統和螢幕的活躍 (active)。 + +舉例來說: + +```javascript +var powerSaveBlocker = require('power-save-blocker'); + +var id = powerSaveBlocker.start('prevent-display-sleep'); +console.log(powerSaveBlocker.isStarted(id)); + +powerSaveBlocker.stop(id); +``` + +## 方法 (Methods) + +`power-save-blocker` 模組有以下幾個方法: + +### `powerSaveBlocker.start(type)` + +* `type` String - Power save blocker type. + * `prevent-app-suspension` - 防止一個應用程式進入睡眠 (suspended)。 將保持系統活躍， + 但允許螢幕被關閉。 使用案例：下載一個檔案或是播放音樂。 + * `prevent-display-sleep`- 防止螢幕進入睡眠。將保持系統和螢幕的活躍。 + 使用案例：播放影片 + +當防止系統進入省電模式 low-power (sleep) mode 。 會回傳一個識別的整數來代表 power save blocker + +**注意:** `prevent-display-sleep` 比 `prevent-app-suspension` 擁有較高的優先權。 +只有高的優先全力才會有效，換句話說 `prevent-display-sleep` 總是會優先於 `prevent-app-suspension` + +例如，一個 API 呼叫 A 請求去做 `prevent-app-suspension`，而另外一個 B 請求去做 `prevent-display-sleep` + `prevent-display-sleep` 將會被使用，直到 B 停止他的請求，`prevent-app-suspension` 才會被使用。 + +### `powerSaveBlocker.stop(id)` + +* `id` Integer - power save blocker 會回傳 id 透過 `powerSaveBlocker.start`. + +將指定的 id 停止 power save blocker + +### `powerSaveBlocker.isStarted(id)` + +* `id` Integer - power save blocker 會回傳 id 透過 `powerSaveBlocker.start`. + +不管對應的 `powerSaveBlocker` 是否已經啟動，將會回傳一個布林值 (boolean) From d7ec0b99fdf37463599109dea7c78a01fe775125 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 7 Sep 2015 21:07:27 +0800 Subject: [PATCH 1164/1293] spec: process.stdout should not throw exception --- spec/node-spec.coffee | 4 ++++ spec/static/main.js | 5 +++++ 2 files changed, 9 insertions(+) diff --git a/spec/node-spec.coffee b/spec/node-spec.coffee index 5ec2bb05e906..164480603e0f 100644 --- a/spec/node-spec.coffee +++ b/spec/node-spec.coffee @@ -133,3 +133,7 @@ describe 'node feature', -> b = new Buffer(p.innerText) assert.equal b.toString(), 'Jøhänñéß' assert.equal Buffer.byteLength(p.innerText), 13 + + describe 'process.stdout', -> + it 'should not throw exception', -> + process.stdout diff --git a/spec/static/main.js b/spec/static/main.js index d8b53167c5e2..1f6f9325e490 100644 --- a/spec/static/main.js +++ b/spec/static/main.js @@ -10,6 +10,11 @@ process.port = 0; // will be used by crash-reporter spec. app.commandLine.appendSwitch('js-flags', '--expose_gc'); app.commandLine.appendSwitch('ignore-certificate-errors'); +// Accessing stdout in the main process will result in the process.stdout +// throwing UnknownSystemError in renderer process sometimes. This line makes +// sure we can reproduce it in renderer process. +process.stdout; + ipc.on('message', function(event, arg) { event.sender.send('message', arg); }); From 8912b404a9399c8fc7d8eccdf64aef1a3f5e6ea3 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 7 Sep 2015 21:34:15 +0800 Subject: [PATCH 1165/1293] spec: process.stdout should have isTTY defined --- spec/node-spec.coffee | 3 +++ 1 file changed, 3 insertions(+) diff --git a/spec/node-spec.coffee b/spec/node-spec.coffee index 164480603e0f..d7c3b068f4b6 100644 --- a/spec/node-spec.coffee +++ b/spec/node-spec.coffee @@ -137,3 +137,6 @@ describe 'node feature', -> describe 'process.stdout', -> it 'should not throw exception', -> process.stdout + + it 'should have isTTY defined', -> + assert.equal typeof(process.stdout.isTTY), 'boolean' From d4aa2308cd91fa822e6c3ee6900df76c6ad81c0b Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 7 Sep 2015 21:34:27 +0800 Subject: [PATCH 1166/1293] Update node to catch exception when accessing process.stdout --- vendor/node | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/node b/vendor/node index c8962e460f3b..9da7dd871c31 160000 --- a/vendor/node +++ b/vendor/node @@ -1 +1 @@ -Subproject commit c8962e460f3bf03d405489a8380a5571730f5f8d +Subproject commit 9da7dd871c313d318bc1447a83ba3c7618bbbc18 From 4412a89270ce0b7582c410e61a9d69fd8f3b65c5 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 7 Sep 2015 21:44:03 +0800 Subject: [PATCH 1167/1293] Explicitly writes debug log to stderr If we don't do this Chromium will close stdout and stderr for us, resulting process.stdout not working. --- atom/app/atom_main_delegate.cc | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/atom/app/atom_main_delegate.cc b/atom/app/atom_main_delegate.cc index 02dd11c81ba0..3c7d6b2e7034 100644 --- a/atom/app/atom_main_delegate.cc +++ b/atom/app/atom_main_delegate.cc @@ -38,7 +38,9 @@ bool AtomMainDelegate::BasicStartupComplete(int* exit_code) { #else settings.logging_dest = logging::LOG_TO_SYSTEM_DEBUG_LOG; #endif // defined(DEBUG) -#endif // defined(OS_WIN) +#else // defined(OS_WIN) + settings.logging_dest = logging::LOG_TO_SYSTEM_DEBUG_LOG; +#endif // !defined(OS_WIN) logging::InitLogging(settings); // Logging with pid and timestamp. From 62b1034c6be9a0590d3cea8978927e67650b0a08 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 7 Sep 2015 22:42:46 +0800 Subject: [PATCH 1168/1293] Suppress the isTTY spec, not reliable on some machines --- spec/node-spec.coffee | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/spec/node-spec.coffee b/spec/node-spec.coffee index d7c3b068f4b6..94174c38b743 100644 --- a/spec/node-spec.coffee +++ b/spec/node-spec.coffee @@ -138,5 +138,6 @@ describe 'node feature', -> it 'should not throw exception', -> process.stdout - it 'should have isTTY defined', -> + # Not reliable on some machines + xit 'should have isTTY defined', -> assert.equal typeof(process.stdout.isTTY), 'boolean' From ad6e67fdfa8bb5443420d27cf42d80ec317b3e81 Mon Sep 17 00:00:00 2001 From: Eran Tiktin Date: Mon, 7 Sep 2015 19:51:28 +0300 Subject: [PATCH 1169/1293] Revert "Add chrome_version.h to gitignore" This reverts commit 41e1555cf4cd223024a38bbe70b2b71a395f102d. --- .gitignore | 1 - 1 file changed, 1 deletion(-) diff --git a/.gitignore b/.gitignore index dc7a879cc8aa..0c6f4cb79dd0 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,4 @@ .DS_Store -/atom/common/chrome_version.h /build/ /dist/ /external_binaries/ From b521e45ef886bd04adf2860898a8a0f1e5784a55 Mon Sep 17 00:00:00 2001 From: Eran Tiktin Date: Mon, 7 Sep 2015 19:51:37 +0300 Subject: [PATCH 1170/1293] Revert "Remove chrome_version.h from git" This reverts commit dcbd8316dfd4ff465b044f51c77a4ba4d7c7f0f3. --- atom/common/chrome_version.h | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 atom/common/chrome_version.h diff --git a/atom/common/chrome_version.h b/atom/common/chrome_version.h new file mode 100644 index 000000000000..250051683786 --- /dev/null +++ b/atom/common/chrome_version.h @@ -0,0 +1,14 @@ +// Copyright (c) 2014 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +// This file is generated by script/bootstrap.py, you should never modify it +// by hand. + +#ifndef ATOM_COMMON_CHROME_VERSION_H_ +#define ATOM_COMMON_CHROME_VERSION_H_ + +#define CHROME_VERSION_STRING "45.0.2454.85" +#define CHROME_VERSION "v" CHROME_VERSION_STRING + +#endif // ATOM_COMMON_CHROME_VERSION_H_ From db3e27ceaab98dd7602f8f619eda8ca7df8a3571 Mon Sep 17 00:00:00 2001 From: Eran Tiktin Date: Mon, 7 Sep 2015 21:55:02 +0300 Subject: [PATCH 1171/1293] Fix `create_chrome_version_h` in bootstrap.py The code was supposed to compare the content of the existing file with the new content and only replace the file if the content was different, but it had a fatal flow. It opened the existing file with 'w+' or 'wb+' and they both truncate the file, so the compare was always false and we always overwrote the file. The updated code compares the file content ignoring line endings and writes the file only if its different or if it didn't exist. --- script/bootstrap.py | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/script/bootstrap.py b/script/bootstrap.py index 293d3dc2dd10..d5ad41a61c59 100755 --- a/script/bootstrap.py +++ b/script/bootstrap.py @@ -162,13 +162,16 @@ def create_chrome_version_h(): version = f.read() with open(template_file, 'r') as f: template = f.read() - if sys.platform in ['win32', 'cygwin']: - open_mode = 'wb+' - else: - open_mode = 'w+' - with open(target_file, open_mode) as f: - content = template.replace('{PLACEHOLDER}', version.strip()) - if f.read() != content: + content = template.replace('{PLACEHOLDER}', version.strip()) + + # We update the file only if the content has changed (ignoring line ending + # differences). + should_write = True + if os.path.isfile(target_file): + with open(target_file, 'r') as f: + should_write = f.read().replace('r', '') != content.replace('r', '') + if should_write: + with open(target_file, 'w') as f: f.write(content) From 1e0facc103b25a26dcdec294e5b0c87dae37389e Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Tue, 8 Sep 2015 08:42:28 +0900 Subject: [PATCH 1172/1293] Update as upstream --- docs-translations/ko/api/web-view-tag.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs-translations/ko/api/web-view-tag.md b/docs-translations/ko/api/web-view-tag.md index e292e972dcd2..b4af6d3ea87f 100644 --- a/docs-translations/ko/api/web-view-tag.md +++ b/docs-translations/ko/api/web-view-tag.md @@ -125,14 +125,14 @@ ``` -`webview`에서 사용하는 스토리지 파티션을 지정합니다. -스토리지 파티션 ID를 `persist:`로 시작하도록 지정하면 앱의 모든 `webview`에서 지정한 스토리지 파티션 ID를 사용하도록 할 수 있습니다. -만약 `persist:` 접두사가 없을 경우 `webview`는 인 메모리 스토리지 파티션을 사용합니다. -여러 `webview`에서 같은 파티션 ID를 사용하면 같은 스토리지 파티션을 공유합니다. -만약 스토리지 파티션 ID가 지정되지 않으면 앱의 기본 스토리지를 사용합니다. +페이지에서 사용하는 세션을 설정합니다. +만약 `partition` 속성이 `persist:` 접두사를 시작하면 같은 `partition` 속성을 가진 앱 내 모든 페이지가 공유하는 영구 세션을 사용합니다. +`persist:` 접두사가 없을 경우 페이지는 인 메모리 세션을 사용합니다. +동일한 `partition`을 지정하여 다중 페이지에서 동일한 세션을 공유할 수 있도록 할 수 있습니다. +만약 `partition`이 지정되지 않으면 앱의 기본 세션을 사용합니다. 이 값은 첫 탐색 이전에만 지정할 수 있습니다. -즉. 작동중인 랜더러 프로세스의 스토리지 파티션은 변경할 수 없습니다. +즉. 작동중인 랜더러 프로세스의 세션은 변경할 수 없습니다. 이후 이 값을 바꾸려고 시도하면 DOM 예외를 발생시킵니다. ## Methods From 21bd5789352be761a47702045431698ee4b1edd9 Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Tue, 8 Sep 2015 08:50:59 +0900 Subject: [PATCH 1173/1293] Update README-ko.md --- README-ko.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README-ko.md b/README-ko.md index 29ac5a0951f0..9ce6748fc871 100644 --- a/README-ko.md +++ b/README-ko.md @@ -13,6 +13,8 @@ Electron 프레임워크는 JavaScript, HTML 그리고 CSS를 사용하여 Cross Electron에 대한 중요한 알림을 받고 싶다면 Twitter에서 [@ElectronJS](https://twitter.com/electronjs)를 팔로우 하세요. +이 프로젝트는 기여자 규약 1.2를 준수합니다. 이 프로젝트에 참여할 때 코드를 유지해야 합니다. 받아들일 수 없는 행동은 atom@github.com로 보고 하십시오. + ## 다운로드 Linux, Windows, Mac용으로 미리 빌드된 Electron 바이너리와 디버그 심볼이 준비되어 있습니다. [releases](https://github.com/atom/electron/releases) 페이지에서 받아 볼 수 있습니다. From 785eb9657b32c08f4f4ddd5a33cb006854ff4285 Mon Sep 17 00:00:00 2001 From: Robo Date: Tue, 8 Sep 2015 05:24:07 +0530 Subject: [PATCH 1174/1293] remove unused code --- atom/browser/web_view_constants.cc | 24 ---------------------- atom/browser/web_view_constants.h | 27 ------------------------- atom/browser/web_view_guest_delegate.cc | 10 +++++++-- filenames.gypi | 2 -- 4 files changed, 8 insertions(+), 55 deletions(-) delete mode 100644 atom/browser/web_view_constants.cc delete mode 100644 atom/browser/web_view_constants.h diff --git a/atom/browser/web_view_constants.cc b/atom/browser/web_view_constants.cc deleted file mode 100644 index 6f8314cbcf36..000000000000 --- a/atom/browser/web_view_constants.cc +++ /dev/null @@ -1,24 +0,0 @@ -// Copyright (c) 2015 GitHub, Inc. -// Use of this source code is governed by the MIT license that can be -// found in the LICENSE file. - -#include "atom/browser/web_view_constants.h" - -namespace atom { - -namespace web_view { - -const char kPreloadUrl[] = "preloadUrl"; -const char kNodeIntegration[] = "nodeIntegration"; -const char kPlugins[] = "plugins"; -const char kDisableWebSecurity[] = "disableWebSecurity"; -const char kPartitionId[] = "partitionId"; - -const int kDefaultWidth = 300; -const int kDefaultHeight = 300; - -const char kWebViewInfoKeyName[] = "web_view_info"; - -} // namespace web_view - -} // namespace atom diff --git a/atom/browser/web_view_constants.h b/atom/browser/web_view_constants.h deleted file mode 100644 index 0831bdbdf1d4..000000000000 --- a/atom/browser/web_view_constants.h +++ /dev/null @@ -1,27 +0,0 @@ -// Copyright (c) 2015 GitHub, Inc. -// Use of this source code is governed by the MIT license that can be -// found in the LICENSE file. - -#ifndef ATOM_BROWSER_WEB_VIEW_CONSTANTS_H_ -#define ATOM_BROWSER_WEB_VIEW_CONSTANTS_H_ - -namespace atom { - -namespace web_view { - -extern const char kPreloadUrl[]; -extern const char kNodeIntegration[]; -extern const char kPlugins[]; -extern const char kDisableWebSecurity[]; -extern const char kPartitionId[]; - -extern const int kDefaultWidth; -extern const int kDefaultHeight; - -extern const char kWebViewInfoKeyName[]; - -} // namespace web_view - -} // namespace atom - -#endif // ATOM_BROWSER_WEB_VIEW_CONSTANTS_H_ diff --git a/atom/browser/web_view_guest_delegate.cc b/atom/browser/web_view_guest_delegate.cc index a954cea8dc02..8e1810c4a39b 100644 --- a/atom/browser/web_view_guest_delegate.cc +++ b/atom/browser/web_view_guest_delegate.cc @@ -5,7 +5,6 @@ #include "atom/browser/web_view_guest_delegate.h" #include "atom/browser/api/atom_api_web_contents.h" -#include "atom/browser/web_view_constants.h" #include "atom/common/native_mate_converters/gurl_converter.h" #include "content/public/browser/guest_host.h" #include "content/public/browser/render_frame_host.h" @@ -14,6 +13,13 @@ namespace atom { +namespace { + +const int kDefaultWidth = 300; +const int kDefaultHeight = 300; + +} // namespace + WebViewGuestDelegate::WebViewGuestDelegate() : guest_opaque_(true), guest_host_(nullptr), @@ -172,7 +178,7 @@ gfx::Size WebViewGuestDelegate::GetDefaultSize() const { return embedder_web_contents_->GetRenderWidgetHostView() ->GetVisibleViewportSize(); } else { - return gfx::Size(web_view::kDefaultWidth, web_view::kDefaultHeight); + return gfx::Size(kDefaultWidth, kDefaultHeight); } } diff --git a/filenames.gypi b/filenames.gypi index 78a8e17f2f99..461c812753c9 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -230,8 +230,6 @@ 'atom/browser/web_contents_preferences.h', 'atom/browser/web_dialog_helper.cc', 'atom/browser/web_dialog_helper.h', - 'atom/browser/web_view_constants.cc', - 'atom/browser/web_view_constants.h', 'atom/browser/web_view_guest_delegate.cc', 'atom/browser/web_view_guest_delegate.h', 'atom/browser/web_view_manager.cc', From e5386cf8eaa05d29113df42ac7d0885aac140ca4 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 8 Sep 2015 13:40:10 +0800 Subject: [PATCH 1175/1293] Bump v0.32.0 --- atom.gyp | 2 +- atom/browser/resources/mac/Info.plist | 2 +- atom/browser/resources/win/atom.rc | 8 ++++---- atom/common/atom_version.h | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/atom.gyp b/atom.gyp index c0fc40187984..547bc3c38af5 100644 --- a/atom.gyp +++ b/atom.gyp @@ -4,7 +4,7 @@ 'product_name%': 'Electron', 'company_name%': 'GitHub, Inc', 'company_abbr%': 'github', - 'version%': '0.31.2', + 'version%': '0.32.0', }, 'includes': [ 'filenames.gypi', diff --git a/atom/browser/resources/mac/Info.plist b/atom/browser/resources/mac/Info.plist index 73facdc7f565..884cdcd1a1ea 100644 --- a/atom/browser/resources/mac/Info.plist +++ b/atom/browser/resources/mac/Info.plist @@ -17,7 +17,7 @@ CFBundleIconFile atom.icns CFBundleVersion - 0.31.2 + 0.32.0 LSMinimumSystemVersion 10.8.0 NSMainNibFile diff --git a/atom/browser/resources/win/atom.rc b/atom/browser/resources/win/atom.rc index 7e7fea9f2fb3..16c7f0311f89 100644 --- a/atom/browser/resources/win/atom.rc +++ b/atom/browser/resources/win/atom.rc @@ -56,8 +56,8 @@ END // VS_VERSION_INFO VERSIONINFO - FILEVERSION 0,31,2,0 - PRODUCTVERSION 0,31,2,0 + FILEVERSION 0,32,0,0 + PRODUCTVERSION 0,32,0,0 FILEFLAGSMASK 0x3fL #ifdef _DEBUG FILEFLAGS 0x1L @@ -74,12 +74,12 @@ BEGIN BEGIN VALUE "CompanyName", "GitHub, Inc." VALUE "FileDescription", "Electron" - VALUE "FileVersion", "0.31.2" + VALUE "FileVersion", "0.32.0" VALUE "InternalName", "electron.exe" VALUE "LegalCopyright", "Copyright (C) 2015 GitHub, Inc. All rights reserved." VALUE "OriginalFilename", "electron.exe" VALUE "ProductName", "Electron" - VALUE "ProductVersion", "0.31.2" + VALUE "ProductVersion", "0.32.0" VALUE "SquirrelAwareVersion", "1" END END diff --git a/atom/common/atom_version.h b/atom/common/atom_version.h index a0b865b0e2a6..e270498e40bf 100644 --- a/atom/common/atom_version.h +++ b/atom/common/atom_version.h @@ -6,8 +6,8 @@ #define ATOM_VERSION_H #define ATOM_MAJOR_VERSION 0 -#define ATOM_MINOR_VERSION 31 -#define ATOM_PATCH_VERSION 2 +#define ATOM_MINOR_VERSION 32 +#define ATOM_PATCH_VERSION 0 #define ATOM_VERSION_IS_RELEASE 1 From 8e1979a6a503a440029449508d19f7f21b067330 Mon Sep 17 00:00:00 2001 From: John-Lin Date: Tue, 8 Sep 2015 15:46:48 +0800 Subject: [PATCH 1176/1293] add doc translation for file object --- docs-translations/zh-TW/api/file-object.md | 28 ++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 docs-translations/zh-TW/api/file-object.md diff --git a/docs-translations/zh-TW/api/file-object.md b/docs-translations/zh-TW/api/file-object.md new file mode 100644 index 000000000000..4f523c489516 --- /dev/null +++ b/docs-translations/zh-TW/api/file-object.md @@ -0,0 +1,28 @@ +# `File` object + +DOM's File 介面提供一個將本地文件抽象化，並可以讓使用者對本地文件直接使用 HTML5 檔案 API +Electron 可以添加一個 `path` 屬性至 `File` 接口進而顯示檔案在檔案系統內的真實路徑。 + +範例，獲得一個檔案之真實路徑，將檔案拖拉至應用程式 (dragged-onto-the-app): + +```html +
+ Drag your file here +
+ + +``` From ba02e19fae3d413754e3eb9bce4255314a8eda42 Mon Sep 17 00:00:00 2001 From: John-Lin Date: Tue, 8 Sep 2015 15:47:11 +0800 Subject: [PATCH 1177/1293] add doc translation for process --- docs-translations/zh-TW/api/process.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 docs-translations/zh-TW/api/process.md diff --git a/docs-translations/zh-TW/api/process.md b/docs-translations/zh-TW/api/process.md new file mode 100644 index 000000000000..a4f45352b9c4 --- /dev/null +++ b/docs-translations/zh-TW/api/process.md @@ -0,0 +1,23 @@ +# process + +在 Electron 裡的 `process` 物件具有以下幾個與 upstream node 的不同點: + +* `process.type` String - Process 的型態，可以是 `browser` (i.e. 主行程) 或 `renderer`. +* `process.versions['electron']` String - Electron 的版本 +* `process.versions['chrome']` String - Chromium 的版本 +* `process.resourcesPath` String - JavaScript 源碼的路徑 + +# 方法 (Methods) + +`process` 物件具有以下的方法: + +### `process.hang` + +會導致目前行程的主執行緒停住 + +## process.setFdLimit(maxDescriptors) _OS X_ _Linux_ + +* `maxDescriptors` Integer + +設置文件描述符 (file descriptor) soft limit `maxDescriptors` 或 OS hard +limit ，以較低者為準當目前的行程。 From a2007189447e908088e0488d67c3eecbd5fe736b Mon Sep 17 00:00:00 2001 From: John-Lin Date: Tue, 8 Sep 2015 15:47:29 +0800 Subject: [PATCH 1178/1293] add doc translation for synopsis --- docs-translations/zh-TW/api/synopsis.md | 41 +++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 docs-translations/zh-TW/api/synopsis.md diff --git a/docs-translations/zh-TW/api/synopsis.md b/docs-translations/zh-TW/api/synopsis.md new file mode 100644 index 000000000000..484f5e353847 --- /dev/null +++ b/docs-translations/zh-TW/api/synopsis.md @@ -0,0 +1,41 @@ +# Synopsis + +所有的 [Node.js's 內建模組](http://nodejs.org/api/) 都可以在 Electron 使用，而且 +第三方的 node 模組同樣的全部支援（包含[原生模組](../tutorial/using-native-node-modules.md)） + +Electron 也提供一些額外的內建模組用來開發原生桌面應用程式，一些模組只可以使用在主行程上 +(main process) 一些只可以使用在渲染行程 (renderer process) 上 (網頁) ，另外還有一些 +模組在兩邊的行程都可以使用。 + +基本的規則是: 如果一個模組是 [GUI](https://zh.wikipedia.org/wiki/%E5%9B%BE%E5%BD%A2%E7%94%A8%E6%88%B7%E7%95%8C%E9%9D%A2) +或者是 low-level 與系統相關的，那麼它就應該只能在主行程上使用 (main process) 你必須要對熟悉 [main process vs. renderer process](../tutorial/quick-start.md#the-main-process) 的觀念，才能去使用這些模組。 + +主行程 (main process) 腳本是一個像一般 Node.js 的腳本: + +```javascript +var app = require('app'); +var BrowserWindow = require('browser-window'); + +var window = null; + +app.on('ready', function() { + window = new BrowserWindow({width: 800, height: 600}); + window.loadUrl('https://github.com'); +}); +``` + +渲染行程 (renderer process) 跟一般正常的網頁沒有差別，而且還能有使用 node 模組的能力: + +```html + + + + + + +``` + +執行你的應用程式，請閱讀[Run your app](../tutorial/quick-start.md#run-your-app). From 375ac3e6ec6f925d8cd0959317317d0ba5b1e69d Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 9 Sep 2015 13:35:07 +0800 Subject: [PATCH 1179/1293] Update brightray, fixes #2669 --- vendor/brightray | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/brightray b/vendor/brightray index 8d64120b51b4..9b3695cfd5c4 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit 8d64120b51b48be46eaa419957b965c0ccfc6c8f +Subproject commit 9b3695cfd5c48a4cdc90e84a863851001ce8dd10 From 446235c8cdfc979d5cc8917000288ca2f252f745 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 9 Sep 2015 15:55:26 +0800 Subject: [PATCH 1180/1293] Fix backward compatibility with old BrowserWindow options --- atom/browser/api/atom_api_window.cc | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index 4acd101f3c98..7403a7ecbb77 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -70,14 +70,13 @@ Window::Window(v8::Isolate* isolate, const mate::Dictionary& options) { options.Get(switches::kWebPreferences, &web_preferences); // Be compatible with old options which are now in web_preferences. - std::string str; - double d; - if (options.Get(switches::kNodeIntegration, &str)) - web_preferences.Set(switches::kNodeIntegration, str); - if (options.Get(switches::kPreloadScript, &str)) - web_preferences.Set(switches::kPreloadScript, str); - if (options.Get(switches::kZoomFactor, &d)) - web_preferences.Set(switches::kZoomFactor, d); + v8::Local value; + if (options.Get(switches::kNodeIntegration, &value)) + web_preferences.Set(switches::kNodeIntegration, value); + if (options.Get(switches::kPreloadScript, &value)) + web_preferences.Set(switches::kPreloadScript, value); + if (options.Get(switches::kZoomFactor, &value)) + web_preferences.Set(switches::kZoomFactor, value); // Creates the WebContents used by BrowserWindow. auto web_contents = WebContents::Create(isolate, web_preferences); From c2b2a2072fb87bf2701a101c14cf887ba84fb2cd Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 9 Sep 2015 16:11:45 +0800 Subject: [PATCH 1181/1293] spec: Set node-integration in window.open should work --- spec/chromium-spec.coffee | 19 +++++++++++++++---- spec/fixtures/pages/window-opener-node.html | 7 +++++++ 2 files changed, 22 insertions(+), 4 deletions(-) create mode 100644 spec/fixtures/pages/window-opener-node.html diff --git a/spec/chromium-spec.coffee b/spec/chromium-spec.coffee index c594a97f3b83..d09a021db9f9 100644 --- a/spec/chromium-spec.coffee +++ b/spec/chromium-spec.coffee @@ -36,11 +36,20 @@ describe 'chromium feature', -> describe 'window.open', -> it 'returns a BrowserWindowProxy object', -> - b = window.open 'about:blank', 'test', 'show=no' + b = window.open 'about:blank', '', 'show=no' assert.equal b.closed, false assert.equal b.constructor.name, 'BrowserWindowProxy' b.close() + it 'accepts "node-integration" as feature', (done) -> + listener = (event) -> + window.removeEventListener 'message', listener + b.close() + assert.equal event.data, 'undefined' + done() + window.addEventListener 'message', listener + b = window.open "file://#{fixtures}/pages/window-opener-node.html", '', 'node-integration=no,show=no' + describe 'window.opener', -> ipc = remote.require 'ipc' url = "file://#{fixtures}/pages/window-opener.html" @@ -58,19 +67,21 @@ describe 'chromium feature', -> w.loadUrl url it 'is not null for window opened by window.open', (done) -> - b = window.open url, 'test2', 'show=no' + b = window.open url, '', 'show=no' ipc.on 'opener', (event, opener) -> b.close() done(if opener isnt null then undefined else opener) describe 'window.opener.postMessage', -> it 'sets source and origin correctly', (done) -> - b = window.open "file://#{fixtures}/pages/window-opener-postMessage.html", 'test', 'show=no' - window.addEventListener 'message', (event) -> + listener = (event) -> + window.removeEventListener 'message', listener b.close() assert.equal event.source.guestId, b.guestId assert.equal event.origin, 'file://' done() + window.addEventListener 'message', listener + b = window.open "file://#{fixtures}/pages/window-opener-postMessage.html", '', 'show=no' describe 'creating a Uint8Array under browser side', -> it 'does not crash', -> diff --git a/spec/fixtures/pages/window-opener-node.html b/spec/fixtures/pages/window-opener-node.html new file mode 100644 index 000000000000..118603c82d3b --- /dev/null +++ b/spec/fixtures/pages/window-opener-node.html @@ -0,0 +1,7 @@ + + + + + From e48f5ea1aabb1fbf091c9d76d78e5e8f1a8cfbab Mon Sep 17 00:00:00 2001 From: Destan Sarpkaya Date: Wed, 9 Sep 2015 14:06:33 +0300 Subject: [PATCH 1182/1293] update broken link --- docs/api/ipc-main-process.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/ipc-main-process.md b/docs/api/ipc-main-process.md index bbb581fcfc9b..41d4d7125365 100644 --- a/docs/api/ipc-main-process.md +++ b/docs/api/ipc-main-process.md @@ -7,7 +7,7 @@ a renderer will be emitted to this module. ## Sending Messages It is also possible to send messages from the main process to the renderer -process, see [WebContents.send](browser-window.md#webcontentssendchannel-args) +process, see [WebContents.send](browser-window.md#webcontents-send-channel-args) for more information. - When sending a message, the event name is the `channel`. From 9d51da505e24c97332159fe077bf35cd3642fc0b Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 9 Sep 2015 19:27:08 +0800 Subject: [PATCH 1183/1293] Run destruction callbacks before message loop gets destroyed --- atom/browser/atom_browser_main_parts.cc | 12 ++++++++++-- atom/browser/atom_browser_main_parts.h | 1 + 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/atom/browser/atom_browser_main_parts.cc b/atom/browser/atom_browser_main_parts.cc index 61b98dfc40ec..a1a1192b2768 100644 --- a/atom/browser/atom_browser_main_parts.cc +++ b/atom/browser/atom_browser_main_parts.cc @@ -39,8 +39,6 @@ AtomBrowserMainParts::AtomBrowserMainParts() } AtomBrowserMainParts::~AtomBrowserMainParts() { - for (const auto& callback : destruction_callbacks_) - callback.Run(); } // static @@ -118,4 +116,14 @@ void AtomBrowserMainParts::PreMainMessageLoopRun() { #endif } +void AtomBrowserMainParts::PostMainMessageLoopRun() { + brightray::BrowserMainParts::PostMainMessageLoopRun(); + + // Make sure destruction callbacks are called before message loop is + // destroyed, otherwise some objects that need to be deleted on IO thread + // won't be freed. + for (const auto& callback : destruction_callbacks_) + callback.Run(); +} + } // namespace atom diff --git a/atom/browser/atom_browser_main_parts.h b/atom/browser/atom_browser_main_parts.h index 59ff7c977c82..bcebc86f16ca 100644 --- a/atom/browser/atom_browser_main_parts.h +++ b/atom/browser/atom_browser_main_parts.h @@ -41,6 +41,7 @@ class AtomBrowserMainParts : public brightray::BrowserMainParts { // content::BrowserMainParts: void PostEarlyInitialization() override; void PreMainMessageLoopRun() override; + void PostMainMessageLoopRun() override; #if defined(OS_MACOSX) void PreMainMessageLoopStart() override; void PostDestroyThreads() override; From 93bbc0bca9fbb6d8290e900e1f82d5619c0bbff4 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 9 Sep 2015 19:27:28 +0800 Subject: [PATCH 1184/1293] Don't reference RequestContextGetter in JS objects V8 doesn't guarrentee the C++ class of JS objects will get destroyed, so this will result in RequestContextGetter never getting freed --- atom/browser/api/atom_api_cookies.h | 2 +- atom/browser/api/atom_api_protocol.h | 6 +++--- atom/browser/net/js_asker.h | 6 +++--- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/atom/browser/api/atom_api_cookies.h b/atom/browser/api/atom_api_cookies.h index 12cf4a220979..0c309b3f18ee 100644 --- a/atom/browser/api/atom_api_cookies.h +++ b/atom/browser/api/atom_api_cookies.h @@ -78,7 +78,7 @@ class Cookies : public mate::Wrappable { // Must be called on IO thread. net::CookieStore* GetCookieStore(); - scoped_refptr request_context_getter_; + net::URLRequestContextGetter* request_context_getter_; DISALLOW_COPY_AND_ASSIGN(Cookies); }; diff --git a/atom/browser/api/atom_api_protocol.h b/atom/browser/api/atom_api_protocol.h index 966fcd8726b3..9f98eb767309 100644 --- a/atom/browser/api/atom_api_protocol.h +++ b/atom/browser/api/atom_api_protocol.h @@ -66,7 +66,7 @@ class Protocol : public mate::Wrappable { public: CustomProtocolHandler( v8::Isolate* isolate, - scoped_refptr request_context, + net::URLRequestContextGetter* request_context, const Handler& handler) : isolate_(isolate), request_context_(request_context), @@ -83,7 +83,7 @@ class Protocol : public mate::Wrappable { private: v8::Isolate* isolate_; - scoped_refptr request_context_; + net::URLRequestContextGetter* request_context_; Protocol::Handler handler_; DISALLOW_COPY_AND_ASSIGN(CustomProtocolHandler); @@ -172,7 +172,7 @@ class Protocol : public mate::Wrappable { // Convert error code to string. std::string ErrorCodeToString(ProtocolError error); - scoped_refptr request_context_getter_; + net::URLRequestContextGetter* request_context_getter_; // Map that stores the original protocols of schemes. using OriginalProtocolsMap = base::ScopedPtrHashMap< diff --git a/atom/browser/net/js_asker.h b/atom/browser/net/js_asker.h index 9c45446abcbb..8ec245ee8c4f 100644 --- a/atom/browser/net/js_asker.h +++ b/atom/browser/net/js_asker.h @@ -46,7 +46,7 @@ class JsAsker : public RequestJob { // Called by |CustomProtocolHandler| to store handler related information. void SetHandlerInfo( v8::Isolate* isolate, - scoped_refptr request_context_getter, + net::URLRequestContextGetter* request_context_getter, const JavaScriptHandler& handler) { isolate_ = isolate; request_context_getter_ = request_context_getter; @@ -57,7 +57,7 @@ class JsAsker : public RequestJob { virtual void StartAsync(scoped_ptr options) = 0; net::URLRequestContextGetter* request_context_getter() const { - return request_context_getter_.get(); + return request_context_getter_; } private: @@ -89,7 +89,7 @@ class JsAsker : public RequestJob { } v8::Isolate* isolate_; - scoped_refptr request_context_getter_; + net::URLRequestContextGetter* request_context_getter_; JavaScriptHandler handler_; base::WeakPtrFactory weak_factory_; From 9dc6cfc1e9e482da4560785755cbc471d112200c Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 9 Sep 2015 16:26:10 +0800 Subject: [PATCH 1185/1293] Bump v0.32.1 --- atom.gyp | 2 +- atom/browser/resources/mac/Info.plist | 2 +- atom/browser/resources/win/atom.rc | 8 ++++---- atom/common/atom_version.h | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/atom.gyp b/atom.gyp index 547bc3c38af5..c78fee1c8e60 100644 --- a/atom.gyp +++ b/atom.gyp @@ -4,7 +4,7 @@ 'product_name%': 'Electron', 'company_name%': 'GitHub, Inc', 'company_abbr%': 'github', - 'version%': '0.32.0', + 'version%': '0.32.1', }, 'includes': [ 'filenames.gypi', diff --git a/atom/browser/resources/mac/Info.plist b/atom/browser/resources/mac/Info.plist index 884cdcd1a1ea..86eef9c09e78 100644 --- a/atom/browser/resources/mac/Info.plist +++ b/atom/browser/resources/mac/Info.plist @@ -17,7 +17,7 @@ CFBundleIconFile atom.icns CFBundleVersion - 0.32.0 + 0.32.1 LSMinimumSystemVersion 10.8.0 NSMainNibFile diff --git a/atom/browser/resources/win/atom.rc b/atom/browser/resources/win/atom.rc index 16c7f0311f89..bfb464b990a3 100644 --- a/atom/browser/resources/win/atom.rc +++ b/atom/browser/resources/win/atom.rc @@ -56,8 +56,8 @@ END // VS_VERSION_INFO VERSIONINFO - FILEVERSION 0,32,0,0 - PRODUCTVERSION 0,32,0,0 + FILEVERSION 0,32,1,0 + PRODUCTVERSION 0,32,1,0 FILEFLAGSMASK 0x3fL #ifdef _DEBUG FILEFLAGS 0x1L @@ -74,12 +74,12 @@ BEGIN BEGIN VALUE "CompanyName", "GitHub, Inc." VALUE "FileDescription", "Electron" - VALUE "FileVersion", "0.32.0" + VALUE "FileVersion", "0.32.1" VALUE "InternalName", "electron.exe" VALUE "LegalCopyright", "Copyright (C) 2015 GitHub, Inc. All rights reserved." VALUE "OriginalFilename", "electron.exe" VALUE "ProductName", "Electron" - VALUE "ProductVersion", "0.32.0" + VALUE "ProductVersion", "0.32.1" VALUE "SquirrelAwareVersion", "1" END END diff --git a/atom/common/atom_version.h b/atom/common/atom_version.h index e270498e40bf..c1d11c91dc87 100644 --- a/atom/common/atom_version.h +++ b/atom/common/atom_version.h @@ -7,7 +7,7 @@ #define ATOM_MAJOR_VERSION 0 #define ATOM_MINOR_VERSION 32 -#define ATOM_PATCH_VERSION 0 +#define ATOM_PATCH_VERSION 1 #define ATOM_VERSION_IS_RELEASE 1 From 590be75fa98bba86608e00fef446f6c564e5e780 Mon Sep 17 00:00:00 2001 From: Gohy Leandre Date: Mon, 31 Aug 2015 11:18:10 +0200 Subject: [PATCH 1186/1293] add ValidatedUrl to did-fail-load event --- atom/browser/api/atom_api_web_contents.cc | 4 ++-- atom/renderer/lib/web-view/guest-view-internal.coffee | 2 +- docs/api/web-contents.md | 1 + docs/api/web-view-tag.md | 1 + 4 files changed, 5 insertions(+), 3 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 9cb52a1ec74d..7c37f17e10d9 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -388,7 +388,7 @@ void WebContents::DidFailProvisionalLoad( int error_code, const base::string16& error_description, bool was_ignored_by_handler) { - Emit("did-fail-load", error_code, error_description); + Emit("did-fail-load", error_code, error_description, validated_url); } void WebContents::DidFailLoad(content::RenderFrameHost* render_frame_host, @@ -396,7 +396,7 @@ void WebContents::DidFailLoad(content::RenderFrameHost* render_frame_host, int error_code, const base::string16& error_description, bool was_ignored_by_handler) { - Emit("did-fail-load", error_code, error_description); + Emit("did-fail-load", error_code, error_description, validated_url); } void WebContents::DidStartLoading() { diff --git a/atom/renderer/lib/web-view/guest-view-internal.coffee b/atom/renderer/lib/web-view/guest-view-internal.coffee index 44db5e304db4..b491184fb8d7 100644 --- a/atom/renderer/lib/web-view/guest-view-internal.coffee +++ b/atom/renderer/lib/web-view/guest-view-internal.coffee @@ -6,7 +6,7 @@ requestId = 0 WEB_VIEW_EVENTS = 'load-commit': ['url', 'isMainFrame'] 'did-finish-load': [] - 'did-fail-load': ['errorCode', 'errorDescription'] + 'did-fail-load': ['errorCode', 'errorDescription', 'validatedUrl'] 'did-frame-finish-load': ['isMainFrame'] 'did-start-loading': [] 'did-stop-loading': [] diff --git a/docs/api/web-contents.md b/docs/api/web-contents.md index 89afae43d1c0..a3d3c360fff6 100644 --- a/docs/api/web-contents.md +++ b/docs/api/web-contents.md @@ -32,6 +32,7 @@ Returns: * `event` Event * `errorCode` Integer * `errorDescription` String +* `validatedUrl` String This event is like `did-finish-load` but emitted when the load failed or was cancelled, e.g. `window.stop()` is invoked. diff --git a/docs/api/web-view-tag.md b/docs/api/web-view-tag.md index 850390702168..ff12110fac84 100644 --- a/docs/api/web-view-tag.md +++ b/docs/api/web-view-tag.md @@ -384,6 +384,7 @@ Returns: * `errorCode` Integer * `errorDescription` String +* `validatedUrl` String This event is like `did-finish-load`, but fired when the load failed or was cancelled, e.g. `window.stop()` is invoked. From 5089929be8e9b919106c8879908beea4cbbcedec Mon Sep 17 00:00:00 2001 From: Eran Tiktin Date: Wed, 9 Sep 2015 21:34:20 +0300 Subject: [PATCH 1187/1293] Update README.md Capitalized the "Formerly known..." text + rearranged the community section and mention the slack channel. --- README.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 68518052c016..54b6af5fa3fc 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [![devDependency Status](https://david-dm.org/atom/electron/dev-status.svg)](https://david-dm.org/atom/electron#info=devDependencies) [![Join the Electron Community on Slack](http://atom-slack.herokuapp.com/badge.svg)](http://atom-slack.herokuapp.com/) -:zap: *formerly known as Atom Shell* :zap: +:zap: *Formerly known as Atom Shell* :zap: The Electron framework lets you write cross-platform desktop applications using JavaScript, HTML and CSS. It is based on [io.js](http://iojs.org) and @@ -15,7 +15,8 @@ Follow [@ElectronJS](https://twitter.com/electronjs) on Twitter for important announcements. This project adheres to the [Contributor Covenant 1.2](http://contributor-covenant.org/version/1/2/0). -By participating, you are expected to uphold this code. Please report unacceptable behavior to atom@github.com. +By participating, you are expected to uphold this code. Please report +unacceptable behavior to atom@github.com. ## Downloads @@ -54,7 +55,12 @@ contains documents describing how to build and contribute to Electron. ## Community -There is an [`electron` category on the Atom forums](http://discuss.atom.io/category/electron) -as well as an `#atom-shell` channel on Freenode. +You can ask questions and interact with the community in the following +locations: +- [`electron`](http://discuss.atom.io/category/electron) category on the Atom +forums +- `#atom-shell` channel on Freenode +- [`Atom`](http://atom-slack.herokuapp.com/) channel on Slack -Check out [awesome-electron](https://github.com/sindresorhus/awesome-electron) for a community maintained list of useful example apps, tools and resources. +Check out [awesome-electron](https://github.com/sindresorhus/awesome-electron) +for a community maintained list of useful example apps, tools and resources. From ce49bba2fc36d3d99ac28066beda4ca0af88f497 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Wed, 9 Sep 2015 13:32:56 -0700 Subject: [PATCH 1188/1293] Add section links --- docs/styleguide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/styleguide.md b/docs/styleguide.md index 687b5c4dea3e..d02b7f56861f 100644 --- a/docs/styleguide.md +++ b/docs/styleguide.md @@ -1,7 +1,7 @@ # Electron Documentation Styleguide -Find the appropriate section for your task: [reading Electron documentation](#) -or [writing Electron documentation](#). +Find the appropriate section for your task: [reading Electron documentation](#reading-electron-documentation) +or [writing Electron documentation](#writing-electron-documentation). ## Writing Electron Documentation From e9712e2998a78001998c4ca66fd4f58f80f59677 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Wed, 9 Sep 2015 13:33:11 -0700 Subject: [PATCH 1189/1293] Add section on documentation translations --- CONTRIBUTING.md | 1 + docs/styleguide.md | 15 +++++++++++++++ 2 files changed, 16 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 61a8e474099a..516f6289ac0f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,6 +29,7 @@ possible with your report. If you can, please include: * Include screenshots and animated GIFs in your pull request whenever possible. * Follow the CoffeeScript, JavaScript, C++ and Python [coding style defined in docs](/docs/development/coding-style.md). * Write documentation in [Markdown](https://daringfireball.net/projects/markdown). + See the [Documentation Styleguide](/docs/styleguide.md). * Use short, present tense commit messages. See [Commit Message Styleguide](#git-commit-messages-styleguide). ## Styleguides diff --git a/docs/styleguide.md b/docs/styleguide.md index d02b7f56861f..77c90467ca93 100644 --- a/docs/styleguide.md +++ b/docs/styleguide.md @@ -27,6 +27,21 @@ These are the ways that we construct the Electron documentation. - ```### `method(foo, bar)` _OS X_``` - Prefer 'in the ___ process' over 'on' +### Documentation Translations + +Translations of the Electron docs are located within the `docs-translations` +directory. + +To add another set (or partial set): + +- Create a subdirectory named by language abbreviation. +- Within that subdirectory, duplicate the `docs` directory, keeping the + names of directories and files same. +- Translate the files. +- Update the `README.md` within your language directory to link to the files + you have translated. +- Add a link to your translation directory on the main Electron [README](https://github.com/atom/electron#documentation-translations). + ## Reading Electron Documentation Here are some tips for understanding Electron documentation syntax. From 6abc4fb2552c344d73a0d062e70aad189d0f8efe Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Wed, 9 Sep 2015 13:48:04 -0700 Subject: [PATCH 1190/1293] :fire: odd, stray + --- docs/api/browser-window.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index d74e999379ba..ad62cc017cdb 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -117,7 +117,7 @@ Properties `width` and `height` are required. The `BrowserWindow` object emits the following events: -+**Note** Some events are only available on specific operating systems and are labeled as such. +**Note** Some events are only available on specific operating systems and are labeled as such. ### Event: 'page-title-updated' @@ -292,7 +292,7 @@ Remove the devtools extension whose name is `name`. Objects created with `new BrowserWindow` have the following instance methods: -+**Note** Some methods are only available on specific operating systems and are labeled as such. +**Note** Some methods are only available on specific operating systems and are labeled as such. ```javascript var BrowserWindow = require('browser-window'); From 5593717d782dfc2cd549d51bf9fdaf48830ef731 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Wed, 9 Sep 2015 13:57:35 -0700 Subject: [PATCH 1191/1293] Create Instance Properties section --- docs/api/browser-window.md | 58 +++++++++++++++++++++++--------------- 1 file changed, 36 insertions(+), 22 deletions(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index ad62cc017cdb..a0f29e349da6 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -288,6 +288,42 @@ API is not for programming use. Remove the devtools extension whose name is `name`. + +## Instance Properties + +Objects created with `new BrowserWindow` have the following properties: + +```javascript +var BrowserWindow = require('browser-window'); + +// In this example `win` is our instance +var win = new BrowserWindow({ width: 800, height: 600 }); + +``` + +### `win.webContents` + +The `WebContents` object this window owns, all web page related events and +operations will be done via it. + +See the [`webContents` documentation](web-contents.md) for its methods and +events. + +**Note:** Users should never store this object because it may become `null` +when the renderer process (web page) has crashed. + +### `win.devToolsWebContents` + +The `WebContents` of devtools for this window. + +**Note:** Users should never store this object because it may become `null` +when the devtools has been closed. + +### `win.id` + +The unique ID of this window. + + ## Instance Methods Objects created with `new BrowserWindow` have the following instance methods: @@ -302,28 +338,6 @@ var win = new BrowserWindow({ width: 800, height: 600 }); ``` -### `win.webContents()` - -The `WebContents` object this window owns, all web page related events and -operations will be done via it. - -See the [`webContents` documentation](web-contents.md) for its methods and -events. - -**Note:** Users should never store this object because it may become `null` -when the renderer process (web page) has crashed. - -### `win.devToolsWebContents()` - -Get the `WebContents` of devtools for this window. - -**Note:** Users should never store this object because it may become `null` -when the devtools has been closed. - -### `win.id()` - -Get the unique ID of this window. - ### `win.destroy()` Force closing the window, the `unload` and `beforeunload` event won't be emitted From 1a35d6bda66e8e6e391fd398e43dab99d848ccf8 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Wed, 9 Sep 2015 14:00:37 -0700 Subject: [PATCH 1192/1293] :fire: extra lines --- docs/api/browser-window.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index a0f29e349da6..f8df8eda9fb7 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -288,7 +288,6 @@ API is not for programming use. Remove the devtools extension whose name is `name`. - ## Instance Properties Objects created with `new BrowserWindow` have the following properties: @@ -323,7 +322,6 @@ when the devtools has been closed. The unique ID of this window. - ## Instance Methods Objects created with `new BrowserWindow` have the following instance methods: From 279fd0a4610afc6691ab16f0341e3b8f63a998c2 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Wed, 9 Sep 2015 14:09:14 -0700 Subject: [PATCH 1193/1293] Standardize **Note:** --- docs/api/app.md | 2 +- docs/api/browser-window.md | 4 ++-- docs/api/global-shortcut.md | 2 +- docs/api/ipc-renderer.md | 4 ++-- docs/api/native-image.md | 2 +- docs/api/remote.md | 2 +- docs/api/screen.md | 2 +- docs/api/tray.md | 2 +- docs/api/web-view-tag.md | 2 +- 9 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/api/app.md b/docs/api/app.md index 07b26f2c5663..42a5dfc24249 100644 --- a/docs/api/app.md +++ b/docs/api/app.md @@ -152,7 +152,7 @@ Emitted when the gpu process crashes. The `app` object has the following methods: -**Note** Some methods are only available on specific operating systems and are labeled as such. +**Note:** Some methods are only available on specific operating systems and are labeled as such. ### `app.quit()` diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index e9d2c7f6feb8..53a9487733b7 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -117,7 +117,7 @@ Properties `width` and `height` are required. The `BrowserWindow` object emits the following events: -+**Note** Some events are only available on specific operating systems and are labeled as such. ++**Note:** Some events are only available on specific operating systems and are labeled as such. ### Event: 'page-title-updated' @@ -292,7 +292,7 @@ Remove the devtools extension whose name is `name`. Objects created with `new BrowserWindow` have the following instance methods: -+**Note** Some methods are only available on specific operating systems and are labeled as such. ++**Note:** Some methods are only available on specific operating systems and are labeled as such. ```javascript var BrowserWindow = require('browser-window'); diff --git a/docs/api/global-shortcut.md b/docs/api/global-shortcut.md index f9ca654cf50a..adba06e1adcf 100644 --- a/docs/api/global-shortcut.md +++ b/docs/api/global-shortcut.md @@ -4,7 +4,7 @@ The `global-shortcut` module can register/unregister a global keyboard shortcut with the operating system so that you can customize the operations for various shortcuts. -**Note**: The shortcut is global; it will work even if the app does +**Note:** The shortcut is global; it will work even if the app does not have the keyboard focus. You should not use this module until the `ready` event of the app module is emitted. diff --git a/docs/api/ipc-renderer.md b/docs/api/ipc-renderer.md index 3adb0bc95476..752af2ebe293 100644 --- a/docs/api/ipc-renderer.md +++ b/docs/api/ipc-renderer.md @@ -4,7 +4,7 @@ The `ipc` module provides a few methods so you can send synchronous and asynchronous messages from the render process (web page) to the main process. You can also receive replies from the main process. -**Note**: If you want to make use of modules in the main process from the renderer +**Note:** If you want to make use of modules in the main process from the renderer process, you might consider using the [remote](remote.md) module. See [ipc (main process)](ipc-main-process.md) for code examples. @@ -13,7 +13,7 @@ See [ipc (main process)](ipc-main-process.md) for code examples. The `ipc` module has the following methods for sending messages: -**Note**: When using these methods to send a `message` you must also listen +**Note:** When using these methods to send a `message` you must also listen for it in the main process with [`ipc (main process)`](ipc-main-process.md). ### `ipc.send(channel[, arg1][, arg2][, ...])` diff --git a/docs/api/native-image.md b/docs/api/native-image.md index c00ec3a9458a..df2bb96ff9da 100644 --- a/docs/api/native-image.md +++ b/docs/api/native-image.md @@ -74,7 +74,7 @@ mixed with other content to create the desired final appearance. The most common case is to use template images for a menu bar icon so it can adapt to both light and dark menu bars. -**Note**: Template image is only supported on OS X. +**Note:** Template image is only supported on OS X. To mark an image as a template image, its filename should end with the word `Template`. For example: diff --git a/docs/api/remote.md b/docs/api/remote.md index ccb16b4b3cc3..5a048fc0789f 100644 --- a/docs/api/remote.md +++ b/docs/api/remote.md @@ -20,7 +20,7 @@ var win = new BrowserWindow({ width: 800, height: 600 }); win.loadUrl('https://github.com'); ``` -**Note**: for the reverse (access the renderer process from the main process), +**Note:** for the reverse (access the renderer process from the main process), you can use [webContents.executeJavascript](browser-window.md#webcontents-executejavascript-code). ## Remote Objects diff --git a/docs/api/screen.md b/docs/api/screen.md index c22530ca8d0a..934e3eaf5a70 100644 --- a/docs/api/screen.md +++ b/docs/api/screen.md @@ -6,7 +6,7 @@ position, etc. You should not use this module until the `ready` event of the `screen` is an [EventEmitter](http://nodejs.org/api/events.html#events_class_events_eventemitter). -**Note**: In the renderer / DevTools, `window.screen` is a reserved +**Note:** In the renderer / DevTools, `window.screen` is a reserved DOM property, so writing `var screen = require('screen')` will not work. In our examples below, we use `atomScreen` as the variable name instead. diff --git a/docs/api/tray.md b/docs/api/tray.md index a673307804a7..528705acb325 100644 --- a/docs/api/tray.md +++ b/docs/api/tray.md @@ -123,7 +123,7 @@ Emitted when dragged files are dropped in the tray icon. The `Tray` module has the following methods: -**Note**: Some methods are only available on specific operating systems and are +**Note:** Some methods are only available on specific operating systems and are labeled as such. ### `Tray.destroy()` diff --git a/docs/api/web-view-tag.md b/docs/api/web-view-tag.md index 6b64a0269c52..1d49a3db130c 100644 --- a/docs/api/web-view-tag.md +++ b/docs/api/web-view-tag.md @@ -135,7 +135,7 @@ If "on", the guest page will have web security disabled. The `webview` tag has the following methods: -**Note**: The webview element must be loaded before using the methods. +**Note:** The webview element must be loaded before using the methods. **Example** ```javascript From c29a2e4992f6dc063abdb847502790436439b1ba Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Wed, 9 Sep 2015 14:11:06 -0700 Subject: [PATCH 1194/1293] Standardize DevTools --- docs/api/browser-window.md | 16 ++++++++-------- docs/api/web-contents.md | 4 ++-- docs/api/web-view-tag.md | 8 ++++---- docs/tutorial/debugging-main-process.md | 2 +- 4 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 53a9487733b7..289f96cd21ea 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -224,15 +224,15 @@ Emitted when the window leaves full screen state triggered by html api. ### Event: 'devtools-opened' -Emitted when devtools is opened. +Emitted when DevTools is opened. ### Event: 'devtools-closed' -Emitted when devtools is closed. +Emitted when DevTools is closed. ### Event: 'devtools-focused' -Emitted when devtools is focused / opened. +Emitted when DevTools is focused / opened. ### Event: 'app-command' _Windows_ @@ -277,7 +277,7 @@ Find a window according to its ID. * `path` String -Adds devtools extension located at `path`, and returns extension's name. +Adds DevTools extension located at `path`, and returns extension's name. The extension will be remembered so you only need to call this API once, this API is not for programming use. @@ -286,7 +286,7 @@ API is not for programming use. * `name` String -Remove the devtools extension whose name is `name`. +Remove the DevTools extension whose name is `name`. ## Instance Methods @@ -315,10 +315,10 @@ when the renderer process (web page) has crashed. ### `win.devToolsWebContents()` -Get the `WebContents` of devtools for this window. +Get the `WebContents` of DevTools for this window. **Note:** Users should never store this object because it may become `null` -when the devtools has been closed. +when the DevTools has been closed. ### `win.id()` @@ -577,7 +577,7 @@ Whether the window's document has been edited. ### `win.openDevTools([options])` * `options` Object (optional). Properties: - * `detach` Boolean - opens devtools in a new window + * `detach` Boolean - opens DevTools in a new window Opens the developer tools. diff --git a/docs/api/web-contents.md b/docs/api/web-contents.md index c49b64743bed..7324b6b17976 100644 --- a/docs/api/web-contents.md +++ b/docs/api/web-contents.md @@ -426,13 +426,13 @@ win.webContents.on("did-finish-load", function() { * `path` String -Adds the specified path to devtools workspace. +Adds the specified path to DevTools workspace. ### `webContents.removeWorkSpace(path)` * `path` String -Removes the specified path from devtools workspace. +Removes the specified path from DevTools workspace. ### `webContents.send(channel[, args...])` diff --git a/docs/api/web-view-tag.md b/docs/api/web-view-tag.md index 1d49a3db130c..a61625023bff 100644 --- a/docs/api/web-view-tag.md +++ b/docs/api/web-view-tag.md @@ -242,15 +242,15 @@ user action, can take advantage of this option for automation. ### `.openDevTools()` -Opens a devtools window for guest page. +Opens a DevTools window for guest page. ### `.closeDevTools()` -Closes the devtools window of guest page. +Closes the DevTools window of guest page. ### `.isDevToolsOpened()` -Returns a boolean whether guest page has a devtools window attached. +Returns a boolean whether guest page has a DevTools window attached. ### `.inspectElement(x, y)` @@ -261,7 +261,7 @@ Starts inspecting element at position (`x`, `y`) of guest page. ### `.inspectServiceWorker()` -Opens the devtools for the service worker context present in the guest page. +Opens the DevTools for the service worker context present in the guest page. ### `.setAudioMuted(muted)` diff --git a/docs/tutorial/debugging-main-process.md b/docs/tutorial/debugging-main-process.md index f4e345a2f3a5..38c6e61ffcde 100644 --- a/docs/tutorial/debugging-main-process.md +++ b/docs/tutorial/debugging-main-process.md @@ -1,6 +1,6 @@ # Debugging the Main Process -The browser window devtools can only debug the renderer process scripts (i.e. +The browser window DevTools can only debug the renderer process scripts (i.e. the web pages). In order to provide a way to debug the scripts from the main process, Electron has provided the `--debug` and `--debug-brk` switches. From b2af3702497c487cd7d5a8f94e50a585f9a0091b Mon Sep 17 00:00:00 2001 From: Heilig Benedek Date: Thu, 10 Sep 2015 02:10:47 +0200 Subject: [PATCH 1195/1293] Changed StringArray options to regular js objects with boolean values for better readability from the js side --- atom/browser/api/atom_api_window.cc | 93 ++++++++++++----------------- atom/browser/native_window.h | 1 + atom/common/event_types.cc | 75 ++++++++++++++++++++++- atom/common/event_types.h | 6 +- docs/api/browser-window.md | 42 ++++++------- vendor/native_mate | 2 +- 6 files changed, 139 insertions(+), 80 deletions(-) diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index 3c523f8ccdb4..b9b592a283aa 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -528,10 +528,10 @@ void Window::SendKeyboardEvent(v8::Isolate* isolate, const mate::Dictionary& dat int keycode = 0; int native = 0; std::string type_str = ""; - std::vector modifier_array; + mate::Dictionary modifier_list = mate::Dictionary::CreateEmpty(isolate); data.Get(switches::kEventType, &type_str); - data.Get(switches::kModifiers, &modifier_array); + data.Get(switches::kModifiers, &modifier_list); data.Get(switches::kKeyCode, &keycode); data.Get(switches::kNativeKeyCode, &native); @@ -543,28 +543,22 @@ void Window::SendKeyboardEvent(v8::Isolate* isolate, const mate::Dictionary& dat type = blink::WebInputEvent::Type::Char; } - for(std::vector::iterator mod = modifier_array.begin(); mod != modifier_array.end(); ++mod) { - if(mod->compare(event_types::kModifierIsKeyPad) == 0){ - modifiers = modifiers & blink::WebInputEvent::Modifiers::IsKeyPad; - }else if(mod->compare(event_types::kModifierIsAutoRepeat) == 0){ - modifiers = modifiers & blink::WebInputEvent::Modifiers::IsAutoRepeat; - }else if(mod->compare(event_types::kModifierIsLeft) == 0){ - modifiers = modifiers & blink::WebInputEvent::Modifiers::IsLeft; - }else if(mod->compare(event_types::kModifierIsRight) == 0){ - modifiers = modifiers & blink::WebInputEvent::Modifiers::IsRight; - }else if(mod->compare(event_types::kModifierShiftKey) == 0){ - modifiers = modifiers & blink::WebInputEvent::Modifiers::ShiftKey; - }else if(mod->compare(event_types::kModifierControlKey) == 0){ - modifiers = modifiers & blink::WebInputEvent::Modifiers::ControlKey; - }else if(mod->compare(event_types::kModifierAltKey) == 0){ - modifiers = modifiers & blink::WebInputEvent::Modifiers::AltKey; - }else if(mod->compare(event_types::kModifierMetaKey) == 0){ - modifiers = modifiers & blink::WebInputEvent::Modifiers::MetaKey; - }else if(mod->compare(event_types::kModifierCapsLockOn) == 0){ - modifiers = modifiers & blink::WebInputEvent::Modifiers::CapsLockOn; - }else if(mod->compare(event_types::kModifierNumLockOn) == 0){ - modifiers = modifiers & blink::WebInputEvent::Modifiers::NumLockOn; - } + std::map modifier_types; + modifier_types[event_types::kModifierIsKeyPad] = false; + modifier_types[event_types::kModifierIsAutoRepeat] = false; + modifier_types[event_types::kModifierIsLeft] = false; + modifier_types[event_types::kModifierIsRight] = false; + modifier_types[event_types::kModifierShiftKey] = false; + modifier_types[event_types::kModifierControlKey] = false; + modifier_types[event_types::kModifierAltKey] = false; + modifier_types[event_types::kModifierMetaKey] = false; + modifier_types[event_types::kModifierCapsLockOn] = false; + modifier_types[event_types::kModifierNumLockOn] = false; + + for(std::map::iterator it = modifier_types.begin(); it != modifier_types.end(); ++it){ + modifier_list.Get(it->first,&(it->second)); + + if(it->second) modifiers = modifiers & event_types::modifierStrToWebModifier(it->first); } window_->SendKeyboardEvent(type, modifiers, keycode, native); @@ -574,7 +568,7 @@ void Window::SendMouseEvent(v8::Isolate* isolate, const mate::Dictionary& data){ int x, y, movementX, movementY, clickCount; std::string type_str = ""; std::string button_str = ""; - std::vector modifier_array; + mate::Dictionary modifier_list = mate::Dictionary::CreateEmpty(isolate); blink::WebInputEvent::Type type = blink::WebInputEvent::Type::MouseMove; blink::WebMouseEvent::Button button = blink::WebMouseEvent::Button::ButtonNone; @@ -582,7 +576,7 @@ void Window::SendMouseEvent(v8::Isolate* isolate, const mate::Dictionary& data){ data.Get(switches::kEventType, &type_str); data.Get(switches::kMouseEventButton, &button_str); - data.Get(switches::kModifiers, &modifier_array); + data.Get(switches::kModifiers, &modifier_list); if(type_str.compare(event_types::kMouseDown) == 0){ type = blink::WebInputEvent::Type::MouseDown; @@ -600,37 +594,24 @@ void Window::SendMouseEvent(v8::Isolate* isolate, const mate::Dictionary& data){ type = blink::WebInputEvent::Type::MouseWheel; } - if(button_str.compare(event_types::kMouseLeftButton) == 0){ - modifiers = modifiers & blink::WebInputEvent::Modifiers::LeftButtonDown; - button = blink::WebMouseEvent::Button::ButtonLeft; - }else if(button_str.compare(event_types::kMouseRightButton) == 0){ - modifiers = modifiers & blink::WebInputEvent::Modifiers::RightButtonDown; - button = blink::WebMouseEvent::Button::ButtonRight; - }else if(button_str.compare(event_types::kMouseMiddleButton) == 0){ - modifiers = modifiers & blink::WebInputEvent::Modifiers::MiddleButtonDown; - button = blink::WebMouseEvent::Button::ButtonMiddle; - } + std::map modifier_types; + modifier_types[event_types::kMouseLeftButton] = false; + modifier_types[event_types::kMouseRightButton] = false; + modifier_types[event_types::kMouseMiddleButton] = false; + modifier_types[event_types::kModifierLeftButtonDown] = false; + modifier_types[event_types::kModifierMiddleButtonDown] = false; + modifier_types[event_types::kModifierRightButtonDown] = false; + modifier_types[event_types::kModifierShiftKey] = false; + modifier_types[event_types::kModifierControlKey] = false; + modifier_types[event_types::kModifierAltKey] = false; + modifier_types[event_types::kModifierMetaKey] = false; + modifier_types[event_types::kModifierCapsLockOn] = false; + modifier_types[event_types::kModifierNumLockOn] = false; - for(std::vector::iterator mod = modifier_array.begin(); mod != modifier_array.end(); ++mod) { - if(mod->compare(event_types::kModifierLeftButtonDown) == 0){ - modifiers = modifiers & blink::WebInputEvent::Modifiers::LeftButtonDown; - }else if(mod->compare(event_types::kModifierMiddleButtonDown) == 0){ - modifiers = modifiers & blink::WebInputEvent::Modifiers::MiddleButtonDown; - }else if(mod->compare(event_types::kModifierRightButtonDown) == 0){ - modifiers = modifiers & blink::WebInputEvent::Modifiers::RightButtonDown; - }else if(mod->compare(event_types::kModifierShiftKey) == 0){ - modifiers = modifiers & blink::WebInputEvent::Modifiers::ShiftKey; - }else if(mod->compare(event_types::kModifierControlKey) == 0){ - modifiers = modifiers & blink::WebInputEvent::Modifiers::ControlKey; - }else if(mod->compare(event_types::kModifierAltKey) == 0){ - modifiers = modifiers & blink::WebInputEvent::Modifiers::AltKey; - }else if(mod->compare(event_types::kModifierMetaKey) == 0){ - modifiers = modifiers & blink::WebInputEvent::Modifiers::MetaKey; - }else if(mod->compare(event_types::kModifierCapsLockOn) == 0){ - modifiers = modifiers & blink::WebInputEvent::Modifiers::CapsLockOn; - }else if(mod->compare(event_types::kModifierNumLockOn) == 0){ - modifiers = modifiers & blink::WebInputEvent::Modifiers::NumLockOn; - } + for(std::map::iterator it = modifier_types.begin(); it != modifier_types.end(); ++it){ + modifier_list.Get(it->first,&(it->second)); + + if(it->second) modifiers = modifiers & event_types::modifierStrToWebModifier(it->first); } if(type == blink::WebInputEvent::Type::MouseWheel){ diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index d361fcf69632..7131894a1f1c 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -332,6 +332,7 @@ class NativeWindow : public content::WebContentsObserver, DISALLOW_COPY_AND_ASSIGN(NativeWindow); }; +//This class provides a way to listen to frame renders and to use the rendered frames for offscreen rendering class RenderSubscriber : public content::RenderWidgetHostViewFrameSubscriber { public: RenderSubscriber(gfx::Size size, base::Callback)> callback) : size_(size), callback_(callback) {} diff --git a/atom/common/event_types.cc b/atom/common/event_types.cc index 3d3b901ed3cc..be0848128980 100644 --- a/atom/common/event_types.cc +++ b/atom/common/event_types.cc @@ -3,6 +3,7 @@ // found in the LICENSE file. #include "atom/common/event_types.h" +#include "third_party/WebKit/public/web/WebInputEvent.h" namespace atom { @@ -40,6 +41,78 @@ const char kModifierIsAutoRepeat[] = "auto-repeat"; const char kModifierIsLeft[] = "left"; const char kModifierIsRight[] = "right"; -} // namespace switches +int modifierStrToWebModifier(std::string modifier){ + if(modifier.compare(event_types::kModifierLeftButtonDown) == 0){ + + return blink::WebInputEvent::Modifiers::LeftButtonDown; + + }else if(modifier.compare(event_types::kModifierMiddleButtonDown) == 0){ + + return blink::WebInputEvent::Modifiers::MiddleButtonDown; + + }else if(modifier.compare(event_types::kModifierRightButtonDown) == 0){ + + return blink::WebInputEvent::Modifiers::RightButtonDown; + + }else if(modifier.compare(event_types::kMouseLeftButton) == 0){ + + return blink::WebInputEvent::Modifiers::LeftButtonDown; + + }else if(modifier.compare(event_types::kMouseRightButton) == 0){ + + return blink::WebInputEvent::Modifiers::RightButtonDown; + + }else if(modifier.compare(event_types::kMouseMiddleButton) == 0){ + + return blink::WebInputEvent::Modifiers::MiddleButtonDown; + + }else if(modifier.compare(event_types::kModifierIsKeyPad) == 0){ + + return blink::WebInputEvent::Modifiers::IsKeyPad; + + }else if(modifier.compare(event_types::kModifierIsAutoRepeat) == 0){ + + return blink::WebInputEvent::Modifiers::IsAutoRepeat; + + }else if(modifier.compare(event_types::kModifierIsLeft) == 0){ + + return blink::WebInputEvent::Modifiers::IsLeft; + + }else if(modifier.compare(event_types::kModifierIsRight) == 0){ + + return blink::WebInputEvent::Modifiers::IsRight; + + }else if(modifier.compare(event_types::kModifierShiftKey) == 0){ + + return blink::WebInputEvent::Modifiers::ShiftKey; + + }else if(modifier.compare(event_types::kModifierControlKey) == 0){ + + return blink::WebInputEvent::Modifiers::ControlKey; + + }else if(modifier.compare(event_types::kModifierAltKey) == 0){ + + return blink::WebInputEvent::Modifiers::AltKey; + + }else if(modifier.compare(event_types::kModifierMetaKey) == 0){ + + return blink::WebInputEvent::Modifiers::MetaKey; + + }else if(modifier.compare(event_types::kModifierCapsLockOn) == 0){ + + return blink::WebInputEvent::Modifiers::CapsLockOn; + + }else if(modifier.compare(event_types::kModifierNumLockOn) == 0){ + + return blink::WebInputEvent::Modifiers::NumLockOn; + + }else{ + + return 0; + + } +} + +} // namespace event_types } // namespace atom diff --git a/atom/common/event_types.h b/atom/common/event_types.h index b7eae781fc42..d4769db2d78b 100644 --- a/atom/common/event_types.h +++ b/atom/common/event_types.h @@ -5,6 +5,8 @@ #ifndef ATOM_COMMON_EVENT_TYPES_H_ #define ATOM_COMMON_EVENT_TYPES_H_ +#include "third_party/WebKit/public/web/WebInputEvent.h" + namespace atom { namespace event_types { @@ -41,7 +43,9 @@ extern const char kModifierIsAutoRepeat[]; extern const char kModifierIsLeft[]; extern const char kModifierIsRight[]; -} // namespace switches +int modifierStrToWebModifier(std::string modifier); + +} // namespace event_types } // namespace atom diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 217844897aff..09d38bc9ad98 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -759,16 +759,16 @@ Sends a mouse event to the BrowserWindow. * `middle` String - The middle button was pressed. * `click-count` Integer - The number of clicks associated with the mouse event. * `precise` Boolean - For the `wheel` event type, this option sets the `hasPreciseScrollingDeltas` option of the event. - * `modifiers` Array of Strings - The modifier values associated with the event. - * `left-button-down` String - The left mouse button was pressed. - * `middle-button-down` String - The right mouse button was pressed. - * `right-button-down` String - The middle mouse button was pressed. - * `shift` String - The shift key was pressed. - * `control` String - The control key was pressed. - * `alt` String - The alt key was pressed. - * `meta` String - The meta key was pressed. - * `caps-lock` String - The caps-lock key was pressed. - * `num-lock` String - The num-lock key was pressed. + * `modifiers` Object - The modifier values associated with the event. + * `left-button-down` Boolean - The left mouse button was pressed. + * `middle-button-down` Boolean - The right mouse button was pressed. + * `right-button-down` Boolean - The middle mouse button was pressed. + * `shift` Boolean - The shift key was pressed. + * `control` Boolean - The control key was pressed. + * `alt` Boolean - The alt key was pressed. + * `meta` Boolean - The meta key was pressed. + * `caps-lock` Boolean - The caps-lock key was on. + * `num-lock` Boolean - The num-lock key was on. ### BrowserWindow.sendKeyboardEvent(options) @@ -780,17 +780,17 @@ Sends a keyboard event to the BrowserWindow. * `char` String - Character event. * `code` Integer - The key code of the key that generated the event. * `native` Integer - The native key code of the key that generated the event. - * `modifiers` Array of Strings - The modifier values associated with the event. - * `keypad` String - Sets the `IsKeyPad` option of the event. - * `auto-repeat` String - Sets the `IsAutoRepeat` option of the event. - * `left` String - Sets the `IsLeft` option of the event. - * `right` String - Sets the `IsRight` option of the event. - * `shift` String - The shift key was pressed. - * `control` String - The control key was pressed. - * `alt` String - The alt key was pressed. - * `meta` String - The meta key was pressed. - * `caps-lock` String - The caps-lock key was pressed. - * `num-lock` String - The num-lock key was pressed. + * `modifiers` Object - The modifier values associated with the event. + * `keypad` Boolean - Sets the `IsKeyPad` option of the event. + * `auto-repeat` Boolean - Sets the `IsAutoRepeat` option of the event. + * `left` Boolean - Sets the `IsLeft` option of the event. + * `right` Boolean - Sets the `IsRight` option of the event. + * `shift` Boolean - The shift key was pressed. + * `control` Boolean - The control key was pressed. + * `alt` Boolean - The alt key was pressed. + * `meta` Boolean - The meta key was pressed. + * `caps-lock` Boolean - The caps-lock key was on. + * `num-lock` Boolean - The num-lock key was on. ## Class: WebContents diff --git a/vendor/native_mate b/vendor/native_mate index 31b6395d9938..c71b1694e51f 160000 --- a/vendor/native_mate +++ b/vendor/native_mate @@ -1 +1 @@ -Subproject commit 31b6395d9938558ea39a77ef2f432beaf2dcd4cb +Subproject commit c71b1694e51fe62f646a0e92e39329d8ab569d5c From f807a8f1e715ca7879d55277494a7e47c1399630 Mon Sep 17 00:00:00 2001 From: Heilig Benedek Date: Thu, 10 Sep 2015 02:16:41 +0200 Subject: [PATCH 1196/1293] Reset native-mate to the original repo --- .gitmodules | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitmodules b/.gitmodules index a3afcef28c84..c6e53ed39a69 100644 --- a/.gitmodules +++ b/.gitmodules @@ -12,7 +12,7 @@ url = https://github.com/atom/chromium-breakpad.git [submodule "vendor/native_mate"] path = vendor/native_mate - url = https://github.com/brenca/native-mate.git + url = https://github.com/zcbenz/native-mate.git [submodule "vendor/crashpad"] path = vendor/crashpad url = https://github.com/atom/crashpad.git From 69769f9319cdad4ea07e76b1cfde7c3f73b4db39 Mon Sep 17 00:00:00 2001 From: Heilig Benedek Date: Thu, 10 Sep 2015 02:23:12 +0200 Subject: [PATCH 1197/1293] Resetting debug changes --- atom/app/atom_main.cc | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/atom/app/atom_main.cc b/atom/app/atom_main.cc index 5677adb2eed3..d782d15eb43b 100644 --- a/atom/app/atom_main.cc +++ b/atom/app/atom_main.cc @@ -90,12 +90,9 @@ int APIENTRY wWinMain(HINSTANCE instance, HINSTANCE, wchar_t* cmd, int) { if (env->GetVar("OS", &os) && os != "cygwin") { AttachConsole(ATTACH_PARENT_PROCESS); - FILE* dontcare, *out, *err; - out = fopen("out.txt", "w"); - err = fopen("err.txt", "w"); - freopen_s(&out, "CON", "w", stdout); - freopen_s(&err, "CON", "w", stderr); - freopen_s(&dontcare, "CON", "r", stdin); + FILE* dontcare; + freopen_s(&dontcare, "CON", "w", stdout); + freopen_s(&dontcare, "CON", "w", stderr); } // Convert argv to to UTF8 From 1497e7e2ac93a98e84707bd1031ab82b833dc938 Mon Sep 17 00:00:00 2001 From: Heilig Benedek Date: Thu, 10 Sep 2015 02:24:08 +0200 Subject: [PATCH 1198/1293] Whoops, missed a line last time. --- atom/app/atom_main.cc | 1 + 1 file changed, 1 insertion(+) diff --git a/atom/app/atom_main.cc b/atom/app/atom_main.cc index d782d15eb43b..47be348522f1 100644 --- a/atom/app/atom_main.cc +++ b/atom/app/atom_main.cc @@ -93,6 +93,7 @@ int APIENTRY wWinMain(HINSTANCE instance, HINSTANCE, wchar_t* cmd, int) { FILE* dontcare; freopen_s(&dontcare, "CON", "w", stdout); freopen_s(&dontcare, "CON", "w", stderr); + freopen_s(&dontcare, "CON", "r", stdin); } // Convert argv to to UTF8 From 70af2e0bee5cfadc45b08d489370e03d7e993e0c Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 10 Sep 2015 11:15:35 +0800 Subject: [PATCH 1199/1293] osx: Don't warn about unkown warning option We can not make every compiler happy. --- common.gypi | 1 + 1 file changed, 1 insertion(+) diff --git a/common.gypi b/common.gypi index a95e05620f02..7c41c3616dfb 100644 --- a/common.gypi +++ b/common.gypi @@ -75,6 +75,7 @@ 'xcode_settings': { 'GCC_TREAT_WARNINGS_AS_ERRORS': 'NO', 'WARNING_CFLAGS': [ + '-Wno-unknown-warning-option', '-Wno-parentheses-equality', '-Wno-unused-function', '-Wno-sometimes-uninitialized', From d4cbf7cadbed1f0dcd01c40ca07639799901b1a6 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 10 Sep 2015 15:30:41 +0800 Subject: [PATCH 1200/1293] spec: node-integration should work in web-preferences --- spec/api-browser-window-spec.coffee | 39 ++++++++++++++++++++++------- spec/fixtures/api/blank.html | 5 ++++ spec/fixtures/api/preload.html | 2 +- spec/fixtures/module/send-later.js | 4 +++ 4 files changed, 40 insertions(+), 10 deletions(-) create mode 100644 spec/fixtures/api/blank.html create mode 100644 spec/fixtures/module/send-later.js diff --git a/spec/api-browser-window-spec.coffee b/spec/api-browser-window-spec.coffee index fa7a8ae33a9c..15cd621ba271 100644 --- a/spec/api-browser-window-spec.coffee +++ b/spec/api-browser-window-spec.coffee @@ -182,15 +182,36 @@ describe 'browser-window module', -> assert.equal after[0], size.width assert.equal after[1], size.height - describe '"preload" options', -> - it 'loads the script before other scripts in window', (done) -> - preload = path.join fixtures, 'module', 'set-global.js' - remote.require('ipc').once 'preload', (event, test) -> - assert.equal(test, 'preload') - done() - w.destroy() - w = new BrowserWindow(show: false, width: 400, height: 400, preload: preload) - w.loadUrl 'file://' + path.join(fixtures, 'api', 'preload.html') + describe '"web-preferences" option', -> + afterEach -> + remote.require('ipc').removeAllListeners('answer') + + describe '"preload" option', -> + it 'loads the script before other scripts in window', (done) -> + preload = path.join fixtures, 'module', 'set-global.js' + remote.require('ipc').once 'answer', (event, test) -> + assert.equal(test, 'preload') + done() + w.destroy() + w = new BrowserWindow + show: false + 'web-preferences': + preload: preload + w.loadUrl 'file://' + path.join(fixtures, 'api', 'preload.html') + + describe '"node-integration" option', -> + it 'disables node integration when specified to false', (done) -> + preload = path.join fixtures, 'module', 'send-later.js' + remote.require('ipc').once 'answer', (event, test) -> + assert.equal(test, 'undefined') + done() + w.destroy() + w = new BrowserWindow + show: false + 'web-preferences': + preload: preload + 'node-integration': false + w.loadUrl 'file://' + path.join(fixtures, 'api', 'blank.html') describe 'beforeunload handler', -> it 'returning true would not prevent close', (done) -> diff --git a/spec/fixtures/api/blank.html b/spec/fixtures/api/blank.html new file mode 100644 index 000000000000..accfb421446d --- /dev/null +++ b/spec/fixtures/api/blank.html @@ -0,0 +1,5 @@ + + + diff --git a/spec/fixtures/api/preload.html b/spec/fixtures/api/preload.html index 22dee23444fa..ece481f92413 100644 --- a/spec/fixtures/api/preload.html +++ b/spec/fixtures/api/preload.html @@ -3,7 +3,7 @@ diff --git a/spec/fixtures/module/send-later.js b/spec/fixtures/module/send-later.js new file mode 100644 index 000000000000..fce96b84b787 --- /dev/null +++ b/spec/fixtures/module/send-later.js @@ -0,0 +1,4 @@ +var ipc = require('ipc'); +window.onload = function() { + ipc.send('answer', typeof window.process); +} From 143453b603fd1378341d7ebcc198b00398fb1d25 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 10 Sep 2015 15:58:10 +0800 Subject: [PATCH 1201/1293] Update native-mate to fix the behavior of Dictionary::Get --- vendor/native_mate | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/native_mate b/vendor/native_mate index 8ca005eb4159..b7387da0854b 160000 --- a/vendor/native_mate +++ b/vendor/native_mate @@ -1 +1 @@ -Subproject commit 8ca005eb41591f583ebab804945311903f866ad6 +Subproject commit b7387da0854b20d376fdae0d93a01f83d080668d From ae2f754d104119aaceb804599571e2ef625d3428 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 10 Sep 2015 16:01:04 +0800 Subject: [PATCH 1202/1293] No need to set menu in spec window --- spec/static/main.js | 88 --------------------------------------------- 1 file changed, 88 deletions(-) diff --git a/spec/static/main.js b/spec/static/main.js index 1f6f9325e490..38ba7cc089de 100644 --- a/spec/static/main.js +++ b/spec/static/main.js @@ -2,7 +2,6 @@ var app = require('app'); var ipc = require('ipc'); var dialog = require('dialog'); var BrowserWindow = require('browser-window'); -var Menu = require('menu'); var window = null; process.port = 0; // will be used by crash-reporter spec. @@ -52,93 +51,6 @@ app.on('window-all-closed', function() { }); app.on('ready', function() { - var template = [ - { - label: 'Atom', - submenu: [ - { - label: 'Quit', - accelerator: 'CommandOrControl+Q', - click: function(item, window) { app.quit(); } - }, - ], - }, - { - label: 'Edit', - submenu: [ - { - label: 'Undo', - accelerator: 'CommandOrControl+Z', - selector: 'undo:', - }, - { - label: 'Redo', - accelerator: 'CommandOrControl+Shift+Z', - selector: 'redo:', - }, - { - type: 'separator', - }, - { - label: 'Cut', - accelerator: 'CommandOrControl+X', - selector: 'cut:', - }, - { - label: 'Copy', - accelerator: 'CommandOrControl+C', - selector: 'copy:', - }, - { - label: 'Paste', - accelerator: 'CommandOrControl+V', - selector: 'paste:', - }, - { - label: 'Select All', - accelerator: 'CommandOrControl+A', - selector: 'selectAll:', - }, - ] - }, - { - label: 'View', - submenu: [ - { - label: 'Reload', - accelerator: 'CommandOrControl+R', - click: function(item, window) { window.restart(); } - }, - { - label: 'Enter Fullscreen', - click: function(item, window) { window.setFullScreen(true); } - }, - { - label: 'Toggle DevTools', - accelerator: 'Alt+CommandOrControl+I', - click: function(item, window) { window.toggleDevTools(); } - }, - ] - }, - { - label: 'Window', - submenu: [ - { - label: 'Open', - accelerator: 'CommandOrControl+O', - }, - { - label: 'Close', - accelerator: 'CommandOrControl+W', - click: function(item, window) { window.close(); } - }, - ] - }, - ]; - - var menu = Menu.buildFromTemplate(template); - app.setApplicationMenu(menu); - // Test if using protocol module would crash. require('protocol').registerStringProtocol('test-if-crashes', function() {}); From 60522e0d68191df5cd331bcbe3ee5675c34553d2 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 10 Sep 2015 16:27:15 +0800 Subject: [PATCH 1203/1293] Bump v0.32.2 --- atom.gyp | 2 +- atom/browser/resources/mac/Info.plist | 2 +- atom/browser/resources/win/atom.rc | 8 ++++---- atom/common/atom_version.h | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/atom.gyp b/atom.gyp index c78fee1c8e60..5799a00171bc 100644 --- a/atom.gyp +++ b/atom.gyp @@ -4,7 +4,7 @@ 'product_name%': 'Electron', 'company_name%': 'GitHub, Inc', 'company_abbr%': 'github', - 'version%': '0.32.1', + 'version%': '0.32.2', }, 'includes': [ 'filenames.gypi', diff --git a/atom/browser/resources/mac/Info.plist b/atom/browser/resources/mac/Info.plist index 86eef9c09e78..2357054b98ea 100644 --- a/atom/browser/resources/mac/Info.plist +++ b/atom/browser/resources/mac/Info.plist @@ -17,7 +17,7 @@ CFBundleIconFile atom.icns CFBundleVersion - 0.32.1 + 0.32.2 LSMinimumSystemVersion 10.8.0 NSMainNibFile diff --git a/atom/browser/resources/win/atom.rc b/atom/browser/resources/win/atom.rc index bfb464b990a3..2431dcc00ea6 100644 --- a/atom/browser/resources/win/atom.rc +++ b/atom/browser/resources/win/atom.rc @@ -56,8 +56,8 @@ END // VS_VERSION_INFO VERSIONINFO - FILEVERSION 0,32,1,0 - PRODUCTVERSION 0,32,1,0 + FILEVERSION 0,32,2,0 + PRODUCTVERSION 0,32,2,0 FILEFLAGSMASK 0x3fL #ifdef _DEBUG FILEFLAGS 0x1L @@ -74,12 +74,12 @@ BEGIN BEGIN VALUE "CompanyName", "GitHub, Inc." VALUE "FileDescription", "Electron" - VALUE "FileVersion", "0.32.1" + VALUE "FileVersion", "0.32.2" VALUE "InternalName", "electron.exe" VALUE "LegalCopyright", "Copyright (C) 2015 GitHub, Inc. All rights reserved." VALUE "OriginalFilename", "electron.exe" VALUE "ProductName", "Electron" - VALUE "ProductVersion", "0.32.1" + VALUE "ProductVersion", "0.32.2" VALUE "SquirrelAwareVersion", "1" END END diff --git a/atom/common/atom_version.h b/atom/common/atom_version.h index c1d11c91dc87..1e60cb874b75 100644 --- a/atom/common/atom_version.h +++ b/atom/common/atom_version.h @@ -7,7 +7,7 @@ #define ATOM_MAJOR_VERSION 0 #define ATOM_MINOR_VERSION 32 -#define ATOM_PATCH_VERSION 1 +#define ATOM_PATCH_VERSION 2 #define ATOM_VERSION_IS_RELEASE 1 From 32a66fa94e6ef4633fefccd36fb7990a3b2bdb3f Mon Sep 17 00:00:00 2001 From: GoooIce Date: Thu, 10 Sep 2015 20:27:50 +0800 Subject: [PATCH 1204/1293] add api\shell.md add api\shell.md --- docs-translations/zh-CN/api/shell.md | 45 ++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 docs-translations/zh-CN/api/shell.md diff --git a/docs-translations/zh-CN/api/shell.md b/docs-translations/zh-CN/api/shell.md new file mode 100644 index 000000000000..a30334dcdc9c --- /dev/null +++ b/docs-translations/zh-CN/api/shell.md @@ -0,0 +1,45 @@ +# shell + +`shell` 模块提供了集成其他桌面客户端的关联功能. + + +在用户默认浏览器中打开URL的示例: + +```javascript +var shell = require('shell'); + +shell.openExternal('https://github.com'); +``` + +## Methods + +`shell` 模块包含以下函数: + +### `shell.showItemInFolder(fullPath)` + +* `fullPath` String + +打开文件所在文件夹,一般情况下还会选中它. + +### `shell.openItem(fullPath)` + +* `fullPath` String + +以默认打开方式打开文件. + +### `shell.openExternal(url)` + +* `url` String + +以系统默认设置打开外部协议.(例如,mailto: somebody@somewhere.io会打开用户默认的邮件客户端) + + +### `shell.moveItemToTrash(fullPath)` + +* `fullPath` String + +删除指定路径文件,并返回此操作的状态值(boolean类型). + +### `shell.beep()` + +播放 beep 声音. From 92f7899c60e3b9234c44ba71fa407be9029ae8fb Mon Sep 17 00:00:00 2001 From: GoooIce Date: Thu, 10 Sep 2015 22:29:22 +0800 Subject: [PATCH 1205/1293] Add api\global-shortcut.md Add api\global-shortcut.md --- .../zh-CN/api/global-shortcut.md | 60 +++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 docs-translations/zh-CN/api/global-shortcut.md diff --git a/docs-translations/zh-CN/api/global-shortcut.md b/docs-translations/zh-CN/api/global-shortcut.md new file mode 100644 index 000000000000..ff0b28832a10 --- /dev/null +++ b/docs-translations/zh-CN/api/global-shortcut.md @@ -0,0 +1,60 @@ +# global-shortcut + +`global-shortcut` 模块可以便捷的为您设置(注册/注销)各种自定义操作的快捷键. + +**Note**: 使用此模块注册的快捷键是系统全局的(QQ截图那种), 不要在应用模块(app module)响应 `ready` +消息前使用此模块(注册快捷键). + +```javascript +var app = require('app'); +var globalShortcut = require('global-shortcut'); + +app.on('ready', function() { + // Register a 'ctrl+x' shortcut listener. + var ret = globalShortcut.register('ctrl+x', function() { + console.log('ctrl+x is pressed'); + }) + + if (!ret) { + console.log('registration failed'); + } + + // Check whether a shortcut is registered. + console.log(globalShortcut.isRegistered('ctrl+x')); +}); + +app.on('will-quit', function() { + // Unregister a shortcut. + globalShortcut.unregister('ctrl+x'); + + // Unregister all shortcuts. + globalShortcut.unregisterAll(); +}); +``` + +## Methods + +`global-shortcut` 模块包含以下函数: + +### `globalShortcut.register(accelerator, callback)` + +* `accelerator` [Accelerator](accelerator.md) +* `callback` Function + +注册 `accelerator` 快捷键. 当用户按下注册的快捷键时将会调用 `callback` 函数. + +### `globalShortcut.isRegistered(accelerator)` + +* `accelerator` [Accelerator](accelerator.md) + +查询 `accelerator` 快捷键是否已经被注册过了,将会返回 `true`(已被注册) 或 `false`(未注册). + +### `globalShortcut.unregister(accelerator)` + +* `accelerator` [Accelerator](accelerator.md) + +注销全局快捷键 `accelerator`. + +### `globalShortcut.unregisterAll()` + +注销本应用注册的所有全局快捷键. From 9ca85a78598c27459c86a1013c037e78f7c91d13 Mon Sep 17 00:00:00 2001 From: Paul Betts Date: Thu, 10 Sep 2015 10:57:08 -0700 Subject: [PATCH 1206/1293] Fix electron-rebuild instructions for Win32 --- docs/tutorial/using-native-node-modules.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorial/using-native-node-modules.md b/docs/tutorial/using-native-node-modules.md index 4d61f70cf6db..35876ac230d8 100644 --- a/docs/tutorial/using-native-node-modules.md +++ b/docs/tutorial/using-native-node-modules.md @@ -31,7 +31,7 @@ which handles the manual steps of downloading headers and building native module npm install --save-dev electron-rebuild # Every time you run npm install, run this -./node_modules/.bin/electron-rebuild +npm run electron-rebuild ``` ### The node-gyp Way From 31775aa0493ad4d1edf7596dd94fd7d2e0b80572 Mon Sep 17 00:00:00 2001 From: Paul Betts Date: Thu, 10 Sep 2015 11:00:43 -0700 Subject: [PATCH 1207/1293] Fix harder --- docs/tutorial/using-native-node-modules.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorial/using-native-node-modules.md b/docs/tutorial/using-native-node-modules.md index 35876ac230d8..c338494cde2b 100644 --- a/docs/tutorial/using-native-node-modules.md +++ b/docs/tutorial/using-native-node-modules.md @@ -31,7 +31,7 @@ which handles the manual steps of downloading headers and building native module npm install --save-dev electron-rebuild # Every time you run npm install, run this -npm run electron-rebuild +node ./node_modules/.bin/electron-rebuild ``` ### The node-gyp Way From 2ac2392a6bfedd406446e9ad994923d2938697c8 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Thu, 10 Sep 2015 12:11:40 -0700 Subject: [PATCH 1208/1293] :fire: extra line --- docs/api/browser-window.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 58a708cfb193..a008baaec492 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -313,7 +313,6 @@ when the renderer process (web page) has crashed. ### `win.devToolsWebContents` - Get the `WebContents` of DevTools for this window. **Note:** Users should never store this object because it may become `null` From aae2d82c28022fa7655a53314299104e59293217 Mon Sep 17 00:00:00 2001 From: Jessica Lord Date: Thu, 10 Sep 2015 12:19:37 -0700 Subject: [PATCH 1209/1293] Update links to web-contents.md --- docs/api/browser-window.md | 2 +- docs/api/ipc-main-process.md | 2 +- docs/api/remote.md | 2 +- docs/api/web-view-tag.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 7aa97f75aec3..fb3e7fd40b38 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -263,7 +263,7 @@ Returns the window that is focused in this application. ### `BrowserWindow.fromWebContents(webContents)` -* `webContents` [WebContents](#webcontents) +* `webContents` [WebContents](web-contents.md) Find a window according to the `webContents` it owns. diff --git a/docs/api/ipc-main-process.md b/docs/api/ipc-main-process.md index 41d4d7125365..98d9c3c22d43 100644 --- a/docs/api/ipc-main-process.md +++ b/docs/api/ipc-main-process.md @@ -7,7 +7,7 @@ a renderer will be emitted to this module. ## Sending Messages It is also possible to send messages from the main process to the renderer -process, see [WebContents.send](browser-window.md#webcontents-send-channel-args) +process, see [WebContents.send](web-contents.md#webcontentssendchannel-args) for more information. - When sending a message, the event name is the `channel`. diff --git a/docs/api/remote.md b/docs/api/remote.md index 5a048fc0789f..1c5c831a1790 100644 --- a/docs/api/remote.md +++ b/docs/api/remote.md @@ -21,7 +21,7 @@ win.loadUrl('https://github.com'); ``` **Note:** for the reverse (access the renderer process from the main process), -you can use [webContents.executeJavascript](browser-window.md#webcontents-executejavascript-code). +you can use [webContents.executeJavascript](web-contents.md#webcontentsexecutejavascriptcode-usergesture). ## Remote Objects diff --git a/docs/api/web-view-tag.md b/docs/api/web-view-tag.md index fed2bd144b9a..4647413b5a43 100644 --- a/docs/api/web-view-tag.md +++ b/docs/api/web-view-tag.md @@ -355,7 +355,7 @@ Prints webview's web page as PDF, Same with `webContents.printToPDF(options, cal Send `args..` to guest page via `channel` in asynchronous message, the guest page can handle it by listening to the `channel` event of `ipc` module. -See [WebContents.send](browser-window.md#webcontentssendchannel-args) for +See [WebContents.send](web-contents.md#webcontentssendchannel-args) for examples. ## DOM events From c3664463ab1a4c29fe41ea3e1be0ee90630bd9d3 Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Fri, 11 Sep 2015 11:56:36 +0900 Subject: [PATCH 1210/1293] Update as upstream, fix typos --- README-ko.md | 6 +++++- docs-translations/ko/README.md | 20 +++++++++---------- docs-translations/ko/api/auto-updater.md | 2 +- docs-translations/ko/api/ipc-main-process.md | 2 +- docs-translations/ko/api/remote.md | 2 +- docs-translations/ko/api/web-view-tag.md | 13 ++++++------ docs-translations/ko/api/window-open.md | 4 ++-- docs-translations/ko/styleguide.md | 15 +++++++++++++- .../ko/tutorial/online-offline-events.md | 2 +- .../ko/tutorial/using-native-node-modules.md | 5 +++-- 10 files changed, 45 insertions(+), 26 deletions(-) diff --git a/README-ko.md b/README-ko.md index 9ce6748fc871..83634370eba9 100644 --- a/README-ko.md +++ b/README-ko.md @@ -49,6 +49,10 @@ Electron을 빌드 하는 방법과 프로젝트에 기여하는 방법도 문 ## 커뮤니티 -[Atom 포럼내의 `electron` 카테고리](http://discuss.atom.io/category/electron)와 Freenode `#atom-shell` 채팅 채널에서 활발하게 토론이 이어지고 있습니다. +다음 링크를 통해 커뮤니티에 질문을 올리거나 토론을 나누실 수 있습니다: + +- Atom 포럼의 [`electron`](http://discuss.atom.io/category/electron) 카테고리 +- Freenode 채팅의 `#atom-shell` 채널 +- Slack의 [`Atom`](http://atom-slack.herokuapp.com/) 채널 [awesome-electron](https://github.com/sindresorhus/awesome-electron) 프로젝트엔 커뮤니티가 운영중인 유용한 예제 어플리케이션과 도구, 리소스가 있으니 한번 참고해 보시기 바랍니다. diff --git a/docs-translations/ko/README.md b/docs-translations/ko/README.md index 2c75fa345cff..c79202b4ae89 100644 --- a/docs-translations/ko/README.md +++ b/docs-translations/ko/README.md @@ -2,7 +2,7 @@ * [어플리케이션 배포](tutorial/application-distribution.md) * [어플리케이션 패키징](tutorial/application-packaging.md) -* [네이티브 node 모듈 사용하기](tutorial/using-native-node-modules.md) +* [네이티브 Node 모듈 사용하기](tutorial/using-native-node-modules.md) * [메인 프로세스 디버깅하기](tutorial/debugging-main-process.md) * [Selenium 과 WebDriver 사용하기](tutorial/using-selenium-and-webdriver.md) * [개발자 콘솔 확장기능](tutorial/devtools-extension.md) @@ -12,21 +12,21 @@ * [시작하기](tutorial/quick-start.md) * [데스크톱 환경 통합](tutorial/desktop-environment-integration.md) -* [온라인/오프라인 이벤트](tutorial/online-offline-events.md) +* [온라인/오프라인 이벤트 감지](tutorial/online-offline-events.md) ## API 레퍼런스 * [개요](api/synopsis.md) -* [process](api/process.md) -* [크롬 Command-Line 스위치 지원](api/chrome-command-line-switches.md) +* [Process 객체](api/process.md) +* [크롬 Command Line 스위치 지원](api/chrome-command-line-switches.md) -커스텀 DOM elements: +### 커스텀 DOM elements: * [`File` 객체](api/file-object.md) * [`` 태그](api/web-view-tag.md) -* [`window.open` 메서드](api/window-open.md) +* [`window.open` 함수](api/window-open.md) -메인 프로세스를 위한 모듈들: +### 메인 프로세스를 위한 모듈들: * [app](api/app.md) * [auto-updater](api/auto-updater.md) @@ -41,16 +41,16 @@ * [power-save-blocker](api/power-save-blocker.md) * [protocol](api/protocol.md) * [session](api/session.md) -* [webContents](api/web-contents.md) +* [web-contents](api/web-contents.md) * [tray](api/tray.md) -랜더러 프로세스를 위한 모듈들 (웹 페이지): +### 랜더러 프로세스를 위한 모듈들 (웹 페이지): * [ipc (renderer)](api/ipc-renderer.md) * [remote](api/remote.md) * [web-frame](api/web-frame.md) -두 프로세스에서 모두 사용 가능한 모듈들: +### 두 프로세스에서 모두 사용 가능한 모듈들: * [clipboard](api/clipboard.md) * [crash-reporter](api/crash-reporter.md) diff --git a/docs-translations/ko/api/auto-updater.md b/docs-translations/ko/api/auto-updater.md index 1b586d5cdd5d..23f881c32ba8 100644 --- a/docs-translations/ko/api/auto-updater.md +++ b/docs-translations/ko/api/auto-updater.md @@ -38,7 +38,7 @@ Squirrel은 응답을 분석해야 할 책임이 있기 때문에 `Accept: appli 버전 식별자와 다른 기준을 특정하는 업데이트 요청 폼을 서버로 전달하기 위한 공통적인 방법으로 쿼리 인자를 사용하는 방법이 있습니다: ```javascript -// On the main process +// In the main process var app = require('app'); var autoUpdater = require('auto-updater'); autoUpdater.setFeedUrl('http://mycompany.com/myapp/latest?version=' + app.getVersion()); diff --git a/docs-translations/ko/api/ipc-main-process.md b/docs-translations/ko/api/ipc-main-process.md index 496afd203318..ad4e545ce474 100644 --- a/docs-translations/ko/api/ipc-main-process.md +++ b/docs-translations/ko/api/ipc-main-process.md @@ -6,7 +6,7 @@ ## 메시지 전송 물론 메인 프로세스에서 랜더러 프로세스로 메시지를 보내는 것도 가능합니다. -자세한 내용은 [WebContents.send](browser-window.md#webcontentssendchannel-args)를 참고하세요. +자세한 내용은 [WebContents.send](web-contents.md#webcontentssendchannel-args)를 참고하세요. - 메시지를 전송할 때 이벤트 이름은 `channel`이 됩니다. - 메시지에 동기로 응답할 땐 반드시 `event.returnValue`를 설정해야 합니다. diff --git a/docs-translations/ko/api/remote.md b/docs-translations/ko/api/remote.md index 34492a30556f..15c82ff0d21e 100644 --- a/docs-translations/ko/api/remote.md +++ b/docs-translations/ko/api/remote.md @@ -17,7 +17,7 @@ var win = new BrowserWindow({ width: 800, height: 600 }); win.loadUrl('https://github.com'); ``` -**참고:** 반대로 메인 프로세스에서 랜더러 프로세스에 접근 하려면 [webContents.executeJavascript](browser-window.md#webcontents-executejavascript-code) 메서드를 사용하면 됩니다. +**참고:** 반대로 메인 프로세스에서 랜더러 프로세스에 접근 하려면 [webContents.executeJavascript](web-contents.md#webcontentsexecutejavascriptcode-usergesture) 메서드를 사용하면 됩니다. ## Remote 객체 diff --git a/docs-translations/ko/api/web-view-tag.md b/docs-translations/ko/api/web-view-tag.md index b4af6d3ea87f..90f5acb9381f 100644 --- a/docs-translations/ko/api/web-view-tag.md +++ b/docs-translations/ko/api/web-view-tag.md @@ -139,7 +139,7 @@ `webview` 태그는 다음과 같은 메서드를 가지고 있습니다: -**참고:** Webview 메서드는 페이지 로드가 끝난 뒤에만 사용할 수 있습니다. +**참고:** 태그 객체의 메서드는 페이지 로드가 끝난 뒤에만 사용할 수 있습니다. **예제** ```javascript @@ -248,15 +248,15 @@ webview.addEventListener("dom-ready", function() { ### `.openDevTools()` -페이지에 대한 개발자 툴을 엽니다. +페이지에 대한 개발자 콘솔을 엽니다. ### `.closeDevTools()` -페이지에 대한 개발자 툴을 닫습니다. +페이지에 대한 개발자 콘솔을 닫습니다. ### `.isDevToolsOpened()` -페이지에 대한 개발자 툴이 열려있는지 확인합니다. 불린 값을 반환합니다. +페이지에 대한 개발자 콘솔이 열려있는지 확인합니다. 불린 값을 반환합니다. ### `.inspectElement(x, y)` @@ -267,7 +267,7 @@ webview.addEventListener("dom-ready", function() { ### `.inspectServiceWorker()` -Service worker에 대한 개발자 툴을 엽니다. +Service worker에 대한 개발자 콘솔을 엽니다. ### `.undo()` @@ -333,7 +333,7 @@ Webview 페이지를 PDF 형식으로 인쇄합니다. `webContents.printToPDF(o `channel`을 통해 페이지에 `args` 비동기 메시지를 보냅니다. 페이지에선 `ipc` 모듈의 `channel` 이벤트를 사용하면 이 메시지를 받을 수 있습니다. -예제는 [WebContents.send](browser-window.md#webcontentssendchannel-args)를 참고하세요. +예제는 [WebContents.send](web-contents.md#webcontentssendchannel-args)를 참고하세요. ## DOM 이벤트 @@ -360,6 +360,7 @@ Returns: * `errorCode` Integer * `errorDescription` String +* `validatedUrl` String `did-finish-load`와 비슷합니다. 하지만 이 이벤트는 `window.stop()`과 같은 무언가로 인해 로드에 실패했을 때 발생하는 이벤트입니다. diff --git a/docs-translations/ko/api/window-open.md b/docs-translations/ko/api/window-open.md index 4187672331f4..a4cf3bce5c93 100644 --- a/docs-translations/ko/api/window-open.md +++ b/docs-translations/ko/api/window-open.md @@ -1,6 +1,6 @@ -# `window.open` 메서드 +# `window.open` 함수 -`window.open` 메서드가 호출되면 새 창을 생성하고 `url` 페이지를 불러옵니다. +`window.open` 함수가 호출되면 새 창을 생성하고 `url` 페이지를 불러옵니다. 이 창은 지정한 `url`을 로드하여 만들어진 `BrowserWindow`의 새 인스턴스이며 본래 창 객체 대신 페이지의 컨트롤이 제한된 프록시 객체를 반환합니다. 프록시 객체는 브라우저의 웹 페이지 창과 호환될 수 있도록 일부 제한된 표준 기능만 가지고 있습니다. diff --git a/docs-translations/ko/styleguide.md b/docs-translations/ko/styleguide.md index 1168556a3d7b..aaa9274cd0b7 100644 --- a/docs-translations/ko/styleguide.md +++ b/docs-translations/ko/styleguide.md @@ -1,6 +1,6 @@ # Electron 문서 스타일 가이드 -[Electron 문서 읽기](#) 와 [Electron 문서 작성하기](#) 중 적당히 필요한 부분을 찾아 참고하세요: +[Electron 문서 읽기](#electron-문서-읽기) 와 [Electron 문서 작성하기](#electron-문서-작성하기) 중 이해가 필요한 부분을 찾아 참고하세요: ## Electron 문서 작성하기 @@ -22,6 +22,19 @@ Electron 문서를 작성하는 규칙은 다음과 같습니다. - 문장의 길이는 한 줄당 80 칸을 유지합니다. - 플랫폼 특정 메서드 헤더는 이탈릭체로 표시합니다. - ```### `method(foo, bar)` _OS X_``` +- 'on' 표현 대신 'in the ___ process' 형식의 표현을 지향합니다. + +### 번역된 참조 문서 + +번역된 Electron의 참조 문서는 `docs-translations` 디렉터리에 있습니다. + +아직 번역되지 않은 언어를 추가하려면 (일부분 포함): + +- 언어의 약어(예: en, ja, ko등)로 서브 디렉터리를 만듭니다. +- 서브 디렉터리에 `docs` 디렉터리를 복사합니다. 파일 이름과 디렉터리 구조는 모두 유지합니다. +- 문서를 번역합니다. +- `README.md`에 번역한 문서의 링크를 추가하고 업데이트 합니다. +- 메인 Electron의 [README](https://github.com/atom/electron#documentation-translations)에 번역된 디렉터리의 링크를 추가합니다. ## Electron 문서 읽기 diff --git a/docs-translations/ko/tutorial/online-offline-events.md b/docs-translations/ko/tutorial/online-offline-events.md index 57e0f48a3e0d..cc8ae4855d55 100644 --- a/docs-translations/ko/tutorial/online-offline-events.md +++ b/docs-translations/ko/tutorial/online-offline-events.md @@ -1,4 +1,4 @@ -# 온라인/오프라인 이벤트 +# 온라인/오프라인 이벤트 감지 온라인/오프라인 이벤트는 다음 예제와 같이 랜더러 프로세스에서 표준 HTML5 API를 이용하여 구현할 수 있습니다. diff --git a/docs-translations/ko/tutorial/using-native-node-modules.md b/docs-translations/ko/tutorial/using-native-node-modules.md index f9cb2be3bf53..913c300be881 100644 --- a/docs-translations/ko/tutorial/using-native-node-modules.md +++ b/docs-translations/ko/tutorial/using-native-node-modules.md @@ -19,13 +19,14 @@ Node v0.11.x 버전부터는 V8 API의 중대한 변경이 있었습니다. 하 ### 쉬운 방법 [`electron-rebuild`](https://github.com/paulcbetts/electron-rebuild) 패키지를 사용하면 빠르고 간단하게 네이티브 모듈을 다시 빌드할 수 있습니다. -간단한 절차를 통해 자동으로 헤더를 다운로드하고 네이티브 모듈을 빌드할 수 있습니다: + +다음 예제는 `electron-rebuild`를 통해 자동으로 모듈의 헤더를 다운로드하고 네이티브 모듈을 빌드합니다: ```sh npm install --save-dev electron-rebuild # 필요한 네이티브 모듈을 `npm install`로 설치한 후 다음 명령을 실행하세요: -./node_modules/.bin/electron-rebuild +node ./node_modules/.bin/electron-rebuild ``` ### node-gyp을 이용한 방법 From 750d3e979c04d3223f45137f57814003aec24cc2 Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Fri, 11 Sep 2015 13:30:37 +0900 Subject: [PATCH 1211/1293] Add session.md as translated, mark untranslated files in README.md --- docs-translations/ko/README.md | 6 +- docs-translations/ko/api/session.md | 187 ++++++++++++++++++++++++++++ 2 files changed, 190 insertions(+), 3 deletions(-) create mode 100644 docs-translations/ko/api/session.md diff --git a/docs-translations/ko/README.md b/docs-translations/ko/README.md index c79202b4ae89..2fb242fae906 100644 --- a/docs-translations/ko/README.md +++ b/docs-translations/ko/README.md @@ -28,9 +28,9 @@ ### 메인 프로세스를 위한 모듈들: -* [app](api/app.md) +* [app (0% 번역됨)](api/app.md) * [auto-updater](api/auto-updater.md) -* [browser-window](api/browser-window.md) +* [browser-window (0% 번역됨)](api/browser-window.md) * [content-tracing](api/content-tracing.md) * [dialog](api/dialog.md) * [global-shortcut](api/global-shortcut.md) @@ -41,7 +41,7 @@ * [power-save-blocker](api/power-save-blocker.md) * [protocol](api/protocol.md) * [session](api/session.md) -* [web-contents](api/web-contents.md) +* [web-contents (0% 번역됨)](api/web-contents.md) * [tray](api/tray.md) ### 랜더러 프로세스를 위한 모듈들 (웹 페이지): diff --git a/docs-translations/ko/api/session.md b/docs-translations/ko/api/session.md new file mode 100644 index 000000000000..cb912aabb100 --- /dev/null +++ b/docs-translations/ko/api/session.md @@ -0,0 +1,187 @@ +# session + +`session` 객체는 [`BrowserWindow`](browser-window.md)의 [`webContents`](web-contents.md)의 프로퍼티입니다. +다음과 같이 `BrowserWindow` 인스턴스에서 접근할 수 있습니다: + +```javascript +var BrowserWindow = require('browser-window'); + +var win = new BrowserWindow({ width: 800, height: 600 }); +win.loadUrl("http://github.com"); + +var session = win.webContents.session +``` + +## Events + +### Event: 'will-download' + +* `event` Event +* `item` Object + * `url` String + * `filename` String + * `mimeType` String + * `hasUserGesture` Boolean +* `webContents` [WebContents](web-contents.md) + +Electron의 `webContents`에서 `item`을 다운로드할 때 발생하는 이벤트입니다. + +`event.preventDefault()` 메서드를 호출하면 다운로드를 취소합니다. + +```javascript +session.on('will-download', function(event, item, webContents) { + event.preventDefault(); + require('request')(item.url, function(data) { + require('fs').writeFileSync('/somewhere', data); + }); +}); +``` + +## Methods + +`session` 객체는 다음과 같은 메서드와 속성을 가지고 있습니다: + +### `session.cookies` + +`cookies` 속성은 쿠키를 조작하는 방법을 제공합니다. 예를 들어 다음과 같이 할 수 있습니다: + +```javascript +var BrowserWindow = require('browser-window'); + +var win = new BrowserWindow({ width: 800, height: 600 }); + +win.loadUrl('https://github.com'); + +win.webContents.on('did-finish-load', function() { + // 모든 쿠키를 가져옵니다. + win.webContents.session.cookies.get({}, function(error, cookies) { + if (error) throw error; + console.log(cookies); + }); + + // Url에 관련된 쿠키를 모두 가져옵니다. + win.webContents.session.cookies.get({ url : "http://www.github.com" }, + function(error, cookies) { + if (error) throw error; + console.log(cookies); + }); + + // 지정한 쿠키 데이터를 설정합니다. + // 동일한 쿠키가 있으면 해당 쿠키를 덮어씁니다. + win.webContents.session.cookies.set( + { url : "http://www.github.com", name : "dummy_name", value : "dummy"}, + function(error, cookies) { + if (error) throw error; + console.log(cookies); + }); +}); +``` + +### `session.cookies.get(details, callback)` + +`details` Object, properties: + +* `url` String - `url`에 관련된 쿠키를 가져옵니다. 이 속성을 비워두면 모든 url의 쿠키를 가져옵니다. +* `name` String - 이름을 기준으로 쿠키를 필터링합니다. +* `domain` String - `domain`과 일치하는 도메인과 서브 도메인에 대한 쿠키를 가져옵니다. +* `path` String - `path`와 일치하는 경로에 대한 쿠키를 가져옵니다. +* `secure` Boolean - 보안 속성을 기준으로 쿠키를 필터링합니다. +* `session` Boolean - 세션 또는 영구 쿠키를 필터링합니다. + +* `callback` Function - function(error, cookies) +* `error` Error +* `cookies` Array - `cookie` 객체의 배열, 속성은 다음과 같습니다: + * `name` String - 쿠키의 이름. + * `value` String - 쿠키의 값. + * `domain` String - 쿠키의 도메인. + * `host_only` String - 쿠키가 호스트 전용인가에 대한 여부. + * `path` String - 쿠키의 경로. + * `secure` Boolean - 쿠키가 안전한 것으로 표시되는지에 대한 여부. (일반적으로 HTTPS) + * `http_only` Boolean - 쿠키가 HttpOnly로 표시되는지에 대한 여부. + * `session` Boolean - 쿠키가 세션 쿠키 또는 만료일이 있는 영구 쿠키인지에 대한 여부. + * `expirationDate` Double - (Option) UNIX 시간으로 표시되는 쿠키의 만료일에 대한 초 단위 시간. 세션 쿠키는 지원되지 않음. + +### `session.cookies.set(details, callback)` + +`details` Object, properties: + +* `url` String - `url`에 관련된 쿠키를 가져옵니다. +* `name` String - 쿠키의 이름입니다. 기본적으로 비워두면 생략됩니다. +* `value` String - 쿠키의 값입니다. 기본적으로 비워두면 생략됩니다. +* `domain` String - 쿠키의 도메인입니다. 기본적으로 비워두면 생략됩니다. +* `path` String - 쿠키의 경로입니다. 기본적으로 비워두면 생략됩니다. +* `secure` Boolean - 쿠키가 안전한 것으로 표시되는지에 대한 여부입니다. 기본값은 false입니다. +* `session` Boolean - 쿠키가 HttpOnly로 표시되는지에 대한 여부입니다. 기본값은 false입니다. +* `expirationDate` Double - UNIX 시간으로 표시되는 쿠키의 만료일에 대한 초 단위 시간입니다. 생략하면 쿠키는 세션 쿠키가 됩니다. + +* `callback` Function - function(error) + * `error` Error + +### `session.cookies.remove(details, callback)` + +* `details` Object, proprties: + * `url` String - 쿠키와 관련된 URL입니다. + * `name` String - 지울 쿠키의 이름입니다. +* `callback` Function - function(error) + * `error` Error + +### `session.clearCache(callback)` + +* `callback` Function - 작업이 완료되면 호출됩니다. + +세션의 HTTP 캐시를 비웁니다. + +### `session.clearStorageData([options, ]callback)` + +* `options` Object (optional), proprties: + * `origin` String - `scheme://host:port`와 같은 `window.location.origin` 규칙을 따르는 origin 문자열. + * `storages` Array - 비우려는 스토리지의 종류, 다음과 같은 타입을 포함할 수 있습니다: + `appcache`, `cookies`, `filesystem`, `indexdb`, `local storage`, + `shadercache`, `websql`, `serviceworkers` + * `quotas` Array - 비우려는 할당의 종류, 다음과 같은 타입을 포함할 수 있습니다: + `temporary`, `persistent`, `syncable`. +* `callback` Function - 작업이 완료되면 호출됩니다. + +웹 스토리지의 데이터를 비웁니다. + +### `session.setProxy(config, callback)` + +* `config` String +* `callback` Function - 작업이 완료되면 호출됩니다. + +세션에 사용할 프록시 `config`를 분석하고 프록시를 적용합니다. + +``` +config = scheme-proxies[";"] +scheme-proxies = ["="] +url-scheme = "http" | "https" | "ftp" | "socks" +proxy-uri-list = [","] +proxy-uri = ["://"][":"] + + 예시: + "http=foopy:80;ftp=foopy2" -- use HTTP proxy "foopy:80" for http:// + URLs, and HTTP proxy "foopy2:80" for + ftp:// URLs. + "foopy:80" -- use HTTP proxy "foopy:80" for all URLs. + "foopy:80,bar,direct://" -- use HTTP proxy "foopy:80" for all URLs, + failing over to "bar" if "foopy:80" is + unavailable, and after that using no + proxy. + "socks4://foopy" -- use SOCKS v4 proxy "foopy:1080" for all + URLs. + "http=foopy,socks5://bar.com -- use HTTP proxy "foopy" for http URLs, + and fail over to the SOCKS5 proxy + "bar.com" if "foopy" is unavailable. + "http=foopy,direct:// -- use HTTP proxy "foopy" for http URLs, + and use no proxy if "foopy" is + unavailable. + "http=foopy;socks=foopy2 -- use HTTP proxy "foopy" for http URLs, + and use socks4://foopy2 for all other + URLs. +``` + +### `session.setDownloadPath(path)` + +* `path` String - 다운로드 위치 + +다운로드 저장 위치를 지정합니다. 기본 다운로드 위치는 각 어플리케이션 데이터 디렉터리의 `Downloads` 폴더입니다. From ff67fae9ef8c53677bc36160e6a9b146c5f55178 Mon Sep 17 00:00:00 2001 From: GoooIce Date: Fri, 11 Sep 2015 17:27:20 +0800 Subject: [PATCH 1212/1293] Add api\accelerator.md Add api\accelerator.md --- docs-translations/zh-CN/api/accelerator.md | 46 ++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 docs-translations/zh-CN/api/accelerator.md diff --git a/docs-translations/zh-CN/api/accelerator.md b/docs-translations/zh-CN/api/accelerator.md new file mode 100644 index 000000000000..8858d18e856e --- /dev/null +++ b/docs-translations/zh-CN/api/accelerator.md @@ -0,0 +1,46 @@ +# Accelerator + +An accelerator is a string that represents a keyboard shortcut. It can contain +multiple modifiers and key codes, combined by the `+` character. + +Examples: + +* `Command+A` +* `Ctrl+Shift+Z` + +## Platform notice + +On Linux and Windows, the `Command` key does not have any effect so +use `CommandOrControl` which represents `Command` on OS X and `Control` on +Linux and Windows to define some accelerators. + +The `Super` key is mapped to the `Windows` key on Windows and Linux and +`Cmd` on OS X. + +## Available modifiers + +* `Command` (or `Cmd` for short) +* `Control` (or `Ctrl` for short) +* `CommandOrControl` (or `CmdOrCtrl` for short) +* `Alt` +* `Shift` +* `Super` + +## Available key codes + +* `0` to `9` +* `A` to `Z` +* `F1` to `F24` +* Punctuations like `~`, `!`, `@`, `#`, `$`, etc. +* `Plus` +* `Space` +* `Backspace` +* `Delete` +* `Insert` +* `Return` (or `Enter` as alias) +* `Up`, `Down`, `Left` and `Right` +* `Home` and `End` +* `PageUp` and `PageDown` +* `Escape` (or `Esc` for short) +* `VolumeUp`, `VolumeDown` and `VolumeMute` +* `MediaNextTrack`, `MediaPreviousTrack`, `MediaStop` and `MediaPlayPause` From af5262630a300a19f34b0f3b84d26a6a590f8c09 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tom=C3=A1=C5=A1=20Han=C3=A1=C4=8Dek?= Date: Fri, 11 Sep 2015 14:26:48 +0200 Subject: [PATCH 1213/1293] docs: Fix role hideothers, unhide typo --- docs/api/menu.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/menu.md b/docs/api/menu.md index 49d6361bcf0b..f48b07e7e40a 100644 --- a/docs/api/menu.md +++ b/docs/api/menu.md @@ -170,11 +170,11 @@ if (process.platform == 'darwin') { { label: 'Hide Others', accelerator: 'Command+Shift+H', - role: 'hideothers:' + role: 'hideothers' }, { label: 'Show All', - role: 'unhide:' + role: 'unhide' }, { type: 'separator' From 654626305c214b5eb3a0a47976bb677e52207da1 Mon Sep 17 00:00:00 2001 From: Jonatas Freitas Date: Fri, 11 Sep 2015 13:28:34 -0300 Subject: [PATCH 1214/1293] Documentation api/accelerator translated to pt-BR --- docs-translations/pt-BR/api/accelerator.md | 46 ++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 docs-translations/pt-BR/api/accelerator.md diff --git a/docs-translations/pt-BR/api/accelerator.md b/docs-translations/pt-BR/api/accelerator.md new file mode 100644 index 000000000000..87987258b11c --- /dev/null +++ b/docs-translations/pt-BR/api/accelerator.md @@ -0,0 +1,46 @@ +# Acelerador (teclas de atalhos) + +Um acelerador é uma string que representa um atalho de tecla. Isso pode conter +multiplos modificadores e códigos chaves, combinado pelo caracter `+`. + +Exemplos: + +* `Command+A` +* `Ctrl+Shift+Z` + +## Aviso sobre plataformas + +No Linux e no Windows a tecla `Command` não tem nenhum efeito, +então use `CommandOrControl` que representa a tecla `Command` existente no OSX e +`Control` no Linux e no Windows para definir aceleradores (atalhos). + +A chave `Super` está mapeada para a tecla `Windows` para Windows e Linux, +e para a tecla `Cmd` para OSX. + +## Modificadores disponiveis + +* `Command` (ou `Cmd` abreviado) +* `Control` (ou `Ctrl` abreviado) +* `CommandOrControl` (ou `CmdOrCtrl` abreviado) +* `Alt` +* `Shift` +* `Super` + +## Códigos chaves disponiveis + +* `0` to `9` +* `A` to `Z` +* `F1` to `F24` +* Punctuations like `~`, `!`, `@`, `#`, `$`, etc. +* `Plus` +* `Space` +* `Backspace` +* `Delete` +* `Insert` +* `Return` (or `Enter` as alias) +* `Up`, `Down`, `Left` and `Right` +* `Home` and `End` +* `PageUp` and `PageDown` +* `Escape` (or `Esc` for short) +* `VolumeUp`, `VolumeDown` and `VolumeMute` +* `MediaNextTrack`, `MediaPreviousTrack`, `MediaStop` and `MediaPlayPause` \ No newline at end of file From e388163d33d625eec235943abfff299cc68b10c0 Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Mon, 14 Sep 2015 08:07:24 +0900 Subject: [PATCH 1215/1293] Update as upstream --- docs-translations/ko/api/menu.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs-translations/ko/api/menu.md b/docs-translations/ko/api/menu.md index 89abcf289a78..a8ac499f5768 100644 --- a/docs-translations/ko/api/menu.md +++ b/docs-translations/ko/api/menu.md @@ -164,11 +164,11 @@ if (process.platform == 'darwin') { { label: 'Hide Others', accelerator: 'Command+Shift+H', - role: 'hideothers:' + role: 'hideothers' }, { label: 'Show All', - role: 'unhide:' + role: 'unhide' }, { type: 'separator' From 7c3d3e4a87b6022ac41359bd536982b40e133627 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 14 Sep 2015 15:46:46 +0800 Subject: [PATCH 1216/1293] Update node to pass all globals through "require" --- vendor/node | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/node b/vendor/node index 9da7dd871c31..fdb584a0b42e 160000 --- a/vendor/node +++ b/vendor/node @@ -1 +1 @@ -Subproject commit 9da7dd871c313d318bc1447a83ba3c7618bbbc18 +Subproject commit fdb584a0b42e89885f74ed68f279318b0fbff37f From 3bd16a5ecd0cac121db3465eb1d51dbfaea623d1 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 14 Sep 2015 15:47:39 +0800 Subject: [PATCH 1217/1293] No more need to override setImmediate It is now done in Node.js. --- atom/common/lib/init.coffee | 2 -- 1 file changed, 2 deletions(-) diff --git a/atom/common/lib/init.coffee b/atom/common/lib/init.coffee index 88b32d8c0254..48f06b93f659 100644 --- a/atom/common/lib/init.coffee +++ b/atom/common/lib/init.coffee @@ -37,8 +37,6 @@ wrapWithActivateUvLoop = (func) -> process.activateUvLoop() func.apply this, arguments process.nextTick = wrapWithActivateUvLoop process.nextTick -global.setImmediate = wrapWithActivateUvLoop timers.setImmediate -global.clearImmediate = timers.clearImmediate # setTimeout needs to update the polling timeout of the event loop, when called # under Chromium's event loop the node's event loop won't get a chance to update From baacc939f673a7632ee4086878b1098ca33a8d33 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 14 Sep 2015 16:05:58 +0800 Subject: [PATCH 1218/1293] spec: node symbols should always be available in preload script --- spec/fixtures/module/preload-node-off.js | 7 +++++++ spec/webview-spec.coffee | 8 ++++++++ 2 files changed, 15 insertions(+) create mode 100644 spec/fixtures/module/preload-node-off.js diff --git a/spec/fixtures/module/preload-node-off.js b/spec/fixtures/module/preload-node-off.js new file mode 100644 index 000000000000..9020f4513a10 --- /dev/null +++ b/spec/fixtures/module/preload-node-off.js @@ -0,0 +1,7 @@ +setImmediate(function() { + try { + console.log([typeof process, typeof setImmediate, typeof global].join(' ')); + } catch (e) { + console.log(e.message); + } +}); diff --git a/spec/webview-spec.coffee b/spec/webview-spec.coffee index 3eeacb0ad0e5..e5a97e65fc02 100644 --- a/spec/webview-spec.coffee +++ b/spec/webview-spec.coffee @@ -84,6 +84,14 @@ describe ' tag', -> webview.src = "file://#{fixtures}/pages/e.html" document.body.appendChild webview + it 'preload script can still use "process" in required modules when nodeintegration is off', (done) -> + webview.addEventListener 'console-message', (e) -> + assert.equal e.message, 'object function object' + done() + webview.setAttribute 'preload', "#{fixtures}/module/preload-node-off.js" + webview.src = "file://#{fixtures}/api/blank.html" + document.body.appendChild webview + it 'receives ipc message in preload script', (done) -> message = 'boom!' listener = (e) -> From d2e52fb6bb037b5fae362ac260670f2fdbdcbfdf Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 14 Sep 2015 16:25:43 +0800 Subject: [PATCH 1219/1293] Set global.setImmediate --- atom/common/lib/init.coffee | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/atom/common/lib/init.coffee b/atom/common/lib/init.coffee index 48f06b93f659..cde0ea3075f5 100644 --- a/atom/common/lib/init.coffee +++ b/atom/common/lib/init.coffee @@ -38,10 +38,15 @@ wrapWithActivateUvLoop = (func) -> func.apply this, arguments process.nextTick = wrapWithActivateUvLoop process.nextTick -# setTimeout needs to update the polling timeout of the event loop, when called -# under Chromium's event loop the node's event loop won't get a chance to update -# the timeout, so we have to force the node's event loop to recalculate the -# timeout in browser process. if process.type is 'browser' + # setTimeout needs to update the polling timeout of the event loop, when + # called under Chromium's event loop the node's event loop won't get a chance + # to update the timeout, so we have to force the node's event loop to + # recalculate the timeout in browser process. global.setTimeout = wrapWithActivateUvLoop timers.setTimeout global.setInterval = wrapWithActivateUvLoop timers.setInterval +else + # There are no setImmediate under renderer process by default, so we need to + # manually setup them here. + global.setImmediate = setImmediate + global.clearImmediate = clearImmediate From 9d366e6c5c4db74969d7189fd2dbfb1ec9310419 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 14 Sep 2015 16:34:58 +0800 Subject: [PATCH 1220/1293] Make global.setImmediate work in browser process --- atom/common/lib/init.coffee | 2 ++ 1 file changed, 2 insertions(+) diff --git a/atom/common/lib/init.coffee b/atom/common/lib/init.coffee index cde0ea3075f5..4bc3e36986c0 100644 --- a/atom/common/lib/init.coffee +++ b/atom/common/lib/init.coffee @@ -45,6 +45,8 @@ if process.type is 'browser' # recalculate the timeout in browser process. global.setTimeout = wrapWithActivateUvLoop timers.setTimeout global.setInterval = wrapWithActivateUvLoop timers.setInterval + global.setImmediate = wrapWithActivateUvLoop timers.setImmediate + global.clearImmediate = wrapWithActivateUvLoop timers.clearImmediate else # There are no setImmediate under renderer process by default, so we need to # manually setup them here. From c346fcb326639fb4d7eea65c289b3720c37ae01a Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 14 Sep 2015 17:02:24 +0800 Subject: [PATCH 1221/1293] Emit browser-window-created when window is created --- atom/browser/api/lib/browser-window.coffee | 3 +++ 1 file changed, 3 insertions(+) diff --git a/atom/browser/api/lib/browser-window.coffee b/atom/browser/api/lib/browser-window.coffee index 283e99641f47..2a92cfc55f88 100644 --- a/atom/browser/api/lib/browser-window.coffee +++ b/atom/browser/api/lib/browser-window.coffee @@ -45,6 +45,9 @@ BrowserWindow::_init = -> @on 'focus', (event) => app.emit 'browser-window-focus', event, this + # Notify the creation of the window. + app.emit 'browser-window-created', {}, this + BrowserWindow.getFocusedWindow = -> windows = BrowserWindow.getAllWindows() return window for window in windows when window.isFocused() From 8534ff452605ba17def4747d2aeb1f8da5568c92 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 14 Sep 2015 17:02:36 +0800 Subject: [PATCH 1222/1293] docs: browser-window-created event --- docs/api/app.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/api/app.md b/docs/api/app.md index 42a5dfc24249..799db98882fe 100644 --- a/docs/api/app.md +++ b/docs/api/app.md @@ -118,6 +118,15 @@ Returns: Emitted when a [browserWindow](browser-window.md) gets focused. +### Event: 'browser-window-created' + +Returns: + +* `event` Event +* `window` BrowserWindow + +Emitted when a new [browserWindow](browser-window.md) is created. + ### Event: 'select-certificate' Emitted when a client certificate is requested. From ca8943c4ba75b7c4abce1235bb7ddba747409100 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 14 Sep 2015 17:02:45 +0800 Subject: [PATCH 1223/1293] spec: browser-window-created event --- spec/api-app-spec.coffee | 29 ++++++++++++++++++++--------- 1 file changed, 20 insertions(+), 9 deletions(-) diff --git a/spec/api-app-spec.coffee b/spec/api-app-spec.coffee index 5c6591cadf50..38ef22ac80bd 100644 --- a/spec/api-app-spec.coffee +++ b/spec/api-app-spec.coffee @@ -26,19 +26,30 @@ describe 'app module', -> assert.equal app.getName(), 'test-name' app.setName 'Electron Test' - describe 'focus/blur event', -> + describe 'BrowserWindow events', -> w = null - beforeEach -> - w.destroy() if w? - w = new BrowserWindow(show: false, width: 400, height: 400) afterEach -> w.destroy() if w? w = null - it 'should emit focus event', (done) -> + + it 'should emit browser-window-focus event when window is focused', (done) -> + app.once 'browser-window-focus', (e, window) -> + assert.equal w.id, window.id + done() + w = new BrowserWindow(show: false) + w.emit 'focus' + + it 'should emit browser-window-blur event when window is blured', (done) -> app.once 'browser-window-blur', (e, window) -> assert.equal w.id, window.id done() - app.once 'browser-window-focus', (e, window) -> - assert.equal w.id, window.id - w.emit 'blur' - w.emit 'focus' + w = new BrowserWindow(show: false) + w.emit 'blur' + + it 'should emit browser-window-created event when window is created', (done) -> + app.once 'browser-window-created', (e, window) -> + setImmediate -> + assert.equal w.id, window.id + done() + w = new BrowserWindow(show: false) + w.emit 'blur' From 4d28fbf5612d94d376f801b1a716488971baf640 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 14 Sep 2015 19:24:54 +0800 Subject: [PATCH 1224/1293] Update brightray for atom/brightray#140 --- vendor/brightray | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/brightray b/vendor/brightray index 9b3695cfd5c4..1cfc13fec13a 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit 9b3695cfd5c48a4cdc90e84a863851001ce8dd10 +Subproject commit 1cfc13fec13a36f3682ee702c32dc2cf22363143 From 3ad5d17612fe7df0ad3db230d03fee8a120bc8e8 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Mon, 14 Sep 2015 19:28:13 +0800 Subject: [PATCH 1225/1293] [OS X] Implement 'activate-with-open-windows' event for app. --- atom/browser/api/atom_api_app.cc | 4 ++++ atom/browser/api/atom_api_app.h | 1 + atom/browser/browser.cc | 4 ++++ atom/browser/browser.h | 3 +++ atom/browser/browser_observer.h | 4 ++++ atom/browser/mac/atom_application_delegate.mm | 1 + docs/api/app.md | 5 +++++ 7 files changed, 22 insertions(+) diff --git a/atom/browser/api/atom_api_app.cc b/atom/browser/api/atom_api_app.cc index e2d265c5da39..f7c20483b490 100644 --- a/atom/browser/api/atom_api_app.cc +++ b/atom/browser/api/atom_api_app.cc @@ -171,6 +171,10 @@ void App::OnActivateWithNoOpenWindows() { Emit("activate-with-no-open-windows"); } +void App::OnActivateWithOpenWindows() { + Emit("activate-with-open-windows"); +} + void App::OnWillFinishLaunching() { Emit("will-finish-launching"); } diff --git a/atom/browser/api/atom_api_app.h b/atom/browser/api/atom_api_app.h index 040f7e3363a9..5f29744e919b 100644 --- a/atom/browser/api/atom_api_app.h +++ b/atom/browser/api/atom_api_app.h @@ -42,6 +42,7 @@ class App : public mate::EventEmitter, void OnOpenFile(bool* prevent_default, const std::string& file_path) override; void OnOpenURL(const std::string& url) override; void OnActivateWithNoOpenWindows() override; + void OnActivateWithOpenWindows() override; void OnWillFinishLaunching() override; void OnFinishLaunching() override; void OnSelectCertificate( diff --git a/atom/browser/browser.cc b/atom/browser/browser.cc index 3419ecbe330d..11530375eff8 100644 --- a/atom/browser/browser.cc +++ b/atom/browser/browser.cc @@ -98,6 +98,10 @@ void Browser::ActivateWithNoOpenWindows() { FOR_EACH_OBSERVER(BrowserObserver, observers_, OnActivateWithNoOpenWindows()); } +void Browser::ActivateWithOpenWindows() { + FOR_EACH_OBSERVER(BrowserObserver, observers_, OnActivateWithOpenWindows()); +} + void Browser::WillFinishLaunching() { FOR_EACH_OBSERVER(BrowserObserver, observers_, OnWillFinishLaunching()); } diff --git a/atom/browser/browser.h b/atom/browser/browser.h index dc412cefb046..43b253c840a8 100644 --- a/atom/browser/browser.h +++ b/atom/browser/browser.h @@ -111,6 +111,9 @@ class Browser : public WindowListObserver { // Tell the application that application is activated with no open windows. void ActivateWithNoOpenWindows(); + // Tell the application that application is activated with open windows. + void ActivateWithOpenWindows(); + // Tell the application the loading has been done. void WillFinishLaunching(); void DidFinishLaunching(); diff --git a/atom/browser/browser_observer.h b/atom/browser/browser_observer.h index 20fd08a2e911..815d21bb843f 100644 --- a/atom/browser/browser_observer.h +++ b/atom/browser/browser_observer.h @@ -47,6 +47,10 @@ class BrowserObserver { // dock icon). virtual void OnActivateWithNoOpenWindows() {} + // The browser is activated with open windows (usually by clicking on the dock + // icon). + virtual void OnActivateWithOpenWindows() {} + // The browser has finished loading. virtual void OnWillFinishLaunching() {} virtual void OnFinishLaunching() {} diff --git a/atom/browser/mac/atom_application_delegate.mm b/atom/browser/mac/atom_application_delegate.mm index 16dcf6fd9523..0ee46e59e6ec 100644 --- a/atom/browser/mac/atom_application_delegate.mm +++ b/atom/browser/mac/atom_application_delegate.mm @@ -53,6 +53,7 @@ hasVisibleWindows:(BOOL)flag { atom::Browser* browser = atom::Browser::Get(); if (flag) { + browser->ActivateWithOpenWindows(); return YES; } else { browser->ActivateWithNoOpenWindows(); diff --git a/docs/api/app.md b/docs/api/app.md index 799db98882fe..bb77a32913fc 100644 --- a/docs/api/app.md +++ b/docs/api/app.md @@ -100,6 +100,11 @@ Emitted when the application is activated while there are no open windows, which usually happens when the user has closed all of the application's windows and then clicks on the application's dock icon. +### Event: activated-with-open-windows _OS X_ + +Emitted when the application is activated while there are open windows, which +usually happens when clicks on the applications's dock icon. + ### Event: 'browser-window-blur' Returns: From c006c4efa422032e05b06f469f269ce8e4aa4ec2 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Mon, 14 Sep 2015 20:34:45 +0800 Subject: [PATCH 1226/1293] Mention 'activate-with-no-open-windows' on OS X only. --- docs/api/app.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/app.md b/docs/api/app.md index bb77a32913fc..12be27ce75fc 100644 --- a/docs/api/app.md +++ b/docs/api/app.md @@ -94,7 +94,7 @@ must be registered to be opened by your application. You should call `event.preventDefault()` if you want to handle this event. -### Event: 'activate-with-no-open-windows' +### Event: 'activate-with-no-open-windows' _OS X_ Emitted when the application is activated while there are no open windows, which usually happens when the user has closed all of the application's windows and From 409b0b54e0861643f9d5cc287c6ede69f1c9931f Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 14 Sep 2015 21:13:24 +0800 Subject: [PATCH 1227/1293] spec: Increate timeout for webview tests --- spec/webview-spec.coffee | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/spec/webview-spec.coffee b/spec/webview-spec.coffee index e5a97e65fc02..ddb203399b8e 100644 --- a/spec/webview-spec.coffee +++ b/spec/webview-spec.coffee @@ -3,13 +3,13 @@ path = require 'path' http = require 'http' describe ' tag', -> + @timeout 10000 + fixtures = path.join __dirname, 'fixtures' webview = null - beforeEach -> webview = new WebView - afterEach -> document.body.removeChild webview From 5d8f1dd4041a15b351276ad0e7f3a26accc17fe7 Mon Sep 17 00:00:00 2001 From: jaanus Date: Mon, 14 Sep 2015 14:15:41 +0200 Subject: [PATCH 1228/1293] =?UTF-8?q?Implements=20#2734=20=E2=80=9CNew=20A?= =?UTF-8?q?PI=20to=20configure=20BrowserWindow=20title=20bar=20on=20Mac?= =?UTF-8?q?=E2=80=9D?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit New API supported on Yosemite 10.10 and newer. --- atom/browser/native_window_mac.mm | 25 +++++++++++++++++++++++++ atom/common/options_switches.cc | 3 +++ atom/common/options_switches.h | 1 + docs/api/browser-window.md | 10 ++++++++++ docs/api/frameless-window.md | 14 ++++++++++++++ spec/api-browser-window-spec.coffee | 17 +++++++++++++++++ 6 files changed, 70 insertions(+) diff --git a/atom/browser/native_window_mac.mm b/atom/browser/native_window_mac.mm index 64f7c11f997b..9555914c899d 100644 --- a/atom/browser/native_window_mac.mm +++ b/atom/browser/native_window_mac.mm @@ -357,6 +357,17 @@ NativeWindowMac::NativeWindowMac( styleMask |= NSTexturedBackgroundWindowMask; } + std::string titleBarStyle = "default"; + options.Get(switches::kTitleBarStyle, &titleBarStyle); + + if (base::mac::IsOSYosemiteOrLater()) { + // New title bar styles are available in Yosemite or newer + if ((titleBarStyle == "hidden") || (titleBarStyle == "hidden-inset")) { + styleMask |= NSFullSizeContentViewWindowMask; + styleMask |= NSUnifiedTitleAndToolbarWindowMask; + } + } + window_.reset([[AtomNSWindow alloc] initWithContentRect:cocoa_bounds styleMask:styleMask @@ -382,6 +393,20 @@ NativeWindowMac::NativeWindowMac( // We will manage window's lifetime ourselves. [window_ setReleasedWhenClosed:NO]; + // Configure title bar look on Yosemite or newer + if (base::mac::IsOSYosemiteOrLater()) { + if ((titleBarStyle == "hidden") || (titleBarStyle == "hidden-inset")) { + [window_ setTitlebarAppearsTransparent:YES]; + [window_ setTitleVisibility:NSWindowTitleHidden]; + if (titleBarStyle == "hidden-inset") { + NSToolbar *toolbar = [[NSToolbar alloc] initWithIdentifier:@"titlebarStylingToolbar"]; + toolbar.showsBaselineSeparator = NO; + [window_ setToolbar:toolbar]; + [toolbar release]; + } + } + } + // On OS X the initial window size doesn't include window frame. bool use_content_size = false; options.Get(switches::kUseContentSize, &use_content_size); diff --git a/atom/common/options_switches.cc b/atom/common/options_switches.cc index ce5398e447f6..c70e1ba4afa6 100644 --- a/atom/common/options_switches.cc +++ b/atom/common/options_switches.cc @@ -42,6 +42,9 @@ const char kAcceptFirstMouse[] = "accept-first-mouse"; // Whether window size should include window frame. const char kUseContentSize[] = "use-content-size"; +// The requested title bar style for the window +const char kTitleBarStyle[] = "title-bar-style"; + // The WebPreferences. const char kWebPreferences[] = "web-preferences"; diff --git a/atom/common/options_switches.h b/atom/common/options_switches.h index c9298618bdfb..e62f3116661a 100644 --- a/atom/common/options_switches.h +++ b/atom/common/options_switches.h @@ -30,6 +30,7 @@ extern const char kAlwaysOnTop[]; extern const char kNodeIntegration[]; extern const char kAcceptFirstMouse[]; extern const char kUseContentSize[]; +extern const char kTitleBarStyle[]; extern const char kWebPreferences[]; extern const char kZoomFactor[]; extern const char kAutoHideMenuBar[]; diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 785980f08082..a9f046774af6 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -70,6 +70,16 @@ Properties `width` and `height` are required. Linux. * `standard-window` Boolean - Uses the OS X's standard window instead of the textured window. Defaults to `true`. +* `title-bar-style` String, OS X - specifies the style of window title bar. + This option is supported on OS X 10.10 Yosemite and newer. There are three + possible values: + * `default` or not specified results in the standard gray opaque Mac title + bar. + * `hidden` results in a hidden title bar and a full size content window, yet + the title bar still has the standard window controls ("traffic lights") in + the top left. + * `hidden-inset` results in a hidden title bar with an alternative look + where the traffic light buttons are slightly more inset from the window edge. * `web-preferences` Object - Settings of web page's features, properties: * `node-integration` Boolean - Whether node integration is enabled. Default is `true`. diff --git a/docs/api/frameless-window.md b/docs/api/frameless-window.md index a326bbd8c196..8d64a6fcd7c8 100644 --- a/docs/api/frameless-window.md +++ b/docs/api/frameless-window.md @@ -13,6 +13,20 @@ var BrowserWindow = require('browser-window'); var win = new BrowserWindow({ width: 800, height: 600, frame: false }); ``` +### Alternatives on Mac + +On Mac OS X 10.10 Yosemite and newer, there's an alternative way to specify +a chromeless window. Instead of setting `frame` to `false` which disables +both the titlebar and window controls, you may want to have the title bar +hidden and your content extend to the full window size, yet still preserve +the window controls ("traffic lights") for standard window actions. +You can do so by specifying the new `title-bar-style` option: + +```javascript +var BrowserWindow = require('browser-window'); +var win = new BrowserWindow({ width: 800, height: 600, 'title-bar-style': 'hidden' }); +``` + ## Transparent window By setting the `transparent` option to `true`, you can also make the frameless diff --git a/spec/api-browser-window-spec.coffee b/spec/api-browser-window-spec.coffee index 15cd621ba271..3e4e2d5db5e2 100644 --- a/spec/api-browser-window-spec.coffee +++ b/spec/api-browser-window-spec.coffee @@ -4,6 +4,7 @@ path = require 'path' remote = require 'remote' http = require 'http' url = require 'url' +os = require 'os' BrowserWindow = remote.require 'browser-window' @@ -160,6 +161,22 @@ describe 'browser-window module', -> assert.equal size[0], 400 assert.equal size[1], 400 + describe '"title-bar-style" option', -> + return if process.platform isnt 'darwin' + return if parseInt(os.release().split('.')[0]) < 14 # only run these tests on Yosemite or newer + + it 'creates browser window with hidden title bar', -> + w.destroy() + w = new BrowserWindow(show: false, width: 400, height: 400, 'title-bar-style': 'hidden') + contentSize = w.getContentSize() + assert.equal contentSize[1], 400 + + it 'creates browser window with hidden inset title bar', -> + w.destroy() + w = new BrowserWindow(show: false, width: 400, height: 400, 'title-bar-style': 'hidden-inset') + contentSize = w.getContentSize() + assert.equal contentSize[1], 400 + describe '"enable-larger-than-screen" option', -> return if process.platform is 'linux' From a5dc911a057f897c1ae915db27a69ed3e6789682 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 14 Sep 2015 22:49:22 +0800 Subject: [PATCH 1229/1293] Correctly set user agent for devtools --- atom/app/atom_content_client.cc | 8 ++++++++ atom/app/atom_content_client.h | 1 + 2 files changed, 9 insertions(+) diff --git a/atom/app/atom_content_client.cc b/atom/app/atom_content_client.cc index 1ba1f2031564..e760c01453d4 100644 --- a/atom/app/atom_content_client.cc +++ b/atom/app/atom_content_client.cc @@ -7,6 +7,7 @@ #include #include +#include "atom/common/atom_version.h" #include "atom/common/chrome_version.h" #include "atom/common/options_switches.h" #include "base/command_line.h" @@ -14,6 +15,7 @@ #include "base/strings/string_util.h" #include "content/public/common/content_constants.h" #include "content/public/common/pepper_plugin_info.h" +#include "content/public/common/user_agent.h" #include "ppapi/shared_impl/ppapi_permissions.h" namespace atom { @@ -72,6 +74,12 @@ std::string AtomContentClient::GetProduct() const { return "Chrome/" CHROME_VERSION_STRING; } +std::string AtomContentClient::GetUserAgent() const { + return content::BuildUserAgentFromProduct( + "Chrome/" CHROME_VERSION_STRING " " + ATOM_PRODUCT_NAME "/" ATOM_VERSION_STRING); +} + void AtomContentClient::AddAdditionalSchemes( std::vector* standard_schemes, std::vector* savable_schemes) { diff --git a/atom/app/atom_content_client.h b/atom/app/atom_content_client.h index 279ec7179f49..a6b2f73e7faa 100644 --- a/atom/app/atom_content_client.h +++ b/atom/app/atom_content_client.h @@ -20,6 +20,7 @@ class AtomContentClient : public brightray::ContentClient { protected: // content::ContentClient: std::string GetProduct() const override; + std::string GetUserAgent() const override; void AddAdditionalSchemes( std::vector* standard_schemes, std::vector* savable_schemes) override; From f140f35910b2c3d1270f3678e8785eb7d3b33aaf Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Mon, 14 Sep 2015 22:47:20 +0800 Subject: [PATCH 1230/1293] Expose experiment APIs --- atom/browser/lib/chrome-extension.coffee | 1 + 1 file changed, 1 insertion(+) diff --git a/atom/browser/lib/chrome-extension.coffee b/atom/browser/lib/chrome-extension.coffee index df0d717cd9dd..15f7bfd54c56 100644 --- a/atom/browser/lib/chrome-extension.coffee +++ b/atom/browser/lib/chrome-extension.coffee @@ -32,6 +32,7 @@ getExtensionInfoFromPath = (srcDirectory) -> startPage: page name: manifest.name srcDirectory: srcDirectory + exposeExperimentalAPIs: true extensionInfoMap[manifest.name] # The loaded extensions cache and its persistent path. From 9134b9cf432a9491ca1c65047ee82d2a0f512390 Mon Sep 17 00:00:00 2001 From: Plusb Preco Date: Tue, 15 Sep 2015 09:50:28 +0900 Subject: [PATCH 1231/1293] Update as upstream --- docs-translations/ko/api/frameless-window.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs-translations/ko/api/frameless-window.md b/docs-translations/ko/api/frameless-window.md index a398087e37b4..64422460775f 100644 --- a/docs-translations/ko/api/frameless-window.md +++ b/docs-translations/ko/api/frameless-window.md @@ -13,6 +13,16 @@ var BrowserWindow = require('browser-window'); var win = new BrowserWindow({ width: 800, height: 600, frame: false }); ``` +### 최신 Mac에서 사용할 수 있는 대안 + +OS X 10.10 Yosemite 이후의 최신 버전부터는 테두리가 없는 창을 만들 때 새로운 방법을 사용할 수 있습니다. +`frame` 옵션을 `false`로 지정하여 제목과 창 구성 요소를 모두 비활성화하는 대신 새로운 `title-bar-style` +옵션을 통해 제목만 숨기고 창 구성 요소("흔히 신호등으로 알고 있는")의 기능과 창 크기를 그대로 유지할 수 있습니다: + +```javascript +var BrowserWindow = require('browser-window'); +var win = new BrowserWindow({ width: 800, height: 600, 'title-bar-style': 'hidden' }); + ## 투명한 창 만들기 Frameless Window의 창의 배경을 투명하게 만들고 싶다면 `transparent` 옵션을 `true`로 바꿔주기만 하면됩니다: From 3bf73bc45518c127cc43418c98104be89e773e64 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 15 Sep 2015 09:17:45 +0800 Subject: [PATCH 1232/1293] Expose native implementation of WebContent::GetURL --- atom/browser/api/atom_api_web_contents.cc | 5 +++++ atom/browser/api/atom_api_web_contents.h | 1 + 2 files changed, 6 insertions(+) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 7c37f17e10d9..a24200e5a87d 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -547,6 +547,10 @@ void WebContents::LoadURL(const GURL& url, const mate::Dictionary& options) { web_contents()->GetController().LoadURLWithParams(params); } +GURL WebContents::GetURL() const { + return web_contents()->GetURL(); +} + base::string16 WebContents::GetTitle() const { return web_contents()->GetTitle(); } @@ -815,6 +819,7 @@ mate::ObjectTemplateBuilder WebContents::GetObjectTemplateBuilder( .SetMethod("getId", &WebContents::GetID) .SetMethod("equal", &WebContents::Equal) .SetMethod("_loadUrl", &WebContents::LoadURL) + .SetMethod("_getUrl", &WebContents::GetURL) .SetMethod("getTitle", &WebContents::GetTitle) .SetMethod("isLoading", &WebContents::IsLoading) .SetMethod("isWaitingForResponse", &WebContents::IsWaitingForResponse) diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index 3c6bde9c24aa..0001d3e8ef75 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -55,6 +55,7 @@ class WebContents : public mate::TrackableObject, int GetID() const; bool Equal(const WebContents* web_contents) const; void LoadURL(const GURL& url, const mate::Dictionary& options); + GURL GetURL() const; base::string16 GetTitle() const; bool IsLoading() const; bool IsWaitingForResponse() const; From 238d4add9925c43614a04eb9d2632808f54ff0ed Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 15 Sep 2015 09:18:22 +0800 Subject: [PATCH 1233/1293] devtools-opened should be emitted after devtools is opened --- atom/browser/api/atom_api_window.cc | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index 7403a7ecbb77..ede6bcd71e6b 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -183,21 +183,21 @@ void Window::OnDevToolsFocus() { } void Window::OnDevToolsOpened() { - Emit("devtools-opened"); - v8::Locker locker(isolate()); v8::HandleScope handle_scope(isolate()); auto handle = WebContents::CreateFrom( isolate(), api_web_contents_->GetDevToolsWebContents()); devtools_web_contents_.Reset(isolate(), handle.ToV8()); + + Emit("devtools-opened"); } void Window::OnDevToolsClosed() { - Emit("devtools-closed"); - v8::Locker locker(isolate()); v8::HandleScope handle_scope(isolate()); devtools_web_contents_.Reset(); + + Emit("devtools-closed"); } void Window::OnExecuteWindowsCommand(const std::string& command_name) { From e656d8428cc463aecb3477717257d1c2494ec694 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 15 Sep 2015 09:20:56 +0800 Subject: [PATCH 1234/1293] Make getUrl work for devToolsWebContents --- atom/browser/api/lib/navigation-controller.coffee | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/atom/browser/api/lib/navigation-controller.coffee b/atom/browser/api/lib/navigation-controller.coffee index a985931f4716..f78d92c341d6 100644 --- a/atom/browser/api/lib/navigation-controller.coffee +++ b/atom/browser/api/lib/navigation-controller.coffee @@ -16,6 +16,11 @@ class NavigationController constructor: (@webContents) -> @clearHistory() + # webContents may have already navigated to a page. + if @webContents._getUrl() + @currentIndex++ + @history.push @webContents._getUrl() + @webContents.on 'navigation-entry-commited', (event, url, inPage, replaceEntry) => if @inPageIndex > -1 and not inPage # Navigated to a new page, clear in-page mark. From 8a8b11cf10f0c107f91915e407e021f95a8f3c38 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 15 Sep 2015 09:21:15 +0800 Subject: [PATCH 1235/1293] Do not use did-finish-load to detect whether WebContents is ready The WebContents JS object can be created way later after the C++ object gets created. --- atom/browser/api/lib/web-contents.coffee | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/atom/browser/api/lib/web-contents.coffee b/atom/browser/api/lib/web-contents.coffee index 1bb82dec1a66..3a2abfb5155f 100644 --- a/atom/browser/api/lib/web-contents.coffee +++ b/atom/browser/api/lib/web-contents.coffee @@ -44,10 +44,8 @@ wrapWebContents = (webContents) -> # Make sure webContents.executeJavaScript would run the code only when the # web contents has been loaded. - webContents.loaded = false - webContents.once 'did-finish-load', -> @loaded = true webContents.executeJavaScript = (code, hasUserGesture=false) -> - if @loaded + if @getUrl() and not @isLoading() @_executeJavaScript code, hasUserGesture else webContents.once 'did-finish-load', @_executeJavaScript.bind(this, code, hasUserGesture) From 377e7ee3a728b5b8fe67605025fefc98cfd4f9f4 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Mon, 14 Sep 2015 18:34:27 -0700 Subject: [PATCH 1236/1293] Implement 'activiate' event instead of 'activate-with-open-windows'. --- atom/browser/api/atom_api_app.cc | 4 ++-- atom/browser/api/atom_api_app.h | 2 +- atom/browser/browser.cc | 4 ++-- atom/browser/browser.h | 5 +++-- atom/browser/browser_observer.h | 6 +++--- atom/browser/mac/atom_application_delegate.mm | 2 +- docs/api/app.md | 11 ++++++++--- 7 files changed, 20 insertions(+), 14 deletions(-) diff --git a/atom/browser/api/atom_api_app.cc b/atom/browser/api/atom_api_app.cc index f7c20483b490..cf187c451c83 100644 --- a/atom/browser/api/atom_api_app.cc +++ b/atom/browser/api/atom_api_app.cc @@ -171,8 +171,8 @@ void App::OnActivateWithNoOpenWindows() { Emit("activate-with-no-open-windows"); } -void App::OnActivateWithOpenWindows() { - Emit("activate-with-open-windows"); +void App::OnActivate(bool hasVisibleWindows) { + Emit("activate", hasVisibleWindows); } void App::OnWillFinishLaunching() { diff --git a/atom/browser/api/atom_api_app.h b/atom/browser/api/atom_api_app.h index 5f29744e919b..7e16a8df4e6c 100644 --- a/atom/browser/api/atom_api_app.h +++ b/atom/browser/api/atom_api_app.h @@ -42,7 +42,7 @@ class App : public mate::EventEmitter, void OnOpenFile(bool* prevent_default, const std::string& file_path) override; void OnOpenURL(const std::string& url) override; void OnActivateWithNoOpenWindows() override; - void OnActivateWithOpenWindows() override; + void OnActivate(bool hasVisibleWindows) override; void OnWillFinishLaunching() override; void OnFinishLaunching() override; void OnSelectCertificate( diff --git a/atom/browser/browser.cc b/atom/browser/browser.cc index 11530375eff8..186b6c6e37af 100644 --- a/atom/browser/browser.cc +++ b/atom/browser/browser.cc @@ -98,8 +98,8 @@ void Browser::ActivateWithNoOpenWindows() { FOR_EACH_OBSERVER(BrowserObserver, observers_, OnActivateWithNoOpenWindows()); } -void Browser::ActivateWithOpenWindows() { - FOR_EACH_OBSERVER(BrowserObserver, observers_, OnActivateWithOpenWindows()); +void Browser::Activate(bool hasVisibleWindows) { + FOR_EACH_OBSERVER(BrowserObserver, observers_, OnActivate(hasVisibleWindows)); } void Browser::WillFinishLaunching() { diff --git a/atom/browser/browser.h b/atom/browser/browser.h index 43b253c840a8..3afa1b5a688c 100644 --- a/atom/browser/browser.h +++ b/atom/browser/browser.h @@ -111,8 +111,9 @@ class Browser : public WindowListObserver { // Tell the application that application is activated with no open windows. void ActivateWithNoOpenWindows(); - // Tell the application that application is activated with open windows. - void ActivateWithOpenWindows(); + // Tell the application that application is activated with visible/invisible + // windows. + void Activate(bool hasVisibleWindows); // Tell the application the loading has been done. void WillFinishLaunching(); diff --git a/atom/browser/browser_observer.h b/atom/browser/browser_observer.h index 815d21bb843f..37be4922ddfa 100644 --- a/atom/browser/browser_observer.h +++ b/atom/browser/browser_observer.h @@ -47,9 +47,9 @@ class BrowserObserver { // dock icon). virtual void OnActivateWithNoOpenWindows() {} - // The browser is activated with open windows (usually by clicking on the dock - // icon). - virtual void OnActivateWithOpenWindows() {} + // The browser is activated with visible/invisible windows (usually by + // clicking on the dock icon). + virtual void OnActivate(bool hasVisibleWindows) {} // The browser has finished loading. virtual void OnWillFinishLaunching() {} diff --git a/atom/browser/mac/atom_application_delegate.mm b/atom/browser/mac/atom_application_delegate.mm index 0ee46e59e6ec..525e700e2b4e 100644 --- a/atom/browser/mac/atom_application_delegate.mm +++ b/atom/browser/mac/atom_application_delegate.mm @@ -52,8 +52,8 @@ - (BOOL)applicationShouldHandleReopen:(NSApplication*)theApplication hasVisibleWindows:(BOOL)flag { atom::Browser* browser = atom::Browser::Get(); + browser->Activate(static_cast(flag)); if (flag) { - browser->ActivateWithOpenWindows(); return YES; } else { browser->ActivateWithNoOpenWindows(); diff --git a/docs/api/app.md b/docs/api/app.md index 12be27ce75fc..ba61e1a0e0d8 100644 --- a/docs/api/app.md +++ b/docs/api/app.md @@ -100,10 +100,15 @@ Emitted when the application is activated while there are no open windows, which usually happens when the user has closed all of the application's windows and then clicks on the application's dock icon. -### Event: activated-with-open-windows _OS X_ +### Event: 'activate' _OS X_ -Emitted when the application is activated while there are open windows, which -usually happens when clicks on the applications's dock icon. +Returns: + +* `event` Event +* `hasVisibleWindows` Bool + +Emitted when the application is activated, which usually happens when clicks on +the applications's dock icon. ### Event: 'browser-window-blur' From 40d93ce55aa0e478b639b0b07e42de1328930ae4 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Mon, 14 Sep 2015 18:36:05 -0700 Subject: [PATCH 1237/1293] Deprecate 'activate-with-no-open-windows' event. --- atom/browser/mac/atom_application_delegate.mm | 1 + docs/api/app.md | 6 ------ 2 files changed, 1 insertion(+), 6 deletions(-) diff --git a/atom/browser/mac/atom_application_delegate.mm b/atom/browser/mac/atom_application_delegate.mm index 525e700e2b4e..7bdab03e0dc8 100644 --- a/atom/browser/mac/atom_application_delegate.mm +++ b/atom/browser/mac/atom_application_delegate.mm @@ -56,6 +56,7 @@ if (flag) { return YES; } else { + // Deprecated API, for compatibility. browser->ActivateWithNoOpenWindows(); return NO; } diff --git a/docs/api/app.md b/docs/api/app.md index ba61e1a0e0d8..85ad873de30d 100644 --- a/docs/api/app.md +++ b/docs/api/app.md @@ -94,12 +94,6 @@ must be registered to be opened by your application. You should call `event.preventDefault()` if you want to handle this event. -### Event: 'activate-with-no-open-windows' _OS X_ - -Emitted when the application is activated while there are no open windows, which -usually happens when the user has closed all of the application's windows and -then clicks on the application's dock icon. - ### Event: 'activate' _OS X_ Returns: From 9652ed6508fa2cb048783f75e1c997461f9aa59b Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Mon, 14 Sep 2015 19:05:53 -0700 Subject: [PATCH 1238/1293] More fixes after code review. --- atom/browser/api/atom_api_app.cc | 8 ++------ atom/browser/api/atom_api_app.h | 3 +-- atom/browser/api/lib/app.coffee | 1 + atom/browser/browser.cc | 10 ++++------ atom/browser/browser.h | 5 +---- atom/browser/browser_observer.h | 6 +----- atom/browser/mac/atom_application_delegate.mm | 8 +------- 7 files changed, 11 insertions(+), 30 deletions(-) diff --git a/atom/browser/api/atom_api_app.cc b/atom/browser/api/atom_api_app.cc index cf187c451c83..43b3d82df109 100644 --- a/atom/browser/api/atom_api_app.cc +++ b/atom/browser/api/atom_api_app.cc @@ -167,12 +167,8 @@ void App::OnOpenURL(const std::string& url) { Emit("open-url", url); } -void App::OnActivateWithNoOpenWindows() { - Emit("activate-with-no-open-windows"); -} - -void App::OnActivate(bool hasVisibleWindows) { - Emit("activate", hasVisibleWindows); +void App::OnActivate(bool has_visible_windows) { + Emit("activate", has_visible_windows); } void App::OnWillFinishLaunching() { diff --git a/atom/browser/api/atom_api_app.h b/atom/browser/api/atom_api_app.h index 7e16a8df4e6c..255f780e578d 100644 --- a/atom/browser/api/atom_api_app.h +++ b/atom/browser/api/atom_api_app.h @@ -41,8 +41,7 @@ class App : public mate::EventEmitter, void OnQuit() override; void OnOpenFile(bool* prevent_default, const std::string& file_path) override; void OnOpenURL(const std::string& url) override; - void OnActivateWithNoOpenWindows() override; - void OnActivate(bool hasVisibleWindows) override; + void OnActivate(bool has_visible_windows) override; void OnWillFinishLaunching() override; void OnFinishLaunching() override; void OnSelectCertificate( diff --git a/atom/browser/api/lib/app.coffee b/atom/browser/api/lib/app.coffee index b3446e86e23a..d1dc3fc68962 100644 --- a/atom/browser/api/lib/app.coffee +++ b/atom/browser/api/lib/app.coffee @@ -45,6 +45,7 @@ app.getHomeDir = -> @getPath 'home' app.getDataPath = -> @getPath 'userData' app.setDataPath = (path) -> @setPath 'userData', path app.resolveProxy = -> @defaultSession.resolveProxy.apply @defaultSession, arguments +app.on 'activate', (event, hasVisibleWindows) -> @emit 'activate-with-no-open-windows' if hasVisibleWindows # Session wrapper. sessionBindings._setWrapSession wrapSession diff --git a/atom/browser/browser.cc b/atom/browser/browser.cc index 186b6c6e37af..9d2a9fc1effb 100644 --- a/atom/browser/browser.cc +++ b/atom/browser/browser.cc @@ -94,12 +94,10 @@ void Browser::OpenURL(const std::string& url) { FOR_EACH_OBSERVER(BrowserObserver, observers_, OnOpenURL(url)); } -void Browser::ActivateWithNoOpenWindows() { - FOR_EACH_OBSERVER(BrowserObserver, observers_, OnActivateWithNoOpenWindows()); -} - -void Browser::Activate(bool hasVisibleWindows) { - FOR_EACH_OBSERVER(BrowserObserver, observers_, OnActivate(hasVisibleWindows)); +void Browser::Activate(bool has_visible_windows) { + FOR_EACH_OBSERVER(BrowserObserver, + observers_, + OnActivate(has_visible_windows)); } void Browser::WillFinishLaunching() { diff --git a/atom/browser/browser.h b/atom/browser/browser.h index 3afa1b5a688c..d135556b8760 100644 --- a/atom/browser/browser.h +++ b/atom/browser/browser.h @@ -108,12 +108,9 @@ class Browser : public WindowListObserver { // Tell the application to open a url. void OpenURL(const std::string& url); - // Tell the application that application is activated with no open windows. - void ActivateWithNoOpenWindows(); - // Tell the application that application is activated with visible/invisible // windows. - void Activate(bool hasVisibleWindows); + void Activate(bool has_visible_windows); // Tell the application the loading has been done. void WillFinishLaunching(); diff --git a/atom/browser/browser_observer.h b/atom/browser/browser_observer.h index 37be4922ddfa..45e86e620f84 100644 --- a/atom/browser/browser_observer.h +++ b/atom/browser/browser_observer.h @@ -43,13 +43,9 @@ class BrowserObserver { // Browser is used to open a url. virtual void OnOpenURL(const std::string& url) {} - // The browser is activated with no open windows (usually by clicking on the - // dock icon). - virtual void OnActivateWithNoOpenWindows() {} - // The browser is activated with visible/invisible windows (usually by // clicking on the dock icon). - virtual void OnActivate(bool hasVisibleWindows) {} + virtual void OnActivate(bool has_visible_windows) {} // The browser has finished loading. virtual void OnWillFinishLaunching() {} diff --git a/atom/browser/mac/atom_application_delegate.mm b/atom/browser/mac/atom_application_delegate.mm index 7bdab03e0dc8..a18d2fe40fcd 100644 --- a/atom/browser/mac/atom_application_delegate.mm +++ b/atom/browser/mac/atom_application_delegate.mm @@ -53,13 +53,7 @@ hasVisibleWindows:(BOOL)flag { atom::Browser* browser = atom::Browser::Get(); browser->Activate(static_cast(flag)); - if (flag) { - return YES; - } else { - // Deprecated API, for compatibility. - browser->ActivateWithNoOpenWindows(); - return NO; - } + return flag; } @end From c99ec368b398aee52f580afb3f9e8900c9e06273 Mon Sep 17 00:00:00 2001 From: Wujg Date: Tue, 15 Sep 2015 11:15:11 +0800 Subject: [PATCH 1239/1293] Update quick-start.md for zh-CN Fixed some typo. --- docs-translations/zh-CN/tutorial/quick-start.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs-translations/zh-CN/tutorial/quick-start.md b/docs-translations/zh-CN/tutorial/quick-start.md index fe54cbe9e308..165c30142e72 100644 --- a/docs-translations/zh-CN/tutorial/quick-start.md +++ b/docs-translations/zh-CN/tutorial/quick-start.md @@ -11,16 +11,16 @@ Electron 可以让你使用纯 JavaScript 调用丰富的原生 APIs 来创造 ## 渲染进程 由于 Electron 使用 Chromium 来展示页面，所以 Chromium 的多进程结构也被充分利用。每个 Electron 的页面都在运行着自己的进程，这样的进程我们称之为**渲染进程**。 -在一般浏览器中，网页通常会在沙盒环境下运行，并且不允许访问原生资源。然后，Electron 用户拥有在网页中调用 io.js 的 APIs 的能力，从而创造出低等的、与操作系统的交互。 +在一般浏览器中，网页通常会在沙盒环境下运行，并且不允许访问原生资源。然而，Electron 用户拥有在网页中调用 io.js 的 APIs 的能力，可以与底层操作系统直接交互。 ## 主进程与渲染进程的区别 -主进程使用 BroswerWindow 实例创建网页。每个 BroswerWindow 实例都在自己的渲染进程里运行着一个网页。当一个 BroswerWindow 实例被销毁，相应的渲染进程也会被终止。 +主进程使用 BroswerWindow 实例创建网页。每个 BroswerWindow 实例都在自己的渲染进程里运行着一个网页。当一个 BroswerWindow 实例被销毁后，相应的渲染进程也会被终止。 主进程管理所有页面和与之对应的渲染进程。每个渲染进程都是相互独立的，并且只关心他们自己的网页。 -由于在网页里管理原生 GUI 资源是非常危险而且容易造成资源泄露的，所以在网页面调用 GUI 相关的 APIs 是不被允许的。如果你想在网页里使用 GUI 操作，其对应的渲染进程必须与主进程进行通讯，请求主进程进行相关的 GUI 操作。 +由于在网页里管理原生 GUI 资源是非常危险而且容易造成资源泄露，所以在网页面调用 GUI 相关的 APIs 是不被允许的。如果你想在网页里使用 GUI 操作，其对应的渲染进程必须与主进程进行通讯，请求主进程进行相关的 GUI 操作。 -在 Electron,我们提供用于在主进程与渲染进程之间通讯的 [ipc][1] 模块。并且也有一个远程进程调用风格的通讯模块 [remote][2]。 +在 Electron，我们提供用于在主进程与渲染进程之间通讯的 [ipc][1] 模块。并且也有一个远程进程调用风格的通讯模块 [remote][2]。 # 打造你第一个 Electron 应用 大体上，一个 Electron 应用的目录结构如下： @@ -133,4 +133,4 @@ $ ./Electron.app/Contents/MacOS/Electron your-app/ [1]: https://github.com/atom/electron/blob/master/docs-translations/zh-CN/api/ipc-renderer.md [2]: https://github.com/atom/electron/blob/master/docs-translations/zh-CN/api/remote.md [3]: https://github.com/atom/electron/releases - [4]: https://github.com/atom/electron/blob/master/docs-translations/zh-CN/tutorial/application-distribution.md \ No newline at end of file + [4]: https://github.com/atom/electron/blob/master/docs-translations/zh-CN/tutorial/application-distribution.md From 97857aa152e12ed5f2044edf53b23ed6992c2b0d Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 15 Sep 2015 11:26:55 +0800 Subject: [PATCH 1240/1293] Update brightray for DevToolsFocused fix --- vendor/brightray | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/brightray b/vendor/brightray index 1cfc13fec13a..1c12c8232376 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit 1cfc13fec13a36f3682ee702c32dc2cf22363143 +Subproject commit 1c12c82323769f677c0c487c910575f1f487637d From b72a5884f2147b010dd563d1a05efe65b9132f4f Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 15 Sep 2015 11:27:32 +0800 Subject: [PATCH 1241/1293] Add BrowserWindow.isDevToolsFocused --- atom/browser/api/atom_api_window.cc | 5 +++++ atom/browser/api/atom_api_window.h | 1 + atom/browser/native_window.cc | 4 ++++ atom/browser/native_window.h | 1 + 4 files changed, 11 insertions(+) diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index ede6bcd71e6b..1a76c3e5f078 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -414,6 +414,10 @@ bool Window::IsWebViewFocused() { return window_->IsWebViewFocused(); } +bool Window::IsDevToolsFocused() { + return window_->IsDevToolsFocused(); +} + void Window::SetRepresentedFilename(const std::string& filename) { window_->SetRepresentedFilename(filename); } @@ -591,6 +595,7 @@ void Window::BuildPrototype(v8::Isolate* isolate, .SetMethod("focusOnWebView", &Window::FocusOnWebView) .SetMethod("blurWebView", &Window::BlurWebView) .SetMethod("isWebViewFocused", &Window::IsWebViewFocused) + .SetMethod("isDevToolsFocused", &Window::IsDevToolsFocused) .SetMethod("capturePage", &Window::CapturePage) .SetMethod("setProgressBar", &Window::SetProgressBar) .SetMethod("setOverlayIcon", &Window::SetOverlayIcon) diff --git a/atom/browser/api/atom_api_window.h b/atom/browser/api/atom_api_window.h index 4384e03a249f..d60bf0d87ea0 100644 --- a/atom/browser/api/atom_api_window.h +++ b/atom/browser/api/atom_api_window.h @@ -124,6 +124,7 @@ class Window : public mate::TrackableObject, void FocusOnWebView(); void BlurWebView(); bool IsWebViewFocused(); + bool IsDevToolsFocused(); void SetRepresentedFilename(const std::string& filename); std::string GetRepresentedFilename(); void SetDocumentEdited(bool edited); diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 997fe72c4ae7..f40f7de8dbc3 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -249,6 +249,10 @@ bool NativeWindow::IsWebViewFocused() { return host_view && host_view->HasFocus(); } +bool NativeWindow::IsDevToolsFocused() { + return inspectable_web_contents_->GetView()->IsDevToolsViewFocused(); +} + void NativeWindow::CapturePage(const gfx::Rect& rect, const CapturePageCallback& callback) { const auto view = web_contents()->GetRenderWidgetHostView(); diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index b89e2b58e6e4..f09845aad348 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -148,6 +148,7 @@ class NativeWindow : public content::WebContentsObserver, virtual void FocusOnWebView(); virtual void BlurWebView(); virtual bool IsWebViewFocused(); + virtual bool IsDevToolsFocused(); // Captures the page with |rect|, |callback| would be called when capturing is // done. From c9ee6b4caf03b104a83b28ad9360d7f6fac647c5 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 15 Sep 2015 11:43:04 +0800 Subject: [PATCH 1242/1293] docs: BrowserWindow.isDevToolsFocused --- docs/api/browser-window.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index a9f046774af6..f0119700f2cb 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -613,7 +613,11 @@ Returns whether the developer tools are opened. ### `win.toggleDevTools()` -Toggle the developer tools. +Toggles the developer tools. + +### `win.isDevToolsFocused()` + +Returns whether the developer tools is focused. ### `win.inspectElement(x, y)` From 2a3a65f67c898a6569a16b233468d6e41cdf7159 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 15 Sep 2015 12:08:17 +0800 Subject: [PATCH 1243/1293] Update brightray to use 10.10 SDK --- vendor/brightray | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/brightray b/vendor/brightray index 1c12c8232376..41f5c2caeaa2 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit 1c12c82323769f677c0c487c910575f1f487637d +Subproject commit 41f5c2caeaa246b2d4ede37dc49345e313b19b5a From 311a5456ec90290bda110ea2ec6f14081f6c8157 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 15 Sep 2015 13:18:01 +0800 Subject: [PATCH 1244/1293] Make crash-reporter spec more reliable --- spec/api-crash-reporter-spec.coffee | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/spec/api-crash-reporter-spec.coffee b/spec/api-crash-reporter-spec.coffee index 6cd714215354..1d34fe441412 100644 --- a/spec/api-crash-reporter-spec.coffee +++ b/spec/api-crash-reporter-spec.coffee @@ -19,8 +19,9 @@ describe 'crash-reporter module', -> return if process.platform is 'win32' and process.arch is 'x64' it 'should send minidump when renderer crashes', (done) -> - @timeout 60000 + @timeout 120000 server = http.createServer (req, res) -> + server.close() form = new formidable.IncomingForm() process.throwDeprecation = false form.parse req, (error, fields, files) -> @@ -37,7 +38,6 @@ describe 'crash-reporter module', -> assert files['upload_file_minidump']['name']? res.end('abc-123-def') - server.close() done() # Server port is generated randomly for the first run, it will be reused # when page is refreshed. From 817363b955f63f31545f35641955f1c15dfb7caf Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 15 Sep 2015 13:29:03 +0800 Subject: [PATCH 1245/1293] spec: Run tests on OS X CI machine --- script/cibuild | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/script/cibuild b/script/cibuild index 38ce06969a22..08d59385c9e0 100755 --- a/script/cibuild +++ b/script/cibuild @@ -71,7 +71,7 @@ def main(): run_script('upload.py') else: run_script('build.py', ['-c', 'D']) - if (is_travis or PLATFORM == 'linux') and target_arch == 'x64': + if PLATFORM != 'win32' and target_arch == 'x64': run_script('test.py', ['--ci']) run_script('clean.py') From 357c7af3c0f8db8e0aab5fe00b889062c2452ba2 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 15 Sep 2015 13:45:26 +0800 Subject: [PATCH 1246/1293] spec: Check existence of webview before removing it --- spec/webview-spec.coffee | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spec/webview-spec.coffee b/spec/webview-spec.coffee index ddb203399b8e..e4b40c28ebeb 100644 --- a/spec/webview-spec.coffee +++ b/spec/webview-spec.coffee @@ -11,7 +11,7 @@ describe ' tag', -> beforeEach -> webview = new WebView afterEach -> - document.body.removeChild webview + document.body.removeChild(webview) if document.body.contains(webview) describe 'src attribute', -> it 'specifies the page to load', (done) -> From eced01eb9d2dc77546692f2878c582f569aa485f Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 15 Sep 2015 14:26:46 +0800 Subject: [PATCH 1247/1293] spec: Delay timeout of window.opener test --- spec/chromium-spec.coffee | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/spec/chromium-spec.coffee b/spec/chromium-spec.coffee index d09a021db9f9..2c42cd9a4cf0 100644 --- a/spec/chromium-spec.coffee +++ b/spec/chromium-spec.coffee @@ -51,6 +51,8 @@ describe 'chromium feature', -> b = window.open "file://#{fixtures}/pages/window-opener-node.html", '', 'node-integration=no,show=no' describe 'window.opener', -> + @timeout 10000 + ipc = remote.require 'ipc' url = "file://#{fixtures}/pages/window-opener.html" w = null @@ -61,16 +63,17 @@ describe 'chromium feature', -> it 'is null for main window', (done) -> ipc.on 'opener', (event, opener) -> - done(if opener is null then undefined else opener) + assert.equal opener, null + done() BrowserWindow = remote.require 'browser-window' w = new BrowserWindow(show: false) w.loadUrl url it 'is not null for window opened by window.open', (done) -> - b = window.open url, '', 'show=no' ipc.on 'opener', (event, opener) -> b.close() done(if opener isnt null then undefined else opener) + b = window.open url, '', 'show=no' describe 'window.opener.postMessage', -> it 'sets source and origin correctly', (done) -> From f1787d747afbfcc9e6c416b298d7bf32a366241d Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 15 Sep 2015 14:43:11 +0800 Subject: [PATCH 1248/1293] The crash-reporter test is not reliable on CI machine --- spec/api-crash-reporter-spec.coffee | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/spec/api-crash-reporter-spec.coffee b/spec/api-crash-reporter-spec.coffee index 1d34fe441412..60b630bc2ffc 100644 --- a/spec/api-crash-reporter-spec.coffee +++ b/spec/api-crash-reporter-spec.coffee @@ -18,6 +18,10 @@ describe 'crash-reporter module', -> # It is not working on 64bit Windows. return if process.platform is 'win32' and process.arch is 'x64' + # The crash-reporter test is not reliable on CI machine. + isCI = remote.process.argv[2] == '--ci' + return if isCI + it 'should send minidump when renderer crashes', (done) -> @timeout 120000 server = http.createServer (req, res) -> From 6615787775436aa6a3c01e6bf5b1497d6b37f1ef Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 15 Sep 2015 15:19:43 +0800 Subject: [PATCH 1249/1293] Update node, fixes #2786 --- vendor/node | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/node b/vendor/node index fdb584a0b42e..4098d45fbb82 160000 --- a/vendor/node +++ b/vendor/node @@ -1 +1 @@ -Subproject commit fdb584a0b42e89885f74ed68f279318b0fbff37f +Subproject commit 4098d45fbb822370c19d2fe7b88162759db4eb96 From 10b1ea724445d02563b2c37a99e43d4909f36ac9 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Tue, 15 Sep 2015 15:30:22 +0800 Subject: [PATCH 1250/1293] Bump v0.32.3 --- atom.gyp | 2 +- atom/browser/resources/mac/Info.plist | 2 +- atom/browser/resources/win/atom.rc | 8 ++++---- atom/common/atom_version.h | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/atom.gyp b/atom.gyp index 5799a00171bc..63defa4273fd 100644 --- a/atom.gyp +++ b/atom.gyp @@ -4,7 +4,7 @@ 'product_name%': 'Electron', 'company_name%': 'GitHub, Inc', 'company_abbr%': 'github', - 'version%': '0.32.2', + 'version%': '0.32.3', }, 'includes': [ 'filenames.gypi', diff --git a/atom/browser/resources/mac/Info.plist b/atom/browser/resources/mac/Info.plist index 2357054b98ea..dd4e610d917e 100644 --- a/atom/browser/resources/mac/Info.plist +++ b/atom/browser/resources/mac/Info.plist @@ -17,7 +17,7 @@ CFBundleIconFile atom.icns CFBundleVersion - 0.32.2 + 0.32.3 LSMinimumSystemVersion 10.8.0 NSMainNibFile diff --git a/atom/browser/resources/win/atom.rc b/atom/browser/resources/win/atom.rc index 2431dcc00ea6..cf894f6b5c33 100644 --- a/atom/browser/resources/win/atom.rc +++ b/atom/browser/resources/win/atom.rc @@ -56,8 +56,8 @@ END // VS_VERSION_INFO VERSIONINFO - FILEVERSION 0,32,2,0 - PRODUCTVERSION 0,32,2,0 + FILEVERSION 0,32,3,0 + PRODUCTVERSION 0,32,3,0 FILEFLAGSMASK 0x3fL #ifdef _DEBUG FILEFLAGS 0x1L @@ -74,12 +74,12 @@ BEGIN BEGIN VALUE "CompanyName", "GitHub, Inc." VALUE "FileDescription", "Electron" - VALUE "FileVersion", "0.32.2" + VALUE "FileVersion", "0.32.3" VALUE "InternalName", "electron.exe" VALUE "LegalCopyright", "Copyright (C) 2015 GitHub, Inc. All rights reserved." VALUE "OriginalFilename", "electron.exe" VALUE "ProductName", "Electron" - VALUE "ProductVersion", "0.32.2" + VALUE "ProductVersion", "0.32.3" VALUE "SquirrelAwareVersion", "1" END END diff --git a/atom/common/atom_version.h b/atom/common/atom_version.h index 1e60cb874b75..8d71e9150540 100644 --- a/atom/common/atom_version.h +++ b/atom/common/atom_version.h @@ -7,7 +7,7 @@ #define ATOM_MAJOR_VERSION 0 #define ATOM_MINOR_VERSION 32 -#define ATOM_PATCH_VERSION 2 +#define ATOM_PATCH_VERSION 3 #define ATOM_VERSION_IS_RELEASE 1 From a3e9ff67b0f3697892d009f87fb5d3adc6916e27 Mon Sep 17 00:00:00 2001 From: Haojian Wu Date: Wed, 16 Sep 2015 08:36:01 +0800 Subject: [PATCH 1251/1293] Fix a wrong check in emitting 'activate-with-no-open-windows' event. --- atom/browser/api/lib/app.coffee | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/atom/browser/api/lib/app.coffee b/atom/browser/api/lib/app.coffee index d1dc3fc68962..f5b137eb0bb2 100644 --- a/atom/browser/api/lib/app.coffee +++ b/atom/browser/api/lib/app.coffee @@ -45,7 +45,7 @@ app.getHomeDir = -> @getPath 'home' app.getDataPath = -> @getPath 'userData' app.setDataPath = (path) -> @setPath 'userData', path app.resolveProxy = -> @defaultSession.resolveProxy.apply @defaultSession, arguments -app.on 'activate', (event, hasVisibleWindows) -> @emit 'activate-with-no-open-windows' if hasVisibleWindows +app.on 'activate', (event, hasVisibleWindows) -> @emit 'activate-with-no-open-windows' if not hasVisibleWindows # Session wrapper. sessionBindings._setWrapSession wrapSession From ceef06b344895edeb7d3770edcf64e387f0203f5 Mon Sep 17 00:00:00 2001 From: Heilig Benedek Date: Wed, 16 Sep 2015 02:59:16 +0200 Subject: [PATCH 1252/1293] Renamed setOffscreenRender to begin/endFrameSubscription because the name was a bit misleading, and replaced the ArrayBuffer creation with a node::Buffer::New call. --- atom/browser/api/atom_api_window.cc | 17 +++++++++++------ atom/browser/api/atom_api_window.h | 3 ++- atom/browser/native_window.cc | 4 ++-- atom/browser/native_window.h | 2 +- docs/api/browser-window.md | 14 ++++++++++---- 5 files changed, 26 insertions(+), 14 deletions(-) diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index b9b592a283aa..78d937616520 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -8,6 +8,7 @@ #include "atom/browser/api/atom_api_web_contents.h" #include "atom/browser/browser.h" #include "atom/browser/native_window.h" +#include "atom/common/node_includes.h" #include "atom/common/options_switches.h" #include "atom/common/event_types.h" #include "atom/common/native_mate_converters/callback.h" @@ -99,10 +100,9 @@ void Window::OnFrameRendered(scoped_ptr rgb, const int size) { v8::Locker locker(isolate()); v8::HandleScope handle_scope(isolate()); - v8::Local data = v8::ArrayBuffer::New(isolate(), rgb.get(), size); - v8::Local uint_data = v8::Uint8ClampedArray::New(data, 0, size); + auto data = node::Buffer::New(isolate(), reinterpret_cast(rgb.get()), static_cast(size)); - Emit("frame-rendered", uint_data, size); + Emit("frame-rendered", data, size); } void Window::OnWindowClosed() { @@ -442,8 +442,12 @@ void Window::CapturePage(mate::Arguments* args) { rect, base::Bind(&OnCapturePageDone, args->isolate(), callback)); } -void Window::SetOffscreenRender(bool isOffscreen) { - window_->SetOffscreenRender(isOffscreen); +void Window::BeginFrameSubscription() { + window_->SetFrameSubscription(true); +} + +void Window::EndFrameSubscription() { + window_->SetFrameSubscription(false); } void Window::SetProgressBar(double progress) { @@ -728,7 +732,8 @@ void Window::BuildPrototype(v8::Isolate* isolate, &Window::IsVisibleOnAllWorkspaces) .SetMethod("sendMouseEvent", &Window::SendMouseEvent) .SetMethod("sendKeyboardEvent", &Window::SendKeyboardEvent) - .SetMethod("setOffscreenRender", &Window::SetOffscreenRender) + .SetMethod("beginFrameSubscription", &Window::BeginFrameSubscription) + .SetMethod("endFrameSubscription", &Window::EndFrameSubscription) #if defined(OS_MACOSX) .SetMethod("showDefinitionForSelection", &Window::ShowDefinitionForSelection) diff --git a/atom/browser/api/atom_api_window.h b/atom/browser/api/atom_api_window.h index 727cacd3d6e8..b5125f9c1f57 100644 --- a/atom/browser/api/atom_api_window.h +++ b/atom/browser/api/atom_api_window.h @@ -141,7 +141,8 @@ class Window : public mate::TrackableObject, void SendKeyboardEvent(v8::Isolate* isolate, const mate::Dictionary& data); void SendMouseEvent(v8::Isolate* isolate, const mate::Dictionary& data); - void SetOffscreenRender(bool isOffscreen); + void BeginFrameSubscription(); + void EndFrameSubscription(); #if defined(OS_MACOSX) void ShowDefinitionForSelection(); diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index a9e0631489a8..e8a4c5a9ea5e 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -333,7 +333,7 @@ void NativeWindow::CapturePage(const gfx::Rect& rect, kBGRA_8888_SkColorType); } -void NativeWindow::SetOffscreenRender(bool isOffscreen) { +void NativeWindow::SetFrameSubscription(bool isOffscreen) { if (!isOffscreen && !offscreen_) return; const auto view = web_contents()->GetRenderWidgetHostView(); @@ -637,7 +637,7 @@ void NativeWindow::SendMouseWheelEvent(int modifiers, int x, int y, bool precise } void NativeWindow::DidFinishLoad(content::RenderFrameHost* render_frame_host, const GURL& validated_url) { - SetOffscreenRender(offscreen_); + SetFrameSubscription(offscreen_); } void NativeWindow::RenderViewCreated( diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index 7131894a1f1c..f439962e7cc6 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -242,7 +242,7 @@ class NativeWindow : public content::WebContentsObserver, void SendMouseEvent(blink::WebInputEvent::Type type, int modifiers, blink::WebMouseEvent::Button button, int x, int y, int movementX, int movementY, int clickCount); void SendMouseWheelEvent(int modifiers, int x, int y, bool clickCount); - void SetOffscreenRender(bool isOffscreen); + void SetFrameSubscription(bool isOffscreen); protected: NativeWindow(brightray::InspectableWebContents* inspectable_web_contents, diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 09d38bc9ad98..c338f2470722 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -75,7 +75,8 @@ You can also create a window without chrome by using * `standard-window` Boolean - Uses the OS X's standard window instead of the textured window. Defaults to `true`. * `offscreen-render` Boolean - The frame of the window will be accessible - through the `frame-rendered` event in a buffer. Defaults to `false`. + through the `frame-rendered` event in a buffer (Uint8, BGRA). Defaults to + `false`. * `web-preferences` Object - Settings of web page's features * `javascript` Boolean * `web-security` Boolean - When setting `false`, it will disable the same-origin @@ -732,10 +733,15 @@ Returns whether the window is visible on all workspaces. **Note:** This API always returns false on Windows. -### BrowserWindow.setOffscreenRender(isOffscreen) +### BrowserWindow.beginFrameSubscription() -Sets the offscreen rendering, if `true` the `frame-rendered` event will fire, -when the frame changes. +Enables offscreen rendering, after this call `frame-rendered` events will be +fired when the window receives a new frame from the renderer. + +### BrowserWindow.endFrameSubscription() + +Enables offscreen rendering, after this call `frame-rendered` events will +no longer be fired if offscreen rendering was enabled before. ### BrowserWindow.sendMouseEvent(options) From 5269380b6d7551b1c7da83639849111cfefbde00 Mon Sep 17 00:00:00 2001 From: Heilig Benedek Date: Wed, 16 Sep 2015 03:12:49 +0200 Subject: [PATCH 1253/1293] Removed duplicate keydown event sending. --- atom/browser/native_window.cc | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index e8a4c5a9ea5e..19120da07ab8 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -592,12 +592,8 @@ void NativeWindow::SendKeyboardEvent(blink::WebInputEvent::Type type, int modifi const auto view = web_contents()->GetRenderWidgetHostView(); const auto host = view ? view->GetRenderWidgetHost() : nullptr; - host->ForwardKeyboardEvent(*keyb_event); - if(keyb_event->type == blink::WebInputEvent::Type::KeyDown){ - keyb_event->type = blink::WebInputEvent::RawKeyDown; - host->ForwardKeyboardEvent(*keyb_event); - } + host->ForwardKeyboardEvent(*keyb_event); } void NativeWindow::SendMouseEvent(blink::WebInputEvent::Type type, int modifiers, blink::WebMouseEvent::Button button, int x, int y, int movementX, int movementY, int clickCount){ From 69cc3ab5ef59ffacca12362881dd8fe681cefb85 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 16 Sep 2015 09:20:16 +0800 Subject: [PATCH 1254/1293] docs: Make description of fullscreen more precise Closes #2793. --- docs/api/browser-window.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index f0119700f2cb..29171a2ec504 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -46,7 +46,7 @@ Properties `width` and `height` are required. * `always-on-top` Boolean - Whether the window should always stay on top of other windows. * `fullscreen` Boolean - Whether the window should show in fullscreen. When - set to `false` the fullscreen button will also be hidden on OS X. + set to `false` the fullscreen button will be hidden or disabled on OS X. * `skip-taskbar` Boolean - Whether to show the window in taskbar. * `kiosk` Boolean - The kiosk mode. * `title` String - Default window title. From 08f5c3230699175e081ea1803eb55da924b9f1c2 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 16 Sep 2015 09:21:09 +0800 Subject: [PATCH 1255/1293] script: Call Electron binary from Debug build We usually don't build Release version on the development machine. --- script/upload-index-json.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/script/upload-index-json.py b/script/upload-index-json.py index dfcbc835915c..671408fa9219 100755 --- a/script/upload-index-json.py +++ b/script/upload-index-json.py @@ -8,7 +8,7 @@ from lib.util import atom_gyp, execute, s3put, scoped_cwd SOURCE_ROOT = os.path.abspath(os.path.dirname(os.path.dirname(__file__))) -OUT_DIR = os.path.join(SOURCE_ROOT, 'out', 'R') +OUT_DIR = os.path.join(SOURCE_ROOT, 'out', 'D') PROJECT_NAME = atom_gyp()['project_name%'] PRODUCT_NAME = atom_gyp()['product_name%'] From 90064eeddda903f6fd554e2c484e1ec5a86a1e8a Mon Sep 17 00:00:00 2001 From: Heilig Benedek Date: Wed, 16 Sep 2015 03:29:23 +0200 Subject: [PATCH 1256/1293] Returning to original native_mate. --- vendor/native_mate | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/native_mate b/vendor/native_mate index c71b1694e51f..b7387da0854b 160000 --- a/vendor/native_mate +++ b/vendor/native_mate @@ -1 +1 @@ -Subproject commit c71b1694e51fe62f646a0e92e39329d8ab569d5c +Subproject commit b7387da0854b20d376fdae0d93a01f83d080668d From 57c910faef1653512df572da203e3a30451b9c50 Mon Sep 17 00:00:00 2001 From: Robo Date: Tue, 15 Sep 2015 19:54:16 +0530 Subject: [PATCH 1257/1293] protocol: respect provided mimetype in generated response headers --- atom/browser/net/url_request_buffer_job.cc | 23 +++++++++++++++++++++- atom/browser/net/url_request_buffer_job.h | 5 +++++ atom/browser/net/url_request_string_job.cc | 14 +++++++++++++ atom/browser/net/url_request_string_job.h | 3 +++ spec/api-protocol-spec.coffee | 13 ++++++++++++ 5 files changed, 57 insertions(+), 1 deletion(-) diff --git a/atom/browser/net/url_request_buffer_job.cc b/atom/browser/net/url_request_buffer_job.cc index 7eb3aaed243c..affc3dd37d25 100644 --- a/atom/browser/net/url_request_buffer_job.cc +++ b/atom/browser/net/url_request_buffer_job.cc @@ -6,13 +6,15 @@ #include +#include "base/strings/string_number_conversions.h" #include "net/base/net_errors.h" namespace atom { URLRequestBufferJob::URLRequestBufferJob( net::URLRequest* request, net::NetworkDelegate* network_delegate) - : JsAsker(request, network_delegate) { + : JsAsker(request, network_delegate), + status_code_(net::HTTP_NOT_IMPLEMENTED) { } void URLRequestBufferJob::StartAsync(scoped_ptr options) { @@ -36,9 +38,28 @@ void URLRequestBufferJob::StartAsync(scoped_ptr options) { data_ = new base::RefCountedBytes( reinterpret_cast(binary->GetBuffer()), binary->GetSize()); + status_code_ = net::HTTP_OK; net::URLRequestSimpleJob::Start(); } +void URLRequestBufferJob::GetResponseInfo(net::HttpResponseInfo* info) { + std::string status("HTTP/1.1 "); + status.append(base::IntToString(status_code_)); + status.append(" "); + status.append(net::GetHttpReasonPhrase(status_code_)); + status.append("\0\0", 2); + net::HttpResponseHeaders* headers = new net::HttpResponseHeaders(status); + + if (!mime_type_.empty()) { + std::string content_type_header(net::HttpRequestHeaders::kContentType); + content_type_header.append(": "); + content_type_header.append(mime_type_); + headers->AddHeader(content_type_header); + } + + info->headers = headers; +} + int URLRequestBufferJob::GetRefCountedData( std::string* mime_type, std::string* charset, diff --git a/atom/browser/net/url_request_buffer_job.h b/atom/browser/net/url_request_buffer_job.h index e6fecdba8301..ab8de7e8f030 100644 --- a/atom/browser/net/url_request_buffer_job.h +++ b/atom/browser/net/url_request_buffer_job.h @@ -9,6 +9,7 @@ #include "atom/browser/net/js_asker.h" #include "base/memory/ref_counted_memory.h" +#include "net/http/http_status_code.h" #include "net/url_request/url_request_simple_job.h" namespace atom { @@ -20,6 +21,9 @@ class URLRequestBufferJob : public JsAsker { // JsAsker: void StartAsync(scoped_ptr options) override; + // URLRequestJob: + void GetResponseInfo(net::HttpResponseInfo* info) override; + // URLRequestSimpleJob: int GetRefCountedData(std::string* mime_type, std::string* charset, @@ -30,6 +34,7 @@ class URLRequestBufferJob : public JsAsker { std::string mime_type_; std::string charset_; scoped_refptr data_; + net::HttpStatusCode status_code_; DISALLOW_COPY_AND_ASSIGN(URLRequestBufferJob); }; diff --git a/atom/browser/net/url_request_string_job.cc b/atom/browser/net/url_request_string_job.cc index 428a87f54b1e..4a631b813eff 100644 --- a/atom/browser/net/url_request_string_job.cc +++ b/atom/browser/net/url_request_string_job.cc @@ -28,6 +28,20 @@ void URLRequestStringJob::StartAsync(scoped_ptr options) { net::URLRequestSimpleJob::Start(); } +void URLRequestStringJob::GetResponseInfo(net::HttpResponseInfo* info) { + std::string status("HTTP/1.1 200 OK"); + net::HttpResponseHeaders* headers = new net::HttpResponseHeaders(status); + + if (!mime_type_.empty()) { + std::string content_type_header(net::HttpRequestHeaders::kContentType); + content_type_header.append(": "); + content_type_header.append(mime_type_); + headers->AddHeader(content_type_header); + } + + info->headers = headers; +} + int URLRequestStringJob::GetData( std::string* mime_type, std::string* charset, diff --git a/atom/browser/net/url_request_string_job.h b/atom/browser/net/url_request_string_job.h index 713185c0cd1d..e40f0d93dab7 100644 --- a/atom/browser/net/url_request_string_job.h +++ b/atom/browser/net/url_request_string_job.h @@ -19,6 +19,9 @@ class URLRequestStringJob : public JsAsker { // JsAsker: void StartAsync(scoped_ptr options) override; + // URLRequestJob: + void GetResponseInfo(net::HttpResponseInfo* info) override; + // URLRequestSimpleJob: int GetData(std::string* mime_type, std::string* charset, diff --git a/spec/api-protocol-spec.coffee b/spec/api-protocol-spec.coffee index f540a63ec406..02fd8d5e402a 100644 --- a/spec/api-protocol-spec.coffee +++ b/spec/api-protocol-spec.coffee @@ -318,6 +318,19 @@ describe 'protocol module', -> error: (xhr, errorType, error) -> done(error) + it 'can set content-type', (done) -> + handler = (request, callback) -> + callback({mimeType: 'application/json', data: '{"value": 1}'}) + protocol.interceptStringProtocol 'http', handler, (error) -> + $.ajax + url: 'http://fake-host' + success: (data) -> + assert.equal typeof(data), 'object' + assert.equal data.value, 1 + done() + error: (xhr, errorType, error) -> + done(error) + describe 'protocol.interceptBufferProtocol', -> it 'can intercept http protocol', (done) -> handler = (request, callback) -> callback(new Buffer(text)) From a3a9bbb9793c924090b498f6ff2d3d6bf83c4747 Mon Sep 17 00:00:00 2001 From: Jonatas Freitas Date: Wed, 16 Sep 2015 00:10:35 -0300 Subject: [PATCH 1258/1293] api/process.md translated to pt-BR --- docs-translations/pt-BR/api/process.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 docs-translations/pt-BR/api/process.md diff --git a/docs-translations/pt-BR/api/process.md b/docs-translations/pt-BR/api/process.md new file mode 100644 index 000000000000..3da0dc58391b --- /dev/null +++ b/docs-translations/pt-BR/api/process.md @@ -0,0 +1,22 @@ +# process +O objeto `process` no Electron tem as seguintes diferenças de um upstream node: + +* `process.type` String - Tipo de processo, pode ser `browser` (i.e. main process) +ou `renderer`. +* `process.versions['electron']` String - Versão do Electron. +* `process.versions['chrome']` String - Versão do Chromium. +* `process.resourcesPath` String - Caminho para os códigos fontes JavaScript. + +# Métodos +O objeto `process` tem os seguintes método: + +### `process.hang` + +Afeta a thread principal do processo atual. + +## process.setFdLimit(MaxDescritores) _OS X_ _Linux_ + +* `maxDescriptors` Integer + +Define o limite do arquivo descritor para `maxDescriptors` ou para o limite do OS, +o que for menor para o processo atual. \ No newline at end of file From 244e184b7ec77cd165fe0758d86f20d156d3041f Mon Sep 17 00:00:00 2001 From: Jonatas Freitas Date: Wed, 16 Sep 2015 00:36:43 -0300 Subject: [PATCH 1259/1293] api/shell translated to pt-BR --- docs-translations/pt-BR/api/shell.md | 43 ++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 docs-translations/pt-BR/api/shell.md diff --git a/docs-translations/pt-BR/api/shell.md b/docs-translations/pt-BR/api/shell.md new file mode 100644 index 000000000000..7c3f24ade509 --- /dev/null +++ b/docs-translations/pt-BR/api/shell.md @@ -0,0 +1,43 @@ +# shell + +O módulo `shell` fornece funções relacionadas intereções com o OS do usuário. + +Um exemplo para abrir uma URL no browser padrão do usuário: + +```javascript +var shell = require('shell'); +shell.openExternal('https://github.com'); +``` + +## Métodos + +O módulo `shell` tem os seguintes métodos: + +### `shell.showItemInFolder(fullPath)` + +* `fullPath` String + +Exibe o arquivo no gerenciador de arquivos padrão do sistema. Se possivel, seleciona o arquivo automaticamente. + +### `shell.openItem(fullPath)` + +* `fullPath` String + +Abre o arquivo em seu programa padrão. + +### `shell.openExternal(url)` + +* `url` String + +Abre o arquivo seguido de um protocol em seu programa padrão. (Por +exemplo, mailto:foo@bar.com.) + +### `shell.moveItemToTrash(fullPath)` + +* `fullPath` String + +Move o arquivo para a lixeira e retorna um boolean com o resultado da operação. + +### `shell.beep()` + +Toca um som beep. \ No newline at end of file From 842ec3d11ba8b1c43e99ddc6d49594db64ccc51a Mon Sep 17 00:00:00 2001 From: Jonatas Freitas Date: Wed, 16 Sep 2015 00:39:14 -0300 Subject: [PATCH 1260/1293] pt-BR README.md updated. --- docs-translations/pt-BR/README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs-translations/pt-BR/README.md b/docs-translations/pt-BR/README.md index 88fb26a5ea54..e60d9505a24a 100644 --- a/docs-translations/pt-BR/README.md +++ b/docs-translations/pt-BR/README.md @@ -17,7 +17,8 @@ ## API - Referencias * [Sinopse](../../docs/api/synopsis.md) -* [Processos](../../docs/api/process.md) +* [Processos](api/process.md) +* [Aceleradores (Teclas de Atalho)](api/accelerator.md) * [Parâmetros CLI suportados (Chrome)](../../docs/api/chrome-command-line-switches.md) DOM elementos personalizados: @@ -56,7 +57,7 @@ Módulos de ambos os processos: * [crash-reporter](../../docs/api/crash-reporter.md) * [native-image](../../docs/api/native-image.md) * [screen](../../docs/api/screen.md) -* [shell](../../docs/api/shell.md) +* [shell](api/shell.md) ## Desenvolvimento From b9c274929bc2095cbcd18620cc2771cbf539b401 Mon Sep 17 00:00:00 2001 From: Ryohei Ikegami Date: Wed, 16 Sep 2015 17:16:21 +0900 Subject: [PATCH 1261/1293] Add app.getLocale() --- atom/browser/api/atom_api_app.cc | 6 ++++++ atom/browser/api/atom_api_app.h | 1 + spec/api-app-spec.coffee | 4 ++++ 3 files changed, 11 insertions(+) diff --git a/atom/browser/api/atom_api_app.cc b/atom/browser/api/atom_api_app.cc index 43b3d82df109..2e7596971f48 100644 --- a/atom/browser/api/atom_api_app.cc +++ b/atom/browser/api/atom_api_app.cc @@ -30,6 +30,7 @@ #include "native_mate/dictionary.h" #include "native_mate/object_template_builder.h" #include "net/ssl/ssl_cert_request_info.h" +#include "ui/base/l10n/l10n_util.h" #if defined(OS_WIN) #include "base/strings/utf_string_conversions.h" @@ -248,6 +249,10 @@ void App::SetAppUserModelId(const std::string& app_id) { #endif } +std::string App::GetLocale() { + return l10n_util::GetApplicationLocale(""); +} + v8::Local App::DefaultSession(v8::Isolate* isolate) { if (default_session_.IsEmpty()) return v8::Null(isolate); @@ -278,6 +283,7 @@ mate::ObjectTemplateBuilder App::GetObjectTemplateBuilder( .SetMethod("getPath", &App::GetPath) .SetMethod("setDesktopName", &App::SetDesktopName) .SetMethod("setAppUserModelId", &App::SetAppUserModelId) + .SetMethod("getLocale", &App::GetLocale) .SetProperty("defaultSession", &App::DefaultSession); } diff --git a/atom/browser/api/atom_api_app.h b/atom/browser/api/atom_api_app.h index 255f780e578d..4896a5f066a1 100644 --- a/atom/browser/api/atom_api_app.h +++ b/atom/browser/api/atom_api_app.h @@ -65,6 +65,7 @@ class App : public mate::EventEmitter, void SetDesktopName(const std::string& desktop_name); void SetAppUserModelId(const std::string& app_id); + std::string GetLocale(); v8::Local DefaultSession(v8::Isolate* isolate); v8::Global default_session_; diff --git a/spec/api-app-spec.coffee b/spec/api-app-spec.coffee index 38ef22ac80bd..4b1a04e00827 100644 --- a/spec/api-app-spec.coffee +++ b/spec/api-app-spec.coffee @@ -26,6 +26,10 @@ describe 'app module', -> assert.equal app.getName(), 'test-name' app.setName 'Electron Test' + describe 'app.getLocale()', -> + it 'should not be empty', -> + assert.notEqual app.getLocale(), '' + describe 'BrowserWindow events', -> w = null afterEach -> From 7b75b29265e9d67851150076a4d58ef32a35b2c8 Mon Sep 17 00:00:00 2001 From: Ryohei Ikegami Date: Wed, 16 Sep 2015 17:17:49 +0900 Subject: [PATCH 1262/1293] Add docs for app.getLocale() --- docs/api/app.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/api/app.md b/docs/api/app.md index 85ad873de30d..e4a8d561e2f5 100644 --- a/docs/api/app.md +++ b/docs/api/app.md @@ -239,6 +239,10 @@ to the npm modules spec. You should usually also specify a `productName` field, which is your application's full capitalized name, and which will be preferred over `name` by Electron. +### `app.getLocale()` + +Returns the current application locale. + ### `app.resolveProxy(url, callback)` * `url` URL From cb13d8bdc7b5fbaa29d7087f7f5b25d2cbc2ef86 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Wed, 16 Sep 2015 19:59:03 +0800 Subject: [PATCH 1263/1293] Update brightray for #2790 --- vendor/brightray | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/brightray b/vendor/brightray index 41f5c2caeaa2..d385c9b1b88d 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit 41f5c2caeaa246b2d4ede37dc49345e313b19b5a +Subproject commit d385c9b1b88da3ba1b5426861ec7c63e8c884135 From 9fd5a64cd8f853d12a6fdf594f3ce3ad278041ab Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 17 Sep 2015 11:25:27 +0800 Subject: [PATCH 1264/1293] Update brightray to unsubscribe from NSNotificationCenter --- vendor/brightray | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/brightray b/vendor/brightray index d385c9b1b88d..f103af2f6bb3 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit d385c9b1b88da3ba1b5426861ec7c63e8c884135 +Subproject commit f103af2f6bb38bb4ceeabd8688d8dee87ccefca1 From e3c64d79716fa40e000827355d3d2d6f744554ee Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 17 Sep 2015 11:30:17 +0800 Subject: [PATCH 1265/1293] Release the native window after window gets closed Previously we delete the window after the JS object gets garbage collected, which is too late for releasing some resources. --- atom/browser/api/atom_api_window.cc | 3 +++ 1 file changed, 3 insertions(+) diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index 1a76c3e5f078..3503fb4eb0fc 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -116,6 +116,9 @@ void Window::OnWindowClosed() { window_->RemoveObserver(this); Emit("closed"); + + // Clean up the resources after window has been closed. + base::MessageLoop::current()->DeleteSoon(FROM_HERE, window_.release()); } void Window::OnWindowBlur() { From e73c655d653b59f139f02b49c3a6d2224049ce14 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 17 Sep 2015 11:32:19 +0800 Subject: [PATCH 1266/1293] No need to delete window in Destory The native window is now automatically deleted after it gets closed. --- atom/browser/api/atom_api_window.cc | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index 3503fb4eb0fc..4c82ef1fad5f 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -223,10 +223,8 @@ bool Window::IsDestroyed() const { } void Window::Destroy() { - if (window_) { + if (window_) window_->CloseContents(nullptr); - window_.reset(); - } } void Window::Close() { From e30dd943dbf105e25108d96a0322a941c5d1cfeb Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 17 Sep 2015 15:01:33 +0800 Subject: [PATCH 1267/1293] Update brightray for #2808 --- vendor/brightray | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/brightray b/vendor/brightray index f103af2f6bb3..25f3a9d0a5b7 160000 --- a/vendor/brightray +++ b/vendor/brightray @@ -1 +1 @@ -Subproject commit f103af2f6bb38bb4ceeabd8688d8dee87ccefca1 +Subproject commit 25f3a9d0a5b73ec170a65f4e2e4c9ad91e23fc8c From 93639a080c22974b71e5f9992c6b7c976035587f Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 17 Sep 2015 15:12:15 +0800 Subject: [PATCH 1268/1293] spec: setImmediate should work in forked scripts --- spec/fixtures/module/set-immediate.js | 11 +++++++++++ spec/node-spec.coffee | 7 +++++++ 2 files changed, 18 insertions(+) create mode 100644 spec/fixtures/module/set-immediate.js diff --git a/spec/fixtures/module/set-immediate.js b/spec/fixtures/module/set-immediate.js new file mode 100644 index 000000000000..e7d44a75d1fe --- /dev/null +++ b/spec/fixtures/module/set-immediate.js @@ -0,0 +1,11 @@ +process.on('uncaughtException', function(error) { + process.send(error.message); + process.exit(1); +}); + +process.on('message', function(msg) { + setImmediate(function() { + process.send('ok'); + process.exit(0); + }); +}); diff --git a/spec/node-spec.coffee b/spec/node-spec.coffee index 94174c38b743..f998a8c5b7b2 100644 --- a/spec/node-spec.coffee +++ b/spec/node-spec.coffee @@ -56,6 +56,13 @@ describe 'node feature', -> done() child.send 'message' + it 'has setImmediate working in script', (done) -> + child = child_process.fork path.join(fixtures, 'module', 'set-immediate.js') + child.on 'message', (msg) -> + assert.equal msg, 'ok' + done() + child.send 'message' + describe 'contexts', -> describe 'setTimeout in fs callback', -> it 'does not crash', (done) -> From 5604655d547b13532efcf1aeb36863f4f57e90cf Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 17 Sep 2015 16:06:19 +0800 Subject: [PATCH 1269/1293] spec: vm.createContext should not crash --- spec/node-spec.coffee | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/spec/node-spec.coffee b/spec/node-spec.coffee index f998a8c5b7b2..c8d569e01ada 100644 --- a/spec/node-spec.coffee +++ b/spec/node-spec.coffee @@ -148,3 +148,7 @@ describe 'node feature', -> # Not reliable on some machines xit 'should have isTTY defined', -> assert.equal typeof(process.stdout.isTTY), 'boolean' + + describe 'vm.createContext', -> + it 'should not crash', -> + require('vm').runInNewContext('') From 2be6bdcf4a0c6927f4e7e32f754072ca6eab2d5c Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 17 Sep 2015 16:06:35 +0800 Subject: [PATCH 1270/1293] Update to node v4.1.0 --- vendor/node | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vendor/node b/vendor/node index 4098d45fbb82..aa9c7a2316ba 160000 --- a/vendor/node +++ b/vendor/node @@ -1 +1 @@ -Subproject commit 4098d45fbb822370c19d2fe7b88162759db4eb96 +Subproject commit aa9c7a2316ba7762f1d04d091585695be3e6be22 From d28789b5098ad9797b888c804da026487c380a58 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 17 Sep 2015 16:11:14 +0800 Subject: [PATCH 1271/1293] Change version to v0.32.4 This makes sure the native modules are built against the headers of v0.32.4, since Node.js v4.1.0 has bumped the module version. --- atom.gyp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/atom.gyp b/atom.gyp index 63defa4273fd..b49f3ac64bdd 100644 --- a/atom.gyp +++ b/atom.gyp @@ -4,7 +4,7 @@ 'product_name%': 'Electron', 'company_name%': 'GitHub, Inc', 'company_abbr%': 'github', - 'version%': '0.32.3', + 'version%': '0.32.4', }, 'includes': [ 'filenames.gypi', From 01ed2c4222bf77c2592dcd234d8c99a8636497cc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ionic=C4=83=20Biz=C4=83u?= Date: Thu, 17 Sep 2015 12:24:12 +0300 Subject: [PATCH 1272/1293] Fixed the mapNumbers require call Since mapNumber.js is a file, we should prefix it with "./", otherwise an error is thrown. --- docs/api/remote.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/remote.md b/docs/api/remote.md index 1c5c831a1790..55893c65f1c4 100644 --- a/docs/api/remote.md +++ b/docs/api/remote.md @@ -79,7 +79,7 @@ exports.withLocalCallback = function() { ```javascript // renderer process -var mapNumbers = require("remote").require("mapNumbers"); +var mapNumbers = require("remote").require("./mapNumbers"); var withRendererCb = mapNumbers.withRendererCallback(function(x) { return x + 1; From a46cb8cebb432d6d80ce24b7dbe1c47ed396bbdd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ionic=C4=83=20Biz=C4=83u?= Date: Thu, 17 Sep 2015 12:34:15 +0300 Subject: [PATCH 1273/1293] Fix the git commit messages hash link --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 516f6289ac0f..6ca3ea5d2f32 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,7 +30,7 @@ possible with your report. If you can, please include: * Follow the CoffeeScript, JavaScript, C++ and Python [coding style defined in docs](/docs/development/coding-style.md). * Write documentation in [Markdown](https://daringfireball.net/projects/markdown). See the [Documentation Styleguide](/docs/styleguide.md). -* Use short, present tense commit messages. See [Commit Message Styleguide](#git-commit-messages-styleguide). +* Use short, present tense commit messages. See [Commit Message Styleguide](#git-commit-messages). ## Styleguides From 1348e18a81706c7764f5b5543baf0f6409a78cd4 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Thu, 17 Sep 2015 18:31:12 +0800 Subject: [PATCH 1274/1293] Bump v0.33.0 --- atom.gyp | 2 +- atom/browser/resources/mac/Info.plist | 2 +- atom/browser/resources/win/atom.rc | 8 ++++---- atom/common/atom_version.h | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/atom.gyp b/atom.gyp index b49f3ac64bdd..c9d5f924789f 100644 --- a/atom.gyp +++ b/atom.gyp @@ -4,7 +4,7 @@ 'product_name%': 'Electron', 'company_name%': 'GitHub, Inc', 'company_abbr%': 'github', - 'version%': '0.32.4', + 'version%': '0.33.0', }, 'includes': [ 'filenames.gypi', diff --git a/atom/browser/resources/mac/Info.plist b/atom/browser/resources/mac/Info.plist index dd4e610d917e..54ba3546a75f 100644 --- a/atom/browser/resources/mac/Info.plist +++ b/atom/browser/resources/mac/Info.plist @@ -17,7 +17,7 @@ CFBundleIconFile atom.icns CFBundleVersion - 0.32.3 + 0.33.0 LSMinimumSystemVersion 10.8.0 NSMainNibFile diff --git a/atom/browser/resources/win/atom.rc b/atom/browser/resources/win/atom.rc index cf894f6b5c33..8863d8be7677 100644 --- a/atom/browser/resources/win/atom.rc +++ b/atom/browser/resources/win/atom.rc @@ -56,8 +56,8 @@ END // VS_VERSION_INFO VERSIONINFO - FILEVERSION 0,32,3,0 - PRODUCTVERSION 0,32,3,0 + FILEVERSION 0,33,0,0 + PRODUCTVERSION 0,33,0,0 FILEFLAGSMASK 0x3fL #ifdef _DEBUG FILEFLAGS 0x1L @@ -74,12 +74,12 @@ BEGIN BEGIN VALUE "CompanyName", "GitHub, Inc." VALUE "FileDescription", "Electron" - VALUE "FileVersion", "0.32.3" + VALUE "FileVersion", "0.33.0" VALUE "InternalName", "electron.exe" VALUE "LegalCopyright", "Copyright (C) 2015 GitHub, Inc. All rights reserved." VALUE "OriginalFilename", "electron.exe" VALUE "ProductName", "Electron" - VALUE "ProductVersion", "0.32.3" + VALUE "ProductVersion", "0.33.0" VALUE "SquirrelAwareVersion", "1" END END diff --git a/atom/common/atom_version.h b/atom/common/atom_version.h index 8d71e9150540..deb09585434e 100644 --- a/atom/common/atom_version.h +++ b/atom/common/atom_version.h @@ -6,8 +6,8 @@ #define ATOM_VERSION_H #define ATOM_MAJOR_VERSION 0 -#define ATOM_MINOR_VERSION 32 -#define ATOM_PATCH_VERSION 3 +#define ATOM_MINOR_VERSION 33 +#define ATOM_PATCH_VERSION 0 #define ATOM_VERSION_IS_RELEASE 1 From 6b875110ed8b20c0da142c56b96d0d61b1564c3b Mon Sep 17 00:00:00 2001 From: Gohy Leandre Date: Mon, 31 Aug 2015 11:19:19 +0200 Subject: [PATCH 1275/1293] Add device emulation API --- atom/browser/api/atom_api_web_contents.cc | 88 +++++++++++++++++++++++ atom/browser/api/atom_api_web_contents.h | 2 + docs/api/web-contents.md | 35 +++++++++ 3 files changed, 125 insertions(+) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index a24200e5a87d..2231a591f732 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -27,6 +27,7 @@ #include "brightray/browser/inspectable_web_contents.h" #include "chrome/browser/printing/print_view_manager_basic.h" #include "chrome/browser/printing/print_preview_message_handler.h" +#include "content/common/view_messages.h" #include "content/public/browser/favicon_status.h" #include "content/public/browser/navigation_details.h" #include "content/public/browser/navigation_entry.h" @@ -44,6 +45,7 @@ #include "net/http/http_response_headers.h" #include "net/url_request/static_http_user_agent_settings.h" #include "net/url_request/url_request_context.h" +#include "third_party/WebKit/public/web/WebDeviceEmulationParams.h" #include "atom/common/node_includes.h" @@ -640,6 +642,88 @@ bool WebContents::IsDevToolsOpened() { return managed_web_contents()->IsDevToolsViewShowing(); } +void WebContents::EnableDeviceEmulation(const base::DictionaryValue& dict) { + if (type_ == REMOTE) + return; + + blink::WebDeviceEmulationParams params; + + if (dict.HasKey("screenPosition")) { + std::string screen_position; + if (!dict.GetString("screenPosition", &screen_position)) + return; + + screen_position = base::StringToLowerASCII(screen_position); + + if (screen_position == "mobile") { + params.screenPosition = blink::WebDeviceEmulationParams::Mobile; + } else if (screen_position == "desktop") { + params.screenPosition = blink::WebDeviceEmulationParams::Desktop; + } else { + return; + } + } + + if (dict.HasKey("screenSize")) { + if (!dict.GetInteger("screenSize.width", ¶ms.screenSize.width)) + return; + if (!dict.GetInteger("screenSize.height", ¶ms.screenSize.height)) + return; + } + + if (dict.HasKey("viewPosition")) { + if (!dict.GetInteger("viewPosition.x", ¶ms.viewPosition.x)) + return; + if (!dict.GetInteger("viewPosition.y", ¶ms.viewPosition.y)) + return; + } + + if (dict.HasKey("deviceScaleFactor")) { + double device_scale_factor; + if (!dict.GetDouble("deviceScaleFactor", &device_scale_factor)) + return; + params.deviceScaleFactor = static_cast(device_scale_factor); + } + + if (dict.HasKey("viewSize")) { + if (!dict.GetInteger("viewSize.width", ¶ms.viewSize.width)) + return; + if (!dict.GetInteger("viewSize.height", ¶ms.viewSize.height)) + return; + } + + if (dict.HasKey("fitToView")) { + if (!dict.GetBoolean("fitToView", ¶ms.fitToView)) + return; + } + + if (dict.HasKey("offset")) { + double x, y; + if (!dict.GetDouble("offset.x", &x)) + return; + if (!dict.GetDouble("offset.y", &y)) + return; + params.offset.x = static_cast(x); + params.offset.y = static_cast(y); + } + + if (dict.HasKey("scale")) { + double scale; + if (!dict.GetDouble("scale", &scale)) + return; + params.scale = static_cast(scale); + } + + Send(new ViewMsg_EnableDeviceEmulation(routing_id(), params)); +} + +void WebContents::DisableDeviceEmulation() { + if (type_ == REMOTE) + return; + + Send(new ViewMsg_DisableDeviceEmulation(routing_id())); +} + void WebContents::ToggleDevTools() { if (IsDevToolsOpened()) CloseDevTools(); @@ -836,6 +920,10 @@ mate::ObjectTemplateBuilder WebContents::GetObjectTemplateBuilder( .SetMethod("openDevTools", &WebContents::OpenDevTools) .SetMethod("closeDevTools", &WebContents::CloseDevTools) .SetMethod("isDevToolsOpened", &WebContents::IsDevToolsOpened) + .SetMethod("enableDeviceEmulation", + &WebContents::EnableDeviceEmulation) + .SetMethod("disableDeviceEmulation", + &WebContents::DisableDeviceEmulation) .SetMethod("toggleDevTools", &WebContents::ToggleDevTools) .SetMethod("inspectElement", &WebContents::InspectElement) .SetMethod("setAudioMuted", &WebContents::SetAudioMuted) diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index 0001d3e8ef75..c765e5cbf4e4 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -74,6 +74,8 @@ class WebContents : public mate::TrackableObject, void CloseDevTools(); bool IsDevToolsOpened(); void ToggleDevTools(); + void EnableDeviceEmulation(const base::DictionaryValue&); + void DisableDeviceEmulation(); void InspectElement(int x, int y); void InspectServiceWorker(); v8::Local Session(v8::Isolate* isolate); diff --git a/docs/api/web-contents.md b/docs/api/web-contents.md index 92d91d170e4a..8b4ebcc33784 100644 --- a/docs/api/web-contents.md +++ b/docs/api/web-contents.md @@ -476,3 +476,38 @@ app.on('ready', function() { which is different from the handlers in the main process. 2. There is no way to send synchronous messages from the main process to a renderer process, because it would be very easy to cause dead locks. + +### `webContents.enableDeviceEmulation(parameters)` + +`parameters` Object, properties: + +* `screenPosition` String - Specify the screen type to emulate + (default: `desktop`) + * `desktop` + * `mobile` +* `screenSize` Object - Set the emulated screen size (screenPosition == mobile) + * `width` Integer - Set the emulated screen width + * `height` Integer - Set the emulated screen height +* `viewPosition` Object - Position the view on the screen + (screenPosition == mobile) (default: `{x: 0, y: 0}`) + * `x` Integer - Set the x axis offset from top left corner + * `y` Integer - Set the y axis offset from top left corner +* `deviceScaleFactor` Integer - Set the device scale factor (if zero defaults to + original device scale factor) (default: `0`) +* `viewSize` Object - Set the emulated view size (empty means no override) + * `width` Integer - Set the emulated view width + * `height` Integer - Set the emulated view height +* `fitToView` Boolean - Whether emulated view should be scaled down if + necessary to fit into available space (default: `false`) +* `offset` Object - Offset of the emulated view inside available space (not in + fit to view mode) (default: `{x: 0, y: 0}`) + * `x` Float - Set the x axis offset from top left corner + * `y` Float - Set the y axis offset from top left corner +* `scale` Float - Scale of emulated view inside available space (not in fit to + view mode) (default: `1`) + +Enable device emulation with the given parameters. + +### `webContents.disableDeviceEmulation()` + +Disable device emulation enabled by `webContents.enableDeviceEmulation`. From 7dc7ee1c4195351eee08d0fe5cef172c3c201a0f Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 18 Sep 2015 11:06:38 +0800 Subject: [PATCH 1276/1293] Move the converters for blink structures to another file It makes the api::WebContents smaller. --- atom/browser/api/atom_api_web_contents.cc | 73 +------------------ atom/browser/api/atom_api_web_contents.h | 6 +- .../native_mate_converters/blink_converter.cc | 65 +++++++++++++++++ .../native_mate_converters/blink_converter.h | 45 ++++++++++++ filenames.gypi | 2 + 5 files changed, 120 insertions(+), 71 deletions(-) create mode 100644 atom/common/native_mate_converters/blink_converter.cc create mode 100644 atom/common/native_mate_converters/blink_converter.h diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 2231a591f732..d4cb6cd227d5 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -15,6 +15,7 @@ #include "atom/browser/web_view_guest_delegate.h" #include "atom/common/api/api_messages.h" #include "atom/common/api/event_emitter_caller.h" +#include "atom/common/native_mate_converters/blink_converter.h" #include "atom/common/native_mate_converters/callback.h" #include "atom/common/native_mate_converters/file_path_converter.h" #include "atom/common/native_mate_converters/gfx_converter.h" @@ -45,7 +46,6 @@ #include "net/http/http_response_headers.h" #include "net/url_request/static_http_user_agent_settings.h" #include "net/url_request/url_request_context.h" -#include "third_party/WebKit/public/web/WebDeviceEmulationParams.h" #include "atom/common/node_includes.h" @@ -642,78 +642,11 @@ bool WebContents::IsDevToolsOpened() { return managed_web_contents()->IsDevToolsViewShowing(); } -void WebContents::EnableDeviceEmulation(const base::DictionaryValue& dict) { +void WebContents::EnableDeviceEmulation( + const blink::WebDeviceEmulationParams& params) { if (type_ == REMOTE) return; - blink::WebDeviceEmulationParams params; - - if (dict.HasKey("screenPosition")) { - std::string screen_position; - if (!dict.GetString("screenPosition", &screen_position)) - return; - - screen_position = base::StringToLowerASCII(screen_position); - - if (screen_position == "mobile") { - params.screenPosition = blink::WebDeviceEmulationParams::Mobile; - } else if (screen_position == "desktop") { - params.screenPosition = blink::WebDeviceEmulationParams::Desktop; - } else { - return; - } - } - - if (dict.HasKey("screenSize")) { - if (!dict.GetInteger("screenSize.width", ¶ms.screenSize.width)) - return; - if (!dict.GetInteger("screenSize.height", ¶ms.screenSize.height)) - return; - } - - if (dict.HasKey("viewPosition")) { - if (!dict.GetInteger("viewPosition.x", ¶ms.viewPosition.x)) - return; - if (!dict.GetInteger("viewPosition.y", ¶ms.viewPosition.y)) - return; - } - - if (dict.HasKey("deviceScaleFactor")) { - double device_scale_factor; - if (!dict.GetDouble("deviceScaleFactor", &device_scale_factor)) - return; - params.deviceScaleFactor = static_cast(device_scale_factor); - } - - if (dict.HasKey("viewSize")) { - if (!dict.GetInteger("viewSize.width", ¶ms.viewSize.width)) - return; - if (!dict.GetInteger("viewSize.height", ¶ms.viewSize.height)) - return; - } - - if (dict.HasKey("fitToView")) { - if (!dict.GetBoolean("fitToView", ¶ms.fitToView)) - return; - } - - if (dict.HasKey("offset")) { - double x, y; - if (!dict.GetDouble("offset.x", &x)) - return; - if (!dict.GetDouble("offset.y", &y)) - return; - params.offset.x = static_cast(x); - params.offset.y = static_cast(y); - } - - if (dict.HasKey("scale")) { - double scale; - if (!dict.GetDouble("scale", &scale)) - return; - params.scale = static_cast(scale); - } - Send(new ViewMsg_EnableDeviceEmulation(routing_id(), params)); } diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index c765e5cbf4e4..0ce47237e494 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -15,6 +15,10 @@ #include "native_mate/handle.h" #include "ui/gfx/image/image.h" +namespace blink { +struct WebDeviceEmulationParams; +} + namespace brightray { class InspectableWebContents; } @@ -74,7 +78,7 @@ class WebContents : public mate::TrackableObject, void CloseDevTools(); bool IsDevToolsOpened(); void ToggleDevTools(); - void EnableDeviceEmulation(const base::DictionaryValue&); + void EnableDeviceEmulation(const blink::WebDeviceEmulationParams& params); void DisableDeviceEmulation(); void InspectElement(int x, int y); void InspectServiceWorker(); diff --git a/atom/common/native_mate_converters/blink_converter.cc b/atom/common/native_mate_converters/blink_converter.cc new file mode 100644 index 000000000000..9225f548380e --- /dev/null +++ b/atom/common/native_mate_converters/blink_converter.cc @@ -0,0 +1,65 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#include "atom/common/native_mate_converters/blink_converter.h" + +#include "base/strings/string_util.h" +#include "native_mate/dictionary.h" +#include "third_party/WebKit/public/web/WebDeviceEmulationParams.h" + +namespace mate { + +bool Converter::FromV8( + v8::Isolate* isolate, v8::Local val, blink::WebFloatPoint* out) { + mate::Dictionary dict; + if (!ConvertFromV8(isolate, val, &dict)) + return false; + return dict.Get("x", &out->x) && dict.Get("y", &out->y); +} + +bool Converter::FromV8( + v8::Isolate* isolate, v8::Local val, blink::WebPoint* out) { + mate::Dictionary dict; + if (!ConvertFromV8(isolate, val, &dict)) + return false; + return dict.Get("x", &out->x) && dict.Get("y", &out->y); +} + +bool Converter::FromV8( + v8::Isolate* isolate, v8::Local val, blink::WebSize* out) { + mate::Dictionary dict; + if (!ConvertFromV8(isolate, val, &dict)) + return false; + return dict.Get("width", &out->width) && dict.Get("height", &out->height); +} + +bool Converter::FromV8( + v8::Isolate* isolate, v8::Local val, + blink::WebDeviceEmulationParams* out) { + mate::Dictionary dict; + if (!ConvertFromV8(isolate, val, &dict)) + return false; + + std::string screen_position; + if (dict.Get("screenPosition", &screen_position)) { + screen_position = base::StringToLowerASCII(screen_position); + if (screen_position == "mobile") + out->screenPosition = blink::WebDeviceEmulationParams::Mobile; + else if (screen_position == "desktop") + out->screenPosition = blink::WebDeviceEmulationParams::Desktop; + else + return false; + } + + dict.Get("screenSize", &out->screenSize); + dict.Get("viewPosition", &out->viewPosition); + dict.Get("deviceScaleFactor", &out->deviceScaleFactor); + dict.Get("viewSize", &out->viewSize); + dict.Get("fitToView", &out->fitToView); + dict.Get("offset", &out->offset); + dict.Get("scale", &out->scale); + return true; +} + +} // namespace mate diff --git a/atom/common/native_mate_converters/blink_converter.h b/atom/common/native_mate_converters/blink_converter.h new file mode 100644 index 000000000000..bbd2af0e679f --- /dev/null +++ b/atom/common/native_mate_converters/blink_converter.h @@ -0,0 +1,45 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#ifndef ATOM_COMMON_NATIVE_MATE_CONVERTERS_BLINK_CONVERTER_H_ +#define ATOM_COMMON_NATIVE_MATE_CONVERTERS_BLINK_CONVERTER_H_ + +#include "native_mate/converter.h" + +namespace blink { +struct WebDeviceEmulationParams; +struct WebFloatPoint; +struct WebPoint; +struct WebSize; +} + +namespace mate { + +template<> +struct Converter { + static bool FromV8(v8::Isolate* isolate, v8::Local val, + blink::WebFloatPoint* out); +}; + +template<> +struct Converter { + static bool FromV8(v8::Isolate* isolate, v8::Local val, + blink::WebPoint* out); +}; + +template<> +struct Converter { + static bool FromV8(v8::Isolate* isolate, v8::Local val, + blink::WebSize* out); +}; + +template<> +struct Converter { + static bool FromV8(v8::Isolate* isolate, v8::Local val, + blink::WebDeviceEmulationParams* out); +}; + +} // namespace mate + +#endif // ATOM_COMMON_NATIVE_MATE_CONVERTERS_BLINK_CONVERTER_H_ diff --git a/filenames.gypi b/filenames.gypi index 461c812753c9..ce679640334d 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -286,6 +286,8 @@ 'atom/common/linux/application_info.cc', 'atom/common/native_mate_converters/accelerator_converter.cc', 'atom/common/native_mate_converters/accelerator_converter.h', + 'atom/common/native_mate_converters/blink_converter.cc', + 'atom/common/native_mate_converters/blink_converter.h', 'atom/common/native_mate_converters/callback.h', 'atom/common/native_mate_converters/file_path_converter.h', 'atom/common/native_mate_converters/gfx_converter.cc', From 5aa7cf7a3021c19dc30af3505b1f975a89934978 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 18 Sep 2015 11:10:32 +0800 Subject: [PATCH 1277/1293] Fix cpplint warning --- atom/common/native_mate_converters/blink_converter.cc | 2 ++ 1 file changed, 2 insertions(+) diff --git a/atom/common/native_mate_converters/blink_converter.cc b/atom/common/native_mate_converters/blink_converter.cc index 9225f548380e..5d3ff62086ca 100644 --- a/atom/common/native_mate_converters/blink_converter.cc +++ b/atom/common/native_mate_converters/blink_converter.cc @@ -4,6 +4,8 @@ #include "atom/common/native_mate_converters/blink_converter.h" +#include + #include "base/strings/string_util.h" #include "native_mate/dictionary.h" #include "third_party/WebKit/public/web/WebDeviceEmulationParams.h" From ec90d03d74102133d62a1e24155580338bdb36dd Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 18 Sep 2015 12:10:00 +0800 Subject: [PATCH 1278/1293] Fix compilation error --- atom/browser/api/atom_api_window.cc | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index 6d6316d91312..b8d2c463eb4c 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -9,7 +9,6 @@ #include "atom/browser/browser.h" #include "atom/browser/native_window.h" #include "atom/common/node_includes.h" -#include "atom/common/options_switches.h" #include "atom/common/event_types.h" #include "atom/common/native_mate_converters/callback.h" #include "atom/common/native_mate_converters/gfx_converter.h" @@ -21,7 +20,6 @@ #include "native_mate/constructor.h" #include "native_mate/dictionary.h" #include "ui/gfx/geometry/rect.h" -#include "v8/include/v8.h" #if defined(OS_WIN) #include "atom/browser/native_window_views.h" @@ -112,10 +110,11 @@ void Window::WillCloseWindow(bool* prevent_default) { void Window::OnFrameRendered(scoped_ptr rgb, const int size) { v8::Locker locker(isolate()); v8::HandleScope handle_scope(isolate()); - - auto data = node::Buffer::New(isolate(), reinterpret_cast(rgb.get()), static_cast(size)); - - Emit("frame-rendered", data, size); + v8::MaybeLocal data = node::Buffer::New( + isolate(), + reinterpret_cast(rgb.release()), + static_cast(size)); + Emit("frame-rendered", data.ToLocalChecked(), size); } void Window::OnWindowClosed() { From d7bac5a10b252c17ffe060840ea26dd275005e76 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 18 Sep 2015 12:15:13 +0800 Subject: [PATCH 1279/1293] Remove the offscreen-render option We are going to move the APIs to WebContents --- atom/browser/native_window.cc | 11 ----------- atom/browser/native_window.h | 3 --- atom/common/options_switches.cc | 2 -- atom/common/options_switches.h | 2 -- 4 files changed, 18 deletions(-) diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index b88c37576d08..9121f0cb8871 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -167,9 +167,6 @@ void NativeWindow::InitFromOptions(const mate::Dictionary& options) { options.Get(switches::kTitle, &title); SetTitle(title); - offscreen_ = false; - options.Get(switches::kOffScreenRender, &offscreen_); - // Then show it. bool show = true; options.Get(switches::kShow, &show); @@ -297,8 +294,6 @@ void NativeWindow::CapturePage(const gfx::Rect& rect, } void NativeWindow::SetFrameSubscription(bool isOffscreen) { - if (!isOffscreen && !offscreen_) return; - const auto view = web_contents()->GetRenderWidgetHostView(); if (view) { @@ -314,8 +309,6 @@ void NativeWindow::SetFrameSubscription(bool isOffscreen) { } else { view->EndFrameSubscription(); } - - offscreen_ = isOffscreen; } } @@ -520,10 +513,6 @@ void NativeWindow::SendMouseWheelEvent(int modifiers, int x, int y, bool precise host->ForwardWheelEvent(*wheel_event); } -void NativeWindow::DidFinishLoad(content::RenderFrameHost* render_frame_host, const GURL& validated_url) { - SetFrameSubscription(offscreen_); -} - void NativeWindow::RenderViewCreated( content::RenderViewHost* render_view_host) { if (!transparent_) diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index e7de4ebc6556..5784743af86a 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -246,7 +246,6 @@ class NativeWindow : public content::WebContentsObserver, // content::WebContentsObserver: void RenderViewCreated(content::RenderViewHost* render_view_host) override; - void DidFinishLoad(content::RenderFrameHost* render_frame_host, const GURL& validated_url) override; void BeforeUnloadDialogCancelled() override; void TitleWasSet(content::NavigationEntry* entry, bool explicit_set) override; bool OnMessageReceived(const IPC::Message& message) override; @@ -267,8 +266,6 @@ class NativeWindow : public content::WebContentsObserver, const SkBitmap& bitmap, content::ReadbackResponse response); - bool offscreen_; - // Whether window has standard frame. bool has_frame_; diff --git a/atom/common/options_switches.cc b/atom/common/options_switches.cc index 75688ec45bf7..2268a4039513 100644 --- a/atom/common/options_switches.cc +++ b/atom/common/options_switches.cc @@ -116,8 +116,6 @@ const char kRegisterStandardSchemes[] = "register-standard-schemes"; // The browser process app model ID const char kAppUserModelId[] = "app-user-model-id"; -const char kOffScreenRender[] = "offscreen-render"; - const char kModifiers[] = "modifiers"; const char kKeyCode[] = "code"; const char kNativeKeyCode[] = "native"; diff --git a/atom/common/options_switches.h b/atom/common/options_switches.h index 6ce6d7f4eddc..eb7842e78769 100644 --- a/atom/common/options_switches.h +++ b/atom/common/options_switches.h @@ -62,8 +62,6 @@ extern const char kRegisterStandardSchemes[]; extern const char kAppUserModelId[]; -extern const char kOffScreenRender[]; - extern const char kModifiers[]; extern const char kKeyCode[]; extern const char kNativeKeyCode[]; From 84ce441fb6e7bd73d9ab404e5d81a390acd78f2f Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 18 Sep 2015 13:33:06 +0800 Subject: [PATCH 1280/1293] Add converters for WebInputEvent --- atom/browser/ui/accelerator_util.cc | 71 +------ atom/common/keyboad_util.cc | 73 +++++++ atom/common/keyboad_util.h | 18 ++ .../native_mate_converters/blink_converter.cc | 184 ++++++++++++++++++ .../native_mate_converters/blink_converter.h | 38 ++++ filenames.gypi | 2 + 6 files changed, 317 insertions(+), 69 deletions(-) create mode 100644 atom/common/keyboad_util.cc create mode 100644 atom/common/keyboad_util.h diff --git a/atom/browser/ui/accelerator_util.cc b/atom/browser/ui/accelerator_util.cc index 41dde7acf732..e25e14b7968c 100644 --- a/atom/browser/ui/accelerator_util.cc +++ b/atom/browser/ui/accelerator_util.cc @@ -9,6 +9,7 @@ #include #include +#include "atom/common/keyboad_util.h" #include "base/stl_util.h" #include "base/strings/string_number_conversions.h" #include "base/strings/string_split.h" @@ -17,74 +18,6 @@ namespace accelerator_util { -namespace { - -// Return key code of the char. -ui::KeyboardCode KeyboardCodeFromCharCode(char c, bool* shifted) { - *shifted = false; - switch (c) { - case 8: case 0x7F: return ui::VKEY_BACK; - case 9: return ui::VKEY_TAB; - case 0xD: case 3: return ui::VKEY_RETURN; - case 0x1B: return ui::VKEY_ESCAPE; - case ' ': return ui::VKEY_SPACE; - - case 'a': return ui::VKEY_A; - case 'b': return ui::VKEY_B; - case 'c': return ui::VKEY_C; - case 'd': return ui::VKEY_D; - case 'e': return ui::VKEY_E; - case 'f': return ui::VKEY_F; - case 'g': return ui::VKEY_G; - case 'h': return ui::VKEY_H; - case 'i': return ui::VKEY_I; - case 'j': return ui::VKEY_J; - case 'k': return ui::VKEY_K; - case 'l': return ui::VKEY_L; - case 'm': return ui::VKEY_M; - case 'n': return ui::VKEY_N; - case 'o': return ui::VKEY_O; - case 'p': return ui::VKEY_P; - case 'q': return ui::VKEY_Q; - case 'r': return ui::VKEY_R; - case 's': return ui::VKEY_S; - case 't': return ui::VKEY_T; - case 'u': return ui::VKEY_U; - case 'v': return ui::VKEY_V; - case 'w': return ui::VKEY_W; - case 'x': return ui::VKEY_X; - case 'y': return ui::VKEY_Y; - case 'z': return ui::VKEY_Z; - - case ')': *shifted = true; case '0': return ui::VKEY_0; - case '!': *shifted = true; case '1': return ui::VKEY_1; - case '@': *shifted = true; case '2': return ui::VKEY_2; - case '#': *shifted = true; case '3': return ui::VKEY_3; - case '$': *shifted = true; case '4': return ui::VKEY_4; - case '%': *shifted = true; case '5': return ui::VKEY_5; - case '^': *shifted = true; case '6': return ui::VKEY_6; - case '&': *shifted = true; case '7': return ui::VKEY_7; - case '*': *shifted = true; case '8': return ui::VKEY_8; - case '(': *shifted = true; case '9': return ui::VKEY_9; - - case ':': *shifted = true; case ';': return ui::VKEY_OEM_1; - case '+': *shifted = true; case '=': return ui::VKEY_OEM_PLUS; - case '<': *shifted = true; case ',': return ui::VKEY_OEM_COMMA; - case '_': *shifted = true; case '-': return ui::VKEY_OEM_MINUS; - case '>': *shifted = true; case '.': return ui::VKEY_OEM_PERIOD; - case '?': *shifted = true; case '/': return ui::VKEY_OEM_2; - case '~': *shifted = true; case '`': return ui::VKEY_OEM_3; - case '{': *shifted = true; case '[': return ui::VKEY_OEM_4; - case '|': *shifted = true; case '\\': return ui::VKEY_OEM_5; - case '}': *shifted = true; case ']': return ui::VKEY_OEM_6; - case '"': *shifted = true; case '\'': return ui::VKEY_OEM_7; - - default: return ui::VKEY_UNKNOWN; - } -} - -} // namespace - bool StringToAccelerator(const std::string& description, ui::Accelerator* accelerator) { if (!base::IsStringASCII(description)) { @@ -104,7 +37,7 @@ bool StringToAccelerator(const std::string& description, // to be correct and usually only uses few special tokens. if (tokens[i].size() == 1) { bool shifted = false; - key = KeyboardCodeFromCharCode(tokens[i][0], &shifted); + key = atom::KeyboardCodeFromCharCode(tokens[i][0], &shifted); if (shifted) modifiers |= ui::EF_SHIFT_DOWN; } else if (tokens[i] == "ctrl" || tokens[i] == "control") { diff --git a/atom/common/keyboad_util.cc b/atom/common/keyboad_util.cc new file mode 100644 index 000000000000..1baa829ff74a --- /dev/null +++ b/atom/common/keyboad_util.cc @@ -0,0 +1,73 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#include "atom/common/keyboad_util.h" + +namespace atom { + +// Return key code of the char. +ui::KeyboardCode KeyboardCodeFromCharCode(char c, bool* shifted) { + *shifted = false; + switch (c) { + case 8: case 0x7F: return ui::VKEY_BACK; + case 9: return ui::VKEY_TAB; + case 0xD: case 3: return ui::VKEY_RETURN; + case 0x1B: return ui::VKEY_ESCAPE; + case ' ': return ui::VKEY_SPACE; + + case 'a': return ui::VKEY_A; + case 'b': return ui::VKEY_B; + case 'c': return ui::VKEY_C; + case 'd': return ui::VKEY_D; + case 'e': return ui::VKEY_E; + case 'f': return ui::VKEY_F; + case 'g': return ui::VKEY_G; + case 'h': return ui::VKEY_H; + case 'i': return ui::VKEY_I; + case 'j': return ui::VKEY_J; + case 'k': return ui::VKEY_K; + case 'l': return ui::VKEY_L; + case 'm': return ui::VKEY_M; + case 'n': return ui::VKEY_N; + case 'o': return ui::VKEY_O; + case 'p': return ui::VKEY_P; + case 'q': return ui::VKEY_Q; + case 'r': return ui::VKEY_R; + case 's': return ui::VKEY_S; + case 't': return ui::VKEY_T; + case 'u': return ui::VKEY_U; + case 'v': return ui::VKEY_V; + case 'w': return ui::VKEY_W; + case 'x': return ui::VKEY_X; + case 'y': return ui::VKEY_Y; + case 'z': return ui::VKEY_Z; + + case ')': *shifted = true; case '0': return ui::VKEY_0; + case '!': *shifted = true; case '1': return ui::VKEY_1; + case '@': *shifted = true; case '2': return ui::VKEY_2; + case '#': *shifted = true; case '3': return ui::VKEY_3; + case '$': *shifted = true; case '4': return ui::VKEY_4; + case '%': *shifted = true; case '5': return ui::VKEY_5; + case '^': *shifted = true; case '6': return ui::VKEY_6; + case '&': *shifted = true; case '7': return ui::VKEY_7; + case '*': *shifted = true; case '8': return ui::VKEY_8; + case '(': *shifted = true; case '9': return ui::VKEY_9; + + case ':': *shifted = true; case ';': return ui::VKEY_OEM_1; + case '+': *shifted = true; case '=': return ui::VKEY_OEM_PLUS; + case '<': *shifted = true; case ',': return ui::VKEY_OEM_COMMA; + case '_': *shifted = true; case '-': return ui::VKEY_OEM_MINUS; + case '>': *shifted = true; case '.': return ui::VKEY_OEM_PERIOD; + case '?': *shifted = true; case '/': return ui::VKEY_OEM_2; + case '~': *shifted = true; case '`': return ui::VKEY_OEM_3; + case '{': *shifted = true; case '[': return ui::VKEY_OEM_4; + case '|': *shifted = true; case '\\': return ui::VKEY_OEM_5; + case '}': *shifted = true; case ']': return ui::VKEY_OEM_6; + case '"': *shifted = true; case '\'': return ui::VKEY_OEM_7; + + default: return ui::VKEY_UNKNOWN; + } +} + +} // namespace atom diff --git a/atom/common/keyboad_util.h b/atom/common/keyboad_util.h new file mode 100644 index 000000000000..0496886e40bd --- /dev/null +++ b/atom/common/keyboad_util.h @@ -0,0 +1,18 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#ifndef ATOM_COMMON_KEYBOAD_UTIL_H_ +#define ATOM_COMMON_KEYBOAD_UTIL_H_ + +#include "ui/events/keycodes/keyboard_codes.h" + +namespace atom { + +// Return key code of the char, and also determine whether the SHIFT key is +// pressed. +ui::KeyboardCode KeyboardCodeFromCharCode(char c, bool* shifted); + +} // namespace atom + +#endif // ATOM_COMMON_KEYBOAD_UTIL_H_ diff --git a/atom/common/native_mate_converters/blink_converter.cc b/atom/common/native_mate_converters/blink_converter.cc index 5d3ff62086ca..afafa10b11d3 100644 --- a/atom/common/native_mate_converters/blink_converter.cc +++ b/atom/common/native_mate_converters/blink_converter.cc @@ -5,13 +5,197 @@ #include "atom/common/native_mate_converters/blink_converter.h" #include +#include +#include "atom/common/keyboad_util.h" #include "base/strings/string_util.h" +#include "content/public/browser/native_web_keyboard_event.h" #include "native_mate/dictionary.h" #include "third_party/WebKit/public/web/WebDeviceEmulationParams.h" +#include "third_party/WebKit/public/web/WebInputEvent.h" + +namespace { + +template +int VectorToBitArray(const std::vector& vec) { + int bits = 0; + for (const T& item : vec) + bits |= item; + return bits; +} + +} // namespace namespace mate { +template<> +struct Converter { + static bool FromV8(v8::Isolate* isolate, v8::Handle val, + char* out) { + std::string code = base::StringToLowerASCII(V8ToString(val)); + if (code.length() != 1) + return false; + *out = code[0]; + return true; + } +}; + +template<> +struct Converter { + static bool FromV8(v8::Isolate* isolate, v8::Handle val, + blink::WebInputEvent::Type* out) { + std::string type = base::StringToLowerASCII(V8ToString(val)); + if (type == "mousedown") + *out = blink::WebInputEvent::MouseDown; + else if (type == "mouseup") + *out = blink::WebInputEvent::MouseUp; + else if (type == "mousemove") + *out = blink::WebInputEvent::MouseMove; + else if (type == "mouseenter") + *out = blink::WebInputEvent::MouseEnter; + else if (type == "mouseleave") + *out = blink::WebInputEvent::MouseLeave; + else if (type == "contextmenu") + *out = blink::WebInputEvent::ContextMenu; + else if (type == "mousewheel") + *out = blink::WebInputEvent::MouseWheel; + else if (type == "keydown") + *out = blink::WebInputEvent::KeyDown; + else if (type == "keyup") + *out = blink::WebInputEvent::KeyUp; + else if (type == "char") + *out = blink::WebInputEvent::Char; + else if (type == "touchstart") + *out = blink::WebInputEvent::TouchStart; + else if (type == "touchmove") + *out = blink::WebInputEvent::TouchMove; + else if (type == "touchend") + *out = blink::WebInputEvent::TouchEnd; + else if (type == "touchcancel") + *out = blink::WebInputEvent::TouchCancel; + return false; + } +}; + +template<> +struct Converter { + static bool FromV8(v8::Isolate* isolate, v8::Handle val, + blink::WebInputEvent::Modifiers* out) { + std::string modifier = base::StringToLowerASCII(V8ToString(val)); + if (modifier == "shift") + *out = blink::WebInputEvent::ShiftKey; + else if (modifier == "control" || modifier == "ctrl") + *out = blink::WebInputEvent::ControlKey; + else if (modifier == "alt") + *out = blink::WebInputEvent::AltKey; + else if (modifier == "meta" || modifier == "command" || modifier == "cmd") + *out = blink::WebInputEvent::MetaKey; + else if (modifier == "iskeypad") + *out = blink::WebInputEvent::IsKeyPad; + else if (modifier == "isautorepeat") + *out = blink::WebInputEvent::IsAutoRepeat; + else if (modifier == "leftbuttondown") + *out = blink::WebInputEvent::LeftButtonDown; + else if (modifier == "middlebuttondown") + *out = blink::WebInputEvent::MiddleButtonDown; + else if (modifier == "rightbuttondown") + *out = blink::WebInputEvent::RightButtonDown; + else if (modifier == "capslock") + *out = blink::WebInputEvent::CapsLockOn; + else if (modifier == "numlock") + *out = blink::WebInputEvent::NumLockOn; + else if (modifier == "left") + *out = blink::WebInputEvent::IsLeft; + else if (modifier == "right") + *out = blink::WebInputEvent::IsRight; + return false; + } +}; + +bool Converter::FromV8( + v8::Isolate* isolate, v8::Local val, + blink::WebInputEvent* out) { + mate::Dictionary dict; + if (!ConvertFromV8(isolate, val, &dict)) + return false; + if (!dict.Get("type", &out->type)) + return false; + std::vector modifiers; + if (dict.Get("modifiers", &modifiers)) + out->modifiers = VectorToBitArray(modifiers); + out->timeStampSeconds = base::Time::Now().ToDoubleT(); + return true; +} + +bool Converter::FromV8( + v8::Isolate* isolate, v8::Local val, + blink::WebKeyboardEvent* out) { + mate::Dictionary dict; + if (!ConvertFromV8(isolate, val, &dict)) + return false; + if (!ConvertFromV8(isolate, val, static_cast(out))) + return false; + char code; + if (!dict.Get("keyCode", &code)) + return false; + bool shifted = false; + out->windowsKeyCode = atom::KeyboardCodeFromCharCode(code, &shifted); + if (out->windowsKeyCode == ui::VKEY_UNKNOWN) + return false; + if (shifted) + out->modifiers |= blink::WebInputEvent::ShiftKey; + out->setKeyIdentifierFromWindowsKeyCode(); + return false; +} + +bool Converter::FromV8( + v8::Isolate* isolate, v8::Local val, + content::NativeWebKeyboardEvent* out) { + mate::Dictionary dict; + if (!ConvertFromV8(isolate, val, &dict)) + return false; + if (!ConvertFromV8(isolate, val, static_cast(out))) + return false; + dict.Get("skipInBrowser", &out->skip_in_browser); + return false; +} + +bool Converter::FromV8( + v8::Isolate* isolate, v8::Local val, blink::WebMouseEvent* out) { + mate::Dictionary dict; + if (!ConvertFromV8(isolate, val, &dict)) + return false; + if (!ConvertFromV8(isolate, val, static_cast(out))) + return false; + if (!dict.Get("x", &out->x) || !dict.Get("y", &out->y)) + return false; + dict.Get("globalX", &out->globalX); + dict.Get("globalY", &out->globalY); + dict.Get("movementX", &out->movementX); + dict.Get("movementY", &out->movementY); + dict.Get("clickCount", &out->clickCount); + return false; +} + +bool Converter::FromV8( + v8::Isolate* isolate, v8::Local val, + blink::WebMouseWheelEvent* out) { + mate::Dictionary dict; + if (!ConvertFromV8(isolate, val, &dict)) + return false; + if (!ConvertFromV8(isolate, val, static_cast(out))) + return false; + dict.Get("deltaX", &out->deltaX); + dict.Get("deltaY", &out->deltaY); + dict.Get("wheelTicksX", &out->wheelTicksX); + dict.Get("wheelTicksY", &out->wheelTicksY); + dict.Get("accelerationRatioX", &out->accelerationRatioX); + dict.Get("accelerationRatioY", &out->accelerationRatioY); + dict.Get("hasPreciseScrollingDeltas", &out->hasPreciseScrollingDeltas); + dict.Get("canScroll", &out->canScroll); + return false; +} + bool Converter::FromV8( v8::Isolate* isolate, v8::Local val, blink::WebFloatPoint* out) { mate::Dictionary dict; diff --git a/atom/common/native_mate_converters/blink_converter.h b/atom/common/native_mate_converters/blink_converter.h index bbd2af0e679f..fd631983d432 100644 --- a/atom/common/native_mate_converters/blink_converter.h +++ b/atom/common/native_mate_converters/blink_converter.h @@ -8,14 +8,52 @@ #include "native_mate/converter.h" namespace blink { +class WebInputEvent; +class WebMouseEvent; +class WebMouseWheelEvent; +class WebKeyboardEvent; struct WebDeviceEmulationParams; struct WebFloatPoint; struct WebPoint; struct WebSize; } +namespace content { +struct NativeWebKeyboardEvent; +} + namespace mate { +template<> +struct Converter { + static bool FromV8(v8::Isolate* isolate, v8::Local val, + blink::WebInputEvent* out); +}; + +template<> +struct Converter { + static bool FromV8(v8::Isolate* isolate, v8::Local val, + blink::WebKeyboardEvent* out); +}; + +template<> +struct Converter { + static bool FromV8(v8::Isolate* isolate, v8::Local val, + content::NativeWebKeyboardEvent* out); +}; + +template<> +struct Converter { + static bool FromV8(v8::Isolate* isolate, v8::Local val, + blink::WebMouseEvent* out); +}; + +template<> +struct Converter { + static bool FromV8(v8::Isolate* isolate, v8::Local val, + blink::WebMouseWheelEvent* out); +}; + template<> struct Converter { static bool FromV8(v8::Isolate* isolate, v8::Local val, diff --git a/filenames.gypi b/filenames.gypi index 30668f20a720..acdea0c25e0a 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -283,6 +283,8 @@ 'atom/common/google_api_key.h', 'atom/common/id_weak_map.cc', 'atom/common/id_weak_map.h', + 'atom/common/keyboad_util.cc', + 'atom/common/keyboad_util.h', 'atom/common/linux/application_info.cc', 'atom/common/native_mate_converters/accelerator_converter.cc', 'atom/common/native_mate_converters/accelerator_converter.h', From 5a599cb6ffcbe7469050af36d503a623d85532de Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 18 Sep 2015 13:49:33 +0800 Subject: [PATCH 1281/1293] Sequence of definitions should follow the declarations --- atom/browser/native_window.cc | 64 +++++++++++++++++------------------ 1 file changed, 32 insertions(+), 32 deletions(-) diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 9121f0cb8871..4a78ec85fe09 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -207,38 +207,6 @@ bool NativeWindow::IsDocumentEdited() { void NativeWindow::SetMenu(ui::MenuModel* menu) { } -void NativeWindow::ShowDefinitionForSelection() { - NOTIMPLEMENTED(); -} - -void NativeWindow::SetAutoHideMenuBar(bool auto_hide) { -} - -bool NativeWindow::IsMenuBarAutoHide() { - return false; -} - -void NativeWindow::SetMenuBarVisibility(bool visible) { -} - -bool NativeWindow::IsMenuBarVisible() { - return true; -} - -double NativeWindow::GetAspectRatio() { - return aspect_ratio_; -} - -gfx::Size NativeWindow::GetAspectRatioExtraSize() { - return aspect_ratio_extraSize_; -} - -void NativeWindow::SetAspectRatio(double aspect_ratio, - const gfx::Size& extra_size) { - aspect_ratio_ = aspect_ratio; - aspect_ratio_extraSize_ = extra_size; -} - bool NativeWindow::HasModalDialog() { return has_dialog_attached_; } @@ -293,6 +261,38 @@ void NativeWindow::CapturePage(const gfx::Rect& rect, kBGRA_8888_SkColorType); } +void NativeWindow::ShowDefinitionForSelection() { + NOTIMPLEMENTED(); +} + +void NativeWindow::SetAutoHideMenuBar(bool auto_hide) { +} + +bool NativeWindow::IsMenuBarAutoHide() { + return false; +} + +void NativeWindow::SetMenuBarVisibility(bool visible) { +} + +bool NativeWindow::IsMenuBarVisible() { + return true; +} + +double NativeWindow::GetAspectRatio() { + return aspect_ratio_; +} + +gfx::Size NativeWindow::GetAspectRatioExtraSize() { + return aspect_ratio_extraSize_; +} + +void NativeWindow::SetAspectRatio(double aspect_ratio, + const gfx::Size& extra_size) { + aspect_ratio_ = aspect_ratio; + aspect_ratio_extraSize_ = extra_size; +} + void NativeWindow::SetFrameSubscription(bool isOffscreen) { const auto view = web_contents()->GetRenderWidgetHostView(); From c550546ff12038ceee01ee5d79e83d1210295030 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 18 Sep 2015 14:09:31 +0800 Subject: [PATCH 1282/1293] Do not manually convert Object to WebInputEvent --- atom/browser/api/atom_api_window.cc | 163 ++++-------------- atom/browser/api/atom_api_window.h | 3 +- atom/browser/native_window.cc | 96 ++++------- atom/browser/native_window.h | 21 ++- atom/common/event_types.cc | 118 ------------- atom/common/event_types.h | 52 ------ .../native_mate_converters/blink_converter.cc | 7 + .../native_mate_converters/blink_converter.h | 2 + atom/common/options_switches.cc | 11 -- atom/common/options_switches.h | 11 -- filenames.gypi | 2 - 11 files changed, 90 insertions(+), 396 deletions(-) delete mode 100644 atom/common/event_types.cc delete mode 100644 atom/common/event_types.h diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index b8d2c463eb4c..a2851415d198 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -9,16 +9,18 @@ #include "atom/browser/browser.h" #include "atom/browser/native_window.h" #include "atom/common/node_includes.h" -#include "atom/common/event_types.h" +#include "atom/common/native_mate_converters/blink_converter.h" #include "atom/common/native_mate_converters/callback.h" #include "atom/common/native_mate_converters/gfx_converter.h" #include "atom/common/native_mate_converters/gurl_converter.h" #include "atom/common/native_mate_converters/image_converter.h" #include "atom/common/native_mate_converters/string16_converter.h" #include "atom/common/options_switches.h" +#include "content/public/browser/native_web_keyboard_event.h" #include "content/public/browser/render_process_host.h" #include "native_mate/constructor.h" #include "native_mate/dictionary.h" +#include "third_party/WebKit/public/web/WebInputEvent.h" #include "ui/gfx/geometry/rect.h" #if defined(OS_WIN) @@ -462,14 +464,6 @@ void Window::CapturePage(mate::Arguments* args) { rect, base::Bind(&OnCapturePageDone, args->isolate(), callback)); } -void Window::BeginFrameSubscription() { - window_->SetFrameSubscription(true); -} - -void Window::EndFrameSubscription() { - window_->SetFrameSubscription(false); -} - void Window::SetProgressBar(double progress) { window_->SetProgressBar(progress); } @@ -546,125 +540,39 @@ bool Window::IsVisibleOnAllWorkspaces() { return window_->IsVisibleOnAllWorkspaces(); } -void Window::SendKeyboardEvent(v8::Isolate* isolate, const mate::Dictionary& data){ - auto type = blink::WebInputEvent::Type::Char; - int modifiers = 0; - int keycode = 0; - int native = 0; - std::string type_str = ""; - mate::Dictionary modifier_list = mate::Dictionary::CreateEmpty(isolate); - - data.Get(switches::kEventType, &type_str); - data.Get(switches::kModifiers, &modifier_list); - data.Get(switches::kKeyCode, &keycode); - data.Get(switches::kNativeKeyCode, &native); - - if(type_str.compare(event_types::kKeyDown) == 0){ - type = blink::WebInputEvent::Type::KeyDown; - }else if(type_str.compare(event_types::kKeyUp) == 0){ - type = blink::WebInputEvent::Type::KeyUp; - }else if(type_str.compare(event_types::kChar) == 0){ - type = blink::WebInputEvent::Type::Char; - } - - std::map modifier_types; - modifier_types[event_types::kModifierIsKeyPad] = false; - modifier_types[event_types::kModifierIsAutoRepeat] = false; - modifier_types[event_types::kModifierIsLeft] = false; - modifier_types[event_types::kModifierIsRight] = false; - modifier_types[event_types::kModifierShiftKey] = false; - modifier_types[event_types::kModifierControlKey] = false; - modifier_types[event_types::kModifierAltKey] = false; - modifier_types[event_types::kModifierMetaKey] = false; - modifier_types[event_types::kModifierCapsLockOn] = false; - modifier_types[event_types::kModifierNumLockOn] = false; - - for(std::map::iterator it = modifier_types.begin(); it != modifier_types.end(); ++it){ - modifier_list.Get(it->first,&(it->second)); - - if(it->second) modifiers = modifiers & event_types::modifierStrToWebModifier(it->first); - } - - window_->SendKeyboardEvent(type, modifiers, keycode, native); -} - -void Window::SendMouseEvent(v8::Isolate* isolate, const mate::Dictionary& data){ - int x, y, movementX, movementY, clickCount; - std::string type_str = ""; - std::string button_str = ""; - mate::Dictionary modifier_list = mate::Dictionary::CreateEmpty(isolate); - - blink::WebInputEvent::Type type = blink::WebInputEvent::Type::MouseMove; - blink::WebMouseEvent::Button button = blink::WebMouseEvent::Button::ButtonNone; - int modifiers = 0; - - data.Get(switches::kEventType, &type_str); - data.Get(switches::kMouseEventButton, &button_str); - data.Get(switches::kModifiers, &modifier_list); - - if(type_str.compare(event_types::kMouseDown) == 0){ - type = blink::WebInputEvent::Type::MouseDown; - }else if(type_str.compare(event_types::kMouseUp) == 0){ - type = blink::WebInputEvent::Type::MouseUp; - }else if(type_str.compare(event_types::kMouseMove) == 0){ - type = blink::WebInputEvent::Type::MouseMove; - }else if(type_str.compare(event_types::kMouseEnter) == 0){ - type = blink::WebInputEvent::Type::MouseEnter; - }else if(type_str.compare(event_types::kMouseLeave) == 0){ - type = blink::WebInputEvent::Type::MouseLeave; - }else if(type_str.compare(event_types::kContextMenu) == 0){ - type = blink::WebInputEvent::Type::ContextMenu; - }else if(type_str.compare(event_types::kMouseWheel) == 0){ - type = blink::WebInputEvent::Type::MouseWheel; - } - - std::map modifier_types; - modifier_types[event_types::kMouseLeftButton] = false; - modifier_types[event_types::kMouseRightButton] = false; - modifier_types[event_types::kMouseMiddleButton] = false; - modifier_types[event_types::kModifierLeftButtonDown] = false; - modifier_types[event_types::kModifierMiddleButtonDown] = false; - modifier_types[event_types::kModifierRightButtonDown] = false; - modifier_types[event_types::kModifierShiftKey] = false; - modifier_types[event_types::kModifierControlKey] = false; - modifier_types[event_types::kModifierAltKey] = false; - modifier_types[event_types::kModifierMetaKey] = false; - modifier_types[event_types::kModifierCapsLockOn] = false; - modifier_types[event_types::kModifierNumLockOn] = false; - - for(std::map::iterator it = modifier_types.begin(); it != modifier_types.end(); ++it){ - modifier_list.Get(it->first,&(it->second)); - - if(it->second) modifiers = modifiers & event_types::modifierStrToWebModifier(it->first); - } - - if(type == blink::WebInputEvent::Type::MouseWheel){ - bool precise = true; - - x = 0; - y = 0; - data.Get(switches::kX, &x); - data.Get(switches::kY, &y); - data.Get(switches::kMouseWheelPrecise, &precise); - - window_->SendMouseWheelEvent(modifiers, x, y, precise); - }else{ - if (data.Get(switches::kX, &x) && data.Get(switches::kY, &y)) { - if(!data.Get(switches::kMovementX, &movementX)){ - movementX = 0; - } - - if(!data.Get(switches::kMovementY, &movementY)){ - movementY = 0; - } - - if(!data.Get(switches::kClickCount, &clickCount)){ - clickCount = 0; - } - - window_->SendMouseEvent(type, modifiers, button, x, y, movementX, movementY, clickCount); +void Window::SendInputEvent(v8::Isolate* isolate, + v8::Local input_event) { + int type = mate::GetWebInputEventType(isolate, input_event); + if (blink::WebInputEvent::isMouseEventType(type)) { + blink::WebMouseEvent mouse_event; + if (mate::ConvertFromV8(isolate, input_event, &mouse_event)) { + window_->SendInputEvent(mouse_event); + return; + } + } else if (blink::WebInputEvent::isKeyboardEventType(type)) { + content::NativeWebKeyboardEvent keyboard_event;; + if (mate::ConvertFromV8(isolate, input_event, &keyboard_event)) { + window_->SendInputEvent(keyboard_event); + return; + } + } else if (type == blink::WebInputEvent::MouseWheel) { + blink::WebMouseWheelEvent mouse_wheel_event; + if (mate::ConvertFromV8(isolate, input_event, &mouse_wheel_event)) { + window_->SendInputEvent(mouse_wheel_event); + return; } } + + isolate->ThrowException(v8::Exception::Error(mate::StringToV8( + isolate, "Invalid event type"))); +} + +void Window::BeginFrameSubscription() { + window_->SetFrameSubscription(true); +} + +void Window::EndFrameSubscription() { + window_->SetFrameSubscription(false); } int32_t Window::ID() const { @@ -751,8 +659,7 @@ void Window::BuildPrototype(v8::Isolate* isolate, &Window::SetVisibleOnAllWorkspaces) .SetMethod("isVisibleOnAllWorkspaces", &Window::IsVisibleOnAllWorkspaces) - .SetMethod("sendMouseEvent", &Window::SendMouseEvent) - .SetMethod("sendKeyboardEvent", &Window::SendKeyboardEvent) + .SetMethod("sendInputEvent", &Window::SendInputEvent) .SetMethod("beginFrameSubscription", &Window::BeginFrameSubscription) .SetMethod("endFrameSubscription", &Window::EndFrameSubscription) #if defined(OS_MACOSX) diff --git a/atom/browser/api/atom_api_window.h b/atom/browser/api/atom_api_window.h index 6dfcbee8bc88..507bbb43849c 100644 --- a/atom/browser/api/atom_api_window.h +++ b/atom/browser/api/atom_api_window.h @@ -142,8 +142,7 @@ class Window : public mate::TrackableObject, bool IsMenuBarVisible(); void SetAspectRatio(double aspect_ratio, mate::Arguments* args); - void SendKeyboardEvent(v8::Isolate* isolate, const mate::Dictionary& data); - void SendMouseEvent(v8::Isolate* isolate, const mate::Dictionary& data); + void SendInputEvent(v8::Isolate* isolate, v8::Local input_event); void BeginFrameSubscription(); void EndFrameSubscription(); diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 4a78ec85fe09..55fe206ff18f 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -8,10 +8,6 @@ #include #include -#include "content/public/browser/render_widget_host_view_frame_subscriber.h" -#include "content/public/browser/native_web_keyboard_event.h" -#include "third_party/WebKit/public/web/WebInputEvent.h" -#include "media/base/video_frame.h" #include "media/base/yuv_convert.h" #include "atom/browser/atom_browser_context.h" #include "atom/browser/atom_browser_main_parts.h" @@ -43,7 +39,6 @@ #include "ui/gfx/geometry/size.h" #include "ui/gfx/screen.h" #include "ui/gl/gpu_switching_manager.h" -#include "ui/events/event.h" using content::NavigationEntry; using content::RenderWidgetHostView; @@ -312,6 +307,38 @@ void NativeWindow::SetFrameSubscription(bool isOffscreen) { } } +void NativeWindow::SendInputEvent(const blink::WebMouseEvent& mouse_event) { + const auto view = web_contents()->GetRenderWidgetHostView(); + if (!view) + return; + const auto host = view->GetRenderWidgetHost(); + if (!host) + return; + host->ForwardMouseEvent(mouse_event); +} + +void NativeWindow::SendInputEvent( + const blink::WebMouseWheelEvent& mouse_wheel_event) { + const auto view = web_contents()->GetRenderWidgetHostView(); + if (!view) + return; + const auto host = view->GetRenderWidgetHost(); + if (!host) + return; + host->ForwardWheelEvent(mouse_wheel_event); +} + +void NativeWindow::SendInputEvent( + const content::NativeWebKeyboardEvent& keyboard_event) { + const auto view = web_contents()->GetRenderWidgetHostView(); + if (!view) + return; + const auto host = view->GetRenderWidgetHost(); + if (!host) + return; + host->ForwardKeyboardEvent(keyboard_event); +} + void NativeWindow::RequestToClosePage() { bool prevent_default = false; FOR_EACH_OBSERVER(NativeWindowObserver, @@ -454,65 +481,6 @@ void NativeWindow::DevToolsClosed() { FOR_EACH_OBSERVER(NativeWindowObserver, observers_, OnDevToolsClosed()); } -void NativeWindow::SendKeyboardEvent(blink::WebInputEvent::Type type, int modifiers, int keycode, int nativeKeycode){ - auto keyb_event = new content::NativeWebKeyboardEvent; - - keyb_event->nativeKeyCode = nativeKeycode; - keyb_event->windowsKeyCode = keycode; - keyb_event->setKeyIdentifierFromWindowsKeyCode(); - keyb_event->type = type; - keyb_event->modifiers = modifiers; - keyb_event->isSystemKey = false; - keyb_event->timeStampSeconds = base::Time::Now().ToDoubleT(); - keyb_event->skip_in_browser = false; - - if (type == blink::WebInputEvent::Char || type == blink::WebInputEvent::RawKeyDown) { - keyb_event->text[0] = keycode; - keyb_event->unmodifiedText[0] = keycode; - } - - const auto view = web_contents()->GetRenderWidgetHostView(); - const auto host = view ? view->GetRenderWidgetHost() : nullptr; - - host->ForwardKeyboardEvent(*keyb_event); -} - -void NativeWindow::SendMouseEvent(blink::WebInputEvent::Type type, int modifiers, blink::WebMouseEvent::Button button, int x, int y, int movementX, int movementY, int clickCount){ - auto mouse_event = new blink::WebMouseEvent(); - - mouse_event->x = x; - mouse_event->y = y; - mouse_event->windowX = x; - mouse_event->windowY = y; - mouse_event->clickCount = clickCount; - mouse_event->type = type; - mouse_event->modifiers = modifiers; - mouse_event->button = button; - - mouse_event->timeStampSeconds = base::Time::Now().ToDoubleT(); - - const auto view = web_contents()->GetRenderWidgetHostView(); - const auto host = view ? view->GetRenderWidgetHost() : nullptr; - host->ForwardMouseEvent(*mouse_event); -} - -void NativeWindow::SendMouseWheelEvent(int modifiers, int x, int y, bool precise){ - auto wheel_event = new blink::WebMouseWheelEvent(); - - wheel_event->type = blink::WebInputEvent::MouseWheel; - wheel_event->deltaX = x; - wheel_event->deltaY = y; - if(x) wheel_event->wheelTicksX = x > 0.0f ? 1.0f : -1.0f; - if(y) wheel_event->wheelTicksY = y > 0.0f ? 1.0f : -1.0f; - wheel_event->modifiers = modifiers; - wheel_event->hasPreciseScrollingDeltas = precise; - wheel_event->canScroll = true; - - const auto view = web_contents()->GetRenderWidgetHostView(); - const auto host = view ? view->GetRenderWidgetHost() : nullptr; - host->ForwardWheelEvent(*wheel_event); -} - void NativeWindow::RenderViewCreated( content::RenderViewHost* render_view_host) { if (!transparent_) diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index 5784743af86a..1eabd5e693d1 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -11,8 +11,6 @@ #include "media/base/video_frame.h" #include "content/public/browser/render_widget_host_view_frame_subscriber.h" -#include "content/public/browser/native_web_keyboard_event.h" -#include "third_party/WebKit/public/web/WebInputEvent.h" #include "atom/browser/native_window_observer.h" #include "atom/browser/ui/accelerator_util.h" #include "base/cancelable_callback.h" @@ -28,6 +26,11 @@ class SkRegion; +namespace blink { +class WebMouseEvent; +class WebMouseWheelEvent; +} + namespace brightray { class InspectableWebContents; } @@ -173,6 +176,14 @@ class NativeWindow : public content::WebContentsObserver, gfx::Size GetAspectRatioExtraSize(); void SetAspectRatio(double aspect_ratio, const gfx::Size& extra_size); + // Subscribe to the frame updates. + void SetFrameSubscription(bool isOffscreen); + + // Send the WebInputEvent to the page. + void SendInputEvent(const blink::WebMouseEvent& mouse_event); + void SendInputEvent(const blink::WebMouseWheelEvent& mouse_wheel_event); + void SendInputEvent(const content::NativeWebKeyboardEvent& keyboard_event); + base::WeakPtr GetWeakPtr() { return weak_factory_.GetWeakPtr(); } @@ -229,12 +240,6 @@ class NativeWindow : public content::WebContentsObserver, void OnFrameReceived(bool result, scoped_refptr frame); - void SendKeyboardEvent(blink::WebInputEvent::Type type, int modifiers, int keycode, int nativeKeycode); - void SendMouseEvent(blink::WebInputEvent::Type type, int modifiers, blink::WebMouseEvent::Button button, int x, int y, int movementX, int movementY, int clickCount); - void SendMouseWheelEvent(int modifiers, int x, int y, bool clickCount); - - void SetFrameSubscription(bool isOffscreen); - protected: NativeWindow(brightray::InspectableWebContents* inspectable_web_contents, const mate::Dictionary& options); diff --git a/atom/common/event_types.cc b/atom/common/event_types.cc deleted file mode 100644 index be0848128980..000000000000 --- a/atom/common/event_types.cc +++ /dev/null @@ -1,118 +0,0 @@ -// Copyright (c) 2013 GitHub, Inc. -// Use of this source code is governed by the MIT license that can be -// found in the LICENSE file. - -#include "atom/common/event_types.h" -#include "third_party/WebKit/public/web/WebInputEvent.h" - -namespace atom { - -namespace event_types { - -const char kMouseDown[] = "down"; -const char kMouseUp[] = "up"; -const char kMouseMove[] = "move"; -const char kMouseEnter[] = "enter"; -const char kMouseLeave[] = "leave"; -const char kContextMenu[] = "context-menu"; -const char kMouseWheel[] = "wheel"; - -const char kKeyDown[] = "down"; -const char kKeyUp[] = "up"; -const char kChar[] = "char"; - -const char kMouseLeftButton[] = "left"; -const char kMouseRightButton[] = "right"; -const char kMouseMiddleButton[] = "middle"; - -const char kModifierLeftButtonDown[] = "left-button-down"; -const char kModifierMiddleButtonDown[] = "middle-button-down"; -const char kModifierRightButtonDown[] = "right-button-down"; - -const char kModifierShiftKey[] = "shift"; -const char kModifierControlKey[] = "control"; -const char kModifierAltKey[] = "alt"; -const char kModifierMetaKey[] = "meta"; -const char kModifierCapsLockOn[] = "caps-lock"; -const char kModifierNumLockOn[] = "num-lock"; - -const char kModifierIsKeyPad[] = "keypad"; -const char kModifierIsAutoRepeat[] = "auto-repeat"; -const char kModifierIsLeft[] = "left"; -const char kModifierIsRight[] = "right"; - -int modifierStrToWebModifier(std::string modifier){ - if(modifier.compare(event_types::kModifierLeftButtonDown) == 0){ - - return blink::WebInputEvent::Modifiers::LeftButtonDown; - - }else if(modifier.compare(event_types::kModifierMiddleButtonDown) == 0){ - - return blink::WebInputEvent::Modifiers::MiddleButtonDown; - - }else if(modifier.compare(event_types::kModifierRightButtonDown) == 0){ - - return blink::WebInputEvent::Modifiers::RightButtonDown; - - }else if(modifier.compare(event_types::kMouseLeftButton) == 0){ - - return blink::WebInputEvent::Modifiers::LeftButtonDown; - - }else if(modifier.compare(event_types::kMouseRightButton) == 0){ - - return blink::WebInputEvent::Modifiers::RightButtonDown; - - }else if(modifier.compare(event_types::kMouseMiddleButton) == 0){ - - return blink::WebInputEvent::Modifiers::MiddleButtonDown; - - }else if(modifier.compare(event_types::kModifierIsKeyPad) == 0){ - - return blink::WebInputEvent::Modifiers::IsKeyPad; - - }else if(modifier.compare(event_types::kModifierIsAutoRepeat) == 0){ - - return blink::WebInputEvent::Modifiers::IsAutoRepeat; - - }else if(modifier.compare(event_types::kModifierIsLeft) == 0){ - - return blink::WebInputEvent::Modifiers::IsLeft; - - }else if(modifier.compare(event_types::kModifierIsRight) == 0){ - - return blink::WebInputEvent::Modifiers::IsRight; - - }else if(modifier.compare(event_types::kModifierShiftKey) == 0){ - - return blink::WebInputEvent::Modifiers::ShiftKey; - - }else if(modifier.compare(event_types::kModifierControlKey) == 0){ - - return blink::WebInputEvent::Modifiers::ControlKey; - - }else if(modifier.compare(event_types::kModifierAltKey) == 0){ - - return blink::WebInputEvent::Modifiers::AltKey; - - }else if(modifier.compare(event_types::kModifierMetaKey) == 0){ - - return blink::WebInputEvent::Modifiers::MetaKey; - - }else if(modifier.compare(event_types::kModifierCapsLockOn) == 0){ - - return blink::WebInputEvent::Modifiers::CapsLockOn; - - }else if(modifier.compare(event_types::kModifierNumLockOn) == 0){ - - return blink::WebInputEvent::Modifiers::NumLockOn; - - }else{ - - return 0; - - } -} - -} // namespace event_types - -} // namespace atom diff --git a/atom/common/event_types.h b/atom/common/event_types.h deleted file mode 100644 index d4769db2d78b..000000000000 --- a/atom/common/event_types.h +++ /dev/null @@ -1,52 +0,0 @@ -// Copyright (c) 2013 GitHub, Inc. -// Use of this source code is governed by the MIT license that can be -// found in the LICENSE file. - -#ifndef ATOM_COMMON_EVENT_TYPES_H_ -#define ATOM_COMMON_EVENT_TYPES_H_ - -#include "third_party/WebKit/public/web/WebInputEvent.h" - -namespace atom { - -namespace event_types { - -extern const char kMouseDown[]; -extern const char kMouseUp[]; -extern const char kMouseMove[]; -extern const char kMouseEnter[]; -extern const char kMouseLeave[]; -extern const char kContextMenu[]; -extern const char kMouseWheel[]; - -extern const char kKeyDown[]; -extern const char kKeyUp[]; -extern const char kChar[]; - -extern const char kMouseLeftButton[]; -extern const char kMouseRightButton[]; -extern const char kMouseMiddleButton[]; - -extern const char kModifierLeftButtonDown[]; -extern const char kModifierMiddleButtonDown[]; -extern const char kModifierRightButtonDown[]; - -extern const char kModifierShiftKey[]; -extern const char kModifierControlKey[]; -extern const char kModifierAltKey[]; -extern const char kModifierMetaKey[]; -extern const char kModifierCapsLockOn[]; -extern const char kModifierNumLockOn[]; - -extern const char kModifierIsKeyPad[]; -extern const char kModifierIsAutoRepeat[]; -extern const char kModifierIsLeft[]; -extern const char kModifierIsRight[]; - -int modifierStrToWebModifier(std::string modifier); - -} // namespace event_types - -} // namespace atom - -#endif // ATOM_COMMON_EVENT_TYPES_H_ diff --git a/atom/common/native_mate_converters/blink_converter.cc b/atom/common/native_mate_converters/blink_converter.cc index afafa10b11d3..a406059cf629 100644 --- a/atom/common/native_mate_converters/blink_converter.cc +++ b/atom/common/native_mate_converters/blink_converter.cc @@ -112,6 +112,13 @@ struct Converter { } }; +int GetWebInputEventType(v8::Isolate* isolate, v8::Local val) { + int type = -1; + mate::Dictionary dict; + ConvertFromV8(isolate, val, &dict) && dict.Get("type", &type); + return type; +} + bool Converter::FromV8( v8::Isolate* isolate, v8::Local val, blink::WebInputEvent* out) { diff --git a/atom/common/native_mate_converters/blink_converter.h b/atom/common/native_mate_converters/blink_converter.h index fd631983d432..17bb108d349e 100644 --- a/atom/common/native_mate_converters/blink_converter.h +++ b/atom/common/native_mate_converters/blink_converter.h @@ -24,6 +24,8 @@ struct NativeWebKeyboardEvent; namespace mate { +int GetWebInputEventType(v8::Isolate* isolate, v8::Local val); + template<> struct Converter { static bool FromV8(v8::Isolate* isolate, v8::Local val, diff --git a/atom/common/options_switches.cc b/atom/common/options_switches.cc index 2268a4039513..c70e1ba4afa6 100644 --- a/atom/common/options_switches.cc +++ b/atom/common/options_switches.cc @@ -116,17 +116,6 @@ const char kRegisterStandardSchemes[] = "register-standard-schemes"; // The browser process app model ID const char kAppUserModelId[] = "app-user-model-id"; -const char kModifiers[] = "modifiers"; -const char kKeyCode[] = "code"; -const char kNativeKeyCode[] = "native"; - -const char kMovementX[] = "movement-x"; -const char kMovementY[] = "movement-y"; -const char kClickCount[] = "click-count"; -const char kEventType[] = "type"; -const char kMouseEventButton[] = "button"; -const char kMouseWheelPrecise[] = "precise"; - } // namespace switches } // namespace atom diff --git a/atom/common/options_switches.h b/atom/common/options_switches.h index eb7842e78769..e62f3116661a 100644 --- a/atom/common/options_switches.h +++ b/atom/common/options_switches.h @@ -62,17 +62,6 @@ extern const char kRegisterStandardSchemes[]; extern const char kAppUserModelId[]; -extern const char kModifiers[]; -extern const char kKeyCode[]; -extern const char kNativeKeyCode[]; - -extern const char kMovementX[]; -extern const char kMovementY[]; -extern const char kClickCount[]; -extern const char kEventType[]; -extern const char kMouseEventButton[]; -extern const char kMouseWheelPrecise[]; - } // namespace switches } // namespace atom diff --git a/filenames.gypi b/filenames.gypi index acdea0c25e0a..f25ec4a8a587 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -313,8 +313,6 @@ 'atom/common/node_includes.h', 'atom/common/options_switches.cc', 'atom/common/options_switches.h', - 'atom/common/event_types.cc', - 'atom/common/event_types.h', 'atom/common/platform_util.h', 'atom/common/platform_util_linux.cc', 'atom/common/platform_util_mac.mm', From 9e7de78231e753ceda212c24224dda1ca4d7b689 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 18 Sep 2015 14:12:48 +0800 Subject: [PATCH 1283/1293] Fix cpplint warnings --- atom/browser/api/atom_api_window.cc | 1 - atom/browser/native_window.cc | 12 ++++-------- atom/browser/native_window.h | 17 +++++++++++------ 3 files changed, 15 insertions(+), 15 deletions(-) diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index a2851415d198..db7b1d5ca1fc 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -8,7 +8,6 @@ #include "atom/browser/api/atom_api_web_contents.h" #include "atom/browser/browser.h" #include "atom/browser/native_window.h" -#include "atom/common/node_includes.h" #include "atom/common/native_mate_converters/blink_converter.h" #include "atom/common/native_mate_converters/callback.h" #include "atom/common/native_mate_converters/gfx_converter.h" diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 55fe206ff18f..809545255498 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -107,9 +107,8 @@ NativeWindow* NativeWindow::FromWebContents( content::WebContents* web_contents) { WindowList& window_list = *WindowList::GetInstance(); for (NativeWindow* window : window_list) { - if (window->web_contents() == web_contents){ + if (window->web_contents() == web_contents) return window; - } } return nullptr; } @@ -290,16 +289,12 @@ void NativeWindow::SetAspectRatio(double aspect_ratio, void NativeWindow::SetFrameSubscription(bool isOffscreen) { const auto view = web_contents()->GetRenderWidgetHostView(); - if (view) { if (isOffscreen) { scoped_ptr subscriber( new RenderSubscriber( view->GetVisibleViewportSize(), - base::Bind(&NativeWindow::OnFrameReceived, base::Unretained(this)) - ) - ); - + base::Bind(&NativeWindow::OnFrameReceived, base::Unretained(this)))); view->BeginFrameSubscription(subscriber.Pass()); } else { view->EndFrameSubscription(); @@ -593,7 +588,8 @@ bool RenderSubscriber::ShouldCaptureFrame( gfx::Rect(size_), size_, base::TimeDelta()); - *callback = base::Bind(&RenderSubscriber::CallbackMethod, callback_, *storage); + *callback = + base::Bind(&RenderSubscriber::CallbackMethod, callback_, *storage); return true; } diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index 1eabd5e693d1..3344cfb65c32 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -313,10 +313,14 @@ class NativeWindow : public content::WebContentsObserver, DISALLOW_COPY_AND_ASSIGN(NativeWindow); }; -//This class provides a way to listen to frame renders and to use the rendered frames for offscreen rendering +// This class provides a way to listen to frame renders and to use the rendered +// frames for offscreen rendering class RenderSubscriber : public content::RenderWidgetHostViewFrameSubscriber { public: - RenderSubscriber(gfx::Size size, base::Callback)> callback) : size_(size), callback_(callback) {} + RenderSubscriber( + gfx::Size size, + base::Callback)> callback) + : size_(size), callback_(callback) {} bool ShouldCaptureFrame(const gfx::Rect& damage_rect, base::TimeTicks present_time, @@ -325,10 +329,11 @@ class RenderSubscriber : public content::RenderWidgetHostViewFrameSubscriber { base::TimeTicks last_present_time() const { return last_present_time_; } - static void CallbackMethod(base::Callback)> callback, - scoped_refptr frame, - base::TimeTicks present_time, - bool success) { + static void CallbackMethod( + base::Callback)> callback, + scoped_refptr frame, + base::TimeTicks present_time, + bool success) { callback.Run(success, frame); } From 42863e4700a19acd57ed425e91c4054fae40f8e6 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 18 Sep 2015 14:20:31 +0800 Subject: [PATCH 1284/1293] Move SendInputEvent to WebContents --- atom/browser/api/atom_api_web_contents.cc | 40 +++++++++++++++++++++++ atom/browser/api/atom_api_web_contents.h | 5 ++- atom/browser/api/atom_api_window.cc | 31 ------------------ atom/browser/api/atom_api_window.h | 1 - atom/browser/native_window.cc | 36 -------------------- atom/browser/native_window.h | 10 ------ 6 files changed, 44 insertions(+), 79 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index d4cb6cd227d5..43b20a3d7135 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -30,12 +30,14 @@ #include "chrome/browser/printing/print_preview_message_handler.h" #include "content/common/view_messages.h" #include "content/public/browser/favicon_status.h" +#include "content/public/browser/native_web_keyboard_event.h" #include "content/public/browser/navigation_details.h" #include "content/public/browser/navigation_entry.h" #include "content/public/browser/plugin_service.h" #include "content/public/browser/render_frame_host.h" #include "content/public/browser/render_process_host.h" #include "content/public/browser/render_view_host.h" +#include "content/public/browser/render_widget_host_view.h" #include "content/public/browser/resource_request_details.h" #include "content/public/browser/service_worker_context.h" #include "content/public/browser/storage_partition.h" @@ -46,6 +48,7 @@ #include "net/http/http_response_headers.h" #include "net/url_request/static_http_user_agent_settings.h" #include "net/url_request/url_request_context.h" +#include "third_party/WebKit/public/web/WebInputEvent.h" #include "atom/common/node_includes.h" @@ -813,6 +816,42 @@ bool WebContents::SendIPCMessage(const base::string16& channel, return Send(new AtomViewMsg_Message(routing_id(), channel, args)); } +void WebContents::SendInputEvent(v8::Isolate* isolate, + v8::Local input_event) { + const auto view = web_contents()->GetRenderWidgetHostView(); + if (!view) + return; + const auto host = view->GetRenderWidgetHost(); + if (!host) + return; + + int type = mate::GetWebInputEventType(isolate, input_event); + if (blink::WebInputEvent::isMouseEventType(type)) { + blink::WebMouseEvent mouse_event; + if (mate::ConvertFromV8(isolate, input_event, &mouse_event)) { + host->ForwardMouseEvent(mouse_event); + return; + } + } else if (blink::WebInputEvent::isKeyboardEventType(type)) { + content::NativeWebKeyboardEvent keyboard_event;; + if (mate::ConvertFromV8(isolate, input_event, &keyboard_event)) { + host->ForwardKeyboardEvent(keyboard_event); + return; + } + } else if (type == blink::WebInputEvent::MouseWheel) { + blink::WebMouseWheelEvent mouse_wheel_event; + if (mate::ConvertFromV8(isolate, input_event, &mouse_wheel_event)) { + host->ForwardWheelEvent(mouse_wheel_event); + return; + } + } + + isolate->ThrowException(v8::Exception::Error(mate::StringToV8( + isolate, "Invalid event type"))); +} + + + void WebContents::SetSize(const SetSizeParams& params) { if (guest_delegate_) guest_delegate_->SetSize(params); @@ -875,6 +914,7 @@ mate::ObjectTemplateBuilder WebContents::GetObjectTemplateBuilder( .SetMethod("focus", &WebContents::Focus) .SetMethod("tabTraverse", &WebContents::TabTraverse) .SetMethod("_send", &WebContents::SendIPCMessage, true) + .SetMethod("sendInputEvent", &WebContents::SendInputEvent) .SetMethod("setSize", &WebContents::SetSize) .SetMethod("setAllowTransparency", &WebContents::SetAllowTransparency) .SetMethod("isGuest", &WebContents::IsGuest) diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index 0ce47237e494..6dc266053255 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -114,10 +114,13 @@ class WebContents : public mate::TrackableObject, void Focus(); void TabTraverse(bool reverse); - // Sending messages to browser. + // Send messages to browser. bool SendIPCMessage(const base::string16& channel, const base::ListValue& args); + // Send WebInputEvent to the page. + void SendInputEvent(v8::Isolate* isolate, v8::Local input_event); + // Methods for creating . void SetSize(const SetSizeParams& params); void SetAllowTransparency(bool allow); diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index db7b1d5ca1fc..985b6a75438a 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -8,18 +8,15 @@ #include "atom/browser/api/atom_api_web_contents.h" #include "atom/browser/browser.h" #include "atom/browser/native_window.h" -#include "atom/common/native_mate_converters/blink_converter.h" #include "atom/common/native_mate_converters/callback.h" #include "atom/common/native_mate_converters/gfx_converter.h" #include "atom/common/native_mate_converters/gurl_converter.h" #include "atom/common/native_mate_converters/image_converter.h" #include "atom/common/native_mate_converters/string16_converter.h" #include "atom/common/options_switches.h" -#include "content/public/browser/native_web_keyboard_event.h" #include "content/public/browser/render_process_host.h" #include "native_mate/constructor.h" #include "native_mate/dictionary.h" -#include "third_party/WebKit/public/web/WebInputEvent.h" #include "ui/gfx/geometry/rect.h" #if defined(OS_WIN) @@ -539,33 +536,6 @@ bool Window::IsVisibleOnAllWorkspaces() { return window_->IsVisibleOnAllWorkspaces(); } -void Window::SendInputEvent(v8::Isolate* isolate, - v8::Local input_event) { - int type = mate::GetWebInputEventType(isolate, input_event); - if (blink::WebInputEvent::isMouseEventType(type)) { - blink::WebMouseEvent mouse_event; - if (mate::ConvertFromV8(isolate, input_event, &mouse_event)) { - window_->SendInputEvent(mouse_event); - return; - } - } else if (blink::WebInputEvent::isKeyboardEventType(type)) { - content::NativeWebKeyboardEvent keyboard_event;; - if (mate::ConvertFromV8(isolate, input_event, &keyboard_event)) { - window_->SendInputEvent(keyboard_event); - return; - } - } else if (type == blink::WebInputEvent::MouseWheel) { - blink::WebMouseWheelEvent mouse_wheel_event; - if (mate::ConvertFromV8(isolate, input_event, &mouse_wheel_event)) { - window_->SendInputEvent(mouse_wheel_event); - return; - } - } - - isolate->ThrowException(v8::Exception::Error(mate::StringToV8( - isolate, "Invalid event type"))); -} - void Window::BeginFrameSubscription() { window_->SetFrameSubscription(true); } @@ -658,7 +628,6 @@ void Window::BuildPrototype(v8::Isolate* isolate, &Window::SetVisibleOnAllWorkspaces) .SetMethod("isVisibleOnAllWorkspaces", &Window::IsVisibleOnAllWorkspaces) - .SetMethod("sendInputEvent", &Window::SendInputEvent) .SetMethod("beginFrameSubscription", &Window::BeginFrameSubscription) .SetMethod("endFrameSubscription", &Window::EndFrameSubscription) #if defined(OS_MACOSX) diff --git a/atom/browser/api/atom_api_window.h b/atom/browser/api/atom_api_window.h index 507bbb43849c..83322c16cb93 100644 --- a/atom/browser/api/atom_api_window.h +++ b/atom/browser/api/atom_api_window.h @@ -142,7 +142,6 @@ class Window : public mate::TrackableObject, bool IsMenuBarVisible(); void SetAspectRatio(double aspect_ratio, mate::Arguments* args); - void SendInputEvent(v8::Isolate* isolate, v8::Local input_event); void BeginFrameSubscription(); void EndFrameSubscription(); diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index 809545255498..eee53e352efe 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -40,10 +40,6 @@ #include "ui/gfx/screen.h" #include "ui/gl/gpu_switching_manager.h" -using content::NavigationEntry; -using content::RenderWidgetHostView; -using content::RenderWidgetHost; - DEFINE_WEB_CONTENTS_USER_DATA_KEY(atom::NativeWindowRelay); namespace atom { @@ -302,38 +298,6 @@ void NativeWindow::SetFrameSubscription(bool isOffscreen) { } } -void NativeWindow::SendInputEvent(const blink::WebMouseEvent& mouse_event) { - const auto view = web_contents()->GetRenderWidgetHostView(); - if (!view) - return; - const auto host = view->GetRenderWidgetHost(); - if (!host) - return; - host->ForwardMouseEvent(mouse_event); -} - -void NativeWindow::SendInputEvent( - const blink::WebMouseWheelEvent& mouse_wheel_event) { - const auto view = web_contents()->GetRenderWidgetHostView(); - if (!view) - return; - const auto host = view->GetRenderWidgetHost(); - if (!host) - return; - host->ForwardWheelEvent(mouse_wheel_event); -} - -void NativeWindow::SendInputEvent( - const content::NativeWebKeyboardEvent& keyboard_event) { - const auto view = web_contents()->GetRenderWidgetHostView(); - if (!view) - return; - const auto host = view->GetRenderWidgetHost(); - if (!host) - return; - host->ForwardKeyboardEvent(keyboard_event); -} - void NativeWindow::RequestToClosePage() { bool prevent_default = false; FOR_EACH_OBSERVER(NativeWindowObserver, diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index 3344cfb65c32..a593fdc3c2b2 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -26,11 +26,6 @@ class SkRegion; -namespace blink { -class WebMouseEvent; -class WebMouseWheelEvent; -} - namespace brightray { class InspectableWebContents; } @@ -179,11 +174,6 @@ class NativeWindow : public content::WebContentsObserver, // Subscribe to the frame updates. void SetFrameSubscription(bool isOffscreen); - // Send the WebInputEvent to the page. - void SendInputEvent(const blink::WebMouseEvent& mouse_event); - void SendInputEvent(const blink::WebMouseWheelEvent& mouse_wheel_event); - void SendInputEvent(const content::NativeWebKeyboardEvent& keyboard_event); - base::WeakPtr GetWeakPtr() { return weak_factory_.GetWeakPtr(); } From 86f523d3c13224f0a3dadac919ec25e24d4f8b80 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 18 Sep 2015 15:57:43 +0800 Subject: [PATCH 1285/1293] Move BeginFrameSubscription to WebContents --- atom/browser/api/atom_api_web_contents.cc | 17 ++++++ atom/browser/api/atom_api_web_contents.h | 6 +++ atom/browser/api/atom_api_window.cc | 23 +------- atom/browser/api/atom_api_window.h | 4 -- atom/browser/api/frame_subscriber.cc | 66 +++++++++++++++++++++++ atom/browser/api/frame_subscriber.h | 45 ++++++++++++++++ atom/browser/native_window.cc | 56 ------------------- atom/browser/native_window.h | 37 ------------- atom/browser/native_window_observer.h | 2 - filenames.gypi | 2 + 10 files changed, 137 insertions(+), 121 deletions(-) create mode 100644 atom/browser/api/frame_subscriber.cc create mode 100644 atom/browser/api/frame_subscriber.h diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 43b20a3d7135..1a9ffeb67fae 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -850,7 +850,21 @@ void WebContents::SendInputEvent(v8::Isolate* isolate, isolate, "Invalid event type"))); } +void WebContents::BeginFrameSubscription( + const FrameSubscriber::FrameCaptureCallback& callback) { + const auto view = web_contents()->GetRenderWidgetHostView(); + if (view) { + scoped_ptr frame_subscriber(new FrameSubscriber( + isolate(), view->GetVisibleViewportSize(), callback)); + view->BeginFrameSubscription(frame_subscriber.Pass()); + } +} +void WebContents::EndFrameSubscription() { + const auto view = web_contents()->GetRenderWidgetHostView(); + if (view) + view->EndFrameSubscription(); +} void WebContents::SetSize(const SetSizeParams& params) { if (guest_delegate_) @@ -915,6 +929,9 @@ mate::ObjectTemplateBuilder WebContents::GetObjectTemplateBuilder( .SetMethod("tabTraverse", &WebContents::TabTraverse) .SetMethod("_send", &WebContents::SendIPCMessage, true) .SetMethod("sendInputEvent", &WebContents::SendInputEvent) + .SetMethod("beginFrameSubscription", + &WebContents::BeginFrameSubscription) + .SetMethod("endFrameSubscription", &WebContents::EndFrameSubscription) .SetMethod("setSize", &WebContents::SetSize) .SetMethod("setAllowTransparency", &WebContents::SetAllowTransparency) .SetMethod("isGuest", &WebContents::IsGuest) diff --git a/atom/browser/api/atom_api_web_contents.h b/atom/browser/api/atom_api_web_contents.h index 6dc266053255..c8ea6908bc5b 100644 --- a/atom/browser/api/atom_api_web_contents.h +++ b/atom/browser/api/atom_api_web_contents.h @@ -8,6 +8,7 @@ #include #include +#include "atom/browser/api/frame_subscriber.h" #include "atom/browser/api/trackable_object.h" #include "atom/browser/common_web_contents_delegate.h" #include "content/public/browser/web_contents_observer.h" @@ -121,6 +122,11 @@ class WebContents : public mate::TrackableObject, // Send WebInputEvent to the page. void SendInputEvent(v8::Isolate* isolate, v8::Local input_event); + // Subscribe to the frame updates. + void BeginFrameSubscription( + const FrameSubscriber::FrameCaptureCallback& callback); + void EndFrameSubscription(); + // Methods for creating . void SetSize(const SetSizeParams& params); void SetAllowTransparency(bool allow); diff --git a/atom/browser/api/atom_api_window.cc b/atom/browser/api/atom_api_window.cc index 985b6a75438a..3a44115da264 100644 --- a/atom/browser/api/atom_api_window.cc +++ b/atom/browser/api/atom_api_window.cc @@ -13,6 +13,7 @@ #include "atom/common/native_mate_converters/gurl_converter.h" #include "atom/common/native_mate_converters/image_converter.h" #include "atom/common/native_mate_converters/string16_converter.h" +#include "atom/common/node_includes.h" #include "atom/common/options_switches.h" #include "content/public/browser/render_process_host.h" #include "native_mate/constructor.h" @@ -24,8 +25,6 @@ #include "atom/browser/ui/win/taskbar_host.h" #endif -#include "atom/common/node_includes.h" - #if defined(OS_WIN) namespace mate { @@ -105,16 +104,6 @@ void Window::WillCloseWindow(bool* prevent_default) { *prevent_default = Emit("close"); } -void Window::OnFrameRendered(scoped_ptr rgb, const int size) { - v8::Locker locker(isolate()); - v8::HandleScope handle_scope(isolate()); - v8::MaybeLocal data = node::Buffer::New( - isolate(), - reinterpret_cast(rgb.release()), - static_cast(size)); - Emit("frame-rendered", data.ToLocalChecked(), size); -} - void Window::OnWindowClosed() { if (api_web_contents_) { api_web_contents_->DestroyWebContents(); @@ -536,14 +525,6 @@ bool Window::IsVisibleOnAllWorkspaces() { return window_->IsVisibleOnAllWorkspaces(); } -void Window::BeginFrameSubscription() { - window_->SetFrameSubscription(true); -} - -void Window::EndFrameSubscription() { - window_->SetFrameSubscription(false); -} - int32_t Window::ID() const { return weak_map_id(); } @@ -628,8 +609,6 @@ void Window::BuildPrototype(v8::Isolate* isolate, &Window::SetVisibleOnAllWorkspaces) .SetMethod("isVisibleOnAllWorkspaces", &Window::IsVisibleOnAllWorkspaces) - .SetMethod("beginFrameSubscription", &Window::BeginFrameSubscription) - .SetMethod("endFrameSubscription", &Window::EndFrameSubscription) #if defined(OS_MACOSX) .SetMethod("showDefinitionForSelection", &Window::ShowDefinitionForSelection) diff --git a/atom/browser/api/atom_api_window.h b/atom/browser/api/atom_api_window.h index 83322c16cb93..d60bf0d87ea0 100644 --- a/atom/browser/api/atom_api_window.h +++ b/atom/browser/api/atom_api_window.h @@ -53,7 +53,6 @@ class Window : public mate::TrackableObject, void OnPageTitleUpdated(bool* prevent_default, const std::string& title) override; void WillCloseWindow(bool* prevent_default) override; - void OnFrameRendered(scoped_ptr rgb, const int size) override; void OnWindowClosed() override; void OnWindowBlur() override; void OnWindowFocus() override; @@ -142,9 +141,6 @@ class Window : public mate::TrackableObject, bool IsMenuBarVisible(); void SetAspectRatio(double aspect_ratio, mate::Arguments* args); - void BeginFrameSubscription(); - void EndFrameSubscription(); - #if defined(OS_MACOSX) void ShowDefinitionForSelection(); #endif diff --git a/atom/browser/api/frame_subscriber.cc b/atom/browser/api/frame_subscriber.cc new file mode 100644 index 000000000000..526769f9cd6c --- /dev/null +++ b/atom/browser/api/frame_subscriber.cc @@ -0,0 +1,66 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#include "atom/browser/api/frame_subscriber.h" + +#include "atom/common/node_includes.h" +#include "base/bind.h" +#include "media/base/video_frame.h" +#include "media/base/yuv_convert.h" + +namespace atom { + +namespace api { + +FrameSubscriber::FrameSubscriber(v8::Isolate* isolate, + const gfx::Size& size, + const FrameCaptureCallback& callback) + : isolate_(isolate), size_(size), callback_(callback) { +} + +bool FrameSubscriber::ShouldCaptureFrame( + const gfx::Rect& damage_rect, + base::TimeTicks present_time, + scoped_refptr* storage, + DeliverFrameCallback* callback) { + *storage = media::VideoFrame::CreateFrame(media::VideoFrame::YV12, size_, + gfx::Rect(size_), size_, + base::TimeDelta()); + *callback = base::Bind(&FrameSubscriber::OnFrameDelivered, + base::Unretained(this), + *storage); + return true; +} + +void FrameSubscriber::OnFrameDelivered( + scoped_refptr frame, base::TimeTicks, bool result) { + if (!result) + return; + + gfx::Rect rect = frame->visible_rect(); + size_t rgb_arr_size = rect.width() * rect.height() * 4; + v8::MaybeLocal buffer = node::Buffer::New(isolate_, rgb_arr_size); + if (buffer.IsEmpty()) + return; + + // Convert a frame of YUV to 32 bit ARGB. + media::ConvertYUVToRGB32(frame->data(media::VideoFrame::kYPlane), + frame->data(media::VideoFrame::kUPlane), + frame->data(media::VideoFrame::kVPlane), + reinterpret_cast( + node::Buffer::Data(buffer.ToLocalChecked())), + rect.width(), rect.height(), + frame->stride(media::VideoFrame::kYPlane), + frame->stride(media::VideoFrame::kUVPlane), + rect.width() * 4, + media::YV12); + + v8::Locker locker(isolate_); + v8::HandleScope handle_scope(isolate_); + callback_.Run(buffer.ToLocalChecked()); +} + +} // namespace api + +} // namespace atom diff --git a/atom/browser/api/frame_subscriber.h b/atom/browser/api/frame_subscriber.h new file mode 100644 index 000000000000..f7748aa5790d --- /dev/null +++ b/atom/browser/api/frame_subscriber.h @@ -0,0 +1,45 @@ +// Copyright (c) 2015 GitHub, Inc. +// Use of this source code is governed by the MIT license that can be +// found in the LICENSE file. + +#ifndef ATOM_BROWSER_API_FRAME_SUBSCRIBER_H_ +#define ATOM_BROWSER_API_FRAME_SUBSCRIBER_H_ + +#include "base/callback.h" +#include "content/public/browser/render_widget_host_view_frame_subscriber.h" +#include "ui/gfx/geometry/size.h" +#include "v8/include/v8.h" + +namespace atom { + +namespace api { + +class FrameSubscriber : public content::RenderWidgetHostViewFrameSubscriber { + public: + using FrameCaptureCallback = base::Callback)>; + + FrameSubscriber(v8::Isolate* isolate, + const gfx::Size& size, + const FrameCaptureCallback& callback); + + bool ShouldCaptureFrame(const gfx::Rect& damage_rect, + base::TimeTicks present_time, + scoped_refptr* storage, + DeliverFrameCallback* callback) override; + + private: + void OnFrameDelivered( + scoped_refptr frame, base::TimeTicks, bool); + + v8::Isolate* isolate_; + gfx::Size size_; + FrameCaptureCallback callback_; + + DISALLOW_COPY_AND_ASSIGN(FrameSubscriber); +}; + +} // namespace api + +} // namespace atom + +#endif // ATOM_BROWSER_API_FRAME_SUBSCRIBER_H_ diff --git a/atom/browser/native_window.cc b/atom/browser/native_window.cc index eee53e352efe..4d5f273340ab 100644 --- a/atom/browser/native_window.cc +++ b/atom/browser/native_window.cc @@ -8,7 +8,6 @@ #include #include -#include "media/base/yuv_convert.h" #include "atom/browser/atom_browser_context.h" #include "atom/browser/atom_browser_main_parts.h" #include "atom/browser/window_list.h" @@ -283,21 +282,6 @@ void NativeWindow::SetAspectRatio(double aspect_ratio, aspect_ratio_extraSize_ = extra_size; } -void NativeWindow::SetFrameSubscription(bool isOffscreen) { - const auto view = web_contents()->GetRenderWidgetHostView(); - if (view) { - if (isOffscreen) { - scoped_ptr subscriber( - new RenderSubscriber( - view->GetVisibleViewportSize(), - base::Bind(&NativeWindow::OnFrameReceived, base::Unretained(this)))); - view->BeginFrameSubscription(subscriber.Pass()); - } else { - view->EndFrameSubscription(); - } - } -} - void NativeWindow::RequestToClosePage() { bool prevent_default = false; FOR_EACH_OBSERVER(NativeWindowObserver, @@ -517,44 +501,4 @@ void NativeWindow::OnCapturePageDone(const CapturePageCallback& callback, callback.Run(bitmap); } -void NativeWindow::OnFrameReceived(bool result, - scoped_refptr frame) { - if (result) { - gfx::Rect rect = frame->visible_rect(); - - const int rgb_arr_size = rect.width() * rect.height() * 4; - scoped_ptr rgb_bytes(new uint8[rgb_arr_size]); - - // Convert a frame of YUV to 32 bit ARGB. - media::ConvertYUVToRGB32(frame->data(media::VideoFrame::kYPlane), - frame->data(media::VideoFrame::kUPlane), - frame->data(media::VideoFrame::kVPlane), - rgb_bytes.get(), - rect.width(), rect.height(), - frame->stride(media::VideoFrame::kYPlane), - frame->stride(media::VideoFrame::kUVPlane), - rect.width() * 4, - media::YV12); - - FOR_EACH_OBSERVER(NativeWindowObserver, - observers_, - OnFrameRendered(rgb_bytes.Pass(), rgb_arr_size)); - } -} - -bool RenderSubscriber::ShouldCaptureFrame( - const gfx::Rect& damage_rect, - base::TimeTicks present_time, - scoped_refptr* storage, - DeliverFrameCallback* callback) { - last_present_time_ = present_time; - *storage = media::VideoFrame::CreateFrame(media::VideoFrame::YV12, size_, - gfx::Rect(size_), size_, - base::TimeDelta()); - - *callback = - base::Bind(&RenderSubscriber::CallbackMethod, callback_, *storage); - return true; -} - } // namespace atom diff --git a/atom/browser/native_window.h b/atom/browser/native_window.h index a593fdc3c2b2..e9a2b9433d13 100644 --- a/atom/browser/native_window.h +++ b/atom/browser/native_window.h @@ -9,8 +9,6 @@ #include #include -#include "media/base/video_frame.h" -#include "content/public/browser/render_widget_host_view_frame_subscriber.h" #include "atom/browser/native_window_observer.h" #include "atom/browser/ui/accelerator_util.h" #include "base/cancelable_callback.h" @@ -171,9 +169,6 @@ class NativeWindow : public content::WebContentsObserver, gfx::Size GetAspectRatioExtraSize(); void SetAspectRatio(double aspect_ratio, const gfx::Size& extra_size); - // Subscribe to the frame updates. - void SetFrameSubscription(bool isOffscreen); - base::WeakPtr GetWeakPtr() { return weak_factory_.GetWeakPtr(); } @@ -228,8 +223,6 @@ class NativeWindow : public content::WebContentsObserver, has_dialog_attached_ = has_dialog_attached; } - void OnFrameReceived(bool result, scoped_refptr frame); - protected: NativeWindow(brightray::InspectableWebContents* inspectable_web_contents, const mate::Dictionary& options); @@ -303,36 +296,6 @@ class NativeWindow : public content::WebContentsObserver, DISALLOW_COPY_AND_ASSIGN(NativeWindow); }; -// This class provides a way to listen to frame renders and to use the rendered -// frames for offscreen rendering -class RenderSubscriber : public content::RenderWidgetHostViewFrameSubscriber { - public: - RenderSubscriber( - gfx::Size size, - base::Callback)> callback) - : size_(size), callback_(callback) {} - - bool ShouldCaptureFrame(const gfx::Rect& damage_rect, - base::TimeTicks present_time, - scoped_refptr* storage, - DeliverFrameCallback* callback) override; - - base::TimeTicks last_present_time() const { return last_present_time_; } - - static void CallbackMethod( - base::Callback)> callback, - scoped_refptr frame, - base::TimeTicks present_time, - bool success) { - callback.Run(success, frame); - } - - private: - gfx::Size size_; - base::Callback)> callback_; - base::TimeTicks last_present_time_; -}; - // This class provides a hook to get a NativeWindow from a WebContents. class NativeWindowRelay : public content::WebContentsUserData { diff --git a/atom/browser/native_window_observer.h b/atom/browser/native_window_observer.h index db6587de1f44..5b0a0c56b3de 100644 --- a/atom/browser/native_window_observer.h +++ b/atom/browser/native_window_observer.h @@ -27,8 +27,6 @@ class NativeWindowObserver { const std::string& partition_id, WindowOpenDisposition disposition) {} - virtual void OnFrameRendered(scoped_ptr rgb, const int size) {} - // Called when user is starting an navigation in web page. virtual void WillNavigate(bool* prevent_default, const GURL& url) {} diff --git a/filenames.gypi b/filenames.gypi index f25ec4a8a587..99d6bc6d50d3 100644 --- a/filenames.gypi +++ b/filenames.gypi @@ -103,6 +103,8 @@ 'atom/browser/api/event_emitter.h', 'atom/browser/api/trackable_object.cc', 'atom/browser/api/trackable_object.h', + 'atom/browser/api/frame_subscriber.cc', + 'atom/browser/api/frame_subscriber.h', 'atom/browser/auto_updater.cc', 'atom/browser/auto_updater.h', 'atom/browser/auto_updater_delegate.h', From 573892c1125e54f1853c0ece03192e265fcab185 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 18 Sep 2015 17:44:11 +0800 Subject: [PATCH 1286/1293] docs: webContents.sendInputEvent --- docs/api/browser-window.md | 64 -------------------------------------- docs/api/web-contents.md | 40 ++++++++++++++++++++++++ 2 files changed, 40 insertions(+), 64 deletions(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 6a168e9e79ec..2868209ab247 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -244,15 +244,6 @@ Emitted when DevTools is closed. Emitted when DevTools is focused / opened. -### Event: 'frame-rendered' - -* `event` Event -* `frame` Buffer -* `size` Number - -Emitted when *offscreen render* is enabled, the current frame's pixel data -and size are available. - ### Event: 'app-command': Emitted when an [App Command](https://msdn.microsoft.com/en-us/library/windows/desktop/ms646275(v=vs.85).aspx) @@ -791,58 +782,3 @@ fired when the window receives a new frame from the renderer. Enables offscreen rendering, after this call `frame-rendered` events will no longer be fired if offscreen rendering was enabled before. - -### BrowserWindow.sendMouseEvent(options) - -Sends a mouse event to the BrowserWindow. -* `options` Object - * `type` String - The type of the mouse event. - * `down` String - Mouse down event. - * `up` String - Mouse up event. - * `move` String - Mouse move event. - * `enter` String - Mouse enter event. - * `leave` String - Mouse leave event. - * `context-menu` String - Context menu event. - * `wheel` String - Mouse wheel event. - * `x` Integer - The x component of the location of the mouse event. - * `y` Integer - The y component of the location of the mouse event. - * `movement-x` Integer - The x component of the mouse movement since the last event. - * `movement-y` Integer - The y component of the mouse movement since the last event. - * `button` String - The mouse button associated with the mouse event. Also sets the associated modifier values on the event. - * `left` String - The left button was pressed. - * `right` String - The right button was pressed. - * `middle` String - The middle button was pressed. - * `click-count` Integer - The number of clicks associated with the mouse event. - * `precise` Boolean - For the `wheel` event type, this option sets the `hasPreciseScrollingDeltas` option of the event. - * `modifiers` Object - The modifier values associated with the event. - * `left-button-down` Boolean - The left mouse button was pressed. - * `middle-button-down` Boolean - The right mouse button was pressed. - * `right-button-down` Boolean - The middle mouse button was pressed. - * `shift` Boolean - The shift key was pressed. - * `control` Boolean - The control key was pressed. - * `alt` Boolean - The alt key was pressed. - * `meta` Boolean - The meta key was pressed. - * `caps-lock` Boolean - The caps-lock key was on. - * `num-lock` Boolean - The num-lock key was on. - -### BrowserWindow.sendKeyboardEvent(options) - -Sends a keyboard event to the BrowserWindow. -* `options` Object - * `type` String - The type of the keyboard event. - * `down` String - Key down event. - * `up` String - Key up event. - * `char` String - Character event. - * `code` Integer - The key code of the key that generated the event. - * `native` Integer - The native key code of the key that generated the event. - * `modifiers` Object - The modifier values associated with the event. - * `keypad` Boolean - Sets the `IsKeyPad` option of the event. - * `auto-repeat` Boolean - Sets the `IsAutoRepeat` option of the event. - * `left` Boolean - Sets the `IsLeft` option of the event. - * `right` Boolean - Sets the `IsRight` option of the event. - * `shift` Boolean - The shift key was pressed. - * `control` Boolean - The control key was pressed. - * `alt` Boolean - The alt key was pressed. - * `meta` Boolean - The meta key was pressed. - * `caps-lock` Boolean - The caps-lock key was on. - * `num-lock` Boolean - The num-lock key was on. diff --git a/docs/api/web-contents.md b/docs/api/web-contents.md index 8b4ebcc33784..1a9043752f28 100644 --- a/docs/api/web-contents.md +++ b/docs/api/web-contents.md @@ -511,3 +511,43 @@ Enable device emulation with the given parameters. ### `webContents.disableDeviceEmulation()` Disable device emulation enabled by `webContents.enableDeviceEmulation`. + +### `webContents.sendInputEvent(event)` + +* `event` Object + * `type` String (**required**) - The type of the event, can be `mouseDown`, + `mouseUp`, `mouseEnter`, `mouseLeave`, `contextMenu`, `mouseWheel`, + `keyDown`, `keyUp`, `char`. + * `modifiers` Array - An array of modifiers of the event, can + include `shift`, `control`, `alt`, `meta`, `isKeypad`, `isAutoRepeat`, + `leftButtonDown`, `middleButtonDown`, `rightButtonDown`, `capsLock`, + `numLock`, `left`, `right`. + +Sends an input `event` to the page. + +For keyboard events, the `event` object also have following properties: + +* `keyCode` String (**required**) - A single character that will be sent as + keyboard event. Can be any ASCII character on the keyboard, like `a`, `1` + and `=`. + +For mouse events, the `event` object also have following properties: + +* `x` Integer (**required**) +* `y` Integer (**required**) +* `globalX` Integer +* `globalY` Integer +* `movementX` Integer +* `movementY` Integer +* `clickCount` Integer + +For the `mouseWheel` event, the `event` object also have following properties: + +* `deltaX` Integer +* `deltaY` Integer +* `wheelTicksX` Integer +* `wheelTicksY` Integer +* `accelerationRatioX` Integer +* `accelerationRatioY` Integer +* `hasPreciseScrollingDeltas` Boolean +* `canScroll` Boolean From 1e918480b44b9cf9b65434ccfd4899dfb199f177 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 18 Sep 2015 17:53:19 +0800 Subject: [PATCH 1287/1293] docs: webContents.beginFrameSubscription --- docs/api/browser-window.md | 10 ---------- docs/api/web-contents.md | 14 ++++++++++++++ 2 files changed, 14 insertions(+), 10 deletions(-) diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 2868209ab247..f1705c291756 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -772,13 +772,3 @@ Sets whether the window should be visible on all workspaces. Returns whether the window is visible on all workspaces. **Note:** This API always returns false on Windows. - -### BrowserWindow.beginFrameSubscription() - -Enables offscreen rendering, after this call `frame-rendered` events will be -fired when the window receives a new frame from the renderer. - -### BrowserWindow.endFrameSubscription() - -Enables offscreen rendering, after this call `frame-rendered` events will -no longer be fired if offscreen rendering was enabled before. diff --git a/docs/api/web-contents.md b/docs/api/web-contents.md index 1a9043752f28..e8f72cd24bf2 100644 --- a/docs/api/web-contents.md +++ b/docs/api/web-contents.md @@ -551,3 +551,17 @@ For the `mouseWheel` event, the `event` object also have following properties: * `accelerationRatioY` Integer * `hasPreciseScrollingDeltas` Boolean * `canScroll` Boolean + +### `webContents.beginFrameSubscription(callback)` + +* `callback` Function + +Begin subscribing for presentation events and captured frames, the `callback` +will be called with `callback(frameBuffer)` when there is a presentation event. + +The `frameBuffer` is a `Buffer` that contains raw pixel data, in the format of +32bit ARGB. + +### `webContents.endFrameSubscription()` + +End subscribing for frame presentation events. From ff0e15bf58c5f090653b88e3be5216cc740622e4 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 18 Sep 2015 17:55:42 +0800 Subject: [PATCH 1288/1293] Expose sendInputEvent in webview --- atom/renderer/lib/web-view/web-view.coffee | 1 + 1 file changed, 1 insertion(+) diff --git a/atom/renderer/lib/web-view/web-view.coffee b/atom/renderer/lib/web-view/web-view.coffee index f5bcf0496f8c..65e4501975fe 100644 --- a/atom/renderer/lib/web-view/web-view.coffee +++ b/atom/renderer/lib/web-view/web-view.coffee @@ -292,6 +292,7 @@ registerWebViewElement = -> "inspectServiceWorker" "print" "printToPDF" + "sendInputEvent" ] # Forward proto.foo* method calls to WebViewImpl.foo*. From 7b2980434c7970695165deaf47ecaea5ae0f1740 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 18 Sep 2015 18:21:51 +0800 Subject: [PATCH 1289/1293] Fix wrong return values in a few converters --- atom/browser/api/atom_api_web_contents.cc | 2 +- .../native_mate_converters/blink_converter.cc | 14 +++++++------- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/atom/browser/api/atom_api_web_contents.cc b/atom/browser/api/atom_api_web_contents.cc index 1a9ffeb67fae..9791a94bb77b 100644 --- a/atom/browser/api/atom_api_web_contents.cc +++ b/atom/browser/api/atom_api_web_contents.cc @@ -847,7 +847,7 @@ void WebContents::SendInputEvent(v8::Isolate* isolate, } isolate->ThrowException(v8::Exception::Error(mate::StringToV8( - isolate, "Invalid event type"))); + isolate, "Invalid event object"))); } void WebContents::BeginFrameSubscription( diff --git a/atom/common/native_mate_converters/blink_converter.cc b/atom/common/native_mate_converters/blink_converter.cc index a406059cf629..67c7e7e95fd8 100644 --- a/atom/common/native_mate_converters/blink_converter.cc +++ b/atom/common/native_mate_converters/blink_converter.cc @@ -73,7 +73,7 @@ struct Converter { *out = blink::WebInputEvent::TouchEnd; else if (type == "touchcancel") *out = blink::WebInputEvent::TouchCancel; - return false; + return true; } }; @@ -108,12 +108,12 @@ struct Converter { *out = blink::WebInputEvent::IsLeft; else if (modifier == "right") *out = blink::WebInputEvent::IsRight; - return false; + return true; } }; int GetWebInputEventType(v8::Isolate* isolate, v8::Local val) { - int type = -1; + blink::WebInputEvent::Type type = blink::WebInputEvent::Undefined; mate::Dictionary dict; ConvertFromV8(isolate, val, &dict) && dict.Get("type", &type); return type; @@ -152,7 +152,7 @@ bool Converter::FromV8( if (shifted) out->modifiers |= blink::WebInputEvent::ShiftKey; out->setKeyIdentifierFromWindowsKeyCode(); - return false; + return true; } bool Converter::FromV8( @@ -164,7 +164,7 @@ bool Converter::FromV8( if (!ConvertFromV8(isolate, val, static_cast(out))) return false; dict.Get("skipInBrowser", &out->skip_in_browser); - return false; + return true; } bool Converter::FromV8( @@ -181,7 +181,7 @@ bool Converter::FromV8( dict.Get("movementX", &out->movementX); dict.Get("movementY", &out->movementY); dict.Get("clickCount", &out->clickCount); - return false; + return true; } bool Converter::FromV8( @@ -200,7 +200,7 @@ bool Converter::FromV8( dict.Get("accelerationRatioY", &out->accelerationRatioY); dict.Get("hasPreciseScrollingDeltas", &out->hasPreciseScrollingDeltas); dict.Get("canScroll", &out->canScroll); - return false; + return true; } bool Converter::FromV8( From b8d50f3a3a9acdcbe434eb42901af3083234ec44 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 18 Sep 2015 18:28:34 +0800 Subject: [PATCH 1290/1293] spec: Add test for sendInputEvent --- spec/fixtures/pages/onkeyup.html | 9 +++++++++ spec/fixtures/pages/onmouseup.html | 9 +++++++++ spec/webview-spec.coffee | 23 +++++++++++++++++++++++ 3 files changed, 41 insertions(+) create mode 100644 spec/fixtures/pages/onkeyup.html create mode 100644 spec/fixtures/pages/onmouseup.html diff --git a/spec/fixtures/pages/onkeyup.html b/spec/fixtures/pages/onkeyup.html new file mode 100644 index 000000000000..99e6c3e98382 --- /dev/null +++ b/spec/fixtures/pages/onkeyup.html @@ -0,0 +1,9 @@ + + + + + diff --git a/spec/fixtures/pages/onmouseup.html b/spec/fixtures/pages/onmouseup.html new file mode 100644 index 000000000000..1fd38bc7211f --- /dev/null +++ b/spec/fixtures/pages/onmouseup.html @@ -0,0 +1,9 @@ + + + + + diff --git a/spec/webview-spec.coffee b/spec/webview-spec.coffee index e4b40c28ebeb..b310b7b129f8 100644 --- a/spec/webview-spec.coffee +++ b/spec/webview-spec.coffee @@ -336,3 +336,26 @@ describe ' tag', -> webview.addEventListener 'did-finish-load', listener2 webview.src = "file://#{fixtures}/pages/fullscreen.html" document.body.appendChild webview + + describe 'sendInputEvent', -> + it 'can send keyboard event', (done) -> + webview.addEventListener 'ipc-message', (e) -> + assert.equal e.channel, 'keyup' + assert.deepEqual e.args, [67, true, false] + done() + webview.addEventListener 'dom-ready', -> + webview.sendInputEvent type: 'keyup', keyCode: 'c', modifiers: ['shift'] + webview.src = "file://#{fixtures}/pages/onkeyup.html" + webview.setAttribute 'nodeintegration', 'on' + document.body.appendChild webview + + it 'can send mouse event', (done) -> + webview.addEventListener 'ipc-message', (e) -> + assert.equal e.channel, 'mouseup' + assert.deepEqual e.args, [10, 20, false, true] + done() + webview.addEventListener 'dom-ready', -> + webview.sendInputEvent type: 'mouseup', modifiers: ['ctrl'], x: 10, y: 20 + webview.src = "file://#{fixtures}/pages/onmouseup.html" + webview.setAttribute 'nodeintegration', 'on' + document.body.appendChild webview From 32bff05208fd73afa0d9a3381c23f79fe421a05b Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 18 Sep 2015 18:32:21 +0800 Subject: [PATCH 1291/1293] docs: .sendInputEvent --- docs/api/web-view-tag.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/api/web-view-tag.md b/docs/api/web-view-tag.md index 4647413b5a43..8eb3857ac970 100644 --- a/docs/api/web-view-tag.md +++ b/docs/api/web-view-tag.md @@ -358,6 +358,15 @@ page can handle it by listening to the `channel` event of `ipc` module. See [WebContents.send](web-contents.md#webcontentssendchannel-args) for examples. +### `.sendInputEvent(event)` + +* `event` Object + +Sends an input `event` to the page. + +See [WebContents.sendInputEvent](web-contents.md##webcontentssendinputeventevent) +for detailed description of `event` object. + ## DOM events The following DOM events are available to the `webview` tag: From 353cdd967a430940f131079c0e4a416e3409354b Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 18 Sep 2015 18:51:49 +0800 Subject: [PATCH 1292/1293] spec: Add test for webContents.beginFrameSubscription --- spec/api-browser-window-spec.coffee | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/spec/api-browser-window-spec.coffee b/spec/api-browser-window-spec.coffee index 3e4e2d5db5e2..846b8bdbc9f0 100644 --- a/spec/api-browser-window-spec.coffee +++ b/spec/api-browser-window-spec.coffee @@ -303,3 +303,11 @@ describe 'browser-window module', -> assert.equal url, 'https://www.github.com/' done() w.loadUrl "file://#{fixtures}/pages/will-navigate.html" + + describe 'beginFrameSubscription method', -> + it 'subscribes frame updates', (done) -> + w.loadUrl "file://#{fixtures}/api/blank.html" + w.webContents.beginFrameSubscription (data) -> + assert.notEqual data.length, 0 + w.webContents.endFrameSubscription() + done() From f716d47e546034d6adaf910fd62b0a6dd203caf7 Mon Sep 17 00:00:00 2001 From: Cheng Zhao Date: Fri, 18 Sep 2015 18:57:48 +0800 Subject: [PATCH 1293/1293] spec: Make the will-navigate test run faster --- spec/api-browser-window-spec.coffee | 10 +++++----- spec/fixtures/pages/will-navigate.html | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/spec/api-browser-window-spec.coffee b/spec/api-browser-window-spec.coffee index 846b8bdbc9f0..bb4d782e7ffb 100644 --- a/spec/api-browser-window-spec.coffee +++ b/spec/api-browser-window-spec.coffee @@ -295,14 +295,14 @@ describe 'browser-window module', -> w.minimize() describe 'will-navigate event', -> - return if isCI and process.platform is 'darwin' + @timeout 10000 it 'emits when user starts a navigation', (done) -> - @timeout 10000 - w.webContents.on 'will-navigate', (event, url) -> + url = "file://#{fixtures}/pages/will-navigate.html" + w.webContents.on 'will-navigate', (event, u) -> event.preventDefault() - assert.equal url, 'https://www.github.com/' + assert.equal u, url done() - w.loadUrl "file://#{fixtures}/pages/will-navigate.html" + w.loadUrl url describe 'beginFrameSubscription method', -> it 'subscribes frame updates', (done) -> diff --git a/spec/fixtures/pages/will-navigate.html b/spec/fixtures/pages/will-navigate.html index bd2ebdc1cb43..8d0c9b779e2d 100644 --- a/spec/fixtures/pages/will-navigate.html +++ b/spec/fixtures/pages/will-navigate.html @@ -1,7 +1,7 @@