Хранение определений функций шаблона C ++ в файле .CPP

У меня есть некоторый шаблон кода, который я бы предпочел сохранить в файле CPP вместо встроенного в заголовке. Я знаю, что это можно сделать, если вы знаете, какие типы шаблонов будут использоваться. Например:

.h файл

class foo
{
public:
    template <typename T>
    void do(const T& t);
};

файл .cpp

template <typename T>
void foo::do(const T& t)
{
    // Do something with t
}

template void foo::do<int>(const int&);
template void foo::do<std::string>(const std::string&);

Обратите внимание на две последние строки - шаблонная функция foo :: do используется только с ints и std :: strings, поэтому эти определения означают, что приложение будет ссылаться.

Мой вопрос - это противный взлом или это будет работать с другими компиляторами / компоновщиками? В настоящее время я использую только этот код с VS2008, но хочу портировать на другие среды.

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

Я рекомендую прочитать следующие пункты из C ++ FAQ Lite :

• Почему я не могу отделить определение своего класса шаблонов от его объявления и поместить его в файл .cpp?
• Как я могу избежать ошибок компоновщика с моими функциями шаблона?
• Как экспорт ключевых слов C ++ помогает с ошибками компоновщика шаблона?

Они подробно рассказывают об этих (и других) проблемах с шаблонами.

Для других на этой странице, задающихся вопросом, каков правильный синтаксис (как я сделал) для явной специализации шаблона (или по крайней мере в VS2008), его следующее ...

В вашем .h файле ...

template<typename T>
class foo
{
public:
    void bar(const T &t);
};

И в вашем .cpp файле

template <class T>
void foo<T>::bar(const T &t)
{ }

// Explicit template instantiation
template class foo<int>;

Этот код правильно сформирован. Нужно только обратить внимание, что определение шаблона видно в момент его создания. Чтобы процитировать стандарт, § 14.7.2.4:

Определение неэкспортированного шаблона функции, неэкспортированного шаблона функции-члена или неэкспортированной функции-члена или статического члена данных шаблона класса должно присутствовать в каждой единице перевода, в которой он явно создан.

Это должно работать нормально везде, где поддерживаются шаблоны. Явная реализация шаблона является частью стандарта C ++.

Ваш пример правильный, но не очень переносимый. Существует также немного более чистый синтаксис, который можно использовать (как указано @ namespace-sid).

Предположим, что шаблонный класс является частью некоторой библиотеки, которая должна использоваться совместно. Должны ли компилироваться другие версии шаблонного класса? Должен ли сопровождающий библиотеки предвидеть все возможные шаблонные применения класса?

Альтернативный подход - это небольшая вариация того, что у вас есть: добавьте третий файл, который является файлом реализации / создания шаблона.

файл foo.h

// Standard header file guards omitted

template <typename T>
class foo
{
public:
    void bar(const T& t);
};

файл foo.cpp

// Always include your headers
#include "foo.h"

template <typename T>
void foo::bar(const T& t)
{
    // Do something with t
}

файл foo-impl.cpp

// Yes, we include the .cpp file
#include "foo.cpp"
template class foo<int>;

Один нюанс в том , что вы должны сообщить компилятору для компиляции foo-impl.cppвместо того , foo.cppкак составление последнего ничего не делает.

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

Это обеспечивает большую гибкость при совместном использовании шаблонного класса для других целей.

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

Это определенно не противный хак, но имейте в виду, что вам придется делать это (явная специализация шаблона) для каждого класса / типа, который вы хотите использовать с данным шаблоном. В случае МНОГИХ типов, запрашивающих создание экземпляра шаблона, в вашем файле .cpp может быть МНОГО строк. Чтобы устранить эту проблему, вы можете иметь TemplateClassInst.cpp в каждом используемом вами проекте, чтобы вы могли лучше контролировать, какие типы будут создаваться. Очевидно, что это решение не будет идеальным (так называемая серебряная пуля), так как в итоге вы можете сломать ODR :).

В последнем стандарте есть ключевое слово ( export), которое поможет решить эту проблему, но оно не реализовано ни в одном из известных мне компиляторов, кроме Comeau.

Смотрите FAQ-Lite об этом.

Это стандартный способ определения функций шаблона. Я думаю, что есть три метода для определения шаблонов. Или, вероятно, 4. Каждый со своими плюсами и минусами.

1. Определите в определении класса. Мне это совсем не нравится, потому что я думаю, что определения классов предназначены только для справки и должны быть легко читаемыми. Однако определить шаблоны в классе гораздо сложнее, чем снаружи. И не все объявления шаблонов находятся на одном уровне сложности. Этот метод также делает шаблон настоящим шаблоном.

2. Определите шаблон в том же заголовке, но за пределами класса. Это мой любимый способ в большинстве случаев. Он сохраняет ваше определение класса в чистоте, шаблон остается истинным шаблоном. Однако это требует полного именования шаблонов, что может быть сложно. Также ваш код доступен всем. Но если вам нужен встроенный код, это единственный способ. Вы также можете сделать это, создав файл .INL в конце определения вашего класса.

