Функции, возвращающие строки, хороший стиль?

В моих программах на C мне часто нужен способ сделать строковое представление моих ADT. Даже если мне не нужно выводить строку на экран каким-либо образом, очень неплохо иметь такой метод для отладки. Так что такая функция часто появляется.

char * mytype_to_string( const mytype_t *t );

На самом деле я понимаю, что у меня есть (по крайней мере) три варианта обработки памяти для возвращаемой строки.

Альтернатива 1: сохранение возвращаемой строки в массиве статических символов в функции. Мне не нужно много думать, за исключением того, что строка перезаписывается при каждом вызове. Что может быть проблемой в некоторых случаях.

Альтернатива 2: выделите строку в куче с помощью malloc внутри функции. Действительно аккуратный, так как мне не нужно думать о размере буфера или перезаписи. Тем не менее, я должен помнить free () строку после завершения, а затем мне также нужно назначить временную переменную, чтобы я мог освободить. и тогда выделение кучи действительно намного медленнее, чем выделение стека, поэтому будьте узким местом, если это повторяется в цикле.

Альтернатива 3: передать указатель на буфер и позволить вызывающей стороне выделить этот буфер. Подобно:

char * mytype_to_string( const mytype_t *mt, char *buf, size_t buflen ); 

Это приносит больше усилий звонящему. Я также заметил, что эта альтернатива дает мне другой вариант порядка аргументов. Какой аргумент я должен иметь первым и последним? (на самом деле шесть возможностей)

Итак, что я должен предпочесть? Есть почему? Есть ли какой-то неписаный стандарт среди разработчиков C?

Методы, которые я видел больше всего, это 2 и 3.

Пользовательский буфер довольно прост в использовании:

char[128] buffer;
mytype_to_string(mt, buffer, 128);

Хотя большинство реализаций будет возвращать количество используемого буфера.

Вариант 2 будет медленнее и опасен при использовании динамически связанных библиотек, где они могут использовать разные среды выполнения (и разные кучи). Таким образом, вы не можете освободить то, что было размещено в другой библиотеке. Это тогда требует free_string(char*)функции, чтобы иметь дело с этим.

Дополнительная идея дизайна для # 3

По возможности также mytypeукажите максимальный размер, необходимый для того же файла .h, что и mytype_to_string().

#define MYTYPE_TO_STRING_SIZE 256

Теперь пользователь может кодировать соответственно.

char buf[MYTYPE_TO_STRING_SIZE];
puts(mytype_to_string(mt, buf, sizeof buf));

порядок

Размер массивов, когда он первый, позволяет использовать типы VLA.

char * mytype_to_string( const mytype_t *mt, size_t bufsize, char *buf[bufsize]); 

Не так важно с одним измерением, но полезно с 2 или более.

void matrix(size_t row, size_t col, double matrix[row][col]);

Я вспоминаю, что чтение следующего размера является предпочтительной идиомой в следующем C. Нужно найти эту ссылку ....

В дополнение к отличному ответу @ ratchetfreak, я хотел бы отметить, что альтернатива № 3 следует той же парадигме / шаблону, что и стандартные функции библиотеки C.

Например, strncpy.

char * strncpy ( char * destination, const char * source, size_t num );

Следование той же парадигме поможет снизить когнитивную нагрузку для новых разработчиков (или даже для вашего будущего Я), когда им нужно использовать вашу функцию.

Единственная разница с тем, что у вас есть в посте, состоит в том, что destinationаргумент в библиотеках C, как правило, указывается первым в списке аргументов. Так:

char * mytype_to_string( char *buf, const mytype_t *mt, size_t buflen ); 

Помимо того, что то, что вы предлагаете сделать, является неприятным запахом кода, альтернатива 3 звучит лучше для меня. Я также думаю, как @ gnasher729, что вы используете не тот язык.

Если честно, вы можете переключиться на другой язык, где возврат строки не является сложной, трудоемкой и подверженной ошибкам операцией.

Вы можете рассмотреть C ++ или Objective-C, где вы можете оставить 99% своего кода без изменений.