refactor: backup

LICENCE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Zoran
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

lua/Trans/backend/baidu.lua

@@ -1,18 +1,13 @@
----@class Baidu: TransOnlineBackend
----@field uri string api uri
----@field salt string
----@field app_id string
----@field app_passwd string
----@field disable boolean
+---@class Baidu: TransBackendOnline
+---@field conf { app_id: string, app_passwd: string }
 local M = {
+    name         = 'baidu',
+    display_text = '百度',
     uri          = 'https://fanyi-api.baidu.com/api/trans/vip/translate',
     salt         = tostring(math.random(bit.lshift(1, 15))),
-    name    = 'baidu',
-    name_zh = '百度',
     method       = 'get',
 }
 
-
 local Trans = require 'Trans'
 
 ---@class BaiduQuery
@@ -27,14 +22,17 @@ local Trans = require 'Trans'
 ---@param data TransData
 ---@return BaiduQuery
 function M.get_query(data)
-    local tmp  = M.app_id .. data.str .. M.salt .. M.app_passwd
+    local m_conf = M.conf
+    assert(m_conf, 'Load Baidu config failed')
+
+    local tmp  = m_conf.app_id .. data.str .. M.salt .. m_conf.app_passwd
     local sign = Trans.util.md5.sumhexa(tmp)
 
     return {
         q     = data.str,
         from  = data.from,
         to    = data.to,
-        appid = M.app_id,
+        appid = m_conf.app_id,
         salt  = M.salt,
         sign  = sign,
     }
@@ -57,14 +55,31 @@ function M.formatter(body, data)
     }
 end
 
----@class TransBackend
----@field baidu Baidu
 return M
 
