netwerk/base/src/nsDirectoryIndexStream.h

   1 /* -*- Mode: C++; tab-width: 4; 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.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #ifndef nsDirectoryIndexStream_h__
  39 #define nsDirectoryIndexStream_h__
  40
  41 #include "nsIFile.h"
  42 #include "nsString.h"
  43 #include "nsIInputStream.h"
  44 #include "nsCOMPtr.h"
  45 #include "nsCOMArray.h"
  46 #include "nsITextToSubURI.h"
  47
  48 class nsDirectoryIndexStream : public nsIInputStream
  49 {
  50 private:
  51     nsCString mBuf;
  52     PRInt32 mOffset;
  53     nsresult mStatus;
  54
  55     PRInt32             mPos;   // position within mArray
  56     nsCOMArray<nsIFile> mArray; // file objects within the directory
  57
  58     nsDirectoryIndexStream();
  59     /**
  60      * aDir will only be used on the calling thread.
  61      */
  62     nsresult Init(nsIFile* aDir);
  63     ~nsDirectoryIndexStream();
  64
  65 public:
  66     /**
  67      * aDir will only be used on the calling thread.
  68      */
  69     static nsresult
  70     Create(nsIFile* aDir, nsIInputStream** aStreamResult);
  71
  72     // nsISupportsInterface
  73     NS_DECL_ISUPPORTS
  74
  75     // nsIInputStream interface
  76     NS_DECL_NSIINPUTSTREAM
  77 };
  78
  79 #endif // nsDirectoryIndexStream_h__
  80