PageRenderTime 58ms CodeModel.GetById 50ms app.highlight 4ms RepoModel.GetById 2ms app.codeStats 0ms

/gecko_api/include/nsDirectoryServiceDefs.h

http://firefox-mac-pdf.googlecode.com/
C++ Header | 214 lines | 105 code | 22 blank | 87 comment | 1 complexity | 8f5e1740b8e56d3d83daa53e6f769fc5 MD5 | raw file
  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/**
 40 * Defines the property names for directories available from 
 41 * nsIDirectoryService. These dirs are always available even if no 
 42 * nsIDirectoryServiceProviders have been registered with the service. 
 43 * Application level keys are defined in nsAppDirectoryServiceDefs.h.
 44 *
 45 * Keys whose definition ends in "DIR" or "FILE" return a single nsIFile (or 
 46 * subclass). Keys whose definition ends in "LIST" return an nsISimpleEnumerator
 47 * which enumerates a list of file objects.
 48 *
 49 * Defines listed in this file are FROZEN.  This list may grow.
 50 */
 51
 52#ifndef nsDirectoryServiceDefs_h___
 53#define nsDirectoryServiceDefs_h___
 54
 55/* General OS specific locations */
 56
 57#define NS_OS_HOME_DIR                          "Home"
 58#define NS_OS_TEMP_DIR                          "TmpD"
 59#define NS_OS_CURRENT_WORKING_DIR               "CurWorkD"
 60/* Files stored in this directory will appear on the user's desktop,
 61 * if there is one, otherwise it's just the same as "Home"
 62 */
 63#define NS_OS_DESKTOP_DIR                       "Desk"
 64
 65/* Property returns the directory in which the procces was started from.  
 66 * On Unix this will be the path in the MOZILLA_FIVE_HOME env var and if 
 67 * unset will be the current working directory. 
 68 */
 69#define NS_OS_CURRENT_PROCESS_DIR               "CurProcD"
 70                                                                                                                       
 71/* This location is similar to NS_OS_CURRENT_PROCESS_DIR, however, 
 72 * NS_XPCOM_CURRENT_PROCESS_DIR can be overriden by passing a "bin
 73 * directory" to NS_InitXPCOM2(). 
 74 */
 75#define NS_XPCOM_CURRENT_PROCESS_DIR            "XCurProcD"
 76
 77/* Property will return the location of the application components
 78 * directory.  By default, this directory will be contained in the 
 79 * NS_XPCOM_CURRENT_PROCESS_DIR.
 80 */
 81#define NS_XPCOM_COMPONENT_DIR                  "ComsD"
 82
 83/* Property will return a list of components directories that will
 84 * will be registered after the application components directory.
 85 */
 86#define NS_XPCOM_COMPONENT_DIR_LIST             "ComsDL"
 87
 88/* Property will return the location of the application components
 89 * registry file.
 90 */
 91#define NS_XPCOM_COMPONENT_REGISTRY_FILE        "ComRegF"
 92
 93/* Property will return the location of the application XPTI
 94 * registry file.
 95 */
 96#define NS_XPCOM_XPTI_REGISTRY_FILE             "XptiRegF"
 97
 98/* Property will return the location of the the XPCOM Shared Library.
 99 */
