10 #include "device-handler.h"
12 struct discover_context;
13 struct device_handler;
19 * Each parser is responsible for creating discover_boot_options from config
20 * files found on new devices. The boot items discovered during parse will have
21 * 'resources' attached (see @discover_boot_option), which may already be
22 * resolved (in the case of a device-local filename, or a URL), or unresolved
23 * (in the case of a filename on another device).
25 * If the boot option contains references to unresolved resources, the
26 * device handler will not inform clients about the boot options, as
27 * they're not properly "available" at this stage. The handler will attempt to
28 * resolve them whenever new devices are discovered, by calling the parser's
29 * resolve_resource function. Once a boot option's resources are full resolved,
30 * the option can be sent to clients.
34 int (*parse)(struct discover_context *ctx);
35 bool (*resolve_resource)(
36 struct device_handler *handler,
37 struct resource *res);
40 enum generic_icon_type {
48 struct parser_found_file {
51 struct list_item list;
54 #define streq(a,b) (!strcasecmp((a),(b)))
56 void parser_init(void);
58 void iterate_parsers(struct discover_context *ctx);
59 int parse_user_event(struct discover_context *ctx, struct event *event);
61 /* File IO functions for parsers; these should be the only interface that
62 * parsers use to access a device's filesystem.
64 * These are intended for small amounts of data, typically text
65 * configuration and state files. Note that parser_request_file,
66 * and parser_replace_file work only on non-directories.
68 int parser_request_file(struct discover_context *ctx,
69 struct discover_device *dev, const char *filename,
70 char **buf, int *len);
71 int parser_replace_file(struct discover_context *ctx,
72 struct discover_device *dev, const char *filename,
74 int parser_request_url(struct discover_context *ctx, struct pb_url *url,
75 char **buf, int *len);
76 /* parser_stat_path returns 0 if path can be stated on dev by the
77 * running user. Note that this function follows symlinks, like the
78 * stat system call. When the function returns 0, also fills in
79 * statbuf for the path. Returns non-zero on error. This function
80 * does not have the limitations on file size that the functions above
81 * do. Unlike some of the functions above, this function also works
83 int parser_stat_path(struct discover_context *ctx,
84 struct discover_device *dev, const char *path,
85 struct stat *statbuf);
86 /* Function used to list the files on a directory. The dirname should
87 * be relative to the discover context device mount path. It returns
88 * the number of files returned in files or a negative value on error.
90 int parser_scandir(struct discover_context *ctx, const char *dirname,
91 struct dirent ***files, int (*filter)(const struct dirent *),
92 int (*comp)(const struct dirent **, const struct dirent **));
94 /* parser_is_unique - Test a file against a list of known files.
95 * If the file @filename exists and the file is not in @found_list add the
96 * file to @found_list and return true. Use when searching case-insensitive
99 bool parser_is_unique(struct discover_context *ctx, struct discover_device *dev, const char *filename,
100 struct list *found_list);
102 #endif /* _PARSER_H */