← Back to branch summary

~ubuntu-branches/debian/stretch/gnome-builder/stretch

« back to all changes in this revision

Viewing changes to libide/ide-source-snippet-parser.c

  • Committer: Package Import Robot
  • Author(s): Andreas Henriksson
  • Date: 2015-10-11 12:38:45 UTC
  • Revision ID: package-import@ubuntu.com-20151011123845-a0hvkz01se0p1p5a
Tags: upstream-3.16.3
Import upstream version 3.16.3

Show diffs side-by-side

added added

removed removed

Lines of Context:
libide/ide-source-snippet-parser.c
 
1
/* ide-source-snippet-parser.c
 
2
 *
 
3
 * Copyright (C) 2013 Christian Hergert <christian@hergert.me>
 
4
 *
 
5
 * This program is free software: you can redistribute it and/or modify
 
6
 * it under the terms of the GNU General Public License as published by
 
7
 * the Free Software Foundation, either version 3 of the License, or
 
8
 * (at your option) any later version.
 
9
 *
 
10
 * This program is distributed in the hope that it will be useful,
 
11
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 
12
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
13
 * GNU General Public License for more details.
 
14
 *
 
15
 * You should have received a copy of the GNU General Public License
 
16
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
17
 */
 
18
 
 
19
#include <errno.h>
 
20
#include <glib/gi18n.h>
 
21
#include <stdlib.h>
 
22
 
 
23
#include "ide-source-snippet.h"
 
24
#include "ide-source-snippet-chunk.h"
 
25
#include "ide-source-snippet-parser.h"
 
26
#include "ide-source-snippet-private.h"
 
27
 
 
28
struct _IdeSourceSnippetParser
 
29
{
 
30
  GObject  parent_instance;
 
31
 
 
32
  GList   *snippets;
 
33
 
 
34
  gint     lineno;
 
35
  GList   *chunks;
 
36
  GList   *scope;
 
37
  gchar   *cur_name;
 
38
  gchar   *cur_desc;
 
39
  GString *cur_text;
 
40
};
 
41
 
 
42
 
 
43
G_DEFINE_TYPE (IdeSourceSnippetParser, ide_source_snippet_parser, G_TYPE_OBJECT)
 
44
 
 
45
 
 
46
IdeSourceSnippetParser *
 
47
ide_source_snippet_parser_new (void)
 
48
{
 
49
  return g_object_new (IDE_TYPE_SOURCE_SNIPPET_PARSER, NULL);
 
50
}
 
51
 
 
52
static void
 
53
ide_source_snippet_parser_flush_chunk (IdeSourceSnippetParser *parser)
 
54
{
 
55
  IdeSourceSnippetChunk *chunk;
 
56
 
 
57
  if (parser->cur_text->len)
 
58
    {
 
59
      chunk = ide_source_snippet_chunk_new ();
 
60
      ide_source_snippet_chunk_set_spec (chunk, parser->cur_text->str);
 
61
      parser->chunks = g_list_append (parser->chunks, chunk);
 
62
      g_string_truncate (parser->cur_text, 0);
 
63
    }
 
64
}
 
65
 
 
66
static void
 
67
ide_source_snippet_parser_store (IdeSourceSnippetParser *parser)
 
68
{
 
69
  IdeSourceSnippet *snippet;
 
70
  GList *scope_iter;
 
71
  GList *chunck_iter;
 
72
 
 
73
  ide_source_snippet_parser_flush_chunk (parser);
 
74
  for (scope_iter = parser->scope; scope_iter; scope_iter = scope_iter->next)
 
75
    {
 
76
      snippet = ide_source_snippet_new (parser->cur_name, g_strdup(scope_iter->data));
 
77
      ide_source_snippet_set_description(snippet, parser->cur_desc);
 
78
 
 
79
      for (chunck_iter = parser->chunks; chunck_iter; chunck_iter = chunck_iter->next)
 
80
        {
 
81
        #if 0
 
82
          g_printerr ("%s:  Tab: %02d  Link: %02d  Text: %s\n",
 
83
                      parser->cur_name,
 
84
                      ide_source_snippet_chunk_get_tab_stop (chunck_iter->data),
 
85
                      ide_source_snippet_chunk_get_linked_chunk (chunck_iter->data),
 
86
                      ide_source_snippet_chunk_get_text (chunck_iter->data));
 
87
        #endif
 
88
          ide_source_snippet_add_chunk (snippet, chunck_iter->data);
 
89
        }
 
90
 
 
91
      parser->snippets = g_list_append (parser->snippets, snippet);
 
92
    }
 
93
}
 
