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 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 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 272 273 274 275
|
/* foundry-completion-provider.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-provider.h"
/**
* FoundryCompletionProvider:
*
* Abstract base class for providing code completion suggestions.
*
* FoundryCompletionProvider provides the core interface for code completion
* functionality including suggestion generation and context-aware completions.
* Concrete implementations handle specific languages and provide specialized
* completion logic for different programming contexts and editor states.
*/
typedef struct
{
PeasPluginInfo *plugin_info;
GWeakRef document_wr;
} FoundryCompletionProviderPrivate;
G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE (FoundryCompletionProvider, foundry_completion_provider, FOUNDRY_TYPE_CONTEXTUAL)
enum {
PROP_0,
PROP_DOCUMENT,
PROP_PLUGIN_INFO,
N_PROPS
};
static GParamSpec *properties[N_PROPS];
static DexFuture *
foundry_completion_provider_real_complete (FoundryCompletionProvider *self,
FoundryCompletionRequest *request)
{
dex_return_error_if_fail (FOUNDRY_IS_COMPLETION_PROVIDER (self));
dex_return_error_if_fail (FOUNDRY_IS_COMPLETION_REQUEST (request));
return dex_future_new_reject (G_IO_ERROR,
G_IO_ERROR_NOT_SUPPORTED,
"Not supported");
}
static DexFuture *
foundry_completion_provider_real_refilter (FoundryCompletionProvider *self,
FoundryCompletionRequest *request,
GListModel *model)
{
dex_return_error_if_fail (FOUNDRY_IS_COMPLETION_PROVIDER (self));
dex_return_error_if_fail (FOUNDRY_IS_COMPLETION_REQUEST (request));
dex_return_error_if_fail (G_IS_LIST_MODEL (model));
return FOUNDRY_COMPLETION_PROVIDER_GET_CLASS (self)->complete (self, request);
}
static void
foundry_completion_provider_dispose (GObject *object)
{
FoundryCompletionProvider *self = (FoundryCompletionProvider *)object;
FoundryCompletionProviderPrivate *priv = foundry_completion_provider_get_instance_private (self);
g_weak_ref_set (&priv->document_wr, NULL);
g_clear_object (&priv->plugin_info);
G_OBJECT_CLASS (foundry_completion_provider_parent_class)->dispose (object);
}
static void
foundry_completion_provider_finalize (GObject *object)
{
FoundryCompletionProvider *self = (FoundryCompletionProvider *)object;
FoundryCompletionProviderPrivate *priv = foundry_completion_provider_get_instance_private (self);
g_weak_ref_clear (&priv->document_wr);
G_OBJECT_CLASS (foundry_completion_provider_parent_class)->finalize (object);
}
static void
foundry_completion_provider_get_property (GObject *object,
guint prop_id,
GValue *value,
GParamSpec *pspec)
{
FoundryCompletionProvider *self = FOUNDRY_COMPLETION_PROVIDER (object);
FoundryCompletionProviderPrivate *priv = foundry_completion_provider_get_instance_private (self);
switch (prop_id)
{
case PROP_DOCUMENT:
g_value_take_object (value, foundry_completion_provider_dup_document (self));
break;
case PROP_PLUGIN_INFO:
g_value_set_object (value, priv->plugin_info);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
}
}
static void
foundry_completion_provider_set_property (GObject *object,
guint prop_id,
const GValue *value,
GParamSpec *pspec)
{
FoundryCompletionProvider *self = FOUNDRY_COMPLETION_PROVIDER (object);
FoundryCompletionProviderPrivate *priv = foundry_completion_provider_get_instance_private (self);
switch (prop_id)
{
case PROP_DOCUMENT:
g_weak_ref_set (&priv->document_wr, g_value_get_object (value));
break;
case PROP_PLUGIN_INFO:
priv->plugin_info = g_value_dup_object (value);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
}
}
static void
foundry_completion_provider_class_init (FoundryCompletionProviderClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS (klass);
object_class->dispose = foundry_completion_provider_dispose;
object_class->finalize = foundry_completion_provider_finalize;
object_class->get_property = foundry_completion_provider_get_property;
object_class->set_property = foundry_completion_provider_set_property;
klass->complete = foundry_completion_provider_real_complete;
klass->refilter = foundry_completion_provider_real_refilter;
properties[PROP_DOCUMENT] =
g_param_spec_object ("document", NULL, NULL,
FOUNDRY_TYPE_TEXT_DOCUMENT,
(G_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY |
G_PARAM_STATIC_STRINGS));
properties[PROP_PLUGIN_INFO] =
g_param_spec_object ("plugin-ifo", NULL, NULL,
PEAS_TYPE_PLUGIN_INFO,
(G_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY |
G_PARAM_STATIC_STRINGS));
g_object_class_install_properties (object_class, N_PROPS, properties);
}
static void
foundry_completion_provider_init (FoundryCompletionProvider *self)
{
FoundryCompletionProviderPrivate *priv = foundry_completion_provider_get_instance_private (self);
g_weak_ref_init (&priv->document_wr, NULL);
}
/**
* foundry_completion_provider_complete:
* @self: a [class@Foundry.CompletionProvider]
* @request: a [class@Foundry.CompletionRequest]
*
* Asynchronously generate a list of completion items.
*
* Returns: (transfer full): [class@Dex.Future] that resolves to a
* [iface@Gio.ListModel] of [class@Foundry.CompletionProposal] or
* rejects with error.
*/
DexFuture *
foundry_completion_provider_complete (FoundryCompletionProvider *self,
FoundryCompletionRequest *request)
{
dex_return_error_if_fail (FOUNDRY_IS_COMPLETION_PROVIDER (self));
dex_return_error_if_fail (FOUNDRY_IS_COMPLETION_REQUEST (request));
return FOUNDRY_COMPLETION_PROVIDER_GET_CLASS (self)->complete (self, request);
}
/**
* foundry_completion_provider_refilter:
* @self: a [class@Foundry.CompletionProvider]
* @request: a [class@Foundry.CompletionRequest]
* @model: a [iface@Gio.ListModel]
*
* Asynchronously refilter @model or provides an alternate result set.
*
* Returns: (transfer full): [class@Dex.Future] that resolves to a
* [iface@Gio.ListModel] of [class@Foundry.CompletionProposal] or
* rejects with error.
*/
DexFuture *
foundry_completion_provider_refilter (FoundryCompletionProvider *self,
FoundryCompletionRequest *request,
GListModel *model)
{
dex_return_error_if_fail (FOUNDRY_IS_COMPLETION_PROVIDER (self));
dex_return_error_if_fail (FOUNDRY_IS_COMPLETION_REQUEST (request));
dex_return_error_if_fail (G_IS_LIST_MODEL (model));
return FOUNDRY_COMPLETION_PROVIDER_GET_CLASS (self)->refilter (self, request, model);
}
/**
* foundry_completion_provider_get_plugin_info:
* @self: a [class@Foundry.CompletionProvider]
*
* Returns: (transfer none): a [class@Peas.PluginInfo]
*/
PeasPluginInfo *
foundry_completion_provider_get_plugin_info (FoundryCompletionProvider *self)
{
FoundryCompletionProviderPrivate *priv = foundry_completion_provider_get_instance_private (self);
g_return_val_if_fail (FOUNDRY_IS_COMPLETION_PROVIDER (self), NULL);
return priv->plugin_info;
}
gboolean
foundry_completion_provider_is_trigger (FoundryCompletionProvider *self,
const FoundryTextIter *iter,
gunichar ch)
{
g_return_val_if_fail (FOUNDRY_IS_COMPLETION_PROVIDER (self), FALSE);
g_return_val_if_fail (iter != NULL, FALSE);
if (FOUNDRY_COMPLETION_PROVIDER_GET_CLASS (self)->is_trigger)
return FOUNDRY_COMPLETION_PROVIDER_GET_CLASS (self)->is_trigger (self, iter, ch);
return FALSE;
}
/**
* foundry_completion_provider_dup_document:
* @self: a [class@Foundry.CompletionProvider]
*
* Returns: (transfer full):
*/
FoundryTextDocument *
foundry_completion_provider_dup_document (FoundryCompletionProvider *self)
{
FoundryCompletionProviderPrivate *priv = foundry_completion_provider_get_instance_private (self);
g_return_val_if_fail (FOUNDRY_IS_COMPLETION_PROVIDER (self), NULL);
return g_weak_ref_get (&priv->document_wr);
}
|