ide-clang-translation-unit.c 31.5 KB
Newer Older
1
2
3
4
/* ide-clang-translation-unit.c
 *
 * Copyright (C) 2015 Christian Hergert <christian@hergert.me>
 *
5
6
7
8
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
9
 *
10
11
12
13
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
14
15
16
17
18
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

Christian Hergert's avatar
Christian Hergert committed
19
#define G_LOG_DOMAIN "clang-translation-unit"
20

21
22
23
#include <clang-c/Index.h>
#include <glib/gi18n.h>

24
25
#include "egg-counter.h"

26
#include "ide-context.h"
27
#include "ide-clang-completion-item.h"
28
#include "ide-clang-completion-item-private.h"
29
#include "ide-clang-private.h"
30
#include "ide-clang-symbol-tree.h"
31
#include "ide-clang-translation-unit.h"
32
#include "ide-debug.h"
33
#include "ide-diagnostic.h"
34
#include "ide-diagnostics.h"
35
#include "ide-file.h"
36
#include "ide-internal.h"
37
#include "ide-project.h"
38
#include "ide-ref-ptr.h"
39
#include "ide-source-location.h"
40
#include "ide-source-range.h"
41
#include "ide-symbol.h"
42
#include "ide-thread-pool.h"
43
44
#include "ide-unsaved-file.h"
#include "ide-unsaved-files.h"
45
#include "ide-vcs.h"
46

47
struct _IdeClangTranslationUnit
48
{
49
50
  IdeObject          parent_instance;

51
  IdeRefPtr         *native;
52
  gint64             serial;
53
  GFile             *file;
54
  IdeHighlightIndex *index;
55
  GHashTable        *diagnostics;
56
};
57

58
59
60
61
62
63
64
65
typedef struct
{
  GPtrArray *unsaved_files;
  gchar     *path;
  guint      line;
  guint      line_offset;
} CodeCompleteState;

66
67
68
69
70
71
72
typedef struct
{
  GPtrArray *ar;
  IdeFile   *file;
  gchar     *path;
} GetSymbolsState;

73
G_DEFINE_TYPE (IdeClangTranslationUnit, ide_clang_translation_unit, IDE_TYPE_OBJECT)
74
EGG_DEFINE_COUNTER (instances, "Clang", "Translation Units", "Number of clang translation units")
75
76
77

enum {
  PROP_0,
78
  PROP_FILE,
79
  PROP_INDEX,
80
81
  PROP_NATIVE,
  PROP_SERIAL,
82
83
84
85
86
  LAST_PROP
};

static GParamSpec *gParamSpecs [LAST_PROP];

87
88
89
90
91
92
93
94
95
96
97
98
99
static void
code_complete_state_free (gpointer data)
{
  CodeCompleteState *state = data;

  if (state)
    {
      g_clear_pointer (&state->unsaved_files, g_ptr_array_unref);
      g_free (state->path);
      g_free (state);
    }
}

100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
/**
 * ide_clang_translation_unit_get_index:
 * @self: A #IdeClangTranslationUnit.
 *
 * Gets the highlight index for the translation unit.
 *
 * Returns: (transfer none) (nullable): An #IdeHighlightIndex or %NULL.
 */
IdeHighlightIndex *
ide_clang_translation_unit_get_index (IdeClangTranslationUnit *self)
{
  g_return_val_if_fail (IDE_IS_CLANG_TRANSLATION_UNIT (self), NULL);

  return self->index;
}

static void
ide_clang_translation_unit_set_index (IdeClangTranslationUnit *self,
                                      IdeHighlightIndex       *index)
{
  g_assert (IDE_IS_CLANG_TRANSLATION_UNIT (self));

  if (index != NULL)
    self->index = ide_highlight_index_ref (index);
}

126
127
128
129
130
GFile *
ide_clang_translation_unit_get_file (IdeClangTranslationUnit *self)
{
  g_return_val_if_fail (IDE_IS_CLANG_TRANSLATION_UNIT (self), NULL);

131
  return self->file;
132
133
134
135
136
137
138
139
140
}

static void
ide_clang_translation_unit_set_file (IdeClangTranslationUnit *self,
                                     GFile                   *file)
{
  g_return_if_fail (IDE_IS_CLANG_TRANSLATION_UNIT (self));
  g_return_if_fail (G_IS_FILE (file));

141
  if (g_set_object (&self->file, file))
142
143
144
    g_object_notify_by_pspec (G_OBJECT (self), gParamSpecs [PROP_FILE]);
}

145
146
147
IdeClangTranslationUnit *
_ide_clang_translation_unit_new (IdeContext        *context,
                                 CXTranslationUnit  tu,
148
                                 GFile             *file,
149
                                 IdeHighlightIndex *index,
150
                                 gint64             serial)
