Use xhp for html rendering

.github/workflows/build-and-test.yml

@@ -11,12 +11,12 @@ jobs:
       # Run tests on all OS's and HHVM versions, even if one fails
       fail-fast: false
       matrix:
-        os: [ ubuntu ]
+        os: [ ubuntu-20.04 ]
         hhvm:
           - '4.128'
-          - latest
-          - nightly
-    runs-on: ${{matrix.os}}-latest
+          - '4.153'
+          - '4.168'
+    runs-on: ${{matrix.os}}
     steps:
       - uses: actions/checkout@v2
       - name: Create branch for version alias

README.md

@@ -20,11 +20,6 @@ Originally, the Ruby GFM pipeline was the best fit; over time, we started to wan
 
 FBMarkdown exists to address all of these goals.
 
-## Requirements
-
-- HHVM 3.24 or above.
-- [hhvm-autoload](https://github.com/hhvm/hhvm-autoload)
-
 ## Installing FBMarkdown
 
     hhvm composer.phar require facebook/fbmarkdown
@@ -90,7 +85,8 @@ Extend `Facebook\Markdown\Inlines\Inline` or a subclass, and pass your classname
 
 There are then several approaches to rendering:
  - instantiate your subclass, and add support for it to a custom renderer
- - instantiate your subclass, and make it implement the `Facebook\Markdown\RenderableAsHTML` interface
+ - instantiate your subclass, and make it implement the `Facebook\Markdown\RenderableAsXHP` interface
+   - Failing that, try the `Facebook\Markdown\RenderableAsHTML` interface.
  - if it could be replaced with several existing inlines, return a
    `Facebook\Markdown\Inlines\InlineSequence`, then you won't need to extend the renderer.
 
@@ -101,7 +97,8 @@ to `$render_ctx->getBlockContext()->prependBlockTypes(...)`.
 
 There are then several approaches to rendering:
  - create a subclass of `Block`, and add support for it to a custom renderer
- - create a subclass of `Block`, and make it implement the `Facebook\Markdown\RenderableAsHTML` interface
+ - create a subclass of `Block`, and make it implement the `Facebook\Markdown\RenderableAsXHP` interface
+   - Failing that, try the `Facebook\Markdown\RenderableAsHTML` interface.
  - if it could be replaced with several existing blocks, return a
    `Facebook\Markdown\Blocks\BlockSequence`
  - if it could be replaced with a paragraph of inlines, return a `Facebook\Markdown\Blocks\InlineSequenceBlock`

composer.json

@@ -11,7 +11,8 @@
     },
     "require": {
         "hhvm": "^4.128",
-        "hhvm/type-assert": "^3.1|^4.0"
+        "hhvm/type-assert": "^3.1|^4.0",
+        "facebook/xhp-lib": "^4.1"
     },
     "require-dev": {
         "hhvm/hacktest": "^2.0",

hhast-lint.json

@@ -1,3 +1,11 @@
 {
-  "roots": [ "src/", "tests/" ]
-}
+  "roots": [
+    "src/",
+    "tests/"
+  ],
+  "builtinLinters": "all",
+  "disabledLinters": [
+    "Facebook\\HHAST\\FinalOrAbstractClassLinter",
+    "Facebook\\HHAST\\UseStatementWithAsLinter"
+  ]
+}

src/ParserContext.php

