# To build dictionary you need to install:

#

#    $ sudo apt-get install dictfmt

#

# Available target:

#

#   all         build dictionaries

#   install     install dictionaries, so they been available in stardict, may require root permission

#   uninstall   remove dictionaries, they been unavailable in stardict, may require root permission

#

# You can override such variables in Makefile.config:

#

#   SF_USER     SourceForge user name.

#   prefix      Prefix to install path.

################################################################

# Standard GNU Makefile settings.

SHELL = /bin/bash

export PATH := /bin:/usr/bin:${PATH}

# Disable built in pattern rules.

MAKEFLAGS += -r

# Disable built in variables.

MAKEFLAGS += -R

# Disable built in suffix rules.

.SUFFIXES:

# Delete target file if command fails.

.DELETE_ON_ERROR:

# Default target.

.DEFAULT_GOAL = help

################################################################

# Build script definitions.

BUILD_SCRIPTS := $(firstword $(MAKEFILE_LIST))

ifneq '' '$(wildcard Makefile.config)'

  include Makefile.config

  BUILD_SCRIPTS += Makefile.config

endif

################################################################

# Version extracting/generation.

VER_FILE := VERSION

# Prevent making distribution with wrong version.

ifneq '' '$(filter deploy% release% dist%,$(MAKECMDGOALS))'

  ifeq '' '$(MAKE_RESTARTS)'

    $(shell rm -f $(VER_FILE))

  endif

endif

# Here are vmajor and vminor. Look README section "Versioning rules."

-include $(VER_FILE)

$(VER_FILE): | $(dir $(VER_FILE))

	\

[ -d .hg/ ] || { echo We miss VERSION file!!; exit 0; }; \

vtagdist=$$(hg log -r . --template '{latesttagdistance}'); \

vatrelease=$$([ $$vtagdist -le 1 ] && echo yes || echo no); \

vtag=$$(hg log -r . --template '{latesttag}'); \

vmajor=$${vtag#v}; \

vmajor=$${vmajor%%.*}; \

vminor=$${vtag#*.}; \

vrev=$$(hg id -i); \

visclean=$$(case $$vrev in *+) echo no;; *) echo yes;; esac); \

vrev=$${vrev%+}; \

{ \

echo "vrev=$$vrev"; \

echo "vtag=$$vtag"; \

echo "vtagdist=$$vtagdist"; \

echo "visclean=$$visclean"; \

echo "vatrelease=$$vatrelease"; \

echo "vmajor=$$vmajor"; \

echo "vminor=$$vminor"; \

} >$@

################################################################

# Determine platform/environment.

host_os = unix

ifneq '' '$(COMSPEC)'

  ifneq '' '$(WINDIR)'

    # Probably under Windows.

    host_os = windows

    ifneq '' '$(wildcard /etc/setup/*cygwin*)'

      # Probably under Cygwin.

      host_os = cygwin

    endif

  endif

endif

################################################################

# Build tools definition/switches.

INSTALL = install

INSTALL_PROGRAM = $(INSTALL)

INSTALL_DATA = $(INSTALL) -m 644

RST_WARNING_FLAGS := --halt warning

RST_FLAGS := --strip-comments

RST_FLAGS += $(RST_WARNING_FLAGS)

RST2HTML := rst2html

ifeq '$(host_os)' 'cygwin'

  RST2HTML := rst2html.py

endif

RST2HTML_RENDER_FLAGS := --strip-comments --embed-stylesheet --no-xml-declaration --math-output=HTML --initial-header-level=2

RST2HTML_FLAGS := $(RST_FLAGS) $(RST2HTML_RENDER_FLAGS)

LATEX2PDF := pdflatex

ifeq '$(ANKI_PY_DIR)' ''

  ANKI_PY_DIR := /usr/share/anki

endif

################################################################

# Install paths.

ifeq '$(origin prefix)' 'undefined'

  ifeq '$(shell id -u)' '0'

    prefix = /usr/local

  else

    prefix = $(HOME)/usr

  endif

endif

datarootdir := $(prefix)/share

datadir := $(datarootdir)/dictd

elispdir := $(datarootdir)/emacs/site-lisp

################################################################

# Project dirs/files.

pkgname = gadict

fullpkgname = $(pkgname)-$(vmajor).$(vminor)

PY_FILES := $(wildcard py/gadict*.py)

