# -*-Makefile-*-

# This Makefile fragment tries to be general-purpose enough to be

# used by many projects via the gnulib maintainer-makefile module.

## Copyright (C) 2001-2020 Free Software Foundation, Inc.

##

## This program is free software: you can redistribute it and/or modify

## it under the terms of the GNU General Public License as published by

## the Free Software Foundation, either version 3 of the License, or

## (at your option) any later version.

##

## This program is distributed in the hope that it will be useful,

## but WITHOUT ANY WARRANTY; without even the implied warranty of

## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

## GNU General Public License for more details.

##

## You should have received a copy of the GNU General Public License

## along with this program.  If not, see <https://www.gnu.org/licenses/>.

# This is reported not to work with make-3.79.1

# ME := $(word $(words $(MAKEFILE_LIST)),$(MAKEFILE_LIST))

ME := maint.mk

# These variables ought to be defined through the configure.ac section

# of the module description. But some packages import this file directly,

# ignoring the module description.

AWK ?= awk

GREP ?= grep

SED ?= sed

# Helper variables.

_empty =

_sp = $(_empty) $(_empty)

# _equal,S1,S2

# ------------

# If S1 == S2, return S1, otherwise the empty string.

_equal = $(and $(findstring $(1),$(2)),$(findstring $(2),$(1)))

# member-check,VARIABLE,VALID-VALUES

# ----------------------------------

# Check that $(VARIABLE) is in the space-separated list of VALID-VALUES, and

# return it.  Die otherwise.

member-check =								\

  $(strip								\

    $(if $($(1)),							\

      $(if $(findstring $(_sp),$($(1))),				\

          $(error invalid $(1): '$($(1))', expected $(2)),		\

          $(or $(findstring $(_sp)$($(1))$(_sp),$(_sp)$(2)$(_sp)),	\

            $(error invalid $(1): '$($(1))', expected $(2)))),		\

      $(error $(1) undefined)))

# Do not save the original name or timestamp in the .tar.gz file.

# Use --rsyncable if available.

gzip_rsyncable := \

  $(shell gzip --help 2>/dev/null|$(GREP) rsyncable >/dev/null \

    && printf %s --rsyncable)

GZIP_ENV = '--no-name --best $(gzip_rsyncable)'

GIT = git

VC = $(GIT)

VC_LIST = $(srcdir)/$(_build-aux)/vc-list-files -C $(srcdir)

# You can override this variable in cfg.mk if your gnulib submodule lives

# in a different location.

gnulib_dir ?= $(srcdir)/gnulib

# You can override this variable in cfg.mk to set your own regexp

# matching files to ignore.

VC_LIST_ALWAYS_EXCLUDE_REGEX ?= ^$$

# This is to preprocess robustly the output of $(VC_LIST), so that even

# when $(srcdir) is a pathological name like "....", the leading sed command

# removes only the intended prefix.

_dot_escaped_srcdir = $(subst .,\.,$(srcdir))

# Post-process $(VC_LIST) output, prepending $(srcdir)/, but only

# when $(srcdir) is not ".".

ifeq ($(srcdir),.)

  _prepend_srcdir_prefix =

else

  _prepend_srcdir_prefix = | $(SED) 's|^|$(srcdir)/|'

endif

# In order to be able to consistently filter "."-relative names,

# (i.e., with no $(srcdir) prefix), this definition is careful to

# remove any $(srcdir) prefix, and to restore what it removes.

_sc_excl = \

  $(or $(exclude_file_name_regexp--$@),^$$)

VC_LIST_EXCEPT = \

  $(VC_LIST) | $(SED) 's|^$(_dot_escaped_srcdir)/||' \

	| if test -f $(srcdir)/.x-$@; then $(GREP) -vEf $(srcdir)/.x-$@; \

	  else $(GREP) -Ev -e "$${VC_LIST_EXCEPT_DEFAULT-ChangeLog}"; fi \

	| $(GREP) -Ev -e '($(VC_LIST_ALWAYS_EXCLUDE_REGEX)|$(_sc_excl))' \

	$(_prepend_srcdir_prefix)

ifeq ($(origin prev_version_file), undefined)

  prev_version_file = $(srcdir)/.prev-version

endif

PREV_VERSION := $(shell cat $(prev_version_file) 2>/dev/null)

VERSION_REGEXP = $(subst .,\.,$(VERSION))

PREV_VERSION_REGEXP = $(subst .,\.,$(PREV_VERSION))

ifeq ($(VC),$(GIT))

  this-vc-tag = v$(VERSION)

  this-vc-tag-regexp = v$(VERSION_REGEXP)

else

  tag-package = $(shell echo "$(PACKAGE)" | tr '[:lower:]' '[:upper:]')

  tag-this-version = $(subst .,_,$(VERSION))

  this-vc-tag = $(tag-package)-$(tag-this-version)

  this-vc-tag-regexp = $(this-vc-tag)

endif

my_distdir = $(PACKAGE)-$(VERSION)

# Old releases are stored here.

release_archive_dir ?= ../release

