Annotation of loncom/xml/lonplot.pm, revision 1.54

1.1       matthew     1: # The LearningOnline Network with CAPA
                      2: # Dynamic plot
                      3: #
1.54    ! matthew     4: # $Id: lonplot.pm,v 1.53 2002/02/28 21:04:10 matthew Exp $
1.1       matthew     5: #
                      6: # Copyright Michigan State University Board of Trustees
                      7: #
                      8: # This file is part of the LearningOnline Network with CAPA (LON-CAPA).
                      9: #
                     10: # LON-CAPA is free software; you can redistribute it and/or modify
                     11: # it under the terms of the GNU General Public License as published by
                     12: # the Free Software Foundation; either version 2 of the License, or
                     13: # (at your option) any later version.
                     14: #
                     15: # LON-CAPA is distributed in the hope that it will be useful,
                     16: # but WITHOUT ANY WARRANTY; without even the implied warranty of
                     17: # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
                     18: # GNU General Public License for more details.
                     19: #
                     20: # You should have received a copy of the GNU General Public License
                     21: # along with LON-CAPA; if not, write to the Free Software
                     22: # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
                     23: #
                     24: # /home/httpd/html/adm/gpl.txt
                     25: #
                     26: # http://www.lon-capa.org/
                     27: #
1.3       matthew    28: # 12/15/01 Matthew
1.31      matthew    29: # 12/17 12/18 12/19 12/20 12/21 12/27 12/28 12/30 12/31 Matthew
                     30: # 01/01/02 Matthew
1.35      matthew    31: # 01/02 01/03 01/04 01/07 01/08 01/09 Matthew
1.52      matthew    32: # 01/21 02/05 02/06 2/28Matthew
1.35      matthew    33: 
1.1       matthew    34: package Apache::lonplot;
1.10      matthew    35: 
1.1       matthew    36: use strict;
1.10      matthew    37: use Apache::File;
1.1       matthew    38: use Apache::response;
1.2       matthew    39: use Apache::lonxml;
1.20      matthew    40: use Apache::edit;
1.10      matthew    41: 
1.33      harris41   42: BEGIN {
1.47      matthew    43:   &Apache::lonxml::register('Apache::lonplot',('gnuplot'));
1.1       matthew    44: }
                     45: 
1.10      matthew    46: ## 
                     47: ## Description of data structures:
                     48: ##
                     49: ##  %plot       %key    %axis
                     50: ## --------------------------
                     51: ##  height      title   color
                     52: ##  width       box     xmin
                     53: ##  bgcolor     pos     xmax
                     54: ##  fgcolor             ymin
                     55: ##  transparent         ymax
                     56: ##  grid
                     57: ##  border
                     58: ##  font
1.19      matthew    59: ##  align
1.10      matthew    60: ##
                     61: ##  @labels: $labels[$i] = \%label
                     62: ##           %label: text, xpos, ypos, justify
1.14      matthew    63: ##
1.10      matthew    64: ##  @curves: $curves[$i] = \%curve
1.14      matthew    65: ##           %curve: name, linestyle, ( function | data )
1.10      matthew    66: ##
                     67: ##  $curves[$i]->{'data'} = [ [x1,x2,x3,x4],
                     68: ##                            [y1,y2,y3,y4] ]
                     69: ##
1.21      matthew    70: 
                     71: ###################################################################
                     72: ##                                                               ##
                     73: ##        Tests used in checking the validitity of input         ##
                     74: ##                                                               ##
                     75: ###################################################################
1.29      matthew    76: 
1.32      matthew    77: my $max_str_len = 50;    # if a label, title, xlabel, or ylabel text
                     78:                          # is longer than this, it will be truncated.
                     79: 
1.29      matthew    80: my %linestyles = 
                     81:     (
                     82:      lines          => 2,     # Maybe this will be used in the future
                     83:      linespoints    => 2,     # to check on whether or not they have 
                     84:      dots	    => 2,     # supplied enough <data></data> fields
                     85:      points         => 2,     # to use the given line style.  But for
                     86:      steps	    => 2,     # now there are more important things 
                     87:      fsteps	    => 2,     # for me to deal with.
                     88:      histeps        => 2,
1.34      matthew    89:      errorbars	    => 3,
                     90:      xerrorbars	    => [3,4],
                     91:      yerrorbars	    => [3,4],
1.35      matthew    92:      xyerrorbars    => [4,6],
1.34      matthew    93:      boxes          => 3,
1.35      matthew    94: #     boxerrorbars   => [3,4,5],
                     95: #     boxxyerrorbars => [4,6,7],
                     96: #     financebars    => 5,
                     97: #     candlesticks   => 5,
                     98:      vector	    => 4
1.29      matthew    99:     );		    
                    100: 
