selectable_test.dart 22 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647
// Copyright 2014 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

// The following tests are transformed from flutter/test/widgets/selectable_text_test.dart

import 'package:flutter/foundation.dart';
import 'package:flutter/gestures.dart';
import 'package:flutter/material.dart';
import 'package:flutter/rendering.dart';
import 'package:flutter_math_fork/src/render/layout/line_editable.dart';
import 'package:flutter_math_fork/src/widgets/selectable.dart';
import 'package:flutter_math_fork/src/widgets/selection/handle_overlay.dart';
import 'package:flutter_test/flutter_test.dart';

import '../load_fonts.dart';

Widget overlay({required Widget child}) => MaterialApp(
      home: Center(
        child: Material(
          child: child,
        ),
      ),
    );

Future<void> skipPastScrollingAnimation(WidgetTester tester) async {
  await tester.pump();
  await tester.pump(const Duration(milliseconds: 200));
}

void main() {
  // Returns the first RenderEditable.
  RenderEditableLine findRenderEditableLine(WidgetTester tester) {
    final root = tester.renderObject(find.byType(InternalSelectableMath));
    expect(root, isNotNull);

    RenderEditableLine? renderEditable;
    void recursiveFinder(RenderObject child) {
      if (child is RenderEditableLine) {
        renderEditable = child;
        return;
      }
      child.visitChildren(recursiveFinder);
    }

    root.visitChildren(recursiveFinder);
    expect(renderEditable, isNotNull);
    return renderEditable!;
  }

  Offset textOffsetToCaretPosition(WidgetTester tester, int index) {
    final renderLine = findRenderEditableLine(tester);
    final endpoints = renderLine.getEndpointForCaretIndex(index);
    return endpoints + const Offset(0.0, -2.0);
  }

  setUpAll(loadKaTeXFonts);

  group('SelectableMath test', () {
    testWidgets('Cursor blinks when showCursor is true',
        (WidgetTester tester) async {
      await tester.pumpWidget(
        overlay(
          child: SelectableMath.tex(
            'some text',
            showCursor: true,
          ),
        ),
      );
      await tester.tap(find.byType(SelectableMath));
      await tester.idle();

      final selectableMath = tester.state<InternalSelectableMathState>(
          find.byType(InternalSelectableMath));

      // Check that the cursor visibility toggles after each blink interval.
      final initialShowCursor = selectableMath.cursorCurrentlyVisible;
      await tester.pump(selectableMath.cursorBlinkInterval);
      expect(selectableMath.cursorCurrentlyVisible, equals(!initialShowCursor));
      await tester.pump(selectableMath.cursorBlinkInterval);
      expect(selectableMath.cursorCurrentlyVisible, equals(initialShowCursor));
      await tester.pump(selectableMath.cursorBlinkInterval ~/ 10);
      expect(selectableMath.cursorCurrentlyVisible, equals(initialShowCursor));
      await tester.pump(selectableMath.cursorBlinkInterval);
      expect(selectableMath.cursorCurrentlyVisible, equals(!initialShowCursor));
      await tester.pump(selectableMath.cursorBlinkInterval);
      expect(selectableMath.cursorCurrentlyVisible, equals(initialShowCursor));
    });

    testWidgets('selectable math basic', (WidgetTester tester) async {
      await tester.pumpWidget(
        overlay(
          child: SelectableMath.tex('selectable'),
        ),
      );
      final selectableMath = tester.state<InternalSelectableMathState>(
          find.byType(InternalSelectableMath));
      // selectable text cannot open keyboard.
      // TODO
      // await tester.showKeyboard(find.byType(InternalSelectableMath));
      // expect(tester.testTextInput.hasAnyClients, false);
      // await skipPastScrollingAnimation(tester);

      // expect(selectableMath.controller.selection.isCollapsed, true);

      await tester.tap(find.byType(SelectableMath));
      await tester.pump();

      // Collapse selection should not paint.
      expect(selectableMath.selectionOverlay!.handlesAreVisible, isFalse);
      // Long press on the 't' character of text 'selectable' to show context
      // menu.
      const dIndex = 5;
      final dPos = textOffsetToCaretPosition(tester, dIndex);
      await tester.longPressAt(dPos);
      await tester.pump();

      // Context menu should not have paste and cut.
      expect(find.text('Copy'), findsOneWidget);
      expect(find.text('Paste'), findsNothing);
      expect(find.text('Cut'), findsNothing);
    });

    testWidgets('Can drag handles to change selection',
        (WidgetTester tester) async {
      await tester.pumpWidget(
        MaterialApp(
          home: Material(
            child: Center(
              child: SelectableMath.tex(
                'abc def ghi',
                dragStartBehavior: DragStartBehavior.down,
              ),
            ),
          ),
        ),
      );
      final selectableMath = tester.state<InternalSelectableMathState>(
          find.byType(InternalSelectableMath));
      final controller = selectableMath.controller;

      // Long press the 'e' to select 'def'.
      final ePos = textOffsetToCaretPosition(tester, 5);
      var gesture = await tester.startGesture(ePos, pointer: 7);
      await tester.pump(const Duration(seconds: 2));
      await gesture.up();
      await tester.pump();
      await tester.pump(const Duration(
          milliseconds: 200)); // skip past the frame where the opacity is zero

      final selection = controller.selection;
      expect(selection.baseOffset, 5);
      expect(selection.extentOffset, 6);

      final renderEditable = findRenderEditableLine(tester);
      final endpoints = [
        renderEditable.getEndpointForCaretIndex(5),
        renderEditable.getEndpointForCaretIndex(6)
      ];
      expect(endpoints.length, 2);

      // Drag the right handle 2 letters to the right.
      // We use a small offset because the endpoint is on the very corner
      // of the handle.
      var handlePos = endpoints[1] + const Offset(1.0, 1.0);
      var newHandlePos = textOffsetToCaretPosition(tester, 9);
      gesture = await tester.startGesture(handlePos, pointer: 7);
      await tester.pump();
      await gesture.moveTo(newHandlePos);
      await tester.pump();
      await gesture.up();
      await tester.pump();

      expect(controller.selection.baseOffset, 5);
      expect(controller.selection.extentOffset, 9);

      // Drag the left handle 2 letters to the left.
      handlePos = endpoints[0] + const Offset(-1.0, 1.0);
      newHandlePos = textOffsetToCaretPosition(tester, 0);
      gesture = await tester.startGesture(handlePos, pointer: 7);
      await tester.pump();
      await gesture.moveTo(newHandlePos);
      await tester.pump();
      await gesture.up();
      await tester.pump();

      expect(controller.selection.baseOffset, 0);
      expect(controller.selection.extentOffset, 9);
    });

    // testWidgets('Can use selection toolbar', (WidgetTester tester) async {
    //   const testValue = 'abcdefghi';
    //   await tester.pumpWidget(
    //     MaterialApp(
    //       home: Material(
    //         child: Center(
    //           child: SelectableMath.tex(
    //             testValue,
    //           ),
    //         ),
    //       ),
    //     ),
    //   );
    //   final selectableMath = tester.state<InternalSelectableMathState>(
    //       find.byType(InternalSelectableMath));
    //   final controller = selectableMath.controller;

    //   // Tap the selection handle to bring up the "paste / select all" menu.
    //   await tester
    //       .tapAt(textOffsetToCaretPosition(tester, testValue.indexOf('e')));
    //   await tester.pump();
    //   await tester.pump(const Duration(
    //       milliseconds: 200)); // skip past the frame where the opacity is zero
    //   final renderLine = findRenderEditableLine(tester);
    //   final endpoint =
    //       renderLine.getEndpointForCaretIndex(controller.selection.start);
    //   // Tapping on the part of the handle's GestureDetector where it overlaps
    //   // with the text itself does not show the menu, so add a small vertical
    //   // offset to tap below the text.
    //   await tester.tapAt(endpoint + const Offset(1.0, 13.0));
    //   await tester.pump();
    //   await tester.pump(const Duration(
    //       milliseconds: 200)); // skip past the frame where the opacity is zero

    //   // Select all should select all the text.
    //   await tester.tap(find.text('Select all'));
    //   await tester.pump();
    //   expect(controller.selection.baseOffset, 0);
    //   expect(controller.selection.extentOffset, testValue.length);

    //   // Copy should reset the selection.
    //   await tester.tap(find.text('Copy'));
    //   await skipPastScrollingAnimation(tester);
    //   expect(controller.selection.isCollapsed, true);
    // });

    testWidgets('Selectable text drops selection when losing focus',
        (WidgetTester tester) async {
      final Key key1 = UniqueKey();
      final Key key2 = UniqueKey();

      await tester.pumpWidget(
        overlay(
          child: Column(
            children: <Widget>[
              SelectableMath.tex(
                'text 1',
                key: key1,
              ),
              SelectableMath.tex(
                'text 2',
                key: key2,
              ),
            ],
          ),
        ),
      );

      await tester.tap(find.byKey(key1));
      await tester.pump();
      final selectableMath = tester.state<InternalSelectableMathState>(
          find.byType(InternalSelectableMath).first);
      final controller = selectableMath.controller;
      controller.selection =
          const TextSelection(baseOffset: 0, extentOffset: 3);
      await tester.pump();
      expect(controller.selection, isNot(equals(TextRange.empty)));

      await tester.tap(find.byKey(key2));
      await tester.pump();
      expect(controller.selection, equals(TextRange.empty));
    });

    testWidgets('selection handles are rendered and not faded away',
        (WidgetTester tester) async {
      const testText = r'abcdef\frac{abc}{def}\sqrt[abc]{def}';
      await tester.pumpWidget(
        MaterialApp(
          home: Material(
            child: Center(
              child: SelectableMath.tex(testText),
            ),
          ),
        ),
      );

      final state = tester.state<InternalSelectableMathState>(
          find.byType(InternalSelectableMath));

      // await tester.tapAt(const Offset(20, 10));
      state.selectWordAt(
          offset: const Offset(20, 10), cause: SelectionChangedCause.longPress);
      await tester.pumpAndSettle();

      final transitions = find
          .descendant(
            of: find.byWidgetPredicate(
                (Widget w) => w.runtimeType == MathSelectionHandleOverlay),
            matching: find.byType(FadeTransition),
          )
          .evaluate()
          .map((Element e) => e.widget)
          .cast<FadeTransition>()
          .toList();
      expect(transitions.length, 2);
      final left = transitions[0];
      final right = transitions[1];

      expect(left.opacity.value, equals(1.0));
      expect(right.opacity.value, equals(1.0));
    });

    testWidgets('selection handles are rendered and not faded away',
        (WidgetTester tester) async {
      const testText = r'abcdef\frac{abc}{def}\sqrt[abc]{def}';
      await tester.pumpWidget(
        MaterialApp(
          home: Material(
            child: Center(
              child: SelectableMath.tex(testText),
            ),
          ),
        ),
      );

      final state = tester.state<InternalSelectableMathState>(
          find.byType(InternalSelectableMath));

      // await tester.tapAt(const Offset(20, 10));
      state.selectWordAt(
          offset: const Offset(20, 10), cause: SelectionChangedCause.longPress);
      await tester.pumpAndSettle();

      final transitions = find
          .descendant(
            of: find.byWidgetPredicate(
                (Widget w) => w.runtimeType == MathSelectionHandleOverlay),
            matching: find.byType(FadeTransition),
          )
          .evaluate()
          .map((Element e) => e.widget)
          .cast<FadeTransition>()
          .toList();
      expect(transitions.length, 2);
      final left = transitions[0];
      final right = transitions[1];

      expect(left.opacity.value, equals(1.0));
      expect(right.opacity.value, equals(1.0));
    },
        variant: const TargetPlatformVariant(
            <TargetPlatform>{TargetPlatform.iOS, TargetPlatform.macOS}));

    testWidgets('Long press shows handles and toolbar',
        (WidgetTester tester) async {
      await tester.pumpWidget(
        MaterialApp(
          home: Material(
            child: Center(
              child: SelectableMath.tex('abc def ghi'),
            ),
          ),
        ),
      );

      // Long press at 'e' in 'def'.
      final ePos = textOffsetToCaretPosition(tester, 5);
      await tester.longPressAt(ePos);
      await tester.pumpAndSettle();

      final selectableMath = tester.state<InternalSelectableMathState>(
          find.byType(InternalSelectableMath));
      expect(selectableMath.selectionOverlay!.handlesAreVisible, isTrue);
      expect(selectableMath.selectionOverlay!.toolbarIsVisible, isTrue);
    });

    testWidgets('Double tap shows handles and toolbar',
        (WidgetTester tester) async {
      await tester.pumpWidget(
        MaterialApp(
          home: Material(
            child: Center(
              child: SelectableMath.tex('abc def ghi'),
            ),
          ),
        ),
      );

      // Double tap at 'e' in 'def'.
      final ePos = textOffsetToCaretPosition(tester, 5);
      await tester.tapAt(ePos);
      await tester.pump(const Duration(milliseconds: 50));
      await tester.tapAt(ePos);
      await tester.pump();

      final selectableMath = tester.state<InternalSelectableMathState>(
          find.byType(InternalSelectableMath));
      expect(selectableMath.selectionOverlay!.handlesAreVisible, isTrue);
      expect(selectableMath.selectionOverlay!.toolbarIsVisible, isTrue);
    });

    testWidgets(
      'Mouse tap does not show handles nor toolbar',
      (WidgetTester tester) async {
        await tester.pumpWidget(
          MaterialApp(
            home: Material(
              child: Center(
                child: SelectableMath.tex('abc def ghi'),
              ),
            ),
          ),
        );

        // Long press to trigger the selectable text.
        final ePos = textOffsetToCaretPosition(tester, 5);
        final gesture = await tester.startGesture(
          ePos,
          pointer: 7,
          kind: PointerDeviceKind.mouse,
        );
        addTearDown(gesture.removePointer);
        await tester.pump();
        await gesture.up();
        await tester.pump();

        final selectableMath = tester.state<InternalSelectableMathState>(
            find.byType(InternalSelectableMath));
        expect(selectableMath.selectionOverlay!.toolbarIsVisible, isFalse);
        expect(selectableMath.selectionOverlay!.handlesAreVisible, isFalse);
      },
    );

    testWidgets(
      'Mouse long press does not show handles nor toolbar',
      (WidgetTester tester) async {
        await tester.pumpWidget(
          MaterialApp(
            home: Material(
              child: Center(
                child: SelectableMath.tex('abc def ghi'),
              ),
            ),
          ),
        );

        // Long press to trigger the selectable text.
        final ePos = textOffsetToCaretPosition(tester, 5);
        final gesture = await tester.startGesture(
          ePos,
          pointer: 7,
          kind: PointerDeviceKind.mouse,
        );
        addTearDown(gesture.removePointer);
        await tester.pump(const Duration(seconds: 2));
        await gesture.up();
        await tester.pump();

        final selectableMath = tester.state<InternalSelectableMathState>(
            find.byType(InternalSelectableMath));
        expect(selectableMath.selectionOverlay!.toolbarIsVisible, isFalse);
        expect(selectableMath.selectionOverlay!.handlesAreVisible, isFalse);
      },
    );

    testWidgets(
      'Mouse double tap does not show handles nor toolbar',
      (WidgetTester tester) async {
        await tester.pumpWidget(
          MaterialApp(
            home: Material(
              child: Center(
                child: SelectableMath.tex('abc def ghi'),
              ),
            ),
          ),
        );

        // Double tap to trigger the selectable text.
        final selectableTextPos = tester.getCenter(find.byType(SelectableMath));
        final gesture = await tester.startGesture(
          selectableTextPos,
          pointer: 7,
          kind: PointerDeviceKind.mouse,
        );
        addTearDown(gesture.removePointer);
        await tester.pump(const Duration(milliseconds: 50));
        await gesture.up();
        await tester.pump();
        await gesture.down(selectableTextPos);
        await tester.pump();
        await gesture.up();
        await tester.pump();

        final selectableMath = tester.state<InternalSelectableMathState>(
            find.byType(InternalSelectableMath));
        expect(selectableMath.selectionOverlay!.toolbarIsVisible, isFalse);
        expect(selectableMath.selectionOverlay!.handlesAreVisible, isFalse);
      },
    );

    testWidgets('changes mouse cursor when hovered',
        (WidgetTester tester) async {
      await tester.pumpWidget(
        MaterialApp(
          home: Material(
            child: Center(
              child: SelectableMath.tex('test'),
            ),
          ),
        ),
      );

      final gesture =
          await tester.createGesture(kind: PointerDeviceKind.mouse, pointer: 1);
      await gesture.addPointer(
          location: tester.getCenter(find.byType(SelectableMath)));
      addTearDown(gesture.removePointer);

      await tester.pump();

      expect(RendererBinding.instance.mouseTracker.debugDeviceActiveCursor(1),
          SystemMouseCursors.text);
    });

    testWidgets(
      'The handles show after pressing Select All',
      (WidgetTester tester) async {
        await tester.pumpWidget(
          MaterialApp(
            home: Material(
              child: Center(
                child: SelectableMath.tex('abc def ghi'),
              ),
            ),
          ),
        );

        // Long press at 'e' in 'def'.
        final ePos = textOffsetToCaretPosition(tester, 5);
        await tester.longPressAt(ePos);
        await tester.pumpAndSettle();

        expect(find.text('Select all'), findsOneWidget);
        expect(find.text('Copy'), findsOneWidget);
        expect(find.text('Paste'), findsNothing);
        expect(find.text('Cut'), findsNothing);
        var selectableMath = tester.state<InternalSelectableMathState>(
            find.byType(InternalSelectableMath));
        expect(selectableMath.selectionOverlay!.handlesAreVisible, isTrue);
        expect(selectableMath.selectionOverlay!.toolbarIsVisible, isTrue);

        await tester.tap(find.text('Select all'));
        await tester.pump();
        expect(find.text('Copy'), findsOneWidget);
        expect(find.text('Select all'), findsNothing);
        expect(find.text('Paste'), findsNothing);
        expect(find.text('Cut'), findsNothing);
        selectableMath = tester.state<InternalSelectableMathState>(
            find.byType(InternalSelectableMath));
        expect(selectableMath.selectionOverlay!.handlesAreVisible, isTrue);
      },
      variant: const TargetPlatformVariant(<TargetPlatform>{
        TargetPlatform.android,
        TargetPlatform.fuchsia,
        TargetPlatform.linux,
        TargetPlatform.windows,
      }),
    );

    testWidgets('Does not show handles when updated from the web engine',
        (WidgetTester tester) async {
      await tester.pumpWidget(
        MaterialApp(
          home: Material(
            child: Center(
              child: SelectableMath.tex('abc def ghi'),
            ),
          ),
        ),
      );

      // Interact with the selectable text to establish the input connection.
      final topLeft = tester.getTopLeft(find.byType(SelectableMath));
      final gesture = await tester.startGesture(
        topLeft + const Offset(0.0, 5.0),
        kind: PointerDeviceKind.mouse,
      );
      addTearDown(gesture.removePointer);
      await tester.pump(const Duration(milliseconds: 50));
      await gesture.up();
      await tester.pumpAndSettle();

      final state = tester.state<InternalSelectableMathState>(
          find.byType(InternalSelectableMath));
      expect(state.selectionOverlay!.handlesAreVisible, isFalse);
      expect(
        state.currentTextEditingValue.selection,
        const TextSelection.collapsed(offset: 0),
      );

      if (kIsWeb) {
        tester.testTextInput.updateEditingValue(const TextEditingValue(
          selection: TextSelection(baseOffset: 2, extentOffset: 7),
        ));
        // Wait for all the `setState` calls to be flushed.
        await tester.pumpAndSettle();
        expect(
          state.currentTextEditingValue.selection,
          const TextSelection(baseOffset: 2, extentOffset: 7),
        );
        expect(state.selectionOverlay!.handlesAreVisible, isFalse);
      }
    });

    // testWidgets('onSelectionChanged is called when selection changes',
    //     (WidgetTester tester) async {
    //   int onSelectionChangedCallCount = 0;

    //   await tester.pumpWidget(
    //     MaterialApp(
    //       home: Material(
    //         child: SelectableText(
    //           'abc def ghi',
    //           onSelectionChanged:
    //               (TextSelection selection, SelectionChangedCause cause) {
    //             onSelectionChangedCallCount += 1;
    //           },
    //         ),
    //       ),
    //     ),
    //   );

    //   // Long press to select 'abc'.
    //   final Offset aLocation = textOffsetToPosition(tester, 1);
    //   await tester.longPressAt(aLocation);
    //   await tester.pump();
    //   expect(onSelectionChangedCallCount, equals(1));

    //   // Tap on 'Select all' option to select the whole text.
    //   await tester.longPressAt(textOffsetToPosition(tester, 5));
    //   await tester.pump();
    //   await tester.tap(find.text('Select all'));
    //   expect(onSelectionChangedCallCount, equals(2));
    // });
  });
}