| /******************************************************************************* |
| * Copyright (c) 2000, 2006 IBM Corporation and others. |
| * All rights reserved. This program and the accompanying materials |
| * are made available under the terms of the Eclipse Public License v1.0 |
| * which accompanies this distribution, and is available at |
| * http://www.eclipse.org/legal/epl-v10.html |
| * |
| * Contributors: |
| * IBM Corporation - initial API and implementation |
| *******************************************************************************/ |
| package org.eclipse.swt.program; |
| |
| |
| import org.eclipse.swt.internal.*; |
| import org.eclipse.swt.internal.win32.*; |
| import org.eclipse.swt.*; |
| import org.eclipse.swt.graphics.*; |
| |
| import java.io.IOException; |
| |
| /** |
| * Instances of this class represent programs and |
| * their associated file extensions in the operating |
| * system. |
| */ |
| public final class Program { |
| String name; |
| String command; |
| String iconName; |
| |
| /** |
| * Prevents uninitialized instances from being created outside the package. |
| */ |
| Program () { |
| } |
| |
| /** |
| * Finds the program that is associated with an extension. |
| * The extension may or may not begin with a '.'. Note that |
| * a <code>Display</code> must already exist to guarantee that |
| * this method returns an appropriate result. |
| * |
| * @param extension the program extension |
| * @return the program or <code>null</code> |
| * |
| * @exception IllegalArgumentException <ul> |
| * <li>ERROR_NULL_ARGUMENT when extension is null</li> |
| * </ul> |
| */ |
| public static Program findProgram (String extension) { |
| if (extension == null) SWT.error (SWT.ERROR_NULL_ARGUMENT); |
| if (extension.length () == 0) return null; |
| if (extension.charAt (0) != '.') extension = "." + extension; //$NON-NLS-1$ |
| /* Use the character encoding for the default locale */ |
| TCHAR key = new TCHAR (0, extension, true); |
| int [] phkResult = new int [1]; |
| if (OS.RegOpenKeyEx (OS.HKEY_CLASSES_ROOT, key, 0, OS.KEY_READ, phkResult) != 0) { |
| return null; |
| } |
| Program program = null; |
| int [] lpcbData = new int [1]; |
| int result = OS.RegQueryValueEx (phkResult [0], null, 0, null, (TCHAR) null, lpcbData); |
| if (result == 0) { |
| TCHAR lpData = new TCHAR (0, lpcbData [0] / TCHAR.sizeof); |
| result = OS.RegQueryValueEx (phkResult [0], null, 0, null, lpData, lpcbData); |
| if (result == 0) program = getProgram (lpData.toString (0, lpData.strlen ())); |
| } |
| OS.RegCloseKey (phkResult [0]); |
| return program; |
| } |
| |
| /** |
| * Answer all program extensions in the operating system. Note |
| * that a <code>Display</code> must already exist to guarantee |
| * that this method returns an appropriate result. |
| * |
| * @return an array of extensions |
| */ |
| public static String [] getExtensions () { |
| String [] extensions = new String [1024]; |
| /* Use the character encoding for the default locale */ |
| TCHAR lpName = new TCHAR (0, 1024); |
| int [] lpcName = new int [] {lpName.length ()}; |
| FILETIME ft = new FILETIME (); |
| int dwIndex = 0, count = 0; |
| while (OS.RegEnumKeyEx (OS.HKEY_CLASSES_ROOT, dwIndex, lpName, lpcName, null, null, null, ft) != OS.ERROR_NO_MORE_ITEMS) { |
| String extension = lpName.toString (0, lpcName [0]); |
| lpcName [0] = lpName.length (); |
| if (extension.length () > 0 && extension.charAt (0) == '.') { |
| if (count == extensions.length) { |
| String [] newExtensions = new String [extensions.length + 1024]; |
| System.arraycopy (extensions, 0, newExtensions, 0, extensions.length); |
| extensions = newExtensions; |
| } |
| extensions [count++] = extension; |
| } |
| dwIndex++; |
| } |
| if (count != extensions.length) { |
| String [] newExtension = new String [count]; |
| System.arraycopy (extensions, 0, newExtension, 0, count); |
| extensions = newExtension; |
| } |
| return extensions; |
| } |
| |
| static String getKeyValue (String string, boolean expand) { |
| /* Use the character encoding for the default locale */ |
| TCHAR key = new TCHAR (0, string, true); |
| int [] phkResult = new int [1]; |
| if (OS.RegOpenKeyEx (OS.HKEY_CLASSES_ROOT, key, 0, OS.KEY_READ, phkResult) != 0) { |
| return null; |
| } |
| String result = null; |
| int [] lpcbData = new int [1]; |
| if (OS.RegQueryValueEx (phkResult [0], (TCHAR) null, 0, null, (TCHAR) null, lpcbData) == 0) { |
| result = ""; |
| int length = lpcbData [0] / TCHAR.sizeof; |
| if (length != 0) { |
| /* Use the character encoding for the default locale */ |
| TCHAR lpData = new TCHAR (0, length); |
| if (OS.RegQueryValueEx (phkResult [0], null, 0, null, lpData, lpcbData) == 0) { |
| if (!OS.IsWinCE && expand) { |
| length = OS.ExpandEnvironmentStrings (lpData, null, 0); |
| if (length != 0) { |
| TCHAR lpDst = new TCHAR (0, length); |
| OS.ExpandEnvironmentStrings (lpData, lpDst, length); |
| result = lpDst.toString (0, Math.max (0, length - 1)); |
| } |
| } else { |
| length = Math.max (0, lpData.length () - 1); |
| result = lpData.toString (0, length); |
| } |
| } |
| } |
| } |
| if (phkResult [0] != 0) OS.RegCloseKey (phkResult [0]); |
| return result; |
| } |
| |
| static Program getProgram (String key) { |
| |
| /* Name */ |
| String name = getKeyValue (key, false); |
| if (name == null || name.length () == 0) { |
| name = key; |
| } |
| |
| /* Command */ |
| String DEFAULT_COMMAND = "\\shell"; //$NON-NLS-1$ |
| String defaultCommand = getKeyValue (key + DEFAULT_COMMAND, true); |
| if (defaultCommand == null || defaultCommand.length() == 0) defaultCommand = "open"; //$NON-NLS-1$ |
| String COMMAND = "\\shell\\" + defaultCommand + "\\command"; //$NON-NLS-1$ |
| String command = getKeyValue (key + COMMAND, true); |
| if (command == null || command.length () == 0) return null; |
| |
| /* Icon */ |
| String DEFAULT_ICON = "\\DefaultIcon"; //$NON-NLS-1$ |
| String iconName = getKeyValue (key + DEFAULT_ICON, true); |
| if (iconName == null) iconName = ""; //$NON-NLS-1$ |
| |
| Program program = new Program (); |
| program.name = name; |
| program.command = command; |
| program.iconName = iconName; |
| return program; |
| } |
| |
| /** |
| * Answers all available programs in the operating system. Note |
| * that a <code>Display</code> must already exist to guarantee |
| * that this method returns an appropriate result. |
| * |
| * @return an array of programs |
| */ |
| public static Program [] getPrograms () { |
| Program [] programs = new Program [1024]; |
| /* Use the character encoding for the default locale */ |
| TCHAR lpName = new TCHAR (0, 1024); |
| int [] lpcName = new int [] {lpName.length ()}; |
| FILETIME ft = new FILETIME (); |
| int dwIndex = 0, count = 0; |
| while (OS.RegEnumKeyEx (OS.HKEY_CLASSES_ROOT, dwIndex, lpName, lpcName, null, null, null, ft) != OS.ERROR_NO_MORE_ITEMS) { |
| String path = lpName.toString (0, lpcName [0]); |
| lpcName [0] = lpName.length (); |
| Program program = getProgram (path); |
| if (program != null) { |
| if (count == programs.length) { |
| Program [] newPrograms = new Program [programs.length + 1024]; |
| System.arraycopy (programs, 0, newPrograms, 0, programs.length); |
| programs = newPrograms; |
| } |
| programs [count++] = program; |
| } |
| dwIndex++; |
| } |
| if (count != programs.length) { |
| Program [] newPrograms = new Program [count]; |
| System.arraycopy (programs, 0, newPrograms, 0, count); |
| programs = newPrograms; |
| } |
| return programs; |
| } |
| |
| /** |
| * Launches the executable associated with the file in |
| * the operating system. If the file is an executable, |
| * then the executable is launched. Note that a <code>Display</code> |
| * must already exist to guarantee that this method returns |
| * an appropriate result. |
| * |
| * @param fileName the file or program name |
| * @return <code>true</code> if the file is launched, otherwise <code>false</code> |
| * |
| * @exception IllegalArgumentException <ul> |
| * <li>ERROR_NULL_ARGUMENT when fileName is null</li> |
| * </ul> |
| */ |
| public static boolean launch (String fileName) { |
| if (fileName == null) SWT.error (SWT.ERROR_NULL_ARGUMENT); |
| |
| /* Use the character encoding for the default locale */ |
| int hHeap = OS.GetProcessHeap (); |
| TCHAR buffer = new TCHAR (0, fileName, true); |
| int byteCount = buffer.length () * TCHAR.sizeof; |
| int lpFile = OS.HeapAlloc (hHeap, OS.HEAP_ZERO_MEMORY, byteCount); |
| OS.MoveMemory (lpFile, buffer, byteCount); |
| SHELLEXECUTEINFO info = new SHELLEXECUTEINFO (); |
| info.cbSize = SHELLEXECUTEINFO.sizeof; |
| info.lpFile = lpFile; |
| info.nShow = OS.SW_SHOW; |
| boolean result = OS.ShellExecuteEx (info); |
| if (lpFile != 0) OS.HeapFree (hHeap, 0, lpFile); |
| return result; |
| } |
| |
| /** |
| * Executes the program with the file as the single argument |
| * in the operating system. It is the responsibility of the |
| * programmer to ensure that the file contains valid data for |
| * this program. |
| * |
| * @param fileName the file or program name |
| * @return <code>true</code> if the file is launched, otherwise <code>false</code> |
| * |
| * @exception IllegalArgumentException <ul> |
| * <li>ERROR_NULL_ARGUMENT when fileName is null</li> |
| * </ul> |
| */ |
| public boolean execute (String fileName) { |
| if (fileName == null) SWT.error (SWT.ERROR_NULL_ARGUMENT); |
| boolean quote = true; |
| String prefix = command, suffix = ""; //$NON-NLS-1$ |
| int index = command.indexOf ("%1"); //$NON-NLS-1$ |
| if (index != -1) { |
| int count=0; |
| int i=index + 2, length = command.length (); |
| while (i < length) { |
| if (command.charAt (i) == '"') count++; |
| i++; |
| } |
| quote = count % 2 == 0; |
| prefix = command.substring (0, index); |
| suffix = command.substring (index + 2, length); |
| } |
| if (quote) fileName = " \"" + fileName + "\""; //$NON-NLS-1$ //$NON-NLS-2$ |
| try { |
| Compatibility.exec(prefix + fileName + suffix); |
| } catch (IOException e) { |
| return false; |
| } |
| return true; |
| } |
| |
| /** |
| * Returns the receiver's image data. This is the icon |
| * that is associated with the receiver in the operating |
| * system. |
| * |
| * @return the image data for the program, may be null |
| */ |
| public ImageData getImageData () { |
| int nIconIndex = 0; |
| String fileName = iconName; |
| int index = iconName.indexOf (','); |
| if (index != -1) { |
| fileName = iconName.substring (0, index); |
| String iconIndex = iconName.substring (index + 1, iconName.length ()).trim (); |
| try { |
| nIconIndex = Integer.parseInt (iconIndex); |
| } catch (NumberFormatException e) {} |
| } |
| /* Use the character encoding for the default locale */ |
| TCHAR lpszFile = new TCHAR (0, fileName, true); |
| int [] phiconSmall = new int[1], phiconLarge = null; |
| OS.ExtractIconEx (lpszFile, nIconIndex, phiconLarge, phiconSmall, 1); |
| if (phiconSmall [0] == 0) return null; |
| Image image = Image.win32_new (null, SWT.ICON, phiconSmall[0]); |
| ImageData imageData = image.getImageData (); |
| image.dispose (); |
| return imageData; |
| } |
| |
| /** |
| * Returns the receiver's name. This is as short and |
| * descriptive a name as possible for the program. If |
| * the program has no descriptive name, this string may |
| * be the executable name, path or empty. |
| * |
| * @return the name of the program |
| */ |
| public String getName () { |
| return name; |
| } |
| |
| /** |
| * Compares the argument to the receiver, and returns true |
| * if they represent the <em>same</em> object using a class |
| * specific comparison. |
| * |
| * @param other the object to compare with this object |
| * @return <code>true</code> if the object is the same as this object and <code>false</code> otherwise |
| * |
| * @see #hashCode() |
| */ |
| public boolean equals(Object other) { |
| if (this == other) return true; |
| if (other instanceof Program) { |
| final Program program = (Program) other; |
| return name.equals(program.name) && command.equals(program.command) |
| && iconName.equals(program.iconName); |
| } |
| return false; |
| } |
| |
| /** |
| * Returns an integer hash code for the receiver. Any two |
| * objects that return <code>true</code> when passed to |
| * <code>equals</code> must return the same value for this |
| * method. |
| * |
| * @return the receiver's hash |
| * |
| * @see #equals(Object) |
| */ |
| public int hashCode() { |
| return name.hashCode() ^ command.hashCode() ^ iconName.hashCode(); |
| } |
| |
| /** |
| * Returns a string containing a concise, human-readable |
| * description of the receiver. |
| * |
| * @return a string representation of the program |
| */ |
| public String toString () { |
| return "Program {" + name + "}"; //$NON-NLS-1$ //$NON-NLS-2$ |
| } |
| |
| } |