/*
 *  R : A Computer Language for Statistical Data Analysis
 *  Copyright (C) 1997--2025  The R Core Team
 *  Copyright (C) 1995, 1996  Robert Gentleman and Ross Ihaka
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, a copy is available at
 *  https://www.R-project.org/Licenses/
 */

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include <string.h> // for memset, strcat, strlen, strncmp
#include <Defn.h>

#include "statsR.h"
#include "statsErr.h"

/* inline-able versions, used just once! */
static R_INLINE bool isUnordered_int(SEXP s)
{
    return (TYPEOF(s) == INTSXP
	    && inherits(s, "factor")
	    && !inherits(s, "ordered"));
}

static R_INLINE bool isOrdered_int(SEXP s)
{
    return (TYPEOF(s) == INTSXP
	    && inherits(s, "factor")
	    && inherits(s, "ordered"));
}

/*
 *  model.frame
 *
 *  The argument "terms" contains the terms object generated from the
 *  model formula.  We first evaluate the "variables" attribute of
 *  "terms" in the "data" environment.  This gives us a list of basic
 *  variables to be in the model frame.  We do some basic sanity
 *  checks on these to ensure that resulting object make sense.
 *
 *  The argument "dots" gives additional things like "weights", "offsets"
 *  and "subset" which will also go into the model frame so that they can
 *  be treated in parallel.
 *
 *  Next we subset the data frame according to "subset" and finally apply
 *  "na.action" to get the final data frame.
 *
 *  Note that the "terms" argument is glued to the model frame as an
 *  attribute.  Code downstream appears to need this.
 *
 */

/* model.frame(terms, rownames, variables, varnames, */
/*             dots, dotnames, subset, na.action) */

SEXP modelframe(SEXP call, SEXP op, SEXP args, SEXP rho)
{
    SEXP terms, data, names, variables, varnames, dots, dotnames, na_action;
    SEXP ans, row_names, subset, tmp;
    char buf[256];
    int i, j, nr, nc;
    int nvars, ndots, nactualdots;
    const void *vmax = vmaxget();

    args = CDR(args);
    terms = CAR(args); args = CDR(args);
    row_names = CAR(args); args = CDR(args);
    variables = CAR(args); args = CDR(args);
    varnames = CAR(args); args = CDR(args);
    dots = CAR(args); args = CDR(args);
    dotnames = CAR(args); args = CDR(args);
    subset = CAR(args); args = CDR(args);
    na_action = CAR(args);

    /* Argument Sanity Checks */

    if (!isNewList(variables))
	error(_("invalid variables"));
    if (!isString(varnames))
	error(_("invalid variable names"));
    if ((nvars = length(variables)) != length(varnames))
	error(_("number of variables != number of variable names"));

    if (!isNewList(dots))
	error(_("invalid extra variables"));
    if ((ndots = length(dots)) != length(dotnames))
	error(_("number of variables != number of variable names"));
    if ( ndots && !isString(dotnames))
	error(_("invalid extra variable names"));

    /*  check for NULL extra arguments -- moved from interpreted code */

    nactualdots = 0;
    for (i = 0; i < ndots; i++)
	if (VECTOR_ELT(dots, i) != R_NilValue) nactualdots++;

    /* Assemble the base data frame. */

    PROTECT(data = allocVector(VECSXP, nvars + nactualdots));
    PROTECT(names = allocVector(STRSXP, nvars + nactualdots));

    for (i = 0; i < nvars; i++) {
	SET_VECTOR_ELT(data, i, VECTOR_ELT(variables, i));
	SET_STRING_ELT(names, i, STRING_ELT(varnames, i));
    }
    for (i = 0,j = 0; i < ndots; i++) {
	const char *ss;
	if (VECTOR_ELT(dots, i) == R_NilValue) continue;
	ss = translateChar(STRING_ELT(dotnames, i));
	if(strlen(ss) + 3 > 256) error(_("overlong names in '%s'"), ss);
	snprintf(buf, 256, "(%s)", ss);
	SET_VECTOR_ELT(data, nvars + j, VECTOR_ELT(dots, i));
	SET_STRING_ELT(names, nvars + j,  mkChar(buf));
	j++;
    }
    setAttrib(data, R_NamesSymbol, names);
    UNPROTECT(2);

    /* Sanity checks to ensure that the the answer can become */
    /* a data frame.  Be deeply suspicious here! */

    nc = length(data);
    nr = 0;			/* -Wall */
    if (nc > 0) {
	for (i = 0; i < nc; i++) {
	    ans = VECTOR_ELT(data, i);
	    switch(TYPEOF(ans)) {
	    case LGLSXP:
	    case INTSXP:
	    case REALSXP:
	    case CPLXSXP:
	    case STRSXP:
	    case RAWSXP:
		break;
	    default:
		error(_("invalid type (%s) for variable '%s'"),
		      R_typeToChar(ans),
		      translateChar(STRING_ELT(names, i)));
	    }
	    nr = nrows(VECTOR_ELT(data, 0));
	    if (nrows(ans) != nr)
		error(_("variable lengths differ (found for '%s')"),
		      translateChar(STRING_ELT(names, i)));
	}
    } else nr = length(row_names);

    PROTECT(data);
    PROTECT(subset);

    /* Turn the data "list" into a "data.frame" */
    /* so that subsetting methods will work. */
    /* To do this we must attach "class"  and */
    /* "row.names" attributes */

    PROTECT(tmp = mkString("data.frame"));
    setAttrib(data, R_ClassSymbol, tmp);
    UNPROTECT(1);
    if (length(row_names) == nr && row_names != R_NilValue) {
	setAttrib(data, R_RowNamesSymbol, row_names);
    } else {
	/*
	PROTECT(row_names = allocVector(INTSXP, nr));
	for (i = 0; i < nr; i++) INTEGER(row_names)[i] = i+1; */
	PROTECT(row_names = allocVector(INTSXP, (nr > 0) ? 2 : 0));
	if (nr > 0) {
	    INTEGER(row_names)[0] = NA_INTEGER;
	    INTEGER(row_names)[1] = nr;
	}
	setAttrib(data, R_RowNamesSymbol, row_names);
	UNPROTECT(1);
    }

    /* Do the subsetting, if required. */
    /* Need to save and restore 'most' attributes */

    if (subset != R_NilValue) {
	PROTECT(tmp=install("[.data.frame"));
	PROTECT(tmp=LCONS(tmp,list4(data,subset,R_MissingArg,mkFalse())));
	data = eval(tmp, rho);
	UNPROTECT(2);
    }
    UNPROTECT(2);
    PROTECT(data);

    /* finally, we run na.action on the data frame */
    /* usually, this will be na.omit */

    if (na_action != R_NilValue) {
	/* some na.actions need this to distinguish responses from
	   explanatory variables */
	setAttrib(data, install("terms"), terms);
	if (isString(na_action) && length(na_action) > 0)
	    na_action = installTrChar(STRING_ELT(na_action, 0));
	PROTECT(na_action);
	PROTECT(tmp = lang2(na_action, data));
	ans = eval(tmp, rho);
	if (MAYBE_REFERENCED(ans))
	    ans = shallow_duplicate(ans);
	PROTECT(ans);
	if (!isNewList(ans) || length(ans) != length(data))
	    error(_("invalid result from na.action"));
	/* need to transfer _all but tsp and dim_ attributes, possibly lost
	   by subsetting in na.action. */
	/* But if data is unchanged, don't mess with it (PR#16436) */

	for ( i = length(ans) ; i-- ; )
	    if (VECTOR_ELT(data, i) != VECTOR_ELT(ans, i)) {
		if (MAYBE_REFERENCED(VECTOR_ELT(ans, i)))
		    SET_VECTOR_ELT(ans, i,
				   shallow_duplicate(VECTOR_ELT(ans, i)));
		copyMostAttribNoTs(VECTOR_ELT(data, i),VECTOR_ELT(ans, i));
	    }

	UNPROTECT(3);
    }
    else ans = data;
    UNPROTECT(1);
    PROTECT(ans);

    /* Finally, tack on a terms attribute
       Now done at R level.
       setAttrib(ans, install("terms"), terms); */
    UNPROTECT(1);
    vmaxset(vmax);
    return ans;
}


	/* The code below is related to model expansion */
	/* and is ultimately called by modelmatrix. */

static void firstfactor(double *x, int nrx, int ncx,
			double *c, int nrc, int ncc, int *v, int adj)
{
    double *cj, *xj;

    for (int j = 0; j < ncc; j++) {
	xj = &x[j * (R_xlen_t)nrx];
	cj = &c[j * (R_xlen_t)nrc];
	for (int i = 0; i < nrx; i++)
	    if(v[i] == NA_INTEGER) xj[i] = NA_REAL;
	    else xj[i] = cj[v[i]-1+adj];
    }
}

static void addfactor(double *x, int nrx, int ncx,
		      double *c, int nrc, int ncc, int *v, int adj)
{
    double *ck, *xj, *yj;

    for (int k = ncc - 1; k >= 0; k--) {
	for (int j = 0; j < ncx; j++) {
	    xj = &x[j * (R_xlen_t)nrx];
	    yj = &x[(k * (R_xlen_t)ncx + j)*nrx];
	    ck = &c[k * (R_xlen_t)nrc];
	    for (int i = 0; i < nrx; i++)
	    if(v[i] == NA_INTEGER) yj[i] = NA_REAL;
	    else yj[i] = ck[v[i]-1+adj] * xj[i];
	}
    }
}

static void firstvar(double *x, int nrx, int ncx, double *c, int nrc, int ncc)
{
    double *cj, *xj;

    for (int j = 0; j < ncc; j++) {
	xj = &x[j * (R_xlen_t)nrx];
	cj = &c[j * (R_xlen_t)nrc];
	for (int i = 0; i < nrx; i++)
	    xj[i] = cj[i];
    }
}

