home *** CD-ROM | disk | FTP | other *** search
/ Nebula 2 / Nebula Two.iso / SourceCode / MiscKit1.7.1 / MiscKit / Examples / AutoDoc / lib / perl5 / Autodoc / GenerateRTF.pm < prev    next >
Encoding:
Perl POD Document  |  1995-11-02  |  23.4 KB  |  831 lines
  1. package Autodoc::GenerateRTF;
  2.  
  3. ###############################################################################
  4. ###############################################################################
  5. ##
  6. ##    Written by Adam Swift (c) 1995 by Friday Software and Consulting
  7. ##                           All rights reserved.
  8. ##
  9. ##      This notice may not be removed from this source code.
  10. ##
  11. ##    This program is included in the MiscKit by permission from the author
  12. ##    and its use is governed by the MiscKit license, found in the file
  13. ##    "LICENSE.rtf" in the MiscKit distribution.  Please refer to that file
  14. ##    for a list of all applicable permissions and restrictions.
  15. ##
  16. ##    Because AutoDoc is licensed free of charge, there is no warranty 
  17. ##    for the program.  Copyright holder, Friday Software and Consulting, 
  18. ##    is providing this program "as is" and this program is distributed in 
  19. ##    the hope that it will be useful, but WITHOUT ANY WARRANTY; without 
  20. ##    even the implied warranty of MERCHANTABILITY or FITNESS FOR A 
  21. ##    PARTICULAR PURPOSE.
  22. ##
  23. ###############################################################################
  24. ###############################################################################
  25.  
  26. require 5.000;
  27.  
  28. ##########################
  29. # load required packages #
  30. ##########################
  31. use Exporter;
  32. # use Autodoc::DumpDocs;
  33.  
  34. @ISA      = qw(Exporter);
  35. @EXPORT   = qw(rtf_fileheader
  36.                rtf_filefooter
  37.                rtf_fonttable
  38.                rtf_stylesheet
  39.                rtf_spacer
  40.                rtf_head
  41.                rtf_title
  42.                rtf_subtitle
  43.                rtf_paragraph
  44.                rtf_synopsis
  45.                rtf_majorheading
  46.                rtf_minorheading
  47.                rtf_synopsis
  48.                rtf_keyvalue
  49.                rtf_methodline
  50.                rtf_format_words
  51.                rtf_format_method
  52.                rtf_boldify
  53.                rtf_italicize
  54.                rtf_copyright
  55.                rtf_emdash
  56.                rtf_setfont_times
  57.                rtf_setfont_helvetica
  58.                rtf_newline
  59.                rtf_newline_small
  60.                rtf_newline_micro
  61.               );
  62.  
  63. $module_version = '$Revision: 1.3 $';
  64. $module_version =~ s!(\$\w+: | \$)!!g;
  65. $module_id        = '$Id: GenerateRTF.pm,v 1.3 1995/10/20 22:16:26 aswift Exp $';
  66. $module_id      =~ s!(\$\w+: | \$)!!g;
  67. $module_name    = $module_id;
  68. $module_name    =~ s!^([^\,]+).*$!$1!;
  69.  
  70. ############################################################################
  71. # 
  72. # Purpose: Module that encapsulates generation of RTF specific syntax to 
  73. #          produce different paragraph and text styles for documentation
  74. #
  75. # HISTORY: START
  76. # $Log: GenerateRTF.pm,v $
  77. # Revision 1.3  1995/10/20  22:16:26  aswift
  78. # Added DevMan style changes Log support
  79. #
  80. #
  81. # HISTORY: END
  82. ############################################################################
  83.  
  84.  
  85. #############################################################################
  86. #
  87. # NAME:       module_version
  88. #
  89. # ACTION:     returns the version number of this module
  90. #
  91. # RETURN:     the module version
  92. #
  93. #############################################################################
  94. sub module_version
  95. {
  96.     return $module_version;
  97. }
  98.  
  99. sub module_versionstamp
  100. {
  101.     return "$module_name (rev-$module_version)";
  102. }
  103.  
  104.  
  105. #############################################################################
  106. #
  107. # NAME:      rtf_paragraph
  108. #
  109. # ACTION:    Takes a string argument and formats it for rtf formatted output
  110. #            as the basic format style.
  111. #
  112. #            This includes calling rtf_format_words to boldify & italicize
  113. #            words.
  114. #
  115. #            Reformat the text passed to this subroutine to turn the newline 
  116. #            markers into real newlines, and generally make paragraphs 
  117. #            look better.
  118. #
  119. # RETURN:    Returns the formatted string
  120. #
  121. #############################################################################
  122. sub rtf_paragraph
  123.   {    
  124.     my ($paragraph)        = $_[0];
  125.     my ($rtf_paragraph)    = "";
  126.     my ($listRTF)    = "";
  127.  
  128.     $rtf_paragraph = '\fs36 \pard \s0 \li2116 \fi0 \ri1007 \ql \tx2494 ';
  129.     $rtf_paragraph .= '\tx2872 \tx3250 ';
  130.     $rtf_paragraph .= rtf_setfont_times();
  131.  
  132.     $listRTF = '\pard \s11 \li7648 \fi-5131 \ri1007 \ql \tx7648 ';
  133.     $listRTF .= "\\tx10180 \\fs16 \\\n \\fs28 ";
  134.  
  135.     # Make all space-runs into single spaces
  136.     $paragraph =~ s/ +/ /g;
  137.  
  138.     # make all spaces following a period (+ end paren) double spaces
  139.     $paragraph =~ s/\.(\)?) /\.$1  /g;
  140.  
  141.     # Make newline markers into rtf compatible newlines
  142.     $paragraph =~ s/\\n\s*/\\\n\\fs16 \\\n\\fs28 /g;
  143.  
  144.     # Boldify and Italicize the words, THIS REFORMATS '}' CURLY BRACES as '\}'
  145.     $paragraph = rtf_format_words ($paragraph); 
  146.  
  147.     # Find List encodings and format the lines THE CURLY IS REPLACED WITH ' '
  148.     $paragraph =~ 
  149.       s/\_\{\s*([^\}\s]+)\s*([^\}]*)\}\s*/\{$listRTF $1\t$2 \}\n /g;
  150.  
  151.     $rtf_paragraph .= $paragraph;
  152.     $rtf_paragraph .= " " . rtf_newline();
  153.  
  154.     return "$rtf_paragraph";
  155.   }
  156.  
  157.  
  158. #############################################################################
  159. #
  160. # NAME:       rtf_majorheading
  161. #
  162. # ACTION:     takes a string and wraps it into an rtf formatted string in the
  163. #             major heading style
  164. #
  165. # RETURN:     returns the rtf formatted string
  166. #
  167. #############################################################################
  168. sub rtf_majorheading
  169.   {
  170.     my ($majhead)     = $_[0];
  171.     my ($rtf_majhead) = "";
  172.  
  173.     $rtf_majhead = rtf_spacer();
  174.     $rtf_majhead .= rtf_setfont_helvetica(18);
  175.     $rtf_majhead .= rtf_boldify($majhead);
  176.     $rtf_majhead .= rtf_newline() . rtf_newline_small();
  177.  
  178.     return $rtf_majhead;
  179.   }
  180.  
  181.  
  182. #############################################################################
  183. #
  184. # NAME:       rtf_minorheading
  185. #
  186. # ACTION:     takes a string and wraps it into an rtf formatted string in the
  187. #             minor heading style
  188. #
  189. # RETURN:     returns the rtf formatted string
  190. #
  191. #############################################################################
  192. sub rtf_minorheading
  193.   {
  194.     my ($minhead)     = $_[0];
  195.     my ($rtf_minhead) = "";
  196.  
  197.     $rtf_minhead = '\pard \tx2116 \tx6148 \tx6794 \tx7440 \tx8086 \tx9378';
  198.     $rtf_minhead .= '\li6148 \fi-4421 \fc0 \cf0 ';
  199.     $rtf_minhead .= rtf_setfont_helvetica(10);
  200.     $rtf_minhead .= rtf_boldify($minhead) . rtf_newline();
  201.  
  202.     return $rtf_minhead;
  203.   }
  204.  
  205.  
  206. #############################################################################
  207. #
  208. # NAME:       rtf_synopsis
  209. #
  210. # ACTION:     returns the text passed in (if any) prepended with the
  211. #             rtf formatting to set text into the sysnopsis style.
  212. #
  213. #############################################################################
  214. sub rtf_synopsis
  215.   {
  216.     my ($synopsis) = "";
  217.     my ($rtf_synopsis) = "";
  218.     
  219.     $synopsis = $_[0]
  220.       if (scalar @_);
  221.     $rtf_synopsis = '\pard \s11 \li6148 \fi-4031 \ri1007 \ql ';
  222.     $rtf_synopsis .= '\tx7440 \tx8086 \tx8732 \tx9378 \tx10024 \tx10670';
  223.     $rtf_synopsis .= rtf_setfont_times();
  224.     $rtf_synopsis .= "\n" . $synopsis . rtf_newline()
  225.       if ($synopsis);
  226.     
  227.     return $rtf_synopsis;
  228.   }
  229.  
  230. #############################################################################
  231. #
  232. # NAME:       rtf_keyvalue
  233. #
  234. # ACTION:     returns the text passed in (if any) prepended with the
  235. #             rtf formatting to set text into the keyvalue style.
  236. #
  237. #############################################################################
  238. sub rtf_keyvalue
  239.   {
  240.     my ($keyvalue) = "";
  241.     my ($rtf_keyvalue) = "";
  242.     
  243.     $keyvalue = $_[0]
  244.       if (scalar @_);
  245.     $rtf_keyvalue = '\pard \s11 \li6148 \fi-4031 \ri1007 \ql \tx6148 ';
  246.     $rtf_keyvalue .= rtf_setfont_times();
  247.     $rtf_keyvalue .= "\n" . $keyvalue . rtf_newline()
  248.       if ($keyvalue);
  249.     
  250.     return $rtf_keyvalue;
  251.   }
  252.  
  253. #############################################################################
  254. #
  255. # NAME:       rtf_methodline
  256. #
  257. # ACTION:     returns the text passed in (if any) prepended with the
  258. #             rtf formatting to set text into the methodline style.
  259. #
  260. #############################################################################
  261. sub rtf_methodline
  262.   {
  263.     my ($methodline) = "";
  264.     my ($rtf_methodline) = "";
  265.     
  266.     $methodline = $_[0]
  267.       if (scalar @_);
  268.  
  269.     $rtf_methodline = '\pard \tx3240 \li2100 \fi-760 \li3240';
  270.     $rtf_methodline .= rtf_setfont_times();
  271.     $rtf_methodline .= "\n" . $methodline . rtf_newline_small()
  272.       if ($methodline);
  273.     
  274.     return $rtf_methodline;
  275.   }
  276.  
  277. #############################################################################
  278. #
  279. # NAME:      rtf_subtitle
  280. #
  281. # ACTION:    takes a string and wraps it into a rtf formatted string in the 
  282. #            subtitle style (bold helvetica).  
  283. #            If more than one string is passed as an argument,
  284. #            a tab is inserted before each of the following strings,
  285. #            and they are set in plain times-roman, with no two on one line.
  286. #
  287. # RETURN:    returns the rtf formatted string
  288. #
  289. #############################################################################
  290. sub rtf_subtitle
  291.   {
  292.     my ($subtitle)       = shift (@_);
  293.     my (@substrings)   = @_;
  294.     my ($string)       = "";
  295.     my ($rtf_subtitle) = "";
  296.     
  297.     $rtf_subtitle = '\pard \s17 \li4888 \fi-2771 \ri1007 \ql \tx4888 ';
  298.     $rtf_subtitle .= rtf_setfont_helvetica();
  299.     $rtf_subtitle .= rtf_boldify($subtitle);
  300.     $rtf_subtitle .= rtf_setfont_times();
  301.  
  302.     foreach $string (@substrings) {
  303.       $rtf_subtitle .= "\t" . $string;
  304.       $rtf_subtitle .= rtf_newline()
  305.     }
  306.     $rtf_subtitle .= rtf_newline()
  307.       if (!(scalar (@substrings)));
  308.     
  309.     return $rtf_subtitle;
  310.   }
  311.  
  312. #############################################################################
  313. #
  314. # NAME:      rtf_title
  315. #
  316. # ACTION:    Takes a string and wraps it into a rtf formatted string in the 
  317. #            title style
  318. #
  319. # RETURN:    returns the rtf formatted string
  320. #
  321. #############################################################################
  322. sub rtf_title
  323.   {
  324.     my ($title)        = $_[0];
  325.     my ($rtf_title)    = "";
  326.  
  327.     $rtf_title = rtf_newline_small(3);
  328.     $rtf_title .= '\pard \s5 \li2116 \fi0 \ri1007 \ql ';
  329.     $rtf_title .= rtf_setfont_helvetica(28);
  330.     $rtf_title .= rtf_boldify($title) . rtf_newline();
  331.     $rtf_title .= rtf_newline_small(5);
  332.  
  333.     return $rtf_title;
  334.   }
  335.  
  336.  
  337. #############################################################################
  338. #
  339. # NAME:      rtf_head
  340. #
  341. # ACTION:    Takes a string and wraps it into a rtf formatted string in the
  342. #            head style.
  343. #
  344. # RETURN:    returns the rtf formatted string.
  345. #
  346. #############################################################################
  347. sub rtf_head
  348.   {
  349.     my ($head) = $_[0];
  350.     my ($rtf_head);
  351.  
  352.     $rtf_head = '\li0 \fi0 \ri0 \ql \sb0 ' . rtf_setfont_times(12);
  353.     $rtf_head .= "\n$head" . rtf_newline();
  354.     
  355.     return $rtf_head;
  356.   }
  357.  
  358.  
  359. #############################################################################
  360. #
  361. # NAME:      rtf_spacer
  362. #
  363. # ACTION:    returns a standard 5 line rtf spacer  
  364. #
  365. # RETURN:    a string representation of the spacer
  366. #
  367. #############################################################################
  368. sub rtf_spacer
  369.   {
  370.     my ($spacer) = "";
  371.  
  372.     $spacer = '\pard \s13 \li1360 \fi0 \ri1007 \ql \fs16 ';
  373.     $spacer .= rtf_newline(4);
  374.     return $spacer;
  375.   }
  376.  
  377. #############################################################################
  378. #
  379. # NAME:       rtf_fileheader
  380. #
  381. # ACTION:     Returns the text group that defines a rtf file header suitible
  382. #             for the documentation format specified by autodoc
  383. #
  384. # RETURN:     The string containing the RTF group defining the file header
  385. #
  386. #############################################################################
  387. sub rtf_fileheader
  388. {
  389.     local ($header);
  390.  
  391.     $header = '{\rtf0\ansi';
  392.     $header .= '\paperw16228 \paperh18648 \margl-907 \margr0 \margt0 \margb0';
  393.  
  394.     return $header;
  395. }
  396.  
  397.  
  398. #############################################################################
  399. #
  400. # NAME:       rtf_filefooter
  401. #
  402. # ACTION:     Returns the text group that defines a rtf file footer suitible
  403. #             for the documentation format specified by autodoc
  404. #
  405. # RETURN:     The string containing the RTF group defining the file footer
  406. #
  407. #############################################################################
  408. sub rtf_filefooter
  409. {
  410.     local ($footer);
  411.  
  412.     $footer = '}';
  413.  
  414.     return $footer;
  415. }
  416.  
  417.  
  418. #############################################################################
  419. #
  420. # NAME:       rtf_fonttable
  421. #
  422. # ACTION:     Returns the text group that defines a font table suitible for
  423. #             documentation in Rich Text Format
  424. #
  425. # RETURN:     The string containing the RTF group defining the font table
  426. #
  427. #############################################################################
  428. sub rtf_fonttable
  429. {
  430.     local ($fonttbl);
  431.     
  432.     $fonttbl = '{\fonttbl';
  433.     $fonttbl .= '\f0\fswiss Helvetica;';
  434.     $fonttbl .= '\f1\froman Times;';
  435.     $fonttbl .= '\f2\fmodern Courier;';
  436.     $fonttbl .= '\f3\ftech Symbol;}';
  437.     
  438.     return $fonttbl;
  439. }
  440.  
  441.  
  442. #############################################################################
  443. #
  444. # NAME:       rtf_stylesheet
  445. #
  446. # ACTION:     Returns the text group that defines a style sheet suitible for
  447. #             documentation in Rich Text Format
  448. #
  449. # RETURN:     The string containing the RTF group defining the style sheet
  450. #
  451. #############################################################################
  452. sub rtf_stylesheet
  453. {
  454.     local ($ss);
  455.  
  456.     $ss = '{\stylesheet';
  457.     $ss .= '{\s0 \li2116 \fi0 \ri1007 \ql \tx2494 \tx2872 \tx3250   ';
  458.     $ss .= 'Body;}';
  459.     $ss .= '{\s1 \li2493 \fi0 \ri1007 \ql \tx2872 \tx3250 \tx3642   ';
  460.     $ss .= 'BodyIndented;}';
  461.     $ss .= '{\s2 \li2493 \fi-376 \ri1007 \ql \tx2494 \tx2872 \tx3250   ';
  462.     $ss .= 'BulletLong;}';
  463.     $ss .= '{\s3 \li2494 \fi-378 \ri1007 \ql   ';
  464.     $ss .= 'BulletShort;}';
  465.     $ss .= '{\s4 \li4888 \fi-2771 \ri1007 \ql \tx4888   ';
  466.     $ss .= 'CategoryOf;}';
  467.     $ss .= '{\s5 \li2116 \fi0 \ri1007 \ql   ';
  468.     $ss .= 'ClassName;}';
  469.     $ss .= '{\s6 \li2494 \fi0 \ri1007 \ql   ';
  470.     $ss .= 'CodeExamp;}';
  471.     $ss .= '{\s7 \li2872 \fi0 \ri1007 \ql   ';
  472.     $ss .= 'CodeExamp2;}';
  473.     $ss .= '{\s8 \li2116 \fi0 \ri1007 \ql   ';
  474.     $ss .= 'CodeExampNoInd;}';
  475.     $ss .= '{\s9 \li4888 \fi-2771 \ri1007 \ql \tx4888   ';
  476.     $ss .= 'ConformsTo;}';
  477.     $ss .= '{\s10 \li4888 \fi-2771 \ri1007 \ql   ';
  478.     $ss .= 'DeclaredIn;}';
  479.     $ss .= '{\s11 \li6148 \fi-4031 \ri1007 \ql \tx6148 \tx9676 \tx10180   ';
  480.     $ss .= 'FirstVar/TypeLine1;}';
  481.     $ss .= '{\s12 \li0 \fi0 \ri0 \ql \tx-25 \tx8290 \tx9172   ';
  482.     $ss .= 'Footer;}';
  483.     $ss .= '{\s13 \li1360 \fi0 \ri1007 \ql   ';
  484.     $ss .= 'Heading;}';
  485.     $ss .= '{\s14 \li4888 \fi-2771 \ri1007 \ql \tx4888   ';
  486.     $ss .= 'ImplementedBy;}';
  487.     $ss .= '{\s15 \li2116 \fi0 \ri1007 \ql   ';
  488.     $ss .= 'Important;}';
  489.     $ss .= '{\s16 \li4888 \fi-2771 \ri1007 \ql \tx4888   ';
  490.     $ss .= 'Incorporates;}';
  491.     $ss .= '{\s17 \li4888 \fi-2771 \ri1007 \ql   ';
  492.     $ss .= 'InheritsFrom;}';
  493.     $ss .= '{\s18 \li2116 \fi0 \ri1007 \ql \tx2872   ';
  494.     $ss .= 'InstanceVar;}';
  495.     $ss .= '{\s19 \li2493 \fi-376 \ri1007 \ql   ';
  496.     $ss .= 'Method;}';
  497.     $ss .= '{\s20 \li3249 \fi-756 \ri1007 \ql   ';
  498.     $ss .= 'MethodDesc;}';
  499.     $ss .= '{\s21 \li2493 \fi-376 \ri1007 \ql   ';
  500.     $ss .= 'MethodFirst;}';
  501.     $ss .= '{\s22 \li2116 \fi0 \ri1007 \ql   ';
  502.     $ss .= 'Note;}';
  503.     $ss .= '{\s23 \li2493 \fi-376 \ri1007 \ql \tx2494 \tx2872 \tx3250   ';
  504.     $ss .= 'Num1Long;}';
  505.     $ss .= '{\s24 \li2494 \fi-378 \ri1007 \ql   ';
  506.     $ss .= 'Num1Short;}';
  507.     $ss .= '{\s25 \li2493 \fi-376 \ri1007 \ql   ';
  508.     $ss .= 'NumLong;}';
  509.     $ss .= '{\s26 \li2494 \fi-378 \ri1007 \ql   ';
  510.     $ss .= 'NumShort;}';
  511.     $ss .= '{\s27 \li2116 \fi0 \ri1007 \ql   ';
  512.     $ss .= 'SeeAlso;}';
  513.     $ss .= '{\s28 \li2493 \fi-376 \ri1007 \ql   ';
  514.     $ss .= 'Step;}';
  515.     $ss .= '{\s29 \li2493 \fi-376 \ri1007 \ql   ';
  516.     $ss .= 'Step1;}';
  517.     $ss .= '{\s30 \li2116 \fi0 \ri1007 \ql   ';
  518.     $ss .= 'SubHeading;}';
  519.     $ss .= '{\s31 \li2494 \fi0 \ri1007 \ql \tx6148 \tx10180   ';
  520.     $ss .= 'TableBody1;}';
  521.     $ss .= '{\s32 \li6148 \fi-3654 \ri1007 \ql \tx6148 \tx10432   ';
  522.     $ss .= 'TableBody2;}';
  523.     $ss .= '{\s33 \li2493 \fi0 \ri1007 \ql \tx6148 \tx10180   ';
  524.     $ss .= 'TableHead;}';
  525.     $ss .= '{\s34 \li6652 \fi-503 \ri1007 \ql \tx9676 \tx10180   ';
  526.     $ss .= 'Var/Type;}';
  527.     $ss .= '{\s35 \li6148 \fi-4031 \ri1007 \ql \tx6148 \tx9676 \tx10180   ';
  528.     $ss .= 'Var/TypeLine1;}';
  529.     $ss .= '{\s36 \li2116 \fi-2015 \ri1007 \ql \tx806 \tx2116   ';
  530.     $ss .= 'Warning;}';
  531.     $ss .= '}';
  532.     return $ss;
  533. }
  534.  
  535.  
  536. #############################################################################
  537. #
  538. # NAME:       rtf_format_method
  539. #
  540. # ACTION:     Process the method string passed in to format it with bold and 
  541. #             italics.  Return the converted method string and a space 
  542. #             separated list of arguments to the method.
  543. #
  544. # RETURN:     An array of two elements, the method as a formatted rtf string 
  545. #             and a string with all of the arguments to the method separated
  546. #             with spaces.
  547. #
  548. #############################################################################
  549. sub rtf_format_method
  550.   {
  551.     my ($method)         = $_[0];
  552.     my ($rtf_method)     = "";
  553.     my ($marg)             = "";
  554.     my ($method_args)     = "";
  555.     my ($marg_separator) = " ";
  556.     
  557.     if ($method =~ m!^\-!) {
  558.       $rtf_method = rtf_emdash() . " ";
  559.     } else {
  560.       $rtf_method = "+ ";
  561.     }
  562.  
  563.     # check if the method line is so long it should be broken accross lines
  564.     if (length($method) > 60) {
  565.       $marg_separator = rtf_newline() . "\t";
  566.     }
  567.  
  568.     # remove the + or -
  569.     $method =~ s!^[\+\-]!!;
  570.  
  571.     # boldify the method name AFTER the return value type casting (if any)
  572.     if ($method =~ m!^\(!) {
  573.       $method =~ s!^(\([^\)]+\))\s*!!;
  574.       $rtf_method .= $1;
  575.     }
  576.     $method =~ s!^[^\:]*!!;
  577.     $rtf_method .= rtf_boldify ($&);
  578.  
  579.     # format the method arguments, their types, and titles
  580.     while ($method =~ m!^:!) {
  581.       
  582.       # extract the colon - oww!
  583.       $method =~ s!:!!;    
  584.       $rtf_method .= rtf_boldify (":");
  585.       
  586.       # extract the type casting (if any)
  587.       if ($method =~ m!^\s*\(!) {
  588.         $method =~ s!\s*(\([^\)]+\))\s*!!;
  589.         $rtf_method .= "$1";
  590.       }
  591.  
  592.       # extract the argument and add it to the list of method arguments
  593.       $method =~ s!\s*(\S*)!!;
  594.       $marg = $1;
  595.       $method_args .= "$marg ";
  596.       $rtf_method .= rtf_italicize ($marg);
  597.       
  598.       # check for a title for the next argument
  599.       if ($method =~ m!:!) {
  600.         $method =~ s!([^:]*)!!;
  601.         $rtf_method .= $marg_separator . rtf_boldify ($1);
  602.       }        
  603.     } 
  604.     $rtf_method .= rtf_newline();
  605.     
  606.     return ($rtf_method, $method_args);
  607.   }
  608.  
  609.  
  610. #############################################################################
  611. #
  612. # NAME:       rtf_format_words
  613. #
  614. # ACTION:     Process string passed in to format special words as bold or 
  615. #             italics.  Return the converted string.
  616. #
  617. # RETURN:     The formatted rtf string
  618. #
  619. #############################################################################
  620. sub rtf_format_words
  621.   {
  622.     my ($text) = " $_[0] ";        # Add spaces to help with matching 
  623.     my (@bold_words, @italic_words);
  624.  
  625.     @bold_words      = Autodoc::DumpDocs::doc_bold_words();
  626.     @italic_words = Autodoc::DumpDocs::doc_italic_words();
  627.  
  628.     # boldify text of the form #{the text}
  629.     $text =~ s/\#\{([^\}]+)\}/\\b $1\\b0 /g;
  630.  
  631.     # italicize text of the form %{the text}
  632.     $text =~ s/\%\{([^\}]+)\}/\\i $1\\i0 /g;
  633.  
  634.     # boldify words which start with a "#" in front of them
  635.     $text =~ s/([^\\])\#([\w\:]+)/$1\\b $2\\b0 /g
  636.       while ($text =~ m/[^\\]\#[\w\:]+/);
  637.  
  638.     # italicize words which start with a "%" in front of them
  639.     $text =~ s/([^\\])\%([\w]+)/$1\\i $2\\i0 /g
  640.       while ($text =~ m/[^\\]\%[\w]+/);
  641.     
  642.     # italicize words in the $format_italicwords array
  643.     foreach $word (@italic_words) {
  644.       $text =~ s/(\W)$word(\W)/$1\\i $word\\i0 $2/g;
  645.     }
  646.     
  647.     # boldify words in the $format_boldwords array
  648.     foreach $word (@bold_words) {
  649.       $text =~ s/(\W)$word(\W)/$1\\b $word\\b0 $2/g;
  650.     }
  651.  
  652.     # Reformat curly braces so they don't prematurely end the rtf doc.
  653.     $text =~ s/\}/\\\}/g;
  654.  
  655.     # Reformat '\%' and '\#' to just '%' and '#'
  656.     $text =~ s/\\([\#\%])/$1/g;
  657.     
  658.     # Remove the spaces we added before.
  659.     $text =~ s/^\s+//;
  660.     $text =~ s/\s+$//;
  661.     return $text;
  662.   }
  663.  
  664.  
  665. #############################################################################
  666. #
  667. # NAME:       rtf_boldify
  668. #
  669. # ACTION:     Takes a string as input, and adds rtf formatting to set the 
  670. #             string in bold. 
  671. #
  672. # RETURN:     Returns the rtf bold formatted string
  673. #
  674. #############################################################################
  675. sub rtf_boldify
  676.   {
  677.     my ($string) = $_[0];
  678.     return ("\\b " . $string . "\\b0 ");
  679.   }
  680.  
  681.  
  682. #############################################################################
  683. #
  684. # NAME:       rtf_italicize
  685. #
  686. # ACTION:     Takes a string as input, and adds rtf formatting to set the 
  687. #             string in italics. 
  688. #
  689. # RETURN:     Returns the rtf italic formatted string
  690. #
  691. #############################################################################
  692. sub rtf_italicize
  693.   {
  694.     my ($string) = $_[0];
  695.     return ("\\i " . $string . "\\i0 ");
  696.   }
  697.  
  698.  
  699. #############################################################################
  700. #
  701. # NAME:       rtf_setfont_times
  702. #
  703. # ACTION:     Returns a string to change the rtf font to times-roman 14pt
  704. #
  705. #############################################################################
  706. sub rtf_setfont_times
  707.   {
  708.     my ($fontsize) = 28;
  709.     
  710.     if (scalar (@_)) {
  711.       $fontsize = $_[0] * 2;
  712.     }
  713.     return ("\\f1 \\fs" . $fontsize . " ");
  714.   }
  715.  
  716.  
  717. #############################################################################
  718. #
  719. # NAME:       rtf_setfont_helvetica
  720. #
  721. # ACTION:     Returns a string to change the rtf font to helvetica 14pt
  722. #             If an argument is passed, we set the font size to that point
  723. #             size (which appears as double that font size in 'rtf-land')
  724. #
  725. #############################################################################
  726. sub rtf_setfont_helvetica
  727.   {
  728.     my ($fontsize) = 28;
  729.     
  730.     if (scalar (@_)) {
  731.       $fontsize = $_[0] * 2;
  732.     }
  733.     return ("\\f0 \\fs" . $fontsize . " ");
  734.   }
  735.  
  736.  
  737.  
  738. #############################################################################
  739. #
  740. # NAME:       rtf_copyright
  741. #
  742. # ACTION:     Returns the rtf string which produces a copyright symbol
  743. #
  744. #############################################################################
  745. sub rtf_copyright
  746.   {
  747.     return "\\f3 \\'e3\\f1 ";
  748.   }
  749.  
  750.  
  751. #############################################################################
  752. #
  753. # NAME:       rtf_emdash
  754. #
  755. # ACTION:     Returns the rtf string which produces a em-dash symbol
  756. #
  757. #############################################################################
  758. sub rtf_emdash
  759.   {
  760.     return "{\\f3 -}";
  761.   }
  762.  
  763.  
  764. #############################################################################
  765. #
  766. # NAME:       rtf_newline_micro
  767. #
  768. # ACTION:     Returns the rtf string which produces a 4pt font size newline
  769. #             if a numerical argument is passed, that number of newlines is
  770. #             output.
  771. #
  772. #############################################################################
  773. sub rtf_newline_micro
  774.   {
  775.     my ($num) = "";
  776.     my ($out) = "\\\n";
  777.  
  778.     if (scalar (@_) > 0) {
  779.       for ($num = $_[0]; $num > 1; $num --) {
  780.         $out .= "\\\n";
  781.       }
  782.     }
  783.     return ("\{\\fs8 " . $out . "\}");
  784.   }
  785.  
  786. #############################################################################
  787. #
  788. # NAME:       rtf_newline_small
  789. #
  790. # ACTION:     Returns the rtf string which produces a 8pt font size newline
  791. #             if a numerical argument is passed, that number of newlines is
  792. #             output.
  793. #
  794. #############################################################################
  795. sub rtf_newline_small
  796.   {
  797.     my ($num) = "";
  798.     my ($out) = "\\\n";
  799.  
  800.     if (scalar (@_) > 0) {
  801.       for ($num = $_[0]; $num > 1; $num --) {
  802.         $out .= "\\\n";
  803.       }
  804.     }
  805.     return ("\{\\fs16 " . $out . "\}");
  806.   }
  807.  
  808. #############################################################################
  809. #
  810. # NAME:       rtf_newline
  811. #
  812. # ACTION:     Returns the rtf string which produces a rtf formatted newline
  813. #             if a numerical argument is passed, that number of newlines is
  814. #             output.
  815. #
  816. #############################################################################
  817. sub rtf_newline
  818.   {
  819.     my ($num) = "";
  820.     my ($out) = "\\\n";
  821.  
  822.     if (scalar (@_) > 0) {
  823.       for ($num = $_[0]; $num > 1; $num --) {
  824.         $out .= "\\\n";
  825.       }
  826.     }
  827.     return ($out);
  828.   }
  829.  
  830. 1;
  831.