djsundog/circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rename "environ" errors to "getenv" errors

Browse Source
This commit is contained in:
Jeff Epler 2022-12-09 14:14:53 -06:00
parent 678a466d1a
commit 44f15d563d
No known key found for this signature in database
GPG Key ID: D5BF15AB975AB4DE
5 changed files with 24 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
ports/espressif/common-hal/_bleio/Adapter.c
View File

@ -103,8 +103,8 @@ void common_hal_bleio_adapter_set_enabled(bleio_adapter_obj_t *self, bool enable
#if CIRCUITPY_OS_GETENV
char ble_name[1 + MYNEWT_VAL_BLE_SVC_GAP_DEVICE_NAME_MAX_LENGTH];
os_environ_err_t result = common_hal_os_getenv_str("CIRCUITPY_BLE_NAME", ble_name, sizeof(ble_name));
if (result == ENVIRON_OK) {
os_getenv_err_t result = common_hal_os_getenv_str("CIRCUITPY_BLE_NAME", ble_name, sizeof(ble_name));
if (result == GETENV_OK) {
ble_svc_gap_device_name_set(ble_name);
} else
#endif

2
ports/espressif/supervisor/port.c
View File

@ -519,7 +519,7 @@ void port_idle_until_interrupt(void) {
void port_post_boot_py(bool heap_valid) {
if (!heap_valid && filesystem_present()) {
mp_int_t reserved;
if (common_hal_os_getenv_int("CIRCUITPY_RESERVED_PSRAM", &reserved) == ENVIRON_OK) {
if (common_hal_os_getenv_int("CIRCUITPY_RESERVED_PSRAM", &reserved) == GETENV_OK) {
common_hal_espidf_set_reserved_psram(reserved);
}
common_hal_espidf_reserve_psram();

8
shared-module/os/__init__.h
View File

@ -27,19 +27,19 @@
#pragma once
typedef enum {
ENVIRON_OK = 0,
GETENV_OK = 0,
ENVIRON_ERR_OPEN,
ENVIRON_ERR_UNICODE,
ENVIRON_ERR_LENGTH,
ENVIRON_ERR_NOT_FOUND,
ENVIRON_ERR_UNEXPECTED = 0xff00, // logical or'd with the byte value
} os_environ_err_t;
} os_getenv_err_t;
// Allocation free version that returns the full length of the value.
// If it fits, the return value is 0-terminated. If the value doesn't fit,
// *value_len may be an over-estimate but never an under-estimate.
os_environ_err_t common_hal_os_getenv_str(const char *key, char *value, size_t value_len);
os_getenv_err_t common_hal_os_getenv_str(const char *key, char *value, size_t value_len);
// Returns ENVIRON_ERR_OK and sets value to the read value. Returns
// ENVIRON_ERR_... if the value was not numeric. allocation-free.
os_environ_err_t common_hal_os_environ_get_key_int(const char *key, mp_int_t *value);
os_getenv_err_t common_hal_os_environ_get_key_int(const char *key, mp_int_t *value);

30
shared-module/os/getenv.c
View File

@ -39,7 +39,7 @@
#include "supervisor/filesystem.h"
#include "supervisor/memory.h"
#define ENVIRON_PATH "settings.toml"
#define GETENV_PATH "settings.toml"
#if defined(UNIX)
typedef FILE *file_arg;
@ -178,7 +178,7 @@ STATIC bool key_matches(file_arg *active_file, const char *key) {
return true;
}
STATIC os_environ_err_t read_unicode_escape(file_arg *active_file, int sz, vstr_t *buf) {
STATIC os_getenv_err_t read_unicode_escape(file_arg *active_file, int sz, vstr_t *buf) {
char hex_buf[sz + 1];
for (int i = 0; i < sz; i++) {
hex_buf[i] = get_next_byte(active_file);
@ -197,7 +197,7 @@ STATIC os_environ_err_t read_unicode_escape(file_arg *active_file, int sz, vstr_
}
// Read a quoted string
STATIC os_environ_err_t read_string_value(file_arg *active_file, vstr_t *buf) {
STATIC os_getenv_err_t read_string_value(file_arg *active_file, vstr_t *buf) {
while (true) {
int character = get_next_byte(active_file);
switch (character) {
@ -244,7 +244,7 @@ STATIC os_environ_err_t read_string_value(file_arg *active_file, vstr_t *buf) {
case 'U':
case 'u': {
int sz = (character == 'u') ? 4 : 8;
os_environ_err_t res;
os_getenv_err_t res;
res = read_unicode_escape(active_file, sz, buf);
if (res != ENVIRON_OK) {
return res;
@ -262,7 +262,7 @@ STATIC os_environ_err_t read_string_value(file_arg *active_file, vstr_t *buf) {
}
// Read a numeric value (non-quoted value) as a string
STATIC os_environ_err_t read_bare_value(file_arg *active_file, vstr_t *buf, int first_character) {
STATIC os_getenv_err_t read_bare_value(file_arg *active_file, vstr_t *buf, int first_character) {
int character = first_character;
while (true) {
switch (character) {
@ -292,13 +292,13 @@ STATIC mp_int_t read_value(file_arg *active_file, vstr_t *buf, bool *quoted) {
}
}
STATIC os_environ_err_t os_environ_get_key_vstr(const char *path, const char *key, vstr_t *buf, bool *quoted) {
STATIC os_getenv_err_t os_environ_get_key_vstr(const char *path, const char *key, vstr_t *buf, bool *quoted) {
file_arg active_file;
if (!open_file(path, &active_file)) {
return ENVIRON_ERR_OPEN;
}
os_environ_err_t result = ENVIRON_ERR_NOT_FOUND;
os_getenv_err_t result = ENVIRON_ERR_NOT_FOUND;
while (!is_eof(&active_file)) {
if (key_matches(&active_file, key)) {
result = read_value(&active_file, buf, quoted);
@ -308,10 +308,10 @@ STATIC os_environ_err_t os_environ_get_key_vstr(const char *path, const char *ke
return result;
}
STATIC os_environ_err_t os_environ_get_key_buf_terminated(const char *key, char *value, size_t value_len, bool *quoted) {
STATIC os_getenv_err_t os_environ_get_key_buf_terminated(const char *key, char *value, size_t value_len, bool *quoted) {
vstr_t buf;
vstr_init_fixed_buf(&buf, value_len, value);
os_environ_err_t result = os_environ_get_key_vstr(ENVIRON_PATH, key, &buf, quoted);
os_getenv_err_t result = os_environ_get_key_vstr(ENVIRON_PATH, key, &buf, quoted);
if (result == ENVIRON_OK) {
vstr_add_byte_nonstd(&buf, 0);
@ -323,16 +323,16 @@ STATIC os_environ_err_t os_environ_get_key_buf_terminated(const char *key, char
return result;
}
os_environ_err_t common_hal_os_getenv_str(const char *key, char *value, size_t value_len) {
os_getenv_err_t common_hal_os_getenv_str(const char *key, char *value, size_t value_len) {
bool quoted;
os_environ_err_t result = os_environ_get_key_buf_terminated(key, value, value_len, &quoted);
os_getenv_err_t result = os_environ_get_key_buf_terminated(key, value, value_len, &quoted);
if (result == ENVIRON_OK && !quoted) {
result = ENVIRON_ERR_UNEXPECTED | value[0];
}
return result;
}
STATIC void throw__environ_error(os_environ_err_t error) {
STATIC void throw__environ_error(os_getenv_err_t error) {
if (error == ENVIRON_OK) {
return;
}
@ -366,7 +366,7 @@ mp_obj_t common_hal_os_getenv_path(const char *path, const char *key, mp_obj_t d
bool quoted;
vstr_init(&buf, 64);
os_environ_err_t result = os_environ_get_key_vstr(path, key, &buf, &quoted);
os_getenv_err_t result = os_environ_get_key_vstr(path, key, &buf, &quoted);
if (result == ENVIRON_ERR_NOT_FOUND) {
return default_;
}
@ -383,10 +383,10 @@ mp_obj_t common_hal_os_getenv(const char *key, mp_obj_t default_) {
return common_hal_os_getenv_path(ENVIRON_PATH, key, default_);
}
os_environ_err_t common_hal_os_environ_get_key_int(const char *key, mp_int_t *value) {
os_getenv_err_t common_hal_os_environ_get_key_int(const char *key, mp_int_t *value) {
char buf[16];
bool quoted;
os_environ_err_t result = os_environ_get_key_buf_terminated(key, buf, sizeof(buf), &quoted);
os_getenv_err_t result = os_environ_get_key_buf_terminated(key, buf, sizeof(buf), &quoted);
if (result != ENVIRON_OK) {
return result;
}

4
supervisor/shared/web_workflow/web_workflow.c
View File

@ -251,8 +251,8 @@ void supervisor_start_web_workflow(void) {
size_t ssid_len = 0;
size_t password_len = 0;
os_environ_err_t result = common_hal_os_getenv_str("CIRCUITPY_WIFI_SSID", ssid, sizeof(ssid));
if (result != ENVIRON_OK) {
os_getenv_err_t result = common_hal_os_getenv_str("CIRCUITPY_WIFI_SSID", ssid, sizeof(ssid));
if (result != GETENV_OK) {
return;
}