Merge pull request #523 from boriel/feature/use-config-file

Refactorize Options container.

Author: boriel

src/api/config.py

@@ -18,17 +18,25 @@
 # The options container
 from . import options
 from . import global_
-from .options import ANYTYPE
+
+from .options import ANYTYPE, Actions
 
 
 # ------------------------------------------------------
 # Common setup and configuration for all tools
 # ------------------------------------------------------
+class ConfigSections:
+    ZXBC = 'zxbc'
+    ZXBASM = 'zxbasm'
+    ZXBPP = 'zxbpp'
+
+
 class OPTION:
     OUTPUT_FILENAME = 'output_filename'
     INPUT_FILENAME = 'input_filename'
     STDERR_FILENAME = 'stderr_filename'
     DEBUG = 'debug_level'
+    PROJECT_FILENAME = 'project_filename'
 
     # File IO
     STDIN = 'stdin'
@@ -70,6 +78,10 @@ class OPTION:
 
 
 OPTIONS = options.Options()
+OPTIONS_NOT_SAVED = {
+    OPTION.STDERR, OPTION.STDIN, OPTION.STDOUT, 'sinclair', OPTION.INPUT_FILENAME, OPTION.OUTPUT_FILENAME,
+    OPTION.PROJECT_FILENAME, 'heap_start_label', 'heap_size_label'
+}
 
 
 def load_config_from_file(filename: str, section: str, options_: options.Options = None, stop_on_error=True) -> bool:
@@ -107,7 +119,7 @@ def load_config_from_file(filename: str, section: str, options_: options.Options
     }
 
     for opt in cfg.options(section):
-        options_[opt].value = parsing.get(options_[opt].type, cfg.get)(option=opt)
+        options_[opt].value = parsing.get(options_[opt].type, cfg.get)(section=section, option=opt)
 
     return True
 
@@ -131,8 +143,8 @@ def save_config_into_file(filename: str, section: str, options_: options.Options
             return False
 
     cfg[section] = {}
-    for opt_name, opt in options.Options.get_options(options_):
-        if opt_name.startswith('__') or opt.value is None or opt_name in ('stderr', 'stdin', 'stdout'):
+    for opt_name, opt in options_().items():
+        if opt_name.startswith('__') or opt.value is None or opt_name in OPTIONS_NOT_SAVED:
             continue
 
         if opt.type == bool:
@@ -164,48 +176,53 @@ def init():
     param_byref --Default parameter passing. TRUE => By Reference
     """
 
-    OPTIONS.reset()
+    OPTIONS(Actions.CLEAR)
 
-    OPTIONS.add_option(OPTION.OUTPUT_FILENAME, str)
-    OPTIONS.add_option(OPTION.INPUT_FILENAME, str)
-    OPTIONS.add_option(OPTION.STDERR_FILENAME, str)
-    OPTIONS.add_option(OPTION.DEBUG, int, 0)
+    OPTIONS(Actions.ADD, name=OPTION.OUTPUT_FILENAME, type=str)
+    OPTIONS(Actions.ADD, name=OPTION.INPUT_FILENAME, type=str)
+    OPTIONS(Actions.ADD, name=OPTION.STDERR_FILENAME, type=str)
+    OPTIONS(Actions.ADD, name=OPTION.DEBUG, type=int, default=0)
 
     # Default console redirections
-    OPTIONS.add_option(OPTION.STDIN, ANYTYPE, sys.stdin)
-    OPTIONS.add_option(OPTION.STDOUT, ANYTYPE, sys.stdout)
-    OPTIONS.add_option(OPTION.STDERR, ANYTYPE, sys.stderr)
-
-    OPTIONS.add_option(OPTION.O_LEVEL, int, global_.DEFAULT_OPTIMIZATION_LEVEL)
-    OPTIONS.add_option(OPTION.CASE_INS, bool, False)
-    OPTIONS.add_option(OPTION.ARRAY_BASE, int, 0)
-    OPTIONS.add_option(OPTION.DEFAULT_BYREF, bool, False)
-    OPTIONS.add_option(OPTION.MAX_SYN_ERRORS, int, global_.DEFAULT_MAX_SYNTAX_ERRORS)
-    OPTIONS.add_option(OPTION.STR_BASE, int, 0)
-    OPTIONS.add_option(OPTION.MEMORY_MAP, str, None)
-    OPTIONS.add_option(OPTION.FORCE_ASM_BRACKET, bool, False)
-
-    OPTIONS.add_option(OPTION.USE_BASIC_LOADER, bool, False)  # Whether to use a loader
-    OPTIONS.add_option(OPTION.AUTORUN, bool, False)  # Whether to add autostart code (needs basic loader = true)
-    OPTIONS.add_option(OPTION.OUTPUT_FILE_TYPE, str, 'bin')  # bin, tap, tzx etc...
-    OPTIONS.add_option(OPTION.INCLUDE_PATH, str, '')  # Include path, like '/var/lib:/var/include'
-
-    OPTIONS.add_option(OPTION.CHECK_MEMORY, bool, False)
-    OPTIONS.add_option(OPTION.STRICT_BOOL, bool, False)
-    OPTIONS.add_option(OPTION.CHECK_ARRAYS, bool, False)
-
-    OPTIONS.add_option(OPTION.ENABLE_BREAK, bool, False)
-    OPTIONS.add_option(OPTION.EMIT_BACKEND, bool, False)
-    OPTIONS.add_option('__DEFINES', dict, {})
-    OPTIONS.add_option(OPTION.EXPLICIT, bool, False)
-    OPTIONS.add_option('Sinclair', bool, False)
-    OPTIONS.add_option(OPTION.STRICT, bool, False)  # True to force type checking
-    OPTIONS.add_option(OPTION.ASM_ZXNEXT, bool, False)  # True to enable ZX Next ASM opcodes
-    OPTIONS.add_option(OPTION.ARCH, str, None)  # Architecture
-    OPTIONS.add_option(OPTION.EXPECTED_WARNINGS, int, 0)  # Expected Warnings that will be silenced
-    OPTIONS.add_option(OPTION.HIDE_WARNING_CODES, bool, False)  # Whether to show WXXX warning codes or not
-
-    save_config_into_file('project.ini', 'zxbc', stop_on_error=True)
+    OPTIONS(Actions.ADD, name=OPTION.STDIN, type=ANYTYPE, default=sys.stdin)
+    OPTIONS(Actions.ADD, name=OPTION.STDOUT, type=ANYTYPE, default=sys.stdout)
+    OPTIONS(Actions.ADD, name=OPTION.STDERR, type=ANYTYPE, default=sys.stderr)
+
+    OPTIONS(Actions.ADD, name=OPTION.O_LEVEL, type=int, default=global_.DEFAULT_OPTIMIZATION_LEVEL)
+    OPTIONS(Actions.ADD, name=OPTION.CASE_INS, type=bool, default=False)
+    OPTIONS(Actions.ADD, name=OPTION.ARRAY_BASE, type=int, default=0)
+    OPTIONS(Actions.ADD, name=OPTION.DEFAULT_BYREF, type=bool, default=False)
+    OPTIONS(Actions.ADD, name=OPTION.MAX_SYN_ERRORS, type=int, default=global_.DEFAULT_MAX_SYNTAX_ERRORS)
+    OPTIONS(Actions.ADD, name=OPTION.STR_BASE, type=int, default=0)
+    OPTIONS(Actions.ADD, name=OPTION.MEMORY_MAP, type=str, default=None)
+    OPTIONS(Actions.ADD, name=OPTION.FORCE_ASM_BRACKET, type=bool, default=False)
+
+    OPTIONS(Actions.ADD, name=OPTION.USE_BASIC_LOADER, type=bool, default=False)  # Whether to use a loader
+
+    # Whether to add autostart code (needs basic loader = true)
+    OPTIONS(Actions.ADD, name=OPTION.AUTORUN, type=bool, default=False)
+    OPTIONS(Actions.ADD, name=OPTION.OUTPUT_FILE_TYPE, type=str, default='bin')  # bin, tap, tzx etc...
+    OPTIONS(Actions.ADD, name=OPTION.INCLUDE_PATH, type=str, default='')  # Include path, like '/var/lib:/var/include'
+
+    OPTIONS(Actions.ADD, name=OPTION.CHECK_MEMORY, type=bool, default=False)
+    OPTIONS(Actions.ADD, name=OPTION.STRICT_BOOL, type=bool, default=False)
+    OPTIONS(Actions.ADD, name=OPTION.CHECK_ARRAYS, type=bool, default=False)
+
+    OPTIONS(Actions.ADD, name=OPTION.ENABLE_BREAK, type=bool, default=False)
+    OPTIONS(Actions.ADD, name=OPTION.EMIT_BACKEND, type=bool, default=False)
+    OPTIONS(Actions.ADD, name='__DEFINES', type=dict, default={})
+    OPTIONS(Actions.ADD, name=OPTION.EXPLICIT, type=bool, default=False)
+    OPTIONS(Actions.ADD, name='sinclair', type=bool, default=False)
+    OPTIONS(Actions.ADD, name=OPTION.STRICT, type=bool, default=False)  # True to force type checking
+    OPTIONS(Actions.ADD, name=OPTION.ASM_ZXNEXT, type=bool, default=False)  # True to enable ZX Next ASM opcodes
+    OPTIONS(Actions.ADD, name=OPTION.ARCH, type=str, default=None)  # Architecture
+    OPTIONS(Actions.ADD, name=OPTION.EXPECTED_WARNINGS, type=int, default=0)  # Expected Warnings that will be silenced
+
+    # Whether to show WXXX warning codes or not
+    OPTIONS(Actions.ADD, name=OPTION.HIDE_WARNING_CODES, type=bool, default=False)
+
+    OPTIONS(Actions.ADD, name=OPTION.PROJECT_FILENAME, type=str, default=os.path.join(os.path.abspath(os.path.curdir),
+                                                                                      'project.ini'))
 
 
 init()

src/api/options.py

@@ -14,11 +14,10 @@
 from typing import Dict
 from typing import List
 from typing import Any
-from typing import Tuple
 
 from .errors import Error
 
-__all__ = ['Option', 'Options', 'ANYTYPE']
+__all__ = ['Option', 'Options', 'ANYTYPE', 'Actions']
 
 
 class ANYTYPE:
@@ -31,7 +30,6 @@ class ANYTYPE:
 # Exception for duplicated Options
 # ----------------------------------------------------------------------
 
-
 class DuplicatedOptionError(Error):
     def __init__(self, option_name):
         self.option = option_name
@@ -75,6 +73,24 @@ def __str__(self):
         return "Invalid value for config initialization"
 
 
+class InvalidActionParameterError(Error):
+    def __init__(self, action, invalid_parameter):
+        self.invalid_parameter = invalid_parameter
+        self.action = action
+
+    def __str__(self):
+        return f"Action '{self.action}' does not accept parameter '{self.invalid_parameter}'"
+
+
+class InvalidActionMissingParameterError(Error):
+    def __init__(self, action, missing_parameter):
+        self.missing_parameter = missing_parameter
+        self.action = action
+
+    def __str__(self):
+        return f"Action '{self.action}' requires parameter '{self.missing_parameter}'"
+
+
 # ----------------------------------------------------------------------
 # This class interfaces an Options Container
 # ----------------------------------------------------------------------
@@ -137,6 +153,18 @@ def pop(self) -> Any:
         return result
 
 
+# ----------------------------------------------------------------------
+# Options commands
+# ----------------------------------------------------------------------
+class Actions:
+    ADD = 'add'
+    ADD_IF_NOT_DEFINED = 'add_if_not_defined'
+    CLEAR = 'clear'
+    LIST = 'list'
+
+    allowed = {ADD, CLEAR, LIST, ADD_IF_NOT_DEFINED}
+
+
 # ----------------------------------------------------------------------
 # This class interfaces an Options Container
 # ----------------------------------------------------------------------
@@ -154,24 +182,21 @@ def __init__(self, init_value=None):
             else:
                 raise InvalidConfigInitialization(invalid_value=init_value)
 
-    def reset(self):
-        self._options.clear()
-
-    def add_option(self, name, type_=None, default_value=None):
+    def __add_option(self, name, type_=None, default=None):
         if name in self._options:
             raise DuplicatedOptionError(name)
 
-        if type_ is None and default_value is not None:
-            type_ = type(default_value)
+        if type_ is None and default is not None:
+            type_ = type(default)
         elif type_ is ANYTYPE:
             type_ = None
 
-        self._options[name] = Option(name, type_, default_value)
+        self._options[name] = Option(name, type_, default)
 
-    def add_option_if_not_defined(self, name, type_=None, default_value=None):
+    def __add_option_if_not_defined(self, name, type_=None, default=None):
         if name in self._options:
             return
-        self.add_option(name, type_, default_value)
+        self.__add_option(name, type_, default)
 
     def __delattr__(self, item: str):
         del self[item]
@@ -207,8 +232,51 @@ def __setitem__(self, key: str, value: Any):
     def __contains__(self, item: str):
         return item in self._options
 
-    @classmethod
-    def get_options(cls, instance: 'Options') -> List[Tuple[str, Option]]:
-        """ Iterate over all options of the given instance
+    def __call__(self, *args, **kwargs):
+        """ Multipurpose function.
+         - With no parameters, returns a dictionary {'option' -> value}
+         - With a command:
+           'add', name='xxxx', type_=None, default_value=None <= Creates the option 'xxxx', if_not_defined=False
+           'reset', clears the container
         """
-        return list(instance._options.items())
+        def check_allowed_args(action: str, kwargs_, allowed_args, required_args=None):
+            for option in kwargs_.keys():
+                if option not in allowed_args:
+                    raise InvalidActionParameterError(action, option)
+
+            for required_option in required_args or []:
+                if required_option not in kwargs_:
+                    raise InvalidActionMissingParameterError(action, required_option)
+
+        # With no parameters
+        if not kwargs:
+            if not args or args == (Actions.LIST, ):
+                return {x: y for x, y in self._options.items()}
+
+        assert args, f"Missing one action of {', '.join(Actions.allowed)}"
+        assert len(args) == 1 and args[0] in Actions.allowed, \
+            f"Only one action of {', '.join(Actions.allowed)} can be specified"
+
+        # clear
+        if args[0] == Actions.CLEAR:
+            check_allowed_args(Actions.CLEAR, kwargs, {})
+            self._options.clear()
+            return
+
+        # list
+        if args[0] == Actions.LIST:
+            check_allowed_args(Actions.LIST, kwargs, {'options'})
+            options = set(kwargs['options'])
+            return {x: y for x, y in self._options.items() if x in options}
+
+        if args[0] == Actions.ADD:
+            kwargs['type'] = kwargs.get('type')
+            kwargs['default'] = kwargs.get('default')
+            check_allowed_args(Actions.ADD, kwargs, {'name', 'type', 'default'}, ['name'])
+            self.__add_option(kwargs['name'], kwargs['type'], kwargs['default'])
+
+        if args[0] == Actions.ADD_IF_NOT_DEFINED:
+            kwargs['type'] = kwargs.get('type')
+            kwargs['default'] = kwargs.get('default')
+            check_allowed_args(Actions.ADD, kwargs, {'name', 'type', 'default'}, ['name'])
+            self.__add_option_if_not_defined(kwargs['name'], kwargs['type'], kwargs['default'])

src/arch/zx48k/backend/__init__.py

@@ -95,7 +95,7 @@
 # External functions
 from ..optimizer.helpers import HI16, LO16
 from src.arch.zx48k.optimizer.asm import Asm
-from src.api.config import OPTIONS
+from src.api.config import OPTIONS, Actions
 from src.arch.zx48k.peephole import engine
 
 import src.api.fp
@@ -134,10 +134,10 @@
 FLAG_end_emitted = False
 
 # Default code ORG
-OPTIONS.add_option_if_not_defined('org', int, 32768)
+OPTIONS(Actions.ADD_IF_NOT_DEFINED, name='org', type=int, default=32768)
 
 # Default HEAP SIZE (Dynamic memory) in bytes
-OPTIONS.add_option_if_not_defined('heap_size', int, 4768)  # A bit more than 4K
+OPTIONS(Actions.ADD_IF_NOT_DEFINED, name='heap_size', type=int, default=4768)  # A bit more than 4K
 
 # List of modules (in alphabetical order) that, if included, should call MEM_INIT
 MEMINITS = {
@@ -196,15 +196,15 @@ def init():
     FLAG_end_emitted = False
 
     # Default code ORG
-    OPTIONS.add_option('org', int, 32768)
+    OPTIONS(Actions.ADD, name='org', type=int, default=32768)
     # Default HEAP SIZE (Dynamic memory) in bytes
-    OPTIONS.add_option('heap_size', int, 4768)  # A bit more than 4K
+    OPTIONS(Actions.ADD, name='heap_size', type=int, default=4768)  # A bit more than 4K
     # Labels for HEAP START (might not be used if not needed)
-    OPTIONS.add_option('heap_start_label', str, f'{NAMESPACE}.ZXBASIC_MEM_HEAP')
+    OPTIONS(Actions.ADD, name='heap_start_label', type=str, default=f'{NAMESPACE}.ZXBASIC_MEM_HEAP')
     # Labels for HEAP SIZE (might not be used if not needed)
-    OPTIONS.add_option('heap_size_label', str, f'{NAMESPACE}.ZXBASIC_HEAP_SIZE')
+    OPTIONS(Actions.ADD, name='heap_size_label', type=str, default=f'{NAMESPACE}.ZXBASIC_HEAP_SIZE')
     # Flag for headerless mode (No prologue / epilogue)
-    OPTIONS.add_option('headerless', bool, False)
+    OPTIONS(Actions.ADD, name='headerless', type=bool, default=False)
 
     engine.main()  # inits the optimizer
 

src/zxbc/args_parser.py

@@ -98,4 +98,7 @@ def parser() -> argparse.ArgumentParser:
                          help='Disables warning WXXX (i.e. -W100 disables warning with code W100)')
     parser_.add_argument('--hide-warning-codes', action='store_true',
                          help='Hides WXXX codes')
+    parser_.add_argument('-F', '--config-file', type=str, default=OPTIONS.project_filename,
+                         help="Loads config from config file")
+    parser_.add_argument('--save-config', type=str, help="Save options into a config file")
     return parser_

src/zxbc/zxbc.py

@@ -87,6 +87,10 @@ def main(args=None, emitter=None):
     parser = args_parser.parser()
     options = parser.parse_args(args=args)
 
+    if os.path.isfile(options.config_file):
+        if src.api.config.load_config_from_file(options.config_file, src.api.config.ConfigSections.ZXBC):
+            src.api.errmsg.info(f"Config file {options.config_file} loaded")
+
     # ------------------------------------------------------------
     # Setting of internal parameters according to command line
     # ------------------------------------------------------------
@@ -96,10 +100,10 @@ def main(args=None, emitter=None):
     OPTIONS.stderr_filename = options.stderr
     OPTIONS.array_base = options.array_base
     OPTIONS.string_base = options.string_base
-    OPTIONS.Sinclair = options.sinclair
+    OPTIONS.sinclair = options.sinclair
     OPTIONS.heap_size = options.heap_size
     OPTIONS.memory_check = options.debug_memory
-    OPTIONS.strict_bool = options.strict_bool or OPTIONS.Sinclair
+    OPTIONS.strict_bool = options.strict_bool or OPTIONS.sinclair
     OPTIONS.array_check = options.debug_array
     OPTIONS.emit_backend = options.emit_backend
     OPTIONS.enable_break = options.enable_break
@@ -149,7 +153,7 @@ def main(args=None, emitter=None):
             OPTIONS.__DEFINES[name] = val
             zxbpp.ID_TABLE.define(name, value=val, lineno=0)
 
-    if OPTIONS.Sinclair:
+    if OPTIONS.sinclair:
         OPTIONS.array_base = 1
         OPTIONS.string_base = 1
         OPTIONS.strictBool = True
@@ -334,6 +338,9 @@ def main(args=None, emitter=None):
             with open_file(OPTIONS.memory_map, 'wt', 'utf-8') as f:
                 f.write(asmparse.MEMORY.memory_map)
 
+    if not gl.has_errors and options.save_config:
+        src.api.config.save_config_into_file(options.save_config, src.api.config.ConfigSections.ZXBC)
+
     return gl.has_errors  # Exit success