console.h

   1 /*
   2 Copyright (C) 1996-1997 Id Software, Inc.
   3
   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.
   8
   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.
  12
  13 See the GNU General Public License for more details.
  14
  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.
  18
  19 */
  20
  21 #ifndef CONSOLE_H
  22 #define CONSOLE_H
  23
  24 //
  25 // console
  26 //
  27 extern int con_totallines;
  28 extern int con_backscroll;
  29 extern qboolean con_initialized;
  30
  31 void Con_Rcon_Redirect_Init(lhnetsocket_t *sock, lhnetaddress_t *dest);
  32 void Con_Rcon_Redirect_End(void);
  33 void Con_Rcon_Redirect_Abort(void);
  34
  35 /// If the line width has changed, reformat the buffer.
  36 void Con_CheckResize (void);
  37 void Con_Init (void);
  38 void Con_Init_Commands (void);
  39 void Con_Shutdown (void);
  40 void Con_DrawConsole (int lines);
  41
  42 /// Prints to all appropriate console targets, and adds timestamps
  43 void Con_Print(const char *txt);
  44
  45 /// Prints to all appropriate console targets.
  46 void Con_Printf(const char *fmt, ...) DP_FUNC_PRINTF(1);
  47
  48 /// A Con_Print that only shows up if the "developer" cvar is set.
  49 void Con_DPrint(const char *msg);
  50
  51 /// A Con_Printf that only shows up if the "developer" cvar is set
  52 void Con_DPrintf(const char *fmt, ...) DP_FUNC_PRINTF(1);
  53 void Con_Clear_f (void);
  54 void Con_DrawNotify (void);
  55
  56 /// Clear all notify lines.
  57 void Con_ClearNotify (void);
  58 void Con_ToggleConsole_f (void);
  59
  60 qboolean GetMapList (const char *s, char *completedname, int completednamebufferlength);
  61
  62 /// wrapper function to attempt to either complete the command line
  63 /// or to list possible matches grouped by type
  64 /// (i.e. will display possible variables, aliases, commands
  65 /// that match what they've typed so far)
  66 void Con_CompleteCommandLine(void);
  67
  68 /// Generic libs/util/console.c function to display a list
  69 /// formatted in columns on the console
  70 void Con_DisplayList(const char **list);
  71
  72
  73 /*! \name log
  74  * @{
  75  */
  76 void Log_Init (void);
  77 void Log_Close (void);
  78 void Log_Start (void);
  79 void Log_DestBuffer_Flush (void); ///< call this once per frame to send out replies to rcon streaming clients
  80
  81 void Log_Printf(const char *logfilename, const char *fmt, ...) DP_FUNC_PRINTF(2);
  82 //@}
  83
  84 #define CON_MASK_HIDENOTIFY 128
  85 #define CON_MASK_CHAT 1
  86 #define CON_MASK_INPUT 2
  87
  88 typedef struct con_lineinfo_s
  89 {
  90         char *start;
  91         size_t len;
  92         int mask;
  93
  94         /// used only by console.c
  95         double addtime;
  96         int height; ///< recalculated line height when needed (-1 to unset)
  97 }
  98 con_lineinfo_t;
  99
 100 typedef struct conbuffer_s
 101 {
 102         int textsize;
 103         char *text;
 104         int maxlines;
 105         con_lineinfo_t *lines;
 106         int lines_first;
 107         int lines_count; ///< cyclic buffer
 108 }
 109 conbuffer_t;
 110
 111 #define CONBUFFER_LINES(buf, i) (buf)->lines[((buf)->lines_first + (i)) % (buf)->maxlines]
 112 #define CONBUFFER_LINES_COUNT(buf) ((buf)->lines_count)
 113 #define CONBUFFER_LINES_LAST(buf) CONBUFFER_LINES(buf, CONBUFFER_LINES_COUNT(buf) - 1)
 114
 115 void ConBuffer_Init(conbuffer_t *buf, int textsize, int maxlines, mempool_t *mempool);
 116 void ConBuffer_Clear (conbuffer_t *buf);
 117 void ConBuffer_Shutdown(conbuffer_t *buf);
 118
 119 /*! Notifies the console code about the current time
 120  * (and shifts back times of other entries when the time
 121  * went backwards)
 122  */
 123 void ConBuffer_FixTimes(conbuffer_t *buf);
 124
 125 /// Deletes the first line from the console history.
 126 void ConBuffer_DeleteLine(conbuffer_t *buf);
 127
 128 /// Deletes the last line from the console history.
 129 void ConBuffer_DeleteLastLine(conbuffer_t *buf);
 130
 131 /// Appends a given string as a new line to the console.
 132 void ConBuffer_AddLine(conbuffer_t *buf, const char *line, int len, int mask);
 133 int ConBuffer_FindPrevLine(conbuffer_t *buf, int mask_must, int mask_mustnot, int start);
 134 int ConBuffer_FindNextLine(conbuffer_t *buf, int mask_must, int mask_mustnot, int start);
 135 const char *ConBuffer_GetLine(conbuffer_t *buf, int i);
 136
 137 #endif
 138