configure.py

#!/usr/bin/python
# coding=utf-8
#  Copyright 2010-2019 Matus Chochlik. Distributed under the Boost
#  Software License, Version 1.0. (See accompanying file
#  LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#
import os, sys, string, getopt, shutil, subprocess

# returns the path to the default build directory
def get_default_build_dir():
    try:
        try:
            if os.environ['BUILD_DIR']:
                return os.path.join(os.environ['BUILD_DIR'], 'oglplu2')
            if os.environ['BINARY_DIR']:
                return os.path.join(os.environ['BINARY_DIR'], 'oglplu2')
        except: pass

        with open(os.path.join(get_root_dir(), "BINARY_DIR"), "rt") as bdf:
            return bdf.read()
    except: return os.path.join(get_root_dir(), "_build");

# initial values for the configuration options

def get_argument_parser():
	import argparse
	import datetime

	def BoolArgValue(arg):
		if(arg in ("True", "true", "Yes", "yes", "Y", "On", "1")):
			return True
		elif(arg in ("False", "false", "No", "no", "N", "Off", "0")):
			return False
		else:
			msg = "'%s' is not a valid boolean value" % str(arg)
			raise argparse.ArgumentTypeError(msg)

	def JobCountValue(arg):
		msg_fmt = "'%s' is not a valid process count value"
		try:
			if int(arg) < 0:
				msg = msg_fmt % str(arg)
				raise argparse.ArgumentTypeError(msg)
			else:
				return int(arg)
		except:
			msg = msg_fmt % str(arg)
			raise argparse.ArgumentTypeError(msg)

	def OpenGLVersionValue(arg):
		import re
		match = re.match("^([3-9]).([0-9])$", arg)
		if match:
			return match.group(1)+"_"+match.group(2)
		else:
			msg = "'%s' is not a supported OpenGL version" % str(arg)
			raise argparse.ArgumentTypeError(msg)

	CMakeGeneratorValue = str

	version_file = os.path.join(os.path.dirname(sys.argv[0]), "VERSION")
	try: version = open(version_file, "r").read().strip()
	except: version = str("<unknown>")


	argparser = argparse.ArgumentParser(
		prog="configure",
		description="""
			Configuration script for the OGLplus library (version %(version)s)
		""" % { "version" : version },
		epilog="""
			Copyright (c) 2008 - %(year)d Matúš Chochlík.
			Permission is granted to copy, distribute and/or modify this document
			under the terms of the Boost Software License, Version 1.0.
			(See a copy at http://www.boost.org/LICENSE_1_0.txt)
		""" % { "year": datetime.datetime.now().year }
	)
	argparser.add_argument(
		"--generate-bash-complete",
		action="store_true",
		help="""
			Generates bash completion script for this configure script and quits.
			For internal use only.
		"""
	)
	argparser.add_argument(
		"--generate-manual",
		action="store_true",
		help="""
			Generates a man-compatible manual.
			For internal use only.
		"""
	)
	argparser.add_argument(
		"--prefix",
		dest="install_prefix",
		type=os.path.abspath,
		action="store",
		help="""
			Specifies the installation prefix. The path must be absolute or
			relative to the current working directory from which %(prog)s is
			invoked.
		"""
	)
	argparser.add_argument(
		"--build-dir",
		type=os.path.abspath,
		default=get_default_build_dir(),
		action="store",
		help="""
			Specifies the work directory for cmake, where the cached files,
			generated makefiles and the intermediate build files will be
			placed. The specified path must be either absolute or
			relative to the current working directory from which %(prog)s
			is invoked (default = '%(default)s').
		"""
	)
	argparser.add_argument(
		"--include-dir", "-I",
		dest="include_dirs",
		type=os.path.abspath,
		action="append",
		default=list(),
		help="""
			Specifies additional directory to search when looking for external
			headers like GL/glew.h or GL3/gl3.h. The specified path
			must be absolute or relative to the current working directory
			from which %(prog)s is invoked. This option may be specified
			multiple times to add multiple directories to the search list.
		"""
	)
	argparser.add_argument(
		"--library-dir", "-L",
		dest="library_dirs",
		type=os.path.abspath,
		action="append",
		default=list(),
		help="""
			Specifies additional directory to search when looking for compiled
			libraries like GL, GLEW, glut, png, etc. The specified
			path must be absolute or relative to the current working directory
			from which configure is invoked. This option may be specified
			multiple times to add multiple directories to the search list.
		"""
	)
	argparser.add_argument(
		"--search-dir", "-S",
		dest="search_dirs",
		type=os.path.abspath,
		action="append",
		default=list(),
		help="""
			Specifies additional directory with include and lib subdirectories
			that should be searched when looking for C++ headers or compiled
			libraries. Specifying --search-dir PATH is equivalent to specifying
			--include-dir PATH/include --library-dir PATH/lib. The provided
			path must be absolute or relative to the current working directory
			from which configure is invoked. This option may be specified
			multiple times to add multiple directories to the search list.
		"""
	)

	argparser.add_argument(
		"--use-cxxflags",
		default=False,
		action="store_true",
		help="""
			Uses the directories specified by the -I options
			in CXXFLAGS (if available) and adds them
			to the values specified by --include-dir.
		"""
	)
	argparser.add_argument(
		"--use-ldflags",
		default=False,
		action="store_true",
		help="""
			Uses the directories specified by the -L options
			in LDFLAGS (if available) and adds them
			to the values specified by --library-dir.
		"""
	)
	argparser.add_argument(
		"--low-profile",
		dest="low_profile",
		type=BoolArgValue,
		choices=[True, False],
		action="store",
		default=None,
		help="""
			Enables or disables the low profile mode (see the documentation
			for the OGLPLUS_LOW_PROFILE compile-time switch).
			If this option is used, then the specified value is written to
			the oglplus/config/site.hpp file, otherwise it is set to the default
			value in oglplus/config.hpp and may be overriden in sources by
			defining this preprocessor symbol or by using the appropriate
			compiler command-line switch or build environment setting.
		"""
	)
	argparser.add_argument(
		"--info-only",
		dest="info_only",
		action="store_true",
		default=False,
		help="""
			With this option configure only generates a python script containing
			information about the available configurations on the current machine.
		"""
	)
	argparser_use_boost_config_group = argparser.add_mutually_exclusive_group()
	argparser_use_boost_config_group .add_argument(
		"--use-boost-config",
		dest="use_boost_config",
		type=BoolArgValue,
		choices=[True, False],
		action="store",
		default=True,
		help="""
			Enables or disables the use of the Boost.Config library for the
			detection of availability of C++ language features (default = %(default)s).
		"""
	)
	argparser_use_boost_config_group .add_argument(
		"--no-boost-config",
		dest="use_boost_config",
		action="store_false",
		help="""
			Do not use the Boost.Config library for C++ feature availability
			detection.
			Equivalent to --use-boost-config=False.
		"""
	)

	argparser_build_examples_group = argparser.add_mutually_exclusive_group()
	argparser_build_examples_group.add_argument(
		"--build-examples",
		dest="build_examples",
		type=BoolArgValue,
		choices=[True, False],
		action="store",
		default=True,
		help="""
			Determines whether the examples should be built (default = %(default)s).
		"""
	)
	argparser_build_examples_group.add_argument(
		"--no-examples",
		dest="build_examples",
		action="store_false",
		help="""
			Do not build the examples and the textures.
			Equivalent to --build-examples=False.
		"""
	)
	argparser_build_docs_group = argparser.add_mutually_exclusive_group()
	argparser_build_docs_group.add_argument(
		"--build-docs",
		dest="build_docs",
		type=BoolArgValue,
		choices=[True, False],
		action="store",
		default=True,
		help="""
			Determines whether the documentation should be built (default = %(default)s).
		"""
	)
	argparser_build_docs_group.add_argument(
		"--no-docs",
		dest="build_docs",
		action="store_false",
		help="""
			Do not build the documentation.
			Equivalent to --build-docs=False.
		"""
	)
	argparser_make_screenshots_group = argparser.add_mutually_exclusive_group()
	argparser_make_screenshots_group.add_argument(
		"--make-screenshots",
		dest="make_screenshots",
		type=BoolArgValue,
		choices=[True, False],
		action="store",
		default=False,
		help="""
			Determines whether screenshots from OGLplus examples should be
			made when building the documentation (default = %(default)s).
		"""
	)
	argparser_make_screenshots_group.add_argument(
		"--screenshots",
		dest="make_screenshots",
		action="store_true",
		help="""
			Equivalent to --make-screenshots=True.
		"""
	)
	argparser.add_argument(
		"--max-gl-version",
		dest="max_gl_version",
		type=OpenGLVersionValue,
		action="store",
		default=None,
		help="""
			Sets the maximum OpenGL version to be used. The cmake OpenGL
			version detection is only rudimentary and not 100%% reliable
			and may return a higher OpenGL version than actually available.
			This option can be used to limit the maximal version number.
		"""
	)
	argparser.add_argument(
		"--strict-gl-version-detection",
		dest="strict_gl_version_detection",
		type=BoolArgValue,
		action="store",
		default=True,
		help="""
			Enables (or disables) strict GL version and extension detection.
			In relaxed (non-strict) mode the only thing that is detected is
			whether specific GL symbols are defined like GL_VERSION_x_y or
			GL_EXT_extension_name. In strict mode a GL context is initialized
			and the GL version and extension list is queried and processed.
		"""
	)

	path2idus = string.maketrans("/.","__")
	path2idmi = string.maketrans("/.","--")
	gl_api_libs = {
		"glcorearb.h"  : "GL/glcorearb.h header",
		"gl3.h"        : "GL3/gl3.h header",
		"GLES3/gl32.h" : "GLES3/gl32.h header",
		"GLES3/gl31.h" : "GLES3/gl31.h header",
		"GLES3/gl3.h"  : "GLES3/gl3.h header",
		"GLEW"         : "GLEW library",
		"GL3W"         : "GL3W library"
	}

	argparser_gl_api_lib_group = argparser.add_mutually_exclusive_group()
	argparser_gl_api_lib_group.add_argument(
		"--use-gl-api-lib",
		dest="gl_api_lib",
		type=str,
		choices=[lib.upper().translate(path2idus) for lib in gl_api_libs.keys() ],
		action="store",
		default=None,
		help="""
			Forces the use of a specific header or library which
			defines the GL symbols (types, functions, defines, etc.).
			If this option is used then the header must be installed somewhere
			in the system include directories or in directories specified
			with --include-dir and the corresponding binary libraries
			must be installed in system library directories or in directories
			specified with the --library-dir option.
		"""
	)
	for gl_api_lib, gl_api_lib_name in gl_api_libs.items():
		lib_lc = gl_api_lib.lower().translate(path2idmi)
		lib_uc = gl_api_lib.upper().translate(path2idus)
		argparser_gl_api_lib_group.add_argument(
			"--use-%(lib_lc)s" % { "lib_lc" : lib_lc },
			dest="gl_api_lib",
			action="store_const",
			const=lib_uc,
			help="""
				Forces the use of the %(lib_name)s to define the GL symbols
				used in OGLplus examples.
				Equivalent to --use-gl-api-lib=%(lib_uc)s.
			""" % {
				"lib" : gl_api_lib,
				"lib_name" : gl_api_lib_name,
				"lib_uc" : lib_uc
			}
		)

	gl_init_libs = ["GLUT", "GLFW3", "GLFW", "wxGL", "SDL", "glX", "Qt5GL",  "EGL"]
	argparser_gl_init_lib_group = argparser.add_mutually_exclusive_group()
	argparser_gl_init_lib_group.add_argument(
		"--use-gl-init-lib",
		dest="gl_init_lib",
		type=str,
		choices=[lib.upper() for lib in gl_init_libs],
		action="store",
		default=None,
		help="""
			Forces the use of a specific window library which
			initializes the default GL context. This option allows
			to force a specific example 'harness'.
		"""
	)

	for gl_init_lib in gl_init_libs:
		argparser_gl_init_lib_group.add_argument(
			"--use-%(lib_lc)s" % { "lib_lc" : gl_init_lib.lower() },
			dest="gl_init_lib",
			action="store_const",
			const=gl_init_lib.upper(),
			help="""
				Forces the use of the %(lib)s library to create
				the window and initialize the GL context in
				OGLplus examples.
				Equivalent to --use-gl-init-lib=%(lib_uc)s.
			""" % {
				"lib" : gl_init_lib,
				"lib_uc" : gl_init_lib.upper()
			}
		)

	argparser.add_argument(
		"--from-scratch",
		default=False,
		action="store_true",
		help="""
			Remove any previous cached and intermediate files and run the
			configuration process from scratch.
			Specifying this option causes the build directory to be deleted
			and recreated.
		"""
	)
	argparser.add_argument(
		"--quiet",
		default=False,
		action="store_true",
		help="""
			Do not print regular messages, errors are still printed to
			stderr. Also any cmake output is still printed.
		"""
	)
	argparser.add_argument(
		"--quick",
		default=False,
		action="store_true",
		help="""
			Skips some optional steps in the configuration process.
		"""
	)
	argparser.add_argument(
		"--jobs",
		type=JobCountValue,
		default=None,
		action="store",
		help="""
			Specifies the number of parallel build jobs to be used,
			if applicable for the used build tool.
		"""
	)
	argparser.add_argument(
		"--build",
		default=False,
		action="store_true",
		help="""
			If possible, after running cmake also invoke the build tool
			and build the project. This is currently supported only
			for certain build tools.
		"""
	)
	argparser.add_argument(
		"--with-tests",
		default=False,
		action="store_true",
		help="""
			Configure the testsuite.
		"""
	)
	argparser.add_argument(
		"--with-clang-tidy",
		default=False,
		action="store_true",
		help="""
			Configure the clang-tidy checks.
		"""
	)
	argparser.add_argument(
		"--generator",
		type=CMakeGeneratorValue,
		default=None,
		action="store",
		help="""
			Specify the cmake generator to be used.
		"""
	)
	argparser.add_argument(
		"--debug-config",
		dest="debug_config",
		default=False,
		action="store_true",
		help="""
			Enable debugging of the cmake build system.
		"""
	)
	argparser.add_argument(
		"--debug-gl-ver-error",
		dest="debug_gl_ver_error",
		default=False,
		action="store_true",
		help="""
			Enable debugging of problems with GL version detetion.
		"""
	)
	argparser.add_argument(
		"--debug-gl-ext-error",
		dest="debug_gl_ext_error",
		type=str,
		default="",
		action="store",
		help="""
			Enable debugging of problems with GL extension detetion.
		"""
	)
	argparser.add_argument(
		"--debug-lib-error",
		dest="debug_lib_error",
		default=False,
		action="store_true",
		help="""
			Enable debugging of problems with building the library.
		"""
	)
	argparser.add_argument(
		"--cmake",
		dest="cmake_options",
		nargs=argparse.REMAINDER,
		default=list(),
		help="""Everything following this option will be passed to cmake verbatim."""
	)

	return argparser

