tool: return code variable consistency

- ParameterError variables are named 'err'
- CURLcode variables are named 'result'

For naming consistency across functions

Closes #20426
This commit is contained in:
Daniel Stenberg 2026-01-25 11:17:32 +01:00
parent 4e5908306a
commit d0dc6e2ec0
No known key found for this signature in database
GPG key ID: 5CC908FDB71E12C2
8 changed files with 301 additions and 293 deletions

View file

@ -216,7 +216,7 @@ static char *c_escape(const char *str, curl_off_t len)
result = curlx_dyn_addf(&escaped,
/* Octal escape to avoid >2 digit hex. */
(len > 1 && ISXDIGIT(s[1])) ?
"\\%03o" : "\\x%02x",
"\\%03o" : "\\x%02x",
(unsigned int)*(const unsigned char *)s);
}
}
@ -235,14 +235,14 @@ static char *c_escape(const char *str, curl_off_t len)
CURLcode tool_setopt_enum(CURL *curl, const char *name, CURLoption tag,
const struct NameValue *nvlist, long lval)
{
CURLcode ret = CURLE_OK;
CURLcode result = CURLE_OK;
bool skip = FALSE;
ret = curl_easy_setopt(curl, tag, lval);
result = curl_easy_setopt(curl, tag, lval);
if(!lval)
skip = TRUE;
if(global->libcurl && !skip && !ret) {
if(global->libcurl && !skip && !result) {
/* we only use this for real if --libcurl was used */
const struct NameValue *nv = NULL;
for(nv = nvlist; nv->name; nv++) {
@ -253,34 +253,34 @@ CURLcode tool_setopt_enum(CURL *curl, const char *name, CURLoption tag,
/* If no definition was found, output an explicit value.
* This could happen if new values are defined and used
* but the NameValue list is not updated. */
ret = easysrc_addf(&easysrc_code, "curl_easy_setopt(hnd, %s, %ldL);",
name, lval);
}
else {
ret = easysrc_addf(&easysrc_code, "curl_easy_setopt(hnd, %s, (long)%s);",
name, nv->name);
result = easysrc_addf(&easysrc_code, "curl_easy_setopt(hnd, %s, %ldL);",
name, lval);
}
else
result =
easysrc_addf(&easysrc_code, "curl_easy_setopt(hnd, %s, (long)%s);",
name, nv->name);
}
#ifdef DEBUGBUILD
if(ret)
warnf("option %s returned error (%d)", name, (int)ret);
if(result)
warnf("option %s returned error (%d)", name, (int)result);
#endif
return ret;
return result;
}
/* setopt wrapper for CURLOPT_SSLVERSION */
CURLcode tool_setopt_SSLVERSION(CURL *curl, const char *name, CURLoption tag,
long lval)
{
CURLcode ret = CURLE_OK;
CURLcode result = CURLE_OK;
bool skip = FALSE;
ret = curl_easy_setopt(curl, tag, lval);
result = curl_easy_setopt(curl, tag, lval);
if(!lval)
skip = TRUE;
if(global->libcurl && !skip && !ret) {
if(global->libcurl && !skip && !result) {
/* we only use this for real if --libcurl was used */
const struct NameValue *nv = NULL;
const struct NameValue *nv2 = NULL;
@ -296,28 +296,28 @@ CURLcode tool_setopt_SSLVERSION(CURL *curl, const char *name, CURLoption tag,
/* If no definition was found, output an explicit value.
* This could happen if new values are defined and used
* but the NameValue list is not updated. */
ret = easysrc_addf(&easysrc_code, "curl_easy_setopt(hnd, %s, %ldL);",
name, lval);
result = easysrc_addf(&easysrc_code, "curl_easy_setopt(hnd, %s, %ldL);",
name, lval);
}
else {
if(nv2->name && *nv2->name)
/* if max is set */
ret = easysrc_addf(&easysrc_code,
"curl_easy_setopt(hnd, %s, (long)(%s | %s));",
name, nv->name, nv2->name);
result = easysrc_addf(&easysrc_code,
"curl_easy_setopt(hnd, %s, (long)(%s | %s));",
name, nv->name, nv2->name);
else
/* without a max */
ret = easysrc_addf(&easysrc_code,
"curl_easy_setopt(hnd, %s, (long)%s);",
name, nv->name);
result = easysrc_addf(&easysrc_code,
"curl_easy_setopt(hnd, %s, (long)%s);",
name, nv->name);
}
}
#ifdef DEBUGBUILD
if(ret)
warnf("option %s returned error (%d)", name, (int)ret);
if(result)
warnf("option %s returned error (%d)", name, (int)result);
#endif
return ret;
return result;
}
/* setopt wrapper for bitmasks */
@ -326,11 +326,11 @@ CURLcode tool_setopt_bitmask(CURL *curl, const char *name, CURLoption tag,
long lval)
{
bool skip = FALSE;
CURLcode ret = curl_easy_setopt(curl, tag, lval);
CURLcode result = curl_easy_setopt(curl, tag, lval);
if(!lval)
skip = TRUE;
if(global->libcurl && !skip && !ret) {
if(global->libcurl && !skip && !result) {
/* we only use this for real if --libcurl was used */
char preamble[80];
unsigned long rest = (unsigned long)lval;
@ -341,9 +341,9 @@ CURLcode tool_setopt_bitmask(CURL *curl, const char *name, CURLoption tag,
if((nv->value & ~rest) == 0) {
/* all value flags contained in rest */
rest &= ~nv->value; /* remove bits handled here */
ret = easysrc_addf(&easysrc_code, "%s(long)%s%s",
result = easysrc_addf(&easysrc_code, "%s(long)%s%s",
preamble, nv->name, rest ? " |" : ");");
if(!rest || ret)
if(!rest || result)
break; /* handled them all */
/* replace with all spaces for continuation line */
curl_msnprintf(preamble, sizeof(preamble), "%*s",
@ -353,42 +353,43 @@ CURLcode tool_setopt_bitmask(CURL *curl, const char *name, CURLoption tag,
/* If any bits have no definition, output an explicit value.
* This could happen if new bits are defined and used
* but the NameValue list is not updated. */
if(rest && !ret)
ret = easysrc_addf(&easysrc_code, "%s%luUL);", preamble, rest);
if(rest && !result)
result = easysrc_addf(&easysrc_code, "%s%luUL);", preamble, rest);
}
return ret;
return result;
}
/* Generate code for a struct curl_slist. */
static CURLcode libcurl_generate_slist(struct curl_slist *slist, int *slistno)
{
CURLcode ret = CURLE_OK;
CURLcode result = CURLE_OK;
/* May need several slist variables, so invent name */
*slistno = ++easysrc_slist_count;
ret = easysrc_addf(&easysrc_decl, "struct curl_slist *slist%d;", *slistno);
if(!ret)
ret = easysrc_addf(&easysrc_data, "slist%d = NULL;", *slistno);
if(!ret)
ret = easysrc_addf(&easysrc_clean, "curl_slist_free_all(slist%d);",
*slistno);
if(!ret)
ret = easysrc_addf(&easysrc_clean, "slist%d = NULL;", *slistno);
if(ret)
return ret;
for(; slist && !ret; slist = slist->next) {
result = easysrc_addf(&easysrc_decl, "struct curl_slist *slist%d;",
*slistno);
if(!result)
result = easysrc_addf(&easysrc_data, "slist%d = NULL;", *slistno);
if(!result)
result = easysrc_addf(&easysrc_clean, "curl_slist_free_all(slist%d);",
*slistno);
if(!result)
result = easysrc_addf(&easysrc_clean, "slist%d = NULL;", *slistno);
if(result)
return result;
for(; slist && !result; slist = slist->next) {
char *escaped = c_escape(slist->data, ZERO_TERMINATED);
if(!escaped)
return CURLE_OUT_OF_MEMORY;
ret = easysrc_addf(&easysrc_data,
"slist%d = curl_slist_append(slist%d, \"%s\");",
*slistno, *slistno, escaped);
result = easysrc_addf(&easysrc_data,
"slist%d = curl_slist_append(slist%d, \"%s\");",
*slistno, *slistno, escaped);
curlx_free(escaped);
}
return ret;
return result;
}
static CURLcode libcurl_generate_mime(CURL *curl,
@ -402,39 +403,40 @@ static CURLcode libcurl_generate_mime_part(CURL *curl,
struct tool_mime *part,
int mimeno)
{
CURLcode ret = CURLE_OK;
CURLcode result = CURLE_OK;
int submimeno = 0;
const char *data = NULL;
const char *filename = part->filename;
/* Parts are linked in reverse order. */
if(part->prev)
ret = libcurl_generate_mime_part(curl, config, part->prev, mimeno);
result = libcurl_generate_mime_part(curl, config, part->prev, mimeno);
/* Create the part. */
if(!ret)
ret = easysrc_addf(&easysrc_code, "part%d = curl_mime_addpart(mime%d);",
mimeno, mimeno);
if(ret)
return ret;
if(!result)
result = easysrc_addf(&easysrc_code, "part%d = curl_mime_addpart(mime%d);",
mimeno, mimeno);
if(result)
return result;
switch(part->kind) {
case TOOLMIME_PARTS:
ret = libcurl_generate_mime(curl, config, part, &submimeno);
if(!ret) {
ret = easysrc_addf(&easysrc_code, "curl_mime_subparts(part%d, mime%d);",
mimeno, submimeno);
if(!ret)
result = libcurl_generate_mime(curl, config, part, &submimeno);
if(!result) {
result =
easysrc_addf(&easysrc_code, "curl_mime_subparts(part%d, mime%d);",
mimeno, submimeno);
if(!result)
/* Avoid freeing in CLEAN. */
ret = easysrc_addf(&easysrc_code, "mime%d = NULL;", submimeno);
result = easysrc_addf(&easysrc_code, "mime%d = NULL;", submimeno);
}
break;
case TOOLMIME_DATA:
data = part->data;
if(!ret) {
if(!result) {
char *escaped = c_escape(data, ZERO_TERMINATED);
ret =
result =
easysrc_addf(&easysrc_code,
"curl_mime_data(part%d, \"%s\", CURL_ZERO_TERMINATED);",
mimeno, escaped);
@ -445,11 +447,12 @@ static CURLcode libcurl_generate_mime_part(CURL *curl,
case TOOLMIME_FILE:
case TOOLMIME_FILEDATA: {
char *escaped = c_escape(part->data, ZERO_TERMINATED);
ret = easysrc_addf(&easysrc_code,
"curl_mime_filedata(part%d, \"%s\");", mimeno, escaped);
if(part->kind == TOOLMIME_FILEDATA && !filename && !ret) {
ret = easysrc_addf(&easysrc_code,
"curl_mime_filename(part%d, NULL);", mimeno);
result =
easysrc_addf(&easysrc_code,
"curl_mime_filedata(part%d, \"%s\");", mimeno, escaped);
if(part->kind == TOOLMIME_FILEDATA && !filename && !result) {
result = easysrc_addf(&easysrc_code,
"curl_mime_filename(part%d, NULL);", mimeno);
}
curlx_free(escaped);
break;
@ -461,59 +464,59 @@ static CURLcode libcurl_generate_mime_part(CURL *curl,
FALLTHROUGH();
case TOOLMIME_STDINDATA:
/* Can only be reading stdin in the current context. */
ret = easysrc_addf(&easysrc_code, "curl_mime_data_cb(part%d, -1, "
"(curl_read_callback) fread, \\", mimeno);
if(!ret)
ret = easysrc_addf(&easysrc_code, " "
"(curl_seek_callback) fseek, NULL, stdin);");
result = easysrc_addf(&easysrc_code, "curl_mime_data_cb(part%d, -1, "
"(curl_read_callback) fread, \\", mimeno);
if(!result)
result = easysrc_addf(&easysrc_code, " "
"(curl_seek_callback) fseek, NULL, stdin);");
break;
default:
/* Other cases not possible in this context. */
break;
}
if(!ret && part->encoder) {
if(!result && part->encoder) {
char *escaped = c_escape(part->encoder, ZERO_TERMINATED);
ret = easysrc_addf(&easysrc_code, "curl_mime_encoder(part%d, \"%s\");",
mimeno, escaped);
result = easysrc_addf(&easysrc_code, "curl_mime_encoder(part%d, \"%s\");",
mimeno, escaped);
curlx_free(escaped);
}
if(!ret && filename) {
if(!result && filename) {
char *escaped = c_escape(filename, ZERO_TERMINATED);
ret = easysrc_addf(&easysrc_code, "curl_mime_filename(part%d, \"%s\");",
mimeno, escaped);
result = easysrc_addf(&easysrc_code, "curl_mime_filename(part%d, \"%s\");",
mimeno, escaped);
curlx_free(escaped);
}
if(!ret && part->name) {
if(!result && part->name) {
char *escaped = c_escape(part->name, ZERO_TERMINATED);
ret = easysrc_addf(&easysrc_code, "curl_mime_name(part%d, \"%s\");",
mimeno, escaped);
result = easysrc_addf(&easysrc_code, "curl_mime_name(part%d, \"%s\");",
mimeno, escaped);
curlx_free(escaped);
}
if(!ret && part->type) {
if(!result && part->type) {
char *escaped = c_escape(part->type, ZERO_TERMINATED);
ret = easysrc_addf(&easysrc_code, "curl_mime_type(part%d, \"%s\");",
mimeno, escaped);
result = easysrc_addf(&easysrc_code, "curl_mime_type(part%d, \"%s\");",
mimeno, escaped);
curlx_free(escaped);
}
if(!ret && part->headers) {
if(!result && part->headers) {
int slistno;
ret = libcurl_generate_slist(part->headers, &slistno);
if(!ret) {
ret = easysrc_addf(&easysrc_code,
"curl_mime_headers(part%d, slist%d, 1);",
mimeno, slistno);
if(!ret)
ret = easysrc_addf(&easysrc_code, "slist%d = NULL;", slistno);
result = libcurl_generate_slist(part->headers, &slistno);
if(!result) {
result = easysrc_addf(&easysrc_code,
"curl_mime_headers(part%d, slist%d, 1);",
mimeno, slistno);
if(!result)
result = easysrc_addf(&easysrc_code, "slist%d = NULL;", slistno);
}
}
return ret;
return result;
}
/* Wrapper to generate source code for a mime structure. */
@ -522,29 +525,29 @@ static CURLcode libcurl_generate_mime(CURL *curl,
struct tool_mime *toolmime,
int *mimeno)
{
CURLcode ret = CURLE_OK;
CURLcode result = CURLE_OK;
/* May need several mime variables, so invent name. */
*mimeno = ++easysrc_mime_count;
ret = easysrc_addf(&easysrc_decl, "curl_mime *mime%d;", *mimeno);
if(!ret)
ret = easysrc_addf(&easysrc_data, "mime%d = NULL;", *mimeno);
if(!ret)
ret = easysrc_addf(&easysrc_code, "mime%d = curl_mime_init(hnd);",
*mimeno);
if(!ret)
ret = easysrc_addf(&easysrc_clean, "curl_mime_free(mime%d);", *mimeno);
if(!ret)
ret = easysrc_addf(&easysrc_clean, "mime%d = NULL;", *mimeno);
result = easysrc_addf(&easysrc_decl, "curl_mime *mime%d;", *mimeno);
if(!result)
result = easysrc_addf(&easysrc_data, "mime%d = NULL;", *mimeno);
if(!result)
result = easysrc_addf(&easysrc_code, "mime%d = curl_mime_init(hnd);",
*mimeno);
if(!result)
result = easysrc_addf(&easysrc_clean, "curl_mime_free(mime%d);", *mimeno);
if(!result)
result = easysrc_addf(&easysrc_clean, "mime%d = NULL;", *mimeno);
if(toolmime->subparts && !ret) {
ret = easysrc_addf(&easysrc_decl, "curl_mimepart *part%d;", *mimeno);
if(!ret)
ret = libcurl_generate_mime_part(curl, config,
toolmime->subparts, *mimeno);
if(toolmime->subparts && !result) {
result = easysrc_addf(&easysrc_decl, "curl_mimepart *part%d;", *mimeno);
if(!result)
result = libcurl_generate_mime_part(curl, config,
toolmime->subparts, *mimeno);
}
return ret;
return result;
}
/* setopt wrapper for CURLOPT_MIMEPOST */
@ -552,38 +555,40 @@ CURLcode tool_setopt_mimepost(CURL *curl, struct OperationConfig *config,
const char *name, CURLoption tag,
curl_mime *mimepost)
{
CURLcode ret = curl_easy_setopt(curl, tag, mimepost);
CURLcode result = curl_easy_setopt(curl, tag, mimepost);
int mimeno = 0;
if(!ret && global->libcurl) {
ret = libcurl_generate_mime(curl, config, config->mimeroot, &mimeno);
if(!result && global->libcurl) {
result = libcurl_generate_mime(curl, config, config->mimeroot, &mimeno);
if(!ret)
ret = easysrc_addf(&easysrc_code, "curl_easy_setopt(hnd, %s, mime%d);",
name, mimeno);
if(!result)
result =
easysrc_addf(&easysrc_code, "curl_easy_setopt(hnd, %s, mime%d);",
name, mimeno);
}
return ret;
return result;
}
/* setopt wrapper for curl_slist options */
CURLcode tool_setopt_slist(CURL *curl, const char *name, CURLoption tag,
struct curl_slist *list)
{
CURLcode ret = CURLE_OK;
CURLcode result = CURLE_OK;
ret = curl_easy_setopt(curl, tag, list);
result = curl_easy_setopt(curl, tag, list);
if(global->libcurl && list && !ret) {
if(global->libcurl && list && !result) {
int i;
ret = libcurl_generate_slist(list, &i);
if(!ret)
ret = easysrc_addf(&easysrc_code, "curl_easy_setopt(hnd, %s, slist%d);",
name, i);
result = libcurl_generate_slist(list, &i);
if(!result)
result =
easysrc_addf(&easysrc_code, "curl_easy_setopt(hnd, %s, slist%d);",
name, i);
}
return ret;
return result;
}
/* options that set long */
@ -592,7 +597,7 @@ CURLcode tool_setopt_long(CURL *curl, const char *name, CURLoption tag,
{
long defval = 0L;
const struct NameValue *nv = NULL;
CURLcode ret = CURLE_OK;
CURLcode result = CURLE_OK;
DEBUGASSERT(tag < CURLOPTTYPE_OBJECTPOINT);
for(nv = setopt_nv_CURLNONZERODEFAULTS; nv->name; nv++) {
@ -602,30 +607,31 @@ CURLcode tool_setopt_long(CURL *curl, const char *name, CURLoption tag,
}
}
ret = curl_easy_setopt(curl, tag, lval);
if((lval != defval) && global->libcurl && !ret) {
result = curl_easy_setopt(curl, tag, lval);
if((lval != defval) && global->libcurl && !result) {
/* we only use this for real if --libcurl was used */
ret = easysrc_addf(&easysrc_code, "curl_easy_setopt(hnd, %s, %ldL);",
name, lval);
result = easysrc_addf(&easysrc_code, "curl_easy_setopt(hnd, %s, %ldL);",
name, lval);
}
return ret;
return result;
}
/* options that set curl_off_t */
CURLcode tool_setopt_offt(CURL *curl, const char *name, CURLoption tag,
curl_off_t lval)
{
CURLcode ret = CURLE_OK;
CURLcode result = CURLE_OK;
DEBUGASSERT((tag >= CURLOPTTYPE_OFF_T) && (tag < CURLOPTTYPE_BLOB));
ret = curl_easy_setopt(curl, tag, lval);
if(global->libcurl && !ret && lval) {
result = curl_easy_setopt(curl, tag, lval);
if(global->libcurl && !result && lval) {
/* we only use this for real if --libcurl was used */
ret = easysrc_addf(&easysrc_code, "curl_easy_setopt(hnd, %s, (curl_off_t)%"
CURL_FORMAT_CURL_OFF_T ");", name, lval);
result =
easysrc_addf(&easysrc_code, "curl_easy_setopt(hnd, %s, (curl_off_t)%"
CURL_FORMAT_CURL_OFF_T ");", name, lval);
}
return ret;
return result;
}
/* setopt wrapper for setting object and function pointers */