bin/foamUpdateCaseFileHeader

   1 #!/bin/sh
   2 #------------------------------------------------------------------------------
   3 # =========                 |
   4 # \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   5 #  \\    /   O peration     |
   6 #   \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
   7 #    \\/     M anipulation  |
   8 #------------------------------------------------------------------------------
   9 # License
  10 #     This file is part of OpenFOAM.
  11 #
  12 #     OpenFOAM is free software: you can redistribute it and/or modify it
  13 #     under the terms of the GNU General Public License as published by
  14 #     the Free Software Foundation, either version 3 of the License, or
  15 #     (at your option) any later version.
  16 #
  17 #     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  18 #     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  19 #     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  20 #     for more details.
  21 #
  22 #     You should have received a copy of the GNU General Public License
  23 #     along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
  24 #
  25 # Script
  26 #     foamUpdateCaseFileHeader
  27 #
  28 # Description
  29 #     Updates the header of application files.
  30 #     By default, writes current version in the header.
  31 #     Alternatively version can be specified with -v option.
  32 #     Also removes consecutive blank lines from file.
  33 #
  34 #------------------------------------------------------------------------------
  35 usage() {
  36     exec 1>&2
  37     while [ "$#" -ge 1 ]; do echo "$1"; shift; done
  38     cat<<USAGE
  39
  40 Usage: ${0##*/} [OPTION] <file1> ... <fileN>
  41
  42 options:
  43   -version <ver>    specifies the version to be written in the header
  44   -help             print the usage
  45
  46   Updates the header of application files and removes consecutive blank lines.
  47   By default, writes current OpenFOAM version in the header.
  48   An alternative version can be specified with the -version option.
  49
  50 USAGE
  51     exit 1
  52 }
  53
  54 #------------------------------------------------------------------------------
  55
  56 # parse options
  57 while [ "$#" -gt 0 ]
  58 do
  59     case "$1" in
  60     -h | -help)
  61         usage
  62         ;;
  63     -v | -version)
  64         [ "$#" -ge 2 ] || usage "'$1' option requires an argument"
  65         version="$2"
  66         shift 2
  67         ;;
  68     -*)
  69         usage "unknown option: '$*'"
  70         ;;
  71     *)
  72         break
  73         ;;
  74     esac
  75 done
  76
  77 # constant width for version - default to WM_PROJECT_VERSION
  78 version=$(printf %-36s ${version:-$WM_PROJECT_VERSION})
  79
  80 [ $# -ge 1 ] || usage
  81
  82 #------------------------------------------------------------------------------
  83
  84 printHeader()
  85 {
  86     cat<<HEADER
  87 /*--------------------------------*- C++ -*----------------------------------*\\
  88 | =========                 |                                                 |
  89 | \\\\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox           |
  90 |  \\\\    /   O peration     | Version:  $version  |
  91 |   \\\\  /    A nd           | Web:      www.OpenFOAM.org                      |
  92 |    \\\\/     M anipulation  |                                                 |
  93 \\*---------------------------------------------------------------------------*/
  94 FoamFile
  95 {
  96     version     2.0;
  97     format      $1;
  98     class       $2;
  99     object      $3;
 100 }
 101 HEADER
 102 }
 103
 104
 105 #
 106 # extract attribute '$1' from file '$2'
 107 #
 108 FoamFileAttribute()
 109 {
 110     sed -n -e 's/[ ;]*$//' -e "s/^ *$1 *//p" $2
 111 }
 112
 113
 114 #
 115 # main
 116 #
 117
 118 tmpFile=FoamFile.tmp$$
 119 for caseFile
 120 do
 121     if grep FoamFile $caseFile >/dev/null 2>&1
 122     then
 123         echo "Updating case file: $caseFile"
 124         sed -n '/FoamFile/,/}/p' $caseFile > $tmpFile
 125
 126         format=$(FoamFileAttribute format $tmpFile)
 127         class=$(FoamFileAttribute  class  $tmpFile)
 128         object=$(FoamFileAttribute object $tmpFile)
 129         # extract note? - needs special handling
 130         unset note
 131
 132         printHeader $format $class $object "$note" > $tmpFile
 133
 134         sed '1,/}/d' $caseFile | sed '/./,/^$/!d' >> $tmpFile
 135
 136         # use cat to avoid removing/replace soft-links
 137         [ -s $tmpFile ] && cat $tmpFile >| $caseFile
 138         rm -f $tmpFile 2>/dev/null
 139     else
 140         echo " Invalid case file: $caseFile" 1>&2
 141     fi
 142 done
 143
 144 #------------------------------------------------------------------ end-of-file