#                   Version for system-less builds.
#
#
# bin_PROGRAMS     .. list of the require binary programs
# include_HEADERS  .. list of the user-space public header files
# lib_LIBRARIES    .. list of the user-space libraries
# lib_LDSCRIPTS    .. list of LD scripts that should be copied to the lib direcotry
# lib_obj_SOURCES  .. list of source files which should be compiled and
#		      the produced object file placed to the lib directory (e.g. crt0.S)
# shared_LIBRARIES .. list of the user-space shared libraries
# nobase_include_HEADERS .. public headers copied even with directory part
# renamed_include_HEADERS .. public headers copied to the different target name (xxx.h->yyy.h)
# utils_PROGRAMS   .. list of the development utility programs (compiled for host computer, this might change in future)
# xxx_SOURCES      .. list of specific target sources
# xxx_LIBS         .. list of specific target libraries
# INCLUDES         .. additional include directories and defines for user-space
# lib_LOADLIBES    .. list of libraries linked to each executable
# link_VARIANTS    .. list of ld script suffixes (after hypen `-') that
#                     should be used for linking (e.g. ram flash). If this is not
#		      specified, then the value of DEFAULT_LD_SCRIPT_VARIANT from config.target is used.
# PREFIX_DIR       .. Prefix to  directories in _compiled and _build. Used in config.omk.

# Some support to serialize some targets for parallel make
ifneq ($(OMK_SERIALIZE_INCLUDED),y)
include-pass: $(check-dir)
library-pass: include-pass
binary-pass utils-pass: library-pass

OMK_SERIALIZE_INCLUDED = y
endif

ifeq ($(wildcard $(MAKERULES_DIR)/config.target),$(MAKERULES_DIR)/config.target)
$(error Please, rename $(MAKERULES_DIR)/config.target to config.omk!)
endif

BUILD_DIR_NAME = _build$(addprefix /,$(PREFIX_DIR))
COMPILED_DIR_NAME = _compiled$(addprefix /,$(PREFIX_DIR))

LOCAL_BUILD_DIR=$(MAKERULES_DIR)/$(BUILD_DIR_NAME)/$(RELATIVE_DIR)
#$(warning LOCAL_BUILD_DIR = $(LOCAL_BUILD_DIR))

#=====================================================================
# Common utility rules

link_VARIANTS ?= $(DEFAULT_LD_SCRIPT_VARIANT)


#=====================================================================
# Include correct rules for just running pass

USER_COMPILED_DIR_NAME=$(MAKERULES_DIR)/$(COMPILED_DIR_NAME)

USER_INCLUDE_DIR := $(USER_COMPILED_DIR_NAME)/include
USER_LIB_DIR     := $(USER_COMPILED_DIR_NAME)/lib
USER_UTILS_DIR   := $(USER_COMPILED_DIR_NAME)/bin-utils
USER_BIN_DIR     := $(USER_COMPILED_DIR_NAME)/bin
USER_OBJS_DIR    := $(LOCAL_BUILD_DIR)


# -------------------------------------
# Rules for compilation for target
ifdef TARGET_RULE_TEMPLATES

LDFLAGS += -nostartfiles

 # FIXME: These are not used. What they are good for?
LIB_CPPFLAGS += $(CPPFLAGS)
LIB_CFLAGS   += $(CFLAGS)

SOLIB_PICFLAGS += -shared -fpic

CFLAGS += -DOMK_FOR_TARGET

INCLUDE_DIR := $(USER_INCLUDE_DIR)
LIB_DIR     := $(USER_LIB_DIR)
OBJS_DIR    := $(USER_OBJS_DIR)

$(eval $(COMPILER_DEFS_template))

# Special rules for CMETRIC generated headers

$(foreach cmetrh,$(cmetric_include_HEADERS),$(eval $(call COMPILE_c_o_template,\
		$(SOURCES_DIR)/$($(basename $(notdir $(cmetrh)))_CMETRIC_SOURCES),\
		$($(basename $(notdir $(cmetrh)))_CMETRIC_SOURCES:%.c=%.o),)))
$(foreach cmetrh,$(cmetric_include_HEADERS),$(eval $(call CMETRIC_o_h_template,\
		$($(basename $(notdir $(cmetrh)))_CMETRIC_SOURCES:%.c=%.o),\
		$(addprefix $(USER_INCLUDE_DIR)/,$(cmetrh)))))

