builtin_functions.cc

/*
 *  OpenSCAD (www.openscad.org)
 *  Copyright (C) 2009-2011 Clifford Wolf <clifford@clifford.at> and
 *                          Marius Kintel <marius@kintel.net>
 *
 *  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.
 *
 *  As a special exception, you have permission to link this program
 *  with the CGAL library and distribute executables, as long as you
 *  follow the requirements of the GNU GPL in regard to all of the
 *  software in the executable aside from CGAL.
 *
 *  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, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */

#include "function.h"
#include "Arguments.h"
#include "Expression.h"
#include "Builtins.h"
#include "printutils.h"
#include "memory.h"
#include "UserModule.h"
#include "degree_trig.h"
#include "FreetypeRenderer.h"
#include "Parameters.h"
#include "import.h"
#include "fileutils.h"

#include <cmath>
#include <sstream>
#include <ctime>
#include <limits>
#include <algorithm>
#include <random>

#include "boost-utils.h"
/*Unicode support for string lengths and array accesses*/
#include <glib.h>
// hash double
#include "linalg.h"

#if defined __WIN32__ || defined _MSC_VER
#include <process.h>
int process_id = _getpid();
#else
#include <sys/types.h>
#include <unistd.h>
int process_id = getpid();
#endif

std::mt19937 deterministic_rng(std::time(nullptr) + process_id);
#include <array>

static inline bool check_arguments(const char *function_name, const Arguments& arguments, const Location& loc, unsigned int expected_count, bool warn = true)
{
  if (arguments.size() != expected_count) {
    if (warn) {
      print_argCnt_warning(function_name, arguments.size(), STR(expected_count), loc, arguments.documentRoot());
    }
    return false;
  }
  return true;
}
/* // Commented due to compiler warning of unused function.
   static inline bool try_check_arguments(const Arguments& arguments, int expected_count)
   {
   return check_arguments(nullptr, arguments, Location::NONE, expected_count, false);
   }
 */
template <size_t N>
static inline bool check_arguments(const char *function_name, const Arguments& arguments, const Location& loc, const Value::Type (& expected_types) [N], bool warn = true)
{
  if (!check_arguments(function_name, arguments, loc, N, warn)) {
    return false;
  }
  for (size_t i = 0; i < N; i++) {
    if (arguments[i]->type() != expected_types[i]) {
      if (warn) {
        print_argConvert_positioned_warning(function_name, "argument " + STR(i), arguments[i]->clone(), {expected_types[i]}, loc, arguments.documentRoot());
      }
      return false;
    }
  }
  return true;
}

template <size_t N>
static inline bool try_check_arguments(const Arguments& arguments, const Value::Type (& expected_types) [N])
{
  return check_arguments(nullptr, arguments, Location::NONE, expected_types, false);
}

Value builtin_abs(Arguments arguments, const Location& loc)
{
  if (!check_arguments("abs", arguments, loc, { Value::Type::NUMBER })) {
    return Value::undefined.clone();
  }
  return Value(std::fabs(arguments[0]->toDouble()));
}

Value builtin_sign(Arguments arguments, const Location& loc)
{
  if (!check_arguments("sign", arguments, loc, { Value::Type::NUMBER })) {
    return Value::undefined.clone();
  }
  double x = arguments[0]->toDouble();
  return Value((x < 0) ? -1.0 : ((x > 0) ? 1.0 : 0.0));
}

Value builtin_rands(Arguments arguments, const Location& loc)
{
  if (arguments.size() < 3 || arguments.size() > 4) {
    print_argCnt_warning("rands", arguments.size(), "3 or 4", loc, arguments.documentRoot());
    return Value::undefined.clone();
  } else if (arguments.size() == 3) {
    if (!check_arguments("rands", arguments, loc, { Value::Type::NUMBER, Value::Type::NUMBER, Value::Type::NUMBER })) {
      return Value::undefined.clone();
    }
  } else {
    if (!check_arguments("rands", arguments, loc, { Value::Type::NUMBER, Value::Type::NUMBER, Value::Type::NUMBER, Value::Type::NUMBER })) {
      return Value::undefined.clone();
    }
  }

  double min = arguments[0]->toDouble();
  if (std::isinf(min) || std::isnan(min)) {
    LOG(message_group::Warning, loc, arguments.documentRoot(), "rands() range min cannot be infinite");
    min = -std::numeric_limits<double>::max() / 2;
    LOG(message_group::Warning, Location::NONE, "", "resetting to %1f", min);
  }

  double max = arguments[1]->toDouble();
  if (std::isinf(max)  || std::isnan(max)) {
    LOG(message_group::Warning, loc, arguments.documentRoot(), "rands() range max cannot be infinite");
    max = std::numeric_limits<double>::max() / 2;
    LOG(message_group::Warning, Location::NONE, "", "resetting to %1f", max);
  }
  if (max < min) {
    double tmp = min; min = max; max = tmp;
  }

  double numresultsd = std::abs(arguments[2]->toDouble() );
  if (std::isinf(numresultsd) || std::isnan(numresultsd)) {
    LOG(message_group::Warning, loc, arguments.documentRoot(), "rands() cannot create an infinite number of results");
    LOG(message_group::Warning, Location::NONE, "", "resetting number of results to 1");
    numresultsd = 1;
  }
  size_t numresults = boost_numeric_cast<size_t, double>(numresultsd);

  if (arguments.size() > 3) {
    uint32_t seed = static_cast<uint32_t>(hash_floating_point(arguments[3]->toDouble() ));
    deterministic_rng.seed(seed);
  }

  VectorType vec(arguments.session());
  if (min >= max) { // uniform_real_distribution doesn't allow min == max
    for (size_t i = 0; i < numresults; ++i)
      vec.emplace_back(min);
  } else {
    std::uniform_real_distribution<> distributor(min, max);
    for (size_t i = 0; i < numresults; ++i) {
      vec.emplace_back(distributor(deterministic_rng));
    }
  }
  return std::move(vec);
}

