electron/atom/common/api/api_messages.h

// Copyright (c) 2013 GitHub, Inc.
// Use of this source code is governed by the MIT license that can be
// found in the LICENSE file.

// Multiply-included file, no traditional include guard.

#include "atom/common/draggable_region.h"
#include "base/strings/string16.h"
#include "base/values.h"
#include "content/public/common/common_param_traits.h"
#include "content/public/common/referrer.h"
#include "ipc/ipc_message_macros.h"
#include "ui/gfx/geometry/rect_f.h"
#include "ui/gfx/ipc/gfx_param_traits.h"
#include "url/gurl.h"

// The message starter should be declared in ipc/ipc_message_start.h. Since
// we don't want to patch Chromium, we just pretend to be Content Shell.

#define IPC_MESSAGE_START ShellMsgStart

IPC_STRUCT_TRAITS_BEGIN(atom::DraggableRegion)
  IPC_STRUCT_TRAITS_MEMBER(draggable)
  IPC_STRUCT_TRAITS_MEMBER(bounds)
IPC_STRUCT_TRAITS_END()

IPC_MESSAGE_ROUTED2(AtomFrameHostMsg_Message,
                    std::string /* channel */,
                    base::ListValue /* arguments */)

IPC_SYNC_MESSAGE_ROUTED2_1(AtomFrameHostMsg_Message_Sync,
                           std::string /* channel */,
                           base::ListValue /* arguments */,
                           base::ListValue /* result */)

IPC_MESSAGE_ROUTED4(AtomFrameHostMsg_Message_To,
                    bool /* send_to_all */,
                    int32_t /* web_contents_id */,
                    std::string /* channel */,
                    base::ListValue /* arguments */)

IPC_MESSAGE_ROUTED3(AtomFrameMsg_Message,
                    bool /* send_to_all */,
                    std::string /* channel */,
                    base::ListValue /* arguments */)

IPC_MESSAGE_ROUTED0(AtomViewMsg_Offscreen)

IPC_MESSAGE_ROUTED3(AtomAutofillFrameHostMsg_ShowPopup,
                    gfx::RectF /* bounds */,
                    std::vector<base::string16> /* values */,
                    std::vector<base::string16> /* labels */)

IPC_MESSAGE_ROUTED0(AtomAutofillFrameHostMsg_HidePopup)

IPC_MESSAGE_ROUTED1(AtomAutofillFrameMsg_AcceptSuggestion,
                    base::string16 /* suggestion */)

// Sent by the renderer when the draggable regions are updated.
IPC_MESSAGE_ROUTED1(AtomFrameHostMsg_UpdateDraggableRegions,
                    std::vector<atom::DraggableRegion> /* regions */)

// Update renderer process preferences.
IPC_MESSAGE_CONTROL1(AtomMsg_UpdatePreferences, base::ListValue)

// Sent by renderer to set the temporary zoom level.
IPC_SYNC_MESSAGE_ROUTED1_1(AtomFrameHostMsg_SetTemporaryZoomLevel,
                           double /* zoom level */,
                           double /* result */)

// Sent by renderer to get the zoom level.
IPC_SYNC_MESSAGE_ROUTED0_1(AtomFrameHostMsg_GetZoomLevel, double /* result */)

// Brings up SaveAs... dialog to save specified URL.
IPC_MESSAGE_ROUTED2(AtomFrameHostMsg_PDFSaveURLAs,
                    GURL /* url */,
                    content::Referrer /* referrer */)
Remove All Rights Reserved after GitHub copyright Closes #762 2014-10-31 18:17:05 +00:00			`// Copyright (c) 2013 GitHub, Inc.`
Switch to use MIT license. 2014-04-25 09:49:37 +00:00			`// Use of this source code is governed by the MIT license that can be`
Add API messages for IPC. 2013-04-21 03:01:04 +00:00			`// found in the LICENSE file.`

			`// Multiply-included file, no traditional include guard.`

Order header files. 2014-03-16 01:37:04 +00:00			`#include "atom/common/draggable_region.h"`
base/string16.h was moved to base/strings/string16.h. 2013-12-10 06:14:05 +00:00			`#include "base/strings/string16.h"`
Add API messages for IPC. 2013-04-21 03:01:04 +00:00			`#include "base/values.h"`
			`#include "content/public/common/common_param_traits.h"`
