src/roff/troff/reg.cpp - master - niceSOFT/groff

src/roff/troff/reg.cpp
662 строки15 KB
G. Branden Robinson
src/roff/troff/reg.cpp: Slightly refactor.
04 май 2026, 22:45
04 май 2026, 22:45a245e2f
/* Copyright 1989-2020 Free Software Foundation, Inc.
             2024-2025 G. Branden Robinson

Written by James Clark (jjc@jclark.com)

This file is part of groff, the GNU roff typesetting system.

groff is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation, either version 3 of the License, or
(at your option) any later version.

groff is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>. */

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include <assert.h>
#include <stdio.h> // prerequisite of searchpath.h
#include <string.h> // memset()

// libgroff
#include "errarg.h" // prerequisite of troff.h
#include "error.h" // prerequisite of troff.h
#include "searchpath.h" // prerequisite of troff.h
#include "symbol.h" // prerequisite of color.h
#include "color.h" // prerequisite of env.h
#include "cset.h" // csdigit()
#include "lib.h" // INT_DIGITS

// troff
#include "dictionary.h"
#include "request.h"
#include "troff.h" // prerequisite of reg.h, token.h; units
#include "reg.h"
#include "token.h"

object_dictionary register_dictionary(101);

// Scribble into this any time we need to format a *roff integer as a
// C string and will use the result immediately.  Think of *roff
// register values, decimal number formats, and autoincrement amounts.
//
// Register values in decimal (and the corresponding number format)
// occupy the most possible space in this buffer.  Non-decimal numbers
// and their formats are always smaller.  Even AT&T troff's extended
// Roman numerals can't express much more than a signed 16-bit integer,
// and base-26 alphabetic formats are a more compact representation than
// decimal.
//
// C++11: constexpr
static const size_t scratchpad_size = INT_DIGITS + 1 /* leading sign */;
static char scratchpad[scratchpad_size];

bool reg::get_value(units * /*d*/)
{
  return false;
}

void reg::increment()
{
  error("cannot increment read-only register");
}

void reg::decrement()
{
  error("cannot decrement read-only register");
}

void reg::set_increment(units /*n*/)
{
  error("cannot automatically increment read-only register");
}

int reg::get_increment() const
{
  return 0;
}

void reg::alter_format(char /*f*/, int /*w*/)
{
  error("cannot assign format of read-only register");
}

const char *reg::get_format()
{
  return "0";
}

void reg::set_value(units /*n*/)
{
  error("cannot write read-only register");
}

bool reg::can_autoincrement() const
{
  return false;
}

bool reg::has_format() const
{
  return false;
}

general_reg::general_reg() : format('1'), width(0), inc(0)
{
}

static char uppercase_array[] = {
  'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H',
  'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P',
  'Q', 'R', 'S', 'T', 'U', 'V', 'W', 'X',
  'Y', 'Z',
};

static char lowercase_array[] = {
  'a', 'b', 'c', 'd', 'e', 'f', 'g', 'h',
  'i', 'j', 'k', 'l', 'm', 'n', 'o', 'p',
  'q', 'r', 's', 't', 'u', 'v', 'w', 'x',
  'y', 'z',
};

