xpcom/io/nsAppDirectoryServiceDefs.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   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) 2000
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Conrad Carlen conrad@ingress.com
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either of the GNU General Public License Version 2 or later (the "GPL"),
  27  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #ifndef nsAppDirectoryServiceDefs_h___
  40 #define nsAppDirectoryServiceDefs_h___
  41
  42 //========================================================================================
  43 //
  44 // Defines property names for directories available from standard nsIDirectoryServiceProviders.
  45 // These keys are not guaranteed to exist because the nsIDirectoryServiceProviders which
  46 // provide them are optional.
  47 //
  48 // Keys whose definition ends in "DIR" or "FILE" return a single nsIFile (or subclass).
  49 // Keys whose definition ends in "LIST" return an nsISimpleEnumerator which enumerates a
  50 // list of file objects.
  51 //
  52 // System and XPCOM level properties are defined in nsDirectoryServiceDefs.h.
  53 //
  54 //========================================================================================
  55
  56
  57 // --------------------------------------------------------------------------------------
  58 // Files and directories which exist on a per-product basis
  59 // --------------------------------------------------------------------------------------
  60
  61 #define NS_APP_APPLICATION_REGISTRY_FILE        "AppRegF"
  62 #define NS_APP_APPLICATION_REGISTRY_DIR         "AppRegD"
  63
  64 #define NS_APP_DEFAULTS_50_DIR                  "DefRt"         // The root dir of all defaults dirs
  65 #define NS_APP_PREF_DEFAULTS_50_DIR             "PrfDef"
  66 #define NS_APP_PROFILE_DEFAULTS_50_DIR          "profDef"       // The profile defaults of the "current"
  67                                                                 // locale. Should be first choice.
  68 #define NS_APP_PROFILE_DEFAULTS_NLOC_50_DIR     "ProfDefNoLoc"  // The profile defaults of the "default"
  69                                                                 // installed locale. Second choice
  70                                                                 // when above is not available.
  71
  72 #define NS_APP_USER_PROFILES_ROOT_DIR           "DefProfRt"     // The dir where user profile dirs live.
  73 #define NS_APP_USER_PROFILES_LOCAL_ROOT_DIR     "DefProfLRt"  // The dir where user profile temp dirs live.
  74
  75 #define NS_APP_RES_DIR                          "ARes"
  76 #define NS_APP_CHROME_DIR                       "AChrom"
  77 #define NS_APP_PLUGINS_DIR                      "APlugns"       // Deprecated - use NS_APP_PLUGINS_DIR_LIST
  78 #define NS_APP_SEARCH_DIR                       "SrchPlugns"
  79
  80 #define NS_APP_CHROME_DIR_LIST                  "AChromDL"
  81 #define NS_APP_PLUGINS_DIR_LIST                 "APluginsDL"
  82 #define NS_APP_SEARCH_DIR_LIST                  "SrchPluginsDL"
  83
  84 // --------------------------------------------------------------------------------------
  85 // Files and directories which exist on a per-profile basis
  86 // These locations are typically provided by the profile mgr
  87 // --------------------------------------------------------------------------------------
  88
  89 // In a shared profile environment, prefixing a profile-relative
  90 // key with NS_SHARED returns a location that is shared by
  91 // other users of the profile. Without this prefix, the consumer
  92 // has exclusive access to this location.
  93
  94 #define NS_SHARED                               "SHARED"
  95
  96 #define NS_APP_PREFS_50_DIR                     "PrefD"         // Directory which contains user prefs
  97 #define NS_APP_PREFS_50_FILE                    "PrefF"
  98 #define NS_APP_PREFS_DEFAULTS_DIR_LIST          "PrefDL"
  99 #define NS_EXT_PREFS_DEFAULTS_DIR_LIST          "ExtPrefDL"
 100 #define NS_APP_PREFS_OVERRIDE_DIR               "PrefDOverride" // Directory for per-profile defaults
 101
 102 #define NS_APP_USER_PROFILE_50_DIR              "ProfD"
 103 #define NS_APP_USER_PROFILE_LOCAL_50_DIR        "ProfLD"
 104
 105 #define NS_APP_USER_CHROME_DIR                  "UChrm"
 106 #define NS_APP_USER_SEARCH_DIR                  "UsrSrchPlugns"
 107
 108 #define NS_APP_LOCALSTORE_50_FILE               "LclSt"
 109 #define NS_APP_HISTORY_50_FILE                  "UHist"
 110 #define NS_APP_USER_PANELS_50_FILE              "UPnls"
 111 #define NS_APP_USER_MIMETYPES_50_FILE           "UMimTyp"
 112 #define NS_APP_CACHE_PARENT_DIR                 "cachePDir"
 113
 114 #define NS_APP_BOOKMARKS_50_FILE                "BMarks"
 115
 116 #define NS_APP_DOWNLOADS_50_FILE                "DLoads"
 117
 118 #define NS_APP_SEARCH_50_FILE                   "SrchF"
 119
 120 #define NS_APP_INSTALL_CLEANUP_DIR              "XPIClnupD"  //location of xpicleanup.dat xpicleanup.exe
 121
 122 #define NS_APP_STORAGE_50_FILE                  "UStor" // sqlite database used as mozStorage profile db
 123 #endif