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
|
#ifndef DATUM_ASTNODE_H
#define DATUM_ASTNODE_H
//===-- qlogo/datum/astnode.h - ASTNode class definition -------*- C++ -*-===//
//
// Copyright 2017-2024 Jason Sikes
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted under the conditions specified in the
// license found in the LICENSE file in the project root.
//
//===----------------------------------------------------------------------===//
///
/// \file
/// This file contains the declaration of the ASTNode class, which is an
/// abstract syntax tree node.
///
//===----------------------------------------------------------------------===//
#include "datum.h"
/// @brief A node of QLogo's Abstract Syntax Tree.
///
/// @details Before execution, a list is parsed into a QList of executable nodes. Each node
/// contains its name, a pointer to the KernelMethod that will perform the actual execution,
/// and an array of zero or more child ASTNodes.
class ASTNode : public Datum
{
protected:
QList<DatumPtr> children;
public:
/// @brief Allocate an ASTNode with the node's name as a Word.
ASTNode(DatumPtr aNodeName);
/// @brief Allocate an ASTNode with the node's name as a QString.
ASTNode(QString aNodeName);
/// @brief A human-readable string. Usually the command name.
DatumPtr nodeName;
/// @brief A pointer to the kernel method that should be called when executing this node.
KernelMethod kernel;
/// @brief Add a child to the node. Child will be added to the end of the children list.
/// @param aChild The child to add.
void addChild(DatumPtr aChild);
/// @brief Returns the child at the specified index.
/// @param index The index of the child to return.
/// @return The child at the specified index.
DatumPtr childAtIndex(unsigned index);
/// @brief Returns the number of children that this node owns.
/// @return The number of children that this node owns.
int countOfChildren();
/// @brief Create an invalid ASTNode.
ASTNode()
{
}
/// @brief Destructor.
~ASTNode();
/// @brief Returns the type of this node.
/// @return The type of this node.
DatumType isa();
/// @brief For debugging. To be used when printing out the AST. Parameters are ignored.
/// @return A string representation of this node.
QString printValue(bool = false, int printDepthLimit = -1, int printWidthLimit = -1);
/// @brief For debugging. To be used when printing out the AST. Parameters are ignored.
/// @return A string representation of this node.
QString showValue(bool = false, int printDepthLimit = -1, int printWidthLimit = -1);
};
#endif // DATUM_ASTNODE_H
|
