katebuffer.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
   Copyright (c) 2000 Waldo Bastian <bastian@kde.org>
   Copyright (C) 2002-2004 Christoph Cullmann <cullmann@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 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_BUFFER_H__
#define __KATE_BUFFER_H__

#include "katetextbuffer.h"

#include "katepartprivate_export.h"

#include <QtCore/QObject>

class KateLineInfo;
class KateDocument;
class KateHighlighting;

class KATEPART_TESTS_EXPORT KateBuffer : public Kate::TextBuffer
{
  Q_OBJECT

  public:
    explicit KateBuffer (KateDocument *doc);

    ~KateBuffer ();

  public:
    void editStart ();

    void editEnd ();

    inline bool editChanged () const { return editingChangedBuffer (); }

    inline int editTagStart () const { return editingMinimalLineChanged (); }

    inline int editTagEnd () const { return editingMaximalLineChanged (); }

    inline bool editTagFrom () const { return editingChangedNumberOfLines() != 0; }

  public:
    void clear();

    bool openFile (const QString &m_file, bool enforceTextCodec);

    bool brokenEncoding () const { return m_brokenEncoding; }

    bool tooLongLinesWrapped () const { return m_tooLongLinesWrapped; }

    bool canEncode ();

    bool saveFile (const QString &m_file);

  public:
    inline Kate::TextLine plainLine (int lineno)
    {
        if (lineno < 0 || lineno >= lines())
          return Kate::TextLine ();

        return line (lineno);
    }

    void ensureHighlighted(int line, int lookAhead = 64);

    inline int count() const { return lines(); }

    void unwrapLines (int from, int to);

    void unwrapLine (int line);

    void wrapLine (const KTextEditor::Cursor &position);

  public:
    inline int tabWidth () const { return m_tabWidth; }

  public:
    void setTabWidth (int w);

    void setHighlight (int hlMode);

    KateHighlighting *highlight () { return m_highlight; }

    void invalidateHighlighting();
    
    KTextEditor::Range computeFoldingRangeForStartLine (int startLine);

  private:
    void doHighlight (int from, int to, bool invalidate);

  Q_SIGNALS:
    void tagLines(int start, int end);
    void respellCheckBlock(int start, int end);
  
  private:
    KateDocument *const m_doc;

    bool m_brokenEncoding;

    bool m_tooLongLinesWrapped;

    KateHighlighting *m_highlight;

    // for the scrapty indent sensitive langs
    int m_tabWidth;

    int m_lineHighlighted;

    int m_maxDynamicContexts;
};

#endif

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