Header files for file operation functions related to the game. More...

#include "stock.h"

Include dependency graph for file_io.h:

This graph shows which files directly or indirectly include this file:

Classes
class	USER_SAVE_OPTION
	The user save options. More...

Functions
bool	checkValidInput (const std::string &input)
	Check if the input is valid.

void	createplayer (std::string &playerName)
	Create a player folder.

void	delsave (std::string &mode)
	Delete a save.

std::vector< std::string >	get_saves (void)
	Get the list of saves aka player folders.

void	loadstatus (unsigned int &rounds_played, std::vector< Stock > &stocks_list, float &balance, std::string &playerName, std::vector< float > &hsi_history)
	Load an existing game status from .save files.

std::vector< std::string >	parseLogo (void)
	returns the game logo, which is hardcoded inside the function.

void	printvector (const std::vector< std::string > &avector)
	Print the vector of saves aka player folders.

void	savestatus (unsigned int rounds_played, std::vector< Stock > stocks_list, float balance, const std::string &playerName)
	Save the game status into *.save files.

Variables
const std::string	SAVE_FILE_EXTENSION_TXT = ".save"

const std::string	SAVE_FOLDER_PREFIX = "saves/"

const std::string	USER_SAVE_OPTION_PROMPT

Detailed Description

Header files for file operation functions related to the game.

Definition in file file_io.h.

Function Documentation

◆ checkValidInput()

bool checkValidInput ( const std::string & input )

inline

Check if the input is valid.

The input is valid if it is one of the options in the USER_SAVE_OPTION class.

Parameters

input The input string

Returns: true if the input is valid, false otherwise

Definition at line 37 of file file_io.h.

                                                     {
    return input.compare(USER_SAVE_OPTION::NEW_GAME) == 0 ||
           input.compare(USER_SAVE_OPTION::LOAD_GAME) == 0 ||
           input.compare(USER_SAVE_OPTION::DELETE_GAME) == 0 ||
           input.compare(USER_SAVE_OPTION::EXIT_GAME) == 0;
}

References USER_SAVE_OPTION::DELETE_GAME, USER_SAVE_OPTION::EXIT_GAME, USER_SAVE_OPTION::LOAD_GAME, and USER_SAVE_OPTION::NEW_GAME.

Referenced by initializePlayerSaves().

Here is the caller graph for this function:

◆ createplayer()

void createplayer ( std::string & playerName )

Create a player folder.

Parameters

playerName Pass the playerName by reference.

Definition at line 69 of file file_io.cpp.

                                       {
    ofstream fout;
    string savefolder =
        SAVE_FOLDER_PREFIX; // create folder when it does not exist (first run)
    string foldername;
    filesystem::create_directory(SAVE_FOLDER_PREFIX);
    cout << "Enter player name:" << endl;
    getline(cin, playerName);
    foldername = SAVE_FOLDER_PREFIX + playerName;
    while ((filesystem::exists(foldername) || playerName.find(' ') != string::npos) ||
           playerName.empty()) { // check whether file already exists
        if (!playerName.empty()) {
            cout << "Invalid Playername. ";
            cout << "Playername should not contain spaces or cannot be the same as "
                    "existing ";
            cout << "playername" << endl << "Please enter a new player name: " << endl;
        }
        getline(cin, playerName);
        foldername = SAVE_FOLDER_PREFIX + playerName;
    }
    filesystem::create_directory(foldername); // create a empty folder for new save
}

References playerName, and SAVE_FOLDER_PREFIX.

Referenced by initializePlayerSaves(), and loadstatus().

Here is the caller graph for this function:

◆ delsave()

void delsave ( std::string & mode )

Delete a save.

Parameters

mode	Return the mode choice (0,1,2,3) by reference for further control after deleting

