TemplateScanner.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
 
#pragma once
 
#include "tools/AsynchronousTask.hxx"
#include <ucbhelper/content.hxx>
#include <com/sun/star/uno/Reference.h>
 
#include <memory>
#include <utility>
#include <vector>
 
namespace com::sun::star::ucb
{
class XContent;
class XCommandEnvironment;
}
 
namespace com::sun::star::sdbc
{
class XResultSet;
}
 
namespace sd
{
class TemplateEntry
{
public:
    TemplateEntry(OUString sTitle, OUString sPath)
        : msTitle(std::move(sTitle))
        , msPath(std::move(sPath))
    {
    }
 
    OUString msTitle;
    OUString msPath;
};
 
class TemplateScanner final : public ::sd::tools::AsynchronousTask
{
public:
    TemplateScanner();
 
    virtual ~TemplateScanner();
 
    virtual void RunNextStep() override;
 
    virtual bool HasNextStep() override;
 
    const TemplateEntry* GetLastAddedEntry() const
    {
        return mpTemplateEntries.empty() ? nullptr : mpTemplateEntries.back().get();
    }
 
private:
    enum State
    {
        INITIALIZE_SCANNING,
        INITIALIZE_FOLDER_SCANNING,
        GATHER_FOLDER_LIST,
        SCAN_FOLDER,
        INITIALIZE_ENTRY_SCAN,
        SCAN_ENTRY,
        DONE,
        ERROR
    };
    State meState;
 
    ::ucbhelper::Content maFolderContent;
    ::std::vector<std::unique_ptr<TemplateEntry>> mpTemplateEntries;
 
    class FolderDescriptorList;
    std::unique_ptr<FolderDescriptorList> mpFolderDescriptors;
 
    css::uno::Reference<css::ucb::XContent> mxTemplateRoot;
    css::uno::Reference<css::ucb::XCommandEnvironment> mxFolderEnvironment;
    css::uno::Reference<css::ucb::XCommandEnvironment> mxEntryEnvironment;
    css::uno::Reference<css::sdbc::XResultSet> mxFolderResultSet;
    css::uno::Reference<css::sdbc::XResultSet> mxEntryResultSet;
 
    State GetTemplateRoot();
 
    State InitializeFolderScanning();
 
    State GatherFolderList();
 
    State ScanFolder();
 
    State InitializeEntryScanning();
 
    State ScanEntry();
};
 
} // end of namespace sd
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */