home *** CD-ROM | disk | FTP | other *** search
/ Il CD di internet / CD.iso / SOURCE / AP / JED / JED097-1.TAR / jed / lib / mkdoc.sl < prev    next >
Encoding:
Text File  |  1994-12-12  |  6.1 KB  |  252 lines
  1. % mkdoc.sl ---- load this file from JED_ROOT/lib!!!!
  2. %
  3. %  Extract documentation from .sl and .c files
  4. %  For this to work, a strict format must be followed.
  5. %  In .c files, add_intrinsic and add_variable statements are checked. The
  6. %  syntax prototype is:
  7. %
  8. %        MAKE_INTRINSIC("name", function, TYPE, n)%
  9. %        /* This is a function called name which returns TYPE
  10. %           and takes n arguments. */
  11. %
  12. %  Note that it is assummed that comments cannot be nested.
  13. %  For .sl files, the syntax follows:
  14. %
  15. %     %!% This function pops an integer n off the stack and an object s.
  16. %     %!% It returns n copies of s on the stack.
  17. %     define dupn (n, s)
  18. %     {
  19. %        loop (n) { s; } 
  20. %     }
  21. %
  22. %  Here I search for '%!%' in column 1 which make indicate a doc string and 
  23. %  then search for 'define' preceed by only whitespace.  The '%!%' must start in 
  24. %  column 1.
  25. %
  26. %  There is no ambiguity as long as the doc strings are placed BEFORE the 
  27. %  object they describe.
  28.  
  29.  
  30. %!% Extracts doc string from FILE and appends it to BUFFER.
  31. %!% Returns 0 upon failure.
  32. define mkdoc_process_sl_file (file, doc_buf)
  33. {
  34.    variable cbuf, doc_ind = "%!%", chars = "a-zA-Z0-9_$!";
  35.    variable c, ctrlm = 1, name;
  36.    variable has_proto;
  37.    
  38.    !if (read_file(file)) return 0;
  39.    cbuf = whatbuf ();
  40.  
  41.    bob ();
  42.  
  43.    while (bol_fsearch (doc_ind))
  44.      {
  45.     setbuf (doc_buf);
  46.     eob ();
  47.     !if (bolp()) newline ();
  48.     push_spot ();
  49.     setbuf (cbuf);
  50.  
  51.     go_right (3); push_mark ();
  52.     skip_white (); 
  53.     has_proto = looking_at ("Prototype: ");
  54.     while (down(1) and looking_at (doc_ind));
  55.     copy_region (doc_buf);
  56.  
  57.     
  58.     % now look for what this documents
  59.     forever 
  60.       {
  61.          bol (); skip_chars (" \t\n"); c = what_char ();
  62.          if (looking_at ("variable"))
  63.            {
  64.           go_right (strlen("variable"));
  65.           skip_white (); push_mark ();
  66.           skip_chars (chars);
  67.           name = Sprintf ("V%s ", bufsubstr(), 1);
  68.           break;
  69.            }
  70.          
  71.          if (looking_at ("define"))
  72.            {
  73.           go_right (strlen ("define"));
  74.           skip_white ();
  75.           push_mark ();
  76.           skip_chars (chars);
  77.           !if (has_proto) if (ffind (")")) go_right (1);
  78.           name = strcat ("F", bufsubstr ());
  79.           break;
  80.            }
  81.          
  82.  
  83.          !if (down (1)) error (strcat ("Error parsing ", file));
  84.       }
  85.     
  86.     %% now we have the name with the appropriate prefix.  Insert it and
  87.     %% replace newlines with ctrlm
  88.     setbuf (doc_buf);
  89.     pop_spot (); insert (name);
  90.     insert_char (ctrlm);
  91.     while (eol, not(eobp()))
  92.       {
  93.          del (); insert_char (ctrlm);
  94.       }
  95.     
  96.     newline ();
  97.     setbuf (cbuf);
  98.      }
  99.    1;
  100. }
  101.  
  102. . %% same routine for C files.  Looks for MAKE_INTRINSIC and MAKE_VARIABLE
  103. . %% macros.
  104. . (
  105. .   [file doc_buf cbuf] =doc_buf =file
  106. .   [f v name ctrlm c] 1 char =ctrlm
  107. .   
  108. .   file read_file {0 return} !if
  109. .   whatbuf =cbuf
  110. .   
  111. .   bob
  112. .   
  113. .   { 
  114. .     0 =f 0 =v
  115. .     "MAKE_" fsearch
  116. .       {
  117. .         "MAKE_INTRINSIC" looking_at =f
  118. .     "MAKE_VARIABLE" looking_at =v
  119. .       }{break} else
  120. .      
  121. .     POINT bol skip_white
  122. .     POINT - {eol continue} if %%continue if in middle of line
  123. .     %% found
  124. .     
  125. .     doc_buf setbuf 
  126. .     eob
  127. .     bolp {newline} !if
  128. .     cbuf setbuf 
  129. . 
  130. .     %% formats are MAKE_INTRINSIC(".fun", cfun, TYPE, n)
  131. .     %% and         MAKE_VARIABLE(".var", &c_var, TYPE, flag)
  132. .     %%   where the & may not be present for string variables
  133. .     
  134. .     "\"." ffind {"Corrupt file." error} !if
  135. .     2 right pop push_mark 
  136. .     "\"" ffind {"Corrupt file." error} !if
  137. .     bufsubstr " " strcat =name
  138. .     1 right pop
  139. .     
  140. .     %% if it is a function, get the c function info as well
  141. .     f { 
  142. .         "F" name strcat ":" strcat =name      %%Ffun:
  143. .         ",\t " skip_chars
  144. .         push_mark "$_A-Za-z0-9" skip_chars 
  145. .     name bufsubstr strcat ":" strcat      %%Ffun:cfun:
  146. .     ",\t " skip_chars 
  147. .     what_char char strcat ":" strcat      %%Ffun:cfun:T:
  148. .     "," ffind pop  %% assume ok
  149. .     ", \t" skip_chars push_mark "0-9" skip_chars
  150. .     bufsubstr strcat =name  %%Whew!!      %%Ffun:cfun:T:0
  151. .       }{
  152. .     "V" name strcat =name
  153. .       }
  154. .     else
  155. .     
  156. .     doc_buf setbuf name insert push_spot
  157. .     cbuf setbuf
  158. .     
  159. .     %% look for documentation
  160. .     {1 down}
  161. .     {
  162. .         bol skip_white eolp {continue} if
  163. .     "/*" looking_at {break} !if
  164. .     2 right pop
  165. .       what_column =c   
  166. .     push_mark
  167. .     "*/" fsearch pop  %% I assume it compiled 
  168. .     
  169. .     doc_buf copy_region
  170. .     doc_buf setbuf
  171. .     pop_spot 
  172. .       push_spot
  173.  
  174. .        {1 down}
  175. .        { 
  176. .           bol skip_white 
  177. .           "*" looking_at {del skip_white} if
  178. .           what_column bol trim c - {" " insert} loop 
  179. .        }
  180. .        while
  181.    
  182. .     pop_spot 
  183. .     ctrlm insert
  184.     
  185. .     {eol eobp not}
  186. .        {del ctrlm insert} while
  187. .     newline
  188. .     cbuf setbuf
  189. .     break
  190. .     } while
  191. .   } forever 
  192. .   1
  193. . ) mkdoc_process_c_file
  194. . 
  195. . 
  196. . %%% Make documentation for set of files.  Function takes as top argument
  197. . %%% the name of docfile to be produced followed by number n of files
  198. . %%% then followed by the n filenames.
  199. . (
  200. .   [docfile] =docfile
  201. .   [argc argv] =argc
  202. .   [docbuf cbuf]  whatbuf =cbuf
  203. .   [type]
  204. .   
  205. .   docfile setbuf erase_buffer
  206. .   whatbuf =docbuf
  207. .   cbuf setbuf
  208. .   
  209. .   argc 
  210. .     { 
  211. .       =argv
  212. .       argv file_type =type
  213. .       "processing " argv strcat flush
  214. .       type
  215. .         {"c" strcmp not type "C" strcmp not or 
  216. .      type "ci" strcmp not or : 
  217. .        argv docbuf mkdoc_process_c_file 
  218. .          { argv " could not be processed!" strcat error } !if
  219. .     }
  220. .         {"sl" strcmp not type "SL" strcmp not or : 
  221. .        argv docbuf mkdoc_process_sl_file 
  222. .          { argv " could not be processed!" strcat error } !if
  223. .     }
  224. .     {" File type not supported!" strcat error}
  225. .       switch
  226. .       whatbuf docbuf strcmp {whatbuf delbuf} if
  227. .     }
  228. .   loop
  229. .   
  230. .   
  231. .   docbuf setbuf 
  232. .   docfile write_buffer {"Unable to write doc file!" error} !if
  233. .   0 set_buffer_modified_flag docbuf delbuf
  234. .   cbuf setbuf
  235. . ) mkdoc
  236. . 
  237. . _stkdepth =$1
  238. . "site.sl" "buf.sl" "help.sl" "util.sl" "dired.sl" "most.sl" "fortran.sl"
  239. . "misc.sl" "tex.sl"
  240. . "../src/intrin.c" "../src/xterm.c"
  241. . "../../slang/src/slang.c"  "../../slang/src/slstd.c"  
  242. . "../../slang/src/slmath.c"
  243. #ifdef UNIX
  244. . "../../slang/src/slunix.c"
  245. #endif
  246. . _stkdepth $1 -
  247. .  % number of files listed above   
  248. .   
  249. . "jed_funs.hlp" mkdoc
  250. . exit_jed
  251.  
  252.