Definition at line 158 of file file_io.cpp.

                            {
    string stockdel;
    string stockname;
    string inputname;
    string confirm;
    ifstream fin;
    vector<string> players;
    filesystem::create_directory(
        SAVE_FOLDER_PREFIX); // prevent error when no folder exists
    players = get_saves();   // generate a vector of name of folders
    if (players.empty()) {
        cout << "No player saves found, please enter " << USER_SAVE_OPTION::NEW_GAME
             << " for new save or enter " << USER_SAVE_OPTION::EXIT_GAME
             << " to quit: ";
        std::cin >> mode;
        while (
            mode != USER_SAVE_OPTION::NEW_GAME && mode != USER_SAVE_OPTION::EXIT_GAME) {
            std::cout << "Invalid input. Please enter " + USER_SAVE_OPTION::NEW_GAME
                      << " for new save or enter " + USER_SAVE_OPTION::EXIT_GAME +
                             " to quit: ";
            std::cin >> mode; // choose new file or load previous file
        }
        return;
    }
    cout << "Enter player name from the following:" << endl;
    printvector(players);
    while (std::find(players.begin(), players.end(), inputname) ==
           players.end()) { // reject incorrect input
        if (!inputname.empty()) {
            cout << "Player name does not exist, please enter a new name from the "
                    "following: "
                 << endl;
            printvector(players);
        }
        getline(cin, inputname);
    }
 
    cout << "WARNING! This action is irreversible and will delete all data associated "
            "with the player save."
         << endl;
    cout << "Player save " << inputname
         << " is going to be deleted, please enter Y to confirm" << endl;
    cin >> confirm;
    if (confirm == "Y" || confirm == "y") {
        stockdel = SAVE_FOLDER_PREFIX + inputname;
        for (const auto & path : std::filesystem::directory_iterator(stockdel)) {
            std::filesystem::remove(path);
        }
        std::filesystem::remove_all(stockdel);
        cout << "Player save " << inputname << " has been deleted." << endl;
    }
    else {
        cout << "The deletion has been cancelled." << endl;
    }
}

References USER_SAVE_OPTION::EXIT_GAME, get_saves(), USER_SAVE_OPTION::NEW_GAME, printvector(), and SAVE_FOLDER_PREFIX.

Referenced by initializePlayerSaves().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_saves()

std::vector< std::string > get_saves ( void )

Get the list of saves aka player folders.

Returns: a vector containing the name all the player folders

Definition at line 214 of file file_io.cpp.

                               {
    vector<string> saves;
    for (const auto & entry : std::filesystem::directory_iterator(SAVE_FOLDER_PREFIX)) {
        saves.emplace_back(entry.path().string().substr(SAVE_FOLDER_PREFIX.size()));
    }
    return saves;
}

References SAVE_FOLDER_PREFIX.

Referenced by delsave(), and loadstatus().

Here is the caller graph for this function:

◆ loadstatus()

void loadstatus	(	unsigned int &	rounds_played,
		std::vector< Stock > &	stocks_list,
		float &	balance,
		std::string &	playerName,
		std::vector< float > &	hsi_history )

Load an existing game status from .save files.

Paramenters should be empty and values are returned by reference.

Parameters

rounds_played	The number of rounds played
stocks_list	A vector of stocks
balance	The balance of the player
playerName	The name of the player also the folder name
hsi_history	A vector of HSI history

Definition at line 120 of file file_io.cpp.

                                                                       {
    string stockload;
    string stockname;
    ifstream fin;
    vector<string> players;
    filesystem::create_directory(
        SAVE_FOLDER_PREFIX); // prevent error when no folder exists
    players = get_saves();   // generate a vector of name of folders
    if (players.empty()) {
        cout << "No player saves found, please create a new player." << endl;
        createplayer(playerName);
        return; // rejection of loading when no save files exist
    }
    cout << "Enter player name from the following:" << endl;
    printvector(players);
    while (std::find(players.begin(), players.end(), playerName) ==
           players.end()) { // reject incorrect input
        if (!playerName.empty()) {
            cout << "Player name does not exist, please enter a new name from the "
                    "following:"
                 << endl;
            printvector(players);
        }
        getline(cin, playerName);
    }
    stockload =
        SAVE_FOLDER_PREFIX + playerName + "/playerstatus" + SAVE_FILE_EXTENSION_TXT;
    fin.open(stockload.c_str());
    fin >> playerName >> rounds_played >> balance;
    fin.close(); // output basic info from playerstatus.save and return by reference
    load_hsi(hsi_history, playerName);
    for (unsigned long i = 0; i < initial_stock_count; i++) {
        stocks_list[i].load(
            playerName, i); // load stocks info to class in seperate files
    }
}

References balance, createplayer(), get_saves(), initial_stock_count, load_hsi(), playerName, printvector(), rounds_played, SAVE_FILE_EXTENSION_TXT, and SAVE_FOLDER_PREFIX.

Referenced by initializePlayerSaves().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseLogo()

std::vector< std::string > parseLogo ( void )

returns the game logo, which is hardcoded inside the function.

Returns: a vector of strings, each string is a line of the logo

