Support writeback

README.md

@@ -67,20 +67,21 @@ require("decipher").setup({
     float = { -- Floating window options
         padding = 0, -- Zero padding (does not apply to title if any)
         border = { -- Floating window border
-            { "╭", "FloatBorder" },
-            { "─", "FloatBorder" },
-            { "╮", "FloatBorder" },
-            { "│", "FloatBorder" },
-            { "╯", "FloatBorder" },
-            { "─", "FloatBorder" },
-            { "╰", "FloatBorder" },
-            { "│", "FloatBorder" },
+            { "╭", "FloatBorder" },
+            { "─", "FloatBorder" },
+            { "╮", "FloatBorder" },
+            { "│", "FloatBorder" },
+            { "╯", "FloatBorder" },
+            { "─", "FloatBorder" },
+            { "╰", "FloatBorder" },
+            { "│", "FloatBorder" },
         },
         mappings = {
-            close = "q", -- Key to press to close the floating window
-            apply = "a", -- Key to press to apply the encoding/decoding
-            jsonpp = "J", -- Key to prettily format contents as json if possbile
-            help = "?", -- Toggle help
+            close = "q", -- Close the floating window
+            apply = "<leader>a", -- Apply the encoded/decoded preview in the original buffer
+            update = "<leader>u", -- Update the original buffer with changes made in the encoded/decoded preview
+            jsonpp = "<leader>j", -- Prettily format contents as json if possible (view is immutable)
+            help = "g?", -- Toggle help
         },
         title = true, -- Display a title with the codec name
         title_pos = "left", -- Position of the title

lua/decipher/compat.lua

@@ -1,7 +1,5 @@
 local compat = {}
 
----@param tbl table
----@return boolean
 function compat.tbl_islist(tbl)
     if vim.fn.has("nvim-0.10.0") == 1 then
         return vim.islist(tbl)
@@ -15,10 +13,40 @@ end
 function compat.get_report_funcs()
     if vim.fn.has("nvim-0.10") == 1 then
         return vim.health.start, vim.health.ok, vim.health.error
+    else
+        ---@diagnostic disable-next-line: deprecated
+        return vim.health.report_start, vim.health.report_ok, vim.health.report_error
     end
+end
 
-    ---@diagnostic disable-next-line: deprecated
-    return vim.health.report_start, vim.health.report_ok, vim.health.report_error
+---@param name string
+---@param value unknown
+---@param options { scope: "local" | "global", win: integer?, buf: integer? }
+function compat.set_option(name, value, options)
+    if vim.fn.has("nvim-0.10.0") == 1 then
+        vim.api.nvim_set_option_value(name, value, options)
+    else
+        if options.win then
+            ---@diagnostic disable-next-line: deprecated
+            vim.api.nvim_win_set_option(options.win, name, value)
+        elseif options.buf then
+            ---@diagnostic disable-next-line: deprecated
+            vim.api.nvim_buf_set_option(options.buf, name, value)
+        end
+    end
+end
+
+---@param name string
+---@param value any
+---@param validator vim.validate.Validator
+---@param optional boolean?
+---@param message string?
+function compat.validate(name, value, validator, optional, message)
+    if vim.fn.has("nvim-0.11.0") == 1 then
+        vim.validate(name, value, validator, optional, message)
+    else
+        vim.validate({ [name] = { value, validator, optional or message } })
+    end
 end
 
 return compat

lua/decipher/config.lua

@@ -3,7 +3,8 @@ local config = {}
 ---@class decipher.WindowMappings
 ---@field close? string
 ---@field apply? string
----@field jsonpp? string
+---@field update? string
+---@field json? string
 ---@field help? string
 
 ---@class decipher.WindowConfig
@@ -14,7 +15,8 @@ local config = {}
 ---@field title_pos? 'left' | 'center' | 'right'
 ---@field autoclose? boolean
 ---@field enter? boolean
----@field options? table<string, any>
+---@field win_options? table<string, any>
+---@field zindex integer?
 
 ---@class decipher.Config
 ---@field float? decipher.WindowConfig
@@ -35,15 +37,17 @@ local default_config = {
         },
         mappings = {
             close = "q",
-            apply = "a",
-            jsonpp = "J",
-            help = "?",
+            apply = "<leader>a",
+            update = "<leader>u",
+            json = "<leader>j",
+            help = "g?",
         },
         title = true,
         title_pos = "left",
         autoclose = true,
         enter = false,
-        options = {},
+        win_options = {},
+        zindex = 50,
     },
 }
 
@@ -70,13 +74,15 @@ local function validate_config(_config)
         ["float.mappings"] = { _config.float.mappings, "table" },
         ["float.mappings.close"] = { _config.float.mappings.close, "string" },
         ["float.mappings.apply"] = { _config.float.mappings.apply, "string" },
-        ["float.mappings.jsonpp"] = { _config.float.mappings.jsonpp, "string" },
+        ["float.mappings.update"] = { _config.float.mappings.update, "string" },
+        ["float.mappings.json"] = { _config.float.mappings.json, "string" },
         ["float.mappings.help"] = { _config.float.mappings.help, "string" },
         ["float.title"] = { _config.float.title, "boolean" },
         ["float.title_pos"] = { _config.float.title_pos, "string" },
         ["float.autoclose"] = { _config.float.autoclose, "boolean" },
         ["float.enter"] = { _config.float.enter, "boolean" },
-        ["float.options"] = { _config.float.options, "table" },
+        ["float.win_options"] = { _config.float.win_options, "table" },
+        ["float.zindex"] = { _config.float.zindex, "number" },
     })
 end
 

