Auto merge of #126788 - GuillaumeGomez:migrate-rustdoc-tests-syntax, r=fmease,oli-obk

Migrate rustdoc tests syntax to `//@` (for coherency)
Part of #125813.
cc `@jieyouxu`
r? `@fmease`
try-job: aarch64-apple

Author: bors

src/etc/htmldocck.py

@@ -240,9 +240,37 @@ def concat_multi_lines(f):
 print_err(lineno, line, 'Trailing backslash at the end of the file')
 
 
+defget_known_directive_names():
+deffilter_line(line):
+line=line.strip()
+returnline.startswith('"') and (line.endswith('",') orline.endswith('"'))
+
+# Equivalent to `src/tools/compiletest/src/header.rs` constant of the same name.
+withopen(
+os.path.join(
+# We go back to `src`.
+os.path.dirname(os.path.dirname(__file__)),
+"tools/compiletest/src/command-list.rs",
+ ),
+"r",
+encoding="utf8"
+ ) asfd:
+content=fd.read()
+return [
+line.strip().replace('",', '').replace('"', '')
+forlineincontent.split('\n')
+iffilter_line(line)
+ ]
+
+
+# To prevent duplicating the list of commmands between `compiletest` and `htmldocck`, we put
+# it into a common file which is included in rust code and parsed here.
+# FIXME: This setup is temporary until we figure out how to improve this situation.
+KNOWN_DIRECTIVE_NAMES=get_known_directive_names()
+
 LINE_PATTERN=re.compile(r'''
-(?<=(?<!\S))(?P<invalid>!?)@(?P<negated>!?)
- (?P<cmd>[A-Za-z]+(?:-[A-Za-z]+)*)
+//@\s+
+ (?P<negated>!?)(?P<cmd>[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*)
  (?P<args>.*)$
 ''', re.X|re.UNICODE)
 
@@ -254,17 +282,9 @@ def get_commands(template):
 ifnotm:
 continue
 
-negated= (m.group('negated') =='!')
 cmd=m.group('cmd')
-ifm.group('invalid') =='!':
-print_err(
-lineno,
-line,
-'Invalid command: `!@{0}{1}`, (help: try with `@!{1}`)'.format(
-'!'ifnegatedelse'',
-cmd,
- ),
- )
+negated= (m.group('negated') =='!')
+ifnotnegatedandcmdinKNOWN_DIRECTIVE_NAMES:
 continue
 args=m.group('args')
 ifargsandnotargs[:1].isspace():
@@ -549,7 +569,7 @@ def get_nb_matching_elements(cache, c, regexp, stop_at_first):
 defcheck_files_in_folder(c, cache, folder, files):
 files=files.strip()
 ifnotfiles.startswith('[') ornotfiles.endswith(']'):
-raiseInvalidCheck("Expected list as second argument of @{} (ie '[]')".format(c.cmd))
+raiseInvalidCheck("Expected list as second argument of {} (ie '[]')".format(c.cmd))
 
 folder=cache.get_absolute_path(folder)
 
@@ -558,7 +578,7 @@ def check_files_in_folder(c, cache, folder, files):
 files_set=set()
 forfileinfiles:
 iffileinfiles_set:
-raiseInvalidCheck("Duplicated file `{}` in @{}".format(file, c.cmd))
+raiseInvalidCheck("Duplicated file `{}` in {}".format(file, c.cmd))
 files_set.add(file)
 folder_set=set([fforfinos.listdir(folder) iff!="."andf!=".."])
 
@@ -590,48 +610,48 @@ def check_command(c, cache):
 ifc.cmdin ['has', 'hasraw', 'matches', 'matchesraw']: # string test
 regexp=c.cmd.startswith('matches')
 
-# @has <path> = file existence
+# has <path> = file existence
 iflen(c.args) ==1andnotregexpand'raw'notinc.cmd:
 try:
 cache.get_file(c.args[0])
 ret=True
 exceptFailedCheckaserr:
 cerr=str(err)
 ret=False
-# @hasraw/matchesraw <path> <pat> = string test
+# hasraw/matchesraw <path> <pat> = string test
 eliflen(c.args) ==2and'raw'inc.cmd:
 cerr="`PATTERN` did not match"
 ret=check_string(cache.get_file(c.args[0]), c.args[1], regexp)
