File: loopCommandOutput.h

package info (click to toggle)
groops 0%2Bgit20250907%2Bds-1
  • links: PTS, VCS
  • area: non-free
  • in suites: forky, sid
  • size: 11,140 kB
  • sloc: cpp: 135,607; fortran: 1,603; makefile: 20
file content (103 lines) | stat: -rw-r--r-- 3,149 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
/***********************************************/
/**
* @file loopCommandOutput.h
*
* @brief Loop over lines of command output.
*
* @author Sebastian Strasser
* @date 2017-02-10
*
*/
/***********************************************/

#ifndef __GROOPS_LOOPCOMMANDOUTPUT__
#define __GROOPS_LOOPCOMMANDOUTPUT__

// Latex documentation
#ifdef DOCSTRING_Loop
static const char *docstringLoopCommandOutput = R"(
\subsection{CommandOutput}\label{loopType:commandOutput}
Loop over lines of command output.
)";
#endif

/***********************************************/

#include "base/import.h"
#include "parallel/parallel.h"
#include "inputOutput/logging.h"
#include "inputOutput/system.h"
#include "classes/loop/loop.h"

/***** CLASS ***********************************/

/** @brief Loop over lines of command output.
* @ingroup loopGroup
* @see Loop */
class LoopCommandOutput : public Loop
{
  std::string              nameString, nameIndex, nameCount;
  std::vector<std::string> strings;

public:
  LoopCommandOutput(Config &config);

  UInt count() const override {return strings.size();}
  Bool iteration(VariableList &varList) override;
};

/***********************************************/
/***** Inlines *********************************/
/***********************************************/

inline LoopCommandOutput::LoopCommandOutput(Config &config)
{
  try
  {
    std::vector<FileName> commands;
    Bool                  silently;

    readConfig(config, "command",            commands,   Config::MUSTSET,  "",            "each output line becomes a loop iteration");
    readConfig(config, "silently",           silently,   Config::DEFAULT,  "0",           "without showing the output.");
    readConfig(config, "variableLoopString", nameString, Config::OPTIONAL, "loopCommand", "name of the variable to be replaced");
    readConfig(config, "variableLoopIndex",  nameIndex,  Config::OPTIONAL, "",            "variable with index of current iteration (starts with zero)");
    readConfig(config, "variableLoopCount",  nameCount,  Config::OPTIONAL, "",            "variable with total number of iterations");
    readConfigCondition(config);
    if(isCreateSchema(config)) return;

    for(const auto &command : commands)
    {
      UInt count = strings.size();
      if(!System::exec(command, strings))
        throw(Exception("Command \""+command.str()+"\" exited with error"));
      if(strings.size() == count)
        logWarningOnce<<"Command \""+command.str()+"\" returned no output"<<Log::endl;
    } // for(i)

    if(!silently)
      for(const auto &str : strings)
        logInfo<<str<<Log::endl;
  }
  catch(std::exception &e)
  {
    GROOPS_RETHROW(e)
  }
}

/***********************************************/

inline Bool LoopCommandOutput::iteration(VariableList &varList)
{
  if(index() >= count())
    return FALSE;

  if(!nameString.empty()) varList.setVariable(nameString, strings.at(index()));
  if(!nameIndex.empty())  varList.setVariable(nameIndex,  index());
  if(!nameCount.empty())  varList.setVariable(nameCount,  count());

  return checkCondition(varList);
}

/***********************************************/

#endif