doc.py

#!/usr/bin/python

"""
Copyright (C) 2006-2009 Citrix Systems Inc.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation; version 2.1 only. with the special
exception on linking described in file LICENSE.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.
"""

import os
import sys
import string

xenapi_docdir = '/myrepos/xen-api/ocaml/doc'

docdir = sys.argv[1]
name = sys.argv[2]
ctype = sys.argv[3]
modules = set(sys.argv[4].split())
includes = sys.argv[5].split()
packs = sys.argv[6].replace(',',' ').split()
libs = sys.argv[7].split()
if len(sys.argv) >= 9:
	pp = '-pp ' + sys.argv[8]
else:
	pp = ''

libs = list(set(libs))	# remove duplicates
packs = list(set(packs))	# remove duplicates

dest = docdir + '/content/' + name
try:
	os.makedirs(dest)
except:
	pass

if len(packs) > 0:
	packages = "-package " + ','.join(packs)
else:
	packages = ""

doc_command = 'ocamlfind ocamldoc -v ' + packages + ' -I +threads -sort -g /myrepos/xen-api/ocaml/doc/odoc_json.cma -d ' + dest + ' ' + pp

files = []
for m in modules:
	d, f = os.path.split(m)
	l = os.listdir('./' + d)
	if f + '.mli' in l:
		files.append(m + '.mli')
	if f + '.ml' in l:
		files.append(m + '.ml')

includesx = []
for i in includes:
	includesx.append('-I ' + i)
	
# run ocamldoc

os.system(doc_command + ' ' + string.join(includesx) + ' ' + string.join(files))

# add dependencies to index files

f = file(dest + '/index.json', 'a')
packs_s = map(lambda s: '"' + s.split('/')[-1] + '"', packs)
libs_s = map(lambda s: '"' + s.split('/')[-1] + '"', libs)
s = 'deps_' + name.replace("-", "") + ' = {"packs": [' + ', '.join(packs_s) + '], '
s += '"libs": [' + ', '.join(libs_s) + ']}'
f.write(s)
f.close()

# update components file
	
def update_components(compdir):
	executables = []
	libraries = []
	packages = []
	
	try:
		f = file(compdir + '/components.js', 'r')
		exec(f.readline())
		exec(f.readline())
		exec(f.readline())
		f.close()
	except:
		pass

	if ctype == "library":
		libraries.append(name)
		libraries = list(set(libraries))
	elif ctype == "package":
		packages.append(name)
		packages = list(set(packages))
	else:
		executables.append(name)
		executables = list(set(executables))

	f = file(compdir + '/components.js', 'w')
	f.write('executables = ' + str(executables) + '\n')
	f.write('libraries = ' + str(libraries) + '\n')
	f.write('packages = ' + str(packages))
	f.close()

update_components(docdir)
update_components(xenapi_docdir)

# add symlink to xen-api
try:
	try:
		os.makedirs(xenapi_docdir + '/content')
	except:
		pass
	os.chdir(xenapi_docdir + '/content')
	os.symlink('../../../../xen-api-libs/doc/content/' + name, name)
except:
	pass