issue #10987 Doxygen 1.11.0 for macOS reports 'sh: latex: command not found'

Author: doxygen

CMakeLists.txt

@@ -194,8 +194,8 @@ endif ()
 find_program(DOT NAMES dot)
 find_package(Python REQUIRED)
 find_package(FLEX REQUIRED)
-if (FLEX_VERSION VERSION_LESS 2.6.3)
-  message(SEND_ERROR "Doxygen requires at least flex version 2.6.3 (installed: ${FLEX_VERSION})")
+if (FLEX_VERSION VERSION_LESS 2.5.37)
+  message(SEND_ERROR "Doxygen requires at least flex version 2.5.37 (installed: ${FLEX_VERSION})")
 endif()
 find_package(BISON REQUIRED)
 if (BISON_VERSION VERSION_LESS 2.7)

doc/changelog.dox

@@ -2107,7 +2107,7 @@ and
 <li>Simplify vhdldocgen code a bit [<a href="https://github.com/doxygen/doxygen/commit/a159f53f032b04064df0c9ad9d7d02f0622f0529">view</a>]</li>
 <li>Modernize search index [<a href="https://github.com/doxygen/doxygen/commit/33a334ce77e6dd0c81e97edc4bfba1fe50d947fa">view</a>]</li>
 <li>Update used links in test examples [<a href="https://github.com/doxygen/doxygen/commit/3c9eeae58ca98a000c75d75ed21bbe4a625cd2c8">view</a>]</li>
-<li>Updated minimum MacOS requirements to version 10.14 [<a href="https://github.com/doxygen/doxygen/commit/4b997ee2519c1032da6f1a9caf2638d17202fea7">view</a>]</li>
+<li>Updated minimum macOS requirements to version 10.14 [<a href="https://github.com/doxygen/doxygen/commit/4b997ee2519c1032da6f1a9caf2638d17202fea7">view</a>]</li>
 <li>Updated test for enums based on recently fixed issues [<a href="https://github.com/doxygen/doxygen/commit/62b368644dec14d1d916c778461f6d4d32e2182e">view</a>]</li>
 <li>Make layout parser use the new XML parser [<a href="https://github.com/doxygen/doxygen/commit/22f6dcc3cedf1bf4360c452db40949e3c156f41b">view</a>]</li>
 <li>Make tagreader use the new XML parser [<a href="https://github.com/doxygen/doxygen/commit/714f89d30cf04ad972df84a6a398258b751d3553">view</a>]</li>