94
 
 
95
static void
 
96
ide_source_snippet_parser_finish (IdeSourceSnippetParser *parser)
 
97
{
 
98
  if (parser->cur_name)
 
99
    {
 
100
      ide_source_snippet_parser_store(parser);
 
101
    }
 
102
 
 
103
  g_clear_pointer (&parser->cur_name, g_free);
 
104
 
 
105
  g_string_truncate (parser->cur_text, 0);
 
106
 
 
107
  g_list_foreach (parser->chunks, (GFunc) g_object_unref, NULL);
 
108
  g_list_free (parser->chunks);
 
109
  parser->chunks = NULL;
 
110
 
 
111
  g_list_free_full(parser->scope, g_free);
 
112
  parser->scope = NULL;
 
113
 
 
114
  g_free(parser->cur_desc);
 
115
  parser->cur_desc = NULL;
 
116
}
 
117
 
 
118
static void
 
119
ide_source_snippet_parser_do_part_simple (IdeSourceSnippetParser *parser,
 
120
                                          const gchar            *line)
 
121
{
 
122
  g_string_append (parser->cur_text, line);
 
123
}
 
124
 
 
125
static void
 
126
ide_source_snippet_parser_do_part_n (IdeSourceSnippetParser *parser,
 
127
                                     gint                    n,
 
128
                                     const gchar            *inner)
 
129
{
 
130
  IdeSourceSnippetChunk *chunk;
 
131
 
 
132
  g_return_if_fail (IDE_IS_SOURCE_SNIPPET_PARSER (parser));
 
133
  g_return_if_fail (n >= -1);
 
134
  g_return_if_fail (inner);
 
135
 
 
136
  chunk = ide_source_snippet_chunk_new ();
 
137
  ide_source_snippet_chunk_set_spec (chunk, n ? inner : "");
 
138
  ide_source_snippet_chunk_set_tab_stop (chunk, n);
 
139
  parser->chunks = g_list_append (parser->chunks, chunk);
 
140
}
 
141
 
 
142
static void
 
143
ide_source_snippet_parser_do_part_linked (IdeSourceSnippetParser *parser,
 
144
                                          gint                    n)
 
145
{
 
146
  IdeSourceSnippetChunk *chunk;
 
147
  gchar text[12];
 
148
 
 
149
  chunk = ide_source_snippet_chunk_new ();
 
150
  if (n)
 
151
    {
 
152
      g_snprintf (text, sizeof text, "$%d", n);
 
153
      text[sizeof text - 1] = '\0';
 
154
      ide_source_snippet_chunk_set_spec (chunk, text);
 
155
    }
 
156
  else
 
157
    {
 
158
      ide_source_snippet_chunk_set_spec (chunk, "");
 
159
      ide_source_snippet_chunk_set_tab_stop (chunk, 0);
 
160
    }
 
161
  parser->chunks = g_list_append (parser->chunks, chunk);
 
162
}
 
163
 
 
164
static void
 
165
ide_source_snippet_parser_do_part_named (IdeSourceSnippetParser *parser,
 
166
                                         const gchar            *name)
 
167
{
 
168
  IdeSourceSnippetChunk *chunk;
 
169
  gchar *spec;
 
170
 
 
171
  chunk = ide_source_snippet_chunk_new ();
 
172
  spec = g_strdup_printf ("$%s", name);
 
173
  ide_source_snippet_chunk_set_spec (chunk, spec);
 
174
  ide_source_snippet_chunk_set_tab_stop (chunk, -1);
 
175
  parser->chunks = g_list_append (parser->chunks, chunk);
 
176
  g_free (spec);
 
177
}
 
178
 
 
179
static gboolean
 
180
parse_variable (const gchar  *line,
 
181
                glong        *n,
 
182
                gchar       **inner,
 
183
                const gchar **endptr,
 
184
                gchar       **name)
 
