1 /* $OpenBSD: for.c,v 1.47 2017/12/05 17:47:09 millert Exp $ */ 2 /* $NetBSD: for.c,v 1.4 1996/11/06 17:59:05 christos Exp $ */ 3 4 /* 5 * Copyright (c) 1999 Marc Espie. 6 * 7 * Extensive code modifications for the OpenBSD project. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * 2. Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in the 16 * documentation and/or other materials provided with the distribution. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE OPENBSD PROJECT AND CONTRIBUTORS 19 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OPENBSD 22 * PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29 */ 30 31 /* 32 * Copyright (c) 1992, The Regents of the University of California. 33 * All rights reserved. 34 * 35 * Redistribution and use in source and binary forms, with or without 36 * modification, are permitted provided that the following conditions 37 * are met: 38 * 1. Redistributions of source code must retain the above copyright 39 * notice, this list of conditions and the following disclaimer. 40 * 2. Redistributions in binary form must reproduce the above copyright 41 * notice, this list of conditions and the following disclaimer in the 42 * documentation and/or other materials provided with the distribution. 43 * 3. Neither the name of the University nor the names of its contributors 44 * may be used to endorse or promote products derived from this software 45 * without specific prior written permission. 46 * 47 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 48 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 49 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 50 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 51 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 52 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 53 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 54 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 55 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 56 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 57 * SUCH DAMAGE. 58 */ 59 60 #include <assert.h> 61 #include <ctype.h> 62 #include <stddef.h> 63 #include <stdio.h> 64 #include <stdlib.h> 65 #include <string.h> 66 #include "config.h" 67 #include "defines.h" 68 #include "buf.h" 69 #include "for.h" 70 #include "lst.h" 71 #include "error.h" 72 #include "var.h" 73 #include "lowparse.h" 74 #include "str.h" 75 #include "memory.h" 76 77 /* 78 * For statements are of the form: 79 * 80 * .for <variable> [variable...] in <varlist> 81 * ... 82 * .endfor 83 * 84 * The trick is to look for the matching .end inside .for loops. 85 * To do that, we keep track of the nesting level of .for loops 86 * and matching .endfor statements, accumulating all statements between 87 * the initial .for loop and the matching .endfor, 88 * then we evaluate the .for loop for each variable in the varlist. 89 */ 90 91 /* State of a for loop. */ 92 struct For_ { 93 char *text; /* Unexpanded text */ 94 LIST vars; /* List of variables */ 95 LstNode var; /* Current var */ 96 int nvars; /* Total number of vars */ 97 LIST lst; /* List of items */ 98 size_t guess; /* Estimated expansion size */ 99 BUFFER buf; /* Accumulating text */ 100 unsigned long lineno; /* Line number at start of loop */ 101 unsigned long level; /* Nesting level */ 102 bool freeold; 103 }; 104 105 /* ForExec(value, handle); 106 * Expands next variable in loop sequence described by handle to value. */ 107 static void ForExec(void *, void *); 108 109 /* n = build_words_list(lst, s); 110 * Cuts string into words, pushes words into list, in reverse order, 111 * because Parse_FromString works as a stack. 112 * Returns the number of words. */ 113 static unsigned long build_words_list(Lst, const char *); 114 115 static unsigned long 116 build_words_list(Lst lst, const char *s) 117 { 118 const char *end, *wrd; 119 unsigned long n; 120 121 n = 0; 122 end = s; 123 124 while ((wrd = iterate_words(&end)) != NULL) { 125 Lst_AtFront(lst, escape_dupi(wrd, end, "\"'")); 126 n++; 127 } 128 return n; 129 } 130 131 For * 132 For_Eval(const char *line) 133 { 134 const char *ptr = line; 135 const char *wrd; 136 char *sub; 137 const char *endVar; 138 For *arg; 139 unsigned long n; 140 141 while (ISSPACE(*ptr)) 142 ptr++; 143 144 /* Parse loop. */ 145 146 arg = emalloc(sizeof(*arg)); 147 arg->nvars = 0; 148 Lst_Init(&arg->vars); 149 150 for (;;) { 151 /* Grab the variables. */ 152 for (wrd = ptr; *ptr && !ISSPACE(*ptr); ptr++) 153 continue; 154 if (ptr - wrd == 0) { 155 Parse_Error(PARSE_FATAL, "Syntax error in for"); 156 return 0; 157 } 158 endVar = ptr; 159 if (*ptr) { 160 ptr++; 161 while (ISSPACE(*ptr)) 162 ptr++; 163 } 164 /* End of variable list ? */ 165 if (endVar - wrd == 2 && wrd[0] == 'i' && wrd[1] == 'n') 166 break; 167 Lst_AtEnd(&arg->vars, Var_NewLoopVar(wrd, endVar)); 168 arg->nvars++; 169 } 170 if (arg->nvars == 0) { 171 Parse_Error(PARSE_FATAL, "Missing variable in for"); 172 return 0; 173 } 174 175 /* Make a list with the remaining words. */ 176 sub = Var_Subst(ptr, NULL, false); 177 if (DEBUG(FOR)) { 178 LstNode ln; 179 (void)fprintf(stderr, "For: Iterator "); 180 for (ln = Lst_First(&arg->vars); ln != NULL; ln = Lst_Adv(ln)) 181 (void)fprintf(stderr, "%s ", 182 Var_LoopVarName(Lst_Datum(ln))); 183 (void)fprintf(stderr, "List %s\n", sub); 184 } 185 186 Lst_Init(&arg->lst); 187 n = build_words_list(&arg->lst, sub); 188 free(sub); 189 if (arg->nvars != 1 && n % arg->nvars != 0) { 190 LstNode ln; 191 192 Parse_Error(PARSE_FATAL, "Wrong number of items in for loop"); 193 (void)fprintf(stderr, "%lu items for %d variables:", 194 n, arg->nvars); 195 for (ln = Lst_First(&arg->lst); ln != NULL; ln = Lst_Adv(ln)) { 196 char *p = Lst_Datum(ln); 197 198 (void)fprintf(stderr, " %s", p); 199 } 200 (void)fprintf(stderr, "\n"); 201 return 0; 202 } 203 arg->lineno = Parse_Getlineno(); 204 arg->level = 1; 205 Buf_Init(&arg->buf, 0); 206 207 return arg; 208 } 209 210 211 bool 212 For_Accumulate(For *arg, const char *line) 213 { 214 const char *ptr = line; 215 216 assert(arg->level > 0); 217 218 if (*ptr == '.') { 219 220 for (ptr++; ISSPACE(*ptr); ptr++) 221 continue; 222 223 if (strncmp(ptr, "endfor", 6) == 0 && 224 (ISSPACE(ptr[6]) || !ptr[6])) { 225 if (DEBUG(FOR)) 226 (void)fprintf(stderr, "For: end for %lu\n", 227 arg->level); 228 /* If matching endfor, don't add line to buffer. */ 229 if (--arg->level == 0) 230 return false; 231 } 232 else if (strncmp(ptr, "for", 3) == 0 && 233 ISSPACE(ptr[3])) { 234 arg->level++; 235 if (DEBUG(FOR)) 236 (void)fprintf(stderr, "For: new loop %lu\n", 237 arg->level); 238 } 239 } 240 Buf_AddString(&arg->buf, line); 241 Buf_AddChar(&arg->buf, '\n'); 242 return true; 243 } 244 245 246 #define GUESS_EXPANSION 32 247 static void 248 ForExec(void *valuep, void *argp) 249 { 250 char *value = valuep; 251 For *arg = argp; 252 BUFFER buf; 253 254 /* Parse_FromString pushes stuff back, so we need to go over vars in 255 reverse. */ 256 if (arg->var == NULL) { 257 arg->var = Lst_Last(&arg->vars); 258 arg->text = Buf_Retrieve(&arg->buf); 259 arg->freeold = false; 260 } 261 262 if (DEBUG(FOR)) 263 (void)fprintf(stderr, "--- %s = %s\n", 264 Var_LoopVarName(Lst_Datum(arg->var)), value); 265 Buf_Init(&buf, arg->guess); 266 Var_SubstVar(&buf, arg->text, Lst_Datum(arg->var), value); 267 if (arg->freeold) 268 free(arg->text); 269 arg->text = Buf_Retrieve(&buf); 270 arg->freeold = true; 271 arg->var = Lst_Rev(arg->var); 272 if (arg->var == NULL) 273 Parse_FromString(arg->text, arg->lineno); 274 } 275 276 277 void 278 For_Run(For *arg) 279 { 280 arg->text = Buf_Retrieve(&arg->buf); 281 arg->guess = Buf_Size(&arg->buf) + GUESS_EXPANSION; 282 283 arg->var = NULL; 284 Lst_ForEach(&arg->lst, ForExec, arg); 285 Buf_Destroy(&arg->buf); 286 Lst_Destroy(&arg->vars, (SimpleProc)Var_DeleteLoopVar); 287 Lst_Destroy(&arg->lst, (SimpleProc)free); 288 free(arg); 289 } 290