1 /* 2 * Copyright (C) 2009 Google Inc. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions are 6 * met: 7 * 8 * * Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * * Redistributions in binary form must reproduce the above 11 * copyright notice, this list of conditions and the following disclaimer 12 * in the documentation and/or other materials provided with the 13 * distribution. 14 * * Neither the name of Google Inc. nor the names of its 15 * contributors may be used to endorse or promote products derived from 16 * this software without specific prior written permission. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29 */ 30 31 #ifndef WebPageSerializerClient_h 32 #define WebPageSerializerClient_h 33 34 namespace blink { 35 class WebCString; 36 class WebURL; 37 38 // This class is used for providing sink interface that can be used to receive 39 // the individual chunks of data to be saved. 40 class WebPageSerializerClient { 41 public: 42 // This enum indicates This sink interface can receive the individual chunks 43 // of serialized data to be saved, so we use values of following enum 44 // definition to indicate the serialization status of serializing all html 45 // content. If current frame is not complete serialized, call 46 // didSerializeDataForFrame with URL of current frame, data, data length and 47 // flag CurrentFrameIsNotFinished. 48 // If current frame is complete serialized, call didSerializeDataForFrame 49 // with URL of current frame, data, data length and flag 50 // CurrentFrameIsFinished. 51 // If all frames of page are complete serialized, call 52 // didSerializeDataForFrame with empty URL, empty data, 0 and flag 53 // AllFramesAreFinished. 54 enum PageSerializationStatus { 55 CurrentFrameIsNotFinished, 56 CurrentFrameIsFinished, 57 AllFramesAreFinished, 58 }; 59 60 // Receive the individual chunks of serialized and encoded data to be saved. 61 // The parameter frameURL specifies what frame the data belongs. The 62 // parameter data contains the available data for saving. The parameter 63 // status indicates the status of data serialization. 64 virtual void didSerializeDataForFrame(const WebURL& frameURL, 65 const WebCString& data, 66 PageSerializationStatus status) = 0; 67 WebPageSerializerClient() { } 68 69 protected: 70 virtual ~WebPageSerializerClient() { } 71 }; 72 73 } // namespace blink 74 75 #endif 76
