gtkcsssection.c 8.95 KB
Newer Older
Benjamin Otte's avatar
Benjamin Otte committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/* GTK - The GIMP Toolkit
 * Copyright (C) 2011 Red Hat, Inc.
 *
 * This library 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 of the License, or (at your option) any later version.
 *
 * This library 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
Javier Jardón's avatar
Javier Jardón committed
15
 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
Benjamin Otte's avatar
Benjamin Otte committed
16 17 18 19 20 21 22
 */

#include "config.h"

#include "gtkcsssectionprivate.h"

#include "gtkcssparserprivate.h"
23
#include "gtkprivate.h"
Benjamin Otte's avatar
Benjamin Otte committed
24 25 26 27 28 29 30 31 32 33 34 35 36

/**
 * GtkCssSection:
 *
 * Defines a part of a CSS document. Because sections are nested into
 * one another, you can use gtk_css_section_get_parent() to get the
 * containing region.
 *
 * Since: 3.2
 */

struct _GtkCssSection
{
37
  gint                ref_count;
Benjamin Otte's avatar
Benjamin Otte committed
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
  GtkCssSectionType   section_type;
  GtkCssSection      *parent;
  GFile              *file;
  guint               start_line;
  guint               start_position;
  GtkCssParser       *parser;         /* parser if section isn't finished parsing yet or %NULL */
  guint               end_line;       /* end line if parser is %NULL */
  guint               end_position;   /* end position if parser is %NULL */
};

G_DEFINE_BOXED_TYPE (GtkCssSection, gtk_css_section, gtk_css_section_ref, gtk_css_section_unref)

GtkCssSection *
_gtk_css_section_new (GtkCssSection     *parent,
                      GtkCssSectionType  type,
53
                      GtkCssParser      *parser)
Benjamin Otte's avatar
Benjamin Otte committed
54 55 56
{
  GtkCssSection *section;

57
  gtk_internal_return_val_if_fail (parser != NULL, NULL);
Benjamin Otte's avatar
Benjamin Otte committed
58 59 60 61 62 63 64

  section = g_slice_new0 (GtkCssSection);

  section->ref_count = 1;
  section->section_type = type;
  if (parent)
    section->parent = gtk_css_section_ref (parent);
65 66 67
  section->file = _gtk_css_parser_get_file (parser);
  if (section->file)
    g_object_ref (section->file);
Benjamin Otte's avatar
Benjamin Otte committed
68 69 70 71 72 73 74
  section->start_line = _gtk_css_parser_get_line (parser);
  section->start_position = _gtk_css_parser_get_position (parser);
  section->parser = parser;

  return section;
}

75 76 77 78 79 80
GtkCssSection *
_gtk_css_section_new_for_file (GtkCssSectionType  type,
                               GFile             *file)
{
  GtkCssSection *section;

81
  gtk_internal_return_val_if_fail (G_IS_FILE (file), NULL);
82 83 84 85 86 87 88 89 90 91

  section = g_slice_new0 (GtkCssSection);

  section->ref_count = 1;
  section->section_type = type;
  section->file = g_object_ref (file);

  return section;
}

Benjamin Otte's avatar
Benjamin Otte committed
92 93 94
void
_gtk_css_section_end (GtkCssSection *section)
{
95 96
  gtk_internal_return_if_fail (section != NULL);
  gtk_internal_return_if_fail (section->parser != NULL);
Benjamin Otte's avatar
Benjamin Otte committed
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115

  section->end_line = _gtk_css_parser_get_line (section->parser);
  section->end_position = _gtk_css_parser_get_position (section->parser);
  section->parser = NULL;
}

/**
 * gtk_css_section_ref:
 * @section: a #GtkCssSection
 *
 * Increments the reference count on @section.
 *
 * Returns: @section itself.
 *
 * Since: 3.2
 **/
