4 ### Author: Frank Terbeck <ft@bewatermyfriend.org>
7 ### generate grml zsh refcard.
12 ### #A#: abbreviations
16 ### consider these lines in zshrc:
17 ### #a3# execute \kbd{apt-cache policy}
18 ### alias acp='apt-cache policy'
20 ### Now this script will add a new description for 'acp' into
21 ### the replacement list created by the @@INSERT-aliases-debian@@
24 ### @@INSERT-aliases-default@@ == @@INSERT-aliases@@
25 ### @@INSERT-aliases-all@@ will create a sorted list of _all_
26 ### aliases from all subsections.
28 ### @@INSERT-other-foobar@@ is special, just does text replaces
29 ### without any special formatting, useful for:
30 ### \command{umask @@INSERT-other-umask@@}{...
31 ### 'other' does not have -default nor -all.
33 ### you may specify certain subsections like this:
34 ### #a3#, which will put the input in the into the
35 ### @@INSERT-aliases-debian@@ tag.
37 ### See the @secmap array below for section numbers.
38 ### Yes, this could be done with real names instead of numbers.
39 ### But names tend to be rather long. I don't want that.
44 my $refin = "./grml-zsh-refcard.tex.in";
45 if (defined($ARGV[0]) && $ARGV[0] =~ m!^[^+]!) {
52 if (defined($ARGV[0])) {
53 $verbose = length($ARGV[0]);
67 $inc, # global counter for input lines
70 %other, # @@INSERT-other-*@@
71 %splits # if lists get long, we might need to split them. HoA
74 my $splitstring="\\commandlistend\n\\pagebreak\n\\commandlistbegin";
80 if ($verbose < 5) { return; }
81 xprint(5, " --- Data ---\n");
82 foreach $key (sort keys(%other)) {
83 xprint(5, " \@\@INSERT-other-$key\@\@ -> $other{$key}\n");
85 foreach $key (sort keys(%data)) {
86 xprint(5, " \@\@INSERT-$key\@\@ =>\n");
87 foreach $entry (sort @{ $data{$key} }) {
88 xprint(5, "$entry\n");
91 foreach $key (sort keys(%splits)) {
92 xprint(5, " List-Splitting Offset for $key:\n");
93 foreach $entry (@{ $splits{$key} }) {
94 xprint(5, "$entry\n");
97 xprint(5, " --- Dump ---\n");
103 if ($verbose >= $level) {
111 $in =~ s!([\\\{\}\*\&~\$_])!\\$1!g;
116 # what an ugly hack :-)
120 @tok = split(/(\\e[^\^]|\^.)/, $keys);
123 if ($k eq '') { next; }
125 if ($k =~ m!^[^\\\^]!) {
131 $k =~ s!\^[jJmM]!return!g;
141 my ($linenum, $cat, $sec) = @_;
144 if ($sec eq '') { $sec = 'default'; }
145 if (!defined($data{"$cat-$sec"})) {
146 warn("Unknown insertion tag in line $linenum (\@\@INSERT-$cat-$sec\@\@). IGNORING.\n");
149 xprint(1, "inserting: category($cat) section($sec), line: $linenum\n");
151 foreach $entry (sort @{ $data{"$cat-$sec"} }) {
154 foreach $is (@{ $splits{"$cat-$sec"} } ) {
156 print("$splitstring\n");
166 my ($sec, $desc) = @_;
169 if ($sec eq '') { $sec=0; }
171 xprint(1, "Handling hashed dir (section: $secmap[$sec]) in line $ln ($desc)\n");
175 if ($input[$ln] =~ m!^\s*\#d[0-9]*\#!) {
176 xprint(1, "Ending hashed dir handling in line $ln.\n");
180 if ($input[$ln] =~ m!\s*hash\s+-d\s+([^=]+)=(.*)!) {
181 $dir=$1; $value=&escape_string($2);
182 push(@{ $data{"hasheddirs-$secmap[$sec]"} }, "\\command\{$dir\}\{$value\}");
185 warn("Broken hashed dir in line $ln. IGNORING.\n");
192 my ($sec, $desc) = @_;
193 my ($abbrev, $value, $doc);
195 if ($sec eq '') { $sec=0; }
197 xprint(1, "Handling abbreviation (section: $secmap[$sec]) in line $ln ($desc)\n");
200 while ($ln <= $i) { # the global $i
201 if ($input[$ln] =~ m!^\s*\#A[0-9]*\#!) {
202 xprint(1, "Ending abbreviation handling in line $ln.\n");
207 if ($input[$ln] =~ s/\s+\#d\s*([^#]*)$//) { $doc = $1; }
208 if ($input[$ln] =~ m!\s*['"]([^"']*)['"]\s\$?['"]([^"']*)['"]!) {
209 $abbrev = $1; $value = &escape_string($2);
210 xprint(2, "ab: $abbrev -> $value ($doc);\n");
211 push(@{ $data{"abbrev-$secmap[$sec]"} }, "\\command\{$abbrev\}\{\\kbd\{$value" . ($doc ne '' ? "\}\\quad $doc" : "\}") . "\}");
214 warn("Broken abbreviation in line $ln. IGNORING.\n");
220 sub handle_function {
221 my ($sec, $desc) = @_;
223 if ($sec eq '') { $sec=0; }
225 xprint(1, "Handling function (section: $secmap[$sec]) in line $ln ($desc)\n");
228 if ($input[$ln] =~ m!\s*(function)?\s*([^(\s]*)!) {
229 xprint(2, " - $2()\n");
230 push(@{ $data{"functions-$secmap[$sec]"} }, "\\command\{$2()\}\{$desc\}");
233 warn("Parsing function line $ln ($input[$ln]) failed. IGNORING.\n");
238 my ($sec, $desc) = @_;
241 if ($sec eq '') { $sec=0; }
243 xprint(1, "Handling alias (section: $secmap[$sec]) in line $ln ($desc)\n");
246 if ($input[$ln] =~ m!\s*alias (-[haocC] +)*([^=]*)=["'](.*)["']!) {
247 $alias=$2; $value=&escape_string($3);
248 $desc =~ s!\@a\@!$value!;
249 push(@{ $data{"aliases-$secmap[$sec]"} }, "\\command\{$alias\}\{$desc\}");
252 warn("Parsing alias line $ln ($input[$ln]) failed. IGNORING.\n");
257 my ($sec, $desc) = @_;
259 $desc =~ m!([^\s]+)\s+(.*)!;
260 xprint(1, "Handling 'other' tag in line $ln ($1 -> $2))\n");
265 sub handle_keybinding {
266 my ($sec, $desc) = @_;
269 if ($sec eq '') { $sec=0; }
271 xprint(1, "Handling keybinding (section: $secmap[$sec]) in line $ln ($desc)\n");
274 if ($input[$ln] =~ m!^.*bindkey\s+[^'"]*(.*)['"]\s+([\w-]*)\#?.*!) {
275 $value=&escape_string($2);
279 $kbd=&demystify_keys($kbd);
280 $desc =~ s!\@k\@!$value!;
281 #xprint(0, "!-> DEBUG: kbd: $kbd - value: $value - desc: $desc\n");
282 push(@{ $data{"keybindings-$secmap[$sec]"} }, "\\command\{$kbd\}\{$desc\}");
285 warn("Parsing keybinding line $ln ($input[$ln]) failed. IGNORING.\n");
289 sub handle_variable {
290 my ($sec, $desc) = @_;
293 if ($sec eq '') { $sec=0; }
295 xprint(1, "Handling variable (section: $secmap[$sec]) in line $ln ($desc)\n");
298 if ($input[$ln] =~ m/\s*(\S+)=(.+)$/) {
299 $var = $1 ; $value = $2;
300 $value =~ s!^\$\{\w*:-(.*)\}!$1!;
303 $value = &escape_string($value);
304 push(@{ $data{"variables-$secmap[$sec]"} }, "\\command\{$var\}\{\\kbd\{$value" . ($desc ne '' ? "\}\\quad $desc" : "\}") . "\}");
307 warn("Parsing variable line $ln ($input[$ln]) failed. IGNORING.\n");
312 # this is different than the other handle_*() subs.
313 my ($code, $key, $value) = @_;
316 xprint(1, "Handling manual entry (code: $code) in line $ln ($key -> $value)\n");
318 $sec = ( (length($code) > 1) ? substr($code, 1) : 0);
319 if (substr($code, 0, 1) eq 'a') {
320 push(@{ $data{"aliases-$secmap[$sec]"} }, "\\command\{$key\}\{$value\}");
322 elsif (substr($code, 0, 1) eq 'A') {
323 push(@{ $data{"abbrev-$secmap[$sec]"} }, "\\command\{$key\}\{$value\}");
325 elsif (substr($code, 0, 1) eq 'd') {
326 push(@{ $data{"hasheddirs-$secmap[$sec]"} }, "\\command\{$key\}\{$value\}");
328 elsif (substr($code, 0, 1) eq 'f') {
329 push(@{ $data{"functions-$secmap[$sec]"} }, "\\command\{$key\}\{$value\}");
331 elsif (substr($code, 0, 1) eq 'k') {
332 push(@{ $data{"keybindings-$secmap[$sec]"} }, "\\command\{$key\}\{$value\}");
334 elsif (substr($code, 0, 1) eq 'o') {
335 push(@{ $data{"other-$secmap[$sec]"} }, "\\command\{$key\}\{$value\}");
337 elsif (substr($code, 0, 1) eq 'v') {
338 push(@{ $data{"variables-$secmap[$sec]"} }, "\\command\{$key\}\{$value\}");
341 warn("Unknown doc-definition character in manual-line $ln ($1). IGNORING.\n");
348 my ($optstring) = @_;
352 if ($optstring =~ m!([a-zA-Z0-9_-]+)\s+(.*)!) {
355 if ($opt eq 'split') {
356 if ($val =~ m!([a-zA-Z0-9_-]+)\s+(.*)!) {
359 xprint(2, " splitting values (for $what): " . join(' ', split(/,/, $when)) . "\n");
360 @{ $splits{"$what"} } = split(/,/, $when);
363 warn("Parsing split option failed in line $ln. IGNORING.\n");
367 warn("Unknown option ($opt) in line $ln. IGNORING.\n");
371 warn("Parsing option in line $ln failed. IGNORING.\n");
378 ### {{{ handling stdin
380 $input[0]='index==linenumber :-)';
383 if ($i > $MAX_INPUT) {
384 die "Sorry dude, input lines exeeded maximum ($MAX_INPUT)}\n";
392 if ($input[$ln] =~ m/^\#\@\#\s*(.*)$/) {
396 if ($input[$ln] =~ m/^\s*\#([a-zA-Z])([0-9]*)\#\s*(.*)$/) {
398 &handle_alias($2, $3);
401 &handle_abbrev($2, $3);
404 &handle_hashdir($2, $3);
407 &handle_function($2, $3);
410 &handle_keybinding($2, $3);
413 &handle_other($2, $3);
416 &handle_variable($2, $3);
420 $arg =~ m!^\s*([a-zA-Z][0-9]*)\s+(\S+)\s+(.*)!;
421 &handle_manual($1, $2, $3);
424 warn("Unknown doc-definition character in line $ln ($1). IGNORING.\n");
436 open(IN, "<$refin") or die "could not open $refin: $!\n";
438 while (<IN>) { #{{{ output loop
440 while (m!\@\@INSERT-other-[^@]+\@\@!) {
441 s!\@\@INSERT-other-([^@]+)\@\@!$other{$1}!;
442 xprint(2, "Inserting \@\@INSERT-other-$1\@\@ -> $other{$1}\n");
444 if (m!^\@\@INSERT-([^-]*)-?(.*)\@\@!) {
446 die "malformed insertion tag in line $i ($_). ABORT\n";