Code: Select all

if (UltraEdit.document.length > 0) // Is any file opened?
{
    // There must be at least one string in this array.
    // The strings can be all just "-" for a flat list.
    // See below the comment about #{1,7} on how to reduce the number of
    // heading levels for being taken into account for table of contents.
    var asTocLevels = [
        "-",                        // Heading 1 in TOC
        "    +",                    // Heading 2 in TOC
        "        *",                // Heading 3 in TOC
        "            -",            // Heading 4 in TOC
        "                +",        // Heading 5 in TOC
        "                    *",    // Heading 6 in TOC
        "                        -" // Heading 7 in TOC
    ];

    var sTocBlockStart = "<!-- toc -->";
    var sTocBlockEnd   = "<!-- /toc -->";

   // Define environment for this script.
   UltraEdit.insertMode();
   if (typeof(UltraEdit.columnModeOff) == "function") UltraEdit.columnModeOff();
   else if (typeof(UltraEdit.activeDocument.columnModeOff) == "function") UltraEdit.activeDocument.columnModeOff();

   // Get initial caret position on running this script.
   var nLineNumber = UltraEdit.activeDocument.currentLineNum;
   var nColumnNumber = UltraEdit.activeDocument.currentColumnNum;

   // Load entire file contents into memory of JavaScript core engine.
   UltraEdit.activeDocument.selectAll();
   if (UltraEdit.activeDocument.isSel())
   {
      var sText = UltraEdit.activeDocument.selection;

      // Remove all blocks with preformatted text which can contain
      // lines starting with one or more hash characters like headings.
      sText = sText.replace(/(^|\r?\n)[\t ]*```[\s\S]+?```[\t ]*(?:\r?\n|$)/g,"$1");
      sText = sText.replace(/[\t ]*<pre\b[\s\S]+?<\/pre>[\t ]*/g,"");
      sText = sText.replace(/[\t ]*<code\b[\s\S]+?<\/code>[\t ]*/g,"");

      // Remove all blocks commented out with an HTML comment.
      sText = sText.replace(/<!--[\s\S]+?-->/g,"");

      // Determine line termination type (DOS/Windows or UNIX).
      var sLineTerm = (UltraEdit.activeDocument.lineTerminator != 1) ? "\r\n" : "\n";
      var sTocList = "";
      var nHeadings = 0;

      // Search for headings in copy them into an array of headings. #{1,7}
      // in search expression results in searching for headings level 1 to 7.
      // The heading levels for table of contents can be reduced by reducing
      // the second number like using #{1,3} for just heading level 1 to 3.
      var asHeadings = sText.match(/(^|\r?\n) {0,3}(?:#{1,7}[\t ]+[^\r\n]+|[^\r\n\t *+\->][^\r\n]*\r?\n {0,3}[=-])/g);

      // Is there at least one heading found?
      if (asHeadings)
      {
         var nLowestLevel = asTocLevels.length;
         nHeadings = asHeadings.length;
         // Reformat all found headings to entries in table of contents.
         for (var nHeading = 0; nHeading < nHeadings; nHeading++)
         {
            // Remove all carriage returns, line-feeds, horizontal tabs
            // and normal spaces from the beginning of each found heading.
            var sHeading = asHeadings[nHeading].replace(/^[\r\n\t ]+/,"");

            // Convert heading 1 defined with one or more equal signs on
            // next line to heading 1 defined with one hash at beginning.
            sHeading = sHeading.replace(/(.+)\r\n {0,3}=$/,"# $1");

            // Convert heading 2 defined with one or more hyphens on next
            // line to heading 2 defined with two hashes at beginning.
            sHeading = sHeading.replace(/(.+)\r\n {0,3}-$/,"## $1");

            // Replace all tabs and spaces after the hash(es) by one space.
            sHeading = sHeading.replace(/^(#+)[\t ]+/,"$1 ");

            // Remove all carriage returns, line-feeds, horizontal tabs
            // and normal spaces from the end of each found heading.
            sHeading = sHeading.replace(/[\r\n\t ]+$/,"");

            // Convert heading into an entry in table of contents according to level.
            var sLevel = " ";
            for (var nLevel = 0; nLevel < asTocLevels.length; nLevel++)
            {
               sLevel = "#" + sLevel;
               if (sHeading.substr(0,sLevel.length) == sLevel)
               {
                  if (nLevel < nLowestLevel) nLowestLevel = nLevel;
                  asHeadings[nHeading] = asTocLevels[nLevel] + sHeading.substr(nLevel+1);
                  break;
               }
            }

            // Is heading level higher than highest level in array asTocLevels?
            if (nLevel == asTocLevels.length)
            {
               // Use the highest level defined in array asTocLevels for this heading.
               asHeadings[nHeading] = sHeading.replace(/^#+/,asTocLevels[asTocLevels.length-1]);
            }
         }

         // Is the lowest heading level not 1 because of file contains,
         // for example, just headings 2 and higher and there is more
         // than one listing level defined for table of contents?
         if (nLowestLevel && (asTocLevels.length > 1))
         {
            // Does the second TOC listing level and most likely all others
            // start with an indenting space for a hierarchical list?
            if (asTocLevels[1].charAt(0) == ' ')
            {
               // Remove the leading spaces according to lowest level as
               // otherwise the table of contents would be formatted as
               // preformatted text which is not wanted for the TOC.
               var nSpaceCount = nLowestLevel * 4;
               for (nHeading = 0; nHeading < nHeadings; nHeading++)
               {
                  asHeadings[nHeading] = asHeadings[nHeading].substr(nSpaceCount);
               }
            }
         }
         // Join all entries in table of contents together to one string.
         sTocList = asHeadings.join(sLineTerm) + sLineTerm;
      }

      // Defined the parameters for searching in active file for TOC block.
      UltraEdit.perlReOn();
      UltraEdit.activeDocument.findReplace.mode=0;
      UltraEdit.activeDocument.findReplace.matchCase=false;
      UltraEdit.activeDocument.findReplace.matchWord=false;
      UltraEdit.activeDocument.findReplace.regExp=true;
      UltraEdit.activeDocument.findReplace.searchDown=true;
      UltraEdit.activeDocument.findReplace.searchInColumn=false;
      UltraEdit.activeDocument.top();

      // Does the active file contain the table of contents block?
      if (UltraEdit.activeDocument.findReplace.find(sTocBlockStart + "[\\s\\S]+?" + sTocBlockEnd))
      {
         UltraEdit.activeDocument.findReplace.mode=1;
         // Are there one or more lines of table of contents?
         if (UltraEdit.activeDocument.findReplace.find("^(?:[^\\r\\n<].+\\r?\\n)+"))
         {
            // Is existing TOC not identical to newly generated TOC?
            if (UltraEdit.activeDocument.selection != sTocList)
            {
               // Get number of lines in existing table of contents.
               var nTocLineCount = UltraEdit.activeDocument.selection.match(/\r?\n/g).length;
               // Delete the existing table of contents.
               UltraEdit.activeDocument.deleteText();
               // Get line number of first line in table of contents.
               var nTocFirstLine = UltraEdit.activeDocument.currentLineNum;
               // Write new table of contents into the file.
               UltraEdit.activeDocument.write(sTocList);

               // Was the initial caret position below table of contents?
               if (nLineNumber >= (nTocFirstLine + nTocLineCount))
               {
                  // Update line number according to number of
                  // added or removed lines in table of contents.
                  nLineNumber += nHeadings - nTocLineCount;
               }
               // Was the initial caret position inside table of contents?
               else if (nLineNumber >= nTocFirstLine)
               {
                  // Set caret to beginning of first line of the TOC.
                  nLineNumber = nTocFirstLine;
                  nColumnNumber = 1;
               }
            }
         }
         else if (sTocList.length)
         {
            // The table of contents block exist, but there are
            // no lines to update, just lines to insert here.
            var nTocLineCount = 0;
            // Get number of lines in existing table of contents block.
            var asLineEndings = UltraEdit.activeDocument.selection.match(/\r?\n/g);
            if (asLineEndings) nTocLineCount = asLineEndings.length;
            // Delete the entire existing table of contents block.
            UltraEdit.activeDocument.deleteText();
            // Get line number of first line of table of contents block.
            var nTocFirstLine = UltraEdit.activeDocument.currentLineNum;
            // Write the entire table of contents block into the file.
            UltraEdit.activeDocument.write(sTocBlockStart+sLineTerm+sLineTerm+
                                           sTocList+sLineTerm+sTocBlockEnd);

            // Was the initial caret position below table of contents block?
            if (nLineNumber >= (nTocFirstLine + nTocLineCount))
            {
               // Update line number according to number of added lines.
               nLineNumber += (nHeadings + 3) - nTocLineCount;
            }
            else if (nLineNumber >= nTocFirstLine)
            {
               // Set caret to beginning of first line of the TOC.
               nLineNumber = nTocFirstLine + 2;
               nColumnNumber = 1;
            }
         }
      }
      else if (sTocList.length)
      {
         // The table of contents block is completely missing. Insert
         // it at top of the active file and update initial line number.
         UltraEdit.activeDocument.write(sTocBlockStart+sLineTerm+sLineTerm+
                                sTocList+sLineTerm+sTocBlockEnd+sLineTerm);
         nLineNumber += nHeadings + 4;
      }

      // Move caret to initial position before updating or inserting the
      // table of contents respectively set the caret to beginning of
      // the first line of the table of contents.
      UltraEdit.activeDocument.gotoLine(nLineNumber,nColumnNumber);
   }
}

Code: Select all

**Bold formatted phrase** on heading level 1
===

*Italic formatted phrase* on heading level 2
---