init.lua

---@author: Leon Heidelbach 10.01.2023
---@version: 1.0
---@license: GPLv3
---@tag init
---@mod trailblazer.init
---@brief [[
--- This is the init module of TrailBlazer. It contains all API functions and is the entry point for
--- the plugin.
---@brief ]]

local log = require("trailblazer.log")
local trails = require("trailblazer.trails")
local storage = require("trailblazer.storage")
local events = require("trailblazer.events")
local highlights = require("trailblazer.highlights")
local helpers = require("trailblazer.helpers")
local keymaps = require("trailblazer.keymaps")

local TrailBlazer = {}
TrailBlazer.options = {}
TrailBlazer.generated = {}

--- Setup function for TrailBlazer.
---@param opts? table
---@return table
local function set_defaults(opts)
  local defaults = {
    lang = "en",
    auto_save_trailblazer_state_on_exit = false,
    auto_load_trailblazer_state_on_enter = false,
    custom_session_storage_dir = "",
    trail_options = {
      trail_mark_priority = 10001,
      available_trail_mark_modes = { -- available modes to cycle through
        "global_chron",
        "global_buf_line_sorted",
        "global_fpath_line_sorted",
        "global_chron_buf_line_sorted",
        "global_chron_fpath_line_sorted",
        "global_chron_buf_switch_group_chron",
        "global_chron_buf_switch_group_line_sorted",
        "buffer_local_chron",
        "buffer_local_line_sorted"
      },
      current_trail_mark_mode = "global_chron", -- current / initial mode
      current_trail_mark_list_type = "quickfix", -- currently only quickfix lists are supported
      trail_mark_list_rows = 10, -- number of rows to show in the trail mark list
      verbose_trail_mark_select = true, -- print current mode notification on mode change
      mark_symbol = "•",
      newest_mark_symbol = "⬤",
      cursor_mark_symbol = "⬤",
      next_mark_symbol = "⬤",
      previous_mark_symbol = "⬤",
      multiple_mark_symbol_counters_enabled = true,
      number_line_color_enabled = true,
      trail_mark_in_text_highlights_enabled = true,
      trail_mark_symbol_line_indicators_enabled = false,
      symbol_line_enabled = true,
      default_trail_mark_stacks = {
        "default"
      },
      available_trail_mark_stack_sort_modes = {
        "alpha_asc",
        "alpha_dsc",
        "chron_asc",
        "chron_dsc",
      },
      current_trail_mark_stack_sort_mode = "alpha_asc",
      move_to_nearest_before_peek = false,
      move_to_nearest_before_peek_motion_directive_up = "fpath_up",
      move_to_nearest_before_peek_motion_directive_down = "fpath_down",
      move_to_nearest_before_peek_dist_type = "lin_char_dist",
    },
    mappings = {
      nv = { -- Mode union: normal & visual mode
        motions = {
          new_trail_mark = '<A-l>',
          track_back = '<A-b>',
          peek_move_next_down = '<A-J>',
          peek_move_previous_up = '<A-K>',
          move_to_nearest = '<A-n>',
          toggle_trail_mark_list = '<A-m>',
        },
        actions = {
          delete_all_trail_marks = '<A-L>',
          paste_at_last_trail_mark = '<A-p>',
          paste_at_all_trail_marks = '<A-P>',
          set_trail_mark_select_mode = '<A-t>',
          switch_to_next_trail_mark_stack = '<A-.>',
          switch_to_previous_trail_mark_stack = '<A-,>',
          set_trail_mark_stack_sort_mode = '<A-s>',
        },
      },
    },
    quickfix_mappings = {
      nv = {
        motions = {
          qf_motion_move_trail_mark_stack_cursor = "<CR>",
        },
        actions = {
          qf_action_delete_trail_mark_selection = "d",
          qf_action_save_visual_selection_start_line = "v",
        },
        alt_actions = {
          qf_action_save_visual_selection_start_line = "V",
        }
      },
      v = {
        actions = {
          qf_action_move_selected_trail_marks_down = "<C-j>",
          qf_action_move_selected_trail_marks_up = "<C-k>",
        }
      }
    },
    hl_groups = {
      TrailBlazerTrailMark = {
        guifg = "White",
        guibg = "none",
        gui = "bold",
      },
      TrailBlazerTrailMarkNext = {
        guifg = "Green",
        guibg = "none",
        gui = "bold",
      },
      TrailBlazerTrailMarkPrevious = {
        guifg = "Red",
        guibg = "none",
        gui = "bold",
      },
      TrailBlazerTrailMarkCursor = {
        guifg = "Black",
        guibg = "Orange",
        gui = "bold",
      },
      TrailBlazerTrailMarkNewest = {
        guifg = "Black",
        guibg = "LightBlue",
        gui = "bold",
      },
      TrailBlazerTrailMarkCustomOrd = {
        guifg = "Black",
        guibg = "LightSlateBlue",
        gui = "bold",
      },
      TrailBlazerTrailMarkGlobalChron = {
        guifg = "Black",
        guibg = "Red",
        gui = "bold",
      },
      TrailBlazerTrailMarkGlobalBufLineSorted = {
        guifg = "Black",
        guibg = "LightRed",
        gui = "bold",
      },
      TrailBlazerTrailMarkGlobalFpathLineSorted = {
        guifg = "Black",
        guibg = "LightRed",
        gui = "bold",
      },
      TrailBlazerTrailMarkGlobalChronBufLineSorted = {
        guifg = "Black",
        guibg = "Olive",
        gui = "bold",
      },
      TrailBlazerTrailMarkGlobalChronFpathLineSorted = {
        guifg = "Black",
        guibg = "Olive",
        gui = "bold",
      },
      TrailBlazerTrailMarkGlobalChronBufSwitchGroupChron = {
        guifg = "Black",
        guibg = "VioletRed",
        gui = "bold",
      },
      TrailBlazerTrailMarkGlobalChronBufSwitchGroupLineSorted = {
        guifg = "Black",
        guibg = "MediumSpringGreen",
        gui = "bold",
      },
      TrailBlazerTrailMarkBufferLocalChron = {
        guifg = "Black",
        guibg = "Green",
        gui = "bold",
      },
      TrailBlazerTrailMarkBufferLocalLineSorted = {
        guifg = "Black",
        guibg = "LightGreen",
        gui = "bold",
      },
    },
  }

  if opts then
    return vim.tbl_deep_extend("force", defaults, opts)
  end

  return defaults
