BSE Interface Reference

/opt/src/beast/bse/bsestorage.h

SYNOPSIS

struct  _BseStorage;
struct  _BseStorageClass;
   
void  bse_storage_add_restorable  (self, object);
gboolean  bse_storage_check_parse_negate  (self);
void  bse_storage_compat_dhchannels  (self, n_channels);
void  bse_storage_compat_dhmixf  (self, mix_freq);
void  bse_storage_compat_dhoscf  (self, osc_freq);
void  bse_storage_compat_dhreset  (self);
void  bse_storage_error  (self, format, ...);
void  bse_storage_finish_parsing  (self);
BseErrorType  bse_storage_flush_fd  (self, fd);
BseErrorType  bse_storage_input_file  (self, file_name);
void  bse_storage_input_text  (self, text, text_name);
const gchar*  bse_storage_item_get_compat_type  (item);
gboolean  bse_storage_match_data_handle  (self, quark);
GTokenType  bse_storage_parse_data_handle  (self, data_handle_p, n_channels_p, mix_freq_p, osc_freq_p);
GTokenType  bse_storage_parse_data_handle_rest  (self, data_handle_p, n_channels_p, mix_freq_p, osc_freq_p);
GTokenType  bse_storage_parse_item_link  (self, from_item, restore_link, data);
void void GTokenType GTokenType  bse_storage_parse_param_value  (self, value, pspec);
GTokenType  bse_storage_parse_rest  (self, context_data, try_statement, user_data);
GTokenType  bse_storage_parse_xinfos  (self, xinfosp);
void  bse_storage_prepare_write  (self, mode);
void  bse_storage_printf  (self, format, ...);
void  bse_storage_put_data_handle  (self, significant_bits, dhandle);
void  bse_storage_put_item_link  (self, from_item, to_item);
void void  bse_storage_put_param  (self, value, pspec);
void  bse_storage_put_xinfos  (self, xinfos);
void  bse_storage_putd  (self, vdouble);
void  bse_storage_putf  (self, vfloat);
void  bse_storage_putr  (self, vreal, hints);
void  bse_storage_reset  (self);
GTokenType  bse_storage_restore_item  (self, item);
void  bse_storage_store_child  (self, item);
void  bse_storage_store_item  (self, item);
void  bse_storage_turn_readable  (self, storage_name);
void void  bse_storage_warn  (self, format, ...);
void void GTokenType  bse_storage_warn_skip  (self, format, ...);

DESCRIPTION

_BseStorage

 /opt/src/beast/bse/bsestorage.h:65
struct _BseStorage
{
  BseObject         parent_instance;
  SfiWStore        *wstore;
  SfiPPool         *stored_items;
  SfiPPool         *referenced_items;
  SfiRStore        *rstore;
  guint             major_version;
  guint             minor_version;
  guint             micro_version;
  GHashTable       *path_table;
  SfiRing          *item_links;
  SfiPPool         *restorable_objects;
  guint             n_dblocks;
  BseStorageDBlock *dblocks;
  gchar            *free_me;
  gfloat            mix_freq;
  gfloat            osc_freq;
  guint             n_channels;
};

_BseStorageClass

 /opt/src/beast/bse/bsestorage.h:89
struct _BseStorageClass
{
  BseObjectClass parent_class;
};

bse_storage_add_restorable

 /opt/src/beast/bse/bsestorage.h:168
void  bse_storage_add_restorable  
(BseStorage *self,
 BseObject  *object);

bse_storage_check_parse_negate

 /opt/src/beast/bse/bsestorage.h:188
gboolean  bse_storage_check_parse_negate  
(BseStorage *self);

bse_storage_compat_dhchannels

 /opt/src/beast/bse/bsestorage.h:101
void  bse_storage_compat_dhchannels  
(BseStorage *self,
 guint       n_channels);

bse_storage_compat_dhmixf

 /opt/src/beast/bse/bsestorage.h:97
void  bse_storage_compat_dhmixf  
(BseStorage *self,
 gfloat      mix_freq);

bse_storage_compat_dhoscf

 /opt/src/beast/bse/bsestorage.h:99
void  bse_storage_compat_dhoscf  
(BseStorage *self,
 gfloat      osc_freq);

bse_storage_compat_dhreset

 /opt/src/beast/bse/bsestorage.h:95
void  bse_storage_compat_dhreset  
(BseStorage *self);

bse_storage_error

 /opt/src/beast/bse/bsestorage.h:153
void  bse_storage_error  
(BseStorage  *self,
 const gchar *format,
 ...);

bse_storage_finish_parsing

 /opt/src/beast/bse/bsestorage.h:169
void  bse_storage_finish_parsing  
(BseStorage *self);

bse_storage_flush_fd

 /opt/src/beast/bse/bsestorage.h:147
BseErrorType  bse_storage_flush_fd  
(BseStorage *self,
 gint        fd);

bse_storage_input_file

 /opt/src/beast/bse/bsestorage.h:111
BseErrorType  bse_storage_input_file  
(BseStorage  *self,
 const gchar *file_name);

bse_storage_input_text

 /opt/src/beast/bse/bsestorage.h:114
void  bse_storage_input_text  
(BseStorage  *self,
 const gchar *text,
 const gchar *text_name);

bse_storage_item_get_compat_type

 /opt/src/beast/bse/bsestorage.h:121
