File: CLIParser.hpp

package info (click to toggle)
fastdds 3.3.0%2Bds-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 60,540 kB
  • sloc: cpp: 793,735; xml: 15,283; python: 5,902; sh: 219; makefile: 95; ansic: 12
file content (622 lines) | stat: -rw-r--r-- 27,106 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
// Copyright 2025 Proyectos y Sistemas de Mantenimiento SL (eProsima).
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef FASTDDS_EXAMPLES_CPP_RPC__CLIPARSER_HPP
#define FASTDDS_EXAMPLES_CPP_RPC__CLIPARSER_HPP

#include <csignal>
#include <cstdlib>
#include <iostream>

#include <fastdds/dds/log/Log.hpp>

#include "InputFeedProcessor.hpp"

namespace eprosima {
namespace fastdds {
namespace examples {
namespace rpc {

using dds::Log;

class CLIParser
{
public:

    CLIParser() = delete;

    //! Entity kind enumeration
    enum class EntityKind : uint8_t
    {
        CLIENT,
        SERVER,
        UNDEFINED
    };

    //! Operation kind enumeration
    enum class OperationKind : uint8_t
    {
        ADDITION,
        SUBSTRACTION,
        REPRESENTATION_LIMITS,
        FIBONACCI,
        SUM_ALL,
        ACCUMULATOR,
        FILTER,
        UNDEFINED
    };

    //! Configuration structure for the application

    struct config
    {
        CLIParser::EntityKind entity = CLIParser::EntityKind::UNDEFINED; // Entity kind (Client or Server)
        CLIParser::OperationKind operation = CLIParser::OperationKind::UNDEFINED; // Operation kind
        std::uint8_t filter_kind = 0; // Filter kind for the input feed
        std::uint16_t timeout = 0; // Seconds to live for the server (0 means infinite)
        std::int32_t x = 0; // First operand for addition and substraction
        std::int32_t y = 0; // Second operand for addition and substraction
        std::uint32_t n_results = 0; // Number of results to return in the Fibonacci sequence
        std::size_t connection_attempts = 10; // Number of attempts to connect to the server
        std::size_t thread_pool_size = 0; // Size of the thread pool for the server
    };