# returns the common valid prefix for the specified paths
def common_path_prefix(paths):
	prefix = os.path.commonprefix(paths)
	for path in paths:
		if prefix != path:
			suffix = path[len(prefix):]
			if not suffix.startswith(os.path.sep):
				return os.path.dirname(prefix)
	return prefix


# returns the shortest path from the directory
# at source_path to the directory at target_path
def shortest_path_from_to(source_path, target_path):
	source_path = os.path.abspath(source_path)
	target_path = os.path.abspath(target_path)

	if source_path == target_path:
		return os.path.curdir

	common_prefix = common_path_prefix([
		source_path,
		target_path
	])
	backtrace = os.path.curdir
	while source_path != common_prefix:
		source_path = os.path.dirname(source_path)
		backtrace = os.path.join(os.path.pardir, backtrace)
	backtrace = os.path.normpath(backtrace)

	relative_path = target_path[len(common_prefix):]
	if relative_path.startswith(os.path.sep):
		relative_path = relative_path[len(os.path.sep):]
	relative_path = os.path.normpath(os.path.join(
		backtrace,
		relative_path
	))
	if len(relative_path) < len(target_path):
		return relative_path
	else: return target_path

# shortens a full command path to a command name only
# if possible
def shorten_command(command_path):
	def is_exe(filepath):
		return os.path.isfile(filepath) and os.access(filepath, os.X_OK)

	command_dir, command = os.path.split(command_path)

	for path_dir in os.environ["PATH"].split(os.pathsep):
		if command_dir == path_dir and is_exe(command_path):
			return command
	return command_path