151
152
153
154
155
{
  IdeClangTranslationUnit *ret;

  g_return_val_if_fail (IDE_IS_CONTEXT (context), NULL);
  g_return_val_if_fail (tu, NULL);
156
  g_return_val_if_fail (!file || G_IS_FILE (file), NULL);
157
158
159

  ret = g_object_new (IDE_TYPE_CLANG_TRANSLATION_UNIT,
                      "context", context,
160
161
                      "file", file,
                      "index", index,
162
163
                      "native", tu,
                      "serial", serial,
164
165
166
167
168
                      NULL);

  return ret;
}

169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
static IdeDiagnosticSeverity
translate_severity (enum CXDiagnosticSeverity severity)
{
  switch (severity)
    {
    case CXDiagnostic_Ignored:
      return IDE_DIAGNOSTIC_IGNORED;

    case CXDiagnostic_Note:
      return IDE_DIAGNOSTIC_NOTE;

    case CXDiagnostic_Warning:
      return IDE_DIAGNOSTIC_WARNING;

    case CXDiagnostic_Error:
      return IDE_DIAGNOSTIC_ERROR;

    case CXDiagnostic_Fatal:
      return IDE_DIAGNOSTIC_FATAL;

    default:
      return 0;
    }
}

194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
static gchar *
get_path (const gchar *workpath,
          const gchar *path)
{
  if (g_str_has_prefix (path, workpath))
    {
      path = path + strlen (workpath);
      while (*path == G_DIR_SEPARATOR)
        path++;

      return g_strdup (path);
    }

  return g_strdup (path);
}

210
211
212
static IdeSourceLocation *
create_location (IdeClangTranslationUnit *self,
                 IdeProject              *project,
213
                 const gchar             *workpath,
214
215
216
217
218
                 CXSourceLocation         cxloc)
{
  IdeSourceLocation *ret = NULL;
  IdeFile *file = NULL;
  CXFile cxfile = NULL;
219
  g_autofree gchar *path = NULL;
220
  const gchar *cstr;
221
222
223
224
225
226
  CXString str;
  unsigned line;
  unsigned column;
  unsigned offset;

  g_return_val_if_fail (self, NULL);
227
  g_return_val_if_fail (workpath, NULL);
228
229
230

  clang_getFileLocation (cxloc, &cxfile, &line, &column, &offset);

231
232
233
  if (line > 0) line--;
  if (column > 0) column--;

234
  str = clang_getFileName (cxfile);
235
  cstr = clang_getCString (str);
236
237
  if (cstr != NULL)
    path = get_path (workpath, cstr);
238
  clang_disposeString (str);
239
240
  if (cstr == NULL)
    return NULL;
241

242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
  file = ide_project_get_file_for_path (project, path);

  if (!file)
    {
      IdeContext *context;
      GFile *gfile;

      context = ide_object_get_context (IDE_OBJECT (self));
      gfile = g_file_new_for_path (path);

      file = g_object_new (IDE_TYPE_FILE,
                           "context", context,
                           "file", gfile,
                           "path", path,
                           NULL);
    }

259
260
261
262
263
264
265
266
  ret = ide_source_location_new (file, line, column, offset);

  return ret;
}

static IdeSourceRange *
create_range (IdeClangTranslationUnit *self,
              IdeProject              *project,
267
              const gchar             *workpath,
268
269
              CXSourceRange            cxrange)
{
270
  IdeSourceRange *range = NULL;
271
272
273
274
275
276
277
278
279
280
  CXSourceLocation cxbegin;
  CXSourceLocation cxend;
  g_autoptr(IdeSourceLocation) begin = NULL;
  g_autoptr(IdeSourceLocation) end = NULL;

  g_return_val_if_fail (IDE_IS_CLANG_TRANSLATION_UNIT (self), NULL);

  cxbegin = clang_getRangeStart (cxrange);
  cxend = clang_getRangeEnd (cxrange);

281
282
  begin = create_location (self, project, workpath, cxbegin);
  end = create_location (self, project, workpath, cxend);
283

284
  if ((begin != NULL) && (end != NULL))
285
    range = ide_source_range_new (begin, end);
286
287
288
289

  return range;
}

290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
static gboolean
cxfile_equal (CXFile  cxfile,
              GFile  *file)
{
  CXString cxstr;
  gchar *path;
  gboolean ret;

  cxstr = clang_getFileName (cxfile);
  path = g_file_get_path (file);

  ret = (0 == g_strcmp0 (clang_getCString (cxstr), path));

  clang_disposeString (cxstr);
  g_free (path);

  return ret;
}

