Merge pull request #4249 from masatake/prolog

Prolog: new parser

Author: masatake

Tmain/extras-long.d/stdout-expected.txt

@@ -15,6 +15,7 @@ z       nulltag             no      NONE        no      1 Include tags with empt
 -       configPrefixed      yes     Kconfig     no      0 prepend CONFIG_ to config names
 -       CppDef              no      Make        no      1 Include FOO in -DFOO as as a name of CPreProcessor macro
 -       guessedFromFileName yes     PkgConfig   no      0 the guessed package name of the .pc file
+-       arityAppended       yes     Prolog      no      0 Include predicates with their arities
 -       funcmap             yes     QemuHX      no      0 Include mapping SQMP to C function name
 -       whitespaceSwapped   yes     Robot       no      0 Include tags swapping whitespace and underscore chars
 # enabling 1
@@ -34,6 +35,7 @@ z       nulltag             no      NONE        no      1 Include tags with empt
 -       configPrefixed      yes     Kconfig     no      0 prepend CONFIG_ to config names
 -       CppDef              no      Make        no      1 Include FOO in -DFOO as as a name of CPreProcessor macro
 -       guessedFromFileName yes     PkgConfig   no      0 the guessed package name of the .pc file
+-       arityAppended       yes     Prolog      no      0 Include predicates with their arities
 -       funcmap             yes     QemuHX      no      0 Include mapping SQMP to C function name
 -       whitespaceSwapped   yes     Robot       no      0 Include tags swapping whitespace and underscore chars
 # disabling 1
@@ -53,6 +55,7 @@ z       nulltag             no      NONE        no      1 Include tags with empt
 -       configPrefixed      yes     Kconfig     no      0 prepend CONFIG_ to config names
 -       CppDef              no      Make        no      1 Include FOO in -DFOO as as a name of CPreProcessor macro
 -       guessedFromFileName yes     PkgConfig   no      0 the guessed package name of the .pc file
+-       arityAppended       yes     Prolog      no      0 Include predicates with their arities
 -       funcmap             yes     QemuHX      no      0 Include mapping SQMP to C function name
 -       whitespaceSwapped   yes     Robot       no      0 Include tags swapping whitespace and underscore chars
 # combination
@@ -72,6 +75,7 @@ z       nulltag             no      NONE        no      1 Include tags with empt
 -       configPrefixed      yes     Kconfig     no      0 prepend CONFIG_ to config names
 -       CppDef              no      Make        no      1 Include FOO in -DFOO as as a name of CPreProcessor macro
 -       guessedFromFileName yes     PkgConfig   no      0 the guessed package name of the .pc file
+-       arityAppended       yes     Prolog      no      0 Include predicates with their arities
 -       funcmap             yes     QemuHX      no      0 Include mapping SQMP to C function name
 -       whitespaceSwapped   yes     Robot       no      0 Include tags swapping whitespace and underscore chars
 # combination with letters
@@ -91,5 +95,6 @@ z       nulltag             no      NONE        no      1 Include tags with empt
 -       configPrefixed      yes     Kconfig     no      0 prepend CONFIG_ to config names
 -       CppDef              no      Make        no      1 Include FOO in -DFOO as as a name of CPreProcessor macro
 -       guessedFromFileName yes     PkgConfig   no      0 the guessed package name of the .pc file
+-       arityAppended       yes     Prolog      no      0 Include predicates with their arities
 -       funcmap             yes     QemuHX      no      0 Include mapping SQMP to C function name
 -       whitespaceSwapped   yes     Robot       no      0 Include tags swapping whitespace and underscore chars

Tmain/list-extras.d/stdout-expected.txt

@@ -15,6 +15,7 @@ z       nulltag             yes     NONE        no      1 Include tags with empt
 -       configPrefixed      yes     Kconfig     no      0 prepend CONFIG_ to config names
 -       CppDef              no      Make        no      1 Include FOO in -DFOO as as a name of CPreProcessor macro
 -       guessedFromFileName yes     PkgConfig   no      0 the guessed package name of the .pc file
+-       arityAppended       yes     Prolog      no      0 Include predicates with their arities
 -       funcmap             yes     QemuHX      no      0 Include mapping SQMP to C function name
 -       whitespaceSwapped   yes     Robot       no      0 Include tags swapping whitespace and underscore chars
 #LETTER	NAME	ENABLED	LANGUAGE	FIXED	VER	DESCRIPTION
@@ -34,6 +35,7 @@ z	nulltag	yes	NONE	no	1	Include tags with empty strings as their names
 -	configPrefixed	yes	Kconfig	no	0	prepend CONFIG_ to config names
 -	CppDef	no	Make	no	1	Include FOO in -DFOO as as a name of CPreProcessor macro
 -	guessedFromFileName	yes	PkgConfig	no	0	the guessed package name of the .pc file
+-	arityAppended	yes	Prolog	no	0	Include predicates with their arities
 -	funcmap	yes	QemuHX	no	0	Include mapping SQMP to C function name
 -	whitespaceSwapped	yes	Robot	no	0	Include tags swapping whitespace and underscore chars
 #LETTER NAME      ENABLED LANGUAGE FIXED VER DESCRIPTION

Tmain/list-fields-with-prefix.d/stdout-expected.txt

@@ -42,6 +42,7 @@ x       UCTAGSxpath          no      NONE             s--    no    --   0 xpath
 -       UCTAGSprotocols      yes     ObjectiveC       s--    no    --   0 protocols that the class (or category) confirms to
 -       UCTAGShome           yes     Passwd           s--    no    rw   0 home directory
 -       UCTAGSshell          yes     Passwd           s--    no    rw   0 login shell
+-       UCTAGSarity          yes     Prolog           -i-    no    --   0 the number of parameters
 -       UCTAGSdecorators     no      Python           s--    no    --   0 decorators on functions and classes
 -       UCTAGSnameref        yes     Python           s--    no    --   0 the original name for the tag
 -       UCTAGSassignmentop   no      R                s--    no    --   0 operator for assignment

Tmain/list-fields.d/stdout-expected.txt

@@ -60,6 +60,7 @@ z	kind	no	NONE	s--	no	r-	0	[tags output] prepend "kind:" to k/ (or K/) field out
 -	protocols	yes	ObjectiveC	s--	no	--	0	protocols that the class (or category) confirms to
 -	home	yes	Passwd	s--	no	rw	0	home directory
 -	shell	yes	Passwd	s--	no	rw	0	login shell
+-	arity	yes	Prolog	-i-	no	--	0	the number of parameters
 -	decorators	no	Python	s--	no	--	0	decorators on functions and classes
 -	nameref	yes	Python	s--	no	--	0	the original name for the tag
 -	assignmentop	no	R	s--	no	--	0	operator for assignment

Tmain/list-params.d/stdout-expected.txt

@@ -1,16 +1,17 @@
 # ALL
-#LANGUAGE      NAME              DESCRIPTION
-Asm            commentCharsAtBOL line comment chraracters at the beginning of line ([;*@])
-Asm            commentCharsInMOL line comment chraracters in the beginning of line ([])
-Asm            extraLinesepChars extra characters used as a line separator ([])
-Asm            useCPreProcessor  run CPreProcessor parser for extracting macro definitions ([true] or false)
-CPreProcessor  _expand           expand macros if their definitions are in the current C/C++/CUDA input file (true or [false])
-CPreProcessor  define            define replacement for an identifier (name(params,...)=definition)
-CPreProcessor  if0               examine code within "#if 0" branch (true or [false])
-CPreProcessor  ignore            a token to be specially handled
-Fypp           guest             parser run after Fypp parser parses the original input ("NONE" or a parser name [Fortran])
-ITcl           forceUse          enable the parser even when `itcl' namespace is not specified in the input (true or [false])
-TclOO          forceUse          enable the parser even when `oo' namespace is not specified in the input (true or [false])
+#LANGUAGE      NAME                DESCRIPTION
+Asm            commentCharsAtBOL   line comment chraracters at the beginning of line ([;*@])
+Asm            commentCharsInMOL   line comment chraracters in the beginning of line ([])
+Asm            extraLinesepChars   extra characters used as a line separator ([])
+Asm            useCPreProcessor    run CPreProcessor parser for extracting macro definitions ([true] or false)
+CPreProcessor  _expand             expand macros if their definitions are in the current C/C++/CUDA input file (true or [false])
+CPreProcessor  define              define replacement for an identifier (name(params,...)=definition)
+CPreProcessor  if0                 examine code within "#if 0" branch (true or [false])
+CPreProcessor  ignore              a token to be specially handled
+Fypp           guest               parser run after Fypp parser parses the original input ("NONE" or a parser name [Fortran])
+ITcl           forceUse            enable the parser even when `itcl' namespace is not specified in the input (true or [false])
+Prolog         allowNestedComments allow nested comments like "/* /* */ */" ([true] or false)
+TclOO          forceUse            enable the parser even when `oo' namespace is not specified in the input (true or [false])
 
 # ALL MACHINABLE
 #LANGUAGE	NAME	DESCRIPTION
