tools/updaterevision.py

#!/usr/bin/env python
# coding: utf-8
#
#	Copyright 2015 Teemu Piippo
#	All rights reserved.
#
#	Redistribution and use in source and binary forms, with or without
#	modification, are permitted provided that the following conditions
#	are met:
#
#	1. Redistributions of source code must retain the above copyright
#	   notice, this list of conditions and the following disclaimer.
#	2. Redistributions in binary form must reproduce the above copyright
#	   notice, this list of conditions and the following disclaimer in the
#	   documentation and/or other materials provided with the distribution.
#	3. Neither the name of the copyright holder nor the names of its
#	   contributors may be used to endorse or promote products derived from
#	   this software without specific prior written permission.
#
#	THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
#	"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
#	TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
#	PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER
#	OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
#	EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
#	PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
#	PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
#	LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT(INCLUDING
#	NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
#	SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#

import argparse
import outputfile

if __name__ == '__main__':
	import subprocess
	from datetime import datetime
	parser = argparse.ArgumentParser(description='Writes a header file with Hg commit information')
	parser.add_argument('--cwd', default = '.')
	parser.add_argument('output')
	args = parser.parse_args()
	data = subprocess.check_output(['hg', 'log', '--cwd', args.cwd, '-r.', '--template',
		'{node|short} {branch} {date|hgdate} {tags}']).decode().replace('\n', '').split()
	rev = data[0]
	branch = data[1]
	timestamp = int(data[2])
	all_tags = set(data[4:])
	try:
		version_tag = [tag for tag in all_tags if tag.startswith('v')][0]
	except IndexError:
		version_tag = None
	date = datetime.utcfromtimestamp(timestamp)
	datestring = date.strftime('%y%m%d-%H%M') if date.year >= 2000 else '000000-0000'
	if len(rev) > 7:
		rev = rev[:7]
	modified = subprocess.check_output(['hg', 'id', '--cwd', args.cwd, '-n']).decode().strip().endswith('+')
	if modified:
		rev += '+'
		# if the source tree is modified, it's not the released version
		version_tag = None
	if version_tag is not None:
		# tags should be the same in released versions whether or not it's tip
		# (though released versions shouldn't be tip because hgtags is modified
		# to create the tag 🤔, but let's do this anyway)
		all_tags -= {'tip'}
	with outputfile.OutputFile(args.output, verbose = True) as f:
		f.write(f'#define HG_NODE "{rev}"\n')
		if branch != 'default':
			f.write(f'#define HG_BRANCH "{branch}"\n')
		f.write(f'#define HG_DATE_VERSION "{datestring}"\n')
		f.write(f'#define HG_DATE_TIME {int(timestamp)}\n')
		if all_tags:
			f.write(f'#define HG_ALL_TAGS "{" ".join(sorted(all_tags))}"\n')
		if version_tag:
			f.write(f'#define HG_VERSION_TAG "{version_tag[1:]}"\n')
		if 'tip' in all_tags:
			f.write('#define HG_TIP\n')
	print(f'Current Hg revision: {rev}')