summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/support/arara/src/main/java/com/github/arara/utils/AraraUtils.java
blob: 42eaa6c44a2250cd7c06dce28accb8f60a028f8e (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
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
/**
 * \cond LICENSE
 * Arara -- the cool TeX automation tool
 * Copyright (c) 2012, 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.
 * \endcond
 *
 * AraraUtils: This class contains some helper methods used for general purpose.
 */
// package definition
package com.github.arara.utils;

// needed imports
import java.util.StringTokenizer;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.apache.commons.lang3.text.WordUtils;
import org.yaml.snakeyaml.error.MarkedYAMLException;

/**
 * Contains some helper methods used for general purpose.
 * 
 * @author Paulo Roberto Massa Cereda
 * @version 3.0a
 * @since 3.0
 */
public class AraraUtils {
    
    // the localization class
    final static AraraLocalization localization = AraraLocalization.getInstance();

    /**
     * Removes the reserved keyword in the strings to be analyzed by the MVEL
     * template engine. The keyword is set in AraraConstants.
     * 
     * @param line The line to be analyzed.
     * @return The new line without the keyword.
     */
    public static String removeKeyword(String line) {
        
        // set a new pattern and matcher
        Pattern pattern = Pattern.compile(AraraConstants.RULEPATTERN);
        Matcher matcher = pattern.matcher(line);
        
        // if the keyword is found
        if (matcher.find()) {
            
            // remove the keyword
            line = (line.substring(matcher.end(), line.length())).trim();
        }
        
        // and return it
        return line;
    }

    /**
     * Prints the arara ASCII header.
     */
    public static void printHeader() {

        // print the ASCII art
        System.out.println("  __ _ _ __ __ _ _ __ __ _ ");
        System.out.println(" / _` | '__/ _` | '__/ _` |");
        System.out.println("| (_| | | | (_| | | | (_| |");
        System.out.println(" \\__,_|_|  \\__,_|_|  \\__,_|\n");

    }

    /**
     * Wraps the string to several lines, according to the wrap length set in
     * the AraraConstants class.
     * 
     * @param message The message to be wrapped.
     * @return A new message.
     */
    public static String wrap(String message) {
                
        // create a new tokenizer in order to allow line breaks, so
        // every line is processed individually
        StringTokenizer tokens = new StringTokenizer(message, "\n", true);
        String result = "";
        
        // iterate through tokens
        while (tokens.hasMoreTokens()) {
            
            // wrap line according to the wrap length
            result = result.concat(WordUtils.wrap(tokens.nextToken(), AraraConstants.WRAPLENGTH));
        }
        
        // return the result
        return result;
    }

    /**
     * Gets the variable reference from a RuntimeException object.
     * @param runtimeException The RuntimeException object.
     * 
     * @return The variable reference name.
     */
    public static String getVariableFromException(RuntimeException runtimeException) {
    
        // set pattern and matcher
        Pattern pattern = Pattern.compile(AraraConstants.VAREXCEPTIONPATTERN);
        Matcher matcher = pattern.matcher(runtimeException.getMessage());
        
        // if the variable is found
        if (matcher.find()) {
            
            // check if it's a valid reference
            if (matcher.groupCount() != 0) {
                
                // return the variable name
                return matcher.group(1);
            }
            
        } else {
                        
            // maybe it's a method call, let's investigate
            pattern = Pattern.compile(AraraConstants.METHODEXCEPTIONPATTERN);
            matcher = pattern.matcher(runtimeException.getMessage());
            
            if (matcher.find()) {
                
                // check if it's a valid reference
                if (matcher.groupCount() > 1) {

                    // return the method name
                    return matcher.group(2);
                }
                
            }
            
        }
        
        // nothing is found, so return an unknown reference
        return "<unknown>";
    }
    
    /**
     * Extracts information from a MarkedYAMLException object.
     * 
     * @param yamlException The exception object.
     * @return A string containing all the available information from the
     * exception object.
     */
    public static String extractInformationFromYAMLException(MarkedYAMLException yamlException) {
        StringBuilder stringBuilder = new StringBuilder();
        if (yamlException.getContext() != null) {
            stringBuilder.append(localization.getMessage("YamlError_Context", yamlException.getContext())).append("\n");
        }
        if (yamlException.getProblem() != null) {
            stringBuilder.append(localization.getMessage("YamlError_Problem", yamlException.getProblem())).append("\n");
        }
        if (yamlException.getProblemMark() != null) {
            stringBuilder.append(localization.getMessage("YamlError_ErrorLocation", yamlException.getProblemMark().getLine(), yamlException.getProblemMark().getColumn())).append("\n");
        }
        if (yamlException.getProblemMark().get_snippet() != null) {
            stringBuilder.append(yamlException.getProblemMark().get_snippet());
        }
        return stringBuilder.toString();
    }
    
    /**
     * Checks if the line contains a valid full directive.
     * 
     * @param line The current line.
     * @return A logic value indicating if a valid directive was found.
     */
    public static boolean checkForFullDirective(String line) {
        Pattern pattern = Pattern.compile(AraraConstants.FULLDIRECTIVEPATTERN);
        Matcher m = pattern.matcher(line);
        if (m.find()) {
            return true;
        }
        else {
            return false;
        }
    }
    
    /**
     * Checks if the line contains a valid empty directive.
     * 
     * @param line The current line.
     * @return A logic value indicating if a valid directive was found.
     */
    public static boolean checkForEmptyDirective(String line) {
        Pattern pattern = Pattern.compile(AraraConstants.EMPTYDIRECTIVEPATTERN);
        Matcher m = pattern.matcher(line);
        if (m.find()) {
            return true;
        }
        else {
            return false;
        }
    }
}