From 64dd9f9d0eb16242cb28ac60b2d6f2f69d0ff38b Mon Sep 17 00:00:00 2001
From: Henrik Wallin <hedda@lysator.liu.se>
Date: Thu, 13 Nov 1997 15:14:29 +0100
Subject: [PATCH] obsolete documentation, see Image.wmml in the pike/tutorial
directory and mkwmml.pike
Rev: src/modules/Image/mkdoc.pike:1.16(DEAD)
---
.gitattributes | 1 -
src/modules/Image/mkdoc.pike | 581 -----------------------------------
2 files changed, 582 deletions(-)
delete mode 100644 src/modules/Image/mkdoc.pike
diff --git a/.gitattributes b/.gitattributes
index 7f6c875462..2c760207f9 100644
--- a/.gitattributes
+++ b/.gitattributes
@@ -87,7 +87,6 @@ testfont binary
/src/modules/Image/lzw.c foreign_ident
/src/modules/Image/lzw.h foreign_ident
/src/modules/Image/matrix.c foreign_ident
-/src/modules/Image/mkdoc.pike foreign_ident
/src/modules/Image/mkwmml.pike foreign_ident
/src/modules/Image/operator.c foreign_ident
/src/modules/Image/pattern.c foreign_ident
diff --git a/src/modules/Image/mkdoc.pike b/src/modules/Image/mkdoc.pike
deleted file mode 100644
index 4a949a8d80..0000000000
--- a/src/modules/Image/mkdoc.pike
+++ /dev/null
@@ -1,581 +0,0 @@
-/* $Id: mkdoc.pike,v 1.15 1997/11/07 06:12:12 mirar Exp $ */
-
-import Stdio;
-import Array;
-
-mapping parse=([]);
-int illustration_counter;
-object illustration_source;
-
-string illustration_code=read_bytes("illustration.pike");
-object lena_image=Image.image()->fromppm(read_file("doc/lena.ppm"));
-
-/*
-
-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)
-{
- stderr->write(s+"\n");
-}
-
-#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];
- }
-}
-
-string addprefix(string suffix,string prefix)
-{
- return prefix+suffix;
-}
-
-#define urlify(S) (replace((S),({"%","&","'","\"","`"}), \
- ({"%25","%26","%27","%22","%60"})))
-#define htmlify(S) (replace((S),({"&","\240"}),({"&"," "})))
-
-string make_nice_reference(string refto,string my_prefix)
-{
- string my_module,my_class,link,s,t;
-
- if (sscanf(my_prefix,"%s.%s",my_module,my_class)==1)
- my_class=0;
-
- switch ((search(refto,"->")!=-1)+(search(refto,".")!=-1)*2)
- {
- case 0: if (refto!=my_module) link=my_prefix+"->"+refto;
- else link=refto;
- break;
- case 1: if (refto) link=my_module+"."+refto; else link=my_module; break;
- case 2:
- case 3: link=refto; break;
- }
-
- s=0; t=0;
- sscanf(link,"%s.%s",link,s);
- sscanf(link,"%s.%s.%s",link,s,t);
- if (s) link+="."+s;
- if (t) link=link+".html#"+t;
- else
- if (search(link,"->")!=-1)
- link=replace(link,"->",".html#");
- else
- link+=".html";
-
- link=replace(link,"..",".");
-
- return "<tt><a href="+urlify(link)+">"+refto+"</a></tt>";
-}
-
-object(File) make_file(string filename)
-{
- stdout->write("creating "+filename+"...\n");
- if (file_size(filename)>0)
- {
- rm(filename+"~");
- mv(filename,filename+"~");
- }
- object f=File();
- if (!f->open(filename,"wtc"))
- {
- stdout->write("failed.");
- exit(1);
- }
- return f;
-}
-
-mapping ills=([]);
-
-string fixdesc(string s,string prefix)
-{
- s=stripws(s);
-
- string t,u,v;
-
- 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="";
- while (sscanf(t,"%s<illustration>%s</illustration>%s",t,u,v)==3)
- {
- s+=t;
-
- array err=catch {
- object x=compile_string(replace(illustration_code,"***the string***",u))();
- x->lena_image=lena_image;
- u=x->doit("illustration_"+illustration_counter+++".gif",
- ills,illustration_source,u);
- };
- if (err)
- {
- stderr->write("error while compiling and running\n"+u+"\n");
- stderr->write(master()->describe_backtrace(err)+"\n");
- }
- else s+=u;
- t=v;
- }
- s+=t;
-
- return htmlify(replace(s,"\n\n","\n\n<p>"));
-}
-
-string standard_doc(mapping info,string myprefix)
-{
- string res="";
-
- if (info->desc && stripws(info->desc)!="")
- res+="\n\n<blockquote>\n"+fixdesc(info->desc,myprefix)+
- "\n</blockquote>\n";
-
- if (info->note && info->note->desc)
- res+="\n\n<h4>NOTE</h4>\n<blockquote>\n"+
- fixdesc(info->note->desc,myprefix)+"\n</blockquote>\n";
-
- if (info->bugs && info->bugs->desc)
- res+="\n\n<h4>KNOWN BUGS</h4>\n<blockquote>\n"+
- fixdesc(info->bugs->desc,myprefix)+"\n</blockquote>\n";
-
- if (info["see also"])
- {
- res+=
- "\n\n<h4>SEE ALSO</h4>\n<blockquote> " +
- map(info["see also"],make_nice_reference,myprefix)*",\n " +
- "\n</blockquote>\n";
- }
-
- return res;
-}
-
-
-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;
-}
-
-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"}));
-}
-
-void document_method(object(File) f,
- mapping method,
- string prefix)
-{
- string s;
-
- stdout->write("documenting "+prefix+" methods "+
- sort(indices(method->names))*", "+"...\n");
-
- f->write("\n<hr>\n");
-
- foreach (sort(indices(method->names)),s)
- f->write("<a name="+urlify(s)+"> </a>\n");
-
- f->write("<h4>SYNOPSIS</h4>\n"
- "<blockquote>\n"
- "<tt>"+htmlify(map(method->decl,synopsis_to_html)*
- "<br>\n")+
- "</tt>\n</blockquote>\n\n");
-
- if (method->desc && stripws(method->desc)!="")
- {
- f->write("<h4>DESCRIPTION</h4>\n"
- "\n\n<blockquote>\n"+
- fixdesc(method->desc,prefix)+
- "\n</blockquote>\n");
- }
-
- if (method->args)
- {
- mapping arg;
- f->write("<h4>ARGUMENTS</h4>\n<blockquote><dl>\n");
- foreach (method->args,arg)
- {
- if (arg->desc)
- f->write("<dt><tt>"+arg->args*"</tt>\n<dt><tt>"+
- "</tt>\n <dd>"+
- fixdesc(arg->desc,prefix)+"\n");
- else
- f->write("<dt><tt>"+arg->args*"</tt>\n<dt><tt>"+
- "</tt>\n");
- }
- f->write("</dl></blockquote>\n");
- }
-
- if (method->returns)
- {
- f->write("<h4>RETURNS</h4>\n"
- "\n\n<blockquote>\n"+method->returns+"\n</blockquote>\n");
- }
-
- if (method->note && method->note->desc)
- {
- f->write("\n\n<h4>NOTE</h4>\n<blockquote>\n"+
- fixdesc(method->note->desc,prefix)+"\n</blockquote>\n");
- }
-
- if (method->bugs && method->bugs->desc)
- {
- f->write("\n\n<h4>KNOWN BUGS</h4>\n<blockquote>\n"+
- fixdesc(method->bugs->desc,prefix)+"\n</blockquote>\n");
- }
-
- if (method["see also"])
- {
- f->write("\n\n<h4>SEE ALSO</h4>\n<blockquote> " +
- map(method["see also"],
- make_nice_reference,prefix)*",\n " +
- "\n</blockquote>\n");
- }
-}
-
-void document_class(string title,
- string file,
- mapping info,
- string prefix)
-{
- stdout->write("documenting "+title+"...\n");
-
- object(File) f=make_file(file);
-
- f->write("<title>Pike documentation: "+title+"</title>\n"+
- "<h2>"+title+"</h2>\n"+
- standard_doc(info,prefix));
-
- // postprocess methods to get names
-
- multiset(string) method_names=(<>);
- string *method_names_arr,method_name;
- mapping method;
-
- if (info->methods)
- foreach (info->methods,method)
- method_names|=(method->names=get_method_names(method->decl));
-
- method_names_arr=sort(indices(method_names));
-
-/* f->write("\n<hr>\n <i><tt>"+*/
-/* map(method_names_arr,make_nice_reference,prefix)**/
-/* "</tt></i><br>\n <i><tt>"+"</tt></i><br>\n\n");*/
- // alphabetically
-
- foreach (method_names_arr,method_name)
- if (method_names[method_name])
- {
- // find it
- foreach (info->methods,method)
- if ( method->names[method_name] )
- {
- document_method(f,method,prefix);
- method_names-=method->names;
- }
- if (method_names[method_name])
- stderr->write("failed to find "+method_name+" again, wierd...\n");
- }
-
- f->close();
-
-}
-
-void make_an_index(string title,
- string file,
- mapping info,
- string prefix,
- string *refs)
-{
- object f=make_file(file);
- f->write("<title>Pike documentation: "+title+"</title>\n"+
- "<h2>"+title+"</h2>\n"+
- standard_doc(info,prefix));
-// if (sizeof(refs))
-// {
-// f->write("<h3>More documentation:</h3>\n <i>" +
-// map(map(refs,addprefix,prefix),
-// make_nice_reference,prefix)*"</tt></i><br>\n <i><tt>" +
-// "</i>\n\n");
-// }
-
-
- // postprocess methods to get names
-
- multiset(string) method_names=(<>);
- string *method_names_arr,method_name;
- mapping method;
-
- if (info->methods)
- foreach (info->methods,method)
- method_names|=(method->names=get_method_names(method->decl));
-
- method_names_arr=sort(indices(method_names));
-
-/* f->write("\n<hr>\n <i><tt>"+*/
-/* map(method_names_arr,make_nice_reference,prefix)**/
-/* "</tt></i><br>\n <i><tt>"+"</tt></i><br>\n\n");*/
- // alphabetically
-
- foreach (method_names_arr,method_name)
- if (method_names[method_name])
- {
- // find it
- foreach (info->methods,method)
- if ( method->names[method_name] )
- {
- document_method(f,method,prefix);
- method_names-=method->names;
- }
- if (method_names[method_name])
- stderr->write("failed to find "+method_name+" again, wierd...\n");
- }
-
- f->close();
-}
-
-void document_module(mapping mod,string module,string dir)
-{
- string clas;
-
- make_an_index("module "+module,
- dir+module+".html", mod,
- module+".", sort(indices(mod->classes||([]))));
-
- stdout->write("module "+module+" class(es): "+
- sort(indices(mod->classes||([])))*", "+"\n");
-
- foreach (sort(indices(mod->classes||([]))),clas)
- document_class(module+"."+clas,
- dir+module+"."+clas+".html",
- mod->classes[clas],
- module+"."+clas);
-
- foreach (sort(indices(mod->modules||([]))),clas)
- document_module(mod->modules[clas],module+"."+clas,dir);
-}
-
-void make_doc_files(string dir)
-{
- stdout->write("modules: "+sort(indices(parse))*", "+"\n");
-
- illustration_source=File();
- illustration_source->open(dir+"illustrations.html","wct");
-
- string module;
-
- foreach (sort(indices(parse)),module)
- document_module(parse[module],module,dir);
-}
-
-int main(int ac,string *files)
-{
- string s,t;
- int line;
- string *ss=({""});
- object f;
-
- string currentfile;
-
- nowM=parse;
-
- stdout->write("reading and parsing data...\n");
-
- files=files[1..];
-
- for (;;)
- {
- int i;
-
- if (!f)
- {
- if (!sizeof(files)) break;
- stdout->write("reading "+files[0]+"...\n");
- 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)) )
- {
- stderr->write(currentfile+" line "+line+": "+err+"\n");
- return 1;
- }
- }
- else
- {
-// if (search(s,"$Id")!=-1) report("Id: "+s);
- if (!descM) descM=methodM;
- if (!descM)
- {
- stderr->write("Error on line "+line+": illegal description position\n");
- 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));
-
- stdout->write("making docs...\n\n");
-
- make_doc_files("doc/");
- return 0;
-}
--
GitLab