scheme.tl Understanding the Type Language

Qter · 发表于 2020-2-27 11:22:20

https://docs.telethon.dev/en/lat ... -type-language.html
Understanding the Type Language¶

Telegram’s Type Language(also known as TL, found on .tl files) is a concise way to definewhat other programming languages commonly call classes or structs.

Every definition is written as follows for a Telegram object is definedas follows:

name#id argument_name:argument_type = CommonType

This means that in a single line you know what the TLObject name is.You know it’s unique ID, and you know what arguments it has. It reallyisn’t that hard to write a generator for generating code to anyplatform!

The generated code should also be able to encode the TLObject (letthis be a request or a type) into bytes, so they can be sent over thenetwork. This isn’t a big deal either, because you know how theTLObject’s are made, and how the types should be serialized.

You can either write your own code generator, or use the one thislibrary provides, but please be kind and keep some special mention tothis project for helping you out.

This is only a introduction. The TL language is not that easy. Butit’s not that hard either. You’re free to sniff thetelethon_generator/ files and learn how to parse other more complexlines, such as flags (to indicate things that may or may not bewritten at all) and vector’s.

Qter · 发表于 2020-2-27 11:33:04

https://tl.telethon.dev/

Qter · 发表于 2020-2-27 14:52:57

本帖最后由 Qter 于 2020-2-27 15:47 编辑