GEN_HEADERS+=$(cmetric_include_HEADERS:%=$(USER_INCLUDE_DIR)/%)

# Generate rules for compilation of programs and libraries
$(foreach prog,$(bin_PROGRAMS),$(foreach link,$(link_VARIANTS),$(eval $(call PROGRAM_template,$(prog),$(USER_BIN_DIR),$(link)))))
$(foreach lib,$(lib_LIBRARIES),$(eval $(call LIBRARY_template,$(lib))))
#$(foreach src,$(lib_obj_SOURCES),$(eval $(call LIBOBJ_template,$(addsuffix .o,$(basename $(src)))))) # FIXME: This can't work LIBOBJ_template is not defined
$(foreach lib,$(shared_LIBRARIES),$(eval $(call SOLIB_template,$(lib))))

# User-space static libraries and applications object files
SOURCES := $(sort $(SOURCES))
#$(warning SOURCES = $(SOURCES))

# User-space shared libraries object files
SOLIB_SOURCES := $(sort $(SOLIB_SOURCES))
#$(warning SOLIB_SOURCES = $(SOLIB_SOURCES))


# The above generated rules produced $(SOURCES) and $(SOLIB_SOURCES)
# variables. Now generate rules for compilation of theese sources
$(foreach src,$(filter %.c,$(SOURCES)),$(eval $(call COMPILE_c_o_template,$(SOURCES_DIR)/$(src),$(src:%.c=%.o),)))
$(foreach src,$(filter %.cc,$(SOURCES)),$(eval $(call COMPILE_cc_o_template,$(SOURCES_DIR)/$(src),$(src:%.cc=%.o),)))
$(foreach src,$(filter %.cxx,$(SOURCES)),$(eval $(call COMPILE_cc_o_template,$(SOURCES_DIR)/$(src),$(src:%.cxx=%.o),)))
$(foreach src,$(filter %.S,$(SOURCES)),$(eval $(call COMPILE_S_o_template,$(SOURCES_DIR)/$(src),$(src:%.S=%.o),)))

$(foreach src,$(filter %.c,$(SOLIB_SOURCES)),$(eval $(call COMPILE_c_o_template,$(SOURCES_DIR)/$(src),$(src:%.c=%.lo),$(SOLIB_PICFLAGS))))
$(foreach src,$(filter %.cc,$(SOLIB_SOURCES)),$(eval $(call COMPILE_cc_o_template,$(SOURCES_DIR)/$(src),$(src:%.cc=%.lo),$(SOLIB_PICFLAGS))))
$(foreach src,$(filter %.cxx,$(SOLIB_SOURCES)),$(eval $(call COMPILE_cc_o_template,$(SOURCES_DIR)/$(src),$(src:%.cxx=%.lo),$(SOLIB_PICFLAGS))))
$(foreach src,$(filter %.S,$(SOLIB_SOURCES)),$(eval $(call COMPILE_S_o_template,$(SOURCES_DIR)/$(src),$(src:%.S=%.lo),$(SOLIB_PICFLAGS))))

library-pass-local: $(addprefix $(USER_INCLUDE_DIR)/,$(cmetric_include_HEADERS)) \
		    $(lib_LIBRARIES:%=$(LIB_DIR)/lib%.a) $(shared_LIBRARIES:%=$(LIB_DIR)/lib%.so) \
		    $(addprefix $(LIB_DIR)/,$(lib_OBJS))

binary-pass-local:  $(foreach link,$(link_VARIANTS),$(bin_PROGRAMS:%=$(USER_BIN_DIR)/%-$(link)) \
		    $(foreach of,$(OUTPUT_FORMATS),$(bin_PROGRAMS:%=$(USER_BIN_DIR)/%-$(link).$(of))))


endif # TARGET_RULE_TEMPLATES


# -------------------------------------
# Rules for compilation utilities for host (user space)
ifdef HOST_RULE_TEMPLATES

CROSS_COMPILE =
TARGET_ARCH =

SOLIB_PICFLAGS += -shared -fpic

# For host compilation, we don't use a specfic ld script
LD_SCRIPT =

