From 307703be886c0740f517fbdc821ca2950aa6a0f4 Mon Sep 17 00:00:00 2001 From: muzimuzhi Date: Tue, 11 Jan 2022 18:01:42 +0800 Subject: [PATCH] fix(gd): Wrap node name in `\tikz@pp@name` #1119 * fix(gd): Wrap node name in `\tikz@pp@name` when tikz calls `\pgfgdedge`. Signed-off-by: muzimuzhi * fix(gd): Add `\tikz@pp@name` for edge kind `-!-` Signed-off-by: muzimuzhi * test(gd)!: New test set and its first test The gd test set only runs on LuaTeX. `pgfgd-debug.lua` adds debugging code to `InterfaceToDisplay` functions which helps in checking tests based on states of display layer (Lua), rather than box content. Signed-off-by: muzimuzhi * chore: Add changelog entries Signed-off-by: muzimuzhi * test(gd): optimize Lua code Signed-off-by: Henri Menke * fixup! test(gd): optimize Lua code Signed-off-by: Henri Menke * fixup! fixup! test(gd): optimize Lua code Signed-off-by: Henri Menke * feat(ci): Archive failed test output for all test sets This extends #1114, commit 2bff7c61e21122063e3492fe71b7b13f026dfa64 Signed-off-by: muzimuzhi * fixup! fixup! fixup! test(gd): optimize Lua code - Load `pgfgd-test.lua` after gd lib. - Update test file (no prefix, no ending period). Signed-off-by: muzimuzhi Co-authored-by: Henri Menke --- .github/workflows/check.yml | 2 +- build.lua | 3 + config-gd.lua | 5 ++ doc/generic/pgf/CHANGELOG.md | 2 + testfiles-gd/support/pgfgd-debug.lua | 32 +++++++++ .../support/pgfgd-regression-test.tex | 5 ++ testfiles-gd/tikz-gd-gh1087.lvt | 66 +++++++++++++++++++ testfiles-gd/tikz-gd-gh1087.tlg | 57 ++++++++++++++++ .../graphs/tikzlibrarygraphs.code.tex | 2 +- .../tex/tikzlibrarygraphdrawing.code.tex | 19 ++++-- 10 files changed, 184 insertions(+), 9 deletions(-) create mode 100644 config-gd.lua create mode 100644 testfiles-gd/support/pgfgd-debug.lua create mode 100644 testfiles-gd/support/pgfgd-regression-test.tex create mode 100644 testfiles-gd/tikz-gd-gh1087.lvt create mode 100644 testfiles-gd/tikz-gd-gh1087.tlg diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml index eab054a22..089beec13 100644 --- a/.github/workflows/check.yml +++ b/.github/workflows/check.yml @@ -31,4 +31,4 @@ jobs: uses: actions/upload-artifact@v2 with: name: test-diff-files - path: build/test/*.diff + path: build/test*/*.diff diff --git a/build.lua b/build.lua index 4951ccf59..cffe654b9 100644 --- a/build.lua +++ b/build.lua @@ -40,6 +40,9 @@ specialformats["latex"] = specialformats["latex"] or } checkengines = {"pdftex", "latexdvips", "latexdvisvgm", "luatex", "xetex"} +-- Use multiple sets of tests +checkconfigs = { "build", "config-gd" } + --- Keep all \special data (may one day be the l3build default) maxprintline = 9999 diff --git a/config-gd.lua b/config-gd.lua new file mode 100644 index 000000000..2b11da78a --- /dev/null +++ b/config-gd.lua @@ -0,0 +1,5 @@ +-- Tests for graph drawing (gd) library + +stdengine = "luatex" +checkengines = {"luatex"} +testfiledir = "testfiles-gd" diff --git a/doc/generic/pgf/CHANGELOG.md b/doc/generic/pgf/CHANGELOG.md index 63068af68..805080ab4 100644 --- a/doc/generic/pgf/CHANGELOG.md +++ b/doc/generic/pgf/CHANGELOG.md @@ -23,6 +23,7 @@ lot of contributed changes. Thanks to everyone who volunteered their time! - Add Matrix chat to README - Add rhombic polihedra #1022 - Add Developer Certificate of Origin (DCO) to Pull Request template and enforce +- Add test set for `graphdrawing` (gd) ### Fixed @@ -58,6 +59,7 @@ lot of contributed changes. Thanks to everyone who volunteered their time! - Suppress white space at line end when `datavisualization` reads from a file #1112 - Form-only patterns have no specified color #1122 +- Make `graphdrawing` work with `name prefix` and `name suffix` options #1087 ### Changed diff --git a/testfiles-gd/support/pgfgd-debug.lua b/testfiles-gd/support/pgfgd-debug.lua new file mode 100644 index 000000000..0f613ba6d --- /dev/null +++ b/testfiles-gd/support/pgfgd-debug.lua @@ -0,0 +1,32 @@ +local InterfaceToDisplay = assert(pgf.gd.interface.InterfaceToDisplay) + +-- helper +local function typeout(...) + texio.write_nl(17, "Gd Lua layer Info: " .. string.format(...)) +end + +local createVertex = assert(InterfaceToDisplay.createVertex) +function InterfaceToDisplay.createVertex(name, ...) + typeout("Create vertex '%s'", name) + createVertex(name, ...) +end + +local createEdge = assert(InterfaceToDisplay.createEdge) +function InterfaceToDisplay.createEdge(tail, head, direction, ...) + typeout("Create edge '%s' from '%s' to '%s'", direction, tail, head) + createEdge(tail, head, direction, ...) +end + +--[[ this generates too many debugging lines +local createEvent = assert(InterfaceToDisplay.createEvent) +function InterfaceToDisplay.createEvent(kind, ...) + typeout("Create event '%s'", kind) + return createEvent(kind, ...) +end +--]] + +local addToVertexOptions = assert(InterfaceToDisplay.addToVertexOptions) +function InterfaceToDisplay.addToVertexOptions(name, ...) + typeout("Add options to vertex '%s'", name) + addToVertexOptions(name, ...) +end diff --git a/testfiles-gd/support/pgfgd-regression-test.tex b/testfiles-gd/support/pgfgd-regression-test.tex new file mode 100644 index 000000000..dc713496f --- /dev/null +++ b/testfiles-gd/support/pgfgd-regression-test.tex @@ -0,0 +1,5 @@ +\input regression-test.tex + +\ifdefined\directlua + \AtBeginDocument{\directlua{dofile('pgfgd-debug.lua')}} +\fi diff --git a/testfiles-gd/tikz-gd-gh1087.lvt b/testfiles-gd/tikz-gd-gh1087.lvt new file mode 100644 index 000000000..4e9daec06 --- /dev/null +++ b/testfiles-gd/tikz-gd-gh1087.lvt @@ -0,0 +1,66 @@ +\documentclass{minimal} +\input{pgfgd-regression-test} + +\RequirePackage{tikz} +\usetikzlibrary{graphs, graphdrawing} +\usegdlibrary{layered} + +\makeatletter +\def\pgfutil@packageerror#1#2#3{\immediate\write17{Package #1 Error: #2.}} +\makeatother +\begin{document} + +\START + +% use all five edge kinds +% make node names variable, to prevent false negative results +\def\testgraph#1{ a#1 -> {b#1, c#1 <-> d#1} -- e#1 <- f#1; a#1 -!- f#1; } +\SEPARATOR +\TYPE{Base graph: \testgraph{}} +\SEPARATOR + +\BEGINTEST{Empty `name prefix`} +\tikzpicture + \graph[layered layout] { [parse/.expand once=\testgraph{1}] }; + \path (b1); + \path[name prefix=z-] (b1); +\endtikzpicture +\ENDTEST + +\BEGINTEST{Non-empty `name prefix`} +\tikzpicture[name prefix=x-] + \graph[layered layout] { [parse/.expand once=\testgraph{2}] }; + + % works + \path (b2) (x-b2); + \path[name prefix=] (x-b2); + \path[name prefix=y-] (x-b2); + + % should throw errors + \path[name prefix=] (b2); +\endtikzpicture +\ENDTEST + +\BEGINTEST{Simple non-gd graph + Empty `name suffix`} +\tikzpicture + \graph { [parse/.expand once=\testgraph{3}] }; + \path (b3); + \path[name suffix=-z] (b3); +\endtikzpicture +\ENDTEST + +\BEGINTEST{Simple non-gd graph + Non-empty `name suffix`} +\tikzpicture[name suffix=-x] + \graph { [parse/.expand once=\testgraph{4}] }; + + % works + \path (b4) (b4-x); + \path[name suffix=] (b4-x); + \path[name suffix=-y] (b4-x); + + % throws errors + \path[name suffix=] (b4); +\endtikzpicture +\ENDTEST + +\END diff --git a/testfiles-gd/tikz-gd-gh1087.tlg b/testfiles-gd/tikz-gd-gh1087.tlg new file mode 100644 index 000000000..d970903b1 --- /dev/null +++ b/testfiles-gd/tikz-gd-gh1087.tlg @@ -0,0 +1,57 @@ +This is a generated file for the l3build validation system. +Don't change this file in any respect. +============================================================ +Base graph: a -> {b, c <-> d} -- e <- f; a -!- f; +============================================================ +============================================================ +TEST 1: Empty `name prefix` +============================================================ +Gd Lua layer Info: Create vertex 'a1' +Gd Lua layer Info: Create vertex 'b1' +Gd Lua layer Info: Create vertex 'c1' +Gd Lua layer Info: Create vertex 'd1' +Gd Lua layer Info: Create edge '<->' from 'c1' to 'd1' +Gd Lua layer Info: Create edge '->' from 'a1' to 'b1' +Gd Lua layer Info: Create edge '->' from 'a1' to 'c1' +Gd Lua layer Info: Create vertex 'e1' +Gd Lua layer Info: Create edge '--' from 'b1' to 'e1' +Gd Lua layer Info: Create edge '--' from 'd1' to 'e1' +Gd Lua layer Info: Create vertex 'f1' +Gd Lua layer Info: Create edge '<-' from 'e1' to 'f1' +Gd Lua layer Info: Add options to vertex 'a1' +Gd Lua layer Info: Add options to vertex 'a1' +Gd Lua layer Info: Add options to vertex 'f1' +Gd Lua layer Info: Add options to vertex 'f1' +Gd Lua layer Info: Create edge '-!-' from 'a1' to 'f1' +============================================================ +============================================================ +TEST 2: Non-empty `name prefix` +============================================================ +Gd Lua layer Info: Create vertex 'x-a2' +Gd Lua layer Info: Create vertex 'x-b2' +Gd Lua layer Info: Create vertex 'x-c2' +Gd Lua layer Info: Create vertex 'x-d2' +Gd Lua layer Info: Create edge '<->' from 'x-c2' to 'x-d2' +Gd Lua layer Info: Create edge '->' from 'x-a2' to 'x-b2' +Gd Lua layer Info: Create edge '->' from 'x-a2' to 'x-c2' +Gd Lua layer Info: Create vertex 'x-e2' +Gd Lua layer Info: Create edge '--' from 'x-b2' to 'x-e2' +Gd Lua layer Info: Create edge '--' from 'x-d2' to 'x-e2' +Gd Lua layer Info: Create vertex 'x-f2' +Gd Lua layer Info: Create edge '<-' from 'x-e2' to 'x-f2' +Gd Lua layer Info: Add options to vertex 'x-a2' +Gd Lua layer Info: Add options to vertex 'x-a2' +Gd Lua layer Info: Add options to vertex 'x-f2' +Gd Lua layer Info: Add options to vertex 'x-f2' +Gd Lua layer Info: Create edge '-!-' from 'x-a2' to 'x-f2' +Package pgf Error: No shape named `b2' is known. +============================================================ +============================================================ +TEST 3: Simple non-gd graph + Empty `name suffix` +============================================================ +============================================================ +============================================================ +TEST 4: Simple non-gd graph + Non-empty `name suffix` +============================================================ +Package pgf Error: No shape named `b4' is known. +============================================================ diff --git a/tex/generic/pgf/frontendlayer/tikz/libraries/graphs/tikzlibrarygraphs.code.tex b/tex/generic/pgf/frontendlayer/tikz/libraries/graphs/tikzlibrarygraphs.code.tex index ce7db967e..ac65e119b 100644 --- a/tex/generic/pgf/frontendlayer/tikz/libraries/graphs/tikzlibrarygraphs.code.tex +++ b/tex/generic/pgf/frontendlayer/tikz/libraries/graphs/tikzlibrarygraphs.code.tex @@ -1208,7 +1208,7 @@ % % Handle late options and operators \tikzgraphsset{source,target,.unknown/.code=,#1}% - \tikzgdlatenodeoptionacallback{\tikz@lib@graph@name}% + \tikzgdlatenodeoptionacallback{\tikz@pp@name\tikz@lib@graph@name}% \node also[graphs/redirect unknown to tikz,/tikz/graphs/.cd,#1](\tikz@lib@graph@name);% \pgfkeysvalueof{/tikz/graphs/@operators}% }% diff --git a/tex/generic/pgf/graphdrawing/tex/tikzlibrarygraphdrawing.code.tex b/tex/generic/pgf/graphdrawing/tex/tikzlibrarygraphdrawing.code.tex index 32d1b1b7a..aac7311e3 100644 --- a/tex/generic/pgf/graphdrawing/tex/tikzlibrarygraphdrawing.code.tex +++ b/tex/generic/pgf/graphdrawing/tex/tikzlibrarygraphdrawing.code.tex @@ -83,15 +83,20 @@ % % Setup for the graphs syntax % - /tikz/graphs/new ->/.code n args={4}{\pgfgdedge{##1}{##2}{->}{/tikz,##3}{##4}}, - /tikz/graphs/new <-/.code n args={4}{\pgfgdedge{##1}{##2}{<-}{/tikz,##3}{##4}}, - /tikz/graphs/new --/.code n args={4}{\pgfgdedge{##1}{##2}{--}{/tikz,##3}{##4}}, - /tikz/graphs/new <->/.code n args={4}{\pgfgdedge{##1}{##2}{<->}{/tikz,##3}{##4}}, - /tikz/graphs/new -!-/.code n args={4}{\pgfgdedge{##1}{##2}{-!-}{/tikz,##3}{##4}}, + /tikz/graphs/new ->/.code n args={4}{\tikz@lib@gd@edge{##1}{##2}{->}{/tikz,##3}{##4}}, + /tikz/graphs/new <-/.code n args={4}{\tikz@lib@gd@edge{##1}{##2}{<-}{/tikz,##3}{##4}}, + /tikz/graphs/new --/.code n args={4}{\tikz@lib@gd@edge{##1}{##2}{--}{/tikz,##3}{##4}}, + /tikz/graphs/new <->/.code n args={4}{\tikz@lib@gd@edge{##1}{##2}{<->}{/tikz,##3}{##4}}, + /tikz/graphs/new -!-/.code n args={4}{\tikz@lib@gd@edge{##1}{##2}{-!-}{/tikz,##3}{##4}}, /tikz/graphs/placement/compute position/.code=,% } }% +% wrapper for \pgfgdedge +\def\tikz@lib@gd@edge#1#2{% + \pgfgdedge{\tikz@pp@name{#1}}{\tikz@pp@name{#2}}% +} + \pgfgdaddprepareedgehook{ \tikz@enable@edge@quotes% \let\tikz@transform=\pgfutil@empty% @@ -130,11 +135,11 @@ }% \def\tikz@gd@edge@from@parent@macro#1#2{ - [/utils/exec=\pgfgdedge{\tikzparentnode}{\tikzchildnode}{--}{/tikz,#1}{#2}] + [/utils/exec=\tikz@lib@gd@edge{\tikzparentnode}{\tikzchildnode}{--}{/tikz,#1}{#2}] }% \def\tikz@gd@plain@edge@macro#1#2{ - \pgfgdedge{\tikztostart}{\tikztotarget}{--}{/tikz,#1}{#2} + \tikz@lib@gd@edge{\tikztostart}{\tikztotarget}{--}{/tikz,#1}{#2} }%