wrap scoped enum around css::util::NumberFormat

Change-Id: Icab5ded8bccdb95f79b3fa35ea164f47919c68fa
Reviewed-on: https://gerrit.libreoffice.org/46339
Tested-by: Jenkins <ci@libreoffice.org>
Reviewed-by: Eike Rathke <erack@redhat.com>

5 files changed, 89 insertions, 39 deletions

diff --git a/include/formula/FormulaCompiler.hxx b/include/formula/FormulaCompiler.hxx
index 852e996dad79..26d996f374e8 100644
--- a/include/formula/FormulaCompiler.hxx
+++ b/include/formula/FormulaCompiler.hxx
@@ -52,6 +52,7 @@ namespace com { namespace sun { namespace star {
 
 class CharClass;
 enum class FormulaError : sal_uInt16;
+enum class SvNumFormatType : sal_Int16;
 
 namespace formula
 {
@@ -236,7 +237,7 @@ public:
     static sal_Unicode      GetNativeSymbolChar( OpCode eOp );
     static  bool            IsMatrixFunction(OpCode _eOpCode);   // if a function _always_ returns a Matrix
 
-    short GetNumFormatType() const { return nNumFmt; }
+    SvNumFormatType GetNumFormatType() const { return nNumFmt; }
     bool  CompileTokenArray();
 
     void CreateStringFromTokenArray( OUString& rFormula );
@@ -340,7 +341,7 @@ protected:
 
     OpCode              eLastOp;
     short               nRecursion;             // GetToken() recursions
-    short               nNumFmt;                // set during CompileTokenArray()
+    SvNumFormatType     nNumFmt;                // set during CompileTokenArray()
     sal_uInt16          pc;                     // program counter
 
     FormulaGrammar::Grammar meGrammar;          // The grammar used, language plus convention.
diff --git a/include/formula/token.hxx b/include/formula/token.hxx
index c3144b4a2dcb..d464ec67d39e 100644
--- a/include/formula/token.hxx
+++ b/include/formula/token.hxx
@@ -183,8 +183,8 @@ public:
     virtual void                SetInForceArray( ParamClass c );
     virtual double              GetDouble() const;
     virtual double&             GetDoubleAsReference();
-    virtual short               GetDoubleType() const;
-    virtual void                SetDoubleType( short nType );
+    virtual sal_Int16           GetDoubleType() const;
+    virtual void                SetDoubleType( sal_Int16 nType );
     virtual svl::SharedString   GetString() const;
     virtual void                SetString( const svl::SharedString& rStr );
     virtual sal_uInt16          GetIndex() const;
@@ -304,7 +304,7 @@ public:
     virtual FormulaToken*       Clone() const override { return new FormulaDoubleToken(*this); }
     virtual double              GetDouble() const override;
     virtual double&             GetDoubleAsReference() override;
-    virtual short               GetDoubleType() const override;     ///< always returns 0 for "not typed"
+    virtual sal_Int16           GetDoubleType() const override;     ///< always returns 0 for "not typed"
     virtual bool                operator==( const FormulaToken& rToken ) const override;
 
     DECL_FIXEDMEMPOOL_NEWDEL_DLL( FormulaDoubleToken )
@@ -313,19 +313,19 @@ public:
 class FORMULA_DLLPUBLIC FormulaTypedDoubleToken : public FormulaDoubleToken
 {
 private:
-            short               mnType;     /**< Can hold, for example, a value
-                                              of css::util::NumberFormat, or by
+            sal_Int16           mnType;     /**< Can hold, for example, a value
+                                              of SvNumFormatType, or by
                                               contract any other
                                               classification. */
 public:
-                                FormulaTypedDoubleToken( double f, short nType ) :
+                                FormulaTypedDoubleToken( double f, sal_Int16 nType ) :
                                     FormulaDoubleToken( f ), mnType( nType ) {}
                                 FormulaTypedDoubleToken( const FormulaTypedDoubleToken& r ) :
                                     FormulaDoubleToken( r ), mnType( r.mnType ) {}
 
     virtual FormulaToken*       Clone() const override { return new FormulaTypedDoubleToken(*this); }
-    virtual short               GetDoubleType() const override;
-    virtual void                SetDoubleType( short nType ) override;
+    virtual sal_Int16           GetDoubleType() const override;
+    virtual void                SetDoubleType( sal_Int16 nType ) override;
     virtual bool                operator==( const FormulaToken& rToken ) const override;
 
     DECL_FIXEDMEMPOOL_NEWDEL_DLL( FormulaTypedDoubleToken )
diff --git a/include/svl/zforlist.hxx b/include/svl/zforlist.hxx
index a2ff78f90a34..6e7d196c2a61 100644
--- a/include/svl/zforlist.hxx
+++ b/include/svl/zforlist.hxx
@@ -32,6 +32,7 @@
 #include <tools/link.hxx>
 #include <svl/ondemand.hxx>
 #include <svl/nfkeytab.hxx>
+#include <o3tl/typed_flags_set.hxx>
 
 #include <map>
 #include <memory>
@@ -61,6 +62,55 @@ constexpr sal_uInt32 NF_STANDARD_FORMAT_TEXT = SV_MAX_COUNT_STANDARD_FORMATS;
 
 #define NUMBERFORMAT_ENTRY_NOT_FOUND (sal_uInt32)(0xffffffff)   /// MAX_ULONG
 
+enum class SvNumFormatType : sal_Int16
+{
+    /** selects all number formats.
+      */
+     ALL = css::util::NumberFormat::ALL, // 0
+     /** selects only user-defined number formats.
+      */
+     DEFINED = css::util::NumberFormat::DEFINED,  // 1
+     /** selects date formats.
+      */
+     DATE = css::util::NumberFormat::DATE, // 2
+     /** selects time formats.
+      */
+     TIME = css::util::NumberFormat::TIME, // 4
+     /** selects currency formats.
+      */
+     CURRENCY = css::util::NumberFormat::CURRENCY,  // 8
+     /** selects decimal number formats.
+      */
+     NUMBER = css::util::NumberFormat::NUMBER, // 16
+     /** selects scientific number formats.
+      */
+     SCIENTIFIC = css::util::NumberFormat::SCIENTIFIC, // 32
+     /** selects number formats for fractions.
+      */
+     FRACTION = css::util::NumberFormat::FRACTION, // 64
+     /** selects percentage number formats.
+      */
+     PERCENT = css::util::NumberFormat::PERCENT, // 128
+     /** selects text number formats.
+      */
+     TEXT = css::util::NumberFormat::TEXT, // 256
+     /** selects number formats which contain date and time.
+      */
+     DATETIME = DATE | TIME, // 6
+     /** selects boolean number formats.
+      */
+     LOGICAL = css::util::NumberFormat::LOGICAL, // 1024
+     /** is used as a return value if no format exists.
+      */
+     UNDEFINED = css::util::NumberFormat::UNDEFINED, // 2048
+     /** @internal is used to flag an empty sub format.
+         @since LibreOffice 5.1
+      */
+     EMPTY = css::util::NumberFormat::EMPTY, // 4096
+};
+namespace o3tl {
+    template<> struct typed_flags<SvNumFormatType> : is_typed_flags<SvNumFormatType, 0x1dff> {};
+}
 
 /** enum values for <method>SvNumberFormatter::GetFormatIndex</method>
 
@@ -361,26 +411,26 @@ public:
     LanguageType GetLanguage() const;
 
     // Determine whether two format types are input compatible or not
-    static bool IsCompatible(short eOldType, short eNewType);
+    static bool IsCompatible(SvNumFormatType eOldType, SvNumFormatType eNewType);
 
     /** Get table of formats of a specific type of a locale. A format FIndex is
         tested whether it has the type and locale requested, if it doesn't
         match FIndex returns the default format for the type/locale. If no
         specific format is to be selected FIndex may be initialized to 0. */
-    SvNumberFormatTable& GetEntryTable(short eType,
+    SvNumberFormatTable& GetEntryTable(SvNumFormatType eType,
                                        sal_uInt32& FIndex,
                                        LanguageType eLnge);
 
     /** Get table of formats of a specific type of a language/country.
         FIndex returns the default format of that type.
         If the language/country was never touched before new entries are generated */
-    SvNumberFormatTable& ChangeCL(short eType,
+    SvNumberFormatTable& ChangeCL(SvNumFormatType eType,
                                   sal_uInt32& FIndex,
                                   LanguageType eLnge);
 
     /** Get table of formats of the same type as FIndex; eType and rLnge are
         set accordingly. An unknown format is set to Standard/General */
-    SvNumberFormatTable& GetFirstEntryTable(short& eType,
+    SvNumberFormatTable& GetFirstEntryTable(SvNumFormatType& eType,
                                             sal_uInt32& FIndex,
                                             LanguageType& rLnge);
 
@@ -400,14 +450,14 @@ public:
             nType contains the type of the format.
             nKey contains the index key of the format.
      */
-    bool PutEntry( OUString& rString, sal_Int32& nCheckPos, short& nType, sal_uInt32& nKey,
+    bool PutEntry( OUString& rString, sal_Int32& nCheckPos, SvNumFormatType& nType, sal_uInt32& nKey,
                    LanguageType eLnge = LANGUAGE_DONTKNOW );
 
     /** Same as <method>PutEntry</method> but the format code string is
          considered to be of language/country eLnge and is converted to
         language/country eNewLnge */
     bool PutandConvertEntry( OUString& rString, sal_Int32& nCheckPos,
-                             short& nType, sal_uInt32& nKey,
+                             SvNumFormatType& nType, sal_uInt32& nKey,
                              LanguageType eLnge, LanguageType eNewLnge,
                              bool bForExcelExport = false );
 
@@ -416,7 +466,7 @@ public:
         converted to another System language/country eNewLnge. In this case
          the automatic currency is converted too. */
     bool PutandConvertEntrySystem( OUString& rString, sal_Int32& nCheckPos,
-                                   short& nType, sal_uInt32& nKey,
+                                   SvNumFormatType& nType, sal_uInt32& nKey,
                                    LanguageType eLnge, LanguageType eNewLnge );
 
     /** Similar to <method>PutEntry</method> and
@@ -457,7 +507,7 @@ public:
             and/or could not be converted.
      */
     sal_uInt32 GetIndexPuttingAndConverting( OUString & rString, LanguageType eLnge,
-                                             LanguageType eSysLnge, short & rType,
+                                             LanguageType eSysLnge, SvNumFormatType & rType,
                                              bool & rNewInserted, sal_Int32 & rCheckPos );
 
     /** Create a format code string using format nIndex as a template and
@@ -566,17 +616,17 @@ public:
     sal_uInt32 GetStandardIndex(LanguageType eLnge = LANGUAGE_DONTKNOW);
 
     /// Return the format index of the default format of a type for language/country
-    sal_uInt32 GetStandardFormat(short eType, LanguageType eLnge = LANGUAGE_DONTKNOW);
+    sal_uInt32 GetStandardFormat(SvNumFormatType eType, LanguageType eLnge = LANGUAGE_DONTKNOW);
 
     /** Return the format index of the default format of a type for language/country.
         Maybe not the default format but a special builtin format, e.g. for
         NF_TIME_HH_MMSS00, if that format is passed in nFIndex. */
-    sal_uInt32 GetStandardFormat( sal_uInt32 nFIndex, short eType, LanguageType eLnge );
+    sal_uInt32 GetStandardFormat( sal_uInt32 nFIndex, SvNumFormatType eType, LanguageType eLnge );
 
     /** Return the format index of the default format of a type for language/country.
         Maybe not the default format but a special builtin format, e.g. for
         NF_TIME_HH_MMSS00, or NF_TIME_HH_MMSS if fNumber >= 1.0  */
-    sal_uInt32 GetStandardFormat( double fNumber, sal_uInt32 nFIndex, short eType,
+    sal_uInt32 GetStandardFormat( double fNumber, sal_uInt32 nFIndex, SvNumFormatType eType,
                                   LanguageType eLnge );
 
     /// Whether nFIndex is a special builtin format
@@ -589,10 +639,10 @@ public:
         fNumber is assumed to be a date, time or datetime value, but unknown
         which. Originally introduced for Chart databrowser editor, probably
         should not be used otherwise. */
-    sal_uInt32 GuessDateTimeFormat( short& rType, double fNumber, LanguageType eLnge );
+    sal_uInt32 GuessDateTimeFormat( SvNumFormatType& rType, double fNumber, LanguageType eLnge );
 
     /** Return the corresponding edit format of a format. */
-    sal_uInt32 GetEditFormat( double fNumber, sal_uInt32 nFIndex, short eType,
+    sal_uInt32 GetEditFormat( double fNumber, sal_uInt32 nFIndex, SvNumFormatType eType,
                               LanguageType eLnge, SvNumberformat const * pFormat );
 
     /// Return the reference date
@@ -603,7 +653,7 @@ public:
     bool GetNoZero() const;
     /** Get the type of a format (or css::util::NumberFormat::UNDEFINED if no entry),
          but with css::util::NumberFormat::DEFINED masked out */
-    short GetType(sal_uInt32 nFIndex) const;
+    SvNumFormatType GetType(sal_uInt32 nFIndex) const;
 
     /// As the name says
     void ClearMergeTable();
@@ -909,7 +959,7 @@ private:
 
     // Return the default format for a given type and current locale.
     // May ONLY be called from within GetStandardFormat().
-    SVL_DLLPRIVATE sal_uInt32   ImpGetDefaultFormat( short nType );
+    SVL_DLLPRIVATE sal_uInt32   ImpGetDefaultFormat( SvNumFormatType nType );
 
     // Return the index in a sequence of format codes matching an enum of
     // NfIndexTableOffset. If not found 0 is returned. If the sequence doesn't
diff --git a/include/svl/zformat.hxx b/include/svl/zformat.hxx
index 2b4813184c9d..38479dfc6aef 100644
--- a/include/svl/zformat.hxx
+++ b/include/svl/zformat.hxx
@@ -46,7 +46,6 @@ enum SvNumberformatLimitOps
     NUMBERFORMAT_OP_GE  = 6             // Operator >=
 };
 
-
 struct ImpSvNumberformatInfo            // Struct for FormatInfo
 {
     std::vector<OUString> sStrArray;    // Array of symbols
@@ -55,7 +54,7 @@ struct ImpSvNumberformatInfo            // Struct for FormatInfo
     sal_uInt16 nCntPre;                 // Count of digits before decimal point
     sal_uInt16 nCntPost;                // Count of digits after decimal point
     sal_uInt16 nCntExp;                 // Count of exponent digits, or AM/PM
-    short eScannedType;                 // Type determined by scan
+    SvNumFormatType eScannedType;       // Type determined by scan
     bool bThousand;                     // Has group (AKA thousand) separator
 
     void Copy( const ImpSvNumberformatInfo& rNumFor, sal_uInt16 nAnz );
@@ -176,12 +175,12 @@ public:
     ~SvNumberformat();
 
     /// Get type of format, may include css::util::NumberFormat::DEFINED bit
-    short GetType() const                       { return eType; }
+    SvNumFormatType GetType() const             { return eType; }
 
     /// Get type of format, does not include css::util::NumberFormat::DEFINED
-    short GetMaskedType() const                 { return eType & ~css::util::NumberFormat::DEFINED; }
+    SvNumFormatType GetMaskedType() const       { return eType & ~SvNumFormatType::DEFINED; }
 
-    void SetType(const short eSetType)          { eType = eSetType; }
+    void SetType(SvNumFormatType eSetType)      { eType = eSetType; }
     // Standard means the I18N defined standard format of this type
     void SetStandard()                          { bStandard = true; }
     bool IsStandard() const                     { return bStandard; }
@@ -233,12 +232,12 @@ public:
     void GetOutputString( const OUString& sString, OUString& OutString, Color** ppColor );
 
     // True if type text
-    bool IsTextFormat() const { return (eType & css::util::NumberFormat::TEXT) != 0; }
+    bool IsTextFormat() const { return bool(eType & SvNumFormatType::TEXT); }
     // True if 4th subformat present
     bool HasTextFormat() const
         {
             return (NumFor[3].GetCount() > 0) ||
-                (NumFor[3].Info().eScannedType == css::util::NumberFormat::TEXT);
+                (NumFor[3].Info().eScannedType == SvNumFormatType::TEXT);
         }
 
     void GetFormatSpecialInfo(bool& bThousand,
@@ -318,9 +317,9 @@ public:
     sal_uInt16 GetNumForNumberElementCount( sal_uInt16 nNumFor ) const;
 
     /** Get the scanned type of the specified subformat. */
-    short GetNumForInfoScannedType( sal_uInt16 nNumFor ) const
+    SvNumFormatType GetNumForInfoScannedType( sal_uInt16 nNumFor ) const
     {
-        return (nNumFor < 4) ? NumFor[nNumFor].Info().eScannedType : css::util::NumberFormat::UNDEFINED;
+        return (nNumFor < 4) ? NumFor[nNumFor].Info().eScannedType : SvNumFormatType::UNDEFINED;
     }
 
     // Whether the second subformat code is really for negative numbers
@@ -427,7 +426,7 @@ public:
     void GetConditions( SvNumberformatLimitOps& rOper1, double& rVal1,
                         SvNumberformatLimitOps& rOper2, double& rVal2 ) const;
     Color* GetColor( sal_uInt16 nNumFor ) const;
-    void GetNumForInfo( sal_uInt16 nNumFor, short& rScannedType,
+    void GetNumForInfo( sal_uInt16 nNumFor, SvNumFormatType& rScannedType,
                     bool& bThousand, sal_uInt16& nPrecision, sal_uInt16& nLeadingCnt ) const;
 
     // rAttr.Number not empty if NatNum attributes are to be stored
@@ -483,7 +482,7 @@ private:
     LocaleType maLocale;            // Language/country of the format, numeral shape and calendar type from Excel.
     SvNumberformatLimitOps eOp1;    // Operator for first condition
     SvNumberformatLimitOps eOp2;    // Operator for second condition
-    short eType;                    // Type of format
+    SvNumFormatType eType;          // Type of format
     bool bAdditionalBuiltin;        // If this is an additional built-in format defined by i18n
     bool bStarFlag;                 // Take *n format as ESC n
     bool bStandard;                 // If this is a default standard format
diff --git a/include/svx/numfmtsh.hxx b/include/svx/numfmtsh.hxx
index a7d0fb7662f1..da26e9cbf707 100644
--- a/include/svx/numfmtsh.hxx
+++ b/include/svx/numfmtsh.hxx
@@ -187,7 +187,7 @@ private:
     std::vector<sal_uInt32> aDelList;
     std::vector<sal_uInt32> aCurEntryList;
     sal_uInt32              nCurFormatKey;
-    short                   nCurCategory;
+    SvNumFormatType         nCurCategory;
     LanguageType            eCurLanguage;
     std::vector<sal_uInt16> aCurCurrencyList;
     NfCurrencyEntry*        pCurCurrencyEntry;
@@ -214,8 +214,8 @@ private:
 
     SVX_DLLPRIVATE void  GetPreviewString_Impl( OUString& rString,
                                                 Color*& rpColor );
-    SVX_DLLPRIVATE static void PosToCategory_Impl(sal_uInt16 nPos, short& rCategory);
-    SVX_DLLPRIVATE static void CategoryToPos_Impl(short nCategory, sal_uInt16& rPos);
+    SVX_DLLPRIVATE static void PosToCategory_Impl(sal_uInt16 nPos, SvNumFormatType& rCategory);
+    SVX_DLLPRIVATE static void CategoryToPos_Impl(SvNumFormatType nCategory, sal_uInt16& rPos);
 };
 
 #endif