Source code for robot.parsing.parser.fileparser

#  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.

import os.path

from robot.utils import is_pathlike, is_string

from ..lexer import Token
from ..model import (File, CommentSection, SettingSection, VariableSection,
                     TestCaseSection, KeywordSection)

from .blockparsers import Parser, TestCaseParser, KeywordParser


class FileParser(Parser):

    def __init__(self, source=None):
        Parser.__init__(self, File(source=self._get_path(source)))

    def _get_path(self, source):
        if not source:
            return None
        if is_string(source) and '\n' not in source and os.path.isfile(source):
            return source
        if is_pathlike(source) and source.is_file():
            return str(source)
        return None

    def handles(self, statement):
        return True

    def parse(self, statement):
        parser_class = {
            Token.SETTING_HEADER: SettingSectionParser,
            Token.VARIABLE_HEADER: VariableSectionParser,
            Token.TESTCASE_HEADER: TestCaseSectionParser,
            Token.KEYWORD_HEADER: KeywordSectionParser,
            Token.COMMENT_HEADER: CommentSectionParser,
            Token.COMMENT: ImplicitCommentSectionParser,
            Token.ERROR: ImplicitCommentSectionParser,
            Token.EOL: ImplicitCommentSectionParser
        }[statement.type]
        parser = parser_class(statement)
        self.model.sections.append(parser.model)
        return parser


class SectionParser(Parser):

    def handles(self, statement):
        return statement.type not in Token.HEADER_TOKENS

    def parse(self, statement):
        self.model.body.append(statement)


class SettingSectionParser(SectionParser):

    def __init__(self, header):
        SectionParser.__init__(self, SettingSection(header))


class VariableSectionParser(SectionParser):

    def __init__(self, header):
        SectionParser.__init__(self, VariableSection(header))


class CommentSectionParser(SectionParser):

    def __init__(self, header):
        SectionParser.__init__(self, CommentSection(header))


class ImplicitCommentSectionParser(SectionParser):

    def __init__(self, statement):
        SectionParser.__init__(self, CommentSection(body=[statement]))


class TestCaseSectionParser(SectionParser):

    def __init__(self, header):
        SectionParser.__init__(self, TestCaseSection(header))

    def parse(self, statement):
        if statement.type == Token.TESTCASE_NAME:
            parser = TestCaseParser(statement)
            model = parser.model
        else:    # Empty lines and comments before first test.
            parser = None
            model = statement
        self.model.body.append(model)
        return parser


class KeywordSectionParser(SectionParser):

    def __init__(self, header):
        SectionParser.__init__(self, KeywordSection(header))

    def parse(self, statement):
        if statement.type == Token.KEYWORD_NAME:
            parser = KeywordParser(statement)
            model = parser.model
        else:    # Empty lines and comments before first keyword.
            parser = None
            model = statement
        self.model.body.append(model)
        return parser