Skip to content

Commit 1202d79

Browse files
authored
GH-46207: [C++] Rename arrow::util::StringBuilder and move to internal namespace (#46813)
### Rationale for this change - Move and Rename function `arrow::util::StringBuilder` to internal namespace to avoid confusion with class `arrow::StringBuilder` ### What changes are included in this PR? - Move `arrow::util::StringBuilder` to `arrow::internal::StringBuilder` - Rename `arrow::internal::StringBuilder` to `arrow::internal::JoinToString` - Rename `arrow/util/string_builder.{h|cc}` to `arrow/util/string_util_internal.{h|cc}` ### Are these changes tested? Yes. ### Are there any user-facing changes? No. they are used internally. * GitHub Issue: #46207 Authored-by: Ziy1-Tan <[email protected]> Signed-off-by: Antoine Pitrou <[email protected]>
1 parent 2bdcbda commit 1202d79

File tree

12 files changed

+41
-51
lines changed

12 files changed

+41
-51
lines changed

cpp/src/arrow/CMakeLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -517,7 +517,7 @@ set(ARROW_UTIL_SRCS
517517
util/ree_util.cc
518518
util/secure_string.cc
519519
util/string.cc
520-
util/string_builder.cc
520+
util/string_util.cc
521521
util/task_group.cc
522522
util/tdigest.cc
523523
util/thread_pool.cc

cpp/src/arrow/flight/transport/grpc/util_internal.cc

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
#include "arrow/flight/types.h"
3030
#include "arrow/status.h"
3131
#include "arrow/util/string.h"
32-
#include "arrow/util/string_builder.h"
32+
#include "arrow/util/string_util.h"
3333

3434
namespace arrow {
3535

@@ -134,9 +134,10 @@ static TransportStatus TransportStatusFromGrpc(const ::grpc::Status& grpc_status
134134
return TransportStatus{TransportStatusCode::kUnauthenticated,
135135
grpc_status.error_message()};
136136
default:
137-
return TransportStatus{TransportStatusCode::kUnknown,
138-
util::StringBuilder("(", grpc_status.error_code(), ")",
139-
grpc_status.error_message())};
137+
return TransportStatus{
138+
TransportStatusCode::kUnknown,
139+
arrow::internal::JoinToString("(", grpc_status.error_code(), ")",
140+
grpc_status.error_message())};
140141
}
141142
}
142143

cpp/src/arrow/flight/types.cc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
#include "arrow/util/formatting.h"
3838
#include "arrow/util/logging.h"
3939
#include "arrow/util/string.h"
40-
#include "arrow/util/string_builder.h"
40+
#include "arrow/util/string_util.h"
4141
#include "arrow/util/uri.h"
4242

4343
namespace arrow {
@@ -189,8 +189,8 @@ static std::ostream& operator<<(std::ostream& os, std::map<std::string, T> m) {
189189
// Wrapper types for Flight RPC protobuf messages
190190

191191
std::string BasicAuth::ToString() const {
192-
return arrow::util::StringBuilder("<BasicAuth username='", username,
193-
"' password=(redacted)>");
192+
return arrow::internal::JoinToString("<BasicAuth username='", username,
193+
"' password=(redacted)>");
194194
}
195195

196196
bool BasicAuth::Equals(const BasicAuth& other) const {
@@ -886,8 +886,8 @@ Status FlightPayload::Validate() const {
886886
}
887887

888888
std::string ActionType::ToString() const {
889-
return arrow::util::StringBuilder("<ActionType type='", type, "' description='",
890-
description, "'>");
889+
return arrow::internal::JoinToString("<ActionType type='", type, "' description='",
890+
description, "'>");
891891
}
892892

893893
const ActionType ActionType::kCancelFlightInfo =
@@ -930,7 +930,7 @@ arrow::Status ActionType::Deserialize(std::string_view serialized, ActionType* o
930930
}
931931

932932
std::string Criteria::ToString() const {
933-
return arrow::util::StringBuilder("<Criteria expression='", expression, "'>");
933+
return arrow::internal::JoinToString("<Criteria expression='", expression, "'>");
934934
}
935935

936936
bool Criteria::Equals(const Criteria& other) const {

cpp/src/arrow/meson.build

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ arrow_util_srcs = [
199199
'util/mutex.cc',
200200
'util/ree_util.cc',
201201
'util/string.cc',
202-
'util/string_builder.cc',
202+
'util/string_util.cc',
203203
'util/task_group.cc',
204204
'util/tdigest.cc',
205205
'util/thread_pool.cc',

cpp/src/arrow/status.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323

2424
#include "arrow/util/compare.h"
2525
#include "arrow/util/macros.h"
26-
#include "arrow/util/string_builder.h"
26+
#include "arrow/util/string_util.h"
2727
#include "arrow/util/visibility.h"
2828

2929
#ifdef ARROW_EXTRA_ERROR_CONTEXT
@@ -181,13 +181,13 @@ class ARROW_EXPORT [[nodiscard]] Status : public util::EqualityComparable<Status
181181

182182
template <typename... Args>
183183
static Status FromArgs(StatusCode code, Args&&... args) {
184-
return Status(code, util::StringBuilder(std::forward<Args>(args)...));
184+
return Status(code, internal::JoinToString(std::forward<Args>(args)...));
185185
}
186186

187187
template <typename... Args>
188188
static Status FromDetailAndArgs(StatusCode code, std::shared_ptr<StatusDetail> detail,
189189
Args&&... args) {
190-
return Status(code, util::StringBuilder(std::forward<Args>(args)...),
190+
return Status(code, internal::JoinToString(std::forward<Args>(args)...),
191191
std::move(detail));
192192
}
193193

cpp/src/arrow/testing/gtest_util.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
#include "arrow/type_fwd.h"
4141
#include "arrow/type_traits.h"
4242
#include "arrow/util/macros.h"
43-
#include "arrow/util/string_builder.h"
43+
#include "arrow/util/string_util.h"
4444
#include "arrow/util/type_fwd.h"
4545

4646
// NOTE: failing must be inline in the macros below, to get correct file / line number
@@ -142,7 +142,7 @@
142142
// A generalized version of GTest's SCOPED_TRACE that takes arbitrary arguments.
143143
// ARROW_SCOPED_TRACE("some variable = ", some_variable, ...)
144144

145-
#define ARROW_SCOPED_TRACE(...) SCOPED_TRACE(::arrow::util::StringBuilder(__VA_ARGS__))
145+
#define ARROW_SCOPED_TRACE(...) SCOPED_TRACE(::arrow::internal::JoinToString(__VA_ARGS__))
146146

147147
namespace arrow {
148148

cpp/src/arrow/util/bitmap.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
#include "arrow/util/endian.h"
3838
#include "arrow/util/functional.h"
3939
#include "arrow/util/span.h"
40-
#include "arrow/util/string_builder.h"
40+
#include "arrow/util/string_util.h"
4141
#include "arrow/util/visibility.h"
4242

4343
namespace arrow {

cpp/src/arrow/util/bitset_stack_internal.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
#include "arrow/util/compare.h"
3939
#include "arrow/util/functional.h"
4040
#include "arrow/util/macros.h"
41-
#include "arrow/util/string_builder.h"
41+
#include "arrow/util/string_util.h"
4242
#include "arrow/util/type_traits.h"
4343
#include "arrow/util/visibility.h"
4444

cpp/src/arrow/util/meson.build

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ install_headers(
160160
'simd.h',
161161
'small_vector.h',
162162
'span.h',
163-
'string_builder.h',
163+
'string_util.h',
164164
'string.h',
165165
'task_group.h',
166166
'test_common.h',

cpp/src/arrow/util/string_builder.cc renamed to cpp/src/arrow/util/string_util.cc

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,13 @@
1515
// specific language governing permissions and limitations
1616
// under the License.
1717

18-
#include "arrow/util/string_builder.h"
18+
#include "arrow/util/string_util.h"
1919

2020
#include <memory>
2121
#include <sstream>
2222

2323
namespace arrow {
24-
25-
namespace util {
26-
namespace detail {
24+
namespace internal {
2725

2826
StringStreamWrapper::StringStreamWrapper()
2927
: sstream_(std::make_unique<std::ostringstream>()), ostream_(*sstream_) {}
@@ -32,6 +30,5 @@ StringStreamWrapper::~StringStreamWrapper() {}
3230

3331
std::string StringStreamWrapper::str() { return sstream_->str(); }
3432

35-
} // namespace detail
36-
} // namespace util
33+
} // namespace internal
3734
} // namespace arrow

0 commit comments

Comments
 (0)