60 lines · 2.1 KB · Python
RawDownload
#!/usr/bin/env python3# SPDX-License-Identifier: GPL-2.0# Copyright (c) 2016, 2025 by Mauro Carvalho Chehab <mchehab@kernel.org>.# pylint: disable=C0103 """Convert a C header or source file ``FILE_IN``, into a ReStructured Textincluded via ..parsed-literal block with cross-references for thedocumentation files that describe the API. It accepts an optional``FILE_RULES`` file to describes what elements will be either ignored orbe pointed to a non-default reference type/name. The output is written at ``FILE_OUT``. It is capable of identifying defines, functions, structs, typedefs,enums and enum symbols and create cross-references for all of them.It is also capable of distinguish #define used for specifying a Linuxioctl. The optional ``FILE_RULES`` contains a set of rules like:     ignore ioctl VIDIOC_ENUM_FMT    replace ioctl VIDIOC_DQBUF vidioc_qbuf    replace define V4L2_EVENT_MD_FL_HAVE_FRAME_SEQ :c:type:`v4l2_event_motion_det`""" import argparse, sysimport os.path src_dir = os.path.dirname(os.path.realpath(__file__))sys.path.insert(0, os.path.join(src_dir, '../lib/python'))from kdoc.parse_data_structs import ParseDataStructsfrom kdoc.enrich_formatter import EnrichFormatter def main():    """Main function"""    parser = argparse.ArgumentParser(description=__doc__,                                     formatter_class=EnrichFormatter)     parser.add_argument("-d", "--debug", action="count", default=0,                        help="Increase debug level. Can be used multiple times")    parser.add_argument("-t", "--toc", action="store_true",                        help="instead of a literal block, outputs a TOC table at the RST file")     parser.add_argument("file_in", help="Input C file")    parser.add_argument("file_out", help="Output RST file")    parser.add_argument("file_rules", nargs="?",                        help="Exceptions file (optional)")     args = parser.parse_args()     parser = ParseDataStructs(debug=args.debug)    parser.parse_file(args.file_in, args.file_rules)     parser.debug_print()    parser.write_output(args.file_in, args.file_out, args.toc)  if __name__ == "__main__":    main()