-
-
Notifications
You must be signed in to change notification settings - Fork 166
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add all current flags and implement opt shortening
- Loading branch information
Showing
4 changed files
with
667 additions
and
138 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,221 @@ | ||
| #!/usr/bin/env python3 | ||
| # | ||
| # This script assumes ../curl/ is a git repo containing curl's source code | ||
| # and extracts the list of arguments curl accepts and writes the result as | ||
| # two JS objects (one for --long-options and one for -s (short) options) | ||
| # to curl-to-go.js. | ||
|
|
||
| from pathlib import Path | ||
| import sys | ||
| import subprocess | ||
| from collections import Counter | ||
|
|
||
| # Git repo of curl's source code to extract the args from | ||
| # TODO: make CURL_REPO and OUTPUT_FILE command line args? | ||
| CURL_REPO = Path(__file__).parent / "../curl" | ||
| INPUT_FILE = CURL_REPO / "src" / "tool_getparam.c" | ||
|
|
||
| OUTPUT_FILE = Path(__file__).parent / "resources/js/curl-to-go.js" | ||
|
|
||
|
|
||
| JS_PARAMS_START = "BEGIN GENERATED CURL OPTIONS" | ||
| JS_PARAMS_END = "END GENERATED CURL OPTIONS" | ||
|
|
||
| OPTS_START = "struct LongShort aliases[]= {" | ||
| OPTS_END = "};" | ||
|
|
||
| BOOL_TYPES = ["bool", "none"] | ||
| STR_TYPES = ["string", "filename"] | ||
| ALIAS_TYPES = BOOL_TYPES + STR_TYPES | ||
|
|
||
| DUPES = { | ||
| "krb": "krb", | ||
| "krb4": "krb", | ||
| "ftp-ssl": "ssl", | ||
| "ssl": "ssl", | ||
| "ftp-ssl-reqd": "ssl-reqd", | ||
| "ssl-reqd": "ssl-reqd", | ||
| "proxy-service-name": "proxy-service-name", | ||
| "socks5-gssapi-service": "proxy-service-name", | ||
| } | ||
|
|
||
| if not OUTPUT_FILE.is_file(): | ||
| sys.exit( | ||
| f"{OUTPUT_FILE} doesn't exist. You should run this script from curl-to-go/" | ||
| ) | ||
| if not CURL_REPO.is_dir(): | ||
| sys.exit( | ||
| f"{CURL_REPO} needs to be a git repo with curl's source code. " | ||
| "You can clone it with\n\n" | ||
| "git clone https://github.com/curl/curl ../curl" | ||
| # or modify the CURL_REPO variable above | ||
| ) | ||
|
|
||
|
|
||
| def on_git_master(git_dir): | ||
| curl_branch = subprocess.run( | ||
| ["git", "rev-parse", "--abbrev-ref", "HEAD"], | ||
| cwd=git_dir, | ||
| check=True, | ||
| capture_output=True, | ||
| text=True, | ||
| ).stdout.strip() | ||
| return curl_branch == "master" | ||
|
|
||
|
|
||
| def parse_aliases(lines): | ||
| aliases = {} | ||
| for line in lines: | ||
| if OPTS_START in line: | ||
| break | ||
| for line in lines: | ||
| line = line.strip() | ||
| if line.endswith(OPTS_END): | ||
| break | ||
| if not line.strip().startswith("{"): | ||
| continue | ||
|
|
||
| # main.c has comments on the same line | ||
| letter, lname, desc = line.split("/*")[0].strip().strip("{},").split(",") | ||
|
|
||
| letter = letter.strip().strip('"') | ||
| lname = lname.strip().strip('"') | ||
| desc = desc.strip() | ||
|
|
||
| if 1 > len(letter) > 2: | ||
| raise ValueError(f"letter form of --{lname} must be 1 or 2 characters long") | ||
|
|
||
| # Simplify "desc" | ||
| alias_type = desc.removeprefix("ARG_").lower() | ||
| if alias_type == "filename": | ||
| alias_type = "string" | ||
| if alias_type not in ALIAS_TYPES: | ||
| raise ValueError(f"unknown desc: {desc!r}") | ||
| # TODO: some "string" arguments should be "list"s | ||
|
|
||
| # Rename "desc" to "type" | ||
| alias = {"letter": letter, "lname": lname, "type": alias_type} | ||
|
|
||
| if lname in aliases and aliases[lname] != alias: | ||
| print( | ||
| f"{lname!r} repeated with different values: {aliases[lname]} vs. {alias} ", | ||
| file=sys.stderr, | ||
| ) | ||
|
|
||
| aliases[lname] = alias | ||
|
|
||
| return list(aliases.values()) | ||
|
|
||
|
|
||
| def fill_out_aliases(aliases): | ||
| # If both --option and --other-option have "oO" (for example) as their `letter`, | ||
| # add a "name" property with the main option's `lname` | ||
| letter_count = Counter(a["letter"] for a in aliases) | ||
|
|
||
| # "ARB_BOOL"-type OPTIONs have a --no-OPTION counterpart | ||
| no_aliases = [] | ||
|
|
||
| for idx, alias in enumerate(aliases): | ||
| if alias["type"] in BOOL_TYPES: | ||
| without_no = alias["lname"].removeprefix("no-").removeprefix("disable-") | ||
| if alias["lname"] != without_no: | ||
| print(f"Assuming --{alias['lname']} is {without_no!r}", file=sys.stderr) | ||
| alias["name"] = without_no | ||
|
|
||
| if letter_count[alias["letter"]] > 1: | ||
| # Can raise KeyError | ||
| # todo lname vs name? might need some get()s technically? | ||
| candidate = DUPES[alias["lname"]] | ||
| if alias["lname"] != candidate: | ||
| # name, not lname | ||
| alias["name"] = candidate | ||
|
|
||
| if alias["type"] == "bool": | ||
| no_alias = {**alias, "lname": "no-" + alias["lname"]} | ||
| if "name" not in no_alias: | ||
| no_alias["name"] = alias["lname"] | ||
| # --no-OPTION options cannot be shortened | ||
| no_alias["expand"] = False | ||
| no_aliases.append((idx, no_alias)) | ||
| elif alias["type"] == "none": | ||
| # The none/bool distinction becomes irrelevant after the step above | ||
| alias["type"] = "bool" | ||
|
|
||
| for i, (insert_loc, no_alias) in enumerate(no_aliases): | ||
| # +1 so that --no-OPTION appears after --OPTION | ||
| aliases.insert(insert_loc + i + 1, no_alias) | ||
|
|
||
| return aliases | ||
|
|
||
|
|
||
| def split(aliases): | ||
| long_args = {} | ||
| short_args = {} | ||
| for alias in aliases: | ||
| long_args[alias["lname"]] = { | ||
| k: v for k, v in alias.items() if k not in ["letter", "lname"] | ||
| } | ||
| if len(alias["letter"]) == 1: | ||
| alias_name = alias.get("name", alias["lname"]) | ||
| if alias["letter"] == "N": # -N is short for --no-buffer | ||
| alias_name = "no-" + alias_name | ||
| short_args[alias["letter"]] = alias_name | ||
| return long_args, short_args | ||
|
|
||
|
|
||
| def format_as_js(d, var_name): | ||
| yield f"\tvar {var_name} = {{" | ||
| for top_key, opt in d.items(): | ||
|
|
||
| def quote(key): | ||
| return key if key.isalpha() else repr(key) | ||
|
|
||
| def val_to_js(val): | ||
| if isinstance(val, str): | ||
| return repr(val) | ||
| if isinstance(val, bool): | ||
| return str(val).lower() | ||
| raise TypeError(f"can't convert values of type {type(val)} to JS") | ||
|
|
||
| if isinstance(opt, dict): | ||
| vals = [f"{quote(k)}: {val_to_js(v)}" for k, v in opt.items()] | ||
| yield f"\t\t{top_key!r}: {{{', '.join(vals)}}}," | ||
| elif isinstance(opt, str): | ||
| yield f"\t\t{top_key!r}: {val_to_js(opt)}," | ||
|
|
||
| yield "\t};" | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| if not on_git_master(CURL_REPO): | ||
| sys.exit("not on curl repo's git master") | ||
|
|
||
| with open(INPUT_FILE) as f: | ||
| aliases = fill_out_aliases(parse_aliases(f)) | ||
| long_args, short_args = split(aliases) | ||
|
|
||
| js_params_lines = list(format_as_js(long_args, "longOptions")) | ||
| js_params_lines += [""] # separate by a newline | ||
| js_params_lines += list(format_as_js(short_args, "shortOptions")) | ||
|
|
||
| new_lines = [] | ||
| with open(OUTPUT_FILE) as f: | ||
| for line in f: | ||
| new_lines.append(line) | ||
| if JS_PARAMS_START in line: | ||
| break | ||
| else: | ||
| raise ValueError(f"{'// ' + JS_PARAMS_START!r} not in {OUTPUT_FILE}") | ||
|
|
||
| new_lines += [l + "\n" for l in js_params_lines] | ||
| for line in f: | ||
| if JS_PARAMS_END in line: | ||
| new_lines.append(line) | ||
| break | ||
| else: | ||
| raise ValueError(f"{'// ' + JS_PARAMS_END!r} not in {OUTPUT_FILE}") | ||
| for line in f: | ||
| new_lines.append(line) | ||
|
|
||
| with open(OUTPUT_FILE, "w", newline="\n") as f: | ||
| f.write("".join(new_lines)) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.