[groff] 24/28: [troff]: Trivially refactor (`did_space_merge()`).

[G. Branden Robinson]

gbranden pushed a commit to branch master
in repository groff.

commit a8d98c8128db456b8056c56a05c52828d6477b21
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Wed Aug 28 15:26:02 2024 -0500

    [troff]: Trivially refactor (`did_space_merge()`).
    
    [troff]: Boolify and rename member function of `node` class hierarchy to
    `did_space_merge()`.  Its former name, `merge_space()`, was ambiguous.
    There is a difference between _testing_ a condition's truth value and
    _assigning_ one to it, and further with performing some sort of side
    effect.  {Without having read the foregoing, which did `merge_space()`
    mean?} Functional languages--including any language that distinguishes
    "pure" functions from those with side effects--are better at getting the
    programmer to consider these matters.
    
    * src/roff/troff/node.h
      (struct node)
      (class space_node)
      (class word_space_node)
      (class unbreakable_space_node):
      Rename `merge_space()` member function declarations to
      `did_space_merge()` and demote return type from `int` to `bool`.
    
    * src/roff/troff/node.cpp
      (node::did_space_merge)
      (space_node::did_space_merge)
      (word_space_node::did_space_merge)
      (unbreakable_space_node::did_space_merge):
      Rename `merge_space()` member function definition to
      `did_space_merge()` and demote return type from `int` to `bool`.
    
    * src/roff/troff/env.cpp (environment::space_newline)
      (environment::space): Update call sites.
---
 ChangeLog               | 31 +++++++++++++++++++++++++++++++
 src/roff/troff/env.cpp  |  6 +++---
 src/roff/troff/node.cpp | 16 ++++++++--------
 src/roff/troff/node.h   |  8 ++++----
 4 files changed, 46 insertions(+), 15 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index f82dd8673..0695bc524 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,34 @@
+2024-08-28  G. Branden Robinson <g.branden.robinson@gmail.com>
+
+       [troff]: Boolify and rename member function of `node` class
+       hierarchy to `did_space_merge()`.  Its former name,
+       `merge_space()`, was ambiguous.  There is a difference between
+       _testing_ a condition's truth value and _assigning_ one to it,
+       and further with performing some sort of side effect.  {Without
+       having read the foregoing, which did `merge_space()` mean?}
+       Functional languages--including any language that distinguishes
+       "pure" functions from those with side effects--are better at
+       getting the programmer to consider these matters.
+
+       * src/roff/troff/node.h
+       (struct node)
+       (class space_node)
+       (class word_space_node)
+       (class unbreakable_space_node):
+       Rename `merge_space()` member function declarations to
+       `did_space_merge()` and demote return type from `int` to `bool`.
+
+       * src/roff/troff/node.cpp
+       (node::did_space_merge)
+       (space_node::did_space_merge)
+       (word_space_node::did_space_merge)
+       (unbreakable_space_node::did_space_merge):
+       Rename `merge_space()` member function definition to
+       `did_space_merge()` and demote return type from `int` to `bool`.
+
+       * src/roff/troff/env.cpp (environment::space_newline)
+       (environment::space): Update call sites.
+
 2024-08-28  G. Branden Robinson <g.branden.robinson@gmail.com>
 
        [troff]: Boolify and rename member function of `node` class
diff --git a/src/roff/troff/env.cpp b/src/roff/troff/env.cpp
index 2076ef51c..f4fb34440 100644
--- a/src/roff/troff/env.cpp
+++ b/src/roff/troff/env.cpp
@@ -479,7 +479,7 @@ void environment::space_newline()
   width_list *w = new width_list(sw, ssw);
   if (node_list_ends_sentence(line) == 1)
     w->next = new width_list(sw, ssw);
