Portable Namespace Reference

Functions
int	system (const DString &command, const DString &args, bool commandHasConsole=true)
uint32_t	pid ()
DString	getenv (const DString &variable)
void	setenv (const DString &variable, const DString &value)
void	unsetenv (const DString &variable)
FILE *	fopen (const DString &fileName, const DString &mode)
int	fclose (FILE *f)
void	unlink (const DString &fileName)
DString	pathSeparator ()
DString	pathListSeparator ()
const char *	ghostScriptCommand ()
const char *	commandExtension ()
bool	fileSystemIsCaseSensitive ()
FILE *	popen (const DString &name, const DString &type)
int	pclose (FILE *stream)
double	getSysElapsedTime ()
bool	isAbsolutePath (const DString &fileName)
void	correctPath (const StringVector &list)
	Correct a possible wrong PATH variable.
void	setShortDir ()
const char *	strnstr (const char *haystack, const char *needle, size_t haystack_len)
const char *	devNull ()
bool	checkForExecutable (const DString &fileName)
size_t	recodeUtf8StringToW (const DString &inputStr, uint16_t **buf)
std::ofstream	openOutputStream (const DString &name, bool append=false)
std::ifstream	openInputStream (const DString &name, bool binary=false, bool openAtEnd=false)
DString	removeLongPathMarker (const DString &path)

Function Documentation

checkForExecutable()

bool Portable::checkForExecutable

(

const DString &

fileName

)

Definition at line 439 of file portable.cpp.

{
#if defined(_WIN32) && !defined(__CYGWIN__)
  const char *extensions[] = {".bat",".com",".exe"};
  for (int i = 0; i < sizeof(extensions) / sizeof(*extensions); i++)
  {
    if (ExistsOnPath(fileName + extensions[i])) return true;
  }
  return false;
#else
  return ExistsOnPath(fileName);
#endif
}

References ExistsOnPath().

Referenced by generateFormula().

commandExtension()

const char * Portable::commandExtension

(

)

Definition at line 477 of file portable.cpp.

{
#if defined(_WIN32) && !defined(__CYGWIN__)
    return ".exe";
#else
    return "";
#endif
}

Referenced by Config::checkAndCorrect(), computeVerifiedDotPath(), javaExecutable(), and writeDiaGraphFromFile().

correctPath()

void Portable::correctPath

(

const StringVector &

extraPaths

)

Correct a possible wrong PATH variable.

This routine was inspired by the cause for bug 766059 was that in the Windows path there were forward slashes.

Definition at line 532 of file portable.cpp.

{
  DString p = Portable::getenv("PATH");
  bool first=true;
  DString result;
#if defined(_WIN32) && !defined(__CYGWIN__)
  for (const auto &path : extraPaths)
  {
    if (!first) result+=';';
    first=false;
    result += substitute(path,"/","\\");
  }
  if (!result.empty() && !p.empty()) result+=';';
  result += substitute(p,"/","\\");
#else
  for (const auto &path : extraPaths)
  {
    if (!first) result+=':';
    first=false;
    result += path;
  }
  if (!result.empty() && !p.empty()) result+=':';
  result += p;
#endif
  if (result!=p) Portable::setenv("PATH",result.data());
  //printf("settingPath(%s) #extraPaths=%zu\n",Portable::getenv("PATH").data(),extraPaths.size());
}

References DString::data(), DString::empty(), getenv(), setenv(), and substitute().

Referenced by parseInput().

devNull()

const char * Portable::devNull

(

)

Definition at line 630 of file portable.cpp.

{
#if defined(_WIN32) && !defined(__CYGWIN__)
  return "NUL";
#else
  return "/dev/null";
#endif
}

Referenced by createDVIFile(), createSVGFromPDFviaInkscape(), and determineInkscapeVersion().

fclose()

int Portable::fclose

(

FILE *

f

)

Definition at line 385 of file portable.cpp.

{
  return ::fclose(f);
}

Referenced by OutputGenerator::endPlainFile(), finishWarnExit(), and initWarningFormat().

fileSystemIsCaseSensitive()

bool Portable::fileSystemIsCaseSensitive

