/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

include IPCTransferable;
include protocol PContent;

include "mozilla/widget/WidgetMessageUtils.h";

using nsIClipboard::ClipboardType from "nsIClipboard.h";

namespace mozilla {

[ChildProc=Content]
sync protocol PClipboardContentAnalysis
{
parent:
    // Given a list of supported types, returns the clipboard data for the
    // first type that matches.
    // aRequestingWindowContextId is the ID of the window that is requesting
    // the clipboard, which is used for content analysis.
    sync GetClipboard(nsCString[] aTypes, ClipboardType aWhichClipboard,
                      uint64_t aRequestingWindowContextId)
        returns (IPCTransferableDataOrError transferableDataOrError);

    // Given a list of supported types, returns the clipboard data for the
    // first type that matches if the data byte size <= aThreshold.
    // aRequestingWindowContext is the window that is requesting the clipboard,
    // which is used for content analysis.
    async GetClipboardDataIfSmallerThan(nsCString[] aTypes,
                                        uint64_t aThreshold,
                                        ClipboardType aWhichClipboard,
                                        uint64_t aRequestingWindowContextId)
        returns (IPCTransferableDataOrError transferableDataOrError);

    // Requests getting data from clipboard.
    // aRequestingWindowContextId is the ID of the window that is requesting
    // the clipboard, which is used for content analysis.
    sync GetAllClipboardDataSync(nsCString[] aTypes, ClipboardType aWhichClipboard,
                                 uint64_t aRequestingWindowContextId)
        returns (IPCTransferableDataOrError transferableDataOrError);
};

}