annotate Applications/Wasm/StartupParametersBuilder.h @ 868:b7f3cd9efe6f

Added tag toa2019062502 for changeset fe96057e97b9
author Benjamin Golinvaux <bgo@osimis.io>
date Tue, 25 Jun 2019 18:04:09 +0200
parents 70992b38aa8a
children 2d8ab34c8c91
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
242
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
1 /**
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
2 * Stone of Orthanc
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
439
b70e9be013e4 preparing for 2019
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 242
diff changeset
5 * Copyright (C) 2017-2019 Osimis S.A., Belgium
242
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
6 *
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
8 * modify it under the terms of the GNU Affero General Public License
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
9 * as published by the Free Software Foundation, either version 3 of
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
10 * the License, or (at your option) any later version.
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
11 *
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
12 * This program is distributed in the hope that it will be useful, but
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
15 * Affero General Public License for more details.
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
16 *
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
17 * You should have received a copy of the GNU Affero General Public License
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
19 **/
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
20
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
21
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
22 #pragma once
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
23
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
24 #include <boost/program_options.hpp>
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
25 #include <tuple>
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
26
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
27 #if ORTHANC_ENABLE_SDL == 1
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
28 #error this file shall be included only with the ORTHANC_ENABLE_SDL set to 0
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
29 #endif
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
30
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
31 namespace OrthancStone
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
32 {
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
33 // This class is used to generate boost program options from a dico.
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
34 // In a Wasm context, startup options are passed as URI arguments that
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
35 // are then passed to this class as a dico.
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
36 // This class regenerates a fake command-line and parses it to produce
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
37 // the same output as if the app was started at command-line.
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
38 class StartupParametersBuilder
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
39 {
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
40 typedef std::list<std::tuple<std::string, std::string>> StartupParameters;
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
41 StartupParameters startupParameters_;
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
42
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
43 public:
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
44
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
45 void Clear();
603
70992b38aa8a new routable logging system in STDIO mode + flag support (with no value) in StartupParametersBuilder + 80 col indent
Benjamin Golinvaux <bgo@osimis.io>
parents: 439
diff changeset
46 // Please note that if a parameter is a flag-style one, the value that
70992b38aa8a new routable logging system in STDIO mode + flag support (with no value) in StartupParametersBuilder + 80 col indent
Benjamin Golinvaux <bgo@osimis.io>
parents: 439
diff changeset
47 // is passed should be an empty string
242
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
48 void SetStartupParameter(const char* name, const char* value);
603
70992b38aa8a new routable logging system in STDIO mode + flag support (with no value) in StartupParametersBuilder + 80 col indent
Benjamin Golinvaux <bgo@osimis.io>
parents: 439
diff changeset
49 void GetStartupParameters(
70992b38aa8a new routable logging system in STDIO mode + flag support (with no value) in StartupParametersBuilder + 80 col indent
Benjamin Golinvaux <bgo@osimis.io>
parents: 439
diff changeset
50 boost::program_options::variables_map& parameters_,
70992b38aa8a new routable logging system in STDIO mode + flag support (with no value) in StartupParametersBuilder + 80 col indent
Benjamin Golinvaux <bgo@osimis.io>
parents: 439
diff changeset
51 const boost::program_options::options_description& options);
242
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
52 };
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
53
092db46c6291 improved SDL/Wasm unification
am@osimis.io
parents:
diff changeset
54 }