src/filemanager/fileopctx.h

   1 /** \file fileopctx.h
   2  *  \brief Header: file operation contexts
   3  *  \date 1998
   4  *  \author Federico Mena <federico@nuclecu.unam.mx>
   5  *  \author Miguel de Icaza <miguel@nuclecu.unam.mx>
   6  */
   7
   8 /* File operation contexts for the Midnight Commander
   9  *
  10  * Copyright (C) 1998 Free Software Foundation, Inc.
  11  *
  12  */
  13
  14 #ifndef MC__FILEOPCTX_H
  15 #define MC__FILEOPCTX_H
  16
  17 #include <sys/stat.h>
  18 #include <sys/types.h>
  19 #include <sys/time.h>
  20 #include <inttypes.h>           /* uintmax_t */
  21
  22 #include "lib/global.h"
  23
  24
  25 /*** typedefs(not structures) and defined constants **********************************************/
  26
  27 typedef int (*mc_stat_fn) (const char *filename, struct stat * buf);
  28
  29 /*** enums ***************************************************************************************/
  30
  31 typedef enum
  32 {
  33     FILEGUI_DIALOG_ONE_ITEM,
  34     FILEGUI_DIALOG_MULTI_ITEM,
  35     FILEGUI_DIALOG_DELETE_ITEM
  36 } filegui_dialog_type_t;
  37
  38 typedef enum
  39 {
  40     OP_COPY = 0,
  41     OP_MOVE = 1,
  42     OP_DELETE = 2
  43 } FileOperation;
  44
  45 typedef enum
  46 {
  47     RECURSIVE_YES = 0,
  48     RECURSIVE_NO = 1,
  49     RECURSIVE_ALWAYS = 2,
  50     RECURSIVE_NEVER = 3,
  51     RECURSIVE_ABORT = 4
  52 } FileCopyMode;
  53
  54 typedef enum
  55 {
  56     FILE_CONT = 0,
  57     FILE_RETRY = 1,
  58     FILE_SKIP = 2,
  59     FILE_ABORT = 3,
  60     FILE_SKIPALL = 4
  61 } FileProgressStatus;
  62
  63 /* First argument passed to real functions */
  64 enum OperationMode
  65 {
  66     Foreground,
  67     Background
  68 };
  69
  70 /*** structures declarations (and typedefs of structures)*****************************************/
  71
  72 struct mc_search_struct;
  73
  74 /* This structure describes a context for file operations.  It is used to update
  75  * the progress windows and pass around options.
  76  */
  77 typedef struct FileOpContext
  78 {
  79     /* Operation type (copy, move, delete) */
  80     FileOperation operation;
  81
  82     /* The estimated time of arrival in seconds */
  83     double eta_secs;
  84
  85     /* Transferred bytes per second */
  86     long bps;
  87
  88     /* Transferred seconds */
  89     long bps_time;
  90
  91     /* Whether the panel total has been computed */
  92     gboolean progress_totals_computed;
  93     filegui_dialog_type_t dialog_type;
  94
  95     /* Counters for progress indicators */
  96     size_t progress_count;
  97     uintmax_t progress_bytes;
  98
  99     /* The value of the "preserve Attributes" checkbox in the copy file dialog.
 100      * We can't use the value of "ctx->preserve" because it can change in order
 101      * to preserve file attributs when moving files across filesystem boundaries
 102      * (we want to keep the value of the checkbox between copy operations).
 103      */
 104     gboolean op_preserve;
 105
 106     /* Result from the recursive query */
 107     FileCopyMode recursive_result;
 108
 109     /* Whether to do a reget */
 110     off_t do_reget;
 111
 112     /* Controls appending to files */
 113     gboolean do_append;
 114
 115     /* Whether to stat or lstat */
 116     gboolean follow_links;
 117
 118     /* Pointer to the stat function we will use */
 119     mc_stat_fn stat_func;
 120
 121     /* Whether to recompute symlinks */
 122     gboolean stable_symlinks;
 123
 124     /* Preserve the original files' owner, group, permissions, and
 125      * timestamps (owner, group only as root).
 126      */
 127     int preserve;
 128
 129     /* If running as root, preserve the original uid/gid (we don't want to
 130      * try chown for non root) preserve_uidgid = preserve && uid == 0
 131      */
 132     gboolean preserve_uidgid;
 133
 134     /* The bits to preserve in created files' modes on file copy */
 135     int umask_kill;
 136
 137     /* The mask of files to actually operate on */
 138     char *dest_mask;
 139
 140     /* search handler */
 141     struct mc_search_struct *search_handle;
 142
 143     /* Whether to dive into subdirectories for recursive operations */
 144     int dive_into_subdirs;
 145
 146     /* When moving directories cross filesystem boundaries delete the
 147      * successfully copied files when all files below the directory and its
 148      * subdirectories were processed.
 149      *
 150      * If erase_at_end is FALSE files will be deleted immediately after their
 151      * successful copy (Note: this behavior is not tested and at the moment
 152      * it can't be changed at runtime).
 153      */
 154     gboolean erase_at_end;
 155
 156     /* PID of the child for background operations */
 157     pid_t pid;
 158
 159     /* toggle if all errors should be ignored */
 160     gboolean skip_all;
 161
 162     /* User interface data goes here */
 163     void *ui;
 164 } FileOpContext;
 165
 166 typedef struct
 167 {
 168     size_t progress_count;
 169     uintmax_t progress_bytes;
 170     uintmax_t copyed_bytes;
 171     size_t bps;
 172     size_t bps_count;
 173     struct timeval transfer_start;
 174     double eta_secs;
 175
 176     gboolean ask_overwrite;
 177 } FileOpTotalContext;
 178
 179 /*** global variables defined in .c file *********************************************************/
 180
 181 extern const char *op_names[3];
 182
 183 /*** declarations of public functions ************************************************************/
 184
 185 FileOpContext *file_op_context_new (FileOperation op);
 186 void file_op_context_destroy (FileOpContext * ctx);
 187
 188 FileOpTotalContext *file_op_total_context_new (void);
 189 void file_op_total_context_destroy (FileOpTotalContext * tctx);
 190
 191 /* The following functions are implemented separately by each port */
 192 FileProgressStatus file_progress_real_query_replace (FileOpContext * ctx,
 193                                                      enum OperationMode mode,
 194                                                      const char *destname,
 195                                                      struct stat *_s_stat, struct stat *_d_stat);
 196
 197 /*** inline functions ****************************************************************************/
 198 #endif /* MC__FILEOPCTX_H */