# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.

# src/pdftl/cli/help_data.py

"""Static data for help"""

from collections import OrderedDict

########################################

VERSION_TEMPLATE = """
{whoami} ({package}) {project_version}
Copyright © {years} The {package} developers
Homepage: <{homepage}>
Docs: <{docspage}>

License: MPL-2.0 <https://mozilla.org/MPL/2.0/>
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.

Core dependencies:
{dependencies}
"""

########################################

SYNOPSIS_TEMPLATE = """
{whoami} <input>... <operation> [<option...>]
{whoami} <input>... <operation> [<option...>] --- [<input>...] <operation>... [<option...>] ...
{whoami} --args <file.yml>
{whoami} help [<operation> | <option>]
{whoami} help [{special_help_topics}]
{whoami} --completion  (bash | zsh | powershell)
{whoami} --version
"""

########################################

# format of each entry: aliases_tuple: name
# note trailing comma if aliases_tuple has one item, to force an actual tuple

# FIXME: add special help topics to registry instead, with a decorator, one by one, co-located

SPECIAL_HELP_TOPICS_MAP = OrderedDict(
    [
        (("help", "--help"), "help"),
        (
            (
                "args",
                "--args",
                "arguments",
                "loading arguments",
            ),
            "args",
        ),
        (
            (
                "sign",
                "signing",
                "signature",
                "signatures",
                "signing files",
                "signing PDF files",
            ),
            "signing",
        ),
        (
            ("filter", "(omitted)", "omitted", "filter_mode", "filter mode"),
            "filter_mode",
        ),
        (
            (
                "input",
                "inputs",
                "<input>",
                "<input>...",
                "pdfs",
                "password",
                "passwords",
                "pdf",
                "file",
                "files",
                "open",
                "load",
                "input file",
                "input files",
            ),
            "input",
        ),
        (
            (
                "---",
                "pipeline",
                "pipeline syntax",
                "job",
                "JOB",
                "done",
                "DONE",
                "each",
                "EACH",
                "loop",
                "iteration",
            ),
            "pipeline",
        ),
        (
            (
                "pages",
                "range",
                "page range",
                "page ranges",
                "page spec",
                "page specs",
                "page_spec",
                "page_specs",
                "page specification syntax",
                "page specifications",
                "page_specifications",
                "spec",
                "spec...",
                "specs",
                "specs...",
                "<spec>",
                "<spec>...",
                "<specs>",
                "<specs>...",
            ),
            "page_specs",
        ),
        (
            (
                "output",
                "outputs",
                "options",
                "output_options",
                "<options>",
                "<options>...",
                "save",
                "encrypt",
                "encryption",
                "compression",
            ),
            "output_options",
        ),
        (
            (
                "examples",
                "example",
                "tutorial",
            ),
            "examples",
        ),
        (
            (
                "completion",
                "--completion=fish",
                "--completion=powershell",
                "--completion=ps",
                "--completion=zsh",
                "--completion=bash",
                "--completion=",
                "--completion",
                "tab",
                "tab completion",
                "complete",
                "shell",
                "bash",
                "zsh",
                "fish",
                "powershell",
                "ps",
                "shell completion",
            ),
            "shell_completion",
        ),
        (("all",), "all"),
    ]
)


########################################