    /**
     * @brief Print usage help message and exit with the given return code
     *
     * @param [in] return_code return code to exit with
     *
     * @warning This method finishes the execution of the program with the input return code
     */
    static void print_help(
            const std::uint8_t return_code)
    {
        std::cout << "Service to perform basic arithmetic operations  "                                    << std::endl;
        std::cout << "(addition and subtraction) on two 32-bit integers"                                   << std::endl;
        std::cout << "or compute the representation limits of a 32-bit integer."                           << std::endl;
        std::cout << ""                                                                                    << std::endl;
        std::cout << "Usage: rpc <entity> [options]"                                                       << std::endl;
        std::cout << ""                                                                                    << std::endl;
        std::cout << "Entities:"                                                                           << std::endl;
        std::cout << "  server                                               Run a server entity"          << std::endl;
        std::cout << "  client                                               Run a client entity"          << std::endl;
        std::cout << ""                                                                                    << std::endl;
        std::cout << "Common options:"                                                                     << std::endl;
        std::cout << "  -h, --help                                           Print this help message"      << std::endl;
        std::cout << ""                                                                                    << std::endl;
        std::cout << "Client arguments:"                                                                   << std::endl;
        std::cout << "  -a <num_1> <num_2>, --addition <num_1> <num_2>       Adds two numbers"             << std::endl;
        std::cout << "                                                       [-2^31 <= <num_i> <= 2^31-1]" << std::endl;
        std::cout << "                                                                                   " << std::endl;
        std::cout << "  -s <num_1> <num_2>, --substraction <num_1> <num_2>   Substracts two numbers"       << std::endl;
        std::cout << "                                                       [-2^31 <= <num_i> <= 2^31-1]" << std::endl;
        std::cout << "                                                                                   " << std::endl;
        std::cout << "  -r, --representation-limits                          Computes the representation"  << std::endl;
        std::cout << "                                                       limits of a 32-bit integer"   << std::endl;
        std::cout << "                                                                                   " << std::endl;
        std::cout << "  -f <num>, --fibonacci <num>                          Returns a feed of results"    << std::endl;
        std::cout << "                                                       with the <num> first elements" <<
            std::endl;
        std::cout << "                                                       of the Fibonacci sequence"    << std::endl;
        std::cout << "                                                                                   " << std::endl;
        std::cout << "      --sum-all                                        Sum all the values provided"  << std::endl;
        std::cout << "                                                       in the input feed"            << std::endl;
        std::cout << "                                                                                   " << std::endl;
        std::cout << "      --accumulator                                    Return a feed of results"     << std::endl;
        std::cout << "                                                       with the sum of all received" << std::endl;
        std::cout << "                                                       values from an input feed"    << std::endl;
        std::cout << "                                                                                   " << std::endl;
        std::cout << "      --filter <filter_kind>                           Return a feed of results"     << std::endl;
        std::cout << "                                                       with the values that match"   << std::endl;
        std::cout << "                                                       the input filter kind"        << std::endl;
        std::cout << "                                                       [<filter_kind> = 0, 1, 2]"    << std::endl;
        std::cout << "                                                       [0 = EVEN,"                   << std::endl;
        std::cout << "                                                        1 = ODD,"                    << std::endl;
        std::cout << "                                                        2 = PRIME]"                  << std::endl;
        std::cout << "                                                                                   " << std::endl;
        std::cout << "      --feed <list>                                    Provide a feed instead of   " << std::endl;
        std::cout << "                                                       capturing from stdin in the " << std::endl;
        std::cout << "                                                       form of <num>,<num>,<num> "   << std::endl;
        std::cout << "                                                       [default: empty]"             << std::endl;
        std::cout << "      --connection-attempts <num>                      Number of attempts to connect" <<
            std::endl;
        std::cout << "                                                       to a server before failing"   << std::endl;
        std::cout << "                                                       [default: 10]"                << std::endl;
        std::cout << "Server arguments:"                                                                   << std::endl;
        std::cout << "      --thread-pool-size <num>                         The size of the thread pool"  << std::endl;
        std::cout << "                                                       to use for processing"        << std::endl;
        std::cout << "                                                       requests."                    << std::endl;
        std::cout << "                                                       When set to 0, a new thread"  << std::endl;
        std::cout << "                                                       will be created when"         << std::endl;
        std::cout << "                                                       no threads are available"     << std::endl;
        std::cout << "                                                       [default: 0] "                << std::endl;
        std::cout << "      --timeout <num>                                  Number of seconds to live"    << std::endl;
        std::cout << "                                                       (Default: 0 = till ^C)."      << std::endl;
        std::exit(return_code);
    }

