Skip to content

Commit

Permalink
styles: API 宏格式化
Browse files Browse the repository at this point in the history
  • Loading branch information
MistEO committed Mar 6, 2024
1 parent 3e5f699 commit 814f048
Show file tree
Hide file tree
Showing 23 changed files with 159 additions and 166 deletions.
44 changes: 22 additions & 22 deletions include/MaaFramework/Instance/MaaController.h
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ extern "C"
* @param callback_arg The callback arg that will be passed to the callback function.
* @return MaaControllerHandle The handle of the created controller instance.
*/
MaaControllerHandle MAA_FRAMEWORK_API MaaAdbControllerCreate(
MAA_FRAMEWORK_API MaaControllerHandle MaaAdbControllerCreate(
MaaStringView adb_path,
MaaStringView address,
MaaAdbControllerType type,
Expand All @@ -49,7 +49,7 @@ extern "C"
* @param callback_arg The callback arg that will be passed to the callback function.
* @return MaaControllerHandle The handle of the created controller instance.
*/
MaaControllerHandle MAA_FRAMEWORK_API MaaWin32ControllerCreate(
MAA_FRAMEWORK_API MaaControllerHandle MaaWin32ControllerCreate(
MaaWin32Hwnd hWnd,
MaaWin32ControllerType type,
MaaControllerCallback callback,
Expand All @@ -67,7 +67,7 @@ extern "C"
* @param callback_arg The callback arg that will be passed to the callback function.
* @return MaaControllerHandle The handle of the created controller instance.
*/
MaaControllerHandle MAA_FRAMEWORK_API MaaAdbControllerCreateV2(
MAA_FRAMEWORK_API MaaControllerHandle MaaAdbControllerCreateV2(
MaaStringView adb_path,
MaaStringView address,
MaaAdbControllerType type,
Expand All @@ -85,21 +85,21 @@ extern "C"
* @param callback_arg The callback arg that will be passed to the callback function.
* @return MaaControllerHandle The handle of the created controller instance.
*/
MaaControllerHandle MAA_FRAMEWORK_API MaaCustomControllerCreate(
MAA_FRAMEWORK_API MaaControllerHandle MaaCustomControllerCreate(
MaaCustomControllerHandle handle,
MaaTransparentArg handle_arg,
MaaControllerCallback callback,
MaaCallbackTransparentArg callback_arg);

MaaControllerHandle MAA_FRAMEWORK_API MaaThriftControllerCreate(
MAA_FRAMEWORK_API MaaControllerHandle MaaThriftControllerCreate(
MaaThriftControllerType type,
MaaStringView host,
int32_t port,
MaaStringView config,
MaaControllerCallback callback,
MaaCallbackTransparentArg callback_arg);

MaaControllerHandle MAA_FRAMEWORK_API MaaDbgControllerCreate(
MAA_FRAMEWORK_API MaaControllerHandle MaaDbgControllerCreate(
MaaStringView read_path,
MaaStringView write_path,
MaaDbgControllerType type,
Expand All @@ -112,7 +112,7 @@ extern "C"
*
* @param ctrl
*/
void MAA_FRAMEWORK_API MaaControllerDestroy(MaaControllerHandle ctrl);
MAA_FRAMEWORK_API void MaaControllerDestroy(MaaControllerHandle ctrl);

/**
* @brief Set options for a given controller instance.
Expand All @@ -126,7 +126,7 @@ extern "C"
* @param val_size The size of the option value.
* @return MaaBool Whether the option is set successfully.
*/
MaaBool MAA_FRAMEWORK_API MaaControllerSetOption(
MAA_FRAMEWORK_API MaaBool MaaControllerSetOption(
MaaControllerHandle ctrl, MaaCtrlOption key, MaaOptionValue value, MaaOptionValueSize val_size);

/**
Expand All @@ -136,25 +136,25 @@ extern "C"
* @{
*/

MaaCtrlId MAA_FRAMEWORK_API MaaControllerPostConnection(MaaControllerHandle ctrl);
MAA_FRAMEWORK_API MaaCtrlId MaaControllerPostConnection(MaaControllerHandle ctrl);

MaaCtrlId MAA_FRAMEWORK_API MaaControllerPostClick(MaaControllerHandle ctrl, int32_t x, int32_t y);
MAA_FRAMEWORK_API MaaCtrlId MaaControllerPostClick(MaaControllerHandle ctrl, int32_t x, int32_t y);

MaaCtrlId MAA_FRAMEWORK_API MaaControllerPostSwipe(
MAA_FRAMEWORK_API MaaCtrlId MaaControllerPostSwipe(
MaaControllerHandle ctrl, int32_t x1, int32_t y1, int32_t x2, int32_t y2, int32_t duration);

MaaCtrlId MAA_FRAMEWORK_API MaaControllerPostPressKey(MaaControllerHandle ctrl, int32_t keycode);
MAA_FRAMEWORK_API MaaCtrlId MaaControllerPostPressKey(MaaControllerHandle ctrl, int32_t keycode);

MaaCtrlId MAA_FRAMEWORK_API MaaControllerPostInputText(MaaControllerHandle ctrl, MaaStringView text);
MAA_FRAMEWORK_API MaaCtrlId MaaControllerPostInputText(MaaControllerHandle ctrl, MaaStringView text);

MaaCtrlId MAA_FRAMEWORK_API
MAA_FRAMEWORK_API MaaCtrlId
MaaControllerPostTouchDown(MaaControllerHandle ctrl, int32_t contact, int32_t x, int32_t y, int32_t pressure);
MaaCtrlId MAA_FRAMEWORK_API
MAA_FRAMEWORK_API MaaCtrlId
MaaControllerPostTouchMove(MaaControllerHandle ctrl, int32_t contact, int32_t x, int32_t y, int32_t pressure);

MaaCtrlId MAA_FRAMEWORK_API MaaControllerPostTouchUp(MaaControllerHandle ctrl, int32_t contact);
MAA_FRAMEWORK_API MaaCtrlId MaaControllerPostTouchUp(MaaControllerHandle ctrl, int32_t contact);

MaaCtrlId MAA_FRAMEWORK_API MaaControllerPostScreencap(MaaControllerHandle ctrl);
MAA_FRAMEWORK_API MaaCtrlId MaaControllerPostScreencap(MaaControllerHandle ctrl);

/** @} */

Expand All @@ -165,7 +165,7 @@ extern "C"
* @param id
* @return MaaStatus The status of the request.
*/
MaaStatus MAA_FRAMEWORK_API MaaControllerStatus(MaaControllerHandle ctrl, MaaCtrlId id);
MAA_FRAMEWORK_API MaaStatus MaaControllerStatus(MaaControllerHandle ctrl, MaaCtrlId id);

/**
* @brief Wait for the request identified by the given id to complete.
Expand All @@ -174,15 +174,15 @@ extern "C"
* @param id
* @return MaaStatus The status of the request.
*/
MaaStatus MAA_FRAMEWORK_API MaaControllerWait(MaaControllerHandle ctrl, MaaCtrlId id);
MAA_FRAMEWORK_API MaaStatus MaaControllerWait(MaaControllerHandle ctrl, MaaCtrlId id);

/**
* @brief Check if the controller is connected.
*
* @param ctrl
* @return MaaBool
*/
MaaBool MAA_FRAMEWORK_API MaaControllerConnected(MaaControllerHandle ctrl);
MAA_FRAMEWORK_API MaaBool MaaControllerConnected(MaaControllerHandle ctrl);

/**
* @brief Get the image buffer of the last screencap request.
Expand All @@ -192,7 +192,7 @@ extern "C"
*
* @return MaaBool Whether the image buffer is retrieved successfully.
*/
MaaBool MAA_FRAMEWORK_API MaaControllerGetImage(MaaControllerHandle ctrl, MaaImageBufferHandle buffer);
MAA_FRAMEWORK_API MaaBool MaaControllerGetImage(MaaControllerHandle ctrl, MaaImageBufferHandle buffer);

/**
* @brief Get the UUID of the controller.
Expand All @@ -202,7 +202,7 @@ extern "C"
*
* @return MaaBool Whether the resolution is retrieved successfully.
*/
MaaBool MAA_FRAMEWORK_API MaaControllerGetUUID(MaaControllerHandle ctrl, MaaStringBufferHandle buffer);
MAA_FRAMEWORK_API MaaBool MaaControllerGetUUID(MaaControllerHandle ctrl, MaaStringBufferHandle buffer);

#ifdef __cplusplus
}
Expand Down
42 changes: 21 additions & 21 deletions include/MaaFramework/Instance/MaaInstance.h
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,14 @@ extern "C"
* @param callback_arg The callback arg that will be passed to the callback function.
* @return MaaInstanceHandle
*/
MaaInstanceHandle MAA_FRAMEWORK_API MaaCreate(MaaInstanceCallback callback, MaaCallbackTransparentArg callback_arg);
MAA_FRAMEWORK_API MaaInstanceHandle MaaCreate(MaaInstanceCallback callback, MaaCallbackTransparentArg callback_arg);

/**
* @brief Free the instance.
*
* @param inst
*/
void MAA_FRAMEWORK_API MaaDestroy(MaaInstanceHandle inst);
MAA_FRAMEWORK_API void MaaDestroy(MaaInstanceHandle inst);

/**
* @brief Set options for a given instance.
Expand All @@ -45,7 +45,7 @@ extern "C"
* @param val_size The size of the option value.
* @return MaaBool Whether the option is set successfully.
*/
MaaBool MAA_FRAMEWORK_API
MAA_FRAMEWORK_API MaaBool
MaaSetOption(MaaInstanceHandle inst, MaaInstOption key, MaaOptionValue value, MaaOptionValueSize val_size);

/**
Expand All @@ -57,7 +57,7 @@ extern "C"
* @param res
* @return MaaBool
*/
MaaBool MAA_FRAMEWORK_API MaaBindResource(MaaInstanceHandle inst, MaaResourceHandle res);
MAA_FRAMEWORK_API MaaBool MaaBindResource(MaaInstanceHandle inst, MaaResourceHandle res);

/**
* @brief Bind the instance to an initialized controller.
Expand All @@ -68,15 +68,15 @@ extern "C"
* @param ctrl
* @return MaaBool
*/
MaaBool MAA_FRAMEWORK_API MaaBindController(MaaInstanceHandle inst, MaaControllerHandle ctrl);
MAA_FRAMEWORK_API MaaBool MaaBindController(MaaInstanceHandle inst, MaaControllerHandle ctrl);

/**
* @brief Check if the instance is initialized.
*
* @param inst
* @return MaaBool
*/
MaaBool MAA_FRAMEWORK_API MaaInited(MaaInstanceHandle inst);
MAA_FRAMEWORK_API MaaBool MaaInited(MaaInstanceHandle inst);

/**
* @brief Register a custom recognizer to the instance.
Expand All @@ -89,7 +89,7 @@ extern "C"
* @param recognizer_arg
* @return MaaBool
*/
MaaBool MAA_FRAMEWORK_API MaaRegisterCustomRecognizer(
MAA_FRAMEWORK_API MaaBool MaaRegisterCustomRecognizer(
MaaInstanceHandle inst,
MaaStringView name,
MaaCustomRecognizerHandle recognizer,
Expand All @@ -102,15 +102,15 @@ extern "C"
* @param name The name of the recognizer when it was registered.
* @return MaaBool
*/
MaaBool MAA_FRAMEWORK_API MaaUnregisterCustomRecognizer(MaaInstanceHandle inst, MaaStringView name);
MAA_FRAMEWORK_API MaaBool MaaUnregisterCustomRecognizer(MaaInstanceHandle inst, MaaStringView name);

/**
* @brief Clear all custom recognizers registered to the instance.
*
* @param inst
* @return MaaBool
*/
MaaBool MAA_FRAMEWORK_API MaaClearCustomRecognizer(MaaInstanceHandle inst);
MAA_FRAMEWORK_API MaaBool MaaClearCustomRecognizer(MaaInstanceHandle inst);

/**
* @brief Register a custom action to the instance.
Expand All @@ -123,7 +123,7 @@ extern "C"
* @param action_arg
* @return MaaBool
*/
MaaBool MAA_FRAMEWORK_API MaaRegisterCustomAction(
MAA_FRAMEWORK_API MaaBool MaaRegisterCustomAction(
MaaInstanceHandle inst, MaaStringView name, MaaCustomActionHandle action, MaaTransparentArg action_arg);

/**
Expand All @@ -133,15 +133,15 @@ extern "C"
* @param name The name of the action when it was registered.
* @return MaaBool
*/
MaaBool MAA_FRAMEWORK_API MaaUnregisterCustomAction(MaaInstanceHandle inst, MaaStringView name);
MAA_FRAMEWORK_API MaaBool MaaUnregisterCustomAction(MaaInstanceHandle inst, MaaStringView name);

/**
* @brief Clear all custom actions registered to the instance.
*
* @param inst
* @return MaaBool
*/
MaaBool MAA_FRAMEWORK_API MaaClearCustomAction(MaaInstanceHandle inst);
MAA_FRAMEWORK_API MaaBool MaaClearCustomAction(MaaInstanceHandle inst);

/**
* @brief Post a task to the instance.
Expand All @@ -154,7 +154,7 @@ extern "C"
* @param param The parameter of the task.
* @return MaaTaskId The id of the task.
*/
MaaTaskId MAA_FRAMEWORK_API MaaPostTask(MaaInstanceHandle inst, MaaStringView entry, MaaStringView param);
MAA_FRAMEWORK_API MaaTaskId MaaPostTask(MaaInstanceHandle inst, MaaStringView entry, MaaStringView param);

/**
* @brief Set the parameter of a task.
Expand All @@ -166,7 +166,7 @@ extern "C"
* @param param The parameter of the task.
* @return MaaBool
*/
MaaBool MAA_FRAMEWORK_API MaaSetTaskParam(MaaInstanceHandle inst, MaaTaskId id, MaaStringView param);
MAA_FRAMEWORK_API MaaBool MaaSetTaskParam(MaaInstanceHandle inst, MaaTaskId id, MaaStringView param);

/**
* @brief Get the status of a task identified by the id.
Expand All @@ -175,7 +175,7 @@ extern "C"
* @param id
* @return MaaStatus
*/
MaaStatus MAA_FRAMEWORK_API MaaTaskStatus(MaaInstanceHandle inst, MaaTaskId id);
MAA_FRAMEWORK_API MaaStatus MaaTaskStatus(MaaInstanceHandle inst, MaaTaskId id);

/**
* @brief Wait for a task to finish.
Expand All @@ -184,15 +184,15 @@ extern "C"
* @param id
* @return MaaStatus
*/
MaaStatus MAA_FRAMEWORK_API MaaWaitTask(MaaInstanceHandle inst, MaaTaskId id);
MAA_FRAMEWORK_API MaaStatus MaaWaitTask(MaaInstanceHandle inst, MaaTaskId id);

/**
* @brief Wait for all tasks to finish.
*
* @param inst
* @return MaaBool
*/
MaaBool MAA_FRAMEWORK_API MaaTaskAllFinished(MaaInstanceHandle inst);
MAA_FRAMEWORK_API MaaBool MaaTaskAllFinished(MaaInstanceHandle inst);

/**
* @brief Post a stop signal to the instance.
Expand All @@ -202,26 +202,26 @@ extern "C"
* @param inst
* @return MaaBool
*/
MaaBool MAA_FRAMEWORK_API MaaPostStop(MaaInstanceHandle inst);
MAA_FRAMEWORK_API MaaBool MaaPostStop(MaaInstanceHandle inst);

/// \deprecated Use MaaPostStop() instead.
MaaBool MAA_FRAMEWORK_API MaaStop(MaaInstanceHandle inst);
MAA_FRAMEWORK_API MaaBool MaaStop(MaaInstanceHandle inst);

/**
* @brief Get the resource handle of the instance.
*
* @param inst
* @return MaaResourceHandle
*/
MaaResourceHandle MAA_FRAMEWORK_API MaaGetResource(MaaInstanceHandle inst);
MAA_FRAMEWORK_API MaaResourceHandle MaaGetResource(MaaInstanceHandle inst);

/**
* @brief Get the controller handle of the instance.
*
* @param inst
* @return MaaControllerHandle
*/
MaaControllerHandle MAA_FRAMEWORK_API MaaGetController(MaaInstanceHandle inst);
MAA_FRAMEWORK_API MaaControllerHandle MaaGetController(MaaInstanceHandle inst);

#ifdef __cplusplus
}
Expand Down
Loading

0 comments on commit 814f048

Please sign in to comment.