include/helpcompiler/compilehelp.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_HELPCOMPILER_COMPILEHELP_HXX
  21 #define INCLUDED_HELPCOMPILER_COMPILEHELP_HXX
  22
  23 #include <sal/config.h>
  24
  25 #include <string_view>
  26
  27 #include <sal/types.h>
  28
  29 #if defined(HELPLINKER_DLLIMPLEMENTATION)
  30 #define HELPLINKER_DLLPUBLIC  SAL_DLLPUBLIC_EXPORT
  31 #else
  32 #define HELPLINKER_DLLPUBLIC  SAL_DLLPUBLIC_IMPORT
  33 #endif
  34 #define HELPLINKER_DLLPRIVATE SAL_DLLPRIVATE
  35
  36 #include <rtl/ustring.hxx>
  37
  38 enum class HelpProcessingErrorClass
  39 {
  40     NONE,
  41     General,       // Missing files, options etc.
  42     XmlParsing     // Errors thrown by libxml
  43 };
  44
  45 struct HelpProcessingErrorInfo
  46 {
  47     HelpProcessingErrorClass   m_eErrorClass;
  48     OUString                   m_aErrorMsg;
  49     OUString                   m_aXMLParsingFile;
  50     sal_Int32                  m_nXMLParsingLine;
  51
  52     HelpProcessingErrorInfo()
  53         : m_eErrorClass( HelpProcessingErrorClass::NONE )
  54         , m_nXMLParsingLine( -1 )
  55     {}
  56
  57     HelpProcessingErrorInfo& operator=( const struct HelpProcessingException& e );
  58 };
  59
  60
  61 // Returns true in case of success, false in case of error
  62 HELPLINKER_DLLPUBLIC bool compileExtensionHelp
  63 (
  64      const OUString& aOfficeHelpPath,
  65     std::u16string_view aExtensionName,
  66     std::u16string_view aExtensionLanguageRoot,
  67     sal_Int32 nXhpFileCount, const OUString* pXhpFiles,
  68     std::u16string_view aDestination,
  69     HelpProcessingErrorInfo& o_rHelpProcessingErrorInfo
  70 );
  71
  72 #endif
  73
  74 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */