199630f85625b69d8d5074e95450e4ac5cd15a67
[nfs-utils.git] / utils / mount / parse_opt.h
1 /*
2  * parse_opt.h -- mount option string parsing helpers
3  *
4  * Copyright (C) 2007 Oracle.  All rights reserved.
5  * Copyright (C) 2007 Chuck Lever <chuck.lever@oracle.com>
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This program 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  * General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public
18  * License along with this program; if not, write to the
19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20  * Boston, MA 021110-1307, USA.
21  *
22  */
23
24 #ifndef _NFS_UTILS_PARSE_OPT_H
25 #define _NFS_UTILS_PARSE_OPT_H
26
27 typedef enum {
28         PO_FAILED = 0,
29         PO_SUCCEEDED = 1,
30 } po_return_t;
31
32 typedef enum {
33         PO_NOT_FOUND = 0,
34         PO_FOUND = 1,
35         PO_BAD_VALUE = 2,
36 } po_found_t;
37
38 typedef enum {
39         PO_KEY1_RIGHTMOST = -1,
40         PO_NEITHER_FOUND = 0,
41         PO_KEY2_RIGHTMOST = 1,
42 } po_rightmost_t;
43
44 struct mount_options;
45
46 struct mount_options *  po_split(char *);
47 void                    po_replace(struct mount_options *,
48                                    struct mount_options *);
49 po_return_t             po_join(struct mount_options *, char **);
50
51 po_return_t             po_append(struct mount_options *, char *);
52 po_found_t              po_contains(struct mount_options *, char *);
53 char *                  po_get(struct mount_options *, char *);
54 po_found_t              po_get_numeric(struct mount_options *,
55                                         char *, long *);
56 po_rightmost_t          po_rightmost(struct mount_options *, char *, char *);
57 po_found_t              po_remove_all(struct mount_options *, char *);
58 void                    po_destroy(struct mount_options *);
59
60 #endif  /* _NFS_UTILS_PARSE_OPT_H */