util/cscope-index.py

   1 #! /usr/bin/python
   2 # Copyright (c) 2006 The Regents of The University of Michigan
   3 # All rights reserved.
   4 #
   5 # Redistribution and use in source and binary forms, with or without
   6 # modification, are permitted provided that the following conditions are
   7 # met: redistributions of source code must retain the above copyright
   8 # notice, this list of conditions and the following disclaimer;
   9 # redistributions in binary form must reproduce the above copyright
  10 # notice, this list of conditions and the following disclaimer in the
  11 # documentation and/or other materials provided with the distribution;
  12 # neither the name of the copyright holders nor the names of its
  13 # contributors may be used to endorse or promote products derived from
  14 # this software without specific prior written permission.
  15 #
  16 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27
  28 # Generate list of files to index with cscope and then generate cscope index.
  29
  30 # Should be run from root of m5 tree (i.e. as 'util/cscope-index.py').
  31
  32 import os
  33
  34 # absolute paths to skip
  35 skipdirs = [ 'src/unittest', 'src/doxygen' ]
  36
  37 # suffixes of files to index
  38 suffixes = [ '.cc', '.hh', '.c', '.h' ]
  39
  40 def oksuffix(f):
  41     for s in suffixes:
  42         if f.endswith(s):
  43             return True
  44     return False
  45
  46 file_list = file('cscope.files', 'w')
  47 cwd = os.getcwd()
  48
  49 for dirpath,subdirs,files in os.walk(os.path.join(cwd, 'src')):
  50     # filter out undesirable subdirectories
  51     for i,dir in enumerate(subdirs):
  52         if dir == 'SCCS':
  53             del subdirs[i]
  54             break
  55
  56     # filter out undesirable absolute paths
  57     if dirpath in skipdirs:
  58         del subdirs[:]
  59         continue
  60
  61     # find C/C++ sources
  62     okfiles = [f for f in files if oksuffix(f)]
  63     if okfiles:
  64         print('\n'.join([os.path.join(dirpath, f) for f in okfiles]),
  65             file=file_list)
  66
  67 file_list.close()
  68
  69 # run cscope to generate index
  70 os.system("cscope -b")