File: remove-JavadocTaglet.patch

package info (click to toggle)
ditaa 0.10%2Bds1-1.2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, buster
  • size: 1,260 kB
  • sloc: java: 7,503; xml: 1,647; jsp: 164; makefile: 24
file content (345 lines) | stat: -rw-r--r-- 10,961 bytes parent folder | download | duplicates (2)
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
From: Markus Koschany <apo@debian.org>
Date: Wed, 13 Jun 2018 22:58:25 +0200
Subject: remove JavadocTaglet

Remove JavadocTaglet class because the Taglet class has been removed in
Java 10.

Bug-Debian: https://bugs.debian.org/897494
---
 .../ascii2image/core/JavadocTaglet.java            | 326 ---------------------
 1 file changed, 326 deletions(-)
 delete mode 100644 src/org/stathissideris/ascii2image/core/JavadocTaglet.java

diff --git a/src/org/stathissideris/ascii2image/core/JavadocTaglet.java b/src/org/stathissideris/ascii2image/core/JavadocTaglet.java
deleted file mode 100644
index f1642ef..0000000
--- a/src/org/stathissideris/ascii2image/core/JavadocTaglet.java
+++ /dev/null
@@ -1,326 +0,0 @@
-/* 
- * Text Diagram Taglet 
- *
- * Copyright (C) 2006 Nordic Growth Market NGM AB,
- * Mikael Brannstrom. 
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * 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., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
- *
- */
-package org.stathissideris.ascii2image.core;
-
-import com.sun.javadoc.ProgramElementDoc;
-import com.sun.javadoc.Tag;
-import com.sun.tools.doclets.Taglet;
-import com.sun.tools.doclets.internal.toolkit.Configuration;
-import com.sun.tools.doclets.standard.Standard;
-import java.awt.image.RenderedImage;
-import java.io.File;
-import java.io.IOException;
-import java.io.UnsupportedEncodingException;
-import java.lang.reflect.Field;
-import java.lang.reflect.Method;
-import java.util.Map;
-import java.util.regex.Pattern;
-import javax.imageio.ImageIO;
-
-import org.stathissideris.ascii2image.text.TextGrid;
-import org.stathissideris.ascii2image.graphics.Diagram;
-import org.stathissideris.ascii2image.core.ConversionOptions;
-import org.stathissideris.ascii2image.graphics.BitmapRenderer;
-
-/** This class is a custom Javadoc taglet for embedding ditaa diagrams in
- * javadoc comments. The tag is an inline which can be used in any javadoc
- * comment. The tag can also be used in package documentation and in the 
- * overview.
- * This taglet assumes that the Standard Javadoc Doclet is being used.
- * <p>
- * The syntax is:<br>
- * <code>
- * &#123;<b>@textdiagram</b> <i>diagram_name</i><br>
- * <i>the ascii art diagram</i><br>
- * &#125;
- * </code>
- * <p>
- * The diagram name will be used when generating the image, so that the image 
- * can be referenced to somewhere else (by using an a-href HTML tag). The 
- * diagram name can only contain letters, numbers and underscore. The name of 
- * the generated image will become "&lt;classname&gt;-&lt;diagram name&gt;.png". 
- * <p>
- * The syntax for the ditaa diagram is described at 
- * <a href="http://ditaa.sourceforge.net/">http://ditaa.sourceforge.net/</a>. 
- * <p>
- * <b>Note:</b> The overview file needs to be named "overview.html" if it lies
- * in the source path, otherwise it is sufficient that it ends with ".html". 
- *
- * @author Mikael Brannstrom
- */
-public class JavadocTaglet implements Taglet {
-
-	private static final String NAME = "textdiagram";
-	private static final Pattern FIGURE_NAME_PATTERN = Pattern.compile("\\w+");
-
-	private final File[] srcPath;
-	private final File dstDir;
-
-	private final boolean simpleMode;
-
-	/** Creates a new instance of TextDiagramTaglet */
-	public JavadocTaglet() {
-
-		String configSourcepath = null;
-		String configDestDirName = null;
-		// Try to get configuration
-		try {
-			// Do this: Configuration config = Standard.htmlDoclet.configuration();
-			Field htmlDocletField = Standard.class.getField("htmlDoclet");
-			Object htmlDoclet = htmlDocletField.get(null); // static field
-			Method configurationMethod = htmlDoclet.getClass().getMethod("configuration", null);
-			Object config = configurationMethod.invoke(htmlDoclet, null);
-			// Do this: configSourcepath = config.sourcepath;
-			Field sourcepathField = config.getClass().getField("sourcepath"); 
-			configSourcepath = (String)sourcepathField.get(config);
-			// Do this: configDestDirName = config.destDirName;
-			Field destDirNameField = config.getClass().getField("destDirName");
-			configDestDirName = (String)destDirNameField.get(config);
-		} catch(Exception e) {
-			warning("Could not setup taglet. Falling back to simple mode.\n"+e);
-		}
-
-		if(configDestDirName == null) {
-			srcPath = null;
-			dstDir = null;
-			simpleMode = true;
-		} else {
-			// setup srcPath
-			String[] srcPathStr = configSourcepath.split("[;:]");
-			srcPath = new File[srcPathStr.length];
-			for(int i=0; i<srcPath.length; i++) {
-				srcPath[i] = new File(srcPathStr[i]).getAbsoluteFile();
-				try {
-					srcPath[i] = srcPath[i].getCanonicalFile();
-				} catch (IOException ex) {
-					warning("Could not get canonical path of file: "+srcPath[i]);
-				}
-			}            
-			// setup dstDir
-			dstDir = new File(configDestDirName);
-
-			simpleMode = false;
-		}
-	}
-
-	public boolean inField() {
-		return false; // inline tag
-	}
-
-	public boolean inConstructor() {
-		return false; // inline tag
-	}
-
-	public boolean inMethod() {
-		return false; // inline tag
-	}
-
-	public boolean inOverview() {
-		return false; // inline tag
-	}
-
-	public boolean inPackage() {
-		return false; // inline tag
-	}
-
-	public boolean inType() {
-		return false; // inline tag
-	}
-
-	/** This tag is an inline tag. */
-	public boolean isInlineTag() {
-		return true;
-	}
-
-	public String getName() {
-		return NAME;
-	}
-
-	/** Generates the diagram image and returns an img html tag that references
-	 * to the image.
-	 */
-	public String toString(Tag tag) {
-		String text = tag.text().trim();
-		String figureName, figureText;
-		int i1=text.indexOf(" "), i2=text.indexOf("\n");
-		if(i1 == -1 && -2 == -1) {
-			return "<!-- Empty "+getName()+" tag -->";
-		}
-
-		int i;
-		if(i1 == -1 || i1 == -1)
-			i = Math.max(i1, i2);
-		else
-			i = Math.min(i1, i2);
-
-		figureName = text.substring(0, i);
-		figureText = text.substring(i+1);
-
-		if(!FIGURE_NAME_PATTERN.matcher(figureName).matches()) {
-			error("Illegal "+getName()+" name: \""+figureName+"\"");
-		}
-
-		// Convert [d] to {d} where d can be 1 character and more
-		figureText = figureText.replaceAll("\\[(\\w+)\\]", "{$1}");
-
-		if(simpleMode) {
-			StringBuffer strBuf = new StringBuffer();
-			strBuf.append("<pre>");
-			strBuf.append(figureText);
-			strBuf.append("</pre>");
-			return strBuf.toString();
-		} else {
-			File outputFile = getOutputFile(tag.position().file(), figureName);
-			generateImage(figureText, outputFile);
-
-			StringBuffer strBuf = new StringBuffer();
-			strBuf.append("<img src=\"");
-			strBuf.append(outputFile.getName());
-			strBuf.append("\" alt=\"");
-			strBuf.append(figureName);
-			strBuf.append("\"/>");
-			return strBuf.toString();
-		}
-	}
-
-	/** Returns null since this is an inline tag.
-	 */
-	public String toString(Tag[] tag) {
-		return null; // should return null, this is an inline tag
-	}
-
-	/** Returns the path of the output file given
-	 * the source file and the diagram name.
-	 * @param srcFile the source file which contains the tag
-	 * @param name the diagram name that will be used for generating the output
-	 * filename.
-	 */
-	private File getOutputFile(File srcFile, String name) {
-		String relPath = getRelativePath(srcFile);
-
-		// Special hack for the overview file
-		if(srcFile.getName().toLowerCase().equals("overview.html") ||
-				(relPath == null && srcFile.getName().toLowerCase().endsWith(".html"))) {
-			relPath = "overview";
-		}
-
-		if(relPath == null) {
-			error("The file is not relative to the source path: "+srcFile);
-		}
-
-		// get the filename and dirname
-		String dirname=null, filename=null;
-		int i = relPath.lastIndexOf(File.separatorChar);
-		if(i == -1) {
-			filename = relPath;
-		} else if(i == 0) {
-			filename = relPath.substring(1);
-		} else {
-			filename = relPath.substring(i+1);
-			dirname = relPath.substring(0, i);
-		}
-
-		// skip file ending in filename
-		i = filename.lastIndexOf('.');
-		if(i != -1)
-			filename = filename.substring(0, i);
-
-		String path;
-		if(dirname == null) {
-			path = filename;
-		} else {
-			path = dirname+File.separator+filename;
-		}
-
-		return new File(dstDir, path+"-"+name+".png");
-	}
-
-	/** Returns the relative path of a (source) file.
-	 * The path is relative to one of the source dirs specified to the
-	 * standard doclet.
-	 * @returns the relative path. If a relative path could not be found
-	 * null is returned.
-	 */
-	private String getRelativePath(File file) {
-		file = file.getAbsoluteFile();
-		try {
-			file = file.getCanonicalFile();
-		} catch (IOException ex) {
-			warning("Could not get canonical path of file: "+file);
-		}
-		String filePath = file.getAbsolutePath();
-		for(int i=0; i<srcPath.length; i++) {
-			String s = srcPath[i].getAbsolutePath();
-			if(filePath.startsWith(s)) {
-				filePath = filePath.substring(s.length());
-				if(filePath.startsWith(File.separator))
-					filePath = filePath.substring(1);
-				return filePath;
-			}
-		}
-		return null;
-	}
-
-	/** Generates the image from the specified text to the output file.
-	 * @param text the ascii art text.
-	 * @param outputFile the file name of the image that is generated.
-	 */
-	private void generateImage(String text, File outputFile) {
-		ConversionOptions options = new ConversionOptions();
-		TextGrid textGrid = new TextGrid();
-		try {
-			if(!textGrid.initialiseWithText(text, null)) {
-				error("Cannot initialize text grid");
-			}
-		} catch (UnsupportedEncodingException e1) {
-			error("Cannot initialize text grid");
-		}
-		Diagram diagram = new Diagram(textGrid, options);
-		RenderedImage image = new BitmapRenderer().renderToImage(diagram,
-				options.renderingOptions);
-
-		try {
-			ImageIO.write(image, "png", outputFile);
-		} catch (IOException e) {
-			error("Cannot write to file "+outputFile.getAbsolutePath());
-		}
-	}
-
-	/** Prints an error message and exits. */
-	private void error(String msg) {
-		System.err.println("Error: "+msg);
-		System.exit(1);
-	}
-
-	/** Prints a warning message. */
-	private void warning(String msg) {
-		System.err.println("Warning: "+msg);
-	}
-
-	/** Register this Taglet.
-	 * @param tagletMap the map to register this tag to.
-	 */
-	public static void register(Map tagletMap) {
-		JavadocTaglet taglet = new JavadocTaglet();
-		tagletMap.put(taglet.getName(), taglet);
-	}
-}