forked from processing/processing
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathToolContribution.java
More file actions
164 lines (125 loc) · 4.26 KB
/
Copy pathToolContribution.java
File metadata and controls
164 lines (125 loc) · 4.26 KB
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
/* -*- mode: java; c-basic-offset: 2; indent-tabs-mode: nil -*- */
/*
Part of the Processing project - http://processing.org
Copyright (c) 2013-15 The Processing Foundation
Copyright (c) 2011-12 Ben Fry and Casey Reas
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License version 2
as published by the Free Software Foundation.
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
*/
package processing.app.contrib;
import java.io.*;
import java.net.URLClassLoader;
import java.util.*;
import processing.app.Base;
import processing.app.Messages;
import processing.app.tools.Tool;
public class ToolContribution extends LocalContribution implements Tool, Comparable<ToolContribution> {
private Tool tool;
private File referenceFile; // shortname/reference/index.html
static public ToolContribution load(File folder) {
try {
return new ToolContribution(folder);
} catch (IgnorableException ig) {
Messages.log(ig.getMessage());
} catch (VerifyError ve) { // incompatible
// avoid the excessive error spew that happens here
} catch (NoClassDefFoundError ncdfe) {
if (ncdfe.getMessage().contains("processing/app/Editor")) {
System.err.println("The Editor class has moved to the processing.app.ui package in Processing 3");
}
} catch (Throwable e) { // unknown error
e.printStackTrace();
}
return null;
}
private ToolContribution(File folder) throws Throwable {
super(folder);
String className = initLoader(null);
if (className != null) {
Class<?> toolClass = loader.loadClass(className);
tool = (Tool) toolClass.newInstance();
}
referenceFile = new File(folder, "reference/index.html");
}
/**
* Method to close the ClassLoader so that the archives are no longer
* "locked" and a tool can be removed without restart.
*/
public void clearClassLoader() {
try {
((URLClassLoader) this.loader).close();
} catch (IOException e1) {
e1.printStackTrace();
}
}
// static protected List<File> discover(File folder) {
// File[] folders = listCandidates(folder, "tool");
// if (folders == null) {
// return new ArrayList<File>();
// } else {
// return Arrays.asList(folders);
// }
// }
static public List<ToolContribution> loadAll(File toolsFolder) {
File[] list = ContributionType.TOOL.listCandidates(toolsFolder);
ArrayList<ToolContribution> outgoing = new ArrayList<ToolContribution>();
// If toolsFolder does not exist or is inaccessible (stranger things have
// happened, and are reported as bugs) list will come back null.
if (list != null) {
for (File folder : list) {
try {
ToolContribution tc = load(folder);
if (tc != null) {
outgoing.add(tc);
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
Collections.sort(outgoing);
return outgoing;
}
public void init(Base base) {
tool.init(base);
}
public void run() {
tool.run();
}
public String getMenuTitle() {
return tool.getMenuTitle();
}
public ContributionType getType() {
return ContributionType.TOOL;
}
/**
* Returns the object stored in the referenceFile field, which contains an
* instance of the file object representing the index file of the reference
*
* @return referenceFile
*/
public File getReferenceIndexFile() {
return referenceFile;
}
/**
* Tests whether the reference's index file indicated by referenceFile exists.
*
* @return true if and only if the file denoted by referenceFile exists; false
* otherwise.
*/
public boolean hasReference() {
return referenceFile.exists();
}
@Override
public int compareTo(ToolContribution o) {
return getMenuTitle().compareTo(o.getMenuTitle());
}
}