@@ -3948,8 +3948,8 @@ href="https://github.com/doxygen/doxygen/commit/a697caadf1912d0d74faa208f4cff887
 <li>Fix typo in function name [<a href="https://github.com/doxygen/doxygen/commit/ace0af42e330a96ad691b2d9a08dd3ff4abb2629">view</a> and [<a href="https://github.com/doxygen/doxygen/commit/b890f40d195b9dc5db12aaa398707de138093c66">view</a>]</li>
 <li>Fixed a couple of small memory leaks [<a href="https://github.com/doxygen/doxygen/commit/85ddfc814f33943199928447b4627d05b0920b99">view</a>]</li>
 <li>Fixed a number of memory leaks in the template engine [<a href="https://github.com/doxygen/doxygen/commit/d14bcd1f8f5bd4a2034bae842000630f4e098eb6">view</a>]</li>
-<li>Fixed compiler warning for MacOSX [<a href="https://github.com/doxygen/doxygen/commit/0aa27346b8728f6698dd2b363959e89d02e03ff6">view</a>]</li>
-<li>Fixed link issue for MacOSX 10.11 [<a href="https://github.com/doxygen/doxygen/commit/0918a19225daedfbd5e23388124a5de3860d5420">view</a>]</li>
+<li>Fixed compiler warning for macOS [<a href="https://github.com/doxygen/doxygen/commit/0aa27346b8728f6698dd2b363959e89d02e03ff6">view</a>]</li>
+<li>Fixed link issue for macOS 10.11 [<a href="https://github.com/doxygen/doxygen/commit/0918a19225daedfbd5e23388124a5de3860d5420">view</a>]</li>
 <li>Fixed minor typos in comments [<a href="https://github.com/doxygen/doxygen/commit/29c500434d30cd4d9c20f6b295475ed42dba2930">view</a>]</li>
 <li>Fixed preprocessor macros for flex version check [<a href="https://github.com/doxygen/doxygen/commit/a8c73cdbe37cc53c398002d20e94037552a8fb55">view</a>]</li>
 <li>Fixed problem with latex and PDF bookmarks [<a href="https://github.com/doxygen/doxygen/commit/499ecaedf1ee1222535be27f77050ee633595685">view</a>]</li>
@@ -4291,7 +4291,7 @@ href="https://github.com/doxygen/doxygen/commit/a697caadf1912d0d74faa208f4cff887
 <li>Add source code possibility for RTF output [<a href="https://github.com/doxygen/doxygen/commit/05eb230757f6510d461bd14df3b190da46edd9dc">view</a>]</li>
 <li>Added Coverity Scan Build Status to Readme [<a href="https://github.com/doxygen/doxygen/commit/394acb6a10dbef10cad3a0a3ff50a05d0efdea9e">view</a>]</li>
 <li>Added clearer range checks for string class to help compiler [<a href="https://github.com/doxygen/doxygen/commit/869ff34828e20e3ec318384d7b0dbf91b6b2d24d">view</a>]</li>
-<li>Added compilation support for MacOSX 10.10 (yosemite) [<a href="https://github.com/doxygen/doxygen/commit/151876a8321204bd2ec08ec6c4de38ba9fb2d034">view</a>]</li>
+<li>Added compilation support for macOS 10.10 (yosemite) [<a href="https://github.com/doxygen/doxygen/commit/151876a8321204bd2ec08ec6c4de38ba9fb2d034">view</a>]</li>
 <li>Added faster reference counted string implementation with short string optimization [<a href="https://github.com/doxygen/doxygen/commit/9323ae470ad514586706dc8647501361fe208f36">view</a>]</li>
 <li>Added graphical hierarchy support to template engine [<a href="https://github.com/doxygen/doxygen/commit/fe818bf8e3a154788a4a180068cfdfbbadd66ff6">view</a>]</li>
 <li>Added guard to prevent (theoretical) out of bound access [<a href="https://github.com/doxygen/doxygen/commit/060a5cc121be5fd177b5d5c834f2b810dc58b9ec">view</a>]</li>
@@ -4476,7 +4476,7 @@ href="https://github.com/doxygen/doxygen/commit/a697caadf1912d0d74faa208f4cff887
 <li>Preparations for release 1.8.8 [<a href="https://github.com/doxygen/doxygen/commit/df2a9ea9df96f1e3f85c5c35978bc5bbfac6aa1d">view</a>]</li>
 <li>Removed not implemented HTML commands from documentation [<a href="https://github.com/doxygen/doxygen/commit/8199b2d105313efd30367c7a03b57bf7a7d2180b">view</a>]</li>
 <li>Removed unsupported HTML commands from the docs [<a href="https://github.com/doxygen/doxygen/commit/16ba4bd5744c2e5fbfabe95b27736b8ca8030390">view</a>]</li>
-<li>Set deployment targets for MacOSX 10.5+ versions [<a href="https://github.com/doxygen/doxygen/commit/28f40b3aea1411488832205fae447f4652125cdc">view</a>]</li>
+<li>Set deployment targets for macOS 10.5+ versions [<a href="https://github.com/doxygen/doxygen/commit/28f40b3aea1411488832205fae447f4652125cdc">view</a>]</li>
 <li>Support multiple extra HTML stylesheets. [<a href="https://github.com/doxygen/doxygen/commit/595943c96860425f9086028b00e1e155e8ec434f">view</a>]</li>
 <li>Tcl: add missing file that breaks test 057 [<a href="https://github.com/doxygen/doxygen/commit/73e7c340f555291d4264b2f83caacf59a5a3395f">view</a>]</li>
 <li>Tcl: add test code for Bug <a href="https://github.com/doxygen/doxygen/issues/5463">5463</a> [<a href="https://github.com/doxygen/doxygen/commit/36ce0578065b95cf12b81e5a4edd95dea5707e22">view</a>]</li>
@@ -5355,7 +5355,7 @@ href="https://github.com/doxygen/doxygen/commit/a697caadf1912d0d74faa208f4cff887
 <li>   In the declaration section the separator line was in between the
        member and its brief description.</li>
 <li>   Fixed a couple of compiler warning with the new XCode 4.4 compiler.</li>
-<li>   Added compilation support for Mountain Lion (Mac OS X 10.8).</li>
+<li>   Added compilation support for Mountain Lion (macOS 10.8).</li>
 <li>   id <a href="https://github.com/doxygen/doxygen/issues/4789">4789</a>: Nested namespaces did not appear in the namespace list if the
        parent namespace was undocumented.</li>
 <li>   id <a href="https://github.com/doxygen/doxygen/issues/4809">4809</a>: Fixed some spelling errors in the code comments.</li>
@@ -6062,7 +6062,7 @@ make sure you add the following:
        more then 9 parameters.</li>
 <li>   id <a href="https://github.com/doxygen/doxygen/issues/4268">4268</a>: For nested anonymous structs @xx markers could appear in
        the output.</li>
-<li>   id <a href="https://github.com/doxygen/doxygen/issues/4270">4270</a>: Added compilation support for MacOSX 10.7 (aka Lion).</li>
+<li>   id <a href="https://github.com/doxygen/doxygen/issues/4270">4270</a>: Added compilation support for macOS 10.7 (aka Lion).</li>
 <li>   id <a href="https://github.com/doxygen/doxygen/issues/4278">4278</a>: Fixed issue printing HTML pages when the
        GENERATE_TREEVIEW option is set to YES.</li>
 <li>   id <a href="https://github.com/doxygen/doxygen/issues/4281">4281</a>: Fixed broken link to an undocumented namespace.</li>
@@ -7012,7 +7012,7 @@ make sure you add the following:
 <a name="1.5.7.1"></a>
 <h3>Changes</h3>
 <ul>
-<li> The dot tool is no longer part of the doxygen package for MacOSX.
+<li> The dot tool is no longer part of the doxygen package for macOS.
      Please install GraphViz separately and set the dot path
      to /usr/local/bin</li>
 </ul>
@@ -7111,7 +7111,7 @@ make sure you add the following:
        template arguments were no longer treated as different classes.</li>
 <li>   id 539712: Fixed code parser issue for parameter indices of procedures
        and functions.</li>
-<li>   id 540058: Creator code was wrong in the MacOSX application bundle.</li>
+<li>   id 540058: Creator code was wrong in the macOS application bundle.</li>
 <li>   id 540372: Fixed problem parsing large table by increasing
        YY_READ_BUF_SIZE in the generated parser files.</li>
 <li>   id 540247: Fixed potential memory corruption issue parsing VHDL.</li>
@@ -7314,7 +7314,7 @@ make sure you add the following:
 <li>   Added support for VHDL (.vhd or .vhdl extension) based on a patch by
        Martin Kreis. Use OPTIMIZE_OUTPUT_VHDL when parsing VHDL code. </li>
 <li>   id 374699: Added support for Objective-C 2.0 properties.</li>
-<li>   Added compilation support for MacOSX 10.5 (Leopard) in combination with
+<li>   Added compilation support for macOS 10.5 (Leopard) in combination with
        Xcode 3</li>
 <li>   Added support for docsets, which allow integration of doxygen generated
        API documentation in Xcode 3. new options:
@@ -7872,7 +7872,7 @@ make sure you add the following:
 </ul>
 <h3>New features</h3>
 <ul>
-<li>   Added support for universal binaries on MacOSX (only the non-GUI part).</li>
+<li>   Added support for universal binaries on macOS (only the non-GUI part).</li>
 <li>   Added CALLER_GRAPH config option and \callergraph command to add
        a caller (or called-by) graph to a function or all functions.
        (thanks to Daniel Sherwood for the patch)</li>
@@ -8693,7 +8693,7 @@ make sure you add the following:
 <li>   id 162517: A @ref command was not parsed properly if the argument
        between quotes was found on the next line.</li>
 <li>   Dot would not run if doxygen was installed in a path which contained
-       spaces (Mac OS X).</li>
+       spaces (macOS).</li>
 <li>   Functions inside inline methods were not always cross-referenced anymore.</li>
 <li>   Latex output was broken in some cases where anonymous structs were used.</li>
 <li>   Fixed bug in doxywizard: if the wizard was used some settings
@@ -8730,9 +8730,9 @@ make sure you add the following:
 <h3>Bug fixes</h3>(ids refer to the old bugzilla issue, just use it in the search box of the <a href="https://github.com/doxygen/doxygen/issues">issue tracker</a>)<br/>
 <ul>
 <li>   Due to an error in the packaging script, an old version of doxywizard
-       was bundled with the Mac OS X version of doxygen.</li>
+       was bundled with the macOS version of doxygen.</li>
 <li>   Dot would not run if doxygen was installed in a path which contained
-       spaces (Mac OS X).</li>
+       spaces (macOS).</li>
 <li>   id 151012: &lt;td&gt; tag in HTML function documentation
        missed 'class="md"'</li>
 <li>   id 154689: Wrong link to members of namespaces imported from tag
@@ -10294,7 +10294,7 @@ make sure you add the following:
 <li>   Added a very simple metrics utility
        (see addon/doxmlparser/examples/metrics) which can compute some
        figures based on the XML output generated by doxygen.</li>
-<li>   Added autodetection for Darwin (MacOSX) to the configure script.</li>
+<li>   Added autodetection for Darwin (macOS) to the configure script.</li>
 <li>   Added option EXCLUDE_SYMLINKS.
        The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
        directories that are symbolic links (a Unix filesystem feature) are
@@ -10645,7 +10645,7 @@ make sure you add the following:
        specified dot file as an image in the documentation. The new config
        option DOTFILE_DIRS should be used to specify directories in which
        doxygen should look for dot files (thanks to Samit Basu for the patch).</li>
-<li>   Added new build target macosx-c++ to build doxygen for Mac OS X
+<li>   Added new build target macosx-c++ to build doxygen for macOS
        (Thanks to Jason Harris for telling me what needed to be changed).</li>
 <li>   Added --enable-langs option to the configure script which can be used
        to compile-in support for a specified set of languages (thanks to

doc/features.dox

@@ -23,7 +23,7 @@
     structured output HTML tags and/or some of Doxygen's special commands 
     can be used.
 <li>Cross platform: works on Windows and many Unix flavors (including Linux and
-    MacOSX).
+    macOS).
 <li>Indexes, organizes and generates browsable and cross-referenced 
     output even from undocumented code.
 <li>Generates structured XML output for parsed sources, which can be 
@@ -35,7 +35,7 @@
     defines. 
 <li>Javadoc (1.1), qdoc3 (partially), and ECMA-334 (C# spec.) compatible.
 <li>Comes with a GUI frontend (Doxywizard) to ease editing the options and 
-    run Doxygen. The GUI is available on Windows, Linux, and MacOSX.
+    run Doxygen. The GUI is available on Windows, Linux, and macOS.
 <li>Automatically generates class and collaboration diagrams in HTML (as clickable 
     image maps) and \LaTeX (as Encapsulated PostScript images).
 <li>Uses the `dot` tool of the Graphviz tool kit to generate

doc/index.dox

@@ -52,7 +52,7 @@ Doxygen can help you in three ways:
      for the Doxygen user manual and web-site).
 </ol>
 
-Doxygen is developed under Mac OS X and Linux, but is set-up to be highly
+Doxygen is developed under macOS and Linux, but is set-up to be highly
 portable. As a result, it runs on most other Unix flavors as well.
 Furthermore, executables for Windows are available.
 

doc/searching.dox

@@ -119,8 +119,8 @@ has its own advantages and disadvantages:
    by Microsoft. Although the tool works fine for most people, it can 
    sometimes crash for no apparent reason (how typical). 
 
-<h2>5. Mac OS X Doc Sets</h2> 
-   If you are running Doxygen on Mac OS X 10.5 or higher, 
+<h2>5. macOS Doc Sets</h2> 
+   If you are running Doxygen on macOS 10.5 or higher, 
    then you can make a "doc set" out of the HTML files produced by Doxygen.
    A doc set consists of a single directory with a special structure 
    containing the HTML files along with a precompiled search index. 
@@ -140,7 +140,7 @@ has its own advantages and disadvantages:
    in the editor and jump to the corresponding section in the Doxygen 
    documentation.
 
-   Disadvantage is that it only works in combination with Xcode on MacOSX.
+   Disadvantage is that it only works in combination with Xcode on macOS.
 
 <h2>6. Qt Compressed Help</h2> 
    If you develop for or want to install the Qt application framework,

doc/starting.dox

@@ -24,7 +24,7 @@ detailed usage information.
 Optionally, the executable \c doxywizard can be used, which is a
 \ref doxywizard_usage "graphical front-end" for editing the configuration file
 that is used by Doxygen and for running Doxygen in a graphical environment.
-For Mac OS X Doxywizard will be started by clicking on the Doxygen application
+For macOS Doxywizard will be started by clicking on the Doxygen application
 icon.
 
 The following figure shows the relation between the tools and the flow
@@ -195,7 +195,7 @@ require a browser that supports Dynamic HTML and JavaScript enabled.
 \addindex LaTeX
 The generated \LaTeX documentation must first be compiled by
 a \LaTeX compiler (I use a recent teTeX distribution for Linux
-and MacOSX and MikTex for Windows).
+and macOS and MikTex for Windows).
 To simplify the process of compiling the generated
 documentation, \c doxygen writes a \c Makefile into the \c latex directory
 (on the Windows platform also a \c make.bat batch file is generated).

