Portable 命名空间参考

函数
int	system (const QCString &command, const QCString &args, bool commandHasConsole=true)
unsigned int	pid ()
QCString	getenv (const QCString &variable)
void	setenv (const QCString &variable, const QCString &value)
void	unsetenv (const QCString &variable)
portable_off_t	fseek (FILE *f, portable_off_t offset, int whence)
portable_off_t	ftell (FILE *f)
FILE *	fopen (const QCString &fileName, const QCString &mode)
int	fclose (FILE *f)
void	unlink (const QCString &fileName)
QCString	pathSeparator ()
QCString	pathListSeparator ()
const char *	ghostScriptCommand ()
const char *	commandExtension ()
bool	fileSystemIsCaseSensitive ()
FILE *	popen (const QCString &name, const QCString &type)
int	pclose (FILE *stream)
void	sysTimerStart ()
void	sysTimerStop ()
double	getSysElapsedTime ()
void	sleep (int ms)
bool	isAbsolutePath (const QCString &fileName)
void	correct_path ()
	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 QCString &fileName)
size_t	recodeUtf8StringToW (const QCString &inputStr, uint16_t **buf)

函数说明

checkForExecutable()

bool Portable::checkForExecutable

(

const QCString &

fileName

)

在文件 portable.cpp 第 396 行定义.

{
#if defined(_WIN32) && !defined(__CYGWIN__)
  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
}

引用了 ExistsOnPath().

被这些函数引用 FormulaManager::generateImages().

commandExtension()

const char * Portable::commandExtension

(

)

在文件 portable.cpp 第 434 行定义.

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

被这些函数引用 runPlantumlContent() , 以及 writeDiaGraphFromFile().

correct_path()

void Portable::correct_path

(

)

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.

在文件 portable.cpp 第 515 行定义.

{
#if defined(_WIN32) && !defined(__CYGWIN__)
  QCString p = Portable::getenv("PATH");
  if (p.isEmpty()) return; // no path nothing to correct
  QCString result = substitute(p,"/","\\");
  if (result!=p) Portable::setenv("PATH",result.data());
#endif
}

引用了 QCString::data(), getenv(), QCString::isEmpty(), setenv() , 以及 substitute().

被这些函数引用 initDoxygen().

devNull()

const char * Portable::devNull

(

)

在文件 portable.cpp 第 595 行定义.

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

被这些函数引用 determineInkscapeVersion() , 以及 FormulaManager::generateImages().

fclose()

int Portable::fclose

(

FILE *

f

)

在文件 portable.cpp 第 342 行定义.

{
  return ::fclose(f);
}

被这些函数引用 checkPngResult(), OutputGenerator::endPlainFile(), FilterCache::getFileContents(), DotRunner::readBoundingBox() , 以及 DotRunner::run().

fileSystemIsCaseSensitive()

bool Portable::fileSystemIsCaseSensitive

(

)

在文件 portable.cpp 第 443 行定义.

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

引用了 FALSE , 以及 TRUE.

被这些函数引用 findFileDef(), getFilterFromList() , 以及 patternMatch().

fopen()

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

在文件 portable.cpp 第 322 行定义.

{
#if defined(_WIN32) && !defined(__CYGWIN__)
  uint16_t *fn = 0;
  size_t fn_len = recodeUtf8StringToW(fileName,&fn);
  uint16_t *m  = 0;
  size_t m_len = recodeUtf8StringToW(mode,&m);
  FILE *result = 0;
  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
}

引用了 QCString::data() , 以及 recodeUtf8StringToW().

被这些函数引用 checkPngResult(), FilterCache::getFileContents(), initWarningFormat(), DotRunner::readBoundingBox(), DotRunner::run() , 以及 OutputGenerator::startPlainFile().

fseek()

portable_off_t Portable::fseek	(	FILE *	f,
		portable_off_t	offset,
		int	whence
	)

在文件 portable.cpp 第 300 行定义.

