annotate dwtx/jface/resource/AbstractResourceManager.d @ 9:6c14e54dfc11

completed /jface/resource/
author Frank Benoit <benoit@tionex.de>
date Sat, 29 Mar 2008 02:25:12 +0100
parents
children da5ad8eedf5d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
1 /*******************************************************************************
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
2 * Copyright (c) 2004, 2006 IBM Corporation and others.
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
3 * All rights reserved. This program and the accompanying materials
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
4 * are made available under the terms of the Eclipse Public License v1.0
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
5 * which accompanies this distribution, and is available at
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
6 * http://www.eclipse.org/legal/epl-v10.html
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
7 *
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
8 * Contributors:
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
9 * IBM Corporation - initial API and implementation
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
10 * Port to the D programming language:
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
11 * Frank Benoit <benoit@tionex.de>
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
12 *******************************************************************************/
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
13 module dwtx.jface.resource.AbstractResourceManager;
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
14
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
15 import dwtx.jface.resource.ResourceManager;
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
16 import dwtx.jface.resource.DeviceResourceDescriptor;
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
17
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
18 import tango.util.collection.HashMap;
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
19 import tango.util.collection.model.Map;
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
20
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21 import dwt.dwthelper.utils;
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 /**
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24 * Abstract implementation of ResourceManager. Maintains reference counts for all previously
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 * allocated DWT resources. Delegates to the abstract method allocate(...) the first time a resource
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26 * is referenced and delegates to the abstract method deallocate(...) the last time a reference is
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 * removed.
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28 *
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 * @since 3.1
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 */
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31 abstract class AbstractResourceManager : ResourceManager {
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 /**
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34 * Map of ResourceDescriptor onto RefCount. (null when empty)
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35 */
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36 private HashMap!(DeviceResourceDescriptor,RefCount) map = null;
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
37
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38 /**
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39 * Holds a reference count for a previously-allocated resource
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
40 */
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41 private static class RefCount {
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42 Object resource;
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
43 int count = 1;
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
44
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
45 this(Object resource) {
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
46 this.resource = resource;
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
47 }
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
48 }
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
49
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
50 /**
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
51 * Called the first time a resource is requested. Should allocate and return a resource
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
52 * of the correct type.
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
53 *
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
54 * @since 3.1
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
55 *
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
56 * @param descriptor identifier for the resource to allocate
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
57 * @return the newly allocated resource
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
58 * @throws DeviceResourceException Thrown when allocation of an DWT device resource fails
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
59 */
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
60 protected abstract Object allocate(DeviceResourceDescriptor descriptor);
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
61
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
62 /**
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
63 * Called the last time a resource is dereferenced. Should release any resources reserved by
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
64 * allocate(...).
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
65 *
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
66 * @since 3.1
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
67 *
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
68 * @param resource resource being deallocated
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
69 * @param descriptor identifier for the resource
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
70 */
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
71 protected abstract void deallocate(Object resource, DeviceResourceDescriptor descriptor);
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
72
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
73 /* (non-Javadoc)
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
74 * @see ResourceManager#create(DeviceResourceDescriptor)
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
75 */
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
76 public final Object create(DeviceResourceDescriptor descriptor){
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
77
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
78 // Lazily allocate the map
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
79 if (map is null) {
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
80 map = new HashMap!(DeviceResourceDescriptor,RefCount);
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
81 }
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
82
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
83 // Get the current reference count
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
84 RefCount count = map.get(descriptor);
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
85 if (count !is null) {
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
86 // If this resource already exists, increment the reference count and return
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
87 // the existing resource.
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
88 count.count++;
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
89 return count.resource;
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
90 }
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
91
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
92 // Allocate and return a new resource (with ref count = 1)
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
93 Object resource = allocate(descriptor);
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
94
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
95 count = new RefCount(resource);
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
96 map.add(descriptor, count);
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
97
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
98 return resource;
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
99 }
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
100
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
101 /* (non-Javadoc)
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
102 * @see ResourceManager#destroy(DeviceResourceDescriptor)
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
103 */
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
104 public final void destroy(DeviceResourceDescriptor descriptor) {
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
105 // If the map is empty (null) then there are no resources to dispose
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
106 if (map is null) {
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
107 return;
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
108 }
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
109
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
110 // Find the existing resource
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
111 RefCount count = map.get(descriptor);
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
112 if (count !is null) {
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
113 // If the resource exists, decrement the reference count.
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
114 count.count--;
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
115 if (count.count is 0) {
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
116 // If this was the last reference, deallocate it.
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
117 deallocate(count.resource, descriptor);
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
118 map.removeKey(descriptor);
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
119 }
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
120 }
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
121
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
122 // Null out the map when empty to save a small amount of memory
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
123 if (map.drained()) {
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
124 map = null;
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
125 }
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
126 }
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
127
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
128 /**
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
129 * Deallocates any resources allocated by this registry that have not yet been
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
130 * deallocated.
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
131 *
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
132 * @since 3.1
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
133 */
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
134 public void dispose() {
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
135 super.dispose();
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
136
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
137 if (map is null) {
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
138 return;
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
139 }
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
140
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
141 foreach( key, val; map ){
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
142 deallocate(val.resource, key);
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
143 }
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
144
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
145 map = null;
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
146 }
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
147
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
148 /* (non-Javadoc)
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
149 * @see dwtx.jface.resource.ResourceManager#find(dwtx.jface.resource.DeviceResourceDescriptor)
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
150 */
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
151 public Object find(DeviceResourceDescriptor descriptor) {
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
152 if (map is null) {
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
153 return null;
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
154 }
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
155 RefCount refCount = cast(RefCount)map.get(descriptor);
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
156 if (refCount is null)
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
157 return null;
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
158 return refCount.resource;
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
159 }
6c14e54dfc11 completed /jface/resource/
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
160 }