static void addvar(double *x, int nrx, int ncx, double *c, int nrc, int ncc)
{
    double *ck, *xj, *yj;

    for (int k = ncc - 1; k >= 0; k--) {
	for (int j = 0; j < ncx; j++) {
	    xj = &x[j * (R_xlen_t)nrx];
	    yj = &x[(k * (R_xlen_t)ncx + j)*nrx];
	    ck = &c[k * (R_xlen_t)nrc];
	    for (int i = 0; i < nrx; i++)
		yj[i] = ck[i] * xj[i];
	}
    }
}

#define BUFSIZE 4096

static char *AppendString(char *buf, const char *str)
{
    while (*str)
	*buf++ = *str++;
    *buf = '\0';
    return buf;
}

static char *AppendInteger(char *buf, int i)
{
    char str[32];
    snprintf(str, sizeof(str), "%d", i);
    return AppendString(buf, str);
}

static SEXP ColumnNames(SEXP x)
{
    SEXP dn = getAttrib(x, R_DimNamesSymbol);
    if (dn == R_NilValue || length(dn) < 2)
	return R_NilValue;
    else
	return VECTOR_ELT(dn, 1);
}

// called from R as  .Externals2(C_modelmatrix, t, data)
SEXP modelmatrix(SEXP call, SEXP op, SEXP args, SEXP rho)
{
    SEXP expr, factors, terms, vars, vnames, assign;
    SEXP xnames, tnames, rnames;
    SEXP count, contrast, contr1, contr2, nlevs, ordered, columns, x;
    SEXP variable, var_i;
    int fik, first, i, j, k, kk, ll, n, nc, nterms, nVar;
    int intrcept, jstart, jnext, risponse, indx, rhs_response;
    double dk, dnc;
    char buf[BUFSIZE]="\0";
    char *bufp;
    const char *addp;
    R_xlen_t nn;

    args = CDR(args);

    /* Get the "terms" structure and extract */
    /* the intercept and response attributes. */
    terms = CAR(args); // = 't' in R's calling code

    intrcept = asLogical(getAttrib(terms, install("intercept")));
    if (intrcept == NA_INTEGER)
	intrcept = 0;

    risponse = asLogical(getAttrib(terms, install("response")));
    if (risponse == NA_INTEGER)
	risponse = 0;

    /* Get the factor pattern matrix.  We duplicate this because */
    /* we may want to alter it if we are in the no-intercept case. */
    /* Note: the values of "nVar" and "nterms" are the REAL number of */
    /* variables in the model data frame and the number of model terms. */

    nVar = nterms = 0;		/* -Wall */
    PROTECT(factors = duplicate(getAttrib(terms, install("factors"))));
    if (length(factors) == 0) {
	/* if (intrcept == 0)
	   error("invalid model (zero parameters).");*/
	nVar = 1;
	nterms = 0;
    }
    else if (isInteger(factors) && isMatrix(factors)) {
	nVar = nrows(factors);
	nterms = ncols(factors);
    }
    else error(_("invalid '%s' argument"), "terms");

    /* Get the variable names from the factor matrix */

    vnames = getAttrib(factors, R_DimNamesSymbol);
    if (length(factors) > 0) {
	if (length(vnames) < 1 ||
	    (nVar - intrcept > 0 && !isString(VECTOR_ELT(vnames, 0))))
	    error(_("invalid '%s' argument"), "terms");
	vnames = VECTOR_ELT(vnames, 0);
    }

    /* Get the variables from the model frame.  First perform */
    /* elementary sanity checks.  Notes:  1) We need at least */
    /* one variable (lhs or rhs) to compute the number of cases. */
    /* 2) We don't type-check the response. */

    vars = CADR(args);
    if (!isNewList(vars) || length(vars) < nVar)
	error(_("invalid model frame"));
    if (length(vars) == 0)
	error(_("do not know how many cases"));

    nn = n = nrows(VECTOR_ELT(vars, 0));
    /* This could be generated, so need to protect it */
    PROTECT(rnames = getAttrib(vars, R_RowNamesSymbol));

    /* This section of the code checks the types of the variables
       in the model frame.  Note that it should really only check
       the variables if they appear in a term in the model.
       Because it does not, we need to allow other types here, as they
       might well occur on the LHS.
       The R code converts all character variables in the model frame to
       factors, so the only types that ought to be here are logical,
       integer (including factor), numeric and complex.
     */

    PROTECT(variable = allocVector(VECSXP, nVar));
    PROTECT(nlevs = allocVector(INTSXP, nVar));
    PROTECT(ordered = allocVector(LGLSXP, nVar));
    PROTECT(columns = allocVector(INTSXP, nVar));

    for (i = 0; i < nVar; i++) {
	var_i = SET_VECTOR_ELT(variable, i, VECTOR_ELT(vars, i));
	if (nrows(var_i) != n)
	    error(_("variable lengths differ (found for variable %d)"), i);
	if (isOrdered_int(var_i)) {
	    LOGICAL(ordered)[i] = 1;
	    if((INTEGER(nlevs)[i] = nlevels(var_i)) < 1)
		error(_("variable %d has no levels"), i+1);
	    /* will get updated later when contrasts are set */
	    INTEGER(columns)[i] = ncols(var_i);
	}
	else if (isUnordered_int(var_i)) {
	    LOGICAL(ordered)[i] = 0;
	    if((INTEGER(nlevs)[i] = nlevels(var_i)) < 1)
		error(_("variable %d has no levels"), i+1);
	    /* will get updated later when contrasts are set */
	    INTEGER(columns)[i] = ncols(var_i);
	}
	else if (isLogical(var_i)) {
	    LOGICAL(ordered)[i] = 0;
	    INTEGER(nlevs)[i] = 2;
	    INTEGER(columns)[i] = ncols(var_i);
	}
	else if (isNumeric(var_i)) {
	    SET_VECTOR_ELT(variable, i, coerceVector(var_i, REALSXP));
	    var_i = VECTOR_ELT(variable, i);
	    LOGICAL(ordered)[i] = 0;
	    INTEGER(nlevs)[i] = 0;
	    INTEGER(columns)[i] = ncols(var_i);
	}
	else {
	    LOGICAL(ordered)[i] = 0;
	    INTEGER(nlevs)[i] = 0;
	    INTEGER(columns)[i] = ncols(var_i);
	}
/*	else
	    error(_("invalid variable type for '%s'"),
	    CHAR(STRING_ELT(vnames, i))); */
    }

    /* If there is no intercept we look through the factor pattern */
    /* matrix and adjust the code for the first factor found so that */
    /* it will be coded by dummy variables rather than contrasts. */

    if (!intrcept) {
	for (j = 0; j < nterms; j++) {
	    for (i = risponse; i < nVar; i++) {
		if (INTEGER(nlevs)[i] > 1
		    && INTEGER(factors)[i + j * nVar] > 0) {
		    INTEGER(factors)[i + j * nVar] = 2;
		    goto alldone;
		}
	    }
	}
    }
 alldone:
    ;

    /* Compute the required contrast or dummy variable matrices. */
    /* We set up a symbolic expression to evaluate these, substituting */
    /* the required arguments at call time.  The calls have the following */
    /* form: (contrast.type nlevs contrasts) */

    PROTECT(contr1 = allocVector(VECSXP, nVar));
    PROTECT(contr2 = allocVector(VECSXP, nVar));

    PROTECT(expr = allocLang(3));
    SETCAR(expr, install("contrasts"));
    SETCADDR(expr, allocVector(LGLSXP, 1));

    /* FIXME: We need to allow a third argument to this function */
    /* which allows us to specify contrasts directly.  That argument */
    /* would be used here in exactly the same way as the below. */
    /* I.e. we would search the list of constrast specs before */
    /* we try the evaluation below. */

    for (i = 0; i < nVar; i++) {
	if (INTEGER(nlevs)[i]) {
	    k = 0;
	    for (j = 0; j < nterms; j++) {
		if (INTEGER(factors)[i + j * nVar] == 1)
		    k |= 1;
		else if (INTEGER(factors)[i + j * nVar] == 2)
		    k |= 2;
	    }
	    SETCADR(expr, VECTOR_ELT(variable, i));
	    if (k & 1) {
		LOGICAL(CADDR(expr))[0] = 1;
		SET_VECTOR_ELT(contr1, i, eval(expr, rho));
	    }
	    if (k & 2) {
		LOGICAL(CADDR(expr))[0] = 0;
		SET_VECTOR_ELT(contr2, i, eval(expr, rho));
	    }
	}
    }

    /* By convention, an rhs term identical to the response generates nothing
       in the model matrix (but interactions involving the response do). */

    rhs_response = -1;
    if (risponse > 0) /* there is a response specified */
	for (j = 0; j < nterms; j++)
	    if (INTEGER(factors)[risponse - 1 + j * nVar]) {
		for (i = 0, k = 0; i < nVar; i++)
		    k += INTEGER(factors)[i + j * nVar] > 0;
		if (k == 1) {
		    rhs_response = j;
		    break;
		}
	    }


    /* We now have everything needed to build the design matrix. */
    /* The first step is to compute the matrix size and to allocate it. */
    /* Note that "count" holds a count of how many columns there are */
    /* for each term in the model and "nc" gives the total column count. */

    PROTECT(count = allocVector(INTSXP, nterms));
    if (intrcept)
	dnc = 1;
    else
	dnc = 0;
    for (j = 0; j < nterms; j++) {
	if (j == rhs_response) {
	    warning(_("the response appeared on the right-hand side and was dropped"));
	    INTEGER(count)[j] = 0;  /* need this initialised */
	    continue;
	}
	dk = 1;	/* accumulate in a double to detect overflow */
	for (i = 0; i < nVar; i++) {
	    if (INTEGER(factors)[i + j * nVar]) {
		if (INTEGER(nlevs)[i]) {
		    switch(INTEGER(factors)[i + j * nVar]) {
		    case 1:
			dk *= ncols(VECTOR_ELT(contr1, i));
			break;
		    case 2:
			dk *= ncols(VECTOR_ELT(contr2, i));
			break;
		    }
		}
		else dk *= INTEGER(columns)[i];
	    }
	}
	if (dk > INT_MAX) error(_("term %d would require %.0g columns"), j+1, dk);
	INTEGER(count)[j] = (int) dk;
	dnc = dnc + dk;
    }
    if (dnc > INT_MAX) error(_("matrix would require %.0g columns"), dnc);
    nc = (int) dnc;

    /* Record which columns of the design matrix are associated */
    /* with which model terms. */

    PROTECT(assign = allocVector(INTSXP, nc));
    k = 0;
    if (intrcept) INTEGER(assign)[k++] = 0;
    for (j = 0; j < nterms; j++) {
	if(INTEGER(count)[j] <= 0)
	    warning(_("problem with term %d in model.matrix: no columns are assigned"),
		      j+1);
	for (i = 0; i < INTEGER(count)[j]; i++)
	    INTEGER(assign)[k++] = j+1;
    }


    /* Create column labels for the matrix columns. */

    PROTECT(xnames = allocVector(STRSXP, nc));


    /* Here we loop over the terms in the model and, within each */
    /* term, loop over the corresponding columns of the design */
    /* matrix, assembling the names. */

    /* FIXME : The body within these two loops should be embedded */
    /* in its own function. */

    k = 0;
    if (intrcept)
	SET_STRING_ELT(xnames, k++, mkChar("(Intercept)"));

    for (j = 0; j < nterms; j++) {
	if (j == rhs_response) continue;
	for (kk = 0; kk < INTEGER(count)[j]; kk++) {
	    first = 1;
	    indx = kk;
	    bufp = &buf[0];
	    for (i = 0; i < nVar; i++) {
		ll = INTEGER(factors)[i + j * nVar];
		if (ll) {
		    var_i = VECTOR_ELT(variable, i);
		    if (!first)
			bufp = AppendString(bufp, ":");
		    first = 0;
		    if (isFactor(var_i) || isLogical(var_i)) {
			if (ll == 1) {
			    x = ColumnNames(VECTOR_ELT(contr1, i));
			    ll = ncols(VECTOR_ELT(contr1, i));
			}
			else {
			    x = ColumnNames(VECTOR_ELT(contr2, i));
			    ll = ncols(VECTOR_ELT(contr2, i));
			}
			addp = translateChar(STRING_ELT(vnames, i));
			if(strlen(buf) + strlen(addp) < BUFSIZE)
			    bufp = AppendString(bufp, addp);
			else
			    warning(_("term names will be truncated"));
			if (x == R_NilValue) {
			    if(strlen(buf) + 10 < BUFSIZE)
				bufp = AppendInteger(bufp, indx % ll + 1);
			    else
				warning(_("term names will be truncated"));
			} else {
			    addp = translateChar(STRING_ELT(x, indx % ll));
			    if(strlen(buf) + strlen(addp) < BUFSIZE)
				bufp = AppendString(bufp, addp);
			    else
				warning(_("term names will be truncated"));
			}
		    } else if (isComplex(var_i)) {
			error(_("complex variables are not currently allowed in model matrices"));
		    } else if(isNumeric(var_i)) { /* numeric */
			x = ColumnNames(var_i);
			ll = ncols(var_i);
			addp = translateChar(STRING_ELT(vnames, i));
			if(strlen(buf) + strlen(addp) < BUFSIZE)
			    bufp = AppendString(bufp, addp);
			else
			    warning(_("term names will be truncated"));
			if (ll > 1) {
			    if (x == R_NilValue) {
				if(strlen(buf) + 10 < BUFSIZE)
				    bufp = AppendInteger(bufp, indx % ll + 1);
				else
				    warning(_("term names will be truncated"));
			    } else {
				addp = translateChar(STRING_ELT(x, indx % ll));
				if(strlen(buf) + strlen(addp) < BUFSIZE)
				    bufp = AppendString(bufp, addp);
				else
				    warning(_("term names will be truncated"));
			    }
			}
		    } else
			error(_("variables of type '%s' are not allowed in model matrices"),
			      R_typeToChar(var_i));
		    indx /= ll;
		}
	    }
	    SET_STRING_ELT(xnames, k++, mkChar(buf));
	}
    }

    /* Allocate and compute the design matrix. */

    PROTECT(x = allocMatrix(REALSXP, n, nc));
    double *rx = REAL(x);

#if defined(R_MEMORY_PROFILING) && defined(USE_RINTERNALS)
    // RTRACE and SET_RTRACE macros are only available with USE_RINTERNALS
    if (RTRACE(vars)){
       memtrace_report(vars, x);
       SET_RTRACE(x, 1);
    }
#endif

    /* a) Begin with a column of 1s for the intercept. */

    if ((jnext = jstart = intrcept) != 0)
	for (i = 0; i < n; i++)
	    rx[i] = 1.0;

    /* b) Now loop over the model terms */

    contrast = R_NilValue;	/* -Wall */
    for (k = 0; k < nterms; k++) {
	if (k == rhs_response) continue;
	for (i = 0; i < nVar; i++) {
	    if (INTEGER(columns)[i] == 0)
		continue;
	    var_i = VECTOR_ELT(variable, i);
#if defined(R_MEMORY_PROFILING) && defined(USE_RINTERNALS)
	    // RTRACE and SET_RTRACE macros are only available with
	    // USE_RINTERNALS
	    if (RTRACE(var_i)){
	       memtrace_report(var_i, x);
	       SET_RTRACE(x, 1);
	    }
#endif
	    fik = INTEGER(factors)[i + k * nVar];
	    if (fik) {
		switch(fik) {
		case 1:
		    contrast = coerceVector(VECTOR_ELT(contr1, i), REALSXP);
		    break;
		case 2:
		    contrast = coerceVector(VECTOR_ELT(contr2, i), REALSXP);
		    break;
		}
		PROTECT(contrast);
		if (jnext == jstart) {
		    if (INTEGER(nlevs)[i] > 0) {
			int adj = isLogical(var_i)?1:0;
			// avoid overflow of jstart * nn PR#15578
			firstfactor(&rx[jstart * nn], n, jnext - jstart,
				    REAL(contrast), nrows(contrast),
				    ncols(contrast), INTEGER(var_i), adj);
			jnext = jnext + ncols(contrast);
		    }
		    else {
			firstvar(&rx[jstart * nn], n, jnext - jstart,
				 REAL(var_i), n, ncols(var_i));
			jnext = jnext + ncols(var_i);
		    }
		}
		else {
		    if (INTEGER(nlevs)[i] > 0) {
			int adj = isLogical(var_i)?1:0;
			addfactor(&rx[jstart * nn], n, jnext - jstart,
				  REAL(contrast), nrows(contrast),
				  ncols(contrast), INTEGER(var_i), adj);
			jnext = jnext + (jnext - jstart)*(ncols(contrast) - 1);
		    }
		    else {
			addvar(&rx[jstart * nn], n, jnext - jstart,
			       REAL(var_i), n, ncols(var_i));
			jnext = jnext + (jnext - jstart) * (ncols(var_i) - 1);
		    }
		}
		UNPROTECT(1);
	    }
	}
	jstart = jnext;
    }
    PROTECT(tnames = allocVector(VECSXP, 2));
    SET_VECTOR_ELT(tnames, 0, rnames);
    SET_VECTOR_ELT(tnames, 1, xnames);
    setAttrib(x, R_DimNamesSymbol, tnames);
    setAttrib(x, install("assign"), assign);
    UNPROTECT(14);
    return x;
}
// modelmatrix()


