OpenSTA/util/PatternMatch.cc

// OpenSTA, Static Timing Analyzer
// Copyright (c) 2026, Parallax Software, Inc.
// 
// 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 3 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, see <https://www.gnu.org/licenses/>.
// 
// The origin of this software must not be misrepresented; you must not
// claim that you wrote the original software.
// 
// Altered source versions must be plainly marked as such, and must not be
// misrepresented as being the original software.
// 
// This notice may not be removed or altered from any source distribution.

#include "PatternMatch.hh"
#include <cctype>
#include <tcl.h>

namespace sta {

PatternMatch::PatternMatch(std::string_view pattern,
                           bool is_regexp,
                           bool nocase,
                           Tcl_Interp *interp) :
  pattern_(pattern),
  is_regexp_(is_regexp),
  nocase_(nocase),
  interp_(interp),
  regexp_(nullptr)
{
  if (is_regexp_)
    compileRegexp();
}

PatternMatch::PatternMatch(std::string_view pattern) :
  pattern_(pattern),
  is_regexp_(false),
  nocase_(false),
  interp_(nullptr),
  regexp_(nullptr)
{
}

PatternMatch::PatternMatch(std::string_view pattern,
                           const PatternMatch *inherit_from) :
  pattern_(pattern),
  is_regexp_(inherit_from->is_regexp_),
  nocase_(inherit_from->nocase_),
  interp_(inherit_from->interp_),
  regexp_(nullptr)
{
  if (is_regexp_)
    compileRegexp();
}

void
PatternMatch::compileRegexp()
{
  int flags = TCL_REG_ADVANCED;
  if (nocase_)
    flags |= TCL_REG_NOCASE;
  std::string anchored_pattern;
  anchored_pattern += '^';
  anchored_pattern += pattern_;
  anchored_pattern += '$';
  Tcl_Obj *pattern_obj = Tcl_NewStringObj(anchored_pattern.c_str(),
                                          anchored_pattern.size());
  Tcl_IncrRefCount(pattern_obj);
  regexp_ = Tcl_GetRegExpFromObj(interp_, pattern_obj, flags);
  Tcl_DecrRefCount(pattern_obj);
  if (regexp_ == nullptr && interp_)
    throw RegexpCompileError(pattern_);
}

static bool
regexpWildcards(std::string_view pattern)
{
  return pattern.find_first_of(".+*?[]") != std::string_view::npos;
}

bool
PatternMatch::hasWildcards() const
{
  if (is_regexp_)
    return regexpWildcards(pattern_);
  else
    return patternWildcards(pattern_);
}

bool
PatternMatch::match(std::string_view str) const
{
  if (regexp_) {
    std::string buf(str);
    const char *cstr = buf.c_str();
    return Tcl_RegExpExec(nullptr, regexp_, cstr, cstr) == 1;
  }
  return patternMatch(pattern_, str);
}

bool
PatternMatch::matchNoCase(std::string_view str) const
{
  if (regexp_) {
    std::string buf(str);
    const char *cstr = buf.c_str();
    return Tcl_RegExpExec(0, regexp_, cstr, cstr) == 1;
  }
  return patternMatchNoCase(pattern_, str, nocase_);
}

////////////////////////////////////////////////////////////////

RegexpCompileError::RegexpCompileError(std::string_view pattern)  :
  Exception()
{
  error_ = "TCL failed to compile regular expression '";
  error_.append(pattern.data(), pattern.size());
  error_ += "'.";
}

const char *
RegexpCompileError::what() const noexcept
{
  return error_.c_str();
}

////////////////////////////////////////////////////////////////

bool
patternMatch(std::string_view pattern,
             std::string_view str)
{
  size_t pi = 0;
  size_t si = 0;
  while (pi < pattern.size() && si < str.size()
         && (str[si] == pattern[pi] || pattern[pi] == '?')) {
    pi++;
    si++;
  }
  if (pi == pattern.size() && si == str.size())
    return true;
  if (pi < pattern.size() && pattern[pi] == '*') {
    if (pi + 1 == pattern.size())
      return true;
    while (si < str.size()) {
      if (patternMatch(pattern.substr(pi + 1), str.substr(si)))
        return true;
      si++;
    }
  }
  return false;
}

static bool
equalCase(char s,
          char p,
          bool nocase)
{
  return nocase
    ? std::tolower(static_cast<unsigned char>(s))
        == std::tolower(static_cast<unsigned char>(p))
    : s == p;
}

bool
patternMatchNoCase(std::string_view pattern,
                   std::string_view str,
                   bool nocase)
{
  size_t pi = 0;
  size_t si = 0;
  while (pi < pattern.size() && si < str.size()
         && (equalCase(str[si], pattern[pi], nocase) || pattern[pi] == '?')) {
    pi++;
    si++;
  }
  if (pi == pattern.size() && si == str.size())
    return true;
  if (pi < pattern.size() && pattern[pi] == '*') {
    if (pi + 1 == pattern.size())
      return true;
    while (si < str.size()) {
      if (patternMatchNoCase(pattern.substr(pi + 1), str.substr(si), nocase))
        return true;
      si++;
    }
  }
  return false;
}

bool
patternWildcards(std::string_view pattern)
{
  return pattern.find_first_of("*?") != std::string_view::npos;
}

} // namespace