mirror of
https://github.com/RubyMetric/chsrc
synced 2026-02-02 15:50:29 +08:00
194 lines
6.5 KiB
C
194 lines
6.5 KiB
C
/** ------------------------------------------------------------
|
||
* SPDX-License-Identifier: GPL-3.0-or-later
|
||
* -------------------------------------------------------------
|
||
* File Name : struct.h
|
||
* File Authors : @ccmywish
|
||
* | @G_I_Y
|
||
* Contributors : @livelycode36
|
||
* |
|
||
* Created On : <2023-08-29>
|
||
* Last Modified : <2026-01-21>
|
||
*
|
||
* chsrc struct
|
||
* ------------------------------------------------------------*/
|
||
|
||
typedef struct ProviderSpeedMeasureInfo_t
|
||
{
|
||
bool skip; /* 是否默认跳过 */
|
||
char *skip_reason_CN; /* 跳过的原因（中文）*/
|
||
char *skip_reason_EN; /* 跳过的原因（英文）*/
|
||
char *url; /* 测速链接 */
|
||
bool accurate; /* 是否为精准测速，上游源和专用镜像站为 ACCURATE，通用镜像站为 ROUGH */
|
||
}
|
||
ProviderSpeedMeasureInfo_t;
|
||
|
||
#define SKIP true
|
||
#define NotSkip false
|
||
#define ToFill NULL
|
||
#define NA NULL
|
||
|
||
#define ACCURATE true
|
||
#define ROUGH false
|
||
|
||
typedef enum ProviderType_t
|
||
{
|
||
IS_GeneralMirrorSite, /* 通用镜像站 */
|
||
IS_DedicatedMirrorSite, /* 专用镜像站 */
|
||
IS_UpstreamProvider, /* 上游默认源 */
|
||
IS_UserDefinedProvider, /* 用户提供 */
|
||
}
|
||
ProviderType_t;
|
||
|
||
typedef struct SourceProvider_t
|
||
{
|
||
const ProviderType_t type; /* 类型 */
|
||
const char *code; /* 用于用户指定某一 Provider */
|
||
const char *abbr; /* 需要使用 Provider 的英文名时，用这个代替，因为大部分 Provider 没有提供正式的英文名 */
|
||
const char *name; /* Provider 中文名 */
|
||
const char *site; /* Provider 首页 */
|
||
ProviderSpeedMeasureInfo_t psmi;
|
||
}
|
||
SourceProvider_t;
|
||
|
||
typedef SourceProvider_t MirrorSite_t;
|
||
|
||
SourceProvider_t UpstreamProvider =
|
||
{
|
||
IS_UpstreamProvider,
|
||
/* 引入新的上游默认源时，请使下面第一行的前三个字段保持不变，只添加第四个字段 */
|
||
"upstream", "Upstream", "上游默认源", NULL,
|
||
/* 引入新的上游默认源时，请完全修改下面这个结构体，可使用 def_need_measure_info 宏 */
|
||
{SKIP, "URL未知，邀您参与贡献!", "URL unknown, welcome to contribute!", NULL, ACCURATE}
|
||
};
|
||
|
||
#define def_need_measure_info {SKIP, "缺乏较大的测速对象，邀您参与贡献!", "Lack of large object URL, welcome to contribute!", NULL, ACCURATE}
|
||
|
||
SourceProvider_t UserDefinedProvider =
|
||
{
|
||
IS_UserDefinedProvider,
|
||
"user", "用户自定义", "用户自定义", NULL,
|
||
{SKIP, "用户自定义源不测速", "SKIP for user-defined source", NULL, ACCURATE}
|
||
};
|
||
|
||
|
||
typedef struct Source_t
|
||
{
|
||
union {
|
||
SourceProvider_t *provider;
|
||
MirrorSite_t *mirror;
|
||
};
|
||
/* 用于换源的 URL */
|
||
char *url;
|
||
|
||
/* 对该 source 的专用测速链接，这就是精准测速 */
|
||
char *speed_measure_url;
|
||
}
|
||
Source_t;
|
||
|
||
/* 不用给专用测速链接，因为 Upstream 的整体测速链接已是精准测速 */
|
||
#define DelegateToUpstream NULL
|
||
/* 不用给专用测速链接，因为该镜像站是专用镜像站，其整体测速链接已是精准测速 */
|
||
#define DelegateToMirror NULL
|
||
/* 看到该注释的贡献者，你可以帮忙寻找专用测速链接 */
|
||
#define NeedContribute NULL
|
||
/* 由 prelude() 填充 */
|
||
#define FeedByPrelude NULL
|
||
|
||
|
||
typedef enum Capability_t
|
||
{
|
||
CanNot,
|
||
FullyCan,
|
||
PartiallyCan
|
||
}
|
||
Capability_t;
|
||
|
||
|
||
|
||
typedef struct Contributor_t
|
||
{
|
||
char *id; /* 全局唯一贡献者标识符，防止反复写信息，以 @ 开头 */
|
||
char *name; /* 贡献者姓名; 鉴于该项目完全依赖于贡献者，建议留下真实姓名或者昵称 */
|
||
char *email;
|
||
char *display_name; /* recipe 结束时会显示贡献者信息，如果你不愿显示真实姓名或者昵称，可以另外提供一个名字 */
|
||
}
|
||
Contributor_t;
|
||
|
||
|
||
typedef struct Target_t
|
||
{
|
||
/* 以 / 为分隔符的多个目标别名 */
|
||
char *aliases;
|
||
|
||
void (*getfn) (char *option);
|
||
void (*setfn) (char *option);
|
||
void (*resetfn) (char *option);
|
||
|
||
/* 初始化函数，用于填充该 struct 的各种信息 */
|
||
void (*preludefn) (void);
|
||
bool inited; /* 是否执行过了 preludefn() */
|
||
|
||
Source_t *sources;
|
||
int sources_n;
|
||
|
||
|
||
/* Features */
|
||
bool can_english; /* 是否支持英文输出 */
|
||
|
||
bool can_user_define; /* 是否支持用户自定义URL来换源 */
|
||
char *can_user_define_explain; /* 用户自定义URL的说明 */
|
||
|
||
Capability_t cap_local; /* 是否支持 local mode */
|
||
char *cap_local_explain; /* local mode 的说明 */
|
||
|
||
char *note; /* 备注 */
|
||
|
||
|
||
/* recipe 维护信息 */
|
||
char *created_on;
|
||
char *last_updated;
|
||
char *sources_last_updated;
|
||
|
||
Contributor_t *chef; /* 该 recipe *当前*的总负责人 (可以任职也可以休职) */
|
||
Contributor_t **cooks; /* 该 recipe 的主要作者 */
|
||
int cooks_n;
|
||
Contributor_t **sauciers; /* 该 recipe 的次要贡献者 (除主要作者外的其他人) */
|
||
int sauciers_n;
|
||
}
|
||
Target_t;
|
||
|
||
|
||
|
||
#define def_target(t, aliases) void t##_getsrc(char *option);void t##_setsrc(char *option);void t##_resetsrc(char *option); Target_t t##_target={aliases};
|
||
|
||
#define chef_allow_gsr(t) this->getfn = t##_getsrc; this->setfn = t##_setsrc; this->resetfn = t##_resetsrc;
|
||
#define chef_allow_s(t) this->getfn = NULL; this->setfn = t##_setsrc; this->resetfn = NULL;
|
||
#define chef_allow_sr(t) this->getfn = NULL; this->setfn = t##_setsrc; this->resetfn = t##_resetsrc;
|
||
#define chef_allow_gs(t) this->getfn = t##_getsrc; this->setfn = t##_setsrc; this->resetfn = NULL;
|
||
#define chef_allow_NOOP(t)
|
||
#define chef_prep_this(t,op) Target_t *this = &t##_target; this->inited = true; chef_allow_##op(t);
|
||
|
||
#define chef_use_this(t) Target_t *this = &t##_target;
|
||
#define chsrc_use_this_source(t) Target_t *this = &t##_target; Source_t source = chsrc_yield_source_and_confirm (this, option);
|
||
|
||
/**
|
||
* 用于定义换源列表
|
||
*
|
||
* def_sources_begin()
|
||
* {&UpstreamProvider, "换源URL", "精准测速链接"},
|
||
* {&某镜像站1, "换源URL", "精准测速链接"},
|
||
* {&某镜像站2, "换源URL", NULL }, // 若精准测速链接为空，则为模糊测速，默认使用该镜像站的整体测速链接
|
||
* def_sources_end()
|
||
*
|
||
* 若是出于代码美观考虑，上述第三列可以写 FeedByPrelude，然后下面调用函数来填充:
|
||
* chef_set_smurl()
|
||
* chef_set_all_smurl_with_postfix()
|
||
* chef_set_all_smurl_with_func()
|
||
*/
|
||
#define def_sources_begin() Source_t sources[] = {
|
||
#define def_sources_end() }; \
|
||
this->sources_n = xy_c_array_len(sources); \
|
||
char *_sources_storage = xy_malloc0 (sizeof(sources)); \
|
||
memcpy (_sources_storage, sources, sizeof(sources)); \
|
||
this->sources = (Source_t *)_sources_storage;
|