michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: let dumpTypes = options['dump-types'].split(',');
michael@0: 
michael@0: let interestingList = {};
michael@0: let typelist = {};
michael@0: 
michael@0: function interestingType(t)
michael@0: {
michael@0:   let name = t.name;
michael@0:   
michael@0:   if (dumpTypes.some(function(n) n == name)) {
michael@0:     interestingList[name] = t;
michael@0:     typelist[name] = t;
michael@0:     return true;
michael@0:   }
michael@0:   
michael@0:   for each (let base in t.bases) {
michael@0:     if (base.access == 'public' && interestingType(base.type)) {
michael@0:       typelist[name] = t;
michael@0:       return true;
michael@0:     }
michael@0:   }
michael@0:   
michael@0:   return false;
michael@0: }
michael@0: 
michael@0: function addSubtype(t, subt)
michael@0: {
michael@0:   if (subt.typedef === undefined &&
michael@0:       subt.kind === undefined)
michael@0:     throw Error("Unexpected subtype: not class or typedef: " + subt);
michael@0: 
michael@0:   if (t.subtypes === undefined)
michael@0:     t.subtypes = [];
michael@0:   
michael@0:   t.subtypes.push(subt);
michael@0: }
michael@0: 
michael@0: function process_type(t)
michael@0: {
michael@0:   interestingType(t);
michael@0:   
michael@0:   for each (let base in t.bases)
michael@0:     addSubtype(base.type, t);
michael@0: }
michael@0: 
michael@0: function process_decl(d)
michael@0: {
michael@0:   if (d.typedef !== undefined && d.memberOf)
michael@0:     addSubtype(d.memberOf, d);
michael@0: }
michael@0: 
michael@0: function publicBases(t)
michael@0: {
michael@0:   yield t;
michael@0: 
michael@0:   for each (let base in t.bases)
michael@0:     if (base.access == "public")
michael@0:       for each (let gbase in publicBases(base.type))
michael@0:         yield gbase;
michael@0: }
michael@0: 
michael@0: function publicMembers(t)
michael@0: {
michael@0:   for each (let base in publicBases(t)) {
michael@0:     for each (let member in base.members) {
michael@0:       if (member.access === undefined)
michael@0:         throw Error("Harumph: member without access? " + member);
michael@0: 
michael@0:       if (member.access != "public")
michael@0:         continue;
michael@0:       
michael@0:       yield member;
michael@0:     }
michael@0:   }
michael@0: }
michael@0: 
michael@0: /**
michael@0:  * Get the short name of a decl name. E.g. turn
michael@0:  * "MyNamespace::MyClass::Method(int j) const" into
michael@0:  * "Method"
michael@0:  */
michael@0: function getShortName(decl)
michael@0: {
michael@0:   let name = decl.name;
michael@0:   let lp = name.lastIndexOf('(');
michael@0:   if (lp != -1)
michael@0:     name = name.slice(0, lp);
michael@0:   
michael@0:   lp = name.lastIndexOf('::');
michael@0:   if (lp != -1)
michael@0:     name = name.slice(lp + 2);
michael@0: 
michael@0:   return name;
michael@0: }
michael@0: 
michael@0: /**
michael@0:  * Remove functions in a base class which were overridden in a derived
michael@0:  * class.
michael@0:  *
michael@0:  * Although really, we should perhaps do this the other way around, or even
michael@0:  * group the two together, but that can come later.
michael@0:  */ 
michael@0: function removeOverrides(members)
michael@0: {
michael@0:   let overrideMap = {};
michael@0:   for (let i = members.length - 1; i >= 0; --i) {
michael@0:     let m = members[i];
michael@0:     if (!m.isFunction)
michael@0:       continue;
michael@0: 
michael@0:     let shortName = getShortName(m);
michael@0: 
michael@0:     let overrides = overrideMap[shortName];
michael@0:     if (overrides === undefined) {
michael@0:       overrideMap[shortName] = [m];
michael@0:       continue;
michael@0:     }
michael@0: 
michael@0:     let found = false;
michael@0:     for each (let override in overrides) {
michael@0:       if (signaturesMatch(override, m)) {
michael@0:         // remove members[i], it was overridden
michael@0:         members.splice(i, 1);
michael@0:         found = true;
michael@0:       }
michael@0:     }
michael@0:     if (found)
michael@0:       continue;
michael@0:          
michael@0:     overrides.push(m);
michael@0:   }
michael@0: }
michael@0: 
michael@0: /**
michael@0:  * Generates the starting position of lines within a file.
michael@0:  */
michael@0: function getLineLocations(fdata)
michael@0: {
michael@0:   yield 0;
michael@0:   
michael@0:   let r = /\n/y;
michael@0:   let pos = 0;
michael@0:   let i = 1;
michael@0:   for (;;) {
michael@0:     pos = fdata.indexOf('\n', pos) + 1;
michael@0:     if (pos == 0)
michael@0:       break;
michael@0: 
michael@0:     yield pos;
michael@0:     i++;
michael@0:   }
michael@0: }
michael@0:     
michael@0: /**
michael@0:  * Find and return the doxygen comment immediately prior to the location
michael@0:  * object that was passed in.
michael@0:  * 
michael@0:  * @todo: parse doccomment data such as @param, @returns
michael@0:  * @todo: parse comments for markup
michael@0:  */
michael@0: function getDocComment(loc)
michael@0: {
michael@0:   let fdata = read_file(loc.file);
michael@0:   let linemap = [l for (l in getLineLocations(fdata))];
michael@0:   
michael@0:   if (loc.line >= linemap.length) {
michael@0:     warning("Location larger than actual header: " + loc);
michael@0:     return <></>;
michael@0:   }
michael@0:   
michael@0:   let endpos = linemap[loc.line - 1] + loc.column - 1;
michael@0:   let semipos = fdata.lastIndexOf(';', endpos);
michael@0:   let bracepos = fdata.lastIndexOf('}', endpos);
michael@0:   let searchslice = fdata.slice(Math.max(semipos, bracepos) + 1, endpos);
michael@0: 
michael@0:   let m = searchslice.match(/\/\*\*[\s\S]*?\*\//gm);
michael@0:   if (m === null)
michael@0:     return <></>;
michael@0:   
michael@0:   let dc = m[m.length - 1].slice(3, -2);
michael@0:   dc = dc.replace(/^\s*(\*+[ \t]*)?/gm, "");
michael@0: 
michael@0:   return <pre class="doccomment">{dc}</pre>;
michael@0: }
michael@0: 
michael@0: function typeName(t)
michael@0: {
michael@0:   if (t.name !== undefined)
michael@0:     return t.name;
michael@0: 
michael@0:   if (t.isPointer)
michael@0:     return "%s%s*".format(t.isConst ? "const " : "", typeName(t.type));
michael@0:   
michael@0:   if (t.isReference)
michael@0:     return "%s%s&".format(t.isConst ? "const " : "", typeName(t.type));
michael@0: 
michael@0:   return t.toString();
michael@0: }
michael@0: 
michael@0: function publicBaseList(t)
michael@0: {
michael@0:   let l = <ul/>;
michael@0:   for each (let b in t.bases) {
michael@0:     if (b.access == 'public')
michael@0:       l.* += <li><a href={"/en/%s".format(b.type.name)}>{b.type.name}</a></li>;
michael@0:   }
michael@0: 
michael@0:   if (l.*.length() == 0)
michael@0:     return <></>;
michael@0:   
michael@0:   return <>
michael@0:     <h2>Base Classes</h2>
michael@0:     {l}
michael@0:   </>;
michael@0: }
michael@0: 
michael@0: /**
michael@0:  * Get a source-link for a given location.
michael@0:  */
michael@0: function getLocLink(loc, text)
michael@0: {
michael@0:   return <a class="loc"
michael@0:             href={"http://hg.mozilla.org/mozilla-central/file/%s/[LOC%s]#l%i".format(options.rev, loc.file, loc.line)}>{text}</a>;
michael@0: }
michael@0: 
michael@0: function dumpType(t)
michael@0: {
michael@0:   print("DUMP-TYPE(%s)".format(t.name));
michael@0: 
michael@0:   let methodOverview = <tbody />;
michael@0:   let methodList = <div/>;
michael@0:   let memberList = <></>;
michael@0: 
michael@0:   let shortNameMap = {};
michael@0: 
michael@0:   let members = [m for (m in publicMembers(t))];
michael@0:   
michael@0:   removeOverrides(members);
michael@0: 
michael@0:   for each (let m in members) {
michael@0:     let qname = m.memberOf.name + '::';
michael@0: 
michael@0:     // we don't inherit constructors from base classes
michael@0:     if (m.isConstructor && m.memberOf !== t)
michael@0:       continue;
michael@0:     
michael@0:     if (m.name.indexOf(qname) != 0)
michael@0:       throw Error("Member name not qualified?");
michael@0:     
michael@0:     let name = m.name.slice(qname.length);
michael@0:     
michael@0:     if (name.indexOf('~') == 0)
michael@0:       continue;
michael@0: 
michael@0:     if (m.isFunction) {
michael@0:       let innerList;
michael@0: 
michael@0:       let shortName = getShortName(m);
michael@0:       if (m.isConstructor)
michael@0:         shortName = 'Constructors';
michael@0: 
michael@0:       if (shortNameMap.hasOwnProperty(shortName)) {
michael@0:         innerList = shortNameMap[shortName];
michael@0:       }
michael@0:       else {
michael@0:         let overview = 
michael@0:           <tr><td>
michael@0:             <a href={'#%s'.format(escape(shortName))}>{shortName}</a>
michael@0:           </td></tr>;
michael@0: 
michael@0:         if (m.isConstructor)
michael@0:           methodOverview.insertChildAfter(null, overview);
michael@0:         else
michael@0:           methodOverview.appendChild(overview);
michael@0:         
michael@0:         let shortMarkup =
michael@0:           <div>
michael@0:             <h3 id={shortName}>{shortName}</h3>
michael@0:             <dl/>
michael@0:           </div>;
michael@0: 
michael@0:         
michael@0:         if (m.isConstructor)
michael@0:           methodList.insertChildAfter(null, shortMarkup);
michael@0:         else
michael@0:           methodList.appendChild(shortMarkup);
michael@0: 
michael@0:         innerList = shortMarkup.dl;
michael@0:         shortNameMap[shortName] = innerList;
michael@0:       }
michael@0:       
michael@0:       let parameters = <ul/>;
michael@0:       for each (p in m.parameters) {
michael@0:         let name = p.name;
michael@0:         if (name == 'this')
michael@0:           continue;
michael@0:         
michael@0:         if (/^D_\d+$/.test(name))
michael@0:           name = '<anonymous>';
michael@0:         
michael@0:         parameters.* += <li>{typeName(p.type)} {name}</li>;
michael@0:       }
michael@0: 
michael@0:       innerList.* +=
michael@0:         <>
michael@0:           <dt id={name} class="methodName">
michael@0:             <code>{typeName(m.type.type)} {name}</code> - {getLocLink(m.loc, "source")}
michael@0:           </dt>
michael@0:           <dd>
michael@0:             {getDocComment(m.loc)}
michael@0:             {parameters.*.length() > 0 ?
michael@0:              <>
michael@0:                <h4>Parameters</h4>
michael@0:                {parameters}
michael@0:              </> : <></>}
michael@0:           </dd>
michael@0:         </>;
michael@0:     }
michael@0:     else {
michael@0:       memberList += <li class="member">{name}</li>;
michael@0:     }
michael@0:   }
michael@0: 
michael@0:   let r =
michael@0:     <body>
michael@0:       <p>{getLocLink(t.loc, "Class Declaration")}</p>
michael@0:   
michael@0:       {getDocComment(t.loc)}
michael@0: 
michael@0:       {dumpTypes.some(function(n) n == t.name) ?
michael@0:          <>
michael@0:            [MAP{t.name}-graph.map]
michael@0:            <img src={"/@api/deki/pages/=en%%252F%s/files/=%s-graph.png".format(t.name, t.name)} usemap="#classes" />
michael@0:          </> : <></>
michael@0:       }
michael@0:   
michael@0:       {methodOverview.*.length() > 0 ?
michael@0:          <>
michael@0:            <h2>Method Overview</h2>
michael@0:            <table class="standard-table">{methodOverview}</table>
michael@0:          </> :
michael@0:          ""
michael@0:       }
michael@0: 
michael@0:       {publicBaseList(t)}
michael@0:   
michael@0:       <h2>Data Members</h2>
michael@0: 
michael@0:       {memberList.*.length() > 0 ?
michael@0:          memberList :
michael@0:          <p><em>No public members.</em></p>
michael@0:       }
michael@0: 
michael@0:       <h2>Methods</h2>
michael@0:   
michael@0:       {methodList.*.length() > 0 ?
michael@0:          methodList :
michael@0:          <p><em>No public methods.</em></p>
michael@0:       }
michael@0:   
michael@0:     </body>;
michael@0: 
michael@0:   write_file(t.name + ".html", r.toXMLString());
michael@0: }
michael@0: 
michael@0: function graphType(t)
michael@0: {
michael@0:   print("GRAPH-TYPE(%s)".format(t.name));
michael@0: 
michael@0:   let contents = "digraph classes {\n"
michael@0:                + "  node [shape=rectangle fontsize=11]\n"
michael@0:                + "  %s;\n".format(t.name);
michael@0: 
michael@0:   function graphClass(c)
michael@0:   {
michael@0:     contents += '%s [URL="http://developer.mozilla.org/en/%s"]\n'.format(c.name, c.name);
michael@0:     
michael@0:     for each (let st in c.subtypes) {
michael@0:       contents += "  %s -> %s;\n".format(c.name, st.name);
michael@0:       graphClass(st);
michael@0:     }
michael@0:   }
michael@0: 
michael@0:   graphClass(t);
michael@0:   
michael@0:   contents += "}\n";
michael@0:   
michael@0:   write_file(t.name + "-graph.gv", contents);
michael@0: }
michael@0:   
michael@0: function input_end()
michael@0: {
michael@0:   for (let p in typelist)
michael@0:     dumpType(typelist[p]);
michael@0: 
michael@0:   for (let n in interestingList)
michael@0:     graphType(interestingList[n]);
michael@0: }