Introduce clang_utils.py, compilation_database.py and related changes

[diivm]

• Add utilities for some cindex.py's classes

• Use those utilities to clean up parse.py

• Use class in parse.py and clean

• Add compilation_database.py

closes #19

[kunaltyagi]

Any updates here?

[diivm]

Hey!
Will pick it up in some time, been busy due to college.

[diivm]

@kunaltyagi Please have a look.

[kunaltyagi]

clang_utils.py is left. Will review it sometime soon

[kunaltyagi]

Can we add some documentation for CursorKind, Cursor and Type for a reader?

[diivm]

Can we add some documentation for CursorKind, Cursor and Type for a reader?

@kunaltyagi
You mean apart from this? Or is this fine?

clang-bind/bindings/python/scripts/clang_utils.py

Lines 107 to 134 in b3447ff

	# Docstring template for the classes
	class_docstring = """
	- {class_name} class utilities.
	- {description}
	`check_functions_dict`:
	- Functions that begin with "is_" i.e., checking functions
	- A list of two-tuples: (function_name: str, function_value: function)
	`get_functions_dict`:
	- Functions that begin with "get_" i.e., getter functions
	- A list of two-tuples: (function_name: str, function_value: function)
	`properties_dict`:
	- @property functions
	- A list of two-tuples: (property_name: str, property_value: property)
	"""
	CursorKindUtils.__doc__ = class_docstring.format(
	class_name="CursorKind",
	description="A CursorKind describes the kind of entity that a cursor points to.",
	)
	CursorUtils.__doc__ = class_docstring.format(
	class_name="Cursor",
	description="The Cursor class represents a reference to an element within the AST. It acts as a kind of iterator.",
	)
	TypeUtils.__doc__ = class_docstring.format(
	class_name="Type",
	description="The Type class represents the type of an element in the abstract syntax tree.",
	)

[kunaltyagi]

I'd put some link/see-also comment here: https://github.com/PointCloudLibrary/clang-bind/pull/6/files#diff-ed2336087d363ffe402008e9acaeeddb1fb4bebcaab2ed4e20b04fc0dd790035R103

And in the classes you've linked to, is there some official clang documentation that we can link to? If not, then please add 1 or 2 examples there

[diivm]

I'd put some link/see-also comment here: https://github.com/PointCloudLibrary/clang-bind/pull/6/files#diff-ed2336087d363ffe402008e9acaeeddb1fb4bebcaab2ed4e20b04fc0dd790035R103

And in the classes you've linked to, is there some official clang documentation that we can link to? If not, then please add 1 or 2 examples there

Couldn't find official documentation, but added links to the python API and the description of checks.

[kunaltyagi]

3/6 files ok. Will read the 3 remaining files in more detail soon

[kunaltyagi]

bindings/python/scripts/parse.py left. Need to review manually. GitHub shows a very difficult to read diff

[kunaltyagi]

Filename required here? Shouldn't the db path in L9 solve this?

[diivm]

Filename for the cpp file to be parsed, to get that file's compiler args from the compilation database.
If none, it will return the compiler args for all the files in the compilation db.

[kunaltyagi]

Approved because the parse logic will be changed soon anyways

[kunaltyagi]

Any plans to clean up the commit history?

[diivm]

Any plans to clean up the commit history?

Done 👍

[diivm]

@kunaltyagi Let's merge?