[Attachment Support] Implement SPI for clients to make an attachment element display...
authorwenson_hsieh@apple.com <wenson_hsieh@apple.com@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Thu, 30 Nov 2017 02:23:44 +0000 (02:23 +0000)
committerwenson_hsieh@apple.com <wenson_hsieh@apple.com@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Thu, 30 Nov 2017 02:23:44 +0000 (02:23 +0000)
commit1195194253a1dad795d286473f7ae637124f2676
treef99b9b6835d289c66091c3c41c24584d963a7b38
parentec2b7713a72d2e924c0bb1eb92700a1564ccc373
[Attachment Support] Implement SPI for clients to make an attachment element display in-place
https://bugs.webkit.org/show_bug.cgi?id=180153
<rdar://problem/35735252>

Reviewed by Tim Horton.

Source/WebCore:

Adds SPI support for inserting attachments using in-place display style, and updating display options for
existing attachments. See comments below for more detail.

Tests: WKAttachmentTests.InPlaceImageAttachmentToggleDisplayMode
       WKAttachmentTests.InPlaceImageAttachmentParagraphInsertion
       WKAttachmentTests.InPlaceVideoAttachmentInsertionWithinList
       WKAttachmentTests.InPlacePDFAttachmentCutAndPaste

* WebCore.xcodeproj/project.pbxproj:
* editing/Editor.cpp:
(WebCore::Editor::insertAttachment):
(WebCore::Editor::insertAttachmentFromFile):

Update display options for the attachment before inserting into the document.

* editing/Editor.h:
* html/AttachmentTypes.h: Added.

Add a new header to define the new attachment display types. This lets us avoid importing HTMLAttachmentElement.h
and instead just import AttachmentTypes.h in some places in WebKit that only deal with plumbing
AttachmentDisplayOptions to the web process.

(WebCore::AttachmentDisplayOptions::encode const):
(WebCore::AttachmentDisplayOptions::decode):

Support serializing and deserializing attachment display options.

* html/HTMLAttachmentElement.cpp:
(WebCore::HTMLAttachmentElement::setFile):

Regenerate the shadow root if needed when setting the file.

(WebCore::HTMLAttachmentElement::updateDisplayMode):

Introduce a new method to update the display mode of an attachment element. This builds up the shadow root of
the attachment if it is displayed in-place.

(WebCore::HTMLAttachmentElement::ensureInnerImage):
(WebCore::HTMLAttachmentElement::ensureInnerVideo):

Helpers to insert image and video elements into the shadow root if needed, and return the image or video element.

(WebCore::HTMLAttachmentElement::innerImage const):
(WebCore::HTMLAttachmentElement::innerVideo const):

Helpers to retrieve existing image and video elements in the shadow root.

(WebCore::HTMLAttachmentElement::populateShadowRootIfNecessary):

Appends and configures the attachment element's shadow root for inline display, initializing an image or video
element or neither, depending on the attachment type.

* html/HTMLAttachmentElement.h:

Introduce an AttachmentDisplayOptions struct which mirrors _WKAttachmentDisplayOptions in the WebKit layer. For
now, this only contains a display mode enum.

* platform/audio/ios/AudioSessionIOS.mm:

Avoid this AVAudioSession assertion when targeting iOS simulator. AVAudioSession always throws this error when
setting an audio session category in the simulator, even in a basic test app, since AVFoundation doesn't support
audio sessions in the simulator.

(WebCore::AudioSession::setCategory):

Source/WebKit:

Add new WebKit SPI, -[_WKAttachment setDisplayOptions:completion:], and add plumbing for attachment display
options to the web content process. Changes covered by 4 new API tests.

* Scripts/webkit/messages.py:
(headers_for_type):
* UIProcess/API/APIAttachment.cpp:
(API::Attachment::setDisplayOptions):
* UIProcess/API/APIAttachment.h:
* UIProcess/API/Cocoa/WKWebView.mm:
(-[WKWebView _insertAttachmentWithFilename:contentType:data:options:completion:]):

Respect given display options when inserting a new attachment.

* UIProcess/API/Cocoa/_WKAttachment.h:
* UIProcess/API/Cocoa/_WKAttachment.mm:
(-[_WKAttachmentDisplayOptions coreDisplayOptions]):

Introduce a helper to convert from the Cocoa _WKAttachmentDisplayOptions object to platform-agnostic
AttachmentDisplayOptions.

(-[_WKAttachment setDisplayOptions:completion:]):
(WebKit::if): Deleted.
* UIProcess/API/Cocoa/_WKAttachmentInternal.h:
* UIProcess/WebPageProxy.cpp:
(WebKit::WebPageProxy::insertAttachment):
(WebKit::WebPageProxy::setAttachmentDisplayOptions):
* UIProcess/WebPageProxy.h:
* WebProcess/WebPage/WebPage.cpp:
(WebKit::WebPage::insertAttachment):
(WebKit::WebPage::requestAttachmentData):
(WebKit::WebPage::setAttachmentDisplayOptions):
(WebKit::WebPage::attachmentElementWithIdentifier const):

Pull common logic to retrieve an attachment element matching a given identifier out into a helper.

* WebProcess/WebPage/WebPage.h:
* WebProcess/WebPage/WebPage.messages.in:

Tools:

Adds new API tests to cover inserting in-place attachments and updating the display mode of existing attachments,
as well as performing a few editing operations (paragraph insertion, cut/paste, list insertion) on attachment
elements.

* TestWebKitAPI/Tests/WebKitCocoa/WKAttachmentTests.mm:
(platformAttachmentIconElementSize):
(testVideoData):
(testPDFData):
(displayOptionsWithMode):
(-[TestWKWebView waitForAttachmentElementSizeToBecome:]):
(-[_WKAttachment synchronouslySetDisplayOptions:error:]):
(TestWebKitAPI::TEST):

git-svn-id: https://svn.webkit.org/repository/webkit/trunk@225311 268f45cc-cd09-0410-ab3c-d52691b4dbfc
23 files changed:
Source/WebCore/ChangeLog
Source/WebCore/WebCore.xcodeproj/project.pbxproj
Source/WebCore/editing/Editor.cpp
Source/WebCore/editing/Editor.h
Source/WebCore/html/AttachmentTypes.h [new file with mode: 0644]
Source/WebCore/html/HTMLAttachmentElement.cpp
Source/WebCore/html/HTMLAttachmentElement.h
Source/WebCore/platform/audio/ios/AudioSessionIOS.mm
Source/WebKit/ChangeLog
Source/WebKit/Scripts/webkit/messages.py
Source/WebKit/UIProcess/API/APIAttachment.cpp
Source/WebKit/UIProcess/API/APIAttachment.h
Source/WebKit/UIProcess/API/Cocoa/WKWebView.mm
Source/WebKit/UIProcess/API/Cocoa/_WKAttachment.h
Source/WebKit/UIProcess/API/Cocoa/_WKAttachment.mm
Source/WebKit/UIProcess/API/Cocoa/_WKAttachmentInternal.h
Source/WebKit/UIProcess/WebPageProxy.cpp
Source/WebKit/UIProcess/WebPageProxy.h
Source/WebKit/WebProcess/WebPage/WebPage.cpp
Source/WebKit/WebProcess/WebPage/WebPage.h
Source/WebKit/WebProcess/WebPage/WebPage.messages.in
Tools/ChangeLog
Tools/TestWebKitAPI/Tests/WebKitCocoa/WKAttachmentTests.mm