summaryrefslogtreecommitdiffstatshomepage
path: root/src/emu/debug/textbuf.cpp
blob: c70f86601853dee9b5040f1143409132fd4f5719 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
// license:BSD-3-Clause
// copyright-holders:Aaron Giles
/***************************************************************************

    textbuf.cpp

    Debugger text buffering engine.

***************************************************************************/

#include "textbuf.h"

#include <new>



/***************************************************************************
    CONSTANTS
***************************************************************************/

#define MAX_LINE_LENGTH         250



/***************************************************************************
    TYPE DEFINITIONS
***************************************************************************/

struct text_buffer
{
	text_buffer(u32 bytes, u32 lines) noexcept
		: buffer(new (std::nothrow) char [bytes])
		, lineoffs(new (std::nothrow) s32 [lines])
		, bufsize(buffer ? bytes : 0)
		, linesize(lineoffs ? lines : 0)
	{
	}

	std::unique_ptr<char []> const  buffer;
	std::unique_ptr<s32 []> const   lineoffs;
	s32 const                       bufsize;
	s32                             bufstart = 0;
	s32                             bufend = 0;
	s32 const                       linesize;
	s32                             linestart = 0;
	s32                             lineend = 0;
	u32                             linestartseq = 0;
	s32                             maxwidth = 0;

	/*-------------------------------------------------
	    buffer_used - return the number of bytes
	    currently held in the buffer
	-------------------------------------------------*/

	s32 buffer_used() const noexcept
	{
		s32 const used(bufend - bufstart);
		return (used < 0) ? (used + bufsize) : used;
	}

	/*-------------------------------------------------
	    buffer_space - return the number of bytes
	    available in the buffer
	-------------------------------------------------*/

	s32 buffer_space() const noexcept
	{
		return bufsize - buffer_used();
	}
};



/***************************************************************************

    Buffer object management

***************************************************************************/

/*-------------------------------------------------
    text_buffer_alloc - allocate a new text buffer
-------------------------------------------------*/

text_buffer_ptr text_buffer_alloc(u32 bytes, u32 lines)
{
	// allocate memory for the text buffer object
	text_buffer_ptr text(new (std::nothrow) text_buffer(bytes, lines));

	if (!text)
		return nullptr;

	if (!text->buffer || !text->lineoffs)
		return nullptr;

	// initialize the buffer description
	text_buffer_clear(*text);

	return text;
}


/*-------------------------------------------------
    text_buffer_free - free a previously allocated
    text buffer
-------------------------------------------------*/

void text_buffer_deleter::operator()(text_buffer *text) const
{
	delete text;
}


/*-------------------------------------------------
    text_buffer_clear - clear a text buffer
-------------------------------------------------*/

void text_buffer_clear(text_buffer &text)
{
	// reset all the buffer pointers and other bits
	text.bufstart = 0;
	text.bufend = 0;

	text.linestart = 0;
	text.lineend = 0;
	text.linestartseq = 0;

	text.maxwidth = 0;

	// create the initial line
	text.lineoffs[0] = 0;
	text.buffer[text.lineoffs[0]] = 0;
}



/***************************************************************************

    Adding data to the buffer

***************************************************************************/

//-------------------------------------------------
//  text_buffer_print - print data to the text
//  buffer
//-------------------------------------------------

void text_buffer_print(text_buffer &text, std::string_view data)
{
	text_buffer_print_wrap(text, data, MAX_LINE_LENGTH);
}


//-------------------------------------------------
//  text_buffer_print_wrap - print data to the
//  text buffer with word wrapping to a given
//  column
//-------------------------------------------------

