abstractlogdata.h

/*
 * Copyright (C) 2009, 2010 Nicolas Bonnefon and other contributors
 *
 * This file is part of glogg.
 *
 * glogg is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * glogg 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with glogg.  If not, see <http://www.gnu.org/licenses/>.
 */

/*
 * Copyright (C) 2016 -- 2019 Anton Filimonov and other contributors
 *
 * This file is part of klogg.
 *
 * klogg is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * klogg 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with klogg.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef ABSTRACTLOGDATA_H
#define ABSTRACTLOGDATA_H

#include <QObject>
#include <QString>
#include <QStringList>
#include <QTextCodec>

#include "linetypes.h"
#include "onelinelog.h"

// Base class representing a set of data.
// It can be either a full set or a filtered set.
class AbstractLogData : public QObject {
    Q_OBJECT
  public:
  public:
    // Returns then line as OneLineLog structure, You can do anything with it.
    OneLineLog getOneLineLog( LineNumber line ) const;
    // Returns a set of lines as a set of OneLineLog structure, You can do anything with it.
    klogg::vector<OneLineLog> getOneLineLogs( LineNumber firstLine, LinesCount number ) const;
    // Returns the line passed as a QString
    QString getLineString( LineNumber line ) const;
    // Returns the line passed as a QString, with tabs expanded
    QString getExpandedLineString( LineNumber line ) const;
    // Returns a set of lines as a QStringList
    klogg::vector<QString> getLines( LineNumber first_line, LinesCount number ) const;
    // Returns a set of lines with tabs expanded
    klogg::vector<QString> getExpandedLines( LineNumber first_line, LinesCount number ) const;
    // Returns the line numer
    LineNumber getLineNumber( LineNumber index ) const;
    // Returns the total number of lines
    LinesCount getNbLine() const;
    // Returns the visible length of the longest line
    // Tabs are expanded
    LineLength getMaxLength() const;
    // Returns the visible length of the passed line
    // Tabs are expanded
    LineLength getLineLength( LineNumber line ) const;

    // Set the view to use the passed encoding for display
    void setDisplayEncoding( const char* encoding_name );
    // Configure how the view shall interpret newline characters
    // this should be non zero for encodings where \n is encoded
    // in multiple bytes (e.g. UTF-16)
    void setMultibyteEncodingOffsets( int before_cr, int after_cr );

    QTextCodec* getDisplayEncoding() const;

    void attachReader() const;
    void detachReader() const;

    // The "type" of a line, which will appear in the FilteredView
    enum class LineTypeFlags {
        Plain = 0, // 0 can be checked like a proper flag in QFlags
        Match = 1 << 0,
        Mark = 1 << 1,
    };
    Q_DECLARE_FLAGS( LineType, LineTypeFlags )

  protected:
    // Returns then line as OneLineLog structure, You can do anything with it.
    virtual OneLineLog doGetOneLineLog( LineNumber line ) const = 0;
    // Returns a set of lines as a set of OneLineLog structure, You can do anything with it.
    virtual klogg::vector<OneLineLog> doGetOneLineLogs( LineNumber firstLine,
                                                        LinesCount number ) const
        = 0;
    // Internal function called to get a given line
    virtual QString doGetLineString( LineNumber line ) const = 0;
    // Internal function called to get a given line
    virtual QString doGetExpandedLineString( LineNumber line ) const = 0;
    // Internal function called to get a set of lines
    virtual klogg::vector<QString> doGetLines( LineNumber first_line, LinesCount number ) const = 0;
    // Internal function called to get a set of expanded lines
    virtual klogg::vector<QString> doGetExpandedLines( LineNumber first_line,
                                                       LinesCount number ) const
        = 0;

    // Internal function called to get the index of given line
    virtual LineNumber doGetLineNumber( LineNumber index ) const = 0;
    // Internal function called to get the number of lines
    virtual LinesCount doGetNbLine() const = 0;
    // Internal function called to get the maximum length
    virtual LineLength doGetMaxLength() const = 0;
    // Internal function called to get the line length
    virtual LineLength doGetLineLength( LineNumber line ) const = 0;
    // Internal function called to set the encoding
    virtual void doSetDisplayEncoding( const char* encoding ) = 0;
    virtual QTextCodec* doGetDisplayEncoding() const = 0;

    virtual void doAttachReader() const = 0;
    virtual void doDetachReader() const = 0;
};

Q_DECLARE_OPERATORS_FOR_FLAGS( AbstractLogData::LineType )

#endif