libseqan2-dev 2.3.1+dfsg-4 / usr / include / seqan / misc / terminal.h

// ==========================================================================
//                 SeqAn - The Library for Sequence Analysis
// ==========================================================================
// Copyright (c) 2006-2016, Knut Reinert, FU Berlin
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * 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.
//     * Neither the name of Knut Reinert or the FU Berlin nor the names of
//       its contributors may be used to endorse or promote products derived
//       from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL KNUT REINERT OR THE FU BERLIN BE LIABLE
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
// LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
// OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
// DAMAGE.
//
// ==========================================================================
// Author: Manuel Holtgrewe <manuel.holtgrewe@fu-berlin.de>
// ==========================================================================
// Terminal-related functionality.
// ==========================================================================

#ifndef SEQAN_MISC_TERMINAL_H_
#define SEQAN_MISC_TERMINAL_H_

#include <cstdio>

#include <seqan/platform.h>

namespace seqan {

// ============================================================================
// Forwards
// ============================================================================

// ============================================================================
// Classes, Structs, Enums, Tags
// ============================================================================

// ============================================================================
// Metafunctions
// ============================================================================

// ============================================================================
// Functions
// ============================================================================

// ----------------------------------------------------------------------------
// Function isTerminal()
// ----------------------------------------------------------------------------

/*!
 * @fn isTerminal
 * @headerfile <seqan/misc/terminal.h>
 * @brief Check whether we are printing to a terminal.
 *
 * @signature bool isTerminal();
 *
 * @return bool true if we are on the terminal, false otherwise.
 *
 * @see getTerminalSize
 * @see isAnsiColorTerminal
 */

#if defined(STDLIB_VS)

#include <io.h>

inline bool isTerminal()
{
    return false;  // Windows does not understand ANSI codes.
}

#endif  // #if defined(STDLIB_VS)

#if !defined(STDLIB_VS)

#include <unistd.h>

inline bool isTerminal()
{
#ifdef SEQAN_NO_TERMINAL
    return false;    // explicitly disable false positive terminal detection
#else
    return isatty(fileno(stdout));
#endif
}

#endif  // #if !defined(STDLIB_VS)

// ----------------------------------------------------------------------------
// Function isAnsiColorTerminal()
// ----------------------------------------------------------------------------

/*!
 * @fn isAnsiColorTerminal
 * @headerfile <seqan/misc/terminal.h>
 * @brief Check whether we are printing to a terminal that supports ANSI color codes.
 *
 * @signature bool isAnsiColorTerminal();
 *
 * @return bool true if we are in a terminal and the terminal interprets ANSI color code.
 *
 * @section Remarks
 *
 * Currently, we assume that UNIX terminals support color while Windows terminals and non-terminals do not.
 *
 * @see isTerminal
 * @see getTerminalSize
 */

#if defined(STDLIB_VS)

inline bool isAnsiColorTerminal()
{
    return false;
}

#else  // #if defined(STDLIB_VS)

inline bool isAnsiColorTerminal()
{
    return isTerminal();
}

#endif  // #if defined(STDLIB_VS)

// ----------------------------------------------------------------------------
// Function getTerminalSize()
// ----------------------------------------------------------------------------

/*!
 * @fn getTerminalSize
 * @headerfile <seqan/misc/terminal.h>
 * @brief Retrieve size of terminal.
 *
 * @signature bool getTerminalSize(cols, rows);
 *
 * @param[out] cols An <tt>unsigned</tt> value the column count is written to.
 * @param[out] rows An <tt>unsigned</tt> value the row count is written to.
 *
 * @return bool true on success, false otherwise.
 *
 * @section Remarks
 *
 * On Windows, <tt>rows</tt> contains the number o frows in the terminal <b>buffer</b>, not the window.
 *
 * @section Examples
 *
 * The following demonstrates the usage.
 *
 * @include demos/dox/misc/get_terminal_size.cpp
 *
 * @see isTerminal
 * @see isAnsiColorTerminal
 */

#if defined(STDLIB_VS)

#include <Windows.h>

// NOTE: cols actually is the buffer size :(
inline bool getTerminalSize(unsigned & cols, unsigned & rows)
{
    CONSOLE_SCREEN_BUFFER_INFO csbi;
    int ret = GetConsoleScreenBufferInfo(GetStdHandle(STD_OUTPUT_HANDLE), &csbi);
    if (ret == 0)
        return false;

    rows = csbi.dwSize.X;
    cols = csbi.dwSize.Y;

    return true;
}

#endif  // #if defined(STDLIB_VS)

#if !defined(STDLIB_VS)

#include <sys/ioctl.h>
#include <unistd.h>

inline bool getTerminalSize(unsigned & cols, unsigned & rows)
{
    struct winsize w;
    w.ws_row = 0;
    w.ws_col = 0;

    ioctl(STDOUT_FILENO, TIOCGWINSZ, &w);

    rows = w.ws_row;
    cols = w.ws_col;

    return true;
}

#endif  // #if !defined(STDLIB_VS)

}  // namespace seqan

#endif // #ifndef SEQAN_MISC_TERMINAL_H_