mirai/mirai-console/backend/mirai-console/src/plugin/PluginFileExtensions.kt at dev · ProtocolScience/mirai · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
/*
 * Copyright 2019-2021 Mamoe Technologies and contributors.
 *
 * 此源代码的使用受 GNU AFFERO GENERAL PUBLIC LICENSE version 3 许可证的约束, 可以在以下链接找到该许可证.
 * Use of this source code is governed by the GNU AGPLv3 license that can be found through the following link.
 *
 * https://github.com/mamoe/mirai/blob/dev/LICENSE
 */

package net.mamoe.mirai.console.plugin

import net.mamoe.mirai.console.data.PluginConfig
import net.mamoe.mirai.console.data.PluginData
import net.mamoe.mirai.console.plugin.jvm.JvmPlugin
import java.io.File
import java.nio.file.Path


/**
 * 支持文件系统存储的扩展.
 *
 * @suppress 此接口只应由 [JvmPlugin] 继承
 *
 * @see JvmPlugin
 */
public interface PluginFileExtensions {
    /**
     * 数据目录路径
     * @see PluginData
     */
    public val dataFolderPath: Path

    /**
     * 数据目录. `dataFolderPath.toFile()`
     * @see PluginData
     */
    public val dataFolder: File


    /**
     * 从数据目录获取一个文件.
     * @see dataFolderPath
     */
    public fun resolveDataFile(relativePath: String): File = dataFolderPath.resolve(relativePath).toFile()

    /**
     * 从数据目录获取一个文件.
     * @see dataFolderPath
     */
    public fun resolveDataPath(relativePath: String): Path = dataFolderPath.resolve(relativePath)

    /**
     * 从数据目录获取一个文件.
     * @see dataFolderPath
     */
    public fun resolveDataFile(relativePath: Path): File = dataFolderPath.resolve(relativePath).toFile()

    /**
     * 从数据目录获取一个文件路径.
     * @see dataFolderPath
     */
    public fun resolveDataPath(relativePath: Path): Path = dataFolderPath.resolve(relativePath)


    /**
     * 插件配置保存路径
     * @see PluginConfig
     */
    public val configFolderPath: Path

    /**
     * 插件配置保存路径
     * @see PluginConfig
     */
    public val configFolder: File


    /**
     * 从配置目录获取一个文件.
     * @see configFolderPath
     */
    public fun resolveConfigFile(relativePath: String): File = configFolderPath.resolve(relativePath).toFile()

    /**
     * 从配置目录获取一个文件.
     * @see configFolderPath
     */
    public fun resolveConfigPath(relativePath: String): Path = configFolderPath.resolve(relativePath)

    /**
     * 从配置目录获取一个文件.
     * @see configFolderPath
     */
    public fun resolveConfigFile(relativePath: Path): File = configFolderPath.resolve(relativePath).toFile()

    /**
     * 从配置目录获取一个文件路径.
     * @see configFolderPath
     */
    public fun resolveConfigPath(relativePath: Path): Path = configFolderPath.resolve(relativePath)
}