# applies LD_LIBRARY_PATH to library search directories
def search_ld_library_path():
	ld_library_path_dirs = list()
	try:
		ld_library_path = os.environ.get("LD_LIBRARY_PATH")
		if ld_library_path:
			for ld_library_dir in ld_library_path.split(':'):
				if os.path.isdir(ld_library_dir):
					ld_library_path_dirs.append(ld_library_dir)
	except: pass
	return ld_library_path_dirs

# applies CXXFLAGS to the options for cmake if possible
def search_cxxflags():
	cxxflags_include_dirs = list()
	try:
		import shlex

		cxxflags = os.environ.get("CXXFLAGS")
		if cxxflags is not None:
			flagiter = iter(shlex.split(cxxflags))
			for flag in flagiter:
				if flag == "-I":
					cxxflags_include_dirs.append(flagiter.next())
				elif flag.startswith("-I"):
					cxxflags_include_dirs.append(flag[2:])
	except: pass
	return cxxflags_include_dirs


# applies LDFLAGS to the options for cmake if possible
def search_ldflags():
	ldflags_library_dirs = list()
	try:
		import shlex

		ldflags = os.environ.get("LDFLAGS")
		if ldflags is not None:
			flagiter = iter(shlex.split(ldflags))
			for flag in flagiter:
				if flag == "-L":
					ldflags_library_dirs.append(flagiter.next())
				elif flag.startswith("-L"):
					ldflags_library_dirs.append(flag[2:])
	except: pass
	return ldflags_library_dirs

