katesearch.h

/* This file is part of the KDE libraries
   Copyright (C) 2004-2005 Anders Lund <anders@alweb.dk>
   Copyright (C) 2002 John Firebaugh <jfirebaugh@kde.org>
   Copyright (C) 2001-2004 Christoph Cullmann <cullmann@kde.org>
   Copyright (C) 2001 Joseph Wenninger <jowenn@kde.org>
   Copyright (C) 1999 Jochen Wilhelmy <digisnap@cs.tu-berlin.de>
 
   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License version 2 as published by the Free Software Foundation.
 
   This library 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
   Library General Public License for more details.
 
   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/
 
#ifndef __KATE_SEARCH_H__
#define __KATE_SEARCH_H__
 
#include "katecursor.h"
#include "../interfaces/document.h"
 
#include <kdialogbase.h>
 
#include <tqstring.h>
#include <tqregexp.h>
#include <tqstringlist.h>
#include <tqvaluelist.h>
 
class KateView;
class KateDocument;
class KateSuperRangeList;
 
class TDEActionCollection;
 
class KateSearch : public TQObject
{
  TQ_OBJECT
 
  friend class KateDocument;
 
  private:
    class SearchFlags
    {
      public:
        bool caseSensitive     :1;
        bool wholeWords        :1;
        bool fromBeginning     :1;
        bool backward          :1;
        bool selected          :1;
        bool prompt            :1;
        bool replace           :1;
        bool finished          :1;
        bool regExp            :1;
        bool useBackRefs       :1;
    };
 
    class SConfig
    {
      public:
        SearchFlags flags;
        KateTextCursor cursor;
        KateTextCursor wrappedEnd; // after wraping around, search/replace until here
        bool wrapped; // have we allready wrapped around ?
        bool showNotFound; // pop up annoying dialogs?
        uint matchedLength;
        KateTextCursor selBegin;
        KateTextCursor selEnd;
    };
 
  public:
    enum Dialog_results {
      srCancel = KDialogBase::Cancel,
      srAll = KDialogBase::User1,
      srLast = KDialogBase::User2,
      srNo = KDialogBase::User3,
      srYes = KDialogBase::Ok
    };
 
  public:
    KateSearch( KateView* );
    ~KateSearch();
 
    void createActions( TDEActionCollection* );
 
  public slots:
    void find();
    void find( const TQString &pattern, long flags, bool add=true, bool shownotfound=false );
    void replace();
    void replace( const TQString &pattern, const TQString &replacement, long flags );
    void findAgain( bool reverseDirection );
 
  private slots:
    void replaceSlot();
    void slotFindNext() { findAgain( false ); }
    void slotFindPrev() { findAgain( true );  }
 
  private:
    static void addToList( TQStringList&, const TQString& );
    static void addToSearchList( const TQString& s )  { addToList( s_searchList, s ); }
    static void addToReplaceList( const TQString& s ) { addToList( s_replaceList, s ); }
    static TQStringList s_searchList; 
    static TQStringList s_replaceList; 
    static TQString s_pattern; 
 
    void search( SearchFlags flags );
    void wrapSearch();
    bool askContinue();
 
    void findAgain();
    void promptReplace();
    void replaceAll();
    void replaceOne();
    void skipOne();
 
    TQString getSearchText();
    KateTextCursor getCursor( SearchFlags flags );
    bool doSearch( const TQString& text );
    void exposeFound( KateTextCursor &cursor, int slen );
 
    inline KateView* view()    { return m_view; }
    inline KateDocument* doc() { return m_doc;  }
 
    KateView*     m_view;
    KateDocument* m_doc;
 
    KateSuperRangeList* m_arbitraryHLList;
 
    SConfig s;
 
    TQValueList<SConfig> m_searchResults;
    int                 m_resultIndex;
 
    int           replaces;
    TQDialog*      replacePrompt;
    TQString m_replacement;
    TQRegExp m_re;
};

class KateReplacePrompt : public KDialogBase
{
  TQ_OBJECT
 
  public:
    KateReplacePrompt(TQWidget *parent);
 
  signals:
    void clicked();
 
  protected slots:
    void slotOk ();

    void slotClose ();

    void slotUser1 ();

    void slotUser2 ();

    void slotUser3 ();

    void done (int result);
};
 
class SearchCommand : public Kate::Command, public Kate::CommandExtension
{
  public:
    SearchCommand() : m_ifindFlags(0) {;}
    bool exec(class Kate::View *view, const TQString &cmd, TQString &errorMsg);
    bool help(class Kate::View *, const TQString &, TQString &);
    TQStringList cmds();
    bool wantsToProcessText( const TQString &/*cmdname*/ );
    void processText( Kate::View *view, const TQString& text );
 
  private:
    void ifindInit( const TQString &cmd );
    void ifindClear();
 
    long m_ifindFlags;
};
 
#endif