]> de.git.xonotic.org Git - xonotic/xonotic-data.pk3dir.git/blob - qcsrc/lib/net.qh
Small optimization
[xonotic/xonotic-data.pk3dir.git] / qcsrc / lib / net.qh
1 #pragma once
2
3 #include "registry.qh"
4 #include "sort.qh"
5 #include "yenc.qh"
6
7 // netcode mismatch and not sure what caused it? developer_csqcentities 1
8
9 .string netname;
10 .int m_id;
11 .bool(entity this, entity sender, bool isNew) m_read;
12 #define NET_HANDLE(id, param) bool Net_Handle_##id(entity this, entity sender, param)
13
14 #define NET_GUARD(id) \
15     bool Net_Handle_##id##_guard(entity this, entity sender, bool isNew) { \
16         bool valid = false; \
17         serialize_marker(to, valid); \
18         if (!valid) LOG_FATALF("Last message not fully parsed: %s", _net_prevmsgstr); \
19         _net_prevmsgstr = #id; \
20         return Net_Handle_##id(this, sender, isNew); \
21     }
22
23 #ifdef CSQC
24 string _net_prevmsgstr;
25         #define REGISTER_NET_TEMP(id) \
26                 NET_HANDLE(id, bool); \
27         NET_GUARD(id); \
28                 REGISTER(TempEntities, NET, id, m_id, new_pure(net_temp_packet)) { \
29                         this.netname = #id; \
30                         this.m_read = Net_Handle_##id##_guard; \
31                 }
32 #else
33         #define REGISTER_NET_TEMP(id) \
34                 const bool NET_##id##_istemp = true; \
35                 REGISTER(TempEntities, NET, id, m_id, new_pure(net_temp_packet)) \
36                 { \
37                         this.netname = #id; \
38                 }
39 #endif
40 #define REGISTER_NET_S2C(id) REGISTER_NET_TEMP(id)
41
42 REGISTRY(TempEntities, BITS(8) - 80)
43 #define TempEntities_from(i) _TempEntities_from(i, NULL)
44 REGISTER_REGISTRY(TempEntities)
45 REGISTRY_SORT(TempEntities)
46 REGISTRY_CHECK(TempEntities)
47 STATIC_INIT(RegisterTempEntities_renumber) { FOREACH(TempEntities, true, it.m_id = 80 + i); }
48
49
50
51 #ifdef CSQC
52         #define REGISTER_NET_LINKED(id) \
53                 ACCUMULATE NET_HANDLE(id, bool isnew) \
54                 { \
55                         this = __self; \
56                         this.sourceLoc = __FILE__ ":" STR(__LINE__); \
57                         if (!this) isnew = true; \
58                 } \
59                 NET_GUARD(id); \
60                 REGISTER(LinkedEntities, NET, id, m_id, new_pure(net_linked_packet)) \
61                 { \
62                         this.netname = #id; \
63                         this.m_read = Net_Handle_##id##_guard; \
64                 }
65 #else
66         #define REGISTER_NET_LINKED(id) \
67                 const bool NET_##id##_istemp = false; \
68                 REGISTER(LinkedEntities, NET, id, m_id, new_pure(net_linked_packet)) \
69                 { \
70                         this.netname = #id; \
71                 }
72 #endif
73
74 REGISTRY(LinkedEntities, BITS(8) - 1)
75 #define LinkedEntities_from(i) _LinkedEntities_from(i, NULL)
76 REGISTER_REGISTRY(LinkedEntities)
77 REGISTRY_SORT(LinkedEntities)
78 REGISTRY_CHECK(LinkedEntities)
79 STATIC_INIT(RegisterLinkedEntities_renumber) { FOREACH(LinkedEntities, true, it.m_id = 1 + i); }
80
81
82
83 #ifdef SVQC
84         #define REGISTER_NET_C2S(id) \
85                 NET_HANDLE(id, bool); \
86                 REGISTER(C2S_Protocol, NET, id, m_id, new_pure(net_c2s_packet)) \
87                 { \
88                         this.netname = #id; \
89                         this.m_read = Net_Handle_##id; \
90                 }
91 #else
92         #define REGISTER_NET_C2S(id) \
93                 const bool NET_##id##_istemp = true; \
94                 REGISTER(C2S_Protocol, NET, id, m_id, new_pure(net_c2s_packet)) \
95                 { \
96                         this.netname = #id; \
97                 }
98 #endif
99
100 REGISTRY(C2S_Protocol, BITS(8) - 1)
101 #define C2S_Protocol_from(i) _C2S_Protocol_from(i, NULL)
102 REGISTER_REGISTRY(C2S_Protocol)
103 REGISTRY_SORT(C2S_Protocol)
104 REGISTRY_CHECK(C2S_Protocol)
105 STATIC_INIT(C2S_Protocol_renumber) { FOREACH(C2S_Protocol, true, it.m_id = i); }
106
107 #ifdef SVQC
108         const int MSG_ENTITY = 5;
109
110         .int SendFlags;
111
112         IntrusiveList g_uncustomizables;
113         STATIC_INIT(g_uncustomizables) { g_uncustomizables = IL_NEW(); }
114
115         void Net_LinkEntity(entity e, bool docull, float dt, bool(entity this, entity to, int sendflags) sendfunc)
116         {
117                 if (e.classname == "") e.classname = "net_linked";
118
119                 if (e.model == "" || e.modelindex == 0)
120                 {
121                         vector mi = e.mins;
122                         vector ma = e.maxs;
123                         _setmodel(e, "null");
124                         setsize(e, mi, ma);
125                 }
126
127                 setSendEntity(e, sendfunc);
128                 e.SendFlags = 0xFFFFFF;
129
130                 if (!docull) e.effects |= EF_NODEPTHTEST;
131
132                 if (dt)
133                 {
134                         e.nextthink = time + dt;
135                         setthink(e, SUB_Remove);
136                 }
137         }
138
139         void Net_UnlinkEntity(entity e)
140         {
141                 setSendEntity(e, func_null);
142         }
143
144         .void(entity this) uncustomizeentityforclient;
145         .float uncustomizeentityforclient_set;
146
147         void SetCustomizer(entity e, bool(entity this, entity client) customizer, void(entity this) uncustomizer)
148         {
149                 setcefc(e, customizer);
150                 e.uncustomizeentityforclient = uncustomizer;
151                 e.uncustomizeentityforclient_set = !!uncustomizer;
152                 if(uncustomizer)
153                         IL_PUSH(g_uncustomizables, e);
154         }
155
156         void UncustomizeEntitiesRun()
157         {
158                 IL_EACH(g_uncustomizables, it.uncustomizeentityforclient_set, it.uncustomizeentityforclient(it));
159         }
160
161         STRING_ITERATOR(g_buf, string_null, 0);
162
163         int ReadByte();
164
165         void Net_ClientCommand(entity sender, string command)
166         {
167                 // command matches `c2s "(.+)"`
168                 string buf = substring(command, argv_start_index(1) + 1, -2);
169                 if (buf == "") return;
170                 STRING_ITERATOR_SET(g_buf, buf, 0);
171                 for (int C2S; (C2S = ReadByte()) >= 0; )
172                 {
173                         entity reader = C2S_Protocol_from(C2S);
174                         if (reader && reader.m_read && reader.m_read(NULL, sender, true)) continue;
175                         LOG_SEVEREF("Net_ClientCommand() with malformed C2S=%d", C2S);
176                         return;
177                 }
178                 g_buf_i--;
179                 int expected = strlen(buf);
180                 if (g_buf_i > expected) LOG_WARNF("Underflow: %d", g_buf_i - expected);
181                 if (g_buf_i < expected) LOG_WARNF("Overrflow: %d", expected - g_buf_i);
182         }
183
184 #endif
185
186 #ifdef CSQC
187         const int MSG_C2S = 0;
188
189         #define Net_Accept(classname) \
190                 MACRO_BEGIN { \
191                         if (!this)    this = new(classname); \
192                 } MACRO_END
193         #define Net_Reject() \
194                 MACRO_BEGIN { \
195                         if (this)     delete(this); \
196                 } MACRO_END
197
198         string g_buf;
199
200         void Net_Flush()
201         {
202                 if (g_buf == "") return;
203                 localcmd("\ncmd c2s \"", strreplace("$", "$$", g_buf), "\"\n");
204                 strfree(g_buf);
205         }
206 #endif
207
208 #if defined(CSQC)
209         #define WriteHeader(to, id) \
210                 MACRO_BEGIN { \
211                         WriteByte(to, NET_##id.m_id); \
212                 } MACRO_END
213 #elif defined(SVQC)
214         #define WriteHeader(to, id) \
215                 MACRO_BEGIN { \
216                         if (NET_##id##_istemp) WriteByte(to, SVC_TEMPENTITY); \
217                         WriteByte(to, NET_##id.m_id); \
218                         bool _net_valid = false; serialize_marker(to, _net_valid); \
219                 } MACRO_END
220 #endif
221
222 // serialization: new style
223
224 USING(Stream, int);
225 #if defined(SVQC)
226         #define stream_reading(stream) false
227         #define stream_writing(stream) true
228 #elif defined(CSQC)
229         #define stream_reading(stream) true
230         #define stream_writing(stream) false
231 #endif
232
233 #define serialize(T, stream, ...) \
234 MACRO_BEGIN \
235     noref Stream _stream = stream; \
236     serialize_##T(_stream, __VA_ARGS__); \
237 MACRO_END
238
239 #if defined(SVQC)
240         #define serialize_byte(stream, this) \
241                 MACRO_BEGIN \
242                 WriteByte(stream, this); \
243                 MACRO_END
244 #elif defined(CSQC)
245         #define serialize_byte(stream, this) \
246                 MACRO_BEGIN \
247                 this = ReadByte(); \
248                 MACRO_END
249 #endif
250
251 #if defined(SVQC)
252         #define serialize_float(stream, this) \
253                 MACRO_BEGIN \
254                 WriteCoord(stream, this); \
255                 MACRO_END
256 #elif defined(CSQC)
257         #define serialize_float(stream, this) \
258                 MACRO_BEGIN \
259                 this = ReadCoord(); \
260                 MACRO_END
261 #endif
262
263 #define serialize_vector(stream, this) \
264 MACRO_BEGIN \
265     vector _v = this; \
266     serialize_float(stream, _v.x); \
267     serialize_float(stream, _v.y); \
268     serialize_float(stream, _v.z); \
269     this = _v; \
270 MACRO_END
271
272 #define serialize_marker(stream, this) \
273 MACRO_BEGIN \
274     if (NDEBUG) { \
275         this = true; \
276     } else { \
277         int _de = 0xDE, _ad = 0xAD, _be = 0xBE, _ef = 0xEF; \
278         serialize_byte(stream, _de); \
279         serialize_byte(stream, _ad); \
280         serialize_byte(stream, _be); \
281         serialize_byte(stream, _ef); \
282         this = (_de == 0xDE && _ad == 0xAD && _be == 0xBE && _ef == 0xEF); \
283     } \
284 MACRO_END
285
286 // serialization: old
287
288 #define ReadRegistered(r) r##_from(Read_byte())
289 #define WriteRegistered(r, to, it) Write_byte(to, it.m_id)
290
291 #define Read_byte() ReadByte()
292 #define Write_byte(to, f) WriteByte(to, f)
293
294 #if defined(CSQC)
295         int ReadByte();
296         void WriteByte(int to, int b)
297         {
298                 assert(to == MSG_C2S);
299                 string s = string_null;
300                 yenc_single(b, s);
301                 string tmp = strcat(g_buf, s);
302                 strcpy(g_buf, tmp);
303         }
304         void WriteShort(int to, int b)
305         {
306                 WriteByte(to, (b >> 8) & 0xFF);
307                 WriteByte(to, b & 0xFF);
308         }
309 #elif defined(SVQC)
310         int ReadByte()
311         {
312                 int ret = -1;
313                 ydec_single(g_buf, ret);
314                 return ret;
315         }
316         int ReadShort()
317         {
318                 return (ReadByte() << 8) | (ReadByte());
319         }
320         void WriteByte(int to, int b);
321 #endif
322
323 #define Read_int() ReadInt24_t()
324 #define Write_int(to, f) WriteInt24_t(to, f)
325
326 #define Read_float() ReadFloat()
327 #define Write_float(to, f) WriteFloat(to, f)
328
329 #define Read_string() ReadString()
330 #define Write_string(to, f) WriteString(to, f)
331
332 #ifdef GAMEQC
333         const float APPROXPASTTIME_ACCURACY_REQUIREMENT = 0.05;
334         #define APPROXPASTTIME_MAX (16384 * APPROXPASTTIME_ACCURACY_REQUIREMENT)
335         #define APPROXPASTTIME_RANGE (64 * APPROXPASTTIME_ACCURACY_REQUIREMENT)
336
337         #ifdef CSQC
338                 float servertime;
339                 entity ReadCSQCEntity()
340                 {
341                         int f = ReadShort();
342                         if (f == 0) return NULL;
343                         return findfloat(NULL, entnum, f);
344                 }
345                 int ReadInt24_t()
346                 {
347                         int v = ReadShort() << 8; // note: this is signed
348                         v += ReadByte();          // note: this is unsigned
349                         return v;
350                 }
351                 #define ReadInt48_t() vec2(ReadInt24_t(), ReadInt24_t())
352                 #define ReadInt72_t() vec3(ReadInt24_t(), ReadInt24_t(), ReadInt24_t())
353
354                 noref int _ReadSByte;
355                 #define ReadSByte() (_ReadSByte = ReadByte(), (_ReadSByte & BIT(7) ? -128 : 0) + (_ReadSByte & BITS(7)))
356                 #define ReadFloat() ReadCoord()
357                 #define ReadVector() vec3(ReadFloat(), ReadFloat(), ReadFloat())
358                 #define ReadVector2D() vec2(ReadFloat(), ReadFloat())
359
360                 float ReadApproxPastTime()
361                 {
362                         float dt = ReadByte();
363
364                         // map from range...PPROXPASTTIME_MAX / 256
365                         dt = (APPROXPASTTIME_MAX / 256) * (dt / (256 - dt));
366
367                         return servertime - dt;
368                 }
369
370         #else
371                 void WriteInt24_t(float dst, float val)
372                 {
373                         float v;
374                         WriteShort(dst, (v = floor(val >> 8)));
375                         WriteByte(dst, val - (v << 8));  // 0..255
376                 }
377                 void WriteInt48_t(float dst, vector val)
378                 {
379                         WriteInt24_t(dst, val.x);
380                         WriteInt24_t(dst, val.y);
381                 }
382                 void WriteInt72_t(float dst, vector val)
383                 {
384                         WriteInt24_t(dst, val.x);
385                         WriteInt24_t(dst, val.y);
386                         WriteInt24_t(dst, val.z);
387                 }
388
389         #define WriteFloat(to, f) WriteCoord(to, f)
390                 #define WriteVector(to, v) MACRO_BEGIN { WriteFloat(to, v.x); WriteFloat(to, v.y); WriteFloat(to, v.z); } MACRO_END
391         #define WriteVector2D(to, v) MACRO_BEGIN { WriteFloat(to, v.x); WriteFloat(to, v.y); } MACRO_END
392
393                 // this will use the value:
394                 //   128
395                 // accuracy near zero is APPROXPASTTIME_MAX/(256*255)
396                 // accuracy at x is 1/derivative, i.e.
397                 //   APPROXPASTTIME_MAX * (1 + 256 * (dt / APPROXPASTTIME_MAX))^2 / 65536
398                 void WriteApproxPastTime(float dst, float t)
399                 {
400                         float dt = time - t;
401
402                         // warning: this is approximate; do not resend when you don't have to!
403                         // be careful with sendflags here!
404                         // we want: 0 -> 0.05, 1 -> 0.1, ..., 255 -> 12.75
405
406                         // map to range...
407                         dt = 256 * (dt / ((APPROXPASTTIME_MAX / 256) + dt));
408
409                         // round...
410                         dt = rint(bound(0, dt, 255));
411
412                         WriteByte(dst, dt);
413                 }
414
415                 // allow writing to also pass through to spectators (like so spectators see the same centerprints as players for example)
416                 #define WRITESPECTATABLE_MSG_ONE(to, statement) MACRO_BEGIN { \
417                         entity prev = msg_entity; \
418                         entity dst = to; \
419                         FOREACH_CLIENT(IS_REAL_CLIENT(it), { \
420                                 if (it == dst || (it.classname == STR_SPECTATOR && it.enemy == dst)) \
421                                 { \
422                                         msg_entity = it; \
423                                         LAMBDA(statement); \
424                                 } \
425                         }); \
426                         msg_entity = prev; \
427                 } MACRO_END
428         #endif
429 #endif