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

74 lines
1.6 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/Document.h>
LibMarkdown: Add LineIterator LineIterator wraps a vector's ConstIterator, to provide an iterator that can work on indented container blocks (like lists and blockquotes).
2021-09-19 14:14:18 -03:00
#include <LibMarkdown/LineIterator.h>
LibMarkdown: Implement introspection of the document tree
2021-09-10 16:36:29 -03:00
#include <LibMarkdown/Visitor.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 {
AK+Everywhere: Rename String to DeprecatedString We have a new, improved string type coming up in AK (OOM aware, no null state), and while it's going to use UTF-8, the name UTF8String is a mouthful - so let's free up the String name by renaming the existing class. Making the old one have an annoying name will hopefully also help with quick adoption :^)
2022-12-04 15:02:33 -03:00
DeprecatedString Document::render_to_html(StringView extra_head_contents) const
Libraries: Add LibMarkdown
2019-09-20 18:46:18 -03:00
{
StringBuilder builder;
LibMarkdown: Allow extra content to be inserted into HTML output's head This lets users supply custom styling and scripting, among other things.
2022-09-27 07:35:10 -03:00
builder.append(R"~~~(<!DOCTYPE html>
<html>
<head>
<style>
code { white-space: pre; }
</style>
)~~~"sv);
if (!extra_head_contents.is_empty())
builder.append(extra_head_contents);
builder.append(R"~~~(
</head>
<body>
)~~~"sv);
LibMarkdown: Emit properly formed HTML documents
2019-10-13 07:58:56 -03:00
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());
LibMarkdown: Allow extra content to be inserted into HTML output's head This lets users supply custom styling and scripting, among other things.
2022-09-27 07:35:10 -03:00
builder.append(R"~~~(
</body>
</html>)~~~"sv);
AK: Remove StringBuilder::build() in favor of to_deprecated_string() Having an alias function that only wraps another one is silly, and keeping the more obvious name should flush out more uses of deprecated strings. No behavior change.
2023-01-26 15:58:09 -03:00
return builder.to_deprecated_string();
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
}
AK+Everywhere: Rename String to DeprecatedString We have a new, improved string type coming up in AK (OOM aware, no null state), and while it's going to use UTF-8, the name UTF8String is a mouthful - so let's free up the String name by renaming the existing class. Making the old one have an annoying name will hopefully also help with quick adoption :^)
2022-12-04 15:02:33 -03:00
DeprecatedString Document::render_to_inline_html() const
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
{
LibMarkdown: Refactor Document's parser into ContainerBlock This will better allow us too do things like have Lists and blockquotes support multiple blocks.
2021-09-19 14:04:24 -03:00
return m_container->render_to_html();
Libraries: Add LibMarkdown
2019-09-20 18:46:18 -03:00
}
LibMarkdown: Convert render_to_terminal to String This commit converts render_to_terminal from DeprecatedString to return an ErrorOr<String>. This is to aid moving `man` away from DeprecatedString. I have opted not to convert render_to_html and render_to_inline_html for now to keep this commit as small as possible.
2023-06-13 12:15:13 -03:00
ErrorOr<String> Document::render_for_terminal(size_t view_width) const
Libraries: Add LibMarkdown
2019-09-20 18:46:18 -03:00
{
LibMarkdown: Render lines to terminal instead of a single string With this patch, the blocks in a markdown document render a vector of lines. These lines get concatenated in Document::render_to_terminal, so this does not change any external APIs of LibMarkdown. This change makes it possible to indent individual lines in the rendered markdown. So, rendering blockquotes in a similar way to code blocks :^)
2022-12-23 06:25:00 -03:00
StringBuilder builder;
for (auto& line : m_container->render_lines_for_terminal(view_width)) {
LibMarkdown: Convert render_to_terminal to String This commit converts render_to_terminal from DeprecatedString to return an ErrorOr<String>. This is to aid moving `man` away from DeprecatedString. I have opted not to convert render_to_html and render_to_inline_html for now to keep this commit as small as possible.
2023-06-13 12:15:13 -03:00
TRY(builder.try_append(line));
TRY(builder.try_append("\n"sv));
LibMarkdown: Render lines to terminal instead of a single string With this patch, the blocks in a markdown document render a vector of lines. These lines get concatenated in Document::render_to_terminal, so this does not change any external APIs of LibMarkdown. This change makes it possible to indent individual lines in the rendered markdown. So, rendering blockquotes in a similar way to code blocks :^)
2022-12-23 06:25:00 -03:00
}
LibMarkdown: Convert render_to_terminal to String This commit converts render_to_terminal from DeprecatedString to return an ErrorOr<String>. This is to aid moving `man` away from DeprecatedString. I have opted not to convert render_to_html and render_to_inline_html for now to keep this commit as small as possible.
2023-06-13 12:15:13 -03:00
return builder.to_string();
Libraries: Add LibMarkdown
2019-09-20 18:46:18 -03:00
}
LibMarkdown: Implement introspection of the document tree
2021-09-10 16:36:29 -03:00
RecursionDecision Document::walk(Visitor& visitor) const
{
RecursionDecision rd = visitor.visit(*this);
if (rd != RecursionDecision::Recurse)
return rd;
return m_container->walk(visitor);
}
Everywhere: Pass AK::StringView by value
2021-11-10 20:55:02 -03:00
OwnPtr<Document> Document::parse(StringView str)
Libraries: Add LibMarkdown
2019-09-20 18:46:18 -03:00
{
Everywhere: Run clang-format
2022-04-01 14:58:27 -03:00
Vector<StringView> const lines_vec = str.lines();
LibMarkdown: Add LineIterator LineIterator wraps a vector's ConstIterator, to provide an iterator that can work on indented container blocks (like lists and blockquotes).
2021-09-19 14:14:18 -03:00
LineIterator lines(lines_vec.begin());
LibMarkdown: Refactor Document's parser into ContainerBlock This will better allow us too do things like have Lists and blockquotes support multiple blocks.
2021-09-19 14:04:24 -03:00
return make<Document>(ContainerBlock::parse(lines));
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