Carp/core/carp_pattern.h

/*
** {======================================================
** PATTERN MATCHING adapted from lstrlib.c of Lua 5.3.4
** Copyright (C) 1994-2017 Lua.org, PUC-Rio; see LUA_LICENSE
** =======================================================
*/
#include <ctype.h>
#include <stdarg.h>
#include <stddef.h>

#include <carp_string.h>

#if !defined(CARP_MAXCAPTURES)
#define CARP_MAXCAPTURES 16
#endif


/* macro to 'unsign' a character */
#define uchar(c) ((unsigned char)(c))


/*
** Some sizes are better limited to fit in 'int', but must also fit in
** 'size_t'. (We assume that Carp’s integer cannot be smaller than 'int'.)
*/
#define MAX_SIZET ((size_t)(~(size_t)0))

#define MAXSIZE (sizeof(size_t) < sizeof(int) ? MAX_SIZET : (size_t)(INT_MAX))


#define CAP_UNFINISHED (-1)
#define CAP_NONE (-2)

typedef struct PatternMatchState {
  string src_init;  /* init of source string */
  string src_end;  /* end ('\0') of source string */
  string p_end;  /* end ('\0') of pattern */
  int matchdepth;  /* control for recursive depth (to avoid C stack overflow) */
  unsigned char level;  /* total number of captures (finished or unfinished) */
  struct {
    string init;
    ptrdiff_t len;
  } capture[CARP_MAXCAPTURES];
} PatternMatchState;

/* recursive function */
string Pattern_internal_match(PatternMatchState *ms, string s, string p);

/* maximum recursion depth for 'match' */
#if !defined(MAXCCALLS)
#define MAXCCALLS 200
#endif

#define C_ESC '\\'
#define SPECIALS "^$*+?.([\\-"

int carp_regerror(const char* fmt, ...) {
  va_list ap;
  va_start(ap, fmt);
  vprintf(fmt, ap);
  va_end(ap);
  return -1;
}

int Pattern_internal_check_capture(PatternMatchState *ms, int l) {
  l -= '1';
  if (l < 0 || l >= ms->level || ms->capture[l].len == CAP_UNFINISHED) {
    return carp_regerror("invalid capture index %c%d", C_ESC, l + 1);
  }
  return l;
}

int Pattern_internal_capture_to_close(PatternMatchState *ms) {
  int level = ms->level;
  for (level--; level>=0; level--) {
    if (ms->capture[level].len == CAP_UNFINISHED) return level;
  }
  return carp_regerror("invalid pattern capture");
}

string Pattern_internal_classend(PatternMatchState *ms, string p) {
  switch (*p++) {
    case C_ESC: {
      if (p == ms->p_end) carp_regerror("malformed pattern (ends with '%c')", C_ESC);
      return p+1;
    }
    case '[': {
      if (*p == '^') p++;
      do {  /* look for a ']' */
        if (p == ms->p_end) carp_regerror("malformed pattern (missing ']')");
        if (*(p++) == C_ESC && p < ms->p_end) p++;  /* skip escapes (e.g. '%]') */
      } while (*p != ']');
      return p+1;
    }
    default: {
      return p;
    }
  }
}

int Pattern_internal_match_class(int c, int cl) {
  int res;
  switch (tolower(cl)) {
    case 'a' : res = isalpha(c); break;
    case 'c' : res = iscntrl(c); break;
    case 'd' : res = isdigit(c); break;
    case 'g' : res = isgraph(c); break;
    case 'l' : res = islower(c); break;
    case 'p' : res = ispunct(c); break;
    case 's' : res = isspace(c); break;
    case 'u' : res = isupper(c); break;
    case 'w' : res = isalnum(c); break;
    case 'x' : res = isxdigit(c); break;
    default: return (cl == c);
  }
  return (islower(cl) ? res : !res);
}

int Pattern_internal_matchbracketclass(int c, string p, string ec) {
  int sig = 1;
  if (*(p+1) == '^') {
    sig = 0;
    p++;  /* skip the '^' */
  }
  while (++p < ec) {
    if (*p == C_ESC) {
      p++;
      if (Pattern_internal_match_class(c, uchar(*p))) return sig;
    }
    else if ((*(p+1) == '-') && (p+2 < ec)) {
      p+=2;
      if (uchar(*(p-2)) <= c && c <= uchar(*p)) return sig;
    }
    else if (uchar(*p) == c) return sig;
  }
  return !sig;
}

