Add nullptr output operator overload (2221)

[zoecarver]

Summary

This patch fixes LWG issue 2221 by adding a nullptr overload to basic_ostream.

[EricWF]

include/ostream

219

We externally instantiate the rest of these methods, but we can't do that here (for backwards compat reasons).

You need to add _LIBCPP_INLINE_VISIBILITY and maybe put it at the bottom of the group because it's unique in this way.

717

inline or just define the thing inside the class.

720

static_cast<const void*>(nullptr);

But I'm not sure we want to forward to the const void* overload. My understanding of that overload is that it exists to print "bool" values for types like ostream that used to implement if (stream) via a conversion to void*.

I think we may just want to print nill.

test/std/input.output/iostream.format/output.streams/ostream.formatted/ostream.inserters/streambuf.pass.cpp

74

I don't think this test is portable. Implementations can print null or nill or "hubbabalo" for that matter.
We should probably just make this a LIBCPP_ASSERT. And maybe we should also assert the string isn't empty (for when other STL's use our test suite).

[mclow.lists]

include/ostream

720

I suggested this approach to Zoe, because I thought that that was what GCC did. (print 0x0)
Turns out that I was wrong; GCC prints nullptr (at least that's what wandbox claims about gcc 9).

test/std/input.output/iostream.format/output.streams/ostream.formatted/ostream.inserters/streambuf.pass.cpp

74

Agreed.

[zoecarver]

include/ostream

219

Thanks, will do.

717

I'll do the later.

720

Alright. I like printing nullptr better anyway, so I will do that if it's OK with both of you.

test/std/input.output/iostream.format/output.streams/ostream.formatted/ostream.inserters/streambuf.pass.cpp

74

Will do.

[zoecarver]

• fix inlining
• fix visibility
• fix "nullptr" output value
• update tests

[mclow.lists]

Once you fix the nits, I think this is good to go.
Be sure to update www/cxx1z_status.html as well.

include/ostream

223

Don't need the \0; the compiler does that for you.
Nor the static cast; the type of a string literal is const char * already.
Just say:

{ return *this << "nullptr"; }

[zoecarver]

• update status
• fix operator implementation

include/ostream

223

🤦‍♂️but I liked the static_cast so much \s.

[mclow.lists]

Committed as revision 364802 (with a minor change; I updated the synopsis)

include/ostream

public:
     basic_ostream& operator<<(long __n);
     basic_ostream& operator<<(unsigned long __n);
     basic_ostream& operator<<(long long __n);
     basic_ostream& operator<<(unsigned long long __n);
     basic_ostream& operator<<(float __f);
     basic_ostream& operator<<(double __f);
     basic_ostream& operator<<(long double __f);
     basic_ostream& operator<<(const void* __p);
     basic_ostream& operator<<(basic_streambuf<char_type, traits_type>* __sb);
 
+    _LIBCPP_INLINE_VISIBILITY
+    basic_ostream& operator<<(nullptr_t)
+    { return *this << "nullptr"; }
+
     // 27.7.2.7 Unformatted output:
     basic_ostream& put(char_type __c);
     basic_ostream& write(const char_type* __s, streamsize __n);
     basic_ostream& flush();
 
     // 27.7.2.5 seeks:
     inline _LIBCPP_HIDE_FROM_ABI_AFTER_V1
     pos_type tellp();
#ifndef _LIBCPP_NO_EXCEPTIONS
     {
         this->__set_badbit_and_consider_rethrow();
     }
 #endif  // _LIBCPP_NO_EXCEPTIONS
     return *this;
 }
 
 template<class _CharT, class _Traits>
 basic_ostream<_CharT, _Traits>&
 __put_character_sequence(basic_ostream<_CharT, _Traits>& __os,
                           const _CharT* __str, size_t __len)
 {
 #ifndef _LIBCPP_NO_EXCEPTIONS
     try
     {
 #endif  // _LIBCPP_NO_EXCEPTIONS
         typename basic_ostream<_CharT, _Traits>::sentry __s(__os);
         if (__s)
         {
             typedef ostreambuf_iterator<_CharT, _Traits> _Ip;

test/std/input.output/iostream.format/output.streams/ostream.formatted/ostream.inserters/streambuf.pass.cpp

int main(int, char**)
     {
         testbuf<char> sb;
         std::ostream os(&sb);
         testbuf<char> sb2("testing...");
         assert(sb.str() == "");
         os << &sb2;
         assert(sb.str() == "testing...");
     }
+    { // LWG 2221 - nullptr
+        testbuf<char> sb;
+        std::ostream os(&sb);
+        os << nullptr;
+        assert(sb.str().size() != 0);
+        LIBCPP_ASSERT(sb.str() == "nullptr");
+    }
 
   return 0;
 }

www/cxx1z_status.html

<!--   <I>Note: "NAD" means that the issue was deemed "Not a defect"</I> -->
   <tr><td><a href="https://wg21.link/LWG2724">2724</a></td><td>The protected virtual member functions of memory_resource should be private</td><td>Oulu</td><td></td></tr>
   <tr><td><a href="https://wg21.link/LWG2725">2725</a></td><td>filesystem::exists(const path&, error_code&) error reporting</td><td>Oulu</td><td>Complete</td></tr>
   <tr><td><a href="https://wg21.link/LWG2726">2726</a></td><td>[recursive_]directory_iterator::increment(error_code&) is underspecified</td><td>Oulu</td><td>Complete</td></tr>
   <tr><td><a href="https://wg21.link/LWG2727">2727</a></td><td>Parallel algorithms with constexpr specifier</td><td>Oulu</td><td></td></tr>
   <tr><td><a href="https://wg21.link/LWG2728">2728</a></td><td>status(p).permissions() and symlink_status(p).permissions() are not specified</td><td>Oulu</td><td>Complete</td></tr>
    <tr><td></td><td></td><td></td><td></td></tr>
   <tr><td><a href="https://wg21.link/LWG2062">2062</a></td><td>Effect contradictions w/o no-throw guarantee of std::function swaps</td><td>Issaquah</td><td>Complete</td></tr>
   <tr><td><a href="https://wg21.link/LWG2166">2166</a></td><td>Heap property underspecified?</td><td>Issaquah</td><td></td></tr>
-  <tr><td><a href="https://wg21.link/LWG2221">2221</a></td><td>No formatted output operator for nullptr</td><td>Issaquah</td><td></td></tr>
+  <tr><td><a href="https://wg21.link/LWG2221">2221</a></td><td>No formatted output operator for nullptr</td><td>Issaquah</td><td>Complete</td></tr>
   <tr><td><a href="https://wg21.link/LWG2223">2223</a></td><td>shrink_to_fit effect on iterator validity</td><td>Issaquah</td><td>Complete</td></tr>
   <tr><td><a href="https://wg21.link/LWG2261">2261</a></td><td>Are containers required to use their 'pointer' type internally?</td><td>Issaquah</td><td></td></tr>
   <tr><td><a href="https://wg21.link/LWG2394">2394</a></td><td>locale::name specification unclear - what is implementation-defined?</td><td>Issaquah</td><td>Complete</td></tr>
   <tr><td><a href="https://wg21.link/LWG2460">2460</a></td><td>LWG issue 2408 and value categories</td><td>Issaquah</td><td>Complete</td></tr>
   <tr><td><a href="https://wg21.link/LWG2468">2468</a></td><td>Self-move-assignment of library types</td><td>Issaquah</td><td></td></tr>
   <tr><td><a href="https://wg21.link/LWG2475">2475</a></td><td>Allow overwriting of std::basic_string terminator with charT() to allow cleaner interoperation with legacy APIs</td><td>Issaquah</td><td>Complete</td></tr>
   <tr><td><a href="https://wg21.link/LWG2503">2503</a></td><td>multiline option should be added to syntax_option_type</td><td>Issaquah</td><td></td></tr>
   <tr><td><a href="https://wg21.link/LWG2510">2510</a></td><td>Tag types should not be DefaultConstructible</td><td>Issaquah</td><td></td></tr>