/* updateform() :  Update a model formula by the replacement of "." templates.
   ---------------------------------------------------------------------------
 */
static SEXP tildeSymbol = NULL;
static SEXP plusSymbol  = NULL;
static SEXP minusSymbol = NULL;
static SEXP timesSymbol = NULL;
static SEXP slashSymbol = NULL;
static SEXP colonSymbol = NULL;
static SEXP powerSymbol = NULL;
static SEXP dotSymbol   = NULL;
static SEXP parenSymbol = NULL;
static SEXP inSymbol    = NULL;

static SEXP ExpandDots(SEXP object, SEXP value)
{
    SEXP op;

    if (TYPEOF(object) == SYMSXP) {
	if (object == dotSymbol)
	    object = duplicate(value);
	return object;
    }

    if (TYPEOF(object) == LANGSXP) {
	if (TYPEOF(value) == LANGSXP) op = CAR(value);
	else op = NULL;
	PROTECT(object);
	if (CAR(object) == plusSymbol) {
	    if (length(object) == 2) {
		SETCADR(object, ExpandDots(CADR(object), value));
	    }
	    else if (length(object) == 3) {
		SETCADR(object, ExpandDots(CADR(object), value));
		SETCADDR(object, ExpandDots(CADDR(object), value));
	    }
	    else goto badformula;
	}
	else if (CAR(object) == minusSymbol) {
	    if (length(object) == 2) {
		if (CADR(object) == dotSymbol &&
		   (op == plusSymbol || op == minusSymbol))
		    SETCADR(object, lang2(parenSymbol,
					  ExpandDots(CADR(object), value)));
		else
		    SETCADR(object, ExpandDots(CADR(object), value));
	    }
	    else if (length(object) == 3) {
		if (CADR(object) == dotSymbol &&
		   (op == plusSymbol || op == minusSymbol))
		    SETCADR(object, lang2(parenSymbol,
					  ExpandDots(CADR(object), value)));
		else
		    SETCADR(object, ExpandDots(CADR(object), value));
		if (CADDR(object) == dotSymbol &&
		   (op == plusSymbol || op == minusSymbol))
		    SETCADDR(object, lang2(parenSymbol,
					   ExpandDots(CADDR(object), value)));
		else
		    SETCADDR(object, ExpandDots(CADDR(object), value));
	    }
	    else goto badformula;
	}
	else if (CAR(object) == timesSymbol || CAR(object) == slashSymbol) {
	    if (length(object) != 3)
		goto badformula;
	    if (CADR(object) == dotSymbol &&
	       (op == plusSymbol || op == minusSymbol))
		SETCADR(object, lang2(parenSymbol,
				      ExpandDots(CADR(object), value)));
	    else
		SETCADR(object, ExpandDots(CADR(object), value));
	    if (CADDR(object) == dotSymbol &&
	       (op == plusSymbol || op == minusSymbol))
		SETCADDR(object, lang2(parenSymbol,
				       ExpandDots(CADDR(object), value)));
	    else
		SETCADDR(object, ExpandDots(CADDR(object), value));
	}
	else if (CAR(object) == colonSymbol) {
	    if (length(object) != 3)
		goto badformula;
	    if (CADR(object) == dotSymbol &&
	       (op == plusSymbol || op == minusSymbol ||
		op == timesSymbol || op == slashSymbol))
		SETCADR(object, lang2(parenSymbol,
				      ExpandDots(CADR(object), value)));
	    else
		SETCADR(object, ExpandDots(CADR(object), value));
	    if (CADDR(object) == dotSymbol &&
	       (op == plusSymbol || op == minusSymbol))
		SETCADDR(object, lang2(parenSymbol,
				       ExpandDots(CADDR(object), value)));
	    else
		SETCADDR(object, ExpandDots(CADDR(object), value));
	}
	else if (CAR(object) == powerSymbol) {
	    if (length(object) != 3)
		goto badformula;
	    if (CADR(object) == dotSymbol &&
	       (op == plusSymbol || op == minusSymbol ||
		op == timesSymbol || op == slashSymbol ||
		op == colonSymbol))
		SETCADR(object, lang2(parenSymbol,
				      ExpandDots(CADR(object), value)));
	    else
		SETCADR(object, ExpandDots(CADR(object), value));
	    if (CADDR(object) == dotSymbol &&
	       (op == plusSymbol || op == minusSymbol))
		SETCADDR(object, lang2(parenSymbol,
				       ExpandDots(CADDR(object), value)));
	    else
		SETCADDR(object, ExpandDots(CADDR(object), value));
	}
	else {
	    op = object;
	    while(op != R_NilValue) {
		SETCAR(op, ExpandDots(CAR(op), value));
		op = CDR(op);
	    }
	}
	UNPROTECT(1);
	return object;
    }
    else return object;

 badformula:
    error(_("invalid formula in 'update'"));
    return R_NilValue; /*NOTREACHED*/
}

