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 #ifdef HAVE_GETTEXT
  25 #include "gettext.h"
  26 #define _(str) dgettext(PACKAGE, (str))
  27 #define N_(str) dgettext(PACKAGE, (str))
  28 #else
  29 #define _(str) str
  30 #define N_(str) str
  31 #endif
  32
  33 #if !ENABLE_NLS
  34 #undef textdomain
  35 #define textdomain(Domainname) /* empty */
  36 #undef bindtextdomain
  37 #define bindtextdomain(Domainname, Dirname) /* empty */
  38 #endif
  39
  40 #define STREQ(a,b) (strcmp((a),(b)) == 0)
  41 #define STRCASEEQ(a,b) (strcasecmp((a),(b)) == 0)
  42 #define STRNEQ(a,b) (strcmp((a),(b)) != 0)
  43 #define STRCASENEQ(a,b) (strcasecmp((a),(b)) != 0)
  44 #define STREQLEN(a,b,n) (strncmp((a),(b),(n)) == 0)
  45 #define STRCASEEQLEN(a,b,n) (strncasecmp((a),(b),(n)) == 0)
  46 #define STRNEQLEN(a,b,n) (strncmp((a),(b),(n)) != 0)
  47 #define STRCASENEQLEN(a,b,n) (strncasecmp((a),(b),(n)) != 0)
  48 #define STRPREFIX(a,b) (strncmp((a),(b),strlen((b))) == 0)
  49
  50 #define TMP_TEMPLATE_ON_STACK(var)                        \
  51   const char *ttos_tmpdir = guestfs_tmpdir ();            \
  52   char var[strlen (ttos_tmpdir) + 32];                    \
  53   sprintf (var, "%s/guestfishXXXXXX", ttos_tmpdir)        \
  54
  55 /* in fish.c */
  56 extern guestfs_h *g;
  57 extern int read_only;
  58 extern int quit;
  59 extern int verbose;
  60 extern int command_num;
  61 extern int utf8_mode;
  62 extern int have_terminfo;
  63 extern int progress_bars;
  64 extern const char *libvirt_uri;
  65 extern int issue_command (const char *cmd, char *argv[], const char *pipe);
  66 extern void pod2text (const char *name, const char *shortdesc, const char *body);
  67 extern void list_builtin_commands (void);
  68 extern int display_builtin_command (const char *cmd);
  69 extern void free_strings (char **argv);
  70 extern int count_strings (char *const *argv);
  71 extern void print_strings (char *const *argv);
  72 extern void print_table (char *const *argv);
  73 extern int is_true (const char *str);
  74 extern char **parse_string_list (const char *str);
  75 extern int xwrite (int fd, const void *buf, size_t len);
  76 extern char *resolve_win_path (const char *path);
  77 extern char *file_in (const char *arg);
  78 extern void free_file_in (char *s);
  79 extern char *file_out (const char *arg);
  80 extern void extended_help_message (void);
  81 extern char *read_key (const char *param);
  82
  83 /* in cmds.c (auto-generated) */
  84 extern void list_commands (void);
  85 extern int display_command (const char *cmd);
  86 extern int run_action (const char *cmd, int argc, char *argv[]);
  87
  88 /* in completion.c (auto-generated) */
  89 extern char **do_completion (const char *text, int start, int end);
  90
  91 /* in destpaths.c */
  92 extern int complete_dest_paths;
  93 extern char *complete_dest_paths_generator (const char *text, int state);
  94
  95 /* in alloc.c */
  96 extern int run_alloc (const char *cmd, int argc, char *argv[]);
  97 extern int run_sparse (const char *cmd, int argc, char *argv[]);
  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 copy.c */
 103 extern int run_copy_in (const char *cmd, int argc, char *argv[]);
 104 extern int run_copy_out (const char *cmd, int argc, char *argv[]);
 105
 106 /* in echo.c */
 107 extern int run_echo (const char *cmd, int argc, char *argv[]);
 108
 109 /* in edit.c */
 110 extern int run_edit (const char *cmd, int argc, char *argv[]);
 111
 112 /* in hexedit.c */
 113 extern int run_hexedit (const char *cmd, int argc, char *argv[]);
 114
 115 /* in inspect.c */
 116 extern void inspect_mount (void);
 117 extern void print_inspect_prompt (void);
 118
 119 /* in lcd.c */
 120 extern int run_lcd (const char *cmd, int argc, char *argv[]);
 121
 122 /* in glob.c */
 123 extern int run_glob (const char *cmd, int argc, char *argv[]);
 124
 125 /* in man.c */
 126 extern int run_man (const char *cmd, int argc, char *argv[]);
 127
 128 /* in more.c */
 129 extern int run_more (const char *cmd, int argc, char *argv[]);
 130
 131 /* in prep.c */
 132 struct prep_data {
 133   const struct prep *prep;
 134   const char *orig_type_string;
 135   char **params;
 136 };
 137 typedef struct prep_data prep_data;
 138 extern void list_prepared_drives (void);
 139 extern prep_data *create_prepared_file (const char *type_string,
 140                                         const char *filename);
 141 extern void prepare_drive (const char *filename, prep_data *data,
 142                            const char *device);
 143 extern void prep_error (prep_data *data, const char *filename, const char *fs, ...) __attribute__((noreturn, format (printf,3,4)));
 144 extern void free_prep_data (prep_data *data);
 145
 146 /* in prep_lv.c */
 147 extern int vg_lv_parse (const char *device, char **vg, char **lv);
 148
 149 /* in progress.c */
 150 extern void reset_progress_bar (void);
 151 extern void progress_callback (guestfs_h *g, void *data, int proc_nr, int serial, uint64_t position, uint64_t total);
 152
 153 /* in rc.c (remote control) */
 154 extern void rc_listen (void) __attribute__((noreturn));
 155 extern int rc_remote (int pid, const char *cmd, int argc, char *argv[],
 156                       int exit_on_error);
 157
 158 /* in reopen.c */
 159 extern int run_reopen (const char *cmd, int argc, char *argv[]);
 160
 161 /* in supported.c */
 162 extern int run_supported (const char *cmd, int argc, char *argv[]);
 163
 164 /* in time.c */
 165 extern int run_time (const char *cmd, int argc, char *argv[]);
 166
 167 /* in tilde.c */
 168 extern char *try_tilde_expansion (char *path);
 169
 170 /* in virt.c */
 171 extern int add_libvirt_drives (const char *guest);
 172
 173 /* This should just list all the built-in commands so they can
 174  * be added to the generated auto-completion code.
 175  */
 176 #define BUILTIN_COMMANDS_FOR_COMPLETION \
 177   "help",                               \
 178   "quit", "exit", "q"
 179
 180 static inline char *
 181 bad_cast (char const *s)
 182 {
 183   return (char *) s;
 184 }
 185
 186 #endif /* FISH_H */