Skip to content

Commit 5d37328

Browse files
juwentus1234facebook-github-bot
authored andcommitted
refactor: Rename velox casting utilities to camelCase convention
Summary: X-link: facebookincubator/nimble#333 Renamed three function templates in velox's casting utilities to follow the camelCase naming convention: - `checked_pointer_cast` → `checkedPointerCast` - `static_unique_pointer_cast` → `staticUniquePointerCast` - `is_instance_of` → `isInstanceOf` This change affects the function definitions in `/data/users/ericjjj/fbsource/fbcode/velox/common/Casts.h` and all call sites within the velox codebase and related projects that use velox namespaced functions. Files updated: - Function definitions in `velox/common/Casts.h` - Velox core files: `core/PlanNode.cpp`, `exec/Exchange.cpp`, `exec/Task.cpp`, `common/memory/MemoryPool.cpp`, `tool/trace/TopNRowNumberReplayer.cpp` - Test file: `velox/common/testutil/tests/CastsTest.cpp` - updated all test cases - DataInfra/Sequence files that use `facebook::velox::` namespace prefix (8 files) This refactoring improves consistency with velox's naming conventions while maintaining backward compatibility with external codebases that use their own implementations. Differential Revision: D87806227
1 parent a2c7774 commit 5d37328

File tree

7 files changed

+60
-62
lines changed

7 files changed

+60
-62
lines changed

velox/common/Casts.h

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -40,21 +40,21 @@ void ensureCastSucceeded(To* casted, From* original) {
4040

4141
} // namespace detail
4242

