home *** CD-ROM | disk | FTP | other *** search
/ Nebula 2 / Nebula Two.iso / SourceCode / MiscKit1.7.1 / MiscKit / Examples / AutoDoc / lib / perl5 / Autodoc / ParseComments.pm < prev    next >
Encoding:
Perl POD Document  |  1995-11-02  |  5.5 KB  |  196 lines
  1. package Autodoc::ParseComments;
  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::ScanFile;
  33.  
  34. @ISA      = qw(Exporter);
  35. @EXPORT   = qw(parse_extractADComment
  36.            parse_extract_preADComment
  37.            parse_extract_postADComment
  38.            parse_containsADComment);
  39.  
  40. $module_version = '$Revision: 1.2 $';
  41. $module_version =~ s!(\$\w+: | \$)!!g;
  42. $module_id    = '$Id: ParseComments.pm,v 1.2 1995/10/20 22:16:28 aswift Exp $';
  43. $module_id      =~ s!(\$\w+: | \$)!!g;
  44. $module_name    = $module_id;
  45. $module_name    =~ s!^([^\,]+).*$!$1!;
  46.  
  47. ############################################################################
  48. # 
  49. # Purpose: Module that encapsulates parsing autodoc style comments out of 
  50. #          source code
  51. #
  52. # HISTORY: START
  53. # $Log: ParseComments.pm,v $
  54. # Revision 1.2  1995/10/20  22:16:28  aswift
  55. # Added DevMan style changes Log support
  56. #
  57. #
  58. # HISTORY: END
  59. ############################################################################
  60.  
  61. #############################################################################
  62. #
  63. # NAME:       module_version
  64. #
  65. # ACTION:     returns the version number of this module
  66. #
  67. # RETURN:     the module version
  68. #
  69. #############################################################################
  70. sub module_version
  71. {
  72.     return $module_version;
  73. }
  74.  
  75. sub module_versionstamp
  76. {
  77.     return "$module_name (rev-$module_version)";
  78. }
  79.  
  80. #############################################################################
  81. #
  82. # NAME:       parse_extractADComment
  83. #
  84. # ACTION:     Extracts the portion of the string argument which contains 
  85. #             an autodoc comment and processes it to remove extra whitespace
  86. #
  87. # ARGUMENTS:  The string (possibly) containing an autodoc comment
  88. #
  89. # RETURN:     The processed portion of the string which contains an autodoc 
  90. #             comment, or an empty string if no comment was found.
  91. #
  92. #############################################################################
  93. sub parse_extractADComment
  94. {
  95.     local ($ADcomment, $in);
  96.  
  97.     use Autodoc::ScanFile;
  98.  
  99.     $ADcomment = "";
  100.     $in = $_[0];
  101.  
  102.     return "" if (!($in =~ m!/\*+\"(.*)\"\*+/!));
  103.  
  104.     
  105.     $ADcomment = scan_postprocess($1);
  106.     
  107.     # remove marked newlines from the beginning of the line
  108.     $ADcomment =~ s/^\s*\\n\s*// 
  109.     while ($ADcomment =~ m/^\\n/);
  110.     
  111.     # remove marked newlines from the end of the line also
  112.     $ADcomment =~ s/\s*\\n\s*$// 
  113.     while ($ADcomment =~ m/\\n$/);    
  114.     
  115. #    $ADcomment =~ s/\s*\\n\s*\\n\s*/ \\n/g
  116. #    while ($ADcomment =~ m/\\n\s*\\n/);    
  117. #                # Remove all repeater newlines
  118.     return $ADcomment;
  119. }
  120.  
  121.  
  122. #############################################################################
  123. #
  124. # NAME:       parse_containsADComment
  125. #
  126. # ACTION:     Returns 1 if the string passed as the argument conforms to 
  127. #             the format of an autodoc comment.
  128. #
  129. # ARGUMENTS:  The string which is being tested
  130. #
  131. # RETURN:     1 if the string passed contains an autodoc comment, 0 otherwise.
  132. #
  133. #############################################################################
  134. sub parse_containsADComment
  135. {
  136.     local ($in);
  137.  
  138.     $in = $_[0];
  139.  
  140.     return 1 if ($in =~ m!/\*+\".*\"\*+/!);
  141.     return 0;
  142. }
  143.  
  144.  
  145. #############################################################################
  146. #
  147. # NAME:       parse_extract_preADComment
  148. #
  149. # ACTION:     Returns the portion of the string that preceeds the autodoc 
  150. #             comment (if any).
  151. #
  152. # ARGUMENTS:  The string which is being extracted
  153. #
  154. # RETURN:     The portion of the string that preceeds the autodoc comment, or
  155. #             an empty string.
  156. #
  157. #############################################################################
  158. sub parse_extract_preADComment
  159. {
  160.     local ($in);
  161.  
  162.     $in = $_[0];
  163.  
  164.     return $` if ($in =~ m!/\*+\".*\"\*+/!);
  165.  
  166.     return "";
  167. }
  168.  
  169.  
  170. #############################################################################
  171. #
  172. # NAME:       parse_extract_postADComment
  173. #
  174. # ACTION:     Returns the portion of the string that follows the autodoc 
  175. #             comment (if any).
  176. #
  177. # ARGUMENTS:  The string which is being extracted
  178. #
  179. # RETURN:     The portion of the string that follows the autodoc comment, or
  180. #             an empty string.
  181. #
  182. #############################################################################
  183. sub parse_extract_postADComment
  184. {
  185.     local ($in);
  186.  
  187.     $in = $_[0];
  188.  
  189.     return $' if ($in =~ m!/\*+\".*\"\*+/!);
  190.  
  191.     return "";
  192. }
  193.  
  194.  
  195. 1;
  196.