# If RELEASE_TYPE is undefined, but RELEASE is, use its second word.

# But overwrite VERSION.

ifdef RELEASE

  VERSION := $(word 1, $(RELEASE))

  RELEASE_TYPE ?= $(word 2, $(RELEASE))

endif

# Validate and return $(RELEASE_TYPE), or die.

RELEASE_TYPES = alpha beta stable

release-type = $(call member-check,RELEASE_TYPE,$(RELEASE_TYPES))

# Override gnu_rel_host and url_dir_list in cfg.mk if these are not right.

# Use alpha.gnu.org for alpha and beta releases.

# Use ftp.gnu.org for stable releases.

gnu_ftp_host-alpha = alpha.gnu.org

gnu_ftp_host-beta = alpha.gnu.org

gnu_ftp_host-stable = ftp.gnu.org

gnu_rel_host ?= $(gnu_ftp_host-$(release-type))

url_dir_list ?= $(if $(call _equal,$(gnu_rel_host),ftp.gnu.org),	\

                     https://ftpmirror.gnu.org/$(PACKAGE),		\

                     https://$(gnu_rel_host)/gnu/$(PACKAGE))

# Override this in cfg.mk if you are using a different format in your

# NEWS file.

today = $(shell date +%Y-%m-%d)

# Select which lines of NEWS are searched for $(news-check-regexp).

# This is a sed line number spec.  The default says that we search

# lines 1..10 of NEWS for $(news-check-regexp).

# If you want to search only line 3 or only lines 20-22, use "3" or "20,22".

news-check-lines-spec ?= 1,10

news-check-regexp ?= '^\*.* $(VERSION_REGEXP) \($(today)\)'

# Prevent programs like 'sort' from considering distinct strings to be equal.

# Doing it here saves us from having to set LC_ALL elsewhere in this file.

export LC_ALL = C

## --------------- ##

## Sanity checks.  ##

## --------------- ##

ifneq ($(_gl-Makefile),)

_cfg_mk := $(wildcard $(srcdir)/cfg.mk)

# Collect the names of rules starting with 'sc_'.

syntax-check-rules := $(sort $(shell $(SED) -n \

   's/^\(sc_[a-zA-Z0-9_-]*\):.*/\1/p' $(srcdir)/$(ME) $(_cfg_mk)))

.PHONY: $(syntax-check-rules)

ifeq ($(shell $(VC_LIST) >/dev/null 2>&1; echo $$?),0)

  local-checks-available += $(syntax-check-rules)

else

  local-checks-available += no-vc-detected

no-vc-detected:

	@echo "No version control files detected; skipping syntax check"

endif

.PHONY: $(local-checks-available)

# Arrange to print the name of each syntax-checking rule just before running it.

$(syntax-check-rules): %: %.m

sc_m_rules_ = $(patsubst %, %.m, $(syntax-check-rules))

.PHONY: $(sc_m_rules_)

$(sc_m_rules_):

	@echo $(patsubst sc_%.m, %, $@)

	@date +%s.%N > .sc-start-$(basename $@)

# Compute and print the elapsed time for each syntax-check rule.

sc_z_rules_ = $(patsubst %, %.z, $(syntax-check-rules))

.PHONY: $(sc_z_rules_)

$(sc_z_rules_): %.z: %

	@end=$$(date +%s.%N);						\

	start=$$(cat .sc-start-$*);					\

	rm -f .sc-start-$*;						\

	$(AWK) -v s=$$start -v e=$$end					\

	  'END {printf "%.2f $(patsubst sc_%,%,$*)\n", e - s}' < /dev/null

# The patsubst here is to replace each sc_% rule with its sc_%.z wrapper

# that computes and prints elapsed time.

local-check :=								\

  $(patsubst sc_%, sc_%.z,						\

    $(filter-out $(local-checks-to-skip), $(local-checks-available)))

syntax-check: $(local-check)

endif

# _sc_search_regexp

#

# This macro searches for a given construct in the selected files and

# then takes some action.

#

# Parameters (shell variables):

#

#  prohibit | require

#

#     Regular expression (ERE) denoting either a forbidden construct

#     or a required construct.  Those arguments are exclusive.

#

#  exclude

#

#     Regular expression (ERE) denoting lines to ignore that matched

#     a prohibit construct.  For example, this can be used to exclude

#     comments that mention why the nearby code uses an alternative

#     construct instead of the simpler prohibited construct.

#

#  in_vc_files | in_files

#

#     grep-E-style regexp selecting the files to check.  For in_vc_files,

#     the regexp is used to select matching files from the list of all

#     version-controlled files; for in_files, it's from the names printed

#     by "find $(srcdir)".  When neither is specified, use all files that

#     are under version control.

#

#  containing | non_containing

#

#     Select the files (non) containing strings matching this regexp.

#     If both arguments are specified then CONTAINING takes

#     precedence.

#

#  with_grep_options

#

#     Extra options for grep.

#

#  ignore_case

#

#     Ignore case.

#

#  halt

#

#     Message to display before to halting execution.

#

# Finally, you may exempt files based on an ERE matching file names.

# For example, to exempt from the sc_space_tab check all files with the

# .diff suffix, set this Make variable:

#

# exclude_file_name_regexp--sc_space_tab = \.diff$

#

# Note that while this functionality is mostly inherited via VC_LIST_EXCEPT,

# when filtering by name via in_files, we explicitly filter out matching

# names here as well.

# Initialize each, so that envvar settings cannot interfere.

export require =

export prohibit =

export exclude =

export in_vc_files =

export in_files =

export containing =

export non_containing =

export halt =

export with_grep_options =

# By default, _sc_search_regexp does not ignore case.

export ignore_case =

_ignore_case = $$(test -n "$$ignore_case" && printf %s -i || :)

define _sc_say_and_exit

   dummy=; : so we do not need a semicolon before each use;		\

   { printf '%s\n' "$(ME): $$msg" 1>&2; exit 1; };

endef

define _sc_search_regexp

   dummy=; : so we do not need a semicolon before each use;		\

									\

   : Check arguments;							\

   test -n "$$prohibit" && test -n "$$require"				\

     && { msg='Cannot specify both prohibit and require'		\

          $(_sc_say_and_exit) } || :;					\

   test -z "$$prohibit" && test -z "$$require"				\

     && { msg='Should specify either prohibit or require'		\

          $(_sc_say_and_exit) } || :;					\

   test -z "$$prohibit" && test -n "$$exclude"				\

     && { msg='Use of exclude requires a prohibit pattern'		\

          $(_sc_say_and_exit) } || :;					\

   test -n "$$in_vc_files" && test -n "$$in_files"			\

     && { msg='Cannot specify both in_vc_files and in_files'		\

          $(_sc_say_and_exit) } || :;					\

   test "x$$halt" != x							\

     || { msg='halt not defined' $(_sc_say_and_exit) };			\

									\

   : Filter by file name;						\

   if test -n "$$in_files"; then					\

     files=$$(find $(srcdir) | $(GREP) -E "$$in_files"			\

              | $(GREP) -Ev '$(_sc_excl)');				\

   else									\

     files=$$($(VC_LIST_EXCEPT));					\

     if test -n "$$in_vc_files"; then					\

       files=$$(echo "$$files" | $(GREP) -E "$$in_vc_files");		\

     fi;								\

   fi;									\

									\

   : Filter by content;							\

   test -n "$$files"							\

     && test -n "$$containing"						\

     && { files=$$(echo "$$files" | xargs $(GREP) -l "$$containing"); }	\

     || :;								\

   test -n "$$files"							\

     && test -n "$$non_containing"					\

     && { files=$$(echo "$$files" | xargs $(GREP) -vl "$$non_containing"); } \

     || :;								\

									\

   : Check for the construct;						\

   if test -n "$$files"; then						\

     if test -n "$$prohibit"; then					\

       echo "$$files"							\

         | xargs $(GREP) $$with_grep_options $(_ignore_case) -nE	\

		"$$prohibit" /dev/null					\

         | $(GREP) -vE "$${exclude:-^$$}"				\

         && { msg="$$halt" $(_sc_say_and_exit) }			\

         || :;								\

     else								\

       echo "$$files"							\

         | xargs							\

             $(GREP) $$with_grep_options $(_ignore_case) -LE "$$require" \

         | $(GREP) .							\

         && { msg="$$halt" $(_sc_say_and_exit) }			\

         || :;								\

     fi									\

   else :;								\

   fi || :;

endef

sc_avoid_if_before_free:

	@$(VC_LIST_EXCEPT)						\

	  | $(GREP) -v useless-if-before-free				\

	  | xargs							\

	      $(srcdir)/$(_build-aux)/useless-if-before-free		\

	      $(useless_free_options)					\

	  && { printf '$(ME): found useless "if"'			\

		      ' before "free" above\n' 1>&2;			\

	       exit 1; }						\

	  || :

sc_cast_of_argument_to_free:

	@prohibit='\

	  $(_sc_search_regexp)

sc_cast_of_x_alloc_return_value:

	@prohibit='\*\) *x(m|c|re)alloc\>'				\

	halt="don't cast x*alloc return value"				\

	  $(_sc_search_regexp)

sc_cast_of_alloca_return_value:

	@prohibit='\*\) *alloca\>'					\

	halt="don't cast alloca return value"				\

	  $(_sc_search_regexp)

sc_space_tab:

	@prohibit='[ ]	'						\

	halt='found SPACE-TAB sequence; remove the SPACE'		\

	  $(_sc_search_regexp)

# Don't use *scanf or the old ato* functions in "real" code.

# They provide no error checking mechanism.

# Instead, use strto* functions.

sc_prohibit_atoi_atof:

	@prohibit='\<([fs]?scanf|ato([filq]|ll)) *\('				\

	halt='do not use *scan''f, ato''f, ato''i, ato''l, ato''ll or ato''q'	\

	  $(_sc_search_regexp)

# Use STREQ rather than comparing strcmp == 0, or != 0.

sp_ = strcmp *\(.+\)

sc_prohibit_strcmp:

	@prohibit='! *strcmp *\(|\<$(sp_) *[!=]=|[!=]= *$(sp_)'		\

	exclude='# *define STRN?EQ\('					\

	halt='replace strcmp calls above with STREQ/STRNEQ'		\

	  $(_sc_search_regexp)

# Really.  You don't want to use this function.

# It may fail to NUL-terminate the destination,

# and always NUL-pads out to the specified length.

sc_prohibit_strncpy:

	@prohibit='\

	halt='do not use strncpy, period'				\

	  $(_sc_search_regexp)

# Pass EXIT_*, not number, to usage, exit, and error (when exiting)

# Convert all uses automatically, via these two commands:

# git grep -l '\

#  | grep -vEf .x-sc_prohibit_magic_number_exit \

#  | xargs --no-run-if-empty \

#      perl -pi -e 's/(^|[^.])\b(exit ?)\(1\)/$1$2(EXIT_FAILURE)/'

# git grep -l '\

#  | grep -vEf .x-sc_prohibit_magic_number_exit \

#  | xargs --no-run-if-empty \

#      perl -pi -e 's/(^|[^.])\b(exit ?)\(0\)/$1$2(EXIT_SUCCESS)/'

sc_prohibit_magic_number_exit:

	@prohibit='(^|[^.])\<(usage|exit|error) ?\(-?[0-9]+[,)]'	\

	exclude='exit \(77\)|error ?\(((0|77),|[^,]*)'			\

	halt='use EXIT_* values rather than magic number'		\

	  $(_sc_search_regexp)

# Check that we don't use $< in non-implicit Makefile rules.

#

# To find the Makefiles, trace AC_CONFIG_FILES.  Using VC_LIST would

# miss the Makefiles that are not under VC control (e.g., symlinks

# installed for gettext).  "Parsing" (recursive) uses of SUBDIRS seems

# too delicate.

#

# Use GNU Make's --print-data-base to normalize the rules into some

# easy to parse format: they are separated by two \n.  Look for the

# "section" about non-pattern rules (marked with "# Files") inside

# which there are still the POSIX Make like implicit rules (".c.o").

sc_prohibit_gnu_make_extensions_awk_ =					\

  BEGIN {								\

      RS = "\n\n";							\

      in_rules = 0;							\

  }									\

  /^\# Files/ {								\

      in_rules = 1;							\

  }									\

  /\$$</ && in_rules && $$0 !~ /^(.*\n)*\.\w+(\.\w+)?:/ {		\

      print "Error: " file ": $$< in a non implicit rule\n" $$0;	\

      status = 1;							\

  }									\

  END {									\

     exit status;							\

  }

