LibXR::STDIO Class Reference

STDIO interface for read/write ports. More...

#include <libxr_rw.hpp>

Collaboration diagram for LibXR::STDIO:

Static Public Member Functions
static int	Printf (const char *fmt,...)
	Prints a formatted string to the write port (like printf).

Static Public Attributes
static ReadPort *	read_ = nullptr
	Read port instance. 读取端口。
static WritePort *	write_ = nullptr
	Write port instance. 写入端口。
static LibXR::Mutex *	write_mutex_
	Write port mutex. 写入端口互斥锁。
static LibXR::WritePort::Stream *	write_stream_ = nullptr

Detailed Description

STDIO interface for read/write ports.

提供静态全局的输入输出接口绑定与缓冲区管理。

Definition at line 619 of file libxr_rw.hpp.

Member Function Documentation

Printf()

int STDIO::Printf ( const char * fmt, ... )

static

Prints a formatted string to the write port (like printf).

将格式化字符串发送至写入端口，类似 printf。

Parameters

fmt	The format string. 格式化字符串。
...	Variable arguments to be formatted. 需要格式化的参数。

Returns

Number of characters written, or negative on error. 成功返回写入的字符数，失败返回负数。

Definition at line 380 of file libxr_rw.cpp.

{
#if LIBXR_PRINTF_BUFFER_SIZE > 0
  if (!STDIO::write_ || !STDIO::write_->Writable())
  {
    return -1;
  }
 
  if (!write_mutex_)
  {
    write_mutex_ = new LibXR::Mutex();
  }
 
  LibXR::Mutex::LockGuard lock_guard(*write_mutex_);
 
  va_list args;
  va_start(args, fmt);
  int len = vsnprintf(STDIO::printf_buff_, LIBXR_PRINTF_BUFFER_SIZE, fmt, args);
  va_end(args);
 
  // Check result and limit length
  if (len < 0)
  {
    return -1;
  }
  if (static_cast<size_t>(len) >= LIBXR_PRINTF_BUFFER_SIZE)
  {
    len = LIBXR_PRINTF_BUFFER_SIZE - 1;
  }
 
  ConstRawData data = {reinterpret_cast<const uint8_t*>(STDIO::printf_buff_),
                       static_cast<size_t>(len)};
 
  static WriteOperation op;  // NOLINT
  auto ans = ErrorCode::OK;
  if (write_stream_ == nullptr)
  {
    ans = STDIO::write_->operator()(data, op);
  }
  else
  {
    (*write_stream_) << data;
    ans = write_stream_->Commit();
  }
 
  if (ans == ErrorCode::OK)
  {
    return len;
  }
  else
  {
    return -1;
  }
 
#else
  UNUSED(fmt);
  return 0;
#endif
}

Field Documentation

read_

ReadPort* LibXR::STDIO::read_ = nullptr

inlinestatic

Read port instance. 读取端口。

Definition at line 623 of file libxr_rw.hpp.

write_

WritePort* LibXR::STDIO::write_ = nullptr

inlinestatic

Write port instance. 写入端口。

Definition at line 624 of file libxr_rw.hpp.

write_mutex_

LibXR::Mutex* LibXR::STDIO::write_mutex_

inlinestatic

Initial value:

=
      nullptr

Write port mutex. 写入端口互斥锁。

Definition at line 625 of file libxr_rw.hpp.

write_stream_

LibXR::WritePort::Stream* LibXR::STDIO::write_stream_ = nullptr

inlinestatic

Definition at line 627 of file libxr_rw.hpp.

---

The documentation for this class was generated from the following files:

• src/core/libxr_rw.hpp
• src/core/libxr_rw.cpp