/src/capstonenext/SStream.c

Source
/* Capstone Disassembly Engine */
/* By Nguyen Anh Quynh <aquynh@gmail.com>, 2013-2019 */

#include <stdarg.h>
#if defined(CAPSTONE_HAS_OSXKERNEL)
#include <Availability.h>
#include <libkern/libkern.h>
#include <i386/limits.h>
#else
#include <stdio.h>
#include <limits.h>
#endif
#include <string.h>

#include <capstone/platform.h>

#include "SStream.h"
#include "cs_priv.h"
#include "utils.h"

static size_t SStream_remaining(SStream *ss)
{
  assert(ss);
  if (ss->index >= SSTREAM_BUF_LEN) {
    ss->index = SSTREAM_BUF_LEN - 1;
    ss->buffer[ss->index] = '\0';
    return 0;
  }
  return SSTREAM_BUF_LEN - ss->index - 1;
}

static void SStream_concat_raw(SStream *ss, const char *s, size_t len)
{
  size_t remaining = SStream_remaining(ss);
  if (len > remaining) {
    len = remaining;
  }
  if (len > 0) {
    memcpy(ss->buffer + ss->index, s, len);
    ss->index += len;
  }
  ss->buffer[ss->index] = '\0';
}

static void SStream_concat1_raw(SStream *ss, char c)
{
  if (SStream_remaining(ss) == 0) {
    return;
  }
  ss->buffer[ss->index] = c;
  ss->index++;
  ss->buffer[ss->index] = '\0';
}

static void SStream_close_markup(SStream *ss)
{
  if (ss->markup_stream && ss->prefixed_by_markup) {
    SStream_concat1_raw(ss, '>');
  }
}

void SStream_Init(SStream *ss)
{
  assert(ss);
  ss->index = 0;
  memset(ss->buffer, 0, sizeof(ss->buffer));
  ss->is_closed = false;
  ss->markup_stream = false;
  ss->prefixed_by_markup = false;
  ss->unsigned_num = false;
}

void SStream_opt_unum(SStream *ss, bool print_unsigned_numbers)
{
  assert(ss);
  ss->unsigned_num = print_unsigned_numbers;
}

/// Returns the a pointer to the internal string buffer of the stream.
/// For reading only.
const char *SStream_rbuf(const SStream *ss)
{
  assert(ss);
  return ss->buffer;
}

/// Searches in the stream for the first (from the left) occurrence of @elem and replaces
/// it with @repl. It returns the pointer *after* the replaced character
/// or NULL if no character was replaced.
///
/// It will never replace the final \0 byte in the stream buffer.
const char *SStream_replc(const SStream *ss, char elem, char repl)
{
  assert(ss);
  char *found = strchr(ss->buffer, elem);
  if (!found || found == ss->buffer + (SSTREAM_BUF_LEN - 1)) {
    return NULL;
  }
  *found = repl;
  found++;
  return found;
}

/// Searches in the stream for the first (from the left) occurrence of @chr and replaces
/// it with @rstr.
void SStream_replc_str(SStream *ss, char chr, const char *rstr)
{
  assert(ss && rstr);
  char *found = strchr(ss->buffer, chr);
  if (!found || found == ss->buffer + (SSTREAM_BUF_LEN - 1)) {
    return;
  }
  size_t post_len = strlen(found + 1);
  size_t buf_str_len = strlen(ss->buffer);
  size_t repl_len = strlen(rstr);
  if (repl_len - 1 + buf_str_len >= SSTREAM_BUF_LEN) {
    return;
  }
  memmove(found + repl_len, found + 1, post_len);
  memcpy(found, rstr, repl_len);
  ss->index = strlen(ss->buffer);
}

/// Removes the space characters '\t' and ' ' from the beginning of the stream buffer.
void SStream_trimls(SStream *ss)
{
  assert(ss);
  size_t buf_off = 0;
  /// Remove leading spaces
  while (ss->buffer[buf_off] == ' ' || ss->buffer[buf_off] == '\t') {
    buf_off++;
  }
  if (buf_off > 0) {
    memmove(ss->buffer, ss->buffer + buf_off,
      SSTREAM_BUF_LEN - buf_off);
    ss->index -= buf_off;
  }
}

/// Extract the mnemonic to @mnem_buf and the operand string into @op_str_buf from the stream buffer.
/// The mnemonic is everything up until the first ' ' or '\t' character.
/// The operand string is everything after the first ' ' or '\t' sequence.
void SStream_extract_mnem_opstr(const SStream *ss, char *mnem_buf,
        size_t mnem_buf_size, char *op_str_buf,
        size_t op_str_buf_size)
{
  assert(ss && mnem_buf && mnem_buf_size > 0 && op_str_buf &&
         op_str_buf_size > 0);
  size_t off = 0;
  // Copy all non space chars to as mnemonic.
  while (ss->buffer[off] && ss->buffer[off] != ' ' &&
         ss->buffer[off] != '\t') {
    if (off < mnem_buf_size - 1) {
      // Only copy if there is space left.
      mnem_buf[off] = ss->buffer[off];
    }
    off++;
  }
  if (!ss->buffer[off]) {
    return;
  }

  // Iterate until next non space char.
  do {
    off++;
  } while (ss->buffer[off] &&
     (ss->buffer[off] == ' ' || ss->buffer[off] == '\t'));

  if (!ss->buffer[off]) {
    return;
  }

  // Copy all follow up characters as op_str
  const char *ss_op_str = ss->buffer + off;
  off = 0;
  while (ss_op_str[off] && off < op_str_buf_size - 1) {
    op_str_buf[off] = ss_op_str[off];
    off++;
  }
}

