1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
|
/*
* Copyright (C) 2004 Apple Computer, 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:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. 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.
*
* THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``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 APPLE COMPUTER, INC. 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 THIRD_PARTY_BLINK_RENDERER_CORE_EDITING_SERIALIZERS_SERIALIZATION_H_
#define THIRD_PARTY_BLINK_RENDERER_CORE_EDITING_SERIALIZERS_SERIALIZATION_H_
#include "third_party/blink/renderer/core/core_export.h"
#include "third_party/blink/renderer/core/css/css_property_names.h"
#include "third_party/blink/renderer/core/dom/parser_content_policy.h"
#include "third_party/blink/renderer/core/dom/shadow_root.h"
#include "third_party/blink/renderer/core/editing/forward.h"
#include "third_party/blink/renderer/core/editing/serializers/create_markup_options.h"
#include "third_party/blink/renderer/core/editing/serializers/html_interchange.h"
#include "third_party/blink/renderer/platform/heap/collection_support/heap_hash_set.h"
#include "third_party/blink/renderer/platform/heap/garbage_collected.h"
#include "third_party/blink/renderer/platform/wtf/forward.h"
namespace blink {
class ContainerNode;
class Document;
class DocumentFragment;
class Element;
class ExceptionState;
class Node;
class CSSPropertyValueSet;
enum ChildrenOnly { kIncludeNode, kChildrenOnly };
using ShadowRootSet = HeapHashSet<Member<ShadowRoot>>;
struct ShadowRootInclusion final {
STACK_ALLOCATED();
public:
enum class Behavior {
// Only serialize shadow roots provided in the include_shadow_roots list.
// Do *not* serialize any other shadow roots, including if they're marked
// serializable.
kOnlyProvidedShadowRoots,
// Include any shadow root (open or closed) marked `serializable`. Also
// include any shadow root in the include_shadow_roots list.
kIncludeAnySerializableShadowRoots,
};
ShadowRootInclusion() = default;
explicit ShadowRootInclusion(Behavior behavior) : behavior(behavior) {}
~ShadowRootInclusion() = default;
Behavior behavior{Behavior::kOnlyProvidedShadowRoots};
ShadowRootSet include_shadow_roots{};
};
DocumentFragment* CreateFragmentFromText(const EphemeralRange& context,
const String& text);
DocumentFragment* CreateFragmentFromMarkup(
Document&,
const String& markup,
const String& base_url,
ParserContentPolicy = kAllowScriptingContent);
DocumentFragment* CreateFragmentFromMarkupWithContext(Document&,
const String& markup,
unsigned fragment_start,
unsigned fragment_end,
const String& base_url,
ParserContentPolicy);
DocumentFragment* CreateFragmentForInnerOuterHTML(
const String&,
Element*,
ParserContentPolicy,
Element::ParseDeclarativeShadowRoots parse_declarative_shadows,
Element::ForceHtml force_html,
ExceptionState&);
DocumentFragment* CreateFragmentForTransformToFragment(
const String&,
const String& source_mime_type,
Document& output_doc);
DocumentFragment* CreateContextualFragment(const String&,
Element*,
ParserContentPolicy,
ExceptionState&);
bool IsPlainTextMarkup(Node*);
// These methods are used by HTMLElement & ShadowRoot to replace the
// children with respected fragment/text.
void ReplaceChildrenWithFragment(ContainerNode*,
DocumentFragment*,
ExceptionState&);
void ReplaceChildrenWithText(ContainerNode*, const String&, ExceptionState&);
CORE_EXPORT String
CreateMarkup(const Node*,
ChildrenOnly = kIncludeNode,
AbsoluteURLs = kDoNotResolveURLs,
const ShadowRootInclusion& = ShadowRootInclusion());
CORE_EXPORT String
CreateMarkup(const Position& start,
const Position& end,
const CreateMarkupOptions& options = CreateMarkupOptions());
CORE_EXPORT String
CreateMarkup(const PositionInFlatTree& start,
const PositionInFlatTree& end,
const CreateMarkupOptions& options = CreateMarkupOptions());
// Processes the HTML string and returns a fragment from the given markup
// stripping out certain security sensitive tags if needed. While this
// processing happens in an isolated document, the final fragment is created in
// the given document, and should be eventually inserted into the document.
// Returns null if this processing fails.
CORE_EXPORT DocumentFragment*
CreateStrictlyProcessedFragmentFromMarkupWithContext(Document&,
const String& raw_markup,
unsigned fragment_start,
unsigned fragment_end,
const String& base_url);
// Processes the HTML string and strips out certain security sensitive tags if
// needed.
// Creates a fragment using the first few parameters, and
// then re-serializes it with the last few parameters as the return value. The
// whole process is done in an isolated document.
// Returns the null string if this processing fails, and otherwise returns the
// processed markup.
CORE_EXPORT String CreateStrictlyProcessedMarkupWithContext(
Document&,
const String& raw_markup,
unsigned fragment_start,
unsigned fragment_end,
const String& base_url,
ChildrenOnly = kIncludeNode,
AbsoluteURLs = kDoNotResolveURLs,
const ShadowRootInclusion& = ShadowRootInclusion());
void MergeWithNextTextNode(Text*, ExceptionState&);
bool PropertyMissingOrEqualToNone(CSSPropertyValueSet*, CSSPropertyID);
} // namespace blink
#endif // THIRD_PARTY_BLINK_RENDERER_CORE_EDITING_SERIALIZERS_SERIALIZATION_H_
|