fix: broken refs in generated html (#656)

fixes #641

---------

Signed-off-by: james-ball-qualcomm <quic_jameball@quicinc.com>

Author: james-ball-qualcomm

backends/cfg_html_doc/adoc_gen.rake

@@ -29,14 +29,14 @@ require "ruby-prof"
       cfg_arch.transitive_implemented_csrs.each do |csr|
         path = dir_path / "#{csr.name}.adoc"
         puts "  Generating #{path}"
-        File.write(path, cfg_arch.convert_monospace_to_links(erb.result(binding)))
+        File.write(path, AntoraUtils.resolve_links(cfg_arch.convert_monospace_to_links(erb.result(binding))))
       end
     when "inst"
       cfg_arch.transitive_implemented_instructions.each do |inst|
         path = dir_path / "#{inst.name}.adoc"
         puts "  Generating #{path}"
         # RubyProf.start
-        File.write(path, cfg_arch.convert_monospace_to_links(erb.result(binding)))
+        File.write(path, AntoraUtils.resolve_links(cfg_arch.convert_monospace_to_links(erb.result(binding))))
         # result = RubyProf.stop
         # RubyProf::FlatPrinter.new(result).print(STDOUT)
       end
@@ -45,13 +45,13 @@ require "ruby-prof"
         ext = cfg_arch.extension(ext_version.name)
         path = dir_path / "#{ext.name}.adoc"
         puts "  Generating #{path}"
-        File.write(path, cfg_arch.convert_monospace_to_links(erb.result(binding)))
+        File.write(path, AntoraUtils.resolve_links(cfg_arch.convert_monospace_to_links(erb.result(binding))))
       end
     when "func"
       global_symtab = cfg_arch.symtab
       path = dir_path / "funcs.adoc"
       puts "  Generating #{path}"
-      File.write(path, cfg_arch.convert_monospace_to_links(erb.result(binding)))
+      File.write(path, AntoraUtils.resolve_links(cfg_arch.convert_monospace_to_links(erb.result(binding))))
     else
       raise "todo"
     end
@@ -106,7 +106,7 @@ require "ruby-prof"
       raise "Unsupported type"
     end
 
-    File.write t.name, cfg_arch.convert_monospace_to_links(lines.join("\n"))
+    File.write t.name, AntoraUtils.resolve_links(cfg_arch.convert_monospace_to_links(lines.join("\n")))
   end
 end
 

backends/cfg_html_doc/templates/toc.adoc.erb

@@ -2,17 +2,17 @@
 
 .Extensions
 <%- cfg_arch.transitive_implemented_extension_versions.sort { |a, b| a.name <=> b.name }.each do |ext| -%>
-* %%LINK%ext;<%= ext.name %>;<%= ext.name %>%%
+* <%= link_to_udb_doc_ext(ext.name) %>
 <%- end -%>
 
 .Control and Status Registers
 <%- cfg_arch.transitive_implemented_csrs.sort { |a, b| a.name <=> b.name }.each do |csr| -%>
-* %%UDB_DOC_LINK%csr;<%= csr.name %>;<%= csr.name %>%%
+* <%= link_to_udb_doc_csr(csr.name) %>
 <%- end -%>
 
 .Instructions
 <%- cfg_arch.transitive_implemented_instructions.sort { |a, b| a.name <=> b.name }.each do |inst| -%>
-* %%UDB_DOC_LINK%inst;<%= inst.name %>;<%= inst.name %>%%
+* <%= link_to_udb_doc_inst(inst.name) %>
 <%- end -%>
 
 .IDL functions

backends/manual/tasks.rake

@@ -138,7 +138,7 @@ rule %r{#{MANUAL_GEN_DIR}/.*/.*/antora/nav.adoc} => proc { |tname|
   erb.filename = nav_template_path.to_s
 
   FileUtils.mkdir_p File.dirname(t.name)
-  File.write t.name, erb.result(binding)
+  File.write t.name, AntoraUtils.resolve_links(erb.result(binding))
 end
 
 # Rule to create start page for a manual version

lib/idl/passes/gen_adoc.rb

@@ -274,7 +274,7 @@ def gen_adoc(indent = 0, indent_spaces: 2)
       after_name = []
       after_name << "<#{template_arg_nodes.map { |t| t.gen_adoc(0, indent_spaces:)}.join(', ')}>" unless template_arg_nodes.empty?
       after_name << "pass:[(]#{arg_nodes.map { |a| a.gen_adoc(0, indent_spaces: ) }.join(', ')})"
-      "#{' '*indent}%%LINK%func;#{name};#{name}%%#{after_name.join ''}"
+      "#{' '*indent}" + link_to_udb_doc_idl_func("#{name}") + "#{after_name.join ''}"
     end
   end
 
@@ -292,15 +292,13 @@ def gen_adoc(indent = 0, indent_spaces: 2)
 
   class CsrFieldReadExpressionAst
     def gen_adoc(indent = 0, indent_spaces: 2)
-      csr_text = "CSR[#{@csr_obj.name}].#{@field_name}"
-      "#{' '*indent}%%LINK%csr_field;#{@csr_obj.name}.#{@field_name};#{csr_text}%%"
+      "#{' '*indent}" + link_to_udb_doc_csr_field("#{@csr_obj.name}", "#{@field_name}")
     end
   end
 
   class CsrReadExpressionAst
     def gen_adoc(indent = 0, indent_spaces: 2)
-      csr_text = "CSR[#{csr_name}]"
-      "#{' '*indent}%%LINK%csr;#{csr_name};#{csr_text}%%"
+      "#{' '*indent}" + link_to_udb_doc_csr("#{csr_name}")
     end
   end