1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
|
/* $Id: nroff.c,v 2.0.1.19 1995/09/18 08:47:29 greyham Exp $
* functions for nroff style output.
*/
#include "c2man.h"
#include "manpage.h"
#include "output.h"
#include "semantic.h"
#include <ctype.h>
void nroff_text(text)
const char *text;
{
put_string(text);
}
void nroff_char(c)
const int c;
{
putchar(c);
}
void nroff_comment() { put_string(".\\\" "); }
void nroff_header(firstpage, input_files, grouped, name, terse, section)
ManualPage *firstpage;
int input_files;
boolean grouped;
const char *name;
const char *terse;
const char *section;
{
#ifdef HAS_STRFTIME
char month[20];
#else
char *month;
static char *month_list[] =
{ "January", "February", "March", "April", "May", "June",
"July", "August", "September", "October", "November", "December" };
#endif
Time_t raw_time;
struct tm *filetime;
if (make_embeddable) return;
output_warning();
put_string(".TH \"");
/* if lots of files contributed, use the current time; otherwise use the
* time of the source file they came from.
*/
raw_time = (grouped && input_files > 1) ? time((Time_t *)NULL)
: firstpage->sourcetime;
filetime = localtime(&raw_time);
#ifdef HAS_STRFTIME
/* generate the date format string */
strftime(month, sizeof month,"%B",filetime);
#else
month = month_list[filetime->tm_mon];
#endif
nroff_text(name);
printf("\" %s \"%d %s %d\"",
section,filetime->tm_mday,month,filetime->tm_year+1900);
/* I have conflicting info about how the .TH macro works.... */
#ifdef HENRYS_TH /* As per Henry Spencer's "How to write a manual page" */
if (manual_name) printf(" \"%s\"", manual_name);
put_string("\n.BY");
#endif
printf(" \"%s",progname);
if ((input_files <= 1 || !grouped) && firstpage->sourcefile)
{
const char *basename = strrchr(firstpage->sourcefile, '/');
if (basename == NULL)
basename = firstpage->sourcefile;
else
basename++;
printf(" %s", basename);
}
#ifndef HENRYS_TH
if (manual_name) printf("\" \"%s", manual_name);
#endif
put_string("\"\n");
#ifdef NeXT
/* define our own .SS on packages (such as NeXT's) where it doesn't move
* left a little. Sorry, awf doesn't support .SS.
*/
put_string(".de SS\n.}X .25i \"\" \"\"\n.nr )E 2\n");
put_string("\\&\\\\$1\n.br\n..\n");
#endif
}
void nroff_dash() { put_string("\\-"); }
void nroff_section(name)
const char *name;
{
put_string(".SH \"");
nroff_text(name);
put_string("\"\n");
}
void nroff_sub_section(name)
const char *name;
{
put_string(".SS \"");
nroff_text(name);
put_string("\"\n");
}
void nroff_break_line() { put_string(".br\n"); }
void nroff_blank_line() { put_string(".sp\n"); }
void nroff_code_start() { put_string(".ft B\n"); }
void nroff_code_end() { put_string(".ft R\n"); }
void nroff_code(text)
const char *text;
{
put_string("\\fB");
nroff_text(text);
put_string("\\fR");
}
void nroff_tag_entry_start() { put_string(".TP\n.B \""); }
void nroff_tag_entry_start_extra() { put_string(".TP\n.BR \""); }
void nroff_tag_entry_end() { put_string("\"\n"); }
void nroff_tag_entry_end_extra(text)
const char *text;
{
put_string("\" \"\t(");
nroff_text(text);
put_string(")\"\n");
}
void nroff_table_start(longestag)
const char *longestag;
{
void nroff_list_start();
nroff_list_start();
/* We measure the length of the longest tag in the table by changing to the
* code font, taking it's width with \w'string' and adding a little for
* the space between the tag and description. This gets stored in the TL
* number register, where the nroff_table_entry can find it.
* This isn't foolproof, because a shorter tag may be longer if it contains
* wider characters, but the extra space gives a little head room anyway.
*/
nroff_code_start();
printf(".nr TL \\w'%s'u+0.2i\n", longestag);
nroff_code_end();
}
void nroff_table_entry(name, description)
const char *name;
const char *description;
{
put_string(".TP \\n(TLu\n");
nroff_code(name);
nroff_char('\n');
if (description)
output_comment(description);
else
nroff_char('\n');
}
void nroff_table_end() { put_string(".RE\n.PD\n"); }
void nroff_indent() { put_string(".IP\n"); }
void nroff_list_start() { put_string(".RS 0.75in\n.PD 0\n"); }
void nroff_list_entry(name)
const char *name;
{
nroff_code(name);
}
void nroff_list_separator() { put_string(",\n"); }
void nroff_list_end() { nroff_char('\n'); nroff_table_end(); }
void nroff_include(filename)
const char *filename;
{
printf(".so %s\n", filename);
}
void nroff_name(name)
const char *name;
{
if (name) nroff_text(name);
else nroff_section("NAME");
}
void nroff_terse_sep()
{
nroff_char(' ');
nroff_dash();
nroff_char(' ');
}
void nroff_emphasized(text)
const char *text;
{
put_string("\\fI");
nroff_text(text);
put_string("\\fR");
}
void nroff_reference(text)
const char *text;
{
nroff_text(text);
nroff_char('(');
nroff_text(manual_section);
nroff_char(')');
}
void nroff_description(text)
const char *text;
{
enum { TEXT, PERIOD, CAPITALISE } state = CAPITALISE;
boolean new_line = TRUE;
boolean dot_command = FALSE;
/* correct punctuation a bit as it goes out */
for (;*text;text++)
{
int c = *text;
if (dot_command)
{
if (c == '\n') dot_command = FALSE;
}
else if (new_line && c == '.')
dot_command = TRUE;
else if (new_line && (c == '-' || c == '*' || is_numbered(text)))
{
output->break_line();
state = CAPITALISE;
}
else if (c == '.')
state = PERIOD;
else if (isspace(c) && state == PERIOD)
state = CAPITALISE;
else if (isalnum(c))
{
if (islower(c) && state == CAPITALISE) c = toupper(c);
state = TEXT;
}
output->character(c);
new_line = c == '\n';
}
/* do a full stop if there wasn't one */
if (!dot_command && state == TEXT) output->character('.');
}
void
nroff_returns(comment)
const char *comment;
{
enum { TEXT, PERIOD, CAPITALISE } state = CAPITALISE;
char lastchar = '\n';
boolean tag_list_started = FALSE;
/* for each line... */
while (*comment)
{
boolean tagged = FALSE;
/* explicitly reject dot commands */
if (*comment && *comment != '.')
{
const char *c = comment;
/* search along until the end of a word */
while (*c && *c != ':' && !isspace(*c))
c++;
/* skip all spaces or tabs after the first word */
while (*c && *c != '\n')
{
if (*c == '\t' || *c == ':')
{
tagged = TRUE;
break;
}
else if (!isspace(*c))
break;
c++;
}
}
/* is it tagged?; explicitly reject dot commands */
if (tagged)
{
/* output lingering newline if necessary */
if (lastchar != '\n')
{
if (state == TEXT && !ispunct(lastchar)) output->character('.');
output->character(lastchar = '\n');
}
if (!tag_list_started)
{
output->tag_list_start();
tag_list_started = TRUE;
}
/* output the taggy bit */
output->tag_entry_start();
while (*comment && *comment != ':' && !isspace(*comment))
output->character(*comment++);
output->tag_entry_end();
/* skip any extra tabs or spaces */
while (*comment == ':' || (isspace(*comment) && *comment != '\n'))
comment++;
state = CAPITALISE;
}
/* terminate the previous line if necessary */
if (lastchar != '\n') output->character(lastchar = '\n');
/* dot commands go out unaltered */
if (*comment == '.')
{
for (;*comment && *comment != '\n'; comment++)
output->character(*comment);
output->character('\n');
}
else
{
/* correct punctuation a bit as the line goes out */
for (;*comment && *comment != '\n'; comment++)
{
char c = *comment;
if (c == '.')
state = PERIOD;
else if (isspace(c) && state == PERIOD)
state = CAPITALISE;
else if (isalnum(c))
{
if (islower(c) && state == CAPITALISE && fixup_comments)
c = toupper(c);
state = TEXT;
}
output->character(lastchar = c);
}
/* if it ended in punctuation, just output the nl straight away. */
if (ispunct(lastchar))
{
if (lastchar == '.') state = CAPITALISE;
output->character(lastchar = '\n');
}
}
if (*comment) comment++;
}
/* output lingering newline if necessary */
if (lastchar != '\n')
{
if (state == TEXT && !ispunct(lastchar) && fixup_comments)
output->character('.');
output->character('\n');
}
if (tag_list_started)
output->tag_list_end();
}
struct Output nroff_output =
{
nroff_comment,
nroff_header,
nroff_dash,
nroff_section,
nroff_sub_section,
nroff_break_line,
nroff_blank_line,
nroff_code_start,
nroff_code_end,
nroff_code,
dummy, /* nroff_tag_list_start */
dummy, /* nroff_tag_list_end */
nroff_tag_entry_start,
nroff_tag_entry_start_extra,
nroff_tag_entry_end,
nroff_tag_entry_end_extra,
nroff_table_start,
nroff_table_entry,
nroff_table_end,
nroff_indent,
nroff_list_start,
nroff_code, /* nroff_list_entry */
nroff_list_separator,
nroff_list_end,
nroff_include,
dummy, /* nroff_file_end */
nroff_text,
nroff_char,
NULL, /* nroff_parse_option */
dummy, /* nroff_print_options */
nroff_name,
nroff_terse_sep,
nroff_reference,
nroff_emphasized,
nroff_description,
nroff_returns
};
|