# get some useful information from cmake
def cmake_system_info(cmake_args):
	command = ["cmake", "--system-information"] + cmake_args
	try:
		proc = subprocess.Popen(
			command,
			stdin=None,
			stdout=subprocess.PIPE,
			stderr=None
		)
	except OSError as os_error:
		print("Failed to execute '%(cmd)s': %(error)s" % {
			"cmd": command,
			"error": os_error
		})
		sys.exit(2)

	result = dict()

	try:
		import shlex
		for line in proc.stdout.readlines():
			try:
				words = shlex.split(line)
				if(words[0] in (
					"CMAKE_BUILD_TOOL",
					"CMAKE_INSTALL_PREFIX"
				)): result[words[0]] = words[1]
			except ValueError:
				pass
			except IndexError:
				pass
	except: pass

	return result

def print_bash_complete_script(argparser):

	import argparse
	import datetime

	year = datetime.datetime.now().year
	print('#  Copyright 2010-%(year)s Matus Chochlik.' % {"year" : year})
	print('#  Distributed under the Boost Software License, Version 1.0.')
	print('#  (See accompanying file LICENSE_1_0.txt or copy at')
	print('#  http://www.boost.org/LICENSE_1_0.txt)')
	print('#')
	print('#  Automatically generated file. Do NOT modify manually,')
	print('#  edit %(self)s instead' % {"self" : os.path.basename(sys.argv[0])})
	print(str())
	print('function _oglplus_config()')
	print('{')
	print('	COMPREPLY=()')
	print('	local curr="${COMP_WORDS[COMP_CWORD]}"')
	print('	local prev="${COMP_WORDS[COMP_CWORD-1]}"')
	print(str())

	options_with_path=list()
	for action in argparser._actions:
		if action.type == os.path.abspath:
			options_with_path += action.option_strings

	print('	case "${prev}" in')
	print('		-h|--help)')
	print('			return 0;;')
	print('		--generator)')
	print('			OLDIFS=${IFS}')
	print('			IFS=$\'\\r\\n\'')
	print('			COMPREPLY=($(')
	print('				cmake --help |')
	print('				sed -n \'/^Generators\s*$/,$p\' |')
	print('				tail -n +4 |')
	print('				grep -v -e \'^\s\+=\' |')
	print('				grep -v -e \'^\s*$\' |')
	print('				cut -d= -f 1 |')
	print('				sed \'s/^\s*\([^ ].\+[^ ]\)\s*$/\\1/\' |')
	print('				grep -e "^${curr}" |')
	print('				sed \'s/ /\\\\ /g\'')
	print('			))')
	print('			IFS=${OLDIFS}')
	print('			return 0;;')
	print('		%s)' % str("|").join(options_with_path))
	print('			COMPREPLY=($(compgen -f "${curr}"))')
	print('			return 0;;')


	for action in argparser._actions:
		if action.choices is not None:
			print('		%s)' % str("|").join(action.option_strings))
			ch = str(" ").join([str(c) for c in action.choices])
			print('			COMPREPLY=($(compgen -W "%s" -- "${curr}"))' % ch)
			print('			return 0;;')

	print('		*)')
	print('	esac')
	print(str())

	print('	local only_once_opts=" \\')
	for action in argparser._actions:
		if type(action) != argparse._AppendAction:
			print('		%s \\' % str(" ").join(action.option_strings))
	print('	"')
	print(str())

	muog_list = list()
	muog_id = 0
	for group in argparser._mutually_exclusive_groups:
		print('	local muog_%d=" \\' % muog_id)
		for action in group._group_actions:
			print('		%s \\' % str(" ").join(action.option_strings))
		print('	"')
		print(str())
		muog_list.append('muog_%d' % muog_id)
		muog_id += 1

	print('	local repeated_opts=" \\')
	for action in argparser._actions:
		if type(action) == argparse._AppendAction:
			print('		%s \\' % str(" ").join(action.option_strings))
	print('	"')
	print(str())
	print('	local opts="${repeated_opts}"')
	print(str())
	print('	for opt in ${only_once_opts}')
	print('	do')
	print('		local opt_used=false')
	print('		for pre in ${COMP_WORDS[@]}')
	print('		do')
	print('			if [ "${opt}" == "${pre}" ]')
	print('			then opt_used=true && break')
	print('			fi')
	print('		done')
	print('		if [ "${opt_used}" == "false" ]')
	print('		then')
	print('			for muog in "${%s}"' % str('}" "${').join(muog_list))
	print('			do')
	print('				local is_muo=false')
	print('				for muo in ${muog}')
	print('				do')
	print('					if [ "${opt}" == "${muo}" ]')
	print('					then is_muo=true && break')
	print('					fi')
	print('				done')
	print('				if [ "${is_muo}" == "true" ]')
	print('				then')
	print('					for pre in ${COMP_WORDS[@]}')
	print('					do')
	print('						for muo in ${muog}')
	print('						do')
	print('							if [ "${pre}" == "${muo}" ]')
	print('							then opt_used=true && break')
	print('							fi')
	print('						done')
	print('					done')
	print('				fi')
	print('			done')
	print(str())
	print('			if [ "${opt_used}" == "false" ]')
	print('			then opts="${opts} ${opt}"')
	print('			fi')
	print('		fi')
	print('	done')
	print(str())
	print('	if [ ${COMP_CWORD} -le 1 ]')
	print('	then opts="--help ${opts}"')
	print('	fi')
	print(str())
	print('	COMPREPLY=($(compgen -W "${opts}" -- "${curr}"))')
	print('}')
	print('complete -F _oglplus_config ./oglplus-config')

