input.h

Go to the documentation of this file.

 
/*
Copyright (c) 2026 MrXie1109
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/
 
#pragma once
#include <cfloat>
#include <cstdint>
#include <iostream>
#include <limits>
#include <string>
 
#include "../text/strpp.h"
 
namespace console {
    template <class CharT = char>
    struct BasicInputSettings {
        std::basic_ostream<CharT> &os; 
        std::basic_istream<CharT> &is; 
    };

    using InputSettings = BasicInputSettings<char>;

    using WInputSettings = BasicInputSettings<wchar_t>;
 
    static BasicInputSettings<> input_settings{
        std::cout, std::cin}; 
 
    static BasicInputSettings<wchar_t> w_input_settings{
        std::wcout, std::wcin}; 

    template <class T = std::string, class CharT = char>
    T input(const CharT                 *prompt = "",
        const BasicInputSettings<CharT> &is     = input_settings) {
        T tmp;
        while (true) {
            is.os << prompt << std::flush;
            is.is >> tmp;
            if (!is.is) {
                is.is.clear();
                is.is.ignore(
                    std::numeric_limits<std::streamsize>::max(), CharT('\n'));
                is.os << "Stream Error!" << std::endl;
                continue;
            }
            is.is.ignore(
                std::numeric_limits<std::streamsize>::max(), CharT('\n'));
            return tmp;
        }
    }

    template <class T = std::string>
    T w_input(const wchar_t  *prompt = L"",
        const WInputSettings &is     = w_input_settings) {
        T tmp;
        while (true) {
            is.os << prompt << std::flush;
            is.is >> tmp;
            if (!is.is) {
                is.is.clear();
                is.is.ignore(
                    std::numeric_limits<std::streamsize>::max(), wchar_t('\n'));
                is.os << "Stream Error!" << std::endl;
                continue;
            }
            is.is.ignore(
                std::numeric_limits<std::streamsize>::max(), wchar_t('\n'));
            return tmp;
        }
    }

    inline long double input_number(const char *prompt = "Type a number: ",
        const InputSettings                    &is     = input_settings) {
        return input<long double>(prompt, is);
    }

    template <class CharT = char>
    std::basic_string<CharT> input_line(const CharT *prompt = "",
        const BasicInputSettings<CharT>             &is     = input_settings) {
        std::basic_string<CharT> tmp;
        is.os << prompt << std::flush;
        if (is.is.peek() == CharT('\n')) is.is.get();
        std::getline(is.is, tmp);
        return tmp;
    }

    template <class T, class CharT = char>
    T input_with_range(T                 min,
        T                                max,
        const CharT                     *prompt = "",
        const BasicInputSettings<CharT> &is     = input_settings) {
        T tmp;
        while (true) {
            tmp = input<T>(prompt, is);
            if (tmp < min) {
                is.os << "less than the minimum value of " << min << std::endl;
                continue;
            }
            if (tmp > max) {
                is.os << "Greater than the maximum value of " << max
                      << std::endl;
                continue;
            }
            return tmp;
        }
    }

    template <class CharT = char>
    CharT input_char(const CharT        *prompt = "",
        const BasicInputSettings<CharT> &is     = input_settings) {
        is.os << prompt << std::flush;
        CharT tmp = static_cast<CharT>(is.is.get());
        is.is.ignore(std::numeric_limits<std::streamsize>::max(), CharT('\n'));
        return tmp;
    }

    inline bool input_yes_or_no(const char *prompt = "Type yes or no: ",
        const InputSettings                &is     = input_settings) {
        while (true) {
            char tmp = input_char(prompt, is);
            if (tmp == 'Y' || tmp == 'y')
                return true;
            else if (tmp == 'N' || tmp == 'n')
                return false;
            else
                is.os << "Please type yes or no." << std::endl;
        }
    }

    template <class CharT = char>
    std::basic_string<CharT> input_all(const CharT *prompt = "",
        const BasicInputSettings<CharT>            &is     = input_settings) {
        is.os << prompt;
        return {std::istreambuf_iterator<CharT>(is.is),
            std::istreambuf_iterator<CharT>()};
    }
}