4

所以,我是一个尝试学习 C 的 C# 人。作为第一个(个人)项目,我正在尝试编写一个基本的坐标几何库。

问题:在后台堆上分配内存,而不是让针对库的程序员来做这件事,这又是最佳 C 编程实践吗?

例如,我的“点”结构和相关方法:

点.h

/* A basic point type. */
typedef struct point
{
    float x;
    float y;
    float z;
    char *note;
}point;

/* Initializes a basic point type. [Free with free_point method] */
point *create_point(float pos_x, float pos_y, float pos_z, char *_note);
/* Frees a point type. */
void free_point(point *_point);
/* Finds the midpoint between two points. */
point *midpoint(point *pt1, point *pt2);

点.c

#include "point.h"

/* Initializes a basic point type. [Free with free_point method] */
point *create_point(float pos_x, float pos_y, float pos_z, char *_note)
{
    point *p;
    size_t notelen = strlen(_note);

    p = (point*)malloc(sizeof(point));
    p->x = pos_x;
    p->y = pos_y;
    p->z = pos_z;

    p->note = (char*)calloc(notelen + 1, sizeof(char));
    strcpy_s(p->note, notelen + 1, _note);

    return p;

}
/* Frees a point type. */
void free_point(point *_point)
{
    free (_point->note);
    free (_point);
}

/* Creates a midpoint between two points. */
point *midpoint(point *pt1, point *pt2)
{
    float mid_x = (pt1->x + pt2->x) * 0.5f;
    float mid_y = (pt1->y + pt2->y) * 0.5f;
    float mid_z = (pt1->z + pt2->z) * 0.5f;

    point *p = create_point(mid_x, mid_y, mid_z, "Midpoint");
    return p;
}

请注意,我通过 create_point() 方法在堆上为任何实现/使用我的 lib 的人创建了 struct 'point'(老实说,这个项目只是为了我和学习,不过......)。这是不好的做法吗?感觉就像我在强迫用户以某种方式编程。midpoint() 方法也是如此。同样,您必须使用指向“点”结构的指针。

我无法在 SO 上找到有关 C 库设计的确切问题,但如果适用,请指出正确的方向。

谢谢。

4

2 回答 2

6

这是偏好,真的。我通常同意让用户按照他们的意愿为对象分配内存,然后为他们初始化成员。

/* here a non-zero return value might indicate if for example
 * we failed to allocate memory for note */
int point_init(struct point* p, int x, int y, char* note)
{
  /* ... */
}

/* usage: */
struct point p;
if (point_init(&p, 1, 2, "hello")) {
  /* error */
}

这使用户可以选择执行诸如分配内存中相邻的点数组之类的操作,而不是跟踪指向点的指针数组:

struct point mypoints[NUM_POINTS];

for(size_t i = 0; i < NUM_POINTS; ++i) {
  point_init(&mypoints[i], ...);
}

编辑:

如果您想使用不透明指针策略向库用户隐藏结构的成员,则需要使用您描述的方法为它们分配内存。这对于在库中分配结构无疑是一个巨大的好处。

于 2012-04-09T18:47:31.757 回答
3

最佳实践是以程序员可以最快的方式编写库的方式,因为这是 C 的强项。例如,程序员可能知道将需要成千上万个这样的点结构,并且为了将未来的访问保持在本地可能更愿意将所有结构分配在一块内存中。如果您的库允许程序员将指针传递给要初始化的结构,那么他可以这样做。但是如果你坚持给他分配内存,他就不行。

于 2012-04-09T18:49:53.010 回答