osaPipeExec.h

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-    */
/* ex: set filetype=cpp softtabstop=4 shiftwidth=4 tabstop=4 cindent expandtab: */
 
/*
 
  Author(s): Martin Kelly
  Created on: 2010-09-23
 
  (C) Copyright 2010-2019 Johns Hopkins University (JHU), All Rights Reserved.
 
  --- begin cisst license - do not edit ---
 
  This software is provided "as is" under an open source license, with
  no warranty.  The complete license can be found in license.txt and
  http://www.cisst.org/cisst/license.txt.
 
  --- end cisst license ---
 
*/
 
#ifndef _osaPipeExec_h
#define _osaPipeExec_h
 
#include <vector>
#include <string>
 
#include <cisstCommon/cmnPortability.h>
 
// Always include last
#include <cisstOSAbstraction/osaExport.h>
 
class CISST_EXPORT osaPipeExec {
    enum {INTERNALS_SIZE = 64};
    char Internals[INTERNALS_SIZE];

    static unsigned int SizeOfInternals(void);
    friend class osaPipeExecTest;
 
    int ToProgram[2];
    int FromProgram[2];
    bool Connected;
    bool ReadFlag;
    bool WriteFlag;
    std::string Name;

    int DoClose(int &n);

    void CloseAllPipes(void);

    void CloseUnusedHandles(void);

    char ** ParseCommand(const std::string & executable,
                         const std::vector<std::string> & arguments);

    void FreeCommand(char **command);
 
#if (CISST_OS == CISST_WINDOWS)
    void RestoreIO(int newStdin, int newStdout);
#endif
 
 public:
    osaPipeExec(const std::string & name = "unnamed");

    ~osaPipeExec(void);

    bool Open(const std::string & executable, const std::string & mode,
              bool noWindow = false);

 
    bool Open(const std::string & executable,
              const std::vector<std::string> & parameters,
              const std::string & mode, bool noWindow = false);

    bool Close(bool killProcess = true);

    int Read(char * buffer, int maxLength) const;

    std::string Read(int maxLength) const;

    int ReadUntil(char * buffer, int maxLength, char stopChar, double timeoutSec = 0.0) const;

    std::string ReadUntil(int maxLength, char stopChar, double timeoutSec = 0.0) const;

    std::string ReadString(int maxLength, double timeoutSec = 0.0) const;

    int Write(const char * buffer);

    int Write(const char * buffer, int n);

    int Write(const std::string & s);

    int Write(const std::string & s, int n);

    bool IsConnected(void) const;

    bool IsProcessRunning(void) const;

    const std::string & GetName(void) const;
};
 
#endif // _osaPipeExec_h