3. Включите header.h и creation.CPP в ваш main.CPP. Я думаю, вот как это сделано. Вам не придется готовить какие-либо предварительные экземпляры, это будет вести себя как настоящий шаблон. Проблема с этим в том, что это не естественно. Обычно мы не включаем и не ожидаем включения исходных файлов. Я предполагаю, что поскольку вы включили исходный файл, функции шаблона могут быть встроены.

4. Этот последний метод, который был опубликован, определяет шаблоны в исходном файле, как и номер 3; но вместо того, чтобы включать исходный файл, мы предварительно создаем шаблоны для тех, которые нам понадобятся. У меня нет проблем с этим методом, и иногда он бывает полезен. У нас есть один большой код, он не может извлечь выгоду из встроенного кода, поэтому просто поместите его в файл CPP. И если мы знаем общие экземпляры и можем их предопределить. Это спасает нас от написания в основном одной и той же вещи 5, 10 раз. Этот метод имеет преимущество сохранения нашего кода в проприетарном виде. Но я не рекомендую помещать крошечные, регулярно используемые функции в файлы CPP. Как это снизит производительность вашей библиотеки.

Обратите внимание, я не знаю о последствиях раздутого файла obj.

Да, это стандартный способ явной реализации специализации . Как вы заявили, вы не можете создать экземпляр этого шаблона с другими типами.

Изменить: исправлено на основе комментария.

Давайте рассмотрим один пример, скажем, по какой-то причине вы хотите иметь шаблонный класс:

//test_template.h:
#pragma once
#include <cstdio>

template <class T>
class DemoT
{
public:
    void test()
    {
        printf("ok\n");
    }
};

template <>
void DemoT<int>::test()
{
    printf("int test (int)\n");
}


template <>
void DemoT<bool>::test()
{
    printf("int test (bool)\n");
}

Если вы компилируете этот код с помощью Visual Studio - он работает «из коробки». gcc выдаст ошибку компоновщика (если один и тот же заголовочный файл используется из нескольких файлов .cpp):

error : multiple definition of `DemoT<int>::test()'; your.o: .../test_template.h:16: first defined here

Можно перенести реализацию в файл .cpp, но тогда вам нужно объявить класс следующим образом:

//test_template.h:
#pragma once
#include <cstdio>

template <class T>
class DemoT
{
public:
    void test()
    {
        printf("ok\n");
    }
};

template <>
void DemoT<int>::test();

template <>
void DemoT<bool>::test();

// Instantiate parametrized template classes, implementation resides on .cpp side.
template class DemoT<bool>;
template class DemoT<int>;

И тогда .cpp будет выглядеть так:

//test_template.cpp:
#include "test_template.h"

template <>
void DemoT<int>::test()
{
    printf("int test (int)\n");
}


template <>
void DemoT<bool>::test()
{
    printf("int test (bool)\n");
}

Без двух последних строк в заголовочном файле - gcc будет работать нормально, но Visual Studio выдаст ошибку:

 error LNK2019: unresolved external symbol "public: void __cdecl DemoT<int>::test(void)" (?test@?$DemoT@H@@QEAAXXZ) referenced in function

Синтаксис класса шаблона является необязательным в случае, если вы хотите предоставить функцию через экспорт .dll, но это применимо только для платформы Windows - поэтому test_template.h может выглядеть так:

//test_template.h:
#pragma once
#include <cstdio>

template <class T>
class DemoT
{
public:
    void test()
    {
        printf("ok\n");
    }
};

#ifdef _WIN32
    #define DLL_EXPORT __declspec(dllexport) 
#else
    #define DLL_EXPORT
#endif

template <>
void DLL_EXPORT DemoT<int>::test();

template <>
void DLL_EXPORT DemoT<bool>::test();

с .cpp файлом из предыдущего примера.

Это, однако, создает большую головную боль для компоновщика, поэтому рекомендуется использовать предыдущий пример, если вы не экспортируете функцию .dll.

Время для обновления! Создайте встроенный (.inl или, возможно, любой другой) файл и просто скопируйте в него все свои определения. Обязательно добавьте шаблон над каждой функцией ( template <typename T, ...>). Теперь вместо включения заголовочного файла во встроенный файл вы делаете обратное. Включите встроенный файл после объявления вашего класса ( #include "file.inl").

Я действительно не знаю, почему никто не упомянул это. Я не вижу непосредственных недостатков.

Нет ничего плохого в приведенном вами примере. Но я должен сказать, что считаю, что неэффективно хранить определения функций в файле cpp. Я понимаю только необходимость разделения объявления и определения функции.

При использовании вместе с явной реализацией классов, библиотека Boost Concept Check Library (BCCL) может помочь вам сгенерировать код функции шаблона в файлах cpp.

Ничто из вышеперечисленного не сработало для меня, так что вот как у вас это решено, у моего класса только один шаблонный метод ..

.час

class Model
{
    template <class T>
    void build(T* b, uint32_t number);
};

.cpp

#include "Model.h"
template <class T>
void Model::build(T* b, uint32_t number)
{
    //implementation
}

void TemporaryFunction()
{
    Model m;
    m.build<B1>(new B1(),1);
    m.build<B2>(new B2(), 1);
    m.build<B3>(new B3(), 1);
}

это позволяет избежать ошибок компоновщика и вообще не вызывать TemporaryFunction