fxsdk/fxconv/fxconv-main.py

#! /usr/bin/env python3

import getopt
import sys
import os
import fxconv
import subprocess

# Note: this line is edited at compile time to insert the install folder
PREFIX="""\
""".strip()

help_string = f"""
usage: fxconv [-s] <python script> [files...]
       fxconv  -b  <bin file> -o <object file> [parameters...]
       fxconv  -i  <png file> -o <object file> (--fx|--cg) [parameters...]
       fxconv  -f  <png file> -o <object file> [parameters...]

fxconv converts data files such as images and fonts into gint formats
optimized for fast execution, or into object files.

Operating modes:
  -s, --script    Expose the fxconv module and run this Python script
  -b, --binary    Turn data into an object file, no conversion
  -i, --image     Convert to gint's bopti image format
  -f, --font      Convert to gint's topti font format
  --libimg-image  Convert to the libimg image format

When using -s, additional arguments are stored in the [fxconv.args] variable of
the module. This is intended to be a restricted list of file names specified by
a Makefile, used to convert only a subset of the files in the script.

The operating mode options are shortcuts to convert single files without a
script. They accept parameters with a "category.key:value" syntax, for example:
  fxconv -f myfont.png -o myfont.o charset:ascii grid.padding:1 height:7

When converting images, use --fx (black-and-white calculators) or --cg (16-bit
color calculators) to specify the target machine.

Install PREFIX is set to '{PREFIX}'.
""".strip()

# Simple error-warnings system
def err(msg):
	print("\x1b[31;1merror:\x1b[0m", msg, file=sys.stderr)
def warn(msg):
	print("\x1b[33;1mwarning:\x1b[0m", msg, file=sys.stderr)

# "converters" module from the user project
try:
	import converters
except ImportError:
	converters = None

def main():
	# Default execution mode is to run a Python script for conversion
	modes = "script binary image font bopti-image libimg-image"
	mode = "s"
	output = None
	model = None
	target = { 'toolchain': None, 'arch': None, 'section': None }
	use_custom = False

	# Parse command-line arguments

	if len(sys.argv) == 1:
		print(help_string, file=sys.stderr)
		sys.exit(1)

	try:
		longs = "help output= fx cg toolchain= arch= section= custom " + modes
		opts, args = getopt.gnu_getopt(sys.argv[1:], "hsbifo:", longs.split())
	except getopt.GetoptError as error:
		err(error)
		sys.exit(1)

	for name, value in opts:
		# Print usage
		if name == "--help":
			err(help_string, file=sys.stderr)
			sys.exit(0)
		# TODO: fxconv: verbose mode
		elif name == "--verbose":
			pass
		elif name in [ "-o", "--output" ]:
			output = value
		elif name in [ "--fx", "--cg" ]:
			model = name[2:]
		elif name == "--toolchain":
			target['toolchain'] = value
		elif name == "--arch":
			target['arch'] = value
		elif name == "--section":
			target['section'] = value
		elif name == "--custom":
			use_custom = True
			mode = "custom"
		# Other names are modes
		else:
			mode = name[1] if len(name)==2 else name[2:]

	# Remaining arguments
	if args == []:
		err(f"execution mode -{mode} expects an input file")
		sys.exit(1)
	input = args.pop(0)

	# In --script mode, run the Python script with an augmented PYTHONPATH

	if mode == "s":
		if output is not None:
			warn("option --output is ignored in script mode")

		if PREFIX == "":
			err("unknown or invalid install path x_x")
			sys.exit(1)

		env = os.environ.copy()
		if "PYTHONPATH" in env:
			env["PYTHONPATH"] += f":{PREFIX}/bin"
		else:
			env["PYTHONPATH"] = f"{PREFIX}/bin"

		p = subprocess.run([ sys.executable, input ], env=env)
		if p.returncode != 0:
			sys.exit(1)

	# In shortcut conversion modes, read parameters from the command-line

	else:
		def check(arg):
			if ':' not in arg:
				warn(f"argument {arg} is not a valid parameter (ignored)")
			return ':' in arg

		def insert(params, path, value):
			if len(path) == 1:
				params[path[0]] = value
				return
			if not path[0] in params:
				params[path[0]] = {}
			insert(params[path[0]], path[1:], value)

		args = [ arg.split(':', 1) for arg in args if check(arg) ]
		params = {}
		for (name, value) in args:
			insert(params, name.split("."), value)

		if "type" in params:
			pass
		elif(len(mode) == 1):
			params["type"] = { "b": "binary", "i": "image", "f": "font" }[mode]
		else:
			params["type"] = mode

		# Will be deprecated in the future
		if params["type"] == "image":
			warn("type 'image' is deprecated, use 'bopti-image' instead")
			params["type"] = "bopti-image"

		# Use the custom module
		custom = None
		if use_custom:
			if converters is None:
				err("--custom specified but no [converters] module in wd")
				sys.exit(1)
			custom = converters.convert

		try:
			fxconv.convert(input, params, target, output, model, custom)
		except fxconv.FxconvError as e:
			err(e)
			sys.exit(1)

if __name__ == "__main__":
	main()