2 Copyright (C) 1999-2007 id Software, Inc. and contributors.
3 For a list of contributors, see the accompanying CONTRIBUTORS file.
5 This file is part of GtkRadiant.
7 GtkRadiant is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 GtkRadiant is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GtkRadiant; if not, write to the Free Software
19 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 //-----------------------------------------------------------------------------
26 // deal with in/out tasks, for either stdin/stdout or network/XML stream
33 #include <sys/types.h>
41 // network broadcasting
42 #include "l_net/l_net.h"
43 #include "libxml/tree.h"
47 qboolean lookedForServer = false;
48 UINT wm_BroadcastCommand = -1;
51 socket_t *brdcst_socket;
54 qboolean verbose = false;
57 // is streamed through the network to Radiant
58 // possibly written to disk at the end of the run
59 //++timo FIXME: need to be global, required when creating nodes?
64 xmlNodePtr xml_NodeForVec( vec3_t v )
69 sprintf (buf, "%f %f %f", v[0], v[1], v[2]);
70 ret = xmlNewNode (NULL, "point");
71 xmlNodeSetContent (ret, buf);
75 // send a node down the stream, add it to the document
76 void xml_SendNode (xmlNodePtr node)
79 char xmlbuf[MAX_NETMESSAGE]; // we have to copy content from the xmlBufferPtr into an aux buffer .. that sucks ..
80 // this index loops through the node buffer
84 xmlAddChild( doc->children, node );
88 xml_buf = xmlBufferCreate();
89 xmlNodeDump( xml_buf, doc, node, 0, 0 );
91 // the XML node might be too big to fit in a single network message
92 // l_net library defines an upper limit of MAX_NETMESSAGE
93 // there are some size check errors, so we use MAX_NETMESSAGE-10 to be safe
94 // if the size of the buffer exceeds MAX_NETMESSAGE-10 we'll send in several network messages
95 while (pos < xml_buf->use)
97 // what size are we gonna send now?
98 (xml_buf->use - pos < MAX_NETMESSAGE - 10) ? (size = xml_buf->use - pos) : (size = MAX_NETMESSAGE - 10);
99 //++timo just a debug thing
100 if (size == MAX_NETMESSAGE - 10)
101 Sys_FPrintf (SYS_NOXML, "Got to split the buffer\n");
102 memcpy( xmlbuf, xml_buf->content+pos, size);
105 NMSG_WriteString (&msg, xmlbuf );
106 Net_Send(brdcst_socket, &msg );
107 // now that the thing is sent prepare to loop again
112 // NOTE: the NMSG_WriteString is limited to MAX_NETMESSAGE
113 // we will need to split into chunks
114 // (we could also go lower level, in the end it's using send and receiv which are not size limited)
115 //++timo FIXME: MAX_NETMESSAGE is not exactly the max size we can stick in the message
116 // there's some tweaking to do in l_net for that .. so let's give us a margin for now
118 //++timo we need to handle the case of a buffer too big to fit in a single message
119 // try without checks for now
120 if (xml_buf->use > MAX_NETMESSAGE-10 )
122 // if we send that we are probably gonna break the stream at the other end..
123 // and Error will call right there
124 //Error( "MAX_NETMESSAGE exceeded for XML feedback stream in FPrintf (%d)\n", xml_buf->use);
125 Sys_FPrintf (SYS_NOXML, "MAX_NETMESSAGE exceeded for XML feedback stream in FPrintf (%d)\n", xml_buf->use);
126 xml_buf->content[xml_buf->use]='\0'; //++timo this corrupts the buffer but we don't care it's for printing
127 Sys_FPrintf (SYS_NOXML, xml_buf->content);
132 memcpy( xmlbuf, xml_buf->content, size );
135 NMSG_WriteString (&msg, xmlbuf );
136 Net_Send(brdcst_socket, &msg );
139 xmlBufferFree( xml_buf );
143 void xml_Select (char *msg, int entitynum, int brushnum, qboolean bError)
145 xmlNodePtr node, select;
149 // now build a proper "select" XML node
150 sprintf (buf, "Entity %i, Brush %i: %s", entitynum, brushnum, msg);
151 node = xmlNewNode (NULL, "select");
152 xmlNodeSetContent (node, buf);
153 level[0] = (int)'0' + (bError ? SYS_ERR : SYS_WRN) ;
155 xmlSetProp (node, "level", (char *)&level);
156 // a 'select' information
157 sprintf (buf, "%i %i", entitynum, brushnum);
158 select = xmlNewNode (NULL, "brush");
159 xmlNodeSetContent (select, buf);
160 xmlAddChild (node, select);
163 sprintf (buf, "Entity %i, Brush %i: %s", entitynum, brushnum, msg);
167 Sys_FPrintf (SYS_NOXML, "%s\n", buf);
171 void xml_Point (char *msg, vec3_t pt)
173 xmlNodePtr node, point;
177 node = xmlNewNode (NULL, "pointmsg");
178 xmlNodeSetContent (node, msg);
179 level[0] = (int)'0' + SYS_ERR;
181 xmlSetProp (node, "level", (char *)&level);
183 sprintf (buf, "%g %g %g", pt[0], pt[1], pt[2]);
184 point = xmlNewNode (NULL, "point");
185 xmlNodeSetContent (point, buf);
186 xmlAddChild (node, point);
189 sprintf (buf, "%s (%g %g %g)", msg, pt[0], pt[1], pt[2]);
193 #define WINDING_BUFSIZE 2048
194 void xml_Winding (char *msg, vec3_t p[], int numpoints, qboolean die)
196 xmlNodePtr node, winding;
197 char buf[WINDING_BUFSIZE];
202 node = xmlNewNode (NULL, "windingmsg");
203 xmlNodeSetContent (node, msg);
204 level[0] = (int)'0' + SYS_ERR;
206 xmlSetProp (node, "level", (char *)&level);
208 sprintf( buf, "%i ", numpoints);
209 for(i = 0; i < numpoints; i++)
211 sprintf (smlbuf, "(%g %g %g)", p[i][0], p[i][1], p[i][2]);
213 if (strlen(buf)+strlen(smlbuf)>WINDING_BUFSIZE)
215 strcat( buf, smlbuf);
218 winding = xmlNewNode (NULL, "winding");
219 xmlNodeSetContent (winding, buf);
220 xmlAddChild (node, winding);
233 #include "stream_version.h"
235 void Broadcast_Setup( const char *dest )
241 Net_StringToAddress((char *)dest, &address);
242 brdcst_socket = Net_Connect(&address, 0);
246 sprintf (sMsg, "<?xml version=\"1.0\"?><q3map_feedback version=\"" Q3MAP_STREAM_VERSION "\">");
248 NMSG_WriteString(&msg, sMsg );
249 Net_Send(brdcst_socket, &msg );
253 void Broadcast_Shutdown()
257 Sys_Printf("Disconnecting\n");
258 Net_Disconnect(brdcst_socket);
259 brdcst_socket = NULL;
263 // all output ends up through here
264 void FPrintf (int flag, char *buf)
267 static qboolean bGotXML = false;
272 // the following part is XML stuff only.. but maybe we don't want that message to go down the XML pipe?
273 if (flag == SYS_NOXML)
276 // ouput an XML file of the run
277 // use the DOM interface to build a tree
279 <message level='flag'>
281 .. various nodes to describe corresponding geometry ..
287 doc = xmlNewDoc("1.0");
288 doc->children = xmlNewDocRawNode(doc, NULL, "q3map_feedback", NULL);
291 node = xmlNewNode (NULL, "message");
292 xmlNodeSetContent (node, buf);
293 level[0] = (int)'0' + flag;
295 xmlSetProp (node, "level", (char *)&level );
303 xmlSaveFile( "XMLDump.xml", doc );
307 void Sys_FPrintf (int flag, const char *format, ...)
309 char out_buffer[4096];
312 if ((flag == SYS_VRB) && (verbose == false))
315 va_start (argptr, format);
316 vsprintf (out_buffer, format, argptr);
319 FPrintf (flag, out_buffer);
322 void Sys_Printf (const char *format, ...)
324 char out_buffer[4096];
327 va_start (argptr, format);
328 vsprintf (out_buffer, format, argptr);
331 FPrintf (SYS_STD, out_buffer);
338 For abnormal program terminations
341 void Error( const char *error, ...)
343 char out_buffer[4096];
347 va_start (argptr,error);
348 vsprintf (tmp, error, argptr);
351 sprintf( out_buffer, "************ ERROR ************\n%s\n", tmp );
353 FPrintf( SYS_ERR, out_buffer );
359 //++timo HACK ALERT .. if we shut down too fast the xml stream won't reach the listener.
360 // a clean solution is to send a sync request node in the stream and wait for an answer before exiting
363 Broadcast_Shutdown();