SEXP updateform(SEXP old, SEXP new)
{
    SEXP _new;

    /* Always fetch these values rather than trying */
    /* to remember them between calls.  The overhead */
    /* is minimal and we don't have to worry about */
    /* intervening dump/restore problems. */

    tildeSymbol = install("~");
    plusSymbol  = install("+");
    minusSymbol = install("-");
    timesSymbol = install("*");
    slashSymbol = install("/");
    colonSymbol = install(":");
    powerSymbol = install("^");
    dotSymbol   = install(".");
    parenSymbol = install("(");
    inSymbol = install("%in%");

    /* We must duplicate here because the */
    /* formulae may be part of the parse tree */
    /* and we don't want to modify it. */

    PROTECT(_new = duplicate(new));

    /* Check of new and old formulae. */
    if (TYPEOF(old) != LANGSXP ||
       (TYPEOF(_new) != LANGSXP && CAR(old) != tildeSymbol) ||
       CAR(_new) != tildeSymbol)
	error(_("formula expected"));

    if (length(old) == 3) {
	SEXP lhs = CADR(old);
	SEXP rhs = CADDR(old);
	/* We now check that new formula has a valid lhs.
	   If it doesn't, we add one and set it to the rhs of the old
	   formula. */
	if (length(_new) == 2)
	    SETCDR(_new, CONS(lhs, CDR(_new)));
	/* Now we check the left and right sides of the new formula
	   and substitute the correct value for any "." templates.
	   We must parenthesize the rhs or we might upset arity and
	   precedence. */
	PROTECT(rhs);
	SETCADR(_new, ExpandDots(CADR(_new), lhs));
	SETCADDR(_new, ExpandDots(CADDR(_new), rhs));
	UNPROTECT(1);
    }
    else {
	/* The old formula had no lhs, so we only expand the rhs of the
	   new formula. */
	SEXP rhs = CADR(old);
	if (length(_new) == 3)
	    SETCADDR(_new, ExpandDots(CADDR(_new), rhs));
	else
	    SETCADR(_new, ExpandDots(CADR(_new), rhs));
    }

    /* It might be overkill to zero the */
    /* the attribute list of the returned */
    /* value, but it can't hurt. */

    SET_ATTRIB(_new, R_NilValue);
    SET_OBJECT(_new, 0);
    SEXP DotEnvSymbol = install(".Environment");
    setAttrib(_new, DotEnvSymbol, getAttrib(old, DotEnvSymbol));

    UNPROTECT(1);
    return _new;
}


/*==========================================================================*/

/* termsform() & auxiliaries: Workhorse to turn model formula into terms() object
   ------------------------------------------------------------------------------
 */
#ifdef DEBUG_terms
# include <Print.h>
/* can use  printVector(SEXP x, int indx, int quote)
 *	    ~~~~~~~~~~~		    ^^^^      ^^^^^
 * to print R vector x[]; if(indx) print indices; if(quote) quote strings
 * Print a "pair"List (with all *vector* components): */
static void printPList(SEXP form)
{
    R_xlen_t n = 0;
    SEXP cl;
    for (cl = form, n = 0; cl != R_NilValue; cl = CDR(cl), n++) {
	Rprintf(" L[%d] (|L[.]|=%d): ", n+1, length(CAR(cl)));
	printVector(CAR(cl), 0, 0);
    }
    return;
}
static bool trace_GetBit = true;
static bool trace_InstallVar = true;
static int n_xVars; // nesting level: use for indentation
#endif

// word size in *bits* :
#define WORDSIZE (8*sizeof(int))

//  Global "State" Variables for terms() computation :
//  -------------------------------------------------

static bool
    intercept,		//  have intercept term in the model
    parity,		//  true if "positive parity"
    response;		//  response term in the model
static int nwords;		/* # of words (ints) to code a term */
static SEXP varlist;		/* variables in the model */
static PROTECT_INDEX vpi;
static SEXP framenames;		/* variables names for specified frame */
static bool haveDot;	/* does RHS of formula contain `.'? */

static int isZeroOne(SEXP x)
{
    if (!isNumeric(x)) return 0;
    return (asReal(x) == 0.0 || asReal(x) == 1.0);
}

static int isZero(SEXP x)
{
    if (!isNumeric(x)) return 0;
    return asReal(x) == 0.0;
}

static int isOne(SEXP x)
{
    if (!isNumeric(x)) return 0;
    return asReal(x) == 1.0;
}


/* MatchVar determines whether two ``variables'' are */
/* identical.  Expressions are identical if they have */
/* the same list structure and their atoms are identical. */
/* This is just EQUAL from lisp. */

/* See src/main/memory.c: probably could be simplified to pointer comparison */
static int Seql2(SEXP a, SEXP b)
{
    if (a == b) return 1;
    if (IS_CACHED(a) && IS_CACHED(b) && ENC_KNOWN(a) == ENC_KNOWN(b))
	return 0;
    else {
    	const void *vmax = vmaxget();
    	int result = !strcmp(translateCharUTF8(a), translateCharUTF8(b));
    	vmaxset(vmax); /* discard any memory used by translateCharUTF8 */
    	return result;
    }
}

static int MatchVar(SEXP var1, SEXP var2)
{
    /* For expedience, and sanity... */
    if ( var1 == var2 )
	return 1;
    /* Handle Nulls */
    if (isNull(var1) && isNull(var2))
	return 1;
    if (isNull(var1) || isNull(var2))
	return 0;
    /* Non-atomic objects - compare CARs & CDRs (and TAGs:  PR#17235) */
    if ((isList(var1) || isLanguage(var1)) &&
	(isList(var2) || isLanguage(var2)))
	return MatchVar(CAR(var1), CAR(var2)) &&
	       MatchVar(CDR(var1), CDR(var2)) &&
	       MatchVar(TAG(var1), TAG(var2));
    /* Symbols */
    if (isSymbol(var1) && isSymbol(var2))
	return (var1 == var2);
    /* Literal Numerics (incl 'NA', 'NaN') */
    if (isNumeric(var1) && isNumeric(var2)) {
	double t1 = asReal(var1), t2 = asReal(var2);
	return ISNAN(t1) ? ISNAN(t2) : (t1 == t2);
    }
    /* Literal Strings */
    if (isString(var1) && isString(var2))
	return Seql2(asChar(var1), asChar(var2));
    /* Nothing else matches */
    return 0;
}


/* InstallVar locates a ''variable'' in the model variable list
   adding it to the global varlist if not found. */

/* FIXME?  This is used in two "almost orthogonal" situations:
 * 1) Install variable in varlist -- index is *not* used by caller:
 *    InstallVar(.) called by ExtractVars() always w/o assigning result.
 * 2) Find the index of 'var' in 'varlist' (but do not change varlist,
 *    as now *all* variables should have been assigned by ExtractVars());
 *    called as  'whichBit = InstallVar(.)' *only* by AllocTermSetBit1()
 */
static int InstallVar(SEXP var)
{
    SEXP v;
    /* Check that variable is legitimate */
    if (!isSymbol(var) && !isLanguage(var) && !isZeroOne(var))
	error(_("invalid term in model formula"));
    /* Lookup/Install it */
    int indx = 0;
    for (v = varlist; CDR(v) != R_NilValue; v = CDR(v)) {
	indx++;
	if (MatchVar(var, CADR(v)))
	    return indx;
    }
#ifdef DEBUG_terms
    if(trace_InstallVar)
	Rprintf("InstallVar(%s): adding it to 'varlist' and return indx+1 = %d\n",
		CHAR(STRING_ELT(deparse1line(var, 0), 0)), indx + 1);
#endif
    SETCDR(v, CONS(var, R_NilValue));
    return indx + 1;
}