static const char *number_value_to_ascii(int value, char format,
					 int width)
{
  (void) memset(scratchpad, 0, (scratchpad_size * sizeof(char)));
  switch (format) {
  case '1':
    if (width <= 0)
      return i_to_a(value);
    else if (width > int((sizeof scratchpad) - 2))
      sprintf(scratchpad, "%.*d", int((sizeof scratchpad) - 2),
	      int(value));
    else
      sprintf(scratchpad, "%.*d", width, int(value));
    break;
  case 'i':
  case 'I':
    {
      char *p = scratchpad;
      bool is_value_out_of_roman_numeral_range = false;
      int n = int(value);
      // AT&T troff uses z and w to represent 10000 and 5000 in Roman
      // numerals; jjc could find no historical basis for this usage.
      if (want_att_compat) {
	if ((n >= 40000) || (n <= -40000))
	  is_value_out_of_roman_numeral_range = true;
      }
      else {
	if ((n >= 4000) || (n <= -4000))
	  is_value_out_of_roman_numeral_range = true;
      }
      if (is_value_out_of_roman_numeral_range) {
	  error("register value %1 is beyond range representable in"
		" '%2' format", n, format);
	  return i_to_a(n);
      }
      const char *roman_numerals
        = (format == 'i') ? "zwmdclxvi" : "ZWMDCLXVI";
      if (n == 0) {
	*p++ = '0';
	*p = '\0';
	break;
      }
      if (n < 0) {
	*p++ = '-';
	n = -n;
      }
      if (want_att_compat) {
	while (n >= 10000) {
	  *p++ = roman_numerals[0];
	  n -= 10000;
	}
      }
      for (int i = 1000; i > 0; i /= 10, roman_numerals += 2) {
	int m = n/i;
	n -= m*i;
	switch (m) {
	case 3:
	  *p++ = roman_numerals[2];
	  /* falls through */
	case 2:
	  *p++ = roman_numerals[2];
	  /* falls through */
	case 1:
	  *p++ = roman_numerals[2];
	  break;
	case 4:
	  *p++ = roman_numerals[2];
	  *p++ = roman_numerals[1];
	  break;
	case 8:
	  *p++ = roman_numerals[1];
	  *p++ = roman_numerals[2];
	  *p++ = roman_numerals[2];
	  *p++ = roman_numerals[2];
	  break;
	case 7:
	  *p++ = roman_numerals[1];
	  *p++ = roman_numerals[2];
	  *p++ = roman_numerals[2];
	  break;
	case 6:
	  *p++ = roman_numerals[1];
	  *p++ = roman_numerals[2];
	  break;
	case 5:
	  *p++ = roman_numerals[1];
	  break;
	case 9:
	  *p++ = roman_numerals[2];
	  *p++ = roman_numerals[0];
	}
      }
      *p = '\0';
      break;
    }
  case 'a':
  case 'A':
    {
      int n = value;
      char *p = scratchpad;
      if (n == 0) {
	*p++ = '0';
	*p = '\0';
      }
      else {
	if (n < 0) {
	  n = -n;
	  *p++ = '-';
	}
	// this is a bit tricky
	while (n > 0) {
	  int d = n % 26;
	  if (d == 0)
	    d = 26;
	  n -= d;
	  n /= 26;
	  *p++ = format == 'a' ? lowercase_array[d - 1] :
				 uppercase_array[d - 1];
	}
	*p-- = '\0';
	char *q = scratchpad[0] == '-' ? scratchpad + 1 : scratchpad;
	while (q < p) {
	  char temp = *q;
	  *q = *p;
	  *p = temp;
	  --p;
	  ++q;
	}
      }
      break;
    }
  default:
    assert(0 == "unhandled case of register format");
    break;
  }
  return scratchpad;
}

const char *general_reg::get_string()
{
  units n;
  if (!get_value(&n))
    return "";
  return number_value_to_ascii(n, format, width);
}

void general_reg::increment()
{
  int n;
  if (get_value(&n))
    set_value(n + inc);
}

void general_reg::decrement()
{
  int n;
  if (get_value(&n))
    set_value(n - inc);
}

void general_reg::set_increment(units n)
{
  inc = n;
}

int general_reg::get_increment() const
{
  return inc;
}

bool general_reg::can_autoincrement() const
{
  return true;
}

bool general_reg::has_format() const
{
  return true;
}

void general_reg::alter_format(char f, int w)
{
  format = f;
  width = w;
}

static const char *number_format_to_ascii(char format, int width)
{
  (void) memset(scratchpad, 0, (scratchpad_size * sizeof(char)));
  if (format == '1') {
    if (width > 0) {
      int n = width;
      if (n > (int(sizeof scratchpad) - 1))
	n = int(sizeof scratchpad) - 1;
      sprintf(scratchpad, "%.*d", n, 0);
      return scratchpad;
    }
    else
      return "0";
  }
  else {
    scratchpad[0] = format;
    scratchpad[1] = '\0';
    return scratchpad;
  }
}

const char *general_reg::get_format()
{
  return number_format_to_ascii(format, width);
}

class number_reg : public general_reg {
  units value;
public:
  number_reg();
  bool get_value(units *);
  void set_value(units);
};

number_reg::number_reg() : value(0)
{
}