FIXME: PDF component IPC should be converted to Mojo. https://codereview.chromium.org/2455543002 2017-11-27 07:00:14 +00:00			`#include "content/public/common/referrer.h"`
Add API messages for IPC. 2013-04-21 03:01:04 +00:00			`#include "ipc/ipc_message_macros.h"`
add datalist element view 2017-05-19 19:35:13 +00:00			`#include "ui/gfx/geometry/rect_f.h"`
Fix API changes of Chrome 38 2014-10-11 11:11:34 +00:00			`#include "ui/gfx/ipc/gfx_param_traits.h"`
FIXME: PDF component IPC should be converted to Mojo. https://codereview.chromium.org/2455543002 2017-11-27 07:00:14 +00:00			`#include "url/gurl.h"`
Add API messages for IPC. 2013-04-21 03:01:04 +00:00
			`// The message starter should be declared in ipc/ipc_message_start.h. Since`
Fixed typos 2014-05-07 06:34:53 +00:00			`// we don't want to patch Chromium, we just pretend to be Content Shell.`
Add API messages for IPC. 2013-04-21 03:01:04 +00:00
			`#define IPC_MESSAGE_START ShellMsgStart`

Add IPC messages and structs for passing draggable regions. 2013-09-05 11:46:12 +00:00			`IPC_STRUCT_TRAITS_BEGIN(atom::DraggableRegion)`
			`IPC_STRUCT_TRAITS_MEMBER(draggable)`
			`IPC_STRUCT_TRAITS_MEMBER(bounds)`
			`IPC_STRUCT_TRAITS_END()`

