File: foundry-input.c

package info (click to toggle)
foundry 1.1~beta-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 15,552 kB
  • sloc: ansic: 167,487; xml: 417; makefile: 21; sh: 19; javascript: 10
file content (219 lines) | stat: -rw-r--r-- 5,983 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
214
215
216
217
218
219
/* foundry-input.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-input.h"
#include "foundry-input-validator.h"

/**
 * FoundryInput:
 *
 * Base class for various types of user input.
 *
 * Since Foundry does not rely on a specific toolkit or platform library
 * input must be abstracted for tooling that requires it. `FoundryInput`
 * is the base class for various types of input which may be requested
 * of the user.
 *
 * Applications should use a platform library that can convert these
 * input requests into an interface.
 */

typedef struct
{
  char                  *subtitle;
  char                  *title;
  FoundryInputValidator *validator;
} FoundryInputPrivate;

enum {
  PROP_0,
  PROP_SUBTITLE,
  PROP_TITLE,
  PROP_VALIDATOR,
  N_PROPS
};

G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE (FoundryInput, foundry_input, G_TYPE_OBJECT)

static GParamSpec *properties[N_PROPS];

static void
foundry_input_finalize (GObject *object)
{
  FoundryInput *self = (FoundryInput *)object;
  FoundryInputPrivate *priv = foundry_input_get_instance_private (self);

  g_clear_pointer (&priv->title, g_free);
  g_clear_pointer (&priv->subtitle, g_free);
  g_clear_object (&priv->validator);

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

static void
foundry_input_get_property (GObject    *object,
                            guint       prop_id,
                            GValue     *value,
                            GParamSpec *pspec)
{
  FoundryInput *self = FOUNDRY_INPUT (object);

  switch (prop_id)
    {
    case PROP_SUBTITLE:
      g_value_take_string (value, foundry_input_dup_subtitle (self));
      break;

    case PROP_TITLE:
      g_value_take_string (value, foundry_input_dup_title (self));
      break;

    case PROP_VALIDATOR:
      g_value_take_object (value, foundry_input_dup_validator (self));
      break;

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

static void
foundry_input_set_property (GObject      *object,
                            guint         prop_id,
                            const GValue *value,
                            GParamSpec   *pspec)
{
  FoundryInput *self = FOUNDRY_INPUT (object);
  FoundryInputPrivate *priv = foundry_input_get_instance_private (self);

  switch (prop_id)
    {
    case PROP_SUBTITLE:
      priv->subtitle = g_value_dup_string (value);
      break;

    case PROP_TITLE:
      priv->title = g_value_dup_string (value);
      break;

    case PROP_VALIDATOR:
      priv->validator = g_value_dup_object (value);
      break;

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

static void
foundry_input_class_init (FoundryInputClass *klass)
{
  GObjectClass *object_class = G_OBJECT_CLASS (klass);

  object_class->finalize = foundry_input_finalize;
  object_class->get_property = foundry_input_get_property;
  object_class->set_property = foundry_input_set_property;

  properties[PROP_SUBTITLE] =
    g_param_spec_string ("subtitle", NULL, NULL,
                         NULL,
                         (G_PARAM_READWRITE |
                          G_PARAM_CONSTRUCT_ONLY |
                          G_PARAM_STATIC_STRINGS));

  properties[PROP_TITLE] =
    g_param_spec_string ("title", NULL, NULL,
                         NULL,
                         (G_PARAM_READWRITE |
                          G_PARAM_CONSTRUCT_ONLY |
                          G_PARAM_STATIC_STRINGS));

  properties[PROP_VALIDATOR] =
    g_param_spec_object ("validator", NULL, NULL,
                         FOUNDRY_TYPE_INPUT_VALIDATOR,
                         (G_PARAM_READWRITE |
                          G_PARAM_CONSTRUCT_ONLY |
                          G_PARAM_STATIC_STRINGS));

  g_object_class_install_properties (object_class, N_PROPS, properties);
}

static void
foundry_input_init (FoundryInput *self)
{
}

char *
foundry_input_dup_subtitle (FoundryInput *self)
{
  FoundryInputPrivate *priv = foundry_input_get_instance_private (self);

  g_return_val_if_fail (FOUNDRY_IS_INPUT (self), NULL);

  return g_strdup (priv->subtitle);
}

char *
foundry_input_dup_title (FoundryInput *self)
{
  FoundryInputPrivate *priv = foundry_input_get_instance_private (self);

  g_return_val_if_fail (FOUNDRY_IS_INPUT (self), NULL);

  return g_strdup (priv->title);
}

/**
 * foundry_input_validate:
 * @self: a [class@Foundry.Input]
 *
 * Returns: (transfer full): a [class@Dex.Future] that resolves to any
 *   value or rejects with error.
 */
DexFuture *
foundry_input_validate (FoundryInput *self)
{
  FoundryInputPrivate *priv = foundry_input_get_instance_private (self);

  dex_return_error_if_fail (FOUNDRY_IS_INPUT (self));

  if (priv->validator != NULL)
    return foundry_input_validator_validate (priv->validator, self);

  return dex_future_new_true ();
}

/**
 * foundry_input_dup_validator:
 * @self: a [class@Foundry.Input]
 *
 * Returns: (transfer full) (nullable):
 */
FoundryInputValidator *
foundry_input_dup_validator (FoundryInput *self)
{
  FoundryInputPrivate *priv = foundry_input_get_instance_private (self);

  g_return_val_if_fail (FOUNDRY_IS_INPUT (self), NULL);

  return priv->validator ? g_object_ref (priv->validator) : NULL;
}