src/fileopctx.c

   1 /* File operation contexts for the Midnight Commander
   2
   3    Copyright (C) 1999, 2001, 2002, 2003, 2004, 2005, 2007
   4    Free Software Foundation, Inc.
   5
   6    Authors: Federico Mena <federico@nuclecu.unam.mx>
   7             Miguel de Icaza <miguel@nuclecu.unam.mx>
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 2 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program; if not, write to the Free Software
  21    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  22  */
  23
  24 /** \file fileopctx.c
  25  *  \brief Source: file operation contexts
  26  *  \date 1998-2007
  27  *  \author Federico Mena <federico@nuclecu.unam.mx>
  28  *  \author Miguel de Icaza <miguel@nuclecu.unam.mx>
  29  */
  30
  31 #include <config.h>
  32
  33 #include <unistd.h>
  34
  35 #include "global.h"
  36 #include "fileopctx.h"
  37 #include "../src/search/search.h"
  38 #include "../vfs/vfs.h"
  39
  40 /**
  41  * \fn FileOpContext * file_op_context_new (FileOperation op)
  42  * \param op file operation struct
  43  * \return The newly-created context, filled with the default file mask values.
  44  *
  45  * Creates a new file operation context with the default values.  If you later want
  46  * to have a user interface for this, call file_op_context_create_ui().
  47  */
  48 FileOpContext *
  49 file_op_context_new (FileOperation op)
  50 {
  51     FileOpContext *ctx;
  52
  53     ctx = g_new0 (FileOpContext, 1);
  54     ctx->operation = op;
  55     ctx->eta_secs = 0.0;
  56     ctx->progress_bytes = 0.0;
  57     ctx->op_preserve = TRUE;
  58     ctx->do_reget = TRUE;
  59     ctx->stat_func = mc_lstat;
  60     ctx->preserve = TRUE;
  61     ctx->preserve_uidgid = (geteuid () == 0) ? TRUE : FALSE;
  62     ctx->umask_kill = 0777777;
  63     ctx->erase_at_end = TRUE;
  64
  65     return ctx;
  66 }
  67
  68
  69 /**
  70  * \fn void file_op_context_destroy (FileOpContext *ctx)
  71  * \param ctx The file operation context to destroy.
  72  *
  73  * Destroys the specified file operation context and its associated UI data, if
  74  * it exists.
  75  */
  76 void
  77 file_op_context_destroy (FileOpContext *ctx)
  78 {
  79     g_return_if_fail (ctx != NULL);
  80
  81     if (ctx->ui)
  82         file_op_context_destroy_ui (ctx);
  83
  84     mc_search_free(ctx->search_handle);
  85
  86     /** \todo FIXME: do we need to free ctx->dest_mask? */
  87
  88     g_free (ctx);
  89 }