netwerk/cache/src/nsDeleteDir.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim:set ts=2 sw=2 sts=2 et cindent: */
   3 /* ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is mozilla.org code.
  17  *
  18  * The Initial Developer of the Original Code is Google Inc.
  19  * Portions created by the Initial Developer are Copyright (C) 2005
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *  Darin Fisher <darin@meer.net>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #ifndef nsDeleteDir_h__
  40 #define nsDeleteDir_h__
  41
  42 #include "nsCOMPtr.h"
  43
  44 class nsIFile;
  45
  46 /**
  47  * This routine attempts to delete a directory that may contain some files that
  48  * are still in use.  This later point is only an issue on Windows and a few
  49  * other systems.
  50  *
  51  * If the moveToTrash parameter is true, then the process for deleting the
  52  * directory creates a sibling directory of the same name with the ".Trash"
  53  * suffix.  It then attempts to move the given directory into the corresponding
  54  * trash folder (moving individual files if necessary).  Next, it proceeds to
  55  * delete each file in the trash folder on a low-priority background thread.
  56  *
  57  * If the moveToTrash parameter is false, then the given directory is deleted
  58  * directly.
  59  *
  60  * If the sync flag is true, then the delete operation runs to completion
  61  * before this function returns.  Otherwise, deletion occurs asynchronously.
  62  */
  63 NS_HIDDEN_(nsresult) DeleteDir(nsIFile *dir, PRBool moveToTrash, PRBool sync);
  64
  65 /**
  66  * This routine returns the trash directory corresponding to the given
  67  * directory.
  68  */
  69 NS_HIDDEN_(nsresult) GetTrashDir(nsIFile *dir, nsCOMPtr<nsIFile> *result);
  70
  71 #endif  // nsDeleteDir_h__