def man_highlight(info_text):
	import re

	return re.sub(
		r'(OGLPLUS_[A-Z0-9_]+|CXXFLAGS|LDFLAGS|GL.*/[A-Za-z0-9_]+.h)',
		r'\\fI\1\\fR',
		info_text
	)

def print_manual(argparser):
	import argparse
	import datetime

	now = datetime.datetime.now()
	print(
		'.TH CONFIGURE-OGLPLUS 1 "%s" "Configuration script for OGLplus."' %
		str(now.date())
	)
	print('.SH "NAME"')
	print('configure-oglplus \\- configuration script for the OGLplus library.')
	print('.SH "SYNOPSIS"')
	print('.B configure-oglplus')
	print('[')
	print('OPTIONS')
	print(']')

	print('.SH "DESCRIPTION"')
	print('This script is a more user-friendly way to invoke the cmake-based')
	print('build system of \\fBOGLplus\\fR.')


	print('.SH "OPTIONS"')

	for action in argparser._actions:
		print(".TP")
		opt_info = str()
		for opt_str in action.option_strings:
			if opt_info:
				opt_info += ", "
			opt_info += '\\fB'+opt_str+'\\fR'
			if action.type == os.path.abspath:
				opt_info += ' <\\fI'+str(action.dest).upper()+'\\fR>';
			if action.choices is not None:
				opt_info += ' {\\fB'
				opt_info += '\\fR,\\fB'.join(map(str, action.choices))
				opt_info += '\\fR}'
		print(opt_info)
		print(
			str(' ').join(man_highlight(action.help).split()) % {
				"prog": "\\fBconfigure-oglplus\\fR",
				"default": "\\fB"+str(action.default)+"\\fR"
			}
		)


	print('.SH "AUTHOR"')
	print('Matus Chochlik, chochlik@gmail.com')

	print('.SH "COPYRIGHT"')
	print('Copyright (c) 2008-%(year)s Matus Chochlik' % {"year": now.year})

	print(".PP")
	print("Permission is granted to copy, distribute and/or modify this document")
	print("under the terms of the Boost Software License, Version 1.0.")
	print("(See a copy at http://www.boost.org/LICENSE_1_0.txt)")

