\documentclass{article} \usepackage{fullpage} \usepackage{epic,eepic} \usepackage{xspace,calc,comment} \usepackage{upquote} % switch curled `'" to straight \usepackage{listings} % format program code \usepackage{enumitem} \usepackage[flushmargin]{footmisc} % support label/reference in footnote \usepackage{rotating} \usepackage[usenames]{color} \usepackage{pslatex} % reduce size of san serif font \usepackage[plainpages=false,pdfpagelabels,pdfpagemode=UseNone,pagebackref=true,breaklinks=true,colorlinks=true,linkcolor=blue,citecolor=blue,urlcolor=blue]{hyperref} \setlength{\textheight}{9in} %\oddsidemargin 0.0in \renewcommand{\topfraction}{0.8} % float must be greater than X of the page before it is forced onto its own page \renewcommand{\bottomfraction}{0.8} % float must be greater than X of the page before it is forced onto its own page \renewcommand{\floatpagefraction}{0.8} % float must be greater than X of the page before it is forced onto its own page \renewcommand{\textfraction}{0.0} % the entire page maybe devoted to floats with no text on the page at all \lefthyphenmin=4 % hyphen only after 4 characters \righthyphenmin=4 % Names used in the document. \newcommand{\CFAIcon}{\textsf{C}\raisebox{\depth}{\rotatebox{180}{\textsf{A}}}\xspace} % Cforall symbolic name \newcommand{\CFA}{\protect\CFAIcon} % safe for section/caption \newcommand{\CFL}{\textrm{Cforall}\xspace} % Cforall symbolic name \newcommand{\Celeven}{\textrm{C11}\xspace} % C11 symbolic name \newcommand{\CC}{\textrm{C}\kern-.1em\hbox{+\kern-.25em+}\xspace} % C++ symbolic name \newcommand{\CCeleven}{\textrm{C}\kern-.1em\hbox{+\kern-.25em+}11\xspace} % C++11 symbolic name \newcommand{\CCfourteen}{\textrm{C}\kern-.1em\hbox{+\kern-.25em+}14\xspace} % C++14 symbolic name \newcommand{\CCseventeen}{\textrm{C}\kern-.1em\hbox{+\kern-.25em+}17\xspace} % C++17 symbolic name \newcommand{\CCtwenty}{\textrm{C}\kern-.1em\hbox{+\kern-.25em+}20\xspace} % C++20 symbolic name \newcommand{\CCV}{\rm C\kern-.1em\hbox{+\kern-.25em+}obj\xspace} % C++ virtual symbolic name \newcommand{\Csharp}{C\raisebox{-0.7ex}{\Large$^\sharp$}\xspace} % C# symbolic name %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \newcommand{\Textbf}[2][red]{{\color{#1}{\textbf{#2}}}} \newcommand{\TODO}[1]{\textbf{TODO}: {\itshape #1}} % TODO included %\newcommand{\TODO}[1]{} % TODO elided % Default underscore is too low and wide. Cannot use lstlisting "literate" as replacing underscore % removes it as a variable-name character so keywords in variables are highlighted. MUST APPEAR % AFTER HYPERREF. %\DeclareTextCommandDefault{\textunderscore}{\leavevmode\makebox[1.2ex][c]{\rule{1ex}{0.1ex}}} \renewcommand{\textunderscore}{\leavevmode\makebox[1.2ex][c]{\rule{1ex}{0.075ex}}} \makeatletter % parindent is relative, i.e., toggled on/off in environments like itemize, so store the value for % use rather than use \parident directly. \newlength{\parindentlnth} \setlength{\parindentlnth}{\parindent} \newcommand{\LstKeywordStyle}[1]{{\lst@basicstyle{\lst@keywordstyle{#1}}}} \newcommand{\LstCommentStyle}[1]{{\lst@basicstyle{\lst@commentstyle{#1}}}} \newlength{\gcolumnposn} % temporary hack because lstlisting does not handle tabs correctly \newlength{\columnposn} \setlength{\gcolumnposn}{2.75in} \setlength{\columnposn}{\gcolumnposn} \newcommand{\C}[2][\@empty]{\ifx#1\@empty\else\global\setlength{\columnposn}{#1}\global\columnposn=\columnposn\fi\hfill\makebox[\textwidth-\columnposn][l]{\lst@basicstyle{\LstCommentStyle{#2}}}} \newcommand{\CRT}{\global\columnposn=\gcolumnposn} % Denote newterms in particular font and index them without particular font and in lowercase, e.g., \newterm{abc}. % The option parameter provides an index term different from the new term, e.g., \newterm[\texttt{abc}]{abc} % The star version does not lowercase the index information, e.g., \newterm*{IBM}. \newcommand{\newtermFontInline}{\emph} \newcommand{\newterm}{\@ifstar\@snewterm\@newterm} \newcommand{\@newterm}[2][\@empty]{\lowercase{\def\temp{#2}}{\newtermFontInline{#2}}\ifx#1\@empty\index{\temp}\else\index{#1@{\protect#2}}\fi} \newcommand{\@snewterm}[2][\@empty]{{\newtermFontInline{#2}}\ifx#1\@empty\index{#2}\else\index{#1@{\protect#2}}\fi} % Latin abbreviation \newcommand{\abbrevFont}{\textit} % set empty for no italics \newcommand{\EG}{\abbrevFont{e}.\abbrevFont{g}.} \newcommand*{\eg}{% \@ifnextchar{,}{\EG}% {\@ifnextchar{:}{\EG}% {\EG,\xspace}}% }% \newcommand{\IE}{\abbrevFont{i}.\abbrevFont{e}.} \newcommand*{\ie}{% \@ifnextchar{,}{\IE}% {\@ifnextchar{:}{\IE}% {\IE,\xspace}}% }% \newcommand{\ETC}{\abbrevFont{etc}} \newcommand*{\etc}{% \@ifnextchar{.}{\ETC}% {\ETC\xspace}% }% \newcommand{\ETAL}{\abbrevFont{et}\hspace{2pt}\abbrevFont{al}} \newcommand*{\etal}{% \@ifnextchar{.}{\protect\ETAL}% {\abbrevFont{\protect\ETAL}.\xspace}% }% \newcommand{\VIZ}{\abbrevFont{viz}} \newcommand*{\viz}{% \@ifnextchar{.}{\VIZ}% {\abbrevFont{\VIZ}.\xspace}% }% \makeatother \newenvironment{cquote}{% \list{}{\lstset{resetmargins=true,aboveskip=0pt,belowskip=0pt}\topsep=4pt\parsep=0pt\leftmargin=\parindentlnth\rightmargin\leftmargin}% \item\relax }{% \endlist }% cquote % CFA programming language, based on ANSI C (with some gcc additions) \lstdefinelanguage{CFA}[ANSI]{C}{ morekeywords={ _Alignas, _Alignof, __alignof, __alignof__, asm, __asm, __asm__, _At, __attribute, __attribute__, auto, _Bool, catch, catchResume, choose, _Complex, __complex, __complex__, __const, __const__, disable, dtype, enable, __extension__, fallthrough, fallthru, finally, forall, ftype, _Generic, _Imaginary, inline, __label__, lvalue, _Noreturn, one_t, otype, restrict, _Static_assert, throw, throwResume, trait, try, ttype, typeof, __typeof, __typeof__, virtual, with, zero_t}, moredirectives={defined,include_next}% }% \lstset{ language=CFA, columns=fullflexible, basicstyle=\linespread{0.9}\sf, % reduce line spacing and use sanserif font stringstyle=\tt, % use typewriter font tabsize=5, % N space tabbing xleftmargin=\parindentlnth, % indent code to paragraph indentation %mathescape=true, % LaTeX math escape in CFA code $...$ escapechar=\$, % LaTeX escape in CFA code keepspaces=true, % showstringspaces=false, % do not show spaces with cup showlines=true, % show blank lines at end of code aboveskip=4pt, % spacing above/below code block belowskip=3pt, % replace/adjust listing characters that look bad in sanserif literate={-}{\makebox[1ex][c]{\raisebox{0.4ex}{\rule{0.8ex}{0.1ex}}}}1 {^}{\raisebox{0.6ex}{$\scriptscriptstyle\land\,$}}1 {~}{\raisebox{0.3ex}{$\scriptstyle\sim\,$}}1 % {`}{\ttfamily\upshape\hspace*{-0.1ex}`}1 {<-}{$\leftarrow$}2 {=>}{$\Rightarrow$}2 {->}{\makebox[1ex][c]{\raisebox{0.4ex}{\rule{0.8ex}{0.075ex}}}\kern-0.2ex\textgreater}2, moredelim=**[is][\color{red}]{`}{`}, }% lstset % inline code @...@ \lstMakeShortInline@% \lstnewenvironment{cfa}[1][] {\lstset{#1}} {} \lstnewenvironment{C++}[1][] % use C++ style {\lstset{language=C++,moredelim=**[is][\protect\color{red}]{`}{`},#1}\lstset{#1}} {} \title{Generic and Tuple Types with Efficient Dynamic Layout in \protect\CFA} \author{Aaron Moss, Robert Schluntz, Peter Buhr} % \email{a3moss@uwaterloo.ca} % \email{rschlunt@uwaterloo.ca} % \email{pabuhr@uwaterloo.ca} % \affiliation{% % \institution{University of Waterloo} % \department{David R. Cheriton School of Computer Science} % \streetaddress{Davis Centre, University of Waterloo} % \city{Waterloo} % \state{ON} % \postcode{N2L 3G1} % \country{Canada} % } %\terms{generic, tuple, variadic, types} %\keywords{generic types, tuple types, variadic types, polymorphic functions, C, Cforall} \begin{document} \maketitle \begin{abstract} The C programming language is a foundational technology for modern computing with millions of lines of code implementing everything from commercial operating-systems to hobby projects. This installation base and the programmers producing it represent a massive software-engineering investment spanning decades and likely to continue for decades more. Nonetheless, C, first standardized over thirty years ago, lacks many features that make programming in more modern languages safer and more productive. The goal of the \CFA project is to create an extension of C that provides modern safety and productivity features while still ensuring strong backwards compatibility with C and its programmers. Prior projects have attempted similar goals but failed to honour C programming-style; for instance, adding object-oriented or functional programming with garbage collection is a non-starter for many C developers. Specifically, \CFA is designed to have an orthogonal feature-set based closely on the C programming paradigm, so that \CFA features can be added \emph{incrementally} to existing C code-bases, and C programmers can learn \CFA extensions on an as-needed basis, preserving investment in existing code and engineers. This paper describes two \CFA extensions, generic and tuple types, details how their design avoids shortcomings of similar features in C and other C-like languages, and presents experimental results validating the design. \end{abstract} \section{Introduction and Background} The C programming language is a foundational technology for modern computing with millions of lines of code implementing everything from commercial operating-systems to hobby projects. This installation base and the programmers producing it represent a massive software-engineering investment spanning decades and likely to continue for decades more. The TIOBE~\cite{TIOBE} ranks the top 5 most popular programming languages as: Java 16\%, \Textbf{C 7\%}, \Textbf{\CC 5\%}, \Csharp 4\%, Python 4\% = 36\%, where the next 50 languages are less than 3\% each with a long tail. The top 3 rankings over the past 30 years are: \begin{center} \setlength{\tabcolsep}{10pt} \lstDeleteShortInline@% \begin{tabular}{@{}rccccccc@{}} & 2017 & 2012 & 2007 & 2002 & 1997 & 1992 & 1987 \\ \hline Java & 1 & 1 & 1 & 1 & 12 & - & - \\ \Textbf{C} & \Textbf{2}& \Textbf{2}& \Textbf{2}& \Textbf{2}& \Textbf{1}& \Textbf{1}& \Textbf{1} \\ \CC & 3 & 3 & 3 & 3 & 2 & 2 & 4 \\ \end{tabular} \lstMakeShortInline@% \end{center} Love it or hate it, C is extremely popular, highly used, and one of the few systems languages. In many cases, \CC is often used solely as a better C. Nonetheless, C, first standardized over thirty years ago, lacks many features that make programming in more modern languages safer and more productive. \CFA (pronounced ``C-for-all'', and written \CFA or Cforall) is an evolutionary extension of the C programming language that aims to add modern language features to C while maintaining both source compatibility with C and a familiar programming model for programmers. The four key design goals for \CFA~\cite{Bilson03} are: (1) The behaviour of standard C code must remain the same when translated by a \CFA compiler as when translated by a C compiler; (2) Standard C code must be as fast and as small when translated by a \CFA compiler as when translated by a C compiler; (3) \CFA code must be at least as portable as standard C code; (4) Extensions introduced by \CFA must be translated in the most efficient way possible. These goals ensure existing C code-bases can be converted to \CFA incrementally with minimal effort, and C programmers can productively generate \CFA code without training beyond the features being used. \CC is used similarly, but has the disadvantages of multiple legacy design-choices that cannot be updated and active divergence of the language model from C, requiring significant effort and training to incrementally add \CC to a C-based project. \CFA is currently implemented as a source-to-source translator from \CFA to the GCC-dialect of C~\cite{GCCExtensions}, allowing it to leverage the portability and code optimizations provided by GCC, meeting goals (1)--(3). Ultimately, a compiler is necessary for advanced features and optimal performance. This paper identifies shortcomings in existing approaches to generic and variadic data types in C-like languages and presents a design for generic and variadic types avoiding those shortcomings. Specifically, the solution is both reusable and type-checked, as well as conforming to the design goals of \CFA with ergonomic use of existing C abstractions. The new constructs are empirically compared with both standard C and \CC; the results show the new design is comparable in performance. \subsection{Polymorphic Functions} \label{sec:poly-fns} \CFA{}\hspace{1pt}'s polymorphism was originally formalized by Ditchfield~\cite{Ditchfield92}, and first implemented by Bilson~\cite{Bilson03}. The signature feature of \CFA is parametric-polymorphic functions~\cite{forceone:impl,Cormack90,Duggan96} with functions generalized using a @forall@ clause (giving the language its name): \begin{lstlisting} `forall( otype T )` T identity( T val ) { return val; } int forty_two = identity( 42 ); $\C{// T is bound to int, forty\_two == 42}$ \end{lstlisting} The @identity@ function above can be applied to any complete \newterm{object type} (or @otype@). The type variable @T@ is transformed into a set of additional implicit parameters encoding sufficient information about @T@ to create and return a variable of that type. The \CFA implementation passes the size and alignment of the type represented by an @otype@ parameter, as well as an assignment operator, constructor, copy constructor and destructor. If this extra information is not needed, \eg for a pointer, the type parameter can be declared as a \newterm{data type} (or @dtype@). In \CFA, the polymorphism runtime-cost is spread over each polymorphic call, due to passing more arguments to polymorphic functions; the experiments in Section~\ref{sec:eval} show this overhead is similar to \CC virtual-function calls. A design advantage is that, unlike \CC template-functions, \CFA polymorphic-functions are compatible with C \emph{separate compilation}, preventing compilation and code bloat. Since bare polymorphic-types provide a restricted set of available operations, \CFA provides a \newterm{type assertion}~\cite[pp.~37-44]{Alphard} mechanism to provide further type information, where type assertions may be variable or function declarations that depend on a polymorphic type-variable. For example, the function @twice@ can be defined using the \CFA syntax for operator overloading: \begin{lstlisting} forall( otype T `| { T ?+?(T, T); }` ) T twice( T x ) { return x + x; } $\C{// ? denotes operands}$ int val = twice( twice( 3.7 ) ); \end{lstlisting} which works for any type @T@ with a matching addition operator. The polymorphism is achieved by creating a wrapper function for calling @+@ with @T@ bound to @double@, then passing this function to the first call of @twice@. There is now the option of using the same @twice@ and converting the result to @int@ on assignment, or creating another @twice@ with type parameter @T@ bound to @int@ because \CFA uses the return type~\cite{Cormack81,Baker82,Ada}, in its type analysis. The first approach has a late conversion from @double@ to @int@ on the final assignment, while the second has an eager conversion to @int@. \CFA minimizes the number of conversions and their potential to lose information, so it selects the first approach, which corresponds with C-programmer intuition. Crucial to the design of a new programming language are the libraries to access thousands of external software features. Like \CC, \CFA inherits a massive compatible library-base, where other programming languages must rewrite or provide fragile inter-language communication with C. A simple example is leveraging the existing type-unsafe (@void *@) C @bsearch@ to binary search a sorted float array: \begin{lstlisting} void * bsearch( const void * key, const void * base, size_t nmemb, size_t size, int (* compar)( const void *, const void * )); int comp( const void * t1, const void * t2 ) { return *(double *)t1 < *(double *)t2 ? -1 : *(double *)t2 < *(double *)t1 ? 1 : 0; } double key = 5.0, vals[10] = { /* 10 sorted float values */ }; double * val = (double *)bsearch( &key, vals, 10, sizeof(vals[0]), comp ); $\C{// search sorted array}$ \end{lstlisting} which can be augmented simply with a generalized, type-safe, \CFA-overloaded wrappers: \begin{lstlisting} forall( otype T | { int ?` y; } $\C{// locally override behaviour}$ qsort( vals, size ); $\C{// descending sort}$ } \end{lstlisting} Within the block, the nested version of @??@ and this local version overrides the built-in @?value; } % \end{lstlisting} % In the example above, @(list_iterator, int)@ satisfies @pointer_like@ by the user-defined dereference function, and @(list_iterator, list)@ also satisfies @pointer_like@ by the built-in dereference operator for pointers. Given a declaration @list_iterator it@, @*it@ can be either an @int@ or a @list@, with the meaning disambiguated by context (\eg @int x = *it;@ interprets @*it@ as an @int@, while @(*it).value = 42;@ interprets @*it@ as a @list@). % While a nominal-inheritance system with associated types could model one of those two relationships by making @El@ an associated type of @Ptr@ in the @pointer_like@ implementation, few such systems could model both relationships simultaneously. \section{Generic Types} One of the known shortcomings of standard C is that it does not provide reusable type-safe abstractions for generic data structures and algorithms. Broadly speaking, there are three approaches to implement abstract data-structures in C. One approach is to write bespoke data-structures for each context in which they are needed. While this approach is flexible and supports integration with the C type-checker and tooling, it is also tedious and error-prone, especially for more complex data structures. A second approach is to use @void *@--based polymorphism, \eg the C standard-library functions @bsearch@ and @qsort@; an approach which does allow reuse of code for common functionality. However, basing all polymorphism on @void *@ eliminates the type-checker's ability to ensure that argument types are properly matched, often requiring a number of extra function parameters, pointer indirection, and dynamic allocation that would not otherwise be needed. A third approach to generic code is to use preprocessor macros, which does allow the generated code to be both generic and type-checked, but errors may be difficult to interpret. Furthermore, writing and using preprocessor macros can be unnatural and inflexible. \CC, Java, and other languages use \newterm{generic types} to produce type-safe abstract data-types. \CFA also implements generic types that integrate efficiently and naturally with the existing polymorphic functions, while retaining backwards compatibility with C and providing separate compilation. However, for known concrete parameters, the generic-type definition can be inlined, like \CC templates. A generic type can be declared by placing a @forall@ specifier on a @struct@ or @union@ declaration, and instantiated using a parenthesized list of types after the type name: \begin{lstlisting} forall( otype R, otype S ) struct pair { R first; S second; }; forall( otype T ) T value( pair( const char *, T ) p ) { return p.second; } forall( dtype F, otype T ) T value_p( pair( F *, T * ) p ) { return * p.second; } pair( const char *, int ) p = { "magic", 42 }; int magic = value( p ); pair( void *, int * ) q = { 0, &p.second }; magic = value_p( q ); double d = 1.0; pair( double *, double * ) r = { &d, &d }; d = value_p( r ); \end{lstlisting} \CFA classifies generic types as either \newterm{concrete} or \newterm{dynamic}. Concrete types have a fixed memory layout regardless of type parameters, while dynamic types vary in memory layout depending on their type parameters. A type may have polymorphic parameters but still be concrete, called \newterm{dtype-static}. Polymorphic pointers are an example of dtype-static types, \eg @forall(dtype T) T *@ is a polymorphic type, but for any @T@, @T *@ is a fixed-sized pointer, and therefore, can be represented by a @void *@ in code generation. \CFA generic types also allow checked argument-constraints. For example, the following declaration of a sorted set-type ensures the set key supports equality and relational comparison: \begin{lstlisting} forall( otype Key | { _Bool ?==?(Key, Key); _Bool ?first, b->first ) ? : cmp( a->second, b->second ); } \end{lstlisting} Since @pair(T *, T * )@ is a concrete type, there are no implicit parameters passed to @lexcmp@, so the generated code is identical to a function written in standard C using @void *@, yet the \CFA version is type-checked to ensure the fields of both pairs and the arguments to the comparison function match in type. Another useful pattern enabled by reused dtype-static type instantiations is zero-cost \newterm{tag-structures}. Sometimes information is only used for type-checking and can be omitted at runtime, \eg: \begin{lstlisting} forall(dtype Unit) struct scalar { unsigned long value; }; struct metres {}; struct litres {}; forall(dtype U) scalar(U) ?+?( scalar(U) a, scalar(U) b ) { return (scalar(U)){ a.value + b.value }; } scalar(metres) half_marathon = { 21093 }; scalar(litres) swimming_pool = { 2500000 }; scalar(metres) marathon = half_marathon + half_marathon; scalar(litres) two_pools = swimming_pool + swimming_pool; marathon + swimming_pool; $\C{// compilation ERROR}$ \end{lstlisting} @scalar@ is a dtype-static type, so all uses have a single structure definition, containing @unsigned long@, and can share the same implementations of common functions like @?+?@. These implementations may even be separately compiled, unlike \CC template functions. However, the \CFA type-checker ensures matching types are used by all calls to @?+?@, preventing nonsensical computations like adding a length to a volume. \section{Tuples} \label{sec:tuples} In many languages, functions can return at most one value; however, many operations have multiple outcomes, some exceptional. Consider C's @div@ and @remquo@ functions, which return the quotient and remainder for a division of integer and float values, respectively. \begin{lstlisting} typedef struct { int quo, rem; } div_t; $\C{// from include stdlib.h}$ div_t div( int num, int den ); double remquo( double num, double den, int * quo ); div_t qr = div( 13, 5 ); $\C{// return quotient/remainder aggregate}$ int q; double r = remquo( 13.5, 5.2, &q ); $\C{// return remainder, alias quotient}$ \end{lstlisting} @div@ aggregates the quotient/remainder in a structure, while @remquo@ aliases a parameter to an argument. Both approaches are awkward. Alternatively, a programming language can directly support returning multiple values, \eg in \CFA: \begin{lstlisting} [ int, int ] div( int num, int den ); $\C{// return two integers}$ [ double, double ] div( double num, double den ); $\C{// return two doubles}$ int q, r; $\C{// overloaded variable names}$ double q, r; [ q, r ] = div( 13, 5 ); $\C{// select appropriate div and q, r}$ [ q, r ] = div( 13.5, 5.2 ); $\C{// assign into tuple}$ \end{lstlisting} Clearly, this approach is straightforward to understand and use; therefore, why do few programming languages support this obvious feature or provide it awkwardly? The answer is that there are complex consequences that cascade through multiple aspects of the language, especially the type-system. This section show these consequences and how \CFA handles them. \subsection{Tuple Expressions} The addition of multiple-return-value functions (MRVF) are useless without a syntax for accepting multiple values at the call-site. The simplest mechanism for capturing the return values is variable assignment, allowing the values to be retrieved directly. As such, \CFA allows assigning multiple values from a function into multiple variables, using a square-bracketed list of lvalue expressions (as above), called a \newterm{tuple}. However, functions also use \newterm{composition} (nested calls), with the direct consequence that MRVFs must also support composition to be orthogonal with single-returning-value functions (SRVF), \eg: \begin{lstlisting} printf( "%d %d\n", div( 13, 5 ) ); $\C{// return values seperated into arguments}$ \end{lstlisting} Here, the values returned by @div@ are composed with the call to @printf@ by flattening the tuple into separate arguments. However, the \CFA type-system must support significantly more complex composition: \begin{lstlisting} [ int, int ] foo$\(_1\)$( int ); $\C{// overloaded foo functions}$ [ double ] foo$\(_2\)$( int ); void bar( int, double, double ); bar( foo( 3 ), foo( 3 ) ); \end{lstlisting} The type-resolver only has the tuple return-types to resolve the call to @bar@ as the @foo@ parameters are identical, which involves unifying the possible @foo@ functions with @bar@'s parameter list. No combination of @foo@s are an exact match with @bar@'s parameters, so the resolver applies C conversions. The minimal cost is @bar( foo@$_1$@( 3 ), foo@$_2$@( 3 ) )@, giving (@int@, {\color{ForestGreen}@int@}, @double@) to (@int@, {\color{ForestGreen}@double@}, @double@) with one {\color{ForestGreen}safe} (widening) conversion from @int@ to @double@ versus ({\color{red}@double@}, {\color{ForestGreen}@int@}, {\color{ForestGreen}@int@}) to ({\color{red}@int@}, {\color{ForestGreen}@double@}, {\color{ForestGreen}@double@}) with one {\color{red}unsafe} (narrowing) conversion from @double@ to @int@ and two safe conversions. \subsection{Tuple Variables} An important observation from function composition is that new variable names are not required to initialize parameters from an MRVF. \CFA also allows declaration of tuple variables that can be initialized from an MRVF, since it can be awkward to declare multiple variables of different types, \eg: \begin{lstlisting} [ int, int ] qr = div( 13, 5 ); $\C{// tuple-variable declaration and initialization}$ [ double, double ] qr = div( 13.5, 5.2 ); \end{lstlisting} where the tuple variable-name serves the same purpose as the parameter name(s). Tuple variables can be composed of any types, except for array types, since array sizes are generally unknown in C. One way to access the tuple-variable components is with assignment or composition: \begin{lstlisting} [ q, r ] = qr; $\C{// access tuple-variable components}$ printf( "%d %d\n", qr ); \end{lstlisting} \CFA also supports \newterm{tuple indexing} to access single components of a tuple expression: \begin{lstlisting} [int, int] * p = &qr; $\C{// tuple pointer}$ int rem = qr`.1`; $\C{// access remainder}$ int quo = div( 13, 5 )`.0`; $\C{// access quotient}$ p`->0` = 5; $\C{// change quotient}$ bar( qr`.1`, qr ); $\C{// pass remainder and quotient/remainder}$ rem = [div( 13, 5 ), 42]`.0.1`; $\C{// access 2nd component of 1st component of tuple expression}$ \end{lstlisting} \subsection{Flattening and Restructuring} In function call contexts, tuples support implicit flattening and restructuring conversions. Tuple flattening recursively expands a tuple into the list of its basic components. Tuple structuring packages a list of expressions into a value of tuple type, \eg: %\lstDeleteShortInline@% %\par\smallskip %\begin{tabular}{@{}l@{\hspace{1.5\parindent}}||@{\hspace{1.5\parindent}}l@{}} \begin{lstlisting} int f( int, int ); int g( [int, int] ); int h( int, [int, int] ); [int, int] x; int y; f( x ); $\C{// flatten}$ g( y, 10 ); $\C{// structure}$ h( x, y ); $\C{// flatten and structure}$ \end{lstlisting} %\end{lstlisting} %& %\begin{lstlisting} %\end{tabular} %\smallskip\par\noindent %\lstMakeShortInline@% In the call to @f@, @x@ is implicitly flattened so the components of @x@ are passed as the two arguments. In the call to @g@, the values @y@ and @10@ are structured into a single argument of type @[int, int]@ to match the parameter type of @g@. Finally, in the call to @h@, @x@ is flattened to yield an argument list of length 3, of which the first component of @x@ is passed as the first parameter of @h@, and the second component of @x@ and @y@ are structured into the second argument of type @[int, int]@. The flexible structure of tuples permits a simple and expressive function call syntax to work seamlessly with both SRVF and MRVF, and with any number of arguments of arbitrarily complex structure. \subsection{Tuple Assignment} An assignment where the left side is a tuple type is called \newterm{tuple assignment}. There are two kinds of tuple assignment depending on whether the right side of the assignment operator has a tuple type or a non-tuple type, called \newterm{multiple} and \newterm{mass assignment}, respectively. %\lstDeleteShortInline@% %\par\smallskip %\begin{tabular}{@{}l@{\hspace{1.5\parindent}}||@{\hspace{1.5\parindent}}l@{}} \begin{lstlisting} int x = 10; double y = 3.5; [int, double] z; z = [x, y]; $\C{// multiple assignment}$ [x, y] = z; $\C{// multiple assignment}$ z = 10; $\C{// mass assignment}$ [y, x] = 3.14; $\C{// mass assignment}$ \end{lstlisting} %\end{lstlisting} %& %\begin{lstlisting} %\end{tabular} %\smallskip\par\noindent %\lstMakeShortInline@% Both kinds of tuple assignment have parallel semantics, so that each value on the left and right side is evaluated before any assignments occur. As a result, it is possible to swap the values in two variables without explicitly creating any temporary variables or calling a function, \eg, @[x, y] = [y, x]@. This semantics means mass assignment differs from C cascading assignment (\eg @a = b = c@) in that conversions are applied in each individual assignment, which prevents data loss from the chain of conversions that can happen during a cascading assignment. For example, @[y, x] = 3.14@ performs the assignments @y = 3.14@ and @x = 3.14@, yielding @y == 3.14@ and @x == 3@; whereas, C cascading assignment @y = x = 3.14@ performs the assignments @x = 3.14@ and @y = x@, yielding @3@ in @y@ and @x@. Finally, tuple assignment is an expression where the result type is the type of the left-hand side of the assignment, just like all other assignment expressions in C. This example shows mass, multiple, and cascading assignment used in one expression: \begin{lstlisting} void f( [int, int] ); f( [x, y] = z = 1.5 ); $\C{// assignments in parameter list}$ \end{lstlisting} \subsection{Member Access} It is also possible to access multiple fields from a single expression using a \newterm{member-access}. The result is a single tuple-valued expression whose type is the tuple of the types of the members, \eg: \begin{lstlisting} struct S { int x; double y; char * z; } s; s.[x, y, z] = 0; \end{lstlisting} Here, the mass assignment sets all members of @s@ to zero. Since tuple-index expressions are a form of member-access expression, it is possible to use tuple-index expressions in conjunction with member tuple expressions to manually restructure a tuple (\eg rearrange, drop, and duplicate components). %\lstDeleteShortInline@% %\par\smallskip %\begin{tabular}{@{}l@{\hspace{1.5\parindent}}||@{\hspace{1.5\parindent}}l@{}} \begin{lstlisting} [int, int, long, double] x; void f( double, long ); x.[0, 1] = x.[1, 0]; $\C{// rearrange: [x.0, x.1] = [x.1, x.0]}$ f( x.[0, 3] ); $\C{// drop: f(x.0, x.3)}$ [int, int, int] y = x.[2, 0, 2]; $\C{// duplicate: [y.0, y.1, y.2] = [x.2, x.0.x.2]}$ \end{lstlisting} %\end{lstlisting} %& %\begin{lstlisting} %\end{tabular} %\smallskip\par\noindent %\lstMakeShortInline@% It is also possible for a member access to contain other member accesses, \eg: \begin{lstlisting} struct A { double i; int j; }; struct B { int * k; short l; }; struct C { int x; A y; B z; } v; v.[x, y.[i, j], z.k]; $\C{// [v.x, [v.y.i, v.y.j], v.z.k]}$ \end{lstlisting} \begin{comment} \subsection{Casting} In C, the cast operator is used to explicitly convert between types. In \CFA, the cast operator has a secondary use as type ascription. That is, a cast can be used to select the type of an expression when it is ambiguous, as in the call to an overloaded function: \begin{lstlisting} int f(); // (1) double f(); // (2) f(); // ambiguous - (1),(2) both equally viable (int)f(); // choose (2) \end{lstlisting} Since casting is a fundamental operation in \CFA, casts should be given a meaningful interpretation in the context of tuples. Taking a look at standard C provides some guidance with respect to the way casts should work with tuples: \begin{lstlisting} int f(); void g(); (void)f(); // (1) (int)g(); // (2) \end{lstlisting} In C, (1) is a valid cast, which calls @f@ and discards its result. On the other hand, (2) is invalid, because @g@ does not produce a result, so requesting an @int@ to materialize from nothing is nonsensical. Generalizing these principles, any cast wherein the number of components increases as a result of the cast is invalid, while casts that have the same or fewer number of components may be valid. Formally, a cast to tuple type is valid when $T_n \leq S_m$, where $T_n$ is the number of components in the target type and $S_m$ is the number of components in the source type, and for each $i$ in $[0, n)$, $S_i$ can be cast to $T_i$. Excess elements ($S_j$ for all $j$ in $[n, m)$) are evaluated, but their values are discarded so that they are not included in the result expression. This approach follows naturally from the way that a cast to @void@ works in C. For example, in \begin{lstlisting} [int, int, int] f(); [int, [int, int], int] g(); ([int, double])f(); $\C{// (1)}$ ([int, int, int])g(); $\C{// (2)}$ ([void, [int, int]])g(); $\C{// (3)}$ ([int, int, int, int])g(); $\C{// (4)}$ ([int, [int, int, int]])g(); $\C{// (5)}$ \end{lstlisting} (1) discards the last element of the return value and converts the second element to @double@. Since @int@ is effectively a 1-element tuple, (2) discards the second component of the second element of the return value of @g@. If @g@ is free of side effects, this expression is equivalent to @[(int)(g().0), (int)(g().1.0), (int)(g().2)]@. Since @void@ is effectively a 0-element tuple, (3) discards the first and third return values, which is effectively equivalent to @[(int)(g().1.0), (int)(g().1.1)]@). Note that a cast is not a function call in \CFA, so flattening and structuring conversions do not occur for cast expressions\footnote{User-defined conversions have been considered, but for compatibility with C and the existing use of casts as type ascription, any future design for such conversions would require more precise matching of types than allowed for function arguments and parameters.}. As such, (4) is invalid because the cast target type contains 4 components, while the source type contains only 3. Similarly, (5) is invalid because the cast @([int, int, int])(g().1)@ is invalid. That is, it is invalid to cast @[int, int]@ to @[int, int, int]@. \end{comment} \subsection{Polymorphism} Tuples also integrate with \CFA polymorphism as a kind of generic type. Due to the implicit flattening and structuring conversions involved in argument passing, @otype@ and @dtype@ parameters are restricted to matching only with non-tuple types, \eg: \begin{lstlisting} forall(otype T, dtype U) void f( T x, U * y ); f( [5, "hello"] ); \end{lstlisting} where @[5, "hello"]@ is flattened, giving argument list @5, "hello"@, and @T@ binds to @int@ and @U@ binds to @const char@. Tuples, however, may contain polymorphic components. For example, a plus operator can be written to add two triples together. \begin{lstlisting} forall(otype T | { T ?+?( T, T ); }) [T, T, T] ?+?( [T, T, T] x, [T, T, T] y ) { return [x.0 + y.0, x.1 + y.1, x.2 + y.2]; } [int, int, int] x; int i1, i2, i3; [i1, i2, i3] = x + ([10, 20, 30]); \end{lstlisting} Flattening and restructuring conversions are also applied to tuple types in polymorphic type assertions. \begin{lstlisting} int f( [int, double], double ); forall(otype T, otype U | { T f( T, U, U ); }) void g( T, U ); g( 5, 10.21 ); \end{lstlisting} Hence, function parameter and return lists are flattened for the purposes of type unification allowing the example to pass expression resolution. This relaxation is possible by extending the thunk scheme described by Bilson~\cite{Bilson03}. Whenever a candidate's parameter structure does not exactly match the formal parameter's structure, a thunk is generated to specialize calls to the actual function: \begin{lstlisting} int _thunk( int _p0, double _p1, double _p2 ) { return f( [_p0, _p1], _p2 ); } \end{lstlisting} so the thunk provides flattening and structuring conversions to inferred functions, improving the compatibility of tuples and polymorphism. These thunks take advantage of GCC C nested-functions to produce closures that have the usual function-pointer signature. \subsection{Variadic Tuples} \label{sec:variadic-tuples} To define variadic functions, \CFA adds a new kind of type parameter, @ttype@ (tuple type). Matching against a @ttype@ parameter consumes all remaining argument components and packages them into a tuple, binding to the resulting tuple of types. In a given parameter list, there must be at most one @ttype@ parameter that occurs last, which matches normal variadic semantics, with a strong feeling of similarity to \CCeleven variadic templates. As such, @ttype@ variables are also called \newterm{argument packs}. Like variadic templates, the main way to manipulate @ttype@ polymorphic functions is via recursion. Since nothing is known about a parameter pack by default, assertion parameters are key to doing anything meaningful. Unlike variadic templates, @ttype@ polymorphic functions can be separately compiled. For example, a generalized @sum@ function written using @ttype@: \begin{lstlisting} int sum$\(_0\)$() { return 0; } forall(ttype Params | { int sum( Params ); } ) int sum$\(_1\)$( int x, Params rest ) { return x + sum( rest ); } sum( 10, 20, 30 ); \end{lstlisting} Since @sum@\(_0\) does not accept any arguments, it is not a valid candidate function for the call @sum(10, 20, 30)@. In order to call @sum@\(_1\), @10@ is matched with @x@, and the argument resolution moves on to the argument pack @rest@, which consumes the remainder of the argument list and @Params@ is bound to @[20, 30]@. The process continues unitl @Params@ is bound to @[]@, requiring an assertion @int sum()@, which matches @sum@\(_0\) and terminates the recursion. Effectively, this algorithm traces as @sum(10, 20, 30)@ $\rightarrow$ @10 + sum(20, 30)@ $\rightarrow$ @10 + (20 + sum(30))@ $\rightarrow$ @10 + (20 + (30 + sum()))@ $\rightarrow$ @10 + (20 + (30 + 0))@. It is reasonable to take the @sum@ function a step further to enforce a minimum number of arguments: \begin{lstlisting} int sum( int x, int y ) { return x + y; } forall(ttype Params | { int sum( int, Params ); } ) int sum( int x, int y, Params rest ) { return sum( x + y, rest ); } \end{lstlisting} One more step permits the summation of any summable type with all arguments of the same type: \begin{lstlisting} trait summable(otype T) { T ?+?( T, T ); }; forall(otype R | summable( R ) ) R sum( R x, R y ) { return x + y; } forall(otype R, ttype Params | summable(R) | { R sum(R, Params); } ) R sum(R x, R y, Params rest) { return sum( x + y, rest ); } \end{lstlisting} Unlike C variadic functions, it is unnecessary to hard code the number and expected types. Furthermore, this code is extendable for any user-defined type with a @?+?@ operator. Summing arbitrary heterogeneous lists is possible with similar code by adding the appropriate type variables and addition operators. It is also possible to write a type-safe variadic print function to replace @printf@: \begin{lstlisting} struct S { int x, y; }; forall(otype T, ttype Params | { void print(T); void print(Params); }) void print(T arg, Params rest) { print(arg); print(rest); } void print( char * x ) { printf( "%s", x ); } void print( int x ) { printf( "%d", x ); } void print( S s ) { print( "{ ", s.x, ",", s.y, " }" ); } print( "s = ", (S){ 1, 2 }, "\n" ); \end{lstlisting} This example showcases a variadic-template-like decomposition of the provided argument list. The individual @print@ functions allow printing a single element of a type. The polymorphic @print@ allows printing any list of types, where as each individual type has a @print@ function. The individual print functions can be used to build up more complicated @print@ functions, such as @S@, which cannot be done with @printf@ in C. Finally, it is possible to use @ttype@ polymorphism to provide arbitrary argument forwarding functions. For example, it is possible to write @new@ as a library function: \begin{lstlisting} forall( otype R, otype S ) void ?{}( pair(R, S) *, R, S ); forall( dtype T, ttype Params | sized(T) | { void ?{}( T *, Params ); } ) T * new( Params p ) { return ((T *)malloc()){ p }; $\C{// construct into result of malloc}$ } pair( int, char ) * x = new( 42, '!' ); \end{lstlisting} The @new@ function provides the combination of type-safe @malloc@ with a \CFA constructor call, making it impossible to forget constructing dynamically allocated objects. This function provides the type-safety of @new@ in \CC, without the need to specify the allocated type again, thanks to return-type inference. \subsection{Implementation} Tuples are implemented in the \CFA translator via a transformation into \newterm{generic types}. For each $N$, the first time an $N$-tuple is seen in a scope a generic type with $N$ type parameters is generated, \eg: \begin{lstlisting} [int, int] f() { [double, double] x; [int, double, int] y; } \end{lstlisting} is transformed into: \begin{lstlisting} forall(dtype T0, dtype T1 | sized(T0) | sized(T1)) struct _tuple2 { T0 field_0; $\C{// generated before the first 2-tuple}$ T1 field_1; }; _tuple2(int, int) f() { _tuple2(double, double) x; forall(dtype T0, dtype T1, dtype T2 | sized(T0) | sized(T1) | sized(T2)) struct _tuple3 { T0 field_0; $\C{// generated before the first 3-tuple}$ T1 field_1; T2 field_2; }; _tuple3(int, double, int) y; } \end{lstlisting} \begin{sloppypar} Tuple expressions are then simply converted directly into compound literals, \eg @[5, 'x', 1.24]@ becomes @(_tuple3(int, char, double)){ 5, 'x', 1.24 }@. \end{sloppypar} \begin{comment} Since tuples are essentially structures, tuple indexing expressions are just field accesses: \begin{lstlisting} void f(int, [double, char]); [int, double] x; x.0+x.1; printf("%d %g\n", x); f(x, 'z'); \end{lstlisting} Is transformed into: \begin{lstlisting} void f(int, _tuple2(double, char)); _tuple2(int, double) x; x.field_0+x.field_1; printf("%d %g\n", x.field_0, x.field_1); f(x.field_0, (_tuple2){ x.field_1, 'z' }); \end{lstlisting} Note that due to flattening, @x@ used in the argument position is converted into the list of its fields. In the call to @f@, the second and third argument components are structured into a tuple argument. Similarly, tuple member expressions are recursively expanded into a list of member access expressions. Expressions that may contain side effects are made into \newterm{unique expressions} before being expanded by the flattening conversion. Each unique expression is assigned an identifier and is guaranteed to be executed exactly once: \begin{lstlisting} void g(int, double); [int, double] h(); g(h()); \end{lstlisting} Internally, this expression is converted to two variables and an expression: \begin{lstlisting} void g(int, double); [int, double] h(); _Bool _unq0_finished_ = 0; [int, double] _unq0; g( (_unq0_finished_ ? _unq0 : (_unq0 = f(), _unq0_finished_ = 1, _unq0)).0, (_unq0_finished_ ? _unq0 : (_unq0 = f(), _unq0_finished_ = 1, _unq0)).1, ); \end{lstlisting} Since argument evaluation order is not specified by the C programming language, this scheme is built to work regardless of evaluation order. The first time a unique expression is executed, the actual expression is evaluated and the accompanying boolean is set to true. Every subsequent evaluation of the unique expression then results in an access to the stored result of the actual expression. Tuple member expressions also take advantage of unique expressions in the case of possible impurity. Currently, the \CFA translator has a very broad, imprecise definition of impurity, where any function call is assumed to be impure. This notion could be made more precise for certain intrinsic, auto-generated, and builtin functions, and could analyze function bodies when they are available to recursively detect impurity, to eliminate some unique expressions. The various kinds of tuple assignment, constructors, and destructors generate GNU C statement expressions. A variable is generated to store the value produced by a statement expression, since its fields may need to be constructed with a non-trivial constructor and it may need to be referred to multiple time, \eg in a unique expression. The use of statement expressions allows the translator to arbitrarily generate additional temporary variables as needed, but binds the implementation to a non-standard extension of the C language. However, there are other places where the \CFA translator makes use of GNU C extensions, such as its use of nested functions, so this restriction is not new. \end{comment} \section{Control Structures} \CFA identifies missing and problematic control structures in C, and extends and modifies these control structures to increase functionality and safety. \subsection{\texorpdfstring{Labelled \LstKeywordStyle{continue} / \LstKeywordStyle{break}}{Labelled continue / break}} While C provides @continue@ and @break@ statements for altering control flow, both are restricted to one level of nesting for a particular control structure. Unfortunately, this restriction forces programmers to use @goto@ to achieve the equivalent control-flow for more than one level of nesting. To prevent having to switch to the @goto@, \CFA extends the @continue@ and @break@ with a target label to support static multi-level exit~\cite{Buhr85}, as in Java. For both @continue@ and @break@, the target label must be directly associated with a @for@, @while@ or @do@ statement; for @break@, the target label can also be associated with a @switch@, @if@ or compound (@{}@) statement. Figure~\ref{f:MultiLevelExit} shows @continue@ and @break@ indicating the specific control structure, and the corresponding C program using only @goto@ and labels. The innermost loop has 7 exit points, which cause continuation or termination of one or more of the 7 nested control-structures. \begin{figure} \lstDeleteShortInline@% \begin{tabular}{@{\hspace{\parindentlnth}}l@{\hspace{\parindentlnth}}l@{\hspace{\parindentlnth}}l@{}} \multicolumn{1}{@{\hspace{\parindentlnth}}c@{\hspace{\parindentlnth}}}{\textbf{\CFA}} & \multicolumn{1}{@{\hspace{\parindentlnth}}c}{\textbf{C}} \\ \begin{cfa} `LC:` { ... $declarations$ ... `LS:` switch ( ... ) { case 3: `LIF:` if ( ... ) { `LF:` for ( ... ) { `LW:` while ( ... ) { ... break `LC`; ... ... break `LS`; ... ... break `LIF`; ... ... continue `LF;` ... ... break `LF`; ... ... continue `LW`; ... ... break `LW`; ... } // while } // for } else { ... break `LIF`; ... } // if } // switch } // compound \end{cfa} & \begin{cfa} { ... $declarations$ ... switch ( ... ) { case 3: if ( ... ) { for ( ... ) { while ( ... ) { ... goto `LC`; ... ... goto `LS`; ... ... goto `LIF`; ... ... goto `LFC`; ... ... goto `LFB`; ... ... goto `LWC`; ... ... goto `LWB`; ... `LWC`: ; } `LWB:` ; `LFC:` ; } `LFB:` ; } else { ... goto `LIF`; ... } `L3:` ; } `LS:` ; } `LC:` ; \end{cfa} & \begin{cfa} // terminate compound // terminate switch // terminate if // continue loop // terminate loop // continue loop // terminate loop // terminate if \end{cfa} \end{tabular} \lstMakeShortInline@% \caption{Multi-level Exit} \label{f:MultiLevelExit} \end{figure} Both labelled @continue@ and @break@ are a @goto@ restricted in the following ways: \begin{itemize} \item They cannot create a loop, which means only the looping constructs cause looping. This restriction means all situations resulting in repeated execution are clearly delineated. \item They cannot branch into a control structure. This restriction prevents missing declarations and/or initializations at the start of a control structure resulting in undefined behaviour. \end{itemize} The advantage of the labelled @continue@/@break@ is allowing static multi-level exits without having to use the @goto@ statement, and tying control flow to the target control structure rather than an arbitrary point in a program. Furthermore, the location of the label at the \emph{beginning} of the target control structure informs the reader (eye candy) that complex control-flow is occurring in the body of the control structure. With @goto@, the label is at the end of the control structure, which fails to convey this important clue early enough to the reader. Finally, using an explicit target for the transfer instead of an implicit target allows new constructs to be added or removed without affecting existing constructs. The implicit targets of the current @continue@ and @break@, \ie the closest enclosing loop or @switch@, change as certain constructs are added or removed. \subsection{\texorpdfstring{Enhanced \LstKeywordStyle{switch} Statement}{Enhanced switch Statement}} There are a number of deficiencies with the C @switch@ statements: enumerating @case@ lists, placement of @case@ clauses, scope of the switch body, and fall through between case clauses. C has no shorthand for specifying a list of case values, whether the list is non-contiguous or contiguous\footnote{C provides this mechanism via fall through.}. \CFA provides a shorthand for a non-contiguous list: \begin{cquote} \lstDeleteShortInline@% \begin{tabular}{@{}l@{\hspace{\parindentlnth}}l@{}} \multicolumn{1}{c@{\hspace{\parindentlnth}}}{\textbf{\CFA}} & \multicolumn{1}{c}{\textbf{C}} \\ \begin{cfa} case 2, 10, 34, 42: \end{cfa} & \begin{cfa} case 2: case 10: case 34: case 42: \end{cfa} \end{tabular} \lstMakeShortInline@% \end{cquote} for a contiguous list:\footnote{gcc provides the same mechanism with awkward syntax, \lstinline@2 ... 42@, where spaces are required around the ellipse.} \begin{cquote} \lstDeleteShortInline@% \begin{tabular}{@{}l@{\hspace{\parindentlnth}}l@{}} \multicolumn{1}{c@{\hspace{\parindentlnth}}}{\textbf{\CFA}} & \multicolumn{1}{c}{\textbf{C}} \\ \begin{cfa} case 2~42: \end{cfa} & \begin{cfa} case 2: case 3: ... case 41: case 42: \end{cfa} \end{tabular} \lstMakeShortInline@% \end{cquote} and a combination: \begin{cfa} case -12~-4, -1~5, 14~21, 34~42: \end{cfa} C allows placement of @case@ clauses \emph{within} statements nested in the @switch@ body (see Duff's device~\cite{Duff83}); \begin{cfa} switch ( i ) { case 0: for ( int i = 0; i < 10; i += 1 ) { ... `case 1:` // no initialization of loop index ... } } \end{cfa} \CFA precludes this form of transfer into a control structure because it causes undefined behaviour, especially with respect to missed initialization, and provides very limited functionality. C allows placement of declaration within the @switch@ body and unreachable code at the start, resulting in undefined behaviour: \begin{cfa} switch ( x ) { `int y = 1;` $\C{// unreachable initialization}$ `x = 7;` $\C{// unreachable code without label/branch}$ case 0: ... `int z = 0;` $\C{// unreachable initialization, cannot appear after case}$ z = 2; case 1: `x = z;` $\C{// without fall through, z is undefined}$ } \end{cfa} \CFA allows the declaration of local variables, \eg @y@, at the start of the @switch@ with scope across the entire @switch@ body, \ie all @case@ clauses, but no statements. \CFA disallows the declaration of local variable, \eg @z@, directly within the @switch@ body, because a declaration cannot occur immediately after a @case@ since a label can only be attached to a statement, and the use of @z@ is undefined in @case 1@ as neither storage allocation nor initialization may have occurred. C @switch@ provides multiple entry points into the statement body, but once an entry point is selected, control continues across \emph{all} @case@ clauses until the end of the @switch@ body, called \newterm{fall through}; @case@ clauses are made disjoint by the @break@ statement. While the ability to fall through \emph{is} a useful form of control flow, it does not match well with programmer intuition, resulting in many errors from missing @break@ statements. \CFA provides a new control structure, @choose@, which mimics @switch@, but reverses the meaning of fall through: \begin{cquote} \lstDeleteShortInline@% \begin{tabular}{@{}l@{\hspace{\parindentlnth}}l@{}} \multicolumn{1}{c@{\hspace{\parindentlnth}}}{\textbf{\CFA}} & \multicolumn{1}{c}{\textbf{C}} \\ \begin{cfa} `choose` ( day ) { case Mon~Thu: // program case Fri: // program wallet += pay; `fallthrough;` case Sat: // party wallet -= party; case Sun: // rest default: // error } \end{cfa} & \begin{cfa} switch ( day ) { case Mon: case Tue: case Wed: case Thu: // program `break;` case Fri: // program wallet += pay; case Sat: // party wallet -= party; `break;` case Sun: // rest `break;` default: // error } \end{cfa} \end{tabular} \lstMakeShortInline@% \end{cquote} Collectively, these enhancements reduce programmer burden and increase readability and safety. \begin{comment} Forgotten @break@ statements at the end of @switch@ cases are a persistent sort of programmer error in C, and the @break@ statements themselves introduce visual clutter and an un-C-like keyword-based block delimiter. \CFA addresses this error by introducing a @choose@ statement, which works identically to a @switch@ except that its default end-of-case behaviour is to break rather than to fall through for all non-empty cases. Since empty cases like @case 7:@ in @case 7: case 11:@ still have fall-through semantics and explicit @break@ is still allowed at the end of a @choose@ case, many idiomatic uses of @switch@ in standard C can be converted to @choose@ statements by simply changing the keyword. Where fall-through is desired for a non-empty case, it can be specified with the new @fallthrough@ statement, making @choose@ equivalently powerful to @switch@, but more concise in the common case where most non-empty cases end with a @break@ statement, as in the example below: \begin{cfa} choose( i ) { case 2: printf("even "); fallthrough; case 3: case 5: case 7: printf("small prime\n"); case 4,6,8,9: printf("small composite\n"); case 13~19: printf("teen\n"); default: printf("something else\n"); } \end{cfa} \end{comment} \subsection{\texorpdfstring{\LstKeywordStyle{with} Clause / Statement}{with Clause / Statement}} \label{s:WithClauseStatement} Grouping heterogenous data into \newterm{aggregate}s (structure/union) is a common programming practice, and an aggregate can be further organized into more complex structures, such as arrays and containers: \begin{cfa} struct S { $\C{// aggregate}$ char c; $\C{// fields}$ int i; double d; }; S s, as[10]; \end{cfa} However, routines manipulating aggregates must repeat the aggregate name to access its containing fields: \begin{cfa} void f( S s ) { `s.`c; `s.`i; `s.`d; $\C{// access containing fields}$ } \end{cfa} A similar situation occurs in object-oriented programming, \eg \CC: \begin{C++} class C { char c; $\C{// fields}$ int i; double d; int mem() { $\C{// implicit "this" parameter}$ `this->`c; `this->`i; `this->`d; $\C{// access containing fields}$ } } \end{C++} Nesting of member routines in a \lstinline[language=C++]@class@ allows eliding \lstinline[language=C++]@this->@ because of lexical scoping. However, for other aggregate parameters, qualification is necessary: \begin{cfa} struct T { double m, n; }; int C::mem( T & t ) { $\C{// multiple aggregate parameters}$ c; i; d; $\C{\color{red}// this-\textgreater.c, this-\textgreater.i, this-\textgreater.d}$ `t.`m; `t.`n; $\C{// must qualify}$ } \end{cfa} % In object-oriented programming, there is an implicit first parameter, often names @self@ or @this@, which is elided. % In any programming language, some functions have a naturally close relationship with a particular data type. % Object-oriented programming allows this close relationship to be codified in the language by making such functions \newterm{class methods} of their related data type. % Class methods have certain privileges with respect to their associated data type, notably un-prefixed access to the fields of that data type. % When writing C functions in an object-oriented style, this un-prefixed access is swiftly missed, as access to fields of a @Foo* f@ requires an extra three characters @f->@ every time, which disrupts coding flow and clutters the produced code. % % \TODO{Fill out section. Be sure to mention arbitrary expressions in with-blocks, recent change driven by Thierry to prioritize field name over parameters.} To simplify the programmer experience, \CFA provides a @with@ clause/statement (see Pascal~\cite[\S~4.F]{Pascal}) to elide aggregate qualification to fields by opening a scope containing the field identifiers. Hence, the qualified fields become variables with the side-effect that it is easier to optimizing field references in a block. \begin{cfa} void f( S s ) `with( s )` { $\C{// with clause}$ c; i; d; $\C{\color{red}// s.c, s.i, s.d}$ } \end{cfa} and the equivalence for object-style programming is: \begin{cfa} int mem( S & this ) `with( this )` { $\C{// with clause}$ c; i; d; $\C{\color{red}// this.c, this.i, this.d}$ } \end{cfa} with the generality of opening multiple aggregate-parameters: \begin{cfa} int mem( S & s, T & t ) `with( s, t )` { $\C{// multiple aggregate parameters}$ c; i; d; $\C{\color{red}// s.c, s.i, s.d}$ m; n; $\C{\color{red}// t.m, t.n}$ } \end{cfa} In detail, the @with@ clause/statement has the form: \begin{cfa} $\emph{with-statement}$: 'with' '(' $\emph{expression-list}$ ')' $\emph{compound-statement}$ \end{cfa} and may appear as the body of a routine or nested within a routine body. Each expression in the expression-list provides a type and object. The type must be an aggregate type. (Enumerations are already opened.) The object is the implicit qualifier for the open structure-fields. All expressions in the expression list are open in ``parallel'' within the compound statement. This semantic is different from Pascal, which nests the openings. The difference between parallel and nesting occurs for fields with the same name but different type: \begin{cfa} struct S { int i; int j; double m; } s, w; struct T { int i; int k; int m } t, w; with( s, t ) { j + k; $\C{// unambiguous, s.j + t.m}$ m = 5.0; $\C{// unambiguous, t.m = 5.0}$ m = 1; $\C{// unambiguous, s.m = 1}$ int a = s.i + m; $\C{// unambiguous, a = s.i + t.i}$ int b = s.i + t.i; $\C{// unambiguous, qualification}$ sout | (double)m | endl; $\C{// unambiguous, cast}$ i; $\C{// ambiguous}$ } \end{cfa} \CFA's ability to overload variables means usages of field with the same names can be automatically disambiguated, eliminating most qualification. Qualification or a cast is used to disambiguate. A cast may be necessary to disambiguate between the overload variables in a @with@ expression: \begin{cfa} with( w ) { ... } $\C{// ambiguous, same name and no context}$ with( (S)w ) { ... } $\C{// unambiguous}$ \end{cfa} \begin{cfa} struct S { int i, j; } sv; with( sv ) { S & sr = sv; with( sr ) { S * sp = &sv; with( *sp ) { i = 3; j = 4; $\C{\color{red}// sp-{\textgreater}i, sp-{\textgreater}j}$ } i = 3; j = 4; $\C{\color{red}// sr.i, sr.j}$ } i = 3; j = 4; $\C{\color{red}// sv.i, sv.j}$ } \end{cfa} The statement form is used within a block: \begin{cfa} int foo() { struct S1 { ... } s1; struct S2 { ... } s2; `with( s1 )` { $\C{// with statement}$ // access fields of s1 without qualification `with( s2 )` { $\C{// nesting}$ // access fields of s1 and s2 without qualification } } `with( s1, s2 )` { // access unambiguous fields of s1 and s2 without qualification } } \end{cfa} \subsection{Exception Handling ???} \section{Declarations} It is important to the design team that \CFA subjectively ``feel like'' C to user programmers. An important part of this subjective feel is maintaining C's procedural programming paradigm, as opposed to the object-oriented paradigm of other systems languages such as \CC and Rust. Maintaining this procedural paradigm means that coding patterns that work in C will remain not only functional but idiomatic in \CFA, reducing the mental burden of retraining C programmers and switching between C and \CFA development. Nonetheless, some features of object-oriented languages are undeniably convienient, and the \CFA design team has attempted to adapt them to a procedural paradigm so as to incorporate their benefits into \CFA; two of these features are resource management and name scoping. \subsection{Alternative Declaration Syntax} \newcommand{\R}[1]{\Textbf{#1}} \newcommand{\B}[1]{{\Textbf[blue]{#1}}} \newcommand{\G}[1]{{\Textbf[OliveGreen]{#1}}} C declaration syntax is notoriously confusing and error prone. For example, many C programmers are confused by a declaration as simple as: \begin{cquote} \lstDeleteShortInline@% \begin{tabular}{@{}ll@{}} \begin{cfa} int * x[5] \end{cfa} & \raisebox{-0.75\totalheight}{\input{Cdecl}} \end{tabular} \lstMakeShortInline@% \end{cquote} Is this an array of 5 pointers to integers or a pointer to an array of 5 integers? If there is any doubt, it implies productivity and safety issues even for basic programs. Another example of confusion results from the fact that a routine name and its parameters are embedded within the return type, mimicking the way the return value is used at the routine's call site. For example, a routine returning a pointer to an array of integers is defined and used in the following way: \begin{cfa} int `(*`f`())[`5`]` {...}; $\C{// definition}$ ... `(*`f`())[`3`]` += 1; $\C{// usage}$ \end{cfa} Essentially, the return type is wrapped around the routine name in successive layers (like an onion). While attempting to make the two contexts consistent is a laudable goal, it has not worked out in practice. \CFA provides its own type, variable and routine declarations, using a different syntax. The new declarations place qualifiers to the left of the base type, while C declarations place qualifiers to the right of the base type. In the following example, \R{red} is the base type and \B{blue} is qualifiers. The \CFA declarations move the qualifiers to the left of the base type, \ie move the blue to the left of the red, while the qualifiers have the same meaning but are ordered left to right to specify a variable's type. \begin{cquote} \lstDeleteShortInline@% \lstset{moredelim=**[is][\color{blue}]{+}{+}} \begin{tabular}{@{}l@{\hspace{\parindentlnth}}l@{}} \multicolumn{1}{c@{\hspace{\parindentlnth}}}{\textbf{\CFA}} & \multicolumn{1}{c}{\textbf{C}} \\ \begin{cfa} +[5] *+ `int` x1; +* [5]+ `int` x2; `[* [5] int]` f+( int p )+; \end{cfa} & \begin{cfa} `int` +*+ x1 +[5]+; `int` +(*+x2+)[5]+; `int (*`f+( int p )+`)[5]`; \end{cfa} \end{tabular} \lstMakeShortInline@% \end{cquote} The only exception is bit field specification, which always appear to the right of the base type. % Specifically, the character @*@ is used to indicate a pointer, square brackets @[@\,@]@ are used to represent an array or function return value, and parentheses @()@ are used to indicate a routine parameter. However, unlike C, \CFA type declaration tokens are distributed across all variables in the declaration list. For instance, variables @x@ and @y@ of type pointer to integer are defined in \CFA as follows: \begin{cquote} \lstDeleteShortInline@% \begin{tabular}{@{}l@{\hspace{\parindentlnth}}l@{}} \multicolumn{1}{c@{\hspace{\parindentlnth}}}{\textbf{\CFA}} & \multicolumn{1}{c}{\textbf{C}} \\ \begin{cfa} `*` int x, y; \end{cfa} & \begin{cfa} int `*`x, `*`y; \end{cfa} \end{tabular} \lstMakeShortInline@% \end{cquote} The downside of this semantics is the need to separate regular and pointer declarations: \begin{cquote} \lstDeleteShortInline@% \begin{tabular}{@{}l@{\hspace{\parindentlnth}}l@{}} \multicolumn{1}{c@{\hspace{\parindentlnth}}}{\textbf{\CFA}} & \multicolumn{1}{c}{\textbf{C}} \\ \begin{cfa} `*` int x; int y; \end{cfa} & \begin{cfa} int `*`x, y; \end{cfa} \end{tabular} \lstMakeShortInline@% \end{cquote} which is prescribing a safety benefit. Other examples are: \begin{cquote} \lstDeleteShortInline@% \begin{tabular}{@{}l@{\hspace{\parindentlnth}}l@{\hspace{\parindentlnth}}l@{}} \multicolumn{1}{c@{\hspace{\parindentlnth}}}{\textbf{\CFA}} & \multicolumn{1}{c@{\hspace{\parindentlnth}}}{\textbf{C}} \\ \begin{cfa} [ 5 ] int z; [ 5 ] * char w; * [ 5 ] double v; struct s { int f0:3; * int f1; [ 5 ] * int f2; }; \end{cfa} & \begin{cfa} int z[ 5 ]; char * w[ 5 ]; double (* v)[ 5 ]; struct s { int f0:3; int * f1; int * f2[ 5 ] }; \end{cfa} & \begin{cfa} // array of 5 integers // array of 5 pointers to char // pointer to array of 5 doubles // common bit field syntax \end{cfa} \end{tabular} \lstMakeShortInline@% \end{cquote} All type qualifiers, \eg @const@, @volatile@, etc., are used in the normal way with the new declarations and also appear left to right, \eg: \begin{cquote} \lstDeleteShortInline@% \begin{tabular}{@{}l@{\hspace{\parindentlnth}}l@{\hspace{\parindentlnth}}l@{}} \multicolumn{1}{c@{\hspace{\parindentlnth}}}{\textbf{\CFA}} & \multicolumn{1}{c@{\hspace{\parindentlnth}}}{\textbf{C}} \\ \begin{cfa} const * const int x; const * [ 5 ] const int y; \end{cfa} & \begin{cfa} int const * const x; const int (* const y)[ 5 ] \end{cfa} & \begin{cfa} // const pointer to const integer // const pointer to array of 5 const integers \end{cfa} \end{tabular} \lstMakeShortInline@% \end{cquote} All declaration qualifiers, \eg @extern@, @static@, etc., are used in the normal way with the new declarations but can only appear at the start of a \CFA routine declaration,\footnote{\label{StorageClassSpecifier} The placement of a storage-class specifier other than at the beginning of the declaration specifiers in a declaration is an obsolescent feature.~\cite[\S~6.11.5(1)]{C11}} \eg: \begin{cquote} \lstDeleteShortInline@% \begin{tabular}{@{}l@{\hspace{\parindentlnth}}l@{\hspace{\parindentlnth}}l@{}} \multicolumn{1}{c@{\hspace{\parindentlnth}}}{\textbf{\CFA}} & \multicolumn{1}{c@{\hspace{\parindentlnth}}}{\textbf{C}} \\ \begin{cfa} extern [ 5 ] int x; static * const int y; \end{cfa} & \begin{cfa} int extern x[ 5 ]; const int static * y; \end{cfa} & \begin{cfa} // externally visible array of 5 integers // internally visible pointer to constant int \end{cfa} \end{tabular} \lstMakeShortInline@% \end{cquote} The new declaration syntax can be used in other contexts where types are required, \eg casts and the pseudo-routine @sizeof@: \begin{cquote} \lstDeleteShortInline@% \begin{tabular}{@{}l@{\hspace{\parindentlnth}}l@{}} \multicolumn{1}{c@{\hspace{\parindentlnth}}}{\textbf{\CFA}} & \multicolumn{1}{c}{\textbf{C}} \\ \begin{cfa} y = (* int)x; i = sizeof([ 5 ] * int); \end{cfa} & \begin{cfa} y = (int *)x; i = sizeof(int * [ 5 ]); \end{cfa} \end{tabular} \lstMakeShortInline@% \end{cquote} Finally, new \CFA declarations may appear together with C declarations in the same program block, but cannot be mixed within a specific declaration. Therefore, a programmer has the option of either continuing to use traditional C declarations or take advantage of the new style. Clearly, both styles need to be supported for some time due to existing C-style header-files, particularly for UNIX-like systems. The syntax of the new routine prototype declaration follows directly from the new routine definition syntax; as well, parameter names are optional, \eg: \begin{cfa} [ int x ] f (); $\C{// returning int with no parameters}$ [ * int ] g (int y); $\C{// returning pointer to int with int parameter}$ [ ] h ( int, char ); $\C{// returning no result with int and char parameters}$ [ * int, int ] j ( int ); $\C{// returning pointer to int and int, with int parameter}$ \end{cfa} This syntax allows a prototype declaration to be created by cutting and pasting source text from the routine definition header (or vice versa). Like C, it is possible to declare multiple routine-prototypes in a single declaration, where the return type is distributed across \emph{all} routine names in the declaration list, \eg: \begin{cquote} \lstDeleteShortInline@% \begin{tabular}{@{}l@{\hspace{\parindentlnth}}l@{}} \multicolumn{1}{c@{\hspace{\parindentlnth}}}{\textbf{\CFA}} & \multicolumn{1}{c}{\textbf{C}} \\ \begin{cfa} [double] foo(), foo( int ), foo( double ) {...} \end{cfa} & \begin{cfa} double foo1(), foo2( int ), foo3( double ); \end{cfa} \end{tabular} \lstMakeShortInline@% \end{cquote} \CFA allows the last routine in the list to define its body. Declaration qualifiers can only appear at the start of a \CFA routine declaration,\footref{StorageClassSpecifier} \eg: \begin{cfa} extern [ int ] f ( int ); static [ int ] g ( int ); \end{cfa} The syntax for pointers to \CFA routines specifies the pointer name on the right, \eg: \begin{cfa} * [ int x ] () fp; $\C{// pointer to routine returning int with no parameters}$ * [ * int ] (int y) gp; $\C{// pointer to routine returning pointer to int with int parameter}$ * [ ] (int,char) hp; $\C{// pointer to routine returning no result with int and char parameters}$ * [ * int,int ] ( int ) jp; $\C{// pointer to routine returning pointer to int and int, with int parameter}$ \end{cfa} While parameter names are optional, \emph{a routine name cannot be specified}; for example, the following is incorrect: \begin{cfa} * [ int x ] f () fp; $\C{// routine name "f" is not allowed}$ \end{cfa} \subsection{References} All variables in C have an \newterm{address}, a \newterm{value}, and a \newterm{type}; at the position in the program's memory denoted by the address, there exists a sequence of bits (the value), with the length and semantic meaning of this bit sequence defined by the type. The C type-system does not always track the relationship between a value and its address; a value that does not have a corresponding address is called a \newterm{rvalue} (for ``right-hand value''), while a value that does have an address is called a \newterm{lvalue} (for ``left-hand value''). For example, in @int x; x = 42;@ the variable expression @x@ on the left-hand-side of the assignment is a lvalue, while the constant expression @42@ on the right-hand-side of the assignment is a rvalue. Despite the nomenclature of ``left-hand'' and ``right-hand'', an expression's classification as lvalue or rvalue is entirely dependent on whether it has an address or not; in imperative programming, the address of a value is used for both reading and writing (mutating) a value, and as such lvalues can be converted to rvalues and read from, but rvalues cannot be mutated because they lack a location to store the updated value. Within a lexical scope, lvalue expressions have an \newterm{address interpretation} for writing a value or a \newterm{value interpretation} to read a value. For example, in @x = y@, @x@ has an address interpretation, while @y@ has a value interpretation. Though this duality of interpretation is useful, C lacks a direct mechanism to pass lvalues between contexts, instead relying on \newterm{pointer types} to serve a similar purpose. In C, for any type @T@ there is a pointer type @T *@, the value of which is the address of a value of type @T@. A pointer rvalue can be explicitly \newterm{dereferenced} to the pointed-to lvalue with the dereference operator @*?@, while the rvalue representing the address of a lvalue can be obtained with the address-of operator @&?@. \begin{cfa} int x = 1, y = 2, * p1, * p2, ** p3; p1 = &x; $\C{// p1 points to x}$ p2 = &y; $\C{// p2 points to y}$ p3 = &p1; $\C{// p3 points to p1}$ *p2 = ((*p1 + *p2) * (**p3 - *p1)) / (**p3 - 15); \end{cfa} Unfortunately, the dereference and address-of operators introduce a great deal of syntactic noise when dealing with pointed-to values rather than pointers, as well as the potential for subtle bugs. For both brevity and clarity, it would be desirable to have the compiler figure out how to elide the dereference operators in a complex expression such as the assignment to @*p2@ above. However, since C defines a number of forms of \newterm{pointer arithmetic}, two similar expressions involving pointers to arithmetic types (\eg @*p1 + x@ and @p1 + x@) may each have well-defined but distinct semantics, introducing the possibility that a user programmer may write one when they mean the other, and precluding any simple algorithm for elision of dereference operators. To solve these problems, \CFA introduces reference types @T&@; a @T&@ has exactly the same value as a @T*@, but where the @T*@ takes the address interpretation by default, a @T&@ takes the value interpretation by default, as below: \begin{cfa} int x = 1, y = 2, & r1, & r2, && r3; &r1 = &x; $\C{// r1 points to x}$ &r2 = &y; $\C{// r2 points to y}$ &&r3 = &&r1; $\C{// r3 points to r2}$ r2 = ((r1 + r2) * (r3 - r1)) / (r3 - 15); $\C{// implicit dereferencing}$ \end{cfa} Except for auto-dereferencing by the compiler, this reference example is exactly the same as the previous pointer example. Hence, a reference behaves like a variable name -- an lvalue expression which is interpreted as a value, but also has the type system track the address of that value. One way to conceptualize a reference is via a rewrite rule, where the compiler inserts a dereference operator before the reference variable for each reference qualifier in the reference variable declaration, so the previous example implicitly acts like: \begin{cfa} `*`r2 = ((`*`r1 + `*`r2) * (`**`r3 - `*`r1)) / (`**`r3 - 15); \end{cfa} References in \CFA are similar to those in \CC, but with a couple important improvements, both of which can be seen in the example above. Firstly, \CFA does not forbid references to references, unlike \CC. This provides a much more orthogonal design for library implementors, obviating the need for workarounds such as @std::reference_wrapper@. Secondly, unlike the references in \CC which always point to a fixed address, \CFA references are rebindable. This allows \CFA references to be default-initialized (\eg to a null pointer), and also to point to different addresses throughout their lifetime. This rebinding is accomplished without adding any new syntax to \CFA, but simply by extending the existing semantics of the address-of operator in C. In C, the address of a lvalue is always a rvalue, as in general that address is not stored anywhere in memory, and does not itself have an address. In \CFA, the address of a @T&@ is a lvalue @T*@, as the address of the underlying @T@ is stored in the reference, and can thus be mutated there. The result of this rule is that any reference can be rebound using the existing pointer assignment semantics by assigning a compatible pointer into the address of the reference, \eg @&r1 = &x;@ above. This rebinding can occur to an arbitrary depth of reference nesting; loosely speaking, nested address-of operators will produce an lvalue nested pointer up to as deep as the reference they're applied to. These explicit address-of operators can be thought of as ``cancelling out'' the implicit dereference operators, \eg @(&`*`)r1 = &x@ or @(&(&`*`)`*`)r3 = &(&`*`)r1@ or even @(&`*`)r2 = (&`*`)`*`r3@ for @&r2 = &r3@. More precisely: \begin{itemize} \item if @R@ is an rvalue of type {@T &@$_1 \cdots$@ &@$_r$} where $r \ge 1$ references (@&@ symbols) than @&R@ has type {@T `*`&@$_{\color{red}2} \cdots$@ &@$_{\color{red}r}$}, \\ \ie @T@ pointer with $r-1$ references (@&@ symbols). \item if @L@ is an lvalue of type {@T &@$_1 \cdots$@ &@$_l$} where $l \ge 0$ references (@&@ symbols) then @&L@ has type {@T `*`&@$_{\color{red}1} \cdots$@ &@$_{\color{red}l}$}, \\ \ie @T@ pointer with $l$ references (@&@ symbols). \end{itemize} Since pointers and references share the same internal representation, code using either is equally performant; in fact the \CFA compiler converts references to pointers internally, and the choice between them in user code can be made based solely on convenience. By analogy to pointers, \CFA references also allow cv-qualifiers such as @const@: \begin{cfa} const int cx = 5; $\C{// cannot change cx}$ const int & cr = cx; $\C{// cannot change cr's referred value}$ &cr = &cx; $\C{// rebinding cr allowed}$ cr = 7; $\C{// ERROR, cannot change cr}$ int & const rc = x; $\C{// must be initialized, like in \CC}$ &rc = &x; $\C{// ERROR, cannot rebind rc}$ rc = 7; $\C{// x now equal to 7}$ \end{cfa} Given that a reference is meant to represent a lvalue, \CFA provides some syntactic shortcuts when initializing references. There are three initialization contexts in \CFA: declaration initialization, argument/parameter binding, and return/temporary binding. In each of these contexts, the address-of operator on the target lvalue may (in fact, must) be elided. The syntactic motivation for this is clearest when considering overloaded operator-assignment, \eg @int ?+=?(int &, int)@; given @int x, y@, the expected call syntax is @x += y@, not @&x += y@. More generally, this initialization of references from lvalues rather than pointers is an instance of a ``lvalue-to-reference'' conversion rather than an elision of the address-of operator; this conversion can actually be used in any context in \CFA an implicit conversion would be allowed. Similarly, use of a the value pointed to by a reference in an rvalue context can be thought of as a ``reference-to-rvalue'' conversion, and \CFA also includes a qualifier-adding ``reference-to-reference'' conversion, analogous to the @T *@ to @const T *@ conversion in standard C. The final reference conversion included in \CFA is ``rvalue-to-reference'' conversion, implemented by means of an implicit temporary. When an rvalue is used to initialize a reference, it is instead used to initialize a hidden temporary value with the same lexical scope as the reference, and the reference is initialized to the address of this temporary. This allows complex values to be succinctly and efficiently passed to functions, without the syntactic overhead of explicit definition of a temporary variable or the runtime cost of pass-by-value. \CC allows a similar binding, but only for @const@ references; the more general semantics of \CFA are an attempt to avoid the \newterm{const hell} problem, in which addition of a @const@ qualifier to one reference requires a cascading chain of added qualifiers. \subsection{Constructors and Destructors} One of the strengths of C is the control over memory management it gives programmers, allowing resource release to be more consistent and precisely timed than is possible with garbage-collected memory management. However, this manual approach to memory management is often verbose, and it is useful to manage resources other than memory (\eg file handles) using the same mechanism as memory. \CC is well-known for an approach to manual memory management that addresses both these issues, Resource Aquisition Is Initialization (RAII), implemented by means of special \newterm{constructor} and \newterm{destructor} functions; we have implemented a similar feature in \CFA. While RAII is a common feature of object-oriented programming languages, its inclusion in \CFA does not violate the design principle that \CFA retain the same procedural paradigm as C. In particular, \CFA does not implement class-based encapsulation: neither the constructor nor any other function has privileged access to the implementation details of a type, except through the translation-unit-scope method of opaque structs provided by C. In \CFA, a constructor is a function named @?{}@, while a destructor is a function named @^?{}@; like other \CFA operators, these names represent the syntax used to call the constructor or destructor, \eg @x{ ... };@ or @^x{};@. Every constructor and destructor must have a return type of @void@, and its first parameter must have a reference type whose base type is the type of the object the function constructs or destructs. This first parameter is informally called the @this@ parameter, as in many object-oriented languages, though a programmer may give it an arbitrary name. Destructors must have exactly one parameter, while constructors allow passing of zero or more additional arguments along with the @this@ parameter. \begin{cfa} struct Array { int * data; int len; }; void ?{}( Array& arr ) { arr.len = 10; arr.data = calloc( arr.len, sizeof(int) ); } void ^?{}( Array& arr ) { free( arr.data ); } { Array x; `?{}(x);` $\C{// implicitly compiler-generated}$ // ... use x `^?{}(x);` $\C{// implicitly compiler-generated}$ } \end{cfa} In the example above, a \newterm{default constructor} (\ie one with no parameters besides the @this@ parameter) and destructor are defined for the @Array@ struct, a dynamic array of @int@. @Array@ is an example of a \newterm{managed type} in \CFA, a type with a non-trivial constructor or destructor, or with a field of a managed type. As in the example, all instances of managed types are implicitly constructed upon allocation, and destructed upon deallocation; this ensures proper initialization and cleanup of resources contained in managed types, in this case the @data@ array on the heap. The exact details of the placement of these implicit constructor and destructor calls are omitted here for brevity, the interested reader should consult \cite{Schluntz17}. Constructor calls are intended to seamlessly integrate with existing C initialization syntax, providing a simple and familiar syntax to veteran C programmers and allowing constructor calls to be inserted into legacy C code with minimal code changes. As such, \CFA also provides syntax for \newterm{copy initialization} and \newterm{initialization parameters}: \begin{cfa} void ?{}( Array& arr, Array other ); void ?{}( Array& arr, int size, int fill ); Array y = { 20, 0xDEADBEEF }, z = y; \end{cfa} Copy constructors have exactly two parameters, the second of which has the same type as the base type of the @this@ parameter; appropriate care is taken in the implementation to avoid recursive calls to the copy constructor when initializing this second parameter. Other constructor calls look just like C initializers, except rather than using field-by-field initialization (as in C), an initialization which matches a defined constructor will call the constructor instead. In addition to initialization syntax, \CFA provides two ways to explicitly call constructors and destructors. Explicit calls to constructors double as a placement syntax, useful for construction of member fields in user-defined constructors and reuse of large storage allocations. While the existing function-call syntax works for explicit calls to constructors and destructors, \CFA also provides a more concise \newterm{operator syntax} for both: \begin{cfa} Array a, b; a{}; $\C{// default construct}$ b{ a }; $\C{// copy construct}$ ^a{}; $\C{// destruct}$ a{ 5, 0xFFFFFFFF }; $\C{// explicit constructor call}$ \end{cfa} To provide a uniform type interface for @otype@ polymorphism, the \CFA compiler automatically generates a default constructor, copy constructor, assignment operator, and destructor for all types. These default functions can be overridden by user-generated versions of them. For compatibility with the standard behaviour of C, the default constructor and destructor for all basic, pointer, and reference types do nothing, while the copy constructor and assignment operator are bitwise copies; if default zero-initialization is desired, the default constructors can be overridden. For user-generated types, the four functions are also automatically generated. @enum@ types are handled the same as their underlying integral type, and unions are also bitwise copied and no-op initialized and destructed. For compatibility with C, a copy constructor from the first union member type is also defined. For @struct@ types, each of the four functions are implicitly defined to call their corresponding functions on each member of the struct. To better simulate the behaviour of C initializers, a set of \newterm{field constructors} is also generated for structures. A constructor is generated for each non-empty prefix of a structure's member-list which copy-constructs the members passed as parameters and default-constructs the remaining members. To allow users to limit the set of constructors available for a type, when a user declares any constructor or destructor, the corresponding generated function and all field constructors for that type are hidden from expression resolution; similarly, the generated default constructor is hidden upon declaration of any constructor. These semantics closely mirror the rule for implicit declaration of constructors in \CC\cite[p.~186]{ANSI98:C++}. In rare situations user programmers may not wish to have constructors and destructors called; in these cases, \CFA provides an ``escape hatch'' to not call them. If a variable is initialized using the syntax \lstinline|S x @= {}| it will be an \newterm{unmanaged object}, and will not have constructors or destructors called. Any C initializer can be the right-hand side of an \lstinline|@=| initializer, \eg \lstinline|Array a @= { 0, 0x0 }|, with the usual C initialization semantics. In addition to the expressive power, \lstinline|@=| provides a simple path for migrating legacy C code to \CFA, by providing a mechanism to incrementally convert initializers; the \CFA design team decided to introduce a new syntax for this escape hatch because we believe that our RAII implementation will handle the vast majority of code in a desirable way, and we wished to maintain familiar syntax for this common case. \subsection{Type Nesting} \CFA allows \newterm{type nesting}, and type qualification of the nested types (see Figure~\ref{f:TypeNestingQualification}), where as C hoists (refactors) nested types into the enclosing scope and has no type qualification. \begin{figure} \centering \lstDeleteShortInline@% \begin{tabular}{@{}l@{\hspace{3em}}l|l@{}} \multicolumn{1}{c@{\hspace{3em}}}{\textbf{C Type Nesting}} & \multicolumn{1}{c}{\textbf{C Implicit Hoisting}} & \multicolumn{1}{|c}{\textbf{\CFA}} \\ \hline \begin{cfa} struct S { enum C { R, G, B }; struct T { union U { int i, j; }; enum C c; short int i, j; }; struct T t; } s; int rtn() { s.t.c = R; struct T t = { R, 1, 2 }; enum C c; union U u; } \end{cfa} & \begin{cfa} enum C { R, G, B }; union U { int i, j; }; struct T { enum C c; short int i, j; }; struct S { struct T t; } s; \end{cfa} & \begin{cfa} struct S { enum C { R, G, B }; struct T { union U { int i, j; }; enum C c; short int i, j; }; struct T t; } s; int rtn() { s.t.c = `S.`R; // type qualification struct `S.`T t = { `S.`R, 1, 2 }; enum `S.`C c; union `S.T.`U u; } \end{cfa} \end{tabular} \lstMakeShortInline@% \caption{Type Nesting / Qualification} \label{f:TypeNestingQualification} \end{figure} In the left example in C, types @C@, @U@ and @T@ are implicitly hoisted outside of type @S@ into the containing block scope. In the right example in \CFA, the types are not hoisted and accessed using the field-selection operator ``@.@'' for type qualification, as does Java, rather than the \CC type-selection operator ``@::@''. \subsection{Default Parameters} \section{Literals} C already includes limited polymorphism for literals -- @0@ can be either an integer or a pointer literal, depending on context, while the syntactic forms of literals of the various integer and float types are very similar, differing from each other only in suffix. In keeping with the general \CFA approach of adding features while respecting ``the C way'' of doing things, we have extended both C's polymorphic zero and typed literal syntax to interoperate with user-defined types, while maintaining a backwards-compatible semantics. \subsection{0/1} In C, @0@ has the special property that it is the only ``false'' value; by the standard, any value which compares equal to @0@ is false, while any value that compares unequal to @0@ is true. As such, an expression @x@ in any boolean context (such as the condition of an @if@ or @while@ statement, or the arguments to an @&&@, @||@, or ternary operator) can be rewritten as @x != 0@ without changing its semantics. The operator overloading feature of \CFA provides a natural means to implement this truth value comparison for arbitrary types, but the C type system is not precise enough to distinguish an equality comparison with @0@ from an equality comparison with an arbitrary integer or pointer. To provide this precision, \CFA introduces a new type @zero_t@ as type type of literal @0@ (somewhat analagous to @nullptr_t@ and @nullptr@ in \CCeleven); @zero_t@ can only take the value @0@, but has implicit conversions to the integer and pointer types so that standard C code involving @0@ continues to work properly. With this addition, the \CFA compiler rewrites @if (x)@ and similar expressions to @if ((x) != 0)@ or the appropriate analogue, and any type @T@ can be made ``truthy'' by defining an operator overload @int ?!=?(T, zero_t)@. \CC makes types truthy by adding a conversion to @bool@; prior to the addition of explicit cast operators in \CCeleven this approach had the pitfall of making truthy types transitively convertable to any numeric type; our design for \CFA avoids this issue. \CFA also includes a special type for @1@, @one_t@; like @zero_t@, @one_t@ has built-in implicit conversions to the various integral types so that @1@ maintains its expected semantics in legacy code. The addition of @one_t@ allows generic algorithms to handle the unit value uniformly for types where that is meaningful. \TODO{Make this sentence true} In particular, polymorphic functions in the \CFA prelude define @++x@ and @x++@ in terms of @x += 1@, allowing users to idiomatically define all forms of increment for a type @T@ by defining the single function @T& ?+=(T&, one_t)@; analogous overloads for the decrement operators are present as well. \subsection{Units} Alternative call syntax (literal argument before routine name) to convert basic literals into user literals. {\lstset{language=CFA,deletedelim=**[is][]{`}{`},moredelim=**[is][\color{red}]{@}{@}} \begin{cfa} struct Weight { double stones; }; void ?{}( Weight & w ) { w.stones = 0; } $\C{// operations}$ void ?{}( Weight & w, double w ) { w.stones = w; } Weight ?+?( Weight l, Weight r ) { return (Weight){ l.stones + r.stones }; } Weight @?`st@( double w ) { return (Weight){ w }; } $\C{// backquote for units}$ Weight @?`lb@( double w ) { return (Weight){ w / 14.0 }; } Weight @?`kg@( double w ) { return (Weight) { w * 0.1575}; } int main() { Weight w, hw = { 14 }; $\C{// 14 stone}$ w = 11@`st@ + 1@`lb@; w = 70.3@`kg@; w = 155@`lb@; w = 0x_9b_u@`lb@; $\C{// hexadecimal unsigned weight (155)}$ w = 0_233@`lb@; $\C{// octal weight (155)}$ w = 5@`st@ + 8@`kg@ + 25@`lb@ + hw; } \end{cfa} }% \section{Libraries} As stated in Section~\ref{sec:poly-fns}, \CFA inherits a large corpus of library code, where other programming languages must rewrite or provide fragile inter-language communication with C. \CFA has replacement libraries condensing hundreds of existing C names into tens of \CFA overloaded names, all without rewriting the actual computations. In many cases, the interface is an inline wrapper providing overloading during compilation but zero cost at runtime. The following sections give a glimpse of the interface reduction to many C libraries. In many cases, @signed@/@unsigned@ @char@ and @short@ routines are available (but not shown) to ensure expression computations remain in a single type, as conversions can distort results. \subsection{Limits} C library @limits.h@ provides lower and upper bound constants for the basic types. \CFA name overloading is used to condense these typed constants, \eg: \begin{cquote} \lstDeleteShortInline@% \begin{tabular}{@{}l@{\hspace{\parindentlnth}}l@{}} \multicolumn{1}{c@{\hspace{\parindentlnth}}}{\textbf{Definition}} & \multicolumn{1}{c}{\textbf{Usage}} \\ \begin{cfa} const short int `MIN` = -32768; const int `MIN` = -2147483648; const long int `MIN` = -9223372036854775808L; \end{cfa} & \begin{cfa} short int si = `MIN`; int i = `MIN`; long int li = `MIN`; \end{cfa} \end{tabular} \lstMakeShortInline@% \end{cquote} The result is a significant reduction in names to access typed constants, \eg: \begin{cquote} \lstDeleteShortInline@% \begin{tabular}{@{}l@{\hspace{\parindentlnth}}l@{}} \multicolumn{1}{c@{\hspace{\parindentlnth}}}{\textbf{\CFA}} & \multicolumn{1}{c}{\textbf{C}} \\ \begin{cfa} MIN MAX M_PI M_E \end{cfa} & \begin{cfa} SCHAR_MIN, CHAR_MIN, SHRT_MIN, INT_MIN, LONG_MIN, LLONG_MIN, SCHAR_MAX, UCHAR_MAX, SHRT_MAX, INT_MAX, LONG_MAX, LLONG_MAX, M_PI, M_PIl, M_CPI, M_CPIl, M_E, M_El, M_CE, M_CEl \end{cfa} \end{tabular} \lstMakeShortInline@% \end{cquote} \subsection{Math} C library @math.h@ provides many mathematical routines. \CFA routine overloading is used to condense these mathematical routines, \eg: \begin{cquote} \lstDeleteShortInline@% \begin{tabular}{@{}l@{\hspace{\parindentlnth}}l@{}} \multicolumn{1}{c@{\hspace{\parindentlnth}}}{\textbf{Definition}} & \multicolumn{1}{c}{\textbf{Usage}} \\ \begin{cfa} float `log`( float x ); double `log`( double ); double _Complex `log`( double _Complex x ); \end{cfa} & \begin{cfa} float f = `log`( 3.5 ); double d = `log`( 3.5 ); double _Complex dc = `log`( 3.5+0.5I ); \end{cfa} \end{tabular} \lstMakeShortInline@% \end{cquote} The result is a significant reduction in names to access math routines, \eg: \begin{cquote} \lstDeleteShortInline@% \begin{tabular}{@{}l@{\hspace{\parindentlnth}}l@{}} \multicolumn{1}{c@{\hspace{\parindentlnth}}}{\textbf{\CFA}} & \multicolumn{1}{c}{\textbf{C}} \\ \begin{cfa} log sqrt sin \end{cfa} & \begin{cfa} logf, log, logl, clogf, clog, clogl sqrtf, sqrt, sqrtl, csqrtf, csqrt, csqrtl sinf, sin, sinl, csinf, csin, csinl \end{cfa} \end{tabular} \lstMakeShortInline@% \end{cquote} While \Celeven has type-generic math~\cite[\S~7.25]{C11} in @tgmath.h@ to provide a similar mechanism, these macros are limited, matching a routine name with a single set of floating type(s). For example, it is not possible to overload @atan@ for both one and two arguments; instead the names @atan@ and @atan2@ are required. The key observation is that only a restricted set of type-generic macros are provided for a limited set of routine names, which do not generalize across the type system, as in \CFA. \subsection{Standard} C library @stdlib.h@ provides many general routines. \CFA routine overloading is used to condense these utility routines, \eg: \begin{cquote} \lstDeleteShortInline@% \begin{tabular}{@{}l@{\hspace{\parindentlnth}}l@{}} \multicolumn{1}{c@{\hspace{\parindentlnth}}}{\textbf{Definition}} & \multicolumn{1}{c}{\textbf{Usage}} \\ \begin{cfa} unsigned int `abs`( int ); double `abs`( double ); double abs( double _Complex ); \end{cfa} & \begin{cfa} unsigned int i = `abs`( -1 ); double d = `abs`( -1.5 ); double d = `abs`( -1.5+0.5I ); \end{cfa} \end{tabular} \lstMakeShortInline@% \end{cquote} The result is a significant reduction in names to access utility routines, \eg: \begin{cquote} \lstDeleteShortInline@% \begin{tabular}{@{}l@{\hspace{\parindentlnth}}l@{}} \multicolumn{1}{c@{\hspace{\parindentlnth}}}{\textbf{\CFA}} & \multicolumn{1}{c}{\textbf{C}} \\ \begin{cfa} abs strto random \end{cfa} & \begin{cfa} abs, labs, llabs, fabsf, fabs, fabsl, cabsf, cabs, cabsl strtol, strtoul, strtoll, strtoull, strtof, strtod, strtold srand48, mrand48, lrand48, drand48 \end{cfa} \end{tabular} \lstMakeShortInline@% \end{cquote} In additon, there are polymorphic routines, like @min@ and @max@, which work on any type with operators @??@. The following shows one example where \CFA \emph{extends} an existing standard C interface to reduce complexity and provide safety. C/\Celeven provide a number of complex and overlapping storage-management operation to support the following capabilities: \begin{description}[itemsep=2pt,parsep=0pt] \item[fill] after allocation the storage is filled with a specified character. \item[resize] an existing allocation is decreased or increased in size. In either case, new storage may or may not be allocated and, if there is a new allocation, as much data from the existing allocation is copied. For an increase in storage size, new storage after the copied data may be filled. \item[alignment] an allocation starts on a specified memory boundary, \eg, an address multiple of 64 or 128 for cache-line purposes. \item[array] the allocation size is scaled to the specified number of array elements. An array may be filled, resized, or aligned. \end{description} Table~\ref{t:StorageManagementOperations} shows the capabilities provided by C/\Celeven allocation-routines and how all the capabilities can be combined into two \CFA routines. \CFA storage-management routines extend the C equivalents by overloading, providing shallow type-safety, and removing the need to specify the base allocation-size. The following example contrasts \CFA and C storage-allocation operation performing the same operations with the same type safety: \begin{cquote} \begin{cfa}[aboveskip=0pt] size_t dim = 10; $\C{// array dimension}$ char fill = '\xff'; $\C{// initialization fill value}$ int * ip; \end{cfa} \lstDeleteShortInline@% \begin{tabular}{@{}l@{\hspace{\parindentlnth}}l@{}} \multicolumn{1}{c@{\hspace{\parindentlnth}}}{\textbf{\CFA}} & \multicolumn{1}{c}{\textbf{C}} \\ \begin{cfa} ip = alloc(); ip = alloc( fill ); ip = alloc( dim ); ip = alloc( dim, fill ); ip = alloc( ip, 2 * dim ); ip = alloc( ip, 4 * dim, fill ); ip = align_alloc( 16 ); ip = align_alloc( 16, fill ); ip = align_alloc( 16, dim ); ip = align_alloc( 16, dim, fill ); \end{cfa} & \begin{cfa} ip = (int *)malloc( sizeof( int ) ); ip = (int *)malloc( sizeof( int ) ); memset( ip, fill, sizeof( int ) ); ip = (int *)malloc( dim * sizeof( int ) ); ip = (int *)malloc( sizeof( int ) ); memset( ip, fill, dim * sizeof( int ) ); ip = (int *)realloc( ip, 2 * dim * sizeof( int ) ); ip = (int *)realloc( ip, 4 * dim * sizeof( int ) ); memset( ip, fill, 4 * dim * sizeof( int ) ); ip = memalign( 16, sizeof( int ) ); ip = memalign( 16, sizeof( int ) ); memset( ip, fill, sizeof( int ) ); ip = memalign( 16, dim * sizeof( int ) ); ip = memalign( 16, dim * sizeof( int ) ); memset( ip, fill, dim * sizeof( int ) ); \end{cfa} \end{tabular} \lstMakeShortInline@% \end{cquote} Variadic @new@ (see Section~\ref{sec:variadic-tuples}) cannot support the same overloading because extra parameters are for initialization. Hence, there are @new@ and @anew@ routines for single and array variables, and the fill value is the arguments to the constructor, \eg: \begin{cfa} struct S { int i, j; }; void ?{}( S & s, int i, int j ) { s.i = i; s.j = j; } S * s = new( 2, 3 ); $\C{// allocate storage and run constructor}$ S * as = anew( dim, 2, 3 ); $\C{// each array element initialized to 2, 3}$ \end{cfa} Note, \CC can only initialization array elements via the default constructor. Finally, the \CFA memory-allocator has \newterm{sticky properties} for dynamic storage: fill and alignment are remembered with an object's storage in the heap. When a @realloc@ is performed, the sticky properties are respected, so that new storage is correctly aligned and initialized with the fill character. \begin{table} \centering \lstDeleteShortInline@% \lstMakeShortInline~% \begin{tabular}{@{}r|r|l|l|l|l@{}} \multicolumn{1}{c}{}& & \multicolumn{1}{c|}{fill} & resize & alignment & array \\ \hline C & ~malloc~ & no & no & no & no \\ & ~calloc~ & yes (0 only) & no & no & yes \\ & ~realloc~ & no/copy & yes & no & no \\ & ~memalign~ & no & no & yes & no \\ & ~posix_memalign~ & no & no & yes & no \\ \hline C11 & ~aligned_alloc~ & no & no & yes & no \\ \hline \CFA & ~alloc~ & yes/copy & no/yes & no & yes \\ & ~align_alloc~ & yes & no & yes & yes \\ \end{tabular} \lstDeleteShortInline~% \lstMakeShortInline@% \caption{Storage-Management Operations} \label{t:StorageManagementOperations} \end{table} \subsection{I/O} \label{s:IOLibrary} The goal of \CFA I/O is to simplify the common cases, while fully supporting polymorphism and user defined types in a consistent way. The approach combines ideas from \CC and Python. The \CFA header file for the I/O library is @fstream@. The common case is printing out a sequence of variables separated by whitespace. \begin{cquote} \lstDeleteShortInline@% \begin{tabular}{@{}l@{\hspace{\parindentlnth}}l@{}} \multicolumn{1}{c@{\hspace{\parindentlnth}}}{\textbf{\CFA}} & \multicolumn{1}{c}{\textbf{\CC}} \\ \begin{cfa} int x = 1, y = 2, z = 3; sout | x `|` y `|` z | endl; \end{cfa} & \begin{cfa} cout << x `<< " "` << y `<< " "` << z << endl; \end{cfa} \\ \begin{cfa}[showspaces=true,aboveskip=0pt,belowskip=0pt] 1` `2` `3 \end{cfa} & \begin{cfa}[showspaces=true,aboveskip=0pt,belowskip=0pt] 1 2 3 \end{cfa} \end{tabular} \lstMakeShortInline@% \end{cquote} The \CFA form has half the characters of the \CC form, and is similar to Python I/O with respect to implicit separators. Similar simplification occurs for tuple I/O, which prints all tuple values separated by ``\lstinline[showspaces=true]@, @''. \begin{cfa} [int, [ int, int ] ] t1 = [ 1, [ 2, 3 ] ], t2 = [ 4, [ 5, 6 ] ]; sout | t1 | t2 | endl; $\C{// print tuples}$ \end{cfa} \begin{cfa}[showspaces=true,aboveskip=0pt] 1`, `2`, `3 4`, `5`, `6 \end{cfa} Finally, \CFA uses the logical-or operator for I/O as it is the lowest-priority overloadable operator, other than assignment. Therefore, fewer output expressions require parenthesis. \begin{cquote} \lstDeleteShortInline@% \begin{tabular}{@{}ll@{}} \textbf{\CFA:} & \begin{cfa} sout | x * 3 | y + 1 | z << 2 | x == y | (x | y) | (x || y) | (x > z ? 1 : 2) | endl; \end{cfa} \\ \textbf{\CC:} & \begin{cfa} cout << x * 3 << y + 1 << `(`z << 2`)` << `(`x == y`)` << (x | y) << (x || y) << (x > z ? 1 : 2) << endl; \end{cfa} \\ \textbf{output:} & \begin{cfa}[showspaces=true,aboveskip=0pt] 3 3 12 0 3 1 2 \end{cfa} \end{tabular} \lstMakeShortInline@% \end{cquote} There is a weak similarity between the \CFA logical-or operator and the Shell pipe-operator for moving data, where data flows in the correct direction for input but the opposite direction for output. The implicit separator character (space/blank) is a separator not a terminator. The rules for implicitly adding the separator are: \begin{itemize}[itemsep=2pt,parsep=0pt] \item A separator does not appear at the start or end of a line. \item A separator does not appear before or after a character literal or variable. \item A separator does not appear before or after a null (empty) C string, which is a local mechanism to disable insertion of the separator character. \item A separator does not appear before a C string starting with the characters: \lstinline[mathescape=off,basicstyle=\tt]@([{=$@ \item A seperator does not appear after a C string ending with the characters: \lstinline[basicstyle=\tt]@,.;!?)]}%@ \item {\lstset{language=CFA,deletedelim=**[is][]{`}{`}} A seperator does not appear before or after a C string begining/ending with the quote or whitespace characters: \lstinline[basicstyle=\tt,showspaces=true]@`'": \t\v\f\r\n@ }% \item There are routines to set and get the separator string, and manipulators to toggle separation on and off in the middle of output. \end{itemize} \subsection{Multi-precision Integers} \label{s:MultiPrecisionIntegers} \CFA has an interface to the GMP multi-precision signed-integers~\cite{GMP}, similar to the \CC interface provided by GMP. The \CFA interface wraps GMP routines into operator routines to make programming with multi-precision integers identical to using fixed-sized integers. The \CFA type name for multi-precision signed-integers is @Int@ and the header file is @gmp@. The following multi-precision factorial programs contrast using GMP with the \CFA and C interfaces. \begin{cquote} \lstDeleteShortInline@% \begin{tabular}{@{}l@{\hspace{\parindentlnth}}@{\hspace{\parindentlnth}}l@{}} \multicolumn{1}{c@{\hspace{\parindentlnth}}}{\textbf{\CFA}} & \multicolumn{1}{@{\hspace{\parindentlnth}}c}{\textbf{C}} \\ \begin{cfa} #include int main( void ) { sout | "Factorial Numbers" | endl; Int fact = 1; sout | 0 | fact | endl; for ( unsigned int i = 1; i <= 40; i += 1 ) { fact *= i; sout | i | fact | endl; } } \end{cfa} & \begin{cfa} #include int main( void ) { `gmp_printf`( "Factorial Numbers\n" ); `mpz_t` fact; `mpz_init_set_ui`( fact, 1 ); `gmp_printf`( "%d %Zd\n", 0, fact ); for ( unsigned int i = 1; i <= 40; i += 1 ) { `mpz_mul_ui`( fact, fact, i ); `gmp_printf`( "%d %Zd\n", i, fact ); } } \end{cfa} \end{tabular} \lstMakeShortInline@% \end{cquote} \section{Evaluation} \label{sec:eval} Though \CFA provides significant added functionality over C, these features have a low runtime penalty. In fact, \CFA's features for generic programming can enable faster runtime execution than idiomatic @void *@-based C code. This claim is demonstrated through a set of generic-code-based micro-benchmarks in C, \CFA, and \CC (see stack implementations in Appendix~\ref{sec:BenchmarkStackImplementation}). Since all these languages share a subset essentially comprising standard C, maximal-performance benchmarks would show little runtime variance, other than in length and clarity of source code. A more illustrative benchmark measures the costs of idiomatic usage of each language's features. Figure~\ref{fig:BenchmarkTest} shows the \CFA benchmark tests for a generic stack based on a singly linked-list, a generic pair-data-structure, and a variadic @print@ routine similar to that in Section~\ref{sec:variadic-tuples}. The benchmark test is similar for C and \CC. The experiment uses element types @int@ and @pair(_Bool, char)@, and pushes $N=40M$ elements on a generic stack, copies the stack, clears one of the stacks, finds the maximum value in the other stack, and prints $N/2$ (to reduce graph height) constants. \begin{figure} \begin{lstlisting}[xleftmargin=3\parindentlnth,aboveskip=0pt,belowskip=0pt] int main( int argc, char * argv[] ) { FILE * out = fopen( "cfa-out.txt", "w" ); int maxi = 0, vali = 42; stack(int) si, ti; REPEAT_TIMED( "push_int", N, push( &si, vali ); ) TIMED( "copy_int", ti = si; ) TIMED( "clear_int", clear( &si ); ) REPEAT_TIMED( "pop_int", N, int xi = pop( &ti ); if ( xi > maxi ) { maxi = xi; } ) REPEAT_TIMED( "print_int", N/2, print( out, vali, ":", vali, "\n" ); ) pair(_Bool, char) maxp = { (_Bool)0, '\0' }, valp = { (_Bool)1, 'a' }; stack(pair(_Bool, char)) sp, tp; REPEAT_TIMED( "push_pair", N, push( &sp, valp ); ) TIMED( "copy_pair", tp = sp; ) TIMED( "clear_pair", clear( &sp ); ) REPEAT_TIMED( "pop_pair", N, pair(_Bool, char) xp = pop( &tp ); if ( xp > maxp ) { maxp = xp; } ) REPEAT_TIMED( "print_pair", N/2, print( out, valp, ":", valp, "\n" ); ) fclose(out); } \end{lstlisting} \caption{\protect\CFA Benchmark Test} \label{fig:BenchmarkTest} \end{figure} The structure of each benchmark implemented is: C with @void *@-based polymorphism, \CFA with the presented features, \CC with templates, and \CC using only class inheritance for polymorphism, called \CCV. The \CCV variant illustrates an alternative object-oriented idiom where all objects inherit from a base @object@ class, mimicking a Java-like interface; hence runtime checks are necessary to safely down-cast objects. The most notable difference among the implementations is in memory layout of generic types: \CFA and \CC inline the stack and pair elements into corresponding list and pair nodes, while C and \CCV lack such a capability and instead must store generic objects via pointers to separately-allocated objects. For the print benchmark, idiomatic printing is used: the C and \CFA variants used @stdio.h@, while the \CC and \CCV variants used @iostream@; preliminary tests show this distinction has negligible runtime impact. Note, the C benchmark uses unchecked casts as there is no runtime mechanism to perform such checks, while \CFA and \CC provide type-safety statically. Figure~\ref{fig:eval} and Table~\ref{tab:eval} show the results of running the benchmark in Figure~\ref{fig:BenchmarkTest} and its C, \CC, and \CCV equivalents. The graph plots the median of 5 consecutive runs of each program, with an initial warm-up run omitted. All code is compiled at \texttt{-O2} by GCC or G++ 6.2.0, with all \CC code compiled as \CCfourteen. The benchmarks are run on an Ubuntu 16.04 workstation with 16 GB of RAM and a 6-core AMD FX-6300 CPU with 3.5 GHz maximum clock frequency. \begin{figure} \centering \input{timing} \caption{Benchmark Timing Results (smaller is better)} \label{fig:eval} \end{figure} \begin{table} \centering \caption{Properties of benchmark code} \label{tab:eval} \newcommand{\CT}[1]{\multicolumn{1}{c}{#1}} \begin{tabular}{rrrrr} & \CT{C} & \CT{\CFA} & \CT{\CC} & \CT{\CCV} \\ \hline maximum memory usage (MB) & 10001 & 2502 & 2503 & 11253 \\ source code size (lines) & 247 & 222 & 165 & 339 \\ redundant type annotations (lines) & 39 & 2 & 2 & 15 \\ binary size (KB) & 14 & 229 & 18 & 38 \\ \end{tabular} \end{table} The C and \CCV variants are generally the slowest with the largest memory footprint, because of their less-efficient memory layout and the pointer-indirection necessary to implement generic types; this inefficiency is exacerbated by the second level of generic types in the pair-based benchmarks. By contrast, the \CFA and \CC variants run in roughly equivalent time for both the integer and pair of @_Bool@ and @char@ because the storage layout is equivalent, with the inlined libraries (\ie no separate compilation) and greater maturity of the \CC compiler contributing to its lead. \CCV is slower than C largely due to the cost of runtime type-checking of down-casts (implemented with @dynamic_cast@); There are two outliers in the graph for \CFA: all prints and pop of @pair@. Both of these cases result from the complexity of the C-generated polymorphic code, so that the GCC compiler is unable to optimize some dead code and condense nested calls. A compiler designed for \CFA could easily perform these optimizations. Finally, the binary size for \CFA is larger because of static linking with the \CFA libraries. \CFA is also competitive in terms of source code size, measured as a proxy for programmer effort. The line counts in Table~\ref{tab:eval} include implementations of @pair@ and @stack@ types for all four languages for purposes of direct comparison, though it should be noted that \CFA and \CC have pre-written data structures in their standard libraries that programmers would generally use instead. Use of these standard library types has minimal impact on the performance benchmarks, but shrinks the \CFA and \CC benchmarks to 73 and 54 lines, respectively. On the other hand, C does not have a generic collections-library in its standard distribution, resulting in frequent reimplementation of such collection types by C programmers. \CCV does not use the \CC standard template library by construction, and in fact includes the definition of @object@ and wrapper classes for @bool@, @char@, @int@, and @const char *@ in its line count, which inflates this count somewhat, as an actual object-oriented language would include these in the standard library; with their omission, the \CCV line count is similar to C. We justify the given line count by noting that many object-oriented languages do not allow implementing new interfaces on library types without subclassing or wrapper types, which may be similarly verbose. Raw line-count, however, is a fairly rough measure of code complexity; another important factor is how much type information the programmer must manually specify, especially where that information is not checked by the compiler. Such unchecked type information produces a heavier documentation burden and increased potential for runtime bugs, and is much less common in \CFA than C, with its manually specified function pointers arguments and format codes, or \CCV, with its extensive use of un-type-checked downcasts (\eg @object@ to @integer@ when popping a stack, or @object@ to @printable@ when printing the elements of a @pair@). To quantify this, the ``redundant type annotations'' line in Table~\ref{tab:eval} counts the number of lines on which the type of a known variable is re-specified, either as a format specifier, explicit downcast, type-specific function, or by name in a @sizeof@, struct literal, or @new@ expression. The \CC benchmark uses two redundant type annotations to create a new stack nodes, while the C and \CCV benchmarks have several such annotations spread throughout their code. The two instances in which the \CFA benchmark still uses redundant type specifiers are to cast the result of a polymorphic @malloc@ call (the @sizeof@ argument is inferred by the compiler). These uses are similar to the @new@ expressions in \CC, though the \CFA compiler's type resolver should shortly render even these type casts superfluous. \section{Related Work} \subsection{Polymorphism} \CC is the most similar language to \CFA; both are extensions to C with source and runtime backwards compatibility. The fundamental difference is in their engineering approach to C compatibility and programmer expectation. While \CC provides good backwards compatibility with C, it has a steep learning curve for many of its extensions. For example, polymorphism is provided via three disjoint mechanisms: overloading, inheritance, and templates. The overloading is restricted because resolution does not use the return type, inheritance requires learning object-oriented programming and coping with a restricted nominal-inheritance hierarchy, templates cannot be separately compiled resulting in compilation/code bloat and poor error messages, and determining how these mechanisms interact and which to use is confusing. In contrast, \CFA has a single facility for polymorphic code supporting type-safe separate-compilation of polymorphic functions and generic (opaque) types, which uniformly leverage the C procedural paradigm. The key mechanism to support separate compilation is \CFA's \emph{explicit} use of assumed properties for a type. Until \CC concepts~\cite{C++Concepts} are standardized (anticipated for \CCtwenty), \CC provides no way to specify the requirements of a generic function in code beyond compilation errors during template expansion; furthermore, \CC concepts are restricted to template polymorphism. Cyclone~\cite{Grossman06} also provides capabilities for polymorphic functions and existential types, similar to \CFA's @forall@ functions and generic types. Cyclone existential types can include function pointers in a construct similar to a virtual function-table, but these pointers must be explicitly initialized at some point in the code, a tedious and potentially error-prone process. Furthermore, Cyclone's polymorphic functions and types are restricted to abstraction over types with the same layout and calling convention as @void *@, \ie only pointer types and @int@. In \CFA terms, all Cyclone polymorphism must be dtype-static. While the Cyclone design provides the efficiency benefits discussed in Section~\ref{sec:generic-apps} for dtype-static polymorphism, it is more restrictive than \CFA's general model. Smith and Volpano~\cite{Smith98} present Polymorphic C, an ML dialect with polymorphic functions, C-like syntax, and pointer types; it lacks many of C's features, however, most notably structure types, and so is not a practical C replacement. Objective-C~\cite{obj-c-book} is an industrially successful extension to C. However, Objective-C is a radical departure from C, using an object-oriented model with message-passing. Objective-C did not support type-checked generics until recently \cite{xcode7}, historically using less-efficient runtime checking of object types. The GObject~\cite{GObject} framework also adds object-oriented programming with runtime type-checking and reference-counting garbage-collection to C; these features are more intrusive additions than those provided by \CFA, in addition to the runtime overhead of reference-counting. Vala~\cite{Vala} compiles to GObject-based C, adding the burden of learning a separate language syntax to the aforementioned demerits of GObject as a modernization path for existing C code-bases. Java~\cite{Java8} included generic types in Java~5, which are type-checked at compilation and type-erased at runtime, similar to \CFA's. However, in Java, each object carries its own table of method pointers, while \CFA passes the method pointers separately to maintain a C-compatible layout. Java is also a garbage-collected, object-oriented language, with the associated resource usage and C-interoperability burdens. D~\cite{D}, Go, and Rust~\cite{Rust} are modern, compiled languages with abstraction features similar to \CFA traits, \emph{interfaces} in D and Go and \emph{traits} in Rust. However, each language represents a significant departure from C in terms of language model, and none has the same level of compatibility with C as \CFA. D and Go are garbage-collected languages, imposing the associated runtime overhead. The necessity of accounting for data transfer between managed runtimes and the unmanaged C runtime complicates foreign-function interfaces to C. Furthermore, while generic types and functions are available in Go, they are limited to a small fixed set provided by the compiler, with no language facility to define more. D restricts garbage collection to its own heap by default, while Rust is not garbage-collected, and thus has a lighter-weight runtime more interoperable with C. Rust also possesses much more powerful abstraction capabilities for writing generic code than Go. On the other hand, Rust's borrow-checker provides strong safety guarantees but is complex and difficult to learn and imposes a distinctly idiomatic programming style. \CFA, with its more modest safety features, allows direct ports of C code while maintaining the idiomatic style of the original source. \subsection{Tuples/Variadics} Many programming languages have some form of tuple construct and/or variadic functions, \eg SETL, C, KW-C, \CC, D, Go, Java, ML, and Scala. SETL~\cite{SETL} is a high-level mathematical programming language, with tuples being one of the primary data types. Tuples in SETL allow subscripting, dynamic expansion, and multiple assignment. C provides variadic functions through @va_list@ objects, but the programmer is responsible for managing the number of arguments and their types, so the mechanism is type unsafe. KW-C~\cite{Buhr94a}, a predecessor of \CFA, introduced tuples to C as an extension of the C syntax, taking much of its inspiration from SETL. The main contributions of that work were adding MRVF, tuple mass and multiple assignment, and record-field access. \CCeleven introduced @std::tuple@ as a library variadic template structure. Tuples are a generalization of @std::pair@, in that they allow for arbitrary length, fixed-size aggregation of heterogeneous values. Operations include @std::get@ to extract values, @std::tie@ to create a tuple of references used for assignment, and lexicographic comparisons. \CCseventeen proposes \emph{structured bindings}~\cite{Sutter15} to eliminate pre-declaring variables and use of @std::tie@ for binding the results. This extension requires the use of @auto@ to infer the types of the new variables, so complicated expressions with a non-obvious type must be documented with some other mechanism. Furthermore, structured bindings are not a full replacement for @std::tie@, as it always declares new variables. Like \CC, D provides tuples through a library variadic-template structure. Go does not have tuples but supports MRVF. Java's variadic functions appear similar to C's but are type-safe using homogeneous arrays, which are less useful than \CFA's heterogeneously-typed variadic functions. Tuples are a fundamental abstraction in most functional programming languages, such as Standard ML~\cite{sml} and~\cite{Scala}, which decompose tuples using pattern matching. \section{Conclusion and Future Work} The goal of \CFA is to provide an evolutionary pathway for large C development-environments to be more productive and safer, while respecting the talent and skill of C programmers. While other programming languages purport to be a better C, they are in fact new and interesting languages in their own right, but not C extensions. The purpose of this paper is to introduce \CFA, and showcase language features that illustrate the \CFA type-system and approaches taken to achieve the goal of evolutionary C extension. The contributions are a powerful type-system using parametric polymorphism and overloading, generic types, and tuples, which all have complex interactions. The work is a challenging design, engineering, and implementation exercise. On the surface, the project may appear as a rehash of similar mechanisms in \CC. However, every \CFA feature is different than its \CC counterpart, often with extended functionality, better integration with C and its programmers, and always supporting separate compilation. All of these new features are being used by the \CFA development-team to build the \CFA runtime-system. Finally, we demonstrate that \CFA performance for some idiomatic cases is better than C and close to \CC, showing the design is practically applicable. There is ongoing work on a wide range of \CFA feature extensions, including arrays with size, exceptions, concurrent primitives, modules, and user-defined conversions. (While all examples in the paper compile and run, a public beta-release of \CFA will take another 8--12 months to finalize these additional extensions.) In addition, there are interesting future directions for the polymorphism design. Notably, \CC template functions trade compile time and code bloat for optimal runtime of individual instantiations of polymorphic functions. \CFA polymorphic functions use dynamic virtual-dispatch; the runtime overhead of this approach is low, but not as low as inlining, and it may be beneficial to provide a mechanism for performance-sensitive code. Two promising approaches are an @inline@ annotation at polymorphic function call sites to create a template-specialization of the function (provided the code is visible) or placing an @inline@ annotation on polymorphic function-definitions to instantiate a specialized version for some set of types (\CC template specialization). These approaches are not mutually exclusive and allow performance optimizations to be applied only when necessary, without suffering global code-bloat. In general, we believe separate compilation, producing smaller code, works well with loaded hardware-caches, which may offset the benefit of larger inlined-code. \section{Acknowledgments} The authors would like to recognize the design assistance of Glen Ditchfield, Richard Bilson, and Thierry Delisle on the features described in this paper, and thank Magnus Madsen and the three anonymous reviewers for valuable feedback. %This work is supported in part by a corporate partnership with \grantsponsor{Huawei}{Huawei Ltd.}{http://www.huawei.com}, and Aaron Moss and Peter Buhr are funded by the \grantsponsor{Natural Sciences and Engineering Research Council} of Canada. % the first author's \grantsponsor{NSERC-PGS}{NSERC PGS D}{http://www.nserc-crsng.gc.ca/Students-Etudiants/PG-CS/BellandPostgrad-BelletSuperieures_eng.asp} scholarship. \bibliographystyle{plain} \bibliography{pl} \appendix \section{Benchmark Stack Implementation} \label{sec:BenchmarkStackImplementation} \lstset{basicstyle=\linespread{0.9}\sf\small} Throughout, @/***/@ designates a counted redundant type annotation. \smallskip\noindent \CFA \begin{lstlisting}[xleftmargin=2\parindentlnth,aboveskip=0pt,belowskip=0pt] forall(otype T) struct stack_node { T value; stack_node(T) * next; }; forall(otype T) void ?{}(stack(T) * s) { (&s->head){ 0 }; } forall(otype T) void ?{}(stack(T) * s, stack(T) t) { stack_node(T) ** crnt = &s->head; for ( stack_node(T) * next = t.head; next; next = next->next ) { *crnt = ((stack_node(T) *)malloc()){ next->value }; /***/ stack_node(T) * acrnt = *crnt; crnt = &acrnt->next; } *crnt = 0; } forall(otype T) stack(T) ?=?(stack(T) * s, stack(T) t) { if ( s->head == t.head ) return *s; clear(s); s{ t }; return *s; } forall(otype T) void ^?{}(stack(T) * s) { clear(s); } forall(otype T) _Bool empty(const stack(T) * s) { return s->head == 0; } forall(otype T) void push(stack(T) * s, T value) { s->head = ((stack_node(T) *)malloc()){ value, s->head }; /***/ } forall(otype T) T pop(stack(T) * s) { stack_node(T) * n = s->head; s->head = n->next; T x = n->value; ^n{}; free(n); return x; } forall(otype T) void clear(stack(T) * s) { for ( stack_node(T) * next = s->head; next; ) { stack_node(T) * crnt = next; next = crnt->next; delete(crnt); } s->head = 0; } \end{lstlisting} \medskip\noindent \CC \begin{lstlisting}[xleftmargin=2\parindentlnth,aboveskip=0pt,belowskip=0pt] template class stack { struct node { T value; node * next; node( const T & v, node * n = nullptr ) : value(v), next(n) {} }; node * head; void copy(const stack& o) { node ** crnt = &head; for ( node * next = o.head;; next; next = next->next ) { *crnt = new node{ next->value }; /***/ crnt = &(*crnt)->next; } *crnt = nullptr; } public: stack() : head(nullptr) {} stack(const stack& o) { copy(o); } stack(stack && o) : head(o.head) { o.head = nullptr; } ~stack() { clear(); } stack & operator= (const stack& o) { if ( this == &o ) return *this; clear(); copy(o); return *this; } stack & operator= (stack && o) { if ( this == &o ) return *this; head = o.head; o.head = nullptr; return *this; } bool empty() const { return head == nullptr; } void push(const T & value) { head = new node{ value, head }; /***/ } T pop() { node * n = head; head = n->next; T x = std::move(n->value); delete n; return x; } void clear() { for ( node * next = head; next; ) { node * crnt = next; next = crnt->next; delete crnt; } head = nullptr; } }; \end{lstlisting} \medskip\noindent C \begin{lstlisting}[xleftmargin=2\parindentlnth,aboveskip=0pt,belowskip=0pt] struct stack_node { void * value; struct stack_node * next; }; struct stack new_stack() { return (struct stack){ NULL }; /***/ } void copy_stack(struct stack * s, const struct stack * t, void * (*copy)(const void *)) { struct stack_node ** crnt = &s->head; for ( struct stack_node * next = t->head; next; next = next->next ) { *crnt = malloc(sizeof(struct stack_node)); /***/ **crnt = (struct stack_node){ copy(next->value) }; /***/ crnt = &(*crnt)->next; } *crnt = 0; } _Bool stack_empty(const struct stack * s) { return s->head == NULL; } void push_stack(struct stack * s, void * value) { struct stack_node * n = malloc(sizeof(struct stack_node)); /***/ *n = (struct stack_node){ value, s->head }; /***/ s->head = n; } void * pop_stack(struct stack * s) { struct stack_node * n = s->head; s->head = n->next; void * x = n->value; free(n); return x; } void clear_stack(struct stack * s, void (*free_el)(void *)) { for ( struct stack_node * next = s->head; next; ) { struct stack_node * crnt = next; next = crnt->next; free_el(crnt->value); free(crnt); } s->head = NULL; } \end{lstlisting} \medskip\noindent \CCV \begin{lstlisting}[xleftmargin=2\parindentlnth,aboveskip=0pt,belowskip=0pt] stack::node::node( const object & v, node * n ) : value( v.new_copy() ), next( n ) {} void stack::copy(const stack & o) { node ** crnt = &head; for ( node * next = o.head; next; next = next->next ) { *crnt = new node{ *next->value }; crnt = &(*crnt)->next; } *crnt = nullptr; } stack::stack() : head(nullptr) {} stack::stack(const stack & o) { copy(o); } stack::stack(stack && o) : head(o.head) { o.head = nullptr; } stack::~stack() { clear(); } stack & stack::operator= (const stack & o) { if ( this == &o ) return *this; clear(); copy(o); return *this; } stack & stack::operator= (stack && o) { if ( this == &o ) return *this; head = o.head; o.head = nullptr; return *this; } bool stack::empty() const { return head == nullptr; } void stack::push(const object & value) { head = new node{ value, head }; /***/ } ptr stack::pop() { node * n = head; head = n->next; ptr x = std::move(n->value); delete n; return x; } void stack::clear() { for ( node * next = head; next; ) { node * crnt = next; next = crnt->next; delete crnt; } head = nullptr; } \end{lstlisting} \begin{comment} \subsubsection{bench.h} (\texttt{bench.hpp} is similar.) \lstinputlisting{evaluation/bench.h} \subsection{C} \subsubsection{c-stack.h} ~ \lstinputlisting{evaluation/c-stack.h} \subsubsection{c-stack.c} ~ \lstinputlisting{evaluation/c-stack.c} \subsubsection{c-pair.h} ~ \lstinputlisting{evaluation/c-pair.h} \subsubsection{c-pair.c} ~ \lstinputlisting{evaluation/c-pair.c} \subsubsection{c-print.h} ~ \lstinputlisting{evaluation/c-print.h} \subsubsection{c-print.c} ~ \lstinputlisting{evaluation/c-print.c} \subsubsection{c-bench.c} ~ \lstinputlisting{evaluation/c-bench.c} \subsection{\CFA} \subsubsection{cfa-stack.h} ~ \lstinputlisting{evaluation/cfa-stack.h} \subsubsection{cfa-stack.c} ~ \lstinputlisting{evaluation/cfa-stack.c} \subsubsection{cfa-print.h} ~ \lstinputlisting{evaluation/cfa-print.h} \subsubsection{cfa-print.c} ~ \lstinputlisting{evaluation/cfa-print.c} \subsubsection{cfa-bench.c} ~ \lstinputlisting{evaluation/cfa-bench.c} \subsection{\CC} \subsubsection{cpp-stack.hpp} ~ \lstinputlisting[language=c++]{evaluation/cpp-stack.hpp} \subsubsection{cpp-print.hpp} ~ \lstinputlisting[language=c++]{evaluation/cpp-print.hpp} \subsubsection{cpp-bench.cpp} ~ \lstinputlisting[language=c++]{evaluation/cpp-bench.cpp} \subsection{\CCV} \subsubsection{object.hpp} ~ \lstinputlisting[language=c++]{evaluation/object.hpp} \subsubsection{cpp-vstack.hpp} ~ \lstinputlisting[language=c++]{evaluation/cpp-vstack.hpp} \subsubsection{cpp-vstack.cpp} ~ \lstinputlisting[language=c++]{evaluation/cpp-vstack.cpp} \subsubsection{cpp-vprint.hpp} ~ \lstinputlisting[language=c++]{evaluation/cpp-vprint.hpp} \subsubsection{cpp-vbench.cpp} ~ \lstinputlisting[language=c++]{evaluation/cpp-vbench.cpp} \end{comment} \end{document} % Local Variables: % % tab-width: 4 % % compile-command: "make" % % End: %