Source code for psyclone.psyir.nodes.unknown_directive

# -----------------------------------------------------------------------------
# BSD 3-Clause License
#
# Copyright (c) 2025-2026, Science and Technology Facilities Council.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice, this
#   list of conditions and the following disclaimer.
#
# * Redistributions in binary form must reproduce the above copyright notice,
#   this list of conditions and the following disclaimer in the documentation
#   and/or other materials provided with the distribution.
#
# * Neither the name of the copyright holder nor the names of its
#   contributors may be used to endorse or promote products derived from
#   this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
# FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
# COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
# BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
# -----------------------------------------------------------------------------
# Authors A. B. G. Chalk and S. Siso, STFC Daresbury Lab.
# -----------------------------------------------------------------------------

''' This module contains the UnknownDirective node implementation.'''

from psyclone.psyir.nodes.directive import StandaloneDirective




class UnknownDirective(StandaloneDirective):
    '''
    Directive representing PSyclone-specific directives in the tree.

    :param directive_string: The content after the sentinel part of this
        directive (e.g. !$CONTENT).
    :param sentinel_infix_string: The content inside the sentinel part of this
        directive (e.g. !CONTENT$).
    :param kwargs: additional keyword arguments provided to the PSyIR node.

    :raises TypeError: if any of the provided strings are not a str.

    '''

    _children_valid_format = "<LeafNode>"

    def __init__(
        self,
        directive_string: str = "",
        sentinel_infix_string: str = "",
        **kwargs
    ):
        super().__init__(**kwargs)
        if not isinstance(directive_string, str):
            raise TypeError(
                f"'directive_string' must be a 'str' but found "
                f"'{type(directive_string).__name__}'")
        if not isinstance(sentinel_infix_string, str):
            raise TypeError(
                f"'sentinel_infix_string' must be a 'str' but found "
                f"'{type(sentinel_infix_string).__name__}'")
        self._directive_string = directive_string
        self._sentinel_infix_string = sentinel_infix_string

    @staticmethod
    def _validate_child(position, child):
        '''
        :param int position: the position to be validated.
        :param child: a child to be validated.
        :type child: :py:class:`psyclone.psyir.nodes.Node`

        :return: whether the given child and position are valid for this node.
        :rtype: bool

        '''
        return False

    @property
    def directive_string(self) -> str:
        '''
        :returns: The content of this UnknownDirective node.
        '''
        return self._directive_string

    @property
    def sentinel_infix_string(self) -> str:
        '''
        :returns: The content inside the directive sentinel of this
            UnknownDirective node (e.g. in Fortran this is the string
            between the ! and $ such as in !DIR$ or !GCC$).
        '''
        return self._sentinel_infix_string