Merge branch 'experimental'

README.md

@@ -12,6 +12,7 @@
   - [高亮组](#高亮组)
   - [声明](#声明)
   - [感谢](#感谢)
+  - [贡献](#贡献)
   - [待办 (画大饼)](#待办-画大饼)
 <!--toc:end-->
 
@@ -20,6 +21,9 @@
 - 使用纯lua编写, 速度极快
 > `Lazy.nvim`的记录: <font color="#0099FF">`➜   Trans.nvim 0.82ms`</font>
 
+- **可以定义快捷键读英文单词**
+> 见wiki
+
 - 大部分功能可以自定义:
   - 高亮
   - 悬浮大小
@@ -93,15 +97,16 @@ use {
 use {
     "JuanZoran/Trans.nvim",
     keys = {
-        { 'v', 'mm' }, -- 换成其他你想用的key即可
+        { {'n', 'x'}, 'mm' }, -- 换成其他你想用的key即可
-        { 'n', 'mm' },
+        { {'n', 'x'}, 'mk' }, 
         { 'n', 'mi' },
     },
     run = 'bash ./install.sh', -- 自动下载使用的本地词库
     requires = 'kkharji/sqlite.lua',
     config = function()
         require("Trans").setup {} -- 启动Trans
-        vim.keymap.set({"v", 'n'}, "mm", '<Cmd>Translate<CR>', { desc = ' Translate' }) -- 自动判断virtual 还是 normal 模式
+        vim.keymap.set({"n", 'x'}, "mm", '<Cmd>Translate<CR>', { desc = ' Translate' }) -- 自动判断virtual 还是 normal 模式
+        vim.keymap.set({'n', 'x'}, 'mk', '<Cmd>TransPlay<CR>', {desc = ' 自动发音'}) -- 自动发音选中或者光标下的单词
         vim.keymap.set("n", "mi", "<Cmd>TranslateInput<CR>", { desc = ' Translate' })
     end
 }
@@ -117,6 +122,7 @@ use {
         keys = {
         -- 可以换成其他你想映射的键
             { 'mm', mode = { 'n', 'x' }, '<Cmd>Translate<CR>', desc = ' Translate' },
+            { 'mk', mode = { 'n', 'x' }, '<Cmd>TransPlay<CR>', desc = ' 自动发音' },
 
             -- 目前这个功能的视窗还没有做好，可以在配置里将view.i改成hover
             { 'mi', '<Cmd>TranslateInput<CR>', desc = ' Translate From Input' },
@@ -315,7 +321,8 @@ require'Trans'.setup {
 **示例:**
 > 示例中展示, 将`mm`映射成快捷键
 ```lua
-vim.keymap.set({'n', 'v'}, 'mm', '<Cmd>Translate<CR>')
+vim.keymap.set({'n', 'x'}, 'mm', '<Cmd>Translate<CR>')
+vim.keymap.set({'n', 'x'}, 'mk', '<Cmd>TransPlay<CR>') -- 自动发音选中或者光标下的单词
 vim.keymap.set('n', 'mi', '<Cmd>TranslateInput<CR>')
 
 ```
@@ -378,11 +385,16 @@ vim.keymap.set('n', 'mi', '<Cmd>TranslateInput<CR>')
 - [sqlite.lua](https://github.com/kharji/sqlite.lua)    数据库访问
 - [T.vim](https://github.com/sicong-li/T.vim)           灵感来源
 
+## 贡献
+> 更新比较频繁, 文档先鸽了  
+> 如果你想要参加这个项目, 可以提issue, 我会把文档补齐
+
 ## 待办 (画大饼)
 - [x] 多风格样式查询
 - [x] 重新录制屏幕截图示例 
+- [x] 快捷键定义 
+- [x] 自动读音 
+- [ ] 变量命名的支持
 - [ ] 历史查询结果保存
 - [ ] 在线多引擎异步查询 
-- [ ] 快捷键定义 
-- [x] 自动读音 
 - [ ] `句子翻译` | `中翻英` 的支持 

lua/Trans/init.lua

@@ -7,6 +7,28 @@ local title = vim.fn.has('nvim-0.9') == 1 and {
 } or nil
 
 
+string.width = vim.fn.strwidth
+string.isEn = function(self)
+    local char = { self:byte(1, -1) }
+    for i = 1, #self do
+        if char[i] > 127 then
+            return false
+        end
+    end
+    return true
+end
+
+
+string.play = vim.fn.has('linux') == 1 and function(self)
+    local cmd = ([[echo "%s" | festival --tts]]):format(self)
+    vim.fn.jobstart(cmd)
+end or function(self)
+    local seperator = vim.fn.has('unix') and '/' or '\\'
+    local file = debug.getinfo(1, "S").source:sub(2):match('(.*)lua') .. seperator .. 'tts' .. seperator .. 'say.js'
+    vim.fn.jobstart('node ' .. file .. ' ' .. self)
+end
+
+
 M.conf = {
     view = {
         i = 'float',
@@ -132,28 +154,93 @@ M.setup = function(opts)
 
     times = times + 1
     if times == 1 then
-        M.translate = require('Trans.translate')
+        local api = vim.api
+
+        local get_mode    = api.nvim_get_mode
+        local set_hl      = api.nvim_set_hl
+        local new_command = api.nvim_create_user_command
 
         if vim.fn.executable('sqlite3') ~= 1 then
             error('Please check out sqlite3')
         end
 
-        vim.api.nvim_create_user_command('Translate', function()
+        new_command('Translate', function()
             M.translate()
         end, { desc = '  单词翻译', })
 
-        vim.api.nvim_create_user_command('TranslateInput', function()
+        new_command('TranslateInput', function()
             M.translate('i')
         end, { desc = '  搜索翻译' })
 
+        new_command('TransPlay', function()
+            local word = M.get_word(get_mode().mode)
+            if word ~= '' and word:isEn() then
+                word:play()
+            end
+        end, { desc = ' 自动发音' })
 
         local hls = require('Trans.ui.theme')[conf.theme]
         for hl, opt in pairs(hls) do
-            vim.api.nvim_set_hl(0, hl, opt)
+            set_hl(0, hl, opt)
         end
     end
 end
 
+local function get_select()
+    local s_start = vim.fn.getpos("v")
+    local s_end = vim.fn.getpos(".")
+    if s_start[2] > s_end[2] or s_start[3] > s_end[3] then
+        s_start, s_end = s_end, s_start
+    end
+
+    local n_lines = math.abs(s_end[2] - s_start[2]) + 1
+    local lines = vim.api.nvim_buf_get_lines(0, s_start[2] - 1, s_end[2], false)
+    lines[1] = string.sub(lines[1], s_start[3], -1)
+    if n_lines == 1 then
+        lines[n_lines] = string.sub(lines[n_lines], 1, s_end[3] - s_start[3] + 1)
+    else
+        lines[n_lines] = string.sub(lines[n_lines], 1, s_end[3])
+    end
+    return table.concat(lines, '')
+end
+
+M.get_word = function(mode)
+    local word
+    if mode == 'n' then
+        word = vim.fn.expand('<cword>')
+    elseif mode == 'v' then
+        vim.api.nvim_input('<ESC>')
+        word = get_select()
+    elseif mode == 'i' then
+        -- TODO Use Telescope with fuzzy finder
+        vim.ui.input({ prompt = '请输入需要查询的单词: ' }, function(input)
+            word = input
+        end)
+    else
+        error('invalid mode: ' .. mode)
+    end
+    return word
+end
+
+
+M.translate = function(mode, view)
+    vim.validate {
+        mode = { mode, 's', true },
+        view = { view, 's', true }
+    }
+
+    mode = mode or vim.api.nvim_get_mode().mode
+    view = view or M.conf.view[mode]
+    assert(mode and view)
+    local word = M.get_word(mode)
+    if word == nil or word == '' then
+        return
+    else
+        require('Trans.view.' .. view)(word:gsub('^%s+', '', 1))
+    end
+end
+
+
 M.augroup = vim.api.nvim_create_augroup('Trans', { clear = true })
 
 return M

lua/Trans/query/baidu.lua

@@ -10,8 +10,8 @@ end
 
 local post = require('Trans.util.curl').POST
 
-local function get_field(word)
+local function get_field(word, isEn)
-    local to   = 'zh'
+    local to   = isEn and 'zh' or 'en'
     local tmp  = appid .. word .. salt .. appPasswd
     local sign = require('Trans.util.md5').sumhexa(tmp)
 
@@ -25,12 +25,12 @@ local function get_field(word)
     }
 end
 
---- this is a nice plugin
 ---返回一个channel
 ---@param word string
 ---@return table
 return function(word)
-    local query = get_field(word)
+    local isEn = word:isEn()
+    local query = get_field(word, isEn)
     local result = {}
 
     post(uri, {
@@ -39,11 +39,11 @@ return function(word)
             content_type = "application/x-www-form-urlencoded",
         },
         callback = function(str)
-            local res = vim.json.decode(str)
+            local ok, res = pcall(vim.json.decode, str)
-            if res and res.trans_result then
+            if ok and res and res.trans_result then
                 result.value = {
                     word = word,
-                    translation = res.trans_result[1].dst,
+                    [isEn and 'translation' or 'definition'] = res.trans_result[1].dst,
                 }
 
                 if result.callback then

lua/Trans/translate.lua

@@ -1,53 +0,0 @@
-local function get_select()
-    local s_start = vim.fn.getpos("v")
-    local s_end = vim.fn.getpos(".")
-    if s_start[2] > s_end[2] or s_start[3] > s_end[3] then
-        s_start, s_end = s_end, s_start
-    end
-
-    local n_lines = math.abs(s_end[2] - s_start[2]) + 1
-    local lines = vim.api.nvim_buf_get_lines(0, s_start[2] - 1, s_end[2], false)
-    lines[1] = string.sub(lines[1], s_start[3], -1)
-    if n_lines == 1 then
-        lines[n_lines] = string.sub(lines[n_lines], 1, s_end[3] - s_start[3] + 1)
-    else
-        lines[n_lines] = string.sub(lines[n_lines], 1, s_end[3])
-    end
-    return table.concat(lines, '')
-end
-
-local function get_word(mode)
-    local word
-    if mode == 'n' then
-        word = vim.fn.expand('<cword>')
-    elseif mode == 'v' then
-        vim.api.nvim_input('<ESC>')
-        word = get_select()
-    elseif mode == 'i' then
-        -- TODO Use Telescope with fuzzy finder
-        vim.ui.input({ prompt = '请输入需要查询的单词: ' }, function(input)
-            word = input
-        end)
-    else
-        error('invalid mode: ' .. mode)
-    end
-
-    return word
-end
-
-return function(mode, view)
-    vim.validate {
-        mode = { mode, 's', true },
-        view = { view, 's', true }
-    }
-
-    mode = mode or vim.api.nvim_get_mode().mode
-    view = view or require('Trans').conf.view[mode]
-    assert(mode and view)
-    local word = get_word(mode)
-    if word == nil or word == '' then
-        return
-    else
-        require('Trans.view.' .. view)(word:gsub('^%s+', '', 1))
-    end
-end

lua/Trans/util/animation.lua

@@ -3,25 +3,25 @@ local display = function(self)
 
     end
 
+    local target = self.times
     if self.sync then
-        local times = self.times
+        if target then
-        if times then
+            for i = 1, target do
-            for i = 1, self.times do
                 if self.run then
                     self:frame(i)
                 end
             end
+
         else
             while self.run do
                 self:frame()
             end
-            callback()
         end
 
+        callback()
     else
         local frame
-        if self.times then
+        if target then
-            local target = self.times
             local times = 0
             frame = function()
                 if self.run and times < target then

lua/Trans/view/hover.lua

@@ -105,7 +105,7 @@ local process = {
                 d = '限定词determiner ',
             }
 
-            local f = '%s %s%%'
+            local f = '%s %2s%%'
             for pos in vim.gsplit(m_result.pos, '/', true) do
                 m_content:addline(
                     it(m_indent .. f:format(pos_map[pos:sub(1, 1)], pos:sub(3)), 'TransPos')
@@ -143,12 +143,14 @@ local process = {
     end,
 
     translation = function()
-        title('中文翻译')
+        if exist(m_result.translation) then
+            title('中文翻译')
 
-        for trs in vim.gsplit(m_result.translation, '\n', true) do
+            for trs in vim.gsplit(m_result.translation, '\n', true) do
-            m_content:addline(
+                m_content:addline(
-                it(m_indent .. trs, 'TransTranslation')
+                    it(m_indent .. trs, 'TransTranslation')
-            )
+                )
+            end
         end
 
         m_content:newline('')
@@ -251,19 +253,15 @@ action = {
         end
     end,
 
-    play = vim.fn.has('linux') == 1 and function()
+    play = function()
-        local cmd = ([[echo "%s" | festival --tts]]):format(m_result.word)
+        m_result.word:play()
-        vim.fn.jobstart(cmd)
-    end or function()
-        local seperator = vim.fn.has('unix') and '/' or '\\'
-        local file = debug.getinfo(1, "S").source:sub(2):match('(.*)lua') .. seperator .. 'tts' .. seperator .. 'say.js'
-        vim.fn.jobstart('node ' .. file .. ' ' .. m_result.word)
     end,
 }
 
+
 local function handle()
     local hover = conf.hover
-    if hover.auto_play then
+    if m_result.translation and hover.auto_play then
         local ok = pcall(action.play)
         if not ok then
             vim.notify('自动发音失败， 请检查README发音部分', vim.log.WARN)
@@ -280,14 +278,13 @@ local function handle()
 end
 
 local function online_query(word)
-    -- TODO :Progress Bar
     local lists = {}
     local engines = conf.engines
     local size = #engines
     local icon = conf.icon
     local error_msg = icon.notfound .. '    没有找到相关的翻译'
     m_window:set_height(1)
-    local width = m_window.width
+    local origin_width = m_window.width
     m_window:set_width(error_msg:width())
 
     if size == 0 then
@@ -307,16 +304,19 @@ local function online_query(word)
 
     local timeout = conf.hover.timeout
     local interval = math.floor(timeout / (m_window.width - spinner[1]:width()))
+    local width = m_window.width
+
     local f = '%s %s'
     require('Trans.util.animation')({
-        times = m_window.width,
+        times = width,
+        interval = interval,
         frame = function(self, times)
             m_content:wipe()
             for i, v in ipairs(lists) do
                 local res = v.value
                 if res then
                     m_result = res
-                    m_window:set_width(width)
+                    m_window:set_width(origin_width)
                     handle()
                     m_content:attach()
 
@@ -327,26 +327,24 @@ local function online_query(word)
 
                     self.run = false
                     return
-                elseif res == 'false' then
+
+                elseif res == false then
                     table.remove(lists, i)
                     size = size - 1
                 end
             end
 
-            if size == 0 then
+            local line
-                m_content:addline(
+            if size == 0 or times == width then
-                    it(error_msg, 'TransFailed')
+                line = it(error_msg, 'TransFailed')
-                )
+                self.run = false
-                m_content:attach()
-
             else
-                m_content:addline(
+                line = it(f:format(spinner[times % range + 1], cell:rep(times)), 'MoreMsg')
-                    it(f:format(spinner[times % range + 1], cell:rep(times)), 'MoreMsg')
-                )
-                m_content:attach()
             end
+
+            m_content:addline(line)
+            m_content:attach()
         end,
-        interval = interval,
     }):display()
 end
 

lua/Trans/window.lua

@@ -2,8 +2,6 @@ local api = vim.api
 local new_content = require('Trans.content')
 local new_animation = require('Trans.util.animation')
 
-string.width = vim.fn.strwidth
-
 local busy = false
 local function lock()
     while busy do