]> de.git.xonotic.org Git - xonotic/darkplaces.git/blobdiff - console.c
*** empty log message ***
[xonotic/darkplaces.git] / console.c
index 9466571faf13b1243a62bc3045d69e78a2575a88..86301d24c6bf8aa932601d8dbf16babf53aac9c1 100644 (file)
--- a/console.c
+++ b/console.c
@@ -19,77 +19,286 @@ Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */
 // console.c
 
-#ifdef NeXT
-#include <libc.h>
+#ifndef WIN32
+# include <unistd.h>
 #endif
-#ifndef _MSC_VER
-#ifndef __BORLANDC__
-#include <unistd.h>
-#endif
-#endif
-#ifdef WIN32
-#include <io.h>
-#endif
-#include <fcntl.h>
+#include <time.h>
 #include "quakedef.h"
 
-int            con_linewidth;
+int con_linewidth;
+
+float con_cursorspeed = 4;
+
+#define                CON_TEXTSIZE    131072
+
+// total lines in console scrollback
+int con_totallines;
+// lines up from bottom to display
+int con_backscroll;
+// where next message will be printed
+int con_current;
+// offset in current line for next print
+int con_x;
+char *con_text = 0;
+
+//seconds
+cvar_t con_notifytime = {CVAR_SAVE, "con_notifytime","3"};
+cvar_t con_notify = {CVAR_SAVE, "con_notify","4"};
+
+#define MAX_NOTIFYLINES 32
+// cl.time time the line was generated for transparent notify lines
+float con_times[MAX_NOTIFYLINES];
+
+int con_vislines;
+
+#define MAXCMDLINE     256
+extern char key_lines[32][MAXCMDLINE];
+extern int edit_line;
+extern int key_linepos;
+extern int key_insert;
+
+
+qboolean con_initialized;
+
+mempool_t *console_mempool;
+
+
+/*
+==============================================================================
+
+LOGGING
+
+==============================================================================
+*/
+
+cvar_t log_file = {0, "log_file",""};
+cvar_t log_sync = {0, "log_sync","0"};
+char crt_log_file [MAX_OSPATH] = "";
+qfile_t* logfile = NULL;
+
+qbyte* logqueue = NULL;
+size_t logq_ind = 0;
+size_t logq_size = 0;
+
+void Log_ConPrint (const char *msg);
+
+/*
+====================
+Log_Timestamp
+====================
+*/
+const char* Log_Timestamp (const char *desc)
+{
+       static char timestamp [128];
+       time_t crt_time;
+       const struct tm *crt_tm;
+       char timestring [64];
+
+       // Build the time stamp (ex: "Wed Jun 30 21:49:08 1993");
+       time (&crt_time);
+       crt_tm = localtime (&crt_time);
+       strftime (timestring, sizeof (timestring), "%a %b %d %T %Y", crt_tm);
+
+       if (desc != NULL)
+               snprintf (timestamp, sizeof (timestamp), "====== %s (%s) ======\n", desc, timestring);
+       else
+               snprintf (timestamp, sizeof (timestamp), "====== %s ======\n", timestring);
+
+       return timestamp;
+}
+
+
+/*
+====================
+Log_Init
+====================
+*/
+void Log_Init (void)
+{
+       Cvar_RegisterVariable (&log_file);
+       Cvar_RegisterVariable (&log_sync);
+
+       // support for the classic Quake option
+       if (COM_CheckParm ("-condebug") != 0)
+       {
+               Cvar_SetQuick (&log_file, "qconsole.log");
+               Cvar_SetValueQuick (&log_sync, 1);
+               unlink (va("%s/qconsole.log", fs_gamedir));
+       }
+
+       // Allocate a log queue
+       logq_size = 512;
+       logqueue = Mem_Alloc (tempmempool, logq_size);
+       logq_ind = 0;
+}
+
 
-float          con_cursorspeed = 4;
+/*
+====================
+Log_Open
+====================
+*/
+void Log_Open (void)
+{
+       if (logfile != NULL || log_file.string[0] == '\0')
+               return;
 
-#define                CON_TEXTSIZE    16384
+       logfile = FS_Open (log_file.string, "at", false);
+       if (logfile != NULL)
+       {
+               strlcpy (crt_log_file, log_file.string, sizeof (crt_log_file));
+               FS_Print (logfile, Log_Timestamp ("Log started"));
+       }
+}
 
