#!/bin/false

# 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/.
#
# ----------------------------------------------------------------------------------------
# Reads board information from boards/BOARDNAME.py - used by build_board_docs, 
# build_pininfo, and build_platform_config
# ----------------------------------------------------------------------------------------

import subprocess;
import re;
import json;
import sys;
import os;

# Scans files for comments of the form /*JSON......*/ 
# 
# Comments look like:
#
#/*JSON{ "type":"staticmethod|staticproperty|constructor|method|property|function|variable",
#         "class" : "Double", "name" : "doubleToIntBits",
#         "needs_parentName":true,           // optional - if for a method, this makes the first 2 args parent+parentName (not just parent)
#         "generate_full|generate|wrap" : "*(JsVarInt*)&x",
#         "description" : " Convert the floating point value given into an integer representing the bits contained in it",
#         "params" : [ [ "x" , "float|int|JsVar|JsVarName", "A floating point number"] ],
#         "return" : ["int|float", "The integer representation of x"],
#         "no_create_links":1                // optional - if this is set then hyperlinks are not created when this name is mentioned (good example = bit() )
#         "not_real_object" : "anything",    // optional - for classes, this means we shouldn't treat this as a built-in object, as internally it isn't stored in a JSV_OBJECT
#         "prototype" : "Object",    // optional - for classes, this is what their prototype is. It's particlarly helpful if not_real_object, because there is no prototype var in that case
#         "check" : "jsvIsFoo(var)", // for classes - this is code that returns true if 'var' is of the given type
#         "ifndef" : "SAVE_ON_FLASH", // if the given preprocessor macro is defined, don't implement this
#         "ifdef" : "USE_LCD_FOO", // if the given preprocessor macro isn't defined, don't implement this
#}*/
#
# description can be an array of strings as well as a simple string (in which case each element is separated by a newline),
# and adding ```sometext``` in the description surrounds it with HTML code tags
#


def get_jsondata(is_for_document):
        scriptdir = os.path.dirname	(os.path.realpath(__file__))
        print "Script location "+scriptdir
        os.chdir(scriptdir+"/..")

        jswraps = []
        defines = []

        if len(sys.argv)>1:
          print "Using files from command line"
          for i in range(1,len(sys.argv)):
            arg = sys.argv[i]
            if arg[0]=="-":
              if arg[1]=="D": 
                defines.append(arg[2:])
              else:
                print "Unknown command-line option"
                exit(1)
            else:
              jswraps.append(arg)
        else:
          print "Scanning for jswrap.c files"
          jswraps = subprocess.check_output(["find", ".", "-name", "jswrap*.c"]).strip().split("\n")

        if len(defines)>1:
          print "Got #DEFINES:"
          for d in defines: print d

        jsondatas = []
        for jswrap in jswraps:
          # ignore anything from archives
          if jswrap.startswith("./archives/"): continue

          # now scan
          print "Scanning "+jswrap
          code = open(jswrap, "r").read()

          if is_for_document and "DO_NOT_INCLUDE_IN_DOCS" in code: 
            print "FOUND 'DO_NOT_INCLUDE_IN_DOCS' IN FILE "+jswrap
            continue

          for comment in re.findall(r"/\*JSON.*?\*/", code, re.VERBOSE | re.MULTILINE | re.DOTALL):
            jsonstring = comment[6:-2]
            print "Parsing "+jsonstring
            try:
              jsondata = json.loads(jsonstring)
              jsondata["filename"] = jswrap
              jsondata["include"] = jswrap[:-2]+".h"
              if ("ifndef" in jsondata) and (jsondata["ifndef"] in defines):
                print "Dropped because of #ifndef "+jsondata["ifndef"]
              if ("ifdef" in jsondata) and not (jsondata["ifdef"] in defines):
                print "Dropped because of #ifdef "+jsondata["ifdef"]
              else:
                jsondatas.append(jsondata)
            except ValueError as e:
              print "JSON PARSE FAILED -",  e
              exit(1)
            except:
              print "JSON PARSE FAILED",  sys.exc_info()[0]
              exit(1)
        print "Scanning finished."
        return jsondatas

def get_includes_from_jsondata(jsondatas):
        includes = []
        for jsondata in jsondatas:
          include = jsondata["include"]
          if not include in includes:
                includes.append(include)
        return includes

def is_property(jsondata):
  return jsondata["type"]=="property" or jsondata["type"]=="staticproperty"

def get_version():
        scriptdir = os.path.dirname	(os.path.realpath(__file__))
        jsutils = scriptdir+"/../src/jsutils.h"
        return subprocess.check_output(["sed", "-ne", "s/^.*JS_VERSION.*\"\(.*\)\"/\\1/p", jsutils]).strip()

def get_name_or_space(jsondata):
        if "name" in jsondata: return jsondata["name"]
        return ""