static std::vector<double> min_max_arguments(const Arguments& arguments, const Location& loc, const char *function_name)
{
  std::vector<double> output;
  // preserve special handling of the first argument
  // as a template for vector processing
  if (arguments.size() == 0) {
    print_argCnt_warning(function_name, arguments.size(), "at least 1", loc, arguments.documentRoot());
    return {};
  } else if (arguments.size() == 1 && arguments[0]->type() == Value::Type::VECTOR) {
    const auto& elements = arguments[0]->toVector();
    if (elements.size() == 0) {
      print_argCnt_warning(function_name, elements.size(), "at least 1 vector element", loc, arguments.documentRoot());
      return {};
    }
    for (size_t i = 0; i < elements.size(); i++) {
      const auto& element = elements[i];
      // 4/20/14 semantic change per discussion:
      // break on any non-number
      if (element.type() != Value::Type::NUMBER) {
        print_argConvert_positioned_warning(function_name, "vector element " + STR(i), element, {Value::Type::NUMBER}, loc, arguments.documentRoot());
        return {};
      }
      output.push_back(element.toDouble());
    }
  } else {
    for (size_t i = 0; i < arguments.size(); i++) {
      const auto& argument = arguments[i];
      // 4/20/14 semantic change per discussion:
      // break on any non-number
      if (argument->type() != Value::Type::NUMBER) {
        print_argConvert_positioned_warning(function_name, "argument " + STR(i), argument->clone(), {Value::Type::NUMBER}, loc, arguments.documentRoot());
        return {};
      }
      output.push_back(argument->toDouble());
    }
  }
  return output;
}

Value builtin_min(Arguments arguments, const Location& loc)
{
  std::vector<double> values = min_max_arguments(arguments, loc, "min");
  if (values.empty()) {
    return Value::undefined.clone();
  }
  return Value(*std::min_element(values.begin(), values.end()));
}

Value builtin_max(Arguments arguments, const Location& loc)
{
  std::vector<double> values = min_max_arguments(arguments, loc, "max");
  if (values.empty()) {
    return Value::undefined.clone();
  }
  return Value(*std::max_element(values.begin(), values.end()));
}

Value builtin_sin(Arguments arguments, const Location& loc)
{
  if (!check_arguments("sin", arguments, loc, { Value::Type::NUMBER })) {
    return Value::undefined.clone();
  }
  return Value(sin_degrees(arguments[0]->toDouble()));
}

Value builtin_cos(Arguments arguments, const Location& loc)
{
  if (!check_arguments("cos", arguments, loc, { Value::Type::NUMBER })) {
    return Value::undefined.clone();
  }
  return Value(cos_degrees(arguments[0]->toDouble()));
}

Value builtin_asin(Arguments arguments, const Location& loc)
{
  if (!check_arguments("asin", arguments, loc, { Value::Type::NUMBER })) {
    return Value::undefined.clone();
  }
  return Value(asin_degrees(arguments[0]->toDouble()));
}

Value builtin_acos(Arguments arguments, const Location& loc)
{
  if (!check_arguments("acos", arguments, loc, { Value::Type::NUMBER })) {
    return Value::undefined.clone();
  }
  return Value(acos_degrees(arguments[0]->toDouble()));
}

Value builtin_tan(Arguments arguments, const Location& loc)
{
  if (!check_arguments("tan", arguments, loc, { Value::Type::NUMBER })) {
    return Value::undefined.clone();
  }
  return Value(tan_degrees(arguments[0]->toDouble()));
}

Value builtin_atan(Arguments arguments, const Location& loc)
{
  if (!check_arguments("atan", arguments, loc, { Value::Type::NUMBER })) {
    return Value::undefined.clone();
  }
  return Value(atan_degrees(arguments[0]->toDouble()));
}

Value builtin_atan2(Arguments arguments, const Location& loc)
{
  if (!check_arguments("atan2", arguments, loc, { Value::Type::NUMBER, Value::Type::NUMBER })) {
    return Value::undefined.clone();
  }
  return Value(atan2_degrees(arguments[0]->toDouble(), arguments[1]->toDouble()));
}

Value builtin_pow(Arguments arguments, const Location& loc)
{
  if (!check_arguments("pow", arguments, loc, { Value::Type::NUMBER, Value::Type::NUMBER })) {
    return Value::undefined.clone();
  }
  return Value(pow(arguments[0]->toDouble(), arguments[1]->toDouble()));
}

