File: foundry-completion-request.c

package info (click to toggle)
foundry 1.1~beta-3
  • links: PTS, VCS
  • area: main
  • in suites: forky
  • size: 15,572 kB
  • sloc: ansic: 167,487; xml: 417; sh: 19; makefile: 13; javascript: 10
file content (177 lines) | stat: -rw-r--r-- 5,184 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
/* foundry-completion-request.c
 *
 * Copyright 2025 Christian Hergert <chergert@redhat.com>
 *
 * 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.1 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 General Public License along
 * with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * SPDX-License-Identifier: LGPL-2.1-or-later
 */

#include "config.h"

#include "foundry-completion-request.h"
#include "foundry-text-buffer.h"
#include "foundry-text-document.h"
#include "foundry-text-iter.h"

/**
 * FoundryCompletionRequest:
 *
 * Represents a single completion request.
 */

enum {
  PROP_0,
  PROP_WORD,
  N_PROPS
};

G_DEFINE_ABSTRACT_TYPE (FoundryCompletionRequest, foundry_completion_request, G_TYPE_OBJECT)

static GParamSpec *properties[N_PROPS];

static void
foundry_completion_request_get_property (GObject    *object,
                                         guint       prop_id,
                                         GValue     *value,
                                         GParamSpec *pspec)
{
  FoundryCompletionRequest *self = FOUNDRY_COMPLETION_REQUEST (object);

  switch (prop_id)
    {
    case PROP_WORD:
      g_value_take_string (value, foundry_completion_request_dup_word (self));
      break;

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

static void
foundry_completion_request_class_init (FoundryCompletionRequestClass *klass)
{
  GObjectClass *object_class = G_OBJECT_CLASS (klass);

  object_class->get_property = foundry_completion_request_get_property;

  properties[PROP_WORD] =
    g_param_spec_string ("word", NULL, NULL,
                         NULL,
                         (G_PARAM_READABLE |
                          G_PARAM_STATIC_STRINGS));

  g_object_class_install_properties (object_class, N_PROPS, properties);
}

static void
foundry_completion_request_init (FoundryCompletionRequest *self)
{
}

/**
 * foundry_completion_request_dup_word:
 * @self: a [class@Foundry.CompletionRequest]
 *
 * Returns: (transfer full) (nullable): the word to complete
 */
char *
foundry_completion_request_dup_word (FoundryCompletionRequest *self)
{
  g_return_val_if_fail (FOUNDRY_IS_COMPLETION_REQUEST (self), NULL);

  return FOUNDRY_COMPLETION_REQUEST_GET_CLASS (self)->dup_word (self);
}

/**
 * foundry_completion_request_dup_file:
 * @self: a [class@Foundry.CompletionRequest]
 *
 * Gets the file that is to be completed.
 *
 * Returns: (transfer full) (nullable):
 */
GFile *
foundry_completion_request_dup_file (FoundryCompletionRequest *self)
{
  g_return_val_if_fail (FOUNDRY_IS_COMPLETION_REQUEST (self), NULL);

  if (FOUNDRY_COMPLETION_REQUEST_GET_CLASS (self)->dup_file)
    return FOUNDRY_COMPLETION_REQUEST_GET_CLASS (self)->dup_file (self);

  return NULL;
}

/**
 * foundry_completion_request_dup_language_id:
 * @self: a [class@Foundry.CompletionRequest]
 *
 * Gets the language identifier for the completion request, such as "c" or "js".
 *
 * The language identifiers are expected to match GtkSourceView language identifiers.
 *
 * Returns: (transfer full) (nullable): the language identifier or %NULL
 */
char *
foundry_completion_request_dup_language_id (FoundryCompletionRequest *self)
{
  g_return_val_if_fail (FOUNDRY_IS_COMPLETION_REQUEST (self), NULL);

  if (FOUNDRY_COMPLETION_REQUEST_GET_CLASS (self)->dup_language_id)
    return FOUNDRY_COMPLETION_REQUEST_GET_CLASS (self)->dup_language_id (self);

  return NULL;
}

/**
 * foundry_completion_request_get_bounds:
 * @self: a [class@Foundry.CompletionRequest]
 * @begin: (out) (nullable): location for iter where completion started
 * @end: (out) (nullable): location for where completion request ended
 *
 * This gets the bounds for the completion request.
 *
 * Generally, `begin` will be right after a break character such as "." and
 * `end` will be where cursor is currently.
 */
void
foundry_completion_request_get_bounds (FoundryCompletionRequest *self,
                                       FoundryTextIter          *begin,
                                       FoundryTextIter          *end)
{
  FoundryTextIter dummy1;
  FoundryTextIter dummy2;

  g_return_if_fail (FOUNDRY_IS_COMPLETION_REQUEST (self));

  if (begin == NULL)
    begin = &dummy1;

  if (end == NULL)
    end = &dummy2;

  FOUNDRY_COMPLETION_REQUEST_GET_CLASS (self)->get_bounds (self, begin, end);
}

FoundryCompletionActivation
foundry_completion_request_get_activation (FoundryCompletionRequest *self)
{
  g_return_val_if_fail (FOUNDRY_IS_COMPLETION_REQUEST (self), 0);

  if (FOUNDRY_COMPLETION_REQUEST_GET_CLASS (self)->get_activation)
    return FOUNDRY_COMPLETION_REQUEST_GET_CLASS (self)->get_activation (self);

  return FOUNDRY_COMPLETION_ACTIVATION_NONE;
}