-qboolean       con_forcedup;           // because no entities to refresh
 
-int                    con_totallines;         // total lines in console scrollback
-int                    con_backscroll;         // lines up from bottom to display
-int                    con_current;            // where next message will be printed
-int                    con_x;                          // offset in current line for next print
-char           *con_text = 0;
+/*
+====================
+Log_Close
+====================
+*/
+void Log_Close (void)
+{
+       if (logfile == NULL)
+               return;
 
-cvar_t         con_notifytime = {CVAR_SAVE, "con_notifytime","3"};     //seconds
-cvar_t         logfile = {0, "logfile","0"};
+       FS_Print (logfile, Log_Timestamp ("Log stopped"));
+       FS_Print (logfile, "\n");
+       FS_Close (logfile);
 
-#define        NUM_CON_TIMES 4
-float          con_times[NUM_CON_TIMES];       // realtime time the line was generated
-                                               // for transparent notify lines
+       logfile = NULL;
+       crt_log_file[0] = '\0';
+}
+
+
+/*
+====================
+Log_Start
+====================
+*/
+void Log_Start (void)
+{
+       Log_Open ();
 
-int                    con_vislines;
+       // Dump the contents of the log queue into the log file and free it
+       if (logqueue != NULL)
+       {
+               if (logfile != NULL && logq_ind != 0)
+                       FS_Write (logfile, logqueue, logq_ind);
+               Mem_Free (logqueue);
+               logqueue = NULL;
+               logq_ind = 0;
+               logq_size = 0;
+       }
+}
 
-qboolean       con_debuglog;
 
-#define        MAXCMDLINE      256
-extern char    key_lines[32][MAXCMDLINE];
-extern int             edit_line;
-extern int             key_linepos;
-extern int             key_insert;
+/*
+================
+Log_ConPrint
+================
+*/
+void Log_ConPrint (const char *msg)
+{
+       // Until the host is completely initialized, we maintain a log queue
+       // to store the messages, since the log can't be started before
+       if (logqueue != NULL)
+       {
+               size_t remain = logq_size - logq_ind;
+               size_t len = strlen (msg);
 
+               // If we need to enlarge the log queue
+               if (len > remain)
+               {
+                       unsigned int factor = ((logq_ind + len) / logq_size) + 1;
+                       qbyte* newqueue;
+
+                       logq_size *= factor;
+                       newqueue = Mem_Alloc (tempmempool, logq_size);
+                       memcpy (newqueue, logqueue, logq_ind);
+                       Mem_Free (logqueue);
+                       logqueue = newqueue;
+                       remain = logq_size - logq_ind;
+               }
+               memcpy (&logqueue[logq_ind], msg, len);
+               logq_ind += len;
 
-qboolean       con_initialized;
+               return;
+       }
 
-mempool_t      *console_mempool;
+       // Check if log_file has changed
+       if (strcmp (crt_log_file, log_file.string) != 0)
+       {
+               Log_Close ();
+               Log_Open ();
+       }
 
-int            con_notifylines;                // scan lines to clear for notify lines
+       // If a log file is available
+       if (logfile != NULL)
+       {
+               FS_Print (logfile, msg);
+               if (log_sync.integer)
+                       FS_Flush (logfile);
+       }
+}
 
-extern void M_Menu_Main_f (void);
 
 /*
 ================
-Con_ToggleConsole_f
+Log_Print
 ================
 */
-void Con_ToggleConsole_f (void)
+void Log_Print (const char *logfilename, const char *msg)
 {
-       if (key_dest == key_console)
+       qfile_t *file;
+       file = FS_Open(logfilename, "at", true);
+       if (file)
        {
-               if (cls.state == ca_connected)
-                       key_dest = key_game;
-               else
-                       M_Menu_Main_f ();
+               FS_Print(file, msg);
+               FS_Close(file);
        }
-       else
-               key_dest = key_console;
+}
 
