prompt

prompt is a lightweight project that allows you to accept input in C++ worry free. prompt accomplishes this by providing the end user with an interface to check input data against a test sample using a specified relational operator.

Usage

To use prompt, simply link it to your project and include the prompt.h header. All of the interface methods should become available to you.

Relational Operators

Each of the relational operators in C++ have been mapped to a macro. See the table below for mappings. Alternatively, you can use the _PROMPT_RELOP_IRRELEVANT macro to not test the data at all.

Operator	Macro
`==`	`_PROMPT_RELOP_EQUAL_TO`
`!=`	`_PROMPT_RELOP_NOT_EQUAL_TO`
`<`	`_PROMPT_RELOP_LESS_THAN`
`<=`	`_PROMPT_RELOP_LESS_THAN_OR_EQUAL_TO`
`>`	`_PROMPT_RELOP_GREATER_THAN`
`>=`	`_PROMPT_RELOP_GREATER_THAN_OR_EQUAL_TO`

Functions

char read_char(std::string prompt, int relOp = _PROMPT_RELOP_IRRELEVANT, char test = ' ', std::string error = _PROMPT_DEFAULT_ERROR) - Reads a char from the end user and returns the value.
double read_char(std::string prompt, int relOp = _PROMPT_RELOP_IRRELEVANT, double test = ' ', std::string error = _PROMPT_DEFAULT_ERROR) - Reads a double from the end user and returns the value.
int read_char(std::string prompt, int relOp = _PROMPT_RELOP_IRRELEVANT, int test = ' ', std::string error = _PROMPT_DEFAULT_ERROR) - Reads an int from the end user and returns the value.
std::string read_char(std::string prompt, int relOp = _PROMPT_RELOP_IRRELEVANT, std::string test = ' ', std::string error = _PROMPT_DEFAULT_ERROR) - Reads a std::string from the end user and returns the value.

Examples

#include <iostream>
#include <string>
#include "prompt.h"

int main() {
  char char1 = read_char("Please enter a lowercase character: ",
    _PROMPT_RELOP_GREATER_THAN, 'Z',
    "The character that you entered was not lowercase.  Please try again.\n");
  std::cout << char1 << '\n';

  std::string name = read_string("Please enter your full name: ");
  std::cout << name << '\n';

  char char2 = read_char("Please enter an uppercase character: ",
    _PROMPT_RELOP_LESS_THAN, 'a',
    "The character that you entered was not uppercase.  Please try again.\n");
  std::cout << char2 << '\n';

  return 0;
}

Licensing

This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by-sa/4.0/ or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.

clayfreeman / prompt