serialportprofile.h

// Copyright (c) 1999-2018 David Muse
// See the COPYING file for more information.
 
#ifndef RUDIMENTS_SERIALPORTPROFILE_H
#define RUDIMENTS_SERIALPORTPROFILE_H
 
#include <rudiments/private/serialportprofileincludes.h>
 
// cfmakeraw, cfsetspeed???
// wraps struct termios
 
class RUDIMENTS_DLLSPEC serialportprofile : public object {
        public:
 
                enum    inputmode_t {
                        cannonical=0,
                        raw
                };
 
                enum    flowcontrol_t {
                        fc_none=0,
                        fc_software,
                        fc_hardware
                };
 
                enum    baudrate_t {
                        baud_0=0,
                        baud_50,
                        baud_75,
                        baud_110,
                        baud_134,
                        baud_150,
                        baud_200,
                        baud_300,
                        baud_600,
                        baud_1200,
                        baud_1800,
                        baud_2400,
                        baud_4800,
                        baud_9600,
                        baud_19200,
                        exta,
                        baud_38400,
                        extb,
                        baud_57600,
                        baud_76800,
                        baud_115200,
                        baud_230400,
                        baud_460800,
                        baud_500000,
                        baud_576000,
                        baud_921600,
                        baud_1000000,
                        baud_1152000,
                        baud_1500000,
                        baud_2000000,
                        baud_2500000,
                        baud_3000000,
                        baud_3500000,
                        baud_4000000
                };
 
                enum    charsize_t {
                        cs_5=0,
                        cs_6,
                        cs_7,
                        cs_8
                };
 
                enum    newlinedelay_t {
                        nl_none=0,
                        nl_100
                };
 
                enum    carriagereturndelay_t {
                        cr_none=0,
                        cr_depends,
                        cr_100,
                        cr_150
                };
 
                enum    tabdelay_t {
                        td_0=0,
                        td_1,
                        td_2,
                        td_xtabs
                };
 
                enum    backspacedelay_t {
                        bs_none=0,
                        bs_50
                };
 
                enum    verticaltabdelay_t {
                        vt_none=0,
                        vt_2
                };
 
                enum    formfeeddelay_t {
                        ff_none=0,
                        ff_2
                };
 
                serialportprofile();
 
                ~serialportprofile();
 
                void    setDefaultControlOptions();
 
                void    setDefaultLocalOptions();
 
                void    setDefaultInputOptions();
 
                void    setDefaultOutputOptions();
 
                void    setDefaultControlCharacters();
 
                void    setDefaultOptions();
 
                void    setControlCharacters(const byte_t *c_cc);
 
                void    parseOptionsString(const char *string);
 
                void            setInputMode(inputmode_t inputmode);
 
                inputmode_t     getInputMode();
 
                void            setFlowControl(flowcontrol_t flowcontrol);
 
                flowcontrol_t   getFlowControl();
 
                void    setBaud(const char *baudrate);
 
                void    setBaud(baudrate_t baudrate);
 
                bool    setInputBaud(const char *baudrate);
 
                bool    setInputBaud(baudrate_t baudrate);
 
                bool    setOutputBaud(const char *baudrate);
 
                bool    setOutputBaud(baudrate_t baudrate);
 
                void    setCharacterSize(charsize_t size);
 
                void    setTwoStopBits(bool truefalse);
 
                void    setReceiverOn(bool truefalse);
 
                void    setParityCheck(bool truefalse);
 
                void    setOddParity(bool truefalse);
 
                void    setHangupOnClose(bool truefalse);
 
                void    setIgnoreModemControlLines(bool truefalse);
 
                void    setBlockJobControlOutput(bool truefalse);
 
                void    setHardwareFlowControl(bool truefalse);
 
                baudrate_t      getBaud();
 
                baudrate_t      getInputBaud();
 
                baudrate_t      getOutputBaud();
 
                charsize_t      getCharacterSize();
 
