amath  1.8.5
Simple command line calculator
help.h
Go to the documentation of this file.
1 /*-
2  * Copyright (c) 2014-2018 Carsten Sonne Larsen <cs@innolan.net>
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
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  * notice, this list of conditions and the following disclaimer in the
12  * documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
18  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
19  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
20  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
21  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  *
25  * Project homepage:
26  * https://amath.innolan.net
27  *
28  */
29 
30 #ifndef AMATH_STATEMENT_HELP_H
31 #define AMATH_STATEMENT_HELP_H
32 
33 #include "node.h"
34 
35 /**
36  * @brief Logic related to the help statement.
37  *
38  */
39 class HelpStatement : public virtual StatementNode
40 {
41 public:
42  HelpStatement();
43  explicit HelpStatement(Symbol argument);
44  explicit HelpStatement(const char* ident);
45  ~HelpStatement();
46  char* Execute();
47 
48 private:
49  char* StatementHelp() const;
50 
51  Symbol argument;
52  char* ident;
53 };
54 
55 #endif
char * ident
Definition: help.h:52
Logic related to the help statement.
Definition: help.h:39
HelpStatement(const char *ident)
Definition: help.cpp:50
Base class for all statements in a syntax tree.
Definition: node.h:40
~HelpStatement()
Definition: help.cpp:56
char * Execute()
Definition: help.cpp:64
HelpStatement(Symbol argument)
Definition: help.cpp:44
char * StatementHelp() const
Definition: help.cpp:87
Symbol argument
Definition: help.h:51
HelpStatement()
Definition: help.cpp:37