sc_prohibit_gnu_make_extensions:

	@if $(AWK) --version | grep GNU >/dev/null 2>&1; then		\

	  (cd $(srcdir) && autoconf --trace AC_CONFIG_FILES:'$$1') |	\

	    tr ' ' '\n' |						\

	    $(SED) -ne '/Makefile/{s/\.in$$//;p;}' |			\

	    while read m; do						\

	      $(MAKE) -qp -f $$m .DUMMY-TARGET 2>/dev/null |		\

	        $(AWK) -v file=$$m -e '$($@_awk_)' || exit 1;		\

	    done;							\

	fi

# Using EXIT_SUCCESS as the first argument to error is misleading,

# since when that parameter is 0, error does not exit.  Use '0' instead.

sc_error_exit_success:

	@prohibit='error *\(EXIT_SUCCESS,'				\

	in_vc_files='\.[chly]$$'					\

	halt='found error (EXIT_SUCCESS'				\

	 $(_sc_search_regexp)

# "FATAL:" should be fully upper-cased in error messages

# "WARNING:" should be fully upper-cased, or fully lower-cased

sc_error_message_warn_fatal:

	@$(VC_LIST_EXCEPT)						\

	  | xargs $(GREP) -nEA2 '[^rp]error *\(' /dev/null		\

	  | $(GREP) -E '"Warning|"Fatal|"fatal'				\

	  && { echo '$(ME): use FATAL, WARNING or warning' 1>&2;	\

	       exit 1; }						\

	  || :

