Class compiler_log_formatter . Boost , Boost.Test , Header <boost/test/output/compiler_log_formatter.hpp>

Class compiler_log_formatter

boost::unit_test::output::compiler_log_formatter — Log formatter for the Human Readable Format (HRF) log format.

Synopsis

// In header: <boost/test/output/compiler_log_formatter.hpp>

class compiler_log_formatter :
  public boost::unit_test::unit_test_log_formatter
{
public:
  // construct/copy/destruct
  compiler_log_formatter();
  // public member functions
  virtual void log_start(std::ostream &, counter_t);
  virtual void log_finish(std::ostream &);
  virtual void log_build_info(std::ostream &);
  virtual void test_unit_start(std::ostream &, test_unit const &);
  virtual void 
  test_unit_finish(std::ostream &, test_unit const &, unsigned long);
  virtual void 
  test_unit_skipped(std::ostream &, test_unit const &, const_string);
  virtual void 
  log_exception_start(std::ostream &, log_checkpoint_data const &, 
                      execution_exception const &);
  virtual void log_exception_finish(std::ostream &);
  virtual void 
  log_entry_start(std::ostream &, log_entry_data const &, log_entry_types);
  virtual void log_entry_value(std::ostream &, const_string);
  virtual void log_entry_value(std::ostream &, lazy_ostream const &);
  virtual void log_entry_finish(std::ostream &);
  virtual void entry_context_start(std::ostream &, log_level);
  virtual void log_entry_context(std::ostream &, const_string);
  virtual void entry_context_finish(std::ostream &);
  virtual void test_unit_skipped(std::ostream &, test_unit const &);
  virtual void test_unit_aborted(std::ostream &, test_unit const &);
  virtual void set_log_level(log_level);
  virtual log_level get_log_level() const;
  virtual std::string get_default_stream_description() const;
  // protected member functions
  virtual void print_prefix(std::ostream &, const_string, std::size_t);
};

Description

`compiler_log_formatter` public construct/copy/destruct

<
```
compiler_log_formatter();
```
>

`compiler_log_formatter` public member functions

```
virtual void log_start(std::ostream & os, counter_t test_cases_amount);
```
Invoked at the beginning of test module execution.
Смотрите также:
log_finish
Параметры:
<os>
output stream to write a messages to
test_cases_amount
total test case amount to be run
```
virtual void log_finish(std::ostream & os);
```
Ссылка на конец выполнения тестового модуля.
См. также:
log_start
Параметры:
<os>
output stream для записи сообщений в
Смотрите также:
log_start
Параметры:
<os>
выходной поток для записи сообщений в
[ORIG_END] -->
```
virtual void log_build_info(std::ostream & os);
```
Invoked when Unit Test Framework build information is requested.
Параметры:
<os>
выходной поток для записи сообщений в
```
virtual void test_unit_start(std::ostream & os, test_unit const & tu);
```
Invoked when test unit starts (either test suite or test case)
Смотрите также:
test_unit_finish
Параметры:
<os>
выходной поток для записи сообщений в
tu
test unit being started

virtual void 
test_unit_finish(std::ostream & os, test_unit const & tu, 
                 unsigned long elapsed);

Ссылается при завершении испытательного блока.

См. также:

test_unit_start

Параметры:

`elapsed`	время в микросекундах тратит на выполнение этого тестового блока
<`os`>	output stream для записи сообщений в
`tu`	Завершается тест

Смотрите также:

test_unit_start

Параметры:

`elapsed`	time in microseconds spend executing this test unit
<`os`>	выходной поток для записи сообщений в
`tu`	test unit being finished

[ORIG_END] -->

```
virtual void 
test_unit_skipped(std::ostream & os, test_unit const & tu, 
                  const_string reason);
```
Invoked if test unit skipped for any reason.
Параметры:
<os>
выходной поток для записи сообщений в
reason
explanation why was it skipped
tu
skipped test unit

virtualvoid
log_exception_start(std::ostream&os,log_checkpoint_dataconst&lcd,
                   execution_exceptionconst&ex);

>Называется, когда Unit Test Framework обнаруживает непойманное исключение.

Фрамворк называет эту функцию, когда обнаруживается непойманное исключение. За этим звонком следует контекстная информация:

один звонок<entry_context_start>,
столько звонков<log_entry_context>, сколько контекстных записей
один звонок<entry_context_finish>

Регистрация информации об исключении завершается звонком<log_exception_finish>.

Смотрите также:

log_exception_finish

Параметры:

<`ex`>	Информация о пойманном исключении
<`lcd`>	информация о последнем контрольно-пропускном пункте до срабатывания исключения
<`os`>	выходной поток для записи сообщений в

