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
|
/* document.c - handle report of various documenting formats
Copyright 1988-2022 Free Software Foundation, Inc.
This program 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, or (at your option)
any later version.
This program 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, write to the Free Software
Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA
02110-1301, USA. */
#include <config.h>
#include "a2ps.h"
#include "routines.h"
#include "document.h"
#include "xstrrpl.h"
/* The rules for authors to Texinfo */
#define AUTHORS_TO_TEXINFO \
"@", "@@", \
NULL
/* The rules to convert documentation to another format */
/* 1. Plain ASCII */
#define DOC_TO_PLAIN \
"url(", "", \
")url(", " (", \
")url", ")", \
"samp(", "`", \
")samp", "'", \
"emph(", "*", \
")emph", "*", \
"code(", "", \
")code", "", \
"@example\n", "", \
"@end example\n", "", \
"@end example", "", /* Just in case */ \
"@itemize\n", "", \
"@end itemize", "", \
"@item\n", " - ", \
"@@", "@", \
NULL
/* 2. Towards HTML */
#define DOC_TO_HTML \
"url(", "<a href=\"", \
")url(", "\">", \
")url", "</a>", \
"emph(", "<emph>", \
")emph", "</emph>'", \
"samp(", "`<code>", \
")samp", "</code>'", \
"code(", "<code>", \
")code", "</code>", \
"@example", "<pre>", \
"@end example", "</pre>", \
"@itemize", "<ul>", \
"@end itemize", "</ul>", \
"@item\n", "<li>", \
"@@", "@", \
NULL
/* 3. Towards Texinfo */
#define DOC_TO_TEXINFO \
"emph(", "@emph{", \
")emph", "}", \
"samp(", "@samp{", \
")samp", "}", \
"code(", "@code{", \
")code", "}", \
"url(", "@href{", \
")url(", ",", \
")url", "}", \
"@itemize", "@itemize @minus", \
NULL
/************************************************************************/
/* The authors list handling */
/************************************************************************/
/*
* Split the authors and print them on STREAM using AUTHOR_FMT
* (which %1s is clean name, and %2s is the email), separated
* with BETWEEN). They must be separated with ',', and
* use this convention "First Last <email>".
*/
static void
authors_print (const char * authors, FILE * stream,
const char *before,
const char *author_fmt, const char *between,
const char *after)
{
char *cp, *author, *email;
const char *authors_end;
bool first = true;
if (!authors)
return;
/* Work on a copy */
astrcpy (cp, authors);
authors_end = cp + strlen (authors);
cp = strtok (cp, ",");
while (cp)
{
author = cp;
email = author + strcspn (author, "<");
*(email - 1) = '\0';
email++;
if (email > authors_end)
return;
*(email + strcspn (email, ">")) = '\0';
*(email - 1) = '\0';
if (first)
{
fputs (before, stream);
first = false;
}
else
fputs (between, stream);
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wformat-nonliteral"
fprintf (stream, author_fmt, author, email);
#pragma GCC diagnostic pop
cp = strtok (NULL, ",");
}
if (!first)
fputs (after, stream);
}
/*
* Plain : nothing to change
*/
void
authors_print_plain (const char * authors, FILE * stream,
const char *before)
{
authors_print (authors, stream,
before, "%s <%s>", ", ", ".\n");
}
/*
* HTML : nothing to change
*/
void
authors_print_html (const char * authors, FILE * stream,
const char *before)
{
authors_print (authors, stream,
before,
"<a href=\"mailto:%2$s\">%1$s</a>", ", ",
".\n");
}
/*
* Plain : nothing to change
*/
void
authors_print_texinfo (const char * authors, FILE * stream,
const char *before)
{
/* We must quote the @ of the emails */
char *cp = xvstrrpl ((const char *) authors,
AUTHORS_TO_TEXINFO);
/* Don't print the email, that makes too wide output. */
authors_print (cp, stream,
before, "%s", ", ", ".\n");
}
/************************************************************************/
/* The documentation handling */
/************************************************************************/
/* 1. Plain ASCII */
void
documentation_print_plain (const char * documentation,
const char *format, FILE * stream)
{
if (!documentation)
return;
char *cp = xvstrrpl (documentation, DOC_TO_PLAIN);
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wformat-nonliteral"
fprintf (stream, format, cp);
#pragma GCC diagnostic pop
}
/* 2. Towards HTML */
void
documentation_print_html (const char * documentation,
const char *format, FILE * stream)
{
if (!documentation)
return;
char *cp = xvstrrpl (documentation, DOC_TO_HTML);
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wformat-nonliteral"
fprintf (stream, format, cp);
#pragma GCC diagnostic pop
}
/* 3. Towards Texinfo */
void
documentation_print_texinfo (const char * documentation,
const char *format, FILE * stream)
{
if (!documentation)
return;
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wformat-nonliteral"
char *cp = xvstrrpl (documentation, DOC_TO_TEXINFO);
fprintf (stream, format, cp);
#pragma GCC diagnostic pop
}
|