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 # Authors: Steve Reinhardt
  29
  30 # Generate list of files to index with cscope and then generate cscope index.
  31
  32 # Should be run from root of m5 tree (i.e. as 'util/cscope-index.py').
  33
  34 import os
  35
  36 # absolute paths to skip
  37 skipdirs = [ 'src/unittest', 'src/doxygen' ]
  38
  39 # suffixes of files to index
  40 suffixes = [ '.cc', '.hh', '.c', '.h' ]
  41
  42 def oksuffix(f):
  43     for s in suffixes:
  44         if f.endswith(s):
  45             return True
  46     return False
  47
  48 file_list = file('cscope.files', 'w')
  49
  50 for dirpath,subdirs,files in os.walk('src'):
  51     # filter out undesirable subdirectories
  52     for i,dir in enumerate(subdirs):
  53         if dir == 'SCCS':
  54             del subdirs[i]
  55             break
  56
  57     # filter out undesirable absolute paths
  58     if dirpath in skipdirs:
  59         del subdirs[:]
  60         continue
  61
  62     # find C/C++ sources
  63     okfiles = [f for f in files if oksuffix(f)]
  64     if okfiles:
  65         print >> file_list, \
  66               '\n'.join([os.path.join(dirpath, f) for f in okfiles])
  67
  68 file_list.close()
  69
  70 # run cscope to generate index
  71 os.system("cscope -b")