-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
Module.java
600 lines (533 loc) · 21.2 KB
/
Module.java
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
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
/*
* Copyright 2011 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.gradle.plugins.ide.idea.model;
import com.google.common.base.Objects;
import com.google.common.base.Preconditions;
import groovy.util.Node;
import org.gradle.internal.Cast;
import org.gradle.internal.xml.XmlTransformer;
import org.gradle.plugins.ide.internal.generator.XmlPersistableConfigurationObject;
import javax.annotation.Nullable;
import java.util.Arrays;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import static com.google.common.base.Strings.isNullOrEmpty;
/**
* Represents the customizable elements of an iml (via XML hooks everything of the iml is customizable).
*/
public class Module extends XmlPersistableConfigurationObject {
public static final String INHERITED = "inherited";
private static final String CONTENT = "content";
private Path contentPath;
private Set<Path> sourceFolders = new LinkedHashSet<>();
private Set<Path> testSourceFolders = new LinkedHashSet<>();
private Set<Path> resourceFolders = new LinkedHashSet<>();
private Set<Path> testResourceFolders = new LinkedHashSet<>();
private Set<Path> generatedSourceFolders = new LinkedHashSet<>();
private Set<Path> excludeFolders = new LinkedHashSet<>();
private boolean inheritOutputDirs;
private Path outputDir;
private Path testOutputDir;
private Set<Dependency> dependencies = new LinkedHashSet<>();
private String jdkName;
private final PathFactory pathFactory;
private String languageLevel;
public Module(XmlTransformer withXmlActions, PathFactory pathFactory) {
super(withXmlActions);
this.pathFactory = pathFactory;
}
/**
* The directory for the content root of the module.
* Defaults to the project directory.
* If null, the directory containing the output file will be used.
*/
public Path getContentPath() {
return contentPath;
}
public void setContentPath(Path contentPath) {
this.contentPath = contentPath;
}
/**
* The directories containing the production sources.
* Must not be null.
*/
public Set<Path> getSourceFolders() {
return sourceFolders;
}
public void setSourceFolders(Set<Path> sourceFolders) {
this.sourceFolders = sourceFolders;
}
/**
* The directories containing the test sources.
* Must not be null.
*/
public Set<Path> getTestSourceFolders() {
return testSourceFolders;
}
public void setTestSourceFolders(Set<Path> testSourceFolders) {
this.testSourceFolders = testSourceFolders;
}
/**
* The directories containing resources.
* Must not be null.
* @since 4.7
*/
public Set<Path> getResourceFolders() {
return resourceFolders;
}
/**
* Sets the directories containing resources.
* @since 4.7
*/
public void setResourceFolders(Set<Path> resourceFolders) {
this.resourceFolders = resourceFolders;
}
/**
* The directories containing test resources.
* Must not be null.
* @since 4.7
*/
public Set<Path> getTestResourceFolders() {
return testResourceFolders;
}
/**
* Sets the directories containing test resources.
* @since 4.7
*/
public void setTestResourceFolders(Set<Path> testResourceFolders) {
this.testResourceFolders = testResourceFolders;
}
/**
* The directories containing generated the production sources.
* Must not be null.
*/
public Set<Path> getGeneratedSourceFolders() {
return generatedSourceFolders;
}
public void setGeneratedSourceFolders(Set<Path> generatedSourceFolders) {
this.generatedSourceFolders = generatedSourceFolders;
}
/**
* The directories to be excluded.
* Must not be null.
*/
public Set<Path> getExcludeFolders() {
return excludeFolders;
}
public void setExcludeFolders(Set<Path> excludeFolders) {
this.excludeFolders = excludeFolders;
}
/**
* If true, output directories for this module will be located below the output directory for the project;
* otherwise, {@link #outputDir} and {@link #testOutputDir} will take effect.
*/
public boolean isInheritOutputDirs() {
return inheritOutputDirs;
}
public void setInheritOutputDirs(boolean inheritOutputDirs) {
this.inheritOutputDirs = inheritOutputDirs;
}
/**
* The output directory for production classes.
* If {@code null}, no entry will be created.
*/
public Path getOutputDir() {
return outputDir;
}
public void setOutputDir(Path outputDir) {
this.outputDir = outputDir;
}
/**
* The output directory for test classes.
* If {@code null}, no entry will be created.
*/
public Path getTestOutputDir() {
return testOutputDir;
}
public void setTestOutputDir(Path testOutputDir) {
this.testOutputDir = testOutputDir;
}
/**
* The dependencies of this module.
* Must not be null.
*/
public Set<Dependency> getDependencies() {
return dependencies;
}
public void setDependencies(Set<Dependency> dependencies) {
this.dependencies = dependencies;
}
public String getJdkName() {
return jdkName;
}
public void setJdkName(String jdkName) {
this.jdkName = jdkName;
}
@Override
protected String getDefaultResourceName() {
return "defaultModule.xml";
}
protected Object configure(Path contentPath,
Set<Path> sourceFolders, Set<Path> testSourceFolders,
Set<Path> resourceFolders, Set<Path> testResourceFolders,
Set<Path> generatedSourceFolders,
Set<Path> excludeFolders,
Boolean inheritOutputDirs, Path outputDir, Path testOutputDir,
Set<Dependency> dependencies, String jdkName, String languageLevel) {
this.languageLevel = languageLevel;
this.contentPath = contentPath;
this.sourceFolders.addAll(sourceFolders);
this.testSourceFolders.addAll(testSourceFolders);
this.resourceFolders.addAll(resourceFolders);
this.testResourceFolders.addAll(testResourceFolders);
this.generatedSourceFolders.addAll(generatedSourceFolders);
this.excludeFolders.addAll(excludeFolders);
if (inheritOutputDirs != null) {
this.inheritOutputDirs = inheritOutputDirs;
}
if (outputDir != null) {
this.outputDir = outputDir;
}
if (testOutputDir != null) {
this.testOutputDir = testOutputDir;
}
this.dependencies = dependencies; // overwrite rather than append dependencies
if (!isNullOrEmpty(jdkName)) {
this.jdkName = jdkName;
} else {
this.jdkName = Module.INHERITED;
}
return this.jdkName;
}
@Override
protected void load(Node xml) {
readJdkFromXml();
readSourceAndExcludeFolderFromXml();
readInheritOutputDirsFromXml();
readOutputDirsFromXml();
readDependenciesFromXml();
}
@Override
protected void store(Node xml) {
addJdkToXml();
setContentURL();
removeSourceAndExcludeFolderFromXml();
addSourceAndExcludeFolderToXml();
writeInheritOutputDirsToXml();
writeSourceLanguageLevel();
addOutputDirsToXml();
removeDependenciesFromXml();
addDependenciesToXml();
}
private void readJdkFromXml() {
Node jdk = findFirstWithAttributeValue(findOrderEntries(), "type", "jdk");
jdkName = jdk != null ? (String) jdk.attribute("jdkName") : INHERITED;
}
private void readSourceAndExcludeFolderFromXml() {
for (Node sourceFolder : findSourceFolder()) {
String url = (String) sourceFolder.attribute("url");
String isTestSource = (String) sourceFolder.attribute("isTestSource");
if (isTestSource != null) {
if ("false".equals(isTestSource)) {
sourceFolders.add(pathFactory.path(url));
} else {
testSourceFolders.add(pathFactory.path(url));
}
}
if ("true".equals(sourceFolder.attribute("generated"))) {
generatedSourceFolders.add(pathFactory.path(url));
}
String type = (String) sourceFolder.attribute("type");
if ("java-resource".equals(type)) {
resourceFolders.add(pathFactory.path(url));
} else if ("java-test-resource".equals(type)) {
testResourceFolders.add(pathFactory.path(url));
}
}
for (Node excludeFolder : findExcludeFolder()) {
excludeFolders.add(pathFactory.path((String) excludeFolder.attribute("url")));
}
}
private boolean readInheritOutputDirsFromXml() {
return inheritOutputDirs = "true".equals(getNewModuleRootManager().attribute("inherit-compiler-output"));
}
private Path readOutputDirsFromXml() {
Node outputDirNode = findOutputDir();
Node testOutputDirNode = findTestOutputDir();
String outputDirUrl = outputDirNode != null ? (String) outputDirNode.attribute("url") : null;
String testOutputDirUrl = testOutputDirNode != null ? (String) testOutputDirNode.attribute("url") : null;
outputDir = outputDirUrl != null ? pathFactory.path(outputDirUrl) : null;
return testOutputDir = testOutputDirUrl != null ? pathFactory.path(testOutputDirUrl) : null;
}
private void readDependenciesFromXml() {
for (Node orderEntry : findOrderEntries()) {
Object orderEntryType = orderEntry.attribute("type");
if ("module-library".equals(orderEntryType)) {
Set<Path> classes = new LinkedHashSet<>();
Set<Path> javadoc = new LinkedHashSet<>();
Set<Path> sources = new LinkedHashSet<>();
Set<JarDirectory> jarDirectories = new LinkedHashSet<>();
for (Node library : getChildren(orderEntry, "library")) {
for (Node classesNode : getChildren(library, "CLASSES")) {
readDependenciesPathsFromXml(classes, classesNode);
}
for (Node javadocNode : getChildren(library, "JAVADOC")) {
readDependenciesPathsFromXml(javadoc, javadocNode);
}
for (Node sourcesNode : getChildren(library, "SOURCES")) {
readDependenciesPathsFromXml(sources, sourcesNode);
}
for (Node jarDirNode : getChildren(library, "jarDirectory")) {
jarDirectories.add(new JarDirectory(pathFactory.path((String) jarDirNode.attribute("url")), Boolean.parseBoolean((String) jarDirNode.attribute("recursive"))));
}
}
ModuleLibrary moduleLibrary = new ModuleLibrary(classes, javadoc, sources, jarDirectories, (String) orderEntry.attribute("scope"));
dependencies.add(moduleLibrary);
} else if ("module".equals(orderEntryType)) {
dependencies.add(new ModuleDependency((String) orderEntry.attribute("module-name"), (String) orderEntry.attribute("scope")));
}
}
}
private void readDependenciesPathsFromXml(Set<Path> paths, Node node) {
for (Node classesRoot : getChildren(node, "root")) {
paths.add(pathFactory.path((String) classesRoot.attribute("url")));
}
}
private void addJdkToXml() {
Preconditions.checkNotNull(jdkName);
List<Node> orderEntries = findOrderEntries();
Node moduleJdk = findFirstWithAttributeValue(orderEntries, "type", "jdk");
Node moduleRootManager = getNewModuleRootManager();
if (!jdkName.equals(INHERITED)) {
Node inheritedJdk = findFirstWithAttributeValue(orderEntries, "type", "inheritedJdk");
if (inheritedJdk != null) {
inheritedJdk.parent().remove(inheritedJdk);
}
if (moduleJdk != null) {
moduleRootManager.remove(moduleJdk);
}
Map<String, Object> attributes = new LinkedHashMap<>();
attributes.put("type", "jdk");
attributes.put("jdkName", jdkName);
attributes.put("jdkType", "JavaSDK");
moduleRootManager.appendNode("orderEntry", attributes);
} else if (findFirstWithAttributeValue(orderEntries, "type", "inheritedJdk") == null) {
if (moduleJdk != null) {
moduleRootManager.remove(moduleJdk);
}
Map<String, Object> attributes = new LinkedHashMap<>();
attributes.put("type", "inheritedJdk");
moduleRootManager.appendNode("orderEntry", attributes);
}
}
private void setContentURL() {
if (contentPath != null) {
setNodeAttribute(findOrCreateContentNode(), "url", contentPath.getUrl());
}
}
private void removeSourceAndExcludeFolderFromXml() {
Node content = findOrCreateContentNode();
for (Node sourceFolder : findSourceFolder()) {
content.remove(sourceFolder);
}
for (Node excludeFolder : findExcludeFolder()) {
content.remove(excludeFolder);
}
}
private void addSourceAndExcludeFolderToXml() {
Node content = findOrCreateContentNode();
for (Path path : sourceFolders) {
Map<String, Object> attributes = new LinkedHashMap<>();
attributes.put("url", path.getUrl());
attributes.put("isTestSource", "false");
if (generatedSourceFolders.contains(path)) {
attributes.put("generated", "true");
}
content.appendNode("sourceFolder", attributes);
}
for (Path path : testSourceFolders) {
Map<String, Object> attributes = new LinkedHashMap<>();
attributes.put("url", path.getUrl());
attributes.put("isTestSource", "true");
if (generatedSourceFolders.contains(path)) {
attributes.put("generated", "true");
}
content.appendNode("sourceFolder", attributes);
}
for (Path path : resourceFolders) {
if (sourceFolders.contains(path)) {
continue;
}
Map<String, Object> attributes = new LinkedHashMap<>();
attributes.put("url", path.getUrl());
attributes.put("type", "java-resource");
if (generatedSourceFolders.contains(path)) {
attributes.put("generated", "true");
}
content.appendNode("sourceFolder", attributes);
}
for (Path path : testResourceFolders) {
if (testSourceFolders.contains(path)) {
continue;
}
Map<String, Object> attributes = new LinkedHashMap<>();
attributes.put("url", path.getUrl());
attributes.put("type", "java-test-resource");
if (generatedSourceFolders.contains(path)) {
attributes.put("generated", "true");
}
content.appendNode("sourceFolder", attributes);
}
for (Path path : excludeFolders) {
Map<String, Object> attributes = new LinkedHashMap<>();
attributes.put("url", path.getUrl());
content.appendNode("excludeFolder", attributes);
}
}
private void writeInheritOutputDirsToXml() {
setNodeAttribute(getNewModuleRootManager(), "inherit-compiler-output", inheritOutputDirs);
}
private void writeSourceLanguageLevel() {
if (languageLevel != null) {
setNodeAttribute(getNewModuleRootManager(), "LANGUAGE_LEVEL", languageLevel);
}
}
private void addOutputDirsToXml() {
if (outputDir != null) {
setNodeAttribute(findOrCreateOutputDir(), "url", outputDir.getUrl());
}
if (testOutputDir != null) {
setNodeAttribute(findOrCreateTestOutputDir(), "url", testOutputDir.getUrl());
}
}
private void removeDependenciesFromXml() {
Node moduleRoot = getNewModuleRootManager();
for (Node orderEntry : findOrderEntries()) {
if (isDependencyOrderEntry(orderEntry)) {
moduleRoot.remove(orderEntry);
}
}
}
protected boolean isDependencyOrderEntry(Object orderEntry) {
return Arrays.asList("module-library", "module").contains((String) ((Node) orderEntry).attribute("type"));
}
private void addDependenciesToXml() {
Node moduleRoot = getNewModuleRootManager();
for (Dependency dependency : dependencies) {
dependency.addToNode(moduleRoot);
}
}
private Node getNewModuleRootManager() {
Node newModuleRootManager = findFirstWithAttributeValue(getChildren(getXml(), "component"), "name", "NewModuleRootManager");
Preconditions.checkNotNull(newModuleRootManager);
return newModuleRootManager;
}
private Node findOrCreateOutputDir() {
Node outputDirNode = findOutputDir();
if (outputDirNode != null) {
return outputDirNode;
}
return getNewModuleRootManager().appendNode("output");
}
private Node findOrCreateTestOutputDir() {
Node testOutputDirNode = findTestOutputDir();
if (testOutputDirNode != null) {
return testOutputDirNode;
}
return getNewModuleRootManager().appendNode("output-test");
}
private Node findOrCreateContentNode() {
Node newModuleRootManager = getNewModuleRootManager();
Node contentNode = findFirstChildNamed(newModuleRootManager, CONTENT);
if (contentNode != null) {
return contentNode;
}
return newModuleRootManager.appendNode(CONTENT);
}
private List<Node> findSourceFolder() {
return getChildren(findOrCreateContentNode(), "sourceFolder");
}
private List<Node> findExcludeFolder() {
return getChildren(findOrCreateContentNode(), "excludeFolder");
}
@Nullable
private Node findOutputDir() {
return findFirstChildNamed(getNewModuleRootManager(), "output");
}
@Nullable
private Node findTestOutputDir() {
return findFirstChildNamed(getNewModuleRootManager(), "output-test");
}
private List<Node> findOrderEntries() {
return getChildren(getNewModuleRootManager(), "orderEntry");
}
private static void setNodeAttribute(Node node, String key, Object value) {
final Map<String, Object> attributes = Cast.uncheckedCast(node.attributes());
attributes.put(key, value);
}
@Override
public String toString() {
return "Module{"
+ "dependencies=" + dependencies
+ ", sourceFolders=" + sourceFolders
+ ", testSourceFolders=" + testSourceFolders
+ ", resourceFolders=" + resourceFolders
+ ", testResourceFolders=" + testResourceFolders
+ ", generatedSourceFolders=" + generatedSourceFolders
+ ", excludeFolders=" + excludeFolders
+ ", inheritOutputDirs=" + inheritOutputDirs
+ ", jdkName=" + jdkName
+ ", outputDir=" + outputDir
+ ", testOutputDir=" + testOutputDir + "}";
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (!getClass().equals(o.getClass())) {
return false;
}
Module module = (Module) o;
return Objects.equal(dependencies, module.dependencies)
&& Objects.equal(excludeFolders, module.excludeFolders)
&& Objects.equal(outputDir, module.outputDir)
&& Objects.equal(sourceFolders, module.sourceFolders)
&& Objects.equal(generatedSourceFolders, module.generatedSourceFolders)
&& Objects.equal(jdkName, module.jdkName)
&& Objects.equal(testOutputDir, module.testOutputDir)
&& Objects.equal(testSourceFolders, module.testSourceFolders)
&& Objects.equal(resourceFolders, module.resourceFolders)
&& Objects.equal(testResourceFolders, module.testResourceFolders);
}
@Override
public int hashCode() {
return Objects.hashCode(sourceFolders,
generatedSourceFolders,
testSourceFolders,
resourceFolders,
testResourceFolders,
excludeFolders,
inheritOutputDirs,
jdkName,
outputDir,
testOutputDir,
dependencies);
}
}