GtkCssSection *
gtk_css_section_ref (GtkCssSection *section)
{
116
  gtk_internal_return_val_if_fail (section != NULL, NULL);
Benjamin Otte's avatar
Benjamin Otte committed
117

118
  section->ref_count += 1;
Benjamin Otte's avatar
Benjamin Otte committed
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134

  return section;
}

/**
 * gtk_css_section_unref:
 * @section: a #GtkCssSection
 *
 * Decrements the reference count on @section, freeing the
 * structure if the reference count reaches 0.
 *
 * Since: 3.2
 **/
void
gtk_css_section_unref (GtkCssSection *section)
{
135
  gtk_internal_return_if_fail (section != NULL);
Benjamin Otte's avatar
Benjamin Otte committed
136

137 138
  section->ref_count -= 1;
  if (section->ref_count > 0)
Benjamin Otte's avatar
Benjamin Otte committed
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
    return;

  if (section->parent)
    gtk_css_section_unref (section->parent);
  if (section->file)
    g_object_unref (section->file);

  g_slice_free (GtkCssSection, section);
}

/**
 * gtk_css_section_get_section_type:
 * @section: the section
 *
 * Gets the type of information that @section describes.
 *
 * Returns: the type of @section
 *
 * Since: 3.2
 **/
GtkCssSectionType
gtk_css_section_get_section_type (const GtkCssSection *section)
{
162
  gtk_internal_return_val_if_fail (section != NULL, GTK_CSS_SECTION_DOCUMENT);
Benjamin Otte's avatar
Benjamin Otte committed
163 164 165 166 167 168 169 170 171 172

  return section->section_type;
}

/**
 * gtk_css_section_get_parent:
 * @section: the section
 *
 * Gets the parent section for the given @section. The parent section is
 * the section that contains this @section. A special case are sections of
173
 * type #GTK_CSS_SECTION_DOCUMENT. Their parent will either be %NULL
Benjamin Otte's avatar
Benjamin Otte committed
174 175
 * if they are the original CSS document that was loaded by
 * gtk_css_provider_load_from_file() or a section of type
176
 * #GTK_CSS_SECTION_IMPORT if it was loaded with an import rule from
Benjamin Otte's avatar
Benjamin Otte committed
177 178
 * a different file.
 *
179
 * Returns: (nullable) (transfer none): the parent section or %NULL if none
Benjamin Otte's avatar
Benjamin Otte committed
180 181 182 183 184 185
 *
 * Since: 3.2
 **/
GtkCssSection *
gtk_css_section_get_parent (const GtkCssSection *section)
{
186
  gtk_internal_return_val_if_fail (section != NULL, NULL);
Benjamin Otte's avatar
Benjamin Otte committed
187 188 189 190 191 192 193 194 195

  return section->parent;
}

/**
 * gtk_css_section_get_file:
 * @section: the section
 *
 * Gets the file that @section was parsed from. If no such file exists,
Matthias Clasen's avatar
Matthias Clasen committed
196
 * for example because the CSS was loaded via
Benjamin Otte's avatar
Benjamin Otte committed
197 198
 * @gtk_css_provider_load_from_data(), then %NULL is returned.
 *
Matthias Clasen's avatar
Matthias Clasen committed
199 200
 * Returns: (transfer none): the #GFile that @section was parsed from
 *     or %NULL if @section was parsed from other data
Benjamin Otte's avatar
Benjamin Otte committed
201 202 203 204 205 206
 *
 * Since: 3.2
 **/
GFile *
gtk_css_section_get_file (const GtkCssSection *section)
{
207
  gtk_internal_return_val_if_fail (section != NULL, NULL);
Benjamin Otte's avatar
Benjamin Otte committed
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226

  return section->file;
}

/**
 * gtk_css_section_get_start_line:
 * @section: the section
 *
 * Returns the line in the CSS document where this section starts.
 * The line number is 0-indexed, so the first line of the document
 * will return 0.
 *
 * Returns: the line number
 *
 * Since: 3.2
 **/
