"""All commands that are available in the napari GUI are defined here.

Internally, prefer using the CommandId enum instead of the string literal.
When adding a new command, add a new title/description in the _COMMAND_INFO dict
below.  The title will be used in the GUI, and the may be used in auto generated
documentation.

CommandId values should be namespaced, e.g. 'napari:layer:something' for a command
that operates on layers.
"""
from typing import NamedTuple, Optional

from napari.utils.compat import StrEnum
from napari.utils.translations import trans


# fmt: off
class CommandId(StrEnum):
    """Id representing a napari command."""

    # View menubar
    TOGGLE_FULLSCREEN = 'napari:window:view:toggle_fullscreen'
    TOGGLE_MENUBAR = 'napari:window:view:toggle_menubar'
    TOGGLE_PLAY = 'napari:window:view:toggle_play'
    TOGGLE_OCTREE_CHUNK_OUTLINES = 'napari:window:view:toggle_octree_chunk_outlines'
    TOGGLE_LAYER_TOOLTIPS = 'napari:window:view:toggle_layer_tooltips'
    TOGGLE_ACTIVITY_DOCK = 'napari:window:view:toggle_activity_dock'

    TOGGLE_VIEWER_AXES = 'napari:window:view:toggle_viewer_axes'
    TOGGLE_VIEWER_AXES_COLORED = 'napari:window:view:toggle_viewer_axes_colored'
    TOGGLE_VIEWER_AXES_LABELS = 'napari:window:view:toggle_viewer_axes_labels'
    TOGGLE_VIEWER_AXES_DASHED = 'napari:window:view:toggle_viewer_axesdashed'
    TOGGLE_VIEWER_AXES_ARROWS = 'napari:window:view:toggle_viewer_axes_arrows'
    TOGGLE_VIEWER_SCALE_BAR = 'napari:window:view:toggle_viewer_scale_bar'
    TOGGLE_VIEWER_SCALE_BAR_COLORED = 'napari:window:view:toggle_viewer_scale_bar_colored'
    TOGGLE_VIEWER_SCALE_BAR_TICKS = 'napari:window:view:toggle_viewer_scale_bar_ticks'

    # Help menubar
    NAPARI_GETTING_STARTED = 'napari:window:help:getting_started'
    NAPARI_TUTORIALS = 'napari:window:help:tutorials'
    NAPARI_LAYERS_GUIDE = 'napari:window:help:layers_guide'
    NAPARI_EXAMPLES = 'napari:window:help:examples'
    NAPARI_RELEASE_NOTES = 'napari:window:help:release_notes'
    NAPARI_HOMEPAGE = 'napari:window:help:homepage'
    NAPARI_INFO = 'napari:window:help:info'
    NAPARI_GITHUB_ISSUE = 'napari:window:help:github_issue'
    TOGGLE_BUG_REPORT_OPT_IN = 'napari:window:help:bug_report_opt_in'

    # Layer menubar
    LAYER_DUPLICATE = 'napari:layer:duplicate'
    LAYER_SPLIT_STACK = 'napari:layer:split_stack'
    LAYER_SPLIT_RGB = 'napari:layer:split_rgb'
    LAYER_MERGE_STACK = 'napari:layer:merge_stack'
    LAYER_TOGGLE_VISIBILITY = 'napari:layer:toggle_visibility'

    LAYER_LINK_SELECTED = 'napari:layer:link_selected_layers'
    LAYER_UNLINK_SELECTED = 'napari:layer:unlink_selected_layers'
    LAYER_SELECT_LINKED = 'napari:layer:select_linked_layers'

    LAYER_CONVERT_TO_LABELS = 'napari:layer:convert_to_labels'
    LAYER_CONVERT_TO_IMAGE = 'napari:layer:convert_to_image'

    LAYER_CONVERT_TO_INT8 = 'napari:layer:convert_to_int8'
    LAYER_CONVERT_TO_INT16 = 'napari:layer:convert_to_int16'
    LAYER_CONVERT_TO_INT32 = 'napari:layer:convert_to_int32'
    LAYER_CONVERT_TO_INT64 = 'napari:layer:convert_to_int64'
    LAYER_CONVERT_TO_UINT8 = 'napari:layer:convert_to_uint8'
    LAYER_CONVERT_TO_UINT16 = 'napari:layer:convert_to_uint16'
    LAYER_CONVERT_TO_UINT32 = 'napari:layer:convert_to_uint32'
    LAYER_CONVERT_TO_UINT64 = 'napari:layer:convert_to_uint64'

    LAYER_PROJECT_MAX = 'napari:layer:project_max'
    LAYER_PROJECT_MIN = 'napari:layer:project_min'
    LAYER_PROJECT_STD = 'napari:layer:project_std'
    LAYER_PROJECT_SUM = 'napari:layer:project_sum'
    LAYER_PROJECT_MEAN = 'napari:layer:project_mean'
    LAYER_PROJECT_MEDIAN = 'napari:layer:project_median'

    @property
    def title(self) -> str:
        return _COMMAND_INFO[self].title

    @property
    def description(self) -> Optional[str]:
        return _COMMAND_INFO[self].description


