LUFA/StudioIntegration/makefile

   1 #
   2 #             LUFA Library
   3 #     Copyright (C) Dean Camera, 2019.
   4 #
   5 #  dean [at] fourwalledcubicle [dot] com
   6 #           www.lufa-lib.org
   7 #
   8 # ---------------------------------------
   9 #  Makefile for the LUFA Atmel Studio Integration.
  10 # ---------------------------------------
  11
  12 LUFA_ROOT            := ..
  13 LUFA_VERSION_NUM     := $(shell grep -e "\#define *LUFA_VERSION_STRING " $(LUFA_ROOT)/Version.h | cut -d'"' -f2)
  14 LUFA_VERSION_TYPE    := $(shell grep -e "\#define *LUFA_VERSION_RELEASE_TYPE " $(LUFA_ROOT)/Version.h)
  15
  16 ifneq ($(findstring LUFA_VERSION_RELEASE_TYPE_DEVELOPMENT, $(LUFA_VERSION_TYPE)),LUFA_VERSION_RELEASE_TYPE_DEVELOPMENT)
  17   EXT_VERSION_NUM    := $(shell date +"%y.%m.%d").$(LUFA_VERSION_NUM)
  18   EXT_VSIX_NAME      := LUFA-RELEASE-$(LUFA_VERSION_NUM).vsix
  19 else
  20   EXT_VERSION_NUM    := 0.$(shell date +"%y%m%d.%H%M%S")
  21   EXT_VSIX_NAME      := LUFA-TESTING-$(shell date +"%y.%m.%d-%H.%M.%S").vsix
  22
  23   $(warning Development mode set - assuming a test version should be created.)
  24 endif
  25
  26 DOXYGEN_TAG_FILE_XML := $(LUFA_ROOT)/Documentation/lufa_doc_tags.xml
  27 DOXYGEN_COMBINED_XML := $(LUFA_ROOT)/Documentation/xml/lufa_doc.xml
  28 TEMP_MANIFEST_XML    := manifest.xml
  29 EXTENSION_OUTPUT_XML := $(LUFA_ROOT)/../extension.xml
  30 MODULE_OUTPUT_XML    := $(LUFA_ROOT)/asf.xml
  31 MSHELP_OUTPUT_XML    := $(LUFA_ROOT)/../lufa_help_$(subst .,_,$(EXT_VERSION_NUM)).mshc
  32 XML_FILES            := $(filter-out $(TEMP_MANIFEST_FILE), $(shell ls *.xml))
  33 VSIX_ASSETS          := $(LUFA_ROOT)/DoxygenPages/Images/LUFA_thumb.png     \
  34                         $(LUFA_ROOT)/DoxygenPages/Images/LUFA.png           \
  35                         $(LUFA_ROOT)/License.txt                            \
  36                         VSIX/"[Content_Types].xml"                          \
  37                         VSIX/LUFA.dll                                       \
  38                         VSIX/LUFA.pkgdef
  39 VSIX_GEN_PARAMS     := --stringparam extension-version "$(EXT_VERSION_NUM)" \
  40                        --stringparam lufa-version "$(LUFA_VERSION_NUM)"     \
  41                        --stringparam help-package-filename "$(notdir $(MSHELP_OUTPUT_XML))"
  42 MSHELP_GEN_PARAMS   := --stringparam generate.toc "book toc"                \
  43                        --stringparam chunk.quietly "1"                      \
  44                        --stringparam chunk.section.depth "3"                \
  45                        --stringparam chunk.first.sections "1"               \
  46                        --stringparam chapter.autolabel "0"                  \
  47                        --stringparam root.filename "LUFA"                   \
  48                        --stringparam html.stylesheet "lufa_studio_help_styling.css"
  49
  50 all: clear_project_dirs generate_xml check_filenames generate_vsix
  51
  52 clear_project_dirs:
  53         @make -s -C $(LUFA_ROOT)/.. clean
  54
  55 clean:
  56         @rm -f $(TEMP_MANIFEST_XML) $(MODULE_OUTPUT_XML) $(EXTENSION_OUTPUT_XML) $(DOXYGEN_TAG_FILE_XML) $(DOXYGEN_COMBINED_XML) $(MSHELP_OUTPUT_XML)
  57         @rm -rf mshelp
  58         @cd $(LUFA_ROOT)/.. && rm -f contents.zip exampleProjects.xml content.xml.cache extension.vsixmanifest asf-manifest.xml extension.xml helpcontentsetup.msha $(notdir $(VSIX_ASSETS)) *.vsix *.mshc
  59
  60 $(DOXYGEN_TAG_FILE_XML):
  61         @make -C ../ doxygen DOXYGEN_OVERRIDE_PARAMS="GENERATE_TAGFILE=Documentation/lufa_doc_tags.xml GENERATE_HTML=no GENERATE_XML=yes"
  62
  63 $(DOXYGEN_COMBINED_XML): $(DOXYGEN_TAG_FILE_XML)
  64         @xsltproc $(dir $@)/combine.xslt $(dir $@)/index.xml > $(DOXYGEN_COMBINED_XML)
  65
  66 $(TEMP_MANIFEST_XML): $(DOXYGEN_TAG_FILE_XML) $(DOXYGEN_COMBINED_XML)
  67         @echo Generating temporary module manifest XML...
  68
  69         @printf "<lufa-manifest version=\"%s\" tagfile=\"%s\" docfile=\"%s\">\n" $(LUFA_VERSION_NUM) $(DOXYGEN_TAG_FILE_XML) $(DOXYGEN_COMBINED_XML) > $@
  70         @for i in $(XML_FILES); do \
  71                 printf "\t<xml-source filename=\"%s\"/>\n" $$i >> $@; \
  72         done;
  73         @echo '</lufa-manifest>' >> $@
  74
  75 $(MODULE_OUTPUT_XML): $(TEMP_MANIFEST_XML)
  76         @echo Generating library core XDK module manifest file...
  77         @xsltproc XDK/lufa_module_transform.xslt $< | xsltproc XDK/lufa_indent_transform.xslt - > $(MODULE_OUTPUT_XML)
  78
  79 $(EXTENSION_OUTPUT_XML): $(TEMP_MANIFEST_XML)
  80         @echo Generating library XDK extension manifest file...
  81         @xsltproc XDK/lufa_extension_transform.xslt $< | xsltproc XDK/lufa_indent_transform.xslt - > $(EXTENSION_OUTPUT_XML)
  82
  83 $(MSHELP_OUTPUT_XML): $(DOXYGEN_COMBINED_XML)
  84         @echo Converting Doxygen XML to DocBook...
  85         @-mkdir mshelp 2> /dev/null
  86         @xsltproc HV1/lufa_docbook_transform.xslt $(DOXYGEN_COMBINED_XML) > mshelp/lufa_docbook.xml
  87
  88         @echo Converting DocBook XML to Microsoft Help 1.0...
  89         @cd mshelp && xsltproc $(MSHELP_GEN_PARAMS) ../HV1/lufa_hv1_transform.xslt lufa_docbook.xml
  90
  91         @echo Copying help assets...
  92         @cp HV1/lufa_studio_help_styling.css mshelp
  93         @-mkdir mshelp/images 2> /dev/null
  94         @cp `find $(LUFA_ROOT)/DoxygenPages/Images -type f` mshelp/images
  95
  96         @echo Archiving help content...
  97         @cd mshelp && zip ../$(MSHELP_OUTPUT_XML) -q -0  -r *.html *.css images
  98
  99         @echo Generating HV1 manifest...
 100         @xsltproc $(VSIX_GEN_PARAMS) HV1/lufa_helpcontentsetup_transform.xslt HV1/helpcontentsetup.msha > $(LUFA_ROOT)/../helpcontentsetup.msha
 101
 102 generate_help: $(MSHELP_OUTPUT_XML)
 103
 104 generate_xml: $(EXTENSION_OUTPUT_XML) $(MODULE_OUTPUT_XML)
 105
 106 generate_vsix: $(EXTENSION_OUTPUT_XML) $(MODULE_OUTPUT_XML) $(MSHELP_OUTPUT_XML)
 107         @echo Generating XDK cache files...
 108         @rm -f $(LUFA_ROOT)/../content.xml.cache
 109         @rm -f $(LUFA_ROOT)/../ExampleProjects.xml
 110         @python VSIX/generate_caches.py $(LUFA_ROOT)/../
 111
 112         @echo Archiving XDK content...
 113         @rm -f contents.zip
 114         @cd $(LUFA_ROOT)/../ && zip contents.zip -q -0 -r --exclude=*Documentation* --exclude=*StudioIntegration* LUFA Bootloaders Demos Projects README.txt
 115
 116         @echo Creating VSIX dependencies...
 117         @cp $(VSIX_ASSETS) $(LUFA_ROOT)/..
 118         @xsltproc $(VSIX_GEN_PARAMS) VSIX/lufa_vsmanifest_transform.xslt VSIX/extension.vsixmanifest > $(LUFA_ROOT)/../extension.vsixmanifest
 119         @xsltproc $(VSIX_GEN_PARAMS) VSIX/lufa_asfmanifest_transform.xslt VSIX/asf-manifest.xml > $(LUFA_ROOT)/../asf-manifest.xml
 120
 121         @echo Generating Atmel Studio VSIX file...
 122         cd $(LUFA_ROOT)/../ && zip $(EXT_VSIX_NAME) -q -9 contents.zip exampleProjects.xml content.xml.cache extension.vsixmanifest asf-manifest.xml extension.xml helpcontentsetup.msha $(notdir $(MSHELP_OUTPUT_XML)) $(notdir $(VSIX_ASSETS))
 123
 124         @echo "Atmel Studio VSIX extension file generated."
 125
 126 check_filenames: $(MODULE_OUTPUT_XML)
 127         @echo Verifying referenced filenames of XDK modules...
 128         @for f in `find $(LUFA_ROOT)/../ -name "asf.xml"`; do \
 129                 echo "Checking $$f..."; \
 130                 asf_file_dir=`dirname $$f`; \
 131                 xsltproc XDK/lufa_filelist_transform.xslt $$f | sed -e "/^$$/d" | while read -r i; do \
 132                         if ( ( ! test -f "$$asf_file_dir/$$i" ) && ( ! test -d "$$asf_file_dir/$$i" ) ); then \
 133                                 echo "Source file \"$$i\" referenced in $$f does not exist!"; \
 134                                 exit 1; \
 135                         fi; \
 136                 done || exit 1; \
 137         done;
 138
 139 check_database:
 140         python ProjectGenerator/project_generator.py -b $(LUFA_ROOT)/../ --main-ext-uuid=0e160d5c-e331-48d9-850b-e0387912171b CHECK
 141
 142 .PHONY: all clean generate_help generate_xml generate_vsix check_filenames check_database