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 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554
|
/*
** $PROJECT:
**
** $VER: autodoc.c 2.2 (25.01.95)
**
** by
**
** Stefan Ruppert , Windthorststra_e 5 , 65439 Flvrsheim , GERMANY
**
** (C) Copyright 1995
** All Rights Reserved !
**
** $HISTORY:
**
** 25.01.95 : 002.002 : changed to patchlevel 33
** 22.01.95 : 000.001 : initial
*/
#include "c2man.h"
#include "manpage.h"
#include "output.h"
#include <ctype.h>
#ifdef DEBUG
#define D(x) x
#else
#define D(x)
#endif
#define MAX_TAG 10
static const int linelength = 79;
static const int tablength = 4;
static const int indentlength = 4;
static int indent = 4;
static int list_indent = 0;
static int column = 0;
static int newline = FALSE;
static int breakline = FALSE;
static int see_also = FALSE;
static int fileend = FALSE;
static int acttable = -1;
static int tablemaxtag[MAX_TAG];
void autodoc_format(text)
const char *text;
{
if(see_also)
{
if(column + ((text) ? strlen(text) + 2 : 1) > linelength)
{
putchar('\n');
newline = TRUE;
}
}
if(newline)
{
int i;
column = i = indent + list_indent;
for(; i ; i--)
putchar(' ');
newline = FALSE;
}
}
void autodoc_text(text)
const char *text;
{
int br = 1;
autodoc_format(text);
if(!see_also || (br = strcmp(text,",\n")))
{
if(see_also < 2)
{
put_string(text);
column += strlen(text);
}
} else if(!br)
{
column += 2;
put_string(", ");
}
}
void autodoc_char(c)
const int c;
{
if(c != '\f')
{
autodoc_format(NULL);
if(c == '\t')
{
int i = tablength - (column % tablength);
column += i;
for(; i ; i--)
putchar(' ');
} else
{
if(see_also)
{
if(c == '(')
see_also++;
else if(c == ')')
see_also--;
}
putchar(c);
column++;
}
if((newline = (c == '\n')))
column = 0;
}
}
void autodoc_comment() { }
void autodoc_header(firstpage, input_files, grouped, name, terse, section)
ManualPage *firstpage;
int input_files;
boolean grouped;
const char *name;
const char *terse;
const char *section;
{
const char *basename = strrchr(firstpage->sourcefile, '/');
int len;
int spc;
fileend = FALSE;
if(basename && *basename == '/')
basename++;
len = ((basename) ? strlen(basename) + 1 : 0) + strlen(name);
spc = linelength - 2 * len;
see_also = FALSE;
if(basename)
{
autodoc_text(basename);
autodoc_char('/');
}
autodoc_text(name);
if(spc > 0)
{
while(spc)
{
autodoc_char(' ');
spc--;
}
if(basename)
{
autodoc_text(basename);
autodoc_char('/');
}
autodoc_text(name);
} else
{
const char *ptr = name;
len = linelength - 1 - len;
while(len)
{
if(basename && *basename)
{
autodoc_char(*basename);
basename++;
} else
{
if(ptr == name && basename)
autodoc_char('/');
else
{
autodoc_char(*ptr);
ptr++;
}
}
len--;
}
}
put_string("\n");
}
void autodoc_dash() { put_string("-"); }
void autodoc_section(name)
const char *name;
{
D((fprintf(stderr,"section : %s\n",name)));
newline = FALSE;
see_also = FALSE;
put_string("\n");
if(!strcmp(name,"DESCRIPTION"))
name = "FUNCTION";
else if(!strcmp(name,"PARAMETERS"))
name = "INPUTS";
else if(!strcmp(name,"RETURNS"))
name = "RESULT";
else if(!strcmp(name,"SEE ALSO"))
see_also = TRUE;
put_string(" ");
autodoc_text(name);
indent = 8;
list_indent = 0;
autodoc_char('\n');
}
void autodoc_sub_section(name)
const char *name;
{
autodoc_text(name);
indent = 12;
}
void autodoc_break_line()
{
breakline = TRUE;
}
void autodoc_blank_line()
{
autodoc_char('\n');
}
void autodoc_code_start() { }
void autodoc_code_end() { }
void autodoc_code(text)
const char *text;
{
autodoc_text(text);
}
void autodoc_tag_entry_start()
{
if(list_indent > 0)
{
autodoc_char('\n');
list_indent -= indentlength;
}
}
void autodoc_tag_entry_start_extra()
{
if(list_indent > 0)
{
autodoc_char('\n');
list_indent -= indentlength;
}
}
void autodoc_tag_entry_end()
{
list_indent += indentlength;
autodoc_char('\n');
}
void autodoc_tag_entry_end_extra(text)
const char *text;
{
put_string("\" \"\t(");
autodoc_text(text);
put_string(")\"\n");
list_indent += indentlength;
}
void autodoc_table_start(longestag)
const char *longestag;
{
if(acttable < MAX_TAG - 1)
{
acttable++;
tablemaxtag[acttable] = strlen(longestag);
}
indent += indentlength;
newline = TRUE;
}
void autodoc_table_entry(name, description)
const char *name;
const char *description;
{
int i = tablemaxtag[acttable] - strlen(name) + 1;
autodoc_code(name);
while(i > 0)
{
putchar(' ');
i--;
}
putchar('-');
putchar(' ');
if (description)
output_comment(description);
else
autodoc_char('\n');
}
void autodoc_table_end()
{
if(acttable > -1)
acttable--;
autodoc_char('\n');
indent -= indentlength;
if(list_indent > 0)
list_indent -= indentlength;
}
void autodoc_indent()
{
int i;
for(i = indent + list_indent; i ; i--)
autodoc_char(' ');
}
void autodoc_list_start()
{
indent += indentlength;
newline = TRUE;
}
void autodoc_list_entry(name)
const char *name;
{
autodoc_code(name);
}
void autodoc_list_separator() { put_string(" ,"); }
void autodoc_list_end() { autodoc_char('\n'); autodoc_table_end(); }
void autodoc_include(filename)
const char *filename;
{
}
void autodoc_terse_sep()
{
autodoc_char(' ');
autodoc_dash();
autodoc_char(' ');
}
void autodoc_name(name)
const char *name;
{
if(name)
autodoc_text(name);
else
autodoc_section("NAME");
}
void autodoc_file_end()
{
if(!fileend)
putchar('\f');
fileend = TRUE;
newline = FALSE;
}
/* ideally, this should be made aware of embedded autodoc commands */
void autodoc_description(text)
const char *text;
{
enum { TEXT, PERIOD, CAPITALISE } state = CAPITALISE;
boolean new_line = TRUE;
/* correct punctuation a bit as it goes out */
for (;*text;text++)
{
int c = *text;
if (new_line && (c == '-' || c == '*'))
{
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 (state == TEXT) output->character('.');
}
/* ideally, this should be made aware of embedded autodoc commands */
void
autodoc_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;
{
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');
/* 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 autodoc_output =
{
autodoc_comment,
autodoc_header,
autodoc_dash,
autodoc_section,
autodoc_sub_section,
autodoc_break_line,
autodoc_blank_line,
autodoc_code_start,
autodoc_code_end,
autodoc_code,
dummy, /* autodoc_tag_list_start */
dummy, /* autodoc_tag_list_end */
autodoc_tag_entry_start,
autodoc_tag_entry_start_extra,
autodoc_tag_entry_end,
autodoc_tag_entry_end_extra,
autodoc_table_start,
autodoc_table_entry,
autodoc_table_end,
autodoc_indent,
autodoc_list_start,
autodoc_code, /* autodoc_list_entry */
autodoc_list_separator,
autodoc_list_end,
autodoc_include,
autodoc_file_end, /* autodoc_file_end */
autodoc_text,
autodoc_char,
NULL, /* autodoc_parse_option */
dummy, /* autodoc_print_options */
autodoc_name,
autodoc_terse_sep,
autodoc_text, /* autodoc_reference */
autodoc_text, /* autodoc_emphasized */
autodoc_description,
autodoc_returns
};
|