aboutsummaryrefslogtreecommitdiffstats
path: root/extras/protoc.py
blob: 839c510b944af02eaaf6ce3551fb4679055e6858 (plain)
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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
#!/usr/bin/env python
# encoding: utf-8
# Philipp Bender, 2012
# Matt Clarkson, 2012

import re, os
from waflib.Task import Task
from waflib.TaskGen import extension
from waflib import Errors, Context, Logs

"""
A simple tool to integrate protocol buffers into your build system.

Example for C++:

    def configure(conf):
        conf.load('compiler_cxx cxx protoc')

    def build(bld):
        bld(
                features = 'cxx cxxprogram'
                source   = 'main.cpp file1.proto proto/file2.proto',
                includes = '. proto',
                target   = 'executable')

Example for Python:

    def configure(conf):
        conf.load('python protoc')

    def build(bld):
        bld(
                features = 'py'
                source   = 'main.py file1.proto proto/file2.proto',
                protoc_includes  = 'proto')

Example for both Python and C++ at same time:

    def configure(conf):
        conf.load('cxx python protoc')

    def build(bld):
        bld(
                features = 'cxx py'
                source   = 'file1.proto proto/file2.proto',
                protoc_includes  = 'proto')	# or includes


Example for Java:

    def options(opt):
        opt.load('java')

    def configure(conf):
        conf.load('python java protoc')
        # Here you have to point to your protobuf-java JAR and have it in classpath
        conf.env.CLASSPATH_PROTOBUF = ['protobuf-java-2.5.0.jar']

    def build(bld):
        bld(
                features = 'javac protoc',
                name = 'pbjava',
                srcdir = 'inc/ src',	# directories used by javac
                source   = ['inc/message_inc.proto', 'inc/message.proto'],
					# source is used by protoc for .proto files
                use = 'PROTOBUF',
                protoc_includes = ['inc']) # for protoc to search dependencies


Protoc includes passed via protoc_includes are either relative to the taskgen
or to the project and are searched in this order.

Include directories external to the waf project can also be passed to the
extra by using protoc_extincludes

                protoc_extincludes = ['/usr/include/pblib']


Notes when using this tool:

- protoc command line parsing is tricky.

  The generated files can be put in subfolders which depend on
  the order of the include paths.

  Try to be simple when creating task generators
  containing protoc stuff.

"""

class protoc(Task):
	run_str = '${PROTOC} ${PROTOC_FL:PROTOC_FLAGS} ${PROTOC_ST:INCPATHS} ${PROTOC_ST:PROTOC_INCPATHS} ${PROTOC_ST:PROTOC_EXTINCPATHS} ${SRC[0].bldpath()}'
	color   = 'BLUE'
	ext_out = ['.h', 'pb.cc', '.py', '.java']
	def scan(self):
		"""
		Scan .proto dependencies
		"""
		node = self.inputs[0]

		nodes = []
		names = []
		seen = []
		search_nodes = []

		if not node:
			return (nodes, names)

		if 'cxx' in self.generator.features:
			search_nodes = self.generator.includes_nodes

		if 'py' in self.generator.features or 'javac' in self.generator.features:
			for incpath in getattr(self.generator, 'protoc_includes', []):
				incpath_node = self.generator.path.find_node(incpath)
				if incpath_node:
					search_nodes.append(incpath_node)
				else:
					# Check if relative to top-level for extra tg dependencies
					incpath_node = self.generator.bld.path.find_node(incpath)
					if incpath_node:
						search_nodes.append(incpath_node)
					else:
						raise Errors.WafError('protoc: include path %r does not exist' % incpath)


		def parse_node(node):
			if node in seen:
				return
			seen.append(node)
			code = node.read().splitlines()
			for line in code:
				m = re.search(r'^import\s+"(.*)";.*(//)?.*', line)
				if m:
					dep = m.groups()[0]
					for incnode in search_nodes:
						found = incnode.find_resource(dep)
						if found:
							nodes.append(found)
							parse_node(found)
						else:
							names.append(dep)

		parse_node(node)
		# Add also dependencies path to INCPATHS so protoc will find the included file
		for deppath in nodes:
			self.env.append_unique('INCPATHS', deppath.parent.bldpath())
		return (nodes, names)

@extension('.proto')
def process_protoc(self, node):
	incdirs = []
	out_nodes = []
	protoc_flags = []

	# ensure PROTOC_FLAGS is a list; a copy is used below anyway
	self.env.PROTOC_FLAGS = self.to_list(self.env.PROTOC_FLAGS)

	if 'cxx' in self.features:
		cpp_node = node.change_ext('.pb.cc')
		hpp_node = node.change_ext('.pb.h')
		self.source.append(cpp_node)
		out_nodes.append(cpp_node)
		out_nodes.append(hpp_node)
		protoc_flags.append('--cpp_out=%s' % node.parent.get_bld().bldpath())

	if 'py' in self.features:
		py_node = node.change_ext('_pb2.py')
		self.source.append(py_node)
		out_nodes.append(py_node)
		protoc_flags.append('--python_out=%s' % node.parent.get_bld().bldpath())

	if 'javac' in self.features:
		# Make javac get also pick java code generated in build
		if not node.parent.get_bld() in self.javac_task.srcdir:
			self.javac_task.srcdir.append(node.parent.get_bld())

		protoc_flags.append('--java_out=%s' % node.parent.get_bld().bldpath())

	tsk = self.create_task('protoc', node, out_nodes)
	tsk.env.append_value('PROTOC_FLAGS', protoc_flags)

	if 'javac' in self.features:
		self.javac_task.set_run_after(tsk)

	# Instruct protoc where to search for .proto included files.
	# For C++ standard include files dirs are used,
	# but this doesn't apply to Python for example
	for incpath in getattr(self, 'protoc_includes', []):
		incpath_node = self.path.find_node(incpath)
		if incpath_node:
			incdirs.append(incpath_node.bldpath())
		else:
			# Check if relative to top-level for extra tg dependencies
			incpath_node = self.bld.path.find_node(incpath)
			if incpath_node:
				incdirs.append(incpath_node.bldpath())
			else:
				raise Errors.WafError('protoc: include path %r does not exist' % incpath)

	tsk.env.PROTOC_INCPATHS = incdirs

	# Include paths external to the waf project (ie. shared pb repositories)
	tsk.env.PROTOC_EXTINCPATHS = getattr(self, 'protoc_extincludes', [])

	# PR2115: protoc generates output of .proto files in nested
	# directories  by canonicalizing paths. To avoid this we have to pass
	# as first include the full directory file of the .proto file
	tsk.env.prepend_value('INCPATHS', node.parent.bldpath())

	use = getattr(self, 'use', '')
	if not 'PROTOBUF' in use:
		self.use = self.to_list(use) + ['PROTOBUF']

def configure(conf):
	conf.check_cfg(package='protobuf', uselib_store='PROTOBUF', args=['--cflags', '--libs'])
	conf.find_program('protoc', var='PROTOC')
	conf.start_msg('Checking for protoc version')
	protocver = conf.cmd_and_log(conf.env.PROTOC + ['--version'], output=Context.BOTH)
	protocver = ''.join(protocver).strip()[protocver[0].rfind(' ')+1:]
	conf.end_msg(protocver)
	conf.env.PROTOC_MAJOR = protocver[:protocver.find('.')]
	conf.env.PROTOC_ST = '-I%s'
	conf.env.PROTOC_FL = '%s'