summaryrefslogtreecommitdiff
path: root/gtksourceview/gtksourcetag.c
blob: a1298068d6782970ab34e72c0352436004426baf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
/*
 * This file is part of GtkSourceView
 *
 * Copyright 2015 - Université Catholique de Louvain
 *
 * GtkSourceView is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * GtkSourceView 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, see <http://www.gnu.org/licenses/>.
 *
 * Author: Sébastien Wilmet
 */

#include "config.h"

#include "gtksourcetag.h"

/**
 * GtkSourceTag:
 * 
 * A tag that can be applied to text in a [class@Buffer].
 *
 * `GtkSourceTag` is a subclass of [class@Gtk.TextTag] that adds properties useful for
 * the GtkSourceView library.
 *
 * If, for a certain tag, [class@Gtk.TextTag] is sufficient, it's better that you create
 * a [class@Gtk.TextTag], not a [class@Tag].
 */

typedef struct
{
	guint draw_spaces : 1;
	guint draw_spaces_set : 1;
} GtkSourceTagPrivate;

enum
{
	PROP_0,
	PROP_DRAW_SPACES,
	PROP_DRAW_SPACES_SET,
	N_PROPS
};

G_DEFINE_TYPE_WITH_PRIVATE (GtkSourceTag, gtk_source_tag, GTK_TYPE_TEXT_TAG)

static GParamSpec *properties[N_PROPS];

static void
gtk_source_tag_get_property (GObject    *object,
                             guint       prop_id,
                             GValue     *value,
                             GParamSpec *pspec)
{
	GtkSourceTagPrivate *priv;

	priv = gtk_source_tag_get_instance_private (GTK_SOURCE_TAG (object));

	switch (prop_id)
	{
		case PROP_DRAW_SPACES:
			g_value_set_boolean (value, priv->draw_spaces);
			break;

		case PROP_DRAW_SPACES_SET:
			g_value_set_boolean (value, priv->draw_spaces_set);
			break;

		default:
			G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
			break;
	}
}

static void
gtk_source_tag_set_property (GObject      *object,
                             guint         prop_id,
                             const GValue *value,
                             GParamSpec   *pspec)
{
	GtkSourceTag *tag;
	GtkSourceTagPrivate *priv;
	gboolean size_changed = FALSE;

	tag = GTK_SOURCE_TAG (object);
	priv = gtk_source_tag_get_instance_private (tag);

	switch (prop_id)
	{
	case PROP_DRAW_SPACES:
		priv->draw_spaces = g_value_get_boolean (value);
		priv->draw_spaces_set = TRUE;
		g_object_notify_by_pspec (object,
		                          properties[PROP_DRAW_SPACES_SET]);
		break;

	case PROP_DRAW_SPACES_SET:
		priv->draw_spaces_set = g_value_get_boolean (value);
		break;

	default:
		G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
		break;
	}

	gtk_text_tag_changed (GTK_TEXT_TAG (tag), size_changed);
}

static void
gtk_source_tag_class_init (GtkSourceTagClass *klass)
{
	GObjectClass *object_class = G_OBJECT_CLASS (klass);

	object_class->get_property = gtk_source_tag_get_property;
	object_class->set_property = gtk_source_tag_set_property;

	/**
	 * GtkSourceTag:draw-spaces:
	 *
	 * Whether to draw white spaces. 
	 * 
	 * This property takes precedence over the value defined by the [class@SpaceDrawer]'s
	 * [property@SpaceDrawer:matrix] property (only where the tag is applied).
	 *
	 * Setting this property also changes [property@Tag:draw-spaces-set] to
	 * %TRUE.
	 */
	properties [PROP_DRAW_SPACES] =
		g_param_spec_boolean ("draw-spaces",
		                      "Draw Spaces",
		                      "",
		                      FALSE,
		                      (G_PARAM_READWRITE |
		                       G_PARAM_EXPLICIT_NOTIFY |
		                       G_PARAM_STATIC_STRINGS));

	/**
	 * GtkSourceTag:draw-spaces-set:
	 *
	 * Whether the [property@Tag:draw-spaces] property is set and must be
	 * taken into account.
	 */
	properties [PROP_DRAW_SPACES_SET] =
		g_param_spec_boolean ("draw-spaces-set",
		                      "Draw Spaces Set",
		                      "",
		                      FALSE,
		                      (G_PARAM_READWRITE |
		                       G_PARAM_EXPLICIT_NOTIFY |
		                       G_PARAM_STATIC_STRINGS));

	g_object_class_install_properties (object_class, N_PROPS, properties);
}

static void
gtk_source_tag_init (GtkSourceTag *tag)
{
}

/**
 * gtk_source_tag_new:
 * @name: (nullable): tag name, or %NULL.
 *
 * Creates a `GtkSourceTag`. 
 * 
 * Configure the tag using object arguments, i.e. using [method@GObject.Object.set].
 *
 * For usual cases, [method@Buffer.create_source_tag] is more convenient to
 * use.
 *
 * Returns: a new `GtkSourceTag`.
 */
GtkTextTag *
gtk_source_tag_new (const gchar *name)
{
	return g_object_new (GTK_SOURCE_TYPE_TAG,
			     "name", name,
			     NULL);
}