Improved robustness of axis implementation
[pspp-builds.git] / lib / gtksheet / psppire-axis-impl.c
1 /* PSPPIRE - a graphical user interface for PSPP.
2    Copyright (C) 2008  Free Software Foundation
3
4    This program is free software: you can redistribute it and/or modify
5    it under the terms of the GNU General Public License as published by
6    the Free Software Foundation, either version 3 of the License, or
7    (at your option) any later version.
8
9    This program is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12    GNU General Public License for more details.
13
14    You should have received a copy of the GNU General Public License
15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
16
17 #include <config.h>
18 #include <string.h>
19 #include <stdlib.h>
20
21 #include <libpspp/tower.h>
22 #include <libpspp/pool.h>
23 #include "psppire-axis-impl.h"
24 #include <math.h>
25
26
27 /* --- prototypes --- */
28 static void psppire_axis_impl_class_init (PsppireAxisImplClass  *class);
29 static void psppire_axis_impl_init      (PsppireAxisImpl                *axis);
30 static void psppire_axis_impl_finalize   (GObject               *object);
31
32
33 /* --- variables --- */
34 static GObjectClass     *parent_class = NULL;
35
36
37 struct axis_node
38 {
39   struct tower_node pixel_node;
40   struct tower_node unit_node;
41 };
42
43 static gint
44 unit_at_pixel (const PsppireAxis *axis, glong pixel)
45 {
46   PsppireAxisImpl *a = PSPPIRE_AXIS_IMPL (axis);
47
48   unsigned long int start;
49   struct tower_node *n;
50   struct axis_node *an;
51   gfloat fraction;
52
53   g_return_val_if_fail (pixel >= 0, -1);
54
55   n = tower_lookup (&a->pixel_tower, pixel, &start);
56   an = tower_data (n, struct axis_node, pixel_node);
57
58   fraction = (pixel - start) / (gfloat) tower_node_get_size (&an->pixel_node);
59
60   return  tower_node_get_level (&an->unit_node)
61     + fraction * tower_node_get_size (&an->unit_node);
62 }
63
64
65 static gint
66 unit_count (const PsppireAxis *axis)
67 {
68   PsppireAxisImpl *a = PSPPIRE_AXIS_IMPL (axis);
69
70   return tower_height (&a->unit_tower);
71 }
72
73
74 /* Returns the pixel at the start of UNIT */
75 static glong
76 start_pixel (const PsppireAxis *axis, gint unit)
77 {
78   gfloat fraction;
79   PsppireAxisImpl *a = PSPPIRE_AXIS_IMPL (axis);
80   struct tower_node *n ;
81   struct axis_node *an;
82
83   unsigned long int start;
84
85   if ( unit < 0)
86     return -1;
87
88   if ( unit >= unit_count (axis))
89     return -1;
90
91   n = tower_lookup (&a->unit_tower, unit, &start);
92
93   an = tower_data (n, struct axis_node, unit_node);
94
95   fraction = (unit - start) / (gfloat) tower_node_get_size (&an->unit_node);
96
97   return  tower_node_get_level (&an->pixel_node) +
98     nearbyintf (fraction * tower_node_get_size (&an->pixel_node));
99 }
100
101
102 static gint
103 unit_size (const PsppireAxis *axis, gint unit)
104 {
105   PsppireAxisImpl *a = PSPPIRE_AXIS_IMPL (axis);
106   struct tower_node *n ;
107   struct axis_node *an;
108
109   unsigned long int start;
110
111   if ( unit < 0)
112     return 0;
113
114   if ( unit >= unit_count (axis))
115     return 0;
116
117   n = tower_lookup (&a->unit_tower, unit, &start);
118
119   an = tower_data (n, struct axis_node, unit_node);
120
121   return nearbyintf (tower_node_get_size (&an->pixel_node)
122                      / (float) tower_node_get_size (&an->unit_node));
123 }
124
125
126 static glong
127 total_size (const PsppireAxis *axis)
128 {
129   PsppireAxisImpl *a = PSPPIRE_AXIS_IMPL (axis);
130
131   return tower_height (&a->pixel_tower);
132 }
133
134
135
136
137 static void
138 psppire_impl_iface_init (PsppireAxisIface *iface)
139 {
140   iface->unit_size = unit_size;
141   iface->unit_count = unit_count;
142   iface->start_pixel = start_pixel;
143   iface->unit_at_pixel = unit_at_pixel;
144   iface->total_size = total_size;
145 }
146
147 /* --- functions --- */
148 /**
149  * psppire_axis_impl_get_type:
150  * @returns: the type ID for accelerator groups.
151  */
152 GType
153 psppire_axis_impl_get_type (void)
154 {
155   static GType object_type = 0;
156
157   if (!object_type)
158     {
159       static const GTypeInfo object_info = {
160         sizeof (PsppireAxisImplClass),
161         (GBaseInitFunc) NULL,
162         (GBaseFinalizeFunc) NULL,
163         (GClassInitFunc) psppire_axis_impl_class_init,
164         NULL,   /* class_finalize */
165         NULL,   /* class_data */
166         sizeof (PsppireAxisImpl),
167         0,      /* n_preallocs */
168         (GInstanceInitFunc) psppire_axis_impl_init,
169       };
170
171       static const GInterfaceInfo interface_info =
172       {
173         (GInterfaceInitFunc) psppire_impl_iface_init,
174         NULL,
175         NULL
176       };
177
178
179       object_type = g_type_register_static (G_TYPE_PSPPIRE_AXIS,
180                                             "PsppireAxisImpl",
181                                             &object_info, 0);
182
183
184       g_type_add_interface_static (object_type,
185                                    PSPPIRE_TYPE_AXIS_IFACE,
186                                    &interface_info);
187     }
188
189   return object_type;
190 }
191
192 static void
193 psppire_axis_impl_class_init (PsppireAxisImplClass *class)
194 {
195   GObjectClass *object_class = G_OBJECT_CLASS (class);
196   parent_class = g_type_class_peek_parent (class);
197
198   object_class->finalize = psppire_axis_impl_finalize;
199 }
200
201
202 static void
203 psppire_axis_impl_init (PsppireAxisImpl *axis)
204 {
205   tower_init (&axis->pixel_tower);
206   tower_init (&axis->unit_tower);
207
208   axis->pool = pool_create ();
209 }
210
211
212 static void
213 psppire_axis_impl_finalize (GObject *object)
214 {
215   PsppireAxisImpl *a = PSPPIRE_AXIS_IMPL (object);
216   pool_destroy (a->pool);
217
218   G_OBJECT_CLASS (parent_class)->finalize (object);
219 }
220
221 /**
222  * psppire_axis_impl_new:
223  * @returns: a new #PsppireAxisImpl object
224  *
225  * Creates a new #PsppireAxisImpl.
226  */
227 PsppireAxisImpl*
228 psppire_axis_impl_new (void)
229 {
230   return g_object_new (G_TYPE_PSPPIRE_AXIS_IMPL, NULL);
231 }
232
233
234 \f
235
236 void
237 psppire_axis_impl_append (PsppireAxisImpl *a, gint size)
238 {
239   psppire_axis_impl_append_n (a, 1, size);
240 }
241
242
243 void
244 psppire_axis_impl_append_n (PsppireAxisImpl *a, gint n_units, gint size)
245 {
246   struct axis_node *node;
247
248   g_return_if_fail (n_units > 0);
249
250   node = pool_alloc (a->pool, sizeof *node);
251
252   tower_insert (&a->unit_tower, n_units, &node->unit_node, NULL);
253   tower_insert (&a->pixel_tower, size * n_units, &node->pixel_node, NULL);
254 }
255
256
257 /* Split the node of both towers at POSN */
258 static void
259 split (PsppireAxisImpl *a, gint posn)
260 {
261   unsigned long int existing_unit_size;
262   unsigned long int existing_pixel_size;
263   unsigned long int start;
264   gfloat fraction;
265   struct axis_node *new_node ;
266   struct tower_node *n;
267   struct axis_node *existing_node;
268
269   g_return_if_fail (posn <= tower_height (&a->unit_tower));
270
271   /* Nothing needs to be done */
272   if ( posn == 0 || posn  == tower_height (&a->unit_tower))
273     return;
274
275   n = tower_lookup (&a->unit_tower, posn, &start);
276
277   existing_node = tower_data (n, struct axis_node, unit_node);
278
279   /* Nothing needs to be done, if the range element is already split here */
280   if ( posn - start == 0)
281     return;
282
283   existing_unit_size = tower_node_get_size (&existing_node->unit_node);
284   existing_pixel_size = tower_node_get_size (&existing_node->pixel_node);
285
286   fraction = (posn - start) / (gfloat) existing_unit_size;
287
288   new_node = pool_alloc (a->pool, sizeof (*new_node));
289
290   tower_resize (&a->unit_tower, &existing_node->unit_node, posn - start);
291
292   tower_resize (&a->pixel_tower, &existing_node->pixel_node,
293                 nearbyintf (fraction * existing_pixel_size));
294
295   tower_insert (&a->unit_tower,
296                 existing_unit_size - (posn - start),
297                 &new_node->unit_node,
298                 tower_next (&a->unit_tower, &existing_node->unit_node));
299
300
301   tower_insert (&a->pixel_tower,
302                 nearbyintf (existing_pixel_size * (1 - fraction)),
303                 &new_node->pixel_node,
304                 tower_next (&a->pixel_tower, &existing_node->pixel_node));
305 }
306
307
308 /* Insert a new unit of size SIZE before POSN */
309 void
310 psppire_axis_impl_insert (PsppireAxisImpl *a, gint posn, gint size)
311 {
312   struct axis_node *before = NULL;
313   struct axis_node *new_node = pool_alloc (a->pool, sizeof (*new_node));
314
315   if ( posn > 0)
316     {
317       unsigned long int start = 0;
318       struct tower_node *n;
319
320       split (a, posn);
321
322       n = tower_lookup (&a->unit_tower, posn, &start);
323       g_assert (posn == start);
324
325       before = tower_data (n, struct axis_node, unit_node);
326     }
327
328   tower_insert (&a->unit_tower,
329                 1,
330                 &new_node->unit_node,
331                 before ? &before->unit_node : NULL);
332
333
334   tower_insert (&a->pixel_tower,
335                 size,
336                 &new_node->pixel_node,
337                 before ? &before->pixel_node : NULL);
338 }
339
340
341 /* Make the element at POSN singular.
342    Return a pointer to the node for this element */
343 static struct axis_node *
344 make_single (PsppireAxisImpl *a, gint posn)
345 {
346   unsigned long int start;
347   struct tower_node *n;
348
349   g_return_val_if_fail (posn < tower_height (&a->unit_tower), NULL);
350
351   n = tower_lookup (&a->unit_tower, posn, &start);
352
353   if ( 1 != tower_node_get_size (n))
354     {
355       split (a, posn + 1);
356       n = tower_lookup (&a->unit_tower, posn, &start);
357
358       if ( 1 != tower_node_get_size (n))
359         {
360           split (a, posn);
361           n = tower_lookup (&a->unit_tower, posn, &start);
362         }
363     }
364
365   g_assert (1 == tower_node_get_size (n));
366
367
368   return tower_data (n, struct axis_node, unit_node);
369 }
370
371 void
372 psppire_axis_impl_resize (PsppireAxisImpl *a, gint posn, gint size)
373 {
374   struct axis_node *an;
375   g_return_if_fail (posn >= 0);
376
377   /* Silently ignore this request if the position is greater than the number of
378      units in the axis */
379   if (posn >= tower_height (&a->unit_tower))
380     return ;
381
382   an = make_single (a, posn);
383
384   tower_resize (&a->pixel_tower, &an->pixel_node, size);
385 }
386
387
388
389 void
390 psppire_axis_impl_clear (PsppireAxisImpl *a)
391 {
392   pool_destroy (a->pool);
393   a->pool = pool_create ();
394
395   tower_init (&a->pixel_tower);
396   tower_init (&a->unit_tower);
397 }
398
399
400
401 void
402 psppire_axis_impl_delete (PsppireAxisImpl *a, gint first, gint n_units)
403 {
404   gint i;
405   g_warning ("%s FIXME: This is an inefficient implementation", __FUNCTION__);
406
407   g_return_if_fail (first + n_units < tower_height (&a->unit_tower));
408
409   for (i = first; i < first + n_units; ++i)
410     {
411       struct axis_node *an = make_single (a, first);
412
413       tower_delete (&a->unit_tower, &an->unit_node);
414       tower_delete (&a->pixel_tower, &an->pixel_node);
415     }
416 }