src/list_generic.h

   1 /* Copyright (c) 2010
   2  *      Juergen Weigert (jnweiger@immd4.informatik.uni-erlangen.de)
   3  *      Sadrul Habib Chowdhury (sadrul@users.sourceforge.net)
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 3, or (at your option)
   8  * any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program (see the file COPYING); if not, see
  17  * https://www.gnu.org/licenses/, or contact Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  19  *
  20  ****************************************************************
  21  */
  22
  23 #ifndef SCREEN_LIST_GENERIC_H
  24 #define SCREEN_LIST_GENERIC_H
  25
  26 #include <stdlib.h>
  27
  28 #include "window.h"
  29
  30 typedef struct ListData ListData;
  31 typedef struct ListRow ListRow;
  32 typedef struct GenericList GenericList;
  33
  34 struct ListRow {
  35         void *data;                     /* Some data relevant to this row */
  36         ListRow *next, *prev;           /* doubly linked list */
  37         int y;                          /* -1 if not on display */
  38 };
  39
  40 struct GenericList {
  41         int (*gl_printheader) (ListData *);                     /* Print the header */
  42         int (*gl_printfooter) (ListData *);                     /* Print the footer */
  43         int (*gl_printrow) (ListData *, ListRow *);             /* Print one row */
  44         int (*gl_pinput) (ListData *, char **inp, size_t *len); /* Process input */
  45         int (*gl_freerow) (ListData *, ListRow *);              /* Free data for a row */
  46         int (*gl_free) (ListData *);                            /* Free data for the list */
  47         int (*gl_rebuild) (ListData *);                         /* Rebuild display */
  48         int (*gl_matchrow) (ListData *, ListRow *, const char *);
  49 };
  50
  51 struct ListData {
  52         const char *name;               /* An identifier for the list */
  53         ListRow *root;                  /* The first item in the list */
  54         ListRow *selected;              /* The selected row */
  55         ListRow *top;                   /* The topmost visible row */
  56
  57         const GenericList *list_fn;             /* The functions that deal with the list */
  58
  59         char *search;                   /* The search term, if any */
  60
  61         void *data;                     /* List specific data */
  62 };
  63
  64
  65 ListRow * glist_add_row (ListData *ldata, void *data, ListRow *after);
  66
  67 void glist_remove_rows (ListData *ldata);
  68
  69 void glist_display_all (ListData *list);
  70
  71 ListData * glist_display (const GenericList *list, const char *name);
  72
  73 void glist_abort (void);
  74
  75 void display_displays (void);
  76
  77 void display_license (void);
  78
  79 void display_windows (int onblank, int order, Window *group);
  80
  81 /* global variables */
  82
  83 extern const struct LayFuncs ListLf;
  84
  85 #endif /* SCREEN_LIST_GENERIC_H */