# Error messages should not start with a capital letter

sc_error_message_uppercase:

	@$(VC_LIST_EXCEPT)						\

	  | xargs $(GREP) -nEA2 '[^rp]error *\(' /dev/null		\

	  | $(GREP) -E '"[A-Z]'						\

	  | $(GREP) -vE '"FATAL|"WARNING|"Java|"C#|PRIuMAX'		\

	  && { echo '$(ME): found capitalized error message' 1>&2;	\

	       exit 1; }						\

	  || :

# Error messages should not end with a period

sc_error_message_period:

	@$(VC_LIST_EXCEPT)						\

	  | xargs $(GREP) -nEA2 '[^rp]error *\(' /dev/null		\

	  | $(GREP) -E '[^."]\."'					\

	  && { echo '$(ME): found error message ending in period' 1>&2;	\

	       exit 1; }						\

	  || :

sc_file_system:

	@prohibit=file''system						\

	exclude='/proc/filesystems'					\

	ignore_case=1							\

	halt='found use of "file''system"; spell it "file system"'	\

	  $(_sc_search_regexp)

# Don't use cpp tests of this symbol.  All code assumes config.h is included.

sc_prohibit_have_config_h:

	@prohibit='^# *if.*HAVE''_CONFIG_H'				\

	halt='found use of HAVE''_CONFIG_H; remove'			\

	  $(_sc_search_regexp)

