-#LyX 1.4.0cvs created this file. For more info see http://www.lyx.org/
-\lyxformat 243
+#LyX 2.3 created this file. For more info see http://www.lyx.org/
+\lyxformat 541
\begin_document
\begin_header
-\textclass literate-article
+\save_transient_properties true
+\origin /systemlyxdir/examples/
+\textclass article
+\use_default_options false
+\begin_modules
+noweb
+\end_modules
+\maintain_unincluded_children false
\language english
+\language_package default
\inputencoding default
-\fontscheme default
+\fontencoding global
+\font_roman "default" "default"
+\font_sans "default" "default"
+\font_typewriter "default" "default"
+\font_math "auto" "auto"
+\font_default_family default
+\use_non_tex_fonts false
+\font_sc false
+\font_osf false
+\font_sf_scale 100 100
+\font_tt_scale 100 100
+\use_microtype false
+\use_dash_ligatures false
\graphics default
+\default_output_format default
+\output_sync 0
+\bibtex_command default
+\index_command default
\paperfontsize default
\spacing single
+\use_hyperref false
\papersize default
\use_geometry false
-\use_amsmath 0
+\use_package amsmath 0
+\use_package amssymb 0
+\use_package cancel 0
+\use_package esint 0
+\use_package mathdots 1
+\use_package mathtools 0
+\use_package mhchem 1
+\use_package stackrel 0
+\use_package stmaryrd 0
+\use_package undertilde 0
\cite_engine basic
+\cite_engine_type default
+\biblio_style plain
\use_bibtopic false
+\use_indices false
\paperorientation portrait
+\suppress_date false
+\justification true
+\use_refstyle 0
+\index Index
+\shortcut idx
+\color #008000
+\end_index
\secnumdepth 3
\tocdepth 3
\paragraph_separation indent
-\defskip medskip
-\quotes_language english
-\quotes_times 2
+\paragraph_indentation default
+\is_math_indent 0
+\quotes_style english
\papercolumns 1
\papersides 1
\paperpagestyle default
\tracking_changes false
-\output_changes true
+\output_changes false
+\html_math_output 0
+\html_css_as_file 0
+\html_be_strict false
\end_header
\begin_body
\begin_layout Title
+\SpecialChar LyX
+ and Literate Programming
+\begin_inset Newline newline
+\end_inset
-LyX and Literate Programming
-\newline
An example program
\end_layout
\begin_layout Author
-
Edmar Wienskoski Jr.
-\newline
+\begin_inset Newline newline
+\end_inset
+
edmar-w-jr@technologist.com
\begin_inset Foot
status collapsed
-\begin_layout Standard
-
-Modified by Bernard Michael Hurley bernardh@westherts.ac.uk ---- Don't blame
+\begin_layout Plain Layout
+Modified by Bernard Michael Hurley bernardh@westherts.ac.uk —- Don't blame
Edmar for any errors that have crept in!
\end_layout
\end_layout
-\begin_layout Abstract
-
-
-\series bold
-Note:
-\series default
- This example program is provided for educational use only.
- The functionality in this C program has been superceded by the equivalent
- Python code in
-\emph on
-examples/listerrors.lyx
-\emph default
- which should be installed in the LyX scripts directory.
-\end_layout
-
\begin_layout Date
-
-
\begin_inset ERT
status collapsed
-\begin_layout Standard
+\begin_layout Plain Layout
+
\backslash
today
\end_layout
-\begin_layout Standard
+\begin_layout Abstract
+\series bold
+Note:
+\series default
+ This example program is provided for educational use only.
+ The functionality in this C program has been superceded by the equivalent
+ Python code in
+\emph on
+examples/listerrors.lyx
+\emph default
+ which should be installed in the \SpecialChar LyX
+ scripts directory.
+\end_layout
-\begin_inset LatexCommand \tableofcontents{}
+\begin_layout Standard
+\begin_inset CommandInset toc
+LatexCommand tableofcontents
\end_inset
\end_layout
\begin_layout Section
-
Introduction
\end_layout
\begin_layout Standard
-
-After typesetting a document, LyX scans the LaTeX log file looking for errors.
+After typesetting a document, \SpecialChar LyX
+ scans the \SpecialChar LaTeX
+ log file looking for errors.
For each error found, the line number is obtained and a error box is displayed
- in the LyX screen at that position.
+ in the \SpecialChar LyX
+ screen at that position.
\end_layout
\begin_layout Standard
-
To use this feature to view compilation errors while working with literate
documents, we need a program that filters the compilation errors and puts
- them in a format suitable for LyX reading it.
+ them in a format suitable for \SpecialChar LyX
+ reading it.
\end_layout
\begin_layout Standard
-
In this document we present a filter that recognizes compilation error messages
from noweb, gnu C, and the IBM C compiler (xlc).
\end_layout
\begin_layout Standard
-
The filter is required to read from standard input, parse for error messages
and copy the error messages to the standard output.
During the output process, the filter must present the error messages in
- a format that LyX can interpret, currently, the LaTeX error message format.
- Of course, nothing will prevent future LyX releases from being able to
- read other formats as well (like gcc error messages for example).
+ a format that \SpecialChar LyX
+ can interpret, currently, the \SpecialChar LaTeX
+ error message format.
+ Of course, nothing will prevent future \SpecialChar LyX
+ releases from being able to read
+ other formats as well (like gcc error messages for example).
This mechanism is necessary to fully explore the literate programming tool's
capabilities.
\end_layout
\begin_layout Section
-
Algorithm
\end_layout
-\begin_layout Scrap
+\begin_layout Standard
+\begin_inset Flex Chunk
+status open
+
+\begin_layout Plain Layout
+
+\begin_inset Argument 1
+status open
+
+\begin_layout Plain Layout
+Function bodies
+\end_layout
+
+\end_inset
-<<Function bodies>>=
-\newline
int
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
main (int argc, char **argv)
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
{
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
if (argc == 2) {
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
switch (argv[1][0]) {
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
case 'n':
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
<<Scan input for noweb error messages>>
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
break;
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
case 'x':
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
<<Scan input for xlc error messages>>
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
break;
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
case 'a':
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
<<AIX system using both noweb and xlc>>
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
break;
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
case 's':
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
case 'b':
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
<<Solaris and Linux systems using both noweb and gcc>>
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
break;
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
case 'g':
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
default:
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
<<Scan input for gcc error messages>>
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
break;
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
}
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
} else {
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
<<Scan input for gcc error messages>>
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
}
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
}
-\newline
-@
\end_layout
-\begin_layout Scrap
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset Flex Chunk
+status open
+
+\begin_layout Plain Layout
+
+\begin_inset Argument 1
+status open
+
+\begin_layout Plain Layout
+Function prototypes
+\end_layout
+
+\end_inset
-<<Function prototypes>>=
-\newline
int main (int argc, char **argv);
-\newline
-@
\end_layout
-\begin_layout Section
+\end_inset
+
+
+\end_layout
+\begin_layout Section
Data Structures
\end_layout
\begin_layout Standard
-
We resort to some global variables to allow access from several different
routines.
These are the buffer and related pointers used during the parse of the
input.
\end_layout
-\begin_layout Scrap
+\begin_layout Standard
+\begin_inset ERT
+status open
+
+\begin_layout Plain Layout
<<Global variables>>=
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
char buffer[200][200];
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
int last_buf_line;
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
int last_err_line;
-\newline
-int err_line;
-\newline
-@
\end_layout
-\begin_layout Section
+\begin_layout Plain Layout
+
+int err_line;@
+\end_layout
+
+\end_inset
+
+\end_layout
+
+\begin_layout Section
The output format
\end_layout
\begin_layout Standard
-
-The output format mimics the TeX error messages format.
+The output format mimics the \SpecialChar TeX
+ error messages format.
This function prints a number of lines residing in the global variable
\family typewriter
\begin_inset Foot
status collapsed
-\begin_layout Standard
-
+\begin_layout Plain Layout
This function has been slightly changed from EW's original to make scanning
- a bit easier with LaTeX::scanLogFile().
- The test has been added because LyX can crash if empty lines are allowed
- here --- I can't figure out why! --- BMH
+ a bit easier with \SpecialChar LaTeX
+::scanLogFile().
+ The test has been added because \SpecialChar LyX
+ can crash if empty lines are allowed here
+ — I can't figure out why! — BMH
\end_layout
\end_inset
\end_layout
-\begin_layout Scrap
+\begin_layout Standard
+\begin_inset Flex Chunk
+status open
+
+\begin_layout Plain Layout
+
+\begin_inset Argument 1
+status open
+
+\begin_layout Plain Layout
+Function bodies
+\end_layout
+
+\end_inset
-<<Function bodies>>=
-\newline
void
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
output_error (int buf_size, int error_line, char *tool)
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
{
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
int i;
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
fprintf(stdout, "! Build Error: ==> %s ==>
\backslash
n", tool);
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
fprintf(stdout, " ...
\backslash
n
nl.%d ...
\backslash
n", error_line);
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
for (i=0; i<buf_size; i++)
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
if (strlen(buffer[i]) != 0)
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
fprintf(stdout, "%s", buffer[i]);
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
fprintf(stdout, "
\backslash
n");
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
}
-\newline
-@
\end_layout
-\begin_layout Scrap
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset Flex Chunk
+status open
+
+\begin_layout Plain Layout
+
+\begin_inset Argument 1
+status open
+
+\begin_layout Plain Layout
+Function prototypes
+\end_layout
+
+\end_inset
-<<Function prototypes>>=
-\newline
void output_error (int buf_size, int error_line, char *tool);
-\newline
-@
\end_layout
-\begin_layout Section
+\end_inset
+
+\end_layout
+
+\begin_layout Section
Functions Implementation
\end_layout
\begin_layout Standard
-
Both noweave and notangle routines, always output one single line for each
error found, thus to scan the buffer for noweb error messages is enough
to exam one input line at a time.
of the file.
\end_layout
-\begin_layout Scrap
+\begin_layout Standard
+\begin_inset Flex Chunk
+status open
-<<Scan input for noweb error messages>>=
-\newline
-{
-\newline
- last_buf_line = 0;
-\newline
- while (fgets(buffer[0], 200, stdin)) {
-\newline
- if (noweb_try(0))
-\newline
- output_error(1, err_line, "noweb");
-\newline
- }
-\newline
-}
-\newline
-@
-\end_layout
+\begin_layout Plain Layout
-\begin_layout Standard
+\begin_inset Argument 1
+status open
-The examination itself is very inefficient.
+\begin_layout Plain Layout
+Scan input for noweb error messages
+\end_layout
+
+\end_inset
+
+{
+\end_layout
+
+\begin_layout Plain Layout
+
+ last_buf_line = 0;
+\end_layout
+
+\begin_layout Plain Layout
+
+ while (fgets(buffer[0], 200, stdin)) {
+\end_layout
+
+\begin_layout Plain Layout
+
+ if (noweb_try(0))
+\end_layout
+
+\begin_layout Plain Layout
+
+ output_error(1, err_line, "noweb");
+\end_layout
+
+\begin_layout Plain Layout
+
+ }
+\end_layout
+
+\begin_layout Plain Layout
+
+}
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+The examination itself is very inefficient.
Unfortunately noweb doesn't have any characteristic that would help to
identify one of its error messages.
The solution is to collect all possible output messages in an array of
array.
\end_layout
-\begin_layout Scrap
+\begin_layout Standard
+\begin_inset Flex Chunk
+status open
+
+\begin_layout Plain Layout
+
+\end_layout
+
+\begin_layout Plain Layout
<<Global variables>>=
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
char *noweb_msgs[] = {
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
"couldn't open file",
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
"couldn't open temporary file",
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
"error writing temporary file",
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
"ill-formed option",
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
"unknown option",
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
"Bad format sequence",
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
"Can't open output file",
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
"Can't open temporary file",
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
"Capacity exceeded:",
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
"Ignoring unknown option -",
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
"This can't happen:",
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
"non-numeric line number in"
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
};
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
+\end_layout
+
+\begin_layout Plain Layout
-\newline
char *noweb_msgs_mimic_gcc[] = {
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
": unescaped << in documentation chunk"
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
};
-\newline
-@
\end_layout
-\begin_layout Standard
+\end_inset
+
+\end_layout
+
+\begin_layout Standard
A noweb error message can be any string that contains a matching pair of
- < <\InsetSpace ~
-\InsetSpace ~
-\InsetSpace ~
+ < <
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset space ~
+\end_inset
+
+
+\begin_inset space ~
+\end_inset
+
> >, or any of the above strings
\end_layout
-\begin_layout Scrap
+\begin_layout Standard
+\begin_inset ERT
+status open
+
+\begin_layout Plain Layout
<<Function bodies>>=
-\newline
-int
-\newline
-noweb_try (int buf_line)
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
+int noweb_try (int buf_line)
+\end_layout
+
+\begin_layout Plain Layout
+
{
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
char *s, *t, *b;
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
int i;
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
+\end_layout
+
+\begin_layout Plain Layout
-\newline
b = buffer[buf_line];
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
err_line = 0;
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
+\end_layout
+
+\begin_layout Plain Layout
-\newline
for (i=0; i<1; i++) {
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
s = (char *)strstr (b, noweb_msgs_mimic_gcc[i]);
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
if (s != NULL) {
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
t = (char *)strchr(buffer[buf_line], ':');
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
err_line = atoi(t+1);
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
t = buffer[buf_line];
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
++s;
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
while (*(t++) = *(s++));
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
return 1;
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
}
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
}
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
s = (char *)strstr(b, "<<");
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
if (s != NULL) {
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
s = (char *)strstr(s+2, ">>");
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
if (s != NULL) {
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
return 1;
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
}
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
} else {
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
for (i = 0; i < 12; ++i) {
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
s = (char *)strstr (b, noweb_msgs[i]);
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
if (s != NULL) {
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
return 1;
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
}
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
}
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
}
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
return 0;
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
}
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
@
\end_layout
-\begin_layout Scrap
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset ERT
+status open
+
+\begin_layout Plain Layout
<<Function prototypes>>=
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
int noweb_try (int buf_line);
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
@
\end_layout
-\begin_layout Standard
+\end_inset
+
+
+\end_layout
+\begin_layout Standard
The xlc compiler always outputs one single line for each error found, thus
to scan the buffer for xlc error messages it is enough to exam one input
line at a time.
\end_layout
-\begin_layout Scrap
+\begin_layout Standard
+\begin_inset Flex Chunk
+status open
+
+\begin_layout Plain Layout
+
+\begin_inset Argument 1
+status open
+
+\begin_layout Plain Layout
+Scan input for xlc error messages
+\end_layout
+
+\end_inset
-<<Scan input for xlc error messages>>=
-\newline
{
-\newline
- last_buf_line = 0;
-\newline
- while (fgets(buffer[last_buf_line], 200, stdin)) {
-\newline
- if (xlc_try(0))
-\newline
- output_error(1, err_line, "xlc");
-\newline
- }
-\newline
-}
-\newline
-@
\end_layout
-\begin_layout Standard
+\begin_layout Plain Layout
+ last_buf_line = 0;
+\end_layout
+
+\begin_layout Plain Layout
+
+ while (fgets(buffer[last_buf_line], 200, stdin)) {
+\end_layout
+
+\begin_layout Plain Layout
+
+ if (xlc_try(0))
+\end_layout
+
+\begin_layout Plain Layout
+
+ output_error(1, err_line, "xlc");
+\end_layout
+
+\begin_layout Plain Layout
+
+ }
+\end_layout
+
+\begin_layout Plain Layout
+
+}
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
A xlc error message is easy to identify.
Every error message starts with a quoted string with no spaces, a comma,
a space, the word
The following routine tests if a given buffer line matches this criteria:
\end_layout
-\begin_layout Scrap
+\begin_layout Standard
+\begin_inset Flex Chunk
+status open
+
+\begin_layout Plain Layout
+
+\end_layout
+
+\begin_layout Plain Layout
+
+\end_layout
+
+\begin_layout Plain Layout
<<Function bodies>>=
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
int
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
xlc_try (int buf_line)
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
{
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
char *s, *t;
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
t = buffer[buf_line];
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
s = t+1;
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
while (*s != '"' && *s != ' ' && *s != '
\backslash
0')
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
s++;
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
if (*t != '"' || *s != '"' || strncmp(s+1, ", line ", 7) != 0)
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
return 0;
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
s += 8;
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
err_line = atoi(s);
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
return 1;
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
}
-\newline
-@
\end_layout
-\begin_layout Scrap
+\end_inset
+
-<<Function prototypes>>=
-\newline
-int xlc_try (int buf_line);
-\newline
-@
\end_layout
\begin_layout Standard
+\begin_inset Flex Chunk
+status open
+
+\begin_layout Plain Layout
+
+\begin_inset Argument 1
+status open
+
+\begin_layout Plain Layout
+Function prototypes
+\end_layout
+
+\end_inset
+
+int xlc_try (int buf_line);
+\end_layout
+
+\end_inset
+
+\end_layout
+
+\begin_layout Standard
The gcc compiler error messages are more complicated to scan.
Each error can span more than one line in the buffer.
The good news is that every buffer line on each error has the same pattern,
line number is still the same.
At the time they differ, all the accumulated lines, except the last one,
will belong to one single error message, which now can be output-ed to
- LyX.
+ \SpecialChar LyX
+.
\end_layout
\begin_layout Standard
-
Every gcc error message contains a string with no space followed by a
\begin_inset Quotes eld
\end_inset
.
\end_layout
-\begin_layout Scrap
+\begin_layout Standard
+\begin_inset Flex Chunk
+status open
+
+\begin_layout Plain Layout
+
+\begin_inset Argument 1
+status open
+
+\begin_layout Plain Layout
+Scan input for gcc error messages
+\end_layout
+
+\end_inset
-<<Scan input for gcc error messages>>=
-\newline
{
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
char *s, *t;
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
last_buf_line = 0;
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
while (fgets(buffer[last_buf_line], 200, stdin)) {
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
/****** Skip lines until I find an error */
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
s = (char *)strpbrk(buffer[last_buf_line], " :");
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
if (s == NULL || *s == ' ')
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
continue; /* No gcc error found here */
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
do {
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
<<gcc error message criteria is to find a "...:999:" or a "...: ">>
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
/****** OK It is an error message, get line number */
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
err_line = atoi(s+1);
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
if (last_err_line == 0 || last_err_line == err_line) {
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
last_err_line = err_line;
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
continue; /* It's either a header or a continuation, don't output
yet */
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
}
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
/****** Completed the scan of one error message, output it to LyX
*/
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
discharge_buffer(1);
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
break;
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
} while (fgets(buffer[last_buf_line], 200, stdin));
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
}
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
/****** EOF completes the scan of whatever was being scanned */
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
discharge_buffer(0);
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
}
-\newline
-@
\end_layout
-\begin_layout Scrap
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset Flex Chunk
+status open
+
+\begin_layout Plain Layout
+
+\begin_inset Argument 1
+status open
+
+\begin_layout Plain Layout
+gcc error message criteria is to find a "...:999:" or a "...: "
+\end_layout
+
+\end_inset
-<<gcc error message criteria is to find a "...:999:" or a "...: ">>=
-\newline
/****** Search first ":" in the error number */
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
s = (char *)strpbrk(buffer[last_buf_line], " :");
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
last_buf_line++;
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
if (s == NULL || *s == ' ')
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
<<No gcc error found here, but it might terminate the scanning of a previous
one>>
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
/****** Search second ":" in the error number */
-\newline
-t = (char *)strpbrk(s+1, " :");
-\newline
-if (t == NULL || *t == ' ')
-\newline
- <<No gcc error found here, but it might terminate the scanning of a previous
- one>>
-\newline
-/****** Verify if is all digits between ":" */
-\newline
-if (t != s+1+strspn(s+1, "0123456789"))
-\newline
- <<No gcc error found here, but it might terminate the scanning of a previous
- one>>
-\newline
-@
\end_layout
-\begin_layout Scrap
+\begin_layout Plain Layout
+
+t = (char *)strpbrk(s+1, " :");if (t == NULL || *t == ' ') <<No gcc error
+ found here, but it might terminate the scanning of a previous one>>/******
+ Verify if is all digits between ":" */if (t != s+1+strspn(s+1, "0123456789"))
+ <<No gcc error found here, but it might terminate the scanning of a previous
+ one>>@
+\end_layout
+
+\begin_layout Plain Layout
+
+\end_layout
+
+\begin_layout Plain Layout
+
+\end_layout
+
+\begin_layout Plain Layout
<<No gcc error found here, but it might terminate the scanning of a previous
one>>=
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
{
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
err_line = 0;
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
discharge_buffer(1);
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
continue;
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
}
-\newline
-@
\end_layout
-\begin_layout Standard
+\end_inset
+
+
+\end_layout
+\begin_layout Standard
As we mentioned, when the scan of one gcc error message is completed everything
in the buffer except the last line is one single error message.
But if the scan terminates with a EOF or through finding one line that
In those cases we empty the buffer completely.
\end_layout
-\begin_layout Scrap
+\begin_layout Standard
+\begin_inset Flex Chunk
+status open
+
+\begin_layout Plain Layout
+
+\end_layout
+
+\begin_layout Plain Layout
+
+\end_layout
+
+\begin_layout Plain Layout
<<Function bodies>>=
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
void
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
discharge_buffer (int save_last)
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
{
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
if (last_err_line != 0) {
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
clean_gcc_messages();
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
if (save_last != 0) {
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
output_error(last_buf_line-1, last_err_line, "gcc");
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
strcpy (buffer[0], buffer[last_buf_line-1]);
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
last_err_line = err_line;
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
last_buf_line = 1;
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
} else {
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
++last_buf_line;
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
clean_gcc_messages();
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
output_error(last_buf_line-1, last_err_line, "gcc");
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
last_err_line = 0;
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
last_buf_line = 0;
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
}
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
}
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
}
-\newline
-@
\end_layout
-\begin_layout Scrap
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset Flex Chunk
+status open
+
+\begin_layout Plain Layout
+
+\begin_inset Argument 1
+status open
+
+\begin_layout Plain Layout
+Function prototypes
+\end_layout
+
+\end_inset
-<<Function prototypes>>=
-\newline
void discharge_buffer (int save_last);
-\newline
-@
\end_layout
-\begin_layout Standard
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+The next function
+\begin_inset Quotes eld
+\end_inset
+
+cleans
+\begin_inset Quotes erd
+\end_inset
+
+ superfluous information from gcc messages, namely the name of the noweb
+ file and the line number of the Error.
+\begin_inset Foot
+status collapsed
+
+\begin_layout Plain Layout
+More could be done.
+ For instance, some way of distinguishing between gcc Errors and Warnings
+ should be devised.
+\end_layout
+
+\end_inset
+
+
+\end_layout
+
+\begin_layout Standard
+\begin_inset Flex Chunk
+status open
+
+\begin_layout Plain Layout
+
+\begin_inset Argument 1
+status open
+
+\begin_layout Plain Layout
+Function bodies
+\end_layout
+
+\end_inset
+
+void
+\end_layout
+
+\begin_layout Plain Layout
+
+clean_gcc_messages ()
+\end_layout
+
+\begin_layout Plain Layout
+
+{
+\end_layout
+
+\begin_layout Plain Layout
+
+ int index;
+\end_layout
+
+\begin_layout Plain Layout
+
+ char search [30];
+\end_layout
+
+\begin_layout Plain Layout
+
+ char *tail, *head;
+\end_layout
+
+\begin_layout Plain Layout
+
+ int search_len = sprintf(search, ".nw:%d:", last_err_line);
+\end_layout
+
+\begin_layout Plain Layout
+
+
+\end_layout
+
+\begin_layout Plain Layout
+
+ for (index = 0; index < last_buf_line-1; index++) {
+\end_layout
+
+\begin_layout Plain Layout
+
+ tail = (char *)strstr (buffer[index], search);
+\end_layout
+
+\begin_layout Plain Layout
+
+ if ( tail == NULL) {
+\end_layout
+
+\begin_layout Plain Layout
+
+ tail = (char *) strstr (buffer[index], ".nw:");
+\end_layout
+
+\begin_layout Plain Layout
+
+ if (tail) {
+\end_layout
+
+\begin_layout Plain Layout
+
+ tail += 4;
+\end_layout
+
+\begin_layout Plain Layout
+
+ }
+\end_layout
+
+\begin_layout Plain Layout
+
+ } else {
+\end_layout
+
+\begin_layout Plain Layout
+
+ tail += search_len;
+\end_layout
+
+\begin_layout Plain Layout
+
+ }
+\end_layout
+
+\begin_layout Plain Layout
+
+ if (tail != NULL) {
+\end_layout
+
+\begin_layout Plain Layout
+
+ head = buffer[index];
+\end_layout
+
+\begin_layout Plain Layout
+
+ while (*(head++) = *(tail++));
+\end_layout
+
+\begin_layout Plain Layout
+
+ }
+\end_layout
+
+\begin_layout Plain Layout
+
+ }
+\end_layout
+
+\begin_layout Plain Layout
-The next function
-\begin_inset Quotes eld
-\end_inset
+}
+\end_layout
-cleans
-\begin_inset Quotes erd
\end_inset
- superfluous information from gcc messages, namely the name of the noweb
- file and the line number of the Error.
-\begin_inset Foot
-status collapsed
-
-\begin_layout Standard
-More could be done.
- For instance, some way of distinguishing between gcc Errors and Warnings
- should be devised.
\end_layout
-\end_inset
+\begin_layout Standard
+\begin_inset Flex Chunk
+status open
+\begin_layout Plain Layout
+\begin_inset Argument 1
+status open
+
+\begin_layout Plain Layout
+Function prototypes
\end_layout
-\begin_layout Scrap
+\end_inset
-<<Function bodies>>=
-\newline
-void
-\newline
-clean_gcc_messages ()
-\newline
-{
-\newline
- int index;
-\newline
- char search [30];
-\newline
- char *tail, *head;
-\newline
- int search_len = sprintf(search, ".nw:%d:", last_err_line);
-\newline
-
-\newline
- for (index = 0; index < last_buf_line-1; index++) {
-\newline
- tail = (char *)strstr (buffer[index], search);
-\newline
- if ( tail == NULL) {
-\newline
- tail = (char *) strstr (buffer[index], ".nw:");
-\newline
- if (tail) {
-\newline
- tail += 4;
-\newline
- }
-\newline
- } else {
-\newline
- tail += search_len;
-\newline
- }
-\newline
- if (tail != NULL) {
-\newline
- head = buffer[index];
-\newline
- while (*(head++) = *(tail++));
-\newline
- }
-\newline
- }
-\newline
-}
-\newline
-@
+void clean_gcc_messages ();
\end_layout
-\begin_layout Scrap
+\end_inset
+
-<<Function prototypes>>=
-\newline
-void clean_gcc_messages ();
-\newline
-@
\end_layout
\begin_layout Standard
-
To combine the scan of noweb error messages and xlc error messages is very
simple.
We just try each one for every input line:
\end_layout
-\begin_layout Scrap
+\begin_layout Standard
+\begin_inset ERT
+status open
+
+\begin_layout Plain Layout
<<AIX system using both noweb and xlc>>=
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
{
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
last_buf_line = 0;
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
while (fgets(buffer[0], 200, stdin)) {
-\newline
- if (noweb_try(0))
-\newline
- output_error(1, err_line, "noweb");
-\newline
- else if (xlc_try(0))
-\newline
- output_error(1, err_line, "xlc");
-\newline
- }
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
+ if (noweb_try(0))
+\end_layout
+
+\begin_layout Plain Layout
+
+ output_error(1, err_line, "noweb");
+\end_layout
+
+\begin_layout Plain Layout
+
+ else if (xlc_try(0))
+\end_layout
+
+\begin_layout Plain Layout
+
+ output_error(1, err_line, "xlc");
+\end_layout
+
+\begin_layout Plain Layout
+
+ }
+\end_layout
+
+\begin_layout Plain Layout
+
}
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
@
\end_layout
-\begin_layout Standard
+\end_inset
+
+
+\end_layout
+\begin_layout Standard
To combine the scan of noweb error messages and gcc error messages is simple
if we realize that it is not possible to find a noweb error message in
the middle of a gcc error message.
the beginning of the scan:
\end_layout
-\begin_layout Scrap
+\begin_layout Standard
+\begin_inset Flex Chunk
+status open
+
+\begin_layout Plain Layout
+
+\begin_inset Argument 1
+status open
+
+\begin_layout Plain Layout
+Solaris and Linux systems using both noweb and gcc
+\end_layout
+
+\end_inset
-<<Solaris and Linux systems using both noweb and gcc>>=
-\newline
{
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
char *s, *t;
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
last_buf_line = 0;
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
while (fgets(buffer[last_buf_line], 200, stdin)) {
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
/****** Skip lines until I find an error */
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
if (last_buf_line == 0 && noweb_try(0)) {
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
output_error(1, err_line, "noweb");
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
continue;
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
}
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
s = (char *)strpbrk(buffer[last_buf_line], " :");
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
if (s == NULL || *s == ' ')
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
continue; /* No gcc error found here */
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
do {
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
<<gcc error message criteria is to find a "...:999:" or a "...: ">>
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
/****** OK It is an error, get line number */
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
err_line = atoi(s+1);
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
if (last_err_line == 0 || last_err_line == err_line) {
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
last_err_line = err_line;
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
continue; /* It's either a header or a continuation, don't output
yet */
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
}
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
/****** Completed the scan of one error message, output it to LyX
*/
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
discharge_buffer(1);
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
break;
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
} while (fgets(buffer[last_buf_line], 200, stdin));
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
}
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
/****** EOF completes the scan of whatever was being scanned */
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
discharge_buffer(0);
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
}
-\newline
-@
\end_layout
-\begin_layout Section
+\end_inset
+
+\end_layout
+
+\begin_layout Section
Wrapping the code into a file
\end_layout
-\begin_layout Scrap
+\begin_layout Standard
+\begin_inset Flex Chunk
+status open
+
+\begin_layout Plain Layout
+
+\begin_inset Argument 1
+status open
+
+\begin_layout Plain Layout
+listerrors.c
+\end_layout
+
+\end_inset
-<<listerrors.c>>=
-\newline
#include <stdio.h>
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
#include <strings.h>
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
<<Global variables>>
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
<<Function prototypes>>
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
<<Function bodies>>
-\newline
-@
\end_layout
-\begin_layout Standard
+\end_inset
+
+
+\end_layout
+\begin_layout Standard
To build this program, we want to add the
\begin_inset Quotes eld
\end_inset
option to gcc.
\end_layout
-\begin_layout Scrap
+\begin_layout Standard
+\begin_inset Flex Chunk
+status open
+
+\begin_layout Plain Layout
+
+\begin_inset Argument 1
+status open
+
+\begin_layout Plain Layout
+build-script
+\end_layout
+
+\end_inset
-<<build-script>>=
-\newline
#!/bin/sh
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
if [ -z "$NOWEB_SOURCE" ]; then NOWEB_SOURCE=Literate.nw; fi
-\newline
-notangle -L -Rlisterrors.c ${NOWEB_SOURCE} > listerrors.c
-\newline
+\end_layout
+
+\begin_layout Plain Layout
+
+if [ -z "$NOWEB_OUTPUT_DIR" ]; then NOWEB_OUTPUT_DIR=.; fi
+\end_layout
+
+\begin_layout Plain Layout
+
+notangle -L -Rlisterrors.c ${NOWEB_SOURCE} > ${NOWEB_OUTPUT_DIR}/listerrors.c
+\end_layout
+
+\begin_layout Plain Layout
+
gcc -g -o listerrors listerrors.c
-\newline
-@
\end_layout
-\begin_layout Standard
+\end_inset
+
+
+\end_layout
-This project can be tangled and compiled from LyX if you set
+\begin_layout Standard
+This project can be tangled and compiled from \SpecialChar LyX
+ if you set
\family typewriter
\backslash
build_command
\family default
- to call a generic script that always extracts a scrap named
+ to call a generic script that always extracts a chunk named
\family typewriter
build-script
\family default
\end_layout
\begin_layout LyX-Code
-
#!/bin/sh
-\newline
-notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 sh
+\begin_inset Newline newline
+\end_inset
+
+notangle -Rbuild-script $1 | env NOWEB_SOURCE=$1 NOWEB_OUTPUT_DIR=$r sh
\end_layout
\begin_layout LyX-Code
projects / lyx.git / blobdiff