--- loncom/xml/lonplot.pm 2001/12/27 22:30:01 1.20
+++ loncom/xml/lonplot.pm 2002/02/27 16:54:58 1.50
@@ -1,7 +1,7 @@
# The LearningOnline Network with CAPA
# Dynamic plot
#
-# $Id: lonplot.pm,v 1.20 2001/12/27 22:30:01 matthew Exp $
+# $Id: lonplot.pm,v 1.50 2002/02/27 16:54:58 matthew Exp $
#
# Copyright Michigan State University Board of Trustees
#
@@ -26,7 +26,11 @@
# http://www.lon-capa.org/
#
# 12/15/01 Matthew
-# 12/17 12/18 12/19 12/20 12/21 12/27 Matthew
+# 12/17 12/18 12/19 12/20 12/21 12/27 12/28 12/30 12/31 Matthew
+# 01/01/02 Matthew
+# 01/02 01/03 01/04 01/07 01/08 01/09 Matthew
+# 01/21 02/05 02/06 Matthew
+
package Apache::lonplot;
use strict;
@@ -35,8 +39,8 @@ use Apache::response;
use Apache::lonxml;
use Apache::edit;
-sub BEGIN {
- &Apache::lonxml::register('Apache::lonplot',('plot'));
+BEGIN {
+ &Apache::lonxml::register('Apache::lonplot',('gnuplot'));
}
##
@@ -63,10 +67,37 @@ sub BEGIN {
## $curves[$i]->{'data'} = [ [x1,x2,x3,x4],
## [y1,y2,y3,y4] ]
##
-##------------------------------------------------------------
-##
-## Tests used in checking the validitity of input
-##
+
+###################################################################
+## ##
+## Tests used in checking the validitity of input ##
+## ##
+###################################################################
+
+my $max_str_len = 50; # if a label, title, xlabel, or ylabel text
+ # is longer than this, it will be truncated.
+
+my %linestyles =
+ (
+ lines => 2, # Maybe this will be used in the future
+ linespoints => 2, # to check on whether or not they have
+ dots => 2, # supplied enough <data></data> fields
+ points => 2, # to use the given line style. But for
+ steps => 2, # now there are more important things
+ fsteps => 2, # for me to deal with.
+ histeps => 2,
+ errorbars => 3,
+ xerrorbars => [3,4],
+ yerrorbars => [3,4],
+ xyerrorbars => [4,6],
+ boxes => 3,
+# boxerrorbars => [3,4,5],
+# boxxyerrorbars => [4,6,7],
+# financebars => 5,
+# candlesticks => 5,
+ vector => 4
+ );
+
my $int_test = sub {$_[0]=~s/\s+//g;$_[0]=~/^\d+$/};
my $real_test =
sub {$_[0]=~s/\s+//g;$_[0]=~/^[+-]?\d*\.?\d*([eE][+-]\d+)?$/};
@@ -74,54 +105,94 @@ my $color_test = sub {$_[0]=~s/\s+//
my $onoff_test = sub {$_[0]=~/^(on|off)$/};
my $key_pos_test = sub {$_[0]=~/^(top|bottom|right|left|outside|below| )+$/};
my $sml_test = sub {$_[0]=~/^(small|medium|large)$/};
-my $linestyle_test = sub {$_[0]=~/^(lines|linespoints|dots|points|steps)$/};
+my $linestyle_test = sub {exists($linestyles{$_[0]})};
my $words_test = sub {$_[0]=~s/\s+/ /g;$_[0]=~/^([\w\(\)]+ ?)+$/};
-##
-## Attribute metadata
-##
-my %plot_defaults =
+
+###################################################################
+## ##
+## Attribute metadata ##
+## ##
+###################################################################
+my @gnuplot_edit_order =
+ qw/bgcolor fgcolor height width font transparent grid border align/;
+
+my $gnuplot_help_text = <<"ENDPLOTHELP";
+<p>
+The <b>gnuplot</b> tag allows an author to design a plot which can
+be created on the fly. This is intended for use in homework problems
+where each student needs to see a distinct plot. It can be used in
+conjunction with a <b>script</b> tag to generate random plots.
+</p><p>
+A <b>gnuplot</b> tag can contain the following sub-tags:
+</p>
+<dl>
+<dt> Plot Label
+ <dd> Allows you to place text at a given (x,y) coordinate on the plot.
+<dt> Plot Title
+ <dd> The title of the plot
+<dt> Plot Xlabel
+ <dd> The label on the horizontal axis of the plot
+<dt> Plot Ylabel
+ <dd> The label on the vertical axis of the plot
+<dt> Plot Axes
+ <dd> allows specification of the x and y ranges displayed in the plot
+<dt> Plot Key
+ <dd> Lists the functions displayed in the plot.
+<dt> Plot Curve
+ <dd> Sets the data used in the plot.
+<dt> Plot Tics
+ <dd> Allows specification of the x and y coordinate 'tics' on the axes.
+This is mostly used to adjust the grid lines when a grid is displayed.
+</dl>
+ENDPLOTHELP
+
+my %gnuplot_defaults =
(
height => {
default => 200,
test => $int_test,
- description => 'vertical size of image (pixels)',
- edit_type => 'entry'
+ description => 'height of image (pixels)',
+ edit_type => 'entry',
+ size => '10'
},
width => {
default => 200,
test => $int_test,
- description => 'horizontal size of image (pixels)',
- edit_type => 'entry'
+ description => 'width of image (pixels)',
+ edit_type => 'entry',
+ size => '10'
},
bgcolor => {
default => 'xffffff',
test => $color_test,
description => 'background color of image (xffffff)',
- edit_type => 'entry'
+ edit_type => 'entry',
+ size => '10'
},
fgcolor => {
default => 'x000000',
test => $color_test,
description => 'foreground color of image (x000000)',
- edit_type => 'entry'
+ edit_type => 'entry',
+ size => '10'
},
transparent => {
default => 'off',
test => $onoff_test,
- description => '',
- edit_type => 'on_off'
+ description => 'Transparent image',
+ edit_type => 'onoff'
},
grid => {
default => 'off',
test => $onoff_test,
- description => '',
- edit_type => 'on_off'
+ description => 'Display grid',
+ edit_type => 'onoff'
},
border => {
default => 'on',
test => $onoff_test,
- description => '',
- edit_type => 'on_off'
+ description => 'Draw border around plot',
+ edit_type => 'onoff'
},
font => {
default => 'medium',
@@ -145,13 +216,14 @@ my %key_defaults =
default => '',
test => $words_test,
description => 'Title of key',
- edit_type => 'entry'
+ edit_type => 'entry',
+ size => '40'
},
box => {
default => 'off',
test => $onoff_test,
description => 'Draw a box around the key?',
- edit_type => 'on_off'
+ edit_type => 'onoff'
},
pos => {
default => 'top right',
@@ -169,13 +241,15 @@ my %label_defaults =
default => 0,
test => $real_test,
description => 'x position of label (graph coordinates)',
- edit_type => 'entry'
+ edit_type => 'entry',
+ size => '10'
},
ypos => {
default => 0,
test => $real_test,
description => 'y position of label (graph coordinates)',
- edit_type => 'entry'
+ edit_type => 'entry',
+ size => '10'
},
justify => {
default => 'left',
@@ -186,155 +260,274 @@ my %label_defaults =
}
);
+my @tic_edit_order = ('location','mirror','start','increment','end');
+my %tic_defaults =
+ (
+ location => {
+ default => 'border',
+ test => sub {$_[0]=~/^(border|axis)$/},
+ description => 'Location of tick marks',
+ edit_type => 'choice',
+ choices => ['border','axis']
+ },
+ mirror => {
+ default => 'on',
+ test => $onoff_test,
+ description => 'mirror ticks on opposite axis?',
+ edit_type => 'onoff'
+ },
+ start => {
+ default => '-10.0',
+ test => $real_test,
+ description => 'Start ticks at',
+ edit_type => 'entry',
+ size => '10'
+ },
+ increment => {
+ default => '1.0',
+ test => $real_test,
+ description => 'Place a tick every',
+ edit_type => 'entry',
+ size => '10'
+ },
+ end => {
+ default => ' 10.0',
+ test => $real_test,
+ description => 'Stop ticks at ',
+ edit_type => 'entry',
+ size => '10'
+ },
+ );
+
my %axis_defaults =
(
- color => {
+ color => {
default => 'x000000',
test => $color_test,
description => 'color of axes (x000000)',
- edit_type => 'entry'
+ edit_type => 'entry',
+ size => '10'
},
xmin => {
default => '-10.0',
test => $real_test,
description => 'minimum x-value shown in plot',
- edit_type => 'entry'
+ edit_type => 'entry',
+ size => '10'
},
xmax => {
default => ' 10.0',
test => $real_test,
description => 'maximum x-value shown in plot',
- edit_type => 'entry'
+ edit_type => 'entry',
+ size => '10'
},
ymin => {
default => '-10.0',
test => $real_test,
description => 'minimum y-value shown in plot',
- edit_type => 'entry'
+ edit_type => 'entry',
+ size => '10'
},
ymax => {
default => ' 10.0',
test => $real_test,
description => 'maximum y-value shown in plot',
- edit_type => 'entry'
- },
- linestyle => {
- default => 'points',
- test => $linestyle_test,
- description => 'Style of the axis lines',
- edit_type => 'choice',
- choices => ['lines','linespoints','dots','points']
+ edit_type => 'entry',
+ size => '10'
}
);
+my $curve_help_text = <<"ENDCURVEHELP";
+The <b>curve</b> tag is where you set the data to be plotted by gnuplot.
+There are two ways of entering the information:
+<dl>
+ <dt> Curve Data
+ <dd> Using a <b>data</b> tag you can specify the numbers used to produce
+the plot.
+<p>
+By default, two <b>data</b> tags will be available in a plot. The
+first will specify X coordinates of the data and the second will
+give the Y coordinates of the data. When working with a linestyle that
+requires more than two data sets, inserting another <b>data</b> tag is
+required. Unfortunately, you must make sure the <b>data</b> tags appear
+in the order gnuplot expects the data.
+</p><p>
+Specifying the data should usually be done with a perl variable or array,
+such as \@Xdata and \@Ydata. You may also specify numerical data seperated
+by commas. Again, the order of the <b>data</b> tags is important. The
+first tag will be the X data and the second will be the Y data.
+</p>
+ <dt> Curve Function
+ <dd> The <b>function</b> tag allows you to specify the curve to be
+plotted as a formula that gnuplot can understand. Be careful using this
+tag - it is surprisingly easy to give gnuplot a function it cannot deal
+with properly. Be explicit: 2*sin(2*3.141592*x/4) will work but
+2sin(2*3.141592x/4) will not. If you do not receive any errors in the
+gnuplot data but still do not have an image produced, it is likely there
+is an error in your <b>function</b> tag.
+</dl>
+ENDCURVEHELP
+
my %curve_defaults =
(
color => {
default => 'x000000',
test => $color_test,
description => 'color of curve (x000000)',
- edit_type => 'entry'
+ edit_type => 'entry',
+ size => '10'
},
name => {
default => '',
test => $words_test,
description => 'name of curve to appear in key',
- edit_type => 'entry'
+ edit_type => 'entry',
+ size => '20'
},
linestyle => {
default => 'lines',
test => $linestyle_test,
- description => 'Style of the axis lines',
+ description => 'Line style',
edit_type => 'choice',
- choices => ['lines','linespoints','dots','points','steps']
+ choices => [keys(%linestyles)]
}
);
-##
-## End of defaults
-##
-my (%plot,%key,%axis,$title,$xlabel,$ylabel,@labels,@curves);
+###################################################################
+## ##
+## parsing and edit rendering ##
+## ##
+###################################################################
+my (%plot,%key,%axis,$title,$xlabel,$ylabel,@labels,@curves,%xtics,%ytics);
-sub start_plot {
- %plot = undef; %key = undef; %axis = undef;
+sub start_gnuplot {
+ %plot = (); %key = (); %axis = ();
$title = undef; $xlabel = undef; $ylabel = undef;
$#labels = -1; $#curves = -1;
+ %xtics = (); %ytics = ();
#
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
my $result='';
+ &Apache::lonxml::register('Apache::lonplot',
+ ('title','xlabel','ylabel','key','axis','label','curve',
+ 'xtics','ytics'));
+ push (@Apache::lonxml::namespace,'lonplot');
if ($target eq 'web') {
- &Apache::lonxml::register('Apache::lonplot',
- ('title','xlabel','ylabel','key','axis','label','curve'));
- push (@Apache::lonxml::namespace,'plot');
- ## Always evaluate the insides of the <plot></plot> tags
- my $inside = &Apache::lonxml::get_all_text("/plot",$$parser[-1]);
+ my $inside = &Apache::lonxml::get_all_text("/gnuplot",$$parser[-1]);
$inside=&Apache::run::evaluate($inside,$safeeval,$$parstack[-1]);
&Apache::lonxml::newparser($parser,\$inside);
- ##-------------------------------------------------------
- &get_attributes(\%plot,\%plot_defaults,$parstack,$safeeval,
+ &get_attributes(\%plot,\%gnuplot_defaults,$parstack,$safeeval,
$tagstack->[-1]);
} elsif ($target eq 'edit') {
+ $result .= &Apache::edit::tag_start($target,$token,'GnuPlot');
+ $result .= &make_javascript();
+ $result .= &help_win($gnuplot_help_text);
+ $result .= &edit_attributes($target,$token,\%gnuplot_defaults,
+ \@gnuplot_edit_order);
} elsif ($target eq 'modified') {
my $constructtag=&Apache::edit::get_new_args
- ($token,$parstack,$safeeval,keys %plot_defaults);
+ ($token,$parstack,$safeeval,keys(%gnuplot_defaults));
if ($constructtag) {
$result = &Apache::edit::rebuild_tag($token);
- $result.= &Apache::edit::handle_insert();
}
}
- return '';
+ return $result;
}
-sub end_plot {
+sub end_gnuplot {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
pop @Apache::lonxml::namespace;
&Apache::lonxml::deregister('Apache::lonplot',
('title','xlabel','ylabel','key','axis','label','curve'));
my $result = '';
if ($target eq 'web') {
- ##
- ## Make sure we have all the input we need:
- if (! defined(%plot )) { &set_defaults(\%plot,\%plot_defaults); }
- if (! defined(%key )) {} # No key for this plot
- if (! defined(%axis )) { &set_defaults(\%axis,\%axis_defaults); }
- if (! defined($title )) {} # No title for this plot
- if (! defined($xlabel)) {} # No xlabel for this plot
- if (! defined($ylabel)) {} # No ylabel for this plot
- if ($#labels < 0) { } # No labels for this plot
- if ($#curves < 0) {
- &Apache::lonxml::warning("No curves specified for plot!!!!");
- return '';
- }
- my $curve;
- foreach $curve (@curves) {
- if (!defined($curve->{'function'})&&!defined($curve->{'data'})){
- &Apache::lonxml::warning("One of the curves specified did not contain any <data> or <function> declarations\n");
- return '';
- }
- }
+ &check_inputs(); # Make sure we have all the data we need
##
## Determine filename
my $tmpdir = '/home/httpd/perl/tmp/';
my $filename = $ENV{'user.name'}.'_'.$ENV{'user.domain'}.
- '_'.time.'_'.$$.'_plot.data';
+ '_'.time.'_'.$$.int(rand(1000)).'_plot.data';
## Write the plot description to the file
- my $fh=Apache::File->new(">$tmpdir$filename");
- print $fh &write_gnuplot_file();
- close($fh);
+ &write_gnuplot_file($tmpdir,$filename);
## return image tag for the plot
$result .= <<"ENDIMAGE";
<img src = "/cgi-bin/plot.gif?$filename"
width = "$plot{'width'}"
height = "$plot{'height'}"
align = "$plot{'align'}"
- alt = "/cgi-bin/plot.gif?$filename" />
+ alt = "image should be /cgi-bin/plot.gif?$filename" />
ENDIMAGE
} elsif ($target eq 'edit') {
+ $result.=&Apache::edit::tag_end($target,$token);
+ }
+ return $result;
+}
+
+
+##--------------------------------------------------------------- xtics
+sub start_xtics {
+ my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
+ my $result='';
+ if ($target eq 'web') {
+ &get_attributes(\%xtics,\%tic_defaults,$parstack,$safeeval,
+ $tagstack->[-1]);
+ } elsif ($target eq 'edit') {
+ $result .= &Apache::edit::tag_start($target,$token,'xtics');
+ $result .= &edit_attributes($target,$token,\%tic_defaults,
+ \@tic_edit_order);
} elsif ($target eq 'modified') {
+ my $constructtag=&Apache::edit::get_new_args
+ ($token,$parstack,$safeeval,keys(%tic_defaults));
+ if ($constructtag) {
+ $result = &Apache::edit::rebuild_tag($token);
+ }
}
return $result;
}
+sub end_xtics {
+ my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
+ my $result = '';
+ if ($target eq 'web') {
+ } elsif ($target eq 'edit') {
+ $result.=&Apache::edit::tag_end($target,$token);
+ }
+ return $result;
+}
+
+##--------------------------------------------------------------- ytics
+sub start_ytics {
+ my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
+ my $result='';
+ if ($target eq 'web') {
+ &get_attributes(\%ytics,\%tic_defaults,$parstack,$safeeval,
+ $tagstack->[-1]);
+ } elsif ($target eq 'edit') {
+ $result .= &Apache::edit::tag_start($target,$token,'ytics');
+ $result .= &edit_attributes($target,$token,\%tic_defaults,
+ \@tic_edit_order);
+ } elsif ($target eq 'modified') {
+ my $constructtag=&Apache::edit::get_new_args
+ ($token,$parstack,$safeeval,keys(%tic_defaults));
+ if ($constructtag) {
+ $result = &Apache::edit::rebuild_tag($token);
+ }
+ }
+ return $result;
+}
+
+sub end_ytics {
+ my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
+ my $result = '';
+ if ($target eq 'web') {
+ } elsif ($target eq 'edit') {
+ $result.=&Apache::edit::tag_end($target,$token);
+ }
+ return $result;
+}
+
+
##----------------------------------------------------------------- key
sub start_key {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
@@ -343,12 +536,13 @@ sub start_key {
&get_attributes(\%key,\%key_defaults,$parstack,$safeeval,
$tagstack->[-1]);
} elsif ($target eq 'edit') {
+ $result .= &Apache::edit::tag_start($target,$token,'Plot Key');
+ $result .= &edit_attributes($target,$token,\%key_defaults);
} elsif ($target eq 'modified') {
my $constructtag=&Apache::edit::get_new_args
- ($token,$parstack,$safeeval,keys %key_defaults);
+ ($token,$parstack,$safeeval,keys(%key_defaults));
if ($constructtag) {
$result = &Apache::edit::rebuild_tag($token);
- $result.= &Apache::edit::handle_insert();
}
}
return $result;
@@ -359,18 +553,31 @@ sub end_key {
my $result = '';
if ($target eq 'web') {
} elsif ($target eq 'edit') {
- } elsif ($target eq 'modified') {
+ $result.=&Apache::edit::tag_end($target,$token);
}
return $result;
}
+
##------------------------------------------------------------------- title
sub start_title {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
my $result='';
if ($target eq 'web') {
$title = &Apache::lonxml::get_all_text("/title",$$parser[-1]);
+ $title =~ s/\n/ /g;
+ if (length($title) > $max_str_len) {
+ $title = substr($title,0,$max_str_len);
+ }
} elsif ($target eq 'edit') {
+ $result.=&Apache::edit::tag_start($target,$token,'Plot Title');
+ my $text=&Apache::lonxml::get_all_text("/title",$$parser[-1]);
+ $result.=&Apache::edit::end_row().
+ &Apache::edit::start_spanning_row().
+ &Apache::edit::editfield('',$text,'',60,1);
} elsif ($target eq 'modified') {
+ my $text=$$parser[-1]->get_text("/title");
+ $result.=&Apache::edit::rebuild_tag($token);
+ $result.=&Apache::edit::modifiedfield($token);
}
return $result;
}
@@ -380,7 +587,7 @@ sub end_title {
my $result = '';
if ($target eq 'web') {
} elsif ($target eq 'edit') {
- } elsif ($target eq 'modified') {
+ $result.=&Apache::edit::tag_end($target,$token);
}
return $result;
}
@@ -390,8 +597,20 @@ sub start_xlabel {
my $result='';
if ($target eq 'web') {
$xlabel = &Apache::lonxml::get_all_text("/xlabel",$$parser[-1]);
+ $xlabel =~ s/\n/ /g;
+ if (length($xlabel) > $max_str_len) {
+ $xlabel = substr($xlabel,0,$max_str_len);
+ }
} elsif ($target eq 'edit') {
+ $result.=&Apache::edit::tag_start($target,$token,'Plot Xlabel');
+ my $text=&Apache::lonxml::get_all_text("/xlabel",$$parser[-1]);
+ $result.=&Apache::edit::end_row().
+ &Apache::edit::start_spanning_row().
+ &Apache::edit::editfield('',$text,'',60,1);
} elsif ($target eq 'modified') {
+ my $text=$$parser[-1]->get_text("/xlabel");
+ $result.=&Apache::edit::rebuild_tag($token);
+ $result.=&Apache::edit::modifiedfield($token);
}
return $result;
}
@@ -401,18 +620,31 @@ sub end_xlabel {
my $result = '';
if ($target eq 'web') {
} elsif ($target eq 'edit') {
- } elsif ($target eq 'modified') {
+ $result.=&Apache::edit::tag_end($target,$token);
}
return $result;
}
+
##------------------------------------------------------------------- ylabel
sub start_ylabel {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
my $result='';
if ($target eq 'web') {
$ylabel = &Apache::lonxml::get_all_text("/ylabel",$$parser[-1]);
+ $ylabel =~ s/\n/ /g;
+ if (length($ylabel) > $max_str_len) {
+ $ylabel = substr($ylabel,0,$max_str_len);
+ }
} elsif ($target eq 'edit') {
+ $result .= &Apache::edit::tag_start($target,$token,'Plot Ylabel');
+ my $text = &Apache::lonxml::get_all_text("/ylabel",$$parser[-1]);
+ $result .= &Apache::edit::end_row().
+ &Apache::edit::start_spanning_row().
+ &Apache::edit::editfield('',$text,'',60,1);
} elsif ($target eq 'modified') {
+ my $text=$$parser[-1]->get_text("/ylabel");
+ $result.=&Apache::edit::rebuild_tag($token);
+ $result.=&Apache::edit::modifiedfield($token);
}
return $result;
}
@@ -422,10 +654,11 @@ sub end_ylabel {
my $result = '';
if ($target eq 'web') {
} elsif ($target eq 'edit') {
- } elsif ($target eq 'modified') {
+ $result.=&Apache::edit::tag_end($target,$token);
}
return $result;
}
+
##------------------------------------------------------------------- label
sub start_label {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
@@ -434,20 +667,24 @@ sub start_label {
my %label;
&get_attributes(\%label,\%label_defaults,$parstack,$safeeval,
$tagstack->[-1]);
- $label{'text'} = &Apache::lonxml::get_all_text("/label",$$parser[-1]);
- if (! &$words_test($label{'text'})) {
- # I should probably warn about it, too.
- $label{'text'} = 'Illegal text';
- }
+ my $text = &Apache::lonxml::get_all_text("/label",$$parser[-1]);
+ $text =~ s/\n/ /g;
+ $text = substr($text,0,$max_str_len) if (length($text) > $max_str_len);
+ $label{'text'} = $text;
push(@labels,\%label);
} elsif ($target eq 'edit') {
+ $result .= &Apache::edit::tag_start($target,$token,'Plot Label');
+ $result .= &edit_attributes($target,$token,\%label_defaults);
+ my $text = &Apache::lonxml::get_all_text("/label",$$parser[-1]);
+ $result .= &Apache::edit::end_row().
+ &Apache::edit::start_spanning_row().
+ &Apache::edit::editfield('',$text,'',60,1);
} elsif ($target eq 'modified') {
- my $constructtag=&Apache::edit::get_new_args
- ($token,$parstack,$safeeval,keys %label_defaults);
- if ($constructtag) {
- $result = &Apache::edit::rebuild_tag($token);
- $result.= &Apache::edit::handle_insert();
- }
+ &Apache::edit::get_new_args
+ ($token,$parstack,$safeeval,keys(%label_defaults));
+ $result.=&Apache::edit::rebuild_tag($token);
+ my $text=$$parser[-1]->get_text("/label");
+ $result.=&Apache::edit::modifiedfield($token);
}
return $result;
}
@@ -457,7 +694,7 @@ sub end_label {
my $result = '';
if ($target eq 'web') {
} elsif ($target eq 'edit') {
- } elsif ($target eq 'modified') {
+ $result.=&Apache::edit::tag_end($target,$token);
}
return $result;
}
@@ -466,17 +703,20 @@ sub end_label {
sub start_curve {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
my $result='';
+ &Apache::lonxml::register('Apache::lonplot',('function','data'));
+ push (@Apache::lonxml::namespace,'curve');
if ($target eq 'web') {
my %curve;
&get_attributes(\%curve,\%curve_defaults,$parstack,$safeeval,
$tagstack->[-1]);
push (@curves,\%curve);
- &Apache::lonxml::register('Apache::lonplot',('function','data'));
- push (@Apache::lonxml::namespace,'curve');
} elsif ($target eq 'edit') {
+ $result .= &Apache::edit::tag_start($target,$token,'Curve');
+ $result .= &help_win($curve_help_text);
+ $result .= &edit_attributes($target,$token,\%curve_defaults);
} elsif ($target eq 'modified') {
my $constructtag=&Apache::edit::get_new_args
- ($token,$parstack,$safeeval,keys %label_defaults);
+ ($token,$parstack,$safeeval,keys(%curve_defaults));
if ($constructtag) {
$result = &Apache::edit::rebuild_tag($token);
$result.= &Apache::edit::handle_insert();
@@ -488,14 +728,15 @@ sub start_curve {
sub end_curve {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
my $result = '';
+ pop @Apache::lonxml::namespace;
+ &Apache::lonxml::deregister('Apache::lonplot',('function','data'));
if ($target eq 'web') {
- pop @Apache::lonxml::namespace;
- &Apache::lonxml::deregister('Apache::lonplot',('function','data'));
} elsif ($target eq 'edit') {
- } elsif ($target eq 'modified') {
+ $result.=&Apache::edit::tag_end($target,$token);
}
return $result;
}
+
##------------------------------------------------------------ curve function
sub start_function {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
@@ -508,13 +749,13 @@ sub start_function {
$curves[-1]->{'function'} =
&Apache::lonxml::get_all_text("/function",$$parser[-1]);
} elsif ($target eq 'edit') {
- $result.=&Apache::edit::tag_start($target,$token);
- my $text=&Apache::lonxml::get_all_text("/function",$$parser[-1]);
- $result.='</td></tr><tr><td colspan="3">'.
- &Apache::edit::editfield('',$text,'',20,1).
- &Apache::edit::end_table();
+ $result .= &Apache::edit::tag_start($target,$token,'Gnuplot compatible curve function');
+ my $text = &Apache::lonxml::get_all_text("/function",$$parser[-1]);
+ $result .= &Apache::edit::end_row().
+ &Apache::edit::start_spanning_row().
+ &Apache::edit::editfield('',$text,'',60,1);
} elsif ($target eq 'modified') {
- # Why do I do this?
+ $result.=&Apache::edit::rebuild_tag($token);
my $text=$$parser[-1]->get_text("/function");
$result.=&Apache::edit::modifiedfield($token);
}
@@ -526,10 +767,11 @@ sub end_function {
my $result = '';
if ($target eq 'web') {
} elsif ($target eq 'edit') {
- } elsif ($target eq 'modified') {
+ $result .= &Apache::edit::end_table();
}
return $result;
}
+
##------------------------------------------------------------ curve data
sub start_data {
my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
@@ -542,12 +784,17 @@ sub start_data {
delete($curves[-1]->{'function'});
}
my $datatext = &Apache::lonxml::get_all_text("/data",$$parser[-1]);
- $datatext =~ s/\s+/ /g;
+ # Deal with cases where we're given an array...
+ if ($datatext =~ /^\@/) {
+ $datatext = &Apache::run::run('return "'.$datatext.'"',
+ $safeeval,1);
+ }
+ $datatext =~ s/\s+/ /g;
# Need to do some error checking on the @data array -
# make sure it's all numbers and make sure each array
# is of the same length.
my @data;
- if ($datatext =~ /,/) {
+ if ($datatext =~ /,/) { # comma deliminated
@data = split /,/,$datatext;
} else { # Assume it's space seperated.
@data = split / /,$datatext;
@@ -568,9 +815,24 @@ sub start_data {
$data[$i] = 1.15572734979092;
}
}
+ # complain if the number of data points is not the same as
+ # in previous sets of data.
+ if (($curves[-1]->{'data'}) && ($#data != $#{@{$curves[-1]->{'data'}->[0]}})){
+ &Apache::lonxml::warning
+ ('Number of data points is not consistent with previous '.
+ 'number of data points');
+ }
push @{$curves[-1]->{'data'}},\@data;
} elsif ($target eq 'edit') {
+ $result .= &Apache::edit::tag_start($target,$token,'Comma or space deliminated curve data');
+ my $text = &Apache::lonxml::get_all_text("/data",$$parser[-1]);
+ $result .= &Apache::edit::end_row().
+ &Apache::edit::start_spanning_row().
+ &Apache::edit::editfield('',$text,'',60,1);
} elsif ($target eq 'modified') {
+ $result.=&Apache::edit::rebuild_tag($token);
+ my $text=$$parser[-1]->get_text("/data");
+ $result.=&Apache::edit::modifiedfield($token);
}
return $result;
}
@@ -580,7 +842,7 @@ sub end_data {
my $result = '';
if ($target eq 'web') {
} elsif ($target eq 'edit') {
- } elsif ($target eq 'modified') {
+ $result .= &Apache::edit::end_table();
}
return $result;
}
@@ -593,7 +855,14 @@ sub start_axis {
&get_attributes(\%axis,\%axis_defaults,$parstack,$safeeval,
$tagstack->[-1]);
} elsif ($target eq 'edit') {
+ $result .= &Apache::edit::tag_start($target,$token,'Plot Axes');
+ $result .= &edit_attributes($target,$token,\%axis_defaults);
} elsif ($target eq 'modified') {
+ my $constructtag=&Apache::edit::get_new_args
+ ($token,$parstack,$safeeval,keys(%axis_defaults));
+ if ($constructtag) {
+ $result = &Apache::edit::rebuild_tag($token);
+ }
}
return $result;
}
@@ -603,35 +872,31 @@ sub end_axis {
my $result = '';
if ($target eq 'web') {
} elsif ($target eq 'edit') {
+ $result.=&Apache::edit::tag_end($target,$token);
} elsif ($target eq 'modified') {
- my $constructtag=&Apache::edit::get_new_args
- ($token,$parstack,$safeeval,keys %axis_defaults);
- if ($constructtag) {
- $result = &Apache::edit::rebuild_tag($token);
- $result.= &Apache::edit::handle_insert();
- }
}
return $result;
}
+###################################################################
+## ##
+## Utility Functions ##
+## ##
+###################################################################
+
##----------------------------------------------------------- set_defaults
sub set_defaults {
- my $var = shift;
- my $defaults = shift;
+ my ($var,$defaults) = @_;
my $key;
- foreach $key (keys %$defaults) {
+ foreach $key (keys(%$defaults)) {
$var->{$key} = $defaults->{$key}->{'default'};
}
}
##------------------------------------------------------------------- misc
sub get_attributes{
- my $values = shift;
- my $defaults = shift;
- my $parstack = shift;
- my $safeeval = shift;
- my $tag = shift;
- foreach my $attr (keys %{$defaults}) {
+ my ($values,$defaults,$parstack,$safeeval,$tag) = @_;
+ foreach my $attr (keys(%{$defaults})) {
$values->{$attr} =
&Apache::lonxml::get_param($attr,$parstack,$safeeval);
if ($values->{$attr} eq '' | !defined($values->{$attr})) {
@@ -648,8 +913,10 @@ sub get_attributes{
}
return ;
}
+
##------------------------------------------------------- write_gnuplot_file
sub write_gnuplot_file {
+ my ($tmpdir,$filename)= @_;
my $gnuplot_input = '';
my $curve;
# Collect all the colors
@@ -668,25 +935,43 @@ sub write_gnuplot_file {
$gnuplot_input .= $plot{'font'} . ' ';
$gnuplot_input .= 'size '.$plot{'width'}.','.$plot{'height'}.' ';
$gnuplot_input .= "@Colors\n";
+ # set output
+ $gnuplot_input .= "set output\n";
# grid
$gnuplot_input .= 'set grid'.$/ if ($plot{'grid'} eq 'on');
# border
$gnuplot_input .= ($plot{'border'} eq 'on'?
'set border'.$/ :
'set noborder'.$/ ); # title, xlabel, ylabel
- $gnuplot_input .= "set output\n";
+ # titles
$gnuplot_input .= "set title \"$title\"\n" if (defined($title)) ;
$gnuplot_input .= "set xlabel \"$xlabel\"\n" if (defined($xlabel));
$gnuplot_input .= "set ylabel \"$ylabel\"\n" if (defined($ylabel));
- if (defined(%axis)) {
+ # tics
+ if (%xtics) {
+ $gnuplot_input .= "set xtics $xtics{'location'} ";
+ $gnuplot_input .= ( $xtics{'mirror'} eq 'on'?"mirror ":"nomirror ");
+ $gnuplot_input .= "$xtics{'start'}, ";
+ $gnuplot_input .= "$xtics{'increment'}, ";
+ $gnuplot_input .= "$xtics{'end'}\n";
+ }
+ if (%ytics) {
+ $gnuplot_input .= "set ytics $ytics{'location'} ";
+ $gnuplot_input .= ( $ytics{'mirror'} eq 'on'?"mirror ":"nomirror ");
+ $gnuplot_input .= "$ytics{'start'}, ";
+ $gnuplot_input .= "$ytics{'increment'}, ";
+ $gnuplot_input .= "$ytics{'end'}\n";
+ }
+ # axis
+ if (%axis) {
$gnuplot_input .= "set xrange \[$axis{'xmin'}:$axis{'xmax'}\]\n";
$gnuplot_input .= "set yrange \[$axis{'ymin'}:$axis{'ymax'}\]\n";
}
# Key
- if (defined(%key)) {
+ if (%key) {
$gnuplot_input .= 'set key '.$key{'pos'}.' ';
if ($key{'title'} ne '') {
- $gnuplot_input .= 'title "'.$key{'title'}.'" ';
+ $gnuplot_input .= 'title " '.$key{'title'}.'" ';
}
$gnuplot_input .= ($key{'box'} eq 'on' ? 'box ' : 'nobox ').$/;
} else {
@@ -700,7 +985,6 @@ sub write_gnuplot_file {
}
# curves
$gnuplot_input .= 'plot ';
- my $datatext = '';
for (my $i = 0;$i<=$#curves;$i++) {
$curve = $curves[$i];
$gnuplot_input.= ', ' if ($i > 0);
@@ -710,9 +994,12 @@ sub write_gnuplot_file {
$curve->{'name'}.'" with '.
$curve->{'linestyle'};
} elsif (exists($curve->{'data'})) {
- $gnuplot_input.= '\'-\' title "'.
- $curve->{'name'}.'" with '.
- $curve->{'linestyle'};
+ # Store data values in $datatext
+ my $datatext = '';
+ # get new filename
+ my $datafilename = "$tmpdir/$filename.$i";
+ my $fh=Apache::File->new(">$datafilename");
+ # Compile data
my @Data = @{$curve->{'data'}};
my @Data0 = @{$Data[0]};
for (my $i =0; $i<=$#Data0; $i++) {
@@ -722,66 +1009,134 @@ sub write_gnuplot_file {
}
$datatext .= $/;
}
- $datatext .=$/;
+ # write file
+ print $fh $datatext;
+ close ($fh);
+ # generate gnuplot text
+ $gnuplot_input.= '"'.$datafilename.'" title "'.
+ $curve->{'name'}.'" with '.
+ $curve->{'linestyle'};
+ }
+ }
+ # Write the output to a file.
+ my $fh=Apache::File->new(">$tmpdir$filename");
+ print $fh $gnuplot_input;
+ close($fh);
+ # That's all folks.
+ return ;
+}
+
+#---------------------------------------------- check_inputs
+sub check_inputs {
+ ## Note: no inputs, no outputs - this acts only on global variables.
+ ## Make sure we have all the input we need:
+ if (! %plot) { &set_defaults(\%plot,\%gnuplot_defaults); }
+ if (! %key ) {} # No key for this plot, thats okay
+# if (! %axis) { &set_defaults(\%axis,\%axis_defaults); }
+ if (! defined($title )) {} # No title for this plot, thats okay
+ if (! defined($xlabel)) {} # No xlabel for this plot, thats okay
+ if (! defined($ylabel)) {} # No ylabel for this plot, thats okay
+ if ($#labels < 0) { } # No labels for this plot, thats okay
+ if ($#curves < 0) {
+ &Apache::lonxml::warning("No curves specified for plot!!!!");
+ return '';
+ }
+ my $curve;
+ foreach $curve (@curves) {
+ if (!defined($curve->{'function'})&&!defined($curve->{'data'})){
+ &Apache::lonxml::warning("One of the curves specified did not contain any <data> or <function> declarations\n");
+ return '';
}
}
- $gnuplot_input .= $/.$datatext;
- return $gnuplot_input;
}
+
#------------------------------------------------ make_edit
sub edit_attributes {
- my $target = shift;
- my $token = shift;
- my $defaults = shift;
- my $result;
- foreach my $attr (%{$token->[2]}) {
+ my ($target,$token,$defaults,$keys) = @_;
+ my ($result,@keys);
+ if ($keys && ref($keys) eq 'ARRAY') {
+ @keys = @$keys;
+ } else {
+ @keys = sort(keys(%$defaults));
+ }
+ foreach my $attr (@keys) {
+ # append a ' ' to the description if it doesn't have one already.
+ my $description = $defaults->{$attr}->{'description'};
+ $description .= ' ' if ($description !~ / $/);
if ($defaults->{$attr}->{'edit_type'} eq 'entry') {
- $result .= &Apache::edit::text_arg(
- $defaults->{$attr}->{'description'},
- $attr,
- $token);
+ $result .= &Apache::edit::text_arg
+ ($description,$attr,$token,
+ $defaults->{$attr}->{'size'});
} elsif ($defaults->{$attr}->{'edit_type'} eq 'choice') {
- $result .= &Apache::edit::select_arg(
- $defaults->{$attr}->{'description'},
- $attr,
- $defaults->{$attr}->{'choices'},
- $token);
+ $result .= &Apache::edit::select_arg
+ ($description,$attr,$defaults->{$attr}->{'choices'},$token);
+ } elsif ($defaults->{$attr}->{'edit_type'} eq 'onoff') {
+ $result .= &Apache::edit::select_arg
+ ($description,$attr,['on','off'],$token);
}
+ $result .= '<br />';
}
return $result;
}
-#------------------------------------------------ insert_xxxxxxx
-sub insert_plot {
- my $result;
+
+###################################################################
+## ##
+## Insertion functions for editing plots ##
+## ##
+###################################################################
+
+sub insert_gnuplot {
+ my $result = '';
# plot attributes
- $result .= '<plot ';
- foreach my $attr (%plot_defaults) {
- $result .= ' '.$attr.' "'.$plot_defaults{$attr}->{'default'}.
- "\"\n";
+ $result .= "<gnuplot \n";
+ foreach my $attr (keys(%gnuplot_defaults)) {
+ $result .= " $attr=\"$gnuplot_defaults{$attr}->{'default'}\"\n";
}
$result .= ">\n";
- # Add the components
- $result .= &insert_key();
- $result .= &insert_axis();
- $result .= &insert_label();
- $result .= &insert_curve();
- $result .= &insert_function();
- $result .= "</curve>\n";
+ # Add the components (most are commented out for simplicity)
+ # $result .= &insert_key();
+ # $result .= &insert_axis();
+ # $result .= &insert_title();
+ # $result .= &insert_xlabel();
+ # $result .= &insert_ylabel();
$result .= &insert_curve();
- $result .= &insert_data();
- $result .= "</curve>\n";
- # close up the <plot>
- $result .= "</plot>\n";
+ # close up the <gnuplot>
+ $result .= "</gnuplot>\n";
+ return $result;
+}
+
+sub insert_tics {
+ my $result;
+ $result .= &insert_xtics() . &insert_ytics;
+ return $result;
+}
+
+sub insert_xtics {
+ my $result;
+ $result .= "\n <xtics ";
+ foreach my $attr (keys(%tic_defaults)) {
+ $result .= "$attr=\"$tic_defaults{$attr}->{'default'}\" ";
+ }
+ $result .= "/>\n";
+ return $result;
+}
+
+sub insert_ytics {
+ my $result;
+ $result .= "\n <ytics ";
+ foreach my $attr (keys(%tic_defaults)) {
+ $result .= "$attr=\"$tic_defaults{$attr}->{'default'}\" ";
+ }
+ $result .= "/>\n";
return $result;
}
sub insert_key {
my $result;
- $result .= ' <key ';
- foreach my $attr (%key_defaults) {
- $result .= ' '.$attr.' "'.$key_defaults{$attr}->{'default'}.
- "\"\n";
+ $result .= "\n <key \n";
+ foreach my $attr (keys(%key_defaults)) {
+ $result .= " $attr=\"$key_defaults{$attr}->{'default'}\"\n";
}
$result .= " />\n";
return $result;
@@ -789,20 +1144,23 @@ sub insert_key {
sub insert_axis{
my $result;
- $result .= ' <axis ';
- foreach my $attr (%axis_defaults) {
- $result .= ' '.$attr.' "'.$axis_defaults{$attr}->{'default'}.
- "\"\n";
+ $result .= "\n <axis ";
+ foreach my $attr (keys(%axis_defaults)) {
+ $result .= " $attr=\"$axis_defaults{$attr}->{'default'}\"\n";
}
$result .= " />\n";
return $result;
}
+sub insert_title { return "\n <title></title>\n"; }
+sub insert_xlabel { return "\n <xlabel></xlabel>\n"; }
+sub insert_ylabel { return "\n <ylabel></ylabel>\n"; }
+
sub insert_label {
my $result;
- $result .= ' <label ';
- foreach my $attr (%label_defaults) {
- $result .= ' '.$attr.' "'.
+ $result .= "\n <label ";
+ foreach my $attr (keys(%label_defaults)) {
+ $result .= ' '.$attr.'="'.
$label_defaults{$attr}->{'default'}."\"\n";
}
$result .= " ></label>\n";
@@ -811,12 +1169,13 @@ sub insert_label {
sub insert_curve {
my $result;
- $result .= ' <curve ';
- foreach my $attr (%curve_defaults) {
- $result .= ' '.$attr.' "'.
+ $result .= "\n <curve ";
+ foreach my $attr (keys(%curve_defaults)) {
+ $result .= ' '.$attr.'="'.
$curve_defaults{$attr}->{'default'}."\"\n";
}
$result .= " >\n";
+ $result .= &insert_data().&insert_data()."</curve>\n";
}
sub insert_function {
@@ -828,10 +1187,44 @@ sub insert_function {
sub insert_data {
my $result;
$result .= " <data></data>\n";
- $result .= " <data></data>\n";
return $result;
}
+##----------------------------------------------------------------------
+# Javascript functions to display help for tags
+
+sub make_javascript {
+ my $helpwindowwidth = 400;
+ my $helpwindowheight = 400;
+ my $result = '';
+ $result.=<<"ENDFUNCTION";
+<script language="JavaScript">
+function openWin(text)
+{
+ newWin = open("", "new_W", "width=$helpwindowwidth,height=$helpwindowheight,resizable=1,scrollbars=1");
+ newWin.document.open("text/html", "replace");
+ newWin.document.writeln(text);
+ newWin.document.writeln('<center><a href=\"javascript:window.close()\">close this window</a></center>');
+ newWin.document.close();
+}
+</script>
+ENDFUNCTION
+ return $result;
+}
+
+sub help_win {
+ my ($helptext)=@_;
+ $helptext =~ s/\n/ /g;
+ $helptext =~ s/\'/\\\'/g;
+ my $result = '';
+ $result.=<<"ENDWIN";
+<table width="100%"><tr><td align="right">
+<a href="javascript:openWin('$helptext')">help</a>
+</td></tr></table><hr />
+ENDWIN
+ return $result;
+}
+##----------------------------------------------------------------------
1;
__END__