class _i(NamedTuple):
    """simple utility tuple for defining items in _COMMAND_INFO."""

    title: str
    description: Optional[str] = None


_COMMAND_INFO = {
    # View menubar
    CommandId.TOGGLE_FULLSCREEN: _i(trans._('Toggle Full Screen')),
    CommandId.TOGGLE_MENUBAR: _i(trans._('Toggle Menubar Visibility')),
    CommandId.TOGGLE_PLAY: _i(trans._('Toggle Play')),
    CommandId.TOGGLE_OCTREE_CHUNK_OUTLINES: _i(trans._('Toggle Chunk Outlines')),
    CommandId.TOGGLE_LAYER_TOOLTIPS: _i(trans._('Toggle Layer Tooltips')),
    CommandId.TOGGLE_ACTIVITY_DOCK: _i(trans._('Toggle Activity Dock')),
    CommandId.TOGGLE_VIEWER_AXES: _i(trans._('Axes Visible')),
    CommandId.TOGGLE_VIEWER_AXES_COLORED: _i(trans._('Axes Colored')),
    CommandId.TOGGLE_VIEWER_AXES_LABELS: _i(trans._('Axes Labels')),
    CommandId.TOGGLE_VIEWER_AXES_DASHED: _i(trans._('Axes Dashed')),
    CommandId.TOGGLE_VIEWER_AXES_ARROWS: _i(trans._('Axes Arrows')),
    CommandId.TOGGLE_VIEWER_SCALE_BAR: _i(trans._('Scale Bar Visible')),
    CommandId.TOGGLE_VIEWER_SCALE_BAR_COLORED: _i(trans._('Scale Bar Colored')),
    CommandId.TOGGLE_VIEWER_SCALE_BAR_TICKS: _i(trans._('Scale Bar Ticks')),

    # Help menubar
    CommandId.NAPARI_GETTING_STARTED: _i(trans._('Getting started')),
    CommandId.NAPARI_TUTORIALS: _i(trans._('Tutorials')),
    CommandId.NAPARI_LAYERS_GUIDE: _i(trans._('Using Layers Guides')),
    CommandId.NAPARI_EXAMPLES: _i(trans._('Examples Gallery')),
    CommandId.NAPARI_RELEASE_NOTES: _i(trans._('Release Notes')),
    CommandId.NAPARI_HOMEPAGE: _i(trans._('napari homepage')),
    CommandId.NAPARI_INFO: _i(trans._('napari Info')),
    CommandId.NAPARI_GITHUB_ISSUE: _i(trans._('Report an issue on GitHub')),
    CommandId.TOGGLE_BUG_REPORT_OPT_IN: _i(trans._('Bug Reporting Opt In/Out...')),

    # Layer menubar
    CommandId.LAYER_DUPLICATE: _i(trans._('Duplicate Layer')),
    CommandId.LAYER_SPLIT_STACK: _i(trans._('Split Stack')),
    CommandId.LAYER_SPLIT_RGB: _i(trans._('Split RGB')),
    CommandId.LAYER_MERGE_STACK: _i(trans._('Merge to Stack')),
    CommandId.LAYER_TOGGLE_VISIBILITY: _i(trans._('Toggle visibility')),
    CommandId.LAYER_LINK_SELECTED: _i(trans._('Link Layers')),
    CommandId.LAYER_UNLINK_SELECTED: _i(trans._('Unlink Layers')),
    CommandId.LAYER_SELECT_LINKED: _i(trans._('Select Linked Layers')),
    CommandId.LAYER_CONVERT_TO_LABELS: _i(trans._('Convert to Labels')),
    CommandId.LAYER_CONVERT_TO_IMAGE: _i(trans._('Convert to Image')),
    CommandId.LAYER_CONVERT_TO_INT8: _i(trans._('Convert to int8')),
    CommandId.LAYER_CONVERT_TO_INT16: _i(trans._('Convert to int16')),
    CommandId.LAYER_CONVERT_TO_INT32: _i(trans._('Convert to int32')),
    CommandId.LAYER_CONVERT_TO_INT64: _i(trans._('Convert to int64')),
    CommandId.LAYER_CONVERT_TO_UINT8: _i(trans._('Convert to uint8')),
    CommandId.LAYER_CONVERT_TO_UINT16: _i(trans._('Convert to uint16')),
    CommandId.LAYER_CONVERT_TO_UINT32: _i(trans._('Convert to uint32')),
    CommandId.LAYER_CONVERT_TO_UINT64: _i(trans._('Convert to uint64')),
    CommandId.LAYER_PROJECT_MAX: _i(trans._('Max projection')),
    CommandId.LAYER_PROJECT_MIN: _i(trans._('Min projection')),
    CommandId.LAYER_PROJECT_STD: _i(trans._('Std projection')),
    CommandId.LAYER_PROJECT_SUM: _i(trans._('Sum projection')),
    CommandId.LAYER_PROJECT_MEAN: _i(trans._('Mean projection')),
    CommandId.LAYER_PROJECT_MEDIAN: _i(trans._('Median projection')),
}
# fmt: on
