1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/ossrv/lowlevellibsandfws/apputils/src/BaUtilsImp.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,143 @@
1.4 +// Copyright (c) 2001-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 +// Declarations for some internal BAFL functions
1.20 +#include <bautils.h>
1.21 +#include <f32file.h>
1.22 +#include <e32std.h>
1.23 +
1.24 +/**
1.25 +Specifies the maximum length of the numerical part of the suffix.
1.26 +
1.27 +If this is changed the documentation of the following functions
1.28 +must also be updated:
1.29 +
1.30 + BaflUtils::NearestLanguageFile()
1.31 + TNearestLanguageFileFinder::CountDigitsFromEndInValidSuffix()
1.32 + TNearestLanguageFileFinder::SetFileName()
1.33 +*/
1.34 +const TInt KMaxSuffixLength = 5;
1.35 +
1.36 +class RDirectoryScanner
1.37 +/**
1.38 +@internalAll
1.39 +*/
1.40 + {
1.41 +public:
1.42 + virtual TInt Open(RFs& aFs, const TDesC& aMatchPattern) = 0;
1.43 + virtual TInt Next(TEntry& aOut) = 0;
1.44 + virtual void Close() = 0;
1.45 + virtual ~RDirectoryScanner() {}
1.46 + };
1.47 +
1.48 +NONSHARABLE_CLASS(RRealDirectoryScanner) : public RDirectoryScanner
1.49 +/**
1.50 +@internalAll
1.51 +*/
1.52 + {
1.53 +public:
1.54 + virtual TInt Open(RFs& aFs, const TDesC& aMatchPattern);
1.55 + virtual TInt Next(TEntry& aOut);
1.56 + virtual void Close();
1.57 +private:
1.58 + RDir iDir;
1.59 + };
1.60 +
1.61 +/**
1.62 + * Add a language to the end of the language path, unless it is already
1.63 + * present. On entry, the language path must have an ELangNone entry at its
1.64 + * end. This will be true on exit also.
1.65 + * @internalAll
1.66 + */
1.67 +void AddLanguage(TLanguagePath& aPath, TLanguage aNewLanguage);
1.68 +
1.69 +/**
1.70 + * Create a language path from the current language, ideal language and locale.
1.71 + * The path may have up to eight entries in it.
1.72 + * @internalAll
1.73 + */
1.74 +
1.75 +void MakeLanguageDowngradePath(TLanguagePath& aPath,
1.76 + TLanguage aCurrent, TLanguage aIdeal, const TLocale& aLocale);
1.77 +
1.78 +
1.79 +/**
1.80 + * This class contains all the functions for working out the nearest language
1.81 + * file. It can be derived from for test code purposes.
1.82 + * @internalAll
1.83 + */
1.84 +NONSHARABLE_CLASS(TNearestLanguageFileFinder)
1.85 + {
1.86 +public:
1.87 + TNearestLanguageFileFinder(const RFs& aFs);
1.88 + TBool SetFileName(TFileName& aFileName);
1.89 + TLanguage Language();
1.90 + // put back the original suffix and drive letter
1.91 + void RepairFileName();
1.92 + // add the preset custom resource drive, if any, to iDrives.
1.93 + TInt AddCustomResourceDrive();
1.94 + // add all remaining drives to iDrives. iDrives must not have more than one
1.95 + // drive in it on entry.
1.96 + void AddAllDrives();
1.97 + // Tries to append the language code to iFileName. This is 00..09 or just the number.
1.98 + // If there was not enough space, EFalse is returned.
1.99 + TBool AppendLanguageCode(TLanguage aLanguage);
1.100 + // Search the drives in iDrives for the file named iFileName.
1.101 + // iFileName must have a drive specifier, which will be overwritten.
1.102 + TBool FindDrive();
1.103 + // Search for files across all drives in all languages in the path plus the
1.104 + // language-neutral file.
1.105 + // On entry, iFileName should be the original name with a drive specifier
1.106 + // minus the suffix. On return, iFileName will be untouched if EFalse is
1.107 + // returned, but contain the result if ETrue is returned.
1.108 + TBool FindLanguageAndDrive();
1.109 + // Test whether the filename passed in matches the stem given + numbers
1.110 + // added to the end. Returns the number if it does, or KErrNotFound if not.
1.111 + // aFileName must not end in a digit.
1.112 + static TInt LanguageNumberFromFile(const TDesC& aFileName, const TDesC& aStem);
1.113 + // Find lowest numbered file that matches iFileName, which must be without
1.114 + // its suffix.
1.115 + TInt FindFirstLanguageFile(RFs&);
1.116 + // Try each drive for any language files that match iFileName.
1.117 + // iFileName must have a directory specifier and be without its suffix.
1.118 + // returns KErrNotFound, KErrNone or error code.
1.119 + TInt FindFirstLanguageFileAndDrive();
1.120 +
1.121 + virtual TInt GetCustomResourceDriveNumber() const;
1.122 +
1.123 + virtual TInt FileExists(const TDesC& aFileName) const;
1.124 + // return our member that is our directory scanning class
1.125 + virtual RDirectoryScanner& DirectoryScanner();
1.126 + virtual ~TNearestLanguageFileFinder() {}
1.127 +
1.128 +private:
1.129 + TInt CountDigitsFromEnd(const TDesC& aFilename);
1.130 + TInt CountDigitsFromEndInSuffix (const TDesC& aFilename);
1.131 +
1.132 +public:
1.133 + const RFs& iFs;
1.134 + TFileName* iFileName;
1.135 + TLanguage iLanguage;
1.136 + TBuf<26> iDrives;
1.137 + TLanguagePath iPath;
1.138 + TBuf<KMaxSuffixLength> iSuffix;
1.139 + TInt iInitialDriveLetter;
1.140 + // length minus the removed suffix
1.141 + TInt iOriginalBaseLength;
1.142 + // length plus added drive letter minus removed suffix
1.143 + TInt iBaseLength;
1.144 + RRealDirectoryScanner iDirScanner;
1.145 + };
1.146 +