Merge pull request #3242 from masatake/man--subsection

masatake · web-flow · commit bacba8df660a · 2021-12-28T12:19:53.000+09:00
Man: extract subsections
diff --git a/Tmain/json-output-format.d/stdout-expected.txt b/Tmain/json-output-format.d/stdout-expected.txt
@@ -8,7 +8,7 @@
 {"_type": "tag", "name": "main", "path": "input.go", "pattern": "/^package main$/", "kind": "package"}
 # json --languages=+man --fields=*-T
 {"_type": "tag", "name": "Foo", "path": "input.py", "pattern": "/^class Foo:$/", "language": "Python", "line": 1, "kind": "class", "inherits": false, "access": "public", "roles": "def", "end": 3}
-{"_type": "tag", "name": "N\tA\tM\tE", "path": "input.1", "pattern": "/^.SH \"\tN\tA\tM\tE\t\"$/", "language": "Man", "line": 1, "kind": "section", "roles": "def"}
+{"_type": "tag", "name": "N\tA\tM\tE", "path": "input.1", "pattern": "/^.SH \"\tN\tA\tM\tE\t\"$/", "language": "Man", "line": 1, "kind": "section", "roles": "def", "end": 1}
 {"_type": "tag", "name": "doIt", "path": "input.py", "pattern": "/^    def doIt():$/", "language": "Python", "line": 2, "kind": "member", "access": "public", "signature": "()", "scope": "Foo", "scopeKind": "class", "roles": "def", "end": 3}
 {"_type": "tag", "name": "foo", "path": "input.c", "pattern": "/^static int foo (void)$/", "file": true, "language": "C", "line": 3, "typeref": "typename:int", "kind": "function", "signature": "(void)", "roles": "def", "extras": "fileScope", "end": 6}
 {"_type": "tag", "name": "main", "path": "input.c", "pattern": "/^main(void)$/", "language": "C", "line": 9, "typeref": "typename:int", "kind": "function", "signature": "(void)", "roles": "def", "end": 12}
@@ -24,7 +24,7 @@
 {"_type": "ptag", "name": "TAG_PROGRAM_URL", "path": "https://ctags.io/", "pattern": "official site"}
 {"_type": "tag", "name": "Foo", "path": "input.py", "pattern": "/^class Foo:$/", "language": "Python", "line": 1, "kind": "class", "inherits": false, "access": "public", "roles": "def", "end": 3}
 {"_type": "tag", "name": "Foo.doIt", "path": "input.py", "pattern": "/^    def doIt():$/", "language": "Python", "line": 2, "kind": "member", "access": "public", "signature": "()", "scope": "Foo", "scopeKind": "class", "roles": "def", "extras": "qualified", "end": 3}
-{"_type": "tag", "name": "N\tA\tM\tE", "path": "input.1", "pattern": "/^.SH \"\tN\tA\tM\tE\t\"$/", "language": "Man", "line": 1, "kind": "section", "roles": "def"}
+{"_type": "tag", "name": "N\tA\tM\tE", "path": "input.1", "pattern": "/^.SH \"\tN\tA\tM\tE\t\"$/", "language": "Man", "line": 1, "kind": "section", "roles": "def", "end": 1}
 {"_type": "tag", "name": "doIt", "path": "input.py", "pattern": "/^    def doIt():$/", "language": "Python", "line": 2, "kind": "member", "access": "public", "signature": "()", "scope": "Foo", "scopeKind": "class", "roles": "def", "end": 3}
 {"_type": "tag", "name": "foo", "path": "input.c", "pattern": "/^static int foo (void)$/", "file": true, "language": "C", "line": 3, "typeref": "typename:int", "kind": "function", "signature": "(void)", "roles": "def", "extras": "fileScope", "end": 6}
 {"_type": "tag", "name": "input.1", "path": "input.1", "pattern": false, "language": "Man", "line": 1, "kind": "file", "roles": "def", "extras": "inputFile", "end": 1}
diff --git a/Tmain/list-mtable-regex-flags.d/stdout-expected.txt b/Tmain/list-mtable-regex-flags.d/stdout-expected.txt
@@ -6,7 +6,7 @@ p       pcre2                                         use pcre2 regex engine
 -       fatal="MESSAGE"                               print the given MESSAGE and exit
 -       mgroup=N                                      a group in pattern determining the line number of tag
 -       placeholder                                   don't put this tag to tags file.
