scargo.file_generators.clang_parser package

Submodules

scargo.file_generators.clang_parser.data_classes module

class scargo.file_generators.clang_parser.data_classes.ArgumentDescriptor(name: str, data_type: str)

Bases: object

Describes a function argument

class scargo.file_generators.clang_parser.data_classes.ClassDescriptor(name: str, mock_name: str, methods: List[FunctionDescriptor])

Bases: object

Contains class names and function definitions

class scargo.file_generators.clang_parser.data_classes.FunctionDescriptor(name: str, return_type: str, specifiers: Sequence[str], arguments: Sequence[ArgumentDescriptor] = ())

Bases: object

Contains function name and types

get_arg_names() → str

get_arg_types() → str

get_specifiers() → str

get_typed_args() → str

class scargo.file_generators.clang_parser.data_classes.HeaderDescriptor(name: str, classes: List[ClassDescriptor], namespaces: List[NamespaceDescriptor], includes: List[IncludeDescriptor])

Bases: object

Parsed header definitions

class scargo.file_generators.clang_parser.data_classes.IncludeDescriptor(name: str)

Bases: object

class scargo.file_generators.clang_parser.data_classes.NamespaceDescriptor(name: str)

Bases: object

scargo.file_generators.clang_parser.header_parser module

scargo.file_generators.clang_parser.header_parser.parse_file(file_path: Path) → HeaderDescriptor

TODO documentation look here for available types which can be extracted https://clang.llvm.org/doxygen/group__CINDEX.html This function receives a path with file name as an argument and returns list of includes, i.e. every string that starts with “#include”, dict of classes where keys are “public”, “private” and “mock_class_name” and list of namespaces, i.e. strings that start with “namespace”.

scargo.file_generators.clang_parser.params_extractor module

scargo.file_generators.clang_parser.params_extractor.extract_classes(cursor: Cursor, filename: str) → List[ClassDescriptor]

scargo.file_generators.clang_parser.params_extractor.extract_includes(cursor: Cursor, filename: str) → List[IncludeDescriptor]

scargo.file_generators.clang_parser.params_extractor.extract_namespaces(cursor: Cursor, filename: str) → List[NamespaceDescriptor]

Module contents