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 36 class WebCString; 37 class WebURL; 38 39 // This class is used for providing sink interface that can be used to receive 40 // the individual chunks of data to be saved. 41 class WebPageSerializerClient { 42 public: 43 // This enum indicates This sink interface can receive the individual chunks 44 // of serialized data to be saved, so we use values of following enum 45 // definition to indicate the serialization status of serializing all html 46 // content. If current frame is not complete serialized, call 47 // didSerializeDataForFrame with URL of current frame, data, data length and 48 // flag CurrentFrameIsNotFinished. 49 // If current frame is complete serialized, call didSerializeDataForFrame 50 // with URL of current frame, data, data length and flag 51 // CurrentFrameIsFinished. 52 // If all frames of page are complete serialized, call 53 // didSerializeDataForFrame with empty URL, empty data, 0 and flag 54 // AllFramesAreFinished. 55 enum PageSerializationStatus { 56 CurrentFrameIsNotFinished, 57 CurrentFrameIsFinished, 58 AllFramesAreFinished, 59 }; 60 61 // Receive the individual chunks of serialized and encoded data to be saved. 62 // The parameter frameURL specifies what frame the data belongs. The 63 // parameter data contains the available data for saving. The parameter 64 // status indicates the status of data serialization. 65 virtual void didSerializeDataForFrame(const WebURL& frameURL, 66 const WebCString& data, 67 PageSerializationStatus status) = 0; 68 WebPageSerializerClient() { } 69 70 protected: 71 virtual ~WebPageSerializerClient() { } 72 }; 73 74 } // namespace blink 75 76 #endif 77