int Pattern_internal_singlematch(PatternMatchState *ms, string s, string p,
                                 string ep) {
  if (s >= ms->src_end) {
    return 0;
  } else {
    int c = uchar(*s);
    switch (*p) {
      case '.': return 1;  /* matches any char */
      case C_ESC: return Pattern_internal_match_class(c, uchar(*(p+1)));
      case '[': return Pattern_internal_matchbracketclass(c, p, ep-1);
      default:  return (uchar(*p) == c);
    }
  }
}

string Pattern_internal_matchbalance(PatternMatchState *ms, string s, string p) {
  if (p >= ms->p_end - 1) carp_regerror("malformed pattern (missing arguments to '%cb')", C_ESC);
  if (*s != *p) {
    return NULL;
  } else {
    int b = *p;
    int e = *(p+1);
    int cont = 1;
    while (++s < ms->src_end) {
      if (*s == e) {
        if (--cont == 0) return s+1;
      }
      else if (*s == b) {
        cont++;
      }
    }
  }
  return NULL;  /* string ends out of balance */
}

string Pattern_internal_max_expand(PatternMatchState *ms, string s, string p,
                                   string ep) {
  ptrdiff_t i = 0;  /* counts maximum expand for item */
  while (Pattern_internal_singlematch(ms, s + i, p, ep)) i++;
  /* keeps trying to match with the maximum repetitions */
  while (i>=0) {
    string res = Pattern_internal_match(ms, (s+i), ep+1);
    if (res) return res;
    i--;  /* else didn't match; reduce 1 repetition to try again */
  }
  return NULL;
}

string Pattern_internal_min_expand(PatternMatchState *ms, string s, string p,
                                   string ep) {
  for (;;) {
    string res = Pattern_internal_match(ms, s, ep+1);
    if (res) return res;
    else if (Pattern_internal_singlematch(ms, s, p, ep)) s++;  /* try with one more repetition */
    else return NULL;
  }
}

string Pattern_internal_start_capture(PatternMatchState *ms, string s, string p,
                                      int what) {
  string res;
  int level = ms->level;
  if (level >= CARP_MAXCAPTURES) carp_regerror("too many captures");
  ms->capture[level].init = s;
  ms->capture[level].len = what;
  ms->level = level+1;
  if (!(res=Pattern_internal_match(ms, s, p))) ms->level--; /* undo capture on failed match */
  return res;
}

string Pattern_internal_end_capture(PatternMatchState *ms, string s, string p) {
  int l = Pattern_internal_capture_to_close(ms);
  string res;
  ms->capture[l].len = s - ms->capture[l].init;  /* close capture */
  if (!(res=Pattern_internal_match(ms, s, p))) {
    ms->capture[l].len = CAP_UNFINISHED; /* undo capture */
  }
  return res;
}

string Pattern_internal_match_capture(PatternMatchState *ms, string s, int l) {
  size_t len;
  l = Pattern_internal_check_capture(ms, l);
  len = ms->capture[l].len;
  if ((size_t)(ms->src_end-s) >= len && !memcmp(ms->capture[l].init, s, len)) {
    return s+len;
  }
  return NULL;
}

