summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/support/arara/src/main/java/com/github/cereda/arara/model/Evaluator.java
blob: 41f8d0994308bef3198f8948a800cd513af7e37d (plain)
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
/**
 * Arara, the cool TeX automation tool
 * Copyright (c) 2012 -- 2018, Paulo Roberto Massa Cereda 
 * All rights reserved.
 *
 * Redistribution and  use in source  and binary forms, with  or without
 * modification, are  permitted provided  that the  following conditions
 * are met:
 *
 * 1. Redistributions  of source  code must  retain the  above copyright
 * notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form  must reproduce the above copyright
 * notice, this list  of conditions and the following  disclaimer in the
 * documentation and/or other materials provided with the distribution.
 *
 * 3. Neither  the name  of the  project's author nor  the names  of its
 * contributors may be used to  endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS  PROVIDED BY THE COPYRIGHT  HOLDERS AND CONTRIBUTORS
 * "AS IS"  AND ANY  EXPRESS OR IMPLIED  WARRANTIES, INCLUDING,  BUT NOT
 * LIMITED  TO, THE  IMPLIED WARRANTIES  OF MERCHANTABILITY  AND FITNESS
 * FOR  A PARTICULAR  PURPOSE  ARE  DISCLAIMED. IN  NO  EVENT SHALL  THE
 * COPYRIGHT HOLDER OR CONTRIBUTORS BE  LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY,  OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT  NOT LIMITED  TO, PROCUREMENT  OF SUBSTITUTE  GOODS OR  SERVICES;
 * LOSS  OF USE,  DATA, OR  PROFITS; OR  BUSINESS INTERRUPTION)  HOWEVER
 * CAUSED AND  ON ANY THEORY  OF LIABILITY, WHETHER IN  CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
 * WAY  OUT  OF  THE USE  OF  THIS  SOFTWARE,  EVEN  IF ADVISED  OF  THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package com.github.cereda.arara.model;

import com.github.cereda.arara.controller.ConfigurationController;
import com.github.cereda.arara.controller.LanguageController;
import com.github.cereda.arara.utils.CommonUtils;
import com.github.cereda.arara.utils.Methods;
import java.util.HashMap;
import java.util.Map;
import org.mvel2.templates.TemplateRuntime;

/**
 * Implements the evaluator model, on which a conditional can be analyzed and
 * processed.
 * @author Paulo Roberto Massa Cereda
 * @version 4.0
 * @since 4.0
 */
public class Evaluator {

    // this attribute holds the maximum number of
    // loops arara will accept; it's like
    // reaching infinity
    private final long loops;
    
    // the counter for the current execution, it
    // helps us keep track of the number of times
    // this evaluation has happened, and also to
    // prevent potential infinite loops
    private long counter;
    
    // a flag that indicates the
    // evaluation to halt regardless
    // of the the result
    private boolean halt;
    
    // the application messages obtained from the
    // language controller
    private static final LanguageController messages =
            LanguageController.getInstance();

    /**
     * Constructor. It gets the application maximum number of loops and reset
     * all counters.
     */
    public Evaluator() {
        loops = (Long) ConfigurationController.getInstance().
                get("execution.loops");
        counter = 0;
        halt = false;
    }

    /**
     * Evaluate the provided conditional.
     * @param conditional The conditional object.
     * @return A boolean value indicating if the conditional holds.
     * @throws AraraException Something wrong happened, to be caught in the
     * higher levels.
     */
    public boolean evaluate(Conditional conditional) throws AraraException {
        
        // when in dry-run mode, arara
        // always ignore conditional evaluations
        if (((Boolean) ConfigurationController.
                getInstance().get("execution.dryrun")) == true) {
            return false;
        }

        switch (conditional.getType()) {
            case NONE:
                return false;
            case IF:
            case UNLESS:
                if (!halt) {
                    halt = true;
                } else {
                    return false;
                }
                break;
        }

        // check counters and see if the execution
        // has reached our concept of infinity,
        // thus breaking the cycles
        counter++;
        if (((conditional.getType() == Conditional.ConditionalType.WHILE) &&
                (counter > loops)) ||
                ((conditional.getType() == Conditional.ConditionalType.UNTIL) &&
                (counter >= loops))) {
            return false;
        } else {

            Map<String, Object> context = new HashMap<String, Object>();
            Methods.addConditionalMethods(context);

            try {
                Object result = TemplateRuntime.eval("@{ ".concat(
                        conditional.getCondition()).concat(" }"), context);
                if (!CommonUtils.checkClass(Boolean.class, result)) {
                    throw new AraraException(
                            messages.getMessage(
                                    Messages.ERROR_EVALUATE_NOT_BOOLEAN_VALUE
                            )
                    );
                } else {
                    boolean value = (Boolean) result;
                    switch (conditional.getType()) {
                        case UNLESS:
                        case UNTIL:
                            value = !value;
                            break;
                    }
                    return value;
                }
            } catch (RuntimeException exception) {
                throw new AraraException(
                        messages.getMessage(
                                Messages.ERROR_EVALUATE_COMPILATION_FAILED
                        ),
                        exception
                );
            }
        }
    }

}