/*
 * Copyright (C) 2022 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.
 */

#import <WebCore/RunLoopObserver.h>
#import <wtf/CheckedPtr.h>
#import <wtf/TZoneMalloc.h>
#import <wtf/WeakPtr.h>

@class WebView;

class WebViewRenderingUpdateScheduler : public CanMakeWeakPtr<WebViewRenderingUpdateScheduler>, public CanMakeCheckedPtr<WebViewRenderingUpdateScheduler> {
    WTF_MAKE_TZONE_ALLOCATED(WebViewRenderingUpdateScheduler);
    WTF_OVERRIDE_DELETE_FOR_CHECKED_PTR(WebViewRenderingUpdateScheduler);
public:
    explicit WebViewRenderingUpdateScheduler(WebView*);
    ~WebViewRenderingUpdateScheduler();

    void scheduleRenderingUpdate();
    void invalidate();

    void didCompleteRenderingUpdateDisplay();
    
private:
    void registerCACommitHandlers();

    void renderingUpdateRunLoopObserverCallback();
    void updateRendering();

    void schedulePostRenderingUpdate();
    void postRenderingUpdateCallback();

    WebView* m_webView;

    std::unique_ptr<WebCore::RunLoopObserver> m_renderingUpdateRunLoopObserver;
    std::unique_ptr<WebCore::RunLoopObserver> m_postRenderingUpdateRunLoopObserver;

    bool m_insideCallback { false };
    bool m_rescheduledInsideCallback { false };
    bool m_haveRegisteredCommitHandlers { false };
};