Wrappers for *ToText

[wxWidgets.git] / src / os2 / dllar.sh

#!/bin/sh
#
# dllar - a tool to build both a .dll and an .a file
# from a set of object (.o) files for EMX/OS2.
#
#  Written by Andrew Zabolotny, bit@freya.etu.ru
#  Ported to Unix like shell by Stefan Neis, Stefan.Neis@t-online.de
#
#  This script will accept a set of files on the command line.
#  All the public symbols from the .o files will be exported into
#  a .DEF file, then linker will be run (through gcc) against them to
#  build a shared library consisting of all given .o files. All libraries
#  (.a) will be first decompressed into component .o files then act as
#  described above. You can optionally give a description (-d "description")
#  which will be put into .DLL. To see the list of accepted options (as well
#  as command-line format) simply run this program without options. The .DLL
#  is built to be imported by name (there is no guarantee that new versions
#  of the library you build will have same ordinals for same symbols).
#
#  dllar is free software; you can redistribute it and/or modify
#  it under the terms of the GNU General Public License as published by
#  the Free Software Foundation; either version 2, or (at your option)
#  any later version.
#
#  dllar is distributed in the hope that it will be useful,
#  but WITHOUT ANY WARRANTY; without even the implied warranty of
#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#  GNU General Public License for more details.
#
#  You should have received a copy of the GNU General Public License
#  along with dllar; see the file COPYING.  If not, write to the Free
#  Software Foundation, 59 Temple Place - Suite 330, Boston, MA
#  02111-1307, USA.

# To successfuly run this program you will need:
#  - Current drive should have LFN support (HPFS, ext2, network, etc)
#    (Sometimes dllar generates filenames which won't fit 8.3 scheme)
#  - gcc
#    (used to build the .dll)
#  - emxexp
#    (used to create .def file from .o files)
#  - emximp
#    (used to create .a file from .def file)
#  - GNU text utilites (cat, sort, uniq)
#    used to process emxexp output
#  - GNU file utilities (mv, rm)
#  - GNU sed
#  - lxlite (optional, see flag below)
#    (used for general .dll cleanup)
#

flag_USE_LXLITE=1;

#
# helper functions
# basnam, variant of basename, which does _not_ remove the path, _iff_
#                              second argument (suffix to remove) is given
basnam(){
    case $# in
    1)
        echo $1 | sed 's/.*\///' | sed 's/.*\\//'
        ;;
    2)
        echo $1 | sed 's/'$2'$//'
        ;;
    *)
        echo "error in basnam $*"
        exit 8
        ;;
    esac
}

# Cleanup temporary files and output
CleanUp() {
    cd $curDir
    for i in $inputFiles ; do
        case $i in
        *!)
            rm -rf `basnam $i !`
            ;;
        *)
            ;;
        esac
    done

    # Kill result in case of failure as there is just to many stupid make/nmake
    # things out there which doesn't do this.
    if [ $# -eq 0 ]; then
        rm -f $arcFile $arcFile2 $defFile $dllFile
    fi
}

# Print usage and exit script with rc=1.
PrintHelp() {
 echo 'Usage: dllar [-o[utput] output_file] [-i[mport] importlib_name]'
 echo '       [-d[escription] "dll descrption"] [-cc "CC"] [-f[lags] "CFLAGS"]'
 echo '       [-ord[inals]] -ex[clude] "symbol(s)"'
 echo '       [-libf[lags] "{INIT|TERM}{GLOBAL|INSTANCE}"] [-nocrt[dll]] [-nolxl[ite]]'
 echo '       [*.o] [*.a]'
 echo '*> "output_file" should have no extension.'
 echo '   If it has the .o, .a or .dll extension, it is automatically removed.'
 echo '   The import library name is derived from this and is set to "name".a,'
 echo '   unless overridden by -import'
 echo '*> "importlib_name" should have no extension.'
 echo '   If it has the .o, or .a extension, it is automatically removed.'
 echo '   This name is used as the import library name and may be longer and'
 echo '   more descriptive than the DLL name which has to follow the old '
 echo '   8.3 convention of FAT.'
 echo '*> "cc" is used to use another GCC executable.   (default: gcc.exe)'
 echo '*> "flags" should be any set of valid GCC flags. (default: -s -Zcrtdll)'
 echo '   These flags will be put at the start of GCC command line.'
 echo '*> -ord[inals] tells dllar to export entries by ordinals. Be careful.'
 echo '*> -ex[clude] defines symbols which will not be exported. You can define'
 echo '   multiple symbols, for example -ex "myfunc yourfunc _GLOBAL*".'
 echo '   If the last character of a symbol is "*", all symbols beginning'
 echo '   with the prefix before "*" will be exclude, (see _GLOBAL* above).'
 echo '*> -libf[lags] can be used to add INITGLOBAL/INITINSTANCE and/or'
 echo '   TERMGLOBAL/TERMINSTANCE flags to the dynamically-linked library.'
 echo '*> -nocrt[dll] switch will disable linking the library against emx''s'
 echo '   C runtime DLLs.'
 echo '*> -nolxl[ite] switch will disable running lxlite on the resulting DLL.'
 echo '*> All other switches (for example -L./ or -lmylib) will be passed'
 echo '   unchanged to GCC at the end of command line.'
 echo '*> If you create a DLL from a library and you do not specify -o,'
 echo '   the basename for DLL and import library will be set to library name,'
 echo '   the initial library will be renamed to 'name'_s.a (_s for static)'
 echo '   i.e. "dllar gcc.a" will create gcc.dll and gcc.a, and the initial'
 echo '   library will be renamed into gcc_s.a.'
 echo '--------'
 echo 'Example:'
 echo '   dllar -o gcc290.dll libgcc.a -d "GNU C runtime library" -ord'
 echo '    -ex "__main __ctordtor*" -libf "INITINSTANCE TERMINSTANCE"'
 CleanUp
 exit 1
}

