diff options
Diffstat (limited to 'WebKit/chromium/src/WebPageSerializerImpl.h')
| -rw-r--r-- | WebKit/chromium/src/WebPageSerializerImpl.h | 189 |
1 files changed, 0 insertions, 189 deletions
diff --git a/WebKit/chromium/src/WebPageSerializerImpl.h b/WebKit/chromium/src/WebPageSerializerImpl.h deleted file mode 100644 index 5ee8805..0000000 --- a/WebKit/chromium/src/WebPageSerializerImpl.h +++ /dev/null @@ -1,189 +0,0 @@ -/* - * Copyright (C) 2009 Google 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: - * - * * Redistributions of source code must retain the above copyright - * notice, this list of conditions and the following disclaimer. - * * 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. - * * Neither the name of Google Inc. nor the names of its - * contributors may be used to endorse or promote products derived from - * this software without specific prior written permission. - * - * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 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 THE COPYRIGHT - * OWNER OR 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. - */ - -#ifndef WebPageSerializerImpl_h -#define WebPageSerializerImpl_h - -#include <wtf/Forward.h> -#include <wtf/HashMap.h> -#include <wtf/Vector.h> -#include <wtf/text/StringBuilder.h> -#include <wtf/text/StringHash.h> -#include <wtf/text/WTFString.h> - -#include "WebEntities.h" -#include "WebPageSerializer.h" -#include "WebPageSerializerClient.h" -#include "WebString.h" -#include "WebURL.h" - -namespace WebCore { -class Document; -class Element; -class Node; -class TextEncoding; -} - -namespace WebKit { -class WebFrameImpl; - -// Get html data by serializing all frames of current page with lists -// which contain all resource links that have local copy. -// contain all saved auxiliary files included all sub frames and resources. -// This function will find out all frames and serialize them to HTML data. -// We have a data buffer to temporary saving generated html data. We will -// sequentially call WebViewDelegate::SendSerializedHtmlData once the data -// buffer is full. See comments of WebViewDelegate::SendSerializedHtmlData -// for getting more information. -class WebPageSerializerImpl { -public: - // Do serialization action. Return false means no available frame has been - // serialized, otherwise return true. - bool serialize(); - - // The parameter specifies which frame need to be serialized. - // The parameter recursive_serialization specifies whether we need to - // serialize all sub frames of the specified frame or not. - // The parameter delegate specifies the pointer of interface - // DomSerializerDelegate provide sink interface which can receive the - // individual chunks of data to be saved. - // The parameter links contain original URLs of all saved links. - // The parameter local_paths contain corresponding local file paths of all - // saved links, which matched with vector:links one by one. - // The parameter local_directory_name is relative path of directory which - // contain all saved auxiliary files included all sub frames and resources. - WebPageSerializerImpl(WebFrame* frame, - bool recursive, - WebPageSerializerClient* client, - const WebVector<WebURL>& links, - const WebVector<WebString>& localPaths, - const WebString& localDirectoryName); - -private: - // Specified frame which need to be serialized; - WebFrameImpl* m_specifiedWebFrameImpl; - // Pointer of WebPageSerializerClient - WebPageSerializerClient* m_client; - // This hash map is used to map resource URL of original link to its local - // file path. - typedef HashMap<WTF::String, WTF::String> LinkLocalPathMap; - // local_links_ include all pair of local resource path and corresponding - // original link. - LinkLocalPathMap m_localLinks; - // Data buffer for saving result of serialized DOM data. - StringBuilder m_dataBuffer; - // Passing true to recursive_serialization_ indicates we will serialize not - // only the specified frame but also all sub-frames in the specific frame. - // Otherwise we only serialize the specified frame excluded all sub-frames. - bool m_recursiveSerialization; - // Flag indicates whether we have collected all frames which need to be - // serialized or not; - bool m_framesCollected; - // Local directory name of all local resource files. - WTF::String m_localDirectoryName; - // Vector for saving all frames which need to be serialized. - Vector<WebFrameImpl*> m_frames; - - // Web entities conversion maps. - WebEntities m_htmlEntities; - WebEntities m_xmlEntities; - - struct SerializeDomParam { - const WebCore::KURL& url; - const WebCore::TextEncoding& textEncoding; - WebCore::Document* document; - const WTF::String& directoryName; - bool isHTMLDocument; // document.isHTMLDocument() - bool haveSeenDocType; - bool haveAddedCharsetDeclaration; - // This meta element need to be skipped when serializing DOM. - const WebCore::Element* skipMetaElement; - // Flag indicates we are in script or style tag. - bool isInScriptOrStyleTag; - bool haveAddedXMLProcessingDirective; - // Flag indicates whether we have added additional contents before end tag. - // This flag will be re-assigned in each call of function - // PostActionAfterSerializeOpenTag and it could be changed in function - // PreActionBeforeSerializeEndTag if the function adds new contents into - // serialization stream. - bool haveAddedContentsBeforeEnd; - - SerializeDomParam(const WebCore::KURL&, const WebCore::TextEncoding&, WebCore::Document*, const WTF::String& directoryName); - }; - - // Collect all target frames which need to be serialized. - void collectTargetFrames(); - // Before we begin serializing open tag of a element, we give the target - // element a chance to do some work prior to add some additional data. - WTF::String preActionBeforeSerializeOpenTag(const WebCore::Element* element, - SerializeDomParam* param, - bool* needSkip); - // After we finish serializing open tag of a element, we give the target - // element a chance to do some post work to add some additional data. - WTF::String postActionAfterSerializeOpenTag(const WebCore::Element* element, - SerializeDomParam* param); - // Before we begin serializing end tag of a element, we give the target - // element a chance to do some work prior to add some additional data. - WTF::String preActionBeforeSerializeEndTag(const WebCore::Element* element, - SerializeDomParam* param, - bool* needSkip); - // After we finish serializing end tag of a element, we give the target - // element a chance to do some post work to add some additional data. - WTF::String postActionAfterSerializeEndTag(const WebCore::Element* element, - SerializeDomParam* param); - // Save generated html content to data buffer. - void saveHTMLContentToBuffer(const WTF::String& content, - SerializeDomParam* param); - - enum FlushOption { - ForceFlush, - DoNotForceFlush, - }; - - // Flushes the content buffer by encoding and sending the content to the - // WebPageSerializerClient. Content is not flushed if the buffer is not full - // unless force is 1. - void encodeAndFlushBuffer(WebPageSerializerClient::PageSerializationStatus status, - SerializeDomParam* param, - FlushOption); - // Serialize open tag of an specified element. - void openTagToString(const WebCore::Element* element, - SerializeDomParam* param); - // Serialize end tag of an specified element. - void endTagToString(const WebCore::Element* element, - SerializeDomParam* param); - // Build content for a specified node - void buildContentForNode(const WebCore::Node* node, - SerializeDomParam* param); -}; - -} // namespace WebKit - -#endif |