/// Empty the stream @ss to given @file (stdin/stderr).
/// @file can be NULL. Then the buffer content is not emitted.
void SStream_Flush(SStream *ss, FILE *file)
{
  assert(ss);
  if (file) {
    fprintf(file, "%s\n", ss->buffer);
  }
  SStream_Init(ss);
}

/**
 * Open the output stream. Every write attempt is accepted again.
 */
void SStream_Open(SStream *ss)
{
  assert(ss);
  ss->is_closed = false;
}

/**
 * Closes the output stream. Every write attempt is ignored.
 */
void SStream_Close(SStream *ss)
{
  assert(ss);
  ss->is_closed = true;
}

/**
 * Copy the string \p s to the buffer of \p ss and terminate it with a '\\0' byte.
 */
void SStream_concat0(SStream *ss, const char *s)
{
#ifndef CAPSTONE_DIET
  assert(ss && s);
  SSTREAM_RETURN_IF_CLOSED(ss);
  if (s[0] == '\0')
    return;

  SStream_concat_raw(ss, s, strlen(s));
  SStream_close_markup(ss);
#else
  ss->buffer[ss->index] = '\0';
#endif
}

/**
 * Copy the single char \p c to the buffer of \p ss.
 */
void SStream_concat1(SStream *ss, const char c)
{
#ifndef CAPSTONE_DIET
  assert(ss);
  SSTREAM_RETURN_IF_CLOSED(ss);
  if (c == '\0')
    return;

  SStream_concat1_raw(ss, c);
  SStream_close_markup(ss);
#else
  ss->buffer[ss->index] = '\0';
#endif
}

/**
 * Copy all strings given to the buffer of \p ss according to formatting \p fmt.
 */
void SStream_concat(SStream *ss, const char *fmt, ...)
{
#ifndef CAPSTONE_DIET
  assert(ss && fmt);
  SSTREAM_RETURN_IF_CLOSED(ss);
  va_list ap;
  int ret;
  size_t remaining = SStream_remaining(ss);
  if (remaining == 0) {
    return;
  }

  va_start(ap, fmt);
  ret = cs_vsnprintf(ss->buffer + ss->index, remaining + 1, fmt, ap);
  va_end(ap);
  if (ret < 0) {
    ss->buffer[ss->index] = '\0';
    return;
  }
  if ((size_t)ret > remaining) {
    ss->index += remaining;
  } else {
    ss->index += (size_t)ret;
  }
  SStream_close_markup(ss);
#else
  ss->buffer[ss->index] = '\0';
#endif
}

// print number with prefix #
void printInt64Bang(SStream *ss, int64_t val)
{
  assert(ss);
  if (ss->unsigned_num) {
    printUInt64Bang(ss, val);
    return;
  }
  SSTREAM_RETURN_IF_CLOSED(ss);
  SStream_concat1(ss, '#');
  printInt64(ss, val);
}

void printUInt64Bang(SStream *ss, uint64_t val)
{
  assert(ss);
  SSTREAM_RETURN_IF_CLOSED(ss);
  SStream_concat1(ss, '#');
  printUInt64(ss, val);
}

// print number
void printInt64(SStream *ss, int64_t val)
{
  assert(ss);
  if (ss->unsigned_num) {
    printUInt64(ss, val);
    return;
  }
  SSTREAM_RETURN_IF_CLOSED(ss);
  if (val >= 0) {
    if (val > HEX_THRESHOLD)
      SStream_concat(ss, "0x%" PRIx64, val);
    else
      SStream_concat(ss, "%" PRIu64, val);
  } else {
    if (val < -HEX_THRESHOLD) {
      if (val == INT64_MIN)
        SStream_concat(ss, "-0x%" PRIx64,
                 (uint64_t)INT64_MAX + 1);
      else
        SStream_concat(ss, "-0x%" PRIx64,
                 (uint64_t)-val);
    } else
      SStream_concat(ss, "-%" PRIu64, -val);
  }
}

void printUInt64(SStream *ss, uint64_t val)
{
  assert(ss);
  SSTREAM_RETURN_IF_CLOSED(ss);
  if (val > HEX_THRESHOLD)
    SStream_concat(ss, "0x%" PRIx64, val);
  else
    SStream_concat(ss, "%" PRIu64, val);
}

// print number in decimal mode
void printInt32BangDec(SStream *ss, int32_t val)
{
  assert(ss);
  SSTREAM_RETURN_IF_CLOSED(ss);
  if (val >= 0)
    SStream_concat(ss, "#%" PRIu32, val);
  else {
    if (val == INT32_MIN)
      SStream_concat(ss, "#-%" PRIu32, val);
    else
      SStream_concat(ss, "#-%" PRIu32, (uint32_t)-val);
  }
}