@@ -21,7 +21,7 @@ enum SourceType: int {
 
 final class ParserContext {
 
-  const keyset<string> DEFAULT_URI_SCHEME_ALLOW_LIST = keyset["http", "https", "irc", "mailto"];
+  const keyset<string> DEFAULT_URI_SCHEME_ALLOW_LIST = keyset['http', 'https', 'irc', 'mailto'];
   private BlockContext $blockContext;
   private InlineContext $inlineContext;
 

src/_Private/ChildValidationDisablerDisposable.php

@@ -0,0 +1,29 @@
+<?hh // strict
+/*
+ *  Copyright (c) 2004-present, Facebook, Inc.
+ *  All rights reserved.
+ *
+ *  This source code is licensed under the MIT license found in the
+ *  LICENSE file in the root directory of this source tree.
+ *
+ */
+
+namespace Facebook\Markdown\_Private;
+
+use namespace Facebook\XHP\ChildValidation;
+use type IDisposable;
+
+final class ChildValidationDisablerDisposable implements IDisposable {
+  private bool $shouldRestore;
+
+  public function __construct() {
+    $this->shouldRestore = ChildValidation\is_enabled();
+    ChildValidation\disable();
+  }
+
+  public function __dispose(): void {
+    if ($this->shouldRestore) {
+      ChildValidation\enable();
+    }
+  }
+}

src/_Private/EMBED_THIS_STRING_AS_IS_WITHOUT_ESCAPING_OR_FILTERING.php

@@ -0,0 +1,32 @@
+<?hh // strict
+/*
+ *  Copyright (c) 2004-present, Facebook, Inc.
+ *  All rights reserved.
+ *
+ *  This source code is licensed under the MIT license found in the
+ *  LICENSE file in the root directory of this source tree.
+ *
+ */
+
+namespace Facebook\Markdown\_Private;
+
+use namespace Facebook\XHP;
+use type Facebook\XHP\Core\frag;
+
+/**
+ * @see https://codebeforethehorse.tumblr.com/post/87306947716/converting-a-project-to-xhp
+ */
+// HHAST_IGNORE_ERROR[CamelCasedMethodsUnderscoredFunctions] intentionally SHOUT_CASE
+function EMBED_THIS_STRING_AS_IS_WITHOUT_ESCAPING_OR_FILTERING(
+  string $danger_danger_danger,
+): frag {
+  return <frag>{new POTENTIAL_XSS_HOLE($danger_danger_danger)}</frag>;
+}
+
+final class POTENTIAL_XSS_HOLE implements XHP\UnsafeRenderable {
+  public function __construct(private string $dangerDangerDanger) {}
+
+  public async function toHTMLStringAsync(): Awaitable<string> {
+    return $this->dangerDangerDanger;
+  }
+}

src/_Private/EscapedAttribute.php

@@ -0,0 +1,22 @@
+<?hh // strict
+/*
+ *  Copyright (c) 2004-present, Facebook, Inc.
+ *  All rights reserved.
+ *
+ *  This source code is licensed under the MIT license found in the
+ *  LICENSE file in the root directory of this source tree.
+ *
+ */
+
+namespace Facebook\Markdown\_Private;
+
+use namespace Facebook\XHP;
+
+final class EscapedAttribute extends XHP\UnsafeAttributeValue_DEPRECATED {
+  public function __construct(private string $dangerDangerDanger) {}
+
+  <<__Override>>
+  public function toHTMLString(): string {
+    return $this->dangerDangerDanger;
+  }
+}

src/_Private/URI_SAFE.php

@@ -0,0 +1,22 @@
+<?hh // strict
+/*
+ *  Copyright (c) 2004-present, Facebook, Inc.
+ *  All rights reserved.
+ *
+ *  This source code is licensed under the MIT license found in the
+ *  LICENSE file in the root directory of this source tree.
+ *
+ */
+
+namespace Facebook\Markdown\_Private;
+
+// This is the list from the reference implementation
+//hackfmt-ignore
+const keyset<string> URI_SAFE = keyset[
+  '-', '_', '.', '+', '!', '*', "'", '(', ')', ';', ':', '%', '#', '@', '?',
+  '=', ';', ':', '/', ',', '+', '&', '$',
+  'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h', 'i', 'j',
+  'k', 'l', 'm', 'n', 'o', 'p', 'q', 'r', 's', 't',
+  'u', 'v', 'w', 'x', 'y', 'z',
+  '1', '2', '3', '4', '5', '6', '7', '8', '9', '0',
+];

src/_Private/consume_link_title.php

@@ -43,7 +43,7 @@ function consume_quoted_link_title(string $input): ?(string, int) {
       break;
     }
 
-    if ($chr === "\\") {
+    if ($chr === '\\') {
       if ($idx + 1 < $len) {
         $next = $input[$idx + 1];
         if (C\contains_key(ASCII_PUNCTUATION, $next)) {
@@ -99,7 +99,7 @@ function consume_parenthesized_link_title(string $input): ?(string, int) {
       continue;
     }
 
-    if ($chr === "\\") {
+    if ($chr === '\\') {
       if ($idx + 1 < $len) {
         $next = $input[$idx + 1];
         if (C\contains_key(ASCII_PUNCTUATION, $next)) {

src/_Private/decode_html_entity.php

@@ -40,7 +40,7 @@ function decode_html_entity(string $string): ?(string, string, string) {
 
   $out = \html_entity_decode(
     $match,
-    /* HH_FIXME[4106] */ /* HH_FIXME[2049] */ \ENT_HTML5,
+    \ENT_HTML5,
     'UTF-8',
   );
   if ($out === $match) {

src/_Private/disable_child_validation.php

@@ -0,0 +1,18 @@
+<?hh // strict
+/*
+ *  Copyright (c) 2004-present, Facebook, Inc.
+ *  All rights reserved.
+ *
+ *  This source code is licensed under the MIT license found in the
+ *  LICENSE file in the root directory of this source tree.
+ *
+ */
+
+namespace Facebook\Markdown\_Private;
+
+use type IDisposable;
+
+<<__ReturnDisposable>>
+function disable_child_validation(): IDisposable {
+  return new ChildValidationDisablerDisposable();
+}

src/_Private/escape_uri_attribute.php

@@ -0,0 +1,33 @@
+<?hh // strict
+/*
+ *  Copyright (c) 2004-present, Facebook, Inc.
+ *  All rights reserved.
+ *
+ *  This source code is licensed under the MIT license found in the
+ *  LICENSE file in the root directory of this source tree.
+ *
+ */
+
+namespace Facebook\Markdown\_Private;
+
+use namespace HH\Lib\{C, Str};
+
+function escape_uri_attribute(string $uri): EscapedAttribute {
+  // While the spec states that no particular method is required, we attempt
+  // to match cmark's behavior so that we can run the spec test suite.
+  $uri = \html_entity_decode($uri, \ENT_HTML5, 'UTF-8');
+
+  $out = '';
+  $len = Str\length($uri);
+  for ($i = 0; $i < $len; ++$i) {
+    $char = $uri[$i];
+    if (C\contains_key(URI_SAFE, $char)) {
+      $out .= $char;
+      continue;
+    }
+    $out .= \urlencode($char);
+  }
+  $uri = $out;
+
+  return new EscapedAttribute(plain_text_to_html_attribute($uri));
+}

src/_Private/get_html_entity_table.php

@@ -17,7 +17,7 @@ function get_html_entity_table(): dict<string, string> {
   $file = __DIR__.'/../../third-party/entities.json';
   invariant(
     \file_exists($file),
-    "Expected %s to exist",
+    'Expected %s to exist',
     $file,
   );
   $data = \json_decode(

src/_Private/td_with_align.php

@@ -0,0 +1,30 @@
+<?hh // strict
+/*
+ *  Copyright (c) 2004-present, Facebook, Inc.
+ *  All rights reserved.
+ *
+ *  This source code is licensed under the MIT license found in the
+ *  LICENSE file in the root directory of this source tree.
+ *
+ */
+
+namespace Facebook\Markdown\_Private;
+
+use namespace Facebook\XHP\ChildValidation as XHPChild;
+use namespace Facebook\XHP\HTML\Category;
+use type Facebook\XHP\HTML\element;
+
+final xhp class td_with_align extends element implements Category\Sectioning {
+  use XHPChild\Validation;
+  attribute :Facebook:XHP:HTML:td,
+    string align;
+
+  <<__Override>>
+  protected static function getChildrenDeclaration(): XHPChild\Constraint {
+    return XHPChild\any_number_of(
+      XHPChild\any_of(XHPChild\pcdata(), XHPChild\of_type<Category\Flow>()),
+    );
+  }
+
+  protected string $tagName = 'td';
+}

src/_Private/th_with_align.php

@@ -0,0 +1,30 @@
+<?hh // strict
+/*
+ *  Copyright (c) 2004-present, Facebook, Inc.
+ *  All rights reserved.
+ *
+ *  This source code is licensed under the MIT license found in the
+ *  LICENSE file in the root directory of this source tree.
+ *
+ */
+
+namespace Facebook\Markdown\_Private;
+
+use namespace Facebook\XHP\ChildValidation as XHPChild;
+use namespace Facebook\XHP\HTML\Category;
+use type Facebook\XHP\HTML\element;
+
+final xhp class th_with_align extends element implements Category\Sectioning {
+  use XHPChild\Validation;
+  attribute :Facebook:XHP:HTML:th,
+    string align;
+
+  <<__Override>>
+  protected static function getChildrenDeclaration(): XHPChild\Constraint {
+    return XHPChild\any_number_of(
+      XHPChild\any_of(XHPChild\pcdata(), XHPChild\of_type<Category\Flow>()),
+    );
+  }
+
+  protected string $tagName = 'th';
+}

src/_Private/trim_node.php

@@ -0,0 +1,24 @@
+<?hh // strict
+/*
+ *  Copyright (c) 2004-present, Facebook, Inc.
+ *  All rights reserved.
+ *
+ *  This source code is licensed under the MIT license found in the
+ *  LICENSE file in the root directory of this source tree.
+ *
+ */
+
+namespace Facebook\Markdown\_Private;
+
+use namespace HH\Lib\{Str, Vec};
+use type Facebook\XHP\AlwaysValidChild;
+use type Facebook\XHP\Core\primitive;
+
+final xhp class trim_node extends primitive implements AlwaysValidChild {
+  <<__Override>>
+  public async function stringifyAsync(): Awaitable<string> {
+    return await Vec\map_async($this->getChildren(), static::renderChildAsync<>)
+      |> Str\join($$, '')
+      |> Str\trim($$);
+  }
+}