ladybird/Userland/Libraries/LibMarkdown/Block.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/RecursionDecision.h>
#include <AK/StringView.h>
#include <AK/Vector.h>
#include <LibMarkdown/Forward.h>

namespace Markdown {

class Block {
public:
    virtual ~Block() = default;

    virtual String render_to_html(bool tight = false) const = 0;
    virtual String render_for_terminal(size_t view_width = 0) const = 0;
    virtual RecursionDecision walk(Visitor&) const = 0;
};

}
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 11: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 16:45:29 +03: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 23:21:26 +03: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 11: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 11: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 11:38:21 +03:00			`*/`

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

LibMarkdown: Implement introspection of the document tree 2021-09-10 22:36:29 +03:00			`#include <AK/RecursionDecision.h>`
LibMarkdown: Drop MD prefixes and move into "Markdown" namespace :^) 2020-04-28 22:04:25 +03:00			`#include <AK/StringView.h>`
AK: Add a forward declaration header You can now #include <AK/Forward.h> to get most of the AK types as forward declarations. Header dependency explosion is one of the main contributors to compile times at the moment, so this is a step towards smaller include graphs. 2020-02-14 23:41:10 +03:00			`#include <AK/Vector.h>`
LibMarkdown: Implement introspection of the document tree 2021-09-10 22:36:29 +03: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 22:04:25 +03:00			`namespace Markdown {`

			`class Block {`
Libraries: Add LibMarkdown 2019-09-21 00:46:18 +03:00			`public:`
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 23:21:26 +03:00			`virtual ~Block() = default;`
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 10:12:00 +03:00			`virtual String render_to_html(bool tight = false) const = 0;`
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 15:11:04 +03:00			`virtual String render_for_terminal(size_t view_width = 0) const = 0;`
LibMarkdown: Implement introspection of the document tree 2021-09-10 22:36:29 +03:00			`virtual RecursionDecision walk(Visitor&) const = 0;`
Libraries: Add LibMarkdown 2019-09-21 00:46:18 +03:00			`};`
LibMarkdown: Drop MD prefixes and move into "Markdown" namespace :^) 2020-04-28 22:04:25 +03:00
			`}`