Joystick.h

// -----------------------------------------------------------------------------
// This file is part of VirtualC64
//
// Copyright (C) Dirk W. Hoffmann. www.dirkwhoffmann.de
// This FILE is dual-licensed. You are free to choose between:
//
//     - The GNU General Public License v3 (or any later version)
//     - The Mozilla Public License v2
//
// SPDX-License-Identifier: GPL-3.0-or-later OR MPL-2.0
// -----------------------------------------------------------------------------
 
#pragma once
 
#include "JoystickTypes.h"
#include "C64Types.h"
#include "SubComponent.h"
 
namespace vc64 {
 
class Joystick final : public SubComponent, public Inspectable<JoystickInfo> {
 
    Descriptions descriptions = {
        {
            .name           = "Joystick1",
            .description    = "Joystick in Port 1"
        },
        {
            .name           = "Joystick2",
            .description    = "Joystick in Port 2"
        }
    };
 
    ConfigOptions options = {
 
        OPT_AUTOFIRE,
        OPT_AUTOFIRE_BURSTS,
        OPT_AUTOFIRE_BULLETS,
        OPT_AUTOFIRE_DELAY
    };
    
    // Reference to the control port this device belongs to
    ControlPort &port;
 
    // Current configuration
    JoystickConfig config = { };
    
    // Button state
    bool button = false;
    
    // Horizontal joystick position (-1 = left, 1 = right, 0 = released)
    int axisX = 0;
    
    // Vertical joystick position (-1 = up, 1 = down, 0 = released)
    int axisY = 0;
 
 
    //
    // Methods
    //
    
public:
    
    Joystick(C64 &ref, ControlPort& pref);
 
    Joystick& operator= (const Joystick& other) {
 
        CLONE(button)
        CLONE(axisX)
        CLONE(axisY)
 
        CLONE(config)
 
        return *this;
    }
 
 
    //
    // Methods from Serializable
    //
 
public:
 
    template <class T> void serialize(T& worker) {
 
        if (isResetter(worker)) return;
 
        worker 
 
        << config.autofire
        << config.autofireBursts
        << config.autofireBullets
        << config.autofireDelay;
    }
    void operator << (SerChecker &worker) override { serialize(worker); }
    void operator << (SerCounter &worker) override { serialize(worker); }
    void operator << (SerResetter &worker) override;
    void operator << (SerReader &worker) override;
    void operator << (SerWriter &worker) override { serialize(worker); }
 
 
    //
    // Methods from CoreComponent
    //
 
public:
 
    const Descriptions &getDescriptions() const override { return descriptions; }
 
private:
 
    void _dump(Category category, std::ostream& os) const override;
 
 
    //
    // Methods from Inspectable
    //
 
private:
 
    void cacheInfo(JoystickInfo &result) const override;
 
 
    //
    // Methods from Configurable
    //
 
public:
 
    const JoystickConfig &getConfig() const { return config; }
    const ConfigOptions &getOptions() const override { return options; }
    i64 getOption(Option opt) const override;
    void checkOption(Option opt, i64 value) override;
    void setOption(Option opt, i64 value) override;
 
    
    //
    // Using the device
    //
    
public:
 
    // Reads the port bits that show up in the CIA's data port registers
    u8 getControlPort() const;
 
    // Triggers a gamepad event
    void trigger(GamePadAction event);
 
 
    //
    // Auto fire
    //
 
public:
 
    // Processes an auto-fire event
    void processEvent();
 
private:
    
    // Indicates if the device is currently auto-firing
    bool isAutofiring();
 
    // Reloads the auto-fire gun
    void reload();
    void reload(isize bullets);
    template <EventSlot Slot> void reload(isize bullets);
};
 
}