From 13b955a15ac352667b2509bed238be2fc54a810b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Henrik=20tom=20W=C3=B6rden?= <henrik@trineo.org>
Date: Wed, 25 Aug 2021 10:31:29 +0200
Subject: [PATCH] MAINT: rename get_env_var to get_env_fallback
---
include/caosdb/utility.h | 6 +++---
include/ccaosdb.h | 2 +-
src/ccaosdb.cpp | 4 ++--
test/test_ccaosdb.cpp | 6 +++---
4 files changed, 9 insertions(+), 9 deletions(-)
diff --git a/include/caosdb/utility.h b/include/caosdb/utility.h
index 0cadf66..8b69bc2 100644
--- a/include/caosdb/utility.h
+++ b/include/caosdb/utility.h
@@ -97,7 +97,7 @@ inline auto load_string_file(const path &path) -> std::string {
/**
* @brief Return the environment variable KEY, or FALLBACK if it does not exist.
*/
-inline auto get_env_var(const char *key, const char *fallback) -> const char * {
+inline auto get_env_fallback(const char *key, const char *fallback) -> const char * {
const char *val = getenv(key);
if (val == nullptr) {
return fallback;
@@ -110,8 +110,8 @@ inline auto get_env_var(const char *key, const char *fallback) -> const char * {
* @brief Return the value of an environment variable or - if undefined - the
* fallback value.
*/
-inline auto get_env_var(const std::string &key, const std::string &fallback) -> const std::string {
- const char *val = get_env_var(key.c_str(), fallback.c_str());
+inline auto get_env_fallback(const std::string &key, const std::string &fallback) -> const std::string {
+ const char *val = get_env_fallback(key.c_str(), fallback.c_str());
auto const result = std::string(val);
return result;
diff --git a/include/ccaosdb.h b/include/ccaosdb.h
index b06f3ec..e643e0d 100644
--- a/include/ccaosdb.h
+++ b/include/ccaosdb.h
@@ -112,7 +112,7 @@ typedef struct {
*
* If the environment variable is not set, return the fallback instead.
*/
-const char *caosdb_utility_get_env_var(const char *name, const char *fallback);
+const char *caosdb_utility_get_env_fallback(const char *name, const char *fallback);
/**
* Return a description of the status code.
diff --git a/src/ccaosdb.cpp b/src/ccaosdb.cpp
index d5165c9..bd2cbf6 100644
--- a/src/ccaosdb.cpp
+++ b/src/ccaosdb.cpp
@@ -170,8 +170,8 @@ const char *caosdb_constants_COMPATIBLE_SERVER_VERSION_PRE_RELEASE() {
int caosdb_status_code_OTHER_CLIENT_ERROR() { return caosdb::StatusCode::OTHER_CLIENT_ERROR; }
-const char *caosdb_utility_get_env_var(const char *name, const char *fallback) {
- return caosdb::utility::get_env_var(name, fallback);
+const char *caosdb_utility_get_env_fallback(const char *name, const char *fallback) {
+ return caosdb::utility::get_env_fallback(name, fallback);
}
const char *caosdb_get_status_description(int code) {
diff --git a/test/test_ccaosdb.cpp b/test/test_ccaosdb.cpp
index fe91428..475a5d1 100644
--- a/test/test_ccaosdb.cpp
+++ b/test/test_ccaosdb.cpp
@@ -23,7 +23,7 @@
#include "caosdb/configuration.h"
#include "caosdb/status_code.h" // for StatusCode
#include "caosdb_test_utility.h" // for EXPECT_THROW_MESSAGE, TEST_DATA_DIR
-#include "ccaosdb.h" // for caosdb_utility_get_env_var
+#include "ccaosdb.h" // for caosdb_utility_get_env_fallback
#include <cstring> // for strcmp
#include <gtest/gtest-message.h> // for Message
#include <gtest/gtest-test-part.h> // for SuiteApiResolver, TestFactoryImpl
@@ -42,8 +42,8 @@ protected:
void TearDown() override { caosdb::configuration::ConfigurationManager::Clear(); }
};
-TEST_F(test_ccaosdb, test_get_env_var) {
- const char *const some_var = caosdb_utility_get_env_var("SOME_ENV_VAR", "fall-back");
+TEST_F(test_ccaosdb, test_get_env_fallback) {
+ const char *const some_var = caosdb_utility_get_env_fallback("SOME_ENV_VAR", "fall-back");
EXPECT_EQ("fall-back", some_var);
}
--
GitLab