@@ -24,6 +25,7 @@ CPreProcessor	if0	examine code within "#if 0" branch (true or [false])
 CPreProcessor	ignore	a token to be specially handled
 Fypp	guest	parser run after Fypp parser parses the original input ("NONE" or a parser name [Fortran])
 ITcl	forceUse	enable the parser even when `itcl' namespace is not specified in the input (true or [false])
+Prolog	allowNestedComments	allow nested comments like "/* /* */ */" ([true] or false)
 TclOO	forceUse	enable the parser even when `oo' namespace is not specified in the input (true or [false])
 
 # ALL MACHINABLE NOHEADER
@@ -37,6 +39,7 @@ CPreProcessor	if0	examine code within "#if 0" branch (true or [false])
 CPreProcessor	ignore	a token to be specially handled
 Fypp	guest	parser run after Fypp parser parses the original input ("NONE" or a parser name [Fortran])
 ITcl	forceUse	enable the parser even when `itcl' namespace is not specified in the input (true or [false])
+Prolog	allowNestedComments	allow nested comments like "/* /* */ */" ([true] or false)
 TclOO	forceUse	enable the parser even when `oo' namespace is not specified in the input (true or [false])
 
 # CPP

Tmain/list-roles.d/stdout-expected.txt

@@ -98,6 +98,7 @@ Perl                    h/heredoc         endmarker          on        0 end mar
 PkgConfig               p/pkg             conflicted         on        0 conflicted
 PkgConfig               p/pkg             provided           on        0 provided
 PkgConfig               p/pkg             required           on        0 required
+Prolog                  m/module          chainElt           off       0 (EXPERIMENTAL)used as an element in a module-qualified atom like module:predicate
 Protobuf                D/protodef        imported           on        0 imported
 Protobuf                m/message         extension          on        0 extending the message
 Python                  Y/unknown         imported           on        0 imported from the other module
@@ -248,6 +249,7 @@ Perl                    h/heredoc         endmarker          on        0 end mar
 PkgConfig               p/pkg             conflicted         on        0 conflicted
 PkgConfig               p/pkg             provided           on        0 provided
 PkgConfig               p/pkg             required           on        0 required
+Prolog                  m/module          chainElt           off       0 (EXPERIMENTAL)used as an element in a module-qualified atom like module:predicate
 Protobuf                D/protodef        imported           on        0 imported
 Protobuf                m/message         extension          on        0 extending the message
 Python                  Y/unknown         imported           on        0 imported from the other module

Units/parser-prolog.r/code.d/args.ctags

@@ -0,0 +1,4 @@
+-G
+--sort=no
+--extras=+q
+--fields=+neEK

Units/parser-prolog.r/code.d/expected.tags

@@ -0,0 +1,12 @@
+unicode_file_name	input.pl	/^unicode_file_name(Name) :-$/;"	predicate	line:44	end:47	arity:1
+unicode_file_name/1	input.pl	/^unicode_file_name(Name) :-$/;"	predicate	line:44	extras:arityAppended	end:47	arity:1
+unicode_file	input.pl	/^unicode_file(mkdir-1) :-                        % create Cyrillic directory$/;"	predicate	line:49	end:58	arity:1
+unicode_file/1	input.pl	/^unicode_file(mkdir-1) :-                        % create Cyrillic directory$/;"	predicate	line:49	extras:arityAppended	end:58	arity:1
+unicode_file	input.pl	/^unicode_file(file-1) :-                         % create Cyrillic file$/;"	predicate	line:59	end:71	arity:1
+unicode_file/1	input.pl	/^unicode_file(file-1) :-                         % create Cyrillic file$/;"	predicate	line:59	extras:arityAppended	end:71	arity:1
+unicode_file	input.pl	/^unicode_file(absfile-1) :-$/;"	predicate	line:72	end:78	arity:1
+unicode_file/1	input.pl	/^unicode_file(absfile-1) :-$/;"	predicate	line:72	extras:arityAppended	end:78	arity:1
+unicode_file	input.pl	/^unicode_file(ext-1) :-$/;"	predicate	line:79	end:83	arity:1
+unicode_file/1	input.pl	/^unicode_file(ext-1) :-$/;"	predicate	line:79	extras:arityAppended	end:83	arity:1
+seek	input.pl	/^seek(write-1) :-$/;"	predicate	line:90	end:108	arity:1
+seek/1	input.pl	/^seek(write-1) :-$/;"	predicate	line:90	extras:arityAppended	end:108	arity:1

