File: Word.cs

package info (click to toggle)
bearssl 0.6%2Bdfsg.1-4
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 4,484 kB
  • sloc: ansic: 49,044; cs: 3,473; sh: 524; makefile: 40
file content (172 lines) | stat: -rw-r--r-- 4,192 bytes parent folder | download | duplicates (3)
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
/*
 * Copyright (c) 2016 Thomas Pornin <pornin@bolet.org>
 *
 * Permission is hereby granted, free of charge, to any person obtaining 
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject to
 * the following conditions:
 *
 * The above copyright notice and this permission notice shall be 
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

using System;
using System.Collections.Generic;

/*
 * A "word" is a function with a name. Words can be either native or
 * interpreted; native words are implemented as some in-compiler special
 * code.
 *
 * Some native words (not all of them) have a C implementation and can
 * thus be part of the generated C code. Native words with no C
 * implementation can be used only during compilation; this is typically
 * the case for words that support the syntax (e.g. 'if').
 */

abstract class Word {

	/*
	 * The compiler context for this word.
	 */
	internal T0Comp TC {
		get; private set;
	}

	/*
	 * Immediate words are executed immediately when encountered in the
	 * source code, even while compiling another word.
	 */
	internal bool Immediate {
		get; set;
	}

	/*
	 * Each word has a unique name. Names are case-sensitive.
	 */
	internal string Name {
		get; private set;
	}

	/*
	 * Words are allocated slot numbers when output code is generated.
	 */
	internal int Slot {
		get; set;
	}

	/*
	 * Each word may have a known stack effect.
	 */
	internal SType StackEffect {
		get; set;
	}

	internal Word(T0Comp owner, string name)
	{
		TC = owner;
		Name = name;
		StackEffect = SType.UNKNOWN;
	}

	/*
	 * Resolving a word means looking up all references to external
	 * words.
	 */
	internal virtual void Resolve()
	{
	}

	/*
	 * Execute this word. If the word is native, then its code is
	 * run right away; if the word is interpreted, then the entry
	 * sequence is executed.
	 */
	internal virtual void Run(CPU cpu)
	{
		throw new Exception(String.Format(
			"cannot run '{0}' at compile-time", Name));
	}

	/*
	 * All words may have an explicit C implementations. To be part
	 * of the generated C code, a word must either be interpreted,
	 * or have an explicit C implementation, or both.
	 */
	internal string CCode {
		get; set;
	}

	/*
	 * Get all words referenced from this one. This implies
	 * resolving the word.
	 */
	internal virtual List<Word> GetReferences()
	{
		return new List<Word>();
	}

	/*
	 * Get all data blocks directly referenced from this one. This
	 * implies resolving the word.
	 */
	internal virtual List<ConstData> GetDataBlocks()
	{
		return new List<ConstData>();
	}

	/*
	 * Produce the code elements for this word.
	 */
	internal virtual void GenerateCodeElements(List<CodeElement> dst)
	{
		throw new Exception("Word does not yield code elements");
	}

	/*
	 * Compute/verify stack effect for this word.
	 */
	internal virtual void AnalyseFlow()
	{
	}

	/*
	 * Get maximum data stack usage for this word. This is the number
	 * of extra slots that this word may need on the data stack. If
	 * the stack effect is not known, this returns -1.
	 */
	internal virtual int MaxDataStack {
		get {
			SType se = StackEffect;
			if (!se.IsKnown) {
				return -1;
			}
			if (se.NoExit) {
				return 0;
			} else {
				return Math.Min(0, se.DataOut - se.DataIn);
			}
		}
	}

	/*
	 * Get maximum return stack usage for this word.
	 */
	internal virtual int MaxReturnStack {
		get {
			return 0;
		}
	}
}