CMake/Source/CTest/cmProcess.h
Brad King 6a7eae7184 Rewrite CTest child output handling
This commit fixes cmCTestRunTest and cmProcess to more efficiently
handle child output.  We now use the buffer for each child output pipe
to hold at most a partial line plus one new block of data at a time.
All complete lines are scanned in-place, and then only the partial line
at the end of the buffer is moved back to the beginning before appending
new data.

We also simplify the cmProcess interface by making GetNextOutputLine the
only method that needs to be called while the process is running.  This
simplifies cmCTestRunTest so that CheckOutput can be called until it
returns false when the process is done.
2009-09-11 12:26:41 -04:00

88 lines
2.5 KiB
C++

/*=========================================================================
Program: CMake - Cross-Platform Makefile Generator
Module: $RCSfile$
Language: C++
Date: $Date$
Version: $Revision$
Copyright (c) 2002 Kitware, Inc., Insight Consortium. All rights reserved.
See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notices for more information.
=========================================================================*/
#ifndef cmProcess_h
#define cmProcess_h
#include "cmStandardIncludes.h"
#include <cmsys/Process.h>
/** \class cmProcess
* \brief run a process with c++
*
* cmProcess wraps the kwsys process stuff in a c++ class.
*/
class cmProcess
{
public:
cmProcess();
~cmProcess();
const char* GetCommand() { return this->Command.c_str();}
void SetCommand(const char* command);
void SetCommandArguments(std::vector<std::string> const& arg);
void SetWorkingDirectory(const char* dir) { this->WorkingDirectory = dir;}
void SetTimeout(double t) { this->Timeout = t;}
// Return true if the process starts
bool StartProcess();
// return the process status
int GetProcessStatus();
// Report the status of the program
int ReportStatus();
int GetId() { return this->Id; }
void SetId(int id) { this->Id = id;}
int GetExitValue() { return this->ExitValue;}
double GetTotalTime() { return this->TotalTime;}
/**
* Read one line of output but block for no more than timeout.
* Returns:
* cmsysProcess_Pipe_None = Process terminated and all output read
* cmsysProcess_Pipe_STDOUT = Line came from stdout
* cmsysProcess_Pipe_STDOUT = Line came from stderr
* cmsysProcess_Pipe_Timeout = Timeout expired while waiting
*/
int GetNextOutputLine(std::string& line, double timeout);
private:
double Timeout;
double StartTime;
double TotalTime;
cmsysProcess* Process;
class Buffer: public std::vector<char>
{
// Half-open index range of partial line already scanned.
size_type First;
size_type Last;
public:
Buffer(): First(0), Last(0) {}
bool GetLine(std::string& line);
bool GetLast(std::string& line);
};
Buffer StdErr;
Buffer StdOut;
std::string Command;
std::string WorkingDirectory;
std::vector<std::string> Arguments;
std::vector<const char*> ProcessArgs;
std::string Output;
int Id;
int ExitValue;
};
#endif