end

--- Setup TrailBlazer.
---@param options? table
function TrailBlazer.setup(options)
  TrailBlazer.options = set_defaults(options)
  TrailBlazer.generated.hl_groups = highlights.register(TrailBlazer.options.hl_groups, true)
  events.setup(TrailBlazer.options)
  trails.setup(TrailBlazer.options)
  storage.setup(TrailBlazer.options)
  log.setup(TrailBlazer.options.lang)
  if TrailBlazer.options.force_mappings then
    keymaps.register_api_maps(TrailBlazer.options.force_mappings, TrailBlazer)
  else
    keymaps.register_api_maps(TrailBlazer.options.mappings, TrailBlazer)
  end
  storage.auto_load_session_check()
end

--- Create a new trail mark at the current cursor or defined position and buffer.
---@param win? number
---@param buf? number | string
---@param pos? table<number, number>
function TrailBlazer.new_trail_mark(win, buf, pos)
  if not TrailBlazer.is_configured() then return end
  trails.actions.new_trail_mark(win, helpers.get_buf_nr(buf), pos)
  trails.list.update_trail_mark_list()
end

--- Track back to the last trail mark.
---@param buf? number | string
function TrailBlazer.track_back(buf)
  if not TrailBlazer.is_configured() then return end
  trails.actions.track_back(helpers.get_buf_nr(buf))
  trails.list.update_trail_mark_list()
end

--- Peek move to the previous trail mark if sorted chronologically or up if sorted by line.
---@param buf? number | string
function TrailBlazer.peek_move_previous_up(buf)
  if not TrailBlazer.is_configured() then return end
  trails.motions.peek_move_previous_up(helpers.get_buf_nr(buf))
  trails.list.update_trail_mark_list(nil, nil, true)
end

--- Peek move to the next trail mark if sorted chronologically or down if sorted by line.
---@param buf? number | string
function TrailBlazer.peek_move_next_down(buf)
  if not TrailBlazer.is_configured() then return end
  trails.motions.peek_move_next_down(helpers.get_buf_nr(buf))
  trails.list.update_trail_mark_list(nil, nil, true)
end

--- Move to the nearest trail mark relative to the current cursor position if one exists in buf.
---@param buf? number | string
---@param directive? string
---@param dist_type? string
function TrailBlazer.move_to_nearest(buf, directive, dist_type)
  if not TrailBlazer.is_configured() then return end
  trails.motions.move_to_nearest(helpers.get_buf_nr(buf), directive, dist_type)
  trails.list.update_trail_mark_list(nil, nil, true)
end

--- Move the cursor the the trail mark cursor position in the current stack.
function TrailBlazer.move_to_trail_mark_cursor()
  if not TrailBlazer.is_configured() then return end
  trails.motions.move_to_trail_mark_cursor()
  trails.list.update_trail_mark_list(nil, nil, true)
end

--- Delete all trail marks from all or a specific buffer.
---@param buf? number | string
function TrailBlazer.delete_all_trail_marks(buf)
  if not TrailBlazer.is_configured() then return end
  trails.actions.delete_all_trail_marks(helpers.get_buf_nr(buf))
  trails.list.update_trail_mark_list()
end

--- Paste the selected register contents at the last trail mark of all or a specific buffer.
---@param buf? number | string
function TrailBlazer.paste_at_last_trail_mark(buf)
  if not TrailBlazer.is_configured() then return end
  trails.actions.paste_at_last_trail_mark(helpers.get_buf_nr(buf))
  trails.list.update_trail_mark_list()
end

--- Paste the selected register contents at all trail marks of all or a specific buffer.
---@param buf? number | string
function TrailBlazer.paste_at_all_trail_marks(buf)
  if not TrailBlazer.is_configured() then return end
  trails.actions.paste_at_all_trail_marks(helpers.get_buf_nr(buf))
  trails.list.update_trail_mark_list()
