10 """gen_std.py is a tool to generate a lookup table (from qualified names to
11 include headers) for C/C++ Standard Library symbols by parsing archieved HTML
12 files from cppreference.
15 - only symbols directly in "std" namespace are added, we should also add std's
16 subnamespace symbols (e.g. chrono).
17 - symbols with multiple variants or defined in multiple headers aren't added,
18 e.g. std::move, std::swap
21 1. Install BeautifulSoup dependency, see instruction:
22 https://www.crummy.com/software/BeautifulSoup/bs4/doc/#installing-beautiful-soup
23 2. Download cppreference offline HTML files (e.g. html_book_20181028.zip) at
24 https://en.cppreference.com/w/Cppreference:Archives
25 3. Unzip the zip file from step 2 to directory </cppreference>, you should
26 get a "reference" directory in </cppreference>
28 // Generate C++ symbols
29 gen_std.py -cppreference </cppreference/reference> -language=cpp > StdSymbolMap.inc
31 gen_std.py -cppreference </cppreference/reference> -language=c > CSymbolMap.inc
35 import cppreference_parser
42 //===-- gen_std.py generated file -------------------------------*- C++ -*-===//
44 // Used to build a lookup table (qualified names => include headers) for %s
45 // Standard Library symbols.
47 // Automatically generated file, DO NOT EDIT!
49 // Generated from cppreference offline HTML book (modified on %s).
50 //===----------------------------------------------------------------------===//
54 parser = argparse.ArgumentParser(description=
'Generate StdGen file')
55 parser.add_argument(
'-cppreference', metavar=
'PATH',
57 help=
'path to the cppreference offline HTML directory',
60 parser.add_argument(
'-language',
62 help=
'Generate c or cpp symbols',
64 return parser.parse_args()
69 if args.language ==
'cpp':
70 page_root = os.path.join(args.cppreference,
"en",
"cpp")
71 symbol_index_root = os.path.join(page_root,
"symbol_index")
73 (page_root,
"symbol_index.html",
"std::"),
81 (symbol_index_root,
"chrono.html",
"std::chrono::"),
82 (symbol_index_root,
"filesystem.html",
"std::filesystem::"),
83 (symbol_index_root,
"pmr.html",
"std::pmr::"),
84 (symbol_index_root,
"regex_constants.html",
"std::regex_constants::"),
85 (symbol_index_root,
"this_thread.html",
"std::this_thread::"),
87 elif args.language ==
'c':
88 page_root = os.path.join(args.cppreference,
"en",
"c")
89 symbol_index_root = page_root
90 parse_pages = [(page_root,
"index.html",
None)]
92 if not os.path.exists(symbol_index_root):
93 exit(
"Path %s doesn't exist!" % symbol_index_root)
99 index_page_path = os.path.join(page_root,
"index.html")
100 cppreference_modified_date = datetime.datetime.fromtimestamp(
101 os.stat(index_page_path).st_mtime).strftime(
'%Y-%m-%d')
102 print CODE_PREFIX % (args.language.upper(), cppreference_modified_date)
103 for symbol
in symbols:
104 if len(symbol.headers) == 1:
106 print "SYMBOL(%s, %s, %s)" % (symbol.name, symbol.namespace,
108 elif len(symbol.headers) == 0:
109 sys.stderr.write(
"No header found for symbol %s\n" % symbol.name)
112 sys.stderr.write(
"Ambiguous header for symbol %s: %s\n" % (
113 symbol.name,
', '.
join(symbol.headers)))
116 if __name__ ==
'__main__':