(

)

Definition at line 486 of file portable.cpp.

{
#if defined(_WIN32) || defined(macintosh) || defined(__MACOSX__) || defined(__APPLE__) || defined(__CYGWIN__)
  return false;
#else
  return true;
#endif
}

Referenced by FileNameLinkedMap::findFileDef(), getFilterFromList(), and useCaseSenseNames().

fopen()

FILE * Portable::fopen	(	const DString &	fileName,
		const DString &	mode )

Definition at line 365 of file portable.cpp.

{
#if defined(_WIN32) && !defined(__CYGWIN__)
  uint16_t *fn = nullptr;
  size_t fn_len = recodeUtf8StringToW(fileName,&fn);
  uint16_t *m  = nullptr;
  size_t m_len = recodeUtf8StringToW(mode,&m);
  FILE *result = nullptr;
  if (fn_len!=(size_t)-1 && m_len!=(size_t)-1)
  {
    result = _wfopen((wchar_t*)fn,(wchar_t*)m);
  }
  delete[] fn;
  delete[] m;
  return result;
#else
  return ::fopen(fileName.data(),mode.data());
#endif
}

References DString::data(), and recodeUtf8StringToW().

Referenced by checkPngResult(), FilterCache::getFileContentsPipe(), initWarningFormat(), DotRunner::run(), OutputGenerator::startPlainFile(), and tryPath().

getenv()

DString Portable::getenv

(

const DString &

variable

)

Definition at line 337 of file portable.cpp.

{
#if defined(_WIN32) && !defined(__CYGWIN__)
    #define ENV_BUFSIZE 32768
    LPTSTR pszVal = (LPTSTR) malloc(ENV_BUFSIZE*sizeof(TCHAR));
    if (GetEnvironmentVariable(variable.data(),pszVal,ENV_BUFSIZE) == 0) return "";
    DString out;
    out = pszVal;
    free(pszVal);
    return out;
    #undef ENV_BUFSIZE
#else
    if(!environmentLoaded) // if the environment variables are not loaded already...
    {                      // ...call loadEnvironment to store them in class
      loadEnvironment();
    }
 
    if (proc_env.find(variable.str()) != proc_env.end())
    {
      return DString(proc_env[variable.str()]);
    }
    else
    {
      return DString();
    }
#endif
}

References DString::data(), environmentLoaded, loadEnvironment(), proc_env, and DString::str().

Referenced by correctPath(), ExistsOnPath(), getCurrentDateTime(), initDoxygen(), javaExecutable(), parseInput(), setDotFontPath(), and substEnvVarsInString().

getSysElapsedTime()

double Portable::getSysElapsedTime

(

)

Definition at line 113 of file portable.cpp.

{
  return SysTimeKeeper::instance().elapsedTime();
}

References SysTimeKeeper::elapsedTime(), and SysTimeKeeper::instance().

Referenced by generateOutput().

ghostScriptCommand()

const char * Portable::ghostScriptCommand

(

)

Definition at line 453 of file portable.cpp.

{
#if defined(_WIN32) && !defined(__CYGWIN__)
    static const char *gsexe = nullptr;
    if (!gsexe)
    {
        const char *gsExec[] = {"gswin32c.exe","gswin64c.exe"};
        for (int i = 0; i < sizeof(gsExec) / sizeof(*gsExec); i++)
        {
            if (ExistsOnPath(gsExec[i]))
            {
                gsexe = gsExec[i];
                return gsexe;
            }
        }
        gsexe = gsExec[0];
        return gsexe;
    }
    return gsexe;
#else
    return "gs";
#endif
}

References ExistsOnPath().

Referenced by createCroppedEPS(), createCroppedPDF(), createEPSbboxFile(), createPNG(), and writeMakeBat().

isAbsolutePath()

bool Portable::isAbsolutePath

(

const DString &

fileName

)

Definition at line 513 of file portable.cpp.

{
  const char *fn = fileName.data();
# ifdef _WIN32
  if (fileName.length()>1 && isalpha(fileName[0]) && fileName[1]==':') fn+=2;
# endif
  char const fst = fn[0];
  if (fst == '/') return true;
# ifdef _WIN32
  if (fst == '\\') return true;
# endif
  return false;
}