void text_buffer_print_wrap(text_buffer &text, std::string_view data, int wrapcol)
{
	s32 const stopcol = (wrapcol < MAX_LINE_LENGTH) ? wrapcol : MAX_LINE_LENGTH;

	// we need to ensure there is enough space for this string plus enough for the max line length
	s32 const needed_space = s32(data.length()) + MAX_LINE_LENGTH;

	// make space in the buffer if we need to
	while (text.buffer_space() < needed_space && text.linestart != text.lineend)
	{
		text.linestartseq++;
		if (++text.linestart >= text.linesize)
			text.linestart = 0;
		text.bufstart = text.lineoffs[text.linestart];
	}

	// now add the data
	for (int ch : data)
	{
		int linelen;

		// a CR resets our position
		if (ch == '\r')
			text.bufend = text.lineoffs[text.lineend];

		// non-CR data is just characters
		else if (ch != '\n')
			text.buffer[text.bufend++] = ch;

		// an explicit newline or line-too-long condition inserts a newline */
		linelen = text.bufend - text.lineoffs[text.lineend];
		if (ch == '\n' || linelen >= stopcol)
		{
			int overflow = 0;

			// if we're wrapping, back off until we hit a space
			if (linelen >= wrapcol)
			{
				// scan backwards, removing characters along the way
				overflow = 1;
				while (overflow < linelen && text.buffer[text.bufend - overflow] != ' ')
					overflow++;

				// if we found a space, take it; otherwise, reset and pretend we didn't try
				if (overflow < linelen)
					linelen -= overflow;
				else
					overflow = 0;
			}

			// did we beat the max width
			if (linelen > text.maxwidth)
				text.maxwidth = linelen;

			// append a terminator
			if (overflow == 0)
				text.buffer[text.bufend++] = 0;
			else
				text.buffer[text.bufend - overflow] = 0;

			// determine what the next line will be
			if (++text.lineend >= text.linesize)
				text.lineend = 0;

			// if we're out of lines, consume the next one
			if (text.lineend == text.linestart)
			{
				text.linestartseq++;
				if (++text.linestart >= text.linesize)
					text.linestart = 0;
				text.bufstart = text.lineoffs[text.linestart];
			}

			// if we don't have enough room in the buffer for a max line, wrap to the start
			if (text.bufend + MAX_LINE_LENGTH + 1 >= text.bufsize)
				text.bufend = 0;

			// create a new empty line
			text.lineoffs[text.lineend] = text.bufend - (overflow ? (overflow - 1) : 0);
		}
	}

	// null terminate what we have on this line
	text.buffer[text.bufend] = 0;
}



/***************************************************************************

    Reading data from the buffer

***************************************************************************/

/*-------------------------------------------------
    text_buffer_max_width - return the maximum
    width of all lines seen so far
-------------------------------------------------*/

u32 text_buffer_max_width(text_buffer const &text)
{
	return text.maxwidth;
}


/*-------------------------------------------------
    text_buffer_num_lines - return the number of
    lines in the text buffer
-------------------------------------------------*/

u32 text_buffer_num_lines(text_buffer const &text)
{
	s32 const lines = text.lineend + 1 - text.linestart;
	return (lines <= 0) ? (lines + text.linesize) : lines;
}


/*-------------------------------------------------
    text_buffer_line_index_to_seqnum - convert a
    line index into a sequence number
-------------------------------------------------*/

u32 text_buffer_line_index_to_seqnum(text_buffer const &text, u32 index)
{
	return text.linestartseq + index;
}


/*-------------------------------------------------
    text_buffer_get_seqnum_line - get a pointer to
    an indexed line in the buffer
-------------------------------------------------*/

const char *text_buffer_get_seqnum_line(text_buffer const &text, u32 seqnum)
{
	u32 const numlines = text_buffer_num_lines(text);
	u32 const index = seqnum - text.linestartseq;
	if (index >= numlines)
		return nullptr;
	return &text.buffer[text.lineoffs[(text.linestart + index) % text.linesize]];
}

/*---------------------------------------------------------------------
    text_buffer_lines::text_buffer_line_iterator::operator*
    Gets the line that the iterator currently points to.
-----------------------------------------------------------------------*/

std::string_view text_buffer_lines::text_buffer_line_iterator::operator*() const
{
	char const *const line = &m_buffer.buffer[m_buffer.lineoffs[m_lineptr]];

	auto next_lineptr = m_lineptr + 1;
	if (next_lineptr == m_buffer.linesize)
		next_lineptr = 0;

	char const *const nextline = &m_buffer.buffer[m_buffer.lineoffs[next_lineptr]];

	// -1 for the '\0' at the end of line
	ptrdiff_t difference = (nextline - line) - 1;

	if (difference < 0)
		difference += m_buffer.bufsize;

	return std::string_view{ line, std::string_view::size_type(difference) };
}

/*---------------------------------------------------------------------
    text_buffer_lines::text_buffer_line_iterator::operator++
    Moves to the next line.
-----------------------------------------------------------------------*/

text_buffer_lines::text_buffer_line_iterator &text_buffer_lines::text_buffer_line_iterator::operator++()
{
	if (++m_lineptr == m_buffer.linesize)
		m_lineptr = 0;

	return *this;
}

/*------------------------------------------------------
    text_buffer_lines::begin()
    Returns an iterator that points to the first line.
--------------------------------------------------------*/

text_buffer_lines::iterator text_buffer_lines::begin() const
{
	return text_buffer_line_iterator(m_buffer, m_buffer.linestart);
}

/*-----------------------------------------------------------
    text_buffer_lines::begin()
    Returns an iterator that points just past the last line.
-------------------------------------------------------------*/

text_buffer_lines::iterator text_buffer_lines::end() const
{
	return text_buffer_line_iterator(m_buffer, m_buffer.lineend);
}