dmaax/ladybird
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
ladybird/Userland/Libraries/LibMarkdown/Document.cpp

123 lines
3 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 05:38:21 -03: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 10: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 22:11:46 -03:00
* Copyright (c) 2021, Peter Elliott <pelliott@serenityos.org>
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 05:38:21 -03: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 05:24:48 -03: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 05:38:21 -03:00
*/
Libraries: Add LibMarkdown
2019-09-20 18:46:18 -03:00
#include <AK/StringBuilder.h>
LibMarkdown: Drop MD prefixes and move into "Markdown" namespace :^)
2020-04-28 16:04:25 -03:00
#include <LibMarkdown/CodeBlock.h>
#include <LibMarkdown/Document.h>
#include <LibMarkdown/Heading.h>
LibMarkdown: Parse horizontal rules A horizontal rule is generated by a line with three or more of these characters: '*', '-', '_'.
2021-01-01 22:39:18 -03:00
#include <LibMarkdown/HorizontalRule.h>
LibMarkdown: Drop MD prefixes and move into "Markdown" namespace :^)
2020-04-28 16:04:25 -03:00
#include <LibMarkdown/List.h>
#include <LibMarkdown/Paragraph.h>
LibMarkdown: Add support for Tables This adds support for GFM-like tables. The HTML rendering ignores the alignments and relative sizes, but the terminal view does not!
2020-09-20 09:14:03 -03:00
#include <LibMarkdown/Table.h>
Libraries: Add LibMarkdown
2019-09-20 18:46:18 -03:00
LibMarkdown: Drop MD prefixes and move into "Markdown" namespace :^)
2020-04-28 16:04:25 -03:00
namespace Markdown {
String Document::render_to_html() const
Libraries: Add LibMarkdown
2019-09-20 18:46:18 -03:00
{
StringBuilder builder;
LibMarkdown: Emit properly formed HTML documents
2019-10-13 07:58:56 -03:00
builder.append("<!DOCTYPE html>\n");
builder.append("<html>\n");
LibMarkdown: Replace inline styles in HTML with CSS in <head>
2020-10-31 15:11:44 -03:00
builder.append("<head>\n");
builder.append("<style>\n");
builder.append("code { white-space: pre; }\n");
builder.append("</style>\n");
builder.append("</head>\n");
LibMarkdown: Emit properly formed HTML documents
2019-10-13 07:58:56 -03:00
builder.append("<body>\n");
LibMarkdown: Add render_to_inline_html() to Document This api is useful when you want to render a markdown document to HTML, but you want to embed it in a existing html document.
2021-08-29 17:14:48 -03:00
builder.append(render_to_inline_html());
builder.append("</body>\n");
builder.append("</html>\n");
return builder.build();
}
String Document::render_to_inline_html() const
{
StringBuilder builder;
Libraries: Add LibMarkdown
2019-09-20 18:46:18 -03:00
for (auto& block : m_blocks) {
auto s = block.render_to_html();
builder.append(s);
}
return builder.build();
}
LibMarkdown: Take a 'view_width' argument for render_for_terminal() Some constructs will require the width of the terminal (or a general 'width') to be rendered correctly, such as tables.
2020-09-20 09:11:04 -03:00
String Document::render_for_terminal(size_t view_width) const
Libraries: Add LibMarkdown
2019-09-20 18:46:18 -03:00
{
StringBuilder builder;
for (auto& block : m_blocks) {
LibMarkdown: Take a 'view_width' argument for render_for_terminal() Some constructs will require the width of the terminal (or a general 'width') to be rendered correctly, such as tables.
2020-09-20 09:11:04 -03:00
auto s = block.render_for_terminal(view_width);
Libraries: Add LibMarkdown
2019-09-20 18:46:18 -03:00
builder.append(s);
}
return builder.build();
}
LibMarkdown: Drop MD prefixes and move into "Markdown" namespace :^)
2020-04-28 16:04:25 -03:00
template<typename BlockType>
static bool helper(Vector<StringView>::ConstIterator& lines, NonnullOwnPtrVector<Block>& blocks)
Libraries: Add LibMarkdown
2019-09-20 18:46:18 -03: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 17:58:00 -03:00
OwnPtr<BlockType> block = BlockType::parse(lines);
if (!block)
Libraries: Add LibMarkdown
2019-09-20 18:46:18 -03:00
return false;
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 17:58:00 -03:00
blocks.append(block.release_nonnull());
Libraries: Add LibMarkdown
2019-09-20 18:46:18 -03:00
return true;
}
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 17:58:00 -03:00
OwnPtr<Document> Document::parse(const StringView& str)
Libraries: Add LibMarkdown
2019-09-20 18:46:18 -03:00
{
LibMarkdown: Handle CRLF line endings Previously, MDDocument only split on Unix-style line endings. This adds a new function to StringView which handles LF, CR and CRLF.
2019-12-02 09:42:33 -03:00
const Vector<StringView> lines_vec = str.lines();
Libraries: Add LibMarkdown
2019-09-20 18:46:18 -03:00
auto lines = lines_vec.begin();
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 17:58:00 -03:00
auto document = make<Document>();
LibMarkdown: Change MD Document parse API to return a RefPtr Markdown documents are now obtained via the static Document::parse method, which returns a RefPtr<Document>, or nullptr on failure.
2020-05-11 14:55:31 -03:00
auto& blocks = document->m_blocks;
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 22:11:46 -03:00
StringBuilder paragraph_text;
Libraries: Add LibMarkdown
2019-09-20 18:46:18 -03:00
LibMarkdown: Flush the pending paragraphs when encountering empty lines Fixes #3854.
2020-10-25 22:52:07 -03:00
auto flush_paragraph = [&] {
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 22:11:46 -03:00
if (paragraph_text.is_empty())
LibMarkdown: Flush the pending paragraphs when encountering empty lines Fixes #3854.
2020-10-25 22:52:07 -03:00
return;
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 22:11:46 -03:00
auto paragraph = make<Paragraph>(Text::parse(paragraph_text.build()));
LibMarkdown: Flush the pending paragraphs when encountering empty lines Fixes #3854.
2020-10-25 22:52:07 -03:00
document->m_blocks.append(move(paragraph));
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 22:11:46 -03:00
paragraph_text.clear();
LibMarkdown: Flush the pending paragraphs when encountering empty lines Fixes #3854.
2020-10-25 22:52:07 -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 22:11:46 -03:00
Libraries: Add LibMarkdown
2019-09-20 18:46:18 -03:00
while (true) {
if (lines.is_end())
LibMarkdown: Change MD Document parse API to return a RefPtr Markdown documents are now obtained via the static Document::parse method, which returns a RefPtr<Document>, or nullptr on failure.
2020-05-11 14:55:31 -03:00
break;
Libraries: Add LibMarkdown
2019-09-20 18:46:18 -03:00
if ((*lines).is_empty()) {
++lines;
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 03:45:45 -03:00
LibMarkdown: Flush the pending paragraphs when encountering empty lines Fixes #3854.
2020-10-25 22:52:07 -03:00
flush_paragraph();
Libraries: Add LibMarkdown
2019-09-20 18:46:18 -03:00
continue;
}
LibMarkdown: Parse paragraphs line-wise This gets rid of the doubled-up checks in `Paragraph::parse()`, and makes a paragraph the last possible kind of block to be parsed.
2020-09-20 13:12:23 -03:00
bool any = helper<Table>(lines, blocks) || helper<List>(lines, blocks) || helper<CodeBlock>(lines, blocks)
LibMarkdown: Parse horizontal rules A horizontal rule is generated by a line with three or more of these characters: '*', '-', '_'.
2021-01-01 22:39:18 -03:00
|| helper<Heading>(lines, blocks) || helper<HorizontalRule>(lines, blocks);
LibMarkdown: Parse paragraphs line-wise This gets rid of the doubled-up checks in `Paragraph::parse()`, and makes a paragraph the last possible kind of block to be parsed.
2020-09-20 13:12:23 -03:00
if (any) {
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 22:11:46 -03:00
if (!paragraph_text.is_empty()) {
LibMarkdown: Parse paragraphs line-wise This gets rid of the doubled-up checks in `Paragraph::parse()`, and makes a paragraph the last possible kind of block to be parsed.
2020-09-20 13:12:23 -03:00
auto last_block = document->m_blocks.take_last();
LibMarkdown: Flush the pending paragraphs when encountering empty lines Fixes #3854.
2020-10-25 22:52:07 -03:00
flush_paragraph();
LibMarkdown: Parse paragraphs line-wise This gets rid of the doubled-up checks in `Paragraph::parse()`, and makes a paragraph the last possible kind of block to be parsed.
2020-09-20 13:12:23 -03:00
document->m_blocks.append(move(last_block));
}
continue;
}
Libraries: Add LibMarkdown
2019-09-20 18:46:18 -03: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 03:45:45 -03:00
if (!paragraph_text.is_empty())
paragraph_text.append("\n");
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 22:11:46 -03:00
paragraph_text.append(*lines++);
LibMarkdown: Parse paragraphs line-wise This gets rid of the doubled-up checks in `Paragraph::parse()`, and makes a paragraph the last possible kind of block to be parsed.
2020-09-20 13:12:23 -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 22:11:46 -03:00
flush_paragraph();
LibMarkdown: Change MD Document parse API to return a RefPtr Markdown documents are now obtained via the static Document::parse method, which returns a RefPtr<Document>, or nullptr on failure.
2020-05-11 14:55:31 -03:00
return document;
Libraries: Add LibMarkdown
2019-09-20 18:46:18 -03:00
}
LibMarkdown: Drop MD prefixes and move into "Markdown" namespace :^)
2020-04-28 16:04:25 -03:00
}
Reference in a new issue Copy permalink