From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from krisdoz.my.domain (schwarze@localhost [127.0.0.1]) by krisdoz.my.domain (8.14.3/8.14.3) with ESMTP id p0UG5cJf009812 for ; Sun, 30 Jan 2011 11:05:39 -0500 (EST) Received: (from schwarze@localhost) by krisdoz.my.domain (8.14.3/8.14.3/Submit) id p0UG5bbS006962; Sun, 30 Jan 2011 11:05:37 -0500 (EST) Date: Sun, 30 Jan 2011 11:05:37 -0500 (EST) Message-Id: <201101301605.p0UG5bbS006962@krisdoz.my.domain> X-Mailinglist: mdocml-source Reply-To: source@mdocml.bsd.lv MIME-Version: 1.0 From: schwarze@mdocml.bsd.lv To: source@mdocml.bsd.lv Subject: mdocml: Implement the \N'number' (numbered character) roff escape X-Mailer: activitymail 1.26, http://search.cpan.org/dist/activitymail/ Content-Type: text/plain; charset=utf-8 Log Message: ----------- Implement the \N'number' (numbered character) roff escape sequence. Don't use it in new manuals, it is inherently non-portable, but we need it for backward-compatibility with existing manuals, for example in Xenocara driver pages. ok kristaps@ jmc@ and tested by Matthieu Herrb (matthieu at openbsd dot org) Modified Files: -------------- mdocml: chars.c chars.h html.c mandoc_char.7 out.c out.h term.c Revision Data ------------- Index: term.c =================================================================== RCS file: /usr/vhosts/mdocml.bsd.lv/cvs/mdocml/term.c,v retrieving revision 1.176 retrieving revision 1.177 diff -Lterm.c -Lterm.c -u -p -r1.176 -r1.177 --- term.c +++ term.c @@ -1,7 +1,7 @@ /* $Id$ */ /* * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons - * Copyright (c) 2010 Ingo Schwarze + * Copyright (c) 2010, 2011 Ingo Schwarze * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above @@ -353,6 +353,17 @@ term_vspace(struct termp *p) static void +numbered(struct termp *p, const char *word, size_t len) +{ + const char *rhs; + + rhs = chars_num2char(word, len); + if (rhs) + encode(p, rhs, 1); +} + + +static void spec(struct termp *p, enum roffdeco d, const char *word, size_t len) { const char *rhs; @@ -511,6 +522,9 @@ term_word(struct termp *p, const char *w word += a2roffdeco(&deco, &seq, &ssz); switch (deco) { + case (DECO_NUMBERED): + numbered(p, seq, ssz); + break; case (DECO_RESERVED): res(p, seq, ssz); break; Index: chars.c =================================================================== RCS file: /usr/vhosts/mdocml.bsd.lv/cvs/mdocml/chars.c,v retrieving revision 1.31 retrieving revision 1.32 diff -Lchars.c -Lchars.c -u -p -r1.31 -r1.32 --- chars.c +++ chars.c @@ -1,6 +1,7 @@ /* $Id$ */ /* * Copyright (c) 2009, 2010 Kristaps Dzonsons + * Copyright (c) 2011 Ingo Schwarze * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above @@ -149,6 +150,27 @@ chars_res2cp(void *arg, const char *p, s if (NULL == ln) return(-1); return(ln->unicode); +} + + +/* + * Numbered character to literal character, + * represented as a null-terminated string for additional safety. + */ +const char * +chars_num2char(const char *p, size_t sz) +{ + int i; + static char c[2]; + + if (sz > 3) + return(NULL); + i = atoi(p); + if (i < 0 || i > 255) + return(NULL); + c[0] = (char)i; + c[1] = '\0'; + return(c); } Index: out.c =================================================================== RCS file: /usr/vhosts/mdocml.bsd.lv/cvs/mdocml/out.c,v retrieving revision 1.36 retrieving revision 1.37 diff -Lout.c -Lout.c -u -p -r1.36 -r1.37 --- out.c +++ out.c @@ -1,6 +1,7 @@ /* $Id$ */ /* * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons + * Copyright (c) 2011 Ingo Schwarze * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above @@ -251,6 +252,49 @@ a2roffdeco(enum roffdeco *d, const char break; } break; + + case ('N'): + + /* + * Sequence of characters: backslash, 'N' (i = 0), + * starting delimiter (i = 1), character number (i = 2). + */ + + *word = wp + 2; + *sz = 0; + + /* + * Cannot use a digit as a starting delimiter; + * but skip the digit anyway. + */ + + if (isdigit((int)wp[1])) + return(2); + + /* + * Any non-digit terminates the character number. + * That is, the terminating delimiter need not + * match the starting delimiter. + */ + + for (i = 2; isdigit((int)wp[i]); i++) + (*sz)++; + + /* + * This is only a numbered character + * if the character number has at least one digit. + */ + + if (*sz) + *d = DECO_NUMBERED; + + /* + * Skip the terminating delimiter, even if it does not + * match, and even if there is no character number. + */ + + return(++i); + case ('h'): /* FALLTHROUGH */ case ('v'): Index: html.c =================================================================== RCS file: /usr/vhosts/mdocml.bsd.lv/cvs/mdocml/html.c,v retrieving revision 1.125 retrieving revision 1.126 diff -Lhtml.c -Lhtml.c -u -p -r1.125 -r1.126 --- html.c +++ html.c @@ -1,6 +1,7 @@ /* $Id$ */ /* - * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons + * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons + * Copyright (c) 2011 Ingo Schwarze * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above @@ -93,6 +94,7 @@ static const char *const htmlattrs[ATTR_ "colspan", /* ATTR_COLSPAN */ }; +static void print_num(struct html *, const char *, size_t); static void print_spec(struct html *, enum roffdeco, const char *, size_t); static void print_res(struct html *, const char *, size_t); @@ -214,6 +216,17 @@ print_gen_head(struct html *h) static void +print_num(struct html *h, const char *p, size_t len) +{ + const char *rhs; + + rhs = chars_num2char(p, len); + if (rhs) + putchar((int)*rhs); +} + + +static void print_spec(struct html *h, enum roffdeco d, const char *p, size_t len) { int cp; @@ -333,6 +346,9 @@ print_encode(struct html *h, const char len = a2roffdeco(&deco, &seq, &sz); switch (deco) { + case (DECO_NUMBERED): + print_num(h, seq, sz); + break; case (DECO_RESERVED): print_res(h, seq, sz); break; Index: out.h =================================================================== RCS file: /usr/vhosts/mdocml.bsd.lv/cvs/mdocml/out.h,v retrieving revision 1.15 retrieving revision 1.16 diff -Lout.h -Lout.h -u -p -r1.15 -r1.16 --- out.h +++ out.h @@ -1,6 +1,6 @@ /* $Id$ */ /* - * Copyright (c) 2009 Kristaps Dzonsons + * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above @@ -52,6 +52,7 @@ enum roffscale { enum roffdeco { DECO_NONE, + DECO_NUMBERED, /* numbered character */ DECO_SPECIAL, /* special character */ DECO_SSPECIAL, /* single-char special */ DECO_RESERVED, /* reserved word */ Index: mandoc_char.7 =================================================================== RCS file: /usr/vhosts/mdocml.bsd.lv/cvs/mdocml/mandoc_char.7,v retrieving revision 1.40 retrieving revision 1.41 diff -Lmandoc_char.7 -Lmandoc_char.7 -u -p -r1.40 -r1.41 --- mandoc_char.7 +++ mandoc_char.7 @@ -513,6 +513,21 @@ implementations: .It \e*(aa Ta \*(aa Ta acute .It \e*(ga Ta \*(ga Ta grave .El +.Sh NUMBERED CHARACTERS +For backward compatibility with existing manuals, +.Xr mandoc 1 +also supports the +.Pp +.Dl \eN\(aq Ns Ar number Ns \(aq +.Pp +escape sequence, inserting the character +.Ar number +from the current character set into the output. +Of course, this is inherently non-portable and is already marked +as deprecated in the Heirloom roff manual. +For example, do not use \eN'34', use \e(dq, or even the plain +.Sq \(dq +character where possible. .Sh COMPATIBILITY This section documents compatibility of .Nm Index: chars.h =================================================================== RCS file: /usr/vhosts/mdocml.bsd.lv/cvs/mdocml/chars.h,v retrieving revision 1.6 retrieving revision 1.7 diff -Lchars.h -Lchars.h -u -p -r1.6 -r1.7 --- chars.h +++ chars.h @@ -1,6 +1,7 @@ /* $Id$ */ /* * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons + * Copyright (c) 2011 Ingo Schwarze * * Permission to use, copy, modify, and distribute this software for any * purpose with or without fee is hereby granted, provided that the above @@ -25,6 +26,7 @@ enum chars { }; void *chars_init(enum chars); +const char *chars_num2char(const char *, size_t); const char *chars_spec2str(void *, const char *, size_t, size_t *); int chars_spec2cp(void *, const char *, size_t); const char *chars_res2str(void *, const char *, size_t, size_t *); -- To unsubscribe send an email to source+unsubscribe@mdocml.bsd.lv