--       scope=ACTION                                  use scope stack: ACTION = ref|push|pop|clear|set
+-       scope=ACTION                                  use scope stack: ACTION = ref|push|pop|clear|set|replace
 -       tenter=TABLE[,CONT]                           enter to given regext table (with specifying continuation)
 -       tjump=TABLE                                   jump to another regext table(don't push the current table to state stack)
 -       tleave                                        leave from the current regext table
diff --git a/Tmain/list-regex-flags.d/stdout-expected.txt b/Tmain/list-regex-flags.d/stdout-expected.txt
@@ -6,7 +6,7 @@ p       pcre2                                         use pcre2 regex engine
 x       exclusive                                     skip testing the other patterns if a line is matched to this pattern
 -       fatal="MESSAGE"                               print the given MESSAGE and exit
 -       placeholder                                   don't put this tag to tags file.
--       scope=ACTION                                  use scope stack: ACTION = ref|push|pop|clear|set
+-       scope=ACTION                                  use scope stack: ACTION = ref|push|pop|clear|set|replace
 -       warning="MESSAGE"                             print the given MESSAGE at WARNING level
 -       _anonymous=PREFIX                             make an anonymous tag with PREFIX
 -       _extra=EXTRA                                  record the tag only when the extra is enabled
diff --git a/Units/optscript.r/op-matchloc2line.d/args.ctags b/Units/optscript.r/op-matchloc2line.d/args.ctags
@@ -0,0 +1,12 @@
+--fields=+n
+
+--langdef=X
+--map-X=.unknown
+--kinddef-X=l,line,lines
+
+--regex-X=/^DEF ([A-Z])//{{
+  0 string dup 1 _matchloc _matchloc2line exch cvs
+  /line
+  1 _matchloc
+  _tag _commit pop
+}}
diff --git a/Units/optscript.r/op-matchloc2line.d/expected.tags b/Units/optscript.r/op-matchloc2line.d/expected.tags
@@ -0,0 +1 @@
+3	input.unknown	/^DEF C$/;"	l	line:3
diff --git a/Units/optscript.r/op-matchloc2line.d/input.unknown b/Units/optscript.r/op-matchloc2line.d/input.unknown
@@ -0,0 +1,5 @@
+REF A
+REF B
+DEF C
+REF D
+
diff --git a/Units/parser-man.r/double-quoted.d/args.ctags b/Units/parser-man.r/double-quoted.d/args.ctags
@@ -0,0 +1,2 @@
+--sort=no
+--fields=+e
diff --git a/Units/parser-man.r/double-quoted.d/expected.tags b/Units/parser-man.r/double-quoted.d/expected.tags
@@ -1,2 +1,2 @@
-CTAGS	input.1	/^.TH "CTAGS" 1 "Version 0.0.0" "Darren Hiebert" "Universal Ctags"$/;"	t
-NAME	input.1	/^.SH "NAME"$/;"	s	title:CTAGS
+CTAGS	input.1	/^.TH "CTAGS" 1 "Version 0.0.0" "Darren Hiebert" "Universal Ctags"$/;"	t	end:7
+NAME	input.1	/^.SH "NAME"$/;"	s	title:CTAGS	end:7
diff --git a/Units/parser-man.r/simple.d/args.ctags b/Units/parser-man.r/simple.d/args.ctags
@@ -0,0 +1,2 @@
+--sort=no
+--fields=+e
diff --git a/Units/parser-man.r/simple.d/expected.tags b/Units/parser-man.r/simple.d/expected.tags
@@ -1,4 +1,20 @@
-CTAGS	input.1	/^.TH CTAGS 1 "Version 0.0.0" "Darren Hiebert" "Universal Ctags"$/;"	t
-DESCRIPTION	input.1	/^.SH "DESCRIPTION"$/;"	s	title:CTAGS
-NAME	input.1	/^.SH "NAME"$/;"	s	title:CTAGS
-SYNOPSIS	input.1	/^.SH SYNOPSIS$/;"	s	title:CTAGS
+CTAGS	input.1	/^.TH CTAGS 1 "Version 0.0.0" "Darren Hiebert" "Universal Ctags"$/;"	t	end:89
+NAME	input.1	/^.SH "NAME"$/;"	s	title:CTAGS	end:6
+ABSTRACT	input.1	/^ABSTRACT$/;"	s	title:CTAGS	end:9
+SYNOPSIS	input.1	/^.SH SYNOPSIS$/;"	s	title:CTAGS	end:16
+DESCRIPTION	input.1	/^.SH "DESCRIPTION"$/;"	s	title:CTAGS	end:25
+AUTHOR	input.1	/^AUTHOR$/;"	s	title:CTAGS	end:52
+subsection1	input.1	/^.SS subsection1$/;"	S	section:CTAGS""AUTHOR	end:34
+subsection2	input.1	/^.SS "subsection2"$/;"	S	section:CTAGS""AUTHOR	end:38
+subsection3	input.1	/^subsection3$/;"	S	section:CTAGS""AUTHOR	end:43
+sub section 4	input.1	/^.SS sub section 4$/;"	S	section:CTAGS""AUTHOR	end:47
+sub section 5	input.1	/^sub section 5$/;"	S	section:CTAGS""AUTHOR	end:52
+ACKNOWLEDGMENT	input.1	/^ACKNOWLEDGMENT$/;"	s	title:CTAGS	end:83
+subsection6	input.1	/^subsection6$/;"	S	section:CTAGS""ACKNOWLEDGMENT	end:61
+subsection7	input.1	/^subsection7$/;"	S	section:CTAGS""ACKNOWLEDGMENT	end:66
+subsection8	input.1	/^.SS "subsection8"$/;"	S	section:CTAGS""ACKNOWLEDGMENT	end:70
+subsection9	input.1	/^.SS subsection9$/;"	S	section:CTAGS""ACKNOWLEDGMENT	end:74
+sub section 10	input.1	/^.SS sub section 10$/;"	S	section:CTAGS""ACKNOWLEDGMENT	end:78
+sub section 11	input.1	/^sub section 11$/;"	S	section:CTAGS""ACKNOWLEDGMENT	end:83
+SEE ALSO	input.1	/^.SH SEE ALSO$/;"	s	title:CTAGS	end:89
+sub section 12	input.1	/^sub section 12$/;"	S	section:CTAGS""SEE ALSO	end:89
diff --git a/Units/parser-man.r/simple.d/input.1 b/Units/parser-man.r/simple.d/input.1
@@ -4,6 +4,8 @@
 .SH "NAME"
 ctags \- Generate tag files for source code
 