    /**
     * @brief Parse the command line options and return the config object
     *
     * @param [in] argc number of arguments
     * @param [in] argv array of arguments
     * @return config object with the parsed options
     *
     * @warning This method finishes the execution of the program if the input arguments are invalid
     */
    static config parse_cli_options(
            int argc,
            char* argv[])
    {
        config config;

        if (argc < 2)
        {
            EPROSIMA_LOG_ERROR(CLI_PARSER, "missing entity argument");
            print_help(EXIT_FAILURE);
        }

        std::string first_argument = argv[1];

        if (first_argument == "server")
        {
            config.entity = CLIParser::EntityKind::SERVER;
        }
        else if (first_argument == "client")
        {
            config.entity = CLIParser::EntityKind::CLIENT;
        }
        else if (first_argument == "-h" || first_argument == "--help")
        {
            print_help(EXIT_SUCCESS);
        }
        else
        {
            EPROSIMA_LOG_ERROR(CLI_PARSER, "parsing entity argument " + first_argument);
            print_help(EXIT_FAILURE);
        }

        for (int i = 2; i < argc; ++i)
        {
            std::string arg = argv[i];
            if (arg == "-h" || arg == "--help")
            {
                print_help(EXIT_SUCCESS);
            }
            else if (arg == "-a" || arg == "--addition")
            {
                if (config.entity == CLIParser::EntityKind::CLIENT)
                {
                    if (CLIParser::OperationKind::UNDEFINED != config.operation)
                    {
                        EPROSIMA_LOG_ERROR(CLI_PARSER, "Only one operation can be selected");
                        print_help(EXIT_FAILURE);
                    }

                    if (++i < argc)
                    {
                        config.x = consume_integer_argument<std::int32_t>(argv[i], arg);

                        if (++i < argc)
                        {
                            config.y = consume_integer_argument<std::int32_t>(argv[i], arg);
                        }
                        else
                        {
                            EPROSIMA_LOG_ERROR(CLI_PARSER, "missing addition argument");
                            print_help(EXIT_FAILURE);
                        }
                    }
                    else
                    {
                        EPROSIMA_LOG_ERROR(CLI_PARSER, "missing addition argument");
                        print_help(EXIT_FAILURE);
                    }

                    config.operation = CLIParser::OperationKind::ADDITION;
                }
                else
                {
                    EPROSIMA_LOG_ERROR(CLI_PARSER, "addition argument is only valid for client entity");
                    print_help(EXIT_FAILURE);
                }
            }
            else if (arg == "-s" || arg == "--substraction")
            {
                if (config.entity == CLIParser::EntityKind::CLIENT)
                {
                    if (CLIParser::OperationKind::UNDEFINED != config.operation)
                    {
                        EPROSIMA_LOG_ERROR(CLI_PARSER, "Only one operation can be selected");
                        print_help(EXIT_FAILURE);
                    }

                    if (++i < argc)
                    {
                        config.x = consume_integer_argument<std::int32_t>(argv[i], arg);

                        if (++i < argc)
                        {
                            config.y = consume_integer_argument<std::int32_t>(argv[i], arg);
                        }
                        else
                        {
                            EPROSIMA_LOG_ERROR(CLI_PARSER, "missing substraction argument");
                            print_help(EXIT_FAILURE);
                        }
                    }
                    else
                    {
                        EPROSIMA_LOG_ERROR(CLI_PARSER, "missing substraction argument");
                        print_help(EXIT_FAILURE);
                    }

                    config.operation = CLIParser::OperationKind::SUBSTRACTION;
                }
                else
                {
                    EPROSIMA_LOG_ERROR(CLI_PARSER, "addition argument is only valid for client entity");
                    print_help(EXIT_FAILURE);
                }
            }
            else if (arg == "-r" || arg == "--representation-limits")
            {
                if (config.entity == CLIParser::EntityKind::CLIENT)
                {
                    if (CLIParser::OperationKind::UNDEFINED != config.operation)
                    {
                        EPROSIMA_LOG_ERROR(CLI_PARSER, "Only one operation can be selected");
                        print_help(EXIT_FAILURE);
                    }

                    config.operation = CLIParser::OperationKind::REPRESENTATION_LIMITS;
                }
                else
                {
                    EPROSIMA_LOG_ERROR(CLI_PARSER, "representation-limits argument is only valid for client entity");
                    print_help(EXIT_FAILURE);
                }
            }
            else if (arg == "-f" || arg == "--fibonacci")
            {
                if (config.entity == CLIParser::EntityKind::CLIENT)
                {
                    if (CLIParser::OperationKind::UNDEFINED != config.operation)
                    {
                        EPROSIMA_LOG_ERROR(CLI_PARSER, "Only one operation can be selected");
                        print_help(EXIT_FAILURE);
                    }

                    if (++i < argc)
                    {
                        config.n_results = consume_integer_argument<std::uint32_t>(argv[i], arg);
                    }
                    else
                    {
                        EPROSIMA_LOG_ERROR(CLI_PARSER, "missing fibonacci argument");
                        print_help(EXIT_FAILURE);
                    }

                    config.operation = CLIParser::OperationKind::FIBONACCI;
                }
                else
                {
                    EPROSIMA_LOG_ERROR(CLI_PARSER, "fibonacci argument is only valid for client entity");
                    print_help(EXIT_FAILURE);
                }
            }
            else if (arg == "--sum-all")
            {
                if (config.entity == CLIParser::EntityKind::CLIENT)
                {
                    if (CLIParser::OperationKind::UNDEFINED != config.operation)
                    {
                        EPROSIMA_LOG_ERROR(CLI_PARSER, "Only one operation can be selected");
                        print_help(EXIT_FAILURE);
                    }

                    config.operation = CLIParser::OperationKind::SUM_ALL;
                }
                else
                {
                    EPROSIMA_LOG_ERROR(CLI_PARSER, "sum-all argument is only valid for client entity");
                    print_help(EXIT_FAILURE);
                }
            }
            else if (arg == "--accumulator")
            {
                if (config.entity == CLIParser::EntityKind::CLIENT)
                {
                    if (CLIParser::OperationKind::UNDEFINED != config.operation)
                    {
                        EPROSIMA_LOG_ERROR(CLI_PARSER, "Only one operation can be selected");
                        print_help(EXIT_FAILURE);
                    }

                    config.operation = CLIParser::OperationKind::ACCUMULATOR;
                }
                else
                {
                    EPROSIMA_LOG_ERROR(CLI_PARSER, "accumulator argument is only valid for client entity");
                    print_help(EXIT_FAILURE);
                }
            }
            else if (arg == "--filter")
            {
                if (config.entity == CLIParser::EntityKind::CLIENT)
                {
                    if (CLIParser::OperationKind::UNDEFINED != config.operation)
                    {
                        EPROSIMA_LOG_ERROR(CLI_PARSER, "Only one operation can be selected");
                        print_help(EXIT_FAILURE);
                    }

                    if (++i < argc)
                    {
                        config.filter_kind = consume_integer_argument<std::uint8_t>(argv[i], arg);

                        if (config.filter_kind > 2)
                        {
                            EPROSIMA_LOG_ERROR(CLI_PARSER, "filter kind must be 0, 1 or 2");
                            print_help(EXIT_FAILURE);
                        }
                    }
                    else
                    {
                        EPROSIMA_LOG_ERROR(CLI_PARSER, "missing filter argument");
                        print_help(EXIT_FAILURE);
                    }

                    config.operation = CLIParser::OperationKind::FILTER;
                }
                else
                {
                    EPROSIMA_LOG_ERROR(CLI_PARSER, "filter argument is only valid for client entity");
                    print_help(EXIT_FAILURE);
                }
            }
            else if (arg == "--connection-attempts")
            {
                if (config.entity == CLIParser::EntityKind::CLIENT)
                {
                    if (++i < argc)
                    {
                        config.connection_attempts = consume_integer_argument<std::size_t>(argv[i], arg);
                    }
                    else
                    {
                        EPROSIMA_LOG_ERROR(CLI_PARSER, "missing connection-attempts argument");
                        print_help(EXIT_FAILURE);
                    }
                }
                else
                {
                    EPROSIMA_LOG_ERROR(CLI_PARSER, "connection-attempts argument is only valid for client entity");
                    print_help(EXIT_FAILURE);
                }
            }
            else if (arg == "--thread-pool-size")
            {
                if (config.entity == CLIParser::EntityKind::SERVER)
                {
                    if (++i < argc)
                    {
                        config.thread_pool_size = consume_integer_argument<std::size_t>(argv[i], arg);
                    }
                    else
                    {
                        EPROSIMA_LOG_ERROR(CLI_PARSER, "missing thread-pool-size argument");
                        print_help(EXIT_FAILURE);
                    }
                }
                else
                {
                    EPROSIMA_LOG_ERROR(CLI_PARSER, "thread-pool-size argument is only valid for server entity");
                    print_help(EXIT_FAILURE);
                }
            }
            else if (arg == "--timeout")
            {
                if (++i < argc)
                {
                    if (config.entity == CLIParser::EntityKind::SERVER)
                    {
                        try
                        {
                            int input = std::stoi(argv[i]);
                            if (input < std::numeric_limits<uint16_t>::min() ||
                                    input > std::numeric_limits<uint16_t>::max())
                            {
                                throw std::out_of_range("timeout argument " + std::string(
                                                  argv[i]) + " out of range [0, 65535].");
                            }
                            else
                            {
                                config.timeout = static_cast<uint16_t>(input);
                            }
                        }
                        catch (const std::invalid_argument& e)
                        {
                            EPROSIMA_LOG_ERROR(CLI_PARSER, "invalid timeout argument " + std::string(
                                        argv[i]) + ": " + std::string(e.what()));
                            print_help(EXIT_FAILURE);
                        }
                        catch (const std::out_of_range& e)
                        {
                            EPROSIMA_LOG_ERROR(CLI_PARSER, std::string(e.what()));
                            print_help(EXIT_FAILURE);
                        }
                    }
                    else
                    {
                        EPROSIMA_LOG_ERROR(CLI_PARSER, "--timeout argument is only valid for server entity");
                        print_help(EXIT_FAILURE);
                    }
                }
                else
                {
                    EPROSIMA_LOG_ERROR(CLI_PARSER, "parsing timeout argument");
                    print_help(EXIT_FAILURE);
                }
            }
            else if (arg == "--feed")
            {
                if (++i < argc)
                {
                    if (config.entity == CLIParser::EntityKind::CLIENT)
                    {
                        // Error handling for reading in performed in InputFeedProcessor
                        InputFeedProcessor::provided_input_feed.reset(new std::stringstream(argv[i]));
                    }
                    else
                    {
                        EPROSIMA_LOG_ERROR(CLI_PARSER, "--feed argument is only valid for client entity");
                        print_help(EXIT_FAILURE);
                    }
                }
                else
                {
                    EPROSIMA_LOG_ERROR(CLI_PARSER, "parsing feed argument");
                    print_help(EXIT_FAILURE);
                }
            }
            else
            {
                EPROSIMA_LOG_ERROR(CLI_PARSER, "unknown option " + arg);
                print_help(EXIT_FAILURE);
            }
        }

        return config;
    }

