sdoc.sdoc2.node.ReferenceNode

Complexity

Total Complexity

5

Size/Duplication

Total Lines	50
Duplicated Lines	0 %

5 Methods

Rating	Name	Duplication	Size	Complexity
A	is_block_command()	0	7	1
A	is_inline_command()	0	7	1
A	get_command()	0	7	1
A	__init__()	0	8	1
A	is_phrasing()	0	7	1

"""
SDoc

Copyright 2016 Set Based IT Consultancy

Licence MIT
"""
# ----------------------------------------------------------------------------------------------------------------------
from sdoc.sdoc2 import node_store
from sdoc.sdoc2.node.Node import Node


class ReferenceNode(Node):
    """
    SDoc2 node for references.
    """

    # ------------------------------------------------------------------------------------------------------------------
    def __init__(self, options, argument):
        """
        Object constructor.

        :param dict[str,str] options: The options of this reference.
        :param str argument: The title of this reference.
        """
        super().__init__('ref', options, argument)

    # ------------------------------------------------------------------------------------------------------------------
    def get_command(self):
        """
        Returns the command of this node, i.e. reference.

        :rtype: str
        """
        return 'ref'

    # ------------------------------------------------------------------------------------------------------------------
    def is_block_command(self):
        """
        Returns False.

        :rtype: bool
        """
        return False

    # ------------------------------------------------------------------------------------------------------------------
    def is_inline_command(self):
        """
        Returns True.

        :rtype: bool
        """
        return True

    # ------------------------------------------------------------------------------------------------------------------
    def is_phrasing(self):
        """
        Returns True.

        :rtype: bool
        """
        return True

# ----------------------------------------------------------------------------------------------------------------------
node_store.register_inline_command('ref', ReferenceNode)

Final newline missing