radiant/watchbsp.h

   1 /*
   2    Copyright (c) 2001, Loki software, inc.
   3    All rights reserved.
   4
   5    Redistribution and use in source and binary forms, with or without modification,
   6    are permitted provided that the following conditions are met:
   7
   8    Redistributions of source code must retain the above copyright notice, this list
   9    of conditions and the following disclaimer.
  10
  11    Redistributions in binary form must reproduce the above copyright notice, this
  12    list of conditions and the following disclaimer in the documentation and/or
  13    other materials provided with the distribution.
  14
  15    Neither the name of Loki software nor the names of its contributors may be used
  16    to endorse or promote products derived from this software without specific prior
  17    written permission.
  18
  19    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
  20    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  22    DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
  23    DIRECT,INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  24    (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  25    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
  26    ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27    (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  28    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef _BSPWINDOW_H_
  32 #define _BSPWINDOW_H_
  33
  34 #include "l_net/l_net.h"
  35
  36 class CWatchBSP
  37 {
  38 private:
  39 // a flag we have set to true when using an external BSP plugin
  40 // the resulting code with that is a bit dirty, cleaner solution would be to seperate the succession of commands from the listening loop
  41 // (in two seperate classes probably)
  42 bool m_bBSPPlugin;
  43
  44 // EIdle: we are not listening
  45 //   DoMonitoringLoop will change state to EBeginStep
  46 // EBeginStep: the socket is up for listening, we are expecting incoming connection
  47 //   incoming connection will change state to EWatching
  48 // EWatching: we have a connection, monitor it
  49 //   connection closed will see if we start a new step (EBeginStep) or launch Quake3 and end (EIdle)
  50 enum EWatchBSPState { EIdle, EBeginStep, EWatching } m_eState;
  51 socket_t *m_pListenSocket;
  52 socket_t *m_pInSocket;
  53 netmessage_t msg;
  54 GPtrArray *m_pCmd;
  55 // used to timeout EBeginStep
  56 GTimer    *m_pTimer;
  57 unsigned int m_iCurrentStep;
  58 // name of the map so we can run the engine
  59 char    *m_sBSPName;
  60 // buffer we use in push mode to receive data directly from the network
  61 xmlParserInputBufferPtr m_xmlInputBuffer;
  62 xmlParserInputPtr m_xmlInput;
  63 xmlParserCtxtPtr m_xmlParserCtxt;
  64 // call this to switch the set listening mode
  65 bool SetupListening();
  66 // start a new EBeginStep
  67 void DoEBeginStep();
  68 // the xml and sax parser state
  69 char m_xmlBuf[MAX_NETMESSAGE];
  70 bool m_bNeedCtxtInit;
  71 message_info_s m_message_info;
  72
  73 public:
  74 CWatchBSP() { m_bBSPPlugin = false; m_pListenSocket = NULL; m_pInSocket = NULL; m_eState = EIdle; m_pTimer = g_timer_new(); m_sBSPName = NULL; m_xmlInputBuffer = NULL; m_bNeedCtxtInit = true; }
  75 virtual ~CWatchBSP();
  76 bool HasBSPPlugin() const
  77 { return m_bBSPPlugin; }
  78
  79 // called regularly to keep listening
  80 void RoutineProcessing();
  81 // start a monitoring loop with the following steps
  82 void DoMonitoringLoop( GPtrArray *pCmd, char *sBSPName );
  83 // close everything - may be called from the outside to abort the process
  84 void Reset();
  85 // start a listening loop for an external process, possibly a BSP plugin
  86 void ExternalListen();
  87 };
  88
  89 void WINAPI QERApp_Listen();
  90
  91 #endif