/* If there is a dotsxp being expanded then we need to see
   whether any of the variables in the data frame match with
   the variable on the lhs. If so they shouldn't be included
   in the factors */

static void CheckRHS(SEXP v)
{
    while ((isList(v) || isLanguage(v)) && v != R_NilValue) {
	CheckRHS(CAR(v));
	v = CDR(v);
    }
    if (isSymbol(v)) {
	for (int i = 0; i < length(framenames); i++) {
	    SEXP s = installTrChar(STRING_ELT(framenames, i));
	    if (v == s) {
		SEXP t = allocVector(STRSXP, length(framenames) - 1);
		for (int j = 0; j < length(t); j++) {
		    if (j < i)
			SET_STRING_ELT(t, j, STRING_ELT(framenames, j));
		    else
			SET_STRING_ELT(t, j, STRING_ELT(framenames, j+1));
		}
		REPROTECT(framenames = t, vpi);
	    }
	}
    }
}


/* ExtractVars() recursively extracts the variables in a model formula.
 * ------------- It calls InstallVar() to do the installation.
 * The code takes care of unary  '+' and '-' .  No checks are made
 * of the other ``binary'' operators.  Maybe there should be some.

 * NB: logic here is partly "repeated" in   EncodeVars()  --->> keep in sync !!
*/
static void ExtractVars(SEXP formula)
{
#ifdef DEBUG_terms
    // for(int j=0; j < n_xVars; j++) Rprintf("  ");
    // indentation by (2 * n_xVars)
    Rprintf("%*d ExtractVars(%s): ", 2*n_xVars, n_xVars,
	    CHAR(STRING_ELT(deparse1line(formula, 0), 0)));
    n_xVars++; // nesting level: use for indentation (by 2):
    int my_n_x = n_xVars; // so we can restore n_xVars before leaving

#  define Prt_xtrVars(_S_) Rprintf(" case '%s'\n", _S_)
#  define Return  n_xVars = my_n_x; return
#else
#  define Prt_xtrVars(_S_)
#  define Return  return
#endif

    if (isNull(formula) || isZeroOne(formula)) {
	Prt_xtrVars("Null or ZeroOne");
	Return;
    }
    if (isSymbol(formula)) {
	if (formula == dotSymbol) haveDot = true;
	Prt_xtrVars(haveDot ? "isSym(<Dot>)" : "isSymbol()");
	    if (haveDot && framenames != R_NilValue) {
		// install variables of the data frame:
		for (int i = 0; i < length(framenames); i++) {
		    SEXP v = installTrChar(STRING_ELT(framenames, i));
		    if (!MatchVar(v, CADR(varlist))) InstallVar(v);
		}
	    } else
		InstallVar(formula);
	Return;
    }
    if (isLanguage(formula)) {
	if (CAR(formula) == tildeSymbol) {
	    if (response)
		error(_("invalid model formula")); // more than one '~'
	    if (isNull(CDDR(formula))) {
		Prt_xtrVars("isLanguage, tilde, *not* response");
		response = false;
		ExtractVars(CADR(formula));
	    }
	    else {
		Prt_xtrVars("isLanguage, tilde, *response*");
		response = true;
		InstallVar(CADR(formula));
		ExtractVars(CADDR(formula));
	    }
	    Return;
	}
	if (CAR(formula) == plusSymbol) { // '+'
	    int len = length(formula);
	    Prt_xtrVars("isLanguage, '+'");
	    if (len > 1)
		ExtractVars(CADR(formula));
	    if (len > 2) // binary
		ExtractVars(CADDR(formula));
	    Return;
	}
	if (CAR(formula) == colonSymbol) {
	    Prt_xtrVars("isLanguage, ':'");
	    ExtractVars(CADR(formula));
	    ExtractVars(CADDR(formula));
	    Return;
	}
	if (CAR(formula) == powerSymbol) {
	    Prt_xtrVars("isLanguage, '^'");
	    if (!isNumeric(CADDR(formula)))
		error(_("invalid power in formula"));
	    ExtractVars(CADR(formula));
	    Return;
	}
	if (CAR(formula) == timesSymbol) {
	    Prt_xtrVars("isLanguage, '*'");
	    ExtractVars(CADR(formula));
	    ExtractVars(CADDR(formula));
	    Return;
	}
	if (CAR(formula) == inSymbol) {
	    Prt_xtrVars("isLanguage, '%in%'");
	    ExtractVars(CADR(formula));
	    ExtractVars(CADDR(formula));
	    Return;
	}
	if (CAR(formula) == slashSymbol) {
	    Prt_xtrVars("isLanguage, '/'");
	    ExtractVars(CADR(formula));
	    ExtractVars(CADDR(formula));
	    Return;
	}
	if (CAR(formula) == minusSymbol) { // '-'
	    Prt_xtrVars("isLanguage, '-'");
	    int len = length(formula);
	    if (len == 2) { // unary
		ExtractVars(CADR(formula));
	    }
	    else {
		ExtractVars(CADR(formula));
		ExtractVars(CADDR(formula));
	    }
	    Return;
	}
	if (CAR(formula) == parenSymbol) {
	    Prt_xtrVars("isLanguage, '('");
	    ExtractVars(CADR(formula));
	    Return;
	}
	// all other calls:
	Prt_xtrVars("_otherwise_");
#ifdef DEBUG_terms
	Rprintf(" .. {%d} ExtractVars(f): installing formula f='%s'\n",
		n_xVars,
		CHAR(STRING_ELT(deparse1line(formula, 0), 0)));
#endif
	InstallVar(formula);
	Return;
    }
    error(_("invalid model formula in ExtractVars"));
}


/* AllocTerm allocates an integer array for bit string representation
 * of a model term and initializes to __no bit set__ */

static SEXP AllocTerm(void) // (<global> nwords)
{
    SEXP term = allocVector(INTSXP, nwords); // caller must PROTECT
    if (nwords)
	memset(INTEGER(term), 0, nwords * sizeof(int));
    return term;
}


/* SetBit sets bit ``whichBit'' to value ``value''
   in the bit string representation of a term. */

static void SetBit(SEXP term, int whichBit, int value)
{
    int
	word = (whichBit - 1) / WORDSIZE,
	offset = (- whichBit) % WORDSIZE;
#ifdef DEBUG_terms
    Rprintf("SetBit(term, which=%3d, value=%d): |term|=%d, word= %d, offset= %2d\n",
	    whichBit, value, length(term), word, offset);
#endif
    if (value)
	((unsigned *) INTEGER(term))[word] |=  ((unsigned) 1 << offset);
    else
	((unsigned *) INTEGER(term))[word] &= ~((unsigned) 1 << offset);
}

/* 0.   Install var (if needed)
 * 1a.  Check if nwords is large enough for 'whichBit'
 * 1b.  If not, increment nwords
 * 2.  term = AllocTerm();
 * 3.  SetBit(term, whichBit, 1);
 */
static SEXP AllocTermSetBit1(SEXP var) { // NB: caller must PROTECT
    int whichBit = InstallVar(var);
    if (nwords < (whichBit - 1)/WORDSIZE + 1)
	error("AllocT..Bit1(%s): Need to increment nwords to %d. Should not happen!\n",
		CHAR(STRING_ELT(deparse1line(var, 0), 0)),
		nwords+1);
    SEXP term = AllocTerm();
    SetBit(term, whichBit, 1);
    return term;
}


/* GetBit gets bit ``whichBit'' from the */
/* bit string representation of a term. */

static int GetBit(SEXP term, int whichBit)
{
    int
	word = (whichBit - 1) / WORDSIZE,
	offset = (- whichBit) % WORDSIZE,
	word_off = INTEGER(term)[word] >> offset;
#ifdef DEBUG_terms
    if(trace_GetBit) {
	Rprintf("GetBit(term,%3d): |term|=%2d, word=%d, offset= %2d --> bit= %d\n",
		whichBit, length(term), word, offset,
		word_off & 1);
    }
#endif
    return word_off & 1;
}


/* OrBits computes a new (bit string) term */
/* which contains the logical OR of the bits */
/* in ``term1'' and ``term2''. */

static SEXP OrBits(SEXP term1, SEXP term2)
{
    SEXP term = AllocTerm();
    for (int i = 0; i < nwords; i++)
	INTEGER(term)[i] = INTEGER(term1)[i] | INTEGER(term2)[i];
    return term;
}


// BitCount counts the number of ``on'' bits in a term
static int BitCount(SEXP term, int nvar)
{
    int sum = 0;
#ifdef DEBUG_terms
    Rprintf("BitCount(*, nvar=%d): ", nvar);
#endif
    for (int i = 1; i <= nvar; i++)
	sum += GetBit(term, i);
#ifdef DEBUG_terms
    Rprintf("  end{BitCount}\n");
#endif
    return sum;
}


/* TermZero tests whether a (bit string) term is zero */

static int TermZero(SEXP term)
{
    for (int i = 0; i < nwords; i++)
        if (INTEGER(term)[i] != 0)
	    return 0;
    return 1;
}


/* TermEqual tests two (bit string) terms for equality. */

static int TermEqual(SEXP term1, SEXP term2)
{
    for (int i = 0; i < nwords; i++)
        if (INTEGER(term1)[i] != INTEGER(term2)[i])
            return 0;
    return 1;
}


/* StripTerm strips the specified term from the given list.
   This mutates the list (but the caller replaces it by 'root').
   Only called from  DeleteTerms() i.e.,  " left - right "
*/