                bool            getTwoStopBits();
 
                bool            getReceiverOn();
 
                bool            getParityCheck();
 
                bool            getOddParity();
 
                bool            getHangupOnClose();
 
                bool            getIgnoreModemControlLines();
 
                bool            getBlockJobControlOutput();
 
                bool            getHardwareFlowControl();
 
                void    setGenerateSignals(bool truefalse);
 
                void    setCanonicalInput(bool truefalse);
 
                void    setEscapedUpperCase(bool truefalse);
 
                void    setEchoInput(bool truefalse);
 
                void    setEraseCharactersOn(bool truefalse);
 
                void    setKillCharacterOn(bool truefalse);
 
                void    setEchoNewLine(bool truefalse);
 
                void    setExtendedFunctions(bool truefalse);
 
                void    setEchoControlCharacters(bool truefalse);
 
                void    setEchoErasedCharacter(bool truefalse);
 
                void    setEmulateKill(bool truefalse);
 
                void    setNoFlushAfterInterruptOrQuit(bool truefalse);
 
                void    setRetypePendingCharacters(bool truefalse);
 
                void    setSendSignalForBackgroundOutput(bool truefalse);
 
                bool    getGenerateSignals();
 
                bool    getCanonicalInput();
 
                bool    getEscapedUpperCase();
 
                bool    getEchoInput();
 
                bool    getEraseCharactersOn();
 
                bool    getKillCharacterOn();
 
                bool    getEchoNewLine();
 
                bool    getExtendedFunctions();
 
                bool    getEchoControlCharacters();
 
                bool    getEchoErasedCharacter();
 
                bool    getEmulateKill();
 
                bool    getNoFlushAfterInterruptOrQuit();
 
                bool    getRetypePendingCharacters();
 
                bool    getSendSignalForBackgroundOutput();
 
                void    setInputParityCheck(bool truefalse);
 
                void    setIgnoreParityErrors(bool truefalse);
 
                void    setMarkParityErrors(bool truefalse);
 
                void    setStripParityBits(bool truefalse);
 
                void    setSoftwareFlowControlOnOutput(bool truefalse);
 
                void    setSoftwareFlowControlOnInput(bool truefalse);
 
                void    setAnyCharacterStartsFlow(bool truefalse);
 
                void    setIgnoreBreak(bool truefalse);
 
                void    setSendSignalOnBreak(bool truefalse);
 
                void    setMapNewLineToCarriageReturnOnInput(bool truefalse);
 
                void    setDiscardEndOfTransmission(bool truefalse);
 
                void    setIgnoreCarriageReturn(bool truefalse);
 
                void    setMapCarriageReturnToNewLineOnInput(bool truefalse);
 
                void    setLowerCase(bool truefalse);
 
                void    setBellIfLineTooLong(bool truefalse);
 
                bool    getInputParityCheck();
 
                bool    getIgnoreParityErrors();
 
                bool    getMarkParityErrors();
 
                bool    getStripParityBits();
 
                bool    getSoftwareFlowControlOnOutput();
 
                bool    getSoftwareFlowControlOnInput();
 
                bool    getAnyCharacterStartsFlow();
 
                bool    getIgnoreBreak();
 
                bool    getSendSignalOnBreak();
 
                bool    getMapNewLineToCarriageReturnOnInput();
 
                bool    getDiscardEndOfTransmission();
 
                bool    getIgnoreCarriageReturn();
 
                bool    getMapCarriageReturnToNewLineOnInput();
 
                bool    getLowerCase();
 
                bool    getBellIfLineTooLong();
 
 
                void    setPostProcessOutput(bool truefalse);
 
                void    setOutputUpperCase(bool truefalse);
 
                void    setMapNewLineToCarriageReturnNewLineOnOutput(
                                                        bool truefalse);
 
                void    setMapCarriageReturnToNewLineOnOutput(bool truefalse);
 
