File: wmakeFunctions

package info (click to toggle)
openfoam 1912.200626-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye
  • size: 238,940 kB
  • sloc: cpp: 1,159,638; sh: 15,902; ansic: 5,195; lex: 660; xml: 387; python: 282; awk: 212; makefile: 103; sed: 88; csh: 3
file content (235 lines) | stat: -rw-r--r-- 5,724 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
#----------------------------------*-sh-*--------------------------------------
# =========                 |
# \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
#  \\    /   O peration     |
#   \\  /    A nd           | www.openfoam.com
#    \\/     M anipulation  |
#------------------------------------------------------------------------------
#     Copyright (C) 2015-2016 OpenFOAM Foundation
#     Copyright (C) 2018 OpenCFD Ltd.
#------------------------------------------------------------------------------
# License
#     This file is part of OpenFOAM, licensed under GNU General Public License
#     <http://www.gnu.org/licenses/>.
#
# Script
#     wmakeFunctions
#
# Description
#     Functions to check wmake environment and find .dep and .o files
#------------------------------------------------------------------------------

# Ensure these variables are always defined
MakeDir=Make
: "${Script:=wmakeFunctions}"

# Environment defaults
if [ -z "$WM_DIR" ]
then
    WM_DIR="$WM_PROJECT_DIR/wmake"
    export WM_DIR
fi


#------------------------------------------------------------------------------
# Check environment variables
#------------------------------------------------------------------------------

checkEnv()
{
    local check failed

    for check in WM_PROJECT_DIR WM_OPTIONS WM_DIR
    do
        eval test "\$$check" || failed="$failed $check"
    done

    [ -z "$failed" ] || {
        echo "$Script error: Environment variable(s) not set" 1>&2
        echo "   $failed" 1>&2
        exit 1
    }
}


#------------------------------------------------------------------------------
# Search up directories tree for the Make sub-directory
#------------------------------------------------------------------------------

# Return the absolute path for a directory or a file's parent directory
# expandPath dirName
# expandPath fileName
#
# Output:
# - the expanded path name
expandPath()
{
    if [ -d "$1" ]
    then
        (cd "$1" && pwd -P)
    elif [ -n "$1" ]
    then
        (cd $(dirname "$1") && pwd -P)
    else
        pwd -P
    fi
}

# Find the target directory, which contains a Make/ directory
# search upwards in its parent directories, but stopping
# when it hits the project root, home, or the file-system root
#
# findTarget dirName
#
# Output:
# - the relative target directory
#
# Global variables used:
# - WM_PROJECT_DIR, HOME
findTarget()
{
    local project=$(expandPath $WM_PROJECT_DIR)
    local home=$(expandPath $HOME)
    local reldir="${1:-.}"
    local absdir=$(expandPath $reldir)

    while [ -n "$absdir" ]
    do
        case "$absdir" in
        ($project | $home | /)
            break
            ;;
        esac

        if [ -d "$reldir/Make" ]
        then
            echo "$reldir"
            return 0
        else
            # Check parent directory
            absdir="${absdir%/*}"
            reldir="$reldir/.."
        fi
    done

    echo "Error: no Make directory for $(expandPath $1)" 1>&2
    echo 1>&2
    return 1
}


# Change to 'MakeDir' parent
# - uses 'MakeDir' for its input
#
# Side-effects:
# - unsets targetType
cdSource()
{
    local dir
    if [ ! -d "$MakeDir" ]
    then
        echo "$Script: '$MakeDir' directory does not exist in $PWD" 1>&2
        echo "    Searching up directories tree for Make directory" 1>&2

        dir=$(findTarget .) || exit 1 # Fatal
        cd $dir 2>/dev/null || {
            echo "$Script error: could not change to directory '$dir'" 1>&2
            exit 1
        }
        unset targetType
    fi

    [ -r $MakeDir/files ] || {
        echo "$Script error: file '$MakeDir/files' does not exist in $PWD" 1>&2
        exit 1
    }
}


# Find the object directory
# findObjectDir dirName
# findObjectDir fileName
#
# Output:
# - the objectsDir
#
# Global variables used:
# - WM_PROJECT_DIR, WM_OPTIONS
findObjectDir()
{
    local project=$(expandPath $WM_PROJECT_DIR)
    local absdir=$(expandPath ${1:-.})
    local objectsDir

    case "$absdir" in
    ("$project"/*)
        local buildPath=$WM_PROJECT_DIR/build/${WM_OPTIONS}
        objectsDir=$buildPath$(echo $absdir | sed s%$project%% )
        ;;
    (*)
        local path=$absdir
        local appDir=.
        [ -d Make ] || appDir=$(findTarget .) || exit 1 # Fatal
        absdir=$(expandPath $appDir/.)
        objectsDir=$appDir/Make/${WM_OPTIONS}$(echo $path | sed s%$absdir%% )
    ;;
    esac

    echo "$objectsDir"
}


# Find the object directory and remove it
# removeObjectDir dirName
# removeObjectDir fileName
#
# Output:
# - NONE
#
# Global variables used:
# - WM_PROJECT_DIR, WM_OPTIONS
removeObjectDir()
{
    local objectsDir=$(findObjectDir ${1:-.})
    if [ -d "$objectsDir" ]
    then
        rm -rf "$objectsDir" 2>/dev/null
    fi
}


# depToSource depFile
#
# Output:
# - the sourceFile corresponding to depFile
#
# Global variables used:
# - WM_OPTIONS
# - WM_MPLIB
if [ -n "$BASH_VERSION" ]
then
    depToSource()
    {
        local sourceFile=${1%.dep}
        sourceFile="${sourceFile/build\/${WM_OPTIONS}\//}"
        sourceFile="${sourceFile/build\/${WM_OPTIONS}${WM_MPLIB}\//}"
        sourceFile="${sourceFile/Make\/${WM_OPTIONS}\//}"
        sourceFile="${sourceFile/Make\/${WM_OPTIONS}${WM_MPLIB}\//}"

        echo "$sourceFile"
    }
else
    depToSource()
    {
        local sourceFile=$(echo ${1%.dep} |             \
            sed -e s%build/${WM_OPTIONS}/%%             \
                -e s%build/${WM_OPTIONS}${WM_MPLIB}/%%  \
                -e s%Make/${WM_OPTIONS}/%%              \
                -e s%Make/${WM_OPTIONS}${WM_MPLIB}/%% )

        echo "$sourceFile"
    }
fi


#------------------------------------------------------------------------------