# TODO: It is probably better to use different directories for host
# includes, libraries and objects
INCLUDE_DIR := $(USER_INCLUDE_DIR)
LIB_DIR     := $(USER_LIB_DIR)
OBJS_DIR    := $(USER_OBJS_DIR)

$(eval $(COMPILER_DEFS_template))

 #User-space static libraries and applications object files
#SOURCES := $(sort $(SOURCES))
#$(warning SOURCES = $(SOURCES))

# Generate rules for compilation of utility programs
$(foreach prog,$(utils_PROGRAMS),$(eval $(call PROGRAM_template,$(prog),$(USER_UTILS_DIR),)))

# The above generated rule produced $(SOURCES) variable. Now generate
# rules for compilation of theese sources
$(foreach src,$(filter %.c,$(SOURCES)),$(eval $(call COMPILE_c_o_template,$(SOURCES_DIR)/$(src),$(src:%.c=%.o),)))
$(foreach src,$(filter %.cc,$(SOURCES)),$(eval $(call COMPILE_cc_o_template,$(SOURCES_DIR)/$(src),$(src:%.cc=%.o),)))
$(foreach src,$(filter %.cxx,$(SOURCES)),$(eval $(call COMPILE_cc_o_template,$(SOURCES_DIR)/$(src),$(src:%.cxx=%.o),)))
$(foreach src,$(filter %.S,$(SOURCES)),$(eval $(call COMPILE_S_o_template,$(SOURCES_DIR)/$(src),$(src:%.S=%.o),)))

utils-pass-local: $(utils_PROGRAMS:%=$(USER_UTILS_DIR)/%)

endif # HOST_RULE_TEMPLATES


#=====================================================================
# Automatic loading of compiled program by issuing "make load"

ifneq ($(OUTPUT_FORMATS),)
# Select a file extension (e.g. .bin) for "make load" command to load.
LOAD_EXTENSION = .$(firstword $(OUTPUT_FORMATS))
endif

# Syntax: $(call LOAD_PROGRAM_template,<executable-name>,<dir>,<link-variant>)
# Used to load program to the target hardware
define LOAD_PROGRAM_template
.PHONY: load-$(1)$(3:%=-%)
load-$(1)$(3:%=-%): $(2)/$(1)$(3:%=-%)$(LOAD_EXTENSION)
	@$(QUIET_CMD_ECHO) "  LOAD    $$<"
	@if [ -z "$$(LOAD_CMD$(3:%=-%))" ]; then echo "No command for loading applications to '$(3)' is specified."; exit 1; fi
	$(Q) $$(LOAD_CMD$(3:%=-%)) $$<
endef

# Syntax: $(call LOAD__RUN_VARIANT_template,<link-variant>)
# Used to load and/or run non-default variant of the default program
define LOAD_RUN_VARIANT_template
.PHONY: load-$(1) run-$(1)

load-$(1): load-$(firstword $(bin_PROGRAMS))-$(1)

run-$(1):
	@$(QUIET_CMD_ECHO) "  RUN     $(1)"
	@if [ -z "$(RUN_CMD-$(1))" ]; then echo "No command for running '$(1)' variant is specified."; exit 1; fi
	$(Q) $(RUN_CMD-$(1))

endef

$(foreach link,$(link_VARIANTS),$(foreach prog,$(bin_PROGRAMS),$(eval $(call LOAD_PROGRAM_template,$(prog),$(USER_BIN_DIR),$(link)))))
$(foreach link,$(link_VARIANTS),$(eval $(call LOAD_RUN_VARIANT_template,$(link))))

.PHONY: load run
load: $(addprefix load-,$(firstword $(bin_PROGRAMS))-$(firstword $(link_VARIANTS)))

run: run-$(firstword $(link_VARIANTS))



#=====================================================================
# Generate pass rules from generic templates
OTHER_PASSES = dep clean install

