visitor.py

Go to the documentation of this file.

#  Copyright 2008-2015 Nokia Networks
#  Copyright 2016-     Robot Framework Foundation
#
#  Licensed under the Apache License, Version 2.0 (the "License");
#  you may not use this file except in compliance with the License.
#  You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
#  Unless required by applicable law or agreed to in writing, software
#  distributed under the License is distributed on an "AS IS" BASIS,
#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#  See the License for the specific language governing permissions and
#  limitations under the License.
 
 
 
 
 
class SuiteVisitor:
 
    
    def visit_suite(self, suite):
        if self.start_suitestart_suite(suite) is not False:
            if suite.has_setup:
                suite.setup.visit(self)
            suite.suites.visit(self)
            suite.tests.visit(self)
            if suite.has_teardown:
                suite.teardown.visit(self)
            self.end_suiteend_suite(suite)
 
    
    def start_suite(self, suite):
        pass
 
    
    def end_suite(self, suite):
        pass
 
    
    def visit_test(self, test):
        if self.start_teststart_test(test) is not False:
            if test.has_setup:
                test.setup.visit(self)
            test.body.visit(self)
            if test.has_teardown:
                test.teardown.visit(self)
            self.end_testend_test(test)
 
    
    def start_test(self, test):
        pass
 
    
    def end_test(self, test):
        pass
 
    
    def visit_keyword(self, kw):
        if self.start_keywordstart_keyword(kw) is not False:
            if hasattr(kw, 'body'):
                kw.body.visit(self)
            if kw.has_teardown:
                kw.teardown.visit(self)
            self.end_keywordend_keyword(kw)
 
    
    def start_keyword(self, keyword):
        return self.start_body_itemstart_body_item(keyword)
 
    
    def end_keyword(self, keyword):
        self.end_body_itemend_body_item(keyword)
 
    
    def visit_for(self, for_):
        if self.start_forstart_for(for_) is not False:
            for_.body.visit(self)
            self.end_forend_for(for_)
 
    
    def start_for(self, for_):
        return self.start_body_itemstart_body_item(for_)
 
    
    def end_for(self, for_):
        self.end_body_itemend_body_item(for_)
 
    
    def visit_for_iteration(self, iteration):
        if self.start_for_iterationstart_for_iteration(iteration) is not False:
            iteration.body.visit(self)
            self.end_for_iterationend_for_iteration(iteration)
 
    
    def start_for_iteration(self, iteration):
        return self.start_body_itemstart_body_item(iteration)
 
    
    def end_for_iteration(self, iteration):
        self.end_body_itemend_body_item(iteration)
 
    
    def visit_if(self, if_):
        if self.start_ifstart_if(if_) is not False:
            if_.body.visit(self)
            self.end_ifend_if(if_)
 
    
    def start_if(self, if_):
        return self.start_body_itemstart_body_item(if_)
 
    
    def end_if(self, if_):
        self.end_body_itemend_body_item(if_)
 
    
    def visit_if_branch(self, branch):
        if self.start_if_branchstart_if_branch(branch) is not False:
            branch.body.visit(self)
            self.end_if_branchend_if_branch(branch)
 
    
    def start_if_branch(self, branch):
        return self.start_body_itemstart_body_item(branch)
 
    
    def end_if_branch(self, branch):
        self.end_body_itemend_body_item(branch)
 
    
    def visit_try(self, try_):
        if self.start_trystart_try(try_) is not False:
            try_.body.visit(self)
            self.end_tryend_try(try_)
 
    
    def start_try(self, try_):
        return self.start_body_itemstart_body_item(try_)
 
    
    def end_try(self, try_):
        self.end_body_itemend_body_item(try_)
 
    
    def visit_try_branch(self, branch):
        if self.start_try_branchstart_try_branch(branch) is not False:
            branch.body.visit(self)
            self.end_try_branchend_try_branch(branch)
 
    
    def start_try_branch(self, branch):
        return self.start_body_itemstart_body_item(branch)
 
    
    def end_try_branch(self, branch):
        self.end_body_itemend_body_item(branch)
 
    
    def visit_while(self, while_):
        if self.start_whilestart_while(while_) is not False:
            while_.body.visit(self)
            self.end_whileend_while(while_)
 
    
    def start_while(self, while_):
        return self.start_body_itemstart_body_item(while_)
 
    
    def end_while(self, while_):
        self.end_body_itemend_body_item(while_)
 
    
    def visit_while_iteration(self, iteration):
        if self.start_while_iterationstart_while_iteration(iteration) is not False:
            iteration.body.visit(self)
            self.end_while_iterationend_while_iteration(iteration)
 
    
    def start_while_iteration(self, iteration):
        return self.start_body_itemstart_body_item(iteration)
 
    
    def end_while_iteration(self, iteration):
        self.end_body_itemend_body_item(iteration)
 
    
    def visit_return(self, return_):
        if self.start_returnstart_return(return_) is not False:
            if hasattr(return_, 'body'):
                return_.body.visit(self)
            self.end_returnend_return(return_)
 
    
    def start_return(self, return_):
        return self.start_body_itemstart_body_item(return_)
 
    
    def end_return(self, return_):
        self.end_body_itemend_body_item(return_)
 
    
    def visit_continue(self, continue_):
        if self.start_continuestart_continue(continue_) is not False:
            if hasattr(continue_, 'body'):
                continue_.body.visit(self)
            self.end_continueend_continue(continue_)
 
    
    def start_continue(self, continue_):
        return self.start_body_itemstart_body_item(continue_)
 
    
    def end_continue(self, continue_):
        self.end_body_itemend_body_item(continue_)
 
    
    def visit_break(self, break_):
        if self.start_breakstart_break(break_) is not False:
            if hasattr(break_, 'body'):
                break_.body.visit(self)
            self.end_breakend_break(break_)
 
    
    def start_break(self, break_):
        return self.start_body_itemstart_body_item(break_)
 
    
    def end_break(self, break_):
        self.end_body_itemend_body_item(break_)
 
    
    def visit_message(self, msg):
        if self.start_messagestart_message(msg) is not False:
            self.end_messageend_message(msg)
 
    
    def start_message(self, msg):
        return self.start_body_itemstart_body_item(msg)
 
    
    def end_message(self, msg):
        self.end_body_itemend_body_item(msg)
 
    
    def start_body_item(self, item):
        pass
 
    
    def end_body_item(self, item):
        pass