conversation.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 ULTIMA4_CONVERSATION_CONVERSATION_H
#define ULTIMA4_CONVERSATION_CONVERSATION_H

#include "ultima/ultima4/core/utils.h"

namespace Ultima {
namespace Ultima4 {

class Debug;
class Person;
class Script;

class ResponsePart {
public:
    ResponsePart(const Common::String &value, const Common::String &arg = "", bool command = false);

    operator Common::String() const;
    bool operator==(const ResponsePart &rhs) const;
    bool isCommand() const;

private:
    Common::String _value, _arg;
    bool _command;
};

class ResponseParts {
public:
    const ResponsePart NONE;
    const ResponsePart ASK;
    const ResponsePart END;
    const ResponsePart ATTACK;
    const ResponsePart BRAGGED;
    const ResponsePart HUMBLE;
    const ResponsePart ADVANCELEVELS;
    const ResponsePart HEALCONFIRM;
    const ResponsePart STARTMUSIC_LB;
    const ResponsePart STARTMUSIC_HW;
    const ResponsePart STOPMUSIC;
    const ResponsePart HAWKWIND;

    ResponseParts();
    ~ResponseParts();
};

extern ResponseParts *g_responseParts;

class Response {
public:
    Response(const Common::String &response);
    virtual ~Response() {}

    void add(const ResponsePart &part);

    virtual const Common::Array<ResponsePart> &getParts() const;

    operator Common::String() const;

    Response *addref();
    void release();

private:
    int _references;
    Common::Array<ResponsePart> _parts;
};

class DynamicResponse : public Response {
public:
    DynamicResponse(Response * (*generator)(const DynamicResponse *), const Common::String &param = "");
    virtual ~DynamicResponse();

    const Common::Array<ResponsePart> &getParts() const override;

    const Common::String &getParam() const {
        return _param;
    }

private:
    Response *(*_generator)(const DynamicResponse *);
    Response *_currentResponse;
    Common::String _param;
};

class Dialogue {
public:
    class Question {
    public:
        Question(const Common::String &txt, Response *yes, Response *no);

        Common::String getText();
        Response *getResponse(bool yes);

    private:
        Common::String _text;
        Response *_yesResp, *_noResp;
    };

    class Keyword {
    public:
        Keyword(const Common::String &kw, Response *resp);
        Keyword(const Common::String &kw, const Common::String &resp);
        ~Keyword();

        bool operator==(const Common::String &kw) const;

        /*
         * Accessor methods
         */
        const Common::String &getKeyword() {
            return _keyword;
        }
        Response *getResponse() {
            return _response;
        }

    private:
        Common::String _keyword;
        Response *_response;
    };

    typedef Common::HashMap<Common::String, Keyword *> KeywordMap;

    /*
     * Constructors/Destructors
     */
    Dialogue();
    virtual ~Dialogue();

    /*
     * Accessor methods
     */
    const Common::String &getName() const {
        return _name;
    }
    const Common::String &getPronoun() const {
        return _pronoun;
    }
    const Common::String &getPrompt() const {
        return _prompt;
    }
    Response *getIntro(bool familiar = false) {
        return _intro;
    }
    Response *getLongIntro(bool familiar = false) {
        return _longIntro;
    }
    Response *getDefaultAnswer() {
        return _defaultAnswer;
    }
    Dialogue::Question *getQuestion() {
        return _question;
    }

    /*
     * Getters
     */
    void setName(const Common::String &n) {
        _name           = n;
    }
    void setPronoun(const Common::String &pn) {
        _pronoun        = pn;
    }
    void setPrompt(const Common::String &prompt) {
        this->_prompt   = prompt;
    }
    void setIntro(Response *i) {
        _intro          = i;
    }
    void setLongIntro(Response *i) {
        _longIntro      = i;
    }
    void setDefaultAnswer(Response *a) {
        _defaultAnswer  = a;
    }
    void setTurnAwayProb(int prob) {
        _turnAwayProb   = prob;
    }
    void setQuestion(Question *q) {
        _question       = q;
    }
    void addKeyword(const Common::String &kw, Response *response);

    const ResponsePart &getAction() const;
    Common::String dump(const Common::String &arg);

    /*
     * Operators
     */
    Keyword *operator[](const Common::String &kw);

private:
    Common::String _name;
    Common::String _pronoun;
    Common::String _prompt;
    Response *_intro;
    Response *_longIntro;
    Response *_defaultAnswer;
    KeywordMap _keywords;
    union {
        int _turnAwayProb;
        int _attackProb;
    };
    Question *_question;
};

class Conversation {
public:
    enum State {
        INTRO,                  
        TALK,                   
        ASK,                    
        ASKYESNO,               
        VENDORQUESTION,         
        BUY_ITEM,               
        SELL_ITEM,              
        BUY_QUANTITY,           
        SELL_QUANTITY,          
        BUY_PRICE,              
        CONFIRMATION,           
        CONTINUEQUESTION,       
        TOPIC,                  
        PLAYER,                 
        FULLHEAL,               
        ADVANCELEVELS,          
        GIVEBEGGAR,             
        ATTACK,                 
        DONE                    
    };

    enum InputType {
        INPUT_STRING,
        INPUT_CHARACTER,
        INPUT_NONE
    };

    /* Constructor/Destructors */
    Conversation();
    ~Conversation();

    /* Member functions */
    InputType getInputRequired(int *bufferLen);

    /* Static variables */
    static const uint BUFFERLEN;    
public:
    State _state;                
    Common::String _playerInput;         
    Common::List<Common::String> _reply;         
    class Script *_script;       
    Dialogue::Question *_question; 
    int _quant;                  
    int _player;                 
    int _price;                  
};

} // End of namespace Ultima4
} // End of namespace Ultima

#endif