/****************************************************************************
**
** Copyright (C) 2021 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the tools applications of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:GPL-EXCEPT$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef TEXTCURSOR_H
#define TEXTCURSOR_H

#include <QtCore/qstring.h>

namespace Utils {

class TextDocument;
class TextBlock;

class TextCursor
{
public:
    enum MoveOperation {
        NoMove,
        Start,
        PreviousCharacter,
        End,
        NextCharacter,
    };

    enum MoveMode { MoveAnchor, KeepAnchor };

    enum SelectionType { Document };

    TextCursor();
    TextCursor(const TextBlock &block);
    TextCursor(TextDocument *document);

    bool movePosition(MoveOperation op, MoveMode = MoveAnchor, int n = 1);
    int position() const;
    void setPosition(int pos, MoveMode mode = MoveAnchor);
    QString selectedText() const;
    void clearSelection();
    int anchor() const;
    TextDocument *document() const;
    void insertText(const QString &text);
    TextBlock block() const;
    int positionInBlock() const;
    int blockNumber() const;

    void select(SelectionType selection);

    bool hasSelection() const;

    void removeSelectedText();
    int selectionEnd() const;

    bool isNull() const;

private:
    TextDocument *m_document = nullptr;
    int m_position = 0;
    int m_anchor = 0;
};
} // namespace Utils

#endif // TEXTCURSOR_H