Value builtin_round(Arguments arguments, const Location& loc)
{
  if (!check_arguments("round", arguments, loc, { Value::Type::NUMBER })) {
    return Value::undefined.clone();
  }
  return Value(round(arguments[0]->toDouble()));
}

Value builtin_ceil(Arguments arguments, const Location& loc)
{
  if (!check_arguments("ceil", arguments, loc, { Value::Type::NUMBER })) {
    return Value::undefined.clone();
  }
  return Value(ceil(arguments[0]->toDouble()));
}

Value builtin_floor(Arguments arguments, const Location& loc)
{
  if (!check_arguments("floor", arguments, loc, { Value::Type::NUMBER })) {
    return Value::undefined.clone();
  }
  return Value(floor(arguments[0]->toDouble()));
}

Value builtin_sqrt(Arguments arguments, const Location& loc)
{
  if (!check_arguments("sqrt", arguments, loc, { Value::Type::NUMBER })) {
    return Value::undefined.clone();
  }
  return Value(sqrt(arguments[0]->toDouble()));
}

Value builtin_exp(Arguments arguments, const Location& loc)
{
  if (!check_arguments("exp", arguments, loc, { Value::Type::NUMBER })) {
    return Value::undefined.clone();
  }
  return Value(exp(arguments[0]->toDouble()));
}

Value builtin_length(Arguments arguments, const Location& loc)
{
  if (try_check_arguments(arguments, { Value::Type::VECTOR })) {
    return Value(double(arguments[0]->toVector().size()));
  }
  if (!check_arguments("len", arguments, loc, { Value::Type::STRING })) {
    return Value::undefined.clone();
  }
  //Unicode glyph count for the length -- rather than the string (num. of bytes) length.
  return Value(double( arguments[0]->toStrUtf8Wrapper().get_utf8_strlen() ));
}

Value builtin_log(Arguments arguments, const Location& loc)
{
  double x, y;
  if (arguments.size() == 1) {
    if (!check_arguments("log", arguments, loc, { Value::Type::NUMBER })) {
      return Value::undefined.clone();
    }
    x = 10.0;
    y = arguments[0]->toDouble();
  } else {
    if (!check_arguments("log", arguments, loc, { Value::Type::NUMBER, Value::Type::NUMBER })) {
      return Value::undefined.clone();
    }
    x = arguments[0]->toDouble();
    y = arguments[1]->toDouble();
  }
  return Value(log(y) / log(x));
}

Value builtin_ln(Arguments arguments, const Location& loc)
{
  if (!check_arguments("ln", arguments, loc, { Value::Type::NUMBER })) {
    return Value::undefined.clone();
  }
  return Value(log(arguments[0]->toDouble()));
}

Value builtin_str(Arguments arguments, const Location& loc)
{
  std::ostringstream stream;
  for (const auto& argument : arguments) {
    stream << argument->toString();
  }
  return Value(stream.str());
}

Value builtin_chr(Arguments arguments, const Location& loc)
{
  std::ostringstream stream;
  for (const auto& argument : arguments) {
    stream << argument->chrString();
  }
  return Value(stream.str());
}

Value builtin_ord(Arguments arguments, const Location& loc)
{
  if (!check_arguments("ord", arguments, loc, { Value::Type::STRING })) {
    return Value::undefined.clone();
  }
  const str_utf8_wrapper& arg_str = arguments[0]->toStrUtf8Wrapper();
  const char *ptr = arg_str.c_str();
  if (!g_utf8_validate(ptr, -1, NULL)) {
    LOG(message_group::Warning, loc, arguments.documentRoot(), "ord() argument '%1$s' is not a valid utf8 string", arg_str.toString());
    return Value::undefined.clone();
  }

  if (arg_str.get_utf8_strlen() == 0) {
    return Value::undefined.clone();
  }

  const gunichar ch = g_utf8_get_char(ptr);
  return Value((double)ch);
}

Value builtin_concat(Arguments arguments, const Location& loc)
{
  VectorType result(arguments.session());
  for (auto& argument : arguments) {
    if (argument->type() == Value::Type::VECTOR) {
      result.emplace_back(EmbeddedVectorType(std::move(argument->toVectorNonConst())));
    } else {
      result.emplace_back(std::move(argument.value));
    }
  }
  return std::move(result);
}

