C语言的out_ptr和inout_ptr如何同时处理输入输出?
摘要:c++23新增了一些智能指针适配器,用来扩展和简化智能指针的使用。 这次主要介绍的是std::out_ptr和std::inout_ptr。这两个适配器用法和实现都很简单,但网上的文档都比较抱歉,还缺少一
c++23新增了一些智能指针适配器,用来扩展和简化智能指针的使用。
这次主要介绍的是std::out_ptr和std::inout_ptr。这两个适配器用法和实现都很简单,但网上的文档都比较抱歉,还缺少一些比较重要的部分,因此单开一篇文章记录一下。
out_ptr
首先从功能最简单的out_ptr讲起。
std::out_ptr其实是一个函数,返回一个类型为std::out_ptr_t的智能指针适配器,函数签名如下:
#include <memory>
template< class Pointer = void, class Smart, class... Args >
auto out_ptr( Smart& s, Args&&... args );
这个函数主要是把各种智能指针包装成output parameter,以方便现有的接口使用,尤其是一些用c语言写的函数。
在继续之前我们先来复习一下output parameter是什么。这东西又叫传出参数,一次就是函数会把一部分数据写进自己的参数里返回给调用者。
通过参数返回是因为c语言和c++11之前的c++不支持多值返回也没有类似tuple这样方便的数据结构,导致函数无法直接返回两个以上的值,所以需要用一种额外的传递数据的方式。
比如我在以前的博客中提到的hsearch:int hsearch_r(ENTRY item, ACTION action, ENTRY **retval, struct hsearch_data *htab)。这个函数用来在哈希表里创建或者查找数据,查找失败的时候会返回错误码,而查找成功的时候函数返回0并把找到的数据设置给retval。这个retval就是output parameter,承载了函数除了错误码之外的返回数据。
c++里现在很少用指针类型作为output parameter了,但还有更本地化的做法——引用:int func(const char *name, Data &retval)。
这类函数有几个特点:
不在乎output parameter里有什么值
函数调用期间完全享有output parameter和其资源的所有权
函数返回后output parameter通常被设置为新值
在c++提倡少用裸指针的今天,我们越来越习惯使用shared_ptr和unique_ptr,但不管哪种智能指针都很难直接适配上面这些函数,看个例子就明白了:
int get_data(const std::string &name, Data **retval)
{
if (!check_name(name)) {
return ErrCheckFailed;
}
*retval = make_data(name);
return 0;
}
// 使用裸指针
Data *data_ptr = nullptr;
if (auto err = get_data("name", &data_ptr); err != 0) {
错误处理
} else {
这里可以使用data_ptr
}
使用裸指针的时候代码比较简单,我们再来看看使用智能指针的时候:
std::unique_ptr<Data> resource;
Data *data_ptr = nullptr;
if (auto err = get_data("name", &data_ptr); err != 0) {
错误处理
} else {
resource.reset(data_ptr);
这里可以使用resource
}
代码会变得啰嗦,而且如果我们忘记了调用reset,那么资源就可能泄漏了;还有最重要的一点,我们主动使用了裸指针,而这正是我们想避免的。
这时候就需要out_ptr了。out_ptr生成的适配器会先放弃智能指针持有资源的所有权并将旧资源释放,因为如前面所说我们要调用的函数会接管资源的所有权,接着构造出的std::out_ptr_t有自动的类型转换方法,可以把智能指针转换成我们需要的T**交给函数使用,最后在函数调用结束之后再把新的资源设置回智能指针。