References DString::data(), and DString::length().

Referenced by findFile(), findFile(), generateOutput(), Markdown::Private::processLink(), and readTextFileByName().

openInputStream()

std::ifstream Portable::openInputStream	(	const DString &	name,
		bool	binary = false,
		bool	openAtEnd = false )

Definition at line 692 of file portable.cpp.

{
  std::ios_base::openmode mode = std::ifstream::in | std::ifstream::binary;
  if (binary)     mode |= std::ios::binary;
  if (openAtEnd)  mode |= std::ios::ate;
#if defined(__clang__) && defined(__MINGW32__)
  return std::ifstream(fs::path(fileName.str()).wstring(), mode);
#else
  return std::ifstream(fs::path(fileName.str()), mode);
#endif
}

References DString::str().

Referenced by configFileToString(), convertMapFile(), DotFilePatcher::convertMapFile(), determineInkscapeVersion(), finishWarnExit(), CitationManager::generatePage(), FormulaManager::initFromRepository(), CitationManager::insertCrossReferencesForBibFile(), Htags::loadFilemap(), preProcessFile(), DotRunner::readBoundingBox(), FilterCache::readFragmentFromFile(), readInputFile(), readSVGSize(), resetPDFSize(), DotFilePatcher::run(), sameMd5Signature(), testRTFOutput(), and updateEPSBoundingBox().

openOutputStream()

std::ofstream Portable::openOutputStream	(	const DString &	name,
		bool	append = false )

Definition at line 681 of file portable.cpp.

{
  std::ios_base::openmode mode = std::ofstream::out | std::ofstream::binary;
  if (append) mode |= std::ofstream::app;
#if defined(__clang__) && defined(__MINGW32__)
  return std::ofstream(fs::path(fileName.str()).wstring(), mode);
#else
  return std::ofstream(fs::path(fileName.str()), mode);
#endif
}

References DString::str().

Referenced by Qhp::addContentsItem(), ResourceMgr::copyResourceAs(), FormulaManager::createFormulasTexFile(), FormulaManager::createLatexFile(), PerlModGenerator::createOutputFile(), HtmlHelp::Private::createProjectFile(), dumpSymbolMap(), EclipseHelp::finalize(), generateDEF(), generateJSNavTree(), generateJSTreeFiles(), CitationManager::generatePage(), generateXML(), generateXMLForClass(), generateXMLForConcept(), generateXMLForDir(), generateXMLForFile(), generateXMLForGroup(), generateXMLForModule(), generateXMLForNamespace(), generateXMLForPage(), generateXMLForRequirement(), generateXMLForRequirements(), HtmlGenerator::init(), Crawlmap::initialize(), DocSets::initialize(), EclipseHelp::initialize(), HtmlHelp::initialize(), Qhp::initialize(), Sitemap::initialize(), openOutputFile(), DotGraph::prepareDotFile(), RTFGenerator::preProcessFileInplace(), resetPDFSize(), DotFilePatcher::run(), runPlantumlContent(), ManGenerator::startDoxyAnchor(), updateEPSBoundingBox(), SearchIndex::write(), SearchIndexExternal::write(), ResourceMgr::writeCategory(), writeCombineScript(), HtmlGenerator::writeExternalSearchPage(), ClassDiagram::writeFigure(), FlowChart::writeFlowChart(), writeInlineGraph(), writeJavascriptSearchData(), writeJavaScriptSearchIndex(), writeJavasScriptSearchDataPage(), writeLatexMakefile(), writeMakeBat(), MermaidManager::writeMermaidSource(), HtmlGenerator::writeSearchData(), HtmlGenerator::writeSearchPage(), and writeTagFile().

pathListSeparator()

DString Portable::pathListSeparator

(

)

Definition at line 399 of file portable.cpp.

{
#if defined(_WIN32) && !defined(__CYGWIN__)
  return ";";
#else
  return ":";
#endif
}

Referenced by ExistsOnPath(), parseInput(), runPlantumlContent(), and setDotFontPath().

pathSeparator()