+/*
+================
+Log_Printf
+================
+*/
+void Log_Printf (const char *logfilename, const char *fmt, ...)
+{
+       qfile_t *file;
+
+       file = FS_Open (logfilename, "at", true);
+       if (file != NULL)
+       {
+               va_list argptr;
+
+               va_start (argptr, fmt);
+               FS_VPrintf (file, fmt, argptr);
+               va_end (argptr);
+
+               FS_Close (file);
+       }
+}
+
+
+/*
+==============================================================================
+
+CONSOLE
+
+==============================================================================
+*/
+
+/*
+================
+Con_ToggleConsole_f
+================
+*/
+void Con_ToggleConsole_f (void)
+{
+       // toggle the 'user wants console' bit
+       key_consoleactive ^= KEY_CONSOLEACTIVE_USER;
        memset (con_times, 0, sizeof(con_times));
 }
 
@@ -112,9 +321,9 @@ Con_ClearNotify
 */
 void Con_ClearNotify (void)
 {
-       int             i;
+       int i;
 
-       for (i=0 ; i<NUM_CON_TIMES ; i++)
+       for (i=0 ; i<MAX_NOTIFYLINES ; i++)
                con_times[i] = 0;
 }
 
@@ -124,12 +333,10 @@ void Con_ClearNotify (void)
 Con_MessageMode_f
 ================
 */
-extern qboolean team_message;
-
 void Con_MessageMode_f (void)
 {
        key_dest = key_message;
-       team_message = false;
+       chat_team = false;
 }
 
 
@@ -141,7 +348,7 @@ Con_MessageMode2_f
 void Con_MessageMode2_f (void)
 {
        key_dest = key_message;
-       team_message = true;
+       chat_team = true;
 }
 
 
@@ -154,8 +361,8 @@ If the line width has changed, reformat the buffer.
 */
 void Con_CheckResize (void)
 {
-       int             i, j, width, oldwidth, oldtotallines, numlines, numchars;
-       char    tbuf[CON_TEXTSIZE];
+       int i, j, width, oldwidth, oldtotallines, numlines, numchars;
+       char tbuf[CON_TEXTSIZE];
 
        width = (vid.conwidth >> 3);
 
@@ -205,7 +412,6 @@ void Con_CheckResize (void)
        con_current = con_totallines - 1;
 }
 
-
 /*
 ================
 Con_Init
@@ -213,36 +419,19 @@ Con_Init
 */
 void Con_Init (void)
 {
-#define MAXGAMEDIRLEN  1000
-       char    temp[MAXGAMEDIRLEN+1];
-       char    *t2 = "/qconsole.log";
-
-       Cvar_RegisterVariable(&logfile);
-       con_debuglog = COM_CheckParm("-condebug");
-
-       if (con_debuglog)
-       {
-               if (strlen (com_gamedir) < (MAXGAMEDIRLEN - strlen (t2)))
-               {
-                       sprintf (temp, "%s%s", com_gamedir, t2);
-                       unlink (temp);
-               }
-               logfile.integer = 1;
-       }
-
        console_mempool = Mem_AllocPool("console");
        con_text = Mem_Alloc(console_mempool, CON_TEXTSIZE);
        memset (con_text, ' ', CON_TEXTSIZE);
        con_linewidth = -1;
        Con_CheckResize ();
 
-       Con_Print("Console initialized.\n");
+       Con_Print("Console initialized.\n");
 
-//
-// register our commands
-//
+       // register our cvars
        Cvar_RegisterVariable (&con_notifytime);
+       Cvar_RegisterVariable (&con_notify);
 
+       // register our commands
        Cmd_AddCommand ("toggleconsole", Con_ToggleConsole_f);
        Cmd_AddCommand ("messagemode", Con_MessageMode_f);
        Cmd_AddCommand ("messagemode2", Con_MessageMode2_f);
@@ -265,19 +454,17 @@ void Con_Linefeed (void)
 
 /*
 ================
-Con_Print
+Con_PrintToHistory
 
 Handles cursor positioning, line wrapping, etc
-All console printing must go through this in order to be logged to disk
+All console printing must go through this in order to be displayed
 If no console is visible, the notify window will pop up.
 ================
 */
-void Con_Print (char *txt)
+void Con_PrintToHistory(const char *txt)
 {
-       int             y;
-       int             c, l;
-       static int      cr;
-       int             mask;
+       int y, c, l, mask;
+       static int cr;
 
        con_backscroll = 0;
 
@@ -322,7 +509,14 @@ void Con_Print (char *txt)
                        Con_Linefeed ();
                // mark time for transparent overlay
                        if (con_current >= 0)
-                               con_times[con_current % NUM_CON_TIMES] = realtime;
+                       {
+                               if (con_notify.integer < 0)
+                                       Cvar_SetValueQuick(&con_notify, 0);
+                               if (con_notify.integer > MAX_NOTIFYLINES)
+                                       Cvar_SetValueQuick(&con_notify, MAX_NOTIFYLINES);
+                               if (con_notify.integer > 0)
+                                       con_times[con_current % con_notify.integer] = cl.time;
+                       }
                }
 
                switch (c)
@@ -348,64 +542,66 @@ void Con_Print (char *txt)
        }
 }
 
