Debian Codegraph @

subprojects/meson-docs/docs/refman/main.py

raw
1 # SPDX-License-Identifier: Apache-2.0
2 # Copyright 2021 The Meson development team
3
4 from pathlib import Path
5 import argparse
6 import typing as T
7
8 from mesonbuild import mlog
9
10 from .loaderbase import LoaderBase
11 from .loaderpickle import LoaderPickle
12 from .loaderyaml import LoaderYAML
13
14 from .generatorbase import GeneratorBase
15 from .generatorjson import GeneratorJSON
16 from .generatorprint import GeneratorPrint
17 from .generatorpickle import GeneratorPickle
18 from .generatormd import GeneratorMD
19 from .generatorman import GeneratorMan
20 from .generatorvim import GeneratorVim
21 from .generatortypes import GeneratorTypes
22 from .generatorc import GeneratorC
23
24 meson_root = Path(__file__).absolute().parents[2]
25
26 def main() -> int:
27 parser = argparse.ArgumentParser(description='Meson reference manual generator')
28 parser.add_argument('-l', '--loader', type=str, default='yaml', choices=['yaml', 'fastyaml', 'pickle'], help='Information loader backend')
29 parser.add_argument('-g', '--generator', type=str, choices=['print', 'pickle', 'md', 'json', 'man', 'vim', 'types', 'c'], required=True, help='Generator backend')
30 parser.add_argument('-s', '--sitemap', type=Path, default=meson_root / 'docs' / 'sitemap.txt', help='Path to the input sitemap.txt')
31 parser.add_argument('-o', '--out', type=Path, required=True, help='Output directory for generated files')
32 parser.add_argument('-i', '--input', type=Path, default=meson_root / 'docs' / 'yaml', help='Input path for the selected loader')
33 parser.add_argument('--link-defs', type=Path, help='Output file for the MD generator link definition file')
34 parser.add_argument('--depfile', type=Path, default=None, help='Set to generate a depfile')
35 parser.add_argument('-q', '--quiet', action='store_true', help='Suppress verbose output')
36 parser.add_argument('--force-color', action='store_true', help='Force enable colors')
37 parser.add_argument('--no-modules', action='store_true', help='Disable building modules')
38 args = parser.parse_args()
39
40 if args.quiet:
41 mlog.set_quiet()
42
43 if args.force_color:
44 mlog.colorize_console = lambda: True
45
46 loaders: T.Dict[str, T.Callable[[], LoaderBase]] = {
47 'yaml': lambda: LoaderYAML(args.input),
48 'fastyaml': lambda: LoaderYAML(args.input, strict=False),
49 'pickle': lambda: LoaderPickle(args.input),
50 }
51
52 loader = loaders[args.loader]()
53 refMan = loader.load()
54
55 generators: T.Dict[str, T.Callable[[], GeneratorBase]] = {
56 'print': lambda: GeneratorPrint(refMan),
57 'pickle': lambda: GeneratorPickle(refMan, args.out),
58 'md': lambda: GeneratorMD(refMan, args.out, args.sitemap, args.link_defs, not args.no_modules),
59 'json': lambda: GeneratorJSON(refMan, args.out, not args.no_modules),
60 'man': lambda: GeneratorMan(refMan, args.out, not args.no_modules),
61 'vim': lambda: GeneratorVim(refMan, args.out),
62 'types': lambda: GeneratorTypes(refMan, args.out, not args.no_modules),
63 'c': lambda: GeneratorC(refMan, args.out, not args.no_modules),
64 }
65 generator = generators[args.generator]()
66
67 # Generate the depfile if required
68 if args.depfile is not None:
69 assert isinstance(args.depfile, Path)
70 assert isinstance(args.out, Path)
71
72 # Also add all files of this package
73 script_files = list(Path(__file__).resolve().parent.glob('**/*.py'))
74 templates = list(Path(__file__).resolve().parent.glob('**/*.mustache'))
75
76 out_text = f'{args.out.resolve().as_posix()}: \\\n'
77 for input in loader.input_files + script_files + templates:
78 out_text += f' {input.resolve().as_posix():<93} \\\n'
79
80 args.depfile.write_text(out_text, encoding='utf-8')
81
82 generator.generate()
83 return 0