1 //  (C) Copyright Gennadiy Rozental 2001.
2 //  Distributed under the Boost Software License, Version 1.0.
3 //  (See accompanying file LICENSE_1_0.txt or copy at
4 //  http://www.boost.org/LICENSE_1_0.txt)
5 
6 //  See http://www.boost.org/libs/test for the library home page.
7 //
8 /// @file
9 /// @brief Provides access to various Unit Test Framework runtime parameters
10 ///
11 /// Primarily for use by the framework itself
12 // ***************************************************************************
13 
14 #ifndef BOOST_TEST_UNIT_TEST_PARAMETERS_HPP_071894GER
15 #define BOOST_TEST_UNIT_TEST_PARAMETERS_HPP_071894GER
16 
17 // Boost.Test
18 #include <boost/test/detail/global_typedef.hpp>
19 #include <boost/test/utils/runtime/argument.hpp>
20 #include <boost/make_shared.hpp>
21 
22 // STL
23 #include <iostream>
24 #include <fstream>
25 
26 #include <boost/test/detail/suppress_warnings.hpp>
27 
28 //____________________________________________________________________________//
29 
30 namespace boost {
31 namespace unit_test {
32 namespace runtime_config {
33 
34 // ************************************************************************** //
35 // **************                 runtime_config               ************** //
36 // ************************************************************************** //
37 
38 // UTF parameters
39 BOOST_TEST_DECL extern std::string AUTO_START_DBG;
40 BOOST_TEST_DECL extern std::string BREAK_EXEC_PATH;
41 BOOST_TEST_DECL extern std::string BUILD_INFO;
42 BOOST_TEST_DECL extern std::string CATCH_SYS_ERRORS;
43 BOOST_TEST_DECL extern std::string COLOR_OUTPUT;
44 BOOST_TEST_DECL extern std::string DETECT_FP_EXCEPT;
45 BOOST_TEST_DECL extern std::string DETECT_MEM_LEAKS;
46 BOOST_TEST_DECL extern std::string LIST_CONTENT;
47 BOOST_TEST_DECL extern std::string LIST_LABELS;
48 BOOST_TEST_DECL extern std::string COMBINED_LOGGER;
49 BOOST_TEST_DECL extern std::string LOG_FORMAT;
50 BOOST_TEST_DECL extern std::string LOG_LEVEL;
51 BOOST_TEST_DECL extern std::string LOG_SINK;
52 BOOST_TEST_DECL extern std::string OUTPUT_FORMAT;
53 BOOST_TEST_DECL extern std::string RANDOM_SEED;
54 BOOST_TEST_DECL extern std::string REPORT_FORMAT;
55 BOOST_TEST_DECL extern std::string REPORT_LEVEL;
56 BOOST_TEST_DECL extern std::string REPORT_MEM_LEAKS;
57 BOOST_TEST_DECL extern std::string REPORT_SINK;
58 BOOST_TEST_DECL extern std::string RESULT_CODE;
59 BOOST_TEST_DECL extern std::string RUN_FILTERS;
60 BOOST_TEST_DECL extern std::string SAVE_TEST_PATTERN;
61 BOOST_TEST_DECL extern std::string SHOW_PROGRESS;
62 BOOST_TEST_DECL extern std::string USE_ALT_STACK;
63 BOOST_TEST_DECL extern std::string WAIT_FOR_DEBUGGER;
64 
65 BOOST_TEST_DECL void init( int& argc, char** argv );
66 
67 // ************************************************************************** //
68 // **************              runtime_param::get              ************** //
69 // ************************************************************************** //
70 
71 /// Access to arguments
72 BOOST_TEST_DECL runtime::arguments_store const& argument_store();
73 
74 template<typename T>
75 inline T const&
get(runtime::cstring parameter_name)76 get( runtime::cstring parameter_name )
77 {
78     return argument_store().get<T>( parameter_name );
79 }
80 
has(runtime::cstring parameter_name)81 inline bool has( runtime::cstring parameter_name )
82 {
83     return argument_store().has( parameter_name );
84 }
85 
86 /// For public access
87 BOOST_TEST_DECL bool save_pattern();
88 
89 // ************************************************************************** //
90 // **************                  stream_holder               ************** //
91 // ************************************************************************** //
92 
93 class stream_holder {
94 public:
95     // Constructor
stream_holder(std::ostream & default_stream=std::cout)96     explicit        stream_holder( std::ostream& default_stream = std::cout)
97     : m_stream( &default_stream )
98     {
99     }
100 
setup(const const_string & stream_name)101     void            setup( const const_string& stream_name )
102     {
103         if(stream_name.empty())
104             return;
105 
106         if( stream_name == "stderr" )
107             m_stream = &std::cerr;
108         else if( stream_name == "stdout" )
109             m_stream = &std::cout;
110         else {
111             m_file = boost::make_shared<std::ofstream>();
112             m_file->open( std::string(stream_name.begin(), stream_name.end()).c_str() );
113             m_stream = m_file.get();
114         }
115     }
116 
117     // Access methods
ref() const118     std::ostream&   ref() const { return *m_stream; }
119 
120 private:
121     // Data members
122     boost::shared_ptr<std::ofstream>   m_file;
123     std::ostream*   m_stream;
124 };
125 
126 } // namespace runtime_config
127 } // namespace unit_test
128 } // namespace boost
129 
130 //____________________________________________________________________________//
131 
132 #include <boost/test/detail/enable_warnings.hpp>
133 
134 #endif // BOOST_TEST_UNIT_TEST_PARAMETERS_HPP_071894GER
135