di-diagnostics.h

Go to the documentation of this file.

/*
 * di-diagnostics.h
 *
 * Copyright (C) 2010  Thomas A. Vaughan
 * All rights reserved.
 *
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the <organization> nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THOMAS A. VAUGHAN ''AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THOMAS A. VAUGHAN BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *
 * Diagnostic routines for DirectInput.  Meant for internal use of this library
 * only.  Clients of the library should just use the SourceDevice interface.
 */

#ifndef GAMEPAD_DI_DIAGNOSTICS_H__
#define GAMEPAD_DI_DIAGNOSTICS_H__

// includes --------------------------------------------------------------------
#include "wave-windows/wave-windows.h"

#include <dinput.h>     // Microsoft DirectInput headers


namespace gamepad {


// NOTE: what follows are helper methods for dealing with DirectInput APIs.
//   These are mostly diagnostics and clients of this library shouldn't need
//   to use these directly.  They are exposed so test code can use them.

/// helper method to inspect Windows DirectInput error codes
void checkDIError(IN HRESULT hr) throw();

#define DI_VERIFY(exp, hr, msg)                                         \
        if (!(exp)) {                                                   \
                DPRINTF("DirectInput API call failed!");                \
                gamepad::checkDIError(hr);                              \
                ASSERT_THROW(false && (exp), msg);                      \
        }


void writeDevCaps(IO std::ostream& stream,
                        IN const DIDEVCAPS& dc);

void writeDevInstance(IO std::ostream& stream,
                        IN const DIDEVICEINSTANCEA& di);


void writeDataFormat(IO std::ostream& stream,
                        IN const DIDATAFORMAT& df);

void writeObjectDataFormat(IO std::ostream& stream,
                        IN const DIOBJECTDATAFORMAT& odf);

void writeStateDebug(IO std::ostream& stream,
                        IN const DIDATAFORMAT& df,
                        IN const byte_t * buffer);

void writeState(IO std::ostream& stream,
                        IN const DIDATAFORMAT& df,
                        IN const byte_t * buffer);


/// information about a device, as determined from enumeration of objects
struct device_caps_t {
        // constructor, manipulators
        device_caps_t(void) throw() { this->clear(); }
        void clear(void) throw() {
                        nAxes = nPOVs = nButtons = 0;
                        dataBytes = 0;
                }
        void dump(IN const char * title) const throw();

        // data fields
        int             nAxes;
        int             nPOVs;
        int             nButtons;
        int             dataBytes;
};


/// This routine will inspect a given device, and then construct a custom
///     DIDATAFORMAT struct to specify how data should be retrieved.  Data
///     will be packed with axes first, then POVs, then buttons, all data
///     dword-aligned.
/// need to free this memory by calling delete[]
byte_t * getDataFormatForDevice(IN IDirectInputDevice8 * device,
                        OUT device_caps_t& dc);

int32_t getAxisValue(IN const byte_t * data,
                        IN const device_caps_t& dc,
                        IN int axisIndex);

int32_t getPOVValue(IN const byte_t * data,
                        IN const device_caps_t& dc,
                        IN int povIndex);

dword_t getButtonValue(IN const byte_t * data,
                        IN const device_caps_t& dc,
                        IN int buttonIndex);

};      // gamepad namespace


// global diagnostics

inline std::ostream& operator << (IO std::ostream& stream,
                                  IN const DIDEVCAPS& dc) {
        gamepad::writeDevCaps(stream, dc);
        return stream;
}

inline std::ostream& operator << (IO std::ostream& stream,
                                  IN const DIDEVICEINSTANCEA& di) {
        gamepad::writeDevInstance(stream, di);
        return stream;
}

inline std::ostream& operator << (IO std::ostream& stream,
                                  IN const DIOBJECTDATAFORMAT& odf) {
        gamepad::writeObjectDataFormat(stream, odf);
        return stream;
}

inline std::ostream& operator << (IO std::ostream& stream,
                                  IN const DIDATAFORMAT& df) {
        gamepad::writeDataFormat(stream, df);
        return stream;
}

#endif  // GAMEPAD_DI_DIAGNOSTICS_H__