cmdline: add a new 'file' token
[libcmdline.git] / src / lib / cmdline_parse_file.h
1 /*
2  * Copyright (c) 2009, Olivier MATZ <zer0@droids-corp.org>
3  * All rights reserved.
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  *
7  *     * Redistributions of source code must retain the above copyright
8  *       notice, this list of conditions and the following disclaimer.
9  *     * Redistributions in binary form must reproduce the above copyright
10  *       notice, this list of conditions and the following disclaimer in the
11  *       documentation and/or other materials provided with the distribution.
12  *     * Neither the name of the University of California, Berkeley nor the
13  *       names of its contributors may be used to endorse or promote products
14  *       derived from this software without specific prior written permission.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27
28 #ifndef _PARSE_FILE_H_
29 #define _PARSE_FILE_H_
30
31 #include "cmdline_parse.h"
32
33 /* size of a parsed file */
34 #define FILENAME_SIZE CMDLINE_MAX_TOKEN_SIZE
35
36 typedef char cmdline_filename_t[FILENAME_SIZE];
37
38 #define PARSE_FILE_F_CREATE    0x01 /* file does not necessarilly exist */
39 #define PARSE_FILE_F_DIRECTORY 0x02 /* must be a directory */
40 struct cmdline_token_file_data {
41         int flags;
42 };
43
44 struct cmdline_token_file {
45         struct cmdline_token_hdr hdr;
46         struct cmdline_token_file_data file_data;
47 };
48 typedef struct cmdline_token_file cmdline_parse_token_file_t;
49
50 extern struct cmdline_token_ops cmdline_token_file_ops;
51
52 #define TOKEN_FILE_INITIALIZER(structure, field, node_flags)    \
53 {                                                               \
54         .hdr = {                                                \
55                 .ops = &cmdline_token_file_ops,                 \
56                 .offset = offsetof(structure, field),           \
57         },                                                      \
58         .file_data = {                                          \
59                 .flags = node_flags,                            \
60         },                                                      \
61 }
62
63 #endif /* _PARSE_FILE_H_ */