1 /*******************************************************************************
2  * Copyright (c) 2007, 2020 IBM Corporation and others.
3  *
4  * This program and the accompanying materials
5  * are made available under the terms of the Eclipse Public License 2.0
6  * which accompanies this distribution, and is available at
7  * https://www.eclipse.org/legal/epl-2.0/
8  *
9  * SPDX-License-Identifier: EPL-2.0
10  *
11  * Contributors:
12  *     IBM Corporation - initial API and implementation
13  *******************************************************************************/
14 package org.eclipse.swt.tools.internal;
15 
16 import java.io.*;
17 
18 import org.eclipse.swt.*;
19 import org.eclipse.swt.graphics.*;
20 import org.eclipse.swt.widgets.*;
21 
22 /**
23  * Instructions on how to use the Sleak tool with a standlaone SWT example:
24  *
25  * Modify the main method below to launch your application.
26  * Run Sleak.
27  *
28  */
29 public class Sleak {
30 	List list;
31 	Canvas canvas;
32 	Button snapshot, diff, stackTrace, saveAs, save;
33 	Text text;
34 	Label label;
35 
36 	String filterPath = "";
37 	String fileName = "sleakout";
38 	String selectedName = null;
39 	boolean incrementFileNames = true;
40 	boolean saveImages = true;
41 	int fileCount = 0;
42 
43 	Object [] oldObjects = new Object [0];
44 	Error [] oldErrors = new Error [0];
45 	Object [] objects = new Object [0];
46 	Error [] errors = new Error [0];
47 
main(String [] args)48 public static void main (String [] args) {
49 	DeviceData data = new DeviceData();
50 	data.tracking = true;
51 	Display display = new Display (data);
52 	Sleak sleak = new Sleak ();
53 	Shell shell = new Shell(display);
54 	shell.setText ("S-Leak");
55 	Point size = shell.getSize ();
56 	shell.setSize (size.x / 2, size.y / 2);
57 	sleak.create (shell);
58 	shell.open();
59 
60 	// Launch your application here
61 	// e.g.
62 //	Shell shell = new Shell(display);
63 //	Button button1 = new Button(shell, SWT.PUSH);
64 //	button1.setBounds(10, 10, 100, 50);
65 //	button1.setText("Hello World");
66 //	Image image = new Image(display, 20, 20);
67 //	Button button2 = new Button(shell, SWT.PUSH);
68 //	button2.setBounds(10, 70, 100, 50);
69 //	button2.setImage(image);
70 //	shell.open();
71 
72 	while (!shell.isDisposed ()) {
73 		if (!display.readAndDispatch ()) display.sleep ();
74 	}
75 	display.dispose ();
76 }
77 
create(Composite parent)78 public void create (Composite parent) {
79 	list = new List (parent, SWT.BORDER | SWT.V_SCROLL);
80 	list.addListener (SWT.Selection, event -> refreshObject ());
81 	text = new Text (parent, SWT.BORDER | SWT.H_SCROLL | SWT.V_SCROLL);
82 	canvas = new Canvas (parent, SWT.BORDER);
83 	canvas.addListener (SWT.Paint, event -> paintCanvas (event));
84 	stackTrace = new Button (parent, SWT.CHECK);
85 	stackTrace.setText ("Stack");
86 	stackTrace.addListener (SWT.Selection, e -> toggleStackTrace ());
87 	snapshot = new Button (parent, SWT.PUSH);
88 	snapshot.setText ("Snap");
89 	snapshot.addListener (SWT.Selection, event -> refreshAll ());
90 	diff = new Button (parent, SWT.PUSH);
91 	diff.setText ("Diff");
92 	diff.addListener (SWT.Selection, event -> refreshDifference ());
93 	label = new Label (parent, SWT.BORDER);
94 	label.setText ("0 object(s)");
95 	saveAs = new Button (parent, SWT.PUSH);
96 	saveAs.setText ("Save As...");
97 	saveAs.setToolTipText("Saves the contents of the list to a file, optionally with the stack traces if selected.");
98 	saveAs.addListener (SWT.Selection, event -> saveToFile (true));
99 	save = new Button (parent, SWT.PUSH);
100 	save.setText ("Save");
101 	save.setToolTipText("Saves to the previously selected file.");
102 	save.addListener (SWT.Selection, event -> saveToFile (false));
103 	parent.addListener (SWT.Resize, e -> layout ());
104 	stackTrace.setSelection (false);
105 	text.setVisible (false);
106 	layout();
107 }
108 
refreshLabel()109 void refreshLabel () {
110 	int colors = 0, cursors = 0, fonts = 0, gcs = 0, images = 0;
111 	int paths = 0, patterns = 0, regions = 0, textLayouts = 0, transforms= 0;
112 	for (Object object : objects) {
113 		if (object instanceof Color) colors++;
114 		if (object instanceof Cursor) cursors++;
115 		if (object instanceof Font) fonts++;
116 		if (object instanceof GC) gcs++;
117 		if (object instanceof Image) images++;
118 		if (object instanceof Path) paths++;
119 		if (object instanceof Pattern) patterns++;
120 		if (object instanceof Region) regions++;
121 		if (object instanceof TextLayout) textLayouts++;
122 		if (object instanceof Transform) transforms++;
123 	}
124 	String string = "";
125 	if (colors != 0) string += colors + " Color(s)\n";
126 	if (cursors != 0) string += cursors + " Cursor(s)\n";
127 	if (fonts != 0) string += fonts + " Font(s)\n";
128 	if (gcs != 0) string += gcs + " GC(s)\n";
129 	if (images != 0) string += images + " Image(s)\n";
130 	if (paths != 0) string += paths + " Paths(s)\n";
131 	if (patterns != 0) string += patterns + " Pattern(s)\n";
132 	if (regions != 0) string += regions + " Region(s)\n";
133 	if (textLayouts != 0) string += textLayouts + " TextLayout(s)\n";
134 	if (transforms != 0) string += transforms + " Transform(s)\n";
135 	if (string.length () != 0) {
136 		string = string.substring (0, string.length () - 1);
137 	}
138 	label.setText (string);
139 }
140 
refreshDifference()141 void refreshDifference () {
142 	Display display = canvas.getDisplay();
143 	DeviceData info = display.getDeviceData ();
144 	if (!info.tracking) {
145 		Shell shell = canvas.getShell();
146 		MessageBox dialog = new MessageBox (shell, SWT.ICON_WARNING | SWT.OK);
147 		dialog.setText (shell.getText ());
148 		dialog.setMessage ("Warning: Device is not tracking resource allocation");
149 		dialog.open ();
150 	}
151 	Object [] newObjects = info.objects;
152 	Error [] newErrors = info.errors;
153 	Object [] diffObjects = new Object [newObjects.length];
154 	Error [] diffErrors = new Error [newErrors.length];
155 	int count = 0;
156 	for (int i=0; i<newObjects.length; i++) {
157 		int index = 0;
158 		while (index < oldObjects.length) {
159 			if (newObjects [i] == oldObjects [index]) break;
160 			index++;
161 		}
162 		if (index == oldObjects.length) {
163 			diffObjects [count] = newObjects [i];
164 			diffErrors [count] = newErrors [i];
165 			count++;
166 		}
167 	}
168 	objects = new Object [count];
169 	errors = new Error [count];
170 	System.arraycopy (diffObjects, 0, objects, 0, count);
171 	System.arraycopy (diffErrors, 0, errors, 0, count);
172 	list.removeAll ();
173 	text.setText ("");
174 	canvas.redraw ();
175 	for (Object object : objects) {
176 		list.add (object.toString());
177 	}
178 	refreshLabel ();
179 	layout ();
180 }
181 
saveToFile(boolean prompt)182 private void saveToFile(boolean prompt) {
183 	if (prompt || selectedName == null) {
184 		FileDialog dialog = new FileDialog(saveAs.getShell(), SWT.SAVE);
185 		dialog.setFilterPath(filterPath);
186 		dialog.setFileName(fileName);
187 		dialog.setOverwrite(true);
188 		selectedName = dialog.open();
189 		fileCount = 0;
190 		if (selectedName == null) {
191 			return;
192 		}
193 		filterPath = dialog.getFilterPath();
194 		fileName = dialog.getFileName();
195 
196 		MessageBox msg = new MessageBox(saveAs.getShell(), SWT.ICON_QUESTION | SWT.YES | SWT.NO);
197 		msg.setText("Append incrementing file counter?");
198 		msg.setMessage("Append an incrementing file count to the file name on each save, starting at 000?");
199 		incrementFileNames = msg.open() == SWT.YES;
200 
201 		msg = new MessageBox(saveAs.getShell(), SWT.ICON_QUESTION | SWT.YES | SWT.NO);
202 		msg.setText("Save images for each resource?");
203 		msg.setMessage("Save an image (png) for each resource?");
204 		saveImages = msg.open() == SWT.YES;
205 	}
206 
207 	String fileName = selectedName;
208 	if (incrementFileNames) {
209 		fileName = String.format("%s_%03d", fileName, fileCount++);
210 	}
211 	try (PrintWriter file = new PrintWriter(new FileOutputStream(fileName))) {
212 
213 		for (int i = 0; i < errors.length; i++) {
214 			Object object = objects[i];
215 			Error error = errors[i];
216 			file.print(object.toString());
217 			if (saveImages) {
218 				String suffix = String.format("%05d.png", i);
219 				String pngName = String.format("%s_%s", fileName, suffix);
220 				Image image = new Image(saveAs.getDisplay(), 100, 100);
221 				try {
222 					GC gc = new GC(image);
223 					try {
224 						draw(gc, object);
225 					} finally {
226 						gc.dispose();
227 					}
228 					ImageLoader loader = new ImageLoader();
229 					loader.data = new ImageData[] { image.getImageData() };
230 					loader.save(pngName, SWT.IMAGE_PNG);
231 				} finally {
232 					image.dispose();
233 				}
234 
235 				file.print(" -> ");
236 				file.print(suffix);
237 			}
238 			file.println();
239 			if (stackTrace.getSelection()) {
240 				error.printStackTrace(file);
241 				System.out.println();
242 			}
243 		}
244 	} catch (IOException e1) {
245 		MessageBox msg = new MessageBox(saveAs.getShell(), SWT.ICON_ERROR | SWT.OK);
246 		msg.setText("Failed to save");
247 		msg.setMessage("Failed to save S-Leak file.\n" + e1.getMessage());
248 		msg.open();
249 	}
250 }
251 
toggleStackTrace()252 void toggleStackTrace () {
253 	refreshObject ();
254 	layout ();
255 }
256 
paintCanvas(Event event)257 void paintCanvas (Event event) {
258 	canvas.setCursor (null);
259 	int index = list.getSelectionIndex ();
260 	if (index == -1) return;
261 	GC gc = event.gc;
262 	Object object = objects [index];
263 	draw(gc, object);
264 }
265 
draw(GC gc, Object object)266 void draw(GC gc, Object object) {
267 	if (object instanceof Color) {
268 		if (((Color)object).isDisposed ()) return;
269 		gc.setBackground ((Color) object);
270 		gc.fillRectangle (canvas.getClientArea());
271 		return;
272 	}
273 	if (object instanceof Cursor) {
274 		if (((Cursor)object).isDisposed ()) return;
275 		canvas.setCursor ((Cursor) object);
276 		return;
277 	}
278 	if (object instanceof Font) {
279 		if (((Font)object).isDisposed ()) return;
280 		gc.setFont ((Font) object);
281 		String string = "";
282 		String lf = text.getLineDelimiter ();
283 		for (FontData data : gc.getFont ().getFontData ()) {
284 			String style = "NORMAL";
285 			int bits = data.getStyle ();
286 			if (bits != 0) {
287 				if ((bits & SWT.BOLD) != 0) style = "BOLD ";
288 				if ((bits & SWT.ITALIC) != 0) style += "ITALIC";
289 			}
290 			string += data.getName () + " " + data.getHeight () + " " + style + lf;
291 		}
292 		gc.drawString (string, 0, 0);
293 		return;
294 	}
295 	//NOTHING TO DRAW FOR GC
296 //	if (object instanceof GC) {
297 //		return;
298 //	}
299 	if (object instanceof Image) {
300 		if (((Image)object).isDisposed ()) return;
301 		gc.drawImage ((Image) object, 0, 0);
302 		return;
303 	}
304 	if (object instanceof Path) {
305 		if (((Path)object).isDisposed ()) return;
306 		gc.drawPath ((Path) object);
307 		return;
308 	}
309 	if (object instanceof Pattern) {
310 		if (((Pattern)object).isDisposed ()) return;
311 		gc.setBackgroundPattern ((Pattern)object);
312 		gc.fillRectangle (canvas.getClientArea ());
313 		gc.setBackgroundPattern (null);
314 		return;
315 	}
316 	if (object instanceof Region) {
317 		if (((Region)object).isDisposed ()) return;
318 		String string = ((Region)object).getBounds().toString();
319 		gc.drawString (string, 0, 0);
320 		return;
321 	}
322 	if (object instanceof TextLayout) {
323 		if (((TextLayout)object).isDisposed ()) return;
324 		((TextLayout)object).draw (gc, 0, 0);
325 		return;
326 	}
327 	if (object instanceof Transform) {
328 		if (((Transform)object).isDisposed ()) return;
329 		String string = ((Transform)object).toString();
330 		gc.drawString (string, 0, 0);
331 		return;
332 	}
333 }
334 
refreshObject()335 void refreshObject () {
336 	int index = list.getSelectionIndex ();
337 	if (index == -1) return;
338 	if (stackTrace.getSelection ()) {
339 		ByteArrayOutputStream stream = new ByteArrayOutputStream ();
340 		PrintStream s = new PrintStream (stream);
341 		errors [index].printStackTrace (s);
342 		text.setText (stream.toString ());
343 		text.setVisible (true);
344 		canvas.setVisible (false);
345 	} else {
346 		canvas.setVisible (true);
347 		text.setVisible (false);
348 		canvas.redraw ();
349 	}
350 }
351 
refreshAll()352 void refreshAll () {
353 	oldObjects = new Object [0];
354 	oldErrors = new Error [0];
355 	refreshDifference ();
356 	oldObjects = objects;
357 	oldErrors = errors;
358 }
359 
layout()360 void layout () {
361 	Composite parent = canvas.getParent();
362 	Rectangle rect = parent.getClientArea ();
363 	int width = 0;
364 	String [] items = list.getItems ();
365 	GC gc = new GC (list);
366 	for (int i=0; i<objects.length; i++) {
367 		width = Math.max (width, gc.stringExtent (items [i]).x);
368 	}
369 	gc.dispose ();
370 	Point snapshotSize = snapshot.computeSize (SWT.DEFAULT, SWT.DEFAULT);
371 	Point diffSize = diff.computeSize (SWT.DEFAULT, SWT.DEFAULT);
372 	Point stackSize = stackTrace.computeSize (SWT.DEFAULT, SWT.DEFAULT);
373 	Point labelSize = label.computeSize (SWT.DEFAULT, SWT.DEFAULT);
374 	Point saveAsSize = saveAs.computeSize (SWT.DEFAULT, SWT.DEFAULT);
375 	Point saveSize = save.computeSize (SWT.DEFAULT, SWT.DEFAULT);
376 	width = Math.max (snapshotSize.x, Math.max (diffSize.x, Math.max (stackSize.x, width)));
377 	width = Math.max (saveAsSize.x, Math.max (saveSize.x, width));
378 	width = Math.max (labelSize.x, list.computeSize (width, SWT.DEFAULT).x);
379 	width = Math.max (64, width);
380 	snapshot.setBounds (0, 0, width, snapshotSize.y);
381 	diff.setBounds (0, snapshotSize.y, width, diffSize.y);
382 	stackTrace.setBounds (0, snapshotSize.y + diffSize.y, width, stackSize.y);
383 	label.setBounds (0, rect.height - saveSize.y - saveAsSize.y - labelSize.y, width, labelSize.y);
384 	saveAs.setBounds (0, rect.height - saveSize.y - saveAsSize.y, width, saveAsSize.y);
385 	save.setBounds (0, rect.height - saveSize.y, width, saveSize.y);
386 	int height = snapshotSize.y + diffSize.y + stackSize.y;
387 	list.setBounds (0, height, width, rect.height - height - labelSize.y - saveAsSize.y -saveSize.y);
388 	text.setBounds (width, 0, rect.width - width, rect.height);
389 	canvas.setBounds (width, 0, rect.width - width, rect.height);
390 }
391 
392 }
393