File: recutl.h

package info (click to toggle)
recutils 1.5-1
  • links: PTS
  • area: main
  • in suites: wheezy
  • size: 10,212 kB
  • sloc: ansic: 55,227; sh: 16,411; lisp: 1,431; yacc: 1,373; makefile: 304; lex: 223; sed: 16
file content (297 lines) | stat: -rw-r--r-- 14,309 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
/* -*- mode: C -*-
 *
 *       File:         recutl.h
 *       Date:         Thu Apr 22 17:29:52 2010
 *
 *       GNU recutils - Common code for the utilities.
 *
 */

/* Copyright (C) 2010, 2011, 2012 Jose E. Marchesi */

/* This program 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 3 of the License, or
 * (at your option) any later version.
 *
 * 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, see <http://www.gnu.org/licenses/>.
 */

#ifndef RECUTL_H
#define RECUTL_H

#include <progname.h>

/*
 * Common arguments.
 */

#define COMMON_ARGS                             \
  HELP_ARG,                                     \
  VERSION_ARG

#define COMMON_LONG_ARGS                        \
  {"help", no_argument, NULL, HELP_ARG},        \
  {"version", no_argument, NULL, VERSION_ARG}

#define COMMON_ARGS_CASES                          \
  case HELP_ARG:                                   \
    {                                              \
      recutl_print_help ();                        \
      exit (EXIT_SUCCESS);                         \
      break;                                       \
    }                                              \
  case VERSION_ARG:                                \
    {                                              \
      recutl_print_version ();                     \
      exit (EXIT_SUCCESS);                         \
      break;                                       \
    }

/*
 * Record selection arguments.
 */

#define RECORD_SELECTION_ARGS                   \
  TYPE_ARG,                                     \
  EXPRESSION_ARG,                               \
  QUICK_ARG,                                    \
  NUM_ARG,                                      \
  INSENSITIVE_ARG,                              \
  RANDOM_ARG

#define RECORD_SELECTION_LONG_ARGS                                     \
   {"type", required_argument, NULL, TYPE_ARG},                        \
   {"expression", required_argument, NULL, EXPRESSION_ARG},            \
   {"quick", required_argument, NULL, QUICK_ARG},                      \
   {"num", required_argument, NULL, NUM_ARG},                          \
   {"case-insensitive", no_argument, NULL, INSENSITIVE_ARG},           \
   {"random", required_argument, NULL, RANDOM_ARG}

#define RECORD_SELECTION_SHORT_ARGS             \
   "it:e:n:q:m:"

