home *** CD-ROM | disk | FTP | other *** search
/ BURKS 2 / BURKS_AUG97.ISO / BURKS / LANGUAGE / ADA / LOVELACE / mklesson < prev    next >
Text File  |  1997-04-08  |  29KB  |  847 lines
  1. #!/usr/local/bin/perl -s
  2. # 
  3. # This is mklesson, a `lesson compiler.'
  4. # Mklesson takes a lesson file (.les) as its sole argument, and uses it to
  5. # generate a set of hypertext tutor files in HTML (.html) format.
  6. # The generated files are created in the current directory.
  7. # Status information is sent to standard output (which is usually the screen).
  8. #
  9. # Usage Example:
  10. #     mklesson lesson9.les
  11. #
  12. # Options:
  13. #   -a  alphabetic filenames (use "s" instead of "-" in
  14. #       generated filenames)
  15. #   -b  book
  16. #   -d  define (not implemented)
  17. #   -s  short filenames (.htm instead of .html)
  18. #
  19. # If you're generating ISO 9660 CD-ROMS, use "-s -a".
  20. #
  21. # $Id: mklesson,v 1.15 1995/08/09 21:07:40 wheeler Exp $
  22. #
  23. # See the user's guide in file userg.html and formatmk.txt.
  24. #
  25. # Input:
  26. #   (argument 1) -- filename of lesson (.les) file.
  27. #   template -- file with templates used for file generation.
  28. #   default  -- if this file exists, it is read to find default settings
  29. #               (its format is identical to a lesson header section).
  30. # 
  31. #
  32. # Output: The program generates files with the following naming patterns:
  33. #    sLESSON-SECTION.html  - text for lesson number LESSON, section SECTION.
  34. #                            If this is the last one, SECTION is "f" (final)
  35. #                            so that the next lesson can always link
  36. #                            backwards correctly (didn't use "l" for last,
  37. #                            because it looks too much like a "1").
  38. #    sLESSON-SECTIONrRESPONSENUMBER.html - text for response RESPONSENUMBER
  39. #    lessonLESSON.html    - lesson outline.
  40. #
  41. #    With the "-a" option, the dashes above become "s".
  42. #
  43. #
  44. # This program is written in the programming language perl because it's
  45. # a relatively short program that performs text processing (a perl strength),
  46. # and I wanted it to be VERY portable (perl is widely available).
  47. # Perl has some disadvantages, in particular, please be careful modifying
  48. # this program because the Perl language syntax is so awful that it's
  49. # as though it was designed to maximize error creation.
  50. #
  51. # Copyright (C) 1994 David A. Wheeler.
  52. #
  53. #    This program is free software; you can redistribute it and/or modify
  54. #    it under the terms of the GNU General Public License as published by
  55. #    the Free Software Foundation; either version 2 of the License, or
  56. #    (at your option) any later version.
  57. #
  58. #    This program is distributed in the hope that it will be useful,
  59. #    but WITHOUT ANY WARRANTY; without even the implied warranty of
  60. #    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  61. #    GNU General Public License for more details.
  62. #
  63. #    You should have received a copy of the GNU General Public License
  64. #    along with this program; if not, write to the Free Software
  65. #    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  66. #
  67. # Since mklesson is free software, if you modify this program and
  68. # then distribute it (or results generated from it) you ARE REQUIRED
  69. # to distribute & permit anyone to copy the modified version of this program.
  70. #
  71. # You CAN use this program to generate
  72. # proprietary tutorials, just as you can use gcc to generate
  73. # proprietary executables. See the GPL for more information.
  74.  
  75.  
  76. # START OF MAIN PROGRAM
  77.  
  78. if (defined($s)) {
  79.    # a "-s" option uses Short extension names (.htm).
  80.    $html_extension = ".htm";
  81. }
  82. else {
  83.    # without a "-s" option, generate ".html" extensions.
  84.    $html_extension = ".html";
  85. }
  86.  
  87. # This version has primitive support for preprocessing commands of form:
  88. # <IFDEF BOOK>
  89. # [<ELSE> ... ]
  90. # <ENDIF>
  91. # In the long term I'd like to support arbitrary preprocessing "define"
  92. # flags, but for now there only one flag, "BOOK".
  93. # You can set "BOOK" with the "-b" flag.
  94. # Eventually there will be another parameter to set arbitrary flags.
  95.  
  96. #  -b ("book") option.
  97. $is_book = 0;
  98. if (defined($b)) {
  99.  $is_book = 1;
  100. }
  101.  
  102. # book_state has one of three values:
  103. #   0 = normal text.
  104. #   1 = inside an <IFDEF BOOK>. Print only if $is_book.
  105. #   2 = inside an <ELSE> of <IFDEF BOOK>. Print only if not $is_book.
  106. $book_state = 0;
  107.  
  108. #  -a ("alphabetic") option.
  109. $alphabetic = 0;
  110. $separator= '-';
  111. if (defined($a)) {
  112.  $alphabetic = 1;
  113.  $separator= 's';
  114. }
  115.  
  116.  
  117. &initialize_variables;
  118. &read_in_template;  # Load the template file into memory.
  119. &read_in_defaults;  # Load the contents of file "default".
  120.  
  121. # Open & process the lesson file.
  122. $lesson_source=shift;
  123. &open_lesson_file;
  124. &process_input_header;
  125. &process_input_body;
  126. &change_timestamp_file($lesson_source);
  127.  
  128. &move_in_new_files;
  129.  
  130. # END OF MAIN PROGRAM
  131.  
  132.  
  133. # SUBROUTINES:
  134.  
  135. sub process_input_header {
  136.  # Process input file as a lesson header section.
  137.  # Stop processing at end-of-file or a <SECTION> marker.
  138.  # (The input file could be a "lesson" file or "default" file)
  139.  
  140.  while (&read_line) {
  141.   if (m/^ *<TUTOR .*NAME="([^"]*)"/i) {
  142.     if (($tutor_name ne "") && ($tutor_name ne $1) )
  143.        {die "Cannot redefine tutor name"};
  144.     $tutor_name=$1;
  145.     print "Tutor name is $tutor_name\n";
  146.     }
  147.   elsif (m/^ *<LESSON .*NUMBER=([0-9]+)/i) {
  148.    if ($lesson_number != 0) {die "Cannot redefine lesson number"};
  149.    $lesson_number=$1;
  150.    $lesson_outline_URL = "lesson${lesson_number}" . $html_extension;
  151.    print "Lesson number is $lesson_number\n";
  152.    }
  153.   elsif (m/^ *<AUTHOR .*NAME="([^"]*)".*EMAIL="([^"]*)"/i) {
  154.    $author_name=$1;
  155.    $author_email=$2;
  156.    print "Author name is $author_name\n";
  157.    print "Author email (address) is $author_email\n";
  158.    }
  159.   elsif (m/^ *<AUTHOR .*ADDRESS="(.*)">$/i) {
  160.    # Note: this format is slightly different, grabbing the ENTIRE line.
  161.    # This is so that the address can include anchors and such, which
  162.    # require the use of " and > characters.
  163.    $author_address=$1;
  164.    print "Author address is $author_address\n";
  165.    }
  166.   elsif (m/^ *<PREVIOUS_LESSON .*LOCATION="([^"]*)"/i) {
  167.    if ($previous_lesson_location_set != 0)
  168.        {die "Cannot redefine previous lesson location"};
  169.    $previous_lesson_location = $1;
  170.    $previous_lesson_location_set = 1;
  171.    print "Previous lesson location is $previous_lesson_location\n";
  172.    }
  173.   elsif (m/^ *<NEXT_LESSON .*LOCATION="([^"]*)"/i) {
  174.    if ($next_lesson_location_set != 0)
  175.       {die "Cannot redefine next lesson location"};
  176.    $next_lesson_location = $1;
  177.    $next_lesson_location_set = 1;
  178.    print "Next lesson location is $next_lesson_location\n";
  179.    }
  180.   elsif (m/^ *<MASTER_OUTLINE .*HREF="([^"]*)"/i) {
  181.    if ($master_outline_URL_set != 0)
  182.      {die "Cannot redefine master lesson outline URL"};
  183.    $master_outline_URL = $1;
  184.    $master_outline_URL_set = 1;
  185.    print "Master outline URL is $master_outline_URL\n";
  186.    }
  187.   elsif (m/^ *<TUTOR_HOME_PAGE .*HREF="([^"]*)"/i) {
  188.    if ($tutor_home_page_set != 0) {die "Cannot redefine tutor home page URL"};
  189.    $tutor_home_page_URL = $1;
  190.    $tutor_home_page_URL_set = 1;
  191.    print "Tutor home page URL is $tutor_home_page_URL\n";
  192.    }
  193.   elsif (m/^ *<TUTOR_MASTER_COPY_URL .*HREF="([^"]*)"/i) {
  194.    if ($tutor_master_copy_URL_set != 0)
  195.      {die "Cannot redefine tutor master copy URL"};
  196.    $tutor_master_copy_URL = $1;
  197.    $tutor_master_copy_URL_set = 1;
  198.    print "Tutor master copy URL is $tutor_master_copy_URL\n";
  199.    }
  200.   elsif (m/^<SECTION /i) {last}
  201.   elsif (m/^ *$/) {} # Do nothing with blank lines.
  202.   else {
  203.     print "WARNING: LINE IN HEADER OF FILE IGNORED, TEXT IS:";
  204.     print $_;
  205.   }
  206.  }
  207.  # We found a SECTION header or end of file. Stop processing lesson header.
  208. }
  209.  
  210. sub process_input_body {
  211.   # Process body of a lesson file (it should have 2 or more sections).
  212.  
  213.   # Errorcheck - we should have gotten TUTOR, LESSON, and AUTHOR.
  214.  
  215.   if ($lesson_number < 1)
  216.      {die "Sorry, no valid lesson number encountered!"};
  217.  
  218.   # Set up constants used in the rest of the program & open outline file.
  219.   # This is the filename for the generated outline.
  220.   $lesson_outline = "lesson${lesson_number}" . $html_extension;
  221.   if (!open(OUTLINE, ">${lesson_outline}.new"))
  222.     {die "Sorry, cannot open output lesson outline file ${lesson_outline}"};
  223.   &substitute_and_append("outline.head", "outline");
  224.  
  225.   # Process body of .les file.
  226.  
  227.   while ($_ ne "") {  # While there's still some text to process.
  228.     if (m/^<SECTION /i) { &process_section; }
  229.     else { print "Warning: text ignored outside of a