commit f108bce59d136c584969fd24a5006914796cf213
author Sam Rawlins <srawlins@google.com> Wed Feb 09 11:26:46 2022 -0800
committer GitHub <noreply@github.com> Wed Feb 09 11:26:46 2022 -0800
tree c8df4b545f5e17b3312b1341da52b57142950350
parent 3c2448108b431dd00d3a7033d9f43f19fa5d93d3
parent 679d6c3199027dd24aa30acc52b63cfbed7df1fa

Merge pull request #175 from dart-lang/move-escape

Move htmlSerializeEscape into its own library

CHANGELOG.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 60c7daf..6adaec5 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,5 +1,9 @@
 ## 0.15.1-dev
 
+- Move `htmlSerializeEscape` to its own library,
+  `package:html/html_escape.dart`, which is exported from
+  `package:html/dom_parsing.dart`.
+
 ## 0.15.0
 
 - Migrate to null safety.

lib/dom_parsing.dart

diff --git a/lib/dom_parsing.dart b/lib/dom_parsing.dart
index 142222e..973931b 100644
--- a/lib/dom_parsing.dart
+++ b/lib/dom_parsing.dart
@@ -3,8 +3,12 @@
 library dom_parsing;
 
 import 'dom.dart';
+import 'html_escape.dart';
 import 'src/constants.dart' show rcdataElements;
 
+// Export a function which was previously declared here.
+export 'html_escape.dart';
+
 /// A simple tree visitor for the DOM nodes.
 class TreeVisitor {
   void visit(Node node) {
@@ -116,58 +120,6 @@
   }
 }
 
-// TODO(jmesserly): reconcile this with dart:web htmlEscape.
-// This one might be more useful, as it is HTML5 spec compliant.
-/// Escapes [text] for use in the
-/// [HTML fragment serialization algorithm][1]. In particular, as described
-/// in the [specification][2]:
-///
-/// - Replace any occurrence of the `&` character by the string `&`.
-/// - Replace any occurrences of the U+00A0 NO-BREAK SPACE character by the
-///   string ` `.
-/// - If the algorithm was invoked in [attributeMode], replace any occurrences
-///   of the `"` character by the string `"`.
-/// - If the algorithm was not invoked in [attributeMode], replace any
-///   occurrences of the `<` character by the string `&lt;`, and any occurrences
-///   of the `>` character by the string `&gt;`.
-///
-/// [1]: http://www.whatwg.org/specs/web-apps/current-work/multipage/the-end.html#serializing-html-fragments
-/// [2]: http://www.whatwg.org/specs/web-apps/current-work/multipage/the-end.html#escapingString
-String htmlSerializeEscape(String text, {bool attributeMode = false}) {
-  // TODO(jmesserly): is it faster to build up a list of codepoints?
-  // StringBuffer seems cleaner assuming Dart can unbox 1-char strings.
-  StringBuffer? result;
-  for (var i = 0; i < text.length; i++) {
-    final ch = text[i];
-    String? replace;
-    switch (ch) {
-      case '&':
-        replace = '&amp;';
-        break;
-      case '\u00A0' /*NO-BREAK SPACE*/ :
-        replace = '&nbsp;';
-        break;
-      case '"':
-        if (attributeMode) replace = '&quot;';
-        break;
-      case '<':
-        if (!attributeMode) replace = '&lt;';
-        break;
-      case '>':
-        if (!attributeMode) replace = '&gt;';
-        break;
-    }
-    if (replace != null) {
-      result ??= StringBuffer(text.substring(0, i));
-      result.write(replace);
-    } else if (result != null) {
-      result.write(ch);
-    }
-  }
-
-  return result != null ? result.toString() : text;
-}
-
 /// Returns true if this tag name is a void element.
 /// This method is useful to a pretty printer, because void elements must not
 /// have an end tag.

lib/html_escape.dart

diff --git a/lib/html_escape.dart b/lib/html_escape.dart
new file mode 100644
index 0000000..b9c20c8
--- /dev/null
+++ b/lib/html_escape.dart
@@ -0,0 +1,51 @@
+// TODO(jmesserly): reconcile this with dart:web htmlEscape.
+// This one might be more useful, as it is HTML5 spec compliant.
+/// Escapes [text] for use in the
+/// [HTML fragment serialization algorithm][1]. In particular, as described
+/// in the [specification][2]:
+///
+/// - Replace any occurrence of the `&` character by the string `&`.
+/// - Replace any occurrences of the U+00A0 NO-BREAK SPACE character by the
+///   string ` `.
+/// - If the algorithm was invoked in [attributeMode], replace any occurrences
+///   of the `"` character by the string `"`.
+/// - If the algorithm was not invoked in [attributeMode], replace any
+///   occurrences of the `<` character by the string `&lt;`, and any occurrences
+///   of the `>` character by the string `&gt;`.
+///
+/// [1]: http://www.whatwg.org/specs/web-apps/current-work/multipage/the-end.html#serializing-html-fragments
+/// [2]: http://www.whatwg.org/specs/web-apps/current-work/multipage/the-end.html#escapingString
+String htmlSerializeEscape(String text, {bool attributeMode = false}) {
+  // TODO(jmesserly): is it faster to build up a list of codepoints?
+  // StringBuffer seems cleaner assuming Dart can unbox 1-char strings.
+  StringBuffer? result;
+  for (var i = 0; i < text.length; i++) {
+    final ch = text[i];
+    String? replace;
+    switch (ch) {
+      case '&':
+        replace = '&amp;';
+        break;
+      case '\u00A0' /*NO-BREAK SPACE*/ :
+        replace = '&nbsp;';
+        break;
+      case '"':
+        if (attributeMode) replace = '&quot;';
+        break;
+      case '<':
+        if (!attributeMode) replace = '&lt;';
+        break;
+      case '>':
+        if (!attributeMode) replace = '&gt;';
+        break;
+    }
+    if (replace != null) {
+      result ??= StringBuffer(text.substring(0, i));
+      result.write(replace);
+    } else if (result != null) {
+      result.write(ch);
+    }
+  }
+
+  return result != null ? result.toString() : text;
+}