Transifex autosync
[xonotic/xonotic-data.pk3dir.git] / qcsrc / common / debug.qh
1 #pragma once
2
3 #ifdef CSQC
4 #include <client/resources.qh>
5 #endif
6
7
8 // This includes some functions useful for debugging.
9 // Some more bot-specific ones are in server/pathlib/debug.qc.
10 // Look for other useful commands under prvm_* in console (apropos / search).
11
12
13 #ifdef CSQC
14 .entity tag_entity;
15 #endif
16
17
18 #ifdef GAMEQC
19 .bool debug;
20 .int sv_entnum;
21 REGISTER_NET_TEMP(net_debug)
22 #endif
23
24 #ifdef CSQC
25         NET_HANDLE(net_debug, bool isNew)
26         {
27                 Net_Accept(net_debug);
28                 this.sv_entnum = ReadShort();
29                 if (ReadByte()) make_pure(this);
30                 this.origin = ReadVector();
31                 setorigin(this, this.origin);
32                 this.debug = true;  // identify server entities by this
33                 this.classname = strzone(ReadString());
34                 this.sourceLoc = strzone(ReadString());
35                 return true;
36         }
37 #endif
38
39 #ifdef SVQC
40         bool debug_send(entity this, entity to, int sf)
41         {
42                 int channel = MSG_ONE;
43                 msg_entity = to;
44                 WriteHeader(channel, net_debug);
45                 WriteShort(channel, etof(this));
46                 WriteByte(channel, is_pure(this));
47                 vector o = this.origin;
48                 if (o == '0 0 0') // brushes
49                         o = (this.absmin + this.absmax) / 2;
50                 if (this.tag_entity)
51                         o += this.tag_entity.origin;
52                 WriteVector(channel, o);
53                 WriteString(channel, this.classname);
54                 WriteString(channel, this.sourceLoc);
55                 return true;
56         }
57 #endif
58
59
60 #if ENABLE_DEBUGDRAW
61 #ifdef GAMEQC
62 /**
63  * 0: off
64  * 1: on
65  * 2: on (pure)
66  * 3: on (.entnum != 0)
67  * 4: on (.origin == '0 0 0')
68  * 5: on (.debug != 0), server only
69  * 6: on (.solid != 0)
70  */
71 bool autocvar_debugdraw;
72 #endif
73
74 #ifdef CSQC
75         string autocvar_debugdraw_filter, autocvar_debugdraw_filterout;
76         .int debugdraw_last;
77         vector project_3d_to_2d(vector vec);
78         void Debug_Draw()
79         {
80                 if (!autocvar_debugdraw) return;
81                 static int debugdraw_frame;
82                 ++debugdraw_frame;
83                 const int sz = 8;
84                 FOREACH_ENTITY(true, {
85                         if (it.debugdraw_last == debugdraw_frame) continue;
86                         int ofs = 0;
87                         FOREACH_ENTITY_RADIUS(it.origin, 100, it.debugdraw_last != debugdraw_frame, {
88                                 it.debugdraw_last = debugdraw_frame;
89                                 vector rgb = (it.debug) ? '0 0 1' : '1 0 0';
90                                 if (autocvar_debugdraw_filterout != "" && strhasword(autocvar_debugdraw_filterout, it.classname)) continue;
91                                 if (autocvar_debugdraw_filter != "" && !strhasword(autocvar_debugdraw_filter, it.classname)) continue;
92                                 if (autocvar_debugdraw == 3)
93                                 {
94                                         if (!it.entnum) continue;
95                                 }
96                                 if (autocvar_debugdraw == 4)
97                                 {
98                                         if (it.origin) continue;
99                                 }
100                                 if (autocvar_debugdraw == 5)
101                                 {
102                                         if (!it.debug) continue;
103                                 }
104                                 else if (autocvar_debugdraw > 5)
105                                 {
106                                         bool flag = true;
107                                         do {
108 //                                              if (it.modelindex) break;
109 //                                              if (it.absmin) break;
110 //                                              if (it.absmax) break;
111 //                                              if (it.entnum) break;
112 //                                              if (it.drawmask) break;
113 //                                              if (it.predraw) break;
114 //                                              if (it.move_movetype) break;
115                                                 if (it.solid) break;
116 //                                              if (it.origin) break;
117 //                                              if (it.oldorigin) break;
118 //                                              if (it.velocity) break;
119 //                                              if (it.angles) break;
120 //                                              if (it.avelocity) break;
121 //                                              if (it.classname) break;
122 //                                              if (it.model) break;
123 //                                              if (it.frame) break;
124 //                                              if (it.skin) break;
125 //                                              if (it.effects) break;
126 //                                              if (it.mins) break;
127 //                                              if (it.maxs) break;
128 //                                              if (it.size) break;
129 //                                              if (it.touch) break;
130 //                                              if (it.use) break;
131 //                                              if (it.think) break;
132 //                                              if (it.blocked) break;
133 //                                              if (it.nextthink) break;
134 //                                              if (it.chain) break;
135 //                                              if (it.netname) break;
136 //                                              if (it.enemy) break;
137 //                                              if (it.flags) break;
138 //                                              if (it.colormap) break;
139 //                                              if (it.owner) break;
140                                                 flag = false;
141                                         } while (0);
142                                         if (!flag) continue;
143                                 }
144                                 else if (is_pure(it))
145                                 {
146                                         if (autocvar_debugdraw < 2) continue;
147                                         rgb.y = 1;
148                                 }
149                                 vector o = it.origin;
150                                 if (it.tag_entity)
151                                         o += it.tag_entity.origin;
152                                 vector pos = project_3d_to_2d(o);
153                                 if (pos.z < 0) continue;
154                                 pos.z = 0;
155                                 pos.y += ofs * sz;
156                                 drawcolorcodedstring2_builtin(pos,
157                                         sprintf("%d: '%s'@%s", (it.debug ? it.sv_entnum : etof(it)),
158                                         it.classname, it.sourceLoc),
159                                         sz * '1 1 0', rgb, 0.5, DRAWFLAG_NORMAL);
160                                 ++ofs;
161             });
162                 });
163         }
164 #endif
165
166
167 #ifdef SVQC
168         COMMON_COMMAND(debugdraw_sv, "Dump all server entities")
169         {
170                 switch (request)
171                 {
172                         case CMD_REQUEST_COMMAND:
173                         {
174                                 if (!autocvar_debugdraw) return;
175                                 int n = 1000;
176                                 int rem = n;
177                                 for (entity e = NULL; (e = findfloat(e, debug, 0)) && rem > 0; )
178                                 {
179                                         if (autocvar_debugdraw < 2 && is_pure(e)) continue;
180                                         debug_send(e, caller, 0);
181                                         e.debug = true;
182                                         --rem;
183                                 }
184                                 LOG_INFOF("%d server entities sent", n - rem);
185                                 return;
186                         }
187
188                         default:
189                         case CMD_REQUEST_USAGE:
190                         {
191                                 LOG_INFO("Usage:^3 ", GetProgramCommandPrefix(), " debugdraw_sv");
192                                 return;
193                         }
194                 }
195         }
196 #endif
197 #endif
198
199
200 GENERIC_COMMAND(bufstr_get, "Examine a string buffer object")
201 {
202         switch (request)
203         {
204                 case CMD_REQUEST_COMMAND:
205                 {
206                         int bufhandle = stof(argv(1));
207                         int string_index = stof(argv(2));
208                         LOG_INFO(bufstr_get(bufhandle, string_index));
209                         return;
210                 }
211
212                 default:
213                 case CMD_REQUEST_USAGE:
214                 {
215                         LOG_INFO("Usage:^3 ", GetProgramCommandPrefix(), " bufstr_get bufhandle string_index");
216                         return;
217                 }
218         }
219 }
220
221
222 GENERIC_COMMAND(version, "Print the current version")
223 {
224         switch (request)
225         {
226                 case CMD_REQUEST_COMMAND:
227                 {
228                         LOG_INFO(WATERMARK);
229                         return;
230                 }
231                 default:
232                 case CMD_REQUEST_USAGE:
233                 {
234                         LOG_INFO("Usage:^3 ", GetProgramCommandPrefix(), " version");
235                         return;
236                 }
237         }
238 }
239
240
241 #ifdef CSQC
242 void(float bufhandle, string pattern, string antipattern) buf_cvarlist = #517;
243 #endif
244 GENERIC_COMMAND(cvar_localchanges, "Print locally changed cvars")
245 {
246         switch (request)
247         {
248                 case CMD_REQUEST_COMMAND:
249                 {
250                         string s = "";
251                         int h = buf_create();
252                         buf_cvarlist(h, "", "_"); // exclude all _ cvars as they are temporary
253                         int n = buf_getsize(h);
254                         for (int i = 0; i < n; ++i) {
255                                 string k = bufstr_get(h, i);
256                                 string v = cvar_string(k);
257                                 string d = cvar_defstring(k);
258                                 if (v == d)
259                                         continue;
260                                 s = strcat(s, k, " \"", v, "\" // \"", d, "\"\n");
261                         }
262                         buf_del(h);
263                         LOG_INFO(s);
264                         return;
265                 }
266                 default:
267                 case CMD_REQUEST_USAGE:
268                 {
269                         LOG_INFO("Usage:^3 ", GetProgramCommandPrefix(), " cvar_localchanges");
270                         return;
271                 }
272         }
273 }
274
275
276 #if ENABLE_DEBUGTRACE
277 REGISTER_STAT(TRACE_ENT, int)
278 #ifdef SVQC
279 bool autocvar_debugtrace;
280
281 REGISTER_MUTATOR(trace, autocvar_debugtrace);
282
283 .bool debug_trace_button;
284 .int solid_prev;
285 MUTATOR_HOOKFUNCTION(trace, SV_StartFrame)
286 {
287         FOREACH_CLIENT(true, {
288                 bool skip = false;
289                 bool btn = PHYS_INPUT_BUTTON_HOOK(it);
290                 if (btn == it.debug_trace_button) skip = true;
291                 it.debug_trace_button = btn;
292                 if (!btn || skip) continue;
293                 FOREACH_ENTITY(true, {
294                         it.solid_prev = it.solid;
295                         it.solid = SOLID_BBOX;
296                 });
297                 vector forward = '0 0 0'; vector right = '0 0 0'; vector up = '0 0 0';
298                 MAKEVECTORS(makevectors, it.v_angle, forward, right, up);
299                 vector pos = it.origin + it.view_ofs;
300                 traceline(pos, pos + forward * max_shot_distance, MOVE_NORMAL, it);
301                 FOREACH_ENTITY(true, {
302                         it.solid = it.solid_prev;
303                         it.solid_prev = 0;
304                 });
305                 entity e = trace_ent;
306                 int i = etof(e);
307                 STAT(TRACE_ENT, it) = i;
308                 if (!e) continue;
309                 setorigin(e, e.origin + '0 0 100');
310                 stuffcmd(it, sprintf("prvm_edict server %d\n", i));
311         });
312 }
313 #endif
314 #ifdef CSQC
315 entity TRACE_ENT;
316 void Trace_draw2d(entity this)
317 {
318         int e = STAT(TRACE_ENT);
319         if (!e) return;
320         vector pos = '0 0 0';
321         pos.y += vid_conheight / 2;
322         drawstring(pos, sprintf("prvm_edict server %d", e), '10 10 0', '1 1 1', 1, DRAWFLAG_NORMAL);
323 }
324
325 STATIC_INIT(TRACE_ENT)
326 {
327         entity e = TRACE_ENT = new_pure(TRACE_ENT);
328         e.draw2d = Trace_draw2d;
329         IL_PUSH(g_drawables_2d, e);
330 }
331 #endif
332 #endif
333
334
335 GENERIC_COMMAND(find, "Search through entities for matching classname")
336 {
337         switch (request)
338         {
339                 case CMD_REQUEST_COMMAND:
340                 {
341                         int entcnt = 0;
342                         FOREACH_ENTITY_CLASS_ORDERED(argv(1), true,
343                         {
344                                 LOG_INFOF("%i (%s)", it, it.classname);
345                                 ++entcnt;
346                         });
347                         if(entcnt)
348                                 LOG_INFOF("Found %d entities", entcnt);
349                         return;
350                 }
351
352                 default:
353                 {
354                         LOG_INFO("Incorrect parameters for ^2find^7");
355         }
356                 case CMD_REQUEST_USAGE:
357                 {
358                         LOG_INFO("Usage:^3 " GetProgramCommandPrefix() " find classname");
359                         LOG_INFO("  Where 'classname' is the classname to search for.");
360                         return;
361                 }
362         }
363 }
364
365
366 GENERIC_COMMAND(findat, "Search through entities for matching origin")
367 {
368         switch (request)
369         {
370                 case CMD_REQUEST_COMMAND:
371                 {
372                     vector match = stov(argv(1));
373                     FOREACH_ENTITY_ORDERED(it.origin == match, LOG_INFOF("%i (%s)", it, it.classname));
374                         return;
375                 }
376
377                 default:
378                         LOG_INFO("Incorrect parameters for ^2findat^7");
379                 case CMD_REQUEST_USAGE:
380                 {
381                         LOG_INFO("Usage:^3 " GetProgramCommandPrefix() " findat \"0 0 0\"");
382                         return;
383                 }
384         }
385 }
386
387
388 // debug_test() allows drawing text from server on the client anywhere in world coordinates.
389
390 #ifdef GAMEQC
391 REGISTER_NET_TEMP(debug_text_3d);
392 #endif
393
394 #ifdef CSQC
395
396 CLASS(DebugText3d, Object)
397         // reusing existing fields
398         ATTRIB(DebugText3d, origin, vector);
399         ATTRIB(DebugText3d, message, string); // the text (i wanted to use the .text field but then this whole macro-based-inheritance thing shat itself)
400         ATTRIB(DebugText3d, health, float); // text alignment (recycled field)
401         ATTRIB(DebugText3d, hit_time, float); // when it was created
402         ATTRIB(DebugText3d, fade_rate, float); // how fast is should disappear
403         ATTRIB(DebugText3d, velocity, vector);
404
405         CONSTRUCTOR(DebugText3d, vector pos, string msg, float align, float fade_rate_, vector vel) {
406                 CONSTRUCT(DebugText3d);
407                 this.origin = pos;
408                 this.message = strzone(msg);
409                 SetResource(this, RES_HEALTH, align);
410                 this.hit_time = time;
411                 this.fade_rate = fade_rate_;
412                 this.velocity = vel;
413                 IL_PUSH(g_drawables_2d, this);
414         }
415
416         DESTRUCTOR(DebugText3d) {
417                 strfree(this.message);
418         }
419
420         void DebugText3d_draw2d(DebugText3d this) {
421                 float since_created = time - this.hit_time;
422                 float alpha_ = 1 - since_created * this.fade_rate;
423
424                 if (alpha_ < 0) {
425                         delete(this);
426                         return;
427                 }
428
429                 int size = 11;
430                 vector screen_pos = project_3d_to_2d(this.origin) + since_created * this.velocity;
431                 if (screen_pos.z < 0) return; // behind camera
432
433                 screen_pos.z = 0;
434                 float align = GetResource(this, RES_HEALTH);
435                 string msg;
436                 vector msg_pos;
437
438                 int n = tokenizebyseparator(this.message, "\n");
439                 for(int k = 0; k < n; ++k)
440                 {
441                         msg = argv(k);
442                         msg_pos = screen_pos + k * 1.25 * size * eY;
443                         if (align > 0)
444                                 msg_pos.x -= stringwidth(msg, true, size * '1 1 0') * min(1, align);
445
446                         drawcolorcodedstring_builtin(msg_pos, msg, size * '1 1 0', alpha_, DRAWFLAG_NORMAL);
447                 }
448         }
449         ATTRIB(DebugText3d, draw2d, void(DebugText3d), DebugText3d_draw2d);
450 ENDCLASS(DebugText3d)
451
452 NET_HANDLE(debug_text_3d, bool is_new) {
453         vector pos = ReadVector();
454         string msg = ReadString();
455         float align = ReadFloat();
456         float duration = ReadFloat();
457         vector vel = ReadVector();
458         make_impure(NEW(DebugText3d, pos, msg, align, 1 / duration, vel));
459         return true;
460 }
461
462 #endif // CSQC
463
464 #ifdef SVQC
465
466 // can't use autocvars because they give unused warning unless the macros are expanded
467 #define debug_text_3d(...) EVAL(OVERLOAD(debug_text_3d, __VA_ARGS__))
468 #define debug_text_3d_2(pos, msg) debug_text_3d_3(pos, msg, cvar("debug_text_3d_default_align"))
469 #define debug_text_3d_3(pos, msg, align) debug_text_3d_4(pos, msg, align, cvar("debug_text_3d_default_duration"))
470 #define debug_text_3d_4(pos, msg, align, dur) debug_text_3d_5(pos, msg, align, dur, stov(cvar_string("debug_text_3d_default_velocity")))
471 #define debug_text_3d_5(pos, msg, align, dur, vel) debug_text_3d_fn(pos, msg, align, dur, vel)
472
473 ERASEABLE
474 void debug_text_3d_fn(vector pos, string msg, float align, float duration, vector vel) {
475         WriteHeader(MSG_BROADCAST, debug_text_3d);
476         WriteVector(MSG_BROADCAST, pos);
477         WriteString(MSG_BROADCAST, msg);
478         WriteFloat(MSG_BROADCAST, align);
479         WriteFloat(MSG_BROADCAST, duration);
480         WriteVector(MSG_BROADCAST, vel);
481 }
482
483 #endif // SVQC