#!/usr/bin/env perl
# (C) Copyright 1996-2016 ECMWF.
#
# This software is licensed under the terms of the Apache Licence Version 2.0
# which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
# In applying this licence, ECMWF does not waive the privileges and immunities
# granted to it by virtue of its status as an intergovernmental organisation nor
# does it submit to any jurisdiction.
use XML::Parser;
use Time::localtime;
my $file = shift;
my $dir = shift;
my $Author="MagicsTeam";
my $ecmwf="http://wms.ecmwf.int";
my $info = {};
my $element = {};
my %links = (
'psetr'=> [ 'Magics_using', 'Single_Parameter_Setting'],
'pset1r'=> [ 'Magics_using', 'Array_Parameter_Setting'],
'pset1c'=> [ 'Magics_using', 'Array_Parameter_Setting'],
'pset1i'=> [ 'Magics_using', 'Array_Parameter_Setting'],
'psetc'=> [ 'Magics_using', 'Single_Parameter_Setting'],
'pseti'=> [ 'Magics_using', 'Single_Parameter_Setting'],
'preset'=> [ 'Magics_using', 'table_single_param_reset_routines'],
'pcoast'=> [ 'Magics_layout_mapping_coastlines', 'pcoast_tables'],
'pcont'=> [ 'Magics_contour', 'pcont_tables'],
'ptext'=> [ 'Magics', 'Text_Plotting_Parameters'],
'pwind'=> [ 'Magics', 'Wind_Plotting_Parameters'],
'pgrib'=> [ 'Magics_data', 'pgrib_tables'],
'pnew("PAGE")'=> [ 'Magics_layout_mapping_coastlines', 'Pseudo_Action_Routine_PNEW'],
);
my %ulinks = (
'pobs'=> [ 'Magics', 'Observation_Plotting_Parameters_1'],
);
my %magmls = (
);
my $linkmagml;
sub link_function
{
my $action = shift;
if ( ${$links{$action}}[0] ne "") {
return "$action";
}
if ( ${$ulinks{$action}}[0] ne "") {
return "$action";
}
return "$action";
}
sub magml_function
{
# my $magml = shift;
# if ( ${$magmls{$magml}}[0] ne "") {
# return "$magml";
# }
# else {
return "MagML";
# }
}
sub parse
{
my $def = shift;
my $node = shift;
while ( defined ( $element = shift @{ $node } ) )
{
my $child = shift @{ $node };
if ( ref $child )
{
my $attr = \%{ shift @{ $child } };
my $name = $attr->{name};
if ($name ne "")
{
$def->{$element}->{$name} = {};
my $list = $element . "_list";
push( @{$def->{$list}}, $name);
foreach my $a (keys %{$attr})
{
$def->{$element}->{$name}->{attributes}->{$a} = $attr->{$a};
}
parse($def->{$element}->{$name}, $child);
}
else
{
$def->{$element} = {};
foreach my $a (keys %{$attr})
{
$def->{$element}->{attributes}->{$a} = $attr->{$a};
}
parse($def->{$element}, $child);
}
}
else
{
$def->{data} = $child;
}
}
}
my $xml= new XML::Parser(Style=>"Tree");
parse ($info, $xml->parsefile($file));
foreach my $object (keys %{$info->{magics}->{tutorial}})
{
my $current=$info->{magics}->{tutorial}->{$object};
my $section=$current->{attributes}->{name};
my $title=$current->{attributes}->{title};
my $comment=$current->{attributes}->{comment};
my $magml=$current->{attributes}->{magml};
my $magplus=$current->{attributes}->{magplus};
print << "EOF";
$title $comment The expected result Requirements Here are our requirements
EOF
foreach my $req (sort keys %{$current->{requirement}} )
{
my $id=$current->{requirement}->{$req}->{attributes}->{name};
my $subject=$current->{requirement}->{$req}->{attributes}->{subject};
my $text=$current->{requirement}->{$req}->{attributes}->{text};
print << "EOF";
$subject :
$text
EOF
}
print << "EOF";
Clues
EOF
foreach my $req (sort keys %{$current->{requirement}} )
{
my $id=$current->{requirement}->{$req}->{attributes}->{name};
my $subject=$current->{requirement}->{$req}->{attributes}->{subject};
my $text=$current->{requirement}->{$req}->{attributes}->{text};
my $targetdoc=$current->{requirement}->{$req}->{attributes}->{link_doc};
my $targetptr=$current->{requirement}->{$req}->{attributes}->{link_ptr};
my $ulink=$current->{requirement}->{$req}->{attributes}->{ulink};
my $num_param = keys %{$current->{requirement}->{$req}->{parameter}};
my $num_action = keys %{$current->{requirement}->{$req}->{action}};
print <<"EOF";
$subject
EOF
if ( $num_param ne 0 ) {
print <<"EOF";
Parameters for $subject Parameters Values Functions
EOF
foreach my $param (keys %{$current->{requirement}->{$req}->{parameter}} )
{
my $value = $current->{requirement}->{$req}->{parameter}->{$param}->{attributes}->{value};
my $function = $current->{requirement}->{$req}->{parameter}->{$param}->{attributes}->{function};
my $link = link_function($function);
print <<"EOF";
$param$value$link
EOF
}
print <<"EOF";
EOF
}
if ( $num_action ne 0 ) {
print <<"EOF";
Action Routines for $subject Action Routines
EOF
foreach my $function (keys %{$current->{requirement}->{$req}->{action}} )
{
my $link = link_function($function);
print " $link\n";
}
print <<"EOF";
EOF
}
if ( $targetdoc ne "" ) {
print <<"EOF";
More information on $subject
EOF
}
if ( $ulink ne "" ) {
print <<"EOF";
More information on $subject
EOF
}
print <<"EOF";
EOF
}
print << "EOF";
Solution Here is the complete solution
$section\.f
EOF
if ( $magplus ne 'off' ) {
print << "EOF";
Spot the differences... Output for Magics++Output for Magics 6.9Main differences
EOF
foreach my $spot (keys %{$current->{spot}} )
{
my $text=$current->{spot}->{$spot}->{attributes}->{text};
print << "EOF";
$text
EOF
}
$linkmagml = magml_function($magml);
print << "EOF";
EOF
}
if ( $magml ne 'off' ) {
print << "EOF";
Using MagML To get the same result, you can create the following magml description $section\.magml More information on $linkmagml
EOF
}
print << "EOF";
EOF
}