1.11      matthew   101: my $int_test       = sub {$_[0]=~s/\s+//g;$_[0]=~/^\d+$/};
1.19      matthew   102: my $real_test      = 
                    103:     sub {$_[0]=~s/\s+//g;$_[0]=~/^[+-]?\d*\.?\d*([eE][+-]\d+)?$/};
1.11      matthew   104: my $color_test     = sub {$_[0]=~s/\s+//g;$_[0]=~/^x[\da-f]{6}$/};
1.1       matthew   105: my $onoff_test     = sub {$_[0]=~/^(on|off)$/};
1.15      matthew   106: my $key_pos_test   = sub {$_[0]=~/^(top|bottom|right|left|outside|below| )+$/};
1.1       matthew   107: my $sml_test       = sub {$_[0]=~/^(small|medium|large)$/};
1.29      matthew   108: my $linestyle_test = sub {exists($linestyles{$_[0]})};
1.15      matthew   109: my $words_test     = sub {$_[0]=~s/\s+/ /g;$_[0]=~/^([\w\(\)]+ ?)+$/};
1.21      matthew   110: 
                    111: ###################################################################
                    112: ##                                                               ##
                    113: ##                      Attribute metadata                       ##
                    114: ##                                                               ##
                    115: ###################################################################
1.47      matthew   116: my @gnuplot_edit_order = 
1.37      matthew   117:     qw/bgcolor fgcolor height width font transparent grid border align/;
1.48      matthew   118: 
                    119: my $gnuplot_help_text = <<"ENDPLOTHELP";
                    120: <p>
                    121: The <b>gnuplot</b> tag allows an author to design a plot which can
                    122: be created on the fly.  This is intended for use in homework problems
                    123: where each student needs to see a distinct plot.  It can be used in
                    124: conjunction with a <b>script</b> tag to generate random plots.
                    125: </p><p>
                    126: A <b>gnuplot</b> tag can contain the following sub-tags:
                    127: </p>
                    128: <dl>
                    129: <dt> Plot Label
                    130:     <dd> Allows you to place text at a given (x,y) coordinate on the plot.
                    131: <dt> Plot Title
                    132:     <dd> The title of the plot
                    133: <dt> Plot Xlabel
                    134:     <dd> The label on the horizontal axis of the plot
                    135: <dt> Plot Ylabel
                    136:     <dd> The label on the vertical axis of the plot
                    137: <dt> Plot Axes
                    138:     <dd> allows specification of the x and y ranges displayed in the plot
                    139: <dt> Plot Key
                    140:     <dd> Lists the functions displayed in the plot.
                    141: <dt> Plot Curve
                    142:     <dd> Sets the data used in the plot.
                    143: <dt> Plot Tics
                    144:     <dd> Allows specification of the x and y coordinate 'tics' on the axes.
                    145: This is mostly used to adjust the grid lines when a grid is displayed.
                    146: </dl>
                    147: ENDPLOTHELP
                    148: 
1.47      matthew   149: my %gnuplot_defaults = 
1.1       matthew   150:     (
1.20      matthew   151:      height       => {
                    152: 	 default     => 200,
                    153: 	 test        => $int_test,
1.29      matthew   154: 	 description => 'height of image (pixels)',
1.38      matthew   155:       	 edit_type   => 'entry',
                    156: 	 size        => '10'
1.20      matthew   157: 	 },
                    158:      width        => {
                    159: 	 default     => 200,
                    160: 	 test        => $int_test,
1.29      matthew   161: 	 description => 'width of image (pixels)',
1.38      matthew   162: 	 edit_type   => 'entry',
                    163: 	 size        => '10'
1.20      matthew   164: 	 },
                    165:      bgcolor      => {
                    166: 	 default     => 'xffffff',
                    167: 	 test        => $color_test, 
                    168: 	 description => 'background color of image (xffffff)',
1.38      matthew   169: 	 edit_type   => 'entry',
                    170: 	 size        => '10'
1.20      matthew   171: 	 },
                    172:      fgcolor      => {
                    173: 	 default     => 'x000000',
                    174: 	 test        => $color_test,
                    175: 	 description => 'foreground color of image (x000000)',
1.38      matthew   176: 	 edit_type   => 'entry',
                    177: 	 size        => '10'
1.20      matthew   178: 	 },
                    179:      transparent  => {
                    180: 	 default     => 'off',
                    181: 	 test        => $onoff_test, 
1.34      matthew   182: 	 description => 'Transparent image',
1.45      matthew   183: 	 edit_type   => 'onoff'
1.20      matthew   184: 	 },
                    185:      grid         => {
                    186: 	 default     => 'off',
                    187: 	 test        => $onoff_test, 
1.34      matthew   188: 	 description => 'Display grid',
1.45      matthew   189: 	 edit_type   => 'onoff'
1.20      matthew   190: 	 },
                    191:      border       => {
                    192: 	 default     => 'on',
                    193: 	 test        => $onoff_test, 
1.34      matthew   194: 	 description => 'Draw border around plot',
1.45      matthew   195: 	 edit_type   => 'onoff'
1.20      matthew   196: 	 },
                    197:      font         => {
                    198: 	 default     => 'medium',
                    199: 	 test        => $sml_test,
                    200: 	 description => 'Size of font to use',
                    201: 	 edit_type   => 'choice',
                    202: 	 choices     => ['small','medium','large']
                    203: 	 },
                    204:      align        => {
                    205: 	 default     => 'left',
                    206: 	 test        => sub {$_[0]=~/^(left|right|center)$/},
                    207: 	 description => 'alignment for image in html',
                    208: 	 edit_type   => 'choice',
                    209: 	 choices     => ['left','right','center']
                    210: 	 } 
1.1       matthew   211:      );
                    212: 
                    213: my %key_defaults = 
                    214:     (
1.20      matthew   215:      title => { 
                    216: 	 default => '',
                    217: 	 test => $words_test,
                    218: 	 description => 'Title of key',
1.38      matthew   219: 	 edit_type   => 'entry',
                    220: 	 size        => '40'
1.20      matthew   221: 	 },
                    222:      box   => { 
                    223: 	 default => 'off',
                    224: 	 test => $onoff_test,
                    225: 	 description => 'Draw a box around the key?',
1.45      matthew   226: 	 edit_type   => 'onoff'
1.20      matthew   227: 	 },
                    228:      pos   => { 
                    229: 	 default => 'top right', 
                    230: 	 test => $key_pos_test, 
                    231: 	 description => 'position of the key on the plot',
                    232: 	 edit_type   => 'choice',
                    233: 	 choices     => ['top left','top right','bottom left','bottom right',
                    234: 			 'outside','below']
                    235: 	 }
1.1       matthew   236:      );
                    237: 
                    238: my %label_defaults = 
                    239:     (
1.20      matthew   240:      xpos    => {
                    241: 	 default => 0,
                    242: 	 test => $real_test,
                    243: 	 description => 'x position of label (graph coordinates)',
1.38      matthew   244: 	 edit_type   => 'entry',
                    245: 	 size        => '10'
1.20      matthew   246: 	 },
                    247:      ypos    => {
                    248: 	 default => 0, 
                    249: 	 test => $real_test,
                    250: 	 description => 'y position of label (graph coordinates)',
1.38      matthew   251: 	 edit_type   => 'entry',
                    252: 	 size        => '10'
1.20      matthew   253: 	 },
                    254:      justify => {
                    255: 	 default => 'left',    
                    256: 	 test => sub {$_[0]=~/^(left|right|center)$/},
                    257: 	 description => 'justification of the label text on the plot',
                    258: 	 edit_type   => 'choice',
                    259: 	 choices     => ['left','right','center']
                    260:      }
1.1       matthew   261:      );
                    262: 
1.45      matthew   263: my @tic_edit_order = ('location','mirror','start','increment','end');
                    264: my %tic_defaults =
                    265:     (
                    266:      location => {
                    267: 	 default => 'border', 
                    268: 	 test => sub {$_[0]=~/^(border|axis)$/},
                    269: 	 description => 'Location of tick marks',
                    270: 	 edit_type   => 'choice',
                    271: 	 choices     => ['border','axis']
                    272: 	 },
                    273:      mirror => {
                    274: 	 default => 'on', 
                    275: 	 test => $onoff_test,
                    276: 	 description => 'mirror ticks on opposite axis?',
                    277: 	 edit_type   => 'onoff'
                    278: 	 },
                    279:      start => {
                    280: 	 default => '-10.0',
                    281: 	 test => $real_test,
                    282: 	 description => 'Start ticks at',
                    283: 	 edit_type   => 'entry',
                    284: 	 size        => '10'
                    285: 	 },
                    286:      increment => {
                    287: 	 default => '1.0',
                    288: 	 test => $real_test,
                    289: 	 description => 'Place a tick every',
                    290: 	 edit_type   => 'entry',
                    291: 	 size        => '10'
                    292: 	 },
                    293:      end => {
                    294: 	 default => ' 10.0',
                    295: 	 test => $real_test,
                    296: 	 description => 'Stop ticks at ',
                    297: 	 edit_type   => 'entry',
                    298: 	 size        => '10'
                    299: 	 },
                    300:      );
                    301: 
1.1       matthew   302: my %axis_defaults = 
                    303:     (
1.28      matthew   304:      color   => {
1.20      matthew   305: 	 default => 'x000000', 
                    306: 	 test => $color_test,
                    307: 	 description => 'color of axes (x000000)',
1.38      matthew   308: 	 edit_type   => 'entry',
                    309: 	 size        => '10'
1.20      matthew   310: 	 },
                    311:      xmin      => {
                    312: 	 default => '-10.0',
                    313: 	 test => $real_test,
                    314: 	 description => 'minimum x-value shown in plot',
1.38      matthew   315: 	 edit_type   => 'entry',
                    316: 	 size        => '10'
1.20      matthew   317: 	 },
                    318:      xmax      => {
                    319: 	 default => ' 10.0',
                    320: 	 test => $real_test,
                    321: 	 description => 'maximum x-value shown in plot',	 
1.38      matthew   322: 	 edit_type   => 'entry',
                    323: 	 size        => '10'
1.20      matthew   324: 	 },
                    325:      ymin      => {
                    326: 	 default => '-10.0',
                    327: 	 test => $real_test,
                    328: 	 description => 'minimum y-value shown in plot',	 
1.38      matthew   329: 	 edit_type   => 'entry',
                    330: 	 size        => '10'
1.20      matthew   331: 	 },
                    332:      ymax      => {
                    333: 	 default => ' 10.0',
                    334: 	 test => $real_test,
                    335: 	 description => 'maximum y-value shown in plot',	 
1.38      matthew   336: 	 edit_type   => 'entry',
                    337: 	 size        => '10'
1.20      matthew   338: 	 }
1.1       matthew   339:      );
                    340: 
1.48      matthew   341: my $curve_help_text = <<"ENDCURVEHELP";
                    342: The <b>curve</b> tag is where you set the data to be plotted by gnuplot.
                    343: There are two ways of entering the information:
                    344: <dl>
                    345:     <dt> Curve Data
                    346:     <dd> Using a <b>data</b> tag you can specify the numbers used to produce 
                    347: the plot.  
                    348: <p>
                    349: By default, two <b>data</b> tags will be available in a plot.  The
                    350: first will specify X coordinates of the data and the second will
                    351: give the Y coordinates of the data.  When working with a linestyle that 
                    352: requires more than two data sets, inserting another <b>data</b> tag is
                    353: required.  Unfortunately, you must make sure the <b>data</b> tags appear
                    354: in the order gnuplot expects the data.
                    355: </p><p>
                    356: Specifying the data should usually be done with a perl variable or array, 
                    357: such as \@Xdata and \@Ydata.  You may also specify numerical data seperated 
                    358: by commas.  Again, the order of the <b>data</b> tags is important.  The
                    359: first tag will be the X data and the second will be the Y data.
                    360: </p>
                    361:     <dt> Curve Function
                    362:     <dd> The <b>function</b> tag allows you to specify the curve to be 
                    363: plotted as a formula that gnuplot can understand.  Be careful using this
                    364: tag - it is surprisingly easy to give gnuplot a function it cannot deal
                    365: with properly.  Be explicit: 2*sin(2*3.141592*x/4) will work but
                    366: 2sin(2*3.141592x/4) will not.  If you do not receive any errors in the
                    367: gnuplot data but still do not have an image produced, it is likely there
                    368: is an error in your <b>function</b> tag.
                    369: </dl>
                    370: ENDCURVEHELP
                    371: 
1.1       matthew   372: my %curve_defaults = 
                    373:     (
1.20      matthew   374:      color     => {
                    375: 	 default => 'x000000',
                    376: 	 test => $color_test,
                    377: 	 description => 'color of curve (x000000)',
1.38      matthew   378: 	 edit_type   => 'entry',
                    379: 	 size        => '10'
1.20      matthew   380: 	 },
                    381:      name      => {
                    382: 	 default => '',
                    383: 	 test => $words_test,
                    384: 	 description => 'name of curve to appear in key',
1.38      matthew   385: 	 edit_type   => 'entry',
                    386: 	 size        => '20'
1.20      matthew   387: 	 },
                    388:      linestyle => {
                    389: 	 default => 'lines',
                    390: 	 test => $linestyle_test,
1.35      matthew   391: 	 description => 'Line style',
1.20      matthew   392: 	 edit_type   => 'choice',
1.38      matthew   393: 	 choices     => [keys(%linestyles)]
1.20      matthew   394: 	 }
1.1       matthew   395:      );
                    396: 
1.21      matthew   397: ###################################################################
                    398: ##                                                               ##
                    399: ##                    parsing and edit rendering                 ##
                    400: ##                                                               ##
                    401: ###################################################################
1.45      matthew   402: my (%plot,%key,%axis,$title,$xlabel,$ylabel,@labels,@curves,%xtics,%ytics);
1.1       matthew   403: 
1.47      matthew   404: sub start_gnuplot {
1.23      matthew   405:     %plot    = ();      %key     = ();      %axis   = (); 
1.10      matthew   406:     $title   = undef;   $xlabel  = undef;   $ylabel = undef;
                    407:     $#labels = -1;      $#curves = -1;
1.45      matthew   408:     %xtics    = ();      %ytics    = ();
1.6       matthew   409:     #
1.1       matthew   410:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                    411:     my $result='';
1.25      matthew   412:     &Apache::lonxml::register('Apache::lonplot',
1.45      matthew   413: 	     ('title','xlabel','ylabel','key','axis','label','curve',
                    414: 	      'xtics','ytics'));
1.29      matthew   415:     push (@Apache::lonxml::namespace,'lonplot');
1.51      matthew   416:     if ($target eq 'web' || $target eq 'tex') {
1.47      matthew   417: 	my $inside = &Apache::lonxml::get_all_text("/gnuplot",$$parser[-1]);
1.17      matthew   418: 	$inside=&Apache::run::evaluate($inside,$safeeval,$$parstack[-1]);
1.29      matthew   419: 	&Apache::lonxml::newparser($parser,\$inside);
1.47      matthew   420: 	&get_attributes(\%plot,\%gnuplot_defaults,$parstack,$safeeval,
1.17      matthew   421: 			$tagstack->[-1]);
1.20      matthew   422:     } elsif ($target eq 'edit') {
1.47      matthew   423: 	$result .= &Apache::edit::tag_start($target,$token,'GnuPlot');
1.48      matthew   424: 	$result .= &make_javascript();
                    425: 	$result .= &help_win($gnuplot_help_text);
1.47      matthew   426: 	$result .= &edit_attributes($target,$token,\%gnuplot_defaults,
                    427: 				    \@gnuplot_edit_order);
1.20      matthew   428:     } elsif ($target eq 'modified') {
                    429: 	my $constructtag=&Apache::edit::get_new_args
1.47      matthew   430: 	    ($token,$parstack,$safeeval,keys(%gnuplot_defaults));
1.20      matthew   431: 	if ($constructtag) {
                    432: 	    $result = &Apache::edit::rebuild_tag($token);
                    433: 	}
1.4       matthew   434:     }
1.21      matthew   435:     return $result;
1.1       matthew   436: }
                    437: 
1.47      matthew   438: sub end_gnuplot {
1.1       matthew   439:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                    440:     pop @Apache::lonxml::namespace;
1.4       matthew   441:     &Apache::lonxml::deregister('Apache::lonplot',
                    442: 	('title','xlabel','ylabel','key','axis','label','curve'));
                    443:     my $result = '';
1.51      matthew   444:     if ($target eq 'web' || $target eq 'tex') {
1.21      matthew   445: 	&check_inputs(); # Make sure we have all the data we need
1.13      matthew   446: 	##
                    447: 	## Determine filename
1.4       matthew   448: 	my $tmpdir = '/home/httpd/perl/tmp/';
1.12      matthew   449: 	my $filename = $ENV{'user.name'}.'_'.$ENV{'user.domain'}.
1.29      matthew   450: 	    '_'.time.'_'.$$.int(rand(1000)).'_plot.data';
1.4       matthew   451: 	## Write the plot description to the file
1.51      matthew   452: 	&write_gnuplot_file($tmpdir,$filename,$target);
1.54    ! matthew   453: 	$filename = &Apache::lonnet::escape($filename);
1.4       matthew   454: 	## return image tag for the plot
1.51      matthew   455: 	if ($target eq 'web') {
                    456: 	    $result .= <<"ENDIMAGE";
1.53      matthew   457: <img src    = "/cgi-bin/plot.gif?file=$filename&output=gif" 
1.16      matthew   458:      width  = "$plot{'width'}" 
                    459:      height = "$plot{'height'}"
                    460:      align  = "$plot{'align'}"
1.47      matthew   461:      alt    = "image should be /cgi-bin/plot.gif?$filename" />
1.12      matthew   462: ENDIMAGE
1.51      matthew   463:         } elsif ($target eq 'tex') {
1.53      matthew   464: 	    &Apache::lonnet::ssi('cgi-bin/plot.gif?file=$filename'.
                    465: 				 '&output=eps');
1.51      matthew   466: 	    $result = "$filename.eps";
                    467: 	}
1.20      matthew   468:     } elsif ($target eq 'edit') {
1.21      matthew   469: 	$result.=&Apache::edit::tag_end($target,$token);
1.4       matthew   470:     }
1.1       matthew   471:     return $result;
                    472: }
1.2       matthew   473: 
1.45      matthew   474: 
                    475: ##--------------------------------------------------------------- xtics
                    476: sub start_xtics {
                    477:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                    478:     my $result='';
1.51      matthew   479:     if ($target eq 'web' || $target eq 'tex') {
1.45      matthew   480: 	&get_attributes(\%xtics,\%tic_defaults,$parstack,$safeeval,
                    481: 		    $tagstack->[-1]);
                    482:     } elsif ($target eq 'edit') {
                    483: 	$result .= &Apache::edit::tag_start($target,$token,'xtics');
                    484: 	$result .= &edit_attributes($target,$token,\%tic_defaults,
                    485: 				    \@tic_edit_order);
                    486:     } elsif ($target eq 'modified') {
                    487: 	my $constructtag=&Apache::edit::get_new_args
                    488: 	    ($token,$parstack,$safeeval,keys(%tic_defaults));
                    489: 	if ($constructtag) {
                    490: 	    $result = &Apache::edit::rebuild_tag($token);
                    491: 	}
                    492:     }
                    493:     return $result;
                    494: }
                    495: 
                    496: sub end_xtics {
                    497:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                    498:     my $result = '';
1.51      matthew   499:     if ($target eq 'web' || $target eq 'tex') {
1.45      matthew   500:     } elsif ($target eq 'edit') {
                    501: 	$result.=&Apache::edit::tag_end($target,$token);
                    502:     }
                    503:     return $result;
                    504: }
                    505: 
                    506: ##--------------------------------------------------------------- ytics
                    507: sub start_ytics {
                    508:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                    509:     my $result='';
1.51      matthew   510:     if ($target eq 'web' || $target eq 'tex') {
1.45      matthew   511: 	&get_attributes(\%ytics,\%tic_defaults,$parstack,$safeeval,
                    512: 		    $tagstack->[-1]);
                    513:     } elsif ($target eq 'edit') {
                    514: 	$result .= &Apache::edit::tag_start($target,$token,'ytics');
                    515: 	$result .= &edit_attributes($target,$token,\%tic_defaults,
                    516: 				    \@tic_edit_order);
                    517:     } elsif ($target eq 'modified') {
                    518: 	my $constructtag=&Apache::edit::get_new_args
                    519: 	    ($token,$parstack,$safeeval,keys(%tic_defaults));
                    520: 	if ($constructtag) {
                    521: 	    $result = &Apache::edit::rebuild_tag($token);
                    522: 	}
                    523:     }
                    524:     return $result;
                    525: }
                    526: 
                    527: sub end_ytics {
                    528:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                    529:     my $result = '';
1.51      matthew   530:     if ($target eq 'web' || $target eq 'tex') {
1.45      matthew   531:     } elsif ($target eq 'edit') {
                    532: 	$result.=&Apache::edit::tag_end($target,$token);
                    533:     }
                    534:     return $result;
                    535: }
                    536: 
                    537: 
1.1       matthew   538: ##----------------------------------------------------------------- key
                    539: sub start_key {
                    540:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                    541:     my $result='';
1.51      matthew   542:     if ($target eq 'web' || $target eq 'tex') {
1.17      matthew   543: 	&get_attributes(\%key,\%key_defaults,$parstack,$safeeval,
1.11      matthew   544: 		    $tagstack->[-1]);
1.20      matthew   545:     } elsif ($target eq 'edit') {
1.25      matthew   546: 	$result .= &Apache::edit::tag_start($target,$token,'Plot Key');
1.21      matthew   547: 	$result .= &edit_attributes($target,$token,\%key_defaults);
1.20      matthew   548:     } elsif ($target eq 'modified') {
                    549: 	my $constructtag=&Apache::edit::get_new_args
1.24      matthew   550: 	    ($token,$parstack,$safeeval,keys(%key_defaults));
1.20      matthew   551: 	if ($constructtag) {
                    552: 	    $result = &Apache::edit::rebuild_tag($token);
                    553: 	}
1.4       matthew   554:     }
1.1       matthew   555:     return $result;
                    556: }
                    557: 
                    558: sub end_key {
                    559:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                    560:     my $result = '';
1.51      matthew   561:     if ($target eq 'web' || $target eq 'tex') {
1.20      matthew   562:     } elsif ($target eq 'edit') {
1.21      matthew   563: 	$result.=&Apache::edit::tag_end($target,$token);
1.4       matthew   564:     }
1.1       matthew   565:     return $result;
                    566: }
1.21      matthew   567: 
1.1       matthew   568: ##------------------------------------------------------------------- title
                    569: sub start_title {
                    570:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                    571:     my $result='';
1.51      matthew   572:     if ($target eq 'web' || $target eq 'tex') {
1.17      matthew   573: 	$title = &Apache::lonxml::get_all_text("/title",$$parser[-1]);
1.49      matthew   574: 	$title =~ s/\n/ /g;
1.32      matthew   575: 	if (length($title) > $max_str_len) {
                    576: 	    $title = substr($title,0,$max_str_len);
                    577: 	}
1.20      matthew   578:     } elsif ($target eq 'edit') {
1.25      matthew   579: 	$result.=&Apache::edit::tag_start($target,$token,'Plot Title');
1.22      matthew   580: 	my $text=&Apache::lonxml::get_all_text("/title",$$parser[-1]);
1.39      matthew   581: 	$result.=&Apache::edit::end_row().
                    582: 	    &Apache::edit::start_spanning_row().
1.30      matthew   583: 	    &Apache::edit::editfield('',$text,'',60,1);
1.20      matthew   584:     } elsif ($target eq 'modified') {
1.29      matthew   585: 	my $text=$$parser[-1]->get_text("/title");
1.42      matthew   586: 	$result.=&Apache::edit::rebuild_tag($token);
1.21      matthew   587: 	$result.=&Apache::edit::modifiedfield($token);
1.4       matthew   588:     }
1.1       matthew   589:     return $result;
                    590: }
                    591: 
                    592: sub end_title {
                    593:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                    594:     my $result = '';
1.51      matthew   595:     if ($target eq 'web' || $target eq 'tex') {
1.20      matthew   596:     } elsif ($target eq 'edit') {
1.27      matthew   597: 	$result.=&Apache::edit::tag_end($target,$token);
1.4       matthew   598:     }
1.1       matthew   599:     return $result;
                    600: }
                    601: ##------------------------------------------------------------------- xlabel
                    602: sub start_xlabel {
                    603:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                    604:     my $result='';
1.51      matthew   605:     if ($target eq 'web' || $target eq 'tex') {
1.17      matthew   606: 	$xlabel = &Apache::lonxml::get_all_text("/xlabel",$$parser[-1]);
1.49      matthew   607: 	$xlabel =~ s/\n/ /g;
1.32      matthew   608: 	if (length($xlabel) > $max_str_len) {
                    609: 	    $xlabel = substr($xlabel,0,$max_str_len);
                    610: 	}
1.20      matthew   611:     } elsif ($target eq 'edit') {
1.25      matthew   612: 	$result.=&Apache::edit::tag_start($target,$token,'Plot Xlabel');
1.22      matthew   613: 	my $text=&Apache::lonxml::get_all_text("/xlabel",$$parser[-1]);
1.39      matthew   614: 	$result.=&Apache::edit::end_row().
                    615: 	    &Apache::edit::start_spanning_row().
1.30      matthew   616: 	    &Apache::edit::editfield('',$text,'',60,1);
1.20      matthew   617:     } elsif ($target eq 'modified') {
1.29      matthew   618: 	my $text=$$parser[-1]->get_text("/xlabel");
1.42      matthew   619: 	$result.=&Apache::edit::rebuild_tag($token);	
1.21      matthew   620: 	$result.=&Apache::edit::modifiedfield($token);
1.4       matthew   621:     }
1.1       matthew   622:     return $result;
                    623: }
                    624: 
                    625: sub end_xlabel {
                    626:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                    627:     my $result = '';
1.51      matthew   628:     if ($target eq 'web' || $target eq 'tex') {
1.20      matthew   629:     } elsif ($target eq 'edit') {
1.27      matthew   630: 	$result.=&Apache::edit::tag_end($target,$token);
1.4       matthew   631:     }
1.1       matthew   632:     return $result;
                    633: }
1.21      matthew   634: 
1.1       matthew   635: ##------------------------------------------------------------------- ylabel
                    636: sub start_ylabel {
                    637:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                    638:     my $result='';
1.51      matthew   639:     if ($target eq 'web' || $target eq 'tex') {
1.17      matthew   640: 	$ylabel = &Apache::lonxml::get_all_text("/ylabel",$$parser[-1]);
1.49      matthew   641: 	$ylabel =~ s/\n/ /g;
1.32      matthew   642: 	if (length($ylabel) > $max_str_len) {
                    643: 	    $ylabel = substr($ylabel,0,$max_str_len);
                    644: 	}
1.20      matthew   645:     } elsif ($target eq 'edit') {
1.25      matthew   646: 	$result .= &Apache::edit::tag_start($target,$token,'Plot Ylabel');
1.22      matthew   647: 	my $text = &Apache::lonxml::get_all_text("/ylabel",$$parser[-1]);
1.39      matthew   648: 	$result .= &Apache::edit::end_row().
                    649: 	    &Apache::edit::start_spanning_row().
1.30      matthew   650: 	    &Apache::edit::editfield('',$text,'',60,1);
1.20      matthew   651:     } elsif ($target eq 'modified') {
1.29      matthew   652: 	my $text=$$parser[-1]->get_text("/ylabel");
1.42      matthew   653: 	$result.=&Apache::edit::rebuild_tag($token);
1.21      matthew   654: 	$result.=&Apache::edit::modifiedfield($token);
1.4       matthew   655:     }
1.1       matthew   656:     return $result;
                    657: }
                    658: 
                    659: sub end_ylabel {
                    660:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                    661:     my $result = '';
1.51      matthew   662:     if ($target eq 'web' || $target eq 'tex') {
1.20      matthew   663:     } elsif ($target eq 'edit') {
1.27      matthew   664: 	$result.=&Apache::edit::tag_end($target,$token);
1.4       matthew   665:     }
1.1       matthew   666:     return $result;
                    667: }
1.21      matthew   668: 
1.1       matthew   669: ##------------------------------------------------------------------- label
                    670: sub start_label {
                    671:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                    672:     my $result='';
1.51      matthew   673:     if ($target eq 'web' || $target eq 'tex') {
1.17      matthew   674: 	my %label;
                    675: 	&get_attributes(\%label,\%label_defaults,$parstack,$safeeval,
1.11      matthew   676: 		    $tagstack->[-1]);
1.32      matthew   677: 	my $text = &Apache::lonxml::get_all_text("/label",$$parser[-1]);
1.49      matthew   678: 	$text =~ s/\n/ /g;
1.32      matthew   679: 	$text = substr($text,0,$max_str_len) if (length($text) > $max_str_len);
                    680: 	$label{'text'} = $text;
1.17      matthew   681: 	push(@labels,\%label);
1.20      matthew   682:     } elsif ($target eq 'edit') {
1.25      matthew   683: 	$result .= &Apache::edit::tag_start($target,$token,'Plot Label');
1.21      matthew   684: 	$result .= &edit_attributes($target,$token,\%label_defaults);
1.22      matthew   685: 	my $text = &Apache::lonxml::get_all_text("/label",$$parser[-1]);
1.39      matthew   686: 	$result .= &Apache::edit::end_row().
                    687: 	    &Apache::edit::start_spanning_row().
1.30      matthew   688: 	    &Apache::edit::editfield('',$text,'',60,1);
1.20      matthew   689:     } elsif ($target eq 'modified') {
1.42      matthew   690: 	&Apache::edit::get_new_args
1.24      matthew   691: 	    ($token,$parstack,$safeeval,keys(%label_defaults));
1.42      matthew   692: 	$result.=&Apache::edit::rebuild_tag($token);
1.22      matthew   693: 	my $text=$$parser[-1]->get_text("/label");
1.21      matthew   694: 	$result.=&Apache::edit::modifiedfield($token);
1.4       matthew   695:     }
1.1       matthew   696:     return $result;
                    697: }
                    698: 
                    699: sub end_label {
                    700:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                    701:     my $result = '';
1.51      matthew   702:     if ($target eq 'web' || $target eq 'tex') {
1.20      matthew   703:     } elsif ($target eq 'edit') {
1.21      matthew   704: 	$result.=&Apache::edit::tag_end($target,$token);
1.4       matthew   705:     }
1.1       matthew   706:     return $result;
                    707: }
                    708: 
                    709: ##------------------------------------------------------------------- curve
                    710: sub start_curve {
                    711:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                    712:     my $result='';
1.25      matthew   713:     &Apache::lonxml::register('Apache::lonplot',('function','data'));
                    714:     push (@Apache::lonxml::namespace,'curve');
1.51      matthew   715:     if ($target eq 'web' || $target eq 'tex') {
1.17      matthew   716: 	my %curve;
                    717: 	&get_attributes(\%curve,\%curve_defaults,$parstack,$safeeval,
1.11      matthew   718: 		    $tagstack->[-1]);
1.17      matthew   719: 	push (@curves,\%curve);
1.20      matthew   720:     } elsif ($target eq 'edit') {
1.26      matthew   721: 	$result .= &Apache::edit::tag_start($target,$token,'Curve');
1.48      matthew   722: 	$result .= &help_win($curve_help_text);
1.21      matthew   723: 	$result .= &edit_attributes($target,$token,\%curve_defaults);
1.20      matthew   724:     } elsif ($target eq 'modified') {
                    725: 	my $constructtag=&Apache::edit::get_new_args
1.35      matthew   726: 	    ($token,$parstack,$safeeval,keys(%curve_defaults));
1.20      matthew   727: 	if ($constructtag) {
                    728: 	    $result = &Apache::edit::rebuild_tag($token);
                    729: 	    $result.= &Apache::edit::handle_insert();
                    730: 	}
1.4       matthew   731:     }
1.1       matthew   732:     return $result;
                    733: }
                    734: 
                    735: sub end_curve {
                    736:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                    737:     my $result = '';
1.25      matthew   738:     pop @Apache::lonxml::namespace;
                    739:     &Apache::lonxml::deregister('Apache::lonplot',('function','data'));
1.51      matthew   740:     if ($target eq 'web' || $target eq 'tex') {
1.20      matthew   741:     } elsif ($target eq 'edit') {
1.21      matthew   742: 	$result.=&Apache::edit::tag_end($target,$token);
1.4       matthew   743:     }
1.1       matthew   744:     return $result;
                    745: }
1.21      matthew   746: 
1.1       matthew   747: ##------------------------------------------------------------ curve function
                    748: sub start_function {
                    749:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                    750:     my $result='';
1.51      matthew   751:     if ($target eq 'web' || $target eq 'tex') {
1.17      matthew   752: 	if (exists($curves[-1]->{'data'})) {
                    753: 	    &Apache::lonxml::warning('Use of <function> precludes use of <data>.  The <data> will be omitted in favor of the <function> declaration.');
                    754: 	    delete $curves[-1]->{'data'} ;
                    755: 	}
                    756: 	$curves[-1]->{'function'} = 
                    757: 	    &Apache::lonxml::get_all_text("/function",$$parser[-1]);
1.20      matthew   758:     } elsif ($target eq 'edit') {
1.37      matthew   759: 	$result .= &Apache::edit::tag_start($target,$token,'Gnuplot compatible curve function');
1.22      matthew   760: 	my $text = &Apache::lonxml::get_all_text("/function",$$parser[-1]);
1.39      matthew   761: 	$result .= &Apache::edit::end_row().
                    762: 	    &Apache::edit::start_spanning_row().
1.30      matthew   763: 	    &Apache::edit::editfield('',$text,'',60,1);
1.20      matthew   764:     } elsif ($target eq 'modified') {
1.42      matthew   765: 	$result.=&Apache::edit::rebuild_tag($token);
1.20      matthew   766: 	my $text=$$parser[-1]->get_text("/function");
                    767: 	$result.=&Apache::edit::modifiedfield($token);
1.4       matthew   768:     }
1.1       matthew   769:     return $result;
                    770: }
                    771: 
                    772: sub end_function {
                    773:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                    774:     my $result = '';
1.51      matthew   775:     if ($target eq 'web' || $target eq 'tex') {
1.20      matthew   776:     } elsif ($target eq 'edit') {
1.26      matthew   777: 	$result .= &Apache::edit::end_table();
1.4       matthew   778:     }
1.1       matthew   779:     return $result;
                    780: }
1.21      matthew   781: 
1.1       matthew   782: ##------------------------------------------------------------ curve  data
                    783: sub start_data {
                    784:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                    785:     my $result='';
1.51      matthew   786:     if ($target eq 'web' || $target eq 'tex') {
1.17      matthew   787: 	if (exists($curves[-1]->{'function'})) {
                    788: 	    &Apache::lonxml::warning('Use of <data> precludes use of .'.
                    789: 	    '<function>.  The <function> will be omitted in favor of '.
                    790:             'the <data> declaration.');
                    791: 	    delete($curves[-1]->{'function'});
                    792: 	}
                    793: 	my $datatext = &Apache::lonxml::get_all_text("/data",$$parser[-1]);
1.40      matthew   794: 	# Deal with cases where we're given an array...
                    795: 	if ($datatext =~ /^\@/) {
                    796: 	    $datatext = &Apache::run::run('return "'.$datatext.'"',
                    797: 					  $safeeval,1);
                    798: 	}
1.49      matthew   799: 	$datatext =~ s/\s+/ /g;
1.17      matthew   800: 	# Need to do some error checking on the @data array - 
                    801: 	# make sure it's all numbers and make sure each array 
                    802: 	# is of the same length.
                    803: 	my @data;
1.35      matthew   804: 	if ($datatext =~ /,/) { # comma deliminated
1.17      matthew   805: 	    @data = split /,/,$datatext;
                    806: 	} else { # Assume it's space seperated.
                    807: 	    @data = split / /,$datatext;
                    808: 	}
                    809: 	for (my $i=0;$i<=$#data;$i++) {
                    810: 	    # Check that it's non-empty
1.19      matthew   811: 	    if (! defined($data[$i])) {
                    812: 		&Apache::lonxml::warning(
                    813: 		    'undefined <data> value.  Replacing with '.
                    814: 		    ' pi/e = 1.15572734979092');
                    815: 		$data[$i] = 1.15572734979092;
                    816: 	    }
1.17      matthew   817: 	    # Check that it's a number
1.19      matthew   818: 	    if (! &$real_test($data[$i]) & ! &$int_test($data[$i])) {
                    819: 		&Apache::lonxml::warning(
                    820: 		    'Bad <data> value of '.$data[$i].'  Replacing with '.
                    821: 		    ' pi/e = 1.15572734979092');
                    822: 		$data[$i] = 1.15572734979092;
                    823: 	    }
1.17      matthew   824: 	}
1.35      matthew   825: 	# complain if the number of data points is not the same as
                    826: 	# in previous sets of data.
1.36      matthew   827: 	if (($curves[-1]->{'data'}) && ($#data != $#{@{$curves[-1]->{'data'}->[0]}})){
1.35      matthew   828: 	    &Apache::lonxml::warning
                    829: 		('Number of data points is not consistent with previous '.
                    830: 		 'number of data points');
                    831: 	}
1.17      matthew   832: 	push  @{$curves[-1]->{'data'}},\@data;
1.20      matthew   833:     } elsif ($target eq 'edit') {
1.37      matthew   834: 	$result .= &Apache::edit::tag_start($target,$token,'Comma or space deliminated curve data');
1.22      matthew   835: 	my $text = &Apache::lonxml::get_all_text("/data",$$parser[-1]);
1.39      matthew   836: 	$result .= &Apache::edit::end_row().
                    837: 	    &Apache::edit::start_spanning_row().
1.30      matthew   838: 	    &Apache::edit::editfield('',$text,'',60,1);
1.20      matthew   839:     } elsif ($target eq 'modified') {
1.42      matthew   840: 	$result.=&Apache::edit::rebuild_tag($token);
1.21      matthew   841: 	my $text=$$parser[-1]->get_text("/data");
                    842: 	$result.=&Apache::edit::modifiedfield($token);
1.4       matthew   843:     }
1.1       matthew   844:     return $result;
                    845: }
                    846: 
                    847: sub end_data {
                    848:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                    849:     my $result = '';
1.51      matthew   850:     if ($target eq 'web' || $target eq 'tex') {
1.20      matthew   851:     } elsif ($target eq 'edit') {
1.26      matthew   852: 	$result .= &Apache::edit::end_table();
1.4       matthew   853:     }
1.1       matthew   854:     return $result;
                    855: }
                    856: 
                    857: ##------------------------------------------------------------------- axis
                    858: sub start_axis {
                    859:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                    860:     my $result='';
1.51      matthew   861:     if ($target eq 'web' || $target eq 'tex') {
1.17      matthew   862: 	&get_attributes(\%axis,\%axis_defaults,$parstack,$safeeval,
                    863: 			$tagstack->[-1]);
1.20      matthew   864:     } elsif ($target eq 'edit') {
1.25      matthew   865: 	$result .= &Apache::edit::tag_start($target,$token,'Plot Axes');
1.21      matthew   866: 	$result .= &edit_attributes($target,$token,\%axis_defaults);
1.20      matthew   867:     } elsif ($target eq 'modified') {
1.29      matthew   868: 	my $constructtag=&Apache::edit::get_new_args
                    869: 	    ($token,$parstack,$safeeval,keys(%axis_defaults));
                    870: 	if ($constructtag) {
                    871: 	    $result = &Apache::edit::rebuild_tag($token);
                    872: 	}
1.4       matthew   873:     }
1.1       matthew   874:     return $result;
                    875: }
                    876: 
                    877: sub end_axis {
                    878:     my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
                    879:     my $result = '';
1.51      matthew   880:     if ($target eq 'web' || $target eq 'tex') {
1.20      matthew   881:     } elsif ($target eq 'edit') {
1.21      matthew   882: 	$result.=&Apache::edit::tag_end($target,$token);
1.20      matthew   883:     } elsif ($target eq 'modified') {
1.4       matthew   884:     }
1.1       matthew   885:     return $result;
                    886: }
                    887: 
1.21      matthew   888: ###################################################################
                    889: ##                                                               ##
                    890: ##        Utility Functions                                      ##
                    891: ##                                                               ##
                    892: ###################################################################
                    893: 
1.13      matthew   894: ##----------------------------------------------------------- set_defaults
                    895: sub set_defaults {
1.21      matthew   896:     my ($var,$defaults) = @_;
1.13      matthew   897:     my $key;
1.24      matthew   898:     foreach $key (keys(%$defaults)) {
1.13      matthew   899: 	$var->{$key} = $defaults->{$key}->{'default'};
                    900:     }
                    901: }
                    902: 
1.1       matthew   903: ##------------------------------------------------------------------- misc
1.2       matthew   904: sub get_attributes{
1.21      matthew   905:     my ($values,$defaults,$parstack,$safeeval,$tag) = @_;
1.24      matthew   906:     foreach my $attr (keys(%{$defaults})) {
1.10      matthew   907: 	$values->{$attr} = 
1.15      matthew   908: 	    &Apache::lonxml::get_param($attr,$parstack,$safeeval);
1.10      matthew   909: 	if ($values->{$attr} eq '' | !defined($values->{$attr})) {
1.11      matthew   910: 	    $values->{$attr} = $defaults->{$attr}->{'default'};
1.6       matthew   911: 	    next;
                    912: 	}
1.10      matthew   913: 	my $test = $defaults->{$attr}->{'test'};
                    914: 	if (! &$test($values->{$attr})) {
1.6       matthew   915: 	    &Apache::lonxml::warning
                    916: 		($tag.':'.$attr.': Bad value.'.'Replacing your value with : '
1.11      matthew   917: 		 .$defaults->{$attr}->{'default'} );
                    918: 	    $values->{$attr} = $defaults->{$attr}->{'default'};
1.10      matthew   919: 	}
1.2       matthew   920:     }
1.11      matthew   921:     return ;
1.6       matthew   922: }
1.40      matthew   923: 
1.15      matthew   924: ##------------------------------------------------------- write_gnuplot_file
1.6       matthew   925: sub write_gnuplot_file {
1.51      matthew   926:     my ($tmpdir,$filename,$target)= @_;
1.6       matthew   927:     my $gnuplot_input = '';
1.10      matthew   928:     my $curve;
1.6       matthew   929:     # Collect all the colors
                    930:     my @Colors;
                    931:     push @Colors, $plot{'bgcolor'};
                    932:     push @Colors, $plot{'fgcolor'}; 
1.13      matthew   933:     push @Colors, (defined($axis{'color'})?$axis{'color'}:$plot{'fgcolor'});
1.9       matthew   934:     foreach $curve (@curves) {
                    935: 	push @Colors, ($curve->{'color'} ne '' ? 
                    936: 		       $curve->{'color'}       : 
1.13      matthew   937: 		       $plot{'fgcolor'}        );
1.6       matthew   938:     }
                    939:     # set term
1.51      matthew   940:     if ($target eq 'web') {
                    941: 	$gnuplot_input .= 'set term gif ';
                    942: 	$gnuplot_input .= 'transparent ' if ($plot{'transparent'} eq 'on');
                    943: 	$gnuplot_input .= $plot{'font'} . ' ';
                    944: 	$gnuplot_input .= 'size '.$plot{'width'}.','.$plot{'height'}.' ';
                    945: 	$gnuplot_input .= "@Colors\n";
                    946: 	# set output
                    947: 	$gnuplot_input .= "set output\n";
                    948:     } elsif ($target eq 'tex') {
                    949: 	$gnuplot_input .= "set term postscript eps monochrome\n";
                    950: 	$gnuplot_input .= "set output \"$filename.eps\"\n";
                    951:     }
1.7       matthew   952:     # grid
1.10      matthew   953:     $gnuplot_input .= 'set grid'.$/ if ($plot{'grid'} eq 'on');
1.7       matthew   954:     # border
1.9       matthew   955:     $gnuplot_input .= ($plot{'border'} eq 'on'?
                    956: 		       'set border'.$/           :
                    957: 		       'set noborder'.$/         );    # title, xlabel, ylabel
1.45      matthew   958:     # titles
1.13      matthew   959:     $gnuplot_input .= "set title  \"$title\"\n"  if (defined($title)) ;
                    960:     $gnuplot_input .= "set xlabel \"$xlabel\"\n" if (defined($xlabel));
                    961:     $gnuplot_input .= "set ylabel \"$ylabel\"\n" if (defined($ylabel));
1.45      matthew   962:     # tics
                    963:     if (%xtics) {    
                    964: 	$gnuplot_input .= "set xtics $xtics{'location'} ";
1.46      matthew   965: 	$gnuplot_input .= ( $xtics{'mirror'} eq 'on'?"mirror ":"nomirror ");
1.45      matthew   966: 	$gnuplot_input .= "$xtics{'start'}, ";
                    967: 	$gnuplot_input .= "$xtics{'increment'}, ";
                    968: 	$gnuplot_input .= "$xtics{'end'}\n";
                    969:     }
                    970:     if (%ytics) {    
                    971: 	$gnuplot_input .= "set ytics $ytics{'location'} ";
1.46      matthew   972: 	$gnuplot_input .= ( $ytics{'mirror'} eq 'on'?"mirror ":"nomirror ");
1.45      matthew   973: 	$gnuplot_input .= "$ytics{'start'}, ";
                    974: 	$gnuplot_input .= "$ytics{'increment'}, ";
                    975:         $gnuplot_input .= "$ytics{'end'}\n";
                    976:     }
                    977:     # axis
1.23      matthew   978:     if (%axis) {
1.13      matthew   979: 	$gnuplot_input .= "set xrange \[$axis{'xmin'}:$axis{'xmax'}\]\n";
                    980: 	$gnuplot_input .= "set yrange \[$axis{'ymin'}:$axis{'ymax'}\]\n";
1.6       matthew   981:     }
                    982:     # Key
1.23      matthew   983:     if (%key) {
1.9       matthew   984: 	$gnuplot_input .= 'set key '.$key{'pos'}.' ';
                    985: 	if ($key{'title'} ne '') {
1.43      matthew   986: 	    $gnuplot_input .= 'title " '.$key{'title'}.'" ';
1.11      matthew   987: 	} 
                    988: 	$gnuplot_input .= ($key{'box'} eq 'on' ? 'box ' : 'nobox ').$/;
1.6       matthew   989:     } else {
1.9       matthew   990: 	$gnuplot_input .= 'set nokey'.$/;
1.13      matthew   991:     }
1.6       matthew   992:     # labels
1.10      matthew   993:     my $label;
1.6       matthew   994:     foreach $label (@labels) {
                    995: 	$gnuplot_input .= 'set label "'.$label->{'text'}.'" at '.
1.9       matthew   996: 	    $label->{'xpos'}.','.$label->{'ypos'}.' '.$label->{'justify'}.$/ ;
1.6       matthew   997:     }
                    998:     # curves
                    999:     $gnuplot_input .= 'plot ';
1.9       matthew  1000:     for (my $i = 0;$i<=$#curves;$i++) {
                   1001: 	$curve = $curves[$i];
                   1002: 	$gnuplot_input.= ', ' if ($i > 0);
1.6       matthew  1003: 	if (exists($curve->{'function'})) {
1.9       matthew  1004: 	    $gnuplot_input.= 
                   1005: 		$curve->{'function'}.' title "'.
                   1006: 		$curve->{'name'}.'" with '.
                   1007: 		$curve->{'linestyle'};
1.6       matthew  1008: 	} elsif (exists($curve->{'data'})) {
1.40      matthew  1009: 	    # Store data values in $datatext
                   1010: 	    my $datatext = '';
                   1011: 	    #   get new filename
                   1012: 	    my $datafilename = "$tmpdir/$filename.$i";
                   1013: 	    my $fh=Apache::File->new(">$datafilename");
                   1014: 	    # Compile data
1.6       matthew  1015: 	    my @Data = @{$curve->{'data'}};
1.9       matthew  1016: 	    my @Data0 = @{$Data[0]};
                   1017: 	    for (my $i =0; $i<=$#Data0; $i++) {
1.10      matthew  1018: 		my $dataset;
1.6       matthew  1019: 		foreach $dataset (@Data) {
1.9       matthew  1020: 		    $datatext .= $dataset->[$i] . ' ';
1.6       matthew  1021: 		}
1.9       matthew  1022: 		$datatext .= $/;
1.6       matthew  1023: 	    }
1.40      matthew  1024: 	    #   write file
                   1025: 	    print $fh $datatext;
                   1026: 	    close ($fh);
                   1027: 	    #   generate gnuplot text
                   1028: 	    $gnuplot_input.= '"'.$datafilename.'" title "'.
                   1029: 		$curve->{'name'}.'" with '.
                   1030: 		$curve->{'linestyle'};
1.6       matthew  1031: 	}
                   1032:     }
1.40      matthew  1033:     # Write the output to a file.
                   1034:     my $fh=Apache::File->new(">$tmpdir$filename");
                   1035:     print $fh $gnuplot_input;
                   1036:     close($fh);
                   1037:     # That's all folks.
                   1038:     return ;
1.2       matthew  1039: }
1.21      matthew  1040: 
                   1041: #---------------------------------------------- check_inputs
                   1042: sub check_inputs {
                   1043:     ## Note: no inputs, no outputs - this acts only on global variables.
                   1044:     ## Make sure we have all the input we need:
1.47      matthew  1045:     if (! %plot) { &set_defaults(\%plot,\%gnuplot_defaults); }
1.23      matthew  1046:     if (! %key ) {} # No key for this plot, thats okay
1.34      matthew  1047: #    if (! %axis) { &set_defaults(\%axis,\%axis_defaults); }
1.21      matthew  1048:     if (! defined($title )) {} # No title for this plot, thats okay
                   1049:     if (! defined($xlabel)) {} # No xlabel for this plot, thats okay
                   1050:     if (! defined($ylabel)) {} # No ylabel for this plot, thats okay
                   1051:     if ($#labels < 0) { }      # No labels for this plot, thats okay
                   1052:     if ($#curves < 0) { 
                   1053: 	&Apache::lonxml::warning("No curves specified for plot!!!!");
                   1054: 	return '';
                   1055:     }
                   1056:     my $curve;
                   1057:     foreach $curve (@curves) {
                   1058: 	if (!defined($curve->{'function'})&&!defined($curve->{'data'})){
                   1059: 	    &Apache::lonxml::warning("One of the curves specified did not contain any <data> or <function> declarations\n");
                   1060: 	    return '';
                   1061: 	}
                   1062:     }
                   1063: }
                   1064: 
1.20      matthew  1065: #------------------------------------------------ make_edit
                   1066: sub edit_attributes {
1.34      matthew  1067:     my ($target,$token,$defaults,$keys) = @_;
                   1068:     my ($result,@keys);
                   1069:     if ($keys && ref($keys) eq 'ARRAY') {
                   1070:         @keys = @$keys;
                   1071:     } else {
                   1072: 	@keys = sort(keys(%$defaults));
                   1073:     }
                   1074:     foreach my $attr (@keys) {
1.35      matthew  1075: 	# append a ' ' to the description if it doesn't have one already.
                   1076: 	my $description = $defaults->{$attr}->{'description'};
                   1077: 	$description .= ' ' if ($description !~ / $/);
1.20      matthew  1078: 	if ($defaults->{$attr}->{'edit_type'} eq 'entry') {
1.35      matthew  1079: 	    $result .= &Apache::edit::text_arg
1.38      matthew  1080: 		($description,$attr,$token,
                   1081: 		 $defaults->{$attr}->{'size'});
1.20      matthew  1082: 	} elsif ($defaults->{$attr}->{'edit_type'} eq 'choice') {
1.35      matthew  1083: 	    $result .= &Apache::edit::select_arg
                   1084: 		($description,$attr,$defaults->{$attr}->{'choices'},$token);
1.45      matthew  1085: 	} elsif ($defaults->{$attr}->{'edit_type'} eq 'onoff') {
1.35      matthew  1086: 	    $result .= &Apache::edit::select_arg
                   1087: 		($description,$attr,['on','off'],$token);
1.20      matthew  1088: 	}
1.25      matthew  1089: 	$result .= '<br />';
1.20      matthew  1090:     }
                   1091:     return $result;
                   1092: }
1.1       matthew  1093: 
1.21      matthew  1094: 
                   1095: ###################################################################
                   1096: ##                                                               ##
                   1097: ##           Insertion functions for editing plots               ##
                   1098: ##                                                               ##
                   1099: ###################################################################
                   1100: 
1.47      matthew  1101: sub insert_gnuplot {
1.29      matthew  1102:     my $result = '';
1.20      matthew  1103:     #  plot attributes
1.50      matthew  1104:     $result .= "<gnuplot \n";
1.47      matthew  1105:     foreach my $attr (keys(%gnuplot_defaults)) {
                   1106: 	$result .= "     $attr=\"$gnuplot_defaults{$attr}->{'default'}\"\n";
1.20      matthew  1107:     }
                   1108:     $result .= ">\n";
1.47      matthew  1109:     # Add the components (most are commented out for simplicity)
1.44      matthew  1110:     # $result .= &insert_key();
                   1111:     # $result .= &insert_axis();
                   1112:     # $result .= &insert_title();    
                   1113:     # $result .= &insert_xlabel();    
                   1114:     # $result .= &insert_ylabel();    
1.20      matthew  1115:     $result .= &insert_curve();
1.50      matthew  1116:     # close up the <gnuplot>
                   1117:     $result .= "</gnuplot>\n";
1.45      matthew  1118:     return $result;
                   1119: }
                   1120: 
1.46      matthew  1121: sub insert_tics {
                   1122:     my $result;
                   1123:     $result .= &insert_xtics() . &insert_ytics;
                   1124:     return $result;
                   1125: }
                   1126: 
1.45      matthew  1127: sub insert_xtics {
                   1128:     my $result;
1.46      matthew  1129:     $result .= "\n    <xtics ";
1.45      matthew  1130:     foreach my $attr (keys(%tic_defaults)) {
1.46      matthew  1131: 	$result .= "$attr=\"$tic_defaults{$attr}->{'default'}\" ";
1.45      matthew  1132:     }
1.46      matthew  1133:     $result .= "/>\n";
1.45      matthew  1134:     return $result;
                   1135: }
                   1136: 
                   1137: sub insert_ytics {
                   1138:     my $result;
1.46      matthew  1139:     $result .= "\n    <ytics ";
1.45      matthew  1140:     foreach my $attr (keys(%tic_defaults)) {
1.46      matthew  1141: 	$result .= "$attr=\"$tic_defaults{$attr}->{'default'}\" ";
1.45      matthew  1142:     }
1.46      matthew  1143:     $result .= "/>\n";
1.20      matthew  1144:     return $result;
                   1145: }
                   1146: 
                   1147: sub insert_key {
                   1148:     my $result;
1.46      matthew  1149:     $result .= "\n    <key \n";
1.30      matthew  1150:     foreach my $attr (keys(%key_defaults)) {
1.29      matthew  1151: 	$result .= "         $attr=\"$key_defaults{$attr}->{'default'}\"\n";
1.20      matthew  1152:     }
                   1153:     $result .= "   />\n";
                   1154:     return $result;
                   1155: }
                   1156: 
                   1157: sub insert_axis{
                   1158:     my $result;
1.46      matthew  1159:     $result .= "\n    <axis ";
1.30      matthew  1160:    foreach my $attr (keys(%axis_defaults)) {
1.29      matthew  1161: 	$result .= "         $attr=\"$axis_defaults{$attr}->{'default'}\"\n";
1.20      matthew  1162:     }
                   1163:     $result .= "   />\n";
                   1164:     return $result;
                   1165: }
1.28      matthew  1166: 
1.46      matthew  1167: sub insert_title { return "\n    <title></title>\n"; }
                   1168: sub insert_xlabel { return "\n    <xlabel></xlabel>\n"; }
                   1169: sub insert_ylabel { return "\n    <ylabel></ylabel>\n"; }
1.20      matthew  1170: 
                   1171: sub insert_label {
                   1172:     my $result;
1.46      matthew  1173:     $result .= "\n    <label ";
1.30      matthew  1174:     foreach my $attr (keys(%label_defaults)) {
1.27      matthew  1175: 	$result .= '         '.$attr.'="'.
1.20      matthew  1176: 	    $label_defaults{$attr}->{'default'}."\"\n";
                   1177:     }
                   1178:     $result .= "   ></label>\n";
                   1179:     return $result;
                   1180: }
                   1181: 
                   1182: sub insert_curve {
                   1183:     my $result;
1.41      matthew  1184:     $result .= "\n    <curve ";
1.30      matthew  1185:     foreach my $attr (keys(%curve_defaults)) {
1.27      matthew  1186: 	$result .= '         '.$attr.'="'.
1.20      matthew  1187: 	    $curve_defaults{$attr}->{'default'}."\"\n";
                   1188:     }
1.41      matthew  1189:     $result .= "    >\n";
                   1190:     $result .= &insert_data().&insert_data()."</curve>\n";
1.20      matthew  1191: }
1.4       matthew  1192: 
1.20      matthew  1193: sub insert_function {
                   1194:     my $result;
                   1195:     $result .= "<function></function>\n";
                   1196:     return $result;
                   1197: }
1.4       matthew  1198: 
1.20      matthew  1199: sub insert_data {
                   1200:     my $result;
                   1201:     $result .= "     <data></data>\n";
                   1202:     return $result;
                   1203: }
1.4       matthew  1204: 
1.48      matthew  1205: ##----------------------------------------------------------------------
                   1206: # Javascript functions to display help for tags
                   1207: 
                   1208: sub make_javascript {
                   1209:     my $helpwindowwidth  = 400;
                   1210:     my $helpwindowheight = 400;
                   1211:     my $result = '';
                   1212:     $result.=<<"ENDFUNCTION";
                   1213: <script language="JavaScript">
                   1214: function openWin(text)
                   1215: {
                   1216:   newWin = open("", "new_W", "width=$helpwindowwidth,height=$helpwindowheight,resizable=1,scrollbars=1");
                   1217:   newWin.document.open("text/html", "replace");
                   1218:   newWin.document.writeln(text);
                   1219:   newWin.document.writeln('<center><a href=\"javascript:window.close()\">close this window</a></center>');
                   1220:   newWin.document.close();
                   1221: }
                   1222: </script>
                   1223: ENDFUNCTION
                   1224:     return $result;
                   1225: }
                   1226: 
                   1227: sub help_win {
                   1228:     my ($helptext)=@_;
                   1229:     $helptext =~ s/\n/ /g;
                   1230:     $helptext =~ s/\'/\\\'/g;
                   1231:     my $result = '';
                   1232:     $result.=<<"ENDWIN";
                   1233: <table width="100%"><tr><td align="right">
                   1234: <a href="javascript:openWin('$helptext')">help</a>
                   1235: </td></tr></table><hr />
                   1236: ENDWIN
                   1237:     return $result;
                   1238: }
1.21      matthew  1239: ##----------------------------------------------------------------------
1.20      matthew  1240: 1;
                   1241: __END__
1.4       matthew  1242: 
                   1243: 

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