gbranden pushed a commit to branch master
in repository groff.
commit 0589738deffe701e089515b0776a1f2394c11e25
Author: G. Branden Robinson <[email protected]>
AuthorDate: Sat Aug 17 10:14:16 2024 -0500
[troff]: Trivially refactor.
Rename `get_number()` to `read_measurement()`. Part of the idea here is
to use the verb "read" to suggest that the function advances the token
pointer through the input stream (and it does). Another part is to
reduce confusion, since the class `charinfo` has an unrelated member
function `get_number()`.
* src/roff/troff/token.h (get_number):
* src/roff/troff/number.cpp (get_number): Rename this...
* src/roff/troff/token.h (read_measurement):
* src/roff/troff/number.cpp (read_measurement): ...to this.
* src/roff/troff/number.cpp (read_measurement): Update self-reference in
assertion message.
* src/roff/troff/env.cpp (point_size):
* src/roff/troff/input.cpp (get_color_element, read_delimited_number)
(get_line_arg, read_size, do_register, do_if_request)
(evaluate_expression):
* src/roff/troff/node.cpp (embolden_font, configure_track_kerning)
(constantly_space_font):
* src/roff/troff/reg.cpp (define_register, inline_define_register [0]):
Update call sites.
---
ChangeLog | 26 ++++++++++++++++++++++++++
src/roff/troff/env.cpp | 4 +++-
src/roff/troff/input.cpp | 16 ++++++++--------
src/roff/troff/node.cpp | 11 ++++++-----
src/roff/troff/number.cpp | 6 +++---
src/roff/troff/reg.cpp | 8 ++++----
src/roff/troff/token.h | 6 +++---
7 files changed, 53 insertions(+), 24 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index 3c065d2a0..b02984a32 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,29 @@
+2024-08-17 G. Branden Robinson <[email protected]>
+
+ [troff]: Trivially refactor. Rename `get_number()` to
+ `read_measurement()`. Part of the idea here is to use the verb
+ "read" to suggest that the function advances the token pointer
+ through the input stream (and it does). Another part is to
+ reduce confusion, since the class `charinfo` has an unrelated
+ member function `get_number()`.
+
+ * src/roff/troff/token.h (get_number):
+ * src/roff/troff/number.cpp (get_number): Rename this...
+ * src/roff/troff/token.h (read_measurement):
+ * src/roff/troff/number.cpp (read_measurement): ...to this.
+
+ * src/roff/troff/number.cpp (read_measurement): Update
+ self-reference in assertion message.
+
+ * src/roff/troff/env.cpp (point_size):
+ * src/roff/troff/input.cpp (get_color_element)
+ (read_delimited_number, get_line_arg, read_size, do_register)
+ (do_if_request, evaluate_expression):
+ * src/roff/troff/node.cpp (embolden_font)
+ (configure_track_kerning, constantly_space_font):
+ * src/roff/troff/reg.cpp (define_register)
+ (inline_define_register [0]): Update call sites.
+
2024-08-16 G. Branden Robinson <[email protected]>
* doc/groff.texi.in (Page Location Traps): Correct erroneous
diff --git a/src/roff/troff/env.cpp b/src/roff/troff/env.cpp
index ee4840b93..c3990f040 100644
--- a/src/roff/troff/env.cpp
+++ b/src/roff/troff/env.cpp
@@ -1305,7 +1305,9 @@ void family_change()
void point_size()
{
int n;
- if (has_arg() && get_number(&n, 'z', curenv->get_requested_point_size())) {
+ if (has_arg()
+ && read_measurement(&n, 'z', curenv->get_requested_point_size()))
+ {
if (n <= 0)
n = 1;
curenv->set_size(n);
diff --git a/src/roff/troff/input.cpp b/src/roff/troff/input.cpp
index e7de7da26..e78fa2aeb 100644
--- a/src/roff/troff/input.cpp
+++ b/src/roff/troff/input.cpp
@@ -1356,7 +1356,7 @@ void do_fill_color(symbol nm)
static unsigned int get_color_element(const char *scheme, const char *col)
{
units val;
- if (!get_number(&val, 'f')) {
+ if (!read_measurement(&val, 'f')) {
warning(WARN_COLOR, "%1 in %2 definition set to 0", col, scheme);
tok.next();
return 0;
@@ -5184,7 +5184,7 @@ static bool read_delimited_number(units *n,
start_token.next();
if (start_token.is_usable_as_delimiter(true /* report error */)) {
tok.next();
- if (get_number(n, si, prev_value)) {
+ if (read_measurement(n, si, prev_value)) {
if (start_token != tok)
warning(WARN_DELIM, "closing delimiter does not match");
return true;
@@ -5199,7 +5199,7 @@ static bool read_delimited_number(units *n, unsigned char
si)
start_token.next();
if (start_token.is_usable_as_delimiter(true /* report error */)) {
tok.next();
- if (get_number(n, si)) {
+ if (read_measurement(n, si)) {
if (start_token != tok)
warning(WARN_DELIM, "closing delimiter does not match");
return true;
@@ -5216,7 +5216,7 @@ static int get_line_arg(units *n, unsigned char si,
charinfo **cp)
if (!start_token.is_usable_as_delimiter(true /* report error */))
return 0;
tok.next();
- if (get_number(n, si)) {
+ if (read_measurement(n, si)) {
if (tok.is_dummy() || tok.is_transparent_dummy())
tok.next();
if (!(start_token == tok
@@ -5306,7 +5306,7 @@ static bool read_size(int *x)
inc = c == '+' ? 1 : -1;
tok.next();
}
- if (!get_number(&val, 'z'))
+ if (!read_measurement(&val, 'z'))
return false;
if (!(start.ch() == '[' && tok.ch() == ']') && start != tok) {
if (start.ch() == '[')
@@ -5436,7 +5436,7 @@ static void do_register()
if (!r || !r->get_value(&prev_value))
prev_value = 0;
int val;
- if (!get_number(&val, 'u', prev_value))
+ if (!read_measurement(&val, 'u', prev_value))
return;
if (start_token != tok)
warning(WARN_DELIM, "closing delimiter does not match");
@@ -6080,7 +6080,7 @@ static bool do_if_request()
}
else {
units n;
- if (!get_number(&n, 'u')) {
+ if (!read_measurement(&n, 'u')) {
skip_branch();
return false;
}
@@ -8242,7 +8242,7 @@ static int evaluate_expression(const char *expr, units
*res)
{
input_stack::push(make_temp_iterator(expr));
tok.next();
- int success = get_number(res, 'u');
+ int success = read_measurement(res, 'u');
while (input_stack::get(0) != EOF)
;
return success;
diff --git a/src/roff/troff/node.cpp b/src/roff/troff/node.cpp
index 6cb5e3235..abca748fd 100644
--- a/src/roff/troff/node.cpp
+++ b/src/roff/troff/node.cpp
@@ -6633,7 +6633,8 @@ static void embolden_font()
else {
int f = finfo2.position;
units offset;
- if (has_arg() && get_number(&offset, 'u') && offset >= 1)
+ if (has_arg()
+ && read_measurement(&offset, 'u') && offset >= 1)
font_table[f]->set_conditional_bold(n, hunits(offset - 1));
else
font_table[f]->conditional_unbold(n);
@@ -6642,7 +6643,7 @@ static void embolden_font()
else {
// A numeric second argument must be an emboldening amount.
units offset;
- if (get_number(&offset, 'u') && offset >= 1)
+ if (read_measurement(&offset, 'u') && offset >= 1)
font_table[n]->set_bold(hunits(offset - 1));
else
font_table[n]->unbold();
@@ -6720,9 +6721,9 @@ static void configure_track_kerning()
int n = finfo.position, min_s, max_s;
hunits min_a, max_a;
if (has_arg()
- && get_number(&min_s, 'z')
+ && read_measurement(&min_s, 'z')
&& get_hunits(&min_a, 'p')
- && get_number(&max_s, 'z')
+ && read_measurement(&max_s, 'z')
&& get_hunits(&max_a, 'p')) {
track_kerning_function tk(min_s, min_a, max_s, max_a);
font_table[n]->set_track_kern(tk);
@@ -6750,7 +6751,7 @@ static void constantly_space_font()
if (!has_arg() || !get_integer(&x))
font_table[n]->set_constant_space(CONSTANT_SPACE_NONE);
else {
- if (!has_arg() || !get_number(&y, 'z'))
+ if (!has_arg() || !read_measurement(&y, 'z'))
font_table[n]->set_constant_space(CONSTANT_SPACE_RELATIVE, x);
else
font_table[n]->set_constant_space(CONSTANT_SPACE_ABSOLUTE,
diff --git a/src/roff/troff/number.cpp b/src/roff/troff/number.cpp
index 1ece5dc1d..ac33c3f5d 100644
--- a/src/roff/troff/number.cpp
+++ b/src/roff/troff/number.cpp
@@ -85,7 +85,7 @@ bool get_number_rigidly(units *res, unsigned char si)
return false;
}
-bool get_number(units *res, unsigned char si)
+bool read_measurement(units *res, unsigned char si)
{
if (!is_valid_expression_start())
return false;
@@ -171,7 +171,7 @@ bool get_hunits(hunits *res, unsigned char si, hunits
prev_value)
return true;
}
-bool get_number(units *res, unsigned char si, units prev_value)
+bool read_measurement(units *res, unsigned char si, units prev_value)
{
units u;
switch (get_incr_number(&u, si)) {
@@ -189,7 +189,7 @@ bool get_number(units *res, unsigned char si, units
prev_value)
warning(WARN_RANGE, "integer decrementation saturated");
break;
default:
- assert(0 == "unhandled case in get_number()");
+ assert(0 == "unhandled case in read_measurement()");
}
return true;
}
diff --git a/src/roff/troff/reg.cpp b/src/roff/troff/reg.cpp
index e6b85217f..7daf30912 100644
--- a/src/roff/troff/reg.cpp
+++ b/src/roff/troff/reg.cpp
@@ -317,13 +317,13 @@ void define_register()
units prev_value;
if ((0 /* nullptr */ == r) || !r->get_value(&prev_value))
prev_value = 0;
- if (get_number(&v, 'u', prev_value)) {
+ if (read_measurement(&v, 'u', prev_value)) {
if (0 /* nullptr */ == r) {
r = new number_reg;
register_dictionary.define(nm, r);
}
r->set_value(v);
- if (tok.is_space() && has_arg() && get_number(&v, 'u'))
+ if (tok.is_space() && has_arg() && read_measurement(&v, 'u'))
r->set_increment(v);
}
skip_line();
@@ -349,10 +349,10 @@ void inline_define_register()
units prev_value;
if ((0 /* nullptr */ == r) || !r->get_value(&prev_value))
prev_value = 0;
- if (get_number(&v, 'u', prev_value)) {
+ if (read_measurement(&v, 'u', prev_value)) {
r->set_value(v);
if (start_token != tok) {
- if (get_number(&v, 'u')) {
+ if (read_measurement(&v, 'u')) {
r->set_increment(v);
if (start_token != tok)
warning(WARN_DELIM, "closing delimiter does not match");
diff --git a/src/roff/troff/token.h b/src/roff/troff/token.h
index 18498c0f4..7de3eebae 100644
--- a/src/roff/troff/token.h
+++ b/src/roff/troff/token.h
@@ -126,11 +126,11 @@ extern void read_title_parts(node **part, hunits
*part_width);
extern bool get_number_rigidly(units *result, unsigned char si);
-extern bool get_number(units *result, unsigned char si);
+extern bool read_measurement(units *result, unsigned char si);
extern bool get_integer(int *result);
-extern bool get_number(units *result, unsigned char si,
- units prev_value);
+extern bool read_measurement(units *result, unsigned char si,
+ units prev_value);
extern bool get_integer(int *result, int prev_value);
extern void interpolate_register(symbol, int);
_______________________________________________
Groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
