solenv/bin/add-modelines

   1 #!/usr/bin/env bash
   2 #
   3 # This file is part of the LibreOffice project.
   4 #
   5 # This Source Code Form is subject to the terms of the Mozilla Public
   6 # License, v. 2.0. If a copy of the MPL was not distributed with this
   7 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8 #
   9
  10 # add-modelines, a simple script to add comments to
  11 # the beginning and end of source files for LibreOffice devs
  12
  13 # Blame goes to Jesse Adelman (at least at first)
  14 # someone AT boldandbusted dotty-dot com
  15 # http://www.boldandbusted.com/
  16 # (c) 2010 Bold and Busted LLC
  17
  18 # NOTE: At present, this script only works for files with C-like comments.
  19 # NOTE: If you don't specify -p, the script will act on the current working directory.
  20 # NOTE: If no arguments are specified, the definitions below are in effect.
  21
  22 # TO DO
  23 #  - Deuglify?
  24 #  - Make source file type agnostic modelines?
  25 #  - Too many/too few comments?
  26 #  - Handle top level source directories with whitespace names? (Do they exist?)
  27
  28 # Turn off globbing, helps with SourceFiles
  29 set -f
  30
  31 # POSIX
  32 set -o posix
  33
  34 # Change these to taste
  35 FirstLine='/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */'
  36 LastLine='/* vim:set shiftwidth=4 softtabstop=4 expandtab cinoptions=b1,g0,N-s cinkeys+=0=break: */'
  37 SourceFiles='*.cxx *.cpp *.hxx *.hpp *.c *.h *.m *.mm *.idl *.src *.hrc'
  38
  39 # Set defaults (don't change these)
  40 ModelineReplace="false"
  41
  42 # Functions
  43
  44 function SetEnvironment()
  45 {
  46      if [ -n "$(which tail)" ] && [ -n "$(which head)" ]; then
  47         {
  48             headCMD=$(which head)
  49             tailCMD=$(which tail)
  50         }
  51         else
  52         {
  53             echo "Missing head or tail, exiting..."
  54             exit 1
  55         }
  56     fi
  57     if [ -n "$(which find)" ]; then
  58         findCMD=$(which find)
  59         else
  60         {
  61             echo "Missing find, exiting..."
  62             exit 1
  63         }
  64     fi
  65 }
  66
  67 function EditFile()
  68 {
  69     local FileToEdit
  70     local currentFirstLine
  71     local currentLastLine
  72
  73     FileToEdit="$1"
  74
  75     currentFirstLine=$($headCMD -1 "$FileToEdit")
  76     currentLastLine=$($tailCMD -1 "$FileToEdit")
  77
  78     case "$ModelineReplace" in
  79         "true" )
  80             if [ "${currentFirstLine:0:6}" = "${FirstLine:0:6}" ]; then
  81             {
  82                 echo "$FirstLine" > "$FileToEdit".new
  83                 $tailCMD -n +2 "$FileToEdit" >> "$FileToEdit".new
  84             }
  85             fi
  86             if [ -e "$FileToEdit.new" ]; then
  87             {
  88                 echo "$LastLine" >> "$FileToEdit".new
  89             }
  90             fi
  91             if [ "${currentLastLine:0:6}" = "${LastLine:0:6}" ]; then
  92             {
  93                 $headCMD -n -1 "$FileToEdit" > "$FileToEdit".new
  94                 echo "$LastLine" >> "$FileToEdit".new
  95             }
  96             fi
  97             mv "$FileToEdit".new "$FileToEdit"
  98             echo "$FileToEdit updated" ;;
  99         "false" )
 100             if [ "${currentFirstLine:0:6}" != "${FirstLine:0:6}" ]; then
 101                 if [ "${currentLastLine:0:6}" != "${LastLine:0:6}" ]; then
 102                 {
 103                     echo "$FirstLine" > "$FileToEdit".new
 104                     cat "$FileToEdit" >> "$FileToEdit".new
 105                     if [ "x${currentLastLine}" != "x" ] ; then
 106                         echo "" >> "$FileToEdit".new
 107                     fi
 108                     echo "$LastLine" >> "$FileToEdit".new
 109                     mv "$FileToEdit".new "$FileToEdit"
 110                     echo "$FileToEdit updated"
 111                 }
 112                 fi
 113             fi ;;
 114     esac
 115 }
 116
 117 function PrintUsage()
 118 {
 119     echo "Usage: $0 [-z] [-s \"<sourcefile glob>\"] [-p <path to source>]"
 120 }
 121
 122 # Main
 123
 124 SetEnvironment
 125
 126 # Get command line options
 127
 128 while getopts "zs:p:" opt; do
 129     case $opt in
 130         z) ModelineReplace="true" ;;
 131         s) SourceFiles="$OPTARG" ;;
 132         p) findPath="$OPTARG" ;;
 133         *) PrintUsage
 134            exit 1 ;;
 135     esac
 136 done
 137
 138 if [ $OPTIND -gt 1 ]; then
 139     shift $((OPTIND - 1))
 140 fi
 141
 142 if [ $# -gt 1 ]; then
 143 {
 144     PrintUsage
 145     echo "Remember to quote the source file globs after -s"
 146     exit 1
 147 }
 148 fi
 149
 150 # Create GNU find expressions that traverse the filesystem once and only once
 151 if [ -z "$findPath" ]; then
 152     findArgs='.'
 153     else
 154         findArgs="$findPath"
 155 fi
 156
 157 for FileType in ${SourceFiles}; do
 158     findArgs="$findArgs"' ( -iname '"$FileType"' -print -o -true ) -a '
 159 done
 160
 161 # This gets rid of the final " -a " in the find argument list
 162 findArgs=(${findArgs:0:(${#findArgs}-3)})
 163
 164 for file in $($findCMD "${findArgs[@]}"); do
 165     EditFile "$file"
 166     echo "Completed: " "$file"
 167 done
 168
 169 # vim:set shiftwidth=4 softtabstop=4 expandtab: