Stowage/ladybird
2
0
Fork 0
mirror of https://github.com/LadybirdBrowser/ladybird.git synced 2025-11-09 01:31:02 +00:00
Code Issues Projects Releases Packages Wiki Activity
ladybird/Userland/Libraries/LibMarkdown/Text.h

213 lines
7.1 KiB
C
Raw Normal View History

Meta: Add license header to source files As suggested by Joshua, this commit adds the 2-clause BSD license as a comment block to the top of every source file. For the first pass, I've just added myself for simplicity. I encourage everyone to add themselves as copyright holders of any file they've added or modified in some significant way. If I've added myself in error somewhere, feel free to replace it with the appropriate copyright holder instead. Going forward, all new source files should include a license header.
2020-01-18 09:38:21 +01:00
/*
Meta: Claim copyright for files created by me This changes copyright holder to myself for the source code files that I've created or have (almost) completely rewritten. Not included are the files that were significantly changed by others even though it was me who originally created them (think HtmlView), or the many other files I've contributed code to.
2020-01-24 16:45:29 +03:00
* Copyright (c) 2019-2020, Sergey Bugaev <bugaevc@serenityos.org>
LibMarkdown: Rewrite Inline text parser to be more forgiving The previous Text::parse was not able to give up on parsing a textual element, and just leave it as plain text. Because this is a very important part of markdown, I fully rewrote the parser to support this without having to backtrack. Also the parser now some other little features, such ast delimiter runs and flanking.
2021-09-06 19:11:46 -06:00
* Copyright (c) 2021, Peter Elliott <pelliott@serenityos.org>
Libraries: Use default constructors/destructors in LibMarkdown https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#cother-other-default-operation-rules "The compiler is more likely to get the default semantics right and you cannot implement these functions better than the compiler."
2022-03-04 13:21:26 -07:00
* Copyright (c) 2022, the SerenityOS developers.
Meta: Add license header to source files As suggested by Joshua, this commit adds the 2-clause BSD license as a comment block to the top of every source file. For the first pass, I've just added myself for simplicity. I encourage everyone to add themselves as copyright holders of any file they've added or modified in some significant way. If I've added myself in error somewhere, feel free to replace it with the appropriate copyright holder instead. Going forward, all new source files should include a license header.
2020-01-18 09:38:21 +01:00
*
Everything: Move to SPDX license identifiers in all files. SPDX License Identifiers are a more compact / standardized way of representing file license information. See: https://spdx.dev/resources/use/#identifiers This was done with the `ambr` search and replace tool. ambr --no-parent-ignore --key-from-file --rep-from-file key.txt rep.txt *
2021-04-22 01:24:48 -07:00
* SPDX-License-Identifier: BSD-2-Clause
Meta: Add license header to source files As suggested by Joshua, this commit adds the 2-clause BSD license as a comment block to the top of every source file. For the first pass, I've just added myself for simplicity. I encourage everyone to add themselves as copyright holders of any file they've added or modified in some significant way. If I've added myself in error somewhere, feel free to replace it with the appropriate copyright holder instead. Going forward, all new source files should include a license header.
2020-01-18 09:38:21 +01:00
*/
Libraries: Add LibMarkdown
2019-09-21 00:46:18 +03:00
#pragma once
Everywhere: Rename {Deprecated => Byte}String This commit un-deprecates DeprecatedString, and repurposes it as a byte string. As the null state has already been removed, there are no other particularly hairy blockers in repurposing this type as a byte string (what it _really_ is). This commit is auto-generated: $ xs=$(ack -l \bDeprecatedString\b\|deprecated_string AK Userland \ Meta Ports Ladybird Tests Kernel) $ perl -pie 's/\bDeprecatedString\b/ByteString/g; s/deprecated_string/byte_string/g' $xs $ clang-format --style=file -i \ $(git diff --name-only | grep \.cpp\|\.h) $ gn format $(git ls-files '*.gn' '*.gni')
2023-12-16 17:49:34 +03:30
#include <AK/ByteString.h>
LibMarkdown: Change internal MD API to return OwnPtrs Previously, all Markdown blocks had a virtual parse method which has been swapped out for a static parse method returning an OwnPtr of that block's type. The Text class also now has a static parse method that will return an Optional<Text>.
2020-05-18 16:58:00 -04:00
#include <AK/Noncopyable.h>
LibMarkdown: Rewrite Inline text parser to be more forgiving The previous Text::parse was not able to give up on parsing a textual element, and just leave it as plain text. Because this is a very important part of markdown, I fully rewrote the parser to support this without having to backtrack. Also the parser now some other little features, such ast delimiter runs and flanking.
2021-09-06 19:11:46 -06:00
#include <AK/OwnPtr.h>
LibMarkdown: Implement introspection of the document tree
2021-09-10 21:36:29 +02:00
#include <AK/RecursionDecision.h>
Everywhere: Remove NonnullOwnPtr.h includes
2023-03-06 17:39:59 +01:00
#include <AK/Vector.h>
LibMarkdown: Implement introspection of the document tree
2021-09-10 21:36:29 +02:00
#include <LibMarkdown/Forward.h>
Libraries: Add LibMarkdown
2019-09-21 00:46:18 +03:00
LibMarkdown: Drop MD prefixes and move into "Markdown" namespace :^)
2020-04-28 21:04:25 +02:00
namespace Markdown {
class Text final {
Libraries: Add LibMarkdown
2019-09-21 00:46:18 +03:00
public:
LibMarkdown: Rewrite Inline text parser to be more forgiving The previous Text::parse was not able to give up on parsing a textual element, and just leave it as plain text. Because this is a very important part of markdown, I fully rewrote the parser to support this without having to backtrack. Also the parser now some other little features, such ast delimiter runs and flanking.
2021-09-06 19:11:46 -06:00
class Node {
public:
virtual void render_to_html(StringBuilder& builder) const = 0;
virtual void render_for_terminal(StringBuilder& builder) const = 0;
LibMarkdown: Add render_for_raw_print methods to Node derived classes This method will be used by the package manager code to render an actual Port's name to raw text as it is stored as relative URL currently in the AvailablePorts.md file.
2023-07-20 14:43:39 +03:00
virtual void render_for_raw_print(StringBuilder& builder) const = 0;
LibMarkdown: Rewrite Inline text parser to be more forgiving The previous Text::parse was not able to give up on parsing a textual element, and just leave it as plain text. Because this is a very important part of markdown, I fully rewrote the parser to support this without having to backtrack. Also the parser now some other little features, such ast delimiter runs and flanking.
2021-09-06 19:11:46 -06:00
virtual size_t terminal_length() const = 0;
LibMarkdown: Implement introspection of the document tree
2021-09-10 21:36:29 +02:00
virtual RecursionDecision walk(Visitor&) const = 0;
LibMarkdown: Rewrite Inline text parser to be more forgiving The previous Text::parse was not able to give up on parsing a textual element, and just leave it as plain text. Because this is a very important part of markdown, I fully rewrote the parser to support this without having to backtrack. Also the parser now some other little features, such ast delimiter runs and flanking.
2021-09-06 19:11:46 -06:00
Libraries: Use default constructors/destructors in LibMarkdown https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#cother-other-default-operation-rules "The compiler is more likely to get the default semantics right and you cannot implement these functions better than the compiler."
2022-03-04 13:21:26 -07:00
virtual ~Node() = default;
LibMarkdown: Rewrite Inline text parser to be more forgiving The previous Text::parse was not able to give up on parsing a textual element, and just leave it as plain text. Because this is a very important part of markdown, I fully rewrote the parser to support this without having to backtrack. Also the parser now some other little features, such ast delimiter runs and flanking.
2021-09-06 19:11:46 -06:00
};
class EmphasisNode : public Node {
public:
bool strong;
NonnullOwnPtr<Node> child;
EmphasisNode(bool strong, NonnullOwnPtr<Node> child)
: strong(strong)
, child(move(child))
{
}
virtual void render_to_html(StringBuilder& builder) const override;
virtual void render_for_terminal(StringBuilder& builder) const override;
LibMarkdown: Add render_for_raw_print methods to Node derived classes This method will be used by the package manager code to render an actual Port's name to raw text as it is stored as relative URL currently in the AvailablePorts.md file.
2023-07-20 14:43:39 +03:00
virtual void render_for_raw_print(StringBuilder& builder) const override;
LibMarkdown: Rewrite Inline text parser to be more forgiving The previous Text::parse was not able to give up on parsing a textual element, and just leave it as plain text. Because this is a very important part of markdown, I fully rewrote the parser to support this without having to backtrack. Also the parser now some other little features, such ast delimiter runs and flanking.
2021-09-06 19:11:46 -06:00
virtual size_t terminal_length() const override;
LibMarkdown: Implement introspection of the document tree
2021-09-10 21:36:29 +02:00
virtual RecursionDecision walk(Visitor&) const override;
Libraries: Add LibMarkdown
2019-09-21 00:46:18 +03:00
};
LibMarkdown: Rewrite Inline text parser to be more forgiving The previous Text::parse was not able to give up on parsing a textual element, and just leave it as plain text. Because this is a very important part of markdown, I fully rewrote the parser to support this without having to backtrack. Also the parser now some other little features, such ast delimiter runs and flanking.
2021-09-06 19:11:46 -06:00
class CodeNode : public Node {
public:
NonnullOwnPtr<Node> code;
CodeNode(NonnullOwnPtr<Node> code)
: code(move(code))
{
}
virtual void render_to_html(StringBuilder& builder) const override;
virtual void render_for_terminal(StringBuilder& builder) const override;
LibMarkdown: Add render_for_raw_print methods to Node derived classes This method will be used by the package manager code to render an actual Port's name to raw text as it is stored as relative URL currently in the AvailablePorts.md file.
2023-07-20 14:43:39 +03:00
virtual void render_for_raw_print(StringBuilder& builder) const override;
LibMarkdown: Rewrite Inline text parser to be more forgiving The previous Text::parse was not able to give up on parsing a textual element, and just leave it as plain text. Because this is a very important part of markdown, I fully rewrote the parser to support this without having to backtrack. Also the parser now some other little features, such ast delimiter runs and flanking.
2021-09-06 19:11:46 -06:00
virtual size_t terminal_length() const override;
LibMarkdown: Implement introspection of the document tree
2021-09-10 21:36:29 +02:00
virtual RecursionDecision walk(Visitor&) const override;
LibMarkdown: Rewrite Inline text parser to be more forgiving The previous Text::parse was not able to give up on parsing a textual element, and just leave it as plain text. Because this is a very important part of markdown, I fully rewrote the parser to support this without having to backtrack. Also the parser now some other little features, such ast delimiter runs and flanking.
2021-09-06 19:11:46 -06:00
};
LibMarkdown: Implement hard and soft line breaks Hard line breaks insert a <br /> when two spaces are at the end of a line. soft line breaks are just regular newlines, but whitespace is now stripped before and after them
2021-09-10 00:45:45 -06:00
class BreakNode : public Node {
public:
virtual void render_to_html(StringBuilder& builder) const override;
virtual void render_for_terminal(StringBuilder& builder) const override;
LibMarkdown: Add render_for_raw_print methods to Node derived classes This method will be used by the package manager code to render an actual Port's name to raw text as it is stored as relative URL currently in the AvailablePorts.md file.
2023-07-20 14:43:39 +03:00
virtual void render_for_raw_print(StringBuilder& builder) const override;
LibMarkdown: Implement hard and soft line breaks Hard line breaks insert a <br /> when two spaces are at the end of a line. soft line breaks are just regular newlines, but whitespace is now stripped before and after them
2021-09-10 00:45:45 -06:00
virtual size_t terminal_length() const override;
LibMarkdown: Implement introspection of the document tree
2021-09-10 21:36:29 +02:00
virtual RecursionDecision walk(Visitor&) const override;
LibMarkdown: Implement hard and soft line breaks Hard line breaks insert a <br /> when two spaces are at the end of a line. soft line breaks are just regular newlines, but whitespace is now stripped before and after them
2021-09-10 00:45:45 -06:00
};
LibMarkdown: Rewrite Inline text parser to be more forgiving The previous Text::parse was not able to give up on parsing a textual element, and just leave it as plain text. Because this is a very important part of markdown, I fully rewrote the parser to support this without having to backtrack. Also the parser now some other little features, such ast delimiter runs and flanking.
2021-09-06 19:11:46 -06:00
class TextNode : public Node {
public:
Everywhere: Rename {Deprecated => Byte}String This commit un-deprecates DeprecatedString, and repurposes it as a byte string. As the null state has already been removed, there are no other particularly hairy blockers in repurposing this type as a byte string (what it _really_ is). This commit is auto-generated: $ xs=$(ack -l \bDeprecatedString\b\|deprecated_string AK Userland \ Meta Ports Ladybird Tests Kernel) $ perl -pie 's/\bDeprecatedString\b/ByteString/g; s/deprecated_string/byte_string/g' $xs $ clang-format --style=file -i \ $(git diff --name-only | grep \.cpp\|\.h) $ gn format $(git ls-files '*.gn' '*.gni')
2023-12-16 17:49:34 +03:30
ByteString text;
LibMarkdown: Render sequences of spaces properly in the terminal
2021-09-10 00:50:42 -06:00
bool collapsible;
LibMarkdown: Rewrite Inline text parser to be more forgiving The previous Text::parse was not able to give up on parsing a textual element, and just leave it as plain text. Because this is a very important part of markdown, I fully rewrote the parser to support this without having to backtrack. Also the parser now some other little features, such ast delimiter runs and flanking.
2021-09-06 19:11:46 -06:00
Everywhere: Pass AK::StringView by value
2021-11-11 00:55:02 +01:00
TextNode(StringView text)
LibMarkdown: Rewrite Inline text parser to be more forgiving The previous Text::parse was not able to give up on parsing a textual element, and just leave it as plain text. Because this is a very important part of markdown, I fully rewrote the parser to support this without having to backtrack. Also the parser now some other little features, such ast delimiter runs and flanking.
2021-09-06 19:11:46 -06:00
: text(text)
LibMarkdown: Render sequences of spaces properly in the terminal
2021-09-10 00:50:42 -06:00
, collapsible(true)
{
}
Everywhere: Pass AK::StringView by value
2021-11-11 00:55:02 +01:00
TextNode(StringView text, bool collapsible)
LibMarkdown: Render sequences of spaces properly in the terminal
2021-09-10 00:50:42 -06:00
: text(text)
, collapsible(collapsible)
LibMarkdown: Rewrite Inline text parser to be more forgiving The previous Text::parse was not able to give up on parsing a textual element, and just leave it as plain text. Because this is a very important part of markdown, I fully rewrote the parser to support this without having to backtrack. Also the parser now some other little features, such ast delimiter runs and flanking.
2021-09-06 19:11:46 -06:00
{
}
virtual void render_to_html(StringBuilder& builder) const override;
virtual void render_for_terminal(StringBuilder& builder) const override;
LibMarkdown: Add render_for_raw_print methods to Node derived classes This method will be used by the package manager code to render an actual Port's name to raw text as it is stored as relative URL currently in the AvailablePorts.md file.
2023-07-20 14:43:39 +03:00
virtual void render_for_raw_print(StringBuilder& builder) const override;
LibMarkdown: Rewrite Inline text parser to be more forgiving The previous Text::parse was not able to give up on parsing a textual element, and just leave it as plain text. Because this is a very important part of markdown, I fully rewrote the parser to support this without having to backtrack. Also the parser now some other little features, such ast delimiter runs and flanking.
2021-09-06 19:11:46 -06:00
virtual size_t terminal_length() const override;
LibMarkdown: Implement introspection of the document tree
2021-09-10 21:36:29 +02:00
virtual RecursionDecision walk(Visitor&) const override;
LibMarkdown: Rewrite Inline text parser to be more forgiving The previous Text::parse was not able to give up on parsing a textual element, and just leave it as plain text. Because this is a very important part of markdown, I fully rewrote the parser to support this without having to backtrack. Also the parser now some other little features, such ast delimiter runs and flanking.
2021-09-06 19:11:46 -06:00
};
class LinkNode : public Node {
public:
bool is_image;
NonnullOwnPtr<Node> text;
Everywhere: Rename {Deprecated => Byte}String This commit un-deprecates DeprecatedString, and repurposes it as a byte string. As the null state has already been removed, there are no other particularly hairy blockers in repurposing this type as a byte string (what it _really_ is). This commit is auto-generated: $ xs=$(ack -l \bDeprecatedString\b\|deprecated_string AK Userland \ Meta Ports Ladybird Tests Kernel) $ perl -pie 's/\bDeprecatedString\b/ByteString/g; s/deprecated_string/byte_string/g' $xs $ clang-format --style=file -i \ $(git diff --name-only | grep \.cpp\|\.h) $ gn format $(git ls-files '*.gn' '*.gni')
2023-12-16 17:49:34 +03:30
ByteString href;
LibMarkdown: Implement the image size extension This implements the image size extension that's quite commonly used: https://github.com/commonmark/commonmark-spec/wiki/Deployed-Extensions#image-size This supports specifying... Both width and height: ![](foo.png =100x200) Width only: ![](foo.png =100x) Height only: ![](foo.png =x200) The size is always in pixels (relative sizing does not seem to be spec'd anywhere).
2022-08-03 00:11:58 +01:00
Optional<int> image_width;
Optional<int> image_height;
LibMarkdown: Rewrite Inline text parser to be more forgiving The previous Text::parse was not able to give up on parsing a textual element, and just leave it as plain text. Because this is a very important part of markdown, I fully rewrote the parser to support this without having to backtrack. Also the parser now some other little features, such ast delimiter runs and flanking.
2021-09-06 19:11:46 -06:00
Everywhere: Rename {Deprecated => Byte}String This commit un-deprecates DeprecatedString, and repurposes it as a byte string. As the null state has already been removed, there are no other particularly hairy blockers in repurposing this type as a byte string (what it _really_ is). This commit is auto-generated: $ xs=$(ack -l \bDeprecatedString\b\|deprecated_string AK Userland \ Meta Ports Ladybird Tests Kernel) $ perl -pie 's/\bDeprecatedString\b/ByteString/g; s/deprecated_string/byte_string/g' $xs $ clang-format --style=file -i \ $(git diff --name-only | grep \.cpp\|\.h) $ gn format $(git ls-files '*.gn' '*.gni')
2023-12-16 17:49:34 +03:30
LinkNode(bool is_image, NonnullOwnPtr<Node> text, ByteString href, Optional<int> image_width, Optional<int> image_height)
LibMarkdown: Rewrite Inline text parser to be more forgiving The previous Text::parse was not able to give up on parsing a textual element, and just leave it as plain text. Because this is a very important part of markdown, I fully rewrote the parser to support this without having to backtrack. Also the parser now some other little features, such ast delimiter runs and flanking.
2021-09-06 19:11:46 -06:00
: is_image(is_image)
, text(move(text))
, href(move(href))
LibMarkdown: Implement the image size extension This implements the image size extension that's quite commonly used: https://github.com/commonmark/commonmark-spec/wiki/Deployed-Extensions#image-size This supports specifying... Both width and height: ![](foo.png =100x200) Width only: ![](foo.png =100x) Height only: ![](foo.png =x200) The size is always in pixels (relative sizing does not seem to be spec'd anywhere).
2022-08-03 00:11:58 +01:00
, image_width(image_width)
, image_height(image_height)
LibMarkdown: Rewrite Inline text parser to be more forgiving The previous Text::parse was not able to give up on parsing a textual element, and just leave it as plain text. Because this is a very important part of markdown, I fully rewrote the parser to support this without having to backtrack. Also the parser now some other little features, such ast delimiter runs and flanking.
2021-09-06 19:11:46 -06:00
{
}
LibMarkdown: Implement the image size extension This implements the image size extension that's quite commonly used: https://github.com/commonmark/commonmark-spec/wiki/Deployed-Extensions#image-size This supports specifying... Both width and height: ![](foo.png =100x200) Width only: ![](foo.png =100x) Height only: ![](foo.png =x200) The size is always in pixels (relative sizing does not seem to be spec'd anywhere).
2022-08-03 00:11:58 +01:00
bool has_image_dimensions() const
{
return image_width.has_value() || image_height.has_value();
}
LibMarkdown: Rewrite Inline text parser to be more forgiving The previous Text::parse was not able to give up on parsing a textual element, and just leave it as plain text. Because this is a very important part of markdown, I fully rewrote the parser to support this without having to backtrack. Also the parser now some other little features, such ast delimiter runs and flanking.
2021-09-06 19:11:46 -06:00
virtual void render_to_html(StringBuilder& builder) const override;
virtual void render_for_terminal(StringBuilder& builder) const override;
LibMarkdown: Add render_for_raw_print methods to Node derived classes This method will be used by the package manager code to render an actual Port's name to raw text as it is stored as relative URL currently in the AvailablePorts.md file.
2023-07-20 14:43:39 +03:00
virtual void render_for_raw_print(StringBuilder& builder) const override;
LibMarkdown: Rewrite Inline text parser to be more forgiving The previous Text::parse was not able to give up on parsing a textual element, and just leave it as plain text. Because this is a very important part of markdown, I fully rewrote the parser to support this without having to backtrack. Also the parser now some other little features, such ast delimiter runs and flanking.
2021-09-06 19:11:46 -06:00
virtual size_t terminal_length() const override;
LibMarkdown: Implement introspection of the document tree
2021-09-10 21:36:29 +02:00
virtual RecursionDecision walk(Visitor&) const override;
Libraries: Add LibMarkdown
2019-09-21 00:46:18 +03:00
};
LibMarkdown: Rewrite Inline text parser to be more forgiving The previous Text::parse was not able to give up on parsing a textual element, and just leave it as plain text. Because this is a very important part of markdown, I fully rewrote the parser to support this without having to backtrack. Also the parser now some other little features, such ast delimiter runs and flanking.
2021-09-06 19:11:46 -06:00
class MultiNode : public Node {
public:
Everywhere: Stop using NonnullOwnPtrVector Same as NonnullRefPtrVector: weird semantics, questionable benefits.
2023-03-06 17:16:25 +01:00
Vector<NonnullOwnPtr<Node>> children;
LibMarkdown: Make Text default-constructible and move-assignable
2020-09-20 16:43:19 +04:30
LibMarkdown: Rewrite Inline text parser to be more forgiving The previous Text::parse was not able to give up on parsing a textual element, and just leave it as plain text. Because this is a very important part of markdown, I fully rewrote the parser to support this without having to backtrack. Also the parser now some other little features, such ast delimiter runs and flanking.
2021-09-06 19:11:46 -06:00
virtual void render_to_html(StringBuilder& builder) const override;
virtual void render_for_terminal(StringBuilder& builder) const override;
LibMarkdown: Add render_for_raw_print methods to Node derived classes This method will be used by the package manager code to render an actual Port's name to raw text as it is stored as relative URL currently in the AvailablePorts.md file.
2023-07-20 14:43:39 +03:00
virtual void render_for_raw_print(StringBuilder& builder) const override;
LibMarkdown: Rewrite Inline text parser to be more forgiving The previous Text::parse was not able to give up on parsing a textual element, and just leave it as plain text. Because this is a very important part of markdown, I fully rewrote the parser to support this without having to backtrack. Also the parser now some other little features, such ast delimiter runs and flanking.
2021-09-06 19:11:46 -06:00
virtual size_t terminal_length() const override;
LibMarkdown: Implement introspection of the document tree
2021-09-10 21:36:29 +02:00
virtual RecursionDecision walk(Visitor&) const override;
LibMarkdown: Rewrite Inline text parser to be more forgiving The previous Text::parse was not able to give up on parsing a textual element, and just leave it as plain text. Because this is a very important part of markdown, I fully rewrote the parser to support this without having to backtrack. Also the parser now some other little features, such ast delimiter runs and flanking.
2021-09-06 19:11:46 -06:00
};
LibMarkdown: Change internal MD API to return OwnPtrs Previously, all Markdown blocks had a virtual parse method which has been swapped out for a static parse method returning an OwnPtr of that block's type. The Text class also now has a static parse method that will return an Optional<Text>.
2020-05-18 16:58:00 -04:00
LibMarkdown: Add strike-through text support to markdown Using ~~text~~ syntax will strike out the text between the two tildes. Only missing portion is the terminal rendering of strike through text. The ansi escape codes for strike through text are \e[9m and \e[29m but it appears the terminal does not support these. Please correct me if I am wrong. I tested that the render_to_terminal function was being called by giving it bold ANSI escape codes, and that did work so the function is being called correctly.
2022-04-26 21:34:29 -07:00
class StrikeThroughNode : public Node {
public:
NonnullOwnPtr<Node> striked_text;
StrikeThroughNode(NonnullOwnPtr<Node> striked_text)
: striked_text(move(striked_text))
{
}
virtual void render_to_html(StringBuilder& builder) const override;
virtual void render_for_terminal(StringBuilder& builder) const override;
LibMarkdown: Add render_for_raw_print methods to Node derived classes This method will be used by the package manager code to render an actual Port's name to raw text as it is stored as relative URL currently in the AvailablePorts.md file.
2023-07-20 14:43:39 +03:00
virtual void render_for_raw_print(StringBuilder& builder) const override;
LibMarkdown: Add strike-through text support to markdown Using ~~text~~ syntax will strike out the text between the two tildes. Only missing portion is the terminal rendering of strike through text. The ansi escape codes for strike through text are \e[9m and \e[29m but it appears the terminal does not support these. Please correct me if I am wrong. I tested that the render_to_terminal function was being called by giving it bold ANSI escape codes, and that did work so the function is being called correctly.
2022-04-26 21:34:29 -07:00
virtual size_t terminal_length() const override;
virtual RecursionDecision walk(Visitor&) const override;
};
LibMarkdown: Rewrite Inline text parser to be more forgiving The previous Text::parse was not able to give up on parsing a textual element, and just leave it as plain text. Because this is a very important part of markdown, I fully rewrote the parser to support this without having to backtrack. Also the parser now some other little features, such ast delimiter runs and flanking.
2021-09-06 19:11:46 -06:00
size_t terminal_length() const;
Libraries: Add LibMarkdown
2019-09-21 00:46:18 +03:00
Everywhere: Rename {Deprecated => Byte}String This commit un-deprecates DeprecatedString, and repurposes it as a byte string. As the null state has already been removed, there are no other particularly hairy blockers in repurposing this type as a byte string (what it _really_ is). This commit is auto-generated: $ xs=$(ack -l \bDeprecatedString\b\|deprecated_string AK Userland \ Meta Ports Ladybird Tests Kernel) $ perl -pie 's/\bDeprecatedString\b/ByteString/g; s/deprecated_string/byte_string/g' $xs $ clang-format --style=file -i \ $(git diff --name-only | grep \.cpp\|\.h) $ gn format $(git ls-files '*.gn' '*.gni')
2023-12-16 17:49:34 +03:30
ByteString render_to_html() const;
ByteString render_for_terminal() const;
ByteString render_for_raw_print() const;
LibMarkdown: Implement introspection of the document tree
2021-09-10 21:36:29 +02:00
RecursionDecision walk(Visitor&) const;
Libraries: Add LibMarkdown
2019-09-21 00:46:18 +03:00
Everywhere: Pass AK::StringView by value
2021-11-11 00:55:02 +01:00
static Text parse(StringView);
Libraries: Add LibMarkdown
2019-09-21 00:46:18 +03:00
private:
LibMarkdown: Rewrite Inline text parser to be more forgiving The previous Text::parse was not able to give up on parsing a textual element, and just leave it as plain text. Because this is a very important part of markdown, I fully rewrote the parser to support this without having to backtrack. Also the parser now some other little features, such ast delimiter runs and flanking.
2021-09-06 19:11:46 -06:00
struct Token {
Everywhere: Rename {Deprecated => Byte}String This commit un-deprecates DeprecatedString, and repurposes it as a byte string. As the null state has already been removed, there are no other particularly hairy blockers in repurposing this type as a byte string (what it _really_ is). This commit is auto-generated: $ xs=$(ack -l \bDeprecatedString\b\|deprecated_string AK Userland \ Meta Ports Ladybird Tests Kernel) $ perl -pie 's/\bDeprecatedString\b/ByteString/g; s/deprecated_string/byte_string/g' $xs $ clang-format --style=file -i \ $(git diff --name-only | grep \.cpp\|\.h) $ gn format $(git ls-files '*.gn' '*.gni')
2023-12-16 17:49:34 +03:30
ByteString data;
LibMarkdown: Rewrite Inline text parser to be more forgiving The previous Text::parse was not able to give up on parsing a textual element, and just leave it as plain text. Because this is a very important part of markdown, I fully rewrote the parser to support this without having to backtrack. Also the parser now some other little features, such ast delimiter runs and flanking.
2021-09-06 19:11:46 -06:00
// Flanking basically means that a delimiter run has a non-whitespace,
Libraries: Fix typos
2021-09-30 20:03:41 -04:00
// non-punctuation character on the corresponding side. For a more exact
LibMarkdown: Rewrite Inline text parser to be more forgiving The previous Text::parse was not able to give up on parsing a textual element, and just leave it as plain text. Because this is a very important part of markdown, I fully rewrote the parser to support this without having to backtrack. Also the parser now some other little features, such ast delimiter runs and flanking.
2021-09-06 19:11:46 -06:00
// definition, see the CommonMark spec.
bool left_flanking;
bool right_flanking;
LibMarkdown: Handle delimiter flanking with punctuation This patch handles the following two rules 1) A delimiter run is either (a) not followed by a Unicode punctuation character, or (b) followed by a Unicode punctuation character and preceded by Unicode whitespace or a Unicode punctuation character. 2) A _ can be used to open/close a delimiter run if it's (a) not part of a left-flanking delimiter run or (b) part of a left-flanking delimiter run followed by a Unicode punctuation character.
2021-09-09 23:22:07 -06:00
bool punct_before;
bool punct_after;
LibMarkdown: Rewrite Inline text parser to be more forgiving The previous Text::parse was not able to give up on parsing a textual element, and just leave it as plain text. Because this is a very important part of markdown, I fully rewrote the parser to support this without having to backtrack. Also the parser now some other little features, such ast delimiter runs and flanking.
2021-09-06 19:11:46 -06:00
// is_run indicates that this token is a 'delimiter run'. A delimiter
Everywhere: Fix spelling mistakes
2022-01-07 05:04:05 -07:00
// run occurs when several of the same syntactical character ('`', '_',
LibMarkdown: Rewrite Inline text parser to be more forgiving The previous Text::parse was not able to give up on parsing a textual element, and just leave it as plain text. Because this is a very important part of markdown, I fully rewrote the parser to support this without having to backtrack. Also the parser now some other little features, such ast delimiter runs and flanking.
2021-09-06 19:11:46 -06:00
// or '*') occur in a row.
bool is_run;
char run_char() const
{
VERIFY(is_run);
return data[0];
}
char run_length() const
{
VERIFY(is_run);
return data.length();
}
LibMarkdown: Implement hard and soft line breaks Hard line breaks insert a <br /> when two spaces are at the end of a line. soft line breaks are just regular newlines, but whitespace is now stripped before and after them
2021-09-10 00:45:45 -06:00
bool is_space() const
{
return data[0] == ' ';
}
Everywhere: Pass AK::StringView by value
2021-11-11 00:55:02 +01:00
bool operator==(StringView str) const { return str == data; }
LibMarkdown: Rewrite Inline text parser to be more forgiving The previous Text::parse was not able to give up on parsing a textual element, and just leave it as plain text. Because this is a very important part of markdown, I fully rewrote the parser to support this without having to backtrack. Also the parser now some other little features, such ast delimiter runs and flanking.
2021-09-06 19:11:46 -06:00
};
Everywhere: Pass AK::StringView by value
2021-11-11 00:55:02 +01:00
static Vector<Token> tokenize(StringView);
LibMarkdown: Rewrite Inline text parser to be more forgiving The previous Text::parse was not able to give up on parsing a textual element, and just leave it as plain text. Because this is a very important part of markdown, I fully rewrote the parser to support this without having to backtrack. Also the parser now some other little features, such ast delimiter runs and flanking.
2021-09-06 19:11:46 -06:00
static bool can_open(Token const& opening);
static bool can_close_for(Token const& opening, Token const& closing);
static NonnullOwnPtr<MultiNode> parse_sequence(Vector<Token>::ConstIterator& tokens, bool in_link);
LibMarkdown: Implement hard and soft line breaks Hard line breaks insert a <br /> when two spaces are at the end of a line. soft line breaks are just regular newlines, but whitespace is now stripped before and after them
2021-09-10 00:45:45 -06:00
static NonnullOwnPtr<Node> parse_break(Vector<Token>::ConstIterator& tokens);
static NonnullOwnPtr<Node> parse_newline(Vector<Token>::ConstIterator& tokens);
LibMarkdown: Rewrite Inline text parser to be more forgiving The previous Text::parse was not able to give up on parsing a textual element, and just leave it as plain text. Because this is a very important part of markdown, I fully rewrote the parser to support this without having to backtrack. Also the parser now some other little features, such ast delimiter runs and flanking.
2021-09-06 19:11:46 -06:00
static NonnullOwnPtr<Node> parse_emph(Vector<Token>::ConstIterator& tokens, bool in_link);
static NonnullOwnPtr<Node> parse_code(Vector<Token>::ConstIterator& tokens);
static NonnullOwnPtr<Node> parse_link(Vector<Token>::ConstIterator& tokens);
LibMarkdown: Add strike-through text support to markdown Using ~~text~~ syntax will strike out the text between the two tildes. Only missing portion is the terminal rendering of strike through text. The ansi escape codes for strike through text are \e[9m and \e[29m but it appears the terminal does not support these. Please correct me if I am wrong. I tested that the render_to_terminal function was being called by giving it bold ANSI escape codes, and that did work so the function is being called correctly.
2022-04-26 21:34:29 -07:00
static NonnullOwnPtr<Node> parse_strike_through(Vector<Token>::ConstIterator& tokens);
LibMarkdown: Change internal MD API to return OwnPtrs Previously, all Markdown blocks had a virtual parse method which has been swapped out for a static parse method returning an OwnPtr of that block's type. The Text class also now has a static parse method that will return an Optional<Text>.
2020-05-18 16:58:00 -04:00
LibMarkdown: Rewrite Inline text parser to be more forgiving The previous Text::parse was not able to give up on parsing a textual element, and just leave it as plain text. Because this is a very important part of markdown, I fully rewrote the parser to support this without having to backtrack. Also the parser now some other little features, such ast delimiter runs and flanking.
2021-09-06 19:11:46 -06:00
OwnPtr<Node> m_node;
Libraries: Add LibMarkdown
2019-09-21 00:46:18 +03:00
};
LibMarkdown: Drop MD prefixes and move into "Markdown" namespace :^)
2020-04-28 21:04:25 +02:00
}
Reference in a new issue Copy permalink