-  if (line != 0 /* nullptr */ && line->merge_space(x, sw, ssw)) {
+  if (line != 0 /* nullptr */ && line->did_space_merge(x, sw, ssw)) {
     width_total += x;
     return;
   }
@@ -507,12 +507,12 @@ void environment::space(hunits space_width, hunits 
sentence_space_width)
   if (p && p->nspaces() == 1 && p->width() == x
       && node_list_ends_sentence(p->next) == 1) {
     hunits xx = translate_space_to_dummy ? H0 : sentence_space_width;
-    if (p->merge_space(xx, space_width, sentence_space_width)) {
+    if (p->did_space_merge(xx, space_width, sentence_space_width)) {
       *tp += xx;
       return;
     }
   }
-  if (p && p->merge_space(x, space_width, sentence_space_width)) {
+  if (p && p->did_space_merge(x, space_width, sentence_space_width)) {
     *tp += x;
     return;
   }
diff --git a/src/roff/troff/node.cpp b/src/roff/troff/node.cpp
index 4b7de8f3a..8ba72554f 100644
--- a/src/roff/troff/node.cpp
+++ b/src/roff/troff/node.cpp
@@ -3216,9 +3216,9 @@ int node::nspaces()
   return 0;
 }
 
-int node::merge_space(hunits, hunits, hunits)
+bool node::did_space_merge(hunits, hunits, hunits)
 {
-  return 0;
+  return false;
 }
 
 
@@ -3259,10 +3259,10 @@ int space_node::nspaces()
   return set ? 0 : 1;
 }
 
-int space_node::merge_space(hunits h, hunits, hunits)
+bool space_node::did_space_merge(hunits h, hunits, hunits)
 {
   n += h;
-  return 1;
+  return true;
 }
 
 hunits space_node::width()
@@ -4477,7 +4477,7 @@ void word_space_node::tprint(troff_output_file *out)
   out->right(n);
 }
 
-int word_space_node::merge_space(hunits h, hunits sw, hunits ssw)
+bool word_space_node::did_space_merge(hunits h, hunits sw, hunits ssw)
 {
   n += h;
   assert(orig_width != 0);
@@ -4485,7 +4485,7 @@ int word_space_node::merge_space(hunits h, hunits sw, 
hunits ssw)
   for (; w->next; w = w->next)
     ;
   w->next = new width_list(sw, ssw);
-  return 1;
+  return true;
 }
 
 unbreakable_space_node::unbreakable_space_node(hunits d, color *c, node *x)
@@ -4533,9 +4533,9 @@ void unbreakable_space_node::split(int, node **, node **)
   assert(0 == "unbreakable_space_node::split() unimplemented");
 }
 
-int unbreakable_space_node::merge_space(hunits, hunits, hunits)
+bool unbreakable_space_node::did_space_merge(hunits, hunits, hunits)
 {
-  return 0;
+  return false;
 }
 
 hvpair::hvpair()
diff --git a/src/roff/troff/node.h b/src/roff/troff/node.h
index ccef903dc..606362eda 100644
--- a/src/roff/troff/node.h
+++ b/src/roff/troff/node.h
@@ -74,7 +74,7 @@ struct node {
   virtual hunits left_italic_correction();
   virtual hunits skew();
   virtual int nspaces();
-  virtual int merge_space(hunits, hunits, hunits);
+  virtual bool did_space_merge(hunits, hunits, hunits);
   virtual vunits vertical_width();
   virtual node *last_char_node();
   virtual void vertical_extent(vunits *, vunits *);
@@ -191,7 +191,7 @@ public:
   int nspaces();
   hunits width();
   int discardable();
-  int merge_space(hunits, hunits, hunits);
+  bool did_space_merge(hunits, hunits, hunits);
   void freeze_space();
   void is_escape_colon();
   void spread_space(int *, hunits *);
@@ -237,7 +237,7 @@ public:
   bool is_same_as(node *);
   void asciify(macro *);
   const char *type();
-  int merge_space(hunits, hunits, hunits);
+  bool did_space_merge(hunits, hunits, hunits);
   bool causes_tprint();
   bool is_tag();
 };
@@ -261,7 +261,7 @@ public:
                              bool /* is_inner */ = false);
   int nbreaks();
   void split(int, node **, node **);
-  int merge_space(hunits, hunits, hunits);
+  bool did_space_merge(hunits, hunits, hunits);
   node *add_self(node *, hyphen_list **);
   hyphen_list *get_hyphen_list(hyphen_list *, int *);
   hyphenation_type get_hyphenation_type();