2.1 Compiling Software the Unix Way

If you’ve ever installed a Unix/Linux package from a source distribution, you’ve probably gotten used to the two-step process:

./configure
make install

• The configure script runs a series of tests on the compilation environment, e.g.,

  • operating system
  • compiler name
  • availability of selected libraries/header files
  • availability and/or behavior of selected functions

• Produces a Makefile and a configuration header config.h based upon the test results

• Source code may use conditional compilation based on the header to select appropriate code

2.2 Generating The configure Script

A rough outline:

1. Create a configure.ac
2. Set up config.h.in (template for eventual config.h file)
3. Set up Makefile.am
4. Set up files NEWS README AUTHORS ChangeLog
5. Run autoreconf

2.3.1 1. Create a configure.ac

AC_INIT(cppSpreadsheet, 1.0, zeil@cs.odu.edu)
AC_PREREQ([2.68])                            ➀
AM_INIT_AUTOMAKE([1.16 foreign no-define])
AC_CONFIG_HEADERS([config.h])
AC_PROG_CXX                                 ➁
AC_CONFIG_FILES([Makefile])
AC_OUTPUT

• ➀ Make sure autoconf is at least version 2.68
• ➁ Search for a C++ compiler and make sure one is available.
• Some common tests that might be added before the final AC_OUTPUT include:
  • AC_CHECK_FILE(file): check to see if a file exists
  • AC_CHECK_LIB(library): check to see if a library is already installed
  • AC_SEARCH_LIBS(function): search for an installed library that provides this function
  • AC_FUNC_MALLOC: check to see if the malloc function exists and appears to behave as expected.
    • This is one of a whole slew of AC_FUNC_… options

2.3.2 Preparing the templates

2: Set up config.h.in (template for eventual config.h file)

3: Set up Makefile.am

AM_INIT_AUTOMAKE([1.10 no-define foreign])

bin_PROGRAMS = testssheet

testssheet_SOURCES=testssheet.cpp exprparser.cpp tokenizer.cpp exprfactory.cpp expression.cpp \
     cellname.cpp numericnode.cpp stringnode.cpp cellrefnode.cpp negatenode.cpp \
     absnode.cpp sqrtnode.cpp sumnode.cpp lessnode.cpp lesseqnode.cpp \
     greaternode.cpp greatereqnode.cpp equalnode.cpp notequalnode.cpp plusnode.cpp \
     subtractnode.cpp timesnode.cpp dividesnode.cpp ifnode.cpp \
     numvalue.cpp strvalue.cpp errvalue.cpp spreadsheet.cpp cell.cpp \
     observable.cpp observerptrseq.cpp cellptrseq.cpp cellnameseq.cpp \
     absnode.h          control.h        lessnode.h        ssi.h \
     binarynode.h       dividesnode.h    minusnode.h       ssview.h \
     cell.h             elementseq.h     negatenode.h      streamtok.h \
     celllistenerseq.h  equalnode.h      notequalnode.h    stringnode.h \
     cellname0.h        errvalue.h       numericnode.h     strvalue.h \
     cellname.h         expression.h     numvalue.h        subtractnode.h \
     cellnameseq.h      exprfactory.h    observable.h      sumnode.h \
     cellptrseq.h       exprparser.h     observer.h        timesnode.h \
     cellrange.h        greatereqnode.h  observerptrseq.h  unaryexpr.h \
     cellrefnode.h      greaternode.h    plusnode.h        unarynode.h \
     clipboard.h        ifnode.h         spreadsheet.h     unittest.h \
     constantnode.h     lesseqnode.h     sqrtnode.h        value.h

2.3.3 Generating the configure Script

4: touch NEWS README AUTHORS ChangeLog

or create real versions of these.

5: run autoreconf --force --install

• Runs the sequence of programs: aclocal autoconf autoheader automake
• Creates config.h.in Makefile.in & configure

• imake for X code

3 Dynamic Loading

autoconf is C/C++-centric

The configure approach relies heavily on conditional compilation features.

• Common in C++

• Only in Java via non-standard techniques

Java programs are more likely varied be altering entire classes at a time.

For example:

public abstract class OCRLauncher extends Thread {
    /**
     * Launch an OCR process to convert the input
     * PDF into some kind of File  of OCR output.
     *
     * @param inputPDFfile The PDF file to be converted to IDM (XML)
     * @param outputFile The raw OCR output
     * @return
     */
    public abstract boolean convertPDFtoOCR
       (File inputPDFfile, File outputFile)
            throws Exception;

    /**
     * Convert a file of OCR output into IDM
     *
     * @param inputOCRfile
     *
     * @return XML (IDM) document
     */
    public abstract Document convertOCRtoIDM
       (File inputOCRfile) throws Exception;
}

This class has distinct implementations for different OCR programs that might be installed on the running system.

A property file, loaded at run time, specifies which class is actually desired:

input.OCRLauncherClass=edu.odu.cs.extract.input.OCRBatchLauncher
input.OCRProgram=OCR
input.OCRBatch=Batch
input.ocr.in_dir=c:/Luratech/ocr_in
input.ocr.out_dir=c:/Luratech/ocr_out

And the desired class is loaded dynamically:

String OCRLauncherName
   = p.getProperty(Properties.Names.OCR_LAUNCH_CLASS);
Class<?> ocrLauncherClass
   = Class.forName(OCRLauncherName);
ocr = (OCRLauncher)ocrLauncherClass.newInstance();
idmDoc = ocr.convertOCRtoIDM(inputOCR);