/*
                             This file is part of the Opie Project
              =.             (C) 2005 Michael 'Mickey' Lauer <mickey@Vanille.de>
            .=l.
           .>+-=
 _;:,     .>    :=|.         This program is free software; you can
.> <`_,   >  .   <=          redistribute it and/or  modify it under
:`=1 )Y*s>-.--   :           the terms of the GNU Library General Public
.="- .-=="i,     .._         License as published by the Free Software
 - .   .-<_>     .<>         Foundation; version 2 of the License.
     ._= =}       :
    .%`+i>       _;_.
    .i_,=:_.      -<s.       This program is distributed in the hope that
     +  .  -:.       =       it will be useful,  but WITHOUT ANY WARRANTY;
    : ..    .:,     . . .    without even the implied warranty of
    =_        +     =;=|`    MERCHANTABILITY or FITNESS FOR A
  _.=:.       :    :=>`:     PARTICULAR PURPOSE. See the GNU
..}^=.=       =       ;      Library General Public License for more
++=   -.     .`     .:       details.
 :     =  ...= . :.=-
 -.   .:....=;==+<;          You should have received a copy of the GNU
  -_. . .   )=.  =           Library General Public License along with
    --        :-=`           this library; see the file COPYING.LIB.
                             If not, write to the Free Software Foundation,
                             Inc., 59 Temple Place - Suite 330,
                             Boston, MA 02111-1307, USA.
*/

#ifndef OINPUTSYSTEM_H
#define OINPUTSYSTEM_H

#include "linux_input.h"

/* QT */
#include <qobject.h>
#include <qdict.h>

namespace Opie {
namespace Core {

class OInputDevice;

/**
 * @brief A container class for the Linux input device subsystem
 *
 * This class provides access to all available input system devices of your device.
 *
 * @author Michael 'Mickey' Lauer <mickey@Vanille.de>
 */
class OInputSystem : public QObject
{
  public:
    typedef QDict<OInputDevice> DeviceMap;
    typedef QDictIterator<OInputDevice> DeviceIterator;

     /**
     * @returns the number of available input devices
     */
    int count() const;
    /**
     * @returns a pointer to the (one and only) @ref OInputSystem instance.
     */
    static OInputSystem* instance();
    /**
     * @returns an iterator usable for iterating through all network interfaces.
     */
    DeviceIterator iterator() const;
    /**
     * @returns a pointer to the @ref OAudioInterface object for the specified @a interface or 0, if not found
     * @see OAudioInterface
     */
    OInputDevice* device( const QString& interface ) const;
    /**
     * @internal Rebuild the internal interface database
     * @note Sometimes it might be useful to call this from client code,
     */
    void synchronize();
    /**
     * @internal destructor
     */
     ~OInputSystem();

 protected:
    OInputSystem();

    static OInputSystem* _instance;
    DeviceMap _devices;
};


class OInputDevice : public QObject
{
  public:
    OInputDevice( QObject* parent, const char* name = 0 );
    ~OInputDevice();

    #include <opie2/oinputsystemenums.h>

  public:
    /**
     * @returns the identity string of this input device
     */
    QString identity() const;
    /**
     * @returns the path of this input device
     */
    QString path() const;
    /**
     * @returns a unique identifier for this input device
     * @note Only a few devices support this
     */
    QString uniq() const;
    /**
     * @returns whether a certain @a Feature is being supported by this device
     */
    bool hasFeature( Feature ) const;
    /**
     * @returns whether a given @a Key or Button is being held at the moment
     */
    bool isHeld( Key ) const;
    /**
     * @returns whether a given @a Switch is being held at the moment
     */
    bool isHeld( Switch ) const;
    /**
     * @internal
     * @returns a string containing a printable form of the global keymask
     */
    QString globalSwitchMask() const;
    /**
     * @internal
     * @returns a string containing a printable form of the global switchmask
     */
    QString globalKeyMask() const;
    /**
     * @internal
     * @returns whether a certain @a path corresponds to an input device
     */
    static bool isValid( const QString& path );

  private:
    int _fd;
    input_id _id;

};

}
}

#endif // OINPUTSYSTEM_H