检查流是否以换行符结尾

Question

我想检查一个流（实际上是一个 ifstream）是否以换行符结尾。我想出了这个：

bool StreamEndsWithNewline(std::basic_istream<char> & the_stream)
{
    if (the_stream.peek() == EOF) {
        the_stream.clear(); //clear flags set by peek()
        return false;
    }
    std::string line = "blah";
    while (std::getline(the_stream, line)) {
       // ...
    }
    return line.empty();
}

这个想法是，如果流的最后一行有一个\n 结束字符，while 循环将进行一次额外的迭代（因为尚未达到 eof），其中空字符串将分配给 line 参数.

“空”流的特殊情况必须单独处理。

它似乎适用于 Windows (vs2010)。我一般可以这样做吗？

Answer 1

tldr;是的，这保证可以工作，除非流最初是空的。

---

需要考虑两个位：fail 位和 eof 位。 std::getline 确实，来自 [string.io]：

构造sentry对象后，如果 sentry 转换为 true，调用 str.erase()，然后从 is 中提取字符并将它们附加到 str，就像调用 str.append(1, c) [...] 如果函数没有提取字符，则调用 is.setstate(ios::failbit)

sentry 确实如此，来自 [istream::sentry]：

效果：如果is.good() 是false，则调用is.setstate(failbit)。否则，准备格式化或未格式化的输入。 [...] 如果is.rdbuf()->sbumpc() 或者is.rdbuf()->sgetc()返回traits::eof()，函数调用setstate(failbit | eofbit)

考虑到所有这些，让我们来看两个例子：

---

案例 1："hello\n"。第一次调用getline()，the_stream.good() 是真的，我们通过\n 提取字符，流仍然是good()，我们进入循环体，line 设置为"hello"。

第二次调用getline()，流还是good()，所以sentry对象转换为true，我们调用str.erase()。尝试提取后续字符失败，因为我们已经完成了流，所以设置了failbit。这会导致 return getline() 转换为 false，因此我们不会再次进入循环体。在循环结束时，line 为空。

---

案例 2："goodbye"，没有换行符。第一次调用getline()，the_stream.good() 是真的，我们提取字符直到我们点击eof()。流failbit 还没有设置，所以我们仍然进入循环体，行设置为"goodbye"。

第二次调用getline()，sentry 对象的构造失败，因为is.good() 为假（is.good() 同时检查eofbit 和failbit）。由于这个失败，我们没有进入调用str.erase() 的getline() 的第一步。由于这次失败，failbit 被设置，所以我们再次不进入循环体。

在循环结束时，line 仍然是 "goodbye"。

---

案例 3：""。在这里，getline() 将不提取任何字符，因此设置了failbit 并且从不进入循环，并且line 始终为空。有几种方法可以将此案例与案例 1 区分开来：

• 您可以在执行任何其他操作之前先通过peek() 查看第一个字符是否为traits::eof()。
• 您可以计算进入循环的次数并检查它是否非零。
• 您可以将line 初始化为一些哨兵非空值。在循环结束时，只有当流以分隔符结束时，该行才会为空。

Answer 2

您的代码有效。

但是，您可以尝试查找流并仅测试最后一个字符或丢弃读取的字符：

#include <cassert>
#include <iostream>
#include <limits>
#include <sstream>

bool StreamEndsWithNewline(std::basic_istream<char>& stream) {
    const auto Unlimited = std::numeric_limits<std::streamsize>::max();
    bool result = false;
    if(stream) {
        if(std::basic_ios<char>::traits_type::eof() != stream.peek()) {
            if(stream.seekg(-1, std::ios::end)) {
                char c;
                result = (stream.get(c) && c == '\n');
                stream.ignore(Unlimited);
            }
            else {
                stream.clear();
                while(stream && stream.ignore(Unlimited, '\n')) {}
                result = (stream.gcount() == 0);
            }
        }
        stream.clear();
    }
    return result;
}

int main() {
    std::cout << "empty\n";
    std::istringstream empty;
    assert(StreamEndsWithNewline(empty) == false);

    std::cout << "empty_line\n";
    std::istringstream empty_line("\n");
    assert(StreamEndsWithNewline(empty_line) == true);

    std::cout << "line\n";
    std::istringstream line("Line\n");
    assert(StreamEndsWithNewline(line) == true);

    std::cout << "unterminated_line\n";
    std::istringstream unterminated_line("Line");
    assert(StreamEndsWithNewline(unterminated_line) == false);

    std::cout << "Please enter ctrl-D: (ctrl-Z on Windows)";
    std::cout.flush();
    assert(StreamEndsWithNewline(std::cin) == false);
    std::cout << '\n';

    std::cout << "Please enter Return and ctrl-D (ctrl-Z on Windows): ";
    std::cout.flush();
    assert(StreamEndsWithNewline(std::cin) == true);
    std::cout << '\n';

    return 0;
}