/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef INCLUDED_SVX_FMSRCCFG_HXX
#define INCLUDED_SVX_FMSRCCFG_HXX

#include <unotools/configvaluecontainer.hxx>
#include <com/sun/star/uno/Sequence.hxx>
#include <svx/svxdllapi.h>

enum class TransliterationFlags;

#define MATCHING_ANYWHERE       0
#define MATCHING_BEGINNING      1
#define MATCHING_END            2
#define MATCHING_WHOLETEXT      3

// this constants should NOT be just changed, since the SearchDialog performs no conversion of the settings of
// its ListBox, but instead just passes them along to the appropriate methods of SearchEngine
// (so if you change the constants or the order of the listbox entries in the dialog, then the other has
// to be adapted)


namespace svxform
{


    // = struct FmSearchParams - parameters of a search


    struct SVX_DLLPUBLIC FmSearchParams
    {
    protected:
        TransliterationFlags
                    nTransliterationFlags;
            // they're way too sensitive for direct access...

    public:
        // no bit fields at all (want to pass the addresses to the OConfigurationValueContainer)
        css::uno::Sequence< OUString >
                    aHistory;
        OUString    sSingleSearchField;

        sal_Int16   nSearchForType;
        sal_Int16   nPosition;
        sal_Int16   nLevOther;
        sal_Int16   nLevShorter;
        sal_Int16   nLevLonger;
        bool        bLevRelaxed;

        bool        bAllFields;
        bool        bUseFormatter;
        bool        bBackwards;
        bool        bWildcard;
        bool        bRegular;
        bool        bApproxSearch;
            // the last three are mutually exclusive

        bool        bSoundsLikeCJK;


        FmSearchParams();

        bool        isIgnoreWidthCJK( ) const;

        TransliterationFlags
                    getTransliterationFlags( ) const { return nTransliterationFlags; }
        void        setTransliterationFlags( TransliterationFlags _nFlags ) { nTransliterationFlags = _nFlags; }

        bool        isCaseSensitive( ) const;
        void        setCaseSensitive( bool _bCase );
    };


    // = class FmSearchConfigItem - a ConfigItem, that remembers search parameters


    class SAL_WARN_UNUSED SVX_DLLPUBLIC FmSearchConfigItem
                :protected  FmSearchParams
                ,public     ::utl::OConfigurationValueContainer
                // order matters!
    {
    private:
        ::osl::Mutex    m_aMutex;

        // wrapper properties:
        // some of the members of FmSearchParams are must be translated to be stored in the configuration
        OUString        m_sSearchForType;
        OUString        m_sSearchPosition;

        bool            m_bIsMatchCase;
        bool            m_bIsMatchFullHalfWidthForms;
        bool            m_bIsMatchHiraganaKatakana;
        bool            m_bIsMatchContractions;
        bool            m_bIsMatchMinusDashCho_on;
        bool            m_bIsMatchRepeatCharMarks;
        bool            m_bIsMatchVariantFormKanji;
        bool            m_bIsMatchOldKanaForms;
        bool            m_bIsMatch_DiZi_DuZu;
        bool            m_bIsMatch_BaVa_HaFa;
        bool            m_bIsMatch_TsiThiChi_DhiZi;
        bool            m_bIsMatch_HyuIyu_ByuVyu;
        bool            m_bIsMatch_SeShe_ZeJe;
        bool            m_bIsMatch_IaIya;
        bool            m_bIsMatch_KiKu;
        bool            m_bIsIgnorePunctuation;
        bool            m_bIsIgnoreWhitespace;
        bool            m_bIsIgnoreProlongedSoundMark;
        bool            m_bIsIgnoreMiddleDot;

    public:
        FmSearchConfigItem();
        ~FmSearchConfigItem();

        const FmSearchParams&   getParams( ) const;
        void                    setParams( const FmSearchParams& _rParams );

    private:
        SVX_DLLPRIVATE void implTranslateFromConfig( );
        SVX_DLLPRIVATE void implTranslateToConfig( );
    };


}


#endif // INCLUDED_SVX_FMSRCCFG_HXX

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */