DwmTermios.hh

Go to the documentation of this file.

//===========================================================================
// @(#) $DwmPath: dwm/libDwm/tags/libDwm-0.6.0/include/DwmTermios.hh 8401 $
// @(#) $Id: DwmTermios.hh 8401 2016-04-17 06:44:31Z dwm $
//===========================================================================
//  Copyright (c) Daniel W. McRobb 2006-2007, 2016
//  All rights reserved.
//
//  Redistribution and use in source and binary forms, with or without
//  modification, are permitted provided that the following conditions
//  are met:
//
//  1. Redistributions of source code must retain the above copyright
//     notice, this list of conditions and the following disclaimer.
//  2. Redistributions in binary form must reproduce the above copyright
//     notice, this list of conditions and the following disclaimer in the
//     documentation and/or other materials provided with the distribution.
//  3. The names of the authors and copyright holders may not be used to
//     endorse or promote products derived from this software without
//     specific prior written permission.
//
//  IN NO EVENT SHALL DANIEL W. MCROBB BE LIABLE TO ANY PARTY FOR
//  DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES,
//  INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE,
//  EVEN IF DANIEL W. MCROBB HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
//  DAMAGE.
//
//  THE SOFTWARE PROVIDED HEREIN IS ON AN "AS IS" BASIS, AND
//  DANIEL W. MCROBB HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT,
//  UPDATES, ENHANCEMENTS, OR MODIFICATIONS. DANIEL W. MCROBB MAKES NO
//  REPRESENTATIONS AND EXTENDS NO WARRANTIES OF ANY KIND, EITHER
//  IMPLIED OR EXPRESS, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
//  WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE,
//  OR THAT THE USE OF THIS SOFTWARE WILL NOT INFRINGE ANY PATENT,
//  TRADEMARK OR OTHER RIGHTS.
//===========================================================================

//---------------------------------------------------------------------------
//---------------------------------------------------------------------------

#ifndef _DWMTERMIOS_HH_
#define _DWMTERMIOS_HH_

extern "C" {
#include <inttypes.h>
#include <termios.h>
}

#include <iostream>
#include <string>
#include <utility>

namespace Dwm {

  class Termios;
  
  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------
  typedef struct {
    tcflag_t       flag;
    tcflag_t       mask;
    const char    *name;
    const char    *longName;
  } TermioFlagInfo_t;

  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------
  class TermioFlags
  {
  public:
    virtual ~TermioFlags() { }

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool IsSet(const std::string & flagName) const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Set(const std::string & flagName);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Unset(const std::string & flagName);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    friend std::ostream & 
    operator << (std::ostream & os, const TermioFlags & flags);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    virtual const TermioFlagInfo_t *KnownFlags() const = 0;
    
  protected:
    tcflag_t             *_flagPtr;
    const TermioFlagInfo_t  *_flagInfo;

    TermioFlags();
    const TermioFlagInfo_t *FindFlag(const std::string & flagName) const;
  };
  
  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------
  class TermioInputFlags
    : public TermioFlags
  {
  public:
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    TermioInputFlags(struct termios & t);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    const TermioFlagInfo_t *KnownFlags() const;
    
  private:
    struct termios  & _termios;

    static const TermioFlagInfo_t  k_flags[];

    TermioInputFlags();
  };

  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------
  class TermioOutputFlags
    : public TermioFlags
  {
  public:
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    TermioOutputFlags(struct termios & t);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    const TermioFlagInfo_t *KnownFlags() const;

  private:
    struct termios  & _termios;
    
    static const TermioFlagInfo_t  k_flags[];

    TermioOutputFlags();
  };
  
  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------
  class TermioControlFlags
    : public TermioFlags
  {
  public:
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    TermioControlFlags(struct termios & t);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    const TermioFlagInfo_t *KnownFlags() const;
    
  private:
    struct termios  & _termios;
    
    static const TermioFlagInfo_t  k_flags[];

    TermioControlFlags();
  };

  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------
  class TermioLocalFlags
    : public TermioFlags
  {
  public:
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    TermioLocalFlags(struct termios & t);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    const TermioFlagInfo_t *KnownFlags() const;
    
  private:
    struct termios  & _termios;
    
    static const TermioFlagInfo_t  k_flags[];

    TermioLocalFlags();
  };
  
  //--------------------------------------------------------------------------
  //--------------------------------------------------------------------------
  class Termios
  {
  public:
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    Termios();
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    TermioInputFlags & InputFlags();

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    TermioOutputFlags & OutputFlags();

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    TermioControlFlags & ControlFlags();

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    TermioLocalFlags & LocalFlags();

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    long InputSpeed() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    long InputSpeed(long inputSpeed);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    long OutputSpeed() const;

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    long OutputSpeed(long outputSpeed);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    cc_t ControlChar(const std::string & ccName) const;
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    cc_t ControlChar(const std::string & ccName, cc_t val);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Get(int fd);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool Set(int fd, int action);
    
    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    friend std::ostream & operator << (std::ostream & os, const Termios & t);

    //------------------------------------------------------------------------
    //------------------------------------------------------------------------
    bool operator == (const Termios & t) const;
    
  private:
    struct termios      _termios;
    TermioInputFlags    _inputFlags;
    TermioOutputFlags   _outputFlags;
    TermioControlFlags  _controlFlags;
    TermioLocalFlags    _localFlags;

    typedef struct {
      uint8_t      index;
      const char  *name;
    } ControlCharName_t;
    
    static const  ControlCharName_t k_controlCharNames[];

    static std::string PrintableControlChar(cc_t cc);

    static const ControlCharName_t *
    FindControlChar(const std::string & ccName);

    static const ControlCharName_t *
    FindControlChar(cc_t cc);
  };
  
}  // namespace Dwm

#endif  // _DWMTERMIOS_HH_

//---------------------------- emacs settings -----------------------------
//  Local Variables:
//  mode: C++/la
//  tab-width: 2
//  indent-tabs-mode: nil
//  c-basic-offset: 2
//  End:
//-------------------------------------------------------------------------