#!/usr/bin/env python3

# A linter to warn for ASSERT macros which are separated from their argument
# list by a space, which Clang's CPP barfs on

from pathlib import Path
from linter import run_linters, RegexpLinter

linters = [
    RegexpLinter(r'WARN\s+\(',
                 message='CPP macros should not have a space between the macro name and their argument list'),
    RegexpLinter(r'ASSERT\s+\(',
                 message='CPP macros should not have a space between the macro name and their argument list'),
    RegexpLinter(r'ASSERT2\s+\(',
                 message='CPP macros should not have a space between the macro name and their argument list'),
    RegexpLinter(r'#ifdef\s+',
                 message='`#if defined(x)` is preferred to `#ifdef x`'),
    RegexpLinter(r'#if\s+defined\s+',
                 message='`#if defined(x)` is preferred to `#if defined x`'),
    RegexpLinter(r'#ifndef\s+',
                 message='`#if !defined(x)` is preferred to `#ifndef x`'),
]

for l in linters:
    # Need do document rules!
    l.add_path_filter(lambda path: path != Path('docs', 'coding-style.html'))
    # Don't lint vendored code
    l.add_path_filter(lambda path: not path.name == 'config.guess')
    # Don't lint font files
    l.add_path_filter(lambda path: not path.parent == Path('docs','users_guide',
        'rtd-theme', 'static', 'fonts'))
    # Don't lint image files
    l.add_path_filter(lambda path: not path.parent == Path('docs','users_guide',
        'images'))
    # Don't lint core spec
    l.add_path_filter(lambda path: not path.name == 'core-spec.pdf')

if __name__ == '__main__':
    run_linters(linters)
