File: foundry-action-intent.c

package info (click to toggle)
foundry 1.1~beta-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 15,552 kB
  • sloc: ansic: 167,487; xml: 417; makefile: 21; sh: 19; javascript: 10
file content (213 lines) | stat: -rw-r--r-- 6,023 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
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
/* foundry-action-intent.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-action-intent.h"

/**
 * FoundryActionIntent:
 *
 * Represents an intent to perform an action with optional parameters.
 *
 * FoundryActionIntent provides functionality for representing actions
 * that can be performed within the development environment. It stores
 * an action name and optional target parameters as a GVariant.
 *
 * Since: 1.1
 */

struct _FoundryActionIntent
{
  FoundryIntent  parent_instance;
  char          *action_name;
  GVariant      *action_target;
};

enum {
  PROP_0,
  PROP_ACTION_NAME,
  PROP_ACTION_TARGET,
  N_PROPS
};

G_DEFINE_FINAL_TYPE (FoundryActionIntent, foundry_action_intent, FOUNDRY_TYPE_INTENT)

static GParamSpec *properties[N_PROPS];

static void
foundry_action_intent_finalize (GObject *object)
{
  FoundryActionIntent *self = FOUNDRY_ACTION_INTENT (object);

  g_clear_pointer (&self->action_name, g_free);
  g_clear_pointer (&self->action_target, g_variant_unref);

  G_OBJECT_CLASS (foundry_action_intent_parent_class)->finalize (object);
}

static void
foundry_action_intent_get_property (GObject    *object,
                                    guint       prop_id,
                                    GValue     *value,
                                    GParamSpec *pspec)
{
  FoundryActionIntent *self = FOUNDRY_ACTION_INTENT (object);

  switch (prop_id)
    {
    case PROP_ACTION_NAME:
      g_value_take_string (value, foundry_action_intent_dup_action_name (self));
      break;

    case PROP_ACTION_TARGET:
      g_value_take_variant (value, foundry_action_intent_dup_action_target (self));
      break;

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

static void
foundry_action_intent_set_property (GObject      *object,
                                    guint         prop_id,
                                    const GValue *value,
                                    GParamSpec   *pspec)
{
  FoundryActionIntent *self = FOUNDRY_ACTION_INTENT (object);

  switch (prop_id)
    {
    case PROP_ACTION_NAME:
      self->action_name = g_value_dup_string (value);
      break;

    case PROP_ACTION_TARGET:
      self->action_target = g_value_dup_variant (value);
      break;

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

static void
foundry_action_intent_class_init (FoundryActionIntentClass *klass)
{
  GObjectClass *object_class = G_OBJECT_CLASS (klass);

  object_class->finalize = foundry_action_intent_finalize;
  object_class->get_property = foundry_action_intent_get_property;
  object_class->set_property = foundry_action_intent_set_property;

  properties[PROP_ACTION_NAME] =
    g_param_spec_string ("action-name", NULL, NULL,
                         NULL,
                         (G_PARAM_CONSTRUCT_ONLY |
                          G_PARAM_READWRITE |
                          G_PARAM_STATIC_STRINGS));

  properties[PROP_ACTION_TARGET] =
    g_param_spec_variant ("action-target", NULL, NULL,
                          G_VARIANT_TYPE_ANY,
                          NULL,
                          (G_PARAM_CONSTRUCT_ONLY |
                           G_PARAM_READWRITE |
                           G_PARAM_STATIC_STRINGS));

  g_object_class_install_properties (object_class, N_PROPS, properties);
}

static void
foundry_action_intent_init (FoundryActionIntent *self)
{
}

/**
 * foundry_action_intent_new:
 * @action_name: the name of the action to perform
 * @action_target: (nullable): optional parameters for the action as a GVariant
 *
 * Creates a new [class@Foundry.ActionIntent] for performing an action
 * with optional parameters.
 *
 * If @action_target is floating, its floating reference is sunk.
 *
 * Returns: (transfer full): a new [class@Foundry.ActionIntent]
 *
 * Since: 1.1
 */
FoundryIntent *
foundry_action_intent_new (const char *action_name,
                           GVariant   *action_target)
{
  g_autoptr(GVariant) sink = NULL;

  g_return_val_if_fail (action_name != NULL, NULL);

  if (action_target)
    sink = g_variant_ref_sink (action_target);

  return g_object_new (FOUNDRY_TYPE_ACTION_INTENT,
                       "action-name", action_name,
                       "action-target", action_target,
                       NULL);
}

/**
 * foundry_action_intent_dup_action_name:
 * @self: a [class@Foundry.ActionIntent]
 *
 * Gets a copy of the action name.
 *
 * Returns: (transfer full) (not nullable): a newly allocated copy of the action name
 *
 * Since: 1.1
 */
char *
foundry_action_intent_dup_action_name (FoundryActionIntent *self)
{
  g_return_val_if_fail (FOUNDRY_IS_ACTION_INTENT (self), NULL);

  return g_strdup (self->action_name);
}

/**
 * foundry_action_intent_dup_action_target:
 * @self: a [class@Foundry.ActionIntent]
 *
 * Gets a copy of the action target parameters.
 *
 * Returns: (transfer full) (nullable): a [type@GVariant] with the action target,
 *   or %NULL if no target is set
 *
 * Since: 1.1
 */
GVariant *
foundry_action_intent_dup_action_target (FoundryActionIntent *self)
{
  g_return_val_if_fail (FOUNDRY_IS_ACTION_INTENT (self), NULL);

  if (self->action_target != NULL)
    return g_variant_ref (self->action_target);

  return NULL;
}