mirrors/pv
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Refer to "bytes" rather than "length", so that in future we can differentiate between the number of bytes in a string and how many display columns it occupies.

Browse Source
This commit is contained in:
Andrew Wood
2024-12-07 17:17:59 +00:00
parent b428e7613d
commit c4c7b9ec00
3 changed files with 50 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/include/pv-internal.h
+3 -3
View File
@@ -191,13 +191,13 @@ struct pvstate_s {
struct { /* format string broken into display components */
size_t str_start; /* for strings: start offset */
size_t str_length; /* for strings: length */
size_t str_bytes; /* for strings: length in bytes */
pv_display_component type; /* type of display component */
} format[PV_FORMAT_ARRAY_MAX];
struct { /* display components */
char content[PV_SIZEOF_COMPONENT_STR]; /* string to display */
size_t length; /* number of bytes in string */
size_t bytes; /* number of bytes in string */
bool required; /* true if included in format */
} component[PV_COMPONENT__MAX];
@@ -207,7 +207,7 @@ struct pvstate_s {
size_t display_buffer_size; /* size allocated to display buffer */
size_t display_string_len; /* length of string in display buffer */
off_t initial_offset; /* offset when first opened (when watching fds) */
size_t lastoutput_length; /* number of last-output bytes to show */
size_t lastoutput_bytes; /* number of last-output bytes to show */
size_t format_segment_count; /* number of format string segments */
src/pv/display.c
+34 -34
View File
@@ -446,7 +446,7 @@ static void pv__format_init(pvstate_t state, /*@null@ */ const char *format_supp
if (state->control.name) {
(void) pv_snprintf(display->component[PV_COMPONENT_NAME].content, PV_SIZEOF_COMPONENT_STR,
"%9.500s:", state->control.name);
display->component[PV_COMPONENT_NAME].length = strlen(display->component[PV_COMPONENT_NAME].content); /* flawfinder: ignore */
display->component[PV_COMPONENT_NAME].bytes = strlen(display->component[PV_COMPONENT_NAME].content); /* flawfinder: ignore */
/* flawfinder: content always bounded thanks to pv_snprintf(). */
}
@@ -477,7 +477,7 @@ static void pv__format_init(pvstate_t state, /*@null@ */ const char *format_supp
segment = 0;
for (strpos = 0; format_used[strpos] != '\0' && segment < PV_FORMAT_ARRAY_MAX; strpos++, segment++) {
pv_display_component seg_type;
size_t str_start, str_length;
size_t str_start, str_bytes;
if ('%' == format_used[strpos]) {
unsigned long number_prefix;
@@ -508,7 +508,7 @@ static void pv__format_init(pvstate_t state, /*@null@ */ const char *format_supp
seg_type = PV_COMPONENT_STRING;
str_start = 0;
str_length = 0;
str_bytes = 0;
switch (format_used[strpos]) {
case 'p':
@@ -529,7 +529,7 @@ static void pv__format_init(pvstate_t state, /*@null@ */ const char *format_supp
number_prefix = PV_SIZEOF_LASTOUTPUT_BUFFER;
if (number_prefix < 1)
number_prefix = 1;
display->lastoutput_length = (size_t) number_prefix;
display->lastoutput_bytes = (size_t) number_prefix;
break;
case 'r':
seg_type = PV_COMPONENT_RATE;
@@ -550,19 +550,19 @@ static void pv__format_init(pvstate_t state, /*@null@ */ const char *format_supp
/* %% => % */
seg_type = PV_COMPONENT_STRING;
str_start = strpos;
str_length = 1;
str_bytes = 1;
break;
case '\0':
/* % at end => just % */
seg_type = PV_COMPONENT_STRING;
str_start = strpos - 1;
str_length = 1;
str_bytes = 1;
break;
default:
/* %z (unknown) => %z */
seg_type = PV_COMPONENT_STRING;
str_start = strpos - 1;
str_length = 2;
str_bytes = 2;
break;
}
} else {
@@ -579,7 +579,7 @@ static void pv__format_init(pvstate_t state, /*@null@ */ const char *format_supp
seg_type = PV_COMPONENT_STRING;
str_start = strpos;
str_length = (size_t) foundlength;
str_bytes = (size_t) foundlength;
strpos += foundlength - 1;
}
@@ -589,7 +589,7 @@ static void pv__format_init(pvstate_t state, /*@null@ */ const char *format_supp
display->format[segment].type = seg_type;
display->format[segment].str_start = str_start;
display->format[segment].str_length = str_length;
display->format[segment].str_bytes = str_bytes;
display->format_segment_count++;
}
}
@@ -785,7 +785,7 @@ bool pv_format(pvstate_t state, /*@null@ */ const char *format_supplied, pvdispl
if (state->control.size < 1
&& ((component_type == PV_COMPONENT_ETA) || (component_type == PV_COMPONENT_FINETA))) {
display->component[component_type].content[0] = '\0';
display->component[component_type].length = 0;
display->component[component_type].bytes = 0;
continue;
}
@@ -968,15 +968,15 @@ bool pv_format(pvstate_t state, /*@null@ */ const char *format_supplied, pvdispl
* functions.
*/
struct tm time = *time_ptr;
size_t component_content_length;
size_t component_content_bytes;
/*@-mustfreefresh @ */
(void) pv_snprintf(component_content, component_buf_size, "%.16s ", _("FIN"));
/*@+mustfreefresh @ *//* splint: see above. */
component_content_length = strlen(component_content); /* flawfinder: ignore */
component_content_bytes = strlen(component_content); /* flawfinder: ignore */
/* flawfinder: always bounded with \0 by pv_snprintf(). */
(void) strftime(component_content + component_content_length,
component_buf_size - 1 - component_content_length, time_format, &time);
(void) strftime(component_content + component_content_bytes,
component_buf_size - 1 - component_content_bytes, time_format, &time);
}
if (!show_fineta) {
@@ -1015,7 +1015,7 @@ bool pv_format(pvstate_t state, /*@null@ */ const char *format_supplied, pvdispl
case PV_COMPONENT_OUTPUTBUF:
/* Recently transferred bytes. */
for (buf_idx = 0; buf_idx < display->lastoutput_length; buf_idx++) {
for (buf_idx = 0; buf_idx < display->lastoutput_bytes; buf_idx++) {
int display_char;
display_char = (int) (display->lastoutput_buffer[buf_idx]);
component_content[buf_idx] = isprint(display_char) ? (char) display_char : '.';
@@ -1028,7 +1028,7 @@ bool pv_format(pvstate_t state, /*@null@ */ const char *format_supplied, pvdispl
}
/* Record the string length for this component. */
display->component[component_type].length = strlen(component_content); /* flawfinder: ignore */
display->component[component_type].bytes = strlen(component_content); /* flawfinder: ignore */
/* flawfinder: always bounded by \0 either explicitly or by pv_snprintf(). */
}
@@ -1041,9 +1041,9 @@ bool pv_format(pvstate_t state, /*@null@ */ const char *format_supplied, pvdispl
static_portion_size = 0;
for (segment = 0; segment < display->format_segment_count; segment++) {
if (display->format[segment].type == PV_COMPONENT_STRING) {
static_portion_size += display->format[segment].str_length;
static_portion_size += display->format[segment].str_bytes;
} else if (display->format[segment].type != PV_COMPONENT_PROGRESS) {
static_portion_size += display->component[display->format[segment].type].length;
static_portion_size += display->component[display->format[segment].type].bytes;
}
}
@@ -1056,7 +1056,7 @@ bool pv_format(pvstate_t state, /*@null@ */ const char *format_supplied, pvdispl
char *component_content;
size_t component_buf_size;
char after_bar[32]; /* flawfinder: ignore - only populated by pv_snprintf(). */
int available_width, bar_length, pad_count;
int available_width, bar_width, pad_count;
component_content = display->component[PV_COMPONENT_PROGRESS].content;
component_content[0] = '\0';
@@ -1114,8 +1114,8 @@ bool pv_format(pvstate_t state, /*@null@ */ const char *format_supplied, pvdispl
(void) pv_snprintf(component_content, component_buf_size, "[");
/* The bar portion. */
bar_length = (int) ((available_width * bar_percentage) / 100 - 1);
for (pad_count = 0; pad_count < bar_length; pad_count++) {
bar_width = (int) ((available_width * bar_percentage) / 100 - 1);
for (pad_count = 0; pad_count < bar_width; pad_count++) {
if (pad_count < available_width)
(void) pv_strlcat(component_content, "=", component_buf_size);
}
@@ -1182,16 +1182,16 @@ bool pv_format(pvstate_t state, /*@null@ */ const char *format_supplied, pvdispl
}
/* Record the string length for this component. */
display->component[PV_COMPONENT_PROGRESS].length = strlen(component_content); /* flawfinder: ignore */
display->component[PV_COMPONENT_PROGRESS].bytes = strlen(component_content); /* flawfinder: ignore */
/* flawfinder: always bounded with \0 by pv_strlcat(). */
/*
* If the progress bar won't fit, drop it.
*/
if ((unsigned int) (display->component[PV_COMPONENT_PROGRESS].length + static_portion_size) >
if ((unsigned int) (display->component[PV_COMPONENT_PROGRESS].bytes + static_portion_size) >
state->control.width) {
component_content[0] = '\0';
display->component[PV_COMPONENT_PROGRESS].length = 0;
display->component[PV_COMPONENT_PROGRESS].bytes = 0;
}
}
@@ -1203,38 +1203,38 @@ bool pv_format(pvstate_t state, /*@null@ */ const char *format_supplied, pvdispl
new_display_string_len = 0;
for (segment = 0; segment < display->format_segment_count; segment++) {
const char *segment_content;
size_t segment_length;
size_t segment_bytes;
if (display->format[segment].type == PV_COMPONENT_STRING) {
segment_content = &(format_used[display->format[segment].str_start]);
segment_length = display->format[segment].str_length;
segment_bytes = display->format[segment].str_bytes;
} else {
segment_content = display->component[display->format[segment].type].content;
segment_length = display->component[display->format[segment].type].length;
segment_bytes = display->component[display->format[segment].type].bytes;
}
/* Skip empty segments. */
if (segment_length == 0)
if (segment_bytes == 0)
continue;
/*
* Truncate the segment if it would make the display string
* overflow the buffer.
*/
if (segment_length + new_display_string_len > display->display_buffer_size - 2)
segment_length = display->display_buffer_size - new_display_string_len - 2;
if (segment_length < 1)
if (segment_bytes + new_display_string_len > display->display_buffer_size - 2)
segment_bytes = display->display_buffer_size - new_display_string_len - 2;
if (segment_bytes < 1)
break;
/* Skip the segment if it would make the display too wide. */
if ((unsigned int) (segment_length + new_display_string_len) > state->control.width)
if ((unsigned int) (segment_bytes + new_display_string_len) > state->control.width)
break;
/* Append the segment to the output string. */
strncat(display->display_buffer, segment_content, segment_length); /* flawfinder: ignore */
strncat(display->display_buffer, segment_content, segment_bytes); /* flawfinder: ignore */
/* flawfinder: length is checked above, and buffer is \0 terminated already. */
new_display_string_len += segment_length;
new_display_string_len += segment_bytes;
}
debug("%s: %d", "display string length counted by format segments", (int) new_display_string_len);
src/pv/transfer.c
+13 -13
View File
@@ -788,34 +788,34 @@ static int pv__transfer_write(pvstate_t state, bool *eof_in, bool *eof_out, long
* last few bytes we've written.
*/
if (state->display.component[PV_COMPONENT_OUTPUTBUF].required && (nwritten > 0)) {
size_t new_portion_length, old_portion_length;
size_t new_portion_size, old_portion_size;
new_portion_length = (size_t) nwritten;
if (new_portion_length > state->display.lastoutput_length)
new_portion_length = state->display.lastoutput_length;
new_portion_size = (size_t) nwritten;
if (new_portion_size > state->display.lastoutput_bytes)
new_portion_size = state->display.lastoutput_bytes;
old_portion_length = state->display.lastoutput_length - new_portion_length;
old_portion_size = state->display.lastoutput_bytes - new_portion_size;
/*
* Make room for the new portion.
*/
if (old_portion_length > 0) {
if (old_portion_size > 0) {
memmove(state->display.lastoutput_buffer,
state->display.lastoutput_buffer + new_portion_length, old_portion_length);
state->display.lastoutput_buffer + new_portion_size, old_portion_size);
}
/*
* Copy the new data in.
*/
memcpy(state->display.lastoutput_buffer + /* flawfinder: ignore */
old_portion_length,
state->transfer.transfer_buffer + state->transfer.write_position - new_portion_length,
new_portion_length);
old_portion_size,
state->transfer.transfer_buffer + state->transfer.write_position - new_portion_size,
new_portion_size);
/*
* flawfinder rationale: calculations above ensure
* that old_portion_length + new_portion_length is
* always <= lastoutput_length, and
* lastoutput_length is guaranteed by
* that old_portion_size + new_portion_size is
* always <= lastoutput_bytes, and
* lastoutput_bytes is guaranteed by
* pv__format_init() to be no more than
* PV_SIZEOF_LASTOUTPUT_BUFFER, which is the size of
* lastoutput_buffer, so the memcpy() will always