#define RECORD_SELECTION_ARGS_CASES                            \
    case TYPE_ARG:                                             \
    case 't':                                                  \
      {                                                        \
        recutl_type = xstrdup (optarg);                        \
        if (!rec_field_name_part_str_p (recutl_type))          \
          {                                                    \
             recutl_fatal ("invalid record type %s\n",         \
                           recutl_type);                       \
          }                                                    \
        break;                                                 \
      }                                                        \
    case EXPRESSION_ARG:                                       \
    case 'e':                                                  \
      {                                                        \
        if (recutl_num_indexes() != 0)                         \
          {                                                    \
            recutl_fatal (_("cannot specify -e and also -n\n"));\
          }                                                    \
                                                               \
        if (recutl_quick_str)                                  \
          {                                                    \
             fprintf (stderr,                                  \
                      "%s: cannot specify -e and also -q.\n",  \
                      program_name);                           \
             exit (EXIT_FAILURE);                              \
          }                                                    \
                                                               \
         recutl_sex_str = xstrdup (optarg);                    \
                                                               \
         /* Compile the search expression.  */                 \
         if (recutl_sex_str)                                   \
          {                                                    \
            recutl_sex = rec_sex_new (recutl_insensitive);     \
            if (!rec_sex_compile (recutl_sex, recutl_sex_str)) \
             {                                                 \
                fprintf (stderr,                               \
                         "%s: error: invalid selection expression.\n",\
                         program_name);                        \
                exit (EXIT_FAILURE);                           \
             }                                                 \
          }                                                    \
                                                               \
         break;                                                \
      }                                                        \
      case NUM_ARG:                                            \
      case 'n':                                                \
      {                                                        \
                                                               \
         if (recutl_sex)                                       \
          {                                                    \
             fprintf (stderr,                                  \
                      "%s: cannot specify -n and also -e.\n",  \
                      program_name);                           \
             exit (EXIT_FAILURE);                              \
          }                                                    \
                                                               \
        if (recutl_quick_str)                                  \
          {                                                    \
             fprintf (stderr,                                  \
                      "%s: cannot specify -n and also -q\n",   \
                      program_name);                           \
             exit (EXIT_FAILURE);                              \
          }                                                    \
                                                               \
        if (recutl_num_indexes() != 0)                         \
          {                                                    \
             recutl_fatal ("please specify just one -n\n");    \
          }                                                    \
                                                               \
        if (!recutl_index_list_parse (optarg))                 \
          {                                                    \
            recutl_fatal (_("invalid list of indexes in -n\n")); \
          }                                                    \
                                                               \
          break;                                               \
      }                                                        \
      case RANDOM_ARG:                                         \
      case 'm':                                                \
      {                                                        \
        if (recutl_sex)                                        \
          {                                                    \
             fprintf (stderr,                                  \
                      "%s: cannot specify -m and also -e.\n",  \
                      program_name);                           \
             exit (EXIT_FAILURE);                              \
          }                                                    \
                                                               \
        if (recutl_quick_str)                                  \
          {                                                    \
             fprintf (stderr,                                  \
                      "%s: cannot specify -m and also -q\n",   \
                      program_name);                           \
             exit (EXIT_FAILURE);                              \
          }                                                    \
                                                               \
        if (recutl_num_indexes() != 0)                         \
          {                                                    \
             fprintf (stderr,                                  \
                      "%s: cannot specify -m and also -n\n",   \
                      program_name);                           \
             exit (EXIT_FAILURE);                              \
          }                                                    \
                                                               \
        if (recutl_random)                                     \
          {                                                    \
             recutl_fatal ("please specify just one -m\n");    \
          }                                                    \
                                                               \
        {                                                      \
          char *end;                                           \
          long int li = strtol (optarg, &end, 0);              \
          if (*end != '\0')                                    \
            {                                                  \
              recutl_fatal ("invalid number in -m\n");         \
            }                                                  \
                                                               \
          recutl_random = li;                                  \
        }                                                      \
                                                               \
        break;                                                 \
      }                                                        \
      case QUICK_ARG:                                          \
      case 'q':                                                \
      {                                                        \
         if (recutl_sex)                                       \
          {                                                    \
             fprintf (stderr,                                  \
                      "%s: cannot specify -n and also -e.\n",  \
                      program_name);                           \
             exit (EXIT_FAILURE);                              \
          }                                                    \
        if (recutl_num_indexes() != 0)                         \
          {                                                    \
            recutl_fatal (_("cannot specify -e and also -n")); \
          }                                                    \
                                                               \
        recutl_quick_str = xstrdup (optarg);                   \
        break;                                                 \
      }                                                        \
      case INSENSITIVE_ARG:                                    \
      case 'i':                                                \
      {                                                        \
          recutl_insensitive = true;                           \
          break;                                               \
      }

#if defined REC_CRYPT_SUPPORT
#  define ENCRYPTION_SHORT_ARGS "s:"
#else
#  define ENCRYPTION_SHORT_ARGS ""
#endif

/*
 * Function prototypes.
 */

void recutl_init (char *util_name);
void recutl_print_version (void);
void recutl_print_help_common (void);
void recutl_print_help_footer (void);
void recutl_print_help_record_selection (void);


void recutl_error (const char *fmt, ...);
void recutl_warning (const char *fmt, ...);
void recutl_fatal (const char *fmt, ...);

bool recutl_parse_db_from_file (FILE *in, char *file_name, rec_db_t db);
rec_db_t recutl_build_db (int argc, char **argv);
char *recutl_eval_field_expression (rec_fex_t fex,
                                    rec_record_t record,
                                    rec_writer_mode_t mode,
                                    bool print_values_p,
                                    bool print_in_a_row_p,
                                    char *password);

rec_db_t recutl_read_db_from_file (char *file_name);
void recutl_write_db_to_file (rec_db_t db, char *file_name);

char *recutl_read_file (char *file_name);

void recutl_check_integrity (rec_db_t db,
                             bool verbose_p,
                             bool external_p);

bool recutl_yesno (char *prompt);

bool recutl_interactive (void);

/* Parse a list of indexes from the given string and set the internal
   recutl_indexes accordingly.  Return true if a list was found in the
   string.  Return false otherwise.  */

bool recutl_index_list_parse (const char *str);

/* Add a given number of random indexes to the indexes list.  The
   generated random numbers are in the range 0..LIMIT.  */

void recutl_index_add_random (size_t num, size_t limit);

/* Return the number of indexes in the internal recutl_indexes data
   structure.  */

size_t recutl_num_indexes (void);

/* Return whether an index is stored in the internal recutl_indexes
   data structure.  */

bool recutl_index_p (size_t index);

/* Reset the list of indexes to be empty.  */

void recutl_reset_indexes (void);

#endif /* recutl.h */

/* End of recutl.h */