/***************************************************************************
//
//	File:			FindDirectory.h
//
//	Copyright 1997, Be Incorporated, All Rights Reserved.
//
//*************************************************************************/


#ifndef _FIND_DIRECTORY_H
#define _FIND_DIRECTORY_H

#include <SupportDefs.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
	/* ---
		first are the per-volume directories.  When asking for these
		directories, a volume must be specified, or the call will assume
		the boot volume.
	--- */

	B_DESKTOP_DIRECTORY				= 0,
	B_TRASH_DIRECTORY,

	/* ---
		here are the beos directories of interest.  These are mostly accessed
		as read-only.
	--- */

	B_BEOS_DIRECTORY				= 1000,
	B_BEOS_SYSTEM_DIRECTORY,
	B_BEOS_ADDONS_DIRECTORY,
	B_BEOS_BOOT_DIRECTORY,
	B_BEOS_FONTS_DIRECTORY,
	B_BEOS_LIB_DIRECTORY,
 	B_BEOS_SERVERS_DIRECTORY,
	B_BEOS_APPS_DIRECTORY,
	B_BEOS_BIN_DIRECTORY,
	B_BEOS_ETC_DIRECTORY,
	B_BEOS_DOCUMENTATION_DIRECTORY,
	B_BEOS_PREFERENCES_DIRECTORY,

	/* ---
		Here are the common directories, shared among all users
	--- */

	B_COMMON_DIRECTORY				= 2000,
	B_COMMON_SYSTEM_DIRECTORY,
	B_COMMON_ADDONS_DIRECTORY,
	B_COMMON_BOOT_DIRECTORY,
	B_COMMON_FONTS_DIRECTORY,
	B_COMMON_LIB_DIRECTORY,
	B_COMMON_SERVERS_DIRECTORY,
	B_COMMON_BIN_DIRECTORY,
	B_COMMON_ETC_DIRECTORY,
	B_COMMON_DOCUMENTATION_DIRECTORY,
	B_COMMON_SETTINGS_DIRECTORY,
	B_COMMON_DEVELOP_DIRECTORY,
	B_COMMON_LOG_DIRECTORY,
	B_COMMON_SPOOL_DIRECTORY,
	B_COMMON_TEMP_DIRECTORY,
	B_COMMON_VAR_DIRECTORY,


	/* ---
		Here are user directories.  These are interpreted in the context
		of the user making the find_directory call.
	--- */

	B_USER_DIRECTORY				= 3000,
	B_USER_CONFIG_DIRECTORY,
	B_USER_ADDONS_DIRECTORY,
	B_USER_BOOT_DIRECTORY,
	B_USER_FONTS_DIRECTORY,
	B_USER_LIB_DIRECTORY,
	B_USER_SETTINGS_DIRECTORY,
	B_USER_DESKBAR_DIRECTORY,

	/* ---
		Here are global directories
	--- */

	B_APPS_DIRECTORY				= 4000,
	B_PREFERENCES_DIRECTORY

} directory_which;

/* ---
	the C interface
--- */

extern status_t find_directory (
	directory_which	which,				/* what directory to return path for */
	dev_t			device,				/* device w/volume, for vol-specific directories */
	bool			create_it,			/* create directory if need be */
	char			*returned_path,		/* buffer for returned path */
	int32			path_length			/* buffer size */
);

#ifdef __cplusplus
}
#endif

#ifdef __cplusplus

class BVolume;
class BPath;

/* ---
	C++ interface
--- */

extern status_t find_directory (
	directory_which	which,
	BPath			*path,
	bool			and_create_it = false,
	BVolume			*vol=NULL
);

#endif

#endif