buildroot

# See utils/checkpackagelib/readme.txt before editing this file.

# Kconfig generates errors if someone introduces a typo like "boool" instead of

# "bool", so below check functions don't need to check for things already

# checked by running "make menuconfig".

​

import re

​

from base import _CheckFunction

# Notice: ignore 'imported but unused' from pyflakes for check functions.

from lib import ConsecutiveEmptyLines

from lib import EmptyLastLine

from lib import NewlineAtEof

from lib import TrailingSpace

​

​

def _empty_or_comment(text):

    line = text.strip()

    # ignore empty lines and comment lines indented or not

    return line == "" or line.startswith("#")

​

​

def _part_of_help_text(text):

    return text.startswith("\t  ")

​

​

# used in more than one check

entries_that_should_not_be_indented = [

    "choice", "comment", "config", "endchoice", "endif", "endmenu", "if",

    "menu", "menuconfig", "source"]

​

​

class AttributesOrder(_CheckFunction):

    attributes_order_convention = {

        "bool": 1, "prompt": 1, "string": 1, "default": 2, "depends": 3,

        "select": 4, "help": 5}

​

    def before(self):

        self.state = 0

​

    def check_line(self, lineno, text):

        if _empty_or_comment(text) or _part_of_help_text(text):

            return

​

        attribute = text.split()[0]

​

        if attribute in entries_that_should_not_be_indented:

            self.state = 0

            return

        if attribute not in self.attributes_order_convention.keys():

            return

        new_state = self.attributes_order_convention[attribute]

        wrong_order = self.state > new_state

​

        # save to process next line

        self.state = new_state

​

        if wrong_order:

            return ["{}:{}: attributes order: type, default, depends on,"

                    " select, help ({}#_config_files)"

                    .format(self.filename, lineno, self.url_to_manual),

                    text]

​

​