{
#if defined(__MINGW32__)
  return fseeko64(f,offset,whence);
#elif defined(_WIN32) && !defined(__CYGWIN__)
  return _fseeki64(f,offset,whence);
#else
  return fseeko(f,offset,whence);
#endif
}

被这些函数引用 FilterCache::getFileContents().

ftell()

portable_off_t Portable::ftell

(

FILE *

f

)

在文件 portable.cpp 第 311 行定义.

{
#if defined(__MINGW32__)
  return ftello64(f);
#elif defined(_WIN32) && !defined(__CYGWIN__)
  return _ftelli64(f);
#else
  return ftello(f);
#endif
}

getenv()

QCString Portable::getenv

(

const QCString &

variable

)

在文件 portable.cpp 第 279 行定义.

{
#if defined(_WIN32) && !defined(__CYGWIN__)
    return ::getenv(variable.data());
#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 QCString(proc_env[variable.str()]);
    }
    else
    {
      return QCString();
    }
#endif
}

引用了 QCString::data(), environmentLoaded, loadEnvironment(), proc_env , 以及 QCString::str().

被这些函数引用 correct_path(), ExistsOnPath(), getCurrentDateTime(), initDoxygen(), parseInput() , 以及 setDotFontPath().

getSysElapsedTime()

double Portable::getSysElapsedTime

(

)

在文件 portable.cpp 第 482 行定义.

{
  return g_sysElapsedTime;
}

引用了 g_sysElapsedTime.

被这些函数引用 generateOutput().

ghostScriptCommand()

const char * Portable::ghostScriptCommand

(

)

在文件 portable.cpp 第 410 行定义.

