cscope-index.py revision 3703
19342SAndreas.Sandberg@arm.com#! /usr/bin/python 210910Sandreas.sandberg@arm.com# Copyright (c) 2006 The Regents of The University of Michigan 39342SAndreas.Sandberg@arm.com# All rights reserved. 49342SAndreas.Sandberg@arm.com# 59342SAndreas.Sandberg@arm.com# Redistribution and use in source and binary forms, with or without 69342SAndreas.Sandberg@arm.com# modification, are permitted provided that the following conditions are 79342SAndreas.Sandberg@arm.com# met: redistributions of source code must retain the above copyright 89342SAndreas.Sandberg@arm.com# notice, this list of conditions and the following disclaimer; 99342SAndreas.Sandberg@arm.com# redistributions in binary form must reproduce the above copyright 109342SAndreas.Sandberg@arm.com# notice, this list of conditions and the following disclaimer in the 119342SAndreas.Sandberg@arm.com# documentation and/or other materials provided with the distribution; 129342SAndreas.Sandberg@arm.com# neither the name of the copyright holders nor the names of its 139342SAndreas.Sandberg@arm.com# contributors may be used to endorse or promote products derived from 149342SAndreas.Sandberg@arm.com# this software without specific prior written permission. 159342SAndreas.Sandberg@arm.com# 169342SAndreas.Sandberg@arm.com# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 179342SAndreas.Sandberg@arm.com# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 189342SAndreas.Sandberg@arm.com# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 199342SAndreas.Sandberg@arm.com# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 209342SAndreas.Sandberg@arm.com# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 219342SAndreas.Sandberg@arm.com# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 229342SAndreas.Sandberg@arm.com# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 239342SAndreas.Sandberg@arm.com# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 249342SAndreas.Sandberg@arm.com# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 259342SAndreas.Sandberg@arm.com# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 269342SAndreas.Sandberg@arm.com# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 279342SAndreas.Sandberg@arm.com# 289342SAndreas.Sandberg@arm.com# Authors: Steve Reinhardt 299342SAndreas.Sandberg@arm.com 309342SAndreas.Sandberg@arm.com# Generate list of files to index with cscope and then generate cscope index. 319342SAndreas.Sandberg@arm.com 329342SAndreas.Sandberg@arm.com# Should be run from root of m5 tree (i.e. as 'util/cscope-index.py'). 339342SAndreas.Sandberg@arm.com 349342SAndreas.Sandberg@arm.comimport os 359342SAndreas.Sandberg@arm.com 369342SAndreas.Sandberg@arm.com# absolute paths to skip 379342SAndreas.Sandberg@arm.comskipdirs = [ 'src/unittest', 'src/doxygen' ] 389342SAndreas.Sandberg@arm.com 399342SAndreas.Sandberg@arm.com# suffixes of files to index 409342SAndreas.Sandberg@arm.comsuffixes = [ '.cc', '.hh', '.c', '.h' ] 4110912Sandreas.sandberg@arm.com 4210912Sandreas.sandberg@arm.comdef oksuffix(f): 4310912Sandreas.sandberg@arm.com for s in suffixes: 4410912Sandreas.sandberg@arm.com if f.endswith(s): 459342SAndreas.Sandberg@arm.com return True 469342SAndreas.Sandberg@arm.com return False 4710912Sandreas.sandberg@arm.com 4810912Sandreas.sandberg@arm.comfile_list = file('cscope.files', 'w') 499342SAndreas.Sandberg@arm.com 5010912Sandreas.sandberg@arm.comfor dirpath,subdirs,files in os.walk('src'): 5110912Sandreas.sandberg@arm.com # filter out undesirable subdirectories 529342SAndreas.Sandberg@arm.com for i,dir in enumerate(subdirs): 539342SAndreas.Sandberg@arm.com if dir == 'SCCS': 549342SAndreas.Sandberg@arm.com del subdirs[i] 559342SAndreas.Sandberg@arm.com break 569342SAndreas.Sandberg@arm.com 579342SAndreas.Sandberg@arm.com # filter out undesirable absolute paths 589342SAndreas.Sandberg@arm.com if dirpath in skipdirs: 5910912Sandreas.sandberg@arm.com del subdirs[:] 6010912Sandreas.sandberg@arm.com continue 619342SAndreas.Sandberg@arm.com 6210912Sandreas.sandberg@arm.com # find C/C++ sources 6310912Sandreas.sandberg@arm.com okfiles = [f for f in files if oksuffix(f)] 6410912Sandreas.sandberg@arm.com if okfiles: 6510912Sandreas.sandberg@arm.com print >> file_list, \ 6610912Sandreas.sandberg@arm.com '\n'.join([os.path.join(dirpath, f) for f in okfiles]) 6710912Sandreas.sandberg@arm.com 6810912Sandreas.sandberg@arm.comfile_list.close() 6910912Sandreas.sandberg@arm.com 7010912Sandreas.sandberg@arm.com# run cscope to generate index 7110913Sandreas.sandberg@arm.comos.system("cscope -b") 7210912Sandreas.sandberg@arm.com