Skip to content

Commit d88e3ac

Browse files
hozlucas28hozlucas28
committed
feature: add new utilities functions
1 parent 9f030b9 commit d88e3ac

File tree

3 files changed

+246
-32
lines changed

3 files changed

+246
-32
lines changed

‎libs/utilities.c

+105-6
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,53 @@
11
#include "utilities.h"
22

3+
#include <ctype.h>
34
#include <stdio.h>
5+
#include <stdlib.h>
6+
#include <string.h>
47

5-
int getStrLength(char* str) {
6-
int length = 0;
8+
void fillDashboard(TGame* pGame, int with) {
9+
int i;
10+
int j;
711

8-
while (*str != '\0') {
9-
length++;
10-
str++;
12+
for (i = 0; i < pGame->rows; i++) {
13+
for (j = 0; j < pGame->cols; j++) {
14+
pGame->dashboard[i][j] = with;
15+
}
16+
}
17+
}
18+
19+
char* getUserInputStr(char* message, int strLength,
20+
int (*validator)(char* userInput)) {
21+
char* userInput = malloc(strLength * sizeof(char));
22+
23+
printf("%s", message);
24+
fflush(stdin);
25+
fgets(userInput, strLength, stdin);
26+
trimStr(userInput);
27+
28+
while (!(*validator)(userInput)) {
29+
printf("Invalid input! Try again...\n");
30+
printf("%s", message);
31+
fflush(stdin);
32+
fgets(userInput, strLength, stdin);
33+
trimStr(userInput);
1134
};
1235

13-
return length;
36+
// TODO
37+
38+
return userInput;
39+
}
40+
41+
int isStrIn(char* str, char* arr[], int size) {
42+
int i;
43+
44+
for (i = 0; i < size; i++) {
45+
if (strcmpi(str, *(arr + i)) == 0) {
46+
return 1;
47+
}
48+
}
49+
50+
return 0;
1451
}
1552

1653
void printDashboard(TGame* pGame) {
@@ -23,3 +60,65 @@ void printDashboard(TGame* pGame) {
2360
printf("\n");
2461
}
2562
}
63+
64+
int strcmpi(const char* str01, const char* str02) {
65+
int i;
66+
67+
int lengthStr01 = strlen(str01);
68+
int lengthStr02 = strlen(str02);
69+
int shortestLength = lengthStr01 < lengthStr02 ? lengthStr01 : lengthStr02;
70+
71+
char charStr01;
72+
char charStr02;
73+
int cmp = 1;
74+
75+
for (i = 0; i < shortestLength; i++) {
76+
charStr01 = toupper(*(str01 + i));
77+
charStr02 = toupper(*(str02 + i));
78+
cmp = charStr01 - charStr02;
79+
80+
if (cmp != 0) {
81+
return cmp;
82+
};
83+
};
84+
85+
return cmp;
86+
}
87+
88+
void trimStr(char* str) {
89+
trimLeftStr(str);
90+
trimRightStr(str);
91+
}
92+
93+
void trimLeftStr(char* str) {
94+
int i;
95+
int j;
96+
int strLength = strlen(str);
97+
98+
int counter = 0;
99+
100+
for (i = 0; i < strLength; i++) {
101+
if (!isspace(*(str + i))) break;
102+
counter++;
103+
};
104+
105+
for (j = 0; j < strLength - counter; j++) {
106+
*(str + j) = *(str + j + counter);
107+
};
108+
109+
*(str + strLength - counter) = '\0';
110+
}
111+
112+
void trimRightStr(char* str) {
113+
int i;
114+
int strLength = strlen(str);
115+
116+
int counter = 0;
117+
118+
for (i = strLength - 1; i > 0; i--) {
119+
if (!isspace(*(str + i))) break;
120+
counter++;
121+
}
122+
123+
*(str + strLength - counter) = '\0';
124+
}

‎libs/utilities.h

+122-17
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,139 @@
11
#ifndef UTILITIES_H_INCLUDED
22
#define UTILITIES_H_INCLUDED
33

4-
#define ROWS 100
5-
#define COLS 100
4+
#include "macros.h"
65

6+
/**
7+
* @struct TGame
8+
* @brief Represents a game structure.
9+
*
10+
* This structure represents a game in which the player's moves are
11+
* recorded. It contains a dashboard, which is a 2D array representing the
12+
* game board, as well as other properties such as the number of rows and
13+
* columns in the dashboard, and the values to represent alive and dead cells.
14+
*/
715
typedef struct {
8-
int dashboard[ROWS][COLS];
9-
int rows;
10-
int cols;
11-
int cellAlive;
12-
int cellDead;
13-
16+
int (*dashboard)[COLS]; /** The game board represented as a 2D array. */
17+
int rows; /** The number of rows in the game board. */
18+
int cols; /** The number of columns in the game board. */
19+
int cellsAlive; /** The value representing an alive cell. */
20+
int cellsDead; /** The value representing a dead cell. */
1421
} TGame;
1522

1623
/**
17-
* @brief Calculates the length of a string.
24+
* @brief Fills the dashboard of a game with a specified value.
25+
*
26+
* This function fills the dashboard of a game with a specified value. The
27+
* dashboard represents the game board where the player's moves are recorded.
28+
*
29+
* @param pGame A pointer to the game structure.
30+
* @param with The value to fill the dashboard with.
31+
*
32+
* @warning This function assumes that the game structure (`pGame`) has been
33+
* properly initialized.
34+
*/
35+
void fillDashboard(TGame* pGame, int with);
36+
37+
/**
38+
* @brief Gets user input as a string.
1839
*
19-
* This function takes a null-terminated string as input and returns the number
20-
* of characters in the string, excluding the null character.
40+
* This function prompts the user with a message and retrieves their input as a
41+
* string. The user's input is validated using the provided validator function.
2142
*
22-
* @param str The null-terminated string for which the length needs to be
23-
* calculated.
43+
* @param message The message to display as a prompt to the user.
44+
* @param strLength The maximum length of the string to be inputted by the user.
45+
* @param validator A function pointer to a validator function that takes a
46+
* string as input and returns an integer. The validator function should return
47+
* 1 if the input is valid, and 0 otherwise.
2448
*
25-
* @return The length of the string.
49+
* @return A pointer to the string entered by the user.
2650
*
27-
* @warning The input string must be null-terminated, otherwise the behavior is
28-
* undefined.
51+
* @warning The returned string may be longer than the specified strLength if
52+
* the user enters more characters.
2953
*/
30-
int getStrLength(char* str);
54+
char* getUserInputStr(char* message, int strLength,
55+
int (*validator)(char* userInput));
3156

57+
/**
58+
* @brief Checks if a string is present in an array of strings.
59+
*
60+
* This function checks if a given string is present in an array of strings.
61+
*
62+
* @param str The string to search for.
63+
* @param arr The array of strings to search in.
64+
* @param size The size of the array.
65+
*
66+
* @return 1 if the string is found in the array, 0 otherwise.
67+
*/
68+
int isStrIn(char* str, char* arr[], int size);
69+
70+
/**
71+
* @brief Prints the dashboard of a game.
72+
*
73+
* This function prints the dashboard of a game, which represents the game board
74+
* where the player's moves are recorded.
75+
*
76+
* @param pGame A pointer to the game structure.
77+
*
78+
* @warning This function assumes that the game structure (`pGame`) has been
79+
* properly initialized and the dashboard has been filled with values.
80+
*/
3281
void printDashboard(TGame* pGame);
3382

83+
/**
84+
* @brief Compares two strings case-insensitively.
85+
*
86+
* This function compares two strings case-insensitively and returns an integer
87+
* indicating their relative order. The comparison is based on the ASCII values
88+
* of the characters in the strings.
89+
*
90+
* @param str01 The first string to compare.
91+
* @param str02 The second string to compare.
92+
*
93+
* @return An integer less than, equal to, or greater than zero if str01 is
94+
* found, respectively, to be less than, to match, or be greater than str02.
95+
*
96+
* @warning This function assumes that the input strings are null-terminated.
97+
*/
98+
int strcmpi(const char* str01, const char* str02);
99+
100+
/**
101+
* @brief Trims leading and trailing whitespace characters from a string.
102+
*
103+
* This function trims leading and trailing whitespace characters from a string
104+
* by modifying the string in-place. The trimmed string will have no leading or
105+
* trailing whitespace characters.
106+
*
107+
* @param str The string to trim.
108+
*
109+
* @warning This function assumes that the input string is null-terminated.
110+
*/
111+
void trimStr(char* str);
112+
113+
/**
114+
* @brief Trims leading whitespace characters from a string.
115+
*
116+
* This function trims leading whitespace characters from a string by modifying
117+
* the string in-place. The trimmed string will have no leading whitespace
118+
* characters.
119+
*
120+
* @param str The string to trim.
121+
*
122+
* @warning This function assumes that the input string is null-terminated.
123+
*/
124+
void trimLeftStr(char* str);
125+
126+
/**
127+
* @brief Trims trailing whitespace characters from a string.
128+
*
129+
* This function trims trailing whitespace characters from a string by modifying
130+
* the string in-place. The trimmed string will have no trailing whitespace
131+
* characters.
132+
*
133+
* @param str The string to trim.
134+
*
135+
* @warning This function assumes that the input string is null-terminated.
136+
*/
137+
void trimRightStr(char* str);
138+
34139
#endif // UTILITIES_H_INCLUDED

‎src/main.c

+19-9
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,33 @@
11
#include "../libs/main.h"
22

3-
#include <stdio.h>
4-
#include <stdlib.h>
3+
#include "stdio.h"
4+
5+
int validatePattern(char* userInput) {
6+
char* options[] = {"glider", "toad", "press", "glider cannon"};
7+
return isStrIn(userInput, options, 2);
8+
}
59

610
int main() {
11+
TGame game;
12+
713
int dashboard[ROWS][COLS];
814
int rows = ROWS;
915
int cols = COLS;
10-
int cellAlive;
11-
int cellDead;
16+
int cellAlive = 0;
17+
int cellDead = 0;
1218

13-
TGame game;
19+
char* requestedPattern;
1420

1521
game.dashboard = dashboard;
1622
game.rows = rows;
1723
game.cols = cols;
18-
game.cellAlive = cellAlive;
19-
game.cellDead = cellDead;
24+
game.cellsAlive = cellAlive;
25+
game.cellsDead = cellDead;
26+
27+
fillDashboard(&game, 0);
2028

21-
printDashboard(&game);
29+
requestedPattern = getUserInputStr("Which pattern do you want (XXX)? ", 100,
30+
&validatePattern);
31+
printf("\n'%s'", requestedPattern);
2232
return 0;
23-
}
33+
}

0 commit comments

Comments
 (0)