CIn.h

// Copyright Kabuki Starship� <kabukistarship.com>.
#pragma once
#ifndef SCRIPT2_CIN_DECL
#define SCRIPT2_CIN_DECL
#include "COut.h"
#if SEAM >= SCRIPT2_COUT && USING_CONSOLE == YES_0
namespace _ {

/* Checks if the given string is yes or no.
@return -1 if no, 1 if yes, and 0 if neither. */
LIB_MEMBER ISN IsYesNo(const CHA* string);
LIB_MEMBER ISN IsYesNo(const CHB* string);
LIB_MEMBER ISN IsYesNo(const CHC* string);

/* Utility class for scanning types with operator overloads.
@code
ISC a;
FL4 b;
CIn cin;
COut("\n\nEnter a value 0-1,000,000").Star() << cin.SScan(a)
@endcode
*/
class LIB_MEMBER CIn {
  CHA boofer_[24];  //< Boofer for scanning numbers and short Strings.

 public:
  enum {
    StateSuccess = 0,     //< State 0: Completed scanning.
    StateBaseSign,        //< State 1: Scanning base sign.
    StateBaseValue,       //< State 2: Scanning base value.
    StateDotOrExponent,   //< State 3: Scanning '.', 'e', or 'E'.
    StateFractionalPart,  //< State 4: Scanning the fraction part.
    StateExponentSign,    //< State 4: Scanning exponent sign.
    StateExponentValue,   //< State 5: Scanning exponent value.
  };

  enum {
    BooferSizeMin = 2,  //< This min size of a string boofer.
  };

  /* Pauses until any key is pressed. */
  CIn();

#if USING_UTF8 == YES_0
  CIn(CHA& result);
  /* CIns a string with a larger boofer than the */
  CIn(CHA* result, ISW boofer_size);
#endif
#if USING_UTF16 == YES_0
  CIn(CHB& result);
  CIn(CHB* result, ISW boofer_size);
#endif
#if USING_UTF32 == YES_0
  CIn(CHC& result);
  CIn(CHC* result, ISW boofer_size);
#endif

  /* Scans the given item to the CIn stream. */
  CIn(ISA& result);
  CIn(IUA& result);
  CIn(ISB& result);
  CIn(IUB& result);
  CIn(ISC& result);
  CIn(IUC& result);
  CIn(ISD& result);
  CIn(IUD& result);
#if USING_FPC == YES_0
  CIn(FPC& result);
#endif
#if USING_FPD == YES_0
  CIn(FPD& result);
#endif

#if USING_UTF8 == YES_0
  /* Reads the character from the CIn stream. */
  LIB_MEMBER static BOL SScan(CHA& result);

  /* Reads the string with the given boofer_size from the CIn stream. */
  static LIB_MEMBER BOL SScan(CHA* result, ISW boofer_size);
#endif
#if USING_UTF16 == YES_0
  /* Reads the character from the CIn stream. */
  static LIB_MEMBER BOL SScan(CHB& result);

  /* Reads the string with the given boofer_size from the CIn stream. */
  static LIB_MEMBER BOL SScan(CHB* result, ISW boofer_size);
#endif
#if USING_UTF32 == YES_0
  /* Reads the character from the CIn stream. */
  static LIB_MEMBER BOL SScan(CHC& result);

  /* Reads the string with the given boofer_size from the CIn stream. */
  static LIB_MEMBER BOL SScan(CHC* result, ISW boofer_size);
#endif

  /* Reads the value from the CIn stream. */
  static LIB_MEMBER BOL SScan(ISA& result);
  static LIB_MEMBER BOL SScan(IUA& result);
  static LIB_MEMBER BOL SScan(ISB& result);
  static LIB_MEMBER BOL SScan(IUB& result);
  static LIB_MEMBER BOL SScan(ISC& result);
  static LIB_MEMBER BOL SScan(IUC& result);
  static LIB_MEMBER BOL SScan(ISD& result);
  static LIB_MEMBER BOL SScan(IUD& result);
#if USING_FPC == YES_0
  static LIB_MEMBER BOL SScan(FPC& result);
#endif
#if USING_FPD == YES_0
  static LIB_MEMBER BOL SScan(FPD& result);
#endif

  /* Reads the current key depressed on the keyboard.
  @return A negative number_ (typically 1) if no keys are pressed. */
  static LIB_MEMBER ISN GetKey();

