src/gnm-data-cache-source.c

   1 /* vim: set sw=8: -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2 /*
   3  * gnm-data-cache-source.c : GODataCacheSource from a Sheet
   4  *
   5  * Copyright (C) 2008 Jody Goldberg (jody@gnome.org)
   6  *
   7  * This program is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License as
   9  * published by the Free Software Foundation; either version 2 of the
  10  * License, or (at your option) version 3.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301
  20  * USA
  21  */
  22
  23 #include <gnumeric-config.h>
  24 #include "gnm-data-cache-source.h"
  25 #include "go-data-cache-source.h"
  26 #include "go-data-cache.h"
  27
  28
  29 #include <gnumeric.h>
  30 #include <ranges.h>
  31 #include <sheet.h>
  32 #include <expr-name.h>
  33
  34 #include <gsf/gsf-impl-utils.h>
  35 #include "gnm-i18n.h"
  36 #include <string.h>
  37
  38 struct _GnmDataCacheSource {
  39         GObject         base;
  40
  41         Sheet     *src_sheet;
  42         GnmRange   src_range;   /* treated as cache if src_name is non-NULL */
  43         GOString  *src_name;    /* optionally NULL */
  44 };
  45 typedef GObjectClass GnmDataCacheSourceClass;
  46
  47 enum {
  48         PROP_0,
  49         PROP_SHEET,     /* GnmSheet * */
  50         PROP_RANGE,     /* GnmRange */
  51         PROP_NAME       /* char *, optionally NULL */
  52 };
  53
  54 static GODataCache *
  55 gdcs_allocate (GODataCacheSource const *src)
  56 {
  57         GnmDataCacheSource *gdcs = (GnmDataCacheSource *)src;
  58         GODataCache *res;
  59
  60         g_return_val_if_fail (gdcs->src_sheet != NULL, NULL);
  61
  62         if (NULL != gdcs->src_name) {
  63                 GnmParsePos pp;
  64                 GnmEvalPos ep;
  65                 GnmNamedExpr *nexpr = expr_name_lookup (
  66                         parse_pos_init_sheet (&pp, gdcs->src_sheet), gdcs->src_name->str);
  67                 if (NULL != nexpr) {
  68                         GnmValue *v = expr_name_eval (nexpr,
  69                                 eval_pos_init_sheet (&ep, gdcs->src_sheet),
  70                                 GNM_EXPR_EVAL_PERMIT_NON_SCALAR | GNM_EXPR_EVAL_PERMIT_EMPTY);
  71
  72                         if (NULL != v) {
  73                                 value_release (v);
  74                         }
  75                 }
  76         }
  77
  78         res = g_object_new (GO_DATA_CACHE_TYPE, NULL);
  79
  80         return res;
  81 }
  82
  83 static GError *
  84 gdcs_validate (GODataCacheSource const *src)
  85 {
  86         return NULL;
  87 }
  88
  89 static gboolean
  90 gdcs_needs_update (GODataCacheSource const *src)
  91 {
  92         return FALSE;
  93 }
  94
  95 static void
  96 gnm_data_cache_source_init (GnmDataCacheSource *src)
  97 {
  98         src->src_sheet = NULL;
  99         range_init_invalid (&src->src_range);
 100 }
 101
 102 static GObjectClass *parent_klass;
 103 static void
 104 gnm_data_cache_source_finalize (GObject *obj)
 105 {
 106         GnmDataCacheSource *src = (GnmDataCacheSource *)obj;
 107         go_string_unref (src->src_name);
 108         (parent_klass->finalize) (obj);
 109 }
 110 static void
 111 gnm_data_cache_source_set_property (GObject *obj, guint property_id,
 112                                     GValue const *value, GParamSpec *pspec)
 113 {
 114         GnmDataCacheSource *src = (GnmDataCacheSource *)obj;
 115
 116         switch (property_id) {
 117         case PROP_SHEET :
 118                 gnm_data_cache_source_set_sheet (src, g_value_get_object (value));
 119                 break;
 120         case PROP_RANGE :
 121                 gnm_data_cache_source_set_range (src, g_value_get_boxed (value));
 122                 break;
 123         case PROP_NAME :
 124                 gnm_data_cache_source_set_name (src, g_value_get_string (value));
 125                 break;
 126         default:
 127                 G_OBJECT_WARN_INVALID_PROPERTY_ID (obj, property_id, pspec);
 128         }
 129 }
 130
 131 static void
 132 gnm_data_cache_source_get_property (GObject *obj, guint property_id,
 133                                     GValue *value, GParamSpec *pspec)
 134 {
 135         GnmDataCacheSource const *src = (GnmDataCacheSource const *)obj;
 136         switch (property_id) {
 137         case PROP_SHEET :
 138                 g_value_set_object (value, gnm_data_cache_source_get_sheet (src));
 139                 break;
 140         case PROP_RANGE :
 141                 g_value_set_boxed (value, gnm_data_cache_source_get_range (src));
 142                 break;
 143         case PROP_NAME :
 144                 g_value_set_string (value, gnm_data_cache_source_get_name (src));
 145                 break;
 146         default:
 147                 G_OBJECT_WARN_INVALID_PROPERTY_ID (obj, property_id, pspec);
 148         }
 149 }
 150
 151 static void
 152 gnm_data_cache_source_class_init (GnmDataCacheSourceClass *klass)
 153 {
 154         GObjectClass *gobject_class = (GObjectClass *)klass;
 155         gobject_class->set_property     = gnm_data_cache_source_set_property;
 156         gobject_class->get_property     = gnm_data_cache_source_get_property;
 157         gobject_class->finalize         = gnm_data_cache_source_finalize;
 158
 159         g_object_class_install_property (gobject_class, PROP_SHEET,
 160                  g_param_spec_object ("src-sheet",
 161                                       P_("Sheet"),
 162                                       P_("The source sheet"),
 163                         GNM_SHEET_TYPE, GSF_PARAM_STATIC | G_PARAM_READWRITE));
 164         g_object_class_install_property (gobject_class, PROP_RANGE,
 165                  g_param_spec_boxed ("src-range",
 166                                      P_("Range"),
 167                                      P_("Optional named expression to generate a source range"),
 168                         gnm_range_get_type (), GSF_PARAM_STATIC | G_PARAM_READWRITE));
 169         g_object_class_install_property (gobject_class, PROP_NAME,
 170                  g_param_spec_string ("src-name",
 171                                       P_("source-name"),
 172                                       P_("Optional named expression to generate a source range"),
 173                                       NULL,
 174                         GSF_PARAM_STATIC | G_PARAM_READWRITE));
 175
 176         parent_klass = g_type_class_peek_parent (klass);
 177 }
 178
 179 static void
 180 gnm_data_cache_source_iface_init (GODataCacheSourceClass *iface)
 181 {
 182         iface->allocate     = gdcs_allocate;
 183         iface->validate     = gdcs_validate;
 184         iface->needs_update = gdcs_needs_update;
 185 }
 186
 187 GSF_CLASS_FULL (GnmDataCacheSource, gnm_data_cache_source, NULL, NULL,
 188                 gnm_data_cache_source_class_init, NULL,
 189                 gnm_data_cache_source_init, G_TYPE_OBJECT, 0,
 190                 GSF_INTERFACE (gnm_data_cache_source_iface_init, GO_DATA_CACHE_SOURCE_TYPE))
 191
 192 /**
 193  * gnm_data_cache_source_new:
 194  * @src_sheet: #Sheet
 195  * @src_range: #GnmRange
 196  * @src_name: char *, optionally %NULL
 197  *
 198  * Allocates a new Allocates a new #GnmDataCacheSource
 199  *
 200  * Returns : #GODataCacheSource
 201  **/
 202 GODataCacheSource *
 203 gnm_data_cache_source_new (Sheet *src_sheet,
 204                            GnmRange const *src_range, char const *src_name)
 205 {
 206         GnmDataCacheSource *res;
 207
 208         g_return_val_if_fail (IS_SHEET (src_sheet), NULL);
 209         g_return_val_if_fail (src_range != NULL, NULL);
 210
 211         res = g_object_new (GNM_DATA_CACHE_SOURCE_TYPE, NULL);
 212         res->src_sheet = src_sheet;
 213         res->src_range = *src_range;
 214         gnm_data_cache_source_set_name (res, src_name);
 215
 216         return GO_DATA_CACHE_SOURCE (res);
 217 }
 218
 219 /**
 220  * gnm_data_cache_source_get_sheet:
 221  * @src: #GnmDataCacheSource
 222  *
 223  * Returns: (transfer none): the #Sheet for @src.
 224  **/
 225 Sheet *
 226 gnm_data_cache_source_get_sheet (GnmDataCacheSource const *src)
 227 {
 228         g_return_val_if_fail (GNM_IS_DATA_CACHE_SOURCE (src), NULL);
 229         return src->src_sheet;
 230 }
 231
 232 void
 233 gnm_data_cache_source_set_sheet (GnmDataCacheSource *src, Sheet *sheet)
 234 {
 235         g_return_if_fail (GNM_IS_DATA_CACHE_SOURCE (src));
 236 }
 237
 238 GnmRange const  *
 239 gnm_data_cache_source_get_range (GnmDataCacheSource const *src)
 240 {
 241         g_return_val_if_fail (GNM_IS_DATA_CACHE_SOURCE (src), NULL);
 242         return &src->src_range;
 243 }
 244
 245 void
 246 gnm_data_cache_source_set_range (GnmDataCacheSource *src, GnmRange const *r)
 247 {
 248         g_return_if_fail (GNM_IS_DATA_CACHE_SOURCE (src));
 249         src->src_range = *r;
 250 }
 251
 252 char const *
 253 gnm_data_cache_source_get_name  (GnmDataCacheSource const *src)
 254 {
 255         g_return_val_if_fail (GNM_IS_DATA_CACHE_SOURCE (src), NULL);
 256         return src->src_name ? src->src_name->str : NULL;
 257 }
 258
 259 void
 260 gnm_data_cache_source_set_name (GnmDataCacheSource *src, char const *name)
 261 {
 262         GOString *new_val;
 263
 264         g_return_if_fail (GNM_IS_DATA_CACHE_SOURCE (src));
 265
 266         new_val = go_string_new (name);
 267         go_string_unref (src->src_name);
 268         src->src_name =  new_val;
 269 }