Value builtin_lookup(Arguments arguments, const Location& loc)
{
  if (!check_arguments("lookup", arguments, loc, { Value::Type::NUMBER, Value::Type::VECTOR })) {
    return Value::undefined.clone();
  }
  double p = arguments[0]->toDouble();
  if (!std::isfinite(p)) {
    LOG(message_group::Warning, loc, arguments.documentRoot(), "lookup(%1$s, ...) first argument is not a number", arguments[0]->toEchoStringNoThrow());
    return Value::undefined.clone();
  }

  double low_p, low_v, high_p, high_v;
  const auto& vec = arguments[1]->toVector();

  // Second must be a vector of vec2, with valid numbers inside
  auto it = vec.begin();
  if (vec.empty() || it->toVector().size() < 2 || !it->getVec2(low_p, low_v)) {
    return Value::undefined.clone();
  }
  high_p = low_p;
  high_v = low_v;

  for (++it; it != vec.end(); ++it) {
    double this_p, this_v;
    if (it->getVec2(this_p, this_v)) {
      if (this_p <= p && (this_p > low_p || low_p > p)) {
        low_p = this_p;
        low_v = this_v;
      }
      if (this_p >= p && (this_p < high_p || high_p < p)) {
        high_p = this_p;
        high_v = this_v;
      }
    }
  }
  if (p <= low_p) return Value(high_v);
  if (p >= high_p) return Value(low_v);
  double f = (p - low_p) / (high_p - low_p);
  return Value(high_v * f + low_v * (1 - f));
}

/*
   Pattern:

   "search" "(" ( match_value | list_of_match_values ) "," vector_of_vectors
        ("," num_returns_per_match
          ("," index_col_num )? )?
        ")";
   match_value : ( Value::Type::NUMBER | Value::Type::STRING );
   list_of_values : "[" match_value ("," match_value)* "]";
   vector_of_vectors : "[" ("[" Value ("," Value)* "]")+ "]";
   num_returns_per_match : int;
   index_col_num : int;

   The search string and searched strings can be unicode strings.
   Examples:
   Index values return as list:
    search("a","abcdabcd");
        - returns [0]
    search("Л","Л");  //A unicode string
        - returns [0]
    search("🂡aЛ","a🂡Л🂡a🂡Л🂡a",0);
        - returns [[1,3,5,7],[0,4,8],[2,6]]
    search("a","abcdabcd",0); //Search up to all matches
        - returns [[0,4]]
    search("a","abcdabcd",1);
        - returns [0]
    search("e","abcdabcd",1);
        - returns []
    search("a",[ ["a",1],["b",2],["c",3],["d",4],["a",5],["b",6],["c",7],["d",8],["e",9] ]);
        - returns [0,4]

   Search on different column; return Index values:
    search(3,[ ["a",1],["b",2],["c",3],["d",4],["a",5],["b",6],["c",7],["d",8],["e",3] ], 0, 1);
        - returns [0,8]

   Search on list of values:
    Return all matches per search vector element:
      search("abc",[ ["a",1],["b",2],["c",3],["d",4],["a",5],["b",6],["c",7],["d",8],["e",9] ], 0);
        - returns [[0,4],[1,5],[2,6]]

    Return first match per search vector element; special case return vector:
      search("abc",[ ["a",1],["b",2],["c",3],["d",4],["a",5],["b",6],["c",7],["d",8],["e",9] ], 1);
        - returns [0,1,2]

    Return first two matches per search vector element; vector of vectors:
      search("abce",[ ["a",1],["b",2],["c",3],["d",4],["a",5],["b",6],["c",7],["d",8],["e",9] ], 2);
        - returns [[0,4],[1,5],[2,6],[8]]

 */

static VectorType search(
  const str_utf8_wrapper& find,
  const str_utf8_wrapper& table,
  unsigned int num_returns_per_match,
  EvaluationSession *session
  ) {
  VectorType returnvec(session);
  //Unicode glyph count for the length
  size_t findThisSize = find.get_utf8_strlen();
  size_t searchTableSize = table.get_utf8_strlen();
  for (size_t i = 0; i < findThisSize; ++i) {
    unsigned int matchCount = 0;
    VectorType resultvec(session);
    const gchar *ptr_ft = g_utf8_offset_to_pointer(find.c_str(), i);
    for (size_t j = 0; j < searchTableSize; ++j) {
      const gchar *ptr_st = g_utf8_offset_to_pointer(table.c_str(), j);
      if (ptr_ft && ptr_st && (g_utf8_get_char(ptr_ft) == g_utf8_get_char(ptr_st)) ) {
        matchCount++;
        if (num_returns_per_match == 1) {
          returnvec.emplace_back(double(j));
          break;
        } else {
          resultvec.emplace_back(double(j));
        }
        if (num_returns_per_match > 1 && matchCount >= num_returns_per_match) {
          break;
        }
      }
    }
    if (matchCount == 0) {
      gchar utf8_of_cp[6] = ""; //A buffer for a single unicode character to be copied into
      if (ptr_ft) g_utf8_strncpy(utf8_of_cp, ptr_ft, 1);
    }
    if (num_returns_per_match == 0 || num_returns_per_match > 1) {
      returnvec.emplace_back(std::move(resultvec));
    }
  }
  return returnvec;
}

static VectorType search(
  const str_utf8_wrapper& find,
  const VectorType& table,
  unsigned int num_returns_per_match,
  unsigned int index_col_num,
  const Location& loc,
  EvaluationSession *session
  ) {
  VectorType returnvec(session);
  //Unicode glyph count for the length
  unsigned int findThisSize = find.get_utf8_strlen();
  unsigned int searchTableSize = table.size();
  for (size_t i = 0; i < findThisSize; ++i) {
    unsigned int matchCount = 0;
    VectorType resultvec(session);
    const gchar *ptr_ft = g_utf8_offset_to_pointer(find.c_str(), i);
    for (size_t j = 0; j < searchTableSize; ++j) {
      const auto& entryVec = table[j].toVector();
      if (entryVec.size() <= index_col_num) {
        LOG(message_group::Warning, loc, session->documentRoot(), "Invalid entry in search vector at index %1$d, required number of values in the entry: %2$d. Invalid entry: %3$s", j, (index_col_num + 1), table[j].toEchoStringNoThrow());
        return VectorType(session);
      }
      const gchar *ptr_st = g_utf8_offset_to_pointer(entryVec[index_col_num].toString().c_str(), 0);
      if (ptr_ft && ptr_st && (g_utf8_get_char(ptr_ft) == g_utf8_get_char(ptr_st)) ) {
        matchCount++;
        if (num_returns_per_match == 1) {
          returnvec.emplace_back(double(j));
          break;
        } else {
          resultvec.emplace_back(double(j));
        }
        if (num_returns_per_match > 1 && matchCount >= num_returns_per_match) {
          break;
        }
      }
    }
    if (matchCount == 0) {
      gchar utf8_of_cp[6] = ""; //A buffer for a single unicode character to be copied into
      if (ptr_ft) g_utf8_strncpy(utf8_of_cp, ptr_ft, 1);
      LOG(message_group::Warning, loc, session->documentRoot(), "search term not found: \"%1$s\"", utf8_of_cp);
    }
    if (num_returns_per_match == 0 || num_returns_per_match > 1) {
      returnvec.emplace_back(std::move(resultvec));
    }
  }
  return returnvec;
}

Value builtin_search(Arguments arguments, const Location& loc)
{
  if (arguments.size() < 2 || arguments.size() > 4) {
    print_argCnt_warning("search", arguments.size(), "between 2 and 4", loc, arguments.documentRoot());
    return Value::undefined.clone();
  }

  const Value& findThis = arguments[0].value;
  const Value& searchTable = arguments[1].value;
  unsigned int num_returns_per_match = (arguments.size() > 2) ? (unsigned int)arguments[2]->toDouble() : 1;
  unsigned int index_col_num = (arguments.size() > 3) ? (unsigned int)arguments[3]->toDouble() : 0;

  VectorType returnvec(arguments.session());

  if (findThis.type() == Value::Type::NUMBER) {
    unsigned int matchCount = 0;
    size_t j = 0;
    for (const auto& search_element : searchTable.toVector()) {
      if ((index_col_num == 0 && (findThis == search_element).toBool()) ||
          (index_col_num < search_element.toVector().size() &&
           (findThis == search_element.toVector()[index_col_num]).toBool())) {
        returnvec.emplace_back(double(j));
        matchCount++;
        if (num_returns_per_match != 0 && matchCount >= num_returns_per_match) break;
      }
      ++j;
    }
  } else if (findThis.type() == Value::Type::STRING) {
    if (searchTable.type() == Value::Type::STRING) {
      returnvec = search(findThis.toStrUtf8Wrapper(), searchTable.toStrUtf8Wrapper(), num_returns_per_match, arguments.session());
    } else {
      returnvec = search(findThis.toStrUtf8Wrapper(), searchTable.toVector(), num_returns_per_match, index_col_num, loc, arguments.session());
    }
  } else if (findThis.type() == Value::Type::VECTOR) {
    const auto& findVec = findThis.toVector();
    for (size_t i = 0; i < findVec.size(); ++i) {
      unsigned int matchCount = 0;
      VectorType resultvec(arguments.session());

      const auto& find_value = findVec[i];
      size_t j = 0;
      for (const auto& search_element : searchTable.toVector()) {
        if ((index_col_num == 0 && (find_value == search_element).toBool()) ||
            (index_col_num < search_element.toVector().size() &&
             (find_value == search_element.toVector()[index_col_num]).toBool())) {
          matchCount++;
          if (num_returns_per_match == 1) {
            returnvec.emplace_back(double(j));
            break;
          } else {
            resultvec.emplace_back(double(j));
          }
          if (num_returns_per_match > 1 && matchCount >= num_returns_per_match) break;
        }
        ++j;
      }
      if (num_returns_per_match == 1 && matchCount == 0) {
        returnvec.emplace_back(std::move(resultvec));
      }
      if (num_returns_per_match == 0 || num_returns_per_match > 1) {
        returnvec.emplace_back(std::move(resultvec));
      }
    }
  } else {
    return Value::undefined.clone();
  }
  return std::move(returnvec);
}

#define QUOTE(x__) # x__
#define QUOTED(x__) QUOTE(x__)

Value builtin_version(Arguments arguments, const Location& loc)
{
  VectorType vec(arguments.session());
  vec.emplace_back(double(OPENSCAD_YEAR));
  vec.emplace_back(double(OPENSCAD_MONTH));
#ifdef OPENSCAD_DAY
  vec.emplace_back(double(OPENSCAD_DAY));
#endif
  return std::move(vec);
}

Value builtin_version_num(Arguments arguments, const Location& loc)
{
  Value val = (arguments.size() == 0) ? builtin_version(std::move(arguments), loc) : std::move(arguments[0].value);
  double y, m, d;
  if (!val.getVec3(y, m, d, 0)) {
    return Value::undefined.clone();
  }
  return Value(y * 10000 + m * 100 + d);
}