src/config.xml

@@ -1042,7 +1042,7 @@ Go to the <a href="commands.html">next</a> section or return to the
  one named \c CLASS and the other named \c Class, and to also support references to files without
  having to specify the exact matching casing.
 
- On Windows (including Cygwin) and MacOS, users should typically set this option to \c NO,
+ On Windows (including Cygwin) and macOS, users should typically set this option to \c NO,
  whereas on Linux or other Unix flavors it should typically be set to \c YES.
 ]]>
       </docs>
@@ -1340,6 +1340,20 @@ FILE_VERSION_FILTER = "cleartool desc -fmt \%Vn"
  using \ref cfg_latex_bib_style "LATEX_BIB_STYLE".
  To use this feature you need \c bibtex and \c perl available in the search path.
  See also \ref cmdcite "\\cite" for info how to create references.
+]]>
+      </docs>
+    </option>
+    <option type='list' id='EXTERNAL_TOOL_PATHS' format='dir' defval=''>
+      <docs>
+<![CDATA[
+ The \c EXTERNAL_TOOL_PATHS tag can be used to extend the search path (PATH environment variable)
+ so that external tools such as \c latex and \c gs can be found.
+ \note This option is particularly useful for macOS version 14 (Sonoma) and higher,
+ when running Doxygen from Doxywizard, because in this case any user-defined changes to the PATH
+ are ignored. A typical example on macOS is to set
+\verbatim
+EXTERNAL_TOOL_PATHS = /Library/TeX/texbin /usr/local/bin
+\endverbatim
 ]]>
       </docs>
     </option>

src/doxygen.cpp

@@ -10792,8 +10792,6 @@ void initDoxygen()
 
   Doxygen::symbolMap = new SymbolMap<Definition>;
 
-  Portable::correct_path();
-
   Debug::startTimer();
   Doxygen::parserManager = new ParserManager(            make_parser_factory<NullOutlineParser>(),
                                                          make_parser_factory<FileCodeParser>());
@@ -11786,6 +11784,8 @@ void parseInput()
   AUTO_TRACE();
   std::atexit(exitDoxygen);
 
+  Portable::correctPath(Config_getList(EXTERNAL_TOOL_PATHS));
+
 #if USE_LIBCLANG
   Doxygen::clangAssistedParsing = Config_getBool(CLANG_ASSISTED_PARSING);
 #endif

src/portable.cpp

@@ -311,6 +311,7 @@ void Portable::setenv(const QCString &name,const QCString &value)
     }
 
     proc_env[name.str()] = value.str(); // create or replace existing value
+    ::setenv(name.data(),value.data(),1);
 #endif
 }
 
@@ -329,6 +330,7 @@ void Portable::unsetenv(const QCString &variable)
     if (it != proc_env.end())
     {
       proc_env.erase(it);
+      ::unsetenv(variable.data());
     }
 #endif
 }
