LCOV - code coverage report
Current view: top level - libreoffice/svl/source/numbers - zforfind.hxx (source / functions) Hit Total Coverage
Test: libreoffice_filtered.info Lines: 7 12 58.3 %
Date: 2012-12-27 Functions: 4 6 66.7 %
Legend: Lines: hit not hit

          Line data    Source code
       1             : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
       2             : /*
       3             :  * This file is part of the LibreOffice project.
       4             :  *
       5             :  * This Source Code Form is subject to the terms of the Mozilla Public
       6             :  * License, v. 2.0. If a copy of the MPL was not distributed with this
       7             :  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
       8             :  *
       9             :  * This file incorporates work covered by the following license notice:
      10             :  *
      11             :  *   Licensed to the Apache Software Foundation (ASF) under one or more
      12             :  *   contributor license agreements. See the NOTICE file distributed
      13             :  *   with this work for additional information regarding copyright
      14             :  *   ownership. The ASF licenses this file to you under the Apache
      15             :  *   License, Version 2.0 (the "License"); you may not use this file
      16             :  *   except in compliance with the License. You may obtain a copy of
      17             :  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
      18             :  */
      19             : 
      20             : #ifndef _ZFORFIND_HXX
      21             : #define _ZFORFIND_HXX
      22             : 
      23             : #include <com/sun/star/uno/Sequence.hxx>
      24             : #include <rtl/ustring.hxx>
      25             : 
      26             : class Date;
      27             : class SvNumberformat;
      28             : class SvNumberFormatter;
      29             : 
      30             : #define SV_MAX_ANZ_INPUT_STRINGS  20    // max count of substrings in input scanner
      31             : 
      32             : class ImpSvNumberInputScan
      33             : {
      34             : public:
      35             :     ImpSvNumberInputScan( SvNumberFormatter* pFormatter );
      36             :     ~ImpSvNumberInputScan();
      37             : 
      38             : /*!*/   void ChangeIntl();                      // MUST be called if language changes
      39             : 
      40             :     /// set reference date for offset calculation
      41             :     void ChangeNullDate( const sal_uInt16 nDay,
      42             :                          const sal_uInt16 nMonth,
      43             :                          const sal_uInt16 nYear );
      44             : 
      45             :     /// convert input string to number
      46             :     bool IsNumberFormat( const OUString& rString,            /// input string
      47             :                          short& F_Type,                      /// format type (in + out)
      48             :                          double& fOutNumber,                 /// value determined (out)
      49             :                          const SvNumberformat* pFormat = NULL);  /// optional a number format to which compare against
      50             : 
      51             :     /// after IsNumberFormat: get decimal position
      52          46 :     short   GetDecPos() const { return nDecPos; }
      53             :     /// after IsNumberFormat: get count of numeric substrings in input string
      54           0 :     sal_uInt16  GetAnzNums() const { return nAnzNums; }
      55             : 
      56             :     /// set threshold of two-digit year input
      57         698 :     void    SetYear2000( sal_uInt16 nVal ) { nYear2000 = nVal; }
      58             :     /// get threshold of two-digit year input
      59           2 :     sal_uInt16  GetYear2000() const { return nYear2000; }
      60             : 
      61             :     /** Whether input can be forced to ISO 8601 format.
      62             : 
      63             :         Depends on locale's date separator and a specific date format order.
      64             : 
      65             :         @param eDateFormat
      66             :             Evaluated only on first call during one scan process, subsequent
      67             :             calls return state of nCanForceToIso8601!
      68             : 
      69             :         @see nCanForceToIso8601
      70             :      */
      71             :     bool CanForceToIso8601( DateFormat eDateFormat );
      72             : 
      73             :     void InvalidateDateAcceptancePatterns();
      74             : 
      75             : private:
      76             :     SvNumberFormatter*  pFormatter;
      77             :     OUString* pUpperMonthText;                  //* Array of month names, uppercase
      78             :     OUString* pUpperAbbrevMonthText;            //* Array of month names, abbreviated, uppercase
      79             :     OUString* pUpperGenitiveMonthText;          //* Array of genitive month names, uppercase
      80             :     OUString* pUpperGenitiveAbbrevMonthText;    //* Array of genitive month names, abbreviated, uppercase
      81             :     OUString* pUpperPartitiveMonthText;         //* Array of partitive month names, uppercase
      82             :     OUString* pUpperPartitiveAbbrevMonthText;   //* Array of partitive month names, abbreviated, uppercase
      83             :     OUString* pUpperDayText;                    //* Array of day of week names, uppercase
      84             :     OUString* pUpperAbbrevDayText;              //* Array of day of week names, abbreviated, uppercase
      85             :     OUString  aUpperCurrSymbol;                 //* Currency symbol, uppercase
      86             :     bool    bTextInitialized;                   //* Whether days and months are initialized
      87             :     bool    bScanGenitiveMonths;                //* Whether to scan an input for genitive months
      88             :     bool    bScanPartitiveMonths;               //* Whether to scan an input for partitive months
      89             :     Date* pNullDate;                            //* 30Dec1899
      90             :     // Variables for provisional results:
      91             :     OUString sStrArray[SV_MAX_ANZ_INPUT_STRINGS]; //* Array of scanned substrings
      92             :     bool       IsNum[SV_MAX_ANZ_INPUT_STRINGS]; //* Whether a substring is numeric
      93             :     sal_uInt16 nNums[SV_MAX_ANZ_INPUT_STRINGS]; //* Sequence of offsets to numeric strings
      94             :     sal_uInt16 nAnzStrings;                     //* Total count of scanned substrings
      95             :     sal_uInt16 nAnzNums;                        //* Count of numeric substrings
      96             :     bool   bDecSepInDateSeps;                   //* True <=> DecSep in {.,-,/,DateSep}
      97             :     sal_uInt8   nMatchedAllStrings;             //* Scan...String() matched all substrings,
      98             : 
      99             :     // bit mask of nMatched... constants
     100             :     static const sal_uInt8 nMatchedEndString;        // 0x01
     101             :     static const sal_uInt8 nMatchedMidString;        // 0x02
     102             :     static const sal_uInt8 nMatchedStartString;      // 0x04
     103             :     static const sal_uInt8 nMatchedVirgin;           // 0x08
     104             :     static const sal_uInt8 nMatchedUsedAsReturn;     // 0x10
     105             : 
     106             :     int    nSign;                               // Sign of number
     107             :     short  nMonth;                              // Month (1..x) if date
     108             :                                                 // negative => short format
     109             :     short  nMonthPos;                           // 1 = front, 2 = middle
     110             :                                                 // 3 = end
     111             :     sal_uInt16 nTimePos;                        // Index of first time separator (+1)
     112             :     short  nDecPos;                             // Index of substring containing "," (+1)
     113             :     short  nNegCheck;                           // '( )' for negative
     114             :     short  nESign;                              // Sign of exponent
     115             :     short  nAmPm;                               // +1 AM, -1 PM, 0 if none
     116             :     short  nLogical;                            // -1 => False, 1 => True
     117             :     sal_uInt16 nThousand;                       // Count of group (AKA thousand) separators
     118             :     sal_uInt16 nPosThousandString;              // Position of concatenaded 000,000,000 string
     119             :     short  eScannedType;                        // Scanned type
     120             :     short  eSetType;                            // Preset Type
     121             : 
     122             :     sal_uInt16 nStringScanNumFor;               // Fixed strings recognized in
     123             :                                                 // pFormat->NumFor[nNumForStringScan]
     124             :     short  nStringScanSign;                     // Sign resulting of FixString
     125             :     sal_uInt16 nYear2000;                       // Two-digit threshold
     126             :                                                 // Year as 20xx
     127             :                                                 // default 18
     128             :                                                 // number <= nYear2000 => 20xx
     129             :                                                 // number >  nYear2000 => 19xx
     130             :     sal_uInt16  nTimezonePos;                   // Index of timezone separator (+1)
     131             : 
     132             :     /** State of ISO 8601 detection.
     133             : 
     134             :         0:= don't know yet
     135             :         1:= no
     136             :         2:= yes, <=2 digits in year
     137             :         3:= yes,   3 digits in year
     138             :         4:= yes, >=4 digits in year
     139             : 
     140             :         @see MayBeIso8601()
     141             :      */
     142             :     sal_uInt8    nMayBeIso8601;
     143             : 
     144             :     /** State of ISO 8601 can be forced.
     145             : 
     146             :         0:= don't know yet
     147             :         1:= no
     148             :         2:= yes
     149             : 
     150             :         @see CanForceToIso8601()
     151             :      */
     152             :     sal_uInt8   nCanForceToIso8601;
     153             : 
     154             :     /** State of dd-month-yy or yy-month-dd detection, with month name.
     155             : 
     156             :         0:= don't know yet
     157             :         1:= no
     158             :         2:= yes, dd-month-yy
     159             :         3:= yes, yy-month-dd
     160             : 
     161             :         @see MayBeMonthDate()
     162             :      */
     163             :     sal_uInt8   nMayBeMonthDate;
     164             : 
     165             :     /** Input matched this locale dependent date acceptance pattern.
     166             :         -2 if not checked yet, -1 if no match, >=0 matched pattern.
     167             : 
     168             :         @see IsAcceptedDatePattern()
     169             :      */
     170             :     sal_Int32   nAcceptedDatePattern;
     171             :     com::sun::star::uno::Sequence< OUString >  sDateAcceptancePatterns;
     172             : 
     173             :     /** If input matched a date acceptance pattern that starts at input
     174             :         particle sStrArray[nDatePatternStart].
     175             : 
     176             :         @see IsAcceptedDatePattern()
     177             :      */
     178             :     sal_uInt16  nDatePatternStart;
     179             : 
     180             :     /** Count of numbers that matched the accepted pattern, if any, else 0.
     181             : 
     182             :         @see GetDatePatternNumbers()
     183             :      */
     184             :     sal_uInt16  nDatePatternNumbers;
     185             : 
     186             : #ifdef _ZFORFIND_CXX        // methods private to implementation
     187             :     void Reset();                               // Reset all variables before start of analysis
     188             : 
     189             :     void InitText();                            // Init of months and days of week
     190             : 
     191             :     // Convert string to double.
     192             :     // Only simple unsigned floating point values without any error detection,
     193             :     // decimal separator has to be '.'
     194             :     // If bForceFraction==true the string is taken to be the fractional part
     195             :     // of 0.1234 without the leading 0. (thus being just "1234").
     196             :     double StringToDouble( const OUString& rStr,
     197             :                            bool bForceFraction = false );
     198             : 
     199             :     // Next number/string symbol
     200             :     bool NextNumberStringSymbol( const sal_Unicode*& pStr,
     201             :                                  OUString& rSymbol );
     202             : 
     203             :     // Concatenate ,000,23 blocks
     204             :     // in input to 000123
     205             :     bool SkipThousands( const sal_Unicode*& pStr, OUString& rSymbol );
     206             : 
     207             :     // Divide numbers/strings into
     208             :     // arrays and variables above.
     209             :     // Leading blanks and blanks
     210             :     // after numbers are thrown away
     211             :     void NumberStringDivision( const OUString& rString );
     212             : 
     213             : 
     214             :     // optimized substring versions
     215             : 
     216             :     // Whether rString contains rWhat at nPos
     217        7913 :     static inline bool StringContains( const OUString& rWhat,
     218             :                                        const OUString& rString,
     219             :                                        sal_Int32 nPos )
     220             :         {
     221             :             // mostly used with one character
     222        7913 :             if ( rWhat[ 0 ] != rString[ nPos ] )
     223             :             {
     224        7617 :                 return false;
     225             :             }
     226         296 :             return StringContainsImpl( rWhat, rString, nPos );
     227             :         }
     228             : 
     229             :     // Whether pString contains rWhat at nPos
     230           0 :     static inline bool StringPtrContains( const OUString& rWhat,
     231             :                                           const sal_Unicode* pString,
     232             :                                           sal_Int32 nPos ) // nPos MUST be a valid offset from pString
     233             :         {
     234             :             // mostly used with one character
     235           0 :             if ( rWhat[ 0 ] != pString[ nPos ] )
     236             :             {
     237           0 :                 return false;
     238             :             }
     239           0 :             return StringPtrContainsImpl( rWhat, pString, nPos );
     240             :         }
     241             : 
     242             :     //! DO NOT use directly
     243             :     static bool StringContainsImpl( const OUString& rWhat,
     244             :                                     const OUString& rString,
     245             :                                     sal_Int32 nPos );
     246             :     //! DO NOT use directly
     247             :     static bool StringPtrContainsImpl( const OUString& rWhat,
     248             :                                        const sal_Unicode* pString,
     249             :                                        sal_Int32 nPos );
     250             : 
     251             :     // Skip a special character
     252             :     static inline bool SkipChar( sal_Unicode c,
     253             :                                  const OUString& rString,
     254             :                                  sal_Int32& nPos );
     255             : 
     256             :     // Skip blank
     257             :     static inline void SkipBlanks( const OUString& rString,
     258             :                                    sal_Int32& nPos );
     259             : 
     260             :     // Jump over rWhat in rString at nPos
     261             :     static inline bool SkipString( const OUString& rWhat,
     262             :                                    const OUString& rString,
     263             :                                    sal_Int32& nPos );
     264             : 
     265             :     // Recognizes exactly ,111 as group separator
     266             :     inline bool GetThousandSep( const OUString& rString,
     267             :                                 sal_Int32& nPos,
     268             :                                 sal_uInt16 nStringPos );
     269             :     // Get boolean value
     270             :     short GetLogical( const OUString& rString );
     271             : 
     272             :     // Get month and advance string position
     273             :     short GetMonth( const OUString& rString,
     274             :                     sal_Int32& nPos );
     275             : 
     276             :     // Get day of week and advance string position
     277             :     int GetDayOfWeek( const OUString& rString,
     278             :                       sal_Int32& nPos );
     279             : 
     280             :     // Get currency symbol and advance string position
     281             :     bool GetCurrency( const OUString& rString,
     282             :                       sal_Int32& nPos,
     283             :                       const SvNumberformat* pFormat = NULL ); // optional number format to match against
     284             : 
     285             :     // Get symbol AM or PM and advance string position
     286             :     bool GetTimeAmPm( const OUString& rString,
     287             :                       sal_Int32& nPos );
     288             : 
     289             :     // Get decimal separator and advance string position
     290             :     inline bool GetDecSep( const OUString& rString,
     291             :                            sal_Int32& nPos );
     292             : 
     293             :     // Get hundredth seconds separator and advance string position
     294             :     inline bool GetTime100SecSep( const OUString& rString,
     295             :                                   sal_Int32& nPos );
     296             : 
     297             :     // Get sign  and advance string position
     298             :     // Including special case '('
     299             :     int GetSign( const OUString& rString,
     300             :                  sal_Int32& nPos );
     301             : 
     302             :     // Get sign of exponent and advance string position
     303             :     short GetESign( const OUString& rString,
     304             :                     sal_Int32& nPos );
     305             : 
     306             :     // Get next number as array offset
     307             :     inline bool GetNextNumber( sal_uInt16& i,
     308             :                                sal_uInt16& j );
     309             : 
     310             :     /** Converts time -> double (only decimals)
     311             : 
     312             :         @return TRUE if time, FALSE if not (e.g. hours >12 with AM/PM)
     313             :      */
     314             :     bool GetTimeRef( double& fOutNumber,                     // result as double
     315             :                      sal_uInt16 nIndex,                      // Index of hour in input
     316             :                      sal_uInt16 nAnz );                      // Count of time substrings in input
     317             :     sal_uInt16 ImplGetDay  ( sal_uInt16 nIndex );   // Day input, 0 if no match
     318             :     sal_uInt16 ImplGetMonth( sal_uInt16 nIndex );   // Month input, zero based return, NumberOfMonths if no match
     319             :     sal_uInt16 ImplGetYear ( sal_uInt16 nIndex );   // Year input, 0 if no match
     320             : 
     321             :     // Conversion of date to number
     322             :     bool GetDateRef( double& fDays,                          // OUT: days diff to null date
     323             :                      sal_uInt16& nCounter,                   // Count of date substrings
     324             :                      const SvNumberformat* pFormat = NULL ); // optional number format to match against
     325             : 
     326             :     // Analyze start of string
     327             :     bool ScanStartString( const OUString& rString,
     328             :                           const SvNumberformat* pFormat = NULL );
     329             : 
     330             :     // Analyze middle substring
     331             :     bool ScanMidString( const OUString& rString,
     332             :                         sal_uInt16 nStringPos,
     333             :                         const SvNumberformat* pFormat = NULL );
     334             : 
     335             : 
     336             :     // Analyze end of string
     337             :     bool ScanEndString( const OUString& rString,
     338             :                         const SvNumberformat* pFormat = NULL );
     339             : 
     340             :     // Compare rString to substring of array indexed by nString
     341             :     // nString == 0xFFFF => last substring
     342             :     bool ScanStringNumFor( const OUString& rString,
     343             :                            sal_Int32 nPos,
     344             :                            const SvNumberformat* pFormat,
     345             :                            sal_uInt16 nString,
     346             :                            bool bDontDetectNegation = false );
     347             : 
     348             :     // if nMatchedAllStrings set nMatchedUsedAsReturn and return true,
     349             :     // else do nothing and return false
     350             :     bool MatchedReturn();
     351             : 
     352             :     //! Be sure that the string to be analyzed is already converted to upper
     353             :     //! case and if it contained native humber digits that they are already
     354             :     //! converted to ASCII.
     355             : 
     356             :     // Main anlyzing function
     357             :     bool IsNumberFormatMain( const OUString& rString,
     358             :                              const SvNumberformat* pFormat = NULL);    // optional number format to match against
     359             : 
     360             :     static inline bool MyIsdigit( sal_Unicode c );
     361             : 
     362             :     // native number transliteration if necessary
     363             :     void TransformInput( OUString& rString );
     364             : 
     365             :     /** Whether input matches locale dependent date acceptance pattern.
     366             : 
     367             :         @param nStartPatternAt
     368             :                The pattern matching starts at input particle
     369             :                sStrArray[nStartPatternAt].
     370             : 
     371             :         NOTE: once called the result is remembered, subsequent calls with
     372             :         different parameters do not check for a match and do not lead to a
     373             :         different result.
     374             :      */
     375             :     bool IsAcceptedDatePattern( sal_uInt16 nStartPatternAt );
     376             : 
     377             :     /** Sets (not advances!) rPos to sStrArray[nParticle].getLength() if string
     378             :         matches separator in pattern at nParticle.
     379             : 
     380             :         @returns TRUE if separator matched.
     381             :      */
     382             :     bool SkipDatePatternSeparator( sal_uInt16 nParticle, sal_Int32 & rPos );
     383             : 
     384             :     /** Returns count of numbers in accepted date pattern.
     385             :      */
     386             :     sal_uInt16 GetDatePatternNumbers();
     387             : 
     388             :     /** Obtain order of accepted date pattern coded as, for example,
     389             :         ('D'<<16)|('M'<<8)|'Y'
     390             :     */
     391             :     sal_uInt32 GetDatePatternOrder();
     392             : 
     393             :     /** Obtain date format order, from accepted date pattern if available or
     394             :         otherwise the locale's default order.
     395             :      */
     396             :     DateFormat GetDateOrder();
     397             : 
     398             :     /** Whether input may be an ISO 8601 date format, yyyy-mm-dd...
     399             : 
     400             :         Checks if input has at least 3 numbers for yyyy-mm-dd and the separator
     401             :         is '-', and 1<=mm<=12 and 1<=dd<=31.
     402             : 
     403             :         @see nMayBeIso8601
     404             :      */
     405             :     bool MayBeIso8601();
     406             : 
     407             :     /** Whether input may be a dd-month-yy format, with month name, not
     408             :         number.
     409             : 
     410             :         @see nMayBeMonthDate
     411             :      */
     412             :     bool MayBeMonthDate();
     413             : 
     414             : #endif  // _ZFORFIND_CXX
     415             : };
     416             : 
     417             : 
     418             : 
     419             : #endif  // _ZFORFIND_HXX
     420             : 
     421             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */

Generated by: LCOV version 1.10