-env = DefaultEnvironment()
+Help('''
+Type 'scons' to build and run all the available test cases.
+It will automatically detect your platform and C compiler and
+build appropriately.
-env.Append(CPPPATH = ["#../", "#common"])
+You can modify the behavious using following options:
+CC Name of C compiler
+CXX Name of C++ compiler
+CCFLAGS Flags to pass to the C compiler
+CXXFLAGS Flags to pass to the C++ compiler
-# Build command for building .pb from .proto using protoc
-def proto_actions(source, target, env, for_signature):
- dirs = ' '.join(['-I' + env.GetBuildPath(d) for d in env['PROTOCPATH']])
- return '$PROTOC $PROTOCFLAGS %s -o%s %s' % (dirs, target[0], source[0])
+For example, for a clang build, use:
+scons CC=clang CXX=clang++
+''')
-proto_file_builder = Builder(generator = proto_actions,
- suffix = '.pb',
- src_suffix = '.proto')
-env.Append(BUILDERS = {'Proto': proto_file_builder})
-env.SetDefault(PROTOC = 'protoc')
+import os
+env = Environment(ENV = os.environ, tools = ['default', 'nanopb'])
-# Define the include path to find nanopb.proto
-env.Append(PROTOCPATH = ['#../generator', '/usr/include', '.'])
+# Allow overriding the compiler with scons CC=???
+if 'CC' in ARGUMENTS: env.Replace(CC = ARGUMENTS['CC'])
+if 'CXX' in ARGUMENTS: env.Replace(CXX = ARGUMENTS['CXX'])
+if 'CFLAGS' in ARGUMENTS: env.Append(CCFLAGS = ARGUMENTS['CFLAGS'])
+if 'CXXFLAGS' in ARGUMENTS: env.Append(CCFLAGS = ARGUMENTS['CXXFLAGS'])
-# Build command for running nanopb generator
-import os.path
-def nanopb_targets(target, source, env):
- basename = os.path.splitext(str(source[0]))[0]
- target.append(basename + '.pb.h')
- return target, source
-
-nanopb_file_builder = Builder(action = '$NANOPB_GENERATOR $NANOPB_FLAGS $SOURCE',
- suffix = '.pb.c',
- src_suffix = '.pb',
- emitter = nanopb_targets)
-env.Append(BUILDERS = {'Nanopb': nanopb_file_builder})
-env.SetDefault(NANOPB_GENERATOR = 'python ' + env.GetBuildPath("#../generator/nanopb_generator.py"))
-
-# Combined method to run both protoc and nanopb generator
-def run_protoc_and_nanopb(env, source):
- b1 = env.Proto(source)
- b2 = env.Nanopb(source)
- return b1 + b2
-env.AddMethod(run_protoc_and_nanopb, "NanopbProto")
+# Add the builders defined in site_init.py
+add_nanopb_builders(env)
-# Build command that runs a test program and saves the output
-def run_test_actions(source, target, env, for_signature):
- cmd = str(source[0]) # Name of binary
- if len(source) > 1:
- cmd += ' <' + str(source[1]) # Input file
- cmd += ' >' + str(target[0])
- return cmd
+# Path to the files shared by tests, and to the nanopb core.
+env.Append(CPPPATH = ["#../", "$COMMON"])
-run_test_builder = Builder(generator = run_test_actions,
- suffix = '.output')
-env.Append(BUILDERS = {'RunTest': run_test_builder})
+# Path for finding nanopb.proto
+env.Append(PROTOCPATH = '#../generator')
-# Build command that decodes a message using protoc
-def decode_actions(source, target, env, for_signature):
- dirs = ' '.join(['-I' + env.GetBuildPath(d) for d in env['PROTOCPATH']])
- return '$PROTOC $PROTOCFLAGS %s --decode=%s %s <%s >%s' % (dirs, env['MESSAGE'], source[1], source[0], target[0])
+# Check the compilation environment, unless we are just cleaning up.
+if not env.GetOption('clean'):
+ def check_ccflags(context, flags, linkflags = ''):
+ '''Check if given CCFLAGS are supported'''
+ context.Message('Checking support for CCFLAGS="%s"... ' % flags)
+ oldflags = context.env['CCFLAGS']
+ oldlinkflags = context.env['CCFLAGS']
+ context.env.Append(CCFLAGS = flags)
+ context.env.Append(LINKFLAGS = linkflags)
+ result = context.TryCompile("int main() {return 0;}", '.c')
+ context.env.Replace(CCFLAGS = oldflags)
+ context.env.Replace(LINKFLAGS = oldlinkflags)
+ context.Result(result)
+ return result
+
+ conf = Configure(env, custom_tests = {'CheckCCFLAGS': check_ccflags})
-decode_builder = Builder(generator = decode_actions,
- suffix = '.decoded')
-env.Append(BUILDERS = {'Decode': decode_builder})
-
-# Build command that asserts that two files be equal
-def compare_files(target, source, env):
- data1 = open(str(source[0]), 'rb').read()
- data2 = open(str(source[1]), 'rb').read()
- if data1 == data2:
-# open(str(target[0]), 'w').write('OK')
- return 0
+ # If the platform doesn't support C99, use our own header file instead.
+ stdbool = conf.CheckCHeader('stdbool.h')
+ stdint = conf.CheckCHeader('stdint.h')
+ stddef = conf.CheckCHeader('stddef.h')
+ string = conf.CheckCHeader('string.h')
+ stdlib = conf.CheckCHeader('stdlib.h')
+ if not stdbool or not stdint or not stddef or not string:
+ conf.env.Append(CPPDEFINES = {'PB_SYSTEM_HEADER': '\\"pb_syshdr.h\\"'})
+ conf.env.Append(CPPPATH = "#../extra")
+
+ if stdbool: conf.env.Append(CPPDEFINES = {'HAVE_STDBOOL_H': 1})
+ if stdint: conf.env.Append(CPPDEFINES = {'HAVE_STDINT_H': 1})
+ if stddef: conf.env.Append(CPPDEFINES = {'HAVE_STDDEF_H': 1})
+ if string: conf.env.Append(CPPDEFINES = {'HAVE_STRING_H': 1})
+ if stdlib: conf.env.Append(CPPDEFINES = {'HAVE_STDLIB_H': 1})
+
+ # Check if we can use pkg-config to find protobuf include path
+ status, output = conf.TryAction('pkg-config protobuf --variable=includedir > $TARGET')
+ if status:
+ conf.env.Append(PROTOCPATH = output.strip())
else:
- return "Test failed: %s and %s differ!" % (source[0], source[1])
+ conf.env.Append(PROTOCPATH = '/usr/include')
+
+ # Check if libmudflap is available (only with GCC)
+ if 'gcc' in env['CC']:
+ if conf.CheckLib('mudflap'):
+ conf.env.Append(CCFLAGS = '-fmudflap')
+ conf.env.Append(LINKFLAGS = '-fmudflap')
+
+ # Check if we can use extra strict warning flags (only with GCC)
+ extra = '-Wcast-qual -Wlogical-op -Wconversion'
+ extra += ' -fstrict-aliasing -Wstrict-aliasing=1'
+ extra += ' -Wmissing-prototypes -Wmissing-declarations -Wredundant-decls'
+ extra += ' -Wstack-protector '
+ if 'gcc' in env['CC']:
+ if conf.CheckCCFLAGS(extra):
+ conf.env.Append(CORECFLAGS = extra)
+
+ # Check if we can use undefined behaviour sanitizer (only with clang)
+ extra = '-fsanitize=undefined '
+ if 'clang' in env['CC']:
+ if conf.CheckCCFLAGS(extra, linkflags = extra):
+ conf.env.Append(CORECFLAGS = extra)
+ conf.env.Append(LINKFLAGS = extra)
+
+ # End the config stuff
+ env = conf.Finish()
+
+# Initialize the CCFLAGS according to the compiler
+if 'gcc' in env['CC']:
+ # GNU Compiler Collection
+
+ # Debug info, warnings as errors
+ env.Append(CFLAGS = '-ansi -pedantic -g -Wall -Werror -fprofile-arcs -ftest-coverage -fstack-protector-all')
+ env.Append(CORECFLAGS = '-Wextra')
+ env.Append(LINKFLAGS = '-g --coverage')
+
+ # We currently need uint64_t anyway, even though ANSI C90 otherwise..
+ env.Append(CFLAGS = '-Wno-long-long')
+elif 'clang' in env['CC']:
+ # CLang
+ env.Append(CFLAGS = '-ansi -g -Wall -Werror')
+ env.Append(CORECFLAGS = ' -Wextra -Wcast-qual -Wconversion')
+elif 'cl' in env['CC']:
+ # Microsoft Visual C++
+
+ # Debug info on, warning level 2 for tests, warnings as errors
+ env.Append(CFLAGS = '/Zi /W2 /WX')
+ env.Append(LINKFLAGS = '/DEBUG')
+
+ # More strict checks on the nanopb core
+ env.Append(CORECFLAGS = '/W4')
+
+ # PB_RETURN_ERROR triggers C4127 because of while(0)
+ env.Append(CFLAGS = '/wd4127')
+elif 'tcc' in env['CC']:
+ # Tiny C Compiler
+ env.Append(CFLAGS = '-Wall -Werror -g')
-compare_builder = Builder(action = compare_files,
- suffix = '.equal')
-env.Append(BUILDERS = {'Compare': compare_builder})
+env.SetDefault(CORECFLAGS = '')
+if 'clang' in env['CXX']:
+ env.Append(CXXFLAGS = '-g -Wall -Werror -Wextra -Wno-missing-field-initializers')
+elif 'g++' in env['CXX'] or 'gcc' in env['CXX']:
+ env.Append(CXXFLAGS = '-g -Wall -Werror -Wextra -Wno-missing-field-initializers')
+elif 'cl' in env['CXX']:
+ env.Append(CXXFLAGS = '/Zi /W2 /WX')
+
# Now include the SConscript files from all subdirectories
-SConscript(Glob('*/SConscript'), exports = 'env')
+import os.path
+env['VARIANT_DIR'] = 'build'
+env['BUILD'] = '#' + env['VARIANT_DIR']
+env['COMMON'] = '#' + env['VARIANT_DIR'] + '/common'
+for subdir in Glob('*/SConscript'):
+ SConscript(subdir, exports = 'env', variant_dir = env['VARIANT_DIR'] + '/' + os.path.dirname(str(subdir)))