1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 2010 Carlos Garnacho <carlosg@gnome.org>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
23 #include <gdk-pixbuf/gdk-pixbuf.h>
24 #include <cairo-gobject.h>
26 #include "gtkcssproviderprivate.h"
28 #include "gtkbitmaskprivate.h"
29 #include "gtkcssarrayvalueprivate.h"
30 #include "gtkcsskeyframesprivate.h"
31 #include "gtkcssparserprivate.h"
32 #include "gtkcsssectionprivate.h"
33 #include "gtkcssselectorprivate.h"
34 #include "gtkcssshorthandpropertyprivate.h"
35 #include "gtkcssstylefuncsprivate.h"
36 #include "gtksymboliccolor.h"
37 #include "gtkstyleprovider.h"
38 #include "gtkstylecontextprivate.h"
39 #include "gtkstylepropertiesprivate.h"
40 #include "gtkstylepropertyprivate.h"
41 #include "gtkstyleproviderprivate.h"
42 #include "gtkbindings.h"
43 #include "gtkmarshalers.h"
44 #include "gtkprivate.h"
48 * SECTION:gtkcssprovider
49 * @Short_description: CSS-like styling for widgets
50 * @Title: GtkCssProvider
51 * @See_also: #GtkStyleContext, #GtkStyleProvider
53 * GtkCssProvider is an object implementing the #GtkStyleProvider interface.
54 * It is able to parse <ulink url="http://www.w3.org/TR/CSS2">CSS</ulink>-like
55 * input in order to style widgets.
57 * <refsect2 id="gtkcssprovider-files">
58 * <title>Default files</title>
60 * An application can cause GTK+ to parse a specific CSS style sheet by
61 * calling gtk_css_provider_load_from_file() and adding the provider with
62 * gtk_style_context_add_provider() or gtk_style_context_add_provider_for_screen().
63 * In addition, certain files will be read when GTK+ is initialized. First,
64 * the file <filename><envar>$XDG_CONFIG_HOME</envar>/gtk-3.0/gtk.css</filename>
65 * is loaded if it exists. Then, GTK+ tries to load
66 * <filename><envar>$HOME</envar>/.themes/<replaceable>theme-name</replaceable>/gtk-3.0/gtk.css</filename>,
68 * <filename><replaceable>datadir</replaceable>/share/themes/<replaceable>theme-name</replaceable>/gtk-3.0/gtk.css</filename>,
69 * where <replaceable>theme-name</replaceable> is the name of the current theme
70 * (see the #GtkSettings:gtk-theme-name setting) and <replaceable>datadir</replaceable>
71 * is the prefix configured when GTK+ was compiled, unless overridden by the
72 * <envar>GTK_DATA_PREFIX</envar> environment variable.
75 * <refsect2 id="gtkcssprovider-stylesheets">
76 * <title>Style sheets</title>
78 * The basic structure of the style sheets understood by this provider is
79 * a series of statements, which are either rule sets or '@-rules', separated
83 * A rule set consists of a selector and a declaration block, which is
84 * a series of declarations enclosed in curly braces ({ and }). The
85 * declarations are separated by semicolons (;). Multiple selectors can
86 * share the same declaration block, by putting all the separators in
87 * front of the block, separated by commas.
89 * <example><title>A rule set with two selectors</title>
90 * <programlisting language="text">
91 * GtkButton, GtkEntry {
98 * <refsect2 id="gtkcssprovider-selectors">
99 * <title>Selectors</title>
101 * Selectors work very similar to the way they do in CSS, with widget class
102 * names taking the role of element names, and widget names taking the role
103 * of IDs. When used in a selector, widget names must be prefixed with a
104 * '#' character. The '*' character represents the so-called universal
105 * selector, which matches any widget.
108 * To express more complicated situations, selectors can be combined in
111 * <listitem><para>To require that a widget satisfies several conditions,
112 * combine several selectors into one by concatenating them. E.g.
113 * <literal>GtkButton#button1</literal> matches a GtkButton widget
114 * with the name button1.</para></listitem>
115 * <listitem><para>To only match a widget when it occurs inside some other
116 * widget, write the two selectors after each other, separated by whitespace.
117 * E.g. <literal>GtkToolBar GtkButton</literal> matches GtkButton widgets
118 * that occur inside a GtkToolBar.</para></listitem>
119 * <listitem><para>In the previous example, the GtkButton is matched even
120 * if it occurs deeply nested inside the toolbar. To restrict the match
121 * to direct children of the parent widget, insert a '>' character between
122 * the two selectors. E.g. <literal>GtkNotebook > GtkLabel</literal> matches
123 * GtkLabel widgets that are direct children of a GtkNotebook.</para></listitem>
127 * <title>Widget classes and names in selectors</title>
128 * <programlisting language="text">
129 * /* Theme labels that are descendants of a window */
130 * GtkWindow GtkLabel {
131 * background-color: #898989
134 * /* Theme notebooks, and anything that's within these */
136 * background-color: #a939f0
139 * /* Theme combo boxes, and entries that
140 * are direct children of a notebook */
142 * GtkNotebook > GtkEntry {
144 * background-color: #1209a2
147 * /* Theme any widget within a GtkBin */
152 * /* Theme a label named title-label */
153 * GtkLabel#title-label {
157 * /* Theme any widget named main-entry */
159 * background-color: #f0a810
164 * Widgets may also define style classes, which can be used for matching.
165 * When used in a selector, style classes must be prefixed with a '.'
169 * Refer to the documentation of individual widgets to learn which
170 * style classes they define and see <xref linkend="gtkstylecontext-classes"/>
171 * for a list of all style classes used by GTK+ widgets.
174 * Note that there is some ambiguity in the selector syntax when it comes
175 * to differentiation widget class names from regions. GTK+ currently treats
176 * a string as a widget class name if it contains any uppercase characters
177 * (which should work for more widgets with names like GtkLabel).
180 * <title>Style classes in selectors</title>
181 * <programlisting language="text">
182 * /* Theme all widgets defining the class entry */
184 * color: #39f1f9;
187 * /* Theme spinbuttons' entry */
188 * GtkSpinButton.entry {
194 * In complicated widgets like e.g. a GtkNotebook, it may be desirable
195 * to style different parts of the widget differently. To make this
196 * possible, container widgets may define regions, whose names
197 * may be used for matching in selectors.
200 * Some containers allow to further differentiate between regions by
201 * applying so-called pseudo-classes to the region. For example, the
202 * tab region in GtkNotebook allows to single out the first or last
203 * tab by using the :first-child or :last-child pseudo-class.
204 * When used in selectors, pseudo-classes must be prefixed with a
208 * Refer to the documentation of individual widgets to learn which
209 * regions and pseudo-classes they define and see
210 * <xref linkend="gtkstylecontext-classes"/> for a list of all regions
211 * used by GTK+ widgets.
214 * <title>Regions in selectors</title>
215 * <programlisting language="text">
216 * /* Theme any label within a notebook */
217 * GtkNotebook GtkLabel {
218 * color: #f90192;
221 * /* Theme labels within notebook tabs */
222 * GtkNotebook tab GtkLabel {
223 * color: #703910;
226 * /* Theme labels in the any first notebook
227 * tab, both selectors are equivalent */
228 * GtkNotebook tab:nth-child(first) GtkLabel,
229 * GtkNotebook tab:first-child GtkLabel {
230 * color: #89d012;
235 * Another use of pseudo-classes is to match widgets depending on their
236 * state. This is conceptually similar to the :hover, :active or :focus
237 * pseudo-classes in CSS. The available pseudo-classes for widget states
238 * are :active, :prelight (or :hover), :insensitive, :selected, :focused
242 * <title>Styling specific widget states</title>
243 * <programlisting language="text">
244 * /* Theme active (pressed) buttons */
246 * background-color: #0274d9;
249 * /* Theme buttons with the mouse pointer on it,
250 * both are equivalent */
252 * GtkButton:prelight {
253 * background-color: #3085a9;
256 * /* Theme insensitive widgets, both are equivalent */
259 * background-color: #320a91;
262 * /* Theme selection colors in entries */
263 * GtkEntry:selected {
264 * background-color: #56f9a0;
267 * /* Theme focused labels */
269 * background-color: #b4940f;
272 * /* Theme inconsistent checkbuttons */
273 * GtkCheckButton:inconsistent {
274 * background-color: #20395a;
279 * Widget state pseudoclasses may only apply to the last element
283 * To determine the effective style for a widget, all the matching rule
284 * sets are merged. As in CSS, rules apply by specificity, so the rules
285 * whose selectors more closely match a widget path will take precedence
289 * <refsect2 id="gtkcssprovider-rules">
290 * <title>@ Rules</title>
292 * GTK+'s CSS supports the @import rule, in order to load another
293 * CSS style sheet in addition to the currently parsed one.
296 * <title>Using the @import rule</title>
297 * <programlisting language="text">
298 * @import url ("path/to/common.css");
301 * <para id="css-binding-set">
302 * In order to extend key bindings affecting different widgets, GTK+
303 * supports the @binding-set rule to parse a set of bind/unbind
304 * directives, see #GtkBindingSet for the supported syntax. Note that
305 * the binding sets defined in this way must be associated with rule sets
306 * by setting the gtk-key-bindings style property.
309 * Customized key bindings are typically defined in a separate
310 * <filename>gtk-keys.css</filename> CSS file and GTK+ loads this file
311 * according to the current key theme, which is defined by the
312 * #GtkSettings:gtk-key-theme-name setting.
315 * <title>Using the @binding rule</title>
316 * <programlisting language="text">
317 * @binding-set binding-set1 {
318 * bind "<alt>Left" { "move-cursor" (visual-positions, -3, 0) };
322 * @binding-set binding-set2 {
323 * bind "<alt>Right" { "move-cursor" (visual-positions, 3, 0) };
324 * bind "<alt>KP_space" { "delete-from-cursor" (whitespace, 1)
325 * "insert-at-cursor" (" ") };
329 * gtk-key-bindings: binding-set1, binding-set2;
334 * GTK+ also supports an additional @define-color rule, in order
335 * to define a color name which may be used instead of color numeric
336 * representations. Also see the #GtkSettings:gtk-color-scheme setting
337 * for a way to override the values of these named colors.
340 * <title>Defining colors</title>
341 * <programlisting language="text">
342 * @define-color bg_color #f9a039;
345 * background-color: @bg_color;
350 * <refsect2 id="gtkcssprovider-symbolic-colors">
351 * <title>Symbolic colors</title>
353 * Besides being able to define color names, the CSS parser is also able
354 * to read different color expressions, which can also be nested, providing
355 * a rich language to define colors which are derived from a set of base
359 * <title>Using symbolic colors</title>
360 * <programlisting language="text">
361 * @define-color entry-color shade (@bg_color, 0.7);
364 * background-color: @entry-color;
368 * background-color: mix (@entry-color,
369 * shade (#fff, 0.5),
375 * The various ways to express colors in GTK+ CSS are:
381 * <entry>Syntax</entry>
382 * <entry>Explanation</entry>
383 * <entry>Examples</entry>
388 * <entry>rgb(@r, @g, @b)</entry>
389 * <entry>An opaque color; @r, @g, @b can be either integers between
390 * 0 and 255 or percentages</entry>
391 * <entry><literallayout>rgb(128, 10, 54)
392 * rgb(20%, 30%, 0%)</literallayout></entry>
395 * <entry>rgba(@r, @g, @b, @a)</entry>
396 * <entry>A translucent color; @r, @g, @b are as in the previous row,
397 * @a is a floating point number between 0 and 1</entry>
398 * <entry><literallayout>rgba(255, 255, 0, 0.5)</literallayout></entry>
401 * <entry>#@xxyyzz</entry>
402 * <entry>An opaque color; @xx, @yy, @zz are hexadecimal numbers
403 * specifying @r, @g, @b variants with between 1 and 4
404 * hexadecimal digits per component are allowed</entry>
405 * <entry><literallayout>#ff12ab
406 * #f0c</literallayout></entry>
409 * <entry>@name</entry>
410 * <entry>Reference to a color that has been defined with
411 * @define-color
413 * <entry>@bg_color</entry>
416 * <entry>mix(@color1, @color2, @f)</entry>
417 * <entry>A linear combination of @color1 and @color2. @f is a
418 * floating point number between 0 and 1.</entry>
419 * <entry><literallayout>mix(#ff1e0a, @bg_color, 0.8)</literallayout></entry>
422 * <entry>shade(@color, @f)</entry>
423 * <entry>A lighter or darker variant of @color. @f is a
424 * floating point number.
426 * <entry>shade(@fg_color, 0.5)</entry>
429 * <entry>lighter(@color)</entry>
430 * <entry>A lighter variant of @color</entry>
433 * <entry>darker(@color)</entry>
434 * <entry>A darker variant of @color</entry>
437 * <entry>alpha(@color, @f)</entry>
438 * <entry>Modifies passed color's alpha by a factor @f. @f is a
439 * floating point number. @f < 1.0 results in a more transparent
440 * color while @f > 1.0 results in a more opaque color.
442 * <entry>alhpa(blue, 0.5)</entry>
448 * <refsect2 id="gtkcssprovider-gradients">
449 * <title>Gradients</title>
451 * Linear or radial Gradients can be used as background images.
454 * A linear gradient along the line from (@start_x, @start_y) to
455 * (@end_x, @end_y) is specified using the syntax
456 * <literallayout>-gtk-gradient (linear,
457 * @start_x @start_y, @end_x @end_y,
458 * color-stop (@position, @color),
459 * ...)</literallayout>
460 * where @start_x and @end_x can be either a floating point number between
461 * 0 and 1 or one of the special values 'left', 'right' or 'center', @start_y
462 * and @end_y can be either a floating point number between 0 and 1 or one
463 * of the special values 'top', 'bottom' or 'center', @position is a floating
464 * point number between 0 and 1 and @color is a color expression (see above).
465 * The color-stop can be repeated multiple times to add more than one color
466 * stop. 'from (@color)' and 'to (@color)' can be used as abbreviations for
467 * color stops with position 0 and 1, respectively.
470 * <title>A linear gradient</title>
471 * <inlinegraphic fileref="gradient1.png" format="PNG"/>
472 * <para>This gradient was specified with
473 * <literallayout>-gtk-gradient (linear,
474 * left top, right bottom,
475 * from(@yellow), to(@blue))</literallayout></para>
478 * <title>Another linear gradient</title>
479 * <inlinegraphic fileref="gradient2.png" format="PNG"/>
480 * <para>This gradient was specified with
481 * <literallayout>-gtk-gradient (linear,
483 * color-stop(0, @yellow),
484 * color-stop(0.2, @blue),
485 * color-stop(1, #0f0))</literallayout></para>
488 * A radial gradient along the two circles defined by (@start_x, @start_y,
489 * @start_radius) and (@end_x, @end_y, @end_radius) is specified using the
491 * <literallayout>-gtk-gradient (radial,
492 * @start_x @start_y, @start_radius,
493 * @end_x @end_y, @end_radius,
494 * color-stop (@position, @color),
495 * ...)</literallayout>
496 * where @start_radius and @end_radius are floating point numbers and
497 * the other parameters are as before.
500 * <title>A radial gradient</title>
501 * <inlinegraphic fileref="gradient3.png" format="PNG"/>
502 * <para>This gradient was specified with
503 * <literallayout>-gtk-gradient (radial,
506 * from(@yellow), to(@green))</literallayout></para>
509 * <title>Another radial gradient</title>
510 * <inlinegraphic fileref="gradient4.png" format="PNG"/>
511 * <para>This gradient was specified with
512 * <literallayout>-gtk-gradient (radial,
515 * color-stop (0, #f00),
516 * color-stop (0.1, #a0f),
517 * color-stop (0.2, @yellow),
518 * color-stop (1, @green))</literallayout></para>
521 * <refsect2 id="gtkcssprovider-shadows">
522 * <title>Text shadow</title>
524 * A shadow list can be applied to text or symbolic icons, using the CSS3
525 * text-shadow syntax, as defined in
526 * <ulink url="http://www.w3.org/TR/css3-text/#text-shadow">the CSS3 specification</ulink>.
529 * A text shadow is specified using the syntax
530 * <literallayout>text-shadow: @horizontal_offset @vertical_offset [ @blur_radius ] @color</literallayout>
531 * The offset of the shadow is specified with the @horizontal_offset and @vertical_offset
532 * parameters. The optional blur radius is parsed, but it is currently not rendered by
533 * the GTK+ theming engine.
536 * To set multiple shadows on an element, you can specify a comma-separated list
537 * of shadow elements in the text-shadow property. Shadows are always rendered
538 * front-back, i.e. the first shadow specified is on top of the others. Shadows
539 * can thus overlay each other, but they can never overlay the text itself,
540 * which is always rendered on top of the shadow layer.
544 * <title>Box shadow</title>
546 * Themes can apply shadows on framed elements using the CSS3 box-shadow syntax,
548 * <ulink url="http://www.w3.org/TR/css3-background/#the-box-shadow">the CSS3 specification</ulink>.
551 * A box shadow is specified using the syntax
552 * <literallayout>box-shadow: [ @inset ] @horizontal_offset @vertical_offset [ @blur_radius ] [ @spread ] @color</literallayout>
553 * A positive offset will draw a shadow that is offset to the right (down) of the box,
554 * a negative offset to the left (top). The optional spread parameter defines an additional
555 * distance to expand the shadow shape in all directions, by the specified radius.
556 * The optional blur radius parameter is parsed, but it is currently not rendered by
557 * the GTK+ theming engine.
558 * The inset parameter defines whether the drop shadow should be rendered inside or outside
559 * the box canvas. Only inset box-shadows are currently supported by the GTK+ theming engine,
560 * non-inset elements are currently ignored.
563 * To set multiple box-shadows on an element, you can specify a comma-separated list
564 * of shadow elements in the box-shadow property. Shadows are always rendered
565 * front-back, i.e. the first shadow specified is on top of the others, so they may
566 * overlap other boxes or other shadows.
569 * <refsect2 id="gtkcssprovider-border-image">
570 * <title>Border images</title>
572 * Images and gradients can also be used in slices for the purpose of creating
574 * For more information, see the CSS3 documentation for the border-image property,
575 * which can be found <ulink url="http://www.w3.org/TR/css3-background/#border-images">here</ulink>.
577 * <inlinegraphic fileref="slices.png" format="PNG"/>
579 * The parameters of the slicing process are controlled by
580 * four separate properties. Note that you can use the
581 * <literallayout>border-image</literallayout> shorthand property
582 * to set values for the three properties at the same time.
585 * <literallayout>border-image-source: url(@path)
586 * (or border-image-source: -gtk-gradient(...))</literallayout>:
587 * Specifies the source of the border image, and it can either
588 * be an URL or a gradient (see above).
591 * <literallayout>border-image-slice: @top @right @bottom @left</literallayout>
592 * The sizes specified by the @top, @right, @bottom and @left parameters
593 * are the offsets, in pixels, from the relevant edge where the image
594 * should be "cut off" to build the slices used for the rendering
598 * <literallayout>border-image-width: @top @right @bottom @left</literallayout>
599 * The sizes specified by the @top, @right, @bottom and @left parameters
600 * are inward distances from the border box edge, used to specify the
601 * rendered size of each slice determined by border-image-slice.
602 * If this property is not specified, the values of border-width will
603 * be used as a fallback.
606 * <literallayout>border-image-repeat: [stretch|repeat|round|space] ?
607 * [stretch|repeat|round|space]</literallayout>
608 * Specifies how the image slices should be rendered in the area
609 * outlined by border-width.
610 * The default (stretch) is to resize the slice to fill in the whole
612 * If the value of this property is 'repeat', the image slice
613 * will be tiled to fill the area.
614 * If the value of this property is 'round', the image slice will
615 * be tiled to fill the area, and scaled to fit it exactly
616 * a whole number of times.
617 * If the value of this property is 'space', the image slice will
618 * be tiled to fill the area, and if it doesn't fit it exactly a whole
619 * number of times, the extra space is distributed as padding around
621 * If two options are specified, the first one affects
622 * the horizontal behaviour and the second one the vertical behaviour.
623 * If only one option is specified, it affects both.
626 * <title>A border image</title>
627 * <inlinegraphic fileref="border1.png" format="PNG"/>
628 * <para>This border image was specified with
629 * <literallayout>url("gradient1.png") 10 10 10 10</literallayout>
633 * <title>A repeating border image</title>
634 * <inlinegraphic fileref="border2.png" format="PNG"/>
635 * <para>This border image was specified with
636 * <literallayout>url("gradient1.png") 10 10 10 10 repeat</literallayout>
640 * <title>A stretched border image</title>
641 * <inlinegraphic fileref="border3.png" format="PNG"/>
642 * <para>This border image was specified with
643 * <literallayout>url("gradient1.png") 10 10 10 10 stretch</literallayout>
647 * <refsect2 id="gtkcssprovider-transitions">
648 * <para>Styles can specify transitions that will be used to create a gradual
649 * change in the appearance when a widget state changes. The following
650 * syntax is used to specify transitions:
651 * <literallayout>@duration [s|ms] [linear|ease|ease-in|ease-out|ease-in-out] [loop]?</literallayout>
652 * The @duration is the amount of time that the animation will take for
653 * a complete cycle from start to end. If the loop option is given, the
654 * animation will be repated until the state changes again.
655 * The option after the duration determines the transition function from a
656 * small set of predefined functions.
657 * <figure><title>Linear transition</title>
658 * <graphic fileref="linear.png" format="PNG"/>
660 * <figure><title>Ease transition</title>
661 * <graphic fileref="ease.png" format="PNG"/>
663 * <figure><title>Ease-in-out transition</title>
664 * <graphic fileref="ease-in-out.png" format="PNG"/>
666 * <figure><title>Ease-in transition</title>
667 * <graphic fileref="ease-in.png" format="PNG"/>
669 * <figure><title>Ease-out transition</title>
670 * <graphic fileref="ease-out.png" format="PNG"/>
674 * <refsect2 id="gtkcssprovider-properties">
675 * <title>Supported properties</title>
677 * Properties are the part that differ the most to common CSS,
678 * not all properties are supported (some are planned to be
679 * supported eventually, some others are meaningless or don't
680 * map intuitively in a widget based environment).
683 * The currently supported properties are:
689 * <entry>Property name</entry>
690 * <entry>Syntax</entry>
691 * <entry>Maps to</entry>
692 * <entry>Examples</entry>
697 * <entry>engine</entry>
698 * <entry>engine-name</entry>
699 * <entry>#GtkThemingEngine</entry>
700 * <entry>engine: clearlooks;
701 * engine: none; /* use the default (i.e. builtin) engine) */ </entry>
704 * <entry>background-color</entry>
705 * <entry morerows="2">color (see above)</entry>
706 * <entry morerows="7">#GdkRGBA</entry>
707 * <entry morerows="7"><literallayout>background-color: #fff;
708 * color: &color1;
709 * background-color: shade (&color1, 0.5);
710 * color: mix (&color1, #f0f, 0.8);</literallayout>
714 * <entry>color</entry>
717 * <entry>border-top-color</entry>
718 * <entry morerows="4">transparent|color (see above)</entry>
721 * <entry>border-right-color</entry>
724 * <entry>border-bottom-color</entry>
727 * <entry>border-left-color</entry>
730 * <entry>border-color</entry>
731 * <entry>[transparent|color]{1,4}</entry>
734 * <entry>font-family</entry>
735 * <entry>@family [, @family]*</entry>
736 * <entry>#gchararray</entry>
737 * <entry>font-family: Sans, Arial;</entry>
740 * <entry>font-style</entry>
741 * <entry>[normal|oblique|italic]</entry>
742 * <entry>#PANGO_TYPE_STYLE</entry>
743 * <entry>font-style: italic;</entry>
746 * <entry>font-variant</entry>
747 * <entry>[normal|small-caps]</entry>
748 * <entry>#PANGO_TYPE_VARIANT</entry>
749 * <entry>font-variant: normal;</entry>
752 * <entry>font-weight</entry>
753 * <entry>[normal|bold|bolder|lighter|100|200|300|400|500|600|700|800|900]</entry>
754 * <entry>#PANGO_TYPE_WEIGHT</entry>
755 * <entry>font-weight: bold;</entry>
758 * <entry>font-size</entry>
759 * <entry>Font size in point</entry>
760 * <entry>#gint</entry>
761 * <entry>font-size: 13;</entry>
764 * <entry>font</entry>
765 * <entry>@family [@style] [@size]</entry>
766 * <entry>#PangoFontDescription</entry>
767 * <entry>font: Sans 15;</entry>
770 * <entry>margin-top</entry>
771 * <entry>integer</entry>
772 * <entry>#gint</entry>
773 * <entry>margin-top: 0;</entry>
776 * <entry>margin-left</entry>
777 * <entry>integer</entry>
778 * <entry>#gint</entry>
779 * <entry>margin-left: 1;</entry>
782 * <entry>margin-bottom</entry>
783 * <entry>integer</entry>
784 * <entry>#gint</entry>
785 * <entry>margin-bottom: 2;</entry>
788 * <entry>margin-right</entry>
789 * <entry>integer</entry>
790 * <entry>#gint</entry>
791 * <entry>margin-right: 4;</entry>
794 * <entry>margin</entry>
795 * <entry morerows="1"><literallayout>@width
796 * @vertical_width @horizontal_width
797 * @top_width @horizontal_width @bottom_width
798 * @top_width @right_width @bottom_width @left_width</literallayout>
800 * <entry morerows="1">#GtkBorder</entry>
801 * <entry morerows="1"><literallayout>margin: 5;
804 * margin: 5 10 3 5;</literallayout>
808 * <entry>padding-top</entry>
809 * <entry>integer</entry>
810 * <entry>#gint</entry>
811 * <entry>padding-top: 5;</entry>
814 * <entry>padding-left</entry>
815 * <entry>integer</entry>
816 * <entry>#gint</entry>
817 * <entry>padding-left: 5;</entry>
820 * <entry>padding-bottom</entry>
821 * <entry>integer</entry>
822 * <entry>#gint</entry>
823 * <entry>padding-bottom: 5;</entry>
826 * <entry>padding-right</entry>
827 * <entry>integer</entry>
828 * <entry>#gint</entry>
829 * <entry>padding-right: 5;</entry>
832 * <entry>padding</entry>
835 * <entry>background-image</entry>
836 * <entry><literallayout>gradient (see above) or
837 * url(@path)</literallayout></entry>
838 * <entry>#cairo_pattern_t</entry>
839 * <entry><literallayout>-gtk-gradient (linear,
840 * left top, right top,
841 * from (#fff), to (#000));
842 * -gtk-gradient (linear, 0.0 0.5, 0.5 1.0,
844 * color-stop (0.5, #f00),
846 * -gtk-gradient (radial,
847 * center center, 0.2,
848 * center center, 0.8,
849 * color-stop (0.0, #fff),
850 * color-stop (1.0, #000));
851 * url ('background.png');</literallayout>
855 * <entry>background-repeat</entry>
856 * <entry>[repeat|no-repeat]</entry>
857 * <entry>internal</entry>
858 * <entry><literallayout>background-repeat: no-repeat;</literallayout>
859 * If not specified, the style doesn't respect the CSS3
860 * specification, since the background will be
861 * stretched to fill the area.
865 * <entry>border-top-width</entry>
866 * <entry>integer</entry>
867 * <entry>#gint</entry>
868 * <entry>border-top-width: 5;</entry>
871 * <entry>border-left-width</entry>
872 * <entry>integer</entry>
873 * <entry>#gint</entry>
874 * <entry>border-left-width: 5;</entry>
877 * <entry>border-bottom-width</entry>
878 * <entry>integer</entry>
879 * <entry>#gint</entry>
880 * <entry>border-bottom-width: 5;</entry>
883 * <entry>border-right-width</entry>
884 * <entry>integer</entry>
885 * <entry>#gint</entry>
886 * <entry>border-right-width: 5;</entry>
889 * <entry>border-width</entry>
890 * <entry morerows="1">#GtkBorder</entry>
891 * <entry morerows="1"><literallayout>border-width: 1;
893 * border-width: 1 2 3;
894 * border-width: 1 2 3 5;</literallayout>
898 * <entry>border-radius</entry>
899 * <entry>integer</entry>
900 * <entry>#gint</entry>
901 * <entry>border-radius: 5;</entry>
904 * <entry>border-style</entry>
905 * <entry>[none|solid|inset|outset]</entry>
906 * <entry>#GtkBorderStyle</entry>
907 * <entry>border-style: solid;</entry>
910 * <entry>border-image</entry>
911 * <entry><literallayout>border image (see above)</literallayout></entry>
912 * <entry>internal use only</entry>
913 * <entry><literallayout>border-image: url("/path/to/image.png") 3 4 3 4 stretch;
914 * border-image: url("/path/to/image.png") 3 4 4 3 repeat stretch;</literallayout>
918 * <entry>text-shadow</entry>
919 * <entry>shadow list (see above)</entry>
920 * <entry>internal use only</entry>
921 * <entry><literallayout>text-shadow: 1 1 0 blue, -4 -4 red;</literallayout></entry>
924 * <entry>transition</entry>
925 * <entry>transition (see above)</entry>
926 * <entry>internal use only</entry>
927 * <entry><literallayout>transition: 150ms ease-in-out;
928 * transition: 1s linear loop;</literallayout>
932 * <entry>gtk-key-bindings</entry>
933 * <entry>binding set name list</entry>
934 * <entry>internal use only</entry>
935 * <entry><literallayout>gtk-bindings: binding1, binding2, ...;</literallayout>
942 * GtkThemingEngines can register their own, engine-specific style properties
943 * with the function gtk_theming_engine_register_property(). These properties
944 * can be set in CSS like other properties, using a name of the form
945 * <literallayout>-<replaceable>namespace</replaceable>-<replaceable>name</replaceable></literallayout>, where <replaceable>namespace</replaceable> is typically
946 * the name of the theming engine, and <replaceable>name</replaceable> is the
947 * name of the property. Style properties that have been registered by widgets
948 * using gtk_widget_class_install_style_property() can also be set in this
949 * way, using the widget class name for <replaceable>namespace</replaceable>.
952 * <title>Using engine-specific style properties</title>
955 * engine: clearlooks;
957 * -GtkPaned-handle-size: 6;
958 * -clearlooks-colorize-scrollbar: false;
965 typedef struct GtkCssRuleset GtkCssRuleset;
966 typedef struct _GtkCssScanner GtkCssScanner;
967 typedef struct _PropertyValue PropertyValue;
968 typedef struct _WidgetPropertyValue WidgetPropertyValue;
969 typedef enum ParserScope ParserScope;
970 typedef enum ParserSymbol ParserSymbol;
972 struct _PropertyValue {
973 GtkCssStyleProperty *property;
975 GtkCssSection *section;
978 struct _WidgetPropertyValue {
979 WidgetPropertyValue *next;
983 GtkCssSection *section;
988 GtkCssSelector *selector;
989 WidgetPropertyValue *widget_style;
990 PropertyValue *styles;
991 GtkBitmask *set_styles;
993 guint owns_styles : 1;
994 guint owns_widget_style : 1;
997 struct _GtkCssScanner
999 GtkCssProvider *provider;
1000 GtkCssParser *parser;
1001 GtkCssSection *section;
1002 GtkCssScanner *parent;
1006 struct _GtkCssProviderPrivate
1010 GHashTable *symbolic_colors;
1011 GHashTable *keyframes;
1014 GResource *resource;
1022 static gboolean gtk_keep_css_sections = FALSE;
1024 static guint css_provider_signals[LAST_SIGNAL] = { 0 };
1026 static void gtk_css_provider_finalize (GObject *object);
1027 static void gtk_css_style_provider_iface_init (GtkStyleProviderIface *iface);
1028 static void gtk_css_style_provider_private_iface_init (GtkStyleProviderPrivateInterface *iface);
1029 static void widget_property_value_list_free (WidgetPropertyValue *head);
1032 gtk_css_provider_load_internal (GtkCssProvider *css_provider,
1033 GtkCssScanner *scanner,
1039 gtk_css_provider_error_quark (void)
1041 return g_quark_from_static_string ("gtk-css-provider-error-quark");
1044 G_DEFINE_TYPE_EXTENDED (GtkCssProvider, gtk_css_provider, G_TYPE_OBJECT, 0,
1045 G_IMPLEMENT_INTERFACE (GTK_TYPE_STYLE_PROVIDER,
1046 gtk_css_style_provider_iface_init)
1047 G_IMPLEMENT_INTERFACE (GTK_TYPE_STYLE_PROVIDER_PRIVATE,
1048 gtk_css_style_provider_private_iface_init));
1051 gtk_css_provider_parsing_error (GtkCssProvider *provider,
1052 GtkCssSection *section,
1053 const GError *error)
1055 /* Only emit a warning when we have no error handlers. This is our
1056 * default handlers. And in this case erroneous CSS files are a bug
1057 * and should be fixed.
1058 * Note that these warnings can also be triggered by a broken theme
1059 * that people installed from some weird location on the internets.
1061 if (!g_signal_has_handler_pending (provider,
1062 css_provider_signals[PARSING_ERROR],
1070 file = gtk_css_section_get_file (section);
1073 info = g_file_query_info (file, G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME, 0, NULL, NULL);
1076 path = g_file_info_get_display_name (info);
1078 path = "<broken file>";
1086 g_warning ("Theme parsing error: %s:%u:%u: %s",
1088 gtk_css_section_get_end_line (section) + 1,
1089 gtk_css_section_get_end_position (section),
1093 g_object_unref (info);
1098 gtk_css_provider_class_init (GtkCssProviderClass *klass)
1100 GObjectClass *object_class = G_OBJECT_CLASS (klass);
1102 if (g_getenv ("GTK_CSS_DEBUG"))
1103 gtk_keep_css_sections = TRUE;
1106 * GtkCssProvider::parsing-error:
1107 * @provider: the provider that had a parsing error
1108 * @section: section the error happened in
1109 * @error: The parsing error
1111 * Signals that a parsing error occured. the @path, @line and @position
1112 * describe the actual location of the error as accurately as possible.
1114 * Parsing errors are never fatal, so the parsing will resume after
1115 * the error. Errors may however cause parts of the given
1116 * data or even all of it to not be parsed at all. So it is a useful idea
1117 * to check that the parsing succeeds by connecting to this signal.
1119 * Note that this signal may be emitted at any time as the css provider
1120 * may opt to defer parsing parts or all of the input to a later time
1121 * than when a loading function was called.
1123 css_provider_signals[PARSING_ERROR] =
1124 g_signal_new (I_("parsing-error"),
1125 G_TYPE_FROM_CLASS (object_class),
1127 G_STRUCT_OFFSET (GtkCssProviderClass, parsing_error),
1129 _gtk_marshal_VOID__BOXED_BOXED,
1130 G_TYPE_NONE, 2, GTK_TYPE_CSS_SECTION, G_TYPE_ERROR);
1132 object_class->finalize = gtk_css_provider_finalize;
1134 klass->parsing_error = gtk_css_provider_parsing_error;
1136 g_type_class_add_private (object_class, sizeof (GtkCssProviderPrivate));
1140 gtk_css_ruleset_init_copy (GtkCssRuleset *new,
1141 GtkCssRuleset *ruleset,
1142 GtkCssSelector *selector)
1144 memcpy (new, ruleset, sizeof (GtkCssRuleset));
1146 new->selector = selector;
1147 /* First copy takes over ownership */
1148 if (ruleset->owns_styles)
1149 ruleset->owns_styles = FALSE;
1150 if (ruleset->owns_widget_style)
1151 ruleset->owns_widget_style = FALSE;
1152 if (new->set_styles)
1153 new->set_styles = _gtk_bitmask_copy (new->set_styles);
1157 gtk_css_ruleset_clear (GtkCssRuleset *ruleset)
1159 if (ruleset->owns_styles)
1163 for (i = 0; i < ruleset->n_styles; i++)
1165 _gtk_css_value_unref (ruleset->styles[i].value);
1166 ruleset->styles[i].value = NULL;
1167 if (ruleset->styles[i].section)
1168 gtk_css_section_unref (ruleset->styles[i].section);
1170 g_free (ruleset->styles);
1172 if (ruleset->set_styles)
1173 _gtk_bitmask_free (ruleset->set_styles);
1174 if (ruleset->owns_widget_style)
1175 widget_property_value_list_free (ruleset->widget_style);
1176 if (ruleset->selector)
1177 _gtk_css_selector_free (ruleset->selector);
1179 memset (ruleset, 0, sizeof (GtkCssRuleset));
1182 static WidgetPropertyValue *
1183 widget_property_value_new (char *name, GtkCssSection *section)
1185 WidgetPropertyValue *value;
1187 value = g_slice_new0 (WidgetPropertyValue);
1190 if (gtk_keep_css_sections)
1191 value->section = gtk_css_section_ref (section);
1197 widget_property_value_free (WidgetPropertyValue *value)
1199 g_free (value->value);
1200 g_free (value->name);
1202 gtk_css_section_unref (value->section);
1204 g_slice_free (WidgetPropertyValue, value);
1208 widget_property_value_list_free (WidgetPropertyValue *head)
1210 WidgetPropertyValue *l, *next;
1211 for (l = head; l != NULL; l = next)
1214 widget_property_value_free (l);
1218 static WidgetPropertyValue *
1219 widget_property_value_list_remove_name (WidgetPropertyValue *head, const char *name)
1221 WidgetPropertyValue *l, **last;
1225 for (l = head; l != NULL; l = l->next)
1227 if (strcmp (l->name, name) == 0)
1230 widget_property_value_free (l);
1241 gtk_css_ruleset_add_style (GtkCssRuleset *ruleset,
1243 WidgetPropertyValue *value)
1245 value->next = widget_property_value_list_remove_name (ruleset->widget_style, name);
1246 ruleset->widget_style = value;
1247 ruleset->owns_widget_style = TRUE;
1251 gtk_css_ruleset_add (GtkCssRuleset *ruleset,
1252 GtkCssStyleProperty *property,
1254 GtkCssSection *section)
1258 g_return_if_fail (ruleset->owns_styles || ruleset->n_styles == 0);
1260 if (ruleset->set_styles == NULL)
1261 ruleset->set_styles = _gtk_bitmask_new ();
1263 ruleset->set_styles = _gtk_bitmask_set (ruleset->set_styles,
1264 _gtk_css_style_property_get_id (property),
1267 ruleset->owns_styles = TRUE;
1269 for (i = 0; i < ruleset->n_styles; i++)
1271 if (ruleset->styles[i].property == property)
1273 _gtk_css_value_unref (ruleset->styles[i].value);
1274 ruleset->styles[i].value = NULL;
1275 if (ruleset->styles[i].section)
1276 gtk_css_section_unref (ruleset->styles[i].section);
1280 if (i == ruleset->n_styles)
1282 ruleset->n_styles++;
1283 ruleset->styles = g_realloc (ruleset->styles, ruleset->n_styles * sizeof (PropertyValue));
1284 ruleset->styles[i].value = NULL;
1285 ruleset->styles[i].property = property;
1288 ruleset->styles[i].value = value;
1289 if (gtk_keep_css_sections)
1290 ruleset->styles[i].section = gtk_css_section_ref (section);
1292 ruleset->styles[i].section = NULL;
1296 gtk_css_ruleset_matches (GtkCssRuleset *ruleset,
1297 const GtkCssMatcher *matcher)
1299 return _gtk_css_selector_matches (ruleset->selector, matcher);
1303 gtk_css_ruleset_get_change (GtkCssRuleset *ruleset)
1305 return _gtk_css_selector_get_change (ruleset->selector);
1309 gtk_css_scanner_destroy (GtkCssScanner *scanner)
1311 if (scanner->section)
1312 gtk_css_section_unref (scanner->section);
1313 g_object_unref (scanner->provider);
1314 _gtk_css_parser_free (scanner->parser);
1316 g_slice_free (GtkCssScanner, scanner);
1320 gtk_css_provider_emit_error (GtkCssProvider *provider,
1321 GtkCssScanner *scanner,
1322 const GError *error)
1324 g_signal_emit (provider, css_provider_signals[PARSING_ERROR], 0,
1325 scanner != NULL ? scanner->section : NULL, error);
1329 gtk_css_scanner_parser_error (GtkCssParser *parser,
1330 const GError *error,
1333 GtkCssScanner *scanner = user_data;
1335 gtk_css_provider_emit_error (scanner->provider,
1340 static GtkCssScanner *
1341 gtk_css_scanner_new (GtkCssProvider *provider,
1342 GtkCssScanner *parent,
1343 GtkCssSection *section,
1347 GtkCssScanner *scanner;
1349 scanner = g_slice_new0 (GtkCssScanner);
1351 g_object_ref (provider);
1352 scanner->provider = provider;
1353 scanner->parent = parent;
1355 scanner->section = gtk_css_section_ref (section);
1357 scanner->parser = _gtk_css_parser_new (text,
1359 gtk_css_scanner_parser_error,
1366 gtk_css_scanner_would_recurse (GtkCssScanner *scanner,
1371 GFile *parser_file = _gtk_css_parser_get_file (scanner->parser);
1372 if (parser_file && g_file_equal (parser_file, file))
1375 scanner = scanner->parent;
1382 gtk_css_scanner_push_section (GtkCssScanner *scanner,
1383 GtkCssSectionType section_type)
1385 GtkCssSection *section;
1387 section = _gtk_css_section_new (scanner->section,
1391 if (scanner->section)
1392 gtk_css_section_unref (scanner->section);
1393 scanner->section = section;
1397 gtk_css_scanner_pop_section (GtkCssScanner *scanner,
1398 GtkCssSectionType check_type)
1400 GtkCssSection *parent;
1402 g_assert (gtk_css_section_get_section_type (scanner->section) == check_type);
1404 parent = gtk_css_section_get_parent (scanner->section);
1406 gtk_css_section_ref (parent);
1408 _gtk_css_section_end (scanner->section);
1409 gtk_css_section_unref (scanner->section);
1411 scanner->section = parent;
1415 gtk_css_provider_init (GtkCssProvider *css_provider)
1417 GtkCssProviderPrivate *priv;
1419 priv = css_provider->priv = G_TYPE_INSTANCE_GET_PRIVATE (css_provider,
1420 GTK_TYPE_CSS_PROVIDER,
1421 GtkCssProviderPrivate);
1423 priv->rulesets = g_array_new (FALSE, FALSE, sizeof (GtkCssRuleset));
1425 priv->symbolic_colors = g_hash_table_new_full (g_str_hash, g_str_equal,
1426 (GDestroyNotify) g_free,
1427 (GDestroyNotify) gtk_symbolic_color_unref);
1428 priv->keyframes = g_hash_table_new_full (g_str_hash, g_str_equal,
1429 (GDestroyNotify) g_free,
1430 (GDestroyNotify) _gtk_css_value_unref);
1434 css_provider_dump_symbolic_colors (GtkCssProvider *css_provider,
1435 GtkStyleProperties *props)
1437 GtkCssProviderPrivate *priv;
1438 GHashTableIter iter;
1439 gpointer key, value;
1441 priv = css_provider->priv;
1442 g_hash_table_iter_init (&iter, priv->symbolic_colors);
1444 while (g_hash_table_iter_next (&iter, &key, &value))
1447 GtkSymbolicColor *color;
1452 gtk_style_properties_map_color (props, name, color);
1456 static GtkStyleProperties *
1457 gtk_css_provider_get_style (GtkStyleProvider *provider,
1458 GtkWidgetPath *path)
1460 GtkCssMatcher matcher;
1461 GtkCssProvider *css_provider;
1462 GtkCssProviderPrivate *priv;
1463 GtkStyleProperties *props;
1466 css_provider = GTK_CSS_PROVIDER (provider);
1467 priv = css_provider->priv;
1468 props = gtk_style_properties_new ();
1470 css_provider_dump_symbolic_colors (css_provider, props);
1471 if (_gtk_css_matcher_init (&matcher, path, 0))
1473 for (i = 0; i < priv->rulesets->len; i++)
1475 GtkCssRuleset *ruleset;
1477 ruleset = &g_array_index (priv->rulesets, GtkCssRuleset, i);
1479 if (ruleset->styles == NULL)
1482 if (!gtk_css_ruleset_matches (ruleset, &matcher))
1485 for (j = 0; j < ruleset->n_styles; j++)
1486 _gtk_style_properties_set_property_by_property (props,
1487 GTK_CSS_STYLE_PROPERTY (ruleset->styles[i].property),
1488 _gtk_css_selector_get_state_flags (ruleset->selector),
1489 ruleset->styles[i].value);
1497 gtk_css_provider_get_style_property (GtkStyleProvider *provider,
1498 GtkWidgetPath *path,
1499 GtkStateFlags state,
1503 GtkCssProvider *css_provider = GTK_CSS_PROVIDER (provider);
1504 GtkCssProviderPrivate *priv = css_provider->priv;
1505 WidgetPropertyValue *val;
1506 GtkCssMatcher matcher;
1507 gboolean found = FALSE;
1511 if (!_gtk_css_matcher_init (&matcher, path, state))
1514 prop_name = g_strdup_printf ("-%s-%s",
1515 g_type_name (pspec->owner_type),
1518 for (i = priv->rulesets->len - 1; i >= 0; i--)
1520 GtkCssRuleset *ruleset;
1522 ruleset = &g_array_index (priv->rulesets, GtkCssRuleset, i);
1524 if (ruleset->widget_style == NULL)
1527 if (!gtk_css_ruleset_matches (ruleset, &matcher))
1530 for (val = ruleset->widget_style; val != NULL; val = val->next)
1532 if (strcmp (val->name, prop_name) == 0)
1534 GtkCssScanner *scanner;
1536 scanner = gtk_css_scanner_new (css_provider,
1539 val->section != NULL ? gtk_css_section_get_file (val->section) : NULL,
1542 found = _gtk_css_style_parse_value (value,
1545 gtk_css_scanner_destroy (scanner);
1561 gtk_css_style_provider_iface_init (GtkStyleProviderIface *iface)
1563 iface->get_style = gtk_css_provider_get_style;
1564 iface->get_style_property = gtk_css_provider_get_style_property;
1567 static GtkSymbolicColor *
1568 gtk_css_style_provider_get_color (GtkStyleProviderPrivate *provider,
1571 GtkCssProvider *css_provider = GTK_CSS_PROVIDER (provider);
1573 return g_hash_table_lookup (css_provider->priv->symbolic_colors, name);
1577 gtk_css_style_provider_lookup (GtkStyleProviderPrivate *provider,
1578 const GtkCssMatcher *matcher,
1579 GtkCssLookup *lookup)
1581 GtkCssProvider *css_provider;
1582 GtkCssProviderPrivate *priv;
1586 css_provider = GTK_CSS_PROVIDER (provider);
1587 priv = css_provider->priv;
1589 for (i = priv->rulesets->len - 1; i >= 0; i--)
1591 GtkCssRuleset *ruleset;
1593 ruleset = &g_array_index (priv->rulesets, GtkCssRuleset, i);
1595 if (ruleset->styles == NULL)
1598 if (!_gtk_bitmask_intersects (_gtk_css_lookup_get_missing (lookup),
1599 ruleset->set_styles))
1602 if (!gtk_css_ruleset_matches (ruleset, matcher))
1605 for (j = 0; j < ruleset->n_styles; j++)
1607 GtkCssStyleProperty *prop = ruleset->styles[j].property;
1608 guint id = _gtk_css_style_property_get_id (prop);
1610 if (!_gtk_css_lookup_is_missing (lookup, id))
1613 _gtk_css_lookup_set (lookup,
1615 ruleset->styles[j].section,
1616 ruleset->styles[j].value);
1622 gtk_css_style_provider_get_change (GtkStyleProviderPrivate *provider,
1623 const GtkCssMatcher *matcher)
1625 GtkCssProvider *css_provider;
1626 GtkCssProviderPrivate *priv;
1627 GtkCssChange change = 0;
1630 css_provider = GTK_CSS_PROVIDER (provider);
1631 priv = css_provider->priv;
1633 for (i = priv->rulesets->len - 1; i >= 0; i--)
1635 GtkCssRuleset *ruleset;
1637 ruleset = &g_array_index (priv->rulesets, GtkCssRuleset, i);
1639 if (ruleset->styles == NULL)
1642 if (!gtk_css_ruleset_matches (ruleset, matcher))
1645 change |= gtk_css_ruleset_get_change (ruleset);
1652 gtk_css_style_provider_private_iface_init (GtkStyleProviderPrivateInterface *iface)
1654 iface->get_color = gtk_css_style_provider_get_color;
1655 iface->lookup = gtk_css_style_provider_lookup;
1656 iface->get_change = gtk_css_style_provider_get_change;
1660 gtk_css_provider_finalize (GObject *object)
1662 GtkCssProvider *css_provider;
1663 GtkCssProviderPrivate *priv;
1666 css_provider = GTK_CSS_PROVIDER (object);
1667 priv = css_provider->priv;
1669 for (i = 0; i < priv->rulesets->len; i++)
1670 gtk_css_ruleset_clear (&g_array_index (priv->rulesets, GtkCssRuleset, i));
1672 g_array_free (priv->rulesets, TRUE);
1674 g_hash_table_destroy (priv->symbolic_colors);
1675 g_hash_table_destroy (priv->keyframes);
1679 g_resources_unregister (priv->resource);
1680 g_resource_unref (priv->resource);
1681 priv->resource = NULL;
1684 G_OBJECT_CLASS (gtk_css_provider_parent_class)->finalize (object);
1688 * gtk_css_provider_new:
1690 * Returns a newly created #GtkCssProvider.
1692 * Returns: A new #GtkCssProvider
1695 gtk_css_provider_new (void)
1697 return g_object_new (GTK_TYPE_CSS_PROVIDER, NULL);
1701 gtk_css_provider_take_error (GtkCssProvider *provider,
1702 GtkCssScanner *scanner,
1705 gtk_css_provider_emit_error (provider,
1709 g_error_free (error);
1713 gtk_css_provider_error_literal (GtkCssProvider *provider,
1714 GtkCssScanner *scanner,
1717 const char *message)
1719 gtk_css_provider_take_error (provider,
1721 g_error_new_literal (domain, code, message));
1725 gtk_css_provider_error (GtkCssProvider *provider,
1726 GtkCssScanner *scanner,
1730 ...) G_GNUC_PRINTF (5, 6);
1732 gtk_css_provider_error (GtkCssProvider *provider,
1733 GtkCssScanner *scanner,
1742 va_start (args, format);
1743 error = g_error_new_valist (domain, code, format, args);
1746 gtk_css_provider_take_error (provider, scanner, error);
1750 gtk_css_provider_invalid_token (GtkCssProvider *provider,
1751 GtkCssScanner *scanner,
1752 const char *expected)
1754 gtk_css_provider_error (provider,
1756 GTK_CSS_PROVIDER_ERROR,
1757 GTK_CSS_PROVIDER_ERROR_SYNTAX,
1758 "expected a valid %s", expected);
1762 css_provider_commit (GtkCssProvider *css_provider,
1764 GtkCssRuleset *ruleset)
1766 GtkCssProviderPrivate *priv;
1769 priv = css_provider->priv;
1771 if (ruleset->styles == NULL && ruleset->widget_style == NULL)
1773 g_slist_free_full (selectors, (GDestroyNotify) _gtk_css_selector_free);
1777 for (l = selectors; l; l = l->next)
1781 gtk_css_ruleset_init_copy (&new, ruleset, l->data);
1783 g_array_append_val (priv->rulesets, new);
1786 g_slist_free (selectors);
1790 gtk_css_provider_reset (GtkCssProvider *css_provider)
1792 GtkCssProviderPrivate *priv;
1795 priv = css_provider->priv;
1799 g_resources_unregister (priv->resource);
1800 g_resource_unref (priv->resource);
1801 priv->resource = NULL;
1804 g_hash_table_remove_all (priv->symbolic_colors);
1805 g_hash_table_remove_all (priv->keyframes);
1807 for (i = 0; i < priv->rulesets->len; i++)
1808 gtk_css_ruleset_clear (&g_array_index (priv->rulesets, GtkCssRuleset, i));
1809 g_array_set_size (priv->rulesets, 0);
1813 gtk_css_provider_propagate_error (GtkCssProvider *provider,
1814 GtkCssSection *section,
1815 const GError *error,
1816 GError **propagate_to)
1823 file = gtk_css_section_get_file (section);
1826 info = g_file_query_info (file,G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME, 0, NULL, NULL);
1829 path = g_file_info_get_display_name (info);
1831 path = "<broken file>";
1839 /* don't fail for deprecations */
1840 if (g_error_matches (error, GTK_CSS_PROVIDER_ERROR, GTK_CSS_PROVIDER_ERROR_DEPRECATED))
1842 g_warning ("Theme parsing error: %s:%u:%u: %s", path,
1843 gtk_css_section_get_end_line (section) + 1,
1844 gtk_css_section_get_end_position (section), error->message);
1848 /* we already set an error. And we'd like to keep the first one */
1852 *propagate_to = g_error_copy (error);
1853 g_prefix_error (propagate_to, "%s:%u:%u: ", path,
1854 gtk_css_section_get_end_line (section) + 1,
1855 gtk_css_section_get_end_position (section));
1858 g_object_unref (info);
1862 parse_import (GtkCssScanner *scanner)
1866 gtk_css_scanner_push_section (scanner, GTK_CSS_SECTION_IMPORT);
1868 if (!_gtk_css_parser_try (scanner->parser, "@import", TRUE))
1870 gtk_css_scanner_pop_section (scanner, GTK_CSS_SECTION_IMPORT);
1874 if (_gtk_css_parser_is_string (scanner->parser))
1878 uri = _gtk_css_parser_read_string (scanner->parser);
1879 file = _gtk_css_parser_get_file_for_path (scanner->parser, uri);
1884 file = _gtk_css_parser_read_url (scanner->parser);
1889 _gtk_css_parser_resync (scanner->parser, TRUE, 0);
1890 gtk_css_scanner_pop_section (scanner, GTK_CSS_SECTION_IMPORT);
1894 if (!_gtk_css_parser_try (scanner->parser, ";", FALSE))
1896 gtk_css_provider_invalid_token (scanner->provider, scanner, "semicolon");
1897 _gtk_css_parser_resync (scanner->parser, TRUE, 0);
1899 else if (gtk_css_scanner_would_recurse (scanner, file))
1901 char *path = g_file_get_path (file);
1902 gtk_css_provider_error (scanner->provider,
1904 GTK_CSS_PROVIDER_ERROR,
1905 GTK_CSS_PROVIDER_ERROR_IMPORT,
1906 "Loading '%s' would recurse",
1912 gtk_css_provider_load_internal (scanner->provider,
1919 g_object_unref (file);
1921 gtk_css_scanner_pop_section (scanner, GTK_CSS_SECTION_IMPORT);
1922 _gtk_css_parser_skip_whitespace (scanner->parser);
1928 parse_color_definition (GtkCssScanner *scanner)
1930 GtkCssValue *symbolic;
1933 gtk_css_scanner_push_section (scanner, GTK_CSS_SECTION_COLOR_DEFINITION);
1935 if (!_gtk_css_parser_try (scanner->parser, "@define-color", TRUE))
1937 gtk_css_scanner_pop_section (scanner, GTK_CSS_SECTION_COLOR_DEFINITION);
1941 name = _gtk_css_parser_try_name (scanner->parser, TRUE);
1944 gtk_css_provider_error_literal (scanner->provider,
1946 GTK_CSS_PROVIDER_ERROR,
1947 GTK_CSS_PROVIDER_ERROR_SYNTAX,
1948 "Not a valid color name");
1949 _gtk_css_parser_resync (scanner->parser, TRUE, 0);
1950 gtk_css_scanner_pop_section (scanner, GTK_CSS_SECTION_COLOR_DEFINITION);
1954 symbolic = _gtk_css_symbolic_value_new (scanner->parser);
1955 if (symbolic == NULL)
1958 _gtk_css_parser_resync (scanner->parser, TRUE, 0);
1959 gtk_css_scanner_pop_section (scanner, GTK_CSS_SECTION_COLOR_DEFINITION);
1963 if (!_gtk_css_parser_try (scanner->parser, ";", TRUE))
1966 _gtk_css_value_unref (symbolic);
1967 gtk_css_provider_error_literal (scanner->provider,
1969 GTK_CSS_PROVIDER_ERROR,
1970 GTK_CSS_PROVIDER_ERROR_SYNTAX,
1971 "Missing semicolon at end of color definition");
1972 _gtk_css_parser_resync (scanner->parser, TRUE, 0);
1974 gtk_css_scanner_pop_section (scanner, GTK_CSS_SECTION_COLOR_DEFINITION);
1978 g_hash_table_insert (scanner->provider->priv->symbolic_colors, name, symbolic);
1980 gtk_css_scanner_pop_section (scanner, GTK_CSS_SECTION_COLOR_DEFINITION);
1985 parse_binding_set (GtkCssScanner *scanner)
1987 GtkBindingSet *binding_set;
1990 gtk_css_scanner_push_section (scanner, GTK_CSS_SECTION_BINDING_SET);
1992 if (!_gtk_css_parser_try (scanner->parser, "@binding-set", TRUE))
1994 gtk_css_scanner_pop_section (scanner, GTK_CSS_SECTION_BINDING_SET);
1998 name = _gtk_css_parser_try_ident (scanner->parser, TRUE);
2001 gtk_css_provider_error_literal (scanner->provider,
2003 GTK_CSS_PROVIDER_ERROR,
2004 GTK_CSS_PROVIDER_ERROR_SYNTAX,
2005 "Expected name for binding set");
2006 _gtk_css_parser_resync (scanner->parser, TRUE, 0);
2007 goto skip_semicolon;
2010 binding_set = gtk_binding_set_find (name);
2013 binding_set = gtk_binding_set_new (name);
2014 binding_set->parsed = TRUE;
2018 if (!_gtk_css_parser_try (scanner->parser, "{", TRUE))
2020 gtk_css_provider_error_literal (scanner->provider,
2022 GTK_CSS_PROVIDER_ERROR,
2023 GTK_CSS_PROVIDER_ERROR_SYNTAX,
2024 "Expected '{' for binding set");
2025 _gtk_css_parser_resync (scanner->parser, TRUE, 0);
2026 goto skip_semicolon;
2029 while (!_gtk_css_parser_is_eof (scanner->parser) &&
2030 !_gtk_css_parser_begins_with (scanner->parser, '}'))
2032 name = _gtk_css_parser_read_value (scanner->parser);
2035 _gtk_css_parser_resync (scanner->parser, TRUE, '}');
2039 if (gtk_binding_entry_add_signal_from_string (binding_set, name) != G_TOKEN_NONE)
2041 gtk_css_provider_error_literal (scanner->provider,
2043 GTK_CSS_PROVIDER_ERROR,
2044 GTK_CSS_PROVIDER_ERROR_SYNTAX,
2045 "Failed to parse binding set.");
2050 if (!_gtk_css_parser_try (scanner->parser, ";", TRUE))
2052 if (!_gtk_css_parser_begins_with (scanner->parser, '}') &&
2053 !_gtk_css_parser_is_eof (scanner->parser))
2055 gtk_css_provider_error_literal (scanner->provider,
2057 GTK_CSS_PROVIDER_ERROR,
2058 GTK_CSS_PROVIDER_ERROR_SYNTAX,
2059 "Expected semicolon");
2060 _gtk_css_parser_resync (scanner->parser, TRUE, '}');
2065 if (!_gtk_css_parser_try (scanner->parser, "}", TRUE))
2067 gtk_css_provider_error_literal (scanner->provider,
2069 GTK_CSS_PROVIDER_ERROR,
2070 GTK_CSS_PROVIDER_ERROR_SYNTAX,
2071 "expected '}' after declarations");
2072 if (!_gtk_css_parser_is_eof (scanner->parser))
2073 _gtk_css_parser_resync (scanner->parser, FALSE, 0);
2077 if (_gtk_css_parser_begins_with (scanner->parser, ';'))
2079 gtk_css_provider_error_literal (scanner->provider,
2081 GTK_CSS_PROVIDER_ERROR,
2082 GTK_CSS_PROVIDER_ERROR_DEPRECATED,
2083 "Nonstandard semicolon at end of binding set");
2084 _gtk_css_parser_try (scanner->parser, ";", TRUE);
2087 gtk_css_scanner_pop_section (scanner, GTK_CSS_SECTION_BINDING_SET);
2093 parse_keyframes (GtkCssScanner *scanner)
2095 GtkCssKeyframes *keyframes;
2098 gtk_css_scanner_push_section (scanner, GTK_CSS_SECTION_KEYFRAMES);
2100 if (!_gtk_css_parser_try (scanner->parser, "@keyframes", TRUE))
2102 gtk_css_scanner_pop_section (scanner, GTK_CSS_SECTION_KEYFRAMES);
2106 name = _gtk_css_parser_try_ident (scanner->parser, TRUE);
2109 gtk_css_provider_error_literal (scanner->provider,
2111 GTK_CSS_PROVIDER_ERROR,
2112 GTK_CSS_PROVIDER_ERROR_SYNTAX,
2113 "Expected name for keyframes");
2114 _gtk_css_parser_resync (scanner->parser, TRUE, 0);
2118 if (!_gtk_css_parser_try (scanner->parser, "{", TRUE))
2120 gtk_css_provider_error_literal (scanner->provider,
2122 GTK_CSS_PROVIDER_ERROR,
2123 GTK_CSS_PROVIDER_ERROR_SYNTAX,
2124 "Expected '{' for keyframes");
2125 _gtk_css_parser_resync (scanner->parser, TRUE, 0);
2130 keyframes = _gtk_css_keyframes_parse (scanner->parser);
2131 if (keyframes == NULL)
2133 _gtk_css_parser_resync (scanner->parser, TRUE, '}');
2138 g_hash_table_insert (scanner->provider->priv->keyframes, name, keyframes);
2140 if (!_gtk_css_parser_try (scanner->parser, "}", TRUE))
2142 gtk_css_provider_error_literal (scanner->provider,
2144 GTK_CSS_PROVIDER_ERROR,
2145 GTK_CSS_PROVIDER_ERROR_SYNTAX,
2146 "expected '}' after declarations");
2147 if (!_gtk_css_parser_is_eof (scanner->parser))
2148 _gtk_css_parser_resync (scanner->parser, FALSE, 0);
2152 gtk_css_scanner_pop_section (scanner, GTK_CSS_SECTION_KEYFRAMES);
2158 parse_at_keyword (GtkCssScanner *scanner)
2160 if (parse_import (scanner))
2162 if (parse_color_definition (scanner))
2164 if (parse_binding_set (scanner))
2166 if (parse_keyframes (scanner))
2171 gtk_css_provider_error_literal (scanner->provider,
2173 GTK_CSS_PROVIDER_ERROR,
2174 GTK_CSS_PROVIDER_ERROR_SYNTAX,
2176 _gtk_css_parser_resync (scanner->parser, TRUE, 0);
2181 parse_selector_list (GtkCssScanner *scanner)
2183 GSList *selectors = NULL;
2185 gtk_css_scanner_push_section (scanner, GTK_CSS_SECTION_SELECTOR);
2188 GtkCssSelector *select = _gtk_css_selector_parse (scanner->parser);
2192 g_slist_free_full (selectors, (GDestroyNotify) _gtk_css_selector_free);
2193 _gtk_css_parser_resync (scanner->parser, FALSE, 0);
2194 gtk_css_scanner_pop_section (scanner, GTK_CSS_SECTION_SELECTOR);
2198 selectors = g_slist_prepend (selectors, select);
2200 while (_gtk_css_parser_try (scanner->parser, ",", TRUE));
2202 gtk_css_scanner_pop_section (scanner, GTK_CSS_SECTION_SELECTOR);
2208 parse_declaration (GtkCssScanner *scanner,
2209 GtkCssRuleset *ruleset)
2211 GtkStyleProperty *property;
2214 gtk_css_scanner_push_section (scanner, GTK_CSS_SECTION_DECLARATION);
2216 name = _gtk_css_parser_try_ident (scanner->parser, TRUE);
2218 goto check_for_semicolon;
2220 property = _gtk_style_property_lookup (name);
2221 if (property == NULL && name[0] != '-')
2223 gtk_css_provider_error (scanner->provider,
2225 GTK_CSS_PROVIDER_ERROR,
2226 GTK_CSS_PROVIDER_ERROR_NAME,
2227 "'%s' is not a valid property name",
2229 _gtk_css_parser_resync (scanner->parser, TRUE, '}');
2231 gtk_css_scanner_pop_section (scanner, GTK_CSS_SECTION_DECLARATION);
2235 if (!_gtk_css_parser_try (scanner->parser, ":", TRUE))
2237 gtk_css_provider_invalid_token (scanner->provider, scanner, "':'");
2238 _gtk_css_parser_resync (scanner->parser, TRUE, '}');
2240 gtk_css_scanner_pop_section (scanner, GTK_CSS_SECTION_DECLARATION);
2250 gtk_css_scanner_push_section (scanner, GTK_CSS_SECTION_VALUE);
2252 value = _gtk_style_property_parse_value (property,
2257 _gtk_css_parser_resync (scanner->parser, TRUE, '}');
2258 gtk_css_scanner_pop_section (scanner, GTK_CSS_SECTION_VALUE);
2259 gtk_css_scanner_pop_section (scanner, GTK_CSS_SECTION_DECLARATION);
2263 if (!_gtk_css_parser_begins_with (scanner->parser, ';') &&
2264 !_gtk_css_parser_begins_with (scanner->parser, '}') &&
2265 !_gtk_css_parser_is_eof (scanner->parser))
2267 gtk_css_provider_error_literal (scanner->provider,
2269 GTK_CSS_PROVIDER_ERROR,
2270 GTK_CSS_PROVIDER_ERROR_SYNTAX,
2271 "Junk at end of value");
2272 _gtk_css_parser_resync (scanner->parser, TRUE, '}');
2273 gtk_css_scanner_pop_section (scanner, GTK_CSS_SECTION_VALUE);
2274 gtk_css_scanner_pop_section (scanner, GTK_CSS_SECTION_DECLARATION);
2278 if (GTK_IS_CSS_SHORTHAND_PROPERTY (property))
2280 GtkCssShorthandProperty *shorthand = GTK_CSS_SHORTHAND_PROPERTY (property);
2283 for (i = 0; i < _gtk_css_shorthand_property_get_n_subproperties (shorthand); i++)
2285 GtkCssStyleProperty *child = _gtk_css_shorthand_property_get_subproperty (shorthand, i);
2286 GtkCssValue *sub = _gtk_css_array_value_get_nth (value, i);
2288 gtk_css_ruleset_add (ruleset, child, _gtk_css_value_ref (sub), scanner->section);
2291 _gtk_css_value_unref (value);
2293 else if (GTK_IS_CSS_STYLE_PROPERTY (property))
2295 gtk_css_ruleset_add (ruleset, GTK_CSS_STYLE_PROPERTY (property), value, scanner->section);
2299 g_assert_not_reached ();
2300 _gtk_css_value_unref (value);
2304 gtk_css_scanner_pop_section (scanner, GTK_CSS_SECTION_VALUE);
2306 else if (name[0] == '-')
2310 gtk_css_scanner_push_section (scanner, GTK_CSS_SECTION_VALUE);
2312 value_str = _gtk_css_parser_read_value (scanner->parser);
2315 WidgetPropertyValue *val;
2317 val = widget_property_value_new (name, scanner->section);
2318 val->value = value_str;
2320 gtk_css_ruleset_add_style (ruleset, name, val);
2324 _gtk_css_parser_resync (scanner->parser, TRUE, '}');
2325 gtk_css_scanner_pop_section (scanner, GTK_CSS_SECTION_VALUE);
2326 gtk_css_scanner_pop_section (scanner, GTK_CSS_SECTION_DECLARATION);
2330 gtk_css_scanner_pop_section (scanner, GTK_CSS_SECTION_VALUE);
2335 check_for_semicolon:
2336 gtk_css_scanner_pop_section (scanner, GTK_CSS_SECTION_DECLARATION);
2338 if (!_gtk_css_parser_try (scanner->parser, ";", TRUE))
2340 if (!_gtk_css_parser_begins_with (scanner->parser, '}') &&
2341 !_gtk_css_parser_is_eof (scanner->parser))
2343 gtk_css_provider_error_literal (scanner->provider,
2345 GTK_CSS_PROVIDER_ERROR,
2346 GTK_CSS_PROVIDER_ERROR_SYNTAX,
2347 "Expected semicolon");
2348 _gtk_css_parser_resync (scanner->parser, TRUE, '}');
2354 parse_declarations (GtkCssScanner *scanner,
2355 GtkCssRuleset *ruleset)
2357 while (!_gtk_css_parser_is_eof (scanner->parser) &&
2358 !_gtk_css_parser_begins_with (scanner->parser, '}'))
2360 parse_declaration (scanner, ruleset);
2365 parse_ruleset (GtkCssScanner *scanner)
2368 GtkCssRuleset ruleset = { 0, };
2370 gtk_css_scanner_push_section (scanner, GTK_CSS_SECTION_RULESET);
2372 selectors = parse_selector_list (scanner);
2373 if (selectors == NULL)
2375 gtk_css_scanner_pop_section (scanner, GTK_CSS_SECTION_RULESET);
2379 if (!_gtk_css_parser_try (scanner->parser, "{", TRUE))
2381 gtk_css_provider_error_literal (scanner->provider,
2383 GTK_CSS_PROVIDER_ERROR,
2384 GTK_CSS_PROVIDER_ERROR_SYNTAX,
2385 "expected '{' after selectors");
2386 _gtk_css_parser_resync (scanner->parser, FALSE, 0);
2387 g_slist_free_full (selectors, (GDestroyNotify) _gtk_css_selector_free);
2388 gtk_css_scanner_pop_section (scanner, GTK_CSS_SECTION_RULESET);
2392 parse_declarations (scanner, &ruleset);
2394 if (!_gtk_css_parser_try (scanner->parser, "}", TRUE))
2396 gtk_css_provider_error_literal (scanner->provider,
2398 GTK_CSS_PROVIDER_ERROR,
2399 GTK_CSS_PROVIDER_ERROR_SYNTAX,
2400 "expected '}' after declarations");
2401 if (!_gtk_css_parser_is_eof (scanner->parser))
2403 _gtk_css_parser_resync (scanner->parser, FALSE, 0);
2404 g_slist_free_full (selectors, (GDestroyNotify) _gtk_css_selector_free);
2405 gtk_css_ruleset_clear (&ruleset);
2406 gtk_css_scanner_pop_section (scanner, GTK_CSS_SECTION_RULESET);
2410 css_provider_commit (scanner->provider, selectors, &ruleset);
2411 gtk_css_ruleset_clear (&ruleset);
2412 gtk_css_scanner_pop_section (scanner, GTK_CSS_SECTION_RULESET);
2416 parse_statement (GtkCssScanner *scanner)
2418 if (_gtk_css_parser_begins_with (scanner->parser, '@'))
2419 parse_at_keyword (scanner);
2421 parse_ruleset (scanner);
2425 parse_stylesheet (GtkCssScanner *scanner)
2427 gtk_css_scanner_push_section (scanner, GTK_CSS_SECTION_DOCUMENT);
2429 _gtk_css_parser_skip_whitespace (scanner->parser);
2431 while (!_gtk_css_parser_is_eof (scanner->parser))
2433 if (_gtk_css_parser_try (scanner->parser, "<!--", TRUE) ||
2434 _gtk_css_parser_try (scanner->parser, "-->", TRUE))
2437 parse_statement (scanner);
2440 gtk_css_scanner_pop_section (scanner, GTK_CSS_SECTION_DOCUMENT);
2444 gtk_css_provider_compare_rule (gconstpointer a_,
2447 const GtkCssRuleset *a = (const GtkCssRuleset *) a_;
2448 const GtkCssRuleset *b = (const GtkCssRuleset *) b_;
2451 compare = _gtk_css_selector_compare (a->selector, b->selector);
2459 gtk_css_provider_postprocess (GtkCssProvider *css_provider)
2461 GtkCssProviderPrivate *priv = css_provider->priv;
2463 g_array_sort (priv->rulesets, gtk_css_provider_compare_rule);
2467 gtk_css_provider_load_internal (GtkCssProvider *css_provider,
2468 GtkCssScanner *parent,
2473 GtkCssScanner *scanner;
2474 gulong error_handler;
2475 char *free_data = NULL;
2478 error_handler = g_signal_connect (css_provider,
2480 G_CALLBACK (gtk_css_provider_propagate_error),
2483 error_handler = 0; /* silence gcc */
2487 GError *load_error = NULL;
2489 if (g_file_load_contents (file, NULL,
2497 GtkCssSection *section;
2500 section = gtk_css_section_ref (parent->section);
2502 section = _gtk_css_section_new_for_file (GTK_CSS_SECTION_DOCUMENT, file);
2504 gtk_css_provider_error (css_provider,
2506 GTK_CSS_PROVIDER_ERROR,
2507 GTK_CSS_PROVIDER_ERROR_IMPORT,
2508 "Failed to import: %s",
2509 load_error->message);
2511 gtk_css_section_unref (section);
2517 scanner = gtk_css_scanner_new (css_provider,
2519 parent ? parent->section : NULL,
2523 parse_stylesheet (scanner);
2525 gtk_css_scanner_destroy (scanner);
2528 gtk_css_provider_postprocess (css_provider);
2535 g_signal_handler_disconnect (css_provider, error_handler);
2539 /* We clear all contents from the provider for backwards compat reasons */
2540 gtk_css_provider_reset (css_provider);
2549 * gtk_css_provider_load_from_data:
2550 * @css_provider: a #GtkCssProvider
2551 * @data: (array length=length) (element-type guint8): CSS data loaded in memory
2552 * @length: the length of @data in bytes, or -1 for NUL terminated strings. If
2553 * @length is not -1, the code will assume it is not NUL terminated and will
2554 * potentially do a copy.
2555 * @error: (out) (allow-none): return location for a #GError, or %NULL
2557 * Loads @data into @css_provider, making it clear any previously loaded
2560 * Returns: %TRUE if the data could be loaded.
2563 gtk_css_provider_load_from_data (GtkCssProvider *css_provider,
2571 g_return_val_if_fail (GTK_IS_CSS_PROVIDER (css_provider), FALSE);
2572 g_return_val_if_fail (data != NULL, FALSE);
2576 length = strlen (data);
2581 free_data = g_strndup (data, length);
2585 gtk_css_provider_reset (css_provider);
2587 ret = gtk_css_provider_load_internal (css_provider, NULL, NULL, data, error);
2591 _gtk_style_provider_private_changed (GTK_STYLE_PROVIDER_PRIVATE (css_provider));
2597 * gtk_css_provider_load_from_file:
2598 * @css_provider: a #GtkCssProvider
2599 * @file: #GFile pointing to a file to load
2600 * @error: (out) (allow-none): return location for a #GError, or %NULL
2602 * Loads the data contained in @file into @css_provider, making it
2603 * clear any previously loaded information.
2605 * Returns: %TRUE if the data could be loaded.
2608 gtk_css_provider_load_from_file (GtkCssProvider *css_provider,
2614 g_return_val_if_fail (GTK_IS_CSS_PROVIDER (css_provider), FALSE);
2615 g_return_val_if_fail (G_IS_FILE (file), FALSE);
2617 gtk_css_provider_reset (css_provider);
2619 success = gtk_css_provider_load_internal (css_provider, NULL, file, NULL, error);
2621 _gtk_style_provider_private_changed (GTK_STYLE_PROVIDER_PRIVATE (css_provider));
2627 * gtk_css_provider_load_from_path:
2628 * @css_provider: a #GtkCssProvider
2629 * @path: the path of a filename to load, in the GLib filename encoding
2630 * @error: (out) (allow-none): return location for a #GError, or %NULL
2632 * Loads the data contained in @path into @css_provider, making it clear
2633 * any previously loaded information.
2635 * Returns: %TRUE if the data could be loaded.
2638 gtk_css_provider_load_from_path (GtkCssProvider *css_provider,
2645 g_return_val_if_fail (GTK_IS_CSS_PROVIDER (css_provider), FALSE);
2646 g_return_val_if_fail (path != NULL, FALSE);
2648 file = g_file_new_for_path (path);
2650 result = gtk_css_provider_load_from_file (css_provider, file, error);
2652 g_object_unref (file);
2658 _gtk_css_provider_load_from_resource (GtkCssProvider *css_provider,
2659 const gchar *resource_path)
2662 char *uri, *escaped;
2665 g_return_val_if_fail (GTK_IS_CSS_PROVIDER (css_provider), FALSE);
2666 g_return_val_if_fail (resource_path != NULL, FALSE);
2668 escaped = g_uri_escape_string (resource_path,
2669 G_URI_RESERVED_CHARS_ALLOWED_IN_PATH, FALSE);
2670 uri = g_strconcat ("resource://", escaped, NULL);
2673 file = g_file_new_for_uri (uri);
2676 result = gtk_css_provider_load_from_file (css_provider, file, NULL);
2678 g_object_unref (file);
2684 _find_theme_path (const gchar *name,
2685 const gchar *variant)
2691 subpath = g_strdup_printf ("gtk-3.0" G_DIR_SEPARATOR_S "gtk-%s.css", variant);
2693 subpath = g_strdup ("gtk-3.0" G_DIR_SEPARATOR_S "gtk.css");
2695 /* First look in the user's config directory
2697 path = g_build_filename (g_get_user_data_dir (), "themes", name, subpath, NULL);
2698 if (!g_file_test (path, G_FILE_TEST_EXISTS))
2704 /* Next look in the user's home directory
2708 const gchar *home_dir;
2710 home_dir = g_get_home_dir ();
2713 path = g_build_filename (home_dir, ".themes", name, subpath, NULL);
2715 if (!g_file_test (path, G_FILE_TEST_EXISTS))
2727 theme_dir = _gtk_css_provider_get_theme_dir ();
2728 path = g_build_filename (theme_dir, name, subpath, NULL);
2731 if (!g_file_test (path, G_FILE_TEST_EXISTS))
2744 _provider_load (GtkCssProvider *provider,
2746 const gchar *variant)
2748 gchar *resource_path;
2749 gboolean loaded = FALSE;
2751 g_assert (provider != NULL);
2754 resource_path = g_strdup_printf ("/org/gtk/libgtk/%s-%s.css", name, variant);
2756 resource_path = g_strdup_printf ("/org/gtk/libgtk/%s.css", name);
2758 if (g_resources_get_info (resource_path, 0, NULL, NULL, NULL))
2760 loaded = _gtk_css_provider_load_from_resource (provider, resource_path);
2762 g_free (resource_path);
2768 path = _find_theme_path (name, variant);
2773 char *resource_file;
2774 GResource *resource;
2776 dir = g_path_get_dirname (path);
2777 resource_file = g_build_filename (dir, "gtk.gresource", NULL);
2778 resource = g_resource_load (resource_file, NULL);
2779 g_free (resource_file);
2781 if (resource != NULL)
2782 g_resources_register (resource);
2784 loaded = gtk_css_provider_load_from_path (provider, path, NULL);
2787 if (resource != NULL)
2789 g_resources_unregister (resource);
2790 g_resource_unref (resource);
2795 /* Only set this after load success, as load_from_path will clear it */
2796 provider->priv->resource = resource;
2808 destroy_theme_cache (GHashTable *themes)
2810 g_hash_table_destroy (themes);
2814 * _gtk_css_provider_get_named_for_screen:
2815 * @screen: a #GdkScreen.
2816 * @name: A theme name
2817 * @variant: (allow-none): variant to load, for example, "dark", or
2818 * %NULL for the default
2820 * Loads a theme from the usual theme paths
2822 * Returns: (transfer none): a #GtkCssProvider with the theme loaded.
2823 * This memory is owned by GTK+, and you must not free it.
2826 _gtk_css_provider_get_named_for_screen (GdkScreen *screen,
2828 const gchar *variant)
2830 GtkCssProvider *provider;
2834 g_return_val_if_fail (GDK_IS_SCREEN (screen), NULL);
2836 themes = g_object_get_data (G_OBJECT (screen), "gtk-themes");
2837 if (G_UNLIKELY (!themes))
2839 themes = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, g_object_unref);
2840 g_object_set_data_full (G_OBJECT (screen),
2843 (GDestroyNotify)destroy_theme_cache);
2847 key = g_strdup ("");
2848 else if (variant == NULL)
2849 key = g_strdup (name);
2851 key = g_strconcat (name, "-", variant, NULL);
2853 provider = g_hash_table_lookup (themes, key);
2857 gboolean save = TRUE;
2859 provider = gtk_css_provider_new ();
2862 save = _provider_load (provider, name, variant);
2865 g_hash_table_insert (themes, g_strdup (key), provider);
2874 * gtk_css_provider_get_default:
2876 * Returns the provider containing the style settings used as a
2877 * fallback for all widgets.
2879 * Returns: (transfer none): The provider used for fallback styling.
2880 * This memory is owned by GTK+, and you must not free it.
2883 gtk_css_provider_get_default (void)
2885 GdkScreen *screen = gdk_screen_get_default ();
2888 return _gtk_css_provider_get_named_for_screen (screen, NULL, NULL);
2894 * gtk_css_provider_get_named:
2895 * @name: A theme name
2896 * @variant: (allow-none): variant to load, for example, "dark", or
2897 * %NULL for the default
2899 * Loads a theme from the usual theme paths
2901 * Returns: (transfer none): a #GtkCssProvider with the theme loaded.
2902 * This memory is owned by GTK+, and you must not free it.
2905 gtk_css_provider_get_named (const gchar *name,
2906 const gchar *variant)
2908 GdkScreen *screen = gdk_screen_get_default ();
2911 return _gtk_css_provider_get_named_for_screen (screen, name, variant);
2917 _gtk_css_provider_get_theme_dir (void)
2922 var = g_getenv ("GTK_DATA_PREFIX");
2925 path = g_build_filename (var, "share", "themes", NULL);
2927 path = g_build_filename (_gtk_get_data_prefix (), "share", "themes", NULL);
2933 compare_properties (gconstpointer a, gconstpointer b, gpointer style)
2935 const guint *ua = a;
2936 const guint *ub = b;
2937 PropertyValue *styles = style;
2939 return strcmp (_gtk_style_property_get_name (GTK_STYLE_PROPERTY (styles[*ua].property)),
2940 _gtk_style_property_get_name (GTK_STYLE_PROPERTY (styles[*ub].property)));
2944 compare_names (gconstpointer a, gconstpointer b)
2946 const WidgetPropertyValue *aa = a;
2947 const WidgetPropertyValue *bb = b;
2948 return strcmp (aa->name, bb->name);
2952 gtk_css_ruleset_print (const GtkCssRuleset *ruleset,
2955 GList *values, *walk;
2956 WidgetPropertyValue *widget_value;
2959 _gtk_css_selector_print (ruleset->selector, str);
2961 g_string_append (str, " {\n");
2963 if (ruleset->styles)
2965 guint *sorted = g_new (guint, ruleset->n_styles);
2967 for (i = 0; i < ruleset->n_styles; i++)
2970 /* so the output is identical for identical selector styles */
2971 g_qsort_with_data (sorted, ruleset->n_styles, sizeof (guint), compare_properties, ruleset->styles);
2973 for (i = 0; i < ruleset->n_styles; i++)
2975 PropertyValue *prop = &ruleset->styles[sorted[i]];
2976 g_string_append (str, " ");
2977 g_string_append (str, _gtk_style_property_get_name (GTK_STYLE_PROPERTY (prop->property)));
2978 g_string_append (str, ": ");
2979 _gtk_css_value_print (prop->value, str);
2980 g_string_append (str, ";\n");
2986 if (ruleset->widget_style)
2989 for (widget_value = ruleset->widget_style; widget_value != NULL; widget_value = widget_value->next)
2990 values = g_list_prepend (values, widget_value);
2992 /* so the output is identical for identical selector styles */
2993 values = g_list_sort (values, compare_names);
2995 for (walk = values; walk; walk = walk->next)
2997 widget_value = walk->data;
2999 g_string_append (str, " ");
3000 g_string_append (str, widget_value->name);
3001 g_string_append (str, ": ");
3002 g_string_append (str, widget_value->value);
3003 g_string_append (str, ";\n");
3006 g_list_free (values);
3009 g_string_append (str, "}\n");
3013 gtk_css_provider_print_colors (GHashTable *colors,
3019 keys = g_hash_table_get_keys (colors);
3020 /* so the output is identical for identical styles */
3021 keys = g_list_sort (keys, (GCompareFunc) strcmp);
3023 for (walk = keys; walk; walk = walk->next)
3025 const char *name = walk->data;
3026 GtkSymbolicColor *symbolic = g_hash_table_lookup (colors, (gpointer) name);
3028 g_string_append (str, "@define-color ");
3029 g_string_append (str, name);
3030 g_string_append (str, " ");
3031 s = gtk_symbolic_color_to_string (symbolic);
3032 g_string_append (str, s);
3034 g_string_append (str, ";\n");
3041 gtk_css_provider_print_keyframes (GHashTable *keyframes,
3046 keys = g_hash_table_get_keys (keyframes);
3047 /* so the output is identical for identical styles */
3048 keys = g_list_sort (keys, (GCompareFunc) strcmp);
3050 for (walk = keys; walk; walk = walk->next)
3052 const char *name = walk->data;
3053 GtkCssKeyframes *keyframe = g_hash_table_lookup (keyframes, (gpointer) name);
3056 g_string_append (str, "\n");
3057 g_string_append (str, "@keyframes ");
3058 g_string_append (str, name);
3059 g_string_append (str, " {\n");
3060 _gtk_css_keyframes_print (keyframe, str);
3061 g_string_append (str, "}\n");
3068 * gtk_css_provider_to_string:
3069 * @provider: the provider to write to a string
3071 * Convertes the @provider into a string representation in CSS
3074 * Using gtk_css_provider_load_from_data() with the return value
3075 * from this function on a new provider created with
3076 * gtk_css_provider_new() will basicallu create a duplicate of
3079 * Returns: a new string representing the @provider.
3084 gtk_css_provider_to_string (GtkCssProvider *provider)
3086 GtkCssProviderPrivate *priv;
3090 g_return_val_if_fail (GTK_IS_CSS_PROVIDER (provider), NULL);
3092 priv = provider->priv;
3094 str = g_string_new ("");
3096 gtk_css_provider_print_colors (priv->symbolic_colors, str);
3097 gtk_css_provider_print_keyframes (priv->keyframes, str);
3099 for (i = 0; i < priv->rulesets->len; i++)
3102 g_string_append (str, "\n");
3103 gtk_css_ruleset_print (&g_array_index (priv->rulesets, GtkCssRuleset, i), str);
3106 return g_string_free (str, FALSE);