void printInt32Bang(SStream *ss, int32_t val)
{
  assert(ss);
  if (ss->unsigned_num) {
    printUInt32Bang(ss, val);
    return;
  }
  SSTREAM_RETURN_IF_CLOSED(ss);
  SStream_concat1(ss, '#');
  printInt32(ss, val);
}

void printUInt8(SStream *ss, uint8_t val)
{
  assert(ss);
  if (val > HEX_THRESHOLD)
    SStream_concat(ss, "0x%" PRIx8, val);
  else
    SStream_concat(ss, "%" PRIu8, val);
}

void printUInt16(SStream *ss, uint16_t val)
{
  assert(ss);
  if (val > HEX_THRESHOLD)
    SStream_concat(ss, "0x%" PRIx16, val);
  else
    SStream_concat(ss, "%" PRIu16, val);
}

void printInt8(SStream *ss, int8_t val)
{
  assert(ss);
  if (ss->unsigned_num) {
    printUInt8(ss, val);
    return;
  }
  SSTREAM_RETURN_IF_CLOSED(ss);
  if (val >= 0) {
    if (val > HEX_THRESHOLD)
      SStream_concat(ss, "0x%" PRIx8, val);
    else
      SStream_concat(ss, "%" PRId8, val);
  } else {
    if (val < -HEX_THRESHOLD) {
      if (val == INT8_MIN)
        SStream_concat(ss, "-0x%" PRIx8,
                 (uint8_t)INT8_MAX + 1);
      else
        SStream_concat(ss, "-0x%" PRIx8, (int8_t)-val);
    } else
      SStream_concat(ss, "-%" PRIu8, -val);
  }
}

void printInt16(SStream *ss, int16_t val)
{
  assert(ss);
  if (ss->unsigned_num) {
    printUInt16(ss, val);
    return;
  }
  SSTREAM_RETURN_IF_CLOSED(ss);
  if (val >= 0) {
    if (val > HEX_THRESHOLD)
      SStream_concat(ss, "0x%" PRIx16, val);
    else
      SStream_concat(ss, "%" PRId16, val);
  } else {
    if (val < -HEX_THRESHOLD) {
      if (val == INT16_MIN)
        SStream_concat(ss, "-0x%" PRIx16,
                 (uint16_t)INT16_MAX + 1);
      else
        SStream_concat(ss, "-0x%" PRIx16,
                 (int16_t)-val);
    } else
      SStream_concat(ss, "-%" PRIu16, -val);
  }
}

void printInt16HexOffset(SStream *ss, int16_t val)
{
  assert(ss);
  if (ss->unsigned_num) {
    printUInt16(ss, val);
    return;
  }
  SSTREAM_RETURN_IF_CLOSED(ss);
  if (val >= 0) {
    SStream_concat(ss, "+0x%" PRIx16, val);
  } else {
    if (val == INT16_MIN)
      SStream_concat(ss, "-0x%" PRIx16,
               (uint16_t)INT16_MAX + 1);
    else
      SStream_concat(ss, "-0x%" PRIx16, (int16_t)-val);
  }
}

void printInt32(SStream *ss, int32_t val)
{
  assert(ss);
  if (ss->unsigned_num) {
    printUInt32(ss, val);
    return;
  }
  SSTREAM_RETURN_IF_CLOSED(ss);
  if (val >= 0) {
    if (val > HEX_THRESHOLD)
      SStream_concat(ss, "0x%" PRIx32, val);
    else
      SStream_concat(ss, "%" PRId32, val);
  } else {
    if (val < -HEX_THRESHOLD) {
      if (val == INT32_MIN)
        SStream_concat(ss, "-0x%" PRIx32,
                 (uint32_t)INT32_MAX + 1);
      else
        SStream_concat(ss, "-0x%" PRIx32,
                 (int32_t)-val);
    } else {
      SStream_concat(ss, "-%" PRIu32, (uint32_t)-val);
    }
  }
}

void printInt32HexOffset(SStream *ss, int32_t val)
{
  assert(ss);
  if (ss->unsigned_num) {
    printUInt32(ss, val);
    return;
  }
  SSTREAM_RETURN_IF_CLOSED(ss);
  if (val >= 0) {
    SStream_concat(ss, "+0x%" PRIx32, val);
  } else {
    if (val == INT32_MIN)
      SStream_concat(ss, "-0x%" PRIx32,
               (uint32_t)INT32_MAX + 1);
    else
      SStream_concat(ss, "-0x%" PRIx32, (int32_t)-val);
  }
}

void printInt32Hex(SStream *ss, int32_t val)
{
  assert(ss);
  SSTREAM_RETURN_IF_CLOSED(ss);
  if (val >= 0) {
    SStream_concat(ss, "0x%" PRIx32, val);
  } else {
    if (val == INT32_MIN)
      SStream_concat(ss, "-0x%" PRIx32,
               (uint32_t)INT32_MAX + 1);
    else
      SStream_concat(ss, "-0x%" PRIx32, (int32_t)-val);
  }
}

