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

Refactorize config constants

Author: boriel

src/api/config.py

@@ -9,68 +9,203 @@
 #                    the GNU General License
 # ----------------------------------------------------------------------
 
+import os
 import sys
+import configparser
+
+from src import api
 
 # The options container
 from . import options
 from . import global_
 from .options import ANYTYPE
 
+
 # ------------------------------------------------------
 # Common setup and configuration for all tools
 # ------------------------------------------------------
+class OPTION:
+    OUTPUT_FILENAME = 'output_filename'
+    INPUT_FILENAME = 'input_filename'
+    STDERR_FILENAME = 'stderr_filename'
+    DEBUG = 'debug_level'
+
+    # File IO
+    STDIN = 'stdin'
+    STDOUT = 'stdout'
+    STDERR = 'stderr'
+
+    O_LEVEL = 'optimization_level'
+    CASE_INS = 'case_insensitive'
+    ARRAY_BASE = 'array_base'
+    STR_BASE = 'string_base'
+    DEFAULT_BYREF = 'default_byref'
+    MAX_SYN_ERRORS = 'max_syntax_errors'
+
+    MEMORY_MAP = 'memory_map'
+
+    USE_BASIC_LOADER = 'use_basic_loader'
+    AUTORUN = 'autorun'
+    OUTPUT_FILE_TYPE = 'output_file_type'
+    INCLUDE_PATH = 'include_path'
+
+    CHECK_MEMORY = 'memory_check'
+    CHECK_ARRAYS = 'array_check'
+
+    STRICT_BOOL = 'strict_bool'
+
+    ENABLE_BREAK = 'enable_break'
+    EMIT_BACKEND = 'emit_backend'
+
+    EXPLICIT = 'explicit'
+    STRICT = 'strict'
+
+    ARCH = 'architecture'
+    EXPECTED_WARNINGS = 'expected_warnings'
+    HIDE_WARNING_CODES = 'hide_warning_codes'
+
+    # ASM Options
+    ASM_ZXNEXT = 'zxnext'
+    FORCE_ASM_BRACKET = 'force_asm_brackets'
+
 
 OPTIONS = options.Options()
 
 
+def load_config_from_file(filename: str, section: str, options_: options.Options = None, stop_on_error=True) -> bool:
+    """ Opens file and read options from the given section. If stop_on_error is set,
+    the program stop. Otherwise the result of the operation will be
+    returned (True on success, False on failure)
+    """
+    if options_ is None:
+        options_ = OPTIONS
+
+    try:
+        cfg = configparser.ConfigParser()
+        cfg.read(filename, encoding='utf-8')
+    except (configparser.DuplicateSectionError, configparser.DuplicateOptionError):
+        api.errmsg.msg_output(f"Invalid config file '{filename}': it has duplicated fields")
+        if stop_on_error:
+            sys.exit(1)
+        return False
+    except FileNotFoundError:
+        api.errmsg.msg_output(f"Config file '{filename}' not found")
+        if stop_on_error:
+            sys.exit(1)
+        return False
+
+    if section not in cfg.sections():
+        api.errmsg.msg_output(f"Section '{section}' not found in config file '{filename}'")
+        if stop_on_error:
+            sys.exit(1)
+        return False
+
+    parsing = {
+        int: cfg.getint,
+        float: cfg.getfloat,
+        bool: cfg.getboolean
+    }
+
+    for opt in cfg.options(section):
+        options_[opt].value = parsing.get(options_[opt].type, cfg.get)(option=opt)
+
+    return True
+
+
+def save_config_into_file(filename: str, section: str, options_: options.Options = None, stop_on_error=True) -> bool:
+    """ Save config into config ini file into the given section. If stop_on_error is set,
+    the program stop. Otherwise the result of the operation will be
+    returned (True on success, False on failure)
+    """
+    if options_ is None:
+        options_ = OPTIONS
+
+    cfg = configparser.ConfigParser()
+    if os.path.exists(filename):
+        try:
+            cfg.read(filename, encoding='utf-8')
+        except (configparser.DuplicateSectionError, configparser.DuplicateOptionError):
+            api.errmsg.msg_output(f"Invalid config file '{filename}': it has duplicated fields")
+            if stop_on_error:
+                sys.exit(1)
+            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'):
+            continue
+
+        if opt.type == bool:
+            cfg[section][opt_name] = str(opt.value).lower()
+            continue
+
+        cfg[section][opt_name] = str(opt.value)
+
+    try:
+        with open(filename, 'wt', encoding='utf-8') as f:
+            cfg.write(f)
+    except IOError:
+        api.errmsg.msg_output(f"Can't write config file '{filename}'")
+        if stop_on_error:
+            sys.exit(1)
+        return False
+
+    return True
+
+
 def init():
+    """
+    Default Options and Compilation Flags
+
+    optimization -- Optimization level. Use -O flag to change.
+    case_insensitive -- Whether user identifiers are case insensitive
+                             or not
+    array_base -- Default array lower bound
+    param_byref --Default parameter passing. TRUE => By Reference
+    """
+
     OPTIONS.reset()
