Makefile

# this is <Makefile>
# ----------------------------------------------------------------------------
#   ($Id$)
# 
# 05/06/2001 by Thomas Forbriger (IMGF Frankfurt)
# 
# C++ interface for PGPLOT
#
# ----
# This program 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 of the License, or
# (at your option) any later version. 
# 
# This program 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 this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
# ----
# 
# REVISIONS and CHANGES
#    05/06/2001   V1.0   Thomas Forbriger
#    14/11/2002   V1.1   place docu on the WWW
#    28/12/2008   v1.2   reorganized Makefile and provide separate
#                        subdirectory for header files
#    18/09/2010   V1.3   start migration to SVN scheme
#                        - check variables
#                        - copy headers (no symbolic links)
#                        - new doxygen definitions
#                        - package creation not yet implemented
#                        - set TF_REMCMMNT to cat if not defined
# 
# ============================================================================
# 

all: install example doxydoc
install: install-include libpgplotCpp.a

# ============================================================================
#
CHECKVAR=$(if $($(1)),,$(error ERROR: missing variable $(1)))
CHECKVARS=$(foreach var,$(1),$(call CHECKVAR,$(var)))
#

$(call CHECKVARS,LOCINCLUDEDIR LOCLIBDIR)
$(call CHECKVARS,TF_BROWSER TF_WWWBASEDIR TF_LINK_PGPLOT TF_LINK_FORTRAN)

PGPLOTLIB=-lpgplotCpp -lcpgplot \
          $(TF_LINK_PGPLOT)  \
          -L$(LOCLIBDIR)

# root headers are those that must be installed in the root of the include
# directory hierarchy for historical reasons
ROOTHEADERS=pgplotCpp.h spcpgplotCpp.h xpgplotCpp.h affpgplot.h
HEADERS=$(ROOTHEADERS) pghandle.h
# only library source code
SRC=xpgplotCpp.cc affpgplot.cc pgplotCpp.cc
# example and test source code
EXSRC=pgtestxx.cc XpgplotCpp.cc

ROOTINCINSTALLPATH=$(LOCINCLUDEDIR)
INCINSTALLPATH=$(ROOTINCINSTALLPATH)/pgplotxx
LIBINSTALLPATH=$(LOCLIBDIR)

# name of headers with comments stripped off
STRIPHEADER=$(addsuffix .strip,$(notdir $(HEADERS)))
# name of installed (exported) header files
INSTHEADER=$(addprefix $(INCINSTALLPATH)/,$(notdir $(HEADERS)))
INSTROOTHEADER=$(addprefix $(ROOTINCINSTALLPATH)/,$(notdir $(ROOTHEADERS)))

# if defined, empty lines are kept in stripped comment headers
# to synchronize line numbers
EMPTYPRINT=1
#EMPTYPRINT=0

# define this to be cat in case you do not have remcmmnt available
ifndef TF_REMCMMNT
TF_REMCMMNT=cat
endif

FLAGS+=$(MYFLAGS)
CXXFLAGS+=$(FLAGS) 
LDFLAGS+=-L$(LOCLIBDIR)
CPPFLAGS+=-I$(LOCINCLUDEDIR) -I$(SERVERINCLUDEDIR) $(FLAGS)

flist: Makefile $(HEADERS) $(SRC) doxydoc.cfg $(EXSRC)
	echo $^ | tr ' ' '\n' | sort > $@

.PHONY: edit
edit: flist; vim $<

.PHONY: clean
clean: ; 
	-find . -name \*.bak | xargs --no-run-if-empty /bin/rm -v
	-find . -name \*.o | xargs --no-run-if-empty /bin/rm -v
	-find . -name \*.d | xargs --no-run-if-empty /bin/rm -v
	-find . -name \*.hd | xargs --no-run-if-empty /bin/rm -v
	-/bin/rm -vf flist *.o install-include *.strip libtpgplotCpp.a
	-/bin/rm -fv XpgplotCpp

#======================================================================
# dependencies
# ------------

%.d: %.cc
	$(SHELL) -ec '$(CXX) -M $(CPPFLAGS) $< \
      | sed '\''s,\($(notdir $*)\)\.o[ :]*,$(dir $@)\1.o $@ : ,g'\'' \
        > $@; \
      [ -s $@ ] || rm -f $@'