void printUInt32Bang(SStream *ss, uint32_t val)
{
  assert(ss);
  SSTREAM_RETURN_IF_CLOSED(ss);
  SStream_concat1(ss, '#');
  printUInt32(ss, val);
}

void printUInt32(SStream *ss, uint32_t val)
{
  assert(ss);
  SSTREAM_RETURN_IF_CLOSED(ss);
  if (val > HEX_THRESHOLD)
    SStream_concat(ss, "0x%x", val);
  else
    SStream_concat(ss, "%u", val);
}

void printFloat(SStream *ss, float val)
{
  assert(ss);
  SSTREAM_RETURN_IF_CLOSED(ss);
  SStream_concat(ss, "%e", val);
}

void printfFloat(SStream *ss, const char *fmt, float val)
{
  assert(ss);
  SSTREAM_RETURN_IF_CLOSED(ss);
  SStream_concat(ss, fmt, val);
}

void printFloatBang(SStream *ss, float val)
{
  assert(ss);
  SSTREAM_RETURN_IF_CLOSED(ss);
  SStream_concat(ss, "#%e", val);
}

void printExpr(SStream *ss, uint64_t val)
{
  assert(ss);
  SSTREAM_RETURN_IF_CLOSED(ss);
  SStream_concat(ss, "%" PRIu64, val);
}

SStream *markup_OS(SStream *OS, SStreamMarkup style)
{
  assert(OS);

  if (OS->is_closed || !OS->markup_stream) {
    return OS;
  }
  OS->markup_stream = false; // Disable temporarily.
  switch (style) {
  default:
    SStream_concat0(OS, "<UNKNOWN:");
    return OS;
  case Markup_Immediate:
    SStream_concat0(OS, "<imm:");
    break;
  case Markup_Register:
    SStream_concat0(OS, "<reg:");
    break;
  case Markup_Target:
    SStream_concat0(OS, "<tar:");
    break;
  case Markup_Memory:
    SStream_concat0(OS, "<mem:");
    break;
  }
  OS->markup_stream = true;
  OS->prefixed_by_markup = true;
  return OS;
}

Coverage Report

Created: 2026-08-31 06:58