# Nearly all .c files must include <config.h>.  However, we also permit this

# via inclusion of a package-specific header, if cfg.mk specified one.

# config_h_header must be suitable for grep -E.

config_h_header ?= <config\.h>

sc_require_config_h:

	@require='^# *include $(config_h_header)'			\

	in_vc_files='\.c$$'						\

	halt='the above files do not include <config.h>'		\

	  $(_sc_search_regexp)

# Print each file name for which the first #include does not match

# $(config_h_header).  Like grep -m 1, this only looks at the first match.

perl_config_h_first_ =							\

  -e 'BEGIN {$$ret = 0}'						\

  -e 'if (/^\# *include\b/) {'						\

  -e '  if (not m{^\# *include $(config_h_header)}) {'			\

  -e '    print "$$ARGV\n";'						\

  -e '    $$ret = 1;'							\

  -e '  }'								\

  -e '  \# Move on to next file after first include'			\

  -e '  close ARGV;'							\

  -e '}'								\

  -e 'END {exit $$ret}'

# You must include <config.h> before including any other header file.

# This can possibly be via a package-specific header, if given by cfg.mk.

sc_require_config_h_first:

	@if $(VC_LIST_EXCEPT) | $(GREP) '\.c$$' > /dev/null; then	\

	  files=$$($(VC_LIST_EXCEPT) | $(GREP) '\.c$$') &&		\

	  perl -n $(perl_config_h_first_) $$files ||			\

	    { echo '$(ME): the above files include some other header'	\

		'before <config.h>' 1>&2; exit 1; } || :;		\

	else :;								\

	fi

sc_prohibit_HAVE_MBRTOWC:

	@prohibit='\bHAVE_MBRTOWC\b'					\

	halt="do not use $$prohibit; it is always defined"		\

	  $(_sc_search_regexp)

# To use this "command" macro, you must first define two shell variables:

# h: the header name, with no enclosing <> or ""

# re: a regular expression that matches IFF something provided by $h is used.

define _sc_header_without_use

  dummy=; : so we do not need a semicolon before each use;		\

  h_esc=`echo '[<"]'"$$h"'[">]'|$(SED) 's/\./\\\\./g'`;			\

  if $(VC_LIST_EXCEPT) | $(GREP) '\.c$$' > /dev/null; then		\

    files=$$($(GREP) -l '^# *include '"$$h_esc"				\

	     $$($(VC_LIST_EXCEPT) | $(GREP) '\.c$$')) &&		\

    $(GREP) -LE "$$re" $$files | $(GREP) . &&				\

      { echo "$(ME): the above files include $$h but don't use it"	\

	1>&2; exit 1; } || :;						\

  else :;								\

  fi

endef

# Prohibit the inclusion of assert.h without an actual use of assert.

sc_prohibit_assert_without_use:

	@h='assert.h' re='\

# Prohibit the inclusion of close-stream.h without an actual use.

sc_prohibit_close_stream_without_use:

	@h='close-stream.h' re='\

# Prohibit the inclusion of getopt.h without an actual use.

sc_prohibit_getopt_without_use:

	@h='getopt.h' re='\

# Don't include quotearg.h unless you use one of its functions.

sc_prohibit_quotearg_without_use:

	@h='quotearg.h' re='\

# Don't include quote.h unless you use one of its functions.

sc_prohibit_quote_without_use:

	@h='quote.h' re='\<quote((_n)? *\(|_quoting_options\>)' \

	  $(_sc_header_without_use)

# Don't include this header unless you use one of its functions.

sc_prohibit_long_options_without_use:

	@h='long-options.h' re='\

	  $(_sc_header_without_use)

# Don't include this header unless you use one of its functions.

sc_prohibit_inttostr_without_use:

	@h='inttostr.h' re='\<(off|[iu]max|uint)tostr *\(' \

	  $(_sc_header_without_use)

# Don't include this header unless you use one of its functions.

sc_prohibit_ignore_value_without_use:

	@h='ignore-value.h' re='\

	  $(_sc_header_without_use)

# Don't include this header unless you use one of its functions.

sc_prohibit_error_without_use:

	@h='error.h' \

	re='\

	  $(_sc_header_without_use)

# Don't include xalloc.h unless you use one of its functions.

# Consider these symbols:

# perl -lne '/^# *define (\w+)\(/ and print $1' lib/xalloc.h|grep -v '^__';