309
310
static IdeDiagnostic *
create_diagnostic (IdeClangTranslationUnit *self,
311
                   IdeProject              *project,
312
                   const gchar             *workpath,
313
                   GFile                   *target,
314
315
316
317
                   CXDiagnostic            *cxdiag)
{
  enum CXDiagnosticSeverity cxseverity;
  IdeDiagnosticSeverity severity;
318
  IdeDiagnostic *diag;
319
  IdeSourceLocation *loc;
320
  g_autofree gchar *spelling = NULL;
321
  CXString cxstr;
322
  CXSourceLocation cxloc;
323
  CXFile cxfile = NULL;
324
325
  guint num_ranges;
  guint i;
326
327
328
329

  g_return_val_if_fail (IDE_IS_CLANG_TRANSLATION_UNIT (self), NULL);
  g_return_val_if_fail (cxdiag, NULL);

330
331
332
  cxloc = clang_getDiagnosticLocation (cxdiag);
  clang_getExpansionLocation (cxloc, &cxfile, NULL, NULL, NULL);

333
  if (cxfile && !cxfile_equal (cxfile, target))
334
335
    return NULL;

336
337
338
  cxseverity = clang_getDiagnosticSeverity (cxdiag);
  severity = translate_severity (cxseverity);

339
340
341
342
  cxstr = clang_getDiagnosticSpelling (cxdiag);
  spelling = g_strdup (clang_getCString (cxstr));
  clang_disposeString (cxstr);

343
344
345
346
347
348
349
350
351
352
353
354
  /*
   * I thought we could use an approach like the following to get deprecation
   * status. However, it has so far proven ineffective.
   *
   *   cursor = clang_getCursor (self->tu, cxloc);
   *   avail = clang_getCursorAvailability (cursor);
   */
  if ((severity == IDE_DIAGNOSTIC_WARNING) &&
      (spelling != NULL) &&
      (strstr (spelling, "deprecated") != NULL))
    severity = IDE_DIAGNOSTIC_DEPRECATED;

355
  loc = create_location (self, project, workpath, cxloc);
356

357
  diag = ide_diagnostic_new (severity, spelling, loc);
358

359
360
  num_ranges = clang_getDiagnosticNumRanges (cxdiag);

361
362
363
364
365
366
  for (i = 0; i < num_ranges; i++)
    {
      CXSourceRange cxrange;
      IdeSourceRange *range;

      cxrange = clang_getDiagnosticRange (cxdiag, i);
367
      range = create_range (self, project, workpath, cxrange);
368
      if (range != NULL)
369
        ide_diagnostic_take_range (diag, range);
370
371
372
    }

  return diag;
373
374
}

375
/**
376
 * ide_clang_translation_unit_get_diagnostics_for_file:
377
 *
378
 * Retrieves the diagnostics for the translation unit for a specific file.
379
380
381
382
 *
 * Returns: (transfer none) (nullable): An #IdeDiagnostics or %NULL.
 */
IdeDiagnostics *
383
384
ide_clang_translation_unit_get_diagnostics_for_file (IdeClangTranslationUnit *self,
                                                     GFile                   *file)
385
386
387
{
  g_return_val_if_fail (IDE_IS_CLANG_TRANSLATION_UNIT (self), NULL);

388
  if (!g_hash_table_contains (self->diagnostics, file))
389
    {
390
      CXTranslationUnit tu = ide_ref_ptr_get (self->native);
391
392
      IdeContext *context;
      IdeProject *project;
393
      IdeVcs *vcs;
394
      g_autofree gchar *workpath = NULL;
395
      GFile *workdir;
396
      GPtrArray *diags;
397
398
399
      guint count;
      guint i;

400
      diags = g_ptr_array_new_with_free_func ((GDestroyNotify)ide_diagnostic_unref);
401

402
403
404
405
406
407
408
409
410
      /*
       * Acquire the reader lock for the project since we will need to do
       * a bunch of project tree lookups when creating diagnostics. By doing
       * this outside of the loops, we avoid creating lots of contention on
       * the reader lock, but potentially hold on to the entire lock for a bit
       * longer at a time.
       */
      context = ide_object_get_context (IDE_OBJECT (self));
      project = ide_context_get_project (context);
411
412
413
      vcs = ide_context_get_vcs (context);
      workdir = ide_vcs_get_working_directory (vcs);
      workpath = g_file_get_path (workdir);
414
415
416

      ide_project_reader_lock (project);

417
      count = clang_getNumDiagnostics (tu);
418
419
420
      for (i = 0; i < count; i++)
        {
          CXDiagnostic cxdiag;
421
          IdeDiagnostic *diag;
422

423
          cxdiag = clang_getDiagnostic (tu, i);
424
          diag = create_diagnostic (self, project, workpath, file, cxdiag);
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445

          if (diag != NULL)
            {
              guint num_fixits;
              gsize j;

              num_fixits = clang_getDiagnosticNumFixIts (cxdiag);

              for (j = 0; j < num_fixits; j++)
                {
                  IdeFixit *fixit = NULL;
                  IdeSourceRange *range;
                  CXSourceRange cxrange;
                  CXString cxstr;

                  cxstr = clang_getDiagnosticFixIt (cxdiag, j, &cxrange);
                  range = create_range (self, project, workpath, cxrange);
                  fixit = _ide_fixit_new (range, clang_getCString (cxstr));
                  clang_disposeString (cxstr);

                  if (fixit != NULL)
446
                    ide_diagnostic_take_fixit (diag, fixit);
447
448
449
450
451
                }

              g_ptr_array_add (diags, diag);
            }

452
453
454
          clang_disposeDiagnostic (cxdiag);
        }

455
456
      ide_project_reader_unlock (project);

457
      g_hash_table_insert (self->diagnostics, g_object_ref (file), ide_diagnostics_new (diags));
458
459
    }

460
461
462
463
464
465
466
467
468
469
470
471
472
473
  return g_hash_table_lookup (self->diagnostics, file);
}

