Merge pull request #8 from JuanZoran/experimental

增加了本地自动播放单词发音

.gitignore

@@ -1,6 +1,7 @@
 lua/Trans/util/
 lua/Trans/test/
 note/
-go/
 demo.mp4
 screenshot.gif
+tts/node_modules/
+tts/package-lock.json

README.md

@@ -103,6 +103,12 @@ use {
     
   > 后续会增加 `healthcheck` 进行检查
 
+- **`auto_play`** 使用步骤:
+    - 需要确保安装了`nodejs`
+    - 进入插件的`tts`目录运行`npm install`
+        > 如果`install.sh`运行正常则自动安装，如果安装失败，请尝试手动安装
+    - linux 用户需要额外安装以下依赖:
+        > sudo apt-get install festival festvox-kallpc16k
 
 ## 配置
 ```lua
@@ -125,14 +131,24 @@ require'Trans'.setup {
             -- TODO :
             pageup = '[[',
             pagedown = ']]',
-            pin = '_', -- 将窗口固定在右上角, 参考demo
+            pin = '<leader>[',
-            close = '+',
+            close = '<leader>]',
+            toggle_entry = '<leader>;',
+            play = '_',
         },
         animation = {
-            open = 'slid', -- 可选的样式: slid , fold 
+            -- open = 'fold',
+            -- close = 'fold',
+            open = 'slid',
             close = 'slid',
-            interval = 12, -- 动画的帧间隔
+            interval = 12,
-        }
+        },
+        auto_close_events = {
+            'InsertEnter',
+            'CursorMoved',
+            'BufLeave',
+        },
+        auto_play = true, -- WARN : 请阅读说明
     },
     float = {
         width = 0.8,
@@ -167,14 +183,15 @@ require'Trans'.setup {
     },
     icon = {
         star = '',
-        notfound = '❔',
+        -- notfound = '❔',
-        yes = '✔️',
+        notfound = ' ',
-        no = '❌'
+        yes = ' ',
+        no = ''
+        -- yes = '✔️',
+        -- no = '❌'
         -- star = '⭐',
-        -- notfound = '',
-        -- yes = '',
-        -- no = ''
     },
+
     db_path = '$HOME/.vim/dict/ultimate.db',
 
     -- TODO :
@@ -264,11 +281,10 @@ vim.keymap.set('n', 'mi', '<Cmd>TranslateInput<CR>')
 - [T.vim](https://github.com/sicong-li/T.vim)           灵感来源
 
 ## 待办 (画大饼)
-- ~~移动光标自动关闭窗口~~
+- [x] 多风格样式查询
-- 多风格样式
+- [x] 重新录制屏幕截图示例 
-- 历史查询结果保存
+- [ ] 历史查询结果保存
-- 在线多引擎异步查询
+- [ ] 在线多引擎异步查询 
-- 快捷键定义
+- [ ] 快捷键定义 
-- 自动读音
+- [ ] 自动读音 
-- `句子翻译` | `中翻英` 的支持
+- [ ] `句子翻译` | `中翻英` 的支持 
-- 重新录制屏幕截图示例

install.sh

@@ -15,3 +15,4 @@ wget https://github.com/skywind3000/ECDICT-ultimate/releases/download/1.0.0/ecdi
 unzip /tmp/dict.zip -d $HOME/.vim/dict
 
 rm -rf /tmp/dict.zip
+cd ./tts/ && npm install

lua/Trans/content.lua

@@ -41,15 +41,16 @@ local content = {
         self.size = 0
     end,
 
-    attach = function(self)
+    ---将内容连接上对应的窗口
+    ---@param self table content对象
+    ---@param offset integer 起始行
+    attach = function(self, offset)
         if self.size == 0 then
             return
         end
 
         self.window:bufset('modifiable', true)
         local window = self.window
-        local offset = self.offset
-
         api.nvim_buf_set_lines(window.bufnr, offset, offset + 1, true, self.lines)
 
         for _, hl in ipairs(self.highlights) do
@@ -58,8 +59,9 @@ local content = {
         self.window:bufset('modifiable', false)
     end,
 
-    actual_height = function(self)
+    actual_height = function(self, wrap)
-        if self.window:option('wrap') then
+        wrap = wrap or self.window:option('wrap')
+        if  wrap then
             local height = 0
             local width = self.window.width
             local lines = self.lines
@@ -67,6 +69,7 @@ local content = {
                 height = height + math.max(1, (math.ceil(lines[i]:width() / width)))
             end
             return height
+
         else
             return self.size
         end
@@ -151,13 +154,12 @@ local content = {
 ---content的构造函数
 ---@param window table 链接的窗口
 ---@return table 构造好的content
-return function(window, offset)
+return function(window)
     vim.validate {
         window = { window, 't' },
     }
     return setmetatable({
         modifiable = true,
-        offset = offset or 0,
         window = window,
         size = 0,
         hl_size = 0,

lua/Trans/init.lua

@@ -19,9 +19,10 @@ M.conf = {
             -- TODO :
             pageup = '[[',
             pagedown = ']]',
-            pin = '+',
+            pin = '<leader>[',
-            close = '_',
+            close = '<leader>]',
-            toggle_entry = '--',
+            toggle_entry = '<leader>;',
+            play = '_',
         },
         animation = {
             -- open = 'fold',
@@ -35,6 +36,7 @@ M.conf = {
             'CursorMoved',
             'BufLeave',
         },
+        auto_play = true,
     },
     float = {
         width = 0.8,
@@ -69,14 +71,15 @@ M.conf = {
     },
     icon = {
         star = '',
-        notfound = '❔',
+        -- notfound = '❔',
-        yes = '✔️',
+        notfound = ' ',
-        no = '❌'
+        yes = ' ',
+        no = ''
+        -- yes = '✔️',
+        -- no = '❌'
         -- star = '⭐',
-        -- notfound = '',
-        -- yes = '',
-        -- no = ''
     },
+
     db_path = '$HOME/.vim/dict/ultimate.db',
 
     -- TODO :

lua/Trans/setup.lua

@@ -2,6 +2,7 @@ if vim.fn.executable('sqlite3') ~= 1 then
     error('Please check out sqlite3')
 end
 
+
 vim.api.nvim_create_user_command('Translate', function()
     require("Trans").translate()
 end, { desc = '  单词翻译', })

lua/Trans/translate.lua

@@ -31,6 +31,7 @@ local function get_word(mode)
     end
 end
 
+
 local function translate(mode, view)
     vim.validate {
         mode = { mode, 's', true },

lua/Trans/view/float.lua

@@ -2,7 +2,7 @@ local m_window
 local m_result
 
 local function set_title()
-    local title = m_window.title
+    local title = m_window.contents[1]
     local github = 'https://github.com/JuanZoran/Trans.nvim'
 
     -- TODO :config this
@@ -10,7 +10,7 @@ local function set_title()
 end
 
 local action = {
-    quit = function ()
+    quit = function()
         m_window:try_close()
     end,
 }
@@ -21,7 +21,7 @@ return function(word)
     local float = require('Trans').conf.float
     m_result    = require('Trans.query.offline')(word)
 
-    local opt = {
+    local opt          = {
         relative = 'editor',
         width    = float.width,
         height   = float.height,
@@ -30,7 +30,7 @@ return function(word)
         row      = math.floor((vim.o.lines - float.height) / 2),
         col      = math.floor((vim.o.columns - float.width) / 2),
     }
-    m_window    = require('Trans.window')(true, opt)
+    m_window           = require('Trans.window')(true, opt)
     m_window.animation = float.animation
 
     set_title()

lua/Trans/view/hover.lua

@@ -186,6 +186,8 @@ end
 
 local action
 local next
+local _word
+
 action = {
     pageup = function()
         m_window:normal('gg')
@@ -251,7 +253,12 @@ action = {
         else
             vim.keymap.del('n', conf.hover.keymap.toggle_entry, { buffer = true })
         end
-    end
+    end,
+
+    play = function()
+        local file = debug.getinfo(1, "S").source:sub(2):match('(.*)lua/') .. 'tts/say.js'
+        vim.fn.jobstart('node ' .. file .. ' ' .. _word)
+    end,
 }
 
 
@@ -259,11 +266,15 @@ return function(word)
     vim.validate {
         word = { word, 's' },
     }
-
+    _word       = word
     -- 目前只处理了本地数据库的查询
     m_result    = require('Trans.query.offline')(word)
     local hover = conf.hover
-    local opt   = {
+    if hover.auto_play then
+        action.play()
+    end
+
+    local opt = {
         relative = 'cursor',
         width    = hover.width,
         height   = hover.height,
@@ -275,7 +286,7 @@ return function(word)
 
     m_window = require("Trans.window")(false, opt)
     m_window.animation = hover.animation
-    m_content = m_window.content
+    m_content = m_window.contents[1]
 
     if m_result then
         for _, field in ipairs(conf.order) do
@@ -283,9 +294,16 @@ return function(word)
         end
     else
         process.failed()
+        m_window:set_width(m_content.lines[1]:width())
+    end
+
+    m_window:draw()
+
+    local height = m_content:actual_height(true)
+    if height < m_window.height then
+        m_window:set_height(height)
     end
 
-    m_window:draw(true)
     m_window:open(function()
         m_window:set('wrap', true)
     end)
@@ -304,7 +322,9 @@ return function(word)
         end,
     })
 
-    for act, key in pairs(hover.keymap) do
+    if m_result then
-        vim.keymap.set('n', key, action[act], { buffer = true, silent = true })
+        for act, key in pairs(hover.keymap) do
+            vim.keymap.set('n', key, action[act], { buffer = true, silent = true })
+        end
     end
 end

lua/Trans/window.lua

@@ -83,23 +83,12 @@ local window = {
 
     ---**第一次**绘制窗口的内容
     ---@param self table 窗口的对象
-    ---@param adjust boolean 是否需要调整窗口的高度和宽度 (只有窗口只有一行时才会调整宽度)
+    draw = function(self)
-    draw = function(self, adjust)
         -- TODO :
-        if self.title then
+        local offset = 0
-            self.title:attach()
+        for _, content in ipairs(self.contents) do
-        end
+            content:attach(offset)
-        self.content:attach()
+            offset = offset + content.size
-
-        if adjust then
-            local height = self.content:actual_height() + self.title:actual_height()
-            if self.height > height then
-                self:set_height(height)
-            end
-
-            if self.content.size == 1 and self.title.size == 0 then
-                self:set_width(self.content.lines[1]:width())
-            end
         end
     end,
 
@@ -207,20 +196,18 @@ local window = {
 }
 
 ---@class window
----@field title table 窗口不变的title对象,载入后不可修改
 ---@field winid integer 窗口的handle
 ---@field bufnr integer 窗口对应buffer的handle
----@field content table 窗口内容的对象, 和title一样是content类
 ---@field width integer 窗口当前的宽度
 ---@field height integer 窗口当前的高度
 ---@field hl integer 窗口highlight的namespace
-
+---@field contents table[] 窗口内容的对象数组
 
 
 ---窗口对象的构造器
 ---@param entry boolean 光标初始化时是否应该进入窗口
 ---@param option table 需要设置的选项
----@return window
+---@return window win
 ---@nodiscard
 return function(entry, option)
     vim.validate {
@@ -249,34 +236,24 @@ return function(entry, option)
     local bufnr = api.nvim_create_buf(false, true)
     local winid = api.nvim_open_win(bufnr, entry, opt)
 
-    local win = setmetatable({
-        winid   = winid,
-        bufnr   = bufnr,
-        title   = nil,
-        content = nil,
-        width   = opt.width,
-        height  = opt.height,
-        hl      = api.nvim_create_namespace('TransWinHl'),
-    },
-        { __index = function(tbl, key)
-            if key == 'content' then
-                if tbl.title then
-                    tbl.content = require('Trans.content')(tbl, tbl.title.size)
-                    tbl.title.modifiable = false
-                else
-                    tbl.content = require('Trans.content')(tbl)
-                end
-                return tbl.content
 
-            elseif key == 'title' then
+    local win
-                tbl.title = require('Trans.content')(tbl, 0)
+    win = {
-                return tbl.title
+        winid    = winid,
-
+        bufnr    = bufnr,
-            else
+        width    = opt.width,
-                return window[key]
+        height   = opt.height,
+        hl       = api.nvim_create_namespace('TransWinHl'),
+        contents = setmetatable({}, {
+            __index = function(self, key)
+                assert(type(key) == 'number')
+                self[key] = require('Trans.content')(win)
+                return self[key]
             end
-        end })
+        })
+    }
 
+    setmetatable(win, { __index = window })
     win:set('winhl', 'Normal:TransWin,FloatBorder:TransBorder')
     win:bufset('filetype', 'Trans')
     win:bufset('buftype', 'nofile')

tts/package.json

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "say": "^0.16.0"
+  }
+}

tts/say.js

@@ -0,0 +1,6 @@
+const say = require('say')
+
+word = process.argv
+
+// console.log(word)
+say.speak(word.slice(2))