alpine/flagmaint.h

   1 /*
   2  * $Id: flagmaint.h 807 2007-11-09 01:21:33Z hubert@u.washington.edu $
   3  *
   4  * ========================================================================
   5  * Copyright 2006-2007 University of Washington
   6  * Copyright 2013-2020 Eduardo Chappa
   7  *
   8  * Licensed under the Apache License, Version 2.0 (the "License");
   9  * you may not use this file except in compliance with the License.
  10  * You may obtain a copy of the License at
  11  *
  12  *     http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * ========================================================================
  15  */
  16
  17 #ifndef PINE_FLAGMAINT_INCLUDED
  18 #define PINE_FLAGMAINT_INCLUDED
  19
  20
  21 #include "../pith/state.h"
  22
  23
  24 /*
  25  * Structures to control flag maintenance screen
  26  */
  27 struct flag_table {
  28     char     *name;             /* flag's name or keyword's nickname */
  29     HelpType  help;             /* help text */
  30     long      flag;             /* flag tag (i.e., F_DEL ) */
  31     unsigned  set:2;            /* its state (set, unset, unknown) */
  32     unsigned  ukn:1;            /* allow unknown state */
  33     char     *keyword;          /* only for user-defined, could be same as name */
  34     char     *comment;          /* comment about the name, keyword name if there is a nick */
  35 };
  36
  37
  38 struct flag_screen {
  39     char              **explanation;
  40     struct flag_table **flag_table;
  41 };
  42
  43 /*
  44  * Some defs to help keep flag setting straight...
  45  */
  46 #define CMD_FLAG_CLEAR  FALSE
  47 #define CMD_FLAG_SET    TRUE
  48 #define CMD_FLAG_UNKN   2
  49
  50
  51 /* exported prototypes */
  52 int     flag_maintenance_screen(struct pine *, struct flag_screen *);
  53
  54
  55 #endif /* PINE_FLAGMAINT_INCLUDED */