2 Copyright (C) 1996-1997 Id Software, Inc.
4 This program is free software; you can redistribute it and/or
5 modify it under the terms of the GNU General Public License
6 as published by the Free Software Foundation; either version 2
7 of the License, or (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13 See the GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
27 static prvm_prog_t prog_list[PRVM_MAXPROGS];
29 int prvm_type_size[8] = {1,sizeof(string_t)/4,1,3,1,1,sizeof(func_t)/4,sizeof(void *)/4};
31 ddef_t *PRVM_ED_FieldAtOfs(int ofs);
32 qboolean PRVM_ED_ParseEpair(prvm_edict_t *ent, ddef_t *key, const char *s, qboolean parsebackslash);
34 cvar_t prvm_language = {0, "prvm_language", "", "when set, loads progs.dat.LANGUAGENAME.po for string translations; when set to dump, progs.dat.dump.po is written from the strings in the progs"};
35 // LordHavoc: prints every opcode as it executes - warning: this is significant spew
36 cvar_t prvm_traceqc = {0, "prvm_traceqc", "0", "prints every QuakeC statement as it is executed (only for really thorough debugging!)"};
37 // LordHavoc: counts usage of each QuakeC statement
38 cvar_t prvm_statementprofiling = {0, "prvm_statementprofiling", "0", "counts how many times each QuakeC statement has been executed, these counts are displayed in prvm_printfunction output (if enabled)"};
39 cvar_t prvm_timeprofiling = {0, "prvm_timeprofiling", "0", "counts how long each function has been executed, these counts are displayed in prvm_profile output (if enabled)"};
40 cvar_t prvm_backtraceforwarnings = {0, "prvm_backtraceforwarnings", "0", "print a backtrace for warnings too"};
41 cvar_t prvm_leaktest = {0, "prvm_leaktest", "0", "try to detect memory leaks in strings or entities"};
42 cvar_t prvm_leaktest_ignore_classnames = {0, "prvm_leaktest_ignore_classnames", "", "classnames of entities to NOT leak check because they are found by find(world, classname, ...) but are actually spawned by QC code (NOT map entities)"};
43 cvar_t prvm_errordump = {0, "prvm_errordump", "0", "write a savegame on crash to crash-server.dmp"};
44 cvar_t prvm_reuseedicts_startuptime = {0, "prvm_reuseedicts_startuptime", "2", "allows immediate re-use of freed entity slots during start of new level (value in seconds)"};
45 cvar_t prvm_reuseedicts_neverinsameframe = {0, "prvm_reuseedicts_neverinsameframe", "1", "never allows re-use of freed entity slots during same frame"};
47 static double prvm_reuseedicts_always_allow = 0;
48 qboolean prvm_runawaycheck = true;
50 extern sizebuf_t vm_tempstringsbuf;
52 //============================================================================
60 void PRVM_MEM_Alloc(void)
64 // reserve space for the null entity aka world
65 // check bound of max_edicts
66 prog->max_edicts = bound(1 + prog->reserved_edicts, prog->max_edicts, prog->limit_edicts);
67 prog->num_edicts = bound(1 + prog->reserved_edicts, prog->num_edicts, prog->max_edicts);
69 // edictprivate_size has to be min as big prvm_edict_private_t
70 prog->edictprivate_size = max(prog->edictprivate_size,(int)sizeof(prvm_edict_private_t));
73 prog->edicts = (prvm_edict_t *)Mem_Alloc(prog->progs_mempool,prog->limit_edicts * sizeof(prvm_edict_t));
75 // alloc edict private space
76 prog->edictprivate = Mem_Alloc(prog->progs_mempool, prog->max_edicts * prog->edictprivate_size);
79 prog->entityfieldsarea = prog->entityfields * prog->max_edicts;
80 prog->edictsfields = (vec_t *)Mem_Alloc(prog->progs_mempool, prog->entityfieldsarea * sizeof(vec_t));
83 for(i = 0; i < prog->max_edicts; i++)
85 prog->edicts[i].priv.required = (prvm_edict_private_t *)((unsigned char *)prog->edictprivate + i * prog->edictprivate_size);
86 prog->edicts[i].fields.vp = prog->edictsfields + i * prog->entityfields;
92 PRVM_MEM_IncreaseEdicts
95 void PRVM_MEM_IncreaseEdicts(void)
99 if(prog->max_edicts >= prog->limit_edicts)
102 PRVM_GCALL(begin_increase_edicts)();
105 prog->max_edicts = min(prog->max_edicts + 256, prog->limit_edicts);
107 prog->entityfieldsarea = prog->entityfields * prog->max_edicts;
108 prog->edictsfields = (vec_t*)Mem_Realloc(prog->progs_mempool, (void *)prog->edictsfields, prog->entityfieldsarea * sizeof(vec_t));
109 prog->edictprivate = (void *)Mem_Realloc(prog->progs_mempool, (void *)prog->edictprivate, prog->max_edicts * prog->edictprivate_size);
111 //set e and v pointers
112 for(i = 0; i < prog->max_edicts; i++)
114 prog->edicts[i].priv.required = (prvm_edict_private_t *)((unsigned char *)prog->edictprivate + i * prog->edictprivate_size);
115 prog->edicts[i].fields.vp = prog->edictsfields + i * prog->entityfields;
118 PRVM_GCALL(end_increase_edicts)();
121 //============================================================================
124 int PRVM_ED_FindFieldOffset(const char *field)
127 d = PRVM_ED_FindField(field);
133 int PRVM_ED_FindGlobalOffset(const char *global)
136 d = PRVM_ED_FindGlobal(global);
142 func_t PRVM_ED_FindFunctionOffset(const char *function)
145 f = PRVM_ED_FindFunction(function);
148 return (func_t)(f - prog->functions);
151 qboolean PRVM_ProgLoaded(int prognr)
153 if(prognr < 0 || prognr >= PRVM_MAXPROGS)
156 return (prog_list[prognr].loaded ? TRUE : FALSE);
161 PRVM_SetProgFromString
164 // perhaps add a return value when the str doesnt exist
165 qboolean PRVM_SetProgFromString(const char *str)
168 for(; i < PRVM_MAXPROGS ; i++)
169 if(prog_list[i].name && !strcmp(prog_list[i].name,str))
171 if(prog_list[i].loaded)
173 prog = &prog_list[i];
178 Con_Printf("%s not loaded !\n",PRVM_NAME);
183 Con_Printf("Invalid program name %s !\n", str);
192 void PRVM_SetProg(int prognr)
194 if(0 <= prognr && prognr < PRVM_MAXPROGS)
196 if(prog_list[prognr].loaded)
197 prog = &prog_list[prognr];
199 PRVM_ERROR("%i not loaded !", prognr);
202 PRVM_ERROR("Invalid program number %i", prognr);
209 Sets everything to NULL
212 void PRVM_ED_ClearEdict (prvm_edict_t *e)
214 memset (e->fields.vp, 0, prog->progs->entityfields * 4);
215 e->priv.required->free = false;
217 // AK: Let the init_edict function determine if something needs to be initialized
218 PRVM_GCALL(init_edict)(e);
221 const char *PRVM_AllocationOrigin(void)
224 if(prog->leaktest_active)
225 if(prog->depth > 0) // actually in QC code and not just parsing the entities block of a map/savegame
227 buf = (char *)PRVM_Alloc(128);
228 PRVM_ShortStackTrace(buf, 128);
237 Returns if this particular edict could get allocated by PRVM_ED_Alloc
240 qboolean PRVM_ED_CanAlloc(prvm_edict_t *e)
242 if(!e->priv.required->free)
244 if(prvm_reuseedicts_always_allow == realtime)
246 if(realtime <= e->priv.required->freetime && prvm_reuseedicts_neverinsameframe.integer)
247 return false; // never allow reuse in same frame (causes networking trouble)
248 if(e->priv.required->freetime < prog->starttime + prvm_reuseedicts_startuptime.value)
250 if(realtime > e->priv.required->freetime + 1)
252 return false; // entity slot still blocked because the entity was freed less than one second ago
259 Either finds a free edict, or allocates a new one.
260 Try to avoid reusing an entity that was recently freed, because it
261 can cause the client to think the entity morphed into something else
262 instead of being removed and recreated, which can cause interpolated
263 angles and bad trails.
266 prvm_edict_t *PRVM_ED_Alloc (void)
271 // the client qc dont need maxclients
272 // thus it doesnt need to use svs.maxclients
273 // AK: changed i=svs.maxclients+1
274 // AK: changed so the edict 0 wont spawn -> used as reserved/world entity
275 // although the menu/client has no world
276 for (i = prog->reserved_edicts + 1;i < prog->num_edicts;i++)
278 e = PRVM_EDICT_NUM(i);
279 if(PRVM_ED_CanAlloc(e))
281 PRVM_ED_ClearEdict (e);
282 e->priv.required->allocation_origin = PRVM_AllocationOrigin();
287 if (i == prog->limit_edicts)
288 PRVM_ERROR ("%s: PRVM_ED_Alloc: no free edicts",PRVM_NAME);
291 if (prog->num_edicts >= prog->max_edicts)
292 PRVM_MEM_IncreaseEdicts();
294 e = PRVM_EDICT_NUM(i);
295 PRVM_ED_ClearEdict (e);
297 e->priv.required->allocation_origin = PRVM_AllocationOrigin();
306 Marks the edict as free
307 FIXME: walk all entities and NULL out references to this entity
310 void PRVM_ED_Free (prvm_edict_t *ed)
312 // dont delete the null entity (world) or reserved edicts
313 if(PRVM_NUM_FOR_EDICT(ed) <= prog->reserved_edicts )
316 PRVM_GCALL(free_edict)(ed);
318 ed->priv.required->free = true;
319 ed->priv.required->freetime = realtime;
320 if(ed->priv.required->allocation_origin)
322 PRVM_Free((char *)ed->priv.required->allocation_origin);
323 ed->priv.required->allocation_origin = NULL;
327 //===========================================================================
334 ddef_t *PRVM_ED_GlobalAtOfs (int ofs)
339 for (i=0 ; i<prog->progs->numglobaldefs ; i++)
341 def = &prog->globaldefs[i];
353 ddef_t *PRVM_ED_FieldAtOfs (int ofs)
358 for (i=0 ; i<prog->progs->numfielddefs ; i++)
360 def = &prog->fielddefs[i];
372 ddef_t *PRVM_ED_FindField (const char *name)
377 for (i=0 ; i<prog->progs->numfielddefs ; i++)
379 def = &prog->fielddefs[i];
380 if (!strcmp(PRVM_GetString(def->s_name), name))
391 ddef_t *PRVM_ED_FindGlobal (const char *name)
396 for (i=0 ; i<prog->progs->numglobaldefs ; i++)
398 def = &prog->globaldefs[i];
399 if (!strcmp(PRVM_GetString(def->s_name), name))
411 mfunction_t *PRVM_ED_FindFunction (const char *name)
416 for (i=0 ; i<prog->progs->numfunctions ; i++)
418 func = &prog->functions[i];
419 if (!strcmp(PRVM_GetString(func->s_name), name))
430 Returns a string describing *data in a type specific manner
433 char *PRVM_ValueString (etype_t type, prvm_eval_t *val)
435 static char line[MAX_INPUTLINE];
440 type = (etype_t)((int) type & ~DEF_SAVEGLOBAL);
445 strlcpy (line, PRVM_GetString (val->string), sizeof (line));
449 if (n < 0 || n >= prog->max_edicts)
450 dpsnprintf (line, sizeof(line), "entity %i (invalid!)", n);
452 dpsnprintf (line, sizeof(line), "entity %i", n);
455 f = prog->functions + val->function;
456 dpsnprintf (line, sizeof(line), "%s()", PRVM_GetString(f->s_name));
459 def = PRVM_ED_FieldAtOfs ( val->_int );
460 dpsnprintf (line, sizeof(line), ".%s", PRVM_GetString(def->s_name));
463 dpsnprintf (line, sizeof(line), "void");
466 // LordHavoc: changed from %5.1f to %10.4f
467 dpsnprintf (line, sizeof(line), "%10.4f", val->_float);
470 // LordHavoc: changed from %5.1f to %10.4f
471 dpsnprintf (line, sizeof(line), "'%10.4f %10.4f %10.4f'", val->vector[0], val->vector[1], val->vector[2]);
474 dpsnprintf (line, sizeof(line), "pointer");
477 dpsnprintf (line, sizeof(line), "bad type %i", (int) type);
488 Returns a string describing *data in a type specific manner
489 Easier to parse than PR_ValueString
492 char *PRVM_UglyValueString (etype_t type, prvm_eval_t *val)
494 static char line[MAX_INPUTLINE];
500 type = (etype_t)((int)type & ~DEF_SAVEGLOBAL);
505 // Parse the string a bit to turn special characters
506 // (like newline, specifically) into escape codes,
507 // this fixes saving games from various mods
508 s = PRVM_GetString (val->string);
509 for (i = 0;i < (int)sizeof(line) - 2 && *s;)
538 dpsnprintf (line, sizeof (line), "%i", PRVM_NUM_FOR_EDICT(PRVM_PROG_TO_EDICT(val->edict)));
541 f = prog->functions + val->function;
542 strlcpy (line, PRVM_GetString (f->s_name), sizeof (line));
545 def = PRVM_ED_FieldAtOfs ( val->_int );
546 dpsnprintf (line, sizeof (line), ".%s", PRVM_GetString(def->s_name));
549 dpsnprintf (line, sizeof (line), "void");
552 dpsnprintf (line, sizeof (line), "%.9g", val->_float);
555 dpsnprintf (line, sizeof (line), "%.9g %.9g %.9g", val->vector[0], val->vector[1], val->vector[2]);
558 dpsnprintf (line, sizeof (line), "bad type %i", type);
569 Returns a string with a description and the contents of a global,
570 padded to 20 field width
573 char *PRVM_GlobalString (int ofs)
579 static char line[128];
581 val = (void *)&prog->globals.generic[ofs];
582 def = PRVM_ED_GlobalAtOfs(ofs);
584 dpsnprintf (line, sizeof(line), "GLOBAL%i", ofs);
587 s = PRVM_ValueString ((etype_t)def->type, (prvm_eval_t *)val);
588 dpsnprintf (line, sizeof(line), "%s (=%s)", PRVM_GetString(def->s_name), s);
592 //for ( ; i<20 ; i++)
593 // strcat (line," ");
599 char *PRVM_GlobalStringNoContents (int ofs)
603 static char line[128];
605 def = PRVM_ED_GlobalAtOfs(ofs);
607 dpsnprintf (line, sizeof(line), "GLOBAL%i", ofs);
609 dpsnprintf (line, sizeof(line), "%s", PRVM_GetString(def->s_name));
612 //for ( ; i<20 ; i++)
613 // strcat (line," ");
627 // LordHavoc: optimized this to print out much more quickly (tempstring)
628 // LordHavoc: changed to print out every 4096 characters (incase there are a lot of fields to print)
629 void PRVM_ED_Print(prvm_edict_t *ed, const char *wildcard_fieldname)
637 char tempstring[MAX_INPUTLINE], tempstring2[260]; // temporary string buffers
639 if (ed->priv.required->free)
641 Con_Printf("%s: FREE\n",PRVM_NAME);
646 dpsnprintf(tempstring, sizeof(tempstring), "\n%s EDICT %i:\n", PRVM_NAME, PRVM_NUM_FOR_EDICT(ed));
647 for (i=1 ; i<prog->progs->numfielddefs ; i++)
649 d = &prog->fielddefs[i];
650 name = PRVM_GetString(d->s_name);
651 if (name[strlen(name)-2] == '_')
652 continue; // skip _x, _y, _z vars
654 // Check Field Name Wildcard
655 if(wildcard_fieldname)
656 if( !matchpattern(name, wildcard_fieldname, 1) )
657 // Didn't match; skip
660 v = (int *)(ed->fields.vp + d->ofs);
662 // if the value is still all 0, skip the field
663 type = d->type & ~DEF_SAVEGLOBAL;
665 for (j=0 ; j<prvm_type_size[type] ; j++)
668 if (j == prvm_type_size[type])
671 if (strlen(name) > sizeof(tempstring2)-4)
673 memcpy (tempstring2, name, sizeof(tempstring2)-4);
674 tempstring2[sizeof(tempstring2)-4] = tempstring2[sizeof(tempstring2)-3] = tempstring2[sizeof(tempstring2)-2] = '.';
675 tempstring2[sizeof(tempstring2)-1] = 0;
678 strlcat(tempstring, name, sizeof(tempstring));
679 for (l = strlen(name);l < 14;l++)
680 strlcat(tempstring, " ", sizeof(tempstring));
681 strlcat(tempstring, " ", sizeof(tempstring));
683 name = PRVM_ValueString((etype_t)d->type, (prvm_eval_t *)v);
684 if (strlen(name) > sizeof(tempstring2)-4)
686 memcpy (tempstring2, name, sizeof(tempstring2)-4);
687 tempstring2[sizeof(tempstring2)-4] = tempstring2[sizeof(tempstring2)-3] = tempstring2[sizeof(tempstring2)-2] = '.';
688 tempstring2[sizeof(tempstring2)-1] = 0;
691 strlcat(tempstring, name, sizeof(tempstring));
692 strlcat(tempstring, "\n", sizeof(tempstring));
693 if (strlen(tempstring) >= sizeof(tempstring)/2)
695 Con_Print(tempstring);
700 Con_Print(tempstring);
710 extern cvar_t developer_entityparsing;
711 void PRVM_ED_Write (qfile_t *f, prvm_edict_t *ed)
721 if (ed->priv.required->free)
727 for (i=1 ; i<prog->progs->numfielddefs ; i++)
729 d = &prog->fielddefs[i];
730 name = PRVM_GetString(d->s_name);
732 if(developer_entityparsing.integer)
733 Con_Printf("PRVM_ED_Write: at entity %d field %s\n", PRVM_NUM_FOR_EDICT(ed), name);
735 if (name[strlen(name)-2] == '_')
736 continue; // skip _x, _y, _z vars
738 v = (int *)(ed->fields.vp + d->ofs);
740 // if the value is still all 0, skip the field
741 type = d->type & ~DEF_SAVEGLOBAL;
742 for (j=0 ; j<prvm_type_size[type] ; j++)
745 if (j == prvm_type_size[type])
748 FS_Printf(f,"\"%s\" ",name);
749 prog->statestring = va("PRVM_ED_Write, ent=%d, name=%s", i, name);
750 FS_Printf(f,"\"%s\"\n", PRVM_UglyValueString((etype_t)d->type, (prvm_eval_t *)v));
751 prog->statestring = NULL;
757 void PRVM_ED_PrintNum (int ent, const char *wildcard_fieldname)
759 PRVM_ED_Print(PRVM_EDICT_NUM(ent), wildcard_fieldname);
764 PRVM_ED_PrintEdicts_f
766 For debugging, prints all the entities in the current server
769 void PRVM_ED_PrintEdicts_f (void)
772 const char *wildcard_fieldname;
774 if(Cmd_Argc() < 2 || Cmd_Argc() > 3)
776 Con_Print("prvm_edicts <program name> <optional field name wildcard>\n");
781 if(!PRVM_SetProgFromString(Cmd_Argv(1)))
785 wildcard_fieldname = Cmd_Argv(2);
787 wildcard_fieldname = NULL;
789 Con_Printf("%s: %i entities\n", PRVM_NAME, prog->num_edicts);
790 for (i=0 ; i<prog->num_edicts ; i++)
791 PRVM_ED_PrintNum (i, wildcard_fieldname);
800 For debugging, prints a single edict
803 void PRVM_ED_PrintEdict_f (void)
806 const char *wildcard_fieldname;
808 if(Cmd_Argc() < 3 || Cmd_Argc() > 4)
810 Con_Print("prvm_edict <program name> <edict number> <optional field name wildcard>\n");
815 if(!PRVM_SetProgFromString(Cmd_Argv(1)))
818 i = atoi (Cmd_Argv(2));
819 if (i >= prog->num_edicts)
821 Con_Print("Bad edict number\n");
826 // Optional Wildcard Provided
827 wildcard_fieldname = Cmd_Argv(3);
830 wildcard_fieldname = NULL;
831 PRVM_ED_PrintNum (i, wildcard_fieldname);
843 // 2 possibilities : 1. just displaying the active edict count
844 // 2. making a function pointer [x]
845 void PRVM_ED_Count_f (void)
853 Con_Print("prvm_count <program name>\n");
858 if(!PRVM_SetProgFromString(Cmd_Argv(1)))
861 if(prog->count_edicts)
862 prog->count_edicts();
866 for (i=0 ; i<prog->num_edicts ; i++)
868 ent = PRVM_EDICT_NUM(i);
869 if (ent->priv.required->free)
874 Con_Printf("num_edicts:%3i\n", prog->num_edicts);
875 Con_Printf("active :%3i\n", active);
882 ==============================================================================
886 FIXME: need to tag constants, doesn't really work
887 ==============================================================================
895 void PRVM_ED_WriteGlobals (qfile_t *f)
903 for (i=0 ; i<prog->progs->numglobaldefs ; i++)
905 def = &prog->globaldefs[i];
907 if ( !(def->type & DEF_SAVEGLOBAL) )
909 type &= ~DEF_SAVEGLOBAL;
911 if (type != ev_string && type != ev_float && type != ev_entity)
914 name = PRVM_GetString(def->s_name);
916 if(developer_entityparsing.integer)
917 Con_Printf("PRVM_ED_WriteGlobals: at global %s\n", name);
919 prog->statestring = va("PRVM_ED_WriteGlobals, name=%s", name);
920 FS_Printf(f,"\"%s\" ", name);
921 FS_Printf(f,"\"%s\"\n", PRVM_UglyValueString((etype_t)type, (prvm_eval_t *)&prog->globals.generic[def->ofs]));
922 prog->statestring = NULL;
932 void PRVM_ED_ParseGlobals (const char *data)
934 char keyname[MAX_INPUTLINE];
940 if (!COM_ParseToken_Simple(&data, false, false))
941 PRVM_ERROR ("PRVM_ED_ParseGlobals: EOF without closing brace");
942 if (com_token[0] == '}')
945 if (developer_entityparsing.integer)
946 Con_Printf("Key: \"%s\"", com_token);
948 strlcpy (keyname, com_token, sizeof(keyname));
951 if (!COM_ParseToken_Simple(&data, false, true))
952 PRVM_ERROR ("PRVM_ED_ParseGlobals: EOF without closing brace");
954 if (developer_entityparsing.integer)
955 Con_Printf(" \"%s\"\n", com_token);
957 if (com_token[0] == '}')
958 PRVM_ERROR ("PRVM_ED_ParseGlobals: closing brace without data");
960 key = PRVM_ED_FindGlobal (keyname);
963 Con_DPrintf("'%s' is not a global on %s\n", keyname, PRVM_NAME);
967 if (!PRVM_ED_ParseEpair(NULL, key, com_token, true))
968 PRVM_ERROR ("PRVM_ED_ParseGlobals: parse error");
972 //============================================================================
979 Can parse either fields or globals
980 returns false if error
983 qboolean PRVM_ED_ParseEpair(prvm_edict_t *ent, ddef_t *key, const char *s, qboolean parsebackslash)
992 val = (prvm_eval_t *)(ent->fields.vp + key->ofs);
994 val = (prvm_eval_t *)(prog->globals.generic + key->ofs);
995 switch (key->type & ~DEF_SAVEGLOBAL)
998 l = (int)strlen(s) + 1;
999 val->string = PRVM_AllocString(l, &new_p);
1000 for (i = 0;i < l;i++)
1002 if (s[i] == '\\' && s[i+1] && parsebackslash)
1007 else if (s[i] == 'r')
1018 while (*s && ISWHITESPACE(*s))
1020 val->_float = atof(s);
1024 for (i = 0;i < 3;i++)
1026 while (*s && ISWHITESPACE(*s))
1030 val->vector[i] = atof(s);
1031 while (!ISWHITESPACE(*s))
1039 while (*s && ISWHITESPACE(*s))
1042 if (i >= prog->limit_edicts)
1043 Con_Printf("PRVM_ED_ParseEpair: ev_entity reference too large (edict %u >= MAX_EDICTS %u) on %s\n", (unsigned int)i, prog->limit_edicts, PRVM_NAME);
1044 while (i >= prog->max_edicts)
1045 PRVM_MEM_IncreaseEdicts();
1046 // if IncreaseEdicts was called the base pointer needs to be updated
1048 val = (prvm_eval_t *)(ent->fields.vp + key->ofs);
1049 val->edict = PRVM_EDICT_TO_PROG(PRVM_EDICT_NUM((int)i));
1055 Con_DPrintf("PRVM_ED_ParseEpair: Bogus field name %s in %s\n", s, PRVM_NAME);
1058 def = PRVM_ED_FindField(s + 1);
1061 Con_DPrintf("PRVM_ED_ParseEpair: Can't find field %s in %s\n", s, PRVM_NAME);
1064 val->_int = def->ofs;
1068 func = PRVM_ED_FindFunction(s);
1071 Con_Printf("PRVM_ED_ParseEpair: Can't find function %s in %s\n", s, PRVM_NAME);
1074 val->function = func - prog->functions;
1078 Con_Printf("PRVM_ED_ParseEpair: Unknown key->type %i for key \"%s\" on %s\n", key->type, PRVM_GetString(key->s_name), PRVM_NAME);
1088 Console command to send a string to QC function GameCommand of the
1092 sv_cmd adminmsg 3 "do not teamkill"
1093 cl_cmd someclientcommand
1094 menu_cmd somemenucommand
1096 All progs can support this extension; sg calls it in server QC, cg in client
1100 void PRVM_GameCommand(const char *whichprogs, const char *whichcmd)
1104 Con_Printf("%s text...\n", whichcmd);
1109 if(!PRVM_SetProgFromString(whichprogs))
1110 // note: this is not PRVM_SetProg because that one aborts "hard" using PRVM_Error
1111 // also, it makes printing error messages easier!
1113 Con_Printf("%s program not loaded.\n", whichprogs);
1117 if(!prog->funcoffsets.GameCommand)
1119 Con_Printf("%s program do not support GameCommand!\n", whichprogs);
1123 int restorevm_tempstringsbuf_cursize;
1128 restorevm_tempstringsbuf_cursize = vm_tempstringsbuf.cursize;
1129 PRVM_G_INT(OFS_PARM0) = PRVM_SetTempString(s ? s : "");
1130 PRVM_ExecuteProgram (prog->funcoffsets.GameCommand, "QC function GameCommand is missing");
1131 vm_tempstringsbuf.cursize = restorevm_tempstringsbuf_cursize;
1136 void PRVM_GameCommand_Server_f(void)
1138 PRVM_GameCommand("server", "sv_cmd");
1140 void PRVM_GameCommand_Client_f(void)
1142 PRVM_GameCommand("client", "cl_cmd");
1144 void PRVM_GameCommand_Menu_f(void)
1146 PRVM_GameCommand("menu", "menu_cmd");
1153 Console command to load a field of a specified edict
1156 void PRVM_ED_EdictGet_f(void)
1163 if(Cmd_Argc() != 4 && Cmd_Argc() != 5)
1165 Con_Print("prvm_edictget <program name> <edict number> <field> [<cvar>]\n");
1170 if(!PRVM_SetProgFromString(Cmd_Argv(1)))
1172 Con_Printf("Wrong program name %s !\n", Cmd_Argv(1));
1176 ed = PRVM_EDICT_NUM(atoi(Cmd_Argv(2)));
1178 if((key = PRVM_ED_FindField(Cmd_Argv(3))) == 0)
1180 Con_Printf("Key %s not found !\n", Cmd_Argv(3));
1184 v = (prvm_eval_t *)(ed->fields.vp + key->ofs);
1185 s = PRVM_UglyValueString(key->type, v);
1188 cvar_t *cvar = Cvar_FindVar(Cmd_Argv(4));
1189 if (cvar && cvar->flags & CVAR_READONLY)
1191 Con_Printf("prvm_edictget: %s is read-only\n", cvar->name);
1194 Cvar_Get(Cmd_Argv(4), s, 0, NULL);
1197 Con_Printf("%s\n", s);
1203 void PRVM_ED_GlobalGet_f(void)
1209 if(Cmd_Argc() != 3 && Cmd_Argc() != 4)
1211 Con_Print("prvm_globalget <program name> <global> [<cvar>]\n");
1216 if(!PRVM_SetProgFromString(Cmd_Argv(1)))
1218 Con_Printf("Wrong program name %s !\n", Cmd_Argv(1));
1222 key = PRVM_ED_FindGlobal(Cmd_Argv(2));
1225 Con_Printf( "No global '%s' in %s!\n", Cmd_Argv(2), Cmd_Argv(1) );
1229 v = (prvm_eval_t *) &prog->globals.generic[key->ofs];
1230 s = PRVM_UglyValueString(key->type, v);
1233 cvar_t *cvar = Cvar_FindVar(Cmd_Argv(3));
1234 if (cvar && cvar->flags & CVAR_READONLY)
1236 Con_Printf("prvm_globalget: %s is read-only\n", cvar->name);
1239 Cvar_Get(Cmd_Argv(3), s, 0, NULL);
1242 Con_Printf("%s\n", s);
1252 Console command to set a field of a specified edict
1255 void PRVM_ED_EdictSet_f(void)
1262 Con_Print("prvm_edictset <program name> <edict number> <field> <value>\n");
1267 if(!PRVM_SetProgFromString(Cmd_Argv(1)))
1269 Con_Printf("Wrong program name %s !\n", Cmd_Argv(1));
1273 ed = PRVM_EDICT_NUM(atoi(Cmd_Argv(2)));
1275 if((key = PRVM_ED_FindField(Cmd_Argv(3))) == 0)
1276 Con_Printf("Key %s not found !\n", Cmd_Argv(3));
1278 PRVM_ED_ParseEpair(ed, key, Cmd_Argv(4), true);
1284 ====================
1287 Parses an edict out of the given string, returning the new position
1288 ed should be a properly initialized empty edict.
1289 Used for initial level load and for savegames.
1290 ====================
1292 const char *PRVM_ED_ParseEdict (const char *data, prvm_edict_t *ent)
1302 // go through all the dictionary pairs
1306 if (!COM_ParseToken_Simple(&data, false, false))
1307 PRVM_ERROR ("PRVM_ED_ParseEdict: EOF without closing brace");
1308 if (developer_entityparsing.integer)
1309 Con_Printf("Key: \"%s\"", com_token);
1310 if (com_token[0] == '}')
1313 // anglehack is to allow QuakeEd to write single scalar angles
1314 // and allow them to be turned into vectors. (FIXME...)
1315 if (!strcmp(com_token, "angle"))
1317 strlcpy (com_token, "angles", sizeof(com_token));
1323 // FIXME: change light to _light to get rid of this hack
1324 if (!strcmp(com_token, "light"))
1325 strlcpy (com_token, "light_lev", sizeof(com_token)); // hack for single light def
1327 strlcpy (keyname, com_token, sizeof(keyname));
1329 // another hack to fix keynames with trailing spaces
1330 n = strlen(keyname);
1331 while (n && keyname[n-1] == ' ')
1338 if (!COM_ParseToken_Simple(&data, false, false))
1339 PRVM_ERROR ("PRVM_ED_ParseEdict: EOF without closing brace");
1340 if (developer_entityparsing.integer)
1341 Con_Printf(" \"%s\"\n", com_token);
1343 if (com_token[0] == '}')
1344 PRVM_ERROR ("PRVM_ED_ParseEdict: closing brace without data");
1348 // ignore attempts to set key "" (this problem occurs in nehahra neh1m8.bsp)
1352 // keynames with a leading underscore are used for utility comments,
1353 // and are immediately discarded by quake
1354 if (keyname[0] == '_')
1357 key = PRVM_ED_FindField (keyname);
1360 Con_DPrintf("%s: '%s' is not a field\n", PRVM_NAME, keyname);
1367 strlcpy (temp, com_token, sizeof(temp));
1368 dpsnprintf (com_token, sizeof(com_token), "0 %s 0", temp);
1371 if (!PRVM_ED_ParseEpair(ent, key, com_token, strcmp(keyname, "wad") != 0))
1372 PRVM_ERROR ("PRVM_ED_ParseEdict: parse error");
1376 ent->priv.required->free = true;
1384 PRVM_ED_LoadFromFile
1386 The entities are directly placed in the array, rather than allocated with
1387 PRVM_ED_Alloc, because otherwise an error loading the map would have entity
1388 number references out of order.
1390 Creates a server's entity / program execution context by
1391 parsing textual entity definitions out of an ent file.
1393 Used for both fresh maps and savegame loads. A fresh map would also need
1394 to call PRVM_ED_CallSpawnFunctions () to let the objects initialize themselves.
1397 void PRVM_ED_LoadFromFile (const char *data)
1400 int parsed, inhibited, spawned, died;
1401 const char *funcname;
1409 prvm_reuseedicts_always_allow = realtime;
1414 // parse the opening brace
1415 if (!COM_ParseToken_Simple(&data, false, false))
1417 if (com_token[0] != '{')
1418 PRVM_ERROR ("PRVM_ED_LoadFromFile: %s: found %s when expecting {", PRVM_NAME, com_token);
1420 // CHANGED: this is not conform to PR_LoadFromFile
1421 if(prog->loadintoworld)
1423 prog->loadintoworld = false;
1424 ent = PRVM_EDICT_NUM(0);
1427 ent = PRVM_ED_Alloc();
1430 if (ent != prog->edicts) // hack
1431 memset (ent->fields.vp, 0, prog->progs->entityfields * 4);
1433 data = PRVM_ED_ParseEdict (data, ent);
1436 // remove the entity ?
1437 if(prog->load_edict && !prog->load_edict(ent))
1444 if (prog->funcoffsets.SV_OnEntityPreSpawnFunction)
1447 PRVM_GLOBALFIELDVALUE(prog->globaloffsets.self)->edict = PRVM_EDICT_TO_PROG(ent);
1448 PRVM_ExecuteProgram (prog->funcoffsets.SV_OnEntityPreSpawnFunction, "QC function SV_OnEntityPreSpawnFunction is missing");
1451 if(ent->priv.required->free)
1458 // immediately call spawn function, but only if there is a self global and a classname
1460 if(!ent->priv.required->free)
1461 if(prog->globaloffsets.self >= 0 && prog->fieldoffsets.classname >= 0)
1463 string_t handle = PRVM_EDICTFIELDVALUE(ent, prog->fieldoffsets.classname)->string;
1466 Con_Print("No classname for:\n");
1467 PRVM_ED_Print(ent, NULL);
1472 // look for the spawn function
1473 funcname = PRVM_GetString(handle);
1474 func = PRVM_ED_FindFunction (va("spawnfunc_%s", funcname));
1476 if(prog->globaloffsets.require_spawnfunc_prefix < 0)
1477 func = PRVM_ED_FindFunction (funcname);
1481 // check for OnEntityNoSpawnFunction
1482 if (prog->funcoffsets.SV_OnEntityNoSpawnFunction)
1485 PRVM_GLOBALFIELDVALUE(prog->globaloffsets.self)->edict = PRVM_EDICT_TO_PROG(ent);
1486 PRVM_ExecuteProgram (prog->funcoffsets.SV_OnEntityNoSpawnFunction, "QC function SV_OnEntityNoSpawnFunction is missing");
1490 if (developer.integer > 0) // don't confuse non-developers with errors
1492 Con_Print("No spawn function for:\n");
1493 PRVM_ED_Print(ent, NULL);
1496 continue; // not included in "inhibited" count
1502 PRVM_GLOBALFIELDVALUE(prog->globaloffsets.self)->edict = PRVM_EDICT_TO_PROG(ent);
1503 PRVM_ExecuteProgram (func - prog->functions, "");
1507 if(!ent->priv.required->free)
1508 if (prog->funcoffsets.SV_OnEntityPostSpawnFunction)
1511 PRVM_GLOBALFIELDVALUE(prog->globaloffsets.self)->edict = PRVM_EDICT_TO_PROG(ent);
1512 PRVM_ExecuteProgram (prog->funcoffsets.SV_OnEntityPostSpawnFunction, "QC function SV_OnEntityPostSpawnFunction is missing");
1516 if (ent->priv.required->free)
1520 Con_DPrintf("%s: %i new entities parsed, %i new inhibited, %i (%i new) spawned (whereas %i removed self, %i stayed)\n", PRVM_NAME, parsed, inhibited, prog->num_edicts, spawned, died, spawned - died);
1522 prvm_reuseedicts_always_allow = 0;
1525 void PRVM_FindOffsets(void)
1527 // field and global searches use -1 for NULL
1528 memset(&prog->fieldoffsets, -1, sizeof(prog->fieldoffsets));
1529 memset(&prog->globaloffsets, -1, sizeof(prog->globaloffsets));
1530 // functions use 0 for NULL
1531 memset(&prog->funcoffsets, 0, sizeof(prog->funcoffsets));
1533 // server and client qc use a lot of similar fields, so this is combined
1534 prog->fieldoffsets.SendEntity = PRVM_ED_FindFieldOffset("SendEntity");
1535 prog->fieldoffsets.SendFlags = PRVM_ED_FindFieldOffset("SendFlags");
1536 prog->fieldoffsets.Version = PRVM_ED_FindFieldOffset("Version");
1537 prog->fieldoffsets.alpha = PRVM_ED_FindFieldOffset("alpha");
1538 prog->fieldoffsets.ammo_cells1 = PRVM_ED_FindFieldOffset("ammo_cells1");
1539 prog->fieldoffsets.ammo_lava_nails = PRVM_ED_FindFieldOffset("ammo_lava_nails");
1540 prog->fieldoffsets.ammo_multi_rockets = PRVM_ED_FindFieldOffset("ammo_multi_rockets");
1541 prog->fieldoffsets.ammo_nails1 = PRVM_ED_FindFieldOffset("ammo_nails1");
1542 prog->fieldoffsets.ammo_plasma = PRVM_ED_FindFieldOffset("ammo_plasma");
1543 prog->fieldoffsets.ammo_rockets1 = PRVM_ED_FindFieldOffset("ammo_rockets1");
1544 prog->fieldoffsets.ammo_shells1 = PRVM_ED_FindFieldOffset("ammo_shells1");
1545 prog->fieldoffsets.angles = PRVM_ED_FindFieldOffset("angles");
1546 prog->fieldoffsets.button3 = PRVM_ED_FindFieldOffset("button3");
1547 prog->fieldoffsets.button4 = PRVM_ED_FindFieldOffset("button4");
1548 prog->fieldoffsets.button5 = PRVM_ED_FindFieldOffset("button5");
1549 prog->fieldoffsets.button6 = PRVM_ED_FindFieldOffset("button6");
1550 prog->fieldoffsets.button7 = PRVM_ED_FindFieldOffset("button7");
1551 prog->fieldoffsets.button8 = PRVM_ED_FindFieldOffset("button8");
1552 prog->fieldoffsets.button9 = PRVM_ED_FindFieldOffset("button9");
1553 prog->fieldoffsets.button10 = PRVM_ED_FindFieldOffset("button10");
1554 prog->fieldoffsets.button11 = PRVM_ED_FindFieldOffset("button11");
1555 prog->fieldoffsets.button12 = PRVM_ED_FindFieldOffset("button12");
1556 prog->fieldoffsets.button13 = PRVM_ED_FindFieldOffset("button13");
1557 prog->fieldoffsets.button14 = PRVM_ED_FindFieldOffset("button14");
1558 prog->fieldoffsets.button15 = PRVM_ED_FindFieldOffset("button15");
1559 prog->fieldoffsets.button16 = PRVM_ED_FindFieldOffset("button16");
1560 prog->fieldoffsets.buttonchat = PRVM_ED_FindFieldOffset("buttonchat");
1561 prog->fieldoffsets.buttonuse = PRVM_ED_FindFieldOffset("buttonuse");
1562 prog->fieldoffsets.chain = PRVM_ED_FindFieldOffset("chain");
1563 prog->fieldoffsets.classname = PRVM_ED_FindFieldOffset("classname");
1564 prog->fieldoffsets.clientcamera = PRVM_ED_FindFieldOffset("clientcamera");
1565 prog->fieldoffsets.clientcolors = PRVM_ED_FindFieldOffset("clientcolors");
1566 prog->fieldoffsets.clientstatus = PRVM_ED_FindFieldOffset("clientstatus");
1567 prog->fieldoffsets.color = PRVM_ED_FindFieldOffset("color");
1568 prog->fieldoffsets.colormod = PRVM_ED_FindFieldOffset("colormod");
1569 prog->fieldoffsets.contentstransition = PRVM_ED_FindFieldOffset("contentstransition");
1570 prog->fieldoffsets.cursor_active = PRVM_ED_FindFieldOffset("cursor_active");
1571 prog->fieldoffsets.cursor_screen = PRVM_ED_FindFieldOffset("cursor_screen");
1572 prog->fieldoffsets.cursor_trace_endpos = PRVM_ED_FindFieldOffset("cursor_trace_endpos");
1573 prog->fieldoffsets.cursor_trace_ent = PRVM_ED_FindFieldOffset("cursor_trace_ent");
1574 prog->fieldoffsets.cursor_trace_start = PRVM_ED_FindFieldOffset("cursor_trace_start");
1575 prog->fieldoffsets.customizeentityforclient = PRVM_ED_FindFieldOffset("customizeentityforclient");
1576 prog->fieldoffsets.dimension_hit = PRVM_ED_FindFieldOffset("dimension_hit");
1577 prog->fieldoffsets.dimension_solid = PRVM_ED_FindFieldOffset("dimension_solid");
1578 prog->fieldoffsets.disableclientprediction = PRVM_ED_FindFieldOffset("disableclientprediction");
1579 prog->fieldoffsets.discardabledemo = PRVM_ED_FindFieldOffset("discardabledemo");
1580 prog->fieldoffsets.dphitcontentsmask = PRVM_ED_FindFieldOffset("dphitcontentsmask");
1581 prog->fieldoffsets.drawonlytoclient = PRVM_ED_FindFieldOffset("drawonlytoclient");
1582 prog->fieldoffsets.exteriormodeltoclient = PRVM_ED_FindFieldOffset("exteriormodeltoclient");
1583 prog->fieldoffsets.fatness = PRVM_ED_FindFieldOffset("fatness");
1584 prog->fieldoffsets.forceshader = PRVM_ED_FindFieldOffset("forceshader");
1585 prog->fieldoffsets.frame = PRVM_ED_FindFieldOffset("frame");
1586 prog->fieldoffsets.frame1time = PRVM_ED_FindFieldOffset("frame1time");
1587 prog->fieldoffsets.frame2 = PRVM_ED_FindFieldOffset("frame2");
1588 prog->fieldoffsets.frame2time = PRVM_ED_FindFieldOffset("frame2time");
1589 prog->fieldoffsets.frame3 = PRVM_ED_FindFieldOffset("frame3");
1590 prog->fieldoffsets.frame3time = PRVM_ED_FindFieldOffset("frame3time");
1591 prog->fieldoffsets.frame4 = PRVM_ED_FindFieldOffset("frame4");
1592 prog->fieldoffsets.frame4time = PRVM_ED_FindFieldOffset("frame4time");
1593 prog->fieldoffsets.fullbright = PRVM_ED_FindFieldOffset("fullbright");
1594 prog->fieldoffsets.glow_color = PRVM_ED_FindFieldOffset("glow_color");
1595 prog->fieldoffsets.glow_size = PRVM_ED_FindFieldOffset("glow_size");
1596 prog->fieldoffsets.glow_trail = PRVM_ED_FindFieldOffset("glow_trail");
1597 prog->fieldoffsets.glowmod = PRVM_ED_FindFieldOffset("glowmod");
1598 prog->fieldoffsets.gravity = PRVM_ED_FindFieldOffset("gravity");
1599 prog->fieldoffsets.groundentity = PRVM_ED_FindFieldOffset("groundentity");
1600 prog->fieldoffsets.hull = PRVM_ED_FindFieldOffset("hull");
1601 prog->fieldoffsets.ideal_yaw = PRVM_ED_FindFieldOffset("ideal_yaw");
1602 prog->fieldoffsets.idealpitch = PRVM_ED_FindFieldOffset("idealpitch");
1603 prog->fieldoffsets.items2 = PRVM_ED_FindFieldOffset("items2");
1604 prog->fieldoffsets.lerpfrac = PRVM_ED_FindFieldOffset("lerpfrac");
1605 prog->fieldoffsets.lerpfrac3 = PRVM_ED_FindFieldOffset("lerpfrac3");
1606 prog->fieldoffsets.lerpfrac4 = PRVM_ED_FindFieldOffset("lerpfrac4");
1607 prog->fieldoffsets.light_lev = PRVM_ED_FindFieldOffset("light_lev");
1608 prog->fieldoffsets.message = PRVM_ED_FindFieldOffset("message");
1609 prog->fieldoffsets.modelflags = PRVM_ED_FindFieldOffset("modelflags");
1610 prog->fieldoffsets.movement = PRVM_ED_FindFieldOffset("movement");
1611 prog->fieldoffsets.movetypesteplandevent = PRVM_ED_FindFieldOffset("movetypesteplandevent");
1612 prog->fieldoffsets.netaddress = PRVM_ED_FindFieldOffset("netaddress");
1613 prog->fieldoffsets.nextthink = PRVM_ED_FindFieldOffset("nextthink");
1614 prog->fieldoffsets.nodrawtoclient = PRVM_ED_FindFieldOffset("nodrawtoclient");
1615 prog->fieldoffsets.pflags = PRVM_ED_FindFieldOffset("pflags");
1616 prog->fieldoffsets.ping = PRVM_ED_FindFieldOffset("ping");
1617 prog->fieldoffsets.packetloss = PRVM_ED_FindFieldOffset("ping_packetloss");
1618 prog->fieldoffsets.movementloss = PRVM_ED_FindFieldOffset("ping_movementloss");
1619 prog->fieldoffsets.pitch_speed = PRVM_ED_FindFieldOffset("pitch_speed");
1620 prog->fieldoffsets.playermodel = PRVM_ED_FindFieldOffset("playermodel");
1621 prog->fieldoffsets.playerskin = PRVM_ED_FindFieldOffset("playerskin");
1622 prog->fieldoffsets.pmodel = PRVM_ED_FindFieldOffset("pmodel");
1623 prog->fieldoffsets.punchvector = PRVM_ED_FindFieldOffset("punchvector");
1624 prog->fieldoffsets.renderamt = PRVM_ED_FindFieldOffset("renderamt"); // HalfLife support
1625 prog->fieldoffsets.renderflags = PRVM_ED_FindFieldOffset("renderflags");
1626 prog->fieldoffsets.rendermode = PRVM_ED_FindFieldOffset("rendermode"); // HalfLife support
1627 prog->fieldoffsets.scale = PRVM_ED_FindFieldOffset("scale");
1628 prog->fieldoffsets.shadertime = PRVM_ED_FindFieldOffset("shadertime");
1629 prog->fieldoffsets.skeletonindex = PRVM_ED_FindFieldOffset("skeletonindex");
1630 prog->fieldoffsets.style = PRVM_ED_FindFieldOffset("style");
1631 prog->fieldoffsets.tag_entity = PRVM_ED_FindFieldOffset("tag_entity");
1632 prog->fieldoffsets.tag_index = PRVM_ED_FindFieldOffset("tag_index");
1633 prog->fieldoffsets.think = PRVM_ED_FindFieldOffset("think");
1634 prog->fieldoffsets.viewmodelforclient = PRVM_ED_FindFieldOffset("viewmodelforclient");
1635 prog->fieldoffsets.viewzoom = PRVM_ED_FindFieldOffset("viewzoom");
1636 prog->fieldoffsets.yaw_speed = PRVM_ED_FindFieldOffset("yaw_speed");
1637 prog->fieldoffsets.bouncefactor = PRVM_ED_FindFieldOffset("bouncefactor");
1638 prog->fieldoffsets.bouncestop = PRVM_ED_FindFieldOffset("bouncestop");
1640 prog->fieldoffsets.solid = PRVM_ED_FindFieldOffset("solid");
1641 prog->fieldoffsets.movetype = PRVM_ED_FindFieldOffset("movetype");
1642 prog->fieldoffsets.modelindex = PRVM_ED_FindFieldOffset("modelindex");
1643 prog->fieldoffsets.mins = PRVM_ED_FindFieldOffset("mins");
1644 prog->fieldoffsets.maxs = PRVM_ED_FindFieldOffset("maxs");
1645 prog->fieldoffsets.mass = PRVM_ED_FindFieldOffset("mass");
1646 prog->fieldoffsets.origin = PRVM_ED_FindFieldOffset("origin");
1647 prog->fieldoffsets.velocity = PRVM_ED_FindFieldOffset("velocity");
1648 //prog->fieldoffsets.axis_forward = PRVM_ED_FindFieldOffset("axis_forward");
1649 //prog->fieldoffsets.axis_left = PRVM_ED_FindFieldOffset("axis_left");
1650 //prog->fieldoffsets.axis_up = PRVM_ED_FindFieldOffset("axis_up");
1651 //prog->fieldoffsets.spinvelocity = PRVM_ED_FindFieldOffset("spinvelocity");
1652 prog->fieldoffsets.angles = PRVM_ED_FindFieldOffset("angles");
1653 prog->fieldoffsets.avelocity = PRVM_ED_FindFieldOffset("avelocity");
1654 prog->fieldoffsets.aiment = PRVM_ED_FindFieldOffset("aiment");
1655 prog->fieldoffsets.enemy = PRVM_ED_FindFieldOffset("enemy");
1656 prog->fieldoffsets.jointtype = PRVM_ED_FindFieldOffset("jointtype");
1657 prog->fieldoffsets.movedir = PRVM_ED_FindFieldOffset("movedir");
1659 prog->fieldoffsets.camera_transform = PRVM_ED_FindFieldOffset("camera_transform");
1660 prog->fieldoffsets.userwavefunc_param0 = PRVM_ED_FindFieldOffset("userwavefunc_param0");
1661 prog->fieldoffsets.userwavefunc_param1 = PRVM_ED_FindFieldOffset("userwavefunc_param1");
1662 prog->fieldoffsets.userwavefunc_param2 = PRVM_ED_FindFieldOffset("userwavefunc_param2");
1663 prog->fieldoffsets.userwavefunc_param3 = PRVM_ED_FindFieldOffset("userwavefunc_param3");
1665 prog->funcoffsets.CSQC_ConsoleCommand = PRVM_ED_FindFunctionOffset("CSQC_ConsoleCommand");
1666 prog->funcoffsets.CSQC_Ent_Remove = PRVM_ED_FindFunctionOffset("CSQC_Ent_Remove");
1667 prog->funcoffsets.CSQC_Ent_Spawn = PRVM_ED_FindFunctionOffset("CSQC_Ent_Spawn");
1668 prog->funcoffsets.CSQC_Ent_Update = PRVM_ED_FindFunctionOffset("CSQC_Ent_Update");
1669 prog->funcoffsets.CSQC_Event = PRVM_ED_FindFunctionOffset("CSQC_Event");
1670 prog->funcoffsets.CSQC_Event_Sound = PRVM_ED_FindFunctionOffset("CSQC_Event_Sound");
1671 prog->funcoffsets.CSQC_Init = PRVM_ED_FindFunctionOffset("CSQC_Init");
1672 prog->funcoffsets.CSQC_InputEvent = PRVM_ED_FindFunctionOffset("CSQC_InputEvent");
1673 prog->funcoffsets.CSQC_Parse_CenterPrint = PRVM_ED_FindFunctionOffset("CSQC_Parse_CenterPrint");
1674 prog->funcoffsets.CSQC_Parse_Print = PRVM_ED_FindFunctionOffset("CSQC_Parse_Print");
1675 prog->funcoffsets.CSQC_Parse_StuffCmd = PRVM_ED_FindFunctionOffset("CSQC_Parse_StuffCmd");
1676 prog->funcoffsets.CSQC_Parse_TempEntity = PRVM_ED_FindFunctionOffset("CSQC_Parse_TempEntity");
1677 prog->funcoffsets.CSQC_Shutdown = PRVM_ED_FindFunctionOffset("CSQC_Shutdown");
1678 prog->funcoffsets.CSQC_UpdateView = PRVM_ED_FindFunctionOffset("CSQC_UpdateView");
1679 prog->funcoffsets.EndFrame = PRVM_ED_FindFunctionOffset("EndFrame");
1680 prog->funcoffsets.GameCommand = PRVM_ED_FindFunctionOffset("GameCommand");
1681 prog->funcoffsets.Gecko_Query = PRVM_ED_FindFunctionOffset("Gecko_Query");
1682 prog->funcoffsets.RestoreGame = PRVM_ED_FindFunctionOffset("RestoreGame");
1683 prog->funcoffsets.SV_ChangeTeam = PRVM_ED_FindFunctionOffset("SV_ChangeTeam");
1684 prog->funcoffsets.SV_OnEntityNoSpawnFunction = PRVM_ED_FindFunctionOffset("SV_OnEntityNoSpawnFunction");
1685 prog->funcoffsets.SV_OnEntityPostSpawnFunction = PRVM_ED_FindFunctionOffset("SV_OnEntityPostSpawnFunction");
1686 prog->funcoffsets.SV_OnEntityPreSpawnFunction = PRVM_ED_FindFunctionOffset("SV_OnEntityPreSpawnFunction");
1687 prog->funcoffsets.SV_ParseClientCommand = PRVM_ED_FindFunctionOffset("SV_ParseClientCommand");
1688 prog->funcoffsets.SV_PausedTic = PRVM_ED_FindFunctionOffset("SV_PausedTic");
1689 prog->funcoffsets.SV_PlayerPhysics = PRVM_ED_FindFunctionOffset("SV_PlayerPhysics");
1690 prog->funcoffsets.SV_Shutdown = PRVM_ED_FindFunctionOffset("SV_Shutdown");
1691 prog->funcoffsets.URI_Get_Callback = PRVM_ED_FindFunctionOffset("URI_Get_Callback");
1692 prog->globaloffsets.SV_InitCmd = PRVM_ED_FindGlobalOffset("SV_InitCmd");
1693 prog->globaloffsets.coop = PRVM_ED_FindGlobalOffset("coop");
1694 prog->globaloffsets.deathmatch = PRVM_ED_FindGlobalOffset("deathmatch");
1695 prog->globaloffsets.dmg_origin = PRVM_ED_FindGlobalOffset("dmg_origin");
1696 prog->globaloffsets.dmg_save = PRVM_ED_FindGlobalOffset("dmg_save");
1697 prog->globaloffsets.dmg_take = PRVM_ED_FindGlobalOffset("dmg_take");
1698 prog->globaloffsets.drawfont = PRVM_ED_FindGlobalOffset("drawfont");
1699 prog->globaloffsets.drawfontscale = PRVM_ED_FindGlobalOffset("drawfontscale");
1700 prog->globaloffsets.gettaginfo_forward = PRVM_ED_FindGlobalOffset("gettaginfo_forward");
1701 prog->globaloffsets.gettaginfo_name = PRVM_ED_FindGlobalOffset("gettaginfo_name");
1702 prog->globaloffsets.gettaginfo_offset = PRVM_ED_FindGlobalOffset("gettaginfo_offset");
1703 prog->globaloffsets.gettaginfo_parent = PRVM_ED_FindGlobalOffset("gettaginfo_parent");
1704 prog->globaloffsets.gettaginfo_right = PRVM_ED_FindGlobalOffset("gettaginfo_right");
1705 prog->globaloffsets.gettaginfo_up = PRVM_ED_FindGlobalOffset("gettaginfo_up");
1706 prog->globaloffsets.transparent_offset = PRVM_ED_FindGlobalOffset("transparent_offset");
1707 prog->globaloffsets.intermission = PRVM_ED_FindGlobalOffset("intermission");
1708 prog->globaloffsets.require_spawnfunc_prefix = PRVM_ED_FindGlobalOffset("require_spawnfunc_prefix");
1709 prog->globaloffsets.sb_showscores = PRVM_ED_FindGlobalOffset("sb_showscores");
1710 prog->globaloffsets.self = PRVM_ED_FindGlobalOffset("self");
1711 prog->globaloffsets.serverdeltatime = PRVM_ED_FindGlobalOffset("serverdeltatime");
1712 prog->globaloffsets.serverprevtime = PRVM_ED_FindGlobalOffset("serverprevtime");
1713 prog->globaloffsets.servertime = PRVM_ED_FindGlobalOffset("servertime");
1714 prog->globaloffsets.time = PRVM_ED_FindGlobalOffset("time");
1715 prog->globaloffsets.trace_allsolid = PRVM_ED_FindGlobalOffset("trace_allsolid");
1716 prog->globaloffsets.trace_dphitcontents = PRVM_ED_FindGlobalOffset("trace_dphitcontents");
1717 prog->globaloffsets.trace_dphitq3surfaceflags = PRVM_ED_FindGlobalOffset("trace_dphitq3surfaceflags");
1718 prog->globaloffsets.trace_dphittexturename = PRVM_ED_FindGlobalOffset("trace_dphittexturename");
1719 prog->globaloffsets.trace_dpstartcontents = PRVM_ED_FindGlobalOffset("trace_dpstartcontents");
1720 prog->globaloffsets.trace_endpos = PRVM_ED_FindGlobalOffset("trace_endpos");
1721 prog->globaloffsets.trace_ent = PRVM_ED_FindGlobalOffset("trace_ent");
1722 prog->globaloffsets.trace_fraction = PRVM_ED_FindGlobalOffset("trace_fraction");
1723 prog->globaloffsets.trace_inopen = PRVM_ED_FindGlobalOffset("trace_inopen");
1724 prog->globaloffsets.trace_inwater = PRVM_ED_FindGlobalOffset("trace_inwater");
1725 prog->globaloffsets.trace_networkentity = PRVM_ED_FindGlobalOffset("trace_networkentity");
1726 prog->globaloffsets.trace_plane_dist = PRVM_ED_FindGlobalOffset("trace_plane_dist");
1727 prog->globaloffsets.trace_plane_normal = PRVM_ED_FindGlobalOffset("trace_plane_normal");
1728 prog->globaloffsets.trace_startsolid = PRVM_ED_FindGlobalOffset("trace_startsolid");
1729 prog->globaloffsets.v_forward = PRVM_ED_FindGlobalOffset("v_forward");
1730 prog->globaloffsets.v_right = PRVM_ED_FindGlobalOffset("v_right");
1731 prog->globaloffsets.v_up = PRVM_ED_FindGlobalOffset("v_up");
1732 prog->globaloffsets.view_angles = PRVM_ED_FindGlobalOffset("view_angles");
1733 prog->globaloffsets.worldstatus = PRVM_ED_FindGlobalOffset("worldstatus");
1734 prog->globaloffsets.particles_alphamin = PRVM_ED_FindGlobalOffset("particles_alphamin");
1735 prog->globaloffsets.particles_alphamax = PRVM_ED_FindGlobalOffset("particles_alphamax");
1736 prog->globaloffsets.particles_colormin = PRVM_ED_FindGlobalOffset("particles_colormin");
1737 prog->globaloffsets.particles_colormax = PRVM_ED_FindGlobalOffset("particles_colormax");
1739 // menu qc only uses some functions, nothing else
1740 prog->funcoffsets.m_draw = PRVM_ED_FindFunctionOffset("m_draw");
1741 prog->funcoffsets.m_init = PRVM_ED_FindFunctionOffset("m_init");
1742 prog->funcoffsets.m_keydown = PRVM_ED_FindFunctionOffset("m_keydown");
1743 prog->funcoffsets.m_keyup = PRVM_ED_FindFunctionOffset("m_keyup");
1744 prog->funcoffsets.m_shutdown = PRVM_ED_FindFunctionOffset("m_shutdown");
1745 prog->funcoffsets.m_toggle = PRVM_ED_FindFunctionOffset("m_toggle");
1750 typedef struct dpfield_s
1757 #define DPFIELDS (sizeof(dpfields) / sizeof(dpfield_t))
1759 dpfield_t dpfields[] =
1770 #define PO_HASHSIZE 16384
1771 typedef struct po_string_s
1774 struct po_string_s *nextonhashchain;
1779 po_string_t *hashtable[PO_HASHSIZE];
1782 void PRVM_PO_UnparseString(char *out, const char *in, size_t outsize)
1791 case '\a': if(outsize >= 2) { *out++ = '\\'; *out++ = 'a'; outsize -= 2; } break;
1792 case '\b': if(outsize >= 2) { *out++ = '\\'; *out++ = 'b'; outsize -= 2; } break;
1793 case '\t': if(outsize >= 2) { *out++ = '\\'; *out++ = 't'; outsize -= 2; } break;
1794 case '\r': if(outsize >= 2) { *out++ = '\\'; *out++ = 'r'; outsize -= 2; } break;
1795 case '\n': if(outsize >= 2) { *out++ = '\\'; *out++ = 'n'; outsize -= 2; } break;
1796 case '\\': if(outsize >= 2) { *out++ = '\\'; *out++ = '\\'; outsize -= 2; } break;
1797 case '"': if(outsize >= 2) { *out++ = '\\'; *out++ = '"'; outsize -= 2; } break;
1799 if(*in >= 0 && *in <= 0x1F)
1804 *out++ = '0' + ((*in & 0700) >> 6);
1805 *out++ = '0' + ((*in & 0070) >> 3);
1806 *out++ = '0' + ((*in & 0007));
1823 void PRVM_PO_ParseString(char *out, const char *in, size_t outsize)
1836 case 'a': if(outsize > 0) { *out++ = '\a'; --outsize; } break;
1837 case 'b': if(outsize > 0) { *out++ = '\b'; --outsize; } break;
1838 case 't': if(outsize > 0) { *out++ = '\t'; --outsize; } break;
1839 case 'r': if(outsize > 0) { *out++ = '\r'; --outsize; } break;
1840 case 'n': if(outsize > 0) { *out++ = '\n'; --outsize; } break;
1841 case '\\': if(outsize > 0) { *out++ = '\\'; --outsize; } break;
1842 case '"': if(outsize > 0) { *out++ = '"'; --outsize; } break;
1843 case '0': case '1': case '2': case '3': case '4': case '5': case '6': case '7':
1847 if(*in >= '0' && *in <= '7')
1850 *out = (*out << 3) | (*in - '0');
1853 if(*in >= '0' && *in <= '7')
1856 *out = (*out << 3) | (*in - '0');
1867 if(outsize > 0) { *out++ = *in; --outsize; }
1882 po_t *PRVM_PO_Load(const char *filename, mempool_t *pool)
1887 char inbuf[MAX_INPUTLINE];
1888 char decodedbuf[MAX_INPUTLINE];
1891 po_string_t thisstr;
1892 const char *buf = (const char *) FS_LoadFile(filename, pool, true, NULL);
1897 po = Mem_Alloc(pool, sizeof(*po));
1898 memset(po, 0, sizeof(*po));
1906 p = strchr(p, '\n');
1912 if(*p == '\r' || *p == '\n')
1917 if(!strncmp(p, "msgid \"", 7))
1922 else if(!strncmp(p, "msgstr \"", 8))
1929 p = strchr(p, '\n');
1939 q = strchr(p, '\n');
1946 if((size_t)(q - p) >= (size_t) sizeof(inbuf))
1948 strlcpy(inbuf, p, q - p); // not - 1, because this adds a NUL
1949 PRVM_PO_ParseString(decodedbuf + decodedpos, inbuf, sizeof(decodedbuf) - decodedpos);
1950 decodedpos += strlen(decodedbuf + decodedpos);
1960 Mem_Free(thisstr.key);
1961 thisstr.key = Mem_Alloc(pool, decodedpos + 1);
1962 memcpy(thisstr.key, decodedbuf, decodedpos + 1);
1964 else if(decodedpos > 0 && thisstr.key) // skip empty translation results
1966 thisstr.value = Mem_Alloc(pool, decodedpos + 1);
1967 memcpy(thisstr.value, decodedbuf, decodedpos + 1);
1968 hashindex = CRC_Block((const unsigned char *) thisstr.key, strlen(thisstr.key)) % PO_HASHSIZE;
1969 thisstr.nextonhashchain = po->hashtable[hashindex];
1970 po->hashtable[hashindex] = Mem_Alloc(pool, sizeof(thisstr));
1971 memcpy(po->hashtable[hashindex], &thisstr, sizeof(thisstr));
1972 memset(&thisstr, 0, sizeof(thisstr));
1976 Mem_Free((char *) buf);
1979 const char *PRVM_PO_Lookup(po_t *po, const char *str)
1981 int hashindex = CRC_Block((const unsigned char *) str, strlen(str)) % PO_HASHSIZE;
1982 po_string_t *p = po->hashtable[hashindex];
1985 if(!strcmp(str, p->key))
1987 p = p->nextonhashchain;
1991 void PRVM_PO_Destroy(po_t *po)
1994 for(i = 0; i < PO_HASHSIZE; ++i)
1996 po_string_t *p = po->hashtable[i];
2000 p = p->nextonhashchain;
2009 void PRVM_LeakTest(void);
2010 void PRVM_ResetProg(void)
2013 PRVM_GCALL(reset_cmd)();
2014 Mem_FreePool(&prog->progs_mempool);
2016 PRVM_PO_Destroy((po_t *) prog->po);
2017 memset(prog,0,sizeof(prvm_prog_t));
2018 prog->starttime = Sys_DoubleTime();
2026 void PRVM_LoadLNO( const char *progname ) {
2027 fs_offset_t filesize;
2029 unsigned int *header;
2032 FS_StripExtension( progname, filename, sizeof( filename ) );
2033 strlcat( filename, ".lno", sizeof( filename ) );
2035 lno = FS_LoadFile( filename, tempmempool, false, &filesize );
2041 <Spike> SafeWrite (h, &lnotype, sizeof(int));
2042 <Spike> SafeWrite (h, &version, sizeof(int));
2043 <Spike> SafeWrite (h, &numglobaldefs, sizeof(int));
2044 <Spike> SafeWrite (h, &numpr_globals, sizeof(int));
2045 <Spike> SafeWrite (h, &numfielddefs, sizeof(int));
2046 <Spike> SafeWrite (h, &numstatements, sizeof(int));
2047 <Spike> SafeWrite (h, statement_linenums, numstatements*sizeof(int));
2049 if( (unsigned) filesize < (6 + prog->progs->numstatements) * sizeof( int ) ) {
2054 header = (unsigned int *) lno;
2055 if( header[ 0 ] == *(unsigned int *) "LNOF" &&
2056 LittleLong( header[ 1 ] ) == 1 &&
2057 (unsigned int)LittleLong( header[ 2 ] ) == (unsigned int)prog->progs->numglobaldefs &&
2058 (unsigned int)LittleLong( header[ 3 ] ) == (unsigned int)prog->progs->numglobals &&
2059 (unsigned int)LittleLong( header[ 4 ] ) == (unsigned int)prog->progs->numfielddefs &&
2060 (unsigned int)LittleLong( header[ 5 ] ) == (unsigned int)prog->progs->numstatements )
2062 prog->statement_linenums = (int *)Mem_Alloc(prog->progs_mempool, prog->progs->numstatements * sizeof( int ) );
2063 memcpy( prog->statement_linenums, (int *) lno + 6, prog->progs->numstatements * sizeof( int ) );
2073 void PRVM_LoadProgs (const char * filename, int numrequiredfunc, char **required_func, int numrequiredfields, prvm_required_field_t *required_field, int numrequiredglobals, char **required_global)
2077 ddef_t *infielddefs;
2078 dfunction_t *dfunctions;
2079 fs_offset_t filesize;
2081 if( prog->loaded ) {
2082 PRVM_ERROR ("PRVM_LoadProgs: there is already a %s program loaded!", PRVM_NAME );
2085 prog->progs = (dprograms_t *)FS_LoadFile (filename, prog->progs_mempool, false, &filesize);
2086 if (prog->progs == NULL || filesize < (fs_offset_t)sizeof(dprograms_t))
2087 PRVM_ERROR ("PRVM_LoadProgs: couldn't load %s for %s", filename, PRVM_NAME);
2088 // TODO bounds check header fields (e.g. numstatements), they must never go behind end of file
2090 Con_DPrintf("%s programs occupy %iK.\n", PRVM_NAME, (int)(filesize/1024));
2092 prog->filecrc = CRC_Block((unsigned char *)prog->progs, filesize);
2094 // byte swap the header
2095 for (i = 0;i < (int) sizeof(*prog->progs) / 4;i++)
2096 ((int *)prog->progs)[i] = LittleLong ( ((int *)prog->progs)[i] );
2098 if (prog->progs->version != PROG_VERSION)
2099 PRVM_ERROR ("%s: %s has wrong version number (%i should be %i)", PRVM_NAME, filename, prog->progs->version, PROG_VERSION);
2100 if (prog->progs->crc != prog->headercrc && prog->progs->crc != prog->headercrc2)
2101 PRVM_ERROR ("%s: %s system vars have been modified (CRC of progs.dat systemvars %i != engine %i), progdefs.h is out of date", PRVM_NAME, filename, prog->progs->crc, prog->headercrc);
2103 //prog->functions = (dfunction_t *)((unsigned char *)progs + progs->ofs_functions);
2104 dfunctions = (dfunction_t *)((unsigned char *)prog->progs + prog->progs->ofs_functions);
2106 if (prog->progs->ofs_strings + prog->progs->numstrings >= (int)filesize)
2107 PRVM_ERROR ("%s: %s strings go past end of file", PRVM_NAME, filename);
2108 prog->strings = (char *)prog->progs + prog->progs->ofs_strings;
2109 prog->stringssize = prog->progs->numstrings;
2111 prog->numknownstrings = 0;
2112 prog->maxknownstrings = 0;
2113 prog->knownstrings = NULL;
2114 prog->knownstrings_freeable = NULL;
2116 Mem_ExpandableArray_NewArray(&prog->stringbuffersarray, prog->progs_mempool, sizeof(prvm_stringbuffer_t), 64);
2118 prog->globaldefs = (ddef_t *)((unsigned char *)prog->progs + prog->progs->ofs_globaldefs);
2120 // we need to expand the fielddefs list to include all the engine fields,
2121 // so allocate a new place for it
2122 infielddefs = (ddef_t *)((unsigned char *)prog->progs + prog->progs->ofs_fielddefs);
2124 prog->fielddefs = (ddef_t *)Mem_Alloc(prog->progs_mempool, (prog->progs->numfielddefs + numrequiredfields) * sizeof(ddef_t));
2126 prog->statements = (dstatement_t *)((unsigned char *)prog->progs + prog->progs->ofs_statements);
2128 prog->statement_profile = (double *)Mem_Alloc(prog->progs_mempool, prog->progs->numstatements * sizeof(*prog->statement_profile));
2130 //pr_global_struct = (globalvars_t *)((unsigned char *)progs + progs->ofs_globals);
2131 prog->globals.generic = (float *)((unsigned char *)prog->progs + prog->progs->ofs_globals);
2133 // byte swap the lumps
2134 for (i=0 ; i<prog->progs->numstatements ; i++)
2136 prog->statements[i].op = LittleShort(prog->statements[i].op);
2137 prog->statements[i].a = LittleShort(prog->statements[i].a);
2138 prog->statements[i].b = LittleShort(prog->statements[i].b);
2139 prog->statements[i].c = LittleShort(prog->statements[i].c);
2142 prog->functions = (mfunction_t *)Mem_Alloc(prog->progs_mempool, sizeof(mfunction_t) * prog->progs->numfunctions);
2143 for (i = 0;i < prog->progs->numfunctions;i++)
2145 prog->functions[i].first_statement = LittleLong (dfunctions[i].first_statement);
2146 prog->functions[i].parm_start = LittleLong (dfunctions[i].parm_start);
2147 prog->functions[i].s_name = LittleLong (dfunctions[i].s_name);
2148 prog->functions[i].s_file = LittleLong (dfunctions[i].s_file);
2149 prog->functions[i].numparms = LittleLong (dfunctions[i].numparms);
2150 prog->functions[i].locals = LittleLong (dfunctions[i].locals);
2151 memcpy(prog->functions[i].parm_size, dfunctions[i].parm_size, sizeof(dfunctions[i].parm_size));
2152 if(prog->functions[i].first_statement >= prog->progs->numstatements)
2153 PRVM_ERROR("PRVM_LoadProgs: out of bounds function statement (function %d) in %s", i, PRVM_NAME);
2154 // TODO bounds check parm_start, s_name, s_file, numparms, locals, parm_size
2157 for (i=0 ; i<prog->progs->numglobaldefs ; i++)
2159 prog->globaldefs[i].type = LittleShort (prog->globaldefs[i].type);
2160 prog->globaldefs[i].ofs = LittleShort (prog->globaldefs[i].ofs);
2161 prog->globaldefs[i].s_name = LittleLong (prog->globaldefs[i].s_name);
2162 // TODO bounds check ofs, s_name
2165 // copy the progs fields to the new fields list
2166 for (i = 0;i < prog->progs->numfielddefs;i++)
2168 prog->fielddefs[i].type = LittleShort (infielddefs[i].type);
2169 if (prog->fielddefs[i].type & DEF_SAVEGLOBAL)
2170 PRVM_ERROR ("PRVM_LoadProgs: prog->fielddefs[i].type & DEF_SAVEGLOBAL in %s", PRVM_NAME);
2171 prog->fielddefs[i].ofs = LittleShort (infielddefs[i].ofs);
2172 prog->fielddefs[i].s_name = LittleLong (infielddefs[i].s_name);
2173 // TODO bounds check ofs, s_name
2176 // append the required fields
2177 for (i = 0;i < (int) numrequiredfields;i++)
2179 prog->fielddefs[prog->progs->numfielddefs].type = required_field[i].type;
2180 prog->fielddefs[prog->progs->numfielddefs].ofs = prog->progs->entityfields;
2181 prog->fielddefs[prog->progs->numfielddefs].s_name = PRVM_SetEngineString(required_field[i].name);
2182 // TODO bounds check ofs, s_name
2183 if (prog->fielddefs[prog->progs->numfielddefs].type == ev_vector)
2184 prog->progs->entityfields += 3;
2186 prog->progs->entityfields++;
2187 prog->progs->numfielddefs++;
2189 prog->entityfields = prog->progs->entityfields;
2191 // check required functions
2192 for(i=0 ; i < numrequiredfunc ; i++)
2193 if(PRVM_ED_FindFunction(required_func[i]) == 0)
2194 PRVM_ERROR("%s: %s not found in %s",PRVM_NAME, required_func[i], filename);
2196 // check required globals
2197 for(i=0 ; i < numrequiredglobals ; i++)
2198 if(PRVM_ED_FindGlobal(required_global[i]) == 0)
2199 PRVM_ERROR("%s: %s not found in %s",PRVM_NAME, required_global[i], filename);
2201 for (i=0 ; i<prog->progs->numglobals ; i++)
2202 ((int *)prog->globals.generic)[i] = LittleLong (((int *)prog->globals.generic)[i]);
2204 // LordHavoc: bounds check anything static
2205 for (i = 0,st = prog->statements;i < prog->progs->numstatements;i++,st++)
2211 if ((unsigned short) st->a >= prog->progs->numglobals || st->b + i < 0 || st->b + i >= prog->progs->numstatements)
2212 PRVM_ERROR("PRVM_LoadProgs: out of bounds IF/IFNOT (statement %d) in %s", i, PRVM_NAME);
2215 if (st->a + i < 0 || st->a + i >= prog->progs->numstatements)
2216 PRVM_ERROR("PRVM_LoadProgs: out of bounds GOTO (statement %d) in %s", i, PRVM_NAME);
2218 // global global global
2253 if ((unsigned short) st->a >= prog->progs->numglobals || (unsigned short) st->b >= prog->progs->numglobals || (unsigned short) st->c >= prog->progs->numglobals)
2254 PRVM_ERROR("PRVM_LoadProgs: out of bounds global index (statement %d)", i);
2256 // global none global
2262 if ((unsigned short) st->a >= prog->progs->numglobals || (unsigned short) st->c >= prog->progs->numglobals)
2263 PRVM_ERROR("PRVM_LoadProgs: out of bounds global index (statement %d) in %s", i, PRVM_NAME);
2279 if ((unsigned short) st->a >= prog->progs->numglobals || (unsigned short) st->b >= prog->progs->numglobals)
2280 PRVM_ERROR("PRVM_LoadProgs: out of bounds global index (statement %d) in %s", i, PRVM_NAME);
2294 if ((unsigned short) st->a >= prog->progs->numglobals)
2295 PRVM_ERROR("PRVM_LoadProgs: out of bounds global index (statement %d) in %s", i, PRVM_NAME);
2298 Con_DPrintf("PRVM_LoadProgs: unknown opcode %d at statement %d in %s\n", st->op, i, PRVM_NAME);
2302 if(prog->progs->numstatements < 1)
2304 PRVM_ERROR("PRVM_LoadProgs: empty program in %s", PRVM_NAME);
2306 else switch(prog->statements[prog->progs->numstatements - 1].op)
2313 PRVM_ERROR("PRVM_LoadProgs: program may fall off the edge (does not end with RETURN, GOTO or DONE) in %s", PRVM_NAME);
2317 PRVM_LoadLNO(filename);
2321 if(*prvm_language.string)
2322 // in CSQC we really shouldn't be able to change how stuff works... sorry for now
2323 // later idea: include a list of authorized .po file checksums with the csprogs
2325 qboolean deftrans = !!strcmp(PRVM_NAME, "client");
2326 if(deftrans) // once we have dotranslate_ strings, ALWAYS use the opt-in method!
2328 for (i=0 ; i<prog->progs->numglobaldefs ; i++)
2331 name = PRVM_GetString(prog->globaldefs[i].s_name);
2332 if((prog->globaldefs[i].type & ~DEF_SAVEGLOBAL) == ev_string)
2333 if(name && !strncmp(name, "dotranslate_", 12))
2340 if(!strcmp(prvm_language.string, "dump"))
2342 qfile_t *f = FS_OpenRealFile(va("%s.%s.po", filename, prvm_language.string), "w", false);
2343 Con_Printf("Dumping to %s.%s.po\n", filename, prvm_language.string);
2346 for (i=0 ; i<prog->progs->numglobaldefs ; i++)
2349 name = PRVM_GetString(prog->globaldefs[i].s_name);
2350 if((prog->globaldefs[i].type & ~DEF_SAVEGLOBAL) == ev_string)
2351 if(deftrans ? (!name || strncmp(name, "notranslate_", 12)) : (name && !strncmp(name, "dotranslate_", 12)))
2353 prvm_eval_t *val = (prvm_eval_t *)(prog->globals.generic + prog->globaldefs[i].ofs);
2354 const char *value = PRVM_GetString(val->string);
2357 char buf[MAX_INPUTLINE];
2358 PRVM_PO_UnparseString(buf, value, sizeof(buf));
2359 FS_Printf(f, "msgid \"%s\"\nmsgstr \"\"\n\n", buf);
2368 po_t *po = PRVM_PO_Load(va("%s.%s.po", filename, prvm_language.string), prog->progs_mempool);
2371 for (i=0 ; i<prog->progs->numglobaldefs ; i++)
2374 name = PRVM_GetString(prog->globaldefs[i].s_name);
2375 if(deftrans ? (!name || strncmp(name, "notranslate_", 12)) : (name && !strncmp(name, "dotranslate_", 12)))
2376 if((prog->globaldefs[i].type & ~DEF_SAVEGLOBAL) == ev_string)
2378 prvm_eval_t *val = (prvm_eval_t *)(prog->globals.generic + prog->globaldefs[i].ofs);
2379 const char *value = PRVM_GetString(val->string);
2382 value = PRVM_PO_Lookup(po, value);
2384 val->string = PRVM_SetEngineString(value);
2392 for (i=0 ; i<prog->progs->numglobaldefs ; i++)
2395 name = PRVM_GetString(prog->globaldefs[i].s_name);
2396 //Con_Printf("found var %s\n", name);
2398 && !strncmp(name, "autocvar_", 9)
2399 && !(strlen(name) > 1 && name[strlen(name)-2] == '_' && (name[strlen(name)-1] == 'x' || name[strlen(name)-1] == 'y' || name[strlen(name)-1] == 'z'))
2402 prvm_eval_t *val = (prvm_eval_t *)(prog->globals.generic + prog->globaldefs[i].ofs);
2403 cvar_t *cvar = Cvar_FindVar(name + 9);
2404 //Con_Printf("PRVM_LoadProgs: autocvar global %s in %s, processing...\n", name, PRVM_NAME);
2409 Con_Printf("PRVM_LoadProgs: no cvar for autocvar global %s in %s, creating...\n", name, PRVM_NAME);
2410 switch(prog->globaldefs[i].type & ~DEF_SAVEGLOBAL)
2413 if((float)((int)(val->_float)) == val->_float)
2414 dpsnprintf(buf, sizeof(buf), "%i", (int)(val->_float));
2416 dpsnprintf(buf, sizeof(buf), "%.9g", val->_float);
2420 dpsnprintf(buf, sizeof(buf), "%.9g %.9g %.9g", val->vector[0], val->vector[1], val->vector[2]); value = buf;
2423 value = PRVM_GetString(val->string);
2426 Con_Printf("PRVM_LoadProgs: invalid type of autocvar global %s in %s\n", name, PRVM_NAME);
2429 cvar = Cvar_Get(name + 9, value, 0, NULL);
2430 if((prog->globaldefs[i].type & ~DEF_SAVEGLOBAL) == ev_string)
2432 val->string = PRVM_SetEngineString(cvar->string);
2433 cvar->globaldefindex_stringno[prog - prog_list] = val->string;
2436 PRVM_ERROR("PRVM_LoadProgs: could not create cvar for autocvar global %s in %s", name, PRVM_NAME);
2437 cvar->globaldefindex_progid[prog - prog_list] = prog->id;
2438 cvar->globaldefindex[prog - prog_list] = i;
2440 else if((cvar->flags & CVAR_PRIVATE) == 0)
2442 // MUST BE SYNCED WITH cvar.c Cvar_Set
2445 switch(prog->globaldefs[i].type & ~DEF_SAVEGLOBAL)
2448 val->_float = cvar->value;
2452 VectorClear(val->vector);
2453 for (j = 0;j < 3;j++)
2455 while (*s && ISWHITESPACE(*s))
2459 val->vector[j] = atof(s);
2460 while (!ISWHITESPACE(*s))
2467 val->string = PRVM_SetEngineString(cvar->string);
2468 cvar->globaldefindex_stringno[prog - prog_list] = val->string;
2471 Con_Printf("PRVM_LoadProgs: invalid type of autocvar global %s in %s\n", name, PRVM_NAME);
2474 cvar->globaldefindex_progid[prog - prog_list] = prog->id;
2475 cvar->globaldefindex[prog - prog_list] = i;
2478 Con_Printf("PRVM_LoadProgs: private cvar for autocvar global %s in %s\n", name, PRVM_NAME);
2484 prog->loaded = TRUE;
2486 // set flags & ddef_ts in prog
2492 PRVM_GCALL(init_cmd)();
2499 void PRVM_Fields_f (void)
2501 int i, j, ednum, used, usedamount;
2503 char tempstring[MAX_INPUTLINE], tempstring2[260];
2513 Con_Print("no progs loaded\n");
2520 Con_Print("prvm_fields <program name>\n");
2525 if(!PRVM_SetProgFromString(Cmd_Argv(1)))
2528 counts = (int *)Mem_Alloc(tempmempool, prog->progs->numfielddefs * sizeof(int));
2529 for (ednum = 0;ednum < prog->max_edicts;ednum++)
2531 ed = PRVM_EDICT_NUM(ednum);
2532 if (ed->priv.required->free)
2534 for (i = 1;i < prog->progs->numfielddefs;i++)
2536 d = &prog->fielddefs[i];
2537 name = PRVM_GetString(d->s_name);
2538 if (name[strlen(name)-2] == '_')
2539 continue; // skip _x, _y, _z vars
2540 v = (int *)(ed->fields.vp + d->ofs);
2541 // if the value is still all 0, skip the field
2542 for (j = 0;j < prvm_type_size[d->type & ~DEF_SAVEGLOBAL];j++)
2555 for (i = 0;i < prog->progs->numfielddefs;i++)
2557 d = &prog->fielddefs[i];
2558 name = PRVM_GetString(d->s_name);
2559 if (name[strlen(name)-2] == '_')
2560 continue; // skip _x, _y, _z vars
2561 switch(d->type & ~DEF_SAVEGLOBAL)
2564 strlcat(tempstring, "string ", sizeof(tempstring));
2567 strlcat(tempstring, "entity ", sizeof(tempstring));
2570 strlcat(tempstring, "function ", sizeof(tempstring));
2573 strlcat(tempstring, "field ", sizeof(tempstring));
2576 strlcat(tempstring, "void ", sizeof(tempstring));
2579 strlcat(tempstring, "float ", sizeof(tempstring));
2582 strlcat(tempstring, "vector ", sizeof(tempstring));
2585 strlcat(tempstring, "pointer ", sizeof(tempstring));
2588 dpsnprintf (tempstring2, sizeof(tempstring2), "bad type %i ", d->type & ~DEF_SAVEGLOBAL);
2589 strlcat(tempstring, tempstring2, sizeof(tempstring));
2592 if (strlen(name) > sizeof(tempstring2)-4)
2594 memcpy (tempstring2, name, sizeof(tempstring2)-4);
2595 tempstring2[sizeof(tempstring2)-4] = tempstring2[sizeof(tempstring2)-3] = tempstring2[sizeof(tempstring2)-2] = '.';
2596 tempstring2[sizeof(tempstring2)-1] = 0;
2599 strlcat(tempstring, name, sizeof(tempstring));
2600 for (j = (int)strlen(name);j < 25;j++)
2601 strlcat(tempstring, " ", sizeof(tempstring));
2602 dpsnprintf(tempstring2, sizeof(tempstring2), "%5d", counts[i]);
2603 strlcat(tempstring, tempstring2, sizeof(tempstring));
2604 strlcat(tempstring, "\n", sizeof(tempstring));
2605 if (strlen(tempstring) >= sizeof(tempstring)/2)
2607 Con_Print(tempstring);
2613 usedamount += prvm_type_size[d->type & ~DEF_SAVEGLOBAL];
2617 Con_Printf("%s: %i entity fields (%i in use), totalling %i bytes per edict (%i in use), %i edicts allocated, %i bytes total spent on edict fields (%i needed)\n", PRVM_NAME, prog->progs->entityfields, used, prog->progs->entityfields * 4, usedamount * 4, prog->max_edicts, prog->progs->entityfields * 4 * prog->max_edicts, usedamount * 4 * prog->max_edicts);
2622 void PRVM_Globals_f (void)
2625 const char *wildcard;
2631 Con_Print("no progs loaded\n");
2634 if(Cmd_Argc () < 2 || Cmd_Argc() > 3)
2636 Con_Print("prvm_globals <program name> <optional name wildcard>\n");
2641 if(!PRVM_SetProgFromString (Cmd_Argv (1)))
2644 if( Cmd_Argc() == 3)
2645 wildcard = Cmd_Argv(2);
2649 Con_Printf("%s :", PRVM_NAME);
2651 for (i = 0;i < prog->progs->numglobaldefs;i++)
2654 if( !matchpattern( PRVM_GetString(prog->globaldefs[i].s_name), wildcard, 1) )
2659 Con_Printf("%s\n", PRVM_GetString(prog->globaldefs[i].s_name));
2661 Con_Printf("%i global variables, %i culled, totalling %i bytes\n", prog->progs->numglobals, numculled, prog->progs->numglobals * 4);
2671 void PRVM_Global_f(void)
2674 if( Cmd_Argc() != 3 ) {
2675 Con_Printf( "prvm_global <program name> <global name>\n" );
2680 if( !PRVM_SetProgFromString( Cmd_Argv(1) ) )
2683 global = PRVM_ED_FindGlobal( Cmd_Argv(2) );
2685 Con_Printf( "No global '%s' in %s!\n", Cmd_Argv(2), Cmd_Argv(1) );
2687 Con_Printf( "%s: %s\n", Cmd_Argv(2), PRVM_ValueString( (etype_t)global->type, (prvm_eval_t *) &prog->globals.generic[ global->ofs ] ) );
2696 void PRVM_GlobalSet_f(void)
2699 if( Cmd_Argc() != 4 ) {
2700 Con_Printf( "prvm_globalset <program name> <global name> <value>\n" );
2705 if( !PRVM_SetProgFromString( Cmd_Argv(1) ) )
2708 global = PRVM_ED_FindGlobal( Cmd_Argv(2) );
2710 Con_Printf( "No global '%s' in %s!\n", Cmd_Argv(2), Cmd_Argv(1) );
2712 PRVM_ED_ParseEpair( NULL, global, Cmd_Argv(3), true );
2721 void PRVM_Init (void)
2723 Cmd_AddCommand ("prvm_edict", PRVM_ED_PrintEdict_f, "print all data about an entity number in the selected VM (server, client, menu)");
2724 Cmd_AddCommand ("prvm_edicts", PRVM_ED_PrintEdicts_f, "prints all data about all entities in the selected VM (server, client, menu)");
2725 Cmd_AddCommand ("prvm_edictcount", PRVM_ED_Count_f, "prints number of active entities in the selected VM (server, client, menu)");
2726 Cmd_AddCommand ("prvm_profile", PRVM_Profile_f, "prints execution statistics about the most used QuakeC functions in the selected VM (server, client, menu)");
2727 Cmd_AddCommand ("prvm_childprofile", PRVM_ChildProfile_f, "prints execution statistics about the most used QuakeC functions in the selected VM (server, client, menu), sorted by time taken in function with child calls");
2728 Cmd_AddCommand ("prvm_callprofile", PRVM_CallProfile_f, "prints execution statistics about the most time consuming QuakeC calls from the engine in the selected VM (server, client, menu)");
2729 Cmd_AddCommand ("prvm_fields", PRVM_Fields_f, "prints usage statistics on properties (how many entities have non-zero values) in the selected VM (server, client, menu)");
2730 Cmd_AddCommand ("prvm_globals", PRVM_Globals_f, "prints all global variables in the selected VM (server, client, menu)");
2731 Cmd_AddCommand ("prvm_global", PRVM_Global_f, "prints value of a specified global variable in the selected VM (server, client, menu)");
2732 Cmd_AddCommand ("prvm_globalset", PRVM_GlobalSet_f, "sets value of a specified global variable in the selected VM (server, client, menu)");
2733 Cmd_AddCommand ("prvm_edictset", PRVM_ED_EdictSet_f, "changes value of a specified property of a specified entity in the selected VM (server, client, menu)");
2734 Cmd_AddCommand ("prvm_edictget", PRVM_ED_EdictGet_f, "retrieves the value of a specified property of a specified entity in the selected VM (server, client menu) into a cvar or to the console");
2735 Cmd_AddCommand ("prvm_globalget", PRVM_ED_GlobalGet_f, "retrieves the value of a specified global variable in the selected VM (server, client menu) into a cvar or to the console");
2736 Cmd_AddCommand ("prvm_printfunction", PRVM_PrintFunction_f, "prints a disassembly (QuakeC instructions) of the specified function in the selected VM (server, client, menu)");
2737 Cmd_AddCommand ("cl_cmd", PRVM_GameCommand_Client_f, "calls the client QC function GameCommand with the supplied string as argument");
2738 Cmd_AddCommand ("menu_cmd", PRVM_GameCommand_Menu_f, "calls the menu QC function GameCommand with the supplied string as argument");
2739 Cmd_AddCommand ("sv_cmd", PRVM_GameCommand_Server_f, "calls the server QC function GameCommand with the supplied string as argument");
2741 Cvar_RegisterVariable (&prvm_language);
2742 Cvar_RegisterVariable (&prvm_traceqc);
2743 Cvar_RegisterVariable (&prvm_statementprofiling);
2744 Cvar_RegisterVariable (&prvm_timeprofiling);
2745 Cvar_RegisterVariable (&prvm_backtraceforwarnings);
2746 Cvar_RegisterVariable (&prvm_leaktest);
2747 Cvar_RegisterVariable (&prvm_leaktest_ignore_classnames);
2748 Cvar_RegisterVariable (&prvm_errordump);
2749 Cvar_RegisterVariable (&prvm_reuseedicts_startuptime);
2750 Cvar_RegisterVariable (&prvm_reuseedicts_neverinsameframe);
2752 // COMMANDLINEOPTION: PRVM: -norunaway disables the runaway loop check (it might be impossible to exit DarkPlaces if used!)
2753 prvm_runawaycheck = !COM_CheckParm("-norunaway");
2763 void PRVM_InitProg(int prognr)
2765 static unsigned int progid = 0;
2767 if(prognr < 0 || prognr >= PRVM_MAXPROGS)
2768 Sys_Error("PRVM_InitProg: Invalid program number %i",prognr);
2770 prog = &prog_list[prognr];
2775 memset(prog, 0, sizeof(prvm_prog_t));
2776 prog->starttime = Sys_DoubleTime();
2777 prog->id = ++progid;
2779 prog->error_cmd = Host_Error;
2780 prog->leaktest_active = prvm_leaktest.integer != 0;
2783 int PRVM_GetProgNr(void)
2785 return prog - prog_list;
2788 void *_PRVM_Alloc(size_t buffersize, const char *filename, int fileline)
2790 return _Mem_Alloc(prog->progs_mempool, NULL, buffersize, 16, filename, fileline);
2793 void _PRVM_Free(void *buffer, const char *filename, int fileline)
2795 _Mem_Free(buffer, filename, fileline);
2798 void _PRVM_FreeAll(const char *filename, int fileline)
2801 prog->fielddefs = NULL;
2802 prog->functions = NULL;
2803 _Mem_EmptyPool(prog->progs_mempool, filename, fileline);
2806 // LordHavoc: turned PRVM_EDICT_NUM into a #define for speed reasons
2807 unsigned int PRVM_EDICT_NUM_ERROR(unsigned int n, char *filename, int fileline)
2809 PRVM_ERROR ("PRVM_EDICT_NUM: %s: bad number %i (called at %s:%i)", PRVM_NAME, n, filename, fileline);
2813 sizebuf_t vm_tempstringsbuf;
2814 #define PRVM_KNOWNSTRINGBASE 0x40000000
2816 const char *PRVM_GetString(int num)
2821 VM_Warning("PRVM_GetString: Invalid string offset (%i < 0)\n", num);
2824 else if (num < prog->stringssize)
2826 // constant string from progs.dat
2827 return prog->strings + num;
2829 else if (num <= prog->stringssize + vm_tempstringsbuf.maxsize)
2831 // tempstring returned by engine to QC (becomes invalid after returning to engine)
2832 num -= prog->stringssize;
2833 if (num < vm_tempstringsbuf.cursize)
2834 return (char *)vm_tempstringsbuf.data + num;
2837 VM_Warning("PRVM_GetString: Invalid temp-string offset (%i >= %i vm_tempstringsbuf.cursize)\n", num, vm_tempstringsbuf.cursize);
2841 else if (num & PRVM_KNOWNSTRINGBASE)
2844 num = num - PRVM_KNOWNSTRINGBASE;
2845 if (num >= 0 && num < prog->numknownstrings)
2847 if (!prog->knownstrings[num])
2849 VM_Warning("PRVM_GetString: Invalid zone-string offset (%i has been freed)\n", num);
2852 return prog->knownstrings[num];
2856 VM_Warning("PRVM_GetString: Invalid zone-string offset (%i >= %i)\n", num, prog->numknownstrings);
2862 // invalid string offset
2863 VM_Warning("PRVM_GetString: Invalid constant-string offset (%i >= %i prog->stringssize)\n", num, prog->stringssize);
2868 const char *PRVM_ChangeEngineString(int i, const char *s)
2871 i = i - PRVM_KNOWNSTRINGBASE;
2872 if(i < 0 || i >= prog->numknownstrings)
2873 PRVM_ERROR("PRVM_ChangeEngineString: s is not an engine string");
2874 old = prog->knownstrings[i];
2875 prog->knownstrings[i] = s;
2879 int PRVM_SetEngineString(const char *s)
2884 if (s >= prog->strings && s <= prog->strings + prog->stringssize)
2885 PRVM_ERROR("PRVM_SetEngineString: s in prog->strings area");
2886 // if it's in the tempstrings area, use a reserved range
2887 // (otherwise we'd get millions of useless string offsets cluttering the database)
2888 if (s >= (char *)vm_tempstringsbuf.data && s < (char *)vm_tempstringsbuf.data + vm_tempstringsbuf.maxsize)
2890 return prog->stringssize + (s - (char *)vm_tempstringsbuf.data);
2892 // see if it's a known string address
2893 for (i = 0;i < prog->numknownstrings;i++)
2894 if (prog->knownstrings[i] == s)
2895 return PRVM_KNOWNSTRINGBASE + i;
2896 // new unknown engine string
2897 if (developer_insane.integer)
2898 Con_DPrintf("new engine string %p = \"%s\"\n", s, s);
2899 for (i = prog->firstfreeknownstring;i < prog->numknownstrings;i++)
2900 if (!prog->knownstrings[i])
2902 if (i >= prog->numknownstrings)
2904 if (i >= prog->maxknownstrings)
2906 const char **oldstrings = prog->knownstrings;
2907 const unsigned char *oldstrings_freeable = prog->knownstrings_freeable;
2908 const char **oldstrings_origin = prog->knownstrings_origin;
2909 prog->maxknownstrings += 128;
2910 prog->knownstrings = (const char **)PRVM_Alloc(prog->maxknownstrings * sizeof(char *));
2911 prog->knownstrings_freeable = (unsigned char *)PRVM_Alloc(prog->maxknownstrings * sizeof(unsigned char));
2912 if(prog->leaktest_active)
2913 prog->knownstrings_origin = (const char **)PRVM_Alloc(prog->maxknownstrings * sizeof(char *));
2914 if (prog->numknownstrings)
2916 memcpy((char **)prog->knownstrings, oldstrings, prog->numknownstrings * sizeof(char *));
2917 memcpy((char **)prog->knownstrings_freeable, oldstrings_freeable, prog->numknownstrings * sizeof(unsigned char));
2918 if(prog->leaktest_active)
2919 memcpy((char **)prog->knownstrings_origin, oldstrings_origin, prog->numknownstrings * sizeof(char *));
2922 prog->numknownstrings++;
2924 prog->firstfreeknownstring = i + 1;
2925 prog->knownstrings[i] = s;
2926 prog->knownstrings_freeable[i] = false;
2927 if(prog->leaktest_active)
2928 prog->knownstrings_origin[i] = NULL;
2929 return PRVM_KNOWNSTRINGBASE + i;
2932 // temp string handling
2934 // all tempstrings go into this buffer consecutively, and it is reset
2935 // whenever PRVM_ExecuteProgram returns to the engine
2936 // (technically each PRVM_ExecuteProgram call saves the cursize value and
2937 // restores it on return, so multiple recursive calls can share the same
2939 // the buffer size is automatically grown as needed
2941 int PRVM_SetTempString(const char *s)
2947 size = (int)strlen(s) + 1;
2948 if (developer_insane.integer)
2949 Con_DPrintf("PRVM_SetTempString: cursize %i, size %i\n", vm_tempstringsbuf.cursize, size);
2950 if (vm_tempstringsbuf.maxsize < vm_tempstringsbuf.cursize + size)
2952 sizebuf_t old = vm_tempstringsbuf;
2953 if (vm_tempstringsbuf.cursize + size >= 1<<28)
2954 PRVM_ERROR("PRVM_SetTempString: ran out of tempstring memory! (refusing to grow tempstring buffer over 256MB, cursize %i, size %i)\n", vm_tempstringsbuf.cursize, size);
2955 vm_tempstringsbuf.maxsize = max(vm_tempstringsbuf.maxsize, 65536);
2956 while (vm_tempstringsbuf.maxsize < vm_tempstringsbuf.cursize + size)
2957 vm_tempstringsbuf.maxsize *= 2;
2958 if (vm_tempstringsbuf.maxsize != old.maxsize || vm_tempstringsbuf.data == NULL)
2960 Con_DPrintf("PRVM_SetTempString: enlarging tempstrings buffer (%iKB -> %iKB)\n", old.maxsize/1024, vm_tempstringsbuf.maxsize/1024);
2961 vm_tempstringsbuf.data = (unsigned char *) Mem_Alloc(sv_mempool, vm_tempstringsbuf.maxsize);
2963 memcpy(vm_tempstringsbuf.data, old.data, old.cursize);
2968 t = (char *)vm_tempstringsbuf.data + vm_tempstringsbuf.cursize;
2970 vm_tempstringsbuf.cursize += size;
2971 return PRVM_SetEngineString(t);
2974 int PRVM_AllocString(size_t bufferlength, char **pointer)
2979 for (i = prog->firstfreeknownstring;i < prog->numknownstrings;i++)
2980 if (!prog->knownstrings[i])
2982 if (i >= prog->numknownstrings)
2984 if (i >= prog->maxknownstrings)
2986 const char **oldstrings = prog->knownstrings;
2987 const unsigned char *oldstrings_freeable = prog->knownstrings_freeable;
2988 const char **oldstrings_origin = prog->knownstrings_origin;
2989 prog->maxknownstrings += 128;
2990 prog->knownstrings = (const char **)PRVM_Alloc(prog->maxknownstrings * sizeof(char *));
2991 prog->knownstrings_freeable = (unsigned char *)PRVM_Alloc(prog->maxknownstrings * sizeof(unsigned char));
2992 if(prog->leaktest_active)
2993 prog->knownstrings_origin = (const char **)PRVM_Alloc(prog->maxknownstrings * sizeof(char *));
2994 if (prog->numknownstrings)
2996 memcpy((char **)prog->knownstrings, oldstrings, prog->numknownstrings * sizeof(char *));
2997 memcpy((char **)prog->knownstrings_freeable, oldstrings_freeable, prog->numknownstrings * sizeof(unsigned char));
2998 if(prog->leaktest_active)
2999 memcpy((char **)prog->knownstrings_origin, oldstrings_origin, prog->numknownstrings * sizeof(char *));
3002 Mem_Free((char **)oldstrings);
3003 if (oldstrings_freeable)
3004 Mem_Free((unsigned char *)oldstrings_freeable);
3005 if (oldstrings_origin)
3006 Mem_Free((char **)oldstrings_origin);
3008 prog->numknownstrings++;
3010 prog->firstfreeknownstring = i + 1;
3011 prog->knownstrings[i] = (char *)PRVM_Alloc(bufferlength);
3012 prog->knownstrings_freeable[i] = true;
3013 if(prog->leaktest_active)
3014 prog->knownstrings_origin[i] = PRVM_AllocationOrigin();
3016 *pointer = (char *)(prog->knownstrings[i]);
3017 return PRVM_KNOWNSTRINGBASE + i;
3020 void PRVM_FreeString(int num)
3023 PRVM_ERROR("PRVM_FreeString: attempt to free a NULL string");
3024 else if (num >= 0 && num < prog->stringssize)
3025 PRVM_ERROR("PRVM_FreeString: attempt to free a constant string");
3026 else if (num >= PRVM_KNOWNSTRINGBASE && num < PRVM_KNOWNSTRINGBASE + prog->numknownstrings)
3028 num = num - PRVM_KNOWNSTRINGBASE;
3029 if (!prog->knownstrings[num])
3030 PRVM_ERROR("PRVM_FreeString: attempt to free a non-existent or already freed string");
3031 if (!prog->knownstrings_freeable[num])
3032 PRVM_ERROR("PRVM_FreeString: attempt to free a string owned by the engine");
3033 PRVM_Free((char *)prog->knownstrings[num]);
3034 if(prog->leaktest_active)
3035 if(prog->knownstrings_origin[num])
3036 PRVM_Free((char *)prog->knownstrings_origin[num]);
3037 prog->knownstrings[num] = NULL;
3038 prog->knownstrings_freeable[num] = false;
3039 prog->firstfreeknownstring = min(prog->firstfreeknownstring, num);
3042 PRVM_ERROR("PRVM_FreeString: invalid string offset %i", num);
3045 static qboolean PRVM_IsStringReferenced(string_t string)
3049 for (i = 0;i < prog->progs->numglobaldefs;i++)
3051 ddef_t *d = &prog->globaldefs[i];
3052 if((etype_t)((int) d->type & ~DEF_SAVEGLOBAL) != ev_string)
3054 if(string == ((prvm_eval_t *) &prog->globals.generic[d->ofs])->string)
3058 for(j = 0; j < prog->num_edicts; ++j)
3060 prvm_edict_t *ed = PRVM_EDICT_NUM(j);
3061 if (ed->priv.required->free)
3063 for (i=0; i<prog->progs->numfielddefs; ++i)
3065 ddef_t *d = &prog->fielddefs[i];
3066 if((etype_t)((int) d->type & ~DEF_SAVEGLOBAL) != ev_string)
3068 if(string == ((prvm_eval_t *) &ed->fields.vp[d->ofs])->string)
3076 static qboolean PRVM_IsEdictRelevant(prvm_edict_t *edict)
3078 if(PRVM_NUM_FOR_EDICT(edict) <= prog->reserved_edicts)
3079 return true; // world or clients
3080 switch(prog - prog_list)
3082 case PRVM_SERVERPROG:
3084 entvars_t *ev = edict->fields.server;
3085 if(ev->solid) // can block other stuff, or is a trigger?
3087 if(ev->modelindex) // visible ent?
3089 if(ev->effects) // particle effect?
3091 if(ev->think) // has a think function?
3092 if(ev->nextthink > 0) // that actually will eventually run?
3096 if(*prvm_leaktest_ignore_classnames.string)
3098 if(strstr(va(" %s ", prvm_leaktest_ignore_classnames.string), va(" %s ", PRVM_GetString(ev->classname))))
3103 case PRVM_CLIENTPROG:
3105 // TODO someone add more stuff here
3106 cl_entvars_t *ev = edict->fields.client;
3107 if(ev->entnum) // csqc networked
3109 if(ev->modelindex) // visible ent?
3111 if(ev->effects) // particle effect?
3113 if(ev->think) // has a think function?
3114 if(ev->nextthink > 0) // that actually will eventually run?
3116 if(*prvm_leaktest_ignore_classnames.string)
3118 if(strstr(va(" %s ", prvm_leaktest_ignore_classnames.string), va(" %s ", PRVM_GetString(ev->classname))))
3124 // menu prog does not have classnames
3130 static qboolean PRVM_IsEdictReferenced(prvm_edict_t *edict, int mark)
3133 int edictnum = PRVM_NUM_FOR_EDICT(edict);
3134 const char *targetname = NULL;
3136 switch(prog - prog_list)
3138 case PRVM_SERVERPROG:
3139 targetname = PRVM_GetString(edict->fields.server->targetname);
3144 if(!*targetname) // ""
3147 for (i = 0;i < prog->progs->numglobaldefs;i++)
3149 ddef_t *d = &prog->globaldefs[i];
3150 if((etype_t)((int) d->type & ~DEF_SAVEGLOBAL) != ev_entity)
3152 if(edictnum == ((prvm_eval_t *) &prog->globals.generic[d->ofs])->edict)
3156 for(j = 0; j < prog->num_edicts; ++j)
3158 prvm_edict_t *ed = PRVM_EDICT_NUM(j);
3159 if (ed->priv.required->mark < mark)
3165 const char *target = PRVM_GetString(ed->fields.server->target);
3167 if(!strcmp(target, targetname))
3170 for (i=0; i<prog->progs->numfielddefs; ++i)
3172 ddef_t *d = &prog->fielddefs[i];
3173 if((etype_t)((int) d->type & ~DEF_SAVEGLOBAL) != ev_entity)
3175 if(edictnum == ((prvm_eval_t *) &ed->fields.vp[d->ofs])->edict)
3183 static void PRVM_MarkReferencedEdicts(void)
3189 for(j = 0; j < prog->num_edicts; ++j)
3191 prvm_edict_t *ed = PRVM_EDICT_NUM(j);
3192 if(ed->priv.required->free)
3194 ed->priv.required->mark = PRVM_IsEdictRelevant(ed) ? 1 : 0;
3201 for(j = 0; j < prog->num_edicts; ++j)
3203 prvm_edict_t *ed = PRVM_EDICT_NUM(j);
3204 if(ed->priv.required->free)
3206 if(ed->priv.required->mark)
3208 if(PRVM_IsEdictReferenced(ed, stage))
3210 ed->priv.required->mark = stage + 1;
3217 Con_DPrintf("leak check used %d stages to find all references\n", stage);
3220 void PRVM_LeakTest(void)
3223 qboolean leaked = false;
3225 if(!prog->leaktest_active)
3229 for (i = 0; i < prog->numknownstrings; ++i)
3231 if(prog->knownstrings[i])
3232 if(prog->knownstrings_freeable[i])
3233 if(prog->knownstrings_origin[i])
3234 if(!PRVM_IsStringReferenced(-1 - i))
3236 Con_Printf("Unreferenced string found!\n Value: %s\n Origin: %s\n", prog->knownstrings[i], prog->knownstrings_origin[i]);
3242 PRVM_MarkReferencedEdicts();
3243 for(j = 0; j < prog->num_edicts; ++j)
3245 prvm_edict_t *ed = PRVM_EDICT_NUM(j);
3246 if(ed->priv.required->free)
3248 if(!ed->priv.required->mark)
3249 if(ed->priv.required->allocation_origin)
3251 Con_Printf("Unreferenced edict found!\n Allocated at: %s\n", ed->priv.required->allocation_origin);
3252 PRVM_ED_Print(ed, NULL);
3258 for (i = 0; i < (int)Mem_ExpandableArray_IndexRange(&prog->stringbuffersarray); ++i)
3260 prvm_stringbuffer_t *stringbuffer = (prvm_stringbuffer_t*) Mem_ExpandableArray_RecordAtIndex(&prog->stringbuffersarray, i);
3262 if(stringbuffer->origin)
3264 Con_Printf("Open string buffer handle found!\n Allocated at: %s\n", stringbuffer->origin);
3269 for(i = 0; i < PRVM_MAX_OPENFILES; ++i)
3271 if(prog->openfiles[i])
3272 if(prog->openfiles_origin[i])
3274 Con_Printf("Open file handle found!\n Allocated at: %s\n", prog->openfiles_origin[i]);
3279 for(i = 0; i < PRVM_MAX_OPENSEARCHES; ++i)
3281 if(prog->opensearches[i])
3282 if(prog->opensearches_origin[i])
3284 Con_Printf("Open search handle found!\n Allocated at: %s\n", prog->opensearches_origin[i]);
3290 Con_Printf("Congratulations. No leaks found.\n");