ControlPort.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 "ControlPortTypes.h"
#include "CmdQueueTypes.h"
#include "SubComponent.h"
#include "Joystick.h"
#include "Mouse.h"
#include "Paddle.h"
 
namespace vc64 {
 
class ControlPort final : public SubComponent {
 
    friend class Mouse;
    friend class Joystick;
    friend class Paddle;
 
    Descriptions descriptions = {
        {
            .name           = "Port1",
            .description    = "Control Port 1"
        },
        {
            .name           = "Port2",
            .description    = "Control Port 2"
        }
    };
 
    // The connected device
    ControlPortDevice device = CPDEVICE_NONE;
 
 
    //
    // Sub components
    //
 
public:
    
    Mouse mouse = Mouse(c64, *this);
    Joystick joystick = Joystick(c64, *this);
    Paddle paddle = Paddle(c64, *this);
 
 
    //
    // Methods
    //
    
public:
 
    ControlPort(C64 &ref, isize id);
 
    ControlPort& operator= (const ControlPort& other) {
 
        CLONE(mouse)
        CLONE(joystick)
        CLONE(paddle)
        CLONE(device)
        
        return *this;
    }
 
 
    //
    // Methods from Serializable
    //
 
public:
 
    template <class T> void serialize(T& worker) {
 
        worker
 
        << mouse
        << joystick
        << paddle;
 
    } SERIALIZERS(serialize);
 
 
    //
    // Methods from CoreComponent
    //
 
public:
 
    const Descriptions &getDescriptions() const override { return descriptions; }
 
private:
 
    void _dump(Category category, std::ostream& os) const override;
 
 
    //
    // Emulating
    //
    
public:
    
    // Invoked at the end of each frame
    void execute();
 
    // Updates the control port bits (must be called before reading)
    void updateControlPort();
    
    // Returns the control port bits as set by the mouse
    u8 getControlPort() const;
    
    // Updates the pot bits (must be called before reading)
    void updatePotX();
    void updatePotY();
    
    // Reads the pot bits that show up in the SID registers
    u8 readPotX() const;
    u8 readPotY() const;
 
 
    //
    // Processing commands and events
    //
 
public:
 
    // Processes a datasette command
    void processCommand(const Cmd &cmd);
};
 
}