blob: 8e0a81b075f50fbba33db1c79072ca10c78d12c7 [file] [log] [blame]
Willy Tarreau2ac57182012-04-19 15:24:50 +02001/*
2 * include/proto/arg.h
3 * This file contains functions and macros declarations for generic argument parsing.
4 *
5 * Copyright 2012 Willy Tarreau <w@1wt.eu>
6 *
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation, version 2.1
10 * exclusively.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
22#ifndef _PROTO_ARG_H
23#define _PROTO_ARG_H
24
25#include <types/arg.h>
26
27/* Some macros used to build some arg list. We can declare various argument
28 * combinations from 0 to 7 args using a single 32-bit integer. The first
29 * argument of these macros is always the mandatory number of arguments, and
30 * remaining ones are optional args. Note: ARGM() may also be used to return
31 * the number of mandatory arguments in a mask.
32 */
33#define ARGM(m) \
34 (m & 15)
35
36#define ARG1(m, t1) \
37 (ARGM(m) + (ARGT_##t1 << 4))
38
39#define ARG2(m, t1, t2) \
40 (ARG1(m, t1) + (ARGT_##t2 << 8))
41
42#define ARG3(m, t1, t2, t3) \
43 (ARG2(m, t1, t2) + (ARGT_##t3 << 12))
44
45#define ARG4(m, t1, t2, t3, t4) \
46 (ARG3(m, t1, t2, t3) + (ARGT_##t4 << 16))
47
48#define ARG5(m, t1, t2, t3, t4, t5) \
49 (ARG4(m, t1, t2, t3, t4) + (ARGT_##t5 << 20))
50
51#define ARG6(m, t1, t2, t3, t4, t5, t6) \
52 (ARG5(m, t1, t2, t3, t4, t5) + (ARGT_##t6 << 24))
53
54#define ARG7(m, t1, t2, t3, t4, t5, t6, t7) \
55 (ARG6(m, t1, t2, t3, t4, t5, t6) + (ARGT_##t7 << 28))
56
Willy Tarreau2e845be2012-10-19 19:49:09 +020057/* This dummy arg list may be used by default when no arg is found, it helps
58 * parsers by removing pointer checks.
59 */
60extern struct arg empty_arg_list[8];
61
Willy Tarreau2ac57182012-04-19 15:24:50 +020062int make_arg_list(const char *in, int len, unsigned int mask, struct arg **argp,
63 char **err_msg, const char **err_ptr, int *err_arg);
64
65#endif /* _PROTO_ARG_H */
66
67/*
68 * Local variables:
69 * c-indent-level: 8
70 * c-basic-offset: 8
71 * End:
72 */