Restrict SAL_RET_MAYBENULL to LIBO_INTERNAL_ONLY
[LibreOffice.git] / l10ntools / inc / common.hxx
blobec5ed0c1958608f328faac333bc6b3370ae9326a
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
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 */
10 // Methods used by all of executables
12 #ifndef INCLUDED_L10NTOOLS_INC_COMMON_HXX
13 #define INCLUDED_L10NTOOLS_INC_COMMON_HXX
15 #include <sal/config.h>
17 #include <string_view>
19 #include <rtl/string.hxx>
20 #include "po.hxx"
22 namespace common {
24 /// Result type of handleArguments()
25 struct HandledArgs
27 OString m_sInputFile;
28 OString m_sOutputFile;
29 OString m_sMergeSrc;
30 OString m_sLanguage;
31 bool m_bMergeMode;
32 bool m_bUTF8BOM;
33 HandledArgs()
34 : m_sInputFile( OString() )
35 , m_sOutputFile( OString() )
36 , m_sMergeSrc( OString() )
37 , m_sLanguage( OString() )
38 , m_bMergeMode( false )
39 , m_bUTF8BOM( false )
43 /// Handle command line parameters
44 bool handleArguments(int argc, char * argv[], HandledArgs& o_aHandledArgs);
46 /// Write out a help about usage
47 void writeUsage(const OString& rName, const OString& rFileType);
49 /// Write out a PoEntry with attention to exceptions
50 void writePoEntry(
51 const OString& rExecutable, PoOfstream& rPoStream, const OString& rSourceFile,
52 std::string_view rResType, const OString& rGroupId, const OString& rLocalId,
53 const OString& rHelpText, const OString& rText, const PoEntry::TYPE eType = PoEntry::TTEXT );
57 #endif
59 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */