miniexpect.h

   1 /* miniexpect
   2  * Copyright (C) 2014 Red Hat Inc.
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library 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 GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  17  */
  18
  19 /* ** NOTE ** All API documentation is in the manual page.
  20  *
  21  * To read the manual page from the source directory, do:
  22  *    man ./miniexpect.3
  23  * If you have installed miniexpect, do:
  24  *    man 3 miniexpect
  25  *
  26  * The source for the manual page is miniexpect.pod.
  27  */
  28
  29 #ifndef MINIEXPECT_H_
  30 #define MINIEXPECT_H_
  31
  32 #include <unistd.h>
  33
  34 #include <pcre.h>
  35
  36 /* This handle is created per subprocess that is spawned. */
  37 struct mexp_h {
  38   int fd;
  39   pid_t pid;
  40   int timeout;
  41   char *buffer;
  42   size_t len;
  43   size_t alloc;
  44   ssize_t next_match;
  45   size_t read_size;
  46   int pcre_error;
  47   void *user1;
  48   void *user2;
  49   void *user3;
  50 };
  51 typedef struct mexp_h mexp_h;
  52
  53 /* Methods to access (some) fields in the handle. */
  54 #define mexp_get_fd(h) ((h)->fd)
  55 #define mexp_get_pid(h) ((h)->pid)
  56 #define mexp_get_timeout_ms(h) ((h)->timeout)
  57 #define mexp_set_timeout_ms(h, ms) ((h)->timeout = (ms))
  58 /* If secs == -1, then this sets h->timeout to -1000, but the main
  59  * code handles this since it only checks for h->timeout < 0.
  60  */
  61 #define mexp_set_timeout(h, secs) ((h)->timeout = 1000 * (secs))
  62 #define mexp_get_read_size(h) ((h)->read_size)
  63 #define mexp_set_read_size(h, size) ((h)->read_size = (size))
  64 #define mexp_get_pcre_error(h) ((h)->pcre_error)
  65
  66 /* Spawn a subprocess. */
  67 extern mexp_h *mexp_spawnvf (unsigned flags, const char *file, char **argv);
  68 extern mexp_h *mexp_spawnlf (unsigned flags, const char *file, const char *arg, ...);
  69 #define mexp_spawnv(file,argv) mexp_spawnvf (0, (file), (argv))
  70 #define mexp_spawnl(file,...) mexp_spawnlf (0, (file), __VA_ARGS__)
  71
  72 #define MEXP_SPAWN_KEEP_SIGNALS 1
  73 #define MEXP_SPAWN_KEEP_FDS     2
  74 #define MEXP_SPAWN_COOKED_MODE  4
  75 #define MEXP_SPAWN_RAW_MODE     0
  76
  77 /* Close the handle. */
  78 extern int mexp_close (mexp_h *h);
  79
  80 /* Expect. */
  81 struct mexp_regexp {
  82   int r;
  83   const pcre *re;
  84   const pcre_extra *extra;
  85   int options;
  86 };
  87 typedef struct mexp_regexp mexp_regexp;
  88
  89 enum mexp_status {
  90   MEXP_EOF        = 0,
  91   MEXP_ERROR      = -1,
  92   MEXP_PCRE_ERROR = -2,
  93   MEXP_TIMEOUT    = -3,
  94 };
  95
  96 extern int mexp_expect (mexp_h *h, const mexp_regexp *regexps,
  97                         int *ovector, int ovecsize);
  98
  99 /* Sending commands, keypresses. */
 100 extern int mexp_printf (mexp_h *h, const char *fs, ...)
 101   __attribute__((format(printf,2,3)));
 102 extern int mexp_send_interrupt (mexp_h *h);
 103
 104 #endif /* MINIEXPECT_H_ */