#!/usr/bin/env python3 import os, sys, getopt, re, pickle import subprocess class State: SearchTitle = 0 SearchEndTitle = 1 SearchStartAPI = 2 SearchEndAPI = 3 DoneAPI = 4 api_files = [] functions = {} typedefs = {} api_header = """ ## API_TITLE API {#sec:API_LABLEAPIAppendix} """ api_ending = """ """ code_ref = """GITHUBFPATH#LLINENR""" def isEndOfComment(line): return re.match('\s*\*/.*', line) def isStartOfComment(line): return re.match('\s*\/\*/.*', line) def isTypedefStart(line): return re.match('.*typedef\s+struct.*', line) def codeReference(fname, githuburl, filepath, linenr): global code_ref ref = code_ref.replace("GITHUB", githuburl) ref = ref.replace("FPATH", filepath) ref = ref.replace("LINENR", str(linenr)) return ref def writeAPI(fout, fin, mk_codeidentation): state = State.SearchStartAPI for line in fin: if state == State.SearchStartAPI: parts = re.match('.*API_START.*',line) if parts: state = State.SearchEndAPI continue if state == State.SearchEndAPI: parts = re.match('.*API_END.*',line) if parts: state = State.DoneAPI continue fout.write(mk_codeidentation + line) continue linenr = 0 typedefFound = 0 multiline_function_def = 0 state = State.SearchStartAPI def createIndex(fin, api_filename, api_title, api_lable, githuburl): global typedefs, functions global linenr, multiline_function_def, typedefFound, state for line in fin: if state == State.DoneAPI: continue linenr = linenr + 1 if state == State.SearchStartAPI: parts = re.match('.*API_START.*',line) if parts: state = State.SearchEndAPI continue if state == State.SearchEndAPI: parts = re.match('.*API_END.*',line) if parts: state = State.DoneAPI continue if multiline_function_def: function_end = re.match('.*;\n', line) if function_end: multiline_function_def = 0 continue param = re.match(".*@brief.*", line) if param: continue param = re.match(".*@param.*", line) if param: continue param = re.match(".*@return.*", line) if param: continue # search typedef struct begin if isTypedefStart(line): typedefFound = 1 # search typedef struct end if typedefFound: typedef = re.match('}\s*(.*);\n', line) if typedef: typedefFound = 0 typedefs[typedef.group(1)] = codeReference(typedef.group(1), githuburl, api_filename, linenr) continue ref_function = re.match('.*typedef\s+void\s+\(\s*\*\s*(.*?)\)\(.*', line) if ref_function: functions[ref_function.group(1)] = codeReference(ref_function.group(1), githuburl, api_filename, linenr) continue one_line_function_definition = re.match('(.*?)\s*\(.*\(*.*;\n', line) if one_line_function_definition: parts = one_line_function_definition.group(1).split(" "); name = parts[len(parts)-1] if len(name) == 0: print(parts); sys.exit(10) functions[name] = codeReference( name, githuburl, api_filename, linenr) continue multi_line_function_definition = re.match('.(.*?)\s*\(.*\(*.*', line) if multi_line_function_definition: parts = multi_line_function_definition.group(1).split(" "); name = parts[len(parts)-1] if len(name) == 0: print(parts); sys.exit(10) multiline_function_def = 1 functions[name] = codeReference(name, githuburl, api_filename, linenr) def findTitle(fin): title = None desc = "" state = State.SearchTitle for line in fin: if state == State.SearchTitle: if isStartOfComment(line): continue parts = re.match('.*(@title)(.*)', line) if parts: title = parts.group(2).strip() state = State.SearchEndTitle continue if state == State.SearchEndTitle: if (isEndOfComment(line)): state = State.DoneAPI break parts = re.match('(\s*\*\s*)(.*\n)',line) if parts: desc = desc + parts.group(2) return title, desc def main(argv): global linenr, multiline_function_def, typedefFound, state mk_codeidentation = " " git_branch_name = "master" btstackfolder = "../../" githuburl = "https://github.com/bluekitchen/btstack/blob/master/" markdownfolder = "docs-markdown/" cmd = 'markdown_create_apis.py [-r ] [-g ] [-o ]' try: opts, args = getopt.getopt(argv,"r:g:o:",["rfolder=","github=","ofolder="]) except getopt.GetoptError: print (cmd) sys.exit(2) for opt, arg in opts: if opt == '-h': print (cmd) sys.exit() elif opt in ("-r", "--rfolder"): btstackfolder = arg elif opt in ("-g", "--github"): githuburl = arg elif opt in ("-o", "--ofolder"): markdownfolder = arg apifile = markdownfolder + "appendix/apis.md" # indexfile = markdownfolder + "api_index.md" btstack_srcfolder = btstackfolder + "src/" try: output = subprocess.check_output("git symbolic-ref --short HEAD", stderr=subprocess.STDOUT, timeout=3, shell=True) git_branch_name = output.decode().rstrip() except subprocess.CalledProcessError as exc: print('GIT branch name: failed to get, use default value \"%s\"" ', git_branch_name, exc.returncode, exc.output) else: print ('GIT branch name : %s' % git_branch_name) githuburl = githuburl + git_branch_name print ('BTstack src folder is : ' + btstack_srcfolder) print ('API file is : ' + apifile) print ('Github URL is : ' + githuburl) # print ('Index file is : ' + indexfile) for root, dirs, files in os.walk(btstack_srcfolder, topdown=True): for f in files: if not f.endswith(".h"): continue api_files.append(root + "/" + f) api_files.sort() print(api_files) with open(apifile, 'w') as fout: fout.write("#\n\n") for api_filename in api_files: api_title = None api_lable = None print(api_filename) with open(api_filename, 'r') as fin: api_title, api_desc = findTitle(fin) if api_title: api_lable = f[:-2] title = api_header.replace("API_TITLE", api_title).replace("API_LABLE", api_lable) fout.write(title) fout.write(api_desc) writeAPI(fout, fin, mk_codeidentation) fin.close() if api_title: linenr = 0 typedefFound = 0 multiline_function_def = 0 state = State.SearchStartAPI with open(api_filename, 'r') as fin: createIndex(fin, api_filename, api_title, api_lable, githuburl) fin.close() for function in functions: parts = function.split(' ') if (len(parts) > 1): print (parts) references = functions.copy() references.update(typedefs) # with open(indexfile, 'w') as fout: # for function, reference in references.items(): # fout.write("[" + function + "](" + reference + ")\n") pickle.dump(references, open("references.p", "wb" ) ) if __name__ == "__main__": main(sys.argv[1:])