typesafe wrappers for css::i18nutil::TransliterationModules

and related css::util::SearchOptions2

The TransliterationModules enum has it's constants spread over multiple
UNO enum/constant-collections - TransliterationModules and
TransliterationModulesExtra, which means that most code simply uses
sal_Int32.

Wrap them up into a better bundle so that only the lowest layer needs to
deal directly with the UNO constants.

Change-Id: I1edeab79fcc7817a4a97c933ef84ab7015bb849b
Reviewed-on: https://gerrit.libreoffice.org/34582
Reviewed-by: Noel Grandin <noel.grandin@collabora.co.uk>
Tested-by: Noel Grandin <noel.grandin@collabora.co.uk>

9 files changed, 65 insertions, 65 deletions

diff --git a/cui/source/dialogs/cuifmsearch.cxx b/cui/source/dialogs/cuifmsearch.cxx
index 8d404c4cfee2..81d008dd60f0 100644
--- a/cui/source/dialogs/cuifmsearch.cxx
+++ b/cui/source/dialogs/cuifmsearch.cxx
@@ -31,7 +31,6 @@
 #include "cuifmsearch.hxx"
 #include <svx/srchdlg.hxx>
 #include <svl/cjkoptions.hxx>
-#include <com/sun/star/i18n/TransliterationModules.hpp>
 #include <comphelper/processfactory.hxx>
 #include <comphelper/string.hxx>
 #include <svx/svxdlg.hxx>
@@ -382,7 +381,7 @@ IMPL_LINK(FmSearchDialog, OnClickedSpecialSettings, Button*, pButton, void )
             aDlg->Execute();
 
 
-            sal_Int32 nFlags = aDlg->GetTransliterationFlags();
+            TransliterationFlags nFlags = aDlg->GetTransliterationFlags();
             m_pSearchEngine->SetTransliterationFlags(nFlags);
 
             m_pcbCase->Check(m_pSearchEngine->GetCaseSensitive());
diff --git a/cui/source/factory/dlgfact.cxx b/cui/source/factory/dlgfact.cxx
index 354554dcc0dc..6b9640122360 100644
--- a/cui/source/factory/dlgfact.cxx
+++ b/cui/source/factory/dlgfact.cxx
@@ -551,7 +551,7 @@ void AbstractSvxCaptionDialog_Impl::SetValidateFramePosLink( const Link<SvxSwFra
     pDlg->SetValidateFramePosLink( rLink );
 }
 
-sal_Int32 AbstractSvxJSearchOptionsDialog_Impl::GetTransliterationFlags() const
+TransliterationFlags AbstractSvxJSearchOptionsDialog_Impl::GetTransliterationFlags() const
 {
     return pDlg->GetTransliterationFlags();
 }
