dialogplayer.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * 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 3 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, see <http://www.gnu.org/licenses/>.
 *
 */

#ifndef STARK_SERVICES_DIALOG_PLAYER_H
#define STARK_SERVICES_DIALOG_PLAYER_H

#include "common/array.h"

#include "engines/stark/resources/dialog.h"

namespace Stark {

namespace Resources {
class Speech;
}

class DialogPlayer {
public:
    DialogPlayer();
    virtual ~DialogPlayer();

    enum OptionType {
        kOptionTypeAsk = 0
    };

    struct Option {
        uint32 _type;
        Common::String _caption;
        Resources::Dialog::Topic *_topic;
        int32 _replyIndex;
    };

    void run(Resources::Dialog *dialog);

    void playSingle(Resources::Speech *speech);

    bool isRunning() const;

    void update();

    void selectOption(uint32 index);

    bool isSpeechReady() const;
    bool isSpeechReady(Resources::Speech *speech) const;

    Resources::Speech *acquireReadySpeech();

    bool areOptionsAvailable() const;

    Common::Array<DialogPlayer::Option> listOptions() const;

    void resume(Resources::Dialog *dialog);

    void reset();

protected:
    void buildOptions();

    void removeLastOnlyOption();

    void onReplyEnd();

    void saveToInterruptionSlot();
    void restoreFromInterruptionSlot();

    Resources::Dialog *_currentDialog;
    Resources::Dialog::Reply *_currentReply;

    Resources::Dialog *_interruptedDialog;
    Resources::Dialog::Reply *_interruptedReply;

    Resources::Speech *_singleSpeech;

    bool _speechReady;
    bool _optionsAvailable;
    Common::Array<Option> _options;
};

} // End of namespace Stark

#endif // STARK_SERVICES_DIALOG_PLAYER_H