commit | 7f9874890985133e41b8596da57b25ed06c3cdf0 | [log] [tgz] |
---|---|---|
author | rniwa@webkit.org <rniwa@webkit.org@268f45cc-cd09-0410-ab3c-d52691b4dbfc> | Thu Oct 24 21:01:22 2019 +0000 |
committer | rniwa@webkit.org <rniwa@webkit.org@268f45cc-cd09-0410-ab3c-d52691b4dbfc> | Thu Oct 24 21:01:22 2019 +0000 |
tree | d11fd9c3576a2b9d6e2824a495da89cc141ea0f9 | |
parent | 3aae06f8e4fc78921f5323831675d585c4d316c4 [diff] |
Add a mechanism to find and manipulate text by paragraphs https://bugs.webkit.org/show_bug.cgi?id=203286 Reviewed by Wenson Hsieh. Source/WebCore: This patch introduces TextManipulationController which allows WebKit clients to find and replace text content in a given document by paragraph boundary. For now, TextManipulationController finds all paragraphs in the document and invokes the callback for each paragraph. In the future, this controller will support detecting removal and insertion of new content to the document. Tests: TextManipulation.StartTextManipulationFindSimpleParagraphs TextManipulation.StartTextManipulationFindParagraphsWithMultileTokens TextManipulation.CompleteTextManipulationShouldReplaceSimpleParagraphContent TextManipulation.CompleteTextManipulationShouldFailWhenContentIsChanged TextManipulation.CompleteTextManipulationShouldFailWhenDocumentHasBeenNavigatedAway * Headers.cmake: * Sources.txt: * WebCore.xcodeproj/project.pbxproj: * dom/Document.cpp: (WebCore::Document::prepareForDestruction): Clear TextManipulationController. Otherwise m_items in TextManipulationController may keep a bunch of nodes alive and not let this document destructed. (WebCore::Document::textManipulationController): Added. * dom/Document.h: (WebCore::Document::textManipulationControllerIfExists): Added. * editing/TextManipulationController.cpp: Added. (WebCore::TextManipulationController::TextManipulationController): Added. (WebCore::TextManipulationController::startObservingParagraphs): Finds all pargraphs and invoke the callback. (WebCore::TextManipulationController::addItem): Added. A helper for startObservingParagraphs. (WebCore::TextManipulationController::completeManipulation): Added. (WebCore::TextManipulationController::replace): Added. A helper for completeManipulation. * editing/TextManipulationController.h: Added. (WebCore::TextManipulationController::ManipulationToken::encode const): Added. (WebCore::TextManipulationController::ManipulationToken::decode): Added. Source/WebKit: This patch introduces a new SPI to find paragraphs of text and let client replace the content of each paragraph. For now, this SPI is limited to find & replace contents of main frame's document. WKWebView's _startTextManipulationsWithCompletionHandler sends StartTextManipulations message to WebContent process to find all paragraphs in the main frame. WebContent process will send back DidFindTextManipulationItem message for each paragraph, which in turn calls back _WKTextManipulationDelegate's _webView: didFindTextManipulationItem:. Upon receiving this delegate callback, the client can invoke WKWebView's _completeTextManipulation to replace the content. It will send CompleteTextManipulation to WebContent process, which will invoke completeManipulation on main frame's document's TextManipulationController. * UIProcess/API/Cocoa/WKWebView.mm: (-[WKWebView _textManipulationDelegate]): Aded. (-[WKWebView _setTextManipulationDelegate:]): Aded. (-[WKWebView _startTextManipulationsWithCompletionHandler:]): (-[WKWebView _completeTextManipulation:completion:]): * UIProcess/API/Cocoa/WKWebViewPrivate.h: * UIProcess/API/Cocoa/_WKTextManipulationDelegate.h: Added. * UIProcess/API/Cocoa/_WKTextManipulationItem.h: Added. * UIProcess/API/Cocoa/_WKTextManipulationItem.mm: Added. (-[_WKTextManipulationItem initWithIdentifier:tokens:]): (-[_WKTextManipulationItem identifier]): (-[_WKTextManipulationItem tokens]): * UIProcess/API/Cocoa/_WKTextManipulationToken.h: Added. * UIProcess/API/Cocoa/_WKTextManipulationToken.mm: Added. (-[_WKTextManipulationToken init]): * UIProcess/WebPageProxy.cpp: (WebKit::WebPageProxy::startTextManipulations): (WebKit::WebPageProxy::didFindTextManipulationItem): (WebKit::WebPageProxy::completeTextManipulation): * UIProcess/WebPageProxy.h: * UIProcess/WebPageProxy.messages.in: * WebKit.xcodeproj/project.pbxproj: * WebProcess/WebPage/WebPage.cpp: (WebKit::WebPage::startTextManipulations): (WebKit::WebPage::completeTextManipulation): * WebProcess/WebPage/WebPage.h: * WebProcess/WebPage/WebPage.messages.in: Tools: Added basic API tests for the new SPI. * TestWebKitAPI/TestWebKitAPI.xcodeproj/project.pbxproj: * TestWebKitAPI/Tests/WebKitCocoa/TextManipulation.mm: Added. (-[TextManipulationDelegate init]): (-[TextManipulationDelegate _webView:didFindItem:forFrame:]): (-[TextManipulationDelegate items]): (TestWebKitAPI::createItem): git-svn-id: http://svn.webkit.org/repository/webkit/trunk@251558 268f45cc-cd09-0410-ab3c-d52691b4dbfc
WebKit is a cross-platform web browser engine. On iOS and macOS, it powers Safari, Mail, iBooks, and many other applications.
Visit WebKit Feature Status page to see which Web API has been implemented, in development, or under consideration.
On macOS, download Safari Technology Preview to test the latest version of WebKit. On Linux, download Epiphany Technology Preview. On Windows, you'll have to build it yourself.
Once your bug is filed, you will receive email when it is updated at each stage in the bug life cycle. After the bug is considered fixed, you may be asked to download the latest nightly and confirm that the fix works for you.
On Windows, follow the instructions on our website.
Run the following command to clone WebKit's Git SVN repository:
git clone git://git.webkit.org/WebKit.git WebKit
or
git clone https://git.webkit.org/git/WebKit.git WebKit
If you want to be able to commit changes to the repository, or just want to check out branches that aren’t contained in WebKit.git, you will need track WebKit's Subversion repository. You can run the following command to configure this and other options of the new Git clone for WebKit development.
Tools/Scripts/webkit-patch setup-git-clone
For information about this, and other aspects of using Git with WebKit, read the wiki page.
If you don‘t want to use Git, run the following command to check out WebKit’s Subversion repository:
svn checkout https://svn.webkit.org/repository/webkit/trunk WebKit
Install Xcode and its command line tools if you haven't done so already:
xcode-select --install
Run the following command to build a debug build with debugging symbols and assertions:
Tools/Scripts/build-webkit --debug
For performance testing, and other purposes, use --release
instead.
You can open WebKit.xcworkspace
to build and debug WebKit within Xcode.
If you don't use a custom build location in Xcode preferences, you have to update the workspace settings to use WebKitBuild
directory. In menu bar, choose File > Workspace Settings, then click the Advanced button, select “Custom”, “Relative to Workspace”, and enter WebKitBuild
for both Products and Intermediates.
The first time after you install a new Xcode, you will need to run the following command to enable Xcode to build command line tools for iOS Simulator:
sudo Tools/Scripts/configure-xcode-for-ios-development
Without this step, you will see the error message: “target specifies product type ‘com.apple.product-type.tool’, but there’s no such product type for the ‘iphonesimulator’ platform.
” when building target JSCLLIntOffsetsExtractor
of project JavaScriptCore
.
Run the following command to build a debug build with debugging symbols and assertions for iOS:
Tools/Scripts/build-webkit --debug --ios-simulator
For production builds:
cmake -DPORT=GTK -DCMAKE_BUILD_TYPE=RelWithDebInfo -GNinja ninja sudo ninja install
For development builds:
Tools/gtk/install-dependencies Tools/Scripts/update-webkitgtk-libs Tools/Scripts/build-webkit --gtk --debug
For more information on building WebKitGTK+, see the wiki page.
For production builds:
cmake -DPORT=WPE -DCMAKE_BUILD_TYPE=RelWithDebInfo -GNinja ninja sudo ninja install
For development builds:
Tools/wpe/install-dependencies Tools/Scripts/update-webkitwpe-libs Tools/Scripts/build-webkit --wpe --debug
For building WebKit on Windows, see the wiki page.
Run the following command to launch Safari with your local build of WebKit:
Tools/Scripts/run-safari --debug
The run-safari
script sets the DYLD_FRAMEWORK_PATH
environment variable to point to your build products, and then launches /Applications/Safari.app
. DYLD_FRAMEWORK_PATH
tells the system loader to prefer your build products over the frameworks installed in /System/Library/Frameworks
.
To run other applications with your local build of WebKit, run the following command:
Tools/Scripts/run-webkit-app <application-path>
Run the following command to launch iOS simulator with your local build of WebKit:
run-safari --debug --ios-simulator
In both cases, if you have built release builds instead, use --release
instead of --debug
.
If you have a development build, you can use the run-minibrowser script, e.g.:
run-minibrowser --debug --wpe
Pass one of --gtk
, --jsc-only
, or --wpe
to indicate the port to use.
Congratulations! You’re up and running. Now you can begin coding in WebKit and contribute your fixes and new features to the project. For details on submitting your code to the project, read Contributing Code.