Zum Hauptinhalt springen

Args_Parser

Dokumentation des args_parser Verzeichnisses

Übersicht und Zweck​

Das args_parser Verzeichnis enthält eine Sammlung von Dateien, die der Verarbeitung von Kommandozeilenargumenten sowie der Konfiguration eines Spiels dienen. Die Hauptaufgabe dieser Dateien besteht darin, Spielkonfigurationen zu initialisieren, indem sowohl übergebene Kommandozeilenargumente als auch Inhalte einer Konfigurationsdatei berücksichtigt werden. Die Dateien sind so strukturiert, dass sie die Eingaben validieren und die erforderlichen Einstellungen für das Spiel vornehmen.

Wichtige Funktionen​

1. parse_args​

  • Zweck: Diese Funktion verarbeitet Kommandozeilenargumente und füllt die GameConfig-Struktur mit den entsprechenden Werten.
  • Eingabeparameter:
    • int argc: Die Anzahl der Kommandozeilenargumente.
    • char *argv[]: Das Array der Kommandozeilenargumente.
    • GameConfig *config: Ein Zeiger auf die GameConfig-Struktur, die gefüllt werden muss.
  • Rückgabewerte: Gibt true zurück, wenn die Verarbeitung erfolgreich war, andernfalls false.
  • Besonderheiten:
    • Das Argument -g erwartet eine 13-stellige Spiel-ID und ist obligatorisch.
    • -p legt die Spielernummer fest (1 oder 2), standardmäßig 1.
    • -c gibt den Pfad zu einer Konfigurationsdatei an, standardmäßig client.conf.

2. print_usage​

  • Zweck: Gibt Anweisungen zur korrekten Nutzung des Programms aus.
  • Eingabeparameter:
    • const char *prog_name: Der Name des Programms, der angezeigt wird.
  • Rückgabewerte: Keine.
  • Besonderheiten: Wird aufgerufen, um dem Benutzer zu zeigen, wie die Kommandozeilenargumente richtig verwendet werden.

3. parse_config_file​

  • Zweck: Liest eine Konfigurationsdatei und füllt die Config-Struktur mit den entsprechenden Werten.
  • Eingabeparameter:
    • const char *filename: Der Name der Konfigurationsdatei.
    • Config *config: Ein Zeiger auf die Config-Struktur, die gefüllt werden muss.
  • Rückgabewerte: Gibt true zurück, wenn die Datei erfolgreich gelesen und geparst wurde, andernfalls false.
  • Besonderheiten:
    • Verwendet Standardwerte aus constants.h für optionale Felder, falls diese in der Datei fehlen.
    • Ignoriert leere Zeilen und Kommentare.

Schnittstellen​

Header-Dateien und globale Variablen​

  • args_parser.h: Deklariert die GameConfig Struktur und die Funktionen parse_args und print_usage. Es enthält eine externe Variable EXTERN_PLAYER_NUMBER, die außerhalb der Datei args_parser.c verwendet werden kann.
  • config.h: Deklariert die Config Struktur und die Funktion parse_config_file.
  • constants.h: Definiert Standardwerte für GAMEKINDNAME, PORTNUMBER und HOSTNAME.

Interaktionen​

  • args_parser.c und config.c verwenden die Header-Dateien zur Deklaration von Funktionen und Strukturen, um sicherzustellen, dass alle notwendigen Informationen bereitgestellt werden.
  • constants.h wird in config.c eingebunden, um Standardwerte für die Konfiguration bereitzustellen.

Implementierungsdetails​

  • Strukturen:
    • GameConfig speichert Spiel-spezifische Informationen wie Spiel-ID, Spielernummer und den Pfad zur Konfigurationsdatei.
    • Config enthält Informationen zum Hostnamen, Portnummer und Spielartname.
  • Algorithmen:
    • parse_args durchläuft die übergebenen Argumente, validiert sie und füllt die GameConfig Struktur. Es stellt sicher, dass die Spiel-ID genau 13 Zeichen lang ist und die Spielernummer entweder 1 oder 2 ist.
    • parse_config_file liest die Konfigurationsdatei Zeile für Zeile, ignoriert Kommentare und leere Zeilen, und füllt die Config Struktur mit den gefundenen Werten.
  • Abhängigkeiten:
    • Die Implementierung nutzt Funktionen aus <string.h>, <stdio.h>, <stdbool.h>, <ctype.h>, und <netinet/in.h>, um Zeichenkettenoperationen, Dateizugriffe und Netzwerkoperationen durchzuführen.

Beispielaufrufe​

Nutzung von parse_args​

#include "args_parser.h"

int main(int argc, char *argv[]) {
  GameConfig config;
  if (!parse_args(argc, argv, &config)) {
    print_usage(argv[0]);
    return 1;
  }
  // Weiterverarbeitung mit config
  return 0;
}

Nutzung von parse_config_file​

#include "config.h"

int main() {
  Config config;
  if (!parse_config_file("config.txt", &config)) {
    fprintf(stderr, "Fehler beim Lesen der Konfigurationsdatei.\n");
    return 1;
  }
  // Weiterverarbeitung mit config
  return 0;
}

Diese Dokumentation bietet eine umfassende und präzise Beschreibung der args_parser-Dateien und ihrer Funktionalitäten. Entwickler können diese Informationen nutzen, um die Dateien korrekt zu implementieren und zu verwenden.