xpcom/io/nsDirectoryServiceDefs.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 /**
   8  * Defines the property names for directories available from
   9  * nsIDirectoryService. These dirs are always available even if no
  10  * nsIDirectoryServiceProviders have been registered with the service.
  11  * Application level keys are defined in nsAppDirectoryServiceDefs.h.
  12  *
  13  * Keys whose definition ends in "DIR" or "FILE" return a single nsIFile (or
  14  * subclass). Keys whose definition ends in "LIST" return an nsISimpleEnumerator
  15  * which enumerates a list of file objects.
  16  *
  17  * Defines listed in this file are FROZEN.  This list may grow.
  18  */
  19
  20 #ifndef nsDirectoryServiceDefs_h___
  21 #define nsDirectoryServiceDefs_h___
  22
  23 /* General OS specific locations */
  24
  25 #define NS_OS_HOME_DIR                          "Home"
  26 #define NS_OS_TEMP_DIR                          "TmpD"
  27 #define NS_OS_CURRENT_WORKING_DIR               "CurWorkD"
  28 /* Files stored in this directory will appear on the user's desktop,
  29  * if there is one, otherwise it's just the same as "Home"
  30  */
  31 #define NS_OS_DESKTOP_DIR                       "Desk"
  32
  33 /* Property returns the directory in which the procces was started from.
  34  * On Unix this will be the path in the MOZILLA_FIVE_HOME env var and if
  35  * unset will be the current working directory.
  36  */
  37 #define NS_OS_CURRENT_PROCESS_DIR               "CurProcD"
  38
  39 /* This location is similar to NS_OS_CURRENT_PROCESS_DIR, however,
  40  * NS_XPCOM_CURRENT_PROCESS_DIR can be overriden by passing a "bin
  41  * directory" to NS_InitXPCOM2().
  42  */
  43 #define NS_XPCOM_CURRENT_PROCESS_DIR            "XCurProcD"
  44
  45 /* Property will return the location of the the XPCOM Shared Library.
  46  */
  47 #define NS_XPCOM_LIBRARY_FILE                   "XpcomLib"
  48
  49 /* Property will return the current location of the GRE directory.
  50  * On OSX, this typically points to Contents/Resources in the app bundle.
  51  * If no GRE is used, this propery will behave like
  52  * NS_XPCOM_CURRENT_PROCESS_DIR.
  53  */
  54 #define NS_GRE_DIR                              "GreD"
  55
  56 /* Property will return the current location of the GRE-binaries directory.
  57  * On OSX, this typically points to Contents/MacOS in the app bundle. On
  58  * all other platforms, this will be identical to NS_GRE_DIR.
  59  * Since this property is based on the NS_GRE_DIR, if no GRE is used, this
  60  * propery will behave like NS_XPCOM_CURRENT_PROCESS_DIR.
  61  */
  62 #define NS_GRE_BIN_DIR                          "GreBinD"
  63
  64 /* Platform Specific Locations */
  65
  66 #if !defined (XP_UNIX) || defined(MOZ_WIDGET_COCOA)
  67     #define NS_OS_SYSTEM_DIR                    "SysD"
  68 #endif
  69
  70 #if defined (MOZ_WIDGET_COCOA)
  71   #define NS_MAC_DESKTOP_DIR                  NS_OS_DESKTOP_DIR
  72   #define NS_MAC_TRASH_DIR                    "Trsh"
  73   #define NS_MAC_STARTUP_DIR                  "Strt"
  74   #define NS_MAC_SHUTDOWN_DIR                 "Shdwn"
  75   #define NS_MAC_APPLE_MENU_DIR               "ApplMenu"
  76   #define NS_MAC_CONTROL_PANELS_DIR           "CntlPnl"
  77   #define NS_MAC_EXTENSIONS_DIR               "Exts"
  78   #define NS_MAC_FONTS_DIR                    "Fnts"
  79   #define NS_MAC_PREFS_DIR                    "Prfs"
  80   #define NS_MAC_DOCUMENTS_DIR                "Docs"
  81   #define NS_MAC_INTERNET_SEARCH_DIR          "ISrch"
  82   #define NS_OSX_HOME_DIR                     NS_OS_HOME_DIR
  83   #define NS_MAC_HOME_DIR                     NS_OS_HOME_DIR
  84   #define NS_MAC_DEFAULT_DOWNLOAD_DIR         "DfltDwnld"
  85   #define NS_MAC_USER_LIB_DIR                 "ULibDir"   // Only available under OS X
  86   #define NS_OSX_DEFAULT_DOWNLOAD_DIR         NS_MAC_DEFAULT_DOWNLOAD_DIR
  87   #define NS_OSX_USER_DESKTOP_DIR             "UsrDsk"
  88   #define NS_OSX_LOCAL_DESKTOP_DIR            "LocDsk"
  89   #define NS_OSX_USER_APPLICATIONS_DIR        "UsrApp"
  90   #define NS_OSX_LOCAL_APPLICATIONS_DIR       "LocApp"
  91   #define NS_OSX_USER_DOCUMENTS_DIR           "UsrDocs"
  92   #define NS_OSX_LOCAL_DOCUMENTS_DIR          "LocDocs"
  93   #define NS_OSX_USER_INTERNET_PLUGIN_DIR     "UsrIntrntPlgn"
  94   #define NS_OSX_LOCAL_INTERNET_PLUGIN_DIR    "LoclIntrntPlgn"
  95   #define NS_OSX_USER_FRAMEWORKS_DIR          "UsrFrmwrks"
  96   #define NS_OSX_LOCAL_FRAMEWORKS_DIR         "LocFrmwrks"
  97   #define NS_OSX_USER_PREFERENCES_DIR         "UsrPrfs"
  98   #define NS_OSX_LOCAL_PREFERENCES_DIR        "LocPrfs"
  99   #define NS_OSX_PICTURE_DOCUMENTS_DIR        "Pct"
 100   #define NS_OSX_MOVIE_DOCUMENTS_DIR          "Mov"
 101   #define NS_OSX_MUSIC_DOCUMENTS_DIR          "Music"
 102   #define NS_OSX_INTERNET_SITES_DIR           "IntrntSts"
 103 #elif defined (XP_WIN)
 104   #define NS_WIN_WINDOWS_DIR                  "WinD"
 105   #define NS_WIN_PROGRAM_FILES_DIR            "ProgF"
 106   #define NS_WIN_HOME_DIR                     NS_OS_HOME_DIR
 107   #define NS_WIN_DESKTOP_DIR                  "DeskV" // virtual folder at the root of the namespace
 108   #define NS_WIN_PROGRAMS_DIR                 "Progs" // User start menu programs directory!
 109   #define NS_WIN_CONTROLS_DIR                 "Cntls"
 110   #define NS_WIN_PRINTERS_DIR                 "Prnts"
 111   #define NS_WIN_PERSONAL_DIR                 "Pers"
 112   #define NS_WIN_FAVORITES_DIR                "Favs"
 113   #define NS_WIN_STARTUP_DIR                  "Strt"
 114   #define NS_WIN_RECENT_DIR                   "Rcnt"
 115   #define NS_WIN_SEND_TO_DIR                  "SndTo"
 116   #define NS_WIN_BITBUCKET_DIR                "Buckt"
 117   #define NS_WIN_STARTMENU_DIR                "Strt"
 118 // This gives the same thing as NS_OS_DESKTOP_DIR
 119   #define NS_WIN_DESKTOP_DIRECTORY            "DeskP" // file sys dir which physically stores objects on desktop
 120   #define NS_WIN_DRIVES_DIR                   "Drivs"
 121   #define NS_WIN_NETWORK_DIR                  "NetW"
 122   #define NS_WIN_NETHOOD_DIR                  "netH"
 123   #define NS_WIN_FONTS_DIR                    "Fnts"
 124   #define NS_WIN_TEMPLATES_DIR                "Tmpls"
 125   #define NS_WIN_COMMON_STARTMENU_DIR         "CmStrt"
 126   #define NS_WIN_COMMON_PROGRAMS_DIR          "CmPrgs"
 127   #define NS_WIN_COMMON_STARTUP_DIR           "CmStrt"
 128   #define NS_WIN_COMMON_DESKTOP_DIRECTORY     "CmDeskP"
 129   #define NS_WIN_COMMON_APPDATA_DIR           "CmAppData"
 130   #define NS_WIN_APPDATA_DIR                  "AppData"
 131   #define NS_WIN_LOCAL_APPDATA_DIR            "LocalAppData"
 132   #define NS_WIN_PRINTHOOD                    "PrntHd"
 133   #define NS_WIN_COOKIES_DIR                  "CookD"
 134   #define NS_WIN_DEFAULT_DOWNLOAD_DIR         "DfltDwnld"
 135   // On Win7 and up these ids will return the default save-to location for
 136   // Windows Libraries associated with the specific content type. For other
 137   // os they return the local user folder. Note these can return network file
 138   // paths which can jank the ui thread so be careful how you access them.
 139   #define NS_WIN_DOCUMENTS_DIR                "Docs"
 140   #define NS_WIN_PICTURES_DIR                 "Pict"
 141   #define NS_WIN_MUSIC_DIR                    "Music"
 142   #define NS_WIN_VIDEOS_DIR                   "Vids"
 143 #elif defined (XP_UNIX)
 144   #define NS_UNIX_LOCAL_DIR                   "Locl"
 145   #define NS_UNIX_LIB_DIR                     "LibD"
 146   #define NS_UNIX_HOME_DIR                    NS_OS_HOME_DIR
 147   #define NS_UNIX_XDG_DESKTOP_DIR             "XDGDesk"
 148   #define NS_UNIX_XDG_DOCUMENTS_DIR           "XDGDocs"
 149   #define NS_UNIX_XDG_DOWNLOAD_DIR            "XDGDwnld"
 150   #define NS_UNIX_XDG_MUSIC_DIR               "XDGMusic"
 151   #define NS_UNIX_XDG_PICTURES_DIR            "XDGPict"
 152   #define NS_UNIX_XDG_PUBLIC_SHARE_DIR        "XDGPubSh"
 153   #define NS_UNIX_XDG_TEMPLATES_DIR           "XDGTempl"
 154   #define NS_UNIX_XDG_VIDEOS_DIR              "XDGVids"
 155   #define NS_UNIX_DEFAULT_DOWNLOAD_DIR        "DfltDwnld"
 156 #endif
 157
 158 /* Deprecated */
 159
 160 #define NS_OS_DRIVE_DIR                         "DrvD"
 161
 162
 163
 164 #endif