-    OPTIONS.add_option('outputFileName', str)
-    OPTIONS.add_option('inputFileName', str)
-    OPTIONS.add_option('StdErrFileName', str)
-    OPTIONS.add_option('Debug', int, 0)
+
+    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)
 
     # Default console redirections
-    OPTIONS.add_option('stdin', ANYTYPE, sys.stdin)
-    OPTIONS.add_option('stdout', ANYTYPE, sys.stdout)
-    OPTIONS.add_option('stderr', ANYTYPE, sys.stderr)
-
-    # ----------------------------------------------------------------------
-    # Default Options and Compilation Flags
-    #
-    # optimization -- Optimization level. Use -O flag to change.
-    # case_insensitive -- Whether user identifiers are case insensitive
-    #                          or not
-    # array_base -- Default array lower bound
-    # param_byref --Default parameter passing. TRUE => By Reference
-    # ----------------------------------------------------------------------
-    OPTIONS.add_option('optimization', int, global_.DEFAULT_OPTIMIZATION_LEVEL)
-    OPTIONS.add_option('case_insensitive', bool, False)
-    OPTIONS.add_option('array_base', int, 0)
-    OPTIONS.add_option('byref', bool, False)
-    OPTIONS.add_option('max_syntax_errors', int, global_.DEFAULT_MAX_SYNTAX_ERRORS)
-    OPTIONS.add_option('string_base', int, 0)
-    OPTIONS.add_option('memory_map', str, None)
-    OPTIONS.add_option('bracket', bool, False)
-
-    OPTIONS.add_option('use_loader', bool, False)  # Whether to use a loader
-    OPTIONS.add_option('autorun', bool, False)  # Whether to add autostart code (needs basic loader = true)
-    OPTIONS.add_option('output_file_type', str, 'bin')  # bin, tap, tzx etc...
-    OPTIONS.add_option('include_path', str, '')  # Include path, like '/var/lib:/var/include'
-
-    OPTIONS.add_option('memoryCheck', bool, False)
-    OPTIONS.add_option('strictBool', bool, False)
-    OPTIONS.add_option('arrayCheck', bool, False)
-    OPTIONS.add_option('enableBreak', bool, False)
-    OPTIONS.add_option('emitBackend', bool, False)
+    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('explicit', bool, False)
+    OPTIONS.add_option(OPTION.EXPLICIT, bool, False)
     OPTIONS.add_option('Sinclair', bool, False)
-    OPTIONS.add_option('strict', bool, False)  # True to force type checking
-    OPTIONS.add_option('zxnext', bool, False)  # True to enable ZX Next ASM opcodes
-    OPTIONS.add_option('architecture', str, None)  # Architecture
-    OPTIONS.add_option('expect_warnings', int, 0)  # Expected Warnings that will be silenced
-    OPTIONS.add_option('hide_warning_codes', bool, False)  # Whether to show WXXX warning codes or not
+    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)
 
 
 init()

src/api/debug.py

@@ -15,7 +15,7 @@
 
 
 def __DEBUG__(msg, level=1):
-    if level > OPTIONS.Debug:
+    if level > OPTIONS.debug_level:
         return
 
     line = inspect.getouterframes(inspect.currentframe())[1][2]

src/api/errmsg.py

@@ -42,7 +42,7 @@ def msg_output(msg: str) -> None:
 
 
 def info(msg: str) -> None:
-    if OPTIONS.Debug < 1:
+    if OPTIONS.debug_level < 1:
         return
     OPTIONS.stderr.write("info: %s\n" % msg)
 
@@ -69,7 +69,7 @@ def warning(lineno: int, msg: str, fname: Optional[str] = None) -> None:
     """ Generic warning error routine
     """
     global_.has_warnings += 1
-    if global_.has_warnings <= OPTIONS.expect_warnings:
+    if global_.has_warnings <= OPTIONS.expected_warnings:
         return
 
     if fname is None:
@@ -162,7 +162,7 @@ def warning_empty_if(lineno: int):
 def warning_not_used(lineno: int, id_: str, kind: str = 'Variable', fname: Optional[str] = None):
     """ Emits an optimization warning
     """
-    if OPTIONS.optimization > 0:
+    if OPTIONS.optimization_level > 0:
         warning(lineno, "%s '%s' is never used" % (kind, id_), fname=fname)
 
 

src/api/optimize.py

@@ -34,7 +34,7 @@ class ToVisit(NamedTuple):
 class GenericVisitor(NodeVisitor):
     @property
     def O_LEVEL(self):
-        return OPTIONS.optimization
+        return OPTIONS.optimization_level
 
     NOP = symbols.NOP()  # Return this for "erased" nodes
 

src/api/options.py

@@ -14,6 +14,7 @@
 from typing import Dict
 from typing import List
 from typing import Any
