document new choose screen properly

[disorder] / lib / macros.h

diff --git a/lib/macros.h b/lib/macros.h
index 0b2dc0859a709ae1b6f57f33c0bac65e26ae71c5..772873c44d5ba68567c435539da99a551ef5fcef 100644 (file)
--- a/lib/macros.h
+++ b/lib/macros.h
@@ -25,6 +25,8 @@
 #ifndef MACROS_H
 #define MACROS_H
 
+struct sink;
+
 /** @brief One node in a macro expansion parse tree */
 struct mx_node {
   /** @brief Next element or NULL at end of list */
@@ -40,10 +42,10 @@ struct mx_node {
   int line;
   
   /** @brief Plain text (if @p type is @ref MX_TEXT) */
-  char *text;
+  const char *text;
 
   /** @brief Expansion name (if @p type is @ref MX_EXPANSION) */
-  char *name;
+  const char *name;
 
   /** @brief Argument count (if @p type is @ref MX_EXPANSION) */
   int nargs;
@@ -62,9 +64,69 @@ const struct mx_node *mx_parse(const char *filename,
                               int line,
                               const char *input,
                               const char *end);
-
 char *mx_dump(const struct mx_node *m);
 
+
+/** @brief Callback for simple expansions
+ * @param nargs Number of arguments
+ * @param args Pointer to array of arguments
+ * @param output Where to send output
+ * @param u User data
+ * @return 0 on success, non-zero on error
+ */
+typedef int mx_simple_callback(int nargs,
+                               char **args,
+                               struct sink *output,
+                               void *u);
+
+/** @brief Callback for magic expansions
+ * @param nargs Number of arguments
+ * @param args Pointer to array of arguments
+ * @param output Where to send output
+ * @param u User data
+ * @return 0 on success, non-zero on error
+ */
+typedef int mx_magic_callback(int nargs,
+                              const struct mx_node **args,
+                              struct sink *output,
+                              void *u);
+
+void mx_register(const char *name,
+                 int min,
+                 int max,
+                 mx_simple_callback *callback);
+void mx_register_magic(const char *name,
+                       int min,
+                       int max,
+                       mx_magic_callback *callback);
+int mx_register_macro(const char *name,
+                      int nargs,
+                      char **args,
+                      const struct mx_node *definition);
+
+void mx_register_builtin(void);
+void mx_search_path(const char *s);
+char *mx_find(const char *name);
+
+int mx_expand_file(const char *path,
+                   struct sink *output,
+                   void *u);
+int mx_expand(const struct mx_node *m,
+              struct sink *output,
+              void *u);
+int mx_expandstr(const struct mx_node *m,
+                 char **sp,
+                 void *u,
+                 const char *what);
+const struct mx_node *mx_rewrite(const struct mx_node *definition,
+                                 hash *h);
+const struct mx_node *mx_rewritel(const struct mx_node *m,
+                                  ...);
+
+int mx_str2bool(const char *s);
+const char *mx_bool2str(int n);
+int mx_bool_result(struct sink *output, int result);
+
 #endif /* MACROS_H */