/**
 * ide_clang_translation_unit_get_diagnostics:
 *
 * Retrieves the diagnostics for the translation unit.
 *
 * Returns: (transfer none) (nullable): An #IdeDiagnostics or %NULL.
 */
IdeDiagnostics *
ide_clang_translation_unit_get_diagnostics (IdeClangTranslationUnit *self)
{
  return ide_clang_translation_unit_get_diagnostics_for_file (self, self->file);
474
475
}

476
gint64
477
ide_clang_translation_unit_get_serial (IdeClangTranslationUnit *self)
478
479
480
{
  g_return_val_if_fail (IDE_IS_CLANG_TRANSLATION_UNIT (self), -1);

481
  return self->serial;
482
483
}

484
485
486
487
488
489
490
491
492
493
static void
ide_clang_translation_unit_set_native (IdeClangTranslationUnit *self,
                                       CXTranslationUnit        native)
{
  g_assert (IDE_IS_CLANG_TRANSLATION_UNIT (self));

  if (native != NULL)
    self->native = ide_ref_ptr_new (native, (GDestroyNotify)clang_disposeTranslationUnit);
}

494
495
496
497
498
static void
ide_clang_translation_unit_finalize (GObject *object)
{
  IdeClangTranslationUnit *self = (IdeClangTranslationUnit *)object;

499
500
  IDE_ENTRY;

501
  g_clear_pointer (&self->native, ide_ref_ptr_unref);
502
  g_clear_object (&self->file);
503
  g_clear_pointer (&self->index, ide_highlight_index_unref);
504
  g_clear_pointer (&self->diagnostics, g_hash_table_unref);
505
506

  G_OBJECT_CLASS (ide_clang_translation_unit_parent_class)->finalize (object);
507

508
509
  EGG_COUNTER_DEC (instances);

510
  IDE_EXIT;
511
512
513
514
515
516
517
518
519
520
521
522
}

