improve abstraction of console buffer access; remove now unnecessary accessor macros
[divverent/darkplaces.git] / 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();
33 void Con_Rcon_Redirect_Abort();
34
35 void Con_CheckResize (void);
36 void Con_Init (void);
37 void Con_Init_Commands (void);
38 void Con_Shutdown (void);
39 void Con_DrawConsole (int lines);
40 void Con_Print(const char *txt);
41 void Con_Printf(const char *fmt, ...) DP_FUNC_PRINTF(1);
42 void Con_DPrint(const char *msg);
43 void Con_DPrintf(const char *fmt, ...) DP_FUNC_PRINTF(1);
44 void Con_Clear_f (void);
45 void Con_DrawNotify (void);
46 void Con_ClearNotify (void);
47 void Con_ToggleConsole_f (void);
48
49 qboolean GetMapList (const char *s, char *completedname, int completednamebufferlength);
50
51 // wrapper function to attempt to either complete the command line
52 // or to list possible matches grouped by type
53 // (i.e. will display possible variables, aliases, commands
54 // that match what they've typed so far)
55 void Con_CompleteCommandLine(void);
56
57 // Generic libs/util/console.c function to display a list
58 // formatted in columns on the console
59 void Con_DisplayList(const char **list);
60
61
62 //
63 // log
64 //
65 void Log_Init (void);
66 void Log_Close (void);
67 void Log_Start (void);
68 void Log_DestBuffer_Flush (void); // call this once per frame to send out replies to rcon streaming clients
69
70 void Log_Printf(const char *logfilename, const char *fmt, ...) DP_FUNC_PRINTF(2);
71
72 #define CON_MASK_HIDENOTIFY 128
73 #define CON_MASK_CHAT 1
74 #define CON_MASK_INPUT 2
75
76 typedef struct con_lineinfo_s
77 {
78         char *start;
79         size_t len;
80         int mask;
81
82         // used only by console.c
83         double addtime;
84         int height; // recalculated line height when needed (-1 to unset)
85 }
86 con_lineinfo_t;
87
88 typedef struct conbuffer_s
89 {
90         int textsize;
91         char *text;
92         int maxlines;
93         con_lineinfo_t *lines;
94         int lines_first;
95         int lines_count; // cyclic buffer
96 }
97 conbuffer_t;
98
99 #define CONBUFFER_LINES(buf, i) (buf)->lines[((buf)->lines_first + (i)) % (buf)->maxlines]
100 #define CONBUFFER_LINES_COUNT(buf) ((buf)->lines_count)
101 #define CONBUFFER_LINES_LAST(buf) CONBUFFER_LINES(buf, CONBUFFER_LINES_COUNT(buf) - 1)
102
103 void ConBuffer_Init(conbuffer_t *buf, int textsize, int maxlines, mempool_t *mempool);
104 void ConBuffer_Clear (conbuffer_t *buf);
105 void ConBuffer_Shutdown(conbuffer_t *buf);
106 void ConBuffer_FixTimes(conbuffer_t *buf);
107 void ConBuffer_DeleteLine(conbuffer_t *buf);
108 void ConBuffer_DeleteLastLine(conbuffer_t *buf);
109 void ConBuffer_AddLine(conbuffer_t *buf, const char *line, int len, int mask);
110 int ConBuffer_FindPrevLine(conbuffer_t *buf, int mask_must, int mask_mustnot, int start);
111 int ConBuffer_FindNextLine(conbuffer_t *buf, int mask_must, int mask_mustnot, int start);
112 const char *ConBuffer_GetLine(conbuffer_t *buf, int i);
113
114 #endif
115