/*  This file is part of the KDE libraries and the Kate part.
 *
 *  Copyright (C) 2008 Erlend Hamberg <ehamberg@gmail.com>
 *
 *  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 KATE_VI_RANGE_INCLUDED
#define KATE_VI_RANGE_INCLUDED

#include <ktexteditor_export.h>
#include <QDebug>

namespace ViMotion
{
enum MotionType {
    ExclusiveMotion, InclusiveMotion
};
}

class KTEXTEDITOR_EXPORT  KateViRange
{
public:
    KateViRange(int slin, int scol, int elin, int ecol, ViMotion::MotionType mt);
    KateViRange(int elin, int ecol, ViMotion::MotionType inc);
    KateViRange();

    void normalize();
    bool isInclusive() const
    {
        return motionType == ViMotion::InclusiveMotion;
    };

    int startLine, startColumn;
    int endLine, endColumn;
    ViMotion::MotionType motionType;
    bool valid;
    bool jump;
    /**
     * qDebug stream operator.  Writes this katevirange to the debug output in a nicely formatted way.
     */
    inline friend QDebug operator<< (QDebug s, const KateViRange &range)
    {
        s << "[" << " (" << range.startLine << ", " << range.startColumn << ")" << " -> " << " (" << range.endLine << ", " << range.endColumn << ")" << "]" << " (" << (range.isInclusive() ? "Inclusive" : "Exclusive") << ") (jump: " << (range.jump ? "true" : "false") << ")";
        return s;
    }

    static KateViRange invalid()
    {
        KateViRange r;
        r.valid = false;
        return r;
    };
};

#endif
