/**
 * UGENE - Integrated Bioinformatics Tools.
 * Copyright (C) 2008-2023 UniPro <ugene@unipro.ru>
 * http://ugene.net
 *
 * This program 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 2
 * of the License, or (at your option) any later version.
 *
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301, USA.
 */

#pragma once

#include <U2Core/BackgroundTaskRunner.h>
#include <U2Core/U2Region.h>
#include <U2Core/U2Type.h>

namespace U2 {

class DNAAlphabet;
class U2SequenceObject;
class U2Region;

struct CharOccurResult {
public:
    CharOccurResult(char charInSequence, qint64 numberOfOccurrence, double percentageOfOccur);

    inline char getChar() const {
        return charInSequence;
    }
    inline qint64 getNumberOfOccur() const {
        return numberOfOccurr;
    }
    inline double getPercentage() const {
        return percentageOfOccur;
    }

private:
    char charInSequence;
    qint64 numberOfOccurr;
    double percentageOfOccur;
};

typedef QList<CharOccurResult> CharactersOccurrence;

class U2VIEW_EXPORT CharOccurTask : public BackgroundTask<QList<CharOccurResult>> {
public:
    CharOccurTask(const DNAAlphabet* alphabet, U2EntityRef seqRef, const QVector<U2Region>& regions);

    /**
     * Calculates the characters occurrence (in a different thread).
     * Assumes that the sequence consists of characters from the passed alphabet.
     */
    virtual void run();

private:
    const DNAAlphabet* alphabet;
    U2EntityRef seqRef;
    QVector<U2Region> regions;

    // A region to analyze at a time
    static const qint64 REGION_TO_ANALAYZE = 1000000;
};

}  // namespace U2
