Tools/TestWebKitAPI/Helpers/cocoa/FindStateSnapshot.h

/*
 * Copyright (C) 2026 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */

#pragma once

#ifdef __cplusplus

#import <CoreGraphics/CoreGraphics.h>
#import <wtf/Vector.h>
#import <wtf/text/WTFString.h>

@class TestWKWebView;

namespace TestWebKitAPI {

struct FrameFindState {
    Vector<unsigned> path; // Child indices from the main frame; the main frame's path is empty.
    String selectedText;
    CGPoint scrollPosition { };
    bool hasFocus { false };
};

struct FindStateSnapshot {
    Vector<FrameFindState> frames;
    CGRect textIndicatorRect { CGRectNull }; // In web view layer coordinates; CGRectNull unless an indicator layer is installed.
#if HAVE(UIFINDINTERACTION)
    bool hasFindOverlayLayer { false };
#endif
#if PLATFORM(IOS_FAMILY)
    CGPoint contentOffset { };
#endif

    static FindStateSnapshot capture(TestWKWebView *);

    std::optional<FrameFindState> frame(const Vector<unsigned>& path) const;
    Vector<Vector<unsigned>> framesWithSelection() const;
};

} // namespace TestWebKitAPI

#endif // __cplusplus