emacs-xcscope/cscope-indexer

   1 #! /bin/sh
   2 ###############################################################################
   3 #
   4 # File:         cscope-indexer
   5 # RCS:          $Header: /cvsroot/cscope/cscope/contrib/xcscope/cscope-indexer,v 1.2 2001/06/28 04:39:47 darrylo Exp $
   6 # Description:  Script to index files for cscope
   7 #
   8 #               This script generates a list of files to index
   9 #               (cscope.out), which is then (optionally) used to
  10 #               generate a cscope database.  You can use this script
  11 #               to just build a list of files, or it can be used to
  12 #               build a list and database.  This script is not used to
  13 #               just build a database (skipping the list of files
  14 #               step), as this can be simply done by just calling
  15 #               "cscope -b".
  16 #
  17 #               Normally, cscope will do its own indexing, but this
  18 #               script can be used to force indexing.  This is useful
  19 #               if you need to recurse into subdirectories, or have
  20 #               many files to index (you can run this script from a
  21 #               cron job, during the night).  It is especially useful
  22 #               for large projects, which can contstantly have source
  23 #               files added and deleted; by using this script, the
  24 #               changing sources files are automatically handled.
  25 #
  26 #               Currently, any paths containing "/CVS/" or "/RCS/" are
  27 #               stripped out (ignored).
  28 #
  29 #               This script is written to use only basic shell features, as
  30 #               not all shells have advanced features.
  31 #
  32 # Author:       Darryl Okahata
  33 # Created:      Thu Apr 27 17:12:14 2000
  34 # Modified:     Tue Jun 19 09:47:45 2001 (Darryl Okahata) darrylo@soco.agilent.com
  35 # Language:     Shell-script
  36 # Package:      N/A
  37 # Status:       Experimental
  38 #
  39 # (C) Copyright 2000, Darryl Okahata, all rights reserved.
  40 #
  41 ###############################################################################
  42 #
  43 # Usage:
  44 #
  45 #     cscope-indexer [ -v ] [-f database_file ] [-i list_file ] [ -l ] [ -r ]
  46 #
  47 # where:
  48 #
  49 #     -f database_file
  50 #          Specifies the cscope database file (default: cscope.out).
  51 #
  52 #     -i list_file
  53 #          Specifies the name of the file into which the list of files
  54 #          to index is placed (default: cscope.files).
  55 #
  56 #     -l
  57 #          Suppress the generation/updating of the cscope database
  58 #          file.  Only a list of files is generated.
  59 #
  60 #     -r
  61 #          Recurse into subdirectories to locate files to index.
  62 #          Without this option, only the current directory is
  63 #          searched.
  64 #
  65 #     -v
  66 #          Be verbose.  Output simple progress messages.
  67 #
  68 #
  69 ###############################################################################
  70 set -e
  71
  72 # May have to edit this:
  73 PATH="/usr/local/bin:/sbin:/usr/sbin:/bin:/usr/bin:$PATH"
  74 export PATH
  75
  76 LIST_ONLY=
  77 DIR='.'
  78 LIST_FILE='cscope.files'
  79 DATABASE_FILE='cscope.out'
  80 RECURSE=
  81 VERBOSE=
  82 export DIR RECURSE                      # Need to pass these to subprocesses
  83
  84 while [ -n "$1" ]
  85 do
  86     case "$1" in
  87     -f)
  88         if [ "X$2" = "X" ]
  89         then
  90             echo "$0: No database file specified" >&2
  91             exit 1
  92         fi
  93         DATABASE_FILE="$2"
  94         shift
  95         ;;
  96     -i)
  97         if [ "X$2" = "X" ]
  98         then
  99             echo "$0: No list file specified" >&2
 100             exit 1
 101         fi
 102         LIST_FILE="$2"
 103         shift
 104         ;;
 105     -l)
 106         LIST_ONLY=1
 107         ;;
 108     -r)
 109         RECURSE=1
 110         ;;
 111     -v)
 112         VERBOSE=1
 113         ;;
 114     *)
 115         DIR="$1"
 116         ;;
 117     esac
 118     shift
 119 done
 120
 121 cd $DIR
 122
 123 if [ "X$VERBOSE" != "X" ]
 124 then
 125     echo "Creating list of files to index ..."
 126 fi
 127
 128 (
 129     if [ "X$RECURSE" = "X" ]
 130     then
 131         # Ugly, inefficient, but it works.
 132         for f in *
 133         do
 134             echo "$DIR/$f"
 135         done
 136     else
 137         find $DIR \( -type f -o -type l \)
 138     fi
 139 ) | \
 140     egrep -i '\.([chly](xx|pp)*|cc|hh)$' | \
 141     sed -e '/\/CVS\//d' -e '/\/RCS\//d' -e 's/^\.\///' | \
 142     sort > $LIST_FILE
 143
 144 if [ "X$VERBOSE" != "X" ]
 145 then
 146     echo "Creating list of files to index ... done"
 147 fi
 148
 149 if [ "X$LIST_ONLY" != "X" ]
 150 then
 151     exit 0
 152 fi
 153
 154 if [ "X$VERBOSE" != "X" ]
 155 then
 156     echo "Indexing files ..."
 157 fi
 158
 159 cscope -b -i $LIST_FILE -f $DATABASE_FILE
 160
 161 if [ "X$VERBOSE" != "X" ]
 162 then
 163     echo "Indexing files ... done"
 164 fi
 165
 166 exit 0