@@ -1089,7 +1089,7 @@ VclPtr<SfxAbstractTabDialog> AbstractDialogFactory_Impl::CreateSchTransformTabDi
 
 VclPtr<AbstractSvxJSearchOptionsDialog> AbstractDialogFactory_Impl::CreateSvxJSearchOptionsDialog( vcl::Window* pParent,
                                                             const SfxItemSet& rOptionsSet,
-                                                            sal_Int32 nInitialFlags)
+                                                            TransliterationFlags nInitialFlags)
 {
     VclPtrInstance<SvxJSearchOptionsDialog> pDlg( pParent, rOptionsSet, nInitialFlags );
     return VclPtr<AbstractSvxJSearchOptionsDialog_Impl>::Create( pDlg );
diff --git a/cui/source/factory/dlgfact.hxx b/cui/source/factory/dlgfact.hxx
index 2160c8a0c81c..2cf6761d6dc1 100644
--- a/cui/source/factory/dlgfact.hxx
+++ b/cui/source/factory/dlgfact.hxx
@@ -254,7 +254,7 @@ class SvxJSearchOptionsDialog;
 class AbstractSvxJSearchOptionsDialog_Impl :public AbstractSvxJSearchOptionsDialog
 {
     DECL_ABSTDLG_BASE(AbstractSvxJSearchOptionsDialog_Impl,SvxJSearchOptionsDialog)
-    virtual sal_Int32           GetTransliterationFlags() const override;
+    virtual TransliterationFlags    GetTransliterationFlags() const override;
 };
 
 class AbstractSvxTransformTabDialog_Impl : public AbstractSvxTransformTabDialog
@@ -549,7 +549,7 @@ public:
                                                             sal_uInt16 nLonger) override;
     virtual VclPtr<AbstractSvxJSearchOptionsDialog> CreateSvxJSearchOptionsDialog( vcl::Window* pParent,
                                                             const SfxItemSet& rOptionsSet,
-                                                            sal_Int32 nInitialFlags) override;
+                                                            TransliterationFlags nInitialFlags) override;
     virtual VclPtr<AbstractFmInputRecordNoDialog> CreateFmInputRecordNoDialog() override;
     virtual VclPtr<AbstractSvxNewDictionaryDialog> CreateSvxNewDictionaryDialog( vcl::Window* pParent ) override;
     virtual VclPtr<VclAbstractDialog>     CreateSvxEditDictionaryDialog( vcl::Window* pParent,
diff --git a/cui/source/inc/cuisrchdlg.hxx b/cui/source/inc/cuisrchdlg.hxx
index c3d664946c17..8edf7623fa0e 100644
--- a/cui/source/inc/cuisrchdlg.hxx
+++ b/cui/source/inc/cuisrchdlg.hxx
@@ -35,7 +35,7 @@ class SvxJSearchOptionsPage;
 
 class SvxJSearchOptionsDialog : public SfxSingleTabDialog
 {
-    sal_Int32                     nInitialTlFlags;
+    TransliterationFlags          nInitialTlFlags;
     VclPtr<SvxJSearchOptionsPage> pPage;
 
     SvxJSearchOptionsDialog( const SvxJSearchOptionsDialog & ) = delete;
@@ -43,14 +43,14 @@ class SvxJSearchOptionsDialog : public SfxSingleTabDialog
 
 public:
     SvxJSearchOptionsDialog(vcl::Window *pParent,
-        const SfxItemSet& rOptionsSet, sal_Int32 nInitialFlags);
+        const SfxItemSet& rOptionsSet, TransliterationFlags nInitialFlags);
     virtual ~SvxJSearchOptionsDialog() override;
     virtual void dispose() override;
 
     // Window
     virtual void    Activate() override;
 
-    sal_Int32           GetTransliterationFlags() const;
+    TransliterationFlags  GetTransliterationFlags() const;
 };
 
 #endif
diff --git a/cui/source/options/cuisrchdlg.cxx b/cui/source/options/cuisrchdlg.cxx
index bff4d1a74c8e..0b3bf50120df 100644
--- a/cui/source/options/cuisrchdlg.cxx
+++ b/cui/source/options/cuisrchdlg.cxx
@@ -30,7 +30,6 @@
 #include <sfx2/viewsh.hxx>
 #include <sfx2/basedlgs.hxx>
 #include <svl/cjkoptions.hxx>
-#include <com/sun/star/i18n/TransliterationModules.hpp>
 
 #include "cuisrchdlg.hxx"
 
@@ -48,7 +47,7 @@
 // class SvxJSearchOptionsDialog -----------------------------------------
 
 SvxJSearchOptionsDialog::SvxJSearchOptionsDialog(vcl::Window *pParent,
-    const SfxItemSet& rOptionsSet, sal_Int32 nInitialFlags)
+    const SfxItemSet& rOptionsSet, TransliterationFlags nInitialFlags)
     : SfxSingleTabDialog(pParent, rOptionsSet)
     , nInitialTlFlags( nInitialFlags )
 {
@@ -77,7 +76,7 @@ void SvxJSearchOptionsDialog::Activate()
     pPage->SetTransliterationFlags( nInitialTlFlags );
 }
 
