Skip to content

fix: rename C iterator bindings to follow new/free pattern #129

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 31, 2023
Merged

fix: rename C iterator bindings to follow new/free pattern #129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions libs/common/include/launchdarkly/bindings/c/value.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,9 +185,9 @@ LD_EXPORT(unsigned int) LDValue_Count(LDValue val);
*
* @param value Target LDValue. Must not be NULL.
* @return Iterator, or NULL if not an array-type. The iterator
* must should be destroyed with LDValue_DestroyArrayIter.
* must should be destroyed with LDValue_ArrayIter_Free.
*/
LD_EXPORT(LDValue_ArrayIter) LDValue_CreateArrayIter(LDValue val);
LD_EXPORT(LDValue_ArrayIter) LDValue_ArrayIter_New(LDValue val);

/**
* Move the array-type iterator to the next item. Should only be done for an
Expand Down Expand Up @@ -219,7 +219,7 @@ LD_EXPORT(LDValue) LDValue_ArrayIter_Value(LDValue_ArrayIter iter);
* Destroy an array iterator.
* @param iter The iterator to destroy.
*/
LD_EXPORT(void) LDValue_DestroyArrayIter(LDValue_ArrayIter iter);
LD_EXPORT(void) LDValue_ArrayIter_Free(LDValue_ArrayIter iter);

/**
* Obtain iterator over an object-type LDValue, otherwise NULL.
Expand All @@ -228,9 +228,9 @@ LD_EXPORT(void) LDValue_DestroyArrayIter(LDValue_ArrayIter iter);
*
* @param value Target LDValue. Must not be NULL.
* @return Iterator, or NULL if not an object-type. The iterator
* must should be destroyed with LDValue_DestroyObjectIter.
* must should be destroyed with LDValue_ObjectIter_Free.
*/
LD_EXPORT(LDValue_ObjectIter) LDValue_CreateObjectIter(LDValue val);
LD_EXPORT(LDValue_ObjectIter) LDValue_ObjectIter_New(LDValue val);

/**
* Move the object-type iterator to the next item. Should only be done for an
Expand Down Expand Up @@ -272,7 +272,7 @@ LD_EXPORT(char const*) LDValue_ObjectIter_Key(LDValue_ObjectIter iter);
* Destroy an object iterator.
* @param iter The iterator to destroy.
*/
LD_EXPORT(void) LDValue_DestroyObjectIter(LDValue_ObjectIter iter);
LD_EXPORT(void) LDValue_ObjectIter_Free(LDValue_ObjectIter iter);

#ifdef __cplusplus
}
Expand Down
8 changes: 4 additions & 4 deletions libs/common/src/bindings/c/value.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ LD_EXPORT(unsigned int) LDValue_Count(LDValue val) {
}
}

LD_EXPORT(LDValue_ArrayIter) LDValue_CreateArrayIter(LDValue val) {
LD_EXPORT(LDValue_ArrayIter) LDValue_ArrayIter_New(LDValue val) {
LD_ASSERT_NOT_NULL(val);

if (AS_VALUE(val)->IsArray()) {
Expand Down Expand Up @@ -126,13 +126,13 @@ LD_EXPORT(LDValue) LDValue_ArrayIter_Value(LDValue_ArrayIter iter) {
return AS_LDVALUE(const_cast<Value*>(&(*val_iter->iter)));
}

LD_EXPORT(void) LDValue_DestroyArrayIter(LDValue_ArrayIter iter) {
LD_EXPORT(void) LDValue_ArrayIter_Free(LDValue_ArrayIter iter) {
LD_ASSERT_NOT_NULL(iter);

delete AS_ARR_ITER(iter);
}

LD_EXPORT(LDValue_ObjectIter) LDValue_CreateObjectIter(LDValue val) {
LD_EXPORT(LDValue_ObjectIter) LDValue_ObjectIter_New(LDValue val) {
LD_ASSERT_NOT_NULL(val);

if (AS_VALUE(val)->IsObject()) {
Expand Down Expand Up @@ -171,7 +171,7 @@ LD_EXPORT(char const*) LDValue_ObjectIter_Key(LDValue_ObjectIter iter) {
return val_iter->iter->first.c_str();
}

LD_EXPORT(void) LDValue_DestroyObjectIter(LDValue_ObjectIter iter) {
LD_EXPORT(void) LDValue_ObjectIter_Free(LDValue_ObjectIter iter) {
LD_ASSERT_NOT_NULL(iter);

delete AS_OBJ_ITER(iter);
Expand Down
8 changes: 4 additions & 4 deletions libs/common/tests/bindings/value_test.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ TEST(ValueCBindingTests, CanCreateArray) {

EXPECT_EQ(LDValueType_Array, LDValue_Type(val_ptr));

auto* iter = LDValue_CreateArrayIter(val_ptr);
auto* iter = LDValue_ArrayIter_New(val_ptr);

auto index = 0;
while (!LDValue_ArrayIter_End(iter)) {
Expand All @@ -102,7 +102,7 @@ TEST(ValueCBindingTests, CanCreateArray) {
index++;
}

LDValue_DestroyArrayIter(iter);
LDValue_ArrayIter_Free(iter);

// Should have iterated 4 items.
EXPECT_EQ(4, index);
Expand All @@ -128,7 +128,7 @@ TEST(ValueCBindingTests, CanCreateObject) {

EXPECT_EQ(LDValueType_Object, LDValue_Type(val_ptr));

auto* iter = LDValue_CreateObjectIter(val_ptr);
auto* iter = LDValue_ObjectIter_New(val_ptr);

auto index = 0;
while (!LDValue_ObjectIter_End(iter)) {
Expand Down Expand Up @@ -159,7 +159,7 @@ TEST(ValueCBindingTests, CanCreateObject) {
LDValue_ObjectIter_Next(iter);
}

LDValue_DestroyObjectIter(iter);
LDValue_ObjectIter_Free(iter);

// Should have iterated 4 items.
EXPECT_EQ(4, index);
Expand Down