Annotation of loncom/xml/lonplot.pm, revision 1.39
1.1 matthew 1: # The LearningOnline Network with CAPA
2: # Dynamic plot
3: #
1.39 ! matthew 4: # $Id: lonplot.pm,v 1.38 2002/01/10 19:45:51 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);
333: }
1.4 matthew 334: }
1.21 matthew 335: return $result;
1.1 matthew 336: }
337:
338: sub end_plot {
339: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
1.25 matthew 340:
1.1 matthew 341: pop @Apache::lonxml::namespace;
1.4 matthew 342: &Apache::lonxml::deregister('Apache::lonplot',
343: ('title','xlabel','ylabel','key','axis','label','curve'));
344: my $result = '';
345: if ($target eq 'web') {
1.21 matthew 346: &check_inputs(); # Make sure we have all the data we need
1.13 matthew 347: ##
348: ## Determine filename
1.4 matthew 349: my $tmpdir = '/home/httpd/perl/tmp/';
1.12 matthew 350: my $filename = $ENV{'user.name'}.'_'.$ENV{'user.domain'}.
1.29 matthew 351: '_'.time.'_'.$$.int(rand(1000)).'_plot.data';
1.4 matthew 352: ## Write the plot description to the file
1.12 matthew 353: my $fh=Apache::File->new(">$tmpdir$filename");
354: print $fh &write_gnuplot_file();
1.14 matthew 355: close($fh);
1.4 matthew 356: ## return image tag for the plot
1.12 matthew 357: $result .= <<"ENDIMAGE";
1.16 matthew 358: <img src = "/cgi-bin/plot.gif?$filename"
359: width = "$plot{'width'}"
360: height = "$plot{'height'}"
361: align = "$plot{'align'}"
362: alt = "/cgi-bin/plot.gif?$filename" />
1.12 matthew 363: ENDIMAGE
1.20 matthew 364: } elsif ($target eq 'edit') {
1.21 matthew 365: $result.=&Apache::edit::tag_end($target,$token);
1.4 matthew 366: }
1.1 matthew 367: return $result;
368: }
1.2 matthew 369:
1.1 matthew 370: ##----------------------------------------------------------------- key
371: sub start_key {
372: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
373: my $result='';
1.17 matthew 374: if ($target eq 'web') {
375: &get_attributes(\%key,\%key_defaults,$parstack,$safeeval,
1.11 matthew 376: $tagstack->[-1]);
1.20 matthew 377: } elsif ($target eq 'edit') {
1.25 matthew 378: $result .= &Apache::edit::tag_start($target,$token,'Plot Key');
1.21 matthew 379: $result .= &edit_attributes($target,$token,\%key_defaults);
1.20 matthew 380: } elsif ($target eq 'modified') {
381: my $constructtag=&Apache::edit::get_new_args
1.24 matthew 382: ($token,$parstack,$safeeval,keys(%key_defaults));
1.20 matthew 383: if ($constructtag) {
384: $result = &Apache::edit::rebuild_tag($token);
385: $result.= &Apache::edit::handle_insert();
386: }
1.4 matthew 387: }
1.1 matthew 388: return $result;
389: }
390:
391: sub end_key {
392: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
393: my $result = '';
1.4 matthew 394: if ($target eq 'web') {
1.20 matthew 395: } elsif ($target eq 'edit') {
1.21 matthew 396: $result.=&Apache::edit::tag_end($target,$token);
1.4 matthew 397: }
1.1 matthew 398: return $result;
399: }
1.21 matthew 400:
1.1 matthew 401: ##------------------------------------------------------------------- title
402: sub start_title {
403: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
404: my $result='';
1.4 matthew 405: if ($target eq 'web') {
1.17 matthew 406: $title = &Apache::lonxml::get_all_text("/title",$$parser[-1]);
1.32 matthew 407: if (length($title) > $max_str_len) {
408: $title = substr($title,0,$max_str_len);
409: }
1.20 matthew 410: } elsif ($target eq 'edit') {
1.25 matthew 411: $result.=&Apache::edit::tag_start($target,$token,'Plot Title');
1.22 matthew 412: my $text=&Apache::lonxml::get_all_text("/title",$$parser[-1]);
1.39 ! matthew 413: $result.=&Apache::edit::end_row().
! 414: &Apache::edit::start_spanning_row().
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]);
1.39 ! matthew 444: $result.=&Apache::edit::end_row().
! 445: &Apache::edit::start_spanning_row().
1.30 matthew 446: &Apache::edit::editfield('',$text,'',60,1);
1.20 matthew 447: } elsif ($target eq 'modified') {
1.29 matthew 448: my $text=$$parser[-1]->get_text("/xlabel");
1.21 matthew 449: $result.=&Apache::edit::modifiedfield($token);
1.4 matthew 450: }
1.1 matthew 451: return $result;
452: }
453:
454: sub end_xlabel {
455: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
456: my $result = '';
1.4 matthew 457: if ($target eq 'web') {
1.20 matthew 458: } elsif ($target eq 'edit') {
1.27 matthew 459: $result.=&Apache::edit::tag_end($target,$token);
1.4 matthew 460: }
1.1 matthew 461: return $result;
462: }
1.21 matthew 463:
1.1 matthew 464: ##------------------------------------------------------------------- ylabel
465: sub start_ylabel {
466: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
467: my $result='';
1.4 matthew 468: if ($target eq 'web') {
1.17 matthew 469: $ylabel = &Apache::lonxml::get_all_text("/ylabel",$$parser[-1]);
1.32 matthew 470: if (length($ylabel) > $max_str_len) {
471: $ylabel = substr($ylabel,0,$max_str_len);
472: }
1.20 matthew 473: } elsif ($target eq 'edit') {
1.25 matthew 474: $result .= &Apache::edit::tag_start($target,$token,'Plot Ylabel');
1.22 matthew 475: my $text = &Apache::lonxml::get_all_text("/ylabel",$$parser[-1]);
1.39 ! matthew 476: $result .= &Apache::edit::end_row().
! 477: &Apache::edit::start_spanning_row().
1.30 matthew 478: &Apache::edit::editfield('',$text,'',60,1);
1.20 matthew 479: } elsif ($target eq 'modified') {
1.29 matthew 480: my $text=$$parser[-1]->get_text("/ylabel");
1.21 matthew 481: $result.=&Apache::edit::modifiedfield($token);
1.4 matthew 482: }
1.1 matthew 483: return $result;
484: }
485:
486: sub end_ylabel {
487: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
488: my $result = '';
1.4 matthew 489: if ($target eq 'web') {
1.20 matthew 490: } elsif ($target eq 'edit') {
1.27 matthew 491: $result.=&Apache::edit::tag_end($target,$token);
1.4 matthew 492: }
1.1 matthew 493: return $result;
494: }
1.21 matthew 495:
1.1 matthew 496: ##------------------------------------------------------------------- label
497: sub start_label {
498: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
499: my $result='';
1.17 matthew 500: if ($target eq 'web') {
501: my %label;
502: &get_attributes(\%label,\%label_defaults,$parstack,$safeeval,
1.11 matthew 503: $tagstack->[-1]);
1.32 matthew 504: my $text = &Apache::lonxml::get_all_text("/label",$$parser[-1]);
505: $text = substr($text,0,$max_str_len) if (length($text) > $max_str_len);
506: $label{'text'} = $text;
1.17 matthew 507: push(@labels,\%label);
1.20 matthew 508: } elsif ($target eq 'edit') {
1.25 matthew 509: $result .= &Apache::edit::tag_start($target,$token,'Plot Label');
1.21 matthew 510: $result .= &edit_attributes($target,$token,\%label_defaults);
1.22 matthew 511: my $text = &Apache::lonxml::get_all_text("/label",$$parser[-1]);
1.39 ! matthew 512: $result .= &Apache::edit::end_row().
! 513: &Apache::edit::start_spanning_row().
1.30 matthew 514: &Apache::edit::editfield('',$text,'',60,1);
1.20 matthew 515: } elsif ($target eq 'modified') {
516: my $constructtag=&Apache::edit::get_new_args
1.24 matthew 517: ($token,$parstack,$safeeval,keys(%label_defaults));
1.20 matthew 518: if ($constructtag) {
519: $result = &Apache::edit::rebuild_tag($token);
520: $result.= &Apache::edit::handle_insert();
521: }
1.22 matthew 522: my $text=$$parser[-1]->get_text("/label");
1.21 matthew 523: $result.=&Apache::edit::modifiedfield($token);
1.4 matthew 524: }
1.1 matthew 525: return $result;
526: }
527:
528: sub end_label {
529: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
530: my $result = '';
1.4 matthew 531: if ($target eq 'web') {
1.20 matthew 532: } elsif ($target eq 'edit') {
1.21 matthew 533: $result.=&Apache::edit::tag_end($target,$token);
1.4 matthew 534: }
1.1 matthew 535: return $result;
536: }
537:
538: ##------------------------------------------------------------------- curve
539: sub start_curve {
540: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
541: my $result='';
1.25 matthew 542: &Apache::lonxml::register('Apache::lonplot',('function','data'));
543: push (@Apache::lonxml::namespace,'curve');
1.17 matthew 544: if ($target eq 'web') {
545: my %curve;
546: &get_attributes(\%curve,\%curve_defaults,$parstack,$safeeval,
1.11 matthew 547: $tagstack->[-1]);
1.17 matthew 548: push (@curves,\%curve);
1.20 matthew 549: } elsif ($target eq 'edit') {
1.26 matthew 550: $result .= &Apache::edit::tag_start($target,$token,'Curve');
1.21 matthew 551: $result .= &edit_attributes($target,$token,\%curve_defaults);
1.20 matthew 552: } elsif ($target eq 'modified') {
553: my $constructtag=&Apache::edit::get_new_args
1.35 matthew 554: ($token,$parstack,$safeeval,keys(%curve_defaults));
1.20 matthew 555: if ($constructtag) {
556: $result = &Apache::edit::rebuild_tag($token);
557: $result.= &Apache::edit::handle_insert();
558: }
1.4 matthew 559: }
1.1 matthew 560: return $result;
561: }
562:
563: sub end_curve {
564: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
565: my $result = '';
1.25 matthew 566: pop @Apache::lonxml::namespace;
567: &Apache::lonxml::deregister('Apache::lonplot',('function','data'));
1.4 matthew 568: if ($target eq 'web') {
1.20 matthew 569: } elsif ($target eq 'edit') {
1.21 matthew 570: $result.=&Apache::edit::tag_end($target,$token);
1.4 matthew 571: }
1.1 matthew 572: return $result;
573: }
1.21 matthew 574:
1.1 matthew 575: ##------------------------------------------------------------ curve function
576: sub start_function {
577: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
578: my $result='';
1.4 matthew 579: if ($target eq 'web') {
1.17 matthew 580: if (exists($curves[-1]->{'data'})) {
581: &Apache::lonxml::warning('Use of <function> precludes use of <data>. The <data> will be omitted in favor of the <function> declaration.');
582: delete $curves[-1]->{'data'} ;
583: }
584: $curves[-1]->{'function'} =
585: &Apache::lonxml::get_all_text("/function",$$parser[-1]);
1.20 matthew 586: } elsif ($target eq 'edit') {
1.37 matthew 587: $result .= &Apache::edit::tag_start($target,$token,'Gnuplot compatible curve function');
1.22 matthew 588: my $text = &Apache::lonxml::get_all_text("/function",$$parser[-1]);
1.39 ! matthew 589: $result .= &Apache::edit::end_row().
! 590: &Apache::edit::start_spanning_row().
1.30 matthew 591: &Apache::edit::editfield('',$text,'',60,1);
1.20 matthew 592: } elsif ($target eq 'modified') {
593: # Why do I do this?
594: my $text=$$parser[-1]->get_text("/function");
595: $result.=&Apache::edit::modifiedfield($token);
1.4 matthew 596: }
1.1 matthew 597: return $result;
598: }
599:
600: sub end_function {
601: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
602: my $result = '';
1.4 matthew 603: if ($target eq 'web') {
1.20 matthew 604: } elsif ($target eq 'edit') {
1.26 matthew 605: $result .= &Apache::edit::end_table();
1.4 matthew 606: }
1.1 matthew 607: return $result;
608: }
1.21 matthew 609:
1.1 matthew 610: ##------------------------------------------------------------ curve data
611: sub start_data {
612: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
613: my $result='';
1.4 matthew 614: if ($target eq 'web') {
1.17 matthew 615: if (exists($curves[-1]->{'function'})) {
616: &Apache::lonxml::warning('Use of <data> precludes use of .'.
617: '<function>. The <function> will be omitted in favor of '.
618: 'the <data> declaration.');
619: delete($curves[-1]->{'function'});
620: }
621: my $datatext = &Apache::lonxml::get_all_text("/data",$$parser[-1]);
622: $datatext =~ s/\s+/ /g;
623: # Need to do some error checking on the @data array -
624: # make sure it's all numbers and make sure each array
625: # is of the same length.
626: my @data;
1.35 matthew 627: if ($datatext =~ /,/) { # comma deliminated
1.17 matthew 628: @data = split /,/,$datatext;
629: } else { # Assume it's space seperated.
630: @data = split / /,$datatext;
631: }
632: for (my $i=0;$i<=$#data;$i++) {
633: # Check that it's non-empty
1.19 matthew 634: if (! defined($data[$i])) {
635: &Apache::lonxml::warning(
636: 'undefined <data> value. Replacing with '.
637: ' pi/e = 1.15572734979092');
638: $data[$i] = 1.15572734979092;
639: }
1.17 matthew 640: # Check that it's a number
1.19 matthew 641: if (! &$real_test($data[$i]) & ! &$int_test($data[$i])) {
642: &Apache::lonxml::warning(
643: 'Bad <data> value of '.$data[$i].' Replacing with '.
644: ' pi/e = 1.15572734979092');
645: $data[$i] = 1.15572734979092;
646: }
1.17 matthew 647: }
1.35 matthew 648: # complain if the number of data points is not the same as
649: # in previous sets of data.
1.36 matthew 650: if (($curves[-1]->{'data'}) && ($#data != $#{@{$curves[-1]->{'data'}->[0]}})){
1.35 matthew 651: &Apache::lonxml::warning
652: ('Number of data points is not consistent with previous '.
653: 'number of data points');
654: }
1.17 matthew 655: push @{$curves[-1]->{'data'}},\@data;
1.20 matthew 656: } elsif ($target eq 'edit') {
1.37 matthew 657: $result .= &Apache::edit::tag_start($target,$token,'Comma or space deliminated curve data');
1.22 matthew 658: my $text = &Apache::lonxml::get_all_text("/data",$$parser[-1]);
1.39 ! matthew 659: $result .= &Apache::edit::end_row().
! 660: &Apache::edit::start_spanning_row().
1.30 matthew 661: &Apache::edit::editfield('',$text,'',60,1);
1.20 matthew 662: } elsif ($target eq 'modified') {
1.21 matthew 663: my $text=$$parser[-1]->get_text("/data");
664: $result.=&Apache::edit::modifiedfield($token);
1.4 matthew 665: }
1.1 matthew 666: return $result;
667: }
668:
669: sub end_data {
670: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
671: my $result = '';
1.4 matthew 672: if ($target eq 'web') {
1.20 matthew 673: } elsif ($target eq 'edit') {
1.26 matthew 674: $result .= &Apache::edit::end_table();
1.4 matthew 675: }
1.1 matthew 676: return $result;
677: }
678:
679: ##------------------------------------------------------------------- axis
680: sub start_axis {
681: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
682: my $result='';
1.4 matthew 683: if ($target eq 'web') {
1.17 matthew 684: &get_attributes(\%axis,\%axis_defaults,$parstack,$safeeval,
685: $tagstack->[-1]);
1.20 matthew 686: } elsif ($target eq 'edit') {
1.25 matthew 687: $result .= &Apache::edit::tag_start($target,$token,'Plot Axes');
1.21 matthew 688: $result .= &edit_attributes($target,$token,\%axis_defaults);
1.20 matthew 689: } elsif ($target eq 'modified') {
1.29 matthew 690: my $constructtag=&Apache::edit::get_new_args
691: ($token,$parstack,$safeeval,keys(%axis_defaults));
692: if ($constructtag) {
693: $result = &Apache::edit::rebuild_tag($token);
694: $result.= &Apache::edit::handle_insert();
695: }
1.4 matthew 696: }
1.1 matthew 697: return $result;
698: }
699:
700: sub end_axis {
701: my ($target,$token,$tagstack,$parstack,$parser,$safeeval,$style)=@_;
702: my $result = '';
1.4 matthew 703: if ($target eq 'web') {
1.20 matthew 704: } elsif ($target eq 'edit') {
1.21 matthew 705: $result.=&Apache::edit::tag_end($target,$token);
1.20 matthew 706: } elsif ($target eq 'modified') {
1.4 matthew 707: }
1.1 matthew 708: return $result;
709: }
710:
1.21 matthew 711: ###################################################################
712: ## ##
713: ## Utility Functions ##
714: ## ##
715: ###################################################################
716:
1.13 matthew 717: ##----------------------------------------------------------- set_defaults
718: sub set_defaults {
1.21 matthew 719: my ($var,$defaults) = @_;
1.13 matthew 720: my $key;
1.24 matthew 721: foreach $key (keys(%$defaults)) {
1.13 matthew 722: $var->{$key} = $defaults->{$key}->{'default'};
723: }
724: }
725:
1.1 matthew 726: ##------------------------------------------------------------------- misc
1.2 matthew 727: sub get_attributes{
1.21 matthew 728: my ($values,$defaults,$parstack,$safeeval,$tag) = @_;
1.24 matthew 729: foreach my $attr (keys(%{$defaults})) {
1.10 matthew 730: $values->{$attr} =
1.15 matthew 731: &Apache::lonxml::get_param($attr,$parstack,$safeeval);
1.10 matthew 732: if ($values->{$attr} eq '' | !defined($values->{$attr})) {
1.11 matthew 733: $values->{$attr} = $defaults->{$attr}->{'default'};
1.6 matthew 734: next;
735: }
1.10 matthew 736: my $test = $defaults->{$attr}->{'test'};
737: if (! &$test($values->{$attr})) {
1.6 matthew 738: &Apache::lonxml::warning
739: ($tag.':'.$attr.': Bad value.'.'Replacing your value with : '
1.11 matthew 740: .$defaults->{$attr}->{'default'} );
741: $values->{$attr} = $defaults->{$attr}->{'default'};
1.10 matthew 742: }
1.2 matthew 743: }
1.11 matthew 744: return ;
1.6 matthew 745: }
1.15 matthew 746: ##------------------------------------------------------- write_gnuplot_file
1.6 matthew 747: sub write_gnuplot_file {
748: my $gnuplot_input = '';
1.10 matthew 749: my $curve;
1.6 matthew 750: # Collect all the colors
751: my @Colors;
752: push @Colors, $plot{'bgcolor'};
753: push @Colors, $plot{'fgcolor'};
1.13 matthew 754: push @Colors, (defined($axis{'color'})?$axis{'color'}:$plot{'fgcolor'});
1.9 matthew 755: foreach $curve (@curves) {
756: push @Colors, ($curve->{'color'} ne '' ?
757: $curve->{'color'} :
1.13 matthew 758: $plot{'fgcolor'} );
1.6 matthew 759: }
760: # set term
761: $gnuplot_input .= 'set term gif ';
762: $gnuplot_input .= 'transparent ' if ($plot{'transparent'} eq 'on');
763: $gnuplot_input .= $plot{'font'} . ' ';
1.10 matthew 764: $gnuplot_input .= 'size '.$plot{'width'}.','.$plot{'height'}.' ';
1.6 matthew 765: $gnuplot_input .= "@Colors\n";
1.7 matthew 766: # grid
1.10 matthew 767: $gnuplot_input .= 'set grid'.$/ if ($plot{'grid'} eq 'on');
1.7 matthew 768: # border
1.9 matthew 769: $gnuplot_input .= ($plot{'border'} eq 'on'?
770: 'set border'.$/ :
771: 'set noborder'.$/ ); # title, xlabel, ylabel
1.13 matthew 772: $gnuplot_input .= "set output\n";
773: $gnuplot_input .= "set title \"$title\"\n" if (defined($title)) ;
774: $gnuplot_input .= "set xlabel \"$xlabel\"\n" if (defined($xlabel));
775: $gnuplot_input .= "set ylabel \"$ylabel\"\n" if (defined($ylabel));
1.23 matthew 776: if (%axis) {
1.13 matthew 777: $gnuplot_input .= "set xrange \[$axis{'xmin'}:$axis{'xmax'}\]\n";
778: $gnuplot_input .= "set yrange \[$axis{'ymin'}:$axis{'ymax'}\]\n";
1.6 matthew 779: }
780: # Key
1.23 matthew 781: if (%key) {
1.9 matthew 782: $gnuplot_input .= 'set key '.$key{'pos'}.' ';
783: if ($key{'title'} ne '') {
1.11 matthew 784: $gnuplot_input .= 'title "'.$key{'title'}.'" ';
785: }
786: $gnuplot_input .= ($key{'box'} eq 'on' ? 'box ' : 'nobox ').$/;
1.6 matthew 787: } else {
1.9 matthew 788: $gnuplot_input .= 'set nokey'.$/;
1.13 matthew 789: }
1.6 matthew 790: # labels
1.10 matthew 791: my $label;
1.6 matthew 792: foreach $label (@labels) {
793: $gnuplot_input .= 'set label "'.$label->{'text'}.'" at '.
1.9 matthew 794: $label->{'xpos'}.','.$label->{'ypos'}.' '.$label->{'justify'}.$/ ;
1.6 matthew 795: }
796: # curves
797: $gnuplot_input .= 'plot ';
798: my $datatext = '';
1.9 matthew 799: for (my $i = 0;$i<=$#curves;$i++) {
800: $curve = $curves[$i];
801: $gnuplot_input.= ', ' if ($i > 0);
1.6 matthew 802: if (exists($curve->{'function'})) {
1.9 matthew 803: $gnuplot_input.=
804: $curve->{'function'}.' title "'.
805: $curve->{'name'}.'" with '.
806: $curve->{'linestyle'};
1.6 matthew 807: } elsif (exists($curve->{'data'})) {
1.9 matthew 808: $gnuplot_input.= '\'-\' title "'.
809: $curve->{'name'}.'" with '.
810: $curve->{'linestyle'};
1.6 matthew 811: my @Data = @{$curve->{'data'}};
1.9 matthew 812: my @Data0 = @{$Data[0]};
813: for (my $i =0; $i<=$#Data0; $i++) {
1.10 matthew 814: my $dataset;
1.6 matthew 815: foreach $dataset (@Data) {
1.9 matthew 816: $datatext .= $dataset->[$i] . ' ';
1.6 matthew 817: }
1.9 matthew 818: $datatext .= $/;
1.6 matthew 819: }
1.9 matthew 820: $datatext .=$/;
1.6 matthew 821: }
822: }
1.9 matthew 823: $gnuplot_input .= $/.$datatext;
1.10 matthew 824: return $gnuplot_input;
1.2 matthew 825: }
1.21 matthew 826:
827: #---------------------------------------------- check_inputs
828: sub check_inputs {
829: ## Note: no inputs, no outputs - this acts only on global variables.
830: ## Make sure we have all the input we need:
1.23 matthew 831: if (! %plot) { &set_defaults(\%plot,\%plot_defaults); }
832: if (! %key ) {} # No key for this plot, thats okay
1.34 matthew 833: # if (! %axis) { &set_defaults(\%axis,\%axis_defaults); }
1.21 matthew 834: if (! defined($title )) {} # No title for this plot, thats okay
835: if (! defined($xlabel)) {} # No xlabel for this plot, thats okay
836: if (! defined($ylabel)) {} # No ylabel for this plot, thats okay
837: if ($#labels < 0) { } # No labels for this plot, thats okay
838: if ($#curves < 0) {
839: &Apache::lonxml::warning("No curves specified for plot!!!!");
840: return '';
841: }
842: my $curve;
843: foreach $curve (@curves) {
844: if (!defined($curve->{'function'})&&!defined($curve->{'data'})){
845: &Apache::lonxml::warning("One of the curves specified did not contain any <data> or <function> declarations\n");
846: return '';
847: }
848: }
849: }
850:
1.20 matthew 851: #------------------------------------------------ make_edit
852: sub edit_attributes {
1.34 matthew 853: my ($target,$token,$defaults,$keys) = @_;
854: my ($result,@keys);
855: if ($keys && ref($keys) eq 'ARRAY') {
856: @keys = @$keys;
857: } else {
858: @keys = sort(keys(%$defaults));
859: }
860: foreach my $attr (@keys) {
1.35 matthew 861: # append a ' ' to the description if it doesn't have one already.
862: my $description = $defaults->{$attr}->{'description'};
863: $description .= ' ' if ($description !~ / $/);
1.20 matthew 864: if ($defaults->{$attr}->{'edit_type'} eq 'entry') {
1.35 matthew 865: $result .= &Apache::edit::text_arg
1.38 matthew 866: ($description,$attr,$token,
867: $defaults->{$attr}->{'size'});
1.20 matthew 868: } elsif ($defaults->{$attr}->{'edit_type'} eq 'choice') {
1.35 matthew 869: $result .= &Apache::edit::select_arg
870: ($description,$attr,$defaults->{$attr}->{'choices'},$token);
1.34 matthew 871: } elsif ($defaults->{$attr}->{'edit_type'} eq 'on_off') {
1.35 matthew 872: $result .= &Apache::edit::select_arg
873: ($description,$attr,['on','off'],$token);
1.20 matthew 874: }
1.25 matthew 875: $result .= '<br />';
1.20 matthew 876: }
877: return $result;
878: }
1.1 matthew 879:
1.21 matthew 880:
881: ###################################################################
882: ## ##
883: ## Insertion functions for editing plots ##
884: ## ##
885: ###################################################################
886:
1.20 matthew 887: #------------------------------------------------ insert_xxxxxxx
888: sub insert_plot {
1.29 matthew 889: my $result = '';
1.20 matthew 890: # plot attributes
1.29 matthew 891: $result .= "<plot \n";
1.30 matthew 892: foreach my $attr (keys(%plot_defaults)) {
1.29 matthew 893: $result .= " $attr=\"$plot_defaults{$attr}->{'default'}\"\n";
1.20 matthew 894: }
895: $result .= ">\n";
896: # Add the components
897: $result .= &insert_key();
898: $result .= &insert_axis();
1.29 matthew 899: $result .= &insert_title();
900: $result .= &insert_xlabel();
901: $result .= &insert_ylabel();
1.20 matthew 902: $result .= &insert_curve();
903: # close up the <plot>
904: $result .= "</plot>\n";
905: return $result;
906: }
907:
908: sub insert_key {
909: my $result;
1.29 matthew 910: $result .= " <key \n";
1.30 matthew 911: foreach my $attr (keys(%key_defaults)) {
1.29 matthew 912: $result .= " $attr=\"$key_defaults{$attr}->{'default'}\"\n";
1.20 matthew 913: }
914: $result .= " />\n";
915: return $result;
916: }
917:
918: sub insert_axis{
919: my $result;
920: $result .= ' <axis ';
1.30 matthew 921: foreach my $attr (keys(%axis_defaults)) {
1.29 matthew 922: $result .= " $attr=\"$axis_defaults{$attr}->{'default'}\"\n";
1.20 matthew 923: }
924: $result .= " />\n";
925: return $result;
926: }
1.28 matthew 927:
928: sub insert_title { return " <title></title>\n"; }
1.29 matthew 929: sub insert_xlabel { return " <xlabel></xlabel>\n"; }
930: sub insert_ylabel { return " <ylabel></ylabel>\n"; }
1.20 matthew 931:
932: sub insert_label {
933: my $result;
934: $result .= ' <label ';
1.30 matthew 935: foreach my $attr (keys(%label_defaults)) {
1.27 matthew 936: $result .= ' '.$attr.'="'.
1.20 matthew 937: $label_defaults{$attr}->{'default'}."\"\n";
938: }
939: $result .= " ></label>\n";
940: return $result;
941: }
942:
943: sub insert_curve {
944: my $result;
945: $result .= ' <curve ';
1.30 matthew 946: foreach my $attr (keys(%curve_defaults)) {
1.27 matthew 947: $result .= ' '.$attr.'="'.
1.20 matthew 948: $curve_defaults{$attr}->{'default'}."\"\n";
949: }
1.29 matthew 950: $result .= " ></curve>\n";
1.20 matthew 951: }
1.4 matthew 952:
1.20 matthew 953: sub insert_function {
954: my $result;
955: $result .= "<function></function>\n";
956: return $result;
957: }
1.4 matthew 958:
1.20 matthew 959: sub insert_data {
960: my $result;
961: $result .= " <data></data>\n";
962: return $result;
963: }
1.4 matthew 964:
1.21 matthew 965: ##----------------------------------------------------------------------
1.20 matthew 966: 1;
967: __END__
1.4 matthew 968:
969:
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