ladybird/Userland/Libraries/LibMarkdown/Paragraph.h

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

#pragma once

#include <AK/NonnullOwnPtrVector.h>
#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 { }

    virtual String render_to_html(bool tight = false) const override;
    virtual String render_for_terminal(size_t view_width = 0) 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 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>`
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`

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 20:42:23 +04:30			`#include <AK/NonnullOwnPtrVector.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/OwnPtr.h>`
LibMarkdown: Drop MD prefixes and move into "Markdown" namespace :^) 2020-04-28 21:04:25 +02:00			`#include <LibMarkdown/Block.h>`
			`#include <LibMarkdown/Text.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 Paragraph final : public Block {`
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			`Paragraph(Text text)`
			`: m_text(move(text))`
Meta+LibHTTP through LibWeb: Make clang-format-10 clean 2020-09-18 09:49:51 +02: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 20:42:23 +04:30
Meta+LibHTTP through LibWeb: Make clang-format-10 clean 2020-09-18 09:49:51 +02:00			`virtual ~Paragraph() override { }`
Libraries: Add LibMarkdown 2019-09-21 00:46:18 +03:00
LibMarkdown: Implement "tightness" for lists From the commonmark spec: A list is loose if any of its constituent list items are separated by blank lines, or if any of its constituent list items directly contain two block-level elements with a blank line between them. Otherwise a list is tight. (The difference in HTML output is that paragraphs in a loose list are wrapped in <p> tags, while paragraphs in a tight list are not.) 2021-09-28 01:12:00 -06:00			`virtual String render_to_html(bool tight = false) const override;`
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 16:41:04 +04:30			`virtual String render_for_terminal(size_t view_width = 0) 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 20:42:23 +04:30
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			`Text m_text;`
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
			`}`