xpcom/io/nsLocalFileWin.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is Mozilla Communicator client code, released
  16  * March 31, 1998.
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Netscape Communications Corporation.
  20  * Portions created by the Initial Developer are Copyright (C) 1998-1999
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *   Doug Turner <dougt@netscape.com>
  25  *   Brodie Thiesfield <brofield@jellycan.com>
  26  *
  27  * Alternatively, the contents of this file may be used under the terms of
  28  * either of the GNU General Public License Version 2 or later (the "GPL"),
  29  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  30  * in which case the provisions of the GPL or the LGPL are applicable instead
  31  * of those above. If you wish to allow use of your version of this file only
  32  * under the terms of either the GPL or the LGPL, and not to allow others to
  33  * use your version of this file under the terms of the MPL, indicate your
  34  * decision by deleting the provisions above and replace them with the notice
  35  * and other provisions required by the GPL or the LGPL. If you do not delete
  36  * the provisions above, a recipient may use your version of this file under
  37  * the terms of any one of the MPL, the GPL or the LGPL.
  38  *
  39  * ***** END LICENSE BLOCK ***** */
  40
  41 #ifndef _nsLocalFileWIN_H_
  42 #define _nsLocalFileWIN_H_
  43
  44 #include "nscore.h"
  45 #include "nsError.h"
  46 #include "nsString.h"
  47 #include "nsCRT.h"
  48 #include "nsIFile.h"
  49 #include "nsIFactory.h"
  50 #include "nsILocalFileWin.h"
  51 #include "nsIHashable.h"
  52 #include "nsIClassInfoImpl.h"
  53
  54 #include "windows.h"
  55
  56 // For older version (<6.0) of the VC Compiler
  57 #if (_MSC_VER == 1100)
  58 #include <objbase.h>
  59 DEFINE_OLEGUID(IID_IPersistFile, 0x0000010BL, 0, 0);
  60 #endif
  61
  62 #include "shlobj.h"
  63
  64 #include <sys/stat.h>
  65
  66 class nsLocalFile : public nsILocalFileWin,
  67                     public nsIHashable
  68 {
  69 public:
  70     NS_DEFINE_STATIC_CID_ACCESSOR(NS_LOCAL_FILE_CID)
  71
  72     nsLocalFile();
  73
  74     static nsresult nsLocalFileConstructor(nsISupports* outer, const nsIID& aIID, void* *aInstancePtr);
  75
  76     // nsISupports interface
  77     NS_DECL_ISUPPORTS
  78
  79     // nsIFile interface
  80     NS_DECL_NSIFILE
  81
  82     // nsILocalFile interface
  83     NS_DECL_NSILOCALFILE
  84
  85     // nsILocalFileWin interface
  86     NS_DECL_NSILOCALFILEWIN
  87
  88     // nsIHashable interface
  89     NS_DECL_NSIHASHABLE
  90
  91 public:
  92     static void GlobalInit();
  93     static void GlobalShutdown();
  94
  95 private:
  96     nsLocalFile(const nsLocalFile& other);
  97     ~nsLocalFile() {}
  98
  99     PRPackedBool mDirty;            // cached information can only be used when this is PR_FALSE
 100     PRPackedBool mFollowSymlinks;   // should we follow symlinks when working on this file
 101
 102     // this string will always be in native format!
 103     nsString mWorkingPath;
 104
 105     // this will be the resolved path of shortcuts, it will *NEVER*
 106     // be returned to the user
 107     nsString mResolvedPath;
 108
 109     // this string, if not empty, is the *short* pathname that represents
 110     // mWorkingPath
 111     nsString mShortWorkingPath;
 112
 113     PRFileInfo64 mFileInfo64;
 114
 115     void MakeDirty() { mDirty = PR_TRUE; mShortWorkingPath.Truncate(); }
 116
 117     nsresult ResolveAndStat();
 118     nsresult ResolveShortcut();
 119
 120     void EnsureShortPath();
 121
 122     nsresult CopyMove(nsIFile *newParentDir, const nsAString &newName,
 123                       PRBool followSymlinks, PRBool move);
 124     nsresult CopySingleFile(nsIFile *source, nsIFile* dest,
 125                             const nsAString &newName,
 126                             PRBool followSymlinks, PRBool move);
 127
 128     nsresult SetModDate(PRInt64 aLastModifiedTime, const PRUnichar *filePath);
 129     nsresult HasFileAttribute(DWORD fileAttrib, PRBool *_retval);
 130     nsresult AppendInternal(const nsAFlatString &node,
 131                             PRBool multipleComponents);
 132 };
 133
 134 #endif