end

--- Set the trail mark selection mode to the given mode or toggle between the available modes.
---@param mode? string
---@param verbose? boolean
function TrailBlazer.set_trail_mark_select_mode(mode, verbose)
  if not TrailBlazer.is_configured() then return end
  trails.actions.set_trail_mark_select_mode(mode, verbose)
  trails.list.update_trail_mark_list()
end

--- Toggle a list of all trail marks for the specified buffer in the specified list type.
---@param type string
---@param buf? number | string
function TrailBlazer.toggle_trail_mark_list(type, buf)
  if not TrailBlazer.is_configured() then return end
  trails.list.toggle_trail_mark_list(type, helpers.get_buf_nr(buf))
end

--- Open a list of all trail marks for the specified buffer in the specified list type.
---@param type string
---@param buf? number | string
---@param rows? number
function TrailBlazer.open_trail_mark_list(type, buf, rows)
  if not TrailBlazer.is_configured() then return end
  trails.list.open_trail_mark_list(type, helpers.get_buf_nr(buf), rows)
end

--- Close a list of all trail marks for the specified buffer in the specified list type.
---@param type string
function TrailBlazer.close_trail_mark_list(type)
  if not TrailBlazer.is_configured() then return end
  trails.list.close_trail_mark_list(type)
end

--- Switch the trail mark stack to the specified stack.
---@param name? string
function TrailBlazer.switch_trail_mark_stack(name, verbose)
  if not TrailBlazer.is_configured() then return end
  trails.actions.switch_trail_mark_stack(name, verbose)
  trails.list.update_trail_mark_list()
end

--- Delete the specified trail mark stack or the current one if no name is supplied.
---@param name? string
---@param verbose? boolean
function TrailBlazer.delete_trail_mark_stack(name, verbose)
  if not TrailBlazer.is_configured() then return end
  trails.actions.delete_trail_mark_stack(name, verbose)
  trails.list.update_trail_mark_list()
end

--- Delete all trail mark stacks.
---@param verbose? boolean
function TrailBlazer.delete_all_trail_mark_stacks(verbose)
  if not TrailBlazer.is_configured() then return end
  trails.actions.delete_all_trail_mark_stacks(verbose)
  trails.list.update_trail_mark_list()
end

--- Add the current trail mark stack under the specified name or "default" if no name is supplied.
---@param name? string
function TrailBlazer.add_trail_mark_stack(name)
  if not TrailBlazer.is_configured() then return end
  trails.actions.add_trail_mark_stack(name)
  trails.list.update_trail_mark_list()
end

--- Switch to the next trail mark stack using the given sort mode or the current one if no sort mode
--- is supplied.
---@param sort_mode? string
---@param verbose? boolean
function TrailBlazer.switch_to_next_trail_mark_stack(sort_mode, verbose)
  if not TrailBlazer.is_configured() then return end
  trails.actions.switch_to_next_trail_mark_stack(sort_mode, verbose)
  trails.list.update_trail_mark_list()
end

--- Switch to the previous trail mark stack using the given sort mode or the current one if no sort
--- mode is supplied.
---@param sort_mode? string
---@param verbose? boolean
function TrailBlazer.switch_to_previous_trail_mark_stack(sort_mode, verbose)
  if not TrailBlazer.is_configured() then return end
  trails.actions.switch_to_previous_trail_mark_stack(sort_mode, verbose)
  trails.list.update_trail_mark_list()
end

--- Set the trail mark stack sort mode to the given mode or toggle between the available modes.
---@param sort_mode? string
---@param verbose? boolean
function TrailBlazer.set_trail_mark_stack_sort_mode(sort_mode, verbose)
  if not TrailBlazer.is_configured() then return end
  trails.actions.set_trail_mark_stack_sort_mode(sort_mode, verbose)
end

--- Save the current TrailBlazer state to a file.
---@param path? string
---@param trail_mark_stacks? table
---@param verbose? boolean
function TrailBlazer.save_trailblazer_state_to_file(path, trail_mark_stacks, verbose)
  if not TrailBlazer.is_configured() then return end
  trails.storage.save_trailblazer_state_to_file(path, trail_mark_stacks, verbose)
end

--- Restore the TrailBlazer state from a file.
---@param path? string
---@param verbose? boolean
function TrailBlazer.load_trailblazer_state_from_file(path, verbose)
  if not TrailBlazer.is_configured() then return end
  trails.storage.load_trailblazer_state_from_file(path, verbose)
end

--- Delete a TrailBlazer state file at path. For safety only valid save files will be deleted.
---@param path? string
---@param verbose? boolean
function TrailBlazer.delete_trailblazer_state_file(path, verbose)
  if not TrailBlazer.is_configured() then return end
  trails.storage.delete_trailblazer_state_file(path, verbose)
end

--- Check if TrailBlazer is configured.
---@return boolean
function TrailBlazer.is_configured()
  if TrailBlazer.options == nil then
    log.error("not_configured")
    return false
  end
  return true
end

return TrailBlazer