Definition at line 34 of file file_io.cpp.

                               {
    vector<string> logo;
    // clang-format off
    logo.reserve(27);
    logo.emplace_back(R"(            __                       __)");
    logo.emplace_back(R"(           |  \                     |  \)");
    logo.emplace_back(R"(  _______ _| $$_    ______   _______| $$   __)");
    logo.emplace_back(R"( /       |   $$ \  /      \ /       | $$  /  \)");
    logo.emplace_back(R"(|  $$$$$$$\$$$$$$ |  $$$$$$|  $$$$$$| $$_/  $$)");
    logo.emplace_back(R"( \$$    \  | $$ __| $$  | $| $$     | $$   $$)");
    logo.emplace_back(R"( _\$$$$$$\ | $$|  | $$__/ $| $$_____| $$$$$$\)");
    logo.emplace_back(R"(|       $$  \$$  $$\$$    $$\$$     | $$  \$$\)");
    logo.emplace_back(R"( \$$$$$$$    \$$$$  \$$$$$$  \$$$$$$$\$$   \$$)");
    logo.emplace_back(R"(                                __                 __)");
    logo.emplace_back(R"(                               |  \               |  \)");
    logo.emplace_back(R"( ______ ____   ______   ______ | $$   __  ______ _| $$_)");
    logo.emplace_back(R"(|      \    \ |      \ /      \| $$  /  \/      |   $$ \)");
    logo.emplace_back(R"(| $$$$$$\$$$$\ \$$$$$$|  $$$$$$| $$_/  $|  $$$$$$\$$$$$$)");
    logo.emplace_back(R"(| $$ | $$ | $$/      $| $$   \$| $$   $$| $$    $$| $$ __)");
    logo.emplace_back(R"(| $$ | $$ | $|  $$$$$$| $$     | $$$$$$\| $$$$$$$$| $$|  \)");
    logo.emplace_back(R"(| $$ | $$ | $$\$$    $| $$     | $$  \$$\\$$     \ \$$  $$)");
    logo.emplace_back(R"( \$$  \$$  \$$ \$$$$$$$\$$      \$$   \$$ \$$$$$$$  \$$$$)");
    logo.emplace_back(R"(          __                       __           __)");
    logo.emplace_back(R"(         |  \                     |  \         |  \)");
    logo.emplace_back(R"(  _______ \$$______ ____  __    __| $$ ______ _| $$_    ______   ______)");
    logo.emplace_back(R"( /       |  |      \    \|  \  |  | $$|      |   $$ \  /      \ /      \)");
    logo.emplace_back(R"(|  $$$$$$| $| $$$$$$\$$$$| $$  | $| $$ \$$$$$$\$$$$$$ |  $$$$$$|  $$$$$$\)");
    logo.emplace_back(R"( \$$    \| $| $$ | $$ | $| $$  | $| $$/      $$| $$ __| $$  | $| $$   \$$)");
    logo.emplace_back(R"( _\$$$$$$| $| $$ | $$ | $| $$__/ $| $|  $$$$$$$| $$|  | $$__/ $| $$)");
    logo.emplace_back(R"(|       $| $| $$ | $$ | $$\$$    $| $$\$$    $$ \$$  $$\$$    $| $$)");
    logo.emplace_back(R"( \$$$$$$$ \$$\$$  \$$  \$$ \$$$$$$ \$$ \$$$$$$$  \$$$$  \$$$$$$ \$$      )");
    // clang-format on
    return logo;
}

Referenced by drawLogo().

Here is the caller graph for this function:

◆ printvector()

void printvector ( const std::vector< std::string > & avector )

Print the vector of saves aka player folders.

Definition at line 222 of file file_io.cpp.

                                                 {
    cout << avector[0];
    // note: start from 1 to avoid printing the first element twice
    for (unsigned long i = 1; i < avector.size(); i++) {
        cout << ", " << avector[i];
    }
    cout << endl;
}

Referenced by delsave(), and loadstatus().

Here is the caller graph for this function:

◆ savestatus()

void savestatus	(	unsigned int	rounds_played,
		std::vector< Stock >	stocks_list,
		float	balance,
		const std::string &	playerName )

Save the game status into *.save files.

Parameters

rounds_played	The number of rounds played
stocks_list	A vector of stocks
balance	The balance of the player
playerName	The name of the player also the folder name

Definition at line 104 of file file_io.cpp.

                               {
    string stocksave;
    ofstream fout;
    stocksave =
        SAVE_FOLDER_PREFIX + playerName + "/playerstatus" + SAVE_FILE_EXTENSION_TXT;
    fout.open(stocksave.c_str());
    fout << playerName << " " << rounds_played << " " << balance
         << endl; // saving basic info out of class inside playerstatus.save
    fout.close();
    for (unsigned long i = 0; i < stocks_list.size(); i++) {
        stocks_list[i].save(
            playerName, i); // save stock info inside class in seperate file
    }
}