vars.h

Idź do dokumentacji tego pliku.

/* $Id$ */

/*
 *  (C) Copyright 2001-2003 Wojtek Kaniewski <wojtekka@irc.pl>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License Version 2 as
 *  published by the Free Software Foundation.
 *
 *  This program 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., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#ifndef __EKG_VARS_H
#define __EKG_VARS_H

#include <glib.h>

#include "dynstuff.h"
#include "plugins.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    VAR_STR,        /* ciąg znaków */
    VAR_INT,        /* liczba całkowita */
    VAR_BOOL,       /* 0/1, tak/nie, yes/no, on/off */
    VAR_MAP,        /* bitmapa */
    VAR_FILE,       /* plik */
    VAR_DIR,        /* katalog */
    VAR_THEME       /* theme */
} variable_class_t;

typedef struct variable_map_t {
    char *label;        /* nazwa wartości */
    int value;      /* wartość */
    int conflicts;      /* wartości, z którymi koliduje */
} variable_map_t;

typedef void (variable_notify_func_t)(const char *);
typedef void (variable_check_func_t)(const char *, const char *);
typedef int (variable_display_func_t)(const char *);

typedef struct variable {
    char *name;     /* nazwa zmiennej */
    plugin_t *plugin;   /* wstyczka obsługująca zmienną */
    int name_hash;      /* hash nazwy zmiennej */
    int type;       /* rodzaj */
    int display;        /* 0 bez wartości, 1 pokazuje, 2 w ogóle */
    void *ptr;      /* wskaźnik do zmiennej */
    variable_check_func_t *check;
                /* funkcja sprawdzająca czy wartość jest
                 * prawidłowa */
    variable_notify_func_t *notify;
                /* funkcja wywoływana po zmianie wartości */
    variable_map_t *map;    /* mapa wartości i etykiet */
    variable_display_func_t *dyndisplay;
                /* funkcja sprawdzająca, czy zmienną można
                 * wyświetlić na liście zmiennych */
} variable_t;

#ifndef EKG2_WIN32_NOFUNCTION

extern GSList *variables;

void variable_init();
void variable_set_default();
variable_t *variable_find(const char *name);
variable_map_t *variable_map(int count, ...);
#define variable_hash ekg_hash

variable_t *variable_add(
    plugin_t *plugin,
    const char *name,
    int type,
    int display,
    void *ptr,
    variable_notify_func_t *notify,
    variable_map_t *map,
    variable_display_func_t *dyndisplay);

int variable_set(const char *name, const char *value);
void variable_help(const char *name);
int variable_remove(plugin_t *plugin, const char *name);

void variables_remove(variable_t *v);
void variables_destroy();

#endif

#ifdef __cplusplus
}
#endif

#endif /* __EKG_VARS_H */

/*
 * Local Variables:
 * mode: c
 * c-file-style: "k&r"
 * c-basic-offset: 8
 * indent-tabs-mode: t
 * End:
 */