tests: mark main()'s "argc" as unused
[miniexpect.git] / miniexpect.h
1 /* miniexpect
2  * Copyright (C) 2014-2022 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 <stdio.h>
33 #include <unistd.h>
34
35 #define PCRE2_CODE_UNIT_WIDTH 8
36 #include <pcre2.h>
37
38 /* This handle is created per subprocess that is spawned. */
39 struct mexp_h {
40   int fd;
41   pid_t pid;
42   int timeout;
43   char *buffer;
44   size_t len;
45   size_t alloc;
46   ssize_t next_match;
47   size_t read_size;
48   int pcre_error;
49   FILE *debug_fp;
50   void *user1;
51   void *user2;
52   void *user3;
53 };
54 typedef struct mexp_h mexp_h;
55
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.
63  */
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)
70
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__)
76
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
81
82 /* Close the handle. */
83 extern int mexp_close (mexp_h *h);
84
85 /* Expect. */
86 struct mexp_regexp {
87   int r;
88   const pcre2_code *re;
89   int options;
90 };
91 typedef struct mexp_regexp mexp_regexp;
92
93 enum mexp_status {
94   MEXP_EOF        = 0,
95   MEXP_ERROR      = -1,
96   MEXP_PCRE_ERROR = -2,
97   MEXP_TIMEOUT    = -3,
98 };
99
100 extern int mexp_expect (mexp_h *h, const mexp_regexp *regexps,
101                         pcre2_match_data *match_data);
102
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);
109
110 #endif /* MINIEXPECT_H_ */