-
Notifications
You must be signed in to change notification settings - Fork 185
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add a dedicated class to manage lifetime of string handles.
It is much easier to use and correctly handles null handles.
- Loading branch information
1 parent
c0f62f6
commit 8dde4aa
Showing
6 changed files
with
127 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| /** | ||
| * @file string_handle_holder.h | ||
| * | ||
| * @section LICENSE | ||
| * | ||
| * The MIT License | ||
| * | ||
| * @copyright Copyright (c) 2017-2023 TileDB, Inc. | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| * of this software and associated documentation files (the "Software"), to deal | ||
| * in the Software without restriction, including without limitation the rights | ||
| * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| * copies of the Software, and to permit persons to whom the Software is | ||
| * furnished to do so, subject to the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be included in | ||
| * all copies or substantial portions of the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| * THE SOFTWARE. | ||
| * | ||
| * @section DESCRIPTION | ||
| * | ||
| * This file declares the C++ API for the TileDB StringHandleHolder object. | ||
| */ | ||
|
|
||
| #ifndef TILEDB_CPP_API_STRING_HANDLE_HOLDER_H | ||
| #define TILEDB_CPP_API_STRING_HANDLE_HOLDER_H | ||
|
|
||
| #include <cassert> | ||
| #include <optional> | ||
| #include <stdexcept> | ||
| #include "tiledb.h" | ||
|
|
||
| namespace tiledb::impl { | ||
|
|
||
| /** | ||
| * Manages the lifetime of a tiledb_string_t* handle and provides operations on | ||
| * it. | ||
| */ | ||
| class StringHandleHolder { | ||
| public: | ||
| StringHandleHolder() { | ||
| string_ = nullptr; | ||
| } | ||
| ~StringHandleHolder() { | ||
| if (string_ == nullptr) { | ||
| return; | ||
| } | ||
|
|
||
| capi_status_t result = tiledb_status(tiledb_string_free(&string_)); | ||
| if (result != TILEDB_OK) { | ||
| log_warn("Could not free string; Error code: " + std::to_string(result)); | ||
| } | ||
| } | ||
|
|
||
| // Disable copy and move. | ||
| StringHandleHolder(const StringHandleHolder&) = delete; | ||
| StringHandleHolder operator=(const StringHandleHolder&) = delete; | ||
| StringHandleHolder(const StringHandleHolder&&) = delete; | ||
| StringHandleHolder operator=(const StringHandleHolder&&) = delete; | ||
|
|
||
| /** | ||
| * Returns a tiledb_string_t** pointer to be passed in native code. | ||
| * This method should be called only once. | ||
| */ | ||
| inline tiledb_string_t** c_ptr() { | ||
| // We should call this function only once when the object is uninitialized. | ||
| assert(string_ == nullptr); | ||
| return &string_; | ||
| } | ||
|
|
||
| /** | ||
| * Returns a C++ string with the handle's data. | ||
| * | ||
| * If the handle is null, returns a defaullt value, which is the empty string | ||
| * if not specified. | ||
| */ | ||
| inline std::string str(const std::string& default_value = "") const { | ||
| return str_opt().value_or(default_value); | ||
| } | ||
|
|
||
| /** | ||
| * Returns a C++ string with the handle's data, or nullopt if the handle is | ||
| * null. | ||
| */ | ||
| std::optional<std::string> str_opt() const { | ||
| if (string_ == nullptr) { | ||
| return std::nullopt; | ||
| } | ||
| const char* c; | ||
| size_t size; | ||
| capi_status_t status = | ||
| tiledb_status(tiledb_string_view(string_, &c, &size)); | ||
| if (status != TILEDB_OK) { | ||
| throw std::runtime_error( | ||
| "Could not view string; Error code: " + std::to_string(status)); | ||
| } | ||
| return std::string(c, size); | ||
| } | ||
|
|
||
| private: | ||
| tiledb_string_t* string_; | ||
| }; | ||
|
|
||
| } // namespace tiledb::impl | ||
|
|
||
| #endif // TILEDB_CPP_API_STRING_HANDLE_HOLDER_H |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters