jcs.org
Serenity Operating System
1/*
2 * Copyright (c) 2020, the SerenityOS developers.
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 *
8 * 1. Redistributions of source code must retain the above copyright notice, this
9 * list of conditions and the following disclaimer.
10 *
11 * 2. Redistributions in binary form must reproduce the above copyright notice,
12 * this list of conditions and the following disclaimer in the documentation
13 * and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
21 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
22 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
23 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 */
26
27#pragma once
28
29#include <AK/Noncopyable.h>
30#include <AK/WeakPtr.h>
31#include <LibGUI/TextDocument.h>
32#include <LibGfx/Palette.h>
33
34namespace GUI {
35
36enum class SyntaxLanguage {
37 PlainText,
38 Cpp,
39 Javascript
40};
41
42struct TextStyle {
43 Color color;
44 const Gfx::Font* font { nullptr };
45};
46
47class SyntaxHighlighter {
48 AK_MAKE_NONCOPYABLE(SyntaxHighlighter);
49 AK_MAKE_NONMOVABLE(SyntaxHighlighter);
50
51public:
52 virtual ~SyntaxHighlighter();
53
54 virtual SyntaxLanguage language() const = 0;
55 virtual void rehighlight(Gfx::Palette) = 0;
56 virtual void highlight_matching_token_pair();
57
58 virtual bool is_identifier(void*) const { return false; };
59 virtual bool is_navigatable(void*) const { return false; };
60
61 void attach(TextEditor& editor);
62 void detach();
63 void cursor_did_change();
64
65protected:
66 SyntaxHighlighter() {}
67
68 WeakPtr<TextEditor> m_editor;
69
70 struct MatchingTokenPair {
71 void* open;
72 void* close;
73 };
74
75 virtual Vector<MatchingTokenPair> matching_token_pairs() const = 0;
76 virtual bool token_types_equal(void*, void*) const = 0;
77
78 struct BuddySpan {
79 int index { -1 };
80 GUI::TextDocumentSpan span_backup;
81 };
82
83 bool m_has_brace_buddies { false };
84 BuddySpan m_brace_buddies[2];
85};
86
87}