DString Portable::pathSeparator

(

)

Definition at line 390 of file portable.cpp.

{
#if defined(_WIN32) && !defined(__CYGWIN__)
  return "\\";
#else
  return "/";
#endif
}

Referenced by Config::checkAndCorrect(), ExistsOnPath(), findExampleFilePath(), readTextFileByName(), writeDiaGraphFromFile(), and writeMscGraphFromFile().

pclose()

int Portable::pclose

(

FILE *

stream

)

Definition at line 504 of file portable.cpp.

{
  #if defined(_MSC_VER) || defined(__BORLANDC__)
  return ::_pclose(stream);
  #else
  return ::pclose(stream);
  #endif
}

Referenced by FileDefImpl::acquireFileVersion(), FilterCache::getFileContentsPipe(), readInputFile(), runQHelpGenerator(), and stackTrace().

pid()

uint32_t Portable::pid

(

)

Definition at line 264 of file portable.cpp.

{
  uint32_t pid;
#if !defined(_WIN32) || defined(__CYGWIN__)
  pid = static_cast<uint32_t>(getpid());
#else
  pid = static_cast<uint32_t>(GetCurrentProcessId());
#endif
  return pid;
}

References pid().

Referenced by initWarningFormat(), parseInput(), pid(), and system().

popen()

FILE * Portable::popen	(	const DString &	name,
		const DString &	type )

Definition at line 495 of file portable.cpp.

{
  #if defined(_MSC_VER) || defined(__BORLANDC__)
  return ::_popen(name.data(),type.data());
  #else
  return ::popen(name.data(),type.data());
  #endif
}

References DString::data().

Referenced by FileDefImpl::acquireFileVersion(), FilterCache::getFileContentsPipe(), readInputFile(), runQHelpGenerator(), and stackTrace().

recodeUtf8StringToW()

size_t Portable::recodeUtf8StringToW	(	const DString &	inputStr,
		uint16_t **	buf )

Definition at line 639 of file portable.cpp.

{
  if (inputStr.empty() || outBuf==nullptr) return 0; // empty input or invalid output
  void *handle = portable_iconv_open("UTF-16LE","UTF-8");
  if (handle==reinterpret_cast<void *>(-1)) return 0; // invalid encoding
  size_t len = inputStr.length();
  uint16_t *buf = new uint16_t[len+1];
  *outBuf = buf;
  size_t inRemains  = len;
  size_t outRemains = len*sizeof(uint16_t)+2; // chars + \0
  const char *p = inputStr.data();
  portable_iconv(handle,&p,&inRemains,reinterpret_cast<char **>(&buf),&outRemains);
  *buf=0;
  portable_iconv_close(handle);
  return len;
}

References DString::data(), DString::empty(), DString::length(), portable_iconv(), portable_iconv_close(), and portable_iconv_open().

Referenced by fopen(), and system().

removeLongPathMarker()

DString Portable::removeLongPathMarker

(

const DString &

path

)

Definition at line 656 of file portable.cpp.

{
  DString result;
#if defined(_WIN32)
  if (path.startsWith("//?/")) // strip leading "\\?\" part from path
  {
    result = path.mid(4);
  }
  else
#endif
  {
    result = path;
  }
  return result;
}

References DString::mid(), and DString::startsWith().

Referenced by computeCommonDirPrefix(), FileDefImpl::FileDefImpl(), FileNameLinkedMap::findFileDef(), DirDefImpl::mergeDirectoryInTree(), FileNameLinkedMap::showFileDefMatches(), and stripFromPath().

setenv()

void Portable::setenv	(	const DString &	variable,
		const DString &	value )

Definition at line 302 of file portable.cpp.

{
#if defined(_WIN32) && !defined(__CYGWIN__)
    SetEnvironmentVariable(name.data(),!value.empty() ? value.data() : "");
#else
    if(!environmentLoaded) // if the environment variables are not loaded already...
    {                                 // ...call loadEnvironment to store them in class
      loadEnvironment();
    }
 
    proc_env[name.str()] = value.str(); // create or replace existing value
    ::setenv(name.data(),value.data(),1);
#endif
}