-
 /*
 ================
-Con_DebugLog
+Con_Print
+
+Prints to all appropriate console targets
 ================
 */
-void Con_DebugLog(char *file, char *fmt, ...)
+void Con_Print(const char *msg)
 {
-    va_list argptr;
-    FILE* fd;
-
-    fd = fopen(file, "at");
-    va_start(argptr, fmt);
-    vfprintf (fd, fmt, argptr);
-    va_end(argptr);
-    fclose(fd);
+       // also echo to debugging console
+       Sys_Print(msg);
+
+       // log all messages to file
+       Log_ConPrint (msg);
+
+       if (!con_initialized)
+               return;
+
+       if (cls.state == ca_dedicated)
+               return;         // no graphics mode
+
+       // write it to the scrollable buffer
+       Con_PrintToHistory(msg);
 }
 
 
+// LordHavoc: increased from 4096 to 16384
+#define        MAXPRINTMSG     16384
+
 /*
 ================
 Con_Printf
 
-Handles cursor positioning, line wrapping, etc
+Prints to all appropriate console targets
 ================
 */
-// LordHavoc: increased from 4096 to 16384
-#define        MAXPRINTMSG     16384
-// FIXME: make a buffer size safe vsprintf?
-void Con_Printf (char *fmt, ...)
+void Con_Printf(const char *fmt, ...)
 {
-       va_list         argptr;
-       char            msg[MAXPRINTMSG];
-
-       va_start (argptr,fmt);
-       vsprintf (msg,fmt,argptr);
-       va_end (argptr);
+       va_list argptr;
+       char msg[MAXPRINTMSG];
 
-// also echo to debugging console
-       Sys_Printf ("%s", msg);
-
-// log all messages to file
-       if (con_debuglog)
-       {
-               // can't use va() here because it might overwrite other important things
-               char logname[MAX_OSPATH];
-               sprintf(logname, "%s/qconsole.log", com_gamedir);
-               Con_DebugLog(logname, "%s", msg);
-       }
+       va_start(argptr,fmt);
+       vsprintf(msg,fmt,argptr);
+       va_end(argptr);
 
-       if (!con_initialized)
-               return;
+       Con_Print(msg);
+}
 
-       if (cls.state == ca_dedicated)
-               return;         // no graphics mode
+/*
+================
+Con_DPrint
 
-// write it to the scrollable buffer
-       Con_Print (msg);
+A Con_Print that only shows up if the "developer" cvar is set
+================
+*/
+void Con_DPrint(const char *msg)
+{
+       if (!developer.integer)
+               return;                 // don't confuse non-developers with techie stuff...
+       Con_Print(msg);
 }
 
 /*
@@ -415,22 +611,34 @@ Con_DPrintf
 A Con_Printf that only shows up if the "developer" cvar is set
 ================
 */
