aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/src/libparser/include/diceparser/diceparser.h
blob: bf2d5708d40b58de22bdede5b7c13533d44e5068 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
/***************************************************************************
 * Copyright (C) 2014 by Renaud Guezennec                                   *
 * https://rolisteam.org/contact                      *
 *                                                                          *
 *  This file is part of DiceParser                                         *
 *                                                                          *
 * DiceParser 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.,                                          *
 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.                 *
 ***************************************************************************/
#ifndef DICEPARSER_H
#define DICEPARSER_H

#include <QJsonObject>
#include <QMap>
#include <QString>
#include <QVariant>
#include <memory>
#include <vector>

#include <diceparser/diceparser_global.h>

#include <diceparser/diceparserhelper.h>
#include <diceparser/highlightdice.h>

class ExplodeDiceNode;
class ParsingToolBox;
class DiceRollerNode;
class DiceAlias;
class ExecutionNode;
/**
 * @page DiceParser Dice Parser
 *
 * @section Intro Introduction
 * Diceparser is the software component dedicated to compute dice command in rolisteam.<br/>
 *
 * @section grammar The Grammar
 *
 * The grammar is described in Readme.md
 */

/**
 * @brief The DiceParser class facade class, it receives a command and return a DiceResult class (not yet implemented).
 */
class DICEPARSER_EXPORT DiceParser
{
public:
    /**
     * @brief DiceParser default constructor
     */
    DiceParser();
    /**
     * @brief ~DiceParser
     */
    virtual ~DiceParser();

    // Command process methods
    /**
     * @brief parseLine, method to call for starting the dice roll. It will parse the command and run the execution
     * tree.
     * @param str dice command
     * @return bool every thing is fine or not
     */
    bool parseLine(QString str, bool allowAlias= true);
    void start();
    void cleanAll();

    // debug
    void writeDownDotTree(QString filepath);

    // control methods
    bool hasIntegerResultNotInFirst() const;
    bool hasDiceResult() const;
    bool hasStringResult() const;
    bool hasSeparator() const;

    // alias management
    const QList<DiceAlias*>& constAliases() const;
    QList<DiceAlias*>* aliases() const;
    void cleanAliases();
    void insertAlias(DiceAlias*, int);
    QString convertAlias(const QString& cmd) const;

    QStringList allFirstResultAsString(bool& hasAlias);
    QStringList getAllDiceResult(bool& hasAlias);

    // Accessors
    int startNodeCount() const;
    QList<qreal> scalarResultsFromEachInstruction() const;
    QStringList stringResultFromEachInstruction(bool& hasAlias) const;
    void diceResultFromEachInstruction(QList<ExportedDiceResult>& resultList) const;
    QString finalStringResult(std::function<QString(const QString&, const QString&, bool)> colorize) const;

    QString diceCommand() const;
    QMap<Dice::ERROR_CODE, QString> errorMap() const;
    QString comment() const;
    QString humanReadableWarning() const;
    QString humanReadableError() const;
    QString resultAsJSon(std::function<QString(const QString&, const QString&, bool)> colorize,
                         bool removeUnhighligthed= false) const;

    //    QStringList stringResult() const;
    //    QStringList allDiceResult(bool& hasAlias) const;
    //    void lastDiceResult(QList<ExportedDiceResult>& diceValues, bool& homogeneous) const;

    // setters
    void setPathToHelp(QString l);
    void setVariableDictionary(const QHash<QString, QString>& variables);
    void setComment(const QString& comment);

private:
    bool readBlocInstruction(QString& str, ExecutionNode*& resultnode);

private:
    std::unique_ptr<ParsingToolBox> m_parsingToolbox;
    QString m_command;
};

#endif // DICEPARSER_H