# Execute a command.
# If exit code of the commnad <> 0 CleanUp() is called and we'll exit the script.
# @Uses    Whatever CleanUp() uses.
doCommand() {
    echo "$*"
    eval $*
    rcCmd=$?

    if [ $rcCmd -ne 0 ]; then
        echo "command failed, exit code="$rcCmd
        CleanUp
        exit $rcCmd
    fi
}

# main routine
# setup globals
cmdLine=$*
outFile=""
outimpFile=""
inputFiles=""
description=""
CC=gcc.exe
CFLAGS="-s -Zcrtdll"
EXTRA_CFLAGS=""
EXPORT_BY_ORDINALS=0
exclude_symbols=""
library_flags=""
curDir=`pwd`
curDirS=curDir
case $curDirS in
*/)
  ;;
*)
  curDirS=${curDirS}"/"
  ;;
esac
# Parse commandline
libsToLink=0
omfLinking=0
while [ $1 ]; do
    case $1 in
    -ord*)
        EXPORT_BY_ORDINALS=1;
        ;;
    -o*)
	shift
        outFile=$1
	;;
    -i*)
        shift
        outimpFile=$1
        ;;
    -d*)
        shift
        description=$1
        ;;
    -f*)
        shift
        CFLAGS=$1
        ;;
    -c*)
        shift
        CC=$1
        ;;
    -h*)
        PrintHelp
        ;;
    -ex*)
        shift
        exclude_symbols=${exclude_symbols}$1" "
        ;;
    -libf*)
        shift
        library_flags=${library_flags}$1" "
        ;;
    -nocrt*)
        CFLAGS="-s"
        ;;
    -nolxl*)
        flag_USE_LXLITE=0
        ;;
    -* | /*)
        case $1 in
        -L* | -l*)
            libsToLink=1
            ;;
        -Zomf)
            omfLinking=1
            ;;
        *)
            ;;
        esac
        EXTRA_CFLAGS=${EXTRA_CFLAGS}" "$1
        ;;
    *.dll)
        EXTRA_CFLAGS="${EXTRA_CFLAGS} `basnam $1 .dll`"
        if [ $omfLinking -eq 1 ]; then
            EXTRA_CFLAGS="${EXTRA_CFLAGS}.lib"
	else
            EXTRA_CFLAGS="${EXTRA_CFLAGS}.a"
        fi
        ;;
    *)
        found=0;
        if [ $libsToLink -ne 0 ]; then
            EXTRA_CFLAGS=${EXTRA_CFLAGS}" "$1
        else
            for file in $1 ; do
                if [ -f $file ]; then
                    inputFiles="${inputFiles} $file"
                    found=1
                fi
            done
            if [ $found -eq 0 ]; then
                echo "ERROR: No file(s) found: "$1
                exit 8
            fi
        fi
      ;;
    esac
    shift
done # iterate cmdline words

#
if [ -z "$inputFiles" ]; then
    echo "dllar: no input files"
    PrintHelp
fi

# Now extract all .o files from .a files
newInputFiles=""
for file in $inputFiles ; do
    case $file in
    *.a | *.lib)
        case $file in
        *.a)
            suffix=".a"
            AR="ar"
            ;;
        *.lib)
            suffix=".lib"
            AR="emxomfar"
            EXTRA_CFLAGS="$EXTRA_CFLAGS -Zomf"
            ;;
        *)
            ;;
        esac
        dirname=`basnam $file $suffix`"_%"
        mkdir $dirname
        if [ $? -ne 0 ]; then
            echo "Failed to create subdirectory ./$dirname"
            CleanUp
            exit 8;
        fi
        # Append '!' to indicate archive
        newInputFiles="$newInputFiles ${dirname}!"
        doCommand "cd $dirname; $AR x ../$file"
        cd $curDir
        found=0;
        for subfile in $dirname/*.o* ; do
            if [ -f $subfile ]; then
                found=1
                if [ -s $subfile ]; then
	            # FIXME: This should be: is file size > 32 byte, _not_ > 0!
                    newInputFiles="$newInputFiles $subfile"
                fi
            fi
        done
        if [ $found -eq 0 ]; then
            echo "WARNING: there are no files in archive \'$file\'"
        fi
        ;;
    *)
        newInputFiles="${newInputFiles} $file"
        ;;
    esac
done
inputFiles="$newInputFiles"

# Output filename(s).
do_backup=0;
if [ -z $outFile ]; then
    do_backup=1;
    set outFile $inputFiles; outFile=$2
fi

# If it is an archive, remove the '!' and the '_%' suffixes
case $outFile in
*_%!)
    outFile=`basnam $outFile _%!`
    ;;
*)
    ;;
esac
case $outFile in
*.dll)
    outFile=`basnam $outFile .dll`
    ;;
*.DLL)
    outFile=`basnam $outFile .DLL`
    ;;
*.o)
    outFile=`basnam $outFile .o`
    ;;
*.obj)
    outFile=`basnam $outFile .obj`
    ;;
*.a)
    outFile=`basnam $outFile .a`
    ;;
*.lib)
    outFile=`basnam $outFile .lib`
    ;;
*)
    ;;
esac
case $outimpFile in
*.a)
    outimpFile=`basnam $outimpFile .a`
    ;;
*.lib)
    outimpFile=`basnam $outimpFile .lib`
    ;;
*)
    ;;
esac
if [ -z $outimpFile ]; then
    outimpFile=$outFile
fi
defFile="${outFile}.def"
arcFile="${outimpFile}.a"
arcFile2="${outimpFile}.lib"

#create $dllFile as something matching 8.3 restrictions,
dllFile="$outFile"
case $dllFile in
*wx_base_*)
    dllFile=`echo $dllFile | sed 's/base_\(...\)/b\1/'`
    ;;
*wx_*_*)
    dllFile=`echo $dllFile | sed 's/_\(..\)[^_]*_\(..\)[^-]*-/\1\2/'`
    ;;
*)
    ;;
esac
dllFile="`echo $dllFile | sed 's/\.//' | sed 's/_//' | sed 's/-//'`"


if [ $do_backup -ne 0 ] ; then
    if [ -f $arcFile ] ; then
        doCommand "mv $arcFile ${outFile}_s.a"
    fi
    if [ -f $arcFile2 ] ; then
        doCommand "mv $arcFile2 ${outFile}_s.lib"
    fi
fi

# Extract public symbols from all the object files.
tmpdefFile=${defFile}_%
rm -f $tmpdefFile
for file in $inputFiles ; do
    case $file in
    *!)
        ;;
    *)
        doCommand "emxexp -u $file >> $tmpdefFile"
        ;;
    esac
done

# Create the def file.
rm -f $defFile
echo "LIBRARY `basnam $dllFile` $library_flags" >> $defFile
dllFile="$dllFile.dll"
if [ ! -z $description ]; then
    echo "DESCRIPTION  \"${description}\"" >> $defFile
fi
echo "EXPORTS" >> $defFile

doCommand "cat $tmpdefFile | sort.exe | uniq.exe > ${tmpdefFile}%"
grep -v "^ *;" < ${tmpdefFile}% | grep -v "^ *$" >$tmpdefFile

# Checks if the export is ok or not.
for word in $exclude_symbols; do
    grep -v $word < $tmpdefFile >${tmpdefFile}%
    mv ${tmpdefFile}% $tmpdefFile
done


if [ $EXPORT_BY_ORDINALS -ne 0 ]; then
    sed "=" < $tmpdefFile | \
    sed '
      N
      : loop
      s/^\([0-9]\+\)\([^;]*\)\(;.*\)\?/\2 @\1 NONAME/
      t loop
    ' > ${tmpdefFile}%
    grep -v "^ *$" < ${tmpdefFile}% > $tmpdefFile
else
    rm -f ${tmpdefFile}%
fi
cat $tmpdefFile >> $defFile
rm -f $tmpdefFile

# Do linking, create implib, and apply lxlite.
gccCmdl="";
for file in $inputFiles ; do
    case $file in
    *!)
        ;;
    *)
        gccCmdl="$gccCmdl $file"
        ;;
    esac
done
doCommand "$CC $CFLAGS -Zdll -o $dllFile $defFile $gccCmdl $EXTRA_CFLAGS"
touch "${outFile}.dll"

doCommand "emximp -o $arcFile $defFile"
if [ $flag_USE_LXLITE -ne 0 ]; then
    add_flags="";
    if [ $EXPORT_BY_ORDINALS -ne 0 ]; then
        add_flags="-ynd"
    fi
    doCommand "lxlite -cs -t: -mrn -mln $add_flags $dllFile"
fi
doCommand "emxomf -s -l $arcFile"

# Successful exit.
CleanUp 1
exit 0