forked from osmocom/wireshark
Trying to get the WS Lua Ref Man to build with the rest of the documentation
svn path=/trunk/; revision=20571
This commit is contained in:
Luis Ontanon
parent
bb773be0ef
commit
70908e9992
|
|
@ -17,7 +17,7 @@ FOP_OPTS?=-Xmx256m
|
|||
#
|
||||
# for win32 (cygwin) environments (as of fop-0.20 the cygwin script does
|
||||
# not use $FOP_OPTS)
|
||||
FOP?=fop-0.20.5/fop.bat
|
||||
FOP?=fop-0.20.5/fop.sh
|
||||
#
|
||||
# for unix like environments (if you have problems with fop, try to use an absolute path here)
|
||||
#FOP=fop-0.20.5/fop.sh
|
||||
|
|
@ -257,9 +257,10 @@ CLEANFILES = \
|
|||
release-notes.txt \
|
||||
svn_version.xml \
|
||||
user-guide.zip \
|
||||
wsluarm.xml \
|
||||
wsluarm_src/*.xml
|
||||
|
||||
|
||||
all: svn_version_check wsug.validated wsdg.validated release_notes.validated wsug wsdg release_notes
|
||||
all: svn_version_check wsug.validated wsdg.validated release_notes.validated wsug wsdg release_notes wsluarm
|
||||
|
||||
clean:
|
||||
rm -rf $(CLEANFILES)
|
||||
|
|
@ -454,3 +455,82 @@ ifdef HHC
|
|||
-rm -r toc.hhc
|
||||
endif
|
||||
|
||||
PERL = perl
|
||||
|
||||
WSLUA_MODULES = \
|
||||
../epan/wslua/wslua_dumper.c \
|
||||
../epan/wslua/wslua_field.c \
|
||||
../epan/wslua/wslua_gui.c \
|
||||
../epan/wslua/wslua_listener.c \
|
||||
../epan/wslua/wslua_pinfo.c \
|
||||
../epan/wslua/wslua_proto.c \
|
||||
../epan/wslua/wslua_tree.c \
|
||||
../epan/wslua/wslua_tvb.c \
|
||||
../epan/wslua/wslua_util.c
|
||||
|
||||
WSLUA_FILES = \
|
||||
wslua_dumper.xml \
|
||||
wslua_field.xml \
|
||||
wslua_gui.xml \
|
||||
wslua_listener.xml \
|
||||
wslua_pinfo.xml \
|
||||
wslua_proto.xml \
|
||||
wslua_tree.xml \
|
||||
wslua_tvb.xml \
|
||||
wslua_util.xml
|
||||
|
||||
WSLUARM_SOURCE = \
|
||||
wsluarm.xml \
|
||||
svn_version.xml \
|
||||
Makefile \
|
||||
$(WSLUA_FILES)
|
||||
|
||||
wsluarm.xml: make-wsluarm.pl template-wsluarm.xml $(WSLUA_MODULES)
|
||||
$(PERL) make-wsluarm.pl $(WSLUA_MODULES)
|
||||
|
||||
wsluarm: wsluarm.html wsluarm.txt wsluarm.pdf wsluarm.pdf wsluarm.chm
|
||||
|
||||
# validate the content
|
||||
wsluarm.validated: $(WSLUARM_SOURCE)
|
||||
@ echo --- WSLUARM - VALIDATING XML ---
|
||||
$(XMLLINT) --valid --noout $<
|
||||
touch $@
|
||||
|
||||
# create html single page file
|
||||
wsluarm.html: $(WSLUARM_SOURCE)
|
||||
@ echo --- WSLUARM - HTML ---
|
||||
$(XSLTPROC) --nonet http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl $< > $@
|
||||
|
||||
# create txt single page file (through HTML)
|
||||
wsluarm.txt: $(WSLUARM_SOURCE)
|
||||
@ echo --- WSLUARM - TXT ---
|
||||
$(XSLTPROC) --stringparam generate.toc "article nop" --nonet http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl $< | $(HTML2TXT) > $@
|
||||
|
||||
# create pdf file (through XSL-FO), portrait pages on US letter paper (the default)
|
||||
# you will get lot's of errors, but that's ok
|
||||
wsluarm-us.fo: $(WSLUARM_SOURCE) custom_layer_pdf.xsl
|
||||
ifdef FOP
|
||||
@ echo --- WSLUARM - PDF US PAPER ---
|
||||
$(XSLTPROC) --stringparam paper.type letter --nonet custom_layer_pdf.xsl $< > $@
|
||||
endif
|
||||
|
||||
# create pdf file (through XSL-FO), portrait pages on A4 paper
|
||||
# you will get lot's of errors, but that's ok
|
||||
wsluarm-a4.fo: $(WSLUARM_SOURCE) custom_layer_pdf.xsl
|
||||
ifdef FOP
|
||||
@ echo --- WSLUARM - PDF A4 PAPER ---
|
||||
$(XSLTPROC) --stringparam paper.type A4 --nonet custom_layer_pdf.xsl $< > $@
|
||||
endif
|
||||
|
||||
# create MS html help file (through html chunked pages)
|
||||
wsluarm.chm: $(WSLUARM_SOURCE)
|
||||
ifdef HHC
|
||||
@ echo --- WSLUARM - MICROSOFT HTML HELP ---
|
||||
$(XSLTPROC) --stringparam base.dir release_notes_chm/ --stringparam use.id.as.filename 1 --stringparam admon.graphics 1 --stringparam admon.graphics.path wsug_graphics/ --stringparam section.autolabel 1 --stringparam section.label.includes.component.label 1 --nonet http://docbook.sourceforge.net/release/xsl/current/htmlhelp/htmlhelp.xsl $<
|
||||
-$(HHC) htmlhelp.hhp
|
||||
-mv htmlhelp.chm $@
|
||||
-rm -r htmlhelp.hhp
|
||||
-rm -r toc.hhc
|
||||
endif
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -0,0 +1,476 @@
|
|||
#!/usr/bin/perl
|
||||
#
|
||||
# make-doc.pl
|
||||
# WSLUA's Reference Manual Generator
|
||||
#
|
||||
# (c) 2006, Luis E. Garcia Onatnon <luis.ontanon@gmail.com>
|
||||
#
|
||||
# $Id$
|
||||
#
|
||||
# Wireshark - Network traffic analyzer
|
||||
# By Gerald Combs <gerald@wireshark.org>
|
||||
# Copyright 1998 Gerald Combs
|
||||
#
|
||||
# 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 2
|
||||
# of the License, 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
||||
#
|
||||
# (-: I don't even think writing this in Lua :-)
|
||||
|
||||
use strict;
|
||||
#use V2P;
|
||||
|
||||
sub deb {
|
||||
# warn $_[0];
|
||||
}
|
||||
|
||||
sub gorolla {
|
||||
# a gorilla stays to a chimp like gorolla stays to chomp
|
||||
# but this one returns the shrugged string.
|
||||
my $s = shift;
|
||||
$s =~ s/^([\n]|\s)*//ms;
|
||||
$s =~ s/([\n]|\s)*$//ms;
|
||||
$s =~ s/\</</ms;
|
||||
$s =~ s/\>/>/ms;
|
||||
$s;
|
||||
}
|
||||
|
||||
my %module = ();
|
||||
my %modules = ();
|
||||
my $class;
|
||||
my %classes;
|
||||
my $function;
|
||||
my @functions;
|
||||
|
||||
my $docbook_template = {
|
||||
module_header => "<chapter id='lua_module_%s'>\n",
|
||||
module_desc => "\t<title>%s</title>\n",
|
||||
module_footer => "</chapter>\n",
|
||||
class_header => "\t<section id='lua_class_%s'><title>%s</title>\n",
|
||||
class_desc => "\t\t<para>%s</para>\n",
|
||||
class_footer => "\t</section> <!-- class_footer: %s -->\n",
|
||||
# class_constructors_header => "\t\t<section id='lua_class_constructors_%s'>\n\t\t\t<title>%s Constructors</title>\n",
|
||||
# class_constructors_footer => "\t\t</section> <!-- class_constructors_footer -->\n",
|
||||
# class_methods_header => "\t\t<section id='lua_class_methods_%s'>\n\t\t\t<title>%s Methods</title>\n",
|
||||
# class_methods_footer => "\t\t</section> <!-- class_methods_footer: %s -->\n",
|
||||
class_attr_header => "\t\t<section id='lua_class_attrib_%s'>\n\t\t\t<title>%s</title>\n",
|
||||
class_attr_footer => "\t\t</section> <!-- class_attr_footer: %s -->\n",
|
||||
class_attr_descr => "\t\t\t<para>%s</para>\n",
|
||||
function_header => "\t\t\t<section id='lua_fn_%s'>\n\t\t\t\t<title>%s</title>\n",
|
||||
function_descr => "\t\t\t\t<para>%s</para>\n",
|
||||
function_footer => "\t\t\t</section> <!-- function_footer: %s -->\n",
|
||||
function_args_header => "\t\t\t\t\t<command>Arguments</command>\t\t\t\t<variablelist>\n",
|
||||
function_args_footer => "\t\t\t\t</variablelist>\n",
|
||||
function_arg_header => "\t\t\t\t<varlistentry><term>%s</term>\n",
|
||||
function_arg_descr => "\t\t\t\t\t<listitem><para>%s</para></listitem>\n",
|
||||
function_arg_footer => "\t\t\t\t</varlistentry> <!-- function_arg_footer: %s -->\n",
|
||||
function_argerror_header => "\t\t\t\t\t<command>Errors</command>\n\t\t\t\t\t\t<itemizedlist>\n",
|
||||
function_argerror => "\t\t\t\t\t\t\t<listitem><para>%s</para></listitem>\n",
|
||||
function_argerror_footer => "\t\t\t\t\t\t</itemizedlist> <!-- function_argerror_footer: %s -->\n",
|
||||
function_returns_header => "\t\t\t\t<command>Returns</command>\n",
|
||||
# function_returns_footer => "\t\t\t\t</section> <!-- function_returns_footer: %s -->\n",
|
||||
function_returns => "\t\t\t\t\t<para>%s</para>\n",
|
||||
function_errors_header => "\t\t\t\t<command>Errors</command><itemizedlist>\n",
|
||||
function_errors => "\t\t\t\t\t\t<listitem><para>%s</para></listitem>\n",
|
||||
function_errors_footer => "\t\t\t\t\t</itemizedlist> <!-- function_error_footer: %s -->\n",
|
||||
non_method_functions_header => "\t\t<section id='non_method_functions_%s'><title>Non Method Functions</title>\n",
|
||||
non_method_functions_footer => "\t\t</section> <!-- Non method -->\n",
|
||||
};
|
||||
|
||||
|
||||
my $template_ref = $docbook_template;
|
||||
my $out_extension = "xml";
|
||||
|
||||
# It's said that only perl can parse perl... my editor isn't perl...
|
||||
# if unencoded this causes my editor's autoindent to bail out so I encoded in octal
|
||||
# XXX: support \" within ""
|
||||
my $QUOTED_RE = "\042\050\133^\042\135*\051\042";
|
||||
|
||||
my $TRAILING_COMMENT_RE = '((\s*|[\n\r]*)/\*(.*?)\*/)?';
|
||||
|
||||
my @control =
|
||||
(
|
||||
# This will be scanned in order trying to match the re if it matches
|
||||
# the body will be executed immediatelly after.
|
||||
['WSLUA_MODULE\s*([A-Z][a-zA-Z]+)([^\*]*)',
|
||||
sub {
|
||||
$module{name} = $1;
|
||||
$module{descr} = $2
|
||||
}],
|
||||
|
||||
[ 'WSLUA_CLASS_DEFINE\050\s*([A-Z][a-zA-Z]+).*?\051;' . $TRAILING_COMMENT_RE,
|
||||
sub {
|
||||
deb ">c=$1=$2=$3=$4=$5=$6=$7=\n";
|
||||
$class = {
|
||||
name => $1,
|
||||
descr=> gorolla($4),
|
||||
constructors => [],
|
||||
methods => [],
|
||||
attributes => []
|
||||
};
|
||||
$classes{$1} = $class;
|
||||
}],
|
||||
|
||||
[ 'WSLUA_FUNCTION\s+wslua_([a-z_]+)[^\173]*\173' . $TRAILING_COMMENT_RE,
|
||||
sub {
|
||||
deb ">f=$1=$2=$3=$4=$5=$6=$7=\n";
|
||||
$function = {
|
||||
returns => [],
|
||||
arglist => [],
|
||||
args => {},
|
||||
name => $1,
|
||||
descr => gorolla($4),
|
||||
type => 'standalone'
|
||||
};
|
||||
push @functions, $function;
|
||||
} ] ,
|
||||
|
||||
[ 'WSLUA_CONSTRUCTOR\s+([A-Za-z0-9]+)_([a-z0-9_]+).*?\173' . $TRAILING_COMMENT_RE,
|
||||
sub {
|
||||
deb ">cc=$1=$2=$3=$4=$5=$6=$7=\n";
|
||||
$function = {
|
||||
returns => [],
|
||||
arglist => [],
|
||||
args => {},
|
||||
name => "$1.$2",
|
||||
descr => gorolla($5),
|
||||
type => 'constructor'
|
||||
};
|
||||
push @{${$class}{constructors}}, $function;
|
||||
} ] ,
|
||||
|
||||
[ '_WSLUA_CONSTRUCTOR_\s+([A-Za-z0-9]+)_([a-z0-9_]+)\s*(.*?)\052\057',
|
||||
sub {
|
||||
deb ">cc=$1=$2=$3=$4=$5=$6=$7=\n";
|
||||
$function = {
|
||||
returns => [],
|
||||
arglist => [],
|
||||
args => {},
|
||||
name => "$1.$2",
|
||||
descr => gorolla($3),
|
||||
type => 'constructor'
|
||||
};
|
||||
push @{${$class}{constructors}}, $function;
|
||||
} ] ,
|
||||
|
||||
[ 'WSLUA_METHOD\s+([A-Za-z]+)_([a-z0-9_]+)[^\173]*\173' . $TRAILING_COMMENT_RE,
|
||||
sub {
|
||||
deb ">cm=$1=$2=$3=$4=$5=$6=$7=\n";
|
||||
my $name = "$1";
|
||||
$name =~ tr/A-Z/a-z/;
|
||||
$name .= ":$2";
|
||||
$function = {
|
||||
returns => [],
|
||||
arglist => [],
|
||||
args => {},
|
||||
name => $name,
|
||||
descr => gorolla($5),
|
||||
type => 'method'
|
||||
};
|
||||
push @{${$class}{methods}}, $function;
|
||||
} ] ,
|
||||
|
||||
[ 'WSLUA_METAMETHOD\s+([A-Za-z]+)(__[a-z0-9]+)[^\173]*\173' . $TRAILING_COMMENT_RE,
|
||||
sub {
|
||||
deb ">cm=$1=$2=$3=$4=$5=$6=$7=\n";
|
||||
my $name = "$1";
|
||||
$name =~ tr/A-Z/a-z/;
|
||||
$name .= ":$2";
|
||||
my ($c,$d) = ($1,$5);
|
||||
$function = {
|
||||
returns => [],
|
||||
arglist => [],
|
||||
args => {},
|
||||
name => $name,
|
||||
descr => gorolla($5),
|
||||
type => 'metamethod'
|
||||
};
|
||||
push @{${$class}{methods}}, $function;
|
||||
} ] ,
|
||||
|
||||
[ '#define WSLUA_(OPT)?ARG_([a-z0-9_]+)_([A-Z0-9]+)\s+\d+' . $TRAILING_COMMENT_RE,
|
||||
sub {
|
||||
deb ">a=$1=$2=$3=$4=$5=$6=$7=\n";
|
||||
my $name = $1 eq 'OPT' ? "[$3]" : $3;
|
||||
push @{${$function}{arglist}} , $name;
|
||||
${${$function}{args}}{$name} = {descr=>$6,}
|
||||
} ],
|
||||
|
||||
[ '\057\052\s*WSLUA_(OPT)?ARG_([A-Za-z0-9_]+)_([A-Z0-9]+)\s*(.*?)\052\057',
|
||||
sub {
|
||||
deb ">a=$1=$2=$3=$4=$5=$6=$7=\n";
|
||||
my $name = $1 eq 'OPT' ? "[$3]" : $3;
|
||||
push @{${$function}{arglist}} , $name;
|
||||
${${$function}{args}}{$name} = {descr=>$4,}
|
||||
} ],
|
||||
|
||||
[ '#define WSLUA_(OPT)?ARG_([A-Za-z]+)_([a-z_]+)_([A-Z0-9]+)\s+\d+' . $TRAILING_COMMENT_RE,
|
||||
sub {
|
||||
deb ">ca=$1=$2=$3=$4=$5=$6=$7=\n";
|
||||
my $name = $1 eq 'OPT' ? "[$4]" : $4;
|
||||
push @{${$function}{arglist}} , $name;
|
||||
${${$function}{args}}{$name} = {descr=>$7,optional => $1 eq '' ? 1 : 0 }
|
||||
} ],
|
||||
|
||||
[ '/\052\s+WSLUA_ATTRIBUTE\s+([A-Za-z]+)_([a-z_]+)\s+([A-Z]*)\s*(.*?)\052/',
|
||||
sub {
|
||||
deb ">at=$1=$2=$3=$4=$5=$6=$7=\n";
|
||||
my $name = "$1";
|
||||
$name =~ tr/A-Z/a-z/;
|
||||
$name .= ".$2";
|
||||
push @{${$class}{attributes}}, { name => $name, descr => gorolla($4), mode=>$3 };
|
||||
} ],
|
||||
|
||||
[ '/\052\s+WSLUA_MOREARGS\s+([A-Za-z_]+)\s+(.*?)\052/',
|
||||
sub {
|
||||
deb ">ma=$1=$2=$3=$4=$5=$6=$7=\n";
|
||||
push @{${$function}{arglist}} , "...";
|
||||
${${$function}{args}}{"..."} = {descr=>gorolla($2)}
|
||||
} ],
|
||||
|
||||
[ 'WSLUA_(FINAL_)?RETURN\050\s*.*?\s*\051\s*;' . $TRAILING_COMMENT_RE,
|
||||
sub {
|
||||
deb ">fr=$1=$2=$3=$4=$5=$6=$7=\n";
|
||||
push @{${$function}{returns}} , gorolla($4) if $4 ne '';
|
||||
} ],
|
||||
|
||||
[ '\057\052\s*_WSLUA_RETURNS_\s*(.*?)\052\057',
|
||||
sub {
|
||||
deb ">fr2=$1=$2=$3=$4=$5=$6=$7=\n";
|
||||
push @{${$function}{returns}} , gorolla($1) if $1 ne '';
|
||||
} ],
|
||||
|
||||
[ 'WSLUA_ERROR\s*\050\s*(([A-Z][A-Za-z]+)_)?([a-z_]+),' . $QUOTED_RE ,
|
||||
sub {
|
||||
deb ">e=$1=$2=$3=$4=$5=$6=$7=\n";
|
||||
my $errors;
|
||||
unless (exists ${$function}{errors}) {
|
||||
$errors = ${$function}{errors} = [];
|
||||
} else {
|
||||
$errors = ${$function}{errors};
|
||||
}
|
||||
|
||||
push @{$errors}, gorolla($4);
|
||||
} ],
|
||||
|
||||
[ 'WSLUA_(OPT)?ARG_ERROR\s*\050\s*(([A-Z][A-Za-z]+)_)?([a-z_]+)\s*,\s*([A-Z0-9]+)\s*,\s*' . $QUOTED_RE,
|
||||
sub {
|
||||
deb ">ae=$1=$2=$3=$4=$5=$6=$7=\n";
|
||||
my $errors;
|
||||
unless (exists ${${${$function}{args}}{$5}}{errors}) {
|
||||
$errors = ${${${$function}{args}}{$5}}{errors} = [];
|
||||
} else {
|
||||
$errors = ${${${$function}{args}}{$5}}{errors};
|
||||
}
|
||||
|
||||
push @{$errors}, gorolla($6);
|
||||
} ] ,
|
||||
);
|
||||
|
||||
my $anymatch = '(^ThIsWiLlNeVeRmAtCh$';
|
||||
for (@control) {
|
||||
$anymatch .= "|${$_}[0]";
|
||||
}
|
||||
$anymatch .= ')';
|
||||
|
||||
# for each file given in the command line args
|
||||
my $file;
|
||||
while ( $file = shift) {
|
||||
|
||||
next unless -f $file;
|
||||
|
||||
%module = ();
|
||||
|
||||
my $docfile = $file;
|
||||
$docfile =~ s#.*/##;
|
||||
$docfile =~ s/\.c$/.$out_extension/;
|
||||
|
||||
open C, "< $file";
|
||||
open D, "> wsluarm_src/$docfile";
|
||||
|
||||
my $b = '';
|
||||
$b .= $_ while (<C>);
|
||||
|
||||
while ($b =~ /$anymatch/ms ) {
|
||||
my $match = $1;
|
||||
# print "\n-----\n$match\n-----\n";
|
||||
for (@control) {
|
||||
my ($re,$f) = @{$_};
|
||||
if ( $match =~ /$re/ms) {
|
||||
&{$f}();
|
||||
$b =~ s/.*?$re//ms;
|
||||
last;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
$modules{$module{name}} = $docfile;
|
||||
|
||||
printf D ${$template_ref}{module_header}, $module{name}, $module{name};
|
||||
if ( exists ${$template_ref}{module_desc} ) {
|
||||
printf D ${$template_ref}{module_desc}, $module{descr}, $module{descr};
|
||||
}
|
||||
|
||||
for my $cname (sort keys %classes) {
|
||||
my $cl = $classes{$cname};
|
||||
printf D ${$template_ref}{class_header}, $cname, $cname;
|
||||
|
||||
if ( ${$cl}{descr} ) {
|
||||
printf D ${$template_ref}{class_desc} , ${$cl}{descr};
|
||||
}
|
||||
|
||||
if ( $#{${$cl}{constructors}} >= 0) {
|
||||
# printf D ${$template_ref}{class_constructors_header}, $cname, $cname;
|
||||
|
||||
for my $c (@{${$cl}{constructors}}) {
|
||||
function_descr($c);
|
||||
}
|
||||
|
||||
# printf D ${$template_ref}{class_constructors_footer}, $cname, $cname;
|
||||
}
|
||||
|
||||
if ( $#{${$cl}{methods}} >= 0) {
|
||||
# printf D ${$template_ref}{class_methods_header}, $cname, $cname;
|
||||
|
||||
for my $m (@{${$cl}{methods}}) {
|
||||
function_descr($m);
|
||||
}
|
||||
|
||||
# printf D ${$template_ref}{class_methods_footer}, $cname, $cname;
|
||||
}
|
||||
|
||||
if ( $#{${$cl}{attributes}} >= 0) {
|
||||
for my $a (@{${$cl}{attributes}}) {
|
||||
printf D ${$template_ref}{class_attr_header}, ${$a}{name}, ${$a}{name};
|
||||
printf D ${$template_ref}{class_attr_descr}, ${$a}{descr}, ${$a}{descr} if ${$a}{descr};
|
||||
printf D ${$template_ref}{class_attr_footer}, ${$a}{name}, ${$a}{name};
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
if (exists ${$template_ref}{class_footer}) {
|
||||
printf D ${$template_ref}{class_footer}, $cname, $cname;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
if ($#functions >= 0) {
|
||||
printf D ${$template_ref}{non_method_functions_header}, $module{name};
|
||||
|
||||
for my $f (@functions) {
|
||||
function_descr($f);
|
||||
}
|
||||
|
||||
print D ${$template_ref}{non_method_functions_footer};
|
||||
}
|
||||
|
||||
%classes = ();
|
||||
$class = undef;
|
||||
$function = undef;
|
||||
@functions = ();
|
||||
close C;
|
||||
|
||||
printf D ${$template_ref}{module_footer}, $module{name};
|
||||
|
||||
close D;
|
||||
}
|
||||
|
||||
my $wsluarm = '';
|
||||
open B, "< template-wsluarm.xml";
|
||||
$wsluarm .= $_ while(<B>);
|
||||
close B;
|
||||
|
||||
my $ents = '';
|
||||
my $txt = '';
|
||||
|
||||
for my $module_name (sort keys %modules) {
|
||||
$ents .= <<"_ENT";
|
||||
<!ENTITY $module_name SYSTEM "wsluarm_src/$modules{$module_name}">
|
||||
_ENT
|
||||
$txt .= "&$module_name;\n";
|
||||
}
|
||||
|
||||
$wsluarm =~ s/<!-- WSLUA_MODULE_ENTITIES -->/$ents/;
|
||||
$wsluarm =~ s/<!-- WSLUA_MODULE_TEXT -->/$txt/;
|
||||
|
||||
open X, "> wsluarm.xml";
|
||||
print X $wsluarm;
|
||||
close X;
|
||||
|
||||
sub function_descr {
|
||||
my $f = $_[0];
|
||||
my $label = $_[1];
|
||||
|
||||
if (defined $label ) {
|
||||
$label =~ s/>/>/;
|
||||
$label =~ s/</</;
|
||||
printf D ${$template_ref}{function_header}, ${$f}{section_name}, $label;
|
||||
} else {
|
||||
my $arglist = '';
|
||||
|
||||
for (@{ ${$f}{arglist} }) {
|
||||
my $a = $_;
|
||||
$a =~ tr/A-Z/a-z/;
|
||||
$arglist .= "$a, ";
|
||||
}
|
||||
|
||||
$arglist =~ s/, $//;
|
||||
|
||||
printf D ${$template_ref}{function_header}, "${$f}{name}($arglist)", "${$f}{name}($arglist)";
|
||||
}
|
||||
|
||||
printf D ${$template_ref}{function_descr}, ${$f}{descr} if ${$f}{descr};
|
||||
|
||||
print D ${$template_ref}{function_args_header} if $#{${$f}{arglist}} >= 0;
|
||||
|
||||
for my $argname (@{${$f}{arglist}}) {
|
||||
my $arg = ${${$f}{args}}{$argname};
|
||||
$argname =~ tr/A-Z/a-z/;
|
||||
$argname =~ s/\[(.*)\]/$1 (optional)/;
|
||||
|
||||
printf D ${$template_ref}{function_arg_header}, $argname, $argname;
|
||||
printf D ${$template_ref}{function_arg_descr}, ${$arg}{descr} , ${$arg}{descr} if ${$arg}{descr};
|
||||
|
||||
if ( $#{${$arg}{errors}} >= 0) {
|
||||
printf D ${$template_ref}{function_argerror_header}, $argname, $argname;
|
||||
printf D ${$template_ref}{function_argerror}, $_, $_ for @{${$arg}{errors}};
|
||||
printf D ${$template_ref}{function_argerror_footer}, $argname, $argname;
|
||||
}
|
||||
|
||||
printf D ${$template_ref}{function_arg_footer}, $argname, $argname;
|
||||
|
||||
}
|
||||
|
||||
print D ${$template_ref}{function_args_footer} if $#{${$f}{arglist}} >= 0;
|
||||
|
||||
if ( $#{${$f}{returns}} >= 0) {
|
||||
printf D ${$template_ref}{function_returns_header}, ${$f}{name};
|
||||
printf D ${$template_ref}{function_returns}, $_ for @{${$f}{returns}};
|
||||
printf D ${$template_ref}{function_returns_footer}, ${$f}{name};
|
||||
}
|
||||
|
||||
if ( $#{${$f}{errors}} >= 0) {
|
||||
my $sname = exists ${$f}{section_name} ? ${$f}{section_name} : ${$f}{name};
|
||||
|
||||
printf D ${$template_ref}{function_errors_header}, $sname;
|
||||
printf D ${$template_ref}{function_errors}, $_ for @{${$f}{errors}};
|
||||
printf D ${$template_ref}{function_errors_footer}, ${$f}{name};
|
||||
}
|
||||
|
||||
if (not defined $label ) {
|
||||
$label = '';
|
||||
}
|
||||
|
||||
printf D ${$template_ref}{function_footer}, $label, $label;
|
||||
|
||||
}
|
||||
|
|
@ -0,0 +1,77 @@
|
|||
<?xml version="1.0"?>
|
||||
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
|
||||
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
|
||||
|
||||
<!-- $Id$ -->
|
||||
|
||||
<!--
|
||||
BIOGRAPHICAL SECTION
|
||||
-Use this section to encode all biographical information
|
||||
-->
|
||||
|
||||
<!-- Author's Names -->
|
||||
<!ENTITY AuthorFullName "Luis E. Garcia Ontanon">
|
||||
<!ENTITY AuthorFirstName "Luis">
|
||||
<!ENTITY AuthorOtherName "Enrrique">
|
||||
<!ENTITY AuthorSurname "Garcia Ontanon">
|
||||
|
||||
<!--Author's Affiliation -->
|
||||
<!ENTITY AuthorShortAffiliation "">
|
||||
<!ENTITY AuthorJobTitle "">
|
||||
<!ENTITY AuthorOrgName "">
|
||||
<!ENTITY AuthorOrgDiv "">
|
||||
<!ENTITY AuthorEmail "luis.ontanon[at]gmail.com">
|
||||
|
||||
<!--
|
||||
DOCUMENT SECTION
|
||||
-Use this section to encode all document information
|
||||
-->
|
||||
|
||||
<!ENTITY DocumentTitle "Wireshark's LUA API Reference Manual">
|
||||
<!ENTITY DocumentSubTitle "&SvnVersion; for Wireshark &WiresharkCurrentVersion;">
|
||||
<!ENTITY DocumentTitleAbbreviation "WSLUARM">
|
||||
|
||||
<!ENTITY DocumentCopyrightHolder1 "Luis E. Garcia Ontanon">
|
||||
<!ENTITY DocumentCopyrightYear "2006">
|
||||
|
||||
<!ENTITY DocumentEdition "First ">
|
||||
<!ENTITY DocumentVersion "V0.1">
|
||||
<!ENTITY DocumentPubDate "2006">
|
||||
|
||||
<!ENTITY DocumentLegalNotice "<para>Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or any later version published by the Free Software Foundation.</para><para>All logos and trademarks in this document are property of their respective owner.</para>">
|
||||
|
||||
<!--
|
||||
Wireshark Info
|
||||
-->
|
||||
<!ENTITY WiresharkCurrentVersion "0.99.3">
|
||||
|
||||
<!--
|
||||
Gnu info
|
||||
-->
|
||||
<!ENTITY GPLWebsite "http://www.gnu.org/copyleft/gpl.html">
|
||||
|
||||
<!--
|
||||
Timezone info
|
||||
-->
|
||||
<!ENTITY TimezoneGMTSite "http://wwp.greenwichmeantime.com/">
|
||||
<!ENTITY TimezoneWorldClockSite "http://www.timeanddate.com/worldclock/">
|
||||
<!ENTITY NTPSite "http://www.ntp.org/">
|
||||
<!ENTITY WikipediaWebsite "http://en.wikipedia.org">
|
||||
<!ENTITY WikipediaTimezone "&WikipediaWebsite;/wiki/Time_zone">
|
||||
<!ENTITY WikipediaDaylightSaving "&WikipediaWebsite;/wiki/Daylight_saving">
|
||||
<!ENTITY WikipediaUTC "&WikipediaWebsite;/wiki/Coordinated_Universal_Time">
|
||||
|
||||
<!--
|
||||
FILE SECTION
|
||||
-Use this section to specify the files that make up the book. Use FPI (public identifiers)
|
||||
-->
|
||||
<!-- These refer to graphics files and figures contained in the document -->
|
||||
|
||||
<!-- These are the actual files that make up the document -->
|
||||
<!-- WSLUA_MODULE_ENTITIES -->
|
||||
]>
|
||||
|
||||
<book>
|
||||
<title>&DocumentTitle;</title>
|
||||
<!-- WSLUA_MODULE_TEXT -->
|
||||
</book>
|
||||
Loading…
Reference in New Issue