Adding upstream version 4:24.2.0.upstream/4%24.2.0

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

4 files changed, 240 insertions, 0 deletions

diff --git a/include/helpcompiler/HelpIndexer.hxx b/include/helpcompiler/HelpIndexer.hxx
new file mode 100644
index 0000000000..d9e639f791
--- /dev/null
+++ b/include/helpcompiler/HelpIndexer.hxx
@@ -0,0 +1,90 @@
+/* -*- 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 INCLUDED_HELPCOMPILER_HELPINDEXER_HXX
+#define INCLUDED_HELPCOMPILER_HELPINDEXER_HXX
+
+#include <helpcompiler/dllapi.h>
+
+#include <rtl/ustring.hxx>
+#include <set>
+#include <string_view>
+
+// 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 lang, OUString module,
+            std::u16string_view srcDir, std::u16string_view outDir);
+
+    /**
+     * Run the indexer.
+     * @return true if index successfully generated.
+     */
+    bool indexDocuments();
+
+    /**
+     * Get the error string (empty if no error occurred).
+     */
+    OUString const & getErrorMessage() const { return d_error;}
+
+    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.
+     */
+    void helpDocument(OUString const & fileName, lucene::document::Document *doc) const;
+
+    /**
+     * Create a reader for the given file, and create an "empty" reader in case the file doesn't exist.
+     */
+    static lucene::util::Reader *helpFileReader(OUString const & path);
+};
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/include/helpcompiler/HelpSearch.hxx b/include/helpcompiler/HelpSearch.hxx
new file mode 100644
index 0000000000..074373c43c
--- /dev/null
+++ b/include/helpcompiler/HelpSearch.hxx
@@ -0,0 +1,42 @@
+/* -*- 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 INCLUDED_HELPCOMPILER_HELPSEARCH_HXX
+#define INCLUDED_HELPCOMPILER_HELPSEARCH_HXX
+
+#include <helpcompiler/dllapi.h>
+
+#include <rtl/ustring.hxx>
+#include <vector>
+
+class L10N_DLLPUBLIC HelpSearch{
+    private:
+                OString d_indexDir;
+
+    public:
+
+    /**
+     * @param indexDir The directory where the index files are stored.
+     */
+        HelpSearch(OUString const &indexDir);
+
+    /**
+     * Query the index for a certain query string.
+     * @param queryStr The query.
+     * @param captionOnly Set to true to search in the caption, not the content.
+     * @param rDocuments Vector to write the paths of the found documents.
+     * @param rScores Vector to write the scores to.
+     */
+        void query(OUString const &queryStr, bool captionOnly,
+            std::vector<OUString> &rDocuments, std::vector<float> &rScores);
+};
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/include/helpcompiler/compilehelp.hxx b/include/helpcompiler/compilehelp.hxx
new file mode 100644
index 0000000000..8944257bd5
--- /dev/null
+++ b/include/helpcompiler/compilehelp.hxx
@@ -0,0 +1,74 @@
+/* -*- 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 .
+ */
+
+#ifndef INCLUDED_HELPCOMPILER_COMPILEHELP_HXX
+#define INCLUDED_HELPCOMPILER_COMPILEHELP_HXX
+
+#include <sal/config.h>
+
+#include <string_view>
+
+#include <sal/types.h>
+
+#if defined(HELPLINKER_DLLIMPLEMENTATION)
+#define HELPLINKER_DLLPUBLIC  SAL_DLLPUBLIC_EXPORT
+#else
+#define HELPLINKER_DLLPUBLIC  SAL_DLLPUBLIC_IMPORT
+#endif
+#define HELPLINKER_DLLPRIVATE SAL_DLLPRIVATE
+
+#include <rtl/ustring.hxx>
+
+enum class HelpProcessingErrorClass
+{
+    NONE,
+    General,       // Missing files, options etc.
+    XmlParsing     // Errors thrown by libxml
+};
+
+struct HelpProcessingErrorInfo
+{
+    HelpProcessingErrorClass   m_eErrorClass;
+    OUString                   m_aErrorMsg;
+    OUString                   m_aXMLParsingFile;
+    sal_Int32                  m_nXMLParsingLine;
+
+    HelpProcessingErrorInfo()
+        : m_eErrorClass( HelpProcessingErrorClass::NONE )
+        , m_nXMLParsingLine( -1 )
+    {}
+
+    HelpProcessingErrorInfo& operator=( const struct HelpProcessingException& e );
+};
+
+
+// Returns true in case of success, false in case of error
+HELPLINKER_DLLPUBLIC bool compileExtensionHelp
+(
+     const OUString& aOfficeHelpPath,
+    std::u16string_view aExtensionName,
+    std::u16string_view aExtensionLanguageRoot,
+    sal_Int32 nXhpFileCount, const OUString* pXhpFiles,
+    std::u16string_view aDestination,
+    HelpProcessingErrorInfo& o_rHelpProcessingErrorInfo
+);
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/include/helpcompiler/dllapi.h b/include/helpcompiler/dllapi.h
new file mode 100644
index 0000000000..e0a115d056
--- /dev/null
+++ b/include/helpcompiler/dllapi.h
@@ -0,0 +1,34 @@
+/* -*- 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 .
+ */
+
+#ifndef INCLUDED_HELPCOMPILER_DLLAPI_H
+#define INCLUDED_HELPCOMPILER_DLLAPI_H
+
+#include <sal/config.h>
+#include <sal/types.h>
+
+#if defined L10N_DLLIMPLEMENTATION
+#define L10N_DLLPUBLIC SAL_DLLPUBLIC_EXPORT
+#else
+#define L10N_DLLPUBLIC SAL_DLLPUBLIC_IMPORT
+#endif
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */