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
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
|
/**
* \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
*
* DirectiveParser: This class analyzes the list of directives and converts them
* to a list of arara tasks.
*/
// package definition
package com.github.arara.utils;
// needed imports
import com.github.arara.exception.AraraException;
import com.github.arara.model.AraraDirective;
import com.github.arara.model.AraraTask;
import java.io.File;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Analyzes the list of directives and converts them to a list of arara tasks.
*
* @author Paulo Roberto Massa Cereda
* @version 3.0a
* @since 1.0
*/
public class DirectiveParser {
// the logger
final static Logger logger = LoggerFactory.getLogger(DirectiveParser.class);
// the list of directives
private List<AraraDirective> directives;
// the list of tasks
private List<AraraTask> tasks;
// the list of file names, to use as a temporary variable
private List<String> fileNames;
// the list of items
private List<String> items;
// the current file reference
private File file;
// the localization class
final static AraraLocalization localization = AraraLocalization.getInstance();
/**
* Constructor
*/
public DirectiveParser() {
}
/**
* Constructor.
*
* @param directives The Arara directives.
*/
public DirectiveParser(List<AraraDirective> directives) {
// set the directives
this.directives = directives;
// create a new list of tasks
this.tasks = new ArrayList<AraraTask>();
// create a new list of file names
this.fileNames = new ArrayList<String>();
// create a new list of items
this.items = new ArrayList<String>();
}
/**
* Setter for file.
*
* @param file The file.
*/
public void setFile(File file) {
// set the file
this.file = file;
}
/**
* Setter for the list of Arara directives.
*
* @param directives The list of Arara directives.
*/
public void setDirectives(List<AraraDirective> directives) {
// set the list
this.directives = directives;
}
/**
* Parses the list of Arara directives.
*
* @return A list of Arara tasks based on the directives.
* @throws AraraMalformedDirective Raised when a malformed directive is
* found.
*/
public List<AraraTask> parse() throws AraraException {
// log message
logger.info("Parsing directives.");
// for every directive
for (AraraDirective currentDirective : directives) {
// clear the list of files
fileNames.clear();
// clear the task name
String taskName = "";
// create a new map
Map taskConfig = new HashMap();
// if there's no configuration
if (currentDirective.getConfig().isEmpty()) {
// set the name
taskName = currentDirective.getName();
} else {
// get the current config
Map currentConfig = currentDirective.getConfig();
// and get the directive name
String directiveName = (String) currentConfig.keySet().iterator().next();
// set the name to the task
taskName = directiveName;
// get the parameters
Object currentConfigParameters = currentConfig.get(directiveName);
// if it is a map
if (currentConfigParameters instanceof Map) {
// get the map
Map currentParameters = (Map) currentConfigParameters;
// if it is empty, error
if (currentParameters.isEmpty()) {
// raise an error
throw new AraraException(localization.getMessage("Error_DirectiveEmptyCurlyBrackets", directiveName, currentDirective.getLineNumber()));
} else {
// for every parameter
for (Object currentParameterKey : currentParameters.keySet()) {
// if the parameter is a string
if (currentParameters.get(currentParameterKey) instanceof String) {
// if it is a file reference, error
if (((String) currentParameterKey).equals("files")) {
// raise an error
throw new AraraException(localization.getMessage("Error_DirectiveInvalidArgumentList", directiveName, currentDirective.getLineNumber(), "files"));
}
if (((String) currentParameterKey).equals("items")) {
// raise an error
throw new AraraException(localization.getMessage("Error_DirectiveInvalidArgumentList", directiveName, currentDirective.getLineNumber(), "items"));
}
// if it is a file reference, error
if (((String) currentParameterKey).equals("file")) {
// raise an error
throw new AraraException(localization.getMessage("Error_DirectiveReservedKeyword", directiveName, currentDirective.getLineNumber(), "file", "files"));
}
if (((String) currentParameterKey).equals("item")) {
// raise an error
throw new AraraException(localization.getMessage("Error_DirectiveReservedKeyword", directiveName, currentDirective.getLineNumber(), "item", "items"));
}
// add the parameter to the configuration
taskConfig.put(currentParameterKey, (String) currentParameters.get(currentParameterKey));
} else {
// if it is a list
if (currentParameters.get(currentParameterKey) instanceof List) {
// if it is a file reference
if (((String) currentParameterKey).equals("files")) {
// get the list
for (Object currentListValue : ((List) currentParameters.get(currentParameterKey))) {
// add the file names
fileNames.add(currentListValue.toString());
}
} else {
if (((String) currentParameterKey).equals("items")) {
// get the list
for (Object currentListValue : ((List) currentParameters.get(currentParameterKey))) {
// add the file names
items.add(currentListValue.toString());
}
} else {
// raise error
throw new AraraException(localization.getMessage("Error_DirectiveListError", directiveName, currentDirective.getLineNumber()));
}
}
} else {
// raise error
throw new AraraException(localization.getMessage("Error_DirectiveGenericError", directiveName, currentDirective.getLineNumber()));
}
}
}
}
} else {
// raise error
throw new AraraException(localization.getMessage("Error_DirectiveGenericError", directiveName, currentDirective.getLineNumber()));
}
}
// set original file name
AraraMethods.setOriginalFile(file.getName());
// if there is not a list of filenames
if (fileNames.isEmpty()) {
// add the only filename available
fileNames.add(file.getName());
}
// if there are no items available
if (items.isEmpty()) {
// simply add an empty entry
items.add("");
}
// for every filename
for (String filename : fileNames) {
// and for every item
for (String item : items) {
// create a new task
AraraTask araraTask = new AraraTask();
// set the name
araraTask.setName(taskName);
// create a new map based on the current configuration
HashMap currentTaskConfig = new HashMap(taskConfig);
// add the current file
currentTaskConfig.put("file", filename);
currentTaskConfig.put("item", item);
// set the parameters
araraTask.setParameters(currentTaskConfig);
// and add the task to the list
tasks.add(araraTask);
// the current task is now null
araraTask = null;
}
}
// clear the list of files and items
fileNames.clear();
items.clear();
}
// return the list of tasks
return tasks;
}
}
|