-void Con_DPrintf (char *fmt, ...)
+void Con_DPrintf(const char *fmt, ...)
 {
-       va_list         argptr;
-       char            msg[MAXPRINTMSG];
+       va_list argptr;
+       char msg[MAXPRINTMSG];
 
        if (!developer.integer)
                return;                 // don't confuse non-developers with techie stuff...
 
-       va_start (argptr,fmt);
-       vsprintf (msg,fmt,argptr);
-       va_end (argptr);
+       va_start(argptr,fmt);
+       vsprintf(msg,fmt,argptr);
+       va_end(argptr);
 
-       Con_Printf ("%s", msg);
+       Con_Print(msg);
 }
 
 
+/*
+================
+Con_SafePrint
+
+Okay to call even when the screen can't be updated
+==================
+*/
+void Con_SafePrint(const char *msg)
+{
+       Con_Print(msg);
+}
+
 /*
 ==================
 Con_SafePrintf
@@ -438,16 +646,16 @@ Con_SafePrintf
 Okay to call even when the screen can't be updated
 ==================
 */
-void Con_SafePrintf (char *fmt, ...)
+void Con_SafePrintf(const char *fmt, ...)
 {
-       va_list         argptr;
-       char            msg[1024];
+       va_list argptr;
+       char msg[MAXPRINTMSG];
 
-       va_start (argptr,fmt);
-       vsprintf (msg,fmt,argptr);
-       va_end (argptr);
+       va_start(argptr,fmt);
+       vsprintf(msg,fmt,argptr);
+       va_end(argptr);
 
-       Con_Printf ("%s", msg);
+       Con_Print(msg);
 }
 
 
@@ -471,9 +679,9 @@ Modified by EvilTypeGuy eviltypeguy@qeradiant.com
 */
 void Con_DrawInput (void)
 {
-       char editlinecopy[256], *text;
+       char editlinecopy[257], *text;
 
-       if (key_dest != key_console && !con_forcedup)
+       if (!key_consoleactive)
                return;         // don't draw anything
 
        text = strcpy(editlinecopy, key_lines[edit_line]);
@@ -517,15 +725,22 @@ void Con_DrawNotify (void)
        extern char chat_buffer[];
        char    temptext[256];
 
-       v = 0;
-       for (i= con_current-NUM_CON_TIMES+1 ; i<=con_current ; i++)
+       if (con_notify.integer < 0)
+               Cvar_SetValueQuick(&con_notify, 0);
+       if (con_notify.integer > MAX_NOTIFYLINES)
+               Cvar_SetValueQuick(&con_notify, MAX_NOTIFYLINES);
+       if (gamemode == GAME_TRANSFUSION)
+               v = 8;
+       else
+               v = 0;
+       for (i= con_current-con_notify.integer+1 ; i<=con_current ; i++)
        {
                if (i < 0)
                        continue;
-               time = con_times[i % NUM_CON_TIMES];
+               time = con_times[i % con_notify.integer];
                if (time == 0)
                        continue;
-               time = realtime - time;
+               time = cl.time - time;
                if (time > con_notifytime.value)
                        continue;
                text = con_text + (i % con_totallines)*con_linewidth;
@@ -545,11 +760,11 @@ void Con_DrawNotify (void)
                x = 0;
 
                // LordHavoc: speedup, and other improvements
-               if (team_message)
+               if (chat_team)
                        sprintf(temptext, "say_team:%s%c", chat_buffer, (int) 10+((int)(realtime*con_cursorspeed)&1));
                else
                        sprintf(temptext, "say:%s%c", chat_buffer, (int) 10+((int)(realtime*con_cursorspeed)&1));
-               while (strlen(temptext) >= con_linewidth)
+               while (strlen(temptext) >= (size_t) con_linewidth)
                {
                        DrawQ_String (0, v, temptext, con_linewidth, 8, 8, 1, 1, 1, 1, 0);
                        strcpy(temptext, &temptext[con_linewidth]);
@@ -561,9 +776,6 @@ void Con_DrawNotify (void)
                        v += 8;
                }
        }
-
-       if (v > con_notifylines)
-               con_notifylines = v;
 }
 
 /*
@@ -574,20 +786,20 @@ Draws the console with the solid background
 The typing input line at the bottom should only be drawn if typing is allowed
 ================
 */
