94f5479e1a
Always start with full buffer lines and trim the display buffer at the very end, treat non-range display atoms as non-trimable in that case and keep track of how many columns are occupied by "widgets" such as line numbers or flags. Fixes #4659
107 lines
2.9 KiB
C++
107 lines
2.9 KiB
C++
#ifndef highlighter_hh_INCLUDED
|
|
#define highlighter_hh_INCLUDED
|
|
|
|
#include "coord.hh"
|
|
#include "completion.hh"
|
|
#include "display_buffer.hh"
|
|
#include "exception.hh"
|
|
#include "flags.hh"
|
|
#include "hash_map.hh"
|
|
#include "array_view.hh"
|
|
#include "string.hh"
|
|
#include "utils.hh"
|
|
#include "parameters_parser.hh"
|
|
|
|
#include <memory>
|
|
|
|
namespace Kakoune
|
|
{
|
|
|
|
class Context;
|
|
|
|
enum class HighlightPass
|
|
{
|
|
Wrap = 1 << 0,
|
|
Move = 1 << 1,
|
|
Colorize = 1 << 2,
|
|
|
|
All = Wrap | Move | Colorize,
|
|
};
|
|
constexpr bool with_bit_ops(Meta::Type<HighlightPass>) { return true; }
|
|
|
|
// A Highlighter is a function which mutates a DisplayBuffer in order to
|
|
// change the visual representation of a file. It could be changing text
|
|
// color, adding information text (line numbering for example) or replacing
|
|
// buffer content (folding for example)
|
|
|
|
struct Highlighter;
|
|
|
|
struct DisplaySetup
|
|
{
|
|
LineCount first_line;
|
|
LineCount line_count;
|
|
ColumnCount first_column;
|
|
ColumnCount widget_columns;
|
|
// Position of the cursor in the window
|
|
DisplayCoord cursor_pos;
|
|
// Offset of line and columns that must remain visible around cursor
|
|
DisplayCoord scroll_offset;
|
|
};
|
|
|
|
using HighlighterIdList = ConstArrayView<StringView>;
|
|
|
|
struct HighlightContext
|
|
{
|
|
const Context& context;
|
|
const DisplaySetup& setup;
|
|
HighlightPass pass;
|
|
HighlighterIdList disabled_ids;
|
|
};
|
|
|
|
struct Highlighter
|
|
{
|
|
Highlighter(HighlightPass passes) : m_passes{passes} {}
|
|
virtual ~Highlighter() = default;
|
|
|
|
void highlight(HighlightContext context, DisplayBuffer& display_buffer, BufferRange range);
|
|
void compute_display_setup(HighlightContext context, DisplaySetup& setup) const;
|
|
|
|
virtual bool has_children() const;
|
|
virtual Highlighter& get_child(StringView path);
|
|
virtual void add_child(String name, std::unique_ptr<Highlighter>&& hl, bool override = false);
|
|
virtual void remove_child(StringView id);
|
|
virtual Completions complete_child(StringView path, ByteCount cursor_pos, bool group) const;
|
|
virtual void fill_unique_ids(Vector<StringView>& unique_ids) const;
|
|
|
|
HighlightPass passes() const { return m_passes; }
|
|
|
|
private:
|
|
virtual void do_highlight(HighlightContext context, DisplayBuffer& display_buffer, BufferRange range) = 0;
|
|
virtual void do_compute_display_setup(HighlightContext context, DisplaySetup& setup) const {}
|
|
|
|
const HighlightPass m_passes;
|
|
};
|
|
|
|
using HighlighterParameters = ConstArrayView<String>;
|
|
using HighlighterFactory = std::unique_ptr<Highlighter> (*)(HighlighterParameters params, Highlighter* parent);
|
|
|
|
struct HighlighterDesc
|
|
{
|
|
const char* docstring;
|
|
ParameterDesc params;
|
|
};
|
|
|
|
struct HighlighterFactoryAndDescription
|
|
{
|
|
HighlighterFactory factory;
|
|
const HighlighterDesc* description;
|
|
};
|
|
|
|
struct HighlighterRegistry : HashMap<String, HighlighterFactoryAndDescription, MemoryDomain::Highlight>,
|
|
Singleton<HighlighterRegistry>
|
|
{};
|
|
|
|
}
|
|
|
|
#endif // highlighter_hh_INCLUDED
|