# perl -lne '/^(?:extern )?(?:void|char) \*?(\w+) *\(/ and print $1' lib/xalloc.h

# Divide into two sets on case, and filter each through this:

# | sort | perl -MRegexp::Assemble -le \

#  'print Regexp::Assemble->new(file => "/dev/stdin")->as_string'|sed 's/\?://g'

# Note this was produced by the above:

# _xa1 = \

#x(((2n?)?re|c(har)?|n(re|m)|z)alloc|alloc_(oversized|die)|m(alloc|emdup)|strdup)

# But we can do better, in at least two ways:

# 1) take advantage of two "dup"-suffixed strings:

# x(((2n?)?re|c(har)?|n(re|m)|[mz])alloc|alloc_(oversized|die)|(mem|str)dup)

# 2) notice that "c(har)?|[mz]" is equivalent to the shorter and more readable

# "char|[cmz]"

# x(((2n?)?re|char|n(re|m)|[cmz])alloc|alloc_(oversized|die)|(mem|str)dup)

_xa1 = x(((2n?)?re|char|n(re|m)|[cmz])alloc|alloc_(oversized|die)|(mem|str)dup)

_xa2 = X([CZ]|N?M)ALLOC

sc_prohibit_xalloc_without_use:

	@h='xalloc.h' \

	re='\<($(_xa1)|$(_xa2)) *\('\

	  $(_sc_header_without_use)

# Extract function names:

# perl -lne '/^(?:extern )?(?:void|char) \*?(\w+) *\(/ and print $1' lib/hash.h

_hash_re = \

clear|delete|free|get_(first|next)|insert|lookup|print_statistics|reset_tuning