$(eval $(call omk_pass_template, include-pass, $(LOCAL_BUILD_DIR),,-n "$(include_HEADERS)$(nobase_include_HEADERS)$(renamed_include_HEADERS)$(lib_LDSCRIPTS)"))
$(eval $(call omk_pass_template, library-pass, $(LOCAL_BUILD_DIR),TARGET_RULE_TEMPLATES=y, -n "$(lib_LIBRARIES)$(shared_LIBRARIES)$(lib_OBJS)"))
$(eval $(call omk_pass_template, binary-pass,  $(LOCAL_BUILD_DIR),TARGET_RULE_TEMPLATES=y, -n "$(bin_PROGRAMS)"))
$(eval $(call omk_pass_template, utils-pass,   $(LOCAL_BUILD_DIR),HOST_RULE_TEMPLATES=y,-n "$(utils_PROGRAMS)"))


$(eval $(call omk_pass_template,$(OTHER_PASSES),$(LOCAL_BUILD_DIR)))


dep-local:

install-local:

# TODO: Check modification date of changed header files. If it is
# newer that in source dir, show a warning.
include-pass-local:
#	@$(call mkdir_def,$(USER_INCLUDE_DIR))
	@$(foreach f, $(include_HEADERS), cmp --quiet $(SOURCES_DIR)/$(f) $(USER_INCLUDE_DIR)/$(notdir $(f)) \
	   || cp $(CP_FLAGS) $(SOURCES_DIR)/$(f) $(USER_INCLUDE_DIR)/$(notdir $(f)) || exit 1 ; )
	@$(foreach f, $(nobase_include_HEADERS), cmp --quiet $(SOURCES_DIR)/$(f) $(USER_INCLUDE_DIR)/$(f) \
	   || ( mkdir -p $(USER_INCLUDE_DIR)/$(dir $(f)) && cp $(CP_FLAGS) $(SOURCES_DIR)/$(f) $(USER_INCLUDE_DIR)/$(f) ) || exit 1 ; )
	@$(foreach f, $(renamed_include_HEADERS), \
	   srcfname=`echo '$(f)' | sed -e 's/^\(.*\)->.*$$/\1/'` ; destfname=`echo '$(f)' | sed -e 's/^.*->\(.*\)$$/\1/'` ; \
	   cmp --quiet $(SOURCES_DIR)/$${srcfname} $(USER_INCLUDE_DIR)/$${destfname} \
	   || ( mkdir -p `dirname $(USER_INCLUDE_DIR)/$${destfname}` && cp $(CP_FLAGS) $(SOURCES_DIR)/$${srcfname} $(USER_INCLUDE_DIR)/$${destfname} ) || exit 1 ; )
	@$(foreach f, $(lib_LDSCRIPTS), cmp --quiet $(SOURCES_DIR)/$(f) $(USER_LIB_DIR)/$(notdir $(f)) \
	   || cp $(CP_FLAGS) $(SOURCES_DIR)/$(f) $(USER_LIB_DIR)/$(notdir $(f)) || exit 1 ; )


.PHONY: clean-custom
clean-local: clean-custom
	@echo Cleaning in $(USER_OBJS_DIR)
	@rm -f $(USER_OBJS_DIR)/*.o $(USER_OBJS_DIR)/*.lo \
	       $(USER_OBJS_DIR)/*.d \
	       $(USER_OBJS_DIR)/*.map \
	       $(LOCAL_CONFIG_H:%=$(USER_OBJS_DIR)/%)

check-dir:
	@$(call mkdir_def,$(USER_INCLUDE_DIR))
	@$(call mkdir_def,$(USER_LIB_DIR))
	@$(call mkdir_def,$(USER_BIN_DIR))
	@$(call mkdir_def,$(USER_UTILS_DIR))

# Create directories only for the first time
ifndef CHECK_DIR_DONE
check-dir = check-dir
CHECK_DIR_DONE = y
endif
export CHECK_DIR_DONE

# Which passes to pass
default: $(check-dir) include-pass library-pass binary-pass utils-pass

ETAGS = etags -R -f $(MAKERULES_DIR)/TAGS
.PHONY: TAGS
TAGS:
	$(ETAGS)    $(MAKERULES_DIR)/app
	$(ETAGS) -a $(MAKERULES_DIR)/arch/$(ARCH)/generic
	$(ETAGS) -a $(MAKERULES_DIR)/arch/$(ARCH)/mach-$(MACH)
	$(ETAGS) -a $(MAKERULES_DIR)/board/$(BOARD)
	$(ETAGS) -a $(MAKERULES_DIR)/libs4c

# Local Variables:
# mode:makefile
# End: