commit 57c2521bcea370515cbdc686ea17d6ff2d2914ea
parent 08e6a73c09429ea67132f3e75ce81e7de95ea8ca
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Mon, 23 May 2022 14:49:38 +0200
Rename some variables
Diffstat:
2 files changed, 71 insertions(+), 73 deletions(-)
diff --git a/src/shtr_lines_list.c b/src/shtr_lines_list.c
@@ -29,38 +29,36 @@
* Helper functions
******************************************************************************/
static res_T
-create_lines_list
- (struct shtr* shtr,
- struct shtr_lines_list** out_lines)
+create_lines_list(struct shtr* shtr, struct shtr_lines_list** out_list)
{
- struct shtr_lines_list* lnlst = NULL;
+ struct shtr_lines_list* list = NULL;
res_T res = RES_OK;
- ASSERT(shtr && out_lines);
+ ASSERT(shtr && out_list);
- lnlst = MEM_CALLOC(shtr->allocator, 1, sizeof(*lnlst));
- if(!lnlst) {
+ list = MEM_CALLOC(shtr->allocator, 1, sizeof(*list));
+ if(!list) {
log_err(shtr, "Could not allocate the list of lines.\n");
res = RES_MEM_ERR;
goto error;
}
- ref_init(&lnlst->ref);
+ ref_init(&list->ref);
SHTR(ref_get(shtr));
- lnlst->shtr = shtr;
- darray_line_init(shtr->allocator, &lnlst->lines);
+ list->shtr = shtr;
+ darray_line_init(shtr->allocator, &list->lines);
exit:
- *out_lines = lnlst;
+ *out_list = list;
return res;
error:
- if(lnlst) {
- SHTR(lines_list_ref_put(lnlst));
- lnlst = NULL;
+ if(list) {
+ SHTR(lines_list_ref_put(list));
+ list = NULL;
}
goto exit;
}
static res_T
-parse_line(struct shtr_lines_list* lnlst, struct txtrdr* txtrdr)
+parse_line(struct shtr_lines_list* list, struct txtrdr* txtrdr)
{
struct shtr_line ln = SHTR_LINE_NULL;
struct param_desc param = PARAM_DESC_NULL;
@@ -73,12 +71,12 @@ parse_line(struct shtr_lines_list* lnlst, struct txtrdr* txtrdr)
int isotope_id_local;
res_T res = RES_OK;
- ASSERT(lnlst && txtrdr);
+ ASSERT(list && txtrdr);
line = txtrdr_get_line(txtrdr);
ASSERT(line);
- shtr = lnlst->shtr;
+ shtr = list->shtr;
param.path = txtrdr_get_name(txtrdr);
param.line = txtrdr_get_line_num(txtrdr);
@@ -148,17 +146,17 @@ parse_line(struct shtr_lines_list* lnlst, struct txtrdr* txtrdr)
*end = backup;
str = end;
if(strlen(str) != 93) {
- log_err(lnlst->shtr, "%s:%lu: missing data after delta air.\n",
+ log_err(list->shtr, "%s:%lu: missing data after delta air.\n",
param.path, (unsigned long)param.line);
res = RES_BAD_ARG;
goto error;
}
- if(darray_line_size_get(&lnlst->lines)) {
- const struct shtr_line* last_ln = darray_line_cdata_get(&lnlst->lines)
- + darray_line_size_get(&lnlst->lines) - 1;
+ if(darray_line_size_get(&list->lines)) {
+ const struct shtr_line* last_ln = darray_line_cdata_get(&list->lines)
+ + darray_line_size_get(&list->lines) - 1;
if(last_ln->wavenumber > ln.wavenumber) {
- log_err(lnlst->shtr,
+ log_err(list->shtr,
"%s:%lu: lines are not sorted in ascending order wrt their wavenumber.\n",
txtrdr_get_name(txtrdr), txtrdr_get_line_num(txtrdr));
res = RES_BAD_ARG;
@@ -166,9 +164,9 @@ parse_line(struct shtr_lines_list* lnlst, struct txtrdr* txtrdr)
}
}
- res = darray_line_push_back(&lnlst->lines, &ln);
+ res = darray_line_push_back(&list->lines, &ln);
if(res != RES_OK) {
- log_err(lnlst->shtr,
+ log_err(list->shtr,
"%s:%lu: error storing the line -- %s.\n",
param.path, (unsigned long)param.line, res_to_cstr(res));
goto error;
@@ -187,15 +185,15 @@ load_stream
const char* name,
struct shtr_lines_list** out_lines)
{
- struct shtr_lines_list* lnlst = NULL;
+ struct shtr_lines_list* list = NULL;
struct txtrdr* txtrdr = NULL;
res_T res = RES_OK;
ASSERT(shtr && stream && name && out_lines);
- res = create_lines_list(shtr, &lnlst);
+ res = create_lines_list(shtr, &list);
if(res != RES_OK) goto error;
- res = txtrdr_stream(lnlst->shtr->allocator, stream, name,
+ res = txtrdr_stream(list->shtr->allocator, stream, name,
0/*No comment char*/, &txtrdr);
if(res != RES_OK) {
log_err(shtr, "%s: error creating the text reader -- %s.\n",
@@ -212,18 +210,18 @@ load_stream
}
if(!txtrdr_get_cline(txtrdr)) break; /* No more parsed line */
- res = parse_line(lnlst, txtrdr);
+ res = parse_line(list, txtrdr);
if(res != RES_OK) goto error;
}
exit:
if(txtrdr) txtrdr_ref_put(txtrdr);
- *out_lines = lnlst;
+ *out_lines = list;
return res;
error:
- if(lnlst) {
- SHTR(lines_list_ref_put(lnlst));
- lnlst = NULL;
+ if(list) {
+ SHTR(lines_list_ref_put(list));
+ list = NULL;
}
goto exit;
}
@@ -232,12 +230,12 @@ static void
release_lines(ref_T * ref)
{
struct shtr* shtr = NULL;
- struct shtr_lines_list* lnlst = CONTAINER_OF
+ struct shtr_lines_list* list = CONTAINER_OF
(ref, struct shtr_lines_list, ref);
ASSERT(ref);
- shtr = lnlst->shtr;
- darray_line_release(&lnlst->lines);
- MEM_RM(shtr->allocator, lnlst);
+ shtr = list->shtr;
+ darray_line_release(&list->lines);
+ MEM_RM(shtr->allocator, list);
SHTR(ref_put(shtr));
}
@@ -248,12 +246,12 @@ res_T
shtr_lines_list_load
(struct shtr* shtr,
const char* path,
- struct shtr_lines_list** lnlst)
+ struct shtr_lines_list** list)
{
FILE* file = NULL;
res_T res = RES_OK;
- if(!shtr || !path || !lnlst) {
+ if(!shtr || !path || !list) {
res = RES_BAD_ARG;
goto error;
}
@@ -265,7 +263,7 @@ shtr_lines_list_load
goto error;
}
- res = load_stream(shtr, file, path, lnlst);
+ res = load_stream(shtr, file, path, list);
if(res != RES_OK) goto error;
exit:
@@ -280,30 +278,30 @@ shtr_lines_list_load_stream
(struct shtr* shtr,
FILE* stream,
const char* stream_name,
- struct shtr_lines_list** lnlst)
+ struct shtr_lines_list** list)
{
- if(!shtr || !stream || !lnlst) return RES_BAD_ARG;
+ if(!shtr || !stream || !list) return RES_BAD_ARG;
return load_stream
- (shtr, stream, stream_name ? stream_name : "<stream>", lnlst);
+ (shtr, stream, stream_name ? stream_name : "<stream>", list);
}
res_T
shtr_lines_list_create_from_stream
(struct shtr* shtr,
FILE* stream,
- struct shtr_lines_list** out_lnlst)
+ struct shtr_lines_list** out_list)
{
- struct shtr_lines_list* lnlst = NULL;
+ struct shtr_lines_list* list = NULL;
size_t nlines;
int version = 0;
res_T res = RES_OK;
- if(!shtr || !out_lnlst || !stream) {
+ if(!shtr || !out_list || !stream) {
res = RES_BAD_ARG;
goto error;
}
- res = create_lines_list(shtr, &lnlst);
+ res = create_lines_list(shtr, &list);
if(res != RES_OK) goto error;
#define READ(Var, Nb) { \
@@ -324,95 +322,95 @@ shtr_lines_list_create_from_stream
if(version != SHTR_LINES_LIST_VERSION) {
log_err(shtr,
"%s: unexpected line list version %d. "
- "Experting a line list in version %d.\n",
+ "Expecting a line list in version %d.\n",
FUNC_NAME, version, SHTR_LINES_LIST_VERSION);
res = RES_BAD_ARG;
goto error;
}
- READ(&nlines, 1);
- res = darray_line_resize(&lnlst->lines, nlines);
+ READ(&nlines, 1);
+ res = darray_line_resize(&list->lines, nlines);
if(res != RES_OK) {
log_err(shtr, "%s: error allocating the line list -- %s.\n",
FUNC_NAME, res_to_cstr(res));
goto error;
}
- READ(darray_line_data_get(&lnlst->lines), nlines);
+ READ(darray_line_data_get(&list->lines), nlines);
#undef READ
exit:
- if(out_lnlst) *out_lnlst = lnlst;
+ if(out_list) *out_list = list;
return res;
error:
- if(lnlst) {
- SHTR(lines_list_ref_put(lnlst));
- lnlst = NULL;
+ if(list) {
+ SHTR(lines_list_ref_put(list));
+ list = NULL;
}
goto exit;
}
res_T
-shtr_lines_list_ref_get(struct shtr_lines_list* lnlst)
+shtr_lines_list_ref_get(struct shtr_lines_list* list)
{
- if(!lnlst) return RES_BAD_ARG;
- ref_get(&lnlst->ref);
+ if(!list) return RES_BAD_ARG;
+ ref_get(&list->ref);
return RES_OK;
}
res_T
-shtr_lines_list_ref_put(struct shtr_lines_list* lnlst)
+shtr_lines_list_ref_put(struct shtr_lines_list* list)
{
- if(!lnlst) return RES_BAD_ARG;
- ref_put(&lnlst->ref, release_lines);
+ if(!list) return RES_BAD_ARG;
+ ref_put(&list->ref, release_lines);
return RES_OK;
}
res_T
shtr_lines_list_get_size
- (const struct shtr_lines_list* lnlst,
+ (const struct shtr_lines_list* list,
size_t* nlines)
{
- if(!lnlst || !nlines) return RES_BAD_ARG;
- *nlines = darray_line_size_get(&lnlst->lines);
+ if(!list || !nlines) return RES_BAD_ARG;
+ *nlines = darray_line_size_get(&list->lines);
return RES_OK;
}
res_T
shtr_lines_list_get
- (const struct shtr_lines_list* lnlst,
+ (const struct shtr_lines_list* list,
const struct shtr_line* lines_list[])
{
- if(!lnlst || !lines_list) return RES_BAD_ARG;
- *lines_list = darray_line_cdata_get(&lnlst->lines);
+ if(!list || !lines_list) return RES_BAD_ARG;
+ *lines_list = darray_line_cdata_get(&list->lines);
return RES_OK;
}
res_T
shtr_lines_list_write
- (const struct shtr_lines_list* lnlst,
+ (const struct shtr_lines_list* list,
FILE* stream)
{
size_t nlines = 0;
res_T res = RES_OK;
- if(!lnlst || !stream) {
+ if(!list || !stream) {
res = RES_BAD_ARG;
goto error;
}
- nlines = darray_line_size_get(&lnlst->lines);
+ nlines = darray_line_size_get(&list->lines);
#define WRITE(Var, Nb) { \
if(fwrite((Var), sizeof(*(Var)), (Nb), stream) != (Nb)) { \
- log_err(lnlst->shtr, "%s: error writing line list.\n", FUNC_NAME); \
+ log_err(list->shtr, "%s: error writing line list.\n", FUNC_NAME); \
res = RES_IO_ERR; \
goto error; \
} \
} (void)0
WRITE(&SHTR_LINES_LIST_VERSION, 1);
WRITE(&nlines, 1);
- WRITE(darray_line_cdata_get(&lnlst->lines), nlines);
+ WRITE(darray_line_cdata_get(&list->lines), nlines);
#undef WRITE
exit:
diff --git a/src/shtr_lines_list_c.h b/src/shtr_lines_list_c.h
@@ -29,8 +29,8 @@
struct shtr;
-/* Version of the lines list. One should increment it and perform a version
- * management onto serialized data when the lines list structure are updated. */
+/* Version of the line list. One should increment it and perform a version
+ * management onto serialized data when the line list structure are updated. */
static const int SHTR_LINES_LIST_VERSION = 0;
struct shtr_lines_list {
