xpcom/io/nsAppFileLocationProvider.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 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) 2000
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *   Conrad Carlen <conrad@ingress.com>
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either of the GNU General Public License Version 2 or later (the "GPL"),
  28  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 #include "nsIDirectoryService.h"
  41 #include "nsILocalFile.h"
  42
  43 class nsIFile;
  44
  45 //*****************************************************************************
  46 // class nsAppFileLocationProvider
  47 //*****************************************************************************
  48
  49 class nsAppFileLocationProvider : public nsIDirectoryServiceProvider2
  50 {
  51 public:
  52                         nsAppFileLocationProvider();
  53
  54    NS_DECL_ISUPPORTS
  55    NS_DECL_NSIDIRECTORYSERVICEPROVIDER
  56    NS_DECL_NSIDIRECTORYSERVICEPROVIDER2
  57
  58 private:
  59                         ~nsAppFileLocationProvider() {}
  60
  61 protected:
  62    NS_METHOD            CloneMozBinDirectory(nsILocalFile **aLocalFile);
  63    /**
  64     * Get the product directory. This is a user-specific directory for storing
  65     * application settings (e.g. the Application Data directory on windows
  66     * systems).
  67     * @param aLocal If true, should try to get a directory that is only stored
  68     *               locally (ie not transferred with roaming profiles)
  69     */
  70    NS_METHOD            GetProductDirectory(nsILocalFile **aLocalFile,
  71                                             PRBool aLocal = PR_FALSE);
  72    NS_METHOD            GetDefaultUserProfileRoot(nsILocalFile **aLocalFile,
  73                                                   PRBool aLocal = PR_FALSE);
  74
  75    nsCOMPtr<nsILocalFile> mMozBinDirectory;
  76 };