92 lines
3.1 KiB
C
92 lines
3.1 KiB
C
|
/* ide-highlighter.h
|
||
|
|
*
|
||
|
|
* Copyright 2015-2019 Christian Hergert <christian@hergert.me>
|
||
|
|
*
|
||
|
|
* This program is free software: you can redistribute it and/or modify
|
||
|
|
* it under the terms of the GNU General Public License as published by
|
||
|
|
* the Free Software Foundation, either version 3 of the License, or
|
||
|
|
* (at your option) any later version.
|
||
|
|
*
|
||
|
|
* This program is distributed in the hope that it will be useful,
|
||
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
|
|
* GNU General Public License for more details.
|
||
|
|
*
|
||
|
|
* You should have received a copy of the GNU General Public License
|
||
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||
|
|
*
|
||
|
|
* SPDX-License-Identifier: GPL-3.0-or-later
|
||
|
|
*/
|
||
|
|
|
||
|
|
#pragma once
|
||
|
|
|
||
|
|
#if !defined (IDE_CODE_INSIDE) && !defined (IDE_CODE_COMPILATION)
|
||
|
|
# error "Only <libide-code.h> can be included directly."
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#include <gtk/gtk.h>
|
||
|
|
#include <libide-core.h>
|
||
|
|
|
||
|
|
#include "ide-code-types.h"
|
||
|
|
|
||
|
|
G_BEGIN_DECLS
|
||
|
|
|
||
|
|
#define IDE_TYPE_HIGHLIGHTER (ide_highlighter_get_type())
|
||
|
|
|
||
|
|
IDE_AVAILABLE_IN_3_32
|
||
|
|
G_DECLARE_INTERFACE (IdeHighlighter, ide_highlighter, IDE, HIGHLIGHTER, IdeObject)
|
||
|
|
|
||
|
|
typedef enum
|
||
|
|
{
|
||
|
|
IDE_HIGHLIGHT_STOP,
|
||
|
|
IDE_HIGHLIGHT_CONTINUE,
|
||
|
|
} IdeHighlightResult;
|
||
|
|
|
||
|
|
typedef IdeHighlightResult (*IdeHighlightCallback) (const GtkTextIter *begin,
|
||
|
|
const GtkTextIter *end,
|
||
|
|
const gchar *style_name);
|
||
|
|
|
||
|
|
struct _IdeHighlighterInterface
|
||
|
|
{
|
||
|
|
GTypeInterface parent_interface;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* IdeHighlighter::update:
|
||
|
|
*
|
||
|
|
* #IdeHighlighter should call callback() with the range and style-name of
|
||
|
|
* the style to apply. Callback will ensure that the style exists and style
|
||
|
|
* it appropriately based on the style scheme.
|
||
|
|
*
|
||
|
|
* If @callback returns %IDE_HIGHLIGHT_STOP, the caller has run out of its
|
||
|
|
* time slice and should yield back to the highlight engine.
|
||
|
|
*
|
||
|
|
* @location should be set to the position that the highlighter got to
|
||
|
|
* before yielding back to the engine.
|
||
|
|
*
|
||
|
|
* Since: 3.32
|
||
|
|
*/
|
||
|
|
void (*update) (IdeHighlighter *self,
|
||
|
|
IdeHighlightCallback callback,
|
||
|
|
const GtkTextIter *range_begin,
|
||
|
|
const GtkTextIter *range_end,
|
||
|
|
GtkTextIter *location);
|
||
|
|
|
||
|
|
void (*set_engine) (IdeHighlighter *self,
|
||
|
|
IdeHighlightEngine *engine);
|
||
|
|
|
||
|
|
void (*load) (IdeHighlighter *self);
|
||
|
|
};
|
||
|
|
|
||
|
|
IDE_AVAILABLE_IN_3_32
|
||
|
|
void ide_highlighter_load (IdeHighlighter *self);
|
||
|
|
IDE_AVAILABLE_IN_3_32
|
||
|
|
void ide_highlighter_update (IdeHighlighter *self,
|
||
|
|
IdeHighlightCallback callback,
|
||
|
|
const GtkTextIter *range_begin,
|
||
|
|
const GtkTextIter *range_end,
|
||
|
|
GtkTextIter *location);
|
||
|
|
void _ide_highlighter_set_highlighter_engine (IdeHighlighter *self,
|
||
|
|
IdeHighlightEngine *highlight_engine) G_GNUC_INTERNAL;
|
||
|
|
|
||
|
|
G_END_DECLS
|