from abc import ABC, abstractmethod
from typing import Optional
from clang import cindex
from devana.syntax_abstraction.syntax import ISyntaxElement
[docs]class ICursorValidate(ABC):
"""An interface that specifies that an object can only work with certain types of clang cursors."""
[docs] @staticmethod
@abstractmethod
def is_cursor_valid(cursor: cindex.Cursor) -> bool:
"""It checks if it is possible to create a valid object on the basis of the rate."""
[docs]class IDefaultCreatable(ABC):
"""The interface of an object that can be created with default sets of values."""
[docs] @classmethod
@abstractmethod
def create_default(cls, parent: Optional = None) -> ISyntaxElement:
"""Create a default, valid instance. Cls parameter allows implementing this method once if
init meets requirements in all derivative types."""
[docs]class IFromCursorCreatable(ABC):
"""The interface of an object that can be created from many clang cursor."""
[docs] @classmethod
@abstractmethod
def from_cursor(cls, cursor: cindex.Cursor, parent: Optional = None) -> Optional[ISyntaxElement]:
"""Create an instance from parsed information from clang. Return None if creation is not possible.
Cls parameter allows implementing this method once if init meets requirements in all derivative types."""
[docs]class IBasicCreatable(IDefaultCreatable, IFromCursorCreatable, ABC):
"""An interface that describes a set of constructors for a code element."""
[docs]class IFromParamsCreatable(ABC):
"""The interface of an object that can be created from many parameters."""
[docs] @classmethod
@abstractmethod
def from_params(cls, *argv) -> ISyntaxElement:
"""Multi-parameter constructor. Similar to the default value, except that it allows
you to set some basic properties."""