static SEXP StripTerm(SEXP term, SEXP list)
{
    SEXP root = R_NilValue, prev = R_NilValue;
    if (TermZero(term))
	intercept = false;
    while (list != R_NilValue) {
	if (TermEqual(term, CAR(list))) {
	    if (prev != R_NilValue)
		SETCDR(prev, CDR(list));
	} else {
	    if (root == R_NilValue)
		root = list;
	    prev = list;
	}
	list = CDR(list);
    }
    return root;
}


/* TrimRepeats removes duplicates of (bit string) terms in a model formula.
   Also drops zero terms. */

static SEXP TrimRepeats(SEXP list)
{
    // Drop zero terms at the start of the list.
    while (list != R_NilValue && TermZero(CAR(list))) {
	list = CDR(list);
    }
    if (list == R_NilValue || CDR(list) == R_NilValue)
	return list;

    PROTECT(list);
    // Find out which terms are duplicates.
    SEXP all_terms = PROTECT(PairToVectorList(list)),
	duplicate_sexp = PROTECT(duplicated(all_terms, FALSE));
    int i_p1 = 1, *is_duplicate = LOGICAL(duplicate_sexp);

    // Remove the zero terms and duplicates from the list.
    for (SEXP current = list; CDR(current) != R_NilValue; i_p1++) {
	SEXP next = CDR(current);
	if (is_duplicate[i_p1] || TermZero(CAR(next))) {
	    // Remove the node from the list.
	    SETCDR(current, CDR(next));
	} else {
	    current = next;
	}
    }

    UNPROTECT(3);
    return list;
}



/*==========================================================================*/

/* Model Formula Manipulation */
/* These functions take a numerically coded */
/* formula and fully expand it. */

static SEXP EncodeVars(SEXP);/* defined below */


/* PlusTerms expands ``left'' and ``right'' and */
/* concatenates their terms (removing duplicates). */

static SEXP PlusTerms(SEXP left, SEXP right)
{
    PROTECT(left = EncodeVars(left));
    right = EncodeVars(right);
    UNPROTECT(1);
    return TrimRepeats(listAppend(left, right));
}


/* InteractTerms expands ``left'' and ``right'' */
/* and forms a new list of terms containing the bitwise */
/* OR of each term in ``left'' with each term in ``right''. */

static SEXP InteractTerms(SEXP left, SEXP right)
{
    SEXP term, l, r, t;
    PROTECT(left = EncodeVars(left));
    PROTECT(right = EncodeVars(right));
    PROTECT(term = allocList(length(left) * length(right)));
    t = term;
    for (l = left; l != R_NilValue; l = CDR(l))
	for (r = right; r != R_NilValue; r = CDR(r)) {
	    SETCAR(t, OrBits(CAR(l), CAR(r)));
	    t = CDR(t);
	}
    UNPROTECT(3);
    return TrimRepeats(term);
}


/* CrossTerms expands ``left'' and ``right'' */
/* and forms the ``cross'' of the list of terms.  */
/* Duplicates are removed. */

static SEXP CrossTerms(SEXP left, SEXP right)
{
    SEXP term, l, r, t;
    PROTECT(left = EncodeVars(left));
    PROTECT(right = EncodeVars(right));
    PROTECT(term = allocList(length(left) * length(right)));
    t = term;
    for (l = left; l != R_NilValue; l = CDR(l))
	for (r = right; r != R_NilValue; r = CDR(r)) {
	    SETCAR(t, OrBits(CAR(l), CAR(r)));
	    t = CDR(t);
	}
    UNPROTECT(3);
    listAppend(right, term);
    listAppend(left, right);
    return TrimRepeats(left);
}


/* PowerTerms expands the ``left'' form and then */
/* raises it to the power specified by the right term. */
/* Allocation here is wasteful, but so what ... */

static SEXP PowerTerms(SEXP left, SEXP right)
{
    SEXP term, l, r, t;
    int i, ip;
    ip = asInteger(right);
    if (ip==NA_INTEGER || ip <= 1)
	error(_("invalid power in formula"));
    term = R_NilValue;		/* -Wall */
    PROTECT(left = EncodeVars(left));
    right = left;
    for (i=1; i < ip; i++)  {
	PROTECT(right);
	PROTECT(term = allocList(length(left) * length(right)));
	t = term;
	for (l = left; l != R_NilValue; l = CDR(l))
	    for (r = right; r != R_NilValue; r = CDR(r)) {
		SETCAR(t, OrBits(CAR(l), CAR(r)));
		t = CDR(t);
	    }
	UNPROTECT(2);
	right = TrimRepeats(term);
    }
    UNPROTECT(1);
    return term;
}


/* InTerms expands ``left'' and ``right'' and */
/* forms the ``nest'' of the the left in the */
/* interaction of the right */

static SEXP InTerms(SEXP left, SEXP right)
{
    PROTECT(left = EncodeVars(left));
    PROTECT(right = EncodeVars(right));
    SEXP t, term = PROTECT(AllocTerm());
    int *term_ = INTEGER(term);
    /* Bitwise or of all terms on right */
    for (t = right; t != R_NilValue; t = CDR(t)) {
	for (int i = 0; i < nwords; i++)
	    term_[i] = term_[i] | INTEGER(CAR(t))[i];
    }
    /* Now bitwise or with each term on the left */
    for (t = left; t != R_NilValue; t = CDR(t))
	for (int i = 0; i < nwords; i++)
	    INTEGER(CAR(t))[i] = term_[i] | INTEGER(CAR(t))[i];
    UNPROTECT(3);
    return TrimRepeats(left);
}

/* NestTerms expands ``left'' and ``right'' */
/* and forms the ``nest'' of the list of terms.  */
/* Duplicates are removed. */

static SEXP NestTerms(SEXP left, SEXP right)
{
    PROTECT(left  = EncodeVars(left));
    PROTECT(right = EncodeVars(right));
    SEXP t, term = PROTECT(AllocTerm());
    int *term_ = INTEGER(term);
    /* Bitwise or of all terms on left */
    for (t = left; t != R_NilValue; t = CDR(t)) {
	for (int i = 0; i < nwords; i++)
	    term_[i] = term_[i] | INTEGER(CAR(t))[i];
    }
    /* Now bitwise or with each term on the right */
    for (t = right; t != R_NilValue; t = CDR(t))
	for (int i = 0; i < nwords; i++)
	    INTEGER(CAR(t))[i] = term_[i] | INTEGER(CAR(t))[i];
    UNPROTECT(3);
    listAppend(left, right);
    return TrimRepeats(left);
}


/* DeleteTerms expands ``left'' and ``right'' */
/* and then removes any terms which appear in */
/* ``right'' from ``left''. */

static SEXP DeleteTerms(SEXP left, SEXP right)
{
    PROTECT(left  = EncodeVars(left));	parity = !parity;
    PROTECT(right = EncodeVars(right)); parity = !parity;
    for (SEXP t = right; t != R_NilValue; t = CDR(t))
	left = StripTerm(CAR(t), left);
    UNPROTECT(2);
    return left;
}


/* EncodeVars() performs  model expansion and bit string encoding.
 * This is the real workhorse of model expansion in terms.formula() == termsform()
 *
 * Returns a (pair)list of length 'nterm' containing integer vectors [1:nwords],
 */
static SEXP EncodeVars(SEXP formula)
{
    if (isNull(formula))	return R_NilValue;
    else if (isOne(formula)) {
	intercept = parity;	return R_NilValue;
    }
    else if (isZero(formula)) {
	intercept = !parity;	return R_NilValue;
    }
    // else :
    SEXP term;
    if (isSymbol(formula)) {
	if (formula == dotSymbol && framenames != R_NilValue) {
	    /* prior to 1.7.0 this made term.labels in reverse order. */
	    SEXP r = R_NilValue, v = R_NilValue; /* -Wall */
	    if (!LENGTH(framenames)) return r;
	    const void *vmax = vmaxget();
	    for (int i = 0; i < LENGTH(framenames); i++) {
		/* change in 1.6.0 do not use duplicated names */
		const char *c = translateChar(STRING_ELT(framenames, i));
		for(int j = 0; j < i; j++)
		    if(!strcmp(c, translateChar(STRING_ELT(framenames, j))))
			error(_("duplicated name '%s' in data frame using '.'"),
			      c);
		term = AllocTermSetBit1(install(c));
#ifdef DEBUG_terms
		Rprintf(".. in 'isSymbol(<dotSymbol>), after AllocT...1()\n");
#endif
		if(i == 0) PROTECT(v = r = cons(term, R_NilValue));
		else {SETCDR(v, CONS(term, R_NilValue)); v = CDR(v);}
	    }
	    UNPROTECT(1);
	    vmaxset(vmax);
	    return r;
	}
	else {
	    term = AllocTermSetBit1(formula);
#ifdef DEBUG_terms
	    Rprintf(".. in 'isSymbol(%s) [regular], after AllocT...1()\n",
		    CHAR(STRING_ELT(deparse1line(formula, 0), 0)));
#endif
	    return CONS(term, R_NilValue);
	}
    }
    if (isLanguage(formula)) {
	if (CAR(formula) == tildeSymbol) {
	    if (isNull(CDDR(formula)))
		return EncodeVars(CADR(formula));
	    else
		return EncodeVars(CADDR(formula));
	}
	if (CAR(formula) == plusSymbol) {
	    int len = length(formula);
	    if (len == 2) // unary '+'
		return EncodeVars(CADR(formula));
	    else
		return PlusTerms(CADR(formula), CADDR(formula));
	}
	if (CAR(formula) == colonSymbol) {
	    return InteractTerms(CADR(formula), CADDR(formula));
	}
	if (CAR(formula) == timesSymbol) {
	    return CrossTerms(CADR(formula), CADDR(formula));
	}
	if (CAR(formula) == inSymbol) {
	    return InTerms(CADR(formula), CADDR(formula));
	}
	if (CAR(formula) == slashSymbol) {
	    return NestTerms(CADR(formula), CADDR(formula));
	}
	if (CAR(formula) == powerSymbol) {
	    return PowerTerms(CADR(formula), CADDR(formula));
	}
	if (CAR(formula) == minusSymbol) {
	    int len = length(formula);
	    if (len == 2) // unary '-'
		return DeleteTerms(R_NilValue, CADR(formula));
	    return DeleteTerms(CADR(formula), CADDR(formula));
	}
	if (CAR(formula) == parenSymbol) {
	    return EncodeVars(CADR(formula));
	}
	term = AllocTermSetBit1(formula);
#ifdef DEBUG_terms
	Rprintf(".. before returning from EncodeVars(%s), after AllocT...1()\n",
		CHAR(STRING_ELT(deparse1line(formula, 0), 0)));
#endif
	return CONS(term, R_NilValue);
    }
    error(_("invalid model formula in EncodeVars"));
    return R_NilValue;/*NOTREACHED*/
}