string Pattern_internal_match(PatternMatchState *ms, string s, string p) {
  if (ms->matchdepth-- == 0) carp_regerror("pattern too complex");
  init: /* using goto's to optimize tail recursion */
  if (p != ms->p_end) {  /* end of pattern? */
    switch (*p) {
      case '(': {  /* start capture */
        if (*(p + 1) == ')') s = Pattern_internal_start_capture(ms, s, p + 2,
                                                                CAP_NONE);
        else s = Pattern_internal_start_capture(ms, s, p + 1, CAP_UNFINISHED);
        break;
      }
      case ')': {  /* end capture */
        s = Pattern_internal_end_capture(ms, s, p + 1);
        break;
      }
      case '$': {
        if ((p + 1) != ms->p_end) goto dflt;  /* are we done as we should */
        s = (s == ms->src_end) ? s : NULL;  /* check end of string */
        break;
      }
      case C_ESC: {  /* escaped sequences not in the format class[*+?-]? */
        switch (*(p + 1)) {
          case 'b': {  /* balanced string? */
            s = Pattern_internal_matchbalance(ms, s, p + 2);
            if (s) {
              p += 4; goto init;  /* return match(ms, s, p + 4); */
            }  /* else fail (s == NULL) */
            break;
          }
          case 'f': {  /* frontier? */
            string ep; char previous;
            p += 2;
            if (*p != '[') carp_regerror("missing '[' after '%cf' in pattern", C_ESC);
            ep = Pattern_internal_classend(ms, p);  /* points to what is next */
            previous = (s == ms->src_init) ? '\0' : *(s - 1);
            if (!Pattern_internal_matchbracketclass(uchar(previous), p, ep - 1) &&
                Pattern_internal_matchbracketclass(uchar(*s), p, ep - 1)) {
              p = ep; goto init;  /* return match(ms, s, ep); */
            }
            s = NULL;  /* match failed */
            break;
          }
          case 'n': { /* newline? */
            if (*s == '\r') { if (*(++s) == '\n') s++; }
            else if (*s == '\n') s++;
            else s = NULL;
            break;
          }
          case 't': { /* tab? */
            if (*s == '\t') s++;
            else s = NULL;
            break;
          }
          case '0': case '1': case '2': case '3':
          case '4': case '5': case '6': case '7':
          case '8': case '9': {  /* capture results (\0-\9)? */
            s = Pattern_internal_match_capture(ms, s, uchar(*(p + 1)));
            if (s) {
              p += 2; goto init;  /* return match(ms, s, p + 2) */
            }
            break;
          }
          default: goto dflt;
        }
        break;
      }
      default: dflt: {  /* pattern class plus optional suffix */
        string ep = Pattern_internal_classend(ms, p);  /* points to optional suffix */
        /* does not match at least once? */
        if (!Pattern_internal_singlematch(ms, s, p, ep)) {
          if (*ep == '*' || *ep == '?' || *ep == '-') {  /* accept empty? */
            p = ep + 1; goto init;  /* return match(ms, s, ep + 1); */
          }
          else { /* '+' or no suffix */
            s = NULL;  /* fail */
          }
        }
        else {  /* matched once */
          switch (*ep) {  /* handle optional suffix */
            case '?': {  /* optional */
              string res;
              if ((res = Pattern_internal_match(ms, s + 1, ep + 1))) {
                s = res;
              } else {
                p = ep + 1; goto init;  /* else return match(ms, s, ep + 1); */
              }
              break;
            }
            case '+':  /* 1 or more repetitions */
              s++;  /* 1 match already done */
              /* FALLTHROUGH */
            case '*':  /* 0 or more repetitions */
              s = Pattern_internal_max_expand(ms, s, p, ep);
              break;
            case '-':  /* 0 or more repetitions (minimum) */
              s = Pattern_internal_min_expand(ms, s, p, ep);
              break;
            default:  /* no suffix */
              s++; p = ep; goto init;  /* return match(ms, s + 1, ep); */
          }
        }
        break;
      }
    }
  }
  ms->matchdepth++;
  return s;
}

string Pattern_internal_lmemfind(string s1, size_t l1, string s2, size_t l2) {
  if (l2 == 0) return s1;  /* empty strings are everywhere */
  if (l2 > l1) return NULL;  /* avoids a negative 'l1' */
  string init;  /* to search for a '*s2' inside 's1' */
  l2--;  /* 1st char will be checked by 'memchr' */
  l1 = l1-l2;  /* 's2' cannot be found after that */
  while (l1 > 0 && (init = (string )memchr(s1, *s2, l1))) {
    init++;   /* 1st char is already checked */
    if (!memcmp(init, s2+1, l2)) {
      return init-1;
    } else {  /* correct 'l1' and 's1' to try again */
      l1 -= init-s1;
      s1 = init;
    }
  }
  return NULL;  /* not found */
}

string String_copy_len(string s, int len) {
    string ptr = CARP_MALLOC(len+1);

    if (!ptr) return NULL;

    memcpy(ptr, s, len);
    ptr[len] = '\0';
    return ptr;
}

Array Array_push_string(Array a, string s, int i, int len) {
  ((string*)a.data)[i] = String_copy_len(s, len);
  return a;
}

Array Pattern_internal_push_onecapture(PatternMatchState *ms, int i, string s,
                                       string e, Array captures) {
  if (i >= ms->level) {
    if (!i) return Array_push_string(captures, s, i, ms->capture[i].len);  /* add whole match */
    else carp_regerror("invalid capture index %cd", C_ESC, i + 1);
  }
  else {
    ptrdiff_t l = ms->capture[i].len;
    if (l == CAP_UNFINISHED) carp_regerror("unfinished capture");
    else if (l != CAP_NONE) return Array_push_string(captures, ms->capture[i].init,
                                                     i, ms->capture[i].len);
  }
  return captures;
}

