lib_config.py 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234
  1. # See utils/checkpackagelib/readme.txt before editing this file.
  2. # Kconfig generates errors if someone introduces a typo like "boool" instead of
  3. # "bool", so below check functions don't need to check for things already
  4. # checked by running "make menuconfig".
  5. import re
  6. from checkpackagelib.base import _CheckFunction
  7. from checkpackagelib.lib import ConsecutiveEmptyLines # noqa: F401
  8. from checkpackagelib.lib import EmptyLastLine # noqa: F401
  9. from checkpackagelib.lib import NewlineAtEof # noqa: F401
  10. from checkpackagelib.lib import TrailingSpace # noqa: F401
  11. def _empty_or_comment(text):
  12. line = text.strip()
  13. # ignore empty lines and comment lines indented or not
  14. return line == "" or line.startswith("#")
  15. def _part_of_help_text(text):
  16. return text.startswith("\t ")
  17. # used in more than one check
  18. entries_that_should_not_be_indented = [
  19. "choice", "comment", "config", "endchoice", "endif", "endmenu", "if",
  20. "menu", "menuconfig", "source"]
  21. class AttributesOrder(_CheckFunction):
  22. attributes_order_convention = {
  23. "bool": 1, "prompt": 1, "string": 1, "default": 2, "depends": 3,
  24. "select": 4, "help": 5}
  25. def before(self):
  26. self.state = 0
  27. def check_line(self, lineno, text):
  28. if _empty_or_comment(text) or _part_of_help_text(text):
  29. return
  30. attribute = text.split()[0]
  31. if attribute in entries_that_should_not_be_indented:
  32. self.state = 0
  33. return
  34. if attribute not in self.attributes_order_convention.keys():
  35. return
  36. new_state = self.attributes_order_convention[attribute]
  37. wrong_order = self.state > new_state
  38. # save to process next line
  39. self.state = new_state
  40. if wrong_order:
  41. return ["{}:{}: attributes order: type, default, depends on,"
  42. " select, help ({}#_config_files)"
  43. .format(self.filename, lineno, self.url_to_manual),
  44. text]
  45. class CommentsMenusPackagesOrder(_CheckFunction):
  46. def before(self):
  47. self.level = 0
  48. self.menu_of_packages = ["The top level menu"]
  49. self.new_package = ""
  50. self.package = [""]
  51. self.print_package_warning = [True]
  52. self.state = ""
  53. def get_level(self):
  54. return len(self.state.split('-')) - 1
  55. def initialize_package_level_elements(self, text):
  56. try:
  57. self.menu_of_packages[self.level] = text[:-1]
  58. self.package[self.level] = ""
  59. self.print_package_warning[self.level] = True
  60. except IndexError:
  61. self.menu_of_packages.append(text[:-1])
  62. self.package.append("")
  63. self.print_package_warning.append(True)
  64. def initialize_level_elements(self, text):
  65. self.level = self.get_level()
  66. self.initialize_package_level_elements(text)
  67. def check_line(self, lineno, text):
  68. # We only want to force sorting for the top-level menus
  69. if self.filename not in ["fs/Config.in",
  70. "package/Config.in",
  71. "package/Config.in.host",
  72. "package/kodi/Config.in"]:
  73. return
  74. source_line = re.match(r'^\s*source ".*/([^/]*)/Config.in(.host)?"', text)
  75. if text.startswith("comment "):
  76. if not self.state.endswith("-comment"):
  77. self.state += "-comment"
  78. self.initialize_level_elements(text)
  79. elif text.startswith("if "):
  80. self.state += "-if"
  81. self.initialize_level_elements(text)
  82. elif text.startswith("menu "):
  83. if self.state.endswith("-comment"):
  84. self.state = self.state[:-8]
  85. self.state += "-menu"
  86. self.initialize_level_elements(text)
  87. elif text.startswith("endif") or text.startswith("endmenu"):
  88. if self.state.endswith("-comment"):
  89. self.state = self.state[:-8]
  90. if text.startswith("endif"):
  91. self.state = self.state[:-3]
  92. elif text.startswith("endmenu"):
  93. self.state = self.state[:-5]
  94. self.level = self.get_level()
  95. elif source_line:
  96. self.new_package = source_line.group(1)
  97. # We order _ before A, so replace it with .
  98. new_package_ord = self.new_package.replace('_', '.')
  99. if self.package[self.level] != "" and \
  100. self.print_package_warning[self.level] and \
  101. new_package_ord < self.package[self.level]:
  102. self.print_package_warning[self.level] = False
  103. prefix = "{}:{}: ".format(self.filename, lineno)
  104. spaces = " " * len(prefix)
  105. return ["{prefix}Packages in: {menu},\n"
  106. "{spaces}are not alphabetically ordered;\n"
  107. "{spaces}correct order: '-', '_', digits, capitals, lowercase;\n"
  108. "{spaces}first incorrect package: {package}"
  109. .format(prefix=prefix, spaces=spaces,
  110. menu=self.menu_of_packages[self.level],
  111. package=self.new_package),
  112. text]
  113. self.package[self.level] = new_package_ord
  114. class HelpText(_CheckFunction):
  115. HELP_TEXT_FORMAT = re.compile(r"^\t .{,62}$")
  116. URL_ONLY = re.compile(r"^(http|https|git)://\S*$")
  117. def before(self):
  118. self.help_text = False
  119. def check_line(self, lineno, text):
  120. if _empty_or_comment(text):
  121. return
  122. entry = text.split()[0]
  123. if entry in entries_that_should_not_be_indented:
  124. self.help_text = False
  125. return
  126. if text.strip() == "help":
  127. self.help_text = True
  128. return
  129. if not self.help_text:
  130. return
  131. if self.HELP_TEXT_FORMAT.match(text.rstrip()):
  132. return
  133. if self.URL_ONLY.match(text.strip()):
  134. return
  135. return ["{}:{}: help text: <tab><2 spaces><62 chars>"
  136. " ({}#writing-rules-config-in)"
  137. .format(self.filename, lineno, self.url_to_manual),
  138. text,
  139. "\t " + "123456789 " * 6 + "12"]
  140. class Indent(_CheckFunction):
  141. ENDS_WITH_BACKSLASH = re.compile(r"^[^#].*\\$")
  142. entries_that_should_be_indented = [
  143. "bool", "default", "depends", "help", "prompt", "select", "string"]
  144. def before(self):
  145. self.backslash = False
  146. def check_line(self, lineno, text):
  147. if _empty_or_comment(text) or _part_of_help_text(text):
  148. self.backslash = False
  149. return
  150. entry = text.split()[0]
  151. last_line_ends_in_backslash = self.backslash
  152. # calculate for next line
  153. if self.ENDS_WITH_BACKSLASH.search(text):
  154. self.backslash = True
  155. else:
  156. self.backslash = False
  157. if last_line_ends_in_backslash:
  158. if text.startswith("\t"):
  159. return
  160. return ["{}:{}: continuation line should be indented using tabs"
  161. .format(self.filename, lineno),
  162. text]
  163. if entry in self.entries_that_should_be_indented:
  164. if not text.startswith("\t{}".format(entry)):
  165. return ["{}:{}: should be indented with one tab"
  166. " ({}#_config_files)"
  167. .format(self.filename, lineno, self.url_to_manual),
  168. text]
  169. elif entry in entries_that_should_not_be_indented:
  170. if not text.startswith(entry):
  171. # four Config.in files have a special but legitimate indentation rule
  172. if self.filename in ["package/Config.in",
  173. "package/Config.in.host",
  174. "package/kodi/Config.in",
  175. "package/x11r7/Config.in"]:
  176. return
  177. return ["{}:{}: should not be indented"
  178. .format(self.filename, lineno),
  179. text]