DXR is a code search and navigation tool aimed at making sense of large projects. It supports full-text and regex searches as well as structural queries.

Mercurial (c68fe15a81fc)

VCS Links

Line Code
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
#!/usr/bin/python3
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.

import os
import sys
import glob
import shutil
import errno

import ThirdPartyPaths
import ThreadAllows


def copy_dir_contents(src, dest):
    for f in glob.glob("%s/*" % src):
        try:
            destname = "%s/%s" % (dest, os.path.basename(f))
            if os.path.isdir(f):
                shutil.copytree(f, destname)
            else:
                shutil.copy2(f, destname)
        except OSError as e:
            if e.errno == errno.ENOTDIR:
                shutil.copy2(f, destname)
            elif e.errno == errno.EEXIST:
                if os.path.isdir(f):
                    copy_dir_contents(f, destname)
                else:
                    os.remove(destname)
                    shutil.copy2(f, destname)
            else:
                raise Exception('Directory not copied. Error: %s' % e)


def write_cmake(module_path, import_alpha):
    names = ['  ' + os.path.basename(f) for f in glob.glob("%s/*.cpp" % module_path)]
    names += ['  ' + os.path.basename(f) for f in glob.glob("%s/external/*.cpp" % module_path)]
    if import_alpha:
        alpha_names = ['  ' + os.path.join("alpha", os.path.basename(f))
                       for f in glob.glob("%s/alpha/*.cpp" % module_path)]
        names += alpha_names
    with open(os.path.join(module_path, 'CMakeLists.txt'), 'w') as f:
        f.write("""set(LLVM_LINK_COMPONENTS support)

add_definitions( -DCLANG_TIDY )

add_clang_library(clangTidyMozillaModule
  ThirdPartyPaths.cpp
%(names)s

  LINK_LIBS
  clangAST
  clangASTMatchers
  clangBasic
  clangLex
  clangTidy
  clangTidyReadabilityModule
  clangTidyUtils
  clangTidyMPIModule
  )""" % {'names': "\n".join(names)})


def add_moz_module(cmake_path):
    with open(cmake_path, 'r') as f:
        lines = f.readlines()
    f.close()

    try:
        idx = lines.index('set(ALL_CLANG_TIDY_CHECKS\n')
        lines.insert(idx + 1, '  clangTidyMozillaModule\n')

        with open(cmake_path, 'w') as f:
            for line in lines:
                f.write(line)
    except ValueError:
        raise Exception('Unable to find ALL_CLANG_TIDY_CHECKS in {}'.format(cmake_path))


def write_third_party_paths(mozilla_path, module_path):
    tpp_txt = os.path.join(
        mozilla_path, '../../tools/rewriting/ThirdPartyPaths.txt')
    generated_txt = os.path.join(
        mozilla_path, '../../tools/rewriting/Generated.txt')
    with open(os.path.join(module_path, 'ThirdPartyPaths.cpp'), 'w') as f:
        ThirdPartyPaths.generate(f, tpp_txt, generated_txt)


def generate_thread_allows(mozilla_path, module_path):
    names = os.path.join(
        mozilla_path, '../../build/clang-plugin/ThreadAllows.txt'
    )
    files = os.path.join(
        mozilla_path, '../../build/clang-plugin/ThreadFileAllows.txt'
    )
    with open(os.path.join(module_path, 'ThreadAllows.h'), 'w') as f:
        f.write(ThreadAllows.generate_allows({files, names}))


def do_import(mozilla_path, clang_tidy_path, import_alpha):
    module = 'mozilla'
    module_path = os.path.join(clang_tidy_path, module)
    try:
        os.makedirs(module_path)
    except OSError as e:
        if e.errno != errno.EEXIST:
            raise

    copy_dir_contents(mozilla_path, module_path)
    write_third_party_paths(mozilla_path, module_path)
    generate_thread_allows(mozilla_path, module_path)
    write_cmake(module_path, import_alpha)
    add_moz_module(os.path.join(module_path, '..', 'CMakeLists.txt'))
    with open(os.path.join(module_path, '..', 'CMakeLists.txt'), 'a') as f:
        f.write('add_subdirectory(%s)\n' % module)
    # A better place for this would be in `ClangTidyForceLinker.h` but `ClangTidyMain.cpp`
    # is also OK.
    with open(os.path.join(module_path, '..', 'tool', 'ClangTidyMain.cpp'), 'a') as f:
        f.write('''
// This anchor is used to force the linker to link the MozillaModule.
extern volatile int MozillaModuleAnchorSource;
static int LLVM_ATTRIBUTE_UNUSED MozillaModuleAnchorDestination =
          MozillaModuleAnchorSource;
''')


def main():
    if len(sys.argv) < 3 or len(sys.argv) > 4:
        print("""\
Usage: import_mozilla_checks.py <mozilla-clang-plugin-path> <clang-tidy-path> [import_alpha]
Imports the Mozilla static analysis checks into a clang-tidy source tree.
If `import_alpha` is specified then in-tree alpha checkers will be also imported.
""")

        return

    mozilla_path = sys.argv[1]
    if not os.path.isdir(mozilla_path):
        print("Invalid path to mozilla clang plugin")

    clang_tidy_path = sys.argv[2]
    if not os.path.isdir(mozilla_path):
        print("Invalid path to clang-tidy source directory")

    import_alpha = False

    if len(sys.argv) == 4 and sys.argv[3] == 'import_alpha':
        import_alpha = True

    do_import(mozilla_path, clang_tidy_path, import_alpha)


if __name__ == '__main__':
    main()