Array Pattern_internal_push_captures(PatternMatchState *ms, string s, string e) {
  int i;
  int nlevels = (ms->level == 0 && s) ? 1 : ms->level;
  Array res;
  res.len = nlevels;
  res.capacity = nlevels;
  res.data = CARP_MALLOC(nlevels*sizeof(string));
  for (i = 0; i < nlevels; i++) Pattern_internal_push_onecapture(ms, i, s, e,
                                                                 res);
  return res;
}

/* check whether pattern has no special characters */
int Pattern_internal_nospecials(string p, size_t l) {
  size_t upto = 0;
  do {
    if (strpbrk(p + upto, SPECIALS)) return 0; /* pattern has a special character */
    upto += strlen(p + upto) + 1; /* may have more after \0 */
  } while (upto <= l);
  return 1; /* no special chars found */
}

void Pattern_internal_prepstate(PatternMatchState *ms, string s, size_t ls,
                                string p, size_t lp) {
  ms->matchdepth = MAXCCALLS;
  ms->src_init = s;
  ms->src_end = s + ls;
  ms->p_end = p + lp;
}

void Pattern_internal_reprepstate(PatternMatchState *ms) {
  ms->level = 0;
  assert(ms->matchdepth == MAXCCALLS);
}

int Pattern_find(pattern* p, string* s) {
  string str = *s;
  pattern pat = *p;
  int lstr = strlen(str);
  int lpat = strlen(pat);
  /* explicit request or no special characters? */
  if (Pattern_internal_nospecials(pat, lpat)) {
    /* do a plain search */
    string s2 = Pattern_internal_lmemfind(str, lstr, pat, lpat);
    if (!s2) return -1;
    return s2-str;
  }
  PatternMatchState ms;
  string s1 = str;
  int anchor = (*pat == '^');
  if (anchor) {
    pat++; lpat--;  /* skip anchor character */
  }
  Pattern_internal_prepstate(&ms, str, lstr, pat, lpat);
  do {
    string res;
    Pattern_internal_reprepstate(&ms);
    if ((res=Pattern_internal_match(&ms, s1, pat))) return s1 - str;
  } while (s1++ < ms.src_end && !anchor);
  return -1;
}

Array Pattern_match(pattern* p, string* s) {
  string str = *s;
  pattern pat = *p;
  int lstr = strlen(str);
  int lpat = strlen(pat);
  PatternMatchState ms;
  string s1 = str;
  int anchor = (*pat == '^');
  if (anchor) {
    pat++; lpat--;  /* skip anchor character */
  }
  Pattern_internal_prepstate(&ms, str, lstr, pat, lpat);
  do {
    string res;
    Pattern_internal_reprepstate(&ms);
    if ((res=Pattern_internal_match(&ms, s1, pat))) {
      return Pattern_internal_push_captures(&ms, s1, res);
    }
  } while (s1++ < ms.src_end && !anchor);
  Array a;
  a.len = 0;
  a.capacity = 0;
  a.data = NULL;
  return a;
}

string Pattern_match_MINUS_str(pattern* p, string* s) {
  string str = *s;
  pattern pat = *p;
  int lstr = strlen(str);
  int lpat = strlen(pat);
  PatternMatchState ms;
  string s1 = str;
  int anchor = (*pat == '^');
  if (anchor) {
    pat++; lpat--;  /* skip anchor character */
  }
  Pattern_internal_prepstate(&ms, str, lstr, pat, lpat);
  do {
    string res;
    Pattern_internal_reprepstate(&ms);
    if ((res=Pattern_internal_match(&ms, s1, pat))) {
      int start = (s1 - str) + 1;
      int end = res - str + 1;
      int len = end - start;
      res = CARP_MALLOC(len + 1);
      memcpy(res, s1, len);
      res[len] = '\0';
      return res;
    }
  } while (s1++ < ms.src_end && !anchor);
  return String_empty();
}

/* state for 'gmatch' */
typedef struct PatternGMatchState {
  string src;  /* current position */
  string pat;  /* pattern */
  string lastmatch;  /* end of last match */
  PatternMatchState ms;  /* match state */
} PatternGMatchState;

typedef struct PatternGMatchRes {
  bool valid;
  Array data;
} PatternGMatchRes;


PatternGMatchRes Pattern_internal_gmatch_aux(PatternGMatchState* gm) {
  string src;
  Array a;
  for (src = gm->src; src <= gm->ms.src_end; src++) {
    string e;
    Pattern_internal_reprepstate(&gm->ms);
    if ((e = Pattern_internal_match(&gm->ms, src, gm->pat)) &&
        e != gm->lastmatch) {
      gm->src = gm->lastmatch = e;
      a = Pattern_internal_push_captures(&gm->ms, src, e);
      return (PatternGMatchRes){.valid=true, .data=a};
    }
  }
  return (PatternGMatchRes){.valid=false, .data=a};  /* not found */
}