    /**
     * @brief Parse the signal number into the signal name
     *
     * @param [in] signum signal number
     *
     * @return std::string signal name
     */
    static std::string parse_signal(
            const int& signum)
    {
        switch (signum)
        {
            case SIGINT:
                return "SIGINT";
            case SIGTERM:
                return "SIGTERM";
#ifndef _WIN32
            case SIGQUIT:
                return "SIGQUIT";
            case SIGHUP:
                return "SIGHUP";
#endif // _WIN32
            default:
                return "UNKNOWN SIGNAL";
        }
    }

    /**
     * @brief Parse the entity kind into std::string
     *
     * @param [in] entity entity kind
     *
     * @return std::string entity kind
     */
    static std::string parse_entity_kind(
            const EntityKind& entity)
    {
        switch (entity)
        {
            case EntityKind::SERVER:
                return "Server";
            case EntityKind::CLIENT:
                return "Client";
            case EntityKind::UNDEFINED:
            default:
                return "Undefined entity";
        }
    }

private:

    /**
     * @brief Consume an integer argument and return it
     *
     * @param [in] arg_value string argument value to consume
     * @param [in] arg_name name of the argument to print in case of error
     *
     * @return integer argument of a given type
     *
     * @warning This method finishes the execution of the program if the input arguments are invalid
     */
    template <typename T>
    static T consume_integer_argument(
            const std::string& arg_value,
            const std::string& arg_name)
    {
        T value = 0;

        try
        {
            long long input = std::stoll(arg_value);

            if (std::is_unsigned<T>::value)
            {
                if (input < 0)
                {
                    throw std::invalid_argument("negative value for unsigned integer");
                }

                // Cast to unsigned long long safe because input is >= 0
                unsigned long long unsigned_input = static_cast<unsigned long long>(input);
                if (unsigned_input < std::numeric_limits<T>::min() ||
                        unsigned_input > std::numeric_limits<T>::max())
                {
                    throw std::out_of_range("unsigned integer argument out of range");
                }
            }
            else if (input < static_cast<long long>(std::numeric_limits<T>::min()) ||
                    input > static_cast<long long>(std::numeric_limits<T>::max()))
            {
                throw std::out_of_range("integer argument out of range");
            }

            value = static_cast<T>(input);
        }
        catch (const std::invalid_argument& e)
        {
            EPROSIMA_LOG_ERROR(CLI_PARSER,
                    "invalid integer value for argument " << arg_name << ": [ " + arg_value + " ]. " + e.what());
            print_help(EXIT_FAILURE);
        }
        catch (const std::out_of_range& e)
        {
            EPROSIMA_LOG_ERROR(CLI_PARSER,
                    "integer value out of range for argument " << arg_name << ": [ " + arg_value + " ]. " + e.what());
            print_help(EXIT_FAILURE);
        }

        return value;
    }

};

} // namespace rpc
} // namespace examples
} // namespace fastdds
} // namespace eprosima

#endif // FASTDDS_EXAMPLES_CPP_RPC__CLIPARSER_HPP