File indexing completed on 2024-04-21 03:51:07

 /*
     SPDX-FileCopyrightText: 1999-2001 Ewald Arnold <kvoctrain@ewald-arnold.de>
     SPDX-FileCopyrightText: 2005-2007 Peter Hedlund <peter.hedlund@kdemail.net>
     SPDX-FileCopyrightText: 2007-2010 Frederik Gladhorn <gladhorn@kde.org>
     SPDX-FileCopyrightText: 2014 Inge Wallin <inge@lysator.liu.se>
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 
 #ifndef PRACTICESESSIONMANAGERBASE_H
 #define PRACTICESESSIONMANAGERBASE_H
 
 // Qt
 #include <QElapsedTimer>
 #include <QVector>
 // kdeedulibs
 #include <KEduVocExpression>
 
 // Parley
 #include "prefs.h"
 #include "testentry.h"
 
 class KEduVocDocument;
 
 namespace Practice
 {
 class SessionManagerBase
 {
 public:
     /**
      * Create a collection of entries to be practiced.
      */
     explicit SessionManagerBase(QWidget *parent);
 
     /**
      * destructor
      */
     virtual ~SessionManagerBase();
 
     /**
      * Prepare for practice using the entries in this document.
      *
      * The default implementation selects all available entries in the
      * document into the list allTestEntries and then calls
      * initializeTraining().
      */
     virtual void setDocument(KEduVocDocument *doc);
 
     /**
      * Initialize the lists of entries that will be used in the
      * training from the full set of available entries. Reimplement
      * this to create other types of training sessions.
      */
     virtual void initializeTraining() = 0;
 
     /**
      * Return the title of the document.
      */
     QString title() const;
 
     // Should be called when starting and ending the practice session respectively.
     // The default implementations only start and stop the practice timer.
     virtual void practiceStarted();
     virtual void practiceFinished();
 
     /** the time in seconds */
     int totalTime();
 
     /**
      * Get the next entry to show to the user. The default
      * implementation refills the active entries up to the max number
      * and selects a random entry from them.
      *
      * @return TestEntry* the next entry to be practiced
      */
     virtual TestEntry *nextTrainingEntry();
 
     /** Finish the currently active entry */
     virtual void removeCurrentEntryFromPractice();
 
     /**
      * Get a list of all entries in the test - used by the summary dialog
      */
     QList<TestEntry *> allTestEntries() const;
 
     /**
      * The number of entries available for the practice session.
      * This is used for statistics at the end of the session.
      * @return
      */
     int allEntryCount() const;
 
     /**
      * The number of entries that are still to be practiced
      * @return
      */
     int activeEntryCount();
 
     /**
      * Get a list of all unanswered entries in the test
      */
     QList<TestEntry *> allUnansweredTestEntries();
 
     // ----------------------------------------------------------------
     // Statistics
     int statisticTotalCorrectFirstAttempt();
     int statisticTotalWrong();
     int statisticTotalUnanswered();
 
     /**
      * Puts some grades on the shell
      */
     void printStatistics();
 
     QStringList multipleChoiceAnswers(int numberChoices);
 
     // QString currentConjugationTense();
 
 protected: // methods
     /**
      * Find out if the given expression can be used as a multiple choice answer for the current entry
      * (i.e. if it's not the answer itself, not a synonym and has a different text)
      */
     bool isValidMultipleChoiceAnswer(KEduVocExpression *e);
 
 protected: // data
     KEduVocDocument *m_doc{nullptr};
     QWidget *m_parent{nullptr};
     int m_learningLanguageIndex{0};
     int m_knownLanguageIndex{1};
     int m_testType{0};
 
     // ----------------------------------------------------------------
     // The following entries define the training
 
     /// All entries available in the document that fulfill the
     /// requirements set in the configuration and the grades in the
     /// entries themselves.
     QList<TestEntry *> m_allTestEntries;
 
     /// All entries that have not been entered into the active set.
     QList<TestEntry *> m_notAskedTestEntries;
 
     /// The list of entries that are being asked. If one of these is
     /// done, it can be deleted and an new one from
     /// m_notAskedTestEntries taken.
     QList<TestEntry *> m_currentEntries;
 
     // The index of the current entry in m_currentEntries.
     int m_currentEntry{-1};
 
     QElapsedTimer m_time;
     int m_totalTime{0};
 };
 
 }
 
 #endif // kvtquery_included