编写高质量C语言代码－－API设计

        首先我们先来看一个程序：

char* strdup(char* str)
{
	char* strNew;
	
	strNew = (char*)malloc(strlen(str) + 1);
	strcpy(strNew, str);
	return(strNew);
}

上面这个程序会发生什么情况？如果malloc失败，strNew为NULL，oh, no！这个malloc也太难用了吧，老是忘记要判断返回值是否为NULL。没错，但这不是你的错，是malloc的错。为什么malloc函数返回值既可能是新分配的地址，又可能是NULL，即表示malloc出错呢？如果malloc函数改成如下：

bool malloc(void* ptr, size_t size);

ptr为指向新分配内存的指针，size为新分配内存的大小，返回值为malloc成功与否。若是这样的malloc，你会用错吗？

         还记得那万恶的getchar函数吗？对，它的原型是：

int getchar();

为什么是int，而不是char呢？坑爹呢？有木有！有木有啊！无数次错误的用成：

char c;

c = getchar();
if(c == EOF)
	...

要是有更好的函数，鬼才愿意用这个函数！若是这样的原型：

bool getchar(char* c);

整个世界和谐了。 Don't mix error and other special-purpose values into your outputs of interfaces.

         这不是最坑爹的，且看下面的BOSS级函数：

void* realloc(void* pv, size_t size);

在C library manual中有这样几句话（译）：

1   如果pv为NULL， size不为0，则此函数相当于malloc(size);

2   如果size为0， pv不为NULL， 则此函数相当于free();

3   如果pv为NULL，size为0，则未定义。

这怎么回事？这明明是realloc函数啊，怎么又出来malloc和free函数了。如果realloc能完成malloc和free函数的功能，后面两个函数累赘了吧？还有，如果realloc失败，realloc返回的将是NULL。这又在坑爹啊，我多么想这么用啊：

ptr = realloc(ptr, newSize);

发现ptr为NULL，不是吧，内存泄露了（ptr如果是ptr所指内存的唯一取的方法，那么您将永远失去您对那块内存的控制）。

          如果realloc不是这样的万能，我们的生活会不会更和谐？Don't write multipurpose functions. Remember K.I.S.S..

 

          当然，作为一般性的考试题，总会有附加题的，请看题：

fseek(fpDocument, offset, 1);

这不是将fpDocument文件指针定位嘛，有问题？请问，定位在哪？等等，我得去看下fseek函数的说明。。。。N分钟过后。。。。

靠，如果是这样：

fseek(fpDocument, offset, SEEK_CUR);

有需要去查fseek函数的说明吗？万恶的bool型参数请参见博文。Don't use magic numbers and boolean arguments.

 

        小结：良好的API设计将是您编写bug_free代码的福音，请投入她的怀抱，感受她带来的好处吧~