discover: Add configuration methods
[petitboot] / discover / parser.h
index a80d1b5b8df43ccf4cee400ce125395212446025..b738577ff3d9d4a17a41bdecb3a5247774d51ad9 100644 (file)
@@ -1,11 +1,39 @@
 #ifndef _PARSER_H
 #define _PARSER_H
 
+#include <stdbool.h>
+
+#include "device-handler.h"
+
 struct discover_context;
+struct device_handler;
+struct resource;
 
+/**
+ * Our config parser.
+ *
+ * Each parser is responsible for creating discover_boot_options from config
+ * files found on new devices. The boot items discovered during parse will have
+ * 'resources' attached (see @discover_boot_option), which may already be
+ * resolved (in the case of a device-local filename, or a URL), or unresolved
+ * (in the case of a filename on another device).
+ *
+ * If the boot option contains references to unresolved resources, the
+ * device handler will not inform clients about the boot options, as
+ * they're not properly "available" at this stage. The handler will attempt to
+ * resolve them whenever new devices are discovered, by calling the parser's
+ * resolve_resource function. Once a boot option's resources are full resolved,
+ * the option can be sent to clients.
+ */
 struct parser {
-       char *name;
-       int (*parse)(struct discover_context *ctx);
+       char                    *name;
+       enum conf_method        method;
+       const char * const      *filenames;
+       int                     (*parse)(struct discover_context *ctx,
+                                               char *buf, int len);
+       bool                    (*resolve_resource)(
+                                               struct device_handler *handler,
+                                               struct resource *res);
 };
 
 enum generic_icon_type {
@@ -20,8 +48,7 @@ enum generic_icon_type {
 
 void parser_init(void);
 
-void iterate_parsers(struct discover_context *ctx);
-struct boot_option *parse_user_event(struct device *device,
-               struct event *event);
+void iterate_parsers(struct discover_context *ctx, enum conf_method method);
+int parse_user_event(struct discover_context *ctx, struct event *event);
 
 #endif /* _PARSER_H */