bool number_reg::get_value(units *res)
{
  *res = value;
  return true;
}

void number_reg::set_value(units n)
{
  value = n;
}

variable_reg::variable_reg(units *p) : ptr(p)
{
}

void variable_reg::set_value(units n)
{
  *ptr = n;
}

bool variable_reg::get_value(units *res)
{
  *res = *ptr;
  return true;
}

static void define_register_request()
{
  if (!has_arg()) {
    warning(WARN_MISSING, "register definition request expects"
	    " arguments");
    skip_line();
    return;
  }
  symbol nm = read_identifier();
  if (nm.is_null()) {
    skip_line();
    return;
  }
  reg *r = static_cast<reg *>(register_dictionary.lookup(nm));
  units v;
  units prev_value;
  if ((0 /* nullptr */ == r) || !r->get_value(&prev_value))
    prev_value = 0;
  if (!has_arg()) {
    warning(WARN_MISSING, "register definition request expects"
	    " a numeric expression as second argument");
    skip_line();
    return;
  }
  if (read_measurement_crement(&v,
			       (unsigned char)('u'), // TODO: grochar
			       prev_value)) {
    if (0 /* nullptr */ == r) {
      r = new number_reg;
      register_dictionary.define(nm, r);
    }
    r->set_value(v);
    if (tok.is_space()) {
      if (has_arg()
	  && read_measurement(&v,
			      (unsigned char)('u'))) // TODO: grochar
	r->set_increment(v);
    }
    else if (has_arg() && !tok.is_tab())
      warning(WARN_SYNTAX, "expected end of line or an auto-increment"
	      " argument in register definition request; got %1",
	      tok.description());
  }
  skip_line();
}

#if 0
void inline_define_register()
{
  token start_token;
  start_token.next();
  if (!start_token.is_usable_as_delimiter(true /* report error */))
    return;
  tok.next();
  symbol nm = read_identifier(true /* want_diagnostic */);
  if (nm.is_null())
    return;
  reg *r = static_cast<reg *>(register_dictionary.lookup(nm));
  if (0 /* nullptr */ == r) {
    r = new number_reg;
    register_dictionary.define(nm, r);
  }
  units v;
  units prev_value;
  if ((0 /* nullptr */ == r) || !r->get_value(&prev_value))
    prev_value = 0;
  if (read_measurement_crement(&v,
			       (unsigned char)('u'), // TODO: grochar
			       prev_value)) {
    r->set_value(v);
    if (start_token != tok) {
      if (read_measurement(&v,
			   (unsigned char)('u'))) { // TODO: grochar
	r->set_increment(v);
	if (start_token != tok) {
	  // token::description() writes to static, class-wide storage,
	  // so we must allocate a copy of it before issuing the next
	  // diagnostic.
	  char *delimdesc = strdup(start_token.description());
	  warning(WARN_DELIM, "closing delimiter does not match;"
		  " expected %1, got %2", delimdesc, tok.description());
	  free(delimdesc);
	}
      }
    }
  }
}
#endif

void set_register(symbol nm, units n)
{
  reg *r = static_cast<reg *>(register_dictionary.lookup(nm));
  if (0 /* nullptr */ == r) {
    r = new number_reg;
    register_dictionary.define(nm, r);
  }
  r->set_value(n);
}

reg *look_up_register(symbol nm, bool suppress_creation)
{
  reg *r = static_cast<reg *>(register_dictionary.lookup(nm));
  if ((0 /* nullptr */ == r) && !suppress_creation) {
    warning(WARN_REG, "register '%1' not defined", nm.contents());
    r = new number_reg;
    register_dictionary.define(nm, r);
  }
  return r;
}