@@ -521,14 +523,24 @@ bool Portable::isAbsolutePath(const QCString &fileName)
  *
  * This routine was inspired by the cause for bug 766059 was that in the Windows path there were forward slashes.
  */
-void Portable::correct_path()
+void Portable::correctPath(const StringVector &extraPaths)
 {
-#if defined(_WIN32) && !defined(__CYGWIN__)
   QCString p = Portable::getenv("PATH");
-  if (p.isEmpty()) return; // no path nothing to correct
+#if defined(_WIN32) && !defined(__CYGWIN__)
   QCString result = substitute(p,"/","\\");
-  if (result!=p) Portable::setenv("PATH",result.data());
+  for (const auto &path : extraPaths)
+  {
+    result+=";\""+substitute(QCString(path),"/","\\")+"\"";
+  }
+#else
+  QCString result=p;
+  for (const auto &path : extraPaths)
+  {
+    result+=":"+QCString(path);
+  }
 #endif
+  if (result!=p) Portable::setenv("PATH",result.data());
+  //printf("settingPath(%s) #extraPaths=%zu\n",Portable::getenv("PATH").data(),extraPaths.size());
 }
 
 void Portable::unlink(const QCString &fileName)

src/portable.h

@@ -7,6 +7,7 @@
 
 #include <fstream>
 
+#include "containers.h"
 #include "qcstring.h"
 
 class Buf;
@@ -34,7 +35,7 @@ namespace Portable
   int            pclose(FILE *stream);
   double         getSysElapsedTime();
   bool           isAbsolutePath(const QCString &fileName);
-  void           correct_path();
+  void           correctPath(const StringVector &list);
   void           setShortDir();
   const char *   strnstr(const char *haystack, const char *needle, size_t haystack_len);
   const char *   devNull();