[system] / trunk / pg / macros / PG.pl Repository:
ViewVC logotype

View of /trunk/pg/macros/PG.pl

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2166 - (download) (as text) (annotate)
Sat May 22 22:16:20 2004 UTC (15 years, 8 months ago) by dpvc
File size: 17111 byte(s)
Files needed for jsMath display mode.

    1 # This file provided the fundamental macros for the pg language
    2 # These macros define the interface between the problems written by
    3 # the professor and the processing which occurs in the script
    4 # processProblem.pl
    5 
    6 
    7 BEGIN {
    8   be_strict();
    9 }
   10 
   11 sub _PG_init{
   12 
   13 }
   14 
   15 #package PG;
   16 
   17 
   18 =head1 NAME
   19 
   20   PG.pl --- located in the courseScripts directory.
   21   Defines the Program Generating language at the most basic level.
   22 
   23 =head1 SYNPOSIS
   24 
   25   The basic PG problem structure:
   26 
   27   DOCUMENT();          # should be the first statment in the problem
   28   loadMacros(.....);   # (optional) load other macro files if needed.
   29                        # (loadMacros is defined in F<dangerousMacros.pl>)
   30 
   31   HEADER_TEXT(...);    # (optional) used only for inserting javaScript into problems.
   32 
   33   #            #  insert text of problems
   34   TEXT("Problem text to be",
   35        "displayed. Enter 1 in this blank:",
   36        ANS_RULE(1,30)  #  ANS_RULE() defines an answer blank 30 characters long.
   37                        #  It is defined in F<PGbasicmacros.pl>
   38        );
   39 
   40 
   41   ANS( answer_evalutors);  # see F<PGanswermacros.pl> for examples of answer evaluatiors.
   42 
   43   ENDDOCUMENT()        # must be the last statement in the problem
   44 
   45 
   46 
   47 =head1 DESCRIPTION
   48 
   49 As described in the synopsis, this file and the macros C<DOCUMENT()> and C<ENDDOCUMENT()> determine
   50 the interface between problems written in the PG language and the rest of B<WeBWorK>, in particular
   51 the subroutine C<createPGtext(()> in the file F<translate.pl>.
   52 
   53 C<DOCUMENT()> must be the first statement in each problem template.
   54 It  initializes variables,
   55 in particular all of the contents of the
   56 environment variable  become defined in the problem enviroment.
   57 (See
   58 L</webwork_system_html/docs/techdescription/pglanguage/PGenvironment.html>)
   59 
   60 ENDDOCUMENT() must the last executable statement in any problem template.  It returns
   61 the rendered problem, answer evaluators and other flags to the rest of B<WeBWorK>, specificially
   62 to the routine C<createPGtext()> defined in F<translate.pl>
   63 
   64 
   65 The C<HEADER_TEXT()>, C<TEXT()>, and C<ANS()> functions load the
   66 header text string, the problem text string.
   67 and the answer evaulator queue respectively.
   68 
   69 
   70 =cut
   71 
   72 
   73 #  Private variables for the PG.pl file.
   74 
   75 my ($STRINGforOUTPUT, $STRINGforHEADER_TEXT, @PG_ANSWERS, @PG_UNLABELED_ANSWERS);
   76 my %PG_ANSWERS_HASH ;
   77 
   78 # my variables are unreliable if two DOCUMENTS were to be called before and ENDDOCUMENT
   79 # there could be conflicts.  As I understand the behavior of the Apache child
   80 # this cannot occur -- a child finishes with one request before obtaining the next
   81 
   82 #   DOCUMENT must come early in every .pg file, before any answers or text are
   83 # defined.  It initializes the variables.
   84 # It can appear only once.
   85 
   86 =head2 DOCUMENT()
   87 
   88 C<DOCUMENT()> must be the first statement in each problem template.  It can
   89 only be used once in each problem.
   90 
   91 C<DOCUMENT()> initializes some empty variables and via C<INITIALIZE_PG()> unpacks the
   92 variables in the C<%envir> variable which is implicitly passed to the problem. It must
   93 be the first statement in any problem template. It
   94 also unpacks any answers submitted and places them in the C<@submittedAnswer> list,
   95 saves the problem seed in C<$PG_original_problemSeed> in case you need it later, and
   96 initializes the pseudo random number generator object in C<$PG_random_generator>.
   97 
   98 You can reset the standard number generator using the command:
   99 
  100   $PG_random_generator->srand($new_seed_value);
  101 
  102 (See also C<SRAND> in the L<PGbasicmacros.pl> file.)
  103 
  104 The
  105 environment variable contents is defined in
  106 L</webwork_system_html/docs/techdescription/pglanguage/PGenvironment.html>
  107 
  108 
  109 =cut
  110 
  111 sub DOCUMENT {
  112 
  113   $STRINGforOUTPUT ="";
  114     $STRINGforHEADER_TEXT ="";
  115   @PG_ANSWERS=();
  116 
  117   @PG_UNLABELED_ANSWERS = ();
  118   %PG_ANSWERS_HASH = ();
  119   # FIXME:  We are initializing these variables into both Safe::Root1 (the cached safe compartment)
  120   # and Safe::Root2 (the current one)
  121   # There is a good chance they won't be properly updated in one or the other of these compartments.
  122 
  123 #   @main::PG_ANSWER_ENTRY_ORDER = ();
  124 #   $main::ANSWER_PREFIX = 'AnSwEr';
  125 #   %main::PG_FLAGS=();  #global flags
  126 #   $main::showPartialCorrectAnswers = 0 unless defined($main::showPartialCorrectAnswers );
  127 #   $main::showHint = 1 unless defined($main::showHint);
  128 #   $main::solutionExists =0;
  129 #   $main::hintExists =0;
  130 #   %main::gifs_created = ();
  131   eval(q!
  132   @main::PG_ANSWER_ENTRY_ORDER = ();
  133   $main::ANSWER_PREFIX = 'AnSwEr';
  134   %main::PG_FLAGS=();  #global flags
  135   $main::showPartialCorrectAnswers = 0 unless defined($main::showPartialCorrectAnswers );
  136   $main::showHint = 1 unless defined($main::showHint);
  137   $main::solutionExists =0;
  138   $main::hintExists =0;
  139   %main::gifs_created = ();
  140 
  141     !);
  142 #    warn eval(q! "PG.pl:  The envir variable $main::{envir} is".join(" ",%main::envir)!);
  143     my $rh_envir = eval(q!\%main::envir!);
  144     my %envir    = %$rh_envir;
  145     #no strict;
  146     foreach  my  $var (keys %envir) {
  147       eval(q!$main::!.$var.q! = $main::envir{!.$var.q!}! );  #whew!! makes sure $var is interpolated but $main:: is evaluated at run time.
  148     #    warn eval(q! "var $var is defined ". $main::!.$var);
  149         warn "Problem defining ", q{\$main::}.$var, " while initializing the PG problem: $@" if $@;
  150     }
  151     #use strict;
  152     #FIXME these strict pragmas don't seem to be needed and they cause trouble in perl 5.6.0
  153 
  154 
  155 
  156     eval(q!
  157   @main::submittedAnswers = @{$main::refSubmittedAnswers} if defined($main::refSubmittedAnswers);
  158   $main::PG_original_problemSeed = $main::problemSeed;
  159   $main::PG_random_generator = new PGrandom($main::problemSeed) || die "Can't create random number generator.";
  160   $main::ans_rule_count = 0;  # counts questions
  161 
  162     # end unpacking of environment variables.
  163     $main::QUIZ_PREFIX = '' unless defined($main::QUIZ_PREFIX)
  164 
  165   !);
  166 #   @main::submittedAnswers = @{$main::refSubmittedAnswers} if defined($main::refSubmittedAnswers);
  167 #   $main::PG_original_problemSeed = $main::problemSeed;
  168 #   $main::PG_random_generator = new PGrandom($main::problemSeed) || die "Can't create random number generator.";
  169 #   $main::ans_rule_count = 0;  # counts questions
  170 
  171     # end unpacking of environment variables.
  172 #   $main::QUIZ_PREFIX = '' unless defined($main::QUIZ_PREFIX)
  173 
  174   $STRINGforOUTPUT = '<SCRIPT SRC="'.$main::envir{jsMathURL}.'"></SCRIPT>' . "\n" . $STRINGforOUTPUT
  175     if ($main::envir{displayMode} eq 'HTML_jsMath');
  176 
  177 }
  178 
  179 sub inc_ans_rule_count {
  180   eval(q!++$main::ans_rule_count!); # evalute at runtime to get correct main::
  181 }
  182 # HEADER_TEXT is for material which is destined to be placed in the header of the html problem -- such
  183 #   as javaScript code.
  184 
  185 =head2 HEADER_TEXT()
  186 
  187 
  188   HEADER_TEXT("string1", "string2", "string3");
  189 
  190 The C<HEADER_TEXT()>
  191 function concatenates its arguments and places them in the output
  192 header text string.  It is used for material which is destined to be placed in
  193 the header of the html problem -- such as javaScript code.
  194  It can be used more than once in a file.
  195 
  196 
  197 =cut
  198 
  199 sub HEADER_TEXT {
  200   my @in = @_;
  201   $STRINGforHEADER_TEXT .= join(" ",@in);
  202   }
  203 
  204 # TEXT is the function which defines text which will appear in the problem.
  205 # All text must be an argument to this function.  Any other statements
  206 #   are calculations (done in perl) which will not directly appear in the
  207 # output.  Think of this as the "print" function for the .pg language.
  208 # It can be used more than once in a file.
  209 
  210 =head2 TEXT()
  211 
  212   TEXT("string1", "string2", "string3");
  213 
  214 The C<TEXT()> function concatenates its arguments and places them in the output
  215 text string. C<TEXT()> is the function which defines text which will appear in the problem.
  216 All text must be an argument to this function.  Any other statements
  217 are calculations (done in perl) which will not directly appear in the
  218 output.  Think of this as the "print" function for the .pg language.
  219 It can be used more than once in a file.
  220 
  221 =cut
  222 
  223 sub TEXT {
  224   my @in = @_;
  225   $STRINGforOUTPUT .= join(" ",@in);
  226   }
  227 
  228 
  229 
  230 =head2 ANS()
  231 
  232   ANS(answer_evaluator1, answer_evaluator2, answer_evaluator3,...)
  233 
  234 Places the answer evaluators in the unlabeled answer_evaluator queue.  They will be paired
  235 with unlabeled answer rules (answer entry blanks) in the order entered.  This is the standard
  236 method for entering answers.
  237 
  238   LABELED_ANS(answer_evaluater_name1, answer_evaluator1, answer_evaluater_name2,answer_evaluator2,...)
  239 
  240 Places the answer evaluators in the labeled answer_evaluator hash.  This allows pairing of
  241 labeled answer evaluators and labeled answer rules which may not have been entered in the same
  242 order.
  243 
  244 =cut
  245 
  246 sub ANS{             # store answer evaluators which have not been explicitly labeled
  247   my @in = @_;
  248   while (@in ) {
  249          warn("<BR><B>Error in ANS:$in[0]</B> -- inputs must be references to
  250                       subroutines<BR>")
  251       unless ref($in[0]);
  252       push(@PG_ANSWERS, shift @in );
  253       }
  254 }
  255 sub LABELED_ANS {  #a better alias for NAMED_ANS
  256   &NAMED_ANS;
  257 }
  258 
  259 sub NAMED_ANS{     # store answer evaluators which have been explicitly labeled (submitted in a hash)
  260   my @in = @_;
  261   while (@in ) {
  262     my $label = shift @in;
  263     $label = eval(q!$main::QUIZ_PREFIX.$label!);
  264     my $ans_eval = shift @in;
  265     TEXT("<BR><B>Error in NAMED_ANS:$in[0]</B>
  266           -- inputs must be references to subroutines<BR>")
  267       unless ref($ans_eval);
  268     $PG_ANSWERS_HASH{$label}= $ans_eval;
  269   }
  270 }
  271 sub RECORD_ANS_NAME {     # this maintains the order in which the answer rules are printed.
  272   my $label = shift;
  273   eval(q!push(@main::PG_ANSWER_ENTRY_ORDER, $label)!);
  274   $label;
  275 }
  276 
  277 sub NEW_ANS_NAME {        # this keeps track of the answers which are entered implicitly,
  278                           # rather than with a specific label
  279     my $number=shift;
  280     my $prefix = eval(q!$main::QUIZ_PREFIX.$main::ANSWER_PREFIX!);
  281     my $label = $prefix.$number;
  282     push(@PG_UNLABELED_ANSWERS,$label);
  283     $label;
  284 }
  285 sub ANS_NUM_TO_NAME {     # This converts a number to an answer label for use in
  286                           # radio button and check box answers. No new answer
  287                           # name is recorded.
  288     my $number=shift;
  289     my $label = eval(q!$main::QUIZ_PREFIX$main::ANSWER_PREFIX$number"!);
  290     $label;
  291 }
  292 
  293 my $vecnum;
  294 
  295 sub RECORD_FORM_LABEL  {             # this stores form data (such as sticky answers), but does nothing more
  296                                      # it's a bit of hack since we are storing these in the KEPT_EXTRA_ANSWERS queue even if they aren't answers per se.
  297   my $label   = shift;             # the label of the input box or textarea
  298     eval(q!push(@main::KEPT_EXTRA_ANSWERS, $label)!); #put the labels into the hash to be caught later for recording purposes
  299     $label;
  300 }
  301 sub NEW_ANS_ARRAY_NAME {        # this keeps track of the answers which are entered implicitly,
  302                           # rather than with a specific label
  303     my $number=shift;
  304     $vecnum = 0;
  305     my $row = shift;
  306     my $col = shift;
  307 #   my $label = "ArRaY"."$number"."["."$vecnum".","."$row".","."$col"."]";
  308     my $label = "ArRaY"."$number"."__"."$vecnum".":"."$row".":"."$col"."__";
  309     push(@PG_UNLABELED_ANSWERS,$label);
  310     $label;
  311 }
  312 
  313 sub NEW_ANS_ARRAY_NAME_EXTENSION {        # this keeps track of the answers which are entered implicitly,
  314                           # rather than with a specific label
  315     my $number=shift;
  316     my $row = shift;
  317     my $col = shift;
  318     if( $row == 0 && $col == 0 ){
  319       $vecnum += 1;
  320     }
  321     #FIXME   change made to conform to HTML 4.01 standards.  "Name" attributes can only contain
  322     # alphanumeric characters,   _ : and .
  323     # Also need to make corresponding changes in PGmorematrixmacros.  grep for ArRaY.
  324     #my $label = "ArRaY"."$number"."["."$vecnum".","."$row".","."$col"."]";
  325     my $label = "ArRaY"."$number"."__"."$vecnum".":"."$row".":"."$col"."__";
  326     eval(q!push(@main::KEPT_EXTRA_ANSWERS, $label)!);#put the labels into the hash to be caught later for recording purposes
  327     $label;
  328 }
  329 
  330 # ENDDOCUMENT must come at the end of every .pg file.
  331 #   It exports the resulting text of the problem, the text to be used in HTML header material
  332 #   (for javaScript), the list of answer evaluators and any other flags.  It can appear only once and
  333 #   it MUST be the last statement in the problem.
  334 
  335 =head2 ENDDOCUMENT()
  336 
  337 ENDDOCUMENT() must the last executable statement in any problem template.  It can
  338 only appear once.  It returns
  339 an array consisting of
  340 
  341   A reference to a string containing the rendered text of the problem.
  342   A reference to a string containing text to be placed in the header
  343                (for javaScript)
  344   A reference to the array containing the answer evaluators.
  345                (May be changed to a hash soon.)
  346   A reference to an associative array (hash) containing various flags.
  347 
  348   The following flags are set by ENDDOCUMENT:
  349   (1) showPartialCorrectAnswers  -- determines whether students are told which
  350       of their answers in a problem are wrong.
  351   (2) recordSubmittedAnswers  -- determines whether students submitted answers
  352       are saved.
  353   (3) refreshCachedImages  -- determines whether the cached image of the problem
  354       in typeset mode is always refreshed (i.e. setting this to 1 means cached
  355       images are not used).
  356   (4) solutionExits   -- indicates the existence of a solution.
  357   (5) hintExits   -- indicates the existence of a hint.
  358   (6) showHintLimit -- determines the number of attempts after which hint(s) will be shown
  359 
  360   (7) PROBLEM_GRADER_TO_USE -- chooses the problem grader to be used in this order
  361     (a) A problem grader specified by the problem using:
  362         install_problem_grader(\&grader);
  363     (b) One of the standard problem graders defined in PGanswermacros.pl when set to
  364         'std_problem_grader' or 'avg_problem_grader' by the environment variable
  365         $PG_environment{PROBLEM_GRADER_TO_USE}
  366     (c) A subroutine referenced by $PG_environment{PROBLEM_GRADER_TO_USE}
  367     (d) The default &std_problem_grader defined in PGanswermacros.pl
  368 
  369 
  370 =cut
  371 
  372 sub ENDDOCUMENT {
  373 
  374     my $index=0;
  375     foreach my $label (@PG_UNLABELED_ANSWERS) {
  376         if ( defined($PG_ANSWERS[$index]) ) {
  377         $PG_ANSWERS_HASH{"$label"}= $PG_ANSWERS[$index];
  378       #warn "recording answer label = $label";
  379       } else {
  380         warn "No answer provided by instructor for answer $label";
  381       }
  382       $index++;
  383     }
  384 
  385     $STRINGforOUTPUT .="\n";
  386    eval q{  #make sure that "main" points to the current safe compartment by evaluating these lines.
  387     $main::PG_FLAGS{'showPartialCorrectAnswers'} = $main::showPartialCorrectAnswers;
  388     $main::PG_FLAGS{'recordSubmittedAnswers'} = $main::recordSubmittedAnswers;
  389     $main::PG_FLAGS{'refreshCachedImages'} = $main::refreshCachedImages;
  390     $main::PG_FLAGS{'hintExists'} = $main::hintExists;
  391     $main::PG_FLAGS{'showHintLimit'} = $main::showHint;
  392     $main::PG_FLAGS{'solutionExists'} = $main::solutionExists;
  393     $main::PG_FLAGS{ANSWER_ENTRY_ORDER} = \@main::PG_ANSWER_ENTRY_ORDER;
  394     $main::PG_FLAGS{KEPT_EXTRA_ANSWERS} = \@main::KEPT_EXTRA_ANSWERS;##need to keep array labels that don't call "RECORD_ANS_NAME"
  395     $main::PG_FLAGS{ANSWER_PREFIX} = $main::ANSWER_PREFIX;
  396     # install problem grader
  397     if (defined($main::PG_FLAGS{PROBLEM_GRADER_TO_USE}) ) {
  398       # problem grader defined within problem -- no further action needed
  399     } elsif ( defined( $main::envir{PROBLEM_GRADER_TO_USE} ) ) {
  400       if (ref($main::envir{PROBLEM_GRADER_TO_USE}) eq 'CODE' ) {         # user defined grader
  401         $main::PG_FLAGS{PROBLEM_GRADER_TO_USE} = $main::envir{PROBLEM_GRADER_TO_USE};
  402       } elsif ($main::envir{PROBLEM_GRADER_TO_USE} eq 'std_problem_grader' ) {
  403         if (defined(&std_problem_grader) ){
  404           $main::PG_FLAGS{PROBLEM_GRADER_TO_USE} = \&std_problem_grader; # defined in PGanswermacros.pl
  405         } # std_problem_grader is the default in any case so don't give a warning.
  406       } elsif ($main::envir{PROBLEM_GRADER_TO_USE} eq 'avg_problem_grader' ) {
  407         if (defined(&avg_problem_grader) ){
  408           $main::PG_FLAGS{PROBLEM_GRADER_TO_USE} = \&avg_problem_grader; # defined in PGanswermacros.pl
  409         }
  410         #else { # avg_problem_grader will be installed by PGtranslator so there is no need for a warning.
  411         # warn "The problem grader 'avg_problem_grader' has not been defined.  Has PGanswermacros.pl been loaded?";
  412         #}
  413       } else {
  414         warn "Error:  $main::PG_FLAGS{PROBLEM_GRADER_TO_USE} is not a known program grader.";
  415       }
  416     } elsif (defined(&std_problem_grader)) {
  417       $main::PG_FLAGS{PROBLEM_GRADER_TO_USE} = \&std_problem_grader; # defined in PGanswermacros.pl
  418     } else {
  419       # PGtranslator will install its default problem grader
  420     }
  421 
  422     warn "ERROR: The problem grader is not a subroutine" unless ref( $main::PG_FLAGS{PROBLEM_GRADER_TO_USE}) eq 'CODE'
  423                      or $main::PG_FLAGS{PROBLEM_GRADER_TO_USE} = 'std_problem_grader'
  424                      or $main::PG_FLAGS{PROBLEM_GRADER_TO_USE} = 'avg_problem_grader';
  425      # return results
  426     };
  427 
  428     $STRINGforOUTPUT .= '<SCRIPT> jsMath.ProcessBeforeShowing() </SCRIPT>'
  429       if ($main::envir{displayMode} eq 'HTML_jsMath');
  430 
  431   (\$STRINGforOUTPUT, \$STRINGforHEADER_TEXT,\%PG_ANSWERS_HASH,eval(q!\%main::PG_FLAGS!));
  432 }
  433 
  434 
  435 
  436 =head2 INITIALIZE_PG()
  437 
  438 This is executed each C<DOCUMENT()> is called.  For backward compatibility
  439 C<loadMacros> also checks whether the C<macroDirectory> has been defined
  440 and if not, it runs C<INITIALIZE_PG()> and issues a warning.
  441 
  442 =cut
  443 
  444 
  445 1;

aubreyja at gmail dot com
ViewVC Help
Powered by ViewVC 1.0.9