GADICT_FILES := $(sort $(wildcard *.gadict))

C5_FILES := $(patsubst %.gadict,dist/dictd/%.c5,$(GADICT_FILES))

ALL_C5_FILES := $(C5_FILES) dist/dictd/gadict_en-ru.c5 dist/dictd/gadict_en-uk.c5

PNG_FILES := $(patsubst %.gadict,dist/dictd/%.png,$(GADICT_FILES))

DICT_FILES := $(C5_FILES:.c5=.dict)

DICTDZ_FILES := $(C5_FILES:.c5=.dict.dz)

INDEX_FILES := $(C5_FILES:.c5=.index)

GAPHRASE_FILES := $(wildcard *.gaphrase)

GADIALOG_FILES := $(wildcard *.gadialog)

SRS_TAB_FILES := $(patsubst %.gadict,dist/srs/%.tab.txt,$(GADICT_FILES))

SRS_ANKI_FILES := \

  $(patsubst %.gadict,dist/anki/%.apkg,$(GADICT_FILES)) \

  $(patsubst %.gaphrase,dist/anki/%.apkg,$(GAPHRASE_FILES)) \

  $(patsubst %.gadialog,dist/anki/%.apkg,$(GADIALOG_FILES))

RST_TMPL_FILE = dist/misc/rst.tmpl

RST_CSS_FILE = www/tmpl/rst.css

RST_FILES := $(wildcard www/*.rst)

RST_HTML_FILES := $(patsubst www/%.rst,dist/www/%.html,$(RST_FILES))

INDEX_HTML_FILE := dist/www/index.html

STAT_MISSING_FILE := dist/misc/MISSING.rst

STAT_RST_FILE := dist/misc/STAT.rst

STAT_HTML_FILE := dist/www/STAT.html

WWW_HTML_FILES := $(RST_HTML_FILES) $(INDEX_HTML_FILE) $(STAT_HTML_FILE)

LOGO_FILE := www/logo.svg

LOGO_DIM := 32x32 48x48 64x64

LOGO_PNG_FILES := $(patsubst %,dist/misc/logo-%.png,$(LOGO_DIM))

FAVICON := dist/www/favicon.png

EL_FILES := $(wildcard contrib/*.el)

DISTREL_TARBALLS = dist/$(fullpkgname).tar.gz dist/$(fullpkgname).zip

DISTSRC_TARBALLS = dist/$(fullpkgname)_src.tar.gz # dist/$(fullpkgname)_src.zip

################################################################

# Install/uninstall targets.

.PHONY: install

install: install-dict install-emacs

.PHONY: install-dict

install-dict: $(DICTDZ_FILES) $(INDEX_FILES) $(PNG_FILES)

	mkdir -p $(datadir)

	for f in $(DICTDZ_FILES) $(INDEX_FILES) $(PNG_FILES); do \

		$(INSTALL_DATA) $$f $(datadir); \

	done

.PHONY: install-emacs install-el

install-el: install-emacs

install-emacs:

	mkdir -p $(elispdir)

	$(INSTALL_DATA) $(EL_FILES) $(elispdir)

	emacs -batch -f batch-byte-compile $(patsubst %,$(elispdir)/%,$(notdir $(EL_FILES)))

.PHONY: uninstall

uninstall:

	for f in $(notdir $(DICTDZ_FILES) $(INDEX_FILES) $(PNG_FILES)); do \

		rm -f $(datadir)/$$f; \

	done

	rm -f $(patsubst %,$(elispdir)/%,$(notdir $(EL_FILES))) $(patsubst %.el,$(elispdir)/%.elc,$(notdir $(EL_FILES)))

################################################################

# Deploy/release targets.

SF_USER ?= gavenkoa

# Release require Anki Python modules, dictd utilities and graphicsmagick (for icon):

#   $ sudo apt install anki dictfmt dictzip graphicsmagick

#   $ apt-cyg install GraphicsMagick

# First time you deploy to SourceForge (sf) you need manually login to:

#   $ sftp $(SF_USER),$(pkgname)@web.sourceforge.net

#   $ sftp $(SF_USER),$(pkgname)@frs.sourceforge.net

#   $ hg push ssh://$(SF_USER)@hg.code.sf.net/p/gadict/code

# as it asks for accepting server public key.

.PHONY: deploy

deploy: deploy2defun deploy2sf

.PHONY: deploy-src deploy-hg

deploy-src deploy-hg: deploy2defun-hg deploy2sf-hg

.PHONY: deploy-html

deploy-html: deploy2defun-html deploy2sf-html

.PHONY: release

release: release2defun release2sf

.PHONY: release2defun

release2defun: validate-release deploy2defun

.PHONY: release2sf

release2sf: validate-release deploy2sf

DEFUN_USER ?= user

DEFUN_HG_SRV ?= hg.defun.work

DEFUN_HG_DIR ?= /srv/hg/gadict

DEFUN_WWW_SRV ?= defun.work

DEFUN_WWW_DIR ?= /srv/www/gadict

DEFUN_REL_DIR ?= /srv/www/gadict/download

.PHONY: deploy2defun-full

deploy2defun-full: deploy2defun deploy2defun-voa

.PHONY: deploy2defun

deploy2defun: deploy2defun-www deploy2defun-dist deploy2defun-hg deploy2defun-html

.PHONY: deploy2defun-hg

deploy2defun-hg:

	hg push ssh://$(DEFUN_USER)@$(DEFUN_HG_SRV)/$(DEFUN_HG_DIR) || [ $$? = 1 ]

.PHONY: deploy2defun-www

deploy2defun-www: $(WWW_HTML_FILES) $(FAVICON)

	( \

echo 'cd $(DEFUN_WWW_DIR)'; \

for f in $(WWW_HTML_FILES) $(FAVICON); do \

  n=$${f##*/}; \

  echo "put $$f $$n"; \

  echo "chmod 644 $$n"; \

