// Copyright (c) 1995-2009 Nokia Corporation and/or its subsidiary(-ies).

// All rights reserved.

// This component and the accompanying materials are made available

// under the terms of the License "Eclipse Public License v1.0"

// which accompanies this distribution, and is available

// at the URL "http://www.eclipse.org/legal/epl-v10.html".

//

// Initial Contributors:

// Nokia Corporation - initial contribution.

//

// Contributors:

//

// Description:

//

/**

 @file

 @publishedAll

 @released

*/

#if !defined(__F32FILE_H__)

#define __F32FILE_H__

#if !defined(__E32BASE_H__)

#include <e32base.h>

#endif

#ifndef SYMBIAN_ENABLE_PUBLIC_PLATFORM_HEADER_SPLIT

// Old implementation including platform e32svr.h (which includes the several other platform headers)...

#if !defined(__E32SVR_H__)

#include <e32svr.h>

#endif

#include <e32ldr.h>

#else

// New implementation including only the public headers needed for f32file.h...

#include <e32ldr.h>

// And the public headers previously included via e32svr.h but otherwise not needed for f32file.h...

#include <e32def.h>

#include <e32event.h>

#include <e32debug.h>

#include <e32keys.h> 

#endif

//-------------------------------------------------------------------------------------------------------------------

/*

    A brief description of the structure of paths and filenames in the Symbian OS.

    A full file or directory name consists of four components:

        - the drive: a single letter followed by a colon.

        - the path, starting with a backslash and ending with the final backslash in the name. The backslashes divide the path into components.

        - the file name: everything from the character following the last backslash to the character preceding the final dot.

        - optional extension, which consists of everything after the final dot. 

    A directory is identified by a trailing slash: thus, 'c:\\wrd\\' indicates a directory, but 'c:\\wrd' indicates a file with no extension. 

    There are some restrictions that apply to the file or directory names.

        - full name should not contain wild cards ('?' or '*' characters)

        - file or directory name should not contain illegal characters like '<', '>', ':', '"', '/', '|' and '\000'. 

        - file or directory name containing only white space characters is illegal.

        - white space characters are those one that are identified by TChar::IsSpace(). ASCII and all UNICODE white space characters

          are considered equivalent. E.g. characters with codes 0x20, U+0020, U+3000, U+2009, etc. considered as equivalent white spaces.

*/

//-------------------------------------------------------------------------------------------------------------------

/**

@publishedAll

@released

The session default drive.

*/

const TInt KDefaultDrive=KMaxTInt;

/**

@publishedAll

@released

Indicates a drive letter which is not in use. 

This is useful when scanning a drive list to find which drives are available.

*/

const TInt KDriveAbsent=0x00;

/**

@publishedAll

@released

The default value for the number of message slots passed to RFs::Connect().

@see RFs::Connect

*/

const TInt KFileServerDefaultMessageSlots=-1;

/**

@publishedAll

@released

The size of the array of TEntry items contained in a TEntryArray object.

@see TEntryArray

@see TEntry

*/

const TInt KEntryArraySize=(0x200*sizeof(TText));

/**

@publishedAll

@released

The character used to separate directories in the path name.

*/

const TInt KPathDelimiter='\\';

/**

@publishedAll

@released

The character used to separate the drive letter from the path.

*/

const TInt KDriveDelimiter=':';

/**

@publishedAll

@released

The character used to separate the filename from the extension.

*/

const TInt KExtDelimiter='.';

/**

@publishedAll

@released

The maximum number of available drives.

*/

const TInt KMaxDrives=26;

/**

@publishedAll

@released

The maximum number of available proxy drives.

*/

const TInt KMaxProxyDrives=KMaxDrives-KMaxLocalDrives;

/**

@publishedAll

@released

Defines a modifiable buffer descriptor to contain a drive list.

The descriptor has maximum length KMaxDrives, sufficient to contain

all possible drive letters.

@see RFs::DriveList

@see KMaxDrives

*/

typedef TBuf8<KMaxDrives> TDriveList;

/**

@publishedAll

@released

The maximum length of a drivename.

Sufficient for a drive letter and colon.

*/

const TInt KMaxDriveName=0x02;

/**

@publishedAll

@released

Defines a modifiable buffer descriptor to contain a drive name.

A drive name comprises a drive letter (A through Z) and a colon.

KMaxDriveName (2 bytes) is sufficient for a drive letter and colon.

@see TDriveUnit::Name

@see KMaxDriveName

*/

typedef TBuf<KMaxDriveName> TDriveName;

/**

@publishedAll

@released

The maximum length of a file system name or file system sub type name.

32 characters is sufficient for a file system or sub type name.

*/

const TInt KMaxFSNameLength=0x0020;

/**

@publishedAll

@released

Defines a modifiable buffer descriptor to contain a file system or file system sub type name.

@see KMaxFSNameLength

*/

typedef TBuf<KMaxFSNameLength> TFSName;

/**

@publishedAll

@released

File/directory attribute: any file without the hidden or system attribute.

*/

