[BACK]Return to lonplot.pm CVS log [TXT] [DIR] Up to [LON-CAPA] / loncom / xml

Diff for /loncom/xml/lonplot.pm between versions 1.45 and 1.48

version 1.45, 2002/01/28 14:12:34 version 1.48, 2002/02/06 10:24:55
Line 29 Line 29
 # 12/17 12/18 12/19 12/20 12/21 12/27 12/28 12/30 12/31 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/01/02 Matthew
 # 01/02 01/03 01/04 01/07 01/08 01/09 Matthew  # 01/02 01/03 01/04 01/07 01/08 01/09 Matthew
 # 01/21 Matthew  # 01/21 02/05 Matthew
   
 package Apache::lonplot;  package Apache::lonplot;
   
Line 40  use Apache::lonxml; Line 40  use Apache::lonxml;
 use Apache::edit;  use Apache::edit;
   
 BEGIN {  BEGIN {
   &Apache::lonxml::register('Apache::lonplot',('plot'));    &Apache::lonxml::register('Apache::lonplot',('gnuplot'));
 }  }
   
 ##   ## 
Line 113  my $words_test     = sub {$_[0]=~s/\s+/ Line 113  my $words_test     = sub {$_[0]=~s/\s+/
 ##                      Attribute metadata                       ##  ##                      Attribute metadata                       ##
 ##                                                               ##  ##                                                               ##
 ###################################################################  ###################################################################
 my @plot_edit_order =   my @gnuplot_edit_order = 
     qw/bgcolor fgcolor height width font transparent grid border align/;      qw/bgcolor fgcolor height width font transparent grid border align/;
 my %plot_defaults =   
   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       => {       height       => {
  default     => 200,   default     => 200,
Line 307  my %axis_defaults = Line 338  my %axis_defaults =
  }   }
      );       );
   
   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 =   my %curve_defaults = 
     (      (
      color     => {       color     => {
Line 339  my %curve_defaults = Line 401  my %curve_defaults =
 ###################################################################  ###################################################################
 my (%plot,%key,%axis,$title,$xlabel,$ylabel,@labels,@curves,%xtics,%ytics);  my (%plot,%key,%axis,$title,$xlabel,$ylabel,@labels,@curves,%xtics,%ytics);
   
 sub start_plot {  sub start_gnuplot {
     %plot    = ();      %key     = ();      %axis   = ();       %plot    = ();      %key     = ();      %axis   = (); 
     $title   = undef;   $xlabel  = undef;   $ylabel = undef;      $title   = undef;   $xlabel  = undef;   $ylabel = undef;
     $#labels = -1;      $#curves = -1;      $#labels = -1;      $#curves = -1;
Line 352  sub start_plot { Line 414  sub start_plot {
       'xtics','ytics'));        'xtics','ytics'));
     push (@Apache::lonxml::namespace,'lonplot');      push (@Apache::lonxml::namespace,'lonplot');
     if ($target eq 'web') {      if ($target eq 'web') {
  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]);   $inside=&Apache::run::evaluate($inside,$safeeval,$$parstack[-1]);
  &Apache::lonxml::newparser($parser,\$inside);   &Apache::lonxml::newparser($parser,\$inside);
  &get_attributes(\%plot,\%plot_defaults,$parstack,$safeeval,   &get_attributes(\%plot,\%gnuplot_defaults,$parstack,$safeeval,
  $tagstack->[-1]);   $tagstack->[-1]);
     } elsif ($target eq 'edit') {      } elsif ($target eq 'edit') {
  $result .= &Apache::edit::tag_start($target,$token,'Plot');   $result .= &Apache::edit::tag_start($target,$token,'GnuPlot');
  $result .= &edit_attributes($target,$token,\%plot_defaults,   $result .= &make_javascript();
     \@plot_edit_order);   $result .= &help_win($gnuplot_help_text);
    $result .= &edit_attributes($target,$token,\%gnuplot_defaults,
       \@gnuplot_edit_order);
     } elsif ($target eq 'modified') {      } elsif ($target eq 'modified') {
  my $constructtag=&Apache::edit::get_new_args   my $constructtag=&Apache::edit::get_new_args
     ($token,$parstack,$safeeval,keys(%plot_defaults));      ($token,$parstack,$safeeval,keys(%gnuplot_defaults));
  if ($constructtag) {   if ($constructtag) {
     $result = &Apache::edit::rebuild_tag($token);      $result = &Apache::edit::rebuild_tag($token);
  }   }
Line 371  sub start_plot { Line 435  sub start_plot {
     return $result;      return $result;
 }  }
   
 sub end_plot {  sub end_gnuplot {
     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;      my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
   
     pop @Apache::lonxml::namespace;      pop @Apache::lonxml::namespace;
     &Apache::lonxml::deregister('Apache::lonplot',      &Apache::lonxml::deregister('Apache::lonplot',
  ('title','xlabel','ylabel','key','axis','label','curve'));   ('title','xlabel','ylabel','key','axis','label','curve'));
Line 393  sub end_plot { Line 456  sub end_plot {
      width  = "$plot{'width'}"        width  = "$plot{'width'}" 
      height = "$plot{'height'}"       height = "$plot{'height'}"
      align  = "$plot{'align'}"       align  = "$plot{'align'}"
      alt    = "/cgi-bin/plot.gif?$filename" />       alt    = "image should be /cgi-bin/plot.gif?$filename" />
 ENDIMAGE  ENDIMAGE
     } elsif ($target eq 'edit') {      } elsif ($target eq 'edit') {
  $result.=&Apache::edit::tag_end($target,$token);   $result.=&Apache::edit::tag_end($target,$token);
Line 645  sub start_curve { Line 708  sub start_curve {
  push (@curves,\%curve);   push (@curves,\%curve);
     } elsif ($target eq 'edit') {      } elsif ($target eq 'edit') {
  $result .= &Apache::edit::tag_start($target,$token,'Curve');   $result .= &Apache::edit::tag_start($target,$token,'Curve');
    $result .= &help_win($curve_help_text);
  $result .= &edit_attributes($target,$token,\%curve_defaults);   $result .= &edit_attributes($target,$token,\%curve_defaults);
     } elsif ($target eq 'modified') {      } elsif ($target eq 'modified') {
  my $constructtag=&Apache::edit::get_new_args   my $constructtag=&Apache::edit::get_new_args
Line 882  sub write_gnuplot_file { Line 946  sub write_gnuplot_file {
     # tics      # tics
     if (%xtics) {          if (%xtics) {    
  $gnuplot_input .= "set xtics $xtics{'location'} ";   $gnuplot_input .= "set xtics $xtics{'location'} ";
  $gnuplot_input .= ( $xtics{'mirror'} eq 'on' ? "mirror" : "nomirror ");   $gnuplot_input .= ( $xtics{'mirror'} eq 'on'?"mirror ":"nomirror ");
  $gnuplot_input .= "$xtics{'start'}, ";   $gnuplot_input .= "$xtics{'start'}, ";
  $gnuplot_input .= "$xtics{'increment'}, ";   $gnuplot_input .= "$xtics{'increment'}, ";
  $gnuplot_input .= "$xtics{'end'}\n";   $gnuplot_input .= "$xtics{'end'}\n";
     }      }
     if (%ytics) {          if (%ytics) {    
  $gnuplot_input .= "set ytics $ytics{'location'} ";   $gnuplot_input .= "set ytics $ytics{'location'} ";
  $gnuplot_input .= ( $ytics{'mirror'} eq 'on' ? "mirror" : "nomirror ");   $gnuplot_input .= ( $ytics{'mirror'} eq 'on'?"mirror ":"nomirror ");
  $gnuplot_input .= "$ytics{'start'}, ";   $gnuplot_input .= "$ytics{'start'}, ";
  $gnuplot_input .= "$ytics{'increment'}, ";   $gnuplot_input .= "$ytics{'increment'}, ";
         $gnuplot_input .= "$ytics{'end'}\n";          $gnuplot_input .= "$ytics{'end'}\n";
Line 962  sub write_gnuplot_file { Line 1026  sub write_gnuplot_file {
 sub check_inputs {  sub check_inputs {
     ## Note: no inputs, no outputs - this acts only on global variables.      ## Note: no inputs, no outputs - this acts only on global variables.
     ## Make sure we have all the input we need:      ## Make sure we have all the input we need:
     if (! %plot) { &set_defaults(\%plot,\%plot_defaults); }      if (! %plot) { &set_defaults(\%plot,\%gnuplot_defaults); }
     if (! %key ) {} # No key for this plot, thats okay      if (! %key ) {} # No key for this plot, thats okay
 #    if (! %axis) { &set_defaults(\%axis,\%axis_defaults); }  #    if (! %axis) { &set_defaults(\%axis,\%axis_defaults); }
     if (! defined($title )) {} # No title for this plot, thats okay      if (! defined($title )) {} # No title for this plot, thats okay
Line 1018  sub edit_attributes { Line 1082  sub edit_attributes {
 ##                                                               ##  ##                                                               ##
 ###################################################################  ###################################################################
   
 #------------------------------------------------ insert_xxxxxxx  sub insert_gnuplot {
 sub insert_plot {  
     my $result = '';      my $result = '';
     #  plot attributes      #  plot attributes
     $result .= "<plot \n";      $result .= "<plot \n";
     foreach my $attr (keys(%plot_defaults)) {      foreach my $attr (keys(%gnuplot_defaults)) {
  $result .= "     $attr=\"$plot_defaults{$attr}->{'default'}\"\n";   $result .= "     $attr=\"$gnuplot_defaults{$attr}->{'default'}\"\n";
     }      }
     $result .= ">\n";      $result .= ">\n";
     # Add the components      # Add the components (most are commented out for simplicity)
     # $result .= &insert_key();      # $result .= &insert_key();
     # $result .= &insert_axis();      # $result .= &insert_axis();
     # $result .= &insert_title();          # $result .= &insert_title();    
Line 1039  sub insert_plot { Line 1102  sub insert_plot {
     return $result;      return $result;
 }  }
   
   sub insert_tics {
       my $result;
       $result .= &insert_xtics() . &insert_ytics;
       return $result;
   }
   
 sub insert_xtics {  sub insert_xtics {
     my $result;      my $result;
     $result .= "    <xtics \n";      $result .= "\n    <xtics ";
     foreach my $attr (keys(%tic_defaults)) {      foreach my $attr (keys(%tic_defaults)) {
  $result .= "         $attr=\"$tic_defaults{$attr}->{'default'}\"\n";   $result .= "$attr=\"$tic_defaults{$attr}->{'default'}\" ";
     }      }
     $result .= "   />\n";      $result .= "/>\n";
     return $result;      return $result;
 }  }
   
 sub insert_ytics {  sub insert_ytics {
     my $result;      my $result;
     $result .= "    <ytics \n";      $result .= "\n    <ytics ";
     foreach my $attr (keys(%tic_defaults)) {      foreach my $attr (keys(%tic_defaults)) {
  $result .= "         $attr=\"$tic_defaults{$attr}->{'default'}\"\n";   $result .= "$attr=\"$tic_defaults{$attr}->{'default'}\" ";
     }      }
     $result .= "   />\n";      $result .= "/>\n";
     return $result;      return $result;
 }  }
   
 sub insert_key {  sub insert_key {
     my $result;      my $result;
     $result .= "    <key \n";      $result .= "\n    <key \n";
     foreach my $attr (keys(%key_defaults)) {      foreach my $attr (keys(%key_defaults)) {
  $result .= "         $attr=\"$key_defaults{$attr}->{'default'}\"\n";   $result .= "         $attr=\"$key_defaults{$attr}->{'default'}\"\n";
     }      }
Line 1071  sub insert_key { Line 1140  sub insert_key {
   
 sub insert_axis{  sub insert_axis{
     my $result;      my $result;
     $result .= '    <axis ';      $result .= "\n    <axis ";
    foreach my $attr (keys(%axis_defaults)) {     foreach my $attr (keys(%axis_defaults)) {
  $result .= "         $attr=\"$axis_defaults{$attr}->{'default'}\"\n";   $result .= "         $attr=\"$axis_defaults{$attr}->{'default'}\"\n";
     }      }
Line 1079  sub insert_axis{ Line 1148  sub insert_axis{
     return $result;      return $result;
 }  }
   
 sub insert_title { return "    <title></title>\n"; }  sub insert_title { return "\n    <title></title>\n"; }
 sub insert_xlabel { return "    <xlabel></xlabel>\n"; }  sub insert_xlabel { return "\n    <xlabel></xlabel>\n"; }
 sub insert_ylabel { return "    <ylabel></ylabel>\n"; }  sub insert_ylabel { return "\n    <ylabel></ylabel>\n"; }
   
 sub insert_label {  sub insert_label {
     my $result;      my $result;
     $result .= '    <label ';      $result .= "\n    <label ";
     foreach my $attr (keys(%label_defaults)) {      foreach my $attr (keys(%label_defaults)) {
  $result .= '         '.$attr.'="'.   $result .= '         '.$attr.'="'.
     $label_defaults{$attr}->{'default'}."\"\n";      $label_defaults{$attr}->{'default'}."\"\n";
Line 1118  sub insert_data { Line 1187  sub insert_data {
 }  }
   
 ##----------------------------------------------------------------------  ##----------------------------------------------------------------------
   # 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;  1;
 __END__  __END__
   
Removed from v.1.45  
changed lines
  Added in v.1.48

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>