Back to index

lightning-sunbird  0.9+nobinonly
nsFileStreams.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) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either the GNU General Public License Version 2 or later (the "GPL"), or
00026  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #ifndef nsFileStreams_h__
00039 #define nsFileStreams_h__
00040 
00041 #include "nsIFileStreams.h"
00042 #include "nsIFile.h"
00043 #include "nsIInputStream.h"
00044 #include "nsIOutputStream.h"
00045 #include "nsISafeOutputStream.h"
00046 #include "nsISeekableStream.h"
00047 #include "nsILineInputStream.h"
00048 #include "nsCOMPtr.h"
00049 #include "prlog.h"
00050 #include "prio.h"
00051 
00052 template<class CharType> class nsLineBuffer;
00053 
00055 
00056 class nsFileStream : public nsISeekableStream
00057 {
00058 public:
00059     NS_DECL_ISUPPORTS
00060     NS_DECL_NSISEEKABLESTREAM
00061 
00062     nsFileStream();
00063     virtual ~nsFileStream();
00064 
00065     nsresult Close();
00066     nsresult InitWithFileDescriptor(PRFileDesc* fd, nsISupports* parent);
00067 
00068 protected:
00069     PRFileDesc*           mFD;
00070     nsCOMPtr<nsISupports> mParent; // strong reference to parent nsFileIO,
00071                                    // which ensures mFD remains valid.
00072     PRBool                mCloseFD;
00073 };
00074 
00076 
00077 class nsFileInputStream : public nsFileStream,
00078                           public nsIFileInputStream,
00079                           public nsILineInputStream
00080 {
00081 public:
00082     NS_DECL_ISUPPORTS_INHERITED
00083     NS_DECL_NSIINPUTSTREAM
00084     NS_DECL_NSIFILEINPUTSTREAM
00085     NS_DECL_NSILINEINPUTSTREAM
00086     
00087     // Overrided from nsFileStream
00088     NS_IMETHOD Seek(PRInt32 aWhence, PRInt64 aOffset);
00089 
00090     nsFileInputStream() : nsFileStream() 
00091     {
00092         mLineBuffer = nsnull;
00093         mBehaviorFlags = 0;
00094     }
00095     virtual ~nsFileInputStream() 
00096     {
00097         Close();
00098     }
00099 
00100     static NS_METHOD
00101     Create(nsISupports *aOuter, REFNSIID aIID, void **aResult);
00102 
00103 protected:
00104     nsLineBuffer<char> *mLineBuffer;
00105 
00110     nsCOMPtr<nsIFile> mFile;
00115     PRInt32 mIOFlags;
00120     PRInt32 mPerm;
00124     PRInt32 mBehaviorFlags;
00125 
00126 protected:
00131     nsresult Open(nsIFile* file, PRInt32 ioFlags, PRInt32 perm);
00135     nsresult Reopen() { return Open(mFile, mIOFlags, mPerm); }
00136 };
00137 
00139 
00140 class nsFileOutputStream : public nsFileStream,
00141                            public nsIFileOutputStream
00142 {
00143 public:
00144     NS_DECL_ISUPPORTS_INHERITED
00145     NS_DECL_NSIOUTPUTSTREAM
00146     NS_DECL_NSIFILEOUTPUTSTREAM
00147 
00148     nsFileOutputStream() : nsFileStream() {}
00149     virtual ~nsFileOutputStream() { nsFileOutputStream::Close(); }
00150     
00151     static NS_METHOD
00152     Create(nsISupports *aOuter, REFNSIID aIID, void **aResult);
00153 };
00154 
00156 
00157 class nsSafeFileOutputStream : public nsFileOutputStream,
00158                                public nsISafeOutputStream
00159 {
00160 public:
00161     NS_DECL_ISUPPORTS_INHERITED
00162     NS_DECL_NSISAFEOUTPUTSTREAM
00163 
00164     nsSafeFileOutputStream() :
00165         mTargetFileExists(PR_TRUE),
00166         mWriteResult(NS_OK) {}
00167 
00168     virtual ~nsSafeFileOutputStream() { nsSafeFileOutputStream::Close(); }
00169 
00170     NS_IMETHODIMP Close();
00171     NS_IMETHODIMP Write(const char *buf, PRUint32 count, PRUint32 *result);
00172     NS_IMETHODIMP Init(nsIFile* file, PRInt32 ioFlags, PRInt32 perm, PRInt32 behaviorFlags);
00173 
00174 protected:
00175     nsCOMPtr<nsIFile>         mTargetFile;
00176     nsCOMPtr<nsIFile>         mTempFile;
00177 
00178     PRBool   mTargetFileExists;
00179     nsresult mWriteResult; // Internally set in Write()
00180 };
00181 
00183 
00184 #endif // nsFileStreams_h__