Skip to content

Commit 54dd6f0

Browse files
authored
[cli] move public C APIs to dedicated cli_api.cpp (openthread#13016)
This commit moves the public C APIs for the CLI from `cli.cpp` to a new dedicated file `cli_api.cpp`.
1 parent 7650ecc commit 54dd6f0

6 files changed

Lines changed: 95 additions & 50 deletions

File tree

src/cli/BUILD.gn

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ import("../../etc/gn/openthread.gni")
3030
openthread_cli_sources = [
3131
"cli.cpp",
3232
"cli.hpp",
33+
"cli_api.cpp",
3334
"cli_ba.cpp",
3435
"cli_ba.hpp",
3536
"cli_bbr.cpp",

src/cli/CMakeLists.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ set(COMMON_INCLUDES
3333

3434
set(COMMON_SOURCES
3535
cli.cpp
36+
cli_api.cpp
3637
cli_ba.cpp
3738
cli_bbr.cpp
3839
cli_br.cpp

src/cli/cli.cpp

Lines changed: 0 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -8826,54 +8826,5 @@ otError Interpreter::ProcessCommand(Arg aArgs[])
88268826
return error;
88278827
}
88288828

8829-
extern "C" void otCliInit(otInstance *aInstance, otCliOutputCallback aCallback, void *aContext)
8830-
{
8831-
Interpreter::Initialize(aInstance, aCallback, aContext);
8832-
8833-
#if OPENTHREAD_CONFIG_CLI_VENDOR_COMMANDS_ENABLE && OPENTHREAD_CONFIG_CLI_MAX_USER_CMD_ENTRIES > 1
8834-
otCliVendorSetUserCommands();
8835-
#endif
8836-
}
8837-
8838-
extern "C" void otCliInputLine(char *aBuf) { Interpreter::GetInterpreter().ProcessLine(aBuf); }
8839-
8840-
extern "C" otError otCliSetUserCommands(const otCliCommand *aUserCommands, uint8_t aLength, void *aContext)
8841-
{
8842-
return Interpreter::GetInterpreter().SetUserCommands(aUserCommands, aLength, aContext);
8843-
}
8844-
8845-
extern "C" void otCliOutputBytes(const uint8_t *aBytes, uint8_t aLength)
8846-
{
8847-
Interpreter::GetInterpreter().OutputBytes(aBytes, aLength);
8848-
}
8849-
8850-
extern "C" void otCliOutputFormat(const char *aFmt, ...)
8851-
{
8852-
va_list aAp;
8853-
va_start(aAp, aFmt);
8854-
Interpreter::GetInterpreter().OutputFormatV(aFmt, aAp);
8855-
va_end(aAp);
8856-
}
8857-
8858-
extern "C" void otCliAppendResult(otError aError) { Interpreter::GetInterpreter().OutputResult(aError); }
8859-
8860-
extern "C" void otCliPlatLogv(otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aFormat, va_list aArgs)
8861-
{
8862-
OT_UNUSED_VARIABLE(aLogLevel);
8863-
OT_UNUSED_VARIABLE(aLogRegion);
8864-
8865-
VerifyOrExit(Interpreter::IsInitialized());
8866-
8867-
// CLI output is being used for logging, so we set the flag
8868-
// `EmittingCommandOutput` to false indicate this.
8869-
Interpreter::GetInterpreter().SetEmittingCommandOutput(false);
8870-
Interpreter::GetInterpreter().OutputFormatV(aFormat, aArgs);
8871-
Interpreter::GetInterpreter().OutputNewLine();
8872-
Interpreter::GetInterpreter().SetEmittingCommandOutput(true);
8873-
8874-
exit:
8875-
return;
8876-
}
8877-
88788829
} // namespace Cli
88798830
} // namespace ot

src/cli/cli.hpp

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,6 @@
8989
namespace ot {
9090

9191
/**
92-
* @namespace ot::Cli
9392
*
9493
* @brief
9594
* This namespace contains definitions for the CLI interpreter.

src/cli/cli_api.cpp

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
/*
2+
* Copyright (c) 2016-2026, The OpenThread Authors.
3+
* All rights reserved.
4+
*
5+
* Redistribution and use in source and binary forms, with or without
6+
* modification, are permitted provided that the following conditions are met:
7+
* 1. Redistributions of source code must retain the above copyright
8+
* notice, this list of conditions and the following disclaimer.
9+
* 2. Redistributions in binary form must reproduce the above copyright
10+
* notice, this list of conditions and the following disclaimer in the
11+
* documentation and/or other materials provided with the distribution.
12+
* 3. Neither the name of the copyright holder nor the
13+
* names of its contributors may be used to endorse or promote products
14+
* derived from this software without specific prior written permission.
15+
*
16+
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17+
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18+
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19+
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
20+
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21+
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22+
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23+
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24+
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25+
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26+
* POSSIBILITY OF SUCH DAMAGE.
27+
*/
28+
29+
/**
30+
* @file
31+
* This file implements the CLI public APIs.
32+
*/
33+
34+
#include <openthread/cli.h>
35+
36+
#include "cli.hpp"
37+
38+
namespace ot {
39+
namespace Cli {
40+
41+
extern "C" void otCliInit(otInstance *aInstance, otCliOutputCallback aCallback, void *aContext)
42+
{
43+
Interpreter::Initialize(aInstance, aCallback, aContext);
44+
45+
#if OPENTHREAD_CONFIG_CLI_VENDOR_COMMANDS_ENABLE && OPENTHREAD_CONFIG_CLI_MAX_USER_CMD_ENTRIES > 1
46+
otCliVendorSetUserCommands();
47+
#endif
48+
}
49+
50+
extern "C" void otCliInputLine(char *aBuf) { Interpreter::GetInterpreter().ProcessLine(aBuf); }
51+
52+
extern "C" otError otCliSetUserCommands(const otCliCommand *aUserCommands, uint8_t aLength, void *aContext)
53+
{
54+
return Interpreter::GetInterpreter().SetUserCommands(aUserCommands, aLength, aContext);
55+
}
56+
57+
extern "C" void otCliOutputBytes(const uint8_t *aBytes, uint8_t aLength)
58+
{
59+
Interpreter::GetInterpreter().OutputBytes(aBytes, aLength);
60+
}
61+
62+
extern "C" void otCliOutputFormat(const char *aFmt, ...)
63+
{
64+
va_list args;
65+
66+
va_start(args, aFmt);
67+
Interpreter::GetInterpreter().OutputFormatV(aFmt, args);
68+
va_end(args);
69+
}
70+
71+
extern "C" void otCliAppendResult(otError aError) { Interpreter::GetInterpreter().OutputResult(aError); }
72+
73+
extern "C" void otCliPlatLogv(otLogLevel aLogLevel, otLogRegion aLogRegion, const char *aFormat, va_list aArgs)
74+
{
75+
OT_UNUSED_VARIABLE(aLogLevel);
76+
OT_UNUSED_VARIABLE(aLogRegion);
77+
78+
VerifyOrExit(Interpreter::IsInitialized());
79+
80+
// CLI output is being used for logging, so we set the flag
81+
// `EmittingCommandOutput` to false indicate this.
82+
Interpreter::GetInterpreter().SetEmittingCommandOutput(false);
83+
Interpreter::GetInterpreter().OutputFormatV(aFormat, aArgs);
84+
Interpreter::GetInterpreter().OutputNewLine();
85+
Interpreter::GetInterpreter().SetEmittingCommandOutput(true);
86+
87+
exit:
88+
return;
89+
}
90+
91+
} // namespace Cli
92+
} // namespace ot

src/cli/radio.cmake

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ target_include_directories(openthread-cli-radio PUBLIC ${OT_PUBLIC_INCLUDES} PRI
4646
target_sources(openthread-cli-radio
4747
PRIVATE
4848
cli.cpp
49+
cli_api.cpp
4950
cli_logging.cpp
5051
cli_utils.cpp
5152
)

0 commit comments

Comments
 (0)