lua/decipher/init.lua

@@ -4,7 +4,7 @@ local decipher_version = "2.1.0"
 
 local codecs = require("decipher.codecs")
 local config = require("decipher.config")
-local errors = require("decipher.errors")
+local notifications = require("decipher.notifications")
 local motion = require("decipher.motion")
 local selection = require("decipher.selection")
 local str_utils = require("decipher.util.string")
@@ -15,6 +15,10 @@ decipher.codec = codecs.codec
 ---@class decipher.Options
 ---@field public preview boolean if a preview should be shown or not
 
+---@class decipher.ProcessCodecOptions
+---@field selection_type decipher.SelectionType
+---@field codec_type "encode" | "decode"
+
 ---@alias decipher.CodecArg string | decipher.Codecs
 
 ---@return string
@@ -63,18 +67,32 @@ end
 
 ---@param codec_name string
 ---@param status boolean
----@param value string?
+---@param value string
 ---@param selection_type decipher.SelectionType
-local function open_float_handler(codec_name, status, value, selection_type)
+---@param codec_type "encode" | "decode"
+local function open_float_handler(codec_name, status, value, selection_type, codec_type)
     if status and value == nil then
         value = "Codec not found"
     end
 
+    if not status then
+        notifications.error(("%s: %s"):format(codec_name, value))
+        return
+    end
+
     -- We need the selection in order to apply the codec operation from the
     -- preview window later on
     local _selection = selection.get_selection(selection_type)
 
-    ui.float.open(codec_name, { value }, config.float, selection_type, _selection)
+    ui.float.open({
+        title = codec_name,
+        contents = vim.fn.split(value, [[\r\?\n]]),
+        config = config.float,
+        selection_type = selection_type,
+        codec_name = codec_name,
+        codec_type = codec_type,
+        selection = _selection,
+    })
 end
 
 --- Handler for setting a text region to a value
@@ -85,12 +103,12 @@ end
 ---@diagnostic disable-next-line:unused-local
 local function set_text_region_handler(codec_name, status, value, selection_type)
     if not status then
-        errors.error_message(("%s: %s"):format(codec_name, value), true)
+        notifications.error(("%s: %s"):format(codec_name, value))
         return
     end
 
     if value == nil then
-        errors.error_message_codec(codec_name)
+        notifications.codec_not_found("Codec not found: " .. codec_name)
         return
     end
 
@@ -102,8 +120,9 @@ end
 ---@param codec_name decipher.CodecArg
 ---@param codec_func fun(string): string
 ---@param selection_type decipher.SelectionType
+---@param codec_type "encode" | "decode"
 ---@param options decipher.Options
