diff options
author | Michael Stahl <mstahl@redhat.com> | 2013-05-06 17:25:51 +0200 |
---|---|---|
committer | Michael Stahl <mstahl@redhat.com> | 2013-05-07 01:41:23 +0200 |
commit | 0bb8c032535a9a6311ba27e22fade8a0ff84429d (patch) | |
tree | 81bdef7d08f38fbe1984a233a1936b927c46fc3a /include/helpcompiler/HelpIndexer.hxx | |
parent | 9a7603187eb5cc580d33212ee147f9ac89de55f4 (diff) |
helpcompiler: remove Package_inc
Change-Id: Iddafa9068edcc20135c08ed205b8fb7fb5382eba
Diffstat (limited to 'include/helpcompiler/HelpIndexer.hxx')
-rw-r--r-- | include/helpcompiler/HelpIndexer.hxx | 89 |
1 files changed, 89 insertions, 0 deletions
diff --git a/include/helpcompiler/HelpIndexer.hxx b/include/helpcompiler/HelpIndexer.hxx new file mode 100644 index 000000000000..4be40eb827ce --- /dev/null +++ b/include/helpcompiler/HelpIndexer.hxx @@ -0,0 +1,89 @@ +/* -*- 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/. + */ + +#ifndef HELPINDEXER_HXX +#define HELPINDEXER_HXX + +#include <helpcompiler/dllapi.h> + +#include <rtl/ustring.hxx> +#include <set> + +// I assume that TCHAR is defined as wchar_t throughout + +namespace lucene +{ +namespace document +{ +class Document; +} +namespace util +{ +class Reader; +} +} + +class L10N_DLLPUBLIC HelpIndexer { + private: + OUString d_lang; + OUString d_module; + OUString d_captionDir; + OUString d_contentDir; + OUString d_indexDir; + OUString d_error; + std::set<OUString> d_files; + + public: + + /** + * @param lang Help files language. + * @param module The module of the helpfiles. + * @param srcDir The help directory to index + * @param outDir The directory to write the "module".idxl directory to + */ + HelpIndexer(OUString const &lang, OUString const &module, + OUString const &srcDir, OUString const &outDir); + + /** + * Run the indexer. + * @return true if index successfully generated. + */ + bool indexDocuments(); + + /** + * Get the error string (empty if no error occurred). + */ + OUString const & getErrorMessage(); + + private: + + /** + * Scan the caption & contents directories for help files. + */ + bool scanForFiles(); + + /** + * Scan for files in the given directory. + */ + bool scanForFiles(OUString const &path); + + /** + * Fill the Document with information on the given help file. + */ + bool helpDocument(OUString const & fileName, lucene::document::Document *doc); + + /** + * Create a reader for the given file, and create an "empty" reader in case the file doesn't exist. + */ + lucene::util::Reader *helpFileReader(OUString const & path); +}; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |