summaryrefslogtreecommitdiff
path: root/desktop/source/app/cmdlineargs.hxx
blob: 4ef302e12fb27b9a35cd77b6603afdacb5ac0b91 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef _DESKTOP_COMMANDLINEARGS_HXX_
#define _DESKTOP_COMMANDLINEARGS_HXX_

#include <rtl/ustring.hxx>
#include <osl/mutex.hxx>
#include "boost/optional.hpp"

namespace desktop
{

class CommandLineArgs
{
    public:
        enum BoolParam	// must be zero based!
        {
            CMD_BOOLPARAM_MINIMIZED,
            CMD_BOOLPARAM_INVISIBLE,
            CMD_BOOLPARAM_NORESTORE,
            CMD_BOOLPARAM_BEAN,
            CMD_BOOLPARAM_PLUGIN,
            CMD_BOOLPARAM_SERVER,
            CMD_BOOLPARAM_HEADLESS,
            CMD_BOOLPARAM_QUICKSTART,
            CMD_BOOLPARAM_NOQUICKSTART,
            CMD_BOOLPARAM_TERMINATEAFTERINIT,
            CMD_BOOLPARAM_NOFIRSTSTARTWIZARD,
            CMD_BOOLPARAM_NOLOGO,
            CMD_BOOLPARAM_NOLOCKCHECK,
            CMD_BOOLPARAM_NODEFAULT,
            CMD_BOOLPARAM_HELP,
            CMD_BOOLPARAM_WRITER,
            CMD_BOOLPARAM_CALC,
            CMD_BOOLPARAM_DRAW,
            CMD_BOOLPARAM_IMPRESS,
            CMD_BOOLPARAM_GLOBAL,
            CMD_BOOLPARAM_MATH,
            CMD_BOOLPARAM_WEB,
            CMD_BOOLPARAM_BASE,
            CMD_BOOLPARAM_HELPWRITER,
            CMD_BOOLPARAM_HELPCALC,
            CMD_BOOLPARAM_HELPDRAW,
            CMD_BOOLPARAM_HELPBASIC,
            CMD_BOOLPARAM_HELPMATH,
            CMD_BOOLPARAM_HELPIMPRESS,
            CMD_BOOLPARAM_HELPBASE,
            CMD_BOOLPARAM_PSN,
            CMD_BOOLPARAM_COUNT				// must be last element!
        };

        enum StringParam // must be zero based!
        {
            CMD_STRINGPARAM_PORTAL,
            CMD_STRINGPARAM_SPLASHPIPE,
            CMD_STRINGPARAM_ACCEPT,
            CMD_STRINGPARAM_UNACCEPT,
            CMD_STRINGPARAM_USERDIR,
            CMD_STRINGPARAM_CLIENTDISPLAY,
            CMD_STRINGPARAM_OPENLIST,
            CMD_STRINGPARAM_VIEWLIST,
            CMD_STRINGPARAM_STARTLIST,
            CMD_STRINGPARAM_FORCEOPENLIST,
            CMD_STRINGPARAM_FORCENEWLIST,
            CMD_STRINGPARAM_PRINTLIST,
            CMD_STRINGPARAM_VERSION,
            CMD_STRINGPARAM_PRINTTOLIST,
            CMD_STRINGPARAM_PRINTERNAME,
            CMD_STRINGPARAM_CONVERSIONLIST,
            CMD_STRINGPARAM_CONVERSIONPARAMS,
            CMD_STRINGPARAM_CONVERSIONOUT,
            CMD_STRINGPARAM_INFILTER,
            CMD_STRINGPARAM_DISPLAY,
            CMD_STRINGPARAM_LANGUAGE,
            CMD_STRINGPARAM_COUNT			// must be last element!
        };

        enum GroupParamId
        {
            CMD_GRPID_MODULE,
            CMD_GRPID_COUNT
        };

        struct Supplier {
            // Thrown from constructors and next:
            class Exception {
            public:
                Exception();
                Exception(Exception const &);
                virtual ~Exception();
                Exception & operator =(Exception const &);
            };

            virtual ~Supplier();
            virtual boost::optional< rtl::OUString > getCwdUrl() = 0;
            virtual bool next(rtl::OUString * argument) = 0;
        };

        CommandLineArgs();
        CommandLineArgs( Supplier& supplier );

        boost::optional< rtl::OUString > getCwdUrl() const { return m_cwdUrl; }

        // generic methods to access parameter
        void					SetBoolParam( BoolParam eParam, sal_Bool bNewValue );

        const rtl::OUString&    GetStringParam( StringParam eParam ) const;

        // Access to bool parameters
        sal_Bool				IsMinimized() const;
        sal_Bool				IsInvisible() const;
        sal_Bool				IsNoRestore() const;
        sal_Bool				IsNoDefault() const;
        sal_Bool				IsBean() const;
        sal_Bool				IsServer() const;
        sal_Bool				IsHeadless() const;
        sal_Bool				IsQuickstart() const;
        sal_Bool                IsNoQuickstart() const;
        sal_Bool				IsTerminateAfterInit() const;
        sal_Bool                IsNoFirstStartWizard() const;
        sal_Bool				IsNoLogo() const;
        sal_Bool				IsNoLockcheck() const;
        sal_Bool				IsHelp() const;
        sal_Bool				IsHelpWriter() const;
        sal_Bool				IsHelpCalc() const;
        sal_Bool				IsHelpDraw() const;
        sal_Bool				IsHelpImpress() const;
        sal_Bool				IsHelpBase() const;
        sal_Bool				IsHelpMath() const;
        sal_Bool				IsHelpBasic() const;
        sal_Bool				IsWriter() const;
        sal_Bool				IsCalc() const;
        sal_Bool				IsDraw() const;
        sal_Bool				IsImpress() const;
        sal_Bool				IsBase() const;
        sal_Bool				IsGlobal() const;
        sal_Bool				IsMath() const;
        sal_Bool				IsWeb() const;
        sal_Bool				HasModuleParam() const;

        // Access to string parameters
        sal_Bool				GetPortalConnectString( ::rtl::OUString& rPara) const;
        sal_Bool				GetAcceptString( ::rtl::OUString& rPara) const;
        sal_Bool				GetUnAcceptString( ::rtl::OUString& rPara) const;
        sal_Bool				GetOpenList( ::rtl::OUString& rPara) const;
        sal_Bool				GetViewList( ::rtl::OUString& rPara) const;
        sal_Bool                GetStartList( ::rtl::OUString& rPara) const;
        sal_Bool				GetForceOpenList( ::rtl::OUString& rPara) const;
        sal_Bool				GetForceNewList( ::rtl::OUString& rPara) const;
        sal_Bool				GetPrintList( ::rtl::OUString& rPara) const;
        sal_Bool				GetPrintToList( ::rtl::OUString& rPara ) const;
        sal_Bool				GetPrinterName( ::rtl::OUString& rPara ) const;
        sal_Bool                GetLanguage( ::rtl::OUString& rPara ) const;
        sal_Bool                GetInFilter( ::rtl::OUString& rPara ) const;
        sal_Bool                GetConversionList( ::rtl::OUString& rPara ) const;
        sal_Bool                GetConversionParams( ::rtl::OUString& rPara ) const;
        sal_Bool                GetConversionOut( ::rtl::OUString& rPara ) const;

        // Special analyzed states (does not match directly to a command line parameter!)
        sal_Bool                IsPrinting() const;
        sal_Bool                IsEmpty() const;
        sal_Bool                IsEmptyOrAcceptOnly() const;

    private:
        enum Count { NONE, ONE, MANY };

        struct GroupDefinition
        {
            sal_Int32	nCount;
            BoolParam*	pGroupMembers;
        };

        // no copy and operator=
        CommandLineArgs( const CommandLineArgs& );
        CommandLineArgs operator=( const CommandLineArgs& );

        sal_Bool				InterpretCommandLineParameter( const ::rtl::OUString& );
        void					ParseCommandLine_Impl( Supplier& supplier );
        void					ResetParamValues();
        sal_Bool				CheckGroupMembers( GroupParamId nGroup, BoolParam nExcludeMember ) const;

        void					AddStringListParam_Impl( StringParam eParam, const rtl::OUString& aParam );
        void					SetBoolParam_Impl( BoolParam eParam, sal_Bool bValue );

        boost::optional< rtl::OUString > m_cwdUrl;
        sal_Bool				m_aBoolParams[ CMD_BOOLPARAM_COUNT ];		// Stores boolean parameters
        rtl::OUString			m_aStrParams[ CMD_STRINGPARAM_COUNT ];		// Stores string parameters
        sal_Bool				m_aStrSetParams[ CMD_STRINGPARAM_COUNT ];	// Stores if string parameters are provided on cmdline
        Count                   m_eArgumentCount;                           // Number of Args
        mutable ::osl::Mutex	m_aMutex;

        // static definition for groups where only one member can be true
        static GroupDefinition	m_pGroupDefinitions[ CMD_GRPID_COUNT ];
};

}

#endif