{
#if defined(_WIN32) && !defined(__CYGWIN__)
    static char *gsexe = NULL;
    if (!gsexe)
    {
        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
}

引用了 ExistsOnPath().

被这些函数引用 FormulaManager::generateImages() , 以及 writeMakeBat().

isAbsolutePath()

bool Portable::isAbsolutePath

(

const QCString &

fileName

)

在文件 portable.cpp 第 496 行定义.

{
  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;
}

引用了 QCString::data(), reg::isalpha() , 以及 QCString::length().

被这些函数引用 generateOutput(), Markdown::processLink() , 以及 DocParser::readTextFileByName().

pathListSeparator()

QCString Portable::pathListSeparator

(

)

在文件 portable.cpp 第 356 行定义.

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

被这些函数引用 ExistsOnPath(), parseInput(), runPlantumlContent() , 以及 setDotFontPath().

pathSeparator()

QCString Portable::pathSeparator

(

)

在文件 portable.cpp 第 347 行定义.

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

被这些函数引用 MemberContext::Private::callerGraph(), MemberContext::Private::callGraph(), ClassContext::Private::collaborationDiagram(), InheritanceGraphContext::Private::createGraph(), DirContext::Private::dirGraph(), ExistsOnPath(), ModuleContext::Private::groupGraph(), FileContext::Private::includedByGraph(), FileContext::Private::includeGraph(), ClassContext::Private::inheritanceDiagram(), DocParser::readTextFileByName(), writeDiaGraphFromFile() , 以及 writeMscGraphFromFile().

pclose()

int Portable::pclose

(

FILE *

stream

)

在文件 portable.cpp 第 461 行定义.

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

被这些函数引用 FileDefImpl::acquireFileVersion(), FilterCache::getFileContents(), readInputFile() , 以及 stackTrace().

pid()

unsigned int Portable::pid

(

)

在文件 portable.cpp 第 207 行定义.

{
  unsigned int pid;
#if !defined(_WIN32) || defined(__CYGWIN__)
  pid = (unsigned int)getpid();
#else
  pid = (unsigned int)GetCurrentProcessId();
#endif
  return pid;
}

被这些函数引用 parseInput() , 以及 system().

popen()

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

在文件 portable.cpp 第 452 行定义.

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

引用了 QCString::data().

被这些函数引用 FileDefImpl::acquireFileVersion(), FilterCache::getFileContents(), readInputFile() , 以及 stackTrace().

recodeUtf8StringToW()

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

在文件 portable.cpp 第 604 行定义.

{
  if (inputStr.isEmpty() || outBuf==0) return 0; // empty input or invalid output
  void *handle = portable_iconv_open("UTF-16LE","UTF-8");
  if (handle==(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,(char**)&buf,&outRemains);
  *buf=0;
  portable_iconv_close(handle);
  return len;
}

引用了 QCString::data(), QCString::isEmpty(), QCString::length(), portable_iconv(), portable_iconv_close() , 以及 portable_iconv_open().

被这些函数引用 fopen() , 以及 system().

setenv()

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

在文件 portable.cpp 第 246 行定义.

{
#if defined(_WIN32) && !defined(__CYGWIN__)
    SetEnvironmentVariable(name.data(),!value.isEmpty() ? 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
#endif
}

引用了 QCString::data(), environmentLoaded, QCString::isEmpty(), loadEnvironment(), proc_env , 以及 QCString::str().

被这些函数引用 correct_path(), initDoxygen(), parseInput(), setDotFontPath() , 以及 unsetDotFontPath().

setShortDir()

void Portable::setShortDir

(

)

在文件 portable.cpp 第 534 行定义.

{
#if defined(_WIN32) && !defined(__CYGWIN__)
  long     length = 0;
  TCHAR*   buffer = NULL;
  // First obtain the size needed by passing NULL and 0.
  length = GetShortPathName(Dir::currentDirPath().c_str(), NULL, 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
}

引用了 Dir::currentDirPath() , 以及 Dir::setCurrent().

被这些函数引用 generateOutput().

sleep()

void Portable::sleep

(

int

ms

)

在文件 portable.cpp 第 487 行定义.

{
#if defined(_WIN32) && !defined(__CYGWIN__)
  Sleep(ms);
#else
  usleep(1000*ms);
#endif
}

被这些函数引用 DotManager::run().

strnstr()

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

在文件 portable.cpp 第 581 行定义.

{
  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 0;
}

引用了 portable_memmem().

被这些函数引用 Markdown::addStrEscapeUtf8Nbsp().

system()

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

taken from the system() manpage on my Linux box

在文件 portable.cpp 第 42 行定义.

{
 
  if (command.isEmpty()) return 1;
 
#if defined(_WIN32) && !defined(__CYGWIN__)
  QCString commandCorrectedPath = substitute(command,'/','\\');
  QCString fullCmd=commandCorrectedPath;
#else
  QCString fullCmd=command;
#endif
  fullCmd=fullCmd.stripWhiteSpace();
  if (fullCmd.at(0)!='"' && fullCmd.find(' ')!=-1)
  {
    // 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 `%s`\n",qPrint(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 * argv[4];
    argv[0] = "sh";
    argv[1] = "-c";
    argv[2] = fullCmd.data();
    argv[3] = 0;
    execve("/bin/sh",(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
  {
    // Because ShellExecuteEx can delegate execution to Shell extensions
    // (data sources, context menu handlers, verb implementations) that
    // are activated using Component Object Model (COM), COM should be
    // initialized before ShellExecuteEx is called. Some Shell extensions
    // require the COM single-threaded apartment (STA) type.
    // For that case COM is initialized as follows
    CoInitializeEx(NULL, COINIT_APARTMENTTHREADED | COINIT_DISABLE_OLE1DDE);
 
    uint16_t *commandw = NULL;
    recodeUtf8StringToW( commandCorrectedPath, &commandw );
    uint16_t *argsw = NULL;
    recodeUtf8StringToW( args, &argsw );
 
    // gswin32 is a GUI api which will pop up a window and run
    // asynchronously. To prevent both, we use ShellExecuteEx and
    // WaitForSingleObject (thanks to Robert Golias for the code)
 
    SHELLEXECUTEINFOW sInfo = {
      sizeof(SHELLEXECUTEINFOW),   /* structure size */
      SEE_MASK_NOCLOSEPROCESS | SEE_MASK_FLAG_NO_UI,  /* tell us the process
                                                       *  handle so we can wait till it's done |
                                                       *  do not display msg box if error
                                                       */
      NULL,                       /* window handle */
      NULL,                       /* action to perform: open */
      (LPCWSTR)commandw,          /* file to execute */
      (LPCWSTR)argsw,             /* argument list */
      NULL,                       /* use current working dir */
      SW_HIDE,                    /* minimize on start-up */
      0,                          /* application instance handle */
      NULL,                       /* ignored: id list */
      NULL,                       /* ignored: class name */
      NULL,                       /* ignored: key class */
      0,                          /* ignored: hot key */
      NULL,                       /* ignored: icon */
      NULL                        /* resulting application handle */
    };
 
    if (!ShellExecuteExW(&sInfo))
    {
      delete[] commandw;
      delete[] argsw;
      return -1;
    }
    else if (sInfo.hProcess)      /* executable was launched, wait for it to finish */
    {
      WaitForSingleObject(sInfo.hProcess,INFINITE);
      /* get process exit code */
      DWORD exitCode;
      if (!GetExitCodeProcess(sInfo.hProcess,&exitCode))
      {
        exitCode = -1;
      }
      CloseHandle(sInfo.hProcess);
      delete[] commandw;
      delete[] argsw;
      return exitCode;
    }
  }
#endif
  return 1; // we should never get here
 
}

引用了 QCString::at(), QCString::data(), environ, Debug::ExtCmd, QCString::find(), QCString::isEmpty(), pid(), Debug::print(), qPrint(), recodeUtf8StringToW(), QCString::stripWhiteSpace() , 以及 substitute().

被这些函数引用 createSVG(), FlowChart::createSVG(), determineInkscapeVersion(), Htags::execute(), DocParser::findAndCopyImage(), FormulaManager::generateImages(), generateOutput(), CitationManager::generatePage(), DotRunner::run(), runPlantumlContent(), writeDiaGraphFromFile(), ClassDiagram::writeFigure() , 以及 writeMscGraphFromFile().

sysTimerStart()

void Portable::sysTimerStart

(

)

在文件 portable.cpp 第 470 行定义.

{
  g_startTime = std::chrono::steady_clock::now();
}

引用了 g_startTime.

被这些函数引用 determineInkscapeVersion(), Htags::execute(), DocParser::findAndCopyImage(), FormulaManager::generateImages(), generateOutput(), DotManager::run(), runPlantumlContent(), writeDiaGraphFromFile(), ClassDiagram::writeFigure() , 以及 writeMscGraphFromFile().

sysTimerStop()

void Portable::sysTimerStop

(

)

在文件 portable.cpp 第 475 行定义.

{
  std::chrono::steady_clock::time_point endTime = std::chrono::steady_clock::now();
  g_sysElapsedTime+= std::chrono::duration_cast<
                         std::chrono::microseconds>(endTime - g_startTime).count()/1000000.0;
}

引用了 g_startTime , 以及 g_sysElapsedTime.

被这些函数引用 determineInkscapeVersion(), Htags::execute(), DocParser::findAndCopyImage(), FormulaManager::generateImages(), generateOutput(), CitationManager::generatePage(), DotManager::run(), runPlantumlContent(), writeDiaGraphFromFile(), ClassDiagram::writeFigure() , 以及 writeMscGraphFromFile().

unlink()

void Portable::unlink

(

const QCString &

fileName

)

在文件 portable.cpp 第 525 行定义.

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

引用了 QCString::data().

被这些函数引用 DotRunner::run().

unsetenv()

void Portable::unsetenv

(

const QCString &

variable

)

在文件 portable.cpp 第 260 行定义.

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

引用了 QCString::data(), QCString::find(), QCString::isEmpty(), proc_env , 以及 QCString::str().

被这些函数引用 setDotFontPath() , 以及 unsetDotFontPath().