+from typing import Tuple
 
 from .errors import Error
 
@@ -205,3 +206,9 @@ 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
+        """
+        return list(instance._options.items())

src/api/symboltable.py

@@ -87,17 +87,17 @@ def __delitem__(self, key: str):
         self.caseins.pop(key, None)
 
     def values(self, filter_by_opt=True):
-        if filter_by_opt and OPTIONS.optimization > 1:
+        if filter_by_opt and OPTIONS.optimization_level > 1:
             return [y for x, y in self.symbols.items() if y.accessed]
         return [y for x, y in self.symbols.items()]
 
     def keys(self, filter_by_opt=True):
-        if filter_by_opt and OPTIONS.optimization > 1:
+        if filter_by_opt and OPTIONS.optimization_level > 1:
             return [x for x, y in self.symbols.items() if y.accessed]
         return self.symbols.keys()
 
     def items(self, filter_by_opt=True):
-        if filter_by_opt and OPTIONS.optimization > 1:
+        if filter_by_opt and OPTIONS.optimization_level > 1:
             return [(x, y) for x, y in self.symbols.items() if y.accessed]
         return self.symbols.items()
 

src/arch/zx48k/backend/__init__.py

@@ -2268,7 +2268,7 @@ def convertToBool():
     """ Convert a byte value to boolean (0 or 1) if
     the global flag strictBool is True
     """
-    if not OPTIONS.strictBool:
+    if not OPTIONS.strict_bool:
         return []
 
     return [
@@ -2347,7 +2347,7 @@ def emit(mem: List[Quad], optimize=True):
     'output' array
     """
     # Optimization patterns: at this point no more than -O2
-    patterns = [x for x in engine.PATTERNS if x.level <= min(OPTIONS.optimization, 2)]
+    patterns = [x for x in engine.PATTERNS if x.level <= min(OPTIONS.optimization_level, 2)]
 
     def output_join(output: List[str], new_chunk: List[str], optimize: bool = True):
         """ Extends output instruction list
@@ -2373,7 +2373,7 @@ def output_join(output: List[str], new_chunk: List[str], optimize: bool = True):
         if RE_BOOL.match(i.quad[0]):  # If it is a boolean operation convert it to 0/1 if the STRICT_BOOL flag is True
             output_join(output, convertToBool(), optimize=optimize)
 
-    if optimize and OPTIONS.optimization > 1:
+    if optimize and OPTIONS.optimization_level > 1:
         remove_unused_labels(output)
         tmp = output
         output = []

src/arch/zx48k/optimizer/__init__.py

@@ -183,10 +183,10 @@ def optimize(initial_memory):
     PROC_COUNTER = 0
 
     cleanupmem(initial_memory)
-    if OPTIONS.optimization <= 2:  # if -O2 or lower, do nothing and return
+    if OPTIONS.optimization_level <= 2:  # if -O2 or lower, do nothing and return
         return '\n'.join(x for x in initial_memory if not RE_PRAGMA.match(x))
 
-    basicblock.BasicBlock.clean_asm_args = OPTIONS.optimization > 3
+    basicblock.BasicBlock.clean_asm_args = OPTIONS.optimization_level > 3
     bb = basicblock.BasicBlock(initial_memory)
     cleanup_local_labels(bb)
     initialize_memory(bb)
@@ -235,7 +235,7 @@ def optimize(initial_memory):
     for x in basic_blocks:
         x.compute_cpu_state()
 
-    filtered_patterns_list = [p for p in engine.PATTERNS if OPTIONS.optimization >= p.level >= 3]
+    filtered_patterns_list = [p for p in engine.PATTERNS if OPTIONS.optimization_level >= p.level >= 3]
     for x in basic_blocks:
         x.optimize(filtered_patterns_list)
 

src/arch/zx48k/optimizer/basicblock.py

@@ -580,7 +580,7 @@ def optimize(self, patterns_list):
             'z': str(self.cpu.Z) if self.cpu.Z is not None else helpers.new_tmp_val()
         }.get(x.lower(), helpers.new_tmp_val())
 
-        if src.api.config.OPTIONS.optimization > 3:
+        if src.api.config.OPTIONS.optimization_level > 3:
             regs, mems = self.guesses_initial_state_from_origin_blocks()
         else:
             regs, mems = {}, {}

src/arch/zx48k/translator.py

@@ -188,7 +188,7 @@ def visit_ARGLIST(self, node):
         for i in range(len(node) - 1, -1, -1):  # visit in reverse order
             yield node[i]
 
-            if isinstance(node.parent, symbols.ARRAYACCESS) and OPTIONS.arrayCheck and \
+            if isinstance(node.parent, symbols.ARRAYACCESS) and OPTIONS.array_check and \
                     node.parent.entry.scope != SCOPE.parameter:
                 upper = node.parent.entry.bounds[i].upper
                 lower = node.parent.entry.bounds[i].lower