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 /* in fish.c */
  51 extern guestfs_h *g;
  52 extern int read_only;
  53 extern int quit;
  54 extern int verbose;
  55 extern int command_num;
  56 extern int utf8_mode;
  57 extern int have_terminfo;
  58 extern int progress_bars;
  59 extern const char *libvirt_uri;
  60 extern int issue_command (const char *cmd, char *argv[], const char *pipe);
  61 extern void pod2text (const char *name, const char *shortdesc, const char *body);
  62 extern void list_builtin_commands (void);
  63 extern int display_builtin_command (const char *cmd);
  64 extern void free_strings (char **argv);
  65 extern int count_strings (char *const *argv);
  66 extern void print_strings (char *const *argv);
  67 extern void print_table (char *const *argv);
  68 extern int is_true (const char *str);
  69 extern char **parse_string_list (const char *str);
  70 extern int xwrite (int fd, const void *buf, size_t len);
  71 extern char *resolve_win_path (const char *path);
  72 extern char *file_in (const char *arg);
  73 extern void free_file_in (char *s);
  74 extern char *file_out (const char *arg);
  75 extern void extended_help_message (void);
  76 extern char *read_key (const char *param);
  77
  78 /* in cmds.c (auto-generated) */
  79 extern void list_commands (void);
  80 extern int display_command (const char *cmd);
  81 extern int run_action (const char *cmd, int argc, char *argv[]);
  82
  83 /* in completion.c (auto-generated) */
  84 extern char **do_completion (const char *text, int start, int end);
  85
  86 /* in destpaths.c */
  87 extern int complete_dest_paths;
  88 extern char *complete_dest_paths_generator (const char *text, int state);
  89
  90 /* in alloc.c */
  91 extern int do_alloc (const char *cmd, int argc, char *argv[]);
  92 extern int do_sparse (const char *cmd, int argc, char *argv[]);
  93 extern int alloc_disk (const char *filename, const char *size,
  94                        int add, int sparse);
  95 extern int parse_size (const char *str, off_t *size_rtn);
  96
  97 /* in copy.c */
  98 extern int do_copy_in (const char *cmd, int argc, char *argv[]);
  99 extern int do_copy_out (const char *cmd, int argc, char *argv[]);
 100
 101 /* in echo.c */
 102 extern int do_echo (const char *cmd, int argc, char *argv[]);
 103
 104 /* in edit.c */
 105 extern int do_edit (const char *cmd, int argc, char *argv[]);
 106
 107 /* in inspect.c */
 108 extern void inspect_mount (void);
 109 extern void print_inspect_prompt (void);
 110
 111 /* in lcd.c */
 112 extern int do_lcd (const char *cmd, int argc, char *argv[]);
 113
 114 /* in glob.c */
 115 extern int do_glob (const char *cmd, int argc, char *argv[]);
 116
 117 /* in man.c */
 118 extern int do_man (const char *cmd, int argc, char *argv[]);
 119
 120 /* in more.c */
 121 extern int do_more (const char *cmd, int argc, char *argv[]);
 122
 123 /* in prep.c */
 124 struct prep_data {
 125   const struct prep *prep;
 126   const char *orig_type_string;
 127   const char **params;
 128 };
 129 typedef struct prep_data prep_data;
 130 extern void list_prepared_drives (void);
 131 extern prep_data *create_prepared_file (const char *type_string,
 132                                         const char *filename);
 133 extern void prepare_drive (const char *filename, prep_data *data,
 134                            const char *device);
 135 extern void prep_error (prep_data *data, const char *filename, const char *fs, ...) __attribute__((noreturn, format (printf,3,4)));
 136
 137 /* in prep_lv.c */
 138 extern int vg_lv_parse (const char *device, char **vg, char **lv);
 139
 140 /* in progress.c */
 141 extern void reset_progress_bar (void);
 142 extern void progress_callback (guestfs_h *g, void *data, int proc_nr, int serial, uint64_t position, uint64_t total);
 143
 144 /* in rc.c (remote control) */
 145 extern void rc_listen (void) __attribute__((noreturn));
 146 extern int rc_remote (int pid, const char *cmd, int argc, char *argv[],
 147                       int exit_on_error);
 148
 149 /* in reopen.c */
 150 extern int do_reopen (const char *cmd, int argc, char *argv[]);
 151
 152 /* in supported.c */
 153 extern int do_supported (const char *cmd, int argc, char *argv[]);
 154
 155 /* in time.c */
 156 extern int do_time (const char *cmd, int argc, char *argv[]);
 157
 158 /* in tilde.c */
 159 extern char *try_tilde_expansion (char *path);
 160
 161 /* in virt.c */
 162 extern int add_libvirt_drives (const char *guest);
 163
 164 /* This should just list all the built-in commands so they can
 165  * be added to the generated auto-completion code.
 166  */
 167 #define BUILTIN_COMMANDS_FOR_COMPLETION \
 168   "help",                               \
 169   "quit", "exit", "q",                  \
 170   "alloc", "allocate",                  \
 171   "copy-in", "copy-out",                \
 172   "echo",                               \
 173   "edit", "vi", "emacs",                \
 174   "lcd",                                \
 175   "glob",                               \
 176   "man", "manual",                      \
 177   "more", "less",                       \
 178   "reopen",                             \
 179   "sparse",                             \
 180   "supported",                          \
 181   "time"
 182
 183 static inline char *
 184 bad_cast (char const *s)
 185 {
 186   return (char *) s;
 187 }
 188
 189 #endif /* FISH_H */