HPCToolkit
Args.hpp
Go to the documentation of this file.
1 // -*-Mode: C++;-*-
2 
3 // * BeginRiceCopyright *****************************************************
4 //
5 // $HeadURL: https://hpctoolkit.googlecode.com/svn/branches/hpctoolkit-hpcserver/src/tool/hpcserver/Args.hpp $
6 // $Id: Args.hpp 4283 2013-07-02 20:13:13Z felipet1326@gmail.com $
7 //
8 // --------------------------------------------------------------------------
9 // Part of HPCToolkit (hpctoolkit.org)
10 //
11 // Information about sources of support for research and development of
12 // HPCToolkit is at 'hpctoolkit.org' and in 'README.Acknowledgments'.
13 // --------------------------------------------------------------------------
14 //
15 // Copyright ((c)) 2002-2019, Rice University
16 // All rights reserved.
17 //
18 // Redistribution and use in source and binary forms, with or without
19 // modification, are permitted provided that the following conditions are
20 // met:
21 //
22 // * Redistributions of source code must retain the above copyright
23 // notice, this list of conditions and the following disclaimer.
24 //
25 // * Redistributions in binary form must reproduce the above copyright
26 // notice, this list of conditions and the following disclaimer in the
27 // documentation and/or other materials provided with the distribution.
28 //
29 // * Neither the name of Rice University (RICE) nor the names of its
30 // contributors may be used to endorse or promote products derived from
31 // this software without specific prior written permission.
32 //
33 // This software is provided by RICE and contributors "as is" and any
34 // express or implied warranties, including, but not limited to, the
35 // implied warranties of merchantability and fitness for a particular
36 // purpose are disclaimed. In no event shall RICE or contributors be
37 // liable for any direct, indirect, incidental, special, exemplary, or
38 // consequential damages (including, but not limited to, procurement of
39 // substitute goods or services; loss of use, data, or profits; or
40 // business interruption) however caused and on any theory of liability,
41 // whether in contract, strict liability, or tort (including negligence
42 // or otherwise) arising in any way out of the use of this software, even
43 // if advised of the possibility of such damage.
44 //
45 // ******************************************************* EndRiceCopyright *
46 
47 //***************************************************************************
48 //
49 // File:
50 // $HeadURL: https://hpctoolkit.googlecode.com/svn/branches/hpctoolkit-hpcserver/src/tool/hpcserver/Args.hpp $
51 //
52 // Purpose:
53 // [The purpose of this file]
54 //
55 // Description:
56 // [The set of functions, macros, etc. defined in the file]
57 //
58 //***************************************************************************
59 
60 #ifndef Args_hpp
61 #define Args_hpp
62 
63 //************************* System Include Files ****************************
64 
65 #include <iostream>
66 #include <string>
67 
68 //*************************** User Include Files ****************************
69 
70 #include <include/uint.h>
72 
73 //*************************** Forward Declarations **************************
74 
75 //***************************************************************************
76 
77 class Args {
78 public:
79  Args();
80  Args(int argc, const char* const argv[]);
81  ~Args();
82 
83  // Parse the command line
84  void
85  parse(int argc, const char* const argv[]);
86 
87  // Version and Usage information
88  void
89  printVersion(std::ostream& os) const;
90 
91  void
92  printUsage(std::ostream& os) const;
93 
94  // Error
95  void
96  printError(std::ostream& os, const char* msg) const;
97 
98  void
99  printError(std::ostream& os, const std::string& msg) const;
100 
101  // Dump
102  void
103  dump(std::ostream& os = std::cerr) const;
104 
105  void
106  ddump() const;
107 
108 public:
109  // Parsed Data: Command
110  const std::string& getCmd() const;
111 
112  // Parsed Data: optional arguments
113  int mainPort; // default: 21590
114  int xmlPort; // default: 0
115  bool compression; // default: true
116 
117 private:
118  void
119  Ctor();
120 
121 private:
124 };
125 
126 #endif // Args_hpp
Definition: Args.hpp:79
~Args()
Definition: Args.cpp:173
void printUsage(std::ostream &os) const
Definition: Args.cpp:186
void Ctor()
Definition: Args.cpp:162
CmdLineParser parser
Definition: Args.hpp:120
bool compression
Definition: Args.hpp:115
void printVersion(std::ostream &os) const
Definition: Args.cpp:179
void parse(int argc, const char *const argv[])
Definition: Args.cpp:208
int mainPort
Definition: Args.hpp:113
Args()
Definition: Args.cpp:150
void ddump() const
Definition: Args.cpp:305
void printError(std::ostream &os, const char *msg) const
Definition: Args.cpp:194
static CmdLineParser::OptArgDesc optArgs[]
Definition: Args.hpp:119
const std::string & getCmd() const
Definition: Args.hpp:102
void dump(std::ostream &os=std::cerr) const
Definition: Args.cpp:296
int xmlPort
Definition: Args.hpp:114