```
virtual void log_exception_finish(std::ostream & os);
```
Invoked when Unit Test Framework detects uncaught exception.
Call to this function finishes uncaught exception report.
Смотрите также:
log_exception_start
Параметры:
<os>
выходной поток для записи сообщений в
```
virtual void 
log_entry_start(std::ostream & os, log_entry_data const & led, 
                log_entry_types let);
```
Ссылка на Unit Test Framework для запуска новой записи журнала.
Запустить эту функцию запуска нового входа в систему. За ним следует серия вызовов log_entry_value и, наконец, вызов для log_entry_finish. Запись журнала может состоять из одного или нескольких значений, сообщаемых. Некоторые из этих значений будут простыми строками, в то время как другие могут быть сложными выражениями в виде «ленивого» шаблона выражения lazy_ostream.
См. также:
log_entry_ value, log_entry_finish
Note
Call to this function may happen before any call to test_unit_start or all calls to test_unit_finish as the framework might log error raised during global initialization/shutdown.
Параметры:
атрибуты входа
led
let
log тип входа log_entry_finish
<os>
output stream для записи сообщений в
Смотрите также:
log_entry_value, log_entry_finish
Note
call to this function may happen before any call to test_unit_start or all calls to test_unit_finish as the framework might log errors raised during global initialization/shutdown.
Параметры:
led
log entry attributes
let
log entry type log_entry_finish
<os>
выходной поток для записи сообщений в
[ORIG_END] -->
```
virtual void log_entry_value(std::ostream & os, const_string value);
```
Invoked by Unit Test Framework to report a log entry content.
This is one of two overloaded methods to report log entry content. This one is used to report plain string value.
Смотрите также:
log_entry_start, log_entry_finish
Параметры:
<os>
output stream to write a messages into.
value
log entry string value
```
virtual void log_entry_value(std::ostream & os, lazy_ostream const & value);
```
Ссылается на Unit Test Framework для отчета о вводе журнала.
Это один из двух перегруженных методов для сообщения содержимого входа в журнал. Этот используется для сообщения о некоторых сложных выражениях, передаваемых как шаблон выражения lazy_ostream. В большинстве случаев реализация по умолчанию, обеспечиваемая рамками, должна работать так, как есть (он просто превращает ленивое выражение в строку).
См. также:
log_entry_start, log_entry_finish
Параметры:
<os>
output stream для записи сообщений в
value
лог вход "lazy" значение
Смотрите также:
log_entry_start, log_entry_finish
Параметры:
<os>
выходной поток для записи сообщений в
value
log entry "lazy" value
[ORIG_END] -->
```
virtual void log_entry_finish(std::ostream & os);
```
Invoked by Unit Test Framework to finish a log entry report.
Смотрите также:
log_entry_start, log_entry_start
Параметры:
<os>
выходной поток для записи сообщений в
```
virtual void entry_context_start(std::ostream & os, log_level l);
```
Ссылается на Unit Test Framework для запуска отчета о входе в систему.
Unit Test Framework logs for failed assertions and uncaught exceptions context if one was defined by a test Module. Контекст состоит из нескольких «скопов», обозначенных описаниями сообщений, назначенных тестовым модулем с использованием BOOST_TEST_INFO/BOOST_TEST_CONTEXT.
См. также:
log_entry_context, entry_context_finish
Параметры:
l
entry log_level, который будет использоваться для настройки сообщения
<os>
output stream для записи сообщений в
Смотрите также:
log_entry_context, entry_context_finish
Параметры:
l
entry log_level, to be used to fine tune the message
<os>
выходной поток для записи сообщений в
[ORIG_END] -->
```
virtual void log_entry_context(std::ostream & os, const_string value);
```
Invoked by Unit Test Framework to report log entry context "scope" description.
Each "scope" description is reported by separate call to log_entry_context.
Смотрите также:
log_entry_start, entry_context_finish
Параметры:
<os>
выходной поток для записи сообщений в
value
context "scope" description
```
virtual void entry_context_finish(std::ostream & os);
```
Ссылается на Unit Test Framework, чтобы закончить отчет контекста входа журнала.
См. также:
log_entry_start, entry_context_context
Параметры:
<os>
output stream для записи сообщений в
Смотрите также:
log_entry_start, entry_context_context
Параметры:
<os>
выходной поток для записи сообщений в
[ORIG_END] -->
```
virtualvoidtest_unit_skipped(std::ostream&os,test_unitconst&tu);
```
Устаревшая версия этого интерфейса.
<
```
virtualvoidtest_unit_aborted(std::ostream&os,test_unitconst&tu);
```
>Называется, когда испытательный блок прерывается.
```
virtualvoidset_log_level(log_levelnew_log_level);
```
Устанавливает уровень журнала регистратора/формата.
Некоторые лесозаготовители должны самостоятельно управлять уровнем журнала. Эта функция позволяет реализации решить эту проблему.
С момента подъема 1.62.
```
virtuallog_levelget_log_level()const;
```
Возвращает уровень журнала регистратора/формата.
С момента повышения 1.62.
```
virtualstd::stringget_default_stream_description()const;
```
Возвращает поток по умолчанию для этого регистратора.
Возвращенная строка описывает поток так, как если бы он был передан из параметра командной строки"--log_sink". В этом отношенииstdoutиstderrимеют особое значение, указывающее стандартный выходной поток или поток ошибок соответственно.
С момента повышения 1.62.

`compiler_log_formatter` protected member functions

virtualvoidprint_prefix(std::ostream&,const_stringfile,std::size_tline);

Статья Class compiler_log_formatter раздела Boost.Test Header <boost/test/output/compiler_log_formatter.hpp> может быть полезна для разработчиков на c++ и boost.

Class compiler_log_formatter

Boost , Boost.Test , Header <boost/test/output/compiler_log_formatter.hpp>

Boost C++ Libraries

Class compiler_log_formatter

Synopsis

Description

compiler_log_formatter public construct/copy/destruct

compiler_log_formatter public member functions

compiler_log_formatter protected member functions

`compiler_log_formatter` public construct/copy/destruct

`compiler_log_formatter` public member functions

`compiler_log_formatter` protected member functions