_hash_fn = \<($(_hash_re)) *\(

_hash_struct = (struct )?\<[Hh]ash_(table|tuning)\>

sc_prohibit_hash_without_use:

	@h='hash.h' \

	re='$(_hash_fn)|$(_hash_struct)'\

	  $(_sc_header_without_use)

sc_prohibit_cloexec_without_use:

	@h='cloexec.h' re='\<(set_cloexec_flag|dup_cloexec) *\(' \

	  $(_sc_header_without_use)

sc_prohibit_posixver_without_use:

	@h='posixver.h' re='\

sc_prohibit_same_without_use:

	@h='same.h' re='\

sc_prohibit_hash_pjw_without_use:

	@h='hash-pjw.h' \

	re='\<hash_pjw\>' \

	  $(_sc_header_without_use)

sc_prohibit_safe_read_without_use:

	@h='safe-read.h' re='(\<SAFE_READ_ERROR\>|\

	  $(_sc_header_without_use)

sc_prohibit_argmatch_without_use:

	@h='argmatch.h' \

	re='(\<(ARGMATCH_DEFINE_GROUP|ARRAY_CARDINALITY|X?ARGMATCH(|_TO_ARGUMENT|_VERIFY))\>|\<(invalid_arg|argmatch(_exit_fn|_(in)?valid)?) *\()' \

	  $(_sc_header_without_use)

sc_prohibit_canonicalize_without_use:

	@h='canonicalize.h' \

	re='CAN_(EXISTING|ALL_BUT_LAST|MISSING)|canonicalize_(mode_t|filename_mode|file_name)' \

	  $(_sc_header_without_use)

sc_prohibit_root_dev_ino_without_use:

	@h='root-dev-ino.h' \

	re='(\<ROOT_DEV_INO_(CHECK|WARN)\>|\

	  $(_sc_header_without_use)

sc_prohibit_openat_without_use:

	@h='openat.h' \

	re='\<(openat_(permissive|needs_fchdir|(save|restore)_fail)|l?(stat|ch(own|mod))at|(euid)?accessat|(FCHMOD|FCHOWN|STAT)AT_INLINE)\>' \

	  $(_sc_header_without_use)

# Prohibit the inclusion of c-ctype.h without an actual use.

ctype_re = isalnum|isalpha|isascii|isblank|iscntrl|isdigit|isgraph|islower\

|isprint|ispunct|isspace|isupper|isxdigit|tolower|toupper

sc_prohibit_c_ctype_without_use:

	@h='c-ctype.h' re='\

	  $(_sc_header_without_use)

# The following list was generated by running:

# man signal.h|col -b|perl -ne '/bsd_signal.*;/.../sigwaitinfo.*;/ and print' \

#   | perl -lne '/^\s+(?:int|void).*?(\w+).*/ and print $1' | fmt

_sig_functions = \

  bsd_signal kill killpg pthread_kill pthread_sigmask raise sigaction \

  sigaddset sigaltstack sigdelset sigemptyset sigfillset sighold sigignore \

  siginterrupt sigismember signal sigpause sigpending sigprocmask sigqueue \

  sigrelse sigset sigsuspend sigtimedwait sigwait sigwaitinfo

_sig_function_re = $(subst $(_sp),|,$(strip $(_sig_functions)))

# The following were extracted from "man signal.h" manually.

_sig_types_and_consts =							\

  MINSIGSTKSZ SA_NOCLDSTOP SA_NOCLDWAIT SA_NODEFER SA_ONSTACK		\

  SA_RESETHAND SA_RESTART SA_SIGINFO SIGEV_NONE SIGEV_SIGNAL		\

  SIGEV_THREAD SIGSTKSZ SIG_BLOCK SIG_SETMASK SIG_UNBLOCK SS_DISABLE	\

  SS_ONSTACK mcontext_t pid_t sig_atomic_t sigevent siginfo_t sigset_t	\

  sigstack sigval stack_t ucontext_t

# generated via this:

# perl -lne '/^#ifdef (SIG\w+)/ and print $1' lib/sig2str.c|sort -u|fmt -70

_sig_names =								\

  SIGABRT SIGALRM SIGALRM1 SIGBUS SIGCANCEL SIGCHLD SIGCLD SIGCONT	\

  SIGDANGER SIGDIL SIGEMT SIGFPE SIGFREEZE SIGGRANT SIGHUP SIGILL	\

  SIGINFO SIGINT SIGIO SIGIOT SIGKAP SIGKILL SIGKILLTHR SIGLOST SIGLWP	\

  SIGMIGRATE SIGMSG SIGPHONE SIGPIPE SIGPOLL SIGPRE SIGPROF SIGPWR	\

  SIGQUIT SIGRETRACT SIGSAK SIGSEGV SIGSOUND SIGSTKFLT SIGSTOP SIGSYS	\

  SIGTERM SIGTHAW SIGTRAP SIGTSTP SIGTTIN SIGTTOU SIGURG SIGUSR1	\

  SIGUSR2 SIGVIRT SIGVTALRM SIGWAITING SIGWINCH SIGWIND SIGWINDOW	\

  SIGXCPU SIGXFSZ

_sig_syms_re = $(subst $(_sp),|,$(strip $(_sig_names) $(_sig_types_and_consts)))

# Prohibit the inclusion of signal.h without an actual use.

sc_prohibit_signal_without_use:

	@h='signal.h'							\

	re='\<($(_sig_function_re)) *\(|\<($(_sig_syms_re))\>'		\

	  $(_sc_header_without_use)

# Don't include stdio--.h unless you use one of its functions.

sc_prohibit_stdio--_without_use:

	@h='stdio--.h' re='\<((f(re)?|p)open|tmpfile) *\('		\

	  $(_sc_header_without_use)

# Don't include stdio-safer.h unless you use one of its functions.

sc_prohibit_stdio-safer_without_use:

	@h='stdio-safer.h' re='\<((f(re)?|p)open|tmpfile)_safer *\('	\

	  $(_sc_header_without_use)

# Prohibit the inclusion of strings.h without a sensible use.

# Using the likes of bcmp, bcopy, bzero, index or rindex is not sensible.

sc_prohibit_strings_without_use:

	@h='strings.h'							\

	re='\<(strn?casecmp|ffs(ll)?)\>'				\

	  $(_sc_header_without_use)

# Extract the raw list of symbol names with this:

gl_extract_define_simple = \

  /^\# *define ([A-Z]\w+)\(/ and print $$1

# Filter out duplicates and convert to a space-separated list:

_intprops_names = \

  $(shell f=$(gnulib_dir)/lib/intprops.h;				\

    perl -lne '$(gl_extract_define_simple)' $$f | sort -u | tr '\n' ' ')

# Remove trailing space and convert to a regular expression:

_intprops_syms_re = $(subst $(_sp),|,$(strip $(_intprops_names)))

# Prohibit the inclusion of intprops.h without an actual use.

sc_prohibit_intprops_without_use:

	@h='intprops.h'							\

	re='\<($(_intprops_syms_re)) *\('				\

	  $(_sc_header_without_use)

_stddef_syms_re = NULL|offsetof|ptrdiff_t|size_t|wchar_t

# Prohibit the inclusion of stddef.h without an actual use.

sc_prohibit_stddef_without_use:

	@h='stddef.h'							\

	re='\<($(_stddef_syms_re))\>'					\

	  $(_sc_header_without_use)

_de1 = dirfd|(close|(fd)?open|read|rewind|seek|tell)dir(64)?(_r)?

_de2 = (versionsort|struct dirent|getdirentries|alphasort|scandir(at)?)(64)?

_de3 = MAXNAMLEN|DIR|ino_t|d_ino|d_fileno|d_namlen

_dirent_syms_re = $(_de1)|$(_de2)|$(_de3)

# Prohibit the inclusion of dirent.h without an actual use.

sc_prohibit_dirent_without_use:

	@h='dirent.h'							\

	re='\<($(_dirent_syms_re))\>'					\

	  $(_sc_header_without_use)

# Prohibit the inclusion of verify.h without an actual use.

sc_prohibit_verify_without_use:

	@h='verify.h'							\

	re='\<(verify(true|expr)?|assume|static_assert) *\('		\

	  $(_sc_header_without_use)

# Don't include xfreopen.h unless you use one of its functions.

sc_prohibit_xfreopen_without_use:

	@h='xfreopen.h' re='\

sc_obsolete_symbols:

	@prohibit='\<(HAVE''_FCNTL_H|O''_NDELAY)\>'			\

	halt='do not use HAVE''_FCNTL_H or O'_NDELAY			\

	  $(_sc_search_regexp)

# FIXME: warn about definitions of EXIT_FAILURE, EXIT_SUCCESS, STREQ

# Each nonempty ChangeLog line must start with a year number, or a TAB.

sc_changelog:

	@prohibit='^[^12	]'					\

	in_vc_files='^ChangeLog$$'					\

	halt='found unexpected prefix in a ChangeLog'			\

	  $(_sc_search_regexp)

# Ensure that each .c file containing a "main" function also

# calls bindtextdomain.

sc_bindtextdomain:

	@require='bindtextdomain *\('					\

	in_vc_files='\.c$$'						\

	containing='\

	halt='the above files do not call bindtextdomain'		\

	  $(_sc_search_regexp)

# Require that the final line of each test-lib.sh-using test be this one:

# Exit $fail

# Note: this test requires GNU grep's --label= option.

Exit_witness_file ?= tests/test-lib.sh

Exit_base := $(notdir $(Exit_witness_file))

sc_require_test_exit_idiom:

	@if test -f $(srcdir)/$(Exit_witness_file); then		\

	  die=0;							\

	  for i in $$($(GREP) -l -F 'srcdir/$(Exit_base)'		\

		$$($(VC_LIST) tests)); do				\

	    tail -n1 $$i | $(GREP) '^Exit .' > /dev/null		\

	      && : || { die=1; echo $$i; }				\

	  done;								\

	  test $$die = 1 &&						\

	    { echo 1>&2 '$(ME): the final line in each of the above is not:'; \

	      echo 1>&2 'Exit something';				\

	      exit 1; } || :;						\

	fi

sc_trailing_blank:

	@prohibit='[	 ]$$'						\

	halt='found trailing blank(s)'					\

	exclude='^Binary file .* matches$$'				\

	  $(_sc_search_regexp)

# Match lines like the following, but where there is only one space

# between the options and the description:

#   -D, --all-repeated[=delimit-method]  print all duplicate lines\n

longopt_re = --[a-z][0-9A-Za-z-]*(\[?=[0-9A-Za-z-]*\]?)?

sc_two_space_separator_in_usage:

	@prohibit='^   *(-[A-Za-z],)? $(longopt_re) [^ ].*\\$$'		\

	halt='help2man requires at least two spaces between an option and its description'\

	  $(_sc_search_regexp)

# A regexp matching function names like "error" that may be used

# to emit translatable messages.

_gl_translatable_diag_func_re ?= error

# Look for diagnostics that aren't marked for translation.

# This won't find any for which error's format string is on a separate line.

sc_unmarked_diagnostics:

	@prohibit='\<$(_gl_translatable_diag_func_re) *\([^"]*"[^"]*[a-z]{3}' \

	exclude='(_|ngettext ?)\('					\

	halt='found unmarked diagnostic(s)'				\

	  $(_sc_search_regexp)

# Avoid useless parentheses like those in this example:

# #if defined (SYMBOL) || defined (SYM2)

sc_useless_cpp_parens:

	@prohibit='^# *if .*defined *\('				\

	halt='found useless parentheses in cpp directive'		\

	  $(_sc_search_regexp)

# List headers for which HAVE_HEADER_H is always true, assuming you are

# using the appropriate gnulib module.  CAUTION: for each "unnecessary"

# #if HAVE_HEADER_H that you remove, be sure that your project explicitly

# requires the gnulib module that guarantees the usability of that header.

gl_assured_headers_ = \

  cd $(gnulib_dir)/lib && echo *.in.h|$(SED) 's/\.in\.h//g'

# Convert the list of names to upper case, and replace each space with "|".

az_ = abcdefghijklmnopqrstuvwxyz

AZ_ = ABCDEFGHIJKLMNOPQRSTUVWXYZ

gl_header_upper_case_or_ =						\

  $$($(gl_assured_headers_)						\

    | tr $(az_)/.- $(AZ_)___						\

    | tr -s ' ' '|'							\

    )

sc_prohibit_always_true_header_tests:

	@or=$(gl_header_upper_case_or_);				\

	re="HAVE_($$or)_H";						\

	prohibit='\<'"$$re"'\>'						\

	halt=$$(printf '%s\n'						\

	'do not test the above HAVE_<header>_H symbol(s);'		\

	'  with the corresponding gnulib module, they are always true')	\

	  $(_sc_search_regexp)

sc_prohibit_defined_have_decl_tests:

	@prohibit='(#[	 ]*ifn?def|\<defined)\>[	 (]+HAVE_DECL_'	\

	halt='HAVE_DECL macros are always defined'			\

	  $(_sc_search_regexp)

# ==================================================================

gl_other_headers_ ?= \

  intprops.h	\

  openat.h	\

  stat-macros.h