move ipc use from rvh to rfh 2018-03-09 09:31:09 +00:00			`IPC_MESSAGE_ROUTED2(AtomFrameHostMsg_Message,`
refactor: use std::string instead of base::string16 for IPC channel names (#14286) 2018-08-24 15:30:37 +00:00			`std::string /* channel */,`
Rename string16 to base::string16. 2014-06-28 11:36:57 +00:00			`base::ListValue /* arguments */)`
Add API messages for IPC. 2013-04-21 03:01:04 +00:00
move ipc use from rvh to rfh 2018-03-09 09:31:09 +00:00			`IPC_SYNC_MESSAGE_ROUTED2_1(AtomFrameHostMsg_Message_Sync,`
refactor: use std::string instead of base::string16 for IPC channel names (#14286) 2018-08-24 15:30:37 +00:00			`std::string /* channel */,`
Rename string16 to base::string16. 2014-06-28 11:36:57 +00:00			`base::ListValue /* arguments */,`
perf: don't use JSON to send the result of `ipcRenderer.sendSync`. (#8953) * Don't use JSON to send the result of `ipcRenderer.sendSync`. - Change the return type of AtomViewHostMsg_Message_Sync from `base::string16` to `base::ListValue` - Adjust lib/browser/api/web-contents.js and /lib/renderer/api/ipc-renderer.js to wrap/unwrap return values to/from array, instead of serializing/deserializing JSON. This change can greatly improve `ipcRenderer.sendSync` calls where the return value contains Buffer instances, because those are converted to Array before being serialized to JSON(which has no efficient way of representing byte arrays). A simple benchmark where remote.require('fs') was used to read a 16mb file got at least 5x faster, not to mention it used a lot less memory. This difference tends increases with larger buffers. * Don't base64 encode Buffers * Don't allocate V8ValueConverter on the heap * Replace hidden global.sandbox with NodeBindings::IsInitialized() * Refactoring: check NodeBindings::IsInitialized() in V8ValueConverter * Refactor problematic test to make it more reliable * Add tests for NaN and Infinity 2018-06-13 07:38:31 +00:00			`base::ListValue /* result */)`
Add ipc.sendSync in renderer. 2013-04-23 13:52:19 +00:00
refactor: implement ipcRenderer.sendTo in native code for better performance (#14285) 2018-08-24 21:14:39 +00:00			`IPC_MESSAGE_ROUTED4(AtomFrameHostMsg_Message_To,`
			`bool /* send_to_all */,`
			`int32_t /* web_contents_id */,`
refactor: use std::string instead of base::string16 for IPC channel names (ipcRenderer.sendTo) (#14302) 2018-08-24 22:30:10 +00:00			`std::string /* channel */,`
refactor: implement ipcRenderer.sendTo in native code for better performance (#14285) 2018-08-24 21:14:39 +00:00			`base::ListValue /* arguments */)`

move ipc use from rvh to rfh 2018-03-09 09:31:09 +00:00			`IPC_MESSAGE_ROUTED3(AtomFrameMsg_Message,`
Add webContents.sendToAll to send message to all frames 2016-05-27 07:58:49 +00:00			`bool /* send_to_all */,`
refactor: use std::string instead of base::string16 for IPC channel names (#14286) 2018-08-24 15:30:37 +00:00			`std::string /* channel */,`
Rename string16 to base::string16. 2014-06-28 11:36:57 +00:00			`base::ListValue /* arguments */)`
Add IPC messages and structs for passing draggable regions. 2013-09-05 11:46:12 +00:00
adds offscreen renderer ipc message to disable external popups 2017-04-11 12:19:34 +00:00			`IPC_MESSAGE_ROUTED0(AtomViewMsg_Offscreen)`

move popup related code to nativewindow 2017-05-26 01:38:27 +00:00			`IPC_MESSAGE_ROUTED3(AtomAutofillFrameHostMsg_ShowPopup,`
add datalist element view 2017-05-19 19:35:13 +00:00			`gfx::RectF /* bounds */,`
			`std::vector<base::string16> /* values */,`
			`std::vector<base::string16> /* labels */)`

move popup related code to nativewindow 2017-05-26 01:38:27 +00:00			`IPC_MESSAGE_ROUTED0(AtomAutofillFrameHostMsg_HidePopup)`
add datalist element view 2017-05-19 19:35:13 +00:00
move popup related code to nativewindow 2017-05-26 01:38:27 +00:00			`IPC_MESSAGE_ROUTED1(AtomAutofillFrameMsg_AcceptSuggestion,`
add datalist element view 2017-05-19 19:35:13 +00:00			`base::string16 /* suggestion */)`

Add IPC messages and structs for passing draggable regions. 2013-09-05 11:46:12 +00:00			`// Sent by the renderer when the draggable regions are updated.`
fix: draggable region ipc should be frame based 2018-01-01 17:24:02 +00:00			`IPC_MESSAGE_ROUTED1(AtomFrameHostMsg_UpdateDraggableRegions,`
Add IPC messages and structs for passing draggable regions. 2013-09-05 11:46:12 +00:00			`std::vector<atom::DraggableRegion> /* regions */)`
Add API to set render process preferences 2016-05-26 23:51:02 +00:00
			`// Update renderer process preferences.`
			`IPC_MESSAGE_CONTROL1(AtomMsg_UpdatePreferences, base::ListValue)`
map webframe zoom api to use HostZoomMap 2017-01-30 17:06:50 +00:00
			`// Sent by renderer to set the temporary zoom level.`
move ipc use from rvh to rfh 2018-03-09 09:31:09 +00:00			`IPC_SYNC_MESSAGE_ROUTED1_1(AtomFrameHostMsg_SetTemporaryZoomLevel,`
map webframe zoom api to use HostZoomMap 2017-01-30 17:06:50 +00:00			`double /* zoom level */,`
			`double /* result */)`

			`// Sent by renderer to get the zoom level.`
move ipc use from rvh to rfh 2018-03-09 09:31:09 +00:00			`IPC_SYNC_MESSAGE_ROUTED0_1(AtomFrameHostMsg_GetZoomLevel, double /* result */)`
FIXME: PDF component IPC should be converted to Mojo. https://codereview.chromium.org/2455543002 2017-11-27 07:00:14 +00:00
			`// Brings up SaveAs... dialog to save specified URL.`
			`IPC_MESSAGE_ROUTED2(AtomFrameHostMsg_PDFSaveURLAs,`
			`GURL /* url */,`
			`content::Referrer /* referrer */)`