--- -- NOTE :free tts:
--- -- https://zj.v.api.aa1.cn/api/baidu-01/?msg=我爱你&choose=0&su=100&yd=5
--- -- 选择转音频的人物，女生1 输入0 ｜ 女生2输入：5｜男生1 输入：1｜男生2 输入：2｜男生3 输入：3
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+-- NOTE :free tts:
+-- https://zj.v.api.aa1.cn/api/baidu-01/?msg=我爱你&choose=0&su=100&yd=5
+-- 选择转音频的人物，女生1 输入0 ｜ 女生2输入：5｜男生1 输入：1｜男生2 输入：2｜男生3 输入：3
 -- {
 --   body = '{"from":"en","to":"zh","trans_result":[{"src":"require","dst":"\\u8981\\u6c42"}]}',
 --   exit = 0,

lua/Trans/backend/offline.lua

@@ -1,4 +1,191 @@
 local Trans = require 'Trans'
+if false then
+    -- local dict    = db:open(Trans.conf.dir .. Trans.separator .. 'ultimate.db')
+    local db      = require 'sqlite.db'
+    local conf = Trans.loader.conf
+    local dict    = db:open(conf.dict)
+    vim.api.nvim_create_autocmd('VimLeavePre', {
+        callback = function()
+            if db:isopen() then db:close() end
+        end,
+    })
+
+    ---@class TransOfflineBackend
+    local M = {
+        name    = 'offline',
+        name_zh = '本地',
+        no_wait = true,
+    }
+
+    ---@param data any
+    function M.query(data)
+        if data.is_word == false or data.from == 'zh' then
+            return
+        end
+
+        local res = dict:select(conf.db_name, {
+            where = { word = data.str },
+            keys  = M.query_field,
+            limit = 1,
+        })[1]
+
+        data.result.offline = res and M.formatter(res) or false
+    end
+
+    -- this is a awesome plugin
+    M.query_field = {
+        'word',
+        'phonetic',
+        'definition',
+        'translation',
+        'pos',
+        'collins',
+        'oxford',
+        'tag',
+        'exchange',
+    }
+
+    local function exist(str)
+        return str and str ~= ''
+    end
+
+    ---@type (fun(res):any)[]
+    local formatter = {
+        title = function(res)
+            local title  = {
+                word     = res.word,
+                oxford   = res.oxford,
+                collins  = res.collins,
+                phonetic = res.phonetic,
+            }
+
+            res.word     = nil
+            res.oxford   = nil
+            res.collins  = nil
+            res.phonetic = nil
+            return title
+        end,
+        tag = function(res)
+            if not exist(res.tag) then
+                return
+            end
+            local tag_map = {
+                zk    = '中考',
+                gk    = '高考',
+                ky    = '考研',
+                gre   = 'gre ',
+                cet4  = '四级',
+                cet6  = '六级',
+                ielts = '雅思',
+                toefl = '托福',
+            }
+
+            local tag = {}
+            for i, _tag in ipairs(vim.split(res.tag, ' ', { plain = true })) do
+                tag[i] = tag_map[_tag]
+            end
+
+            return tag
+        end,
+        exchange = function(res)
+            if not exist(res.exchange) then
+                return
+            end
+            local exchange_map = {
+                ['0'] = '原型        ',
+                ['1'] = '类别        ',
+                ['p'] = '过去式      ',
+                ['r'] = '比较级      ',
+                ['t'] = '最高级      ',
+                ['b'] = '比较级      ',
+                ['z'] = '最高级      ',
+                ['s'] = '复数        ',
+                ['d'] = '过去分词    ',
+                ['i'] = '现在分词    ',
+                ['3'] = '第三人称单数',
+                ['f'] = '第三人称单数',
+            }
+
+            local exchange = {}
+            for _, _exchange in ipairs(vim.split(res.exchange, '/', { plain = true })) do
+                exchange[exchange_map[_exchange:sub(1, 1)]] = _exchange:sub(3)
+            end
+
+            return exchange
+        end,
+        pos = function(res)
+            if not exist(res.pos) then
+                return
+            end
+            local pos_map = {
+                a = '代词pron         ',
+                c = '连接词conj       ',
+                i = '介词prep         ',
+                j = '形容词adj        ',
+                m = '数词num          ',
+                n = '名词n            ',
+                p = '代词pron         ',
+                r = '副词adv          ',
+                u = '感叹词int        ',
+                v = '动词v            ',
+                x = '否定标记not      ',
+                t = '不定式标记infm   ',
+                d = '限定词determiner ',
+            }
+
+            local pos = {}
+            for _, _pos in ipairs(vim.split(res.pos, '/', { plain = true })) do
+                pos[pos_map[_pos:sub(1, 1)]] = ('%2s%%'):format(_pos:sub(3))
+            end
+
+            return pos
+        end,
+        translation = function(res)
+            if not exist(res.translation) then
+                return
+            end
+            local translation = {}
+            for i, _translation in ipairs(vim.split(res.translation, '\n', { plain = true })) do
+                translation[i] = _translation
+            end
+
+            return translation
+        end,
+        definition = function(res)
+            if not exist(res.definition) then
+                return
+            end
+            local definition = {}
+            for i, _definition in ipairs(vim.split(res.definition, '\n', { plain = true })) do
+                --     -- TODO :判断是否需要分割空格
+                definition[i] = _definition:gsub('^%s+', '', 1)
+            end
+
+            return definition
+        end,
+    }
+
+    ---Formater for TransResul
+    ---@param res TransResult
+    ---@return TransResult
+    function M.formatter(res)
+        for field, func in pairs(formatter) do
+            res[field] = func(res)
+        end
+
+        return res
+    end
+
+    ---@class TransBackends
+    ---@field offline TransOfflineBackend
+    return {
+        name    = 'offline',
+        name_zh = '本地',
+        no_wait = true,
+    }
+end
+
+
 
 local db      = require 'sqlite.db'
 local path    = Trans.conf.dir .. Trans.separator .. 'ultimate.db'
@@ -18,8 +205,6 @@ local M = {
 }
 
 ---@param data any
----@return any
----@overload fun(TransData): TransResult
 function M.query(data)
     if data.is_word == false or data.from == 'zh' then
         return
@@ -178,6 +363,4 @@ function M.formatter(res)
     return res
 end
 
----@class TransBackends
----@field offline TransOfflineBackend
 return M

lua/Trans/backend/youdao.lua

@@ -1,15 +1,14 @@
----@class Youdao: TransOnlineBackend
+---@class Youdao: TransBackendOnline
 ---@field uri string api uri
 ---@field salt string
----@field app_id string
----@field app_passwd string
 ---@field disable boolean
+---@field conf { app_id: string, app_passwd: string }
 local M = {
     uri          = 'https://openapi.youdao.com/api',
-    salt    = tostring(math.random(bit.lshift(1, 15))),
     name         = 'youdao',
-    name_zh = '有道',
+    display_text = '有道',
     method       = 'get',
+    salt         = tostring(math.random(bit.lshift(1, 15))),
 }
 
 ---@class YoudaoQuery
@@ -26,7 +25,7 @@ local M = {
 ---@return YoudaoQuery
 function M.get_query(data)
     local str     = data.str
-    local app_id  = M.app_id
+    local m_conf  = M.conf
     local salt    = M.salt
     local curtime = tostring(os.time())
 
@@ -38,7 +37,7 @@ function M.get_query(data)
 
 
     -- sign=sha256(应用ID+input+salt+curtime+应用密钥)； 一二三四五六七八九十
-    local hash = app_id .. input .. salt .. curtime .. M.app_passwd
+    local hash = m_conf.app_id .. input .. salt .. curtime .. m_conf.app_passwd
     local sign = vim.fn.sha256(hash)
 
 
@@ -47,7 +46,7 @@ function M.get_query(data)
         to       = data.from == 'zh' and 'en' or 'zh-CHS',
         from     = 'auto',
         signType = 'v3',
-        appKey   = app_id,
+        appKey   = m_conf.app_id,
         salt     = M.salt,
         curtime  = curtime,
         sign     = sign,
@@ -160,6 +159,26 @@ end
 ---@class TransBackend
 ---@field youdao Youdao
 return M
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 
 -- INFO :Query Result Example
 -- {

lua/Trans/core/animation.lua

@@ -0,0 +1,8 @@
+local Trans = require'Trans'
+
+---@class Trans
+local M = {}
+
+
+
+return M

lua/Trans/core/backend.lua

@@ -1,27 +1,68 @@
 local Trans = require 'Trans'
 
-
 ---@class TransBackend
 ---@field no_wait? boolean whether need to wait for the result
----@field all_name string[] @all backend name
----@field name string @backend name
----@field name_zh string @backend name in Chinese
+---@field name string
+---@field display_text string?
+---@field conf table? @User specific config
 
----@class TransOnlineBackend: TransBackend
+
+---@class TransBackendOnline: TransBackend
 ---@field uri string @request uri
 ---@field method 'get' | 'post' @request method
----@field formatter fun(body: table, data: TransData): TransResult|false|nil @formatter
----@field get_query fun(data: TransData): table<string, string> @get query
----@field header? table<string, string> | fun(data: TransData): table<string, string> @request header
----@field debug? fun(body: table?) @debug
+---@field formatter fun(body: table, data: TransData): TransResult|false|nil transform response body to TransResult
+---@field get_query fun(data: TransData): table<string, any> @get query table
+---@field error_message? fun(errorCode) @get error message
+
+-- -@field header table<string, string>|fun(data: TransData): table<string, string> @request header
 
 
-local conf = Trans.conf
---- INFO :Parse online engine keys config file
-local path = conf.dir .. '/Trans.json'
+---@class TransBackendOffline: TransBackend
+---@field query fun(data: TransData)
+
+
+
+---@class TransBackendCore
+local M = {
+    ---@type table<string, TransBackend> backendname -> backend source
+    sources = {},
+}
+
+local m_util = {}
+
+-- INFO :Template method for online query
+---@param data TransData @data
+---@param backend TransBackendOnline @backend
+function M.do_query(data, backend)
+    local name      = backend.name
+    local formatter = backend.formatter
+    -- local header    = type(backend.header) == 'function' and backend.header(data) or backend.header
+
+    local function handle(output)
+        local status, body = pcall(vim.json.decode, output.body)
+        if not status or not body then
+            data.result[name] = false
+            return
+        end
+
+        data.result[name] = formatter(body, data)
+    end
+
+    Trans.curl[backend.method](backend.uri, {
+        query = backend.get_query(data),
+        callback = handle,
+        --- FIXME :
+        header = header,
+    })
+end
+
+-- TODO :Implement all of utility functions
+M.util = m_util
+
+
+-- INFO :Parse configuration file
+local path = Trans.conf.dir .. '/Trans.json'
 local file = io.open(path, 'r')
-
-
 local user_conf = {}
 if file then
     local content = file:read '*a'
@@ -29,33 +70,16 @@ if file then
     file:close()
 end
 
-
-local all_name = {}
-for _, config in ipairs(user_conf) do
-    if not config.disable then
-        all_name[#all_name + 1] = config.name
-        user_conf[config.name] = config
-    end
-end
-
-
----@class TransBackends
----@field all_name string[] all backend names
-
+-- WARNING : [Breaking change] 'Trans.json' should use json object instead of array
 ---@class Trans
----@field backend TransBackends
-return setmetatable({
-    all_name = all_name,
-}, {
+---@field backend TransBackendCore
+return setmetatable(M, {
     __index = function(self, name)
         ---@type TransBackend
         local backend = require('Trans.backend.' .. name)
+        backend.conf = user_conf[name]
 
-        for key, value in pairs(user_conf[name] or {}) do
-            backend[key] = value
-        end
-
-        self[name] = backend
+        self.sources[name] = backend
         return backend
     end,
 })

lua/Trans/core/conf.lua

@@ -1,138 +0,0 @@
----@class Trans
----@field conf TransConf
-
-
----@class TransConf
-return {
-    ---@type string the directory for database file and password file
-    dir      = require 'Trans'.plugin_dir,
-    debug    = true,
-    ---@type 'default' | 'dracula' | 'tokyonight' global Trans theme [see lua/Trans/style/theme.lua]
-    theme    = 'default', -- default | tokyonight | dracula
-    strategy = {
-        ---@type { frontend:string, backend:string | string[] } fallback strategy for mode
-        default = {
-            frontend = 'hover',
-            backend = '*',
-        },
-    },
-    ---@type table frontend options
-    frontend = {
-        ---@class TransFrontendOpts
-        ---@field keymaps table<string, string>
-        default = {
-            query     = 'fallback',
-            border    = 'rounded',
-            title     = vim.fn.has 'nvim-0.9' == 1 and {
-                    { '',       'TransTitleRound' },
-                    { ' Trans', 'TransTitle' },
-                    { '',       'TransTitleRound' },
-                } or nil, -- need nvim-0.9+
-            auto_play = true,
-            ---@type {open: string | boolean, close: string | boolean, interval: integer} Hover Window Animation
-            animation = {
-                open = 'slid', -- 'fold', 'slid'
-                close = 'slid',
-                interval = 12,
-            },
-            timeout   = 2000,
-        },
-        ---@class TransHoverOpts : TransFrontendOpts
-        hover = {
-            ---@type integer Max Width of Hover Window
-            width             = 37,
-            ---@type integer Max Height of Hover Window
-            height            = 27,
-            ---@type string -- see: /lua/Trans/style/spinner
-            spinner           = 'dots',
-            ---@type string
-            fallback_message  = '{{notfound}} 翻译超时或没有找到相关的翻译',
-            auto_resize       = true,
-            split_width       = 60,
-            padding           = 10, -- padding for hover window width
-            keymaps           = {
-                -- pageup       = '<C-u>',
-                -- pagedown     = '<C-d>',
-                -- pin          = '<leader>[',
-                -- close        = '<leader>]',
-                -- toggle_entry = '<leader>;',
-
-                -- play         = '_', -- Deprecated
-            },
-            ---@type string[] auto close events
-            auto_close_events = {
-                'InsertEnter',
-                'CursorMoved',
-                'BufLeave',
-            },
-            ---@type table<string, string[]> order to display translate result
-            order             = {
-                default = {
-                    'str',
-                    'translation',
-                    'definition',
-                },
-                offline = {
-                    'title',
-                    'tag',
-                    'pos',
-                    'exchange',
-                    'translation',
-                    'definition',
-                },
-                youdao = {
-                    'title',
-                    'translation',
-                    'definition',
-                    'web',
-                },
-            },
-            icon              = {
-                -- or use emoji
-                list        = '●', -- ● | ○ | ◉ | ◯ | ◇ | ◆ | ▪ | ▫ | ⬤ | 🟢 | 🟡 | 🟣 | 🟤 | 🟠| 🟦 | 🟨 | 🟧 | 🟥 | 🟪 | 🟫 | 🟩 | 🟦
-                star        = '', -- ⭐ | ✴ | ✳ | ✲ | ✱ | ✰ | ★ | ☆ | 🌟 | 🌠 | 🌙 | 🌛 | 🌜 | 🌟 | 🌠 | 🌌 | 🌙 |
-                notfound    = ' ', --❔ | ❓ | ❗ | ❕|
-                yes         = '✔', -- ✅ | ✔️ | ☑
-                no          = '', -- ❌ | ❎ | ✖ | ✘ | ✗ |
-                cell        = '■', -- ■  | □ | ▇ | ▏ ▎ ▍ ▌ ▋ ▊ ▉
-                web         = '󰖟', --🌍 | 🌎 | 🌏 | 🌐 |
-                tag         = '',
-                pos         = '',
-                exchange    = '',
-                definition  = '󰗊',
-                translation = '󰊿',
-            },
-        },
-    },
-}
-
-
--- TODO :
--- float = {
---     width = 0.8,
---     height = 0.8,
---     border = 'rounded',
---     keymap = {
---         quit = 'q',
---     },
---     animation = {
---         open = 'fold',
---         close = 'fold',
---         interval = 10,
---     },
---     tag = {
---         wait = '#519aba',
---         fail = '#e46876',
---         success = '#10b981',
---     },
--- },
-
-
--- local title = {
---     "████████╗██████╗  █████╗ ███╗   ██╗███████╗",
---     "╚══██╔══╝██╔══██╗██╔══██╗████╗  ██║██╔════╝",
---     "   ██║   ██████╔╝███████║██╔██╗ ██║███████╗",
---     "   ██║   ██╔══██╗██╔══██║██║╚██╗██║╚════██║",
---     "   ██║   ██║  ██║██║  ██║██║ ╚████║███████║",
---     "   ╚═╝   ╚═╝  ╚═╝╚═╝  ╚═╝╚═╝  ╚═══╝╚══════╝",
---}

lua/Trans/core/data.lua

@@ -1,53 +1,39 @@
 local Trans = require 'Trans'
 
-
----@class TransData
+---@class TransData: TransDataOption
+---@field mode string @The mode of the str
 ---@field from string @Source language type
 ---@field to string @Target language type
----@field is_word boolean @Is the str a word
 ---@field str string @The original string
----@field mode string @The mode of the str
 ---@field result table<string, TransResult|nil|false> @The result of the translation
 ---@field frontend TransFrontend
+---@field is_word? boolean @Is the str a word
 ---@field trace table<string, string> debug message
----@field backends table<string, TransBackend>
+---@field backends TransBackend[]
 local M = {}
 M.__index = M
 
 ---TransData constructor
----@param opts table
+---@param opts TransDataOption
 ---@return TransData
 function M.new(opts)
+
+    ---@cast opts TransData
     local mode     = opts.mode
-    local str  = opts.str
-
-
+    opts.result    = {}
+    opts.trace     = {}
     local strategy = Trans.conf.strategy[mode]
-    local data = setmetatable({
-        str    = str,
-        mode   = mode,
-        result = {},
-        trace  = {},
-    }, M)
 
 
-    data.frontend = Trans.frontend[strategy.frontend].new()
-    data.backends = {}
-    for i, name in ipairs(strategy.backend) do
-        data.backends[i] = Trans.backend[name]
-    end
+    ---@cast opts TransData
+    setmetatable(opts, M)
 
-    if Trans.util.is_english(str) then
-        data.from = 'en'
-        data.to = 'zh'
-    else
-        data.from = 'zh'
-        data.to = 'en'
-    end
 
-    data.is_word = Trans.util.is_word(str)
+    -- NOTE : whether should we use the default strategy
+    opts.frontend = Trans.frontend[strategy.frontend].new()
+    opts.backends = {}
 
-    return data
+    return opts
 end
 
 ---@class TransResult
@@ -67,12 +53,8 @@ end
 ---@return string? backend.name
 function M:get_available_result()
     local result = self.result
-
-    if result['offline'] then return result['offline'], 'offline' end
-
     for _, backend in ipairs(self.backends) do
         if result[backend.name] then
-            ---@diagnostic disable-next-line: return-type-mismatch
             return result[backend.name], backend.name
         end
     end

lua/Trans/core/debug.lua

@@ -0,0 +1,8 @@
+---@class Trans
+---@field debug fun(message: string, level: number?)
+
+return function (message, level)
+    level = level or vim.log.levels.INFO
+    -- TODO : custom messaage filter
+    vim.notify(message, level)
+end

lua/Trans/core/frontend.lua

@@ -1,32 +1,65 @@
 local Trans            = require 'Trans'
-local conf = Trans.conf
-local frontend_opts = conf.frontend
+
+---@class TransFrontendOpts
+local default_frontend = {
+    auto_play = true,
+    query     = 'fallback',
+    border    = 'rounded',
+    title     = vim.fn.has 'nvim-0.9' == 1 and {
+        { '', 'TransTitleRound' },
+        { ' Trans', 'TransTitle' },
+        { '', 'TransTitleRound' },
+    } or nil, -- need nvim-0.9+
+    ---@type {open: string | boolean, close: string | boolean, interval: integer} Window Animation
+    animation = {
+        open = 'slid', -- 'fold', 'slid'
+        close = 'slid',
+        interval = 12,
+    },
+    timeout   = 2000, -- only for online backend query
+}
+
+if Trans.conf.frontend.default then
+    default_frontend = vim.tbl_extend('force', default_frontend, Trans.conf.frontend.default)
+end
+
+local function empty_method(method)
+    return function() error('Method [' .. method .. '] not implemented') end
+end
 
 
 ---@class TransFrontend
----@field opts TransFrontendOpts
+---@field opts? TransFrontendOpts options which user can set
 ---@field get_active_instance fun():TransFrontend?
----@field process fun(self: TransFrontend, data: TransData)
 ---@field wait fun(self: TransFrontend): fun(backend: TransBackend): boolean Update wait status
 ---@field execute fun(action: string) @Execute action for frontend instance
----@field fallback fun() @Fallback method when no result
 ---@field setup? fun() @Setup method for frontend [optional] **NOTE: This method will be called when frontend is first used**
+local M = {
+    ---@type fun() @Fallback method when no result
+    fallback = empty_method 'fallback',
+    ---@type fun(self: TransFrontend, data: TransData) @render backend result
+    process = empty_method 'process',
+}
+
+
+
+
 
 ---@class Trans
 ---@field frontend TransFrontend
-return setmetatable({}, {
+return setmetatable(M, {
     __index = function(self, name)
-        local opts = vim.tbl_extend('keep', frontend_opts[name] or {}, frontend_opts.default)
-
         ---@type TransFrontend
         local frontend = require('Trans.frontend.' .. name)
 
-        frontend.opts = opts
-        self[name] = frontend
+        frontend.opts =
+            vim.tbl_extend('force', frontend.opts or {}, default_frontend, Trans.conf.frontend[name])
 
         if frontend.setup then
             frontend.setup()
         end
+
+        rawset(self, name, frontend)
         return frontend
     end,
 })

lua/Trans/core/helper.lua

@@ -0,0 +1,19 @@
+local fn, api = vim.fn, vim.api
+local Trans = require 'Trans'
+
+---@class TransHelper for Trans module dev
+local M = {}
+
+
+---Get abs_path of file
+---@param path string[]
+---@param is_dir boolean? [default]: false
+---@return string @Generated path
+function M.relative_path(path, is_dir)
+    return Trans.plugin_dir .. table.concat(path, Trans.separator) .. (is_dir and Trans.separator or '')
+end
+
+
+
+
+return M

lua/Trans/core/init.lua

@@ -0,0 +1,7 @@
+-- Return Core module
+local M = {}
+
+
+
+
+return M

lua/Trans/core/setup.lua

@@ -1,44 +1,31 @@
+---@class Trans
 local Trans = require 'Trans'
 
-local function set_strategy_opts(conf)
-    local all_backends = Trans.backend.all_name
-    local g_strategy = conf.strategy
+---@alias TransMode 'visual' 'input'
+local default_strategy = {
+    frontend = 'hover',
+    backend  = {
+        'offline',
+        -- 'youdao',
+        -- 'baidu',
+    },
+}
 
-    local function parse_backend(backend)
-        if type(backend) == 'string' then
-            return backend == '*' and all_backends or { backend }
-        end
+Trans.conf = {
+    ---@type string the directory for database file and password file
+    dir      = require 'Trans'.plugin_dir,
+    ---@type 'default' | 'dracula' | 'tokyonight' global Trans theme [@see lua/Trans/style/theme.lua]
+    theme    = 'default',
+    ---@type table<TransMode, { frontend:string, backend:string | string[] }> fallback strategy for mode
+    -- input = {
+    -- visual = {
+    -- ...
+    strategy = vim.defaulttable(function()
+        return setmetatable({}, default_strategy)
+    end),
+    frontend = {},
+}
 
-        return backend
-    end
-
-    local default_strategy = g_strategy.default
-    default_strategy.backend = parse_backend(default_strategy.backend)
-    default_strategy.__index = default_strategy
-
-    g_strategy.default = nil
-
-    setmetatable(g_strategy, {
-        __index = function()
-            return default_strategy
-        end,
-    })
-
-    for _, strategy in pairs(g_strategy) do
-        strategy.backend = parse_backend(strategy.backend)
-        setmetatable(strategy, default_strategy)
-    end
-end
-
-
-
-local function define_highlights(conf)
-    local set_hl     = vim.api.nvim_set_hl
-    local highlights = Trans.style.theme[conf.theme]
-    for hl, opt in pairs(highlights) do
-        set_hl(0, hl, opt)
-    end
-end
 
 
 ---@class Trans
@@ -50,6 +37,10 @@ return function(opts)
     local conf = Trans.conf
     conf.dir   = vim.fn.expand(conf.dir)
 
-    set_strategy_opts(conf)
-    define_highlights(conf)
+    -- INFO : set highlight
+    local set_hl     = vim.api.nvim_set_hl
+    local highlights = Trans.style.theme[conf.theme]
+    for hl, opt in pairs(highlights) do
+        set_hl(0, hl, opt)
+    end
 end

lua/Trans/core/translate.lua

@@ -1,92 +1,45 @@
 local Trans = require 'Trans'
-local util = Trans.util
 
-local function init_opts(opts)
+local function process(opts)
     opts = opts or {}
     opts.mode = opts.mode or vim.fn.mode()
-    opts.str = util.get_str(opts.mode)
-    return opts
-end
+    local str = Trans.util.get_str(opts.mode)
+    opts.str = str
 
 
----To Do Online Query
----@param data TransData @data
----@param backend TransOnlineBackend @backend
-local function do_query(data, backend)
-    -- TODO : template method for online query
-    local name      = backend.name
-    local uri       = backend.uri
-    local method    = backend.method
-    local formatter = backend.formatter
-    local query     = backend.get_query(data)
-    local header    = type(backend.header) == 'function' and backend.header(data) or backend.header
-
-    local function handle(output)
-        local status, body = pcall(vim.json.decode, output.body)
-        if not status or not body then
-            if not Trans.conf.debug then
-                backend.debug(body)
-                data.trace[name] = output
-            end
-
-            data.result[name] = false
+    if not str or str == '' then
+        Trans.debug 'No string to translate'
         return
     end
 
-        -- vim.print(data.result[name])
-        data.result[name] = formatter(body, data)
+
+    if opts.from == nil and opts.to == nil then
+        -- INFO : Default support [zh -> en] or [en -> zh]
+        if Trans.util.is_english(str) then
+            opts.from = 'en'
+            opts.to = 'zh'
+        else
+            opts.from = 'zh'
+            opts.to = 'en'
         end
-
-    Trans.curl[method](uri, {
-        query = query,
-        callback = handle,
-        header = header,
-    })
-    -- Hook ?
     end
+    assert(opts.from and opts.to, 'opts.from and opts.to must be set at the same time')
 
----@type table<string, fun(data: TransData):boolean>
-local strategy = {
-    fallback = function(data)
-        local result = data.result
-        Trans.backend.offline.query(data)
-
-        if result.offline then return true end
-
-        local update = data.frontend:wait()
-        for _, backend in ipairs(data.backends) do
-            do_query(data, backend)
-
-            local name = backend.name
-            ---@cast backend TransBackend
-            while result[name] == nil and update(backend) do
-            end
-
-            if result[name] then return true end
-        end
-
-        return false
-    end,
-    --- TODO :More Strategys
-}
-
-
--- HACK : Core process logic
-local function process(opts)
-    opts = init_opts(opts)
-    local str = opts.str
-    if not str or str == '' then return end
+    opts.is_word = opts.is_word or Trans.util.is_word(str)
 
 
     -- Find in cache
     if Trans.cache[str] then
         local data = Trans.cache[str]
-        data.frontend:process(data)
-        return
+        return data.frontend:process(data)
     end
 
+
+
+
+    -- Create new data
     local data = Trans.data.new(opts)
-    if strategy[data.frontend.opts.query](data) then
+    if Trans.strategy[data.frontend.opts.query](data) then
         Trans.cache[data.str] = data
         data.frontend:process(data)
     else
@@ -95,8 +48,17 @@ local function process(opts)
 end
 
 
+---@class TransDataOption
+---@field mode string?
+---@field frontend string?
+---@field from string? @Source language type
+---@field to string? @Target language type
+---@field is_word? boolean @Is the str a word
+
+
+
+--- NOTE : Use coroutine to stop and resume the process (for animation)
+
 ---@class Trans
----@field translate fun(opts: { frontend: string?, mode: string?}?) Translate string core function
-return function(opts)
-    coroutine.wrap(process)(opts)
-end
+---@field translate fun(opts: TransDataOption?) Translate string core function
+return function(...) coroutine.wrap(process)(...) end

lua/Trans/core/util.lua

@@ -3,7 +3,6 @@ local fn, api = vim.fn, vim.api
 ---@class TransUtil
 local M = require 'Trans'.metatable 'util'
 
-
 ---Get selected text
 ---@return string
 function M.get_select()
@@ -52,7 +51,7 @@ function M.get_lines()
         return vim.fn.getline(s_row)
     else
         local lines = vim.fn.getline(s_row, e_row)
-    return table.concat(lines, " ")
+        return table.concat(lines, ' ')
     end
 end
 
@@ -225,6 +224,13 @@ function M.list_fields(list, field)
     return ret
 end
 
+-- function M.checker(method, ...)
+--     -- TODO :Use function programming to simplify the code
+--     local params = { ... }
+
+-- end
+
+
 ---@class Trans
 ---@field util TransUtil
 return M

lua/Trans/core/window.lua

@@ -184,6 +184,7 @@ window.__index = window
 --     relative  = relative,
 -- }
 
+---@class TransWindowOpts
 local default_opts = {
     enter     = false,
     winid     = -1,
@@ -201,14 +202,10 @@ local default_opts = {
         focusable = true,
         noautocmd = true,
     },
+    animation = nil, ---@type table? Hover Window Animation
+    buffer    = nil, ---@type TransBuffer attached buffer object
 }
 
----@class TransWindowOpts
----@field buffer TransBuffer attached buffer object
----@field enter? boolean cursor should [enter] window when open,default: false
----@field win_opts WindowOpts window config [**When open**]
----@field animation? table? Hover Window Animation
-
 ---Create new window
 ---@param opts TransWindowOpts window config
 ---@return TransWindow

lua/Trans/frontend/float.lua

@@ -121,3 +121,34 @@ return M
 --     iciba   = 'iciba',
 --     offline = '本地',
 -- }
+
+
+-- TODO :
+-- float = {
+--     width = 0.8,
+--     height = 0.8,
+--     border = 'rounded',
+--     keymap = {
+--         quit = 'q',
+--     },
+--     animation = {
+--         open = 'fold',
+--         close = 'fold',
+--         interval = 10,
+--     },
+--     tag = {
+--         wait = '#519aba',
+--         fail = '#e46876',
+--         success = '#10b981',
+--     },
+-- },
+
+
+-- local title = {
+--     "████████╗██████╗  █████╗ ███╗   ██╗███████╗",
+--     "╚══██╔══╝██╔══██╗██╔══██╗████╗  ██║██╔════╝",
+--     "   ██║   ██████╔╝███████║██╔██╗ ██║███████╗",
+--     "   ██║   ██╔══██╗██╔══██║██║╚██╗██║╚════██║",
+--     "   ██║   ██║  ██║██║  ██║██║ ╚████║███████║",
+--     "   ╚═╝   ╚═╝  ╚═╝╚═╝  ╚═╝╚═╝  ╚═══╝╚══════╝",
+--}

lua/Trans/frontend/hover/execute.lua

@@ -5,9 +5,11 @@ local strategy = {
     pageup = function(hover)
         hover.buffer:normal 'gg'
     end,
+
     pagedown = function(hover)
         hover.buffer:normal 'G'
     end,
+
     pin = function(hover)
         if hover.pin then
             return
@@ -27,9 +29,11 @@ local strategy = {
 
         window:set('wrap', true)
     end,
+
     close = function(hover)
         hover:destroy()
     end,
+
     toggle_entry = function(hover)
         if api.nvim_get_current_win() ~= hover.window.winid then
             api.nvim_set_current_win(hover.window.winid)
@@ -48,6 +52,12 @@ local strategy = {
 ---@class TransHover
 ---@field execute fun(hover: TransHover, action: string)
 return function(hover, action)
-    -- TODO :
-    strategy[action](hover)
+    return strategy[action](hover)
 end
+
+-- This function will be called within coroutine, so we can't use __call
+-- return setmetatable(strategy, {
+--     __call = function(_, hover, action)
+--         return strategy[action](hover)
+--     end,
+-- })

lua/Trans/frontend/hover/init.lua

@@ -10,16 +10,84 @@ local util = Trans.util
 ---@field window TransWindow @hover window
 ---@field queue TransHover[] @hover queue for all hover instances
 ---@field destroy_funcs fun(hover:TransHover)[] @functions to be executed when hover window is closed
----@field opts TransHoverOpts @options for hover window
+---@field opts TransHoverOpts @hover window options
 ---@field pin boolean @whether hover window is pinned
 local M = Trans.metatable('frontend.hover', {
     ns = vim.api.nvim_create_namespace 'TransHoverWin',
     queue = {},
+    ---@class TransHoverOpts: TransFrontendOpts
+    opts = {
+        ---@type integer Max Width of Hover Window
+        width             = 37,
+        ---@type integer Max Height of Hover Window
+        height            = 27,
+        ---@type string -- see: /lua/Trans/style/spinner
+        spinner           = 'dots',
+        ---@type string
+        fallback_message  = '{{notfound}} {{error_message}}',
+        auto_resize       = true,
+        split_width       = 60,
+        padding           = 10, -- padding for hover window width
+        keymaps           = {
+            -- pageup       = '<C-u>',
+            -- pagedown     = '<C-d>',
+            -- pin          = '<leader>[',
+            -- close        = '<leader>]',
+            -- toggle_entry = '<leader>;',
+        },
+        ---@type string[] auto close events
+        auto_close_events = {
+            'InsertEnter',
+            'CursorMoved',
+            'BufLeave',
+        },
+        ---@type table<string, string[]> order to display translate result
+        order             = {
+            default = {
+                'str',
+                'translation',
+                'definition',
+            },
+            offline = {
+                'title',
+                'tag',
+                'pos',
+                'exchange',
+                'translation',
+                'definition',
+            },
+            youdao = {
+                'title',
+                'translation',
+                'definition',
+                'web',
+            },
+        },
+        icon              = {
+            -- or use emoji
+            list        = '●', -- ● | ○ | ◉ | ◯ | ◇ | ◆ | ▪ | ▫ | ⬤ | 🟢 | 🟡 | 🟣 | 🟤 | 🟠| 🟦 | 🟨 | 🟧 | 🟥 | 🟪 | 🟫 | 🟩 | 🟦
+            star        = '', -- ⭐ | ✴ | ✳ | ✲ | ✱ | ✰ | ★ | ☆ | 🌟 | 🌠 | 🌙 | 🌛 | 🌜 | 🌟 | 🌠 | 🌌 | 🌙 |
+            notfound    = ' ', --❔ | ❓ | ❗ | ❕|
+            yes         = '✔', -- ✅ | ✔️ | ☑
+            no          = '', -- ❌ | ❎ | ✖ | ✘ | ✗ |
+            cell        = '■', -- ■  | □ | ▇ | ▏ ▎ ▍ ▌ ▋ ▊ ▉
+            web         = '󰖟', --🌍 | 🌎 | 🌏 | 🌐 |
+            tag         = '',
+            pos         = '',
+            exchange    = '',
+            definition  = '󰗊',
+            translation = '󰊿',
+        },
+    },
 })
 M.__index = M
 
 
----Set up function which will be invoked when this module is loaded
+
+--[[
+Set up function which will be invoked when this module is loaded
+Because the options are not loaded yet when this module is loaded
+--]]
 function M.setup()
     local set = vim.keymap.set
     for action, key in pairs(M.opts.keymaps) do
@@ -89,6 +157,9 @@ end
 function M:init_window(opts)
     opts = opts or {}
     local m_opts = self.opts
+
+
+    ---@format disable-next
     local option = {
         buffer = self.buffer,
         animation = m_opts.animation,
@@ -139,7 +210,7 @@ function M:wait()
     local it      = util.node.item
     return function(backend)
         cur = cur + 1
-        buffer[1] = pr(backend.name_zh)
+        buffer[1] = pr(backend.display_text)
         buffer[2] = it { spinner[cur % size + 1] .. (cell):rep(cur), 'TransWaitting' }
         pause(interval)
         return cur < times

lua/Trans/health.lua

@@ -1,15 +1,15 @@
 local Trans      = require 'Trans'
 local health, fn = vim.health, vim.fn
 
-local ok         = health.report_ok
-local warn       = health.report_warn
-local error      = health.report_error
+local ok         = health.ok or health.report_ok
+local warn       = health.warn or health.report_warn
+local error      = health.error or health.report_error
 local has        = fn.has
 local executable = fn.executable
 
 local function check_neovim_version()
     if has 'nvim-0.9' == 1 then
-        ok [[You have [neovim-nightly] ]]
+        ok [[You have [neovim-0.9] ]]
     else
         warn [[Trans Title requires Neovim 0.9 or newer
         See neovim-nightly: [https://github.com/neovim/neovim/releases/tag/nightly]
@@ -42,7 +42,7 @@ local function check_binary_dependencies()
         win    = 'node',
         mac    = 'say',
         linux  = 'festival',
-        termux = 'termux-api-speak',
+        termux = 'termux-tts-speak',
     })[Trans.system]
 
 

lua/Trans/init.lua

@@ -5,19 +5,21 @@
 local function metatable(folder_name, origin)
     return setmetatable(origin or {}, {
         __index = function(tbl, key)
-            local status, result = pcall(require, ('Trans.%s.%s'):format(folder_name, key))
-            if status then
-                tbl[key] = result
+            local found, result = pcall(require, ('Trans.%s.%s'):format(folder_name, key))
+            if found then
+                rawset(tbl, key, result)
                 return result
             end
         end,
     })
 end
 
+
 ---@class string
 ---@field width function @Get string display width
 ---@field play function @Use tts to play string
 
+
 local uname = vim.loop.os_uname().sysname
 local system =
     uname == 'Darwin' and 'mac' or
@@ -25,29 +27,26 @@ local system =
     uname == 'Linux' and (vim.fn.executable 'termux-api-start' == 1 and 'termux' or 'linux') or
     error 'Unknown System, Please Report Issue'
 
-local sep = system == 'win' and '\\\\' or '/'
+
+local separator = system == 'win' and '\\\\' or '/'
+
 ---@class Trans
 ---@field style table @Style module
 ---@field cache table<string, TransData> @Cache for translated data object
 ---@field plugin_dir string @Plugin directory
 ---@field separator string @Path separator
 ---@field system 'mac'|'win'|'termux'|'linux' @Path separator
+---@field strategy table<string, fun(data: TransData):boolean> Translate string core function
 local M = metatable('core', {
     cache      = {},
     style      = metatable 'style',
-    separator  = sep,
+    strategy   = metatable 'strategy',
+    separator  = separator,
     system     = system,
-    plugin_dir = debug.getinfo(1, 'S').source:sub(2):match('(.-)lua' .. sep .. 'Trans'),
+    plugin_dir = debug.getinfo(1, 'S').source:sub(2):match('(.-)lua' .. separator .. 'Trans'),
 })
 
 M.metatable = metatable
 
----Get abs_path of file
----@param path string[]
----@param is_dir boolean?
----@return string
-function M.relative_path(path, is_dir)
-    return M.plugin_dir .. table.concat(path, sep) .. (is_dir and sep or '')
-end
 
 return M

lua/Trans/strategy/fallback.lua

@@ -0,0 +1,27 @@
+---Fallback query strategy
+---@param data TransData
+---@return boolean @true if query success
+return function(data)
+    local result = data.result
+    local update
+    for _, backend in ipairs(data.backends) do
+        local name = backend.name
+
+        if backend.no_wait then
+            ---@cast backend TransOfflineBackend
+            backend.query(data)
+        else
+            ---@cast backend TransOnlineBackend
+            require 'Trans'.backend.do_query(data, backend)
+            update = update or data.frontend:wait()
+
+            while result[name] == nil and update(backend) do
+            end
+        end
+
+        ---@cast backend TransBackend
+        if result[name] then return true end
+    end
+
+    return false
+end

lua/Trans/style/spinner.lua

@@ -393,14 +393,6 @@ return {
         '◉',
         '◎'
     },
-    star = {
-        '✶',
-        '✸',
-        '✹',
-        '✺',
-        '✹',
-        '✷'
-    },
     star2 = {
         '+',
         'x',