1 /*
2  *  Copyright (c) 2019, 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 contains definitions for a simple CLI to control the Joiner role.
32  */
33 
34 #ifndef CLI_JOINER_HPP_
35 #define CLI_JOINER_HPP_
36 
37 #include "openthread-core-config.h"
38 
39 #include <openthread/joiner.h>
40 
41 #include "utils/lookup_table.hpp"
42 #include "utils/parse_cmdline.hpp"
43 
44 #if OPENTHREAD_CONFIG_JOINER_ENABLE
45 
46 namespace ot {
47 namespace Cli {
48 
49 class Interpreter;
50 
51 /**
52  * This class implements the Joiner CLI interpreter.
53  *
54  */
55 class Joiner
56 {
57 public:
58     typedef Utils::CmdLineParser::Arg Arg;
59 
60     /**
61      * Constructor
62      *
63      * @param[in]  aInterpreter  The CLI interpreter.
64      *
65      */
Joiner(Interpreter & aInterpreter)66     explicit Joiner(Interpreter &aInterpreter)
67         : mInterpreter(aInterpreter)
68     {
69     }
70 
71     /**
72      * This method interprets a list of CLI arguments.
73      *
74      * @param[in]  aArgs        A pointer to an array of command line arguments.
75      *
76      */
77     otError Process(Arg aArgs[]);
78 
79 private:
80     struct Command
81     {
82         const char *mName;
83         otError (Joiner::*mHandler)(Arg aArgs[]);
84     };
85 
86     otError ProcessDiscerner(Arg aArgs[]);
87     otError ProcessHelp(Arg aArgs[]);
88     otError ProcessId(Arg aArgs[]);
89     otError ProcessStart(Arg aArgs[]);
90     otError ProcessStop(Arg aArgs[]);
91 
92     static void HandleCallback(otError aError, void *aContext);
93     void        HandleCallback(otError aError);
94 
95     static constexpr Command sCommands[] = {
96         {"discerner", &Joiner::ProcessDiscerner}, {"help", &Joiner::ProcessHelp}, {"id", &Joiner::ProcessId},
97         {"start", &Joiner::ProcessStart},         {"stop", &Joiner::ProcessStop},
98     };
99 
100     static_assert(Utils::LookupTable::IsSorted(sCommands), "Command Table is not sorted");
101 
102     Interpreter &mInterpreter;
103 };
104 
105 } // namespace Cli
106 } // namespace ot
107 
108 #endif // OPENTHREAD_CONFIG_JOINER_ENABLE
109 
110 #endif // CLI_JOINER_HPP_
111