aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/include/parsingtoolbox.h
blob: f91c2f613ca2b5c9ae1a07d89bbd21062f2a6ea9 (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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
/***************************************************************************
 * 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 PARSINGTOOLBOX_H
#define PARSINGTOOLBOX_H

#include <QMap>
#include <vector>

#include "booleancondition.h"
#include "highlightdice.h"
#include "node/dicerollernode.h"
#include "node/executionnode.h"
#include "node/ifnode.h"
#include "node/paintnode.h"
#include "node/scalaroperatornode.h"
#include "operationcondition.h"
#include "range.h"
#include "validatorlist.h"

class RepeaterNode;
class DiceAlias;
class ExplodeDiceNode;

class SubtituteInfo
{
public:
    SubtituteInfo();

    bool isValid() const;

    int length() const;
    void setLength(int length);

    int resultIndex() const;
    void setResultIndex(int valueIndex);

    int position() const;
    void setPosition(int position);

    int digitNumber() const;
    void setDigitNumber(int digitNumber);

    int subIndex() const;
    void setSubIndex(int subindex);

private:
    int m_length= 2;
    int m_digitNumber= 0;
    int m_resultIndex= -1;
    int m_position= -1;
    int m_subIndex= -1;
};

/**
 * @brief The ParsingToolBox is gathering many useful methods for dice parsing.
 * Its goal is to make the diceparser a bit lighter.
 */
class ParsingToolBox
{
public:
    enum LIST_OPERATOR
    {
        NONE,
        UNIQUE
    };
    enum Function
    {
        REPEAT
    };
    enum OptionOperator
    {
        KeepAndExplode,
        Keep,
        Reroll,
        RerollUntil,
        Explode,
        Sort,
        Count,
        RerollAndAdd,
        Merge,
        ifOperator,
        Painter,
        Filter,
        Split,
        Group,
        Occurences,
        Unique,
        Bind,
        AllSameExplode
    };
    enum DiceOperator
    {
        D,
        L
    };
    enum NodeAction
    {
        JumpBackward
    };
    ParsingToolBox();
    ParsingToolBox(const ParsingToolBox& data);
    virtual ~ParsingToolBox();
    void clearUp();

    // Build execution tree
    DiceRollerNode* getDiceRollerNode(ExecutionNode* previous);
    DiceRollerNode* addRollDiceNode(qint64 faces, ExecutionNode*);
    ExplodeDiceNode* addExplodeDiceNode(qint64 faces, ExecutionNode* previous);
    Dice::CONDITION_STATE isValidValidator(ExecutionNode* previous, ValidatorList* val);
    ExecutionNode* addSort(ExecutionNode* e, bool b);

    // parsing tools
    static bool readAscending(QString& str);
    bool readLogicOperator(QString& str, BooleanCondition::LogicOperator& op);
    Validator* readValidator(QString& str, bool hasSquare= false);
    ValidatorList* readValidatorList(QString& str);
    static bool readNumber(QString& str, qint64& myNumber);
    static bool readString(QString& str, QString& strresult);
    static bool readVariable(QString& str, qint64& myNumber, QString& reasonFail);
    static bool readOpenParentheses(QString& str);
    static bool readCloseParentheses(QString& str);

    static bool readDynamicVariable(QString& str, qint64& index);
    bool readList(QString& str, QStringList& list, QList<Range>& ranges);
    bool readDiceRange(QString& str, qint64& start, qint64& end);
    static LIST_OPERATOR readListOperator(QString& str);
    void readProbability(QStringList& str, QList<Range>& ranges);
    bool readLogicOperation(QString& str, ValidatorList::LogicOperation& op);
    bool readDiceLogicOperator(QString& str, OperationCondition::ConditionOperator& op);
    bool readArithmeticOperator(QString& str, Die::ArithmeticOperator& op);
    std::vector<ExecutionNode*> readInstructionList(QString& str, bool startNode);
    static Dice::ConditionType readConditionType(QString& str);
    bool readComment(QString& str, QString&, QString&);
    bool readOperand(QString& str, ExecutionNode*& node);
    static int findClosingCharacterIndexOf(QChar open, QChar closing, const QString& str, int offset);
    static void readSubtitutionParameters(SubtituteInfo& info, QString& rest);
    static bool readPainterParameter(PainterNode* painter, QString& str);
    static bool readComma(QString& str);
    bool readReaperArguments(RepeaterNode* node, QString& source);
    bool readExpression(QString& str, ExecutionNode*& node);
    bool readInstructionOperator(QChar c);
    bool readNode(QString& str, ExecutionNode*& node);
    /**
     * @brief readIfInstruction reads the current command to build if node with proper parameters.
     * @param str is the command string, if IF istruction is found, the str will be changed, in other case the string is
     * unmodified
     * @param trueNode is the branch's beginning to be executed if the IfNode is true.
     * @param falseNode is the branch's beginning to be executed if the IfNode is false.
     * @return true, ifNode has been found, false otherwise
     */
    bool readIfInstruction(QString& str, ExecutionNode*& trueNode, ExecutionNode*& falseNode);
    bool readOptionFromNull(QString& str, ExecutionNode*& node);
    bool readOperatorFromNull(QString& str, ExecutionNode*& node);
    bool readParameterNode(QString& str, ExecutionNode*& node);
    bool readFunction(QString& str, ExecutionNode*& node);
    bool readDice(QString& str, ExecutionNode*& node);
    bool readDiceOperator(QString&, DiceOperator&);
    bool readDiceExpression(QString&, ExecutionNode*& node);
    bool readOperator(QString&, ExecutionNode* previous);
    bool readCommand(QString& str, ExecutionNode*& node);
    bool readBlocInstruction(QString& str, ExecutionNode*& resultnode);
    bool readOption(QString&, ExecutionNode* node); // OptionOperator& option,
    bool readValuesList(QString& str, ExecutionNode*& node);

    // Error
    bool hasError() const;
    void addError(Dice::ERROR_CODE code, const QString& msg);
    void addWarning(Dice::ERROR_CODE code, const QString& msg);
    const QMap<Dice::ERROR_CODE, QString>& getErrorList() const;
    const QMap<Dice::ERROR_CODE, QString>& getWarningList() const;

    // Traversal functions
    static QString number(qreal value);
    static ExecutionNode* getLatestNode(ExecutionNode* node);
    static ExecutionNode* getLeafNode(ExecutionNode* start);
    const std::vector<ExecutionNode*>& getStartNodes();
    static void setStartNodes(std::vector<ExecutionNode*>* startNodes);
    std::pair<bool, QVariant> hasResultOfType(Dice::RESULT_TYPE, ExecutionNode* node, bool notthelast= false) const;
    QList<qreal> scalarResultsFromEachInstruction() const;
    std::pair<QString, QString> finalScalarResult() const;
    QString finalStringResult() const;
    QStringList allFirstResultAsString(bool& hasAlias) const;
    QList<qreal> sumOfDiceResult() const;
    QList<ExportedDiceResult> diceResultFromEachInstruction() const;
    bool hasIntegerResultNotInFirst() const;
    bool hasDiceResult() const;
    bool hasStringResult() const;

    // result
    static QString replaceVariableToValue(const QString& source, QStringList values,
                                          QMap<Dice::ERROR_CODE, QString>& errorMap);
    static QString replacePlaceHolderToValue(const QString& source, const QList<ExportedDiceResult>& list);
    static SubtituteInfo readVariableFromString(const QString& source, int& start);
    static SubtituteInfo readPlaceHolderFromString(const QString& source, int& start);
    static ExportedDiceResult finalDiceResultFromInstruction(ExecutionNode* start);
    static ExportedDiceResult allDiceResultFromInstruction(ExecutionNode* start);
    void addResultInJson(QJsonObject& obj, Dice::RESULT_TYPE type, const QString& key, ExecutionNode* start, bool b);
    void addDiceResultInJson(QJsonObject& obj, ExecutionNode* start,
                             std::function<QString(const QString&, const QString&, bool)> colorize);

    // accessors
    void setComment(const QString& comment);
    QString getComment() const;
    void setHelpPath(const QString& path);
    static QHash<QString, QString> getVariableHash();
    static void setVariableHash(const QHash<QString, QString>& variableHash);
    void setStartNodes(std::vector<ExecutionNode*> nodes);

    // Aliases
    QString convertAlias(QString str);
    void insertAlias(DiceAlias* dice, int i);
    const QList<DiceAlias*>& getAliases() const;
    QList<DiceAlias*>* aliases();
    void cleanUpAliases();

    static bool readStringResultParameter(QString& str);
    static QString replacePlaceHolderFromJson(const QString& source, const QJsonObject& obj);

private:
    QMap<QString, BooleanCondition::LogicOperator> m_logicOp;
    QMap<QString, ValidatorList::LogicOperation> m_logicOperation;
    QMap<QString, OperationCondition::ConditionOperator> m_conditionOperation;
    std::vector<std::pair<QString, Die::ArithmeticOperator>> m_arithmeticOperation;
    QMap<QString, DiceOperator> m_mapDiceOp;
    QMap<QString, OptionOperator> m_OptionOp;
    QMap<QString, NodeAction> m_nodeActionMap;
    std::map<QString, Function> m_functionMap;
    QStringList m_commandList;

    QMap<Dice::ERROR_CODE, QString> m_errorMap;
    QMap<Dice::ERROR_CODE, QString> m_warningMap;
    std::vector<ExecutionNode*> m_startNodes;

    QString m_comment;

    static QHash<QString, QString> m_variableHash;
    QString m_helpPath;
    QList<DiceAlias*> m_aliasList;
};

#endif // PARSINGTOOLBOX_H