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 a chosen console target
  43 void Con_MaskPrint(int mask, const char *msg);
  44
  45 // Prints to a chosen console target
  46 void Con_MaskPrintf(int mask, const char *fmt, ...) DP_FUNC_PRINTF(2);
  47
  48 /// Prints to all appropriate console targets, and adds timestamps
  49 void Con_Print(const char *txt);
  50
  51 /// Prints to all appropriate console targets.
  52 void Con_Printf(const char *fmt, ...) DP_FUNC_PRINTF(1);
  53
  54 /// A Con_Print that only shows up if the "developer" cvar is set.
  55 void Con_DPrint(const char *msg);
  56
  57 /// A Con_Printf that only shows up if the "developer" cvar is set
  58 void Con_DPrintf(const char *fmt, ...) DP_FUNC_PRINTF(1);
  59 void Con_Clear_f (void);
  60 void Con_DrawNotify (void);
  61
  62 /// Clear all notify lines.
  63 void Con_ClearNotify (void);
  64 void Con_ToggleConsole_f (void);
  65
  66 qboolean GetMapList (const char *s, char *completedname, int completednamebufferlength);
  67
  68 /// wrapper function to attempt to either complete the command line
  69 /// or to list possible matches grouped by type
  70 /// (i.e. will display possible variables, aliases, commands
  71 /// that match what they've typed so far)
  72 void Con_CompleteCommandLine(void);
  73
  74 /// Generic libs/util/console.c function to display a list
  75 /// formatted in columns on the console
  76 void Con_DisplayList(const char **list);
  77
  78
  79 /*! \name log
  80  * @{
  81  */
  82 void Log_Init (void);
  83 void Log_Close (void);
  84 void Log_Start (void);
  85 void Log_DestBuffer_Flush (void); ///< call this once per frame to send out replies to rcon streaming clients
  86
  87 void Log_Printf(const char *logfilename, const char *fmt, ...) DP_FUNC_PRINTF(2);
  88 //@}
  89
  90 // CON_MASK_PRINT is the default (Con_Print/Con_Printf)
  91 // CON_MASK_DEVELOPER is used by Con_DPrint/Con_DPrintf
  92 #define CON_MASK_HIDENOTIFY 128
  93 #define CON_MASK_CHAT 1
  94 #define CON_MASK_INPUT 2
  95 #define CON_MASK_DEVELOPER 4
  96 #define CON_MASK_PRINT 8
  97
  98 typedef struct con_lineinfo_s
  99 {
 100         char *start;
 101         size_t len;
 102         int mask;
 103
 104         /// used only by console.c
 105         double addtime;
 106         int height; ///< recalculated line height when needed (-1 to unset)
 107 }
 108 con_lineinfo_t;
 109
 110 typedef struct conbuffer_s
 111 {
 112         qboolean active;
 113         int textsize;
 114         char *text;
 115         int maxlines;
 116         con_lineinfo_t *lines;
 117         int lines_first;
 118         int lines_count; ///< cyclic buffer
 119 }
 120 conbuffer_t;
 121
 122 #define CONBUFFER_LINES(buf, i) (buf)->lines[((buf)->lines_first + (i)) % (buf)->maxlines]
 123 #define CONBUFFER_LINES_COUNT(buf) ((buf)->lines_count)
 124 #define CONBUFFER_LINES_LAST(buf) CONBUFFER_LINES(buf, CONBUFFER_LINES_COUNT(buf) - 1)
 125
 126 void ConBuffer_Init(conbuffer_t *buf, int textsize, int maxlines, mempool_t *mempool);
 127 void ConBuffer_Clear (conbuffer_t *buf);
 128 void ConBuffer_Shutdown(conbuffer_t *buf);
 129
 130 /*! Notifies the console code about the current time
 131  * (and shifts back times of other entries when the time
 132  * went backwards)
 133  */
 134 void ConBuffer_FixTimes(conbuffer_t *buf);
 135
 136 /// Deletes the first line from the console history.
 137 void ConBuffer_DeleteLine(conbuffer_t *buf);
 138
 139 /// Deletes the last line from the console history.
 140 void ConBuffer_DeleteLastLine(conbuffer_t *buf);
 141
 142 /// Appends a given string as a new line to the console.
 143 void ConBuffer_AddLine(conbuffer_t *buf, const char *line, int len, int mask);
 144 int ConBuffer_FindPrevLine(conbuffer_t *buf, int mask_must, int mask_mustnot, int start);
 145 int ConBuffer_FindNextLine(conbuffer_t *buf, int mask_must, int mask_mustnot, int start);
 146 const char *ConBuffer_GetLine(conbuffer_t *buf, int i);
 147
 148 #endif
 149