Value builtin_parent_module(Arguments arguments, const Location& loc)
{
  double d;
  if (arguments.size() == 0) {
    d = 1;
  } else if (!check_arguments("parent_module", arguments, loc, { Value::Type::NUMBER })) {
    return Value::undefined.clone();
  } else {
    d = arguments[0]->toDouble();
  }

  int n = trunc(d);
  int s = UserModule::stack_size();
  if (n < 0) {
    LOG(message_group::Warning, loc, arguments.documentRoot(), "Negative parent module index (%1$d) not allowed", n);
    return Value::undefined.clone();
  }
  if (n >= s) {
    LOG(message_group::Warning, loc, arguments.documentRoot(), "Parent module index (%1$d) greater than the number of modules on the stack", n);
    return Value::undefined.clone();
  }
  return Value(UserModule::stack_element(s - 1 - n));
}

Value builtin_norm(Arguments arguments, const Location& loc)
{
  if (!check_arguments("norm", arguments, loc, { Value::Type::VECTOR })) {
    return Value::undefined.clone();
  }
  double sum = 0;
  for (const auto& v : arguments[0]->toVector()) {
    if (v.type() == Value::Type::NUMBER) {
      double x = v.toDouble();
      sum += x * x;
    } else {
      LOG(message_group::Warning, loc, arguments.documentRoot(), "Incorrect arguments to norm()");
      return Value::undefined.clone();
    }
  }
  return Value(sqrt(sum));
}

Value builtin_cross(Arguments arguments, const Location& loc)
{
  if (!check_arguments("cross", arguments, loc, { Value::Type::VECTOR, Value::Type::VECTOR })) {
    return Value::undefined.clone();
  }

  const auto& v0 = arguments[0]->toVector();
  const auto& v1 = arguments[1]->toVector();
  if ((v0.size() == 2) && (v1.size() == 2)) {
    return Value(v0[0].toDouble() * v1[1].toDouble() - v0[1].toDouble() * v1[0].toDouble());
  }

  if ((v0.size() != 3) || (v1.size() != 3)) {
    LOG(message_group::Warning, loc, arguments.documentRoot(), "Invalid vector size of parameter for cross()");
    return Value::undefined.clone();
  }
  for (unsigned int a = 0; a < 3; ++a) {
    if ((v0[a].type() != Value::Type::NUMBER) || (v1[a].type() != Value::Type::NUMBER)) {
      LOG(message_group::Warning, loc, arguments.documentRoot(), "Invalid value in parameter vector for cross()");
      return Value::undefined.clone();
    }
    double d0 = v0[a].toDouble();
    double d1 = v1[a].toDouble();
    if (std::isnan(d0) || std::isnan(d1)) {
      LOG(message_group::Warning, loc, arguments.documentRoot(), "Invalid value (NaN) in parameter vector for cross()");
      return Value::undefined.clone();
    }
    if (std::isinf(d0) || std::isinf(d1)) {
      LOG(message_group::Warning, loc, arguments.documentRoot(), "Invalid value (INF) in parameter vector for cross()");
      return Value::undefined.clone();
    }
  }

  double x = v0[1].toDouble() * v1[2].toDouble() - v0[2].toDouble() * v1[1].toDouble();
  double y = v0[2].toDouble() * v1[0].toDouble() - v0[0].toDouble() * v1[2].toDouble();
  double z = v0[0].toDouble() * v1[1].toDouble() - v0[1].toDouble() * v1[0].toDouble();

  return VectorType(arguments.session(), x, y, z);
}

Value builtin_textmetrics(Arguments arguments, const Location& loc)
{
  Parameters parameters = Parameters::parse(std::move(arguments), loc,
                                            { "text", "size", "font" },
                                            { "direction", "language", "script", "halign", "valign", "spacing" }
                                            );
  parameters.set_caller("textmetrics");

  FreetypeRenderer::Params ftparams;
  ftparams.set_loc(loc);
  ftparams.set_documentPath(arguments.documentRoot());
  ftparams.set(parameters);
  ftparams.detect_properties();

  FreetypeRenderer::TextMetrics metrics(ftparams);
  if (!metrics.ok) {
    return Value::undefined.clone();
  }

  // The bounding box, ascent/descent, and offset values will be zero
  // if the text consists of nothing but whitespace.
  VectorType bbox_pos(arguments.session());
  bbox_pos.emplace_back(metrics.bbox_x);
  bbox_pos.emplace_back(metrics.bbox_y);

  VectorType bbox_dims(arguments.session());
  bbox_dims.emplace_back(metrics.bbox_w);
  bbox_dims.emplace_back(metrics.bbox_h);

  VectorType offset(arguments.session());
  offset.emplace_back(metrics.x_offset);
  offset.emplace_back(metrics.y_offset);

  // The advance values are valid whether or not the text
  // is whitespace.
  VectorType advance(arguments.session());
  advance.emplace_back(metrics.advance_x);
  advance.emplace_back(metrics.advance_y);

  ObjectType text_metrics(arguments.session());
  text_metrics.set("position", std::move(bbox_pos));
  text_metrics.set("size", std::move(bbox_dims));
  text_metrics.set("ascent", metrics.ascent);
  text_metrics.set("descent", metrics.descent);
  text_metrics.set("offset", std::move(offset));
  text_metrics.set("advance", std::move(advance));
  return std::move(text_metrics);
}