+.SH
+ABSTRACT
 
 .SH SYNOPSIS
 .TP 6
@@ -20,3 +22,68 @@ This tag file allows these items to be quickly and easily located by a text
 editor or other utility. A "tag" signifies a language object for which an
 index entry is available (or, alternatively, the index entry created for that
 object).
+
+.SH
+AUTHOR
+.sp
+The Developers.
+
+.SS subsection1
+.sp
+This is the first subsection.
+
+.SS "subsection2"
+.sp
+This is the second subsection.
+
+.SS
+subsection3
+.sp
+This is the third subsection.
+
+.SS sub section 4
+.sp
+This is the fourth subsection.
+
+.SS
+sub section 5
+.sp
+This is the fifth subsection.
+
+.SH
+ACKNOWLEDGMENT
+.sp
+
+.SS
+subsection6
+.sp
+This is the sixth subsection.
+
+.SS
+subsection7
+.sp
+This is the seventh subsection.
+
+.SS "subsection8"
+.sp
+This is the eight subsection.
+
+.SS subsection9
+.sp
+This is the ninth subsection.
+
+.SS sub section 10
+.sp
+This is the tenth subsection.
+
+.SS
+sub section 11
+.sp
+This is the eleventh subsection.
+
+.SH SEE ALSO
+.sp
+See tags(5) for the details of tags file format.
+
+.SS
+sub section 12
diff --git a/Units/regex-with-scope-autoFQTag.d/expected.tags b/Units/regex-with-scope-autoFQTag.d/expected.tags
@@ -1,4 +1,4 @@
-NS1	input.foo	/^ns NS1$/;"	n	end:16
+NS1	input.foo	/^ns NS1$/;"	n	end:15
 x	input.foo	/^define x {$/;"	d	namespace:NS1	end:14
 NS1.x	input.foo	/^define x {$/;"	d	namespace:NS1	end:14
 y	input.foo	/^	define y {$/;"	d	definition:NS1.x	end:7
diff --git a/Units/regex-with-scope-nested.d/expected.tags b/Units/regex-with-scope-nested.d/expected.tags
@@ -1,5 +1,5 @@
 X	input.foo	/^# open:X$/;"	s	end:47
-NS1	input.foo	/^ns NS1$/;"	n	end:16
+NS1	input.foo	/^ns NS1$/;"	n	end:15
 x	input.foo	/^define x {$/;"	d	namespace:NS1	end:14
 y	input.foo	/^	define y {$/;"	d	definition:NS1.x	end:7
 v_y_0	input.foo	/^	       var v_y_0$/;"	v	definition:NS1.x.y
diff --git a/docs/man-pages.rst b/docs/man-pages.rst
@@ -15,6 +15,7 @@ Man pages
 	ctags-incompatibilities(7) <man/ctags-incompatibilities.7.rst>
 	ctags-faq(7) <man/ctags-faq.7.rst>
 
+	ctags-lang-gdscript(7) <man/ctags-lang-gdscript.7.rst>
 	ctags-lang-inko(7) <man/ctags-lang-inko.7.rst>
 	ctags-lang-iPythonCell(7) <man/ctags-lang-iPythonCell.7.rst>
 	ctags-lang-julia(7) <man/ctags-lang-julia.7.rst>
diff --git a/docs/man/ctags-optlib.7.rst b/docs/man/ctags-optlib.7.rst
@@ -329,7 +329,7 @@ representation. ``--list-regex-flags`` lists all the flags.
 	can be an empty string.  See the following description of
 	``scope=...`` flag about how this is useful.
 
-``scope=(ref|push|pop|clear|set)``
+``scope=(ref|push|pop|clear|set|replace)``
 
 	Specify what to do with the internal scope stack.
 
@@ -342,7 +342,7 @@ representation. ``--list-regex-flags`` lists all the flags.
 	``--regex-<LANG>`` is pushed to the stack. ``{scope=push}``
 	implies ``{scope=ref}``.
 
-	You can fill the scope field of captured tag with
+	You can fill the scope field (``scope:``) of captured tag with
 	``{scope=ref}``. If ``{scope=ref}`` flag is given,
 	ctags attaches the tag at the top to the tag
 	captured with ``--regex-<LANG>`` as the value for the ``scope:``
@@ -356,6 +356,21 @@ representation. ``--list-regex-flags`` lists all the flags.
 	Specifying ``{scope=set}`` removes all the tags in the scope, and
 	then pushes the captured tag as ``{scope=push}`` does.
 
+	``{scope=replace}`` does the three things sequentially. First it
+	does the same as ``{scope=pop}``, then fills the ``scope:`` field
+	of the tag captured with ``--regex-<LANG>``, and pushes the tag to
+	the scope stack as if ``{scope=push}`` was given finally.
+	You cannot specify another scope action together with
+	``{scope=replace}``.
+
+	You don't want to specify ``{scope=pop}{scope=push}`` as an
+	alternative to ``{scope=replace}``; ``{scope=pop}{scope=push}``
+	fills the ``scope:`` field of the tag captured with ``--regex-<LANG>``
+	first, then pops the tag at the top of the stack, and pushes
+	the captured tag to the scope stack finally. The timing when
+	filling the end field is different between ``{scope=replace}`` and
+	``{scope=pop}{scope=push}``.
+
 	In some cases, you may want to use ``--regex-<LANG>`` only for its
 	side effects: using it only to manipulate the stack but not for
 	capturing a tag. In such a case, make *<name_pattern>* component of
diff --git a/docs/optlib.rst b/docs/optlib.rst
@@ -570,6 +570,56 @@ Example 2:
 	foo	/tmp/input.pp	/^class foo {$/;"	c
 
 
+Example 3:
+
+.. code-block::
+
+	# in /tmp/input.docdoc
+	title T
+	...
+	section S0
+	...
+	section S1
+	...
+
+.. code-block:: ctags
+	:emphasize-lines: 15,21
+
+	# in /tmp/doc.ctags:
+	--langdef=doc
+	--map-doc=+.docdoc
+	--kinddef-doc=s,section,sections
+	--kinddef-doc=S,subsection,subsections
+
+	--_tabledef-doc=main
+	--_tabledef-doc=section
+	--_tabledef-doc=subsection
+
+	--_mtable-regex-doc=main/section +([^\n]+)\n/\1/s/{scope=push}{tenter=section}
+	--_mtable-regex-doc=main/[^\n]+\n|[^\n]+|\n//
+	--_mtable-regex-doc=main///{scope=clear}{tquit}
+
+	--_mtable-regex-doc=section/section +([^\n]+)\n/\1/s/{scope=replace}
+	--_mtable-regex-doc=section/subsection +([^\n]+)\n/\1/S/{scope=push}{tenter=subsection}
+	--_mtable-regex-doc=section/[^\n]+\n|[^\n]+|\n//
+	--_mtable-regex-doc=section///{scope=clear}{tquit}
+
+	--_mtable-regex-doc=subsection/(section )//{_advanceTo=0start}{tleave}{scope=pop}
+	--_mtable-regex-doc=subsection/subsection +([^\n]+)\n/\1/S/{scope=replace}
+	--_mtable-regex-doc=subsection/[^\n]+\n|[^\n]+|\n//
+	--_mtable-regex-doc=subsection///{scope=clear}{tquit}
+
+.. code-block:: console
+
+	% ctags --sort=no --fields=+nl --options=/tmp/doc.ctags -o - /tmp/input.docdoc
+	SEC0	/tmp/input.docdoc	/^section SEC0$/;"	s	line:1	language:doc
+	SUB0-1	/tmp/input.docdoc	/^subsection SUB0-1$/;"	S	line:3	language:doc	section:SEC0
+	SUB0-2	/tmp/input.docdoc	/^subsection SUB0-2$/;"	S	line:5	language:doc	section:SEC0
+	SEC1	/tmp/input.docdoc	/^section SEC1$/;"	s	line:7	language:doc
+	SUB1-1	/tmp/input.docdoc	/^subsection SUB1-1$/;"	S	line:9	language:doc	section:SEC1
+	SUB1-2	/tmp/input.docdoc	/^subsection SUB1-2$/;"	S	line:11	language:doc	section:SEC1
+
+
 NOTE: This flag doesn't work well with ``--mline-regex-<LANG>=``.
 
 Overriding the letter for file kind
diff --git a/docs/parser-gdscript.rst b/docs/parser-gdscript.rst
@@ -10,8 +10,8 @@ for the differences between GDScript and Python. A short list of major
 differences:
 
 - Files are classes. All symbols are attributes of the class defined by the
-file.
+  file.
 - There are no functions because all symbols are class attributes, so all
-"functions" are methods.
+  "functions" are methods.
 - Variables are explicitly declared with the `var` keyword.
 - Enum, signal and const keywords are added.
diff --git a/main/field.c b/main/field.c
@@ -225,7 +225,7 @@ static fieldDefinition fieldDefinitionsExuberant [] = {
 		.dataType           = FIELDTYPE_INTEGER,
 		.getterValueType    = "int",
 		.getValueObject     = getFieldValueForLineCommon,
-		.setterValueType    = "matchlok|int",
+		.setterValueType    = "matchloc|int",
 		.checkValueForSetter= checkFieldValueForLineCommon,
 		.setValueObject     = setFieldValueForLineCommon,
 	},
@@ -432,7 +432,7 @@ static fieldDefinition fieldDefinitionsUniversal [] = {
 		.dataType			= FIELDTYPE_INTEGER,
 		.getterValueType    = "int",
 		.getValueObject     = getFieldValueForLineCommon,
-		.setterValueType    = "matchlok|int",
+		.setterValueType    = "matchloc|int",
 		.checkValueForSetter= checkFieldValueForLineCommon,
 		.setValueObject     = setFieldValueForLineCommon,
 
diff --git a/main/lregex.c b/main/lregex.c
diff --git a/man/ctags-optlib.7.rst.in b/man/ctags-optlib.7.rst.in
diff --git a/misc/optlib2c b/misc/optlib2c
diff --git a/optlib/man.c b/optlib/man.c
diff --git a/optlib/man.ctags b/optlib/man.ctags

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +REF A
 +REF B
 +DEF C
 +REF D
++