-
Notifications
You must be signed in to change notification settings - Fork 4
/
Copy pathIAstNodeQueue.cs
119 lines (93 loc) · 4.39 KB
/
IAstNodeQueue.cs
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
/* M2Sharp -- Modula-2 to C# Translator & Compiler
*
* Copyright (c) 2016 The Modula-2 Software Foundation
*
* Author & Maintainer: Benjamin Kowarsch <trijezdci@org.m2sf>
*
* @synopsis
*
* M2Sharp is a multi-dialect Modula-2 to C# translator and via-C# compiler.
* It supports the dialects described in the 3rd and 4th editions of Niklaus
* Wirth's book "Programming in Modula-2" (PIM) published by Springer Verlag,
* and an extended mode with select features from the revised language by
* B.Kowarsch and R.Sutcliffe "Modula-2 Revision 2010" (M2R10).
*
* In translator mode, M2Sharp translates Modula-2 source to C# source files.
* In compiler mode, M2Sharp compiles Modula-2 source via C# source files
* to object code or executables using the host system's C# compiler.
*
* @repository
*
* https://github.com/m2sf/m2sharp
*
* @file
*
* IAstNodeQueue.cs
*
* Public interface for AST node queue type.
*
* @license
*
* M2Sharp is free software: you can redistribute and/or modify it under the
* terms of the GNU Lesser General Public License (LGPL) either version 2.1
* or at your choice version 3 as published by the Free Software Foundation.
* However, you may not alter the copyright, author and license information.
*
* M2Sharp is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. Read the license for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with M2Sharp. If not, see <https://www.gnu.org/copyleft/lesser.html>.
*
* NB: Components in the domain part of email addresses are in reverse order.
*/
namespace M2SF.M2Sharp {
public interface IAstNodeQueue {
/* --------------------------------------------------------------------------
* constructor newFromList(node, ...)
* --------------------------------------------------------------------------
* Returns a newly allocated AST node queue object that includes the nodes
* passed as arguments of a variadic argument list.
* ----------------------------------------------------------------------- */
// public static AstNodeQueue newFromList (params AstNode[] nodeList);
/* --------------------------------------------------------------------------
* method Count()
* --------------------------------------------------------------------------
* Returns the number of nodes in the receiver.
* ----------------------------------------------------------------------- */
public uint Count ();
/* --------------------------------------------------------------------------
* method Contains(node)
* --------------------------------------------------------------------------
* Returns true if node is stored in the receiver, else false.
* ----------------------------------------------------------------------- */
public bool Contains (AstNode node);
/* --------------------------------------------------------------------------
* method Enqueue(node)
* --------------------------------------------------------------------------
* Enqueues node in the receiver. Returns true on success, else false.
* ----------------------------------------------------------------------- */
public bool Enqueue (AstNode node);
/* --------------------------------------------------------------------------
* method EnqueueUnique(node)
* --------------------------------------------------------------------------
* Enqueues node in the receiver if and only if the node is not already
* present in the receiver. Returns true on success, else false.
* ----------------------------------------------------------------------- */
public bool EnqueueUnique (AstNode node);
/* --------------------------------------------------------------------------
* method Dequeue()
* --------------------------------------------------------------------------
* Removes the tail of the receiver and returns it, or null on failure.
* ----------------------------------------------------------------------- */
public AstNode Dequeue ();
/* --------------------------------------------------------------------------
* method Reset()
* --------------------------------------------------------------------------
* Removes all entries from the receiver.
* ----------------------------------------------------------------------- */
public void Reset ();
} /* IAstNodeQueue */
} /* M2SF.M2Sharp */
/* END OF FILE */