/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef _EDTSPELL_HXX
#define _EDTSPELL_HXX

#include <svtools/svxbox.hxx>
#include <editeng/svxenum.hxx>
#include <editeng/splwrap.hxx>
#include <editeng/svxacorr.hxx>
#include <com/sun/star/uno/Reference.h>
#include <editeng/editengdllapi.h>

namespace com { namespace sun { namespace star { namespace linguistic2 {
    class XSpellChecker1;
}}}}


class EditView;
class ImpEditEngine;
class ContentNode;

class EditSpellWrapper : public SvxSpellWrapper
{
private:
    EditView*               pEditView;
    void                    CheckSpellTo();

protected:
    virtual void            SpellStart( SvxSpellArea eArea );
    virtual BOOL            SpellContinue();    // Bereich pruefen
    virtual void            ReplaceAll( const String &rNewText, INT16 nLanguage );
    virtual void            SpellEnd();
    virtual BOOL            SpellMore();
    virtual BOOL            HasOtherCnt();
    virtual void            ScrollArea();
    virtual void            ChangeWord( const String& rNewWord, const USHORT nLang );
    virtual void            ChangeThesWord( const String& rNewWord );
    virtual void            AutoCorrect( const String& rOldWord, const String& rNewWord );

public:
    EditSpellWrapper( Window* pWin,
            ::com::sun::star::uno::Reference<
                ::com::sun::star::linguistic2::XSpellChecker1 > &xChecker,
            BOOL bIsStart,
            BOOL bIsAllRight, EditView* pView );

};


struct WrongRange
{
    USHORT nStart;
    USHORT nEnd;

    WrongRange( USHORT nS, USHORT nE ) { nStart = nS; nEnd = nE; }
};

SV_DECL_VARARR( WrongRanges, WrongRange, 4, 4 )
#define NOT_INVALID 0xFFFF

class WrongList : private WrongRanges
{
private:
    USHORT  nInvalidStart;
    USHORT  nInvalidEnd;

    BOOL    DbgIsBuggy() const;

public:
            WrongList();
            ~WrongList();

    BOOL    IsInvalid() const       { return nInvalidStart != NOT_INVALID; }
    void    SetValid()              { nInvalidStart = NOT_INVALID; nInvalidEnd = 0; }
    void    MarkInvalid( USHORT nS, USHORT nE );

    USHORT          Count() const               { return WrongRanges::Count(); }

    // Wenn man weiss was man tut:
    WrongRange&     GetObject( USHORT n ) const { return WrongRanges::GetObject( n ); }
    void            InsertWrong( const WrongRange& rWrong, USHORT nPos );

    USHORT  GetInvalidStart() const { return nInvalidStart; }
    USHORT& GetInvalidStart()       { return nInvalidStart; }

    USHORT  GetInvalidEnd() const   { return nInvalidEnd; }
    USHORT& GetInvalidEnd()         { return nInvalidEnd; }

    void    TextInserted( USHORT nPos, USHORT nChars, BOOL bPosIsSep );
    void    TextDeleted( USHORT nPos, USHORT nChars );

    void    ResetRanges()           { Remove( 0, Count() ); }
    BOOL    HasWrongs() const       { return Count() != 0; }
    void    InsertWrong( USHORT nStart, USHORT nEnd, BOOL bClearRange );
    BOOL    NextWrong( USHORT& rnStart, USHORT& rnEnd ) const;
    BOOL    HasWrong( USHORT nStart, USHORT nEnd ) const;
    BOOL    HasAnyWrong( USHORT nStart, USHORT nEnd ) const;
    void    ClearWrongs( USHORT nStart, USHORT nEnd, const ContentNode* pNode );
    void    MarkWrongsInvalid();

    WrongList*  Clone() const;

    // #i102062#
    bool operator==(const WrongList& rCompare) const;
};

inline void WrongList::InsertWrong( const WrongRange& rWrong, USHORT nPos )
{
    WrongRanges::Insert( rWrong, nPos );
#ifdef DBG_UTIL
    DBG_ASSERT( !DbgIsBuggy(), "Insert: WrongList kaputt!" );
#endif
}



class EdtAutoCorrDoc : public SvxAutoCorrDoc
{
    ImpEditEngine*  pImpEE;
    ContentNode*    pCurNode;
    USHORT          nCursor;

    BOOL            bAllowUndoAction;
    BOOL            bUndoAction;

protected:
    void            ImplStartUndoAction();

public:
                    EdtAutoCorrDoc( ImpEditEngine* pImpEE, ContentNode* pCurNode, USHORT nCrsr, xub_Unicode cIns );
                    ~EdtAutoCorrDoc();

    virtual BOOL    Delete( USHORT nStt, USHORT nEnd );
    virtual BOOL    Insert( USHORT nPos, const String& rTxt );
    virtual BOOL    Replace( USHORT nPos, const String& rTxt );

    virtual BOOL    SetAttr( USHORT nStt, USHORT nEnd, USHORT nSlotId, SfxPoolItem& );
    virtual BOOL    SetINetAttr( USHORT nStt, USHORT nEnd, const String& rURL );

    virtual BOOL    HasSymbolChars( USHORT nStt, USHORT nEnd );

    virtual const String* GetPrevPara( BOOL bAtNormalPos );

    virtual BOOL    ChgAutoCorrWord( USHORT& rSttPos, USHORT nEndPos,
                                  SvxAutoCorrect& rACorrect, const String** ppPara );

    virtual LanguageType GetLanguage( USHORT nPos, BOOL bPrevPara = FALSE ) const;

    USHORT          GetCursor() const { return nCursor; }

};

#endif  // EDTSPELL