Merge branch 'martin-t/check-cvars' into 'master'
[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 // GAMEQC
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 // CSQC
165
166 #ifdef SVQC
167         COMMON_COMMAND(debugdraw_sv, "Dump all server entities")
168         {
169                 switch (request)
170                 {
171                         case CMD_REQUEST_COMMAND:
172                         {
173                                 if (!autocvar_debugdraw) return;
174                                 int n = 1000;
175                                 int rem = n;
176                                 for (entity e = NULL; (e = findfloat(e, debug, 0)) && rem > 0; )
177                                 {
178                                         if (autocvar_debugdraw < 2 && is_pure(e)) continue;
179                                         debug_send(e, caller, 0);
180                                         e.debug = true;
181                                         --rem;
182                                 }
183                                 LOG_INFOF("%d server entities sent", n - rem);
184                                 return;
185                         }
186
187                         default:
188                         case CMD_REQUEST_USAGE:
189                         {
190                                 LOG_INFO("Usage:^3 ", GetProgramCommandPrefix(), " debugdraw_sv");
191                                 return;
192                         }
193                 }
194         }
195 #endif // SVQC
196 #endif // ENABLE_DEBUGDRAW
197
198
199 GENERIC_COMMAND(bufstr_get, "Examine a string buffer object", false)
200 {
201         switch (request)
202         {
203                 case CMD_REQUEST_COMMAND:
204                 {
205                         int bufhandle = stof(argv(1));
206                         int string_index = stof(argv(2));
207                         LOG_INFO(bufstr_get(bufhandle, string_index));
208                         return;
209                 }
210
211                 default:
212                 case CMD_REQUEST_USAGE:
213                 {
214                         LOG_INFO("Usage:^3 ", GetProgramCommandPrefix(), " bufstr_get bufhandle string_index");
215                         return;
216                 }
217         }
218 }
219
220
221 GENERIC_COMMAND(version, "Print the current version", false)
222 {
223         switch (request)
224         {
225                 case CMD_REQUEST_COMMAND:
226                 {
227                         LOG_INFO(WATERMARK);
228                         return;
229                 }
230                 default:
231                 case CMD_REQUEST_USAGE:
232                 {
233                         LOG_INFO("Usage:^3 ", GetProgramCommandPrefix(), " version");
234                         return;
235                 }
236         }
237 }
238
239
240 #ifdef CSQC
241 void(float bufhandle, string pattern, string antipattern) buf_cvarlist = #517;
242 #endif
243
244 GENERIC_COMMAND(cvar_localchanges, "Print locally changed cvars", false)
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
279 #ifdef SVQC
280 bool autocvar_debugtrace;
281
282 REGISTER_MUTATOR(trace, autocvar_debugtrace);
283
284 .bool debug_trace_button;
285 .int solid_prev;
286 MUTATOR_HOOKFUNCTION(trace, SV_StartFrame)
287 {
288         FOREACH_CLIENT(true, {
289                 bool skip = false;
290                 bool btn = PHYS_INPUT_BUTTON_HOOK(it);
291                 if (btn == it.debug_trace_button) skip = true;
292                 it.debug_trace_button = btn;
293                 if (!btn || skip) continue;
294                 FOREACH_ENTITY(true, {
295                         it.solid_prev = it.solid;
296                         it.solid = SOLID_BBOX;
297                 });
298                 vector forward = '0 0 0'; vector right = '0 0 0'; vector up = '0 0 0';
299                 MAKE_VECTORS(it.v_angle, forward, right, up);
300                 vector pos = it.origin + it.view_ofs;
301                 traceline(pos, pos + forward * max_shot_distance, MOVE_NORMAL, it);
302                 FOREACH_ENTITY(true, {
303                         it.solid = it.solid_prev;
304                         it.solid_prev = 0;
305                 });
306                 entity e = trace_ent;
307                 int i = etof(e);
308                 STAT(TRACE_ENT, it) = i;
309                 if (!e) continue;
310                 setorigin(e, e.origin + '0 0 100');
311                 stuffcmd(it, sprintf("prvm_edict server %d\n", i));
312         });
313 }
314 #endif // SVQC
315
316 #ifdef CSQC
317 entity TRACE_ENT;
318 void Trace_draw2d(entity this)
319 {
320         int e = STAT(TRACE_ENT);
321         if (!e) return;
322         vector pos = '0 0 0';
323         pos.y += vid_conheight / 2;
324         drawstring(pos, sprintf("prvm_edict server %d", e), '10 10 0', '1 1 1', 1, DRAWFLAG_NORMAL);
325 }
326
327 STATIC_INIT(TRACE_ENT)
328 {
329         entity e = TRACE_ENT = new_pure(TRACE_ENT);
330         e.draw2d = Trace_draw2d;
331         IL_PUSH(g_drawables_2d, e);
332 }
333 #endif // CSQC
334
335 #endif
336
337
338 GENERIC_COMMAND(find, "Search through entities for matching classname", false)
339 {
340         switch (request)
341         {
342                 case CMD_REQUEST_COMMAND:
343                 {
344                         int entcnt = 0;
345                         FOREACH_ENTITY_CLASS_ORDERED(argv(1), true,
346                         {
347                                 LOG_INFOF("%i (%s)", it, it.classname);
348                                 ++entcnt;
349                         });
350                         if(entcnt)
351                                 LOG_INFOF("Found %d entities", entcnt);
352                         return;
353                 }
354
355                 default:
356                 {
357                         LOG_INFO("Incorrect parameters for ^2find^7");
358         }
359                 case CMD_REQUEST_USAGE:
360                 {
361                         LOG_INFO("Usage:^3 " GetProgramCommandPrefix() " find classname");
362                         LOG_INFO("  Where 'classname' is the classname to search for.");
363                         return;
364                 }
365         }
366 }
367
368
369 GENERIC_COMMAND(findat, "Search through entities for matching origin", false)
370 {
371         switch (request)
372         {
373                 case CMD_REQUEST_COMMAND:
374                 {
375                     vector match = stov(argv(1));
376                     FOREACH_ENTITY_ORDERED(it.origin == match, LOG_INFOF("%i (%s)", it, it.classname));
377                         return;
378                 }
379
380                 default:
381                         LOG_INFO("Incorrect parameters for ^2findat^7");
382                 case CMD_REQUEST_USAGE:
383                 {
384                         LOG_INFO("Usage:^3 " GetProgramCommandPrefix() " findat \"0 0 0\"");
385                         return;
386                 }
387         }
388 }
389
390
391 // debug_test() allows drawing text from server on the client anywhere in world coordinates.
392
393 #ifdef GAMEQC
394 REGISTER_NET_TEMP(debug_text_3d);
395 #endif
396
397 #ifdef CSQC
398
399 CLASS(DebugText3d, Object)
400         // reusing existing fields
401         ATTRIB(DebugText3d, origin, vector);
402         ATTRIB(DebugText3d, message, string); // the text (i wanted to use the .text field but then this whole macro-based-inheritance thing shat itself)
403         ATTRIB(DebugText3d, health, float); // text alignment (recycled field)
404         ATTRIB(DebugText3d, hit_time, float); // when it was created
405         ATTRIB(DebugText3d, fade_rate, float); // how fast it should disappear
406         ATTRIB(DebugText3d, velocity, vector);
407
408         CONSTRUCTOR(DebugText3d, vector pos, string msg, float align, float fade_rate_, vector vel) {
409                 CONSTRUCT(DebugText3d);
410                 this.origin = pos;
411                 this.message = strzone(msg);
412                 SetResource(this, RES_HEALTH, align);
413                 this.hit_time = time;
414                 this.fade_rate = fade_rate_;
415                 this.velocity = vel;
416                 IL_PUSH(g_drawables_2d, this);
417         }
418
419         DESTRUCTOR(DebugText3d) {
420                 strfree(this.message);
421         }
422
423         void DebugText3d_draw2d(DebugText3d this) {
424                 float since_created = time - this.hit_time;
425                 float alpha_ = 1 - since_created * this.fade_rate;
426
427                 if (alpha_ < 0) {
428                         delete(this);
429                         return;
430                 }
431
432                 int size = 11;
433                 vector screen_pos = project_3d_to_2d(this.origin) + since_created * this.velocity;
434                 if (screen_pos.z < 0) return; // behind camera
435
436                 screen_pos.z = 0;
437                 float align = GetResource(this, RES_HEALTH);
438                 string msg;
439                 vector msg_pos;
440
441                 int n = tokenizebyseparator(this.message, "\n");
442                 for(int k = 0; k < n; ++k)
443                 {
444                         msg = argv(k);
445                         msg_pos = screen_pos + k * 1.25 * size * eY;
446                         if (align > 0)
447                                 msg_pos.x -= stringwidth(msg, true, size * '1 1 0') * min(1, align);
448
449                         drawcolorcodedstring_builtin(msg_pos, msg, size * '1 1 0', alpha_, DRAWFLAG_NORMAL);
450                 }
451         }
452         ATTRIB(DebugText3d, draw2d, void(DebugText3d), DebugText3d_draw2d);
453 ENDCLASS(DebugText3d)
454
455 NET_HANDLE(debug_text_3d, bool is_new) {
456         vector pos = ReadVector();
457         string msg = ReadString();
458         float align = ReadFloat();
459         float duration = ReadFloat();
460         vector vel = ReadVector();
461         make_impure(NEW(DebugText3d, pos, msg, align, 1 / duration, vel));
462         return true;
463 }
464
465 #endif // CSQC
466
467 #ifdef SVQC
468
469 // can't use autocvars because they give unused warning unless the macros are expanded
470 #define debug_text_3d(...) EVAL(OVERLOAD(debug_text_3d, __VA_ARGS__))
471 #define debug_text_3d_2(pos, msg) debug_text_3d_3(pos, msg, cvar("debug_text_3d_default_align"))
472 #define debug_text_3d_3(pos, msg, align) debug_text_3d_4(pos, msg, align, cvar("debug_text_3d_default_duration"))
473 #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")))
474 #define debug_text_3d_5(pos, msg, align, dur, vel) debug_text_3d_fn(pos, msg, align, dur, vel)
475
476 ERASEABLE
477 void debug_text_3d_fn(vector pos, string msg, float align, float duration, vector vel) {
478         WriteHeader(MSG_BROADCAST, debug_text_3d);
479         WriteVector(MSG_BROADCAST, pos);
480         WriteString(MSG_BROADCAST, msg);
481         WriteFloat(MSG_BROADCAST, align);
482         WriteFloat(MSG_BROADCAST, duration);
483         WriteVector(MSG_BROADCAST, vel);
484 }
485
486 #endif // SVQC