static void
ide_clang_translation_unit_get_property (GObject    *object,
                                         guint       prop_id,
                                         GValue     *value,
                                         GParamSpec *pspec)
{
  IdeClangTranslationUnit *self = IDE_CLANG_TRANSLATION_UNIT (object);

  switch (prop_id)
    {
523
524
525
526
    case PROP_FILE:
      g_value_set_object (value, ide_clang_translation_unit_get_file (self));
      break;

527
528
529
530
    case PROP_INDEX:
      g_value_set_boxed (value, ide_clang_translation_unit_get_index (self));
      break;

531
532
    case PROP_SERIAL:
      g_value_set_int64 (value, ide_clang_translation_unit_get_serial (self));
533
534
535
536
537
538
539
      break;

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

540
541
542
543
544
545
546
547
548
549
550
551
552
553
static void
ide_clang_translation_unit_set_property (GObject      *object,
                                         guint         prop_id,
                                         const GValue *value,
                                         GParamSpec   *pspec)
{
  IdeClangTranslationUnit *self = IDE_CLANG_TRANSLATION_UNIT (object);

  switch (prop_id)
    {
    case PROP_FILE:
      ide_clang_translation_unit_set_file (self, g_value_get_object (value));
      break;

554
555
556
557
    case PROP_INDEX:
      ide_clang_translation_unit_set_index (self, g_value_get_boxed (value));
      break;

558
559
560
561
562
    case PROP_SERIAL:
      self->serial = g_value_get_int64 (value);
      break;

    case PROP_NATIVE:
563
      ide_clang_translation_unit_set_native (self, g_value_get_pointer (value));
564
565
      break;

566
567
568
569
570
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
    }
}

571
572
573
574
575
576
577
static void
ide_clang_translation_unit_class_init (IdeClangTranslationUnitClass *klass)
{
  GObjectClass *object_class = G_OBJECT_CLASS (klass);

  object_class->finalize = ide_clang_translation_unit_finalize;
  object_class->get_property = ide_clang_translation_unit_get_property;
578
579
580
581
  object_class->set_property = ide_clang_translation_unit_set_property;

  gParamSpecs [PROP_FILE] =
    g_param_spec_object ("file",
Piotr Drąg's avatar
Piotr Drąg committed
582
583
                         "File",
                         "The file used to build the translation unit.",
584
585
                         G_TYPE_FILE,
                         (G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
586

587
588
  gParamSpecs [PROP_INDEX] =
    g_param_spec_boxed ("index",
Piotr Drąg's avatar
Piotr Drąg committed
589
590
                         "Index",
                         "The highlight index for the translation unit.",
591
                         IDE_TYPE_HIGHLIGHT_INDEX,
592
                         (G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
593

594
595
  gParamSpecs [PROP_NATIVE] =
    g_param_spec_pointer ("native",
Piotr Drąg's avatar
Piotr Drąg committed
596
597
                          "Native",
                          "The native translation unit pointer.",
598
599
600
601
                          (G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));

  gParamSpecs [PROP_SERIAL] =
    g_param_spec_int64 ("serial",
Piotr Drąg's avatar
Piotr Drąg committed
602
603
                        "Serial",
                        "A sequence number for the translation unit.",
604
                        0,
605
606
                        G_MAXINT64,
                        0,
607
                        (G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS));
608
609

  g_object_class_install_properties (object_class, LAST_PROP, gParamSpecs);
610
611
612
613
614
}

static void
ide_clang_translation_unit_init (IdeClangTranslationUnit *self)
{
615
616
  EGG_COUNTER_INC (instances);

617
618
619
620
  self->diagnostics = g_hash_table_new_full ((GHashFunc)g_file_hash,
                                             (GEqualFunc)g_file_equal,
                                             g_object_unref,
                                             (GDestroyNotify)ide_diagnostics_unref);
621
}
622
623
624
625
626
627
628
629
630
631

static void
ide_clang_translation_unit_code_complete_worker (GTask        *task,
                                                 gpointer      source_object,
                                                 gpointer      task_data,
                                                 GCancellable *cancellable)
{
  IdeClangTranslationUnit *self = source_object;
  CodeCompleteState *state = task_data;
  CXCodeCompleteResults *results;
632
  CXTranslationUnit tu;
633
634
  g_autoptr(IdeRefPtr) refptr = NULL;
  struct CXUnsavedFile *ufs;
635
  GPtrArray *ar;
636
637
638
639
640
641
642
  gsize i;
  gsize j = 0;

  g_assert (IDE_IS_CLANG_TRANSLATION_UNIT (self));
  g_assert (state);
  g_assert (state->unsaved_files);

643
644
  tu = ide_ref_ptr_get (self->native);

645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
  /*
   * FIXME: Not thread safe! We should probably add a "Pending" flag or something that is
   *        similar to g_input_stream_set_pending().
   */

  if (!state->path)
    {
      /* implausable to reach here, anyway */
      g_task_return_new_error (task,
                               G_IO_ERROR,
                               G_IO_ERROR_INVALID_FILENAME,
                               _("clang_codeCompleteAt() only works on local files"));
      return;
    }

  ufs = g_new0 (struct CXUnsavedFile, state->unsaved_files->len);

  for (i = 0; i < state->unsaved_files->len; i++)
    {
      IdeUnsavedFile *uf;
      gchar *path;
      GFile *file;

      uf = g_ptr_array_index (state->unsaved_files, i);
      file = ide_unsaved_file_get_file (uf);
      path = g_file_get_path (file);

      /*
       * NOTE: Some files might not be local, and therefore return a NULL path.
       *       Also, we will free the path from the (const char *) pointer after
       *       executing the work.
       */
      if (path != NULL)
        {
          GBytes *content = ide_unsaved_file_get_content (uf);

          ufs [j].Filename = path;
          ufs [j].Contents = g_bytes_get_data (content, NULL);
          ufs [j].Length = g_bytes_get_size (content);

          j++;
        }
    }

689
  results = clang_codeCompleteAt (tu,
690
691
692
693
694
695
696
697
698
699
700
                                  state->path,
                                  state->line + 1,
                                  state->line_offset + 1,
                                  ufs, j,
                                  clang_defaultCodeCompleteOptions ());

  /*
   * encapsulate in refptr so we don't need to malloc lots of little strings.
   * we will inflate result strings as necessary.
   */
  refptr = ide_ref_ptr_new (results, (GDestroyNotify)clang_disposeCodeCompleteResults);
701
  ar = g_ptr_array_new_with_free_func (g_object_unref);
702
703
704
705
706

  for (i = 0; i < results->NumResults; i++)
    {
      GtkSourceCompletionProposal *proposal;

Sébastien Lafargue's avatar
Sébastien Lafargue committed
707
      proposal = GTK_SOURCE_COMPLETION_PROPOSAL (ide_clang_completion_item_new (refptr, i));
708
      g_ptr_array_add (ar, proposal);
709
710
    }

711
  g_task_return_pointer (task, ar, (GDestroyNotify)g_ptr_array_unref);
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732

  /* cleanup malloc'd state */
  for (i = 0; i < j; i++)
    g_free ((gchar *)ufs [i].Filename);
  g_free (ufs);
}


void
ide_clang_translation_unit_code_complete_async (IdeClangTranslationUnit *self,
                                                GFile                   *file,
                                                const GtkTextIter       *location,
                                                GCancellable            *cancellable,
                                                GAsyncReadyCallback      callback,
                                                gpointer                 user_data)
{
  g_autoptr(GTask) task = NULL;
  CodeCompleteState *state;
  IdeContext *context;
  IdeUnsavedFiles *unsaved_files;

733
734
  IDE_ENTRY;

735
736
737
738
739
740
741
742
743
744
745
746
747
748
  g_return_if_fail (IDE_IS_CLANG_TRANSLATION_UNIT (self));
  g_return_if_fail (G_IS_FILE (file));
  g_return_if_fail (location);
  g_return_if_fail (!cancellable || G_IS_CANCELLABLE (cancellable));

  context = ide_object_get_context (IDE_OBJECT (self));
  unsaved_files = ide_context_get_unsaved_files (context);

  task = g_task_new (self, cancellable, callback, user_data);

  state = g_new0 (CodeCompleteState, 1);
  state->path = g_file_get_path (file);
  state->line = gtk_text_iter_get_line (location);
  state->line_offset = gtk_text_iter_get_line_offset (location);
749
  state->unsaved_files = ide_unsaved_files_to_array (unsaved_files);
750
751
752
753
754
755
756

  /*
   * TODO: Technically it is not safe for us to go run this in a thread. We need to ensure
   *       that only one thread is dealing with this at a time.
   */

  g_task_set_task_data (task, state, code_complete_state_free);
757
758
759
760

  ide_thread_pool_push_task (IDE_THREAD_POOL_COMPILER,
                             task,
                             ide_clang_translation_unit_code_complete_worker);
761
762

  IDE_EXIT;
763
764
765
766
767
768
769
770
771
772
}

/**
 * ide_clang_translation_unit_code_complete_finish:
 * @self: A #IdeClangTranslationUnit.
 * @result: A #GAsyncResult
 * @error: (out) (nullable): A location for a #GError, or %NULL.
 *
 * Completes a call to ide_clang_translation_unit_code_complete_async().
 *
773
774
 * Returns: (transfer container) (element-type GtkSourceCompletionProposal*): An array of
 *   #GtkSourceCompletionProposal. Upon failure, %NULL is returned.
775
 */
776
GPtrArray *
777
778
779
780
781
ide_clang_translation_unit_code_complete_finish (IdeClangTranslationUnit  *self,
                                                 GAsyncResult             *result,
                                                 GError                  **error)
{
  GTask *task = (GTask *)result;
782
783
784
  GPtrArray *ret;

  IDE_ENTRY;
785
786
787
788

  g_return_val_if_fail (IDE_IS_CLANG_TRANSLATION_UNIT (self), NULL);
  g_return_val_if_fail (G_IS_TASK (task), NULL);

789
790
791
  ret = g_task_propagate_pointer (task, error);

  IDE_RETURN (ret);
792
}
793

794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
static enum CXChildVisitResult
find_child_type (CXCursor     cursor,
                 CXCursor     parent,
                 CXClientData user_data)
{
  enum CXCursorKind *child_kind = user_data;
  enum CXCursorKind kind = clang_getCursorKind (cursor);

  switch ((int)kind)
    {
    case CXCursor_StructDecl:
    case CXCursor_UnionDecl:
    case CXCursor_EnumDecl:
      *child_kind = kind;
      return CXChildVisit_Break;

    case CXCursor_TypeRef:
      cursor = clang_getCursorReferenced (cursor);
      *child_kind = clang_getCursorKind (cursor);
      return CXChildVisit_Break;

    default:
      break;
    }

  return CXChildVisit_Continue;
}

822
823
824
825
826
static IdeSymbolKind
get_symbol_kind (CXCursor        cursor,
                 IdeSymbolFlags *flags)
{
  enum CXAvailabilityKind availability;
827
  enum CXCursorKind cxkind;
828
829
830
831
832
833
834
  IdeSymbolFlags local_flags = 0;
  IdeSymbolKind kind = 0;

  availability = clang_getCursorAvailability (cursor);
  if (availability == CXAvailability_Deprecated)
    local_flags |= IDE_SYMBOL_FLAGS_IS_DEPRECATED;

835
836
837
838
839
840
841
842
843
844
845
  cxkind = clang_getCursorKind (cursor);

  if (cxkind == CXCursor_TypedefDecl)
    {
      enum CXCursorKind child_kind = 0;

      clang_visitChildren (cursor, find_child_type, &child_kind);
      cxkind = child_kind;
    }

  switch ((int)cxkind)
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
    {
    case CXCursor_StructDecl:
      kind = IDE_SYMBOL_STRUCT;
      break;

    case CXCursor_UnionDecl:
      kind = IDE_SYMBOL_UNION;
      break;

    case CXCursor_ClassDecl:
      kind = IDE_SYMBOL_CLASS;
      break;

    case CXCursor_FunctionDecl:
      kind = IDE_SYMBOL_FUNCTION;
      break;

    case CXCursor_EnumDecl:
      kind = IDE_SYMBOL_ENUM;
      break;

    case CXCursor_EnumConstantDecl:
      kind = IDE_SYMBOL_ENUM_VALUE;
      break;

    case CXCursor_FieldDecl:
      kind = IDE_SYMBOL_FIELD;
      break;

    default:
      break;
    }

  *flags = local_flags;

  return kind;
}

884
885
886
887
888
889
IdeSymbol *
ide_clang_translation_unit_lookup_symbol (IdeClangTranslationUnit  *self,
                                          IdeSourceLocation        *location,
                                          GError                  **error)
{
  g_autofree gchar *filename = NULL;
890
  g_autofree gchar *workpath = NULL;
891
  g_auto(CXString) cxstr = { 0 };
892
893
894
  g_autoptr(IdeSourceLocation) declaration = NULL;
  g_autoptr(IdeSourceLocation) definition = NULL;
  g_autoptr(IdeSourceLocation) canonical = NULL;
895
  CXTranslationUnit tu;
896
897
  IdeSymbolKind symkind = 0;
  IdeSymbolFlags symflags = 0;
898
899
900
901
  IdeProject *project;
  IdeContext *context;
  IdeVcs *vcs;
  GFile *workdir;
902
  CXSourceLocation cxlocation;
903
  CXCursor tmpcursor;
904
905
906
907
908
909
910
911
912
913
914
915
916
  CXCursor cursor;
  CXFile cxfile;
  IdeSymbol *ret = NULL;
  IdeFile *file;
  GFile *gfile;
  guint line;
  guint line_offset;

  IDE_ENTRY;

  g_return_val_if_fail (IDE_IS_CLANG_TRANSLATION_UNIT (self), NULL);
  g_return_val_if_fail (location != NULL, NULL);

917
918
  tu = ide_ref_ptr_get (self->native);

919
920
921
922
923
924
  context = ide_object_get_context (IDE_OBJECT (self));
  project = ide_context_get_project (context);
  vcs = ide_context_get_vcs (context);
  workdir = ide_vcs_get_working_directory (vcs);
  workpath = g_file_get_path (workdir);

925
926
927
928
929
930
  line = ide_source_location_get_line (location);
  line_offset = ide_source_location_get_line_offset (location);

  if (!(file = ide_source_location_get_file (location)) ||
      !(gfile = ide_file_get_file (file)) ||
      !(filename = g_file_get_path (gfile)) ||
931
      !(cxfile = clang_getFile (tu, filename)))
932
933
    IDE_RETURN (NULL);

934
935
  cxlocation = clang_getLocation (tu, cxfile, line + 1, line_offset + 1);
  cursor = clang_getCursor (tu, cxlocation);
936
937
938
  if (clang_Cursor_isNull (cursor))
    IDE_RETURN (NULL);

939
940
941
942
943
944
945
946
947
948
949
  tmpcursor = clang_getCursorReferenced (cursor);
  if (!clang_Cursor_isNull (tmpcursor))
    {
      CXSourceLocation tmploc;
      CXSourceRange cxrange;

      cxrange = clang_getCursorExtent (tmpcursor);
      tmploc = clang_getRangeStart (cxrange);
      definition = create_location (self, project, workpath, tmploc);
    }

950
951
  symkind = get_symbol_kind (cursor, &symflags);

952
  cxstr = clang_getCursorDisplayName (cursor);
953
954
  ret = ide_symbol_new (clang_getCString (cxstr), symkind, symflags,
                        declaration, definition, canonical);
955
956
957
958
959
960
961
962

  /*
   * TODO: We should also get information about the defintion of the symbol.
   *       Possibly more.
   */

  IDE_RETURN (ret);
}
963
964
965
966
967
968
969
970

static IdeSymbol *
create_symbol (CXCursor         cursor,
               GetSymbolsState *state)
{
  g_auto(CXString) cxname = { 0 };
  g_autoptr(IdeSourceLocation) srcloc = NULL;
  CXSourceLocation cxloc;
971
972
  IdeSymbolKind symkind;
  IdeSymbolFlags symflags;
973
974
975
976
977
978
979
980
981
982
983
  const gchar *name;
  IdeSymbol *symbol;
  guint line;
  guint line_offset;

  cxname = clang_getCursorSpelling (cursor);
  name = clang_getCString (cxname);
  cxloc = clang_getCursorLocation (cursor);
  clang_getFileLocation (cxloc, NULL, &line, &line_offset, NULL);
  srcloc = ide_source_location_new (state->file, line-1, line_offset-1, 0);

984
985
  symkind = get_symbol_kind (cursor, &symflags);

986
  symbol = ide_symbol_new (name, symkind, symflags, NULL, NULL, srcloc);
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013

  return symbol;
}

static enum CXChildVisitResult
ide_clang_translation_unit_get_symbols__visitor_cb (CXCursor     cursor,
                                                    CXCursor     parent,
                                                    CXClientData user_data)
{
  GetSymbolsState *state = user_data;
  g_autoptr(IdeSymbol) symbol = NULL;
  g_auto(CXString) filename = { 0 };
  CXSourceLocation cxloc;
  CXFile file;
  enum CXCursorKind kind;

  g_assert (state);

  cxloc = clang_getCursorLocation (cursor);
  clang_getFileLocation (cxloc, &file, NULL, NULL, NULL);
  filename = clang_getFileName (file);

  if (0 != g_strcmp0 (clang_getCString (filename), state->path))
    return CXChildVisit_Continue;

  kind = clang_getCursorKind (cursor);

1014
  switch ((int)kind)
1015
1016
    {
    case CXCursor_FunctionDecl:
1017
    case CXCursor_TypedefDecl:
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
      symbol = create_symbol (cursor, state);
      break;

    default:
      break;
    }

  if (symbol != NULL)
    g_ptr_array_add (state->ar, ide_symbol_ref (symbol));

  return CXChildVisit_Continue;
}

static gint
sort_symbols_by_name (gconstpointer a,
                      gconstpointer b)
{
  IdeSymbol **asym = (IdeSymbol **)a;
  IdeSymbol **bsym = (IdeSymbol **)b;

  return g_strcmp0 (ide_symbol_get_name (*asym),
                    ide_symbol_get_name (*bsym));
}

/**
 * ide_clang_translation_unit_get_symbols:
 *
 * Returns: (transfer container) (element-type IdeSymbol*): An array of #IdeSymbol.
 */
GPtrArray *
ide_clang_translation_unit_get_symbols (IdeClangTranslationUnit *self,
                                        IdeFile                 *file)
{
  GetSymbolsState state = { 0 };
  CXCursor cursor;

  g_return_val_if_fail (IDE_IS_CLANG_TRANSLATION_UNIT (self), NULL);
  g_return_val_if_fail (IDE_IS_FILE (file), NULL);

  state.ar = g_ptr_array_new_with_free_func ((GDestroyNotify)ide_symbol_unref);
  state.file = file;
  state.path = g_file_get_path (ide_file_get_file (file));

1061
  cursor = clang_getTranslationUnitCursor (ide_ref_ptr_get (self->native));
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
  clang_visitChildren (cursor,
                       ide_clang_translation_unit_get_symbols__visitor_cb,
                       &state);

  g_ptr_array_sort (state.ar, sort_symbols_by_name);

  g_free (state.path);

  return state.ar;
}
1072
1073
1074
1075
1076
1077
1078
1079
1080

void
ide_clang_translation_unit_get_symbol_tree_async (IdeClangTranslationUnit *self,
                                                  GFile                   *file,
                                                  GCancellable            *cancellable,
                                                  GAsyncReadyCallback      callback,
                                                  gpointer                 user_data)
{
  g_autoptr(GTask) task = NULL;
1081
  IdeSymbolTree *symbol_tree;
1082
  IdeContext *context;
1083
1084
1085
1086
1087
1088

  g_return_if_fail (IDE_IS_CLANG_TRANSLATION_UNIT (self));
  g_return_if_fail (G_IS_FILE (file));
  g_return_if_fail (!cancellable || G_IS_CANCELLABLE (cancellable));

  task = g_task_new (self, cancellable, callback, user_data);
1089
1090

  context = ide_object_get_context (IDE_OBJECT (self));
1091
  symbol_tree = g_object_new (IDE_TYPE_CLANG_SYMBOL_TREE,
1092
                              "context", context,
1093
1094
1095
1096
                              "native", self->native,
                              "file", file,
                              NULL);
  g_task_return_pointer (task, symbol_tree, g_object_unref);
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
}

IdeSymbolTree *
ide_clang_translation_unit_get_symbol_tree_finish (IdeClangTranslationUnit  *self,
                                                   GAsyncResult             *result,
                                                   GError                  **error)
{
  GTask *task = (GTask *)result;

  g_return_val_if_fail (IDE_IS_CLANG_TRANSLATION_UNIT (self), NULL);
  g_return_val_if_fail (G_IS_TASK (task), NULL);

  return g_task_propagate_pointer (task, error);
}