                void    setDontOutputCarriageReturnAtColumnZero(bool truefalse);
 
                void    setMapNewLineToCarriageReturnOnOutput(bool truefalse);
 
                void    setUseFillCharactersForDelay(bool truefalse);
 
                void    setUseDelForFill(bool truefalse);
 
                void    setExpandTabToSpaces(bool truefalse);
 
                void    setDelayAfterNewLine(newlinedelay_t nldelay);
 
                void    setDelayAfterCarriageReturn(
                                        carriagereturndelay_t crdelay);
 
                void    setDelayAfterTab(tabdelay_t tabdelay);
 
                void    setDelayAfterBackSpace(backspacedelay_t bsdelay);
 
                void    setDelayAfterVerticalTab(verticaltabdelay_t vtdelay);
 
                void    setDelayAfterFormFeed(formfeeddelay_t ffdelay);
 
                bool    getPostProcessOutput();
 
                bool    getOutputUpperCase();
 
                bool    getMapNewLineToCarriageReturnNewLineOnOutput();
 
                bool    getMapCarriageReturnToNewLineOnOutput();
 
                bool    getDontOutputCarriageReturnAtColumnZero();
 
                bool    getMapNewLineToCarriageReturnOnOutput();
 
                bool    getUseFillCharactersForDelay();
 
                bool    getUseDelForFill();
 
                bool    getExpandTabToSpaces();
 
                newlinedelay_t          getDelayAfterNewLine();
 
                carriagereturndelay_t   getDelayAfterCarriageReturn();
 
                tabdelay_t              getDelayAfterTab();
 
                backspacedelay_t        getDelayAfterBackSpace();
 
                verticaltabdelay_t      getDelayAfterVerticalTab();
 
                formfeeddelay_t         getDelayAfterFormFeed();
 
                void    setInterruptCharacter(byte_t character);
 
                void    setQuitCharacter(byte_t character);
 
                void    setEraseCharacter(byte_t character);
 
                void    setKillCharacter(byte_t character);
 
                void    setEndOfFileCharacter(byte_t character);
 
                void    setEndOfLineCharacter(byte_t character);
 
                void    setSecondEndOfLineCharacter(byte_t character);
 
                void    setSwitchCharacer(byte_t character);
 
                void    setStartCharacter(byte_t character);
 
                void    setStopCharacter(byte_t character);
 
                void    setSuspendCharacter(byte_t character);
 
                void    setDelayedSuspendCharacter(byte_t character);
 
                void    setLiteralNextCharcter(byte_t character);
 
                void    setWordEraseCharcter(byte_t character);
 
                void    setReprintCharacter(byte_t character);
 
                void    setDiscardPendingOutputCharacter(byte_t character);
 
                void    setStatusRequestCharacter(byte_t character);
 
                void    setReadThreshold(byte_t count);
 
                void    setReadTimeout(byte_t deciseconds);
 
 
                byte_t  getInterruptCharacter();
 
                byte_t  getQuitCharacter();
 
                byte_t  getEraseCharacter();
 
                byte_t  getKillCharacter();
 
                byte_t  getEndOfFileCharacter();
 
                byte_t  getEndOfLineCharacter();
 
                byte_t  getSecondEndOfLineCharacter();
 
                byte_t  getSwitchCharacer();
 
                byte_t  getStartCharacter();
 
                byte_t  getStopCharacter();
 
                byte_t  getSuspendCharacter();
 
                byte_t  getDelayedSuspendCharacter();
 
                byte_t  getLiteralNextCharcter();
 
                byte_t  getWordEraseCharcter();
 
 
                byte_t  getReprintCharacter();
 
                byte_t  getDiscardPendingOutputCharacter();
 
                byte_t  getStatusRequestCharacter();
 
                byte_t  getReadThreshold();
 
                byte_t  getReadTimeout();
 
        #include <rudiments/private/serialportprofile.h>
};
 
#endif