829a771997-12-06Mirar (Pontus Hagland) /* $Id: mkwmml.pike,v 1.6 1997/12/06 22:09:33 mirar Exp $ */
2974bc1997-11-10Mirar (Pontus Hagland)  import Stdio; import Array; mapping parse=([]); int illustration_counter;
829a771997-12-06Mirar (Pontus Hagland) mapping manpage_suffix= ([ "Image":"I", "Image.image":"i", "Image.colortable":"c", "Image.font":"f", ]); function verbose=werror;
2974bc1997-11-10Mirar (Pontus Hagland) #define error(X) throw( ({ (X), backtrace()[0..sizeof(backtrace())-2] }) ) /* module : mapping <- moduleM "desc" : text "see also" : array of references "note" : mapping of "desc": text "modules" : same as classes (below) "classes" : mapping class : mapping <- classM "see also" : array of references "desc" : text "note" : mapping of "desc": text "methods" : array of mappings <- methodM "decl" : array of textlines of declarations "desc" : text "returns" : textline "see also" : array of references "note" : mapping of "desc": text "known bugs" : mapping of "desc": text "args" : array of mappings <- argM "args" : array of args names and types "desc" : description "names" : multiset of method name(s) */ mapping moduleM, classM, methodM, argM, nowM, descM; mapping focM(mapping dest,string name,int line) { return dest[name] || (dest[name]=(["_line":line])); } string stripws(string s) { sscanf(s,"%*[ \t\n\r]%s",s); s=reverse(s); sscanf(s,"%*[ \t\n\r]%s",s); return reverse(s); } mapping lower_nowM() { if (nowM && (nowM==parse || nowM==classM || nowM==methodM || nowM==moduleM)) return nowM; else return nowM=methodM; } void report(string s) {
829a771997-12-06Mirar (Pontus Hagland)  verbose("mkwmml: "+s+"\n");
2974bc1997-11-10Mirar (Pontus Hagland) } #define complain(X) (X) mapping keywords= (["module":lambda(string arg,int line) { classM=descM=nowM=moduleM=focM(parse,stripws(arg),line); methodM=0; if (!nowM->classes) nowM->classes=([]); if (!nowM->modules) nowM->modules=([]); report("module "+arg); }, "class":lambda(string arg,int line) { if (!moduleM) return complain("class w/o module"); descM=nowM=classM=focM(moduleM->classes,stripws(arg),line); methodM=0; report("class "+arg); }, "submodule":lambda(string arg,int line) { if (!moduleM) return complain("submodule w/o module"); classM=descM=nowM=moduleM=focM(moduleM->modules,stripws(arg),line); methodM=0; if (!nowM->classes) nowM->classes=([]); if (!nowM->modules) nowM->modules=([]); report("submodule "+arg); }, "method":lambda(string arg,int line) { if (!classM) return complain("method w/o class"); if (!nowM || methodM!=nowM || methodM->desc || methodM->args || descM==methodM) { if (!classM->methods) classM->methods=({}); classM->methods+=({methodM=nowM=(["decl":({}),"_line":line])}); } methodM->decl+=({stripws(arg)}); descM=0; }, "arg":lambda(string arg,int line) { if (!methodM) return complain("arg w/o method"); if (!methodM->args) methodM->args=({}); methodM->args+=({argM=nowM=(["args":({}),"_line":line])}); argM->args+=({arg}); descM=argM; }, "note":lambda(string arg,int line) { if (!lower_nowM()) return complain("note w/o method, class or module"); descM=nowM->note||(nowM->note=(["_line":line])); }, "bugs":lambda(string arg,int line) { if (!lower_nowM()) return complain("bugs w/o method, class or module"); descM=nowM->bugs||(nowM->bugs=(["_line":line])); }, "see":lambda(string arg,int line) { if (arg[0..4]!="also:") return complain("see w/o 'also:'\n"); if (!lower_nowM()) return complain("see also w/o method, class or module"); nowM["see also"]=map(arg[5..]/",",stripws); }, "returns":lambda(string arg) { if (!methodM) return complain("returns w/o method"); methodM->returns=stripws(arg); descM=0; nowM=0; } ]); string getridoftabs(string s) { string res=""; for (;;) { int i; if ((i=search(s,"\t"))==-1) return res+s; res+=s[0..i-1]; s=s[i+1..]; res+=" "[(strlen(res)%8)..7]; } } object(File) make_file(string filename) { stderr->write("creating "+filename+"...\n"); if (file_size(filename)>0) { rm(filename+"~"); mv(filename,filename+"~"); } object f=File(); if (!f->open(filename,"wtc")) { stderr->write("failed."); exit(1); } return f; } string synopsis_to_html(string s) { string type,name,arg; if (sscanf(s,"%s%*[ \t]%s(%s",type,name,arg)!=4) sscanf(s,"%s(%s",name,arg),type=""; return type+" <b>"+name+"</b>("+ replace(arg,({","," "}),({", ","\240"})); } string htmlify(string s) { #define HTMLIFY(S) \ (replace((S),({"->","&","\240"}),({"-&gt;","&amp;","&nbsp;"}))) string t="",u,v; while (sscanf(s,"%s<%s>%s",u,v,s)==3) t+=HTMLIFY(u)+"<"+v+">"; return t+HTMLIFY(s); } #define linkify(S) (replace((S),({"->","()"}),({".",""}))) string make_nice_reference(string what,string prefix) { string q;
3089dc1997-11-10Mirar (Pontus Hagland)  if (what==prefix[strlen(prefix)-strlen(what)-2..strlen(prefix)-3]) { q=prefix[0..strlen(prefix)-3]; } else if (what==prefix[strlen(prefix)-strlen(what)-1..strlen(prefix)-2]) { q=prefix[0..strlen(prefix)-2]; } else if (search(what,".")==-1 && search(what,"->")==-1 && !parse[what])
8cbb141997-11-10Mirar (Pontus Hagland)  {
2974bc1997-11-10Mirar (Pontus Hagland)  q=prefix+what;
8cbb141997-11-10Mirar (Pontus Hagland)  }
2974bc1997-11-10Mirar (Pontus Hagland)  else q=what; return "<link to="+linkify(q)+">"+what+"</link>"; } string fixdesc(string s,string prefix,string where) { s=stripws(s);
87b4cb1997-11-11Mirar (Pontus Hagland)  string t,u,v,q;
2974bc1997-11-10Mirar (Pontus Hagland)  t=s; s=""; while (sscanf(t,"%s<ref>%s</ref>%s",t,u,v)==3) { s+=t+make_nice_reference(u,prefix); t=v; } s+=t; t=s; s="";
87b4cb1997-11-11Mirar (Pontus Hagland)  while (sscanf(t,"%s<illustration%s>%s</illustration>%s",t,q,u,v)==4)
2974bc1997-11-10Mirar (Pontus Hagland)  { s+=htmlify(replace(t,"\n\n","\n\n<p>"));
87b4cb1997-11-11Mirar (Pontus Hagland)  s+="<illustration __from__='"+where+"' src=lena.gif"+q+">\n"
2974bc1997-11-10Mirar (Pontus Hagland)  +replace(u,"lena()","src")+"</illustration>"; t=v; } s+=htmlify(replace(t,"\n\n","\n\n<p>")); return s; } multiset(string) get_method_names(string *decls) { string decl,name; multiset(string) names=(<>); foreach (decls,decl) { sscanf(decl,"%*s%*[\t ]%s%*[\t (]%*s",name); names[name]=1; } return names; }
e45d821997-11-10Mirar (Pontus Hagland) string *nice_order(string *arr) { sort(map(arr,replace,({"_","`"}),({"ÿ","þ"})), arr); return arr; }
2974bc1997-11-10Mirar (Pontus Hagland)  string addprefix(string suffix,string prefix) { return prefix+suffix; }
829a771997-12-06Mirar (Pontus Hagland) void document(string enttype, mapping huh,string name,string prefix, object f)
2974bc1997-11-10Mirar (Pontus Hagland) { string *names; if (huh->names) names=map(indices(huh->names),addprefix,name); else names=({name});
829a771997-12-06Mirar (Pontus Hagland)  verbose("mkwmml: "+name+" : "+names*","+"\n");
2974bc1997-11-10Mirar (Pontus Hagland) 
829a771997-12-06Mirar (Pontus Hagland)  f->write("\n<"+enttype+" name="+ replace(names*",", ">", "&gt;"));
2974bc1997-11-10Mirar (Pontus Hagland) 
829a771997-12-06Mirar (Pontus Hagland)  if (manpage_suffix[replace(name,"->",".")]) f->write(" mansuffix="+manpage_suffix[replace(name,"->",".")]);
2974bc1997-11-10Mirar (Pontus Hagland) 
829a771997-12-06Mirar (Pontus Hagland)  f->write(">\n");
2974bc1997-11-10Mirar (Pontus Hagland)  // [SYNTAX] if (huh->decl) {
829a771997-12-06Mirar (Pontus Hagland)  f->write("<man_syntax>\n");
2974bc1997-11-10Mirar (Pontus Hagland)  f->write(replace(htmlify(map(huh->decl,synopsis_to_html)* "<br>\n"),"\n","\n\t")+"\n");
829a771997-12-06Mirar (Pontus Hagland)  f->write("</man_syntax>\n\n");
2974bc1997-11-10Mirar (Pontus Hagland)  } // [DESCRIPTION] if (huh->desc) {
829a771997-12-06Mirar (Pontus Hagland)  f->write("<man_description>\n");
2974bc1997-11-10Mirar (Pontus Hagland)  f->write(fixdesc(huh->desc,prefix,huh->_line)+"\n");
829a771997-12-06Mirar (Pontus Hagland)  f->write("</man_description>\n\n");
2974bc1997-11-10Mirar (Pontus Hagland)  } // [ARGUMENTS] if (huh->args) { string rarg="";
829a771997-12-06Mirar (Pontus Hagland)  f->write("<man_arguments>\n");
2974bc1997-11-10Mirar (Pontus Hagland)  foreach (huh->args,mapping arg) { if (arg->desc) {
829a771997-12-06Mirar (Pontus Hagland)  f->write("\t<aargdesc>\n" +fixdesc(rarg+"\t\t<aarg>" +arg->args*"</aarg>\n\t\t<aarg>" +"</aarg>",prefix,arg->_line) +"\n\t\t<adesc>"
2974bc1997-11-10Mirar (Pontus Hagland)  +fixdesc(arg->desc,prefix,arg->_line)
829a771997-12-06Mirar (Pontus Hagland)  +"</adesc></aargdesc>\n\n");
2974bc1997-11-10Mirar (Pontus Hagland)  rarg=""; } else {
829a771997-12-06Mirar (Pontus Hagland)  rarg+="\t\t<aarg>" +arg->args*"</aarg>\n\t\t<aarg>"+ "</aarg>\n";
2974bc1997-11-10Mirar (Pontus Hagland)  } } if (rarg!="") error("trailing args w/o desc on "+arg->_line+"\n");
829a771997-12-06Mirar (Pontus Hagland)  f->write("</man_arguments>\n\n");
2974bc1997-11-10Mirar (Pontus Hagland)  } // [RETURN VALUE] if (huh->returns) {
829a771997-12-06Mirar (Pontus Hagland)  f->write("<man_returns>\n");
2974bc1997-11-10Mirar (Pontus Hagland)  f->write(fixdesc(huh->returns,prefix,huh->_line)+"\n");
829a771997-12-06Mirar (Pontus Hagland)  f->write("</man_returns>\n\n");
2974bc1997-11-10Mirar (Pontus Hagland)  } // [NOTE] if (huh->note && huh->note->desc) {
829a771997-12-06Mirar (Pontus Hagland)  f->write("<man_note>\n");
2974bc1997-11-10Mirar (Pontus Hagland)  f->write(fixdesc(huh->note->desc,prefix,huh->_line)+"\n");
829a771997-12-06Mirar (Pontus Hagland)  f->write("</man_note>\n\n");
2974bc1997-11-10Mirar (Pontus Hagland)  } // [SEE ALSO] if (huh["see also"]) {
829a771997-12-06Mirar (Pontus Hagland)  f->write("<man_see exp>\n"); f->write(huh["see also"]*", "); f->write("</man_see>\n\n");
2974bc1997-11-10Mirar (Pontus Hagland)  } // ---childs---- if (huh->methods) { // postprocess methods to get names multiset(string) method_names=(<>); string *method_names_arr,method_name; mapping method; if (huh->methods) foreach (huh->methods,method) method_names|=(method->names=get_method_names(method->decl));
e45d821997-11-10Mirar (Pontus Hagland)  method_names_arr=nice_order(indices(method_names));
2974bc1997-11-10Mirar (Pontus Hagland)  // alphabetically foreach (method_names_arr,method_name) if (method_names[method_name]) { // find it foreach (huh->methods,method) if ( method->names[method_name] ) {
829a771997-12-06Mirar (Pontus Hagland)  document("method",method,prefix,prefix,f);
2974bc1997-11-10Mirar (Pontus Hagland)  method_names-=method->names; } if (method_names[method_name]) stderr->write("failed to find "+method_name+" again, wierd...\n"); } } if (huh->classes) {
e45d821997-11-10Mirar (Pontus Hagland)  foreach(nice_order(indices(huh->classes)),string n)
2974bc1997-11-10Mirar (Pontus Hagland)  { f->write("\n\n\n<section title=\""+prefix+n+"\">\n");
829a771997-12-06Mirar (Pontus Hagland)  document("class",huh->classes[n],
2974bc1997-11-10Mirar (Pontus Hagland)  prefix+n,prefix+n+"->",f); f->write("</section title=\""+prefix+n+"\">\n"); } } if (huh->modules) {
e45d821997-11-10Mirar (Pontus Hagland)  foreach(nice_order(indices(huh->modules)),string n)
2974bc1997-11-10Mirar (Pontus Hagland)  { f->write("\n\n\n<section title=\""+prefix+n+"\">\n");
829a771997-12-06Mirar (Pontus Hagland)  document("module",huh->modules[n],
2974bc1997-11-10Mirar (Pontus Hagland)  prefix+n,prefix+n+".",f); f->write("</section title=\""+prefix+n+"\">\n"); } } // end ANCHOR
829a771997-12-06Mirar (Pontus Hagland)  f->write("</"+enttype+">\n\n");
2974bc1997-11-10Mirar (Pontus Hagland) } void make_doc_files() { stderr->write("modules: "+sort(indices(parse))*", "+"\n"); foreach (sort(indices(parse)),string module)
829a771997-12-06Mirar (Pontus Hagland)  document("module",parse[module],module,module+".",stdout);
2974bc1997-11-10Mirar (Pontus Hagland) } int main(int ac,string *files) { string s,t; int line; string *ss=({""}); object f; string currentfile; nowM=parse; stderr->write("reading and parsing data...\n"); files=files[1..];
829a771997-12-06Mirar (Pontus Hagland)  if (sizeof(files) && files[0]=="--nonverbose") files=files[1..],verbose=lambda(){}; stderr->write("mkwmml: reading files...\n");
2974bc1997-11-10Mirar (Pontus Hagland)  for (;;) { int i; if (!f) { if (!sizeof(files)) break;
829a771997-12-06Mirar (Pontus Hagland)  verbose("mkwmml: reading "+files[0]+"...\n");
2974bc1997-11-10Mirar (Pontus Hagland)  f=File(); currentfile=files[0]; files=files[1..]; if (!f->open(currentfile,"r")) { f=0; continue; } t=0; ss=({""}); line=0; } if (sizeof(ss)<2) { if (t=="") { f=0; continue; } t=f->read(8192); s=ss[0]; ss=t/"\n"; ss[0]=s+ss[0]; } s=ss[0]; ss=ss[1..]; line++; if ((i=search(s,"**!"))!=-1) { string kw,arg; sscanf(s[i+3..],"%*[ \t]%s%*[ \t]%s",kw,arg); if (keywords[kw]) { string err; if ( (err=keywords[kw](arg,currentfile+" line "+line)) ) {
829a771997-12-06Mirar (Pontus Hagland)  stderr->write("mkwmml: "+ currentfile+" line "+line+": "+err+"\n");
2974bc1997-11-10Mirar (Pontus Hagland)  return 1; } } else { // if (search(s,"$Id")!=-1) report("Id: "+s); if (!descM) descM=methodM; if (!descM) {
829a771997-12-06Mirar (Pontus Hagland)  stderr->write("mkwmml: " "Error on line "+line+ ": illegal description position\n");
2974bc1997-11-10Mirar (Pontus Hagland)  return 1; } if (!descM->desc) descM->desc=""; else descM->desc+="\n"; s=getridoftabs(s); descM->desc+=s[search(s,"**!")+3..]; } } } // stderr->write(sprintf("%O",parse));
829a771997-12-06Mirar (Pontus Hagland)  stderr->write("mkwmml: making docs...\n\n");
2974bc1997-11-10Mirar (Pontus Hagland)  make_doc_files(); return 0; }