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