movingrange.h

Go to the documentation of this file.

/* This file is part of the KDE project
 *
 *  Copyright (C) 2010 Christoph Cullmann <cullmann@kde.org>
 *
 *  Based on code of the SmartCursor/Range by:
 *  Copyright (C) 2003-2005 Hamish Rodda <rodda@kde.org>
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Library General Public
 *  License as published by the Free Software Foundation; either
 *  version 2 of the License, or (at your option) any later version.
 *
 *  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 KDELIBS_KTEXTEDITOR_MOVINGRANGE_H
#define KDELIBS_KTEXTEDITOR_MOVINGRANGE_H

#include <ktexteditor/ktexteditor_export.h>
#include <ktexteditor/attribute.h>
#include <ktexteditor/range.h>
#include <ktexteditor/movingcursor.h>

// TODO: KDE5, maybe add
// - void MoivingRange::setBlockMode(bool enableBlockMode);
// - bool MoivingRange::blockMode() const;
// This way, arbitrary highlighting would work for colums as well. In fact, if implemented
// correctly in the Kate Renderer, drawing block selection mode could use this, too.
// The vi in put mode yank highlighting could use it, too: https://bugs.kde.org/show_bug.cgi?id=324695
//
// A correct implementation needs to take care of MovingRangeFeedback, especially
// of mouseEnteredRange(), mouseExitedRange(), caretEnteredRange() and caretEnteredRange()

namespace KTextEditor
{

class Document;
class View;
class MovingRangeFeedback;

class KTEXTEDITOR_EXPORT MovingRange
{
  //
  // sub types
  //
  public:
    enum InsertBehavior {
      DoNotExpand = 0x0,
      ExpandLeft = 0x1,
      ExpandRight = 0x2
    };
    Q_DECLARE_FLAGS(InsertBehaviors, InsertBehavior)

    
    enum EmptyBehavior {
      AllowEmpty        = 0x0, 
      InvalidateIfEmpty = 0x1  
    };

  //
  // stuff that needs to be implemented by editor part cursors
  //
  public:
    virtual void setInsertBehaviors (InsertBehaviors insertBehaviors) = 0;

    virtual InsertBehaviors insertBehaviors () const = 0;

    virtual void setEmptyBehavior (EmptyBehavior emptyBehavior) = 0;

    virtual EmptyBehavior emptyBehavior () const = 0;

    virtual Document *document () const = 0;

    virtual void setRange (const KTextEditor::Range &range) = 0;

    virtual const MovingCursor &start () const = 0;

    virtual const MovingCursor &end () const = 0;

    virtual View *view () const = 0;

    virtual void setView (View *view) = 0;

    virtual Attribute::Ptr attribute () const = 0;

    virtual void setAttribute (Attribute::Ptr attribute) = 0;

    virtual bool attributeOnlyForViews () const = 0;

    virtual void setAttributeOnlyForViews (bool onlyForViews) = 0;

    virtual MovingRangeFeedback *feedback () const = 0;

    virtual void setFeedback (MovingRangeFeedback *feedback) = 0;
    
    virtual qreal zDepth () const = 0;
    
    virtual void setZDepth (qreal zDepth) = 0;

    virtual ~MovingRange ();

  //
  // forbidden stuff
  //
  protected:
    MovingRange ();

  private:
    MovingRange (const MovingRange &);

    MovingRange &operator= (const MovingRange &);

  //
  // convenience API
  //
  public:
    void setRange (const Cursor &start, const Cursor &end);

    const Range toRange () const { return Range (start().toCursor(), end().toCursor()); }

    operator const Range () const { return Range (start().toCursor(), end().toCursor()); }

    inline friend QDebug operator<< (QDebug s, const MovingRange *range) {
      if (range)
        s << "[" << range->start() << " -> " << range->end() << "]";
      else
        s << "(null range)";
      return s.space();
    }

    inline friend QDebug operator<< (QDebug s, const MovingRange &range) {
      return s << &range;
    }

    inline bool isEmpty() const {
      return start() == end();
    }

    //BEGIN comparison functions
    inline bool contains(const Range& range) const {
      return range.start() >= start() && range.end() <= end();
    }

    inline bool contains(const Cursor& cursor) const {
      return cursor >= start() && cursor < end();
    }

    inline bool containsLine(int line) const {
      return (line > start().line() || (line == start().line() && !start().column())) && line < end().line();
    }

    inline bool containsColumn(int column) const {
      return column >= start().column() && column < end().column();
    }

    bool overlaps(const Range& range) const;

    inline bool overlapsLine(int line) const {
      return line >= start().line() && line <= end().line();
    }

    inline bool overlapsColumn(int column) const {
      return start().column() <= column && end().column() > column;
    }
    
    inline bool onSingleLine() const {
      return start().line() == end().line();
    }

    //END comparison functions
};

Q_DECLARE_OPERATORS_FOR_FLAGS(MovingRange::InsertBehaviors)

}

#endif

// kate: space-indent on; indent-width 2; replace-tabs on;