Skip to content

Commit

Permalink
Add support for initializer_list on arrays
Browse files Browse the repository at this point in the history
While these array classes are deprecated in the user code, they're still
used, for compatibility, in many places in wxWidgets API and allowing to
create them from initializer_list makes using it more ergonomic as it's
now possible to just pass an initializer list of items to fill the
control with, for example, instead of appending them one by one.

Ref wxWidgets#23309.
  • Loading branch information
Lotendan committed Oct 14, 2023
1 parent cc7fefd commit 29585d2
Show file tree
Hide file tree
Showing 5 changed files with 45 additions and 0 deletions.
6 changes: 6 additions & 0 deletions include/wx/arrstr.h
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
#if wxUSE_STD_CONTAINERS_COMPATIBLY
#include <vector>
#endif
#include <initializer_list>

// these functions are only used in STL build now but we define them in any
// case for compatibility with the existing code outside of the library which
Expand Down Expand Up @@ -83,6 +84,8 @@ class WXDLLIMPEXP_BASE wxArrayString : public wxArrayStringBase
wxArrayString(size_t sz, const char** a);
wxArrayString(size_t sz, const wchar_t** a);
wxArrayString(size_t sz, const wxString* a);
template<typename U>
wxArrayString(std::initializer_list<U> list) : wxArrayStringBase(list) { }

int Index(const wxString& str, bool bCase = true, bool bFromEnd = false) const;

Expand Down Expand Up @@ -184,6 +187,9 @@ class WXDLLIMPEXP_BASE wxArrayString
wxArrayString(size_t sz, const wxString* a);
// copy ctor
wxArrayString(const wxArrayString& array);
// list constructor
template<typename U>
wxArrayString(std::initializer_list<U> list) { Init(false); assign(list.begin(), list.end()); }
// assignment operator
wxArrayString& operator=(const wxArrayString& src);
// not virtual, this class should not be derived from
Expand Down
7 changes: 7 additions & 0 deletions include/wx/dynarray.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@

#include "wx/vector.h"

#include <initializer_list>

/*
This header defines legacy dynamic arrays and object arrays (i.e. arrays
which own their elements) classes.
Expand Down Expand Up @@ -105,6 +107,9 @@ class wxBaseArray : public wxVector<T>
: base_vec(first, last)
{ }

template<typename U>
wxBaseArray(std::initializer_list<U> list) : base_vec(list.begin(), list.end()) {}

void Empty() { this->clear(); }
void Clear() { this->clear(); }
void Alloc(size_t uiSize) { this->reserve(uiSize); }
Expand Down Expand Up @@ -519,6 +524,8 @@ class wxBaseObjectArray : private wxBaseArray<T*>
name(size_t n, Base::const_reference v) : Base(n, v) { } \
template <class InputIterator> \
name(InputIterator first, InputIterator last) : Base(first, last) { } \
template<typename U> \
name(std::initializer_list<U> list) : Base(list.begin(), list.end()) { } \
}


Expand Down
8 changes: 8 additions & 0 deletions interface/wx/arrstr.h
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,14 @@ class wxArrayString : public wxArray
*/
wxArrayString(size_t sz, const wxString* arr);

/**
Constructs the container with the contents of the initializer_list @a list.
@since 3.2.3
*/
template<typename T>
wxArrayString(std::initializer_list<T> list);

/**
Destructor frees memory occupied by the array strings. For performance
reasons it is not virtual, so this class should not be derived from.
Expand Down
8 changes: 8 additions & 0 deletions interface/wx/dynarray.h
Original file line number Diff line number Diff line change
Expand Up @@ -271,6 +271,14 @@ class wxArray<T>
*/
wxObjArray(const wxObjArray& array);

/**
Constructs the container with the contents of the initializer_list @a list.
@since 3.2.3
*/
template<typename T>
wxArray(std::initializer_list<T> list);

/**
Performs a shallow array copy (i.e.\ doesn't copy the objects pointed to
even if the source array contains the items of pointer type).
Expand Down
16 changes: 16 additions & 0 deletions tests/arrays/arrays.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -340,6 +340,19 @@ TEST_CASE("wxArrayString", "[dynarray]")
CHECK( a7.size() == 1 );

wxCLANG_WARNING_RESTORE(self-assign-overloaded)

wxArrayString a8( { wxT("dog"), wxT("human"), wxT("condor"), wxT("thermit"), wxT("alligator") } );
CHECK( a8.size() == 5 );
CHECK( a8[1] == "human" );
CHECK( a8[4] == "alligator" );

a8 = { wxT("Foo") }; // Test operator=
CHECK( a8.size() == 1 );
CHECK( a8[0] == "Foo" );

// Same test with std::initializer_list<std::string>
wxArrayString a9( { std::string("dog"), std::string("human"), std::string("condor"), std::string("thermit"), std::string("alligator") } );
CHECK( a9.size() == 5 );
}

TEST_CASE("wxSortedArrayString", "[dynarray]")
Expand Down Expand Up @@ -623,6 +636,9 @@ TEST_CASE("wxDynArray::" #name, "[dynarray]") \
CHECK( b.Index( 5 ) == 2 ); \
CHECK( b.Index( 6 ) == wxNOT_FOUND ); \
CHECK( b.Index( 17 ) == 3 ); \
\
wxArray##name c({1,2,3}); \
CHECK(c.size() == 3); \
}

TestArrayOf(UShort)
Expand Down

0 comments on commit 29585d2

Please sign in to comment.