Value builtin_fontmetrics(Arguments arguments, const Location& loc)
{
  Parameters parameters = Parameters::parse(std::move(arguments), loc,
                                            { "size", "font" }
                                            );
  parameters.set_caller("fontmetrics");

  FreetypeRenderer::Params ftparams;
  ftparams.set_loc(loc);
  ftparams.set_documentPath(arguments.documentRoot());
  ftparams.set(parameters);
  ftparams.detect_properties();

  FreetypeRenderer::FontMetrics metrics(ftparams);
  if (!metrics.ok) {
    return Value::undefined.clone();
  }

  ObjectType nominal(arguments.session());
  nominal.set("ascent", metrics.nominal_ascent);
  nominal.set("descent", metrics.nominal_descent);

  ObjectType max(arguments.session());
  max.set("ascent", metrics.max_ascent);
  max.set("descent", metrics.max_descent);

  ObjectType font(arguments.session());
  font.set("family", metrics.family_name);
  font.set("style", metrics.style_name);

  ObjectType font_metrics(arguments.session());
  font_metrics.set("nominal", nominal);
  font_metrics.set("max", max);
  font_metrics.set("interline", metrics.interline);
  font_metrics.set("font", font);

  return std::move(font_metrics);
}

Value builtin_is_undef(const std::shared_ptr<const Context>& context, const FunctionCall *call)
{
  if (call->arguments.size() != 1) {
    print_argCnt_warning("is_undef", call->arguments.size(), "1", call->location(), context->documentRoot());
    return Value::undefined.clone();
  }
  if (auto lookup = dynamic_pointer_cast<Lookup>(call->arguments[0]->getExpr())) {
    auto result = context->try_lookup_variable(lookup->get_name());
    return !result || result->isUndefined();
  } else {
    return call->arguments[0]->getExpr()->evaluate(context).isUndefined();
  }
}

Value builtin_is_list(Arguments arguments, const Location& loc)
{
  if (!check_arguments("is_list", arguments, loc, 1)) {
    return Value::undefined.clone();
  }
  return Value(arguments[0]->isDefinedAs(Value::Type::VECTOR));
}

Value builtin_is_num(Arguments arguments, const Location& loc)
{
  if (!check_arguments("is_num", arguments, loc, 1)) {
    return Value::undefined.clone();
  }
  return Value(arguments[0]->isDefinedAs(Value::Type::NUMBER) && !std::isnan(arguments[0]->toDouble()));
}

Value builtin_is_bool(Arguments arguments, const Location& loc)
{
  if (!check_arguments("is_bool", arguments, loc, 1)) {
    return Value::undefined.clone();
  }
  return Value(arguments[0]->isDefinedAs(Value::Type::BOOL));
}

Value builtin_is_string(Arguments arguments, const Location& loc)
{
  if (!check_arguments("is_string", arguments, loc, 1)) {
    return Value::undefined.clone();
  }
  return Value(arguments[0]->isDefinedAs(Value::Type::STRING));
}

Value builtin_is_function(Arguments arguments, const Location& loc)
{
  if (!check_arguments("is_function", arguments, loc, 1)) {
    return Value::undefined.clone();
  }
  return Value(arguments[0]->isDefinedAs(Value::Type::FUNCTION));
}

Value builtin_is_object(Arguments arguments, const Location& loc)
{
  if (!check_arguments("is_object", arguments, loc, 1)) {
    return Value::undefined.clone();
  }
  return Value(arguments[0]->isDefinedAs(Value::Type::OBJECT));
}

Value builtin_import(Arguments arguments, const Location& loc)
{
  const Parameters parameters = Parameters::parse(std::move(arguments), loc, {}, {"file"});
  std::string raw_filename = parameters.get("file", "");
  std::string file = lookup_file(raw_filename, loc.filePath().parent_path().string(), parameters.documentRoot());
  return import_json(file, arguments.session(), loc);
}

