devspec.en_US/project/recutils/utils/recutl.h

   1 /* -*- mode: C -*-
   2  *
   3  *       File:         recutl.h
   4  *       Date:         Thu Apr 22 17:29:52 2010
   5  *
   6  *       GNU recutils - Common code for the utilities.
   7  *
   8  */
   9
  10 /* Copyright (C) 2010-2019 Jose E. Marchesi */
  11
  12 /* This program is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation, either version 3 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  24  */
  25
  26 #ifndef RECUTL_H
  27 #define RECUTL_H
  28
  29 #include <progname.h>
  30
  31 /*
  32  * Common arguments.
  33  */
  34
  35 #define COMMON_ARGS                             \
  36   HELP_ARG,                                     \
  37   VERSION_ARG
  38
  39 #define COMMON_LONG_ARGS                        \
  40   {"help", no_argument, NULL, HELP_ARG},        \
  41   {"version", no_argument, NULL, VERSION_ARG}
  42
  43 #define COMMON_ARGS_CASES                          \
  44   case HELP_ARG:                                   \
  45     {                                              \
  46       recutl_print_help ();                        \
  47       exit (EXIT_SUCCESS);                         \
  48       break;                                       \
  49     }                                              \
  50   case VERSION_ARG:                                \
  51     {                                              \
  52       recutl_print_version ();                     \
  53       exit (EXIT_SUCCESS);                         \
  54       break;                                       \
  55     }
  56
  57 /*
  58  * Record selection arguments.
  59  */
  60
  61 #define RECORD_SELECTION_ARGS                   \
  62   TYPE_ARG,                                     \
  63   EXPRESSION_ARG,                               \
  64   QUICK_ARG,                                    \
  65   NUM_ARG,                                      \
  66   INSENSITIVE_ARG,                              \
  67   RANDOM_ARG
  68
  69 #define RECORD_SELECTION_LONG_ARGS                                     \
  70    {"type", required_argument, NULL, TYPE_ARG},                        \
  71    {"expression", required_argument, NULL, EXPRESSION_ARG},            \
  72    {"quick", required_argument, NULL, QUICK_ARG},                      \
  73    {"number", required_argument, NULL, NUM_ARG},                       \
  74    {"case-insensitive", no_argument, NULL, INSENSITIVE_ARG},           \
  75    {"random", required_argument, NULL, RANDOM_ARG}
  76
  77 #define RECORD_SELECTION_SHORT_ARGS             \
  78    "it:e:n:q:m:"
  79
  80 #define RECORD_SELECTION_ARGS_CASES                            \
  81     case TYPE_ARG:                                             \
  82     case 't':                                                  \
  83       {                                                        \
  84         recutl_type = xstrdup (optarg);                        \
  85         if (!rec_field_name_p (recutl_type))                   \
  86           {                                                    \
  87              recutl_fatal ("invalid record type %s\n",         \
  88                            recutl_type);                       \
  89           }                                                    \
  90         break;                                                 \
  91       }                                                        \
  92     case EXPRESSION_ARG:                                       \
  93     case 'e':                                                  \
  94       {                                                        \
  95         if (recutl_num_indexes() != 0)                         \
  96           {                                                    \
  97             recutl_fatal (_("cannot specify -e and also -n\n"));\
  98           }                                                    \
  99                                                                \
 100         if (recutl_quick_str)                                  \
 101           {                                                    \
 102             recutl_fatal (_("cannot specify -e and also -q\n"));\
 103           }                                                    \
 104                                                                \
 105          recutl_sex_str = xstrdup (optarg);                    \
 106                                                                \
 107          /* Compile the search expression.  */                 \
 108          if (recutl_sex_str)                                   \
 109           {                                                    \
 110             recutl_sex = rec_sex_new (recutl_insensitive);     \
 111             if (!rec_sex_compile (recutl_sex, recutl_sex_str)) \
 112              {                                                 \
 113                recutl_fatal(_("invalid selection expression\n"));       \
 114              }                                                 \
 115           }                                                    \
 116                                                                \
 117          break;                                                \
 118       }                                                        \
 119       case NUM_ARG:                                            \
 120       case 'n':                                                \
 121       {                                                        \
 122                                                                \
 123          if (recutl_sex)                                       \
 124           {                                                    \
 125              recutl_fatal(_("cannot specify -n and also -e\n"));\
 126           }                                                    \
 127                                                                \
 128         if (recutl_quick_str)                                  \
 129           {                                                    \
 130              recutl_fatal(_("cannot specify -n and also -q\n"));\
 131           }                                                    \
 132                                                                \
 133         if (recutl_num_indexes() != 0)                         \
 134           {                                                    \
 135              recutl_fatal ("please specify just one -n\n");    \
 136           }                                                    \
 137                                                                \
 138         if (!recutl_index_list_parse (optarg))                 \
 139           {                                                    \
 140             recutl_fatal (_("invalid list of indexes in -n\n")); \
 141           }                                                    \
 142                                                                \
 143           break;                                               \
 144       }                                                        \
 145       case RANDOM_ARG:                                         \
 146       case 'm':                                                \
 147       {                                                        \
 148         if (recutl_sex)                                        \
 149           {                                                    \
 150              recutl_fatal (_("cannot specify -m and also -e\n"));\
 151           }                                                    \
 152                                                                \
 153         if (recutl_quick_str)                                  \
 154           {                                                    \
 155              recutl_fatal (_("cannot specify -m and also -q\n"));\
 156           }                                                    \
 157                                                                \
 158         if (recutl_num_indexes() != 0)                         \
 159           {                                                    \
 160              recutl_fatal (_("cannot specify -m and also -n\n"));\
 161           }                                                    \
 162                                                                \
 163         if (recutl_random)                                     \
 164           {                                                    \
 165              recutl_fatal ("please specify just one -m\n");    \
 166           }                                                    \
 167                                                                \
 168         {                                                      \
 169           char *end;                                           \
 170           long int li = strtol (optarg, &end, 0);              \
 171           if (*end != '\0')                                    \
 172             {                                                  \
 173               recutl_fatal ("invalid number in -m\n");         \
 174             }                                                  \
 175                                                                \
 176           recutl_random = li;                                  \
 177         }                                                      \
 178                                                                \
 179         break;                                                 \
 180       }                                                        \
 181       case QUICK_ARG:                                          \
 182       case 'q':                                                \
 183       {                                                        \
 184          if (recutl_sex)                                       \
 185           {                                                    \
 186              recutl_fatal (_("cannot specify -e and also -n\n"));\
 187           }                                                    \
 188         if (recutl_num_indexes() != 0)                         \
 189           {                                                    \
 190             recutl_fatal (_("cannot specify -e and also -n\n"));\
 191           }                                                    \
 192                                                                \
 193         recutl_quick_str = xstrdup (optarg);                   \
 194         break;                                                 \
 195       }                                                        \
 196       case INSENSITIVE_ARG:                                    \
 197       case 'i':                                                \
 198       {                                                        \
 199           recutl_insensitive = true;                           \
 200           break;                                               \
 201       }
 202
 203 #if defined REC_CRYPT_SUPPORT
 204 #  define ENCRYPTION_SHORT_ARGS "s:"
 205 #else
 206 #  define ENCRYPTION_SHORT_ARGS ""
 207 #endif
 208
 209 /*
 210  * Function prototypes.
 211  */
 212
 213 void recutl_init (char *util_name);
 214 void recutl_print_version (void);
 215 void recutl_print_help_common (void);
 216 void recutl_print_help_footer (void);
 217 void recutl_print_help_record_selection (void);
 218
 219
 220 void recutl_error (const char *fmt, ...);
 221 void recutl_warning (const char *fmt, ...);
 222 void recutl_fatal (const char *fmt, ...);
 223 void recutl_out_of_memory (void);
 224
 225 bool recutl_parse_db_from_file (FILE *in, char *file_name, rec_db_t db);
 226 rec_db_t recutl_build_db (int argc, char **argv);
 227
 228 rec_db_t recutl_read_db_from_file (char *file_name);
 229 void recutl_write_db_to_file (rec_db_t db, char *file_name);
 230
 231 bool recutl_file_is_writable (char *file_name);
 232
 233 char *recutl_read_file (char *file_name);
 234
 235 void recutl_check_integrity (rec_db_t db,
 236                              bool verbose_p,
 237                              bool external_p);
 238
 239 bool recutl_yesno (char *prompt);
 240
 241 bool recutl_interactive (void);
 242
 243 char *recutl_getpass (bool asktwice);
 244
 245 /* Parse a list of indexes from the given string and set the internal
 246    recutl_indexes accordingly.  Return true if a list was found in the
 247    string.  Return false otherwise.  */
 248
 249 bool recutl_index_list_parse (const char *str);
 250
 251 /* Return the number of indexes in the internal recutl_indexes data
 252    structure.  */
 253
 254 size_t recutl_num_indexes (void);
 255
 256 /* Reset the list of indexes to be empty.  */
 257
 258 void recutl_reset_indexes (void);
 259
 260 /* Return the index structure.  */
 261
 262 size_t *recutl_index (void);
 263
 264 #endif /* recutl.h */
 265
 266 /* End of recutl.h */