Концепция скрытого друга в C++

Есть ли недостаток? Да, в приведенном выше примере С++ применяет разные правила к двум аргументам оператора +. В частности, левый аргумент должен быть объектом типа MyDistance, но правый аргумент может быть любым типом, преобразуемым в MyDistance.

Немного расширив свой пример

class MyDistance{
  public:
    ...
    MyDistance(int dist) { ... }

    MyDistance operator+(const MyDistance& other) const {
        return MyDistance(m + other.m);
    }
    ...
};

С этим кодом

MyDistance x(1);
MyDistance y = x + 2;

законно, потому что есть преобразование из int в MyDistance, но это незаконно

MyDistance x(1);
MyDistance y = 2 + x;

потому что, учитывая объявление над левой частью +, должно быть MyDistance объектом.

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

Мы ожидаем, что operator+ будет симметричным, поэтому дружественная версия лучше, потому что она применяет одни и те же правила к обоим аргументам.

Скрытые друзья — твой друг

Дэн Сакс выступил с отличным докладом о скрытых друзьях на CppCon2018. Он называется Новые друзья.

В дополнение к проблемам, описанным @john, шаблоны являются еще одной серьезной причиной для освоения идиомы «скрытых друзей».

Операторы вставки и извлечения потока operator<< и operator>> лучше всего писать в терминах std::basic_ostream и std::basic_istream, шаблонов, на которых основаны std::ostream и std::istream. Написанные таким образом, операторы будут работать с любым типом символов.

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

Предположим, например, что вы решили добавить параметр шаблона в класс MyDistance. Если operator<< не является скрытым другом, код может выглядеть следующим образом. Этот operator<< находится вне класса MyDistance и может быть найден без ADL.

Это полная программа (она работает):

#include <iostream>
#include <type_traits>

template< typename NumType >
class MyDistance {
    static_assert(std::is_arithmetic_v<NumType>, "");
public:
    explicit MyDistance(NumType i) :m(i) {}

    // ...

    // This is a declaration that says, in essence, "In the 
    // scope outside this class, there is visible a definition 
    // for the templated operator<< declared here, and that 
    // operator function template is my friend." 
    // 
    // Although it is a friend, it is not hidden.
    //
    // operator<< requires three template parameters.
    // Parameter NumType2 is distinct from NumType.
    template< typename charT, typename traits, typename NumType2 >
    friend auto operator<<
        (std::basic_ostream<charT, traits>& out, 
            const MyDistance<NumType2>& myDist)
        ->std::basic_ostream<charT, traits>&;

private:
    NumType m;
};

// operator<< is not hidden, because it is defined outside
// of class MyDistance, and it is therefore visible in the 
// scope outside class MyDistance. It can be found without ADL.
//
// Here we can use NumType, NumType2, T, or anything else 
// as the third template parameter. It's just a name.
template< typename charT, typename traits, typename NumType >
auto operator<<
(std::basic_ostream<charT, traits>& out, 
    const MyDistance<NumType>& myDist)
-> std::basic_ostream<charT, traits>&
{
    out << myDist.m << " m";
    return out;
}

int main()
{
    MyDistance<int> md_int{ 42 };
    MyDistance<double> md_double{ 3.14 };
    std::cout 
        << "MyDistance<int>    : " << md_int << '\n' 
        << "MyDistance<double> : " << md_double << '\n';
    return 0;
}

Когда код написан как скрытый друг, он становится чище и лаконичнее. Этот operator<< не виден в области вне класса MyDistance, и его можно найти только с помощью ADL.

Это также полная программа:

#include <iostream>
#include <type_traits>

template< typename NumType >
class MyDistance {
    static_assert(std::is_arithmetic_v<NumType>, "");
public:
    explicit MyDistance(NumType i) :m(i) {}

    // ...

    // operator<< has only the two template parameters 
    // required by std::basic_ostream. It is only visible 
    // within class MyDistance, so it is "hidden." 
    //
    // You cannot scope to it either, using the scope resolution 
    // operator(::), because it is not a member of the class!
    // 
    // It is truly hidden, and can only be found with ADL.
    template< typename charT, typename traits>
    friend auto operator<<
        (std::basic_ostream<charT, traits>& out,
            const MyDistance& myDist)
        ->std::basic_ostream<charT, traits>&
    {
        out << myDist.m << " m";
        return out;
    }

private:
    NumType m;
};

int main()
{
    MyDistance<int> md_int{ 42 };
    MyDistance<double> md_double{ 3.14 };
    std::cout
        << "MyDistance<int>    : " << md_int << '\n'
        << "MyDistance<double> : " << md_double << '\n';
    return 0;
}

Теперь представьте, что MyDistance — это более сложный объект с множеством шаблонных параметров, некоторые из которых сами могут быть шаблонными.

Несколько лет назад я создал класс RomanNumeral<IntType> для выполнения арифметических операций с римскими цифрами. Я также написал класс Rational<IntType> для выполнения арифметических действий с рациональными числами, где числитель и знаменатель хранились отдельно. Затем мне пришла в голову блестящая идея разрешить построение рациональных чисел с помощью римских цифр! Но я также хотел, чтобы класс Rational продолжал работать с целыми числами. Какой беспорядок! Потребовалась настоящая забота о том, чтобы операторы потока работали так, чтобы они выводили такие вещи, как: xiii/c.

Это отличное упражнение. Одна из вещей, которую вы узнаете, если попробуете, заключается в том, что скрытые друзья — ваши друзья!