const TUint KEntryAttNormal=0x0000;

/**

@publishedAll

@released

File/directory attribute: read-only file or directory.

*/

const TUint KEntryAttReadOnly=0x0001;

/**

@publishedAll

@released

File/directory attribute: hidden file or directory.

*/

const TUint KEntryAttHidden=0x0002;

/**

@publishedAll

@released

File/directory attribute: system file.

*/

const TUint KEntryAttSystem=0x0004;

/**

@publishedAll

@released

File/directory attribute: volume name directory.

*/

const TUint KEntryAttVolume=0x0008;

/**

@publishedAll

@released

File/directory attribute: a directory without the hidden or system attribute.

*/

const TUint KEntryAttDir=0x0010;

/**

@publishedAll

@released

File/directory attribute: an archive file.

*/

const TUint KEntryAttArchive=0x0020;

/**

@publishedAll

@released

File/directory attribute: ROM eXecute In Place file

*/

const TUint KEntryAttXIP=0x0080;

/**

@publishedAll

@released

This file attribute bit is set if the file exists only on a remote file 

system and is not locally cached.

Due to the potential high-latency of remote file systems, applications 

(or users of applications) may make use of this bit to modify their 

behaviour when working with remote files.

This is a read-only attribute, so any attempt to set this attribute will

will be ignored.

*/

const TUint KEntryAttRemote=0x0100;

/**

@publishedAll

@released

The range of entry attributes reserved for file-system specific meanings.

File systems may assign meaning to these bits, but their definition will

not be supported nor maintained by Symbian.

All other file attribute bits are reserved for use by Symbian.

The following table summarises the assignment of attribute bits:

	 0 - KEntryAttReadOnly

	 1 - KEntryAttHidden

	 2 - KEntryAttSystem

	 3 - KEntryAttVolume

	 4 - KEntryAttDir

	 6 - KEntryAttArchive

	 7 - KEntryAttXIP

	 8 - KEntryAttRemote

	 9 - Reserved

	10 - Reserved

	11 - Reserved

	12 - Reserved

	13 - Reserved

	14 - Reserved

	15 - Reserved

	16 - File System Specific

	17 - File System Specific

	18 - File System Specific

	19 - File System Specific

	20 - File System Specific

	22 - File System Specific

	22 - File System Specific

	23 - File System Specific

	24 - KEntryAttPacked

	25 - Reserved

	26 - Reserved

	27 - KEntryAttMatchExclude

	28 - KEntryAttAllowUid

	29 - Reserved

	30 - KEntryAttMatchExclusive

	31 - Reserved

*/

const TUint KEntryAttMaskFileSystemSpecific=0x00FF0000;

/**

@publishedAll

@released

Bit mask for matching file and directory entries.

This mask ensures that directories and hidden and

system files are matched.

(Note that KEntryAttNormal matches all entry types except directories, hidden

and system entries).

@see RFs::GetDir

*/

const TUint KEntryAttMatchMask=(KEntryAttHidden|KEntryAttSystem|KEntryAttDir);

/**

@publishedAll

@released

Bit mask for matching file and directory entries.

This is used when all entry types, including hidden and system files,

but excluding the volume entry are to be matched.

@see RFs::GetDir

*/

const TUint KEntryAttMaskSupported=0x3f;

/**

@publishedAll

@released

Bit mask for matching file and directory entries.

This is used for exclusive matching. When OR'ed with one or more file attribute

constants, for example, KEntryAttNormal, it ensures that only the files with

those attributes are matched.

When OR’ed with KEntryAttDir, directories only (not hidden or system) are matched.

@see KEntryAttDir

@see KEntryAttNormal

@see RFs::GetDir

*/

const TUint KEntryAttMatchExclusive=0x40000000;

/**

@publishedAll

@released

Bit mask for feature manager file entries.

It is used in order to identify each ROM feature set data file 

uniquely in the mount order of ROM sections.

*/

const TUint KEntryAttUnique=0x01000000;

/**

@publishedAll

@released

Bit mask for matching file and directory entries.

It is used to exclude files or directories with certain attributes from

directory listings. This bitmask has the opposite effect

to KEntryAttMatchExclusive. For example:

@code

KEntryAttMatchExclude|KEntryAttReadOnly

@endcode

excludes all read only entries from the directory listing.

@code

KEntryAttMatchExclusive|KEntryAttReadOnly

@endcode

lists only read only entries.

@see KEntryAttMatchExclusive

@see RFs::GetDir

*/

const TUint KEntryAttMatchExclude=0x08000000;

/**

@publishedAll

@released

Bit mask for matching file and directory entries.

Bit mask flag used when UID information should be included in the directory

entry listing.

@see RFs::GetDir

*/

const TUint KEntryAttAllowUid=0x10000000;

/**

@publishedAll

@released

Indicates that a TEntry (that is generally returned from a TEntryArray) is

stored in packed format where the iSizeHigh and iReserved fields follow the

valid characters of the name string.  Before accessing the aforementioned