SL.io.50 (Avoid endl): Mention string streams

[N-Dekker]

Explicitly mentioned string streams as endl insertions into string streams do actually occur in the wild.

People have been wondering whether endl is specifically useful for a stringstream to get a platform-specific end-of-line character sequence (apparently not):
"Inserting endline into a stringstream"
https://stackoverflow.com/questions/6865398/inserting-endline-into-a-stringstream

But there have also been concerns about the performance effect of endl on an ostringstream:
"Why does using std::endl with ostringstream affect output speed?"
https://stackoverflow.com/questions/12675273/why-does-using-stdendl-with-ostringstream-affect-output-speed

[cubbimew]

CI wants ostringstream to be added to scripts/hunspell/isocpp.dic

And yes, I've also seen the "platform-specific end-of-line" urban legend, I wonder if it should be called out explicitly.

[N-Dekker]

@cubbimew Thanks for your comments. Can you please check if I addressed them correctly and sufficiently?

[BenjamenMeyer]

or \n\r for Mac ;)

[N-Dekker]

or \n\r for Mac ;)

@BenjamenMeyer You mean '\r', right? But hasn't Mac moved towards using just a single \n, nowadays? Otherwise, are there still actively used C++11 Standard Library implementations for Mac whose file output streams produce a '\r' on each end-of-line?

I did notice the smiley in your comment, but I just want to be entirely sure that it's OK not to mention the old Mac '\r' in the proposed text.

[BenjamenMeyer]

@N-Dekker AFAIK mac is still doing the \n\r - now, perhaps it changes from application to application, but I've still seen it in recent years. The new text called out the Windows behavior as an example; it could be worth noting (legacy or otherwise) the Mac behavior too.

[jwakely]

I just want to be entirely sure that it's OK not to mention the old Mac '\r' in the proposed text.

Please don't mention Macs. Your proposed change is fine. What matters is that it doesn't output a platform-specific line ending, you don't need to give multiple examples of things it doesn't do.

[BenjamenMeyer]

I'm fine with this PR documenting it ;) (e.g not a change - just the commentary here)

[N-Dekker]

@jwakely @BenjamenMeyer Thanks, I won't mention old Macs line endings, if it isn't really necessary. So I also think the PR is OK now.

[BenjamenMeyer]

cool - glad to have this documented. too bad we can't link back to the definition of std::endl for more authority; but this should do just fine and help curb those urban legends.

[jleffler]

On a Mac running modern macOS (MacOS X or later; anything currently supported by Apple), the default line ending is Unix-style \n line endings. AFAIK, the older Macs (20+ years old now) and MacOS 9 or earlier used \r (only; not either \r\n or \n\r) for the line endings.

…

On Tue, Jun 7, 2022 at 9:56 AM Benjamen Meyer ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In CppCoreGuidelines.md <#1920 (comment)> : > @@ -20308,6 +20308,14 @@ For writing to a file, there is rarely a need to `flush`. ##### Note +For string streams (specifically `ostringstream`), the insertion of an `endl` is entirely equivalent +to the insertion of a `'\n'` character, but also in this case, `endl` might be significantly slower. + +`endl` does *not* take care of producing a platform specific end-of-line sequence (like "\r\n" on +Windows). So for a string stream, `s << endl` just inserts a *single* character, `'\n'`. @N-Dekker <https://github.com/N-Dekker> AFAIK mac is still doing the \n\r - now, perhaps it changes from application to application, but I've still seen it in recent years. The new text called out the Windows behavior as an example; it could be worth noting (legacy or otherwise) the Mac behavior too. — Reply to this email directly, view it on GitHub <#1920 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ACCAHBXD2POYTHTRCU7RZWTVN5WLNANCNFSM5XWA6X7Q> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

-- Jonathan Leffler ***@***.***> #include <disclaimer.h> Guardian of DBD::Informix - v2018.1031 - http://dbi.perl.org "Blessed are we who can laugh at ourselves, for we shall never cease to be amused."

[hsutter]

Editors call: Great, thanks!