15267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)/* 25267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * Copyright (C) 2009 Google Inc. All rights reserved. 35267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * 45267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * Redistribution and use in source and binary forms, with or without 55267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * modification, are permitted provided that the following conditions are 65267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * met: 75267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * 85267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * * Redistributions of source code must retain the above copyright 95267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * notice, this list of conditions and the following disclaimer. 105267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * * Redistributions in binary form must reproduce the above 115267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * copyright notice, this list of conditions and the following disclaimer 125267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * in the documentation and/or other materials provided with the 135267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * distribution. 145267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * * Neither the name of Google Inc. nor the names of its 155267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * contributors may be used to endorse or promote products derived from 165267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * this software without specific prior written permission. 175267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * 185267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 195267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 205267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 215267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 225267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 235267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 245267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 255267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 265267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 275267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 285267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 295267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) */ 305267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) 315267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)#ifndef WebPageSerializerClient_h 325267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)#define WebPageSerializerClient_h 335267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) 345267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)namespace WebKit { 355267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)class WebCString; 365267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)class WebURL; 375267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) 385267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)// This class is used for providing sink interface that can be used to receive 395267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)// the individual chunks of data to be saved. 405267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)class WebPageSerializerClient { 415267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)public: 425267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) // This enum indicates This sink interface can receive the individual chunks 435267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) // of serialized data to be saved, so we use values of following enum 445267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) // definition to indicate the serialization status of serializing all html 455267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) // content. If current frame is not complete serialized, call 465267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) // didSerializeDataForFrame with URL of current frame, data, data length and 475267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) // flag CurrentFrameIsNotFinished. 485267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) // If current frame is complete serialized, call didSerializeDataForFrame 495267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) // with URL of current frame, data, data length and flag 505267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) // CurrentFrameIsFinished. 515267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) // If all frames of page are complete serialized, call 525267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) // didSerializeDataForFrame with empty URL, empty data, 0 and flag 535267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) // AllFramesAreFinished. 545267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) enum PageSerializationStatus { 555267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) CurrentFrameIsNotFinished, 565267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) CurrentFrameIsFinished, 575267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) AllFramesAreFinished, 585267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) }; 595267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) 605267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) // Receive the individual chunks of serialized and encoded data to be saved. 615267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) // The parameter frameURL specifies what frame the data belongs. The 625267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) // parameter data contains the available data for saving. The parameter 635267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) // status indicates the status of data serialization. 645267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) virtual void didSerializeDataForFrame(const WebURL& frameURL, 655267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) const WebCString& data, 665267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) PageSerializationStatus status) = 0; 675267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) WebPageSerializerClient() { } 685267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) 695267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)protected: 705267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) virtual ~WebPageSerializerClient() { } 715267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)}; 725267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) 735267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)} // namespace WebKit 745267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles) 755267f701546148b83dfbe1d151cb184385bb5c22Torne (Richard Coles)#endif 76