### Full Version by @zoelabbb
- [zoelabbb](https://github.com/zoelabbb)
- [zoelabbb/conio.h](https://github.com/zoelabbb/conio.h.git)
## LIST METHODS
-- `getch()`
-- `getche()`
-- `ungetch()`
-- `clrscr()`
-- `gotoxy()`
-- `wherex()`
-- `wherey()`
-- `putch()`
-- `putchar()`
-> **Note** This isn't a full version of 'conio.h'.-> This library has only a few functions that are often used by most programmers.
+- `clrscr()` - Clears the terminal screen. +- `getch()` - Reads a single character from the standard input. +- `getche()` - Reads a single character from the standard input and then echoing it. +- `gotoxy(int, int)` - Moves the cursor to the specified coordinates on the terminal screen. +- `putch(int)` - Writes a character to the standard output. +- `ungetch(int)` - Pushes a character back onto the input stream. +- `wherex()` - Retrieves the current X-coordinate of the cursor on the terminal screen. +- `wherey()` - Retrieves the current Y-coordinate of the cursor on the terminal screen. +> **Note** This isn't a full version of 'conio.h'. +> This library has only a few functions that are often used by most programmers. ## INSTALLATION -### Install the requirements +### Install the requirements (Unix system only) ```bash pkg update && pkg upgrade ``` @@ -37,15 +37,19 @@ pkg install clang git -y git clone https://github.com/mitsuki31/conio_lt.git ``` +Or you can also download the archived version on the [release](https://github.com/mitsuki31/conio_lt/releases/latest). + ### Install as root > **Warning** Must have an `Administrator` or `root` privileges:warning: ```bash -cp conio_lt/conio_lt.h $HOME/usr/include +cp conio_lt/conio_lt.h /usr/include ``` -> **Note** Each devices can be different, on my device is `$HOME/usr/include` +> **Note** This installation only for **Unix** system. +> To install it for **Borland C++**, copy it to where the **Borland C++** would searches its libraries. +> It depends on where you installed the **Borland C++**. ### Install as local ```bash -cp conio_lt/conio_lt.h
+> **Note** Change `"path/to/your_project"` to your project directory. diff --git a/conio_lt.h b/conio_lt.h index b2f1c1f..1bd8330 100644 --- a/conio_lt.h +++ b/conio_lt.h @@ -1,35 +1,35 @@ -/* - -[======== conio_lt.h ========] -[ Author : Ryuu Mitsuki ] -[ Version : 0.1.2 ] -[============================] - -Description -------------- -* Similar like 'conio.h', but it's a lite version of 'conio.h'. -* I hope this can be useful for your project or something else. -* -* Made with : Termux -* OS type : Android (aarch64-linux) -* Clang ver : 15.0.7 ------------- - -List Functions --------------- -:> getch() -:> getche() -:> ungetch() -:> clrscr() -:> gotoxy() -:> wherex() -:> wherey() -:> putch() -:> putchar() --------------- - -*/ - +/** + * @file conio_lt.h + * + * Copyright (c) 2023 Ryuu Mitsuki + * Authored and developed by Ryuu Mitsuki + * + * @version 0.1.5, 2 July 2023 + * + * Description + * ------------- + * Similar like 'conio.h', but it's a lite version of 'conio.h'. + * I hope this can be useful for your project or something else. + * ------------ + * + * List Functions + * -------------- + *
-
+ *
- #clrscr() + *
- #getch() + *
- #getche() + *
- #gotoxy(int, int) + *
- #putch(int) + *
- #ungetch(int) + *
- #wherex() + *
- #wherey() + *
The function uses the following control sequences: + * + *
-
+ *
- \c "\033[0m": Resets any text formatting or color attributes. + *
- \c "\033[1J": Clears the screen from the cursor position to the end of the screen. + *
- \c "\033[1;1f": Moves the cursor to the top-left corner of the screen. + *
By combining these control sequences in a single \c printf statement, + * the function achieves the effect of clearing the terminal screen. + * + * @since 0.1.0 + */ +void clrscr() { + printf("%s0m%s1J%s1;1f", __prefix, __prefix, __prefix); +} + +/** + * @brief Pushes a character back onto the input stream. + * This function pushes a character back onto the input stream. + * It takes an integer parameter \c __c, representing the character to be pushed back. + * + * @param __c The character to be pushed back. + * + * @return Returns the pushed-back character on success, or `EOF` on failure. + * + * @since 0.1.0 + * @see #getch() + * @see #getche() + */ +const int ungetch(const int __c) { + return ungetc(__c, stdin); +} + +/** + * @brief Reads a single character from the standard input without echoing it. + * This function reads a single character from the standard input without echoing it. + * + * @return Returns the character read from the standard input. + * + * @since 0.1.0 + * @see #getche() + * @see #ungetch(int) + */ +const int getch() { + return __getch(0); /* 0 means no echo */ +} + +/** + * @brief Reads a single character from the standard input and then echoing it. + * This function reads a single character from the standard input and then echoing it. + * + * @return Returns the character read from the standard input. + * + * @since 0.1.0 + * @see #getch() + * @see #ungetch(int) + */ +const int getche() { + return __getch(1); /* non-zero means with echo */ +} + +/** + * @brief Retrieves the current X-coordinate of the cursor on the terminal screen. + * This function retrieves the current X-coordinate of the cursor on the terminal screen. + * + * @return Returns the X-coordinate of the cursor. + * + * @since 0.1.0 + */ +const int wherex() { + int __x = 0, __y = 0; + __whereis_xy(&__x, &__y); + + return __x; /* only return the X-coordinate */ +} + +/** + * @brief Retrieves the current Y-coordinate of the cursor on the terminal screen. + * This function retrieves the current Y-coordinate of the cursor on the terminal screen. + * + * @return Returns the Y-coordinate of the cursor. + * + * @since 0.1.0 + */ +const int wherey() { + int __x = 0, __y = 0; + __whereis_xy(&__x, &__y); + + return __y; /* only return the Y-coordinate */ +} + +/** + * @brief Writes a character to the standard output. + * This function writes a character to the standard output. + * It takes an integer parameter \c __chr, representing the character to be written. + * + * @param __chr The character to be written. + * + * @return Returns the written character as an integer. + * + * @since 0.1.0 + */ +const int putch(const int __chr) { + printf("%c", __chr); + return __chr; +} + +#endif /* CONIO_LT_H_ */