docs.js

[gnome.introspection-doc-generator] / docs.js

//<Script type="text/javascript">

Gtk = imports.gi.Gtk;
Gio = imports.gi.Gio;
Gdk = imports.gi.Gdk;

// generic libraries
XObject     = imports.XObject.XObject;
File        = imports.File.File; 
console     = imports.console.console; 
Template    = imports.JsTemplate.Template.Template; 

// Introspecion specific..
NameSpace   = imports.Introspect.NameSpace.NameSpace; 
Link        = imports.Introspect.Link.Link; 



var outputdir = Seed.argv[2];

if (!outputdir) {
    throw {
        name: "ArgumentError", 
        message: "No output directory specified on the command line\n" +
          "Usage seed docs.js /var/www/seed  [Gtk] \n"
    };
}


if (!File.isDirectory(outputdir)) {
    console.log("Creating directory " + outputdir);
    File.mkdir(outputdir);
};

 
// Which libraries to build.

var ns_list = NameSpace.namespaces();
if (typeof(Seed.argv[3]) == 'string') {
    console.log(Seed.argv.length);
    ns_list = Seed.argv[3].split(',');
}


ns_list = ns_list.sort();
// let's try and load them, so we find out early what will fail.
print("loading library to make sure it works.");
ns_list_clean = [];
ns_list.forEach(function(ns_name) 
{
    try {
    
        var  core = imports.gi[ns_name];
        ns_list_clean.push(ns_name);
    } catch( e) {
        print(JSON.stringify(e));
    }
    
});
ns_list = ns_list_clean;



// which languages do we want to output for.
langs=[];
File.list(__script_path__ + '/templates/').forEach(function(f) {
    if (!File.isDirectory(__script_path__ + '/templates/' + f)) {
        return;
    }
    if (f == 'resources') {
        return;
    }
    langs.push({
        name : f,
        cls_template       : new Template( {
            templateFile : __script_path__ + '/templates/' + f + '/class.html',
            Link : Link // links might be specific to languages..
        }),
        cls_ix_template    : new Template( {
            templateFile : __script_path__ + '/templates/' + f + '/class_ix.html',
            Link : Link // links might be specific to languages..
        }),
        reference_template : new Template({
            templateFile : __script_path__ + '/templates/' + f + '/references.html',
            Link : Link // links might be specific to languages..
        }),
    });
});


/*
var cls_template = new Template(__script_path__ + '/templates/class.html');
var cls_ix_template = new Template(__script_path__ + '/templates/class_ix.html');
var reference_template = new Template(__script_path__ + '/templates/references.html');
*/

print("Looping throught namespaces");
var ns_idx = [];
ns_list.forEach(function(ns_name) 
{
    
    //if (ns_idx.length) {         return ;/* do one - for testing */ } 
    
    var  core = imports.gi[ns_name];
    var idx = { name: ns_name}; 
    console.log("START:" + ns_name);
   
    var ns = NameSpace.ns(ns_name);
    
    // gir goes in top level...
    if (File.exists(ns.gir_file)) {
        File.copyFile(ns.gir_file, outputdir + '/'+ ns.gir_filename, Gio.FileCopyFlags.OVERWRITE);
    }

    
    

    langs.forEach(function(lang) {
        ns['left_bar'] = lang.cls_ix_template.process(ns);
        // namespace template
        
        if (!File.exists(outputdir + '/'+ lang.name)) {
               File.mkdir(outputdir + '/'+ lang.name );
        }
      
        
        Gio.simple_write(outputdir + '/'+ lang.name+ '/' +ns_name +  '.html', lang.cls_template.process(ns));
        
        // left bar index of elements in namespace...
        Gio.simple_write(outputdir + '/'+ lang.name + '/_ix_'+ ns_name +  '.shtml', lang.cls_ix_template.process(ns));
            
    });
     
    
    var actions = {
        'objects' : 'Class',
        'interfaces' : 'Interface',
        'structs' : 'Struct',
        'unions' : 'Union',
        'enums' : 'Enum'
        
    };
    
    for (var i in actions) {
        // we flag GLib as a GObject lib...
        idx[i]= ns_name == 'GLib' ? 1 : ns[i].length ;
        
        ns[i].forEach( function(n) {
            
            print('NameSpace.factory(' + actions[i] +','+ns_name+','+n);
            var odata = XObject.extend(
                NameSpace.factory(actions[i], ns_name, n),
                { 'left_bar' :ns['left_bar'] }
            );
            
            langs.forEach(function(lang) {
                Gio.simple_write(outputdir +  '/'+ lang.name + '/' + ns_name + '.' + n + '.html', 
                    lang.cls_template.process(odata)
                )
            });
            console.log(ns_name + '.' +n);
        }); 
    }
    ns_idx.push(idx);
    
});

var refs = '';
var html_file_path = '';
var html = ''

// output cross reference data..
langs.forEach(function(lang) {
    
    for (var i in NameSpace.references) {
        
        html_file_path = [ outputdir, lang.name, i + '.html'].join('/');
      
        if (i == 'undefined') {
          console.log("Undefined name space - ignored");
          continue;
        }
        
        if (!File.isFile(html_file_path)) {
          console.log("No HTML file " + html_file_path + " to insert references into - ignored");
          continue;
        }
        
        refs = lang.reference_template.process(NameSpace.references[i]);

          // HTML to put refs into
        html =  File.read(html_file_path);

          // do the replacement
        html = html.replace(/\<!--references--\>/, refs);

          // write back to file
        Gio.simple_write(html_file_path, html);

    }
});

// set up index and resources.
langs.forEach(function(lang) {
    var ix_template = new Template({
        templateFile : __script_path__ + '/templates/' + lang.name + '/index.html',
        Link : Link, // lang specifc?
    });
    Gio.simple_write(outputdir + '/' + lang.name +  '/index.html', ix_template.process(ns_idx));
    File.silentRecursiveCopy(__script_path__ + '/templates/resources/', 
        outputdir + '/'  + lang.name , Gio.FileCopyFlags.OVERWRITE);
});