Skip to content

WriteChunks: write all chunks before checking insertion status #372

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ChrisJefferson wants to merge 1 commit into
base: master
Choose a base branch
from
Open

WriteChunks: write all chunks before checking insertion status #372

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 23 additions & 11 deletions gap/DocumentationTree.gi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -479,6 +479,29 @@ BindGlobal( "WriteChunks",
chunks_stream := AUTODOC_OutputTextFile( path_to_xmlfiles, filename );
chunk_names := RecNames( tree!.chunks );

# Write out every chunk first. Writing a chunk whose body contains a
# nested @InsertChunk marks the inserted chunk as inserted, so all chunk
# bodies must be written before we can decide which chunks were never
# inserted -- otherwise a chunk used only from within a later-written
# chunk is spuriously flagged, depending on iteration order.
for current_chunk_name in chunk_names do
current_chunk := tree!.chunks.( current_chunk_name );
AppendTo( chunks_stream, "<#GAPDoc Label=\"", current_chunk_name, "\">\n" );
if IsBound( current_chunk!.content ) then
AUTODOC_WriteDocumentationListWithSource(
current_chunk!.content,
current_chunk!.content_source_positions,
chunks_stream
);
fi;
AppendTo( chunks_stream, "\n<#/GAPDoc>\n" );
od;

CloseStream( chunks_stream );

# Now that every insertion (including those nested inside other chunks)
# has been resolved, warn about chunks that are defined but never inserted,
# or inserted but never defined.
for current_chunk_name in chunk_names do
current_chunk := tree!.chunks.( current_chunk_name );
if current_chunk!.is_defined = true and current_chunk!.is_inserted = false then
Expand All @@ -498,19 +521,8 @@ BindGlobal( "WriteChunks",
" was inserted but never defined"
);
fi;
AppendTo( chunks_stream, "<#GAPDoc Label=\"", current_chunk_name, "\">\n" );
if IsBound( current_chunk!.content ) then
AUTODOC_WriteDocumentationListWithSource(
current_chunk!.content,
current_chunk!.content_source_positions,
chunks_stream
);
fi;
AppendTo( chunks_stream, "\n<#/GAPDoc>\n" );
od;

CloseStream( chunks_stream );

end );

##
Expand Down