ftermios.h

/***********************************************************************
* ftermios.h - Provides access to POSIX tty I/O control                *
*                                                                      *
* This file is part of the FINAL CUT widget toolkit                    *
*                                                                      *
* Copyright 2018-2023 Markus Gans                                      *
*                                                                      *
* FINAL CUT is free software; you can redistribute it and/or modify    *
* it under the terms of the GNU Lesser General Public License as       *
* published by the Free Software Foundation; either version 3 of       *
* the License, or (at your option) any later version.                  *
*                                                                      *
* FINAL CUT is distributed in the hope that it will be useful, but     *
* WITHOUT ANY WARRANTY; without even the implied warranty of           *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
* GNU Lesser General Public License for more details.                  *
*                                                                      *
* You should have received a copy of the GNU Lesser General Public     *
* License along with this program.  If not, see                        *
* <http://www.gnu.org/licenses/>.                                      *
***********************************************************************/

/*  Standalone class
 *  ════════════════
 *
 * ▕▔▔▔▔▔▔▔▔▔▔▏
 * ▕ FTermios ▏
 * ▕▁▁▁▁▁▁▁▁▁▁▏
 */

#ifndef FTERMIOS_H
#define FTERMIOS_H

#if !defined (USE_FINAL_H) && !defined (COMPILE_FINAL_CUT)
  #error "Only <final/final.h> can be included directly."
#endif

#include <termios.h>
#include <unistd.h>

#include "final/ftypes.h"
#include "final/util/fstring.h"

namespace finalcut
{

//----------------------------------------------------------------------
// class FTermios
//----------------------------------------------------------------------

class FTermios final
{
  public:
    // Constructors
    FTermios();

    // Accessors
    auto         getClassName() const -> FString;
    static auto  getTTY() -> termios;
    static auto  getStdIn() noexcept -> int;
    static auto  getStdOut() noexcept -> int;
    static auto  getStdErr() noexcept -> int;

    // Inquiries
    static auto  isRaw() noexcept -> bool;

    // Methods
    static void  init();
    static void  setTTY (const termios&);
    static void  storeTTYsettings();
    static void  restoreTTYsettings();
    static void  setHardwareEcho();
    static void  unsetHardwareEcho();
    static void  setCaptureSendCharacters();
    static void  unsetCaptureSendCharacters();
    static void  setRawMode (bool = true);
    static void  unsetRawMode();
    static void  setCookedMode();
    static auto  getBaudRate() -> uInt;

  private:
    // Data members
    static int     stdin_no;
    static int     stdout_no;
    static int     stderr_no;
    static bool    raw_mode;
    static struct  termios term_init;
};


// FTermios inline functions
//----------------------------------------------------------------------
inline auto FTermios::getClassName() const -> FString
{ return "FTermios"; }

//----------------------------------------------------------------------
inline auto FTermios::getStdIn() noexcept -> int
{ return stdin_no; }

//----------------------------------------------------------------------
inline auto FTermios::getStdOut() noexcept -> int
{ return stdout_no; }

//----------------------------------------------------------------------
inline auto FTermios::getStdErr() noexcept -> int
{ return stderr_no; }

//----------------------------------------------------------------------
inline auto FTermios::isRaw() noexcept -> bool
{ return raw_mode; }

//----------------------------------------------------------------------
inline void FTermios::unsetRawMode()
{ setRawMode(false); }

//----------------------------------------------------------------------
inline void FTermios::setCookedMode()
{ setRawMode(false); }

}  // namespace finalcut

#endif  // FTERMIOS_H