text: /*
   * Copyright 2004-2017 Cray Inc.
   * Other additional copyright holders may be indicated within.
   * 
   * The entirety of this work is licensed under the Apache License,
   * Version 2.0 (the "License"); you may not use this file except
   * in compliance with the License.
   * 
   * You may obtain a copy of the License at
   * 
   *     http://www.apache.org/licenses/LICENSE-2.0
   * 
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  
  /*****************************************************************************
  
  This code is based on beautify.cpp from the alpha version of the ZPL
  compiler, 06/08/2004.  Changes were made to utilize the Chapel
  compiler's file and string utilities and to make use of its vector
  class rather than ZPL's generic_stack class.
  
  The original code is:
  
  Copyright (c) 2004 University of Washington 
  
  Permission is hereby granted, free of charge, to any person obtaining
  a copy of this software and associated documentation files (the
  "Software"), to deal in the Software without restriction, including
  without limitation the rights to use, copy, modify, merge, publish,
  distribute, sublicense, and/or sell copies of the Software, and to
  permit persons to whom the Software is furnished to do so, subject to
  the following conditions:
  
  The above copyright notice and this permission notice shall be
  included in all copies or substantial portions of the Software.
  
  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  
  *****************************************************************************/
  
  #include <cctype>
  #include <cstdlib>
  #include <cstring>
  #include "chpl.h"
  #include "beautify.h"
  #include "files.h"
  #include "misc.h"
  #include "stringutil.h"
  #include "mysystem.h"
  
  #define ZLINEFORMAT "#line %d \"%s\"\n"
  #define ZLINEINPUT "/* ZLINE: "
  #define ZLINEINPUTFORMAT "/* ZLINE: %d %s"
  #define ZLINEINPUTLEN strlen(ZLINEINPUT)
  #define ZCMAXMAPSIZE 4096
  
  #define FALSE 0
  #define TRUE 1
  #define max(x,y) ((x)>(y) ? x : y)
  
  static std::vector<int> justification;
  static int depth = 0;
  static int parens = 0;
  static int justify = 0;
  static int inquote = FALSE;
  static int intick = FALSE;
  static int escaped = FALSE;
  
  static void update_state(char *line) {
    int oldstuff; /* characters up to the last open paren */
    int stuff;            /* characters since last open paren */
    char *cp;
    int oldoldstuff;
  
    oldstuff = justify;
    stuff = 0;
    cp = line;
    escaped = FALSE;
  
    while (cp[0] != '\0') {
      switch (*cp) {
      case '\\': 
        escaped = !escaped;
        stuff++;
        break;
      case '\'':
        stuff++;
        if (!escaped && !inquote) {
          intick = !intick;
        }
        escaped = FALSE;
        break;
      case '\"':
        stuff++;
        if (!escaped) {
          inquote = !inquote;
        }
        escaped = FALSE;
        break;
      case '{':
        if (!inquote && !intick) {
          if (oldstuff == -1) {
            INT_FATAL("Unbalanced curly braces:\n\t%s",line);
          }
          oldstuff = 0;   /* assume all parens have been closed */
          stuff = 0;
          depth++;
        } else {
          stuff++;
        }
        escaped = FALSE;
        break;
      case '}':
        if (!inquote && !intick) {
          if (oldstuff == -1) {
            INT_FATAL("Unbalanced curly braces:\n\t%s",line);
          }
          oldstuff = 0;   /* assume all parens have been closed */
          stuff = 0;
          depth--;
        } else {
          stuff++;
        }
        escaped = FALSE;
        break;
      case '(':
        if (!inquote && !intick) {
          justification.push_back(oldstuff);
          if (oldstuff == -1) {
            INT_FATAL("Unbalanced parentheses:\n\t%s",line);
          }
          oldoldstuff = oldstuff;
          oldstuff = oldoldstuff + stuff + 1;
          stuff = 0;
          parens++;
        } else {
          stuff++;
        }
        escaped = FALSE;
        break;
      case ')':
        if (!inquote && !intick) {
          oldstuff = justification.back();
          justification.pop_back();
          stuff = 0;
          parens--;
        } else {
          stuff++;
        }
        escaped = FALSE;
        break;
      default:
        stuff++;
        escaped = FALSE;
        break;
      }
      cp++;
    }
  
    if ((parens == 0) || (oldstuff == -1)) {
      justify = 0;
    } else {
      justify = oldstuff;
    }
  
  }
  
  void beautify(fileinfo* origfile) {
    char line[1024];
    char *cp;
    FILE *inputfile;
    FILE *outputfile;
    const char* command;
    int i;
    int new_line, indent;
    int zline;
    char zname[1024];
    int old_depth;
    char* znptr;
    fileinfo* tmpfile;
  
    mysystem(astr("# beautifying ", origfile->filename),
             "generating comment for --print-commands option");
  
    zline = -1;
    
    openfile(origfile, "r");
    inputfile = origfile->fptr;
  
    tmpfile = openTmpFile("beautify.tmp");
    outputfile = tmpfile->fptr;
  
    new_line = TRUE;
    indent = TRUE;
    while (fgets(line, sizeof(line), inputfile)) {
      cp = line;
      if (new_line == TRUE) {
        indent = TRUE;
  
        while (isspace((int)(*cp)))               /* remove leading spaces */
          cp++;
  
        /* record zpl/c source line map info */
        if (!strncmp(cp, ZLINEINPUT, ZLINEINPUTLEN)) {
          sscanf(cp, ZLINEINPUTFORMAT, &zline, zname);
          znptr = strrchr(zname,'/');
          if (znptr != NULL) {
            // We can't use strcpy here because the source
            // and destination strings can overlap.
            char *src = znptr+1;
            char *dst = zname;
            size_t len = strlen(src) + 1; // also copy null
            memmove(dst, src, len);
          }
          continue;
        }
      }
      else {
        indent = FALSE;
      }
  
      if (cp[0] != '\0') {
        if (zline >= 0 && new_line == TRUE) {
          int zlineP = zline;
          if (zline == 0) {
            zlineP = 1;  // #line 0 ... is illegal in C11
            if (!strcmp(zname, "<internal>")) //always internal when zline==0 ?
              zline = -1; //do not print #line until we see ZLINEINPUT again
          }
          fprintf(outputfile, ZLINEFORMAT, zlineP, zname);
        }
      }
  
      if (cp[strlen(cp)-1] == '\n')
        new_line = TRUE;
      else {
        new_line = FALSE;
      }
  
      switch (cp[0]) {
      case '\0':
        fprintf(outputfile, "\n");        /* output blank line */
          break;
      case '}':
        /*** assumes there is no open curly braces follow on the line ***/
        old_depth = depth;
        update_state(cp);         /* update state first */
        for (i = 0; i < 2*(old_depth-1)+justify; i++) {
          fprintf(outputfile, " ");
        }
        fprintf(outputfile, "%s", cp);    /* output line */
        break;
      default:
        if ((indent == TRUE) && (cp[0] != '#'))
          for (i = (strncmp(cp, "case", 4) == 0) ? 1 : 0; i < 2*depth+justify; i++)
            fprintf(outputfile, " ");
        fprintf(outputfile, "%s", cp);  /* output line */
  
        update_state(cp);         /* update state */
      }
    }
  
    closefile(tmpfile);
    closefile(origfile);
  
    command = astr("mv ", tmpfile->pathname, " ", origfile->pathname);
    mysystem(command, "moving beautified file");
    
    if (justification.size() != 0) {
      INT_FATAL( "Parentheses or curly braces are not balanced "
                 "in codegen for %s.", origfile->pathname);
    }
  
  }
  