1 | \chapter{\CFA Enumeration} |
---|
2 | |
---|
3 | |
---|
4 | \CFA supports C enumeration using the same syntax and semantics for backwards compatibility. |
---|
5 | \CFA also extends C-Style enumeration by adding a number of new features that bring enumerations inline with other modern programming languages. |
---|
6 | Any enumeration extensions must be intuitive to C programmers both in syntax and semantics. |
---|
7 | The following sections detail all of my new contributions to enumerations in \CFA. |
---|
8 | |
---|
9 | |
---|
10 | \section{Aliasing} |
---|
11 | |
---|
12 | C already provides @const@-style aliasing using the unnamed enumerator \see{\VRef{s:TypeName}}, even if the name @enum@ is misleading (@const@ would be better). |
---|
13 | Given the existence of this form, it is straightforward to extend it with types other than integers. |
---|
14 | \begin{cfa} |
---|
15 | enum E { Size = 20u, PI = 3.14159L, Jack = L"John" }; |
---|
16 | \end{cfa} |
---|
17 | which matches with @const@ aliasing in other programming languages. |
---|
18 | Here, the type of the enumerator is the type of the initialization constant, \eg @typeof(20u)@ for @Size@ implies @unsigned int@. |
---|
19 | Auto-initialization is restricted to the case where all constants are @int@, matching with C. |
---|
20 | As seen in \VRef{s:EnumeratorTyping}, this feature is just a shorthand for multiple typed-enumeration declarations. |
---|
21 | |
---|
22 | |
---|
23 | \section{Enumerator Unscoping} |
---|
24 | \label{s:EnumeratorUnscoping} |
---|
25 | |
---|
26 | In C, unscoped enumerators presents a \Newterm{naming problem} when multiple enumeration types appear in the same scope with duplicate enumerator names. |
---|
27 | There is no mechanism in C to resolve these naming conflicts other than renaming one of the duplicates, which may be impossible. |
---|
28 | |
---|
29 | The \CFA type-system allows extensive overloading, including enumerators. |
---|
30 | Furthermore, \CFA uses the left-hand of assignment in type resolution to pinpoint the best overloaded name. |
---|
31 | Finally, qualification and casting are provided to disambiguate any ambiguous situations. |
---|
32 | \begin{cfa} |
---|
33 | enum E1 { First, Second, Third, Fourth }; |
---|
34 | enum E2 { @Fourth@, @Third@, @Second@, @First@ }; $\C{// same enumerator names}$ |
---|
35 | E1 p() { return Third; } $\C{// correctly resolved duplicate names}$ |
---|
36 | E2 p() { return Fourth; } |
---|
37 | void foo() { |
---|
38 | E1 e1 = First; E2 e2 = First; $\C{// initialization}$ |
---|
39 | e1 = Second; e2 = Second; $\C{// assignment}$ |
---|
40 | e1 = p(); e2 = p(); $\C{// function call}$ |
---|
41 | int i = @E1.@First + @E2.@First; $\C{// disambiguate with qualification}$ |
---|
42 | int j = @(E1)@First + @(E2)@First; $\C{// disambiguate with cast}$ |
---|
43 | } |
---|
44 | \end{cfa} |
---|
45 | \CFA overloading allows programmers to use the most meaningful names without fear of name clashes from include files. |
---|
46 | In most cases, the type system implicitly disambiguates, otherwise the programmer explicitly disambiguates using qualification or casting. |
---|
47 | |
---|
48 | |
---|
49 | \section{Enumerator Scoping} |
---|
50 | |
---|
51 | An enumeration can be scoped, using @'!'@, so the enumerator constants are not projected into the enclosing scope. |
---|
52 | \begin{cfa} |
---|
53 | enum Week @!@ { Mon, Tue, Wed, Thu = 10, Fri, Sat, Sun }; |
---|
54 | enum RGB @!@ { Red, Green, Blue }; |
---|
55 | \end{cfa} |
---|
56 | Now the enumerators \emph{must} be qualified with the associated enumeration. |
---|
57 | \begin{cfa} |
---|
58 | Week week = @Week.@Mon; |
---|
59 | week = @Week.@Sat; |
---|
60 | RGB rgb = @RGB.@Red; |
---|
61 | rgb = @RGB.@Blue; |
---|
62 | \end{cfa} |
---|
63 | It is possible to toggle back to unscoping using the \CFA @with@ clause/statement (see also \CC \lstinline[language=c++]{using enum} in Section~\ref{s:C++RelatedWork}). |
---|
64 | \begin{cfa} |
---|
65 | with ( @Week@, @RGB@ ) { $\C{// type names}$ |
---|
66 | week = @Sun@; $\C{// no qualification}$ |
---|
67 | rgb = @Green@; |
---|
68 | } |
---|
69 | \end{cfa} |
---|
70 | As in Section~\ref{s:EnumeratorUnscoping}, opening multiple scoped enumerations in a @with@ can result in duplicate enumeration names, but \CFA implicit type resolution and explicit qualification/casting handles ambiguities. |
---|
71 | |
---|
72 | |
---|
73 | \section{Enumeration Pseudo-functions} |
---|
74 | |
---|
75 | Pseudo-functions are function-like operators that do not result in any run-time computations, \ie like @sizeof@, @alignof@, @typeof@. |
---|
76 | A pseudo-function call is often substituted with information extracted from the compilation symbol-table, like storage size or alignment associated with the underlying architecture. |
---|
77 | |
---|
78 | The attributes of an enumerator are accessed by pseudo-functions @posE@, @valueE@, and @labelE@. |
---|
79 | \begin{cfa} |
---|
80 | int jane_pos = @posE@( Names.Jane ); $\C{// 2}$ |
---|
81 | char * jane_value = @valueE@( Names.Jane ); $\C{// "JANE"}$ |
---|
82 | char * jane_label = @labelE@( Names.Jane ); $\C{// "Jane"}$ |
---|
83 | sout | posE( Names.Jane) | labelE( Names.Jane ) | valueE( Names.Jane ); |
---|
84 | \end{cfa} |
---|
85 | Note the ability to print all of an enumerator's properties. |
---|
86 | |
---|
87 | |
---|
88 | \section{Enumerator Typing} |
---|
89 | \label{s:EnumeratorTyping} |
---|
90 | |
---|
91 | \CFA extends the enumeration declaration by parameterizing with a type (like a generic type), allowing enumerators to be assigned any values from the declared type. |
---|
92 | Figure~\ref{f:EumeratorTyping} shows a series of examples illustrating that all \CFA types can be use with an enumeration and each type's constants used to set the enumerator constants. |
---|
93 | Note, the synonyms @Liz@ and @Beth@ in the last declaration. |
---|
94 | Because enumerators are constants, the enumeration type is implicitly @const@, so all the enumerator types in Figure~\ref{f:EumeratorTyping} are logically rewritten with @const@. |
---|
95 | |
---|
96 | C has an implicit type conversion from an enumerator to its base type @int@. |
---|
97 | Correspondingly, \CFA has an implicit (safe) conversion from a typed enumerator to its base type. |
---|
98 | \begin{cfa} |
---|
99 | char currency = Dollar; |
---|
100 | string fred = Fred; $\C{// implicit conversion from char * to \CFA string type}$ |
---|
101 | Person student = Beth; |
---|
102 | \end{cfa} |
---|
103 | |
---|
104 | % \begin{cfa} |
---|
105 | % struct S { int i, j; }; |
---|
106 | % enum( S ) s { A = { 3, 4 }, B = { 7, 8 } }; |
---|
107 | % enum( @char@ ) Currency { Dollar = '$\textdollar$', Euro = '$\texteuro$', Pound = '$\textsterling$' }; |
---|
108 | % enum( @double@ ) Planet { Venus = 4.87, Earth = 5.97, Mars = 0.642 }; // mass |
---|
109 | % enum( @char *@ ) Colour { Red = "red", Green = "green", Blue = "blue" }; |
---|
110 | % enum( @Currency@ ) Europe { Euro = '$\texteuro$', Pound = '$\textsterling$' }; // intersection |
---|
111 | % \end{cfa} |
---|
112 | |
---|
113 | \begin{figure} |
---|
114 | \begin{cfa} |
---|
115 | // integral |
---|
116 | enum( @char@ ) Currency { Dollar = '$\textdollar$', Cent = '$\textcent$', Yen = '$\textyen$', Pound = '$\textsterling$', Euro = 'E' }; |
---|
117 | enum( @signed char@ ) srgb { Red = -1, Green = 0, Blue = 1 }; |
---|
118 | enum( @long long int@ ) BigNum { X = 123_456_789_012_345, Y = 345_012_789_456_123 }; |
---|
119 | // non-integral |
---|
120 | enum( @double@ ) Math { PI_2 = 1.570796, PI = 3.141597, E = 2.718282 }; |
---|
121 | enum( @_Complex@ ) Plane { X = 1.5+3.4i, Y = 7+3i, Z = 0+0.5i }; |
---|
122 | // pointer |
---|
123 | enum( @const char *@ ) Name { Fred = "FRED", Mary = "MARY", Jane = "JANE" }; |
---|
124 | int i, j, k; |
---|
125 | enum( @int *@ ) ptr { I = &i, J = &j, K = &k }; |
---|
126 | enum( @int &@ ) ref { I = i, J = j, K = k }; |
---|
127 | // tuple |
---|
128 | enum( @[int, int]@ ) { T = [ 1, 2 ] }; $\C{// new \CFA type}$ |
---|
129 | // function |
---|
130 | void f() {...} void g() {...} |
---|
131 | enum( @void (*)()@ ) funs { F = f, G = g }; |
---|
132 | // aggregate |
---|
133 | struct Person { char * name; int age, height; }; |
---|
134 | @***@enum( @Person@ ) friends { @Liz@ = { "ELIZABETH", 22, 170 }, @Beth@ = Liz, |
---|
135 | Jon = { "JONATHAN", 35, 190 } }; |
---|
136 | \end{cfa} |
---|
137 | \caption{Enumerator Typing} |
---|
138 | \label{f:EumeratorTyping} |
---|
139 | \end{figure} |
---|
140 | |
---|
141 | An advantage of the typed enumerations is eliminating the \emph{harmonizing} problem between an enumeration and companion data \see{\VRef{s:Usage}}: |
---|
142 | \begin{cfa} |
---|
143 | enum( char * ) integral_types { |
---|
144 | chr = "char", schar = "signed char", uschar = "unsigned char", |
---|
145 | sshort = "signed short int", ushort = "unsigned short int", |
---|
146 | sint = "signed int", usint = "unsigned int", |
---|
147 | ... |
---|
148 | }; |
---|
149 | \end{cfa} |
---|
150 | Note, the enumeration type can be a structure (see @Person@ in Figure~\ref{f:EumeratorTyping}), so it is possible to have the equivalent of multiple arrays of companion data using an array of structures. |
---|
151 | |
---|
152 | While the enumeration type can be any C aggregate, the aggregate's \CFA constructors are not used to evaluate an enumerator's value. |
---|
153 | \CFA enumeration constants are compile-time values (static); |
---|
154 | calling constructors happens at runtime (dynamic). |
---|
155 | |
---|
156 | |
---|
157 | \section{Enumeration Inheritance} |
---|
158 | |
---|
159 | \CFA Plan-9 inheritance may be used with enumerations, where Plan-9 inheritance is containment inheritance with implicit unscoping (like a nested unnamed @struct@/@union@ in C). |
---|
160 | \begin{cfa} |
---|
161 | enum( char * ) Names { /* as above */ }; |
---|
162 | enum( char * ) Names2 { @inline Names@, Jack = "JACK", Jill = "JILL" }; |
---|
163 | @***@enum /* inferred */ Names3 { @inline Names2@, Sue = "SUE", Tom = "TOM" }; |
---|
164 | \end{cfa} |
---|
165 | Enumeration @Name2@ inherits all the enumerators and their values from enumeration @Names@ by containment, and a @Names@ enumeration is a subtype of enumeration @Name2@. |
---|
166 | Note, enumerators must be unique in inheritance but enumerator values may be repeated. |
---|
167 | |
---|
168 | The enumeration type for the inheriting type must be the same as the inherited type; |
---|
169 | hence the enumeration type may be omitted for the inheriting enumeration and it is inferred from the inherited enumeration, as for @Name3@. |
---|
170 | % When inheriting from integral types, automatic numbering may be used, so the inheritance placement left to right is important. |
---|
171 | Specifically, the inheritance relationship for @Names@ is: |
---|
172 | \begin{cfa} |
---|
173 | Names $\(\subset\)$ Names2 $\(\subset\)$ Names3 $\(\subset\)$ const char * $\C{// enum type of Names}$ |
---|
174 | \end{cfa} |
---|
175 | For the given function prototypes, the following calls are valid. |
---|
176 | \begin{cquote} |
---|
177 | \begin{tabular}{ll} |
---|
178 | \begin{cfa} |
---|
179 | void f( Names ); |
---|
180 | void g( Names2 ); |
---|
181 | void h( Names3 ); |
---|
182 | void j( const char * ); |
---|
183 | \end{cfa} |
---|
184 | & |
---|
185 | \begin{cfa} |
---|
186 | f( Fred ); |
---|
187 | g( Fred ); g( Jill ); |
---|
188 | h( Fred ); h( Jill ); h( Sue ); |
---|
189 | j( Fred ); j( Jill ); j( Sue ); j( "WILL" ); |
---|
190 | \end{cfa} |
---|
191 | \end{tabular} |
---|
192 | \end{cquote} |
---|
193 | Note, the validity of calls is the same for call-by-reference as for call-by-value, and @const@ restrictions are the same as for other types. |
---|
194 | |
---|
195 | |
---|
196 | \section{Enumerator Control Structures} |
---|
197 | |
---|
198 | Enumerators can be used in multiple contexts. |
---|
199 | In most programming languages, an enumerator is implicitly converted to its value (like a typed macro substitution). |
---|
200 | However, enumerator synonyms and typed enumerations make this implicit conversion to value incorrect in some contexts. |
---|
201 | In these contexts, a programmer's initition assumes an implicit conversion to postion. |
---|
202 | |
---|
203 | For example, an intuitive use of enumerations is with the \CFA @switch@/@choose@ statement, where @choose@ performs an implict @break@ rather than a fall-through at the end of a @case@ clause. |
---|
204 | \begin{cquote} |
---|
205 | \begin{cfa} |
---|
206 | enum Count { First, Second, Third, Fourth }; |
---|
207 | Count e; |
---|
208 | \end{cfa} |
---|
209 | \begin{tabular}{ll} |
---|
210 | \begin{cfa} |
---|
211 | |
---|
212 | choose( e ) { |
---|
213 | case @First@: ...; |
---|
214 | case @Second@: ...; |
---|
215 | case @Third@: ...; |
---|
216 | case @Fourth@: ...; |
---|
217 | } |
---|
218 | \end{cfa} |
---|
219 | & |
---|
220 | \begin{cfa} |
---|
221 | // rewrite |
---|
222 | choose( @value@( e ) ) { |
---|
223 | case @value@( First ): ...; |
---|
224 | case @value@( Second ): ...; |
---|
225 | case @value@( Third ): ...; |
---|
226 | case @value@( Fourth ): ...; |
---|
227 | } |
---|
228 | \end{cfa} |
---|
229 | \end{tabular} |
---|
230 | \end{cquote} |
---|
231 | Here, the intuitive code on the left is implicitly transformed into the statndard implementation on the right, using the value of the enumeration variable and enumerators. |
---|
232 | However, this implementation is fragile, \eg if the enumeration is changed to: |
---|
233 | \begin{cfa} |
---|
234 | enum Count { First, Second, Third @= First@, Fourth }; |
---|
235 | \end{cfa} |
---|
236 | which make @Third == First@ and @Fourth == Second@, causing a compilation error because of duplicase @case@ clauses. |
---|
237 | To better match with programmer intuition, \CFA toggles between value and position semantics depneding on the language context. |
---|
238 | For conditional clauses and switch statments, \CFA uses the robust position implementation. |
---|
239 | \begin{cfa} |
---|
240 | choose( @position@( e ) ) { |
---|
241 | case @position@( First ): ...; |
---|
242 | case @position@( Second ): ...; |
---|
243 | case @position@( Third ): ...; |
---|
244 | case @position@( Fourth ): ...; |
---|
245 | } |
---|
246 | \end{cfa} |
---|
247 | |
---|
248 | \begin{cfa} |
---|
249 | Count variable_a = First, variable_b = Second, variable_c = Third, variable_d = Fourth; |
---|
250 | p(variable_a); // 0 |
---|
251 | p(variable_b); // 1 |
---|
252 | p(variable_c); // "Third" |
---|
253 | p(variable_d); // 3 |
---|
254 | \end{cfa} |
---|
255 | |
---|
256 | |
---|
257 | @if@ statement |
---|
258 | |
---|
259 | @switch@ statement |
---|
260 | |
---|
261 | looping statements |
---|
262 | |
---|
263 | |
---|
264 | \section{Planet Example} |
---|
265 | |
---|
266 | \VRef[Figure]{f:PlanetExample} shows an archetypal enumeration example illustrating most of the \CFA enumeration features. |
---|
267 | Enumeration @Planet@ is a typed enumeration of type @MR@. |
---|
268 | Each of the planet enumerators is initialized to a specific mass/radius, @MR@, value. |
---|
269 | The unnamed enumeration projects the gravitational-constant enumerator @G@. |
---|
270 | The program main iterates through the planets computing the weight on each planet for a given earth weight. |
---|
271 | |
---|
272 | \begin{figure} |
---|
273 | \begin{cfa} |
---|
274 | struct MR { double mass, radius; }; |
---|
275 | enum( MR ) Planet { |
---|
276 | // mass (kg) radius (km) |
---|
277 | MERCURY = { 0.330_E24, 2.4397_E6 }, |
---|
278 | VENUS = { 4.869_E24, 6.0518_E6 }, |
---|
279 | EARTH = { 5.976_E24, 6.3781_E6 }, |
---|
280 | MOON = { 7.346_E22, 1.7380_E6 }, $\C{// not a planet}$ |
---|
281 | MARS = { 0.642_E24, 3.3972_E6 }, |
---|
282 | JUPITER = { 1898._E24, 71.492_E6 }, |
---|
283 | SATURN = { 568.8_E24, 60.268_E6 }, |
---|
284 | URANUS = { 86.86_E24, 25.559_E6 }, |
---|
285 | NEPTUNE = { 102.4_E24, 24.746_E6 }, |
---|
286 | }; |
---|
287 | enum( double ) { G = 6.6743E-11 }; $\C{// universal gravitational constant (m3 kg-1 s-2)}$ |
---|
288 | |
---|
289 | static double surfaceGravity( Planet p ) with( p ) { |
---|
290 | return G * mass / ( radius * radius ); |
---|
291 | } |
---|
292 | static double surfaceWeight( Planet p, double otherMass ) { |
---|
293 | return otherMass * surfaceGravity( p ); |
---|
294 | } |
---|
295 | int main( int argc, char * argv[] ) { |
---|
296 | if ( argc != 2 ) exit | "Usage: " | argv[0] | "earth-weight"; |
---|
297 | double earthWeight = convert( argv[1] ); |
---|
298 | double mass = earthWeight / surfaceGravity( EARTH ); |
---|
299 | for ( p; Planet ) { |
---|
300 | sout | "Your weight on" | labelE(p) | "is" | wd(1,1, surfaceWeight( p, mass )) | "kg"; |
---|
301 | } |
---|
302 | } |
---|
303 | |
---|
304 | $\$$ planet 100 |
---|
305 | Your weight on MERCURY is 37.7 kg |
---|
306 | Your weight on VENUS is 90.5 kg |
---|
307 | Your weight on EARTH is 100.0 kg |
---|
308 | Your weight on MOON is 16.6 kg |
---|
309 | Your weight on MARS is 37.9 kg |
---|
310 | Your weight on JUPITER is 252.8 kg |
---|
311 | Your weight on SATURN is 106.6 kg |
---|
312 | Your weight on URANUS is 90.5 kg |
---|
313 | Your weight on NEPTUNE is 113.8 kg |
---|
314 | \end{cfa} |
---|
315 | \caption{Planet Example} |
---|
316 | \label{f:PlanetExample} |
---|
317 | \end{figure} |
---|