#                   Version for SDCC builds.
#
# bin_PROGRAMS     .. list of the require binary programs
# test_PROGRAMS    .. list of the test 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)
# asm_build_HEADERS .. list of files copied to the build object directory
# 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.

CC = sdcc
OBJ_EXT = .rel
LIB_EXT = .lib
LIB_PREF =
AR = sdcclib
AS = asx8051
HC = packihx
HEX2BIN = true
OBJCOPY = objcopy
TARGETLOADER = ul_sendhex
ARFLAGS = -a
A51TOASX = $(MAKERULES_DIR)/a51toasx.sh

BUILD_DIR_NAME = _build
COMPILED_DIR_NAME = _compiled
GROUP_DIR_NAME =

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_TESTS_DIR   = $(USER_COMPILED_DIR_NAME)/bin-tests
USER_BIN_DIR     = $(USER_COMPILED_DIR_NAME)/bin
USER_OBJS_DIR    = $(LOCAL_BUILD_DIR)

.PHONY: check-dir

# 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

override OMK_SERIALIZE_INCLUDED = y
MAKEOVERRIDES := $(filter-out OMK_SERIALIZE_INCLUDED=n,$(MAKEOVERRIDES))
endif

CPPFLAGS  += -I $(USER_INCLUDE_DIR)

CPPFLAGS  += $(CONFIG_OMK_DEFINES)

CFLAGS  += $(TARGET_ARCH) 
LDFLAGS += $(TARGET_ARCH) 

LOADLIBES += -L$(USER_LIB_DIR) 

LOADLIBES += $(lib_LOADLIBES:%=-l%)

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

# Checks for OMK tester
ifdef OMK_TESTSROOT
default-config-pass-check include-pass-check:
library-pass-check binary-pass-check:
	@[ -x "$(shell which $(CC))" ] || $(call canttest,Cannot find compiler: $(CC))
	@[ -z "$(wildcard $(USER_LIB_DIR)/$(LD_SCRIPT).ld*)" ] && $(call canttest,LD_SCRIPT $(LD_SCRIPT).ld* not found)
endif

#=====================================================================
# User-space rules and templates to compile programs, libraries etc.

ifdef USER_RULE_TEMPLATES

USER_SOURCES2OBJS = $(OBJ_EXT)/.c $(OBJ_EXT)/.cc $(OBJ_EXT)/.cxx $(OBJ_EXT)/.S $(OBJ_EXT)/.asm $(OBJ_EXT)/.o

#%.o: %.c
#	$(CC) -o $@ $(LCFLAGS) -c $<

c_o_COMPILE = $(CC) $(DEFS) $(DEFAULT_INCLUDES) $(AM_CPPFLAGS) \
	$(CPPFLAGS) $(AM_CFLAGS) $(CFLAGS) $(INCLUDES) -DOMK_FOR_USER

cc_o_COMPILE = $(CXX) $(DEFS) $(DEFAULT_INCLUDES) $(AM_CPPFLAGS) \
	$(CPPFLAGS) $(AM_CXXFLAGS) $(CFLAGS) $(INCLUDES) -DOMK_FOR_USER

S_o_COMPILE = $$(CC) $(DEFS) $(DEFAULT_INCLUDES) $(INCLUDES) \
	$(CPPFLAGS) $(AM_CFLAGS) $$(CFLAGS) $(ASFLAGS)

# Check C compiler version for user build
ifndef CC_MAJOR_VERSION
CC_MAJOR_VERSION := sdcc
endif


# Syntax: $(call COMPILE_c_o_template,<source>,<target>,<additional c-flags>)
define COMPILE_c_o_template
$(2): $(1) $$(GEN_HEADERS)
	@$(QUIET_CMD_ECHO) "  CC      $$@"
	$(Q) if $$(c_o_COMPILE) $(3) -o "$$@" -c $$< ; \
	then $$(c_o_COMPILE) $(3) -M $$< > "$$@.d" ; \
	else exit 1; \
	fi
