Замечания по программе findtext

[alexey-malov]

• [x] Разбить main на подфункции. посмотрите на мои замечания к вашим одногруппникам, чтобы понять, что именно нужно сделать

[alexey-malov]

• [x] дописать тесты

[alexey-malov]

• [x] Если текст найден, программа должна вернуть нулевой код возврата и ненулевой, если не найден

[alexey-malov]

• [x] Программа должна проверять output, сравнивая его с ожидаемым

[alexey-malov]

bool PrintLineNumbersWhereSearchStringWasFound(std::ifstream &inputFile, std::string searchString)

• [x] Принимать не ifstream&, а istream&
• [x] объекты следует передавать по константной ссылке, если функция не модифицирует их состояние. Примитивные объекты передавать по константной ссылке выгоды нет, лучше по значению

[alexey-malov]

• [x] Сделать версию функции PrintLineNumbersContainingText(), которая принимает имя файла и искомый текст и вызывает PrintLineNumbersContainingText, прининимающую поток.

тогда main превратится в:

/*проверка числа аргументов*/
if (PrintLineNumbersContainingText(argv[1], argv[2])
{
    return 0;
}
else
{
    // text not found
    return 1;
}

[alexey-malov]

bool IsSearchStringEmpty(std::string searchString)
{
    if (searchString.empty())
    {
        std::cout << "Search string must be not empty. \n";
        return false;
    }
    return true;
}

• [x] Функция делает противоположное своему имени + имеет побочные эффекты в виде вывода в output, неочевидные из названия. И вообще можно обойтись без неё

[alexey-malov]

bool CheckFileToOpenForReading(const std::string &inputFile)
{
    std::ifstream file ;
    file.open(inputFile);
    if (!file.is_open())
    {
        std::cout << "Failed to open " << inputFile << " for reading \n";
        return false;
    }
    return true;
}

• [x] Проверку надо разместить в той функции, которая открывает файл для обработки.

[alexey-malov]

enum result
{
    text_was_found,
    text_not_found,
    err
};

• [ ] Программа не соответствует принятому стилю кодирования. Ознакомьтесь с правилами именования переменных, функций, классов, расстановкой скобок, знаков препинания и отступов.

[alexey-malov]

result PrintLineNumbersContainingText(const std::string &inputFile, std::string searchString)

• [ ] объекты следует передавать по константной ссылке, если функция не модифицирует их состояние. Примитивные объекты передавать по константной ссылке выгоды нет, лучше по значению

• [x] inputFile -> inputFileName либо inputFilePath

[alexey-malov]

    else if (programResult == text_not_found)

• [ ] Программа не соответствует принятому стилю кодирования. Ознакомьтесь с правилами именования переменных, функций, классов, расстановкой скобок, знаков препинания и отступов.