main.cpp

/**
 * @file main.cpp
 * @brief A C++ program for spell checking using a balanced binary search tree (BST).
 * @author Kaitlyn Archambault
 * @date 2023-10-30
 */
#include "inc/utils.h"
#include "inc/spell_checker.h"
#include "inc/colours.h"

#include <iostream>
#include <string>

using namespace std;

// expected program arguments, used as feedback to the user
const string EXPECTED_FORMAT = "\"./check ../tests/sample_text.txt ../tests/dictionary.txt tree_output.txt\"";

/**
 * Validate program arguments
 *
 * @return True if arguments provided are valid, false otherwise.
 */
bool valid_arguments(int argc, int expected_num_args, char* argv[], const string& expected_format);

/**
 * @brief The main entry point of the program.
 *
 * Parse command-line arguments and perform
 * spell checking using a balanced search tree.
 *
 * @return 0 on successful execution, 1 on failure.
 */
int main(int argc, char* argv[]) {
    // determine if the correct number of program arguments were provided/ all are in the correct format
    if (!valid_arguments(argc, 4, argv, EXPECTED_FORMAT)) {
        return 1;
    }

    // for readability, initialize file paths from validated arguments
    string sample_text_path = argv[1];
    string dictionary_path = argv[2];
    string tree_output_path = argv[3];

    // TODO allow a program argument to determine tree type
    Dictionary dictionary = Dictionary::build_and_save(dictionary_path, tree_output_path, "bst");

    // validate dictionary contains data, or else all spell checks will fail
    if (dictionary.is_empty()) {
        cerr << RED << "Error: the provided dictionary was empty. Check the file path and try again." << RESET << endl;

        return 1;
    }

    // Create and use a spell checker with the dictionary
    SpellChecker spell_checker(dictionary);
    spell_checker.run_check(sample_text_path);
    spell_checker.print_results();

    return 0;
}

bool valid_arguments(int argc, int expected_num_args, char* argv[], const string& expected_format) {
    if (argc != expected_num_args) {
        cerr << RED << "Wrong number of arguments: expected " << expected_num_args << " but " << argc << " were provided." << RESET << endl;
        cout << CYAN << "Arguments should resemble " << expected_format << RESET << endl;

        return false;
    }

    // all program arguments are expected to be txt files
    string extension = "txt";
    if (!is_valid_file_path(argv[1], extension) || !is_valid_file_path(argv[2], extension) || !is_valid_file_path(argv[3], extension)) {
        cerr << RED << "Must enter a valid " << "." << extension << " format file name for all provided files." << RESET << endl;
        cout << CYAN << "Arguments should resemble " << expected_format << RESET << endl;

        return false;
    }

    return true;
}