-extern cvar_t scr_conalpha;
 extern char engineversion[40];
 void Con_DrawConsole (int lines)
 {
-       int                             i, y;
-       int                             rows;
-       char                    *text;
-       int                             j;
+       int i, y, rows, j;
+       char *text;
 
        if (lines <= 0)
                return;
 
 // draw the background
-       DrawQ_Pic(0, lines - vid.conheight, "gfx/conback", vid.conwidth, vid.conheight, 1, 1, 1, scr_conalpha.value * lines / vid.conheight, 0);
+       if (scr_conbrightness.value >= 0.01f)
+               DrawQ_Pic(0, lines - vid.conheight, "gfx/conback", vid.conwidth, vid.conheight, scr_conbrightness.value, scr_conbrightness.value, scr_conbrightness.value, scr_conalpha.value, 0);
+       else
+               DrawQ_Fill(0, lines - vid.conheight, vid.conwidth, vid.conheight, 0, 0, 0, scr_conalpha.value, 0);
        DrawQ_String(vid.conwidth - strlen(engineversion) * 8 - 8, lines - 8, engineversion, 0, 8, 8, 1, 0, 0, 1, 0);
 
 // draw the text
@@ -616,15 +828,10 @@ void Con_DrawConsole (int lines)
        MEGA Thanks to Taniwha
 
 */
-void
-Con_DisplayList(char **list)
+void Con_DisplayList(const char **list)
 {
-       int     i = 0;
-       int     pos = 0;
-       int     len = 0;
-       int     maxlen = 0;
-       int     width = (con_linewidth - 4);
-       char    **walk = list;
+       int i = 0, pos = 0, len = 0, maxlen = 0, width = (con_linewidth - 4);
+       const char **walk = list;
 
        while (*walk) {
                len = strlen(*walk);
@@ -637,20 +844,20 @@ Con_DisplayList(char **list)
        while (*list) {
                len = strlen(*list);
                if (pos + maxlen >= width) {
-                       Con_Printf("\n");
+                       Con_Print("\n");
                        pos = 0;
                }
 
-               Con_Printf("%s", *list);
+               Con_Print(*list);
                for (i = 0; i < (maxlen - len); i++)
-                       Con_Printf(" ");
+                       Con_Print(" ");
 
                pos += maxlen;
                list++;
        }
 
        if (pos)
-               Con_Printf("\n\n");
+               Con_Print("\n\n");
 }
 
 /*
@@ -662,14 +869,11 @@ Con_DisplayList(char **list)
        Thanks to taniwha
 
 */
-void
-Con_CompleteCommandLine (void)
+void Con_CompleteCommandLine (void)
 {
-       char    *cmd = "";
-       char    *s;
-       int             c, v, a, i;
-       int             cmd_len;
-       char    **list[3] = {0, 0, 0};
+       const char *cmd = "", *s;
+       const char **list[3] = {0, 0, 0};
+       int c, v, a, i, cmd_len;
 
        s = key_lines[edit_line] + 1;
        // Count number of possible matches
@@ -701,7 +905,7 @@ Con_CompleteCommandLine (void)
                do {
                        for (i = 0; i < 3; i++) {
                                char ch = cmd[cmd_len];
-                               char **l = list[i];
+                               const char **l = list[i];
                                if (l) {
                                        while (*l && (*l)[cmd_len] == ch)
                                                l++;
@@ -713,10 +917,10 @@ Con_CompleteCommandLine (void)
                                cmd_len++;
                } while (i == 3);
                // 'quakebar'
-               Con_Printf("\n\35");
+               Con_Print("\n\35");
                for (i = 0; i < con_linewidth - 4; i++)
-                       Con_Printf("\36");
-               Con_Printf("\37\n");
+                       Con_Print("\36");
+               Con_Print("\37\n");
 
                // Print Possible Commands
                if (c) {
@@ -746,6 +950,6 @@ Con_CompleteCommandLine (void)
        }
        for (i = 0; i < 3; i++)
                if (list[i])
-                       Mem_Free(list[i]);
+                       Mem_Free((void *)list[i]);
 }