void register_builtin_functions()
{
  Builtins::init("abs", new BuiltinFunction(&builtin_abs),
  {
    "abs(number) -> number",
  });

  Builtins::init("sign", new BuiltinFunction(&builtin_sign),
  {
    "sign(number) -> -1, 0 or 1",
  });

  Builtins::init("rands", new BuiltinFunction(&builtin_rands),
  {
    "rands(min, max, num_results) -> vector",
    "rands(min, max, num_results, seed) -> vector",
  });

  Builtins::init("min", new BuiltinFunction(&builtin_min),
  {
    "min(number, number, ...) -> number",
    "min(vector) -> number",
  });

  Builtins::init("max", new BuiltinFunction(&builtin_max),
  {
    "max(number, number, ...) -> number",
    "max(vector) -> number",
  });

  Builtins::init("sin", new BuiltinFunction(&builtin_sin),
  {
    "sin(degrees) -> number",
  });

  Builtins::init("cos", new BuiltinFunction(&builtin_cos),
  {
    "cos(degrees) -> number",
  });

  Builtins::init("asin", new BuiltinFunction(&builtin_asin),
  {
    "asin(number) -> degrees",
  });

  Builtins::init("acos", new BuiltinFunction(&builtin_acos),
  {
    "acos(number) -> degrees",
  });

  Builtins::init("tan", new BuiltinFunction(&builtin_tan),
  {
    "tan(degrees) -> number",
  });

  Builtins::init("atan", new BuiltinFunction(&builtin_atan),
  {
    "atan(number) -> degrees",
  });

  Builtins::init("atan2", new BuiltinFunction(&builtin_atan2),
  {
    "atan2(number, number) -> degrees",
  });

  Builtins::init("round", new BuiltinFunction(&builtin_round),
  {
    "round(number) -> number",
  });

  Builtins::init("ceil", new BuiltinFunction(&builtin_ceil),
  {
    "ceil(number) -> number",
  });

  Builtins::init("floor", new BuiltinFunction(&builtin_floor),
  {
    "floor(number) -> number",
  });

  Builtins::init("pow", new BuiltinFunction(&builtin_pow),
  {
    "pow(base, exponent) -> number",
  });

  Builtins::init("sqrt", new BuiltinFunction(&builtin_sqrt),
  {
    "sqrt(number) -> number",
  });

  Builtins::init("exp", new BuiltinFunction(&builtin_exp),
  {
    "exp(number) -> number",
  });

  Builtins::init("len", new BuiltinFunction(&builtin_length),
  {
    "len(string) -> number",
    "len(vector) -> number",
  });

  Builtins::init("log", new BuiltinFunction(&builtin_log),
  {
    "log(number) -> number",
  });

  Builtins::init("ln", new BuiltinFunction(&builtin_ln),
  {
    "ln(number) -> number",
  });

  Builtins::init("str", new BuiltinFunction(&builtin_str),
  {
    "str(number or string, ...) -> string",
  });

  Builtins::init("chr", new BuiltinFunction(&builtin_chr),
  {
    "chr(number) -> string",
    "chr(vector) -> string",
    "chr(range) -> string",
  });

  Builtins::init("textmetrics",
                 new BuiltinFunction(&builtin_textmetrics,
                                     &Feature::ExperimentalTextMetricsFunctions),
  {
    "textmetrics(text, size, font, direction, language, script, halign, valign, spacing) -> object",
  });

  Builtins::init("fontmetrics",
                 new BuiltinFunction(&builtin_fontmetrics,
                                     &Feature::ExperimentalTextMetricsFunctions),
  {
    "fontmetrics(size, font) -> object",
  });

  Builtins::init("ord", new BuiltinFunction(&builtin_ord),
  {
    "ord(string) -> number",
  });

  Builtins::init("concat", new BuiltinFunction(&builtin_concat),
  {
    "concat(number or string or vector, ...) -> vector",
  });

  Builtins::init("lookup", new BuiltinFunction(&builtin_lookup),
  {
    "lookup(key, <key,value> vector) -> value",
  });

  Builtins::init("search", new BuiltinFunction(&builtin_search),
  {
    "search(string , string or vector [, num_returns_per_match [, index_col_num ] ] ) -> vector",
  });

  Builtins::init("version", new BuiltinFunction(&builtin_version),
  {
    "version() -> vector",
  });

  Builtins::init("version_num", new BuiltinFunction(&builtin_version_num),
  {
    "version_num() -> number",
  });

  Builtins::init("norm", new BuiltinFunction(&builtin_norm),
  {
    "norm(vector) -> number",
  });

  Builtins::init("cross", new BuiltinFunction(&builtin_cross),
  {
    "cross(vector, vector) -> vector",
  });

  Builtins::init("parent_module", new BuiltinFunction(&builtin_parent_module),
  {
    "parent_module(number) -> string",
  });

  Builtins::init("is_undef", new BuiltinFunction(&builtin_is_undef),
  {
    "is_undef(arg) -> boolean",
  });

  Builtins::init("is_list", new BuiltinFunction(&builtin_is_list),
  {
    "is_list(arg) -> boolean",
  });

  Builtins::init("is_num", new BuiltinFunction(&builtin_is_num),
  {
    "is_num(arg) -> boolean",
  });

  Builtins::init("is_bool", new BuiltinFunction(&builtin_is_bool),
  {
    "is_bool(arg) -> boolean",
  });

  Builtins::init("is_string", new BuiltinFunction(&builtin_is_string),
  {
    "is_string(arg) -> boolean",
  });

  Builtins::init("is_function", new BuiltinFunction(&builtin_is_function),
  {
    "is_function(arg) -> boolean",
  });

  Builtins::init("is_object", new BuiltinFunction(&builtin_is_object,
                                                  &Feature::ExperimentalTextMetricsFunctions),
  {
    "is_object(arg) -> boolean",
  });

  Builtins::init("import", new BuiltinFunction(&builtin_import, &Feature::ExperimentalImportFunction),
  {
    "import(file) -> object",
  });
}