endef


# Syntax: $(call COMPILE_cc_o_template,<source>,<target>,<additional c-flags>)
define COMPILE_cc_o_template
$(2): $(1) $(LOCAL_CONFIG_H)
	@$(QUIET_CMD_ECHO) "  CXX     $$@"
	$(Q) echo "C++ compilation not suported for this compiler"
endef


# Syntax: $(call COMPILE_S_o_template,<source>,<target>,<additional c-flags>)
define COMPILE_S_o_template
$(2): $(1) $$(GEN_HEADERS)
	@$(QUIET_CMD_ECHO) "  CC      $$@"
	$(Q) if $$(S_o_COMPILE) $(3) -o "$$@" -c $$< ; \
	then $$(c_o_COMPILE) $(3) -M $$< > "$$@.d" ; \
	else exit 1; \
	fi
endef

# Syntax: $(call COMPILE_asm_o_template,<source>,<target>,<additional c-flags>)
define COMPILE_asm_o_template
$(2): $(1) $(LOCAL_CONFIG_H)
	@$(QUIET_CMD_ECHO) "  ASM      $$@"
	$(Q) $$(A51TOASX) $(1) $(2:%$(OBJ_EXT)=%.s)
	$(Q) $$(AS) -l -o $(2:%$(OBJ_EXT)=%.s)
endef


# Syntax: $(call PROGRAM_template,<executable-name>,<dir>,<executable-suffix>,<linker-sript>)
define PROGRAM_template

$(foreach x, $(USER_SOURCES2OBJS),
$(1)_OBJS += $$(patsubst %$(notdir $(x)),%$(dir $(x)),$$(filter %$(notdir $(x)),\
		$$($(1)_SOURCES) $$($(1)_GEN_SOURCES)))
)
$(1)_OBJS := $$(sort $$($(1)_OBJS:%/=%))

USER_OBJS  += $$($(1)_OBJS)
USER_SOURCES += $$($(1)_SOURCES)

-include $(USER_LIB_DIR)/$(LD_SCRIPT).ld$$(addprefix -,$(3))

$(2)/$(1)$(addprefix -,$(3)): $(USER_LIB_DIR)/$(LD_SCRIPT).ld$$(addprefix -,$(3))

$(2)/$(1)$(addprefix -,$(3)): $(USER_LIB_DIR)/timestamp

$(2)/$(1)$(addprefix -,$(3)): $$($(1)_OBJS)
	@$(QUIET_CMD_ECHO) "  LINK    $$@"
	$(Q) $$(shell if [ -z "$$(filter %.cc,$$($(1)_SOURCES))" ] ; \
	  then echo $$(CC)  $$(CPPFLAGS) $$(AM_CPPFLAGS) $$(AM_CFLAGS) $$(CFLAGS) ; \
	  else echo $$(CXX) $$(CPPFLAGS) $$(AM_CPPFLAGS) $$(AM_CXXFLAGS) $$(CXXFLAGS) ; fi) \
	  $$(AM_LDFLAGS) $$(LDFLAGS) $$($(1)_OBJS) $$(LOADLIBES) $$($(1)_LIBS:%=-l%) \
	  -o $(2)/$(1)$(addprefix -,$(3))
	$(HEX2BIN) $(2)/$(1)$(addprefix -,$(3)).hex
endef

# Rules for other output formats (can be specified by OUTPUT_FORMATS)
%.bin: %.hex
	@$(QUIET_CMD_ECHO) "  OBJCOPY $@"
	$(Q) $(OBJCOPY) --input-target=ihex --output-target=binary $< $@

%.hex: %
	@$(QUIET_CMD_ECHO) "  GENIHEX $@"
	$(Q) cd $(dirname $<) && $(HC) $< >$@

