C++ Primer中Sales_item.h代码解析

<pre name="code" class="plain"><strong><span style="font-size:14px;"><strong>#ifndef SALESITEM_H              
// 若SALESITEM_H未被定义，则对其进行定义；
#define SALESITEM_H
// 自定义头文件Version_test；
#include "Version_test.h" 

//Sales_item类定义的相关函数
#include <iostream>
#include <string>

class Sales_item {
/*定义为友元函数，重载输入运算符>>；
**第1个形参：运算符将要读取的流的引用；第2个形参：将要读入到的对象的引用；
**第2个形参必须是非常量，因为本操作就是向此对象写入数据，此对象值会改变；
*/
friend std::istream& operator>>(std::istream&, Sales_item&);

/*定义为友元函数，重载输出运算符<<；
**第1个形参：非常量ostream对象的引用；第2个形参：一个常量的引用；
**第1个形参必须是非常量，因为本操作就是向流写入数据，其状态会改变；
**第2个形参：引用是因为避免赋值实参；常量是因为通常打印对象不会改变对象本身的值；
*/
friend std::ostream& operator<<(std::ostream&, const Sales_item&);

/*定义为友元函数，重载关系运算符<；
**第1个/第2个形参：一个常量的引用；
**引用是因为避免改变实参；常量是因为比较对象并不需要改变对象本身的值；
*/
friend bool operator<(const Sales_item&, const Sales_item&);

/*定义为友元函数，重载相等运算符==；
**定义两个对象是否相等，会比较对象的每一个数据成员，只有对应成员均相等时才相等；
**第1个/第2个形参：一个常量的引用；
**引用是因为避免改变实参；常量是因为比较对象并不需要改变对象本身的值；
*/
friend bool operator==(const Sales_item&, const Sales_item&);

//定义公共成员
public:
/*这种传递中的代码使用以下变量来控制编译；
**变量：IN_CLASS_INITS/DEFAULT_FCNS；对应C++作用：类初始状态设置/default(默认)；
*/
#if defined(IN_CLASS_INITS) && defined(DEFAULT_FCNS)
//若定义类初始值设置及默认值，则定义默认构造函数,不接受任何实参；
    Sales_item() = default;
#else
/*若未定义类初始值及默认值，则定义构造函数，函数体空；
**构造函数初始列表为新创建的数据成员units_sold/revenue初始化，对应初始化值为0/0.0；
*/
    Sales_item(): units_sold(0), revenue(0.0) { }
#endif
/*只有一个string类型参数的构造函数,函数体空；
**构造函数使用这个string对象初始化bookNo，units_sold/revenue使用类内初始值初始化；
*/
    Sales_item(const std::string &book):
              bookNo(book), units_sold(0), revenue(0.0) { }
/*一个istream为参数的构造函数,函数体空；
**函数体：从is中读取一条交易信息后存入this对象中；
*/
    Sales_item(std::istream &is) { is >> *this; }
public:
/* 重载运算符+=，用于对象之间的累加运算；
** 成员二元操作：左侧操作必然隐含的this指针
*/
    Sales_item& operator+=(const Sales_item&);
    
/*常成员函数，表示只能由常成员对象访问；
**对Sales_item对象进行操作，返回bookNo；
*/
    std::string isbn() const { return bookNo; }
    double avg_price() const;
// 私有成员
private:
//隐式初始化为空字符串
    std::string bookNo;  
//IN_CLASS_INITS：类初始状态设置；
#ifdef IN_CLASS_INITS
//显式初始化；
    unsigned units_sold = 0; 
    double revenue = 0.0;
#else
//定义变量；
    unsigned units_sold;  
    double revenue;       
#endif
};

/* 二元谓词（有两个参数）；
**一个可调用的表达式，返回结果是一个能用作条件的值。
**用于比较对象.isbn是否相等，相等返回布尔值true，否则false；
*/
inline bool compareIsbn(const Sales_item &lhs, const Sales_item &rhs) 
{ return lhs.isbn() == rhs.isbn(); }

// 非成员二元操作：必须声明每个操作数的参数；
Sales_item operator+(const Sales_item&, const Sales_item&);

/* 二元谓词（有两个参数）；内联；
**一个可调用的表达式，返回结果是一个能用作条件的值。
****定义==，用于对象相等；
*/
inline bool operator==(const Sales_item &lhs, const Sales_item &rhs)
{
    // must be made a friend of Sales_item
    return lhs.units_sold == rhs.units_sold &&
           lhs.revenue == rhs.revenue &&
           lhs.isbn() == rhs.isbn();
}

/* 二元谓词（有两个参数）；内联；
**一个可调用的表达式，返回结果是一个能用作条件的值。
**定义!=，用于对象不相等；与==相反；
*/
inline bool operator!=(const Sales_item &lhs, const Sales_item &rhs)
{
    return !(lhs == rhs); 
}

// 假定两个对象指的是具有相同的ISBN，重载函数定义+=，用于对象+=；
Sales_item& Sales_item::operator+=(const Sales_item& rhs) 
{
    units_sold += rhs.units_sold; 
    revenue += rhs.revenue; 
    return *this;
}

//假定两个对象指的是具有相同的ISBN，重载函数定义定义+，用于对象+；
Sales_item operator+(const Sales_item& lhs, const Sales_item& rhs) 
{
    Sales_item ret(lhs);  
    ret += rhs;         
    return ret;           
}
//定义输入流>>，用于对象输入；
std::istream& operator>>(std::istream& in, Sales_item& s)
{
    double price;
    in >> s.bookNo >> s.units_sold >> price;
    // check that the inputs succeeded
    if (in)
        s.revenue = s.units_sold * price;
    else 
        s = Sales_item();  // input failed: reset object to default state
    return in;
}
//定义输出流<<，用于对象输出；
std::ostream& operator<<(std::ostream& out, const Sales_item& s)
{
    out << s.isbn() << " " << s.units_sold << " "
        << s.revenue << " " << s.avg_price();
    return out;
}
//定义函数avg_price；
double Sales_item::avg_price() const
{
    if (units_sold) 
        return revenue/units_sold; 
    else 
        return 0;
}
#endif
</strong>
</span></strong>