Line	Count	Source
1		/* Capstone Disassembly Engine */
2		/* By Nguyen Anh Quynh <aquynh@gmail.com>, 2013-2019 */
3
4		#include <stdarg.h>
5		#if defined(CAPSTONE_HAS_OSXKERNEL)
6		#include <Availability.h>
7		#include <libkern/libkern.h>
8		#include <i386/limits.h>
9		#else
10		#include <stdio.h>
11		#include <limits.h>
12		#endif
13		#include <string.h>
14
15		#include <capstone/platform.h>
16
17		#include "SStream.h"
18		#include "cs_priv.h"
19		#include "utils.h"
20
21		static size_t SStream_remaining(SStream *ss)
22	30.9M	{
23	30.9M	assert(ss);
24	30.9M	if (ss->index >= SSTREAM_BUF_LEN) {
25	0	ss->index = SSTREAM_BUF_LEN - 1;
26	0	ss->buffer[ss->index] = '\0';
27	0	return 0;
28	0	}
29	30.9M	return SSTREAM_BUF_LEN - ss->index - 1;
30	30.9M	}
31
32		static void SStream_concat_raw(SStream ss, const char s, size_t len)
33	17.2M	{
34	17.2M	size_t remaining = SStream_remaining(ss);
35	17.2M	if (len > remaining) {
36	0	len = remaining;
37	0	}
38	17.2M	if (len > 0) {
39	17.2M	memcpy(ss->buffer + ss->index, s, len);
40	17.2M	ss->index += len;
41	17.2M	}
42	17.2M	ss->buffer[ss->index] = '\0';
43	17.2M	}
44
45		static void SStream_concat1_raw(SStream *ss, char c)
46	2.64M	{
47	2.64M	if (SStream_remaining(ss) == 0) {
48	0	return;
49	0	}
50	2.64M	ss->buffer[ss->index] = c;
51	2.64M	ss->index++;
52	2.64M	ss->buffer[ss->index] = '\0';
53	2.64M	}
54
55		static void SStream_close_markup(SStream *ss)
56	30.9M	{
57	30.9M	if (ss->markup_stream && ss->prefixed_by_markup) {
58	0	SStream_concat1_raw(ss, '>');
59	0	}
60	30.9M	}
61
62		void SStream_Init(SStream *ss)
63	4.47M	{
64	4.47M	assert(ss);
65	4.47M	ss->index = 0;
66	4.47M	memset(ss->buffer, 0, sizeof(ss->buffer));
67	4.47M	ss->is_closed = false;
68	4.47M	ss->markup_stream = false;
69	4.47M	ss->prefixed_by_markup = false;
70	4.47M	ss->unsigned_num = false;
71	4.47M	}
72
73		void SStream_opt_unum(SStream *ss, bool print_unsigned_numbers)
74	4.32M	{
75	4.32M	assert(ss);
76	4.32M	ss->unsigned_num = print_unsigned_numbers;
77	4.32M	}
78
79		/// Returns the a pointer to the internal string buffer of the stream.
80		/// For reading only.
81		const char SStream_rbuf(const SStream ss)
82	198k	{
83	198k	assert(ss);
84	198k	return ss->buffer;
85	198k	}
86
87		/// Searches in the stream for the first (from the left) occurrence of @elem and replaces
88		/// it with @repl. It returns the pointer after the replaced character
89		/// or NULL if no character was replaced.
90		///
91		/// It will never replace the final \0 byte in the stream buffer.
92		const char SStream_replc(const SStream ss, char elem, char repl)
93	153k	{
94	153k	assert(ss);
95	153k	char *found = strchr(ss->buffer, elem);
96	153k	if (!found \|\| found == ss->buffer + (SSTREAM_BUF_LEN - 1)) {
97	153k	return NULL;
98	153k	}
99	0	*found = repl;
100	0	found++;
101	0	return found;
102	153k	}
103
104		/// Searches in the stream for the first (from the left) occurrence of @chr and replaces
105		/// it with @rstr.
106		void SStream_replc_str(SStream ss, char chr, const char rstr)
107	48.8k	{
108	48.8k	assert(ss && rstr);
109	48.8k	char *found = strchr(ss->buffer, chr);
110	48.8k	if (!found \|\| found == ss->buffer + (SSTREAM_BUF_LEN - 1)) {
111	0	return;
112	0	}
113	48.8k	size_t post_len = strlen(found + 1);
114	48.8k	size_t buf_str_len = strlen(ss->buffer);
115	48.8k	size_t repl_len = strlen(rstr);
116	48.8k	if (repl_len - 1 + buf_str_len >= SSTREAM_BUF_LEN) {
117	0	return;
118	0	}
119	48.8k	memmove(found + repl_len, found + 1, post_len);
120	48.8k	memcpy(found, rstr, repl_len);
121	48.8k	ss->index = strlen(ss->buffer);
122	48.8k	}
123
124		/// Removes the space characters '\t' and ' ' from the beginning of the stream buffer.
125		void SStream_trimls(SStream *ss)
126	4.47M	{
127	4.47M	assert(ss);
128	4.47M	size_t buf_off = 0;
129		/// Remove leading spaces
130	4.55M	while (ss->buffer[buf_off] == ' ' \|\| ss->buffer[buf_off] == '\t') {
131	71.7k	buf_off++;
132	71.7k	}
133	4.47M	if (buf_off > 0) {
134	71.7k	memmove(ss->buffer, ss->buffer + buf_off,
135	71.7k	SSTREAM_BUF_LEN - buf_off);
136	71.7k	ss->index -= buf_off;
137	71.7k	}
138	4.47M	}
139
140		/// Extract the mnemonic to @mnem_buf and the operand string into @op_str_buf from the stream buffer.
141		/// The mnemonic is everything up until the first ' ' or '\t' character.
142		/// The operand string is everything after the first ' ' or '\t' sequence.
143		void SStream_extract_mnem_opstr(const SStream ss, char mnem_buf,
144		size_t mnem_buf_size, char *op_str_buf,
145		size_t op_str_buf_size)
146	4.32M	{
147	4.32M	assert(ss && mnem_buf && mnem_buf_size > 0 && op_str_buf &&
148	4.32M	op_str_buf_size > 0);
149	4.32M	size_t off = 0;
150		// Copy all non space chars to as mnemonic.
151	24.0M	while (ss->buffer[off] && ss->buffer[off] != ' ' &&
152	22.9M	ss->buffer[off] != '\t') {
153	19.7M	if (off < mnem_buf_size - 1) {
154		// Only copy if there is space left.
155	19.7M	mnem_buf[off] = ss->buffer[off];
156	19.7M	}
157	19.7M	off++;
158	19.7M	}
159	4.32M	if (!ss->buffer[off]) {
160	186k	return;
161	186k	}
162
163		// Iterate until next non space char.
164	4.13M	do {
165	4.13M	off++;
166	4.13M	} while (ss->buffer[off] &&
167	4.07M	(ss->buffer[off] == ' ' \|\| ss->buffer[off] == '\t'));
168
169	4.13M	if (!ss->buffer[off]) {
170	62.5k	return;
171	62.5k	}
172
173		// Copy all follow up characters as op_str
174	4.07M	const char *ss_op_str = ss->buffer + off;
175	4.07M	off = 0;
176	57.6M	while (ss_op_str[off] && off < op_str_buf_size - 1) {
177	53.5M	op_str_buf[off] = ss_op_str[off];
178	53.5M	off++;
179	53.5M	}
180	4.07M	}
181
182		/// Empty the stream @ss to given @file (stdin/stderr).
183		/// @file can be NULL. Then the buffer content is not emitted.
184		void SStream_Flush(SStream ss, FILE file)
185	49.7k	{
186	49.7k	assert(ss);
187	49.7k	if (file) {
188	0	fprintf(file, "%s\n", ss->buffer);
189	0	}
190	49.7k	SStream_Init(ss);
191	49.7k	}
192
193		/**
194		* Open the output stream. Every write attempt is accepted again.
195		*/
196		void SStream_Open(SStream *ss)
197	0	{
198	0	assert(ss);
199	0	ss->is_closed = false;
200	0	}
201
202		/**
203		* Closes the output stream. Every write attempt is ignored.
204		*/
205		void SStream_Close(SStream *ss)
206	0	{
207	0	assert(ss);
208	0	ss->is_closed = true;
209	0	}
210
211		/**
212		* Copy the string \p s to the buffer of \p ss and terminate it with a '\\0' byte.
213		*/
214		void SStream_concat0(SStream ss, const char s)
215	24.7M	{
216	24.7M	#ifndef CAPSTONE_DIET
217	24.7M	assert(ss && s);
218	24.7M	SSTREAM_RETURN_IF_CLOSED(ss);
219	24.7M	if (s[0] == '\0')
220	7.53M	return;
221
222	17.2M	SStream_concat_raw(ss, s, strlen(s));
223	17.2M	SStream_close_markup(ss);
224		#else
225		ss->buffer[ss->index] = '\0';
226		#endif
227	17.2M	}
228
229		/**
230		* Copy the single char \p c to the buffer of \p ss.
231		*/
232		void SStream_concat1(SStream *ss, const char c)
233	2.67M	{
234	2.67M	#ifndef CAPSTONE_DIET
235	2.67M	assert(ss);
236	2.67M	SSTREAM_RETURN_IF_CLOSED(ss);
237	2.67M	if (c == '\0')
238	26.2k	return;
239
240	2.64M	SStream_concat1_raw(ss, c);
241	2.64M	SStream_close_markup(ss);
242		#else
243		ss->buffer[ss->index] = '\0';
244		#endif
245	2.64M	}
246
247		/**
248		* Copy all strings given to the buffer of \p ss according to formatting \p fmt.
249		*/
250		void SStream_concat(SStream ss, const char fmt, ...)
251	11.0M	{
252	11.0M	#ifndef CAPSTONE_DIET
253	11.0M	assert(ss && fmt);
254	11.0M	SSTREAM_RETURN_IF_CLOSED(ss);
255	11.0M	va_list ap;
256	11.0M	int ret;
257	11.0M	size_t remaining = SStream_remaining(ss);
258	11.0M	if (remaining == 0) {
259	0	return;
260	0	}
261
262	11.0M	va_start(ap, fmt);
263	11.0M	ret = cs_vsnprintf(ss->buffer + ss->index, remaining + 1, fmt, ap);
264	11.0M	va_end(ap);
265	11.0M	if (ret < 0) {
266	0	ss->buffer[ss->index] = '\0';
267	0	return;
268	0	}
269	11.0M	if ((size_t)ret > remaining) {
270	0	ss->index += remaining;
271	11.0M	} else {
272	11.0M	ss->index += (size_t)ret;
273	11.0M	}
274	11.0M	SStream_close_markup(ss);
275		#else
276		ss->buffer[ss->index] = '\0';
277		#endif
278	11.0M	}
279
280		// print number with prefix #
281		void printInt64Bang(SStream *ss, int64_t val)
282	94.3k	{
283	94.3k	assert(ss);
284	94.3k	if (ss->unsigned_num) {
285	0	printUInt64Bang(ss, val);
286	0	return;
287	0	}
288	94.3k	SSTREAM_RETURN_IF_CLOSED(ss);
289	94.3k	SStream_concat1(ss, '#');
290	94.3k	printInt64(ss, val);
291	94.3k	}
292
293		void printUInt64Bang(SStream *ss, uint64_t val)
294	14.1k	{
295	14.1k	assert(ss);
296	14.1k	SSTREAM_RETURN_IF_CLOSED(ss);
297	14.1k	SStream_concat1(ss, '#');
298	14.1k	printUInt64(ss, val);
299	14.1k	}
300
301		// print number
302		void printInt64(SStream *ss, int64_t val)
303	969k	{
304	969k	assert(ss);
305	969k	if (ss->unsigned_num) {
306	0	printUInt64(ss, val);
307	0	return;
308	0	}
309	969k	SSTREAM_RETURN_IF_CLOSED(ss);
310	969k	if (val >= 0) {
311	883k	if (val > HEX_THRESHOLD)
312	564k	SStream_concat(ss, "0x%" PRIx64, val);
313	319k	else
314	319k	SStream_concat(ss, "%" PRIu64, val);
315	883k	} else {
316	85.9k	if (val < -HEX_THRESHOLD) {
317	77.7k	if (val == INT64_MIN)
318	24	SStream_concat(ss, "-0x%" PRIx64,
319	24	(uint64_t)INT64_MAX + 1);
320	77.7k	else
321	77.7k	SStream_concat(ss, "-0x%" PRIx64,
322	77.7k	(uint64_t)-val);
323	77.7k	} else
324	8.20k	SStream_concat(ss, "-%" PRIu64, -val);
325	85.9k	}
326	969k	}
327
328		void printUInt64(SStream *ss, uint64_t val)
329	260k	{
330	260k	assert(ss);
331	260k	SSTREAM_RETURN_IF_CLOSED(ss);
332	260k	if (val > HEX_THRESHOLD)
333	185k	SStream_concat(ss, "0x%" PRIx64, val);
334	75.5k	else
335	75.5k	SStream_concat(ss, "%" PRIu64, val);
336	260k	}
337
338		// print number in decimal mode
339		void printInt32BangDec(SStream *ss, int32_t val)
340	0	{
341	0	assert(ss);
342	0	SSTREAM_RETURN_IF_CLOSED(ss);
343	0	if (val >= 0)
344	0	SStream_concat(ss, "#%" PRIu32, val);
345	0	else {
346	0	if (val == INT32_MIN)
347	0	SStream_concat(ss, "#-%" PRIu32, val);
348	0	else
349	0	SStream_concat(ss, "#-%" PRIu32, (uint32_t)-val);
350	0	}
351	0	}
352
353		void printInt32Bang(SStream *ss, int32_t val)
354	237k	{
355	237k	assert(ss);
356	237k	if (ss->unsigned_num) {
357	0	printUInt32Bang(ss, val);
358	0	return;
359	0	}
360	237k	SSTREAM_RETURN_IF_CLOSED(ss);
361	237k	SStream_concat1(ss, '#');
362	237k	printInt32(ss, val);
363	237k	}
364
365		void printUInt8(SStream *ss, uint8_t val)
366	0	{
367	0	assert(ss);
368	0	if (val > HEX_THRESHOLD)
369	0	SStream_concat(ss, "0x%" PRIx8, val);
370	0	else
371	0	SStream_concat(ss, "%" PRIu8, val);
372	0	}
373
374		void printUInt16(SStream *ss, uint16_t val)
375	0	{
376	0	assert(ss);
377	0	if (val > HEX_THRESHOLD)
378	0	SStream_concat(ss, "0x%" PRIx16, val);
379	0	else
380	0	SStream_concat(ss, "%" PRIu16, val);
381	0	}
382
383		void printInt8(SStream *ss, int8_t val)
384	2.05k	{
385	2.05k	assert(ss);
386	2.05k	if (ss->unsigned_num) {
387	0	printUInt8(ss, val);
388	0	return;
389	0	}
390	2.05k	SSTREAM_RETURN_IF_CLOSED(ss);
391	2.05k	if (val >= 0) {
392	1.11k	if (val > HEX_THRESHOLD)
393	593	SStream_concat(ss, "0x%" PRIx8, val);
394	517	else
395	517	SStream_concat(ss, "%" PRId8, val);
396	1.11k	} else {
397	945	if (val < -HEX_THRESHOLD) {
398	859	if (val == INT8_MIN)
399	297	SStream_concat(ss, "-0x%" PRIx8,
400	297	(uint8_t)INT8_MAX + 1);
401	562	else
402	562	SStream_concat(ss, "-0x%" PRIx8, (int8_t)-val);
403	859	} else
404	86	SStream_concat(ss, "-%" PRIu8, -val);
405	945	}
406	2.05k	}
407
408		void printInt16(SStream *ss, int16_t val)
409	3.37k	{
410	3.37k	assert(ss);
411	3.37k	if (ss->unsigned_num) {
412	0	printUInt16(ss, val);
413	0	return;
414	0	}
415	3.37k	SSTREAM_RETURN_IF_CLOSED(ss);
416	3.37k	if (val >= 0) {
417	2.27k	if (val > HEX_THRESHOLD)
418	1.68k	SStream_concat(ss, "0x%" PRIx16, val);
419	586	else
420	586	SStream_concat(ss, "%" PRId16, val);
421	2.27k	} else {
422	1.10k	if (val < -HEX_THRESHOLD) {
423	1.01k	if (val == INT16_MIN)
424	116	SStream_concat(ss, "-0x%" PRIx16,
425	116	(uint16_t)INT16_MAX + 1);
426	897	else
427	897	SStream_concat(ss, "-0x%" PRIx16,
428	897	(int16_t)-val);
429	1.01k	} else
430	88	SStream_concat(ss, "-%" PRIu16, -val);
431	1.10k	}
432	3.37k	}
433
434		void printInt16HexOffset(SStream *ss, int16_t val)
435	7.14k	{
436	7.14k	assert(ss);
437	7.14k	if (ss->unsigned_num) {
438	0	printUInt16(ss, val);
439	0	return;
440	0	}
441	7.14k	SSTREAM_RETURN_IF_CLOSED(ss);
442	7.14k	if (val >= 0) {
443	4.86k	SStream_concat(ss, "+0x%" PRIx16, val);
444	4.86k	} else {
445	2.27k	if (val == INT16_MIN)
446	70	SStream_concat(ss, "-0x%" PRIx16,
447	70	(uint16_t)INT16_MAX + 1);
448	2.20k	else
449	2.20k	SStream_concat(ss, "-0x%" PRIx16, (int16_t)-val);
450	2.27k	}
451	7.14k	}
452
453		void printInt32(SStream *ss, int32_t val)
454	329k	{
455	329k	assert(ss);
456	329k	if (ss->unsigned_num) {
457	0	printUInt32(ss, val);
458	0	return;
459	0	}
460	329k	SSTREAM_RETURN_IF_CLOSED(ss);
461	329k	if (val >= 0) {
462	249k	if (val > HEX_THRESHOLD)
463	153k	SStream_concat(ss, "0x%" PRIx32, val);
464	96.5k	else
465	96.5k	SStream_concat(ss, "%" PRId32, val);
466	249k	} else {
467	79.3k	if (val < -HEX_THRESHOLD) {
468	75.1k	if (val == INT32_MIN)
469	87	SStream_concat(ss, "-0x%" PRIx32,
470	87	(uint32_t)INT32_MAX + 1);
471	75.0k	else
472	75.0k	SStream_concat(ss, "-0x%" PRIx32,
473	75.0k	(int32_t)-val);
474	75.1k	} else {
475	4.24k	SStream_concat(ss, "-%" PRIu32, (uint32_t)-val);
476	4.24k	}
477	79.3k	}
478	329k	}
479
480		void printInt32HexOffset(SStream *ss, int32_t val)
481	1.01k	{
482	1.01k	assert(ss);
483	1.01k	if (ss->unsigned_num) {
484	0	printUInt32(ss, val);
485	0	return;
486	0	}
487	1.01k	SSTREAM_RETURN_IF_CLOSED(ss);
488	1.01k	if (val >= 0) {
489	800	SStream_concat(ss, "+0x%" PRIx32, val);
490	800	} else {
491	218	if (val == INT32_MIN)
492	48	SStream_concat(ss, "-0x%" PRIx32,
493	48	(uint32_t)INT32_MAX + 1);
494	170	else
495	170	SStream_concat(ss, "-0x%" PRIx32, (int32_t)-val);
496	218	}
497	1.01k	}
498
499		void printInt32Hex(SStream *ss, int32_t val)
500	5.04k	{
501	5.04k	assert(ss);
502	5.04k	SSTREAM_RETURN_IF_CLOSED(ss);
503	5.04k	if (val >= 0) {
504	2.60k	SStream_concat(ss, "0x%" PRIx32, val);
505	2.60k	} else {
506	2.44k	if (val == INT32_MIN)
507	12	SStream_concat(ss, "-0x%" PRIx32,
508	12	(uint32_t)INT32_MAX + 1);
509	2.42k	else
510	2.42k	SStream_concat(ss, "-0x%" PRIx32, (int32_t)-val);
511	2.44k	}
512	5.04k	}
513
514		void printUInt32Bang(SStream *ss, uint32_t val)
515	282k	{
516	282k	assert(ss);
517	282k	SSTREAM_RETURN_IF_CLOSED(ss);
518	282k	SStream_concat1(ss, '#');
519	282k	printUInt32(ss, val);
520	282k	}
521
522		void printUInt32(SStream *ss, uint32_t val)
523	404k	{
524	404k	assert(ss);
525	404k	SSTREAM_RETURN_IF_CLOSED(ss);
526	404k	if (val > HEX_THRESHOLD)
527	312k	SStream_concat(ss, "0x%x", val);
528	92.5k	else
529	92.5k	SStream_concat(ss, "%u", val);
530	404k	}
531
532		void printFloat(SStream *ss, float val)
533	0	{
534	0	assert(ss);
535	0	SSTREAM_RETURN_IF_CLOSED(ss);
536	0	SStream_concat(ss, "%e", val);
537	0	}
538
539		void printfFloat(SStream ss, const char fmt, float val)
540	407	{
541	407	assert(ss);
542	407	SSTREAM_RETURN_IF_CLOSED(ss);
543	407	SStream_concat(ss, fmt, val);
544	407	}
545
546		void printFloatBang(SStream *ss, float val)
547	778	{
548	778	assert(ss);
549	778	SSTREAM_RETURN_IF_CLOSED(ss);
550	778	SStream_concat(ss, "#%e", val);
551	778	}
552
553		void printExpr(SStream *ss, uint64_t val)
554	0	{
555	0	assert(ss);
556	0	SSTREAM_RETURN_IF_CLOSED(ss);
557	0	SStream_concat(ss, "%" PRIu64, val);
558	0	}
559
560		SStream markup_OS(SStream OS, SStreamMarkup style)
561	872k	{
562	872k	assert(OS);
563
564	872k	if (OS->is_closed \|\| !OS->markup_stream) {
565	872k	return OS;
566	872k	}
567	0	OS->markup_stream = false; // Disable temporarily.
568	0	switch (style) {
569	0	default:
570	0	SStream_concat0(OS, "<UNKNOWN:");
571	0	return OS;
572	0	case Markup_Immediate:
573	0	SStream_concat0(OS, "<imm:");
574	0	break;
575	0	case Markup_Register:
576	0	SStream_concat0(OS, "<reg:");
577	0	break;
578	0	case Markup_Target:
579	0	SStream_concat0(OS, "<tar:");
580	0	break;
581	0	case Markup_Memory:
582	0	SStream_concat0(OS, "<mem:");
583	0	break;
584	0	}
585	0	OS->markup_stream = true;
586		OS->prefixed_by_markup = true;
587	0	return OS;
588	0	}