# Syntax: $(call LIBRARY_template,<library-name>)
define LIBRARY_template
$(foreach x, $(USER_SOURCES2OBJS),
$(1)_OBJS += $$(patsubst %$(notdir $(x)),%$(dir $(x)),$$(filter %$(notdir $(x)),\
		$$($(1)_SOURCES) $$($(1)_GEN_SOURCES)))
)
$(1)_OBJS := $$(sort $$($(1)_OBJS:%/=%))

USER_OBJS  += $$($(1)_OBJS)
USER_SOURCES += $$($(1)_SOURCES)

$(USER_LIB_DIR)/$(LIB_PREF)$(1)$(LIB_EXT): $$($(1)_OBJS)
	@$(QUIET_CMD_ECHO) "  AR      $$@"
	$(Q) for i in $$^ ; do $(AR) $(ARFLAGS) $$@ $$$$i ; done
	@touch $(USER_LIB_DIR)/timestamp
endef

# -------------------------------------
# Rules for compilation for target

# Generate rules for compilation of programs and libraries
ifneq ($(link_VARIANTS),)
$(foreach prog,$(bin_PROGRAMS),$(foreach link,$(link_VARIANTS),$(eval $(call PROGRAM_template,$(prog),$(USER_BIN_DIR),$(link)))))
$(foreach prog,$(utils_PROGRAMS),$(foreach link,$(link_VARIANTS),$(eval $(call PROGRAM_template,$(prog),$(USER_UTILS_DIR),$(link)))))
$(foreach prog,$(test_PROGRAMS),$(foreach link,$(link_VARIANTS),$(eval $(call PROGRAM_template,$(prog),$(USER_TESTS_DIR),$(link)))))
else
$(foreach prog,$(bin_PROGRAMS),$(eval $(call PROGRAM_template,$(prog),$(USER_BIN_DIR))))
$(foreach prog,$(utils_PROGRAMS),$(eval $(call PROGRAM_template,$(prog),$(USER_UTILS_DIR))))
$(foreach prog,$(test_PROGRAMS),$(eval $(call PROGRAM_template,$(prog),$(USER_TESTS_DIR))))
endif

$(foreach lib,$(lib_LIBRARIES),$(eval $(call LIBRARY_template,$(lib))))
$(foreach src,$(lib_obj_SOURCES),$(eval $(call LIBOBJ_template,$(addsuffix $(OBJ_EXT),$(basename $(src))))))

# lib_obj_SOURCES handling
lib_OBJS = $(addsuffix $(OBJ_EXT),$(basename $(lib_obj_SOURCES)))
#$(warning lib_OBJS = $(lib_OBJS))
SOURCES += $(filter-out %$(OBJ_EXT),$(lib_obj_SOURCES))

$(LIB_DIR)/%$(OBJ_EXT): %$(OBJ_EXT)
	@echo "  CP      $(^:$(MAKERULES_DIR)/%=%) -> $(@:$(MAKERULES_DIR)/%=%)"
	$(Q)cp $(CP_FLAGS) $< $@


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


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


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

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


library-pass-local: $(lib_LIBRARIES:%=$(USER_LIB_DIR)/$(LIB_PREF)%$(LIB_EXT)) $(shared_LIBRARIES:%=$(USER_LIB_DIR)/$(LIB_PREF)%.so)

utils-pass-local: $(foreach link,$(link_VARIANTS),$(utils_PROGRAMS:%=$(USER_UTILS_DIR)/%-$(link)) $(foreach of,$(OUTPUT_FORMATS),$(utils_PROGRAMS:%=$(USER_UTILS_DIR)/%-$(link).$(of))))

