YSTest: platform_ex 命名空间参考

YSTest PreAlpha_b800_20170810 The YSLib Test Project

- 首页
- 相关页面
- 模块
- 命名空间
- 类
- 文件

- 命名空间列表
- 命名空间成员

命名空间 | 类 | 函数
platform_ex 命名空间参考
Top-level Platform Namespaces

平台扩展命名空间。 更多...

## 命名空间

| Android
| Android 平台扩展接口。
| Windows
| Windows 平台扩展接口。

## 类

class | COM
| COM 全局状态。 更多...
class | COMException
| COM 异常基类。 更多...

## 函数

YF_API const platform::KeyInput & | FetchKeyState ()
| 取按键状态。 更多...
YF_API const platform::KeyInput & | FetchOldKeyState ()
| 取上一次更新的按键状态。 更多...
YF_API platform::KeyInput | FetchKeyDownState ()
| 取键按下状态。 更多...
YF_API platform::KeyInput | FetchKeyUpState ()
| 取键释放状态。 更多...
YF_API void | ClearKeyStates ()
| 清除按键缓冲。 更多...
YF_API void | UpdateKeyStates ()
| 更新按键状态。 更多...
u16string | MakePathStringU (const char *s)
| MakePathStringU
| YB_NONNULL (1) PDefH(u16string
| 构造适合表示路径的 `char16_t` 字符串。 更多...
const char16_t *s | ImplRet (platform::Nonnull(s)) inline PDefH(const u16string &
const char16_t *s const u16string &s | ImplRet (s) YF_API YB_NONNULL(1) u16string MakePathStringU(const char *)
template<class _iCOM1 , class _iCOM2 >
PDefH(void, EnsureNonNull, void *p) ImplExpr(p?void() boo | operator== )(const COMPtr< _iCOM1 > &x, const COMPtr< _iCOM2 > &y) ynothrow
| 检查指针值，若为空则抛出 COMException 。 更多...
inline::HRESULT | CheckHResult (::HRESULT h)
| 检查 ::HRESULT 值，若表示失败则抛出 COMException 。 更多...
template<class _iCOM >
bool | operator== (const COMPtr< _iCOM > &x, std::nullptr_t) ynothrow
template<class _iCOM >
bool | operator== (std::nullptr_t, const COMPtr< _iCOM > &x) ynothrow
template<class _iCOM1 , class _iCOM2 >
bool | operator!= (const COMPtr< _iCOM1 > &x, const COMPtr< _iCOM2 > &y) ynothrow
template<class _iCOM >
bool | operator!= (const COMPtr< _iCOM > &x, std::nullptr_t) ynothrow
template<class _iCOM >
bool | operator!= (std::nullptr_t, const COMPtr< _iCOM > &x) ynothrow
template<class _iCOM1 , class _iCOM2 >
bool | operator< (const COMPtr< _iCOM1 > &x, const COMPtr< _iCOM2 > &y) ynothrow
template<class _iCOM >
void | Attach (COMPtr< _iCOM > &ptr, typename COMPtr< _iCOM >::InterfaceType *p) ynothrow
template<class _iCOM >
_iCOM * | Detach (COMPtr< _iCOM > &ptr) ynothrow
template<class _iCOM >
unsigned long | Reset (COMPtr< _iCOM > &ptr) ynothrow

## 详细描述

平台扩展命名空间。

注解
  为便于移植，部分平台扩展接口保留至平台中立文件，依赖性按后者处理。

## 函数说明

template<class _iCOM >

void platform_ex::Attach | ( | COMPtr< _iCOM > & | ptr,
|  | typename COMPtr< _iCOM >::InterfaceType * | p
| ) |  |

在文件 COM.h 第 382 行定义.

参考 ystdex::ref(), yassume , 以及 yunused.

函数调用图:

inline ::HRESULT platform_ex::CheckHResult | ( | ::HRESULT | h | ) |

检查 ::HRESULT 值，若表示失败则抛出 COMException 。

返回
  表示成功的值。

自从
  build 563

在文件 COM.h 第 89 行定义.

void platform_ex::ClearKeyStates | ( |  | ) |

清除按键缓冲。

自从
  build 299

在文件 Input.cpp 第 159 行定义.

参考 platform::Deref(), ystdex::reset() , 以及 yunseq.

函数调用图:
template<class _iCOM >

_iCOM* platform_ex::Detach | ( | COMPtr< _iCOM > & | ptr | ) |

在文件 COM.h 第 396 行定义.

参考 CHRLib::p().

函数调用图:

platform::KeyInput platform_ex::FetchKeyDownState | ( |  | ) |

取键按下状态。

自从
  build 299

在文件 Input.cpp 第 143 行定义.

参考自 YSLib::Devices::InputManager::DispatchInput() , 以及 platform::WaitForInput().

这是这个函数的调用关系图:

const platform::KeyInput & platform_ex::FetchKeyState | ( |  | ) |

取按键状态。

自从
  build 321

在文件 Input.cpp 第 127 行定义.

参考自 YSLib::Devices::InputManager::DispatchInput(), YSLib::Devices::InputManager::Update() , 以及 YSLib::DS::ShlDS::WrapForSwapScreens().

这是这个函数的调用关系图:

platform::KeyInput platform_ex::FetchKeyUpState | ( |  | ) |

取键释放状态。

自从
  build 299

在文件 Input.cpp 第 151 行定义.

参考自 YSLib::Devices::InputManager::DispatchInput().

这是这个函数的调用关系图:

const platform::KeyInput & platform_ex::FetchOldKeyState | ( |  | ) |

取上一次更新的按键状态。

自从
  build 321

在文件 Input.cpp 第 135 行定义.

const char16_t* s platform_ex::ImplRet | ( | platform:: | Nonnulls | ) | const

const char16_t* s const u16string& s platform_ex::ImplRet | ( | s |  | ) | const

前置条件
  间接断言：参数非空。

u16string platform_ex::MakePathStringU | ( | const char * | s | ) |

在文件 FileIO.cpp 第 1305 行定义.

参考 CHRLib::MakeUCS2LE().

函数调用图:
template<class _iCOM1 , class _iCOM2 >

bool platform_ex::operator!= | ( | const COMPtr< _iCOM1 > & | x,
|  | const COMPtr< _iCOM2 > & | y
| ) |  |

inline

在文件 COM.h 第 351 行定义.

参考 NPL::x , 以及 YSLib::UI::y.

template<class _iCOM >

bool platform_ex::operator!= | ( | const COMPtr< _iCOM > & | x,
|  | std::nullptr_t |
| ) |  |

inline

在文件 COM.h 第 357 行定义.

template<class _iCOM >

bool platform_ex::operator!= | ( | std::nullptr_t | ,
|  | const COMPtr< _iCOM > & | x
| ) |  |

inline

在文件 COM.h 第 364 行定义.

参考 NPL::x.

template<class _iCOM1 , class _iCOM2 >

bool platform_ex::operator< | ( | const COMPtr< _iCOM1 > & | x,
|  | const COMPtr< _iCOM2 > & | y
| ) |  |

inline

在文件 COM.h 第 371 行定义.

参考 YSLib::UI::y.

template<class _iCOM >

bool platform_ex::operator== | ( | const COMPtr< _iCOM > & | x,
|  | std::nullptr_t |
| ) |  |

inline

在文件 COM.h 第 338 行定义.

template<class _iCOM >

bool platform_ex::operator== | ( | std::nullptr_t | ,
|  | const COMPtr< _iCOM > & | x
| ) |  |

inline

在文件 COM.h 第 344 行定义.

参考 NPL::x.

template<class _iCOM >

unsigned long platform_ex::Reset | ( | COMPtr< _iCOM > & | ptr | ) |

在文件 COM.h 第 406 行定义.

参考自 YSLib::UI::SequenceViewer::AdjustForContent().

这是这个函数的调用关系图:

void platform_ex::UpdateKeyStates | ( |  | ) |

更新按键状态。

自从
  build 299

在文件 Input.cpp 第 170 行定义.

参考 YSLib::i , 以及 ystdex::swap().

参考自 YSLib::Devices::InputManager::Update() , 以及 platform::WaitForInput().

函数调用图:

这是这个函数的调用关系图:

platform_ex::YB_NONNULL | ( | 1 |  | ) |

inline

构造适合表示路径的 `char16_t` 字符串。

自从
  build 706

注解
  字符类型非 `char16_t` 时转换。

前置条件
  间接断言：参数非空。

## 变量说明

const char16_t *s platform_ex::MakePathStringU

在文件 FileIO.h 第 1443 行定义.

参考自 platform::HDirectory::operator u16string(), platform::ReadLink() , 以及 platform::ugetcwd().

template<class _iCOM1 , class _iCOM2 >

PDefH (void, EnsureNonNull, void* p) ImplExpr(p ? void() boo platform_ex::operator==) (const COMPtr< _iCOM1 > &x, const COMPtr< _iCOM2 > &y) ynothrow

inline

检查指针值，若为空则抛出 COMException 。

自从
  build 563

COM 指针。

警告
  非虚析构。

异常

  COMException | 转换失败。

自从
  build 563

在文件 COM.h 第 328 行定义.