rope(3)

📦 version 4.4.0, in nixpkgs unstable

💖 NAME 💖

okay so this is the rope(3) page from the Library Functions Manual, and the name entry is literally:

rope -

That's it. That's the name. The rest is a whole lot of C++ energy, bestie. 🫶

✨ SYNOPSIS ✨

🦋 Classes

  • class __gnu_cxx::rope< _CharT, _Alloc > — the one class listed here, and she's the main character.

🦋 Namespaces

the namespaces showing up are:

  • namespace __gnu_cxx
  • namespace __gnu_cxx::__detail
  • namespace std
  • namespace std::tr1

🦋 Defines

the defines are coming in hot — and yes, __ROPE_DEFINE_ALLOC is listed twice in the original. I'm keeping both because details are sacred. 💅

  • #define __GC_CONST
  • #define __ROPE_DEFINE_ALLOC(_Tp, __name)
  • #define __ROPE_DEFINE_ALLOC(_Tp, __name)
  • #define __ROPE_DEFINE_ALLOCS(__a)
  • #define __STATIC_IF_SGI_ALLOC
  • #define __STL_FREE_STRING(__s, __l, __a)
  • #define __STL_ROPE_FROM_UNOWNED_CHAR_PTR(__s, __size, __a)
  • #define _ROPE

🦋 Typedefs

two typedef cuties:

  • typedef rope< char > __gnu_cxx::crope
  • typedef rope< wchar_t > __gnu_cxx::wrope

🦋 Enumerations

two enum situations:

  • enum { _S_max_rope_depth }
  • enum _Tag { _S_leaf, _S_concat, _S_substringfn, _S_function }

🦋 Functions

okay this is the big one — every function, no skipping, no summarizing. The signatures stay exactly as written, bestie. 💖

🔥 core little helpers

  • crope::reference __gnu_cxx::__mutable_reference_at (crope &__c, size_t __i)
  • template<typename _ForwardIterator , typename _Tp > void __gnu_cxx::_Destroy_const (_ForwardIterator __first, _ForwardIterator __last, allocator< _Tp >)
  • template<typename _ForwardIterator , typename _Allocator > void __gnu_cxx::_Destroy_const (_ForwardIterator __first, _ForwardIterator __last, _Allocator __alloc)
  • void __gnu_cxx::_S_cond_store_eos (wchar_t &__c)
  • void __gnu_cxx::_S_cond_store_eos (char &__c)
  • template<class _CharT > void __gnu_cxx::_S_cond_store_eos (_CharT &)
  • template<class _CharT > _CharT __gnu_cxx::_S_eos (_CharT *)
  • bool __gnu_cxx::_S_is_basic_char_type (wchar_t *)
  • bool __gnu_cxx::_S_is_basic_char_type (char *)
  • template<class _CharT > bool __gnu_cxx::_S_is_basic_char_type (_CharT *)
  • bool __gnu_cxx::_S_is_one_byte_char_type (char *)
  • template<class _CharT > bool __gnu_cxx::_S_is_one_byte_char_type (_CharT *)

🔥 operator!= girlies

  • template<class _CharT , class _Alloc > bool __gnu_cxx::operator!= (const _Rope_char_ptr_proxy< _CharT, _Alloc > &__x, const _Rope_char_ptr_proxy< _CharT, _Alloc > &__y)
  • template<class _CharT , class _Alloc > bool __gnu_cxx::operator!= (const rope< _CharT, _Alloc > &__x, const rope< _CharT, _Alloc > &__y)
  • template<class _CharT , class _Alloc > bool __gnu_cxx::operator!= (const _Rope_iterator< _CharT, _Alloc > &__x, const _Rope_iterator< _CharT, _Alloc > &__y)
  • template<class _CharT , class _Alloc > bool __gnu_cxx::operator!= (const _Rope_const_iterator< _CharT, _Alloc > &__x, const _Rope_const_iterator< _CharT, _Alloc > &__y)

