ocaml: Fix memory leak in bindings for functions that return buffers.
[libguestfs.git] / fish / fish.h
1 /* libguestfs - guestfish shell
2  * Copyright (C) 2009 Red Hat Inc.
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License along
15  * with this program; if not, write to the Free Software Foundation, Inc.,
16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
17  */
18
19 #ifndef FISH_H
20 #define FISH_H
21
22 #include <guestfs.h>
23
24 #include "fish-cmds.h"
25
26 #ifdef HAVE_GETTEXT
27 #include "gettext.h"
28 #define _(str) dgettext(PACKAGE, (str))
29 #define N_(str) dgettext(PACKAGE, (str))
30 #else
31 #define _(str) str
32 #define N_(str) str
33 #endif
34
35 #if !ENABLE_NLS
36 #undef textdomain
37 #define textdomain(Domainname) /* empty */
38 #undef bindtextdomain
39 #define bindtextdomain(Domainname, Dirname) /* empty */
40 #endif
41
42 #define STREQ(a,b) (strcmp((a),(b)) == 0)
43 #define STRCASEEQ(a,b) (strcasecmp((a),(b)) == 0)
44 #define STRNEQ(a,b) (strcmp((a),(b)) != 0)
45 #define STRCASENEQ(a,b) (strcasecmp((a),(b)) != 0)
46 #define STREQLEN(a,b,n) (strncmp((a),(b),(n)) == 0)
47 #define STRCASEEQLEN(a,b,n) (strncasecmp((a),(b),(n)) == 0)
48 #define STRNEQLEN(a,b,n) (strncmp((a),(b),(n)) != 0)
49 #define STRCASENEQLEN(a,b,n) (strncasecmp((a),(b),(n)) != 0)
50 #define STRPREFIX(a,b) (strncmp((a),(b),strlen((b))) == 0)
51
52 #define TMP_TEMPLATE_ON_STACK(var)                        \
53   const char *ttos_tmpdir = guestfs_tmpdir ();            \
54   char var[strlen (ttos_tmpdir) + 32];                    \
55   sprintf (var, "%s/guestfishXXXXXX", ttos_tmpdir)        \
56
57 /* in fish.c */
58 extern guestfs_h *g;
59 extern int read_only;
60 extern int quit;
61 extern int verbose;
62 extern int command_num;
63 extern int progress_bars;
64 extern int remote_control_csh;
65 extern const char *libvirt_uri;
66 extern int input_lineno;
67
68 extern int issue_command (const char *cmd, char *argv[], const char *pipe, int rc_exit_on_error_flag);
69 extern void list_builtin_commands (void);
70 extern int display_builtin_command (const char *cmd);
71 extern void free_strings (char **argv);
72 extern int count_strings (char *const *argv);
73 extern void print_strings (char *const *argv);
74 extern void print_table (char *const *argv);
75 extern int is_true (const char *str);
76 extern char **parse_string_list (const char *str);
77 extern int xwrite (int fd, const void *buf, size_t len);
78 extern char *win_prefix (const char *path);
79 extern char *file_in (const char *arg);
80 extern void free_file_in (char *s);
81 extern char *file_out (const char *arg);
82 extern void extended_help_message (void);
83 extern void progress_callback (guestfs_h *g, void *data, uint64_t event, int event_handle, int flags, const char *buf, size_t buf_len, const uint64_t *array, size_t array_len);
84
85 /* in cmds.c (auto-generated) */
86 extern void list_commands (void);
87 extern int display_command (const char *cmd);
88 extern int run_action (const char *cmd, size_t argc, char *argv[]);
89
90 /* in completion.c (auto-generated) */
91 extern char **do_completion (const char *text, int start, int end);
92
93 /* in destpaths.c */
94 extern int complete_dest_paths;
95 extern char *complete_dest_paths_generator (const char *text, int state);
96
97 /* in alloc.c */
98 extern int alloc_disk (const char *filename, const char *size,
99                        int add, int sparse);
100 extern int parse_size (const char *str, off_t *size_rtn);
101
102 /* in help.c */
103 extern void display_help (void);
104
105 /* in prep.c */
106 struct prep_data {
107   const struct prep *prep;
108   const char *orig_type_string;
109   char **params;
110 };
111 typedef struct prep_data prep_data;
112 extern void list_prepared_drives (void);
113 extern prep_data *create_prepared_file (const char *type_string,
114                                         const char *filename);
115 extern void prepare_drive (const char *filename, prep_data *data,
116                            const char *device);
117 extern void prep_error (prep_data *data, const char *filename, const char *fs, ...) __attribute__((noreturn, format (printf,3,4)));
118 extern void free_prep_data (void *data);
119
120 /* in prep_lv.c */
121 extern int vg_lv_parse (const char *device, char **vg, char **lv);
122
123 /* in rc.c (remote control) */
124 extern void rc_listen (void) __attribute__((noreturn));
125 extern int rc_remote (int pid, const char *cmd, size_t argc, char *argv[],
126                       int exit_on_error);
127
128 /* in tilde.c */
129 extern char *try_tilde_expansion (char *path);
130
131 /* This should just list all the built-in commands so they can
132  * be added to the generated auto-completion code.
133  */
134 #define BUILTIN_COMMANDS_FOR_COMPLETION \
135   "help",                               \
136   "quit", "exit", "q"
137
138 static inline char *
139 bad_cast (char const *s)
140 {
141   return (char *) s;
142 }
143
144 #endif /* FISH_H */