makefile

# define the C compiler to use
CC = g++

# define any compile-time flags
CFLAGS = -std=c++17 -Wall -O2
DEBUG_FLAGS = -std=c++17 -g -Wall -O2

# The header files of the LatMRG library and the LatticeTester library
INCLUDES = -I./include -I./latticetester/include

#Definition to compile with yafu on if it is included
ifeq ($(wildcard data/yafu),)
    YAFU =
else
    YAFU = -DUSE_YAFU
endif

# Library path. This assumes NTL is in /usr/local/lib (its default path).
STAT_LIBS_PATH = -Wl,-Bstatic -L$(LIB_DIR)
STAT_LIBS = -llatmrg -llatticetester
DYN_LIBS_PATH = -Wl,-Bdynamic -L/usr/local/lib
DYN_LIBS = -lntl -lgmp -ltinyxml2

# A few directories we need to be aware of
SRC_DIR = ./src
OBJ_DIR = ./obj
LIB_DIR = ./lib
BIN_DIR = ./bin
INC_DIR = ./include
PRO_DIR = ./progs

EX_DIR = ./examples
EX_BUILD = ./bin/examples

# Other source files locations
MRG_LOW = $(SRC_DIR)/latmrg

# The source files are in SRC_DIR. This grabs subdirectories
SRCS = $(wildcard $(MRG_LOW)/*.cc)
PROGS_CC = $(filter-out ./progs/SeekMain.cc, $(wildcard $(PRO_DIR)/*.cc))
PROGS_H = $(wildcard $(PRO_DIR)/*.h)
EX_CC = $(wildcard $(EX_DIR)/*.cc)

STA_OBJS = $(SRCS:$(SRC_DIR)/%.cc=$(OBJ_DIR)/%.o)
DYN_OBJS = $(SRCS:$(SRC_DIR)/%.cc=$(OBJ_DIR)/%.so)
PROGS_O = $(PROGS_CC:$(PRO_DIR)/%.cc=$(PRO_DIR)/%.o)
EX_O = $(EX_CC:%.cc=%.o)

LATTEST_DEP = $(wildcard latticetester/progs/*.cc) \
	      $(wildcard latticetester/src/*.cc) \
	      $(wildcard latticetester/include/latticetester/*.h)


# A separator to segment the information printed on screen

SEP = @echo ================================================================================

default: $(PROGS_O)
	@echo
	@echo 'LatMRG programs compiled in ./bin'

all: clean_all default doc

#===============================================================================
# Building the library

$(LIB_DIR)/liblatmrg.a: $(STA_OBJS) | message_lib $(LIB_DIR)
	rm -f $(LIB_DIR)/liblatmrg.a
	ar rcs $(LIB_DIR)/liblatmrg.a $(STA_OBJS)
	@echo
	@echo 'LatMRG library archive created: ./lib/liblatmrg.a'
	@echo

message_lib:
	$(SEP)
	@echo 'Building library(ies)'
	@echo

$(LIB_DIR):
	mkdir -p $(LIB_DIR)
	@echo

$(OBJ_DIR):
	mkdir -p $(OBJ_DIR)
	mkdir -p $(OBJ_DIR)/latmrg
	@echo

$(OBJ_DIR)/%.o:$(SRC_DIR)/%.cc $(INC_DIR)/%.h | message_obj $(OBJ_DIR)
	$(CC) $(CFLAGS) $(INCLUDES) $(YAFU) -c $< -o $@

message_obj:
	$(SEP)
	@echo 'Compiling the LatMRG library'
	@echo


#===============================================================================
#Included library tinyxml2

$(LIB_DIR)/libtinyxml2.a:$(OBJ_DIR)/tinyxml2.o | message_lib $(LIB_DIR) $(OBJ_DIR)
	$(CC) -fPIC $(INCLUDES) -c -o $^ $(SRC_DIR)/tinyxml2.cpp
	ar cr $@ $^
	ranlib $@
	@echo

$(OBJ_DIR)/tinyxml2.o:$(SRC_DIR)/tinyxml2.cpp

#===============================================================================
# Building the programs of ./progs

$(PRO_DIR)/%.o:$(LIB_DIR)/libtinyxml2.a $(LIB_DIR)/liblatticetester.a\
  $(LIB_DIR)/liblatmrg.a $(PRO_DIR)/%.cc $(PROGS_H) | message_progs $(BIN_DIR)
	$(CC) $(CFLAGS) $(INCLUDES) $(YAFU) -c $(PRO_DIR)/$(@:progs/%.o=%).cc -o $@
	$(CC) $@ $(STAT_LIBS_PATH) $(STAT_LIBS) $(DYN_LIBS_PATH) $(DYN_LIBS) \
	  -o $(BIN_DIR)/$(@:progs/%.o=%)

message_progs:
	$(SEP)
	@echo 'Building the LatMRG executables'

$(BIN_DIR):
	mkdir -p $(BIN_DIR)
	@echo

#===============================================================================
# Building the documentation

doc:
	$(SEP)
	@echo 'Building the documentation'
	@echo
	doxygen docs/doc/doc-gen
	@echo 'Documentation now in ./docs'
	@echo

#===============================================================================
# Installation/removal of LatMRG

install:
	$(SEP)
	@echo 'Creating folders'
	mkdir -p /usr/local/LatMRG
	mkdir -p /usr/local/LatMRG/lib
	mkdir -p /usr/local/LatMRG/bin
	@echo 'Copying files'
	cp ./bin/* /usr/local/LatMRG/bin
	cp ./lib/* /usr/local/LatMRG/lib

remove:
	rm -rf /usr/local/LatMRG


#===============================================================================
# Execution of the examples

PROGS_INPUTS = $(EX_DIR)/inputs

MK_XML = $(wildcard $(PROGS_INPUTS)/mk/mk*.xml)
PERIOD_XML = $(wildcard $(PROGS_INPUTS)/period/period*.xml)
LAT_XML = $(wildcard $(PROGS_INPUTS)/lat/lat*.xml)
SEEK_XML = $(wildcard $(PROGS_INPUTS)/seek/seek*.xml)

EX_PRE = $(EX_DIR)/outputs
EX_OUTPUTS = $(wildcard $(EX_PRE)/lat/*) $(wildcard $(EX_PRE)/mk/*) $(wildcard $(EX_PRE)/period/*)

# Don't call this unless you are reckless
examples:default mk_ex period_ex lattest_ex seek_ex

check_ex:default mk_ex period_ex lattest_ex
	@echo
	$(SEP)
	@echo 'Testing if examples outputs match'
	@echo
	@for filename in ./examples/outputs/mk/*;\
	  do foo=$${filename#"$(EX_PRE)"};\
	  foo="$(PROGS_INPUTS)$${foo}";\
	  if [ "$$(diff $$foo $$filename)" != "" ]; then\
	    echo "Example $$foo has errors."; else\
	    echo "Example $$foo executes as expected.";\
	  fi;\
        done
	@for filename in ./examples/outputs/period/*;\
	  do foo=$${filename#"$(EX_PRE)"};\
	  foo="$(PROGS_INPUTS)$${foo}";\
	  if [ "$$(diff $$foo $$filename)" != "" ]; then\
	    echo "Example $$foo has errors."; else\
	    echo "Example $$foo executes as expected.";\
	  fi;\
        done
	@for filename in ./examples/outputs/lat/*;\
	  do foo=$${filename#"$(EX_PRE)"};\
	  foo="$(PROGS_INPUTS)$${foo}";\
	  if [ "$$(diff $$foo $$filename)" != "" ]; then\
	    echo "Example $$foo has errors."; else\
	    echo "Example $$foo executes as expected.";\
	  fi;\
        done
	@echo
	$(SEP)
	@echo 'Cleaning test examples'
	@echo
	rm -f $(PROGS_INPUTS)/lat/lat*.res
	rm -f $(PROGS_INPUTS)/mk/mk*.res
	rm -f $(PROGS_INPUTS)/period/period*.res

mk_ex:
	@echo
	$(SEP)
	@echo 'FindMK examples'
	./bin/MRGLattice $(MK_XML)

period_ex:
	@echo
	$(SEP)
	@echo 'Period examples'
	./bin/MRGLattice $(PERIOD_XML)

lattest_ex:
	@echo
	$(SEP)
	@echo 'Lattest examples'
	./bin/MRGLattice $(LAT_XML)

seek_ex:
	@echo
	$(SEP)
	@echo 'Seek examples'
	./bin/MRGLattice $(SEEK_XML)

clean_ex:
	rm -f $(PROGS_INPUTS)/*/*.res

#===============================================================================
# LatticeTester related considerations

config_latticetester:
	@read -p 'Enter NTL prefix (default: /usr/local): ' NTL_PREFIX; \
	  if [ -z $$NTL_PREFIX ]; then\
	    NTL_PREFIX='--ntl /usr/local';\
	  else\
	    NTL_PREFIX='--ntl '$$NTL_PREFIX;\
	  fi;\
	  cd latticetester;\
	  ./waf configure $$NTL_PREFIX

$(LIB_DIR)/liblatticetester.a:$(LATTEST_DEP) | message_lib $(LIB_DIR)
	$(SEP)
	@echo 'Building/Updating LatticeTester with waf'
	@echo
	cd latticetester; ./waf build
	@echo 'LatticeTester build/update finished'
	@echo
	cp latticetester/build/src/liblatticetester.a $(LIB_DIR)
	@echo

clean_lattice:
	$(SEP)
	@echo 'Cleaning LatticeTester'
	@echo
	cd latticetester; ./waf clean
	@echo

#===============================================================================
# Cleaning stuff

clean: separator clean_lib clean_progs clean_doc
	@echo

clean_all: clean_lattice clean

clean_lib:
	rm -rf $(LIB_DIR)
	rm -rf $(OBJ_DIR)

clean_progs:
	rm -rf $(BIN_DIR)
	rm -f $(PRO_DIR)/*.o

clean_doc:
	rm -rf docs/*.html
	rm -rf docs/*.js
	rm -rf docs/*.png
	rm -rf docs/*.css
	rm -rf docs/search

#===============================================================================
# Graphical stuff

separator:
	$(SEP)
	@echo

#===============================================================================
# PHONY targets

.PHONY: doc clean clean_all examples $(EX_BUILD)/ $(EX_CC) separator\
  config_latticetester $(MK_DAT) mk_ex period_ex seek_ex lattest_ex $(EX_OUTPUTS)\
  install remove