Array Array_push_back(Array res, Array tmp) {
  res.len++;
  res.data = realloc(res.data, res.len*sizeof(Array));
  ((Array*)res.data)[res.len-1] = tmp;
  return res;
}

Array Pattern_global_MINUS_match(pattern* p, string* s) {
  string str = *s;
  pattern pat = *p;
  int lstr = strlen(str);
  int lpat = strlen(pat);
  PatternGMatchState gm;
  Pattern_internal_prepstate(&gm.ms, str, lstr, pat, lpat);
  gm.src = str; gm.pat = pat; gm.lastmatch = NULL;
  Array res;
  res.len = 0;
  res.capacity = 0;
  res.data = NULL;
  PatternGMatchRes tmp = Pattern_internal_gmatch_aux(&gm);
  while (tmp.valid) {
    res = Array_push_back(res, tmp.data);
    tmp = Pattern_internal_gmatch_aux(&gm);
  }
  return res;
}

string Pattern_internal_add_char(string a, char b) {
    if (!a) {
      string buffer = CARP_MALLOC(2);
      snprintf(buffer, 2, "%c", b);
      return buffer;
    }

    int len = strlen(a) + 2;
    string buffer = CARP_MALLOC(len);
    snprintf(buffer, len, "%s%c", a, b);
    CARP_FREE(a);
    return buffer;
}

string Pattern_internal_add_value(PatternMatchState *ms, string res, string src,
                                  string e, string tr) {
  size_t l, i;
  l = strlen(tr);
  for (i = 0; i < l; i++) {
    if (tr[i] != C_ESC) res = Pattern_internal_add_char(res, tr[i]);
    else {
      i++;  /* skip ESC */
      if (!isdigit(uchar(tr[i]))) {
        if (tr[i] != C_ESC) {
          carp_regerror( "invalid use of '%c' in replacement string", C_ESC);
        }
        res = Pattern_internal_add_char(res, tr[i]);
      }
      else if (tr[i] == '0') res = String_append(res, src);
      else {
        Array a = {.len = 0, .capacity = 0, .data = NULL};
        Pattern_internal_push_onecapture(ms, tr[i] - '1', src, e, a);
        res = String_append(res, ((string*)a.data)[0]);  /* add capture to accumulated result */
      }
    }
  }
  return res;
}

string Pattern_substitute(pattern* p, string *s, string *t, int ns) {
  string str = *s;
  pattern pat = *p;
  string tr = *t;
  int lstr = strlen(str);
  int lpat = strlen(pat);
  string lastmatch = NULL;  /* end of last match */
  int anchor = (*pat == '^');
  string res = NULL;
  PatternMatchState ms;
  int n = 0;
  if (anchor) {
    pat++; lpat--;  /* skip anchor character */
  }
  Pattern_internal_prepstate(&ms, str, lstr, pat, lpat);
  while (n < ns || ns == -1) {
    string e;
    Pattern_internal_reprepstate(&ms);  /* (re)prepare state for new match */
    if ((e = Pattern_internal_match(&ms, str, pat)) && e != lastmatch) {  /* match? */
      n++;
      res = Pattern_internal_add_value(&ms, res, str, e, tr);  /* add replacement to buffer */
      str = lastmatch = e;
    }
    else if (str < ms.src_end) res = Pattern_internal_add_char(res, *str++);
    else break;  /* end of subject */
    if (anchor) break;
  }
  int l = strlen(res)+strlen(str)+1;
  res = realloc(res, l);
  snprintf(res, l, "%s%s", res, str);
  return res;
}

pattern Pattern_copy(pattern *p) {
    size_t len = strlen(*p) + 1;
    pattern ptr = CARP_MALLOC(len);

    if (!ptr) return NULL;

    return (pattern) memcpy(ptr, *p, len);
}

void Pattern_delete(pattern p) {
  CARP_FREE(p);
}

pattern Pattern_init(string* p) {
  return Pattern_copy(p);
}

string Pattern_str(pattern *p) {
  return Pattern_copy(p);
}

string Pattern_prn(pattern *p) {
    int n = strlen(*p) + 4;
    string buffer = CARP_MALLOC(n);
    snprintf(buffer, n, "#\"%s\"", *p);
    return buffer;
}

bool Pattern__EQ_(pattern *a, pattern *b) {
    return strcmp(*a, *b) == 0;
}