-#This file was created by <kayvan> Sun May 2 15:56:35 1999
-#LyX 1.0 (C) 1995-1999 Matthias Ettrich and the LyX Team
-\lyxformat 2.15
+#LyX 1.3 created this file. For more info see http://www.lyx.org/
+\lyxformat 221
\textclass literate-article
\begin_preamble
%
\def\nwendcode{\endtrivlist \endgroup}
\let\nwdocspar=\smallbreak
\end_preamble
-\language default
+\language english
\inputencoding default
\fontscheme default
\graphics default
\paperfontsize default
-\spacing single
+\spacing single
\papersize Default
\paperpackage a4
\use_geometry 0
\use_amsmath 0
+\use_natbib 0
+\use_numerical_citations 0
\paperorientation portrait
\secnumdepth 3
\tocdepth 3
# Copyright (C) 1999 Kayvan A.
Sylvan <kayvan@sylvan.com>
\newline
-#
-\protected_separator
-You are free to use and modify this code under the terms of
+# You are free to use and modify this code under the terms of
\newline
# the GNU General Public Licence version 2 or later.
\newline
#
\newline
-#
-\protected_separator
-Written with assistance from:
+# Written with assistance from:
\newline
-#
-\protected_separator
- Edmar Wienskoski Jr.
+# Edmar Wienskoski Jr.
<edmar-w-jr@technologist.com>
\newline
-#
-\protected_separator
- Amir Karger <karger@post.harvard.edu>
+# Amir Karger <karger@post.harvard.edu>
\newline
#
\newline
-# $Id: noweb2lyx.lyx,v 1.1 1999/09/27 18:44:32 larsbj Exp $
+# $Id: noweb2lyx.lyx,v 1.4 2003/01/17 13:50:11 lasgouttes Exp $
\newline
#
\newline
Code chunks look like this:
\layout LyX-Code
-<<Name of chunk here>>=
+<
+\begin_inset ERT
+status Collapsed
+
+\layout Standard
+{}
+\end_inset
+
+<Name of chunk here>
+\begin_inset ERT
+status Collapsed
+
+\layout Standard
+{}
+\end_inset
+
+>=
\newline
{...
code for the chunk goes here ...}
The other form that the ``@'' line takes is as follows:
\layout LyX-Code
-<<Name of chunk here>>=
+<
+\begin_inset ERT
+status Collapsed
+
+\layout Standard
+{}
+\end_inset
+
+<Name of chunk here>
+\begin_inset ERT
+status Collapsed
+
+\layout Standard
+{}
+\end_inset
+
+>=
\newline
{...
code for the chunk ...}
\noun default
code chunks.
This proved to be too hard and presents other problems
-\begin_float footnote
+\begin_inset Foot
+collapsed true
+
\layout Standard
Not the least of these problems is the fact that << is a quote in French.
-\end_float
+\end_inset
+
.
On the other hand, it turns out that reLyX contains a very useful literal
quoting mechanism.
We want to be able to run it as a simple pre-processor and post-processor
from within reLyX.
We can accomplish this by setting the flags
-\latex latex
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+
+\begin_inset ERT
+status Collapsed
+
+\layout Standard
[[pre_only]]
-\latex default
+\end_inset
+
+
+\family default
+\series default
+\shape default
+\size default
+\emph default
+\bar default
+\noun default
+\color default
and
-\latex latex
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+
+\begin_inset ERT
+status Collapsed
+
+\layout Standard
[[post_only]]
-\latex default
+\end_inset
+
+
+\family default
+\series default
+\shape default
+\size default
+\emph default
+\bar default
+\noun default
+\color default
before we reach the main conversion code.
\layout Standard
\newline
if (!$post_only) {
\newline
-
-\protected_separator
-
-\protected_separator
-<<Transform noweb for reLyX>>
+ <<Transform noweb for reLyX>>
\newline
}
\newline
if ((!$pre_only) && (!$post_only)) {
\newline
-
-\protected_separator
-
-\protected_separator
-<<Run reLyX on intermediate file>>
+ <<Run reLyX on intermediate file>>
\newline
}
\newline
if (!$pre_only) {
\newline
-
-\protected_separator
-
-\protected_separator
-<<Fix up LyX file>>
+ <<Fix up LyX file>>
\newline
}
\newline
\newline
{
\newline
-
-\protected_separator
-
-\protected_separator
-if (/^
+ if (/^
\backslash
s*
\backslash
\backslash
>=/) { # Beginning of a noweb scrap
\newline
-
-\protected_separator
-
-\protected_separator
-
-\protected_separator
-
-\protected_separator
-<<Read in and output the noweb code chunk>>
+ <<Read in and output the noweb code chunk>>
\newline
-
-\protected_separator
-
-\protected_separator
-} elsif (/^@
+ } elsif (/^@
\backslash
s+(.*)/) { # Beginning of a documentation chunk
\newline
-
-\protected_separator
-
-\protected_separator
-
-\protected_separator
-
-\protected_separator
-print OUTPUT $1; # We do not need the ``@'' part
+ print OUTPUT $1; # We do not need the ``@'' part
\newline
-
-\protected_separator
-
-\protected_separator
-} elsif (/
+ } elsif (/
\backslash
[
\backslash
\backslash
]/) { # noweb quoted code
\newline
-
-\protected_separator
-
-\protected_separator
-
-\protected_separator
-
-\protected_separator
-<<Perform special input quoting of [[var]]>>
+ <<Perform special input quoting of [[var]]>>
\newline
-
-\protected_separator
-
-\protected_separator
-} else {
+ } else {
\newline
-
-\protected_separator
-
-\protected_separator
-
-\protected_separator
-
-\protected_separator
-print OUTPUT; # Just let the line pass through
+ print OUTPUT; # Just let the line pass through
\newline
-
-\protected_separator
-
-\protected_separator
-}
+ }
\newline
}
\newline
\layout Standard
While reading in the
-\latex latex
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+
+\begin_inset ERT
+status Collapsed
+
+\layout Standard
[[INPUT]]
-\latex default
+\end_inset
+
+
+\family default
+\series default
+\shape default
+\size default
+\emph default
+\bar default
+\noun default
+\color default
file, once we have identified a
\noun on
noweb
noweb2lyx
\noun default
, we will use
-\latex latex
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+
+\begin_inset ERT
+status Collapsed
+
+\layout Standard
[[INPUT]]
-\latex default
+\end_inset
+
+
+\family default
+\series default
+\shape default
+\size default
+\emph default
+\bar default
+\noun default
+\color default
and
-\latex latex
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+
+\begin_inset ERT
+status Collapsed
+
+\layout Standard
[[OUTPUT]]
-\latex default
+\end_inset
+
+
+\family default
+\series default
+\shape default
+\size default
+\emph default
+\bar default
+\noun default
+\color default
to read and write files.
In the code fragment above, we need to read from the input file and write
to a file that will be later transformed by reLyX.
\newline
if ($pre_only) {
\newline
-
-\protected_separator
-
-\protected_separator
-&setup_files($input_file, $output_file);
+ &setup_files($input_file, $output_file);
\newline
} else {
\newline
-
-\protected_separator
-
-\protected_separator
-$relyx_file = "temp$$";
+ $relyx_file = "temp$$";
\newline
-
-\protected_separator
-
-\protected_separator
-&setup_files($input_file, $relyx_file);
+ &setup_files($input_file, $relyx_file);
\newline
}
\newline
\layout Standard
This code uses a small perl subroutine,
-\latex latex
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+
+\begin_inset ERT
+status Collapsed
+
+\layout Standard
[[setup_files]]
-\latex default
+\end_inset
+
+
+\family default
+\series default
+\shape default
+\size default
+\emph default
+\bar default
+\noun default
+\color default
, which we define below:
\layout Scrap
\newline
sub setup_files {
\newline
-
-\protected_separator
-
-\protected_separator
-my($in, $out) = @_;
+ my($in, $out) = @_;
\newline
-
-\protected_separator
-
-\protected_separator
-open(INPUT, "<$in") || die "Can not read $in: $!
+ open(INPUT, "<$in") || die "Can not read $in: $!
\backslash
n";
\newline
-
-\protected_separator
-
-\protected_separator
-open(OUTPUT, ">$out") || die "Can not write $out: $!
+ open(OUTPUT, ">$out") || die "Can not write $out: $!
\backslash
n";
\newline
}
\newline
-@ %def setup_files
-\protected_separator
-
-\protected_separator
-
+@ %def setup_files
\layout Subsection
Reading in the
\newline
scrapline: while (<INPUT>) {
\newline
-
-\protected_separator
-
-\protected_separator
-last scrapline if /^@
+ last scrapline if /^@
\backslash
s+/;
\newline
-
-\protected_separator
-
-\protected_separator
-$savedScrap .= $_;
+ $savedScrap .= $_;
\newline
};
\newline
switch: {
\newline
-
-\protected_separator
-
-\protected_separator
-if (/^@
+ if (/^@
\backslash
s+$/) {$savedScrap .= $_; last switch; }
\newline
-
-\protected_separator
-
-\protected_separator
-if (/^@
+ if (/^@
\backslash
s+%def.*$/) {$savedScrap .= $_; last switch; }
\newline
-
-\protected_separator
-
-\protected_separator
-if (/^@
+ if (/^@
\backslash
s+(.*)$/) {$savedScrap .= "@
\backslash
\layout Standard
Finally, we need to close the
-\latex latex
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+
+\begin_inset ERT
+status Collapsed
+
+\layout Standard
[[INPUT]]
-\latex default
+\end_inset
+
+
+\family default
+\series default
+\shape default
+\size default
+\emph default
+\bar default
+\noun default
+\color default
and
-\latex latex
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+
+\begin_inset ERT
+status Collapsed
+
+\layout Standard
[[OUTPUT]]
-\latex default
+\end_inset
+
+
+\family default
+\series default
+\shape default
+\size default
+\emph default
+\bar default
+\noun default
+\color default
files.
\layout Scrap
In this section, we describe and implement the code that runs reLyX on the
intermediate file
-\latex latex
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+
+\begin_inset ERT
+status Collapsed
+
+\layout Standard
[[relyx_file]]
-\latex default
+\end_inset
+
+
+\family default
+\series default
+\shape default
+\size default
+\emph default
+\bar default
+\noun default
+\color default
.
\layout Subsection
noweb2lyx.nw
\emph default
file that is generated by LyX
-\begin_float footnote
+\begin_inset Foot
+collapsed true
+
\layout Standard
reLyX searches for
\backslash
doc
-\latex latex
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+
+\begin_inset ERT
+status Collapsed
+
+\layout Standard
{}
-\latex default
+\end_inset
+
+
+\family default
+\series default
+\shape default
+\size default
+\emph default
+\bar default
+\noun default
+\color default
ument
-\latex latex
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+
+\begin_inset ERT
+status Collapsed
+
+\layout Standard
{}
-\latex default
+\end_inset
+
+
+\family default
+\series default
+\shape default
+\size default
+\emph default
+\bar default
+\noun default
+\color default
class and gets confused, so we have to obfuscate it slightly.
-\end_float
+\end_inset
+
.
With the regular expression as it is, we can actually run
\noun on
\newline
open(INPUT, "<$relyx_file") ||
\newline
-
-\protected_separator
-
-\protected_separator
-die "Can not read $relyx_file: $!
+ die "Can not read $relyx_file: $!
\backslash
n";
\newline
\newline
parse: while(<INPUT>) {
\newline
-
-\protected_separator
-
-\protected_separator
-if (/
+ if (/
\backslash
\backslash
docu[m]entclass{(.*)}/) {
\newline
-
-\protected_separator
-
-\protected_separator
-
-\protected_separator
-
-\protected_separator
-$class = $1;
+ $class = $1;
\newline
-
-\protected_separator
-
-\protected_separator
-
-\protected_separator
-
-\protected_separator
-last parse;
+ last parse;
\newline
-
-\protected_separator
-
-\protected_separator
-}
+ }
\newline
}
\newline
\backslash
n"
\newline
-
-\protected_separator
-
-\protected_separator
-if (system("reLyX -c $doc_class $relyx_file"));
+ if (system("reLyX -c $doc_class $relyx_file"));
\newline
@
\layout Standard
\newline
{
\newline
-
-\protected_separator
-
-\protected_separator
-<<Fix code chunks in latex layout>>
+ <<Fix code chunks in latex layout>>
\newline
-
-\protected_separator
-
-\protected_separator
-<<Fix [[var]] noweb construct>>
+ <<Fix [[var]] noweb construct>>
\newline
-
-\protected_separator
-
-\protected_separator
-print OUTPUT; # default
+ print OUTPUT; # default
\newline
}
\newline
\layout Standard
Note that in the perl code that is contained in the
-\latex latex
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+
+\begin_inset ERT
+status Collapsed
+
+\layout Standard
[[while(<INPUT>)]]
-\latex default
+\end_inset
+
+
+\family default
+\series default
+\shape default
+\size default
+\emph default
+\bar default
+\noun default
+\color default
loop above, the perl construct
-\latex latex
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+
+\begin_inset ERT
+status Collapsed
+
+\layout Standard
[[next line]]
-\latex default
+\end_inset
+
+
+\family default
+\series default
+\shape default
+\size default
+\emph default
+\bar default
+\noun default
+\color default
is sufficient to restart the loop.
We can use this construct to do some relatively complex parsing of the
reLyX generated file.
\layout Standard
Setting up the
-\latex latex
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+
+\begin_inset ERT
+status Collapsed
+
+\layout Standard
[[INPUT]]
-\latex default
+\end_inset
+
+
+\family default
+\series default
+\shape default
+\size default
+\emph default
+\bar default
+\noun default
+\color default
and
-\latex latex
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+
+\begin_inset ERT
+status Collapsed
+
+\layout Standard
[[OUTPUT]]
-\latex default
+\end_inset
+
+
+\family default
+\series default
+\shape default
+\size default
+\emph default
+\bar default
+\noun default
+\color default
is taken care of by this code:
\layout Scrap
\newline
if ($post_only) {
\newline
-
-\protected_separator
-
-\protected_separator
-&setup_files("$input_file", "$output_file");
+ &setup_files("$input_file", "$output_file");
\newline
} else {
\newline
-
-\protected_separator
- &setup_files("$relyx_file.lyx", "$output_file");
+ &setup_files("$relyx_file.lyx", "$output_file");
\newline
}
\newline
\backslash
latex latex/) { # Beginning of some latex code
\newline
-
-\protected_separator
-
-\protected_separator
-if (($line = <INPUT>) =~ /^
+ if (($line = <INPUT>) =~ /^
\backslash
s*<</) { # code scrap
\newline
-
-\protected_separator
-
-\protected_separator
-
-\protected_separator
-<<Transform this chunk into layout scrap>>
+ <<Transform this chunk into layout scrap>>
\newline
-
-\protected_separator
-
-\protected_separator
-} else {
+ } else {
\newline
-
-\protected_separator
-
-\protected_separator
-
-\protected_separator
-
-\protected_separator
-# print the
+ # print the
\backslash
latex latex line + next line
\newline
-
-\protected_separator
-
-\protected_separator
-
-\protected_separator
-
-\protected_separator
-print OUTPUT "$_$line";
+ print OUTPUT "$_$line";
\newline
-
-\protected_separator
-
-\protected_separator
-}
+ }
\newline
-
-\protected_separator
-
-\protected_separator
-next line;
+ next line;
\newline
}
\newline
\newline
codeline: while (<INPUT>) {
\newline
-
-\protected_separator
-
-\protected_separator
-$savedScrap .= $_;
+ $savedScrap .= $_;
\newline
-
-\protected_separator
-
-\protected_separator
-last codeline if /^@
+ last codeline if /^@
\backslash
s+/;
\newline
\newline
slurp: while (<INPUT>) {
\newline
-
-\protected_separator
-
-\protected_separator
-last slurp if /
+ last slurp if /
\backslash
\backslash
latex /;
\newline
-
-\protected_separator
-
-\protected_separator
-next slurp if /
+ next slurp if /
\backslash
\backslash
newline/;
\newline
-
-\protected_separator
-
-\protected_separator
-next slurp if /^
+ next slurp if /^
\backslash
s*$/;
\newline
-
-\protected_separator
-
-\protected_separator
-warn "confused by line: $_";
+ warn "confused by line: $_";
\newline
}
\newline
\backslash
]/) { # special code for [[var]]
\newline
-
-\protected_separator
-
-\protected_separator
-s/
+ s/
\backslash
[
\backslash
\backslash
n/g;
\newline
-
-\protected_separator
-
-\protected_separator
-print OUTPUT;
+ print OUTPUT;
\newline
-
-\protected_separator
-
-\protected_separator
-next line;
+ next line;
\newline
}
\newline
\newline
if ($ARGV[0] eq "-pre") {
\newline
-
-\protected_separator
-
-\protected_separator
-&usage unless ($#ARGV == 2);
+ &usage unless ($#ARGV == 2);
\newline
-
-\protected_separator
-
-\protected_separator
-$input_file = $ARGV[1]; $output_file = $ARGV[2]; $pre_only = 1;
+ $input_file = $ARGV[1]; $output_file = $ARGV[2]; $pre_only = 1;
\newline
} elsif ($ARGV[0] eq "-post") {
\newline
-
-\protected_separator
-
-\protected_separator
-&usage unless ($#ARGV == 2);
+ &usage unless ($#ARGV == 2);
\newline
-
-\protected_separator
-
-\protected_separator
-$input_file = $ARGV[1]; $output_file = $ARGV[2]; $post_only = 1;
+ $input_file = $ARGV[1]; $output_file = $ARGV[2]; $post_only = 1;
\newline
} else {
\newline
-
-\protected_separator
-
-\protected_separator
-&usage unless ($#ARGV == 1);
+ &usage unless ($#ARGV == 1);
\newline
-
-\protected_separator
-
-\protected_separator
-$input_file = $ARGV[0];
-\protected_separator
-$output_file = $ARGV[1];
+ $input_file = $ARGV[0]; $output_file = $ARGV[1];
\newline
-
-\protected_separator
-
-\protected_separator
-$pre_only = 0; $post_only = 0;
+ $pre_only = 0; $post_only = 0;
\newline
}
\newline
\newline
sub usage() {
\newline
-
-\protected_separator
-
-\protected_separator
-print "Usage: noweb2lyx [-pre | -post] input-file output-file
+ print "Usage: noweb2lyx [-pre | -post] input-file output-file
\newline
\newline
\backslash
n";
\newline
-
-\protected_separator
-
-\protected_separator
-exit;
+ exit;
\newline
}
\newline
\layout Standard
-\latex latex
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+
+\begin_inset ERT
+status Collapsed
+
+\layout Standard
\backslash
nowebchunks
+\end_inset
+
+
\layout Section*
Identifiers
\layout Standard
-\latex latex
+\family roman
+\series medium
+\shape up
+\size normal
+\emph off
+\bar no
+\noun off
+\color none
+
+\begin_inset ERT
+status Collapsed
+
+\layout Standard
\backslash
nowebindex
+\end_inset
+
+
\the_end