  /* Spin waits for the user to press a keyboard key.
  @return The key the user pressed. */
  static LIB_MEMBER ISN ScanKey();
};

/* Prints a formatted string to the console and then pauses for the user to
press any key to continue. */
struct LIB_MEMBER Pausef {
  Pausef(const CHA* message = "\nPress any key to continue...");
};

/* Gets the names of the KeyId. */
inline const CHA* KeyIdName();

/* Gets the array of KeyId offsets. */
inline const ISB* KeyIdOffset();

/* Gets the array of KeyId order. */
inline const IUA* KeyIdOrder();

/* Gets the name from the VK code. */
inline const CHA* KeyIdNameFromCode(ISC code);

/* Gets the VK code from the name of the key. */
inline ISC KeyIdCodeFromName(const CHA* name);

/* Convert a key id to an HID code.
@return Pointer to the a LUT.   */
const IUA* KeyboardNativeToHID();

/* Convert an HID code to a key id.
@return Pointer to the a LUT. */
const IUA* KeyboardHIDToNative();

typedef ISC VKCode;

enum {
  cVKA = 4,
  cVKB = 5,
  cVKC = 6,
  cVKD = 7,
  cVKE = 8,
  cVKF = 9,
  cVKG = 10,
  cVKH = 11,
  cVKI = 12,
  cVKJ = 13,
  cVKK = 14,
  cVKL = 15,
  cVKM = 16,
  cVKN = 17,
  cVKO = 18,
  cVKP = 19,
  cVKQ = 20,
  cVKR = 21,
  cVKS = 22,
  cVKT = 23,
  cVKU = 24,
  cVKV = 25,
  cVKW = 26,
  cVKX = 27,
  cVKY = 28,
  cVKZ = 29,
  cVK1 = 30,
  cVK2 = 31,
  cVK3 = 32,
  cVK4 = 33,
  cVK5 = 34,
  cVK6 = 35,
  cVK7 = 36,
  cVK8 = 37,
  cVK9 = 38,
  cVK0 = 39,
  cVKEnter = 40,
  cVKEscape = 41,
  cVKDelete = 42,
  cVKTab = 43,
  cVKSpace = 44,
  cVKMinus = 45,
  cVKEquals = 46,
  cVKLeftBracket = 47,
  cVKRightBracket = 48,
  cVKBackslash = 49,
  cVKSemicolon = 51,
  cVKQuote = 52,
  cVKGrave = 53,
  cVKComma = 54,
  cVKPeriod = 55,
  cVKSlash = 56,
  cVKCapsLock = 57,
  cVKF1 = 58,
  cVKF2 = 59,
  cVKF3 = 60,
  cVKF4 = 61,
  cVKF5 = 62,
  cVKF6 = 63,
  cVKF7 = 64,
  cVKF8 = 65,
  cVKF9 = 66,
  cVKF10 = 67,
  cVKF11 = 68,
  cVKF12 = 69,
  cVKPrintScreen = 70,
  cVKScrollLock = 71,
  cVKPause = 72,
  cVKInsert = 73,
  cVKHome = 74,
  cVKPageUp = 75,
  cVKDeleteForward = 76,
  cVKEnd = 77,
  cVKPageDown = 78,
  cVKRight = 79,
  cVKLeft = 80,
  cVKDown = 81,
  cVKUp = 82,
  cKPNumLock = 83,
  cKPDivide = 84,
  cKPMultiply = 85,
  cKPSubtract = 86,
  cKPAdd = 87,
  cKPEnter = 88,
  cKP1 = 89,
  cKP2 = 90,
  cKP3 = 91,
  cKP4 = 92,
  cKP5 = 93,
  cKP6 = 94,
  cKP7 = 95,
  cKP8 = 96,
  cKP9 = 97,
  cKP0 = 98,
  cKPPoint = 99,
  cVKNonUSBackslash = 100,
  cKPEquals = 103,
  cVKF13 = 104,
  cVKF14 = 105,
  cVKF15 = 106,
  cVKF16 = 107,
  cVKF17 = 108,
  cVKF18 = 109,
  cVKF19 = 110,
  cVKF20 = 111,
  cVKF21 = 112,
  cVKF22 = 113,
  cVKF23 = 114,
  cVKF24 = 115,
  cVKHelp = 117,
  cVKMenu = 118,
  cVKLeftControl = 224,
  cVKLeftShift = 225,
  cVKLeftAlt = 226,
  cVKLeftGUI = 227,
  cVKRightControl = 228,
  cVKRightShift = 229,
  cVKRightAlt = 230,
  cVKRightGUI = 231
};

/* Gets the next key pressed in the keyboard event cue. */
inline ISC CInKey();

/* Gets the pressed state of the vk_code. */
inline BOL CInState(ISC vk_code);

struct KeyId {
  ISC vk_code;
  const CHA* label;
  const CHA* description;

  KeyId(VKCode code, const CHA* label);

  void ReprogramConsole();
};

}  //< namespace _

_::COut& operator<<(_::COut& o, _::CIn i);
_::COut& operator<<(_::COut& o, _::CIn& i);

_::COut& operator<<(_::COut& o, _::Pausef& i);

#endif
#endif