ladybird/Userland/Libraries/LibMarkdown/Paragraph.h

/*
 * Copyright (c) 2019-2020, Sergey Bugaev <bugaevc@serenityos.org>
 * Copyright (c) 2022, the SerenityOS developers.
 *
 * SPDX-License-Identifier: BSD-2-Clause
 */

#pragma once

#include <AK/OwnPtr.h>
#include <LibMarkdown/Block.h>
#include <LibMarkdown/Text.h>

namespace Markdown {

class Paragraph final : public Block {
public:
    Paragraph(Text text)
        : m_text(move(text))
    {
    }

    virtual ~Paragraph() override = default;

    virtual DeprecatedString render_to_html(bool tight = false) const override;
    virtual Vector<DeprecatedString> render_lines_for_terminal(size_t view_width = 0) const override;
    virtual RecursionDecision walk(Visitor&) const override;

private:
    Text m_text;
};

}
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 08:38:21 +00: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 13:45:29 +00:00			`* Copyright (c) 2019-2020, Sergey Bugaev <bugaevc@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 20:21:26 +00: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 08:38:21 +00: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 08:24:48 +00: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 08:38:21 +00:00			`*/`

Libraries: Add LibMarkdown 2019-09-20 21:46:18 +00:00			`#pragma once`

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 20:58:00 +00:00			`#include <AK/OwnPtr.h>`
LibMarkdown: Drop MD prefixes and move into "Markdown" namespace :^) 2020-04-28 19:04:25 +00:00			`#include <LibMarkdown/Block.h>`
			`#include <LibMarkdown/Text.h>`
Libraries: Add LibMarkdown 2019-09-20 21:46:18 +00:00
LibMarkdown: Drop MD prefixes and move into "Markdown" namespace :^) 2020-04-28 19:04:25 +00:00			`namespace Markdown {`

			`class Paragraph final : public Block {`
Libraries: Add LibMarkdown 2019-09-20 21:46:18 +00: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-07 01:11:46 +00:00			`Paragraph(Text text)`
			`: m_text(move(text))`
Meta+LibHTTP through LibWeb: Make clang-format-10 clean 2020-09-18 07:49:51 +00:00			`{`
			`}`
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 16:12:23 +00: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 20:21:26 +00:00			`virtual ~Paragraph() override = default;`
Libraries: Add LibMarkdown 2019-09-20 21:46:18 +00: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 18:02:33 +00:00			`virtual DeprecatedString render_to_html(bool tight = false) const override;`
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 09:25:00 +00:00			`virtual Vector<DeprecatedString> render_lines_for_terminal(size_t view_width = 0) const override;`
LibMarkdown: Implement introspection of the document tree 2021-09-10 19:36:29 +00:00			`virtual RecursionDecision walk(Visitor&) const override;`
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 16:12:23 +00:00
Libraries: Add LibMarkdown 2019-09-20 21:46:18 +00: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-07 01:11:46 +00:00			`Text m_text;`
Libraries: Add LibMarkdown 2019-09-20 21:46:18 +00:00			`};`
LibMarkdown: Drop MD prefixes and move into "Markdown" namespace :^) 2020-04-28 19:04:25 +00:00
			`}`