PrinterPortLogger.cc

Go to the documentation of this file.

#include "PrinterPortLogger.hh"
#include "PlugException.hh"
#include "FileException.hh"
#include "serialize.hh"

namespace openmsx {

PrinterPortLogger::PrinterPortLogger(CommandController& commandController)
        : logFilenameSetting(
                commandController, "printerlogfilename",
                "filename of the file where the printer output is logged to",
                "printer.log")
        , toPrint(0) // Initialize to avoid a static analysis (cppcheck) warning.
                     // For correctness it's not strictly needed to initialize
                     // this variable. But understanding why exactly it's not
                     // needed depends on the implementation details of a few
                     // other classes, so let's simplify stuff and just
                     // initialize.
        , prevStrobe(true)
{
}

bool PrinterPortLogger::getStatus(EmuTime::param /*time*/)
{
        return false; // false = low = ready
}

void PrinterPortLogger::setStrobe(bool strobe, EmuTime::param /*time*/)
{
        if (file.is_open() && !strobe && prevStrobe) {
                // falling edge
                file.write(&toPrint, 1);
                file.flush(); // optimize when it turns out flushing
                               // every time is too slow
        }
        prevStrobe = strobe;
}

void PrinterPortLogger::writeData(byte data, EmuTime::param /*time*/)
{
        toPrint = data;
}

void PrinterPortLogger::plugHelper(
                Connector& /*connector*/, EmuTime::param /*time*/)
{
        try {
                file = File(logFilenameSetting.getString(),
                            File::TRUNCATE);
        } catch (FileException& e) {
                throw PlugException("Couldn't plug printer logger: ",
                                    e.getMessage());
        }
}

void PrinterPortLogger::unplugHelper(EmuTime::param /*time*/)
{
        file.close();
}

const std::string& PrinterPortLogger::getName() const
{
        static const std::string name("logger");
        return name;
}

string_view PrinterPortLogger::getDescription() const
{
        return  "Log everything that is sent to the printer port to a "
                "file. The filename can be set with the "
                "'printerlogfilename' setting.";
}

template<typename Archive>
void PrinterPortLogger::serialize(Archive& /*ar*/, unsigned /*version*/)
{
        // We don't try to resume logging to the same file.
        // And to not accidentally loose a previous log, we don't
        // overwrite that file automatically. So after savestate/loadstate,
        // you have to replug the PrinterPortLogger
}
INSTANTIATE_SERIALIZE_METHODS(PrinterPortLogger);
REGISTER_POLYMORPHIC_INITIALIZER(Pluggable, PrinterPortLogger, "PrinterPortLogger");

} // namespace openmsx