-sal_Int32 SvxJSearchOptionsDialog::GetTransliterationFlags() const
+TransliterationFlags SvxJSearchOptionsDialog::GetTransliterationFlags() const
 {
     return pPage->GetTransliterationFlags();
 }
diff --git a/cui/source/options/optaboutconfig.cxx b/cui/source/options/optaboutconfig.cxx
index 99fcc3fd9393..38c30f1bf820 100644
--- a/cui/source/options/optaboutconfig.cxx
+++ b/cui/source/options/optaboutconfig.cxx
@@ -25,7 +25,6 @@
 #include <com/sun/star/container/XHierarchicalName.hpp>
 #include <com/sun/star/container/XHierarchicalNameAccess.hpp>
 #include <com/sun/star/util/XChangesBatch.hpp>
-#include <com/sun/star/i18n/TransliterationModules.hpp>
 #include <com/sun/star/util/SearchFlags.hpp>
 #include <com/sun/star/util/SearchAlgorithms2.hpp>
 #include <unotools/textsearch.hxx>
@@ -175,7 +174,7 @@ CuiAboutConfigTabPage::CuiAboutConfigTabPage( vcl::Window* pParent/*, const SfxI
     aTabs[4] = aTabs[3] + fWidth * 8;
 
     m_options.AlgorithmType2 = util::SearchAlgorithms2::ABSOLUTE;
-    m_options.transliterateFlags |= i18n::TransliterationModules_IGNORE_CASE;
+    m_options.transliterateFlags |= TransliterationFlags::IGNORE_CASE;
     m_options.searchFlag |= (util::SearchFlags::REG_NOT_BEGINOFLINE |
                                         util::SearchFlags::REG_NOT_ENDOFLINE);
 
diff --git a/cui/source/options/optaboutconfig.hxx b/cui/source/options/optaboutconfig.hxx
index 91641d1616b7..b33be6505207 100644
--- a/cui/source/options/optaboutconfig.hxx
+++ b/cui/source/options/optaboutconfig.hxx
@@ -12,8 +12,8 @@
 
 #include <com/sun/star/container/XNameAccess.hpp>
 #include <com/sun/star/beans/NamedValue.hpp>
-#include <com/sun/star/util/SearchOptions2.hpp>
 
+#include <i18nutil/searchopt.hxx>
 #include <sfx2/tabdlg.hxx>
 #include <svtools/simptabl.hxx>
 #include <vcl/edit.hxx>
@@ -52,7 +52,7 @@ private:
     VclPtr< SvSimpleTable > m_pPrefBox;
 
      //for search
-    css::util::SearchOptions2 m_options;
+    i18nutil::SearchOptions2 m_options;
     SvTreeListEntries m_prefBoxEntries;
 
     void AddToModifiedVector( const std::shared_ptr< Prop_Impl >& rProp );
diff --git a/cui/source/options/optjsearch.cxx b/cui/source/options/optjsearch.cxx
index ce5f61aecd2a..bbe587a61a67 100644
--- a/cui/source/options/optjsearch.cxx
+++ b/cui/source/options/optjsearch.cxx
@@ -18,7 +18,7 @@
  */
 
 #include <unotools/searchopt.hxx>
-#include <com/sun/star/i18n/TransliterationModules.hpp>
+#include <i18nutil/transliteration.hxx>
 #include <cuires.hrc>
 #include <dialmgr.hxx>
 #include <optjsearch.hxx>
@@ -51,7 +51,7 @@ SvxJSearchOptionsPage::SvxJSearchOptionsPage( vcl::Window* pParent, const SfxIte
     get( m_pIgnoreMiddleDot, "ignoremiddledot");
 
     bSaveOptions = true;
-    nTransliterationFlags = 0x00000000;
+    nTransliterationFlags = TransliterationFlags::NONE;
 }
 
 SvxJSearchOptionsPage::~SvxJSearchOptionsPage()
@@ -89,92 +89,92 @@ VclPtr<SfxTabPage> SvxJSearchOptionsPage::Create( vcl::Window* pParent, const Sf
 }
 
 
-void SvxJSearchOptionsPage::SetTransliterationFlags( sal_Int32 nSettings )
+void SvxJSearchOptionsPage::SetTransliterationFlags( TransliterationFlags nSettings )
 {
-    bool  bVal = 0 != (nSettings & TransliterationModules_IGNORE_CASE);
+    bool  bVal(nSettings & TransliterationFlags::IGNORE_CASE);
     m_pMatchCase              ->Check( bVal );    //! treat as equal uppercase/lowercase
-    bVal = 0 != (nSettings & TransliterationModules_IGNORE_WIDTH);
+    bVal = bool(nSettings & TransliterationFlags::IGNORE_WIDTH);
     m_pMatchFullHalfWidth     ->Check( bVal );
-    bVal = 0 != (nSettings & TransliterationModules_IGNORE_KANA);
+    bVal = bool(nSettings & TransliterationFlags::IGNORE_KANA);
     m_pMatchHiraganaKatakana  ->Check( bVal );
-    bVal = 0 != (nSettings & TransliterationModules_ignoreSize_ja_JP);
+    bVal = bool(nSettings & TransliterationFlags::ignoreSize_ja_JP);
     m_pMatchContractions      ->Check( bVal );
-    bVal = 0 != (nSettings & TransliterationModules_ignoreMinusSign_ja_JP);
+    bVal = bool(nSettings & TransliterationFlags::ignoreMinusSign_ja_JP);
     m_pMatchMinusDashChoon    ->Check( bVal );
-    bVal = 0 != (nSettings & TransliterationModules_ignoreIterationMark_ja_JP);
+    bVal = bool(nSettings & TransliterationFlags::ignoreIterationMark_ja_JP);
     m_pMatchRepeatCharMarks   ->Check( bVal );
-    bVal = 0 != (nSettings & TransliterationModules_ignoreTraditionalKanji_ja_JP);
+    bVal = bool(nSettings & TransliterationFlags::ignoreTraditionalKanji_ja_JP);
     m_pMatchVariantFormKanji  ->Check( bVal );
-    bVal = 0 != (nSettings & TransliterationModules_ignoreTraditionalKana_ja_JP);
+    bVal = bool(nSettings & TransliterationFlags::ignoreTraditionalKana_ja_JP);
     m_pMatchOldKanaForms      ->Check( bVal );
-    bVal = 0 != (nSettings & TransliterationModules_ignoreZiZu_ja_JP);
+    bVal = bool(nSettings & TransliterationFlags::ignoreZiZu_ja_JP);
     m_pMatchDiziDuzu          ->Check( bVal );
-    bVal = 0 != (nSettings & TransliterationModules_ignoreBaFa_ja_JP);
+    bVal = bool(nSettings & TransliterationFlags::ignoreBaFa_ja_JP);
     m_pMatchBavaHafa          ->Check( bVal );
-    bVal = 0 != (nSettings & TransliterationModules_ignoreTiJi_ja_JP);
+    bVal = bool(nSettings & TransliterationFlags::ignoreTiJi_ja_JP);
     m_pMatchTsithichiDhizi    ->Check( bVal );
-    bVal = 0 != (nSettings & TransliterationModules_ignoreHyuByu_ja_JP);
+    bVal = bool(nSettings & TransliterationFlags::ignoreHyuByu_ja_JP);
     m_pMatchHyuiyuByuvyu      ->Check( bVal );
-    bVal = 0 != (nSettings & TransliterationModules_ignoreSeZe_ja_JP);
+    bVal = bool(nSettings & TransliterationFlags::ignoreSeZe_ja_JP);
     m_pMatchSesheZeje         ->Check( bVal );
-    bVal = 0 != (nSettings & TransliterationModules_ignoreIandEfollowedByYa_ja_JP);
+    bVal = bool(nSettings & TransliterationFlags::ignoreIandEfollowedByYa_ja_JP);
     m_pMatchIaiya             ->Check( bVal );
-    bVal = 0 != (nSettings & TransliterationModules_ignoreKiKuFollowedBySa_ja_JP);
+    bVal = bool(nSettings & TransliterationFlags::ignoreKiKuFollowedBySa_ja_JP);
     m_pMatchKiku              ->Check( bVal );
-    bVal = 0 != (nSettings & TransliterationModules_ignoreSeparator_ja_JP);
+    bVal = bool(nSettings & TransliterationFlags::ignoreSeparator_ja_JP);
     m_pIgnorePunctuation      ->Check( bVal );
-    bVal = 0 != (nSettings & TransliterationModules_ignoreSpace_ja_JP);
+    bVal = bool(nSettings & TransliterationFlags::ignoreSpace_ja_JP);
     m_pIgnoreWhitespace       ->Check( bVal );
-    bVal = 0 != (nSettings & TransliterationModules_ignoreProlongedSoundMark_ja_JP);
+    bVal = bool(nSettings & TransliterationFlags::ignoreProlongedSoundMark_ja_JP);
     m_pMatchProlongedSoundMark->Check( bVal );
-    bVal = 0 != (nSettings & TransliterationModules_ignoreMiddleDot_ja_JP);
+    bVal = bool(nSettings & TransliterationFlags::ignoreMiddleDot_ja_JP);
     m_pIgnoreMiddleDot        ->Check( bVal );
 
     nTransliterationFlags = nSettings;
 }
 
 
-sal_Int32 SvxJSearchOptionsPage::GetTransliterationFlags_Impl()
+TransliterationFlags SvxJSearchOptionsPage::GetTransliterationFlags_Impl()
 {
-    sal_Int32 nTmp = 0;
+    TransliterationFlags nTmp = TransliterationFlags::NONE;
     if (m_pMatchCase->IsChecked()) //! treat as equal uppercase/lowercase
-        nTmp |= TransliterationModules_IGNORE_CASE;
+        nTmp |= TransliterationFlags::IGNORE_CASE;
     if (m_pMatchFullHalfWidth->IsChecked())
-        nTmp |= TransliterationModules_IGNORE_WIDTH;
+        nTmp |= TransliterationFlags::IGNORE_WIDTH;
     if (m_pMatchHiraganaKatakana->IsChecked())
-        nTmp |= TransliterationModules_IGNORE_KANA;
+        nTmp |= TransliterationFlags::IGNORE_KANA;
     if (m_pMatchContractions->IsChecked())
-        nTmp |= TransliterationModules_ignoreSize_ja_JP;
+        nTmp |= TransliterationFlags::ignoreSize_ja_JP;
     if (m_pMatchMinusDashChoon->IsChecked())
-        nTmp |= TransliterationModules_ignoreMinusSign_ja_JP;
+        nTmp |= TransliterationFlags::ignoreMinusSign_ja_JP;
     if (m_pMatchRepeatCharMarks->IsChecked())
-        nTmp |= TransliterationModules_ignoreIterationMark_ja_JP;
+        nTmp |= TransliterationFlags::ignoreIterationMark_ja_JP;
     if (m_pMatchVariantFormKanji->IsChecked())
-        nTmp |= TransliterationModules_ignoreTraditionalKanji_ja_JP;
+        nTmp |= TransliterationFlags::ignoreTraditionalKanji_ja_JP;
     if (m_pMatchOldKanaForms->IsChecked())
-        nTmp |= TransliterationModules_ignoreTraditionalKana_ja_JP;
+        nTmp |= TransliterationFlags::ignoreTraditionalKana_ja_JP;
     if (m_pMatchDiziDuzu->IsChecked())
-        nTmp |= TransliterationModules_ignoreZiZu_ja_JP;
+        nTmp |= TransliterationFlags::ignoreZiZu_ja_JP;
     if (m_pMatchBavaHafa->IsChecked())
-        nTmp |= TransliterationModules_ignoreBaFa_ja_JP;
+        nTmp |= TransliterationFlags::ignoreBaFa_ja_JP;
     if (m_pMatchTsithichiDhizi->IsChecked())
-        nTmp |= TransliterationModules_ignoreTiJi_ja_JP;
+        nTmp |= TransliterationFlags::ignoreTiJi_ja_JP;
     if (m_pMatchHyuiyuByuvyu->IsChecked())
-        nTmp |= TransliterationModules_ignoreHyuByu_ja_JP;
+        nTmp |= TransliterationFlags::ignoreHyuByu_ja_JP;
     if (m_pMatchSesheZeje->IsChecked())
-        nTmp |= TransliterationModules_ignoreSeZe_ja_JP;
+        nTmp |= TransliterationFlags::ignoreSeZe_ja_JP;
     if (m_pMatchIaiya->IsChecked())
-        nTmp |= TransliterationModules_ignoreIandEfollowedByYa_ja_JP;
+        nTmp |= TransliterationFlags::ignoreIandEfollowedByYa_ja_JP;
     if (m_pMatchKiku->IsChecked())
-        nTmp |= TransliterationModules_ignoreKiKuFollowedBySa_ja_JP;
+        nTmp |= TransliterationFlags::ignoreKiKuFollowedBySa_ja_JP;
     if (m_pIgnorePunctuation->IsChecked())
-        nTmp |= TransliterationModules_ignoreSeparator_ja_JP;
+        nTmp |= TransliterationFlags::ignoreSeparator_ja_JP;
     if (m_pIgnoreWhitespace->IsChecked())
-        nTmp |= TransliterationModules_ignoreSpace_ja_JP;
+        nTmp |= TransliterationFlags::ignoreSpace_ja_JP;
     if (m_pMatchProlongedSoundMark->IsChecked())
-        nTmp |= TransliterationModules_ignoreProlongedSoundMark_ja_JP;
+        nTmp |= TransliterationFlags::ignoreProlongedSoundMark_ja_JP;
     if (m_pIgnoreMiddleDot->IsChecked())
-        nTmp |= TransliterationModules_ignoreMiddleDot_ja_JP;
+        nTmp |= TransliterationFlags::ignoreMiddleDot_ja_JP;
 
     nTransliterationFlags = nTmp;
     return nTransliterationFlags;
@@ -234,7 +234,7 @@ void SvxJSearchOptionsPage::Reset( const SfxItemSet* )
 
 bool SvxJSearchOptionsPage::FillItemSet( SfxItemSet* )
 {
-    sal_Int32 nOldVal = nTransliterationFlags;
+    TransliterationFlags nOldVal = nTransliterationFlags;
     nTransliterationFlags = GetTransliterationFlags_Impl();
     bool bModified = nOldVal != nTransliterationFlags;
 
diff --git a/cui/source/options/optjsearch.hxx b/cui/source/options/optjsearch.hxx
index 542e1c1a9b9f..b6d768044da7 100644
--- a/cui/source/options/optjsearch.hxx
+++ b/cui/source/options/optjsearch.hxx
@@ -52,10 +52,12 @@ private:
     VclPtr<CheckBox>   m_pIgnoreWhitespace;
     VclPtr<CheckBox>   m_pIgnoreMiddleDot;
 
-    sal_Int32       nTransliterationFlags;
-    bool        bSaveOptions;
+    TransliterationFlags
+                       nTransliterationFlags;
+    bool               bSaveOptions;
 
-    sal_Int32               GetTransliterationFlags_Impl();
+    TransliterationFlags
+                        GetTransliterationFlags_Impl();
 
 public:
                         SvxJSearchOptionsPage( vcl::Window* pParent, const SfxItemSet& rSet );
@@ -68,8 +70,9 @@ public:
 
     void                EnableSaveOptions( bool bVal )  { bSaveOptions = bVal; }
 
-    sal_Int32               GetTransliterationFlags() const { return nTransliterationFlags; }
-    void                SetTransliterationFlags( sal_Int32 nSettings );
+    TransliterationFlags
+                        GetTransliterationFlags() const { return nTransliterationFlags; }
+    void                SetTransliterationFlags( TransliterationFlags nSettings );
 };