-include $(patsubst %.cc,%.d,$(SRC) $(EXSRC))


#======================================================================
# library part
# ------------

libpgplotCpp.a: $(SRC:.cc=.o)
	ar rcv $@ $^
	ranlib $@
	/bin/mv -vf $@ $(LIBINSTALLPATH)

#----------------------------------------------------------------------
# comment stripping

%.hd: %.h; echo $(notdir $<.strip): $< > $@

-include $(patsubst %.h,%.hd,$(HEADERS))

# first awk rule assumes that the first non-comment line starts with '#'
# and that the first (copyright) comment end with pattern "^ */"
%.h.strip: 
	awk 'BEGIN {hot=1;} /^ \*\// { if (hot) { hot=2; print; next;} }\
        /^#/ { hot=0; } \
        { if (hot==2) { print ""; } else if (hot) { print; } }' $< > $@
	$(TF_REMCMMNT) $< | awk 'BEGIN {hot=0;} \
        /^ *$$/ { if ((hot) && ($(EMPTYPRINT))) { print; } next; } \
        /^#/ { hot=1; } { if (hot) print; }' >> $@

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

$(INCINSTALLPATH)/%.h: %.h.strip
	mkdir -p $(INCINSTALLPATH)
	-rm -fv $@
	/bin/cp -vpd $< $@

$(ROOTINCINSTALLPATH)/%.h: %.h.strip
	mkdir -p $(ROOTINCINSTALLPATH)
	-rm -fv $@
	/bin/cp -vpd $< $@

.PHONY: install-include
install-include: $(INSTHEADER) $(INSTROOTHEADER)

#----------------------------------------------------------------------
# eaxmple and test code

XpgplotCpp: XpgplotCpp.o install; $(CXX) $< -o $@ $(PGPLOTLIB) -laff \
  $(TF_LINK_FORTRAN)
pgtestxx: pgtestxx.o install; $(CXX) $< -o $@ $(PGPLOTLIB) -laff -ltfxx \
  $(TF_LINK_FORTRAN)

pgtestxx.run: pgtestxx; pgtestxx -all; /bin/rm -fv pgtestxx

example: install XpgplotCpp; XpgplotCpp; rm -fv XpgplotCpp XpgplotCpp.o

#======================================================================
# documentation part
# ------------------
#
# targets commonly used:
# ----------------------
#
# make doxyclean        removes all documentation
# make doxydoc          creates doxygen documentation in the DOXYWWWPATH
# make doxyview         creates doxygen documentation and launches netscape to
#                       browse in the documentation
# make doxyconf         edit the doxygen configuration file
#
# If you launch "make doxydoc" the documentation will be written to
# DOXYWWWPATH (see below). This is meant to export the documentation through
# your homepage. The doxyfull directory is just a symbolic link to this
# directory.
#

$(call CHECKVARS,TF_WWWBASEDIR TF_BROWSER)

DOXYWWWPATH=$(TF_WWWBASEDIR)/libpgplotxx

.PHONY: doxyclean doxyview doxydoc doxyconf

doxyclean: ;/bin/rm -rfv $(DOXYWWWPATH)

DOXYSRC=$(CODE) $(HEADERS)

# create doxygen intermediate configuration
PWD=$(shell env pwd)
doxydoc.xxx: doxydoc.cfg
	sed 's,<OUTPUTDIRECTORY>,$(DOXYWWWPATH),g;s,<STRIPFROMPATH>,$(PWD),g' \
	  $< > $@
# create commented version of doxygen configuration
doxycomm.xxx: doxydoc.cfg
	/bin/cp -vf $< $@; doxygen -u $@

$(DOXYWWWPATH)/html/index.html: doxydoc.xxx $(DOXYSRC)
	mkdir -vp $(DOXYWWWPATH)
	doxygen $<

doxydoc: $(DOXYWWWPATH)/html/index.html

doxyview: $(DOXYWWWPATH)/html/index.html
	$(TF_BROWSER) file:$< &

#======================================================================
# create package
# --------------
# is delegated to Makefile.packages
# which still has to be coded
PACKAGE=libpgplotxx
#ifdef TF_MAKEPKG
#include $(TF_MAKEPKG)
#endif

# 
# ----- END OF Makefile -----