Модули C++20 и идиома PIMPL

Вопрос или проблема

Ответ или решение

Использование идиомы PIMPL с модулями C++20

Вопрос, который вы подняли, касается одновременно идиомы PIMPL (Pointer to Implementation) и новых возможностей, предоставляемых модулями C++20. Это сочетание может создавать определенные проблемы, особенно когда вы хотите скрыть детали реализации от конечных пользователей библиотеки, используя внешнюю библиотеку.

Проблемы и решения:

1. Неверное название файла InternalPartition.ixx:
   Данное сообщение об ошибке возникает потому, что модуль, объявленный в этом файле, не является интерфейсом. В C++20 расширение .ixx предназначено для интерфейсных модулей, которые используют ключевое слово export. Для внутренних модулей используйте другое расширение, например, .cpp для файлов реализации.

   Решение: Переименуйте файл InternalPartition.ixx в InternalPartition.cpp, если это действительно модуль реализации.

2. Ошибка "использование неопределенного типа ‘lib::Internal’":
   Эта ошибка указывает на то, что класс Internal, определенный в интерфейсе модуля, недоступен в реализации. В C++20, если вы импортируете модуль, вам нужно быть уверенным, что типы, которые вы хотите использовать, действительно доступны в области видимости.

   Решение: Убедитесь, что вы правильно импортируете InternalPartition в MyLibrary.cpp и используете соответствующую директиву import. Вместо этого можно использовать:

   import MyLibrary:InternalPartition; // убедитесь, что вы импортируете правильно

   Также не забудьте, что класс после определения в интерфейсном модуле должен быть доступен в реализации.

3. Ошибка CMake о "частном источнике":
   Данная ошибка говорит о том, что вы пытаетесь импортировать модуль, который был определен как частный. Это происходит, если вы пытаетесь импортировать InternalPartition в интерфейсный модуль или в публичный контекст.

   Решение: Убедитесь, что InternalPartition не является доступным в публичной декларации. Сам концепт PIMPL означает, что реализация скрыта, и это должно справляться с ошибками компиляции. Если InternalPartition действительно должен быть приватным, оставьте его только в реализации, а сам интерфейс должен предоставлять только то, что нужно пользователям.

4. Ошибки с использованием InternalPartition.cpp:
   Если вы хотите избавиться от внутреннего модуля и писать module MyLibrary; в InternalPartition.cpp, необходимо убедиться, что все необходимые декларации о классе Internal доступны в MyLibrary.ixx. Если класс Internal не объявлен в MyLibrary.ixx, компилятор не сможет его идентифицировать.

   Решение: Возможно, имеет смысл оставить InternalPartition внутренним, но не управлять его объявлением в интерфейсе. Другими словами, используйте Forward Declaration в MyLibrary.ixx и убедитесь, что его реализация полностью закрыта.

Пример реализации

Для лучшего понимания, вот простой пример реализации с использованием PIMPL и C++20 модулей:

MyLibrary.ixx:

export module MyLibrary;

class Internal; // Forward declaration

export class MyLibrary {
public:
    MyLibrary();
    ~MyLibrary();

private:
    Internal* impl; // PIMPL
};

InternalPartition.cpp:

module MyLibrary:InternalPartition;

class Internal {
public:
    void doSomething();
};

// Реализация функций классов

MyLibrary.cpp:

import MyLibrary:InternalPartition;

MyLibrary::MyLibrary()
    : impl(new Internal()) {}

MyLibrary::~MyLibrary() {
    delete impl;
}

Заключение

Использование PIMPL в сочетании с модулями C++20 требует точного понимания видимости и доступности модулей. Следуя приведенным рекомендациям, вы сможете создать библиотеку, основанную на PIMPL, которая устойчиво скрывает реализацию от пользователей, при этом сохраняя все преимущества модульной структуры C++. Не забывайте проверять компиляцию вашего проекта с использованием итогов CMake, чтобы упростить процесс отладки.