Branch data     Line data    Source code

       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 COMPILE_HXX
      21                 :            : #define COMPILE_HXX
      22                 :            : 
      23                 :            : #include "sal/types.h"
      24                 :            : 
      25                 :            : #if defined(HELPLINKER_DLLIMPLEMENTATION)
      26                 :            : #define HELPLINKER_DLLPUBLIC  SAL_DLLPUBLIC_EXPORT
      27                 :            : #else
      28                 :            : #define HELPLINKER_DLLPUBLIC  SAL_DLLPUBLIC_IMPORT
      29                 :            : #endif
      30                 :            : #define HELPLINKER_DLLPRIVATE SAL_DLLPRIVATE
      31                 :            : 
      32                 :            : #include <rtl/ustring.hxx>
      33                 :            : 
      34                 :            : enum HelpProcessingErrorClass
      35                 :            : {
      36                 :            :     HELPPROCESSING_NO_ERROR,
      37                 :            :     HELPPROCESSING_GENERAL_ERROR,       // Missing files, options etc.
      38                 :            :     HELPPROCESSING_INTERNAL_ERROR,      // Unexpected problems
      39                 :            :     HELPPROCESSING_XMLPARSING_ERROR     // Errors thrown by libxml
      40                 :            : };
      41                 :            : 
      42                 :         62 : struct HelpProcessingErrorInfo
      43                 :            : {
      44                 :            :     HelpProcessingErrorClass        m_eErrorClass;
      45                 :            :     rtl::OUString                   m_aErrorMsg;
      46                 :            :     rtl::OUString                   m_aXMLParsingFile;
      47                 :            :     sal_Int32                       m_nXMLParsingLine;
      48                 :            : 
      49                 :         62 :     HelpProcessingErrorInfo( void )
      50                 :            :         : m_eErrorClass( HELPPROCESSING_NO_ERROR )
      51                 :         62 :         , m_nXMLParsingLine( -1 )
      52                 :         62 :     {}
      53                 :            : 
      54                 :            :     HelpProcessingErrorInfo& operator=( const struct HelpProcessingException& e );
      55                 :            : };
      56                 :            : 
      57                 :            : 
      58                 :            : // Returns true in case of success, false in case of error
      59                 :            : HELPLINKER_DLLPUBLIC bool compileExtensionHelp
      60                 :            : (
      61                 :            :      const rtl::OUString& aOfficeHelpPath,
      62                 :            :     const rtl::OUString& aExtensionName,
      63                 :            :     const rtl::OUString& aExtensionLanguageRoot,
      64                 :            :     sal_Int32 nXhpFileCount, const rtl::OUString* pXhpFiles,
      65                 :            :     const rtl::OUString& aDestination,
      66                 :            :     HelpProcessingErrorInfo& o_rHelpProcessingErrorInfo
      67                 :            : );
      68                 :            : 
      69                 :            : #endif
      70                 :            : 
      71                 :            : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */