Annotation of loncom/xml/lonplot.pm, revision 1.38
1.1 matthew 1: # The LearningOnline Network with CAPA
2: # Dynamic plot
3: #
1.38 ! matthew 4: # $Id: lonplot.pm,v 1.37 2002/01/10 16:29:54 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
32:
33: # Current issues
34: # 1. Gnuplot is unable to vary the color or linestyle of <data> plots.
35: # The key does not know this so it is misleading for the user.
36: # Multiple <function>s can be plotted with varying line styles and
37: # colors.
38: #
1.1 matthew 39: package Apache::lonplot;
1.10 matthew 40:
1.1 matthew 41: use strict;
1.10 matthew 42: use Apache::File;
1.1 matthew 43: use Apache::response;
1.2 matthew 44: use Apache::lonxml;
1.20 matthew 45: use Apache::edit;
1.10 matthew 46:
1.33 harris41 47: BEGIN {
1.1 matthew 48: &Apache::lonxml::register('Apache::lonplot',('plot'));
49: }
50:
1.10 matthew 51: ##
52: ## Description of data structures:
53: ##
54: ## %plot %key %axis
55: ## --------------------------
56: ## height title color
57: ## width box xmin
58: ## bgcolor pos xmax
59: ## fgcolor ymin
60: ## transparent ymax
61: ## grid
62: ## border
63: ## font
1.19 matthew 64: ## align
1.10 matthew 65: ##
66: ## @labels: $labels[$i] = \%label
67: ## %label: text, xpos, ypos, justify
1.14 matthew 68: ##
1.10 matthew 69: ## @curves: $curves[$i] = \%curve
1.14 matthew 70: ## %curve: name, linestyle, ( function | data )
1.10 matthew 71: ##
72: ## $curves[$i]->{'data'} = [ [x1,x2,x3,x4],
73: ## [y1,y2,y3,y4] ]
74: ##
1.21 matthew 75:
76: ###################################################################
77: ## ##
78: ## Tests used in checking the validitity of input ##
79: ## ##
80: ###################################################################
1.29 matthew 81:
1.32 matthew 82: my $max_str_len = 50; # if a label, title, xlabel, or ylabel text
83: # is longer than this, it will be truncated.
84:
1.29 matthew 85: my %linestyles =
86: (
87: lines => 2, # Maybe this will be used in the future
88: linespoints => 2, # to check on whether or not they have
89: dots => 2, # supplied enough <data></data> fields
90: points => 2, # to use the given line style. But for
91: steps => 2, # now there are more important things
92: fsteps => 2, # for me to deal with.
93: histeps => 2,
1.34 matthew 94: errorbars => 3,
95: xerrorbars => [3,4],
96: yerrorbars => [3,4],
1.35 matthew 97: xyerrorbars => [4,6],
1.34 matthew 98: boxes => 3,
1.35 matthew 99: # boxerrorbars => [3,4,5],
100: # boxxyerrorbars => [4,6,7],
101: # financebars => 5,
102: # candlesticks => 5,
103: vector => 4
1.29 matthew 104: );
105:
1.11 matthew 106: my $int_test = sub {$_[0]=~s/\s+//g;$_[0]=~/^\d+$/};
1.19 matthew 107: my $real_test =
108: sub {$_[0]=~s/\s+//g;$_[0]=~/^[+-]?\d*\.?\d*([eE][+-]\d+)?$/};
1.11 matthew 109: my $color_test = sub {$_[0]=~s/\s+//g;$_[0]=~/^x[\da-f]{6}$/};
1.1 matthew 110: my $onoff_test = sub {$_[0]=~/^(on|off)$/};
1.15 matthew 111: my $key_pos_test = sub {$_[0]=~/^(top|bottom|right|left|outside|below| )+$/};
1.1 matthew 112: my $sml_test = sub {$_[0]=~/^(small|medium|large)$/};
1.29 matthew 113: my $linestyle_test = sub {exists($linestyles{$_[0]})};
1.15 matthew 114: my $words_test = sub {$_[0]=~s/\s+/ /g;$_[0]=~/^([\w\(\)]+ ?)+$/};
1.21 matthew 115:
116: ###################################################################
117: ## ##
118: ## Attribute metadata ##
119: ## ##
120: ###################################################################
1.34 matthew 121: my @plot_edit_order =
1.37 matthew 122: qw/bgcolor fgcolor height width font transparent grid border align/;
1.1 matthew 123: my %plot_defaults =
124: (
1.20 matthew 125: height => {
126: default => 200,
127: test => $int_test,
1.29 matthew 128: description => 'height of image (pixels)',
1.38 ! matthew 129: edit_type => 'entry',
! 130: size => '10'
1.20 matthew 131: },
132: width => {
133: default => 200,
134: test => $int_test,
1.29 matthew 135: description => 'width of image (pixels)',
1.38 ! matthew 136: edit_type => 'entry',
! 137: size => '10'
1.20 matthew 138: },
139: bgcolor => {
140: default => 'xffffff',
141: test => $color_test,
142: description => 'background color of image (xffffff)',
1.38 ! matthew 143: edit_type => 'entry',
! 144: size => '10'
1.20 matthew 145: },
146: fgcolor => {
147: default => 'x000000',
148: test => $color_test,
149: description => 'foreground color of image (x000000)',
1.38 ! matthew 150: edit_type => 'entry',
! 151: size => '10'
1.20 matthew 152: },
153: transparent => {
154: default => 'off',
155: test => $onoff_test,
1.34 matthew 156: description => 'Transparent image',
1.20 matthew 157: edit_type => 'on_off'
158: },
159: grid => {
160: default => 'off',
161: test => $onoff_test,
1.34 matthew 162: description => 'Display grid',
1.20 matthew 163: edit_type => 'on_off'
164: },
165: border => {
166: default => 'on',
167: test => $onoff_test,
1.34 matthew 168: description => 'Draw border around plot',
1.20 matthew 169: edit_type => 'on_off'
170: },
171: font => {
172: default => 'medium',
173: test => $sml_test,
174: description => 'Size of font to use',
175: edit_type => 'choice',
176: choices => ['small','medium','large']
177: },
178: align => {
179: default => 'left',
180: test => sub {$_[0]=~/^(left|right|center)$/},
181: description => 'alignment for image in html',
182: edit_type => 'choice',
183: choices => ['left','right','center']
184: }
1.1 matthew 185: );
186:
187: my %key_defaults =
188: (
1.20 matthew 189: title => {
190: default => '',
191: test => $words_test,
192: description => 'Title of key',
1.38 ! matthew 193: edit_type => 'entry',
! 194: size => '40'
1.20 matthew 195: },
196: box => {
197: default => 'off',
198: test => $onoff_test,
199: description => 'Draw a box around the key?',
200: edit_type => 'on_off'
201: },
202: pos => {
203: default => 'top right',
204: test => $key_pos_test,
205: description => 'position of the key on the plot',
206: edit_type => 'choice',
207: choices => ['top left','top right','bottom left','bottom right',
208: 'outside','below']
209: }
1.1 matthew 210: );
211:
212: my %label_defaults =
213: (
1.20 matthew 214: xpos => {
215: default => 0,
216: test => $real_test,
217: description => 'x position of label (graph coordinates)',
1.38 ! matthew 218: edit_type => 'entry',
! 219: size => '10'
1.20 matthew 220: },
221: ypos => {
222: default => 0,
223: test => $real_test,
224: description => 'y position of label (graph coordinates)',
1.38 ! matthew 225: edit_type => 'entry',
! 226: size => '10'
1.20 matthew 227: },
228: justify => {
229: default => 'left',
230: test => sub {$_[0]=~/^(left|right|center)$/},
231: description => 'justification of the label text on the plot',
232: edit_type => 'choice',
233: choices => ['left','right','center']
234: }
1.1 matthew 235: );
236:
237: my %axis_defaults =
238: (
1.28 matthew 239: color => {
1.20 matthew 240: default => 'x000000',
241: test => $color_test,
242: description => 'color of axes (x000000)',
1.38 ! matthew 243: edit_type => 'entry',
! 244: size => '10'
1.20 matthew 245: },
246: xmin => {
247: default => '-10.0',
248: test => $real_test,
249: description => 'minimum x-value shown in plot',
1.38 ! matthew 250: edit_type => 'entry',
! 251: size => '10'
1.20 matthew 252: },
253: xmax => {
254: default => ' 10.0',
255: test => $real_test,
256: description => 'maximum x-value shown in plot',
1.38 ! matthew 257: edit_type => 'entry',
! 258: size => '10'
1.20 matthew 259: },
260: ymin => {
261: default => '-10.0',
262: test => $real_test,
263: description => 'minimum y-value shown in plot',
1.38 ! matthew 264: edit_type => 'entry',
! 265: size => '10'
1.20 matthew 266: },
267: ymax => {
268: default => ' 10.0',
269: test => $real_test,
270: description => 'maximum y-value shown in plot',
1.38 ! matthew 271: edit_type => 'entry',
! 272: size => '10'
1.20 matthew 273: }
1.1 matthew 274: );
275:
276: my %curve_defaults =
277: (
1.20 matthew 278: color => {
279: default => 'x000000',
280: test => $color_test,
281: description => 'color of curve (x000000)',
1.38 ! matthew 282: edit_type => 'entry',
! 283: size => '10'
1.20 matthew 284: },
285: name => {
286: default => '',
287: test => $words_test,
288: description => 'name of curve to appear in key',
1.38 ! matthew 289: edit_type => 'entry',
! 290: size => '20'
1.20 matthew 291: },
292: linestyle => {
293: default => 'lines',
294: test => $linestyle_test,
1.35 matthew 295: description => 'Line style',
1.20 matthew 296: edit_type => 'choice',
1.38 ! matthew 297: choices => [keys(%linestyles)]
1.20 matthew 298: }
1.1 matthew 299: );
300:
1.21 matthew 301: ###################################################################
302: ## ##
303: ## parsing and edit rendering ##
304: ## ##
305: ###################################################################
1.1 matthew 306: my (%plot,%key,%axis,$title,$xlabel,$ylabel,@labels,@curves);
307:
308: sub start_plot {
1.23 matthew 309: %plot = (); %key = (); %axis = ();
1.10 matthew 310: $title = undef; $xlabel = undef; $ylabel = undef;
311: $#labels = -1; $#curves = -1;
1.6 matthew 312: #
1.1 matthew 313: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
314: my $result='';
1.25 matthew 315: &Apache::lonxml::register('Apache::lonplot',
316: ('title','xlabel','ylabel','key','axis','label','curve'));
1.29 matthew 317: push (@Apache::lonxml::namespace,'lonplot');
1.4 matthew 318: if ($target eq 'web') {
1.29 matthew 319: my $inside = &Apache::lonxml::get_all_text("/plot",$$parser[-1]);
1.17 matthew 320: $inside=&Apache::run::evaluate($inside,$safeeval,$$parstack[-1]);
1.29 matthew 321: &Apache::lonxml::newparser($parser,\$inside);
1.17 matthew 322: &get_attributes(\%plot,\%plot_defaults,$parstack,$safeeval,
323: $tagstack->[-1]);
1.20 matthew 324: } elsif ($target eq 'edit') {
1.25 matthew 325: $result .= &Apache::edit::tag_start($target,$token,'Plot');
1.34 matthew 326: $result .= &edit_attributes($target,$token,\%plot_defaults,
327: \@plot_edit_order);
1.20 matthew 328: } elsif ($target eq 'modified') {
329: my $constructtag=&Apache::edit::get_new_args
1.24 matthew 330: ($token,$parstack,$safeeval,keys(%plot_defaults));
1.20 matthew 331: if ($constructtag) {
332: $result = &Apache::edit::rebuild_tag($token);
1.26 matthew 333: # $result.= &Apache::edit::handle_insert();
1.20 matthew 334: }
1.4 matthew 335: }
1.21 matthew 336: return $result;
1.1 matthew 337: }
338:
339: sub end_plot {
340: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
1.25 matthew 341:
1.1 matthew 342: pop @Apache::lonxml::namespace;
1.4 matthew 343: &Apache::lonxml::deregister('Apache::lonplot',
344: ('title','xlabel','ylabel','key','axis','label','curve'));
345: my $result = '';
346: if ($target eq 'web') {
1.21 matthew 347: &check_inputs(); # Make sure we have all the data we need
1.13 matthew 348: ##
349: ## Determine filename
1.4 matthew 350: my $tmpdir = '/home/httpd/perl/tmp/';
1.12 matthew 351: my $filename = $ENV{'user.name'}.'_'.$ENV{'user.domain'}.
1.29 matthew 352: '_'.time.'_'.$$.int(rand(1000)).'_plot.data';
1.4 matthew 353: ## Write the plot description to the file
1.12 matthew 354: my $fh=Apache::File->new(">$tmpdir$filename");
355: print $fh &write_gnuplot_file();
1.14 matthew 356: close($fh);
1.4 matthew 357: ## return image tag for the plot
1.12 matthew 358: $result .= <<"ENDIMAGE";
1.16 matthew 359: <img src = "/cgi-bin/plot.gif?$filename"
360: width = "$plot{'width'}"
361: height = "$plot{'height'}"
362: align = "$plot{'align'}"
363: alt = "/cgi-bin/plot.gif?$filename" />
1.12 matthew 364: ENDIMAGE
1.20 matthew 365: } elsif ($target eq 'edit') {
1.21 matthew 366: $result.=&Apache::edit::tag_end($target,$token);
1.4 matthew 367: }
1.1 matthew 368: return $result;
369: }
1.2 matthew 370:
1.1 matthew 371: ##----------------------------------------------------------------- key
372: sub start_key {
373: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
374: my $result='';
1.17 matthew 375: if ($target eq 'web') {
376: &get_attributes(\%key,\%key_defaults,$parstack,$safeeval,
1.11 matthew 377: $tagstack->[-1]);
1.20 matthew 378: } elsif ($target eq 'edit') {
1.25 matthew 379: $result .= &Apache::edit::tag_start($target,$token,'Plot Key');
1.21 matthew 380: $result .= &edit_attributes($target,$token,\%key_defaults);
1.20 matthew 381: } elsif ($target eq 'modified') {
382: my $constructtag=&Apache::edit::get_new_args
1.24 matthew 383: ($token,$parstack,$safeeval,keys(%key_defaults));
1.20 matthew 384: if ($constructtag) {
385: $result = &Apache::edit::rebuild_tag($token);
386: $result.= &Apache::edit::handle_insert();
387: }
1.4 matthew 388: }
1.1 matthew 389: return $result;
390: }
391:
392: sub end_key {
393: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
394: my $result = '';
1.4 matthew 395: if ($target eq 'web') {
1.20 matthew 396: } elsif ($target eq 'edit') {
1.21 matthew 397: $result.=&Apache::edit::tag_end($target,$token);
1.4 matthew 398: }
1.1 matthew 399: return $result;
400: }
1.21 matthew 401:
1.1 matthew 402: ##------------------------------------------------------------------- title
403: sub start_title {
404: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
405: my $result='';
1.4 matthew 406: if ($target eq 'web') {
1.17 matthew 407: $title = &Apache::lonxml::get_all_text("/title",$$parser[-1]);
1.32 matthew 408: if (length($title) > $max_str_len) {
409: $title = substr($title,0,$max_str_len);
410: }
1.20 matthew 411: } elsif ($target eq 'edit') {
1.25 matthew 412: $result.=&Apache::edit::tag_start($target,$token,'Plot Title');
1.22 matthew 413: my $text=&Apache::lonxml::get_all_text("/title",$$parser[-1]);
414: $result.='</td></tr><tr><td colspan="3">'.
1.30 matthew 415: &Apache::edit::editfield('',$text,'',60,1);
1.20 matthew 416: } elsif ($target eq 'modified') {
1.29 matthew 417: my $text=$$parser[-1]->get_text("/title");
1.21 matthew 418: $result.=&Apache::edit::modifiedfield($token);
1.4 matthew 419: }
1.1 matthew 420: return $result;
421: }
422:
423: sub end_title {
424: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
425: my $result = '';
1.4 matthew 426: if ($target eq 'web') {
1.20 matthew 427: } elsif ($target eq 'edit') {
1.27 matthew 428: $result.=&Apache::edit::tag_end($target,$token);
1.4 matthew 429: }
1.1 matthew 430: return $result;
431: }
432: ##------------------------------------------------------------------- xlabel
433: sub start_xlabel {
434: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
435: my $result='';
1.4 matthew 436: if ($target eq 'web') {
1.17 matthew 437: $xlabel = &Apache::lonxml::get_all_text("/xlabel",$$parser[-1]);
1.32 matthew 438: if (length($xlabel) > $max_str_len) {
439: $xlabel = substr($xlabel,0,$max_str_len);
440: }
1.20 matthew 441: } elsif ($target eq 'edit') {
1.25 matthew 442: $result.=&Apache::edit::tag_start($target,$token,'Plot Xlabel');
1.22 matthew 443: my $text=&Apache::lonxml::get_all_text("/xlabel",$$parser[-1]);
444: $result.='</td></tr><tr><td colspan="3">'.
1.30 matthew 445: &Apache::edit::editfield('',$text,'',60,1);
1.20 matthew 446: } elsif ($target eq 'modified') {
1.29 matthew 447: my $text=$$parser[-1]->get_text("/xlabel");
1.21 matthew 448: $result.=&Apache::edit::modifiedfield($token);
1.4 matthew 449: }
1.1 matthew 450: return $result;
451: }
452:
453: sub end_xlabel {
454: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
455: my $result = '';
1.4 matthew 456: if ($target eq 'web') {
1.20 matthew 457: } elsif ($target eq 'edit') {
1.27 matthew 458: $result.=&Apache::edit::tag_end($target,$token);
1.4 matthew 459: }
1.1 matthew 460: return $result;
461: }
1.21 matthew 462:
1.1 matthew 463: ##------------------------------------------------------------------- ylabel
464: sub start_ylabel {
465: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
466: my $result='';
1.4 matthew 467: if ($target eq 'web') {
1.17 matthew 468: $ylabel = &Apache::lonxml::get_all_text("/ylabel",$$parser[-1]);
1.32 matthew 469: if (length($ylabel) > $max_str_len) {
470: $ylabel = substr($ylabel,0,$max_str_len);
471: }
1.20 matthew 472: } elsif ($target eq 'edit') {
1.25 matthew 473: $result .= &Apache::edit::tag_start($target,$token,'Plot Ylabel');
1.22 matthew 474: my $text = &Apache::lonxml::get_all_text("/ylabel",$$parser[-1]);
475: $result .= '</td></tr><tr><td colspan="3">'.
1.30 matthew 476: &Apache::edit::editfield('',$text,'',60,1);
1.20 matthew 477: } elsif ($target eq 'modified') {
1.29 matthew 478: my $text=$$parser[-1]->get_text("/ylabel");
1.21 matthew 479: $result.=&Apache::edit::modifiedfield($token);
1.4 matthew 480: }
1.1 matthew 481: return $result;
482: }
483:
484: sub end_ylabel {
485: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
486: my $result = '';
1.4 matthew 487: if ($target eq 'web') {
1.20 matthew 488: } elsif ($target eq 'edit') {
1.27 matthew 489: $result.=&Apache::edit::tag_end($target,$token);
1.4 matthew 490: }
1.1 matthew 491: return $result;
492: }
1.21 matthew 493:
1.1 matthew 494: ##------------------------------------------------------------------- label
495: sub start_label {
496: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
497: my $result='';
1.17 matthew 498: if ($target eq 'web') {
499: my %label;
500: &get_attributes(\%label,\%label_defaults,$parstack,$safeeval,
1.11 matthew 501: $tagstack->[-1]);
1.32 matthew 502: my $text = &Apache::lonxml::get_all_text("/label",$$parser[-1]);
503: $text = substr($text,0,$max_str_len) if (length($text) > $max_str_len);
504: $label{'text'} = $text;
1.17 matthew 505: push(@labels,\%label);
1.20 matthew 506: } elsif ($target eq 'edit') {
1.25 matthew 507: $result .= &Apache::edit::tag_start($target,$token,'Plot Label');
1.21 matthew 508: $result .= &edit_attributes($target,$token,\%label_defaults);
1.22 matthew 509: my $text = &Apache::lonxml::get_all_text("/label",$$parser[-1]);
510: $result .= '</td></tr><tr><td colspan="3">'.
1.30 matthew 511: &Apache::edit::editfield('',$text,'',60,1);
1.20 matthew 512: } elsif ($target eq 'modified') {
513: my $constructtag=&Apache::edit::get_new_args
1.24 matthew 514: ($token,$parstack,$safeeval,keys(%label_defaults));
1.20 matthew 515: if ($constructtag) {
516: $result = &Apache::edit::rebuild_tag($token);
517: $result.= &Apache::edit::handle_insert();
518: }
1.22 matthew 519: my $text=$$parser[-1]->get_text("/label");
1.21 matthew 520: $result.=&Apache::edit::modifiedfield($token);
1.4 matthew 521: }
1.1 matthew 522: return $result;
523: }
524:
525: sub end_label {
526: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
527: my $result = '';
1.4 matthew 528: if ($target eq 'web') {
1.20 matthew 529: } elsif ($target eq 'edit') {
1.21 matthew 530: $result.=&Apache::edit::tag_end($target,$token);
1.4 matthew 531: }
1.1 matthew 532: return $result;
533: }
534:
535: ##------------------------------------------------------------------- curve
536: sub start_curve {
537: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
538: my $result='';
1.25 matthew 539: &Apache::lonxml::register('Apache::lonplot',('function','data'));
540: push (@Apache::lonxml::namespace,'curve');
1.17 matthew 541: if ($target eq 'web') {
542: my %curve;
543: &get_attributes(\%curve,\%curve_defaults,$parstack,$safeeval,
1.11 matthew 544: $tagstack->[-1]);
1.17 matthew 545: push (@curves,\%curve);
1.20 matthew 546: } elsif ($target eq 'edit') {
1.26 matthew 547: $result .= &Apache::edit::tag_start($target,$token,'Curve');
1.21 matthew 548: $result .= &edit_attributes($target,$token,\%curve_defaults);
1.20 matthew 549: } elsif ($target eq 'modified') {
550: my $constructtag=&Apache::edit::get_new_args
1.35 matthew 551: ($token,$parstack,$safeeval,keys(%curve_defaults));
1.20 matthew 552: if ($constructtag) {
553: $result = &Apache::edit::rebuild_tag($token);
554: $result.= &Apache::edit::handle_insert();
555: }
1.4 matthew 556: }
1.1 matthew 557: return $result;
558: }
559:
560: sub end_curve {
561: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
562: my $result = '';
1.25 matthew 563: pop @Apache::lonxml::namespace;
564: &Apache::lonxml::deregister('Apache::lonplot',('function','data'));
1.4 matthew 565: if ($target eq 'web') {
1.20 matthew 566: } elsif ($target eq 'edit') {
1.21 matthew 567: $result.=&Apache::edit::tag_end($target,$token);
1.4 matthew 568: }
1.1 matthew 569: return $result;
570: }
1.21 matthew 571:
1.1 matthew 572: ##------------------------------------------------------------ curve function
573: sub start_function {
574: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
575: my $result='';
1.4 matthew 576: if ($target eq 'web') {
1.17 matthew 577: if (exists($curves[-1]->{'data'})) {
578: &Apache::lonxml::warning('Use of <function> precludes use of <data>. The <data> will be omitted in favor of the <function> declaration.');
579: delete $curves[-1]->{'data'} ;
580: }
581: $curves[-1]->{'function'} =
582: &Apache::lonxml::get_all_text("/function",$$parser[-1]);
1.20 matthew 583: } elsif ($target eq 'edit') {
1.37 matthew 584: $result .= &Apache::edit::tag_start($target,$token,'Gnuplot compatible curve function');
1.22 matthew 585: my $text = &Apache::lonxml::get_all_text("/function",$$parser[-1]);
586: $result .= '</td></tr><tr><td colspan="3">'.
1.30 matthew 587: &Apache::edit::editfield('',$text,'',60,1);
1.20 matthew 588: } elsif ($target eq 'modified') {
589: # Why do I do this?
590: my $text=$$parser[-1]->get_text("/function");
591: $result.=&Apache::edit::modifiedfield($token);
1.4 matthew 592: }
1.1 matthew 593: return $result;
594: }
595:
596: sub end_function {
597: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
598: my $result = '';
1.4 matthew 599: if ($target eq 'web') {
1.20 matthew 600: } elsif ($target eq 'edit') {
1.26 matthew 601: $result .= &Apache::edit::end_table();
1.4 matthew 602: }
1.1 matthew 603: return $result;
604: }
1.21 matthew 605:
1.1 matthew 606: ##------------------------------------------------------------ curve data
607: sub start_data {
608: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
609: my $result='';
1.4 matthew 610: if ($target eq 'web') {
1.17 matthew 611: if (exists($curves[-1]->{'function'})) {
612: &Apache::lonxml::warning('Use of <data> precludes use of .'.
613: '<function>. The <function> will be omitted in favor of '.
614: 'the <data> declaration.');
615: delete($curves[-1]->{'function'});
616: }
617: my $datatext = &Apache::lonxml::get_all_text("/data",$$parser[-1]);
618: $datatext =~ s/\s+/ /g;
619: # Need to do some error checking on the @data array -
620: # make sure it's all numbers and make sure each array
621: # is of the same length.
622: my @data;
1.35 matthew 623: if ($datatext =~ /,/) { # comma deliminated
1.17 matthew 624: @data = split /,/,$datatext;
625: } else { # Assume it's space seperated.
626: @data = split / /,$datatext;
627: }
628: for (my $i=0;$i<=$#data;$i++) {
629: # Check that it's non-empty
1.19 matthew 630: if (! defined($data[$i])) {
631: &Apache::lonxml::warning(
632: 'undefined <data> value. Replacing with '.
633: ' pi/e = 1.15572734979092');
634: $data[$i] = 1.15572734979092;
635: }
1.17 matthew 636: # Check that it's a number
1.19 matthew 637: if (! &$real_test($data[$i]) & ! &$int_test($data[$i])) {
638: &Apache::lonxml::warning(
639: 'Bad <data> value of '.$data[$i].' Replacing with '.
640: ' pi/e = 1.15572734979092');
641: $data[$i] = 1.15572734979092;
642: }
1.17 matthew 643: }
1.35 matthew 644: # complain if the number of data points is not the same as
645: # in previous sets of data.
1.36 matthew 646: if (($curves[-1]->{'data'}) && ($#data != $#{@{$curves[-1]->{'data'}->[0]}})){
1.35 matthew 647: &Apache::lonxml::warning
648: ('Number of data points is not consistent with previous '.
649: 'number of data points');
650: }
1.17 matthew 651: push @{$curves[-1]->{'data'}},\@data;
1.20 matthew 652: } elsif ($target eq 'edit') {
1.37 matthew 653: $result .= &Apache::edit::tag_start($target,$token,'Comma or space deliminated curve data');
1.22 matthew 654: my $text = &Apache::lonxml::get_all_text("/data",$$parser[-1]);
655: $result .= '</td></tr><tr><td colspan="3">'.
1.30 matthew 656: &Apache::edit::editfield('',$text,'',60,1);
1.20 matthew 657: } elsif ($target eq 'modified') {
1.21 matthew 658: my $text=$$parser[-1]->get_text("/data");
659: $result.=&Apache::edit::modifiedfield($token);
1.4 matthew 660: }
1.1 matthew 661: return $result;
662: }
663:
664: sub end_data {
665: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
666: my $result = '';
1.4 matthew 667: if ($target eq 'web') {
1.20 matthew 668: } elsif ($target eq 'edit') {
1.26 matthew 669: $result .= &Apache::edit::end_table();
1.4 matthew 670: }
1.1 matthew 671: return $result;
672: }
673:
674: ##------------------------------------------------------------------- axis
675: sub start_axis {
676: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
677: my $result='';
1.4 matthew 678: if ($target eq 'web') {
1.17 matthew 679: &get_attributes(\%axis,\%axis_defaults,$parstack,$safeeval,
680: $tagstack->[-1]);
1.20 matthew 681: } elsif ($target eq 'edit') {
1.25 matthew 682: $result .= &Apache::edit::tag_start($target,$token,'Plot Axes');
1.21 matthew 683: $result .= &edit_attributes($target,$token,\%axis_defaults);
1.20 matthew 684: } elsif ($target eq 'modified') {
1.29 matthew 685: my $constructtag=&Apache::edit::get_new_args
686: ($token,$parstack,$safeeval,keys(%axis_defaults));
687: if ($constructtag) {
688: $result = &Apache::edit::rebuild_tag($token);
689: $result.= &Apache::edit::handle_insert();
690: }
1.4 matthew 691: }
1.1 matthew 692: return $result;
693: }
694:
695: sub end_axis {
696: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
697: my $result = '';
1.4 matthew 698: if ($target eq 'web') {
1.20 matthew 699: } elsif ($target eq 'edit') {
1.21 matthew 700: $result.=&Apache::edit::tag_end($target,$token);
1.20 matthew 701: } elsif ($target eq 'modified') {
1.4 matthew 702: }
1.1 matthew 703: return $result;
704: }
705:
1.21 matthew 706: ###################################################################
707: ## ##
708: ## Utility Functions ##
709: ## ##
710: ###################################################################
711:
1.13 matthew 712: ##----------------------------------------------------------- set_defaults
713: sub set_defaults {
1.21 matthew 714: my ($var,$defaults) = @_;
1.13 matthew 715: my $key;
1.24 matthew 716: foreach $key (keys(%$defaults)) {
1.13 matthew 717: $var->{$key} = $defaults->{$key}->{'default'};
718: }
719: }
720:
1.1 matthew 721: ##------------------------------------------------------------------- misc
1.2 matthew 722: sub get_attributes{
1.21 matthew 723: my ($values,$defaults,$parstack,$safeeval,$tag) = @_;
1.24 matthew 724: foreach my $attr (keys(%{$defaults})) {
1.10 matthew 725: $values->{$attr} =
1.15 matthew 726: &Apache::lonxml::get_param($attr,$parstack,$safeeval);
1.10 matthew 727: if ($values->{$attr} eq '' | !defined($values->{$attr})) {
1.11 matthew 728: $values->{$attr} = $defaults->{$attr}->{'default'};
1.6 matthew 729: next;
730: }
1.10 matthew 731: my $test = $defaults->{$attr}->{'test'};
732: if (! &$test($values->{$attr})) {
1.6 matthew 733: &Apache::lonxml::warning
734: ($tag.':'.$attr.': Bad value.'.'Replacing your value with : '
1.11 matthew 735: .$defaults->{$attr}->{'default'} );
736: $values->{$attr} = $defaults->{$attr}->{'default'};
1.10 matthew 737: }
1.2 matthew 738: }
1.11 matthew 739: return ;
1.6 matthew 740: }
1.15 matthew 741: ##------------------------------------------------------- write_gnuplot_file
1.6 matthew 742: sub write_gnuplot_file {
743: my $gnuplot_input = '';
1.10 matthew 744: my $curve;
1.6 matthew 745: # Collect all the colors
746: my @Colors;
747: push @Colors, $plot{'bgcolor'};
748: push @Colors, $plot{'fgcolor'};
1.13 matthew 749: push @Colors, (defined($axis{'color'})?$axis{'color'}:$plot{'fgcolor'});
1.9 matthew 750: foreach $curve (@curves) {
751: push @Colors, ($curve->{'color'} ne '' ?
752: $curve->{'color'} :
1.13 matthew 753: $plot{'fgcolor'} );
1.6 matthew 754: }
755: # set term
756: $gnuplot_input .= 'set term gif ';
757: $gnuplot_input .= 'transparent ' if ($plot{'transparent'} eq 'on');
758: $gnuplot_input .= $plot{'font'} . ' ';
1.10 matthew 759: $gnuplot_input .= 'size '.$plot{'width'}.','.$plot{'height'}.' ';
1.6 matthew 760: $gnuplot_input .= "@Colors\n";
1.7 matthew 761: # grid
1.10 matthew 762: $gnuplot_input .= 'set grid'.$/ if ($plot{'grid'} eq 'on');
1.7 matthew 763: # border
1.9 matthew 764: $gnuplot_input .= ($plot{'border'} eq 'on'?
765: 'set border'.$/ :
766: 'set noborder'.$/ ); # title, xlabel, ylabel
1.13 matthew 767: $gnuplot_input .= "set output\n";
768: $gnuplot_input .= "set title \"$title\"\n" if (defined($title)) ;
769: $gnuplot_input .= "set xlabel \"$xlabel\"\n" if (defined($xlabel));
770: $gnuplot_input .= "set ylabel \"$ylabel\"\n" if (defined($ylabel));
1.23 matthew 771: if (%axis) {
1.13 matthew 772: $gnuplot_input .= "set xrange \[$axis{'xmin'}:$axis{'xmax'}\]\n";
773: $gnuplot_input .= "set yrange \[$axis{'ymin'}:$axis{'ymax'}\]\n";
1.6 matthew 774: }
775: # Key
1.23 matthew 776: if (%key) {
1.9 matthew 777: $gnuplot_input .= 'set key '.$key{'pos'}.' ';
778: if ($key{'title'} ne '') {
1.11 matthew 779: $gnuplot_input .= 'title "'.$key{'title'}.'" ';
780: }
781: $gnuplot_input .= ($key{'box'} eq 'on' ? 'box ' : 'nobox ').$/;
1.6 matthew 782: } else {
1.9 matthew 783: $gnuplot_input .= 'set nokey'.$/;
1.13 matthew 784: }
1.6 matthew 785: # labels
1.10 matthew 786: my $label;
1.6 matthew 787: foreach $label (@labels) {
788: $gnuplot_input .= 'set label "'.$label->{'text'}.'" at '.
1.9 matthew 789: $label->{'xpos'}.','.$label->{'ypos'}.' '.$label->{'justify'}.$/ ;
1.6 matthew 790: }
791: # curves
792: $gnuplot_input .= 'plot ';
793: my $datatext = '';
1.9 matthew 794: for (my $i = 0;$i<=$#curves;$i++) {
795: $curve = $curves[$i];
796: $gnuplot_input.= ', ' if ($i > 0);
1.6 matthew 797: if (exists($curve->{'function'})) {
1.9 matthew 798: $gnuplot_input.=
799: $curve->{'function'}.' title "'.
800: $curve->{'name'}.'" with '.
801: $curve->{'linestyle'};
1.6 matthew 802: } elsif (exists($curve->{'data'})) {
1.9 matthew 803: $gnuplot_input.= '\'-\' title "'.
804: $curve->{'name'}.'" with '.
805: $curve->{'linestyle'};
1.6 matthew 806: my @Data = @{$curve->{'data'}};
1.9 matthew 807: my @Data0 = @{$Data[0]};
808: for (my $i =0; $i<=$#Data0; $i++) {
1.10 matthew 809: my $dataset;
1.6 matthew 810: foreach $dataset (@Data) {
1.9 matthew 811: $datatext .= $dataset->[$i] . ' ';
1.6 matthew 812: }
1.9 matthew 813: $datatext .= $/;
1.6 matthew 814: }
1.9 matthew 815: $datatext .=$/;
1.6 matthew 816: }
817: }
1.9 matthew 818: $gnuplot_input .= $/.$datatext;
1.10 matthew 819: return $gnuplot_input;
1.2 matthew 820: }
1.21 matthew 821:
822: #---------------------------------------------- check_inputs
823: sub check_inputs {
824: ## Note: no inputs, no outputs - this acts only on global variables.
825: ## Make sure we have all the input we need:
1.23 matthew 826: if (! %plot) { &set_defaults(\%plot,\%plot_defaults); }
827: if (! %key ) {} # No key for this plot, thats okay
1.34 matthew 828: # if (! %axis) { &set_defaults(\%axis,\%axis_defaults); }
1.21 matthew 829: if (! defined($title )) {} # No title for this plot, thats okay
830: if (! defined($xlabel)) {} # No xlabel for this plot, thats okay
831: if (! defined($ylabel)) {} # No ylabel for this plot, thats okay
832: if ($#labels < 0) { } # No labels for this plot, thats okay
833: if ($#curves < 0) {
834: &Apache::lonxml::warning("No curves specified for plot!!!!");
835: return '';
836: }
837: my $curve;
838: foreach $curve (@curves) {
839: if (!defined($curve->{'function'})&&!defined($curve->{'data'})){
840: &Apache::lonxml::warning("One of the curves specified did not contain any <data> or <function> declarations\n");
841: return '';
842: }
843: }
844: }
845:
1.20 matthew 846: #------------------------------------------------ make_edit
847: sub edit_attributes {
1.34 matthew 848: my ($target,$token,$defaults,$keys) = @_;
849: my ($result,@keys);
850: if ($keys && ref($keys) eq 'ARRAY') {
851: @keys = @$keys;
852: } else {
853: @keys = sort(keys(%$defaults));
854: }
855: foreach my $attr (@keys) {
1.35 matthew 856: # append a ' ' to the description if it doesn't have one already.
857: my $description = $defaults->{$attr}->{'description'};
858: $description .= ' ' if ($description !~ / $/);
1.20 matthew 859: if ($defaults->{$attr}->{'edit_type'} eq 'entry') {
1.35 matthew 860: $result .= &Apache::edit::text_arg
1.38 ! matthew 861: ($description,$attr,$token,
! 862: $defaults->{$attr}->{'size'});
1.20 matthew 863: } elsif ($defaults->{$attr}->{'edit_type'} eq 'choice') {
1.35 matthew 864: $result .= &Apache::edit::select_arg
865: ($description,$attr,$defaults->{$attr}->{'choices'},$token);
1.34 matthew 866: } elsif ($defaults->{$attr}->{'edit_type'} eq 'on_off') {
1.35 matthew 867: $result .= &Apache::edit::select_arg
868: ($description,$attr,['on','off'],$token);
1.20 matthew 869: }
1.25 matthew 870: $result .= '<br />';
1.20 matthew 871: }
872: return $result;
873: }
1.1 matthew 874:
1.21 matthew 875:
876: ###################################################################
877: ## ##
878: ## Insertion functions for editing plots ##
879: ## ##
880: ###################################################################
881:
1.20 matthew 882: #------------------------------------------------ insert_xxxxxxx
883: sub insert_plot {
1.29 matthew 884: my $result = '';
1.20 matthew 885: # plot attributes
1.29 matthew 886: $result .= "<plot \n";
1.30 matthew 887: foreach my $attr (keys(%plot_defaults)) {
1.29 matthew 888: $result .= " $attr=\"$plot_defaults{$attr}->{'default'}\"\n";
1.20 matthew 889: }
890: $result .= ">\n";
891: # Add the components
892: $result .= &insert_key();
893: $result .= &insert_axis();
1.29 matthew 894: $result .= &insert_title();
895: $result .= &insert_xlabel();
896: $result .= &insert_ylabel();
1.20 matthew 897: $result .= &insert_curve();
898: # close up the <plot>
899: $result .= "</plot>\n";
900: return $result;
901: }
902:
903: sub insert_key {
904: my $result;
1.29 matthew 905: $result .= " <key \n";
1.30 matthew 906: foreach my $attr (keys(%key_defaults)) {
1.29 matthew 907: $result .= " $attr=\"$key_defaults{$attr}->{'default'}\"\n";
1.20 matthew 908: }
909: $result .= " />\n";
910: return $result;
911: }
912:
913: sub insert_axis{
914: my $result;
915: $result .= ' <axis ';
1.30 matthew 916: foreach my $attr (keys(%axis_defaults)) {
1.29 matthew 917: $result .= " $attr=\"$axis_defaults{$attr}->{'default'}\"\n";
1.20 matthew 918: }
919: $result .= " />\n";
920: return $result;
921: }
1.28 matthew 922:
923: sub insert_title { return " <title></title>\n"; }
1.29 matthew 924: sub insert_xlabel { return " <xlabel></xlabel>\n"; }
925: sub insert_ylabel { return " <ylabel></ylabel>\n"; }
1.20 matthew 926:
927: sub insert_label {
928: my $result;
929: $result .= ' <label ';
1.30 matthew 930: foreach my $attr (keys(%label_defaults)) {
1.27 matthew 931: $result .= ' '.$attr.'="'.
1.20 matthew 932: $label_defaults{$attr}->{'default'}."\"\n";
933: }
934: $result .= " ></label>\n";
935: return $result;
936: }
937:
938: sub insert_curve {
939: my $result;
940: $result .= ' <curve ';
1.30 matthew 941: foreach my $attr (keys(%curve_defaults)) {
1.27 matthew 942: $result .= ' '.$attr.'="'.
1.20 matthew 943: $curve_defaults{$attr}->{'default'}."\"\n";
944: }
1.29 matthew 945: $result .= " ></curve>\n";
1.20 matthew 946: }
1.4 matthew 947:
1.20 matthew 948: sub insert_function {
949: my $result;
950: $result .= "<function></function>\n";
951: return $result;
952: }
1.4 matthew 953:
1.20 matthew 954: sub insert_data {
955: my $result;
956: $result .= " <data></data>\n";
957: return $result;
958: }
1.4 matthew 959:
1.21 matthew 960: ##----------------------------------------------------------------------
1.20 matthew 961: 1;
962: __END__
1.4 matthew 963:
964:
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/back.gif){kind=icon}
Return to lonplot.pm CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [LON-CAPA] / loncom / xml