mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
COMP: support m4 include directories for wrap-lemon
Set the m4 -I include accordingly to have the folllowing:
- the directory of the parser.
- include/ in the top-level source tree of the current target
(eg, src/finiteVolume/include-m4/ when compiling libfiniteVolume)
- include/ from OpenFOAM
Additional -dry-run option for makeParser, wrap-lemon for expanding m4
only.
Extend m4 wrapping support to include bison as well.
This commit is contained in:
Mark Olesen
@ -1,4 +1,4 @@
|
||||
#!/bin/sh
|
||||
#!/bin/bash
|
||||
#------------------------------------------------------------------------------
|
||||
# ========= |
|
||||
# \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
||||
@ -14,7 +14,7 @@
|
||||
# wrap-bison
|
||||
#
|
||||
# Usage
|
||||
# wrap-bison -input=*.yy -output=*.cc [bison-options]
|
||||
# wrap-bison -output=*.cc [bison options/args]
|
||||
#
|
||||
# Description
|
||||
# A wrapper to handle renaming/relocation of bison-generated files.
|
||||
@ -41,6 +41,13 @@
|
||||
# - place generated *.hh files directly into lnInclude/
|
||||
# - place generated *.cc file into the build/ directory
|
||||
#
|
||||
# When called with m4 wrapping, it sets the m4 -I include to have
|
||||
# the following:
|
||||
# - the directory of the parser.
|
||||
# - include/ in the top-level source tree of the current target
|
||||
# (eg, src/finiteVolume/include/ when compiling libfiniteVolume)
|
||||
# - include/ from OpenFOAM
|
||||
#
|
||||
# Note
|
||||
# General idea lifted from swak
|
||||
#------------------------------------------------------------------------------
|
||||
@ -52,8 +59,9 @@ usage() {
|
||||
Usage: ${0##*/} [options] [bison args/options]
|
||||
|
||||
options:
|
||||
-input=NAME Perform the renaming actions
|
||||
-output=NAME Perform the renaming actions
|
||||
-dry-run Process m4 only (output on stdout)
|
||||
-no-tmp Do not retain temporary m4 processed files
|
||||
-output=NAME Request renaming actions
|
||||
-h, -help Print the usage
|
||||
|
||||
A bison wrapper with renaming of skeleton files
|
||||
@ -62,7 +70,7 @@ USAGE
|
||||
exit 1
|
||||
}
|
||||
|
||||
# File extensions used
|
||||
# File extensions used (may need adjustment)
|
||||
extCode="cc"
|
||||
extHead="hh"
|
||||
|
||||
@ -70,71 +78,151 @@ extHead="hh"
|
||||
# Parse arguments and options
|
||||
#------------------------------------------------------------------------------
|
||||
|
||||
# wrap-bison -input=... -output=...
|
||||
unset inputFile outputFile
|
||||
# wrap-bison -output=...
|
||||
unset outputFile optDryRun optRemoveTmp m4Flags
|
||||
while [ "$#" -gt 0 ]
|
||||
do
|
||||
case "$1" in
|
||||
(-h | -help*) usage ;;
|
||||
|
||||
(-input=*) inputFile="${1#*=}" ;;
|
||||
(-output=*) outputFile="${1#*=}" ;;
|
||||
(-dry-run) optDryRun=true ;;
|
||||
(-no-tmp) optRemoveTmp=true ;;
|
||||
(-output=*) outputFile="${1#*=}" ;;
|
||||
|
||||
(*) break ;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
|
||||
# No rename action supplied? Juet execute bison directly.
|
||||
if [ -z "$inputFile" ]
|
||||
#------------------------------------------------------------------------------
|
||||
# Additional m4Flags (for includes etc)
|
||||
#
|
||||
# $1 : path-qualified name of the parser
|
||||
#
|
||||
# Set includes accordingly to
|
||||
# - the directory containing the parser
|
||||
# - include/ in the top-level source tree of the current target
|
||||
# - include/ from OpenFOAM
|
||||
|
||||
defineM4Flags()
|
||||
{
|
||||
# Always include the directory containing the parser file
|
||||
m4Flags="$m4Flags${m4Flags:+ }-I$(dirname ${1:-.})"
|
||||
|
||||
local proj="$WM_PROJECT_DIR/src/${WM_PROJECT:-OpenFOAM}"
|
||||
local curr="$PWD"
|
||||
|
||||
# Called from the Makefile (PWD contains the parser source)
|
||||
# or from elsewhere (eg, createCode)?
|
||||
if [ ! -f "$curr/Make/options" ]
|
||||
then
|
||||
# No Make/options (eg createCode) - discover with "wmake -pwd"
|
||||
curr="$(wmake -pwd 2>/dev/null)"
|
||||
fi
|
||||
|
||||
# Avoid examining twice
|
||||
[ "$curr" != "$proj" ] || unset curr
|
||||
|
||||
if [ -n "$curr" ] && [ -d "$curr/include" ]
|
||||
then
|
||||
m4Flags="$m4Flags -I$curr/include"
|
||||
fi
|
||||
|
||||
if [ -n "$proj" ] && [ -d "$proj/include" ]
|
||||
then
|
||||
m4Flags="$m4Flags -I$proj/include"
|
||||
fi
|
||||
}
|
||||
|
||||
|
||||
#------------------------------------------------------------------------------
|
||||
# Get some information based on the bison options
|
||||
# The last argument is the input file
|
||||
|
||||
unset parser
|
||||
findBisonOptions()
|
||||
{
|
||||
parser="${@: -1}"
|
||||
}
|
||||
|
||||
findBisonOptions "$@"
|
||||
|
||||
unset parserFlags extParser usingM4
|
||||
|
||||
# Detect m4 use (defines parser macro too) and get extension without m4
|
||||
case "$parser" in
|
||||
(*.*m4)
|
||||
usingM4=true
|
||||
parserFlags="-Dm4"
|
||||
defineM4Flags "$parser"
|
||||
|
||||
extParser=".${parser##*.}" # The extension (with dot)
|
||||
extParser="${extParser%m4}" # Without trailing m4
|
||||
extParser="${extParser/%[-_]/}" # Without - or _ separators
|
||||
;;
|
||||
esac
|
||||
|
||||
# No rename action requested? Just execute bison directly.
|
||||
if [ -z "$outputFile" ] && [ "$usingM4" != true ]
|
||||
then
|
||||
bison $*
|
||||
exit $?
|
||||
fi
|
||||
|
||||
#------------------------------------------------------------------------------
|
||||
# Renaming requested
|
||||
|
||||
# Need lnInclude/ directory
|
||||
[ -d lnInclude ] || mkdir lnInclude 2>/dev/null || {
|
||||
exitCode=0 # No failures
|
||||
|
||||
|
||||
#------------------------------------------------------------------------------
|
||||
# Dry-run
|
||||
|
||||
if [ "$optDryRun" = true ]
|
||||
then
|
||||
if [ "$usingM4" = true ]
|
||||
then
|
||||
echo "m4 flags: $m4Flags" 1>&2
|
||||
m4 $m4Flags "$parser"; exitCode=$?
|
||||
else
|
||||
echo "Nothing to do - not using m4" 2>/dev/null
|
||||
fi
|
||||
[ "$exitCode" -eq 0 ] || echo "m4 failed" 2>/dev/null
|
||||
exit "$exitCode" # Done
|
||||
fi
|
||||
|
||||
|
||||
#------------------------------------------------------------------------------
|
||||
|
||||
# Called from the Makefile (PWD contains the parser source)
|
||||
# or from elsewhere (eg, createCode)?
|
||||
curr="$PWD"
|
||||
if [ ! -f "$curr/Make/options" ]
|
||||
then
|
||||
# No Make/options (eg createCode) - discover with "wmake -pwd"
|
||||
curr="$(wmake -pwd 2>/dev/null)"
|
||||
fi
|
||||
|
||||
# Will most likely need a lnInclude/ directory
|
||||
[ -d "$curr/lnInclude" ] || mkdir "$curr/lnInclude" 2>/dev/null || {
|
||||
echo "Cannot continue without an lnInclude directory" 1>&2
|
||||
pwd -L
|
||||
(cd "$curr" && pwd -L)
|
||||
exit 1
|
||||
}
|
||||
|
||||
# Get a baseName (stem) for the output
|
||||
baseName="${inputFile##*/}"
|
||||
baseName="${parser##*/}"
|
||||
baseName="${baseName%.*}"
|
||||
|
||||
# Fallback for output
|
||||
if [ -z "$outputFile" ]
|
||||
then
|
||||
outputFile="$(dirname ${inputFile})/${baseName}.$extCode"
|
||||
outputFile="$(dirname ${parser})/${baseName}.$extCode"
|
||||
fi
|
||||
|
||||
# Execute in a temporary directory (keeps files together)
|
||||
cwd="$(pwd -L)"
|
||||
tmpDir="Make/bisonWrapper-$baseName"
|
||||
rm -rf "$tmpDir" 2>/dev/null
|
||||
mkdir "$tmpDir" 2>/dev/null
|
||||
outputDir="$(dirname $outputFile)"
|
||||
|
||||
cd "$tmpDir" || exit
|
||||
rc=1
|
||||
|
||||
# DO WE WANT THIS?
|
||||
# trap 'cd $cwd; rm -f $tmpDir 2>/dev/null; exit $rc' EXIT TERM INT
|
||||
|
||||
bison "$@" "../../$inputFile"
|
||||
rc=$?
|
||||
|
||||
cd "../.." || exit
|
||||
|
||||
if [ "$rc" -ne 0 ]
|
||||
then
|
||||
rm -rf "$tmpDir" 2>/dev/null
|
||||
exit "$rc" # Exit with bison return code
|
||||
fi
|
||||
#------------------------------------------------------------------------------
|
||||
|
||||
# Renaming, filter code
|
||||
|
||||
# Check for/remove .tab. tag?
|
||||
unset untabFilter
|
||||
@ -146,7 +234,7 @@ hasTab="${hasTab%.*}"
|
||||
|
||||
if [ "$hasTab" = "${hasTab%.tab}" ]
|
||||
then
|
||||
untab='/^#.*".*\.tab\./s/\.tab\././'
|
||||
untabFilter='/^#.*".*\.tab\./s/\.tab\././'
|
||||
fi
|
||||
|
||||
# Filter include names to generate new files
|
||||
@ -160,12 +248,80 @@ filterRename()
|
||||
-e '/include *"location/s/"/"'"${baseName}."'/;' \
|
||||
-e '/include *"position/s/"/"'"${baseName}."'/;' \
|
||||
-e '/include *"stack/s/"/"'"${baseName}."'/;' \
|
||||
-e "$untab;" \
|
||||
-e "$untabFilter;" \
|
||||
"$1" >| "$2"
|
||||
fi
|
||||
}
|
||||
|
||||
|
||||
#------------------------------------------------------------------------------
|
||||
|
||||
# This gets slightly complicated with temporary files/dirs.
|
||||
#
|
||||
# - a tmp FILE for the m4-filtered parser (optional).
|
||||
# - a tmp DIR for storing the bison generated files so that we can
|
||||
# properly edit and rename them.
|
||||
|
||||
unset tmpFile tmpDir parserInput
|
||||
|
||||
if [ "$usingM4" = true ]
|
||||
then
|
||||
# Drop last argument (the parser input file)
|
||||
set -- "${@:1:${#}-1}"
|
||||
|
||||
# Filter via m4
|
||||
|
||||
# The outputDir is always defined. Make absolute
|
||||
tmpFile="$(cd ${outputDir:?} && pwd -L)/${parser##*/}"
|
||||
tmpFile="${tmpFile%.*}$extParser" # Eg, from .lyy-m4 -> .lyy
|
||||
|
||||
# We may want this:
|
||||
# trap 'rm -f $tmpFile 2>/dev/null; exit $exitCode' EXIT TERM INT
|
||||
|
||||
if m4 $m4Flags "$parser" > "$tmpFile" && [ -f "$tmpFile" ]
|
||||
then
|
||||
parserInput="$tmpFile"
|
||||
exitCode=0
|
||||
else
|
||||
echo "m4 stage failed on $parser" 2>/dev/null
|
||||
rm -f "$tmpFile" 2>/dev/null
|
||||
exit 1
|
||||
fi
|
||||
|
||||
else
|
||||
# No special (m4) handling
|
||||
|
||||
# Make parser input name absolute
|
||||
parserInput="$(cd $(dirname $parser) && pwd -L)/${parser##*/}"
|
||||
|
||||
fi
|
||||
|
||||
#------------
|
||||
# Execute bison in a temporary directory to keeps all files together
|
||||
cwd="$(pwd -L)"
|
||||
tmpDir="Make/wrap-bison-$baseName"
|
||||
rm -rf "$tmpDir" 2>/dev/null
|
||||
mkdir "$tmpDir" 2>/dev/null
|
||||
|
||||
# We may want this:
|
||||
# trap 'cd $cwd; rm -f $tmpDir 2>/dev/null; exit $exitCode' EXIT TERM INT
|
||||
|
||||
cd "$tmpDir" || exit
|
||||
|
||||
# Execute bison
|
||||
bison "$@" "$parserInput"
|
||||
exitCode=$?
|
||||
|
||||
cd "../.." || exit
|
||||
|
||||
if [ "$exitCode" -ne 0 ]
|
||||
then
|
||||
rm -rf "$tmpDir" 2>/dev/null
|
||||
exit "$exitCode" # Exit with bison return code
|
||||
fi
|
||||
|
||||
#------------
|
||||
|
||||
# Boilerplate -> lnInclude/ directory with new name
|
||||
for file in position location stack
|
||||
do
|
||||
@ -185,7 +341,17 @@ filterRename \
|
||||
"${outputFile}"
|
||||
|
||||
|
||||
if [ -n "$tmpFile" ]
|
||||
then
|
||||
if [ -n "$optRemoveTmp" ]
|
||||
then
|
||||
rm -f "$tmpFile" 2>/dev/null
|
||||
else
|
||||
echo "Retaining intermediate: $tmpFile" 2>/dev/null
|
||||
fi
|
||||
fi
|
||||
|
||||
rm -rf "$tmpDir" 2>/dev/null
|
||||
exit "$rc" # Exit with bison return code
|
||||
exit "$exitCode" # Exit with bison return code
|
||||
|
||||
#------------------------------------------------------------------------------
|
||||
|
||||
Reference in New Issue
Block a user