annotate dwtx/jface/resource/FileImageDescriptor.d @ 4:c87617952847

some JFace modules
author Frank Benoit <benoit@tionex.de>
date Fri, 28 Mar 2008 17:08:33 +0100
parents
children c884a1ab6db3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
1 /*******************************************************************************
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
2 * Copyright (c) 2000, 2006 IBM Corporation and others.
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
3 * All rights reserved. This program and the accompanying materials
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
4 * are made available under the terms of the Eclipse Public License v1.0
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
5 * which accompanies this distribution, and is available at
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
6 * http://www.eclipse.org/legal/epl-v10.html
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
7 *
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
8 * Contributors:
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
9 * IBM Corporation - initial API and implementation
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
10 * Port to the D programming language:
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
11 * Frank Benoit <benoit@tionex.de>
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
12 *******************************************************************************/
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
13 module dwtx.jface.resource.FileImageDescriptor;
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
14
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
15 import dwtx.jface.resource.ImageDescriptor;
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
16
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
17 // import java.io.BufferedInputStream;
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
18 // import java.io.FileInputStream;
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
19 // import java.io.FileNotFoundException;
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
20 // import java.io.IOException;
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21 // import java.io.InputStream;
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 import dwt.DWT;
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24 import dwt.DWTException;
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 import dwt.graphics.ImageData;
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 import dwt.dwthelper.utils;
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28 import dwt.dwthelper.InputStream;
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 import dwt.dwthelper.FileInputStream;
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 import dwt.dwthelper.BufferedInputStream;
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32 /**
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 * An image descriptor that loads its image information
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34 * from a file.
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35 */
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36 class FileImageDescriptor : ImageDescriptor {
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
37
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38 /**
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39 * The class whose resource directory contain the file,
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
40 * or <code>null</code> if none.
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41 */
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42 private ClassInfo location;
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
43
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
44 /**
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
45 * The name of the file.
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
46 */
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
47 private String name;
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
48
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
49 /**
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
50 * Creates a new file image descriptor.
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
51 * The file has the given file name and is located
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
52 * in the given class's resource directory. If the given
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
53 * class is <code>null</code>, the file name must be absolute.
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
54 * <p>
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
55 * Note that the file is not accessed until its
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
56 * <code>getImageDate</code> method is called.
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
57 * </p>
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
58 *
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
59 * @param clazz class for resource directory, or
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
60 * <code>null</code>
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
61 * @param filename the name of the file
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
62 */
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
63 this(ClassInfo clazz, String filename) {
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
64 this.location = clazz;
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
65 this.name = filename;
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
66 }
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
67
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
68 /* (non-Javadoc)
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
69 * Method declared on Object.
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
70 */
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
71 public bool equals(Object o) {
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
72 if (!( cast(FileImageDescriptor)o )) {
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
73 return false;
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
74 }
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
75 FileImageDescriptor other = cast(FileImageDescriptor) o;
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
76 if (location !is null) {
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
77 if ( location.name != other.location.name ) {
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
78 return false;
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
79 }
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
80 } else {
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
81 if (other.location !is null) {
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
82 return false;
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
83 }
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
84 }
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
85 return name == other.name;
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
86 }
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
87
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
88 /* (non-Javadoc)
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
89 * Method declared on ImageDesciptor.
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
90 * Returns null if the image data cannot be read.
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
91 */
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
92 public ImageData getImageData() {
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
93 InputStream in_ = getStream();
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
94 ImageData result = null;
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
95 if (in_ !is null) {
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
96 try {
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
97 result = new ImageData(in_);
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
98 } catch (DWTException e) {
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
99 if (e.code !is DWT.ERROR_INVALID_IMAGE) {
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
100 throw e;
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
101 // fall through otherwise
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
102 }
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
103 } finally {
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
104 in_.close();
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
105 }
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
106 }
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
107 return result;
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
108 }
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
109
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
110 /**
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
111 * Returns a stream on the image contents. Returns
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
112 * null if a stream could not be opened.
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
113 *
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
114 * @return the buffered stream on the file or <code>null</code>
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
115 * if the file cannot be found
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
116 */
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
117 private InputStream getStream() {
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
118 InputStream is_ = null;
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
119
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
120 if (location !is null) {
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
121 is_ = ClassInfoGetResourceAsStream( location, name);
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
122
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
123 } else {
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
124 try {
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
125 is_ = new FileInputStream(name);
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
126 } catch (/+FileNotFoundException+/ IOException e) {
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
127 return null;
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
128 }
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
129 }
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
130 if (is_ is null) {
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
131 return null;
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
132 } else {
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
133 return new BufferedInputStream(is_);
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
134 }
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
135 }
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
136
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
137 /* (non-Javadoc)
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
138 * Method declared on Object.
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
139 */
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
140 public override hash_t toHash() {
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
141 int code = dwt.dwthelper.utils.toHash(name);
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
142 if (location !is null) {
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
143 code += location.toHash();
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
144 }
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
145 return code;
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
146 }
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
147
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
148 /* (non-Javadoc)
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
149 * Method declared on Object.
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
150 */
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
151 /**
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
152 * The <code>FileImageDescriptor</code> implementation of this <code>Object</code> method
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
153 * returns a string representation of this object which is suitable only for debugging.
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
154 */
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
155 public override String toString() {
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
156 return "FileImageDescriptor(location=" ~ location.toString() ~ ", name=" ~ name ~ ")";//$NON-NLS-3$//$NON-NLS-2$//$NON-NLS-1$
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
157 }
c87617952847 some JFace modules
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
158 }