source: doc/uC++toCFA/uC++toCFA.tex@ 0c88135

Last change on this file since 0c88135 was 3733643, checked in by Peter A. Buhr <pabuhr@…>, 16 months ago

multiple changes to reflect updates in Cforall

  • Property mode set to 100644
File size: 14.3 KB
Line 
1%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -*- Mode: Latex -*- %%%%%%%%%%%%%%%%%%%%%%%%%%%%
2%%
3%% Cforall Version 1.0.0 Copyright (C) 2016 University of Waterloo
4%%
5%% The contents of this file are covered under the licence agreement in the
6%% file "LICENCE" distributed with Cforall.
7%%
8%% user.tex --
9%%
10%% Author : Peter A. Buhr
11%% Created On : Wed Apr 6 14:53:29 2016
12%% Last Modified By : Peter A. Buhr
13%% Last Modified On : Fri Sep 13 07:48:54 2024
14%% Update Count : 5987
15%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
16
17% requires tex packages: texlive-base texlive-latex-base tex-common texlive-humanities texlive-latex-extra texlive-fonts-recommended
18
19\documentclass[11pt]{article}
20
21\makeatletter
22\def\@maketitle{%
23 \newpage
24 \null
25% \vskip 2em%
26 \begin{center}%
27 \let \footnote \thanks
28 {\LARGE\bf \@title \par}%
29 \@ifundefined{@author}{}
30 {
31 \ifx\@empty\@author
32 \else
33 \vskip 1.5em%
34 {\large
35 \lineskip .5em%
36 \begin{tabular}[t]{c}%
37 \@author
38 \end{tabular}%
39 \par
40 }%
41 \fi
42 }%
43 \ifx\@empty\@date
44 \else
45 \vskip 1em%
46 {\large \@date}%
47 \fi
48 \end{center}%
49 \par
50% \vskip 1.5em
51}%maketitle
52\makeatother
53
54%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
55
56% Latex packages used in the document.
57%\usepackage[T1]{fontenc} % allow Latin1 (extended ASCII) characters
58%\usepackage{textcomp}
59%\usepackage[latin1]{inputenc}
60
61\usepackage{fullpage,times,comment}
62\usepackage{epic,eepic}
63\usepackage{upquote} % switch curled `'" to straight
64\usepackage[labelformat=simple,aboveskip=0pt,farskip=0pt]{subfig}
65\renewcommand{\thesubfigure}{\alph{subfigure})}
66\usepackage{latexsym} % \Box glyph
67\usepackage{mathptmx} % better math font with "times"
68\usepackage[usenames]{color}
69\usepackage[pagewise]{lineno}
70\renewcommand{\linenumberfont}{\scriptsize\sffamily}
71\input{common} % common CFA document macros
72\usepackage[dvips,plainpages=false,pdfpagelabels,pdfpagemode=UseNone,colorlinks=true,pagebackref=true,linkcolor=blue,citecolor=blue,urlcolor=blue,pagebackref=true,breaklinks=true]{hyperref}
73\usepackage{breakurl}
74
75\renewcommand\footnoterule{\kern -3pt\rule{0.3\linewidth}{0.15pt}\kern 2pt}
76\newcommand{\uC}{$\mu$\CC}
77
78% Default underscore is too low and wide. Cannot use lstlisting "literate" as replacing underscore
79% removes it as a variable-name character so keywords in variables are highlighted. MUST APPEAR
80% AFTER HYPERREF.
81\renewcommand{\textunderscore}{\leavevmode\makebox[1.2ex][c]{\rule{1ex}{0.075ex}}}
82
83\setlength{\topmargin}{-0.45in} % move running title into header
84\setlength{\headsep}{0.25in}
85
86%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
87
88\setlength{\gcolumnposn}{3in}
89\CFAStyle % use default CFA format-style
90\lstset{language=CFA} % CFA default lnaguage
91\lstnewenvironment{C++}[1][] % use C++ style
92{\lstset{language=C++,escapechar=\$,mathescape=false,moredelim=**[is][\protect\color{red}]{@}{@},#1}}{}
93\lstnewenvironment{uC++}[1][]
94{\lstset{language=uC++,escapechar=\$,mathescape=false,moredelim=**[is][\protect\color{red}]{@}{@},#1}}{}
95
96\newsavebox{\myboxA}
97\newsavebox{\myboxB}
98
99%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
100
101% Names used in the document.
102\newcommand{\Version}{\input{build/version}}
103\newcommand{\Textbf}[2][red]{{\color{#1}{\textbf{#2}}}}
104\newcommand{\Emph}[2][red]{{\color{#1}\textbf{\emph{#2}}}}
105\newcommand{\R}[1]{{\color{red}#1}}
106\newcommand{\RB}[1]{\Textbf{#1}}
107\newcommand{\B}[1]{{\Textbf[blue]{#1}}}
108\newcommand{\G}[1]{{\Textbf[OliveGreen]{#1}}}
109\newcommand{\Sp}{\R{\textvisiblespace}}
110\newcommand{\KWC}{K-W C\xspace}
111
112%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
113
114\setcounter{secnumdepth}{3} % number subsubsections
115\setcounter{tocdepth}{3} % subsubsections in table of contents
116\makeindex
117
118%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
119
120\title{\vspace*{-0.5in}
121\uC to \CFA Cheat Sheet}
122%\author{Peter A. Buhr}
123\date{}
124
125%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
126
127\begin{document}
128\pagestyle{headings}
129% changed after setting pagestyle
130\renewcommand{\sectionmark}[1]{\markboth{\thesection\quad #1}{\thesection\quad #1}}
131\renewcommand{\subsectionmark}[1]{\markboth{\thesubsection\quad #1}{\thesubsection\quad #1}}
132
133%\linenumbers % comment out to turn off line numbering
134
135\maketitle
136\vspace*{-0.55in}
137
138\section{Introduction}
139
140\CFA is NOT an object-oriented programming-language.
141\CFA uses parametric polymorphism and allows overloading of variables and routines:
142\begin{cfa}
143int i; char i; double i; $\C[2in]{// overload name i}$
144int i(); double i(); char i();
145i += 1; $\C{// int i}$
146i += 1.0; $\C{// double i}$
147i += 'a'; $\C{// char i}$
148int j = i(); $\C{// int i()}$
149double j = i(); $\C{// double i();}$
150char j = i(); $\C{// char i()}\CRT$
151\end{cfa}
152\CFA has rebindable references.
153\begin{cquote}
154\begin{tabular}{@{}l|l@{}}
155\multicolumn{2}{@{}l}{\lstinline{ int x = 1, y = 2, * p1x = &x, * p1y = &y, ** p2i = &p1x,}} \\
156\multicolumn{2}{@{}l}{\lstinline{\ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ \ & r1x = x, & r1y = y, && r2i = r1x;}} \\
157\begin{uC++}
158**p2i = 3;
159p2i = &p1y;
160**p2i = 3;
161p1x = p1y;
162**p2i = 4;
163p1x = @nullptr@;
164\end{uC++}
165&
166\begin{cfa}
167r2i = 3; $\C[1.0in]{// change x}$
168&r2i = &r1y; $\C{// change p2i / r2i}$
169r2i = 3; $\C{// change y}$
170&r1x = &r1y; $\C{// change p1x / r1x}$
171r2i = 4; $\C{// change y}$
172&r1x = @0p@; $\C{// reset}\CRT$
173\end{cfa}
174\end{tabular}
175\end{cquote}
176Non-rebindable reference (\CC reference) is a @const@ reference (@const@ pointer).
177\begin{cfa}
178int & @const@ cr = x; // must initialize, no null pointer
179int & @const@ & @const@ crcr = cr; // generalize
180\end{cfa}
181Aggregate qualification is reduced or eliminated by opening scopes using the @with@ clause.
182\begin{cfa}
183struct S { int i; int j; double m; }; // field i has same type in structures S and T
184struct T { int i; int k; int m; };
185void foo( S s, T t ) @with(s, t)@ { // open structure scope s and t in parallel
186 j + k; $\C[1.6in]{// unambiguous, s.j + t.k}$
187 m = 5.0; $\C{// unambiguous, s.m = 5.0}$
188 m = 1; $\C{// unambiguous, t.m = 1}$
189 int a = m; $\C{// unambiguous, a = t.m}$
190 double b = m; $\C{// unambiguous, b = s.m}$
191 int c = s.i + t.i; $\C{// unambiguous with qualification}$
192 (double)m; $\C{// unambiguous with cast s.m}\CRT$
193}
194\end{cfa}
195\noindent
196In subsequent code examples, the left example is \uC and the right example is \CFA.
197
198
199\section{Stream I/O}
200
201\CFA output streams automatically separate values and insert a newline at the end of the print.
202\begin{cquote}
203\begin{tabular}{@{}l|l@{}}
204\begin{uC++}
205#include <@iostream@>
206using namespace std;
207int i; double d; char c;
208cin >> i >> d >> c;
209cout << i << ' ' << d << ' ' << c | endl;
210\end{uC++}
211&
212\begin{cfa}
213#include <@fstream.hfa@>
214
215int i; double d; char c;
216sin | i | d | c;
217sout | i | d | c
218\end{cfa}
219\end{tabular}
220\end{cquote}
221
222
223\section{Looping}
224
225\begin{cquote}
226\begin{tabular}{@{}l|l@{}}
227\begin{uC++}
228for ( @;;@ ) { ... } / while ( @true@ ) { ... }
229for ( int i = 0; i < @10@; i += 1 ) { ... }
230for ( int i = @5@; i < @15@; i += @2@ ) { ... }
231for ( int i = -1; i <@=@ 10; i += 3 ) { ... }
232for ( int i = 10; i > 0; i @-@= 1 ) { ... }
233\end{uC++}
234&
235\begin{cfa}
236for () { ... } / while () { ... }
237for ( @10@ ) { ... } / for ( i; @10@ ) { ... }
238for ( i; @5@ ~ @15@ ~ @2@ ) { ... }
239for ( i; -1 ~@=@ 10 ~ 3 ) { ... }
240for ( i; 0 @-@~ 10 ) { ... }
241\end{cfa}
242\\
243\hline
244\begin{uC++}
245int i = 0
246for ( i = 0; i < 10; i += 1 ) { ... }
247@if ( i == 10 )@ { ... }
248\end{uC++}
249&
250\begin{cfa}
251
252for ( i; 10 ) { ... }
253@else@ { ... } // i == 10
254\end{cfa}
255\\
256\hline
257\begin{uC++}
258L1: for ( ;; ) {
259 L2: for ( ;; ) {
260 ... @break L1@; ... @break L2@; ...
261 }
262}
263\end{uC++}
264&
265\begin{cfa}
266L1: for () {
267 L2: for () {
268 ... @break L1@; ... @break L2@; ...
269 }
270}
271\end{cfa}
272\end{tabular}
273\end{cquote}
274
275
276\section{Exception}
277
278Currently, \CFA uses macros @ExceptionDecl@ and @ExceptionInst@ to declare and instantiate an exception.
279\begin{cquote}
280\begin{tabular}{@{}l|ll@{}}
281\begin{uC++}
282
283@_Exception@ E { // local or global scope
284 ... // exception fields
285};
286try {
287 ...
288 if ( ... ) @_Resume@ E( /* initialization */ );
289 if ( ... ) @_Throw@ E( /* initialization */ );
290 ...
291} @_CatchResume@( E & ) { // should be reference
292 ...
293} catch( E & ) {
294 ...
295}
296\end{uC++}
297&
298\begin{cfa}
299#include <Exception.hfa>
300@ExceptionDecl@( E, // must be global scope
301 ... // exception fields
302);
303try {
304 ...
305 if ( ... ) @throwResume@ @ExceptionInst@( E, /* intialization */ );
306 if ( ... ) @throw@ @ExceptionInst@( E, /* intialization */ );
307 ...
308} @catchResume@( E * ) { // must be pointer
309 ...
310} catch( E * ) {
311 ...
312}
313\end{cfa}
314\end{tabular}
315\end{cquote}
316
317
318\section{Non-local Exception}
319
320\begin{cquote}
321\begin{tabular}{@{}l|ll@{}}
322\begin{uC++}
323
324
325void main() {
326 try {
327 _Enable {
328 ... suspend(); ...
329 }
330 } @_CatchResume@( E & ) { // reference
331 ...
332 } catch( E & ) {
333 ...
334 }
335}
336\end{uC++}
337&
338\begin{cfa}
339#define resumePoll( coroutine ) resume( coroutine ); checked_poll()
340#define suspendPoll suspend; checked_poll()
341void main() {
342 try {
343 enable_ehm();
344 ... suspendPoll ...
345 disable_ehm();
346 } @catchResume@( E * ) { // pointer
347 ...
348 } catch( E & ) {
349 ...
350 }
351}
352\end{cfa}
353\end{tabular}
354\end{cquote}
355
356
357\section{Constructor / Destructor}
358
359\begin{cquote}
360\begin{tabular}{@{}l|l@{}}
361\begin{uC++}
362struct S {
363 ... // fields
364 @S@(...) { ... }
365 @~S@(...) { ... }
366};
367\end{uC++}
368&
369\begin{cfa}
370struct S {
371 ... // fields
372};
373@?{}@( @S & s,@ ...) { ... }
374@^?{}@( @S & s@ ) { ... }
375\end{cfa}
376\end{tabular}
377\end{cquote}
378
379
380\section{String}
381
382\begin{cquote}
383\begin{tabular}{@{}l|l@{}}
384\multicolumn{2}{@{}l@{}}{\lstinline{string s1, s2;}} \\
385\begin{uC++}
386s1 = "abcdefg";
387s2 = s1;
388s1 += s2;
389s1 == s2; s1 != s2;
390s1 < s2; s1 <= s2; s1 > s2; s1 >= s2;
391s1.length();
392s1[3];
393s1.substr( 2 ); s1.substr( 2, 3 );
394s1.replace( 2, 5, s2 );
395s1.find( s2 ); s1.rfind( s2 );
396s1.find_first_of( s2 ); s1.find_last_of( s2 );
397s1.find_first_not_of( s2 ); s1.find_last_not_of( s2 );
398getline( cin, s1 );
399cout << s1 << endl;
400\end{uC++}
401&
402\begin{cfa}
403s1 = "abcdefg";
404s2 = s1;
405s1 += s2;
406s1 == s2; s1 != s2;
407s1 < s2; s1 <= s2; s1 > s2; s1 >= s2;
408size( s1 );
409s1[3];
410s1( 2 ); s1( 2, 3 );
411// replace( s1, 2, 5, s2 );
412// find( s1, s2 ), rfind( s1, s2 );
413// find_first_of( s2 ); find_last_of( s2 );
414// find_first_not_of( s1, s2 ); find_last_not_of( s1, s2 );
415sin | getline( s1 );
416sout | s1;
417\end{cfa}
418\end{tabular}
419\end{cquote}
420
421
422\section{\texorpdfstring{Structures (object-oriented \protect\vs routine style)}{Structures (object-oriented vs. routine style)}}
423
424\begin{cquote}
425\begin{tabular}{@{}l|l@{}}
426\begin{uC++}
427struct S {
428 int i = 0; // cheat, implicit default constructor
429 int setter( int j ) { int t = i; i = j; return t; }
430 int getter() { return i; }
431};
432
433S s;
434@s.@setter( 3 ); // object-oriented calls
435int k = @s.@getter();
436\end{uC++}
437&
438\begin{cfa}
439struct S {
440 int i;
441};
442void ?{}( S & s ) { s.i = 0; } // explicit default constructor
443int setter( @S & s,@ int j ) @with(s)@ { int t = i; i = j; return t; }
444int getter( @S & s@ ) @with(s)@ { return i; }
445S s;
446setter( @s,@ 3 ); // normal routine calls
447int k = getter( @s@ );
448\end{cfa}
449\end{tabular}
450\end{cquote}
451
452
453\section{\texorpdfstring{\lstinline{uArray}}{uArray}}
454
455\begin{cquote}
456\begin{tabular}{@{}l|l@{}}
457\begin{uC++}
458#include <iostream>
459using namespace std;
460struct S {
461 int i;
462 S( int i ) { S::i = i; cout << "ctor " << S::i << endl; }
463 ~S() { S::i = i; cout << "dtor " << S::i << endl; }
464};
465int main() {
466 enum { N = 5 };
467 @uArray( S, s, N );@ // no constructor calls
468 for ( int i = 0; i < N; i += 1 ) @s[i]( i )@; // constructor calls
469 for ( int i = 0; i < N; i += 1 ) cout << s[i]@->@i << endl;
470}
471\end{uC++}
472&
473\begin{cfa}
474#include <fstream.hfa>
475#include <array.hfa>
476struct S {
477 int i;
478};
479void ?{}( S & s, int i ) { s.i = i; sout | "ctor" | s.i; }
480void ^?{}( S & s ) { sout | "dtor" | s.i; }
481int main() {
482 enum { N = 5 };
483 @array( S, N ) s = { delay_init };@ // no constructor calls
484 for ( i; N ) @s[i]{ i }@; // constructor calls
485 for ( i; N ) sout | s[i]@.@i;
486}
487\end{cfa}
488\end{tabular}
489\end{cquote}
490
491
492\section{Coroutines}
493
494\begin{cquote}
495\begin{tabular}{@{}l|ll@{}}
496\begin{uC++}
497
498_Coroutine C {
499 // private coroutine fields
500 void main() {
501 ... suspend(); ...
502 ... _Resume E( ... ) _At partner;
503 }
504 public:
505 void mem( ... ) {
506 ... resume() ...
507 }
508};
509\end{uC++}
510&
511\begin{cfa}
512#include <$coroutine$.hfa>
513coroutine C {
514 // private coroutine fields
515
516};
517void main( C & c ) {
518 ... suspend; ... // keyword not routine
519 ... resumeAt( partner, ExceptionInst( E, ... ) );
520}
521void mem( C & c, ... ) {
522 ... resume(); ...
523}
524\end{cfa}
525\\
526\multicolumn{2}{@{}l@{}}{\lstinline{C c;}}
527\end{tabular}
528\end{cquote}
529
530
531\section{Locks}
532
533\begin{cquote}
534\begin{tabular}{@{}l|ll@{}}
535\begin{uC++}
536
537uOwnerLock m;
538uCondLock s;
539bool avail = true;
540m.acquire();
541if ( ! avail ) s.wait( m );
542else {
543 avail = false;
544 m.release();
545}
546@osacquire( cout )@ << i << endl;
547\end{uC++}
548&
549\begin{cfa}
550#include <locks.hfa>
551owner_lock m;
552condition_variable( owner_lock ) s;
553bool avail = true;
554lock( m );
555if ( ! avail ) wait( s, m );
556else {
557 avail = false;
558 unlock( m );
559}
560@mutex( sout )@ sout | i; // safe I/O
561\end{cfa}
562\end{tabular}
563\end{cquote}
564
565
566\section{Monitors}
567
568\begin{cquote}
569\begin{tabular}{@{}l|ll@{}}
570\begin{uC++}
571
572@_Monitor@ M {
573 @uCondition@ c;
574 bool avail = true;
575 public:
576
577 void rtn() {
578 if ( ! avail ) c.wait();
579 else avail = false;
580 }
581};
582\end{uC++}
583&
584\begin{cfa}
585#include <$monitor$.hfa>
586@monitor@ M {
587 @condition@ c;
588 bool avail;
589};
590void ?{}( M & m ) { m.avail = true; }
591void rtn( M & m ) with( m ) {
592 if ( ! avail ) wait( c );
593 else avail = false;
594}
595
596\end{cfa}
597\\
598\multicolumn{2}{@{}l@{}}{\lstinline{M m;}}
599\end{tabular}
600\end{cquote}
601
602
603\section{Threads}
604
605\begin{cquote}
606\begin{tabular}{@{}l|ll@{}}
607\begin{uC++}
608
609@_Task@ T {
610 // private task fields
611 void main() {
612 ... _Resume E( ... ) _At partner;
613 }
614 public:
615};
616\end{uC++}
617&
618\begin{cfa}
619#include <$thread$.hfa>
620@thread@ T {
621 // private task fields
622
623};
624void main( @T & t@ ) {
625 ... resumeAt( partner, ExceptionInst( E, ... ) );
626}
627\end{cfa}
628\\
629\multicolumn{2}{@{}l@{}}{\lstinline{T t; // start thread in main routine}}
630\end{tabular}
631\end{cquote}
632
633
634\input{uC++toCFA.ind}
635
636% \bibliographystyle{plain}
637% \bibliography{pl}
638
639\end{document}
640
641% Local Variables: %
642% tab-width: 4 %
643% fill-column: 100 %
644% compile-command: "make" %
645% End: %
Note: See TracBrowser for help on using the repository browser.