done; \

echo 'quit'; \

) | sftp -b - $(DEFUN_USER)@$(DEFUN_WWW_SRV)

.PHONY: deploy2defun-dist

deploy2defun-dist: $(DISTREL_TARBALLS) $(DISTSRC_TARBALLS)

	( \

echo "-mkdir $(DEFUN_REL_DIR)"; \

echo "-mkdir $(DEFUN_REL_DIR)/v$(vmajor).$(vminor)"; \

echo "cd $(DEFUN_REL_DIR)/v$(vmajor).$(vminor)"; \

for f in $(DISTREL_TARBALLS) $(DISTSRC_TARBALLS); do \

  n=$${f##*/}; \

  echo "put $$f $$n"; \

  echo "chmod 644 $$n"; \

done; \

) | sftp -b - $(DEFUN_USER)@$(DEFUN_WWW_SRV)

.PHONY: deploy2defun-html

deploy2defun-html: $(DICT_HTML_FILES)

	( \

echo 'cd $(DEFUN_WWW_DIR)'; \

for f in $(DICT_HTML_FILES); do \

  n=$${f##*/}; \

  echo "put $$f $$n"; \

  echo "chmod 644 $$n"; \

done; \

echo 'quit'; \

) | sftp -b - $(DEFUN_USER)@$(DEFUN_WWW_SRV)

.PHONY: deploy2sf-full

deploy2sf-full: deploy2sf deploy2sf-voa

.PHONY: deploy2sf

deploy2sf: deploy2sf-www deploy2sf-dist deploy2sf-hg deploy2sf-html

.PHONY: deploy2sf-hg

deploy2sf-hg:

	hg push ssh://$(SF_USER)@hg.code.sf.net/p/$(pkgname)/code || [ $$? = 1 ]

# Will be accessed via http://$(pkgname).sourceforge.net

.PHONY: deploy2sf-www

deploy2sf-www: $(WWW_HTML_FILES) $(FAVICON)

	( echo 'cd htdocs'; \

for f in $(WWW_HTML_FILES) $(FAVICON); do \

  n=$${f##*/}; \

  echo "put $$f $$n"; \

  echo "chmod 644 $$n"; \

done; \

echo 'quit'; \

) | sftp -b - $(SF_USER),$(pkgname)@web.sourceforge.net

.PHONY: deploy2sf-dist

deploy2sf-dist: $(DISTREL_TARBALLS) $(DISTSRC_TARBALLS)

	( echo 'cd /home/frs/project/$(shell v=$(pkgname); echo $${v:0:1}/$${v:0:2})/$(pkgname)'; \

echo "put  www/README.rst"; \

echo "chmod 644 README.rst"; \

echo "-mkdir v$(vmajor).$(vminor)"; \

echo "cd v$(vmajor).$(vminor)"; \

for f in $(DISTREL_TARBALLS) $(DISTSRC_TARBALLS); do \

  n=$${f##*/}; \

  echo "put $$f $$n"; \

  echo "chmod 644 $$n"; \

done; \

echo 'quit'; \

) | sftp -b - $(SF_USER),$(pkgname)@frs.sourceforge.net

.PHONY: deploy2sf-html

deploy2sf-html: $(DICT_HTML_FILES)

	( echo 'cd htdocs'; \

for f in $(DICT_HTML_FILES); do \

  n=$${f##*/}; \

  echo "put $$f $$n"; \

  echo "chmod 644 $$n"; \

done; \

echo 'quit'; \

) | sftp -b - $(SF_USER),$(pkgname)@web.sourceforge.net

.PHONY: validate-release

validate-release:

	\

case ${visclean} in \

  no) echo "Local changes found. Build stop."; \

    exit 1;; \

esac

	\

case $(vatrelease) in \

  no) echo "We are not at release. Build stop."; \

    exit 1;; \

esac

################################################################

# Printed VOA dictionary isn't going to change so there is no need to require

# LaTeX in built environment to make releases.

.PHONY: deploy-voa

deploy-voa: deploy2defun-voa deploy2sf-voa

.PHONY: deploy2defun-voa

deploy2defun-voa: voa

	( \

echo 'cd $(DEFUN_WWW_DIR)'; \

echo "put dist/pdf/voa-special.pdf"; \

echo "chmod 644 voa-special.pdf"; \

echo 'quit'; \

) | sftp -b - $(DEFUN_USER)@$(DEFUN_WWW_SRV)

.PHONY: deploy2sf-voa

deploy2sf-voa: voa

	( \

echo 'cd htdocs'; \

echo "put dist/pdf/voa-special.pdf"; \

echo "chmod 644 voa-special.pdf"; \

echo 'quit'; \

) | sftp -b - $(SF_USER),$(pkgname)@web.sourceforge.net

################################################################

# Dist targets.

.PHONY: dist

dist: dist-rel dist-src

.PHONY: dist-rel

dist-rel: $(DISTREL_TARBALLS)

DISTREL_DICTDZ_FILES := $(patsubst %,dist/$(fullpkgname)/dictd/%,$(notdir $(DICTDZ_FILES)))

DISTREL_INDEX_FILES := $(patsubst %,dist/$(fullpkgname)/dictd/%,$(notdir $(INDEX_FILES)))

DISTREL_RST_FILES := $(patsubst %,dist/$(fullpkgname)/doc/txt/%,$(notdir $(RST_FILES)))

DISTREL_WWW_HTML_FILES := $(patsubst %,dist/$(fullpkgname)/doc/html/%,$(notdir $(RST_HTML_FILES)))

DISTREL_SRS_TAB_FILES := $(patsubst %,dist/$(fullpkgname)/srs/%,$(notdir $(SRS_TAB_FILES)))

DISTREL_SRS_ANKI_FILES := $(patsubst %,dist/$(fullpkgname)/anki/%,$(notdir $(SRS_ANKI_FILES)))

dist/$(fullpkgname).tar.gz: $(DISTREL_DICTDZ_FILES) $(DISTREL_INDEX_FILES) $(DISTREL_SRS_ANKI_FILES) $(DISTREL_RST_FILES) $(DISTREL_WWW_HTML_FILES) $(BUILD_SCRIPTS)

	rm -rf $@

	tar zcf $@ -C dist/ $(fullpkgname)

dist/$(fullpkgname).zip: $(DISTREL_DICTDZ_FILES) $(DISTREL_INDEX_FILES) $(DISTREL_RST_FILES) $(DISTREL_WWW_HTML_FILES) $(BUILD_SCRIPTS)

	rm -rf $@

	cd $(dir $@) && zip -r $(notdir $@) $(fullpkgname)

$(DISTREL_DICTDZ_FILES) $(DISTREL_INDEX_FILES): dist/$(fullpkgname)/dictd/%: dist/dictd/% | dist/$(fullpkgname)/dictd/

	cp $< $@

$(DISTREL_SRS_TAB_FILES): dist/$(fullpkgname)/srs/%: dist/srs/% | dist/$(fullpkgname)/srs/

	cp $< $@

$(DISTREL_SRS_ANKI_FILES): dist/$(fullpkgname)/anki/%: dist/anki/% | dist/$(fullpkgname)/anki/

	cp $< $@

$(DISTREL_RST_FILES): dist/$(fullpkgname)/doc/txt/%: www/% | dist/$(fullpkgname)/doc/txt/

	cp $< $@

$(DISTREL_WWW_HTML_FILES): dist/$(fullpkgname)/doc/html/%: dist/www/% | dist/$(fullpkgname)/doc/html/

	cp $< $@

$(patsubst %,dist/$(fullpkgname)/%, dictd/ srs/ anki/ doc/txt/ doc/html/):

	mkdir -p $@

.PHONY: dist-src

dist-src: $(DISTSRC_TARBALLS)

DISTSRC_GADICT_FILES := $(patsubst %,dist/$(fullpkgname)_src/%,$(GADICT_FILES))

DISTSRC_GAPHRASE_FILES := $(patsubst %,dist/$(fullpkgname)_src/%,$(GAPHRASE_FILES))

DISTSRC_GADIALOG_FILES := $(patsubst %,dist/$(fullpkgname)_src/%,$(GADIALOG_FILES))

DISTSRC_PY_FILES := $(patsubst %,dist/$(fullpkgname)_src/py/%,$(notdir $(PY_FILES)))

DISTSRC_RST_FILES := $(patsubst %,dist/$(fullpkgname)_src/www/%,$(notdir $(RST_FILES)))

DISTSRC_TMPL_FILES := $(patsubst %,dist/$(fullpkgname)_src/www/tmpl/%, rst.css rst.tmpl.in)

DISTSRC_BUILD_SCRIPTS := $(patsubst %,dist/$(fullpkgname)_src/%, Makefile VERSION)

dist/$(fullpkgname)_src.tar.gz: $(DISTSRC_GADICT_FILES) $(DISTSRC_GAPHRASE_FILES) $(DISTSRC_GADIALOG_FILES) \

  $(DISTSRC_PY_FILES) $(DISTSRC_RST_FILES) $(DISTSRC_TMPL_FILES) $(DISTSRC_BUILD_SCRIPTS) $(BUILD_SCRIPTS)

	rm -rf $@

	tar zcf $@ -C dist/ $(fullpkgname)_src

$(DISTSRC_GADICT_FILES) $(DISTSRC_GAPHRASE_FILES) $(DISTSRC_GADIALOG_FILES): dist/$(fullpkgname)_src/%: % | dist/$(fullpkgname)_src/

	cp $< $@

$(DISTSRC_PY_FILES): dist/$(fullpkgname)_src/py/%: py/% | dist/$(fullpkgname)_src/py/

	cp $< $@

$(DISTSRC_RST_FILES): dist/$(fullpkgname)_src/www/%: www/% | dist/$(fullpkgname)_src/www/

	cp $< $@

$(DISTSRC_TMPL_FILES): dist/$(fullpkgname)_src/www/tmpl/%: www/tmpl/% | dist/$(fullpkgname)_src/www/tmpl/

	cp $< $@

$(DISTSRC_BUILD_SCRIPTS): dist/$(fullpkgname)_src/%: % | dist/$(fullpkgname)_src/

	cp $< $@

dist/$(fullpkgname)_src/ $(patsubst %,dist/$(fullpkgname)_src/%, py/ www/ www/tmpl/):

	mkdir -p $@

################################################################

# Word frequency statistic.

define FREQ_MACRO

$(1)_OPT += -freq:$(2):$(3)=$(4)

$(1)_DEP += $(4)

endef

# For gadict_voa.

$(eval $(call FREQ_MACRO,VOA_FREQLIST,freq,GSL,wordlist/gsl.freq))

$(eval $(call FREQ_MACRO,VOA_FREQLIST,freq,AWL,wordlist/awl.freq))

$(eval $(call FREQ_MACRO,VOA_FREQLIST,freq,NGSL,wordlist/ngsl.freq))

$(eval $(call FREQ_MACRO,VOA_FREQLIST,freq,NAWL,wordlist/nawl.freq))

$(eval $(call FREQ_MACRO,VOA_FREQLIST,var,BSL,wordlist/bsl.var))

$(eval $(call FREQ_MACRO,VOA_FREQLIST,var,TSL,wordlist/tsl.var))

# For other dictionaries.

$(eval $(call FREQ_MACRO,FREQLIST,freq,GSL,wordlist/gsl.freq))