annotate dwt/graphics/Resource.d @ 333:684eed7589a0

Generate error if a resource is deleted without disposal. Without that, is is very hard to find accidental deleted/scoped Color/Font/..
author Frank Benoit <benoit@tionex.de>
date Tue, 10 Feb 2009 17:14:24 +0100
parents fd9c62a2998e
children c49e17d48b76
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
174
f906dbcacee5 Minor changes to be more compatible to dwt-linux, formatting in toString, Display.DEBUG=true
Frank Benoit <benoit@tionex.de>
parents: 14
diff changeset
1 /*******************************************************************************
246
fd9c62a2998e Updater SWT 3.4M7 to 3.4
Frank Benoit <benoit@tionex.de>
parents: 213
diff changeset
2 * Copyright (c) 2000, 2008 IBM Corporation and others.
14
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
3 * All rights reserved. This program and the accompanying materials
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
4 * are made available under the terms of the Eclipse Public License v1.0
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
5 * which accompanies this distribution, and is available at
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
6 * http://www.eclipse.org/legal/epl-v10.html
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
7 *
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
8 * Contributors:
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
9 * IBM Corporation - initial API and implementation
174
f906dbcacee5 Minor changes to be more compatible to dwt-linux, formatting in toString, Display.DEBUG=true
Frank Benoit <benoit@tionex.de>
parents: 14
diff changeset
10 * Port to the D programming language:
f906dbcacee5 Minor changes to be more compatible to dwt-linux, formatting in toString, Display.DEBUG=true
Frank Benoit <benoit@tionex.de>
parents: 14
diff changeset
11 * Frank Benoit <benoit@tionex.de>
14
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
12 *******************************************************************************/
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
13 module dwt.graphics.Resource;
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
14
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
15 import dwt.DWT;
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
16 import dwt.graphics.Device;
333
684eed7589a0 Generate error if a resource is deleted without disposal. Without that, is is very hard to find accidental deleted/scoped Color/Font/..
Frank Benoit <benoit@tionex.de>
parents: 246
diff changeset
17 //import tango.util.log.Trace;
14
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
18
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
19 /**
174
f906dbcacee5 Minor changes to be more compatible to dwt-linux, formatting in toString, Display.DEBUG=true
Frank Benoit <benoit@tionex.de>
parents: 14
diff changeset
20 * This class is the abstract superclass of all graphics resource objects.
14
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21 * Resources created by the application must be disposed.
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22 * <p>
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 * IMPORTANT: This class is intended to be subclassed <em>only</em>
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24 * within the DWT implementation. However, it has not been marked
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 * final to allow those outside of the DWT development team to implement
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26 * patched versions of the class in order to get around specific
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 * limitations in advance of when those limitations can be addressed
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28 * by the team. Any class built using subclassing to access the internals
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 * of this class will likely fail to compile or run between releases and
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 * may be strongly platform specific. Subclassing should not be attempted
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31 * without an intimate and detailed understanding of the workings of the
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32 * hierarchy. No support is provided for user-written classes which are
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 * implemented as subclasses of this class.
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34 * </p>
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35 *
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36 * @see #dispose
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
37 * @see #isDisposed
246
fd9c62a2998e Updater SWT 3.4M7 to 3.4
Frank Benoit <benoit@tionex.de>
parents: 213
diff changeset
38 * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>
174
f906dbcacee5 Minor changes to be more compatible to dwt-linux, formatting in toString, Display.DEBUG=true
Frank Benoit <benoit@tionex.de>
parents: 14
diff changeset
39 *
14
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
40 * @since 3.1
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41 */
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42 public abstract class Resource {
174
f906dbcacee5 Minor changes to be more compatible to dwt-linux, formatting in toString, Display.DEBUG=true
Frank Benoit <benoit@tionex.de>
parents: 14
diff changeset
43
14
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
44 /**
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
45 * the device where this resource was created
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
46 */
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
47 Device device;
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
48
246
fd9c62a2998e Updater SWT 3.4M7 to 3.4
Frank Benoit <benoit@tionex.de>
parents: 213
diff changeset
49 public this() {
213
36f5cb12e1a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 174
diff changeset
50 }
36f5cb12e1a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 174
diff changeset
51
36f5cb12e1a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 174
diff changeset
52 this(Device device) {
36f5cb12e1a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 174
diff changeset
53 if (device is null) device = Device.getDevice();
36f5cb12e1a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 174
diff changeset
54 if (device is null) DWT.error(DWT.ERROR_NULL_ARGUMENT);
36f5cb12e1a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 174
diff changeset
55 this.device = device;
36f5cb12e1a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 174
diff changeset
56 }
36f5cb12e1a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 174
diff changeset
57
333
684eed7589a0 Generate error if a resource is deleted without disposal. Without that, is is very hard to find accidental deleted/scoped Color/Font/..
Frank Benoit <benoit@tionex.de>
parents: 246
diff changeset
58 ~this(){
684eed7589a0 Generate error if a resource is deleted without disposal. Without that, is is very hard to find accidental deleted/scoped Color/Font/..
Frank Benoit <benoit@tionex.de>
parents: 246
diff changeset
59 if( !isDisposed ){
684eed7589a0 Generate error if a resource is deleted without disposal. Without that, is is very hard to find accidental deleted/scoped Color/Font/..
Frank Benoit <benoit@tionex.de>
parents: 246
diff changeset
60 //Trace.formatln("{} {} {} Resource deleted, but is not yet disposed", __FILE__, __LINE__, this.classinfo.name );
684eed7589a0 Generate error if a resource is deleted without disposal. Without that, is is very hard to find accidental deleted/scoped Color/Font/..
Frank Benoit <benoit@tionex.de>
parents: 246
diff changeset
61 DWT.error( 0, null, " Resource deleted, but is not yet disposed: (" ~ this.classinfo.name ~ ")" );
684eed7589a0 Generate error if a resource is deleted without disposal. Without that, is is very hard to find accidental deleted/scoped Color/Font/..
Frank Benoit <benoit@tionex.de>
parents: 246
diff changeset
62 }
684eed7589a0 Generate error if a resource is deleted without disposal. Without that, is is very hard to find accidental deleted/scoped Color/Font/..
Frank Benoit <benoit@tionex.de>
parents: 246
diff changeset
63 }
684eed7589a0 Generate error if a resource is deleted without disposal. Without that, is is very hard to find accidental deleted/scoped Color/Font/..
Frank Benoit <benoit@tionex.de>
parents: 246
diff changeset
64
213
36f5cb12e1a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 174
diff changeset
65 void destroy() {
36f5cb12e1a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 174
diff changeset
66 }
36f5cb12e1a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 174
diff changeset
67
14
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
68 /**
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
69 * Disposes of the operating system resources associated with
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
70 * this resource. Applications must dispose of all resources
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
71 * which they allocate.
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
72 */
213
36f5cb12e1a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 174
diff changeset
73 public void dispose() {
36f5cb12e1a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 174
diff changeset
74 if (device is null) return;
36f5cb12e1a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 174
diff changeset
75 if (device.isDisposed()) return;
36f5cb12e1a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 174
diff changeset
76 destroy();
36f5cb12e1a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 174
diff changeset
77 if (device.tracking) device.dispose_Object(this);
36f5cb12e1a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 174
diff changeset
78 device = null;
36f5cb12e1a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 174
diff changeset
79 }
14
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
80
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
81 /**
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
82 * Returns the <code>Device</code> where this resource was
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
83 * created.
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
84 *
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
85 * @return <code>Device</code> the device of the receiver
174
f906dbcacee5 Minor changes to be more compatible to dwt-linux, formatting in toString, Display.DEBUG=true
Frank Benoit <benoit@tionex.de>
parents: 14
diff changeset
86 *
14
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
87 * @since 3.2
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
88 */
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
89 public Device getDevice() {
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
90 Device device = this.device;
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
91 if (device is null || isDisposed ()) DWT.error (DWT.ERROR_GRAPHIC_DISPOSED);
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
92 return device;
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
93 }
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
94
213
36f5cb12e1a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 174
diff changeset
95 void init_() {
36f5cb12e1a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 174
diff changeset
96 if (device.tracking) device.new_Object(this);
36f5cb12e1a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 174
diff changeset
97 }
36f5cb12e1a2 Update to SWT 3.4M7
Frank Benoit <benoit@tionex.de>
parents: 174
diff changeset
98
14
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
99 /**
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
100 * Returns <code>true</code> if the resource has been disposed,
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
101 * and <code>false</code> otherwise.
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
102 * <p>
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
103 * This method gets the dispose state for the resource.
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
104 * When a resource has been disposed, it is an error to
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
105 * invoke any other method using the resource.
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
106 *
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
107 * @return <code>true</code> when the resource is disposed and <code>false</code> otherwise
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
108 */
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
109 public abstract bool isDisposed();
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
110
d3cfc7ee5c52 Resource, Device as proto
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
111 }