Это слишком много кода для библиотеки только заголовка?

Question

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

#include <list>
#include <string>
#include <boost/noncopyable.hpp>
#include <boost/make_shared.hpp>
#include <boost/iterator/iterator_facade.hpp>
#include <Windows.h>
#include "../Exception.hpp"

namespace WindowsAPI { namespace FileSystem {

class NonRecursiveEnumeration;
class RecursiveEnumeration;
struct AllResults;
struct FilesOnly;

template <typename Filter_T = AllResults, typename Recurse_T = NonRecursiveEnumeration>
class DirectoryIterator;

template <typename Recurse_T>
struct FileData;

class NonRecursiveEnumeration : public boost::noncopyable
{
    WIN32_FIND_DATAW currentData;
    HANDLE hFind;
    std::wstring root;
public:
    NonRecursiveEnumeration() : hFind(INVALID_HANDLE_VALUE) {
    };
    NonRecursiveEnumeration(const std::wstring& pathSpec) {
        std::wstring::const_iterator lastSlash =
            std::find(pathSpec.rbegin(), pathSpec.rend(), L'\\').base();
        if (lastSlash != pathSpec.end())
            root.assign(pathSpec.begin(), lastSlash);
        hFind = FindFirstFileW(pathSpec.c_str(), &currentData);
        if (hFind == INVALID_HANDLE_VALUE)
            WindowsApiException::ThrowFromLastError();
        while (!wcscmp(currentData.cFileName, L".") || !wcscmp(currentData.cFileName, L"..")) {
            increment();
        }
    };
    void increment() {
        BOOL success =
            FindNextFile(hFind, &currentData);
        if (success)
            return;
        DWORD error = GetLastError();
        if (error == ERROR_NO_MORE_FILES) {
            FindClose(hFind);
            hFind = INVALID_HANDLE_VALUE;
        } else {
            WindowsApiException::Throw(error);
        }
    };
    ~NonRecursiveEnumeration() {
        if (hFind != INVALID_HANDLE_VALUE)
            FindClose(hFind);
    };
    bool equal(const NonRecursiveEnumeration& other) const {
        if (this == &other)
            return true;
        return hFind == other.hFind;
    };
    const std::wstring& GetPathRoot() const {
        return root;
    };
    const WIN32_FIND_DATAW& GetCurrentFindData() const {
        return currentData;
    };
};

//Not implemented yet
class RecursiveEnumeration : public boost::noncopyable
{
};

template <typename Recurse_T>
struct FileData //Serves as a proxy to the WIN32_FIND_DATA struture inside the iterator.
{
    const Recurse_T* impl;
    template <typename Filter_T, typename Recurse_T>
    FileData(const DirectoryIterator<Filter_T, Recurse_T>* parent) : impl(parent->impl.get()) {};
    DWORD GetAttributes() const {
        return impl->GetCurrentFindData().dwFileAttributes;
    };
    bool IsDirectory() const {
        return (GetAttributes() & FILE_ATTRIBUTE_DIRECTORY) != 0;
    };
    bool IsFile() const {
        return !IsDirectory();
    };
    bool IsArchive() const {
        return (GetAttributes() & FILE_ATTRIBUTE_ARCHIVE) != 0;
    };
    bool IsReadOnly() const {
        return (GetAttributes() & FILE_ATTRIBUTE_READONLY) != 0;
    };
    unsigned __int64 GetSize() const {
        ULARGE_INTEGER intValue;
        intValue.LowPart = impl.GetCurrentFindData().nFileSizeLow;
        intValue.HighPart = impl.GetCurrentFindData().nFileSizeHigh;
        return intValue.QuadPart;
    };
    std::wstring GetFolderPath() const {
        return impl->GetPathRoot();
    };
    std::wstring GetFileName() const {
        return impl->GetCurrentFindData().cFileName;
    };
    std::wstring GetFullFileName() const {
        return GetFolderPath() + GetFileName();
    };
    std::wstring GetShortFileName() const {
        return impl->GetCurrentFindData().cAlternateFileName;
    };
    FILETIME GetCreationTime() const {
        return impl->GetCurrentFindData().ftCreationTime;
    };
    FILETIME GetLastAccessTime() const {
        return impl->GetCurrentFindData().ftLastAccessTime;
    };
    FILETIME GetLastWriteTime() const {
        return impl->GetCurrentFindData().ftLastWriteTime;
    };
};

struct AllResults
{
    template <typename Recurse_T>
    bool operator()(const FileData<Recurse_T>&) {
        return true;
    };
}; 

struct FilesOnly
{
    template <typename Recurse_T>
    bool operator()(const FileData<Recurse_T>& arg) {
        return arg.IsFile();
    };
};

#pragma warning(push)
#pragma warning(disable: 4355)
template <typename Filter_T, typename Recurse_T>
class DirectoryIterator : public boost::iterator_facade<DirectoryIterator<Filter_T>, const FileData<Recurse_T>, std::input_iterator_tag>
{
    friend class boost::iterator_core_access;
    boost::shared_ptr<Recurse_T> impl;
    FileData<Recurse_T> derefData;
    Filter_T filter;
    void increment() {
        do {
            impl->increment();
        } while (! filter(derefData));
    };
    bool equal(const DirectoryIterator& other) const {
        return impl->equal(*other.impl);
    };
    const FileData<Recurse_T>& dereference() const {
        return derefData;
    };
public:
    typedef FileData<Recurse_T> DataType;
    friend struct DataType;
    DirectoryIterator(Filter_T functor = Filter_T()) :
        impl(boost::make_shared<Recurse_T>()),
        derefData(this),
        filter(functor) {
    };
    explicit DirectoryIterator(const std::wstring& pathSpec, Filter_T functor = Filter_T()) :
        impl(boost::make_shared<Recurse_T>(pathSpec)),
        derefData(this),
        filter(functor) {
    };
};
#pragma warning(pop)

}}