🔥 operator+ (addition slay)

  • template<class _CharT , class _Alloc > rope< _CharT, _Alloc > __gnu_cxx::operator+ (const rope< _CharT, _Alloc > &__left, _CharT __right)
  • template<class _CharT , class _Alloc > rope< _CharT, _Alloc > __gnu_cxx::operator+ (const rope< _CharT, _Alloc > &__left, const _CharT *__right)
  • template<class _CharT , class _Alloc > rope< _CharT, _Alloc > __gnu_cxx::operator+ (const rope< _CharT, _Alloc > &__left, const rope< _CharT, _Alloc > &__right)
  • template<class _CharT , class _Alloc > _Rope_iterator< _CharT, _Alloc > __gnu_cxx::operator+ (ptrdiff_t __n, const _Rope_iterator< _CharT, _Alloc > &__x)
  • template<class _CharT , class _Alloc > _Rope_iterator< _CharT, _Alloc > __gnu_cxx::operator+ (const _Rope_iterator< _CharT, _Alloc > &__x, ptrdiff_t __n)
  • template<class _CharT , class _Alloc > _Rope_const_iterator< _CharT, _Alloc > __gnu_cxx::operator+ (ptrdiff_t __n, const _Rope_const_iterator< _CharT, _Alloc > &__x)
  • template<class _CharT , class _Alloc > _Rope_const_iterator< _CharT, _Alloc > __gnu_cxx::operator+ (const _Rope_const_iterator< _CharT, _Alloc > &__x, ptrdiff_t __n)

🔥 operator+= (add-and-assign)

  • template<class _CharT , class _Alloc > rope< _CharT, _Alloc > & __gnu_cxx::operator+= (rope< _CharT, _Alloc > &__left, _CharT __right)
  • template<class _CharT , class _Alloc > rope< _CharT, _Alloc > & __gnu_cxx::operator+= (rope< _CharT, _Alloc > &__left, const _CharT *__right)
  • template<class _CharT , class _Alloc > rope< _CharT, _Alloc > & __gnu_cxx::operator+= (rope< _CharT, _Alloc > &__left, const rope< _CharT, _Alloc > &__right)

🔥 operator- (minus moment)

  • template<class _CharT , class _Alloc > ptrdiff_t __gnu_cxx::operator- (const _Rope_iterator< _CharT, _Alloc > &__x, const _Rope_iterator< _CharT, _Alloc > &__y)
  • template<class _CharT , class _Alloc > _Rope_iterator< _CharT, _Alloc > __gnu_cxx::operator- (const _Rope_iterator< _CharT, _Alloc > &__x, ptrdiff_t __n)
  • template<class _CharT , class _Alloc > ptrdiff_t __gnu_cxx::operator- (const _Rope_const_iterator< _CharT, _Alloc > &__x, const _Rope_const_iterator< _CharT, _Alloc > &__y)
  • template<class _CharT , class _Alloc > _Rope_const_iterator< _CharT, _Alloc > __gnu_cxx::operator- (const _Rope_const_iterator< _CharT, _Alloc > &__x, ptrdiff_t __n)

🔥 operator< (less-than)

  • template<class _CharT , class _Alloc > bool __gnu_cxx::operator< (const rope< _CharT, _Alloc > &__left, const rope< _CharT, _Alloc > &__right)
  • template<class _CharT , class _Alloc > bool __gnu_cxx::operator< (const _Rope_iterator< _CharT, _Alloc > &__x, const _Rope_iterator< _CharT, _Alloc > &__y)
  • template<class _CharT , class _Alloc > bool __gnu_cxx::operator< (const _Rope_const_iterator< _CharT, _Alloc > &__x, const _Rope_const_iterator< _CharT, _Alloc > &__y)

🔥 operator<< (stream insert)

  • template<class _CharT , class _Traits , class _Alloc > std::basic_ostream< _CharT, _Traits > & __gnu_cxx::operator<< (std::basic_ostream< _CharT, _Traits > &__o, const rope< _CharT, _Alloc > &__r)