-local function process_codec(codec_name, codec_func, selection_type, options)
+local function process_codec(codec_name, codec_func, selection_type, codec_type, options)
     local lines = selection.get_text(0, selection_type)
     local joined = table.concat(lines, "\n")
     local status, value = pcall(codec_func, codec_name, joined)
@@ -113,74 +132,75 @@ local function process_codec(codec_name, codec_func, selection_type, options)
     local _codec_name = ("%s"):format(codec_name)
 
     if do_preview then
-        open_float_handler(_codec_name, status, value, selection_type)
+        open_float_handler(_codec_name, status, value, selection_type, codec_type)
     else
         set_text_region_handler(_codec_name, status, value, selection_type)
     end
 end
 
 ---@param codec_func fun(string): string
 ---@param selection_type decipher.SelectionType
+---@param codec_type "encode" | "decode"
 ---@param options decipher.Options
-local function process_codec_prompt(codec_func, selection_type, options)
+local function process_codec_prompt(codec_func, selection_type, codec_type, options)
     vim.ui.select(codecs.supported(), { prompt = "Codec?: " }, function(codec_name)
         if codec_name == nil then
             return
         end
 
-        process_codec(codec_name, codec_func, selection_type, options)
+        process_codec(codec_name, codec_func, selection_type, codec_type, options)
     end)
 end
 
 ---@param codec_name decipher.CodecArg
 ---@param options decipher.Options
 function decipher.encode_selection(codec_name, options)
-    process_codec(codec_name, decipher.encode, "visual", options)
+    process_codec(codec_name, decipher.encode, "visual", "encode", options)
 end
 
 ---@param codec_name decipher.CodecArg
 ---@param options decipher.Options
 function decipher.decode_selection(codec_name, options)
-    process_codec(codec_name, decipher.decode, "visual", options)
+    process_codec(codec_name, decipher.decode, "visual", "decode", options)
 end
 
 ---@param codec_name decipher.CodecArg
 ---@param options decipher.Options
 function decipher.encode_motion(codec_name, options)
     motion.start_motion(function()
-        process_codec(codec_name, decipher.encode, "motion", options)
+        process_codec(codec_name, decipher.encode, "motion", "encode", options)
     end)
 end
 
 ---@param codec_name decipher.CodecArg
 ---@param options decipher.Options
 function decipher.decode_motion(codec_name, options)
     motion.start_motion(function()
-        process_codec(codec_name, decipher.decode, "motion", options)
+        process_codec(codec_name, decipher.decode, "motion", "decode", options)
     end)
 end
 
 ---@param options decipher.Options
 function decipher.encode_selection_prompt(options)
-    process_codec_prompt(decipher.encode, "visual", options)
+    process_codec_prompt(decipher.encode, "visual", "encode", options)
 end
 
 ---@param options decipher.Options
 function decipher.decode_selection_prompt(options)
-    process_codec_prompt(decipher.decode, "visual", options)
+    process_codec_prompt(decipher.decode, "visual", "decode", options)
 end
 
 ---@param options decipher.Options
 function decipher.encode_motion_prompt(options)
     motion.start_motion(function()
-        process_codec_prompt(decipher.encode, "motion", options)
+        process_codec_prompt(decipher.encode, "motion", "encode", options)
     end)
 end
 
 ---@param options decipher.Options
 function decipher.decode_motion_prompt(options)
     motion.start_motion(function()
-        process_codec_prompt(decipher.decode, "motion", options)
+        process_codec_prompt(decipher.decode, "motion", "decode", options)
     end)
 end
 
@@ -193,16 +213,14 @@ end
 ---@param user_config? decipher.Config
 function decipher.setup(user_config)
     if not vim.fn.has("nvim-0.5.0") then
-        errors.error_message("This plugin only works with Neovim >= v0.5.0", true)
+        notifications.error("This plugin only works with Neovim >= v0.5.0")
         return
     end
 
     if not decipher.has_bit_library() then
-        errors.error_message({
-            { "A bit library is required. Ensure that either " },
-            { "neovim has been built with luajit " },
-            { "or use neovim v0.9.0+ which includes a bit library" },
-        }, true)
+        notifications.error(
+            "A bit library is required. Ensure that either neovim has been built with luajit or use neovim v0.9.0+ which includes a bit library"
+        )
 
         return
     end