tt_parser.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 TITANIC_TT_PARSER_H
#define TITANIC_TT_PARSER_H

#include "titanic/true_talk/tt_node.h"
#include "titanic/true_talk/tt_pronoun.h"
#include "titanic/true_talk/tt_sentence.h"
#include "titanic/true_talk/tt_string.h"

namespace Titanic {

enum NumberFlag { NF_1 = 1, NF_2 = 2, NF_4 = 4, NF_8 = 8, NF_10 = 0x10 };

enum ParserAction {
    NO_ACTION = 0, CHECK_COMMAND_FORM, EXPECT_THING,  OBJECT_IS_TO,
    SEEK_ACTOR, SEEK_OBJECT, SEEK_OBJECT_OVERRIDE, SEEK_TO,
    SEEK_FROM, SEEK_TO_OVERRIDE, SEEK_FROM_OVERRIDE, SEEK_LOCATION,
    SEEK_OWNERSHIP, SEEK_STATE, SEEK_MODIFIERS, SEEK_NEW_FRAME,
    SEEK_STATE_OBJECT, SET_ACTION, SET_COLOR, ACTOR_IS_TO,
    ACTOR_IS_FROM, ACTOR_IS_OBJECT, STATE_IDENTITY,
    WORD_TYPE_IS_SENTENCE_TYPE, COMPLEX_VERB
};

class CScriptHandler;
class TTconcept;

struct NumberEntry {
    CString _text;
    int _value;
    int _flags;

    NumberEntry() : _value(0), _flags(0) {}
    NumberEntry(const CString &text, int value, int flags) :
        _text(text), _value(value), _flags(flags) {}
};
typedef Common::Array<NumberEntry> NumberArray;

class TTparserNode : public TTnode {
public:
    uint _tag;
public:
    TTparserNode() : TTnode(), _tag(0) {}
    TTparserNode(uint tag) : TTnode(), _tag(tag) {}
};

class TTparser {
private:
    StringArray _replacements1;
    StringArray _replacements2;
    StringArray _replacements3;
    StringArray _replacements4;
    StringArray _phrases;
    NumberArray _numbers;
    TTparserNode *_nodesP;
    TTconcept *_conceptP;
    TTconcept *_currentConceptP;
private:
    void clear();

    void loadArray(StringArray &arr, const CString &name);

    void loadArrays();

    int normalize(TTsentence *sentence);

    bool normalizeContraction(const TTstring &srcLine, int &srcIndex, TTstring &destLine);

    static int isEmoticon(const TTstring &str, int &index);

    static void searchAndReplace(TTstring &line, const StringArray &strings);

    static int searchAndReplace(TTstring &line, int startIndex, const StringArray &strings);

    int replaceNumbers(TTstring &line, int startIndex);

    const NumberEntry *replaceNumbers2(TTstring &line, int *startIndex);

    int loadRequests(TTword *word);
    int considerRequests(TTword *word);
    int processRequests(TTword *word);

    int addToConceptList(TTword *word);
    int checkReferent(TTpronoun *pronoun);

    void addNode(uint tag);

    int addConcept(TTconcept *c);

    void removeConcept(TTconcept *c);

    void removeNode(TTparserNode *node);

    void preprocessGerman(TTstring &line);

    int processModifiers(int modifier, TTword *word);

    int checkForAction();
    int fn2(TTword *word);
    bool checkConcept2(TTconcept *conceptP, int conceptMode);
    int filterConcepts(int conceptMode, int conceptIndex);
    bool resetConcept(TTconcept **conceptPP, int conceptIndex);
public:
    CScriptHandler *_owner;
    TTsentenceConcept *_sentenceConcept;
    TTsentence *_sentence;
    int _fieldC;
    int _field10;
    int _field14;
    TTword *_currentWordP;
    StringArray _pronouns;
public:
    TTparser(CScriptHandler *owner);
    ~TTparser();

    int preprocess(TTsentence *sentence);

    int findFrames(TTsentence *sentence);

    void conceptChanged(TTconcept *newConcept, TTconcept *oldConcept);
};

} // End of namespace Titanic

#endif /* TITANIC_TT_PARSER_H */