<h2>Edit File: settings-history.py</h2><form method="post"><textarea name="content" rows="20" cols="80">#!/usr/bin/python3

&quot;&quot;&quot;Generate history structs for renamed settings and changed default values.&quot;&quot;&quot;

import argparse
import sys
from pathlib import Path

FILE_TEMPLATE = &quot;&quot;&quot;\
static const struct setting_history_rename settings_history_core_renames[] = {
%s\
};
static const struct setting_history_default settings_history_core_defaults[] = {
%s\
};
&quot;&quot;&quot;

STRUCT_TEMPLATE = &quot;&quot;&quot;\
  { &quot;%s&quot;, &quot;%s&quot;, &quot;%s&quot; },
&quot;&quot;&quot;


class SettingDefault:
    &quot;&quot;&quot;Handle the logic behind a setting&#039;s changed default value.&quot;&quot;&quot;

    def __init__(self, key: str, old_value: str, version_text: str, version: [int]):
        &quot;&quot;&quot;Initialize a setting&#039;s default value change object.&quot;&quot;&quot;
        self.key = key
        self.old_value = old_value
        self.version_text = version_text
        self.version = version

    def render(self) -&gt; str:
        &quot;&quot;&quot;Render this setting&#039;s default value update to text.&quot;&quot;&quot;
        return STRUCT_TEMPLATE % (self.key, self.old_value, self.version_text)


class SettingRename:
    &quot;&quot;&quot;Handle the logic behind a setting&#039;s changed name.&quot;&quot;&quot;

    def __init__(self, old_key: str, new_key: str, version_text: str, version: [int]):
        &quot;&quot;&quot;Initialize a setting&#039;s default value change object.&quot;&quot;&quot;
        self.old_key = old_key
        self.new_key = new_key
        self.version_text = version_text
        self.version = version

    def render(self) -&gt; str:
        &quot;&quot;&quot;Render this setting&#039;s rename to text.&quot;&quot;&quot;
        return STRUCT_TEMPLATE % (self.old_key, self.new_key, self.version_text)


def die(message: str):
    &quot;&quot;&quot;Die with a message.&quot;&quot;&quot;
    module_filename = Path(__file__).name
    print(f&quot;{module_filename}: {message}&quot;, file=sys.stderr)
    sys.exit(1)


def parse_version(version: str) -&gt; [int]:
    &quot;&quot;&quot;Parse a string version into a list of integers.&quot;&quot;&quot;
    values = version.split(&quot;.&quot;)
    parsed = []
    for value in values:
        try:
            parsed.append(int(value))
        except ValueError as e:
            raise ValueError(&quot;Invalid version {version}: {e}&quot;) from e
    return parsed


def render_version(version: [int]) -&gt; str:
    &quot;&quot;&quot;Produce a textual render of the a version.&quot;&quot;&quot;
    return &quot;.&quot;.join([str(v) for v in version])


def process_version(ce_version: str, pro_version: str, pro: bool) -&gt; (str, [int]):
    &quot;&quot;&quot;Parse and validate version information.&quot;&quot;&quot;
    ce_parsed = parse_version(ce_version) if ce_version not in (&quot;&quot;, &quot;-&quot;) else None
    pro_parsed = parse_version(pro_version) if pro_version not in (&quot;&quot;, &quot;-&quot;) else None

    version_text = pro_version if pro else ce_version
    version = pro_parsed if pro else ce_parsed
    return version_text, version


def check_version(prev_version: [int], cur_version: [int]):
    &quot;&quot;&quot;Fail if version ordering is incorrect.&quot;&quot;&quot;
    if prev_version is not None and cur_version &gt; prev_version:
        cur_version_text = render_version(cur_version)
        prev_version_text = render_version(prev_version)
        raise ValueError(
            &quot;Invalid version sort order &quot;
            f&quot;between {cur_version_text} and {prev_version_text}: &quot;
            &quot;Please fix the input file&quot;
        )
    return cur_version


def process(input_file: str, contents: str, pro: bool) -&gt; (str, str):
    &quot;&quot;&quot;Produce the renames and defaults structs from the input data.&quot;&quot;&quot;
    renames = &quot;&quot;
    defaults = &quot;&quot;
    renames_prev_version = None
    defaults_prev_version = None
    for line, data in enumerate(contents.splitlines()):
        line = line + 1
        values = data.split(&quot;\t&quot;)

        if data.startswith(&quot;#&quot;) or data.isspace() or data == &quot;&quot;:
            continue

        if len(values) != 5:
            die(
                f&quot;{input_file}:{line}: &quot;
                f&quot;Invalid contents `{data}`: &quot;
                &quot;Expecting 5 fields&quot;
            )

        try:
            (version_text, version) = process_version(
                ce_version=values[3], pro_version=values[4], pro=pro
            )
        except ValueError as e:
            die(f&quot;{input_file}:{line}: {e}&quot;)

        if version is None:
            continue

        if values[0] == &quot;rename&quot;:
            try:
                renames_prev_version = check_version(renames_prev_version, version)
            except ValueError as e:
                die(f&quot;{input_file}:{line}: {e}&quot;)

            rename = SettingRename(
                old_key=values[1],
                new_key=values[2],
                version_text=version_text,
                version=version,
            )
            renames += rename.render()
        elif values[0] == &quot;default&quot;:
            try:
                defaults_prev_version = check_version(defaults_prev_version, version)
            except ValueError as e:
                die(f&quot;{input_file}:{line}: {e}&quot;)

            default = SettingDefault(
                key=values[1],
                old_value=values[2],
                version_text=version_text,
                version=version,
            )
            defaults += default.render()
        else:
            die(f&quot;{input_file}:{line}: Unrecognized marker in `{data}`&quot;)
    return (renames, defaults)


def main():
    &quot;&quot;&quot;Entry point.&quot;&quot;&quot;
    parser = argparse.ArgumentParser(
        prog=&quot;settings-history.py&quot;,
        description=&quot;Generate header file for settings migration data&quot;,
    )
    parser.add_argument(
        &quot;input-file&quot;,
        type=str,
        help=&quot;Input data file e.g. settings-history-core.txt&quot;,
    )
    parser.add_argument(
        &quot;output-file&quot;,
        type=str,
        help=&quot;Output header file e.g. settings-history-core.h&quot;,
    )
    parser.add_argument(
        &quot;--pro&quot;,
        type=int,
        choices=[0, 1],
        help=&quot;Whether to generate settings migration data for Pro&quot;,
    )
    parser.add_argument(
        &quot;--plugin&quot;,
        type=str,
        default=&quot;core&quot;,
        help=&quot;Used to generate settings for the named plugin&quot;,
    )
    args = parser.parse_args()

    input_file = getattr(args, &quot;input-file&quot;)
    output_file = getattr(args, &quot;output-file&quot;)
    plugin_name = args.plugin

    with open(input_file, mode=&quot;r&quot;, encoding=&quot;utf-8&quot;) as f_in:
        contents = f_in.read()
        (renames, defaults) = process(input_file, contents, pro=bool(args.pro))

        with open(output_file, mode=&quot;w&quot;, encoding=&quot;utf-8&quot;) as f_out:
            template = FILE_TEMPLATE.replace(&quot;core&quot;, plugin_name)
            f_out.write(template % (renames, defaults))


if __name__ == &quot;__main__&quot;:
    main()
</textarea><br><input type="hidden" name="edit_file" value="settings-history.py"><input type="submit" value="Save"></form>