Back to index

lightning-sunbird  0.9+nobinonly
nsLocalFileOSX.h
Go to the documentation of this file.
00001 /* -*- Mode: C; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 2001, 2002
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *  Conrad Carlen <ccarlen@netscape.com>
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either the GNU General Public License Version 2 or later (the "GPL"), or
00027  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #ifndef nsLocalFileMac_h__
00040 #define nsLocalFileMac_h__
00041 
00042 #include "nsILocalFileMac.h"
00043 #include "nsString.h"
00044 
00045 class nsDirEnumerator;
00046 
00047 //*****************************************************************************
00048 //  nsLocalFile
00049 //
00050 // The native charset of this implementation is UTF-8. The Unicode used by the
00051 // Mac OS file system is decomposed, so "Native" versions of these routines will
00052 // always use decomposed Unicode (NFD). Their "non-Native" counterparts are 
00053 // intended to be simple wrappers which call the "Native" version and convert 
00054 // between UTF-8 and UTF-16. All the work is done on the "Native" side except
00055 // for the conversion to NFC (composed Unicode) done in "non-Native" getters.
00056 //*****************************************************************************
00057 
00058 class NS_COM nsLocalFile : public nsILocalFileMac, 
00059                            public nsILocalFileMac_MOZILLA_1_8_BRANCH
00060 {
00061     friend class nsDirEnumerator;
00062     
00063 public:
00064     NS_DEFINE_STATIC_CID_ACCESSOR(NS_LOCAL_FILE_CID)
00065     
00066                         nsLocalFile();
00067 
00068     static NS_METHOD    nsLocalFileConstructor(nsISupports* outer, const nsIID& aIID, void* *aInstancePtr);
00069 
00070     NS_DECL_ISUPPORTS
00071     NS_DECL_NSIFILE
00072     NS_DECL_NSILOCALFILE
00073     NS_DECL_NSILOCALFILEMAC
00074     NS_DECL_NSILOCALFILEMAC_MOZILLA_1_8_BRANCH
00075 
00076 public:
00077 
00078     static void         GlobalInit();
00079     static void         GlobalShutdown();
00080     
00081 private:
00082                         ~nsLocalFile();
00083 
00084 protected:
00085                         nsLocalFile(const nsLocalFile& src);
00086     
00087     nsresult            SetBaseRef(CFURLRef aCFURLRef); // Does CFRetain on aCFURLRef
00088     nsresult            UpdateTargetRef();
00089     
00090     nsresult            GetFSRefInternal(FSRef& aFSSpec, PRBool bForceUpdateCache = PR_TRUE);
00091     nsresult            GetPathInternal(nsACString& path);  // Returns path WRT mFollowLinks
00092 
00093     nsresult            CopyInternal(nsIFile* newParentDir,
00094                                      const nsAString& newName,
00095                                      PRBool followLinks);
00096 
00097     static PRInt64      HFSPlustoNSPRTime(const UTCDateTime& utcTime);
00098     static void         NSPRtoHFSPlusTime(PRInt64 nsprTime, UTCDateTime& utcTime);
00099     static nsresult     CFStringReftoUTF8(CFStringRef aInStrRef, nsACString& aOutStr);
00100 
00101 protected:
00102     CFURLRef            mBaseRef;           // The FS object we represent
00103     CFURLRef            mTargetRef;         // If mBaseRef is an alias, its target
00104 
00105     FSRef               mCachedFSRef;
00106     PRPackedBool        mCachedFSRefValid;
00107     
00108     PRPackedBool        mFollowLinks;
00109     PRPackedBool        mFollowLinksDirty;
00110 
00111     static const char         kPathSepChar;
00112     static const PRUnichar    kPathSepUnichar;
00113     static const PRInt64      kJanuaryFirst1970Seconds;    
00114 };
00115 
00116 #endif // nsLocalFileMac_h__