185
{
 
186
  gboolean has_inner = FALSE;
 
187
  char *end = NULL;
 
188
  gint brackets;
 
189
  gint i;
 
190
 
 
191
  *n = -1;
 
192
  *inner = NULL;
 
193
  *endptr = NULL;
 
194
  *name = NULL;
 
195
 
 
196
  g_assert (*line == '$');
 
197
 
 
198
  line++;
 
199
 
 
200
  *endptr = line;
 
201
 
 
202
  if (!*line)
 
203
    {
 
204
      *endptr = NULL;
 
205
      return FALSE;
 
206
    }
 
207
 
 
208
  if (*line == '{')
 
209
    {
 
210
      has_inner = TRUE;
 
211
      line++;
 
212
    }
 
213
 
 
214
  if (g_ascii_isdigit (*line))
 
215
    {
 
216
      errno = 0;
 
217
      *n = strtol (line, &end, 10);
 
218
      if (((*n == LONG_MIN) || (*n == LONG_MAX)) && errno == ERANGE)
 
219
        return FALSE;
 
220
      else if (*n < 0)
 
221
        return FALSE;
 
222
      line = end;
 
223
    }
 
224
  else if (g_ascii_isalpha (*line))
 
225
    {
 
226
      const gchar *cur;
 
227
 
 
228
      for (cur = line; *cur; cur++)
 
229
        {
 
230
          if (g_ascii_isalnum (*cur))
 
231
            continue;
 
232
          break;
 
233
        }
 
234
      *endptr = cur;
 
235
      *name = g_strndup (line, cur - line);
 
236
      *n = -2;
 
237
      return TRUE;
 
238
    }
 
239
 
 
240
  if (has_inner)
 
241
    {
 
242
      if (*line == ':')
 
243
        line++;
 
244
 
 
245
      brackets = 1;
 
246
 
 
247
      for (i = 0; line[i]; i++)
 
248
        {
 
249
          switch (line[i])
 
250
            {
 
251
            case '{':
 
252
              brackets++;
 
253
              break;
 
254
 
 
255
            case '}':
 
256
              brackets--;
 
257
              break;
 
258
 
 
259
            default:
 
260
              break;
 
261
            }
 
262
 
 
263
          if (!brackets)
 
264
            {
 
265
              *inner = g_strndup (line, i);
 
266
              *endptr = &line[i + 1];
 
267
              return TRUE;
 
268
            }
 
269
        }
 
270
 
 
271
      return FALSE;
 
272
    }
 
273
 
 
274
  *endptr = line;
 
275
 
 
276
  return TRUE;
 
277
}
 
278
 
 
279
static void
 
280
ide_source_snippet_parser_do_part (IdeSourceSnippetParser *parser,
 
281
                                   const gchar            *line)
 
282
{
 
283
  const gchar *dollar;
 
284
  gchar *str;
 
285
  gchar *inner;
 
286
  gchar *name;
 
287
  glong n;
 
288
 
 
289
  g_assert (line);
 
290
  g_assert (*line == '\t');
 
291
 
 
292
  line++;
 
293
 
 
294
again:
 
295
  if (!*line)
 
296
    return;
 
297
 
 
298
  if (!(dollar = strchr (line, '$')))
 
299
    {
 
300
      ide_source_snippet_parser_do_part_simple (parser, line);
 
301
      return;
 
302
    }
 
303
 
 
304
  /*
 
305
   * Parse up to the next $ as a simple.
 
306
   * If it is $N or ${N} then it is a linked chunk w/o tabstop.
 
307
   * If it is ${N:""} then it is a chunk w/ tabstop.
 
308
   * If it is ${blah|upper} then it is a non-tab stop chunk performing
 
309
   * some sort of of expansion.
 
310
   */
 
311
 
 
312
  g_assert (dollar >= line);
 
313
 
 
314
  if (dollar != line)
 
315
    {
 
316
      str = g_strndup (line, (dollar - line));
 
317
      ide_source_snippet_parser_do_part_simple (parser, str);
 
318
      g_free (str);
 
319
      line = dollar;
 
320
    }
 
321
 
 
322
parse_dollar:
 
323
  inner = NULL;
 
324
 
 
325
  if (!parse_variable (line, &n, &inner, &line, &name))
 
326
    {
 
327
      ide_source_snippet_parser_do_part_simple (parser, line);
 
328
      return;
 
329
    }
 
330
 
 
331
#if 0
 
332
  g_printerr ("Parse Variable: N=%d  inner=\"%s\"\n", n, inner);
 
333
  g_printerr ("  Left over: \"%s\"\n", line);
 
334
#endif
 
335
 
 
336
  ide_source_snippet_parser_flush_chunk (parser);
 
337
 
 
338
  if (inner)
 
339
    {
 
340
      ide_source_snippet_parser_do_part_n (parser, n, inner);
 
341
      g_free (inner);
 
342
      inner = NULL;
 
343
    }
 
344
  else if (n == -2 && name)
 
345
    ide_source_snippet_parser_do_part_named (parser, name);
 
346
  else
 
347
    ide_source_snippet_parser_do_part_linked (parser, n);
 
348
 
 
349
  g_free (name);
 
350
 
 
351
  if (line)
 
352
    {
 
353
      if (*line == '$')
 
354
        {
 
355
          goto parse_dollar;
 
356
        }
 
357
      else
 
358
        goto again;
 
359
    }
 
360
}
 
