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

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

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