sourcelocationfinder.cpp

//==================================================================================================
// This implementation-file is part of DoxygenXLinks - A doxygen post-processor that allows to
// define smarter <b>Doxygen</b>-links.
//
// \emoji :copyright: 2025-2026 A-Worx GmbH, Germany.
// Published under \ref mainpage_license "Boost Software License".
//==================================================================================================
#include "jobs.hpp"
#include "dxl.hpp"
#include "xlink.hpp"
#include "dxlapp.hpp"
#include "ALib.System.TextFile.H"
#include "ALib.ALox.H"
#include "ALib.App.H"    // TODO(251204 09:14): we need this only for the definition of LOX_LOX.
                         //                     How can we avoid to include the whole app?
 
#include <iostream>
#include <fstream>
 
using namespace alib;
using namespace std;
 
namespace dxl {
 
        ////----- special doxygen fix: search for "\anchor" and "\name" in one line --------
        //{
        //    // todo: this is not used anywhere. Do we want to keep it? Is this doxed? Does this make sense?
        //    integer anchorPos= line.IndexOf("anchor");
        //    if (    anchorPos >= 1
        //         && (   line.CharAt(anchorPos-1) == '\\'
        //             || line.CharAt(anchorPos-1) == '@') ) {
        //        anchorPos+=7;
        //
        //        integer dxlTagPos= line.IndexOf("DXLTAG{", anchorPos);
        //        if (    dxlTagPos > 0
        //            && (   line.CharAt(dxlTagPos-1) == '\\'
        //                || line.CharAt(dxlTagPos-1) == '@') ) {
        //            Substring anchorName= line.Substring(anchorPos, dxlTagPos-anchorPos-1);
        //            anchorName.Trim();
        //            Substring anchorTitle= line.Substring(dxlTagPos+7, line.IndexOfOrLength('}')-1);
        //            anchorTitle.Trim();
        //
        //            String512 sourceHint;
        //            sourceHint <<  "Found pattern '@anchor ...@DXLTAG{title}\' in source: "
        //                       <<  path << ':' << lineNo;
        //
        //            dxl.AddAnchorTitle(anchorName, anchorTitle, sourceHint);
        //        }
        //    }
        //}
 
 
bool  SourceLocationFinder::Do() {
    Lox_SetDomain("DXL/SRC/JOB", Scope::Method )
    Lox_Info( "Reading source file {!Q} of size {}",
              srcFileNode.Name(), format::ByteSizeIEC(srcFileNode->Size()) )
    dxl.Stats.SourceFileSize.fetch_add(int(srcFileNode->Size()));
 
    Path path;
    {ALIB_LOCK_SHARED_WITH(dxl.GetSourceTreeLock())
        srcFileNode.AssembleRealPath(path, lang::Inclusion::Include);  }
 
    // read exclamations applicable to this file once
    StdVectorMA<ExclamationFile::Entry*> exclamations(poolWorker->TMA);
    dxl.Exclamations.Get(srcFileNode.Name(), exclamations);
 
    DXLApp& app= app::Get<DXLApp>();
 
    Lox_Info("Reading source file:  {}", path )
    MappedFile&      htmlFile= poolWorker->InputFile;
    std::errc errc= htmlFile.Open(path.Terminate(), srcFileNode->Size(), false);
    if(errc != std::errc()) {
        app.cErr->Add(app.cli.ExitCodeDecls.Find(ExitCodes::CantOpenSrcFile).Mapped()->FormatString(),
                      path);
        app.machine.SetExitCode(ExitCodes::CantOpenSrcFile);
        return true;
    }
    MappedFile::Data<char> mfc= htmlFile.GetData<char>();
 
    // we want maximum speed and even spare the fast log calls in the loop.
    Verbosity verbosity;
    Lox_GetVerbosity(verbosity)
 
  //------------------------------------------- main loop ------------------------------------------
    integer     lineStartRemaining= mfc.Remaining();
    int         lineNo= 1;
    String512   linkString;
 
    while ( !mfc.IsEOF() ) {
        char c= mfc.Next<NC>();
        if (c == '\n') {  lineNo++;  lineStartRemaining= mfc.Remaining(); continue; }
        if (c != '#' ) {  continue; }
 
      //------------------------------------------ # found -----------------------------------------
        if (mfc.Remaining() < 4)
            break;
 
        //---- 2nd character ----
        c= mfc.Next<NC>();
 
        // if double hash is given, remove one hash ##"..." and keep the rest.
        // Note: This is mainly needed for the documentation of this tool ;-)
        if (c == '#' ) { continue;}
 
        // not '"' ?
        if ( c != '\"' ) {
            if ( c == '\n')
                ++lineNo;
            continue;
        }
 
        //---- 3rd character: not an allowed link start? ----
        c= mfc.Next<NC>();
        if ( !isalpha(c) && String(".%^_<").IndexOf(c) < 0 ) {
            if ( c == '\n')
                ++lineNo;
            continue;
        }
 
        int colNo= int(lineStartRemaining - mfc.Remaining() - 2);
 
        // search for exclamations
        {   auto exclIt= exclamations.begin();
            for (; exclIt!=exclamations.end(); ++exclIt )
                if ( (*exclIt)->Matches(lineNo, colNo ) )
                    break;
            if (exclIt != exclamations.end()) {
                continue;
        }   }
 
        // This seems to be an XLink!
        bool suppressedAnchor;
        linkString.Reset(c); {
            bool foundEnd= false;
            while (mfc.Remaining()) {
                c= mfc.Next<NC>();
                if ( c == '\\') { linkString._<NC>(c); linkString._<NC>(mfc.Next()); continue; }
                if ( c == '\"') { foundEnd= true; break;}
                if ( c == '\n') { lineNo++; break; }
                linkString._<NC>(c);
                if (linkString.Length() == 511 ) {
                    Lox_Warning( "Found unterminated XLink pattern {!Q} in source file {}:{}:{}",
                                  linkString, path, lineNo, colNo )
                    break;
            }   }
            suppressedAnchor= linkString.CharAtStart() == '%';
            if ( !foundEnd ) continue;
            if (suppressedAnchor)
                linkString[0]= ' ';
            linkString.Trim();
        }
 
        // get or create the XLink
        XLink* xLink= dxl.RegisterXLink(linkString);
 
        if (verbosity >= Verbosity::Info)
            Lox_Info( "Found XLink pattern {!Q} in source file {}:{}:{}",
                      linkString, path, lineNo, colNo )
 
        // attach this source location to the XLink
        {ALIB_LOCK_WITH(xLink->Lock)
            xLink->SourceLocations.emplace_back( srcFileNode, lineNo, colNo );  }
 
        // attach the XLink to this source file
        { ALIB_LOCK_WITH(dxl.GetSourceTreeLock())
            if (!srcFileNode.HasCustomData())
                srcFileNode.AttachCustomData<XLinkList>(dxl.GetSourceTree().GetAllocator());
            srcFileNode.GetCustomData<XLinkList>().emplace_back( xLink, lineNo, colNo );
    }   }
 
    dxl.Stats.SourceFileLines.fetch_add(lineNo);
    return true;
}
} //namespace [dxl]