Logo Search packages:      
Sourcecode: jinput version File versions  Download package

RawInputEnvironmentPlugin.java

/*
 * %W% %E%
 *
 * Copyright 2002 Sun Microsystems, Inc. All rights reserved.
 * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
 */
/*****************************************************************************
 * Copyright (c) 2003 Sun Microsystems, Inc.  All Rights Reserved.
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * - Redistribution of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 *
 * - Redistribution in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materails provided with the distribution.
 *
 * Neither the name Sun Microsystems, Inc. or the names of the contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * This software is provided "AS IS," without a warranty of any kind.
 * ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES, INCLUDING
 * ANY IMPLIED WARRANT OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR
 * NON-INFRINGEMEN, ARE HEREBY EXCLUDED.  SUN MICROSYSTEMS, INC. ("SUN") AND
 * ITS LICENSORS SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE AS
 * A RESULT OF USING, MODIFYING OR DESTRIBUTING THIS SOFTWARE OR ITS 
 * DERIVATIVES.  IN NO EVENT WILL SUN OR ITS LICENSORS BE LIABLE FOR ANY LOST
 * REVENUE, PROFIT OR DATA, OR FOR DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL,
 * INCIDENTAL OR PUNITIVE DAMAGES.  HOWEVER CAUSED AND REGARDLESS OF THE THEORY
 * OF LIABILITY, ARISING OUT OF THE USE OF OUR INABILITY TO USE THIS SOFTWARE,
 * EVEN IF SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
 *
 * You acknowledge that this software is not designed or intended for us in
 * the design, construction, operation or maintenance of any nuclear facility
 *
 *****************************************************************************/
package net.java.games.input;

import java.security.AccessController;
import java.security.PrivilegedAction;
import java.util.List;
import java.util.ArrayList;
import java.io.File;
import java.io.IOException;

import net.java.games.util.plugins.Plugin;

/** DirectInput implementation of controller environment
 * @author martak
 * @author elias
 * @version 1.0
 */
00055 public final class RawInputEnvironmentPlugin extends ControllerEnvironment implements Plugin {
      
      private static boolean supported = false;

      /**
       * Static utility method for loading native libraries.
       * It will try to load from either the path given by
       * the net.java.games.input.librarypath property
       * or through System.loadLibrary().
       * 
       */
00066       static void loadLibrary(final String lib_name) {
            AccessController.doPrivileged(
                        new PrivilegedAction() {
                              public final Object run() {
                                  try {
                                    String lib_path = System.getProperty("net.java.games.input.librarypath");
                                    if (lib_path != null)
                                          System.load(lib_path + File.separator + System.mapLibraryName(lib_name));
                                    else
                                          System.loadLibrary(lib_name);
                                  } catch (UnsatisfiedLinkError e) {
                                      e.printStackTrace();
                                      supported = false;
                                  }
                                    return null;
                              }
                        });
      }
    
      static String getPrivilegedProperty(final String property) {
             return (String)AccessController.doPrivileged(new PrivilegedAction() {
                      public Object run() {
                          return System.getProperty(property);
                      }
                  });
            }
            

      static String getPrivilegedProperty(final String property, final String default_value) {
       return (String)AccessController.doPrivileged(new PrivilegedAction() {
                public Object run() {
                    return System.getProperty(property, default_value);
                }
            });
      }
            
      static {
            String osName = getPrivilegedProperty("os.name", "").trim();
            if(osName.startsWith("Windows")) {
                  supported = true;
                  if("x86".equals(getPrivilegedProperty("os.arch"))) {
                        loadLibrary("jinput-raw");
                  } else {
                        loadLibrary("jinput-raw_64");
                  }
            }
      }

    private final Controller[] controllers;

      /** Creates new DirectInputEnvironment */
00117       public RawInputEnvironmentPlugin() {
            RawInputEventQueue queue;
            Controller[] controllers = new Controller[]{};
            if(isSupported()) {
                  try {
                        queue = new RawInputEventQueue();
                        controllers = enumControllers(queue);
                  } catch (IOException e) {
                        logln("Failed to enumerate devices: " + e.getMessage());
                  }
            }
            this.controllers = controllers;
      }

00131       public final Controller[] getControllers() {
            return controllers;
      }

      private final static SetupAPIDevice lookupSetupAPIDevice(String device_name, List setupapi_devices) {
            /* First, replace # with / in the device name, since that
             * seems to be the format in raw input device name
             */
            device_name = device_name.replaceAll("#", "\\\\").toUpperCase();
            for (int i = 0; i < setupapi_devices.size(); i++) {
                  SetupAPIDevice device = (SetupAPIDevice)setupapi_devices.get(i);
                  if (device_name.indexOf(device.getInstanceId().toUpperCase()) != -1)
                        return device;
            }
            return null;
      }
      
      private final static void createControllersFromDevices(RawInputEventQueue queue, List controllers, List devices, List setupapi_devices) throws IOException {
            List active_devices = new ArrayList();
            for (int i = 0; i < devices.size(); i++) {
                  RawDevice device = (RawDevice)devices.get(i);
                  SetupAPIDevice setupapi_device = lookupSetupAPIDevice(device.getName(), setupapi_devices);
                  if (setupapi_device == null) {
                        /* Either the device is an RDP or we failed to locate the
                         * SetupAPI device that matches
                         */
                        continue;
                  }
                  RawDeviceInfo info = device.getInfo();
                  Controller controller = info.createControllerFromDevice(device, setupapi_device);
                  if (controller != null) {
                        controllers.add(controller);
                        active_devices.add(device);
                  }
            }
            queue.start(active_devices);
      }

      private final static native void enumerateDevices(RawInputEventQueue queue, List devices) throws IOException;

      private final Controller[] enumControllers(RawInputEventQueue queue) throws IOException {
            List controllers = new ArrayList();
            List devices = new ArrayList();
            enumerateDevices(queue, devices);
            List setupapi_devices = enumSetupAPIDevices();
            createControllersFromDevices(queue, controllers, devices, setupapi_devices);
            Controller[] controllers_array = new Controller[controllers.size()];
            controllers.toArray(controllers_array);
            return controllers_array;
      }

00182       public boolean isSupported() {
            return supported;
      }

      /*
       * The raw input API, while being able to access
       * multiple mice and keyboards, is a bit raw (hah)
       * since it lacks some important features:
       *
       * 1. The list of keyboards and the list of mice
       *    both include useless Terminal Server
       *    devices (RDP_MOU and RDP_KEY) that we'd
       *    like to skip.
       * 2. The device names returned by GetRawInputDeviceInfo()
       *    are not for display, but instead synthesized
       *    from a combination of a device instance id
       *    and a GUID.
       *
       * A solution to both problems is the SetupAPI that allows
       * us to enumerate all keyboard and mouse devices and fetch their
       * descriptive names and at the same time filter out the unwanted
       * RDP devices.
       */
      private final static List enumSetupAPIDevices() throws IOException {
            List devices = new ArrayList();
            nEnumSetupAPIDevices(getKeyboardClassGUID(), devices);
            nEnumSetupAPIDevices(getMouseClassGUID(), devices);
            return devices;
      }
      private final static native void nEnumSetupAPIDevices(byte[] guid, List devices) throws IOException;

      private final static native byte[] getKeyboardClassGUID();
      private final static native byte[] getMouseClassGUID();

} // class DirectInputEnvironment

Generated by  Doxygen 1.6.0   Back to index