jswrap_number.c

/*
 * This file is part of Espruino, a JavaScript interpreter for Microcontrollers
 *
 * Copyright (C) 2013 Gordon Williams <gw@pur3.co.uk>
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * ----------------------------------------------------------------------------
 * This file is designed to be parsed during the build process
 *
 * JavaScript methods for Numbers
 * ----------------------------------------------------------------------------
 */
#include "jswrap_number.h"

/*JSON{
  "type" : "class",
  "class" : "Number",
  "check" : "jsvIsNumeric(var)"
}
This is the built-in JavaScript class for numbers.
 */

/*JSON{
  "type" : "constructor",
  "class" : "Number",
  "name" : "Number",
  "generate" : "jswrap_number_constructor",
  "params" : [
    ["value","JsVarArray","A single value to be converted to a number"]
  ],
  "return" : ["JsVar","A Number object"],
  "typescript" : [
    "new(...value: any[]): Number;",
    "(value: any): number;"
  ]
}
Creates a number
 */
JsVar *jswrap_number_constructor(JsVar *args) {
  if (jsvGetArrayLength(args)==0) return jsvNewFromInteger(0);
  JsVar *val = jsvGetArrayItem(args, 0);
  JsVar *result = 0;

  if (jsvIsArray(val)) {
    JsVarInt l = jsvGetArrayLength(val);
    if (l==0) result = jsvNewFromInteger(0);
    else if (l==1) {
      JsVar *n = jsvGetArrayItem(val, 0);
      if (jsvIsString(n) && jsvIsEmptyString(n)) result = jsvNewFromInteger(0);
      else if (!jsvIsBoolean(n)) result=jsvAsNumber(n);
      jsvUnLock(n);
    } // else NaN
  } else if (jsvIsUndefined(val) || jsvIsObject(val))
    result = 0;
  else {
    if (jsvIsString(val) && jsvIsEmptyString(val)) {
      result = jsvNewFromInteger(0);
    } else
      result = jsvAsNumber(val);
  }
  jsvUnLock(val);
  if (result) return result;
  return jsvNewFromFloat(NAN);
}


/*JSON{
  "type" : "variable",
  "name" : "NaN",
  "generate_full" : "NAN",
  "return" : ["float","Not a  Number"]
}*/

/*JSON{
  "type" : "variable",
  "name" : "Infinity",
  "generate_full" : "INFINITY",
  "return" : ["float","Positive Infinity (1/0)"]
}*/

/*JSON{
  "type" : "staticproperty",
  "class" : "Number",
  "name" : "NaN",
  "generate_full" : "NAN",
  "return" : ["float","Not a  Number"]
}*/

/*JSON{
  "type" : "staticproperty",
  "class" : "Number",
  "name" : "MAX_VALUE",
  "generate_full" : "DBL_MAX",
  "return" : ["float","Maximum representable value"]
}*/

/*JSON{
  "type" : "staticproperty",
  "class" : "Number",
  "name" : "MIN_VALUE",
  "generate_full" : "DBL_MIN",
  "return" : ["float","Smallest representable value"]
}*/

/*JSON{
  "type" : "staticproperty",
  "class" : "Number",
  "name" : "NEGATIVE_INFINITY",
  "generate_full" : "-INFINITY",
  "return" : ["float","Negative Infinity (-1/0)"]
}*/

/*JSON{
  "type" : "staticproperty",
  "class" : "Number",
  "name" : "POSITIVE_INFINITY",
  "generate_full" : "INFINITY",
  "return" : ["float","Positive Infinity (1/0)"]
}*/

/*JSON{
  "type" : "method",
  "class" : "Number",
  "name" : "toFixed",
  "generate" : "jswrap_number_toFixed",
  "params" : [
    ["decimalPlaces","int32","A number between 0 and 20 specifying the number of decimal digits after the decimal point"]
  ],
  "return" : ["JsVar","A string"]
}
Format the number as a fixed point number
 */
JsVar *jswrap_number_toFixed(JsVar *parent, int decimals) {
  if (decimals<0) decimals=0;
  if (decimals>20) decimals=20;
  char buf[JS_NUMBER_BUFFER_SIZE];
  ftoa_bounded_extra(jsvGetFloat(parent), buf, sizeof(buf), 10, decimals);
  return jsvNewFromString(buf);
}

/*JSON{
  "type" : "variable",
  "name" : "HIGH",
  "generate_full" : "1",
  "return" : ["int32","Logic 1 for Arduino compatibility - this is the same as just typing `1`"],
  "typescript" : "declare const HIGH: true;"
}*/

/*JSON{
  "type" : "variable",
  "name" : "LOW",
  "generate_full" : "0",
  "return" : ["int32","Logic 0 for Arduino compatibility - this is the same as just typing `0`"],
  "typescript" : "declare const LOW: false;"
}*/