Tools/TestWebKitAPI/EditingTestHarness.h

   1 /*
   2  * Copyright (C) 2017 Apple Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
  14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
  17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  23  * THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #pragma once
  27
  28 #import "TestWKWebView.h"
  29 #import <WebKit/WKUIDelegatePrivate.h>
  30
  31 @interface EditingTestHarness : NSObject<WKUIDelegatePrivate> {
  32     RetainPtr<NSMutableArray<NSDictionary *>> _editorStateHistory;
  33     RetainPtr<TestWKWebView> _webView;
  34 }
  35
  36 - (instancetype)initWithWebView:(TestWKWebView *)webView;
  37
  38 @property (nonatomic, readonly) TestWKWebView *webView;
  39 @property (nonatomic, readonly) NSDictionary *latestEditorState;
  40 @property (nonatomic, readonly) NSArray<NSDictionary *> *editorStateHistory;
  41
  42 - (void)insertParagraph;
  43 - (void)insertText:(NSString *)text;
  44 - (void)insertHTML:(NSString *)html;
  45 - (void)selectAll;
  46 - (void)deleteBackwards;
  47 - (void)moveBackward;
  48 - (void)moveForward;
  49 - (void)insertParagraphAndExpectEditorStateWith:(NSDictionary<NSString *, id> *)entries;
  50 - (void)insertText:(NSString *)text andExpectEditorStateWith:(NSDictionary<NSString *, id> *)entries;
  51 - (void)insertHTML:(NSString *)html andExpectEditorStateWith:(NSDictionary<NSString *, id> *)entries;
  52 - (void)selectAllAndExpectEditorStateWith:(NSDictionary<NSString *, id> *)entries;
  53 - (void)moveBackwardAndExpectEditorStateWith:(NSDictionary<NSString *, id> *)entries;
  54 - (void)moveWordBackwardAndExpectEditorStateWith:(NSDictionary<NSString *, id> *)entries;
  55 - (void)deleteBackwardAndExpectEditorStateWith:(NSDictionary<NSString *, id> *)entries;
  56 - (void)toggleBold;
  57 - (void)toggleItalic;
  58 - (void)toggleUnderline;
  59 - (void)setForegroundColor:(NSString *)colorAsString;
  60 - (void)alignJustifiedAndExpectEditorStateWith:(NSDictionary<NSString *, id> *)entries;
  61 - (void)alignLeftAndExpectEditorStateWith:(NSDictionary<NSString *, id> *)entries;
  62 - (void)alignCenterAndExpectEditorStateWith:(NSDictionary<NSString *, id> *)entries;
  63 - (void)alignRightAndExpectEditorStateWith:(NSDictionary<NSString *, id> *)entries;
  64
  65 - (BOOL)latestEditorStateContains:(NSDictionary<NSString *, id> *)entries;
  66
  67 @end