finalcut/include/final/ftermcap.h

/***********************************************************************
* ftermcap.h - Provides access to terminal capabilities                *
*                                                                      *
* This file is part of the Final Cut widget toolkit                    *
*                                                                      *
* Copyright 2016-2017 Markus Gans                                      *
*                                                                      *
* The 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.                  *
*                                                                      *
* The 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
 *  ════════════════
 *
 * ▕▔▔▔▔▔▔▔▔▔▔▏
 * ▕ FTermcap ▏
 * ▕▁▁▁▁▁▁▁▁▁▁▏
 */

#ifndef FTERMCAP_H
#define FTERMCAP_H

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

// FTermcap string macro
#define TCAP(s)  tcap[(s)].string

#include <string>


//----------------------------------------------------------------------
// class FTermcap
//----------------------------------------------------------------------
#pragma pack(push)
#pragma pack(1)

class FTermcap
{
  public:
    // Typedef
    typedef struct
    {
      char* string;
      char  tname[3];
    }
    tcap_map;

    // Constructors
    FTermcap()
    { }

    // Destructor
    ~FTermcap()
    { }

    // Accessors
    const char* getClassName() const;

    static tcap_map* getTermcapMap()
    {
      return tcap;
    }

    // Mutator
    static void setTermcapMap (tcap_map* t)
    {
      tcap = t;
    }

    // Data Members
    static bool background_color_erase;
    static bool automatic_left_margin;
    static bool automatic_right_margin;
    static bool eat_nl_glitch;
    static bool ansi_default_color;
    static bool osc_support;
    static bool no_utf8_acs_chars;
    static int  max_color;
    static int  tabstop;
    static int  attr_without_color;

  private:
    // Data Members
    static tcap_map* tcap;
};
#pragma pack(pop)

// FOptiMove inline functions
//----------------------------------------------------------------------
inline const char* FTermcap::getClassName() const
{ return "FTermcap"; }

#endif  // FTERMCAP_H