1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/textandloc/textandlocutils/numbergrouping/src/NumberGrouping.cpp Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,953 @@
1.4 +/*
1.5 +* Copyright (c) 2002-2008 Nokia Corporation and/or its subsidiary(-ies).
1.6 +* All rights reserved.
1.7 +* This component and the accompanying materials are made available
1.8 +* under the terms of the License "Eclipse Public License v1.0"
1.9 +* which accompanies this distribution, and is available
1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.11 +*
1.12 +* Initial Contributors:
1.13 +* Nokia Corporation - initial contribution.
1.14 +*
1.15 +* Contributors:
1.16 +*
1.17 +* Description:
1.18 +*
1.19 +*/
1.20 +
1.21 +#include <f32file.h>
1.22 +#include <barsc.h>
1.23 +#include "NumberGrouping.h"
1.24 +#include "RegularExpression.h"
1.25 +#include "cleanuputil.h"
1.26 +
1.27 +#include <barsread.h>
1.28 +//#include <eikenv.h>
1.29 +#include <centralrepository.h>
1.30 +#include <NumberGroupingCRKeys.h>
1.31 +
1.32 +const TText KNumberGroupingWildcard('n');
1.33 +const TText KNumberGroupingOneOrMoreCharactersToken('~');
1.34 +
1.35 +// This constant represents all the valid whitespace that we can handle. Several
1.36 +// APIs give whitespace special significance as a formatting character, especially
1.37 +// those methods used to obtain text for formatting into fixed-width UI elements
1.38 +// where spaces are not to be rendered at the margins.
1.39 +const TText KNumberGroupingSpace(' ');
1.40 +
1.41 +const TInt KMinimumLengthToGroup = 1; // No grouping occurs if fewer than this in unformatted buffer
1.42 +
1.43 +#include <numbergrouping.rsg>
1.44 +
1.45 +
1.46 +GLDEF_C void Panic(TNumberGroupingPanic aPanic)
1.47 + {
1.48 + _LIT(KPanicCat,"Number Grouping");
1.49 + User::Panic(KPanicCat, aPanic);
1.50 + }
1.51 +
1.52 +// Valid phone number characters apart from IsDigit() characters are listed here
1.53 +const TText KAdditionalPhoneNumberCharacters[] = {'+','#','*','p','w'};
1.54 +
1.55 +
1.56 +
1.57 +
1.58 +NONSHARABLE_CLASS(CPNGNumberGroupingExtension): public CBase
1.59 + {
1.60 +public:
1.61 + CPNGNumberGroupingExtension();
1.62 + ~CPNGNumberGroupingExtension();
1.63 +public:
1.64 + TInt iMaxExtraCharacters;
1.65 + TInt iNumberGroupingCRValue;
1.66 + };
1.67 +
1.68 +CPNGNumberGroupingExtension::CPNGNumberGroupingExtension()
1.69 + {
1.70 + }
1.71 +
1.72 +CPNGNumberGroupingExtension::~CPNGNumberGroupingExtension()
1.73 + {
1.74 + }
1.75 +
1.76 +
1.77 +
1.78 +CPNGNumberGrouping::TPNGSeparator::TPNGSeparator()
1.79 + : iPosition(-1), iSeparatorCharacter(KNumberGroupingSpace)
1.80 + {
1.81 + }
1.82 +
1.83 +CPNGNumberGrouping::TPNGSeparator::TPNGSeparator( TInt aPosition, TText aSeparatorCharacter )
1.84 + : iPosition(aPosition), iSeparatorCharacter(aSeparatorCharacter)
1.85 + {
1.86 + }
1.87 +
1.88 +CPNGNumberGrouping::TPNGGroupingInfo::TPNGGroupingInfo()
1.89 + {
1.90 + }
1.91 +
1.92 +// CPNGNumberGrouping - grouping engine class
1.93 +CPNGNumberGrouping::CPNGNumberGrouping(TInt aMaxLength /* = 0 */, TBool aReversed /* = EFalse */) :
1.94 + iForceLanguage(ELangTest),
1.95 + iUnformattedNumberPtr(KNullDesC),
1.96 + iFormattedNumberPtr(KNullDesC),
1.97 + iReverseFormattedNumberPtr(KNullDesC),
1.98 + iSelectionPtr(KNullDesC),
1.99 + iLanguage(ELangTest),
1.100 + iMaxUnformattedLength(aMaxLength),
1.101 + iReversed(aReversed),
1.102 + iMatchedPatternIndex(ENoMatchedPattern)
1.103 + {
1.104 + }
1.105 +
1.106 +EXPORT_C CPNGNumberGrouping* CPNGNumberGrouping::NewL( TInt aMaxLength, TBool aReserved)
1.107 + {
1.108 + CPNGNumberGrouping* s = NewLC(aMaxLength, aReserved);
1.109 + CleanupStack::Pop();
1.110 + return s;
1.111 + }
1.112 +
1.113 +EXPORT_C CPNGNumberGrouping* CPNGNumberGrouping::NewLC( TInt aMaxLength, TBool aReserved)
1.114 + {
1.115 + CPNGNumberGrouping* s = new(ELeave)CPNGNumberGrouping( aMaxLength, aReserved);
1.116 + CleanupStack::PushL(s);
1.117 + s->ConstructL();
1.118 + return s;
1.119 + }
1.120 +
1.121 +void CPNGNumberGrouping::ConstructL()
1.122 + {
1.123 + iExtension = new (ELeave) CPNGNumberGroupingExtension();
1.124 + CRepository* repository = NULL;
1.125 + iExtension->iNumberGroupingCRValue = 0;
1.126 + TRAPD(ret, repository = CRepository::NewL(KCRUidNumberGrouping));
1.127 + if (ret == KErrNone)
1.128 + {
1.129 + ret = repository->Get(KNumberGrouping, iExtension->iNumberGroupingCRValue);
1.130 + }
1.131 + delete repository;
1.132 +
1.133 + // Read from resource first in order to obtain a value for iExtension->iMaxExtraCharacters
1.134 + iLanguage = doReadLanguageFromSharedData();
1.135 + doReadFormatInfoFromResourceFileL(); // This sets iExtension->iMaxExtraCharacters
1.136 +
1.137 + // Allocation of buffers. Note that iMaxUnformattedLength must be retained as member
1.138 + // data because HBufCs may come back with more storage available than asked for.
1.139 + // The uncertainty in the actual length provided by the HBufCs means that although
1.140 + // they are asked to be different by iExtension->iMaxExtraCharacters, the difference between the
1.141 + // actual MaxLengths may be less than iMaxExtraCharcaters.
1.142 + // The approach decided upon is to retain iMaxUnformattedLength as member data and
1.143 + // use IT everywhere throughout this class's implementation, NEVER using
1.144 + // iUnformattedNumber->Des().MaxLength()
1.145 + iUnformattedNumber = HBufC::NewL(iMaxUnformattedLength);
1.146 + iFormattedNumber = HBufC::NewL(iMaxUnformattedLength + iExtension->iMaxExtraCharacters);
1.147 +
1.148 + // Create revesed buffer only if requested
1.149 + if ( iReversed )
1.150 + iReverseFormattedNumber = HBufC::NewL(iMaxUnformattedLength + iExtension->iMaxExtraCharacters);
1.151 + }
1.152 +
1.153 +EXPORT_C CPNGNumberGrouping::~CPNGNumberGrouping()
1.154 + {
1.155 + doClearGroupingItemsList();
1.156 +
1.157 + delete iUnformattedNumber;
1.158 + delete iFormattedNumber;
1.159 + delete iReverseFormattedNumber;
1.160 + delete iRegExp;
1.161 + delete iExtension;
1.162 + }
1.163 +
1.164 +EXPORT_C TInt CPNGNumberGrouping::Insert(TInt aIndex, TText aChar)
1.165 + {
1.166 +
1.167 + if( aIndex >= 0 && aIndex <= iUnformattedNumber->Length())
1.168 + {
1.169 +
1.170 + if(iUnformattedNumber->Length() >= iMaxUnformattedLength)
1.171 + return KErrOverflow;
1.172 +
1.173 + TBuf<1> bufChar(1);
1.174 + bufChar[0] = aChar;
1.175 + TPtr ptrModifyable(iUnformattedNumber->Des());
1.176 + ptrModifyable.Insert(aIndex, bufChar);
1.177 +
1.178 + doClearFormattedNumbers();
1.179 +
1.180 + return KErrNone;
1.181 + }
1.182 +
1.183 + return KErrIndexOutOfRange;
1.184 + }
1.185 +
1.186 +EXPORT_C TInt CPNGNumberGrouping::Delete(TInt aIndex)
1.187 + {
1.188 + if(aIndex >= 0 && aIndex < iUnformattedNumber->Length())
1.189 + {
1.190 + TPtr ptrModifyable(iUnformattedNumber->Des());
1.191 + ptrModifyable.Delete(aIndex, KSingleCharacter);
1.192 +
1.193 + doClearFormattedNumbers();
1.194 +
1.195 + return KErrNone;
1.196 + }
1.197 +
1.198 + return KErrIndexOutOfRange;
1.199 + }
1.200 +
1.201 +EXPORT_C TInt CPNGNumberGrouping::Append(TText aChar)
1.202 + {
1.203 + if(iUnformattedNumber->Length() >= iMaxUnformattedLength)
1.204 + return KErrOverflow;
1.205 +
1.206 + TBuf<1> bufChar(1);
1.207 + bufChar[0] = aChar;
1.208 + TPtr ptrModifyable(iUnformattedNumber->Des());
1.209 + ptrModifyable.Append(bufChar);
1.210 +
1.211 + doClearFormattedNumbers();
1.212 +
1.213 + return KErrNone;
1.214 + }
1.215 +
1.216 +EXPORT_C TInt CPNGNumberGrouping::Set(const TDesC& aNumber)
1.217 + {
1.218 + if( aNumber.Length() > iMaxUnformattedLength )
1.219 + return KErrOverflow;
1.220 +
1.221 + TPtr ptrModifyable( iUnformattedNumber->Des() );
1.222 + ptrModifyable.Copy( aNumber );
1.223 +
1.224 + doClearFormattedNumbers();
1.225 +
1.226 + return KErrNone;
1.227 + }
1.228 +
1.229 +EXPORT_C TInt CPNGNumberGrouping::Length() const
1.230 + {
1.231 + if(!iFormattedNumber->Length()) // This test is used as the trigger to reformat
1.232 + FormattedNumber();
1.233 +
1.234 + return iFormattedNumber->Length();
1.235 + }
1.236 +
1.237 +EXPORT_C TInt CPNGNumberGrouping::UnFormattedLength() const
1.238 + {
1.239 + return iUnformattedNumber->Length();
1.240 + }
1.241 +
1.242 +EXPORT_C TInt CPNGNumberGrouping::MaxDisplayLength() const
1.243 + {
1.244 + // Despite its name, this method returns the max length of the UNFORMATTED buffer
1.245 + // This must not be implemented to return the actual length available in
1.246 + // iUnformattedBuffer.
1.247 + return iMaxUnformattedLength;
1.248 + }
1.249 +
1.250 +EXPORT_C TBool CPNGNumberGrouping::IsSpace(TInt aPos) const
1.251 + {
1.252 + // Very tricky semantics for this. Must be a space inserted by the formatting
1.253 + if ( iFormattedNumber->Length() > aPos &&
1.254 + iFormattedNumber->operator[](aPos) == KNumberGroupingSpace &&
1.255 + // Check also that is is less than the length to group + inserted characters
1.256 + aPos < ( LengthToGroup() + (iFormattedNumber->Length() - iUnformattedNumber->Length()) ) )
1.257 + return ETrue;
1.258 + else
1.259 + return EFalse;
1.260 + }
1.261 +
1.262 +EXPORT_C const TDesC& CPNGNumberGrouping::FormattedNumber(TInt aFrom, TInt aTo) const
1.263 + {
1.264 + if(iUnformattedNumber->Length() != 0 &&
1.265 + aFrom >= 0 &&
1.266 + aFrom <= aTo )
1.267 + {
1.268 + FormattedNumber();
1.269 + iFormattedNumberPtr.Set(KNullDesC);
1.270 +
1.271 + TInt length = iFormattedNumber->Length();
1.272 + if(aTo < length + 1)
1.273 + {
1.274 + TInt length = iFormattedNumber->Length();
1.275 + if ( iExtension->iNumberGroupingCRValue )
1.276 + {
1.277 + // Advance to the next non-space
1.278 + while( (aFrom < length ) && (*iFormattedNumber)[aFrom] == KNumberGroupingSpace )
1.279 + {
1.280 + ++aFrom;
1.281 + }
1.282 +
1.283 + // Retreat to the last non-space
1.284 + while( (aTo > 0) && (*iFormattedNumber)[aTo] == KNumberGroupingSpace )
1.285 + {
1.286 + --aTo;
1.287 + }
1.288 + }
1.289 +
1.290 + // Does fetching the descriptor still make sense?
1.291 + if ( (0 <= aFrom) && (aFrom <= aTo) && (aTo < length) )
1.292 + iFormattedNumberPtr.Set( iFormattedNumber->Mid( aFrom, aTo-aFrom+1 ) );
1.293 + }
1.294 + }
1.295 + else
1.296 + {
1.297 + if(iFormattedNumber->Length())
1.298 + {
1.299 + CPNGNumberGrouping* pThis = const_cast<CPNGNumberGrouping*>(this);
1.300 + pThis->doClearFormattedNumbers();
1.301 + }
1.302 +
1.303 + iFormattedNumberPtr.Set(KNullDesC);
1.304 + }
1.305 +
1.306 + return iFormattedNumberPtr;
1.307 + }
1.308 +
1.309 +EXPORT_C const TDesC& CPNGNumberGrouping::FormattedNumber() const
1.310 + {
1.311 + if( !iFormattedNumber->Length() )
1.312 + {
1.313 + TInt err = KErrNone;
1.314 +
1.315 + CPNGNumberGrouping* pThis = const_cast<CPNGNumberGrouping*>(this);
1.316 +
1.317 + if( LengthToGroup() < KMinimumLengthToGroup || !iExtension->iNumberGroupingCRValue )
1.318 + {
1.319 + // This is now just a short cut, as doNumberGroupingL handles premature truncation of
1.320 + // formatting. But this avoids all the language checking
1.321 + doNumberSquashing(); // copies the unformatted number straight into the formatted number
1.322 + }
1.323 + else
1.324 + {
1.325 + TLanguage eLanguage;
1.326 + if(iForceLanguage != ELangTest)
1.327 + eLanguage = iForceLanguage;
1.328 + else
1.329 + eLanguage = doReadLanguageFromSharedData();
1.330 +
1.331 + if(eLanguage != iLanguage)
1.332 + {
1.333 + iLanguage = eLanguage;
1.334 +
1.335 + TRAP(err, pThis->doReadFormatInfoFromResourceFileL());
1.336 + if(err != KErrNone)
1.337 + {
1.338 + iFormattedNumberPtr.Set(KNullDesC);
1.339 + return iFormattedNumberPtr;
1.340 + }
1.341 + }
1.342 +
1.343 + TRAP(err, doNumberGroupingL());
1.344 + }
1.345 +
1.346 + if(err != KErrNone)
1.347 + pThis->doClearFormattedNumbers();
1.348 + else
1.349 + iFormattedNumberPtr.Set(iFormattedNumber->Ptr(), iFormattedNumber->Length());
1.350 + }
1.351 +
1.352 + return iFormattedNumberPtr;
1.353 + }
1.354 +
1.355 +EXPORT_C const TDesC& CPNGNumberGrouping::ReverseFormattedNumber(TInt aFrom, TInt aTo) const
1.356 + {
1.357 + if ( iReversed )
1.358 + {
1.359 + if(iUnformattedNumber->Length() != 0 &&
1.360 + aFrom >= 0 &&
1.361 + aFrom <= aTo)
1.362 + {
1.363 + ReverseFormattedNumber();
1.364 +
1.365 + iReverseFormattedNumberPtr.Set(KNullDesC);
1.366 +
1.367 + TInt length = iReverseFormattedNumber->Length();
1.368 + if( aTo < length + 1 )
1.369 + {
1.370 + // Advance to the next non-space
1.371 + if( iExtension->iNumberGroupingCRValue )
1.372 + {
1.373 + while( (aFrom < length ) && (*iReverseFormattedNumber)[aFrom] == KNumberGroupingSpace )
1.374 + {
1.375 + ++aFrom;
1.376 + }
1.377 +
1.378 + // Retreat to the last non-space
1.379 + while( (aTo > 0) && (*iReverseFormattedNumber)[aTo] == KNumberGroupingSpace )
1.380 + {
1.381 + --aTo;
1.382 + }
1.383 + }
1.384 +
1.385 + // Does fetching the descriptor still make sense?
1.386 + if ( (0 <= aFrom) && (aFrom <= aTo) && (aTo < length) )
1.387 + iReverseFormattedNumberPtr.Set(
1.388 + iReverseFormattedNumber->Mid( aFrom, aTo-aFrom+1) );
1.389 + }
1.390 + }
1.391 + else
1.392 + iReverseFormattedNumberPtr.Set(KNullDesC);
1.393 + }
1.394 +
1.395 + return iReverseFormattedNumberPtr; // Zero initialized at construction
1.396 + }
1.397 +
1.398 +EXPORT_C const TDesC& CPNGNumberGrouping::ReverseFormattedNumber() const
1.399 + {
1.400 + if( iReverseFormattedNumber && !iReverseFormattedNumber->Length())
1.401 + {
1.402 + if(!iFormattedNumber->Length())
1.403 + FormattedNumber();
1.404 +
1.405 + TInt nLength = iFormattedNumber->Length();
1.406 +
1.407 + TPtr ptrModifyable(iReverseFormattedNumber->Des());
1.408 + TBuf<1> bufChar(1);
1.409 +
1.410 + for(TInt i = nLength; i > 0; --i)
1.411 + {
1.412 + TText cChar = (*iFormattedNumber)[i-1];
1.413 + bufChar[0] = cChar;
1.414 + ptrModifyable.Insert(nLength - i, bufChar);
1.415 + }
1.416 +
1.417 + iReverseFormattedNumberPtr.Set(iReverseFormattedNumber->Ptr(), nLength);
1.418 + }
1.419 +
1.420 + return iReverseFormattedNumberPtr;
1.421 + }
1.422 +
1.423 +EXPORT_C const TDesC& CPNGNumberGrouping::Selection(TInt aFrom, TInt aTo) const
1.424 + {
1.425 + if(aFrom < iUnformattedNumber->Length())
1.426 + {
1.427 + TPtr ptrUnformatted = iUnformattedNumber->Des();
1.428 + iSelectionPtr.Set(&(ptrUnformatted[aFrom]), aTo - aFrom);
1.429 + }
1.430 + else
1.431 + iSelectionPtr.Set(KNullDesC);
1.432 +
1.433 + return iSelectionPtr;
1.434 + }
1.435 +
1.436 +EXPORT_C const TDesC& CPNGNumberGrouping::UnFormattedNumber(TInt aFrom, TInt aTo) const
1.437 + {
1.438 + if (iUnformattedNumber && aFrom >= 0 && aFrom <= aTo && aTo < iUnformattedNumber->Length())
1.439 + {
1.440 + iUnformattedNumberPtr.Set(&((*iUnformattedNumber)[aFrom]), aTo - aFrom + 1);
1.441 + }
1.442 + else
1.443 + {
1.444 + iUnformattedNumberPtr.Set(KNullDesC);
1.445 + }
1.446 + return iUnformattedNumberPtr;
1.447 + }
1.448 +
1.449 +EXPORT_C const TDesC& CPNGNumberGrouping::UnFormattedNumber() const
1.450 + {
1.451 + return UnFormattedNumber(0, iUnformattedNumber->Length() - 1);
1.452 + }
1.453 +
1.454 +TLanguage CPNGNumberGrouping::doReadLanguageFromSharedData() const
1.455 + {
1.456 + if (iExtension->iNumberGroupingCRValue)
1.457 + {
1.458 + return ELangAmerican;
1.459 + }
1.460 + else
1.461 + {
1.462 + return ELangTest;
1.463 + }
1.464 + }
1.465 +
1.466 +void CPNGNumberGrouping::doClearFormattedNumbers()
1.467 + {
1.468 + TPtr ptrModifyable( iUnformattedNumber->Des() );
1.469 +
1.470 + for (TInt index = 0; index < ptrModifyable.Length(); index++)
1.471 + {
1.472 + TChar ch = TChar(ptrModifyable[index]);
1.473 + ch.Fold( TChar::EFoldDigits | TChar::EFoldSpaces);
1.474 + }
1.475 +
1.476 + iFormattedNumber->Des().Zero();
1.477 + iFormattedNumberPtr.Set(KNullDesC);
1.478 +
1.479 + if ( iReverseFormattedNumber )
1.480 + iReverseFormattedNumber->Des().Zero();
1.481 +
1.482 + iReverseFormattedNumberPtr.Set(KNullDesC);
1.483 + iMatchedPatternIndex = ENoMatchedPattern;
1.484 + }
1.485 +
1.486 +void CPNGNumberGrouping::doReadFormatInfoFromResourceFileL()
1.487 + {
1.488 + doClearGroupingItemsList();
1.489 + delete iRegExp;
1.490 + iRegExp = NULL;
1.491 +
1.492 + RPointerArray<TDesC> parrGroupingPatternsList;
1.493 + CleanupResetAndDestroyPushL(parrGroupingPatternsList);
1.494 +
1.495 + TInt maxExtraCharacters(0);
1.496 +
1.497 + RFs fs;
1.498 + CleanupClosePushL(fs);
1.499 + if(fs.Connect() == KErrNone)
1.500 + {
1.501 + RResourceFile resourceFile;
1.502 + CleanupClosePushL(resourceFile);
1.503 +
1.504 + resourceFile.OpenL(fs, _L("z:\\resource\\numbergrouping.rsc"));
1.505 + HBufC8* bufResource = resourceFile.AllocReadL(R_GROUPING_MAPPING);
1.506 +
1.507 + TResourceReader resourceReader;
1.508 + resourceReader.SetBuffer(bufResource);
1.509 +
1.510 + TInt nLanguageCount = resourceReader.ReadInt8();
1.511 + TBool bLanguageMatches = EFalse;
1.512 +
1.513 + while(nLanguageCount-- || !bLanguageMatches)
1.514 + {
1.515 + TBool bLanguageMatches = (resourceReader.ReadInt8() == iLanguage);
1.516 +
1.517 + if(bLanguageMatches || ((nLanguageCount == -1) && !bLanguageMatches))
1.518 + {
1.519 + TInt nGroupingSchemeCount = resourceReader.ReadInt8();
1.520 +
1.521 + while(nGroupingSchemeCount--)
1.522 + {
1.523 + TInt thisMaxExtraCharacters(0);
1.524 + ReadGroupingSchemeL(
1.525 + resourceReader, parrGroupingPatternsList, thisMaxExtraCharacters );
1.526 + // take this new max extra characters if bigger
1.527 + maxExtraCharacters = Max( maxExtraCharacters, thisMaxExtraCharacters );
1.528 + }
1.529 +
1.530 + break; // This breaks out because we take the first language that matches
1.531 +
1.532 + } // End of if on language/locale test
1.533 + else // skip other locales
1.534 + {
1.535 + TInt nGroupingSchemeCount = resourceReader.ReadInt8();
1.536 + while(nGroupingSchemeCount--)
1.537 + {
1.538 + SkipGroupingSchemeL( resourceReader );
1.539 + }
1.540 + }
1.541 + }
1.542 +
1.543 + delete bufResource;
1.544 +
1.545 + resourceFile.Close();
1.546 + CleanupStack::Pop(); // resource file
1.547 + }
1.548 +
1.549 + fs.Close();
1.550 + CleanupStack::Pop(); // file system
1.551 +
1.552 + iExtension->iMaxExtraCharacters = maxExtraCharacters; // Latch the high water mark of extra characters
1.553 +
1.554 + iRegExp = CRegularExpression::NewL(&parrGroupingPatternsList);
1.555 +
1.556 + CleanupStack::PopAndDestroy(&parrGroupingPatternsList); // patterns list
1.557 + }
1.558 +
1.559 +void CPNGNumberGrouping::doNumberGroupingL() const
1.560 + {
1.561 + TInt lengthToGroup = LengthToGroup();
1.562 +
1.563 + if ( lengthToGroup >= KMinimumLengthToGroup )
1.564 + {
1.565 +
1.566 + TInt matchedPattern = KErrNotFound;
1.567 + TInt newMatchedPattern = KErrNotFound;
1.568 +
1.569 + // Search for matches in the RegExp object. It returns the next matching pattern
1.570 + // However, even if there is a match, lengthToGroup may not be in the deployment
1.571 + // length range between minDigits and MaxDigits, inclusive
1.572 + do {
1.573 + // Check for another matching pattern
1.574 + newMatchedPattern = iRegExp->SearchFrom( newMatchedPattern+1, *iUnformattedNumber);
1.575 +
1.576 + if( newMatchedPattern != KErrNotFound) // Found a match, but it is OK?
1.577 + {
1.578 +
1.579 + TInt minDigits = iGroupingItemsList[newMatchedPattern]->iMinNumberOfDigits;
1.580 + TInt maxDigits = iGroupingItemsList[newMatchedPattern]->iMaxNumberOfDigits;
1.581 +
1.582 + // Fill in sensible values for min and max if not present
1.583 + if(minDigits == -1)
1.584 + minDigits = 0;
1.585 + if(maxDigits == -1)
1.586 + maxDigits = lengthToGroup;
1.587 +
1.588 + if ( minDigits <= lengthToGroup && lengthToGroup <= maxDigits )
1.589 + {
1.590 + matchedPattern = newMatchedPattern; // accept this new pattern
1.591 + break;
1.592 + }
1.593 + }
1.594 +
1.595 + } while ( newMatchedPattern != KErrNotFound );
1.596 +
1.597 + // Actually go and do the grouping
1.598 + if ( matchedPattern != KErrNotFound )
1.599 + {
1.600 + doNumberGroupingForPatternL( matchedPattern, lengthToGroup );
1.601 + return;
1.602 + }
1.603 +
1.604 + }
1.605 +
1.606 + // if we get to here, either the string was not matched to any of the patterns or the
1.607 + // unformatted string is exactly the display length. In either case we call
1.608 + // doNumberSquashing() which simply leaves the string as it is...
1.609 + doNumberSquashing();
1.610 +
1.611 + }
1.612 +
1.613 +
1.614 +void CPNGNumberGrouping::doNumberGroupingForPatternL( TInt aMatchingPattern, TInt aLengthToGroup ) const
1.615 + {
1.616 + iMatchedPatternIndex = aMatchingPattern;
1.617 +
1.618 + TInt nLowPos = 0;
1.619 + TInt nHighPos = 0;
1.620 +
1.621 + TPtr desUnformattedNumber = iUnformattedNumber->Des();
1.622 + TInt unformattedLength = iUnformattedNumber->Length();
1.623 +
1.624 + __ASSERT_ALWAYS( aLengthToGroup <= unformattedLength , Panic(ENumberGroupingBadLengthToGroup) );
1.625 +
1.626 + TPNGGroupingInfo* matchedPattern = iGroupingItemsList[iMatchedPatternIndex];
1.627 + TInt nAfterCount = matchedPattern->iAfterPositions.Count();
1.628 + TBool bBeforePosition = (matchedPattern->iBeforePosition.iPosition == -1)?0:1;
1.629 +
1.630 + // Test to see if the beforePosition can be used with the current text length.
1.631 + // The following does not allow the before position to be used if it would result in an
1.632 + // insertion right next to one from the AfterPositions.
1.633 + // That is, tildas in the formatting string represent 1 or more characters.
1.634 + // e.g. if the last afterPosition is 4 and the before position is 3, then a 7 digit
1.635 + // number will not be able to have the before position used.
1.636 + if( nAfterCount &&
1.637 + (unformattedLength - matchedPattern->iBeforePosition.iPosition) <=
1.638 + matchedPattern->iAfterPositions[nAfterCount - 1].iPosition)
1.639 + {
1.640 + bBeforePosition = EFalse;
1.641 + }
1.642 +
1.643 + TPtr ptrModifyable(iFormattedNumber->Des());
1.644 +
1.645 + for(TInt i = 0; i < nAfterCount && nHighPos < aLengthToGroup ; ++i)
1.646 + {
1.647 + nHighPos = matchedPattern->iAfterPositions[i].iPosition;
1.648 + if ( nHighPos >= aLengthToGroup )
1.649 + break;
1.650 +
1.651 + if(nHighPos < unformattedLength)
1.652 + {
1.653 + ptrModifyable.Append( desUnformattedNumber.Mid( nLowPos, nHighPos - nLowPos) );
1.654 + ptrModifyable.Append(matchedPattern->iAfterPositions[i].iSeparatorCharacter);
1.655 + nLowPos = nHighPos;
1.656 + }
1.657 + }
1.658 +
1.659 + // Do not do "before end" formatting at all if there is any truncation
1.660 + if ( aLengthToGroup < unformattedLength )
1.661 + {
1.662 + TInt nBeforePosition = matchedPattern->iBeforePosition.iPosition;
1.663 +
1.664 + if(bBeforePosition && nBeforePosition < unformattedLength)
1.665 + {
1.666 + nHighPos = unformattedLength - nBeforePosition;
1.667 + ptrModifyable.Append( desUnformattedNumber.Mid( nLowPos, nHighPos - nLowPos) );
1.668 + ptrModifyable.Append( matchedPattern->iBeforePosition.iSeparatorCharacter );
1.669 + nLowPos = nHighPos;
1.670 + }
1.671 + }
1.672 +
1.673 + nHighPos = unformattedLength;
1.674 + ptrModifyable.Append( desUnformattedNumber.Mid( nLowPos, nHighPos - nLowPos) );
1.675 +
1.676 + }
1.677 +
1.678 +void CPNGNumberGrouping::doNumberSquashing() const
1.679 + {
1.680 + __ASSERT_ALWAYS( !iFormattedNumber->Length(), Panic(ENumberGroupingFormattedNumberAlreadyExists) );
1.681 +
1.682 + // just copy from one t'other...
1.683 + TPtr ptrModifyable(iFormattedNumber->Des());
1.684 + ptrModifyable.Copy(*iUnformattedNumber);
1.685 + iMatchedPatternIndex = ENoMatchedPattern;
1.686 + }
1.687 +
1.688 +void CPNGNumberGrouping::doClearGroupingItemsList()
1.689 + {
1.690 + TInt nCount = iGroupingItemsList.Count();
1.691 +
1.692 + for(TInt i = 0; i < nCount; ++i)
1.693 + {
1.694 + iGroupingItemsList[i]->iAfterPositions.Close();
1.695 + delete iGroupingItemsList[i];
1.696 + iGroupingItemsList[i] = NULL;
1.697 + }
1.698 + iGroupingItemsList.Close();
1.699 + }
1.700 +
1.701 +void CPNGNumberGrouping::ReadGroupingSchemeL(
1.702 + TResourceReader& aResourceReader,
1.703 + RPointerArray<TDesC>& aGroupingPatternsList,
1.704 + TInt& aMaxExtraCharacters )
1.705 + {
1.706 + CleanupResetAndDestroyPushL(aGroupingPatternsList);
1.707 + TPNGGroupingInfo* groupingInfo = new (ELeave) TPNGGroupingInfo;
1.708 + CleanupStack::PushL( groupingInfo );
1.709 +
1.710 + // Read in all resource for this grouping scheme, perform checking and then analyze it
1.711 + HBufC* initialDigits = aResourceReader.ReadHBufCL();
1.712 + __ASSERT_ALWAYS( initialDigits, Panic( ENumberGroupingNoInitialDigitsInResource ) );
1.713 + CleanupStack::PushL( initialDigits );
1.714 +
1.715 + groupingInfo->iMinNumberOfDigits = aResourceReader.ReadInt8();
1.716 + groupingInfo->iMaxNumberOfDigits = aResourceReader.ReadInt8();
1.717 + __ASSERT_DEBUG(
1.718 + ( groupingInfo->iMaxNumberOfDigits == -1) ||
1.719 + ( groupingInfo->iMinNumberOfDigits <= groupingInfo->iMaxNumberOfDigits ),
1.720 + Panic( ENumberGroupingBadMinMaxDigitRangeInResource ) );
1.721 +
1.722 + // Read in formatting Pattern
1.723 + HBufC* formatPattern = aResourceReader.ReadHBufCL();
1.724 +
1.725 + if ( formatPattern ) // Does not have to be there
1.726 + {
1.727 + CleanupStack::PushL( formatPattern );
1.728 + TInt formatLength = formatPattern->Length();
1.729 + if ( formatLength > 0 )
1.730 + {
1.731 + // Obtain a wildcard version of the matching pattern in initialDigits.
1.732 + // This is used to check the supplied formatPattern for comformance to initialDigits
1.733 + HBufC* wildcardedMatchBuf = HBufC::NewLC( formatLength ); // Will not be longer than the search pattern
1.734 +
1.735 + TPtr wildcardedMatchPtr( wildcardedMatchBuf->Des() );
1.736 + // Get the example number using the latest search pattern only
1.737 + GetWildcardVersionOfMatchStringL( *initialDigits, KNumberGroupingWildcard, wildcardedMatchPtr );
1.738 +
1.739 + // Now parse the descriptor
1.740 + TBool trailingPossible(EFalse);
1.741 + ParseForAfterPositions(
1.742 + *formatPattern, groupingInfo, wildcardedMatchPtr, aMaxExtraCharacters, trailingPossible );
1.743 +
1.744 + // Now parse the descriptor from the end if needed
1.745 + if ( trailingPossible )
1.746 + ParseForBeforePosition( *formatPattern, groupingInfo, aMaxExtraCharacters );
1.747 +
1.748 + CleanupStack::PopAndDestroy( wildcardedMatchBuf );
1.749 + }
1.750 + CleanupStack::PopAndDestroy( formatPattern );
1.751 + } // End of if on formatPattern.Length
1.752 +
1.753 + User::LeaveIfError( aGroupingPatternsList.Append( initialDigits ) );
1.754 + CleanupStack::Pop( initialDigits );
1.755 +
1.756 + // Do not leave if the next one fails, but remove the last from the patterns list and then leave
1.757 + // This is done in case someone TRAPs. Otherwise neither of these lists would be used and their
1.758 + // mismatch would not be a problem
1.759 + if ( TInt err = iGroupingItemsList.Append(groupingInfo) != KErrNone )
1.760 + {
1.761 + // return value of Count will be at least 1, because we have just successfully gone through an Append
1.762 + aGroupingPatternsList.Remove( aGroupingPatternsList.Count() - 1 );
1.763 + // ownership is now mine again...
1.764 + delete initialDigits;
1.765 + // Need to delete groupingInfo, and make sure it is no longer on the cleanupstack
1.766 + CleanupStack::PopAndDestroy( groupingInfo );
1.767 + User::Leave(err);
1.768 + }
1.769 + else
1.770 + {
1.771 + CleanupStack::Pop( groupingInfo ); // Success. This object now not owned by the cleanupstack
1.772 + }
1.773 +
1.774 + CleanupStack::Pop(&aGroupingPatternsList);
1.775 + }
1.776 +
1.777 +void CPNGNumberGrouping::ParseForAfterPositions(
1.778 + const TDesC& aFormatPattern,
1.779 + TPNGGroupingInfo* aGroupingInfo,
1.780 + const TDesC& aWildcardedMatchingPattern,
1.781 + TInt& aMaxExtraCharacters,
1.782 + TBool& trailingPossible ) const
1.783 + {
1.784 + TInt pos(0); // Keeps track of the position with which the next separator will be stored
1.785 + TInt formatLength = aFormatPattern.Length();
1.786 + for (TInt index = 0; index < formatLength; index++ )
1.787 + {
1.788 + // The format pattern is compared with the matching pattern. The matching pattern may be
1.789 + // shorter than the format pattern, so by default a wildcard character is used.
1.790 + TText ch = aFormatPattern[index];
1.791 + TText matchingChar(KNumberGroupingWildcard); // default to expect is the wildcard character
1.792 + if ( pos < aWildcardedMatchingPattern.Length() ) // if still within the matching pattern
1.793 + matchingChar = aWildcardedMatchingPattern[pos];
1.794 + if ( ch == matchingChar )
1.795 + pos++; // not a separator. index where the next "after" marker goes
1.796 + else if ( ch == KNumberGroupingOneOrMoreCharactersToken )
1.797 + {
1.798 + // finish looking for "afterPositions". But there may be a "before" position in the
1.799 + // remainder, so set the flag
1.800 + trailingPossible = ETrue;
1.801 + break;
1.802 + }
1.803 + else
1.804 + {
1.805 + // Explicit prevention of any separator characters being valid phone numbers
1.806 +#ifdef _DEBUG
1.807 + if ( IsValidPhoneNumberCharacter( ch ) || ch == KNumberGroupingWildcard )
1.808 + {
1.809 + RDebug::Print(
1.810 + _L("NumberGrouping: Illegal character or format mismatch in resource: initialDigits pattern= <%S> formatPattern=<%S>"),
1.811 + &aWildcardedMatchingPattern, &aFormatPattern );
1.812 + }
1.813 +#endif
1.814 + __ASSERT_DEBUG( !IsValidPhoneNumberCharacter( ch ), Panic( ENumberGroupingInvalidSeparatorCharacterInFormat ) );
1.815 + __ASSERT_DEBUG( ch != KNumberGroupingWildcard, Panic( ENumberGroupingMatchingPatternVersusFormatPatternMismatch ) );
1.816 + TPNGSeparator separator( pos, aFormatPattern[index]);
1.817 + aGroupingInfo->iAfterPositions.Append(separator);
1.818 + aMaxExtraCharacters++;
1.819 + }
1.820 + }
1.821 + }
1.822 +
1.823 +void CPNGNumberGrouping::ParseForBeforePosition(
1.824 + const TDesC& aFormatPattern,
1.825 + TPNGGroupingInfo* aGroupingInfo,
1.826 + TInt& aMaxExtraCharacters ) const
1.827 + {
1.828 + TInt pos=0;
1.829 + TInt formatLength = aFormatPattern.Length();
1.830 +
1.831 + for (TInt index = formatLength-1; index >=0; index-- )
1.832 + {
1.833 + TText ch = aFormatPattern[index];
1.834 + if ( ch == KNumberGroupingWildcard )
1.835 + pos++;
1.836 + else if ( ch == KNumberGroupingOneOrMoreCharactersToken )
1.837 + break;
1.838 + else
1.839 + {
1.840 + // Explicit prevention of any separator characters being valid phone numbers
1.841 +#ifdef _DEBUG
1.842 + if ( IsValidPhoneNumberCharacter( ch ) )
1.843 + {
1.844 + RDebug::Print(
1.845 + _L("NumberGrouping: Illegal character in trailing part of format string in resource: formatPattern=<%S>"),
1.846 + &aFormatPattern );
1.847 + }
1.848 +#endif
1.849 + __ASSERT_DEBUG( !IsValidPhoneNumberCharacter( ch ),
1.850 + Panic( ENumberGroupingInvalidSeparatorCharacterInFormat ) );
1.851 + TPNGSeparator separator( pos, ch );
1.852 + aGroupingInfo->iBeforePosition = separator;
1.853 + aMaxExtraCharacters++;
1.854 + break;
1.855 + }
1.856 + }
1.857 + }
1.858 +
1.859 +
1.860 +void CPNGNumberGrouping::SkipGroupingSchemeL( TResourceReader& aResourceReader ) const
1.861 + {
1.862 + HBufC* tempBuf;
1.863 + tempBuf = aResourceReader.ReadHBufCL();
1.864 + delete tempBuf;
1.865 + aResourceReader.Advance(2); // min and max characters
1.866 + tempBuf = aResourceReader.ReadHBufCL();
1.867 + delete tempBuf;
1.868 + }
1.869 +
1.870 +void CPNGNumberGrouping::GetWildcardVersionOfMatchStringL(
1.871 + const TDesC& aMatchString,
1.872 + TText aWildcard,
1.873 + TDes& aWildcardMatchString ) const
1.874 + {
1.875 + RPointerArray<TDesC> patternList;
1.876 + CleanupClosePushL(patternList);
1.877 +
1.878 + // Make a copy of the input string
1.879 + HBufC* matchString = aMatchString.AllocLC();
1.880 +
1.881 + User::LeaveIfError( patternList.Append(matchString) );// takes ownership
1.882 + CleanupStack::Pop( matchString );
1.883 +
1.884 + CRegularExpression* regExp = CRegularExpression::NewLC(&patternList);
1.885 +
1.886 + // Only 1 pattern fed in. Access that pattern at index 0
1.887 + regExp->GetWildcardVersionOfPattern( 0 , aWildcard, aWildcardMatchString );
1.888 +
1.889 + CleanupStack::PopAndDestroy(regExp);
1.890 +
1.891 + // Delete the patterns list
1.892 + delete patternList[0];
1.893 + CleanupStack::PopAndDestroy();
1.894 + }
1.895 +
1.896 +
1.897 +EXPORT_C TBool CPNGNumberGrouping::IsCharacterInsertedByNumberGrouping(TInt aPos) const
1.898 + {
1.899 + TInt insertedCharacters = Length() - UnFormattedLength();
1.900 +
1.901 + if( insertedCharacters == 0 ) // no formatting was done
1.902 + return EFalse;
1.903 + else if ( aPos < ( insertedCharacters + LengthToGroup() ) )
1.904 + {
1.905 + return !IsValidPhoneNumberCharacter( (*iFormattedNumber)[aPos] );
1.906 + }
1.907 + else // aPos is pointing at or beyond index= LengthToGroup() + <chars inserted>; no formatting there
1.908 + return EFalse;
1.909 + }
1.910 +
1.911 +
1.912 +TBool CPNGNumberGrouping::IsValidPhoneNumberCharacter( TText aCharacter ) const
1.913 + {
1.914 + if ( ((TChar)aCharacter).IsDigit() )
1.915 + return ETrue;
1.916 +
1.917 + // Check through the list of additional valid phone number characters
1.918 + TInt numAdditionalChars = sizeof( KAdditionalPhoneNumberCharacters )/sizeof(TText);
1.919 +
1.920 + for (TInt index = 0; index < numAdditionalChars; index++)
1.921 + {
1.922 + if ( aCharacter == KAdditionalPhoneNumberCharacters[index] )
1.923 + return ETrue;
1.924 + }
1.925 +
1.926 + return EFalse;
1.927 + }
1.928 +
1.929 +EXPORT_C TBool CPNGNumberGrouping::IsChangedByGrouping() const
1.930 + {
1.931 + // The only way that grouping is effectively different is by making things longer
1.932 + return ( Length() > UnFormattedLength() );
1.933 + }
1.934 +
1.935 +TInt CPNGNumberGrouping::LengthToGroup() const
1.936 + {
1.937 +
1.938 + TPtrC ptr = iUnformattedNumber->Des();
1.939 + TInt lengthToGroup = ptr.Length();
1.940 +
1.941 + // Find the first non-digit
1.942 + for (TInt index = 0; index < ptr.Length(); index++)
1.943 + {
1.944 + TChar ch = TChar(ptr[index]);
1.945 + ch.Fold(TChar::EFoldDigits);
1.946 + if ( !( ch.IsDigit() ) )
1.947 + {
1.948 + lengthToGroup = index; // only characters BEFORE the character at index are grouped
1.949 + break;
1.950 + }
1.951 + }
1.952 +
1.953 + return lengthToGroup;
1.954 + }
1.955 +
1.956 +// End of File