check_inclusions.py

#!/usr/bin/python

import sys, re

if len(sys.argv) != 2:
    print 'Usage: %s <file>' % sys.argv[0]
    sys.exit()

filename = sys.argv[1]
print 'Checking %s' % filename

regex = re.compile('^#include.*<(.*)>')
ql_headers = []
boost_headers = []
std_headers = []
experimental_headers = []
source = open(filename)
for n, line in enumerate(source):
    match = regex.search(line)
    if match:
        header, = match.groups()
        line_num = n+1
        if header.startswith('ql/'):
            ql_headers.append((header,line_num))
            if header.startswith('ql/experimental') and 'internal' not in line:
                experimental_headers.append((header,line_num))
        elif header.startswith('boost/'):
            boost_headers.append((header,line_num))
        else:
            std_headers.append((header,line_num))
source.close()

# At least one QuantLib header must be included (which, hopefully,
# ultimately leads to including ql/qldefines.hpp)
if not ql_headers:
    print "./%s:1: error: no QuantLib header included" % filename
    sys.exit(1)

if 'ql/experimental' not in filename:
    # files in core library can't include stuff in experimental
    if experimental_headers:
        for f,n in experimental_headers:
            print "./%s:%d: error: experimental header '%s' included" % (filename, n, f)
        sys.exit(1)

# At least one QuantLib header must be included before Boost and standard ones
first_ql_header = min([ n for _,n in ql_headers])

for _,n in boost_headers:
    if n < first_ql_header:
        print "./%s:%d: error: Boost header included before first QuantLib header" % (filename, n)
        sys.exit(1)

for _,n in std_headers:
    if n < first_ql_header:
        print "./%s:%d: error: standard header included before first QuantLib header" % (filename, n)
        sys.exit(1)