From 90a67543f0ed6417fcce39025a3674766dd1140d Mon Sep 17 00:00:00 2001
From: Ricardo <ricardo@zomia.me>
Date: Mon, 30 May 2022 19:52:15 +0000
Subject: [PATCH] Got rid of some useless functions and commented all the code

---
 functions.c    |  46 +++++++++++++++++++---------------------------
 include/main.h |  11 +++++------
 inverT         | Bin 17632 -> 17600 bytes
 main.c         |  49 ++++++++++++++++++++++++++-----------------------
 4 files changed, 50 insertions(+), 56 deletions(-)
 mode change 100644 => 100755 inverT

diff --git a/functions.c b/functions.c
index 4be6d72..8898c5f 100644
--- a/functions.c
+++ b/functions.c
@@ -2,41 +2,33 @@
 
 int ask_file() {
 
-	printf ("Insert name of the file to be read : ");
-	fgets(info.filename, info.fileNameSize, stdin);
-	info.filename[strlen(info.filename)-1] = '\0';
-	invert_file();
-	return 0;
-}
-
-int get_file(char *fileName) {
-
-	strcpy(info.filename, fileName);
-	invert_file();
-	return 0;
+	printf ("Insert name of the file to be read : ");	// print this
+	fgets(info.filename, info.fileNameSize, stdin);		// get the file from user input
+	info.filename[strlen(info.filename)-1] = '\0';		// turn the last character into zero
+	return 0;											// to clear the newline character in there
 }
 
 int invert_file(void) {
 
-	if ((info.fd= fopen(info.filename, "r")) != NULL){
-	int ft, i = 0;
+	if ((info.fd= fopen(info.filename, "r")) != NULL){	// If the file opens
+		int ft, i = 0;									// make this two variables to help
+														// going thru the text
+		fseek(info.fd, 0, SEEK_END);					// take the file descriptor pointer
+														// to the end of the file
+		ft = ftell(info.fd);							// Count the file total number of characters
 
-    fseek(info.fd, 0, SEEK_END);
+		while(i < ft) {									// While the characters dont finish
+			i++;										// increment one character
+			fseek(info.fd, -i, SEEK_END);				// go back one character in the text
+			printf("%c", fgetc(info.fd));				// print current character
+		}
+		printf("\n");									// print newline to clear the terminal
 
-    ft = ftell(info.fd);
-    while(i < ft)
-    {
-        i++;
-        fseek(info.fd, -i, SEEK_END);
-        printf("%c", fgetc(info.fd));
-    }
-	printf("\n");
-
-		fclose(info.fd);
+		fclose(info.fd);								// Close the file
 	}
 
-	else {
-		perror(info.filename);
+	else {												// Otherwiser
+		perror(info.filename);							// print failed to open the file
 	}
 
 	return 0;
diff --git a/include/main.h b/include/main.h
index a5eab64..5fadbec 100644
--- a/include/main.h
+++ b/include/main.h
@@ -6,13 +6,12 @@
 
 
 //Function declarations
-int ask_file();					// It has no flags, it just prompts for filename
-int get_file(char *fileName);	// Gets the filename passed on has an argument
-int invert_file(void);			// Invert the file stored in the variable info.filename
+int ask_file();				// It has no flags, it just prompts for filename
+int invert_file(void);		// Invert the file stored in the variable info.filename
 
 
-//This are general parameters for the program
-struct parameters {
+
+struct parameters {			//This are general parameters for the program
 
 	char filename[100];		// Filename where the text is
 	FILE *fd;				// File descriptor for the text file
@@ -21,6 +20,6 @@ struct parameters {
 	char help[];			// Help menu to be printed on screen
 };
 
-struct parameters info;
+struct parameters info;		// Declare struct info of type parameters
 
 #endif
diff --git a/inverT b/inverT
old mode 100644
new mode 100755
index 1a385373f4d6c9f6a7db48c708dcae5aaf01445e..5f21d97e3a42ccdcef354cd1ada69a0002e2589b
GIT binary patch
delta 1266
zcmY*ZZD?Cn7(VA_Nz>USHy<?(t=-L3(t>MKx-F@7c<<Waon+WCt3RZ(Lm9$AJ8&?;
zStW~btz)t8pTd6V2CWPQBbQ0*k2RTPRpyT}Wt;e86BTbDV7jeXwC(jdH`#Ot-t(OI
zdET#cxXCSp7Y&~8;Oa-6Hyfwj%vsYE;N6=oUh^zY&+==HnVQEk)G2)yURgi(NA}Wl
zXD=jou<N}G)0K*=$+RS&&zo;nnZ8(3XhZ&KD6yDc6M4poRoysN&7N50{#+PDfmw5?
zZ=@?$Ok%8j1`bropDRJtC(>1Y;<#78xJgmrGxoI@&GOLJ;1izchHaN$r~ScJX?C5I
zV1#nP@XjmiU|SJYOCIyizpJXuItf}g(zmRa(4j0!m9Jn!FPA@;rDCwPzaJslRp!qr
z5bD`-Ejv-mzF{?p>^`B-x7A0&6*TgO9(DhSQ<M^+X6_RHwk7yKuVEU5*IM=z_3T1o
z<eS6(ttSOZr$Z0(PiZEkJUN5Fp6{G)7_(~Zt5~mq(zl}_yS&LQF2N?!6%<fVpsQYi
z9nMdNAK~NF9_|XLB4OgG$1TJf>ARLfBjKL$jeq{nR;`P|pFdKc-nfh@&wwhQw*?>h
z?^d}75-ZlQi1K3`-5C=HW|hD>w-Q6$o9T|f{cr8X%&FZ!bTAgvUf63~(}wpNE86p#
zu{Nxq+P(n(K&EqD&sMzF7v{m{bDL>Mk|&in)8g~;!U})db{;rZwe8n{p8($mjxO8w
zEKt2;+c$s(;Htp8w%vlaQdVqxluAmxlOdxU3L9*YWk3Sf2Cn{bv&V!4YoS0aen`~6
zF5X)6$?r=8TRg6-ys5#<+CY5>8@+AYuLAGu(#t}2^v^*Tp#SxNe%sMShwou|nu`s%
z!{{(;@@@7*BsX+ScBS}~+1K@kn@`dC-e-8xT<*QerQc$7b>|Gv(_6dZ{C7ILYaDtk
zIYORfkS`HWM)<E(N=BkplnXK+Q^Klf&71*%Ya+(&m+%~<Nui#0oJ3q9q>3=+Tm%>g
zACOwuaa9%c{k4Pkry`95^(=*srsB~9!jpVV4yaDty=N@bm#GLpLd%%y9r`5|iGEPe
zTdGGo&x)MWPRu!H|BAG}NOYf5vxzaeR?{hr?UH%4?^|x}=|3o$AMZZo;unZ(-CL&c
zmm=0wGd5cGglI?`;~6Sx-GQQ_3W*gJ2Uv&6_dG4}6lsIW#xe1W#ag8I29rEVbA$1J
E0rOgo%>V!Z

delta 1389
zcmZWpZD?Cn7(VBA>5}y$Hy<?(`?{IBEYOdH>5}T|a$SSBQpI9BEjSjD*2x4bG%$aZ
zZq#ZoanSAjX@BUtfznaYjq84FLz^;fBl=@142I}hLA-&W>DFO%U9Zo%_paOUz&UTu
z^E~hKzUQ8MlT+z}O2>B4^zq1b*Lepq$9d+V%^O6)+KB>tmR@yrSv%6jBEqzP`RTqN
zev9n+qkUrYrH^K_(;xm^v#RMrZLM>%E=iR6*(h5TuQf>XsTH254we-)QyLyDQ};+U
zfU`uOpoA2LumBa@BO0snZltv=>}{wFtr|ul&3XXjSjO8h^wS*xHON!4sgjaC?9@Ba
zU4dH{zQh8H3in9nK7sO8P)cG?$VGk*y%P?@W#S(3VrRREdKGtR;mFJ;TaM0pp;ay%
zNhU#nIy%dC`+OUVU|M+}mcH?xKFk_?4{z7O8!O;>lDWik%JA3H{>yz$?yc`~l(@ID
z&wUTkc{b;ho|uDphF4M4R7oGjPHDvBAam;+W^KI=o7lH%s;K5Iqq{at@^7Xm*;D=|
zPnxG?cR#AbM@=p3NjB(@4Q+V<E$P4BhHB=J-Lg7|Rxbf6oG~~axObF~xp2*{sAss!
zjXo5!Q~V(MBCxfi-EFB`QGZv4i;}{xx-*+8n|gga_v6R=1y}mOS#G+w{42lIajf<7
z4npL8?dnyzyIs8{cggBXw{ooU3&1aSMDD=Ush`xIuRFcrgf#FRe+^xjXa6#cam4<T
zVe}(TBJyXPUNVdvqIA<R77)h}37+cMvSCPwIm9Gl^p;_avI|l;QifAAl%#FFC?Z5L
z{cy8C2J#4}Fh%AHh2?QD8owpER(wy`TT@x_8LeLLB%1(zfSI^q7zYv8c;PipoBXGM
zN7>t<K!mHm$2^Gcc)d0CAyaJDD*`^uj)(TT9z(rJC>`2j=yuhKrUaeRTAJQ+&?$Ci
z=QA{~E$zHch3akW$HzaRlkA;cVfrUKwQC4`D8AoUO9;M6KFm^x7a5HQ=rz8^iZB;R
zJ?X~_bpQAVxR)T;Z{dI2q=TJH1ZX{5iU)#W!P1QRERA_^=%Or?2!vX}df-j$*K3{a
z&|zmqSx+KNUtvcRf#40h+Ja~~nHK{60IwE%9~mME5?!`f+lVmR>59j~&5Hp!ZuU6M
z*We5^9-;n!x%-&h5}@B{JuP|ae7$$zK;Ij0_G;3T2L$a%Yr2Ad!xodxHB<JJo8sRh
zTdMT2sN7Gx*eSW$lb5Wjc?lebqAkjM1o{FCwZ&bd{9gj&3VXFJPG4pdZQ=g_78kB}

diff --git a/main.c b/main.c
index 07ef0b7..23a3fad 100644
--- a/main.c
+++ b/main.c
@@ -12,11 +12,11 @@
 
 // Necessary to initalize my struct with all the info
 struct parameters info = {
-	.filename = "EMPTY",
-	.fd = NULL,
-	.version = "1.0",
-	.fileNameSize = 80,
-// Below is the variable that olds the text to dislpay for help
+	.filename = "EMPTY",		// Here we store the file name
+	.fd = NULL,					// File descriptor
+	.version = "1.0",			// Software version
+	.fileNameSize = 80,			// How many characters has the filename, including extention
+// Below is the variable that holds the text to dislpay for help
 	.help = "\n\
 ------------------------------------------------\n\
 Usage: ./inverT -i [<some.text.file>]\n\
@@ -30,35 +30,38 @@ Example: ./inverT -i test.txt\n",
 int main (int argc, char *argv[])  {
 
 
-	if (argc == 1) {
-		ask_file();
+	if (argc == 1) {								// If only one argument
+		ask_file();									// Ask user for the file name and location
+		invert_file();								// and invert the file content
 	}
 
-	else if (argc == 2) {
-		if (strncmp(argv[1], "-help", 5) == 0) {
-			printf("%s\n", info.help);
+	else if (argc == 2) {							// If two arguments
+		if (strncmp(argv[1], "-help", 5) == 0) {	// Check if the flag is '-help'
+			printf("%s\n", info.help);				// and print help info
 		}
-		else if (strncmp(argv[1], "-v", 2) == 0) {
-			printf("Version %s\n", info.version);
+		else if (strncmp(argv[1], "-v", 2) == 0) {	// Check if the flag is '-v'
+			printf("Version %s\n", info.version);	// and print version info
 		}
-		else {
-			get_file(argv[1]);
+		else {										// Otherwise
+			strcpy(info.filename, argv[1]);			// save the second argument into info.filename
+			invert_file();							// and invert the file content
 		}
 	}
 
-	else if (argc == 3) {
-		if(strncmp(argv[1], "-i", 2) == 0) {
-			get_file(argv[2]);
+	else if (argc == 3) {							// If three arguments
+		if(strncmp(argv[1], "-i", 2) == 0) {		// Check if the flag is '-i'
+			strcpy(info.filename, argv[2]);			// save the third argument into info.filename
+			invert_file();							// and invert the file content
 		}
-		else {
-			printf("\nInvalid flag!!!");
-			printf("%s\n", info.help);
+		else {										// Otherwise
+			printf("\nInvalid flag!!!");			// print this
+			printf("%s\n", info.help);				// and then print help info
 		}
 	}
 
-	else {
-		printf("\nTo many arguments!!!");
-		printf("%s\n", info.help);
+	else {											// Otherwise if more then three arguments
+		printf("\nTo many arguments!!!");			// print this
+		printf("%s\n", info.help);					// and then print help info
 	}
 
 	return 0;