/* TermCode decides on the encoding of a model term. */
/* Returns 1 if variable ``whichBit'' in ``thisTerm'' */
/* is to be encoded by contrasts and 2 if it is to be */
/* encoded by dummy variables.  This is decided using */
/* the heuristic described in Statistical Models in S, page 38. */

// called only in one place, in "step 4"
static int TermCode(SEXP termlist, SEXP thisterm, int whichbit, SEXP term)
{
    int *term_ = INTEGER(term),
	*th_t  = INTEGER(CAR(thisterm));
    for (int i = 0; i < nwords; i++)
	term_[i] = th_t[i];

    /* Eliminate factor ``whichbit'' */
    SetBit(term, whichbit, 0);

    /* Search preceding terms for a match */
    /* Zero is a possibility - it is a special case */

    bool allzero = true;
    for (int i = 0; i < nwords; i++) {
	if (term_[i]) {
	    allzero = false; break;
	}
    }
    if (allzero)
	return 1;

    for (SEXP t = termlist; t != thisterm; t = CDR(t)) {
	allzero = true;
	int *ct = INTEGER(CAR(t));
	for (int i = 0; i < nwords; i++)
	    if (term_[i] & ~ct[i]) {
		allzero = false; break;
	    }
	if (allzero)
	    return 1;
    }
    return 2;
}


/* Internal code for the ``terms'' function */
/* The value is a formula with an assortment */
/* of useful attributes. */