-include $(USER_OBJS_DIR)/*.d

endif

#=====================================================================
# 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)$(addprefix -,$(3))
-include $(USER_LIB_DIR)/$(LD_SCRIPT).ld$$(addprefix -,$(3))
load-$(1)$(addprefix -,$(3)): $(2)/$(1)$(addprefix -,$(3))$(LOAD_EXTENSION)
	@$(QUIET_CMD_ECHO) "  LOAD    $$<"
	@if [ -z "$$(LOAD_CMD$(addprefix -,$(3)))" ]; then echo "No command for loading applications to '$(3)' is specified."; exit 1; fi
	$(Q) $$(LOAD_CMD$(addprefix -,$(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)
-include $(USER_LIB_DIR)/$(LD_SCRIPT).ld$$(addprefix -,$(3))
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) $(test_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) $(test_PROGRAMS))-$(firstword $(link_VARIANTS)))

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

#=====================================================================
# Generate pass rules from generic templates

$(eval $(call omk_pass_template, include-pass, $(LOCAL_BUILD_DIR),,$(include_HEADERS)$(nobase_include_HEADERS)$(renamed_include_HEADERS)$(lib_LDSCRIPTS)$(config_include_HEADERS)$(LOCAL_CONFIG_H)))
$(eval $(call omk_pass_template, library-pass, $(LOCAL_BUILD_DIR),USER_RULE_TEMPLATES=y,$(lib_LIBRARIES)$(shared_LIBRARIES)$(lib_obj_SOURCES)))
$(eval $(call omk_pass_template, binary-pass,  $(LOCAL_BUILD_DIR),USER_RULE_TEMPLATES=y,$(bin_PROGRAMS)$(test_PROGRAMS)))
$(eval $(call omk_pass_template, utils-pass,   $(LOCAL_BUILD_DIR),USER_RULE_TEMPLATES=y,$(utils_PROGRAMS)))
$(eval $(call omk_pass_template, dep,    $(LOCAL_BUILD_DIR),,always))
$(eval $(call omk_pass_template, clean,  $(LOCAL_BUILD_DIR),,always))
$(eval $(call omk_pass_template, install,$(LOCAL_BUILD_DIR),,always))


dep-local:

install-local:

$(eval $(call include-pass-template,$(USER_INCLUDE_DIR),include))

include-pass-local:
	@$(foreach f, $(lib_LDSCRIPTS), cmp --quiet $(SOURCES_DIR)/$(f) $(USER_LIB_DIR)/$(notdir $(f)) \
	   || $(call cp_cmd,$(SOURCES_DIR)/$(f),$(USER_LIB_DIR)/$(notdir $(f))) || exit 1 ; )
	@$(foreach f, $(asm_build_HEADERS), \
	   srcfname=`echo '$(f)' | sed -e 's/^\(.*\)->.*$$/\1/'` ; destfname=`echo '$(f)' | sed -e 's/^.*->\(.*\)$$/\1/'` ; \
	   cmp --quiet $(SOURCES_DIR)/$${srcfname} $(USER_OBJS_DIR)/$${destfname} \
	   || ( mkdir -p `dirname $(USER_OBJS_DIR)/$${destfname}` && \
	   $(A51TOASX) $(SOURCES_DIR)/$${srcfname} $(USER_OBJS_DIR)/$${destfname} ) || exit 1 ; )


.PHONY: clean-custom
clean-local: clean-custom
	@echo Cleaning in $(USER_OBJS_DIR)
	$(Q)rm -f $(USER_OBJS_DIR)/*$(OBJ_EXT) $(USER_OBJS_DIR)/*.lo \
	       $(USER_OBJS_DIR)/*.d \
	       $(USER_OBJS_DIR)/*.map \
	       $(LOCAL_CONFIG_H:%=$(USER_OBJS_DIR)/%) \
	       $(tar_EMBEDFILES:%=$(USER_OBJS_DIR)/%_tarfile)
	$(Q)$(foreach confh,$(addprefix $(USER_INCLUDE_DIR)/,$(config_include_HEADERS)),\
	    if [ -e $(confh) ] ; then touch -t 200001010101 $(confh) ; fi ; \
	)

check-dir::
	@$(call mkdir_def,$(USER_OBJS_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))
	@$(call mkdir_def,$(USER_TESTS_DIR))

include-pass-submakes: extra-rules-subdirs
# Which passes to pass
default: include-pass library-pass binary-pass utils-pass