References DString::data(), DString::empty(), environmentLoaded, loadEnvironment(), proc_env, setenv(), and DString::str().

Referenced by correctPath(), initDoxygen(), parseInput(), runPlantumlContent(), setDotFontPath(), setenv(), and unsetDotFontPath().

setShortDir()

void Portable::setShortDir

(

)

Definition at line 569 of file portable.cpp.

{
#if defined(_WIN32) && !defined(__CYGWIN__)
  long     length = 0;
  TCHAR*   buffer = nullptr;
  // First obtain the size needed by passing nullptr and 0.
  length = GetShortPathName(Dir::currentDirPath().c_str(), nullptr, 0);
  // Dynamically allocate the correct size
  // (terminating null char was included in length)
  buffer = new TCHAR[length];
  // Now simply call again using same (long) path.
  length = GetShortPathName(Dir::currentDirPath().c_str(), buffer, length);
  // Set the correct directory (short name)
  Dir::setCurrent(buffer);
  delete [] buffer;
#endif
}

References Dir::currentDirPath(), and Dir::setCurrent().

Referenced by runHtmlHelpCompiler().

strnstr()

const char * Portable::strnstr	(	const char *	haystack,
		const char *	needle,
		size_t	haystack_len )

Definition at line 616 of file portable.cpp.

{
  size_t needle_len = strnlen(needle, haystack_len);
  if (needle_len < haystack_len || !needle[needle_len])
  {
    const char *x = portable_memmem(haystack, haystack_len, needle, needle_len);
    if (x && !memchr(haystack, 0, x - haystack))
    {
      return x;
    }
  }
  return nullptr;
}

References portable_memmem().

Referenced by Markdown::Private::addStrEscapeUtf8Nbsp().

system()

int Portable::system	(	const DString &	command,
		const DString &	args,
		bool	commandHasConsole = true )

taken from the system() manpage on my Linux box

Definition at line 121 of file portable.cpp.

{
  if (command.empty()) return 1;
  AutoTimeKeeper timeKeeper;
 
#if defined(_WIN32) && !defined(__CYGWIN__)
  DString commandCorrectedPath = substitute(command,'/','\\');
  DString fullCmd=commandCorrectedPath;
#else
  DString fullCmd=command;
#endif
  fullCmd=fullCmd.stripWhiteSpace();
  if (fullCmd.at(0)!='"' && fullCmd.find(' ')!=DString::npos)
  {
    // add quotes around command as it contains spaces and is not quoted already
    fullCmd="\""+fullCmd+"\"";
  }
  fullCmd += " ";
  fullCmd += args;
#ifndef NODEBUG
  Debug::print(Debug::ExtCmd,0,"Executing external command `{}`\n",fullCmd);
#endif
 
#if !defined(_WIN32) || defined(__CYGWIN__)
  (void)commandHasConsole;
  /*! taken from the system() manpage on my Linux box */
  int pid,status=0;
 
#ifdef _OS_SOLARIS // for Solaris we use vfork since it is more memory efficient
 
  // on Solaris fork() duplicates the memory usage
  // so we use vfork instead
 
  // spawn shell
  if ((pid=vfork())<0)
  {
    status=-1;
  }
  else if (pid==0)
  {
     execl("/bin/sh","sh","-c",fullCmd.data(),(char*)0);
     _exit(127);
  }
  else
  {
    while (waitpid(pid,&status,0 )<0)
    {
      if (errno!=EINTR)
      {
        status=-1;
        break;
      }
    }
  }
  return status;
 
#else  // Other Unices just use fork
 
  pid = fork();
  if (pid==-1)
  {
    perror("fork error");
    return -1;
  }
  if (pid==0)
  {
    const char * const argv[4] = { "sh", "-c", fullCmd.data(), 0 };
    execve("/bin/sh",const_cast<char * const*>(argv),environ);
    exit(127);
  }
  for (;;)
  {
    if (waitpid(pid,&status,0)==-1)
    {
      if (errno!=EINTR) return -1;
    }
    else
    {
      if (WIFEXITED(status))
      {
        return WEXITSTATUS(status);
      }
      else
      {
        return status;
      }
    }
  }
#endif // !_OS_SOLARIS
 
#else // Win32 specific
  if (commandHasConsole)
  {
    return ::system(fullCmd.data());
  }
  else
  {
    uint16_t* fullCmdW = nullptr;
    recodeUtf8StringToW(fullCmd, &fullCmdW);
 
    STARTUPINFOW sStartupInfo;
    std::memset(&sStartupInfo, 0, sizeof(sStartupInfo));
    sStartupInfo.cb = sizeof(sStartupInfo);
    sStartupInfo.dwFlags |= STARTF_USESHOWWINDOW;
    sStartupInfo.wShowWindow = SW_HIDE;
 
    PROCESS_INFORMATION sProcessInfo;
    std::memset(&sProcessInfo, 0, sizeof(sProcessInfo));
 
    if (!CreateProcessW(
      nullptr, // No module name (use command line)
      reinterpret_cast<wchar_t*>(fullCmdW), // Command line, can be mutated by CreateProcessW
      nullptr, // Process handle not inheritable
      nullptr, // Thread handle not inheritable
      false, // Set handle inheritance to false
      CREATE_NO_WINDOW,
      nullptr, // Use parent's environment block
      nullptr, // Use parent's starting directory
      &sStartupInfo,
      &sProcessInfo
    ))
    {
      delete[] fullCmdW;
      return -1;
    }
    else if (sProcessInfo.hProcess)      /* executable was launched, wait for it to finish */
    {
      WaitForSingleObject(sProcessInfo.hProcess,INFINITE);
      /* get process exit code */
      DWORD exitCode;
      bool retval = GetExitCodeProcess(sProcessInfo.hProcess,&exitCode);
      CloseHandle(sProcessInfo.hProcess);
      CloseHandle(sProcessInfo.hThread);
      delete[] fullCmdW;
      if (!retval) return -1;
      return exitCode;
    }
  }
#endif
  return 1; // we should never get here
 
}