43-
// `checked_pointer_cast` is a dynamic casting tool to throw a Velox exception
43+
// `checkedPointerCast` is a dynamic casting tool to throw a Velox exception
4444
// when the casting failed. Use this instead of `std::dynamic_pointer_cast`
4545
// when:
4646
// 1) Casting must happen
4747
// 2) We want a stack trace if it failed.
4848
template <typename To, typename From>
49-
std::shared_ptr<To> checked_pointer_cast(const std::shared_ptr<From>& input) {
49+
std::shared_ptr<To> checkedPointerCast(const std::shared_ptr<From>& input) {
5050
VELOX_CHECK_NOT_NULL(input.get());
5151
auto casted = std::dynamic_pointer_cast<To>(input);
5252
detail::ensureCastSucceeded(casted.get(), input.get());
5353
return casted;
5454
}
5555

5656
template <typename To, typename From>
57-
std::unique_ptr<To> checked_pointer_cast(std::unique_ptr<From> input) {
57+
std::unique_ptr<To> checkedPointerCast(std::unique_ptr<From> input) {
5858
VELOX_CHECK_NOT_NULL(input.get());
5959
auto* released = input.release();
6060
To* casted{nullptr};
@@ -69,37 +69,37 @@ std::unique_ptr<To> checked_pointer_cast(std::unique_ptr<From> input) {
6969
}
7070

7171
template <typename To, typename From>
72-
To* checked_pointer_cast(From* input) {
72+
To* checkedPointerCast(From* input) {
7373
VELOX_CHECK_NOT_NULL(input);
7474
auto* casted = dynamic_cast<To*>(input);
7575
detail::ensureCastSucceeded(casted, input);
7676
return casted;
7777
}
7878

7979
template <typename To, typename From>
80-
std::unique_ptr<To> static_unique_pointer_cast(std::unique_ptr<From> input) {
80+
std::unique_ptr<To> staticUniquePointerCast(std::unique_ptr<From> input) {
8181
VELOX_CHECK_NOT_NULL(input.get());
8282
auto* released = input.release();
8383
auto* casted = static_cast<To*>(released);
8484
return std::unique_ptr<To>(casted);
8585
}
8686

8787
template <typename To, typename From>
88-
bool is_instance_of(const std::shared_ptr<From>& input) {
88+
bool isInstanceOf(const std::shared_ptr<From>& input) {
8989
VELOX_CHECK_NOT_NULL(input.get());
9090
auto* casted = dynamic_cast<const To*>(input.get());
9191
return casted != nullptr;
9292
}
9393

9494
template <typename To, typename From>
95-
bool is_instance_of(const std::unique_ptr<From>& input) {
95+
bool isInstanceOf(const std::unique_ptr<From>& input) {
9696
VELOX_CHECK_NOT_NULL(input.get());
9797
auto* casted = dynamic_cast<const To*>(input.get());
9898
return casted != nullptr;
9999
}
100100

101101
template <typename To, typename From>
102-
bool is_instance_of(const From* input) {
102+
bool isInstanceOf(const From* input) {
103103
VELOX_CHECK_NOT_NULL(input);
104104
auto* casted = dynamic_cast<const To*>(input);
105105
return casted != nullptr;

velox/common/memory/MemoryPool.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -599,7 +599,7 @@ bool MemoryPoolImpl::transferTo(MemoryPool* dest, void* buffer, uint64_t size) {
599599
return false;
600600
}
601601
VELOX_CHECK_NOT_NULL(dest);
602-
auto* destImpl = checked_pointer_cast<MemoryPoolImpl, MemoryPool>(dest);
602+
auto* destImpl = checkedPointerCast<MemoryPoolImpl, MemoryPool>(dest);
603603
if (allocator_ != destImpl->allocator_) {
604604
return false;
605605
}

velox/common/testutil/tests/CastsTest.cpp

Lines changed: 45 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -93,47 +93,47 @@ class CastsTest : public ::testing::Test {
9393
DerivedClass* derivedRawPtr_;
9494
};
9595

96-
// Tests for checked_pointer_cast with shared_ptr
96+
// Tests for checkedPointerCast with shared_ptr
9797
TEST_F(CastsTest, checkedPointerCastSharedPtrSuccess) {
9898
// Cast derived to base (should always work)
99-
auto result = checked_pointer_cast<BaseClass>(derivedPtr_);
99+
auto result = checkedPointerCast<BaseClass>(derivedPtr_);
100100
EXPECT_NE(result, nullptr);
101101
EXPECT_EQ(result->getValue(), 100);
102102

103103
// Cast base to derived when it actually is derived
104104
std::shared_ptr<BaseClass> basePtrToDerived = derivedPtr_;
105-
auto derivedResult = checked_pointer_cast<DerivedClass>(basePtrToDerived);
105+
auto derivedResult = checkedPointerCast<DerivedClass>(basePtrToDerived);
106106
EXPECT_NE(derivedResult, nullptr);
107107
EXPECT_EQ(derivedResult->getValue(), 100);
108108
EXPECT_EQ(derivedResult->getDerivedValue(), 200);
109109
}
110110

111111
TEST_F(CastsTest, checkedPointerCastSharedPtrFailure) {
112112
// Try to cast base to derived when it's not actually derived
113-
VELOX_ASSERT_THROW(checked_pointer_cast<DerivedClass>(basePtr_), "");
113+
VELOX_ASSERT_THROW(checkedPointerCast<DerivedClass>(basePtr_), "");
114114

115115
// Try to cast to unrelated class
116-
VELOX_ASSERT_THROW(checked_pointer_cast<UnrelatedClass>(derivedPtr_), "");
116+
VELOX_ASSERT_THROW(checkedPointerCast<UnrelatedClass>(derivedPtr_), "");
117117
}
118118

119119
TEST_F(CastsTest, checkedPointerCastSharedPtrNullInput) {
120120
std::shared_ptr<BaseClass> nullPtr;
121-
VELOX_ASSERT_THROW(checked_pointer_cast<DerivedClass>(nullPtr), "");
121+
VELOX_ASSERT_THROW(checkedPointerCast<DerivedClass>(nullPtr), "");
122122
}
123123

124-
// Tests for checked_pointer_cast with unique_ptr
124+
// Tests for checkedPointerCast with unique_ptr
125125
TEST_F(CastsTest, checkedPointerCastUniquePtrSuccess) {
126126
// Cast derived to base
127127
auto derivedForCast = std::make_unique<DerivedClass>();
128-
auto result = checked_pointer_cast<BaseClass>(std::move(derivedForCast));
128+
auto result = checkedPointerCast<BaseClass>(std::move(derivedForCast));
129129
EXPECT_NE(result, nullptr);
130130
EXPECT_EQ(result->getValue(), 100);
131131

132132
// Cast base to derived when it actually is derived
133133
std::unique_ptr<BaseClass> basePtrToDerived =
134134
std::make_unique<DerivedClass>();
135135
auto derivedResult =
136-
checked_pointer_cast<DerivedClass>(std::move(basePtrToDerived));
136+
checkedPointerCast<DerivedClass>(std::move(basePtrToDerived));
137137
EXPECT_NE(derivedResult, nullptr);
138138
EXPECT_EQ(derivedResult->getValue(), 100);
139139
EXPECT_EQ(derivedResult->getDerivedValue(), 200);
@@ -143,47 +143,45 @@ TEST_F(CastsTest, checkedPointerCastUniquePtrFailure) {
143143
// Try to cast base to derived when it's not actually derived
144144
auto baseForCast = std::make_unique<BaseClass>();
145145
VELOX_ASSERT_THROW(
146-
checked_pointer_cast<DerivedClass>(std::move(baseForCast)), "");
146+
checkedPointerCast<DerivedClass>(std::move(baseForCast)), "");
147147
}
148148

149149
TEST_F(CastsTest, checkedPointerCastUniquePtrNullInput) {
150150
std::unique_ptr<BaseClass> nullPtr;
151-
VELOX_ASSERT_THROW(
152-
checked_pointer_cast<DerivedClass>(std::move(nullPtr)), "");
151+
VELOX_ASSERT_THROW(checkedPointerCast<DerivedClass>(std::move(nullPtr)), "");
153152
}
154153

155-
// Tests for checked_pointer_cast with raw pointers
154+
// Tests for checkedPointerCast with raw pointers
156155
TEST_F(CastsTest, checkedPointerCastRawPtrSuccess) {
157156
// Cast derived to base
158-
auto result = checked_pointer_cast<BaseClass>(derivedRawPtr_);
157+
auto result = checkedPointerCast<BaseClass>(derivedRawPtr_);
159158
EXPECT_NE(result, nullptr);
160159
EXPECT_EQ(result->getValue(), 100);
161160

162161
// Cast base to derived when it actually is derived
163162
BaseClass* basePtrToDerived = derivedRawPtr_;
164-
auto derivedResult = checked_pointer_cast<DerivedClass>(basePtrToDerived);
163+
auto derivedResult = checkedPointerCast<DerivedClass>(basePtrToDerived);
165164
EXPECT_NE(derivedResult, nullptr);
166165
EXPECT_EQ(derivedResult->getValue(), 100);
167166
EXPECT_EQ(derivedResult->getDerivedValue(), 200);
168167
}
169168

170169
TEST_F(CastsTest, checkedPointerCastRawPtrFailure) {
171170
// Try to cast base to derived when it's not actually derived
172-
VELOX_ASSERT_THROW(checked_pointer_cast<DerivedClass>(baseRawPtr_), "");
171+
VELOX_ASSERT_THROW(checkedPointerCast<DerivedClass>(baseRawPtr_), "");
173172
}
174173

175174
TEST_F(CastsTest, checkedPointerCastRawPtrNullInput) {
176175
BaseClass* nullPtr = nullptr;
177-
VELOX_ASSERT_THROW(checked_pointer_cast<DerivedClass>(nullPtr), "");
176+
VELOX_ASSERT_THROW(checkedPointerCast<DerivedClass>(nullPtr), "");
178177
}
179178

180-
// Tests for static_unique_pointer_cast
179+
// Tests for staticUniquePointerCast
181180
TEST_F(CastsTest, staticUniquePointerCastSuccess) {
182181
// Create a unique_ptr to derived and cast to base
183182
auto derivedForCast = std::make_unique<DerivedClass>();
184183
auto originalPtr = derivedForCast.get();
185-
auto result =
186-
static_unique_pointer_cast<BaseClass>(std::move(derivedForCast));
184+
auto result = staticUniquePointerCast<BaseClass>(std::move(derivedForCast));
187185

188186
EXPECT_NE(result, nullptr);
189187
EXPECT_EQ(result.get(), originalPtr); // Should be the same pointer
@@ -193,65 +191,65 @@ TEST_F(CastsTest, staticUniquePointerCastSuccess) {
193191
TEST_F(CastsTest, staticUniquePointerCastNullInput) {
194192
std::unique_ptr<DerivedClass> nullPtr;
195193
VELOX_ASSERT_THROW(
196-
static_unique_pointer_cast<BaseClass>(std::move(nullPtr)), "");
194+
staticUniquePointerCast<BaseClass>(std::move(nullPtr)), "");
197195
}
198196

199-
// Tests for is_instance_of with shared_ptr
197+
// Tests for isInstanceOf with shared_ptr
200198
TEST_F(CastsTest, isInstanceOfSharedPtr) {
201199
// Test positive cases
202-
EXPECT_TRUE(is_instance_of<BaseClass>(derivedPtr_));
203-
EXPECT_TRUE(is_instance_of<DerivedClass>(derivedPtr_));
204-
EXPECT_TRUE(is_instance_of<BaseClass>(anotherDerivedPtr_));
205-
EXPECT_TRUE(is_instance_of<AnotherDerivedClass>(anotherDerivedPtr_));
200+
EXPECT_TRUE(isInstanceOf<BaseClass>(derivedPtr_));
201+
EXPECT_TRUE(isInstanceOf<DerivedClass>(derivedPtr_));
202+
EXPECT_TRUE(isInstanceOf<BaseClass>(anotherDerivedPtr_));
203+
EXPECT_TRUE(isInstanceOf<AnotherDerivedClass>(anotherDerivedPtr_));
206204

207205
// Test negative cases
208-
EXPECT_FALSE(is_instance_of<DerivedClass>(basePtr_));
209-
EXPECT_FALSE(is_instance_of<AnotherDerivedClass>(derivedPtr_));
210-
EXPECT_FALSE(is_instance_of<DerivedClass>(anotherDerivedPtr_));
211-
EXPECT_FALSE(is_instance_of<UnrelatedClass>(derivedPtr_));
206+
EXPECT_FALSE(isInstanceOf<DerivedClass>(basePtr_));
207+
EXPECT_FALSE(isInstanceOf<AnotherDerivedClass>(derivedPtr_));
208+
EXPECT_FALSE(isInstanceOf<DerivedClass>(anotherDerivedPtr_));
209+
EXPECT_FALSE(isInstanceOf<UnrelatedClass>(derivedPtr_));
212210
}
213211

214212
TEST_F(CastsTest, isInstanceOfSharedPtrNullInput) {
215213
std::shared_ptr<BaseClass> nullPtr;
216-
VELOX_ASSERT_THROW(is_instance_of<DerivedClass>(nullPtr), "");
214+
VELOX_ASSERT_THROW(isInstanceOf<DerivedClass>(nullPtr), "");
217215
}
218216

219-
// Tests for is_instance_of with unique_ptr
217+
// Tests for isInstanceOf with unique_ptr
220218
TEST_F(CastsTest, isInstanceOfUniquePtr) {
221219
// Test positive cases
222-
EXPECT_TRUE(is_instance_of<BaseClass>(derivedUniquePtr_));
223-
EXPECT_TRUE(is_instance_of<DerivedClass>(derivedUniquePtr_));
220+
EXPECT_TRUE(isInstanceOf<BaseClass>(derivedUniquePtr_));
221+
EXPECT_TRUE(isInstanceOf<DerivedClass>(derivedUniquePtr_));
224222

225223
// Test negative cases
226-
EXPECT_FALSE(is_instance_of<DerivedClass>(baseUniquePtr_));
227-
EXPECT_FALSE(is_instance_of<AnotherDerivedClass>(derivedUniquePtr_));
224+
EXPECT_FALSE(isInstanceOf<DerivedClass>(baseUniquePtr_));
225+
EXPECT_FALSE(isInstanceOf<AnotherDerivedClass>(derivedUniquePtr_));
228226
}
229227

230228
TEST_F(CastsTest, isInstanceOfUniquePtrNullInput) {
231229
std::unique_ptr<BaseClass> nullPtr;
232-
VELOX_ASSERT_THROW(is_instance_of<DerivedClass>(nullPtr), "");
230+
VELOX_ASSERT_THROW(isInstanceOf<DerivedClass>(nullPtr), "");
233231
}
234232

235-
// Tests for is_instance_of with raw pointers
233+
// Tests for isInstanceOf with raw pointers
236234
TEST_F(CastsTest, isInstanceOfRawPtr) {
237235
// Test positive cases
238-
EXPECT_TRUE(is_instance_of<BaseClass>(derivedRawPtr_));
239-
EXPECT_TRUE(is_instance_of<DerivedClass>(derivedRawPtr_));
236+
EXPECT_TRUE(isInstanceOf<BaseClass>(derivedRawPtr_));
237+
EXPECT_TRUE(isInstanceOf<DerivedClass>(derivedRawPtr_));
240238

241239
// Test negative cases
242-
EXPECT_FALSE(is_instance_of<DerivedClass>(baseRawPtr_));
243-
EXPECT_FALSE(is_instance_of<AnotherDerivedClass>(derivedRawPtr_));
240+
EXPECT_FALSE(isInstanceOf<DerivedClass>(baseRawPtr_));
241+
EXPECT_FALSE(isInstanceOf<AnotherDerivedClass>(derivedRawPtr_));
244242
}
245243

246244
TEST_F(CastsTest, isInstanceOfRawPtrNullInput) {
247245
BaseClass* nullPtr = nullptr;
248-
VELOX_ASSERT_THROW(is_instance_of<DerivedClass>(nullPtr), "");
246+
VELOX_ASSERT_THROW(isInstanceOf<DerivedClass>(nullPtr), "");
249247
}
250248

251249
// Test error messages contain useful information
252250
TEST_F(CastsTest, errorMessageContent) {
253251
try {
254-
checked_pointer_cast<DerivedClass>(basePtr_);
252+
checkedPointerCast<DerivedClass>(basePtr_);
255253
FAIL() << "Expected VeloxException to be thrown";
256254
} catch (const VeloxException& e) {
257255
const std::string& message = e.message();
@@ -266,12 +264,12 @@ TEST_F(CastsTest, errorMessageContent) {
266264
TEST_F(CastsTest, objectIdentityPreserved) {
267265
// For shared_ptr
268266
std::shared_ptr<BaseClass> basePtrToDerived = derivedPtr_;
269-
auto castedShared = checked_pointer_cast<DerivedClass>(basePtrToDerived);
267+
auto castedShared = checkedPointerCast<DerivedClass>(basePtrToDerived);
270268
EXPECT_EQ(castedShared.get(), derivedPtr_.get());
271269

272270
// For raw ptr
273271
BaseClass* basePtrToDerivedRaw = derivedRawPtr_;
274-
auto castedRaw = checked_pointer_cast<DerivedClass>(basePtrToDerivedRaw);
272+
auto castedRaw = checkedPointerCast<DerivedClass>(basePtrToDerivedRaw);
275273
EXPECT_EQ(castedRaw, derivedRawPtr_);
276274
}
277275

@@ -280,7 +278,7 @@ TEST_F(CastsTest, uniquePtrExceptionSafety) {
280278
auto baseForCast = std::make_unique<BaseClass>();
281279

282280
try {
283-
checked_pointer_cast<DerivedClass>(std::move(baseForCast));
281+
checkedPointerCast<DerivedClass>(std::move(baseForCast));
284282
FAIL() << "Expected VeloxException to be thrown";
285283
} catch (const VeloxException&) {
286284
// The unique_ptr should have been restored and the object should still

velox/core/PlanNode.cpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1829,7 +1829,7 @@ PlanNodePtr IndexLookupJoinNode::create(
18291829
auto sources = deserializeSources(obj, context);
18301830
VELOX_CHECK_EQ(2, sources.size());
18311831
TableScanNodePtr lookupSource =
1832-
checked_pointer_cast<const TableScanNode>(sources[1]);
1832+
checkedPointerCast<const TableScanNode>(sources[1]);
18331833

18341834
auto leftKeys = deserializeFields(obj["leftKeys"], context);
18351835
auto rightKeys = deserializeFields(obj["rightKeys"], context);
@@ -1910,7 +1910,7 @@ bool IndexLookupJoinNode::isSupported(JoinType joinType) {
19101910
}
19111911

19121912
bool isIndexLookupJoin(const PlanNode* planNode) {
1913-
return is_instance_of<IndexLookupJoinNode>(planNode);
1913+
return isInstanceOf<IndexLookupJoinNode>(planNode);
19141914
}
19151915

19161916
// static
@@ -3770,7 +3770,7 @@ void EqualIndexLookupCondition::validate() const {
37703770
VELOX_CHECK_NOT_NULL(key);
37713771
VELOX_CHECK_NOT_NULL(value);
37723772
VELOX_CHECK_NOT_NULL(
3773-
checked_pointer_cast<const ConstantTypedExpr>(value),
3773+
checkedPointerCast<const ConstantTypedExpr>(value),
37743774
"Equal condition value must be a constant expression: {}",
37753775
value->toString());
37763776

velox/exec/Exchange.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ void Exchange::getSplits(ContinueFuture* future) {
109109

110110
if (split.hasConnectorSplit()) {
111111
auto remoteSplit =
112-
checked_pointer_cast<RemoteConnectorSplit>(split.connectorSplit);
112+
checkedPointerCast<RemoteConnectorSplit>(split.connectorSplit);
113113
if (FOLLY_UNLIKELY(splitTracer_ != nullptr)) {
114114
splitTracer_->write(split);
115115
}

velox/exec/Task.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1641,7 +1641,7 @@ void Task::addSplitToStoreLocked(
16411641
return;
16421642
}
16431643
auto* queueSplitsStore =
1644-
checked_pointer_cast<QueueSplitsStore>(splitsStore.get());
1644+
checkedPointerCast<QueueSplitsStore>(splitsStore.get());
16451645
queueSplitsStore->addSplit(split, promises);
16461646
}
16471647

velox/tool/trace/TopNRowNumberReplayer.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ core::PlanNodePtr TopNRowNumberReplayer::createPlanNode(
2929
const core::PlanNodeId& nodeId,
3030
const core::PlanNodePtr& source) const {
3131
const auto* topNRowNumberNode =
32-
checked_pointer_cast<const core::TopNRowNumberNode>(node);
32+
checkedPointerCast<const core::TopNRowNumberNode>(node);
3333
const auto generateRowNumber = topNRowNumberNode->generateRowNumber();
3434
return std::make_shared<core::TopNRowNumberNode>(
3535
nodeId,

0 commit comments

Comments
 (0)