Units/parser-prolog.r/code.d/input.pl

@@ -0,0 +1,108 @@
+% Taken from pl-9.2.9-build/swipl-9.2.9/src/test.pl
+% 0'. can be a trouble.
+
+/*  Part of SWI-Prolog
+
+    Author:        Jan Wielemaker and Anjo Anjewierden
+    E-mail:        [email protected]
+    WWW:           http://www.swi-prolog.org
+    Copyright (c)  1996-2023, University of Amsterdam
+                              VU University Amsterdam
+                              CWI, Amsterdam
+                              SWI-Prolog Solutions b.v.
+    All rights reserved.
+
+    Redistribution and use in source and binary forms, with or without
+    modification, are permitted provided that the following conditions
+    are met:
+
+    1. Redistributions of source code must retain the above copyright
+       notice, this list of conditions and the following disclaimer.
+
+    2. Redistributions in binary form must reproduce the above copyright
+       notice, this list of conditions and the following disclaimer in
+       the documentation and/or other materials provided with the
+       distribution.
+
+    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+    "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+    FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+    COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+    INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+    BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+    LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+    LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+    ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+    POSSIBILITY OF SUCH DAMAGE.
+*/
+                 /*******************************
+                 *      UNICODE FILENAMES       *
+                 *******************************/
+
+unicode_file_name(Name) :-
+    current_prolog_flag(pid, Pid),
+    atom_codes(Name0, [1074, 1086, 1079, 1076, 1091, 1093, 1072]),
+    atomic_list_concat([Name0, -, Pid], Name).
+
+unicode_file(mkdir-1) :-                        % create Cyrillic directory
+    unicode_file_name(Dir),
+    catch(delete_directory(Dir), _, true),
+    make_directory(Dir),
+    exists_directory(Dir),
+    working_directory(Old, Dir),
+    working_directory(O2, '..'),
+    same_file(Old, '.'),
+    same_file(O2, Dir),
+    delete_directory(Dir).
+unicode_file(file-1) :-                         % create Cyrillic file
+    unicode_file_name(File),
+    Term = hello(world),
+    catch(delete_file(File), _, true),
+    open(File, write, Out),
+    format(Out, '~q.~n', [Term]),
+    close(Out),
+    exists_file(File),
+    open(File, read, In),
+    read(In, Read),
+    close(In),
+    Read =@= Term,
+    delete_file(File).
+unicode_file(absfile-1) :-
+    unicode_file_name(File),
+    absolute_file_name(File, Path),
+    file_directory_name(Path, Dir),
+    same_file(Dir, '.'),
+    file_base_name(Path, Base),
+    Base == File.
+unicode_file(ext-1) :-
+    atom_codes(File, [1074, 1086, 1079, 1076, 0'., 1091, 1093, 1072]),
+    file_name_extension(Base, Ext, File),
+    atom_codes(Base, [1074, 1086, 1079, 1076]),
+    atom_codes(Ext, [1091, 1093, 1072]).
+
+
+                 /*******************************
+                 *              SEEK            *
+                 *******************************/
+
+seek(write-1) :-
+    tmp_file(seek, File),
+    open(File, write, S, [type(binary)]),
+    Max = 999,
+    forall(between(0, Max, _),
+           format(S, '1234567890~n', [])),
+    forall(between(0, Max, N),
+           (   Pos is N * 11 + 6,
+               seek(S, Pos, bof, _),
+               format(S, 'x', [])
+           )),
+    close(S),
+
+    open(File, read, In, [type(binary)]),
+    atom_codes('123456x890\n', Bytes),
+    forall(between(0, Max, N),
+           must_read(Bytes, In)),
+    close(In),
+    delete_file(File).

Units/parser-prolog.r/dcg.d/args.ctags

@@ -0,0 +1,3 @@
+-G
+--sort=no
+--fields=+neEK