361
 
 
362
static void
 
363
ide_source_snippet_parser_do_snippet (IdeSourceSnippetParser *parser,
 
364
                                      const gchar            *line)
 
365
{
 
366
  parser->cur_name = g_strstrip (g_strdup (&line[8]));
 
367
}
 
368
 
 
369
static void
 
370
ide_source_snippet_parser_do_snippet_scope (IdeSourceSnippetParser *parser,
 
371
                                            const gchar            *line)
 
372
{
 
373
  gchar **scope_list;
 
374
  GList *iter;
 
375
  gint i;
 
376
  gboolean add_scope;
 
377
 
 
378
  scope_list = g_strsplit (&line[8], ",", -1);
 
379
 
 
380
  for (i = 0; scope_list[i]; i++)
 
381
    {
 
382
      add_scope = TRUE;
 
383
      for (iter = parser->scope; iter; iter = iter->next)
 
384
        {
 
385
          if (g_strcmp0(iter->data, scope_list[i]) == 0)
 
386
              add_scope = FALSE;
 
387
              break;
 
388
        }
 
389
 
 
390
      if (add_scope)
 
391
        parser->scope = g_list_append(parser->scope,
 
392
                                    g_strstrip (g_strdup (scope_list[i])));
 
393
    }
 
394
 
 
395
  g_strfreev(scope_list);
 
396
}
 
397
 
 
398
static void
 
399
ide_source_snippet_parser_do_snippet_description (IdeSourceSnippetParser *parser,
 
400
                                                  const gchar            *line)
 
401
{
 
402
  if (parser->cur_desc)
 
403
    {
 
404
      g_free(parser->cur_desc);
 
405
      parser->cur_desc = NULL;
 
406
    }
 
407
 
 
408
  parser->cur_desc = g_strstrip (g_strdup (&line[7]));
 
409
}
 
410
 
 
411
static void
 
412
ide_source_snippet_parser_feed_line (IdeSourceSnippetParser *parser,
 
413
                                     gchar                  *basename,
 
414
                                     const gchar            *line)
 
415
{
 
416
  g_assert (parser);
 
417
  g_assert (basename);
 
418
  g_assert (line);
 
419
 
 
420
  parser->lineno++;
 
421
 
 
422
  switch (*line)
 
423
    {
 
424
    case '\0':
 
425
      if (parser->cur_name)
 
426
        g_string_append_c (parser->cur_text, '\n');
 
427
      break;
 
428
 
 
429
    case '#':
 
430
      break;
 
431
 
 
432
    case '\t':
 
433
      if (parser->cur_name)
 
434
        {
 
435
          GList *iter;
 
436
          gboolean add_default_scope = TRUE;
 
437
          for (iter = parser->scope; iter; iter = iter->next)
 
438
            {
 
439
              if (g_strcmp0(iter->data, basename) == 0)
 
440
                {
 
441
                  add_default_scope = FALSE;
 
442
                  break;
 
443
                }
 
444
            }
 
445
 
 
446
          if (add_default_scope)
 
447
            parser->scope = g_list_append(parser->scope,
 
448
                                        g_strstrip (g_strdup (basename)));
 
449
 
 
450
          if (parser->cur_text->len || parser->chunks)
 
451
            g_string_append_c (parser->cur_text, '\n');
 
452
          ide_source_snippet_parser_do_part (parser, line);
 
453
        }
 
454
      break;
 
455
 
 
456
    case 's':
 
457
      if (g_str_has_prefix (line, "snippet"))
 
458
        {
 
459
          ide_source_snippet_parser_finish (parser);
 
460
          ide_source_snippet_parser_do_snippet (parser, line);
 
461
          break;
 
462
        }
 
463
 
 
464
    case '-':
 
465
      if (parser->cur_text->len || parser->chunks)
 
466
        {
 
467
          ide_source_snippet_parser_store(parser);
 
468
 
 
469
          g_string_truncate (parser->cur_text, 0);
 
470
 
 
471
          g_list_foreach (parser->chunks, (GFunc) g_object_unref, NULL);
 
472
          g_list_free (parser->chunks);
 
473
          parser->chunks = NULL;
 
474
 
 
475
          g_list_free_full(parser->scope, g_free);
 
476
          parser->scope = NULL;
 
477
        }
 
478
 
 
479
      if (g_str_has_prefix(line, "- scope"))
 
480
        {
 
481
          ide_source_snippet_parser_do_snippet_scope (parser, line);
 
482
          break;
 
483
        }
 
484
 
 
485
      if (g_str_has_prefix(line, "- desc"))
 
486
        {
 
487
          ide_source_snippet_parser_do_snippet_description (parser, line);
 
488
          break;
 
489
        }
 
490
 
 
491
    /* Fall through */
 
492
    default:
 
493
      g_warning (_("Invalid snippet at line %d: %s"), parser->lineno, line);
 
494
      break;
 
495
    }
 
496
}
 