Answer 1

У меня есть гораздо больше кода в некоторых моих моих моих, если это любое утешение. И вот и все стандартные реализации стандартной библиотеки C ++, Boost и Microsoft (например, ATL).

Answer 2

Единственная часть, которая поражает меня как открытым для большого вопроса, будут реализациями функций в DirectoryIteratorImpl. Отказ Это не шаблон, поэтому он на самом деле не должен быть в заголовке, и у него есть пара несколько более длинных подпрограмм («настоящий» конструктор и приращение).

Остальные являются либо шаблонами, либо в составных из таких тривиальных функций, которые вы хотите, чтобы они внурились в любом случае (например, члены FileData). Те, кто закончится в заголовке в любом случае.

Answer 3

Что касается длины заголовка, вы можете иметь столько же кода, как вы хотите в файлах заголовков. Выделение компромиссов - это количество кода, которое необходимо перекомпилировать каждый раз, когда ваша программа построена; Код, помещенный в файлах CPP, могут быть скомпилированы в объектные файлы и связаны на каждой последующей сборке.

Я бы предположил, что каждый из определений методов для DirectoryIteratorImpl следует перемещать в .cpp файл. Если вы не определяете метод, встроенный внутри определения класса, нет причин для него в файл заголовка.

Безразличен в сторону: избегать письма inline DirectoryIteratorImpl(); - На самом деле запишите свои встроенные функции встроенные или не поменяйте их в Inline. Из C ++ FAQ Lite:

Обычно необходимо, чтобы определение функции (часть между {...}) быть помещена в заголовочном файле. Если вы поместите определение встроенной функции в файл .cpp, и если он вызывается из некоторого другого файла .CPP, вы получите «нерешенную внешнюю» ошибку от линкера.

Если ваши функции «слишком большие» для записи в заголовочном файле, они слишком велики, и компилятор, скорее всего, проигнорирует ваше встроенное предложение в любом случае.

Answer 4

Кажется, вы программируете для Windows здесь, предположим, что вы используете Visual Studio?

Во всяком случае, я не думаю, что есть что-то столько кода в заголовках.

Это вопрос торговли в основном:

• медленнее компиляция (но у нас многолетний и сложные заголовки)
• более частая перекомпиляция (опять же, многолетние)
• Возможно, код раздувания ...

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

Честно говоря, я бы не слишком беспокоился об этом. Количество Boost Библиотеки являются заголовками - только даже для их запчастей не шаблонов просто потому, что она облегчает интеграцию (без необходимости связывания).