100#define NS_XPCOM_LIBRARY_FILE                   "XpcomLib"
101
102/* Property will return the current location of the the GRE directory.  
103 * If no GRE is used, this propery will behave like 
104 * NS_XPCOM_CURRENT_PROCESS_DIR.
105 */
106#define NS_GRE_DIR                              "GreD"
107
108/* Property will return the current location of the the GRE component 
109 * directory.  If no GRE is used, this propery will behave like 
110 * NS_XPCOM_COMPONENT_DIR.
111 */
112#define NS_GRE_COMPONENT_DIR                    "GreComsD" 
113
114
115/* Platform Specific Locations */
116
117#if !defined (XP_UNIX) || defined(XP_MACOSX)
118    #define NS_OS_SYSTEM_DIR                    "SysD"
119#endif
120
121#if defined (XP_MACOSX)
122    #define NS_MAC_DESKTOP_DIR                  NS_OS_DESKTOP_DIR
123    #define NS_MAC_TRASH_DIR                    "Trsh"
124    #define NS_MAC_STARTUP_DIR                  "Strt"
125    #define NS_MAC_SHUTDOWN_DIR                 "Shdwn"
126    #define NS_MAC_APPLE_MENU_DIR               "ApplMenu"
127    #define NS_MAC_CONTROL_PANELS_DIR           "CntlPnl"
128    #define NS_MAC_EXTENSIONS_DIR               "Exts"
129    #define NS_MAC_FONTS_DIR                    "Fnts"
130    #define NS_MAC_PREFS_DIR                    "Prfs"
131    #define NS_MAC_DOCUMENTS_DIR                "Docs"
132    #define NS_MAC_INTERNET_SEARCH_DIR          "ISrch"
133    #define NS_OSX_HOME_DIR                     NS_OS_HOME_DIR
134    #define NS_MAC_HOME_DIR                     NS_OS_HOME_DIR
135    #define NS_MAC_DEFAULT_DOWNLOAD_DIR         "DfltDwnld"
136    #define NS_MAC_USER_LIB_DIR                 "ULibDir"   // Only available under OS X
137    #define NS_OSX_DEFAULT_DOWNLOAD_DIR         NS_MAC_DEFAULT_DOWNLOAD_DIR
138    #define NS_OSX_USER_DESKTOP_DIR             "UsrDsk"
139    #define NS_OSX_LOCAL_DESKTOP_DIR            "LocDsk"
140    #define NS_OSX_USER_APPLICATIONS_DIR        "UsrApp"
141    #define NS_OSX_LOCAL_APPLICATIONS_DIR       "LocApp"
142    #define NS_OSX_USER_DOCUMENTS_DIR           "UsrDocs"
143    #define NS_OSX_LOCAL_DOCUMENTS_DIR          "LocDocs"
144    #define NS_OSX_USER_INTERNET_PLUGIN_DIR     "UsrIntrntPlgn"
145    #define NS_OSX_LOCAL_INTERNET_PLUGIN_DIR    "LoclIntrntPlgn"
146    #define NS_OSX_USER_FRAMEWORKS_DIR          "UsrFrmwrks"
147    #define NS_OSX_LOCAL_FRAMEWORKS_DIR         "LocFrmwrks"
148    #define NS_OSX_USER_PREFERENCES_DIR         "UsrPrfs"
149    #define NS_OSX_LOCAL_PREFERENCES_DIR        "LocPrfs"
150    #define NS_OSX_PICTURE_DOCUMENTS_DIR        "Pct"
151    #define NS_OSX_MOVIE_DOCUMENTS_DIR          "Mov"
152    #define NS_OSX_MUSIC_DOCUMENTS_DIR          "Music"
153    #define NS_OSX_INTERNET_SITES_DIR           "IntrntSts"
154#elif defined (XP_WIN)
155    #define NS_WIN_WINDOWS_DIR                  "WinD"
156    #define NS_WIN_PROGRAM_FILES_DIR            "ProgF"
157    #define NS_WIN_HOME_DIR                     NS_OS_HOME_DIR
158    #define NS_WIN_DESKTOP_DIR                  "DeskV" // virtual folder at the root of the namespace
159    #define NS_WIN_PROGRAMS_DIR                 "Progs" // User start menu programs directory!
160    #define NS_WIN_CONTROLS_DIR                 "Cntls"
161    #define NS_WIN_PRINTERS_DIR                 "Prnts"
162    #define NS_WIN_PERSONAL_DIR                 "Pers"
163    #define NS_WIN_FAVORITES_DIR                "Favs"
164    #define NS_WIN_STARTUP_DIR                  "Strt"
165    #define NS_WIN_RECENT_DIR                   "Rcnt"
166    #define NS_WIN_SEND_TO_DIR                  "SndTo"
167    #define NS_WIN_BITBUCKET_DIR                "Buckt"
168    #define NS_WIN_STARTMENU_DIR                "Strt"
169// This gives the same thing as NS_OS_DESKTOP_DIR
170    #define NS_WIN_DESKTOP_DIRECTORY            "DeskP" // file sys dir which physically stores objects on desktop
171    #define NS_WIN_DRIVES_DIR                   "Drivs"
172    #define NS_WIN_NETWORK_DIR                  "NetW"
173    #define NS_WIN_NETHOOD_DIR                  "netH"
174    #define NS_WIN_FONTS_DIR                    "Fnts"
175    #define NS_WIN_TEMPLATES_DIR                "Tmpls"
176    #define NS_WIN_COMMON_STARTMENU_DIR         "CmStrt"
177    #define NS_WIN_COMMON_PROGRAMS_DIR          "CmPrgs"
178    #define NS_WIN_COMMON_STARTUP_DIR           "CmStrt"
179    #define NS_WIN_COMMON_DESKTOP_DIRECTORY     "CmDeskP"
180    #define NS_WIN_APPDATA_DIR                  "AppData"
181    #define NS_WIN_LOCAL_APPDATA_DIR            "LocalAppData"
182    #define NS_WIN_PRINTHOOD                    "PrntHd"
183    #define NS_WIN_COOKIES_DIR                  "CookD"
184    #define NS_WIN_DEFAULT_DOWNLOAD_DIR         "DfltDwnld"
185#elif defined (XP_UNIX)
186    #define NS_UNIX_LOCAL_DIR                   "Locl"
187    #define NS_UNIX_LIB_DIR                     "LibD"
188    #define NS_UNIX_HOME_DIR                    NS_OS_HOME_DIR
189    #define NS_UNIX_XDG_DESKTOP_DIR             "XDGDesk"
190    #define NS_UNIX_XDG_DOCUMENTS_DIR           "XDGDocs"
191    #define NS_UNIX_XDG_DOWNLOAD_DIR            "XDGDwnld"
192    #define NS_UNIX_XDG_MUSIC_DIR               "XDGMusic"
193    #define NS_UNIX_XDG_PICTURES_DIR            "XDGPict"
194    #define NS_UNIX_XDG_PUBLIC_SHARE_DIR        "XDGPubSh"
195    #define NS_UNIX_XDG_TEMPLATES_DIR           "XDGTempl"
196    #define NS_UNIX_XDG_VIDEOS_DIR              "XDGVids"
197    #define NS_UNIX_DEFAULT_DOWNLOAD_DIR        "DfltDwnld"
198#elif defined (XP_OS2)
199    #define NS_OS2_DIR                          "OS2Dir"
200    #define NS_OS2_HOME_DIR                     NS_OS_HOME_DIR
201    #define NS_OS2_DESKTOP_DIR                  NS_OS_DESKTOP_DIR
202#elif defined (XP_BEOS)
203    #define NS_BEOS_SETTINGS_DIR                "Setngs"
204    #define NS_BEOS_HOME_DIR                    NS_OS_HOME_DIR
205    #define NS_BEOS_DESKTOP_DIR                 NS_OS_DESKTOP_DIR
206#endif
207
208/* Deprecated */
209
210#define NS_OS_DRIVE_DIR                         "DrvD"
211
212
213
214#endif