References DString::at(), DString::data(), DString::empty(), environ, Debug::ExtCmd, DString::find(), DString::npos, pid(), Debug::print(), recodeUtf8StringToW(), DString::stripWhiteSpace(), and substitute().

Referenced by createCroppedEPS(), createCroppedPDF(), createDVIFile(), createEPSbboxFile(), createPNG(), createPostscriptFile(), FlowChart::createSVG(), createSVGFromPDF(), createSVGFromPDFviaInkscape(), determineInkscapeVersion(), do_mscgen_generate(), Htags::execute(), DocParser::findAndCopyImage(), CitationManager::generatePage(), DotRunner::run(), runHtmlHelpCompiler(), runMermaid(), runPlantumlContent(), runQHelpGenerator(), writeDiaGraphFromFile(), writeDotGraphFromFile(), writeDotImageMapFromFile(), ClassDiagram::writeFigure(), and writeMscGraphFromFile().

unlink()

void Portable::unlink

(

const DString &

fileName

)

Definition at line 560 of file portable.cpp.

{
#if defined(_WIN32) && !defined(__CYGWIN__)
  _unlink(fileName.data());
#else
  ::unlink(fileName.data());
#endif
}

References DString::data(), and unlink().

Referenced by finishWarnExit(), RTFGenerator::preProcessFileInplace(), DotRunner::run(), and unlink().

unsetenv()

void Portable::unsetenv

(

const DString &

variable

)

Definition at line 317 of file portable.cpp.

{
#if defined(_WIN32) && !defined(__CYGWIN__)
    SetEnvironmentVariable(variable.data(),nullptr);
#else
    /* Some systems don't have unsetenv(), so we do it ourselves */
    if (variable.empty() || variable.find('=')!=DString::npos)
    {
      return; // not properly formatted
    }
 
    auto it = proc_env.find(variable.str());
    if (it != proc_env.end())
    {
      proc_env.erase(it);
      ::unsetenv(variable.data());
    }
#endif
}

References DString::data(), DString::empty(), DString::find(), DString::npos, proc_env, DString::str(), and unsetenv().

Referenced by setDotFontPath(), unsetDotFontPath(), and unsetenv().