// Scintilla source code edit control
/** @file PerLine.h
 ** Manages data associated with each line of the document
 **/
// Copyright 1998-2009 by Neil Hodgson <neilh@scintilla.org>
// The License.txt file describes the conditions under which this software may be distributed.

#ifndef PERLINE_H
#define PERLINE_H

#ifdef SCI_NAMESPACE
namespace Scintilla {
#endif

/**
 * This holds the marker identifier and the marker type to display.
 * MarkerHandleNumbers are members of lists.
 */
struct MarkerHandleNumber {
    int handle;
    int number;
    MarkerHandleNumber *next;
};

/**
 * A marker handle set contains any number of MarkerHandleNumbers.
 */
class MarkerHandleSet {
    MarkerHandleNumber *root;

public:
    MarkerHandleSet();
    ~MarkerHandleSet();
    int Length() const;
    int NumberFromHandle(int handle) const;
    int MarkValue() const;  ///< Bit set of marker numbers.
    bool Contains(int handle) const;
    bool InsertHandle(int handle, int markerNum);
    void RemoveHandle(int handle);
    bool RemoveNumber(int markerNum);
    void CombineWith(MarkerHandleSet *other);
};

class LineMarkers : public PerLine {
    SplitVector<MarkerHandleSet *> markers;
    /// Handles are allocated sequentially and should never have to be reused as 32 bit ints are very big.
    int handleCurrent;
public:
    LineMarkers() : handleCurrent(0) {
    }
    virtual ~LineMarkers();
    virtual void Init();
    virtual void InsertLine(int line);
    virtual void RemoveLine(int line);

    int MarkValue(int line);
    int AddMark(int line, int marker, int lines);
    void MergeMarkers(int pos);
    bool DeleteMark(int line, int markerNum, bool all);
    void DeleteMarkFromHandle(int markerHandle);
    int LineFromHandle(int markerHandle);
};

class LineLevels : public PerLine {
    SplitVector<int> levels;
public:
    virtual ~LineLevels();
    virtual void Init();
    virtual void InsertLine(int line);
    virtual void RemoveLine(int line);

    void ExpandLevels(int sizeNew=-1);
    void ClearLevels();
    int SetLevel(int line, int level, int lines);
    int GetLevel(int line);
};

class LineState : public PerLine {
    SplitVector<int> lineStates;
public:
    LineState() {
    }
    virtual ~LineState();
    virtual void Init();
    virtual void InsertLine(int line);
    virtual void RemoveLine(int line);

    int SetLineState(int line, int state);
    int GetLineState(int line);
    int GetMaxLineState();
};

class LineAnnotation : public PerLine {
    SplitVector<char *> annotations;
public:
    LineAnnotation() {
    }
    virtual ~LineAnnotation();
    virtual void Init();
    virtual void InsertLine(int line);
    virtual void RemoveLine(int line);

    bool AnySet() const;
    bool MultipleStyles(int line) const;
    int Style(int line);
    const char *Text(int line) const;
    const unsigned char *Styles(int line) const;
    void SetText(int line, const char *text);
    void ClearAll();
    void SetStyle(int line, int style);
    void SetStyles(int line, const unsigned char *styles);
    int Length(int line) const;
    int Lines(int line) const;
};

#ifdef SCI_NAMESPACE
}
#endif

#endif
