Merge branch 'main' of https://git.efi.th-nuernberg.de/gitea/bruennerda98937/info2Wortsalat

Start_Linux/input.c

@@ -1,60 +1,69 @@
+/* 
+----- input.c-------------------------------------------------------- 
+ Description: ReadWords: Takes a file and separates all the words from one another, returns the wordcount and an array with all words
+     Project: Praktikum Informatik 2
+      Author: kobma99134@th-nuernberg.de
+        Date: 05-11-2025
+------------------------------------------------------------------------- 
+*/
+
 #include "input.h"
 #include <string.h>
 #include <ctype.h>
 
-// TODO:
-// eine Funktion implementieren, die ein einzelnes Wort aus einer Textdatei (words.txt) einliest und als C-String zurückgibt.
-
 // Read words from file and store in 'words' array
 int readWords(FILE *file, char words[][MAX_WORD_LEN], unsigned int maxWordCount)
 {
-    if(file == NULL) {
+    // checks, if the file acually exists
+    if (file == NULL) {
         return 0;
     }
 
-    int wordCount = 0;
-    char buffer[1024]; // Buffer for reading lines
+    //return value: wordcount, as in the number of words that are being read
+    int wordcount = 0;
+    char readLine[MAX_LINE_LEN];
 
-    // Read file line by line
-    while(fgets(buffer, sizeof(buffer), file) != NULL && wordCount < maxWordCount) {
-        // Process each character in the line
-        char currentWord[MAX_WORD_LEN];
+    // collects the words line by line and adds them to the list, if its not exceeding the max word count
+    while (fgets(readLine, sizeof(readLine), file) != (NULL && wordcount < maxWordCount)) {
+        
+        char word[MAX_WORD_LEN];
         int wordIndex = 0;
         
-        for(int i = 0; buffer[i] != '\0'; i++) {
-            char c = buffer[i];
+        //reads every character in the line from start to finish, until the Enter key ('\0')
+        for (int i = 0; readLine[i] != '\0'; i++) {
             
-            // Check if character is a letter
-            if(isalpha(c)) {
-                // Convert to uppercase and add to current word
-                if(wordIndex < MAX_WORD_LEN - 1) {
-                    currentWord[wordIndex++] = toupper(c);
+            // is the character a letter from the alphabet?
+            if(isalpha(readLine[i])) {
+                if (wordIndex < MAX_WORD_LEN) {
+                    // clean code: We want only uppercase or only lowercase letters to avoid future problems...
+                    word[wordIndex++] = toupper(readLine[i]);
                 }
             }
             else {
-                // Non-letter character = word delimiter
-                if(wordIndex > 0) {
-                    // We have a complete word
-                    currentWord[wordIndex] = '\0';
-                    strcpy(words[wordCount], currentWord);
-                    wordCount++;
+                //if its not a letter, it has to be another character dividing two words e.g. ' ', ',', ';' etc.
+                if (wordIndex > 0) {
+                    // we want a full word, not an empty string
+                    word[wordIndex] = '\0';
+                    // add the word to the wordlist
+                    strcpy(words[wordcount], word);
+                    wordcount++;
                     wordIndex = 0;
 
-                    // Check if we've reached max word count
-                    if(wordCount >= maxWordCount) {
-                        return wordCount;
+                    if (wordcount >= maxWordCount) {
+                        return wordcount;
                     }
                 }
             }
         }
 
-        // Handle last word in line if it doesn't end with delimiter
-        if(wordIndex > 0 && wordCount < maxWordCount) {
-            currentWord[wordIndex] = '\0';
-            strcpy(words[wordCount], currentWord);
-            wordCount++;
+        //Edge case: If the last word ends on a '\0', right after the last letter
+        if (wordIndex > 0 && wordcount < maxWordCount) {
+            word[wordIndex] = '\0';
+            strcpy(words[wordcount], word);
+            wordcount++;
         }
-    }
 
-    return wordCount;
+    }
+    // regular case: return the total number of words
+    return wordcount;
 }

todo.md

@@ -5,6 +5,7 @@ Wörter aus der Wortliste zufällig horizontal oder vertikal plazieren, restlich
 #### input.c
 _Vorgegebene Anweisung:_  
 eine Funktion implementierenm die ein einzelnes Wort aus einer Textdatei (words.txt) einliest und als C-String zurückgibt  
+=> Die Methode sollte Fertig sein, ist aber noch nicht getestet.
 #### main.c
 _Vorgegebene Anweisung:_  
 Check if all words were successfully placed