// R's  terms.formula(x, specials, data, keep.order, allowDotAsName)   in ../R/models.R
SEXP termsform(SEXP args)
{
    args = CDR(args); // (called via .External)

    /* Always fetch these values rather than trying to remember them
       between calls.  The overhead is minimal. */

    tildeSymbol = install("~");
    plusSymbol  = install("+");
    minusSymbol = install("-");
    timesSymbol = install("*");
    slashSymbol = install("/");
    colonSymbol = install(":");
    powerSymbol = install("^");
    dotSymbol   = install(".");
    parenSymbol = install("(");
    inSymbol = install("%in%");

    /* Do we have a model formula? <==> Check for unary or binary ~ */

    if (!isLanguage(CAR(args)) ||
	CAR(CAR(args)) != tildeSymbol ||
	(length(CAR(args)) != 2 && length(CAR(args)) != 3))
	error(_("argument is not a valid model"));

    haveDot = false;

    SEXP ans = PROTECT(duplicate(CAR(args)));

    /* The formula will be returned, modified if haveDot becomes true */

    SEXP specials = CADR(args);
    if(length(specials) && !isString(specials))
	error(_("'specials' must be NULL or a character vector"));
    SEXP
	a = CDDR(args),
	/* We use data to get the value to substitute for "." in formulae */
	data = CAR(a);
    a = CDR(a);
    if (isNull(data) || isEnvironment(data))
	framenames = R_NilValue;
    else if (isDataFrame(data))
	framenames = getAttrib(data, R_NamesSymbol);
    else
	error(_("'data' argument is of the wrong type"));
    PROTECT_WITH_INDEX(framenames, &vpi);

    bool hadFrameNames = false;
    if (framenames != R_NilValue) {
	if(length(framenames)) hadFrameNames = true;
	if (length(CAR(args)) == 3)
	    CheckRHS(CADR(CAR(args)));
    }

    /* Preserve term order? */
    int aLog = asLogical(CAR(a));
    bool keepOrder = (aLog == NA_LOGICAL) ? 0 : (bool) aLog;

    a = CDR(a);
    aLog = asLogical(CAR(a));
    bool allowDot = (aLog == NA_LOGICAL) ? 0 : (bool) aLog;

    // a := attributes(<answer>)
    a = allocList((specials == R_NilValue) ? 8 : 9);
    SET_ATTRIB(ans, a);

    /* Step 1: Determine the ``variables'' in the model :
     * ------ Here we create a call of the form list(...).
     * You can evaluate it to get the model variables or use substitute
     * and then pull the result apart to get the variable names. */

    intercept = true;
    parity = true;
    response = false;
    PROTECT(varlist = LCONS(install("list"), R_NilValue));
#ifdef DEBUG_terms
    n_xVars = 0; // the nesting level of ExtractVars()
    Rprintf("termsform(): calling ExtractVars(CAR(args), 1), where\n CAR(args)='%s'\n",
	    CHAR(STRING_ELT(deparse1line(CAR(args), 0), 0)));
#endif
    ExtractVars(CAR(args));
    //^^^^^^^^^ fills the 'varlist' = attr(<terms>, "variables")
    UNPROTECT(1);
    SETCAR(a, varlist);
    SET_TAG(a, install("variables"));
    a = CDR(a);

    int nvar = length(varlist) - 1; /* Number of variables in the formula */

    /* in allocating words need to allow for intercept term (PR#15735) */
    nwords = nvar/WORDSIZE + 1; // global; used & incremented in EncodeVars()
#ifdef DEBUG_terms
    Rprintf(" .. after ExtractVars(): ini. nvar = %d, nwords = %d;%sCalling EncodeVars():%s",
	    nvar, nwords,
	    "\n------------------\n",
	    "\n------------------\n");
#endif

    /* Step 2: Recode the model terms in binary form
     * ------  and at the same time, expand the model formula. */

    /* FIXME: this includes 'specials' in the model */
    /* There perhaps needs to be a an extra pass */
    /* through the model to delete any terms which */
    /* contain specials.  Actually, specials should */
    /* only enter additively so this should also be */
    /* checked and abort forced if not. */

    /* BDR 2002-01-29: S does include specials, so code may rely on this */

    /* FIXME: this is also the point where nesting needs to be taken care of. */

    SEXP formula = PROTECT(EncodeVars(CAR(args)));
    //                     ^^^^^^^^^^
    if(length(varlist) != nvar + 1) {
	warning(_("'varlist' has changed (from nvar=%d) to new %d after EncodeVars() -- should no longer happen!"),
		nvar, length(varlist) - 1);
	nvar = length(varlist) - 1;
    }
#ifdef DEBUG_terms
    Rprintf("after EncodeVars(): final (nvar,nwords) = (%d,%d); formula 'L' =\n", nvar, nwords);
    // Show the content of formula  [[ Do we have integer(nwords) or just int.(1) ? ]]
    printPList(formula);
#endif

    /* Step 2a: Compute variable names */

    SEXP v, call, varnames = PROTECT(allocVector(STRSXP, nvar));
    {
	R_xlen_t i;
	for (v = CDR(varlist), i = 0; v != R_NilValue; v = CDR(v))
	    SET_STRING_ELT(varnames, i++,
			   STRING_ELT(deparse1line(CAR(v), 0), 0));
    }
#ifdef DEBUG_terms
    Rprintf("after Step 2a: variable names:\n"); printVector(varnames, 1, 1);
#endif

    /* Step 2b: Find and remove any offset(s) */

    /* first see if any of the variables are offsets */
    R_xlen_t k = 0;
    for (R_xlen_t l = (R_xlen_t)response; l < nvar; l++)
	if (!strncmp(CHAR(STRING_ELT(varnames, l)), "offset(", 7)) k++;
    if (k > 0) {
#ifdef DEBUG_terms
	Rprintf(" step 2b: found k=%ld offset(.)s\n", k);
#endif
	bool foundOne = false; /* has there been a non-offset term? */
	/* allocate the "offsets" attribute */
	SETCAR(a, v = allocVector(INTSXP, k));
	// FIXME: using R_xlen_t above but int here, as we assign to INTEGER(v)
	for (int l = response, k = 0; l < nvar; l++)
	    if (!strncmp(CHAR(STRING_ELT(varnames, l)), "offset(", 7))
		INTEGER(v)[k++] = l + 1;
	SET_TAG(a, install("offset"));
	a = CDR(a);
	/* now remove offset terms from the formula */
	call = formula; /* call is to be the previous term once one is found */
	while (1) {
	    SEXP thisterm = foundOne ? CDR(call) : call;
	    bool have_offset = false;
#ifdef DEBUG_terms
	    Rprintf(" while (1) : foundOne = %d; length(thisterm) =%d; ",
		   foundOne, length(thisterm));
#endif
	    if(length(thisterm) == 0) break;
	    for (int i = 1; i <= nvar; i++)
		if (GetBit(CAR(thisterm), i) &&
		    !strncmp(CHAR(STRING_ELT(varnames, i-1)), "offset(", 7)) {
		    have_offset = true;
#ifdef DEBUG_terms
		    Rprintf(" i=%d: have_offset, ", i);
#endif
		    break;
		}
	    if (have_offset) {
		if (!foundOne) call = formula = CDR(formula);
		else SETCDR(call, CDR(thisterm));
	    } else {
		if (foundOne) call = CDR(call);
		else foundOne = true;
	    }
	}
    }
    int nterm = length(formula); /* = #{model terms} */
#ifdef DEBUG_terms
    Rprintf("after step 2: k=%ld, nterm:= |formula| = %d\n", k, nterm);
    // fails: 'formula' is "pairlist", not "vector" !!
    // Rprintf("formula[1..nterm=%d] = ", nterm); printVector(formula, 1, 0);

    /* Step 3: Reorder the model terms by BitCount, otherwise
     * ------  preserving their order. */

    Rprintf(" .. step 3 .. reorder model terms by BitCount():\n");
#endif
    SEXP    ord = PROTECT(allocVector(INTSXP, nterm)),
	pattern = PROTECT(allocVector(VECSXP, nterm));
    {
	SEXP sCounts = PROTECT(allocVector(INTSXP, nterm));
	int bitmax = 0,
	    *iord = INTEGER(ord),
	    *counts = INTEGER(sCounts);
	R_xlen_t n;
	for (call = formula, n = 0; call != R_NilValue; call = CDR(call), n++) {
	    SET_VECTOR_ELT(pattern, n, CAR(call));
	    counts[n] = BitCount(CAR(call), nvar);
#ifdef DEBUG_terms
	    int lc = length(CAR(call));
	    Rprintf("  -> BitCount(CAR(call),nv) =:counts[n=%ld]=%2d, from bitpat.in int[%s%d]): ",
		    n+1, counts[n], (lc==1)?"":"1:", lc);
	    printVector(CAR(call), 0, 0);
#endif
	}
	for (n = 0; n < nterm; n++)
	    if(counts[n] > bitmax) bitmax = counts[n];
#ifdef DEBUG_terms
	Rprintf("step 3 (part I): counts[1..nterm]: "); printVector(sCounts, 1, 0);
	Rprintf("     bitmax = max(counts[]) = %d\n", bitmax);
#endif

	if(keepOrder) {
	    for (n = 0; n < nterm; n++)
		iord[n] = counts[n];
	} else {
	    call = formula;
	    int m = 0;
	    for (int i = 0; i <= bitmax; i++) /* can order 0 occur? */
		for (n = 0; n < nterm; n++)
		    if (counts[n] == i) {
			SETCAR(call, VECTOR_ELT(pattern, n));
			call = CDR(call);
			iord[m++] = i;
		    }
	}
	UNPROTECT(2);
    }
#ifdef DEBUG_terms
    Rprintf("after step 3: ord[1:nterm]: "); printVector(ord, 1, 0);
    Rprintf("--=--\n .. step 4: Create \"factors\" pattern matrix:\n");
#endif

    /* Step 4: Compute the factor pattern for the model. */
    /* 0 - the variable does not appear in this term. */
    /* 1 - code the variable by contrasts in this term. */
    /* 2 - code the variable by indicators in this term. */

    if (nterm > 0) {
	SETCAR(a, pattern = allocMatrix(INTSXP, nvar, nterm));
	int *pattn = INTEGER(pattern);
	for (R_xlen_t i = 0; i < ((R_xlen_t) nterm) * nvar; i++)
	    pattn[i] = 0;
	SEXP term = PROTECT(AllocTerm());
	R_xlen_t n_n = -1; // n = 0;  ==>  n_n = -1 + n*nvar = -1
	for (call = formula; call != R_NilValue; call = CDR(call)) {
#ifdef DEBUG_terms
	    Rprintf("  st.4: (bitpattern in int) term: "); printVector(CAR(call), 0,0);
#endif
	    for (int i = 1; i <= nvar; i++) {
		if (GetBit(CAR(call), i)) {
#ifdef DEBUG_terms
		    Rprintf(" var i=%d --> TermCode(., c., i, t.) {bit[i] := 0}\n", i);
#endif
		    pattn[i+n_n] = TermCode(formula, call, i, term);
#ifdef DEBUG_terms
		    Rprintf(" => pattn[%d,%d] = %d\n", (n_n+1)/nvar, i, pattn[i+n_n]);
#endif
		}
	    }
	    n_n += nvar; // n++ ==>  n_n = -1 + n*nvar
	}
	UNPROTECT(1);
    }
    else {
	SETCAR(a, pattern = allocVector(INTSXP,0));
    }
    SET_TAG(a, install("factors"));
    a = CDR(a);

#ifdef DEBUG_terms
    Rprintf(".. after step 4: filled \"factors\" matrix (nvar x nterm) = (%d x %d)\n",
	    nvar, nterm);
    Rprintf("--=--\n .. step 5 .. computing term labels \"term.labels\":\n");
#endif

    /* Step 5: Compute term labels */

    SEXP termlabs = PROTECT(allocVector(STRSXP, nterm));
    R_xlen_t n = 0;
    for (call = formula; call != R_NilValue; call = CDR(call)) {
	R_xlen_t l = 0;
#ifdef DEBUG_terms
	Rprintf("  st.5: (bitpattern in int) term: "); printVector(CAR(call), 0, 0);
	Rprintf("  ----  {not tracing GetBit() when determining 'cbuf' length}\n");
	trace_GetBit = false; // *not* tracing below
#endif
	for (int i = 1; i <= nvar; i++) {
	    if (GetBit(CAR(call), i)) {
		if (l > 0)
		    l += 1;
		l += (int) strlen(CHAR(STRING_ELT(varnames, i - 1)));
	    }
	}
#ifdef DEBUG_terms
	trace_GetBit = true; // back to tracing
	Rprintf("     --> cbuf length %d (+1 for final \\0)\n", l);
#endif
	char cbuf[l+1];
	cbuf[0] = '\0';
	l = 0;
	for (int i = 1; i <= nvar; i++) {
	    if (GetBit(CAR(call), i)) {
		if (l > 0)
		    strcat(cbuf, ":");
		strcat(cbuf, CHAR(STRING_ELT(varnames, i - 1)));
		l++;
	    }
	}
	SET_STRING_ELT(termlabs, n, mkChar(cbuf));
	n++;
#ifdef DEBUG_terms
	Rprintf("  -> term.labels[%ld]: '%s'\n", n, cbuf);
#endif
    }

#ifdef DEBUG_terms
    Rprintf(".. finished step 5: term.labels: "); printVector(termlabs, 1, /* quote */ 1);
#endif

    if (nterm > 0) { // dimnames("factors") <- ...
	PROTECT(v = allocVector(VECSXP, 2));
	SET_VECTOR_ELT(v, 0, varnames);
	SET_VECTOR_ELT(v, 1, termlabs);
	setAttrib(pattern, R_DimNamesSymbol, v);
	UNPROTECT(1);
    }
    SETCAR(a, termlabs);
    UNPROTECT(1); // termlabs
    SET_TAG(a, install("term.labels"));
    a = CDR(a);

    /* If there are specials stick them in here */

    if (specials != R_NilValue) {
	int j; // R_xlen_t? but  j < i  which is int
	const void *vmax = vmaxget();
	int i = length(specials);
	SEXP t, t_ = PROTECT(allocList(i));
	for (j = 0, t = t_; j < i; j++, t = CDR(t)) {
	    const char *ss = translateChar(STRING_ELT(specials, j));
	    SET_TAG(t, install(ss));
	    SETCAR(t, allocVector(INTSXP, 0));
	    R_xlen_t k = 0;
	    for (v = CDR(varlist); v != R_NilValue; v = CDR(v)) {
		call = CAR(v);
		if (TYPEOF(call) == LANGSXP && TYPEOF(CAR(call)) == SYMSXP &&
		    !strcmp(CHAR(PRINTNAME(CAR(call))), ss))
		    k++;
	    }
	    if (k > 0) {
		SETCAR(t, allocVector(INTSXP, k));
		k = 0;
		int l = 1;
		for (v = CDR(varlist); v != R_NilValue; v = CDR(v)) {
			call = CAR(v);
			if (TYPEOF(call) == LANGSXP && TYPEOF(CAR(call)) == SYMSXP &&
			    !strcmp(CHAR(PRINTNAME(CAR(call))), ss))
				INTEGER(CAR(t))[k++] = l;
			l++;
		}
	    }
	    else SETCAR(t, R_NilValue);
	}
	SETCAR(a, t_);
	SET_TAG(a, install("specials"));
	a = CDR(a);
	UNPROTECT(1);
	vmaxset(vmax);
    }


    /* Step 6: Fix up the formula by substituting for dot, which should be
       the framenames joined by + */

    if (haveDot) {
	if(length(framenames)) {
	    SEXP rhs;
	    PROTECT_INDEX ind;
	    PROTECT_WITH_INDEX(rhs = installTrChar(STRING_ELT(framenames, 0)),
			       &ind);
	    for (R_xlen_t i = 1; i < LENGTH(framenames); i++) {
		REPROTECT(rhs = lang3(plusSymbol, rhs,
				      installTrChar(STRING_ELT(framenames, i))),
			  ind);
	    }
	    if (!isNull(CADDR(ans)))
		SETCADDR(ans, ExpandDots(CADDR(ans), rhs));
	    else
		SETCADR(ans, ExpandDots(CADR(ans), rhs));
	    UNPROTECT(1);
	} else if(!allowDot && !hadFrameNames) {
	    error(_("'.' in formula and no 'data' argument"));
	}
    }

    SETCAR(a, allocVector(INTSXP, nterm));
    {
	R_xlen_t n = 0;
	int *ia = INTEGER(CAR(a)), *iord = INTEGER(ord);
	for (call = formula; call != R_NilValue; call = CDR(call), n++)
	    ia[n] = iord[n];
    }

    SET_TAG(a, install("order"));
    a = CDR(a);

    SETCAR(a, ScalarInteger((int)intercept));
    SET_TAG(a, install("intercept"));
    a = CDR(a);

    SETCAR(a, ScalarInteger((int)response));
    SET_TAG(a, install("response"));
    a = CDR(a);

    SETCAR(a, mkString("terms"));
    SET_TAG(a, R_ClassSymbol);
    SET_OBJECT(ans, 1);

    SETCDR(a, R_NilValue);  /* truncate if necessary */

    UNPROTECT(5);
    return ans;
}
// termsform()