const gchar*  bse_storage_item_get_compat_type  
(BseItem *item);

bse_storage_match_data_handle

 /opt/src/beast/bse/bsestorage.h:176
gboolean  bse_storage_match_data_handle  
(BseStorage *self,
 GQuark      quark);

bse_storage_parse_data_handle

 /opt/src/beast/bse/bsestorage.h:174
GTokenType  bse_storage_parse_data_handle  
(BseStorage     *self,
 GslDataHandle **data_handle_p,
 guint          *n_channels_p,
 gfloat         *mix_freq_p,
 gfloat         *osc_freq_p);

bse_storage_parse_data_handle_rest

 /opt/src/beast/bse/bsestorage.h:181
GTokenType  bse_storage_parse_data_handle_rest  
(BseStorage     *self,
 GslDataHandle **data_handle_p,
 guint          *n_channels_p,
 gfloat         *mix_freq_p,
 gfloat         *osc_freq_p);

bse_storage_parse_item_link

 /opt/src/beast/bse/bsestorage.h:166
GTokenType  bse_storage_parse_item_link  
(BseStorage           *self,
 BseItem              *from_item,
 BseStorageRestoreLink restore_link,
 gpointer              data);
Parse an item link statement and return the expected token if a parsing error occours. Item links are resolved at the end of the parsing stage by calling the user supplied handler restore_link() with the link target amongst its arguments (see BseStorageRestoreLink()).
self: valid BseStorage
from_item: link owner
restore_link: BseStorageRestoreLink handler to be called once the link was resolved
data: user data passed into restore_link()
RETURNS: expected token in case of a parsing error (G_TOKEN_NONE on success)

bse_storage_parse_param_value

 /opt/src/beast/bse/bsestorage.h:162
void void GTokenType GTokenType  bse_storage_parse_param_value  
(BseStorage *self,
 GValue     *value,
 GParamSpec *pspec);

bse_storage_parse_rest

 /opt/src/beast/bse/bsestorage.h:187
GTokenType  bse_storage_parse_rest  
(BseStorage     *self,
 gpointer        context_data,
 BseTryStatement try_statement,
 gpointer        user_data);

bse_storage_parse_xinfos

 /opt/src/beast/bse/bsestorage.h:183
GTokenType  bse_storage_parse_xinfos  
(BseStorage *self,
 gchar    ***xinfosp);

bse_storage_prepare_write

 /opt/src/beast/bse/bsestorage.h:107
void  bse_storage_prepare_write  
(BseStorage    *self,
 BseStorageMode mode);

bse_storage_printf

 /opt/src/beast/bse/bsestorage.h:134
void  bse_storage_printf  
(BseStorage  *self,
 const gchar *format,
 ...);

bse_storage_put_data_handle

 /opt/src/beast/bse/bsestorage.h:143
void  bse_storage_put_data_handle  
(BseStorage    *self,
 guint          significant_bits,
 GslDataHandle *dhandle);

bse_storage_put_item_link

 /opt/src/beast/bse/bsestorage.h:140
void  bse_storage_put_item_link  
(BseStorage *self,
 BseItem    *from_item,
 BseItem    *to_item);

bse_storage_put_param

 /opt/src/beast/bse/bsestorage.h:137
void void  bse_storage_put_param  
(BseStorage   *self,
 const GValue *value,
 GParamSpec   *pspec);

bse_storage_put_xinfos

 /opt/src/beast/bse/bsestorage.h:145
void  bse_storage_put_xinfos  
(BseStorage *self,
 gchar     **xinfos);

bse_storage_putd

 /opt/src/beast/bse/bsestorage.h:128
void  bse_storage_putd  
(BseStorage *self,
 gdouble     vdouble);

bse_storage_putf

 /opt/src/beast/bse/bsestorage.h:126
void  bse_storage_putf  
(BseStorage *self,
 gfloat      vfloat);

bse_storage_putr

 /opt/src/beast/bse/bsestorage.h:131
void  bse_storage_putr  
(BseStorage  *self,
 SfiReal      vreal,
 const gchar *hints);

bse_storage_reset

 /opt/src/beast/bse/bsestorage.h:105
void  bse_storage_reset  
(BseStorage *self);

bse_storage_restore_item

 /opt/src/beast/bse/bsestorage.h:116
GTokenType  bse_storage_restore_item  
(BseStorage *self,
 gpointer    item);

bse_storage_store_child

 /opt/src/beast/bse/bsestorage.h:120
void  bse_storage_store_child  
(BseStorage *self,
 gpointer    item);

bse_storage_store_item

 /opt/src/beast/bse/bsestorage.h:118
void  bse_storage_store_item  
(BseStorage *self,
 gpointer    item);

bse_storage_turn_readable

 /opt/src/beast/bse/bsestorage.h:109
void  bse_storage_turn_readable  
(BseStorage  *self,
 const gchar *storage_name);

bse_storage_warn

 /opt/src/beast/bse/bsestorage.h:156
void void  bse_storage_warn  
(BseStorage  *self,
 const gchar *format,
 ...);

bse_storage_warn_skip

 /opt/src/beast/bse/bsestorage.h:159
void void GTokenType  bse_storage_warn_skip  
(BseStorage  *self,
 const gchar *format,
 ...);