1>------ 已启动全部重新生成: 项目: lib_scheme, 配置: Debug Win32 ------
1>Cleaning... 0 files.
1>ninja: Entering directory `..\out\Debug\'
1>[1/4] ACTION codegen_scheme-ing scheme.tl..
1>EXEC : warning : counted 505bce7 mismatch with provided 3b9acde9 (auth.kefuLogin#3b9acde9, auth.kefuLogin kefu_login_name:string kefu_login_password:string auth_code:string = auth.Authorization)
1>
1>[2/4] STAMP obj\lib_scheme.actions_rules_copies.stamp
1>[3/4] CXX obj\gen\lib_scheme.scheme.obj
1>注意: 包含文件: D:\TBuild\longchat-tdesktop\out\Debug\gen\scheme.h

codegen_scheme.py 里对key值生成方法进行了验证
countTypeId = binascii.crc32(binascii.a2b_qp(cleanline));
if (typeid != countTypeId):
print('Warning: counted ' + countTypeId + ' mismatch with provided ' + typeid + ' (' + key + ', ' + cleanline + ')' + '-->' +countTypeId);

Qter · 发表于 2020-3-2 11:52:50

本帖最后由 Qter 于 2020-3-2 11:58 编辑

scheme.tl中的定义

messages.sendMessage#fa88427a flags:# no_webpage:flags.1?true silent:flags.5?true background:flags.6?true clear_draft:flags.7?true peer:InputPeer reply_to_msg_id:flags.0?int message:string random_id:long reply_markup:flags.2?ReplyMarkup entities:flags.3?Vector<MessageEntity> = Updates;

复制代码

自动生成的代码
scheme.h

class MTPmessages_sendMessage { // RPC method 'messages.sendMessage'
public:
enum class Flag : uint32 {
f_no_webpage = (1U << 1),
f_silent = (1U << 5),
f_background = (1U << 6),
f_clear_draft = (1U << 7),
f_reply_to_msg_id = (1U << 0),
f_reply_markup = (1U << 2),
f_entities = (1U << 3),
MAX_FIELD = (1U << 7),
};
using Flags = base::flags<Flag>;
friend inline constexpr auto is_flag_type(Flag) { return true; };
bool is_no_webpage() const { return vflags.v & Flag::f_no_webpage; }
bool is_silent() const { return vflags.v & Flag::f_silent; }
bool is_background() const { return vflags.v & Flag::f_background; }
bool is_clear_draft() const { return vflags.v & Flag::f_clear_draft; }
bool has_reply_to_msg_id() const { return vflags.v & Flag::f_reply_to_msg_id; }
bool has_reply_markup() const { return vflags.v & Flag::f_reply_markup; }
bool has_entities() const { return vflags.v & Flag::f_entities; }
MTPflags<MTPmessages_sendMessage::Flags> vflags;
MTPInputPeer vpeer;
MTPint vreply_to_msg_id;
MTPstring vmessage;
MTPlong vrandom_id;
MTPReplyMarkup vreply_markup;
MTPVector<MTPMessageEntity> ventities;
MTPmessages_sendMessage() = default;
MTPmessages_sendMessage(const MTPflags<MTPmessages_sendMessage::Flags> &_flags, const MTPInputPeer &_peer, MTPint _reply_to_msg_id, const MTPstring &_message, const MTPlong &_random_id, const MTPReplyMarkup &_reply_markup, const MTPVector<MTPMessageEntity> &_entities) : vflags(_flags), vpeer(_peer), vreply_to_msg_id(_reply_to_msg_id), vmessage(_message), vrandom_id(_random_id), vreply_markup(_reply_markup), ventities(_entities) {
}
uint32 innerLength() const;
mtpTypeId type() const {
return mtpc_messages_sendMessage;
}
void read(const mtpPrime *&from, const mtpPrime *end, mtpTypeId cons = mtpc_messages_sendMessage);
void write(mtpBuffer &to) const;
using ResponseType = MTPUpdates;
};
using MTPmessages_SendMessage = MTPBoxed<MTPmessages_sendMessage>;

复制代码

scheme.cpp

uint32 MTPmessages_sendMessage::innerLength() const {
return vflags.innerLength() + vpeer.innerLength() + (has_reply_to_msg_id() ? vreply_to_msg_id.innerLength() : 0) + vmessage.innerLength() + vrandom_id.innerLength() + (has_reply_markup() ? vreply_markup.innerLength() : 0) + (has_entities() ? ventities.innerLength() : 0);
}
void MTPmessages_sendMessage::read(const mtpPrime *&from, const mtpPrime *end, mtpTypeId cons) {
vflags.read(from, end);
vpeer.read(from, end);
if (has_reply_to_msg_id()) { vreply_to_msg_id.read(from, end); } else { vreply_to_msg_id = MTPint(); }
vmessage.read(from, end);
vrandom_id.read(from, end);
if (has_reply_markup()) { vreply_markup.read(from, end); } else { vreply_markup = MTPReplyMarkup(); }
if (has_entities()) { ventities.read(from, end); } else { ventities = MTPVector<MTPMessageEntity>(); }
}
void MTPmessages_sendMessage::write(mtpBuffer &to) const {
vflags.write(to);
vpeer.write(to);
if (has_reply_to_msg_id()) vreply_to_msg_id.write(to);
vmessage.write(to);
vrandom_id.write(to);
if (has_reply_markup()) vreply_markup.write(to);
if (has_entities()) ventities.write(to);
}

复制代码

代码中的调用

auto sendFlags = MTPmessages_SendMessage::Flags(0);
sendFlags |= MTPmessages_SendMessage::Flag::f_reply_to_msg_id;
sendFlags |= MTPmessages_SendMessage::Flag::f_no_webpage;
sendFlags |= MTPmessages_SendMessage::Flag::f_silent;
lastMessage = history->addNewMessage(
MTP_message(
MTP_flags(flags),
MTP_int(newId.msg),
MTP_int(messageFromId),
peerToMTP(peer->id),
MTPMessageFwdHeader(),
MTPint(),
MTP_int(message.replyTo),
MTP_int(unixtime()),
msgText,
media,
MTPReplyMarkup(),
localEntities,
MTP_int(1),
MTPint(),
MTP_string(messagePostAuthor),
MTPlong()),
NewMessageUnread);
history->sendRequestId = request(MTPmessages_SendMessage(
MTP_flags(sendFlags),
peer->input,
MTP_int(message.replyTo),
msgText,
MTP_long(randomId),
MTPReplyMarkup(),
sentEntities
)).done([=](const MTPUpdates &result) {
applyUpdates(result, randomId);
history->clearSentDraftText(QString());
}).fail([=](const RPCError &error) {
if (error.type() == qstr("MESSAGE_EMPTY")) {
lastMessage->destroy();
} else {
sendMessageFail(error);
}
history->clearSentDraftText(QString());
}).afterRequest(history->sendRequestId
).send();

复制代码

日志：
发送

[11:56:21.034 01-0006421] (dc:2) Send: { core_message
msg_id: 6799454597686760760 [LONG],
seq_no: 352 [INT],
bytes: 148 [INT],
body: { msg_container
messages: [ vector<0xffffffffffffffff>
{ core_message
msg_id: 6799454597686728540 [LONG],
seq_no: 351 [INT],
bytes: 88 [INT],
body: { messages_sendMessage
flags: 128 [INT],
no_webpage: [ SKIPPED BY BIT 1 IN FIELD flags ],
silent: [ SKIPPED BY BIT 5 IN FIELD flags ],
background: [ SKIPPED BY BIT 6 IN FIELD flags ],
clear_draft: YES [ BY BIT 7 IN FIELD flags ],
peer: { inputPeerChat
chat_id: 1 [INT],
},
reply_to_msg_id: [ SKIPPED BY BIT 0 IN FIELD flags ],
message: "fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff" [STRING],
random_id: 14114719467741365869 [LONG],
reply_markup: [ SKIPPED BY BIT 2 IN FIELD flags ],
entities: [ SKIPPED BY BIT 3 IN FIELD flags ],
},
},
{ core_message
msg_id: 6799454597686745724 [LONG],
seq_no: 352 [INT],
bytes: 20 [INT],
body: { msgs_ack
msg_ids: [ vector<0x22076cba>
6799454563309987337 [LONG],
],
},
},
],
},
}

复制代码

返回

[11:56:21.247 01-0006436] (dc:2) Recv: { core_message
msg_id: 6799454593288775185 [LONG],
seq_no: 51 [INT],
bytes: 292 [INT],
body: { rpc_result
req_msg_id: 6799454597686728540 [LONG],
result: { updates
updates: [ vector<0x0>
{ updateMessageID
id: 172 [INT],
random_id: 14114719467741365869 [LONG],
},
{ updateNewMessage
message: { message
flags: 770 [INT],
out: YES [ BY BIT 1 IN FIELD flags ],
mentioned: [ SKIPPED BY BIT 4 IN FIELD flags ],
media_unread: [ SKIPPED BY BIT 5 IN FIELD flags ],
silent: [ SKIPPED BY BIT 13 IN FIELD flags ],
post: [ SKIPPED BY BIT 14 IN FIELD flags ],
from_scheduled: [ SKIPPED BY BIT 18 IN FIELD flags ],
id: 172 [INT],
from_id: 10000001 [INT],
to_id: { peerChat
chat_id: 1 [INT],
},
fwd_from: [ SKIPPED BY BIT 2 IN FIELD flags ],
via_bot_id: [ SKIPPED BY BIT 11 IN FIELD flags ],
reply_to_msg_id: [ SKIPPED BY BIT 3 IN FIELD flags ],
date: 1583121389 [INT],
message: "fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff" [STRING],
media: { messageMediaEmpty },
reply_markup: [ SKIPPED BY BIT 6 IN FIELD flags ],
entities: [ SKIPPED BY BIT 7 IN FIELD flags ],
views: [ SKIPPED BY BIT 10 IN FIELD flags ],
edit_date: [ SKIPPED BY BIT 15 IN FIELD flags ],
post_author: [ SKIPPED BY BIT 16 IN FIELD flags ],
grouped_id: [ SKIPPED BY BIT 17 IN FIELD flags ],
},
pts: 316 [INT],
pts_count: 1 [INT],
},
],
users: [ vector<0x0>
{ user
flags: 4201591 [INT],
self: YES [ BY BIT 10 IN FIELD flags ],
contact: YES [ BY BIT 11 IN FIELD flags ],
mutual_contact: YES [ BY BIT 12 IN FIELD flags ],
deleted: [ SKIPPED BY BIT 13 IN FIELD flags ],
bot: [ SKIPPED BY BIT 14 IN FIELD flags ],
bot_chat_history: [ SKIPPED BY BIT 15 IN FIELD flags ],
bot_nochats: [ SKIPPED BY BIT 16 IN FIELD flags ],
verified: [ SKIPPED BY BIT 17 IN FIELD flags ],
restricted: [ SKIPPED BY BIT 18 IN FIELD flags ],
min: [ SKIPPED BY BIT 20 IN FIELD flags ],
bot_inline_geo: [ SKIPPED BY BIT 21 IN FIELD flags ],
support: [ SKIPPED BY BIT 23 IN FIELD flags ],
id: 10000001 [INT],
access_hash: 1827705845932265805 [LONG],
first_name: "13812345678" [STRING],
last_name: "t" [STRING],
username: [ SKIPPED BY BIT 3 IN FIELD flags ],
phone: "8613812345678" [STRING],
photo: { userProfilePhotoEmpty },
status: { userStatusOnline
expires: 1583121449 [INT],
},
bot_info_version: [ SKIPPED BY BIT 14 IN FIELD flags ],
restriction_reason: [ SKIPPED BY BIT 18 IN FIELD flags ],
bot_inline_placeholder: [ SKIPPED BY BIT 19 IN FIELD flags ],
lang_code: "" [STRING],
},
],
chats: [ vector<0x0>
{ chat
flags: 262144 [INT],
creator: [ SKIPPED BY BIT 0 IN FIELD flags ],
kicked: [ SKIPPED BY BIT 1 IN FIELD flags ],
left: [ SKIPPED BY BIT 2 IN FIELD flags ],
deactivated: [ SKIPPED BY BIT 5 IN FIELD flags ],
id: 1 [INT],
title: "tangtest" [STRING],
photo: { chatPhotoEmpty },
participants_count: 1 [INT],
date: 1578387290 [INT],
version: 1 [INT],
migrated_to: [ SKIPPED BY BIT 6 IN FIELD flags ],
admin_rights: [ SKIPPED BY BIT 14 IN FIELD flags ],
default_banned_rights: { chatBannedRights
flags: 0 [INT],
view_messages: [ SKIPPED BY BIT 0 IN FIELD flags ],
send_messages: [ SKIPPED BY BIT 1 IN FIELD flags ],
send_media: [ SKIPPED BY BIT 2 IN FIELD flags ],
send_stickers: [ SKIPPED BY BIT 3 IN FIELD flags ],
send_gifs: [ SKIPPED BY BIT 4 IN FIELD flags ],
send_games: [ SKIPPED BY BIT 5 IN FIELD flags ],
send_inline: [ SKIPPED BY BIT 6 IN FIELD flags ],
embed_links: [ SKIPPED BY BIT 7 IN FIELD flags ],
send_polls: [ SKIPPED BY BIT 8 IN FIELD flags ],
change_info: [ SKIPPED BY BIT 10 IN FIELD flags ],
invite_users: [ SKIPPED BY BIT 15 IN FIELD flags ],
pin_messages: [ SKIPPED BY BIT 17 IN FIELD flags ],
until_date: 2147483647 [INT],
},
},
],
date: 1583121389 [INT],
seq: 0 [INT],
},
},
}

复制代码

Qter · 发表于 2020-3-2 14:25:21

本帖最后由 Qter 于 2020-3-2 15:11 编辑

kf登录及返回定义

复制代码

生成的结构

MTPauth_Authorization& result
auto& d = result.c_auth_authorization();
QString phone = qs(d.vuser.c_user().vphone);
d.vuser.c_user().is_self()
class MTPauth_authorization : private MTP::internal::TypeDataOwner {
public:
MTPauth_authorization();
const MTPDauth_authorization &c_auth_authorization() const;
....
};
class MTPDauth_authorization : public MTP::internal::TypeData {
public:
...
MTPUser vuser;
};
class MTPuser : private MTP::internal::TypeDataOwner {
public:
const MTPDuser &c_user() const;
...
};
using MTPUser = MTPBoxed<MTPuser>;
class MTPDuser : public MTP::internal::TypeData {
public:
template <typename Other>
static constexpr bool Is() { return std::is_same_v<std::decay_t<Other>, MTPDuser>; };
enum class Flag : uint32 {
f_self = (1U << 10),
f_contact = (1U << 11),
f_mutual_contact = (1U << 12),
f_deleted = (1U << 13),
f_bot = (1U << 14),
f_bot_chat_history = (1U << 15),
f_bot_nochats = (1U << 16),
f_verified = (1U << 17),
f_restricted = (1U << 18),
f_min = (1U << 20),
f_bot_inline_geo = (1U << 21),
f_support = (1U << 23),
f_access_hash = (1U << 0),
f_first_name = (1U << 1),
f_last_name = (1U << 2),
f_username = (1U << 3),
f_phone = (1U << 4),
f_photo = (1U << 5),
f_status = (1U << 6),
f_bot_info_version = (1U << 14),
f_restriction_reason = (1U << 18),
f_bot_inline_placeholder = (1U << 19),
f_lang_code = (1U << 22),
MAX_FIELD = (1U << 23),
};
using Flags = base::flags<Flag>;
friend inline constexpr auto is_flag_type(Flag) { return true; };
bool is_self() const { return vflags.v & Flag::f_self; }
bool is_contact() const { return vflags.v & Flag::f_contact; }
bool is_mutual_contact() const { return vflags.v & Flag::f_mutual_contact; }
bool is_deleted() const { return vflags.v & Flag::f_deleted; }
bool is_bot() const { return vflags.v & Flag::f_bot; }
bool is_bot_chat_history() const { return vflags.v & Flag::f_bot_chat_history; }
bool is_bot_nochats() const { return vflags.v & Flag::f_bot_nochats; }
bool is_verified() const { return vflags.v & Flag::f_verified; }
bool is_restricted() const { return vflags.v & Flag::f_restricted; }
bool is_min() const { return vflags.v & Flag::f_min; }
bool is_bot_inline_geo() const { return vflags.v & Flag::f_bot_inline_geo; }
bool is_support() const { return vflags.v & Flag::f_support; }
bool has_access_hash() const { return vflags.v & Flag::f_access_hash; }
bool has_first_name() const { return vflags.v & Flag::f_first_name; }
bool has_last_name() const { return vflags.v & Flag::f_last_name; }
bool has_username() const { return vflags.v & Flag::f_username; }
bool has_phone() const { return vflags.v & Flag::f_phone; }
bool has_photo() const { return vflags.v & Flag::f_photo; }
bool has_status() const { return vflags.v & Flag::f_status; }
bool has_bot_info_version() const { return vflags.v & Flag::f_bot_info_version; }
bool has_restriction_reason() const { return vflags.v & Flag::f_restriction_reason; }
bool has_bot_inline_placeholder() const { return vflags.v & Flag::f_bot_inline_placeholder; }
bool has_lang_code() const { return vflags.v & Flag::f_lang_code; }
MTPDuser() = default;
MTPDuser(const MTPflags<MTPDuser::Flags> &_flags, MTPint _id, const MTPlong &_access_hash, const MTPstring &_first_name, const MTPstring &_last_name, const MTPstring &_username, const MTPstring &_phone, const MTPUserProfilePhoto &_photo, const MTPUserStatus &_status, MTPint _bot_info_version, const MTPstring &_restriction_reason, const MTPstring &_bot_inline_placeholder, const MTPstring &_lang_code);
MTPflags<MTPDuser::Flags> vflags;
MTPint vid;
MTPlong vaccess_hash;
MTPstring vfirst_name;
MTPstring vlast_name;
MTPstring vusername;
MTPstring vphone;
MTPUserProfilePhoto vphoto;
MTPUserStatus vstatus;
MTPint vbot_info_version;
MTPstring vrestriction_reason;
MTPstring vbot_inline_placeholder;
MTPstring vlang_code;
};

复制代码

Qter · 发表于 2020-3-3 11:04:37

scheme.tl

invokeWithLayer#da9b0d0d {X:Type} layer:int query:!X = X;

复制代码

! modifier

In TL, the idempotent operator ! can modify any type, actually making surface values be allowed when its constant values are serialized. However, if T is a standard function like S1->..->Sr->Type, then !T is defined using the equation (!T) a1 ... ar = !(T a1 ... ar), for any a1:S1, ..., ar:Sr.

The ! operator is only allowed in a definition of the types of fields of functional combinators. It is usually used as a type prefix, for example:

set_timeout {X:Type} timeout:int f:!X = X;

In this case, the set_timeout “wrapper” is defined. It takes two explicit parameters: the integer timeout and a surface expression of type X. X : Type is itself an implicit parameter (it is not explicitly stated, rather it is inferred from the values of the other parameters and their types). A similar kind of wrapper may be helpful for modifying the action of RPC queries (which are surface expressions of various types). For example, suppose we have the function

factorial n:int = int;

then we can wrap the RPC query (factorial 100) as follows: (set_timeout 200 (factorial 100)). This expression is still a surface value of type int, which means it can be passed as an RPC query.

A consecutive pair of two computations is another example:

pair {X Y : Type} x:X y:Y = Pair X Y; // constructorseq_pair {X Y : Type} x:!X y:!Y = Pair X Y; // functional wrapper for sequential computationpar_pair {X Y : Type} x:!X y:!Y = Pair X Y; // functional wrapper for parallel computation

Now the RPC query (seq_pair (factorial 2) (factorial 3)) : Pair int int first calculates factorial 2, then factorial 3, and returns the pair (pair 2 6). In this case, the sequence of operations isn’t important, because they do not have side effects. It would have been just as well to use (par_pair (factorial 2) (factorial 3)). However, this is not always the case.

We can also define an analogy to a “comma” operation:

comma {X Y : Type} x:!X y:!Y = Y;

For example, this operation could first calculate x, then forget the result, calculate y, and return y.

Note that the semantics of the seq_pair, par_pair and comma wrappers are indeed defined where they are implemented (like the semantics of all other functional combinators), not by their TL declaration.

In principle, polymorphic wrappers like set_timeout can also be applied, for example, to “annotate” a RPC response’s constant values. For example, the server might return a response to a query together with the time it was calculated. However, a value of type !X must be constant, because that is what is expected as the enclosing expression’s value. In other words, set_timeout 239 E is a constant/surface value of type X if and only if E is such itself.

https://core.telegram.org/mtproto/TL-abstract-types

		自动登录	找回密码
密码			立即注册