guint
gtk_css_section_get_start_line (const GtkCssSection *section)
{
227
  gtk_internal_return_val_if_fail (section != NULL, 0);
Benjamin Otte's avatar
Benjamin Otte committed
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245

  return section->start_line;
}

/**
 * gtk_css_section_get_start_position:
 * @section: the section
 *
 * Returns the offset in bytes from the start of the current line
 * returned via gtk_css_section_get_start_line().
 *
 * Returns: the offset in bytes from the start of the line.
 *
 * Since: 3.2
 **/
guint
gtk_css_section_get_start_position (const GtkCssSection *section)
{
246
  gtk_internal_return_val_if_fail (section != NULL, 0);
Benjamin Otte's avatar
Benjamin Otte committed
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271

  return section->start_position;
}

/**
 * gtk_css_section_get_end_line:
 * @section: the section
 *
 * Returns the line in the CSS document where this section end.
 * The line number is 0-indexed, so the first line of the document
 * will return 0.
 * This value may change in future invocations of this function if
 * @section is not yet parsed completely. This will for example 
 * happen in the GtkCssProvider::parsing-error signal.
 * The end position and line may be identical to the start
 * position and line for sections which failed to parse anything
 * successfully.
 *
 * Returns: the line number
 *
 * Since: 3.2
 **/
guint
gtk_css_section_get_end_line (const GtkCssSection *section)
{
272
  gtk_internal_return_val_if_fail (section != NULL, 0);
Benjamin Otte's avatar
Benjamin Otte committed
273 274 275 276 277 278 279 280

  if (section->parser)
    return _gtk_css_parser_get_line (section->parser);
  else
    return section->end_line;
}

/**
Matthias Clasen's avatar
Matthias Clasen committed
281
 * gtk_css_section_get_end_position:
Benjamin Otte's avatar
Benjamin Otte committed
282 283 284 285 286
 * @section: the section
 *
 * Returns the offset in bytes from the start of the current line
 * returned via gtk_css_section_get_end_line().
 * This value may change in future invocations of this function if
Matthias Clasen's avatar
Matthias Clasen committed
287
 * @section is not yet parsed completely. This will for example
Benjamin Otte's avatar
Benjamin Otte committed
288 289 290 291 292 293 294 295 296 297 298 299
 * happen in the GtkCssProvider::parsing-error signal.
 * The end position and line may be identical to the start
 * position and line for sections which failed to parse anything
 * successfully.
 *
 * Returns: the offset in bytes from the start of the line.
 *
 * Since: 3.2
 **/
guint
gtk_css_section_get_end_position (const GtkCssSection *section)
{
300
  gtk_internal_return_val_if_fail (section != NULL, 0);
Benjamin Otte's avatar
Benjamin Otte committed
301 302 303 304 305 306 307

  if (section->parser)
    return _gtk_css_parser_get_position (section->parser);
  else
    return section->end_position;
}

308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
void
_gtk_css_section_print (const GtkCssSection  *section,
                        GString              *string)
{
  if (section->file)
    {
      GFileInfo *info;

      info = g_file_query_info (section->file, G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME, 0, NULL, NULL);

      if (info)
        {
          g_string_append (string, g_file_info_get_display_name (info));
          g_object_unref (info);
        }
      else
        {
          g_string_append (string, "<broken file>");
        }
    }
  else
    {
      g_string_append (string, "<data>");
    }

  g_string_append_printf (string, ":%u:%u", 
                          gtk_css_section_get_end_line (section) + 1,
                          gtk_css_section_get_end_position (section));
}

char *
_gtk_css_section_to_string (const GtkCssSection *section)
{
  GString *string;

343
  gtk_internal_return_val_if_fail (section != NULL, NULL);
344 345 346 347 348 349

  string = g_string_new (NULL);
  _gtk_css_section_print (section, string);

  return g_string_free (string, FALSE);
}