file modules/infomsg.py

[No description available]

Namespaces #

Classes #

Source code #

##################################
#                                #
#  Info message module for BOSS  #
#                                #
##################################

from __future__ import print_function
import modules.gb as gb

# ====== Module-level globals ========

# Set of currently active message types, used by the function clearInfoMessages.
active_msg_types = set()

# ====== END: Module-level globals ========



# ====== Info message base class ========

class InfoMessage(object):
    """Base class for BOSS info messages."""

    def __init__(self):
        global active_msg_types
        active_msg_types.add(self.__class__)


    def printMessage(self):
        """
        Print the info message of the child class
        and add the message tag to the list of
        tags done.
        """        
        if self.tag not in self.__class__.tags_done:
            self.__class__.tags_done.add(self.tag)
            print('  - ' + self.msg)

# ====== END: Info message base class ========



# ====== List of info message classes ========


class ClassNotLoadable(InfoMessage):

    msg = gb.textmods['yellow'] +  "The class '%s' is not loadable." + gb.textmods['end']
    tags_done = set()

    def __init__(self, tag, reason=''):
        self.tag = tag
        self.msgmsg = self.__class__.msg % (tag)
        if bool(reason): self.msgmsg += " (%s)" % reason
        InfoMessage.__init__(self)


class ClassAlreadyDone(InfoMessage):

    msg = "Class '%s' is already done."
    tags_done = set()

    def __init__(self, tag, reason=''):
        self.tag = tag
        self.msgmsg = self.__class__.msg % (tag)
        if bool(reason): self.msgmsg += " (%s)" % reason
        InfoMessage.__init__(self)


class FunctionAlreadyDone(InfoMessage):

    msg = "Function '%s' is already done."
    tags_done = set()

    def __init__(self, tag, reason=''):
        self.tag = tag
        self.msgmsg = self.__class__.msg % (tag)
        if bool(reason): self.msgmsg += " (%s)" % reason
        InfoMessage.__init__(self)


class ParentClassIgnored(InfoMessage):

    msg = gb.textmods['yellow'] +  "In class '%s', the parent class '%s' is ignored." + gb.textmods['end']
    tags_done = set()

    def __init__(self, tag, parent_class, reason=''):
        self.tag = tag
        self.msgmsg = self.__class__.msg % (tag, parent_class)
        if bool(reason): self.msgmsg += " (%s)" % reason
        InfoMessage.__init__(self)


class IgnoredFunction(InfoMessage):

    msg = gb.textmods['yellow'] +  "The function '%s' is ignored." + gb.textmods['end']
    tags_done = set()

    def __init__(self, tag, reason=''):
        self.tag = tag
        self.msgmsg = self.__class__.msg % (tag)
        if bool(reason): self.msgmsg += " (%s)" % reason
        InfoMessage.__init__(self)


class IgnoredMemberFunction(InfoMessage):

    msg = gb.textmods['yellow'] +  "The member function '%s' is ignored." + gb.textmods['end']
    tags_done = set()

    def __init__(self, tag, reason=''):
        self.tag = tag
        self.msgmsg = self.__class__.msg % (tag)
        if bool(reason): self.msgmsg += " (%s)" % reason
        InfoMessage.__init__(self)


class IgnoredMemberVariable(InfoMessage):

    msg = gb.textmods['yellow'] +  "The member variable '%s' is ignored." + gb.textmods['end']
    tags_done = set()

    def __init__(self, tag, reason=''):
        self.tag = tag
        self.msgmsg = self.__class__.msg % (tag)
        if bool(reason): self.msgmsg += " (%s)" % reason
        InfoMessage.__init__(self)


class NoIncludeStatementGenerated(InfoMessage):

    msg = gb.textmods['yellow'] +  "No header file include statement generated for the type '%s'." + gb.textmods['end']
    tags_done = set()

    def __init__(self, tag, reason=''):
        self.tag = tag
        self.msgmsg = self.__class__.msg % (tag)
        if bool(reason): self.msgmsg += " (%s)" % reason
        InfoMessage.__init__(self)


class TypeNotAccepted(InfoMessage):

    msg = gb.textmods['yellow'] +  "The type '%s' is not accepted." + gb.textmods['end']
    tags_done = set()

    def __init__(self, tag, reason=''):
        self.tag = tag
        self.msgmsg = self.__class__.msg % (tag)
        if bool(reason): self.msgmsg += " (%s)" % reason
        InfoMessage.__init__(self)


class NoFactoryFunctions(InfoMessage):

    msg = gb.textmods['yellow'] +  "No factory functions generated for class '%s'." + gb.textmods['end']
    tags_done = set()

    def __init__(self, tag, reason=''):
        self.tag = tag
        self.msgmsg = self.__class__.msg % (tag)
        if bool(reason): self.msgmsg += " (%s)" % reason
        InfoMessage.__init__(self)


class NoPointerCopyAndAssignmentFunctions(InfoMessage):

    msg = gb.textmods['yellow'] +  "No pointer-based copy constructor or assignment functions generated for class '%s'." + gb.textmods['end']
    tags_done = set()

    def __init__(self, tag, reason=''):
        self.tag = tag
        self.msgmsg = self.__class__.msg % (tag)
        if bool(reason): self.msgmsg += " (%s)" % reason
        InfoMessage.__init__(self)


class NoLoadedTypesEntry(InfoMessage):

    msg = gb.textmods['yellow'] +  "No entry in loaded_types.hpp generated for class '%s'." + gb.textmods['end']
    tags_done = set()

    def __init__(self, tag, reason=''):
        self.tag = tag
        self.msgmsg = self.__class__.msg % (tag)
        if bool(reason): self.msgmsg += " (%s)" % reason
        InfoMessage.__init__(self)


# ====== END: List of info message classes ========



# ====== clearInfoMessages ========

def clearInfoMessages():
    """
    Loop through all active message types and clear the class-wide
    set of tags done. This will allow the info message to be printed
    again for the given tag.
    """
    global active_msg_types

    for info_msg_type in active_msg_types:
        info_msg_type.tags_done.clear()
    
    active_msg_types.clear()

# ====== END: clearInfoMessages ========

Updated on 2022-08-03 at 12:58:21 +0000