static void assign_register_format_request()
{
  if (!has_arg()) {
    warning(WARN_MISSING, "register interpolation format assignment"
	    " request expects arguments");
    skip_line();
    return;
  }
  symbol nm = read_identifier();
  if (nm.is_null()) {
    skip_line();
    return;
  }
  reg *r = static_cast<reg *>(register_dictionary.lookup(nm));
  if (0 /* nullptr */ == r) {
    r = new number_reg;
    register_dictionary.define(nm, r);
  }
  tok.skip_spaces();
  int c = tok.ch(); // safely compares to char literals; TODO: grochar
  if (csdigit(c)) {
    int n = 0;
    do {
      ++n;
      tok.next();
    } while (csdigit(tok.ch()));
    r->alter_format('1', n);
  }
  else if ((c == int('i'))
	   || (c == int('I'))
	   || (c == int('a'))
	   || (c == int('A'))) // TODO: grochar * 4
    r->alter_format(c);
  else if (!has_arg())
    warning(WARN_MISSING, "register interpolation format assignment"
	    " request register format as second argument");
  else
    error("register interpolation format assignment request expects"
	  " 'i', 'I', 'a', 'A', or decimal digits, got %1",
	  tok.description());
  skip_line();
}

static void remove_register_request()
{
  if (!has_arg()) {
    warning(WARN_MISSING, "register removal request expects arguments");
    skip_line();
    return;
  }
  for (;;) {
    symbol s = read_identifier();
    if (s.is_null())
      break;
    register_dictionary.remove(s);
    if (!has_arg())
      break;
  }
  skip_line();
}

static void alias_register_request()
{
  if (!has_arg()) {
    warning(WARN_MISSING, "register aliasing request expects"
	    " arguments");
    skip_line();
    return;
  }
  symbol s1 = read_identifier();
  if (!s1.is_null()) {
    if (!has_arg())
      warning(WARN_MISSING, "register aliasing request expects"
	      " identifier of existing register as second argument");
    else {
      symbol s2 = read_identifier();
      if (!s2.is_null()) {
	if (!register_dictionary.alias(s1, s2))
	  error("cannot alias undefined register '%1'", s2.contents());
      }
    }
  }
  skip_line();
}

static void rename_register_request()
{
  if (!has_arg()) {
    warning(WARN_MISSING, "register renaming request expects"
	    " arguments");
    skip_line();
    return;
  }
  symbol s1 = read_identifier();
  if (!has_arg())
    warning(WARN_MISSING, "register renaming request expects new"
	    " identifier as second argument");
  else if (!s1.is_null()) {
    symbol s2 = read_identifier();
    if (!s2.is_null())
      register_dictionary.rename(s1, s2);
  }
  skip_line();
}

static void dump_register(symbol *id, reg *r)
{
  errprint("%1\t", id->contents());
  int n;
  if (r->get_value(&n)) {
    errprint("%1", n);
    if (r->can_autoincrement()) {
      (void) memset(scratchpad, 0, (scratchpad_size * sizeof(char)));
      (void) snprintf(scratchpad, scratchpad_size, "%+d",
		      r->get_increment());
      errprint("\t%1", scratchpad);
    }
    if (r->has_format()) {
      const char *f = r->get_format();
      assert(f != 0 /* nullptr */);
      if (f != 0 /* nullptr*/)
	errprint("\t%1", f);
    }
  }
  else {
    const char *s = r->get_string();
    // Some string-valued registers, like `.z` and `.itm`, can be empty.
    if (s != 0 /* nullptr */)
      errprint("%1", s);
  }
  errprint("\n");
}

static void print_register_request()
{
  reg *r;
  symbol identifier;
  if (has_arg()) {
    do {
      identifier = read_identifier();
      r = look_up_register(identifier, true /* suppress creation */);
      if (r != 0 /* nullptr */)
	dump_register(&identifier, r);
    } while (has_arg());
  }
  else {
    object_dictionary_iterator iter(register_dictionary);
    // We must use the nuclear `reinterpret_cast` operator because GNU
    // troff's dictionary types use a pre-STL approach to containers.
    while (iter.get(&identifier, reinterpret_cast<object **>(&r))) {
      assert(!identifier.is_null());
      dump_register(&identifier, r);
    }
  }
  fflush(stderr);
  skip_line();
}

void init_reg_requests()
{
  init_request("rr", remove_register_request);
  init_request("nr", define_register_request);
  init_request("af", assign_register_format_request);
  init_request("aln", alias_register_request);
  init_request("rnn", rename_register_request);
  init_request("pnr", print_register_request);
}

// Local Variables:
// fill-column: 72
// mode: C++
// End:
// vim: set cindent noexpandtab shiftwidth=2 textwidth=72: