简介

EasyGo借鉴了wox的插件架构,尤其是python插件,几乎差不多,所以如果你开发过wox的python插件,那么可以很容易的将它移植到EasyGo上面来

架构

插件的整体架构如图

插件接口介绍

插件导出三个基本接口函数供EasyGo调用,大概介绍如下:

#ifdef CMDPLUGIN_EXPORTS
#define CMDPLUGIN_API extern "C" __declspec(dllexport)
#else
#define CMDPLUGIN_API extern "C" __declspec(dllimport)
#endif

CMDPLUGIN_API bool InitPlugin(char* pPluginPath);
CMDPLUGIN_API bool Query(char* pQuery, char* pResult, int* length);
CMDPLUGIN_API bool GetContextMenu(char* result, char* pMenu, int* length);

/**
 * 初始化插件,插件可以在这里做一些准备性工作,比如保存传入的插件路径,用来创建配置文件
 * [in] pPluginPath:当前插件位于的文件夹路径
 */
bool InitPlugin(char* pPluginPath)
{
    return true;
}

/**
 * 查询函数,使用EasyGo传入的查询关键字来获取结果列表并返回
 * [in] pQuery:用户输入的查询文字,格式为json字符串
 * [out] pResult:用户返回的结果数组,格式为json字符串
 * [in_out] length:pResult的空间大小
 *EasyGo会进行两次调用,第一次调用,pResult = NULL,我们需要返回结果的长度,然后EasyGo会根据返回的length为pResult分配
 * 足够大的空间,然后传入pResult指针来获取结果,使用完毕后记得释放pResult的内存
 */
bool Query(char* pQuery, char* pResult, int* length)
{
    return true;
}

/**
 * 获取针对某条结果的菜单选项,一般用不上,我们返回false即可
 * [in] result:结果列表中的某一条结果,格式为json字符串
 * [out] pMenu:返回的菜单数组,格式为json字符串
 * [in_out] length:  pMenu的空间大小,同Query函数,会调用两次
 *
 */
bool GetContextMenu(char* result, char* pMenu, int* length)
{
    return true;
}

数据结构介绍

接着我们来说明一下这三个函数涉及到的json字符串结构

bool Query(char* pQuery, char* pResult, int* length)

参数:pQuery

{
    "RawQuery": "lm xxxx",
    "Keyword": "lm",
    "Parameter": "xxxx"
}

它可以转化为下面的结构体

struct QueryText{
    string rawQuery;
    string keyword;
    string parameter;
};

参数:pResult

{
    "Results": [
        {
            "Title": "结果1",
            "SubTitle": "这是结果1",
            "IconPath": "app.png",
            "Action": {
                "FuncName": "Ra_CopyPath",
                "Parameter": "参数",
                "HideWindow": true
            }
        },
        {
            "Title": "结果2",
            "SubTitle": "这是结果2",
            "IconPath": "app.png",
            "Action": {
                "FuncName": "Ra_CopyPath",
                "Parameter": "参数",
                "HideWindow": true
            }
        }
    ]
}

它可以转化成如下的结构体

struct PluginAction{
    string funcName;          //响应的函数名,如果是自定义函数,需要将此函数导出,函数声明为 void funcName(char* parameter);
    string parameter;         //传入函数的参数,如果你有许多参数,请使用json字符串传入
    bool hideWindow;      //用户回车或者单击完成操作后是否隐藏EasyGo输入窗口

    PluginAction(){
        hideWindow = true;
    }
};

//这个是Result的完整结构体,Query和GetContextMenu函数的一些参数都只是用了其中部分参数
struct Result{
    string id;          //这个是插件id,由EasyGo赋值
    string title;       //这是EasyGo上行文字
    string subTitle;       //这是EasyGo下行文字
    string iconPath;     //这是图标路径,如果为空那么默认使用插件图标
    string extraData;    //这是额外数据,如果你想在GetContextMenu中获取一些自定义数据进行一些操作,那么可以用这个,可以为空
    PluginAction action;   // 这个是Result的响应函数定义,定义用户回车或者鼠标左击的操作
};

bool GetContextMenu(char* result, char* pMenu, int* length)

参数:result

{
    "ID": "6064551FD7904BD09D23FB9CA9F4CD03",
    "Title": "结果1",
    "SubTitle": "这是结果1",
    "ExtraData": "这个是可选的,由Query中赋值得来"
}

参数:pMenu
同Query函数的pResult,是json数组

EasyGo提供给插件的接口

EasyGo提供给插件的有两种类型接口,主动的和被动的,大部分是被动调用,涉及到 PluginAction 结构体。
PluginAction里面有个FuncName,在EasyGo里面定义了一些常用的函数,方便用户调用,名字和作用如下:
Ra_CopyPath : 会拷贝Parameter文字内容到剪切板
Ra_Copy:这个会拷贝Parameter指定的文件到剪切板,你可以在桌面上进行粘贴文件操作
Ra_CopyImage:拷贝图片到剪切板,可以进行图片粘贴操作
Ra_ChangeQuery:会设置EasyGo输入框的值为Parameter字符串,如果和之前输入框的文字不同会触发一次查询操作
Ra_Delete:删除Paramter参数指定的文件或者文件夹 (不可恢复,非移动到回收站,请注意)
Ra_Recycle:删除Paramter参数指定的文件或者文件夹到回收站
Ra_Open:打开Parameter指定的可执行程序或者文件夹
Ra_OpenFileFolder:打开Parameter指定文件路径所在的文件夹
Ra_OpenWeb:打开Parameter指定的网址
Ra_ShowContent : 会弹出一个文本浏览框显示你传入的Parameter内容,纯文本
以上是被动调用的,根据返回的结果来进行用户点击的响应设置
然后是主动的,主动的目前只提供了如下函数,可以直接使用GetProcAddr来获取此导出函数的函数指针进行调用
void Ra_ChangeQuery(const char* strQuery) : 修改输入框的查询字符串,query为字符串类型,如果文本发生改变会触发重新查询
void Ra_ReQuery() : 强制重新查询
void Ra_Reload() : 重载

配置文件

{
  "ID":"98451A7B5C764F6A9A3814EF7E4AFEEC",        这个是guid唯一标示
  "Keyword":"guid",                 这个是插件关键字,用户使用该默认关键字出发插件功能
  "Name":"生成Guid",              插件名
  "Description":"生成Guid",           插件描述
  "Author":"zsxeee",                 插件作者
  "Version":"1.0.0",                   插件版本
  "PluginType":"python",           插件类型,目前只有c++和python两种
  "PluginMode":"EnterMode",        插件模式,EnterMode或者RealMode,此字段可以省略,默认为RealMode
  "AcceptType": "png,ico,folder",    插件支持的拖入的文件类型,就是文件的后缀名,其中唯一特殊的是folder,代表插件可以接受文件夹路径参数
  "IconPath": "img\\app.png",        插件图标
  "ExeName":"Main.py" ,               插件源文件名字
  "CfgPath": "set.json"     插件的配置选项,可以用相对路径,可以指定配置文件名也可以指定设置界面程序。配置文件或者配置程序会在插件管理界面右键设置打开
}

插件打包

插件打包后的格式是 插件名.Plugin ,其实就是将插件的三个文件打包成zip文件,然后把zip后缀改成Plugin即可,记住了,打包的时候插件的外层不要有文件夹

具体的使用方法请参考示例

0
赞赏

微信赞赏支付宝赞赏