summaryrefslogtreecommitdiffstats
path: root/common/waf.py
blob: 55c75175b5bf08fb59c29391315b0a3e4663fe1f (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
import sys, os
from waflib.Build import BuildContext

def cmd_spell(ctx):
	from waflib import Options
	from sys import argv
	from subprocess import call

	Options.commands = None # stop warnings about knowing commands.

	if not ctx.env.BIN_ASPELL:
		ctx.fatal("'aspell' is required please add binary to your path and re-run configure.")

	if len(argv) < 3:
		ctx.fatal("Please supply at least one file name")

	files = argv[2:]

	path = ctx.path.parent.abspath()

	# XXX: add error checking eg check if file exists.
	for file in files:
		cmd = ctx.env.BIN_ASPELL + ["-c", "--personal=%s/common/spell/dict/rtems" % path, "--extra-dicts=%s/common/spell/en_GB-ise-w_accents.multi" % path, file]

		print "running:", cmd
		call(cmd)


class spell(BuildContext):
	__doc__ = "Check spelling.  Supply a list of files or a glob (*.rst)"
	cmd = 'spell'
	fun = 'cmd_spell'


def cmd_configure(ctx):
	ctx.load('tex')

	if not ctx.env.PDFLATEX:
		conf.fatal('The program LaTex is required')

	ctx.find_program("sphinx-build", var="BIN_SPHINX_BUILD", mandatory=True)
#	ctx.find_program("pdflatex", var="BIN_PDFLATEX", mandatory=True)
	ctx.find_program("aspell", var="BIN_ASPELL", mandatory=False)


def cmd_build(ctx, conf_dir=".", source_dir="."):
	srcnode = ctx.srcnode.abspath()

	if ctx.options.pdf:

		ctx(
			rule	= "${BIN_SPHINX_BUILD} -b latex -c %s -j %d -d build/doctrees %s build/latex" % (conf_dir, ctx.options.jobs, source_dir),
			cwd		= ctx.path.abspath(),
			source	= ctx.path.ant_glob('**/*.rst'),
			target	= "latex/%s.tex" % ctx.path.name
		)

		ctx.add_group()

		ctx(
			features	= 'tex',
			cwd			= "%s/latex/" % ctx.path.get_bld().abspath(),
			type		= 'pdflatex',
			source		= ctx.bldnode.find_or_declare("latex/%s.tex" % ctx.path.name),
			prompt		= 0
		)

	else:
	# Copy HTML resources.
		for dir in ["_static", "_templates"]:
			files = ctx.path.parent.find_node("common").ant_glob("%s/*" % dir)
			ctx.path.get_bld().make_node(dir).mkdir() # dirs

			ctx(
				features    = "subst",
				is_copy     = True,
				source      = files,
				target      = [ctx.bldnode.find_node(dir).get_bld().make_node(x.name) for x in files]
			)

		ctx(
			rule   = "${BIN_SPHINX_BUILD} -b html -c %s -j %d -d build/doctrees %s build/html" % (conf_dir, ctx.options.jobs, source_dir),
			cwd	= ctx.path.abspath(),
			source =  ctx.path.ant_glob('**/*.rst'),# + ctx.path.ant_glob('conf.py'),
			target = ctx.path.find_or_declare('html/index.html')
		)

def cmd_options(ctx):
	ctx.add_option('--pdf', action='store_true', default=False, help="Build PDF.")

def cmd_options_path(ctx):
	cmd_options(ctx)
	ctx.add_option('--rtems-path-py', type='string', help="Full path to py/ in RTEMS source repository.")


def cmd_configure_path(ctx):
	if not ctx.options.rtems_path_py:
		ctx.fatal("--rtems-path-py is required")

	ctx.env.RTEMS_PATH = ctx.options.rtems_path_py

	cmd_configure(ctx)


CONF_FRAG = """
sys.path.append(os.path.abspath('../../common/'))
sys.path.append('%s')
templates_path = ['_templates']
html_static_path = ['_static']
"""


# XXX: fix this ugly hack.  No time to waste on it.
def cmd_build_path(ctx):
	def run(task):

		with open("conf.py") as fp:
			conf = "import sys, os\nsys.path.append(os.path.abspath('../../common/'))\n"
			conf += fp.read()

		task.inputs[0].abspath()
		task.outputs[0].write(conf + (CONF_FRAG % ctx.env.RTEMS_PATH))

	ctx(
		rule   = run,
		source = [ctx.path.parent.find_node("common/conf.py"), ctx.path.find_node("./conf.py")],
		target = ctx.path.get_bld().make_node('conf.py')
    )

	cmd_build(ctx, conf_dir="build", source_dir="build")