[#241] Temporary fix anchor names for fields, cases, items, values, etc.

ndsev · Sep 25, 2020 · 8fd4c30 · 8fd4c30
1 parent d128a45
commit 8fd4c30
Show file tree

Hide file tree

Showing 16 changed files with 41 additions and 58 deletions.
diff --git a/compiler/extensions/doc/freemarker/bitmask.html.ftl b/compiler/extensions/doc/freemarker/bitmask.html.ftl
@@ -25,7 +25,7 @@
       <tr><td>{</td><td rowspan="${values?size+1}">&nbsp;</td><td></td></tr>
 <#list values as value>
           <tr>
-            <td id="tabIndent"><a href="#${value.name}" class="fieldLink">${value.name}</a></td>
+            <td id="tabIndent"><a href="#${anchorName}_${value.name}" class="fieldLink">${value.name}</a></td>
             <td>= ${value.value}<#if value_has_next>,</#if></td>
       </tr>
 </#list>
@@ -38,7 +38,7 @@
 
     <dl>
 <#list values as value>
-      <dt class="memberItem"><a name="${value.name}">${value.name}:</a></dt>
+      <dt class="memberItem"><a name="${anchorName}_${value.name}">${value.name}:</a></dt>
       <dd class="memberDetail">
       <@doc_comment value.docComment/>
   <#list value.usageInfoList as usageInfo>

diff --git a/compiler/extensions/doc/freemarker/choice.html.ftl b/compiler/extensions/doc/freemarker/choice.html.ftl
@@ -4,15 +4,15 @@
 <#include "linkedtype.inc.ftl">
 <#include "usedby.inc.ftl">
 <#include "collaboration_diagram.inc.ftl">
-<#macro choice_field field>
+<#macro choice_field anchorName field>
             <tr class="codeMember">
               <td id="tabIndent"></td>
               <td id="tabIndent">
                 <#if field.isArrayImplicit>implicit </#if><#t>
                   <#lt><@linkedtype field.linkedType/><@compound_field_arguments field.arguments/>
               </td>
               <td>
-                <a href="#${field.name}" class="fieldLink">${field.name}</a><#rt>
+                <a href="#${anchorName}_${field.name}" class="fieldLink">${field.name}</a><#rt>
                   ${field.arrayRange}<#t>
     <#if field.initializerExpression?has_content>
                   <#lt> = ${field.initializerExpression}<#rt>
@@ -64,14 +64,13 @@
               <td id="tabIndent"></td>
               <td colspan=2>
     <#list caseMember.caseList as case>
-                <a name="casedef_${case.expression}"></a>
-                <a href="#case_${case.expression}" class="fieldLink">case ${case.expression}</a>:<#rt>
+                <a name="${anchorName}_casedef_${case.expression}" href="#${anchorName}_case_${case.expression}" class="fieldLink">case ${case.expression}</a>:<#rt>
                   <#lt><#if case?has_next><br/></#if>
     </#list>
               </td>
             </tr>
     <#if caseMember.field??>
-            <@choice_field caseMember.field/>
+            <@choice_field anchorName caseMember.field/>
     <#else>
             <tr>
               <td colspan=2 id="tabIndent"></td>
@@ -83,11 +82,11 @@
             <tr>
               <td id="tabIndent"></td>
               <td colspan=2>
-                <a href="#case_default" class="fieldLink">default</a>:
+                <a href="#${anchorName}_case_default" class="fieldLink">default</a>:
               </td>
             </tr>
     <#if defaultMember.field??>
-            <@choice_field defaultMember.field/>
+            <@choice_field anchorName defaultMember.field/>
     <#else>
             <tr>
               <td colspan=2 id="tabIndent"></td>
@@ -116,7 +115,7 @@
             <dl>
     <#list caseMember.caseList as case>
                 <dt class="memberItem">
-                    <a name="case_${case.expression}">${case.expression}</a>
+                    <a name="${anchorName}_case_${case.expression}">${case.expression}</a>
                 </dt>
                 <dd class="memberDetail">
                     <@doc_comment case.docComment/>
@@ -134,14 +133,14 @@
           <dl>
   <#if caseMember.field??>
               <dt class="memberItem">
-                  <a name="${caseMember.field.name}">${caseMember.field.name}:</a>
+                  <a name="${anchorName}_${caseMember.field.name}">${caseMember.field.name}:</a>
               </dt>
               <dd class="memberDetail">
                   <@doc_comment caseMember.field.docComment/>
               </dd>
   <#else>
               <dt class="memberItem">
-                  <a name="no_field">no member data</a>
+                  <a name="${anchorName}_no_field">no member data</a>
               </dt>
               <dd class="memberDetail">
                   <br />
@@ -160,7 +159,7 @@
         <dd>
             <dl>
                 <dt class="memberItem">
-                    <a name="case_default">default</a>
+                    <a name="${anchorName}_case_default">default</a>
                 </dt>
                 <dd class="memberDetail">
                     <@doc_comment defaultMember.docComment/>
@@ -174,14 +173,14 @@
           <dl>
   <#if defaultMember.field??>
               <dt class="memberItem">
-                  <a name="${defaultMember.field.name}">${defaultMember.field.name}:</a>
+                  <a name="${anchorName}_${defaultMember.field.name}">${defaultMember.field.name}:</a>
               </dt>
               <dd class="memberDetail">
                   <@doc_comment defaultMember.field.docComment/>
               </dd>
   <#else>
               <dt class="memberItem">
-                  <a name="no_field">no member data</a>
+                  <a name="${anchorName}_no_field">no member data</a>
               </dt>
               <dd class="memberDetail">
                   <br />

diff --git a/compiler/extensions/doc/freemarker/compound.inc.ftl b/compiler/extensions/doc/freemarker/compound.inc.ftl
@@ -1,13 +1,13 @@
 <#ftl output_format="HTML">
 <#include "linkedtype.inc.ftl">
 
-<#macro compound_fields fields>
+<#macro compound_fields anchorName fields>
     <#list fields as field>
-        <@compound_field field/>
+        <@compound_field anchorName field/>
     </#list>
 </#macro>
 
-<#macro compound_field field>
+<#macro compound_field anchorName field>
     <#if field.alignmentExpression?has_content>
             <tr class="codeMember">
               <td colspan=3>align(${field.alignmentExpression}):</td>
@@ -27,7 +27,7 @@
                   <#lt><@linkedtype field.linkedType/><@compound_field_arguments field.arguments/>
               </td>
               <td>
-                <a href="#${field.name}" class="fieldLink">${field.name}</a><#rt>
+                <a href="#${anchorName}_${field.name}" class="fieldLink">${field.name}</a><#rt>
                   ${field.arrayRange}<#t>
     <#if field.initializerExpression?has_content>
                   <#lt> = ${field.initializerExpression}<#rt>
@@ -78,12 +78,12 @@
     </#if>
 </#macro>
 
-<#macro compound_member_details fields>
+<#macro compound_member_details anchorName fields>
     <#if fields?has_content>
     <dl>
         <#list fields as field>
       <dt class="memberItem">
-        <a name="${field.name}">
+        <a name="${anchorName}_${field.name}">
             <#if field.docComment.isDeprecated>
           <span class="deprecated">(deprecated) </span>
           <del>

diff --git a/compiler/extensions/doc/freemarker/enumeration.html.ftl b/compiler/extensions/doc/freemarker/enumeration.html.ftl
@@ -25,7 +25,7 @@
       <tr><td>{</td><td rowspan="${items?size+1}">&nbsp;</td><td></td></tr>
 <#list items as item>
           <tr>
-            <td id="tabIndent"><a href="#${item.name}" class="fieldLink">${item.name}</a></td>
+            <td id="tabIndent"><a href="#${anchorName}_${item.name}" class="fieldLink">${item.name}</a></td>
             <td>= ${item.value}<#if item_has_next>,</#if></td>
       </tr>
 </#list>
@@ -38,7 +38,7 @@
 
     <dl>
 <#list items as item>
-      <dt class="memberItem"><a name="${item.name}">${item.name}:</a></dt>
+      <dt class="memberItem"><a name="${anchorName}_${item.name}">${item.name}:</a></dt>
       <dd class="memberDetail">
       <@doc_comment item.docComment/>
   <#list item.usageInfoList as usageInfo>

diff --git a/compiler/extensions/doc/freemarker/pubsub.html.ftl b/compiler/extensions/doc/freemarker/pubsub.html.ftl
@@ -25,7 +25,7 @@
                 <tr><td id="tabIndent">
                     ${message.keyword}(${message.topicDefinition}) <#rt>
                     <@linkedtype message.type/> <#rt>
-                    <#lt><a href="#${message.name}" class="fieldLink">${message.name}</a>;
+                    <#lt><a href="#${linkedType.hyperlinkName}_${message.name}" class="fieldLink">${message.name}</a>;
                 </td></tr>
 </#list>
                 <tr><td>};</td></tr>
@@ -37,7 +37,7 @@
 
         <dl>
 <#list messageList as message>
-            <dt class="memberItem"><a name="${message.name}">${message.name}:</a></dt>
+            <dt class="memberItem"><a name="${linkedType.hyperlinkName}_${message.name}">${message.name}:</a></dt>
             <dd class="memberDetail">
             <@doc_comment message.docComment/>
             </dd>

diff --git a/compiler/extensions/doc/freemarker/service.html.ftl b/compiler/extensions/doc/freemarker/service.html.ftl
@@ -24,7 +24,7 @@
 <#list methodList as method>
                 <tr><td id="tabIndent">
                     <@linkedtype method.responseType/> <#rt>
-                    <a href="#${method.name}" class="fieldLink">${method.name}</a><#t>
+                    <a href="#${linkedType.hyperlinkName}_${method.name}" class="fieldLink">${method.name}</a><#t>
                     <#lt>(<@linkedtype method.requestType/>);
                 </td></tr>
 </#list>
@@ -37,7 +37,7 @@
 
         <dl>
 <#list methodList as method>
-            <dt class="memberItem"><a name="${method.name}">${method.name}:</a></dt>
+            <dt class="memberItem"><a name="${linkedType.hyperlinkName}_${method.name}">${method.name}:</a></dt>
             <dd class="memberDetail">
             <@doc_comment method.docComment/>
             </dd>

diff --git a/compiler/extensions/doc/freemarker/sql_database.html.ftl b/compiler/extensions/doc/freemarker/sql_database.html.ftl
@@ -24,15 +24,15 @@
           <tbody id="tabIndent">
             <tr><td colspan=3>sql_database ${name}</td></tr>
             <tr><td colspan=3>{</td></tr>
-            <@compound_fields fields/>
+            <@compound_fields anchorName fields/>
             <tr><td colspan=3>};</td></tr>
           </tbody>
         </table>
       </td></tr>
     </table>
 
     <h3>Member Details</h3>
-    <@compound_member_details fields/>
+    <@compound_member_details anchorName fields/>
 <#if collaborationDiagramSvgFileName??>
 
     <@collaboration_diagram collaborationDiagramSvgFileName/>

diff --git a/compiler/extensions/doc/freemarker/sql_table.html.ftl b/compiler/extensions/doc/freemarker/sql_table.html.ftl
@@ -25,7 +25,7 @@
           <tbody id="tabIndent">
             <tr><td colspan=3>table ${name}<@compound_parameters parameters/></td></tr>
             <tr><td colspan=3>{</td></tr>
-            <@compound_fields fields/>
+            <@compound_fields anchorName fields/>
 <#if sqlConstraint?has_content>
             <tr><td colspan=3>&nbsp;</td></tr>
             <tr>
@@ -40,7 +40,7 @@
     </table>
 
     <h3>Member Details</h3>
-    <@compound_member_details fields/>
+    <@compound_member_details anchorName fields/>
 
     <@used_by usedByList/>
 <#if collaborationDiagramSvgFileName??>

diff --git a/compiler/extensions/doc/freemarker/structure.html.ftl b/compiler/extensions/doc/freemarker/structure.html.ftl
@@ -24,7 +24,7 @@
           <tbody>
             <tr><td colspan=3>struct ${name}<@compound_parameters parameters/></td></tr>
             <tr><td colspan=3>{</td></tr>
-            <@compound_fields fields/>
+            <@compound_fields anchorName fields/>
 <#if functions?has_content>
             <tr><td colspan=3>&nbsp;</td></tr>
             <@compound_functions functions/>
@@ -36,7 +36,7 @@
     </table>
 
     <h3>Member Details</h3>
-    <@compound_member_details fields/>
+    <@compound_member_details anchorName fields/>
 
     <@used_by usedByList/>
 <#if collaborationDiagramSvgFileName??>

diff --git a/compiler/extensions/doc/freemarker/union.html.ftl b/compiler/extensions/doc/freemarker/union.html.ftl
@@ -24,7 +24,7 @@
           <tbody id="tabIndent">
             <tr><td colspan=3>union ${name}<@compound_parameters parameters/></td></tr>
             <tr><td colspan=3>{</td></tr>
-            <@compound_fields fields/>
+            <@compound_fields anchorName fields/>
 <#if functions?has_content>
             <tr><td colspan=3>&nbsp;</td></tr>
             <@compound_functions functions/>
@@ -36,7 +36,7 @@
     </table>
 
     <h3>Member Details</h3>
-    <@compound_member_details fields/>
+    <@compound_member_details anchorName fields/>
 
     <@used_by usedByList/>
 <#if collaborationDiagramSvgFileName??>

diff --git a/compiler/extensions/doc/src/zserio/emit/doc/BitmaskTemplateData.java b/compiler/extensions/doc/src/zserio/emit/doc/BitmaskTemplateData.java
@@ -130,7 +130,7 @@ public String getChoiceCaseLinkText()
             public String getChoiceCaseLink() throws ZserioEmitException
             {
                 return DocEmitterTools.getUrlNameFromType(choiceType) +
-                        "#casedef_" + getBitmaskValue().getName();
+                        "_casedef_" + getBitmaskValue().getName();
             }
         };
 

diff --git a/compiler/extensions/doc/src/zserio/emit/doc/ChoiceTemplateData.java b/compiler/extensions/doc/src/zserio/emit/doc/ChoiceTemplateData.java
@@ -136,13 +136,13 @@ public static class CaseSeeLinkTemplateData
         public CaseSeeLinkTemplateData(EnumItem caseType, EnumType caseTypeOwner) throws ZserioEmitException
         {
             text = caseTypeOwner.getName() + "." + caseType.getName();
-            link = DocEmitterTools.getUrlNameFromType(caseTypeOwner) + "#casedef_" + caseType.getName();
+            link = DocEmitterTools.getUrlNameFromType(caseTypeOwner) + "_" + caseType.getName();
         }
 
         public CaseSeeLinkTemplateData(BitmaskValue caseType, BitmaskType caseTypeOwner) throws ZserioEmitException
         {
             text = caseTypeOwner.getName() + "." + caseType.getName();
-            link = DocEmitterTools.getUrlNameFromType(caseTypeOwner) + "#casedef_" + caseType.getName();
+            link = DocEmitterTools.getUrlNameFromType(caseTypeOwner) + "_" + caseType.getName();
         }
 
         public String getText()

diff --git a/compiler/extensions/doc/src/zserio/emit/doc/DocEmitterTools.java b/compiler/extensions/doc/src/zserio/emit/doc/DocEmitterTools.java
@@ -27,18 +27,6 @@ public static String getDirectoryNameFromType(AstNode type) throws ZserioEmitExc
         return getZserioPackageName(type).toString();
     }
 
-    /**
-     * Returns the HTML file name.
-     *
-     * @param type The ZserioType from which to generate the HTML file name.
-     *
-     * @throws ZserioEmitException Throws in case of any internal error.
-     */
-    public static String getHtmlFileNameFromType(AstNode type) throws ZserioEmitException
-    {
-        return getFileNameFromType(type, ".html");
-    }
-
     /**
      * Returns the URL name of HTML file.
      *
@@ -48,8 +36,8 @@ public static String getHtmlFileNameFromType(AstNode type) throws ZserioEmitExce
      */
     public static String getUrlNameFromType(AstNode type) throws ZserioEmitException
     {
-        return ".." + URLDirSeparator + getDirectoryNameFromType(type) +
-                URLDirSeparator + getHtmlFileNameFromType(type);
+        return DocEmitterTools.getZserioPackageName(type) + ".html#" +
+                (new LinkedType(type).getHyperlinkName());
     }
 
     /**
@@ -65,7 +53,7 @@ public static String getUrlNameFromTypeAndFieldName(AstNode type, String fieldNa
     {
         String urlName = getUrlNameFromType(type);
         if (fieldName != null)
-            urlName += "#" + fieldName;
+            urlName += "_" + fieldName;
 
         return urlName;
     }

diff --git a/compiler/extensions/doc/src/zserio/emit/doc/EnumerationTemplateData.java b/compiler/extensions/doc/src/zserio/emit/doc/EnumerationTemplateData.java
@@ -129,7 +129,7 @@ public String getChoiceCaseLinkText()
 
             public String getChoiceCaseLink() throws ZserioEmitException
             {
-                return DocEmitterTools.getUrlNameFromType(choiceType) + "#casedef_" + getEnumItem().getName();
+                return DocEmitterTools.getUrlNameFromType(choiceType) + "_casedef_" + getEnumItem().getName();
             }
         }
 

diff --git a/compiler/extensions/doc/src/zserio/emit/doc/PubsubTemplateData.java b/compiler/extensions/doc/src/zserio/emit/doc/PubsubTemplateData.java
@@ -15,8 +15,6 @@ public PubsubTemplateData(TemplateDataContext context, PubsubType pubsubType) th
         name = pubsubType.getName();
         packageName = pubsubType.getPackage().getPackageName().toString();
         linkedType = new LinkedType(pubsubType);
-        ResourceManager.getInstance().setCurrentOutputDir(
-                DocEmitterTools.getDirectoryNameFromType(pubsubType));
         docComment = new DocCommentTemplateData(pubsubType.getDocComment());
         for (PubsubMessage message : pubsubType.getMessageList())
         {

diff --git a/compiler/extensions/doc/src/zserio/emit/doc/ServiceTemplateData.java b/compiler/extensions/doc/src/zserio/emit/doc/ServiceTemplateData.java
@@ -14,8 +14,6 @@ public ServiceTemplateData(TemplateDataContext context, ServiceType serviceType)
         name = serviceType.getName();
         packageName = serviceType.getPackage().getPackageName().toString();
         linkedType = new LinkedType(serviceType);
-        ResourceManager.getInstance().setCurrentOutputDir(
-                DocEmitterTools.getDirectoryNameFromType(serviceType));
         docComment = new DocCommentTemplateData(serviceType.getDocComment());
         for (ServiceMethod method : serviceType.getMethodList())
         {
-Original file line number
+Diff line change
@@ Expand Up / @@ -129,7 +129,7 @@ public String getChoiceCaseLinkText() @@
                 public String getChoiceCaseLink() throws ZserioEmitException
                 {
-                    return DocEmitterTools.getUrlNameFromType(choiceType) + "#casedef_" + getEnumItem().getName();
+                    return DocEmitterTools.getUrlNameFromType(choiceType) + "_casedef_" + getEnumItem().getName();
                 }
             }
@@ Expand Down @@