#!/bin/bash

# Copyright (C) 2008 Steve Youngs

# Author:     Steve Youngs <steve@sxemacs.org>
# Maintainer: Steve Youngs <steve@sxemacs.org>
# Created:    <2008-03-10>
# Time-stamp: <Tuesday Mar 11, 2008 00:23:45 steve>
# Homepage:   N/A
# Keywords:   utils package-management

# This file is part of pkgusr.

# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions
# are met:
#
# 1. Redistributions of source code must retain the above copyright
#    notice, this list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright
#    notice, this list of conditions and the following disclaimer in the
#    documentation and/or other materials provided with the distribution.
#
# 3. Neither the name of the author nor the names of any contributors
#    may be used to endorse or promote products derived from this
#    software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR
# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
# BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
# WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
# OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
# IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

## Commentary:
# 
#  This script is used to locate headers that declare symbol.  symbol
#  being the thing you are searching for.  This is good for those
#  "unknown reference" errors.

## Code:
ourname=${0##*/}

# Usage
if [ $# -lt 1 -o "$1" = "--help" -o "$1" = "--usage" -o "$1" = "-h" ]; then
	echo 1>&2
	echo 1>&2 'USAGE:  ${ourname} <symbol_regexp>'
	echo 1>&2
	echo 1>&2 '  Find headers that declare symbol matching <symbol_regexp>.'
	echo 1>&2
	echo 1>&2 '  See grep(1), '"'REGULAR EXPRESSIONS'"' for the syntax of regexps'
	echo 1>&2 '  used by this script.'
	echo 1>&2
	exit 1
fi

# Header directories.
# These are the directories we search.  If you have other header directories
# such as /usr/local/include, /opt/include, add them here.
header_dirs=(/usr/include /usr/X11R6/include)

## bastard header directories...
# header_dirs=(/usr/include /usr/X11R6/include /opt/jdk/include /opt/qt/include)

sym=${1}

all_headers=$(find -H -L ${header_dirs[*]} -type f -name "*.h" -print)

### FIXME: This is totally brain dead, it'll match on shit you don't
#          want like comments.
#    A possible solution might be to use etags in some way.
for header in ${all_headers} ; do
    grep -E -l --mmap --colour ${sym} ${header} 2>/dev/null
done

## header-symbol-search ends here