xref: /freebsd/contrib/kyua/utils/cmdline/globals.cpp (revision 25ecdc7d52770caf1c9b44b5ec11f468f6b636f3)
1 // Copyright 2010 The Kyua Authors.
2 // All rights reserved.
3 //
4 // Redistribution and use in source and binary forms, with or without
5 // modification, are permitted provided that the following conditions are
6 // met:
7 //
8 // * Redistributions of source code must retain the above copyright
9 //   notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 //   notice, this list of conditions and the following disclaimer in the
12 //   documentation and/or other materials provided with the distribution.
13 // * Neither the name of Google Inc. nor the names of its contributors
14 //   may be used to endorse or promote products derived from this software
15 //   without specific prior written permission.
16 //
17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 
29 #include "utils/cmdline/globals.hpp"
30 
31 #include "utils/format/macros.hpp"
32 #include "utils/logging/macros.hpp"
33 #include "utils/fs/path.hpp"
34 #include "utils/sanity.hpp"
35 
36 namespace cmdline = utils::cmdline;
37 
38 namespace {
39 
40 
41 /// The name of the binary used to execute the program.
42 static std::string Progname;
43 
44 
45 }  // anonymous namespace
46 
47 
48 /// Initializes the global state of the CLI.
49 ///
50 /// This function can only be called once during the execution of a program,
51 /// unless override_for_testing is set to true.
52 ///
53 /// \param argv0 The value of argv[0]; i.e. the program name.
54 /// \param override_for_testing Should always be set to false unless for tests
55 ///     of this functionality, which may set this to true to redefine internal
56 ///     state.
57 void
58 cmdline::init(const char* argv0, const bool override_for_testing)
59 {
60     if (!override_for_testing)
61         PRE_MSG(Progname.empty(), "cmdline::init called more than once");
62     Progname = utils::fs::path(argv0).leaf_name();
63     LD(F("Program name: %s") % Progname);
64     POST(!Progname.empty());
65 }
66 
67 
68 /// Gets the program name.
69 ///
70 /// \pre init() must have been called in advance.
71 ///
72 /// \return The program name.
73 const std::string&
74 cmdline::progname(void)
75 {
76     PRE_MSG(!Progname.empty(), "cmdline::init not called yet");
77     return Progname;
78 }
79