aboutsummaryrefslogtreecommitdiff
path: root/libbutl/small-forward-list.mxx
blob: 6aa4986af068e1f7a0d0d533c18e48847eb598c6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
// file      : libbutl/small-forward-list.mxx -*- C++ -*-
// license   : MIT; see accompanying LICENSE file

#ifndef __cpp_modules_ts
#pragma once
#endif

#ifndef __cpp_lib_modules_ts
#include <cstddef>      // size_t
#include <utility>      // move()
#include <forward_list>
#endif

// Other includes.

#ifdef __cpp_modules_ts
export module butl.small_forward_list;
#ifdef __cpp_lib_modules_ts
import std.core;
#endif
import butl.small_allocator;
#else
#include <libbutl/small-allocator.mxx>
#endif

#include <libbutl/export.hxx>

LIBBUTL_MODEXPORT namespace butl
{
  // Issues and limitations.
  //
  // - Because small_allocator currently expects us to allocate the entire
  //   small buffer and there is no reserve() in std::forward_list, we
  //   currently only support N==1 (which we static_assert).
  //
  // - swap() is deleted (see notes below).
  //
  // - The implementation doesn't allocate T but rather a "node" that normally
  //   consists of a pointers (next) and T.
  //
  template <typename T>
  using small_forward_list_node =
#if   defined (_MSC_VER)
  std::_Flist_node<T, void*>;
#elif defined (__GLIBCXX__)
  std::_Fwd_list_node<T>;
#elif defined (_LIBCPP_VERSION)
  std::__forward_list_node<T, void*>;
#else
#error unknown standard library implementation
#endif

  template <typename T, std::size_t N>
  using small_forward_list_buffer =
    small_allocator_buffer<small_forward_list_node<T>, N>;

  template <typename T, std::size_t N>
  class small_forward_list:
    private small_forward_list_buffer<T, N>,
    public std::forward_list<T,
                             small_allocator<T,
                                             N,
                                             small_forward_list_buffer<T, N>>>
  {
    static_assert (N == 1, "only small_forward_list or 1 currently supported");

  public:
    static constexpr const std::size_t small_size = N;

    using buffer_type = small_forward_list_buffer<T, N>;
    using allocator_type = small_allocator<T, N, buffer_type>;
    using base_type = std::forward_list<T, allocator_type>;

    small_forward_list ()
      : base_type (allocator_type (this)) {}

    small_forward_list (std::initializer_list<T> v)
      : base_type (allocator_type (this))
    {
      static_cast<base_type&> (*this) = v;
    }

    template <typename I>
    small_forward_list (I b, I e)
      : base_type (allocator_type (this))
    {
      this->assign (b, e);
    }

    explicit
    small_forward_list (std::size_t n)
      : base_type (allocator_type (this))
    {
      this->resize (n);
    }

    small_forward_list (std::size_t n, const T& x)
      : base_type (allocator_type (this))
    {
      this->assign (n, x);
    }

    small_forward_list (const small_forward_list& v)
      : buffer_type (), base_type (allocator_type (this))
    {
      static_cast<base_type&> (*this) = v;
    }

    small_forward_list&
    operator= (const small_forward_list& v)
    {
      // Note: propagate_on_container_copy_assignment = false
      //
      static_cast<base_type&> (*this) = v;
      return *this;
    }

    small_forward_list (small_forward_list&& v)
      : base_type (allocator_type (this))
    {
      *this = std::move (v); // Delegate to operator=(&&).
    }

    small_forward_list&
    operator= (small_forward_list&& v)
    {
      // VC14's implementation of operator=(&&) swaps pointers without regard
      // for allocator (fixed in 15).
      //
#if defined(_MSC_VER) && _MSC_VER <= 1900
      clear ();
      for (T& x: v)
        push_front (std::move (x));
      reverse ();
      v.clear ();
#else
      // Note: propagate_on_container_move_assignment = false
      //
      static_cast<base_type&> (*this) = std::move (v);
#endif

      return *this;
    }

    small_forward_list&
    operator= (std::initializer_list<T> v)
    {
      static_cast<base_type&> (*this) = v;
      return *this;
    }

    // Implementing swap() under small buffer optimization is not trivial, to
    // say the least (think of swapping two such buffers of different sizes).
    // One easy option would be to force both in to the heap.
    //
    void
    swap (small_forward_list&) = delete;
  };
}