/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/*
 * The contents of this file are subject to the Netscape Public
 * License Version 1.1 (the "License"); you may not use this file
 * except in compliance with the License. You may obtain a copy of
 * the License at http://www.mozilla.org/NPL/
 *
 * Software distributed under the License is distributed on an "AS
 * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
 * implied. See the License for the specific language governing
 * rights and limitations under the License.
 *
 * The Original Code is Mozilla Communicator client code, 
 * released March 31, 1998. 
 *
 * The Initial Developer of the Original Code is Netscape Communications 
 * Corporation.  Portions created by Netscape are
 * Copyright (C) 1998 Netscape Communications Corporation. All
 * Rights Reserved.
 *
 * Contributor(s): 
 *     John R. McMullen <mcmullen@netscape.com>
 */

#ifndef _NSFILELOCATIONS_H_
#define _NSFILELOCATIONS_H_

#include "nsFileSpec.h"
#include "nsIFileLocator.h"
#include "nsIDirectoryService.h"

#ifdef XP_MAC
#include <Types.h>
#endif


class nsFileLocator : public nsIFileLocator
//=============================================================================
{
public:
  nsFileLocator();
  
  NS_DECL_ISUPPORTS
  
  NS_IMETHOD GetFileLocation(
      PRUint32 aType,
        // NOTE: actually either nsSpecialFileSpec:Type, see nsFileLocations.h
        // or nsSpecialSystemDirectory::SystemDirectories, see nsSpecialSystemDirectory.h
      nsIFileSpec** outSpec);

  NS_IMETHOD ForgetProfileDir();

protected:
  
  virtual ~nsFileLocator();

};




class nsFileLocationProvider : public nsIDirectoryServiceProvider
//=============================================================================
{
public:
  nsFileLocationProvider();

  NS_DECL_ISUPPORTS
  NS_DECL_NSIDIRECTORYSERVICEPROVIDER

protected:
  virtual ~nsFileLocationProvider();

};



//
//
//
//
//
// Talk to dougt@netscape.com before adding any more locations to this file!!
//
//
//
//
//
//
//

//========================================================================================
class NS_APPSHELL nsSpecialFileSpec : public nsFileSpec
//========================================================================================
{

    public:
        enum Type
        {
            // Use a big offset, so that values passed to nsIFileLocator can share the
            // same range as the type nsSpecialSystemDirectory::SystemDirectories.
            
            // Who has not wished one could have inheritance for enumerated types?
            
            App_DirectoryBase              = 0x00010000
        ,   App_PrefsDirectory30           = App_DirectoryBase +    1 
        ,   App_PrefsDirectory40           = App_DirectoryBase +    2
        ,   App_PrefsDirectory50           = App_DirectoryBase +    3

        ,   App_ResDirectory               = App_DirectoryBase +    5

        ,   App_UserProfileDirectory30     = App_DirectoryBase +   10
        ,   App_UserProfileDirectory40     = App_DirectoryBase +   11
        ,   App_UserProfileDirectory50     = App_DirectoryBase +   12
        ,   App_DefaultUserProfileRoot30   = App_DirectoryBase +   13
        ,   App_DefaultUserProfileRoot40   = App_DirectoryBase +   14
        ,   App_DefaultUserProfileRoot50   = App_DirectoryBase +   15
        ,   App_ProfileDefaultsFolder30    = App_DirectoryBase +   16
        ,   App_ProfileDefaultsFolder40    = App_DirectoryBase +   17
        ,   App_ProfileDefaultsFolder50    = App_DirectoryBase +   18
        ,   App_PrefDefaultsFolder50       = App_DirectoryBase +   19
	,   App_ShrimpDirectory            = App_DirectoryBase +   20
        ,   App_ProfileDefaultsFolder50_nloc    = App_DirectoryBase +   21

        ,   App_DefaultsFolder50           = App_DirectoryBase +   25

        ,   App_ComponentsDirectory        = App_DirectoryBase +   30
        ,   App_ChromeDirectory            = App_DirectoryBase +   31
        ,   App_PluginsDirectory           = App_DirectoryBase +   32

        ,   App_UserChromeDirectory        = App_DirectoryBase +   40

        ,   App_FileBase                   = App_DirectoryBase + 1000
        ,   App_PreferencesFile30          = App_FileBase      +    1
        ,   App_PreferencesFile40          = App_FileBase      +    2
        ,   App_PreferencesFile50          = App_FileBase      +    3

        ,   App_BookmarksFile30            = App_FileBase      +   10
        ,   App_BookmarksFile40            = App_FileBase      +   11
        ,   App_BookmarksFile50            = App_FileBase      +   12

        ,   App_Registry40                 = App_FileBase      +   20
        ,   App_Registry50                 = App_FileBase      +   21
        ,   App_LocalStore50               = App_FileBase   +  30
        ,   App_History50              = App_FileBase   +  40
        ,   App_MailDirectory50        = App_FileBase   +  50
        ,   App_ImapMailDirectory50    = App_FileBase   +  60
        ,   App_NewsDirectory50        = App_FileBase   +  70
        ,   App_MessengerFolderCache50 = App_FileBase   +  80
        ,   App_UsersPanels50          = App_FileBase   +  90
        ,   App_SearchFile50           = App_FileBase   + 100
        ,   App_SearchDirectory50      = App_FileBase   + 101
        ,   App_UsersMimeTypes50	   = App_FileBase   + 102
        };
                    //nsSpecialFileSpec();
                    nsSpecialFileSpec(Type aType);        
    virtual         ~nsSpecialFileSpec();
    void            operator = (Type aType);
    void            operator = (const nsFileSpec& inOther) { *(nsFileSpec*)this = inOther; }
    PRBool          operator == (const nsFileSpec& inOther)
                        { return nsFileSpec::operator == (inOther); }
 
private:
    void            operator = (const char* inPath) { *(nsFileSpec*)this = inPath; }

}; // class NS_APPSHELL nsSpecialFileSpec


#endif // _NSFILELOCATIONS_H_