configfile.h

Go to the documentation of this file.

/*
 * Copyright (C) 2000-2017 the xine project
 *
 * This file is part of xine, a free video player.
 *
 * xine is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * xine 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
 *
 * config file management
 */

#ifndef HAVE_CONFIGFILE_H
#define HAVE_CONFIGFILE_H

#ifdef __cplusplus
extern "C" {
#endif

#include <pthread.h>

#include <xine.h>

#define CONFIG_FILE_VERSION 2

#define XINE_CONFIG_SECURITY 30


typedef struct cfg_entry_s cfg_entry_t;
typedef struct config_values_s config_values_t;

struct cfg_entry_s {
  cfg_entry_t     *next;
  config_values_t *config;

  char            *key;
  int              type;

  int              exp_level;

  char            *unknown_value;

  char            *str_value;
  char            *str_default;

  int              num_value;
  int              num_default;

  int              range_min;
  int              range_max;  /* also used for enum */

  char           **enum_values;

  char            *description;
  char            *help;

  xine_config_cb_t callback;
  void            *callback_data;
};

struct config_values_s {

  /*
   * register config values
   *
   * these functions return the current value of the
   * registered item, i.e. the default value if it was
   * not found in the config file or the current value
   * from the config file otherwise
   */

  char* (*register_string) (config_values_t *self,
                            const char *key,
                            const char *def_value,
                            const char *description,
                            const char *help,
                            int exp_level,
                            xine_config_cb_t changed_cb,
                            void *cb_data);

  char* (*register_filename) (config_values_t *self,
                              const char *key,
                              const char *def_value,
                              int req_type,
                              const char *description,
                              const char *help,
                              int exp_level,
                              xine_config_cb_t changed_cb,
                              void *cb_data);

  int (*register_range) (config_values_t *self,
                         const char *key,
                         int def_value,
                         int min, int max,
                         const char *description,
                         const char *help,
                         int exp_level,
                         xine_config_cb_t changed_cb,
                         void *cb_data);

  int (*register_enum) (config_values_t *self,
                        const char *key,
                        int def_value,
                        char **values,
                        const char *description,
                        const char *help,
                        int exp_level,
                        xine_config_cb_t changed_cb,
                        void *cb_data);

  int (*register_num) (config_values_t *self,
                       const char *key,
                       int def_value,
                       const char *description,
                       const char *help,
                       int exp_level,
                       xine_config_cb_t changed_cb,
                       void *cb_data);

  int (*register_bool) (config_values_t *self,
                        const char *key,
                        int def_value,
                        const char *description,
                        const char *help,
                        int exp_level,
                        xine_config_cb_t changed_cb,
                        void *cb_data);

  void (*register_entry) (config_values_t *self, cfg_entry_t* entry);

  void (*update_num) (config_values_t *self, const char *key, int value);

  void (*update_string) (config_values_t *self, const char *key, const char *value);

  int (*parse_enum) (const char *str, const char **values);

  cfg_entry_t* (*lookup_entry) (config_values_t *self, const char *key);

  void (*unregister_callback) (config_values_t *self, const char *key);

  void (*dispose) (config_values_t *self);

  void (*set_new_entry_callback) (config_values_t *self, xine_config_cb_t new_entry_cb, void *cb_data);

  void (*unset_new_entry_callback) (config_values_t *self);

  char* (*get_serialized_entry) (config_values_t *self, const char *key);

  char* (*register_serialized_entry) (config_values_t *self, const char *value);

  cfg_entry_t         *first, *last, *cur;

  xine_config_cb_t    new_entry_cb;
  void                *new_entry_cbdata;

  pthread_mutex_t      config_lock;

  int current_version;
};

config_values_t *_x_config_init (void) XINE_MALLOC;

int _x_config_change_opt(config_values_t *config, const char *opt);

void _x_config_unregister_cb_class_d (config_values_t *config, void *callback_data) XINE_PROTECTED;

#ifdef __cplusplus
}
#endif

#endif