lib/buildcmd.h

   1 /* buildcmd.[ch] -- build command lines from a stream of arguments
   2    Copyright (C) 2005 Free Software Foundation, Inc.
   3
   4    This program is free software; you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation; either version 2, or (at your option)
   7    any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program; if not, write to the Free Software
  16    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
  17    USA.
  18 */
  19 /*
  20  * Written by James Youngman.
  21  */
  22 #ifndef INC_BUILDCMD_H
  23 #define INC_BUILDCMD_H 1
  24
  25 struct buildcmd_state
  26 {
  27   /* Number of valid elements in `cmd_argv'.  */
  28   int cmd_argc;                 /* 0 */
  29
  30   /* The list of args being built.  */
  31   char **cmd_argv; /* NULL */
  32
  33   /* Number of elements allocated for `cmd_argv'.  */
  34   int cmd_argv_alloc;
  35
  36   /* Storage for elements of `cmd_argv'.  */
  37   char *argbuf;
  38
  39   /* Number of chars being used in `cmd_argv'.  */
  40   int cmd_argv_chars;
  41
  42   /* Number of chars being used in `cmd_argv' for the initial args..  */
  43   int cmd_initial_argv_chars;
  44
  45   /* User context information. */
  46   void *usercontext;
  47
  48   /* to-do flag. */
  49   int todo;
  50 };
  51
  52
  53 struct buildcmd_control
  54 {
  55   /* If true, exit if lines_per_exec or args_per_exec is exceeded.  */
  56   int exit_if_size_exceeded; /* false */
  57
  58   /* The maximum number of characters that can be used per command line.  */
  59   long arg_max;
  60
  61   /* The length of `replace_pat'.  */
  62   size_t rplen;
  63
  64   /* If nonzero, then instead of putting the args from stdin at
  65    the end of the command argument list, they are each stuck into the
  66    initial args, replacing each occurrence of the `replace_pat' in the
  67    initial args.  */
  68   char *replace_pat;
  69
  70   /* Number of initial arguments given on the command line.  */
  71   int initial_argc;             /* 0 */
  72
  73   /* exec callback. */
  74   int (*exec_callback)(const struct buildcmd_control *, struct buildcmd_state *);
  75
  76   /* If nonzero, the maximum number of nonblank lines from stdin to use
  77      per command line.  */
  78   long lines_per_exec;          /* 0 */
  79
  80   /* The maximum number of arguments to use per command line.  */
  81   long args_per_exec;           /* 1024 */
  82 };
  83
  84
  85
  86
  87 extern void bc_do_insert (const struct buildcmd_control *ctl,
  88                           struct buildcmd_state *state,
  89                           char *arg, size_t arglen,
  90                           const char *prefix, size_t pfxlen,
  91                           const char *linebuf, size_t lblen,
  92                           int initial_args);
  93
  94 extern void bc_push_arg (const struct buildcmd_control *ctl,
  95                          struct buildcmd_state *state,
  96                          const char *arg,    size_t len,
  97                          const char *prefix, size_t pfxlen,
  98                          int initial_args);
  99
 100 extern void bc_init_state(const struct buildcmd_control *ctl,
 101                           struct buildcmd_state *state,
 102                           void *usercontext);
 103 extern void bc_init_controlinfo(struct buildcmd_control *ctl);
 104 extern long bc_get_arg_max(void);
 105 extern void bc_clear_args(const struct buildcmd_control *ctl,
 106                           struct buildcmd_state *state);
 107
 108
 109 #endif