🔥 operator<= (less-or-equal)

  • template<class _CharT , class _Alloc > bool __gnu_cxx::operator<= (const rope< _CharT, _Alloc > &__x, const rope< _CharT, _Alloc > &__y)
  • template<class _CharT , class _Alloc > bool __gnu_cxx::operator<= (const _Rope_iterator< _CharT, _Alloc > &__x, const _Rope_iterator< _CharT, _Alloc > &__y)
  • template<class _CharT , class _Alloc > bool __gnu_cxx::operator<= (const _Rope_const_iterator< _CharT, _Alloc > &__x, const _Rope_const_iterator< _CharT, _Alloc > &__y)

🔥 operator== (equal)

  • template<class _CharT , class _Alloc > bool __gnu_cxx::operator== (const rope< _CharT, _Alloc > &__left, const rope< _CharT, _Alloc > &__right)
  • template<class _CharT , class _Alloc > bool __gnu_cxx::operator== (const _Rope_iterator< _CharT, _Alloc > &__x, const _Rope_iterator< _CharT, _Alloc > &__y)
  • template<class _CharT , class _Alloc > bool __gnu_cxx::operator== (const _Rope_const_iterator< _CharT, _Alloc > &__x, const _Rope_const_iterator< _CharT, _Alloc > &__y)
  • template<class _CharT , class _Alloc > bool __gnu_cxx::operator== (const _Rope_char_ptr_proxy< _CharT, _Alloc > &__x, const _Rope_char_ptr_proxy< _CharT, _Alloc > &__y)

🔥 operator> (greater)

  • template<class _CharT , class _Alloc > bool __gnu_cxx::operator> (const rope< _CharT, _Alloc > &__x, const rope< _CharT, _Alloc > &__y)
  • template<class _CharT , class _Alloc > bool __gnu_cxx::operator> (const _Rope_iterator< _CharT, _Alloc > &__x, const _Rope_iterator< _CharT, _Alloc > &__y)
  • template<class _CharT , class _Alloc > bool __gnu_cxx::operator> (const _Rope_const_iterator< _CharT, _Alloc > &__x, const _Rope_const_iterator< _CharT, _Alloc > &__y)

🔥 operator>= (greater-or-equal)

  • template<class _CharT , class _Alloc > bool __gnu_cxx::operator>= (const rope< _CharT, _Alloc > &__x, const rope< _CharT, _Alloc > &__y)
  • template<class _CharT , class _Alloc > bool __gnu_cxx::operator>= (const _Rope_iterator< _CharT, _Alloc > &__x, const _Rope_iterator< _CharT, _Alloc > &__y)
  • template<class _CharT , class _Alloc > bool __gnu_cxx::operator>= (const _Rope_const_iterator< _CharT, _Alloc > &__x, const _Rope_const_iterator< _CharT, _Alloc > &__y)

🔥 swap (the trade)

  • template<class _CharT , class _Alloc > void __gnu_cxx::swap (rope< _CharT, _Alloc > &__x, rope< _CharT, _Alloc > &__y)
  • template<class _CharT , class __Alloc > void __gnu_cxx::swap (_Rope_char_ref_proxy< _CharT, __Alloc > __a, _Rope_char_ref_proxy< _CharT, __Alloc > __b)

🦋 Variables

one variable, standing pretty:

  • rope< _CharT, _Alloc > __gnu_cxx::identity_element (_Rope_Concat_fn< _CharT, _Alloc >)

🌸 Detailed Description 🌸

the actual detailed description says:

This file is a GNU extension to the Standard C++ Library (possibly containing extensions from the HP/SGI STL subset).

and then:

Definition in file rope.

🎀 Author 🎀

the author section says:

Generated automatically by Doxygen for libstdc++ from the source code.

that's the whole rope(3) moment 💖✨ — footer-core says this page came from libstdc++, dated 21 Apr 2009, and the manual page is rope(3). Bye bestie, go be iconic with your includes. 🎀👑

📦 where this page comes from