2 * Copyright (C) 2014-2022 Red Hat Inc.
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.
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.
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
19 /* ** NOTE ** All API documentation is in the manual page.
21 * To read the manual page from the source directory, do:
23 * If you have installed miniexpect, do:
26 * The source for the manual page is miniexpect.pod.
35 #define PCRE2_CODE_UNIT_WIDTH 8
38 /* This handle is created per subprocess that is spawned. */
54 typedef struct mexp_h mexp_h;
56 /* Methods to access (some) fields in the handle. */
57 #define mexp_get_fd(h) ((h)->fd)
58 #define mexp_get_pid(h) ((h)->pid)
59 #define mexp_get_timeout_ms(h) ((h)->timeout)
60 #define mexp_set_timeout_ms(h, ms) ((h)->timeout = (ms))
61 /* If secs == -1, then this sets h->timeout to -1000, but the main
62 * code handles this since it only checks for h->timeout < 0.
64 #define mexp_set_timeout(h, secs) ((h)->timeout = 1000 * (secs))
65 #define mexp_get_read_size(h) ((h)->read_size)
66 #define mexp_set_read_size(h, size) ((h)->read_size = (size))
67 #define mexp_get_pcre_error(h) ((h)->pcre_error)
68 #define mexp_set_debug_file(h, fp) ((h)->debug_fp = (fp))
69 #define mexp_get_debug_file(h) ((h)->debug_fp)
71 /* Spawn a subprocess. */
72 extern mexp_h *mexp_spawnvf (unsigned flags, const char *file, char **argv);
73 extern mexp_h *mexp_spawnlf (unsigned flags, const char *file, const char *arg, ...);
74 #define mexp_spawnv(file,argv) mexp_spawnvf (0, (file), (argv))
75 #define mexp_spawnl(file,...) mexp_spawnlf (0, (file), __VA_ARGS__)
77 #define MEXP_SPAWN_KEEP_SIGNALS 1
78 #define MEXP_SPAWN_KEEP_FDS 2
79 #define MEXP_SPAWN_COOKED_MODE 4
80 #define MEXP_SPAWN_RAW_MODE 0
82 /* Close the handle. */
83 extern int mexp_close (mexp_h *h);
91 typedef struct mexp_regexp mexp_regexp;
100 extern int mexp_expect (mexp_h *h, const mexp_regexp *regexps,
101 pcre2_match_data *match_data);
103 /* Sending commands, keypresses. */
104 extern int mexp_printf (mexp_h *h, const char *fs, ...)
105 __attribute__((format(printf,2,3)));
106 extern int mexp_printf_password (mexp_h *h, const char *fs, ...)
107 __attribute__((format(printf,2,3)));
108 extern int mexp_send_interrupt (mexp_h *h);
110 #endif /* MINIEXPECT_H_ */