# the main function
def main(argv):

	# parse and process the command-line arguments
	argparser = get_argument_parser()
	options = argparser.parse_args()
	cmake_env = os.environ.copy()
	if sys.platform == 'win32':
		env_list_sep = str(";")
	else: env_list_sep = str(":")

	# if we just wanted to generate the bash completion script
	if options.generate_bash_complete:
		print_bash_complete_script(argparser)
		return 0

	# if we just wanted to generate the bash completion script
	if options.generate_manual:
		print_manual(argparser)
		return 0

	# if we are in quiet mode we may also go to quick mode
	if options.quiet: options.quick = True

	# if we also want to build the project disable quick mode
	if options.build: options.quick = False

	# get the info from cmake if we are not in a hurry
	if not options.quick:
		cmake_info = cmake_system_info(options.cmake_options)
	else: cmake_info = list()

	# the search prefix
	for search_dir in options.search_dirs:
		subdir = os.path.join(search_dir, "include")
		if os.path.exists(subdir):
			options.include_dirs.append(subdir)
		subdir = os.path.join(search_dir, "lib")
		if os.path.exists(subdir):
			options.library_dirs.append(subdir)
			subdir = os.path.join(subdir, "pkgconfig")
			pkg_config_path = cmake_env.get("PKG_CONFIG_PATH", None)
			if pkg_config_path:
				pc_paths = pkg_config_path.split(env_list_sep)
				pc_paths.append(subdir)
				pkg_config_path = env_list_sep.join(pc_paths)
			else: pkg_config_path = subdir
			cmake_env["PKG_CONFIG_PATH"] = pkg_config_path

	# search the LD_LIBRARY_PATH
	options.library_dirs += search_ld_library_path()
	# search the CXX and LD FLAGS if requested
	if(options.use_cxxflags): options.include_dirs += search_cxxflags()
	if(options.use_ldflags):  options.library_dirs += search_ldflags()

	# additional options for cmake
	cmake_options = list()

	# add the installation prefix if provided
	if(options.install_prefix):
		cmake_options.append(
			"-DCMAKE_INSTALL_PREFIX="+
			options.install_prefix
		)

	# set the low profile mode switch
	if(options.low_profile is not None):
		cmake_options.append("-DOGLPLUS_CONFIG_SET_LOW_PROFILE=On")
		if(options.low_profile):
			cmake_options.append("-DOGLPLUS_LOW_PROFILE=On")
		else:
			cmake_options.append("-DOGLPLUS_LOW_PROFILE=Off")

	if(options.info_only):
		options.build_examples = False
		options.make_screenshots = False
		options.build_docs = False
		options.use_boost_config = False
		options.build = False

	# disable building the examples
	if(not options.build_examples):
		cmake_options.append("-DOGLPLUS_NO_EXAMPLES=On")

	# disable example screenshots in the docs
	if(not options.make_screenshots):
		cmake_options.append("-DOGLPLUS_NO_SCREENSHOTS=On")

	# don't use Boost.Config
	if(not options.use_boost_config):
		cmake_options.append("-DOGLPLUS_NO_BOOST_CONFIG=On")

	# disable building the docs
	if(not options.build_docs):
		cmake_options.append("-DOGLPLUS_NO_DOCS=On")

	# limit the GL version
	if(options.max_gl_version):
		cmake_options.append("-DOGLPLUS_MAX_GL_VERSION="+options.max_gl_version)

	# enable/disable strict version detection
	if(options.strict_gl_version_detection is not None):
		value = int(options.strict_gl_version_detection)
		cmake_options.append("-DOGLPLUS_CONFIG_STRICT_VERSION_CHECK="+str(value))

	# force the GL header to be used
	if(options.gl_api_lib):
		cmake_options.append("-DOGLPLUS_FORCE_GL_API_LIB="+options.gl_api_lib)

	# force the GL initialization library to be used
	if(options.gl_init_lib):
		cmake_options.append("-DOGLPLUS_FORCE_GL_INIT_LIB="+options.gl_init_lib)

	# add paths for header lookop
	if(options.include_dirs):
		cmake_options.append("-DHEADER_SEARCH_PATHS="+";".join(options.include_dirs))

	# add paths for library lookup
	if(options.library_dirs):
		cmake_options.append("-DLIBRARY_SEARCH_PATHS="+";".join(options.library_dirs))

	# remove the build dir if it was requested
	if(options.from_scratch and os.path.exists(options.build_dir)):
		try: shutil.rmtree(options.build_dir)
		except OSError as os_error:
			print("Warning failed to remove build directory")

	# configure the test suite
	if(options.with_tests):
		cmake_options.append("-DOGLPLUS_WITH_TESTS=On")

	# configure the clang-tidy
	if(options.with_clang_tidy):
		cmake_options.append("-DOGLPLUS_WITH_CLANG_TIDY=On")

	# set the generator if specified
	if(options.generator):
		cmake_options += ['-G', options.generator]

	# put cmake in debug mode if specified
	if(options.debug_config):
		cmake_options += ["--debug-output", "--debug-trycompile"]
	if(options.debug_gl_ver_error):
		cmake_options += ["-DOGLPLUS_DEBUG_GL_VER_ERROR=1"]
	if(options.debug_gl_ext_error):
		cmake_options += ["-DOGLPLUS_DEBUG_GL_EXT_ERROR="+options.debug_gl_ext_error]
	if(options.debug_lib_error):
		cmake_options += ["-DOGLPLUS_DEBUG_LIB_ERROR=1"]

	# create the build directory if necessary
	if(not os.path.isdir(options.build_dir)):
		os.makedirs(options.build_dir)

	# compose the command line for calling cmake
	workdir = os.path.abspath(os.path.dirname(sys.argv[0]))
	cmake_cmd_line = ["cmake"] + cmake_options + options.cmake_options + [workdir]

	# call cmake
	try:
		ret = subprocess.call(
			cmake_cmd_line,
			cwd=options.build_dir,
			env=cmake_env
		)
		if ret < 0:
			print("# Configuration killed by signal %d" % -ret)
			sys.exit(-ret)
		elif ret > 0:
			print("# Configuration failed with code %d" % ret)
			sys.exit(ret)
	# handle errors
	except OSError as os_error:
		print( "# Configuration failed")
		print("# Failed to execute '%(cmd)s': %(error)s" % {
			"cmd": str(" ").join(cmake_cmd_line),
			"error": str(os_error)
		})
		sys.exit(3)

	# use the specified number of jobs
	if options.jobs is not None:
		job_count = options.jobs
	else:
		# else try to get the processor count (use below)
		try:
			import multiprocessing
			job_count = multiprocessing.cpu_count()+1
		except: job_count = None

	# print some info if not supressed
	if not options.quiet and not options.info_only:
		print("# Configuration completed successfully.")

		cmake_build_tool = cmake_info.get("CMAKE_BUILD_TOOL")
		if(cmake_build_tool):
			cmake_build_tool = shorten_command(cmake_build_tool)
			path_to_build_dir = shortest_path_from_to(os.getcwd(), options.build_dir)

			if(not options.build):
				if(cmake_build_tool == "make"):
					print("# To build OGLplus do the following:")
					print(str())
					print("cd "+ path_to_build_dir)
					if job_count:
						print("%(tool)s -j %(jobs)d" % {
							"tool": cmake_build_tool,
							"jobs": job_count
						})
					else: print(cmake_build_tool)
					print(cmake_build_tool + " install")

	# if the user requested build after config is done
	if options.build:
		cmake_build_tool = cmake_info.get("CMAKE_BUILD_TOOL")

		if cmake_build_tool:
			build_tool_name = os.path.basename(cmake_build_tool)
		else:
			build_tool_name = str()

		if build_tool_name in ("make",):
			build_cmd_line = [cmake_build_tool];
			if job_count:
				build_cmd_line += ["-j", str(job_count)]
		elif build_tool_name in ("devenv.com", "devenv.exe"):
			build_cmd_line = [
				cmake_build_tool,
				os.path.join(options.build_dir, "OGLplus.sln"),
				"/Build",
				"Release"
			]
		else: build_cmd_line = [ "cmake", "--build", options.build_dir ]

		if build_cmd_line:
			try: subprocess.call(
				build_cmd_line,
				cwd=options.build_dir,
				env=cmake_env
			)
			except OSError as os_error:
				print( "# Build failed")
				print("# Failed to execute '%(cmd)s': %(error)s" % {
					"cmd": str(" ").join(build_cmd_line),
					"error": str(os_error)
				})
				sys.exit(4)
		else: print("# --build is not supported with the current build tool")


	# print the configuration info if requested
	if options.info_only:
		try:
			info_py_path=os.path.join(options.build_dir, 'config', 'info.py')
			info_py=open(info_py_path).read()
			exec(info_py) in locals()

			key_descs = {
				"GL_INIT_LIBS": "Possible values for --gl-init-lib",
				"GL_API_LIBS": "Possible values for --gl-api-lib",
			}
			for key, value in oglplus_config_info.items():

				try: desc=key_descs[key]
				except: desc=key

				if type(value) == list:
					value = "\n\t".join(value)

				print("%(desc)s:\n\t%(value)s" % {"desc": desc, "value": value})
		except: pass

	# print additional info if not supressed
	elif not options.quiet:

		if not options.install_prefix:
			options.install_prefix = cmake_info.get("CMAKE_INSTALL_PREFIX")

		if(options.install_prefix):

			if not os.access(options.install_prefix, os.W_OK):
				print(str())
				print("# NOTE: installing to '%(prefix)s' "\
					"may require administrative privilegues" % {
						"prefix": options.install_prefix
					}
				)

# run the main function
if __name__ == "__main__": main(sys.argv[1:])