1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/lowlevellibsandfws/apputils/inc/BAUTILS.H Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,132 @@
1.4 +// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +//
1.18 +
1.19 +#if !defined(__BAUTILS_H__)
1.20 +#define __BAUTILS_H__
1.21 +
1.22 +#include <e32std.h>
1.23 +#include <f32file.h>
1.24 +#include <barsread.h>
1.25 +#include <badesca.h>
1.26 +
1.27 +/**
1.28 +@publishedAll
1.29 +@released
1.30 +*/
1.31 +const TUint KBaflCharTruncation=0x2026; // Unicode's "horizontal ellipsis"
1.32 +
1.33 +/**
1.34 +There are at most 16 languages in the language downgrade path.
1.35 +The end of the language path is marked by an ELangNone.
1.36 +@publishedAll
1.37 +@released
1.38 +*/
1.39 +const TInt KMaxDowngradeLanguages = 16;
1.40 +
1.41 +/**
1.42 +@publishedAll
1.43 +@released
1.44 +*/
1.45 +typedef TLanguage TLanguagePath[KMaxDowngradeLanguages + 1];
1.46 +
1.47 +class RFs;
1.48 +class CBaflFileSortTable;
1.49 +class TDigitizerCalibration;
1.50 +
1.51 +
1.52 +class BaflUtils
1.53 +/**
1.54 +Provides simple-to-use file system utilities.
1.55 +
1.56 +The functions listed in "Copying, renaming, and deleting files" create and
1.57 +use a CFileMan object. They are useful for one-off calls, but for repeated
1.58 +use it is more efficient to use CFileMan directly.
1.59 +
1.60 +Note that there is a very similiar group of functions available in EikFileUtils,
1.61 +which may be easier to use in GUI applications, as they do not require a file
1.62 +server session to be passed.
1.63 +
1.64 +@see CFileMan
1.65 +@see EikFileUtils
1.66 +@publishedAll
1.67 +@released
1.68 +*/
1.69 + {
1.70 +public:
1.71 + IMPORT_C static void CopyWithTruncation(TDes& aDest,const TDesC& aSrc,TChar aTruncationSymbol=KBaflCharTruncation);
1.72 + IMPORT_C static TBool FileExists(const RFs& aFs,const TDesC& aFileName);
1.73 + IMPORT_C static void EnsurePathExistsL(RFs& aFs,const TDesC& aFileName);
1.74 + IMPORT_C static TPtrC ExtractAppNameFromFullName(const TFullName &aName);
1.75 + IMPORT_C static void NearestLanguageFile(const RFs& aFs,TFileName& aName);
1.76 + IMPORT_C static void NearestLanguageFile(const RFs& aFs,TFileName& aName, TLanguage& aLanguage);
1.77 + IMPORT_C static TInt SetIdealLanguage(TLanguage aLanguage);
1.78 + IMPORT_C static TLanguage IdealLanguage();
1.79 + IMPORT_C static void ReleaseIdealLanguage();
1.80 + IMPORT_C static TInt GetSystemDrive(TDriveNumber& aDriveNumber);
1.81 + IMPORT_C static TBool PathExists(RFs& aFs,const TDesC& aFileName);
1.82 + IMPORT_C static TInt IsFolder(const RFs& aFs, const TDesC& aFullName, TBool& aIsFolder);
1.83 + IMPORT_C static TBool FolderExists(RFs& aFs, const TDesC& aFolderName);
1.84 + IMPORT_C static TFileName FolderNameFromFullName(const TDesC& aFullName);
1.85 + IMPORT_C static TFileName DriveAndPathFromFullName(const TDesC& aFullName);
1.86 + IMPORT_C static TFileName RootFolderPath(const TBuf<1> aDriveLetter);
1.87 + IMPORT_C static void AbbreviateFileName(const TFileName& aOriginalFileName, TDes& aAbbreviatedFileName);
1.88 + IMPORT_C static TBool UidTypeMatches(const TUidType& aFileUid, const TUidType& aMatchUid);
1.89 + IMPORT_C static TInt Parse(const TDesC& aName);
1.90 + IMPORT_C static TInt ValidateFolderNameTypedByUserL(const RFs& aFs, const TDesC& aFolderNameTypedByUser, const TDesC& aCurrentPath, TFileName& aNewFolderFullName);
1.91 + IMPORT_C static TInt CopyFile(RFs& aFs, const TDesC& aSourceFullName, const TDesC& aTargetFullName, TUint aSwitch = CFileMan::EOverWrite);
1.92 + IMPORT_C static TInt RenameFile(RFs& aFs, const TDesC& aOldFullName, const TDesC& aNewFullName, TUint aSwitch = CFileMan::EOverWrite);
1.93 + IMPORT_C static TInt DeleteFile(RFs& aFs, const TDesC& aSourceFullName, TUint aSwitch = 0);
1.94 + IMPORT_C static TInt CheckWhetherFullNameRefersToFolder(const TDesC& aFullName, TBool& aIsFolder);
1.95 + IMPORT_C static TInt MostSignificantPartOfFullName(const TDesC& aFullName, TFileName& aMostSignificantPart);
1.96 + IMPORT_C static TInt CheckFolder(RFs& aFs, const TDesC& aFolderName);
1.97 + IMPORT_C static TInt DiskIsReadOnly(RFs& aFs, const TDesC& aFullName, TBool& aIsReadOnly);
1.98 + IMPORT_C static TInt DriveIsReadOnlyInternal(RFs& aFs, const TDesC& aFullName, TBool& aIsReadOnlyInternal);
1.99 + IMPORT_C static void GetDiskListL(const RFs& aFs,CDesCArray& aArray);
1.100 + IMPORT_C static void UpdateDiskListL(const RFs& aFs,CDesCArray& aArray,TBool aIncludeRom,TDriveNumber aDriveNumber);
1.101 + IMPORT_C static void RemoveSystemDirectory(CDir& aDir);
1.102 + IMPORT_C static TBool IsFirstDriveForSocket(TDriveUnit aDriveUnit);
1.103 + IMPORT_C static TInt SortByTable(CDir& aDir,CBaflFileSortTable* aTable);
1.104 + IMPORT_C static void GetDowngradePathL(const RFs& aFs, const TLanguage aCurrentLanguage, RArray<TLanguage>& aLanguageArray);
1.105 + IMPORT_C static void PersistLocale();
1.106 + IMPORT_C static TInt PersistHAL();
1.107 + IMPORT_C static void PersistScreenCalibration(const TDigitizerCalibration& aScreenCalibration);
1.108 + IMPORT_C static void InitialiseScreenCalibration(RFs& aFs);
1.109 + IMPORT_C static void InitialiseHAL(RFs& aFs);
1.110 + IMPORT_C static void InitialiseLocale(RFs& aFs);
1.111 + IMPORT_C static void GetEquivalentLanguageList(TLanguage aLang, TLanguagePath& aEquivalents);
1.112 + IMPORT_C static void NearestLanguageFileV2(const RFs& aFs,TFileName& aName, TLanguage& aLanguage);
1.113 +
1.114 +private:
1.115 + static void DoCopyFileL(RFs& aFs, const TDesC& aSourceFullName, const TDesC& aTargetFullName, TUint aSwitch);
1.116 + static void DoRenameFileL(RFs& aFs, const TDesC& aOldFullName, const TDesC& aNewFullName, TUint aSwitch);
1.117 + static void DoDeleteFileL(RFs& aFs, const TDesC& aSourceFullName, TUint aSwitch);
1.118 + };
1.119 +
1.120 +
1.121 +/**
1.122 + * Bafl File Sort Table containing an array of UIDs.
1.123 + * @publishedAll
1.124 + * @released
1.125 + */
1.126 +class CBaflFileSortTable : public CArrayFixFlat<TUid>
1.127 + {
1.128 +public:
1.129 + IMPORT_C CBaflFileSortTable();
1.130 + IMPORT_C void ConstructFromResourceL(TResourceReader& aReader);
1.131 +private:
1.132 + enum {EArrayGranularity=4};
1.133 + };
1.134 +
1.135 +#endif