-# @has/matches <path> <pat> <match> = XML tree test
+# has/matches <path> <pat> <match> = XML tree test
 eliflen(c.args) ==3and'raw'notinc.cmd:
 cerr="`XPATH PATTERN` did not match"
 ret=get_nb_matching_elements(cache, c, regexp, True) !=0
 else:
-raiseInvalidCheck('Invalid number of @{} arguments'.format(c.cmd))
+raiseInvalidCheck('Invalid number of {} arguments'.format(c.cmd))
 
 elifc.cmd=='files': # check files in given folder
-iflen(c.args) !=2: # @files <folder path> <file list>
-raiseInvalidCheck("Invalid number of @{} arguments".format(c.cmd))
+iflen(c.args) !=2: # files <folder path> <file list>
+raiseInvalidCheck("Invalid number of {} arguments".format(c.cmd))
 elifc.negated:
-raiseInvalidCheck("@{} doesn't support negative check".format(c.cmd))
+raiseInvalidCheck("{} doesn't support negative check".format(c.cmd))
 ret=check_files_in_folder(c, cache, c.args[0], c.args[1])
 
 elifc.cmd=='count': # count test
-iflen(c.args) ==3: # @count <path> <pat> <count> = count test
+iflen(c.args) ==3: # count <path> <pat> <count> = count test
 expected=int(c.args[2])
 found=get_tree_count(cache.get_tree(c.args[0]), c.args[1])
 cerr="Expected {} occurrences but found {}".format(expected, found)
 ret=expected==found
-eliflen(c.args) ==4: # @count <path> <pat> <text> <count> = count test
+eliflen(c.args) ==4: # count <path> <pat> <text> <count> = count test
 expected=int(c.args[3])
 found=get_nb_matching_elements(cache, c, False, False)
 cerr="Expected {} occurrences but found {}".format(expected, found)
 ret=found==expected
 else:
-raiseInvalidCheck('Invalid number of @{} arguments'.format(c.cmd))
+raiseInvalidCheck('Invalid number of {} arguments'.format(c.cmd))
 
 elifc.cmd=='snapshot': # snapshot test
-iflen(c.args) ==3: # @snapshot <snapshot-name> <html-path> <xpath>
+iflen(c.args) ==3: # snapshot <snapshot-name> <html-path> <xpath>
  [snapshot_name, html_path, pattern] =c.args
 tree=cache.get_tree(html_path)
 xpath=normalize_xpath(pattern)
@@ -654,33 +674,33 @@ def check_command(c, cache):
 else:
 raiseFailedCheck('Expected 1 match, but found {}'.format(len(subtrees)))
 else:
-raiseInvalidCheck('Invalid number of @{} arguments'.format(c.cmd))
+raiseInvalidCheck('Invalid number of {} arguments'.format(c.cmd))
 
 elifc.cmd=='has-dir': # has-dir test
-iflen(c.args) ==1: # @has-dir <path> = has-dir test
+iflen(c.args) ==1: # has-dir <path> = has-dir test
 try:
 cache.get_dir(c.args[0])
 ret=True
 exceptFailedCheckaserr:
 cerr=str(err)
 ret=False
 else:
-raiseInvalidCheck('Invalid number of @{} arguments'.format(c.cmd))
+raiseInvalidCheck('Invalid number of {} arguments'.format(c.cmd))
 
 elifc.cmd=='valid-html':
-raiseInvalidCheck('Unimplemented @valid-html')
+raiseInvalidCheck('Unimplemented valid-html')
 
 elifc.cmd=='valid-links':
-raiseInvalidCheck('Unimplemented @valid-links')
+raiseInvalidCheck('Unimplemented valid-links')
 
 else:
-raiseInvalidCheck('Unrecognized @{}'.format(c.cmd))
+raiseInvalidCheck('Unrecognized {}'.format(c.cmd))
 
 ifret==c.negated:
 raiseFailedCheck(cerr)
 
 exceptFailedCheckaserr:
-message='@{}{} check failed'.format('!'ifc.negatedelse'', c.cmd)
+message='{}{} check failed'.format('!'ifc.negatedelse'', c.cmd)
 print_err(c.lineno, c.context, str(err), message)
 exceptInvalidCheckaserr:
 print_err(c.lineno, c.context, str(err))