497
 
 
498
gboolean
 
499
ide_source_snippet_parser_load_from_file (IdeSourceSnippetParser *parser,
 
500
                                          GFile                  *file,
 
501
                                          GError                **error)
 
502
{
 
503
  GFileInputStream *file_stream;
 
504
  GDataInputStream *data_stream;
 
505
  GError *local_error = NULL;
 
506
  gchar *line;
 
507
  gchar *basename = NULL;
 
508
 
 
509
  g_return_val_if_fail (IDE_IS_SOURCE_SNIPPET_PARSER (parser), FALSE);
 
510
  g_return_val_if_fail (G_IS_FILE (file), FALSE);
 
511
 
 
512
  basename = g_file_get_basename (file);
 
513
 
 
514
  if (basename)
 
515
    {
 
516
      if (strstr (basename, "."))
 
517
        *strstr (basename, ".") = '\0';
 
518
    }
 
519
 
 
520
  file_stream = g_file_read (file, NULL, error);
 
521
  if (!file_stream)
 
522
    return FALSE;
 
523
 
 
524
  data_stream = g_data_input_stream_new (G_INPUT_STREAM (file_stream));
 
525
  g_object_unref (file_stream);
 
526
 
 
527
again:
 
528
  line = g_data_input_stream_read_line_utf8 (data_stream, NULL, NULL, &local_error);
 
529
  if (line && local_error)
 
530
    {
 
531
      g_propagate_error (error, local_error);
 
532
      return FALSE;
 
533
    }
 
534
  else if (line)
 
535
    {
 
536
      ide_source_snippet_parser_feed_line (parser, basename, line);
 
537
      g_free (line);
 
538
      goto again;
 
539
    }
 
540
 
 
541
  ide_source_snippet_parser_finish (parser);
 
542
  g_free(basename);
 
543
 
 
544
  return TRUE;
 
545
}
 
546
 
 
547
GList *
 
548
ide_source_snippet_parser_get_snippets (IdeSourceSnippetParser *parser)
 
549
{
 
550
  g_return_val_if_fail (IDE_IS_SOURCE_SNIPPET_PARSER (parser), NULL);
 
551
  return parser->snippets;
 
552
}
 
553
 
 
554
static void
 
555
ide_source_snippet_parser_finalize (GObject *object)
 
556
{
 
557
  IdeSourceSnippetParser *self = IDE_SOURCE_SNIPPET_PARSER (object);
 
558
 
 
559
  g_list_foreach (self->snippets, (GFunc) g_object_unref, NULL);
 
560
  g_list_free (self->snippets);
 
561
  self->snippets = NULL;
 
562
 
 
563
  g_list_foreach (self->chunks, (GFunc) g_object_unref, NULL);
 
564
  g_list_free (self->chunks);
 
565
  self->chunks = NULL;
 
566
 
 
567
  g_list_free_full(self->scope, g_free);
 
568
  self->scope = NULL;
 
569
 
 
570
  if (self->cur_text)
 
571
    g_string_free (self->cur_text, TRUE);
 
572
 
 
573
  g_free (self->cur_name);
 
574
  self->cur_name = NULL;
 
575
 
 
576
  if (self->cur_desc)
 
577
    {
 
578
      g_free (self->cur_desc);
 
579
      self->cur_desc = NULL;
 
580
    }
 
581
 
 
582
  G_OBJECT_CLASS (ide_source_snippet_parser_parent_class)->finalize (object);
 
583
}
 
584
 
 
585
static void
 
586
ide_source_snippet_parser_class_init (IdeSourceSnippetParserClass *klass)
 
587
{
 
588
  GObjectClass *object_class;
 
589
 
 
590
  object_class = G_OBJECT_CLASS (klass);
 
591
  object_class->finalize = ide_source_snippet_parser_finalize;
 
592
}
 
593
 
 
594
static void
 
595
ide_source_snippet_parser_init (IdeSourceSnippetParser *parser)
 
596
{
 
597
  parser->lineno = -1;
 
598
  parser->cur_text = g_string_new (NULL);
 
599
  parser->scope = NULL;
 
600
  parser->cur_desc = NULL;
 
601
}